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