2024-05-13 20:29 UTC+0100 ~ Mykyta Yatsenko mykyta.yatsenko5@xxxxxxxxx
> From: Mykyta Yatsenko <yatsenko@xxxxxxxx>
>
> Sort bpftool c dump output; aiming to simplify vmlinux.h diffing and
> forcing more natural type definitions ordering.
>
> Definitions are sorted first by their BTF kind ranks, then by their base
> type name and by their own name.
>
> Type ranks
>
> Assign ranks to btf kinds (defined in function btf_type_rank) to set
> next order:
> 1. Anonymous enums/enums64
> 2. Named enums/enums64
> 3. Trivial types typedefs (ints, then floats)
> 4. Structs/Unions
> 5. Function prototypes
> 6. Forward declarations
>
> Type rank is set to maximum for unnamed reference types, structs and
> unions to avoid emitting those types early. They will be emitted as
> part of the type chain starting with named type.
>
> Lexicographical ordering
>
> Each type is assigned a sort_name and own_name.
> sort_name is the resolved name of the final base type for reference
> types (typedef, pointer, array etc). Sorting by sort_name allows to
> group typedefs of the same base type. sort_name for non-reference type
> is the same as own_name. own_name is a direct name of particular type,
> is used as final sorting step.
>
> Signed-off-by: Mykyta Yatsenko <yatsenko@xxxxxxxx>
> ---
> .../bpf/bpftool/Documentation/bpftool-btf.rst | 5 +-
> tools/bpf/bpftool/bash-completion/bpftool | 3 +
> tools/bpf/bpftool/btf.c | 138 +++++++++++++++++-
> 3 files changed, 139 insertions(+), 7 deletions(-)
>
> diff --git a/tools/bpf/bpftool/Documentation/bpftool-btf.rst b/tools/bpf/bpftool/Documentation/bpftool-btf.rst
> index eaba24320fb2..65eeb3d905f0 100644
> --- a/tools/bpf/bpftool/Documentation/bpftool-btf.rst
> +++ b/tools/bpf/bpftool/Documentation/bpftool-btf.rst
> @@ -28,7 +28,7 @@ BTF COMMANDS
> | **bpftool** **btf help**
> |
> | *BTF_SRC* := { **id** *BTF_ID* | **prog** *PROG* | **map** *MAP* [{**key** | **value** | **kv** | **all**}] | **file** *FILE* }
> -| *FORMAT* := { **raw** | **c** }
> +| *FORMAT* := { **raw** | **c** [**unsorted**]}
Missing space at the end, "[**unsorted**] }"
> | *MAP* := { **id** *MAP_ID* | **pinned** *FILE* }
> | *PROG* := { **id** *PROG_ID* | **pinned** *FILE* | **tag** *PROG_TAG* | **name** *PROG_NAME* }
>
> @@ -63,7 +63,8 @@ bpftool btf dump *BTF_SRC*
> pahole.
>
> **format** option can be used to override default (raw) output format. Raw
> - (**raw**) or C-syntax (**c**) output formats are supported.
> + (**raw**) or C-syntax (**c**) output formats are supported. (**unsorted**)
> + option can be used with (**c**) to avoid sorting the output.
The parenthesis are not part of the formatting here, they are used in
the previous sentence to mention the keyword related to the options
mentioned in the sentence. So here we could have:
"With C-style formatting, the output is sorted by default. Use the
**unsorted** option to avoid sorting the output."
>
> bpftool btf help
> Print short help message.
> diff --git a/tools/bpf/bpftool/bash-completion/bpftool b/tools/bpf/bpftool/bash-completion/bpftool
> index 04afe2ac2228..be99d49b8714 100644
> --- a/tools/bpf/bpftool/bash-completion/bpftool
> +++ b/tools/bpf/bpftool/bash-completion/bpftool
> @@ -930,6 +930,9 @@ _bpftool()
> format)
> COMPREPLY=( $( compgen -W "c raw" -- "$cur" ) )
> ;;
> + c)
> + COMPREPLY=( $( compgen -W "unsorted" -- "$cur" ) )
> + ;;
> *)
> # emit extra options
> case ${words[3]} in
> diff --git a/tools/bpf/bpftool/btf.c b/tools/bpf/bpftool/btf.c
> index 91fcb75babe3..7e7071d301df 100644
> --- a/tools/bpf/bpftool/btf.c
> +++ b/tools/bpf/bpftool/btf.c
[...]
> @@ -1063,7 +1191,7 @@ static int do_help(int argc, char **argv)
> " %1$s %2$s help\n"
> "\n"
> " BTF_SRC := { id BTF_ID | prog PROG | map MAP [{key | value | kv | all}] | file FILE }\n"
> - " FORMAT := { raw | c }\n"
> + " FORMAT := { raw | c [unsorted]}\n"
Missing space as well: "[unsorted] }\n"
> " " HELP_SPEC_MAP "\n"
> " " HELP_SPEC_PROGRAM "\n"
> " " HELP_SPEC_OPTIONS " |\n"
With the above addressed:
Reviewed-by: Quentin Monnet <qmo@xxxxxxxxxx>
