FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
l2_input.h
Go to the documentation of this file.
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 /* Per-subinterface L2 feature configuration */
29 
30 typedef struct
31 {
32 
33  union
34  {
35  u16 bd_index; /* bridge domain id */
36  u32 output_sw_if_index; /* for xconnect */
37  };
38 
39  /* config for which input features are configured on this interface */
41 
42  /* split horizon group */
44 
45  /* Interface mode. If both are 0, this interface is in L3 mode */
48 
49  /* this is the bvi interface for the bridge-domain */
51 
53 
54 
55 typedef struct
56 {
57 
58  /* Next nodes for the feature bitmap */
59  u32 feat_next_node_index[32];
60 
61  /* config vector indexed by sw_if_index */
63 
64  /* bridge domain config vector indexed by bd_index */
66 
67  /* convenience variables */
71 
73 
75 
78 {
79  l2_bridge_domain_t *bd_config;
80 
81  bd_config = vec_elt_at_index (l2im->bd_configs, bd_index);
82  return bd_is_valid (bd_config) ? bd_config : NULL;
83 }
84 
87 {
89  l2_bridge_domain_t *bd_config;
90 
91  vec_validate (mp->bd_configs, bd_index);
92  bd_config = vec_elt_at_index (mp->bd_configs, bd_index);
93  return bd_config;
94 }
95 
96 /* L2 input indication packet is from BVI, using -2 */
97 #define L2INPUT_BVI ((u32) (~0-1))
98 
99 /* L2 input features */
100 
101 /* Mappings from feature ID to graph node name in reverse order */
102 #define foreach_l2input_feat \
103  _(DROP, "feature-bitmap-drop") \
104  _(XCONNECT, "l2-output") \
105  _(FLOOD, "l2-flood") \
106  _(ARP_UFWD, "l2-uu-fwd") \
107  _(ARP_TERM, "arp-term-l2bd") \
108  _(UU_FLOOD, "l2-flood") \
109  _(GBP_FWD, "gbp-fwd") \
110  _(UU_FWD, "l2-uu-fwd") \
111  _(FWD, "l2-fwd") \
112  _(RW, "l2-rw") \
113  _(LEARN, "l2-learn") \
114  _(L2_EMULATION, "l2-emulation") \
115  _(GBP_LEARN, "gbp-learn-l2") \
116  _(GBP_LPM_ANON_CLASSIFY, "l2-gbp-lpm-anon-classify") \
117  _(GBP_NULL_CLASSIFY, "gbp-null-classify") \
118  _(GBP_SRC_CLASSIFY, "gbp-src-classify") \
119  _(GBP_LPM_CLASSIFY, "l2-gbp-lpm-classify") \
120  _(VTR, "l2-input-vtr") \
121  _(L2_IP_QOS_RECORD, "l2-ip-qos-record") \
122  _(VPATH, "vpath-input-l2") \
123  _(ACL, "l2-input-acl") \
124  _(POLICER_CLAS, "l2-policer-classify") \
125  _(INPUT_FEAT_ARC, "l2-input-feat-arc") \
126  _(INPUT_CLASSIFY, "l2-input-classify") \
127  _(SPAN, "span-l2-input")
128 
129 /* Feature bitmap positions */
130 typedef enum
131 {
132 #define _(sym,str) L2INPUT_FEAT_##sym##_BIT,
134 #undef _
137 
138 STATIC_ASSERT (L2INPUT_N_FEAT <= 32, "too many l2 input features");
139 
140 /* Feature bit masks */
141 typedef enum
142 {
144 #define _(sym,str) L2INPUT_FEAT_##sym = (1<<L2INPUT_FEAT_##sym##_BIT),
146 #undef _
148 #define _(sym,str) L2INPUT_FEAT_##sym |
150 #undef _
151  0
153 
154 STATIC_ASSERT ((u64) L2INPUT_VALID_MASK == (1ull << L2INPUT_N_FEAT) - 1, "");
155 
156 /** Return an array of strings containing graph node names of each feature */
157 char **l2input_get_feat_names (void);
158 
159 /* arg0 - u32 feature_bitmap, arg1 - u32 verbose */
160 u8 *format_l2_input_features (u8 * s, va_list * args);
161 
164 {
165  return ((bd_config->feature_bitmap & L2INPUT_FEAT_FLOOD) ==
166  L2INPUT_FEAT_FLOOD);
167 }
168 
171 {
172  return ((bd_config->feature_bitmap & L2INPUT_FEAT_UU_FLOOD) ==
173  L2INPUT_FEAT_UU_FLOOD);
174 }
175 
178 {
179  return ((bd_config->feature_bitmap & L2INPUT_FEAT_FWD) == L2INPUT_FEAT_FWD);
180 }
181 
184 {
185  return ((bd_config->feature_bitmap & L2INPUT_FEAT_LEARN) ==
186  L2INPUT_FEAT_LEARN);
187 }
188 
191 {
192  return ((bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM) ==
193  L2INPUT_FEAT_ARP_TERM);
194 }
195 
198 {
199  return ((bd_config->feature_bitmap & L2INPUT_FEAT_ARP_UFWD) ==
200  L2INPUT_FEAT_ARP_UFWD);
201 }
202 
203 /** Masks for eliminating features that do not apply to a packet */
204 
205 /** Get a pointer to the config for the given interface */
207 
208 /* Enable (or disable) the feature in the bitmap for the given interface */
209 u32 l2input_intf_bitmap_enable (u32 sw_if_index,
210  l2input_feat_masks_t feature_bitmap,
211  u32 enable);
212 
213 /* Sets modifies flags from a bridge domain */
214 u32 l2input_set_bridge_features (u32 bd_index, u32 feat_mask, u32 feat_value);
215 
216 void l2input_interface_mac_change (u32 sw_if_index,
217  const u8 * old_address,
218  const u8 * new_address);
219 
220 #define MODE_L3 0
221 #define MODE_L2_BRIDGE 1
222 #define MODE_L2_XC 2
223 #define MODE_L2_CLASSIFY 3
224 
225 #define MODE_ERROR_ETH 1
226 #define MODE_ERROR_BVI_DEF 2
227 
230  u32 mode,
231  u32 sw_if_index,
232  u32 bd_index, l2_bd_port_type_t port_type,
233  u32 shg, u32 xc_sw_if_index);
234 
235 static inline void
237 {
238  ethernet_header_t *eth;
239  u16 ethertype;
240  u8 vlan_count = 0;
241 
242  /* point at current l2 hdr */
243  eth = vlib_buffer_get_current (b);
244 
245  /*
246  * l2-output pays no attention to this
247  * but the tag push/pop code on an l2 subif needs it.
248  *
249  * Determine l2 header len, check for up to 2 vlans
250  */
251  vnet_buffer (b)->l2.l2_len = sizeof (ethernet_header_t);
252  ethertype = clib_net_to_host_u16 (eth->type);
253  if (ethernet_frame_is_tagged (ethertype))
254  {
256  vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
257  vlan_count = 1;
258  vlan = (void *) (eth + 1);
259  ethertype = clib_net_to_host_u16 (vlan->type);
260  if (ethertype == ETHERNET_TYPE_VLAN)
261  {
262  vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
263  vlan_count = 2;
264  }
265  }
266  ethernet_buffer_set_vlan_count (b, vlan_count);
267 }
268 
269 /*
270  * Compute flow hash of an ethernet packet, use 5-tuple hash if L3 packet
271  * is ip4 or ip6. Otherwise hash on smac/dmac/etype.
272  * The vlib buffer current pointer is expected to be at ethernet header
273  * and vnet l2.l2_len is expected to be setup already.
274  */
275 static inline u32
277 {
279  u8 *l3h = (u8 *) eh + vnet_buffer (b)->l2.l2_len;
280  u16 ethertype = clib_net_to_host_u16 (*(u16 *) (l3h - 2));
281 
282  if (ethertype == ETHERNET_TYPE_IP4)
284  else if (ethertype == ETHERNET_TYPE_IP6)
286  else
287  {
288  u32 a, b, c;
289  u32 *ap = (u32 *) & eh->dst_address[2];
290  u32 *bp = (u32 *) & eh->src_address[2];
291  a = *ap;
292  b = *bp;
293  c = ethertype;
294  hash_v3_mix32 (a, b, c);
295  hash_v3_finalize32 (a, b, c);
296  return c;
297  }
298 }
299 
300 #endif
301 
302 
303 /*
304  * fd.io coding-style-patch-verification: ON
305  *
306  * Local Variables:
307  * eval: (c-set-style "gnu")
308  * End:
309  */
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:509
static_always_inline u8 bd_feature_forward(l2_bridge_domain_t *bd_config)
Definition: l2_input.h:177
l2_input_config_t * configs
Definition: l2_input.h:62
a
Definition: bitmap.h:538
unsigned long u64
Definition: types.h:89
static u32 ip4_compute_flow_hash(const ip4_header_t *ip, flow_hash_config_t flow_hash_config)
Definition: ip4.h:310
u32 l2input_intf_bitmap_enable(u32 sw_if_index, l2input_feat_masks_t feature_bitmap, u32 enable)
Enable (or disable) the feature in the bitmap for the given interface.
Definition: l2_input.c:527
u8 src_address[6]
Definition: packet.h:56
vlib_main_t * vm
Definition: in2out_ed.c:1582
static_always_inline u8 bd_feature_uu_flood(l2_bridge_domain_t *bd_config)
Definition: l2_input.h:170
u8 * format_l2_input_features(u8 *s, va_list *args)
Definition: l2_input.c:68
#define hash_v3_mix32(a, b, c)
Definition: hash.h:554
unsigned char u8
Definition: types.h:56
static_always_inline u8 bd_feature_arp_ufwd(l2_bridge_domain_t *bd_config)
Definition: l2_input.h:197
#define static_always_inline
Definition: clib.h:108
u32 output_sw_if_index
Definition: l2_input.h:36
u8 dst_address[6]
Definition: packet.h:55
u8 shg
Definition: l2.api:303
u32 l2input_set_bridge_features(u32 bd_index, u32 feat_mask, u32 feat_value)
Definition: l2_input.c:541
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
static_always_inline u8 bd_feature_arp_term(l2_bridge_domain_t *bd_config)
Definition: l2_input.h:190
l2_input_config_t * l2input_intf_config(u32 sw_if_index)
Masks for eliminating features that do not apply to a packet.
Definition: l2_input.c:517
unsigned int u32
Definition: types.h:88
l2input_main_t l2input_main
l2input_feat_t
Definition: l2_input.h:130
static_always_inline u8 bd_feature_flood(l2_bridge_domain_t *bd_config)
Definition: l2_input.h:163
char ** l2input_get_feat_names(void)
Return an array of strings containing graph node names of each feature.
Definition: l2_input.c:62
vnet_main_t * vnet_main
Definition: l2_input.h:69
STATIC_ASSERT(L2INPUT_N_FEAT<=32, "too many l2 input features")
unsigned short u16
Definition: types.h:57
static u32 vnet_l2_compute_flow_hash(vlib_buffer_t *b)
Definition: l2_input.h:276
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:229
static u32 ip6_compute_flow_hash(const ip6_header_t *ip, flow_hash_config_t flow_hash_config)
Definition: ip6.h:382
enum l2_bd_port_type_t_ l2_bd_port_type_t
vnet_main_t vnet_main
Definition: misc.c:43
u32 set_int_l2_mode(vlib_main_t *vm, vnet_main_t *vnet_main, u32 mode, u32 sw_if_index, u32 bd_index, l2_bd_port_type_t port_type, u32 shg, u32 xc_sw_if_index)
Set the subinterface to run in l2 or l3 mode.
Definition: l2_input.c:580
#define ethernet_buffer_set_vlan_count(b, v)
Sets the number of VLAN headers in the current Ethernet frame in the buffer.
Definition: ethernet.h:425
l2input_feat_masks_t
Definition: l2_input.h:141
vl_api_tunnel_mode_t mode
Definition: gre.api:48
static u32 bd_is_valid(l2_bridge_domain_t *bd_config)
Definition: l2_bd.h:134
svmdb_client_t * c
vlib_node_registration_t l2input_node
(constructor) VLIB_REGISTER_NODE (l2input_node)
Definition: l2_input.c:465
void l2input_interface_mac_change(u32 sw_if_index, const u8 *old_address, const u8 *new_address)
Definition: l2_input.c:551
static_always_inline u8 bd_feature_learn(l2_bridge_domain_t *bd_config)
Definition: l2_input.h:183
static_always_inline l2_bridge_domain_t * l2input_bd_config(u32 bd_index)
Definition: l2_input.h:86
#define foreach_l2input_feat
Definition: l2_input.h:102
static_always_inline l2_bridge_domain_t * l2input_bd_config_from_index(l2input_main_t *l2im, u32 bd_index)
Definition: l2_input.h:77
#define hash_v3_finalize32(a, b, c)
Definition: hash.h:564
static_always_inline int ethernet_frame_is_tagged(u16 type)
Definition: ethernet.h:78
#define IP_FLOW_HASH_DEFAULT
Default: 5-tuple without the "reverse" bit.
Definition: lookup.h:70
struct _vlib_node_registration vlib_node_registration_t
u32 feature_bitmap
Definition: l2_bd.h:69
static void vnet_update_l2_len(vlib_buffer_t *b)
Definition: l2_input.h:236
VLIB buffer representation.
Definition: buffer.h:102
l2_bridge_domain_t * bd_configs
Definition: l2_input.h:65
#define vnet_buffer(b)
Definition: buffer.h:417
vlib_main_t * vlib_main
Definition: l2_input.h:68