Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 882731e0 authored by Quentin Monnet's avatar Quentin Monnet Committed by Daniel Borkmann
Browse files

tools: bpftool: document restriction on '.' in names to pin in bpffs 



Names used to pin eBPF programs and maps under the eBPF virtual file
system cannot contain a dot character, which is reserved for future
extensions of this file system.

Document this in bpftool man pages to avoid users getting confused if
pinning fails because of a dot.

Signed-off-by: default avatarQuentin Monnet <quentin.monnet@netronome.com>
Reviewed-by: default avatarJakub Kicinski <jakub.kicinski@netronome.com>
Signed-off-by: default avatarDaniel Borkmann <daniel@iogearbox.net>
parent c5fa5d60

tools/bpf/bpftool/Documentation/bpftool-map.rst

+3 −1
Original line number Diff line number Diff line
@@ -86,7 +86,9 @@ DESCRIPTION 
	**bpftool map pin**     *MAP*  *FILE*

		  Pin map *MAP* as *FILE*.



		  Note: *FILE* must be located in *bpffs* mount.

		  Note: *FILE* must be located in *bpffs* mount. It must not

		  contain a dot character ('.'), which is reserved for future

		  extensions of *bpffs*.



	**bpftool** **map event_pipe** *MAP* [**cpu** *N* **index** *M*]

		  Read events from a BPF_MAP_TYPE_PERF_EVENT_ARRAY map.

tools/bpf/bpftool/Documentation/bpftool-prog.rst

+6 −2
Original line number Diff line number Diff line
@@ -75,7 +75,9 @@ DESCRIPTION 
	**bpftool prog pin** *PROG* *FILE*

		  Pin program *PROG* as *FILE*.



		  Note: *FILE* must be located in *bpffs* mount.

		  Note: *FILE* must be located in *bpffs* mount. It must not

		  contain a dot character ('.'), which is reserved for future

		  extensions of *bpffs*.



	**bpftool prog load** *OBJ* *FILE* [**type** *TYPE*] [**map** {**idx** *IDX* | **name** *NAME*} *MAP*] [**dev** *NAME*]

		  Load bpf program from binary *OBJ* and pin as *FILE*.
@@ -91,7 +93,9 @@ DESCRIPTION 
		  If **dev** *NAME* is specified program will be loaded onto

		  given networking device (offload).



		  Note: *FILE* must be located in *bpffs* mount.

		  Note: *FILE* must be located in *bpffs* mount. It must not

		  contain a dot character ('.'), which is reserved for future

		  extensions of *bpffs*.



        **bpftool prog attach** *PROG* *ATTACH_TYPE* *MAP*

                  Attach bpf program *PROG* (with type specified by *ATTACH_TYPE*)