linux-kernel - Re: [PATCH] bpf: Document cfi_stubs and owner fields in struct bpf_struct

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <f87d1365-a3b6-4307-9d72-91d5f5b2c585@linux.dev>
Date: Thu, 20 Nov 2025 11:29:17 -0800
From: Martin KaFai Lau <martin.lau@...ux.dev>
To: Nirbhay Sharma <nirbhay.lkd@...il.com>
Cc: Alexei Starovoitov <ast@...nel.org>,
 Daniel Borkmann <daniel@...earbox.net>, Andrii Nakryiko <andrii@...nel.org>,
 Eduard Zingerman <eddyz87@...il.com>, Song Liu <song@...nel.org>,
 Yonghong Song <yonghong.song@...ux.dev>,
 John Fastabend <john.fastabend@...il.com>, KP Singh <kpsingh@...nel.org>,
 Stanislav Fomichev <sdf@...ichev.me>, Hao Luo <haoluo@...gle.com>,
 Jiri Olsa <jolsa@...nel.org>, skhan@...uxfoundation.org,
 david.hunter.linux@...il.com,
 linux-kernel-mentees@...ts.linuxfoundation.org, bpf@...r.kernel.org,
 linux-kernel@...r.kernel.org
Subject: Re: [PATCH] bpf: Document cfi_stubs and owner fields in struct
 bpf_struct_ops



On 11/18/25 10:24 PM, Nirbhay Sharma 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'
> 
> 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.
> 
> Signed-off-by: Nirbhay Sharma <nirbhay.lkd@...il.com>
> ---
>   include/linux/bpf.h | 10 ++++++++--
>   1 file changed, 8 insertions(+), 2 deletions(-)
> 
> diff --git a/include/linux/bpf.h b/include/linux/bpf.h
> index d808253f2e94..d39b4b2c8f35 100644
> --- a/include/linux/bpf.h
> +++ b/include/linux/bpf.h
> @@ -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.

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