Add support for multiple microarchitectures in single binary
[vpp.git] / vnet / 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
45 struct vnet_main_t;
46 struct vnet_hw_interface_t;
47 struct vnet_sw_interface_t;
48
49 /* Interface up/down callback. */
50 typedef clib_error_t * (vnet_interface_function_t)
51   (struct vnet_main_t * vnm, u32 if_index, u32 flags);
52
53 /* Sub-interface add/del callback. */
54 typedef clib_error_t * (vnet_subif_add_del_function_t)
55   (struct vnet_main_t * vnm, u32 if_index,
56    struct vnet_sw_interface_t * template,
57    int is_add);
58
59 typedef struct _vnet_interface_function_list_elt {
60   struct _vnet_interface_function_list_elt * next_interface_function;
61   clib_error_t * (*fp) (struct vnet_main_t * vnm, u32 if_index, u32 flags);
62 } _vnet_interface_function_list_elt_t;
63
64 #define _VNET_INTERFACE_FUNCTION_DECL(f,tag)                            \
65                                                                         \
66 static void __vnet_interface_function_init_##tag##_##f (void)           \
67     __attribute__((__constructor__)) ;                                  \
68                                                                         \
69 static void __vnet_interface_function_init_##tag##_##f (void)           \
70 {                                                                       \
71  vnet_main_t * vnm = vnet_get_main();                                   \
72  static _vnet_interface_function_list_elt_t init_function;              \
73  init_function.next_interface_function = vnm->tag##_functions;          \
74  vnm->tag##_functions = &init_function;                                 \
75  init_function.fp = (void *) &f;                                        \
76
77
78 #define VNET_HW_INTERFACE_ADD_DEL_FUNCTION(f)                   \
79   _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_add_del)
80 #define VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(f)              \
81   _VNET_INTERFACE_FUNCTION_DECL(f,hw_interface_link_up_down)
82 #define VNET_SW_INTERFACE_ADD_DEL_FUNCTION(f)                   \
83   _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_add_del)
84 #define VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(f)             \
85   _VNET_INTERFACE_FUNCTION_DECL(f,sw_interface_admin_up_down)
86
87 /* A class of hardware interface devices. */
88 typedef struct _vnet_device_class {
89   /* Index into main vector. */
90   u32 index;
91
92   /* Device name (e.g. "FOOBAR 1234a"). */
93   char * name;
94
95   /* Function to call when hardware interface is added/deleted. */
96   vnet_interface_function_t * interface_add_del_function;
97
98   /* Function to bring device administratively up/down. */
99   vnet_interface_function_t * admin_up_down_function;
100
101   /* Function to call when sub-interface is added/deleted */
102   vnet_subif_add_del_function_t * subif_add_del_function;
103
104   /* Redistribute flag changes/existence of this interface class. */
105   u32 redistribute;
106
107   /* Transmit function. */
108   vlib_node_function_t * tx_function;
109
110   /* Error strings indexed by error code for this node. */
111   char ** tx_function_error_strings;
112
113   /* Number of error codes used by this node. */
114   u32 tx_function_n_errors;
115
116   /* Renumber device name [only!] support, a control-plane kludge */
117   int (*name_renumber) (struct vnet_hw_interface_t * hi, u32 new_dev_instance);
118
119   /* Format device instance as name. */
120   format_function_t * format_device_name;
121
122   /* Parse function for device name. */
123   unformat_function_t * unformat_device_name;
124
125   /* Format device verbosely for this class. */
126   format_function_t * format_device;
127
128   /* Trace buffer format for TX function. */
129   format_function_t * format_tx_trace;
130
131   /* Function to clear hardware counters for device. */
132   void (* clear_counters) (u32 dev_class_instance);
133
134   uword (* is_valid_class_for_interface) (struct vnet_main_t * vnm, u32 hw_if_index, u32 hw_class_index);
135
136   /* Called when hardware class of an interface changes. */
137   void ( * hw_class_change) (struct vnet_main_t * vnm,
138                              u32 hw_if_index,
139                              u32 new_hw_class_index);
140
141   /* Called to redirect traffic from a specific interface instance */
142   void (* rx_redirect_to_node) (struct vnet_main_t * vnm,
143                                 u32 hw_if_index,
144                                 u32 node_index);
145
146   /* Link-list of all device classes set up by constructors created below */
147   struct _vnet_device_class * next_class_registration;
148
149   /* Do not splice vnet_interface_output_node into TX path */
150   u8 no_flatten_output_chains;
151
152 } vnet_device_class_t;
153
154 #define VNET_DEVICE_CLASS(x,...)                                        \
155   __VA_ARGS__ vnet_device_class_t x;                                    \
156 static void __vnet_add_device_class_registration_##x (void)             \
157     __attribute__((__constructor__)) ;                                  \
158 static void __vnet_add_device_class_registration_##x (void)             \
159 {                                                                       \
160     vnet_main_t * vnm = vnet_get_main();                                \
161     x.next_class_registration = vnm->device_class_registrations;        \
162     vnm->device_class_registrations = &x;                               \
163 }                                                                       \
164 __VA_ARGS__ vnet_device_class_t x                                       
165
166 #define VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE(arch, fn, tgt)           \
167   uword                                                                 \
168   __attribute__ ((flatten))                                             \
169   __attribute__ ((target (tgt)))                                        \
170   CLIB_CPU_OPTIMIZED                                                    \
171   fn ## _ ## arch ( vlib_main_t * vm,                                   \
172                    vlib_node_runtime_t * node,                          \
173                    vlib_frame_t * frame)                                \
174   { return fn (vm, node, frame); }
175
176 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn)                     \
177   foreach_march_variant(VLIB_DEVICE_TX_FUNCTION_CLONE_TEMPLATE, fn)
178
179 #if CLIB_DEBUG > 0
180 #define VLIB_MULTIARCH_CLONE_AND_SELECT_FN(fn,...)
181 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn)
182 #else
183 #define VLIB_DEVICE_TX_FUNCTION_MULTIARCH(dev, fn)                      \
184   VLIB_DEVICE_TX_FUNCTION_MULTIARCH_CLONE(fn)                           \
185   CLIB_MULTIARCH_SELECT_FN(fn, static inline)                           \
186   static void __attribute__((__constructor__))                          \
187   __vlib_device_tx_function_multiarch_select_##dev (void)               \
188   { dev.tx_function = fn ## _multiarch_select(); }
189 #endif
190
191
192 /* Layer-2 (e.g. Ethernet) interface class. */
193 typedef struct _vnet_hw_interface_class {
194   /* Index into main vector. */
195   u32 index;
196
197   /* Class name (e.g. "Ethernet"). */
198   char * name;
199
200   /* Function to call when hardware interface is added/deleted. */
201   vnet_interface_function_t * interface_add_del_function;
202
203   /* Function to bring interface administratively up/down. */
204   vnet_interface_function_t * admin_up_down_function;
205
206   /* Function to call when link state changes. */
207   vnet_interface_function_t * link_up_down_function;
208
209   /* Format function to display interface name. */
210   format_function_t * format_interface_name;
211
212   /* Format function to display interface address. */
213   format_function_t * format_address;
214
215   /* Format packet header for this interface class. */
216   format_function_t * format_header;
217
218   /* Format device verbosely for this class. */
219   format_function_t * format_device;
220
221   /* Parser for hardware (e.g. ethernet) address. */
222   unformat_function_t * unformat_hw_address;
223
224   /* Parser for packet header for e.g. rewrite string. */
225   unformat_function_t * unformat_header;
226
227   /* Forms adjacency for given l3 packet type and destination address.
228      Returns number of bytes in adjacency. */
229   uword (* set_rewrite) (struct vnet_main_t * vnm,
230                          u32 sw_if_index,
231                          u32 l3_packet_type,
232                          void * dst_address,
233                          void * rewrite,
234                          uword max_rewrite_bytes);
235
236   uword (* is_valid_class_for_interface) (struct vnet_main_t * vnm, u32 hw_if_index, u32 hw_class_index);
237
238   /* Called when hw interface class is changed and old hardware instance
239      may want to be deleted. */
240   void (* hw_class_change) (struct vnet_main_t * vnm, u32 hw_if_index, u32 old_class_index, u32 new_class_index);
241
242   /* List of hw interface classes, built by constructors */
243   struct _vnet_hw_interface_class * next_class_registration;
244
245 } vnet_hw_interface_class_t;
246
247 #define VNET_HW_INTERFACE_CLASS(x,...)                                  \
248   __VA_ARGS__ vnet_hw_interface_class_t x;                              \
249 static void __vnet_add_hw_interface_class_registration_##x (void)       \
250     __attribute__((__constructor__)) ;                                  \
251 static void __vnet_add_hw_interface_class_registration_##x (void)       \
252 {                                                                       \
253     vnet_main_t * vnm = vnet_get_main();                                \
254     x.next_class_registration = vnm->hw_interface_class_registrations;  \
255     vnm->hw_interface_class_registrations = &x;                         \
256 }                                                                       \
257 __VA_ARGS__ vnet_hw_interface_class_t x
258
259 /* Hardware-interface.  This corresponds to a physical wire
260    that packets flow over. */
261 typedef struct vnet_hw_interface_t {
262   /* Interface name. */
263   u8 * name;
264
265   u32 flags;
266   /* Hardware link state is up. */
267 #define VNET_HW_INTERFACE_FLAG_LINK_UP          (1 << 0)
268   /* Hardware duplex state */
269 #define VNET_HW_INTERFACE_FLAG_DUPLEX_SHIFT     1
270 #define VNET_HW_INTERFACE_FLAG_HALF_DUPLEX      (1 << 1)
271 #define VNET_HW_INTERFACE_FLAG_FULL_DUPLEX      (1 << 2)
272 #define VNET_HW_INTERFACE_FLAG_DUPLEX_MASK      \
273   (VNET_HW_INTERFACE_FLAG_HALF_DUPLEX |         \
274    VNET_HW_INTERFACE_FLAG_FULL_DUPLEX)
275
276   /* Hardware link speed */
277 #define VNET_HW_INTERFACE_FLAG_SPEED_SHIFT      3
278 #define VNET_HW_INTERFACE_FLAG_SPEED_10M        (1 << 3)
279 #define VNET_HW_INTERFACE_FLAG_SPEED_100M       (1 << 4)
280 #define VNET_HW_INTERFACE_FLAG_SPEED_1G         (1 << 5)
281 #define VNET_HW_INTERFACE_FLAG_SPEED_10G        (1 << 6)
282 #define VNET_HW_INTERFACE_FLAG_SPEED_40G        (1 << 7)
283 #define VNET_HW_INTERFACE_FLAG_SPEED_100G       (1 << 8)
284 #define VNET_HW_INTERFACE_FLAG_SPEED_MASK       \
285   (VNET_HW_INTERFACE_FLAG_SPEED_10M |           \
286    VNET_HW_INTERFACE_FLAG_SPEED_100M |          \
287    VNET_HW_INTERFACE_FLAG_SPEED_1G |            \
288    VNET_HW_INTERFACE_FLAG_SPEED_10G |           \
289    VNET_HW_INTERFACE_FLAG_SPEED_40G |           \
290    VNET_HW_INTERFACE_FLAG_SPEED_100G)
291
292   /* l2output node flags */
293 #define VNET_HW_INTERFACE_FLAG_L2OUTPUT_SHIFT   9
294 #define VNET_HW_INTERFACE_FLAG_L2OUTPUT_MAPPED  (1 << 9)
295
296   /* Hardware address as vector.  Zero (e.g. zero-length vector) if no
297      address for this class (e.g. PPP). */
298   u8 * hw_address;
299
300   /* Interface is up as far as software is concerned. */
301   /* NAME.{output,tx} nodes for this interface. */
302   u32 output_node_index, tx_node_index;
303
304   /* (dev_class, dev_instance) uniquely identifies hw interface. */
305   u32 dev_class_index;
306   u32 dev_instance;
307
308   /* (hw_class, hw_instance) uniquely identifies hw interface. */
309   u32 hw_class_index;
310   u32 hw_instance;
311
312   /* Hardware index for this hardware interface. */
313   u32 hw_if_index;
314
315   /* Software index for this hardware interface. */
316   u32 sw_if_index;
317
318   /* Maximum transmit rate for this interface in bits/sec. */
319   f64 max_rate_bits_per_sec;
320
321   /* Smallest packet size supported by this interface. */
322   u32 min_supported_packet_bytes;
323
324   /* Largest packet size supported by this interface. */
325   u32 max_supported_packet_bytes;
326
327   /* Smallest packet size for this interface. */
328   u32 min_packet_bytes;
329
330   /* Largest packet size for this interface. */
331   u32 max_packet_bytes;
332
333   /* Number of extra bytes that go on the wire.
334      Packet length on wire
335      = max (length + per_packet_overhead_bytes, min_packet_bytes). */
336   u32 per_packet_overhead_bytes;
337
338   /* Receive and transmit layer 3 packet size limits (MRU/MTU). */
339   u32 max_l3_packet_bytes[VLIB_N_RX_TX];
340
341   /* Hash table mapping sub interface id to sw_if_index. */
342   uword * sub_interface_sw_if_index_by_id;
343
344   /* Count of number of L2 subinterfaces */
345   u32 l2_if_count;
346
347   /* Bonded interface info -
348      0       - not a bonded interface nor a slave
349      ~0      - slave to a bonded interface
350      others  - A bonded interface with a pointer to bitmap for all slaves */
351   uword *bond_info;
352 #define VNET_HW_INTERFACE_BOND_INFO_NONE ((uword *) 0)
353 #define VNET_HW_INTERFACE_BOND_INFO_SLAVE ((uword *) ~0)
354
355 } vnet_hw_interface_t;
356
357 typedef enum {
358   /* A hw interface. */
359   VNET_SW_INTERFACE_TYPE_HARDWARE,
360
361   /* A sub-interface. */
362   VNET_SW_INTERFACE_TYPE_SUB,
363 } vnet_sw_interface_type_t;
364
365 typedef struct {
366   // Subinterface ID. A number 0-N to uniquely identify this subinterface under the
367   // main (parent?) interface
368   u32 id; 
369
370   // Classification data. Used to associate packet header with subinterface.
371   struct {
372     u16 outer_vlan_id;
373     u16 inner_vlan_id;
374     union {
375       u16 raw_flags;
376       struct {
377         u16 no_tags:1;
378         u16 one_tag:1;
379         u16 two_tags:1;
380         u16 dot1ad:1;   // 0 = dot1q, 1=dot1ad
381         u16 exact_match:1;
382         u16 default_sub:1;
383         u16 outer_vlan_id_any:1;
384         u16 inner_vlan_id_any:1;
385       } flags;
386     };
387   } eth;
388 } vnet_sub_interface_t;
389
390 /* Software-interface.  This corresponds to a Ethernet VLAN, ATM vc, a
391    tunnel, etc.  Configuration (e.g. IP address) gets attached to
392    software interface. */
393 typedef struct {
394   vnet_sw_interface_type_t type : 16;
395
396   u16 flags;
397   /* Interface is "up" meaning adminstratively up.
398      Up in the sense of link state being up is maintained by hardware interface. */
399 #define VNET_SW_INTERFACE_FLAG_ADMIN_UP (1 << 0)
400
401   /* Interface is disabled for forwarding: punt all traffic to slow-path. */
402 #define VNET_SW_INTERFACE_FLAG_PUNT (1 << 1)
403
404 #define VNET_SW_INTERFACE_FLAG_PROXY_ARP (1 << 2)
405
406 #define VNET_SW_INTERFACE_FLAG_UNNUMBERED (1 << 3)
407
408 #define VNET_SW_INTERFACE_FLAG_BOND_SLAVE (1 << 4)
409
410   /* Index for this interface. */
411   u32 sw_if_index;
412
413   /* Software interface index of super-interface;
414      equal to sw_if_index if this interface is not a
415      sub-interface. */
416   u32 sup_sw_if_index;
417
418   /* this swif is unnumbered, use addresses on unnumbered_sw_if_index... */
419   u32 unnumbered_sw_if_index;
420
421   u32 link_speed;
422
423   u32 output_feature_bitmap;
424
425   union {
426     /* VNET_SW_INTERFACE_TYPE_HARDWARE. */
427     u32 hw_if_index;
428
429     /* VNET_SW_INTERFACE_TYPE_SUB. */
430     vnet_sub_interface_t sub;
431
432     /* SW interfaces are sorted by type and key. */
433     // u32 sort_key;
434   };
435 } vnet_sw_interface_t;
436
437 typedef enum {
438   /* Simple counters. */
439   VNET_INTERFACE_COUNTER_DROP = 0,
440   VNET_INTERFACE_COUNTER_PUNT = 1,
441   VNET_INTERFACE_COUNTER_IP4 = 2,
442   VNET_INTERFACE_COUNTER_IP6 = 3,
443   VNET_INTERFACE_COUNTER_RX_NO_BUF = 4,
444   VNET_INTERFACE_COUNTER_RX_MISS = 5,
445   VNET_INTERFACE_COUNTER_RX_ERROR = 6,
446   VNET_INTERFACE_COUNTER_TX_ERROR = 7,
447   VNET_N_SIMPLE_INTERFACE_COUNTER = 8,
448   /* Combined counters. */
449   VNET_INTERFACE_COUNTER_RX = 0,
450   VNET_INTERFACE_COUNTER_TX = 1,
451   VNET_N_COMBINED_INTERFACE_COUNTER = 2,
452 } vnet_interface_counter_type_t;
453
454 typedef struct {
455   u32 output_node_index;
456   u32 tx_node_index;
457 } vnet_hw_interface_nodes_t;
458
459 typedef struct {
460   /* Hardware interfaces. */
461   vnet_hw_interface_t * hw_interfaces;
462
463   /* Hash table mapping HW interface name to index. */
464   uword * hw_interface_by_name;
465
466   /* Vectors if hardware interface classes and device classes. */
467   vnet_hw_interface_class_t * hw_interface_classes;
468   vnet_device_class_t * device_classes;
469
470   /* Hash table mapping name to hw interface/device class. */
471   uword * hw_interface_class_by_name;
472   uword * device_class_by_name;
473
474   /* Software interfaces. */
475   vnet_sw_interface_t * sw_interfaces;
476
477   /* Hash table mapping sub intfc sw_if_index by sup sw_if_index and sub id */
478   uword * sw_if_index_by_sup_and_sub;
479
480   /* Software interface counters both simple and combined
481      packet and byte counters. */
482   volatile u32 *sw_if_counter_lock;
483   vlib_simple_counter_main_t * sw_if_counters;
484   vlib_combined_counter_main_t * combined_sw_if_counters;
485
486   vnet_hw_interface_nodes_t * deleted_hw_interface_nodes;
487
488   /* pcap drop tracing */
489   int drop_pcap_enable;
490   pcap_main_t pcap_main;
491   u8 * pcap_filename;
492   u32 pcap_sw_if_index;
493   u32 pcap_pkts_to_capture;
494   uword * pcap_drop_filter_hash;
495
496 } vnet_interface_main_t;
497
498 static inline void vnet_interface_counter_lock (vnet_interface_main_t *im)
499 {
500   if (im->sw_if_counter_lock)
501     while (__sync_lock_test_and_set (im->sw_if_counter_lock, 1))
502       /* zzzz */ ;
503 }
504 static inline void vnet_interface_counter_unlock (vnet_interface_main_t *im)
505 {
506   if (im->sw_if_counter_lock)
507     *im->sw_if_counter_lock = 0;
508 }
509
510 void vnet_pcap_drop_trace_filter_add_del (u32 error_index, int is_add);
511
512 int vnet_interface_name_renumber (u32 sw_if_index, u32 new_show_dev_instance);
513
514
515 /*
516  *  Output features
517  */
518
519 #define foreach_intf_output_feat \
520  _(IPSEC, "ipsec-output")
521
522 // Feature bitmap positions
523 typedef enum {
524 #define _(sym,str) INTF_OUTPUT_FEAT_##sym,
525   foreach_intf_output_feat
526 #undef _
527   INTF_OUTPUT_N_FEAT,
528 } intf_output_feat_t;
529
530 /* flag that we are done with feature path */
531 #define INTF_OUTPUT_FEAT_DONE INTF_OUTPUT_N_FEAT
532
533 int vnet_interface_add_del_feature(struct vnet_main_t * vnm, vlib_main_t * vm,
534                                    u32 sw_if_index,
535                                    intf_output_feat_t feature, int is_add);
536
537 #endif /* included_vnet_interface_h */