path: root/doc/api
diff options
authorCristian Dumitrescu <>2017-10-13 13:22:16 +0100
committerCristian Dumitrescu <>2017-10-20 14:09:28 +0200
commit6613ffe1382b416836017fdae7e30a7087e3d240 (patch)
tree495294947814352f8298c15870261f0b63932613 /doc/api
parent10f32b0f4ebc06000d1cbc14c1b95f8acc5c62ec (diff)
ethdev: add API for traffic metering and policing
This patch introduces new ethdev generic API for Traffic Metering and Policing (MTR), which is yet another standard RX offload for Ethernet devices. Similar to rte_flow and rte_tm APIs, the configuration of MTR objects is done in their own namespace (rte_mtr) within the librte_ether library. Main features: 1. Traffic metering: determine the color for the current packet (green, yellow, red) based on history maintained by the MTR object. Supported algorithms: srTCM (RFC 2697), trTCM (RFC 2698 and RFC 4115). 2. Policing (per meter output color actions): re-color the packet (keep or change the meter output color) or drop the packet. 3. Statistics 4. Capability API Signed-off-by: Cristian Dumitrescu <> Acked-by: Hemant Agrawal <> Acked-by: Jerin Jacob <>
Diffstat (limited to 'doc/api')
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/api/ b/doc/api/
index 990815f..07d6f4a 100644
--- a/doc/api/
+++ b/doc/api/
@@ -41,6 +41,7 @@ The public API headers are grouped by topics:
[ethctrl] (@ref rte_eth_ctrl.h),
[rte_flow] (@ref rte_flow.h),
[rte_tm] (@ref rte_tm.h),
+ [rte_mtr] (@ref rte_mtr.h),
[cryptodev] (@ref rte_cryptodev.h),
[eventdev] (@ref rte_eventdev.h),
[event_eth_rx_adapter] (@ref rte_event_eth_rx_adapter.h),