1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
/*-
* 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.
*/
#ifndef __INCLUDE_RTE_MTR_DRIVER_H__
#define __INCLUDE_RTE_MTR_DRIVER_H__
/**
* @file
* RTE Generic Traffic Metering and Policing API (Driver Side)
*
* This file provides implementation helpers for internal use by PMDs, they
* are not intended to be exposed to applications and are not subject to ABI
* versioning.
*/
#include <stdint.h>
#include <rte_errno.h>
#include "rte_ethdev.h"
#include "rte_mtr.h"
#ifdef __cplusplus
extern "C" {
#endif
typedef int (*rte_mtr_capabilities_get_t)(struct rte_eth_dev *dev,
struct rte_mtr_capabilities *cap,
struct rte_mtr_error *error);
/**< @internal MTR capabilities get */
typedef int (*rte_mtr_meter_profile_add_t)(struct rte_eth_dev *dev,
uint32_t meter_profile_id,
struct rte_mtr_meter_profile *profile,
struct rte_mtr_error *error);
/**< @internal MTR meter profile add */
typedef int (*rte_mtr_meter_profile_delete_t)(struct rte_eth_dev *dev,
uint32_t meter_profile_id,
struct rte_mtr_error *error);
/**< @internal MTR meter profile delete */
typedef int (*rte_mtr_create_t)(struct rte_eth_dev *dev,
uint32_t mtr_id,
struct rte_mtr_params *params,
int shared,
struct rte_mtr_error *error);
/**< @internal MTR object create */
typedef int (*rte_mtr_destroy_t)(struct rte_eth_dev *dev,
uint32_t mtr_id,
struct rte_mtr_error *error);
/**< @internal MTR object destroy */
typedef int (*rte_mtr_meter_enable_t)(struct rte_eth_dev *dev,
uint32_t mtr_id,
struct rte_mtr_error *error);
/**< @internal MTR object meter enable */
typedef int (*rte_mtr_meter_disable_t)(struct rte_eth_dev *dev,
uint32_t mtr_id,
struct rte_mtr_error *error);
/**< @internal MTR object meter disable */
typedef int (*rte_mtr_meter_profile_update_t)(struct rte_eth_dev *dev,
uint32_t mtr_id,
uint32_t meter_profile_id,
struct rte_mtr_error *error);
/**< @internal MTR object meter profile update */
typedef int (*rte_mtr_meter_dscp_table_update_t)(struct rte_eth_dev *dev,
uint32_t mtr_id,
enum rte_mtr_color *dscp_table,
struct rte_mtr_error *error);
/**< @internal MTR object meter DSCP table update */
typedef int (*rte_mtr_policer_actions_update_t)(struct rte_eth_dev *dev,
uint32_t mtr_id,
uint32_t action_mask,
enum rte_mtr_policer_action *actions,
struct rte_mtr_error *error);
/**< @internal MTR object policer action update*/
typedef int (*rte_mtr_stats_update_t)(struct rte_eth_dev *dev,
uint32_t mtr_id,
uint64_t stats_mask,
struct rte_mtr_error *error);
/**< @internal MTR object enabled stats update */
typedef int (*rte_mtr_stats_read_t)(struct rte_eth_dev *dev,
uint32_t mtr_id,
struct rte_mtr_stats *stats,
uint64_t *stats_mask,
int clear,
struct rte_mtr_error *error);
/**< @internal MTR object stats read */
struct rte_mtr_ops {
/** MTR capabilities get */
rte_mtr_capabilities_get_t capabilities_get;
/** MTR meter profile add */
rte_mtr_meter_profile_add_t meter_profile_add;
/** MTR meter profile delete */
rte_mtr_meter_profile_delete_t meter_profile_delete;
/** MTR object create */
rte_mtr_create_t create;
/** MTR object destroy */
rte_mtr_destroy_t destroy;
/** MTR object meter enable */
rte_mtr_meter_enable_t meter_enable;
/** MTR object meter disable */
rte_mtr_meter_disable_t meter_disable;
/** MTR object meter profile update */
rte_mtr_meter_profile_update_t meter_profile_update;
/** MTR object meter DSCP table update */
rte_mtr_meter_dscp_table_update_t meter_dscp_table_update;
/** MTR object policer action update */
rte_mtr_policer_actions_update_t policer_actions_update;
/** MTR object enabled stats update */
rte_mtr_stats_update_t stats_update;
/** MTR object stats read */
rte_mtr_stats_read_t stats_read;
};
/**
* Initialize generic error structure.
*
* This function also sets rte_errno to a given value.
*
* @param[out] error
* Pointer to error structure (may be NULL).
* @param[in] code
* Related error code (rte_errno).
* @param[in] type
* Cause field and error type.
* @param[in] cause
* Object responsible for the error.
* @param[in] message
* Human-readable error message.
*
* @return
* Error code.
*/
static inline int
rte_mtr_error_set(struct rte_mtr_error *error,
int code,
enum rte_mtr_error_type type,
const void *cause,
const char *message)
{
if (error) {
*error = (struct rte_mtr_error){
.type = type,
.cause = cause,
.message = message,
};
}
rte_errno = code;
return code;
}
/**
* Get generic traffic metering and policing operations structure from a port
*
* @param[in] port_id
* The port identifier of the Ethernet device.
* @param[out] error
* Error details
*
* @return
* The traffic metering and policing operations structure associated with
* port_id on success, NULL otherwise.
*/
const struct rte_mtr_ops *
rte_mtr_ops_get(uint16_t port_id, struct rte_mtr_error *error);
#ifdef __cplusplus
}
#endif
#endif /* __INCLUDE_RTE_MTR_DRIVER_H__ */
|
