misc: deprecate gbp and its dependents
[vpp.git] / extras / deprecated / vnet / vxlan-gbp / vxlan_gbp.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 #include <vnet/vxlan-gbp/vxlan_gbp.h>
16 #include <vnet/ip/format.h>
17 #include <vnet/ip/punt.h>
18 #include <vnet/fib/fib_entry.h>
19 #include <vnet/fib/fib_table.h>
20 #include <vnet/fib/fib_entry_track.h>
21 #include <vnet/mfib/mfib_table.h>
22 #include <vnet/adj/adj_mcast.h>
23 #include <vnet/adj/rewrite.h>
24 #include <vnet/interface.h>
25 #include <vlib/vlib.h>
26
27 /**
28  * @file
29  * @brief VXLAN GBP.
30  *
31  * VXLAN GBP provides the features of vxlan and carry group policy id.
32  */
33 static vlib_punt_hdl_t punt_hdl;
34
35 vxlan_gbp_main_t vxlan_gbp_main;
36
37 u8 *
38 format_vxlan_gbp_tunnel_mode (u8 * s, va_list * args)
39 {
40   vxlan_gbp_tunnel_mode_t mode = va_arg (*args, vxlan_gbp_tunnel_mode_t);
41
42   switch (mode)
43     {
44     case VXLAN_GBP_TUNNEL_MODE_L2:
45       s = format (s, "L2");
46       break;
47     case VXLAN_GBP_TUNNEL_MODE_L3:
48       s = format (s, "L3");
49       break;
50     }
51   return (s);
52 }
53
54 u8 *
55 format_vxlan_gbp_tunnel (u8 * s, va_list * args)
56 {
57   vxlan_gbp_tunnel_t *t = va_arg (*args, vxlan_gbp_tunnel_t *);
58
59   s = format (s,
60               "[%d] instance %d src %U dst %U vni %d fib-idx %d"
61               " sw-if-idx %d mode %U ",
62               t->dev_instance, t->user_instance,
63               format_ip46_address, &t->src, IP46_TYPE_ANY,
64               format_ip46_address, &t->dst, IP46_TYPE_ANY,
65               t->vni, t->encap_fib_index, t->sw_if_index,
66               format_vxlan_gbp_tunnel_mode, t->mode);
67
68   s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
69
70   if (PREDICT_FALSE (ip46_address_is_multicast (&t->dst)))
71     s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
72
73   return s;
74 }
75
76 static u8 *
77 format_vxlan_gbp_name (u8 * s, va_list * args)
78 {
79   u32 dev_instance = va_arg (*args, u32);
80   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
81   vxlan_gbp_tunnel_t *t;
82
83   if (dev_instance == ~0)
84     return format (s, "<cached-unused>");
85
86   if (dev_instance >= vec_len (vxm->tunnels))
87     return format (s, "<improperly-referenced>");
88
89   t = pool_elt_at_index (vxm->tunnels, dev_instance);
90
91   return format (s, "vxlan_gbp_tunnel%d", t->user_instance);
92 }
93
94 static clib_error_t *
95 vxlan_gbp_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
96                                    u32 flags)
97 {
98   u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
99     VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
100   vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
101
102   return /* no error */ 0;
103 }
104
105 /* *INDENT-OFF* */
106 VNET_DEVICE_CLASS (vxlan_gbp_device_class, static) = {
107   .name = "VXLAN-GBP",
108   .format_device_name = format_vxlan_gbp_name,
109   .format_tx_trace = format_vxlan_gbp_encap_trace,
110   .admin_up_down_function = vxlan_gbp_interface_admin_up_down,
111 };
112 /* *INDENT-ON* */
113
114 static u8 *
115 format_vxlan_gbp_header_with_length (u8 * s, va_list * args)
116 {
117   u32 dev_instance = va_arg (*args, u32);
118   s = format (s, "unimplemented dev %u", dev_instance);
119   return s;
120 }
121
122 /* *INDENT-OFF* */
123 VNET_HW_INTERFACE_CLASS (vxlan_gbp_hw_class) = {
124   .name = "VXLAN-GBP",
125   .format_header = format_vxlan_gbp_header_with_length,
126   .build_rewrite = default_build_rewrite,
127 };
128 /* *INDENT-ON* */
129
130 static void
131 vxlan_gbp_tunnel_restack_dpo (vxlan_gbp_tunnel_t * t)
132 {
133   u8 is_ip4 = ip46_address_is_ip4 (&t->dst);
134   dpo_id_t dpo = DPO_INVALID;
135   fib_forward_chain_type_t forw_type = is_ip4 ?
136     FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
137
138   fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
139
140   /* vxlan_gbp uses the payload hash as the udp source port
141    * hence the packet's hash is unknown
142    * skip single bucket load balance dpo's */
143   while (DPO_LOAD_BALANCE == dpo.dpoi_type)
144     {
145       load_balance_t *lb = load_balance_get (dpo.dpoi_index);
146       if (lb->lb_n_buckets > 1)
147         break;
148
149       dpo_copy (&dpo, load_balance_get_bucket_i (lb, 0));
150     }
151
152   u32 encap_index = is_ip4 ?
153     vxlan4_gbp_encap_node.index : vxlan6_gbp_encap_node.index;
154   dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
155   dpo_reset (&dpo);
156 }
157
158 static vxlan_gbp_tunnel_t *
159 vxlan_gbp_tunnel_from_fib_node (fib_node_t * node)
160 {
161   ASSERT (FIB_NODE_TYPE_VXLAN_GBP_TUNNEL == node->fn_type);
162   return ((vxlan_gbp_tunnel_t *) (((char *) node) -
163                                   STRUCT_OFFSET_OF (vxlan_gbp_tunnel_t,
164                                                     node)));
165 }
166
167 /**
168  * Function definition to backwalk a FIB node -
169  * Here we will restack the new dpo of VXLAN DIP to encap node.
170  */
171 static fib_node_back_walk_rc_t
172 vxlan_gbp_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
173 {
174   vxlan_gbp_tunnel_restack_dpo (vxlan_gbp_tunnel_from_fib_node (node));
175   return (FIB_NODE_BACK_WALK_CONTINUE);
176 }
177
178 /**
179  * Function definition to get a FIB node from its index
180  */
181 static fib_node_t *
182 vxlan_gbp_tunnel_fib_node_get (fib_node_index_t index)
183 {
184   vxlan_gbp_tunnel_t *t;
185   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
186
187   t = pool_elt_at_index (vxm->tunnels, index);
188
189   return (&t->node);
190 }
191
192 /**
193  * Function definition to inform the FIB node that its last lock has gone.
194  */
195 static void
196 vxlan_gbp_tunnel_last_lock_gone (fib_node_t * node)
197 {
198   /*
199    * The VXLAN GBP tunnel is a root of the graph. As such
200    * it never has children and thus is never locked.
201    */
202   ASSERT (0);
203 }
204
205 /*
206  * Virtual function table registered by VXLAN GBP tunnels
207  * for participation in the FIB object graph.
208  */
209 const static fib_node_vft_t vxlan_gbp_vft = {
210   .fnv_get = vxlan_gbp_tunnel_fib_node_get,
211   .fnv_last_lock = vxlan_gbp_tunnel_last_lock_gone,
212   .fnv_back_walk = vxlan_gbp_tunnel_back_walk,
213 };
214
215
216 #define foreach_copy_field                      \
217 _(vni)                                          \
218 _(mode)                                         \
219 _(mcast_sw_if_index)                            \
220 _(encap_fib_index)                              \
221 _(src)                                          \
222 _(dst)
223
224 static void
225 vxlan_gbp_rewrite (vxlan_gbp_tunnel_t * t, bool is_ip6)
226 {
227   union
228   {
229     ip4_vxlan_gbp_header_t h4;
230     ip6_vxlan_gbp_header_t h6;
231   } h;
232   int len = is_ip6 ? sizeof h.h6 : sizeof h.h4;
233
234   udp_header_t *udp;
235   vxlan_gbp_header_t *vxlan_gbp;
236   /* Fixed portion of the (outer) ip header */
237
238   clib_memset (&h, 0, sizeof (h));
239   if (!is_ip6)
240     {
241       ip4_header_t *ip = &h.h4.ip4;
242       udp = &h.h4.udp, vxlan_gbp = &h.h4.vxlan_gbp;
243       ip->ip_version_and_header_length = 0x45;
244       ip->ttl = 254;
245       ip->protocol = IP_PROTOCOL_UDP;
246
247       ip->src_address = t->src.ip4;
248       ip->dst_address = t->dst.ip4;
249
250       /* we fix up the ip4 header length and checksum after-the-fact */
251       ip->checksum = ip4_header_checksum (ip);
252     }
253   else
254     {
255       ip6_header_t *ip = &h.h6.ip6;
256       udp = &h.h6.udp, vxlan_gbp = &h.h6.vxlan_gbp;
257       ip->ip_version_traffic_class_and_flow_label =
258         clib_host_to_net_u32 (6 << 28);
259       ip->hop_limit = 255;
260       ip->protocol = IP_PROTOCOL_UDP;
261
262       ip->src_address = t->src.ip6;
263       ip->dst_address = t->dst.ip6;
264     }
265
266   /* UDP header, randomize src port on something, maybe? */
267   udp->src_port = clib_host_to_net_u16 (47789);
268   udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan_gbp);
269
270   /* VXLAN header */
271   vxlan_gbp_set_header (vxlan_gbp, t->vni);
272   vnet_rewrite_set_data (*t, &h, len);
273 }
274
275 static uword
276 vtep_addr_ref (ip46_address_t * ip)
277 {
278   uword *vtep = ip46_address_is_ip4 (ip) ?
279     hash_get (vxlan_gbp_main.vtep4, ip->ip4.as_u32) :
280     hash_get_mem (vxlan_gbp_main.vtep6, &ip->ip6);
281   if (vtep)
282     return ++(*vtep);
283   ip46_address_is_ip4 (ip) ?
284     hash_set (vxlan_gbp_main.vtep4, ip->ip4.as_u32, 1) :
285     hash_set_mem_alloc (&vxlan_gbp_main.vtep6, &ip->ip6, 1);
286   return 1;
287 }
288
289 static uword
290 vtep_addr_unref (ip46_address_t * ip)
291 {
292   uword *vtep = ip46_address_is_ip4 (ip) ?
293     hash_get (vxlan_gbp_main.vtep4, ip->ip4.as_u32) :
294     hash_get_mem (vxlan_gbp_main.vtep6, &ip->ip6);
295   ALWAYS_ASSERT (vtep);
296   if (--(*vtep) != 0)
297     return *vtep;
298   ip46_address_is_ip4 (ip) ?
299     hash_unset (vxlan_gbp_main.vtep4, ip->ip4.as_u32) :
300     hash_unset_mem_free (&vxlan_gbp_main.vtep6, &ip->ip6);
301   return 0;
302 }
303
304 /* *INDENT-OFF* */
305 typedef CLIB_PACKED(union
306 {
307   struct
308   {
309     fib_node_index_t mfib_entry_index;
310     adj_index_t mcast_adj_index;
311   };
312   u64 as_u64;
313 }) mcast_shared_t;
314 /* *INDENT-ON* */
315
316 static inline mcast_shared_t
317 mcast_shared_get (ip46_address_t * ip)
318 {
319   ASSERT (ip46_address_is_multicast (ip));
320   uword *p = hash_get_mem (vxlan_gbp_main.mcast_shared, ip);
321   ALWAYS_ASSERT (p);
322   mcast_shared_t ret = {.as_u64 = *p };
323   return ret;
324 }
325
326 static inline void
327 mcast_shared_add (ip46_address_t * dst, fib_node_index_t mfei, adj_index_t ai)
328 {
329   mcast_shared_t new_ep = {
330     .mcast_adj_index = ai,
331     .mfib_entry_index = mfei,
332   };
333
334   hash_set_mem_alloc (&vxlan_gbp_main.mcast_shared, dst, new_ep.as_u64);
335 }
336
337 static inline void
338 mcast_shared_remove (ip46_address_t * dst)
339 {
340   mcast_shared_t ep = mcast_shared_get (dst);
341
342   adj_unlock (ep.mcast_adj_index);
343   mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_VXLAN_GBP);
344
345   hash_unset_mem_free (&vxlan_gbp_main.mcast_shared, dst);
346 }
347
348 inline void
349 vxlan_gbp_register_udp_ports (void)
350 {
351   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
352
353   if (vxm->udp_ports_registered == 0)
354     {
355       udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan_gbp,
356                              vxlan4_gbp_input_node.index, /* is_ip4 */ 1);
357       udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan6_gbp,
358                              vxlan6_gbp_input_node.index, /* is_ip4 */ 0);
359     }
360   /*
361    * Counts the number of vxlan_gbp tunnels
362    */
363   vxm->udp_ports_registered += 1;
364 }
365
366 inline void
367 vxlan_gbp_unregister_udp_ports (void)
368 {
369   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
370
371   ASSERT (vxm->udp_ports_registered != 0);
372
373   if (vxm->udp_ports_registered == 1)
374     {
375       udp_unregister_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan_gbp,
376                                /* is_ip4 */ 1);
377       udp_unregister_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan6_gbp,
378                                /* is_ip4 */ 0);
379     }
380
381   vxm->udp_ports_registered -= 1;
382 }
383
384 int vnet_vxlan_gbp_tunnel_add_del
385   (vnet_vxlan_gbp_tunnel_add_del_args_t * a, u32 * sw_if_indexp)
386 {
387   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
388   vxlan_gbp_tunnel_t *t = 0;
389   vnet_main_t *vnm = vxm->vnet_main;
390   u64 *p;
391   u32 sw_if_index = ~0;
392   vxlan4_gbp_tunnel_key_t key4;
393   vxlan6_gbp_tunnel_key_t key6;
394   u32 is_ip6 = a->is_ip6;
395
396   int not_found;
397   if (!is_ip6)
398     {
399       key4.key[0] = ip46_address_is_multicast (&a->dst) ?
400         a->dst.ip4.as_u32 :
401         a->dst.ip4.as_u32 | (((u64) a->src.ip4.as_u32) << 32);
402       key4.key[1] = (((u64) a->encap_fib_index) << 32)
403         | clib_host_to_net_u32 (a->vni << 8);
404       not_found =
405         clib_bihash_search_inline_16_8 (&vxm->vxlan4_gbp_tunnel_by_key,
406                                         &key4);
407       p = &key4.value;
408     }
409   else
410     {
411       key6.key[0] = a->dst.ip6.as_u64[0];
412       key6.key[1] = a->dst.ip6.as_u64[1];
413       key6.key[2] = (((u64) a->encap_fib_index) << 32)
414         | clib_host_to_net_u32 (a->vni << 8);
415       not_found =
416         clib_bihash_search_inline_24_8 (&vxm->vxlan6_gbp_tunnel_by_key,
417                                         &key6);
418       p = &key6.value;
419     }
420
421   if (not_found)
422     p = 0;
423
424   if (a->is_add)
425     {
426       l2input_main_t *l2im = &l2input_main;
427       u32 dev_instance;         /* real dev instance tunnel index */
428       u32 user_instance;        /* request and actual instance number */
429
430       /* adding a tunnel: tunnel must not already exist */
431       if (p)
432         {
433           t = pool_elt_at_index (vxm->tunnels, *p);
434           *sw_if_indexp = t->sw_if_index;
435           return VNET_API_ERROR_TUNNEL_EXIST;
436         }
437       pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
438       clib_memset (t, 0, sizeof (*t));
439       dev_instance = t - vxm->tunnels;
440
441       /* copy from arg structure */
442 #define _(x) t->x = a->x;
443       foreach_copy_field;
444 #undef _
445
446       vxlan_gbp_rewrite (t, is_ip6);
447       /*
448        * Reconcile the real dev_instance and a possible requested instance.
449        */
450       user_instance = a->instance;
451       if (user_instance == ~0)
452         user_instance = dev_instance;
453       if (hash_get (vxm->instance_used, user_instance))
454         {
455           pool_put (vxm->tunnels, t);
456           return VNET_API_ERROR_INSTANCE_IN_USE;
457         }
458       hash_set (vxm->instance_used, user_instance, 1);
459
460       t->dev_instance = dev_instance;   /* actual */
461       t->user_instance = user_instance; /* name */
462
463       /* copy the key */
464       int add_failed;
465       if (is_ip6)
466         {
467           key6.value = (u64) dev_instance;
468           add_failed =
469             clib_bihash_add_del_24_8 (&vxm->vxlan6_gbp_tunnel_by_key, &key6,
470                                       1 /*add */ );
471         }
472       else
473         {
474           key4.value = (u64) dev_instance;
475           add_failed =
476             clib_bihash_add_del_16_8 (&vxm->vxlan4_gbp_tunnel_by_key, &key4,
477                                       1 /*add */ );
478         }
479
480       if (add_failed)
481         {
482           pool_put (vxm->tunnels, t);
483           return VNET_API_ERROR_INVALID_REGISTRATION;
484         }
485
486       vxlan_gbp_register_udp_ports ();
487
488       t->hw_if_index = vnet_register_interface
489         (vnm, vxlan_gbp_device_class.index, dev_instance,
490          vxlan_gbp_hw_class.index, dev_instance);
491       vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, t->hw_if_index);
492
493       /* Set vxlan_gbp tunnel output node */
494       u32 encap_index = !is_ip6 ?
495         vxlan4_gbp_encap_node.index : vxlan6_gbp_encap_node.index;
496       vnet_set_interface_output_node (vnm, t->hw_if_index, encap_index);
497
498       t->sw_if_index = sw_if_index = hi->sw_if_index;
499
500       if (VXLAN_GBP_TUNNEL_MODE_L3 == t->mode)
501         {
502           ip4_sw_interface_enable_disable (t->sw_if_index, 1);
503           ip6_sw_interface_enable_disable (t->sw_if_index, 1);
504         }
505
506       vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index,
507                                ~0);
508       vxm->tunnel_index_by_sw_if_index[sw_if_index] = dev_instance;
509
510       /* setup l2 input config with l2 feature and bd 0 to drop packet */
511       vec_validate (l2im->configs, sw_if_index);
512       l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
513       l2im->configs[sw_if_index].bd_index = 0;
514
515       vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
516       si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
517       vnet_sw_interface_set_flags (vnm, sw_if_index,
518                                    VNET_SW_INTERFACE_FLAG_ADMIN_UP);
519
520       fib_node_init (&t->node, FIB_NODE_TYPE_VXLAN_GBP_TUNNEL);
521       fib_prefix_t tun_dst_pfx;
522       vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
523
524       fib_prefix_from_ip46_addr (&t->dst, &tun_dst_pfx);
525       if (!ip46_address_is_multicast (&t->dst))
526         {
527           /* Unicast tunnel -
528            * source the FIB entry for the tunnel's destination
529            * and become a child thereof. The tunnel will then get poked
530            * when the forwarding for the entry updates, and the tunnel can
531            * re-stack accordingly
532            */
533           vtep_addr_ref (&t->src);
534           t->fib_entry_index = fib_entry_track (t->encap_fib_index,
535                                                 &tun_dst_pfx,
536                                                 FIB_NODE_TYPE_VXLAN_GBP_TUNNEL,
537                                                 dev_instance,
538                                                 &t->sibling_index);
539           vxlan_gbp_tunnel_restack_dpo (t);
540         }
541       else
542         {
543           /* Multicast tunnel -
544            * as the same mcast group can be used for multiple mcast tunnels
545            * with different VNIs, create the output fib adjacency only if
546            * it does not already exist
547            */
548           fib_protocol_t fp = fib_ip_proto (is_ip6);
549
550           if (vtep_addr_ref (&t->dst) == 1)
551             {
552               fib_node_index_t mfei;
553               adj_index_t ai;
554               fib_route_path_t path = {
555                 .frp_proto = fib_proto_to_dpo (fp),
556                 .frp_addr = zero_addr,
557                 .frp_sw_if_index = 0xffffffff,
558                 .frp_fib_index = ~0,
559                 .frp_weight = 0,
560                 .frp_flags = FIB_ROUTE_PATH_LOCAL,
561                 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
562               };
563               const mfib_prefix_t mpfx = {
564                 .fp_proto = fp,
565                 .fp_len = (is_ip6 ? 128 : 32),
566                 .fp_grp_addr = tun_dst_pfx.fp_addr,
567               };
568
569               /*
570                * Setup the (*,G) to receive traffic on the mcast group
571                *  - the forwarding interface is for-us
572                *  - the accepting interface is that from the API
573                */
574               mfib_table_entry_path_update (t->encap_fib_index, &mpfx,
575                                             MFIB_SOURCE_VXLAN_GBP,
576                                             MFIB_ENTRY_FLAG_NONE, &path);
577
578               path.frp_sw_if_index = a->mcast_sw_if_index;
579               path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
580               path.frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT;
581               mfei = mfib_table_entry_path_update (
582                 t->encap_fib_index, &mpfx, MFIB_SOURCE_VXLAN_GBP,
583                 MFIB_ENTRY_FLAG_NONE, &path);
584
585               /*
586                * Create the mcast adjacency to send traffic to the group
587                */
588               ai = adj_mcast_add_or_lock (fp,
589                                           fib_proto_to_link (fp),
590                                           a->mcast_sw_if_index);
591
592               /*
593                * create a new end-point
594                */
595               mcast_shared_add (&t->dst, mfei, ai);
596             }
597
598           dpo_id_t dpo = DPO_INVALID;
599           mcast_shared_t ep = mcast_shared_get (&t->dst);
600
601           /* Stack shared mcast dst mac addr rewrite on encap */
602           dpo_set (&dpo, DPO_ADJACENCY_MCAST,
603                    fib_proto_to_dpo (fp), ep.mcast_adj_index);
604
605           dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
606           dpo_reset (&dpo);
607           flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
608         }
609
610       vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
611         flood_class;
612     }
613   else
614     {
615       /* deleting a tunnel: tunnel must exist */
616       if (!p)
617         return VNET_API_ERROR_NO_SUCH_ENTRY;
618
619       u32 instance = p[0];
620       t = pool_elt_at_index (vxm->tunnels, instance);
621
622       sw_if_index = t->sw_if_index;
623       vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
624
625       if (VXLAN_GBP_TUNNEL_MODE_L3 == t->mode)
626         {
627           ip4_sw_interface_enable_disable (t->sw_if_index, 0);
628           ip6_sw_interface_enable_disable (t->sw_if_index, 0);
629         }
630
631       vxm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
632
633       if (!is_ip6)
634         clib_bihash_add_del_16_8 (&vxm->vxlan4_gbp_tunnel_by_key, &key4,
635                                   0 /*del */ );
636       else
637         clib_bihash_add_del_24_8 (&vxm->vxlan6_gbp_tunnel_by_key, &key6,
638                                   0 /*del */ );
639
640       if (!ip46_address_is_multicast (&t->dst))
641         {
642           vtep_addr_unref (&t->src);
643           fib_entry_untrack (t->fib_entry_index, t->sibling_index);
644         }
645       else if (vtep_addr_unref (&t->dst) == 0)
646         {
647           mcast_shared_remove (&t->dst);
648         }
649
650       vxlan_gbp_unregister_udp_ports ();
651       vnet_delete_hw_interface (vnm, t->hw_if_index);
652       hash_unset (vxm->instance_used, t->user_instance);
653
654       fib_node_deinit (&t->node);
655       pool_put (vxm->tunnels, t);
656     }
657
658   if (sw_if_indexp)
659     *sw_if_indexp = sw_if_index;
660
661   return 0;
662 }
663
664 int
665 vnet_vxlan_gbp_tunnel_del (u32 sw_if_index)
666 {
667   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
668   vxlan_gbp_tunnel_t *t = 0;
669   u32 ti;
670
671   if (sw_if_index >= vec_len (vxm->tunnel_index_by_sw_if_index))
672     return VNET_API_ERROR_NO_SUCH_ENTRY;
673
674   ti = vxm->tunnel_index_by_sw_if_index[sw_if_index];
675   if (~0 != ti)
676     {
677       t = pool_elt_at_index (vxm->tunnels, ti);
678
679       vnet_vxlan_gbp_tunnel_add_del_args_t args = {
680         .is_add = 0,
681         .is_ip6 = !ip46_address_is_ip4 (&t->src),
682         .vni = t->vni,
683         .src = t->src,
684         .dst = t->dst,
685         .instance = ~0,
686       };
687
688       return (vnet_vxlan_gbp_tunnel_add_del (&args, NULL));
689     }
690
691   return VNET_API_ERROR_NO_SUCH_ENTRY;
692 }
693
694 static uword
695 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
696 {
697   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
698   vlib_main_t *vm = vxm->vlib_main;
699   uword input_node = (ipv4_set) ? vxlan4_gbp_input_node.index :
700     vxlan6_gbp_input_node.index;
701
702   return vlib_node_add_next (vm, input_node, node_index);
703 }
704
705 static uword
706 unformat_decap_next (unformat_input_t * input, va_list * args)
707 {
708   u32 *result = va_arg (*args, u32 *);
709   u32 ipv4_set = va_arg (*args, int);
710   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
711   vlib_main_t *vm = vxm->vlib_main;
712   u32 node_index;
713   u32 tmp;
714
715   if (unformat (input, "l2"))
716     *result = VXLAN_GBP_INPUT_NEXT_L2_INPUT;
717   else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
718     *result = get_decap_next_for_node (node_index, ipv4_set);
719   else if (unformat (input, "%d", &tmp))
720     *result = tmp;
721   else
722     return 0;
723   return 1;
724 }
725
726 static clib_error_t *
727 vxlan_gbp_tunnel_add_del_command_fn (vlib_main_t * vm,
728                                      unformat_input_t * input,
729                                      vlib_cli_command_t * cmd)
730 {
731   unformat_input_t _line_input, *line_input = &_line_input;
732   ip46_address_t src = ip46_address_initializer, dst =
733     ip46_address_initializer;
734   vxlan_gbp_tunnel_mode_t mode = VXLAN_GBP_TUNNEL_MODE_L2;
735   u8 is_add = 1;
736   u8 src_set = 0;
737   u8 dst_set = 0;
738   u8 grp_set = 0;
739   u8 ipv4_set = 0;
740   u8 ipv6_set = 0;
741   u32 instance = ~0;
742   u32 encap_fib_index = 0;
743   u32 mcast_sw_if_index = ~0;
744   u32 decap_next_index = VXLAN_GBP_INPUT_NEXT_L2_INPUT;
745   u32 vni = 0;
746   u32 table_id;
747   clib_error_t *parse_error = NULL;
748
749   /* Get a line of input. */
750   if (!unformat_user (input, unformat_line_input, line_input))
751     return 0;
752
753   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
754     {
755       if (unformat (line_input, "del"))
756         {
757           is_add = 0;
758         }
759       else if (unformat (line_input, "instance %d", &instance))
760         ;
761       else if (unformat (line_input, "src %U",
762                          unformat_ip46_address, &src, IP46_TYPE_ANY))
763         {
764           src_set = 1;
765           ip46_address_is_ip4 (&src) ? (ipv4_set = 1) : (ipv6_set = 1);
766         }
767       else if (unformat (line_input, "dst %U",
768                          unformat_ip46_address, &dst, IP46_TYPE_ANY))
769         {
770           dst_set = 1;
771           ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
772         }
773       else if (unformat (line_input, "group %U %U",
774                          unformat_ip46_address, &dst, IP46_TYPE_ANY,
775                          unformat_vnet_sw_interface,
776                          vnet_get_main (), &mcast_sw_if_index))
777         {
778           grp_set = dst_set = 1;
779           ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
780         }
781       else if (unformat (line_input, "encap-vrf-id %d", &table_id))
782         {
783           encap_fib_index =
784             fib_table_find (fib_ip_proto (ipv6_set), table_id);
785         }
786       else if (unformat (line_input, "decap-next %U", unformat_decap_next,
787                          &decap_next_index, ipv4_set))
788         ;
789       else if (unformat (line_input, "vni %d", &vni))
790         ;
791       else
792         {
793           parse_error = clib_error_return (0, "parse error: '%U'",
794                                            format_unformat_error, line_input);
795           break;
796         }
797     }
798
799   unformat_free (line_input);
800
801   if (parse_error)
802     return parse_error;
803
804   if (encap_fib_index == ~0)
805     return clib_error_return (0, "nonexistent encap-vrf-id %d", table_id);
806
807   if (src_set == 0)
808     return clib_error_return (0, "tunnel src address not specified");
809
810   if (dst_set == 0)
811     return clib_error_return (0, "tunnel dst address not specified");
812
813   if (grp_set && !ip46_address_is_multicast (&dst))
814     return clib_error_return (0, "tunnel group address not multicast");
815
816   if (grp_set == 0 && ip46_address_is_multicast (&dst))
817     return clib_error_return (0, "dst address must be unicast");
818
819   if (grp_set && mcast_sw_if_index == ~0)
820     return clib_error_return (0, "tunnel nonexistent multicast device");
821
822   if (ipv4_set && ipv6_set)
823     return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
824
825   if (ip46_address_cmp (&src, &dst) == 0)
826     return clib_error_return (0, "src and dst addresses are identical");
827
828   if (decap_next_index == ~0)
829     return clib_error_return (0, "next node not found");
830
831   if (vni == 0)
832     return clib_error_return (0, "vni not specified");
833
834   if (vni >> 24)
835     return clib_error_return (0, "vni %d out of range", vni);
836
837   vnet_vxlan_gbp_tunnel_add_del_args_t a = {
838     .is_add = is_add,
839     .is_ip6 = ipv6_set,
840     .instance = instance,
841 #define _(x) .x = x,
842     foreach_copy_field
843 #undef _
844   };
845
846   u32 tunnel_sw_if_index;
847   int rv = vnet_vxlan_gbp_tunnel_add_del (&a, &tunnel_sw_if_index);
848
849   switch (rv)
850     {
851     case 0:
852       if (is_add)
853         vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
854                          vnet_get_main (), tunnel_sw_if_index);
855       break;
856
857     case VNET_API_ERROR_TUNNEL_EXIST:
858       return clib_error_return (0, "tunnel already exists...");
859
860     case VNET_API_ERROR_NO_SUCH_ENTRY:
861       return clib_error_return (0, "tunnel does not exist...");
862
863     case VNET_API_ERROR_INSTANCE_IN_USE:
864       return clib_error_return (0, "Instance is in use");
865
866     default:
867       return clib_error_return
868         (0, "vnet_vxlan_gbp_tunnel_add_del returned %d", rv);
869     }
870
871   return 0;
872 }
873
874 /*?
875  * Add or delete a VXLAN Tunnel.
876  *
877  * VXLAN provides the features needed to allow L2 bridge domains (BDs)
878  * to span multiple servers. This is done by building an L2 overlay on
879  * top of an L3 network underlay using VXLAN tunnels.
880  *
881  * This makes it possible for servers to be co-located in the same data
882  * center or be separated geographically as long as they are reachable
883  * through the underlay L3 network.
884  *
885  * You can refer to this kind of L2 overlay bridge domain as a VXLAN
886  * (Virtual eXtensible VLAN) segment.
887  *
888  * @cliexpar
889  * Example of how to create a VXLAN Tunnel:
890  * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id 7}
891  * Example of how to create a VXLAN Tunnel with a known name, vxlan_gbp_tunnel42:
892  * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 dst 10.0.3.3 instance 42}
893  * Example of how to create a multicast VXLAN Tunnel with a known name, vxlan_gbp_tunnel23:
894  * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 group 239.1.1.1 GigabitEthernet0/8/0 instance 23}
895  * Example of how to delete a VXLAN Tunnel:
896  * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
897  ?*/
898 /* *INDENT-OFF* */
899 VLIB_CLI_COMMAND (create_vxlan_gbp_tunnel_command, static) = {
900   .path = "create vxlan-gbp tunnel",
901   .short_help =
902   "create vxlan-gbp tunnel src <local-vtep-addr>"
903   " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
904   " [instance <id>]"
905   " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
906   .function = vxlan_gbp_tunnel_add_del_command_fn,
907 };
908 /* *INDENT-ON* */
909
910 static clib_error_t *
911 show_vxlan_gbp_tunnel_command_fn (vlib_main_t * vm,
912                                   unformat_input_t * input,
913                                   vlib_cli_command_t * cmd)
914 {
915   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
916   vxlan_gbp_tunnel_t *t;
917   int raw = 0;
918
919   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
920     {
921       if (unformat (input, "raw"))
922         raw = 1;
923       else
924         return clib_error_return (0, "parse error: '%U'",
925                                   format_unformat_error, input);
926     }
927
928   if (pool_elts (vxm->tunnels) == 0)
929     vlib_cli_output (vm, "No vxlan-gbp tunnels configured...");
930
931 /* *INDENT-OFF* */
932   pool_foreach (t, vxm->tunnels)
933    {
934     vlib_cli_output (vm, "%U", format_vxlan_gbp_tunnel, t);
935   }
936 /* *INDENT-ON* */
937
938   if (raw)
939     {
940       vlib_cli_output (vm, "Raw IPv4 Hash Table:\n%U\n",
941                        format_bihash_16_8, &vxm->vxlan4_gbp_tunnel_by_key,
942                        1 /* verbose */ );
943       vlib_cli_output (vm, "Raw IPv6 Hash Table:\n%U\n",
944                        format_bihash_24_8, &vxm->vxlan6_gbp_tunnel_by_key,
945                        1 /* verbose */ );
946     }
947
948   return 0;
949 }
950
951 /*?
952  * Display all the VXLAN Tunnel entries.
953  *
954  * @cliexpar
955  * Example of how to display the VXLAN Tunnel entries:
956  * @cliexstart{show vxlan_gbp tunnel}
957  * [0] src 10.0.3.1 dst 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
958  * @cliexend
959  ?*/
960 /* *INDENT-OFF* */
961 VLIB_CLI_COMMAND (show_vxlan_gbp_tunnel_command, static) = {
962     .path = "show vxlan-gbp tunnel",
963     .short_help = "show vxlan-gbp tunnel [raw]",
964     .function = show_vxlan_gbp_tunnel_command_fn,
965 };
966 /* *INDENT-ON* */
967
968
969 void
970 vnet_int_vxlan_gbp_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
971 {
972   if (is_ip6)
973     vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-gbp-bypass",
974                                  sw_if_index, is_enable, 0, 0);
975   else
976     vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-gbp-bypass",
977                                  sw_if_index, is_enable, 0, 0);
978 }
979
980
981 static clib_error_t *
982 set_ip_vxlan_gbp_bypass (u32 is_ip6,
983                          unformat_input_t * input, vlib_cli_command_t * cmd)
984 {
985   unformat_input_t _line_input, *line_input = &_line_input;
986   vnet_main_t *vnm = vnet_get_main ();
987   clib_error_t *error = 0;
988   u32 sw_if_index, is_enable;
989
990   sw_if_index = ~0;
991   is_enable = 1;
992
993   if (!unformat_user (input, unformat_line_input, line_input))
994     return 0;
995
996   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
997     {
998       if (unformat_user
999           (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1000         ;
1001       else if (unformat (line_input, "del"))
1002         is_enable = 0;
1003       else
1004         {
1005           error = unformat_parse_error (line_input);
1006           goto done;
1007         }
1008     }
1009
1010   if (~0 == sw_if_index)
1011     {
1012       error = clib_error_return (0, "unknown interface `%U'",
1013                                  format_unformat_error, line_input);
1014       goto done;
1015     }
1016
1017   vnet_int_vxlan_gbp_bypass_mode (sw_if_index, is_ip6, is_enable);
1018
1019 done:
1020   unformat_free (line_input);
1021
1022   return error;
1023 }
1024
1025 static clib_error_t *
1026 set_ip4_vxlan_gbp_bypass (vlib_main_t * vm,
1027                           unformat_input_t * input, vlib_cli_command_t * cmd)
1028 {
1029   return set_ip_vxlan_gbp_bypass (0, input, cmd);
1030 }
1031
1032 /*?
1033  * This command adds the 'ip4-vxlan-gbp-bypass' graph node for a given
1034  * interface. By adding the IPv4 vxlan_gbp-bypass graph node to an interface,
1035  * the node checks for and validate input vxlan_gbp packet and bypass
1036  * ip4-lookup, ip4-local, ip4-udp-lookup nodes to speedup vxlan_gbp packet
1037  * forwarding. This node will cause extra overhead to for non-vxlan_gbp packets
1038  * which is kept at a minimum.
1039  *
1040  * @cliexpar
1041  * @parblock
1042  * Example of graph node before ip4-vxlan_gbp-bypass is enabled:
1043  * @cliexstart{show vlib graph ip4-vxlan_gbp-bypass}
1044  *            Name                      Next                    Previous
1045  * ip4-vxlan-gbp-bypass              error-drop [0]
1046  *                                vxlan4-gbp-input [1]
1047  *                                   ip4-lookup [2]
1048  * @cliexend
1049  *
1050  * Example of how to enable ip4-vxlan-gbp-bypass on an interface:
1051  * @cliexcmd{set interface ip vxlan-gbp-bypass GigabitEthernet2/0/0}
1052  *
1053  * Example of graph node after ip4-vxlan-gbp-bypass is enabled:
1054  * @cliexstart{show vlib graph ip4-vxlan-gbp-bypass}
1055  *            Name             Next                      Previous
1056  * ip4-vxlan-gbp-bypass     error-drop [0]               ip4-input
1057  *                       vxlan4-gbp-input [1]       ip4-input-no-checksum
1058  *                          ip4-lookup [2]
1059  * @cliexend
1060  *
1061  * Example of how to display the feature enabled on an interface:
1062  * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1063  * IP feature paths configured on GigabitEthernet2/0/0...
1064  * ...
1065  * ipv4 unicast:
1066  *   ip4-vxlan-gbp-bypass
1067  *   ip4-lookup
1068  * ...
1069  * @cliexend
1070  *
1071  * Example of how to disable ip4-vxlan-gbp-bypass on an interface:
1072  * @cliexcmd{set interface ip vxlan-gbp-bypass GigabitEthernet2/0/0 del}
1073  * @endparblock
1074 ?*/
1075 /* *INDENT-OFF* */
1076 VLIB_CLI_COMMAND (set_interface_ip_vxlan_gbp_bypass_command, static) = {
1077   .path = "set interface ip vxlan-gbp-bypass",
1078   .function = set_ip4_vxlan_gbp_bypass,
1079   .short_help = "set interface ip vxlan-gbp-bypass <interface> [del]",
1080 };
1081 /* *INDENT-ON* */
1082
1083 static clib_error_t *
1084 set_ip6_vxlan_gbp_bypass (vlib_main_t * vm,
1085                           unformat_input_t * input, vlib_cli_command_t * cmd)
1086 {
1087   return set_ip_vxlan_gbp_bypass (1, input, cmd);
1088 }
1089
1090 /*?
1091  * This command adds the 'ip6-vxlan-gbp-bypass' graph node for a given
1092  * interface. By adding the IPv6 vxlan-gbp-bypass graph node to an interface,
1093  * the node checks for and validate input vxlan_gbp packet and bypass
1094  * ip6-lookup, ip6-local, ip6-udp-lookup nodes to speedup vxlan_gbp packet
1095  * forwarding. This node will cause extra overhead to for non-vxlan packets
1096  * which is kept at a minimum.
1097  *
1098  * @cliexpar
1099  * @parblock
1100  * Example of graph node before ip6-vxlan-gbp-bypass is enabled:
1101  * @cliexstart{show vlib graph ip6-vxlan-gbp-bypass}
1102  *            Name                      Next                    Previous
1103  * ip6-vxlan-gbp-bypass              error-drop [0]
1104  *                                vxlan6-gbp-input [1]
1105  *                                   ip6-lookup [2]
1106  * @cliexend
1107  *
1108  * Example of how to enable ip6-vxlan-gbp-bypass on an interface:
1109  * @cliexcmd{set interface ip6 vxlan-gbp-bypass GigabitEthernet2/0/0}
1110  *
1111  * Example of graph node after ip6-vxlan-gbp-bypass is enabled:
1112  * @cliexstart{show vlib graph ip6-vxlan-gbp-bypass}
1113  *            Name             Next                    Previous
1114  * ip6-vxlan-gbp-bypass     error-drop [0]             ip6-input
1115  *                       vxlan6-gbp-input [1]      ip4-input-no-checksum
1116  *                          ip6-lookup [2]
1117  * @cliexend
1118  *
1119  * Example of how to display the feature enabled on an interface:
1120  * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1121  * IP feature paths configured on GigabitEthernet2/0/0...
1122  * ...
1123  * ipv6 unicast:
1124  *   ip6-vxlan-gbp-bypass
1125  *   ip6-lookup
1126  * ...
1127  * @cliexend
1128  *
1129  * Example of how to disable ip6-vxlan-gbp-bypass on an interface:
1130  * @cliexcmd{set interface ip6 vxlan-gbp-bypass GigabitEthernet2/0/0 del}
1131  * @endparblock
1132 ?*/
1133 /* *INDENT-OFF* */
1134 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_gbp_bypass_command, static) = {
1135   .path = "set interface ip6 vxlan-gbp-bypass",
1136   .function = set_ip6_vxlan_gbp_bypass,
1137   .short_help = "set interface ip6 vxlan-gbp-bypass <interface> [del]",
1138 };
1139 /* *INDENT-ON* */
1140
1141 #define VXLAN_GBP_HASH_NUM_BUCKETS (2 * 1024)
1142 #define VXLAN_GBP_HASH_MEMORY_SIZE (1 << 20)
1143
1144 clib_error_t *
1145 vxlan_gbp_init (vlib_main_t * vm)
1146 {
1147   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
1148
1149   vxm->vnet_main = vnet_get_main ();
1150   vxm->vlib_main = vm;
1151
1152   /* initialize the ip6 hash */
1153   clib_bihash_init_16_8 (&vxm->vxlan4_gbp_tunnel_by_key, "vxlan4-gbp",
1154                          VXLAN_GBP_HASH_NUM_BUCKETS,
1155                          VXLAN_GBP_HASH_MEMORY_SIZE);
1156   clib_bihash_init_24_8 (&vxm->vxlan6_gbp_tunnel_by_key, "vxlan6-gbp",
1157                          VXLAN_GBP_HASH_NUM_BUCKETS,
1158                          VXLAN_GBP_HASH_MEMORY_SIZE);
1159   vxm->vtep6 = hash_create_mem (0, sizeof (ip6_address_t), sizeof (uword));
1160   vxm->mcast_shared = hash_create_mem (0,
1161                                        sizeof (ip46_address_t),
1162                                        sizeof (mcast_shared_t));
1163
1164   fib_node_register_type (FIB_NODE_TYPE_VXLAN_GBP_TUNNEL, &vxlan_gbp_vft);
1165
1166   punt_hdl = vlib_punt_client_register ("vxlan-gbp");
1167
1168   vlib_punt_reason_alloc (punt_hdl, "VXLAN-GBP-no-such-v4-tunnel", NULL, NULL,
1169                           &vxm->punt_no_such_tunnel[FIB_PROTOCOL_IP4],
1170                           VNET_PUNT_REASON_F_IP4_PACKET,
1171                           format_vnet_punt_reason_flags);
1172   vlib_punt_reason_alloc (punt_hdl, "VXLAN-GBP-no-such-v6-tunnel", NULL, NULL,
1173                           &vxm->punt_no_such_tunnel[FIB_PROTOCOL_IP6],
1174                           VNET_PUNT_REASON_F_IP6_PACKET,
1175                           format_vnet_punt_reason_flags);
1176
1177   return (0);
1178 }
1179
1180 /* *INDENT-OFF* */
1181 VLIB_INIT_FUNCTION (vxlan_gbp_init) =
1182 {
1183   .runs_after = VLIB_INITS("punt_init"),
1184 };
1185 /* *INDENT-ON* */
1186
1187 /*
1188  * fd.io coding-style-patch-verification: ON
1189  *
1190  * Local Variables:
1191  * eval: (c-set-style "gnu")
1192  * End:
1193  */