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