X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fprog_guide%2Ftraffic_metering_and_policing.rst;h=c0537e653c0469cf684bbf133407ef9c5183fb01;hb=81ce0906ea2a8c496dcad30c87aecdd8db95e0ea;hp=89f0e68bb72fff5cb7101a539cf3c8f1248ad348;hpb=5bf4bebb093bf59f90d29f4ed83a4703682d7f14;p=dpdk.git diff --git a/doc/guides/prog_guide/traffic_metering_and_policing.rst b/doc/guides/prog_guide/traffic_metering_and_policing.rst index 89f0e68bb7..c0537e653c 100644 --- a/doc/guides/prog_guide/traffic_metering_and_policing.rst +++ b/doc/guides/prog_guide/traffic_metering_and_policing.rst @@ -1,33 +1,5 @@ -.. BSD LICENSE - Copyright(c) 2017 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. - +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2017 Intel Corporation. Traffic Metering and Policing API ================================= @@ -56,7 +28,7 @@ The metering and policing stage typically sits on top of flow classification, which is why the MTR objects are enabled through a special "meter" action. The MTR objects are created and updated in their own name space (``rte_mtr``) -within the ``librte_ether`` library. Whether an MTR object is private to a +within the ``librte_ethdev`` library. Whether an MTR object is private to a flow or potentially shared by several flows has to be specified at its creation time. @@ -84,18 +56,10 @@ The processing done for each input packet hitting an MTR object is: color blind mode, which is equivalent to considering all input packets initially colored as green. -* Policing: There is a separate policer action configured for each meter - output color, which can: - - * Drop the packet. - - * Keep the same packet color: the policer output color matches the meter - output color (essentially a no-op action). - - * Recolor the packet: the policer output color is set to a different color - than the meter output color. The policer output color is the output color - of the packet, which is set in the packet meta-data (i.e. struct - ``rte_mbuf::sched::color``). +* There is a meter policy API to manage pre-defined policies for meter. + Any rte_flow action list can be configured per color for each policy. + A meter object configured with a policy executes the actions per packet + according to the packet color. * Statistics: The set of counters maintained for each MTR object is configurable and subject to the implementation support. This set includes