Skip to content

Local kptrs, BPF linked lists

Kumar Kartikeya Dwivedi bpf 5 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v5 Latest25 patches 29 repliesIn review
  2. v424 patches 31 repliesSuperseded 8 of 24 applied
  3. v324 patches 0 repliesSuperseded
Earlier versions · 2
VersionPostedPatchesRepliesStatus
v225 patches25 repliesSuperseded
v125 patches1 replySuperseded

Changes in v5 from the cover letter

v4: https://lore.kernel.org/bpf/[email protected]

* Add a lot more selftests (failure, success, runtime, BTF)
* Make sure series is bisect friendly
* Move list draining out of spin lock
* This exposed an issue where bpf_mem_free can now be called in map_free path without migrate_disable, also fixed that.
* Rename MEM_ALLOC -> MEM_RINGBUF, MEM_TYPE_LOCAL -> MEM_ALLOC (Alexei)
* Group lock identity into a struct active_lock { ptr, id } (Dave)
* Split set_release_on_unlock logic into separate patch (Alexei)

Patches in v5 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/25bpf: Remove BPF_MAP_OFF_ARR_MAXinclude/linux/bpf.h kernel/bpf/btf.c+5 -60 replies
2/25bpf: Fix copy_map_value, zero_map_valueinclude/linux/bpf.h+2 -20 replies
3/25bpf: Support bpf_list_head in map valuesinclude/linux/bpf.h include/uapi/linux/bpf.h kernel/bpf/btf.c +4 more+237 -48 replies
4/25bpf: Rename RET_PTR_TO_ALLOC_MEMinclude/linux/bpf.h kernel/bpf/verifier.c+4 -41 reply
5/25bpf: Rename MEM_ALLOC to MEM_RINGBUFinclude/linux/bpf.h kernel/bpf/ringbuf.c kernel/bpf/verifier.c +3 more+17 -205 replies
6/25bpf: Introduce local kptrsinclude/linux/bpf.h include/linux/filter.h kernel/bpf/btf.c +5 more+99 -687 replies
7/25bpf: Recognize bpf_{spin_lock,list_head,list_node} in local kptrsinclude/linux/bpf.h include/linux/btf.h kernel/bpf/btf.c +1 more+224 -180 replies
8/25bpf: Verify ownership relationships for user BTF typesinclude/linux/bpf.h include/linux/btf.h kernel/bpf/btf.c +1 more+77 -00 replies
9/25bpf: Allow locking bpf_spin_lock in local kptrkernel/bpf/helpers.c kernel/bpf/verifier.c+55 -170 replies
10/25bpf: Allow locking bpf_spin_lock global variablesinclude/linux/bpf_verifier.h kernel/bpf/verifier.c+32 -142 replies
11/25bpf: Allow locking bpf_spin_lock in inner map valueskernel/bpf/map_in_map.c+0 -50 replies
12/25bpf: Rewrite kfunc argument handlinginclude/linux/btf.h kernel/bpf/btf.c kernel/bpf/verifier.c +3 more+569 -330 replies
13/25bpf: Drop kfunc bits from btf_check_func_arg_matchinclude/linux/bpf.h include/linux/bpf_verifier.h kernel/bpf/btf.c +1 more+10 -3710 replies
14/25bpf: Support constant scalar arguments for kfuncsDocumentation/bpf/kfuncs.rst kernel/bpf/verifier.c+75 -140 replies
15/25bpf: Teach verifier about non-size constant argumentsinclude/linux/bpf_verifier.h kernel/bpf/verifier.c+76 -452 replies
16/25bpf: Introduce bpf_obj_newinclude/linux/bpf.h include/linux/bpf_verifier.h kernel/bpf/core.c +3 more+195 -230 replies
17/25bpf: Introduce bpf_obj_dropkernel/bpf/helpers.c kernel/bpf/verifier.c tools/testing/selftests/bpf/bpf_experimental.h+79 -110 replies
18/25bpf: Permit NULL checking pointer with non-zero fixed offsetkernel/bpf/verifier.c+9 -40 replies
19/25bpf: Introduce single ownership BPF linked list APIkernel/bpf/helpers.c kernel/bpf/verifier.c tools/testing/selftests/bpf/bpf_experimental.h+361 -140 replies
20/25bpf: Add 'release on unlock' logic for bpf_list_push_{front,back}include/linux/bpf_verifier.h kernel/bpf/verifier.c+52 -10 replies
21/25selftests/bpf: Add __contains macro to bpf_experimental.htools/testing/selftests/bpf/bpf_experimental.h+2 -00 replies
22/25selftests/bpf: Update spinlock selftesttools/testing/selftests/bpf/prog_tests/spin_lock.c tools/testing/selftests/bpf/prog_tests/spinlock.c tools/testing/selftests/bpf/progs/test_spin_lock.c+48 -472 replies
23/25selftests/bpf: Add failure test cases for spin lock pairingtools/testing/selftests/bpf/prog_tests/spin_lock.c tools/testing/selftests/bpf/progs/test_spin_lock_fail.c+292 -10 replies
24/25selftests/bpf: Add BPF linked list API teststools/testing/selftests/bpf/DENYLIST.s390x tools/testing/selftests/bpf/prog_tests/linked_list.c tools/testing/selftests/bpf/progs/linked_list.c +2 more+1261 -00 replies
25/25selftests/bpf: Add BTF sanity teststools/testing/selftests/bpf/prog_tests/linked_list.c+271 -02 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v5 yet.

Read the v5 thread

Cover letter [PATCH bpf-next v5 00/25] Local kptrs, BPF linked lists

This series introduces user defined BPF objects, by introducing local kptrs. These are kptrs (strongly typed pointers) that refer to objects of a user defined type, hence called "local" kptrs. This allows BPF programs to allocate their own objects, build their own object hierarchies, and use the basic building blocks provided by BPF runtime to build their own data structures flexibly.

Then, we introduce the support for single ownership BPF linked lists, which can be put inside BPF maps, or local kptrs, and hold such allocated local kptrs as elements. It works as an instrusive collection, which is done to allow making local kptrs part of multiple data structures at the same time in the future.

The eventual goal of this and future patches is to allow one to do some limited form of kernel style programming in BPF C, and allow programmers to build their own complex data structures flexibly out of basic building blocks.

The key difference will be that such programs are verified to be safe, preserve runtime integrity of the system, and are proven to be bug free as far as the invariants of BPF specific APIs are concerned.

One immediate use case that will be using the entire infrastructure this series is introducing will be managing percpu NMI safe linked lists inside BPF programs.

The other use case this will serve in the near future will be linking kernel structures like XDP frame and sk_buff directly into user data structures (rbtree, pifomap, etc.) for packet queueing. This will follow single ownership concept included in this series.

The user has complete control of the internal locking, and hence also the batching of operations for each critical section.

The features are:
- Local kptrs - User defined kernel objects.
- bpf_obj_new, bpf_obj_drop to allocate and free them.
- Single ownership BPF linked lists.
- Support for them in BPF maps.
- Support for them in local kptrs.
- Global spin locks.
- Spin locks inside local kptrs.

Some other notable things:
- Completely static verification of locking.
- Kfunc argument handling has been completely reworked.
- Argument rewriting support for kfuncs.
- Search pruning now understands non-size precise registers.
- A new bpf_experimental.h header as a dumping ground for these APIs.

Any functionality exposed in this series is NOT part of UAPI. It is only available through use of kfuncs, and structs that can be added to map value may also change their size or name in the future. Hence, every feature in this series must be considered experimental.

Follow-ups:
-----------
* Support for kptrs (local and kernel) in local storage and percpu maps + kptr tests
* Fixes for helper access checks rebasing on top of this series

Next steps:
-----------
* NMI safe percpu single ownership linked lists (using local_t protection).
* Lockless linked lists.
* Allow RCU protected local kptrs. This then allows RCU protected list lookups, since spinlock protection for readers does not scale.
* Introduce bpf_refcount for local kptrs, shared ownership.
* Introduce shared ownership linked lists.
* Documentation.

Changelog:
----------
v4 -> v5
v4: https://lore.kernel.org/bpf/[email protected]

* Add a lot more selftests (failure, success, runtime, BTF)
* Make sure series is bisect friendly
* Move list draining out of spin lock
* This exposed an issue where bpf_mem_free can now be called in map_free path without migrate_disable, also fixed that.
* Rename MEM_ALLOC -> MEM_RINGBUF, MEM_TYPE_LOCAL -> MEM_ALLOC (Alexei)
* Group lock identity into a struct active_lock { ptr, id } (Dave)
* Split set_release_on_unlock logic into separate patch (Alexei)

v3 -> v4
v3: https://lore.kernel.org/bpf/[email protected]

* Fix compiler error for !CONFIG_BPF_SYSCALL (Kernel Test Robot)
* Fix error due to BUILD_BUG_ON on 32-bit platforms (Kernel Test Robot)

v2 -> v3
v2: https://lore.kernel.org/bpf/[email protected]

* Add ack from Dave for patch 5
* Rename btf_type_fields -> btf_record, btf_type_fields_off -> btf_field_offs, rename functions similarly (Alexei)
* Remove 'kind' component from contains declaration tag (Alexei)
* Move bpf_list_head, bpf_list_node definitions to UAPI bpf.h (Alexei)
* Add note in commit log about modifying btf_struct_access API (Dave)
* Downgrade WARN_ON_ONCE to verbose(env, "...") and return -EFAULT (Dave)
* Add type_is_local_kptr wrapper to avoid noisy checks (Dave)
* Remove unused flags parameter from bpf_kptr_new (Alexei)
* Rename bpf_kptr_new -> bpf_obj_new, bpf_kptr_drop -> bpf_obj_drop (Alexei)
* Reword comment in ref_obj_id_set_release_on_unlock (Dave)
* Fix return type of ref_obj_id_set_release_on_unlock (Dave)
* Introduce is_bpf_list_api_kfunc to dedup checks (Dave)
* Disallow BPF_WRITE to untrusted local kptrs
* Add details about soundness of check_reg_allocation_locked logic
* List untrusted local kptrs for PROBE_MEM handling

v1 -> v2
v1: https://lore.kernel.org/bpf/[email protected]

* Rebase on bpf-next to resolve merge conflict in DENYLIST.s390x
* Fix a couple of mental lapses in bpf_list_head_free

RFC v1 -> v1
RFC v1: https://lore.kernel.org/bpf/[email protected]

* Mostly a complete rewrite of BTF parsing, refactor existing code (Kartikeya)
* Rebase kfunc rewrite for bpf-next, add support for more changes
* Cache type metadata in BTF to avoid recomputation inside verifier (Kartikeya)
* Remove __kernel tag, make things similar to map values, reserve bpf_ prefix
* bpf_kptr_new, bpf_kptr_drop
* Rename precision state enum values (Alexei)
* Drop explicit constructor/destructor support (Alexei)
* Rewrite code for constructing/destructing objects and offload to runtime
* Minimize duplication in bpf_map_value_off_desc handling (Alexei)
* Expose global memory allocator (Alexei)
* Address other nits from Alexei
* Split out local kptrs in maps, more kptrs in maps support into a follow up

Links:
------
* Dave's BPF RB-Tree RFC series
v1 (Discussion thread)

     https://lore.kernel.org/bpf/[email protected]
   v2 (With support for static locks)
     https://lore.kernel.org/bpf/[email protected]

* BPF Linked Lists Discussion
https://lore.kernel.org/bpf/CAP01T74U30+yeBHEgmgzTJ-XYxZ0zj71kqCDJtTH9YQNfTK+Xw@mail.gmail.com
* BPF Memory Allocator from Alexei
https://lore.kernel.org/bpf/[email protected]
* BPF Memory Allocator UAPI Discussion
https://lore.kernel.org/bpf/[email protected]

Kumar Kartikeya Dwivedi (25):
bpf: Remove BPF_MAP_OFF_ARR_MAX
bpf: Fix copy_map_value, zero_map_value
bpf: Support bpf_list_head in map values
bpf: Rename RET_PTR_TO_ALLOC_MEM
bpf: Rename MEM_ALLOC to MEM_RINGBUF
bpf: Introduce local kptrs
bpf: Recognize bpf_{spin_lock,list_head,list_node} in local kptrs
bpf: Verify ownership relationships for user BTF types
bpf: Allow locking bpf_spin_lock in local kptr
bpf: Allow locking bpf_spin_lock global variables
bpf: Allow locking bpf_spin_lock in inner map values
bpf: Rewrite kfunc argument handling
bpf: Drop kfunc bits from btf_check_func_arg_match
bpf: Support constant scalar arguments for kfuncs
bpf: Teach verifier about non-size constant arguments
bpf: Introduce bpf_obj_new
bpf: Introduce bpf_obj_drop
bpf: Permit NULL checking pointer with non-zero fixed offset
bpf: Introduce single ownership BPF linked list API
bpf: Add 'release on unlock' logic for bpf_list_push_{front,back} selftests/bpf: Add __contains macro to bpf_experimental.h selftests/bpf: Update spinlock selftest
selftests/bpf: Add failure test cases for spin lock pairing selftests/bpf: Add BPF linked list API tests selftests/bpf: Add BTF sanity tests

 Documentation/bpf/kfuncs.rst                  |   30 +
 include/linux/bpf.h                           |  113 +-
 include/linux/bpf_verifier.h                  |   24 +-
 include/linux/btf.h                           |   67 +-
 include/linux/filter.h                        |    8 +-
 include/uapi/linux/bpf.h                      |   10 +
 kernel/bpf/btf.c                              |  808 +++++-----
 kernel/bpf/core.c                             |   16 +
 kernel/bpf/helpers.c                          |  143 +-
 kernel/bpf/map_in_map.c                       |    5 -
 kernel/bpf/ringbuf.c                          |    6 +-
 kernel/bpf/syscall.c                          |   30 +-
 kernel/bpf/verifier.c                         | 1346 +++++++++++++++--
 net/bpf/bpf_dummy_struct_ops.c                |   14 +-
 net/core/filter.c                             |   34 +-
 net/ipv4/bpf_tcp_ca.c                         |   13 +-
 net/netfilter/nf_conntrack_bpf.c              |   17 +-
 tools/include/uapi/linux/bpf.h                |   10 +
 tools/testing/selftests/bpf/DENYLIST.s390x    |    1 +
 .../testing/selftests/bpf/bpf_experimental.h  |   68 +
 .../testing/selftests/bpf/prog_tests/dynptr.c |    2 +-
 .../bpf/prog_tests/kfunc_dynptr_param.c       |    2 +-
 .../selftests/bpf/prog_tests/linked_list.c    |  524 +++++++
 .../selftests/bpf/prog_tests/spin_lock.c      |  133 ++
 .../selftests/bpf/prog_tests/spinlock.c       |   45 -
 .../testing/selftests/bpf/progs/linked_list.c |  370 +++++
 .../testing/selftests/bpf/progs/linked_list.h |   56 +
 .../selftests/bpf/progs/linked_list_fail.c    |  581 +++++++
 .../selftests/bpf/progs/test_spin_lock.c      |    4 +-
 .../selftests/bpf/progs/test_spin_lock_fail.c |  204 +++
 tools/testing/selftests/bpf/verifier/calls.c  |    2 +-
 .../selftests/bpf/verifier/ref_tracking.c     |    4 +-
 .../testing/selftests/bpf/verifier/ringbuf.c  |    2 +-
 .../selftests/bpf/verifier/spill_fill.c       |    2 +-
 34 files changed, 4012 insertions(+), 682 deletions(-)
 create mode 100644 tools/testing/selftests/bpf/bpf_experimental.h
 create mode 100644 tools/testing/selftests/bpf/prog_tests/linked_list.c
 create mode 100644 tools/testing/selftests/bpf/prog_tests/spin_lock.c
 delete mode 100644 tools/testing/selftests/bpf/prog_tests/spinlock.c
 create mode 100644 tools/testing/selftests/bpf/progs/linked_list.c
 create mode 100644 tools/testing/selftests/bpf/progs/linked_list.h
 create mode 100644 tools/testing/selftests/bpf/progs/linked_list_fail.c
 create mode 100644 tools/testing/selftests/bpf/progs/test_spin_lock_fail.c

base-commit: 25906092edb4bcf94cb669bd1ed03a0ef2f4120c
prerequisite-patch-id: c763e9eecf8258840e7db20e4475c26f4c7800bc
prerequisite-patch-id: 553e0a3f3035d36a96bdcc798793cbecc519d3e7

Signature · 1 line
2.38.1