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