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