blob: fb75ff349b9e41678b0d8c105bf24f57f46b8aac [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,
Damjan Marion4e53a0d2017-06-21 14:29:44 +020057 VNET_HW_INTERFACE_RX_MODE_DEFAULT,
Stevene3a395c2017-05-09 16:19:50 -070058 VNET_HW_INTERFACE_NUM_RX_MODES,
59} vnet_hw_interface_rx_mode;
60
Ed Warnickecb9cada2015-12-08 15:45:58 -070061/* Interface up/down callback. */
Dave Barachba868bb2016-08-08 09:51:21 -040062typedef clib_error_t *(vnet_interface_function_t)
Ed Warnickecb9cada2015-12-08 15:45:58 -070063 (struct vnet_main_t * vnm, u32 if_index, u32 flags);
64
65/* Sub-interface add/del callback. */
Dave Barachba868bb2016-08-08 09:51:21 -040066typedef clib_error_t *(vnet_subif_add_del_function_t)
Ed Warnickecb9cada2015-12-08 15:45:58 -070067 (struct vnet_main_t * vnm, u32 if_index,
Dave Barachba868bb2016-08-08 09:51:21 -040068 struct vnet_sw_interface_t * template, int is_add);
Ed Warnickecb9cada2015-12-08 15:45:58 -070069
Pavel Kotucekc631f2d2016-09-26 10:40:02 +020070/* Interface set mac address callback. */
71typedef clib_error_t *(vnet_interface_set_mac_address_function_t)
72 (struct vnet_hw_interface_t * hi, char *address);
73
Stevene3a395c2017-05-09 16:19:50 -070074/* Interface set rx mode callback. */
75typedef clib_error_t *(vnet_interface_set_rx_mode_function_t)
76 (struct vnet_main_t * vnm, u32 if_index, u32 queue_id,
77 vnet_hw_interface_rx_mode mode);
78
Neale Ranns8b37b872016-11-21 12:25:22 +000079typedef enum vnet_interface_function_priority_t_
80{
81 VNET_ITF_FUNC_PRIORITY_LOW,
82 VNET_ITF_FUNC_PRIORITY_HIGH,
83} vnet_interface_function_priority_t;
84#define VNET_ITF_FUNC_N_PRIO ((vnet_interface_function_priority_t)VNET_ITF_FUNC_PRIORITY_HIGH+1)
85
Dave Barachba868bb2016-08-08 09:51:21 -040086typedef struct _vnet_interface_function_list_elt
87{
88 struct _vnet_interface_function_list_elt *next_interface_function;
89 clib_error_t *(*fp) (struct vnet_main_t * vnm, u32 if_index, u32 flags);
Ed Warnickecb9cada2015-12-08 15:45:58 -070090} _vnet_interface_function_list_elt_t;
91
92#define _VNET_INTERFACE_FUNCTION_DECL(f,tag) \
93 \
94static void __vnet_interface_function_init_##tag##_##f (void) \
95 __attribute__((__constructor__)) ; \
96 \
97static void __vnet_interface_function_init_##tag##_##f (void) \
98{ \
99 vnet_main_t * vnm = vnet_get_main(); \
100 static _vnet_interface_function_list_elt_t init_function; \
Neale Ranns8b37b872016-11-21 12:25:22 +0000101 init_function.next_interface_function = \
102 vnm->tag##_functions[VNET_ITF_FUNC_PRIORITY_LOW]; \
103 vnm->tag##_functions[VNET_ITF_FUNC_PRIORITY_LOW] = &init_function; \
104 init_function.fp = (void *) &f; \
105}
106
107#define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
108 \
109static void __vnet_interface_function_init_##tag##_##f (void) \
110 __attribute__((__constructor__)) ; \
111 \
112static void __vnet_interface_function_init_##tag##_##f (void) \
113{ \
114 vnet_main_t * vnm = vnet_get_main(); \
115 static _vnet_interface_function_list_elt_t init_function; \
116 init_function.next_interface_function = vnm->tag##_functions[p]; \
117 vnm->tag##_functions[p] = &init_function; \
Ed Warnickecb9cada2015-12-08 15:45:58 -0700118 init_function.fp = (void *) &f; \
Dave Barachba868bb2016-08-08 09:51:21 -0400119}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700120
121#define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f) \
122 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
123#define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f) \
124 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
Neale Ranns8b37b872016-11-21 12:25:22 +0000125#define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(f,p) \
126 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,hw_interface_link_up_down,p)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700127#define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f) \
128 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
129#define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f) \
130 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
Neale Ranns8b37b872016-11-21 12:25:22 +0000131#define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(f,p) \
132 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_admin_up_down, p)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700133
134/* A class of hardware interface devices. */
Dave Barachba868bb2016-08-08 09:51:21 -0400135typedef struct _vnet_device_class
136{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700137 /* Index into main vector. */
138 u32 index;
139
140 /* Device name (e.g. "FOOBAR 1234a"). */
Dave Barachba868bb2016-08-08 09:51:21 -0400141 char *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700142
143 /* Function to call when hardware interface is added/deleted. */
Dave Barachba868bb2016-08-08 09:51:21 -0400144 vnet_interface_function_t *interface_add_del_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700145
146 /* Function to bring device administratively up/down. */
Dave Barachba868bb2016-08-08 09:51:21 -0400147 vnet_interface_function_t *admin_up_down_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700148
149 /* Function to call when sub-interface is added/deleted */
Dave Barachba868bb2016-08-08 09:51:21 -0400150 vnet_subif_add_del_function_t *subif_add_del_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700151
Stevene3a395c2017-05-09 16:19:50 -0700152 /* Function to call interface rx mode is changed */
153 vnet_interface_set_rx_mode_function_t *rx_mode_change_function;
154
Ed Warnickecb9cada2015-12-08 15:45:58 -0700155 /* Redistribute flag changes/existence of this interface class. */
156 u32 redistribute;
157
158 /* Transmit function. */
Dave Barachba868bb2016-08-08 09:51:21 -0400159 vlib_node_function_t *tx_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700160
161 /* Error strings indexed by error code for this node. */
Dave Barachba868bb2016-08-08 09:51:21 -0400162 char **tx_function_error_strings;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700163
164 /* Number of error codes used by this node. */
165 u32 tx_function_n_errors;
166
167 /* Renumber device name [only!] support, a control-plane kludge */
Dave Barachba868bb2016-08-08 09:51:21 -0400168 int (*name_renumber) (struct vnet_hw_interface_t * hi,
169 u32 new_dev_instance);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700170
171 /* Format device instance as name. */
Dave Barachba868bb2016-08-08 09:51:21 -0400172 format_function_t *format_device_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700173
174 /* Parse function for device name. */
Dave Barachba868bb2016-08-08 09:51:21 -0400175 unformat_function_t *unformat_device_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700176
177 /* Format device verbosely for this class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400178 format_function_t *format_device;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700179
180 /* Trace buffer format for TX function. */
Dave Barachba868bb2016-08-08 09:51:21 -0400181 format_function_t *format_tx_trace;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700182
183 /* Function to clear hardware counters for device. */
Dave Barachba868bb2016-08-08 09:51:21 -0400184 void (*clear_counters) (u32 dev_class_instance);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700185
Dave Barachba868bb2016-08-08 09:51:21 -0400186 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
187 u32 hw_if_index,
188 u32 hw_class_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700189
190 /* Called when hardware class of an interface changes. */
Dave Barachba868bb2016-08-08 09:51:21 -0400191 void (*hw_class_change) (struct vnet_main_t * vnm,
192 u32 hw_if_index, u32 new_hw_class_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700193
194 /* Called to redirect traffic from a specific interface instance */
Dave Barachba868bb2016-08-08 09:51:21 -0400195 void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
196 u32 hw_if_index, u32 node_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700197
198 /* Link-list of all device classes set up by constructors created below */
Dave Barachba868bb2016-08-08 09:51:21 -0400199 struct _vnet_device_class *next_class_registration;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700200
Pavel Kotucekc631f2d2016-09-26 10:40:02 +0200201 /* Function to set mac address. */
202 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700203} vnet_device_class_t;
204
205#define VNET_DEVICE_CLASS(x,...) \
206 __VA_ARGS__ vnet_device_class_t x; \
207static void __vnet_add_device_class_registration_##x (void) \
208 __attribute__((__constructor__)) ; \
209static void __vnet_add_device_class_registration_##x (void) \
210{ \
211 vnet_main_t * vnm = vnet_get_main(); \
212 x.next_class_registration = vnm->device_class_registrations; \
213 vnm->device_class_registrations = &x; \
214} \
Dave Barachba868bb2016-08-08 09:51:21 -0400215__VA_ARGS__ vnet_device_class_t x
Ed Warnickecb9cada2015-12-08 15:45:58 -0700216
Damjan Marion1c80e832016-05-11 23:07:18 +0200217#define VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE(arch, fn, tgt) \
218 uword \
219 __attribute__ ((flatten)) \
220 __attribute__ ((target (tgt))) \
221 CLIB_CPU_OPTIMIZED \
222 fn ## _ ## arch ( vlib_main_t * vm, \
223 vlib_node_runtime_t * node, \
224 vlib_frame_t * frame) \
225 { return fn (vm, node, frame); }
226
227#define VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
228 foreach_march_variant(VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE, fn)
229
230#if CLIB_DEBUG > 0
231#define VLIB_MULTIARCH_CLONE_AND_SELECT_FN(fn,...)
232#define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn)
233#else
234#define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn) \
235 VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
236 CLIB_MULTIARCH_SELECT_FN(fn, static inline) \
237 static void __attribute__((__constructor__)) \
238 __vlib_device_tx_function_multiarch_select_##dev (void) \
239 { dev.tx_function = fn ## _multiarch_select(); }
240#endif
241
Neale Rannsb80c5362016-10-08 13:03:40 +0100242/**
243 * Link Type: A description of the protocol of packets on the link.
244 * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
245 * it maps to the GRE-proto, etc for other lnk types.
246 */
247typedef enum vnet_link_t_
248{
249#if CLIB_DEBUG > 0
250 VNET_LINK_IP4 = 1,
251#else
252 VNET_LINK_IP4 = 0,
253#endif
254 VNET_LINK_IP6,
255 VNET_LINK_MPLS,
256 VNET_LINK_ETHERNET,
257 VNET_LINK_ARP,
Florin Corasce1b4c72017-01-26 14:25:34 -0800258 VNET_LINK_NSH,
Neale Rannsb80c5362016-10-08 13:03:40 +0100259} __attribute__ ((packed)) vnet_link_t;
260
Neale Ranns924d03a2016-10-19 08:25:46 +0100261#define VNET_LINKS { \
262 [VNET_LINK_ETHERNET] = "ethernet", \
263 [VNET_LINK_IP4] = "ipv4", \
264 [VNET_LINK_IP6] = "ipv6", \
265 [VNET_LINK_MPLS] = "mpls", \
266 [VNET_LINK_ARP] = "arp", \
Florin Corasce1b4c72017-01-26 14:25:34 -0800267 [VNET_LINK_NSH] = "nsh", \
Neale Ranns924d03a2016-10-19 08:25:46 +0100268}
269
270/**
271 * @brief Number of link types. Not part of the enum so it does not have to be included in
272 * switch statements
273 */
Florin Corasce1b4c72017-01-26 14:25:34 -0800274#define VNET_LINK_NUM (VNET_LINK_NSH+1)
Neale Ranns924d03a2016-10-19 08:25:46 +0100275
Neale Rannsb80c5362016-10-08 13:03:40 +0100276/**
277 * @brief Convert a link to to an Ethertype
278 */
279extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
280
281/**
282 * @brief Attributes assignable to a HW interface Class.
283 */
284typedef enum vnet_hw_interface_class_flags_t_
285{
286 /**
287 * @brief a point 2 point interface
288 */
289 VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
290} vnet_hw_interface_class_flags_t;
Damjan Marion1c80e832016-05-11 23:07:18 +0200291
Ed Warnickecb9cada2015-12-08 15:45:58 -0700292/* Layer-2 (e.g. Ethernet) interface class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400293typedef struct _vnet_hw_interface_class
294{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700295 /* Index into main vector. */
296 u32 index;
297
298 /* Class name (e.g. "Ethernet"). */
Dave Barachba868bb2016-08-08 09:51:21 -0400299 char *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700300
Neale Rannsb80c5362016-10-08 13:03:40 +0100301 /* Flags */
302 vnet_hw_interface_class_flags_t flags;
303
Ed Warnickecb9cada2015-12-08 15:45:58 -0700304 /* Function to call when hardware interface is added/deleted. */
Dave Barachba868bb2016-08-08 09:51:21 -0400305 vnet_interface_function_t *interface_add_del_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700306
307 /* Function to bring interface administratively up/down. */
Dave Barachba868bb2016-08-08 09:51:21 -0400308 vnet_interface_function_t *admin_up_down_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700309
310 /* Function to call when link state changes. */
Dave Barachba868bb2016-08-08 09:51:21 -0400311 vnet_interface_function_t *link_up_down_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700312
Neale Ranns3be6b282016-12-20 14:24:01 +0000313 /* Function to call when link MAC changes. */
314 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
315
Ed Warnickecb9cada2015-12-08 15:45:58 -0700316 /* Format function to display interface name. */
Dave Barachba868bb2016-08-08 09:51:21 -0400317 format_function_t *format_interface_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700318
319 /* Format function to display interface address. */
Dave Barachba868bb2016-08-08 09:51:21 -0400320 format_function_t *format_address;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700321
322 /* Format packet header for this interface class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400323 format_function_t *format_header;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700324
325 /* Format device verbosely for this class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400326 format_function_t *format_device;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700327
328 /* Parser for hardware (e.g. ethernet) address. */
Dave Barachba868bb2016-08-08 09:51:21 -0400329 unformat_function_t *unformat_hw_address;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700330
331 /* Parser for packet header for e.g. rewrite string. */
Dave Barachba868bb2016-08-08 09:51:21 -0400332 unformat_function_t *unformat_header;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700333
Neale Rannsb80c5362016-10-08 13:03:40 +0100334 /* Builds a rewrite string for the interface to the destination
335 * for the payload/link type. */
336 u8 *(*build_rewrite) (struct vnet_main_t * vnm,
337 u32 sw_if_index,
338 vnet_link_t link_type, const void *dst_hw_address);
339
340 /* Update an adjacecny added by FIB (as opposed to via the
341 * neighbour resolution protocol). */
342 void (*update_adjacency) (struct vnet_main_t * vnm,
343 u32 sw_if_index, u32 adj_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700344
Dave Barachba868bb2016-08-08 09:51:21 -0400345 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
346 u32 hw_if_index,
347 u32 hw_class_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700348
349 /* Called when hw interface class is changed and old hardware instance
350 may want to be deleted. */
Dave Barachba868bb2016-08-08 09:51:21 -0400351 void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
352 u32 old_class_index, u32 new_class_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700353
354 /* List of hw interface classes, built by constructors */
Dave Barachba868bb2016-08-08 09:51:21 -0400355 struct _vnet_hw_interface_class *next_class_registration;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700356
357} vnet_hw_interface_class_t;
358
Neale Rannsb80c5362016-10-08 13:03:40 +0100359/**
360 * @brief Return a complete, zero-length (aka dummy) rewrite
361 */
362extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
363 u32 sw_if_index,
364 vnet_link_t link_type,
365 const void *dst_hw_address);
366
367/**
368 * @brief Default adjacency update function
369 */
370extern void default_update_adjacency (struct vnet_main_t *vnm,
371 u32 sw_if_index, u32 adj_index);
372
Ed Warnickecb9cada2015-12-08 15:45:58 -0700373#define VNET_HW_INTERFACE_CLASS(x,...) \
374 __VA_ARGS__ vnet_hw_interface_class_t x; \
375static void __vnet_add_hw_interface_class_registration_##x (void) \
376 __attribute__((__constructor__)) ; \
377static void __vnet_add_hw_interface_class_registration_##x (void) \
378{ \
379 vnet_main_t * vnm = vnet_get_main(); \
380 x.next_class_registration = vnm->hw_interface_class_registrations; \
381 vnm->hw_interface_class_registrations = &x; \
382} \
383__VA_ARGS__ vnet_hw_interface_class_t x
384
385/* Hardware-interface. This corresponds to a physical wire
386 that packets flow over. */
Dave Barachba868bb2016-08-08 09:51:21 -0400387typedef struct vnet_hw_interface_t
388{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700389 /* Interface name. */
Dave Barachba868bb2016-08-08 09:51:21 -0400390 u8 *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700391
392 u32 flags;
393 /* Hardware link state is up. */
394#define VNET_HW_INTERFACE_FLAG_LINK_UP (1 << 0)
395 /* Hardware duplex state */
396#define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
397#define VNET_HW_INTERFACE_FLAG_HALF_DUPLEX (1 << 1)
398#define VNET_HW_INTERFACE_FLAG_FULL_DUPLEX (1 << 2)
399#define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK \
400 (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX | \
401 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
402
403 /* Hardware link speed */
404#define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT 3
405#define VNET_HW_INTERFACE_FLAG_SPEED_10M (1 << 3)
406#define VNET_HW_INTERFACE_FLAG_SPEED_100M (1 << 4)
407#define VNET_HW_INTERFACE_FLAG_SPEED_1G (1 << 5)
408#define VNET_HW_INTERFACE_FLAG_SPEED_10G (1 << 6)
409#define VNET_HW_INTERFACE_FLAG_SPEED_40G (1 << 7)
410#define VNET_HW_INTERFACE_FLAG_SPEED_100G (1 << 8)
411#define VNET_HW_INTERFACE_FLAG_SPEED_MASK \
412 (VNET_HW_INTERFACE_FLAG_SPEED_10M | \
413 VNET_HW_INTERFACE_FLAG_SPEED_100M | \
414 VNET_HW_INTERFACE_FLAG_SPEED_1G | \
415 VNET_HW_INTERFACE_FLAG_SPEED_10G | \
416 VNET_HW_INTERFACE_FLAG_SPEED_40G | \
417 VNET_HW_INTERFACE_FLAG_SPEED_100G)
418
Damjan Marion44036902017-04-28 12:29:15 +0200419 /* rx mode flags */
420#define VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE (1 << 10)
421
Dave Barach2c0a4f42017-06-29 09:30:15 -0400422 /* tx checksum offload */
423#define VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD (1 << 11)
424
Ed Warnickecb9cada2015-12-08 15:45:58 -0700425 /* Hardware address as vector. Zero (e.g. zero-length vector) if no
426 address for this class (e.g. PPP). */
Dave Barachba868bb2016-08-08 09:51:21 -0400427 u8 *hw_address;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700428
429 /* Interface is up as far as software is concerned. */
430 /* NAME.{output,tx} nodes for this interface. */
431 u32 output_node_index, tx_node_index;
432
433 /* (dev_class, dev_instance) uniquely identifies hw interface. */
434 u32 dev_class_index;
435 u32 dev_instance;
436
437 /* (hw_class, hw_instance) uniquely identifies hw interface. */
438 u32 hw_class_index;
439 u32 hw_instance;
440
441 /* Hardware index for this hardware interface. */
442 u32 hw_if_index;
443
444 /* Software index for this hardware interface. */
445 u32 sw_if_index;
446
447 /* Maximum transmit rate for this interface in bits/sec. */
448 f64 max_rate_bits_per_sec;
449
Mohsin Kazmif2ba9aa2016-04-24 18:53:42 +0200450 /* Smallest packet size supported by this interface. */
451 u32 min_supported_packet_bytes;
452
453 /* Largest packet size supported by this interface. */
454 u32 max_supported_packet_bytes;
455
Ed Warnickecb9cada2015-12-08 15:45:58 -0700456 /* Smallest packet size for this interface. */
457 u32 min_packet_bytes;
458
459 /* Largest packet size for this interface. */
460 u32 max_packet_bytes;
461
462 /* Number of extra bytes that go on the wire.
463 Packet length on wire
464 = max (length + per_packet_overhead_bytes, min_packet_bytes). */
465 u32 per_packet_overhead_bytes;
466
467 /* Receive and transmit layer 3 packet size limits (MRU/MTU). */
468 u32 max_l3_packet_bytes[VLIB_N_RX_TX];
469
470 /* Hash table mapping sub interface id to sw_if_index. */
Dave Barachba868bb2016-08-08 09:51:21 -0400471 uword *sub_interface_sw_if_index_by_id;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700472
473 /* Count of number of L2 subinterfaces */
474 u32 l2_if_count;
John Lobcebbb92016-04-05 15:47:43 -0400475
476 /* Bonded interface info -
477 0 - not a bonded interface nor a slave
478 ~0 - slave to a bonded interface
479 others - A bonded interface with a pointer to bitmap for all slaves */
480 uword *bond_info;
481#define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
482#define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
483
Damjan Marioneb743fa2017-03-20 16:34:15 +0100484 /* Input node */
485 u32 input_node_index;
486
487 /* input node cpu index by queue */
Damjan Marion586afd72017-04-05 19:18:20 +0200488 u32 *input_node_thread_index_by_queue;
Damjan Marioneb743fa2017-03-20 16:34:15 +0100489
Damjan Marion44036902017-04-28 12:29:15 +0200490 /* vnet_hw_interface_rx_mode by queue */
491 u8 *rx_mode_by_queue;
Damjan Marion4e53a0d2017-06-21 14:29:44 +0200492 vnet_hw_interface_rx_mode default_rx_mode;
Damjan Marion44036902017-04-28 12:29:15 +0200493
Damjan Marion153646e2017-04-05 18:15:45 +0200494 /* device input device_and_queue runtime index */
495 uword *dq_runtime_index_by_queue;
496
Ed Warnickecb9cada2015-12-08 15:45:58 -0700497} vnet_hw_interface_t;
498
Damjan Marion3d9c86e2016-07-04 21:04:40 +0200499extern vnet_device_class_t vnet_local_interface_device_class;
500
Dave Barachba868bb2016-08-08 09:51:21 -0400501typedef enum
502{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700503 /* A hw interface. */
504 VNET_SW_INTERFACE_TYPE_HARDWARE,
505
506 /* A sub-interface. */
507 VNET_SW_INTERFACE_TYPE_SUB,
508} vnet_sw_interface_type_t;
509
Dave Barachba868bb2016-08-08 09:51:21 -0400510typedef struct
511{
512 /*
513 * Subinterface ID. A number 0-N to uniquely identify
514 * this subinterface under the main (parent?) interface
515 */
516 u32 id;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700517
Dave Barachba868bb2016-08-08 09:51:21 -0400518 /* Classification data. Used to associate packet header with subinterface. */
519 struct
520 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700521 u16 outer_vlan_id;
522 u16 inner_vlan_id;
Dave Barachba868bb2016-08-08 09:51:21 -0400523 union
524 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700525 u16 raw_flags;
Dave Barachba868bb2016-08-08 09:51:21 -0400526 struct
527 {
528 u16 no_tags:1;
529 u16 one_tag:1;
530 u16 two_tags:1;
531 u16 dot1ad:1; /* 0 = dot1q, 1=dot1ad */
532 u16 exact_match:1;
533 u16 default_sub:1;
534 u16 outer_vlan_id_any:1;
535 u16 inner_vlan_id_any:1;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700536 } flags;
537 };
538 } eth;
539} vnet_sub_interface_t;
540
Eyal Baric5b13602016-11-24 19:42:43 +0200541typedef enum
542{
543 /* Always flood */
544 VNET_FLOOD_CLASS_NORMAL,
545 VNET_FLOOD_CLASS_TUNNEL_MASTER,
546 /* Does not flood when tunnel master is in the same L2 BD */
547 VNET_FLOOD_CLASS_TUNNEL_NORMAL
548} vnet_flood_class_t;
549
Ed Warnickecb9cada2015-12-08 15:45:58 -0700550/* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
551 tunnel, etc. Configuration (e.g. IP address) gets attached to
552 software interface. */
Dave Barachba868bb2016-08-08 09:51:21 -0400553typedef struct
554{
555 vnet_sw_interface_type_t type:16;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700556
557 u16 flags;
558 /* Interface is "up" meaning adminstratively up.
559 Up in the sense of link state being up is maintained by hardware interface. */
560#define VNET_SW_INTERFACE_FLAG_ADMIN_UP (1 << 0)
561
562 /* Interface is disabled for forwarding: punt all traffic to slow-path. */
563#define VNET_SW_INTERFACE_FLAG_PUNT (1 << 1)
564
565#define VNET_SW_INTERFACE_FLAG_PROXY_ARP (1 << 2)
566
567#define VNET_SW_INTERFACE_FLAG_UNNUMBERED (1 << 3)
568
John Lobcebbb92016-04-05 15:47:43 -0400569#define VNET_SW_INTERFACE_FLAG_BOND_SLAVE (1 << 4)
570
John Lob2fd6cb2017-07-12 19:56:45 -0400571 /* Interface does not appear in CLI/API */
Eyal Bari3212c572017-03-06 11:47:50 +0200572#define VNET_SW_INTERFACE_FLAG_HIDDEN (1 << 5)
573
John Lob2fd6cb2017-07-12 19:56:45 -0400574 /* Interface in ERROR state */
Damjan Marionabce5092017-05-10 20:09:31 +0200575#define VNET_SW_INTERFACE_FLAG_ERROR (1 << 6)
576
Ed Warnickecb9cada2015-12-08 15:45:58 -0700577 /* Index for this interface. */
578 u32 sw_if_index;
579
580 /* Software interface index of super-interface;
581 equal to sw_if_index if this interface is not a
582 sub-interface. */
583 u32 sup_sw_if_index;
584
585 /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
586 u32 unnumbered_sw_if_index;
587
588 u32 link_speed;
589
Dave Barachba868bb2016-08-08 09:51:21 -0400590 union
591 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700592 /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
593 u32 hw_if_index;
594
595 /* VNET_SW_INTERFACE_TYPE_SUB. */
596 vnet_sub_interface_t sub;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700597 };
Eyal Baric5b13602016-11-24 19:42:43 +0200598
599 vnet_flood_class_t flood_class;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700600} vnet_sw_interface_t;
601
Dave Barachba868bb2016-08-08 09:51:21 -0400602typedef enum
603{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700604 /* Simple counters. */
605 VNET_INTERFACE_COUNTER_DROP = 0,
606 VNET_INTERFACE_COUNTER_PUNT = 1,
607 VNET_INTERFACE_COUNTER_IP4 = 2,
608 VNET_INTERFACE_COUNTER_IP6 = 3,
609 VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
610 VNET_INTERFACE_COUNTER_RX_MISS = 5,
611 VNET_INTERFACE_COUNTER_RX_ERROR = 6,
612 VNET_INTERFACE_COUNTER_TX_ERROR = 7,
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100613 VNET_INTERFACE_COUNTER_MPLS = 8,
614 VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700615 /* Combined counters. */
616 VNET_INTERFACE_COUNTER_RX = 0,
617 VNET_INTERFACE_COUNTER_TX = 1,
618 VNET_N_COMBINED_INTERFACE_COUNTER = 2,
619} vnet_interface_counter_type_t;
620
Dave Barachba868bb2016-08-08 09:51:21 -0400621typedef struct
622{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700623 u32 output_node_index;
624 u32 tx_node_index;
625} vnet_hw_interface_nodes_t;
626
Dave Barachba868bb2016-08-08 09:51:21 -0400627typedef struct
628{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700629 /* Hardware interfaces. */
Dave Barachba868bb2016-08-08 09:51:21 -0400630 vnet_hw_interface_t *hw_interfaces;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700631
632 /* Hash table mapping HW interface name to index. */
Dave Barachba868bb2016-08-08 09:51:21 -0400633 uword *hw_interface_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700634
635 /* Vectors if hardware interface classes and device classes. */
Dave Barachba868bb2016-08-08 09:51:21 -0400636 vnet_hw_interface_class_t *hw_interface_classes;
637 vnet_device_class_t *device_classes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700638
639 /* Hash table mapping name to hw interface/device class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400640 uword *hw_interface_class_by_name;
641 uword *device_class_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700642
643 /* Software interfaces. */
Dave Barachba868bb2016-08-08 09:51:21 -0400644 vnet_sw_interface_t *sw_interfaces;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700645
646 /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
Dave Barachba868bb2016-08-08 09:51:21 -0400647 uword *sw_if_index_by_sup_and_sub;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700648
649 /* Software interface counters both simple and combined
650 packet and byte counters. */
651 volatile u32 *sw_if_counter_lock;
Dave Barachba868bb2016-08-08 09:51:21 -0400652 vlib_simple_counter_main_t *sw_if_counters;
653 vlib_combined_counter_main_t *combined_sw_if_counters;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700654
Dave Barachba868bb2016-08-08 09:51:21 -0400655 vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700656
657 /* pcap drop tracing */
658 int drop_pcap_enable;
659 pcap_main_t pcap_main;
Dave Barachba868bb2016-08-08 09:51:21 -0400660 u8 *pcap_filename;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700661 u32 pcap_sw_if_index;
662 u32 pcap_pkts_to_capture;
Dave Barachba868bb2016-08-08 09:51:21 -0400663 uword *pcap_drop_filter_hash;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700664
Damjan Marion152e21d2016-11-29 14:55:43 +0100665 /* feature_arc_index */
666 u8 output_feature_arc_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700667} vnet_interface_main_t;
668
Dave Barachba868bb2016-08-08 09:51:21 -0400669static inline void
670vnet_interface_counter_lock (vnet_interface_main_t * im)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700671{
672 if (im->sw_if_counter_lock)
673 while (__sync_lock_test_and_set (im->sw_if_counter_lock, 1))
674 /* zzzz */ ;
675}
Dave Barachba868bb2016-08-08 09:51:21 -0400676
677static inline void
678vnet_interface_counter_unlock (vnet_interface_main_t * im)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700679{
680 if (im->sw_if_counter_lock)
681 *im->sw_if_counter_lock = 0;
682}
683
684void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
685
686int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
687
Ed Warnickecb9cada2015-12-08 15:45:58 -0700688#endif /* included_vnet_interface_h */
Dave Barachba868bb2016-08-08 09:51:21 -0400689
690/*
691 * fd.io coding-style-patch-verification: ON
692 *
693 * Local Variables:
694 * eval: (c-set-style "gnu")
695 * End:
696 */