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