Lines Matching +full:uapi +full:- +full:header
2 # SPDX-License-Identifier: GPL-2.0-only
4 # Copyright (C) 2018-2019 Netronome Systems, Inc.
95 @filename: name of file to parse, usually include/uapi/linux/bpf.h in the
137 # - "void"
138 # - "type name"
139 # - "type *name"
140 # - Same as above, with "const" and/or "struct" in front of type
141 # - "..." (undefined number of arguments, for bpf_trace_printk())
227 if offset == -1:
382 Checks the number of helpers/syscalls documented within the header file
413 .. See git log include/uapi/linux/bpf.h in kernel tree for details.
415 .. SPDX-License-Identifier: Linux-man-pages-copyleft
418 .. located in file include/uapi/linux/bpf.h of the Linux kernel sources
420 .. repository (header and footer).
446 version = subprocess.run(['make', '-s', '--no-print-directory', 'kernelversion'],
455 cmd = ['git', 'log', '-1', '--pretty=format:%cs', '--no-patch',
456 '-L',
457 '/{}/,/\\*\\//:include/uapi/linux/bpf.h'.format(delimiter)]
476 header = '''\
478 BPF-HELPERS
480 -------------------------------------------------------------------------------
482 -------------------------------------------------------------------------------
492 written in a pseudo-assembly language, then attached to one of the several
496 These functions are restricted to a white-list of helpers defined in the
509 without requiring any foreign-function interface. As a result, calling helpers
523 print(header.format(version=kernelVersion,
560 But as of this writing, the BPF sub-system is under heavy development. New eBPF
563 the efforts of the community, this page might not be up-to-date. If you want to
568 * *include/uapi/linux/bpf.h* is the main BPF header. It contains the full list
571 * *net/core/filter.c* contains the definition of most network-related helper
573 * *kernel/trace/bpf_trace.c* is the equivalent for most tracing program-related
582 **bpftool-feature**\\ (8) for details). Add the **unprivileged** keyword to
610 **tc-bpf**\\ (8)'''
657 header = '''\
661 -------------------------------------------------------------------------------
663 -------------------------------------------------------------------------------
671 print(header)
680 A printer for dumping collected information about helpers as C header to
811 header = '''\
812 /* This is auto-generated file. See bpf_doc.py for details. */
816 print(header)
902 # ../include/uapi/linux/bpf.h, use it as a default name for the file to parse,
903 # otherwise the --filename argument will be required from the command line.
906 bpfh = os.path.join(linuxRoot, 'include/uapi/linux/bpf.h')
914 Parse eBPF header file and generate documentation for the eBPF API.
915 The RST-formatted output produced can be turned into a manual page with the
918 argParser.add_argument('--header', action='store_true',
919 help='generate C header file')
921 argParser.add_argument('--filename', help='path to include/uapi/linux/bpf.h',
924 argParser.add_argument('--filename', help='path to include/uapi/linux/bpf.h')
934 if args.header:
936 raise NotImplementedError('Only helpers header generation is supported')