ethernet: new interface registration function
[vpp.git] / src / vnet / ethernet / ethernet.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  * ethernet.h: types/functions for ethernet.
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_ethernet_h
41 #define included_ethernet_h
42
43 #include <vnet/vnet.h>
44 #include <vnet/ethernet/packet.h>
45 #include <vnet/ethernet/mac_address.h>
46 #include <vnet/feature/feature.h>
47
48 /* ethernet-input frame flags and scalar data */
49
50 /* all packets in frame share same sw_if_index */
51 #define ETH_INPUT_FRAME_F_SINGLE_SW_IF_IDX (1 << 0)
52
53 /* all ip4 packets in frame have correct ip4 checksum */
54 #define ETH_INPUT_FRAME_F_IP4_CKSUM_OK (1 << 1)
55
56 typedef struct
57 {
58   u32 sw_if_index;
59   u32 hw_if_index;
60 } ethernet_input_frame_t;
61
62 #ifdef CLIB_HAVE_VEC128
63 static const u16x8 tagged_ethertypes = {
64   (u16) ETHERNET_TYPE_VLAN,
65   (u16) ETHERNET_TYPE_DOT1AD,
66   (u16) ETHERNET_TYPE_VLAN_9100,
67   (u16) ETHERNET_TYPE_VLAN_9200,
68   /* duplicate last one to fill register */
69   (u16) ETHERNET_TYPE_VLAN_9200,
70   (u16) ETHERNET_TYPE_VLAN_9200,
71   (u16) ETHERNET_TYPE_VLAN_9200,
72   (u16) ETHERNET_TYPE_VLAN_9200
73 };
74 #endif
75
76 static_always_inline int
77 ethernet_frame_is_tagged (u16 type)
78 {
79 #ifdef CLIB_HAVE_VEC128
80   return !u16x8_is_all_zero (tagged_ethertypes == u16x8_splat (type));
81 #else
82   if ((type == ETHERNET_TYPE_VLAN) ||
83       (type == ETHERNET_TYPE_DOT1AD) ||
84       (type == ETHERNET_TYPE_VLAN_9100) || (type == ETHERNET_TYPE_VLAN_9200))
85     return 1;
86 #endif
87   return 0;
88 }
89
90 static_always_inline int
91 ethernet_frame_is_any_tagged_x2 (u16 type0, u16 type1)
92 {
93 #ifdef CLIB_HAVE_VEC128
94   u16x8 r0 = (tagged_ethertypes == u16x8_splat (type0));
95   u16x8 r1 = (tagged_ethertypes == u16x8_splat (type1));
96   return !u16x8_is_all_zero (r0 | r1);
97 #else
98   return ethernet_frame_is_tagged (type0) || ethernet_frame_is_tagged (type1);
99 #endif
100 }
101
102 static_always_inline int
103 ethernet_frame_is_any_tagged_x4 (u16 type0, u16 type1, u16 type2, u16 type3)
104 {
105 #ifdef CLIB_HAVE_VEC128
106   u16x8 r0 = (tagged_ethertypes == u16x8_splat (type0));
107   u16x8 r1 = (tagged_ethertypes == u16x8_splat (type1));
108   u16x8 r2 = (tagged_ethertypes == u16x8_splat (type2));
109   u16x8 r3 = (tagged_ethertypes == u16x8_splat (type3));
110   return !u16x8_is_all_zero (r0 | r1 | r2 | r3);
111 #else
112   return ethernet_frame_is_tagged (type0) || ethernet_frame_is_tagged (type1)
113     || ethernet_frame_is_tagged (type2) || ethernet_frame_is_tagged (type3);
114 #endif
115 }
116
117 /* Max. sized ethernet/vlan header for parsing. */
118 typedef struct
119 {
120   ethernet_header_t ethernet;
121
122   /* Allow up to 2 stacked vlan headers. */
123   ethernet_vlan_header_t vlan[2];
124 } ethernet_max_header_t;
125
126 struct vnet_hw_interface_t;
127 /* Ethernet flag change callback. */
128 typedef u32 (ethernet_flag_change_function_t)
129   (vnet_main_t * vnm, struct vnet_hw_interface_t * hi, u32 flags);
130
131 typedef struct
132 {
133   ethernet_flag_change_function_t *flag_change;
134 } vnet_eth_if_callbacks_t;
135
136 #define ETHERNET_MIN_PACKET_BYTES  64
137 #define ETHERNET_MAX_PACKET_BYTES  9216
138
139 /* ethernet dataplane loads mac address as u64 for efficiency */
140 typedef union ethernet_interface_address
141 {
142   struct
143   {
144     mac_address_t mac;
145     u16 zero;
146   };
147   u64 as_u64;
148 } ethernet_interface_address_t;
149
150 /* Ethernet interface instance. */
151 typedef struct ethernet_interface
152 {
153   u32 flags;
154
155   /* Top 16 bits for status and bottom 16 bits for set operation */
156 #define ETHERNET_INTERFACE_FLAGS_STATUS_MASK  (0xffff0000)
157 #define ETHERNET_INTERFACE_FLAGS_SET_OPN_MASK (0x0000ffff)
158
159   /* Interface driver/hw is in L3/non-promiscuous mode so packet DMAC
160      would already be filtered */
161 #define ETHERNET_INTERFACE_FLAG_STATUS_L3 (1 << 16)
162
163   /* Set interface to default L3 mode */
164 #define ETHERNET_INTERFACE_FLAG_DEFAULT_L3 0
165
166   /* Set interface to accept all packets (promiscuous mode). */
167 #define ETHERNET_INTERFACE_FLAG_ACCEPT_ALL 1
168
169   /* Change MTU on interface from hw interface structure */
170 #define ETHERNET_INTERFACE_FLAG_MTU        2
171
172   /* Callback, e.g. to turn on/off promiscuous mode */
173   vnet_eth_if_callbacks_t cb;
174
175   u32 driver_instance;
176
177   /* Ethernet (MAC) address for this interface. */
178   ethernet_interface_address_t address;
179
180   /* Secondary MAC addresses for this interface */
181   ethernet_interface_address_t *secondary_addrs;
182 } ethernet_interface_t;
183
184 extern vnet_hw_interface_class_t ethernet_hw_interface_class;
185
186 typedef struct
187 {
188   /* Name (a c string). */
189   char *name;
190
191   /* Ethernet type in host byte order. */
192   ethernet_type_t type;
193
194   /* Node which handles this type. */
195   u32 node_index;
196
197   /* Next index for this type. */
198   u32 next_index;
199 } ethernet_type_info_t;
200
201 typedef enum
202 {
203 #define ethernet_error(n,c,s) ETHERNET_ERROR_##n,
204 #include <vnet/ethernet/error.def>
205 #undef ethernet_error
206   ETHERNET_N_ERROR,
207 } ethernet_error_t;
208
209
210 // Structs used when parsing packet to find sw_if_index
211
212 typedef struct
213 {
214   u32 sw_if_index;
215   u32 flags;
216   // config entry is-valid flag
217   // exact match flags (valid if packet has 0/1/2/3 tags)
218   // L2 vs L3 forwarding mode
219 #define SUBINT_CONFIG_MATCH_0_TAG (1<<0)
220 #define SUBINT_CONFIG_MATCH_1_TAG (1<<1)
221 #define SUBINT_CONFIG_MATCH_2_TAG (1<<2)
222 #define SUBINT_CONFIG_MATCH_3_TAG (1<<3)
223 #define SUBINT_CONFIG_VALID       (1<<4)
224 #define SUBINT_CONFIG_L2          (1<<5)
225 #define SUBINT_CONFIG_P2P         (1<<6)
226
227 } subint_config_t;
228
229 always_inline u32
230 eth_create_valid_subint_match_flags (u32 num_tags)
231 {
232   return SUBINT_CONFIG_VALID | (1 << num_tags);
233 }
234
235
236 typedef struct
237 {
238   subint_config_t untagged_subint;
239   subint_config_t default_subint;
240   u16 dot1q_vlans;              // pool id for vlan table
241   u16 dot1ad_vlans;             // pool id for vlan table
242 } main_intf_t;
243
244 typedef struct
245 {
246   subint_config_t single_tag_subint;
247   subint_config_t inner_any_subint;
248   u32 qinqs;                    // pool id for qinq table
249 } vlan_intf_t;
250
251 typedef struct
252 {
253   vlan_intf_t vlans[ETHERNET_N_VLAN];
254 } vlan_table_t;
255
256 typedef struct
257 {
258   subint_config_t subint;
259 } qinq_intf_t;
260
261 typedef struct
262 {
263   qinq_intf_t vlans[ETHERNET_N_VLAN];
264 } qinq_table_t;
265
266 // Structure mapping to a next index based on ethertype.
267 // Common ethertypes are stored explicitly, others are
268 // stored in a sparse table.
269 typedef struct
270 {
271   /* Sparse vector mapping ethernet type in network byte order
272      to next index. */
273   u16 *input_next_by_type;
274   u32 *sparse_index_by_input_next_index;
275
276   /* cached next indexes for common ethertypes */
277   u32 input_next_ip4;
278   u32 input_next_ip6;
279   u32 input_next_mpls;
280 } next_by_ethertype_t;
281
282 struct ethernet_main_t_;
283
284 typedef void (ethernet_address_change_function_t)
285   (struct ethernet_main_t_ * im, u32 sw_if_index, uword opaque);
286
287 typedef struct
288 {
289   ethernet_address_change_function_t *function;
290   uword function_opaque;
291 } ethernet_address_change_ctx_t;
292
293 typedef struct ethernet_main_t_
294 {
295   vlib_main_t *vlib_main;
296
297   /* next node index for the L3 input node of each ethertype */
298   next_by_ethertype_t l3_next;
299
300   /* next node index for L2 interfaces */
301   u32 l2_next;
302
303   /* flag and next node index for L3 redirect */
304   u32 redirect_l3;
305   u32 redirect_l3_next;
306
307   /* Pool of ethernet interface instances. */
308   ethernet_interface_t *interfaces;
309
310   ethernet_type_info_t *type_infos;
311
312   /* Hash tables mapping name/type to type info index. */
313   uword *type_info_by_name, *type_info_by_type;
314
315   // The root of the vlan parsing tables. A vector with one element
316   // for each main interface, indexed by hw_if_index.
317   main_intf_t *main_intfs;
318
319   // Pool of vlan tables
320   vlan_table_t *vlan_pool;
321
322   // Pool of qinq tables;
323   qinq_table_t *qinq_pool;
324
325   /* Set to one to use AB.CD.EF instead of A:B:C:D:E:F as ethernet format. */
326   int format_ethernet_address_16bit;
327
328   /* debug: make sure we don't wipe out an ethernet registration by mistake */
329   u8 next_by_ethertype_register_called;
330
331   /* Feature arc index */
332   u8 output_feature_arc_index;
333
334   /* Allocated loopback instances */
335   uword *bm_loopback_instances;
336
337   /** Functions to call when interface hw address changes. */
338   ethernet_address_change_ctx_t *address_change_callbacks;
339
340   /** Default interface MTU */
341   u32 default_mtu;
342
343 } ethernet_main_t;
344
345 extern ethernet_main_t ethernet_main;
346
347 always_inline ethernet_type_info_t *
348 ethernet_get_type_info (ethernet_main_t * em, ethernet_type_t type)
349 {
350   uword *p = hash_get (em->type_info_by_type, type);
351   return p ? vec_elt_at_index (em->type_infos, p[0]) : 0;
352 }
353
354 ethernet_interface_t *ethernet_get_interface (ethernet_main_t * em,
355                                               u32 hw_if_index);
356 mac_address_t *ethernet_interface_add_del_address (ethernet_main_t * em,
357                                                    u32 hw_if_index,
358                                                    const u8 * address,
359                                                    u8 is_add);
360
361 void ethernet_delete_interface (vnet_main_t * vnm, u32 hw_if_index);
362
363 /* Register given node index to take input for given ethernet type. */
364 void
365 ethernet_register_input_type (vlib_main_t * vm,
366                               ethernet_type_t type, u32 node_index);
367
368 /* Register given node index to take input for packet from L2 interfaces. */
369 void ethernet_register_l2_input (vlib_main_t * vm, u32 node_index);
370
371 /* Register given node index to take redirected L3 traffic, and enable L3 redirect */
372 void ethernet_register_l3_redirect (vlib_main_t * vm, u32 node_index);
373
374 /* Formats ethernet address X:X:X:X:X:X */
375 u8 *format_mac_address (u8 * s, va_list * args);
376 u8 *format_ethernet_address (u8 * s, va_list * args);
377 u8 *format_ethernet_type (u8 * s, va_list * args);
378 u8 *format_ethernet_vlan_tci (u8 * s, va_list * va);
379 u8 *format_ethernet_header (u8 * s, va_list * args);
380 u8 *format_ethernet_header_with_length (u8 * s, va_list * args);
381
382 /* Parse ethernet address in either X:X:X:X:X:X unix or X.X.X cisco format. */
383 uword unformat_ethernet_address (unformat_input_t * input, va_list * args);
384 uword unformat_mac_address (unformat_input_t * input, va_list * args);
385
386 /* Parse ethernet type as 0xXXXX or type name from ethernet/types.def.
387    In either host or network byte order. */
388 uword
389 unformat_ethernet_type_host_byte_order (unformat_input_t * input,
390                                         va_list * args);
391 uword
392 unformat_ethernet_type_net_byte_order (unformat_input_t * input,
393                                        va_list * args);
394
395 /* Parse ethernet header. */
396 uword unformat_ethernet_header (unformat_input_t * input, va_list * args);
397
398 /* Parse ethernet interface name; return hw_if_index. */
399 uword unformat_ethernet_interface (unformat_input_t * input, va_list * args);
400
401 uword unformat_pg_ethernet_header (unformat_input_t * input, va_list * args);
402
403 void ethernet_setup_node (vlib_main_t *vm, u32 node_index);
404
405 always_inline ethernet_header_t *
406 ethernet_buffer_get_header (vlib_buffer_t * b)
407 {
408   return (void *) (b->data + vnet_buffer (b)->l2_hdr_offset);
409 }
410
411 /** Returns the number of VLAN headers in the current Ethernet frame in the
412  * buffer. Returns 0, 1, 2 for the known header count. The value 3 indicates
413  * the number of headers is not known.
414  */
415 #define ethernet_buffer_get_vlan_count(b) ( \
416     ((b)->flags & VNET_BUFFER_FLAGS_VLAN_BITS) >> VNET_BUFFER_F_LOG2_VLAN_1_DEEP \
417 )
418
419 /** Sets the number of VLAN headers in the current Ethernet frame in the
420  * buffer. Values 0, 1, 2 indicate  the header count. The value 3 indicates
421  * the number of headers is not known.
422  */
423 #define ethernet_buffer_set_vlan_count(b, v) ( \
424     (b)->flags = ((b)->flags & ~VNET_BUFFER_FLAGS_VLAN_BITS) | \
425         (((v) << VNET_BUFFER_F_LOG2_VLAN_1_DEEP) & VNET_BUFFER_FLAGS_VLAN_BITS) \
426 )
427
428 /** Adjusts the vlan count by the delta in 'v' */
429 #define ethernet_buffer_adjust_vlan_count(b, v) ( \
430   ethernet_buffer_set_vlan_count(b,  \
431       (word)ethernet_buffer_get_vlan_count(b) + (word)(v)) \
432 )
433
434 /** Adjusts the vlan count by the header size byte delta in 'v' */
435 #define ethernet_buffer_adjust_vlan_count_by_bytes(b, v) ( \
436     (b)->flags = ((b)->flags & ~VNET_BUFFER_FLAGS_VLAN_BITS) | (( \
437         ((b)->flags & VNET_BUFFER_FLAGS_VLAN_BITS) + \
438         ((v) << (VNET_BUFFER_F_LOG2_VLAN_1_DEEP - 2)) \
439     ) & VNET_BUFFER_FLAGS_VLAN_BITS) \
440 )
441
442 /**
443  * Determine the size of the Ethernet headers of the current frame in
444  * the buffer. This uses the VLAN depth flags that are set by
445  * ethernet-input. Because these flags are stored in the vlib_buffer_t
446  * "flags" field this count is valid regardless of the node so long as it's
447  * checked downstream of ethernet-input; That is, the value is not stored in
448  * the opaque space.
449  */
450 #define ethernet_buffer_header_size(b) ( \
451         ethernet_buffer_get_vlan_count((b)) * sizeof(ethernet_vlan_header_t) + \
452         sizeof(ethernet_header_t) \
453 )
454
455 ethernet_main_t *ethernet_get_main (vlib_main_t * vm);
456 u32 ethernet_set_flags (vnet_main_t * vnm, u32 hw_if_index, u32 flags);
457 void ethernet_sw_interface_set_l2_mode (vnet_main_t * vnm, u32 sw_if_index,
458                                         u32 l2);
459 void ethernet_sw_interface_set_l2_mode_noport (vnet_main_t * vnm,
460                                                u32 sw_if_index, u32 l2);
461 void ethernet_set_rx_redirect (vnet_main_t * vnm, vnet_hw_interface_t * hi,
462                                u32 enable);
463
464 clib_error_t *next_by_ethertype_init (next_by_ethertype_t * l3_next);
465 clib_error_t *next_by_ethertype_register (next_by_ethertype_t * l3_next,
466                                           u32 ethertype, u32 next_index);
467
468 int vnet_create_loopback_interface (u32 * sw_if_indexp, u8 * mac_address,
469                                     u8 is_specified, u32 user_instance);
470 int vnet_delete_loopback_interface (u32 sw_if_index);
471 int vnet_create_sub_interface (u32 sw_if_index, u32 id,
472                                u32 flags, u16 inner_vlan_id,
473                                u16 outer_vlan_id, u32 * sub_sw_if_index);
474 int vnet_delete_sub_interface (u32 sw_if_index);
475
476 // Perform ethernet subinterface classification table lookups given
477 // the ports's sw_if_index and fields extracted from the ethernet header.
478 // The resulting tables are used by identify_subint().
479 always_inline void
480 eth_vlan_table_lookups (ethernet_main_t * em,
481                         vnet_main_t * vnm,
482                         u32 port_sw_if_index0,
483                         u16 first_ethertype,
484                         u16 outer_id,
485                         u16 inner_id,
486                         vnet_hw_interface_t ** hi,
487                         main_intf_t ** main_intf,
488                         vlan_intf_t ** vlan_intf, qinq_intf_t ** qinq_intf)
489 {
490   vlan_table_t *vlan_table;
491   qinq_table_t *qinq_table;
492   u32 vlan_table_id;
493
494   // Read the main, vlan, and qinq interface table entries
495   // TODO: Consider if/how to prefetch tables. Also consider
496   // single-entry cache to skip table lookups and identify_subint()
497   // processing.
498   *hi = vnet_get_sup_hw_interface (vnm, port_sw_if_index0);
499   *main_intf = vec_elt_at_index (em->main_intfs, (*hi)->hw_if_index);
500
501   // Always read the vlan and qinq tables, even if there are not that
502   // many tags on the packet. This makes the lookups and comparisons
503   // easier (and less branchy).
504   vlan_table_id = (first_ethertype == ETHERNET_TYPE_DOT1AD) ?
505     (*main_intf)->dot1ad_vlans : (*main_intf)->dot1q_vlans;
506   vlan_table = vec_elt_at_index (em->vlan_pool, vlan_table_id);
507   *vlan_intf = &vlan_table->vlans[outer_id];
508
509   qinq_table = vec_elt_at_index (em->qinq_pool, (*vlan_intf)->qinqs);
510   *qinq_intf = &qinq_table->vlans[inner_id];
511 }
512
513
514 // Determine the subinterface for this packet, given the result of the
515 // vlan table lookups and vlan header parsing. Check the most specific
516 // matches first.
517 // Returns 1 if a matching subinterface was found, otherwise returns 0.
518 always_inline u32
519 eth_identify_subint (vnet_hw_interface_t * hi,
520                      u32 match_flags,
521                      main_intf_t * main_intf,
522                      vlan_intf_t * vlan_intf,
523                      qinq_intf_t * qinq_intf,
524                      u32 * new_sw_if_index, u8 * error0, u32 * is_l2)
525 {
526   subint_config_t *subint;
527
528   // Each comparison is checking both the valid flag and the number of tags
529   // (incorporating exact-match/non-exact-match).
530
531   // check for specific double tag
532   subint = &qinq_intf->subint;
533   if ((subint->flags & match_flags) == match_flags)
534     goto matched;
535
536   // check for specific outer and 'any' inner
537   subint = &vlan_intf->inner_any_subint;
538   if ((subint->flags & match_flags) == match_flags)
539     goto matched;
540
541   // check for specific single tag
542   subint = &vlan_intf->single_tag_subint;
543   if ((subint->flags & match_flags) == match_flags)
544     goto matched;
545
546   // check for default interface
547   subint = &main_intf->default_subint;
548   if ((subint->flags & match_flags) == match_flags)
549     goto matched;
550
551   // check for untagged interface
552   subint = &main_intf->untagged_subint;
553   if ((subint->flags & match_flags) == match_flags)
554     goto matched;
555
556   // No matching subinterface
557   *new_sw_if_index = ~0;
558   *error0 = ETHERNET_ERROR_UNKNOWN_VLAN;
559   *is_l2 = 0;
560   return 0;
561
562 matched:
563   *new_sw_if_index = subint->sw_if_index;
564   *is_l2 = subint->flags & SUBINT_CONFIG_L2;
565   return 1;
566 }
567
568 always_inline ethernet_main_t *
569 vnet_get_ethernet_main (void)
570 {
571   return &ethernet_main;
572 }
573
574 typedef struct
575 {
576   u32 dev_class_index;
577   u32 dev_instance;
578   vnet_eth_if_callbacks_t cb;
579   const u8 *address;
580 } vnet_eth_interface_registration_t;
581
582 u32 vnet_eth_register_interface (vnet_main_t *vnm,
583                                  vnet_eth_interface_registration_t *r);
584 void ethernet_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, u32 ai);
585 u8 *ethernet_build_rewrite (vnet_main_t * vnm,
586                             u32 sw_if_index,
587                             vnet_link_t link_type, const void *dst_address);
588 void ethernet_input_init (vlib_main_t * vm, ethernet_main_t * em);
589
590 extern vlib_node_registration_t ethernet_input_node;
591
592 #endif /* included_ethernet_h */
593
594 /*
595  * fd.io coding-style-patch-verification: ON
596  *
597  * Local Variables:
598  * eval: (c-set-style "gnu")
599  * End:
600  */