linux/samples/bpf
Ilya Leoshkevich c0ca277bb8 samples/bpf: Use bpf_{btf,link,map,prog}_get_info_by_fd()
Use the new type-safe wrappers around bpf_obj_get_info_by_fd().

Signed-off-by: Ilya Leoshkevich <iii@linux.ibm.com>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
Link: https://lore.kernel.org/bpf/20230214231221.249277-5-iii@linux.ibm.com
2023-02-16 15:32:45 -08:00
..
gnu samples/bpf: Change _kern suffix to .bpf with syscall tracing program 2022-12-29 14:22:34 -08:00
.gitignore samples/bpf: Update .gitignore 2021-10-08 11:58:58 -07:00
asm_goto_workaround.h
bpf_insn.h samples/bpf: Relicense bpf_insn.h as GPL-2.0-only OR BSD-2-Clause 2021-09-29 16:03:55 +02:00
cookie_uid_helper_example.c samples/bpf: Get rid of deprecated libbpf API uses 2021-12-02 15:23:40 -08:00
cpustat_kern.c samples: bpf: Refactor tracepoint tracing programs with libbpf 2020-08-24 20:59:35 -07:00
cpustat_user.c samples/bpf: Use libbpf 1.0 API mode instead of RLIMIT_MEMLOCK 2022-04-10 20:17:15 -07:00
do_hbm_test.sh samples: bpf: Fix a spelling typo in do_hbm_test.sh 2021-03-15 22:17:35 -07:00
fds_example.c samples: bpf: Replace sizeof(arr)/sizeof(arr[0]) with ARRAY_SIZE 2022-07-13 21:43:52 -07:00
hash_func01.h
hbm_edt_kern.c samples/bpf: Fix double word in comments 2022-10-19 11:21:49 -07:00
hbm_kern.h samples/bpf: Clean up samples/bpf build failes 2021-12-02 15:23:40 -08:00
hbm_out_kern.c
hbm.c samples/bpf: Use libbpf 1.0 API mode instead of RLIMIT_MEMLOCK 2022-04-10 20:17:15 -07:00
hbm.h
ibumad_kern.c samples: bpf: Ix kernel-doc syntax in file header 2021-05-24 21:06:02 -07:00
ibumad_user.c samples/bpf: Use libbpf 1.0 API mode instead of RLIMIT_MEMLOCK 2022-04-10 20:17:15 -07:00
lathist_kern.c samples: bpf: Refactor kprobe tracing programs with libbpf 2020-08-24 20:59:35 -07:00
lathist_user.c samples: bpf: Refactor kprobe tracing programs with libbpf 2020-08-24 20:59:35 -07:00
lwt_len_hist_user.c samples: bpf: Fix build error 2020-05-14 12:37:39 -07:00
lwt_len_hist.bpf.c samples/bpf: change _kern suffix to .bpf with BPF test programs 2023-01-15 13:32:45 -08:00
lwt_len_hist.sh samples/bpf: change _kern suffix to .bpf with BPF test programs 2023-01-15 13:32:45 -08:00
Makefile samples/bpf: change _kern suffix to .bpf with BPF test programs 2023-01-15 13:32:45 -08:00
Makefile.target samples/bpf: Clean up samples/bpf build failes 2021-12-02 15:23:40 -08:00
map_perf_test_user.c samples/bpf: Change _kern suffix to .bpf with syscall tracing program 2022-12-29 14:22:34 -08:00
map_perf_test.bpf.c samples/bpf: Use BPF_KSYSCALL macro in syscall tracing programs 2022-12-29 14:22:34 -08:00
net_shared.h samples/bpf: replace BPF programs header with net_shared.h 2023-01-15 13:32:45 -08:00
offwaketime_kern.c samples/bpf/test_overhead_kprobe_kern: replace bpf_probe_read_kernel with bpf_probe_read_kernel_str to get task comm 2022-01-20 08:52:53 +02:00
offwaketime_user.c samples/bpf: Use libbpf 1.0 API mode instead of RLIMIT_MEMLOCK 2022-04-10 20:17:15 -07:00
parse_ldabs.c
parse_simple.c
parse_varlen.c
README.rst samples/bpf: Fix typo in README 2022-11-01 15:25:21 +01:00
run_cookie_uid_helper_example.sh
sampleip_kern.c bpf: Remove unused headers 2021-03-25 22:03:46 -07:00
sampleip_user.c samples, bpf: Refactor pointer error check with libbpf 2020-05-19 17:12:49 +02:00
sock_example.c samples: bpf: Replace sizeof(arr)/sizeof(arr[0]) with ARRAY_SIZE 2022-07-13 21:43:52 -07:00
sock_example.h
sock_flags.bpf.c samples/bpf: change _kern suffix to .bpf with BPF test programs 2023-01-15 13:32:45 -08:00
sockex1_kern.c
sockex1_user.c samples/bpf: Get rid of deprecated libbpf API uses 2021-12-02 15:23:40 -08:00
sockex2_kern.c samples/bpf: Remove compiler warnings 2020-05-13 12:30:50 -07:00
sockex2_user.c samples/bpf: Use libbpf 1.0 API mode instead of RLIMIT_MEMLOCK 2022-04-10 20:17:15 -07:00
sockex3_kern.c samples/bpf: Fix sockex3 error: Missing BPF prog type 2022-11-07 17:13:35 -08:00
sockex3_user.c samples/bpf: Fix sockex3 error: Missing BPF prog type 2022-11-07 17:13:35 -08:00
spintest_kern.c samples: bpf: Refactor kprobe tracing programs with libbpf 2020-08-24 20:59:35 -07:00
spintest_user.c samples/bpf: Use libbpf 1.0 API mode instead of RLIMIT_MEMLOCK 2022-04-10 20:17:15 -07:00
syscall_nrs.c
syscall_tp_kern.c samples/bpf: Add openat2() enter/exit tracepoint to syscall_tp sample 2023-02-08 16:50:42 -08:00
syscall_tp_user.c samples/bpf: Use libbpf 1.0 API mode instead of RLIMIT_MEMLOCK 2022-04-10 20:17:15 -07:00
task_fd_query_kern.c samples/bpf: Replace blk_account_io_done() with __blk_account_io_done() 2022-09-20 17:25:59 -07:00
task_fd_query_user.c samples/bpf: Replace blk_account_io_done() with __blk_account_io_done() 2022-09-20 17:25:59 -07:00
tc_l2_redirect_kern.c
tc_l2_redirect_user.c
tc_l2_redirect.sh samples/bpf: ensure ipv6 is enabled before running tests 2023-01-15 13:32:45 -08:00
tcbpf1_kern.c
tcp_basertt_kern.c
tcp_bpf.readme
tcp_bufs_kern.c
tcp_clamp_kern.c
tcp_cong_kern.c
tcp_dumpstats_kern.c
tcp_iw_kern.c
tcp_rwnd_kern.c
tcp_synrto_kern.c
tcp_tos_reflect_kern.c
test_cgrp2_array_pin.c samples/bpf: Get rid of deprecated libbpf API uses 2021-12-02 15:23:40 -08:00
test_cgrp2_attach.c samples: bpf: Replace sizeof(arr)/sizeof(arr[0]) with ARRAY_SIZE 2022-07-13 21:43:52 -07:00
test_cgrp2_sock2.c samples: bpf: Refactor test_cgrp2_sock2 program with libbpf 2020-11-26 19:33:35 -08:00
test_cgrp2_sock2.sh samples/bpf: change _kern suffix to .bpf with BPF test programs 2023-01-15 13:32:45 -08:00
test_cgrp2_sock.c samples/bpf: Get rid of deprecated libbpf API uses 2021-12-02 15:23:40 -08:00
test_cgrp2_sock.sh samples/bpf: refactor BPF functionality testing scripts 2023-01-15 13:32:45 -08:00
test_cgrp2_tc.bpf.c samples/bpf: change _kern suffix to .bpf with BPF test programs 2023-01-15 13:32:45 -08:00
test_cgrp2_tc.sh samples/bpf: change _kern suffix to .bpf with BPF test programs 2023-01-15 13:32:45 -08:00
test_cls_bpf.sh
test_current_task_under_cgroup_user.c samples/bpf: Change _kern suffix to .bpf with syscall tracing program 2022-12-29 14:22:34 -08:00
test_current_task_under_cgroup.bpf.c samples/bpf: Use BPF_KSYSCALL macro in syscall tracing programs 2022-12-29 14:22:34 -08:00
test_lru_dist.c samples/bpf: remove unused function with test_lru_dist 2022-12-19 14:21:05 -08:00
test_lwt_bpf.c samples/bpf: use vmlinux.h instead of implicit headers in BPF test program 2023-01-15 13:32:45 -08:00
test_lwt_bpf.sh samples/bpf: fix broken lightweight tunnel testing 2023-01-15 13:32:45 -08:00
test_map_in_map_user.c samples/bpf: Use bpf_{btf,link,map,prog}_get_info_by_fd() 2023-02-16 15:32:45 -08:00
test_map_in_map.bpf.c samples/bpf: change _kern suffix to .bpf with BPF test programs 2023-01-15 13:32:45 -08:00
test_overhead_kprobe.bpf.c samples/bpf: change _kern suffix to .bpf with BPF test programs 2023-01-15 13:32:45 -08:00
test_overhead_raw_tp.bpf.c samples/bpf: change _kern suffix to .bpf with BPF test programs 2023-01-15 13:32:45 -08:00
test_overhead_tp.bpf.c samples/bpf: change _kern suffix to .bpf with BPF test programs 2023-01-15 13:32:45 -08:00
test_overhead_user.c samples/bpf: change _kern suffix to .bpf with BPF test programs 2023-01-15 13:32:45 -08:00
test_override_return.sh samples: bpf: Fix tracex7 error raised on the missing argument 2021-07-27 11:15:09 -07:00
test_probe_write_user_user.c samples/bpf: Change _kern suffix to .bpf with syscall tracing program 2022-12-29 14:22:34 -08:00
test_probe_write_user.bpf.c samples/bpf: Use BPF_KSYSCALL macro in syscall tracing programs 2022-12-29 14:22:34 -08:00
trace_event_kern.c bpf: Remove unused headers 2021-03-25 22:03:46 -07:00
trace_event_user.c bpf: samples: Do not touch RLIMIT_MEMLOCK 2020-12-02 18:32:47 -08:00
trace_output_user.c samples/bpf: Change _kern suffix to .bpf with syscall tracing program 2022-12-29 14:22:34 -08:00
trace_output.bpf.c samples/bpf: Change _kern suffix to .bpf with syscall tracing program 2022-12-29 14:22:34 -08:00
tracex1_kern.c samples/bpf: Fix broken tracex1 due to kprobe argument change 2021-04-19 18:19:49 -07:00
tracex1_user.c samples, bpf: Refactor kprobe tracing user progs with libbpf 2020-05-19 17:12:53 +02:00
tracex2_user.c samples/bpf: Change _kern suffix to .bpf with syscall tracing program 2022-12-29 14:22:34 -08:00
tracex2.bpf.c samples/bpf: Fix tracex2 by using BPF_KSYSCALL macro 2022-12-29 14:22:34 -08:00
tracex3_kern.c samples/bpf: Replace blk_account_io_done() with __blk_account_io_done() 2022-09-20 17:25:59 -07:00
tracex3_user.c samples/bpf: Use libbpf 1.0 API mode instead of RLIMIT_MEMLOCK 2022-04-10 20:17:15 -07:00
tracex4_kern.c samples, bpf: Refactor kprobe, tail call kern progs map definition 2020-05-19 17:13:03 +02:00
tracex4_user.c samples/bpf: replace meaningless counter with tracex4 2022-12-19 14:21:05 -08:00
tracex5_kern.c samples/bpf, selftests/bpf: Use bpf_probe_read_kernel 2020-07-21 13:26:26 -07:00
tracex5_user.c samples: bpf: Replace sizeof(arr)/sizeof(arr[0]) with ARRAY_SIZE 2022-07-13 21:43:52 -07:00
tracex6_kern.c samples, bpf: Refactor kprobe, tail call kern progs map definition 2020-05-19 17:13:03 +02:00
tracex6_user.c samples/bpf: Use libbpf 1.0 API mode instead of RLIMIT_MEMLOCK 2022-04-10 20:17:15 -07:00
tracex7_kern.c
tracex7_user.c samples: bpf: Fix tracex7 error raised on the missing argument 2021-07-27 11:15:09 -07:00
xdp1_kern.c samples/bpf: fixup some tools to be able to support xdp multibuffer 2022-06-21 18:55:53 -07:00
xdp1_user.c samples/bpf: Use bpf_{btf,link,map,prog}_get_info_by_fd() 2023-02-16 15:32:45 -08:00
xdp2_kern.c samples/bpf: Fix MAC address swapping in xdp2_kern 2022-10-19 11:06:29 -07:00
xdp2skb_meta_kern.c samples: bpf: Remove bpf_load loader completely 2020-11-26 19:33:36 -08:00
xdp2skb_meta.sh
xdp_adjust_tail_kern.c
xdp_adjust_tail_user.c samples/bpf: Use bpf_{btf,link,map,prog}_get_info_by_fd() 2023-02-16 15:32:45 -08:00
xdp_fwd_kern.c
xdp_fwd_user.c samples/bpf: Use bpf_{btf,link,map,prog}_get_info_by_fd() 2023-02-16 15:32:45 -08:00
xdp_monitor_user.c samples/bpf: Use libbpf 1.0 API mode instead of RLIMIT_MEMLOCK 2022-04-10 20:17:15 -07:00
xdp_monitor.bpf.c samples: bpf: Convert xdp_monitor_kern.o to XDP samples helper 2021-08-24 14:48:41 -07:00
xdp_redirect_cpu_user.c samples/bpf: Use bpf_{btf,link,map,prog}_get_info_by_fd() 2023-02-16 15:32:45 -08:00
xdp_redirect_cpu.bpf.c samples/bpf: Update cpumap/devmap sec_name 2022-02-01 09:51:31 -08:00
xdp_redirect_map_multi_user.c samples/bpf: Use libbpf 1.0 API mode instead of RLIMIT_MEMLOCK 2022-04-10 20:17:15 -07:00
xdp_redirect_map_multi.bpf.c samples/bpf: Update cpumap/devmap sec_name 2022-02-01 09:51:31 -08:00
xdp_redirect_map_user.c samples/bpf: Fix xdp_redirect_map egress devmap prog 2022-07-11 21:14:35 -07:00
xdp_redirect_map.bpf.c samples/bpf: Fix xdp_redirect_map egress devmap prog 2022-07-11 21:14:35 -07:00
xdp_redirect_user.c samples/bpf: Use libbpf 1.0 API mode instead of RLIMIT_MEMLOCK 2022-04-10 20:17:15 -07:00
xdp_redirect.bpf.c samples: bpf: Convert xdp_redirect_kern.o to XDP samples helper 2021-08-24 14:48:42 -07:00
xdp_router_ipv4_user.c samples/bpf: Fix wrong allocation size in xdp_router_ipv4_user 2022-11-25 00:21:29 +01:00
xdp_router_ipv4.bpf.c sample: bpf: xdp_router_ipv4: Allow the kernel to send arp requests 2022-06-02 16:26:54 -07:00
xdp_rxq_info_kern.c
xdp_rxq_info_user.c samples/bpf: Use bpf_{btf,link,map,prog}_get_info_by_fd() 2023-02-16 15:32:45 -08:00
xdp_sample_pkts_kern.c samples: bpf: Refactor XDP kern program maps with BTF-defined map 2020-10-11 12:14:36 -07:00
xdp_sample_pkts_user.c samples/bpf: Use bpf_{btf,link,map,prog}_get_info_by_fd() 2023-02-16 15:32:45 -08:00
xdp_sample_shared.h samples: bpf: Add basic infrastructure for XDP samples 2021-08-24 14:48:40 -07:00
xdp_sample_user.c samples/bpf: Use libbpf 1.0 API mode instead of RLIMIT_MEMLOCK 2022-04-10 20:17:15 -07:00
xdp_sample_user.h samples/bpf: use preferred getters/setters instead of deprecated ones 2022-01-25 17:59:07 -08:00
xdp_sample.bpf.c samples: bpf: Add BPF support for devmap_xmit tracepoint 2021-08-24 14:48:41 -07:00
xdp_sample.bpf.h samples/bpf: split common macros to net_shared.h 2023-01-15 13:32:45 -08:00
xdp_tx_iptunnel_common.h
xdp_tx_iptunnel_kern.c samples/bpf: fixup some tools to be able to support xdp multibuffer 2022-06-21 18:55:53 -07:00
xdp_tx_iptunnel_user.c samples/bpf: Use bpf_{btf,link,map,prog}_get_info_by_fd() 2023-02-16 15:32:45 -08:00

eBPF sample programs
====================

This directory contains a test stubs, verifier test-suite and examples
for using eBPF. The examples use libbpf from tools/lib/bpf.

Build dependencies
==================

Compiling requires having installed:
 * clang >= version 3.4.0
 * llvm >= version 3.7.1

Note that LLVM's tool 'llc' must support target 'bpf', list version
and supported targets with command: ``llc --version``

Clean and configuration
-----------------------

It can be needed to clean tools, samples or kernel before trying new arch or
after some changes (on demand)::

 make -C tools clean
 make -C samples/bpf clean
 make clean

Configure kernel, defconfig for instance::

 make defconfig

Kernel headers
--------------

There are usually dependencies to header files of the current kernel.
To avoid installing devel kernel headers system wide, as a normal
user, simply call::

 make headers_install

This will create a local "usr/include" directory in the git/build top
level directory, that the make system will automatically pick up first.

Compiling
=========

For building the BPF samples, issue the below command from the kernel
top level directory::

 make M=samples/bpf

It is also possible to call make from this directory.  This will just
hide the invocation of make as above.

Manually compiling LLVM with 'bpf' support
------------------------------------------

Since version 3.7.0, LLVM adds a proper LLVM backend target for the
BPF bytecode architecture.

By default llvm will build all non-experimental backends including bpf.
To generate a smaller llc binary one can use::

 -DLLVM_TARGETS_TO_BUILD="BPF"

We recommend that developers who want the fastest incremental builds
use the Ninja build system, you can find it in your system's package
manager, usually the package is ninja or ninja-build.

Quick sniplet for manually compiling LLVM and clang
(build dependencies are ninja, cmake and gcc-c++)::

 $ git clone https://github.com/llvm/llvm-project.git
 $ mkdir -p llvm-project/llvm/build
 $ cd llvm-project/llvm/build
 $ cmake .. -G "Ninja" -DLLVM_TARGETS_TO_BUILD="BPF;X86" \
            -DLLVM_ENABLE_PROJECTS="clang"    \
            -DCMAKE_BUILD_TYPE=Release        \
            -DLLVM_BUILD_RUNTIME=OFF
 $ ninja

It is also possible to point make to the newly compiled 'llc' or
'clang' command via redefining LLC or CLANG on the make command line::

 make M=samples/bpf LLC=~/git/llvm-project/llvm/build/bin/llc CLANG=~/git/llvm-project/llvm/build/bin/clang

Cross compiling samples
-----------------------
In order to cross-compile, say for arm64 targets, export CROSS_COMPILE and ARCH
environment variables before calling make. But do this before clean,
configuration and header install steps described above. This will direct make to
build samples for the cross target::

 export ARCH=arm64
 export CROSS_COMPILE="aarch64-linux-gnu-"

Headers can be also installed on RFS of target board if need to keep them in
sync (not necessarily and it creates a local "usr/include" directory also)::

 make INSTALL_HDR_PATH=~/some_sysroot/usr headers_install

Pointing LLC and CLANG is not necessarily if it's installed on HOST and have
in its targets appropriate arm64 arch (usually it has several arches).
Build samples::

 make M=samples/bpf

Or build samples with SYSROOT if some header or library is absent in toolchain,
say libelf, providing address to file system containing headers and libs,
can be RFS of target board::

 make M=samples/bpf SYSROOT=~/some_sysroot