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