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