summaryrefslogtreecommitdiffstats
path: root/src/plugins/gtpu/gtpu.api
blob: 7c5c137a8404fdedd5164af92438c91232857485 (plain)
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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
/*
 * Copyright (c) 2017 Intel and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

option version = "2.1.0";
import "vnet/interface_types.api";
import "vnet/ip/ip_types.api";

enum gtpu_forwarding_type
{
  GTPU_API_FORWARDING_NONE = 0,
  GTPU_API_FORWARDING_BAD_HEADER = 1,
  GTPU_API_FORWARDING_UNKNOWN_TEID = 2,
  GTPU_API_FORWARDING_UNKNOWN_TYPE = 4,
};

enum gtpu_decap_next_type
{
  GTPU_API_DECAP_NEXT_DROP = 0,
  GTPU_API_DECAP_NEXT_L2 = 1,
  GTPU_API_DECAP_NEXT_IP4 = 2,
  GTPU_API_DECAP_NEXT_IP6 = 3,
};

typedef sw_if_counters
{
  u64 packets_rx;
  u64 packets_tx;
  u64 bytes_rx;
  u64 bytes_tx;
};

/** \brief Create or delete a GTPU tunnel
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param is_add - add address if non-zero, else delete
    @param src_address - GTPU tunnel's source address.
    @param dst_address - GTPU tunnel's destination address.
    @param mcast_sw_if_index - version, O-bit and C-bit (see nsh_packet.h)
    @param encap_vrf_id - fib identifier used for outgoing encapsulated packets
    @param decap_next_index - the index of the next node if success
    @param teid - Local (rx) Tunnel Endpoint Identifier
    @param tteid - Remote (tx) Tunnel Endpoint Identifier
*/
define gtpu_add_del_tunnel
{
  u32 client_index;
  u32 context;
  bool is_add;
  vl_api_address_t src_address;
  vl_api_address_t dst_address;
  vl_api_interface_index_t mcast_sw_if_index;
  u32 encap_vrf_id;
  u32 decap_next_index;
  u32 teid;
  u32 tteid;
  option vat_help = "src <ip-addr> {dst <ip-addr> | group <mcast-ip-addr> {<intfc> | mcast_sw_if_index <nn>}} teid <nn> [tteid <nn>] [encap-vrf-id <nn>] [decap-next <l2|nn>] [del]";
};

/** \brief reply for set or delete an GTPU tunnel
    @param context - sender context, to match reply w/ request
    @param retval - return code
    @param sw_if_index - software index of the interface
*/
define gtpu_add_del_tunnel_reply
{
  u32 context;
  i32 retval;
  vl_api_interface_index_t sw_if_index;
};

/** \brief Create or delete a GTPU tunnel
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param is_add - add address if non-zero, else delete
    @param src_address - GTPU tunnel's source address.
    @param dst_address - GTPU tunnel's destination address.
    @param mcast_sw_if_index - version, O-bit and C-bit (see nsh_packet.h)
    @param encap_vrf_id - fib identifier used for outgoing encapsulated packets
    @param decap_next_index - the index of the next node if success
    @param teid - Local (rx) Tunnel Endpoint Identifier
    @param tteid - Remote (tx) Tunnel Endpoint Identifier
    @param pdu_extension - add PDU session container extension to each packet
    @param qfi - the QFI to set in the PDU session container, 6 bits only
*/
define gtpu_add_del_tunnel_v2
{
  u32 client_index;
  u32 context;
  bool is_add;
  vl_api_address_t src_address;
  vl_api_address_t dst_address;
  vl_api_interface_index_t mcast_sw_if_index;
  u32 encap_vrf_id;
  vl_api_gtpu_decap_next_type_t decap_next_index;
  u32 teid;
  u32 tteid;
  bool pdu_extension;
  u8 qfi;
  option vat_help = "src <ip-addr> {dst <ip-addr> | group <mcast-ip-addr> {<intfc> | mcast_sw_if_index <nn>}} teid <nn> [tteid <nn>] [encap-vrf-id <nn>] [decap-next <l2|nn>] [qfi <nn>] [del]";
  option in_progress;
};

/** \brief reply for set or delete an GTPU tunnel
    @param context - sender context, to match reply w/ request
    @param retval - return code
    @param sw_if_index - software index of the interface
    @param counters - Number of packets/bytes that is sent/received via this tunnel. Inaccurate (with in flight packets), sum for the entire set of per-thread counters. Zero for new tunnels.
*/
define gtpu_add_del_tunnel_v2_reply
{
  u32 context;
  i32 retval;
  vl_api_interface_index_t sw_if_index;
  vl_api_sw_if_counters_t counters;
  option in_progress;
};

/** \brief Update GTPU tunnel TX TEID
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param dst_address - GTPU tunnel's destination address.
    @param encap_vrf_id - fib identifier used for outgoing encapsulated packets
    @param teid - Local (rx) Tunnel Endpoint Identifier
    @param tteid - remote (tx) Tunnel Endpoint Identifier
*/
autoreply define gtpu_tunnel_update_tteid
{
  u32 client_index;
  u32 context;
  vl_api_address_t dst_address;
  u32 encap_vrf_id;
  u32 teid;
  u32 tteid;
  option vat_help = "dst <ip-addr> teid <nn> tteid <nn> [encap-vrf-id <nn>]";
};

/** \brief Dump GTPU tunnel
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param sw_if_index - software index of the interface
*/
define gtpu_tunnel_dump
{
  u32 client_index;
  u32 context;
  vl_api_interface_index_t sw_if_index;
  option vat_help = "[<intfc> | sw_if_index <nn>]";
};

/** \brief dump details of an GTPU tunnel
    @param context - sender context, to match reply w/ request
    @param sw_if_index - software index of the interface
    @param src_address - GTPU tunnel's source address.
    @param dst_address - GTPU tunnel's destination address.
    @param mcast_sw_if_index - version, O-bit and C-bit (see nsh_packet.h)
    @param encap_vrf_id - fib identifier used for outgoing encapsulated packets
    @param decap_next_index - the index of the next node if success
    @param teid - Local (rx) Tunnel Endpoint Identifier
    @param tteid - Remote (tx) Tunnel Endpoint Identifier
*/
define gtpu_tunnel_details
{
  u32 context;
  vl_api_interface_index_t sw_if_index;
  vl_api_address_t src_address;
  vl_api_address_t dst_address;
  vl_api_interface_index_t mcast_sw_if_index;
  u32 encap_vrf_id;
  u32 decap_next_index;
  u32 teid;
  u32 tteid;
};


/** \brief Dump GTPU tunnel
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param sw_if_index - software index of the interface
*/
define gtpu_tunnel_v2_dump
{
  u32 client_index;
  u32 context;
  vl_api_interface_index_t sw_if_index;
  option vat_help = "[<intfc> | sw_if_index <nn>]";
  option in_progress;
};

/** \brief dump details of an GTPU tunnel
    @param context - sender context, to match reply w/ request
    @param sw_if_index - software index of the interface
    @param src_address - GTPU tunnel's source address.
    @param dst_address - GTPU tunnel's destination address.
    @param mcast_sw_if_index - version, O-bit and C-bit (see nsh_packet.h)
    @param encap_vrf_id - fib identifier used for outgoing encapsulated packets
    @param decap_next_index - the index of the next node if success
    @param teid - Local (rx) Tunnel Endpoint Identifier
    @param tteid - Remote (tx) Tunnel Endpoint Identifier
    @param pdu_extension - add PDU session container extension to each packet
    @param qfi - the QFI to set in the PDU session container, 6 bits only
    @param is_forwarding - tunnel used for forwarding packets
    @param forwarding_type - the type of packets forwarded
    @param counters - Number of packets/bytes that is sent/received via this tunnel. Inaccurate (with in flight packets), sum for the entire set of per-thread counters.
*/
define gtpu_tunnel_v2_details
{
  u32 context;
  vl_api_interface_index_t sw_if_index;
  vl_api_address_t src_address;
  vl_api_address_t dst_address;
  vl_api_interface_index_t mcast_sw_if_index;
  u32 encap_vrf_id;
  vl_api_gtpu_decap_next_type_t decap_next_index;
  u32 teid;
  u32 tteid;
  bool pdu_extension;
  u8 qfi;
  bool is_forwarding;
  vl_api_gtpu_forwarding_type_t forwarding_type;
  vl_api_sw_if_counters_t counters;
  option in_progress;
};

/** \brief Interface set gtpu-bypass request
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param sw_if_index - interface used to reach neighbor
    @param is_ipv6 - if non-zero, enable ipv6-gtpu-bypass, else ipv4-gtpu-bypass
    @param enable - if non-zero enable, else disable
*/
autoreply define sw_interface_set_gtpu_bypass
{
  u32 client_index;
  u32 context;
  vl_api_interface_index_t sw_if_index;
  bool is_ipv6;
  bool enable;
  option vat_help = "<intfc> | sw_if_index <id> [ip4 | ip6] [enable | disable]";
};

/** \brief Offload gtpu rx request
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param hw_if_index - rx hw interface
    @param sw_if_index - gtpu interface to offload
    @param enable - if non-zero enable, else disable
*/
autoreply define gtpu_offload_rx
{
  u32 client_index;
  u32 context;
  u32 hw_if_index;
  u32 sw_if_index;
  u8 enable;
  option vat_help = "hw <intfc> rx <tunnel-name> [del]";
};

/** \brief Set gtpu-forward request
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param is_add - add address if non-zero, else delete
    @param forwarding_type - forward filter (unknown teid, unknown message type or unknown header)
    @param dst_address - forward destination address.
    @param encap_vrf_id - fib identifier used for outgoing packets
    @param decap_next_index - the index of the next node if success
*/
define gtpu_add_del_forward
{
  u32 client_index;
  u32 context;
  bool is_add;
  vl_api_address_t dst_address;
  vl_api_gtpu_forwarding_type_t forwarding_type;
  u32 encap_vrf_id;
  vl_api_gtpu_decap_next_type_t decap_next_index;
  option vat_help = "dst <ip-addr> {bad-header|unknown-teid|unknown-type} [decap-next <l2|nn>] [del]";
  option in_progress;
};

/** \brief reply for set or delete GTPU forwarding
    @param context - sender context, to match reply w/ request
    @param retval - return code
    @param sw_if_index - software index of the interface
*/
define gtpu_add_del_forward_reply
{
  u32 context;
  i32 retval;
  vl_api_interface_index_t sw_if_index;
  option in_progress;
};

/** \brief Get list of metrics, use for bulk transfer.
    @param client_index - opaque cookie to identify the sender
    @param context - sender context, to match reply w/ request
    @param sw_if_index_start - software index of the first interface to return data on.
    @param capacity - max number of interfaces returned.
*/
define gtpu_get_transfer_counts
{
  u32 client_index;
  u32 context;
  vl_api_interface_index_t sw_if_index_start;
  u32 capacity;
  //option vat_help = "start_index <sw_if_index> count <nn>";
  option in_progress;
};

/** \brief reply for set or delete GTPU forwarding
    @param context - sender context, to match reply w/ request
    @param retval - return code
    @param count - number of tunnel counters returned, sequential starting at sw_if_index_start.
    @param tunnels - Number of packets/bytes that is sent/received via this tunnel. Inaccurate (with in flight packets), sum for the entire set of per-thread counters.
*/
typedef tunnel_metrics
{
   vl_api_interface_index_t sw_if_index;
   u32 reserved;
   vl_api_sw_if_counters_t counters;
};

define gtpu_get_transfer_counts_reply
{
  u32 context;
  i32 retval;
  u32 count;
  vl_api_tunnel_metrics_t tunnels[count];
  option in_progress;
};

/*
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */