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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * interface.h: VNET interfaces/sub-interfaces
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 #ifndef included_vnet_interface_h
41 #define included_vnet_interface_h
43 #include <vnet/unix/pcap.h>
46 struct vnet_hw_interface_t;
47 struct vnet_sw_interface_t;
49 /* Interface up/down callback. */
50 typedef clib_error_t * (vnet_interface_function_t)
51 (struct vnet_main_t * vnm, u32 if_index, u32 flags);
53 /* Sub-interface add/del callback. */
54 typedef clib_error_t * (vnet_subif_add_del_function_t)
55 (struct vnet_main_t * vnm, u32 if_index,
56 struct vnet_sw_interface_t * template,
59 typedef struct _vnet_interface_function_list_elt {
60 struct _vnet_interface_function_list_elt * next_interface_function;
61 clib_error_t * (*fp) (struct vnet_main_t * vnm, u32 if_index, u32 flags);
62 } _vnet_interface_function_list_elt_t;
64 #define _VNET_INTERFACE_FUNCTION_DECL(f,tag) \
66 static void __vnet_interface_function_init_##tag##_##f (void) \
67 __attribute__((__constructor__)) ; \
69 static void __vnet_interface_function_init_##tag##_##f (void) \
71 vnet_main_t * vnm = vnet_get_main(); \
72 static _vnet_interface_function_list_elt_t init_function; \
73 init_function.next_interface_function = vnm->tag##_functions; \
74 vnm->tag##_functions = &init_function; \
75 init_function.fp = (void *) &f; \
78 #define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f) \
79 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
80 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f) \
81 _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
82 #define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f) \
83 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
84 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f) \
85 _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
87 /* A class of hardware interface devices. */
88 typedef struct _vnet_device_class {
89 /* Index into main vector. */
92 /* Device name (e.g. "FOOBAR 1234a"). */
95 /* Function to call when hardware interface is added/deleted. */
96 vnet_interface_function_t * interface_add_del_function;
98 /* Function to bring device administratively up/down. */
99 vnet_interface_function_t * admin_up_down_function;
101 /* Function to call when sub-interface is added/deleted */
102 vnet_subif_add_del_function_t * subif_add_del_function;
104 /* Redistribute flag changes/existence of this interface class. */
107 /* Transmit function. */
108 vlib_node_function_t * tx_function;
110 /* Error strings indexed by error code for this node. */
111 char ** tx_function_error_strings;
113 /* Number of error codes used by this node. */
114 u32 tx_function_n_errors;
116 /* Renumber device name [only!] support, a control-plane kludge */
117 int (*name_renumber) (struct vnet_hw_interface_t * hi, u32 new_dev_instance);
119 /* Format device instance as name. */
120 format_function_t * format_device_name;
122 /* Parse function for device name. */
123 unformat_function_t * unformat_device_name;
125 /* Format device verbosely for this class. */
126 format_function_t * format_device;
128 /* Trace buffer format for TX function. */
129 format_function_t * format_tx_trace;
131 /* Function to clear hardware counters for device. */
132 void (* clear_counters) (u32 dev_class_instance);
134 uword (* is_valid_class_for_interface) (struct vnet_main_t * vnm, u32 hw_if_index, u32 hw_class_index);
136 /* Called when hardware class of an interface changes. */
137 void ( * hw_class_change) (struct vnet_main_t * vnm,
139 u32 new_hw_class_index);
141 /* Called to redirect traffic from a specific interface instance */
142 void (* rx_redirect_to_node) (struct vnet_main_t * vnm,
146 /* Link-list of all device classes set up by constructors created below */
147 struct _vnet_device_class * next_class_registration;
149 /* Do not splice vnet_interface_output_node into TX path */
150 u8 no_flatten_output_chains;
152 } vnet_device_class_t;
154 #define VNET_DEVICE_CLASS(x,...) \
155 __VA_ARGS__ vnet_device_class_t x; \
156 static void __vnet_add_device_class_registration_##x (void) \
157 __attribute__((__constructor__)) ; \
158 static void __vnet_add_device_class_registration_##x (void) \
160 vnet_main_t * vnm = vnet_get_main(); \
161 x.next_class_registration = vnm->device_class_registrations; \
162 vnm->device_class_registrations = &x; \
164 __VA_ARGS__ vnet_device_class_t x
166 #define VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE(arch, fn, tgt) \
168 __attribute__ ((flatten)) \
169 __attribute__ ((target (tgt))) \
171 fn ## _ ## arch ( vlib_main_t * vm, \
172 vlib_node_runtime_t * node, \
173 vlib_frame_t * frame) \
174 { return fn (vm, node, frame); }
176 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
177 foreach_march_variant(VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE, fn)
180 #define VLIB_MULTIARCH_CLONE_AND_SELECT_FN(fn,...)
181 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn)
183 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn) \
184 VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
185 CLIB_MULTIARCH_SELECT_FN(fn, static inline) \
186 static void __attribute__((__constructor__)) \
187 __vlib_device_tx_function_multiarch_select_##dev (void) \
188 { dev.tx_function = fn ## _multiarch_select(); }
192 /* Layer-2 (e.g. Ethernet) interface class. */
193 typedef struct _vnet_hw_interface_class {
194 /* Index into main vector. */
197 /* Class name (e.g. "Ethernet"). */
200 /* Function to call when hardware interface is added/deleted. */
201 vnet_interface_function_t * interface_add_del_function;
203 /* Function to bring interface administratively up/down. */
204 vnet_interface_function_t * admin_up_down_function;
206 /* Function to call when link state changes. */
207 vnet_interface_function_t * link_up_down_function;
209 /* Format function to display interface name. */
210 format_function_t * format_interface_name;
212 /* Format function to display interface address. */
213 format_function_t * format_address;
215 /* Format packet header for this interface class. */
216 format_function_t * format_header;
218 /* Format device verbosely for this class. */
219 format_function_t * format_device;
221 /* Parser for hardware (e.g. ethernet) address. */
222 unformat_function_t * unformat_hw_address;
224 /* Parser for packet header for e.g. rewrite string. */
225 unformat_function_t * unformat_header;
227 /* Forms adjacency for given l3 packet type and destination address.
228 Returns number of bytes in adjacency. */
229 uword (* set_rewrite) (struct vnet_main_t * vnm,
234 uword max_rewrite_bytes);
236 uword (* is_valid_class_for_interface) (struct vnet_main_t * vnm, u32 hw_if_index, u32 hw_class_index);
238 /* Called when hw interface class is changed and old hardware instance
239 may want to be deleted. */
240 void (* hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index, u32 old_class_index, u32 new_class_index);
242 /* List of hw interface classes, built by constructors */
243 struct _vnet_hw_interface_class * next_class_registration;
245 } vnet_hw_interface_class_t;
247 #define VNET_HW_INTERFACE_CLASS(x,...) \
248 __VA_ARGS__ vnet_hw_interface_class_t x; \
249 static void __vnet_add_hw_interface_class_registration_##x (void) \
250 __attribute__((__constructor__)) ; \
251 static void __vnet_add_hw_interface_class_registration_##x (void) \
253 vnet_main_t * vnm = vnet_get_main(); \
254 x.next_class_registration = vnm->hw_interface_class_registrations; \
255 vnm->hw_interface_class_registrations = &x; \
257 __VA_ARGS__ vnet_hw_interface_class_t x
259 /* Hardware-interface. This corresponds to a physical wire
260 that packets flow over. */
261 typedef struct vnet_hw_interface_t {
262 /* Interface name. */
266 /* Hardware link state is up. */
267 #define VNET_HW_INTERFACE_FLAG_LINK_UP (1 << 0)
268 /* Hardware duplex state */
269 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
270 #define VNET_HW_INTERFACE_FLAG_HALF_DUPLEX (1 << 1)
271 #define VNET_HW_INTERFACE_FLAG_FULL_DUPLEX (1 << 2)
272 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK \
273 (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX | \
274 VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
276 /* Hardware link speed */
277 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT 3
278 #define VNET_HW_INTERFACE_FLAG_SPEED_10M (1 << 3)
279 #define VNET_HW_INTERFACE_FLAG_SPEED_100M (1 << 4)
280 #define VNET_HW_INTERFACE_FLAG_SPEED_1G (1 << 5)
281 #define VNET_HW_INTERFACE_FLAG_SPEED_10G (1 << 6)
282 #define VNET_HW_INTERFACE_FLAG_SPEED_40G (1 << 7)
283 #define VNET_HW_INTERFACE_FLAG_SPEED_100G (1 << 8)
284 #define VNET_HW_INTERFACE_FLAG_SPEED_MASK \
285 (VNET_HW_INTERFACE_FLAG_SPEED_10M | \
286 VNET_HW_INTERFACE_FLAG_SPEED_100M | \
287 VNET_HW_INTERFACE_FLAG_SPEED_1G | \
288 VNET_HW_INTERFACE_FLAG_SPEED_10G | \
289 VNET_HW_INTERFACE_FLAG_SPEED_40G | \
290 VNET_HW_INTERFACE_FLAG_SPEED_100G)
292 /* l2output node flags */
293 #define VNET_HW_INTERFACE_FLAG_L2OUTPUT_SHIFT 9
294 #define VNET_HW_INTERFACE_FLAG_L2OUTPUT_MAPPED (1 << 9)
296 /* Hardware address as vector. Zero (e.g. zero-length vector) if no
297 address for this class (e.g. PPP). */
300 /* Interface is up as far as software is concerned. */
301 /* NAME.{output,tx} nodes for this interface. */
302 u32 output_node_index, tx_node_index;
304 /* (dev_class, dev_instance) uniquely identifies hw interface. */
308 /* (hw_class, hw_instance) uniquely identifies hw interface. */
312 /* Hardware index for this hardware interface. */
315 /* Software index for this hardware interface. */
318 /* Maximum transmit rate for this interface in bits/sec. */
319 f64 max_rate_bits_per_sec;
321 /* Smallest packet size supported by this interface. */
322 u32 min_supported_packet_bytes;
324 /* Largest packet size supported by this interface. */
325 u32 max_supported_packet_bytes;
327 /* Smallest packet size for this interface. */
328 u32 min_packet_bytes;
330 /* Largest packet size for this interface. */
331 u32 max_packet_bytes;
333 /* Number of extra bytes that go on the wire.
334 Packet length on wire
335 = max (length + per_packet_overhead_bytes, min_packet_bytes). */
336 u32 per_packet_overhead_bytes;
338 /* Receive and transmit layer 3 packet size limits (MRU/MTU). */
339 u32 max_l3_packet_bytes[VLIB_N_RX_TX];
341 /* Hash table mapping sub interface id to sw_if_index. */
342 uword * sub_interface_sw_if_index_by_id;
344 /* Count of number of L2 subinterfaces */
347 /* Bonded interface info -
348 0 - not a bonded interface nor a slave
349 ~0 - slave to a bonded interface
350 others - A bonded interface with a pointer to bitmap for all slaves */
352 #define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
353 #define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
355 } vnet_hw_interface_t;
357 extern vnet_device_class_t vnet_local_interface_device_class;
360 /* A hw interface. */
361 VNET_SW_INTERFACE_TYPE_HARDWARE,
363 /* A sub-interface. */
364 VNET_SW_INTERFACE_TYPE_SUB,
365 } vnet_sw_interface_type_t;
368 // Subinterface ID. A number 0-N to uniquely identify this subinterface under the
369 // main (parent?) interface
372 // Classification data. Used to associate packet header with subinterface.
382 u16 dot1ad:1; // 0 = dot1q, 1=dot1ad
385 u16 outer_vlan_id_any:1;
386 u16 inner_vlan_id_any:1;
390 } vnet_sub_interface_t;
392 /* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
393 tunnel, etc. Configuration (e.g. IP address) gets attached to
394 software interface. */
396 vnet_sw_interface_type_t type : 16;
399 /* Interface is "up" meaning adminstratively up.
400 Up in the sense of link state being up is maintained by hardware interface. */
401 #define VNET_SW_INTERFACE_FLAG_ADMIN_UP (1 << 0)
403 /* Interface is disabled for forwarding: punt all traffic to slow-path. */
404 #define VNET_SW_INTERFACE_FLAG_PUNT (1 << 1)
406 #define VNET_SW_INTERFACE_FLAG_PROXY_ARP (1 << 2)
408 #define VNET_SW_INTERFACE_FLAG_UNNUMBERED (1 << 3)
410 #define VNET_SW_INTERFACE_FLAG_BOND_SLAVE (1 << 4)
412 /* Index for this interface. */
415 /* Software interface index of super-interface;
416 equal to sw_if_index if this interface is not a
420 /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
421 u32 unnumbered_sw_if_index;
425 u32 output_feature_bitmap;
428 /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
431 /* VNET_SW_INTERFACE_TYPE_SUB. */
432 vnet_sub_interface_t sub;
434 /* SW interfaces are sorted by type and key. */
437 } vnet_sw_interface_t;
440 /* Simple counters. */
441 VNET_INTERFACE_COUNTER_DROP = 0,
442 VNET_INTERFACE_COUNTER_PUNT = 1,
443 VNET_INTERFACE_COUNTER_IP4 = 2,
444 VNET_INTERFACE_COUNTER_IP6 = 3,
445 VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
446 VNET_INTERFACE_COUNTER_RX_MISS = 5,
447 VNET_INTERFACE_COUNTER_RX_ERROR = 6,
448 VNET_INTERFACE_COUNTER_TX_ERROR = 7,
449 VNET_N_SIMPLE_INTERFACE_COUNTER = 8,
450 /* Combined counters. */
451 VNET_INTERFACE_COUNTER_RX = 0,
452 VNET_INTERFACE_COUNTER_TX = 1,
453 VNET_N_COMBINED_INTERFACE_COUNTER = 2,
454 } vnet_interface_counter_type_t;
457 u32 output_node_index;
459 } vnet_hw_interface_nodes_t;
462 /* Hardware interfaces. */
463 vnet_hw_interface_t * hw_interfaces;
465 /* Hash table mapping HW interface name to index. */
466 uword * hw_interface_by_name;
468 /* Vectors if hardware interface classes and device classes. */
469 vnet_hw_interface_class_t * hw_interface_classes;
470 vnet_device_class_t * device_classes;
472 /* Hash table mapping name to hw interface/device class. */
473 uword * hw_interface_class_by_name;
474 uword * device_class_by_name;
476 /* Software interfaces. */
477 vnet_sw_interface_t * sw_interfaces;
479 /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
480 uword * sw_if_index_by_sup_and_sub;
482 /* Software interface counters both simple and combined
483 packet and byte counters. */
484 volatile u32 *sw_if_counter_lock;
485 vlib_simple_counter_main_t * sw_if_counters;
486 vlib_combined_counter_main_t * combined_sw_if_counters;
488 vnet_hw_interface_nodes_t * deleted_hw_interface_nodes;
490 /* pcap drop tracing */
491 int drop_pcap_enable;
492 pcap_main_t pcap_main;
494 u32 pcap_sw_if_index;
495 u32 pcap_pkts_to_capture;
496 uword * pcap_drop_filter_hash;
498 } vnet_interface_main_t;
500 static inline void vnet_interface_counter_lock (vnet_interface_main_t *im)
502 if (im->sw_if_counter_lock)
503 while (__sync_lock_test_and_set (im->sw_if_counter_lock, 1))
506 static inline void vnet_interface_counter_unlock (vnet_interface_main_t *im)
508 if (im->sw_if_counter_lock)
509 *im->sw_if_counter_lock = 0;
512 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
514 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
521 #define foreach_intf_output_feat \
522 _(IPSEC, "ipsec-output")
524 // Feature bitmap positions
526 #define _(sym,str) INTF_OUTPUT_FEAT_##sym,
527 foreach_intf_output_feat
530 } intf_output_feat_t;
532 /* flag that we are done with feature path */
533 #define INTF_OUTPUT_FEAT_DONE INTF_OUTPUT_N_FEAT
535 int vnet_interface_add_del_feature(struct vnet_main_t * vnm, vlib_main_t * vm,
537 intf_output_feat_t feature, int is_add);
539 #endif /* included_vnet_interface_h */