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