blob: 07da2617d7111dd812ec7dc20374dec02fc1524d [file] [log] [blame]
Ed Warnickecb9cada2015-12-08 15:45:58 -07001/*
2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15/*
16 * interface.h: VNET interfaces/sub-interfaces
17 *
18 * Copyright (c) 2008 Eliot Dresselhaus
19 *
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
27 *
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
30 *
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38 */
39
40#ifndef included_vnet_interface_h
41#define included_vnet_interface_h
42
Dave Barach3ae28732018-11-16 17:19:00 -050043#include <vlib/vlib.h>
44#include <vppinfra/pcap.h>
Neale Rannsb80c5362016-10-08 13:03:40 +010045#include <vnet/l3_types.h>
jaszha035cdde5c2019-07-11 20:47:24 +000046#include <vppinfra/lock.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070047
48struct vnet_main_t;
49struct vnet_hw_interface_t;
50struct vnet_sw_interface_t;
Neale Rannsc87b66c2019-02-07 07:26:12 -080051union ip46_address_t_;
Ed Warnickecb9cada2015-12-08 15:45:58 -070052
Stevene3a395c2017-05-09 16:19:50 -070053typedef enum
54{
55 VNET_HW_INTERFACE_RX_MODE_UNKNOWN,
56 VNET_HW_INTERFACE_RX_MODE_POLLING,
57 VNET_HW_INTERFACE_RX_MODE_INTERRUPT,
58 VNET_HW_INTERFACE_RX_MODE_ADAPTIVE,
Damjan Marion4e53a0d2017-06-21 14:29:44 +020059 VNET_HW_INTERFACE_RX_MODE_DEFAULT,
Stevene3a395c2017-05-09 16:19:50 -070060 VNET_HW_INTERFACE_NUM_RX_MODES,
61} vnet_hw_interface_rx_mode;
62
Ed Warnickecb9cada2015-12-08 15:45:58 -070063/* Interface up/down callback. */
Dave Barachba868bb2016-08-08 09:51:21 -040064typedef clib_error_t *(vnet_interface_function_t)
Ed Warnickecb9cada2015-12-08 15:45:58 -070065 (struct vnet_main_t * vnm, u32 if_index, u32 flags);
66
67/* Sub-interface add/del callback. */
Dave Barachba868bb2016-08-08 09:51:21 -040068typedef clib_error_t *(vnet_subif_add_del_function_t)
Ed Warnickecb9cada2015-12-08 15:45:58 -070069 (struct vnet_main_t * vnm, u32 if_index,
Dave Barachba868bb2016-08-08 09:51:21 -040070 struct vnet_sw_interface_t * template, int is_add);
Ed Warnickecb9cada2015-12-08 15:45:58 -070071
Pavel Kotucekc631f2d2016-09-26 10:40:02 +020072/* Interface set mac address callback. */
73typedef clib_error_t *(vnet_interface_set_mac_address_function_t)
Neale Ranns3b81a1e2018-09-06 09:50:26 -070074 (struct vnet_hw_interface_t * hi,
75 const u8 * old_address, const u8 * new_address);
Pavel Kotucekc631f2d2016-09-26 10:40:02 +020076
Matthew Smithe0792fd2019-07-12 11:48:24 -050077/* Interface add/del additional mac address callback */
78typedef clib_error_t *(vnet_interface_add_del_mac_address_function_t)
79 (struct vnet_hw_interface_t * hi, const u8 * address, u8 is_add);
80
Stevene3a395c2017-05-09 16:19:50 -070081/* Interface set rx mode callback. */
82typedef clib_error_t *(vnet_interface_set_rx_mode_function_t)
83 (struct vnet_main_t * vnm, u32 if_index, u32 queue_id,
84 vnet_hw_interface_rx_mode mode);
85
Steven4f8863b2018-04-12 19:36:19 -070086/* Interface set l2 mode callback. */
87typedef clib_error_t *(vnet_interface_set_l2_mode_function_t)
88 (struct vnet_main_t * vnm, struct vnet_hw_interface_t * hi,
89 i32 l2_if_adjust);
90
Damjan Mariona35cc142018-03-16 01:25:27 +010091typedef enum
92{
93 VNET_FLOW_DEV_OP_ADD_FLOW,
94 VNET_FLOW_DEV_OP_DEL_FLOW,
95 VNET_FLOW_DEV_OP_GET_COUNTER,
96 VNET_FLOW_DEV_OP_RESET_COUNTER,
97} vnet_flow_dev_op_t;
98
Paul Vinciguerrabdc0e6b2018-09-22 05:32:50 -070099/* Interface flow operations callback. */
Damjan Mariona35cc142018-03-16 01:25:27 +0100100typedef int (vnet_flow_dev_ops_function_t) (struct vnet_main_t * vnm,
101 vnet_flow_dev_op_t op,
102 u32 hw_if_index, u32 index,
103 uword * private_data);
104
Neale Ranns8b37b872016-11-21 12:25:22 +0000105typedef enum vnet_interface_function_priority_t_
106{
107 VNET_ITF_FUNC_PRIORITY_LOW,
108 VNET_ITF_FUNC_PRIORITY_HIGH,
109} vnet_interface_function_priority_t;
110#define VNET_ITF_FUNC_N_PRIO ((vnet_interface_function_priority_t)VNET_ITF_FUNC_PRIORITY_HIGH+1)
111
Dave Barachba868bb2016-08-08 09:51:21 -0400112typedef struct _vnet_interface_function_list_elt
113{
114 struct _vnet_interface_function_list_elt *next_interface_function;
115 clib_error_t *(*fp) (struct vnet_main_t * vnm, u32 if_index, u32 flags);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700116} _vnet_interface_function_list_elt_t;
117
Damjan Marion6e363512018-08-10 22:39:11 +0200118#ifndef CLIB_MARCH_VARIANT
Neale Ranns8b37b872016-11-21 12:25:22 +0000119#define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
120 \
121static void __vnet_interface_function_init_##tag##_##f (void) \
122 __attribute__((__constructor__)) ; \
123 \
124static void __vnet_interface_function_init_##tag##_##f (void) \
125{ \
126 vnet_main_t * vnm = vnet_get_main(); \
127 static _vnet_interface_function_list_elt_t init_function; \
128 init_function.next_interface_function = vnm->tag##_functions[p]; \
129 vnm->tag##_functions[p] = &init_function; \
Ed Warnickecb9cada2015-12-08 15:45:58 -0700130 init_function.fp = (void *) &f; \
Damjan Marion72d2c4f2018-04-05 21:32:29 +0200131} \
132static void __vnet_interface_function_deinit_##tag##_##f (void) \
133 __attribute__((__destructor__)) ; \
134 \
135static void __vnet_interface_function_deinit_##tag##_##f (void) \
136{ \
137 vnet_main_t * vnm = vnet_get_main(); \
138 _vnet_interface_function_list_elt_t *next; \
Neale Ranns8f215b42019-02-22 12:40:53 +0000139 if (vnm->tag##_functions[p]->fp == f) \
Damjan Marion72d2c4f2018-04-05 21:32:29 +0200140 { \
141 vnm->tag##_functions[p] = \
142 vnm->tag##_functions[p]->next_interface_function; \
143 return; \
144 } \
145 next = vnm->tag##_functions[p]; \
146 while (next->next_interface_function) \
147 { \
Neale Ranns8f215b42019-02-22 12:40:53 +0000148 if (next->next_interface_function->fp == f) \
Damjan Marion72d2c4f2018-04-05 21:32:29 +0200149 { \
150 next->next_interface_function = \
151 next->next_interface_function->next_interface_function; \
152 return; \
153 } \
154 next = next->next_interface_function; \
155 } \
Dave Barachba868bb2016-08-08 09:51:21 -0400156}
Damjan Marion6e363512018-08-10 22:39:11 +0200157#else
158/* create unused pointer to silence compiler warnings and get whole
159 function optimized out */
160#define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
161static __clib_unused void * __clib_unused_##f = f;
162#endif
Ed Warnickecb9cada2015-12-08 15:45:58 -0700163
Eyal Barif9cda7d2018-02-13 11:50:58 +0200164#define _VNET_INTERFACE_FUNCTION_DECL(f,tag) \
165 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,VNET_ITF_FUNC_PRIORITY_LOW)
166
Ed Warnickecb9cada2015-12-08 15:45:58 -0700167#define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f) \
168 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
169#define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f) \
170 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
Ole Troand7231612018-06-07 10:17:57 +0200171#define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(f,p) \
Neale Ranns8b37b872016-11-21 12:25:22 +0000172 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,hw_interface_link_up_down,p)
Ole Troand7231612018-06-07 10:17:57 +0200173#define VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(f) \
174 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_mtu_change)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700175#define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f) \
176 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
177#define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f) \
178 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
Neale Ranns8b37b872016-11-21 12:25:22 +0000179#define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(f,p) \
180 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_admin_up_down, p)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700181
Neale Rannsc87b66c2019-02-07 07:26:12 -0800182/**
183 * Tunnel description parameters
184 */
185typedef int (*vnet_dev_class_ip_tunnel_desc_t) (u32 sw_if_index,
186 union ip46_address_t_ * src,
187 union ip46_address_t_ * dst,
188 u8 * is_l2);
189
Ed Warnickecb9cada2015-12-08 15:45:58 -0700190/* A class of hardware interface devices. */
Dave Barachba868bb2016-08-08 09:51:21 -0400191typedef struct _vnet_device_class
192{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700193 /* Index into main vector. */
194 u32 index;
195
196 /* Device name (e.g. "FOOBAR 1234a"). */
Dave Barachba868bb2016-08-08 09:51:21 -0400197 char *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700198
199 /* Function to call when hardware interface is added/deleted. */
Dave Barachba868bb2016-08-08 09:51:21 -0400200 vnet_interface_function_t *interface_add_del_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700201
202 /* Function to bring device administratively up/down. */
Dave Barachba868bb2016-08-08 09:51:21 -0400203 vnet_interface_function_t *admin_up_down_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700204
205 /* Function to call when sub-interface is added/deleted */
Dave Barachba868bb2016-08-08 09:51:21 -0400206 vnet_subif_add_del_function_t *subif_add_del_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700207
Stevene3a395c2017-05-09 16:19:50 -0700208 /* Function to call interface rx mode is changed */
209 vnet_interface_set_rx_mode_function_t *rx_mode_change_function;
210
Steven4f8863b2018-04-12 19:36:19 -0700211 /* Function to call interface l2 mode is changed */
212 vnet_interface_set_l2_mode_function_t *set_l2_mode_function;
213
Ed Warnickecb9cada2015-12-08 15:45:58 -0700214 /* Redistribute flag changes/existence of this interface class. */
215 u32 redistribute;
216
217 /* Transmit function. */
Dave Barachba868bb2016-08-08 09:51:21 -0400218 vlib_node_function_t *tx_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700219
Mohsin Kazmidd8e7d02018-07-23 14:45:57 +0200220 /* Transmit function candidate registration with priority */
221 vlib_node_fn_registration_t *tx_fn_registrations;
222
Ed Warnickecb9cada2015-12-08 15:45:58 -0700223 /* Error strings indexed by error code for this node. */
Dave Barachba868bb2016-08-08 09:51:21 -0400224 char **tx_function_error_strings;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700225
226 /* Number of error codes used by this node. */
227 u32 tx_function_n_errors;
228
229 /* Renumber device name [only!] support, a control-plane kludge */
Dave Barachba868bb2016-08-08 09:51:21 -0400230 int (*name_renumber) (struct vnet_hw_interface_t * hi,
231 u32 new_dev_instance);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700232
Damjan Mariona35cc142018-03-16 01:25:27 +0100233 /* Interface flow offload operations */
234 vnet_flow_dev_ops_function_t *flow_ops_function;
235
Ed Warnickecb9cada2015-12-08 15:45:58 -0700236 /* Format device instance as name. */
Dave Barachba868bb2016-08-08 09:51:21 -0400237 format_function_t *format_device_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700238
239 /* Parse function for device name. */
Dave Barachba868bb2016-08-08 09:51:21 -0400240 unformat_function_t *unformat_device_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700241
242 /* Format device verbosely for this class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400243 format_function_t *format_device;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700244
245 /* Trace buffer format for TX function. */
Dave Barachba868bb2016-08-08 09:51:21 -0400246 format_function_t *format_tx_trace;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700247
Damjan Mariona35cc142018-03-16 01:25:27 +0100248 /* Format flow offload entry */
249 format_function_t *format_flow;
250
Neale Rannsc87b66c2019-02-07 07:26:12 -0800251 vnet_dev_class_ip_tunnel_desc_t ip_tun_desc;
252
Ed Warnickecb9cada2015-12-08 15:45:58 -0700253 /* Function to clear hardware counters for device. */
Dave Barachba868bb2016-08-08 09:51:21 -0400254 void (*clear_counters) (u32 dev_class_instance);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700255
Dave Barachba868bb2016-08-08 09:51:21 -0400256 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
257 u32 hw_if_index,
258 u32 hw_class_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700259
260 /* Called when hardware class of an interface changes. */
Dave Barachba868bb2016-08-08 09:51:21 -0400261 void (*hw_class_change) (struct vnet_main_t * vnm,
262 u32 hw_if_index, u32 new_hw_class_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700263
264 /* Called to redirect traffic from a specific interface instance */
Dave Barachba868bb2016-08-08 09:51:21 -0400265 void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
266 u32 hw_if_index, u32 node_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700267
268 /* Link-list of all device classes set up by constructors created below */
Dave Barachba868bb2016-08-08 09:51:21 -0400269 struct _vnet_device_class *next_class_registration;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700270
Pavel Kotucekc631f2d2016-09-26 10:40:02 +0200271 /* Function to set mac address. */
272 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
Matthew Smithe0792fd2019-07-12 11:48:24 -0500273
274 /* Function to add/delete additional MAC addresses */
275 vnet_interface_add_del_mac_address_function_t *mac_addr_add_del_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700276} vnet_device_class_t;
277
Damjan Marion6e363512018-08-10 22:39:11 +0200278#ifndef CLIB_MARCH_VARIANT
Ed Warnickecb9cada2015-12-08 15:45:58 -0700279#define VNET_DEVICE_CLASS(x,...) \
280 __VA_ARGS__ vnet_device_class_t x; \
281static void __vnet_add_device_class_registration_##x (void) \
282 __attribute__((__constructor__)) ; \
283static void __vnet_add_device_class_registration_##x (void) \
284{ \
285 vnet_main_t * vnm = vnet_get_main(); \
286 x.next_class_registration = vnm->device_class_registrations; \
287 vnm->device_class_registrations = &x; \
288} \
Damjan Marion72d2c4f2018-04-05 21:32:29 +0200289static void __vnet_rm_device_class_registration_##x (void) \
290 __attribute__((__destructor__)) ; \
291static void __vnet_rm_device_class_registration_##x (void) \
292{ \
293 vnet_main_t * vnm = vnet_get_main(); \
294 VLIB_REMOVE_FROM_LINKED_LIST (vnm->device_class_registrations, \
295 &x, next_class_registration); \
296} \
Dave Barachba868bb2016-08-08 09:51:21 -0400297__VA_ARGS__ vnet_device_class_t x
Damjan Marion6e363512018-08-10 22:39:11 +0200298#else
299/* create unused pointer to silence compiler warnings and get whole
300 function optimized out */
301#define VNET_DEVICE_CLASS(x,...) \
302static __clib_unused vnet_device_class_t __clib_unused_##x
303#endif
Ed Warnickecb9cada2015-12-08 15:45:58 -0700304
Mohsin Kazmidd8e7d02018-07-23 14:45:57 +0200305#define VNET_DEVICE_CLASS_TX_FN(devclass) \
306uword CLIB_MARCH_SFX (devclass##_tx_fn)(); \
307static vlib_node_fn_registration_t \
308 CLIB_MARCH_SFX(devclass##_tx_fn_registration) = \
309 { .function = &CLIB_MARCH_SFX (devclass##_tx_fn), }; \
310 \
311static void __clib_constructor \
312CLIB_MARCH_SFX (devclass##_tx_fn_multiarch_register) (void) \
313{ \
314 extern vnet_device_class_t devclass; \
315 vlib_node_fn_registration_t *r; \
316 r = &CLIB_MARCH_SFX (devclass##_tx_fn_registration); \
317 r->priority = CLIB_MARCH_FN_PRIORITY(); \
318 r->next_registration = devclass.tx_fn_registrations; \
319 devclass.tx_fn_registrations = r; \
320} \
321uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (devclass##_tx_fn)
322
Neale Rannsb80c5362016-10-08 13:03:40 +0100323/**
324 * Link Type: A description of the protocol of packets on the link.
325 * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
326 * it maps to the GRE-proto, etc for other lnk types.
327 */
328typedef enum vnet_link_t_
329{
330#if CLIB_DEBUG > 0
331 VNET_LINK_IP4 = 1,
332#else
333 VNET_LINK_IP4 = 0,
334#endif
335 VNET_LINK_IP6,
336 VNET_LINK_MPLS,
337 VNET_LINK_ETHERNET,
338 VNET_LINK_ARP,
Florin Corasce1b4c72017-01-26 14:25:34 -0800339 VNET_LINK_NSH,
Neale Rannsb80c5362016-10-08 13:03:40 +0100340} __attribute__ ((packed)) vnet_link_t;
341
Neale Ranns924d03a2016-10-19 08:25:46 +0100342#define VNET_LINKS { \
343 [VNET_LINK_ETHERNET] = "ethernet", \
344 [VNET_LINK_IP4] = "ipv4", \
345 [VNET_LINK_IP6] = "ipv6", \
346 [VNET_LINK_MPLS] = "mpls", \
347 [VNET_LINK_ARP] = "arp", \
Florin Corasce1b4c72017-01-26 14:25:34 -0800348 [VNET_LINK_NSH] = "nsh", \
Neale Ranns924d03a2016-10-19 08:25:46 +0100349}
350
Neale Ranns580bba72018-04-23 05:31:19 -0700351#define FOR_EACH_VNET_LINK(_link) \
352 for (_link = VNET_LINK_IP4; \
353 _link <= VNET_LINK_NSH; \
354 _link++)
355
Neale Ranns924d03a2016-10-19 08:25:46 +0100356/**
357 * @brief Number of link types. Not part of the enum so it does not have to be included in
358 * switch statements
359 */
Florin Corasce1b4c72017-01-26 14:25:34 -0800360#define VNET_LINK_NUM (VNET_LINK_NSH+1)
Neale Ranns924d03a2016-10-19 08:25:46 +0100361
Neale Rannsb80c5362016-10-08 13:03:40 +0100362/**
363 * @brief Convert a link to to an Ethertype
364 */
365extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
366
367/**
368 * @brief Attributes assignable to a HW interface Class.
369 */
370typedef enum vnet_hw_interface_class_flags_t_
371{
372 /**
373 * @brief a point 2 point interface
374 */
375 VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
Neale Ranns5f8f6172019-04-18 10:23:56 +0000376 /**
377 * @brief a non-broadcast multiple access interface
378 */
379 VNET_HW_INTERFACE_CLASS_FLAG_NBMA = (1 << 1),
Neale Rannsb80c5362016-10-08 13:03:40 +0100380} vnet_hw_interface_class_flags_t;
Damjan Marion1c80e832016-05-11 23:07:18 +0200381
Ed Warnickecb9cada2015-12-08 15:45:58 -0700382/* Layer-2 (e.g. Ethernet) interface class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400383typedef struct _vnet_hw_interface_class
384{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700385 /* Index into main vector. */
386 u32 index;
387
388 /* Class name (e.g. "Ethernet"). */
Dave Barachba868bb2016-08-08 09:51:21 -0400389 char *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700390
Neale Rannsb80c5362016-10-08 13:03:40 +0100391 /* Flags */
392 vnet_hw_interface_class_flags_t flags;
393
Ed Warnickecb9cada2015-12-08 15:45:58 -0700394 /* Function to call when hardware interface is added/deleted. */
Dave Barachba868bb2016-08-08 09:51:21 -0400395 vnet_interface_function_t *interface_add_del_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700396
397 /* Function to bring interface administratively up/down. */
Dave Barachba868bb2016-08-08 09:51:21 -0400398 vnet_interface_function_t *admin_up_down_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700399
400 /* Function to call when link state changes. */
Dave Barachba868bb2016-08-08 09:51:21 -0400401 vnet_interface_function_t *link_up_down_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700402
Neale Ranns3be6b282016-12-20 14:24:01 +0000403 /* Function to call when link MAC changes. */
404 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
405
Matthew Smithe0792fd2019-07-12 11:48:24 -0500406 /* Function to add/delete additional MAC addresses */
407 vnet_interface_add_del_mac_address_function_t *mac_addr_add_del_function;
408
Ed Warnickecb9cada2015-12-08 15:45:58 -0700409 /* Format function to display interface name. */
Dave Barachba868bb2016-08-08 09:51:21 -0400410 format_function_t *format_interface_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700411
412 /* Format function to display interface address. */
Dave Barachba868bb2016-08-08 09:51:21 -0400413 format_function_t *format_address;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700414
415 /* Format packet header for this interface class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400416 format_function_t *format_header;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700417
418 /* Format device verbosely for this class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400419 format_function_t *format_device;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700420
421 /* Parser for hardware (e.g. ethernet) address. */
Dave Barachba868bb2016-08-08 09:51:21 -0400422 unformat_function_t *unformat_hw_address;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700423
424 /* Parser for packet header for e.g. rewrite string. */
Dave Barachba868bb2016-08-08 09:51:21 -0400425 unformat_function_t *unformat_header;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700426
Neale Rannsb80c5362016-10-08 13:03:40 +0100427 /* Builds a rewrite string for the interface to the destination
428 * for the payload/link type. */
429 u8 *(*build_rewrite) (struct vnet_main_t * vnm,
430 u32 sw_if_index,
431 vnet_link_t link_type, const void *dst_hw_address);
432
Paul Vinciguerrabdc0e6b2018-09-22 05:32:50 -0700433 /* Update an adjacency added by FIB (as opposed to via the
Neale Rannsb80c5362016-10-08 13:03:40 +0100434 * neighbour resolution protocol). */
435 void (*update_adjacency) (struct vnet_main_t * vnm,
436 u32 sw_if_index, u32 adj_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700437
Dave Barachba868bb2016-08-08 09:51:21 -0400438 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
439 u32 hw_if_index,
440 u32 hw_class_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700441
442 /* Called when hw interface class is changed and old hardware instance
443 may want to be deleted. */
Dave Barachba868bb2016-08-08 09:51:21 -0400444 void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
445 u32 old_class_index, u32 new_class_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700446
447 /* List of hw interface classes, built by constructors */
Dave Barachba868bb2016-08-08 09:51:21 -0400448 struct _vnet_hw_interface_class *next_class_registration;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700449
450} vnet_hw_interface_class_t;
451
Neale Rannsb80c5362016-10-08 13:03:40 +0100452/**
Dave Barach11fb09e2020-08-06 12:10:09 -0400453 * @brief Return a complete, zero-length (aka placeholder) rewrite
Neale Rannsb80c5362016-10-08 13:03:40 +0100454 */
455extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
456 u32 sw_if_index,
457 vnet_link_t link_type,
458 const void *dst_hw_address);
459
460/**
461 * @brief Default adjacency update function
462 */
463extern void default_update_adjacency (struct vnet_main_t *vnm,
464 u32 sw_if_index, u32 adj_index);
465
Ed Warnickecb9cada2015-12-08 15:45:58 -0700466#define VNET_HW_INTERFACE_CLASS(x,...) \
467 __VA_ARGS__ vnet_hw_interface_class_t x; \
468static void __vnet_add_hw_interface_class_registration_##x (void) \
469 __attribute__((__constructor__)) ; \
470static void __vnet_add_hw_interface_class_registration_##x (void) \
471{ \
472 vnet_main_t * vnm = vnet_get_main(); \
473 x.next_class_registration = vnm->hw_interface_class_registrations; \
474 vnm->hw_interface_class_registrations = &x; \
475} \
Damjan Marion72d2c4f2018-04-05 21:32:29 +0200476static void __vnet_rm_hw_interface_class_registration_##x (void) \
477 __attribute__((__destructor__)) ; \
478static void __vnet_rm_hw_interface_class_registration_##x (void) \
479{ \
480 vnet_main_t * vnm = vnet_get_main(); \
481 VLIB_REMOVE_FROM_LINKED_LIST (vnm->hw_interface_class_registrations,\
482 &x, next_class_registration); \
483} \
Ed Warnickecb9cada2015-12-08 15:45:58 -0700484__VA_ARGS__ vnet_hw_interface_class_t x
485
Neale Ranns6e43e062018-10-26 05:17:03 -0700486typedef enum vnet_hw_interface_flags_t_
Dave Barachba868bb2016-08-08 09:51:21 -0400487{
Neale Rannsb3a93812018-10-29 01:55:24 -0700488 VNET_HW_INTERFACE_FLAG_NONE,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700489 /* Hardware link state is up. */
Neale Ranns6e43e062018-10-26 05:17:03 -0700490 VNET_HW_INTERFACE_FLAG_LINK_UP = (1 << 0),
Ed Warnickecb9cada2015-12-08 15:45:58 -0700491 /* Hardware duplex state */
Neale Ranns6e43e062018-10-26 05:17:03 -0700492 VNET_HW_INTERFACE_FLAG_HALF_DUPLEX = (1 << 1),
493 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX = (1 << 2),
494
Neale Ranns6e43e062018-10-26 05:17:03 -0700495 /* rx mode flags */
496 VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE = (1 << 16),
497
498 /* tx checksum offload */
499 VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD = (1 << 17),
Andrew Yourtchenko6a7cff72018-10-12 16:09:22 +0200500
501 /* gso */
502 VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO = (1 << 18),
Neale Ranns5f8f6172019-04-18 10:23:56 +0000503
504 /* non-broadcast multiple access */
505 VNET_HW_INTERFACE_FLAG_NBMA = (1 << 19),
John Lo4a302ee2020-05-12 22:34:39 -0400506
507 /* hw/driver can switch between l2-promisc and l3-dmac-filter modes */
508 VNET_HW_INTERFACE_FLAG_SUPPORTS_MAC_FILTER = (1 << 20),
Neale Ranns6e43e062018-10-26 05:17:03 -0700509} vnet_hw_interface_flags_t;
510
511#define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
512#define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT 3
Ed Warnickecb9cada2015-12-08 15:45:58 -0700513#define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK \
514 (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX | \
515 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700516
Neale Ranns6e43e062018-10-26 05:17:03 -0700517/* Hardware-interface. This corresponds to a physical wire
518 that packets flow over. */
519typedef struct vnet_hw_interface_t
520{
Dave Barachf5667c32019-09-25 11:27:46 -0400521 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Neale Ranns6e43e062018-10-26 05:17:03 -0700522 /* Interface name. */
523 u8 *name;
Damjan Marion44036902017-04-28 12:29:15 +0200524
Neale Ranns6e43e062018-10-26 05:17:03 -0700525 /* flags */
526 vnet_hw_interface_flags_t flags;
Dave Barach2c0a4f42017-06-29 09:30:15 -0400527
Damjan Marion5100aa92018-11-08 15:30:16 +0100528
529 /* link speed in kbps */
530 u32 link_speed;
531
Ed Warnickecb9cada2015-12-08 15:45:58 -0700532 /* Hardware address as vector. Zero (e.g. zero-length vector) if no
533 address for this class (e.g. PPP). */
Dave Barachba868bb2016-08-08 09:51:21 -0400534 u8 *hw_address;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700535
536 /* Interface is up as far as software is concerned. */
537 /* NAME.{output,tx} nodes for this interface. */
538 u32 output_node_index, tx_node_index;
539
540 /* (dev_class, dev_instance) uniquely identifies hw interface. */
541 u32 dev_class_index;
542 u32 dev_instance;
543
544 /* (hw_class, hw_instance) uniquely identifies hw interface. */
545 u32 hw_class_index;
546 u32 hw_instance;
547
548 /* Hardware index for this hardware interface. */
549 u32 hw_if_index;
550
551 /* Software index for this hardware interface. */
552 u32 sw_if_index;
553
John Loe5453d02018-01-23 19:21:34 -0500554 /* Next index in interface-output node for this interface
555 used by node function vnet_per_buffer_interface_output() */
556 u32 output_node_next_index;
557
Ed Warnickecb9cada2015-12-08 15:45:58 -0700558 /* Maximum transmit rate for this interface in bits/sec. */
559 f64 max_rate_bits_per_sec;
560
Mohsin Kazmif2ba9aa2016-04-24 18:53:42 +0200561 /* Smallest packet size supported by this interface. */
562 u32 min_supported_packet_bytes;
563
564 /* Largest packet size supported by this interface. */
565 u32 max_supported_packet_bytes;
566
Ed Warnickecb9cada2015-12-08 15:45:58 -0700567 /* Smallest packet size for this interface. */
568 u32 min_packet_bytes;
569
570 /* Largest packet size for this interface. */
571 u32 max_packet_bytes;
572
Ed Warnickecb9cada2015-12-08 15:45:58 -0700573 /* Hash table mapping sub interface id to sw_if_index. */
Dave Barachba868bb2016-08-08 09:51:21 -0400574 uword *sub_interface_sw_if_index_by_id;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700575
John Lo4a302ee2020-05-12 22:34:39 -0400576 /* Count of number of L2 and L3 subinterfaces */
Ed Warnickecb9cada2015-12-08 15:45:58 -0700577 u32 l2_if_count;
John Lo4a302ee2020-05-12 22:34:39 -0400578 u32 l3_if_count;
John Lobcebbb92016-04-05 15:47:43 -0400579
580 /* Bonded interface info -
581 0 - not a bonded interface nor a slave
582 ~0 - slave to a bonded interface
583 others - A bonded interface with a pointer to bitmap for all slaves */
584 uword *bond_info;
585#define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
586#define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
587
Damjan Marioneb743fa2017-03-20 16:34:15 +0100588 /* Input node */
589 u32 input_node_index;
590
591 /* input node cpu index by queue */
Damjan Marion586afd72017-04-05 19:18:20 +0200592 u32 *input_node_thread_index_by_queue;
Damjan Marioneb743fa2017-03-20 16:34:15 +0100593
Damjan Marion44036902017-04-28 12:29:15 +0200594 /* vnet_hw_interface_rx_mode by queue */
595 u8 *rx_mode_by_queue;
Damjan Marion4e53a0d2017-06-21 14:29:44 +0200596 vnet_hw_interface_rx_mode default_rx_mode;
Damjan Marion44036902017-04-28 12:29:15 +0200597
Damjan Marion153646e2017-04-05 18:15:45 +0200598 /* device input device_and_queue runtime index */
599 uword *dq_runtime_index_by_queue;
600
Zhiyong Yang6865d3c2019-05-15 04:25:20 -0400601 /* numa node that hardware device connects to */
602 u8 numa_node;
603
Dave Barachf5667c32019-09-25 11:27:46 -0400604 /* trace */
605 i32 n_trace;
606
607 u32 trace_classify_table_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700608} vnet_hw_interface_t;
609
Damjan Marion3d9c86e2016-07-04 21:04:40 +0200610extern vnet_device_class_t vnet_local_interface_device_class;
611
Dave Barachba868bb2016-08-08 09:51:21 -0400612typedef enum
613{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700614 /* A hw interface. */
615 VNET_SW_INTERFACE_TYPE_HARDWARE,
616
617 /* A sub-interface. */
618 VNET_SW_INTERFACE_TYPE_SUB,
Pavel Kotucek15ac81c2017-06-20 14:00:26 +0200619 VNET_SW_INTERFACE_TYPE_P2P,
Neale Ranns17ff3c12018-07-04 10:24:24 -0700620 VNET_SW_INTERFACE_TYPE_PIPE,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700621} vnet_sw_interface_type_t;
622
Dave Barachba868bb2016-08-08 09:51:21 -0400623typedef struct
624{
625 /*
626 * Subinterface ID. A number 0-N to uniquely identify
627 * this subinterface under the main (parent?) interface
628 */
629 u32 id;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700630
Dave Barachba868bb2016-08-08 09:51:21 -0400631 /* Classification data. Used to associate packet header with subinterface. */
632 struct
633 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700634 u16 outer_vlan_id;
635 u16 inner_vlan_id;
Dave Barachba868bb2016-08-08 09:51:21 -0400636 union
637 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700638 u16 raw_flags;
Dave Barachba868bb2016-08-08 09:51:21 -0400639 struct
640 {
641 u16 no_tags:1;
642 u16 one_tag:1;
643 u16 two_tags:1;
644 u16 dot1ad:1; /* 0 = dot1q, 1=dot1ad */
645 u16 exact_match:1;
646 u16 default_sub:1;
647 u16 outer_vlan_id_any:1;
648 u16 inner_vlan_id_any:1;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700649 } flags;
650 };
651 } eth;
652} vnet_sub_interface_t;
653
Pavel Kotucek15ac81c2017-06-20 14:00:26 +0200654typedef struct
655{
656 /*
657 * Subinterface ID. A number 0-N to uniquely identify
658 * this subinterface under the main interface
659 */
660 u32 id;
661 u32 pool_index;
662 u8 client_mac[6];
663} vnet_p2p_sub_interface_t;
664
Eyal Baric5b13602016-11-24 19:42:43 +0200665typedef enum
666{
Neale Ranns87dad112018-04-09 01:53:01 -0700667 /* THe BVI interface */
668 VNET_FLOOD_CLASS_BVI,
Eyal Baric5b13602016-11-24 19:42:43 +0200669 /* Always flood */
670 VNET_FLOOD_CLASS_NORMAL,
671 VNET_FLOOD_CLASS_TUNNEL_MASTER,
672 /* Does not flood when tunnel master is in the same L2 BD */
Neale Ranns87dad112018-04-09 01:53:01 -0700673 VNET_FLOOD_CLASS_TUNNEL_NORMAL,
674 /* Never flood to this type */
675 VNET_FLOOD_CLASS_NO_FLOOD,
Eyal Baric5b13602016-11-24 19:42:43 +0200676} vnet_flood_class_t;
677
Ole Troand7231612018-06-07 10:17:57 +0200678/* Per protocol MTU */
679typedef enum
680{
681 VNET_MTU_L3, /* Default payload MTU (without L2 headers) */
682 VNET_MTU_IP4, /* Per-protocol MTUs overriding default */
683 VNET_MTU_IP6,
684 VNET_MTU_MPLS,
685 VNET_N_MTU
686} vnet_mtu_t;
687
688extern vnet_mtu_t vnet_link_to_mtu (vnet_link_t link);
689
Neale Ranns1855b8e2018-07-11 10:31:26 -0700690typedef enum vnet_sw_interface_flags_t_
691{
Neale Rannsb3a93812018-10-29 01:55:24 -0700692 VNET_SW_INTERFACE_FLAG_NONE = 0,
Paul Vinciguerrabdc0e6b2018-09-22 05:32:50 -0700693 /* Interface is "up" meaning administratively up.
Neale Ranns1855b8e2018-07-11 10:31:26 -0700694 Up in the sense of link state being up is maintained by hardware interface. */
695 VNET_SW_INTERFACE_FLAG_ADMIN_UP = (1 << 0),
696
697 /* Interface is disabled for forwarding: punt all traffic to slow-path. */
698 VNET_SW_INTERFACE_FLAG_PUNT = (1 << 1),
699
Neale Ranns57e53bb2019-05-29 13:58:43 +0000700 __VNET_SW_INTERFACE_FLAG_UNSUED = (1 << 2),
Neale Ranns1855b8e2018-07-11 10:31:26 -0700701
702 VNET_SW_INTERFACE_FLAG_UNNUMBERED = (1 << 3),
703
Steven Luong5ad541e2019-08-27 07:43:27 -0700704 __VNET_SW_INTERFACE_FLAG_UNUSED2 = (1 << 4),
Neale Ranns1855b8e2018-07-11 10:31:26 -0700705
706 /* Interface does not appear in CLI/API */
707 VNET_SW_INTERFACE_FLAG_HIDDEN = (1 << 5),
708
709 /* Interface in ERROR state */
710 VNET_SW_INTERFACE_FLAG_ERROR = (1 << 6),
711
712 /* Interface has IP configured directed broadcast */
713 VNET_SW_INTERFACE_FLAG_DIRECTED_BCAST = (1 << 7),
714
715} __attribute__ ((packed)) vnet_sw_interface_flags_t;
716
Ed Warnickecb9cada2015-12-08 15:45:58 -0700717/* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
718 tunnel, etc. Configuration (e.g. IP address) gets attached to
719 software interface. */
Dave Barachba868bb2016-08-08 09:51:21 -0400720typedef struct
721{
722 vnet_sw_interface_type_t type:16;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700723
Neale Ranns1855b8e2018-07-11 10:31:26 -0700724 vnet_sw_interface_flags_t flags;
Damjan Marionabce5092017-05-10 20:09:31 +0200725
Ed Warnickecb9cada2015-12-08 15:45:58 -0700726 /* Index for this interface. */
727 u32 sw_if_index;
728
729 /* Software interface index of super-interface;
730 equal to sw_if_index if this interface is not a
731 sub-interface. */
732 u32 sup_sw_if_index;
733
734 /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
735 u32 unnumbered_sw_if_index;
736
Damjan Mariona8ab5682018-05-10 20:26:36 +0200737 /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
738 u32 hw_if_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700739
Ole Troand7231612018-06-07 10:17:57 +0200740 /* MTU for network layer (not including L2 headers) */
741 u32 mtu[VNET_N_MTU];
742
Damjan Mariona8ab5682018-05-10 20:26:36 +0200743 /* VNET_SW_INTERFACE_TYPE_SUB. */
744 vnet_sub_interface_t sub;
Pavel Kotucek15ac81c2017-06-20 14:00:26 +0200745
Damjan Mariona8ab5682018-05-10 20:26:36 +0200746 /* VNET_SW_INTERFACE_TYPE_P2P. */
747 vnet_p2p_sub_interface_t p2p;
Eyal Baric5b13602016-11-24 19:42:43 +0200748
749 vnet_flood_class_t flood_class;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700750} vnet_sw_interface_t;
751
Dave Barachba868bb2016-08-08 09:51:21 -0400752typedef enum
753{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700754 /* Simple counters. */
755 VNET_INTERFACE_COUNTER_DROP = 0,
756 VNET_INTERFACE_COUNTER_PUNT = 1,
757 VNET_INTERFACE_COUNTER_IP4 = 2,
758 VNET_INTERFACE_COUNTER_IP6 = 3,
759 VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
760 VNET_INTERFACE_COUNTER_RX_MISS = 5,
761 VNET_INTERFACE_COUNTER_RX_ERROR = 6,
762 VNET_INTERFACE_COUNTER_TX_ERROR = 7,
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100763 VNET_INTERFACE_COUNTER_MPLS = 8,
764 VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700765 /* Combined counters. */
766 VNET_INTERFACE_COUNTER_RX = 0,
Neale Ranns871dc422018-03-29 01:28:09 -0700767 VNET_INTERFACE_COUNTER_RX_UNICAST = 1,
768 VNET_INTERFACE_COUNTER_RX_MULTICAST = 2,
769 VNET_INTERFACE_COUNTER_RX_BROADCAST = 3,
770 VNET_INTERFACE_COUNTER_TX = 4,
771 VNET_INTERFACE_COUNTER_TX_UNICAST = 5,
772 VNET_INTERFACE_COUNTER_TX_MULTICAST = 6,
Neale Ranns6f4a6be2018-03-16 16:26:21 -0700773 VNET_INTERFACE_COUNTER_TX_BROADCAST = 7,
774 VNET_N_COMBINED_INTERFACE_COUNTER = 8,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700775} vnet_interface_counter_type_t;
776
Neale Ranns871dc422018-03-29 01:28:09 -0700777#define foreach_rx_combined_interface_counter(_x) \
778 for (_x = VNET_INTERFACE_COUNTER_RX; \
779 _x <= VNET_INTERFACE_COUNTER_RX_BROADCAST; \
780 _x++)
781
782#define foreach_tx_combined_interface_counter(_x) \
783 for (_x = VNET_INTERFACE_COUNTER_TX; \
784 _x <= VNET_INTERFACE_COUNTER_TX_BROADCAST; \
785 _x++)
Neale Ranns6f4a6be2018-03-16 16:26:21 -0700786
Ole Troan1ec0ea82018-06-14 09:28:27 +0200787#define foreach_simple_interface_counter_name \
788 _(DROP, drops, if) \
789 _(PUNT, punt, if) \
790 _(IP4, ip4, if) \
791 _(IP6, ip6, if) \
792 _(RX_NO_BUF, rx-no-buf, if) \
793 _(RX_MISS, rx-miss, if) \
794 _(RX_ERROR, rx-error, if) \
Paul Vinciguerra8b5d0b82019-01-21 08:48:21 -0800795 _(TX_ERROR, tx-error, if) \
796 _(MPLS, mpls, if)
Ole Troan1ec0ea82018-06-14 09:28:27 +0200797
798#define foreach_combined_interface_counter_name \
799 _(RX, rx, if) \
800 _(RX_UNICAST, rx-unicast, if) \
801 _(RX_MULTICAST, rx-multicast, if) \
802 _(RX_BROADCAST, rx-broadcast, if) \
803 _(TX, tx, if) \
Ole Troan712dde92019-04-11 09:08:39 +0200804 _(TX_UNICAST, tx-unicast, if) \
Ole Troan1ec0ea82018-06-14 09:28:27 +0200805 _(TX_MULTICAST, tx-multicast, if) \
806 _(TX_BROADCAST, tx-broadcast, if)
807
Neale Ranns6f4a6be2018-03-16 16:26:21 -0700808typedef enum
809{
810 COLLECT_SIMPLE_STATS = 0,
811 COLLECT_DETAILED_STATS = 1,
812} vnet_interface_stats_collection_mode_e;
813
814extern int collect_detailed_interface_stats_flag;
815
816static inline int
Neale Rannsf704f382018-03-19 12:24:07 -0400817collect_detailed_interface_stats (void)
Neale Ranns6f4a6be2018-03-16 16:26:21 -0700818{
819 return collect_detailed_interface_stats_flag;
820}
821
Neale Rannsf704f382018-03-19 12:24:07 -0400822void collect_detailed_interface_stats_flag_set (void);
823void collect_detailed_interface_stats_flag_clear (void);
Neale Ranns6f4a6be2018-03-16 16:26:21 -0700824
825
Dave Barachba868bb2016-08-08 09:51:21 -0400826typedef struct
827{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700828 u32 output_node_index;
829 u32 tx_node_index;
830} vnet_hw_interface_nodes_t;
831
Dave Barachba868bb2016-08-08 09:51:21 -0400832typedef struct
833{
Vijayabhaskar Katamreddye3bbf5b2019-06-28 12:59:23 -0700834 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Andrew Yourtchenko6a7cff72018-10-12 16:09:22 +0200835 u32 *split_buffers;
Andrew Yourtchenko6a7cff72018-10-12 16:09:22 +0200836} vnet_interface_per_thread_data_t;
837
Florin Coras3ffe6ca2019-06-26 16:27:13 -0700838typedef u8 *(*vnet_buffer_opquae_formatter_t) (const vlib_buffer_t * b,
839 u8 * s);
840
Andrew Yourtchenko6a7cff72018-10-12 16:09:22 +0200841typedef struct
842{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700843 /* Hardware interfaces. */
Dave Barachba868bb2016-08-08 09:51:21 -0400844 vnet_hw_interface_t *hw_interfaces;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700845
846 /* Hash table mapping HW interface name to index. */
Dave Barachba868bb2016-08-08 09:51:21 -0400847 uword *hw_interface_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700848
849 /* Vectors if hardware interface classes and device classes. */
Dave Barachba868bb2016-08-08 09:51:21 -0400850 vnet_hw_interface_class_t *hw_interface_classes;
851 vnet_device_class_t *device_classes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700852
853 /* Hash table mapping name to hw interface/device class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400854 uword *hw_interface_class_by_name;
855 uword *device_class_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700856
857 /* Software interfaces. */
Dave Barachba868bb2016-08-08 09:51:21 -0400858 vnet_sw_interface_t *sw_interfaces;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700859
860 /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
Dave Barachba868bb2016-08-08 09:51:21 -0400861 uword *sw_if_index_by_sup_and_sub;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700862
863 /* Software interface counters both simple and combined
864 packet and byte counters. */
jaszha035cdde5c2019-07-11 20:47:24 +0000865 clib_spinlock_t sw_if_counter_lock;
Dave Barachba868bb2016-08-08 09:51:21 -0400866 vlib_simple_counter_main_t *sw_if_counters;
867 vlib_combined_counter_main_t *combined_sw_if_counters;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700868
Dave Barachba868bb2016-08-08 09:51:21 -0400869 vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700870
Dave Barach33909772019-09-23 10:27:27 -0400871 /*
872 * pcap drop tracing
873 * Only the drop filter hash lives here. See ../src/vlib/main.h for
874 * the rest of the variables.
875 */
Dave Barachba868bb2016-08-08 09:51:21 -0400876 uword *pcap_drop_filter_hash;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700877
Florin Coras3ffe6ca2019-06-26 16:27:13 -0700878 /* Buffer metadata format helper functions */
879 vnet_buffer_opquae_formatter_t *buffer_opaque_format_helpers;
880 vnet_buffer_opquae_formatter_t *buffer_opaque2_format_helpers;
881
Andrew Yourtchenko6a7cff72018-10-12 16:09:22 +0200882 /* per-thread data */
883 vnet_interface_per_thread_data_t *per_thread_data;
884
Damjan Marion152e21d2016-11-29 14:55:43 +0100885 /* feature_arc_index */
886 u8 output_feature_arc_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700887} vnet_interface_main_t;
888
Dave Barachba868bb2016-08-08 09:51:21 -0400889static inline void
890vnet_interface_counter_lock (vnet_interface_main_t * im)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700891{
892 if (im->sw_if_counter_lock)
jaszha035cdde5c2019-07-11 20:47:24 +0000893 clib_spinlock_lock (&im->sw_if_counter_lock);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700894}
Dave Barachba868bb2016-08-08 09:51:21 -0400895
896static inline void
897vnet_interface_counter_unlock (vnet_interface_main_t * im)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700898{
899 if (im->sw_if_counter_lock)
jaszha035cdde5c2019-07-11 20:47:24 +0000900 clib_spinlock_unlock (&im->sw_if_counter_lock);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700901}
902
903void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
904
905int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
906
Damjan Marion652d2e12019-02-02 00:15:27 +0100907uword vnet_interface_output_node (vlib_main_t * vm,
908 vlib_node_runtime_t * node,
909 vlib_frame_t * frame);
910
Florin Coras3ffe6ca2019-06-26 16:27:13 -0700911void vnet_register_format_buffer_opaque_helper
912 (vnet_buffer_opquae_formatter_t fn);
913
914void vnet_register_format_buffer_opaque2_helper
915 (vnet_buffer_opquae_formatter_t fn);
916
Dave Barachb97641c2019-09-09 16:38:17 -0400917typedef struct
918{
919 u8 *filename;
920 int enable;
921 int status;
922 u32 packets_to_capture;
Dave Barach33909772019-09-23 10:27:27 -0400923 u32 max_bytes_per_pkt;
924 u8 rx_enable;
925 u8 tx_enable;
926 u8 drop_enable;
Dave Barach586462f2020-08-05 16:12:35 -0400927 u8 preallocate_data;
928 u8 free_data;
Dave Barachb97641c2019-09-09 16:38:17 -0400929 u32 sw_if_index;
Dave Barach9137e542019-09-13 17:47:50 -0400930 int filter;
Dave Barachb97641c2019-09-09 16:38:17 -0400931} vnet_pcap_dispatch_trace_args_t;
932
933int vnet_pcap_dispatch_trace_configure (vnet_pcap_dispatch_trace_args_t *);
934
Ed Warnickecb9cada2015-12-08 15:45:58 -0700935#endif /* included_vnet_interface_h */
Dave Barachba868bb2016-08-08 09:51:21 -0400936
937/*
938 * fd.io coding-style-patch-verification: ON
939 *
940 * Local Variables:
941 * eval: (c-set-style "gnu")
942 * End:
943 */