From: Ihor Solodrai <ihor.solodrai@linux.dev>
To: Alexei Starovoitov <ast@kernel.org>,
Andrii Nakryiko <andrii@kernel.org>,
Daniel Borkmann <daniel@iogearbox.net>,
Eduard Zingerman <eddyz87@gmail.com>,
Kumar Kartikeya Dwivedi <memxor@gmail.com>,
Quentin Monnet <qmo@kernel.org>
Cc: bpf@vger.kernel.org, Alan Maguire <alan.maguire@oracle.com>,
Cupertino Miranda <cupertino.miranda@oracle.com>,
David Faust <david.faust@oracle.com>,
Ian Rogers <irogers@google.com>,
"Jose E . Marchesi" <jose.marchesi@oracle.com>,
Vineet Gupta <vineet.gupta@linux.dev>,
Yonghong Song <yonghong.song@linux.dev>
Subject: [PATCH bpf-next v2 8/8] bpftool: Document __bpf_relocatable and __bpf_static_offset
Date: Fri, 23 Oct 2026 15:26:52 -0700 [thread overview]
Message-ID: <20261023222652.3927736-9-ihor.solodrai@linux.dev> (raw)
In-Reply-To: <20261023222652.3927736-1-ihor.solodrai@linux.dev>
The C dump annotates records with the __bpf_relocatable and
__bpf_static_offset macros. Programs control the attributes through
these macros and BPF_NO_PRESERVE_ACCESS_INDEX, which disables only
__bpf_relocatable.
Update bpftool documentation to explain both macros, and how to avoid
the Clang crash on CO-RE field-info builtins over __bpf_static_offset
types.
Signed-off-by: Ihor Solodrai <ihor.solodrai@linux.dev>
---
.../bpf/bpftool/Documentation/bpftool-btf.rst | 24 +++++++++++++++++++
1 file changed, 24 insertions(+)
diff --git a/tools/bpf/bpftool/Documentation/bpftool-btf.rst b/tools/bpf/bpftool/Documentation/bpftool-btf.rst
index c6dc445cd4a1..37fef36a14fb 100644
--- a/tools/bpf/bpftool/Documentation/bpftool-btf.rst
+++ b/tools/bpf/bpftool/Documentation/bpftool-btf.rst
@@ -70,6 +70,30 @@ bpftool btf dump *BTF_SRC* [format *FORMAT*] [root_id *ROOT_ID*]
formatting, the output is sorted by default. Use the **unsorted** option
to avoid sorting the output.
+ C output annotates struct and union definitions individually. Most
+ records carry ``__attribute__((__bpf_relocatable))``. The generated
+ header defines ``__bpf_relocatable`` as ``preserve_access_index`` where
+ supported, or as empty when **BPF_NO_PRESERVE_ACCESS_INDEX** is defined
+ or the compiler lacks the attribute. GCC-BPF can apply CO-RE through
+ these attributes.
+
+ Context and socket types whose field accesses the verifier rewrites
+ carry ``__attribute__((__bpf_static_offset))`` instead, and their nested
+ anonymous records carry no attribute. ``__bpf_static_offset`` expands to
+ ``preserve_static_offset`` where supported (Clang 18 and later), or to
+ empty otherwise. The attribute keeps static field offsets in load and
+ store instruction immediates. **BPF_NO_PRESERVE_ACCESS_INDEX** does
+ not affect ``__bpf_static_offset``.
+
+ Either macro may be pre-defined as a bare attribute name, such as
+ ``preserve_access_index``, or as empty to override the policy.
+
+ Clang 18 through 23 crash when ``__builtin_preserve_field_info`` is used
+ on a type marked ``__bpf_static_offset``, including through
+ ``bpf_core_field_*`` and the CO-RE bitfield helpers. Compile with
+ ``-D__bpf_static_offset=`` to use these helpers with an affected
+ compiler.
+
**root_id** option can be used to filter a dump to a single type and all
its dependent types. It cannot be used with any other types of filtering
(such as the "key", "value", or "kv" arguments when dumping BTF for a map).
--
2.56.0
next prev parent reply other threads:[~2026-10-23 22:28 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-10-23 22:26 [PATCH bpf-next v2 0/8] bpftool: Per-record CO-RE attributes in the C dump Ihor Solodrai
2026-10-23 22:26 ` [PATCH bpf-next v2 1/8] libbpf: Look up BTF strings without making BTF modifiable Ihor Solodrai
2026-10-23 22:39 ` sashiko-bot
2026-10-23 22:26 ` [PATCH bpf-next v2 2/8] selftests/bpf: Cover unknown BTF header-extension bytes in btf dump Ihor Solodrai
2026-10-23 22:26 ` [PATCH bpf-next v2 3/8] bpftool: Apply __bpf_relocatable per record on BTF dump Ihor Solodrai
2026-10-27 18:03 ` Andrii Nakryiko
2026-10-27 18:15 ` Ihor Solodrai
2026-10-27 18:21 ` Andrii Nakryiko
2026-10-27 18:26 ` Ihor Solodrai
2026-10-27 21:25 ` Ihor Solodrai
2026-10-23 22:26 ` [PATCH bpf-next v2 4/8] bpftool: Skip __bpf_relocatable on verifier-rewritten context types Ihor Solodrai
2026-10-27 18:06 ` Andrii Nakryiko
2026-10-27 18:10 ` Andrii Nakryiko
2026-10-27 18:17 ` Ihor Solodrai
2026-10-23 22:26 ` [PATCH bpf-next v2 5/8] bpftool: Emit __bpf_static_offset " Ihor Solodrai
2026-10-27 18:10 ` Andrii Nakryiko
2026-10-23 22:26 ` [PATCH bpf-next v2 6/8] selftests/bpf: Cover record attributes in bpftool BTF dumps Ihor Solodrai
2026-10-23 22:26 ` [PATCH bpf-next v2 7/8] selftests/bpf: Cover context and socket accesses through vmlinux.h Ihor Solodrai
2026-10-23 22:26 ` Ihor Solodrai [this message]
2026-10-23 22:28 ` [PATCH bpf-next v2 0/8] bpftool: Per-record CO-RE attributes in the C dump Vineet Gupta
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20261023222652.3927736-9-ihor.solodrai@linux.dev \
--to=ihor.solodrai@linux.dev \
--cc=alan.maguire@oracle.com \
--cc=andrii@kernel.org \
--cc=ast@kernel.org \
--cc=bpf@vger.kernel.org \
--cc=cupertino.miranda@oracle.com \
--cc=daniel@iogearbox.net \
--cc=david.faust@oracle.com \
--cc=eddyz87@gmail.com \
--cc=irogers@google.com \
--cc=jose.marchesi@oracle.com \
--cc=memxor@gmail.com \
--cc=qmo@kernel.org \
--cc=vineet.gupta@linux.dev \
--cc=yonghong.song@linux.dev \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox