linux/samples/bpf
Ong Boon Leong eb68db45b7 samples/bpf: xdpsock: Add timestamp for Tx-only operation
It may be useful to add timestamp for Tx packets for continuous or cyclic
transmit operation. The timestamp and sequence ID of a Tx packet are
stored according to pktgen header format. To enable per-packet timestamp,
use -y|--tstamp option. If timestamp is off, pktgen header is not
included in the UDP payload. This means receiving side can use the magic
number for pktgen for differentiation.

The implementation supports both VLAN tagged and untagged option. By
default, the minimum packet size is set at 64B. However, if VLAN tagged
is on (-V), the minimum packet size is increased to 66B just so to fit
the pktgen_hdr size.

Added hex_dump() into the code path just for future cross-checking.
As before, simply change to "#define DEBUG_HEXDUMP 1" to inspect the
accuracy of TX packet.

Signed-off-by: Ong Boon Leong <boon.leong.ong@intel.com>
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
Link: https://lore.kernel.org/bpf/20211230035447.523177-8-boon.leong.ong@intel.com
2022-01-05 17:53:24 -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: Refactor tracepoint tracing programs with libbpf 2020-08-24 20:59:35 -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: Get rid of deprecated libbpf API uses 2021-12-02 15:23:40 -08:00
hash_func01.h
hbm_edt_kern.c
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: Stop using bpf_object__find_program_by_title API. 2021-12-14 14:38:05 -08: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: Ix kernel-doc syntax in file header 2021-05-24 21:06:02 -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_kern.c samples/bpf: Clean up samples/bpf build failes 2021-12-02 15:23:40 -08:00
lwt_len_hist_user.c samples: bpf: Fix build error 2020-05-14 12:37:39 -07:00
lwt_len_hist.sh samples: bpf: Fix lwt_len_hist reusing previous BPF map 2020-11-26 19:33:36 -08:00
Makefile samples: bpf: Fix xdp_sample_user.o linking with Clang 2021-12-06 19:33:44 -08:00
Makefile.target samples/bpf: Clean up samples/bpf build failes 2021-12-02 15:23:40 -08:00
map_perf_test_kern.c samples: bpf: Refactor BPF map performance test with libbpf 2020-07-08 01:33:14 +02:00
map_perf_test_user.c samples/bpf: Get rid of deprecated libbpf API uses 2021-12-02 15:23:40 -08:00
offwaketime_kern.c samples/bpf: Define MAX_ENTRIES instead of a magic number in offwaketime 2021-08-15 00:08:40 -07:00
offwaketime_user.c bpf: samples: Do not touch RLIMIT_MEMLOCK 2020-12-02 18:32:47 -08:00
parse_ldabs.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
parse_simple.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
parse_varlen.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
README.rst bpf, docs: Update build procedure for manually compiling LLVM and Clang 2021-01-23 00:09:03 +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: Get rid of deprecated libbpf API uses 2021-12-02 15:23:40 -08:00
sock_example.h
sock_flags_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
sockex1_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
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: Get rid of deprecated libbpf API uses 2021-12-02 15:23:40 -08:00
sockex3_kern.c bpf, libbpf: Guard bpf inline asm from bpf_tail_call_static 2020-10-22 01:46:52 +02:00
sockex3_user.c bpf: samples: Do not touch RLIMIT_MEMLOCK 2020-12-02 18:32:47 -08:00
spintest_kern.c samples: bpf: Refactor kprobe tracing programs with libbpf 2020-08-24 20:59:35 -07:00
spintest_user.c bpf: samples: Do not touch RLIMIT_MEMLOCK 2020-12-02 18:32:47 -08:00
syscall_nrs.c
syscall_tp_kern.c samples: bpf: Refactor tracepoint tracing programs with libbpf 2020-08-24 20:59:35 -07:00
syscall_tp_user.c bpf: samples: Do not touch RLIMIT_MEMLOCK 2020-12-02 18:32:47 -08:00
task_fd_query_kern.c samples: bpf: Fix broken bpf programs due to removed symbol 2020-08-18 17:10:03 -07:00
task_fd_query_user.c samples, bpf: Suppress compiler warning 2021-05-12 12:29:43 -07:00
tc_l2_redirect_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
tc_l2_redirect_user.c
tc_l2_redirect.sh
tcbpf1_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
tcp_basertt_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
tcp_bpf.readme
tcp_bufs_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
tcp_clamp_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
tcp_cong_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
tcp_dumpstats_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
tcp_iw_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
tcp_rwnd_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
tcp_synrto_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
tcp_tos_reflect_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
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: Get rid of deprecated libbpf API uses 2021-12-02 15:23:40 -08: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: Refactor test_cgrp2_sock2 program with libbpf 2020-11-26 19:33:35 -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
test_cgrp2_tc_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
test_cgrp2_tc.sh
test_cls_bpf.sh
test_current_task_under_cgroup_kern.c samples: bpf: Refactor kprobe tracing programs with libbpf 2020-08-24 20:59:35 -07:00
test_current_task_under_cgroup_user.c samples: bpf: Refactor kprobe tracing programs with libbpf 2020-08-24 20:59:35 -07:00
test_lru_dist.c samples/bpf: Get rid of deprecated libbpf API uses 2021-12-02 15:23:40 -08:00
test_lwt_bpf.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
test_lwt_bpf.sh samples: bpf: Fix lwt_len_hist reusing previous BPF map 2020-11-26 19:33:36 -08:00
test_map_in_map_kern.c samples/bpf: Fix test_map_in_map on s390 2020-09-19 01:02:55 +02:00
test_map_in_map_user.c bpf: samples: Do not touch RLIMIT_MEMLOCK 2020-12-02 18:32:47 -08:00
test_overhead_kprobe_kern.c samples/bpf, selftests/bpf: Use bpf_probe_read_kernel 2020-07-21 13:26:26 -07:00
test_overhead_raw_tp_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
test_overhead_tp_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
test_overhead_user.c bpf: samples: Do not touch RLIMIT_MEMLOCK 2020-12-02 18:32:47 -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_kern.c samples: bpf: Refactor kprobe tracing programs with libbpf 2020-08-24 20:59:35 -07:00
test_probe_write_user_user.c samples: bpf: Refactor kprobe tracing programs with libbpf 2020-08-24 20:59:35 -07:00
trace_common.h samples, bpf: Refactor kprobe tracing user progs with libbpf 2020-05-19 17:12:53 +02: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_kern.c samples: bpf: Refactor kprobe tracing programs with libbpf 2020-08-24 20:59:35 -07:00
trace_output_user.c samples/bpf: Get rid of deprecated libbpf API uses 2021-12-02 15:23:40 -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_kern.c samples, bpf: Refactor kprobe, tail call kern progs map definition 2020-05-19 17:13:03 +02:00
tracex2_user.c bpf: samples: Do not touch RLIMIT_MEMLOCK 2020-12-02 18:32:47 -08:00
tracex3_kern.c samples: bpf: Fix broken bpf programs due to removed symbol 2020-08-18 17:10:03 -07:00
tracex3_user.c bpf: samples: Do not touch RLIMIT_MEMLOCK 2020-12-02 18:32:47 -08: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: Fix a couple of warnings 2021-08-24 14:48:40 -07:00
tracex5_kern.c samples/bpf, selftests/bpf: Use bpf_probe_read_kernel 2020-07-21 13:26:26 -07:00
tracex5_user.c bpf: samples: Do not touch RLIMIT_MEMLOCK 2020-12-02 18:32:47 -08: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 bpf: samples: Do not touch RLIMIT_MEMLOCK 2020-12-02 18:32:47 -08:00
tracex7_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
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: Add an explict comment to handle nested vlan tagging. 2021-08-10 11:17:32 +02:00
xdp1_user.c selftests/bpf: Switch to new bpf_object__next_{map,program} APIs 2021-10-06 12:34:02 -07:00
xdp2_kern.c samples, bpf: Add an explict comment to handle nested vlan tagging. 2021-08-10 11:17:32 +02: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 samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
xdp_adjust_tail_user.c bpf: samples: Do not touch RLIMIT_MEMLOCK 2020-12-02 18:32:47 -08:00
xdp_fwd_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
xdp_fwd_user.c samples/bpf: Stop using bpf_object__find_program_by_title API. 2021-12-14 14:38:05 -08:00
xdp_monitor_user.c samples: bpf: Convert xdp_monitor to XDP samples helper 2021-08-24 14:48:41 -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: Fix incorrect use of strlen in xdp_redirect_cpu 2021-11-12 17:23:16 -08:00
xdp_redirect_cpu.bpf.c samples/bpf: Remove unneeded variable 2021-12-09 09:21:45 -08:00
xdp_redirect_map_multi_user.c samples: bpf: Convert xdp_redirect_map_multi to XDP samples helper 2021-08-24 14:48:42 -07:00
xdp_redirect_map_multi.bpf.c samples: bpf: Fix vmlinux.h generation for XDP samples 2021-09-28 17:21:35 -07:00
xdp_redirect_map_user.c samples: bpf: Convert xdp_redirect_map to XDP samples helper 2021-08-24 14:48:42 -07:00
xdp_redirect_map.bpf.c samples: bpf: Convert xdp_redirect_map_kern.o to XDP samples helper 2021-08-24 14:48:42 -07:00
xdp_redirect_user.c samples: bpf: Convert xdp_redirect to XDP samples helper 2021-08-24 14:48:42 -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_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
xdp_router_ipv4_user.c samples: bpf: Convert ARP table network order fields into readable format 2021-09-21 13:27:54 -07:00
xdp_rxq_info_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
xdp_rxq_info_user.c bpf: samples: Do not touch RLIMIT_MEMLOCK 2020-12-02 18:32:47 -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: Get rid of deprecated libbpf API uses 2021-12-02 15:23:40 -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: Fix summary per-sec stats in xdp_sample_user 2021-11-12 17:23:16 -08:00
xdp_sample_user.h samples: bpf: Fix 'unknown warning group' build warning on Clang 2021-12-06 19:33:44 -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: Add BPF support for redirect tracepoint 2021-08-24 14:48:40 -07:00
xdp_tx_iptunnel_common.h
xdp_tx_iptunnel_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
xdp_tx_iptunnel_user.c bpf: samples: Do not touch RLIMIT_MEMLOCK 2020-12-02 18:32:47 -08:00
xdpsock_ctrl_proc.c samples/bpf: Get rid of deprecated libbpf API uses 2021-12-02 15:23:40 -08:00
xdpsock_kern.c samples/bpf: Use consistent include paths for libbpf 2020-01-20 16:37:45 -08:00
xdpsock_user.c samples/bpf: xdpsock: Add timestamp for Tx-only operation 2022-01-05 17:53:24 -08:00
xdpsock.h samples/bpf: Sample application for eBPF load and socket creation split 2020-12-03 10:37:59 -08:00
xsk_fwd.c samples/bpf: Get rid of deprecated libbpf API uses 2021-12-02 15:23:40 -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 creates a local "usr/include" directory in the git/build top
level directory, that the make system automatically pickup 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,
cofiguration 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