2 * l2_input.h : layer 2 input packet processing
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:
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #ifndef included_vnet_l2_input_h
19 #define included_vnet_l2_input_h
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>
31 /* l2 connection type */
32 typedef enum l2_input_flags_t_
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;
41 /* Per-subinterface L2 feature configuration */
44 u8 __force_u64_alignement[0] __attribute__ ((aligned (8)));
48 /* bridge domain id and values cached from the BD */
56 u32 output_sw_if_index;
59 /* config for which input features are configured on this interface */
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;
66 /* split horizon group */
69 /* Interface sequence number */
72 /* Flags describing this interface */
73 l2_input_flags_t flags;
75 /* A wee bit of spare space */
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));
86 /* Next nodes for the feature bitmap */
87 u32 feat_next_node_index[32];
89 /* config vector indexed by sw_if_index */
90 l2_input_config_t *configs;
92 /* bridge domain config vector indexed by bd_index */
93 l2_bridge_domain_t *bd_configs;
95 /* convenience variables */
96 vlib_main_t *vlib_main;
97 vnet_main_t *vnet_main;
102 extern l2input_main_t l2input_main;
104 extern vlib_node_registration_t l2input_node;
106 static_always_inline l2_bridge_domain_t *
107 l2input_bd_config_from_index (l2input_main_t * l2im, u32 bd_index)
109 l2_bridge_domain_t *bd_config;
111 bd_config = vec_elt_at_index (l2im->bd_configs, bd_index);
112 return bd_is_valid (bd_config) ? bd_config : NULL;
115 static_always_inline l2_bridge_domain_t *
116 l2input_bd_config (u32 bd_index)
118 l2input_main_t *mp = &l2input_main;
119 l2_bridge_domain_t *bd_config;
121 vec_validate (mp->bd_configs, bd_index);
122 bd_config = vec_elt_at_index (mp->bd_configs, bd_index);
126 /* L2 input indication packet is from BVI, using -2 */
127 #define L2INPUT_BVI ((u32) (~0-1))
129 /* L2 input features */
131 /* Mappings from feature ID to graph node name in reverse order */
132 #define foreach_l2input_feat \
133 _(DROP, "feature-bitmap-drop") \
134 _(XCONNECT, "l2-output") \
135 _(FLOOD, "l2-flood") \
136 _(ARP_UFWD, "l2-uu-fwd") \
137 _(ARP_TERM, "arp-term-l2bd") \
138 _(UU_FLOOD, "l2-flood") \
139 _(GBP_FWD, "gbp-fwd") \
140 _(UU_FWD, "l2-uu-fwd") \
143 _(LEARN, "l2-learn") \
144 _(L2_EMULATION, "l2-emulation") \
145 _(GBP_LEARN, "gbp-learn-l2") \
146 _(GBP_LPM_ANON_CLASSIFY, "l2-gbp-lpm-anon-classify") \
147 _(GBP_NULL_CLASSIFY, "gbp-null-classify") \
148 _(GBP_SRC_CLASSIFY, "gbp-src-classify") \
149 _(GBP_LPM_CLASSIFY, "l2-gbp-lpm-classify") \
150 _(VTR, "l2-input-vtr") \
151 _(L2_IP_QOS_RECORD, "l2-ip-qos-record") \
152 _(VPATH, "vpath-input-l2") \
153 _(ACL, "l2-input-acl") \
154 _(POLICER_CLAS, "l2-policer-classify") \
155 _(INPUT_FEAT_ARC, "l2-input-feat-arc") \
156 _(INPUT_CLASSIFY, "l2-input-classify") \
157 _(SPAN, "span-l2-input")
159 /* Feature bitmap positions */
162 #define _(sym,str) L2INPUT_FEAT_##sym##_BIT,
168 STATIC_ASSERT (L2INPUT_N_FEAT <= 32, "too many l2 input features");
170 /* Feature bit masks */
173 L2INPUT_FEAT_NONE = 0,
174 #define _(sym,str) L2INPUT_FEAT_##sym = (1<<L2INPUT_FEAT_##sym##_BIT),
178 #define _(sym,str) L2INPUT_FEAT_##sym |
182 } l2input_feat_masks_t;
184 STATIC_ASSERT ((u64) L2INPUT_VALID_MASK == (1ull << L2INPUT_N_FEAT) - 1, "");
186 /** Return an array of strings containing graph node names of each feature */
187 char **l2input_get_feat_names (void);
189 /* arg0 - u32 feature_bitmap, arg1 - u32 verbose */
190 u8 *format_l2_input_feature_bitmap (u8 * s, va_list * args);
191 u8 *format_l2_input_features (u8 * s, va_list * args);
192 u8 *format_l2_input (u8 * s, va_list * args);
194 static_always_inline u8
195 bd_feature_flood (l2_bridge_domain_t * bd_config)
197 return ((bd_config->feature_bitmap & L2INPUT_FEAT_FLOOD) ==
201 static_always_inline u8
202 bd_feature_uu_flood (l2_bridge_domain_t * bd_config)
204 return ((bd_config->feature_bitmap & L2INPUT_FEAT_UU_FLOOD) ==
205 L2INPUT_FEAT_UU_FLOOD);
208 static_always_inline u8
209 bd_feature_forward (l2_bridge_domain_t * bd_config)
211 return ((bd_config->feature_bitmap & L2INPUT_FEAT_FWD) == L2INPUT_FEAT_FWD);
214 static_always_inline u8
215 bd_feature_learn (l2_bridge_domain_t * bd_config)
217 return ((bd_config->feature_bitmap & L2INPUT_FEAT_LEARN) ==
221 static_always_inline u8
222 bd_feature_arp_term (l2_bridge_domain_t * bd_config)
224 return ((bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM) ==
225 L2INPUT_FEAT_ARP_TERM);
228 static_always_inline u8
229 bd_feature_arp_ufwd (l2_bridge_domain_t * bd_config)
231 return ((bd_config->feature_bitmap & L2INPUT_FEAT_ARP_UFWD) ==
232 L2INPUT_FEAT_ARP_UFWD);
236 l2_input_is_bridge (const l2_input_config_t * input)
238 return (input->flags & L2_INPUT_FLAG_BRIDGE);
242 l2_input_is_xconnect (const l2_input_config_t * input)
244 return (input->flags & L2_INPUT_FLAG_XCONNECT);
248 l2_input_is_bvi (const l2_input_config_t * input)
250 return (input->flags & L2_INPUT_FLAG_BVI);
253 static_always_inline u8
254 l2_input_seq_num (u32 sw_if_index)
256 l2_input_config_t *input;
258 input = vec_elt_at_index (l2input_main.configs, sw_if_index);
260 return input->seq_num;
264 /** Masks for eliminating features that do not apply to a packet */
266 /** Get a pointer to the config for the given interface */
267 l2_input_config_t *l2input_intf_config (u32 sw_if_index);
269 /* Enable (or disable) the feature in the bitmap for the given interface */
270 u32 l2input_intf_bitmap_enable (u32 sw_if_index,
271 l2input_feat_masks_t feature_bitmap,
274 /* Sets modifies flags from a bridge domain */
275 u32 l2input_set_bridge_features (u32 bd_index, u32 feat_mask, u32 feat_value);
277 void l2input_interface_mac_change (u32 sw_if_index,
278 const u8 * old_address,
279 const u8 * new_address);
281 void l2_input_seq_num_inc (u32 sw_if_index);
282 walk_rc_t l2input_recache (u32 bd_index, u32 sw_if_index);
285 #define MODE_L2_BRIDGE 1
287 #define MODE_L2_CLASSIFY 3
289 #define MODE_ERROR_ETH 1
290 #define MODE_ERROR_BVI_DEF 2
292 u32 set_int_l2_mode (vlib_main_t * vm,
293 vnet_main_t * vnet_main,
296 u32 bd_index, l2_bd_port_type_t port_type,
297 u32 shg, u32 xc_sw_if_index);
300 vnet_update_l2_len (vlib_buffer_t *b)
302 ethernet_header_t *eth;
306 /* point at current l2 hdr */
307 eth = vlib_buffer_get_current (b);
310 * l2-output pays no attention to this
311 * but the tag push/pop code on an l2 subif needs it.
313 * Determine l2 header len, check for up to 2 vlans
315 vnet_buffer (b)->l2.l2_len = sizeof (ethernet_header_t);
316 ethertype = clib_net_to_host_u16 (eth->type);
317 if (ethernet_frame_is_tagged (ethertype))
319 ethernet_vlan_header_t *vlan;
320 vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
322 vlan = (void *) (eth + 1);
323 ethertype = clib_net_to_host_u16 (vlan->type);
324 if (ethertype == ETHERNET_TYPE_VLAN)
326 vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
330 ethernet_buffer_set_vlan_count (b, vlan_count);
336 * Compute flow hash of an ethernet packet, use 5-tuple hash if L3 packet
337 * is ip4 or ip6. Otherwise hash on smac/dmac/etype.
338 * The vlib buffer current pointer is expected to be at ethernet header
339 * and vnet l2.l2_len is expected to be setup already.
342 vnet_l2_compute_flow_hash (vlib_buffer_t * b)
344 ethernet_header_t *eh = vlib_buffer_get_current (b);
345 u8 *l3h = (u8 *) eh + vnet_buffer (b)->l2.l2_len;
346 u16 ethertype = clib_net_to_host_u16 (*(u16 *) (l3h - 2));
348 if (ethertype == ETHERNET_TYPE_IP4)
349 return ip4_compute_flow_hash ((ip4_header_t *) l3h, IP_FLOW_HASH_DEFAULT);
350 else if (ethertype == ETHERNET_TYPE_IP6)
351 return ip6_compute_flow_hash ((ip6_header_t *) l3h, IP_FLOW_HASH_DEFAULT);
355 u32 *ap = (u32 *) & eh->dst_address[2];
356 u32 *bp = (u32 *) & eh->src_address[2];
360 hash_v3_mix32 (a, b, c);
361 hash_v3_finalize32 (a, b, c);
370 * fd.io coding-style-patch-verification: ON
373 * eval: (c-set-style "gnu")