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