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