523e23c4363a86becc481ec7dbfb1ce41d04bbda
[vpp.git] / src / plugins / gbp / gbp_policy_dpo.c
1 /*
2  * Copyright (c) 2018 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15
16 #include <vnet/dpo/dvr_dpo.h>
17 #include <vnet/dpo/drop_dpo.h>
18 #include <vnet/vxlan-gbp/vxlan_gbp_packet.h>
19
20 #include <plugins/gbp/gbp.h>
21 #include <plugins/gbp/gbp_policy_dpo.h>
22 #include <plugins/gbp/gbp_recirc.h>
23
24 /**
25  * DPO pool
26  */
27 gbp_policy_dpo_t *gbp_policy_dpo_pool;
28
29 /**
30  * DPO type registered for these GBP FWD
31  */
32 dpo_type_t gbp_policy_dpo_type;
33
34 static gbp_policy_dpo_t *
35 gbp_policy_dpo_alloc (void)
36 {
37   gbp_policy_dpo_t *gpd;
38
39   pool_get_aligned_zero (gbp_policy_dpo_pool, gpd, CLIB_CACHE_LINE_BYTES);
40
41   return (gpd);
42 }
43
44 static inline gbp_policy_dpo_t *
45 gbp_policy_dpo_get_from_dpo (const dpo_id_t * dpo)
46 {
47   ASSERT (gbp_policy_dpo_type == dpo->dpoi_type);
48
49   return (gbp_policy_dpo_get (dpo->dpoi_index));
50 }
51
52 static inline index_t
53 gbp_policy_dpo_get_index (gbp_policy_dpo_t * gpd)
54 {
55   return (gpd - gbp_policy_dpo_pool);
56 }
57
58 static void
59 gbp_policy_dpo_lock (dpo_id_t * dpo)
60 {
61   gbp_policy_dpo_t *gpd;
62
63   gpd = gbp_policy_dpo_get_from_dpo (dpo);
64   gpd->gpd_locks++;
65 }
66
67 static void
68 gbp_policy_dpo_unlock (dpo_id_t * dpo)
69 {
70   gbp_policy_dpo_t *gpd;
71
72   gpd = gbp_policy_dpo_get_from_dpo (dpo);
73   gpd->gpd_locks--;
74
75   if (0 == gpd->gpd_locks)
76     {
77       dpo_reset (&gpd->gpd_dpo);
78       pool_put (gbp_policy_dpo_pool, gpd);
79     }
80 }
81
82 static u32
83 gbp_policy_dpo_get_urpf (const dpo_id_t * dpo)
84 {
85   gbp_policy_dpo_t *gpd;
86
87   gpd = gbp_policy_dpo_get_from_dpo (dpo);
88
89   return (gpd->gpd_sw_if_index);
90 }
91
92 void
93 gbp_policy_dpo_add_or_lock (dpo_proto_t dproto,
94                             epg_id_t epg, u32 sw_if_index, dpo_id_t * dpo)
95 {
96   gbp_policy_dpo_t *gpd;
97   dpo_id_t parent = DPO_INVALID;
98
99   gpd = gbp_policy_dpo_alloc ();
100
101   gpd->gpd_proto = dproto;
102   gpd->gpd_sw_if_index = sw_if_index;
103   gpd->gpd_epg = epg;
104
105   if (~0 != sw_if_index)
106     {
107       /*
108        * stack on the DVR DPO for the output interface
109        */
110       dvr_dpo_add_or_lock (sw_if_index, dproto, &parent);
111     }
112   else
113     {
114       dpo_copy (&parent, drop_dpo_get (dproto));
115     }
116
117   dpo_stack (gbp_policy_dpo_type, dproto, &gpd->gpd_dpo, &parent);
118   dpo_set (dpo, gbp_policy_dpo_type, dproto, gbp_policy_dpo_get_index (gpd));
119 }
120
121 u8 *
122 format_gbp_policy_dpo (u8 * s, va_list * ap)
123 {
124   index_t index = va_arg (*ap, index_t);
125   u32 indent = va_arg (*ap, u32);
126   gbp_policy_dpo_t *gpd = gbp_policy_dpo_get (index);
127   vnet_main_t *vnm = vnet_get_main ();
128
129   s = format (s, "gbp-policy-dpo: %U, epg:%d out:%U",
130               format_dpo_proto, gpd->gpd_proto,
131               gpd->gpd_epg,
132               format_vnet_sw_if_index_name, vnm, gpd->gpd_sw_if_index);
133   s = format (s, "\n%U", format_white_space, indent + 2);
134   s = format (s, "%U", format_dpo_id, &gpd->gpd_dpo, indent + 4);
135
136   return (s);
137 }
138
139 /**
140  * Interpose a policy DPO
141  */
142 static void
143 gbp_policy_dpo_interpose (const dpo_id_t * original,
144                           const dpo_id_t * parent, dpo_id_t * clone)
145 {
146   gbp_policy_dpo_t *gpd, *gpd_clone;
147
148   gpd_clone = gbp_policy_dpo_alloc ();
149   gpd = gbp_policy_dpo_get (original->dpoi_index);
150
151   gpd_clone->gpd_proto = gpd->gpd_proto;
152   gpd_clone->gpd_epg = gpd->gpd_epg;
153   gpd_clone->gpd_sw_if_index = gpd->gpd_sw_if_index;
154
155   dpo_stack (gbp_policy_dpo_type,
156              gpd_clone->gpd_proto, &gpd_clone->gpd_dpo, parent);
157
158   dpo_set (clone,
159            gbp_policy_dpo_type,
160            gpd_clone->gpd_proto, gbp_policy_dpo_get_index (gpd_clone));
161 }
162
163 const static dpo_vft_t gbp_policy_dpo_vft = {
164   .dv_lock = gbp_policy_dpo_lock,
165   .dv_unlock = gbp_policy_dpo_unlock,
166   .dv_format = format_gbp_policy_dpo,
167   .dv_get_urpf = gbp_policy_dpo_get_urpf,
168   .dv_mk_interpose = gbp_policy_dpo_interpose,
169 };
170
171 /**
172  * @brief The per-protocol VLIB graph nodes that are assigned to a glean
173  *        object.
174  *
175  * this means that these graph nodes are ones from which a glean is the
176  * parent object in the DPO-graph.
177  */
178 const static char *const gbp_policy_dpo_ip4_nodes[] = {
179   "ip4-gbp-policy-dpo",
180   NULL,
181 };
182
183 const static char *const gbp_policy_dpo_ip6_nodes[] = {
184   "ip6-gbp-policy-dpo",
185   NULL,
186 };
187
188 const static char *const *const gbp_policy_dpo_nodes[DPO_PROTO_NUM] = {
189   [DPO_PROTO_IP4] = gbp_policy_dpo_ip4_nodes,
190   [DPO_PROTO_IP6] = gbp_policy_dpo_ip6_nodes,
191 };
192
193 dpo_type_t
194 gbp_policy_dpo_get_type (void)
195 {
196   return (gbp_policy_dpo_type);
197 }
198
199 static clib_error_t *
200 gbp_policy_dpo_module_init (vlib_main_t * vm)
201 {
202   gbp_policy_dpo_type = dpo_register_new_type (&gbp_policy_dpo_vft,
203                                                gbp_policy_dpo_nodes);
204
205   return (NULL);
206 }
207
208 VLIB_INIT_FUNCTION (gbp_policy_dpo_module_init);
209
210 typedef struct gbp_policy_dpo_trace_t_
211 {
212   u32 src_epg;
213   u32 dst_epg;
214   u32 acl_index;
215   u32 a_bit;
216 } gbp_policy_dpo_trace_t;
217
218 typedef enum
219 {
220   GBP_POLICY_DROP,
221   GBP_POLICY_N_NEXT,
222 } gbp_policy_next_t;
223
224 always_inline u32
225 gbp_rule_l3_redirect (const gbp_rule_t * gu, vlib_buffer_t * b0, int is_ip6)
226 {
227   gbp_policy_node_t pnode;
228   const dpo_id_t *dpo;
229   dpo_proto_t dproto;
230
231   pnode = (is_ip6 ? GBP_POLICY_NODE_IP6 : GBP_POLICY_NODE_IP4);
232   dproto = (is_ip6 ? DPO_PROTO_IP6 : DPO_PROTO_IP4);
233   dpo = &gu->gu_dpo[pnode][dproto];
234
235   /* The flow hash is still valid as this is a IP packet being switched */
236   vnet_buffer (b0)->ip.adj_index[VLIB_TX] = dpo->dpoi_index;
237
238   return (dpo->dpoi_next_node);
239 }
240
241 always_inline uword
242 gbp_policy_dpo_inline (vlib_main_t * vm,
243                        vlib_node_runtime_t * node,
244                        vlib_frame_t * from_frame, u8 is_ip6)
245 {
246   gbp_main_t *gm = &gbp_main;
247   u32 n_left_from, next_index, *from, *to_next;
248   gbp_rule_t *gu;
249
250   from = vlib_frame_vector_args (from_frame);
251   n_left_from = from_frame->n_vectors;
252
253   next_index = node->cached_next_index;
254
255   while (n_left_from > 0)
256     {
257       u32 n_left_to_next;
258
259       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
260
261       while (n_left_from > 0 && n_left_to_next > 0)
262         {
263           const gbp_policy_dpo_t *gpd0;
264           u32 bi0, next0;
265           gbp_contract_key_t key0;
266           gbp_contract_t *gc0;
267           vlib_buffer_t *b0;
268           index_t gci0;
269
270           bi0 = from[0];
271           to_next[0] = bi0;
272           from += 1;
273           to_next += 1;
274           n_left_from -= 1;
275           n_left_to_next -= 1;
276           next0 = GBP_POLICY_DROP;
277
278           b0 = vlib_get_buffer (vm, bi0);
279
280           gc0 = NULL;
281           gpd0 = gbp_policy_dpo_get (vnet_buffer (b0)->ip.adj_index[VLIB_TX]);
282           vnet_buffer (b0)->ip.adj_index[VLIB_TX] = gpd0->gpd_dpo.dpoi_index;
283
284           if (vnet_buffer2 (b0)->gbp.flags & VXLAN_GBP_GPFLAGS_A)
285             {
286               next0 = gpd0->gpd_dpo.dpoi_next_node;
287               key0.as_u32 = ~0;
288               goto trace;
289             }
290
291           key0.gck_src = vnet_buffer2 (b0)->gbp.src_epg;
292           key0.gck_dst = gpd0->gpd_epg;
293
294           if (EPG_INVALID != key0.gck_src)
295             {
296               if (PREDICT_FALSE (key0.gck_src == key0.gck_dst))
297                 {
298                   /*
299                    * intra-epg allowed
300                    */
301                   next0 = gpd0->gpd_dpo.dpoi_next_node;
302                   vnet_buffer2 (b0)->gbp.flags |= VXLAN_GBP_GPFLAGS_A;
303                 }
304               else
305                 {
306                   gci0 = gbp_contract_find (&key0);
307
308                   if (INDEX_INVALID != gci0)
309                     {
310                       fa_5tuple_opaque_t pkt_5tuple0;
311                       u8 action0 = 0;
312                       u32 acl_pos_p0, acl_match_p0;
313                       u32 rule_match_p0, trace_bitmap0;
314                       /*
315                        * tests against the ACL
316                        */
317                       gc0 = gbp_contract_get (gci0);
318                       acl_plugin_fill_5tuple_inline (gm->
319                                                      acl_plugin.p_acl_main,
320                                                      gc0->gc_lc_index, b0,
321                                                      is_ip6,
322                                                      /* is_input */ 1,
323                                                      /* is_l2_path */ 0,
324                                                      &pkt_5tuple0);
325                       acl_plugin_match_5tuple_inline (gm->
326                                                       acl_plugin.p_acl_main,
327                                                       gc0->gc_lc_index,
328                                                       &pkt_5tuple0, is_ip6,
329                                                       &action0, &acl_pos_p0,
330                                                       &acl_match_p0,
331                                                       &rule_match_p0,
332                                                       &trace_bitmap0);
333
334                       if (action0 > 0)
335                         {
336
337                           vnet_buffer2 (b0)->gbp.flags |= VXLAN_GBP_GPFLAGS_A;
338                           gu = gbp_rule_get (gc0->gc_rules[rule_match_p0]);
339
340                           switch (gu->gu_action)
341                             {
342                             case GBP_RULE_PERMIT:
343                               next0 = gpd0->gpd_dpo.dpoi_next_node;
344                               break;
345                             case GBP_RULE_DENY:
346                               ASSERT (0);
347                               next0 = 0;
348                               break;
349                             case GBP_RULE_REDIRECT:
350                               next0 = gbp_rule_l3_redirect (gu, b0, is_ip6);
351                               break;
352                             }
353                         }
354                     }
355                 }
356             }
357           else
358             {
359               /*
360                * the src EPG is not set when the packet arrives on an EPG
361                * uplink interface and we do not need to apply policy
362                */
363               next0 = gpd0->gpd_dpo.dpoi_next_node;
364             }
365         trace:
366           if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
367             {
368               gbp_policy_dpo_trace_t *tr;
369
370               tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
371               tr->src_epg = key0.gck_src;
372               tr->dst_epg = key0.gck_dst;
373               tr->acl_index = (gc0 ? gc0->gc_acl_index : ~0);
374               tr->a_bit = vnet_buffer2 (b0)->gbp.flags & VXLAN_GBP_GPFLAGS_A;
375             }
376
377           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
378                                            n_left_to_next, bi0, next0);
379         }
380       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
381     }
382   return from_frame->n_vectors;
383 }
384
385 static u8 *
386 format_gbp_policy_dpo_trace (u8 * s, va_list * args)
387 {
388   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
389   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
390   gbp_policy_dpo_trace_t *t = va_arg (*args, gbp_policy_dpo_trace_t *);
391
392   s = format (s, " src-epg:%d dst-epg:%d acl-index:%d a-bit:%d",
393               t->src_epg, t->dst_epg, t->acl_index, t->a_bit);
394
395   return s;
396 }
397
398 static uword
399 ip4_gbp_policy_dpo (vlib_main_t * vm,
400                     vlib_node_runtime_t * node, vlib_frame_t * from_frame)
401 {
402   return (gbp_policy_dpo_inline (vm, node, from_frame, 0));
403 }
404
405 static uword
406 ip6_gbp_policy_dpo (vlib_main_t * vm,
407                     vlib_node_runtime_t * node, vlib_frame_t * from_frame)
408 {
409   return (gbp_policy_dpo_inline (vm, node, from_frame, 1));
410 }
411
412 /* *INDENT-OFF* */
413 VLIB_REGISTER_NODE (ip4_gbp_policy_dpo_node) = {
414     .function = ip4_gbp_policy_dpo,
415     .name = "ip4-gbp-policy-dpo",
416     .vector_size = sizeof (u32),
417     .format_trace = format_gbp_policy_dpo_trace,
418     .n_next_nodes = GBP_POLICY_N_NEXT,
419     .next_nodes =
420     {
421         [GBP_POLICY_DROP] = "ip4-drop",
422     }
423 };
424 VLIB_REGISTER_NODE (ip6_gbp_policy_dpo_node) = {
425     .function = ip6_gbp_policy_dpo,
426     .name = "ip6-gbp-policy-dpo",
427     .vector_size = sizeof (u32),
428     .format_trace = format_gbp_policy_dpo_trace,
429     .n_next_nodes = GBP_POLICY_N_NEXT,
430     .next_nodes =
431     {
432         [GBP_POLICY_DROP] = "ip6-drop",
433     }
434 };
435
436 VLIB_NODE_FUNCTION_MULTIARCH (ip4_gbp_policy_dpo_node, ip4_gbp_policy_dpo)
437 VLIB_NODE_FUNCTION_MULTIARCH (ip6_gbp_policy_dpo_node, ip6_gbp_policy_dpo)
438 /* *INDENT-ON* */
439
440 /*
441  * fd.io coding-style-patch-verification: ON
442  *
443  * Local Variables:
444  * eval: (c-set-style "gnu")
445  * End:
446  */