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_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   /* Feature arc index */
 267   u8 output_feature_arc_index;
 268
 269   /* Allocated loopback instances */
 270   uword *bm_loopback_instances;
 271 } ethernet_main_t;
 272
 273 ethernet_main_t ethernet_main;
 274
 275 always_inline ethernet_type_info_t *
 276 ethernet_get_type_info (ethernet_main_t * em, ethernet_type_t type)
 277 {
 278   uword *p = hash_get (em->type_info_by_type, type);
 279   return p ? vec_elt_at_index (em->type_infos, p[0]) : 0;
 280 }
 281
 282 ethernet_interface_t *ethernet_get_interface (ethernet_main_t * em,
 283                                               u32 hw_if_index);
 284
 285 clib_error_t *ethernet_register_interface (vnet_main_t * vnm,
 286                                            u32 dev_class_index,
 287                                            u32 dev_instance,
 288                                            u8 * address,
 289                                            u32 * hw_if_index_return,
 290                                            ethernet_flag_change_function_t
 291                                            flag_change);
 292
 293 void ethernet_delete_interface (vnet_main_t * vnm, u32 hw_if_index);
 294
 295 /* Register given node index to take input for given ethernet type. */
 296 void
 297 ethernet_register_input_type (vlib_main_t * vm,
 298                               ethernet_type_t type, u32 node_index);
 299
 300 /* Register given node index to take input for packet from L2 interfaces. */
 301 void ethernet_register_l2_input (vlib_main_t * vm, u32 node_index);
 302
 303 /* Register given node index to take redirected L3 traffic, and enable L3 redirect */
 304 void ethernet_register_l3_redirect (vlib_main_t * vm, u32 node_index);
 305
 306 /* Formats ethernet address X:X:X:X:X:X */
 307 u8 *format_ethernet_address (u8 * s, va_list * args);
 308 u8 *format_ethernet_type (u8 * s, va_list * args);
 309 u8 *format_ethernet_vlan_tci (u8 * s, va_list * va);
 310 u8 *format_ethernet_header (u8 * s, va_list * args);
 311 u8 *format_ethernet_header_with_length (u8 * s, va_list * args);
 312
 313 /* Parse ethernet address in either X:X:X:X:X:X unix or X.X.X cisco format. */
 314 uword unformat_ethernet_address (unformat_input_t * input, va_list * args);
 315
 316 /* Parse ethernet type as 0xXXXX or type name from ethernet/types.def.
 317    In either host or network byte order. */
 318 uword
 319 unformat_ethernet_type_host_byte_order (unformat_input_t * input,
 320                                         va_list * args);
 321 uword
 322 unformat_ethernet_type_net_byte_order (unformat_input_t * input,
 323                                        va_list * args);
 324
 325 /* Parse ethernet header. */
 326 uword unformat_ethernet_header (unformat_input_t * input, va_list * args);
 327
 328 /* Parse ethernet interface name; return hw_if_index. */
 329 uword unformat_ethernet_interface (unformat_input_t * input, va_list * args);
 330
 331 uword unformat_pg_ethernet_header (unformat_input_t * input, va_list * args);
 332
 333 always_inline void
 334 ethernet_setup_node (vlib_main_t * vm, u32 node_index)
 335 {
 336   vlib_node_t *n = vlib_get_node (vm, node_index);
 337   pg_node_t *pn = pg_get_node (node_index);
 338
 339   n->format_buffer = format_ethernet_header_with_length;
 340   n->unformat_buffer = unformat_ethernet_header;
 341   pn->unformat_edit = unformat_pg_ethernet_header;
 342 }
 343
 344 always_inline ethernet_header_t *
 345 ethernet_buffer_get_header (vlib_buffer_t * b)
 346 {
 347   return (void *)
 348     (b->data + vnet_buffer (b)->ethernet.start_of_ethernet_header);
 349 }
 350
 351 /** Returns the number of VLAN headers in the current Ethernet frame in the
 352  * buffer. Returns 0, 1, 2 for the known header count. The value 3 indicates
 353  * the number of headers is not known.
 354  */
 355 #define ethernet_buffer_get_vlan_count(b) ( \
 356     ((b)->flags & ETH_BUFFER_VLAN_BITS) >> LOG2_ETH_BUFFER_VLAN_1_DEEP \
 357 )
 358
 359 /** Sets the number of VLAN headers in the current Ethernet frame in the
 360  * buffer. Values 0, 1, 2 indicate  the header count. The value 3 indicates
 361  * the number of headers is not known.
 362  */
 363 #define ethernet_buffer_set_vlan_count(b, v) ( \
 364     (b)->flags = ((b)->flags & ~ETH_BUFFER_VLAN_BITS) | \
 365         (((v) << LOG2_ETH_BUFFER_VLAN_1_DEEP) & ETH_BUFFER_VLAN_BITS) \
 366 )
 367
 368 /** Adjusts the vlan count by the delta in 'v' */
 369 #define ethernet_buffer_adjust_vlan_count(b, v) ( \
 370   ethernet_buffer_set_vlan_count(b,  \
 371       (word)ethernet_buffer_get_vlan_count(b) + (word)(v)) \
 372 )
 373
 374 /** Adjusts the vlan count by the header size byte delta in 'v' */
 375 #define ethernet_buffer_adjust_vlan_count_by_bytes(b, v) ( \
 376     (b)->flags = ((b)->flags & ~ETH_BUFFER_VLAN_BITS) | (( \
 377         ((b)->flags & ETH_BUFFER_VLAN_BITS) + \
 378         ((v) << (LOG2_ETH_BUFFER_VLAN_1_DEEP - 2)) \
 379     ) & ETH_BUFFER_VLAN_BITS) \
 380 )
 381
 382 /**
 383  * Determine the size of the Ethernet headers of the current frame in
 384  * the buffer. This uses the VLAN depth flags that are set by
 385  * ethernet-input. Because these flags are stored in the vlib_buffer_t
 386  * "flags" field this count is valid regardless of the node so long as it's
 387  * checked downstream of ethernet-input; That is, the value is not stored in
 388  * the opaque space.
 389  */
 390 #define ethernet_buffer_header_size(b) ( \
 391         ethernet_buffer_get_vlan_count((b)) * sizeof(ethernet_vlan_header_t) + \
 392         sizeof(ethernet_header_t) \
 393 )
 394
 395 ethernet_main_t *ethernet_get_main (vlib_main_t * vm);
 396 u32 ethernet_set_flags (vnet_main_t * vnm, u32 hw_if_index, u32 flags);
 397 void ethernet_sw_interface_set_l2_mode (vnet_main_t * vnm, u32 sw_if_index,
 398                                         u32 l2);
 399 void ethernet_sw_interface_set_l2_mode_noport (vnet_main_t * vnm,
 400                                                u32 sw_if_index, u32 l2);
 401 void ethernet_set_rx_redirect (vnet_main_t * vnm, vnet_hw_interface_t * hi,
 402                                u32 enable);
 403
 404 int
 405 vnet_arp_set_ip4_over_ethernet (vnet_main_t * vnm,
 406                                 u32 sw_if_index, void *a_arg,
 407                                 int is_static, int is_no_fib_entry);
 408
 409 int
 410 vnet_arp_unset_ip4_over_ethernet (vnet_main_t * vnm,
 411                                   u32 sw_if_index, void *a_arg);
 412
 413 int vnet_proxy_arp_fib_reset (u32 fib_id);
 414
 415 clib_error_t *next_by_ethertype_init (next_by_ethertype_t * l3_next);
 416 clib_error_t *next_by_ethertype_register (next_by_ethertype_t * l3_next,
 417                                           u32 ethertype, u32 next_index);
 418
 419 int vnet_create_loopback_interface (u32 * sw_if_indexp, u8 * mac_address,
 420                                     u8 is_specified, u32 user_instance);
 421 int vnet_delete_loopback_interface (u32 sw_if_index);
 422 int vnet_delete_sub_interface (u32 sw_if_index);
 423
 424 // Perform ethernet subinterface classification table lookups given
 425 // the ports's sw_if_index and fields extracted from the ethernet header.
 426 // The resulting tables are used by identify_subint().
 427 always_inline void
 428 eth_vlan_table_lookups (ethernet_main_t * em,
 429                         vnet_main_t * vnm,
 430                         u32 port_sw_if_index0,
 431                         u16 first_ethertype,
 432                         u16 outer_id,
 433                         u16 inner_id,
 434                         vnet_hw_interface_t ** hi,
 435                         main_intf_t ** main_intf,
 436                         vlan_intf_t ** vlan_intf, qinq_intf_t ** qinq_intf)
 437 {
 438   vlan_table_t *vlan_table;
 439   qinq_table_t *qinq_table;
 440   u32 vlan_table_id;
 441
 442   // Read the main, vlan, and qinq interface table entries
 443   // TODO: Consider if/how to prefetch tables. Also consider
 444   // single-entry cache to skip table lookups and identify_subint()
 445   // processing.
 446   *hi = vnet_get_sup_hw_interface (vnm, port_sw_if_index0);
 447   *main_intf = vec_elt_at_index (em->main_intfs, (*hi)->hw_if_index);
 448
 449   // Always read the vlan and qinq tables, even if there are not that
 450   // many tags on the packet. This makes the lookups and comparisons
 451   // easier (and less branchy).
 452   vlan_table_id = (first_ethertype == ETHERNET_TYPE_DOT1AD) ?
 453     (*main_intf)->dot1ad_vlans : (*main_intf)->dot1q_vlans;
 454   vlan_table = vec_elt_at_index (em->vlan_pool, vlan_table_id);
 455   *vlan_intf = &vlan_table->vlans[outer_id];
 456
 457   qinq_table = vec_elt_at_index (em->qinq_pool, (*vlan_intf)->qinqs);
 458   *qinq_intf = &qinq_table->vlans[inner_id];
 459 }
 460
 461
 462 // Determine the subinterface for this packet, given the result of the
 463 // vlan table lookups and vlan header parsing. Check the most specific
 464 // matches first.
 465 // Returns 1 if a matching subinterface was found, otherwise returns 0.
 466 always_inline u32
 467 eth_identify_subint (vnet_hw_interface_t * hi,
 468                      vlib_buffer_t * b0,
 469                      u32 match_flags,
 470                      main_intf_t * main_intf,
 471                      vlan_intf_t * vlan_intf,
 472                      qinq_intf_t * qinq_intf,
 473                      u32 * new_sw_if_index, u8 * error0, u32 * is_l2)
 474 {
 475   subint_config_t *subint;
 476
 477   // Each comparison is checking both the valid flag and the number of tags
 478   // (incorporating exact-match/non-exact-match).
 479
 480   // check for specific double tag
 481   subint = &qinq_intf->subint;
 482   if ((subint->flags & match_flags) == match_flags)
 483     goto matched;
 484
 485   // check for specific outer and 'any' inner
 486   subint = &vlan_intf->inner_any_subint;
 487   if ((subint->flags & match_flags) == match_flags)
 488     goto matched;
 489
 490   // check for specific single tag
 491   subint = &vlan_intf->single_tag_subint;
 492   if ((subint->flags & match_flags) == match_flags)
 493     goto matched;
 494
 495   // check for untagged interface
 496   subint = &main_intf->untagged_subint;
 497   if ((subint->flags & match_flags) == match_flags)
 498     goto matched;
 499
 500   // check for default interface
 501   subint = &main_intf->default_subint;
 502   if ((subint->flags & match_flags) == match_flags)
 503     goto matched;
 504
 505   // No matching subinterface
 506   *new_sw_if_index = ~0;
 507   *error0 = ETHERNET_ERROR_UNKNOWN_VLAN;
 508   *is_l2 = 0;
 509   return 0;
 510
 511 matched:
 512   *new_sw_if_index = subint->sw_if_index;
 513   *is_l2 = subint->flags & SUBINT_CONFIG_L2;
 514   return 1;
 515 }
 516
 517 // Compare two ethernet macs. Return 1 if they are the same, 0 if different
 518 always_inline u32
 519 eth_mac_equal (u8 * mac1, u8 * mac2)
 520 {
 521   return (*((u32 *) (mac1 + 0)) == *((u32 *) (mac2 + 0)) &&
 522           *((u32 *) (mac1 + 2)) == *((u32 *) (mac2 + 2)));
 523 }
 524
 525
 526 always_inline ethernet_main_t *
 527 vnet_get_ethernet_main (void)
 528 {
 529   return &ethernet_main;
 530 }
 531
 532 void vnet_register_ip4_arp_resolution_event (vnet_main_t * vnm,
 533                                              void *address_arg,
 534                                              uword node_index,
 535                                              uword type_opaque, uword data);
 536
 537
 538 int vnet_add_del_ip4_arp_change_event (vnet_main_t * vnm,
 539                                        void *data_callback,
 540                                        u32 pid,
 541                                        void *address_arg,
 542                                        uword node_index,
 543                                        uword type_opaque,
 544                                        uword data, int is_add);
 545
 546 void ethernet_arp_change_mac (u32 sw_if_index);
 547 void ethernet_ndp_change_mac (u32 sw_if_index);
 548
 549 void arp_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, u32 ai);
 550
 551 void ethernet_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, u32 ai);
 552 u8 *ethernet_build_rewrite (vnet_main_t * vnm,
 553                             u32 sw_if_index,
 554                             vnet_link_t link_type, const void *dst_address);
 555 const u8 *ethernet_ip4_mcast_dst_addr (void);
 556 const u8 *ethernet_ip6_mcast_dst_addr (void);
 557
 558 extern vlib_node_registration_t ethernet_input_node;
 559
 560 #endif /* included_ethernet_h */
 561
 562 /*
 563  * fd.io coding-style-patch-verification: ON
 564  *
 565  * Local Variables:
 566  * eval: (c-set-style "gnu")
 567  * End:
 568  */