DPDK  18.05.1
rte_mtr.h
Go to the documentation of this file.
1 /*-
2  * BSD LICENSE
3  *
4  * Copyright 2017 Intel Corporation
5  * Copyright 2017 NXP
6  * Copyright 2017 Cavium
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  * * Neither the name of Intel Corporation nor the names of its
19  * contributors may be used to endorse or promote products derived
20  * from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #ifndef __INCLUDE_RTE_MTR_H__
36 #define __INCLUDE_RTE_MTR_H__
37 
76 #include <stdint.h>
77 #include <rte_compat.h>
78 #include <rte_common.h>
79 
80 #ifdef __cplusplus
81 extern "C" {
82 #endif
83 
87 enum rte_mtr_color {
88  RTE_MTR_GREEN = 0,
89  RTE_MTR_YELLOW,
90  RTE_MTR_RED,
91  RTE_MTR_COLORS
92 };
93 
97 enum rte_mtr_stats_type {
99  RTE_MTR_STATS_N_PKTS_GREEN = 1 << 0,
100 
102  RTE_MTR_STATS_N_PKTS_YELLOW = 1 << 1,
103 
105  RTE_MTR_STATS_N_PKTS_RED = 1 << 2,
106 
108  RTE_MTR_STATS_N_PKTS_DROPPED = 1 << 3,
109 
111  RTE_MTR_STATS_N_BYTES_GREEN = 1 << 4,
112 
114  RTE_MTR_STATS_N_BYTES_YELLOW = 1 << 5,
115 
117  RTE_MTR_STATS_N_BYTES_RED = 1 << 6,
118 
120  RTE_MTR_STATS_N_BYTES_DROPPED = 1 << 7,
121 };
122 
126 struct rte_mtr_stats {
128  uint64_t n_pkts[RTE_MTR_COLORS];
129 
131  uint64_t n_bytes[RTE_MTR_COLORS];
132 
134  uint64_t n_pkts_dropped;
135 
137  uint64_t n_bytes_dropped;
138 };
139 
143 enum rte_mtr_algorithm {
149  RTE_MTR_NONE = 0,
150 
152  RTE_MTR_SRTCM_RFC2697,
153 
155  RTE_MTR_TRTCM_RFC2698,
156 
158  RTE_MTR_TRTCM_RFC4115,
159 };
160 
164 struct rte_mtr_meter_profile {
166  enum rte_mtr_algorithm alg;
167 
168  RTE_STD_C11
169  union {
171  struct {
173  uint64_t cir;
174 
176  uint64_t cbs;
177 
179  uint64_t ebs;
180  } srtcm_rfc2697;
181 
183  struct {
185  uint64_t cir;
186 
188  uint64_t pir;
189 
191  uint64_t cbs;
192 
194  uint64_t pbs;
195  } trtcm_rfc2698;
196 
198  struct {
200  uint64_t cir;
201 
203  uint64_t eir;
204 
206  uint64_t cbs;
207 
209  uint64_t ebs;
210  } trtcm_rfc4115;
211  };
212 };
213 
217 enum rte_mtr_policer_action {
219  MTR_POLICER_ACTION_COLOR_GREEN = 0,
220 
222  MTR_POLICER_ACTION_COLOR_YELLOW,
223 
225  MTR_POLICER_ACTION_COLOR_RED,
226 
228  MTR_POLICER_ACTION_DROP,
229 };
230 
236 struct rte_mtr_params {
238  uint32_t meter_profile_id;
239 
249  int use_prev_mtr_color;
250 
263  enum rte_mtr_color *dscp_table;
264 
270  int meter_enable;
271 
273  enum rte_mtr_policer_action action[RTE_MTR_COLORS];
274 
278  uint64_t stats_mask;
279 };
280 
284 struct rte_mtr_capabilities {
286  uint32_t n_max;
287 
292  uint32_t n_shared_max;
293 
297  int identical;
298 
302  int shared_identical;
303 
308  uint32_t shared_n_flows_per_mtr_max;
309 
314  uint32_t chaining_n_mtrs_per_flow_max;
315 
326  int chaining_use_prev_mtr_color_supported;
327 
337  int chaining_use_prev_mtr_color_enforced;
338 
343  uint32_t meter_srtcm_rfc2697_n_max;
344 
349  uint32_t meter_trtcm_rfc2698_n_max;
350 
355  uint32_t meter_trtcm_rfc4115_n_max;
356 
362  uint64_t meter_rate_max;
363 
368  int color_aware_srtcm_rfc2697_supported;
369 
374  int color_aware_trtcm_rfc2698_supported;
375 
380  int color_aware_trtcm_rfc4115_supported;
381 
386  int policer_action_recolor_supported;
387 
392  int policer_action_drop_supported;
393 
397  uint64_t stats_mask;
398 };
399 
406 enum rte_mtr_error_type {
407  RTE_MTR_ERROR_TYPE_NONE,
408  RTE_MTR_ERROR_TYPE_UNSPECIFIED,
409  RTE_MTR_ERROR_TYPE_METER_PROFILE_ID,
410  RTE_MTR_ERROR_TYPE_METER_PROFILE,
411  RTE_MTR_ERROR_TYPE_MTR_ID,
412  RTE_MTR_ERROR_TYPE_MTR_PARAMS,
413  RTE_MTR_ERROR_TYPE_POLICER_ACTION_GREEN,
414  RTE_MTR_ERROR_TYPE_POLICER_ACTION_YELLOW,
415  RTE_MTR_ERROR_TYPE_POLICER_ACTION_RED,
416  RTE_MTR_ERROR_TYPE_STATS_MASK,
417  RTE_MTR_ERROR_TYPE_STATS,
418  RTE_MTR_ERROR_TYPE_SHARED,
419 };
420 
432 struct rte_mtr_error {
433  enum rte_mtr_error_type type;
434  const void *cause;
435  const char *message;
436 };
437 
450 int __rte_experimental
451 rte_mtr_capabilities_get(uint16_t port_id,
452  struct rte_mtr_capabilities *cap,
453  struct rte_mtr_error *error);
454 
473 int __rte_experimental
474 rte_mtr_meter_profile_add(uint16_t port_id,
475  uint32_t meter_profile_id,
476  struct rte_mtr_meter_profile *profile,
477  struct rte_mtr_error *error);
478 
494 int __rte_experimental
495 rte_mtr_meter_profile_delete(uint16_t port_id,
496  uint32_t meter_profile_id,
497  struct rte_mtr_error *error);
498 
522 int __rte_experimental
523 rte_mtr_create(uint16_t port_id,
524  uint32_t mtr_id,
525  struct rte_mtr_params *params,
526  int shared,
527  struct rte_mtr_error *error);
528 
545 int __rte_experimental
546 rte_mtr_destroy(uint16_t port_id,
547  uint32_t mtr_id,
548  struct rte_mtr_error *error);
549 
572 int __rte_experimental
573 rte_mtr_meter_disable(uint16_t port_id,
574  uint32_t mtr_id,
575  struct rte_mtr_error *error);
576 
593 int __rte_experimental
594 rte_mtr_meter_enable(uint16_t port_id,
595  uint32_t mtr_id,
596  struct rte_mtr_error *error);
597 
612 int __rte_experimental
613 rte_mtr_meter_profile_update(uint16_t port_id,
614  uint32_t mtr_id,
615  uint32_t meter_profile_id,
616  struct rte_mtr_error *error);
617 
636 int __rte_experimental
637 rte_mtr_meter_dscp_table_update(uint16_t port_id,
638  uint32_t mtr_id,
639  enum rte_mtr_color *dscp_table,
640  struct rte_mtr_error *error);
641 
662 int __rte_experimental
663 rte_mtr_policer_actions_update(uint16_t port_id,
664  uint32_t mtr_id,
665  uint32_t action_mask,
666  enum rte_mtr_policer_action *actions,
667  struct rte_mtr_error *error);
668 
687 int __rte_experimental
688 rte_mtr_stats_update(uint16_t port_id,
689  uint32_t mtr_id,
690  uint64_t stats_mask,
691  struct rte_mtr_error *error);
692 
718 int __rte_experimental
719 rte_mtr_stats_read(uint16_t port_id,
720  uint32_t mtr_id,
721  struct rte_mtr_stats *stats,
722  uint64_t *stats_mask,
723  int clear,
724  struct rte_mtr_error *error);
725 
726 #ifdef __cplusplus
727 }
728 #endif
729 
730 #endif /* __INCLUDE_RTE_MTR_H__ */
Generated by   doxygen 1.8.1.2