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 v1 8/8] bpftool: Document __bpf_core_pai and __bpf_core_pso
Date: Thu, 15 Oct 2026 17:00:12 -0700 [thread overview]
Message-ID: <20261016000012.2232059-9-ihor.solodrai@linux.dev> (raw)
In-Reply-To: <20261016000012.2232059-1-ihor.solodrai@linux.dev>
The C dump annotates records with the __bpf_core_pai and
__bpf_core_pso macros. Programs control the attributes through these
macros and BPF_NO_PRESERVE_ACCESS_INDEX, which disables only
__bpf_core_pai.
Update bpftool documentation to explain __bpf_core_pai and
__bpf_core_pso macros.
Signed-off-by: Ihor Solodrai <ihor.solodrai@linux.dev>
---
.../bpf/bpftool/Documentation/bpftool-btf.rst | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/tools/bpf/bpftool/Documentation/bpftool-btf.rst b/tools/bpf/bpftool/Documentation/bpftool-btf.rst
index c6dc445cd4a1..0bd50c4fa68a 100644
--- a/tools/bpf/bpftool/Documentation/bpftool-btf.rst
+++ b/tools/bpf/bpftool/Documentation/bpftool-btf.rst
@@ -70,6 +70,24 @@ 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, with or
+ without **unsorted**. Most records carry
+ ``__attribute__((__bpf_core_pai))``. The generated header defines
+ ``__bpf_core_pai`` 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_core_pso))`` instead, and their nested
+ anonymous records carry no attribute. ``__bpf_core_pso`` 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_core_pso``.
+
+ Either macro may be pre-defined as a bare attribute name, such as
+ ``preserve_access_index``, or as empty to override the policy.
+
**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
prev parent reply other threads:[~2026-10-16 0:01 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-10-16 0:00 [PATCH bpf-next v1 0/8] bpftool: Per-record CO-RE attributes in the C dump Ihor Solodrai
2026-10-16 0:00 ` [PATCH bpf-next v1 1/8] bpftool: Dump C from a detached BTF copy Ihor Solodrai
2026-10-16 1:18 ` Alexei Starovoitov
2026-10-16 9:44 ` Alan Maguire
2026-10-16 9:25 ` Alan Maguire
2026-10-16 0:00 ` [PATCH bpf-next v1 2/8] selftests/bpf: Cover unknown BTF header-extension bytes in btf dump Ihor Solodrai
2026-10-16 0:00 ` [PATCH bpf-next v1 3/8] bpftool: Apply __bpf_core_pai per record on BTF dump Ihor Solodrai
2026-10-16 0:39 ` bot+bpf-ci
2026-10-16 1:17 ` Alexei Starovoitov
2026-10-16 0:00 ` [PATCH bpf-next v1 4/8] bpftool: Skip __bpf_core_pai on verifier-rewritten context types Ihor Solodrai
2026-10-16 0:00 ` [PATCH bpf-next v1 5/8] bpftool: Emit __bpf_core_pso " Ihor Solodrai
2026-10-16 1:27 ` Alexei Starovoitov
2026-10-16 5:49 ` Ihor Solodrai
2026-10-16 0:00 ` [PATCH bpf-next v1 6/8] selftests/bpf: Cover record attributes in bpftool BTF dumps Ihor Solodrai
2026-10-16 0:00 ` [PATCH bpf-next v1 7/8] selftests/bpf: Cover context and socket accesses through vmlinux.h Ihor Solodrai
2026-10-16 0:00 ` Ihor Solodrai [this message]
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=20261016000012.2232059-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.