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