kernel_optimize_test/samples/bpf
Yonghong Song 6bf3bbe1f4 samples/bpf: workaround clang asm goto compilation errors
x86 compilation has required asm goto support since 4.17.
Since clang does not support asm goto, at 4.17,
Commit b1ae32dbab ("x86/cpufeature: Guard asm_volatile_goto usage
for BPF compilation") worked around the issue by permitting an
alternative implementation without asm goto for clang.

At 5.0, more asm goto usages appeared.
  [yhs@148 x86]$ egrep -r asm_volatile_goto
  include/asm/cpufeature.h:     asm_volatile_goto("1: jmp 6f\n"
  include/asm/jump_label.h:     asm_volatile_goto("1:"
  include/asm/jump_label.h:     asm_volatile_goto("1:"
  include/asm/rmwcc.h:  asm_volatile_goto (fullop "; j" #cc " %l[cc_label]"     \
  include/asm/uaccess.h:        asm_volatile_goto("\n"                          \
  include/asm/uaccess.h:        asm_volatile_goto("\n"                          \
  [yhs@148 x86]$

Compiling samples/bpf directories, most bpf programs failed
compilation with error messages like:
  In file included from /home/yhs/work/bpf-next/samples/bpf/xdp_sample_pkts_kern.c:2:
  In file included from /home/yhs/work/bpf-next/include/linux/ptrace.h:6:
  In file included from /home/yhs/work/bpf-next/include/linux/sched.h:15:
  In file included from /home/yhs/work/bpf-next/include/linux/sem.h:5:
  In file included from /home/yhs/work/bpf-next/include/uapi/linux/sem.h:5:
  In file included from /home/yhs/work/bpf-next/include/linux/ipc.h:9:
  In file included from /home/yhs/work/bpf-next/include/linux/refcount.h:72:
  /home/yhs/work/bpf-next/arch/x86/include/asm/refcount.h:70:9: error: 'asm goto' constructs are not supported yet
        return GEN_BINARY_SUFFIXED_RMWcc(LOCK_PREFIX "subl",
               ^
  /home/yhs/work/bpf-next/arch/x86/include/asm/rmwcc.h:67:2: note: expanded from macro 'GEN_BINARY_SUFFIXED_RMWcc'
        __GEN_RMWcc(op " %[val], %[var]\n\t" suffix, var, cc,           \
        ^
  /home/yhs/work/bpf-next/arch/x86/include/asm/rmwcc.h:21:2: note: expanded from macro '__GEN_RMWcc'
        asm_volatile_goto (fullop "; j" #cc " %l[cc_label]"             \
        ^
  /home/yhs/work/bpf-next/include/linux/compiler_types.h:188:37: note: expanded from macro 'asm_volatile_goto'
  #define asm_volatile_goto(x...) asm goto(x)

Most implementation does not even provide an alternative
implementation. And it is also not practical to make changes
for each call site.

This patch workarounded the asm goto issue by redefining the macro like below:
  #define asm_volatile_goto(x...) asm volatile("invalid use of asm_volatile_goto")

If asm_volatile_goto is not used by bpf programs, which is typically the case, nothing bad
will happen. If asm_volatile_goto is used by bpf programs, which is incorrect, the compiler
will issue an error since "invalid use of asm_volatile_goto" is not valid assembly codes.

With this patch, all bpf programs under samples/bpf can pass compilation.

Note that bpf programs under tools/testing/selftests/bpf/ compiled fine as
they do not access kernel internal headers.

Fixes: e769742d35 ("Revert "x86/jump-labels: Macrofy inline assembly code to work around GCC inlining bugs"")
Fixes: 18fe58229d ("x86, asm: change the GEN_*_RMWcc() macros to not quote the condition")
Acked-by: Alexei Starovoitov <ast@kernel.org>
Signed-off-by: Yonghong Song <yhs@fb.com>
Signed-off-by: Daniel Borkmann <daniel@iogearbox.net>
2019-01-15 20:57:30 +01:00
..
.gitignore
asm_goto_workaround.h samples/bpf: workaround clang asm goto compilation errors 2019-01-15 20:57:30 +01:00
bpf_insn.h
bpf_load.c samples: bpf: fix: seg fault with NULL pointer arg 2018-12-03 23:58:03 +01:00
bpf_load.h
cookie_uid_helper_example.c
cpustat_kern.c
cpustat_user.c
fds_example.c
hash_func01.h
lathist_kern.c
lathist_user.c
load_sock_ops.c
lwt_len_hist_kern.c
lwt_len_hist_user.c
lwt_len_hist.sh
Makefile samples/bpf: workaround clang asm goto compilation errors 2019-01-15 20:57:30 +01:00
map_perf_test_kern.c
map_perf_test_user.c
offwaketime_kern.c
offwaketime_user.c
parse_ldabs.c
parse_simple.c
parse_varlen.c
README.rst
run_cookie_uid_helper_example.sh
sampleip_kern.c
sampleip_user.c samples/bpf: remove duplicated includes 2018-09-18 17:49:33 +02:00
sock_example.c
sock_example.h
sock_flags_kern.c
sockex1_kern.c
sockex1_user.c
sockex2_kern.c samples/bpf: fix compilation failure 2018-09-21 22:51:16 +02:00
sockex2_user.c
sockex3_kern.c samples/bpf: fix compilation failure 2018-09-21 22:51:16 +02:00
sockex3_user.c samples/bpf: fix compilation failure 2018-09-21 22:51:16 +02:00
spintest_kern.c
spintest_user.c
syscall_nrs.c
syscall_tp_kern.c
syscall_tp_user.c
task_fd_query_kern.c
task_fd_query_user.c
tc_l2_redirect_kern.c
tc_l2_redirect_user.c
tc_l2_redirect.sh
tcbpf1_kern.c
tcp_basertt_kern.c
tcp_bpf.readme
tcp_bufs_kern.c
tcp_clamp_kern.c
tcp_cong_kern.c
tcp_iw_kern.c
tcp_rwnd_kern.c
tcp_synrto_kern.c
tcp_tos_reflect_kern.c bpf: add TCP_SAVE_SYN/TCP_SAVED_SYN sample program 2018-09-01 01:36:04 +02:00
test_cgrp2_array_pin.c
test_cgrp2_attach.c
test_cgrp2_attach2.c selftests/bpf: fix incorrect users of create_and_get_cgroup 2019-01-07 13:15:55 -08:00
test_cgrp2_sock.c
test_cgrp2_sock.sh
test_cgrp2_sock2.c
test_cgrp2_sock2.sh
test_cgrp2_tc_kern.c
test_cgrp2_tc.sh
test_cls_bpf.sh
test_current_task_under_cgroup_kern.c
test_current_task_under_cgroup_user.c selftests/bpf: fix incorrect users of create_and_get_cgroup 2019-01-07 13:15:55 -08:00
test_ipip.sh
test_lru_dist.c
test_lwt_bpf.c
test_lwt_bpf.sh
test_map_in_map_kern.c
test_map_in_map_user.c
test_overhead_kprobe_kern.c
test_overhead_raw_tp_kern.c
test_overhead_tp_kern.c
test_overhead_user.c
test_override_return.sh
test_probe_write_user_kern.c
test_probe_write_user_user.c
trace_event_kern.c
trace_event_user.c
trace_output_kern.c
trace_output_user.c
tracex1_kern.c
tracex1_user.c
tracex2_kern.c
tracex2_user.c
tracex3_kern.c
tracex3_user.c bpf, tracex3_user: erase "ARRAY_SIZE" redefined 2018-10-04 16:31:57 +02:00
tracex4_kern.c
tracex4_user.c
tracex5_kern.c
tracex5_user.c
tracex6_kern.c
tracex6_user.c
tracex7_kern.c
tracex7_user.c
xdp_adjust_tail_kern.c
xdp_adjust_tail_user.c
xdp_fwd_kern.c
xdp_fwd_user.c
xdp_monitor_kern.c
xdp_monitor_user.c
xdp_redirect_cpu_kern.c
xdp_redirect_cpu_user.c
xdp_redirect_kern.c
xdp_redirect_map_kern.c
xdp_redirect_map_user.c
xdp_redirect_user.c
xdp_router_ipv4_kern.c
xdp_router_ipv4_user.c
xdp_rxq_info_kern.c
xdp_rxq_info_user.c
xdp_sample_pkts_kern.c
xdp_sample_pkts_user.c
xdp_tx_iptunnel_common.h
xdp_tx_iptunnel_kern.c
xdp_tx_iptunnel_user.c
xdp1_kern.c
xdp1_user.c samples: bpf: user proper argument index 2019-01-10 15:54:47 +01:00
xdp2_kern.c
xdp2skb_meta_kern.c
xdp2skb_meta.sh
xdpsock_kern.c samples/bpf: xdpsock, minor fixes 2018-09-01 01:36:08 +02:00
xdpsock_user.c samples/bpf: xdpsock, minor fixes 2018-09-01 01:36:08 +02:00
xdpsock.h

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``

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 samples/bpf/

Do notice the "/" slash after the directory name.

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

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"

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

 $ git clone http://llvm.org/git/llvm.git
 $ cd llvm/tools
 $ git clone --depth 1 http://llvm.org/git/clang.git
 $ cd ..; mkdir build; cd build
 $ cmake .. -DLLVM_TARGETS_TO_BUILD="BPF;X86"
 $ make -j $(getconf _NPROCESSORS_ONLN)

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 samples/bpf/ LLC=~/git/llvm/build/bin/llc CLANG=~/git/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. This will direct make to build
samples for the cross target.

export ARCH=arm64
export CROSS_COMPILE="aarch64-linux-gnu-"
make samples/bpf/ LLC=~/git/llvm/build/bin/llc CLANG=~/git/llvm/build/bin/clang