Commit b103cbe0 authored by Daniel Borkmann's avatar Daniel Borkmann
Browse files

Merge branch 'bpf-helper-man-install' 



Quentin Monnet says:

====================
The three patches in this series are related to the documentation for eBPF
helpers. The first patch brings minor formatting edits to the documentation
in include/uapi/linux/bpf.h, and the second one updates the related header
file under tools/.

The third patch adds a Makefile under tools/bpf for generating the
documentation (man pages) about eBPF helpers. The targets defined in this
file can also be called from the bpftool directory (please refer to
relevant commit logs for details).
====================

Signed-off-by: default avatarDaniel Borkmann <daniel@iogearbox.net>
parents 671dffa7 86f7d85c

include/uapi/linux/bpf.h

+2 −4
Original line number Diff line number Diff line
@@ -1826,7 +1826,7 @@ union bpf_attr { 
 * 		A non-negative value equal to or less than *size* on success,

 * 		or a negative error in case of failure.

 *

 * int skb_load_bytes_relative(const struct sk_buff *skb, u32 offset, void *to, u32 len, u32 start_header)

 * int bpf_skb_load_bytes_relative(const struct sk_buff *skb, u32 offset, void *to, u32 len, u32 start_header)

 * 	Description

 * 		This helper is similar to **bpf_skb_load_bytes**\ () in that

 * 		it provides an easy way to load *len* bytes from *offset*
@@ -1877,7 +1877,7 @@ union bpf_attr { 
 *		* < 0 if any input argument is invalid

 *		*   0 on success (packet is forwarded, nexthop neighbor exists)

 *		* > 0 one of **BPF_FIB_LKUP_RET_** codes explaining why the

 *		*     packet is not forwarded or needs assist from full stack

 *		  packet is not forwarded or needs assist from full stack

 *

 * int bpf_sock_hash_update(struct bpf_sock_ops_kern *skops, struct bpf_map *map, void *key, u64 flags)

 *	Description
@@ -2033,7 +2033,6 @@ union bpf_attr { 
 *		This helper is only available is the kernel was compiled with

 *		the **CONFIG_BPF_LIRC_MODE2** configuration option set to

 *		"**y**".

 *

 *	Return

 *		0

 *
@@ -2053,7 +2052,6 @@ union bpf_attr { 
 *		This helper is only available is the kernel was compiled with

 *		the **CONFIG_BPF_LIRC_MODE2** configuration option set to

 *		"**y**".

 *

 *	Return

 *		0

 *

tools/bpf/Makefile.helpers

0 → 100644
+59 −0
Original line number Diff line number Diff line 
ifndef allow-override

  include ../scripts/Makefile.include

  include ../scripts/utilities.mak

else

  # Assume Makefile.helpers is being run from bpftool/Documentation

  # subdirectory. Go up two more directories to fetch bpf.h header and

  # associated script.

  UP2DIR := ../../

endif



INSTALL ?= install

RM ?= rm -f

RMDIR ?= rmdir --ignore-fail-on-non-empty



ifeq ($(V),1)

  Q =

else

  Q = @

endif



prefix ?= /usr/local

mandir ?= $(prefix)/man

man7dir = $(mandir)/man7



HELPERS_RST = bpf-helpers.rst

MAN7_RST = $(HELPERS_RST)



_DOC_MAN7 = $(patsubst %.rst,%.7,$(MAN7_RST))

DOC_MAN7 = $(addprefix $(OUTPUT),$(_DOC_MAN7))



helpers: man7

man7: $(DOC_MAN7)



RST2MAN_DEP := $(shell command -v rst2man 2>/dev/null)



$(OUTPUT)$(HELPERS_RST): $(UP2DIR)../../include/uapi/linux/bpf.h

	$(QUIET_GEN)$(UP2DIR)../../scripts/bpf_helpers_doc.py --filename $< > $@



$(OUTPUT)%.7: $(OUTPUT)%.rst

ifndef RST2MAN_DEP

	$(error "rst2man not found, but required to generate man pages")

endif

	$(QUIET_GEN)rst2man $< > $@



helpers-clean:

	$(call QUIET_CLEAN, eBPF_helpers-manpage)

	$(Q)$(RM) $(DOC_MAN7) $(OUTPUT)$(HELPERS_RST)



helpers-install: helpers

	$(call QUIET_INSTALL, eBPF_helpers-manpage)

	$(Q)$(INSTALL) -d -m 755 $(DESTDIR)$(man7dir)

	$(Q)$(INSTALL) -m 644 $(DOC_MAN7) $(DESTDIR)$(man7dir)



helpers-uninstall:

	$(call QUIET_UNINST, eBPF_helpers-manpage)

	$(Q)$(RM) $(addprefix $(DESTDIR)$(man7dir)/,$(_DOC_MAN7))

	$(Q)$(RMDIR) $(DESTDIR)$(man7dir)



.PHONY: helpers helpers-clean helpers-install helpers-uninstall

tools/bpf/bpftool/Documentation/Makefile

+8 −5
Original line number Diff line number Diff line
@@ -15,12 +15,15 @@ prefix ?= /usr/local 
mandir ?= $(prefix)/man

man8dir = $(mandir)/man8



MAN8_RST = $(wildcard *.rst)

# Load targets for building eBPF helpers man page.

include ../../Makefile.helpers



MAN8_RST = $(filter-out $(HELPERS_RST),$(wildcard *.rst))



_DOC_MAN8 = $(patsubst %.rst,%.8,$(MAN8_RST))

DOC_MAN8 = $(addprefix $(OUTPUT),$(_DOC_MAN8))



man: man8

man: man8 helpers

man8: $(DOC_MAN8)



RST2MAN_DEP := $(shell command -v rst2man 2>/dev/null)
@@ -31,16 +34,16 @@ ifndef RST2MAN_DEP 
endif

	$(QUIET_GEN)rst2man $< > $@



clean:

clean: helpers-clean

	$(call QUIET_CLEAN, Documentation)

	$(Q)$(RM) $(DOC_MAN8)



install: man

install: man helpers-install

	$(call QUIET_INSTALL, Documentation-man)

	$(Q)$(INSTALL) -d -m 755 $(DESTDIR)$(man8dir)

	$(Q)$(INSTALL) -m 644 $(DOC_MAN8) $(DESTDIR)$(man8dir)



uninstall:

uninstall: helpers-uninstall

	$(call QUIET_UNINST, Documentation-man)

	$(Q)$(RM) $(addprefix $(DESTDIR)$(man8dir)/,$(_DOC_MAN8))

	$(Q)$(RMDIR) $(DESTDIR)$(man8dir)

tools/include/uapi/linux/bpf.h

+24 −8
Original line number Diff line number Diff line
@@ -1826,7 +1826,7 @@ union bpf_attr { 
 * 		A non-negative value equal to or less than *size* on success,

 * 		or a negative error in case of failure.

 *

 * int skb_load_bytes_relative(const struct sk_buff *skb, u32 offset, void *to, u32 len, u32 start_header)

 * int bpf_skb_load_bytes_relative(const struct sk_buff *skb, u32 offset, void *to, u32 len, u32 start_header)

 * 	Description

 * 		This helper is similar to **bpf_skb_load_bytes**\ () in that

 * 		it provides an easy way to load *len* bytes from *offset*
@@ -1857,7 +1857,8 @@ union bpf_attr { 
 *		is resolved), the nexthop address is returned in ipv4_dst

 *		or ipv6_dst based on family, smac is set to mac address of

 *		egress device, dmac is set to nexthop mac address, rt_metric

 *		is set to metric from route (IPv4/IPv6 only).

 *		is set to metric from route (IPv4/IPv6 only), and ifindex

 *		is set to the device index of the nexthop from the FIB lookup.

 *

 *             *plen* argument is the size of the passed in struct.

 *             *flags* argument can be a combination of one or more of the
@@ -1873,9 +1874,10 @@ union bpf_attr { 
 *             *ctx* is either **struct xdp_md** for XDP programs or

 *             **struct sk_buff** tc cls_act programs.

 *     Return

 *             Egress device index on success, 0 if packet needs to continue

 *             up the stack for further processing or a negative error in case

 *             of failure.

 *		* < 0 if any input argument is invalid

 *		*   0 on success (packet is forwarded, nexthop neighbor exists)

 *		* > 0 one of **BPF_FIB_LKUP_RET_** codes explaining why the

 *		  packet is not forwarded or needs assist from full stack

 *

 * int bpf_sock_hash_update(struct bpf_sock_ops_kern *skops, struct bpf_map *map, void *key, u64 flags)

 *	Description
@@ -2031,7 +2033,6 @@ union bpf_attr { 
 *		This helper is only available is the kernel was compiled with

 *		the **CONFIG_BPF_LIRC_MODE2** configuration option set to

 *		"**y**".

 *

 *	Return

 *		0

 *
@@ -2051,7 +2052,6 @@ union bpf_attr { 
 *		This helper is only available is the kernel was compiled with

 *		the **CONFIG_BPF_LIRC_MODE2** configuration option set to

 *		"**y**".

 *

 *	Return

 *		0

 *
@@ -2612,6 +2612,18 @@ struct bpf_raw_tracepoint_args { 
#define BPF_FIB_LOOKUP_DIRECT  BIT(0)

#define BPF_FIB_LOOKUP_OUTPUT  BIT(1)



enum {

	BPF_FIB_LKUP_RET_SUCCESS,      /* lookup successful */

	BPF_FIB_LKUP_RET_BLACKHOLE,    /* dest is blackholed; can be dropped */

	BPF_FIB_LKUP_RET_UNREACHABLE,  /* dest is unreachable; can be dropped */

	BPF_FIB_LKUP_RET_PROHIBIT,     /* dest not allowed; can be dropped */

	BPF_FIB_LKUP_RET_NOT_FWDED,    /* packet is not forwarded */

	BPF_FIB_LKUP_RET_FWD_DISABLED, /* fwding is not enabled on ingress */

	BPF_FIB_LKUP_RET_UNSUPP_LWT,   /* fwd requires encapsulation */

	BPF_FIB_LKUP_RET_NO_NEIGH,     /* no neighbor entry for nh */

	BPF_FIB_LKUP_RET_FRAG_NEEDED,  /* fragmentation required to fwd */

};



struct bpf_fib_lookup {

	/* input:  network family for lookup (AF_INET, AF_INET6)

	 * output: network family of egress nexthop
@@ -2625,7 +2637,11 @@ struct bpf_fib_lookup { 


	/* total length of packet from network header - used for MTU check */

	__u16	tot_len;

	__u32	ifindex;  /* L3 device index for lookup */



	/* input: L3 device index for lookup

	 * output: device index from FIB lookup

	 */

	__u32	ifindex;



	union {

		/* inputs to lookup */

CRA Git | Maintained and supported by SUSTech CRA and CCSE