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