Skip to content

Commit

Permalink
xdp-bench: Update load-mode documentation
Browse files Browse the repository at this point in the history
Update the documentation to reflect the changes made in pull request xdp-project#409 (d7edea3).

Signed-off-by: Nimrod Oren <[email protected]>
  • Loading branch information
nimrod-oren authored and tohojo committed Nov 19, 2024
1 parent 7aafb57 commit a746871
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 28 deletions.
21 changes: 9 additions & 12 deletions xdp-bench/README.org
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,12 @@ flushing it back out if writing).
The default for this option is =no-touch=.

** -l, --load-mode <MODE>
Specify which mechanism xdp-bench should use to load the packet data when
parsing the IP header (used with =-p parse-ip=). The following modes are
available:
Specify which mechanism xdp-bench should use to load (and store) the packet data.
The following modes are available:

#+begin_src sh
dpa - Use traditional Direct Packet Access from the XDP program
load-bytes - Use the xdp_load_bytes() helper function to load the data
load-bytes - Use the xdp_load_bytes() and xdp_store_bytes() helper functions
#+end_src

This can be used to benchmark the various packet access modes supported by the
Expand Down Expand Up @@ -154,13 +153,12 @@ following actions are available:
The default for this option is =no-touch=.

** -l, --load-mode <MODE>
Specify which mechanism xdp-bench should use to load the packet data when
parsing the IP header (used with =-p parse-ip=). The following modes are
available:
Specify which mechanism xdp-bench should use to load (and store) the packet data.
The following modes are available:

#+begin_src sh
dpa - Use traditional Direct Packet Access from the XDP program
load-bytes - Use the xdp_load_bytes() helper function to load the data
load-bytes - Use the xdp_load_bytes() and xdp_store_bytes() helper functions
#+end_src

This can be used to benchmark the various packet access modes supported by the
Expand Down Expand Up @@ -234,13 +232,12 @@ allows this function to be turned off.
The default for this option is =swap-macs=.

** -l, --load-mode <MODE>
Specify which mechanism xdp-bench should use to load the packet data when
parsing the IP header (used with =-p parse-ip=). The following modes are
available:
Specify which mechanism xdp-bench should use to load (and store) the packet data.
The following modes are available:

#+begin_src sh
dpa - Use traditional Direct Packet Access from the XDP program
load-bytes - Use the xdp_load_bytes() helper function to load the data
load-bytes - Use the xdp_load_bytes() and xdp_store_bytes() helper functions
#+end_src

This can be used to benchmark the various packet access modes supported by the
Expand Down
27 changes: 12 additions & 15 deletions xdp-bench/xdp-bench.8
Original file line number Diff line number Diff line change
Expand Up @@ -92,14 +92,13 @@ The default for this option is \fIno\-touch\fP.

.SS "-l, --load-mode <MODE>"
.PP
Specify which mechanism xdp-bench should use to load the packet data when
parsing the IP header (used with \fI\-p parse\-ip\fP). The following modes are
available:
Specify which mechanism xdp-bench should use to load (and store) the packet data.
The following modes are available:

.RS
.nf
\fCdpa - Use traditional Direct Packet Access from the XDP program
load-bytes - Use the xdp_load_bytes() helper function to load the data
\fCdpa - Use traditional Direct Packet Access from the XDP program
load-bytes - Use the xdp_load_bytes() and xdp_store_bytes() helper functions
\fP
.fi
.RE
Expand Down Expand Up @@ -191,14 +190,13 @@ The default for this option is \fIno\-touch\fP.

.SS "-l, --load-mode <MODE>"
.PP
Specify which mechanism xdp-bench should use to load the packet data when
parsing the IP header (used with \fI\-p parse\-ip\fP). The following modes are
available:
Specify which mechanism xdp-bench should use to load (and store) the packet data.
The following modes are available:

.RS
.nf
\fCdpa - Use traditional Direct Packet Access from the XDP program
load-bytes - Use the xdp_load_bytes() helper function to load the data
\fCdpa - Use traditional Direct Packet Access from the XDP program
load-bytes - Use the xdp_load_bytes() and xdp_store_bytes() helper functions
\fP
.fi
.RE
Expand Down Expand Up @@ -295,14 +293,13 @@ The default for this option is \fIswap\-macs\fP.

.SS "-l, --load-mode <MODE>"
.PP
Specify which mechanism xdp-bench should use to load the packet data when
parsing the IP header (used with \fI\-p parse\-ip\fP). The following modes are
available:
Specify which mechanism xdp-bench should use to load (and store) the packet data.
The following modes are available:

.RS
.nf
\fCdpa - Use traditional Direct Packet Access from the XDP program
load-bytes - Use the xdp_load_bytes() helper function to load the data
\fCdpa - Use traditional Direct Packet Access from the XDP program
load-bytes - Use the xdp_load_bytes() and xdp_store_bytes() helper functions
\fP
.fi
.RE
Expand Down
2 changes: 1 addition & 1 deletion xdp-bench/xdp-bench.c
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ struct prog_option basic_options[] = {
.short_opt = 'l',
.metavar = "<mode>",
.typearg = basic_load_modes,
.help = "How to load data when parsing IP header (with -p parse-ip; default dpa)"),
.help = "How to load (and store) data; default dpa"),
DEFINE_OPTION("rxq-stats", OPT_BOOL, struct basic_opts, rxq_stats,
.short_opt = 'r',
.help = "Collect per-RXQ drop statistics"),
Expand Down

0 comments on commit a746871

Please sign in to comment.