8c9a33744b
This change adds automatic table references to the docs. The table numbers in the generated Html and PDF docs are now automatically numbered based on section. Requires Sphinx >= 1.3.1. This change: * Adds a RST table:: directive to each table caption. * Indents the tables to the required directive level. Signed-off-by: John McNamara <john.mcnamara@intel.com>
199 lines
7.4 KiB
ReStructuredText
199 lines
7.4 KiB
ReStructuredText
.. BSD LICENSE
|
|
Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
|
|
All rights reserved.
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions
|
|
are met:
|
|
|
|
* Redistributions of source code must retain the above copyright
|
|
notice, this list of conditions and the following disclaimer.
|
|
* Redistributions in binary form must reproduce the above copyright
|
|
notice, this list of conditions and the following disclaimer in
|
|
the documentation and/or other materials provided with the
|
|
distribution.
|
|
* Neither the name of Intel Corporation nor the names of its
|
|
contributors may be used to endorse or promote products derived
|
|
from this software without specific prior written permission.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
QoS Metering Sample Application
|
|
===============================
|
|
|
|
The QoS meter sample application is an example that demonstrates the use of DPDK to provide QoS marking and metering,
|
|
as defined by RFC2697 for Single Rate Three Color Marker (srTCM) and RFC 2698 for Two Rate Three Color Marker (trTCM) algorithm.
|
|
|
|
Overview
|
|
--------
|
|
|
|
The application uses a single thread for reading the packets from the RX port,
|
|
metering, marking them with the appropriate color (green, yellow or red) and writing them to the TX port.
|
|
|
|
A policing scheme can be applied before writing the packets to the TX port by dropping or
|
|
changing the color of the packet in a static manner depending on both the input and output colors of the packets that are processed by the meter.
|
|
|
|
The operation mode can be selected as compile time out of the following options:
|
|
|
|
* Simple forwarding
|
|
|
|
* srTCM color blind
|
|
|
|
* srTCM color aware
|
|
|
|
* srTCM color blind
|
|
|
|
* srTCM color aware
|
|
|
|
Please refer to RFC2697 and RFC2698 for details about the srTCM and trTCM configurable parameters
|
|
(CIR, CBS and EBS for srTCM; CIR, PIR, CBS and PBS for trTCM).
|
|
|
|
The color blind modes are functionally equivalent with the color-aware modes when
|
|
all the incoming packets are colored as green.
|
|
|
|
Compiling the Application
|
|
-------------------------
|
|
|
|
#. Go to the example directory:
|
|
|
|
.. code-block:: console
|
|
|
|
export RTE_SDK=/path/to/rte_sdk
|
|
cd ${RTE_SDK}/examples/qos_meter
|
|
|
|
#. Set the target
|
|
(a default target is used if not specified):
|
|
|
|
.. note::
|
|
|
|
This application is intended as a linuxapp only.
|
|
|
|
.. code-block:: console
|
|
|
|
export RTE_TARGET=x86_64-native-linuxapp-gcc
|
|
|
|
#. Build the application:
|
|
|
|
.. code-block:: console
|
|
|
|
make
|
|
|
|
Running the Application
|
|
-----------------------
|
|
|
|
The application execution command line is as below:
|
|
|
|
.. code-block:: console
|
|
|
|
./qos_meter [EAL options] -- -p PORTMASK
|
|
|
|
The application is constrained to use a single core in the EAL core mask and 2 ports only in the application port mask
|
|
(first port from the port mask is used for RX and the other port in the core mask is used for TX).
|
|
|
|
Refer to *DPDK Getting Started Guide* for general information on running applications and
|
|
the Environment Abstraction Layer (EAL) options.
|
|
|
|
Explanation
|
|
-----------
|
|
|
|
Selecting one of the metering modes is done with these defines:
|
|
|
|
.. code-block:: c
|
|
|
|
#define APP_MODE_FWD 0
|
|
#define APP_MODE_SRTCM_COLOR_BLIND 1
|
|
#define APP_MODE_SRTCM_COLOR_AWARE 2
|
|
#define APP_MODE_TRTCM_COLOR_BLIND 3
|
|
#define APP_MODE_TRTCM_COLOR_AWARE 4
|
|
|
|
#define APP_MODE APP_MODE_SRTCM_COLOR_BLIND
|
|
|
|
To simplify debugging (for example, by using the traffic generator RX side MAC address based packet filtering feature),
|
|
the color is defined as the LSB byte of the destination MAC address.
|
|
|
|
The traffic meter parameters are configured in the application source code with following default values:
|
|
|
|
.. code-block:: c
|
|
|
|
struct rte_meter_srtcm_params app_srtcm_params[] = {
|
|
|
|
{.cir = 1000000 * 46, .cbs = 2048, .ebs = 2048},
|
|
|
|
};
|
|
|
|
struct rte_meter_trtcm_params app_trtcm_params[] = {
|
|
|
|
{.cir = 1000000 * 46, .pir = 1500000 * 46, .cbs = 2048, .pbs = 2048},
|
|
|
|
};
|
|
|
|
Assuming the input traffic is generated at line rate and all packets are 64 bytes Ethernet frames (IPv4 packet size of 46 bytes)
|
|
and green, the expected output traffic should be marked as shown in the following table:
|
|
|
|
.. _table_qos_metering_1:
|
|
|
|
.. table:: Output Traffic Marking
|
|
|
|
+-------------+------------------+-------------------+----------------+
|
|
| **Mode** | **Green (Mpps)** | **Yellow (Mpps)** | **Red (Mpps)** |
|
|
| | | | |
|
|
+=============+==================+===================+================+
|
|
| srTCM blind | 1 | 1 | 12.88 |
|
|
| | | | |
|
|
+-------------+------------------+-------------------+----------------+
|
|
| srTCM color | 1 | 1 | 12.88 |
|
|
| | | | |
|
|
+-------------+------------------+-------------------+----------------+
|
|
| trTCM blind | 1 | 0.5 | 13.38 |
|
|
| | | | |
|
|
+-------------+------------------+-------------------+----------------+
|
|
| trTCM color | 1 | 0.5 | 13.38 |
|
|
| | | | |
|
|
+-------------+------------------+-------------------+----------------+
|
|
| FWD | 14.88 | 0 | 0 |
|
|
| | | | |
|
|
+-------------+------------------+-------------------+----------------+
|
|
|
|
To set up the policing scheme as desired, it is necessary to modify the main.h source file,
|
|
where this policy is implemented as a static structure, as follows:
|
|
|
|
.. code-block:: c
|
|
|
|
int policer_table[e_RTE_METER_COLORS][e_RTE_METER_COLORS] =
|
|
{
|
|
{ GREEN, RED, RED},
|
|
{ DROP, YELLOW, RED},
|
|
{ DROP, DROP, RED}
|
|
};
|
|
|
|
Where rows indicate the input color, columns indicate the output color,
|
|
and the value that is stored in the table indicates the action to be taken for that particular case.
|
|
|
|
There are four different actions:
|
|
|
|
* GREEN: The packet's color is changed to green.
|
|
|
|
* YELLOW: The packet's color is changed to yellow.
|
|
|
|
* RED: The packet's color is changed to red.
|
|
|
|
* DROP: The packet is dropped.
|
|
|
|
In this particular case:
|
|
|
|
* Every packet which input and output color are the same, keeps the same color.
|
|
|
|
* Every packet which color has improved is dropped (this particular case can't happen, so these values will not be used).
|
|
|
|
* For the rest of the cases, the color is changed to red.
|