b4e90af550cea58631b9a79a674785afda9041ec
[vpp.git] / vnet / 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 } l2_input_config_t;
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 */
66   l2_input_config_t *configs;
67
68   /* bridge domain config vector indexed by bd_index */
69   l2_bridge_domain_t *bd_configs;
70
71   /* convenience variables */
72   vlib_main_t *vlib_main;
73   vnet_main_t *vnet_main;
74 } l2input_main_t;
75
76 extern l2input_main_t l2input_main;
77
78 extern vlib_node_registration_t l2input_node;
79
80 static_always_inline l2_bridge_domain_t *
81 l2input_bd_config_from_index (l2input_main_t * l2im, u32 bd_index)
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
89 /* L2 input indication packet is from BVI, using -2 */
90 #define L2INPUT_BVI ((u32) (~0-1))
91
92 /* L2 input features */
93
94 /* Mappings from feature ID to graph node name */
95 #define foreach_l2input_feat                    \
96  _(DROP,          "feature-bitmap-drop")        \
97  _(XCONNECT,      "l2-output")                  \
98  _(IPIW,          "feature-bitmap-drop")        \
99  _(FLOOD,         "l2-flood")                   \
100  _(ARP_TERM,      "arp-term-l2bd")              \
101  _(UU_FLOOD,      "l2-flood")                   \
102  _(FWD,           "l2-fwd")                     \
103  _(RW,            "l2-rw")                      \
104  _(LEARN,         "l2-learn")                   \
105  _(VTR,           "l2-input-vtr")               \
106  _(VPATH,         "vpath-input-l2")             \
107  _(CTRL_PKT,      "feature-bitmap-drop")        \
108  _(L2PT,          "feature-bitmap-drop")        \
109  _(IGMP_SNOOP,    "feature-bitmap-drop")        \
110  _(MLD_SNOOP,     "feature-bitmap-drop")        \
111  _(DHCP_SNOOP,    "feature-bitmap-drop")        \
112  _(DAI,           "feature-bitmap-drop")        \
113  _(IPSG,          "feature-bitmap-drop")        \
114  _(ACL,           "l2-input-acl")               \
115  _(QOS,           "feature-bitmap-drop")        \
116  _(CFM,           "feature-bitmap-drop")        \
117  _(SPAN,          "feature-bitmap-drop")        \
118  _(POLICER_CLAS,  "l2-policer-classify")        \
119  _(INPUT_CLASSIFY, "l2-input-classify")
120
121 /* Feature bitmap positions */
122 typedef enum
123 {
124 #define _(sym,str) L2INPUT_FEAT_##sym##_BIT,
125   foreach_l2input_feat
126 #undef _
127     L2INPUT_N_FEAT,
128 } l2input_feat_t;
129
130 /* Feature bit masks */
131 typedef enum
132 {
133 #define _(sym,str) L2INPUT_FEAT_##sym = (1<<L2INPUT_FEAT_##sym##_BIT),
134   foreach_l2input_feat
135 #undef _
136 } l2input_feat_masks_t;
137
138 /** Return an array of strings containing graph node names of each feature */
139 char **l2input_get_feat_names (void);
140
141
142 static_always_inline u8
143 bd_feature_flood (l2_bridge_domain_t * bd_config)
144 {
145   return ((bd_config->feature_bitmap & L2INPUT_FEAT_FLOOD) ==
146           L2INPUT_FEAT_FLOOD);
147 }
148
149 static_always_inline u8
150 bd_feature_uu_flood (l2_bridge_domain_t * bd_config)
151 {
152   return ((bd_config->feature_bitmap & L2INPUT_FEAT_UU_FLOOD) ==
153           L2INPUT_FEAT_UU_FLOOD);
154 }
155
156 static_always_inline u8
157 bd_feature_forward (l2_bridge_domain_t * bd_config)
158 {
159   return ((bd_config->feature_bitmap & L2INPUT_FEAT_FWD) == L2INPUT_FEAT_FWD);
160 }
161
162 static_always_inline u8
163 bd_feature_learn (l2_bridge_domain_t * bd_config)
164 {
165   return ((bd_config->feature_bitmap & L2INPUT_FEAT_LEARN) ==
166           L2INPUT_FEAT_LEARN);
167 }
168
169 static_always_inline u8
170 bd_feature_arp_term (l2_bridge_domain_t * bd_config)
171 {
172   return ((bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM) ==
173           L2INPUT_FEAT_ARP_TERM);
174 }
175
176 /** Masks for eliminating features that do not apply to a packet */
177
178 #define IP4_FEAT_MASK  ~(L2INPUT_FEAT_CTRL_PKT    | \
179                          L2INPUT_FEAT_MLD_SNOOP   | \
180                          L2INPUT_FEAT_L2PT        | \
181                          L2INPUT_FEAT_CFM         | \
182                          L2INPUT_FEAT_DAI)
183
184 #define IP6_FEAT_MASK  ~(L2INPUT_FEAT_CTRL_PKT    | \
185                          L2INPUT_FEAT_IGMP_SNOOP  | \
186                          L2INPUT_FEAT_L2PT        | \
187                          L2INPUT_FEAT_CFM         | \
188                          L2INPUT_FEAT_DAI)
189
190 #define IP_UDP_TCP_FEAT_MASK  ~(L2INPUT_FEAT_CTRL_PKT   | \
191                                 L2INPUT_FEAT_L2PT       | \
192                                 L2INPUT_FEAT_IGMP_SNOOP | \
193                                 L2INPUT_FEAT_MLD_SNOOP  | \
194                                 L2INPUT_FEAT_DHCP_SNOOP | \
195                                 L2INPUT_FEAT_CFM        | \
196                                 L2INPUT_FEAT_DAI)
197
198 #define MPLS_FEAT_MASK  ~(L2INPUT_FEAT_CTRL_PKT   | \
199                           L2INPUT_FEAT_L2PT       | \
200                           L2INPUT_FEAT_IGMP_SNOOP | \
201                           L2INPUT_FEAT_MLD_SNOOP  | \
202                           L2INPUT_FEAT_DHCP_SNOOP | \
203                           L2INPUT_FEAT_CFM        | \
204                           L2INPUT_FEAT_DAI)
205
206
207 /** Get a pointer to the config for the given interface */
208 l2_input_config_t *l2input_intf_config (u32 sw_if_index);
209
210 /* Enable (or disable) the feature in the bitmap for the given interface */
211 u32 l2input_intf_bitmap_enable (u32 sw_if_index,
212                                 u32 feature_bitmap, u32 enable);
213
214 /* Sets modifies flags from a bridge domain */
215 u32 l2input_set_bridge_features (u32 bd_index, u32 feat_mask, u32 feat_value);
216
217
218 #define MODE_L3        0
219 #define MODE_L2_BRIDGE 1
220 #define MODE_L2_XC     2
221 #define MODE_L2_CLASSIFY 3
222
223 #define MODE_ERROR_ETH        1
224 #define MODE_ERROR_BVI_DEF    2
225
226 u32 set_int_l2_mode (vlib_main_t * vm,
227                      vnet_main_t * vnet_main,
228                      u32 mode,
229                      u32 sw_if_index,
230                      u32 bd_index, u32 bvi, u32 shg, u32 xc_sw_if_index);
231
232 static inline void
233 vnet_update_l2_len (vlib_buffer_t * b)
234 {
235   ethernet_header_t *eth;
236   u16 ethertype;
237   u8 vlan_count = 0;
238
239   /* point at currrent l2 hdr */
240   eth = vlib_buffer_get_current (b);
241
242   /*
243    * l2-output pays no attention to this
244    * but the tag push/pop code on an l2 subif needs it.
245    *
246    * Determine l2 header len, check for up to 2 vlans
247    */
248   vnet_buffer (b)->l2.l2_len = sizeof (ethernet_header_t);
249   ethertype = clib_net_to_host_u16 (eth->type);
250   if (ethernet_frame_is_tagged (ethertype))
251     {
252       ethernet_vlan_header_t *vlan;
253       vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
254       vlan_count = 1;
255       vlan = (void *) (eth + 1);
256       ethertype = clib_net_to_host_u16 (vlan->type);
257       if (ethertype == ETHERNET_TYPE_VLAN)
258         {
259           vnet_buffer (b)->l2.l2_len += sizeof (*vlan);
260           vlan_count = 2;
261         }
262     }
263   ethernet_buffer_set_vlan_count (b, vlan_count);
264 }
265
266 /*
267  * Compute flow hash of an ethernet packet, use 5-tuple hash if L3 packet
268  * is ip4 or ip6. Otherwise hash on smac/dmac/etype.
269  * The vlib buffer current pointer is expected to be at ethernet header
270  * and vnet l2.l2_len is exppected to be setup already.
271  */
272 static inline u32
273 vnet_l2_compute_flow_hash (vlib_buffer_t * b)
274 {
275   ethernet_header_t *eh = vlib_buffer_get_current (b);
276   u8 *l3h = (u8 *) eh + vnet_buffer (b)->l2.l2_len;
277   u16 ethertype = clib_net_to_host_u16 (*(u16 *) (l3h - 2));
278
279   if (ethertype == ETHERNET_TYPE_IP4)
280     return ip4_compute_flow_hash ((ip4_header_t *) l3h, IP_FLOW_HASH_DEFAULT);
281   else if (ethertype == ETHERNET_TYPE_IP6)
282     return ip6_compute_flow_hash ((ip6_header_t *) l3h, IP_FLOW_HASH_DEFAULT);
283   else
284     {
285       u32 a, b, c;
286       u32 *ap = (u32 *) & eh->dst_address[2];
287       u32 *bp = (u32 *) & eh->src_address[2];
288       a = *ap;
289       b = *bp;
290       c = ethertype;
291       hash_v3_mix32 (a, b, c);
292       hash_v3_finalize32 (a, b, c);
293       return c;
294     }
295 }
296
297 #endif
298
299
300 /*
301  * fd.io coding-style-patch-verification: ON
302  *
303  * Local Variables:
304  * eval: (c-set-style "gnu")
305  * End:
306  */