FD.io VPP  v20.09-64-g4f7b92f0a
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_interface_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 
233  /* Number of error codes used by this node. */
234  u32 tx_function_n_errors;
235 
236  /* Renumber device name [only!] support, a control-plane kludge */
237  int (*name_renumber) (struct vnet_hw_interface_t * hi,
238  u32 new_dev_instance);
239 
240  /* Interface flow offload operations */
241  vnet_flow_dev_ops_function_t *flow_ops_function;
242 
243  /* Format device instance as name. */
244  format_function_t *format_device_name;
245 
246  /* Parse function for device name. */
247  unformat_function_t *unformat_device_name;
248 
249  /* Format device verbosely for this class. */
251 
252  /* Trace buffer format for TX function. */
253  format_function_t *format_tx_trace;
254 
255  /* Format flow offload entry */
257 
259 
260  /* Function to clear hardware counters for device. */
261  void (*clear_counters) (u32 dev_class_instance);
262 
263  uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
264  u32 hw_if_index,
265  u32 hw_class_index);
266 
267  /* Called when hardware class of an interface changes. */
268  void (*hw_class_change) (struct vnet_main_t * vnm,
269  u32 hw_if_index, u32 new_hw_class_index);
270 
271  /* Called to redirect traffic from a specific interface instance */
272  void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
273  u32 hw_if_index, u32 node_index);
274 
275  /* Link-list of all device classes set up by constructors created below */
276  struct _vnet_device_class *next_class_registration;
277 
278  /* Function to set mac address. */
279  vnet_interface_set_mac_address_function_t *mac_addr_change_function;
280 
281  /* Function to add/delete additional MAC addresses */
282  vnet_interface_add_del_mac_address_function_t *mac_addr_add_del_function;
283 
284  /* Interface to set rss queues of the interface */
285  vnet_interface_rss_queues_set_t *set_rss_queues_function;
286 
288 
289 #ifndef CLIB_MARCH_VARIANT
290 #define VNET_DEVICE_CLASS(x,...) \
291  __VA_ARGS__ vnet_device_class_t x; \
292 static void __vnet_add_device_class_registration_##x (void) \
293  __attribute__((__constructor__)) ; \
294 static void __vnet_add_device_class_registration_##x (void) \
295 { \
296  vnet_main_t * vnm = vnet_get_main(); \
297  x.next_class_registration = vnm->device_class_registrations; \
298  vnm->device_class_registrations = &x; \
299 } \
300 static void __vnet_rm_device_class_registration_##x (void) \
301  __attribute__((__destructor__)) ; \
302 static void __vnet_rm_device_class_registration_##x (void) \
303 { \
304  vnet_main_t * vnm = vnet_get_main(); \
305  VLIB_REMOVE_FROM_LINKED_LIST (vnm->device_class_registrations, \
306  &x, next_class_registration); \
307 } \
308 __VA_ARGS__ vnet_device_class_t x
309 #else
310 /* create unused pointer to silence compiler warnings and get whole
311  function optimized out */
312 #define VNET_DEVICE_CLASS(x,...) \
313 static __clib_unused vnet_device_class_t __clib_unused_##x
314 #endif
315 
316 #define VNET_DEVICE_CLASS_TX_FN(devclass) \
317 uword CLIB_MARCH_SFX (devclass##_tx_fn)(); \
318 static vlib_node_fn_registration_t \
319  CLIB_MARCH_SFX(devclass##_tx_fn_registration) = \
320  { .function = &CLIB_MARCH_SFX (devclass##_tx_fn), }; \
321  \
322 static void __clib_constructor \
323 CLIB_MARCH_SFX (devclass##_tx_fn_multiarch_register) (void) \
324 { \
325  extern vnet_device_class_t devclass; \
326  vlib_node_fn_registration_t *r; \
327  r = &CLIB_MARCH_SFX (devclass##_tx_fn_registration); \
328  r->priority = CLIB_MARCH_FN_PRIORITY(); \
329  r->next_registration = devclass.tx_fn_registrations; \
330  devclass.tx_fn_registrations = r; \
331 } \
332 uword CLIB_CPU_OPTIMIZED CLIB_MARCH_SFX (devclass##_tx_fn)
333 
334 /**
335  * Link Type: A description of the protocol of packets on the link.
336  * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
337  * it maps to the GRE-proto, etc for other lnk types.
338  */
339 typedef enum vnet_link_t_
340 {
341 #if CLIB_DEBUG > 0
343 #else
344  VNET_LINK_IP4 = 0,
345 #endif
351 } __attribute__ ((packed)) vnet_link_t;
352 
353 #define VNET_LINKS { \
354  [VNET_LINK_ETHERNET] = "ethernet", \
355  [VNET_LINK_IP4] = "ipv4", \
356  [VNET_LINK_IP6] = "ipv6", \
357  [VNET_LINK_MPLS] = "mpls", \
358  [VNET_LINK_ARP] = "arp", \
359  [VNET_LINK_NSH] = "nsh", \
360 }
361 
362 #define FOR_EACH_VNET_LINK(_link) \
363  for (_link = VNET_LINK_IP4; \
364  _link <= VNET_LINK_NSH; \
365  _link++)
366 
367 /**
368  * @brief Number of link types. Not part of the enum so it does not have to be included in
369  * switch statements
370  */
371 #define VNET_LINK_NUM (VNET_LINK_NSH+1)
372 
373 /**
374  * @brief Convert a link to to an Ethertype
375  */
376 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
377 
378 /**
379  * @brief Attributes assignable to a HW interface Class.
380  */
382 {
383  /**
384  * @brief a point 2 point interface
385  */
387  /**
388  * @brief a non-broadcast multiple access interface
389  */
392 
393 /* Layer-2 (e.g. Ethernet) interface class. */
394 typedef struct _vnet_hw_interface_class
395 {
396  /* Index into main vector. */
397  u32 index;
398 
399  /* Class name (e.g. "Ethernet"). */
400  char *name;
401 
402  /* Flags */
404 
405  /* Function to call when hardware interface is added/deleted. */
406  vnet_interface_function_t *interface_add_del_function;
407 
408  /* Function to bring interface administratively up/down. */
410 
411  /* Function to call when link state changes. */
413 
414  /* Function to call when link MAC changes. */
415  vnet_interface_set_mac_address_function_t *mac_addr_change_function;
416 
417  /* Function to add/delete additional MAC addresses */
418  vnet_interface_add_del_mac_address_function_t *mac_addr_add_del_function;
419 
420  /* Format function to display interface name. */
421  format_function_t *format_interface_name;
422 
423  /* Format function to display interface address. */
424  format_function_t *format_address;
425 
426  /* Format packet header for this interface class. */
427  format_function_t *format_header;
428 
429  /* Format device verbosely for this class. */
431 
432  /* Parser for hardware (e.g. ethernet) address. */
433  unformat_function_t *unformat_hw_address;
434 
435  /* Parser for packet header for e.g. rewrite string. */
436  unformat_function_t *unformat_header;
437 
438  /* Builds a rewrite string for the interface to the destination
439  * for the payload/link type. */
440  u8 *(*build_rewrite) (struct vnet_main_t * vnm,
442  vnet_link_t link_type, const void *dst_hw_address);
443 
444  /* Update an adjacency added by FIB (as opposed to via the
445  * neighbour resolution protocol). */
446  void (*update_adjacency) (struct vnet_main_t * vnm,
447  u32 sw_if_index, u32 adj_index);
448 
449  uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
450  u32 hw_if_index,
451  u32 hw_class_index);
452 
453  /* Called when hw interface class is changed and old hardware instance
454  may want to be deleted. */
455  void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
456  u32 old_class_index, u32 new_class_index);
457 
458  /* List of hw interface classes, built by constructors */
459  struct _vnet_hw_interface_class *next_class_registration;
460 
462 
463 /**
464  * @brief Return a complete, zero-length (aka placeholder) rewrite
465  */
466 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
467  u32 sw_if_index,
468  vnet_link_t link_type,
469  const void *dst_hw_address);
470 
471 /**
472  * @brief Default adjacency update function
473  */
474 extern void default_update_adjacency (struct vnet_main_t *vnm,
475  u32 sw_if_index, u32 adj_index);
476 
477 #define VNET_HW_INTERFACE_CLASS(x,...) \
478  __VA_ARGS__ vnet_hw_interface_class_t x; \
479 static void __vnet_add_hw_interface_class_registration_##x (void) \
480  __attribute__((__constructor__)) ; \
481 static void __vnet_add_hw_interface_class_registration_##x (void) \
482 { \
483  vnet_main_t * vnm = vnet_get_main(); \
484  x.next_class_registration = vnm->hw_interface_class_registrations; \
485  vnm->hw_interface_class_registrations = &x; \
486 } \
487 static void __vnet_rm_hw_interface_class_registration_##x (void) \
488  __attribute__((__destructor__)) ; \
489 static void __vnet_rm_hw_interface_class_registration_##x (void) \
490 { \
491  vnet_main_t * vnm = vnet_get_main(); \
492  VLIB_REMOVE_FROM_LINKED_LIST (vnm->hw_interface_class_registrations,\
493  &x, next_class_registration); \
494 } \
495 __VA_ARGS__ vnet_hw_interface_class_t x
496 
498 {
500  /* Hardware link state is up. */
502  /* Hardware duplex state */
505 
506  /* rx mode flags */
508 
509  /* tx checksum offload */
511 
512  /* gso */
514 
515  /* non-broadcast multiple access */
517 
518  /* hw/driver can switch between l2-promisc and l3-dmac-filter modes */
521 
522 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
523 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT 3
524 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK \
525  (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX | \
526  VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
527 
528 /* Hardware-interface. This corresponds to a physical wire
529  that packets flow over. */
530 typedef struct vnet_hw_interface_t
531 {
532  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
533  /* Interface name. */
535 
536  /* flags */
538 
539 
540  /* link speed in kbps */
542 
543  /* Hardware address as vector. Zero (e.g. zero-length vector) if no
544  address for this class (e.g. PPP). */
546 
547  /* Interface is up as far as software is concerned. */
548  /* NAME.{output,tx} nodes for this interface. */
549  u32 output_node_index, tx_node_index;
550 
551  /* (dev_class, dev_instance) uniquely identifies hw interface. */
554 
555  /* (hw_class, hw_instance) uniquely identifies hw interface. */
558 
559  /* Hardware index for this hardware interface. */
561 
562  /* Software index for this hardware interface. */
564 
565  /* Next index in interface-output node for this interface
566  used by node function vnet_per_buffer_interface_output() */
568 
569  /* Maximum transmit rate for this interface in bits/sec. */
571 
572  /* Smallest packet size supported by this interface. */
574 
575  /* Largest packet size supported by this interface. */
577 
578  /* Smallest packet size for this interface. */
580 
581  /* Largest packet size for this interface. */
583 
584  /* Hash table mapping sub interface id to sw_if_index. */
586 
587  /* Count of number of L2 and L3 subinterfaces */
590 
591  /* Bonded interface info -
592  0 - not a bonded interface nor a slave
593  ~0 - slave to a bonded interface
594  others - A bonded interface with a pointer to bitmap for all slaves */
596 #define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
597 #define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
598 
599  /* Input node */
601 
602  /* input node cpu index by queue */
604 
605  /* vnet_hw_interface_rx_mode by queue */
607  vnet_hw_interface_rx_mode default_rx_mode;
608 
609  /* device input device_and_queue runtime index */
611 
612  /* numa node that hardware device connects to */
614 
615  /* rss queues bitmap */
617 
618  /* trace */
620 
623 
625 
626 typedef enum
627 {
628  /* A hw interface. */
630 
631  /* A sub-interface. */
636 
637 typedef struct
638 {
639  /*
640  * Subinterface ID. A number 0-N to uniquely identify
641  * this subinterface under the main (parent?) interface
642  */
644 
645  /* Classification data. Used to associate packet header with subinterface. */
646  struct
647  {
650  union
651  {
653  struct
654  {
658  u16 dot1ad:1; /* 0 = dot1q, 1=dot1ad */
663  } flags;
664  };
665  } eth;
667 
668 typedef struct
669 {
670  /*
671  * Subinterface ID. A number 0-N to uniquely identify
672  * this subinterface under the main interface
673  */
676  u8 client_mac[6];
678 
679 typedef enum
680 {
681  /* THe BVI interface */
683  /* Always flood */
686  /* Does not flood when tunnel master is in the same L2 BD */
688  /* Never flood to this type */
691 
692 /* Per protocol MTU */
693 typedef enum
694 {
695  VNET_MTU_L3, /* Default payload MTU (without L2 headers) */
696  VNET_MTU_IP4, /* Per-protocol MTUs overriding default */
700 } vnet_mtu_t;
701 
702 extern vnet_mtu_t vnet_link_to_mtu (vnet_link_t link);
703 
705 {
707  /* Interface is "up" meaning administratively up.
708  Up in the sense of link state being up is maintained by hardware interface. */
710 
711  /* Interface is disabled for forwarding: punt all traffic to slow-path. */
713 
714  __VNET_SW_INTERFACE_FLAG_UNSUED = (1 << 2),
715 
717 
718  __VNET_SW_INTERFACE_FLAG_UNUSED2 = (1 << 4),
719 
720  /* Interface does not appear in CLI/API */
722 
723  /* Interface in ERROR state */
725 
726  /* Interface has IP configured directed broadcast */
728 
729 } __attribute__ ((packed)) vnet_sw_interface_flags_t;
730 
731 /* Software-interface. This corresponds to a Ethernet VLAN, ATM vc, a
732  tunnel, etc. Configuration (e.g. IP address) gets attached to
733  software interface. */
734 typedef struct
735 {
736  vnet_sw_interface_type_t type:16;
737 
739 
740  /* Index for this interface. */
742 
743  /* Software interface index of super-interface;
744  equal to sw_if_index if this interface is not a
745  sub-interface. */
747 
748  /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
750 
751  /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
753 
754  /* MTU for network layer (not including L2 headers) */
756 
757  /* VNET_SW_INTERFACE_TYPE_SUB. */
759 
760  /* VNET_SW_INTERFACE_TYPE_P2P. */
762 
763  vnet_flood_class_t flood_class;
765 
766 typedef enum
767 {
768  /* Simple counters. */
779  /* Combined counters. */
790 
791 #define foreach_rx_combined_interface_counter(_x) \
792  for (_x = VNET_INTERFACE_COUNTER_RX; \
793  _x <= VNET_INTERFACE_COUNTER_RX_BROADCAST; \
794  _x++)
795 
796 #define foreach_tx_combined_interface_counter(_x) \
797  for (_x = VNET_INTERFACE_COUNTER_TX; \
798  _x <= VNET_INTERFACE_COUNTER_TX_BROADCAST; \
799  _x++)
800 
801 #define foreach_simple_interface_counter_name \
802  _(DROP, drops, if) \
803  _(PUNT, punt, if) \
804  _(IP4, ip4, if) \
805  _(IP6, ip6, if) \
806  _(RX_NO_BUF, rx-no-buf, if) \
807  _(RX_MISS, rx-miss, if) \
808  _(RX_ERROR, rx-error, if) \
809  _(TX_ERROR, tx-error, if) \
810  _(MPLS, mpls, if)
811 
812 #define foreach_combined_interface_counter_name \
813  _(RX, rx, if) \
814  _(RX_UNICAST, rx-unicast, if) \
815  _(RX_MULTICAST, rx-multicast, if) \
816  _(RX_BROADCAST, rx-broadcast, if) \
817  _(TX, tx, if) \
818  _(TX_UNICAST, tx-unicast, if) \
819  _(TX_MULTICAST, tx-multicast, if) \
820  _(TX_BROADCAST, tx-broadcast, if)
821 
822 typedef enum
823 {
827 
829 
830 static inline int
832 {
834 }
835 
838 
839 
840 typedef struct
841 {
845 
846 typedef struct
847 {
848  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
851 
852 typedef u8 *(*vnet_buffer_opquae_formatter_t) (const vlib_buffer_t * b,
853  u8 * s);
854 
855 typedef struct
856 {
857  /* Hardware interfaces. */
859 
860  /* Hash table mapping HW interface name to index. */
862 
863  /* Vectors if hardware interface classes and device classes. */
866 
867  /* Hash table mapping name to hw interface/device class. */
870 
871  /* Software interfaces. */
873 
874  /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
876 
877  /* Software interface counters both simple and combined
878  packet and byte counters. */
882 
884 
885  /*
886  * pcap drop tracing
887  * Only the drop filter hash lives here. See ../src/vlib/main.h for
888  * the rest of the variables.
889  */
891 
892  /* Buffer metadata format helper functions */
895 
896  /* per-thread data */
898 
899  /* feature_arc_index */
902 
903 static inline void
905 {
906  if (im->sw_if_counter_lock)
908 }
909 
910 static inline void
912 {
913  if (im->sw_if_counter_lock)
915 }
916 
917 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
918 
919 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
920 
922  vlib_node_runtime_t * node,
923  vlib_frame_t * frame);
924 
927 
930 
931 typedef struct
932 {
934  int enable;
935  int status;
944  int filter;
946 
948 
949 #endif /* included_vnet_interface_h */
950 
951 /*
952  * fd.io coding-style-patch-verification: ON
953  *
954  * Local Variables:
955  * eval: (c-set-style "gnu")
956  * End:
957  */
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:1639
#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:119
static_always_inline void clib_spinlock_lock(clib_spinlock_t *p)
Definition: lock.h:80
void collect_detailed_interface_stats_flag_set(void)
Definition: interface.c:1734
vnet_interface_per_thread_data_t * per_thread_data
Definition: interface.h:897
clib_spinlock_t sw_if_counter_lock
Definition: interface.h:879
vl_api_wireguard_peer_flags_t flags
Definition: wireguard.api:103
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:883
vnet_p2p_sub_interface_t p2p
Definition: interface.h:761
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.
PCAP utility definitions.
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:603
a non-broadcast multiple access interface
Definition: interface.h:390
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
uword * sub_interface_sw_if_index_by_id
Definition: interface.h:585
struct _vnet_device_class vnet_device_class_t
uword * dq_runtime_index_by_queue
Definition: interface.h:610
vnet_mtu_t vnet_link_to_mtu(vnet_link_t link)
Definition: interface.c:1623
unsigned char u8
Definition: types.h:56
vnet_interface_stats_collection_mode_e
Definition: interface.h:822
void vnet_register_format_buffer_opaque_helper(vnet_buffer_opquae_formatter_t fn)
enum vnet_sw_interface_flags_t_ vnet_sw_interface_flags_t
double f64
Definition: types.h:142
u8 *() format_function_t(u8 *s, va_list *args)
Definition: format.h:48
vnet_hw_interface_rx_mode
Definition: interface.h:53
vnet_flood_class_t flood_class
Definition: interface.h:763
uword * pcap_drop_filter_hash
Definition: interface.h:890
vnet_l3_packet_type_t
Definition: l3_types.h:44
vlib_combined_counter_main_t * combined_sw_if_counters
Definition: interface.h:881
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:537
struct _vlib_node_fn_registration vlib_node_fn_registration_t
unsigned int u32
Definition: types.h:88
int collect_detailed_interface_stats_flag
Definition: interface.c:1731
uword vnet_interface_output_node(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
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:704
u32 max_supported_packet_bytes
Definition: interface.h:576
uword * hw_interface_by_name
Definition: interface.h:861
vnet_l3_packet_type_t vnet_link_to_l3_proto(vnet_link_t link)
Convert a link to to an Ethertype.
Definition: interface.c:1601
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:858
vnet_sub_interface_t sub
Definition: interface.h:758
vnet_buffer_opquae_formatter_t * buffer_opaque_format_helpers
Definition: interface.h:893
unsigned short u16
Definition: types.h:57
vnet_mtu_t
Definition: interface.h:693
uword * sw_if_index_by_sup_and_sub
Definition: interface.h:875
vnet_sw_interface_flags_t flags
Definition: interface.h:738
vlib_simple_counter_main_t * sw_if_counters
Definition: interface.h:880
uword() unformat_function_t(unformat_input_t *input, va_list *args)
Definition: format.h:233
vnet_device_class_t vnet_local_interface_device_class
vl_api_address_t dst
Definition: gre.api:55
vnet_interface_function_priority_t_
Definition: interface.h:110
uword * hw_interface_class_by_name
Definition: interface.h:868
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)
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:679
vnet_link_t_
Link Type: A description of the protocol of packets on the link.
Definition: interface.h:339
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:911
static int collect_detailed_interface_stats(void)
Definition: interface.h:831
int vnet_pcap_dispatch_trace_configure(vnet_pcap_dispatch_trace_args_t *)
vnet_interface_counter_type_t
Definition: interface.h:766
string name[64]
Definition: ip.api:44
u32 trace_classify_table_index
Definition: interface.h:621
static void vnet_interface_counter_lock(vnet_interface_main_t *im)
Definition: interface.h:904
signed int i32
Definition: types.h:77
enum vnet_interface_function_priority_t_ vnet_interface_function_priority_t
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:869
vnet_buffer_opquae_formatter_t * buffer_opaque2_format_helpers
Definition: interface.h:894
vl_api_ip4_address_t hi
Definition: arp.api:37
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:83
struct vnet_hw_interface_t vnet_hw_interface_t
clib_bitmap_t * rss_queues
Definition: interface.h:616
struct _vnet_hw_interface_class vnet_hw_interface_class_t
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
vnet_sw_interface_t * sw_interfaces
Definition: interface.h:872
a point 2 point interface
Definition: interface.h:386
u32 index
Definition: flow_types.api:221
vnet_hw_interface_class_t * hw_interface_classes
Definition: interface.h:864
A collection of combined counters.
Definition: counter.h:188
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:573
vnet_sw_interface_type_t type
Definition: interface.h:736
uword clib_bitmap_t
Definition: bitmap.h:50
vnet_hw_interface_flags_t_
Definition: interface.h:497
u8 *(* vnet_buffer_opquae_formatter_t)(const vlib_buffer_t *b, u8 *s)
Definition: interface.h:852
vnet_hw_interface_rx_mode default_rx_mode
Definition: interface.h:607
vnet_device_class_t * device_classes
Definition: interface.h:865
void collect_detailed_interface_stats_flag_clear(void)
Definition: interface.c:1740
void default_update_adjacency(struct vnet_main_t *vnm, u32 sw_if_index, u32 adj_index)
Default adjacency update function.
Definition: interface.c:1647
int vnet_interface_name_renumber(u32 sw_if_index, u32 new_show_dev_instance)
Definition: interface.c:1395
vnet_hw_interface_class_flags_t_
Attributes assignable to a HW interface Class.
Definition: interface.h:381
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:33
vnet_sw_interface_type_t
Definition: interface.h:626
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