[PATCH] perf/docu: Update header documentation on BPF_PROG_INFO

[PATCH] perf/docu: Update header documentation on BPF_PROG_INFO

[Thomas Richter]

Update the perf.data file format description on header
section HEADER_BPF_PROG_INFO.
The information is taken from process_bpf_prog_info()
and write_bpf_prog_info() from file util/header.c.

Signed-off-by: Thomas Richter <tmricht@linux.ibm.com>
Acked-by: Sumanth Korikkar <sumanthk@linux.ibm.com>
Reviewed-by: Jan Polensky <japo@linux.ibm.com>
---
 tools/perf/Documentation/perf.data-file-format.txt | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/tools/perf/Documentation/perf.data-file-format.txt b/tools/perf/Documentation/perf.data-file-format.txt
index cd95ba09f727..0437eb5d9188 100644
--- a/tools/perf/Documentation/perf.data-file-format.txt
+++ b/tools/perf/Documentation/perf.data-file-format.txt
@@ -348,6 +348,16 @@ to special needs.
 
 struct perf_bpil, which contains detailed information about
 a BPF program, including type, id, tag, jited/xlated instructions, etc.
+The format of data in HEADER_BPF_PROG_INFO is as follows:
+	u32 count
+
+	struct perf_bpil {
+		u32 info_len;	/* size of struct bpf_prog_info, when the tool is compiled */
+		u32 data_len;	/* total bytes allocated for data, round up to 8 bytes */
+		u64 arrays;	/* which arrays are included in data */
+		struct bpf_prog_info info;
+		u8  data[];
+	}[count];
 
         HEADER_BPF_BTF = 26,
 
-- 
2.48.1

Re: [PATCH] perf/docu: Update header documentation on BPF_PROG_INFO

[Namhyung Kim]

Hello,

On Tue, Aug 05, 2025 at 11:03:49AM +0200, Thomas Richter wrote:
> Update the perf.data file format description on header
> section HEADER_BPF_PROG_INFO.
> The information is taken from process_bpf_prog_info()
> and write_bpf_prog_info() from file util/header.c.
> 
> Signed-off-by: Thomas Richter <tmricht@linux.ibm.com>
> Acked-by: Sumanth Korikkar <sumanthk@linux.ibm.com>
> Reviewed-by: Jan Polensky <japo@linux.ibm.com>

Acked-by: Namhyung Kim <namhyung@kernel.org>

Thanks,
Namhyung

> ---
>  tools/perf/Documentation/perf.data-file-format.txt | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/tools/perf/Documentation/perf.data-file-format.txt b/tools/perf/Documentation/perf.data-file-format.txt
> index cd95ba09f727..0437eb5d9188 100644
> --- a/tools/perf/Documentation/perf.data-file-format.txt
> +++ b/tools/perf/Documentation/perf.data-file-format.txt
> @@ -348,6 +348,16 @@ to special needs.
>  
>  struct perf_bpil, which contains detailed information about
>  a BPF program, including type, id, tag, jited/xlated instructions, etc.
> +The format of data in HEADER_BPF_PROG_INFO is as follows:
> +	u32 count
> +
> +	struct perf_bpil {
> +		u32 info_len;	/* size of struct bpf_prog_info, when the tool is compiled */
> +		u32 data_len;	/* total bytes allocated for data, round up to 8 bytes */
> +		u64 arrays;	/* which arrays are included in data */
> +		struct bpf_prog_info info;
> +		u8  data[];
> +	}[count];
>  
>          HEADER_BPF_BTF = 26,
>  
> -- 
> 2.48.1
>