VXLAN over IPv6.
[vpp.git] / vnet / 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
18 vxlan_main_t vxlan_main;
19
20 static u8 * format_decap_next (u8 * s, va_list * args)
21 {
22   u32 next_index = va_arg (*args, u32);
23
24   switch (next_index)
25     {
26     case VXLAN_INPUT_NEXT_DROP:
27       return format (s, "drop");
28     case VXLAN_INPUT_NEXT_L2_INPUT:
29       return format (s, "l2");
30     case VXLAN_INPUT_NEXT_IP4_INPUT:
31       return format (s, "ip4");
32     case VXLAN_INPUT_NEXT_IP6_INPUT:
33       return format (s, "ip6");
34     default:
35       return format (s, "unknown %d", next_index);
36     }
37   return s;
38 }
39
40 u8 * format_vxlan_tunnel (u8 * s, va_list * args)
41 {
42   vxlan_tunnel_t * t = va_arg (*args, vxlan_tunnel_t *);
43   vxlan_main_t * ngm = &vxlan_main;
44
45   s = format (s, 
46               "[%d] %U (src) %U (dst) vni %d encap_fib_index %d",
47               t - ngm->tunnels,
48               format_ip46_address, &t->src,
49               format_ip46_address, &t->dst,
50               t->vni,
51               t->encap_fib_index);
52   s = format (s, " decap_next %U\n", format_decap_next, t->decap_next_index);
53   return s;
54 }
55
56 static u8 * format_vxlan_name (u8 * s, va_list * args)
57 {
58   u32 dev_instance = va_arg (*args, u32);
59   return format (s, "vxlan_tunnel%d", dev_instance);
60 }
61
62 static uword dummy_interface_tx (vlib_main_t * vm,
63                                  vlib_node_runtime_t * node,
64                                  vlib_frame_t * frame)
65 {
66   clib_warning ("you shouldn't be here, leaking buffers...");
67   return frame->n_vectors;
68 }
69
70 static clib_error_t *
71 vxlan_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
72 {
73   if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
74     vnet_hw_interface_set_flags (vnm, hw_if_index, VNET_HW_INTERFACE_FLAG_LINK_UP);
75   else
76     vnet_hw_interface_set_flags (vnm, hw_if_index, 0);
77
78   return /* no error */ 0;
79 }
80
81 VNET_DEVICE_CLASS (vxlan_device_class,static) = {
82   .name = "VXLAN",
83   .format_device_name = format_vxlan_name,
84   .format_tx_trace = format_vxlan_encap_trace,
85   .tx_function = dummy_interface_tx,
86   .admin_up_down_function = vxlan_interface_admin_up_down,
87 };
88
89 static uword dummy_set_rewrite (vnet_main_t * vnm,
90                                 u32 sw_if_index,
91                                 u32 l3_type,
92                                 void * dst_address,
93                                 void * rewrite,
94                                 uword max_rewrite_bytes)
95 {
96   return 0;
97 }
98
99 static u8 * format_vxlan_header_with_length (u8 * s, va_list * args)
100 {
101   u32 dev_instance = va_arg (*args, u32);
102   s = format (s, "unimplemented dev %u", dev_instance);
103   return s;
104 }
105
106 VNET_HW_INTERFACE_CLASS (vxlan_hw_class) = {
107   .name = "VXLAN",
108   .format_header = format_vxlan_header_with_length,
109   .set_rewrite = dummy_set_rewrite,
110 };
111
112 #define foreach_copy_field                      \
113 _(vni)                                          \
114 _(encap_fib_index)                              \
115 _(decap_next_index)
116
117 #define foreach_copy_ipv4 {                     \
118   _(src.ip4.as_u32)                             \
119   _(dst.ip4.as_u32)                             \
120 }
121
122 #define foreach_copy_ipv6 {                     \
123   _(src.ip6.as_u64[0])                          \
124   _(src.ip6.as_u64[1])                          \
125   _(dst.ip6.as_u64[0])                          \
126   _(dst.ip6.as_u64[1])                          \
127 }
128
129 static int vxlan4_rewrite (vxlan_tunnel_t * t)
130 {
131   u8 *rw = 0;
132   ip4_header_t * ip0;
133   ip4_vxlan_header_t * h0;
134   int len = sizeof (*h0);
135
136   vec_validate_aligned (rw, len-1, CLIB_CACHE_LINE_BYTES);
137
138   h0 = (ip4_vxlan_header_t *) rw;
139
140   /* Fixed portion of the (outer) ip4 header */
141   ip0 = &h0->ip4;
142   ip0->ip_version_and_header_length = 0x45;
143   ip0->ttl = 254;
144   ip0->protocol = IP_PROTOCOL_UDP;
145
146   /* we fix up the ip4 header length and checksum after-the-fact */
147   ip0->src_address.as_u32 = t->src.ip4.as_u32;
148   ip0->dst_address.as_u32 = t->dst.ip4.as_u32;
149   ip0->checksum = ip4_header_checksum (ip0);
150
151   /* UDP header, randomize src port on something, maybe? */
152   h0->udp.src_port = clib_host_to_net_u16 (4789);
153   h0->udp.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan);
154
155   /* VXLAN header */
156   vnet_set_vni_and_flags(&h0->vxlan, t->vni);
157
158   t->rewrite = rw;
159   return (0);
160 }
161
162 static int vxlan6_rewrite (vxlan_tunnel_t * t)
163 {
164   u8 *rw = 0;
165   ip6_header_t * ip0;
166   ip6_vxlan_header_t * h0;
167   int len = sizeof (*h0);
168
169   vec_validate_aligned (rw, len-1, CLIB_CACHE_LINE_BYTES);
170
171   h0 = (ip6_vxlan_header_t *) rw;
172
173   /* Fixed portion of the (outer) ip6 header */
174   ip0 = &h0->ip6;
175   ip0->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32(6 << 28);
176   ip0->hop_limit = 255;
177   ip0->protocol = IP_PROTOCOL_UDP;
178
179   ip0->src_address.as_u64[0] = t->src.ip6.as_u64[0];
180   ip0->src_address.as_u64[1] = t->src.ip6.as_u64[1];
181   ip0->dst_address.as_u64[0] = t->dst.ip6.as_u64[0];
182   ip0->dst_address.as_u64[1] = t->dst.ip6.as_u64[1];
183
184   /* UDP header, randomize src port on something, maybe? */
185   h0->udp.src_port = clib_host_to_net_u16 (4789);
186   h0->udp.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan);
187
188   /* VXLAN header */
189   vnet_set_vni_and_flags(&h0->vxlan, t->vni);
190
191   t->rewrite = rw;
192   return (0);
193 }
194
195 int vnet_vxlan_add_del_tunnel 
196 (vnet_vxlan_add_del_tunnel_args_t *a, u32 * sw_if_indexp)
197 {
198   vxlan_main_t * vxm = &vxlan_main;
199   vxlan_tunnel_t *t = 0;
200   vnet_main_t * vnm = vxm->vnet_main;
201   ip4_main_t * im4 = &ip4_main;
202   ip6_main_t * im6 = &ip6_main;
203   vnet_hw_interface_t * hi;
204   uword * p;
205   u32 hw_if_index = ~0;
206   u32 sw_if_index = ~0;
207   int rv;
208   vxlan4_tunnel_key_t key4;
209   vxlan6_tunnel_key_t key6;
210
211   if (!a->is_ip6) {
212     key4.src = a->dst.ip4.as_u32; /* decap src in key is encap dst in config */
213     key4.vni = clib_host_to_net_u32 (a->vni << 8);
214   
215     p = hash_get (vxm->vxlan4_tunnel_by_key, key4.as_u64);
216   } else {
217     key6.src.as_u64[0] = a->dst.ip6.as_u64[0];
218     key6.src.as_u64[1] = a->dst.ip6.as_u64[1];
219     key6.vni = clib_host_to_net_u32 (a->vni << 8);
220
221     p = hash_get (vxm->vxlan6_tunnel_by_key, pointer_to_uword(&key6));
222   }
223   
224   if (a->is_add)
225     {
226       /* adding a tunnel: tunnel must not already exist */
227       if (p)
228         return VNET_API_ERROR_TUNNEL_EXIST;
229
230       if (a->decap_next_index == ~0)
231           a->decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
232
233       if (a->decap_next_index >= VXLAN_INPUT_N_NEXT)
234         return VNET_API_ERROR_INVALID_DECAP_NEXT;
235       
236       pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
237       memset (t, 0, sizeof (*t));
238       
239       /* copy from arg structure */
240 #define _(x) t->x = a->x;
241       foreach_copy_field;
242       if (!a->is_ip6) foreach_copy_ipv4
243       else            foreach_copy_ipv6
244 #undef _
245       
246       if (a->is_ip6) {
247         /* copy the key */
248         t->key6 = key6;
249       }
250
251       if (!a->is_ip6) t->flags |= VXLAN_TUNNEL_IS_IPV4;
252
253       if (!a->is_ip6) {
254         rv = vxlan4_rewrite (t);
255       } else {
256         rv = vxlan6_rewrite (t);
257       }
258
259       if (rv)
260         {
261           pool_put (vxm->tunnels, t);
262           return rv;
263         }
264
265       if (!a->is_ip6)
266         hash_set (vxm->vxlan4_tunnel_by_key, key4.as_u64, t - vxm->tunnels);
267       else
268         hash_set (vxm->vxlan6_tunnel_by_key, pointer_to_uword(&t->key6), t - vxm->tunnels);
269       
270       if (vec_len (vxm->free_vxlan_tunnel_hw_if_indices) > 0)
271         {
272           vnet_interface_main_t * im = &vnm->interface_main;
273           hw_if_index = vxm->free_vxlan_tunnel_hw_if_indices
274             [vec_len (vxm->free_vxlan_tunnel_hw_if_indices)-1];
275           _vec_len (vxm->free_vxlan_tunnel_hw_if_indices) -= 1;
276           
277           hi = vnet_get_hw_interface (vnm, hw_if_index);
278           hi->dev_instance = t - vxm->tunnels;
279           hi->hw_instance = hi->dev_instance;
280
281           /* clear old stats of freed tunnel before reuse */
282           sw_if_index = hi->sw_if_index;
283           vnet_interface_counter_lock(im);
284           vlib_zero_combined_counter 
285             (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX], sw_if_index);
286           vlib_zero_combined_counter 
287             (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_RX], sw_if_index);
288           vlib_zero_simple_counter 
289             (&im->sw_if_counters[VNET_INTERFACE_COUNTER_DROP], sw_if_index);
290           vnet_interface_counter_unlock(im);
291         }
292       else 
293         {
294           hw_if_index = vnet_register_interface
295             (vnm, vxlan_device_class.index, t - vxm->tunnels,
296              vxlan_hw_class.index, t - vxm->tunnels);
297           hi = vnet_get_hw_interface (vnm, hw_if_index);
298           hi->output_node_index = vxlan_encap_node.index;
299         }
300       
301       t->hw_if_index = hw_if_index;
302       t->sw_if_index = sw_if_index = hi->sw_if_index;
303       
304       vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
305       vxm->tunnel_index_by_sw_if_index[sw_if_index] = t - vxm->tunnels;
306
307       if (a->decap_next_index == VXLAN_INPUT_NEXT_L2_INPUT)
308         {
309           l2input_main_t * l2im = &l2input_main;
310           /* setup l2 input config with l2 feature and bd 0 to drop packet */
311           vec_validate (l2im->configs, sw_if_index);
312           l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
313           l2im->configs[sw_if_index].bd_index = 0;
314         }
315       vnet_sw_interface_set_flags (vnm, sw_if_index, 
316                                    VNET_SW_INTERFACE_FLAG_ADMIN_UP);
317       if (!a->is_ip6) {
318       vec_validate (im4->fib_index_by_sw_if_index, sw_if_index);
319       im4->fib_index_by_sw_if_index[sw_if_index] = t->encap_fib_index;
320       } else {
321         vec_validate (im6->fib_index_by_sw_if_index, sw_if_index);
322         im6->fib_index_by_sw_if_index[sw_if_index] = t->encap_fib_index;
323       }
324     }
325   else
326     {
327       /* deleting a tunnel: tunnel must exist */
328       if (!p) 
329         return VNET_API_ERROR_NO_SUCH_ENTRY;
330
331       t = pool_elt_at_index (vxm->tunnels, p[0]);
332
333       vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */);
334       /* make sure tunnel is removed from l2 bd or xconnect */
335       set_int_l2_mode(vxm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0, 0, 0, 0);
336       vec_add1 (vxm->free_vxlan_tunnel_hw_if_indices, t->hw_if_index);
337
338       vxm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
339
340       if (!a->is_ip6)
341         hash_unset (vxm->vxlan4_tunnel_by_key, key4.as_u64);
342       else
343         hash_unset (vxm->vxlan6_tunnel_by_key, pointer_to_uword(&key6));
344
345       vec_free (t->rewrite);
346       if (!a->is_ip6) {
347         t->rewrite = vxlan4_dummy_rewrite;
348       } else {
349         t->rewrite = vxlan6_dummy_rewrite;
350       }
351       pool_put (vxm->tunnels, t);
352     }
353
354   if (sw_if_indexp)
355       *sw_if_indexp = sw_if_index;
356
357   return 0;
358 }
359
360 static u32 fib4_index_from_fib_id (u32 fib_id)
361 {
362   ip4_main_t * im = &ip4_main;
363   uword * p;
364
365   p = hash_get (im->fib_index_by_table_id, fib_id);
366   if (!p)
367     return ~0;
368
369   return p[0];
370 }
371
372 static u32 fib6_index_from_fib_id (u32 fib_id)
373 {
374   ip6_main_t * im = &ip6_main;
375   uword * p;
376
377   p = hash_get (im->fib_index_by_table_id, fib_id);
378   if (!p)
379     return ~0;
380
381   return p[0];
382 }
383
384 static uword unformat_decap_next (unformat_input_t * input, va_list * args)
385 {
386   u32 * result = va_arg (*args, u32 *);
387   u32 tmp;
388   
389   if (unformat (input, "l2"))
390     *result = VXLAN_INPUT_NEXT_L2_INPUT;
391   else if (unformat (input, "drop"))
392     *result = VXLAN_INPUT_NEXT_DROP;
393   else if (unformat (input, "ip4"))
394     *result = VXLAN_INPUT_NEXT_IP4_INPUT;
395   else if (unformat (input, "ip6"))
396     *result = VXLAN_INPUT_NEXT_IP6_INPUT;
397   else if (unformat (input, "%d", &tmp))
398     *result = tmp;
399   else
400     return 0;
401   return 1;
402 }
403
404 static clib_error_t *
405 vxlan_add_del_tunnel_command_fn (vlib_main_t * vm,
406                                    unformat_input_t * input,
407                                    vlib_cli_command_t * cmd)
408 {
409   unformat_input_t _line_input, * line_input = &_line_input;
410   ip46_address_t src, dst;
411   u8 is_add = 1;
412   u8 src_set = 0;
413   u8 dst_set = 0;
414   u8 ipv4_set = 0;
415   u8 ipv6_set = 0;
416   u32 encap_fib_index = 0;
417   u32 decap_next_index = ~0;
418   u32 vni = 0;
419   u32 tmp;
420   int rv;
421   vnet_vxlan_add_del_tunnel_args_t _a, * a = &_a;
422   
423   /* Get a line of input. */
424   if (! unformat_user (input, unformat_line_input, line_input))
425     return 0;
426
427   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) {
428     if (unformat (line_input, "del"))
429       {
430         is_add = 0;
431       }
432     else if (unformat (line_input, "src %U",
433                        unformat_ip4_address, &src.ip4))
434       {
435         src_set = 1;
436         ipv4_set = 1;
437       }
438     else if (unformat (line_input, "dst %U",
439                        unformat_ip4_address, &dst.ip4))
440       {
441         dst_set = 1;
442         ipv4_set = 1;
443       }
444     else if (unformat (line_input, "src %U", 
445                        unformat_ip6_address, &src.ip6))
446       {
447         src_set = 1;
448         ipv6_set = 1;
449       }
450     else if (unformat (line_input, "dst %U",
451                        unformat_ip6_address, &dst.ip6))
452       {
453         dst_set = 1;
454         ipv6_set = 1;
455       }
456     else if (unformat (line_input, "encap-vrf-id %d", &tmp))
457       {
458         if (ipv6_set)
459           encap_fib_index = fib6_index_from_fib_id (tmp);
460         else
461           encap_fib_index = fib4_index_from_fib_id (tmp);
462         if (encap_fib_index == ~0)
463           return clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
464       }
465     else if (unformat (line_input, "decap-next %U", unformat_decap_next, 
466                        &decap_next_index))
467       ;
468     else if (unformat (line_input, "vni %d", &vni))
469       {
470         if (vni >> 24)  
471           return clib_error_return (0, "vni %d out of range", vni);
472       }
473     else 
474       return clib_error_return (0, "parse error: '%U'", 
475                                 format_unformat_error, line_input);
476   }
477
478   unformat_free (line_input);
479
480   if (src_set == 0)
481     return clib_error_return (0, "tunnel src address not specified");
482
483   if (dst_set == 0)
484     return clib_error_return (0, "tunnel dst address not specified");
485
486   if (ipv4_set && ipv6_set)
487     return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
488
489   if ((ipv4_set && memcmp(&src.ip4, &dst.ip4, sizeof(src.ip4)) == 0) ||
490       (ipv6_set && memcmp(&src.ip6, &dst.ip6, sizeof(src.ip6)) == 0))
491     return clib_error_return (0, "src and dst addresses are identical");
492
493   if (vni == 0)
494     return clib_error_return (0, "vni not specified");
495
496   memset (a, 0, sizeof (*a));
497
498   a->is_add = is_add;
499   a->is_ip6 = ipv6_set;
500
501 #define _(x) a->x = x;
502   foreach_copy_field;
503   if (ipv4_set) foreach_copy_ipv4
504   else          foreach_copy_ipv6
505 #undef _
506   
507   rv = vnet_vxlan_add_del_tunnel (a, 0 /* hw_if_indexp */);
508
509   switch(rv)
510     {
511     case 0:
512       break;
513     case VNET_API_ERROR_INVALID_DECAP_NEXT:
514       return clib_error_return (0, "invalid decap-next...");
515
516     case VNET_API_ERROR_TUNNEL_EXIST:
517       return clib_error_return (0, "tunnel already exists...");
518
519     case VNET_API_ERROR_NO_SUCH_ENTRY:
520       return clib_error_return (0, "tunnel does not exist...");
521
522     default:
523       return clib_error_return 
524         (0, "vnet_vxlan_add_del_tunnel returned %d", rv);
525     }
526
527   return 0;
528 }
529
530 VLIB_CLI_COMMAND (create_vxlan_tunnel_command, static) = {
531   .path = "create vxlan tunnel",
532   .short_help = 
533   "create vxlan tunnel src <local-vtep-addr> dst <remote-vtep-addr> vni <nn>" 
534   " [encap-vrf-id <nn>] [decap-next [l2|ip4|ip6] [del]\n",
535   .function = vxlan_add_del_tunnel_command_fn,
536 };
537
538 static clib_error_t *
539 show_vxlan_tunnel_command_fn (vlib_main_t * vm,
540                                 unformat_input_t * input,
541                                 vlib_cli_command_t * cmd)
542 {
543   vxlan_main_t * vxm = &vxlan_main;
544   vxlan_tunnel_t * t;
545   
546   if (pool_elts (vxm->tunnels) == 0)
547     vlib_cli_output (vm, "No vxlan tunnels configured...");
548
549   pool_foreach (t, vxm->tunnels,
550   ({
551     vlib_cli_output (vm, "%U", format_vxlan_tunnel, t);
552   }));
553   
554   return 0;
555 }
556
557 VLIB_CLI_COMMAND (show_vxlan_tunnel_command, static) = {
558     .path = "show vxlan tunnel",
559     .function = show_vxlan_tunnel_command_fn,
560 };
561
562
563 clib_error_t *vxlan_init (vlib_main_t *vm)
564 {
565   vxlan_main_t * vxm = &vxlan_main;
566   ip4_vxlan_header_t * hdr4;
567   ip4_header_t * ip4;
568   ip6_vxlan_header_t * hdr6;
569   ip6_header_t * ip6;
570   
571   vxm->vnet_main = vnet_get_main();
572   vxm->vlib_main = vm;
573
574   /* initialize the ip6 hash */
575   vxm->vxlan6_tunnel_by_key = hash_create_mem(0,
576         sizeof(vxlan6_tunnel_key_t),
577         sizeof(uword));
578
579   /* init dummy rewrite string for deleted vxlan tunnels */
580   _vec_len(vxlan4_dummy_rewrite) = sizeof(ip4_vxlan_header_t);
581   hdr4 = (ip4_vxlan_header_t *) vxlan4_dummy_rewrite;
582   ip4 = &hdr4->ip4;
583   /* minimal rewrite setup, see vxlan_rewite() above as reference */
584   ip4->ip_version_and_header_length = 0x45;
585   ip4->checksum = ip4_header_checksum (ip4);
586
587   /* Same again for IPv6 */
588   _vec_len(vxlan6_dummy_rewrite) = sizeof(ip6_vxlan_header_t);
589   hdr6 = (ip6_vxlan_header_t *) vxlan6_dummy_rewrite;
590   ip6 = &hdr6->ip6;
591   /* minimal rewrite setup, see vxlan_rewite() above as reference */
592   ip6->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32(6 << 28);
593  
594   udp_register_dst_port (vm, UDP_DST_PORT_vxlan, 
595                          vxlan4_input_node.index, /* is_ip4 */ 1);
596   udp_register_dst_port (vm, UDP_DST_PORT_vxlan6,
597                          vxlan6_input_node.index, /* is_ip4 */ 0);
598   return 0;
599 }
600
601 VLIB_INIT_FUNCTION(vxlan_init);