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