FD.io VPP  v18.10-34-gcce845e
Vector Packet Processing
interface.h
Go to the documentation of this file.
1 /*
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>
44 #include <vnet/l3_types.h>
45 
46 struct vnet_main_t;
47 struct vnet_hw_interface_t;
48 struct vnet_sw_interface_t;
49 struct ip46_address_t;
50 
51 typedef enum
52 {
60 
61 /* Interface up/down callback. */
63  (struct vnet_main_t * vnm, u32 if_index, u32 flags);
64 
65 /* Sub-interface add/del callback. */
67  (struct vnet_main_t * vnm, u32 if_index,
68  struct vnet_sw_interface_t * template, int is_add);
69 
70 /* Interface set mac address callback. */
72  (struct vnet_hw_interface_t * hi,
73  const u8 * old_address, const u8 * new_address);
74 
75 /* Interface set rx mode callback. */
77  (struct vnet_main_t * vnm, u32 if_index, u32 queue_id,
78  vnet_hw_interface_rx_mode mode);
79 
80 /* Interface set l2 mode callback. */
82  (struct vnet_main_t * vnm, struct vnet_hw_interface_t * hi,
83  i32 l2_if_adjust);
84 
85 typedef enum
86 {
92 
93 /* Interface flow operations callback. */
94 typedef int (vnet_flow_dev_ops_function_t) (struct vnet_main_t * vnm,
95  vnet_flow_dev_op_t op,
96  u32 hw_if_index, u32 index,
97  uword * private_data);
98 
100 {
104 #define VNET_ITF_FUNC_N_PRIO ((vnet_interface_function_priority_t)VNET_ITF_FUNC_PRIORITY_HIGH+1)
105 
106 typedef struct _vnet_interface_function_list_elt
107 {
108  struct _vnet_interface_function_list_elt *next_interface_function;
109  clib_error_t *(*fp) (struct vnet_main_t * vnm, u32 if_index, u32 flags);
110 } _vnet_interface_function_list_elt_t;
111 
112 #ifndef CLIB_MARCH_VARIANT
113 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
114  \
115 static void __vnet_interface_function_init_##tag##_##f (void) \
116  __attribute__((__constructor__)) ; \
117  \
118 static void __vnet_interface_function_init_##tag##_##f (void) \
119 { \
120  vnet_main_t * vnm = vnet_get_main(); \
121  static _vnet_interface_function_list_elt_t init_function; \
122  init_function.next_interface_function = vnm->tag##_functions[p]; \
123  vnm->tag##_functions[p] = &init_function; \
124  init_function.fp = (void *) &f; \
125 } \
126 static void __vnet_interface_function_deinit_##tag##_##f (void) \
127  __attribute__((__destructor__)) ; \
128  \
129 static void __vnet_interface_function_deinit_##tag##_##f (void) \
130 { \
131  vnet_main_t * vnm = vnet_get_main(); \
132  _vnet_interface_function_list_elt_t *next; \
133  if (vnm->tag##_functions[p]->fp == (void *) &f) \
134  { \
135  vnm->tag##_functions[p] = \
136  vnm->tag##_functions[p]->next_interface_function; \
137  return; \
138  } \
139  next = vnm->tag##_functions[p]; \
140  while (next->next_interface_function) \
141  { \
142  if (next->next_interface_function->fp == (void *) &f) \
143  { \
144  next->next_interface_function = \
145  next->next_interface_function->next_interface_function; \
146  return; \
147  } \
148  next = next->next_interface_function; \
149  } \
150 }
151 #else
152 /* create unused pointer to silence compiler warnings and get whole
153  function optimized out */
154 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
155 static __clib_unused void * __clib_unused_##f = f;
156 #endif
157 
158 #define _VNET_INTERFACE_FUNCTION_DECL(f,tag) \
159  _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,VNET_ITF_FUNC_PRIORITY_LOW)
160 
161 #define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f) \
162  _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
163 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f) \
164  _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
165 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(f,p) \
166  _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,hw_interface_link_up_down,p)
167 #define VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(f) \
168  _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_mtu_change)
169 #define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f) \
170  _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
171 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f) \
172  _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
173 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(f,p) \
174  _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_admin_up_down, p)
175 
176 /* A class of hardware interface devices. */
177 typedef struct _vnet_device_class
178 {
179  /* Index into main vector. */
180  u32 index;
181 
182  /* Device name (e.g. "FOOBAR 1234a"). */
183  char *name;
184 
185  /* Function to call when hardware interface is added/deleted. */
186  vnet_interface_function_t *interface_add_del_function;
187 
188  /* Function to bring device administratively up/down. */
190 
191  /* Function to call when sub-interface is added/deleted */
192  vnet_subif_add_del_function_t *subif_add_del_function;
193 
194  /* Function to call interface rx mode is changed */
195  vnet_interface_set_rx_mode_function_t *rx_mode_change_function;
196 
197  /* Function to call interface l2 mode is changed */
198  vnet_interface_set_l2_mode_function_t *set_l2_mode_function;
199 
200  /* Redistribute flag changes/existence of this interface class. */
201  u32 redistribute;
202 
203  /* Transmit function. */
204  vlib_node_function_t *tx_function;
205 
206  /* Transmit function candidate registration with priority */
207  vlib_node_fn_registration_t *tx_fn_registrations;
208 
209  /* Error strings indexed by error code for this node. */
210  char **tx_function_error_strings;
211 
212  /* Number of error codes used by this node. */
213  u32 tx_function_n_errors;
214 
215  /* Renumber device name [only!] support, a control-plane kludge */
216  int (*name_renumber) (struct vnet_hw_interface_t * hi,
217  u32 new_dev_instance);
218 
219  /* Interface flow offload operations */
220  vnet_flow_dev_ops_function_t *flow_ops_function;
221 
222  /* Format device instance as name. */
223  format_function_t *format_device_name;
224 
225  /* Parse function for device name. */
226  unformat_function_t *unformat_device_name;
227 
228  /* Format device verbosely for this class. */
229  format_function_t *format_device;
230 
231  /* Trace buffer format for TX function. */
232  format_function_t *format_tx_trace;
233 
234  /* Format flow offload entry */
236 
237  /* Function to clear hardware counters for device. */
238  void (*clear_counters) (u32 dev_class_instance);
239 
240  uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
241  u32 hw_if_index,
242  u32 hw_class_index);
243 
244  /* Called when hardware class of an interface changes. */
245  void (*hw_class_change) (struct vnet_main_t * vnm,
246  u32 hw_if_index, u32 new_hw_class_index);
247 
248  /* Called to redirect traffic from a specific interface instance */
249  void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
250  u32 hw_if_index, u32 node_index);
251 
252  /* Link-list of all device classes set up by constructors created below */
253  struct _vnet_device_class *next_class_registration;
254 
255  /* Function to set mac address. */
256  vnet_interface_set_mac_address_function_t *mac_addr_change_function;
258 
259 #ifndef CLIB_MARCH_VARIANT
260 #define VNET_DEVICE_CLASS(x,...) \
261  __VA_ARGS__ vnet_device_class_t x; \
262 static void __vnet_add_device_class_registration_##x (void) \
263  __attribute__((__constructor__)) ; \
264 static void __vnet_add_device_class_registration_##x (void) \
265 { \
266  vnet_main_t * vnm = vnet_get_main(); \
267  x.next_class_registration = vnm->device_class_registrations; \
268  vnm->device_class_registrations = &x; \
269 } \
270 static void __vnet_rm_device_class_registration_##x (void) \
271  __attribute__((__destructor__)) ; \
272 static void __vnet_rm_device_class_registration_##x (void) \
273 { \
274  vnet_main_t * vnm = vnet_get_main(); \
275  VLIB_REMOVE_FROM_LINKED_LIST (vnm->device_class_registrations, \
276  &x, next_class_registration); \
277 } \
278 __VA_ARGS__ vnet_device_class_t x
279 #else
280 /* create unused pointer to silence compiler warnings and get whole
281  function optimized out */
282 #define VNET_DEVICE_CLASS(x,...) \
283 static __clib_unused vnet_device_class_t __clib_unused_##x
284 #endif
285 
286 #define VNET_DEVICE_CLASS_TX_FN(devclass) \
287 uword CLIB_MARCH_SFX (devclass##_tx_fn)(); \
288 static vlib_node_fn_registration_t \
289  CLIB_MARCH_SFX(devclass##_tx_fn_registration) = \
290  { .function = &CLIB_MARCH_SFX (devclass##_tx_fn), }; \
291  \
292 static void __clib_constructor \
293 CLIB_MARCH_SFX (devclass##_tx_fn_multiarch_register) (void) \
294 { \
295  extern vnet_device_class_t devclass; \
296  vlib_node_fn_registration_t *r; \
297  r = &CLIB_MARCH_SFX (devclass##_tx_fn_registration); \
298  r->priority = CLIB_MARCH_FN_PRIORITY(); \
299  r->next_registration = devclass.tx_fn_registrations; \
300  devclass.tx_fn_registrations = r; \
301 } \
302 uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (devclass##_tx_fn)
303 
304 #define VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE(arch, fn, tgt) \
305  uword \
306  __attribute__ ((flatten)) \
307  __attribute__ ((target (tgt))) \
308  CLIB_CPU_OPTIMIZED \
309  fn ## _ ## arch ( vlib_main_t * vm, \
310  vlib_node_runtime_t * node, \
311  vlib_frame_t * frame) \
312  { return fn (vm, node, frame); }
313 
314 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
315  foreach_march_variant(VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE, fn)
316 
317 #if CLIB_DEBUG > 0
318 #define VLIB_MULTIARCH_CLONE_AND_SELECT_FN(fn,...)
319 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn)
320 #else
321 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn) \
322  VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn) \
323  CLIB_MULTIARCH_SELECT_FN(fn, static inline) \
324  static void __attribute__((__constructor__)) \
325  __vlib_device_tx_function_multiarch_select_##dev (void) \
326  { dev.tx_function = fn ## _multiarch_select(); }
327 #endif
328 
329 /**
330  * Link Type: A description of the protocol of packets on the link.
331  * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
332  * it maps to the GRE-proto, etc for other lnk types.
333  */
334 typedef enum vnet_link_t_
335 {
336 #if CLIB_DEBUG > 0
338 #else
339  VNET_LINK_IP4 = 0,
340 #endif
346 } __attribute__ ((packed)) vnet_link_t;
347 
348 #define VNET_LINKS { \
349  [VNET_LINK_ETHERNET] = "ethernet", \
350  [VNET_LINK_IP4] = "ipv4", \
351  [VNET_LINK_IP6] = "ipv6", \
352  [VNET_LINK_MPLS] = "mpls", \
353  [VNET_LINK_ARP] = "arp", \
354  [VNET_LINK_NSH] = "nsh", \
355 }
356 
357 #define FOR_EACH_VNET_LINK(_link) \
358  for (_link = VNET_LINK_IP4; \
359  _link <= VNET_LINK_NSH; \
360  _link++)
361 
362 /**
363  * @brief Number of link types. Not part of the enum so it does not have to be included in
364  * switch statements
365  */
366 #define VNET_LINK_NUM (VNET_LINK_NSH+1)
367 
368 /**
369  * @brief Convert a link to to an Ethertype
370  */
371 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
372 
373 /**
374  * @brief Attributes assignable to a HW interface Class.
375  */
377 {
378  /**
379  * @brief a point 2 point interface
380  */
383 
384 /* Layer-2 (e.g. Ethernet) interface class. */
385 typedef struct _vnet_hw_interface_class
386 {
387  /* Index into main vector. */
388  u32 index;
389 
390  /* Class name (e.g. "Ethernet"). */
391  char *name;
392 
393  /* Flags */
395 
396  /* Function to call when hardware interface is added/deleted. */
397  vnet_interface_function_t *interface_add_del_function;
398 
399  /* Function to bring interface administratively up/down. */
401 
402  /* Function to call when link state changes. */
404 
405  /* Function to call when link MAC changes. */
406  vnet_interface_set_mac_address_function_t *mac_addr_change_function;
407 
408  /* Format function to display interface name. */
409  format_function_t *format_interface_name;
410 
411  /* Format function to display interface address. */
412  format_function_t *format_address;
413 
414  /* Format packet header for this interface class. */
415  format_function_t *format_header;
416 
417  /* Format device verbosely for this class. */
418  format_function_t *format_device;
419 
420  /* Parser for hardware (e.g. ethernet) address. */
421  unformat_function_t *unformat_hw_address;
422 
423  /* Parser for packet header for e.g. rewrite string. */
424  unformat_function_t *unformat_header;
425 
426  /* Builds a rewrite string for the interface to the destination
427  * for the payload/link type. */
428  u8 *(*build_rewrite) (struct vnet_main_t * vnm,
430  vnet_link_t link_type, const void *dst_hw_address);
431 
432  /* Update an adjacency added by FIB (as opposed to via the
433  * neighbour resolution protocol). */
434  void (*update_adjacency) (struct vnet_main_t * vnm,
435  u32 sw_if_index, u32 adj_index);
436 
437  uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
438  u32 hw_if_index,
439  u32 hw_class_index);
440 
441  /* Called when hw interface class is changed and old hardware instance
442  may want to be deleted. */
443  void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
444  u32 old_class_index, u32 new_class_index);
445 
446  /* List of hw interface classes, built by constructors */
447  struct _vnet_hw_interface_class *next_class_registration;
448 
450 
451 /**
452  * @brief Return a complete, zero-length (aka dummy) rewrite
453  */
454 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
455  u32 sw_if_index,
456  vnet_link_t link_type,
457  const void *dst_hw_address);
458 
459 /**
460  * @brief Default adjacency update function
461  */
462 extern void default_update_adjacency (struct vnet_main_t *vnm,
463  u32 sw_if_index, u32 adj_index);
464 
465 #define VNET_HW_INTERFACE_CLASS(x,...) \
466  __VA_ARGS__ vnet_hw_interface_class_t x; \
467 static void __vnet_add_hw_interface_class_registration_##x (void) \
468  __attribute__((__constructor__)) ; \
469 static void __vnet_add_hw_interface_class_registration_##x (void) \
470 { \
471  vnet_main_t * vnm = vnet_get_main(); \
472  x.next_class_registration = vnm->hw_interface_class_registrations; \
473  vnm->hw_interface_class_registrations = &x; \
474 } \
475 static void __vnet_rm_hw_interface_class_registration_##x (void) \
476  __attribute__((__destructor__)) ; \
477 static void __vnet_rm_hw_interface_class_registration_##x (void) \
478 { \
479  vnet_main_t * vnm = vnet_get_main(); \
480  VLIB_REMOVE_FROM_LINKED_LIST (vnm->hw_interface_class_registrations,\
481  &x, next_class_registration); \
482 } \
483 __VA_ARGS__ vnet_hw_interface_class_t x
484 
485 /* Hardware-interface. This corresponds to a physical wire
486  that packets flow over. */
487 typedef struct vnet_hw_interface_t
488 {
489  /* Interface name. */
491 
493  /* Hardware link state is up. */
494 #define VNET_HW_INTERFACE_FLAG_LINK_UP (1 << 0)
495  /* Hardware duplex state */
496 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
497 #define VNET_HW_INTERFACE_FLAG_HALF_DUPLEX (1 << 1)
498 #define VNET_HW_INTERFACE_FLAG_FULL_DUPLEX (1 << 2)
499 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK \
500  (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX | \
501  VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
502 
503  /* Hardware link speed */
504 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT 3
505 #define VNET_HW_INTERFACE_FLAG_SPEED_10M (1 << 3)
506 #define VNET_HW_INTERFACE_FLAG_SPEED_100M (1 << 4)
507 #define VNET_HW_INTERFACE_FLAG_SPEED_1G (1 << 5)
508 #define VNET_HW_INTERFACE_FLAG_SPEED_2_5G (1 << 6)
509 #define VNET_HW_INTERFACE_FLAG_SPEED_5G (1 << 7)
510 #define VNET_HW_INTERFACE_FLAG_SPEED_10G (1 << 8)
511 #define VNET_HW_INTERFACE_FLAG_SPEED_20G (1 << 9)
512 #define VNET_HW_INTERFACE_FLAG_SPEED_25G (1 << 10)
513 #define VNET_HW_INTERFACE_FLAG_SPEED_40G (1 << 11)
514 #define VNET_HW_INTERFACE_FLAG_SPEED_50G (1 << 12)
515 #define VNET_HW_INTERFACE_FLAG_SPEED_56G (1 << 13)
516 #define VNET_HW_INTERFACE_FLAG_SPEED_100G (1 << 14)
517 #define VNET_HW_INTERFACE_FLAG_SPEED_MASK \
518  (VNET_HW_INTERFACE_FLAG_SPEED_10M | \
519  VNET_HW_INTERFACE_FLAG_SPEED_100M | \
520  VNET_HW_INTERFACE_FLAG_SPEED_1G | \
521  VNET_HW_INTERFACE_FLAG_SPEED_2_5G | \
522  VNET_HW_INTERFACE_FLAG_SPEED_5G | \
523  VNET_HW_INTERFACE_FLAG_SPEED_10G | \
524  VNET_HW_INTERFACE_FLAG_SPEED_20G | \
525  VNET_HW_INTERFACE_FLAG_SPEED_25G | \
526  VNET_HW_INTERFACE_FLAG_SPEED_40G | \
527  VNET_HW_INTERFACE_FLAG_SPEED_50G | \
528  VNET_HW_INTERFACE_FLAG_SPEED_56G | \
529  VNET_HW_INTERFACE_FLAG_SPEED_100G)
530 
531  /* rx mode flags */
532 #define VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE (1 << 16)
533 
534  /* tx checksum offload */
535 #define VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD (1 << 17)
536 
537  /* Hardware address as vector. Zero (e.g. zero-length vector) if no
538  address for this class (e.g. PPP). */
540 
541  /* Interface is up as far as software is concerned. */
542  /* NAME.{output,tx} nodes for this interface. */
543  u32 output_node_index, tx_node_index;
544 
545  /* (dev_class, dev_instance) uniquely identifies hw interface. */
548 
549  /* (hw_class, hw_instance) uniquely identifies hw interface. */
552 
553  /* Hardware index for this hardware interface. */
555 
556  /* Software index for this hardware interface. */
558 
559  /* Next index in interface-output node for this interface
560  used by node function vnet_per_buffer_interface_output() */
562 
563  /* Maximum transmit rate for this interface in bits/sec. */
565 
566  /* Smallest packet size supported by this interface. */
568 
569  /* Largest packet size supported by this interface. */
571 
572  /* Smallest packet size for this interface. */
574 
575  /* Largest packet size for this interface. */
577 
578  /* Hash table mapping sub interface id to sw_if_index. */
580 
581  /* Count of number of L2 subinterfaces */
583 
584  /* Bonded interface info -
585  0 - not a bonded interface nor a slave
586  ~0 - slave to a bonded interface
587  others - A bonded interface with a pointer to bitmap for all slaves */
589 #define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
590 #define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
591 
592  /* Input node */
594 
595  /* input node cpu index by queue */
597 
598  /* vnet_hw_interface_rx_mode by queue */
600  vnet_hw_interface_rx_mode default_rx_mode;
601 
602  /* device input device_and_queue runtime index */
604 
606 
608 
609 typedef enum
610 {
611  /* A hw interface. */
613 
614  /* A sub-interface. */
619 
620 typedef struct
621 {
622  /*
623  * Subinterface ID. A number 0-N to uniquely identify
624  * this subinterface under the main (parent?) interface
625  */
627 
628  /* Classification data. Used to associate packet header with subinterface. */
629  struct
630  {
633  union
634  {
636  struct
637  {
638  u16 no_tags:1;
639  u16 one_tag:1;
640  u16 two_tags:1;
641  u16 dot1ad:1; /* 0 = dot1q, 1=dot1ad */
642  u16 exact_match:1;
643  u16 default_sub:1;
644  u16 outer_vlan_id_any:1;
645  u16 inner_vlan_id_any:1;
646  } flags;
647  };
648  } eth;
650 
651 typedef struct
652 {
653  /*
654  * Subinterface ID. A number 0-N to uniquely identify
655  * this subinterface under the main interface
656  */
659  u8 client_mac[6];
661 
662 typedef enum
663 {
664  /* THe BVI interface */
666  /* Always flood */
669  /* Does not flood when tunnel master is in the same L2 BD */
671  /* Never flood to this type */
674 
675 /* Per protocol MTU */
676 typedef enum
677 {
678  VNET_MTU_L3, /* Default payload MTU (without L2 headers) */
679  VNET_MTU_IP4, /* Per-protocol MTUs overriding default */
683 } vnet_mtu_t;
684 
685 extern vnet_mtu_t vnet_link_to_mtu (vnet_link_t link);
686 
688 {
689  /* Interface is "up" meaning administratively up.
690  Up in the sense of link state being up is maintained by hardware interface. */
692 
693  /* Interface is disabled for forwarding: punt all traffic to slow-path. */
695 
697 
699 
701 
702  /* Interface does not appear in CLI/API */
704 
705  /* Interface in ERROR state */
707 
708  /* Interface has IP configured directed broadcast */
710 
711 } __attribute__ ((packed)) vnet_sw_interface_flags_t;
712 
713 /* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
714  tunnel, etc. Configuration (e.g. IP address) gets attached to
715  software interface. */
716 typedef struct
717 {
718  vnet_sw_interface_type_t type:16;
719 
720  vnet_sw_interface_flags_t flags;
721 
722  /* Index for this interface. */
724 
725  /* Software interface index of super-interface;
726  equal to sw_if_index if this interface is not a
727  sub-interface. */
729 
730  /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
732 
734 
735  /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
737 
738  /* MTU for network layer (not including L2 headers) */
740 
741  /* VNET_SW_INTERFACE_TYPE_SUB. */
743 
744  /* VNET_SW_INTERFACE_TYPE_P2P. */
746 
747  vnet_flood_class_t flood_class;
749 
750 typedef enum
751 {
752  /* Simple counters. */
763  /* Combined counters. */
774 
775 #define foreach_rx_combined_interface_counter(_x) \
776  for (_x = VNET_INTERFACE_COUNTER_RX; \
777  _x <= VNET_INTERFACE_COUNTER_RX_BROADCAST; \
778  _x++)
779 
780 #define foreach_tx_combined_interface_counter(_x) \
781  for (_x = VNET_INTERFACE_COUNTER_TX; \
782  _x <= VNET_INTERFACE_COUNTER_TX_BROADCAST; \
783  _x++)
784 
785 #define foreach_simple_interface_counter_name \
786  _(DROP, drops, if) \
787  _(PUNT, punt, if) \
788  _(IP4, ip4, if) \
789  _(IP6, ip6, if) \
790  _(RX_NO_BUF, rx-no-buf, if) \
791  _(RX_MISS, rx-miss, if) \
792  _(RX_ERROR, rx-error, if) \
793  _(TX_ERROR, tx-error, if)
794 
795 #define foreach_combined_interface_counter_name \
796  _(RX, rx, if) \
797  _(RX_UNICAST, rx-unicast, if) \
798  _(RX_MULTICAST, rx-multicast, if) \
799  _(RX_BROADCAST, rx-broadcast, if) \
800  _(TX, tx, if) \
801  _(TX_UNICAST, tx-unicast-miss, if) \
802  _(TX_MULTICAST, tx-multicast, if) \
803  _(TX_BROADCAST, tx-broadcast, if)
804 
805 typedef enum
806 {
810 
812 
813 static inline int
815 {
817 }
818 
821 
822 
823 typedef struct
824 {
828 
829 typedef struct
830 {
831  /* Hardware interfaces. */
833 
834  /* Hash table mapping HW interface name to index. */
836 
837  /* Vectors if hardware interface classes and device classes. */
840 
841  /* Hash table mapping name to hw interface/device class. */
844 
845  /* Software interfaces. */
847 
848  /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
850 
851  /* Software interface counters both simple and combined
852  packet and byte counters. */
856 
858 
859  /* pcap drop tracing */
866 
867  /* feature_arc_index */
870 
871 static inline void
873 {
874  if (im->sw_if_counter_lock)
875  while (__sync_lock_test_and_set (im->sw_if_counter_lock, 1))
876  /* zzzz */ ;
877 }
878 
879 static inline void
881 {
882  if (im->sw_if_counter_lock)
883  *im->sw_if_counter_lock = 0;
884 }
885 
886 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
887 
888 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
889 
890 #endif /* included_vnet_interface_h */
891 
892 /*
893  * fd.io coding-style-patch-verification: ON
894  *
895  * Local Variables:
896  * eval: (c-set-style "gnu")
897  * End:
898  */
u8 * default_build_rewrite(struct vnet_main_t *vnm, u32 sw_if_index, vnet_link_t link_type, const void *dst_hw_address)
Return a complete, zero-length (aka dummy) rewrite.
Definition: interface.c:1513
vmrglw vmrglh hi
uword( unformat_function_t)(unformat_input_t *input, va_list *args)
Definition: format.h:232
pcap_main_t pcap_main
Definition: interface.h:861
void collect_detailed_interface_stats_flag_set(void)
Definition: interface.c:1572
volatile u32 * sw_if_counter_lock
Definition: interface.h:853
vnet_hw_interface_nodes_t * deleted_hw_interface_nodes
Definition: interface.h:857
vnet_p2p_sub_interface_t p2p
Definition: interface.h:745
enum vnet_hw_interface_class_flags_t_ vnet_hw_interface_class_flags_t
Attributes assignable to a HW interface Class.
PCAP utility definitions.
u32 * input_node_thread_index_by_queue
Definition: interface.h:596
clib_error_t *( vnet_interface_set_rx_mode_function_t)(struct vnet_main_t *vnm, u32 if_index, u32 queue_id, vnet_hw_interface_rx_mode mode)
Definition: interface.h:77
uword * sub_interface_sw_if_index_by_id
Definition: interface.h:579
u8 *( format_function_t)(u8 *s, va_list *args)
Definition: format.h:48
struct _vnet_device_class vnet_device_class_t
uword * dq_runtime_index_by_queue
Definition: interface.h:603
vnet_mtu_t vnet_link_to_mtu(vnet_link_t link)
Definition: interface.c:1497
unsigned char u8
Definition: types.h:56
vnet_interface_stats_collection_mode_e
Definition: interface.h:805
enum vnet_sw_interface_flags_t_ vnet_sw_interface_flags_t
double f64
Definition: types.h:142
vnet_hw_interface_rx_mode
Definition: interface.h:51
vnet_flood_class_t flood_class
Definition: interface.h:747
uword * pcap_drop_filter_hash
Definition: interface.h:865
PCAP main state data structure.
Definition: pcap.h:124
vnet_l3_packet_type_t
Definition: l3_types.h:44
u32 sw_if_index
Definition: vxlan_gbp.api:39
vlib_combined_counter_main_t * combined_sw_if_counters
Definition: interface.h:855
static format_function_t format_flow
Definition: flow_cli.c:22
struct _vlib_node_fn_registration vlib_node_fn_registration_t
clib_error_t *( vnet_interface_function_t)(struct vnet_main_t *vnm, u32 if_index, u32 flags)
Definition: interface.h:63
unsigned int u32
Definition: types.h:88
int collect_detailed_interface_stats_flag
Definition: interface.c:1569
A collection of simple counters.
Definition: counter.h:57
void vnet_pcap_drop_trace_filter_add_del(u32 error_index, int is_add)
vnet_sw_interface_flags_t_
Definition: interface.h:687
u32 max_supported_packet_bytes
Definition: interface.h:570
uword * hw_interface_by_name
Definition: interface.h:835
vnet_l3_packet_type_t vnet_link_to_l3_proto(vnet_link_t link)
Convert a link to to an Ethertype.
Definition: interface.c:1475
static clib_error_t * link_up_down_function(vnet_main_t *vm, u32 hw_if_index, u32 flags)
vnet_hw_interface_t * hw_interfaces
Definition: interface.h:832
vnet_sub_interface_t sub
Definition: interface.h:742
unsigned short u16
Definition: types.h:57
vnet_mtu_t
Definition: interface.h:676
uword * sw_if_index_by_sup_and_sub
Definition: interface.h:849
vnet_sw_interface_flags_t flags
Definition: interface.h:720
vlib_simple_counter_main_t * sw_if_counters
Definition: interface.h:854
vnet_device_class_t vnet_local_interface_device_class
vnet_interface_function_priority_t_
Definition: interface.h:99
u8 name[64]
Definition: memclnt.api:151
uword * hw_interface_class_by_name
Definition: interface.h:842
uword( vlib_node_function_t)(struct vlib_main_t *vm, struct vlib_node_runtime_t *node, struct vlib_frame_t *frame)
Definition: node.h:54
u32 flags
Definition: vhost_user.h:115
vnet_flow_dev_op_t
Definition: interface.h:85
static clib_error_t * admin_up_down_function(vnet_main_t *vm, u32 hw_if_index, u32 flags)
vnet_flood_class_t
Definition: interface.h:662
vnet_link_t_
Link Type: A description of the protocol of packets on the link.
Definition: interface.h:334
static void vnet_interface_counter_unlock(vnet_interface_main_t *im)
Definition: interface.h:880
static int collect_detailed_interface_stats(void)
Definition: interface.h:814
vnet_interface_counter_type_t
Definition: interface.h:750
clib_error_t *( vnet_interface_set_l2_mode_function_t)(struct vnet_main_t *vnm, struct vnet_hw_interface_t *hi, i32 l2_if_adjust)
Definition: interface.h:82
static void vnet_interface_counter_lock(vnet_interface_main_t *im)
Definition: interface.h:872
signed int i32
Definition: types.h:77
enum vnet_interface_function_priority_t_ vnet_interface_function_priority_t
clib_error_t *( vnet_subif_add_del_function_t)(struct vnet_main_t *vnm, u32 if_index, struct vnet_sw_interface_t *template, int is_add)
Definition: interface.h:67
uword * device_class_by_name
Definition: interface.h:843
struct vnet_hw_interface_t vnet_hw_interface_t
struct _vnet_hw_interface_class vnet_hw_interface_class_t
u64 uword
Definition: types.h:112
vnet_sw_interface_t * sw_interfaces
Definition: interface.h:846
a point 2 point interface
Definition: interface.h:381
vnet_hw_interface_class_t * hw_interface_classes
Definition: interface.h:838
A collection of combined counters.
Definition: counter.h:172
clib_error_t *( vnet_interface_set_mac_address_function_t)(struct vnet_hw_interface_t *hi, const u8 *old_address, const u8 *new_address)
Definition: interface.h:72
u32 min_supported_packet_bytes
Definition: interface.h:567
vnet_hw_interface_rx_mode default_rx_mode
Definition: interface.h:600
vnet_device_class_t * device_classes
Definition: interface.h:839
void collect_detailed_interface_stats_flag_clear(void)
Definition: interface.c:1578
void default_update_adjacency(struct vnet_main_t *vnm, u32 sw_if_index, u32 adj_index)
Default adjacency update function.
Definition: interface.c:1521
int vnet_interface_name_renumber(u32 sw_if_index, u32 new_show_dev_instance)
Definition: interface.c:1311
vnet_hw_interface_class_flags_t_
Attributes assignable to a HW interface Class.
Definition: interface.h:376
int( vnet_flow_dev_ops_function_t)(struct vnet_main_t *vnm, vnet_flow_dev_op_t op, u32 hw_if_index, u32 index, uword *private_data)
Definition: interface.h:94
vnet_sw_interface_type_t
Definition: interface.h:609