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