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