blob: 2344348bf0082869ca267c977656fb8967bf0777 [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
51/* Interface up/down callback. */
Dave Barachba868bb2016-08-08 09:51:21 -040052typedef clib_error_t *(vnet_interface_function_t)
Ed Warnickecb9cada2015-12-08 15:45:58 -070053 (struct vnet_main_t * vnm, u32 if_index, u32 flags);
54
55/* Sub-interface add/del callback. */
Dave Barachba868bb2016-08-08 09:51:21 -040056typedef clib_error_t *(vnet_subif_add_del_function_t)
Ed Warnickecb9cada2015-12-08 15:45:58 -070057 (struct vnet_main_t * vnm, u32 if_index,
Dave Barachba868bb2016-08-08 09:51:21 -040058 struct vnet_sw_interface_t * template, int is_add);
Ed Warnickecb9cada2015-12-08 15:45:58 -070059
Pavel Kotucekc631f2d2016-09-26 10:40:02 +020060/* Interface set mac address callback. */
61typedef clib_error_t *(vnet_interface_set_mac_address_function_t)
62 (struct vnet_hw_interface_t * hi, char *address);
63
Neale Ranns8b37b872016-11-21 12:25:22 +000064typedef enum vnet_interface_function_priority_t_
65{
66 VNET_ITF_FUNC_PRIORITY_LOW,
67 VNET_ITF_FUNC_PRIORITY_HIGH,
68} vnet_interface_function_priority_t;
69#define VNET_ITF_FUNC_N_PRIO ((vnet_interface_function_priority_t)VNET_ITF_FUNC_PRIORITY_HIGH+1)
70
Dave Barachba868bb2016-08-08 09:51:21 -040071typedef struct _vnet_interface_function_list_elt
72{
73 struct _vnet_interface_function_list_elt *next_interface_function;
74 clib_error_t *(*fp) (struct vnet_main_t * vnm, u32 if_index, u32 flags);
Ed Warnickecb9cada2015-12-08 15:45:58 -070075} _vnet_interface_function_list_elt_t;
76
77#define _VNET_INTERFACE_FUNCTION_DECL(f,tag) \
78 \
79static void __vnet_interface_function_init_##tag##_##f (void) \
80 __attribute__((__constructor__)) ; \
81 \
82static void __vnet_interface_function_init_##tag##_##f (void) \
83{ \
84 vnet_main_t * vnm = vnet_get_main(); \
85 static _vnet_interface_function_list_elt_t init_function; \
Neale Ranns8b37b872016-11-21 12:25:22 +000086 init_function.next_interface_function = \
87 vnm->tag##_functions[VNET_ITF_FUNC_PRIORITY_LOW]; \
88 vnm->tag##_functions[VNET_ITF_FUNC_PRIORITY_LOW] = &init_function; \
89 init_function.fp = (void *) &f; \
90}
91
92#define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
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; \
101 init_function.next_interface_function = vnm->tag##_functions[p]; \
102 vnm->tag##_functions[p] = &init_function; \
Ed Warnickecb9cada2015-12-08 15:45:58 -0700103 init_function.fp = (void *) &f; \
Dave Barachba868bb2016-08-08 09:51:21 -0400104}
Ed Warnickecb9cada2015-12-08 15:45:58 -0700105
106#define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f) \
107 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
108#define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f) \
109 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
Neale Ranns8b37b872016-11-21 12:25:22 +0000110#define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(f,p) \
111 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,hw_interface_link_up_down,p)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700112#define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f) \
113 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
114#define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f) \
115 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
Neale Ranns8b37b872016-11-21 12:25:22 +0000116#define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(f,p) \
117 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_admin_up_down, p)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700118
119/* A class of hardware interface devices. */
Dave Barachba868bb2016-08-08 09:51:21 -0400120typedef struct _vnet_device_class
121{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700122 /* Index into main vector. */
123 u32 index;
124
125 /* Device name (e.g. "FOOBAR 1234a"). */
Dave Barachba868bb2016-08-08 09:51:21 -0400126 char *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700127
128 /* Function to call when hardware interface is added/deleted. */
Dave Barachba868bb2016-08-08 09:51:21 -0400129 vnet_interface_function_t *interface_add_del_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700130
131 /* Function to bring device administratively up/down. */
Dave Barachba868bb2016-08-08 09:51:21 -0400132 vnet_interface_function_t *admin_up_down_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700133
134 /* Function to call when sub-interface is added/deleted */
Dave Barachba868bb2016-08-08 09:51:21 -0400135 vnet_subif_add_del_function_t *subif_add_del_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700136
137 /* Redistribute flag changes/existence of this interface class. */
138 u32 redistribute;
139
140 /* Transmit function. */
Dave Barachba868bb2016-08-08 09:51:21 -0400141 vlib_node_function_t *tx_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700142
143 /* Error strings indexed by error code for this node. */
Dave Barachba868bb2016-08-08 09:51:21 -0400144 char **tx_function_error_strings;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700145
146 /* Number of error codes used by this node. */
147 u32 tx_function_n_errors;
148
149 /* Renumber device name [only!] support, a control-plane kludge */
Dave Barachba868bb2016-08-08 09:51:21 -0400150 int (*name_renumber) (struct vnet_hw_interface_t * hi,
151 u32 new_dev_instance);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700152
153 /* Format device instance as name. */
Dave Barachba868bb2016-08-08 09:51:21 -0400154 format_function_t *format_device_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700155
156 /* Parse function for device name. */
Dave Barachba868bb2016-08-08 09:51:21 -0400157 unformat_function_t *unformat_device_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700158
159 /* Format device verbosely for this class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400160 format_function_t *format_device;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700161
162 /* Trace buffer format for TX function. */
Dave Barachba868bb2016-08-08 09:51:21 -0400163 format_function_t *format_tx_trace;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700164
165 /* Function to clear hardware counters for device. */
Dave Barachba868bb2016-08-08 09:51:21 -0400166 void (*clear_counters) (u32 dev_class_instance);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700167
Dave Barachba868bb2016-08-08 09:51:21 -0400168 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
169 u32 hw_if_index,
170 u32 hw_class_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700171
172 /* Called when hardware class of an interface changes. */
Dave Barachba868bb2016-08-08 09:51:21 -0400173 void (*hw_class_change) (struct vnet_main_t * vnm,
174 u32 hw_if_index, u32 new_hw_class_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700175
176 /* Called to redirect traffic from a specific interface instance */
Dave Barachba868bb2016-08-08 09:51:21 -0400177 void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
178 u32 hw_if_index, u32 node_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700179
180 /* Link-list of all device classes set up by constructors created below */
Dave Barachba868bb2016-08-08 09:51:21 -0400181 struct _vnet_device_class *next_class_registration;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700182
Damjan Marion8b2247d2016-12-02 08:09:45 +0100183 /* Splice vnet_interface_output_node into TX path */
184 u8 flatten_output_chains;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700185
Pavel Kotucekc631f2d2016-09-26 10:40:02 +0200186 /* Function to set mac address. */
187 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700188} vnet_device_class_t;
189
190#define VNET_DEVICE_CLASS(x,...) \
191 __VA_ARGS__ vnet_device_class_t x; \
192static void __vnet_add_device_class_registration_##x (void) \
193 __attribute__((__constructor__)) ; \
194static void __vnet_add_device_class_registration_##x (void) \
195{ \
196 vnet_main_t * vnm = vnet_get_main(); \
197 x.next_class_registration = vnm->device_class_registrations; \
198 vnm->device_class_registrations = &x; \
199} \
Dave Barachba868bb2016-08-08 09:51:21 -0400200__VA_ARGS__ vnet_device_class_t x
Ed Warnickecb9cada2015-12-08 15:45:58 -0700201
Damjan Marion1c80e832016-05-11 23:07:18 +0200202#define VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE(arch, fn, tgt) \
203 uword \
204 __attribute__ ((flatten)) \
205 __attribute__ ((target (tgt))) \
206 CLIB_CPU_OPTIMIZED \
207 fn ## _ ## arch ( vlib_main_t * vm, \
208 vlib_node_runtime_t * node, \
209 vlib_frame_t * frame) \
210 { return fn (vm, node, frame); }
211
212#define VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
213 foreach_march_variant(VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE, fn)
214
215#if CLIB_DEBUG > 0
216#define VLIB_MULTIARCH_CLONE_AND_SELECT_FN(fn,...)
217#define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn)
218#else
219#define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn) \
220 VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
221 CLIB_MULTIARCH_SELECT_FN(fn, static inline) \
222 static void __attribute__((__constructor__)) \
223 __vlib_device_tx_function_multiarch_select_##dev (void) \
224 { dev.tx_function = fn ## _multiarch_select(); }
225#endif
226
Neale Rannsb80c5362016-10-08 13:03:40 +0100227/**
228 * Link Type: A description of the protocol of packets on the link.
229 * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
230 * it maps to the GRE-proto, etc for other lnk types.
231 */
232typedef enum vnet_link_t_
233{
234#if CLIB_DEBUG > 0
235 VNET_LINK_IP4 = 1,
236#else
237 VNET_LINK_IP4 = 0,
238#endif
239 VNET_LINK_IP6,
240 VNET_LINK_MPLS,
241 VNET_LINK_ETHERNET,
242 VNET_LINK_ARP,
Florin Corasce1b4c72017-01-26 14:25:34 -0800243 VNET_LINK_NSH,
Neale Rannsb80c5362016-10-08 13:03:40 +0100244} __attribute__ ((packed)) vnet_link_t;
245
Neale Ranns924d03a2016-10-19 08:25:46 +0100246#define VNET_LINKS { \
247 [VNET_LINK_ETHERNET] = "ethernet", \
248 [VNET_LINK_IP4] = "ipv4", \
249 [VNET_LINK_IP6] = "ipv6", \
250 [VNET_LINK_MPLS] = "mpls", \
251 [VNET_LINK_ARP] = "arp", \
Florin Corasce1b4c72017-01-26 14:25:34 -0800252 [VNET_LINK_NSH] = "nsh", \
Neale Ranns924d03a2016-10-19 08:25:46 +0100253}
254
255/**
256 * @brief Number of link types. Not part of the enum so it does not have to be included in
257 * switch statements
258 */
Florin Corasce1b4c72017-01-26 14:25:34 -0800259#define VNET_LINK_NUM (VNET_LINK_NSH+1)
Neale Ranns924d03a2016-10-19 08:25:46 +0100260
Neale Rannsb80c5362016-10-08 13:03:40 +0100261/**
262 * @brief Convert a link to to an Ethertype
263 */
264extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
265
266/**
267 * @brief Attributes assignable to a HW interface Class.
268 */
269typedef enum vnet_hw_interface_class_flags_t_
270{
271 /**
272 * @brief a point 2 point interface
273 */
274 VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
275} vnet_hw_interface_class_flags_t;
Damjan Marion1c80e832016-05-11 23:07:18 +0200276
Ed Warnickecb9cada2015-12-08 15:45:58 -0700277/* Layer-2 (e.g. Ethernet) interface class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400278typedef struct _vnet_hw_interface_class
279{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700280 /* Index into main vector. */
281 u32 index;
282
283 /* Class name (e.g. "Ethernet"). */
Dave Barachba868bb2016-08-08 09:51:21 -0400284 char *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700285
Neale Rannsb80c5362016-10-08 13:03:40 +0100286 /* Flags */
287 vnet_hw_interface_class_flags_t flags;
288
Ed Warnickecb9cada2015-12-08 15:45:58 -0700289 /* Function to call when hardware interface is added/deleted. */
Dave Barachba868bb2016-08-08 09:51:21 -0400290 vnet_interface_function_t *interface_add_del_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700291
292 /* Function to bring interface administratively up/down. */
Dave Barachba868bb2016-08-08 09:51:21 -0400293 vnet_interface_function_t *admin_up_down_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700294
295 /* Function to call when link state changes. */
Dave Barachba868bb2016-08-08 09:51:21 -0400296 vnet_interface_function_t *link_up_down_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700297
Neale Ranns3be6b282016-12-20 14:24:01 +0000298 /* Function to call when link MAC changes. */
299 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
300
Ed Warnickecb9cada2015-12-08 15:45:58 -0700301 /* Format function to display interface name. */
Dave Barachba868bb2016-08-08 09:51:21 -0400302 format_function_t *format_interface_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700303
304 /* Format function to display interface address. */
Dave Barachba868bb2016-08-08 09:51:21 -0400305 format_function_t *format_address;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700306
307 /* Format packet header for this interface class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400308 format_function_t *format_header;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700309
310 /* Format device verbosely for this class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400311 format_function_t *format_device;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700312
313 /* Parser for hardware (e.g. ethernet) address. */
Dave Barachba868bb2016-08-08 09:51:21 -0400314 unformat_function_t *unformat_hw_address;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700315
316 /* Parser for packet header for e.g. rewrite string. */
Dave Barachba868bb2016-08-08 09:51:21 -0400317 unformat_function_t *unformat_header;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700318
Neale Rannsb80c5362016-10-08 13:03:40 +0100319 /* Builds a rewrite string for the interface to the destination
320 * for the payload/link type. */
321 u8 *(*build_rewrite) (struct vnet_main_t * vnm,
322 u32 sw_if_index,
323 vnet_link_t link_type, const void *dst_hw_address);
324
325 /* Update an adjacecny added by FIB (as opposed to via the
326 * neighbour resolution protocol). */
327 void (*update_adjacency) (struct vnet_main_t * vnm,
328 u32 sw_if_index, u32 adj_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700329
Dave Barachba868bb2016-08-08 09:51:21 -0400330 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
331 u32 hw_if_index,
332 u32 hw_class_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700333
334 /* Called when hw interface class is changed and old hardware instance
335 may want to be deleted. */
Dave Barachba868bb2016-08-08 09:51:21 -0400336 void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
337 u32 old_class_index, u32 new_class_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700338
339 /* List of hw interface classes, built by constructors */
Dave Barachba868bb2016-08-08 09:51:21 -0400340 struct _vnet_hw_interface_class *next_class_registration;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700341
342} vnet_hw_interface_class_t;
343
Neale Rannsb80c5362016-10-08 13:03:40 +0100344/**
345 * @brief Return a complete, zero-length (aka dummy) rewrite
346 */
347extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
348 u32 sw_if_index,
349 vnet_link_t link_type,
350 const void *dst_hw_address);
351
352/**
353 * @brief Default adjacency update function
354 */
355extern void default_update_adjacency (struct vnet_main_t *vnm,
356 u32 sw_if_index, u32 adj_index);
357
Ed Warnickecb9cada2015-12-08 15:45:58 -0700358#define VNET_HW_INTERFACE_CLASS(x,...) \
359 __VA_ARGS__ vnet_hw_interface_class_t x; \
360static void __vnet_add_hw_interface_class_registration_##x (void) \
361 __attribute__((__constructor__)) ; \
362static void __vnet_add_hw_interface_class_registration_##x (void) \
363{ \
364 vnet_main_t * vnm = vnet_get_main(); \
365 x.next_class_registration = vnm->hw_interface_class_registrations; \
366 vnm->hw_interface_class_registrations = &x; \
367} \
368__VA_ARGS__ vnet_hw_interface_class_t x
369
370/* Hardware-interface. This corresponds to a physical wire
371 that packets flow over. */
Dave Barachba868bb2016-08-08 09:51:21 -0400372typedef struct vnet_hw_interface_t
373{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700374 /* Interface name. */
Dave Barachba868bb2016-08-08 09:51:21 -0400375 u8 *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700376
377 u32 flags;
378 /* Hardware link state is up. */
379#define VNET_HW_INTERFACE_FLAG_LINK_UP (1 << 0)
380 /* Hardware duplex state */
381#define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
382#define VNET_HW_INTERFACE_FLAG_HALF_DUPLEX (1 << 1)
383#define VNET_HW_INTERFACE_FLAG_FULL_DUPLEX (1 << 2)
384#define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK \
385 (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX | \
386 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
387
388 /* Hardware link speed */
389#define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT 3
390#define VNET_HW_INTERFACE_FLAG_SPEED_10M (1 << 3)
391#define VNET_HW_INTERFACE_FLAG_SPEED_100M (1 << 4)
392#define VNET_HW_INTERFACE_FLAG_SPEED_1G (1 << 5)
393#define VNET_HW_INTERFACE_FLAG_SPEED_10G (1 << 6)
394#define VNET_HW_INTERFACE_FLAG_SPEED_40G (1 << 7)
395#define VNET_HW_INTERFACE_FLAG_SPEED_100G (1 << 8)
396#define VNET_HW_INTERFACE_FLAG_SPEED_MASK \
397 (VNET_HW_INTERFACE_FLAG_SPEED_10M | \
398 VNET_HW_INTERFACE_FLAG_SPEED_100M | \
399 VNET_HW_INTERFACE_FLAG_SPEED_1G | \
400 VNET_HW_INTERFACE_FLAG_SPEED_10G | \
401 VNET_HW_INTERFACE_FLAG_SPEED_40G | \
402 VNET_HW_INTERFACE_FLAG_SPEED_100G)
403
Damjan Mariondb2c6c62015-12-16 19:31:59 +0100404 /* l2output node flags */
405#define VNET_HW_INTERFACE_FLAG_L2OUTPUT_SHIFT 9
406#define VNET_HW_INTERFACE_FLAG_L2OUTPUT_MAPPED (1 << 9)
407
Damjan Marion44036902017-04-28 12:29:15 +0200408 /* rx mode flags */
409#define VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE (1 << 10)
410
Ed Warnickecb9cada2015-12-08 15:45:58 -0700411 /* Hardware address as vector. Zero (e.g. zero-length vector) if no
412 address for this class (e.g. PPP). */
Dave Barachba868bb2016-08-08 09:51:21 -0400413 u8 *hw_address;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700414
415 /* Interface is up as far as software is concerned. */
416 /* NAME.{output,tx} nodes for this interface. */
417 u32 output_node_index, tx_node_index;
418
419 /* (dev_class, dev_instance) uniquely identifies hw interface. */
420 u32 dev_class_index;
421 u32 dev_instance;
422
423 /* (hw_class, hw_instance) uniquely identifies hw interface. */
424 u32 hw_class_index;
425 u32 hw_instance;
426
427 /* Hardware index for this hardware interface. */
428 u32 hw_if_index;
429
430 /* Software index for this hardware interface. */
431 u32 sw_if_index;
432
433 /* Maximum transmit rate for this interface in bits/sec. */
434 f64 max_rate_bits_per_sec;
435
Mohsin Kazmif2ba9aa2016-04-24 18:53:42 +0200436 /* Smallest packet size supported by this interface. */
437 u32 min_supported_packet_bytes;
438
439 /* Largest packet size supported by this interface. */
440 u32 max_supported_packet_bytes;
441
Ed Warnickecb9cada2015-12-08 15:45:58 -0700442 /* Smallest packet size for this interface. */
443 u32 min_packet_bytes;
444
445 /* Largest packet size for this interface. */
446 u32 max_packet_bytes;
447
448 /* Number of extra bytes that go on the wire.
449 Packet length on wire
450 = max (length + per_packet_overhead_bytes, min_packet_bytes). */
451 u32 per_packet_overhead_bytes;
452
453 /* Receive and transmit layer 3 packet size limits (MRU/MTU). */
454 u32 max_l3_packet_bytes[VLIB_N_RX_TX];
455
456 /* Hash table mapping sub interface id to sw_if_index. */
Dave Barachba868bb2016-08-08 09:51:21 -0400457 uword *sub_interface_sw_if_index_by_id;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700458
459 /* Count of number of L2 subinterfaces */
460 u32 l2_if_count;
John Lobcebbb92016-04-05 15:47:43 -0400461
462 /* Bonded interface info -
463 0 - not a bonded interface nor a slave
464 ~0 - slave to a bonded interface
465 others - A bonded interface with a pointer to bitmap for all slaves */
466 uword *bond_info;
467#define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
468#define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
469
Damjan Marioneb743fa2017-03-20 16:34:15 +0100470 /* Input node */
471 u32 input_node_index;
472
473 /* input node cpu index by queue */
Damjan Marion586afd72017-04-05 19:18:20 +0200474 u32 *input_node_thread_index_by_queue;
Damjan Marioneb743fa2017-03-20 16:34:15 +0100475
Damjan Marion44036902017-04-28 12:29:15 +0200476 /* vnet_hw_interface_rx_mode by queue */
477 u8 *rx_mode_by_queue;
478
Damjan Marion153646e2017-04-05 18:15:45 +0200479 /* device input device_and_queue runtime index */
480 uword *dq_runtime_index_by_queue;
481
Ed Warnickecb9cada2015-12-08 15:45:58 -0700482} vnet_hw_interface_t;
483
Damjan Marion3d9c86e2016-07-04 21:04:40 +0200484extern vnet_device_class_t vnet_local_interface_device_class;
485
Dave Barachba868bb2016-08-08 09:51:21 -0400486typedef enum
487{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700488 /* A hw interface. */
489 VNET_SW_INTERFACE_TYPE_HARDWARE,
490
491 /* A sub-interface. */
492 VNET_SW_INTERFACE_TYPE_SUB,
493} vnet_sw_interface_type_t;
494
Damjan Marion44036902017-04-28 12:29:15 +0200495typedef enum
496{
497 VNET_HW_INTERFACE_RX_MODE_UNKNOWN,
498 VNET_HW_INTERFACE_RX_MODE_POLLING,
499 VNET_HW_INTERFACE_RX_MODE_INTERRUPT,
500 VNET_HW_INTERFACE_RX_MODE_ADAPTIVE,
501 VNET_HW_INTERFACE_NUM_RX_MODES,
502} vnet_hw_interface_rx_mode;
503
Dave Barachba868bb2016-08-08 09:51:21 -0400504typedef struct
505{
506 /*
507 * Subinterface ID. A number 0-N to uniquely identify
508 * this subinterface under the main (parent?) interface
509 */
510 u32 id;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700511
Dave Barachba868bb2016-08-08 09:51:21 -0400512 /* Classification data. Used to associate packet header with subinterface. */
513 struct
514 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700515 u16 outer_vlan_id;
516 u16 inner_vlan_id;
Dave Barachba868bb2016-08-08 09:51:21 -0400517 union
518 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700519 u16 raw_flags;
Dave Barachba868bb2016-08-08 09:51:21 -0400520 struct
521 {
522 u16 no_tags:1;
523 u16 one_tag:1;
524 u16 two_tags:1;
525 u16 dot1ad:1; /* 0 = dot1q, 1=dot1ad */
526 u16 exact_match:1;
527 u16 default_sub:1;
528 u16 outer_vlan_id_any:1;
529 u16 inner_vlan_id_any:1;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700530 } flags;
531 };
532 } eth;
533} vnet_sub_interface_t;
534
Eyal Baric5b13602016-11-24 19:42:43 +0200535typedef enum
536{
537 /* Always flood */
538 VNET_FLOOD_CLASS_NORMAL,
539 VNET_FLOOD_CLASS_TUNNEL_MASTER,
540 /* Does not flood when tunnel master is in the same L2 BD */
541 VNET_FLOOD_CLASS_TUNNEL_NORMAL
542} vnet_flood_class_t;
543
Ed Warnickecb9cada2015-12-08 15:45:58 -0700544/* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
545 tunnel, etc. Configuration (e.g. IP address) gets attached to
546 software interface. */
Dave Barachba868bb2016-08-08 09:51:21 -0400547typedef struct
548{
549 vnet_sw_interface_type_t type:16;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700550
551 u16 flags;
552 /* Interface is "up" meaning adminstratively up.
553 Up in the sense of link state being up is maintained by hardware interface. */
554#define VNET_SW_INTERFACE_FLAG_ADMIN_UP (1 << 0)
555
556 /* Interface is disabled for forwarding: punt all traffic to slow-path. */
557#define VNET_SW_INTERFACE_FLAG_PUNT (1 << 1)
558
559#define VNET_SW_INTERFACE_FLAG_PROXY_ARP (1 << 2)
560
561#define VNET_SW_INTERFACE_FLAG_UNNUMBERED (1 << 3)
562
John Lobcebbb92016-04-05 15:47:43 -0400563#define VNET_SW_INTERFACE_FLAG_BOND_SLAVE (1 << 4)
564
Eyal Bari3212c572017-03-06 11:47:50 +0200565/* Interface does not appear in CLI/API */
566#define VNET_SW_INTERFACE_FLAG_HIDDEN (1 << 5)
567
Ed Warnickecb9cada2015-12-08 15:45:58 -0700568 /* Index for this interface. */
569 u32 sw_if_index;
570
571 /* Software interface index of super-interface;
572 equal to sw_if_index if this interface is not a
573 sub-interface. */
574 u32 sup_sw_if_index;
575
576 /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
577 u32 unnumbered_sw_if_index;
578
579 u32 link_speed;
580
Dave Barachba868bb2016-08-08 09:51:21 -0400581 union
582 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700583 /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
584 u32 hw_if_index;
585
586 /* VNET_SW_INTERFACE_TYPE_SUB. */
587 vnet_sub_interface_t sub;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700588 };
Eyal Baric5b13602016-11-24 19:42:43 +0200589
590 vnet_flood_class_t flood_class;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700591} vnet_sw_interface_t;
592
Dave Barachba868bb2016-08-08 09:51:21 -0400593typedef enum
594{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700595 /* Simple counters. */
596 VNET_INTERFACE_COUNTER_DROP = 0,
597 VNET_INTERFACE_COUNTER_PUNT = 1,
598 VNET_INTERFACE_COUNTER_IP4 = 2,
599 VNET_INTERFACE_COUNTER_IP6 = 3,
600 VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
601 VNET_INTERFACE_COUNTER_RX_MISS = 5,
602 VNET_INTERFACE_COUNTER_RX_ERROR = 6,
603 VNET_INTERFACE_COUNTER_TX_ERROR = 7,
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100604 VNET_INTERFACE_COUNTER_MPLS = 8,
605 VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700606 /* Combined counters. */
607 VNET_INTERFACE_COUNTER_RX = 0,
608 VNET_INTERFACE_COUNTER_TX = 1,
609 VNET_N_COMBINED_INTERFACE_COUNTER = 2,
610} vnet_interface_counter_type_t;
611
Dave Barachba868bb2016-08-08 09:51:21 -0400612typedef struct
613{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700614 u32 output_node_index;
615 u32 tx_node_index;
616} vnet_hw_interface_nodes_t;
617
Dave Barachba868bb2016-08-08 09:51:21 -0400618typedef struct
619{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700620 /* Hardware interfaces. */
Dave Barachba868bb2016-08-08 09:51:21 -0400621 vnet_hw_interface_t *hw_interfaces;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700622
623 /* Hash table mapping HW interface name to index. */
Dave Barachba868bb2016-08-08 09:51:21 -0400624 uword *hw_interface_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700625
626 /* Vectors if hardware interface classes and device classes. */
Dave Barachba868bb2016-08-08 09:51:21 -0400627 vnet_hw_interface_class_t *hw_interface_classes;
628 vnet_device_class_t *device_classes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700629
630 /* Hash table mapping name to hw interface/device class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400631 uword *hw_interface_class_by_name;
632 uword *device_class_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700633
634 /* Software interfaces. */
Dave Barachba868bb2016-08-08 09:51:21 -0400635 vnet_sw_interface_t *sw_interfaces;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700636
637 /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
Dave Barachba868bb2016-08-08 09:51:21 -0400638 uword *sw_if_index_by_sup_and_sub;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700639
640 /* Software interface counters both simple and combined
641 packet and byte counters. */
642 volatile u32 *sw_if_counter_lock;
Dave Barachba868bb2016-08-08 09:51:21 -0400643 vlib_simple_counter_main_t *sw_if_counters;
644 vlib_combined_counter_main_t *combined_sw_if_counters;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700645
Dave Barachba868bb2016-08-08 09:51:21 -0400646 vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700647
648 /* pcap drop tracing */
649 int drop_pcap_enable;
650 pcap_main_t pcap_main;
Dave Barachba868bb2016-08-08 09:51:21 -0400651 u8 *pcap_filename;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700652 u32 pcap_sw_if_index;
653 u32 pcap_pkts_to_capture;
Dave Barachba868bb2016-08-08 09:51:21 -0400654 uword *pcap_drop_filter_hash;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700655
Damjan Marion152e21d2016-11-29 14:55:43 +0100656 /* feature_arc_index */
657 u8 output_feature_arc_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700658} vnet_interface_main_t;
659
Dave Barachba868bb2016-08-08 09:51:21 -0400660static inline void
661vnet_interface_counter_lock (vnet_interface_main_t * im)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700662{
663 if (im->sw_if_counter_lock)
664 while (__sync_lock_test_and_set (im->sw_if_counter_lock, 1))
665 /* zzzz */ ;
666}
Dave Barachba868bb2016-08-08 09:51:21 -0400667
668static inline void
669vnet_interface_counter_unlock (vnet_interface_main_t * im)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700670{
671 if (im->sw_if_counter_lock)
672 *im->sw_if_counter_lock = 0;
673}
674
675void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
676
677int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
678
Ed Warnickecb9cada2015-12-08 15:45:58 -0700679#endif /* included_vnet_interface_h */
Dave Barachba868bb2016-08-08 09:51:21 -0400680
681/*
682 * fd.io coding-style-patch-verification: ON
683 *
684 * Local Variables:
685 * eval: (c-set-style "gnu")
686 * End:
687 */