linux-6.12.1/scripts/bpf_doc.py

2 # SPDX-License-Identifier: GPL-2.0-only
4 # Copyright (C) 2018-2019 Netronome Systems, Inc.
89     @filename: name of file to parse, usually include/uapi/linux/bpf.h in the
130         #   - "void"
131         #   - "type  name"
132         #   - "type *name"
133         #   - Same as above, with "const" and/or "struct" in front of type
134         #   - "..." (undefined number of arguments, for bpf_trace_printk())
198         if offset == -1:
353         Checks the number of helpers/syscalls documented within the header file
384 .. See git log include/uapi/linux/bpf.h in kernel tree for details.
386 .. SPDX-License-Identifier: Linux-man-pages-copyleft
389 .. located in file include/uapi/linux/bpf.h of the Linux kernel sources
391 .. repository (header and footer).
417                 version = subprocess.run(['make', '-s', '--no-print-directory', 'kernelversion'],
426             cmd = ['git', 'log', '-1', '--pretty=format:%cs', '--no-patch',
427                    '-L',
428                    '/{}/,/\\*\\//:include/uapi/linux/bpf.h'.format(delimiter)]
447         header = '''\
449 BPF-HELPERS
451 -------------------------------------------------------------------------------
453 -------------------------------------------------------------------------------
463 written in a pseudo-assembly language, then attached to one of the several
467 These functions are restricted to a white-list of helpers defined in the
480 without requiring any foreign-function interface. As a result, calling helpers
494         print(header.format(version=kernelVersion,
531 But as of this writing, the BPF sub-system is under heavy development. New eBPF
534 the efforts of the community, this page might not be up-to-date. If you want to
539 * *include/uapi/linux/bpf.h* is the main BPF header. It contains the full list
542 * *net/core/filter.c* contains the definition of most network-related helper
544 * *kernel/trace/bpf_trace.c* is the equivalent for most tracing program-related
553   **bpftool-feature**\\ (8) for details). Add the **unprivileged** keyword to
581 **tc-bpf**\\ (8)'''
628         header = '''\
632 -------------------------------------------------------------------------------
634 -------------------------------------------------------------------------------
642         print(header)
651     A printer for dumping collected information about helpers as C header to
782         header = '''\
783 /* This is auto-generated file. See bpf_doc.py for details. */
787         print(header)
855 # ../include/uapi/linux/bpf.h, use it as a default name for the file to parse,
856 # otherwise the --filename argument will be required from the command line.
859 bpfh = os.path.join(linuxRoot, 'include/uapi/linux/bpf.h')
867 Parse eBPF header file and generate documentation for the eBPF API.
868 The RST-formatted output produced can be turned into a manual page with the
871 argParser.add_argument('--header', action='store_true',
872                        help='generate C header file')
874     argParser.add_argument('--filename', help='path to include/uapi/linux/bpf.h',
877     argParser.add_argument('--filename', help='path to include/uapi/linux/bpf.h')
887 if args.header:
889         raise NotImplementedError('Only helpers header generation is supported')