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