FD.io VPP  v19.04.4-rc0-5-ge88582fac
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/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  /* config for which input features are configured on this interface */
40 
41  /* split horizon group */
43 
44  /* Interface mode. If both are 0, this interface is in L3 mode */
47 
48  /* this is the bvi interface for the bridge-domain */
50 
52 
53 
54 typedef struct
55 {
56 
57  /* Next nodes for the feature bitmap */
58  u32 feat_next_node_index[32];
59 
60  /* config vector indexed by sw_if_index */
62 
63  /* bridge domain config vector indexed by bd_index */
65 
66  /* convenience variables */
70 
72 
74 
77 {
78  l2_bridge_domain_t *bd_config;
79 
80  bd_config = vec_elt_at_index (l2im->bd_configs, bd_index);
81  return bd_is_valid (bd_config) ? bd_config : NULL;
82 }
83 
86 {
88  l2_bridge_domain_t *bd_config;
89 
90  vec_validate (mp->bd_configs, bd_index);
91  bd_config = vec_elt_at_index (mp->bd_configs, bd_index);
92  return bd_config;
93 }
94 
95 /* L2 input indication packet is from BVI, using -2 */
96 #define L2INPUT_BVI ((u32) (~0-1))
97 
98 /* L2 input features */
99 
100 /* Mappings from feature ID to graph node name in reverse order */
101 #define foreach_l2input_feat \
102  _(DROP, "feature-bitmap-drop") \
103  _(XCONNECT, "l2-output") \
104  _(FLOOD, "l2-flood") \
105  _(ARP_TERM, "arp-term-l2bd") \
106  _(UU_FLOOD, "l2-flood") \
107  _(GBP_FWD, "gbp-fwd") \
108  _(UU_FWD, "l2-uu-fwd") \
109  _(FWD, "l2-fwd") \
110  _(RW, "l2-rw") \
111  _(LEARN, "l2-learn") \
112  _(L2_EMULATION, "l2-emulation") \
113  _(GBP_LEARN, "gbp-learn-l2") \
114  _(GBP_NULL_CLASSIFY, "gbp-null-classify") \
115  _(GBP_SRC_CLASSIFY, "gbp-src-classify") \
116  _(GBP_LPM_CLASSIFY, "l2-gbp-lpm-classify") \
117  _(VTR, "l2-input-vtr") \
118  _(L2_IP_QOS_RECORD, "l2-ip-qos-record") \
119  _(VPATH, "vpath-input-l2") \
120  _(ACL, "l2-input-acl") \
121  _(POLICER_CLAS, "l2-policer-classify") \
122  _(INPUT_FEAT_ARC, "l2-input-feat-arc") \
123  _(INPUT_CLASSIFY, "l2-input-classify") \
124  _(SPAN, "span-l2-input")
125 
126 /* Feature bitmap positions */
127 typedef enum
128 {
129 #define _(sym,str) L2INPUT_FEAT_##sym##_BIT,
131 #undef _
134 
135 STATIC_ASSERT (L2INPUT_N_FEAT <= 32, "too many l2 input features");
136 
137 /* Feature bit masks */
138 typedef enum
139 {
141 #define _(sym,str) L2INPUT_FEAT_##sym = (1<<L2INPUT_FEAT_##sym##_BIT),
143 #undef _
145 #define _(sym,str) L2INPUT_FEAT_##sym |
147 #undef _
148  0
150 
151 STATIC_ASSERT ((u64) L2INPUT_VALID_MASK == (1ull << L2INPUT_N_FEAT) - 1, "");
152 
153 /** Return an array of strings containing graph node names of each feature */
154 char **l2input_get_feat_names (void);
155 
156 /* arg0 - u32 feature_bitmap, arg1 - u32 verbose */
157 u8 *format_l2_input_features (u8 * s, va_list * args);
158 
161 {
162  return ((bd_config->feature_bitmap & L2INPUT_FEAT_FLOOD) ==
163  L2INPUT_FEAT_FLOOD);
164 }
165 
168 {
169  return ((bd_config->feature_bitmap & L2INPUT_FEAT_UU_FLOOD) ==
170  L2INPUT_FEAT_UU_FLOOD);
171 }
172 
175 {
176  return ((bd_config->feature_bitmap & L2INPUT_FEAT_FWD) == L2INPUT_FEAT_FWD);
177 }
178 
181 {
182  return ((bd_config->feature_bitmap & L2INPUT_FEAT_LEARN) ==
183  L2INPUT_FEAT_LEARN);
184 }
185 
188 {
189  return ((bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM) ==
190  L2INPUT_FEAT_ARP_TERM);
191 }
192 
193 /** Masks for eliminating features that do not apply to a packet */
194 
195 /** Get a pointer to the config for the given interface */
197 
198 /* Enable (or disable) the feature in the bitmap for the given interface */
199 u32 l2input_intf_bitmap_enable (u32 sw_if_index,
200  l2input_feat_masks_t feature_bitmap,
201  u32 enable);
202 
203 /* Sets modifies flags from a bridge domain */
204 u32 l2input_set_bridge_features (u32 bd_index, u32 feat_mask, u32 feat_value);
205 
206 void l2input_interface_mac_change (u32 sw_if_index,
207  const u8 * old_address,
208  const u8 * new_address);
209 
210 #define MODE_L3 0
211 #define MODE_L2_BRIDGE 1
212 #define MODE_L2_XC 2
213 #define MODE_L2_CLASSIFY 3
214 
215 #define MODE_ERROR_ETH 1
216 #define MODE_ERROR_BVI_DEF 2
217 
220  u32 mode,
221  u32 sw_if_index,
222  u32 bd_index, l2_bd_port_type_t port_type,
223  u32 shg, u32 xc_sw_if_index);
224 
225 static inline void
227 {
228  ethernet_header_t *eth;
229  u16 ethertype;
230  u8 vlan_count = 0;
231 
232  /* point at current l2 hdr */
233  eth = vlib_buffer_get_current (b);
234 
235  /*
236  * l2-output pays no attention to this
237  * but the tag push/pop code on an l2 subif needs it.
238  *
239  * Determine l2 header len, check for up to 2 vlans
240  */
241  vnet_buffer (b)->l2.l2_len = sizeof (ethernet_header_t);
242  ethertype = clib_net_to_host_u16 (eth->type);
243  if (ethernet_frame_is_tagged (ethertype))
244  {
246  vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
247  vlan_count = 1;
248  vlan = (void *) (eth + 1);
249  ethertype = clib_net_to_host_u16 (vlan->type);
250  if (ethertype == ETHERNET_TYPE_VLAN)
251  {
252  vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
253  vlan_count = 2;
254  }
255  }
256  ethernet_buffer_set_vlan_count (b, vlan_count);
257 }
258 
259 /*
260  * Compute flow hash of an ethernet packet, use 5-tuple hash if L3 packet
261  * is ip4 or ip6. Otherwise hash on smac/dmac/etype.
262  * The vlib buffer current pointer is expected to be at ethernet header
263  * and vnet l2.l2_len is expected to be setup already.
264  */
265 static inline u32
267 {
269  u8 *l3h = (u8 *) eh + vnet_buffer (b)->l2.l2_len;
270  u16 ethertype = clib_net_to_host_u16 (*(u16 *) (l3h - 2));
271 
272  if (ethertype == ETHERNET_TYPE_IP4)
274  else if (ethertype == ETHERNET_TYPE_IP6)
276  else
277  {
278  u32 a, b, c;
279  u32 *ap = (u32 *) & eh->dst_address[2];
280  u32 *bp = (u32 *) & eh->src_address[2];
281  a = *ap;
282  b = *bp;
283  c = ethertype;
284  hash_v3_mix32 (a, b, c);
285  hash_v3_finalize32 (a, b, c);
286  return c;
287  }
288 }
289 
290 #endif
291 
292 
293 /*
294  * fd.io coding-style-patch-verification: ON
295  *
296  * Local Variables:
297  * eval: (c-set-style "gnu")
298  * End:
299  */
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:439
static_always_inline u8 bd_feature_forward(l2_bridge_domain_t *bd_config)
Definition: l2_input.h:174
l2_input_config_t * configs
Definition: l2_input.h:61
a
Definition: bitmap.h:538
unsigned long u64
Definition: types.h:89
#define NULL
Definition: clib.h:58
static u32 ip4_compute_flow_hash(const ip4_header_t *ip, flow_hash_config_t flow_hash_config)
Definition: ip4.h:296
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:536
u8 src_address[6]
Definition: packet.h:56
static_always_inline u8 bd_feature_uu_flood(l2_bridge_domain_t *bd_config)
Definition: l2_input.h:167
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
#define static_always_inline
Definition: clib.h:99
u32 output_sw_if_index
Definition: l2_input.h:35
u8 dst_address[6]
Definition: packet.h:55
u32 l2input_set_bridge_features(u32 bd_index, u32 feat_mask, u32 feat_value)
Definition: l2_input.c:550
#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:187
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:526
unsigned int u32
Definition: types.h:88
l2input_main_t l2input_main
l2input_feat_t
Definition: l2_input.h:127
static_always_inline u8 bd_feature_flood(l2_bridge_domain_t *bd_config)
Definition: l2_input.h:160
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:68
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:266
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:478
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:589
#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:393
l2input_feat_masks_t
Definition: l2_input.h:138
static u32 bd_is_valid(l2_bridge_domain_t *bd_config)
Definition: l2_bd.h:133
svmdb_client_t * c
vlib_main_t * vm
Definition: buffer.c:312
vlib_node_registration_t l2input_node
(constructor) VLIB_REGISTER_NODE (l2input_node)
Definition: l2_input.c:474
void l2input_interface_mac_change(u32 sw_if_index, const u8 *old_address, const u8 *new_address)
Definition: l2_input.c:560
static_always_inline u8 bd_feature_learn(l2_bridge_domain_t *bd_config)
Definition: l2_input.h:180
static_always_inline l2_bridge_domain_t * l2input_bd_config(u32 bd_index)
Definition: l2_input.h:85
vl_api_vxlan_gbp_api_tunnel_mode_t mode
Definition: vxlan_gbp.api:44
#define foreach_l2input_feat
Definition: l2_input.h:101
static_always_inline l2_bridge_domain_t * l2input_bd_config_from_index(l2input_main_t *l2im, u32 bd_index)
Definition: l2_input.h:76
#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:226
VLIB buffer representation.
Definition: buffer.h:102
l2_bridge_domain_t * bd_configs
Definition: l2_input.h:64
#define vnet_buffer(b)
Definition: buffer.h:369
vlib_main_t * vlib_main
Definition: l2_input.h:67