Skip to content
Snippets Groups Projects
Commit a81b2a3d authored by Daniel Salzman's avatar Daniel Salzman
Browse files

fixup! kxdpgun: update documentation

parent 13912ce4
No related branches found
No related tags found
No related merge requests found
......@@ -102,6 +102,23 @@ Override auto\-detected remote MAC address.
\fB\-v\fP, \fB\-\-vlan\fP \fIid\fP
Add VLAN 802.1Q header with the given id. VLAN offloading should be disabled.
.TP
\fB\-m\fP, \fB\-\-mode\fP \fImode\fP
Set the XDP mode. Supported values are:
.INDENT 7.0
.IP \(bu 2
\fBauto\fP (default) – the XDP mode is selected automatically to achieve
the best performance, which means that native driver support is preferred
over the generic one, and zero\-copy is used if available.
.IP \(bu 2
\fBcopy\fP – the XDP socket copy mode is forced even if zero\-copy
is available. This can resolve various driver issues, but at the cost
of lower performance.
.IP \(bu 2
\fBgeneric\fP – the generic XDP implementation is forced even if native
implementation is available. This mode doesn\(aqt require support from the
driver nor hardware, but offers the worst performance.
.UNINDENT
.TP
\fB\-h\fP, \fB\-\-help\fP
Print the program help.
.TP
......
......@@ -80,17 +80,19 @@ Options
Add VLAN 802.1Q header with the given id. VLAN offloading should be disabled.
**-m**, **--mode** *mode*
Set the XDP mode. Supported values are *auto* (default), *copy*, and *generic*.
Set the XDP mode. Supported values are:
When the mode is set to *auto*, kxdpgun uses native driver or hardware XDP
implementation. The zero-copy for packet data between kernel and user space is
also enabled if supported by the implementation.
- **auto** (default) – the XDP mode is selected automatically to achieve
the best performance, which means that native driver support is preferred
over the generic one, and zero-copy is used if available.
When the mode is set to *copy*, kxdpgun also uses native driver but disables
the zero-copy.
- **copy** – the XDP socket copy mode is forced even if zero-copy
is available. This can resolve various driver issues, but at the cost
of lower performance.
When the mode is set to *generic*, kxdpgun uses generic XDP implementation
which doesn't require support from the driver nor hardware.
- **generic** – the generic XDP implementation is forced even if native
implementation is available. This mode doesn't require support from the
driver nor hardware, but offers the worst performance.
**-h**, **--help**
Print the program help.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment