1450af8d0SKP Singh // SPDX-License-Identifier: GPL-2.0 2450af8d0SKP Singh /* Copyright (c) 2019 Facebook */ 3450af8d0SKP Singh #include <linux/rculist.h> 4450af8d0SKP Singh #include <linux/list.h> 5450af8d0SKP Singh #include <linux/hash.h> 6450af8d0SKP Singh #include <linux/types.h> 7450af8d0SKP Singh #include <linux/spinlock.h> 8450af8d0SKP Singh #include <linux/bpf.h> 9450af8d0SKP Singh #include <linux/btf_ids.h> 10450af8d0SKP Singh #include <linux/bpf_local_storage.h> 11450af8d0SKP Singh #include <net/sock.h> 12450af8d0SKP Singh #include <uapi/linux/sock_diag.h> 13450af8d0SKP Singh #include <uapi/linux/btf.h> 140fe4b381SKP Singh #include <linux/rcupdate.h> 150fe4b381SKP Singh #include <linux/rcupdate_trace.h> 160fe4b381SKP Singh #include <linux/rcupdate_wait.h> 17450af8d0SKP Singh 18450af8d0SKP Singh #define BPF_LOCAL_STORAGE_CREATE_FLAG_MASK (BPF_F_NO_PREALLOC | BPF_F_CLONE) 19450af8d0SKP Singh 20450af8d0SKP Singh static struct bpf_local_storage_map_bucket * 21450af8d0SKP Singh select_bucket(struct bpf_local_storage_map *smap, 22450af8d0SKP Singh struct bpf_local_storage_elem *selem) 23450af8d0SKP Singh { 24450af8d0SKP Singh return &smap->buckets[hash_ptr(selem, smap->bucket_log)]; 25450af8d0SKP Singh } 26450af8d0SKP Singh 27450af8d0SKP Singh static int mem_charge(struct bpf_local_storage_map *smap, void *owner, u32 size) 28450af8d0SKP Singh { 29450af8d0SKP Singh struct bpf_map *map = &smap->map; 30450af8d0SKP Singh 31450af8d0SKP Singh if (!map->ops->map_local_storage_charge) 32450af8d0SKP Singh return 0; 33450af8d0SKP Singh 34450af8d0SKP Singh return map->ops->map_local_storage_charge(smap, owner, size); 35450af8d0SKP Singh } 36450af8d0SKP Singh 37450af8d0SKP Singh static void mem_uncharge(struct bpf_local_storage_map *smap, void *owner, 38450af8d0SKP Singh u32 size) 39450af8d0SKP Singh { 40450af8d0SKP Singh struct bpf_map *map = &smap->map; 41450af8d0SKP Singh 42450af8d0SKP Singh if (map->ops->map_local_storage_uncharge) 43450af8d0SKP Singh map->ops->map_local_storage_uncharge(smap, owner, size); 44450af8d0SKP Singh } 45450af8d0SKP Singh 46450af8d0SKP Singh static struct bpf_local_storage __rcu ** 47450af8d0SKP Singh owner_storage(struct bpf_local_storage_map *smap, void *owner) 48450af8d0SKP Singh { 49450af8d0SKP Singh struct bpf_map *map = &smap->map; 50450af8d0SKP Singh 51450af8d0SKP Singh return map->ops->map_owner_storage_ptr(owner); 52450af8d0SKP Singh } 53450af8d0SKP Singh 540a09a2f9SKumar Kartikeya Dwivedi static bool selem_linked_to_storage_lockless(const struct bpf_local_storage_elem *selem) 550a09a2f9SKumar Kartikeya Dwivedi { 560a09a2f9SKumar Kartikeya Dwivedi return !hlist_unhashed_lockless(&selem->snode); 570a09a2f9SKumar Kartikeya Dwivedi } 580a09a2f9SKumar Kartikeya Dwivedi 59450af8d0SKP Singh static bool selem_linked_to_storage(const struct bpf_local_storage_elem *selem) 60450af8d0SKP Singh { 61450af8d0SKP Singh return !hlist_unhashed(&selem->snode); 62450af8d0SKP Singh } 63450af8d0SKP Singh 640a09a2f9SKumar Kartikeya Dwivedi static bool selem_linked_to_map_lockless(const struct bpf_local_storage_elem *selem) 650a09a2f9SKumar Kartikeya Dwivedi { 660a09a2f9SKumar Kartikeya Dwivedi return !hlist_unhashed_lockless(&selem->map_node); 670a09a2f9SKumar Kartikeya Dwivedi } 680a09a2f9SKumar Kartikeya Dwivedi 69450af8d0SKP Singh static bool selem_linked_to_map(const struct bpf_local_storage_elem *selem) 70450af8d0SKP Singh { 71450af8d0SKP Singh return !hlist_unhashed(&selem->map_node); 72450af8d0SKP Singh } 73450af8d0SKP Singh 74450af8d0SKP Singh struct bpf_local_storage_elem * 75450af8d0SKP Singh bpf_selem_alloc(struct bpf_local_storage_map *smap, void *owner, 76b00fa38aSJoanne Koong void *value, bool charge_mem, gfp_t gfp_flags) 77450af8d0SKP Singh { 78450af8d0SKP Singh struct bpf_local_storage_elem *selem; 79450af8d0SKP Singh 80450af8d0SKP Singh if (charge_mem && mem_charge(smap, owner, smap->elem_size)) 81450af8d0SKP Singh return NULL; 82450af8d0SKP Singh 83e9aae8beSRoman Gushchin selem = bpf_map_kzalloc(&smap->map, smap->elem_size, 84b00fa38aSJoanne Koong gfp_flags | __GFP_NOWARN); 85450af8d0SKP Singh if (selem) { 86450af8d0SKP Singh if (value) 87836e49e1SXu Kuohai copy_map_value(&smap->map, SDATA(selem)->data, value); 889db44fddSKumar Kartikeya Dwivedi /* No need to call check_and_init_map_value as memory is zero init */ 89450af8d0SKP Singh return selem; 90450af8d0SKP Singh } 91450af8d0SKP Singh 92450af8d0SKP Singh if (charge_mem) 93450af8d0SKP Singh mem_uncharge(smap, owner, smap->elem_size); 94450af8d0SKP Singh 95450af8d0SKP Singh return NULL; 96450af8d0SKP Singh } 97450af8d0SKP Singh 984cbd23ccSMartin KaFai Lau static void bpf_local_storage_free_rcu(struct rcu_head *rcu) 990fe4b381SKP Singh { 1000fe4b381SKP Singh struct bpf_local_storage *local_storage; 1010fe4b381SKP Singh 102d39d1445SHou Tao /* If RCU Tasks Trace grace period implies RCU grace period, do 103d39d1445SHou Tao * kfree(), else do kfree_rcu(). 104d39d1445SHou Tao */ 1050fe4b381SKP Singh local_storage = container_of(rcu, struct bpf_local_storage, rcu); 106d39d1445SHou Tao if (rcu_trace_implies_rcu_gp()) 107d39d1445SHou Tao kfree(local_storage); 108d39d1445SHou Tao else 1090fe4b381SKP Singh kfree_rcu(local_storage, rcu); 1100fe4b381SKP Singh } 1110fe4b381SKP Singh 112e768e3c5SKumar Kartikeya Dwivedi static void bpf_selem_free_trace_rcu(struct rcu_head *rcu) 1130fe4b381SKP Singh { 1140fe4b381SKP Singh struct bpf_local_storage_elem *selem; 1150fe4b381SKP Singh 1160fe4b381SKP Singh selem = container_of(rcu, struct bpf_local_storage_elem, rcu); 1179db44fddSKumar Kartikeya Dwivedi if (rcu_trace_implies_rcu_gp()) 118e768e3c5SKumar Kartikeya Dwivedi kfree(selem); 119d39d1445SHou Tao else 120e768e3c5SKumar Kartikeya Dwivedi kfree_rcu(selem, rcu); 1210fe4b381SKP Singh } 1220fe4b381SKP Singh 123450af8d0SKP Singh /* local_storage->lock must be held and selem->local_storage == local_storage. 124450af8d0SKP Singh * The caller must ensure selem->smap is still valid to be 125450af8d0SKP Singh * dereferenced for its smap->elem_size and smap->cache_idx. 126450af8d0SKP Singh */ 127c83597faSYonghong Song static bool bpf_selem_unlink_storage_nolock(struct bpf_local_storage *local_storage, 128450af8d0SKP Singh struct bpf_local_storage_elem *selem, 129a47eabf2SMartin KaFai Lau bool uncharge_mem, bool reuse_now) 130450af8d0SKP Singh { 131450af8d0SKP Singh struct bpf_local_storage_map *smap; 132450af8d0SKP Singh bool free_local_storage; 133450af8d0SKP Singh void *owner; 134450af8d0SKP Singh 1350fe4b381SKP Singh smap = rcu_dereference_check(SDATA(selem)->smap, bpf_rcu_lock_held()); 136450af8d0SKP Singh owner = local_storage->owner; 137450af8d0SKP Singh 138450af8d0SKP Singh /* All uncharging on the owner must be done first. 139450af8d0SKP Singh * The owner may be freed once the last selem is unlinked 140450af8d0SKP Singh * from local_storage. 141450af8d0SKP Singh */ 142450af8d0SKP Singh if (uncharge_mem) 143450af8d0SKP Singh mem_uncharge(smap, owner, smap->elem_size); 144450af8d0SKP Singh 145450af8d0SKP Singh free_local_storage = hlist_is_singular_node(&selem->snode, 146450af8d0SKP Singh &local_storage->list); 147450af8d0SKP Singh if (free_local_storage) { 148450af8d0SKP Singh mem_uncharge(smap, owner, sizeof(struct bpf_local_storage)); 149450af8d0SKP Singh local_storage->owner = NULL; 150450af8d0SKP Singh 151450af8d0SKP Singh /* After this RCU_INIT, owner may be freed and cannot be used */ 152450af8d0SKP Singh RCU_INIT_POINTER(*owner_storage(smap, owner), NULL); 153450af8d0SKP Singh 154450af8d0SKP Singh /* local_storage is not freed now. local_storage->lock is 155450af8d0SKP Singh * still held and raw_spin_unlock_bh(&local_storage->lock) 156450af8d0SKP Singh * will be done by the caller. 157450af8d0SKP Singh * 158450af8d0SKP Singh * Although the unlock will be done under 159c561d110STom Rix * rcu_read_lock(), it is more intuitive to 1600fe4b381SKP Singh * read if the freeing of the storage is done 161450af8d0SKP Singh * after the raw_spin_unlock_bh(&local_storage->lock). 162450af8d0SKP Singh * 163450af8d0SKP Singh * Hence, a "bool free_local_storage" is returned 1640fe4b381SKP Singh * to the caller which then calls then frees the storage after 1650fe4b381SKP Singh * all the RCU grace periods have expired. 166450af8d0SKP Singh */ 167450af8d0SKP Singh } 168450af8d0SKP Singh hlist_del_init_rcu(&selem->snode); 169450af8d0SKP Singh if (rcu_access_pointer(local_storage->cache[smap->cache_idx]) == 170450af8d0SKP Singh SDATA(selem)) 171450af8d0SKP Singh RCU_INIT_POINTER(local_storage->cache[smap->cache_idx], NULL); 172450af8d0SKP Singh 173*c6099813SMartin KaFai Lau bpf_obj_free_fields(smap->map.record, SDATA(selem)->data); 174*c6099813SMartin KaFai Lau if (!reuse_now) 175e768e3c5SKumar Kartikeya Dwivedi call_rcu_tasks_trace(&selem->rcu, bpf_selem_free_trace_rcu); 176e768e3c5SKumar Kartikeya Dwivedi else 177e768e3c5SKumar Kartikeya Dwivedi kfree_rcu(selem, rcu); 178dcf456c9SKP Singh 179fc6652aaSMartin KaFai Lau if (rcu_access_pointer(local_storage->smap) == smap) 180fc6652aaSMartin KaFai Lau RCU_INIT_POINTER(local_storage->smap, NULL); 181fc6652aaSMartin KaFai Lau 182450af8d0SKP Singh return free_local_storage; 183450af8d0SKP Singh } 184450af8d0SKP Singh 185121f31f3SMartin KaFai Lau static void bpf_selem_unlink_storage(struct bpf_local_storage_elem *selem, 186a47eabf2SMartin KaFai Lau bool reuse_now) 187450af8d0SKP Singh { 188450af8d0SKP Singh struct bpf_local_storage *local_storage; 189450af8d0SKP Singh bool free_local_storage = false; 190a10787e6SSong Liu unsigned long flags; 191450af8d0SKP Singh 1920a09a2f9SKumar Kartikeya Dwivedi if (unlikely(!selem_linked_to_storage_lockless(selem))) 193450af8d0SKP Singh /* selem has already been unlinked from sk */ 194450af8d0SKP Singh return; 195450af8d0SKP Singh 1960fe4b381SKP Singh local_storage = rcu_dereference_check(selem->local_storage, 1970fe4b381SKP Singh bpf_rcu_lock_held()); 198a10787e6SSong Liu raw_spin_lock_irqsave(&local_storage->lock, flags); 199450af8d0SKP Singh if (likely(selem_linked_to_storage(selem))) 200450af8d0SKP Singh free_local_storage = bpf_selem_unlink_storage_nolock( 201a47eabf2SMartin KaFai Lau local_storage, selem, true, reuse_now); 202a10787e6SSong Liu raw_spin_unlock_irqrestore(&local_storage->lock, flags); 203450af8d0SKP Singh 204dcf456c9SKP Singh if (free_local_storage) { 205a47eabf2SMartin KaFai Lau if (!reuse_now) 2060fe4b381SKP Singh call_rcu_tasks_trace(&local_storage->rcu, 2070fe4b381SKP Singh bpf_local_storage_free_rcu); 208dcf456c9SKP Singh else 209dcf456c9SKP Singh kfree_rcu(local_storage, rcu); 210dcf456c9SKP Singh } 211450af8d0SKP Singh } 212450af8d0SKP Singh 213450af8d0SKP Singh void bpf_selem_link_storage_nolock(struct bpf_local_storage *local_storage, 214450af8d0SKP Singh struct bpf_local_storage_elem *selem) 215450af8d0SKP Singh { 216450af8d0SKP Singh RCU_INIT_POINTER(selem->local_storage, local_storage); 21770b97111SMartin KaFai Lau hlist_add_head_rcu(&selem->snode, &local_storage->list); 218450af8d0SKP Singh } 219450af8d0SKP Singh 2204cbd23ccSMartin KaFai Lau static void bpf_selem_unlink_map(struct bpf_local_storage_elem *selem) 221450af8d0SKP Singh { 222450af8d0SKP Singh struct bpf_local_storage_map *smap; 223450af8d0SKP Singh struct bpf_local_storage_map_bucket *b; 224a10787e6SSong Liu unsigned long flags; 225450af8d0SKP Singh 2260a09a2f9SKumar Kartikeya Dwivedi if (unlikely(!selem_linked_to_map_lockless(selem))) 227450af8d0SKP Singh /* selem has already be unlinked from smap */ 228450af8d0SKP Singh return; 229450af8d0SKP Singh 2300fe4b381SKP Singh smap = rcu_dereference_check(SDATA(selem)->smap, bpf_rcu_lock_held()); 231450af8d0SKP Singh b = select_bucket(smap, selem); 232a10787e6SSong Liu raw_spin_lock_irqsave(&b->lock, flags); 233450af8d0SKP Singh if (likely(selem_linked_to_map(selem))) 234450af8d0SKP Singh hlist_del_init_rcu(&selem->map_node); 235a10787e6SSong Liu raw_spin_unlock_irqrestore(&b->lock, flags); 236450af8d0SKP Singh } 237450af8d0SKP Singh 238450af8d0SKP Singh void bpf_selem_link_map(struct bpf_local_storage_map *smap, 239450af8d0SKP Singh struct bpf_local_storage_elem *selem) 240450af8d0SKP Singh { 241450af8d0SKP Singh struct bpf_local_storage_map_bucket *b = select_bucket(smap, selem); 242a10787e6SSong Liu unsigned long flags; 243450af8d0SKP Singh 244a10787e6SSong Liu raw_spin_lock_irqsave(&b->lock, flags); 245450af8d0SKP Singh RCU_INIT_POINTER(SDATA(selem)->smap, smap); 246450af8d0SKP Singh hlist_add_head_rcu(&selem->map_node, &b->list); 247a10787e6SSong Liu raw_spin_unlock_irqrestore(&b->lock, flags); 248450af8d0SKP Singh } 249450af8d0SKP Singh 250a47eabf2SMartin KaFai Lau void bpf_selem_unlink(struct bpf_local_storage_elem *selem, bool reuse_now) 251450af8d0SKP Singh { 252450af8d0SKP Singh /* Always unlink from map before unlinking from local_storage 253450af8d0SKP Singh * because selem will be freed after successfully unlinked from 254450af8d0SKP Singh * the local_storage. 255450af8d0SKP Singh */ 256450af8d0SKP Singh bpf_selem_unlink_map(selem); 257a47eabf2SMartin KaFai Lau bpf_selem_unlink_storage(selem, reuse_now); 258450af8d0SKP Singh } 259450af8d0SKP Singh 260e8b02296SMartin KaFai Lau /* If cacheit_lockit is false, this lookup function is lockless */ 261450af8d0SKP Singh struct bpf_local_storage_data * 262450af8d0SKP Singh bpf_local_storage_lookup(struct bpf_local_storage *local_storage, 263450af8d0SKP Singh struct bpf_local_storage_map *smap, 264450af8d0SKP Singh bool cacheit_lockit) 265450af8d0SKP Singh { 266450af8d0SKP Singh struct bpf_local_storage_data *sdata; 267450af8d0SKP Singh struct bpf_local_storage_elem *selem; 268450af8d0SKP Singh 269450af8d0SKP Singh /* Fast path (cache hit) */ 2700fe4b381SKP Singh sdata = rcu_dereference_check(local_storage->cache[smap->cache_idx], 2710fe4b381SKP Singh bpf_rcu_lock_held()); 272450af8d0SKP Singh if (sdata && rcu_access_pointer(sdata->smap) == smap) 273450af8d0SKP Singh return sdata; 274450af8d0SKP Singh 275450af8d0SKP Singh /* Slow path (cache miss) */ 2760fe4b381SKP Singh hlist_for_each_entry_rcu(selem, &local_storage->list, snode, 2770fe4b381SKP Singh rcu_read_lock_trace_held()) 278450af8d0SKP Singh if (rcu_access_pointer(SDATA(selem)->smap) == smap) 279450af8d0SKP Singh break; 280450af8d0SKP Singh 281450af8d0SKP Singh if (!selem) 282450af8d0SKP Singh return NULL; 283450af8d0SKP Singh 284450af8d0SKP Singh sdata = SDATA(selem); 285450af8d0SKP Singh if (cacheit_lockit) { 286a10787e6SSong Liu unsigned long flags; 287a10787e6SSong Liu 288450af8d0SKP Singh /* spinlock is needed to avoid racing with the 289450af8d0SKP Singh * parallel delete. Otherwise, publishing an already 290450af8d0SKP Singh * deleted sdata to the cache will become a use-after-free 291450af8d0SKP Singh * problem in the next bpf_local_storage_lookup(). 292450af8d0SKP Singh */ 293a10787e6SSong Liu raw_spin_lock_irqsave(&local_storage->lock, flags); 294450af8d0SKP Singh if (selem_linked_to_storage(selem)) 295450af8d0SKP Singh rcu_assign_pointer(local_storage->cache[smap->cache_idx], 296450af8d0SKP Singh sdata); 297a10787e6SSong Liu raw_spin_unlock_irqrestore(&local_storage->lock, flags); 298450af8d0SKP Singh } 299450af8d0SKP Singh 300450af8d0SKP Singh return sdata; 301450af8d0SKP Singh } 302450af8d0SKP Singh 303450af8d0SKP Singh static int check_flags(const struct bpf_local_storage_data *old_sdata, 304450af8d0SKP Singh u64 map_flags) 305450af8d0SKP Singh { 306450af8d0SKP Singh if (old_sdata && (map_flags & ~BPF_F_LOCK) == BPF_NOEXIST) 307450af8d0SKP Singh /* elem already exists */ 308450af8d0SKP Singh return -EEXIST; 309450af8d0SKP Singh 310450af8d0SKP Singh if (!old_sdata && (map_flags & ~BPF_F_LOCK) == BPF_EXIST) 311450af8d0SKP Singh /* elem doesn't exist, cannot update it */ 312450af8d0SKP Singh return -ENOENT; 313450af8d0SKP Singh 314450af8d0SKP Singh return 0; 315450af8d0SKP Singh } 316450af8d0SKP Singh 317450af8d0SKP Singh int bpf_local_storage_alloc(void *owner, 318450af8d0SKP Singh struct bpf_local_storage_map *smap, 319b00fa38aSJoanne Koong struct bpf_local_storage_elem *first_selem, 320b00fa38aSJoanne Koong gfp_t gfp_flags) 321450af8d0SKP Singh { 322450af8d0SKP Singh struct bpf_local_storage *prev_storage, *storage; 323450af8d0SKP Singh struct bpf_local_storage **owner_storage_ptr; 324450af8d0SKP Singh int err; 325450af8d0SKP Singh 326450af8d0SKP Singh err = mem_charge(smap, owner, sizeof(*storage)); 327450af8d0SKP Singh if (err) 328450af8d0SKP Singh return err; 329450af8d0SKP Singh 330e9aae8beSRoman Gushchin storage = bpf_map_kzalloc(&smap->map, sizeof(*storage), 331b00fa38aSJoanne Koong gfp_flags | __GFP_NOWARN); 332450af8d0SKP Singh if (!storage) { 333450af8d0SKP Singh err = -ENOMEM; 334450af8d0SKP Singh goto uncharge; 335450af8d0SKP Singh } 336450af8d0SKP Singh 337fc6652aaSMartin KaFai Lau RCU_INIT_POINTER(storage->smap, smap); 338450af8d0SKP Singh INIT_HLIST_HEAD(&storage->list); 339450af8d0SKP Singh raw_spin_lock_init(&storage->lock); 340450af8d0SKP Singh storage->owner = owner; 341450af8d0SKP Singh 342450af8d0SKP Singh bpf_selem_link_storage_nolock(storage, first_selem); 343450af8d0SKP Singh bpf_selem_link_map(smap, first_selem); 344450af8d0SKP Singh 345450af8d0SKP Singh owner_storage_ptr = 346450af8d0SKP Singh (struct bpf_local_storage **)owner_storage(smap, owner); 347450af8d0SKP Singh /* Publish storage to the owner. 348450af8d0SKP Singh * Instead of using any lock of the kernel object (i.e. owner), 349450af8d0SKP Singh * cmpxchg will work with any kernel object regardless what 350450af8d0SKP Singh * the running context is, bh, irq...etc. 351450af8d0SKP Singh * 352450af8d0SKP Singh * From now on, the owner->storage pointer (e.g. sk->sk_bpf_storage) 353450af8d0SKP Singh * is protected by the storage->lock. Hence, when freeing 354450af8d0SKP Singh * the owner->storage, the storage->lock must be held before 355450af8d0SKP Singh * setting owner->storage ptr to NULL. 356450af8d0SKP Singh */ 357450af8d0SKP Singh prev_storage = cmpxchg(owner_storage_ptr, NULL, storage); 358450af8d0SKP Singh if (unlikely(prev_storage)) { 359450af8d0SKP Singh bpf_selem_unlink_map(first_selem); 360450af8d0SKP Singh err = -EAGAIN; 361450af8d0SKP Singh goto uncharge; 362450af8d0SKP Singh 363450af8d0SKP Singh /* Note that even first_selem was linked to smap's 364450af8d0SKP Singh * bucket->list, first_selem can be freed immediately 365450af8d0SKP Singh * (instead of kfree_rcu) because 366450af8d0SKP Singh * bpf_local_storage_map_free() does a 3670fe4b381SKP Singh * synchronize_rcu_mult (waiting for both sleepable and 3680fe4b381SKP Singh * normal programs) before walking the bucket->list. 369450af8d0SKP Singh * Hence, no one is accessing selem from the 370450af8d0SKP Singh * bucket->list under rcu_read_lock(). 371450af8d0SKP Singh */ 372450af8d0SKP Singh } 373450af8d0SKP Singh 374450af8d0SKP Singh return 0; 375450af8d0SKP Singh 376450af8d0SKP Singh uncharge: 377450af8d0SKP Singh kfree(storage); 378450af8d0SKP Singh mem_uncharge(smap, owner, sizeof(*storage)); 379450af8d0SKP Singh return err; 380450af8d0SKP Singh } 381450af8d0SKP Singh 382450af8d0SKP Singh /* sk cannot be going away because it is linking new elem 383450af8d0SKP Singh * to sk->sk_bpf_storage. (i.e. sk->sk_refcnt cannot be 0). 384450af8d0SKP Singh * Otherwise, it will become a leak (and other memory issues 385450af8d0SKP Singh * during map destruction). 386450af8d0SKP Singh */ 387450af8d0SKP Singh struct bpf_local_storage_data * 388450af8d0SKP Singh bpf_local_storage_update(void *owner, struct bpf_local_storage_map *smap, 389b00fa38aSJoanne Koong void *value, u64 map_flags, gfp_t gfp_flags) 390450af8d0SKP Singh { 391450af8d0SKP Singh struct bpf_local_storage_data *old_sdata = NULL; 392b00fa38aSJoanne Koong struct bpf_local_storage_elem *selem = NULL; 393450af8d0SKP Singh struct bpf_local_storage *local_storage; 394a10787e6SSong Liu unsigned long flags; 395450af8d0SKP Singh int err; 396450af8d0SKP Singh 397450af8d0SKP Singh /* BPF_EXIST and BPF_NOEXIST cannot be both set */ 398450af8d0SKP Singh if (unlikely((map_flags & ~BPF_F_LOCK) > BPF_EXIST) || 399450af8d0SKP Singh /* BPF_F_LOCK can only be used in a value with spin_lock */ 400450af8d0SKP Singh unlikely((map_flags & BPF_F_LOCK) && 401db559117SKumar Kartikeya Dwivedi !btf_record_has_field(smap->map.record, BPF_SPIN_LOCK))) 402450af8d0SKP Singh return ERR_PTR(-EINVAL); 403450af8d0SKP Singh 404b00fa38aSJoanne Koong if (gfp_flags == GFP_KERNEL && (map_flags & ~BPF_F_LOCK) != BPF_NOEXIST) 405b00fa38aSJoanne Koong return ERR_PTR(-EINVAL); 406b00fa38aSJoanne Koong 4070fe4b381SKP Singh local_storage = rcu_dereference_check(*owner_storage(smap, owner), 4080fe4b381SKP Singh bpf_rcu_lock_held()); 409450af8d0SKP Singh if (!local_storage || hlist_empty(&local_storage->list)) { 410450af8d0SKP Singh /* Very first elem for the owner */ 411450af8d0SKP Singh err = check_flags(NULL, map_flags); 412450af8d0SKP Singh if (err) 413450af8d0SKP Singh return ERR_PTR(err); 414450af8d0SKP Singh 415b00fa38aSJoanne Koong selem = bpf_selem_alloc(smap, owner, value, true, gfp_flags); 416450af8d0SKP Singh if (!selem) 417450af8d0SKP Singh return ERR_PTR(-ENOMEM); 418450af8d0SKP Singh 419b00fa38aSJoanne Koong err = bpf_local_storage_alloc(owner, smap, selem, gfp_flags); 420450af8d0SKP Singh if (err) { 421450af8d0SKP Singh kfree(selem); 422450af8d0SKP Singh mem_uncharge(smap, owner, smap->elem_size); 423450af8d0SKP Singh return ERR_PTR(err); 424450af8d0SKP Singh } 425450af8d0SKP Singh 426450af8d0SKP Singh return SDATA(selem); 427450af8d0SKP Singh } 428450af8d0SKP Singh 429450af8d0SKP Singh if ((map_flags & BPF_F_LOCK) && !(map_flags & BPF_NOEXIST)) { 430450af8d0SKP Singh /* Hoping to find an old_sdata to do inline update 431450af8d0SKP Singh * such that it can avoid taking the local_storage->lock 432450af8d0SKP Singh * and changing the lists. 433450af8d0SKP Singh */ 434450af8d0SKP Singh old_sdata = 435450af8d0SKP Singh bpf_local_storage_lookup(local_storage, smap, false); 436450af8d0SKP Singh err = check_flags(old_sdata, map_flags); 437450af8d0SKP Singh if (err) 438450af8d0SKP Singh return ERR_PTR(err); 4390a09a2f9SKumar Kartikeya Dwivedi if (old_sdata && selem_linked_to_storage_lockless(SELEM(old_sdata))) { 440450af8d0SKP Singh copy_map_value_locked(&smap->map, old_sdata->data, 441450af8d0SKP Singh value, false); 442450af8d0SKP Singh return old_sdata; 443450af8d0SKP Singh } 444450af8d0SKP Singh } 445450af8d0SKP Singh 446b00fa38aSJoanne Koong if (gfp_flags == GFP_KERNEL) { 447b00fa38aSJoanne Koong selem = bpf_selem_alloc(smap, owner, value, true, gfp_flags); 448b00fa38aSJoanne Koong if (!selem) 449b00fa38aSJoanne Koong return ERR_PTR(-ENOMEM); 450b00fa38aSJoanne Koong } 451b00fa38aSJoanne Koong 452a10787e6SSong Liu raw_spin_lock_irqsave(&local_storage->lock, flags); 453450af8d0SKP Singh 454450af8d0SKP Singh /* Recheck local_storage->list under local_storage->lock */ 455450af8d0SKP Singh if (unlikely(hlist_empty(&local_storage->list))) { 456450af8d0SKP Singh /* A parallel del is happening and local_storage is going 457450af8d0SKP Singh * away. It has just been checked before, so very 458450af8d0SKP Singh * unlikely. Return instead of retry to keep things 459450af8d0SKP Singh * simple. 460450af8d0SKP Singh */ 461450af8d0SKP Singh err = -EAGAIN; 462450af8d0SKP Singh goto unlock_err; 463450af8d0SKP Singh } 464450af8d0SKP Singh 465450af8d0SKP Singh old_sdata = bpf_local_storage_lookup(local_storage, smap, false); 466450af8d0SKP Singh err = check_flags(old_sdata, map_flags); 467450af8d0SKP Singh if (err) 468450af8d0SKP Singh goto unlock_err; 469450af8d0SKP Singh 470450af8d0SKP Singh if (old_sdata && (map_flags & BPF_F_LOCK)) { 471450af8d0SKP Singh copy_map_value_locked(&smap->map, old_sdata->data, value, 472450af8d0SKP Singh false); 473450af8d0SKP Singh selem = SELEM(old_sdata); 474450af8d0SKP Singh goto unlock; 475450af8d0SKP Singh } 476450af8d0SKP Singh 477b00fa38aSJoanne Koong if (gfp_flags != GFP_KERNEL) { 478450af8d0SKP Singh /* local_storage->lock is held. Hence, we are sure 479450af8d0SKP Singh * we can unlink and uncharge the old_sdata successfully 480450af8d0SKP Singh * later. Hence, instead of charging the new selem now 481450af8d0SKP Singh * and then uncharge the old selem later (which may cause 482450af8d0SKP Singh * a potential but unnecessary charge failure), avoid taking 483450af8d0SKP Singh * a charge at all here (the "!old_sdata" check) and the 484450af8d0SKP Singh * old_sdata will not be uncharged later during 485450af8d0SKP Singh * bpf_selem_unlink_storage_nolock(). 486450af8d0SKP Singh */ 487b00fa38aSJoanne Koong selem = bpf_selem_alloc(smap, owner, value, !old_sdata, gfp_flags); 488450af8d0SKP Singh if (!selem) { 489450af8d0SKP Singh err = -ENOMEM; 490450af8d0SKP Singh goto unlock_err; 491450af8d0SKP Singh } 492b00fa38aSJoanne Koong } 493450af8d0SKP Singh 494450af8d0SKP Singh /* First, link the new selem to the map */ 495450af8d0SKP Singh bpf_selem_link_map(smap, selem); 496450af8d0SKP Singh 497450af8d0SKP Singh /* Second, link (and publish) the new selem to local_storage */ 498450af8d0SKP Singh bpf_selem_link_storage_nolock(local_storage, selem); 499450af8d0SKP Singh 500450af8d0SKP Singh /* Third, remove old selem, SELEM(old_sdata) */ 501450af8d0SKP Singh if (old_sdata) { 502450af8d0SKP Singh bpf_selem_unlink_map(SELEM(old_sdata)); 503450af8d0SKP Singh bpf_selem_unlink_storage_nolock(local_storage, SELEM(old_sdata), 504a47eabf2SMartin KaFai Lau false, false); 505450af8d0SKP Singh } 506450af8d0SKP Singh 507450af8d0SKP Singh unlock: 508a10787e6SSong Liu raw_spin_unlock_irqrestore(&local_storage->lock, flags); 509450af8d0SKP Singh return SDATA(selem); 510450af8d0SKP Singh 511450af8d0SKP Singh unlock_err: 512a10787e6SSong Liu raw_spin_unlock_irqrestore(&local_storage->lock, flags); 513b00fa38aSJoanne Koong if (selem) { 514b00fa38aSJoanne Koong mem_uncharge(smap, owner, smap->elem_size); 515b00fa38aSJoanne Koong kfree(selem); 516b00fa38aSJoanne Koong } 517450af8d0SKP Singh return ERR_PTR(err); 518450af8d0SKP Singh } 519450af8d0SKP Singh 520c83597faSYonghong Song static u16 bpf_local_storage_cache_idx_get(struct bpf_local_storage_cache *cache) 521450af8d0SKP Singh { 522450af8d0SKP Singh u64 min_usage = U64_MAX; 523450af8d0SKP Singh u16 i, res = 0; 524450af8d0SKP Singh 525450af8d0SKP Singh spin_lock(&cache->idx_lock); 526450af8d0SKP Singh 527450af8d0SKP Singh for (i = 0; i < BPF_LOCAL_STORAGE_CACHE_SIZE; i++) { 528450af8d0SKP Singh if (cache->idx_usage_counts[i] < min_usage) { 529450af8d0SKP Singh min_usage = cache->idx_usage_counts[i]; 530450af8d0SKP Singh res = i; 531450af8d0SKP Singh 532450af8d0SKP Singh /* Found a free cache_idx */ 533450af8d0SKP Singh if (!min_usage) 534450af8d0SKP Singh break; 535450af8d0SKP Singh } 536450af8d0SKP Singh } 537450af8d0SKP Singh cache->idx_usage_counts[res]++; 538450af8d0SKP Singh 539450af8d0SKP Singh spin_unlock(&cache->idx_lock); 540450af8d0SKP Singh 541450af8d0SKP Singh return res; 542450af8d0SKP Singh } 543450af8d0SKP Singh 544c83597faSYonghong Song static void bpf_local_storage_cache_idx_free(struct bpf_local_storage_cache *cache, 545450af8d0SKP Singh u16 idx) 546450af8d0SKP Singh { 547450af8d0SKP Singh spin_lock(&cache->idx_lock); 548450af8d0SKP Singh cache->idx_usage_counts[idx]--; 549450af8d0SKP Singh spin_unlock(&cache->idx_lock); 550450af8d0SKP Singh } 551450af8d0SKP Singh 552c83597faSYonghong Song int bpf_local_storage_map_alloc_check(union bpf_attr *attr) 553c83597faSYonghong Song { 554c83597faSYonghong Song if (attr->map_flags & ~BPF_LOCAL_STORAGE_CREATE_FLAG_MASK || 555c83597faSYonghong Song !(attr->map_flags & BPF_F_NO_PREALLOC) || 556c83597faSYonghong Song attr->max_entries || 557c83597faSYonghong Song attr->key_size != sizeof(int) || !attr->value_size || 558c83597faSYonghong Song /* Enforce BTF for userspace sk dumping */ 559c83597faSYonghong Song !attr->btf_key_type_id || !attr->btf_value_type_id) 560c83597faSYonghong Song return -EINVAL; 561c83597faSYonghong Song 562c83597faSYonghong Song if (!bpf_capable()) 563c83597faSYonghong Song return -EPERM; 564c83597faSYonghong Song 565c83597faSYonghong Song if (attr->value_size > BPF_LOCAL_STORAGE_MAX_VALUE_SIZE) 566c83597faSYonghong Song return -E2BIG; 567c83597faSYonghong Song 568c83597faSYonghong Song return 0; 569c83597faSYonghong Song } 570c83597faSYonghong Song 571c83597faSYonghong Song int bpf_local_storage_map_check_btf(const struct bpf_map *map, 572c83597faSYonghong Song const struct btf *btf, 573c83597faSYonghong Song const struct btf_type *key_type, 574c83597faSYonghong Song const struct btf_type *value_type) 575c83597faSYonghong Song { 576c83597faSYonghong Song u32 int_data; 577c83597faSYonghong Song 578c83597faSYonghong Song if (BTF_INFO_KIND(key_type->info) != BTF_KIND_INT) 579c83597faSYonghong Song return -EINVAL; 580c83597faSYonghong Song 581c83597faSYonghong Song int_data = *(u32 *)(key_type + 1); 582c83597faSYonghong Song if (BTF_INT_BITS(int_data) != 32 || BTF_INT_OFFSET(int_data)) 583c83597faSYonghong Song return -EINVAL; 584c83597faSYonghong Song 585c83597faSYonghong Song return 0; 586c83597faSYonghong Song } 587c83597faSYonghong Song 5882ffcb6fcSMartin KaFai Lau void bpf_local_storage_destroy(struct bpf_local_storage *local_storage) 589450af8d0SKP Singh { 590450af8d0SKP Singh struct bpf_local_storage_elem *selem; 591c83597faSYonghong Song bool free_storage = false; 592c83597faSYonghong Song struct hlist_node *n; 5932ffcb6fcSMartin KaFai Lau unsigned long flags; 594c83597faSYonghong Song 595c83597faSYonghong Song /* Neither the bpf_prog nor the bpf_map's syscall 596c83597faSYonghong Song * could be modifying the local_storage->list now. 597c83597faSYonghong Song * Thus, no elem can be added to or deleted from the 598c83597faSYonghong Song * local_storage->list by the bpf_prog or by the bpf_map's syscall. 599c83597faSYonghong Song * 600c83597faSYonghong Song * It is racing with bpf_local_storage_map_free() alone 601c83597faSYonghong Song * when unlinking elem from the local_storage->list and 602c83597faSYonghong Song * the map's bucket->list. 603c83597faSYonghong Song */ 6042ffcb6fcSMartin KaFai Lau raw_spin_lock_irqsave(&local_storage->lock, flags); 605c83597faSYonghong Song hlist_for_each_entry_safe(selem, n, &local_storage->list, snode) { 606c83597faSYonghong Song /* Always unlink from map before unlinking from 607c83597faSYonghong Song * local_storage. 608c83597faSYonghong Song */ 609c83597faSYonghong Song bpf_selem_unlink_map(selem); 610c83597faSYonghong Song /* If local_storage list has only one element, the 611c83597faSYonghong Song * bpf_selem_unlink_storage_nolock() will return true. 612c83597faSYonghong Song * Otherwise, it will return false. The current loop iteration 613c83597faSYonghong Song * intends to remove all local storage. So the last iteration 614c83597faSYonghong Song * of the loop will set the free_cgroup_storage to true. 615c83597faSYonghong Song */ 616c83597faSYonghong Song free_storage = bpf_selem_unlink_storage_nolock( 617a47eabf2SMartin KaFai Lau local_storage, selem, false, true); 618c83597faSYonghong Song } 6192ffcb6fcSMartin KaFai Lau raw_spin_unlock_irqrestore(&local_storage->lock, flags); 620c83597faSYonghong Song 6212ffcb6fcSMartin KaFai Lau if (free_storage) 6222ffcb6fcSMartin KaFai Lau kfree_rcu(local_storage, rcu); 623c83597faSYonghong Song } 624c83597faSYonghong Song 6257490b7f1SYafang Shao u64 bpf_local_storage_map_mem_usage(const struct bpf_map *map) 6267490b7f1SYafang Shao { 6277490b7f1SYafang Shao struct bpf_local_storage_map *smap = (struct bpf_local_storage_map *)map; 6287490b7f1SYafang Shao u64 usage = sizeof(*smap); 6297490b7f1SYafang Shao 6307490b7f1SYafang Shao /* The dynamically callocated selems are not counted currently. */ 6317490b7f1SYafang Shao usage += sizeof(*smap->buckets) * (1ULL << smap->bucket_log); 6327490b7f1SYafang Shao return usage; 6337490b7f1SYafang Shao } 6347490b7f1SYafang Shao 635c83597faSYonghong Song struct bpf_map * 636c83597faSYonghong Song bpf_local_storage_map_alloc(union bpf_attr *attr, 637c83597faSYonghong Song struct bpf_local_storage_cache *cache) 638c83597faSYonghong Song { 639c83597faSYonghong Song struct bpf_local_storage_map *smap; 64062827d61SMartin KaFai Lau unsigned int i; 64162827d61SMartin KaFai Lau u32 nbuckets; 642c83597faSYonghong Song 64362827d61SMartin KaFai Lau smap = bpf_map_area_alloc(sizeof(*smap), NUMA_NO_NODE); 64462827d61SMartin KaFai Lau if (!smap) 64562827d61SMartin KaFai Lau return ERR_PTR(-ENOMEM); 64662827d61SMartin KaFai Lau bpf_map_init_from_attr(&smap->map, attr); 64762827d61SMartin KaFai Lau 64862827d61SMartin KaFai Lau nbuckets = roundup_pow_of_two(num_possible_cpus()); 64962827d61SMartin KaFai Lau /* Use at least 2 buckets, select_bucket() is undefined behavior with 1 bucket */ 65062827d61SMartin KaFai Lau nbuckets = max_t(u32, 2, nbuckets); 65162827d61SMartin KaFai Lau smap->bucket_log = ilog2(nbuckets); 65262827d61SMartin KaFai Lau 65362827d61SMartin KaFai Lau smap->buckets = bpf_map_kvcalloc(&smap->map, sizeof(*smap->buckets), 65462827d61SMartin KaFai Lau nbuckets, GFP_USER | __GFP_NOWARN); 65562827d61SMartin KaFai Lau if (!smap->buckets) { 65662827d61SMartin KaFai Lau bpf_map_area_free(smap); 65762827d61SMartin KaFai Lau return ERR_PTR(-ENOMEM); 65862827d61SMartin KaFai Lau } 65962827d61SMartin KaFai Lau 66062827d61SMartin KaFai Lau for (i = 0; i < nbuckets; i++) { 66162827d61SMartin KaFai Lau INIT_HLIST_HEAD(&smap->buckets[i].list); 66262827d61SMartin KaFai Lau raw_spin_lock_init(&smap->buckets[i].lock); 66362827d61SMartin KaFai Lau } 66462827d61SMartin KaFai Lau 66562827d61SMartin KaFai Lau smap->elem_size = offsetof(struct bpf_local_storage_elem, 66662827d61SMartin KaFai Lau sdata.data[attr->value_size]); 667c83597faSYonghong Song 668c83597faSYonghong Song smap->cache_idx = bpf_local_storage_cache_idx_get(cache); 669c83597faSYonghong Song return &smap->map; 670c83597faSYonghong Song } 671c83597faSYonghong Song 672c83597faSYonghong Song void bpf_local_storage_map_free(struct bpf_map *map, 673c83597faSYonghong Song struct bpf_local_storage_cache *cache, 674c83597faSYonghong Song int __percpu *busy_counter) 675c83597faSYonghong Song { 676450af8d0SKP Singh struct bpf_local_storage_map_bucket *b; 677c83597faSYonghong Song struct bpf_local_storage_elem *selem; 678c83597faSYonghong Song struct bpf_local_storage_map *smap; 679450af8d0SKP Singh unsigned int i; 680450af8d0SKP Singh 681c83597faSYonghong Song smap = (struct bpf_local_storage_map *)map; 682c83597faSYonghong Song bpf_local_storage_cache_idx_free(cache, smap->cache_idx); 683c83597faSYonghong Song 684450af8d0SKP Singh /* Note that this map might be concurrently cloned from 685450af8d0SKP Singh * bpf_sk_storage_clone. Wait for any existing bpf_sk_storage_clone 686450af8d0SKP Singh * RCU read section to finish before proceeding. New RCU 687450af8d0SKP Singh * read sections should be prevented via bpf_map_inc_not_zero. 688450af8d0SKP Singh */ 689450af8d0SKP Singh synchronize_rcu(); 690450af8d0SKP Singh 691450af8d0SKP Singh /* bpf prog and the userspace can no longer access this map 692450af8d0SKP Singh * now. No new selem (of this map) can be added 693450af8d0SKP Singh * to the owner->storage or to the map bucket's list. 694450af8d0SKP Singh * 695450af8d0SKP Singh * The elem of this map can be cleaned up here 696450af8d0SKP Singh * or when the storage is freed e.g. 697450af8d0SKP Singh * by bpf_sk_storage_free() during __sk_destruct(). 698450af8d0SKP Singh */ 699450af8d0SKP Singh for (i = 0; i < (1U << smap->bucket_log); i++) { 700450af8d0SKP Singh b = &smap->buckets[i]; 701450af8d0SKP Singh 702450af8d0SKP Singh rcu_read_lock(); 703450af8d0SKP Singh /* No one is adding to b->list now */ 704450af8d0SKP Singh while ((selem = hlist_entry_safe( 705450af8d0SKP Singh rcu_dereference_raw(hlist_first_rcu(&b->list)), 706450af8d0SKP Singh struct bpf_local_storage_elem, map_node))) { 707bc235cdbSSong Liu if (busy_counter) { 708bc235cdbSSong Liu migrate_disable(); 709197827a0SHou Tao this_cpu_inc(*busy_counter); 710bc235cdbSSong Liu } 711a47eabf2SMartin KaFai Lau bpf_selem_unlink(selem, true); 712bc235cdbSSong Liu if (busy_counter) { 713197827a0SHou Tao this_cpu_dec(*busy_counter); 714bc235cdbSSong Liu migrate_enable(); 715bc235cdbSSong Liu } 716450af8d0SKP Singh cond_resched_rcu(); 717450af8d0SKP Singh } 718450af8d0SKP Singh rcu_read_unlock(); 719450af8d0SKP Singh } 720450af8d0SKP Singh 721450af8d0SKP Singh /* While freeing the storage we may still need to access the map. 722450af8d0SKP Singh * 723450af8d0SKP Singh * e.g. when bpf_sk_storage_free() has unlinked selem from the map 724450af8d0SKP Singh * which then made the above while((selem = ...)) loop 725450af8d0SKP Singh * exit immediately. 726450af8d0SKP Singh * 727450af8d0SKP Singh * However, while freeing the storage one still needs to access the 728450af8d0SKP Singh * smap->elem_size to do the uncharging in 729450af8d0SKP Singh * bpf_selem_unlink_storage_nolock(). 730450af8d0SKP Singh * 731450af8d0SKP Singh * Hence, wait another rcu grace period for the storage to be freed. 732450af8d0SKP Singh */ 733450af8d0SKP Singh synchronize_rcu(); 734450af8d0SKP Singh 735450af8d0SKP Singh kvfree(smap->buckets); 73673cf09a3SYafang Shao bpf_map_area_free(smap); 737450af8d0SKP Singh } 738