Skip to contentSkip to conversation

bpf: Document cfi_stubs and owner fields in struct bpf_struct_ops

PATCH Superseded Nirbhay Sharma 3 participants 4 messages Nov 19, 2025 – Nov 20, 2025

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 bpf: Document cfi_stubs and owner fields in struct bpf_struct_ops

Add missing kernel-doc documentation for the cfi_stubs and owner fields in struct bpf_struct_ops to fix the following warnings:

Warning: include/linux/bpf.h:1931 struct member 'cfi_stubs' not described in 'bpf_struct_ops'
Warning: include/linux/bpf.h:1931 struct member 'owner' not described in 'bpf_struct_ops'

The cfi_stubs field was added in commit 2cd3e3772e41 ("x86/cfi,bpf:
Fix bpf_struct_ops CFI") to provide CFI stub functions for trampolines, and the owner field is used for module reference counting.

---
 include/linux/bpf.h | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)
include/linux/bpf.h +8 -2
index d808253f2e94..d39b4b2c8f35 100644
@@ -1905,10 +1905,16 @@ struct btf_member;
  *	      reason, if this callback is not defined, the check is skipped as
  *	      the struct_ops map will have final verification performed in
  *	      @reg.
- * @type: BTF type.
- * @value_type: Value type.
+ * @cfi_stubs: Pointer to a structure of stub functions for CFI. These stubs
+ *	       provide the correct Control Flow Integrity hashes for the
+ *	       trampolines generated by BPF struct_ops.
+ * @owner: The module that owns this struct_ops. Used for module reference
+ *	   counting to ensure the module providing the struct_ops cannot be
+ *	   unloaded while in use.
  * @name: The name of the struct bpf_struct_ops object.
  * @func_models: Func models
+ * @type: BTF type.
+ * @value_type: Value type.
  * @type_id: BTF type id.
  * @value_id: BTF value id.
  */
Signature · 1 line
2.48.1
#1 lore raw
Quoted 29 lines · Nirbhay Sharma

Add missing kernel-doc documentation for the cfi_stubs and owner fields in struct bpf_struct_ops to fix the following warnings:

Warning: include/linux/bpf.h:1931 struct member 'cfi_stubs' not described in 'bpf_struct_ops'
Warning: include/linux/bpf.h:1931 struct member 'owner' not described in 'bpf_struct_ops'

The cfi_stubs field was added in commit 2cd3e3772e41 ("x86/cfi,bpf:
Fix bpf_struct_ops CFI") to provide CFI stub functions for trampolines, and the owner field is used for module reference counting.

---
  include/linux/bpf.h | 10 ++++++++--
  1 file changed, 8 insertions(+), 2 deletions(-)
include/linux/bpf.h +2 -2
index d808253f2e94..d39b4b2c8f35 100644
@@ -1905,10 +1905,16 @@ struct btf_member;
   *	      reason, if this callback is not defined, the check is skipped as
   *	      the struct_ops map will have final verification performed in
   *	      @reg.
- * @type: BTF type.
- * @value_type: Value type.
+ * @cfi_stubs: Pointer to a structure of stub functions for CFI. These stubs
+ *	       provide the correct Control Flow Integrity hashes for the

include/linux/bpf.h struct btf_member; · line 1919

Quoted 10 lines
include/linux/bpf.h +6 -0
+ *	       trampolines generated by BPF struct_ops.
+ * @owner: The module that owns this struct_ops. Used for module reference
+ *	   counting to ensure the module providing the struct_ops cannot be
+ *	   unloaded while in use.
   * @name: The name of the struct bpf_struct_ops object.
   * @func_models: Func models
+ * @type: BTF type.
+ * @value_type: Value type.
   * @type_id: BTF type id.
   * @value_id: BTF value id.

Please take this chance to remove all doc after func_models. Meaning remove type, value_type, type_id, and value_id. They were removed in commit 4c5763ed996a.

pw-bot: cr

#2 lore raw

PATCH v2 1/1 bpf: Document cfi_stubs and owner fields in struct bpf_struct_ops

Add missing kernel-doc documentation for the cfi_stubs and owner fields in struct bpf_struct_ops to fix the following warnings:

Warning: include/linux/bpf.h:1931 struct member 'cfi_stubs' not described in 'bpf_struct_ops'
Warning: include/linux/bpf.h:1931 struct member 'owner' not described in 'bpf_struct_ops'

The cfi_stubs field was added in commit 2cd3e3772e41 ("x86/cfi,bpf:
Fix bpf_struct_ops CFI") to provide CFI stub functions for trampolines, and the owner field is used for module reference counting.

---
Changes in v2:
- Removed documentation for non-existent fields (type, value_type, type_id, value_id) that were moved to bpf_struct_ops_desc in commit 4c5763ed996a

 include/linux/bpf.h | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)
include/linux/bpf.h +6 -4
index d808253f2e94..96851fa0494f 100644
@@ -1905,12 +1905,14 @@ struct btf_member;
  *	      reason, if this callback is not defined, the check is skipped as
  *	      the struct_ops map will have final verification performed in
  *	      @reg.
- * @type: BTF type.
- * @value_type: Value type.
+ * @cfi_stubs: Pointer to a structure of stub functions for CFI. These stubs
+ *	       provide the correct Control Flow Integrity hashes for the
+ *	       trampolines generated by BPF struct_ops.
+ * @owner: The module that owns this struct_ops. Used for module reference
+ *	   counting to ensure the module providing the struct_ops cannot be
+ *	   unloaded while in use.
  * @name: The name of the struct bpf_struct_ops object.
  * @func_models: Func models
- * @type_id: BTF type id.
- * @value_id: BTF value id.
  */
 struct bpf_struct_ops {
 	const struct bpf_verifier_ops *verifier_ops;
Signature · 1 line
2.48.1
#3 lore raw
This patch was applied to bpf/bpf-next.git (master) by Martin KaFai Lau <[email protected]>:

Hello:

This patch was applied to bpf/bpf-next.git (master) by Martin KaFai Lau <[email protected]>:

Quoted 9 lines · On Fri, 21 Nov 2025 02:16:21 +0530 you wrote:

Add missing kernel-doc documentation for the cfi_stubs and owner fields in struct bpf_struct_ops to fix the following warnings:

Warning: include/linux/bpf.h:1931 struct member 'cfi_stubs' not described in 'bpf_struct_ops'
Warning: include/linux/bpf.h:1931 struct member 'owner' not described in 'bpf_struct_ops'

[...]

Here is the summary with links:
- [v2] bpf: Document cfi_stubs and owner fields in struct bpf_struct_ops

    https://git.kernel.org/bpf/bpf-next/c/e0940c672ab4

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html