diff options
Diffstat (limited to 'doc/guides/sample_app_ug')
| -rw-r--r-- | doc/guides/sample_app_ug/l3_forward.rst | 42 |
1 files changed, 28 insertions, 14 deletions
diff --git a/doc/guides/sample_app_ug/l3_forward.rst b/doc/guides/sample_app_ug/l3_forward.rst index 491f99d9..c885cdb7 100644 --- a/doc/guides/sample_app_ug/l3_forward.rst +++ b/doc/guides/sample_app_ug/l3_forward.rst @@ -88,32 +88,46 @@ To compile the application: Running the Application ----------------------- -The application has a number of command line options: +The application has a number of command line options:: -.. code-block:: console + ./l3fwd [EAL options] -- -p PORTMASK + [-P] + [-E] + [-L] + --config(port,queue,lcore)[,(port,queue,lcore)] + [--eth-dest=X,MM:MM:MM:MM:MM:MM] + [--enable-jumbo [--max-pkt-len PKTLEN]] + [--no-numa] + [--hash-entry-num] + [--ipv6] + [--parse-ptype] + +Where, + +* ``-p PORTMASK:`` Hexadecimal bitmask of ports to configure - ./build/l3fwd [EAL options] -- -p PORTMASK [-P] --config(port,queue,lcore)[,(port,queue,lcore)] [--enable-jumbo [--max-pkt-len PKTLEN]] [--no-numa][--hash-entry-num][--ipv6] [--parse-ptype] +* ``-P:`` Optional, sets all ports to promiscuous mode so that packets are accepted regardless of the packet's Ethernet MAC destination address. + Without this option, only packets with the Ethernet MAC destination address set to the Ethernet address of the port are accepted. -where, +* ``-E:`` Optional, enable exact match. -* -p PORTMASK: Hexadecimal bitmask of ports to configure +* ``-L:`` Optional, enable longest prefix match. -* -P: optional, sets all ports to promiscuous mode so that packets are accepted regardless of the packet's Ethernet MAC destination address. - Without this option, only packets with the Ethernet MAC destination address set to the Ethernet address of the port are accepted. +* ``--config (port,queue,lcore)[,(port,queue,lcore)]:`` Determines which queues from which ports are mapped to which cores. -* --config (port,queue,lcore)[,(port,queue,lcore)]: determines which queues from which ports are mapped to which cores +* ``--eth-dest=X,MM:MM:MM:MM:MM:MM:`` Optional, ethernet destination for port X. -* --enable-jumbo: optional, enables jumbo frames +* ``--enable-jumbo:`` Optional, enables jumbo frames. -* --max-pkt-len: optional, maximum packet length in decimal (64-9600) +* ``--max-pkt-len:`` Optional, under the premise of enabling jumbo, maximum packet length in decimal (64-9600). -* --no-numa: optional, disables numa awareness +* ``--no-numa:`` Optional, disables numa awareness. -* --hash-entry-num: optional, specifies the hash entry number in hexadecimal to be setup +* ``--hash-entry-num:`` Optional, specifies the hash entry number in hexadecimal to be setup. -* --ipv6: optional, set it if running ipv6 packets +* ``--ipv6:`` Optional, set if running ipv6 packets. -* --parse-ptype: optional, set it if use software way to analyze packet type +* ``--parse-ptype:`` Optional, set to use software to analyze packet type. Without this option, hardware will check the packet type. For example, consider a dual processor socket platform where cores 0-7 and 16-23 appear on socket 0, while cores 8-15 and 24-31 appear on socket 1. Let's say that the programmer wants to use memory from both NUMA nodes, the platform has only two ports, one connected to each NUMA node, |