FD.io VPP  v18.01.2-1-g9b554f3
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  /* Interface mode. If both are 0, this interface is in L3 mode */
41 
42  /* this is the bvi interface for the bridge-domain */
44 
45  /* config for which input features are configured on this interface */
47 
48  /* some of these flags are also in the feature bitmap */
52 
53  /* split horizon group */
55 
57 
58 
59 typedef struct
60 {
61 
62  /* Next nodes for the feature bitmap */
63  u32 feat_next_node_index[32];
64 
65  /* config vector indexed by sw_if_index */
67 
68  /* bridge domain config vector indexed by bd_index */
70 
71  /* convenience variables */
75 
77 
79 
82 {
83  l2_bridge_domain_t *bd_config;
84 
85  bd_config = vec_elt_at_index (l2im->bd_configs, bd_index);
86  return bd_is_valid (bd_config) ? bd_config : NULL;
87 }
88 
91 {
93  l2_bridge_domain_t *bd_config;
94 
95  vec_validate (mp->bd_configs, bd_index);
96  bd_config = vec_elt_at_index (mp->bd_configs, bd_index);
97  return bd_config;
98 }
99 
100 /* L2 input indication packet is from BVI, using -2 */
101 #define L2INPUT_BVI ((u32) (~0-1))
102 
103 /* L2 input features */
104 
105 /* Mappings from feature ID to graph node name in reverse order */
106 #define foreach_l2input_feat \
107  _(DROP, "feature-bitmap-drop") \
108  _(XCONNECT, "l2-output") \
109  _(FLOOD, "l2-flood") \
110  _(ARP_TERM, "arp-term-l2bd") \
111  _(UU_FLOOD, "l2-flood") \
112  _(FWD, "l2-fwd") \
113  _(RW, "l2-rw") \
114  _(LEARN, "l2-learn") \
115  _(L2_EMULATION, "l2-emulation") \
116  _(VTR, "l2-input-vtr") \
117  _(VPATH, "vpath-input-l2") \
118  _(ACL, "l2-input-acl") \
119  _(POLICER_CLAS, "l2-policer-classify") \
120  _(INPUT_CLASSIFY, "l2-input-classify") \
121  _(SPAN, "span-l2-input")
122 
123 /* Feature bitmap positions */
124 typedef enum
125 {
126 #define _(sym,str) L2INPUT_FEAT_##sym##_BIT,
128 #undef _
131 
132 STATIC_ASSERT (L2INPUT_N_FEAT <= 32, "too many l2 input features");
133 
134 /* Feature bit masks */
135 typedef enum
136 {
137 #define _(sym,str) L2INPUT_FEAT_##sym = (1<<L2INPUT_FEAT_##sym##_BIT),
139 #undef _
141 #define _(sym,str) L2INPUT_FEAT_##sym |
143 #undef _
144  0
146 
147 STATIC_ASSERT ((u64) L2INPUT_VALID_MASK == (1ull << L2INPUT_N_FEAT) - 1, "");
148 
149 /** Return an array of strings containing graph node names of each feature */
150 char **l2input_get_feat_names (void);
151 
152 /* arg0 - u32 feature_bitmap */
153 u8 *format_l2_input_features (u8 * s, va_list * args);
154 
157 {
158  return ((bd_config->feature_bitmap & L2INPUT_FEAT_FLOOD) ==
159  L2INPUT_FEAT_FLOOD);
160 }
161 
164 {
165  return ((bd_config->feature_bitmap & L2INPUT_FEAT_UU_FLOOD) ==
166  L2INPUT_FEAT_UU_FLOOD);
167 }
168 
171 {
172  return ((bd_config->feature_bitmap & L2INPUT_FEAT_FWD) == L2INPUT_FEAT_FWD);
173 }
174 
177 {
178  return ((bd_config->feature_bitmap & L2INPUT_FEAT_LEARN) ==
179  L2INPUT_FEAT_LEARN);
180 }
181 
184 {
185  return ((bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM) ==
186  L2INPUT_FEAT_ARP_TERM);
187 }
188 
189 /** Masks for eliminating features that do not apply to a packet */
190 
191 /** Get a pointer to the config for the given interface */
193 
194 /* Enable (or disable) the feature in the bitmap for the given interface */
195 u32 l2input_intf_bitmap_enable (u32 sw_if_index,
196  u32 feature_bitmap, u32 enable);
197 
198 /* Sets modifies flags from a bridge domain */
199 u32 l2input_set_bridge_features (u32 bd_index, u32 feat_mask, u32 feat_value);
200 
201 
202 #define MODE_L3 0
203 #define MODE_L2_BRIDGE 1
204 #define MODE_L2_XC 2
205 #define MODE_L2_CLASSIFY 3
206 
207 #define MODE_ERROR_ETH 1
208 #define MODE_ERROR_BVI_DEF 2
209 
212  u32 mode,
213  u32 sw_if_index,
214  u32 bd_index, u32 bvi, u32 shg, u32 xc_sw_if_index);
215 
216 static inline void
218 {
219  ethernet_header_t *eth;
220  u16 ethertype;
221  u8 vlan_count = 0;
222 
223  /* point at currrent l2 hdr */
224  eth = vlib_buffer_get_current (b);
225 
226  /*
227  * l2-output pays no attention to this
228  * but the tag push/pop code on an l2 subif needs it.
229  *
230  * Determine l2 header len, check for up to 2 vlans
231  */
232  vnet_buffer (b)->l2.l2_len = sizeof (ethernet_header_t);
233  ethertype = clib_net_to_host_u16 (eth->type);
234  if (ethernet_frame_is_tagged (ethertype))
235  {
237  vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
238  vlan_count = 1;
239  vlan = (void *) (eth + 1);
240  ethertype = clib_net_to_host_u16 (vlan->type);
241  if (ethertype == ETHERNET_TYPE_VLAN)
242  {
243  vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
244  vlan_count = 2;
245  }
246  }
247  ethernet_buffer_set_vlan_count (b, vlan_count);
248 }
249 
250 /*
251  * Compute flow hash of an ethernet packet, use 5-tuple hash if L3 packet
252  * is ip4 or ip6. Otherwise hash on smac/dmac/etype.
253  * The vlib buffer current pointer is expected to be at ethernet header
254  * and vnet l2.l2_len is exppected to be setup already.
255  */
256 static inline u32
258 {
260  u8 *l3h = (u8 *) eh + vnet_buffer (b)->l2.l2_len;
261  u16 ethertype = clib_net_to_host_u16 (*(u16 *) (l3h - 2));
262 
263  if (ethertype == ETHERNET_TYPE_IP4)
265  else if (ethertype == ETHERNET_TYPE_IP6)
267  else
268  {
269  u32 a, b, c;
270  u32 *ap = (u32 *) & eh->dst_address[2];
271  u32 *bp = (u32 *) & eh->src_address[2];
272  a = *ap;
273  b = *bp;
274  c = ethertype;
275  hash_v3_mix32 (a, b, c);
276  hash_v3_finalize32 (a, b, c);
277  return c;
278  }
279 }
280 
281 #endif
282 
283 
284 /*
285  * fd.io coding-style-patch-verification: ON
286  *
287  * Local Variables:
288  * eval: (c-set-style "gnu")
289  * End:
290  */
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:432
static_always_inline u8 bd_feature_forward(l2_bridge_domain_t *bd_config)
Definition: l2_input.h:170
l2_input_config_t * configs
Definition: l2_input.h:66
a
Definition: bitmap.h:516
STATIC_ASSERT(L2INPUT_N_FEAT<=32,"too many l2 input features")
#define NULL
Definition: clib.h:55
static u32 ip4_compute_flow_hash(const ip4_header_t *ip, flow_hash_config_t flow_hash_config)
Definition: ip4.h:299
u8 src_address[6]
Definition: packet.h:54
struct _vlib_node_registration vlib_node_registration_t
static_always_inline u8 bd_feature_uu_flood(l2_bridge_domain_t *bd_config)
Definition: l2_input.h:163
u8 * format_l2_input_features(u8 *s, va_list *args)
Definition: l2_input.c:66
#define hash_v3_mix32(a, b, c)
Definition: hash.h:553
#define static_always_inline
Definition: clib.h:93
u32 output_sw_if_index
Definition: l2_input.h:35
u8 dst_address[6]
Definition: packet.h:53
u32 l2input_set_bridge_features(u32 bd_index, u32 feat_mask, u32 feat_value)
Definition: l2_input.c:547
#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:183
unsigned long u64
Definition: types.h:89
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:524
u32 l2input_intf_bitmap_enable(u32 sw_if_index, u32 feature_bitmap, u32 enable)
Enable (or disable) the feature in the bitmap for the given interface.
Definition: l2_input.c:534
l2input_main_t l2input_main
Definition: l2_input.c:113
l2input_feat_t
Definition: l2_input.h:124
static_always_inline u8 bd_feature_flood(l2_bridge_domain_t *bd_config)
Definition: l2_input.h:156
char ** l2input_get_feat_names(void)
Return an array of strings containing graph node names of each feature.
Definition: l2_input.c:60
vnet_main_t * vnet_main
Definition: l2_input.h:73
static u32 vnet_l2_compute_flow_hash(vlib_buffer_t *b)
Definition: l2_input.h:257
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:195
static u32 ip6_compute_flow_hash(const ip6_header_t *ip, flow_hash_config_t flow_hash_config)
Definition: ip6.h:414
vnet_main_t vnet_main
Definition: misc.c:43
#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:369
l2input_feat_masks_t
Definition: l2_input.h:135
static u32 bd_is_valid(l2_bridge_domain_t *bd_config)
Definition: l2_bd.h:114
svmdb_client_t * c
vlib_main_t * vm
Definition: buffer.c:283
vlib_node_registration_t l2input_node
(constructor) VLIB_REGISTER_NODE (l2input_node)
Definition: l2_input.c:472
static_always_inline u8 bd_feature_learn(l2_bridge_domain_t *bd_config)
Definition: l2_input.h:176
static_always_inline l2_bridge_domain_t * l2input_bd_config(u32 bd_index)
Definition: l2_input.h:90
unsigned int u32
Definition: types.h:88
#define foreach_l2input_feat
Definition: l2_input.h:106
static_always_inline l2_bridge_domain_t * l2input_bd_config_from_index(l2input_main_t *l2im, u32 bd_index)
Definition: l2_input.h:81
#define hash_v3_finalize32(a, b, c)
Definition: hash.h:563
static_always_inline int ethernet_frame_is_tagged(u16 type)
Definition: ethernet.h:71
#define IP_FLOW_HASH_DEFAULT
Default: 5-tuple without the "reverse" bit.
Definition: lookup.h:69
unsigned short u16
Definition: types.h:57
u32 feature_bitmap
Definition: l2_bd.h:56
unsigned char u8
Definition: types.h:56
static void vnet_update_l2_len(vlib_buffer_t *b)
Definition: l2_input.h:217
l2_bridge_domain_t * bd_configs
Definition: l2_input.h:69
#define vnet_buffer(b)
Definition: buffer.h:326
u32 set_int_l2_mode(vlib_main_t *vm, vnet_main_t *vnet_main, u32 mode, u32 sw_if_index, u32 bd_index, u32 bvi, u32 shg, u32 xc_sw_if_index)
Set the subinterface to run in l2 or l3 mode.
Definition: l2_input.c:565
vlib_main_t * vlib_main
Definition: l2_input.h:72