blob: e3fb47ad263453f0ec2581def53dcec9c5c4f8b5 [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
Neale Ranns8b37b872016-11-21 12:25:22 +000092#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
Eyal Barif9cda7d2018-02-13 11:50:58 +0200106#define _VNET_INTERFACE_FUNCTION_DECL(f,tag) \
107 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,VNET_ITF_FUNC_PRIORITY_LOW)
108
Ed Warnickecb9cada2015-12-08 15:45:58 -0700109#define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f) \
110 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
111#define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f) \
112 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
Neale Ranns8b37b872016-11-21 12:25:22 +0000113#define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(f,p) \
114 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,hw_interface_link_up_down,p)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700115#define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f) \
116 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
117#define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f) \
118 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
Neale Ranns8b37b872016-11-21 12:25:22 +0000119#define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(f,p) \
120 _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_admin_up_down, p)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700121
122/* A class of hardware interface devices. */
Dave Barachba868bb2016-08-08 09:51:21 -0400123typedef struct _vnet_device_class
124{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700125 /* Index into main vector. */
126 u32 index;
127
128 /* Device name (e.g. "FOOBAR 1234a"). */
Dave Barachba868bb2016-08-08 09:51:21 -0400129 char *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700130
131 /* Function to call when hardware interface is added/deleted. */
Dave Barachba868bb2016-08-08 09:51:21 -0400132 vnet_interface_function_t *interface_add_del_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700133
134 /* Function to bring device administratively up/down. */
Dave Barachba868bb2016-08-08 09:51:21 -0400135 vnet_interface_function_t *admin_up_down_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700136
137 /* Function to call when sub-interface is added/deleted */
Dave Barachba868bb2016-08-08 09:51:21 -0400138 vnet_subif_add_del_function_t *subif_add_del_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700139
Stevene3a395c2017-05-09 16:19:50 -0700140 /* Function to call interface rx mode is changed */
141 vnet_interface_set_rx_mode_function_t *rx_mode_change_function;
142
Ed Warnickecb9cada2015-12-08 15:45:58 -0700143 /* Redistribute flag changes/existence of this interface class. */
144 u32 redistribute;
145
146 /* Transmit function. */
Dave Barachba868bb2016-08-08 09:51:21 -0400147 vlib_node_function_t *tx_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700148
149 /* Error strings indexed by error code for this node. */
Dave Barachba868bb2016-08-08 09:51:21 -0400150 char **tx_function_error_strings;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700151
152 /* Number of error codes used by this node. */
153 u32 tx_function_n_errors;
154
155 /* Renumber device name [only!] support, a control-plane kludge */
Dave Barachba868bb2016-08-08 09:51:21 -0400156 int (*name_renumber) (struct vnet_hw_interface_t * hi,
157 u32 new_dev_instance);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700158
159 /* Format device instance as name. */
Dave Barachba868bb2016-08-08 09:51:21 -0400160 format_function_t *format_device_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700161
162 /* Parse function for device name. */
Dave Barachba868bb2016-08-08 09:51:21 -0400163 unformat_function_t *unformat_device_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700164
165 /* Format device verbosely for this class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400166 format_function_t *format_device;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700167
168 /* Trace buffer format for TX function. */
Dave Barachba868bb2016-08-08 09:51:21 -0400169 format_function_t *format_tx_trace;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700170
171 /* Function to clear hardware counters for device. */
Dave Barachba868bb2016-08-08 09:51:21 -0400172 void (*clear_counters) (u32 dev_class_instance);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700173
Dave Barachba868bb2016-08-08 09:51:21 -0400174 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
175 u32 hw_if_index,
176 u32 hw_class_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700177
178 /* Called when hardware class of an interface changes. */
Dave Barachba868bb2016-08-08 09:51:21 -0400179 void (*hw_class_change) (struct vnet_main_t * vnm,
180 u32 hw_if_index, u32 new_hw_class_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700181
182 /* Called to redirect traffic from a specific interface instance */
Dave Barachba868bb2016-08-08 09:51:21 -0400183 void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
184 u32 hw_if_index, u32 node_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700185
186 /* Link-list of all device classes set up by constructors created below */
Dave Barachba868bb2016-08-08 09:51:21 -0400187 struct _vnet_device_class *next_class_registration;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700188
Pavel Kotucekc631f2d2016-09-26 10:40:02 +0200189 /* Function to set mac address. */
190 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700191} vnet_device_class_t;
192
193#define VNET_DEVICE_CLASS(x,...) \
194 __VA_ARGS__ vnet_device_class_t x; \
195static void __vnet_add_device_class_registration_##x (void) \
196 __attribute__((__constructor__)) ; \
197static void __vnet_add_device_class_registration_##x (void) \
198{ \
199 vnet_main_t * vnm = vnet_get_main(); \
200 x.next_class_registration = vnm->device_class_registrations; \
201 vnm->device_class_registrations = &x; \
202} \
Dave Barachba868bb2016-08-08 09:51:21 -0400203__VA_ARGS__ vnet_device_class_t x
Ed Warnickecb9cada2015-12-08 15:45:58 -0700204
Damjan Marion1c80e832016-05-11 23:07:18 +0200205#define VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE(arch, fn, tgt) \
206 uword \
207 __attribute__ ((flatten)) \
208 __attribute__ ((target (tgt))) \
209 CLIB_CPU_OPTIMIZED \
210 fn ## _ ## arch ( vlib_main_t * vm, \
211 vlib_node_runtime_t * node, \
212 vlib_frame_t * frame) \
213 { return fn (vm, node, frame); }
214
215#define VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
216 foreach_march_variant(VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE, fn)
217
218#if CLIB_DEBUG > 0
219#define VLIB_MULTIARCH_CLONE_AND_SELECT_FN(fn,...)
220#define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn)
221#else
222#define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn) \
223 VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
224 CLIB_MULTIARCH_SELECT_FN(fn, static inline) \
225 static void __attribute__((__constructor__)) \
226 __vlib_device_tx_function_multiarch_select_##dev (void) \
227 { dev.tx_function = fn ## _multiarch_select(); }
228#endif
229
Neale Rannsb80c5362016-10-08 13:03:40 +0100230/**
231 * Link Type: A description of the protocol of packets on the link.
232 * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
233 * it maps to the GRE-proto, etc for other lnk types.
234 */
235typedef enum vnet_link_t_
236{
237#if CLIB_DEBUG > 0
238 VNET_LINK_IP4 = 1,
239#else
240 VNET_LINK_IP4 = 0,
241#endif
242 VNET_LINK_IP6,
243 VNET_LINK_MPLS,
244 VNET_LINK_ETHERNET,
245 VNET_LINK_ARP,
Florin Corasce1b4c72017-01-26 14:25:34 -0800246 VNET_LINK_NSH,
Neale Rannsb80c5362016-10-08 13:03:40 +0100247} __attribute__ ((packed)) vnet_link_t;
248
Neale Ranns924d03a2016-10-19 08:25:46 +0100249#define VNET_LINKS { \
250 [VNET_LINK_ETHERNET] = "ethernet", \
251 [VNET_LINK_IP4] = "ipv4", \
252 [VNET_LINK_IP6] = "ipv6", \
253 [VNET_LINK_MPLS] = "mpls", \
254 [VNET_LINK_ARP] = "arp", \
Florin Corasce1b4c72017-01-26 14:25:34 -0800255 [VNET_LINK_NSH] = "nsh", \
Neale Ranns924d03a2016-10-19 08:25:46 +0100256}
257
258/**
259 * @brief Number of link types. Not part of the enum so it does not have to be included in
260 * switch statements
261 */
Florin Corasce1b4c72017-01-26 14:25:34 -0800262#define VNET_LINK_NUM (VNET_LINK_NSH+1)
Neale Ranns924d03a2016-10-19 08:25:46 +0100263
Neale Rannsb80c5362016-10-08 13:03:40 +0100264/**
265 * @brief Convert a link to to an Ethertype
266 */
267extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
268
269/**
270 * @brief Attributes assignable to a HW interface Class.
271 */
272typedef enum vnet_hw_interface_class_flags_t_
273{
274 /**
275 * @brief a point 2 point interface
276 */
277 VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
278} vnet_hw_interface_class_flags_t;
Damjan Marion1c80e832016-05-11 23:07:18 +0200279
Ed Warnickecb9cada2015-12-08 15:45:58 -0700280/* Layer-2 (e.g. Ethernet) interface class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400281typedef struct _vnet_hw_interface_class
282{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700283 /* Index into main vector. */
284 u32 index;
285
286 /* Class name (e.g. "Ethernet"). */
Dave Barachba868bb2016-08-08 09:51:21 -0400287 char *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700288
Neale Rannsb80c5362016-10-08 13:03:40 +0100289 /* Flags */
290 vnet_hw_interface_class_flags_t flags;
291
Ed Warnickecb9cada2015-12-08 15:45:58 -0700292 /* Function to call when hardware interface is added/deleted. */
Dave Barachba868bb2016-08-08 09:51:21 -0400293 vnet_interface_function_t *interface_add_del_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700294
295 /* Function to bring interface administratively up/down. */
Dave Barachba868bb2016-08-08 09:51:21 -0400296 vnet_interface_function_t *admin_up_down_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700297
298 /* Function to call when link state changes. */
Dave Barachba868bb2016-08-08 09:51:21 -0400299 vnet_interface_function_t *link_up_down_function;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700300
Neale Ranns3be6b282016-12-20 14:24:01 +0000301 /* Function to call when link MAC changes. */
302 vnet_interface_set_mac_address_function_t *mac_addr_change_function;
303
Ed Warnickecb9cada2015-12-08 15:45:58 -0700304 /* Format function to display interface name. */
Dave Barachba868bb2016-08-08 09:51:21 -0400305 format_function_t *format_interface_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700306
307 /* Format function to display interface address. */
Dave Barachba868bb2016-08-08 09:51:21 -0400308 format_function_t *format_address;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700309
310 /* Format packet header for this interface class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400311 format_function_t *format_header;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700312
313 /* Format device verbosely for this class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400314 format_function_t *format_device;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700315
316 /* Parser for hardware (e.g. ethernet) address. */
Dave Barachba868bb2016-08-08 09:51:21 -0400317 unformat_function_t *unformat_hw_address;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700318
319 /* Parser for packet header for e.g. rewrite string. */
Dave Barachba868bb2016-08-08 09:51:21 -0400320 unformat_function_t *unformat_header;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700321
Neale Rannsb80c5362016-10-08 13:03:40 +0100322 /* Builds a rewrite string for the interface to the destination
323 * for the payload/link type. */
324 u8 *(*build_rewrite) (struct vnet_main_t * vnm,
325 u32 sw_if_index,
326 vnet_link_t link_type, const void *dst_hw_address);
327
328 /* Update an adjacecny added by FIB (as opposed to via the
329 * neighbour resolution protocol). */
330 void (*update_adjacency) (struct vnet_main_t * vnm,
331 u32 sw_if_index, u32 adj_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700332
Dave Barachba868bb2016-08-08 09:51:21 -0400333 uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
334 u32 hw_if_index,
335 u32 hw_class_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700336
337 /* Called when hw interface class is changed and old hardware instance
338 may want to be deleted. */
Dave Barachba868bb2016-08-08 09:51:21 -0400339 void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
340 u32 old_class_index, u32 new_class_index);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700341
342 /* List of hw interface classes, built by constructors */
Dave Barachba868bb2016-08-08 09:51:21 -0400343 struct _vnet_hw_interface_class *next_class_registration;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700344
345} vnet_hw_interface_class_t;
346
Neale Rannsb80c5362016-10-08 13:03:40 +0100347/**
348 * @brief Return a complete, zero-length (aka dummy) rewrite
349 */
350extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
351 u32 sw_if_index,
352 vnet_link_t link_type,
353 const void *dst_hw_address);
354
355/**
356 * @brief Default adjacency update function
357 */
358extern void default_update_adjacency (struct vnet_main_t *vnm,
359 u32 sw_if_index, u32 adj_index);
360
Ed Warnickecb9cada2015-12-08 15:45:58 -0700361#define VNET_HW_INTERFACE_CLASS(x,...) \
362 __VA_ARGS__ vnet_hw_interface_class_t x; \
363static void __vnet_add_hw_interface_class_registration_##x (void) \
364 __attribute__((__constructor__)) ; \
365static void __vnet_add_hw_interface_class_registration_##x (void) \
366{ \
367 vnet_main_t * vnm = vnet_get_main(); \
368 x.next_class_registration = vnm->hw_interface_class_registrations; \
369 vnm->hw_interface_class_registrations = &x; \
370} \
371__VA_ARGS__ vnet_hw_interface_class_t x
372
373/* Hardware-interface. This corresponds to a physical wire
374 that packets flow over. */
Dave Barachba868bb2016-08-08 09:51:21 -0400375typedef struct vnet_hw_interface_t
376{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700377 /* Interface name. */
Dave Barachba868bb2016-08-08 09:51:21 -0400378 u8 *name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700379
380 u32 flags;
381 /* Hardware link state is up. */
382#define VNET_HW_INTERFACE_FLAG_LINK_UP (1 << 0)
383 /* Hardware duplex state */
384#define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
385#define VNET_HW_INTERFACE_FLAG_HALF_DUPLEX (1 << 1)
386#define VNET_HW_INTERFACE_FLAG_FULL_DUPLEX (1 << 2)
387#define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK \
388 (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX | \
389 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
390
391 /* Hardware link speed */
392#define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT 3
393#define VNET_HW_INTERFACE_FLAG_SPEED_10M (1 << 3)
394#define VNET_HW_INTERFACE_FLAG_SPEED_100M (1 << 4)
395#define VNET_HW_INTERFACE_FLAG_SPEED_1G (1 << 5)
396#define VNET_HW_INTERFACE_FLAG_SPEED_10G (1 << 6)
397#define VNET_HW_INTERFACE_FLAG_SPEED_40G (1 << 7)
398#define VNET_HW_INTERFACE_FLAG_SPEED_100G (1 << 8)
399#define VNET_HW_INTERFACE_FLAG_SPEED_MASK \
400 (VNET_HW_INTERFACE_FLAG_SPEED_10M | \
401 VNET_HW_INTERFACE_FLAG_SPEED_100M | \
402 VNET_HW_INTERFACE_FLAG_SPEED_1G | \
403 VNET_HW_INTERFACE_FLAG_SPEED_10G | \
404 VNET_HW_INTERFACE_FLAG_SPEED_40G | \
405 VNET_HW_INTERFACE_FLAG_SPEED_100G)
406
Damjan Marion44036902017-04-28 12:29:15 +0200407 /* rx mode flags */
408#define VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE (1 << 10)
409
Dave Barach2c0a4f42017-06-29 09:30:15 -0400410 /* tx checksum offload */
411#define VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD (1 << 11)
412
Ed Warnickecb9cada2015-12-08 15:45:58 -0700413 /* Hardware address as vector. Zero (e.g. zero-length vector) if no
414 address for this class (e.g. PPP). */
Dave Barachba868bb2016-08-08 09:51:21 -0400415 u8 *hw_address;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700416
417 /* Interface is up as far as software is concerned. */
418 /* NAME.{output,tx} nodes for this interface. */
419 u32 output_node_index, tx_node_index;
420
421 /* (dev_class, dev_instance) uniquely identifies hw interface. */
422 u32 dev_class_index;
423 u32 dev_instance;
424
425 /* (hw_class, hw_instance) uniquely identifies hw interface. */
426 u32 hw_class_index;
427 u32 hw_instance;
428
429 /* Hardware index for this hardware interface. */
430 u32 hw_if_index;
431
432 /* Software index for this hardware interface. */
433 u32 sw_if_index;
434
John Loe5453d02018-01-23 19:21:34 -0500435 /* Next index in interface-output node for this interface
436 used by node function vnet_per_buffer_interface_output() */
437 u32 output_node_next_index;
438
Ed Warnickecb9cada2015-12-08 15:45:58 -0700439 /* Maximum transmit rate for this interface in bits/sec. */
440 f64 max_rate_bits_per_sec;
441
Mohsin Kazmif2ba9aa2016-04-24 18:53:42 +0200442 /* Smallest packet size supported by this interface. */
443 u32 min_supported_packet_bytes;
444
445 /* Largest packet size supported by this interface. */
446 u32 max_supported_packet_bytes;
447
Ed Warnickecb9cada2015-12-08 15:45:58 -0700448 /* Smallest packet size for this interface. */
449 u32 min_packet_bytes;
450
451 /* Largest packet size for this interface. */
452 u32 max_packet_bytes;
453
454 /* Number of extra bytes that go on the wire.
455 Packet length on wire
456 = max (length + per_packet_overhead_bytes, min_packet_bytes). */
457 u32 per_packet_overhead_bytes;
458
459 /* Receive and transmit layer 3 packet size limits (MRU/MTU). */
460 u32 max_l3_packet_bytes[VLIB_N_RX_TX];
461
462 /* Hash table mapping sub interface id to sw_if_index. */
Dave Barachba868bb2016-08-08 09:51:21 -0400463 uword *sub_interface_sw_if_index_by_id;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700464
465 /* Count of number of L2 subinterfaces */
466 u32 l2_if_count;
John Lobcebbb92016-04-05 15:47:43 -0400467
468 /* Bonded interface info -
469 0 - not a bonded interface nor a slave
470 ~0 - slave to a bonded interface
471 others - A bonded interface with a pointer to bitmap for all slaves */
472 uword *bond_info;
473#define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
474#define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
475
Damjan Marioneb743fa2017-03-20 16:34:15 +0100476 /* Input node */
477 u32 input_node_index;
478
479 /* input node cpu index by queue */
Damjan Marion586afd72017-04-05 19:18:20 +0200480 u32 *input_node_thread_index_by_queue;
Damjan Marioneb743fa2017-03-20 16:34:15 +0100481
Damjan Marion44036902017-04-28 12:29:15 +0200482 /* vnet_hw_interface_rx_mode by queue */
483 u8 *rx_mode_by_queue;
Damjan Marion4e53a0d2017-06-21 14:29:44 +0200484 vnet_hw_interface_rx_mode default_rx_mode;
Damjan Marion44036902017-04-28 12:29:15 +0200485
Damjan Marion153646e2017-04-05 18:15:45 +0200486 /* device input device_and_queue runtime index */
487 uword *dq_runtime_index_by_queue;
488
Ed Warnickecb9cada2015-12-08 15:45:58 -0700489} vnet_hw_interface_t;
490
Damjan Marion3d9c86e2016-07-04 21:04:40 +0200491extern vnet_device_class_t vnet_local_interface_device_class;
492
Dave Barachba868bb2016-08-08 09:51:21 -0400493typedef enum
494{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700495 /* A hw interface. */
496 VNET_SW_INTERFACE_TYPE_HARDWARE,
497
498 /* A sub-interface. */
499 VNET_SW_INTERFACE_TYPE_SUB,
Pavel Kotucek15ac81c2017-06-20 14:00:26 +0200500 VNET_SW_INTERFACE_TYPE_P2P,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700501} vnet_sw_interface_type_t;
502
Dave Barachba868bb2016-08-08 09:51:21 -0400503typedef struct
504{
505 /*
506 * Subinterface ID. A number 0-N to uniquely identify
507 * this subinterface under the main (parent?) interface
508 */
509 u32 id;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700510
Dave Barachba868bb2016-08-08 09:51:21 -0400511 /* Classification data. Used to associate packet header with subinterface. */
512 struct
513 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700514 u16 outer_vlan_id;
515 u16 inner_vlan_id;
Dave Barachba868bb2016-08-08 09:51:21 -0400516 union
517 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700518 u16 raw_flags;
Dave Barachba868bb2016-08-08 09:51:21 -0400519 struct
520 {
521 u16 no_tags:1;
522 u16 one_tag:1;
523 u16 two_tags:1;
524 u16 dot1ad:1; /* 0 = dot1q, 1=dot1ad */
525 u16 exact_match:1;
526 u16 default_sub:1;
527 u16 outer_vlan_id_any:1;
528 u16 inner_vlan_id_any:1;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700529 } flags;
530 };
531 } eth;
532} vnet_sub_interface_t;
533
Pavel Kotucek15ac81c2017-06-20 14:00:26 +0200534typedef struct
535{
536 /*
537 * Subinterface ID. A number 0-N to uniquely identify
538 * this subinterface under the main interface
539 */
540 u32 id;
541 u32 pool_index;
542 u8 client_mac[6];
543} vnet_p2p_sub_interface_t;
544
Eyal Baric5b13602016-11-24 19:42:43 +0200545typedef enum
546{
547 /* Always flood */
548 VNET_FLOOD_CLASS_NORMAL,
549 VNET_FLOOD_CLASS_TUNNEL_MASTER,
550 /* Does not flood when tunnel master is in the same L2 BD */
551 VNET_FLOOD_CLASS_TUNNEL_NORMAL
552} vnet_flood_class_t;
553
Ed Warnickecb9cada2015-12-08 15:45:58 -0700554/* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
555 tunnel, etc. Configuration (e.g. IP address) gets attached to
556 software interface. */
Dave Barachba868bb2016-08-08 09:51:21 -0400557typedef struct
558{
559 vnet_sw_interface_type_t type:16;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700560
561 u16 flags;
562 /* Interface is "up" meaning adminstratively up.
563 Up in the sense of link state being up is maintained by hardware interface. */
564#define VNET_SW_INTERFACE_FLAG_ADMIN_UP (1 << 0)
565
566 /* Interface is disabled for forwarding: punt all traffic to slow-path. */
567#define VNET_SW_INTERFACE_FLAG_PUNT (1 << 1)
568
569#define VNET_SW_INTERFACE_FLAG_PROXY_ARP (1 << 2)
570
571#define VNET_SW_INTERFACE_FLAG_UNNUMBERED (1 << 3)
572
John Lobcebbb92016-04-05 15:47:43 -0400573#define VNET_SW_INTERFACE_FLAG_BOND_SLAVE (1 << 4)
574
John Lob2fd6cb2017-07-12 19:56:45 -0400575 /* Interface does not appear in CLI/API */
Eyal Bari3212c572017-03-06 11:47:50 +0200576#define VNET_SW_INTERFACE_FLAG_HIDDEN (1 << 5)
577
John Lob2fd6cb2017-07-12 19:56:45 -0400578 /* Interface in ERROR state */
Damjan Marionabce5092017-05-10 20:09:31 +0200579#define VNET_SW_INTERFACE_FLAG_ERROR (1 << 6)
580
Ed Warnickecb9cada2015-12-08 15:45:58 -0700581 /* Index for this interface. */
582 u32 sw_if_index;
583
584 /* Software interface index of super-interface;
585 equal to sw_if_index if this interface is not a
586 sub-interface. */
587 u32 sup_sw_if_index;
588
589 /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
590 u32 unnumbered_sw_if_index;
591
592 u32 link_speed;
593
Dave Barachba868bb2016-08-08 09:51:21 -0400594 union
595 {
Ed Warnickecb9cada2015-12-08 15:45:58 -0700596 /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
597 u32 hw_if_index;
598
599 /* VNET_SW_INTERFACE_TYPE_SUB. */
600 vnet_sub_interface_t sub;
Pavel Kotucek15ac81c2017-06-20 14:00:26 +0200601
602 /* VNET_SW_INTERFACE_TYPE_P2P. */
603 vnet_p2p_sub_interface_t p2p;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700604 };
Eyal Baric5b13602016-11-24 19:42:43 +0200605
606 vnet_flood_class_t flood_class;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700607} vnet_sw_interface_t;
608
Dave Barachba868bb2016-08-08 09:51:21 -0400609typedef enum
610{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700611 /* Simple counters. */
612 VNET_INTERFACE_COUNTER_DROP = 0,
613 VNET_INTERFACE_COUNTER_PUNT = 1,
614 VNET_INTERFACE_COUNTER_IP4 = 2,
615 VNET_INTERFACE_COUNTER_IP6 = 3,
616 VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
617 VNET_INTERFACE_COUNTER_RX_MISS = 5,
618 VNET_INTERFACE_COUNTER_RX_ERROR = 6,
619 VNET_INTERFACE_COUNTER_TX_ERROR = 7,
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100620 VNET_INTERFACE_COUNTER_MPLS = 8,
621 VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
Ed Warnickecb9cada2015-12-08 15:45:58 -0700622 /* Combined counters. */
623 VNET_INTERFACE_COUNTER_RX = 0,
624 VNET_INTERFACE_COUNTER_TX = 1,
625 VNET_N_COMBINED_INTERFACE_COUNTER = 2,
626} vnet_interface_counter_type_t;
627
Dave Barachba868bb2016-08-08 09:51:21 -0400628typedef struct
629{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700630 u32 output_node_index;
631 u32 tx_node_index;
632} vnet_hw_interface_nodes_t;
633
Dave Barachba868bb2016-08-08 09:51:21 -0400634typedef struct
635{
Ed Warnickecb9cada2015-12-08 15:45:58 -0700636 /* Hardware interfaces. */
Dave Barachba868bb2016-08-08 09:51:21 -0400637 vnet_hw_interface_t *hw_interfaces;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700638
639 /* Hash table mapping HW interface name to index. */
Dave Barachba868bb2016-08-08 09:51:21 -0400640 uword *hw_interface_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700641
642 /* Vectors if hardware interface classes and device classes. */
Dave Barachba868bb2016-08-08 09:51:21 -0400643 vnet_hw_interface_class_t *hw_interface_classes;
644 vnet_device_class_t *device_classes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700645
646 /* Hash table mapping name to hw interface/device class. */
Dave Barachba868bb2016-08-08 09:51:21 -0400647 uword *hw_interface_class_by_name;
648 uword *device_class_by_name;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700649
650 /* Software interfaces. */
Dave Barachba868bb2016-08-08 09:51:21 -0400651 vnet_sw_interface_t *sw_interfaces;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700652
653 /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
Dave Barachba868bb2016-08-08 09:51:21 -0400654 uword *sw_if_index_by_sup_and_sub;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700655
656 /* Software interface counters both simple and combined
657 packet and byte counters. */
658 volatile u32 *sw_if_counter_lock;
Dave Barachba868bb2016-08-08 09:51:21 -0400659 vlib_simple_counter_main_t *sw_if_counters;
660 vlib_combined_counter_main_t *combined_sw_if_counters;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700661
Dave Barachba868bb2016-08-08 09:51:21 -0400662 vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700663
664 /* pcap drop tracing */
665 int drop_pcap_enable;
666 pcap_main_t pcap_main;
Dave Barachba868bb2016-08-08 09:51:21 -0400667 u8 *pcap_filename;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700668 u32 pcap_sw_if_index;
669 u32 pcap_pkts_to_capture;
Dave Barachba868bb2016-08-08 09:51:21 -0400670 uword *pcap_drop_filter_hash;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700671
Damjan Marion152e21d2016-11-29 14:55:43 +0100672 /* feature_arc_index */
673 u8 output_feature_arc_index;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700674} vnet_interface_main_t;
675
Dave Barachba868bb2016-08-08 09:51:21 -0400676static inline void
677vnet_interface_counter_lock (vnet_interface_main_t * im)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700678{
679 if (im->sw_if_counter_lock)
680 while (__sync_lock_test_and_set (im->sw_if_counter_lock, 1))
681 /* zzzz */ ;
682}
Dave Barachba868bb2016-08-08 09:51:21 -0400683
684static inline void
685vnet_interface_counter_unlock (vnet_interface_main_t * im)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700686{
687 if (im->sw_if_counter_lock)
688 *im->sw_if_counter_lock = 0;
689}
690
691void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
692
693int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
694
Ed Warnickecb9cada2015-12-08 15:45:58 -0700695#endif /* included_vnet_interface_h */
Dave Barachba868bb2016-08-08 09:51:21 -0400696
697/*
698 * fd.io coding-style-patch-verification: ON
699 *
700 * Local Variables:
701 * eval: (c-set-style "gnu")
702 * End:
703 */