FD.io VPP  v21.06
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 <vlib/vlib.h>
44 #include <vppinfra/pcap.h>
45 #include <vnet/l3_types.h>
46 #include <vppinfra/lock.h>
47 
48 struct vnet_main_t;
49 struct vnet_hw_interface_t;
50 struct vnet_sw_interface_t;
51 union ip46_address_t_;
52 
53 typedef enum
54 {
62 
63 /* Interface up/down callback. */
65  (struct vnet_main_t * vnm, u32 if_index, u32 flags);
66 
67 /* Sub-interface add/del callback. */
69  (struct vnet_main_t * vnm, u32 if_index,
70  struct vnet_sw_interface_t * template, int is_add);
71 
72 /* Interface set mac address callback. */
74  (struct vnet_hw_interface_t * hi,
75  const u8 * old_address, const u8 * new_address);
76 
77 /* Interface add/del additional mac address callback */
79  (struct vnet_hw_interface_t * hi, const u8 * address, u8 is_add);
80 
81 /* Interface set rx mode callback. */
83  (struct vnet_main_t * vnm, u32 if_index, u32 queue_id,
84  vnet_hw_if_rx_mode mode);
85 
86 /* Interface set l2 mode callback. */
88  (struct vnet_main_t * vnm, struct vnet_hw_interface_t * hi,
89  i32 l2_if_adjust);
90 
91 /* Interface to set rss queues of the interface */
93  (struct vnet_main_t * vnm, struct vnet_hw_interface_t * hi,
94  clib_bitmap_t * bitmap);
95 
96 typedef enum
97 {
103 
104 /* Interface flow operations callback. */
105 typedef int (vnet_flow_dev_ops_function_t) (struct vnet_main_t * vnm,
106  vnet_flow_dev_op_t op,
107  u32 hw_if_index, u32 index,
108  uword * private_data);
109 
111 {
115 #define VNET_ITF_FUNC_N_PRIO ((vnet_interface_function_priority_t)VNET_ITF_FUNC_PRIORITY_HIGH+1)
116 
117 typedef struct _vnet_interface_function_list_elt
118 {
119  struct _vnet_interface_function_list_elt *next_interface_function;
120  clib_error_t *(*fp) (struct vnet_main_t * vnm, u32 if_index, u32 flags);
121 } _vnet_interface_function_list_elt_t;
122 
123 #ifndef CLIB_MARCH_VARIANT
124 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
125  \
126 static void __vnet_interface_function_init_##tag##_##f (void) \
127  __attribute__((__constructor__)) ; \
128  \
129 static void __vnet_interface_function_init_##tag##_##f (void) \
130 { \
131  vnet_main_t * vnm = vnet_get_main(); \
132  static _vnet_interface_function_list_elt_t init_function; \
133  init_function.next_interface_function = vnm->tag##_functions[p]; \
134  vnm->tag##_functions[p] = &init_function; \
135  init_function.fp = (void *) &f; \
136 } \
137 static void __vnet_interface_function_deinit_##tag##_##f (void) \
138  __attribute__((__destructor__)) ; \
139  \
140 static void __vnet_interface_function_deinit_##tag##_##f (void) \
141 { \
142  vnet_main_t * vnm = vnet_get_main(); \
143  _vnet_interface_function_list_elt_t *next; \
144  if (vnm->tag##_functions[p]->fp == f) \
145  { \
146  vnm->tag##_functions[p] = \
147  vnm->tag##_functions[p]->next_interface_function; \
148  return; \
149  } \
150  next = vnm->tag##_functions[p]; \
151  while (next->next_interface_function) \
152  { \
153  if (next->next_interface_function->fp == f) \
154  { \
155  next->next_interface_function = \
156  next->next_interface_function->next_interface_function; \
157  return; \
158  } \
159  next = next->next_interface_function; \
160  } \
161 }
162 #else
163 /* create unused pointer to silence compiler warnings and get whole
164  function optimized out */
165 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p) \
166 static __clib_unused void * __clib_unused_##f = f;
167 #endif
168 
169 #define _VNET_INTERFACE_FUNCTION_DECL(f,tag) \
170  _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,VNET_ITF_FUNC_PRIORITY_LOW)
171 
172 #define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f) \
173  _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
174 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f) \
175  _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
176 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(f,p) \
177  _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,hw_interface_link_up_down,p)
178 #define VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(f) \
179  _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_mtu_change)
180 #define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f) \
181  _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
182 #define VNET_SW_INTERFACE_ADD_DEL_FUNCTION_PRIO(f,p) \
183  _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_add_del,p)
184 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f) \
185  _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
186 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(f,p) \
187  _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_admin_up_down, p)
188 
189 /**
190  * Tunnel description parameters
191  */
193  union ip46_address_t_ * src,
194  union ip46_address_t_ * dst,
195  u8 * is_l2);
196 
197 /* A class of hardware interface devices. */
198 typedef struct _vnet_device_class
199 {
200  /* Index into main vector. */
201  u32 index;
202 
203  /* Device name (e.g. "FOOBAR 1234a"). */
204  char *name;
205 
206  /* Function to call when hardware interface is added/deleted. */
207  vnet_interface_function_t *interface_add_del_function;
208 
209  /* Function to bring device administratively up/down. */
211 
212  /* Function to call when sub-interface is added/deleted */
213  vnet_subif_add_del_function_t *subif_add_del_function;
214 
215  /* Function to call interface rx mode is changed */
216  vnet_interface_set_rx_mode_function_t *rx_mode_change_function;
217 
218  /* Function to call interface l2 mode is changed */
219  vnet_interface_set_l2_mode_function_t *set_l2_mode_function;
220 
221  /* Redistribute flag changes/existence of this interface class. */
222  u32 redistribute;
223 
224  /* Transmit function. */
225  vlib_node_function_t *tx_function;
226 
227  /* Transmit function candidate registration with priority */
228  vlib_node_fn_registration_t *tx_fn_registrations;
229 
230  /* Error strings indexed by error code for this node. */
231  char **tx_function_error_strings;
232  vlib_error_desc_t *tx_function_error_counters;
233 
234  /* Number of error codes used by this node. */
235  u32 tx_function_n_errors;
236 
237  /* Renumber device name [only!] support, a control-plane kludge */
238  int (*name_renumber) (struct vnet_hw_interface_t * hi,
239  u32 new_dev_instance);
240 
241  /* Interface flow offload operations */
242  vnet_flow_dev_ops_function_t *flow_ops_function;
243 
244  /* Format device instance as name. */
245  format_function_t *format_device_name;
246 
247  /* Parse function for device name. */
248  unformat_function_t *unformat_device_name;
249 
250  /* Format device verbosely for this class. */
252 
253  /* Trace buffer format for TX function. */
254  format_function_t *format_tx_trace;
255 
256  /* Format flow offload entry */
258 
260 
261  /* Function to clear hardware counters for device. */
262  void (*clear_counters) (u32 dev_class_instance);
263 
264  uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
265  u32 hw_if_index,
266  u32 hw_class_index);
267 
268  /* Called when hardware class of an interface changes. */
269  void (*hw_class_change) (struct vnet_main_t * vnm,
270  u32 hw_if_index, u32 new_hw_class_index);
271 
272  /* Called to redirect traffic from a specific interface instance */
273  void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
274  u32 hw_if_index, u32 node_index);
275 
276  /* Link-list of all device classes set up by constructors created below */
277  struct _vnet_device_class *next_class_registration;
278 
279  /* Function to set mac address. */
280  vnet_interface_set_mac_address_function_t *mac_addr_change_function;
281 
282  /* Function to add/delete additional MAC addresses */
283  vnet_interface_add_del_mac_address_function_t *mac_addr_add_del_function;
284 
285  /* Interface to set rss queues of the interface */
286  vnet_interface_rss_queues_set_t *set_rss_queues_function;
287 
289 
290 #ifndef CLIB_MARCH_VARIANT
291 #define VNET_DEVICE_CLASS(x,...) \
292  __VA_ARGS__ vnet_device_class_t x; \
293 static void __vnet_add_device_class_registration_##x (void) \
294  __attribute__((__constructor__)) ; \
295 static void __vnet_add_device_class_registration_##x (void) \
296 { \
297  vnet_main_t * vnm = vnet_get_main(); \
298  x.next_class_registration = vnm->device_class_registrations; \
299  vnm->device_class_registrations = &x; \
300 } \
301 static void __vnet_rm_device_class_registration_##x (void) \
302  __attribute__((__destructor__)) ; \
303 static void __vnet_rm_device_class_registration_##x (void) \
304 { \
305  vnet_main_t * vnm = vnet_get_main(); \
306  VLIB_REMOVE_FROM_LINKED_LIST (vnm->device_class_registrations, \
307  &x, next_class_registration); \
308 } \
309 __VA_ARGS__ vnet_device_class_t x
310 #else
311 /* create unused pointer to silence compiler warnings and get whole
312  function optimized out */
313 #define VNET_DEVICE_CLASS(x,...) \
314 static __clib_unused vnet_device_class_t __clib_unused_##x
315 #endif
316 
317 #define VNET_DEVICE_CLASS_TX_FN(devclass) \
318  uword CLIB_MARCH_SFX (devclass##_tx_fn) (); \
319  static vlib_node_fn_registration_t CLIB_MARCH_SFX ( \
320  devclass##_tx_fn_registration) = { \
321  .function = &CLIB_MARCH_SFX (devclass##_tx_fn), \
322  }; \
323  \
324  static void __clib_constructor CLIB_MARCH_SFX ( \
325  devclass##_tx_fn_multiarch_register) (void) \
326  { \
327  extern vnet_device_class_t devclass; \
328  vlib_node_fn_registration_t *r; \
329  r = &CLIB_MARCH_SFX (devclass##_tx_fn_registration); \
330  r->march_variant = CLIB_MARCH_SFX (CLIB_MARCH_VARIANT_TYPE); \
331  r->next_registration = devclass.tx_fn_registrations; \
332  devclass.tx_fn_registrations = r; \
333  } \
334  uword CLIB_MARCH_SFX (devclass##_tx_fn)
335 
336 /**
337  * Link Type: A description of the protocol of packets on the link.
338  * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
339  * it maps to the GRE-proto, etc for other lnk types.
340  */
341 typedef enum vnet_link_t_
342 {
343 #if CLIB_DEBUG > 0
345 #else
346  VNET_LINK_IP4 = 0,
347 #endif
353 } __attribute__ ((packed)) vnet_link_t;
354 
355 #define VNET_LINKS { \
356  [VNET_LINK_ETHERNET] = "ethernet", \
357  [VNET_LINK_IP4] = "ipv4", \
358  [VNET_LINK_IP6] = "ipv6", \
359  [VNET_LINK_MPLS] = "mpls", \
360  [VNET_LINK_ARP] = "arp", \
361  [VNET_LINK_NSH] = "nsh", \
362 }
363 
364 #define FOR_EACH_VNET_LINK(_link) \
365  for (_link = VNET_LINK_IP4; \
366  _link <= VNET_LINK_NSH; \
367  _link++)
368 
369 #define FOR_EACH_VNET_IP_LINK(_link) \
370  for (_link = VNET_LINK_IP4; \
371  _link <= VNET_LINK_IP6; \
372  _link++)
373 
374 /**
375  * @brief Number of link types. Not part of the enum so it does not have to be
376  * included in switch statements
377  */
378 #define VNET_LINK_NUM (VNET_LINK_NSH+1)
379 #define VNET_N_LINKS VNET_LINK_NUM
380 
381 /**
382  * @brief Convert a link to to an Ethertype
383  */
384 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
385 
386 /**
387  * @brief Attributes assignable to a HW interface Class.
388  */
390 {
391  /**
392  * @brief a point 2 point interface
393  */
395  /**
396  * @brief a non-broadcast multiple access interface
397  */
400 
401 /* Layer-2 (e.g. Ethernet) interface class. */
402 typedef struct _vnet_hw_interface_class
403 {
404  /* Index into main vector. */
405  u32 index;
406 
407  /* Class name (e.g. "Ethernet"). */
408  char *name;
409 
410  /* Flags */
412 
413  /* Function to call when hardware interface is added/deleted. */
414  vnet_interface_function_t *interface_add_del_function;
415 
416  /* Function to bring interface administratively up/down. */
418 
419  /* Function to call when link state changes. */
421 
422  /* Function to call when link MAC changes. */
423  vnet_interface_set_mac_address_function_t *mac_addr_change_function;
424 
425  /* Function to add/delete additional MAC addresses */
426  vnet_interface_add_del_mac_address_function_t *mac_addr_add_del_function;
427 
428  /* Format function to display interface name. */
429  format_function_t *format_interface_name;
430 
431  /* Format function to display interface address. */
432  format_function_t *format_address;
433 
434  /* Format packet header for this interface class. */
435  format_function_t *format_header;
436 
437  /* Format device verbosely for this class. */
439 
440  /* Parser for hardware (e.g. ethernet) address. */
441  unformat_function_t *unformat_hw_address;
442 
443  /* Parser for packet header for e.g. rewrite string. */
444  unformat_function_t *unformat_header;
445 
446  /* Builds a rewrite string for the interface to the destination
447  * for the payload/link type. */
448  u8 *(*build_rewrite) (struct vnet_main_t * vnm,
450  vnet_link_t link_type, const void *dst_hw_address);
451 
452  /* Update an adjacency added by FIB (as opposed to via the
453  * neighbour resolution protocol). */
454  void (*update_adjacency) (struct vnet_main_t * vnm,
455  u32 sw_if_index, u32 adj_index);
456 
457  uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
458  u32 hw_if_index,
459  u32 hw_class_index);
460 
461  /* Called when hw interface class is changed and old hardware instance
462  may want to be deleted. */
463  void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
464  u32 old_class_index, u32 new_class_index);
465 
466  /* List of hw interface classes, built by constructors */
467  struct _vnet_hw_interface_class *next_class_registration;
468 
470 
471 /**
472  * @brief Return a complete, zero-length (aka placeholder) rewrite
473  */
474 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
475  u32 sw_if_index,
476  vnet_link_t link_type,
477  const void *dst_hw_address);
478 
479 /**
480  * @brief Default adjacency update function
481  */
482 extern void default_update_adjacency (struct vnet_main_t *vnm,
483  u32 sw_if_index, u32 adj_index);
484 
485 #define VNET_HW_INTERFACE_CLASS(x,...) \
486  __VA_ARGS__ vnet_hw_interface_class_t x; \
487 static void __vnet_add_hw_interface_class_registration_##x (void) \
488  __attribute__((__constructor__)) ; \
489 static void __vnet_add_hw_interface_class_registration_##x (void) \
490 { \
491  vnet_main_t * vnm = vnet_get_main(); \
492  x.next_class_registration = vnm->hw_interface_class_registrations; \
493  vnm->hw_interface_class_registrations = &x; \
494 } \
495 static void __vnet_rm_hw_interface_class_registration_##x (void) \
496  __attribute__((__destructor__)) ; \
497 static void __vnet_rm_hw_interface_class_registration_##x (void) \
498 { \
499  vnet_main_t * vnm = vnet_get_main(); \
500  VLIB_REMOVE_FROM_LINKED_LIST (vnm->hw_interface_class_registrations,\
501  &x, next_class_registration); \
502 } \
503 __VA_ARGS__ vnet_hw_interface_class_t x
504 
506 {
508  /* Hardware link state is up. */
510  /* Hardware duplex state */
513 
514  /* non-broadcast multiple access */
517 
519 {
521 
522  /* tx checksum offload */
528 
529  /* rx checksum offload */
535 
536  /* gso */
545 
546  /* lro */
548 
549  /* rx mode */
551  /* hw/driver can switch between l2-promisc and l3-dmac-filter modes */
554 
555 #define VNET_HW_INTERFACE_CAP_SUPPORTS_L4_TX_CKSUM \
556  (VNET_HW_INTERFACE_CAP_SUPPORTS_TX_TCP_CKSUM | \
557  VNET_HW_INTERFACE_CAP_SUPPORTS_TX_UDP_CKSUM)
558 
559 #define VNET_HW_INTERFACE_CAP_SUPPORTS_TX_CKSUM \
560  (VNET_HW_INTERFACE_CAP_SUPPORTS_TX_IP4_CKSUM | \
561  VNET_HW_INTERFACE_CAP_SUPPORTS_TX_TCP_CKSUM | \
562  VNET_HW_INTERFACE_CAP_SUPPORTS_TX_UDP_CKSUM)
563 
564 #define VNET_HW_INTERFACE_CAP_SUPPORTS_L4_RX_CKSUM \
565  (VNET_HW_INTERFACE_CAP_SUPPORTS_RX_TCP_CKSUM | \
566  VNET_HW_INTERFACE_CAP_SUPPORTS_RX_UDP_CKSUM)
567 
568 #define VNET_HW_INTERFACE_CAP_SUPPORTS_RX_CKSUM \
569  (VNET_HW_INTERFACE_CAP_SUPPORTS_RX_IP4_CKSUM | \
570  VNET_HW_INTERFACE_CAP_SUPPORTS_RX_TCP_CKSUM | \
571  VNET_HW_INTERFACE_CAP_SUPPORTS_RX_UDP_CKSUM)
572 
573 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
574 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT 3
575 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK \
576  (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX | \
577  VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
578 
579 typedef struct
580 {
581  /* hw interface index */
583 
584  /* device instance */
586 
587  /* index of thread pollling this queue */
589 
590  /* file index of queue interrupt line */
592 
593  /* hardware queue identifier */
595 
596  /* mode */
597  vnet_hw_if_rx_mode mode : 8;
598 #define VNET_HW_IF_RXQ_THREAD_ANY ~0
599 #define VNET_HW_IF_RXQ_NO_RX_INTERRUPT ~0
601 
602 typedef struct
603 {
605  /* hw interface index */
607 
608  /* hardware queue identifier */
610 
611  /* bitmap of threads which use this queue */
614 
615 typedef enum
616 {
621 
622 typedef struct
623 {
628 
629 typedef struct
630 {
631  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
635 
636 /* Hardware-interface. This corresponds to a physical wire
637  that packets flow over. */
638 typedef struct vnet_hw_interface_t
639 {
640  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
641  /* flags */
643 
644  /* capabilities flags */
646 
647  /* Hardware address as vector. Zero (e.g. zero-length vector) if no
648  address for this class (e.g. PPP). */
650 
651  /* Interface is up as far as software is concerned. */
652  /* NAME.{output,tx} nodes for this interface. */
653  u32 output_node_index, tx_node_index;
654 
655  /* interface-output-arc-end node next index for tx node */
657 
658  /* (dev_class, dev_instance) uniquely identifies hw interface. */
661 
662  /* (hw_class, hw_instance) uniquely identifies hw interface. */
665 
666  /* Hardware index for this hardware interface. */
668 
669  /* Software index for this hardware interface. */
671 
672  /* per thread output-node runtimes */
674 
675  CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
676 
677  /* Interface name. */
679 
680  /* link speed in kbps */
682 
683  /* Next index in interface-output node for this interface
684  used by node function vnet_per_buffer_interface_output() */
686 
687  /* Maximum transmit rate for this interface in bits/sec. */
689 
690  /* Smallest packet size supported by this interface. */
692 
693  /* Largest packet size supported by this interface. */
695 
696  /* Smallest packet size for this interface. */
698 
699  /* Largest packet size for this interface. */
701 
702  /* Hash table mapping sub interface id to sw_if_index. */
704 
705  /* Count of number of L2 and L3 subinterfaces */
708 
709  /* Bonded interface info -
710  0 - not a bonded interface nor a slave
711  ~0 - slave to a bonded interface
712  others - A bonded interface with a pointer to bitmap for all slaves */
714 #define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
715 #define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
716 
717  /* Input node */
719 
720  /* input node cpu index by queue */
722 
723  vnet_hw_if_rx_mode default_rx_mode;
724 
725  /* rx queues */
727 
728  /* tx queues */
730 
731  /* numa node that hardware device connects to */
733 
734  /* rss queues bitmap */
736 
737  /* trace */
739 
742 
745 
746 typedef struct
747 {
751 
752 typedef struct
753 {
757 
759 
760 typedef enum
761 {
762  /* A hw interface. */
764 
765  /* A sub-interface. */
770 
771 typedef struct
772 {
773  /*
774  * Subinterface ID. A number 0-N to uniquely identify
775  * this subinterface under the main (parent?) interface
776  */
778 
779  /* Classification data. Used to associate packet header with subinterface. */
780  struct
781  {
784  union
785  {
787  struct
788  {
792  u16 dot1ad:1; /* 0 = dot1q, 1=dot1ad */
797  } flags;
798  };
799  } eth;
801 
802 typedef struct
803 {
804  /*
805  * Subinterface ID. A number 0-N to uniquely identify
806  * this subinterface under the main interface
807  */
810  u8 client_mac[6];
812 
813 typedef enum
814 {
815  /* THe BVI interface */
817  /* Always flood */
820  /* Does not flood when tunnel master is in the same L2 BD */
822  /* Never flood to this type */
825 
826 /* Per protocol MTU */
827 typedef enum
828 {
829  VNET_MTU_L3, /* Default payload MTU (without L2 headers) */
830  VNET_MTU_IP4, /* Per-protocol MTUs overriding default */
834 } vnet_mtu_t;
835 
836 extern vnet_mtu_t vnet_link_to_mtu (vnet_link_t link);
837 
839 {
841  /* Interface is "up" meaning administratively up.
842  Up in the sense of link state being up is maintained by hardware interface. */
844 
845  /* Interface is disabled for forwarding: punt all traffic to slow-path. */
847 
848  __VNET_SW_INTERFACE_FLAG_UNSUED = (1 << 2),
849 
851 
852  __VNET_SW_INTERFACE_FLAG_UNUSED2 = (1 << 4),
853 
854  /* Interface does not appear in CLI/API */
856 
857  /* Interface in ERROR state */
859 
860  /* Interface has IP configured directed broadcast */
862 
863 } __attribute__ ((packed)) vnet_sw_interface_flags_t;
864 
865 /* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
866  tunnel, etc. Configuration (e.g. IP address) gets attached to
867  software interface. */
868 typedef struct
869 {
870  vnet_sw_interface_type_t type:16;
871 
873 
874  /* Index for this interface. */
876 
877  /* Software interface index of super-interface;
878  equal to sw_if_index if this interface is not a
879  sub-interface. */
881 
882  /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
884 
885  /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
887 
888  /* MTU for network layer (not including L2 headers) */
890 
891  /* VNET_SW_INTERFACE_TYPE_SUB. */
893 
894  /* VNET_SW_INTERFACE_TYPE_P2P. */
896 
897  vnet_flood_class_t flood_class;
899 
900 typedef enum
901 {
902  /* Simple counters. */
913  /* Combined counters. */
924 
925 #define foreach_rx_combined_interface_counter(_x) \
926  for (_x = VNET_INTERFACE_COUNTER_RX; \
927  _x <= VNET_INTERFACE_COUNTER_RX_BROADCAST; \
928  _x++)
929 
930 #define foreach_tx_combined_interface_counter(_x) \
931  for (_x = VNET_INTERFACE_COUNTER_TX; \
932  _x <= VNET_INTERFACE_COUNTER_TX_BROADCAST; \
933  _x++)
934 
935 #define foreach_simple_interface_counter_name \
936  _(DROP, drops, if) \
937  _(PUNT, punt, if) \
938  _(IP4, ip4, if) \
939  _(IP6, ip6, if) \
940  _(RX_NO_BUF, rx-no-buf, if) \
941  _(RX_MISS, rx-miss, if) \
942  _(RX_ERROR, rx-error, if) \
943  _(TX_ERROR, tx-error, if) \
944  _(MPLS, mpls, if)
945 
946 #define foreach_combined_interface_counter_name \
947  _(RX, rx, if) \
948  _(RX_UNICAST, rx-unicast, if) \
949  _(RX_MULTICAST, rx-multicast, if) \
950  _(RX_BROADCAST, rx-broadcast, if) \
951  _(TX, tx, if) \
952  _(TX_UNICAST, tx-unicast, if) \
953  _(TX_MULTICAST, tx-multicast, if) \
954  _(TX_BROADCAST, tx-broadcast, if)
955 
956 typedef enum
957 {
961 
963 
964 static inline int
966 {
968 }
969 
972 
973 
974 typedef struct
975 {
979 
980 typedef struct
981 {
982  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
985 
986 typedef u8 *(*vnet_buffer_opquae_formatter_t) (const vlib_buffer_t * b,
987  u8 * s);
988 
989 typedef struct
990 {
991  /* Hardware interfaces. */
993 
994  /* Hardware interface RX queues */
997 
998  /* Hardware interface TX queues */
1001 
1002  /* Hash table mapping HW interface name to index. */
1004 
1005  /* Vectors if hardware interface classes and device classes. */
1008 
1009  /* Hash table mapping name to hw interface/device class. */
1012 
1013  /* Software interfaces. */
1015 
1016  /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
1018 
1019  /* Software interface counters both simple and combined
1020  packet and byte counters. */
1024 
1026 
1027  /*
1028  * pcap drop tracing
1029  * Only the drop filter hash lives here. See ../src/vlib/main.h for
1030  * the rest of the variables.
1031  */
1033 
1034  /* Buffer metadata format helper functions */
1037 
1038  /* per-thread data */
1040 
1041  /* feature_arc_index */
1043 
1044  /* fast lookup tables */
1048 
1049 static inline void
1051 {
1052  if (im->sw_if_counter_lock)
1054 }
1055 
1056 static inline void
1058 {
1059  if (im->sw_if_counter_lock)
1061 }
1062 
1063 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
1064 
1065 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
1066 
1069 
1072 
1073 typedef struct
1074 {
1076  int enable;
1077  int status;
1086  int filter;
1089 
1091 
1094 
1095 #endif /* included_vnet_interface_h */
1096 
1097 /*
1098  * fd.io coding-style-patch-verification: ON
1099  *
1100  * Local Variables:
1101  * eval: (c-set-style "gnu")
1102  * End:
1103  */
vnet_hw_if_output_node_runtime_t * output_node_thread_runtimes
Definition: interface.h:673
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 placeholder) rewrite.
Definition: interface.c:1705
vnet_hw_if_tx_frame_t frame
Definition: interface.h:632
clib_bitmap_t * threads
Definition: interface.h:612
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
static_always_inline void clib_spinlock_unlock(clib_spinlock_t *p)
Definition: lock.h:121
static_always_inline void clib_spinlock_lock(clib_spinlock_t *p)
Definition: lock.h:82
void collect_detailed_interface_stats_flag_set(void)
Definition: interface.c:1802
vnet_interface_per_thread_data_t * per_thread_data
Definition: interface.h:1039
clib_spinlock_t sw_if_counter_lock
Definition: interface.h:1021
vl_api_wireguard_peer_flags_t flags
Definition: wireguard.api:105
clib_error_t *() vnet_interface_add_del_mac_address_function_t(struct vnet_hw_interface_t *hi, const u8 *address, u8 is_add)
Definition: interface.h:79
vnet_hw_interface_nodes_t * deleted_hw_interface_nodes
Definition: interface.h:1025
vlib_node_registration_t vnet_interface_output_arc_end_node
(constructor) VLIB_REGISTER_NODE (vnet_interface_output_arc_end_node)
vnet_p2p_sub_interface_t p2p
Definition: interface.h:895
static void clear_counters(perfmon_main_t *pm)
enum vnet_hw_interface_class_flags_t_ vnet_hw_interface_class_flags_t
Attributes assignable to a HW interface Class.
STATIC_ASSERT_OFFSET_OF(vnet_hw_interface_t, cacheline1, CLIB_CACHE_LINE_BYTES)
PCAP utility definitions.
enum vnet_hw_interface_capabilities_t_ vnet_hw_interface_capabilities_t
vnet_hw_interface_capabilities_t caps
Definition: interface.h:645
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:69
u32 * input_node_thread_index_by_queue
Definition: interface.h:721
a non-broadcast multiple access interface
Definition: interface.h:398
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:88
vl_api_address_t src
Definition: gre.api:54
u16 vlib_error_t
Definition: error.h:45
uword * sub_interface_sw_if_index_by_id
Definition: interface.h:703
string name[64]
Definition: fib.api:25
struct _vnet_device_class vnet_device_class_t
vnet_hw_if_tx_queue_t * hw_if_tx_queues
Definition: interface.h:999
vnet_mtu_t vnet_link_to_mtu(vnet_link_t link)
Definition: interface.c:1689
unsigned char u8
Definition: types.h:56
vlib_buffer_t ** b
vnet_interface_stats_collection_mode_e
Definition: interface.h:956
void vnet_register_format_buffer_opaque_helper(vnet_buffer_opquae_formatter_t fn)
enum vnet_sw_interface_flags_t_ vnet_sw_interface_flags_t
u16 * if_out_arc_end_next_index_by_sw_if_index
Definition: interface.h:1046
double f64
Definition: types.h:142
unsigned int u32
Definition: types.h:88
uword * txq_index_by_hw_if_index_and_queue_id
Definition: interface.h:1000
u8 *() format_function_t(u8 *s, va_list *args)
Definition: format.h:48
vnet_flood_class_t flood_class
Definition: interface.h:897
uword * pcap_drop_filter_hash
Definition: interface.h:1032
vnet_l3_packet_type_t
Definition: l3_types.h:44
vlib_combined_counter_main_t * combined_sw_if_counters
Definition: interface.h:1023
enum vnet_hw_interface_flags_t_ vnet_hw_interface_flags_t
static format_function_t format_flow
Definition: flow_cli.c:24
vnet_hw_interface_flags_t flags
Definition: interface.h:642
vnet_hw_if_rx_mode default_rx_mode
Definition: interface.h:723
struct _vlib_node_fn_registration vlib_node_fn_registration_t
int collect_detailed_interface_stats_flag
Definition: interface.c:1799
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:838
u32 max_supported_packet_bytes
Definition: interface.h:694
uword * hw_interface_by_name
Definition: interface.h:1003
vnet_l3_packet_type_t vnet_link_to_l3_proto(vnet_link_t link)
Convert a link to to an Ethertype.
Definition: interface.c:1667
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:992
vnet_hw_interface_capabilities_t_
Definition: interface.h:518
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:34
vnet_sub_interface_t sub
Definition: interface.h:892
vnet_buffer_opquae_formatter_t * buffer_opaque_format_helpers
Definition: interface.h:1035
unsigned short u16
Definition: types.h:57
vnet_mtu_t
Definition: interface.h:827
uword * sw_if_index_by_sup_and_sub
Definition: interface.h:1017
vnet_hw_if_rxq_poll_vector_t * rxq_poll_vector
Definition: interface.h:754
vnet_hw_if_rx_mode mode
Definition: interface.h:597
vnet_sw_interface_flags_t flags
Definition: interface.h:872
vlib_simple_counter_main_t * sw_if_counters
Definition: interface.h:1022
vnet_hw_if_tx_frame_hint_t
Definition: interface.h:615
uword() unformat_function_t(unformat_input_t *input, va_list *args)
Definition: format.h:225
vnet_device_class_t vnet_local_interface_device_class
uword * rxq_index_by_hw_if_index_and_queue_id
Definition: interface.h:996
vnet_interface_function_priority_t_
Definition: interface.h:110
uword * hw_interface_class_by_name
Definition: interface.h:1010
vnet_hw_if_rx_queue_t * hw_if_rx_queues
Definition: interface.h:995
int(* vnet_dev_class_ip_tunnel_desc_t)(u32 sw_if_index, union ip46_address_t_ *src, union ip46_address_t_ *dst, u8 *is_l2)
Tunnel description parameters.
Definition: interface.h:192
vnet_flow_dev_op_t
Definition: interface.h:96
void vnet_register_format_buffer_opaque2_helper(vnet_buffer_opquae_formatter_t fn)
u32 index
Definition: flow_types.api:221
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:813
vnet_interface_main_t * im
vnet_link_t_
Link Type: A description of the protocol of packets on the link.
Definition: interface.h:341
static u8 * format_device(u8 *s, va_list *args)
Definition: mactime_top.c:327
static void vnet_interface_counter_unlock(vnet_interface_main_t *im)
Definition: interface.h:1057
static int collect_detailed_interface_stats(void)
Definition: interface.h:965
int vnet_pcap_dispatch_trace_configure(vnet_pcap_dispatch_trace_args_t *)
vnet_interface_counter_type_t
Definition: interface.h:900
u32 trace_classify_table_index
Definition: interface.h:740
static void vnet_interface_counter_lock(vnet_interface_main_t *im)
Definition: interface.h:1050
signed int i32
Definition: types.h:77
enum vnet_interface_function_priority_t_ vnet_interface_function_priority_t
vlib_node_registration_t vnet_interface_output_node
(constructor) VLIB_REGISTER_NODE (vnet_interface_output_node)
clib_error_t *() vnet_interface_function_t(struct vnet_main_t *vnm, u32 if_index, u32 flags)
Definition: interface.h:65
enum vnet_link_t_ vnet_link_t
Link Type: A description of the protocol of packets on the link.
clib_error_t *() vnet_interface_rss_queues_set_t(struct vnet_main_t *vnm, struct vnet_hw_interface_t *hi, clib_bitmap_t *bitmap)
Definition: interface.h:93
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
uword * device_class_by_name
Definition: interface.h:1011
vnet_buffer_opquae_formatter_t * buffer_opaque2_format_helpers
Definition: interface.h:1036
vl_api_ip4_address_t hi
Definition: arp.api:37
struct _vlib_node_registration vlib_node_registration_t
struct vnet_hw_interface_t vnet_hw_interface_t
clib_bitmap_t * rss_queues
Definition: interface.h:735
struct _vnet_hw_interface_class vnet_hw_interface_class_t
VLIB buffer representation.
Definition: buffer.h:111
u64 uword
Definition: types.h:112
vnet_sw_interface_t * sw_interfaces
Definition: interface.h:1014
a point 2 point interface
Definition: interface.h:394
node node_index
vnet_hw_interface_class_t * hw_interface_classes
Definition: interface.h:1006
A collection of combined counters.
Definition: counter.h:203
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:74
u32 min_supported_packet_bytes
Definition: interface.h:691
u32 * hw_if_index_by_sw_if_index
Definition: interface.h:1045
vnet_sw_interface_type_t type
Definition: interface.h:870
vl_api_ip4_address_t dst
Definition: pnat.api:41
uword clib_bitmap_t
Definition: bitmap.h:50
vnet_hw_if_rx_mode
Definition: interface.h:53
vnet_hw_interface_flags_t_
Definition: interface.h:505
u8 *(* vnet_buffer_opquae_formatter_t)(const vlib_buffer_t *b, u8 *s)
Definition: interface.h:986
u32 if_out_arc_end_node_next_index
Definition: interface.h:656
vnet_device_class_t * device_classes
Definition: interface.h:1007
void collect_detailed_interface_stats_flag_clear(void)
Definition: interface.c:1808
clib_error_t *() vnet_interface_set_rx_mode_function_t(struct vnet_main_t *vnm, u32 if_index, u32 queue_id, vnet_hw_if_rx_mode mode)
Definition: interface.h:83
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
void default_update_adjacency(struct vnet_main_t *vnm, u32 sw_if_index, u32 adj_index)
Default adjacency update function.
Definition: interface.c:1713
int vnet_interface_name_renumber(u32 sw_if_index, u32 new_show_dev_instance)
Definition: interface.c:1452
vnet_hw_if_tx_frame_hint_t hints
Definition: interface.h:625
vnet_hw_interface_class_flags_t_
Attributes assignable to a HW interface Class.
Definition: interface.h:389
vnet_sw_interface_type_t
Definition: interface.h:760
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:105