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/packet.h>
  25 #include <vnet/ip/ip.h>
  26
  27 /* Per-subinterface L2 feature configuration */
  28
  29 typedef struct
  30 {
  31
  32   union
  33   {
  34     u16 bd_index;               /* bridge domain id */
  35     u32 output_sw_if_index;     /* for xconnect */
  36   };
  37
  38   /* Interface mode. If both are 0, this interface is in L3 mode */
  39   u8 xconnect;
  40   u8 bridge;
  41
  42   /* this is the bvi interface for the bridge-domain */
  43   u8 bvi;
  44
  45   /* config for which input features are configured on this interface */
  46   u32 feature_bitmap;
  47
  48   /* some of these flags are also in the feature bitmap */
  49   u8 learn_enable;
  50   u8 fwd_enable;
  51   u8 flood_enable;
  52
  53   /* split horizon group */
  54   u8 shg;
  55
  56   /* sequence number for interface based flush of MACs */
  57   u8 seq_num;
  58
  59 } l2_input_config_t;
  60
  61
  62 typedef struct
  63 {
  64
  65   /* Next nodes for the feature bitmap */
  66   u32 feat_next_node_index[32];
  67
  68   /* config vector indexed by sw_if_index */
  69   l2_input_config_t *configs;
  70
  71   /* bridge domain config vector indexed by bd_index */
  72   l2_bridge_domain_t *bd_configs;
  73
  74   /* convenience variables */
  75   vlib_main_t *vlib_main;
  76   vnet_main_t *vnet_main;
  77 } l2input_main_t;
  78
  79 extern l2input_main_t l2input_main;
  80
  81 extern vlib_node_registration_t l2input_node;
  82
  83 static_always_inline l2_bridge_domain_t *
  84 l2input_bd_config_from_index (l2input_main_t * l2im, u32 bd_index)
  85 {
  86   l2_bridge_domain_t *bd_config;
  87
  88   bd_config = vec_elt_at_index (l2im->bd_configs, bd_index);
  89   return bd_is_valid (bd_config) ? bd_config : NULL;
  90 }
  91
  92 static_always_inline l2_bridge_domain_t *
  93 l2input_bd_config (u32 bd_index)
  94 {
  95   l2input_main_t *mp = &l2input_main;
  96   l2_bridge_domain_t *bd_config;
  97
  98   vec_validate (mp->bd_configs, bd_index);
  99   bd_config = vec_elt_at_index (mp->bd_configs, bd_index);
 100   return bd_config;
 101 }
 102
 103 /* L2 input indication packet is from BVI, using -2 */
 104 #define L2INPUT_BVI ((u32) (~0-1))
 105
 106 /* L2 input features */
 107
 108 /* Mappings from feature ID to graph node name */
 109 #define foreach_l2input_feat                    \
 110  _(DROP,          "feature-bitmap-drop")        \
 111  _(XCONNECT,      "l2-output")                  \
 112  _(FLOOD,         "l2-flood")                   \
 113  _(ARP_TERM,      "arp-term-l2bd")              \
 114  _(UU_FLOOD,      "l2-flood")                   \
 115  _(FWD,           "l2-fwd")                     \
 116  _(RW,            "l2-rw")                      \
 117  _(LEARN,         "l2-learn")                   \
 118  _(VTR,           "l2-input-vtr")               \
 119  _(VPATH,         "vpath-input-l2")             \
 120  _(ACL,           "l2-input-acl")               \
 121  _(POLICER_CLAS,  "l2-policer-classify")        \
 122  _(INPUT_CLASSIFY, "l2-input-classify")
 123
 124 /* Feature bitmap positions */
 125 typedef enum
 126 {
 127 #define _(sym,str) L2INPUT_FEAT_##sym##_BIT,
 128   foreach_l2input_feat
 129 #undef _
 130     L2INPUT_N_FEAT,
 131   L2INPUT_VALID_MASK =
 132 #define _(sym,str) L2INPUT_FEAT_##sym##_BIT |
 133     foreach_l2input_feat
 134 #undef _
 135     0,
 136 } l2input_feat_t;
 137
 138 /* Feature bit masks */
 139 typedef enum
 140 {
 141 #define _(sym,str) L2INPUT_FEAT_##sym = (1<<L2INPUT_FEAT_##sym##_BIT),
 142   foreach_l2input_feat
 143 #undef _
 144 } l2input_feat_masks_t;
 145
 146 /** Return an array of strings containing graph node names of each feature */
 147 char **l2input_get_feat_names (void);
 148
 149
 150 static_always_inline u8
 151 bd_feature_flood (l2_bridge_domain_t * bd_config)
 152 {
 153   return ((bd_config->feature_bitmap & L2INPUT_FEAT_FLOOD) ==
 154           L2INPUT_FEAT_FLOOD);
 155 }
 156
 157 static_always_inline u8
 158 bd_feature_uu_flood (l2_bridge_domain_t * bd_config)
 159 {
 160   return ((bd_config->feature_bitmap & L2INPUT_FEAT_UU_FLOOD) ==
 161           L2INPUT_FEAT_UU_FLOOD);
 162 }
 163
 164 static_always_inline u8
 165 bd_feature_forward (l2_bridge_domain_t * bd_config)
 166 {
 167   return ((bd_config->feature_bitmap & L2INPUT_FEAT_FWD) == L2INPUT_FEAT_FWD);
 168 }
 169
 170 static_always_inline u8
 171 bd_feature_learn (l2_bridge_domain_t * bd_config)
 172 {
 173   return ((bd_config->feature_bitmap & L2INPUT_FEAT_LEARN) ==
 174           L2INPUT_FEAT_LEARN);
 175 }
 176
 177 static_always_inline u8
 178 bd_feature_arp_term (l2_bridge_domain_t * bd_config)
 179 {
 180   return ((bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM) ==
 181           L2INPUT_FEAT_ARP_TERM);
 182 }
 183
 184 /** Masks for eliminating features that do not apply to a packet */
 185
 186 /** Get a pointer to the config for the given interface */
 187 l2_input_config_t *l2input_intf_config (u32 sw_if_index);
 188
 189 /* Enable (or disable) the feature in the bitmap for the given interface */
 190 u32 l2input_intf_bitmap_enable (u32 sw_if_index,
 191                                 u32 feature_bitmap, u32 enable);
 192
 193 /* Sets modifies flags from a bridge domain */
 194 u32 l2input_set_bridge_features (u32 bd_index, u32 feat_mask, u32 feat_value);
 195
 196
 197 #define MODE_L3        0
 198 #define MODE_L2_BRIDGE 1
 199 #define MODE_L2_XC     2
 200 #define MODE_L2_CLASSIFY 3
 201
 202 #define MODE_ERROR_ETH        1
 203 #define MODE_ERROR_BVI_DEF    2
 204
 205 u32 set_int_l2_mode (vlib_main_t * vm,
 206                      vnet_main_t * vnet_main,
 207                      u32 mode,
 208                      u32 sw_if_index,
 209                      u32 bd_index, u32 bvi, u32 shg, u32 xc_sw_if_index);
 210
 211 static inline void
 212 vnet_update_l2_len (vlib_buffer_t * b)
 213 {
 214   ethernet_header_t *eth;
 215   u16 ethertype;
 216   u8 vlan_count = 0;
 217
 218   /* point at currrent l2 hdr */
 219   eth = vlib_buffer_get_current (b);
 220
 221   /*
 222    * l2-output pays no attention to this
 223    * but the tag push/pop code on an l2 subif needs it.
 224    *
 225    * Determine l2 header len, check for up to 2 vlans
 226    */
 227   vnet_buffer (b)->l2.l2_len = sizeof (ethernet_header_t);
 228   ethertype = clib_net_to_host_u16 (eth->type);
 229   if (ethernet_frame_is_tagged (ethertype))
 230     {
 231       ethernet_vlan_header_t *vlan;
 232       vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
 233       vlan_count = 1;
 234       vlan = (void *) (eth + 1);
 235       ethertype = clib_net_to_host_u16 (vlan->type);
 236       if (ethertype == ETHERNET_TYPE_VLAN)
 237         {
 238           vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
 239           vlan_count = 2;
 240         }
 241     }
 242   ethernet_buffer_set_vlan_count (b, vlan_count);
 243 }
 244
 245 /*
 246  * Compute flow hash of an ethernet packet, use 5-tuple hash if L3 packet
 247  * is ip4 or ip6. Otherwise hash on smac/dmac/etype.
 248  * The vlib buffer current pointer is expected to be at ethernet header
 249  * and vnet l2.l2_len is exppected to be setup already.
 250  */
 251 static inline u32
 252 vnet_l2_compute_flow_hash (vlib_buffer_t * b)
 253 {
 254   ethernet_header_t *eh = vlib_buffer_get_current (b);
 255   u8 *l3h = (u8 *) eh + vnet_buffer (b)->l2.l2_len;
 256   u16 ethertype = clib_net_to_host_u16 (*(u16 *) (l3h - 2));
 257
 258   if (ethertype == ETHERNET_TYPE_IP4)
 259     return ip4_compute_flow_hash ((ip4_header_t *) l3h, IP_FLOW_HASH_DEFAULT);
 260   else if (ethertype == ETHERNET_TYPE_IP6)
 261     return ip6_compute_flow_hash ((ip6_header_t *) l3h, IP_FLOW_HASH_DEFAULT);
 262   else
 263     {
 264       u32 a, b, c;
 265       u32 *ap = (u32 *) & eh->dst_address[2];
 266       u32 *bp = (u32 *) & eh->src_address[2];
 267       a = *ap;
 268       b = *bp;
 269       c = ethertype;
 270       hash_v3_mix32 (a, b, c);
 271       hash_v3_finalize32 (a, b, c);
 272       return c;
 273     }
 274 }
 275
 276 #endif
 277
 278
 279 /*
 280  * fd.io coding-style-patch-verification: ON
 281  *
 282  * Local Variables:
 283  * eval: (c-set-style "gnu")
 284  * End:
 285  */