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