vlib: Punt reason allocation listener enable/disable callback
[vpp.git] / src / 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/fib/fib_entry.h>
18 #include <vnet/fib/fib_table.h>
19 #include <vnet/fib/fib_entry_track.h>
20 #include <vnet/mfib/mfib_table.h>
21 #include <vnet/adj/adj_mcast.h>
22 #include <vnet/adj/rewrite.h>
23 #include <vnet/interface.h>
24 #include <vlib/vlib.h>
25
26 /**
27  * @file
28  * @brief VXLAN GBP.
29  *
30  * VXLAN GBP provides the features of vxlan and carry group policy id.
31  */
32 static vlib_punt_hdl_t punt_hdl;
33
34 vxlan_gbp_main_t vxlan_gbp_main;
35
36 u8 *
37 format_vxlan_gbp_tunnel_mode (u8 * s, va_list * args)
38 {
39   vxlan_gbp_tunnel_mode_t mode = va_arg (*args, vxlan_gbp_tunnel_mode_t);
40
41   switch (mode)
42     {
43     case VXLAN_GBP_TUNNEL_MODE_L2:
44       s = format (s, "L2");
45       break;
46     case VXLAN_GBP_TUNNEL_MODE_L3:
47       s = format (s, "L3");
48       break;
49     }
50   return (s);
51 }
52
53 u8 *
54 format_vxlan_gbp_tunnel (u8 * s, va_list * args)
55 {
56   vxlan_gbp_tunnel_t *t = va_arg (*args, vxlan_gbp_tunnel_t *);
57
58   s = format (s,
59               "[%d] instance %d src %U dst %U vni %d fib-idx %d"
60               " sw-if-idx %d mode %U ",
61               t->dev_instance, t->user_instance,
62               format_ip46_address, &t->src, IP46_TYPE_ANY,
63               format_ip46_address, &t->dst, IP46_TYPE_ANY,
64               t->vni, t->encap_fib_index, t->sw_if_index,
65               format_vxlan_gbp_tunnel_mode, t->mode);
66
67   s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
68
69   if (PREDICT_FALSE (ip46_address_is_multicast (&t->dst)))
70     s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
71
72   return s;
73 }
74
75 static u8 *
76 format_vxlan_gbp_name (u8 * s, va_list * args)
77 {
78   u32 dev_instance = va_arg (*args, u32);
79   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
80   vxlan_gbp_tunnel_t *t;
81
82   if (dev_instance == ~0)
83     return format (s, "<cached-unused>");
84
85   if (dev_instance >= vec_len (vxm->tunnels))
86     return format (s, "<improperly-referenced>");
87
88   t = pool_elt_at_index (vxm->tunnels, dev_instance);
89
90   return format (s, "vxlan_gbp_tunnel%d", t->user_instance);
91 }
92
93 static clib_error_t *
94 vxlan_gbp_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
95                                    u32 flags)
96 {
97   u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
98     VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
99   vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
100
101   return /* no error */ 0;
102 }
103
104 /* *INDENT-OFF* */
105 VNET_DEVICE_CLASS (vxlan_gbp_device_class, static) = {
106   .name = "VXLAN-GBP",
107   .format_device_name = format_vxlan_gbp_name,
108   .format_tx_trace = format_vxlan_gbp_encap_trace,
109   .admin_up_down_function = vxlan_gbp_interface_admin_up_down,
110 };
111 /* *INDENT-ON* */
112
113 static u8 *
114 format_vxlan_gbp_header_with_length (u8 * s, va_list * args)
115 {
116   u32 dev_instance = va_arg (*args, u32);
117   s = format (s, "unimplemented dev %u", dev_instance);
118   return s;
119 }
120
121 /* *INDENT-OFF* */
122 VNET_HW_INTERFACE_CLASS (vxlan_gbp_hw_class) = {
123   .name = "VXLAN-GBP",
124   .format_header = format_vxlan_gbp_header_with_length,
125   .build_rewrite = default_build_rewrite,
126 };
127 /* *INDENT-ON* */
128
129 static void
130 vxlan_gbp_tunnel_restack_dpo (vxlan_gbp_tunnel_t * t)
131 {
132   u8 is_ip4 = ip46_address_is_ip4 (&t->dst);
133   dpo_id_t dpo = DPO_INVALID;
134   fib_forward_chain_type_t forw_type = is_ip4 ?
135     FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
136
137   fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
138
139   /* vxlan_gbp uses the payload hash as the udp source port
140    * hence the packet's hash is unknown
141    * skip single bucket load balance dpo's */
142   while (DPO_LOAD_BALANCE == dpo.dpoi_type)
143     {
144       load_balance_t *lb = load_balance_get (dpo.dpoi_index);
145       if (lb->lb_n_buckets > 1)
146         break;
147
148       dpo_copy (&dpo, load_balance_get_bucket_i (lb, 0));
149     }
150
151   u32 encap_index = is_ip4 ?
152     vxlan4_gbp_encap_node.index : vxlan6_gbp_encap_node.index;
153   dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
154   dpo_reset (&dpo);
155 }
156
157 static vxlan_gbp_tunnel_t *
158 vxlan_gbp_tunnel_from_fib_node (fib_node_t * node)
159 {
160   ASSERT (FIB_NODE_TYPE_VXLAN_GBP_TUNNEL == node->fn_type);
161   return ((vxlan_gbp_tunnel_t *) (((char *) node) -
162                                   STRUCT_OFFSET_OF (vxlan_gbp_tunnel_t,
163                                                     node)));
164 }
165
166 /**
167  * Function definition to backwalk a FIB node -
168  * Here we will restack the new dpo of VXLAN DIP to encap node.
169  */
170 static fib_node_back_walk_rc_t
171 vxlan_gbp_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
172 {
173   vxlan_gbp_tunnel_restack_dpo (vxlan_gbp_tunnel_from_fib_node (node));
174   return (FIB_NODE_BACK_WALK_CONTINUE);
175 }
176
177 /**
178  * Function definition to get a FIB node from its index
179  */
180 static fib_node_t *
181 vxlan_gbp_tunnel_fib_node_get (fib_node_index_t index)
182 {
183   vxlan_gbp_tunnel_t *t;
184   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
185
186   t = pool_elt_at_index (vxm->tunnels, index);
187
188   return (&t->node);
189 }
190
191 /**
192  * Function definition to inform the FIB node that its last lock has gone.
193  */
194 static void
195 vxlan_gbp_tunnel_last_lock_gone (fib_node_t * node)
196 {
197   /*
198    * The VXLAN GBP tunnel is a root of the graph. As such
199    * it never has children and thus is never locked.
200    */
201   ASSERT (0);
202 }
203
204 /*
205  * Virtual function table registered by VXLAN GBP tunnels
206  * for participation in the FIB object graph.
207  */
208 const static fib_node_vft_t vxlan_gbp_vft = {
209   .fnv_get = vxlan_gbp_tunnel_fib_node_get,
210   .fnv_last_lock = vxlan_gbp_tunnel_last_lock_gone,
211   .fnv_back_walk = vxlan_gbp_tunnel_back_walk,
212 };
213
214
215 #define foreach_copy_field                      \
216 _(vni)                                          \
217 _(mode)                                         \
218 _(mcast_sw_if_index)                            \
219 _(encap_fib_index)                              \
220 _(src)                                          \
221 _(dst)
222
223 static void
224 vxlan_gbp_rewrite (vxlan_gbp_tunnel_t * t, bool is_ip6)
225 {
226   union
227   {
228     ip4_vxlan_gbp_header_t h4;
229     ip6_vxlan_gbp_header_t h6;
230   } h;
231   int len = is_ip6 ? sizeof h.h6 : sizeof h.h4;
232
233   udp_header_t *udp;
234   vxlan_gbp_header_t *vxlan_gbp;
235   /* Fixed portion of the (outer) ip header */
236
237   clib_memset (&h, 0, sizeof (h));
238   if (!is_ip6)
239     {
240       ip4_header_t *ip = &h.h4.ip4;
241       udp = &h.h4.udp, vxlan_gbp = &h.h4.vxlan_gbp;
242       ip->ip_version_and_header_length = 0x45;
243       ip->ttl = 254;
244       ip->protocol = IP_PROTOCOL_UDP;
245
246       ip->src_address = t->src.ip4;
247       ip->dst_address = t->dst.ip4;
248
249       /* we fix up the ip4 header length and checksum after-the-fact */
250       ip->checksum = ip4_header_checksum (ip);
251     }
252   else
253     {
254       ip6_header_t *ip = &h.h6.ip6;
255       udp = &h.h6.udp, vxlan_gbp = &h.h6.vxlan_gbp;
256       ip->ip_version_traffic_class_and_flow_label =
257         clib_host_to_net_u32 (6 << 28);
258       ip->hop_limit = 255;
259       ip->protocol = IP_PROTOCOL_UDP;
260
261       ip->src_address = t->src.ip6;
262       ip->dst_address = t->dst.ip6;
263     }
264
265   /* UDP header, randomize src port on something, maybe? */
266   udp->src_port = clib_host_to_net_u16 (47789);
267   udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan_gbp);
268
269   /* VXLAN header */
270   vxlan_gbp_set_header (vxlan_gbp, t->vni);
271   vnet_rewrite_set_data (*t, &h, len);
272 }
273
274 static uword
275 vtep_addr_ref (ip46_address_t * ip)
276 {
277   uword *vtep = ip46_address_is_ip4 (ip) ?
278     hash_get (vxlan_gbp_main.vtep4, ip->ip4.as_u32) :
279     hash_get_mem (vxlan_gbp_main.vtep6, &ip->ip6);
280   if (vtep)
281     return ++(*vtep);
282   ip46_address_is_ip4 (ip) ?
283     hash_set (vxlan_gbp_main.vtep4, ip->ip4.as_u32, 1) :
284     hash_set_mem_alloc (&vxlan_gbp_main.vtep6, &ip->ip6, 1);
285   return 1;
286 }
287
288 static uword
289 vtep_addr_unref (ip46_address_t * ip)
290 {
291   uword *vtep = ip46_address_is_ip4 (ip) ?
292     hash_get (vxlan_gbp_main.vtep4, ip->ip4.as_u32) :
293     hash_get_mem (vxlan_gbp_main.vtep6, &ip->ip6);
294   ALWAYS_ASSERT (vtep);
295   if (--(*vtep) != 0)
296     return *vtep;
297   ip46_address_is_ip4 (ip) ?
298     hash_unset (vxlan_gbp_main.vtep4, ip->ip4.as_u32) :
299     hash_unset_mem_free (&vxlan_gbp_main.vtep6, &ip->ip6);
300   return 0;
301 }
302
303 /* *INDENT-OFF* */
304 typedef CLIB_PACKED(union
305 {
306   struct
307   {
308     fib_node_index_t mfib_entry_index;
309     adj_index_t mcast_adj_index;
310   };
311   u64 as_u64;
312 }) mcast_shared_t;
313 /* *INDENT-ON* */
314
315 static inline mcast_shared_t
316 mcast_shared_get (ip46_address_t * ip)
317 {
318   ASSERT (ip46_address_is_multicast (ip));
319   uword *p = hash_get_mem (vxlan_gbp_main.mcast_shared, ip);
320   ALWAYS_ASSERT (p);
321   mcast_shared_t ret = {.as_u64 = *p };
322   return ret;
323 }
324
325 static inline void
326 mcast_shared_add (ip46_address_t * dst, fib_node_index_t mfei, adj_index_t ai)
327 {
328   mcast_shared_t new_ep = {
329     .mcast_adj_index = ai,
330     .mfib_entry_index = mfei,
331   };
332
333   hash_set_mem_alloc (&vxlan_gbp_main.mcast_shared, dst, new_ep.as_u64);
334 }
335
336 static inline void
337 mcast_shared_remove (ip46_address_t * dst)
338 {
339   mcast_shared_t ep = mcast_shared_get (dst);
340
341   adj_unlock (ep.mcast_adj_index);
342   mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_VXLAN_GBP);
343
344   hash_unset_mem_free (&vxlan_gbp_main.mcast_shared, dst);
345 }
346
347 inline void
348 vxlan_gbp_register_udp_ports (void)
349 {
350   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
351
352   if (vxm->udp_ports_registered == 0)
353     {
354       udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan_gbp,
355                              vxlan4_gbp_input_node.index, /* is_ip4 */ 1);
356       udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan6_gbp,
357                              vxlan6_gbp_input_node.index, /* is_ip4 */ 0);
358     }
359   /*
360    * Counts the number of vxlan_gbp tunnels
361    */
362   vxm->udp_ports_registered += 1;
363 }
364
365 inline void
366 vxlan_gbp_unregister_udp_ports (void)
367 {
368   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
369
370   ASSERT (vxm->udp_ports_registered != 0);
371
372   if (vxm->udp_ports_registered == 1)
373     {
374       udp_unregister_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan_gbp,
375                                /* is_ip4 */ 1);
376       udp_unregister_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan6_gbp,
377                                /* is_ip4 */ 0);
378     }
379
380   vxm->udp_ports_registered -= 1;
381 }
382
383 int vnet_vxlan_gbp_tunnel_add_del
384   (vnet_vxlan_gbp_tunnel_add_del_args_t * a, u32 * sw_if_indexp)
385 {
386   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
387   vxlan_gbp_tunnel_t *t = 0;
388   vnet_main_t *vnm = vxm->vnet_main;
389   u64 *p;
390   u32 sw_if_index = ~0;
391   vxlan4_gbp_tunnel_key_t key4;
392   vxlan6_gbp_tunnel_key_t key6;
393   u32 is_ip6 = a->is_ip6;
394
395   int not_found;
396   if (!is_ip6)
397     {
398       key4.key[0] = ip46_address_is_multicast (&a->dst) ?
399         a->dst.ip4.as_u32 :
400         a->dst.ip4.as_u32 | (((u64) a->src.ip4.as_u32) << 32);
401       key4.key[1] = (((u64) a->encap_fib_index) << 32)
402         | clib_host_to_net_u32 (a->vni << 8);
403       not_found =
404         clib_bihash_search_inline_16_8 (&vxm->vxlan4_gbp_tunnel_by_key,
405                                         &key4);
406       p = &key4.value;
407     }
408   else
409     {
410       key6.key[0] = a->dst.ip6.as_u64[0];
411       key6.key[1] = a->dst.ip6.as_u64[1];
412       key6.key[2] = (((u64) a->encap_fib_index) << 32)
413         | clib_host_to_net_u32 (a->vni << 8);
414       not_found =
415         clib_bihash_search_inline_24_8 (&vxm->vxlan6_gbp_tunnel_by_key,
416                                         &key6);
417       p = &key6.value;
418     }
419
420   if (not_found)
421     p = 0;
422
423   if (a->is_add)
424     {
425       l2input_main_t *l2im = &l2input_main;
426       u32 dev_instance;         /* real dev instance tunnel index */
427       u32 user_instance;        /* request and actual instance number */
428
429       /* adding a tunnel: tunnel must not already exist */
430       if (p)
431         {
432           t = pool_elt_at_index (vxm->tunnels, *p);
433           *sw_if_indexp = t->sw_if_index;
434           return VNET_API_ERROR_TUNNEL_EXIST;
435         }
436       pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
437       clib_memset (t, 0, sizeof (*t));
438       dev_instance = t - vxm->tunnels;
439
440       /* copy from arg structure */
441 #define _(x) t->x = a->x;
442       foreach_copy_field;
443 #undef _
444
445       vxlan_gbp_rewrite (t, is_ip6);
446       /*
447        * Reconcile the real dev_instance and a possible requested instance.
448        */
449       user_instance = a->instance;
450       if (user_instance == ~0)
451         user_instance = dev_instance;
452       if (hash_get (vxm->instance_used, user_instance))
453         {
454           pool_put (vxm->tunnels, t);
455           return VNET_API_ERROR_INSTANCE_IN_USE;
456         }
457       hash_set (vxm->instance_used, user_instance, 1);
458
459       t->dev_instance = dev_instance;   /* actual */
460       t->user_instance = user_instance; /* name */
461
462       /* copy the key */
463       int add_failed;
464       if (is_ip6)
465         {
466           key6.value = (u64) dev_instance;
467           add_failed =
468             clib_bihash_add_del_24_8 (&vxm->vxlan6_gbp_tunnel_by_key, &key6,
469                                       1 /*add */ );
470         }
471       else
472         {
473           key4.value = (u64) dev_instance;
474           add_failed =
475             clib_bihash_add_del_16_8 (&vxm->vxlan4_gbp_tunnel_by_key, &key4,
476                                       1 /*add */ );
477         }
478
479       if (add_failed)
480         {
481           pool_put (vxm->tunnels, t);
482           return VNET_API_ERROR_INVALID_REGISTRATION;
483         }
484
485       vxlan_gbp_register_udp_ports ();
486
487       t->hw_if_index = vnet_register_interface
488         (vnm, vxlan_gbp_device_class.index, dev_instance,
489          vxlan_gbp_hw_class.index, dev_instance);
490       vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, t->hw_if_index);
491
492       /* Set vxlan_gbp tunnel output node */
493       u32 encap_index = !is_ip6 ?
494         vxlan4_gbp_encap_node.index : vxlan6_gbp_encap_node.index;
495       vnet_set_interface_output_node (vnm, t->hw_if_index, encap_index);
496
497       t->sw_if_index = sw_if_index = hi->sw_if_index;
498
499       if (VXLAN_GBP_TUNNEL_MODE_L3 == t->mode)
500         {
501           ip4_sw_interface_enable_disable (t->sw_if_index, 1);
502           ip6_sw_interface_enable_disable (t->sw_if_index, 1);
503         }
504
505       vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index,
506                                ~0);
507       vxm->tunnel_index_by_sw_if_index[sw_if_index] = dev_instance;
508
509       /* setup l2 input config with l2 feature and bd 0 to drop packet */
510       vec_validate (l2im->configs, sw_if_index);
511       l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
512       l2im->configs[sw_if_index].bd_index = 0;
513
514       vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
515       si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
516       vnet_sw_interface_set_flags (vnm, sw_if_index,
517                                    VNET_SW_INTERFACE_FLAG_ADMIN_UP);
518
519       fib_node_init (&t->node, FIB_NODE_TYPE_VXLAN_GBP_TUNNEL);
520       fib_prefix_t tun_dst_pfx;
521       vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
522
523       fib_prefix_from_ip46_addr (&t->dst, &tun_dst_pfx);
524       if (!ip46_address_is_multicast (&t->dst))
525         {
526           /* Unicast tunnel -
527            * source the FIB entry for the tunnel's destination
528            * and become a child thereof. The tunnel will then get poked
529            * when the forwarding for the entry updates, and the tunnel can
530            * re-stack accordingly
531            */
532           vtep_addr_ref (&t->src);
533           t->fib_entry_index = fib_entry_track (t->encap_fib_index,
534                                                 &tun_dst_pfx,
535                                                 FIB_NODE_TYPE_VXLAN_GBP_TUNNEL,
536                                                 dev_instance,
537                                                 &t->sibling_index);
538           vxlan_gbp_tunnel_restack_dpo (t);
539         }
540       else
541         {
542           /* Multicast tunnel -
543            * as the same mcast group can be used for multiple mcast tunnels
544            * with different VNIs, create the output fib adjacency only if
545            * it does not already exist
546            */
547           fib_protocol_t fp = fib_ip_proto (is_ip6);
548
549           if (vtep_addr_ref (&t->dst) == 1)
550             {
551               fib_node_index_t mfei;
552               adj_index_t ai;
553               fib_route_path_t path = {
554                 .frp_proto = fib_proto_to_dpo (fp),
555                 .frp_addr = zero_addr,
556                 .frp_sw_if_index = 0xffffffff,
557                 .frp_fib_index = ~0,
558                 .frp_weight = 0,
559                 .frp_flags = FIB_ROUTE_PATH_LOCAL,
560                 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
561               };
562               const mfib_prefix_t mpfx = {
563                 .fp_proto = fp,
564                 .fp_len = (is_ip6 ? 128 : 32),
565                 .fp_grp_addr = tun_dst_pfx.fp_addr,
566               };
567
568               /*
569                * Setup the (*,G) to receive traffic on the mcast group
570                *  - the forwarding interface is for-us
571                *  - the accepting interface is that from the API
572                */
573               mfib_table_entry_path_update (t->encap_fib_index,
574                                             &mpfx,
575                                             MFIB_SOURCE_VXLAN_GBP, &path);
576
577               path.frp_sw_if_index = a->mcast_sw_if_index;
578               path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
579               path.frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT;
580               mfei = mfib_table_entry_path_update (t->encap_fib_index,
581                                                    &mpfx,
582                                                    MFIB_SOURCE_VXLAN_GBP,
583                                                    &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 interface.
1034  * By adding the IPv4 vxlan_gbp-bypass graph node to an interface, the node checks
1035  *  for and validate input vxlan_gbp packet and bypass ip4-lookup, ip4-local,
1036  * ip4-udp-lookup nodes to speedup vxlan_gbp packet forwarding. This node will
1037  * cause extra overhead to for non-vxlan_gbp packets which is kept at a minimum.
1038  *
1039  * @cliexpar
1040  * @parblock
1041  * Example of graph node before ip4-vxlan_gbp-bypass is enabled:
1042  * @cliexstart{show vlib graph ip4-vxlan_gbp-bypass}
1043  *            Name                      Next                    Previous
1044  * ip4-vxlan-gbp-bypass              error-drop [0]
1045  *                                vxlan4-gbp-input [1]
1046  *                                   ip4-lookup [2]
1047  * @cliexend
1048  *
1049  * Example of how to enable ip4-vxlan-gbp-bypass on an interface:
1050  * @cliexcmd{set interface ip vxlan-gbp-bypass GigabitEthernet2/0/0}
1051  *
1052  * Example of graph node after ip4-vxlan-gbp-bypass is enabled:
1053  * @cliexstart{show vlib graph ip4-vxlan-gbp-bypass}
1054  *            Name                      Next                    Previous
1055  * ip4-vxlan-gbp-bypass              error-drop [0]               ip4-input
1056  *                                vxlan4-gbp-input [1]        ip4-input-no-checksum
1057  *                                   ip4-lookup [2]
1058  * @cliexend
1059  *
1060  * Example of how to display the feature enabled on an interface:
1061  * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1062  * IP feature paths configured on GigabitEthernet2/0/0...
1063  * ...
1064  * ipv4 unicast:
1065  *   ip4-vxlan-gbp-bypass
1066  *   ip4-lookup
1067  * ...
1068  * @cliexend
1069  *
1070  * Example of how to disable ip4-vxlan-gbp-bypass on an interface:
1071  * @cliexcmd{set interface ip vxlan-gbp-bypass GigabitEthernet2/0/0 del}
1072  * @endparblock
1073 ?*/
1074 /* *INDENT-OFF* */
1075 VLIB_CLI_COMMAND (set_interface_ip_vxlan_gbp_bypass_command, static) = {
1076   .path = "set interface ip vxlan-gbp-bypass",
1077   .function = set_ip4_vxlan_gbp_bypass,
1078   .short_help = "set interface ip vxlan-gbp-bypass <interface> [del]",
1079 };
1080 /* *INDENT-ON* */
1081
1082 static clib_error_t *
1083 set_ip6_vxlan_gbp_bypass (vlib_main_t * vm,
1084                           unformat_input_t * input, vlib_cli_command_t * cmd)
1085 {
1086   return set_ip_vxlan_gbp_bypass (1, input, cmd);
1087 }
1088
1089 /*?
1090  * This command adds the 'ip6-vxlan-gbp-bypass' graph node for a given interface.
1091  * By adding the IPv6 vxlan-gbp-bypass graph node to an interface, the node checks
1092  *  for and validate input vxlan_gbp packet and bypass ip6-lookup, ip6-local,
1093  * ip6-udp-lookup nodes to speedup vxlan_gbp packet forwarding. This node will
1094  * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1095  *
1096  * @cliexpar
1097  * @parblock
1098  * Example of graph node before ip6-vxlan-gbp-bypass is enabled:
1099  * @cliexstart{show vlib graph ip6-vxlan-gbp-bypass}
1100  *            Name                      Next                    Previous
1101  * ip6-vxlan-gbp-bypass              error-drop [0]
1102  *                                vxlan6-gbp-input [1]
1103  *                                   ip6-lookup [2]
1104  * @cliexend
1105  *
1106  * Example of how to enable ip6-vxlan-gbp-bypass on an interface:
1107  * @cliexcmd{set interface ip6 vxlan-gbp-bypass GigabitEthernet2/0/0}
1108  *
1109  * Example of graph node after ip6-vxlan-gbp-bypass is enabled:
1110  * @cliexstart{show vlib graph ip6-vxlan-gbp-bypass}
1111  *            Name                      Next                    Previous
1112  * ip6-vxlan-gbp-bypass              error-drop [0]               ip6-input
1113  *                                vxlan6-gbp-input [1]        ip4-input-no-checksum
1114  *                                   ip6-lookup [2]
1115  * @cliexend
1116  *
1117  * Example of how to display the feature enabled on an interface:
1118  * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1119  * IP feature paths configured on GigabitEthernet2/0/0...
1120  * ...
1121  * ipv6 unicast:
1122  *   ip6-vxlan-gbp-bypass
1123  *   ip6-lookup
1124  * ...
1125  * @cliexend
1126  *
1127  * Example of how to disable ip6-vxlan-gbp-bypass on an interface:
1128  * @cliexcmd{set interface ip6 vxlan-gbp-bypass GigabitEthernet2/0/0 del}
1129  * @endparblock
1130 ?*/
1131 /* *INDENT-OFF* */
1132 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_gbp_bypass_command, static) = {
1133   .path = "set interface ip6 vxlan-gbp-bypass",
1134   .function = set_ip6_vxlan_gbp_bypass,
1135   .short_help = "set interface ip6 vxlan-gbp-bypass <interface> [del]",
1136 };
1137 /* *INDENT-ON* */
1138
1139 #define VXLAN_GBP_HASH_NUM_BUCKETS (2 * 1024)
1140 #define VXLAN_GBP_HASH_MEMORY_SIZE (1 << 20)
1141
1142 clib_error_t *
1143 vxlan_gbp_init (vlib_main_t * vm)
1144 {
1145   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
1146
1147   vxm->vnet_main = vnet_get_main ();
1148   vxm->vlib_main = vm;
1149
1150   /* initialize the ip6 hash */
1151   clib_bihash_init_16_8 (&vxm->vxlan4_gbp_tunnel_by_key, "vxlan4-gbp",
1152                          VXLAN_GBP_HASH_NUM_BUCKETS,
1153                          VXLAN_GBP_HASH_MEMORY_SIZE);
1154   clib_bihash_init_24_8 (&vxm->vxlan6_gbp_tunnel_by_key, "vxlan6-gbp",
1155                          VXLAN_GBP_HASH_NUM_BUCKETS,
1156                          VXLAN_GBP_HASH_MEMORY_SIZE);
1157   vxm->vtep6 = hash_create_mem (0, sizeof (ip6_address_t), sizeof (uword));
1158   vxm->mcast_shared = hash_create_mem (0,
1159                                        sizeof (ip46_address_t),
1160                                        sizeof (mcast_shared_t));
1161
1162   fib_node_register_type (FIB_NODE_TYPE_VXLAN_GBP_TUNNEL, &vxlan_gbp_vft);
1163
1164   punt_hdl = vlib_punt_client_register ("vxlan-gbp");
1165
1166   vlib_punt_reason_alloc (punt_hdl,
1167                           "VXLAN-GBP-no-such-v4-tunnel",
1168                           NULL, NULL,
1169                           &vxm->punt_no_such_tunnel[FIB_PROTOCOL_IP4]);
1170   vlib_punt_reason_alloc (punt_hdl,
1171                           "VXLAN-GBP-no-such-v6-tunnel",
1172                           NULL, NULL,
1173                           &vxm->punt_no_such_tunnel[FIB_PROTOCOL_IP6]);
1174
1175   return (0);
1176 }
1177
1178 /* *INDENT-OFF* */
1179 VLIB_INIT_FUNCTION (vxlan_gbp_init) =
1180 {
1181   .runs_after = VLIB_INITS("punt_init"),
1182 };
1183 /* *INDENT-ON* */
1184
1185 /*
1186  * fd.io coding-style-patch-verification: ON
1187  *
1188  * Local Variables:
1189  * eval: (c-set-style "gnu")
1190  * End:
1191  */