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| **sock_release** } 35| *ATTACH_FLAGS* := { **multi** | **override** } 36 37DESCRIPTION 38=========== 39 **bpftool cgroup { show | list }** *CGROUP* [**effective**] 40 List all programs attached to the cgroup *CGROUP*. 41 42 Output will start with program ID followed by attach type, 43 attach flags and program name. 44 45 If **effective** is specified retrieve effective programs that 46 will execute for events within a cgroup. This includes 47 inherited along with attached ones. 48 49 **bpftool cgroup tree** [*CGROUP_ROOT*] [**effective**] 50 Iterate over all cgroups in *CGROUP_ROOT* and list all 51 attached programs. If *CGROUP_ROOT* is not specified, 52 bpftool uses cgroup v2 mountpoint. 53 54 The output is similar to the output of cgroup show/list 55 commands: it starts with absolute cgroup path, followed by 56 program ID, attach type, attach flags and program name. 57 58 If **effective** is specified retrieve effective programs that 59 will execute for events within a cgroup. This includes 60 inherited along with attached ones. 61 62 **bpftool cgroup attach** *CGROUP* *ATTACH_TYPE* *PROG* [*ATTACH_FLAGS*] 63 Attach program *PROG* to the cgroup *CGROUP* with attach type 64 *ATTACH_TYPE* and optional *ATTACH_FLAGS*. 65 66 *ATTACH_FLAGS* can be one of: **override** if a sub-cgroup installs 67 some bpf program, the program in this cgroup yields to sub-cgroup 68 program; **multi** if a sub-cgroup installs some bpf program, 69 that cgroup program gets run in addition to the program in this 70 cgroup. 71 72 Only one program is allowed to be attached to a cgroup with 73 no attach flags or the **override** flag. Attaching another 74 program will release old program and attach the new one. 75 76 Multiple programs are allowed to be attached to a cgroup with 77 **multi**. They are executed in FIFO order (those that were 78 attached first, run first). 79 80 Non-default *ATTACH_FLAGS* are supported by kernel version 4.14 81 and later. 82 83 *ATTACH_TYPE* can be on of: 84 **ingress** ingress path of the inet socket (since 4.10); 85 **egress** egress path of the inet socket (since 4.10); 86 **sock_create** opening of an inet socket (since 4.10); 87 **sock_ops** various socket operations (since 4.12); 88 **device** device access (since 4.15); 89 **bind4** call to bind(2) for an inet4 socket (since 4.17); 90 **bind6** call to bind(2) for an inet6 socket (since 4.17); 91 **post_bind4** return from bind(2) for an inet4 socket (since 4.17); 92 **post_bind6** return from bind(2) for an inet6 socket (since 4.17); 93 **connect4** call to connect(2) for an inet4 socket (since 4.17); 94 **connect6** call to connect(2) for an inet6 socket (since 4.17); 95 **sendmsg4** call to sendto(2), sendmsg(2), sendmmsg(2) for an 96 unconnected udp4 socket (since 4.18); 97 **sendmsg6** call to sendto(2), sendmsg(2), sendmmsg(2) for an 98 unconnected udp6 socket (since 4.18); 99 **recvmsg4** call to recvfrom(2), recvmsg(2), recvmmsg(2) for 100 an unconnected udp4 socket (since 5.2); 101 **recvmsg6** call to recvfrom(2), recvmsg(2), recvmmsg(2) for 102 an unconnected udp6 socket (since 5.2); 103 **sysctl** sysctl access (since 5.2); 104 **getsockopt** call to getsockopt (since 5.3); 105 **setsockopt** call to setsockopt (since 5.3); 106 **getpeername4** call to getpeername(2) for an inet4 socket (since 5.8); 107 **getpeername6** call to getpeername(2) for an inet6 socket (since 5.8); 108 **getsockname4** call to getsockname(2) for an inet4 socket (since 5.8); 109 **getsockname6** call to getsockname(2) for an inet6 socket (since 5.8). 110 **sock_release** closing an userspace inet socket (since 5.9). 111 112 **bpftool cgroup detach** *CGROUP* *ATTACH_TYPE* *PROG* 113 Detach *PROG* from the cgroup *CGROUP* and attach type 114 *ATTACH_TYPE*. 115 116 **bpftool prog help** 117 Print short help message. 118 119OPTIONS 120======= 121 .. include:: common_options.rst 122 123 -f, --bpffs 124 Show file names of pinned programs. 125 126EXAMPLES 127======== 128| 129| **# mount -t bpf none /sys/fs/bpf/** 130| **# mkdir /sys/fs/cgroup/test.slice** 131| **# bpftool prog load ./device_cgroup.o /sys/fs/bpf/prog** 132| **# bpftool cgroup attach /sys/fs/cgroup/test.slice/ device id 1 allow_multi** 133 134**# bpftool cgroup list /sys/fs/cgroup/test.slice/** 135 136:: 137 138 ID AttachType AttachFlags Name 139 1 device allow_multi bpf_prog1 140 141| 142| **# bpftool cgroup detach /sys/fs/cgroup/test.slice/ device id 1** 143| **# bpftool cgroup list /sys/fs/cgroup/test.slice/** 144 145:: 146 147 ID AttachType AttachFlags Name 148