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