src/vnet/l2/l2_input.h

   1 /*
   2  * l2_input.h : layer 2 input packet processing
   3  *
   4  * Copyright (c) 2013 Cisco and/or its affiliates.
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #ifndef included_vnet_l2_input_h
  19 #define included_vnet_l2_input_h
  20
  21 #include <stdbool.h>
  22
  23 #include <vlib/vlib.h>
  24 #include <vnet/vnet.h>
  25 #include <vnet/l2/l2_bd.h>
  26 #include <vnet/ethernet/ethernet.h>
  27 #include <vnet/ethernet/packet.h>
  28 #include <vnet/ip/ip4_inlines.h>
  29 #include <vnet/ip/ip6_inlines.h>
  30 #include <vnet/mpls/mpls_lookup.h>
  31
  32 /* l2 connection type */
  33 typedef enum l2_input_flags_t_
  34 {
  35   /* NONE imples L3 mode. */
  36   L2_INPUT_FLAG_NONE = 0,
  37   L2_INPUT_FLAG_XCONNECT = (1 << 0),
  38   L2_INPUT_FLAG_BRIDGE = (1 << 1),
  39   L2_INPUT_FLAG_BVI = (1 << 2),
  40 } __clib_packed l2_input_flags_t;
  41
  42 /* Per-subinterface L2 feature configuration */
  43 typedef struct
  44 {
  45   u8 __force_u64_alignement[0] __attribute__ ((aligned (8)));
  46
  47   union
  48   {
  49     /* bridge domain id and values cached from the BD */
  50     struct
  51     {
  52       u16 bd_index;
  53       u8 bd_seq_num;
  54       u8 bd_mac_age;
  55     };
  56     /* for xconnect */
  57     u32 output_sw_if_index;
  58   };
  59
  60   /* config for which input features are configured on this interface */
  61   u32 feature_bitmap;
  62
  63   /* config for which input features are configured on this interface's
  64    * BD - this is cahced from the BD struct*/
  65   u32 bd_feature_bitmap;
  66
  67   /* split horizon group */
  68   u8 shg;
  69
  70   /* Interface sequence number */
  71   u8 seq_num;
  72
  73   /* Flags describing this interface */
  74   l2_input_flags_t flags;
  75
  76   /* A wee bit of spare space */
  77   u8 __pad;
  78 } l2_input_config_t;
  79
  80 /* Ensure a struct is an even multiple of 8 bytes,
  81  * so they do not stradle cache lines */
  82 STATIC_ASSERT_SIZEOF (l2_input_config_t, 2 * sizeof (u64));
  83
  84 typedef struct
  85 {
  86
  87   /* Next nodes for the feature bitmap */
  88   u32 feat_next_node_index[32];
  89
  90   /* config vector indexed by sw_if_index */
  91   l2_input_config_t *configs;
  92
  93   /* bridge domain config vector indexed by bd_index */
  94   l2_bridge_domain_t *bd_configs;
  95
  96   /* convenience variables */
  97   vlib_main_t *vlib_main;
  98   vnet_main_t *vnet_main;
  99
 100   u16 msg_id_base;
 101 } l2input_main_t;
 102
 103 extern l2input_main_t l2input_main;
 104
 105 extern vlib_node_registration_t l2input_node;
 106
 107 static_always_inline l2_bridge_domain_t *
 108 l2input_bd_config_from_index (l2input_main_t * l2im, u32 bd_index)
 109 {
 110   l2_bridge_domain_t *bd_config;
 111
 112   bd_config = vec_elt_at_index (l2im->bd_configs, bd_index);
 113   return bd_is_valid (bd_config) ? bd_config : NULL;
 114 }
 115
 116 static_always_inline l2_bridge_domain_t *
 117 l2input_bd_config (u32 bd_index)
 118 {
 119   l2input_main_t *mp = &l2input_main;
 120   l2_bridge_domain_t *bd_config;
 121
 122   vec_validate (mp->bd_configs, bd_index);
 123   bd_config = vec_elt_at_index (mp->bd_configs, bd_index);
 124   return bd_config;
 125 }
 126
 127 /* L2 input indication packet is from BVI, using -2 */
 128 #define L2INPUT_BVI ((u32) (~0-1))
 129
 130 /* L2 input features */
 131
 132 /* Mappings from feature ID to graph node name in reverse order */
 133 #define foreach_l2input_feat                    \
 134  _(DROP,          "feature-bitmap-drop")        \
 135  _(XCONNECT,      "l2-output")                  \
 136  _(FLOOD,         "l2-flood")                   \
 137  _(ARP_UFWD,      "l2-uu-fwd")                  \
 138  _(ARP_TERM,      "arp-term-l2bd")              \
 139  _(UU_FLOOD,      "l2-flood")                   \
 140  _(UU_FWD,        "l2-uu-fwd")                  \
 141  _(FWD,           "l2-fwd")                     \
 142  _(RW,            "l2-rw")                      \
 143  _(LEARN,         "l2-learn")                   \
 144  _(VTR,           "l2-input-vtr")               \
 145  _(L2_IP_QOS_RECORD, "l2-ip-qos-record")        \
 146  _(VPATH,         "vpath-input-l2")             \
 147  _(ACL,           "l2-input-acl")               \
 148  _(POLICER_CLAS,  "l2-policer-classify")        \
 149  _(INPUT_FEAT_ARC, "l2-input-feat-arc")         \
 150  _(INPUT_CLASSIFY, "l2-input-classify")         \
 151  _(SPAN,          "span-l2-input")
 152
 153 /* Feature bitmap positions */
 154 typedef enum
 155 {
 156 #define _(sym,str) L2INPUT_FEAT_##sym##_BIT,
 157   foreach_l2input_feat
 158 #undef _
 159   L2INPUT_N_FEAT
 160 } l2input_feat_t;
 161
 162 STATIC_ASSERT (L2INPUT_N_FEAT <= 32, "too many l2 input features");
 163
 164 /* Feature bit masks */
 165 typedef enum
 166 {
 167   L2INPUT_FEAT_NONE = 0,
 168 #define _(sym,str) L2INPUT_FEAT_##sym = (1<<L2INPUT_FEAT_##sym##_BIT),
 169   foreach_l2input_feat
 170 #undef _
 171     L2INPUT_VALID_MASK =
 172 #define _(sym,str) L2INPUT_FEAT_##sym |
 173     foreach_l2input_feat
 174 #undef _
 175   0
 176 } l2input_feat_masks_t;
 177
 178 STATIC_ASSERT ((u64) L2INPUT_VALID_MASK == (1ull << L2INPUT_N_FEAT) - 1, "");
 179
 180 /** Return an array of strings containing graph node names of each feature */
 181 char **l2input_get_feat_names (void);
 182
 183 /* arg0 - u32 feature_bitmap, arg1 - u32 verbose */
 184 u8 *format_l2_input_feature_bitmap (u8 * s, va_list * args);
 185 u8 *format_l2_input_features (u8 * s, va_list * args);
 186 u8 *format_l2_input (u8 * s, va_list * args);
 187
 188 static_always_inline u8
 189 bd_feature_flood (l2_bridge_domain_t * bd_config)
 190 {
 191   return ((bd_config->feature_bitmap & L2INPUT_FEAT_FLOOD) ==
 192           L2INPUT_FEAT_FLOOD);
 193 }
 194
 195 static_always_inline u8
 196 bd_feature_uu_flood (l2_bridge_domain_t * bd_config)
 197 {
 198   return ((bd_config->feature_bitmap & L2INPUT_FEAT_UU_FLOOD) ==
 199           L2INPUT_FEAT_UU_FLOOD);
 200 }
 201
 202 static_always_inline u8
 203 bd_feature_forward (l2_bridge_domain_t * bd_config)
 204 {
 205   return ((bd_config->feature_bitmap & L2INPUT_FEAT_FWD) == L2INPUT_FEAT_FWD);
 206 }
 207
 208 static_always_inline u8
 209 bd_feature_learn (l2_bridge_domain_t * bd_config)
 210 {
 211   return ((bd_config->feature_bitmap & L2INPUT_FEAT_LEARN) ==
 212           L2INPUT_FEAT_LEARN);
 213 }
 214
 215 static_always_inline u8
 216 bd_feature_arp_term (l2_bridge_domain_t * bd_config)
 217 {
 218   return ((bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM) ==
 219           L2INPUT_FEAT_ARP_TERM);
 220 }
 221
 222 static_always_inline u8
 223 bd_feature_arp_ufwd (l2_bridge_domain_t * bd_config)
 224 {
 225   return ((bd_config->feature_bitmap & L2INPUT_FEAT_ARP_UFWD) ==
 226           L2INPUT_FEAT_ARP_UFWD);
 227 }
 228
 229 static inline bool
 230 l2_input_is_bridge (const l2_input_config_t * input)
 231 {
 232   return (input->flags & L2_INPUT_FLAG_BRIDGE);
 233 }
 234
 235 static inline bool
 236 l2_input_is_xconnect (const l2_input_config_t * input)
 237 {
 238   return (input->flags & L2_INPUT_FLAG_XCONNECT);
 239 }
 240
 241 static inline bool
 242 l2_input_is_bvi (const l2_input_config_t * input)
 243 {
 244   return (input->flags & L2_INPUT_FLAG_BVI);
 245 }
 246
 247 static_always_inline u8
 248 l2_input_seq_num (u32 sw_if_index)
 249 {
 250   l2_input_config_t *input;
 251
 252   input = vec_elt_at_index (l2input_main.configs, sw_if_index);
 253
 254   return input->seq_num;
 255 }
 256
 257
 258 /** Masks for eliminating features that do not apply to a packet */
 259
 260 /** Get a pointer to the config for the given interface */
 261 l2_input_config_t *l2input_intf_config (u32 sw_if_index);
 262
 263 /* Enable (or disable) the feature in the bitmap for the given interface */
 264 u32 l2input_intf_bitmap_enable (u32 sw_if_index,
 265                                 l2input_feat_masks_t feature_bitmap,
 266                                 u32 enable);
 267
 268 /* Sets modifies flags from a bridge domain */
 269 u32 l2input_set_bridge_features (u32 bd_index, u32 feat_mask, u32 feat_value);
 270
 271 void l2input_interface_mac_change (u32 sw_if_index,
 272                                    const u8 * old_address,
 273                                    const u8 * new_address);
 274
 275 void l2_input_seq_num_inc (u32 sw_if_index);
 276 walk_rc_t l2input_recache (u32 bd_index, u32 sw_if_index);
 277
 278 #define MODE_L3        0
 279 #define MODE_L2_BRIDGE 1
 280 #define MODE_L2_XC     2
 281 #define MODE_L2_CLASSIFY 3
 282
 283 #define MODE_ERROR_ETH        1
 284 #define MODE_ERROR_BVI_DEF    2
 285
 286 u32 set_int_l2_mode (vlib_main_t * vm,
 287                      vnet_main_t * vnet_main,
 288                      u32 mode,
 289                      u32 sw_if_index,
 290                      u32 bd_index, l2_bd_port_type_t port_type,
 291                      u32 shg, u32 xc_sw_if_index);
 292
 293 static inline u16
 294 vnet_update_l2_len (vlib_buffer_t *b)
 295 {
 296   ethernet_header_t *eth;
 297   u16 ethertype;
 298   u8 vlan_count = 0;
 299
 300   /* point at current l2 hdr */
 301   eth = vlib_buffer_get_current (b);
 302
 303   /*
 304    * l2-output pays no attention to this
 305    * but the tag push/pop code on an l2 subif needs it.
 306    *
 307    * Determine l2 header len, check for up to 2 vlans
 308    */
 309   vnet_buffer (b)->l2.l2_len = sizeof (ethernet_header_t);
 310   ethertype = clib_net_to_host_u16 (eth->type);
 311   if (ethernet_frame_is_tagged (ethertype))
 312     {
 313       ethernet_vlan_header_t *vlan;
 314       vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
 315       vlan_count = 1;
 316       vlan = (void *) (eth + 1);
 317       ethertype = clib_net_to_host_u16 (vlan->type);
 318       if (ethertype == ETHERNET_TYPE_VLAN)
 319         {
 320           vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
 321           vlan_count = 2;
 322         }
 323     }
 324   ethernet_buffer_set_vlan_count (b, vlan_count);
 325
 326   return (ethertype);
 327 }
 328
 329 /*
 330  * Compute flow hash of an ethernet packet, use 5-tuple hash if L3 packet
 331  * is ip4, ip6, or mpls. Otherwise hash on smac/dmac/etype.
 332  * The vlib buffer current pointer is expected to be at ethernet header
 333  * and vnet l2.l2_len is expected to be setup already.
 334  */
 335 static inline u32
 336 vnet_l2_compute_flow_hash (vlib_buffer_t * b)
 337 {
 338   ethernet_header_t *eh = vlib_buffer_get_current (b);
 339   u8 *l3h = (u8 *) eh + vnet_buffer (b)->l2.l2_len;
 340   u16 ethertype = clib_net_to_host_u16 (*(u16 *) (l3h - 2));
 341
 342   if (ethertype == ETHERNET_TYPE_IP4)
 343     return ip4_compute_flow_hash ((ip4_header_t *) l3h, IP_FLOW_HASH_DEFAULT);
 344   else if (ethertype == ETHERNET_TYPE_IP6)
 345     return ip6_compute_flow_hash ((ip6_header_t *) l3h, IP_FLOW_HASH_DEFAULT);
 346   else if (ethertype == ETHERNET_TYPE_MPLS)
 347     return mpls_compute_flow_hash ((mpls_unicast_header_t *) l3h,
 348                                    IP_FLOW_HASH_DEFAULT);
 349   else
 350     {
 351       u32 a, b, c;
 352       u32 *ap = (u32 *) & eh->dst_address[2];
 353       u32 *bp = (u32 *) & eh->src_address[2];
 354       a = *ap;
 355       b = *bp;
 356       c = ethertype;
 357       hash_v3_mix32 (a, b, c);
 358       hash_v3_finalize32 (a, b, c);
 359       return c;
 360     }
 361 }
 362
 363 #endif
 364
 365
 366 /*
 367  * fd.io coding-style-patch-verification: ON
 368  *
 369  * Local Variables:
 370  * eval: (c-set-style "gnu")
 371  * End:
 372  */