blob: 095fe9617e2d7430bcb2e65776c6890d8d20b5e6 [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
43#include <vnet/unix/pcap.h>
Neale Rannsb80c5362016-10-08 13:03:40 +010044#include <vnet/l3_types.h>
Ed Warnickecb9cada2015-12-08 15:45:58 -070045
46struct vnet_main_t;
47struct vnet_hw_interface_t;
48struct vnet_sw_interface_t;
Neale Rannsb80c5362016-10-08 13:03:40 +010049struct ip46_address_t;
Ed Warnickecb9cada2015-12-08 15:45:58 -070050
Stevene3a395c2017-05-09 16:19:50 -070051typedef enum
52{
53 VNET_HW_INTERFACE_RX_MODE_UNKNOWN,
54 VNET_HW_INTERFACE_RX_MODE_POLLING,
55 VNET_HW_INTERFACE_RX_MODE_INTERRUPT,
56 VNET_HW_INTERFACE_RX_MODE_ADAPTIVE,
57 VNET_HW_INTERFACE_NUM_RX_MODES,
58} vnet_hw_interface_rx_mode;
59
Ed Warnickecb9cada2015-12-08 15:45:58 -070060/* Interface up/down callback. */
Dave Barachba868bb2016-08-08 09:51:21 -040061typedef clib_error_t *(vnet_interface_function_t)
Ed Warnickecb9cada2015-12-08 15:45:58 -070062 (struct vnet_main_t * vnm, u32 if_index, u32 flags);
63
64/* Sub-interface add/del callback. */
Dave Barachba868bb2016-08-08 09:51:21 -040065typedef clib_error_t *(vnet_subif_add_del_function_t)
Ed Warnickecb9cada2015-12-08 15:45:58 -070066 (struct vnet_main_t * vnm, u32 if_index,
Dave Barachba868bb2016-08-08 09:51:21 -040067 struct vnet_sw_interface_t * template, int is_add);
Ed Warnickecb9cada2015-12-08 15:45:58 -070068
Pavel Kotucekc631f2d2016-09-26 10:40:02 +020069/* Interface set mac address callback. */
70typedef clib_error_t *(vnet_interface_set_mac_address_function_t)
71 (struct vnet_hw_interface_t * hi, char *address);
72
Stevene3a395c2017-05-09 16:19:50 -070073/* Interface set rx mode callback. */
74typedef clib_error_t *(vnet_interface_set_rx_mode_function_t)
75 (struct vnet_main_t * vnm, u32 if_index, u32 queue_id,
76 vnet_hw_interface_rx_mode mode);
77
Neale Ranns8b37b872016-11-21 12:25:22 +000078typedef enum vnet_interface_function_priority_t_
79{
80 VNET_ITF_FUNC_PRIORITY_LOW,
81 VNET_ITF_FUNC_PRIORITY_HIGH,
82} vnet_interface_function_priority_t;
83#define VNET_ITF_FUNC_N_PRIO ((vnet_interface_function_priority_t)VNET_ITF_FUNC_PRIORITY_HIGH+1)
84
Dave Barachba868bb2016-08-08 09:51:21 -040085typedef struct _vnet_interface_function_list_elt
86{
87 struct _vnet_interface_function_list_elt *next_interface_function;
88 clib_error_t *(*fp) (struct vnet_main_t * vnm, u32 if_index, u32 flags);
Ed Warnickecb9cada2015-12-08 15:45:58 -070089} _vnet_interface_function_list_elt_t;
90
91#define _VNET_INTERFACE_FUNCTION_DECL(f,tag) \
92 \
93static void __vnet_interface_function_init_##tag##_##f (void) \
94 __attribute__((__constructor__)) ; \
95 \
96static void __vnet_interface_function_init_##tag##_##f (void) \
97{ \
98 vnet_main_t * vnm = vnet_get_main(); \
99 static _vnet_interface_function_list_elt_t init_function; \
Neale Ranns8b37b872016-11-21 12:25:22 +0000100 init_function.next_interface_function = \
101 vnm->tag##_functions[VNET_ITF_FUNC_PRIORITY_LOW]; \
102 vnm->tag##_functions[VNET_ITF_FUNC_PRIORITY_LOW] = &init_function; \
103 init_function.fp = (void *) &f; \
104}
105
106#define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
107 \
108static void __vnet_interface_function_init_##tag##_##f (void) \
109 __attribute__((__constructor__)) ; \
110 \
111static void __vnet_interface_function_init_##tag##_##f (void) \
112{ \
113 vnet_main_t * vnm = vnet_get_main(); \
114 static _vnet_interface_function_list_elt_t init_function; \
115 init_function.next_interface_function = vnm->tag##_functions[p]; \
116 vnm->tag##_functions[p] = &init_function; \
Ed Warnickecb9cada2015-12-08 15:45:58 -0700117 init_function.fp = (void *) &f; \
Dave Barachba868bb2016-08-08 09:51:21 -0400118}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700119
120#define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f) \
121 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
122#define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f) \
123 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
Neale Ranns8b37b872016-11-21 12:25:22 +0000124#define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(f,p) \
125 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,hw_interface_link_up_down,p)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700126#define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f) \
127 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
128#define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f) \
129 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
Neale Ranns8b37b872016-11-21 12:25:22 +0000130#define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(f,p) \
131 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_admin_up_down, p)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700132
133/* A class of hardware interface devices. */
Dave Barachba868bb2016-08-08 09:51:21 -0400134typedef struct _vnet_device_class
135{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700136 /* Index into main vector. */
137 u32 index;
138
139 /* Device name (e.g. "FOOBAR 1234a"). */
Dave Barachba868bb2016-08-08 09:51:21 -0400140 char *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700141
142 /* Function to call when hardware interface is added/deleted. */
Dave Barachba868bb2016-08-08 09:51:21 -0400143 vnet_interface_function_t *interface_add_del_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700144
145 /* Function to bring device administratively up/down. */
Dave Barachba868bb2016-08-08 09:51:21 -0400146 vnet_interface_function_t *admin_up_down_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700147
148 /* Function to call when sub-interface is added/deleted */
Dave Barachba868bb2016-08-08 09:51:21 -0400149 vnet_subif_add_del_function_t *subif_add_del_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700150
Stevene3a395c2017-05-09 16:19:50 -0700151 /* Function to call interface rx mode is changed */
152 vnet_interface_set_rx_mode_function_t *rx_mode_change_function;
153
Ed Warnickecb9cada2015-12-08 15:45:58 -0700154 /* Redistribute flag changes/existence of this interface class. */
155 u32 redistribute;
156
157 /* Transmit function. */
Dave Barachba868bb2016-08-08 09:51:21 -0400158 vlib_node_function_t *tx_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700159
160 /* Error strings indexed by error code for this node. */
Dave Barachba868bb2016-08-08 09:51:21 -0400161 char **tx_function_error_strings;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700162
163 /* Number of error codes used by this node. */
164 u32 tx_function_n_errors;
165
166 /* Renumber device name [only!] support, a control-plane kludge */
Dave Barachba868bb2016-08-08 09:51:21 -0400167 int (*name_renumber) (struct vnet_hw_interface_t * hi,
168 u32 new_dev_instance);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700169
170 /* Format device instance as name. */
Dave Barachba868bb2016-08-08 09:51:21 -0400171 format_function_t *format_device_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700172
173 /* Parse function for device name. */
Dave Barachba868bb2016-08-08 09:51:21 -0400174 unformat_function_t *unformat_device_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700175
176 /* Format device verbosely for this class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400177 format_function_t *format_device;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700178
179 /* Trace buffer format for TX function. */
Dave Barachba868bb2016-08-08 09:51:21 -0400180 format_function_t *format_tx_trace;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700181
182 /* Function to clear hardware counters for device. */
Dave Barachba868bb2016-08-08 09:51:21 -0400183 void (*clear_counters) (u32 dev_class_instance);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700184
Dave Barachba868bb2016-08-08 09:51:21 -0400185 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
186 u32 hw_if_index,
187 u32 hw_class_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700188
189 /* Called when hardware class of an interface changes. */
Dave Barachba868bb2016-08-08 09:51:21 -0400190 void (*hw_class_change) (struct vnet_main_t * vnm,
191 u32 hw_if_index, u32 new_hw_class_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700192
193 /* Called to redirect traffic from a specific interface instance */
Dave Barachba868bb2016-08-08 09:51:21 -0400194 void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
195 u32 hw_if_index, u32 node_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700196
197 /* Link-list of all device classes set up by constructors created below */
Dave Barachba868bb2016-08-08 09:51:21 -0400198 struct _vnet_device_class *next_class_registration;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700199
Damjan Marion8b2247d2016-12-02 08:09:45 +0100200 /* Splice vnet_interface_output_node into TX path */
201 u8 flatten_output_chains;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700202
Pavel Kotucekc631f2d2016-09-26 10:40:02 +0200203 /* Function to set mac address. */
204 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700205} vnet_device_class_t;
206
207#define VNET_DEVICE_CLASS(x,...) \
208 __VA_ARGS__ vnet_device_class_t x; \
209static void __vnet_add_device_class_registration_##x (void) \
210 __attribute__((__constructor__)) ; \
211static void __vnet_add_device_class_registration_##x (void) \
212{ \
213 vnet_main_t * vnm = vnet_get_main(); \
214 x.next_class_registration = vnm->device_class_registrations; \
215 vnm->device_class_registrations = &x; \
216} \
Dave Barachba868bb2016-08-08 09:51:21 -0400217__VA_ARGS__ vnet_device_class_t x
Ed Warnickecb9cada2015-12-08 15:45:58 -0700218
Damjan Marion1c80e832016-05-11 23:07:18 +0200219#define VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE(arch, fn, tgt) \
220 uword \
221 __attribute__ ((flatten)) \
222 __attribute__ ((target (tgt))) \
223 CLIB_CPU_OPTIMIZED \
224 fn ## _ ## arch ( vlib_main_t * vm, \
225 vlib_node_runtime_t * node, \
226 vlib_frame_t * frame) \
227 { return fn (vm, node, frame); }
228
229#define VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
230 foreach_march_variant(VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE, fn)
231
232#if CLIB_DEBUG > 0
233#define VLIB_MULTIARCH_CLONE_AND_SELECT_FN(fn,...)
234#define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn)
235#else
236#define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn) \
237 VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
238 CLIB_MULTIARCH_SELECT_FN(fn, static inline) \
239 static void __attribute__((__constructor__)) \
240 __vlib_device_tx_function_multiarch_select_##dev (void) \
241 { dev.tx_function = fn ## _multiarch_select(); }
242#endif
243
Neale Rannsb80c5362016-10-08 13:03:40 +0100244/**
245 * Link Type: A description of the protocol of packets on the link.
246 * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
247 * it maps to the GRE-proto, etc for other lnk types.
248 */
249typedef enum vnet_link_t_
250{
251#if CLIB_DEBUG > 0
252 VNET_LINK_IP4 = 1,
253#else
254 VNET_LINK_IP4 = 0,
255#endif
256 VNET_LINK_IP6,
257 VNET_LINK_MPLS,
258 VNET_LINK_ETHERNET,
259 VNET_LINK_ARP,
Florin Corasce1b4c72017-01-26 14:25:34 -0800260 VNET_LINK_NSH,
Neale Rannsb80c5362016-10-08 13:03:40 +0100261} __attribute__ ((packed)) vnet_link_t;
262
Neale Ranns924d03a2016-10-19 08:25:46 +0100263#define VNET_LINKS { \
264 [VNET_LINK_ETHERNET] = "ethernet", \
265 [VNET_LINK_IP4] = "ipv4", \
266 [VNET_LINK_IP6] = "ipv6", \
267 [VNET_LINK_MPLS] = "mpls", \
268 [VNET_LINK_ARP] = "arp", \
Florin Corasce1b4c72017-01-26 14:25:34 -0800269 [VNET_LINK_NSH] = "nsh", \
Neale Ranns924d03a2016-10-19 08:25:46 +0100270}
271
272/**
273 * @brief Number of link types. Not part of the enum so it does not have to be included in
274 * switch statements
275 */
Florin Corasce1b4c72017-01-26 14:25:34 -0800276#define VNET_LINK_NUM (VNET_LINK_NSH+1)
Neale Ranns924d03a2016-10-19 08:25:46 +0100277
Neale Rannsb80c5362016-10-08 13:03:40 +0100278/**
279 * @brief Convert a link to to an Ethertype
280 */
281extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
282
283/**
284 * @brief Attributes assignable to a HW interface Class.
285 */
286typedef enum vnet_hw_interface_class_flags_t_
287{
288 /**
289 * @brief a point 2 point interface
290 */
291 VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
292} vnet_hw_interface_class_flags_t;
Damjan Marion1c80e832016-05-11 23:07:18 +0200293
Ed Warnickecb9cada2015-12-08 15:45:58 -0700294/* Layer-2 (e.g. Ethernet) interface class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400295typedef struct _vnet_hw_interface_class
296{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700297 /* Index into main vector. */
298 u32 index;
299
300 /* Class name (e.g. "Ethernet"). */
Dave Barachba868bb2016-08-08 09:51:21 -0400301 char *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700302
Neale Rannsb80c5362016-10-08 13:03:40 +0100303 /* Flags */
304 vnet_hw_interface_class_flags_t flags;
305
Ed Warnickecb9cada2015-12-08 15:45:58 -0700306 /* Function to call when hardware interface is added/deleted. */
Dave Barachba868bb2016-08-08 09:51:21 -0400307 vnet_interface_function_t *interface_add_del_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700308
309 /* Function to bring interface administratively up/down. */
Dave Barachba868bb2016-08-08 09:51:21 -0400310 vnet_interface_function_t *admin_up_down_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700311
312 /* Function to call when link state changes. */
Dave Barachba868bb2016-08-08 09:51:21 -0400313 vnet_interface_function_t *link_up_down_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700314
Neale Ranns3be6b282016-12-20 14:24:01 +0000315 /* Function to call when link MAC changes. */
316 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
317
Ed Warnickecb9cada2015-12-08 15:45:58 -0700318 /* Format function to display interface name. */
Dave Barachba868bb2016-08-08 09:51:21 -0400319 format_function_t *format_interface_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700320
321 /* Format function to display interface address. */
Dave Barachba868bb2016-08-08 09:51:21 -0400322 format_function_t *format_address;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700323
324 /* Format packet header for this interface class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400325 format_function_t *format_header;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700326
327 /* Format device verbosely for this class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400328 format_function_t *format_device;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700329
330 /* Parser for hardware (e.g. ethernet) address. */
Dave Barachba868bb2016-08-08 09:51:21 -0400331 unformat_function_t *unformat_hw_address;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700332
333 /* Parser for packet header for e.g. rewrite string. */
Dave Barachba868bb2016-08-08 09:51:21 -0400334 unformat_function_t *unformat_header;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700335
Neale Rannsb80c5362016-10-08 13:03:40 +0100336 /* Builds a rewrite string for the interface to the destination
337 * for the payload/link type. */
338 u8 *(*build_rewrite) (struct vnet_main_t * vnm,
339 u32 sw_if_index,
340 vnet_link_t link_type, const void *dst_hw_address);
341
342 /* Update an adjacecny added by FIB (as opposed to via the
343 * neighbour resolution protocol). */
344 void (*update_adjacency) (struct vnet_main_t * vnm,
345 u32 sw_if_index, u32 adj_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700346
Dave Barachba868bb2016-08-08 09:51:21 -0400347 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
348 u32 hw_if_index,
349 u32 hw_class_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700350
351 /* Called when hw interface class is changed and old hardware instance
352 may want to be deleted. */
Dave Barachba868bb2016-08-08 09:51:21 -0400353 void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
354 u32 old_class_index, u32 new_class_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700355
356 /* List of hw interface classes, built by constructors */
Dave Barachba868bb2016-08-08 09:51:21 -0400357 struct _vnet_hw_interface_class *next_class_registration;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700358
359} vnet_hw_interface_class_t;
360
Neale Rannsb80c5362016-10-08 13:03:40 +0100361/**
362 * @brief Return a complete, zero-length (aka dummy) rewrite
363 */
364extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
365 u32 sw_if_index,
366 vnet_link_t link_type,
367 const void *dst_hw_address);
368
369/**
370 * @brief Default adjacency update function
371 */
372extern void default_update_adjacency (struct vnet_main_t *vnm,
373 u32 sw_if_index, u32 adj_index);
374
Ed Warnickecb9cada2015-12-08 15:45:58 -0700375#define VNET_HW_INTERFACE_CLASS(x,...) \
376 __VA_ARGS__ vnet_hw_interface_class_t x; \
377static void __vnet_add_hw_interface_class_registration_##x (void) \
378 __attribute__((__constructor__)) ; \
379static void __vnet_add_hw_interface_class_registration_##x (void) \
380{ \
381 vnet_main_t * vnm = vnet_get_main(); \
382 x.next_class_registration = vnm->hw_interface_class_registrations; \
383 vnm->hw_interface_class_registrations = &x; \
384} \
385__VA_ARGS__ vnet_hw_interface_class_t x
386
387/* Hardware-interface. This corresponds to a physical wire
388 that packets flow over. */
Dave Barachba868bb2016-08-08 09:51:21 -0400389typedef struct vnet_hw_interface_t
390{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700391 /* Interface name. */
Dave Barachba868bb2016-08-08 09:51:21 -0400392 u8 *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700393
394 u32 flags;
395 /* Hardware link state is up. */
396#define VNET_HW_INTERFACE_FLAG_LINK_UP (1 << 0)
397 /* Hardware duplex state */
398#define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
399#define VNET_HW_INTERFACE_FLAG_HALF_DUPLEX (1 << 1)
400#define VNET_HW_INTERFACE_FLAG_FULL_DUPLEX (1 << 2)
401#define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK \
402 (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX | \
403 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
404
405 /* Hardware link speed */
406#define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT 3
407#define VNET_HW_INTERFACE_FLAG_SPEED_10M (1 << 3)
408#define VNET_HW_INTERFACE_FLAG_SPEED_100M (1 << 4)
409#define VNET_HW_INTERFACE_FLAG_SPEED_1G (1 << 5)
410#define VNET_HW_INTERFACE_FLAG_SPEED_10G (1 << 6)
411#define VNET_HW_INTERFACE_FLAG_SPEED_40G (1 << 7)
412#define VNET_HW_INTERFACE_FLAG_SPEED_100G (1 << 8)
413#define VNET_HW_INTERFACE_FLAG_SPEED_MASK \
414 (VNET_HW_INTERFACE_FLAG_SPEED_10M | \
415 VNET_HW_INTERFACE_FLAG_SPEED_100M | \
416 VNET_HW_INTERFACE_FLAG_SPEED_1G | \
417 VNET_HW_INTERFACE_FLAG_SPEED_10G | \
418 VNET_HW_INTERFACE_FLAG_SPEED_40G | \
419 VNET_HW_INTERFACE_FLAG_SPEED_100G)
420
Damjan Mariondb2c6c62015-12-16 19:31:59 +0100421 /* l2output node flags */
422#define VNET_HW_INTERFACE_FLAG_L2OUTPUT_SHIFT 9
423#define VNET_HW_INTERFACE_FLAG_L2OUTPUT_MAPPED (1 << 9)
424
Damjan Marion44036902017-04-28 12:29:15 +0200425 /* rx mode flags */
426#define VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE (1 << 10)
427
Ed Warnickecb9cada2015-12-08 15:45:58 -0700428 /* Hardware address as vector. Zero (e.g. zero-length vector) if no
429 address for this class (e.g. PPP). */
Dave Barachba868bb2016-08-08 09:51:21 -0400430 u8 *hw_address;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700431
432 /* Interface is up as far as software is concerned. */
433 /* NAME.{output,tx} nodes for this interface. */
434 u32 output_node_index, tx_node_index;
435
436 /* (dev_class, dev_instance) uniquely identifies hw interface. */
437 u32 dev_class_index;
438 u32 dev_instance;
439
440 /* (hw_class, hw_instance) uniquely identifies hw interface. */
441 u32 hw_class_index;
442 u32 hw_instance;
443
444 /* Hardware index for this hardware interface. */
445 u32 hw_if_index;
446
447 /* Software index for this hardware interface. */
448 u32 sw_if_index;
449
450 /* Maximum transmit rate for this interface in bits/sec. */
451 f64 max_rate_bits_per_sec;
452
Mohsin Kazmif2ba9aa2016-04-24 18:53:42 +0200453 /* Smallest packet size supported by this interface. */
454 u32 min_supported_packet_bytes;
455
456 /* Largest packet size supported by this interface. */
457 u32 max_supported_packet_bytes;
458
Ed Warnickecb9cada2015-12-08 15:45:58 -0700459 /* Smallest packet size for this interface. */
460 u32 min_packet_bytes;
461
462 /* Largest packet size for this interface. */
463 u32 max_packet_bytes;
464
465 /* Number of extra bytes that go on the wire.
466 Packet length on wire
467 = max (length + per_packet_overhead_bytes, min_packet_bytes). */
468 u32 per_packet_overhead_bytes;
469
470 /* Receive and transmit layer 3 packet size limits (MRU/MTU). */
471 u32 max_l3_packet_bytes[VLIB_N_RX_TX];
472
473 /* Hash table mapping sub interface id to sw_if_index. */
Dave Barachba868bb2016-08-08 09:51:21 -0400474 uword *sub_interface_sw_if_index_by_id;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700475
476 /* Count of number of L2 subinterfaces */
477 u32 l2_if_count;
John Lobcebbb92016-04-05 15:47:43 -0400478
479 /* Bonded interface info -
480 0 - not a bonded interface nor a slave
481 ~0 - slave to a bonded interface
482 others - A bonded interface with a pointer to bitmap for all slaves */
483 uword *bond_info;
484#define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
485#define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
486
Damjan Marioneb743fa2017-03-20 16:34:15 +0100487 /* Input node */
488 u32 input_node_index;
489
490 /* input node cpu index by queue */
Damjan Marion586afd72017-04-05 19:18:20 +0200491 u32 *input_node_thread_index_by_queue;
Damjan Marioneb743fa2017-03-20 16:34:15 +0100492
Damjan Marion44036902017-04-28 12:29:15 +0200493 /* vnet_hw_interface_rx_mode by queue */
494 u8 *rx_mode_by_queue;
495
Damjan Marion153646e2017-04-05 18:15:45 +0200496 /* device input device_and_queue runtime index */
497 uword *dq_runtime_index_by_queue;
498
Ed Warnickecb9cada2015-12-08 15:45:58 -0700499} vnet_hw_interface_t;
500
Damjan Marion3d9c86e2016-07-04 21:04:40 +0200501extern vnet_device_class_t vnet_local_interface_device_class;
502
Dave Barachba868bb2016-08-08 09:51:21 -0400503typedef enum
504{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700505 /* A hw interface. */
506 VNET_SW_INTERFACE_TYPE_HARDWARE,
507
508 /* A sub-interface. */
509 VNET_SW_INTERFACE_TYPE_SUB,
510} vnet_sw_interface_type_t;
511
Dave Barachba868bb2016-08-08 09:51:21 -0400512typedef struct
513{
514 /*
515 * Subinterface ID. A number 0-N to uniquely identify
516 * this subinterface under the main (parent?) interface
517 */
518 u32 id;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700519
Dave Barachba868bb2016-08-08 09:51:21 -0400520 /* Classification data. Used to associate packet header with subinterface. */
521 struct
522 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700523 u16 outer_vlan_id;
524 u16 inner_vlan_id;
Dave Barachba868bb2016-08-08 09:51:21 -0400525 union
526 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700527 u16 raw_flags;
Dave Barachba868bb2016-08-08 09:51:21 -0400528 struct
529 {
530 u16 no_tags:1;
531 u16 one_tag:1;
532 u16 two_tags:1;
533 u16 dot1ad:1; /* 0 = dot1q, 1=dot1ad */
534 u16 exact_match:1;
535 u16 default_sub:1;
536 u16 outer_vlan_id_any:1;
537 u16 inner_vlan_id_any:1;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700538 } flags;
539 };
540 } eth;
541} vnet_sub_interface_t;
542
Eyal Baric5b13602016-11-24 19:42:43 +0200543typedef enum
544{
545 /* Always flood */
546 VNET_FLOOD_CLASS_NORMAL,
547 VNET_FLOOD_CLASS_TUNNEL_MASTER,
548 /* Does not flood when tunnel master is in the same L2 BD */
549 VNET_FLOOD_CLASS_TUNNEL_NORMAL
550} vnet_flood_class_t;
551
Ed Warnickecb9cada2015-12-08 15:45:58 -0700552/* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
553 tunnel, etc. Configuration (e.g. IP address) gets attached to
554 software interface. */
Dave Barachba868bb2016-08-08 09:51:21 -0400555typedef struct
556{
557 vnet_sw_interface_type_t type:16;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700558
559 u16 flags;
560 /* Interface is "up" meaning adminstratively up.
561 Up in the sense of link state being up is maintained by hardware interface. */
562#define VNET_SW_INTERFACE_FLAG_ADMIN_UP (1 << 0)
563
564 /* Interface is disabled for forwarding: punt all traffic to slow-path. */
565#define VNET_SW_INTERFACE_FLAG_PUNT (1 << 1)
566
567#define VNET_SW_INTERFACE_FLAG_PROXY_ARP (1 << 2)
568
569#define VNET_SW_INTERFACE_FLAG_UNNUMBERED (1 << 3)
570
John Lobcebbb92016-04-05 15:47:43 -0400571#define VNET_SW_INTERFACE_FLAG_BOND_SLAVE (1 << 4)
572
Eyal Bari3212c572017-03-06 11:47:50 +0200573/* Interface does not appear in CLI/API */
574#define VNET_SW_INTERFACE_FLAG_HIDDEN (1 << 5)
575
Damjan Marionabce5092017-05-10 20:09:31 +0200576/* Interface in ERROR state */
577#define VNET_SW_INTERFACE_FLAG_ERROR (1 << 6)
578
Ed Warnickecb9cada2015-12-08 15:45:58 -0700579 /* Index for this interface. */
580 u32 sw_if_index;
581
582 /* Software interface index of super-interface;
583 equal to sw_if_index if this interface is not a
584 sub-interface. */
585 u32 sup_sw_if_index;
586
587 /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
588 u32 unnumbered_sw_if_index;
589
590 u32 link_speed;
591
Dave Barachba868bb2016-08-08 09:51:21 -0400592 union
593 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700594 /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
595 u32 hw_if_index;
596
597 /* VNET_SW_INTERFACE_TYPE_SUB. */
598 vnet_sub_interface_t sub;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700599 };
Eyal Baric5b13602016-11-24 19:42:43 +0200600
601 vnet_flood_class_t flood_class;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700602} vnet_sw_interface_t;
603
Dave Barachba868bb2016-08-08 09:51:21 -0400604typedef enum
605{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700606 /* Simple counters. */
607 VNET_INTERFACE_COUNTER_DROP = 0,
608 VNET_INTERFACE_COUNTER_PUNT = 1,
609 VNET_INTERFACE_COUNTER_IP4 = 2,
610 VNET_INTERFACE_COUNTER_IP6 = 3,
611 VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
612 VNET_INTERFACE_COUNTER_RX_MISS = 5,
613 VNET_INTERFACE_COUNTER_RX_ERROR = 6,
614 VNET_INTERFACE_COUNTER_TX_ERROR = 7,
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100615 VNET_INTERFACE_COUNTER_MPLS = 8,
616 VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700617 /* Combined counters. */
618 VNET_INTERFACE_COUNTER_RX = 0,
619 VNET_INTERFACE_COUNTER_TX = 1,
620 VNET_N_COMBINED_INTERFACE_COUNTER = 2,
621} vnet_interface_counter_type_t;
622
Dave Barachba868bb2016-08-08 09:51:21 -0400623typedef struct
624{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700625 u32 output_node_index;
626 u32 tx_node_index;
627} vnet_hw_interface_nodes_t;
628
Dave Barachba868bb2016-08-08 09:51:21 -0400629typedef struct
630{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700631 /* Hardware interfaces. */
Dave Barachba868bb2016-08-08 09:51:21 -0400632 vnet_hw_interface_t *hw_interfaces;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700633
634 /* Hash table mapping HW interface name to index. */
Dave Barachba868bb2016-08-08 09:51:21 -0400635 uword *hw_interface_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700636
637 /* Vectors if hardware interface classes and device classes. */
Dave Barachba868bb2016-08-08 09:51:21 -0400638 vnet_hw_interface_class_t *hw_interface_classes;
639 vnet_device_class_t *device_classes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700640
641 /* Hash table mapping name to hw interface/device class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400642 uword *hw_interface_class_by_name;
643 uword *device_class_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700644
645 /* Software interfaces. */
Dave Barachba868bb2016-08-08 09:51:21 -0400646 vnet_sw_interface_t *sw_interfaces;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700647
648 /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
Dave Barachba868bb2016-08-08 09:51:21 -0400649 uword *sw_if_index_by_sup_and_sub;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700650
651 /* Software interface counters both simple and combined
652 packet and byte counters. */
653 volatile u32 *sw_if_counter_lock;
Dave Barachba868bb2016-08-08 09:51:21 -0400654 vlib_simple_counter_main_t *sw_if_counters;
655 vlib_combined_counter_main_t *combined_sw_if_counters;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700656
Dave Barachba868bb2016-08-08 09:51:21 -0400657 vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700658
659 /* pcap drop tracing */
660 int drop_pcap_enable;
661 pcap_main_t pcap_main;
Dave Barachba868bb2016-08-08 09:51:21 -0400662 u8 *pcap_filename;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700663 u32 pcap_sw_if_index;
664 u32 pcap_pkts_to_capture;
Dave Barachba868bb2016-08-08 09:51:21 -0400665 uword *pcap_drop_filter_hash;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700666
Damjan Marion152e21d2016-11-29 14:55:43 +0100667 /* feature_arc_index */
668 u8 output_feature_arc_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700669} vnet_interface_main_t;
670
Dave Barachba868bb2016-08-08 09:51:21 -0400671static inline void
672vnet_interface_counter_lock (vnet_interface_main_t * im)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700673{
674 if (im->sw_if_counter_lock)
675 while (__sync_lock_test_and_set (im->sw_if_counter_lock, 1))
676 /* zzzz */ ;
677}
Dave Barachba868bb2016-08-08 09:51:21 -0400678
679static inline void
680vnet_interface_counter_unlock (vnet_interface_main_t * im)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700681{
682 if (im->sw_if_counter_lock)
683 *im->sw_if_counter_lock = 0;
684}
685
686void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
687
688int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
689
Ed Warnickecb9cada2015-12-08 15:45:58 -0700690#endif /* included_vnet_interface_h */
Dave Barachba868bb2016-08-08 09:51:21 -0400691
692/*
693 * fd.io coding-style-patch-verification: ON
694 *
695 * Local Variables:
696 * eval: (c-set-style "gnu")
697 * End:
698 */