1BPFTOOL-CGROUP(8) BPFTOOL-CGROUP(8)
2
6 bpftool-cgroup - tool for inspection and simple manipulation of eBPF
7 progs
8
10 bpftool [OPTIONS] cgroup COMMAND
11 OPTIONS := { { -j | --json } [{ -p | --pretty }] | { -f | --bpffs }
13 }
14 COMMANDS := { show | list | tree | attach | detach | help }
16
18 bpftool cgroup { show | list } CGROUP [effective]
19 bpftool cgroup tree [CGROUP_ROOT] [effective]
20 bpftool cgroup attach CGROUP ATTACH_TYPE PROG [ATTACH_FLAGS]
21 bpftool cgroup detach CGROUP ATTACH_TYPE PROG
22 bpftool cgroup help
23 PROG := { id PROG_ID | pinned FILE | tag PROG_TAG }
25 ATTACH_TYPE := { ingress | egress | sock_create | sock_ops | device |
26 bind4 | bind6 | post_bind4 | post_bind6 | connect4 | connect6 |
27 getpeername4 | getpeername6 | getsockname4 | getsockname6 | sendmsg4 |
28 sendmsg6 | recvmsg4 | recvmsg6 | sysctl | getsockopt | setsockopt |
29 sock_release }
30 ATTACH_FLAGS := { multi | override }
31
34 bpftool cgroup { show | list } CGROUP [effective]
35 List all programs attached to the cgroup CGROUP.
36 Output will start with program ID followed by attach type,
38 attach flags and program name.
39 If effective is specified retrieve effective programs that
41 will execute for events within a cgroup. This includes inher‐
42 ited along with attached ones.
43 bpftool cgroup tree [CGROUP_ROOT] [effective]
45 Iterate over all cgroups in CGROUP_ROOT and list all attached
46 programs. If CGROUP_ROOT is not specified, bpftool uses
47 cgroup v2 mountpoint.
48 The output is similar to the output of cgroup show/list com‐
50 mands: it starts with absolute cgroup path, followed by pro‐
51 gram ID, attach type, attach flags and program name.
52 If effective is specified retrieve effective programs that
54 will execute for events within a cgroup. This includes inher‐
55 ited along with attached ones.
56 bpftool cgroup attach CGROUP ATTACH_TYPE PROG [ATTACH_FLAGS]
58 Attach program PROG to the cgroup CGROUP with attach type AT‐
59 TACH_TYPE and optional ATTACH_FLAGS.
60 ATTACH_FLAGS can be one of: override if a sub-cgroup installs
62 some bpf program, the program in this cgroup yields to
63 sub-cgroup program; multi if a sub-cgroup installs some bpf
64 program, that cgroup program gets run in addition to the pro‐
65 gram in this cgroup.
66 Only one program is allowed to be attached to a cgroup with
68 no attach flags or the override flag. Attaching another pro‐
69 gram will release old program and attach the new one.
70 Multiple programs are allowed to be attached to a cgroup with
72 multi. They are executed in FIFO order (those that were at‐
73 tached first, run first).
74 Non-default ATTACH_FLAGS are supported by kernel version 4.14
76 and later.
77 ATTACH_TYPE can be on of: ingress ingress path of the inet
79 socket (since 4.10); egress egress path of the inet socket
80 (since 4.10); sock_create opening of an inet socket (since
81 4.10); sock_ops various socket operations (since 4.12); de‐
82 vice device access (since 4.15); bind4 call to bind(2) for an
83 inet4 socket (since 4.17); bind6 call to bind(2) for an inet6
84 socket (since 4.17); post_bind4 return from bind(2) for an
85 inet4 socket (since 4.17); post_bind6 return from bind(2) for
86 an inet6 socket (since 4.17); connect4 call to connect(2) for
87 an inet4 socket (since 4.17); connect6 call to connect(2) for
88 an inet6 socket (since 4.17); sendmsg4 call to sendto(2),
89 sendmsg(2), sendmmsg(2) for an unconnected udp4 socket (since
90 4.18); sendmsg6 call to sendto(2), sendmsg(2), sendmmsg(2)
91 for an unconnected udp6 socket (since 4.18); recvmsg4 call to
92 recvfrom(2), recvmsg(2), recvmmsg(2) for an unconnected udp4
93 socket (since 5.2); recvmsg6 call to recvfrom(2), recvmsg(2),
94 recvmmsg(2) for an unconnected udp6 socket (since 5.2);
95 sysctl sysctl access (since 5.2); getsockopt call to getsock‐
96 opt (since 5.3); setsockopt call to setsockopt (since 5.3);
97 getpeername4 call to getpeername(2) for an inet4 socket
98 (since 5.8); getpeername6 call to getpeername(2) for an inet6
99 socket (since 5.8); getsockname4 call to getsockname(2) for
100 an inet4 socket (since 5.8); getsockname6 call to getsock‐
101 name(2) for an inet6 socket (since 5.8). sock_release clos‐
102 ing an userspace inet socket (since 5.9).
103 bpftool cgroup detach CGROUP ATTACH_TYPE PROG
105 Detach PROG from the cgroup CGROUP and attach type AT‐
106 TACH_TYPE.
107 bpftool prog help
109 Print short help message.
110
112 -h, --help
113 Print short help message (similar to bpftool help).
114 -V, --version
116 Print version number (similar to bpftool version), and op‐
117 tional features that were included when bpftool was compiled.
118 Optional features include linking against libbfd to provide
119 the disassembler for JIT-ted programs (bpftool prog dump
120 jited) and usage of BPF skeletons (some features like bpftool
121 prog profile or showing pids associated to BPF objects may
122 rely on it).
123 -j, --json
125 Generate JSON output. For commands that cannot produce JSON,
126 this option has no effect.
127 -p, --pretty
129 Generate human-readable JSON output. Implies -j.
130 -d, --debug
132 Print all logs available, even debug-level information. This
133 includes logs from libbpf as well as from the verifier, when
134 attempting to load programs.
135 -f, --bpffs
137 Show file names of pinned programs.
138
140 # mount -t bpf none /sys/fs/bpf/
141 # mkdir /sys/fs/cgroup/test.slice
142 # bpftool prog load ./device_cgroup.o /sys/fs/bpf/prog
143 # bpftool cgroup attach /sys/fs/cgroup/test.slice/ device id 1 allow_multi
144 # bpftool cgroup list /sys/fs/cgroup/test.slice/
147 ID AttachType AttachFlags Name
149 1 device allow_multi bpf_prog1
150 # bpftool cgroup detach /sys/fs/cgroup/test.slice/ device id 1
152 # bpftool cgroup list /sys/fs/cgroup/test.slice/
153 ID AttachType AttachFlags Name
156
158 bpf(2), bpf-helpers(7), bpftool(8), bpftool-btf(8), bpftool-fea‐
159 ture(8), bpftool-gen(8), bpftool-iter(8), bpftool-link(8),
160 bpftool-map(8), bpftool-net(8), bpftool-perf(8), bpftool-prog(8),
161 bpftool-struct_ops(8)
162 BPFTOOL-CGROUP(8)