d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

net/mvpp2: document MTR and TM usage

Browse Source 
Document MTR (metering) and TM (traffic management) usage plus
do some small updates here and there.

Signed-off-by: Natalie Samsonov <nsamsono@marvell.com>
This commit is contained in:
Natalie Samsonov 2018-09-25 09:05:08 +02:00 committed by Ferruh Yigit
parent e04ec42af0
commit 0ba610ca1d
2 changed files with 406 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
doc/guides/nics/img/mvpp2_tm.svg Normal file
View File

@ -0,0 +1,71 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN" "http://www.w3.org/TR/2001/PR-SVG-20010719/DTD/svg10.dtd">
<svg width="16cm" height="4cm" viewBox="-1 -1 309 75" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g>
<polyline style="fill: none; fill-opacity:0; stroke-width: 1; stroke: #000000" points="159.661,12.6759 141.655,12.6759 141.655,35.5606 88.1561,35.5606 88.1561,44.9245 "/>
<polygon style="fill: #000000" points="88.1561,49.4245 85.1561,43.4245 88.1561,44.9245 91.1561,43.4245 "/>
<polygon style="fill: none; fill-opacity:0; stroke-width: 1; stroke: #000000" points="88.1561,49.4245 85.1561,43.4245 88.1561,44.9245 91.1561,43.4245 "/>
</g>
<g>
<polyline style="fill: none; fill-opacity:0; stroke-width: 1; stroke: #000000" points="159.661,12.6759 176.28,12.6759 176.28,35.5606 281.681,35.5606 281.681,44.9245 "/>
<polygon style="fill: #000000" points="281.681,49.4245 278.681,43.4245 281.681,44.9245 284.681,43.4245 "/>
<polygon style="fill: none; fill-opacity:0; stroke-width: 1; stroke: #000000" points="281.681,49.4245 278.681,43.4245 281.681,44.9245 284.681,43.4245 "/>
</g>
<g>
<rect style="fill: #ffffff" x="126.066" y="0.98102" width="67.1901" height="23.3899"/>
<rect style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" x="126.066" y="0.98102" width="67.1901" height="23.3899"/>
</g>
<text font-size="12.7998" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="159.661" y="17.1259">
<tspan x="159.661" y="17.1259">Port N</tspan>
</text>
<text font-size="12.7998" style="fill: #000000;text-anchor:start;font-family:sans-serif;font-style:normal;font-weight:normal" x="304.581" y="68.168">
<tspan x="304.581" y="68.168"></tspan>
</text>
<g>
<rect style="fill: #ffffff" x="62.5504" y="51.5478" width="51.2114" height="22.0925"/>
<rect style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" x="62.5504" y="51.5478" width="51.2114" height="22.0925"/>
</g>
<text font-size="12.7998" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="88.1561" y="67.044">
<tspan x="88.1561" y="67.044">Txq 0</tspan>
</text>
<g>
<rect style="fill: #ffffff" x="134.1" y="51.355" width="51.1213" height="22.478"/>
<rect style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" x="134.1" y="51.355" width="51.1213" height="22.478"/>
</g>
<text font-size="12.7998" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="159.661" y="67.044">
<tspan x="159.661" y="67.044">Txq 1</tspan>
</text>
<g>
<rect style="fill: #ffffff" x="256.416" y="51.5478" width="50.5306" height="22.0925"/>
<rect style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" x="256.416" y="51.5478" width="50.5306" height="22.0925"/>
</g>
<text font-size="12.7998" style="fill: #000000;text-anchor:middle;font-family:sans-serif;font-style:normal;font-weight:normal" x="281.681" y="67.044">
<tspan x="281.681" y="67.044">Txq M</tspan>
</text>
<text font-size="12.7998" style="fill: #000000;text-anchor:start;font-family:sans-serif;font-style:normal;font-weight:normal" x="101.822" y="67.044">
<tspan x="101.822" y="67.044"></tspan>
</text>
<text font-size="12.7998" style="fill: #000000;text-anchor:start;font-family:sans-serif;font-style:normal;font-weight:normal" x="-0.537645" y="17.1259">
<tspan x="-0.537645" y="17.1259">Level 0:</tspan>
</text>
<text font-size="12.7998" style="fill: #000000;text-anchor:start;font-family:sans-serif;font-style:normal;font-weight:normal" x="-0.746688" y="67.044">
<tspan x="-0.746688" y="67.044">Level 1:</tspan>
</text>
<g>
<ellipse style="fill: #000000" cx="207.645" cy="62.594" rx="0.425344" ry="0.425344"/>
<ellipse style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" cx="207.645" cy="62.594" rx="0.425344" ry="0.425344"/>
</g>
<g>
<ellipse style="fill: #000000" cx="219.525" cy="62.594" rx="0.425344" ry="0.425344"/>
<ellipse style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" cx="219.525" cy="62.594" rx="0.425344" ry="0.425344"/>
</g>
<g>
<ellipse style="fill: #000000" cx="231.405" cy="62.594" rx="0.425345" ry="0.425345"/>
<ellipse style="fill: none; fill-opacity:0; stroke-width: 2; stroke: #000000" cx="231.405" cy="62.594" rx="0.425345" ry="0.425345"/>
</g>
<g>
<line style="fill: none; fill-opacity:0; stroke-width: 1; stroke: #000000" x1="159.661" y1="24.3709" x2="159.661" y2="45.737"/>
<polygon style="fill: #000000" points="159.661,50.237 156.661,44.237 159.661,45.737 162.661,44.237 "/>
<polygon style="fill: none; fill-opacity:0; stroke-width: 1; stroke: #000000" points="159.661,50.237 156.661,44.237 159.661,45.737 162.661,44.237 "/>
</g>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 4.9 KiB

386
doc/guides/nics/mvpp2.rst
View File

@ -56,7 +56,7 @@ Features of the MVPP2 PMD are:
- Speed capabilities
- Link status
- Queue start/stop
- Tx Queue start/stop
- MTU update
- Jumbo frame
- Promiscuous mode
@ -70,12 +70,13 @@ Features of the MVPP2 PMD are:
- L4 checksum offload
- Packet type parsing
- Basic stats
- Extended stats
- QoS
- :ref:`Extended stats <extstats>`
- RX flow control
- TX queue start/stop
- Scattered TX frames
- :ref:`QoS <qossupport>`
- :ref:`Flow API <flowapi>`
- :ref:`Traffic metering and policing <mtrapi>`
- :ref:`Traffic Management API <tmapi>`
Limitations
-----------
@ -89,6 +90,20 @@ Limitations
functionality. Current workaround is to reset board so that PPv2 has a
chance to start in a sane state.
- MUSDK architecture does not support changing configuration in run time.
All nessesary configurations should be done before first dev_start().
- RX queue start/stop is not supported.
- Current implementation does not support replacement of buffers in the HW buffer pool
at run time, so it is responsibility of the application to ensure that MTU does not exceed the configured buffer size.
- Configuring TX flow control currently is not supported.
- In current implementation, mechanism for acknowledging transmitted packets (``tx_done_cleanup``) is not supported.
- Running more than one DPDK-MUSDK application simultaneously is not supported.
Prerequisites
-------------
@ -139,6 +154,92 @@ The following options can be modified in the ``config`` file.
When MVPP2 PMD is enabled ``CONFIG_RTE_LIBRTE_MVNETA_PMD`` must be disabled
Building DPDK
-------------
Driver needs precompiled MUSDK library during compilation.
.. code-block:: console
export CROSS_COMPILE=<toolchain>/bin/aarch64-linux-gnu-
./bootstrap
./configure --host=aarch64-linux-gnu
make install
MUSDK will be installed to `usr/local` under current directory.
For the detailed build instructions please consult ``doc/musdk_get_started.txt``.
Before the DPDK build process the environmental variable ``LIBMUSDK_PATH`` with
the path to the MUSDK installation directory needs to be exported.
For additional instructions regarding DPDK cross compilation please refer to :doc:`Cross compile DPDK for ARM64 <../linux_gsg/cross_build_dpdk_for_arm64>`.
.. code-block:: console
export LIBMUSDK_PATH=<musdk>/usr/local
export CROSS=<toolchain>/bin/aarch64-linux-gnu-
export RTE_KERNELDIR=<kernel-dir>
export RTE_TARGET=arm64-armv8a-linuxapp-gcc
make config T=arm64-armv8a-linuxapp-gcc
sed -i "s/MVNETA_PMD=y/MVNETA_PMD=n/" build/.config
sed -i "s/MVPP2_PMD=n/MVPP2_PMD=y/" build/.config
make
Usage Example
-------------
MVPP2 PMD requires extra out of tree kernel modules to function properly.
`musdk_cma` sources are part of the MUSDK. Please consult
``doc/musdk_get_started.txt`` for the detailed build instructions.
For `mvpp2x_sysfs` please consult ``Documentation/pp22_sysfs.txt`` for the
detailed build instructions.
.. code-block:: console
insmod musdk_cma.ko
insmod mvpp2x_sysfs.ko
Additionally interfaces used by DPDK application need to be put up:
.. code-block:: console
ip link set eth0 up
ip link set eth2 up
In order to run testpmd example application following command can be used:
.. code-block:: console
./testpmd --vdev=eth_mvpp2,iface=eth0,iface=eth2 -c 7 -- \
--burst=128 --txd=2048 --rxd=1024 --rxq=2 --txq=2 --nb-cores=2 \
-i -a --rss-udp
.. _extstats:
Extended stats
--------------
MVPP2 PMD supports the following extended statistics:
- ``rx_bytes``: number of RX bytes
- ``rx_packets``: number of RX packets
- ``rx_unicast_packets``: number of RX unicast packets
- ``rx_errors``: number of RX MAC errors
- ``rx_fullq_dropped``: number of RX packets dropped due to full RX queue
- ``rx_bm_dropped``: number of RX packets dropped due to no available buffers in the HW pool
- ``rx_early_dropped``: number of RX packets that were early dropped
- ``rx_fifo_dropped``: number of RX packets dropped due to RX fifo overrun
- ``rx_cls_dropped``: number of RX packets dropped by classifier
- ``tx_bytes``: number of TX bytes
- ``tx_packets``: number of TX packets
- ``tx_unicast_packets``: number of TX unicast packets
- ``tx_errors``: number of TX MAC errors
.. _qossupport:
QoS Configuration
-----------------
@ -302,39 +403,14 @@ Usage example
./testpmd --vdev=eth_mvpp2,iface=eth0,iface=eth2,cfg=/home/user/mrvl.conf \
-c 7 -- -i -a --disable-hw-vlan-strip --rxq=3 --txq=3
Building DPDK
-------------
Driver needs precompiled MUSDK library during compilation.
.. code-block:: console
export CROSS_COMPILE=<toolchain>/bin/aarch64-linux-gnu-
./bootstrap
./configure --host=aarch64-linux-gnu
make install
MUSDK will be installed to `usr/local` under current directory.
For the detailed build instructions please consult ``doc/musdk_get_started.txt``.
Before the DPDK build process the environmental variable ``LIBMUSDK_PATH`` with
the path to the MUSDK installation directory needs to be exported.
.. code-block:: console
export LIBMUSDK_PATH=<musdk>/usr/local
export CROSS=aarch64-linux-gnu-
make config T=arm64-armv8a-linuxapp-gcc
sed -i "s/MVNETA_PMD=y/MVNETA_PMD=n/" build/.config
sed -i "s/MVPP2_PMD=n/MVPP2_PMD=y/" build/.config
make
.. _flowapi:
Flow API
--------
PPv2 offers packet classification capabilities via classifier engine which
can be configured via generic flow API offered by DPDK.
For an additional description please refer to DPDK :ref:`Generic flow API <Generic_flow_API>`.
Supported flow actions
~~~~~~~~~~~~~~~~~~~~~~
@ -495,31 +571,239 @@ Following limitations need to be taken into account while creating flow rules:
For additional information about classifier please consult
``doc/musdk_cls_user_guide.txt``.
Usage Example
-------------
.. _mtrapi:
MVPP2 PMD requires extra out of tree kernel modules to function properly.
`musdk_cma` sources are part of the MUSDK. Please consult
``doc/musdk_get_started.txt`` for the detailed build instructions.
For `mvpp2x_sysfs` please consult ``Documentation/pp22_sysfs.txt`` for the
detailed build instructions.
Traffic metering and policing
-----------------------------
.. code-block:: console
MVPP2 PMD supports DPDK traffic metering and policing that allows the following:
insmod musdk_cma.ko
insmod mvpp2x_sysfs.ko
1. Meter ingress traffic.
2. Do policing.
3. Gather statistics.
Additionally interfaces used by DPDK application need to be put up:
For an additional description please refer to DPDK :doc:`Traffic Metering and Policing API <../prog_guide/traffic_metering_and_policing>`.
.. code-block:: console
The policer objects defined by this feature can work with the default policer defined via config file as discribed in :ref:`QoS Support <qossupport>`.
ip link set eth0 up
ip link set eth2 up
Limitations
~~~~~~~~~~~
In order to run testpmd example application following command can be used:
The following capabilities are not supported:
.. code-block:: console
- MTR object meter DSCP table update
- MTR object policer action update
- MTR object enabled statistics
./testpmd --vdev=eth_mvpp2,iface=eth0,iface=eth2 -c 7 -- \
--burst=128 --txd=2048 --rxd=1024 --rxq=2 --txq=2 --nb-cores=2 \
-i -a --rss-udp
Usage example
~~~~~~~~~~~~~
1. Run testpmd user app:
.. code-block:: console
./testpmd --vdev=eth_mvpp2,iface=eth0,iface=eth2 -c 6 -- -i -p 3 -a --txd 1024 --rxd 1024
2. Create meter profile:
.. code-block:: console
testpmd> add port meter profile 0 0 srtcm_rfc2697 2000 256 256
3. Create meter:
.. code-block:: console
testpmd> create port meter 0 0 0 yes d d d 0 1 0
4. Create flow rule witch meter attached:
.. code-block:: console
testpmd> flow create 0 ingress pattern ipv4 src is 10.10.10.1 / end actions meter mtr_id 0 / end
For a detailed usage description please refer to "Traffic Metering and Policing" section in DPDK :doc:`Testpmd Runtime Functions <../testpmd_app_ug/testpmd_funcs>`.
.. _tmapi:
Traffic Management API
----------------------
MVPP2 PMD supports generic DPDK Traffic Management API which allows to
configure the following features:
1. Hierarchical scheduling
2. Traffic shaping
3. Congestion management
4. Packet marking
Internally TM is represented by a hierarchy (tree) of nodes.
Node which has a parent is called a leaf whereas node without
parent is called a non-leaf (root).
MVPP2 PMD supports two level hierarchy where level 0 represents ports and level 1 represents tx queues of a given port.
.. figure:: img/mvpp2_tm.svg
Nodes hold following types of settings:
- for egress scheduler configuration: weight
- for egress rate limiter: private shaper
- bitmask indicating which statistics counters will be read
Hierarchy is always constructed from the top, i.e first a root node is added
then some number of leaf nodes. Number of leaf nodes cannot exceed number
of configured tx queues.
After hierarchy is complete it can be committed.
For an additional description please refer to DPDK :doc:`Traffic Management API <../prog_guide/traffic_management>`.
Limitations
~~~~~~~~~~~
The following capabilities are not supported:
- Traffic manager WRED profile and WRED context
- Traffic manager shared shaper update
- Traffic manager packet marking
- Maximum number of levels in hierarchy is 2
- Currently dynamic change of a hierarchy is not supported
Usage example
~~~~~~~~~~~~~
For a detailed usage description please refer to "Traffic Management" section in DPDK :doc:`Testpmd Runtime Functions <../testpmd_app_ug/testpmd_funcs>`.
1. Run testpmd as follows:
.. code-block:: console
./testpmd --vdev=net_mrvl,iface=eth0,iface=eth2,cfg=./qos_config -c 7 -- \
-i -p 3 --disable-hw-vlan-strip --rxq 3 --txq 3 --txd 1024 --rxd 1024
2. Stop all ports:
.. code-block:: console
testpmd> port stop all
3. Add shaper profile:
.. code-block:: console
testpmd> add port tm node shaper profile 0 0 900000 70000 0
Parameters have following meaning::
0 - Id of a port.
0 - Id of a new shaper profile.
900000 - Shaper rate in bytes/s.
70000 - Bucket size in bytes.
0 - Packet length adjustment - ignored.
4. Add non-leaf node for port 0:
.. code-block:: console
testpmd> add port tm nonleaf node 0 3 -1 0 0 0 0 0 1 3 0
Parameters have following meaning::
0 - Id of a port
3 - Id of a new node.
-1 - Indicate that root does not have a parent.
0 - Priority of the node.
0 - Weight of the node.
0 - Id of a level. Since this is a root 0 is passed.
0 - Id of the shaper profile.
0 - Number of SP priorities.
3 - Enable statistics for both number of transmitted packets and bytes.
0 - Number of shared shapers.
5. Add leaf node for tx queue 0:
.. code-block:: console
testpmd> add port tm leaf node 0 0 3 0 30 1 -1 0 0 1 0
Parameters have following meaning::
0 - Id of a port.
0 - Id of a new node.
3 - Id of the parent node.
0 - Priority of a node.
30 - WRR weight.
1 - Id of a level. Since this is a leaf node 1 is passed.
-1 - Id of a shaper. -1 indicates that shaper is not attached.
0 - Congestion management is not supported.
0 - Congestion management is not supported.
1 - Enable statistics counter for number of transmitted packets.
0 - Number of shared shapers.
6. Add leaf node for tx queue 1:
.. code-block:: console
testpmd> add port tm leaf node 0 1 3 0 60 1 -1 0 0 1 0
Parameters have following meaning::
0 - Id of a port.
1 - Id of a new node.
3 - Id of the parent node.
0 - Priority of a node.
60 - WRR weight.
1 - Id of a level. Since this is a leaf node 1 is passed.
-1 - Id of a shaper. -1 indicates that shaper is not attached.
0 - Congestion management is not supported.
0 - Congestion management is not supported.
1 - Enable statistics counter for number of transmitted packets.
0 - Number of shared shapers.
7. Add leaf node for tx queue 2:
.. code-block:: console
testpmd> add port tm leaf node 0 2 3 0 99 1 -1 0 0 1 0
Parameters have following meaning::
0 - Id of a port.
2 - Id of a new node.
3 - Id of the parent node.
0 - Priority of a node.
99 - WRR weight.
1 - Id of a level. Since this is a leaf node 1 is passed.
-1 - Id of a shaper. -1 indicates that shaper is not attached.
0 - Congestion management is not supported.
0 - Congestion management is not supported.
1 - Enable statistics counter for number of transmitted packets.
0 - Number of shared shapers.
8. Commit hierarchy:
.. code-block:: console
testpmd> port tm hierarchy commit 0 no
Parameters have following meaning::
0 - Id of a port.
no - Do not flush TM hierarchy if commit fails.
9. Start all ports
.. code-block:: console
testpmd> port start all
10. Enable forwarding
.. code-block:: console
testpmd> start