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|               **getpeername4** | **getpeername6** | **getsockname4** | **getsockname6** | **sendmsg4** |
33|               **sendmsg6** | **recvmsg4** | **recvmsg6** | **sysctl** | **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		  **getpeername4** call to getpeername(2) for an inet4 socket (since 5.8);
106		  **getpeername6** call to getpeername(2) for an inet6 socket (since 5.8);
107		  **getsockname4** call to getsockname(2) for an inet4 socket (since 5.8);
108		  **getsockname6** call to getsockname(2) for an inet6 socket (since 5.8).
109
110	**bpftool cgroup detach** *CGROUP* *ATTACH_TYPE* *PROG*
111		  Detach *PROG* from the cgroup *CGROUP* and attach type
112		  *ATTACH_TYPE*.
113
114	**bpftool prog help**
115		  Print short help message.
116
117OPTIONS
118=======
119	.. include:: common_options.rst
120
121	-f, --bpffs
122		  Show file names of pinned programs.
123
124EXAMPLES
125========
126|
127| **# mount -t bpf none /sys/fs/bpf/**
128| **# mkdir /sys/fs/cgroup/test.slice**
129| **# bpftool prog load ./device_cgroup.o /sys/fs/bpf/prog**
130| **# bpftool cgroup attach /sys/fs/cgroup/test.slice/ device id 1 allow_multi**
131
132**# bpftool cgroup list /sys/fs/cgroup/test.slice/**
133
134::
135
136    ID       AttachType      AttachFlags     Name
137    1        device          allow_multi     bpf_prog1
138
139|
140| **# bpftool cgroup detach /sys/fs/cgroup/test.slice/ device id 1**
141| **# bpftool cgroup list /sys/fs/cgroup/test.slice/**
142
143::
144
145    ID       AttachType      AttachFlags     Name
146