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