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