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