guides/sample_app_ug/l2_forward_real_virtual.rst

..  SPDX-License-Identifier: BSD-3-Clause
    Copyright(c) 2010-2014 Intel Corporation.

.. _l2_fwd_app_real_and_virtual:

L2 Forwarding Sample Application (in Real and Virtualized Environments)
=======================================================================

The L2 Forwarding sample application is a simple example of packet processing using
the Data Plane Development Kit (DPDK) which
also takes advantage of Single Root I/O Virtualization (SR-IOV) features in a virtualized environment.

.. note::

    Please note that previously a separate L2 Forwarding in Virtualized Environments sample application was used,
    however, in later DPDK versions these sample applications have been merged.

Overview
--------

The L2 Forwarding sample application, which can operate in real and virtualized environments,
performs L2 forwarding for each packet that is received on an RX_PORT.
The destination port is the adjacent port from the enabled portmask, that is,
if the first four ports are enabled (portmask 0xf),
ports 1 and 2 forward into each other, and ports 3 and 4 forward into each other.
Also, if MAC addresses updating is enabled, the MAC addresses are affected as follows:

*   The source MAC address is replaced by the TX_PORT MAC address

*   The destination MAC address is replaced by  02:00:00:00:00:TX_PORT_ID

This application can be used to benchmark performance using a traffic-generator, as shown in the :numref:`figure_l2_fwd_benchmark_setup`,
or in a virtualized environment as shown in :numref:`figure_l2_fwd_virtenv_benchmark_setup`.

.. _figure_l2_fwd_benchmark_setup:

.. figure:: img/l2_fwd_benchmark_setup.*

   Performance Benchmark Setup (Basic Environment)

.. _figure_l2_fwd_virtenv_benchmark_setup:

.. figure:: img/l2_fwd_virtenv_benchmark_setup.*

   Performance Benchmark Setup (Virtualized Environment)

This application may be used for basic VM to VM communication as shown in :numref:`figure_l2_fwd_vm2vm`,
when MAC addresses updating is disabled.

.. _figure_l2_fwd_vm2vm:

.. figure:: img/l2_fwd_vm2vm.*

   Virtual Machine to Virtual Machine communication.

The L2 Forwarding application can also be used as a starting point for developing a new application based on the DPDK.

.. _l2_fwd_vf_setup:

Virtual Function Setup Instructions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This application can use the virtual function available in the system and
therefore can be used in a virtual machine without passing through
the whole Network Device into a guest machine in a virtualized scenario.
The virtual functions can be enabled in the host machine or the hypervisor with the respective physical function driver.

For example, in a Linux* host machine, it is possible to enable a virtual function using the following command:

.. code-block:: console

    modprobe ixgbe max_vfs=2,2

This command enables two Virtual Functions on each of Physical Function of the NIC,
with two physical ports in the PCI configuration space.
It is important to note that enabled Virtual Function 0 and 2 would belong to Physical Function 0
and Virtual Function 1 and 3 would belong to Physical Function 1,
in this case enabling a total of four Virtual Functions.

Compiling the Application
-------------------------

To compile the sample application see :doc:`compiling`.

The application is located in the ``l2fwd`` sub-directory.

Running the Application
-----------------------

The application requires a number of command line options:

.. code-block:: console

    ./<build_dir>/examples/dpdk-l2fwd [EAL options] -- -p PORTMASK
                                   [-P]
                                   [-q NQ]
                                   --[no-]mac-updating
                                   [--portmap="(port, port)[,(port, port)]"]

where,

*   p PORTMASK: A hexadecimal bitmask of the ports to configure

*   P: Optional, set all ports to promiscuous mode
    so that packets are accepted regardless of the MAC destination address.
    Without this option, only packets with the MAC destination address
    set to the Ethernet address of the port are accepted.

*   q NQ: A number of queues (=ports) per lcore (default is 1)

*   --[no-]mac-updating: Enable or disable MAC addresses updating (enabled by default)

*   --portmap="(port,port)[,(port,port)]": Determines forwarding ports mapping.

To run the application in linux environment with 4 lcores, 16 ports and 8 RX queues per lcore and MAC address
updating enabled, issue the command:

.. code-block:: console

    $ ./<build_dir>/examples/dpdk-l2fwd -l 0-3 -n 4 -- -q 8 -p ffff

To run the application in linux environment with 4 lcores, 4 ports, 8 RX queues
per lcore, to forward RX traffic of ports 0 & 1 on ports 2 & 3 respectively and
vice versa, issue the command:

.. code-block:: console

    $ ./<build_dir>/examples/dpdk-l2fwd -l 0-3 -n 4 -- -q 8 -p f --portmap="(0,2)(1,3)"

Refer to the *DPDK Getting Started Guide* for general information on running applications
and the Environment Abstraction Layer (EAL) options.

Explanation
-----------

The following sections provide some explanation of the code.

.. _l2_fwd_app_cmd_arguments:

Command Line Arguments
~~~~~~~~~~~~~~~~~~~~~~

The L2 Forwarding sample application takes specific parameters,
in addition to Environment Abstraction Layer (EAL) arguments.
The preferred way to parse parameters is to use the getopt() function,
since it is part of a well-defined and portable library.

The parsing of arguments is done in the l2fwd_parse_args() function.
The method of argument parsing is not described here.
Refer to the *glibc getopt(3)* man page for details.

EAL arguments are parsed first, then application-specific arguments.
This is done at the beginning of the main() function:

.. literalinclude:: ../../../examples/l2fwd/main.c
    :language: c
    :start-after: Init EAL. 8<
    :end-before: >8 End of init EAL.
    :dedent: 1

.. _l2_fwd_app_mbuf_init:

Mbuf Pool Initialization
~~~~~~~~~~~~~~~~~~~~~~~~

Once the arguments are parsed, the mbuf pool is created.
The mbuf pool contains a set of mbuf objects that will be used by the driver
and the application to store network packet data:

.. literalinclude:: ../../../examples/l2fwd/main.c
    :language: c
    :start-after: Create the mbuf pool. 8<
    :end-before: >8 End of create the mbuf pool.
    :dedent: 1

The rte_mempool is a generic structure used to handle pools of objects.
In this case, it is necessary to create a pool that will be used by the driver.
The number of allocated pkt mbufs is NB_MBUF, with a data room size of
RTE_MBUF_DEFAULT_BUF_SIZE each.
A per-lcore cache of 32 mbufs is kept.
The memory is allocated in NUMA socket 0,
but it is possible to extend this code to allocate one mbuf pool per socket.

The rte_pktmbuf_pool_create() function uses the default mbuf pool and mbuf
initializers, respectively rte_pktmbuf_pool_init() and rte_pktmbuf_init().
An advanced application may want to use the mempool API to create the
mbuf pool with more control.

.. _l2_fwd_app_dvr_init:

Driver Initialization
~~~~~~~~~~~~~~~~~~~~~

The main part of the code in the main() function relates to the initialization of the driver.
To fully understand this code, it is recommended to study the chapters that related to the Poll Mode Driver
in the *DPDK Programmer's Guide* - Rel 1.4 EAR and the *DPDK API Reference*.

.. literalinclude:: ../../../examples/l2fwd/main.c
    :language: c
    :start-after: Initialization of the driver. 8<
    :end-before: >8 End of initialization of the driver.
    :dedent: 1

The next step is to configure the RX and TX queues.
For each port, there is only one RX queue (only one lcore is able to poll a given port).
The number of TX queues depends on the number of available lcores.
The rte_eth_dev_configure() function is used to configure the number of queues for a port:

.. literalinclude:: ../../../examples/l2fwd/main.c
    :language: c
    :start-after: Configure the number of queues for a port.
    :end-before: >8 End of configuration of the number of queues for a port.
    :dedent: 2

.. _l2_fwd_app_rx_init:

RX Queue Initialization
~~~~~~~~~~~~~~~~~~~~~~~

The application uses one lcore to poll one or several ports, depending on the -q option,
which specifies the number of queues per lcore.

For example, if the user specifies -q 4, the application is able to poll four ports with one lcore.
If there are 16 ports on the target (and if the portmask argument is -p ffff ),
the application will need four lcores to poll all the ports.

.. literalinclude:: ../../../examples/l2fwd/main.c
    :language: c
    :start-after: RX queue setup. 8<
    :end-before: >8 End of RX queue setup.
    :dedent: 2

The list of queues that must be polled for a given lcore is stored in a private structure called struct lcore_queue_conf.

.. literalinclude:: ../../../examples/l2fwd/main.c
    :language: c
    :start-after: List of queues to be polled for a given lcore. 8<
    :end-before: >8 End of list of queues to be polled for a given lcore.

The values n_rx_port and rx_port_list[] are used in the main packet processing loop
(see :ref:`l2_fwd_app_rx_tx_packets`).

.. _l2_fwd_app_tx_init:

TX Queue Initialization
~~~~~~~~~~~~~~~~~~~~~~~

Each lcore should be able to transmit on any port. For every port, a single TX queue is initialized.

.. literalinclude:: ../../../examples/l2fwd/main.c
    :language: c
    :start-after: Init one TX queue on each port. 8<
    :end-before: >8 End of init one TX queue on each port.
    :dedent: 2

.. _l2_fwd_app_rx_tx_packets:

Receive, Process and Transmit Packets
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In the l2fwd_main_loop() function, the main task is to read ingress packets from the RX queues.
This is done using the following code:

.. literalinclude:: ../../../examples/l2fwd/main.c
    :language: c
    :start-after: Read packet from RX queues. 8<
    :end-before: >8 End of read packet from RX queues.
    :dedent: 2

Packets are read in a burst of size MAX_PKT_BURST.
The rte_eth_rx_burst() function writes the mbuf pointers in a local table and returns the number of available mbufs in the table.

Then, each mbuf in the table is processed by the l2fwd_simple_forward() function.
The processing is very simple: process the TX port from the RX port, then replace the source and destination MAC addresses if MAC
addresses updating is enabled.

.. note::

    In the following code, one line for getting the output port requires some explanation.

During the initialization process, a static array of destination ports (l2fwd_dst_ports[]) is filled such that for each source port,
a destination port is assigned that is either the next or previous enabled port from the portmask.
Naturally, the number of ports in the portmask must be even, otherwise, the application exits.

.. literalinclude:: ../../../examples/l2fwd/main.c
    :language: c
    :start-after: Simple forward. 8<
    :end-before: >8 End of simple forward.


Then, the packet is sent using the l2fwd_send_packet (m, dst_port) function.
For this test application, the processing is exactly the same for all packets arriving on the same RX port.
Therefore, it would have been possible to call the l2fwd_send_burst() function directly from the main loop
to send all the received packets on the same TX port,
using the burst-oriented send function, which is more efficient.

However, in real-life applications (such as, L3 routing),
packet N is not necessarily forwarded on the same port as packet N-1.
The application is implemented to illustrate that, so the same approach can be reused in a more complex application.

The l2fwd_send_packet() function stores the packet in a per-lcore and per-txport table.
If the table is full, the whole packets table is transmitted using the l2fwd_send_burst() function:

.. literalinclude:: ../../../examples/l2fwd-crypto/main.c
    :language: c
    :start-after: Enqueue packets for TX and prepare them to be sent. 8<
    :end-before: >8 End of Enqueuing packets for TX.

To ensure that no packets remain in the tables, each lcore does a draining of TX queue in its main loop.
This technique introduces some latency when there are not many packets to send,
however it improves performance:

.. literalinclude:: ../../../examples/l2fwd/main.c
    :language: c
    :start-after: Drains TX queue in its main loop. 8<
    :end-before: >8 End of draining TX queue.
    :dedent: 2