session: send ctrl msg over mq
[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 <vnet/unix/pcap.h>
44 #include <vnet/l3_types.h>
45
46 struct vnet_main_t;
47 struct vnet_hw_interface_t;
48 struct vnet_sw_interface_t;
49 struct ip46_address_t;
50
51 typedef enum
52 {
53   VNET_HW_INTERFACE_RX_MODE_UNKNOWN,
54   VNET_HW_INTERFACE_RX_MODE_POLLING,
55   VNET_HW_INTERFACE_RX_MODE_INTERRUPT,
56   VNET_HW_INTERFACE_RX_MODE_ADAPTIVE,
57   VNET_HW_INTERFACE_RX_MODE_DEFAULT,
58   VNET_HW_INTERFACE_NUM_RX_MODES,
59 } vnet_hw_interface_rx_mode;
60
61 /* Interface up/down callback. */
62 typedef clib_error_t *(vnet_interface_function_t)
63   (struct vnet_main_t * vnm, u32 if_index, u32 flags);
64
65 /* Sub-interface add/del callback. */
66 typedef clib_error_t *(vnet_subif_add_del_function_t)
67   (struct vnet_main_t * vnm, u32 if_index,
68    struct vnet_sw_interface_t * template, int is_add);
69
70 /* Interface set mac address callback. */
71 typedef clib_error_t *(vnet_interface_set_mac_address_function_t)
72   (struct vnet_hw_interface_t * hi, char *address);
73
74 /* Interface set rx mode callback. */
75 typedef clib_error_t *(vnet_interface_set_rx_mode_function_t)
76   (struct vnet_main_t * vnm, u32 if_index, u32 queue_id,
77    vnet_hw_interface_rx_mode mode);
78
79 /* Interface set l2 mode callback. */
80 typedef clib_error_t *(vnet_interface_set_l2_mode_function_t)
81   (struct vnet_main_t * vnm, struct vnet_hw_interface_t * hi,
82    i32 l2_if_adjust);
83
84 typedef enum
85 {
86   VNET_FLOW_DEV_OP_ADD_FLOW,
87   VNET_FLOW_DEV_OP_DEL_FLOW,
88   VNET_FLOW_DEV_OP_GET_COUNTER,
89   VNET_FLOW_DEV_OP_RESET_COUNTER,
90 } vnet_flow_dev_op_t;
91
92 /* Interface flow opeations callback. */
93 typedef int (vnet_flow_dev_ops_function_t) (struct vnet_main_t * vnm,
94                                             vnet_flow_dev_op_t op,
95                                             u32 hw_if_index, u32 index,
96                                             uword * private_data);
97
98 typedef enum vnet_interface_function_priority_t_
99 {
100   VNET_ITF_FUNC_PRIORITY_LOW,
101   VNET_ITF_FUNC_PRIORITY_HIGH,
102 } vnet_interface_function_priority_t;
103 #define VNET_ITF_FUNC_N_PRIO ((vnet_interface_function_priority_t)VNET_ITF_FUNC_PRIORITY_HIGH+1)
104
105 typedef struct _vnet_interface_function_list_elt
106 {
107   struct _vnet_interface_function_list_elt *next_interface_function;
108   clib_error_t *(*fp) (struct vnet_main_t * vnm, u32 if_index, u32 flags);
109 } _vnet_interface_function_list_elt_t;
110
111 #define _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,p)                    \
112                                                                         \
113 static void __vnet_interface_function_init_##tag##_##f (void)           \
114     __attribute__((__constructor__)) ;                                  \
115                                                                         \
116 static void __vnet_interface_function_init_##tag##_##f (void)           \
117 {                                                                       \
118  vnet_main_t * vnm = vnet_get_main();                                   \
119  static _vnet_interface_function_list_elt_t init_function;              \
120  init_function.next_interface_function = vnm->tag##_functions[p];       \
121  vnm->tag##_functions[p] = &init_function;                              \
122  init_function.fp = (void *) &f;                                        \
123 }                                                                       \
124 static void __vnet_interface_function_deinit_##tag##_##f (void)         \
125     __attribute__((__destructor__)) ;                                   \
126                                                                         \
127 static void __vnet_interface_function_deinit_##tag##_##f (void)         \
128 {                                                                       \
129  vnet_main_t * vnm = vnet_get_main();                                   \
130  _vnet_interface_function_list_elt_t *next;                             \
131  if (vnm->tag##_functions[p]->fp == (void *) &f)                        \
132     {                                                                   \
133       vnm->tag##_functions[p] =                                         \
134         vnm->tag##_functions[p]->next_interface_function;               \
135       return;                                                           \
136     }                                                                   \
137   next = vnm->tag##_functions[p];                                       \
138   while (next->next_interface_function)                                 \
139     {                                                                   \
140       if (next->next_interface_function->fp == (void *) &f)             \
141         {                                                               \
142           next->next_interface_function =                               \
143             next->next_interface_function->next_interface_function;     \
144           return;                                                       \
145         }                                                               \
146       next = next->next_interface_function;                             \
147     }                                                                   \
148 }
149
150 #define _VNET_INTERFACE_FUNCTION_DECL(f,tag)                            \
151   _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,tag,VNET_ITF_FUNC_PRIORITY_LOW)
152
153 #define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f)                   \
154   _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
155 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f)              \
156   _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
157 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(f,p)       \
158   _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,hw_interface_link_up_down,p)
159 #define VNET_SW_INTERFACE_MTU_CHANGE_FUNCTION(f)                \
160   _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_mtu_change)
161 #define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f)                   \
162   _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
163 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f)             \
164   _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
165 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(f,p)      \
166   _VNET_INTERFACE_FUNCTION_DECL_PRIO(f,sw_interface_admin_up_down, p)
167
168 /* A class of hardware interface devices. */
169 typedef struct _vnet_device_class
170 {
171   /* Index into main vector. */
172   u32 index;
173
174   /* Device name (e.g. "FOOBAR 1234a"). */
175   char *name;
176
177   /* Function to call when hardware interface is added/deleted. */
178   vnet_interface_function_t *interface_add_del_function;
179
180   /* Function to bring device administratively up/down. */
181   vnet_interface_function_t *admin_up_down_function;
182
183   /* Function to call when sub-interface is added/deleted */
184   vnet_subif_add_del_function_t *subif_add_del_function;
185
186   /* Function to call interface rx mode is changed */
187   vnet_interface_set_rx_mode_function_t *rx_mode_change_function;
188
189   /* Function to call interface l2 mode is changed */
190   vnet_interface_set_l2_mode_function_t *set_l2_mode_function;
191
192   /* Redistribute flag changes/existence of this interface class. */
193   u32 redistribute;
194
195   /* Transmit function. */
196   vlib_node_function_t *tx_function;
197
198   /* Error strings indexed by error code for this node. */
199   char **tx_function_error_strings;
200
201   /* Number of error codes used by this node. */
202   u32 tx_function_n_errors;
203
204   /* Renumber device name [only!] support, a control-plane kludge */
205   int (*name_renumber) (struct vnet_hw_interface_t * hi,
206                         u32 new_dev_instance);
207
208   /* Interface flow offload operations */
209   vnet_flow_dev_ops_function_t *flow_ops_function;
210
211   /* Format device instance as name. */
212   format_function_t *format_device_name;
213
214   /* Parse function for device name. */
215   unformat_function_t *unformat_device_name;
216
217   /* Format device verbosely for this class. */
218   format_function_t *format_device;
219
220   /* Trace buffer format for TX function. */
221   format_function_t *format_tx_trace;
222
223   /* Format flow offload entry */
224   format_function_t *format_flow;
225
226   /* Function to clear hardware counters for device. */
227   void (*clear_counters) (u32 dev_class_instance);
228
229     uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
230                                            u32 hw_if_index,
231                                            u32 hw_class_index);
232
233   /* Called when hardware class of an interface changes. */
234   void (*hw_class_change) (struct vnet_main_t * vnm,
235                            u32 hw_if_index, u32 new_hw_class_index);
236
237   /* Called to redirect traffic from a specific interface instance */
238   void (*rx_redirect_to_node) (struct vnet_main_t * vnm,
239                                u32 hw_if_index, u32 node_index);
240
241   /* Link-list of all device classes set up by constructors created below */
242   struct _vnet_device_class *next_class_registration;
243
244   /* Function to set mac address. */
245   vnet_interface_set_mac_address_function_t *mac_addr_change_function;
246 } vnet_device_class_t;
247
248 #define VNET_DEVICE_CLASS(x,...)                                        \
249   __VA_ARGS__ vnet_device_class_t x;                                    \
250 static void __vnet_add_device_class_registration_##x (void)             \
251     __attribute__((__constructor__)) ;                                  \
252 static void __vnet_add_device_class_registration_##x (void)             \
253 {                                                                       \
254     vnet_main_t * vnm = vnet_get_main();                                \
255     x.next_class_registration = vnm->device_class_registrations;        \
256     vnm->device_class_registrations = &x;                               \
257 }                                                                       \
258 static void __vnet_rm_device_class_registration_##x (void)              \
259     __attribute__((__destructor__)) ;                                   \
260 static void __vnet_rm_device_class_registration_##x (void)              \
261 {                                                                       \
262     vnet_main_t * vnm = vnet_get_main();                                \
263     VLIB_REMOVE_FROM_LINKED_LIST (vnm->device_class_registrations,      \
264                                   &x, next_class_registration);         \
265 }                                                                       \
266 __VA_ARGS__ vnet_device_class_t x
267
268 #define VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE(arch, fn, tgt)           \
269   uword                                                                 \
270   __attribute__ ((flatten))                                             \
271   __attribute__ ((target (tgt)))                                        \
272   CLIB_CPU_OPTIMIZED                                                    \
273   fn ## _ ## arch ( vlib_main_t * vm,                                   \
274                    vlib_node_runtime_t * node,                          \
275                    vlib_frame_t * frame)                                \
276   { return fn (vm, node, frame); }
277
278 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn)                     \
279   foreach_march_variant(VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE, fn)
280
281 #if CLIB_DEBUG > 0
282 #define VLIB_MULTIARCH_CLONE_AND_SELECT_FN(fn,...)
283 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn)
284 #else
285 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn)                      \
286   VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn)                           \
287   CLIB_MULTIARCH_SELECT_FN(fn, static inline)                           \
288   static void __attribute__((__constructor__))                          \
289   __vlib_device_tx_function_multiarch_select_##dev (void)               \
290   { dev.tx_function = fn ## _multiarch_select(); }
291 #endif
292
293 /**
294  * Link Type: A description of the protocol of packets on the link.
295  * On an ethernet link this maps directly into the ethertype. On a GRE tunnel
296  * it maps to the GRE-proto, etc for other lnk types.
297  */
298 typedef enum vnet_link_t_
299 {
300 #if CLIB_DEBUG > 0
301   VNET_LINK_IP4 = 1,
302 #else
303   VNET_LINK_IP4 = 0,
304 #endif
305   VNET_LINK_IP6,
306   VNET_LINK_MPLS,
307   VNET_LINK_ETHERNET,
308   VNET_LINK_ARP,
309   VNET_LINK_NSH,
310 } __attribute__ ((packed)) vnet_link_t;
311
312 #define VNET_LINKS {                   \
313     [VNET_LINK_ETHERNET] = "ethernet", \
314     [VNET_LINK_IP4] = "ipv4",          \
315     [VNET_LINK_IP6] = "ipv6",          \
316     [VNET_LINK_MPLS] = "mpls",         \
317     [VNET_LINK_ARP] = "arp",           \
318     [VNET_LINK_NSH] = "nsh",           \
319 }
320
321 #define FOR_EACH_VNET_LINK(_link)    \
322   for (_link = VNET_LINK_IP4;        \
323        _link <= VNET_LINK_NSH;       \
324        _link++)
325
326 /**
327  * @brief Number of link types. Not part of the enum so it does not have to be included in
328  * switch statements
329  */
330 #define VNET_LINK_NUM (VNET_LINK_NSH+1)
331
332 /**
333  * @brief Convert a link to to an Ethertype
334  */
335 extern vnet_l3_packet_type_t vnet_link_to_l3_proto (vnet_link_t link);
336
337 /**
338  * @brief Attributes assignable to a HW interface Class.
339  */
340 typedef enum vnet_hw_interface_class_flags_t_
341 {
342   /**
343    * @brief a point 2 point interface
344    */
345   VNET_HW_INTERFACE_CLASS_FLAG_P2P = (1 << 0),
346 } vnet_hw_interface_class_flags_t;
347
348 /* Layer-2 (e.g. Ethernet) interface class. */
349 typedef struct _vnet_hw_interface_class
350 {
351   /* Index into main vector. */
352   u32 index;
353
354   /* Class name (e.g. "Ethernet"). */
355   char *name;
356
357   /* Flags */
358   vnet_hw_interface_class_flags_t flags;
359
360   /* Function to call when hardware interface is added/deleted. */
361   vnet_interface_function_t *interface_add_del_function;
362
363   /* Function to bring interface administratively up/down. */
364   vnet_interface_function_t *admin_up_down_function;
365
366   /* Function to call when link state changes. */
367   vnet_interface_function_t *link_up_down_function;
368
369   /* Function to call when link MAC changes. */
370   vnet_interface_set_mac_address_function_t *mac_addr_change_function;
371
372   /* Format function to display interface name. */
373   format_function_t *format_interface_name;
374
375   /* Format function to display interface address. */
376   format_function_t *format_address;
377
378   /* Format packet header for this interface class. */
379   format_function_t *format_header;
380
381   /* Format device verbosely for this class. */
382   format_function_t *format_device;
383
384   /* Parser for hardware (e.g. ethernet) address. */
385   unformat_function_t *unformat_hw_address;
386
387   /* Parser for packet header for e.g. rewrite string. */
388   unformat_function_t *unformat_header;
389
390   /* Builds a rewrite string for the interface to the destination
391    * for the payload/link type. */
392   u8 *(*build_rewrite) (struct vnet_main_t * vnm,
393                         u32 sw_if_index,
394                         vnet_link_t link_type, const void *dst_hw_address);
395
396   /* Update an adjacecny added by FIB (as opposed to via the
397    * neighbour resolution protocol). */
398   void (*update_adjacency) (struct vnet_main_t * vnm,
399                             u32 sw_if_index, u32 adj_index);
400
401     uword (*is_valid_class_for_interface) (struct vnet_main_t * vnm,
402                                            u32 hw_if_index,
403                                            u32 hw_class_index);
404
405   /* Called when hw interface class is changed and old hardware instance
406      may want to be deleted. */
407   void (*hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index,
408                            u32 old_class_index, u32 new_class_index);
409
410   /* List of hw interface classes, built by constructors */
411   struct _vnet_hw_interface_class *next_class_registration;
412
413 } vnet_hw_interface_class_t;
414
415 /**
416  * @brief Return a complete, zero-length (aka dummy) rewrite
417  */
418 extern u8 *default_build_rewrite (struct vnet_main_t *vnm,
419                                   u32 sw_if_index,
420                                   vnet_link_t link_type,
421                                   const void *dst_hw_address);
422
423 /**
424  * @brief Default adjacency update function
425  */
426 extern void default_update_adjacency (struct vnet_main_t *vnm,
427                                       u32 sw_if_index, u32 adj_index);
428
429 #define VNET_HW_INTERFACE_CLASS(x,...)                                  \
430   __VA_ARGS__ vnet_hw_interface_class_t x;                              \
431 static void __vnet_add_hw_interface_class_registration_##x (void)       \
432     __attribute__((__constructor__)) ;                                  \
433 static void __vnet_add_hw_interface_class_registration_##x (void)       \
434 {                                                                       \
435     vnet_main_t * vnm = vnet_get_main();                                \
436     x.next_class_registration = vnm->hw_interface_class_registrations;  \
437     vnm->hw_interface_class_registrations = &x;                         \
438 }                                                                       \
439 static void __vnet_rm_hw_interface_class_registration_##x (void)        \
440     __attribute__((__destructor__)) ;                                   \
441 static void __vnet_rm_hw_interface_class_registration_##x (void)        \
442 {                                                                       \
443     vnet_main_t * vnm = vnet_get_main();                                \
444     VLIB_REMOVE_FROM_LINKED_LIST (vnm->hw_interface_class_registrations,\
445                                   &x, next_class_registration);         \
446 }                                                                       \
447 __VA_ARGS__ vnet_hw_interface_class_t x
448
449 /* Hardware-interface.  This corresponds to a physical wire
450    that packets flow over. */
451 typedef struct vnet_hw_interface_t
452 {
453   /* Interface name. */
454   u8 *name;
455
456   u32 flags;
457   /* Hardware link state is up. */
458 #define VNET_HW_INTERFACE_FLAG_LINK_UP          (1 << 0)
459   /* Hardware duplex state */
460 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT     1
461 #define VNET_HW_INTERFACE_FLAG_HALF_DUPLEX      (1 << 1)
462 #define VNET_HW_INTERFACE_FLAG_FULL_DUPLEX      (1 << 2)
463 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK      \
464   (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX |         \
465    VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
466
467   /* Hardware link speed */
468 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT      3
469 #define VNET_HW_INTERFACE_FLAG_SPEED_10M        (1 << 3)
470 #define VNET_HW_INTERFACE_FLAG_SPEED_100M       (1 << 4)
471 #define VNET_HW_INTERFACE_FLAG_SPEED_1G         (1 << 5)
472 #define VNET_HW_INTERFACE_FLAG_SPEED_2_5G       (1 << 6)
473 #define VNET_HW_INTERFACE_FLAG_SPEED_5G         (1 << 7)
474 #define VNET_HW_INTERFACE_FLAG_SPEED_10G        (1 << 8)
475 #define VNET_HW_INTERFACE_FLAG_SPEED_20G        (1 << 9)
476 #define VNET_HW_INTERFACE_FLAG_SPEED_25G        (1 << 10)
477 #define VNET_HW_INTERFACE_FLAG_SPEED_40G        (1 << 11)
478 #define VNET_HW_INTERFACE_FLAG_SPEED_50G        (1 << 12)
479 #define VNET_HW_INTERFACE_FLAG_SPEED_56G        (1 << 13)
480 #define VNET_HW_INTERFACE_FLAG_SPEED_100G       (1 << 14)
481 #define VNET_HW_INTERFACE_FLAG_SPEED_MASK       \
482   (VNET_HW_INTERFACE_FLAG_SPEED_10M |           \
483    VNET_HW_INTERFACE_FLAG_SPEED_100M |          \
484    VNET_HW_INTERFACE_FLAG_SPEED_1G |            \
485    VNET_HW_INTERFACE_FLAG_SPEED_2_5G |          \
486    VNET_HW_INTERFACE_FLAG_SPEED_5G |            \
487    VNET_HW_INTERFACE_FLAG_SPEED_10G |           \
488    VNET_HW_INTERFACE_FLAG_SPEED_20G |           \
489    VNET_HW_INTERFACE_FLAG_SPEED_25G |           \
490    VNET_HW_INTERFACE_FLAG_SPEED_40G |           \
491    VNET_HW_INTERFACE_FLAG_SPEED_50G |           \
492    VNET_HW_INTERFACE_FLAG_SPEED_56G |           \
493    VNET_HW_INTERFACE_FLAG_SPEED_100G)
494
495   /* rx mode flags */
496 #define VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE (1 << 16)
497
498   /* tx checksum offload */
499 #define VNET_HW_INTERFACE_FLAG_SUPPORTS_TX_L4_CKSUM_OFFLOAD (1 << 17)
500
501   /* Hardware address as vector.  Zero (e.g. zero-length vector) if no
502      address for this class (e.g. PPP). */
503   u8 *hw_address;
504
505   /* Interface is up as far as software is concerned. */
506   /* NAME.{output,tx} nodes for this interface. */
507   u32 output_node_index, tx_node_index;
508
509   /* (dev_class, dev_instance) uniquely identifies hw interface. */
510   u32 dev_class_index;
511   u32 dev_instance;
512
513   /* (hw_class, hw_instance) uniquely identifies hw interface. */
514   u32 hw_class_index;
515   u32 hw_instance;
516
517   /* Hardware index for this hardware interface. */
518   u32 hw_if_index;
519
520   /* Software index for this hardware interface. */
521   u32 sw_if_index;
522
523   /* Next index in interface-output node for this interface
524      used by node function vnet_per_buffer_interface_output() */
525   u32 output_node_next_index;
526
527   /* Maximum transmit rate for this interface in bits/sec. */
528   f64 max_rate_bits_per_sec;
529
530   /* Smallest packet size supported by this interface. */
531   u32 min_supported_packet_bytes;
532
533   /* Largest packet size supported by this interface. */
534   u32 max_supported_packet_bytes;
535
536   /* Smallest packet size for this interface. */
537   u32 min_packet_bytes;
538
539   /* Largest packet size for this interface. */
540   u32 max_packet_bytes;
541
542   /* Hash table mapping sub interface id to sw_if_index. */
543   uword *sub_interface_sw_if_index_by_id;
544
545   /* Count of number of L2 subinterfaces */
546   u32 l2_if_count;
547
548   /* Bonded interface info -
549      0       - not a bonded interface nor a slave
550      ~0      - slave to a bonded interface
551      others  - A bonded interface with a pointer to bitmap for all slaves */
552   uword *bond_info;
553 #define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
554 #define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
555
556   /* Input node */
557   u32 input_node_index;
558
559   /* input node cpu index by queue */
560   u32 *input_node_thread_index_by_queue;
561
562   /* vnet_hw_interface_rx_mode by queue */
563   u8 *rx_mode_by_queue;
564   vnet_hw_interface_rx_mode default_rx_mode;
565
566   /* device input device_and_queue runtime index */
567   uword *dq_runtime_index_by_queue;
568
569 } vnet_hw_interface_t;
570
571 extern vnet_device_class_t vnet_local_interface_device_class;
572
573 typedef enum
574 {
575   /* A hw interface. */
576   VNET_SW_INTERFACE_TYPE_HARDWARE,
577
578   /* A sub-interface. */
579   VNET_SW_INTERFACE_TYPE_SUB,
580   VNET_SW_INTERFACE_TYPE_P2P,
581   VNET_SW_INTERFACE_TYPE_PIPE,
582 } vnet_sw_interface_type_t;
583
584 typedef struct
585 {
586   /*
587    * Subinterface ID. A number 0-N to uniquely identify
588    * this subinterface under the main (parent?) interface
589    */
590   u32 id;
591
592   /* Classification data. Used to associate packet header with subinterface. */
593   struct
594   {
595     u16 outer_vlan_id;
596     u16 inner_vlan_id;
597     union
598     {
599       u16 raw_flags;
600       struct
601       {
602         u16 no_tags:1;
603         u16 one_tag:1;
604         u16 two_tags:1;
605         u16 dot1ad:1;           /* 0 = dot1q, 1=dot1ad */
606         u16 exact_match:1;
607         u16 default_sub:1;
608         u16 outer_vlan_id_any:1;
609         u16 inner_vlan_id_any:1;
610       } flags;
611     };
612   } eth;
613 } vnet_sub_interface_t;
614
615 typedef struct
616 {
617   /*
618    * Subinterface ID. A number 0-N to uniquely identify
619    * this subinterface under the main interface
620    */
621   u32 id;
622   u32 pool_index;
623   u8 client_mac[6];
624 } vnet_p2p_sub_interface_t;
625
626 typedef enum
627 {
628   /* THe BVI interface */
629   VNET_FLOOD_CLASS_BVI,
630   /* Always flood */
631   VNET_FLOOD_CLASS_NORMAL,
632   VNET_FLOOD_CLASS_TUNNEL_MASTER,
633   /* Does not flood when tunnel master is in the same L2 BD */
634   VNET_FLOOD_CLASS_TUNNEL_NORMAL,
635   /* Never flood to this type */
636   VNET_FLOOD_CLASS_NO_FLOOD,
637 } vnet_flood_class_t;
638
639 /* Per protocol MTU */
640 typedef enum
641 {
642   VNET_MTU_L3,                  /* Default payload MTU (without L2 headers) */
643   VNET_MTU_IP4,                 /* Per-protocol MTUs overriding default */
644   VNET_MTU_IP6,
645   VNET_MTU_MPLS,
646   VNET_N_MTU
647 } vnet_mtu_t;
648
649 extern vnet_mtu_t vnet_link_to_mtu (vnet_link_t link);
650
651 /* Software-interface.  This corresponds to a Ethernet VLAN, ATM vc, a
652    tunnel, etc.  Configuration (e.g. IP address) gets attached to
653    software interface. */
654 typedef struct
655 {
656   vnet_sw_interface_type_t type:16;
657
658   u16 flags;
659   /* Interface is "up" meaning adminstratively up.
660      Up in the sense of link state being up is maintained by hardware interface. */
661 #define VNET_SW_INTERFACE_FLAG_ADMIN_UP (1 << 0)
662
663   /* Interface is disabled for forwarding: punt all traffic to slow-path. */
664 #define VNET_SW_INTERFACE_FLAG_PUNT (1 << 1)
665
666 #define VNET_SW_INTERFACE_FLAG_PROXY_ARP (1 << 2)
667
668 #define VNET_SW_INTERFACE_FLAG_UNNUMBERED (1 << 3)
669
670 #define VNET_SW_INTERFACE_FLAG_BOND_SLAVE (1 << 4)
671
672   /* Interface does not appear in CLI/API */
673 #define VNET_SW_INTERFACE_FLAG_HIDDEN (1 << 5)
674
675   /* Interface in ERROR state */
676 #define VNET_SW_INTERFACE_FLAG_ERROR (1 << 6)
677
678   /* Index for this interface. */
679   u32 sw_if_index;
680
681   /* Software interface index of super-interface;
682      equal to sw_if_index if this interface is not a
683      sub-interface. */
684   u32 sup_sw_if_index;
685
686   /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
687   u32 unnumbered_sw_if_index;
688
689   u32 link_speed;
690
691   /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
692   u32 hw_if_index;
693
694   /* MTU for network layer (not including L2 headers) */
695   u32 mtu[VNET_N_MTU];
696
697   /* VNET_SW_INTERFACE_TYPE_SUB. */
698   vnet_sub_interface_t sub;
699
700   /* VNET_SW_INTERFACE_TYPE_P2P. */
701   vnet_p2p_sub_interface_t p2p;
702
703   vnet_flood_class_t flood_class;
704 } vnet_sw_interface_t;
705
706 typedef enum
707 {
708   /* Simple counters. */
709   VNET_INTERFACE_COUNTER_DROP = 0,
710   VNET_INTERFACE_COUNTER_PUNT = 1,
711   VNET_INTERFACE_COUNTER_IP4 = 2,
712   VNET_INTERFACE_COUNTER_IP6 = 3,
713   VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
714   VNET_INTERFACE_COUNTER_RX_MISS = 5,
715   VNET_INTERFACE_COUNTER_RX_ERROR = 6,
716   VNET_INTERFACE_COUNTER_TX_ERROR = 7,
717   VNET_INTERFACE_COUNTER_MPLS = 8,
718   VNET_N_SIMPLE_INTERFACE_COUNTER = 9,
719   /* Combined counters. */
720   VNET_INTERFACE_COUNTER_RX = 0,
721   VNET_INTERFACE_COUNTER_RX_UNICAST = 1,
722   VNET_INTERFACE_COUNTER_RX_MULTICAST = 2,
723   VNET_INTERFACE_COUNTER_RX_BROADCAST = 3,
724   VNET_INTERFACE_COUNTER_TX = 4,
725   VNET_INTERFACE_COUNTER_TX_UNICAST = 5,
726   VNET_INTERFACE_COUNTER_TX_MULTICAST = 6,
727   VNET_INTERFACE_COUNTER_TX_BROADCAST = 7,
728   VNET_N_COMBINED_INTERFACE_COUNTER = 8,
729 } vnet_interface_counter_type_t;
730
731 #define foreach_rx_combined_interface_counter(_x)               \
732   for (_x = VNET_INTERFACE_COUNTER_RX;                          \
733        _x <= VNET_INTERFACE_COUNTER_RX_BROADCAST;               \
734        _x++)
735
736 #define foreach_tx_combined_interface_counter(_x)               \
737   for (_x = VNET_INTERFACE_COUNTER_TX;                          \
738        _x <= VNET_INTERFACE_COUNTER_TX_BROADCAST;               \
739        _x++)
740
741 #define foreach_simple_interface_counter_name   \
742   _(DROP, drops, if)                            \
743   _(PUNT, punt, if)                             \
744   _(IP4, ip4, if)                               \
745   _(IP6, ip6, if)                               \
746   _(RX_NO_BUF, rx-no-buf, if)                   \
747   _(RX_MISS, rx-miss, if)                       \
748   _(RX_ERROR, rx-error, if)                     \
749   _(TX_ERROR, tx-error, if)
750
751 #define foreach_combined_interface_counter_name \
752   _(RX, rx, if)                                 \
753   _(RX_UNICAST, rx-unicast, if)                 \
754   _(RX_MULTICAST, rx-multicast, if)             \
755   _(RX_BROADCAST, rx-broadcast, if)             \
756   _(TX, tx, if)                                 \
757   _(TX_UNICAST, tx-unicast-miss, if)            \
758   _(TX_MULTICAST, tx-multicast, if)             \
759   _(TX_BROADCAST, tx-broadcast, if)
760
761 typedef enum
762 {
763   COLLECT_SIMPLE_STATS = 0,
764   COLLECT_DETAILED_STATS = 1,
765 } vnet_interface_stats_collection_mode_e;
766
767 extern int collect_detailed_interface_stats_flag;
768
769 static inline int
770 collect_detailed_interface_stats (void)
771 {
772   return collect_detailed_interface_stats_flag;
773 }
774
775 void collect_detailed_interface_stats_flag_set (void);
776 void collect_detailed_interface_stats_flag_clear (void);
777
778
779 typedef struct
780 {
781   u32 output_node_index;
782   u32 tx_node_index;
783 } vnet_hw_interface_nodes_t;
784
785 typedef struct
786 {
787   /* Hardware interfaces. */
788   vnet_hw_interface_t *hw_interfaces;
789
790   /* Hash table mapping HW interface name to index. */
791   uword *hw_interface_by_name;
792
793   /* Vectors if hardware interface classes and device classes. */
794   vnet_hw_interface_class_t *hw_interface_classes;
795   vnet_device_class_t *device_classes;
796
797   /* Hash table mapping name to hw interface/device class. */
798   uword *hw_interface_class_by_name;
799   uword *device_class_by_name;
800
801   /* Software interfaces. */
802   vnet_sw_interface_t *sw_interfaces;
803
804   /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
805   uword *sw_if_index_by_sup_and_sub;
806
807   /* Software interface counters both simple and combined
808      packet and byte counters. */
809   volatile u32 *sw_if_counter_lock;
810   vlib_simple_counter_main_t *sw_if_counters;
811   vlib_combined_counter_main_t *combined_sw_if_counters;
812
813   vnet_hw_interface_nodes_t *deleted_hw_interface_nodes;
814
815   /* pcap drop tracing */
816   int drop_pcap_enable;
817   pcap_main_t pcap_main;
818   u8 *pcap_filename;
819   u32 pcap_sw_if_index;
820   u32 pcap_pkts_to_capture;
821   uword *pcap_drop_filter_hash;
822
823   /* feature_arc_index */
824   u8 output_feature_arc_index;
825 } vnet_interface_main_t;
826
827 static inline void
828 vnet_interface_counter_lock (vnet_interface_main_t * im)
829 {
830   if (im->sw_if_counter_lock)
831     while (__sync_lock_test_and_set (im->sw_if_counter_lock, 1))
832       /* zzzz */ ;
833 }
834
835 static inline void
836 vnet_interface_counter_unlock (vnet_interface_main_t * im)
837 {
838   if (im->sw_if_counter_lock)
839     *im->sw_if_counter_lock = 0;
840 }
841
842 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
843
844 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
845
846 #endif /* included_vnet_interface_h */
847
848 /*
849  * fd.io coding-style-patch-verification: ON
850  *
851  * Local Variables:
852  * eval: (c-set-style "gnu")
853  * End:
854  */