Loading...
1.. SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2
3================
4bpftool-cgroup
5================
6-------------------------------------------------------------------------------
7tool for inspection and simple manipulation of eBPF progs
8-------------------------------------------------------------------------------
9
10:Manual section: 8
11
12.. include:: substitutions.rst
13
14SYNOPSIS
15========
16
17**bpftool** [*OPTIONS*] **cgroup** *COMMAND*
18
19*OPTIONS* := { |COMMON_OPTIONS| | { **-f** | **--bpffs** } }
20
21*COMMANDS* :=
22{ **show** | **list** | **tree** | **attach** | **detach** | **help** }
23
24CGROUP COMMANDS
25===============
26
27| **bpftool** **cgroup** { **show** | **list** } *CGROUP* [**effective**]
28| **bpftool** **cgroup tree** [*CGROUP_ROOT*] [**effective**]
29| **bpftool** **cgroup attach** *CGROUP* *ATTACH_TYPE* *PROG* [*ATTACH_FLAGS*]
30| **bpftool** **cgroup detach** *CGROUP* *ATTACH_TYPE* *PROG*
31| **bpftool** **cgroup help**
32|
33| *PROG* := { **id** *PROG_ID* | **pinned** *FILE* | **tag** *PROG_TAG* | **name** *PROG_NAME* }
34| *ATTACH_TYPE* := { **cgroup_inet_ingress** | **cgroup_inet_egress** |
35| **cgroup_inet_sock_create** | **cgroup_sock_ops** |
36| **cgroup_device** | **cgroup_inet4_bind** | **cgroup_inet6_bind** |
37| **cgroup_inet4_post_bind** | **cgroup_inet6_post_bind** |
38| **cgroup_inet4_connect** | **cgroup_inet6_connect** |
39| **cgroup_unix_connect** | **cgroup_inet4_getpeername** |
40| **cgroup_inet6_getpeername** | **cgroup_unix_getpeername** |
41| **cgroup_inet4_getsockname** | **cgroup_inet6_getsockname** |
42| **cgroup_unix_getsockname** | **cgroup_udp4_sendmsg** |
43| **cgroup_udp6_sendmsg** | **cgroup_unix_sendmsg** |
44| **cgroup_udp4_recvmsg** | **cgroup_udp6_recvmsg** |
45| **cgroup_unix_recvmsg** | **cgroup_sysctl** |
46| **cgroup_getsockopt** | **cgroup_setsockopt** |
47| **cgroup_inet_sock_release** }
48| *ATTACH_FLAGS* := { **multi** | **override** }
49
50DESCRIPTION
51===========
52bpftool cgroup { show | list } *CGROUP* [effective]
53 List all programs attached to the cgroup *CGROUP*.
54
55 Output will start with program ID followed by attach type, attach flags and
56 program name.
57
58 If **effective** is specified retrieve effective programs that will execute
59 for events within a cgroup. This includes inherited along with attached
60 ones.
61
62bpftool cgroup tree [*CGROUP_ROOT*] [effective]
63 Iterate over all cgroups in *CGROUP_ROOT* and list all attached programs.
64 If *CGROUP_ROOT* is not specified, bpftool uses cgroup v2 mountpoint.
65
66 The output is similar to the output of cgroup show/list commands: it starts
67 with absolute cgroup path, followed by program ID, attach type, attach
68 flags and program name.
69
70 If **effective** is specified retrieve effective programs that will execute
71 for events within a cgroup. This includes inherited along with attached
72 ones.
73
74bpftool cgroup attach *CGROUP* *ATTACH_TYPE* *PROG* [*ATTACH_FLAGS*]
75 Attach program *PROG* to the cgroup *CGROUP* with attach type *ATTACH_TYPE*
76 and optional *ATTACH_FLAGS*.
77
78 *ATTACH_FLAGS* can be one of: **override** if a sub-cgroup installs some
79 bpf program, the program in this cgroup yields to sub-cgroup program;
80 **multi** if a sub-cgroup installs some bpf program, that cgroup program
81 gets run in addition to the program in this cgroup.
82
83 Only one program is allowed to be attached to a cgroup with no attach flags
84 or the **override** flag. Attaching another program will release old
85 program and attach the new one.
86
87 Multiple programs are allowed to be attached to a cgroup with **multi**.
88 They are executed in FIFO order (those that were attached first, run
89 first).
90
91 Non-default *ATTACH_FLAGS* are supported by kernel version 4.14 and later.
92
93 *ATTACH_TYPE* can be one of:
94
95 - **ingress** ingress path of the inet socket (since 4.10)
96 - **egress** egress path of the inet socket (since 4.10)
97 - **sock_create** opening of an inet socket (since 4.10)
98 - **sock_ops** various socket operations (since 4.12)
99 - **device** device access (since 4.15)
100 - **bind4** call to bind(2) for an inet4 socket (since 4.17)
101 - **bind6** call to bind(2) for an inet6 socket (since 4.17)
102 - **post_bind4** return from bind(2) for an inet4 socket (since 4.17)
103 - **post_bind6** return from bind(2) for an inet6 socket (since 4.17)
104 - **connect4** call to connect(2) for an inet4 socket (since 4.17)
105 - **connect6** call to connect(2) for an inet6 socket (since 4.17)
106 - **connect_unix** call to connect(2) for a unix socket (since 6.7)
107 - **sendmsg4** call to sendto(2), sendmsg(2), sendmmsg(2) for an unconnected udp4 socket (since 4.18)
108 - **sendmsg6** call to sendto(2), sendmsg(2), sendmmsg(2) for an unconnected udp6 socket (since 4.18)
109 - **sendmsg_unix** call to sendto(2), sendmsg(2), sendmmsg(2) for an unconnected unix socket (since 6.7)
110 - **recvmsg4** call to recvfrom(2), recvmsg(2), recvmmsg(2) for an unconnected udp4 socket (since 5.2)
111 - **recvmsg6** call to recvfrom(2), recvmsg(2), recvmmsg(2) for an unconnected udp6 socket (since 5.2)
112 - **recvmsg_unix** call to recvfrom(2), recvmsg(2), recvmmsg(2) for an unconnected unix socket (since 6.7)
113 - **sysctl** sysctl access (since 5.2)
114 - **getsockopt** call to getsockopt (since 5.3)
115 - **setsockopt** call to setsockopt (since 5.3)
116 - **getpeername4** call to getpeername(2) for an inet4 socket (since 5.8)
117 - **getpeername6** call to getpeername(2) for an inet6 socket (since 5.8)
118 - **getpeername_unix** call to getpeername(2) for a unix socket (since 6.7)
119 - **getsockname4** call to getsockname(2) for an inet4 socket (since 5.8)
120 - **getsockname6** call to getsockname(2) for an inet6 socket (since 5.8)
121 - **getsockname_unix** call to getsockname(2) for a unix socket (since 6.7)
122 - **sock_release** closing a userspace inet socket (since 5.9)
123
124bpftool cgroup detach *CGROUP* *ATTACH_TYPE* *PROG*
125 Detach *PROG* from the cgroup *CGROUP* and attach type *ATTACH_TYPE*.
126
127bpftool prog help
128 Print short help message.
129
130OPTIONS
131=======
132.. include:: common_options.rst
133
134-f, --bpffs
135 Show file names of pinned programs.
136
137EXAMPLES
138========
139|
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
145**# bpftool cgroup list /sys/fs/cgroup/test.slice/**
146
147::
148
149 ID AttachType AttachFlags Name
150 1 device allow_multi bpf_prog1
151
152|
153| **# bpftool cgroup detach /sys/fs/cgroup/test.slice/ device id 1**
154| **# bpftool cgroup list /sys/fs/cgroup/test.slice/**
155
156::
157
158 ID AttachType AttachFlags Name
1================
2bpftool-cgroup
3================
4-------------------------------------------------------------------------------
5tool for inspection and simple manipulation of eBPF progs
6-------------------------------------------------------------------------------
7
8:Manual section: 8
9
10SYNOPSIS
11========
12
13 **bpftool** [*OPTIONS*] **cgroup** *COMMAND*
14
15 *OPTIONS* := { { **-j** | **--json** } [{ **-p** | **--pretty** }] | { **-f** | **--bpffs** } }
16
17 *COMMANDS* :=
18 { **show** | **list** | **tree** | **attach** | **detach** | **help** }
19
20CGROUP COMMANDS
21===============
22
23| **bpftool** **cgroup { show | list }** *CGROUP* [**effective**]
24| **bpftool** **cgroup tree** [*CGROUP_ROOT*] [**effective**]
25| **bpftool** **cgroup attach** *CGROUP* *ATTACH_TYPE* *PROG* [*ATTACH_FLAGS*]
26| **bpftool** **cgroup detach** *CGROUP* *ATTACH_TYPE* *PROG*
27| **bpftool** **cgroup help**
28|
29| *PROG* := { **id** *PROG_ID* | **pinned** *FILE* | **tag** *PROG_TAG* }
30| *ATTACH_TYPE* := { **ingress** | **egress** | **sock_create** | **sock_ops** | **device** |
31| **bind4** | **bind6** | **post_bind4** | **post_bind6** | **connect4** | **connect6** |
32| **sendmsg4** | **sendmsg6** | **recvmsg4** | **recvmsg6** | **sysctl** |
33| **getsockopt** | **setsockopt** }
34| *ATTACH_FLAGS* := { **multi** | **override** }
35
36DESCRIPTION
37===========
38 **bpftool cgroup { show | list }** *CGROUP* [**effective**]
39 List all programs attached to the cgroup *CGROUP*.
40
41 Output will start with program ID followed by attach type,
42 attach flags and program name.
43
44 If **effective** is specified retrieve effective programs that
45 will execute for events within a cgroup. This includes
46 inherited along with attached ones.
47
48 **bpftool cgroup tree** [*CGROUP_ROOT*] [**effective**]
49 Iterate over all cgroups in *CGROUP_ROOT* and list all
50 attached programs. If *CGROUP_ROOT* is not specified,
51 bpftool uses cgroup v2 mountpoint.
52
53 The output is similar to the output of cgroup show/list
54 commands: it starts with absolute cgroup path, followed by
55 program ID, attach type, attach flags and program name.
56
57 If **effective** is specified retrieve effective programs that
58 will execute for events within a cgroup. This includes
59 inherited along with attached ones.
60
61 **bpftool cgroup attach** *CGROUP* *ATTACH_TYPE* *PROG* [*ATTACH_FLAGS*]
62 Attach program *PROG* to the cgroup *CGROUP* with attach type
63 *ATTACH_TYPE* and optional *ATTACH_FLAGS*.
64
65 *ATTACH_FLAGS* can be one of: **override** if a sub-cgroup installs
66 some bpf program, the program in this cgroup yields to sub-cgroup
67 program; **multi** if a sub-cgroup installs some bpf program,
68 that cgroup program gets run in addition to the program in this
69 cgroup.
70
71 Only one program is allowed to be attached to a cgroup with
72 no attach flags or the **override** flag. Attaching another
73 program will release old program and attach the new one.
74
75 Multiple programs are allowed to be attached to a cgroup with
76 **multi**. They are executed in FIFO order (those that were
77 attached first, run first).
78
79 Non-default *ATTACH_FLAGS* are supported by kernel version 4.14
80 and later.
81
82 *ATTACH_TYPE* can be on of:
83 **ingress** ingress path of the inet socket (since 4.10);
84 **egress** egress path of the inet socket (since 4.10);
85 **sock_create** opening of an inet socket (since 4.10);
86 **sock_ops** various socket operations (since 4.12);
87 **device** device access (since 4.15);
88 **bind4** call to bind(2) for an inet4 socket (since 4.17);
89 **bind6** call to bind(2) for an inet6 socket (since 4.17);
90 **post_bind4** return from bind(2) for an inet4 socket (since 4.17);
91 **post_bind6** return from bind(2) for an inet6 socket (since 4.17);
92 **connect4** call to connect(2) for an inet4 socket (since 4.17);
93 **connect6** call to connect(2) for an inet6 socket (since 4.17);
94 **sendmsg4** call to sendto(2), sendmsg(2), sendmmsg(2) for an
95 unconnected udp4 socket (since 4.18);
96 **sendmsg6** call to sendto(2), sendmsg(2), sendmmsg(2) for an
97 unconnected udp6 socket (since 4.18);
98 **recvmsg4** call to recvfrom(2), recvmsg(2), recvmmsg(2) for
99 an unconnected udp4 socket (since 5.2);
100 **recvmsg6** call to recvfrom(2), recvmsg(2), recvmmsg(2) for
101 an unconnected udp6 socket (since 5.2);
102 **sysctl** sysctl access (since 5.2);
103 **getsockopt** call to getsockopt (since 5.3);
104 **setsockopt** call to setsockopt (since 5.3).
105
106 **bpftool cgroup detach** *CGROUP* *ATTACH_TYPE* *PROG*
107 Detach *PROG* from the cgroup *CGROUP* and attach type
108 *ATTACH_TYPE*.
109
110 **bpftool prog help**
111 Print short help message.
112
113OPTIONS
114=======
115 -h, --help
116 Print short generic help message (similar to **bpftool help**).
117
118 -V, --version
119 Print version number (similar to **bpftool version**).
120
121 -j, --json
122 Generate JSON output. For commands that cannot produce JSON, this
123 option has no effect.
124
125 -p, --pretty
126 Generate human-readable JSON output. Implies **-j**.
127
128 -f, --bpffs
129 Show file names of pinned programs.
130
131 -d, --debug
132 Print all logs available from libbpf, including debug-level
133 information.
134
135EXAMPLES
136========
137|
138| **# mount -t bpf none /sys/fs/bpf/**
139| **# mkdir /sys/fs/cgroup/test.slice**
140| **# bpftool prog load ./device_cgroup.o /sys/fs/bpf/prog**
141| **# bpftool cgroup attach /sys/fs/cgroup/test.slice/ device id 1 allow_multi**
142
143**# bpftool cgroup list /sys/fs/cgroup/test.slice/**
144
145::
146
147 ID AttachType AttachFlags Name
148 1 device allow_multi bpf_prog1
149
150|
151| **# bpftool cgroup detach /sys/fs/cgroup/test.slice/ device id 1**
152| **# bpftool cgroup list /sys/fs/cgroup/test.slice/**
153
154::
155
156 ID AttachType AttachFlags Name
157
158SEE ALSO
159========
160 **bpf**\ (2),
161 **bpf-helpers**\ (7),
162 **bpftool**\ (8),
163 **bpftool-prog**\ (8),
164 **bpftool-map**\ (8),
165 **bpftool-feature**\ (8),
166 **bpftool-net**\ (8),
167 **bpftool-perf**\ (8),
168 **bpftool-btf**\ (8)