vnet: distinguish between max_frame_size and MTU
[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   static vlib_node_fn_registration_t CLIB_MARCH_SFX (                         \
325     devclass##_tx_fn_registration) = {                                        \
326     .function = &CLIB_MARCH_SFX (devclass##_tx_fn),                           \
327   };                                                                          \
328                                                                               \
329   static void __clib_constructor CLIB_MARCH_SFX (                             \
330     devclass##_tx_fn_multiarch_register) (void)                               \
331   {                                                                           \
332     extern vnet_device_class_t devclass;                                      \
333     vlib_node_fn_registration_t *r;                                           \
334     r = &CLIB_MARCH_SFX (devclass##_tx_fn_registration);                      \
335     r->march_variant = CLIB_MARCH_SFX (CLIB_MARCH_VARIANT_TYPE);              \
336     r->next_registration = devclass.tx_fn_registrations;                      \
337     devclass.tx_fn_registrations = r;                                         \
338   }                                                                           \
339   uword CLIB_MARCH_SFX (devclass##_tx_fn)
340
341 /**
342  * Link Type: A description of the protocol of packets on the link.
343  * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
344  * it maps to the GRE-proto, etc for other lnk types.
345  */
346 typedef enum vnet_link_t_
347 {
348 #if CLIB_DEBUG > 0
349   VNET_LINK_IP4 = 1,
350 #else
351   VNET_LINK_IP4 = 0,
352 #endif
353   VNET_LINK_IP6,
354   VNET_LINK_MPLS,
355   VNET_LINK_ETHERNET,
356   VNET_LINK_ARP,
357   VNET_LINK_NSH,
358 } __attribute__ ((packed)) vnet_link_t;
359
360 #define VNET_LINKS {                   \
361     [VNET_LINK_ETHERNET] = "ethernet", \
362     [VNET_LINK_IP4] = "ipv4",          \
363     [VNET_LINK_IP6] = "ipv6",          \
364     [VNET_LINK_MPLS] = "mpls",         \
365     [VNET_LINK_ARP] = "arp",           \
366     [VNET_LINK_NSH] = "nsh",           \
367 }
368
369 #define FOR_EACH_VNET_LINK(_link)    \
370   for (_link = VNET_LINK_IP4;        \
371        _link <= VNET_LINK_NSH;       \
372        _link++)
373
374 #define FOR_EACH_VNET_IP_LINK(_link)    \
375   for (_link = VNET_LINK_IP4;           \
376        _link <= VNET_LINK_IP6;          \
377        _link++)
378
379 /**
380  * @brief Number of link types. Not part of the enum so it does not have to be
381  * included in switch statements
382  */
383 #define VNET_LINK_NUM (VNET_LINK_NSH+1)
384 #define VNET_N_LINKS VNET_LINK_NUM
385
386 /**
387  * @brief Convert a link to to an Ethertype
388  */
389 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
390
391 /**
392  * @brief Attributes assignable to a HW interface Class.
393  */
394 typedef enum vnet_hw_interface_class_flags_t_
395 {
396   /**
397    * @brief a point 2 point interface
398    */
399   VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
400   /**
401    * @brief a non-broadcast multiple access interface
402    */
403   VNET_HW_INTERFACE_CLASS_FLAG_NBMA = (1 << 1),
404 } vnet_hw_interface_class_flags_t;
405
406 /* Layer-2 (e.g. Ethernet) interface class. */
407 typedef struct _vnet_hw_interface_class
408 {
409   /* Index into main vector. */
410   u32 index;
411
412   /* Class name (e.g. "Ethernet"). */
413   char *name;
414
415   /* Flags */
416   vnet_hw_interface_class_flags_t flags;
417
418   /* tx hash type for interfaces of this hw class */
419   vnet_hash_fn_type_t tx_hash_fn_type;
420
421   /* Function to call when hardware interface is added/deleted. */
422   vnet_interface_function_t *interface_add_del_function;
423
424   /* Function to bring interface administratively up/down. */
425   vnet_interface_function_t *admin_up_down_function;
426
427   /* Function to call when link state changes. */
428   vnet_interface_function_t *link_up_down_function;
429
430   /* Function to call when link MAC changes. */
431   vnet_interface_set_mac_address_function_t *mac_addr_change_function;
432
433   /* Function to add/delete additional MAC addresses */
434   vnet_interface_add_del_mac_address_function_t *mac_addr_add_del_function;
435
436   /* Function to set max frame size. */
437   vnet_interface_set_max_frame_size_function_t *set_max_frame_size;
438
439   /* Format function to display interface name. */
440   format_function_t *format_interface_name;
441
442   /* Format function to display interface address. */
443   format_function_t *format_address;
444
445   /* Format packet header for this interface class. */
446   format_function_t *format_header;
447
448   /* Format device verbosely for this class. */
449   format_function_t *format_device;
450
451   /* Parser for hardware (e.g. ethernet) address. */
452   unformat_function_t *unformat_hw_address;
453
454   /* Parser for packet header for e.g. rewrite string. */
455   unformat_function_t *unformat_header;
456
457   /* Builds a rewrite string for the interface to the destination
458    * for the payload/link type. */
459   u8 *(*build_rewrite) (struct vnet_main_t * vnm,
460                         u32 sw_if_index,
461                         vnet_link_t link_type, const void *dst_hw_address);
462
463   /* Update an adjacency added by FIB (as opposed to via the
464    * neighbour resolution protocol). */
465   void (*update_adjacency) (struct vnet_main_t * vnm,
466                             u32 sw_if_index, u32 adj_index);
467
468     uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
469                                            u32 hw_if_index,
470                                            u32 hw_class_index);
471
472   /* Called when hw interface class is changed and old hardware instance
473      may want to be deleted. */
474   void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
475                            u32 old_class_index, u32 new_class_index);
476
477   /* List of hw interface classes, built by constructors */
478   struct _vnet_hw_interface_class *next_class_registration;
479
480 } vnet_hw_interface_class_t;
481
482 /**
483  * @brief Return a complete, zero-length (aka placeholder) rewrite
484  */
485 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
486                                   u32 sw_if_index,
487                                   vnet_link_t link_type,
488                                   const void *dst_hw_address);
489
490 /**
491  * @brief Default adjacency update function
492  */
493 extern void default_update_adjacency (struct vnet_main_t *vnm,
494                                       u32 sw_if_index, u32 adj_index);
495
496 #define VNET_HW_INTERFACE_CLASS(x,...)                                  \
497   __VA_ARGS__ vnet_hw_interface_class_t x;                              \
498 static void __vnet_add_hw_interface_class_registration_##x (void)       \
499     __attribute__((__constructor__)) ;                                  \
500 static void __vnet_add_hw_interface_class_registration_##x (void)       \
501 {                                                                       \
502     vnet_main_t * vnm = vnet_get_main();                                \
503     x.next_class_registration = vnm->hw_interface_class_registrations;  \
504     vnm->hw_interface_class_registrations = &x;                         \
505 }                                                                       \
506 static void __vnet_rm_hw_interface_class_registration_##x (void)        \
507     __attribute__((__destructor__)) ;                                   \
508 static void __vnet_rm_hw_interface_class_registration_##x (void)        \
509 {                                                                       \
510     vnet_main_t * vnm = vnet_get_main();                                \
511     VLIB_REMOVE_FROM_LINKED_LIST (vnm->hw_interface_class_registrations,\
512                                   &x, next_class_registration);         \
513 }                                                                       \
514 __VA_ARGS__ vnet_hw_interface_class_t x
515
516 typedef enum vnet_hw_interface_flags_t_
517 {
518   VNET_HW_INTERFACE_FLAG_NONE,
519   /* Hardware link state is up. */
520   VNET_HW_INTERFACE_FLAG_LINK_UP = (1 << 0),
521   /* Hardware duplex state */
522   VNET_HW_INTERFACE_FLAG_HALF_DUPLEX = (1 << 1),
523   VNET_HW_INTERFACE_FLAG_FULL_DUPLEX = (1 << 2),
524
525   /* non-broadcast multiple access */
526   VNET_HW_INTERFACE_FLAG_NBMA = (1 << 19),
527 } vnet_hw_interface_flags_t;
528
529 #define foreach_vnet_hw_if_caps                                               \
530   _ (0, TX_IP4_CKSUM, "ip4-csum-tx")                                          \
531   _ (1, TX_TCP_CKSUM, "tcp-csum-tx")                                          \
532   _ (2, TX_UDP_CKSUM, "udp-csum-tx")                                          \
533   _ (3, TX_IP4_OUTER_CKSUM, "outer-ip4-csum-tx")                              \
534   _ (4, TX_UDP_OUTER_CKSUM, "outer-udp-csum-tx")                              \
535   _ (5, RX_IP4_CKSUM, "ip4-csum-rx")                                          \
536   _ (6, RX_TCP_CKSUM, "tcp-csum-rx")                                          \
537   _ (7, RX_UDP_CKSUM, "udp-csum-rx")                                          \
538   _ (8, RX_IP4_OUTER_CKSUM, "outer-ip4-csum-rx")                              \
539   _ (9, RX_UDP_OUTER_CKSUM, "outer-udp-csum-rx")                              \
540   _ (10, TCP_GSO, "tcp-tso")                                                  \
541   _ (11, UDP_GSO, "udp-gso")                                                  \
542   _ (12, VXLAN_TNL_GSO, "vxlan-tnl-gso")                                      \
543   _ (13, IPIP_TNL_GSO, "ipip-tnl-gso")                                        \
544   _ (14, GENEVE_TNL_GSO, "geneve-tnl-gso")                                    \
545   _ (15, GRE_TNL_GSO, "gre-tnl-gso")                                          \
546   _ (16, UDP_TNL_GSO, "udp-tnl-gso")                                          \
547   _ (17, IP_TNL_GSO, "ip-tnl-gso")                                            \
548   _ (18, TCP_LRO, "tcp-lro")                                                  \
549   _ (30, INT_MODE, "int-mode")                                                \
550   _ (31, MAC_FILTER, "mac-filter")
551
552 typedef enum vnet_hw_if_caps_t_
553 {
554   VNET_HW_INTERFACE_CAP_NONE,
555 #define _(bit, sfx, str) VNET_HW_IF_CAP_##sfx = (1 << (bit)),
556   foreach_vnet_hw_if_caps
557 #undef _
558
559 } vnet_hw_if_caps_t;
560
561 #define VNET_HW_IF_CAP_L4_TX_CKSUM                                            \
562   (VNET_HW_IF_CAP_TX_TCP_CKSUM | VNET_HW_IF_CAP_TX_UDP_CKSUM)
563
564 #define VNET_HW_IF_CAP_TX_CKSUM                                               \
565   (VNET_HW_IF_CAP_TX_IP4_CKSUM | VNET_HW_IF_CAP_TX_TCP_CKSUM |                \
566    VNET_HW_IF_CAP_TX_UDP_CKSUM)
567
568 #define VNET_HW_IF_CAP_TX_OUTER_CKSUM                                         \
569   (VNET_HW_IF_CAP_TX_IP4_OUTER_CKSUM | VNET_HW_IF_CAP_TX_UDP_OUTER_CKSUM)
570
571 #define VNET_HW_IF_CAP_TX_CKSUM_MASK                                          \
572   (VNET_HW_IF_CAP_TX_CKSUM | VNET_HW_IF_CAP_TX_OUTER_CKSUM)
573
574 #define VNET_HW_IF_CAP_L4_RX_CKSUM                                            \
575   (VNET_HW_IF_CAP_RX_TCP_CKSUM | VNET_HW_IF_CAP_RX_UDP_CKSUM)
576
577 #define VNET_HW_IF_CAP_RX_CKSUM                                               \
578   (VNET_HW_IF_CAP_RX_IP4_CKSUM | VNET_HW_IF_CAP_RX_TCP_CKSUM |                \
579    VNET_HW_IF_CAP_RX_UDP_CKSUM)
580
581 #define VNET_HW_IF_CAP_TNL_GSO_MASK                                           \
582   VNET_HW_IF_CAP_VXLAN_TNL_GSO | VNET_HW_IF_CAP_IPIP_TNL_GSO
583
584 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT 1
585 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT  3
586 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK      \
587   (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX |         \
588    VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
589
590 typedef struct
591 {
592   /* hw interface index */
593   u32 hw_if_index;
594
595   /* device instance */
596   u32 dev_instance;
597
598   /* index of thread pollling this queue */
599   u32 thread_index;
600
601   /* file index of queue interrupt line */
602   u32 file_index;
603
604   /* hardware queue identifier */
605   u32 queue_id;
606
607   /* mode */
608   vnet_hw_if_rx_mode mode : 8;
609 #define VNET_HW_IF_RXQ_THREAD_ANY      ~0
610 #define VNET_HW_IF_RXQ_NO_RX_INTERRUPT ~0
611 } vnet_hw_if_rx_queue_t;
612
613 typedef struct
614 {
615   u8 shared_queue : 1;
616   /* hw interface index */
617   u32 hw_if_index;
618
619   /* hardware queue identifier */
620   u32 queue_id;
621
622   /* bitmap of threads which use this queue */
623   clib_bitmap_t *threads;
624 } vnet_hw_if_tx_queue_t;
625
626 typedef enum
627 {
628   VNET_HW_IF_TX_FRAME_HINT_NOT_CHAINED = (1 << 0),
629   VNET_HW_IF_TX_FRAME_HINT_NO_GSO = (1 << 1),
630   VNET_HW_IF_TX_FRAME_HINT_NO_CKSUM_OFFLOAD = (1 << 2),
631 } vnet_hw_if_tx_frame_hint_t;
632
633 typedef struct
634 {
635   u8 shared_queue : 1;
636   vnet_hw_if_tx_frame_hint_t hints : 16;
637   u32 queue_id;
638 } vnet_hw_if_tx_frame_t;
639
640 typedef struct
641 {
642   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
643   vnet_hw_if_tx_frame_t *frame;
644   u32 *lookup_table;
645   u32 n_queues;
646 } vnet_hw_if_output_node_runtime_t;
647
648 /* Hardware-interface.  This corresponds to a physical wire
649    that packets flow over. */
650 typedef struct vnet_hw_interface_t
651 {
652   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
653   /* flags */
654   vnet_hw_interface_flags_t flags;
655
656   /* capabilities flags */
657   vnet_hw_if_caps_t caps;
658
659   /* Hardware address as vector.  Zero (e.g. zero-length vector) if no
660      address for this class (e.g. PPP). */
661   u8 *hw_address;
662
663   /* Interface is up as far as software is concerned. */
664   /* NAME.{output,tx} nodes for this interface. */
665   u32 output_node_index, tx_node_index;
666
667   /* interface-output-arc-end node next index for tx node */
668   u32 if_out_arc_end_node_next_index;
669
670   /* (dev_class, dev_instance) uniquely identifies hw interface. */
671   u32 dev_class_index;
672   u32 dev_instance;
673
674   /* (hw_class, hw_instance) uniquely identifies hw interface. */
675   u32 hw_class_index;
676   u32 hw_instance;
677
678   /* Hardware index for this hardware interface. */
679   u32 hw_if_index;
680
681   /* Software index for this hardware interface. */
682   u32 sw_if_index;
683
684   /* per thread output-node runtimes */
685   vnet_hw_if_output_node_runtime_t *output_node_thread_runtimes;
686
687   CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
688
689   /* Interface name. */
690   u8 *name;
691
692   /* link speed in kbps */
693   u32 link_speed;
694
695   /* Next index in interface-output node for this interface
696      used by node function vnet_per_buffer_interface_output() */
697   u32 output_node_next_index;
698
699   /* called when hw interface is using transmit side packet steering */
700   vnet_hash_fn_t hf;
701
702   /* Maximum transmit rate for this interface in bits/sec. */
703   f64 max_rate_bits_per_sec;
704
705   /* Smallest packet size for this interface. */
706   u32 min_frame_size;
707
708   /* Largest frame size for this interface. */
709   u32 max_frame_size;
710
711   /* Layer 2 overhead */
712   u16 frame_overhead;
713
714   /* Hash table mapping sub interface id to sw_if_index. */
715   uword *sub_interface_sw_if_index_by_id;
716
717   /* Count of number of L2 and L3 subinterfaces */
718   u32 l2_if_count;
719   u32 l3_if_count;
720
721   /* Bonded interface info -
722      0       - not a bonded interface nor a slave
723      ~0      - slave to a bonded interface
724      others  - A bonded interface with a pointer to bitmap for all slaves */
725   uword *bond_info;
726 #define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
727 #define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
728
729   /* Input node */
730   u32 input_node_index;
731
732   vnet_hw_if_rx_mode default_rx_mode;
733
734   /* rx queues */
735   u32 *rx_queue_indices;
736
737   /* tx queues */
738   u32 *tx_queue_indices;
739
740   /* numa node that hardware device connects to */
741   u8 numa_node;
742
743   /* rss queues bitmap */
744   clib_bitmap_t *rss_queues;
745
746   /* trace */
747   i32 n_trace;
748
749   u32 trace_classify_table_index;
750 } vnet_hw_interface_t;
751
752 STATIC_ASSERT_OFFSET_OF (vnet_hw_interface_t, cacheline1,
753                          CLIB_CACHE_LINE_BYTES);
754
755 typedef struct
756 {
757   u32 dev_instance;
758   u32 queue_id;
759 } vnet_hw_if_rxq_poll_vector_t;
760
761 typedef struct
762 {
763   vnet_hw_if_rxq_poll_vector_t *rxq_vector_int;
764   vnet_hw_if_rxq_poll_vector_t *rxq_vector_poll;
765   void *rxq_interrupts;
766 } vnet_hw_if_rx_node_runtime_t;
767
768 extern vnet_device_class_t vnet_local_interface_device_class;
769
770 typedef enum
771 {
772   /* A hw interface. */
773   VNET_SW_INTERFACE_TYPE_HARDWARE,
774
775   /* A sub-interface. */
776   VNET_SW_INTERFACE_TYPE_SUB,
777   VNET_SW_INTERFACE_TYPE_P2P,
778   VNET_SW_INTERFACE_TYPE_PIPE,
779 } vnet_sw_interface_type_t;
780
781 typedef struct
782 {
783   /*
784    * Subinterface ID. A number 0-N to uniquely identify
785    * this subinterface under the main (parent?) interface
786    */
787   u32 id;
788
789   /* Classification data. Used to associate packet header with subinterface. */
790   struct
791   {
792     u16 outer_vlan_id;
793     u16 inner_vlan_id;
794     union
795     {
796       u16 raw_flags;
797       struct
798       {
799         u16 no_tags:1;
800         u16 one_tag:1;
801         u16 two_tags:1;
802         u16 dot1ad:1;           /* 0 = dot1q, 1=dot1ad */
803         u16 exact_match:1;
804         u16 default_sub:1;
805         u16 outer_vlan_id_any:1;
806         u16 inner_vlan_id_any:1;
807       } flags;
808     };
809   } eth;
810 } vnet_sub_interface_t;
811
812 typedef struct
813 {
814   /*
815    * Subinterface ID. A number 0-N to uniquely identify
816    * this subinterface under the main interface
817    */
818   u32 id;
819   u32 pool_index;
820   u8 client_mac[6];
821 } vnet_p2p_sub_interface_t;
822
823 typedef enum
824 {
825   /* THe BVI interface */
826   VNET_FLOOD_CLASS_BVI,
827   /* Always flood */
828   VNET_FLOOD_CLASS_NORMAL,
829   VNET_FLOOD_CLASS_TUNNEL_MASTER,
830   /* Does not flood when tunnel master is in the same L2 BD */
831   VNET_FLOOD_CLASS_TUNNEL_NORMAL,
832   /* Never flood to this type */
833   VNET_FLOOD_CLASS_NO_FLOOD,
834 } vnet_flood_class_t;
835
836 /* Per protocol MTU */
837 typedef enum
838 {
839   VNET_MTU_L3,                  /* Default payload MTU (without L2 headers) */
840   VNET_MTU_IP4,                 /* Per-protocol MTUs overriding default */
841   VNET_MTU_IP6,
842   VNET_MTU_MPLS,
843   VNET_N_MTU
844 } vnet_mtu_t;
845
846 extern vnet_mtu_t vnet_link_to_mtu (vnet_link_t link);
847
848 typedef enum vnet_sw_interface_flags_t_
849 {
850   VNET_SW_INTERFACE_FLAG_NONE = 0,
851   /* Interface is "up" meaning administratively up.
852      Up in the sense of link state being up is maintained by hardware interface. */
853   VNET_SW_INTERFACE_FLAG_ADMIN_UP = (1 << 0),
854
855   /* Interface is disabled for forwarding: punt all traffic to slow-path. */
856   VNET_SW_INTERFACE_FLAG_PUNT = (1 << 1),
857
858   __VNET_SW_INTERFACE_FLAG_UNSUED = (1 << 2),
859
860   VNET_SW_INTERFACE_FLAG_UNNUMBERED = (1 << 3),
861
862   __VNET_SW_INTERFACE_FLAG_UNUSED2 = (1 << 4),
863
864   /* Interface does not appear in CLI/API */
865   VNET_SW_INTERFACE_FLAG_HIDDEN = (1 << 5),
866
867   /* Interface in ERROR state */
868   VNET_SW_INTERFACE_FLAG_ERROR = (1 << 6),
869
870   /* Interface has IP configured directed broadcast */
871   VNET_SW_INTERFACE_FLAG_DIRECTED_BCAST = (1 << 7),
872
873 } __attribute__ ((packed)) vnet_sw_interface_flags_t;
874
875 /* Software-interface.  This corresponds to a Ethernet VLAN, ATM vc, a
876    tunnel, etc.  Configuration (e.g. IP address) gets attached to
877    software interface. */
878 typedef struct
879 {
880   vnet_sw_interface_type_t type:16;
881
882   vnet_sw_interface_flags_t flags;
883
884   /* Index for this interface. */
885   u32 sw_if_index;
886
887   /* Software interface index of super-interface;
888      equal to sw_if_index if this interface is not a
889      sub-interface. */
890   u32 sup_sw_if_index;
891
892   /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
893   u32 unnumbered_sw_if_index;
894
895   /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
896   u32 hw_if_index;
897
898   /* MTU for network layer (not including L2 headers) */
899   u32 mtu[VNET_N_MTU];
900
901   /* VNET_SW_INTERFACE_TYPE_SUB. */
902   vnet_sub_interface_t sub;
903
904   /* VNET_SW_INTERFACE_TYPE_P2P. */
905   vnet_p2p_sub_interface_t p2p;
906
907   vnet_flood_class_t flood_class;
908 } vnet_sw_interface_t;
909
910 typedef enum
911 {
912   /* Simple counters. */
913   VNET_INTERFACE_COUNTER_DROP = 0,
914   VNET_INTERFACE_COUNTER_PUNT = 1,
915   VNET_INTERFACE_COUNTER_IP4 = 2,
916   VNET_INTERFACE_COUNTER_IP6 = 3,
917   VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
918   VNET_INTERFACE_COUNTER_RX_MISS = 5,
919   VNET_INTERFACE_COUNTER_RX_ERROR = 6,
920   VNET_INTERFACE_COUNTER_TX_ERROR = 7,
921   VNET_INTERFACE_COUNTER_MPLS = 8,
922   VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
923   /* Combined counters. */
924   VNET_INTERFACE_COUNTER_RX = 0,
925   VNET_INTERFACE_COUNTER_RX_UNICAST = 1,
926   VNET_INTERFACE_COUNTER_RX_MULTICAST = 2,
927   VNET_INTERFACE_COUNTER_RX_BROADCAST = 3,
928   VNET_INTERFACE_COUNTER_TX = 4,
929   VNET_INTERFACE_COUNTER_TX_UNICAST = 5,
930   VNET_INTERFACE_COUNTER_TX_MULTICAST = 6,
931   VNET_INTERFACE_COUNTER_TX_BROADCAST = 7,
932   VNET_N_COMBINED_INTERFACE_COUNTER = 8,
933 } vnet_interface_counter_type_t;
934
935 #define foreach_rx_combined_interface_counter(_x)               \
936   for (_x = VNET_INTERFACE_COUNTER_RX;                          \
937        _x <= VNET_INTERFACE_COUNTER_RX_BROADCAST;               \
938        _x++)
939
940 #define foreach_tx_combined_interface_counter(_x)               \
941   for (_x = VNET_INTERFACE_COUNTER_TX;                          \
942        _x <= VNET_INTERFACE_COUNTER_TX_BROADCAST;               \
943        _x++)
944
945 #define foreach_simple_interface_counter_name   \
946   _(DROP, drops, if)                            \
947   _(PUNT, punt, if)                             \
948   _(IP4, ip4, if)                               \
949   _(IP6, ip6, if)                               \
950   _(RX_NO_BUF, rx-no-buf, if)                   \
951   _(RX_MISS, rx-miss, if)                       \
952   _(RX_ERROR, rx-error, if)                     \
953   _(TX_ERROR, tx-error, if)         \
954   _(MPLS, mpls, if)
955
956 #define foreach_combined_interface_counter_name \
957   _(RX, rx, if)                                 \
958   _(RX_UNICAST, rx-unicast, if)                 \
959   _(RX_MULTICAST, rx-multicast, if)             \
960   _(RX_BROADCAST, rx-broadcast, if)             \
961   _(TX, tx, if)                                 \
962   _(TX_UNICAST, tx-unicast, if)                 \
963   _(TX_MULTICAST, tx-multicast, if)             \
964   _(TX_BROADCAST, tx-broadcast, if)
965
966 typedef enum
967 {
968   COLLECT_SIMPLE_STATS = 0,
969   COLLECT_DETAILED_STATS = 1,
970 } vnet_interface_stats_collection_mode_e;
971
972 extern int collect_detailed_interface_stats_flag;
973
974 static inline int
975 collect_detailed_interface_stats (void)
976 {
977   return collect_detailed_interface_stats_flag;
978 }
979
980 void collect_detailed_interface_stats_flag_set (void);
981 void collect_detailed_interface_stats_flag_clear (void);
982
983
984 typedef struct
985 {
986   u32 output_node_index;
987   u32 tx_node_index;
988 } vnet_hw_interface_nodes_t;
989
990 typedef struct
991 {
992   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
993   u32 *split_buffers;
994 } vnet_interface_per_thread_data_t;
995
996 typedef u8 *(*vnet_buffer_opquae_formatter_t) (const vlib_buffer_t * b,
997                                                u8 * s);
998
999 typedef struct
1000 {
1001   /* Hardware interfaces. */
1002   vnet_hw_interface_t *hw_interfaces;
1003
1004   /* Hardware interface RX queues */
1005   vnet_hw_if_rx_queue_t *hw_if_rx_queues;
1006   uword *rxq_index_by_hw_if_index_and_queue_id;
1007
1008   /* Hardware interface TX queues */
1009   vnet_hw_if_tx_queue_t *hw_if_tx_queues;
1010   uword *txq_index_by_hw_if_index_and_queue_id;
1011
1012   /* Hash table mapping HW interface name to index. */
1013   uword *hw_interface_by_name;
1014
1015   /* Vectors if hardware interface classes and device classes. */
1016   vnet_hw_interface_class_t *hw_interface_classes;
1017   vnet_device_class_t *device_classes;
1018
1019   /* Hash table mapping name to hw interface/device class. */
1020   uword *hw_interface_class_by_name;
1021   uword *device_class_by_name;
1022
1023   /* Software interfaces. */
1024   vnet_sw_interface_t *sw_interfaces;
1025
1026   /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
1027   uword *sw_if_index_by_sup_and_sub;
1028
1029   /* Software interface counters both simple and combined
1030      packet and byte counters. */
1031   clib_spinlock_t sw_if_counter_lock;
1032   vlib_simple_counter_main_t *sw_if_counters;
1033   vlib_combined_counter_main_t *combined_sw_if_counters;
1034
1035   vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
1036
1037   /*
1038    * pcap drop tracing
1039    * Only the drop filter hash lives here. See ../src/vlib/main.h for
1040    * the rest of the variables.
1041    */
1042   uword *pcap_drop_filter_hash;
1043
1044   /* Buffer metadata format helper functions */
1045   vnet_buffer_opquae_formatter_t *buffer_opaque_format_helpers;
1046   vnet_buffer_opquae_formatter_t *buffer_opaque2_format_helpers;
1047
1048   /* per-thread data */
1049   vnet_interface_per_thread_data_t *per_thread_data;
1050
1051   /* feature_arc_index */
1052   u8 output_feature_arc_index;
1053
1054   /* fast lookup tables */
1055   u32 *hw_if_index_by_sw_if_index;
1056   u16 *if_out_arc_end_next_index_by_sw_if_index;
1057 } vnet_interface_main_t;
1058
1059 static inline void
1060 vnet_interface_counter_lock (vnet_interface_main_t * im)
1061 {
1062   if (im->sw_if_counter_lock)
1063     clib_spinlock_lock (&im->sw_if_counter_lock);
1064 }
1065
1066 static inline void
1067 vnet_interface_counter_unlock (vnet_interface_main_t * im)
1068 {
1069   if (im->sw_if_counter_lock)
1070     clib_spinlock_unlock (&im->sw_if_counter_lock);
1071 }
1072
1073 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
1074
1075 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
1076
1077 void vnet_register_format_buffer_opaque_helper
1078   (vnet_buffer_opquae_formatter_t fn);
1079
1080 void vnet_register_format_buffer_opaque2_helper
1081   (vnet_buffer_opquae_formatter_t fn);
1082
1083 typedef struct
1084 {
1085   u8 *filename;
1086   int enable;
1087   int status;
1088   u32 packets_to_capture;
1089   u32 max_bytes_per_pkt;
1090   u8 rx_enable;
1091   u8 tx_enable;
1092   u8 drop_enable;
1093   u8 preallocate_data;
1094   u8 free_data;
1095   u32 sw_if_index;
1096   int filter;
1097   vlib_error_t drop_err;
1098 } vnet_pcap_dispatch_trace_args_t;
1099
1100 int vnet_pcap_dispatch_trace_configure (vnet_pcap_dispatch_trace_args_t *);
1101
1102 extern vlib_node_registration_t vnet_interface_output_node;
1103 extern vlib_node_registration_t vnet_interface_output_arc_end_node;
1104
1105 #endif /* included_vnet_interface_h */
1106
1107 /*
1108  * fd.io coding-style-patch-verification: ON
1109  *
1110  * Local Variables:
1111  * eval: (c-set-style "gnu")
1112  * End:
1113  */