Skip to contentSkip to conversation

bpf: refer to struct xdp_md in user space comments

PATCH In review Jakub Kicinski 4 participants 5 messages Aug 19, 2020 – Aug 31, 2020

Subsystems (3)
lore
Share & tools
lore

Jakub Kicinski

author maintainer
#0 lore raw

PATCH 1/1 bpf: refer to struct xdp_md in user space comments

uAPI uses xdp_md, not xdp_buff. Fix comments.

---
 include/uapi/linux/bpf.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
include/uapi/linux/bpf.h +4 -4
index 0480f893facd..cc3553a102d0 100644
@@ -1554,7 +1554,7 @@ union bpf_attr {
  * 	Return
  * 		0 on success, or a negative error in case of failure.
  *
- * long bpf_xdp_adjust_head(struct xdp_buff *xdp_md, int delta)
+ * long bpf_xdp_adjust_head(struct xdp_md *xdp_md, int delta)
  * 	Description
  * 		Adjust (move) *xdp_md*\ **->data** by *delta* bytes. Note that
  * 		it is possible to use a negative value for *delta*. This helper
@@ -1752,7 +1752,7 @@ union bpf_attr {
  * 	Return
  * 		0 on success, or a negative error in case of failure.
  *
- * long bpf_xdp_adjust_meta(struct xdp_buff *xdp_md, int delta)
+ * long bpf_xdp_adjust_meta(struct xdp_md *xdp_md, int delta)
  * 	Description
  * 		Adjust the address pointed by *xdp_md*\ **->data_meta** by
  * 		*delta* (which can be positive or negative). Note that this
@@ -2051,7 +2051,7 @@ union bpf_attr {
  * 	Return
  * 		0 on success, or a negative error in case of failure.
  *
- * long bpf_xdp_adjust_tail(struct xdp_buff *xdp_md, int delta)
+ * long bpf_xdp_adjust_tail(struct xdp_md *xdp_md, int delta)
  * 	Description
  * 		Adjust (move) *xdp_md*\ **->data_end** by *delta* bytes. It is
  * 		possible to both shrink and grow the packet tail.
@@ -3049,7 +3049,7 @@ union bpf_attr {
  *		The value to write, of *size*, is passed through eBPF stack and
  *		pointed by *data*.
  *
- *		*ctx* is a pointer to in-kernel struct xdp_buff.
+ *		*ctx* is a pointer to in-kernel struct xdp_md.
  *
  *		This helper is similar to **bpf_perf_eventoutput**\ () but
  *		restricted to raw_tracepoint bpf programs.
Signature · 1 line
2.26.2
maintainer
#2 lore raw
In reply to Jakub Kicinski

include/uapi/linux/bpf.h union bpf_attr {

Quoted 12 lines · Jakub Kicinski

uAPI uses xdp_md, not xdp_buff. Fix comments.

---
  include/uapi/linux/bpf.h | 8 ++++----
  1 file changed, 4 insertions(+), 4 deletions(-)
include/uapi/linux/bpf.h +0 -0
index 0480f893facd..cc3553a102d0 100644
@@ -1554,7 +1554,7 @@ union bpf_attr {

Needs also tooling header copy, but once that is done, it needs fixup for libbpf:

[root@pc-9 bpf]# make
GEN bpf_helper_defs.h
Unrecognized type 'struct xdp_md', please add it to known types! make[1]: *** [Makefile:186: bpf_helper_defs.h] Error 1 make[1]: *** Deleting file 'bpf_helper_defs.h'
make: *** [Makefile:160: all] Error 2
[root@pc-9 bpf]#

Pls fix up and send v2, thanks.
Daniel

author maintainer
#3 lore raw
Quoted 24 lines · On Thu, 20 Aug 2020 16:16:47 +0200 Daniel Borkmann wrote:

include/uapi/linux/bpf.h union bpf_attr {

Quoted 12 lines · Jakub Kicinski

uAPI uses xdp_md, not xdp_buff. Fix comments.

---
  include/uapi/linux/bpf.h | 8 ++++----
  1 file changed, 4 insertions(+), 4 deletions(-)
include/uapi/linux/bpf.h +0 -0
index 0480f893facd..cc3553a102d0 100644
@@ -1554,7 +1554,7 @@ union bpf_attr {  

Needs also tooling header copy, but once that is done, it needs fixup for libbpf:

[root@pc-9 bpf]# make
GEN bpf_helper_defs.h
Unrecognized type 'struct xdp_md', please add it to known types! make[1]: *** [Makefile:186: bpf_helper_defs.h] Error 1 make[1]: *** Deleting file 'bpf_helper_defs.h'
make: *** [Makefile:160: all] Error 2
[root@pc-9 bpf]#

Quoted 1 line

Pls fix up and send v2, thanks.

FWIW upon closer inspection it appears that this is intentional (even if confusing) and bpf_helpers_doc.py swaps the types to __sk_buff and xdp_md when generating man pages and the header.

#4 lore raw
Quoted 25 lines · Jakub Kicinski
Quoted 24 lines · On Thu, 20 Aug 2020 16:16:47 +0200 Daniel Borkmann wrote:

include/uapi/linux/bpf.h union bpf_attr {

Quoted 12 lines · Jakub Kicinski

uAPI uses xdp_md, not xdp_buff. Fix comments.

---
  include/uapi/linux/bpf.h | 8 ++++----
  1 file changed, 4 insertions(+), 4 deletions(-)
include/uapi/linux/bpf.h +0 -0
index 0480f893facd..cc3553a102d0 100644
@@ -1554,7 +1554,7 @@ union bpf_attr {  

Needs also tooling header copy, but once that is done, it needs fixup for libbpf:

[root@pc-9 bpf]# make
GEN bpf_helper_defs.h
Unrecognized type 'struct xdp_md', please add it to known types! make[1]: *** [Makefile:186: bpf_helper_defs.h] Error 1 make[1]: *** Deleting file 'bpf_helper_defs.h'
make: *** [Makefile:160: all] Error 2
[root@pc-9 bpf]#

Quoted 6 lines
Quoted 1 line

Pls fix up and send v2, thanks.

FWIW upon closer inspection it appears that this is intentional (even if confusing) and bpf_helpers_doc.py swaps the types to __sk_buff and xdp_md when generating man pages and the header.

I liked the direction of fixing the uapi file. Is there a legit reason to have the documentation in uapi/linux/bpf.h to reference a struct that is not part of the uapi?