misc: fix issues reported by clang-15
[vpp.git] / src / vnet / interface.h
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 #include <vnet/hash/hash.h>
48
49 struct vnet_main_t;
50 struct vnet_hw_interface_t;
51 struct vnet_sw_interface_t;
52 union ip46_address_t_;
53
54 typedef enum
55 {
56   VNET_HW_IF_RX_MODE_UNKNOWN,
57   VNET_HW_IF_RX_MODE_POLLING,
58   VNET_HW_IF_RX_MODE_INTERRUPT,
59   VNET_HW_IF_RX_MODE_ADAPTIVE,
60   VNET_HW_IF_RX_MODE_DEFAULT,
61   VNET_HW_IF_NUM_RX_MODES,
62 } vnet_hw_if_rx_mode;
63
64 /* Interface up/down callback. */
65 typedef clib_error_t *(vnet_interface_function_t)
66   (struct vnet_main_t * vnm, u32 if_index, u32 flags);
67
68 /* Sub-interface add/del callback. */
69 typedef clib_error_t *(vnet_subif_add_del_function_t)
70   (struct vnet_main_t * vnm, u32 if_index,
71    struct vnet_sw_interface_t * template, int is_add);
72
73 /* Interface set mtu callback. */
74 typedef clib_error_t *(vnet_interface_set_max_frame_size_function_t) (
75   struct vnet_main_t *vnm, struct vnet_hw_interface_t *hi, u32 mtu);
76
77 /* Interface set mac address callback. */
78 typedef clib_error_t *(vnet_interface_set_mac_address_function_t)
79   (struct vnet_hw_interface_t * hi,
80    const u8 * old_address, const u8 * new_address);
81
82 /* Interface add/del additional mac address callback */
83 typedef clib_error_t *(vnet_interface_add_del_mac_address_function_t)
84   (struct vnet_hw_interface_t * hi, const u8 * address, u8 is_add);
85
86 /* Interface set rx mode callback. */
87 typedef clib_error_t *(vnet_interface_set_rx_mode_function_t)
88   (struct vnet_main_t * vnm, u32 if_index, u32 queue_id,
89    vnet_hw_if_rx_mode mode);
90
91 /* Interface set l2 mode callback. */
92 typedef clib_error_t *(vnet_interface_set_l2_mode_function_t)
93   (struct vnet_main_t * vnm, struct vnet_hw_interface_t * hi,
94    i32 l2_if_adjust);
95
96 /* Interface to set rss queues of the interface */
97 typedef clib_error_t *(vnet_interface_rss_queues_set_t)
98   (struct vnet_main_t * vnm, struct vnet_hw_interface_t * hi,
99    clib_bitmap_t * bitmap);
100
101 typedef enum
102 {
103   VNET_FLOW_DEV_OP_ADD_FLOW,
104   VNET_FLOW_DEV_OP_DEL_FLOW,
105   VNET_FLOW_DEV_OP_GET_COUNTER,
106   VNET_FLOW_DEV_OP_RESET_COUNTER,
107 } vnet_flow_dev_op_t;
108
109 /* Interface flow operations callback. */
110 typedef int (vnet_flow_dev_ops_function_t) (struct vnet_main_t * vnm,
111                                             vnet_flow_dev_op_t op,
112                                             u32 hw_if_index, u32 index,
113                                             uword * private_data);
114
115 typedef enum vnet_interface_function_priority_t_
116 {
117   VNET_ITF_FUNC_PRIORITY_LOW,
118   VNET_ITF_FUNC_PRIORITY_HIGH,
119 } vnet_interface_function_priority_t;
120 #define VNET_ITF_FUNC_N_PRIO ((vnet_interface_function_priority_t)VNET_ITF_FUNC_PRIORITY_HIGH+1)
121
122 typedef struct _vnet_interface_function_list_elt
123 {
124   struct _vnet_interface_function_list_elt *next_interface_function;
125   clib_error_t *(*fp) (struct vnet_main_t * vnm, u32 if_index, u32 flags);
126 } _vnet_interface_function_list_elt_t;
127
128 #ifndef CLIB_MARCH_VARIANT
129 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p)                    \
130                                                                         \
131 static void __vnet_interface_function_init_##tag##_##f (void)           \
132     __attribute__((__constructor__)) ;                                  \
133                                                                         \
134 static void __vnet_interface_function_init_##tag##_##f (void)           \
135 {                                                                       \
136  vnet_main_t * vnm = vnet_get_main();                                   \
137  static _vnet_interface_function_list_elt_t init_function;              \
138  init_function.next_interface_function = vnm->tag##_functions[p];       \
139  vnm->tag##_functions[p] = &init_function;                              \
140  init_function.fp = (void *) &f;                                        \
141 }                                                                       \
142 static void __vnet_interface_function_deinit_##tag##_##f (void)         \
143     __attribute__((__destructor__)) ;                                   \
144                                                                         \
145 static void __vnet_interface_function_deinit_##tag##_##f (void)         \
146 {                                                                       \
147  vnet_main_t * vnm = vnet_get_main();                                   \
148  _vnet_interface_function_list_elt_t *next;                             \
149  if (vnm->tag##_functions[p]->fp == f)                                  \
150     {                                                                   \
151       vnm->tag##_functions[p] =                                         \
152         vnm->tag##_functions[p]->next_interface_function;               \
153       return;                                                           \
154     }                                                                   \
155   next = vnm->tag##_functions[p];                                       \
156   while (next->next_interface_function)                                 \
157     {                                                                   \
158       if (next->next_interface_function->fp == f)                       \
159         {                                                               \
160           next->next_interface_function =                               \
161             next->next_interface_function->next_interface_function;     \
162           return;                                                       \
163         }                                                               \
164       next = next->next_interface_function;                             \
165     }                                                                   \
166 }
167 #else
168 /* create unused pointer to silence compiler warnings and get whole
169    function optimized out */
170 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p)                    \
171 static __clib_unused void * __clib_unused_##f = f;
172 #endif
173
174 #define _VNET_INTERFACE_FUNCTION_DECL(f,tag)                            \
175   _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,VNET_ITF_FUNC_PRIORITY_LOW)
176
177 #define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f)                   \
178   _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
179 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f)              \
180   _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
181 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(f,p)       \
182   _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,hw_interface_link_up_down,p)
183 #define VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(f)                \
184   _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_mtu_change)
185 #define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f)                   \
186   _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
187 #define VNET_SW_INTERFACE_ADD_DEL_FUNCTION_PRIO(f,p)            \
188   _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_add_del,p)
189 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f)             \
190   _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
191 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(f,p)      \
192   _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_admin_up_down, p)
193
194 /**
195  * Tunnel description parameters
196  */
197 typedef int (*vnet_dev_class_ip_tunnel_desc_t) (u32 sw_if_index,
198                                                 union ip46_address_t_ * src,
199                                                 union ip46_address_t_ * dst,
200                                                 u8 * is_l2);
201
202 /* A class of hardware interface devices. */
203 typedef struct _vnet_device_class
204 {
205   /* Index into main vector. */
206   u32 index;
207
208   /* Device name (e.g. "FOOBAR 1234a"). */
209   char *name;
210
211   /* Function to call when hardware interface is added/deleted. */
212   vnet_interface_function_t *interface_add_del_function;
213
214   /* Function to bring device administratively up/down. */
215   vnet_interface_function_t *admin_up_down_function;
216
217   /* Function to call when sub-interface is added/deleted */
218   vnet_subif_add_del_function_t *subif_add_del_function;
219
220   /* Function to call interface rx mode is changed */
221   vnet_interface_set_rx_mode_function_t *rx_mode_change_function;
222
223   /* Function to call interface l2 mode is changed */
224   vnet_interface_set_l2_mode_function_t *set_l2_mode_function;
225
226   /* Redistribute flag changes/existence of this interface class. */
227   u32 redistribute;
228
229   /* Transmit function. */
230   vlib_node_function_t *tx_function;
231
232   /* Transmit function candidate registration with priority */
233   vlib_node_fn_registration_t *tx_fn_registrations;
234
235   /* Error strings indexed by error code for this node. */
236   char **tx_function_error_strings;
237   vlib_error_desc_t *tx_function_error_counters;
238
239   /* Number of error codes used by this node. */
240   u32 tx_function_n_errors;
241
242   /* Renumber device name [only!] support, a control-plane kludge */
243   int (*name_renumber) (struct vnet_hw_interface_t * hi,
244                         u32 new_dev_instance);
245
246   /* Interface flow offload operations */
247   vnet_flow_dev_ops_function_t *flow_ops_function;
248
249   /* Format device instance as name. */
250   format_function_t *format_device_name;
251
252   /* Parse function for device name. */
253   unformat_function_t *unformat_device_name;
254
255   /* Format device verbosely for this class. */
256   format_function_t *format_device;
257
258   /* Trace buffer format for TX function. */
259   format_function_t *format_tx_trace;
260
261   /* Format flow offload entry */
262   format_function_t *format_flow;
263
264   vnet_dev_class_ip_tunnel_desc_t ip_tun_desc;
265
266   /* Function to clear hardware counters for device. */
267   void (*clear_counters) (u32 dev_class_instance);
268
269     uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
270                                            u32 hw_if_index,
271                                            u32 hw_class_index);
272
273   /* Called when hardware class of an interface changes. */
274   void (*hw_class_change) (struct vnet_main_t * vnm,
275                            u32 hw_if_index, u32 new_hw_class_index);
276
277   /* Called to redirect traffic from a specific interface instance */
278   void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
279                                u32 hw_if_index, u32 node_index);
280
281   /* Link-list of all device classes set up by constructors created below */
282   struct _vnet_device_class *next_class_registration;
283
284   /* Function to set mac address. */
285   vnet_interface_set_mac_address_function_t *mac_addr_change_function;
286
287   /* Function to add/delete additional MAC addresses */
288   vnet_interface_add_del_mac_address_function_t *mac_addr_add_del_function;
289
290   /* Interface to set rss queues of the interface */
291   vnet_interface_rss_queues_set_t *set_rss_queues_function;
292
293 } vnet_device_class_t;
294
295 #ifndef CLIB_MARCH_VARIANT
296 #define VNET_DEVICE_CLASS(x,...)                                        \
297   __VA_ARGS__ vnet_device_class_t x;                                    \
298 static void __vnet_add_device_class_registration_##x (void)             \
299     __attribute__((__constructor__)) ;                                  \
300 static void __vnet_add_device_class_registration_##x (void)             \
301 {                                                                       \
302     vnet_main_t * vnm = vnet_get_main();                                \
303     x.next_class_registration = vnm->device_class_registrations;        \
304     vnm->device_class_registrations = &x;                               \
305 }                                                                       \
306 static void __vnet_rm_device_class_registration_##x (void)              \
307     __attribute__((__destructor__)) ;                                   \
308 static void __vnet_rm_device_class_registration_##x (void)              \
309 {                                                                       \
310     vnet_main_t * vnm = vnet_get_main();                                \
311     VLIB_REMOVE_FROM_LINKED_LIST (vnm->device_class_registrations,      \
312                                   &x, next_class_registration);         \
313 }                                                                       \
314 __VA_ARGS__ vnet_device_class_t x
315 #else
316 /* create unused pointer to silence compiler warnings and get whole
317    function optimized out */
318 #define VNET_DEVICE_CLASS(x,...)                                        \
319 static __clib_unused vnet_device_class_t __clib_unused_##x
320 #endif
321
322 #define VNET_DEVICE_CLASS_TX_FN(devclass)                                     \
323   uword CLIB_MARCH_SFX (devclass##_tx_fn) (                                   \
324     vlib_main_t *, vlib_node_runtime_t *, vlib_frame_t *);                    \
325   static vlib_node_fn_registration_t CLIB_MARCH_SFX (                         \
326     devclass##_tx_fn_registration) = {                                        \
327     .function = &CLIB_MARCH_SFX (devclass##_tx_fn),                           \
328   };                                                                          \
329                                                                               \
330   static void __clib_constructor CLIB_MARCH_SFX (                             \
331     devclass##_tx_fn_multiarch_register) (void)                               \
332   {                                                                           \
333     extern vnet_device_class_t devclass;                                      \
334     vlib_node_fn_registration_t *r;                                           \
335     r = &CLIB_MARCH_SFX (devclass##_tx_fn_registration);                      \
336     r->march_variant = CLIB_MARCH_SFX (CLIB_MARCH_VARIANT_TYPE);              \
337     r->next_registration = devclass.tx_fn_registrations;                      \
338     devclass.tx_fn_registrations = r;                                         \
339   }                                                                           \
340   uword CLIB_MARCH_SFX (devclass##_tx_fn)
341
342 /**
343  * Link Type: A description of the protocol of packets on the link.
344  * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
345  * it maps to the GRE-proto, etc for other lnk types.
346  */
347 typedef enum vnet_link_t_
348 {
349 #if CLIB_DEBUG > 0
350   VNET_LINK_IP4 = 1,
351 #else
352   VNET_LINK_IP4 = 0,
353 #endif
354   VNET_LINK_IP6,
355   VNET_LINK_MPLS,
356   VNET_LINK_ETHERNET,
357   VNET_LINK_ARP,
358   VNET_LINK_NSH,
359 } __attribute__ ((packed)) vnet_link_t;
360
361 #define VNET_LINKS {                   \
362     [VNET_LINK_ETHERNET] = "ethernet", \
363     [VNET_LINK_IP4] = "ipv4",          \
364     [VNET_LINK_IP6] = "ipv6",          \
365     [VNET_LINK_MPLS] = "mpls",         \
366     [VNET_LINK_ARP] = "arp",           \
367     [VNET_LINK_NSH] = "nsh",           \
368 }
369
370 #define FOR_EACH_VNET_LINK(_link)    \
371   for (_link = VNET_LINK_IP4;        \
372        _link <= VNET_LINK_NSH;       \
373        _link++)
374
375 #define FOR_EACH_VNET_IP_LINK(_link)    \
376   for (_link = VNET_LINK_IP4;           \
377        _link <= VNET_LINK_IP6;          \
378        _link++)
379
380 /**
381  * @brief Number of link types. Not part of the enum so it does not have to be
382  * included in switch statements
383  */
384 #define VNET_LINK_NUM (VNET_LINK_NSH+1)
385 #define VNET_N_LINKS VNET_LINK_NUM
386
387 /**
388  * @brief Convert a link to to an Ethertype
389  */
390 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
391
392 /**
393  * @brief Attributes assignable to a HW interface Class.
394  */
395 typedef enum vnet_hw_interface_class_flags_t_
396 {
397   /**
398    * @brief a point 2 point interface
399    */
400   VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
401   /**
402    * @brief a non-broadcast multiple access interface
403    */
404   VNET_HW_INTERFACE_CLASS_FLAG_NBMA = (1 << 1),
405 } vnet_hw_interface_class_flags_t;
406
407 /* Layer-2 (e.g. Ethernet) interface class. */
408 typedef struct _vnet_hw_interface_class
409 {
410   /* Index into main vector. */
411   u32 index;
412
413   /* Class name (e.g. "Ethernet"). */
414   char *name;
415
416   /* Flags */
417   vnet_hw_interface_class_flags_t flags;
418
419   /* tx hash type for interfaces of this hw class */
420   vnet_hash_fn_type_t tx_hash_fn_type;
421
422   /* Function to call when hardware interface is added/deleted. */
423   vnet_interface_function_t *interface_add_del_function;
424
425   /* Function to bring interface administratively up/down. */
426   vnet_interface_function_t *admin_up_down_function;
427
428   /* Function to call when link state changes. */
429   vnet_interface_function_t *link_up_down_function;
430
431   /* Function to call when link MAC changes. */
432   vnet_interface_set_mac_address_function_t *mac_addr_change_function;
433
434   /* Function to add/delete additional MAC addresses */
435   vnet_interface_add_del_mac_address_function_t *mac_addr_add_del_function;
436
437   /* Function to set max frame size. */
438   vnet_interface_set_max_frame_size_function_t *set_max_frame_size;
439
440   /* Format function to display interface name. */
441   format_function_t *format_interface_name;
442
443   /* Format function to display interface address. */
444   format_function_t *format_address;
445
446   /* Format packet header for this interface class. */
447   format_function_t *format_header;
448
449   /* Format device verbosely for this class. */
450   format_function_t *format_device;
451
452   /* Parser for hardware (e.g. ethernet) address. */
453   unformat_function_t *unformat_hw_address;
454
455   /* Parser for packet header for e.g. rewrite string. */
456   unformat_function_t *unformat_header;
457
458   /* Builds a rewrite string for the interface to the destination
459    * for the payload/link type. */
460   u8 *(*build_rewrite) (struct vnet_main_t * vnm,
461                         u32 sw_if_index,
462                         vnet_link_t link_type, const void *dst_hw_address);
463
464   /* Update an adjacency added by FIB (as opposed to via the
465    * neighbour resolution protocol). */
466   void (*update_adjacency) (struct vnet_main_t * vnm,
467                             u32 sw_if_index, u32 adj_index);
468
469     uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
470                                            u32 hw_if_index,
471                                            u32 hw_class_index);
472
473   /* Called when hw interface class is changed and old hardware instance
474      may want to be deleted. */
475   void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
476                            u32 old_class_index, u32 new_class_index);
477
478   /* List of hw interface classes, built by constructors */
479   struct _vnet_hw_interface_class *next_class_registration;
480
481 } vnet_hw_interface_class_t;
482
483 /**
484  * @brief Return a complete, zero-length (aka placeholder) rewrite
485  */
486 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
487                                   u32 sw_if_index,
488                                   vnet_link_t link_type,
489                                   const void *dst_hw_address);
490
491 /**
492  * @brief Default adjacency update function
493  */
494 extern void default_update_adjacency (struct vnet_main_t *vnm,
495                                       u32 sw_if_index, u32 adj_index);
496
497 #define VNET_HW_INTERFACE_CLASS(x,...)                                  \
498   __VA_ARGS__ vnet_hw_interface_class_t x;                              \
499 static void __vnet_add_hw_interface_class_registration_##x (void)       \
500     __attribute__((__constructor__)) ;                                  \
501 static void __vnet_add_hw_interface_class_registration_##x (void)       \
502 {                                                                       \
503     vnet_main_t * vnm = vnet_get_main();                                \
504     x.next_class_registration = vnm->hw_interface_class_registrations;  \
505     vnm->hw_interface_class_registrations = &x;                         \
506 }                                                                       \
507 static void __vnet_rm_hw_interface_class_registration_##x (void)        \
508     __attribute__((__destructor__)) ;                                   \
509 static void __vnet_rm_hw_interface_class_registration_##x (void)        \
510 {                                                                       \
511     vnet_main_t * vnm = vnet_get_main();                                \
512     VLIB_REMOVE_FROM_LINKED_LIST (vnm->hw_interface_class_registrations,\
513                                   &x, next_class_registration);         \
514 }                                                                       \
515 __VA_ARGS__ vnet_hw_interface_class_t x
516
517 typedef enum vnet_hw_interface_flags_t_
518 {
519   VNET_HW_INTERFACE_FLAG_NONE,
520   /* Hardware link state is up. */
521   VNET_HW_INTERFACE_FLAG_LINK_UP = (1 << 0),
522   /* Hardware duplex state */
523   VNET_HW_INTERFACE_FLAG_HALF_DUPLEX = (1 << 1),
524   VNET_HW_INTERFACE_FLAG_FULL_DUPLEX = (1 << 2),
525
526   /* non-broadcast multiple access */
527   VNET_HW_INTERFACE_FLAG_NBMA = (1 << 19),
528 } vnet_hw_interface_flags_t;
529
530 #define foreach_vnet_hw_if_caps                                               \
531   _ (0, TX_IP4_CKSUM, "ip4-csum-tx")                                          \
532   _ (1, TX_TCP_CKSUM, "tcp-csum-tx")                                          \
533   _ (2, TX_UDP_CKSUM, "udp-csum-tx")                                          \
534   _ (3, TX_IP4_OUTER_CKSUM, "outer-ip4-csum-tx")                              \
535   _ (4, TX_UDP_OUTER_CKSUM, "outer-udp-csum-tx")                              \
536   _ (5, RX_IP4_CKSUM, "ip4-csum-rx")                                          \
537   _ (6, RX_TCP_CKSUM, "tcp-csum-rx")                                          \
538   _ (7, RX_UDP_CKSUM, "udp-csum-rx")                                          \
539   _ (8, RX_IP4_OUTER_CKSUM, "outer-ip4-csum-rx")                              \
540   _ (9, RX_UDP_OUTER_CKSUM, "outer-udp-csum-rx")                              \
541   _ (10, TCP_GSO, "tcp-tso")                                                  \
542   _ (11, UDP_GSO, "udp-gso")                                                  \
543   _ (12, VXLAN_TNL_GSO, "vxlan-tnl-gso")                                      \
544   _ (13, IPIP_TNL_GSO, "ipip-tnl-gso")                                        \
545   _ (14, GENEVE_TNL_GSO, "geneve-tnl-gso")                                    \
546   _ (15, GRE_TNL_GSO, "gre-tnl-gso")                                          \
547   _ (16, UDP_TNL_GSO, "udp-tnl-gso")                                          \
548   _ (17, IP_TNL_GSO, "ip-tnl-gso")                                            \
549   _ (18, TCP_LRO, "tcp-lro")                                                  \
550   _ (30, INT_MODE, "int-mode")                                                \
551   _ (31, MAC_FILTER, "mac-filter")
552
553 typedef enum vnet_hw_if_caps_t_
554 {
555   VNET_HW_INTERFACE_CAP_NONE,
556 #define _(bit, sfx, str) VNET_HW_IF_CAP_##sfx = (1 << (bit)),
557   foreach_vnet_hw_if_caps
558 #undef _
559
560 } vnet_hw_if_caps_t;
561
562 #define VNET_HW_IF_CAP_L4_TX_CKSUM                                            \
563   (VNET_HW_IF_CAP_TX_TCP_CKSUM | VNET_HW_IF_CAP_TX_UDP_CKSUM)
564
565 #define VNET_HW_IF_CAP_TX_CKSUM                                               \
566   (VNET_HW_IF_CAP_TX_IP4_CKSUM | VNET_HW_IF_CAP_TX_TCP_CKSUM |                \
567    VNET_HW_IF_CAP_TX_UDP_CKSUM)
568
569 #define VNET_HW_IF_CAP_TX_OUTER_CKSUM                                         \
570   (VNET_HW_IF_CAP_TX_IP4_OUTER_CKSUM | VNET_HW_IF_CAP_TX_UDP_OUTER_CKSUM)
571
572 #define VNET_HW_IF_CAP_TX_CKSUM_MASK                                          \
573   (VNET_HW_IF_CAP_TX_CKSUM | VNET_HW_IF_CAP_TX_OUTER_CKSUM)
574
575 #define VNET_HW_IF_CAP_L4_RX_CKSUM                                            \
576   (VNET_HW_IF_CAP_RX_TCP_CKSUM | VNET_HW_IF_CAP_RX_UDP_CKSUM)
577
578 #define VNET_HW_IF_CAP_RX_CKSUM                                               \
579   (VNET_HW_IF_CAP_RX_IP4_CKSUM | VNET_HW_IF_CAP_RX_TCP_CKSUM |                \
580    VNET_HW_IF_CAP_RX_UDP_CKSUM)
581
582 #define VNET_HW_IF_CAP_TNL_GSO_MASK                                           \
583   VNET_HW_IF_CAP_VXLAN_TNL_GSO | VNET_HW_IF_CAP_IPIP_TNL_GSO
584
585 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
586 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT  3
587 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK      \
588   (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX |         \
589    VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
590
591 typedef struct
592 {
593   /* hw interface index */
594   u32 hw_if_index;
595
596   /* device instance */
597   u32 dev_instance;
598
599   /* index of thread pollling this queue */
600   u32 thread_index;
601
602   /* file index of queue interrupt line */
603   u32 file_index;
604
605   /* hardware queue identifier */
606   u32 queue_id;
607
608   /* mode */
609   vnet_hw_if_rx_mode mode : 8;
610 #define VNET_HW_IF_RXQ_THREAD_ANY      ~0
611 #define VNET_HW_IF_RXQ_NO_RX_INTERRUPT ~0
612 } vnet_hw_if_rx_queue_t;
613
614 typedef struct
615 {
616   u8 shared_queue : 1;
617   /* hw interface index */
618   u32 hw_if_index;
619
620   /* hardware queue identifier */
621   u32 queue_id;
622
623   /* bitmap of threads which use this queue */
624   clib_bitmap_t *threads;
625 } vnet_hw_if_tx_queue_t;
626
627 typedef enum
628 {
629   VNET_HW_IF_TX_FRAME_HINT_NOT_CHAINED = (1 << 0),
630   VNET_HW_IF_TX_FRAME_HINT_NO_GSO = (1 << 1),
631   VNET_HW_IF_TX_FRAME_HINT_NO_CKSUM_OFFLOAD = (1 << 2),
632 } vnet_hw_if_tx_frame_hint_t;
633
634 typedef struct
635 {
636   u8 shared_queue : 1;
637   vnet_hw_if_tx_frame_hint_t hints : 16;
638   u32 queue_id;
639 } vnet_hw_if_tx_frame_t;
640
641 typedef struct
642 {
643   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
644   vnet_hw_if_tx_frame_t *frame;
645   u32 *lookup_table;
646   u32 n_queues;
647 } vnet_hw_if_output_node_runtime_t;
648
649 /* Hardware-interface.  This corresponds to a physical wire
650    that packets flow over. */
651 typedef struct vnet_hw_interface_t
652 {
653   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
654   /* flags */
655   vnet_hw_interface_flags_t flags;
656
657   /* capabilities flags */
658   vnet_hw_if_caps_t caps;
659
660   /* Hardware address as vector.  Zero (e.g. zero-length vector) if no
661      address for this class (e.g. PPP). */
662   u8 *hw_address;
663
664   /* Interface is up as far as software is concerned. */
665   /* NAME.{output,tx} nodes for this interface. */
666   u32 output_node_index, tx_node_index;
667
668   /* interface-output-arc-end node next index for tx node */
669   u32 if_out_arc_end_node_next_index;
670
671   /* (dev_class, dev_instance) uniquely identifies hw interface. */
672   u32 dev_class_index;
673   u32 dev_instance;
674
675   /* (hw_class, hw_instance) uniquely identifies hw interface. */
676   u32 hw_class_index;
677   u32 hw_instance;
678
679   /* Hardware index for this hardware interface. */
680   u32 hw_if_index;
681
682   /* Software index for this hardware interface. */
683   u32 sw_if_index;
684
685   /* per thread output-node runtimes */
686   vnet_hw_if_output_node_runtime_t *output_node_thread_runtimes;
687
688   CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
689
690   /* Interface name. */
691   u8 *name;
692
693   /* link speed in kbps */
694   u32 link_speed;
695
696   /* Next index in interface-output node for this interface
697      used by node function vnet_per_buffer_interface_output() */
698   u32 output_node_next_index;
699
700   /* called when hw interface is using transmit side packet steering */
701   vnet_hash_fn_t hf;
702
703   /* Maximum transmit rate for this interface in bits/sec. */
704   f64 max_rate_bits_per_sec;
705
706   /* Smallest packet size for this interface. */
707   u32 min_frame_size;
708
709   /* Largest frame size for this interface. */
710   u32 max_frame_size;
711
712   /* Layer 2 overhead */
713   u16 frame_overhead;
714
715   /* Hash table mapping sub interface id to sw_if_index. */
716   uword *sub_interface_sw_if_index_by_id;
717
718   /* Count of number of L2 and L3 subinterfaces */
719   u32 l2_if_count;
720   u32 l3_if_count;
721
722   /* Bonded interface info -
723      0       - not a bonded interface nor a slave
724      ~0      - slave to a bonded interface
725      others  - A bonded interface with a pointer to bitmap for all slaves */
726   uword *bond_info;
727 #define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
728 #define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
729
730   /* Input node */
731   u32 input_node_index;
732
733   vnet_hw_if_rx_mode default_rx_mode;
734
735   /* rx queues */
736   u32 *rx_queue_indices;
737
738   /* tx queues */
739   u32 *tx_queue_indices;
740
741   /* numa node that hardware device connects to */
742   u8 numa_node;
743
744   /* rss queues bitmap */
745   clib_bitmap_t *rss_queues;
746
747   /* trace */
748   i32 n_trace;
749
750   u32 trace_classify_table_index;
751 } vnet_hw_interface_t;
752
753 STATIC_ASSERT_OFFSET_OF (vnet_hw_interface_t, cacheline1,
754                          CLIB_CACHE_LINE_BYTES);
755
756 typedef struct
757 {
758   u32 dev_instance;
759   u32 queue_id;
760 } vnet_hw_if_rxq_poll_vector_t;
761
762 typedef struct
763 {
764   vnet_hw_if_rxq_poll_vector_t *rxq_vector_int;
765   vnet_hw_if_rxq_poll_vector_t *rxq_vector_poll;
766   void *rxq_interrupts;
767 } vnet_hw_if_rx_node_runtime_t;
768
769 extern vnet_device_class_t vnet_local_interface_device_class;
770
771 typedef enum
772 {
773   /* A hw interface. */
774   VNET_SW_INTERFACE_TYPE_HARDWARE,
775
776   /* A sub-interface. */
777   VNET_SW_INTERFACE_TYPE_SUB,
778   VNET_SW_INTERFACE_TYPE_P2P,
779   VNET_SW_INTERFACE_TYPE_PIPE,
780 } vnet_sw_interface_type_t;
781
782 typedef struct
783 {
784   /*
785    * Subinterface ID. A number 0-N to uniquely identify
786    * this subinterface under the main (parent?) interface
787    */
788   u32 id;
789
790   /* Classification data. Used to associate packet header with subinterface. */
791   struct
792   {
793     u16 outer_vlan_id;
794     u16 inner_vlan_id;
795     union
796     {
797       u16 raw_flags;
798       struct
799       {
800         u16 no_tags:1;
801         u16 one_tag:1;
802         u16 two_tags:1;
803         u16 dot1ad:1;           /* 0 = dot1q, 1=dot1ad */
804         u16 exact_match:1;
805         u16 default_sub:1;
806         u16 outer_vlan_id_any:1;
807         u16 inner_vlan_id_any:1;
808       } flags;
809     };
810   } eth;
811 } vnet_sub_interface_t;
812
813 typedef struct
814 {
815   /*
816    * Subinterface ID. A number 0-N to uniquely identify
817    * this subinterface under the main interface
818    */
819   u32 id;
820   u32 pool_index;
821   u8 client_mac[6];
822 } vnet_p2p_sub_interface_t;
823
824 typedef enum
825 {
826   /* THe BVI interface */
827   VNET_FLOOD_CLASS_BVI,
828   /* Always flood */
829   VNET_FLOOD_CLASS_NORMAL,
830   VNET_FLOOD_CLASS_TUNNEL_MASTER,
831   /* Does not flood when tunnel master is in the same L2 BD */
832   VNET_FLOOD_CLASS_TUNNEL_NORMAL,
833   /* Never flood to this type */
834   VNET_FLOOD_CLASS_NO_FLOOD,
835 } vnet_flood_class_t;
836
837 /* Per protocol MTU */
838 typedef enum
839 {
840   VNET_MTU_L3,                  /* Default payload MTU (without L2 headers) */
841   VNET_MTU_IP4,                 /* Per-protocol MTUs overriding default */
842   VNET_MTU_IP6,
843   VNET_MTU_MPLS,
844   VNET_N_MTU
845 } vnet_mtu_t;
846
847 extern vnet_mtu_t vnet_link_to_mtu (vnet_link_t link);
848
849 typedef enum vnet_sw_interface_flags_t_
850 {
851   VNET_SW_INTERFACE_FLAG_NONE = 0,
852   /* Interface is "up" meaning administratively up.
853      Up in the sense of link state being up is maintained by hardware interface. */
854   VNET_SW_INTERFACE_FLAG_ADMIN_UP = (1 << 0),
855
856   /* Interface is disabled for forwarding: punt all traffic to slow-path. */
857   VNET_SW_INTERFACE_FLAG_PUNT = (1 << 1),
858
859   __VNET_SW_INTERFACE_FLAG_UNSUED = (1 << 2),
860
861   VNET_SW_INTERFACE_FLAG_UNNUMBERED = (1 << 3),
862
863   __VNET_SW_INTERFACE_FLAG_UNUSED2 = (1 << 4),
864
865   /* Interface does not appear in CLI/API */
866   VNET_SW_INTERFACE_FLAG_HIDDEN = (1 << 5),
867
868   /* Interface in ERROR state */
869   VNET_SW_INTERFACE_FLAG_ERROR = (1 << 6),
870
871   /* Interface has IP configured directed broadcast */
872   VNET_SW_INTERFACE_FLAG_DIRECTED_BCAST = (1 << 7),
873
874 } __attribute__ ((packed)) vnet_sw_interface_flags_t;
875
876 /* Software-interface.  This corresponds to a Ethernet VLAN, ATM vc, a
877    tunnel, etc.  Configuration (e.g. IP address) gets attached to
878    software interface. */
879 typedef struct
880 {
881   vnet_sw_interface_type_t type:16;
882
883   vnet_sw_interface_flags_t flags;
884
885   /* Index for this interface. */
886   u32 sw_if_index;
887
888   /* Software interface index of super-interface;
889      equal to sw_if_index if this interface is not a
890      sub-interface. */
891   u32 sup_sw_if_index;
892
893   /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
894   u32 unnumbered_sw_if_index;
895
896   /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
897   u32 hw_if_index;
898
899   /* MTU for network layer (not including L2 headers) */
900   u32 mtu[VNET_N_MTU];
901
902   /* VNET_SW_INTERFACE_TYPE_SUB. */
903   vnet_sub_interface_t sub;
904
905   /* VNET_SW_INTERFACE_TYPE_P2P. */
906   vnet_p2p_sub_interface_t p2p;
907
908   vnet_flood_class_t flood_class;
909 } vnet_sw_interface_t;
910
911 typedef enum
912 {
913   /* Simple counters. */
914   VNET_INTERFACE_COUNTER_DROP = 0,
915   VNET_INTERFACE_COUNTER_PUNT = 1,
916   VNET_INTERFACE_COUNTER_IP4 = 2,
917   VNET_INTERFACE_COUNTER_IP6 = 3,
918   VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
919   VNET_INTERFACE_COUNTER_RX_MISS = 5,
920   VNET_INTERFACE_COUNTER_RX_ERROR = 6,
921   VNET_INTERFACE_COUNTER_TX_ERROR = 7,
922   VNET_INTERFACE_COUNTER_MPLS = 8,
923   VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
924   /* Combined counters. */
925   VNET_INTERFACE_COUNTER_RX = 0,
926   VNET_INTERFACE_COUNTER_RX_UNICAST = 1,
927   VNET_INTERFACE_COUNTER_RX_MULTICAST = 2,
928   VNET_INTERFACE_COUNTER_RX_BROADCAST = 3,
929   VNET_INTERFACE_COUNTER_TX = 4,
930   VNET_INTERFACE_COUNTER_TX_UNICAST = 5,
931   VNET_INTERFACE_COUNTER_TX_MULTICAST = 6,
932   VNET_INTERFACE_COUNTER_TX_BROADCAST = 7,
933   VNET_N_COMBINED_INTERFACE_COUNTER = 8,
934 } vnet_interface_counter_type_t;
935
936 #define foreach_rx_combined_interface_counter(_x)               \
937   for (_x = VNET_INTERFACE_COUNTER_RX;                          \
938        _x <= VNET_INTERFACE_COUNTER_RX_BROADCAST;               \
939        _x++)
940
941 #define foreach_tx_combined_interface_counter(_x)               \
942   for (_x = VNET_INTERFACE_COUNTER_TX;                          \
943        _x <= VNET_INTERFACE_COUNTER_TX_BROADCAST;               \
944        _x++)
945
946 #define foreach_simple_interface_counter_name   \
947   _(DROP, drops, if)                            \
948   _(PUNT, punt, if)                             \
949   _(IP4, ip4, if)                               \
950   _(IP6, ip6, if)                               \
951   _(RX_NO_BUF, rx-no-buf, if)                   \
952   _(RX_MISS, rx-miss, if)                       \
953   _(RX_ERROR, rx-error, if)                     \
954   _(TX_ERROR, tx-error, if)         \
955   _(MPLS, mpls, if)
956
957 #define foreach_combined_interface_counter_name \
958   _(RX, rx, if)                                 \
959   _(RX_UNICAST, rx-unicast, if)                 \
960   _(RX_MULTICAST, rx-multicast, if)             \
961   _(RX_BROADCAST, rx-broadcast, if)             \
962   _(TX, tx, if)                                 \
963   _(TX_UNICAST, tx-unicast, if)                 \
964   _(TX_MULTICAST, tx-multicast, if)             \
965   _(TX_BROADCAST, tx-broadcast, if)
966
967 typedef enum
968 {
969   COLLECT_SIMPLE_STATS = 0,
970   COLLECT_DETAILED_STATS = 1,
971 } vnet_interface_stats_collection_mode_e;
972
973 extern int collect_detailed_interface_stats_flag;
974
975 static inline int
976 collect_detailed_interface_stats (void)
977 {
978   return collect_detailed_interface_stats_flag;
979 }
980
981 void collect_detailed_interface_stats_flag_set (void);
982 void collect_detailed_interface_stats_flag_clear (void);
983
984
985 typedef struct
986 {
987   u32 output_node_index;
988   u32 tx_node_index;
989 } vnet_hw_interface_nodes_t;
990
991 typedef struct
992 {
993   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
994   u32 *split_buffers;
995 } vnet_interface_per_thread_data_t;
996
997 typedef u8 *(*vnet_buffer_opquae_formatter_t) (const vlib_buffer_t * b,
998                                                u8 * s);
999
1000 typedef struct
1001 {
1002   /* Hardware interfaces. */
1003   vnet_hw_interface_t *hw_interfaces;
1004
1005   /* Hardware interface RX queues */
1006   vnet_hw_if_rx_queue_t *hw_if_rx_queues;
1007   uword *rxq_index_by_hw_if_index_and_queue_id;
1008
1009   /* Hardware interface TX queues */
1010   vnet_hw_if_tx_queue_t *hw_if_tx_queues;
1011   uword *txq_index_by_hw_if_index_and_queue_id;
1012
1013   /* Hash table mapping HW interface name to index. */
1014   uword *hw_interface_by_name;
1015
1016   /* Vectors if hardware interface classes and device classes. */
1017   vnet_hw_interface_class_t *hw_interface_classes;
1018   vnet_device_class_t *device_classes;
1019
1020   /* Hash table mapping name to hw interface/device class. */
1021   uword *hw_interface_class_by_name;
1022   uword *device_class_by_name;
1023
1024   /* Software interfaces. */
1025   vnet_sw_interface_t *sw_interfaces;
1026
1027   /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
1028   uword *sw_if_index_by_sup_and_sub;
1029
1030   /* Software interface counters both simple and combined
1031      packet and byte counters. */
1032   clib_spinlock_t sw_if_counter_lock;
1033   vlib_simple_counter_main_t *sw_if_counters;
1034   vlib_combined_counter_main_t *combined_sw_if_counters;
1035
1036   vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
1037
1038   /*
1039    * pcap drop tracing
1040    * Only the drop filter hash lives here. See ../src/vlib/main.h for
1041    * the rest of the variables.
1042    */
1043   uword *pcap_drop_filter_hash;
1044
1045   /* Buffer metadata format helper functions */
1046   vnet_buffer_opquae_formatter_t *buffer_opaque_format_helpers;
1047   vnet_buffer_opquae_formatter_t *buffer_opaque2_format_helpers;
1048
1049   /* per-thread data */
1050   vnet_interface_per_thread_data_t *per_thread_data;
1051
1052   /* feature_arc_index */
1053   u8 output_feature_arc_index;
1054
1055   /* fast lookup tables */
1056   u32 *hw_if_index_by_sw_if_index;
1057   u16 *if_out_arc_end_next_index_by_sw_if_index;
1058 } vnet_interface_main_t;
1059
1060 static inline void
1061 vnet_interface_counter_lock (vnet_interface_main_t * im)
1062 {
1063   if (im->sw_if_counter_lock)
1064     clib_spinlock_lock (&im->sw_if_counter_lock);
1065 }
1066
1067 static inline void
1068 vnet_interface_counter_unlock (vnet_interface_main_t * im)
1069 {
1070   if (im->sw_if_counter_lock)
1071     clib_spinlock_unlock (&im->sw_if_counter_lock);
1072 }
1073
1074 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
1075
1076 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
1077
1078 void vnet_register_format_buffer_opaque_helper
1079   (vnet_buffer_opquae_formatter_t fn);
1080
1081 void vnet_register_format_buffer_opaque2_helper
1082   (vnet_buffer_opquae_formatter_t fn);
1083
1084 typedef struct
1085 {
1086   u8 *filename;
1087   int enable;
1088   int status;
1089   u32 packets_to_capture;
1090   u32 max_bytes_per_pkt;
1091   u8 rx_enable;
1092   u8 tx_enable;
1093   u8 drop_enable;
1094   u8 preallocate_data;
1095   u8 free_data;
1096   u32 sw_if_index;
1097   int filter;
1098   vlib_error_t drop_err;
1099 } vnet_pcap_dispatch_trace_args_t;
1100
1101 int vnet_pcap_dispatch_trace_configure (vnet_pcap_dispatch_trace_args_t *);
1102
1103 extern vlib_node_registration_t vnet_interface_output_node;
1104 extern vlib_node_registration_t vnet_interface_output_arc_end_node;
1105
1106 #endif /* included_vnet_interface_h */
1107
1108 /*
1109  * fd.io coding-style-patch-verification: ON
1110  *
1111  * Local Variables:
1112  * eval: (c-set-style "gnu")
1113  * End:
1114  */