X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=lib%2Flibrte_ethdev%2Frte_tm.h;h=175417a15f89a0fa9a1f0e5a45eca2366bfcf2d5;hb=b4cfffaa85ecfac2035eee26fa48167fdcefd678;hp=03eaa0004099894da3c165e0d7d357672cefcac9;hpb=8bd5f07c7a1ac0c5b8d16758efc3ada3e16b0adc;p=dpdk.git diff --git a/lib/librte_ethdev/rte_tm.h b/lib/librte_ethdev/rte_tm.h index 03eaa00040..175417a15f 100644 --- a/lib/librte_ethdev/rte_tm.h +++ b/lib/librte_ethdev/rte_tm.h @@ -1,36 +1,7 @@ -/*- - * BSD LICENSE - * - * Copyright(c) 2017 Intel Corporation. - * Copyright(c) 2017 Cavium. - * Copyright(c) 2017 NXP. - * 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. + * Copyright(c) 2017 Cavium. + * Copyright(c) 2017 NXP. */ #ifndef __INCLUDE_RTE_TM_H__ @@ -45,7 +16,8 @@ * traffic shaping, congestion management, packet marking, etc. * * @warning - * @b EXPERIMENTAL: this API may change without prior notice + * @b EXPERIMENTAL: + * All functions in this file may be changed or removed without prior notice. */ #include @@ -279,6 +251,23 @@ struct rte_tm_capabilities { */ uint64_t shaper_private_rate_max; + /** Shaper private packet mode supported. When non-zero, this parameter + * indicates that there is at least one node that can be configured + * with packet mode in its private shaper. When shaper is configured + * in packet mode, committed/peak rate provided is interpreted + * in packets per second. + */ + int shaper_private_packet_mode_supported; + + /** Shaper private byte mode supported. When non-zero, this parameter + * indicates that there is at least one node that can be configured + * with byte mode in its private shaper. When shaper is configured + * in byte mode, committed/peak rate provided is interpreted in + * bytes per second. + */ + int shaper_private_byte_mode_supported; + + /** Maximum number of shared shapers. The value of zero indicates that * shared shapers are not supported. */ @@ -313,6 +302,21 @@ struct rte_tm_capabilities { */ uint64_t shaper_shared_rate_max; + /** Shaper shared packet mode supported. When non-zero, this parameter + * indicates a shared shaper can be configured with packet mode. + * When shared shaper is configured in packet mode, committed/peak rate + * provided is interpreted in packets per second. + */ + int shaper_shared_packet_mode_supported; + + /** Shaper shared byte mode supported. When non-zero, this parameter + * indicates that a shared shaper can be configured with byte mode. + * When shared shaper is configured in byte mode, committed/peak rate + * provided is interpreted in bytes per second. + */ + int shaper_shared_byte_mode_supported; + + /** Minimum value allowed for packet length adjustment for any private * or shared shaper. */ @@ -368,6 +372,22 @@ struct rte_tm_capabilities { */ uint32_t sched_wfq_weight_max; + /** WFQ packet mode supported. When non-zero, this parameter indicates + * that there is at least one non-leaf node that supports packet mode + * for WFQ among its children. WFQ weights will be applied against + * packet count for scheduling children when a non-leaf node + * is configured appropriately. + */ + int sched_wfq_packet_mode_supported; + + /** WFQ byte mode supported. When non-zero, this parameter indicates + * that there is at least one non-leaf node that supports byte mode + * for WFQ among its children. WFQ weights will be applied against + * bytes for scheduling children when a non-leaf node is configured + * appropriately. + */ + int sched_wfq_byte_mode_supported; + /** WRED packet mode support. When non-zero, this parameter indicates * that there is at least one leaf node that supports the WRED packet * mode, which might not be true for all the leaf nodes. In packet @@ -514,6 +534,24 @@ struct rte_tm_level_capabilities { */ uint64_t shaper_private_rate_max; + /** Shaper private packet mode supported. When non-zero, + * this parameter indicates there is at least one + * non-leaf node at this level that can be configured + * with packet mode in its private shaper. When private + * shaper is configured in packet mode, committed/peak + * rate provided is interpreted in packets per second. + */ + int shaper_private_packet_mode_supported; + + /** Shaper private byte mode supported. When non-zero, + * this parameter indicates there is at least one + * non-leaf node at this level that can be configured + * with byte mode in its private shaper. When private + * shaper is configured in byte mode, committed/peak + * rate provided is interpreted in bytes per second. + */ + int shaper_private_byte_mode_supported; + /** Maximum number of shared shapers that any non-leaf * node on this level can be part of. The value of zero * indicates that shared shapers are not supported by @@ -524,6 +562,20 @@ struct rte_tm_level_capabilities { */ uint32_t shaper_shared_n_max; + /** Shaper shared packet mode supported. When non-zero, + * this parameter indicates that there is at least one + * non-leaf node on this level that can be part of + * shared shapers which work in packet mode. + */ + int shaper_shared_packet_mode_supported; + + /** Shaper shared byte mode supported. When non-zero, + * this parameter indicates that there is at least one + * non-leaf node on this level that can be part of + * shared shapers which work in byte mode. + */ + int shaper_shared_byte_mode_supported; + /** Maximum number of children nodes. This parameter * indicates that there is at least one non-leaf node on * this level that can be configured with this many @@ -583,6 +635,25 @@ struct rte_tm_level_capabilities { */ uint32_t sched_wfq_weight_max; + /** WFQ packet mode supported. When non-zero, this + * parameter indicates that there is at least one + * non-leaf node at this level that supports packet + * mode for WFQ among its children. WFQ weights will + * be applied against packet count for scheduling + * children when a non-leaf node is configured + * appropriately. + */ + int sched_wfq_packet_mode_supported; + + /** WFQ byte mode supported. When non-zero, this + * parameter indicates that there is at least one + * non-leaf node at this level that supports byte + * mode for WFQ among its children. WFQ weights will + * be applied against bytes for scheduling children + * when a non-leaf node is configured appropriately. + */ + int sched_wfq_byte_mode_supported; + /** Mask of statistics counter types supported by the * non-leaf nodes on this level. Every supported * statistics counter type is supported by at least one @@ -625,6 +696,24 @@ struct rte_tm_level_capabilities { */ uint64_t shaper_private_rate_max; + /** Shaper private packet mode supported. When non-zero, + * this parameter indicates there is at least one leaf + * node at this level that can be configured with + * packet mode in its private shaper. When private + * shaper is configured in packet mode, committed/peak + * rate provided is interpreted in packets per second. + */ + int shaper_private_packet_mode_supported; + + /** Shaper private byte mode supported. When non-zero, + * this parameter indicates there is at least one leaf + * node at this level that can be configured with + * byte mode in its private shaper. When private shaper + * is configured in byte mode, committed/peak rate + * provided is interpreted in bytes per second. + */ + int shaper_private_byte_mode_supported; + /** Maximum number of shared shapers that any leaf node * on this level can be part of. The value of zero * indicates that shared shapers are not supported by @@ -635,6 +724,20 @@ struct rte_tm_level_capabilities { */ uint32_t shaper_shared_n_max; + /** Shaper shared packet mode supported. When non-zero, + * this parameter indicates that there is at least one + * leaf node on this level that can be part of + * shared shapers which work in packet mode. + */ + int shaper_shared_packet_mode_supported; + + /** Shaper shared byte mode supported. When non-zero, + * this parameter indicates that there is at least one + * leaf node on this level that can be part of + * shared shapers which work in byte mode. + */ + int shaper_shared_byte_mode_supported; + /** WRED packet mode support. When non-zero, this * parameter indicates that there is at least one leaf * node on this level that supports the WRED packet @@ -715,12 +818,38 @@ struct rte_tm_node_capabilities { */ uint64_t shaper_private_rate_max; + /** Shaper private packet mode supported. When non-zero, this parameter + * indicates private shaper of current node can be configured with + * packet mode. When configured in packet mode, committed/peak rate + * provided is interpreted in packets per second. + */ + int shaper_private_packet_mode_supported; + + /** Shaper private byte mode supported. When non-zero, this parameter + * indicates private shaper of current node can be configured with + * byte mode. When configured in byte mode, committed/peak rate + * provided is interpreted in bytes per second. + */ + int shaper_private_byte_mode_supported; + /** Maximum number of shared shapers the current node can be part of. * The value of zero indicates that shared shapers are not supported by * the current node. */ uint32_t shaper_shared_n_max; + /** Shaper shared packet mode supported. When non-zero, + * this parameter indicates that current node can be part of + * shared shapers which work in packet mode. + */ + int shaper_shared_packet_mode_supported; + + /** Shaper shared byte mode supported. When non-zero, + * this parameter indicates that current node can be part of + * shared shapers which work in byte mode. + */ + int shaper_shared_byte_mode_supported; + RTE_STD_C11 union { /** Items valid only for non-leaf nodes. */ @@ -764,6 +893,23 @@ struct rte_tm_node_capabilities { * WFQ weight, so WFQ is reduced to FQ. */ uint32_t sched_wfq_weight_max; + + /** WFQ packet mode supported. When non-zero, this + * parameter indicates that current node supports packet + * mode for WFQ among its children. WFQ weights will be + * applied against packet count for scheduling children + * when configured appropriately. + */ + int sched_wfq_packet_mode_supported; + + /** WFQ byte mode supported. When non-zero, this + * parameter indicates that current node supports byte + * mode for WFQ among its children. WFQ weights will be + * applied against bytes for scheduling children when + * configured appropriately. + */ + int sched_wfq_byte_mode_supported; + } nonleaf; /** Items valid only for leaf nodes. */ @@ -865,10 +1011,10 @@ struct rte_tm_wred_params { * Token bucket */ struct rte_tm_token_bucket { - /** Token bucket rate (bytes per second) */ + /** Token bucket rate (bytes per second or packets per second) */ uint64_t rate; - /** Token bucket size (bytes), a.k.a. max burst size */ + /** Token bucket size (bytes or packets), a.k.a. max burst size */ uint64_t size; }; @@ -889,6 +1035,11 @@ struct rte_tm_token_bucket { * Dual rate shapers use both the committed and the peak token buckets. The * rate of the peak bucket has to be bigger than zero, as well as greater than * or equal to the rate of the committed bucket. + * + * @see struct rte_tm_capabilities::shaper_private_packet_mode_supported + * @see struct rte_tm_capabilities::shaper_private_byte_mode_supported + * @see struct rte_tm_capabilities::shaper_shared_packet_mode_supported + * @see struct rte_tm_capabilities::shaper_shared_byte_mode_supported */ struct rte_tm_shaper_params { /** Committed token bucket */ @@ -901,8 +1052,19 @@ struct rte_tm_shaper_params { * purpose of shaping. Can be used to correct the packet length with * the framing overhead bytes that are also consumed on the wire (e.g. * RTE_TM_ETH_FRAMING_OVERHEAD_FCS). + * This field is ignored when the profile enables packet mode. */ int32_t pkt_length_adjust; + + /** When zero, the byte mode is enabled for the current profile, so the + * *rate* and *size* fields in both the committed and peak token buckets + * are specified in bytes per second and bytes, respectively. + * When non-zero, the packet mode is enabled for the current profile, + * so the *rate* and *size* fields in both the committed and peak token + * buckets are specified in packets per second and packets, + * respectively. + */ + int packet_mode; }; /** @@ -954,6 +1116,8 @@ struct rte_tm_node_params { * When non-NULL, it points to a pre-allocated array of * *n_sp_priorities* values, with non-zero value for * byte-mode and zero for packet-mode. + * @see struct rte_tm_node_capabilities::sched_wfq_packet_mode_supported + * @see struct rte_tm_node_capabilities::sched_wfq_byte_mode_supported */ int *wfq_weight_mode; @@ -1026,6 +1190,7 @@ enum rte_tm_error_type { RTE_TM_ERROR_TYPE_SHAPER_PROFILE_PEAK_RATE, RTE_TM_ERROR_TYPE_SHAPER_PROFILE_PEAK_SIZE, RTE_TM_ERROR_TYPE_SHAPER_PROFILE_PKT_ADJUST_LEN, + RTE_TM_ERROR_TYPE_SHAPER_PROFILE_PACKET_MODE, RTE_TM_ERROR_TYPE_SHAPER_PROFILE_ID, RTE_TM_ERROR_TYPE_SHARED_SHAPER_ID, RTE_TM_ERROR_TYPE_NODE_PARENT_NODE_ID, @@ -1079,6 +1244,7 @@ struct rte_tm_error { * @return * 0 on success, non-zero error code otherwise. */ +__rte_experimental int rte_tm_get_number_of_leaf_nodes(uint16_t port_id, uint32_t *n_leaf_nodes, @@ -1103,6 +1269,7 @@ rte_tm_get_number_of_leaf_nodes(uint16_t port_id, * @return * 0 on success, non-zero error code otherwise. */ +__rte_experimental int rte_tm_node_type_get(uint16_t port_id, uint32_t node_id, @@ -1121,6 +1288,7 @@ rte_tm_node_type_get(uint16_t port_id, * @return * 0 on success, non-zero error code otherwise. */ +__rte_experimental int rte_tm_capabilities_get(uint16_t port_id, struct rte_tm_capabilities *cap, @@ -1141,6 +1309,7 @@ rte_tm_capabilities_get(uint16_t port_id, * @return * 0 on success, non-zero error code otherwise. */ +__rte_experimental int rte_tm_level_capabilities_get(uint16_t port_id, uint32_t level_id, @@ -1161,6 +1330,7 @@ rte_tm_level_capabilities_get(uint16_t port_id, * @return * 0 on success, non-zero error code otherwise. */ +__rte_experimental int rte_tm_node_capabilities_get(uint16_t port_id, uint32_t node_id, @@ -1186,6 +1356,7 @@ rte_tm_node_capabilities_get(uint16_t port_id, * * @see struct rte_tm_capabilities::cman_wred_context_n_max */ +__rte_experimental int rte_tm_wred_profile_add(uint16_t port_id, uint32_t wred_profile_id, @@ -1209,6 +1380,7 @@ rte_tm_wred_profile_add(uint16_t port_id, * * @see struct rte_tm_capabilities::cman_wred_context_n_max */ +__rte_experimental int rte_tm_wred_profile_delete(uint16_t port_id, uint32_t wred_profile_id, @@ -1240,6 +1412,7 @@ rte_tm_wred_profile_delete(uint16_t port_id, * * @see struct rte_tm_capabilities::cman_wred_context_shared_n_max */ +__rte_experimental int rte_tm_shared_wred_context_add_update(uint16_t port_id, uint32_t shared_wred_context_id, @@ -1264,6 +1437,7 @@ rte_tm_shared_wred_context_add_update(uint16_t port_id, * * @see struct rte_tm_capabilities::cman_wred_context_shared_n_max */ +__rte_experimental int rte_tm_shared_wred_context_delete(uint16_t port_id, uint32_t shared_wred_context_id, @@ -1288,6 +1462,7 @@ rte_tm_shared_wred_context_delete(uint16_t port_id, * * @see struct rte_tm_capabilities::shaper_n_max */ +__rte_experimental int rte_tm_shaper_profile_add(uint16_t port_id, uint32_t shaper_profile_id, @@ -1311,6 +1486,7 @@ rte_tm_shaper_profile_add(uint16_t port_id, * * @see struct rte_tm_capabilities::shaper_n_max */ +__rte_experimental int rte_tm_shaper_profile_delete(uint16_t port_id, uint32_t shaper_profile_id, @@ -1340,6 +1516,7 @@ rte_tm_shaper_profile_delete(uint16_t port_id, * * @see struct rte_tm_capabilities::shaper_shared_n_max */ +__rte_experimental int rte_tm_shared_shaper_add_update(uint16_t port_id, uint32_t shared_shaper_id, @@ -1363,6 +1540,7 @@ rte_tm_shared_shaper_add_update(uint16_t port_id, * * @see struct rte_tm_capabilities::shaper_shared_n_max */ +__rte_experimental int rte_tm_shared_shaper_delete(uint16_t port_id, uint32_t shared_shaper_id, @@ -1431,6 +1609,7 @@ rte_tm_shared_shaper_delete(uint16_t port_id, * @see RTE_TM_NODE_LEVEL_ID_ANY * @see struct rte_tm_capabilities */ +__rte_experimental int rte_tm_node_add(uint16_t port_id, uint32_t node_id, @@ -1464,6 +1643,7 @@ rte_tm_node_add(uint16_t port_id, * * @see RTE_TM_UPDATE_NODE_ADD_DELETE */ +__rte_experimental int rte_tm_node_delete(uint16_t port_id, uint32_t node_id, @@ -1488,6 +1668,7 @@ rte_tm_node_delete(uint16_t port_id, * @see rte_tm_node_resume() * @see RTE_TM_UPDATE_NODE_SUSPEND_RESUME */ +__rte_experimental int rte_tm_node_suspend(uint16_t port_id, uint32_t node_id, @@ -1511,6 +1692,7 @@ rte_tm_node_suspend(uint16_t port_id, * @see rte_tm_node_suspend() * @see RTE_TM_UPDATE_NODE_SUSPEND_RESUME */ +__rte_experimental int rte_tm_node_resume(uint16_t port_id, uint32_t node_id, @@ -1552,6 +1734,7 @@ rte_tm_node_resume(uint16_t port_id, * @see rte_tm_node_add() * @see rte_tm_node_delete() */ +__rte_experimental int rte_tm_hierarchy_commit(uint16_t port_id, int clear_on_fail, @@ -1592,6 +1775,7 @@ rte_tm_hierarchy_commit(uint16_t port_id, * @see RTE_TM_UPDATE_NODE_PARENT_KEEP_LEVEL * @see RTE_TM_UPDATE_NODE_PARENT_CHANGE_LEVEL */ +__rte_experimental int rte_tm_node_parent_update(uint16_t port_id, uint32_t node_id, @@ -1621,6 +1805,7 @@ rte_tm_node_parent_update(uint16_t port_id, * * @see struct rte_tm_capabilities::shaper_private_n_max */ +__rte_experimental int rte_tm_node_shaper_update(uint16_t port_id, uint32_t node_id, @@ -1648,6 +1833,7 @@ rte_tm_node_shaper_update(uint16_t port_id, * * @see struct rte_tm_capabilities::shaper_shared_n_max */ +__rte_experimental int rte_tm_node_shared_shaper_update(uint16_t port_id, uint32_t node_id, @@ -1675,6 +1861,7 @@ rte_tm_node_shared_shaper_update(uint16_t port_id, * @see enum rte_tm_stats_type * @see RTE_TM_UPDATE_NODE_STATS */ +__rte_experimental int rte_tm_node_stats_update(uint16_t port_id, uint32_t node_id, @@ -1703,6 +1890,7 @@ rte_tm_node_stats_update(uint16_t port_id, * @see RTE_TM_UPDATE_NODE_WFQ_WEIGHT_MODE * @see RTE_TM_UPDATE_NODE_N_SP_PRIORITIES */ +__rte_experimental int rte_tm_node_wfq_weight_mode_update(uint16_t port_id, uint32_t node_id, @@ -1726,6 +1914,7 @@ rte_tm_node_wfq_weight_mode_update(uint16_t port_id, * * @see RTE_TM_UPDATE_NODE_CMAN */ +__rte_experimental int rte_tm_node_cman_update(uint16_t port_id, uint32_t node_id, @@ -1750,6 +1939,7 @@ rte_tm_node_cman_update(uint16_t port_id, * * @see struct rte_tm_capabilities::cman_wred_context_private_n_max */ +__rte_experimental int rte_tm_node_wred_context_update(uint16_t port_id, uint32_t node_id, @@ -1775,6 +1965,7 @@ rte_tm_node_wred_context_update(uint16_t port_id, * * @see struct rte_tm_capabilities::cman_wred_context_shared_n_max */ +__rte_experimental int rte_tm_node_shared_wred_context_update(uint16_t port_id, uint32_t node_id, @@ -1807,6 +1998,7 @@ rte_tm_node_shared_wred_context_update(uint16_t port_id, * * @see enum rte_tm_stats_type */ +__rte_experimental int rte_tm_node_stats_read(uint16_t port_id, uint32_t node_id, @@ -1844,6 +2036,7 @@ rte_tm_node_stats_read(uint16_t port_id, * * @see struct rte_tm_capabilities::mark_vlan_dei_supported */ +__rte_experimental int rte_tm_mark_vlan_dei(uint16_t port_id, int mark_green, @@ -1894,6 +2087,7 @@ rte_tm_mark_vlan_dei(uint16_t port_id, * @see struct rte_tm_capabilities::mark_ip_ecn_tcp_supported * @see struct rte_tm_capabilities::mark_ip_ecn_sctp_supported */ +__rte_experimental int rte_tm_mark_ip_ecn(uint16_t port_id, int mark_green, @@ -1942,6 +2136,7 @@ rte_tm_mark_ip_ecn(uint16_t port_id, * * @see struct rte_tm_capabilities::mark_ip_dscp_supported */ +__rte_experimental int rte_tm_mark_ip_dscp(uint16_t port_id, int mark_green,