4. Ethtool Sample Application
The Ethtool sample application shows an implementation of an ethtool-like API and provides a console environment that allows its use to query and change Ethernet card parameters. The sample is based upon a simple L2 frame reflector.
4.1. Compiling the Application
To compile the sample application see Compiling the Sample Applications.
The application is located in the
4.2. Running the Application
The application requires an available core for each port, plus one. The only available options are the standard ones for the EAL:
./<build_dir>/examples/dpdk-ethtool [EAL options]
Refer to the DPDK Getting Started Guide for general information on running applications and the Environment Abstraction Layer (EAL) options.
4.3. Using the application
The application is console-driven using the cmdline DPDK interface:
From this interface the available commands and descriptions of what they do as follows:
drvinfo: Print driver info
eeprom: Dump EEPROM to file
module-eeprom: Dump plugin module EEPROM to file
link: Print port link states
macaddr: Gets/sets MAC address
mtu: Set NIC MTU
open: Open port
pause: Get/set port pause state
portstats: Print port statistics
regs: Dump port register(s) to file
ringparam: Get/set ring parameters
rxmode: Toggle port Rx mode
stop: Stop port
validate: Check that given MAC address is valid unicast address
vlan: Add/remove VLAN id
quit: Exit program
4.4.1. Packet Reflector
The background packet reflector is intended to demonstrate basic packet processing on NIC ports controlled by the Ethtool shim. Each incoming MAC frame is rewritten so that it is returned to the sender, using the port in question’s own MAC address as the source address, and is then sent out on the same port.
4.4.2. Ethtool Shell
The foreground part of the Ethtool sample is a console-based interface that accepts commands as described in using the application. Individual call-back functions handle the detail associated with each command, which make use of the functions defined in the Ethtool interface to the DPDK functions.
4.5. Ethtool interface
The Ethtool interface is built as a separate library, and implements the following functions: