VPP-98 Dedicated storage for VXLAN over IPv6 hash keys
[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_mem (vxm->vxlan6_tunnel_by_key, &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       /* copy the key */
247       if (a->is_ip6)
248         {
249           t->key6 = clib_mem_alloc (sizeof(vxlan6_tunnel_key_t));
250           clib_memcpy (t->key6, &key6, sizeof(key6));
251         }
252       else
253         {
254           t->key4 = 0; /* not yet used */
255         }
256
257       if (!a->is_ip6) t->flags |= VXLAN_TUNNEL_IS_IPV4;
258
259       if (!a->is_ip6) {
260         rv = vxlan4_rewrite (t);
261       } else {
262         rv = vxlan6_rewrite (t);
263       }
264
265       if (rv)
266         {
267           pool_put (vxm->tunnels, t);
268           return rv;
269         }
270
271       if (!a->is_ip6)
272         hash_set (vxm->vxlan4_tunnel_by_key, key4.as_u64, t - vxm->tunnels);
273       else
274         hash_set_mem (vxm->vxlan6_tunnel_by_key, t->key6, t - vxm->tunnels);
275       
276       if (vec_len (vxm->free_vxlan_tunnel_hw_if_indices) > 0)
277         {
278           vnet_interface_main_t * im = &vnm->interface_main;
279           hw_if_index = vxm->free_vxlan_tunnel_hw_if_indices
280             [vec_len (vxm->free_vxlan_tunnel_hw_if_indices)-1];
281           _vec_len (vxm->free_vxlan_tunnel_hw_if_indices) -= 1;
282           
283           hi = vnet_get_hw_interface (vnm, hw_if_index);
284           hi->dev_instance = t - vxm->tunnels;
285           hi->hw_instance = hi->dev_instance;
286
287           /* clear old stats of freed tunnel before reuse */
288           sw_if_index = hi->sw_if_index;
289           vnet_interface_counter_lock(im);
290           vlib_zero_combined_counter 
291             (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX], sw_if_index);
292           vlib_zero_combined_counter 
293             (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_RX], sw_if_index);
294           vlib_zero_simple_counter 
295             (&im->sw_if_counters[VNET_INTERFACE_COUNTER_DROP], sw_if_index);
296           vnet_interface_counter_unlock(im);
297         }
298       else 
299         {
300           hw_if_index = vnet_register_interface
301             (vnm, vxlan_device_class.index, t - vxm->tunnels,
302              vxlan_hw_class.index, t - vxm->tunnels);
303           hi = vnet_get_hw_interface (vnm, hw_if_index);
304           hi->output_node_index = vxlan_encap_node.index;
305         }
306       
307       t->hw_if_index = hw_if_index;
308       t->sw_if_index = sw_if_index = hi->sw_if_index;
309       
310       vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
311       vxm->tunnel_index_by_sw_if_index[sw_if_index] = t - vxm->tunnels;
312
313       if (a->decap_next_index == VXLAN_INPUT_NEXT_L2_INPUT)
314         {
315           l2input_main_t * l2im = &l2input_main;
316           /* setup l2 input config with l2 feature and bd 0 to drop packet */
317           vec_validate (l2im->configs, sw_if_index);
318           l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
319           l2im->configs[sw_if_index].bd_index = 0;
320         }
321       vnet_sw_interface_set_flags (vnm, sw_if_index, 
322                                    VNET_SW_INTERFACE_FLAG_ADMIN_UP);
323       if (!a->is_ip6) {
324       vec_validate (im4->fib_index_by_sw_if_index, sw_if_index);
325       im4->fib_index_by_sw_if_index[sw_if_index] = t->encap_fib_index;
326       } else {
327         vec_validate (im6->fib_index_by_sw_if_index, sw_if_index);
328         im6->fib_index_by_sw_if_index[sw_if_index] = t->encap_fib_index;
329       }
330     }
331   else
332     {
333       /* deleting a tunnel: tunnel must exist */
334       if (!p) 
335         return VNET_API_ERROR_NO_SUCH_ENTRY;
336
337       t = pool_elt_at_index (vxm->tunnels, p[0]);
338
339       vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */);
340       /* make sure tunnel is removed from l2 bd or xconnect */
341       set_int_l2_mode(vxm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0, 0, 0, 0);
342       vec_add1 (vxm->free_vxlan_tunnel_hw_if_indices, t->hw_if_index);
343
344       vxm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
345
346       if (!a->is_ip6)
347         hash_unset (vxm->vxlan4_tunnel_by_key, key4.as_u64);
348       else
349         hash_unset_mem (vxm->vxlan6_tunnel_by_key, t->key6);
350
351       vec_free (t->rewrite);
352       if (!a->is_ip6)
353         {
354           t->rewrite = vxlan4_dummy_rewrite;
355           t->key4 = 0;
356         }
357       else
358         {
359           t->rewrite = vxlan6_dummy_rewrite;
360           clib_mem_free (t->key6);
361           t->key6 = 0;
362         }
363
364       pool_put (vxm->tunnels, t);
365     }
366
367   if (sw_if_indexp)
368       *sw_if_indexp = sw_if_index;
369
370   return 0;
371 }
372
373 static u32 fib4_index_from_fib_id (u32 fib_id)
374 {
375   ip4_main_t * im = &ip4_main;
376   uword * p;
377
378   p = hash_get (im->fib_index_by_table_id, fib_id);
379   if (!p)
380     return ~0;
381
382   return p[0];
383 }
384
385 static u32 fib6_index_from_fib_id (u32 fib_id)
386 {
387   ip6_main_t * im = &ip6_main;
388   uword * p;
389
390   p = hash_get (im->fib_index_by_table_id, fib_id);
391   if (!p)
392     return ~0;
393
394   return p[0];
395 }
396
397 static uword unformat_decap_next (unformat_input_t * input, va_list * args)
398 {
399   u32 * result = va_arg (*args, u32 *);
400   u32 tmp;
401   
402   if (unformat (input, "l2"))
403     *result = VXLAN_INPUT_NEXT_L2_INPUT;
404   else if (unformat (input, "drop"))
405     *result = VXLAN_INPUT_NEXT_DROP;
406   else if (unformat (input, "ip4"))
407     *result = VXLAN_INPUT_NEXT_IP4_INPUT;
408   else if (unformat (input, "ip6"))
409     *result = VXLAN_INPUT_NEXT_IP6_INPUT;
410   else if (unformat (input, "%d", &tmp))
411     *result = tmp;
412   else
413     return 0;
414   return 1;
415 }
416
417 static clib_error_t *
418 vxlan_add_del_tunnel_command_fn (vlib_main_t * vm,
419                                    unformat_input_t * input,
420                                    vlib_cli_command_t * cmd)
421 {
422   unformat_input_t _line_input, * line_input = &_line_input;
423   ip46_address_t src, dst;
424   u8 is_add = 1;
425   u8 src_set = 0;
426   u8 dst_set = 0;
427   u8 ipv4_set = 0;
428   u8 ipv6_set = 0;
429   u32 encap_fib_index = 0;
430   u32 decap_next_index = ~0;
431   u32 vni = 0;
432   u32 tmp;
433   int rv;
434   vnet_vxlan_add_del_tunnel_args_t _a, * a = &_a;
435   u32 sw_if_index;
436   
437   /* Get a line of input. */
438   if (! unformat_user (input, unformat_line_input, line_input))
439     return 0;
440
441   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) {
442     if (unformat (line_input, "del"))
443       {
444         is_add = 0;
445       }
446     else if (unformat (line_input, "src %U",
447                        unformat_ip4_address, &src.ip4))
448       {
449         src_set = 1;
450         ipv4_set = 1;
451       }
452     else if (unformat (line_input, "dst %U",
453                        unformat_ip4_address, &dst.ip4))
454       {
455         dst_set = 1;
456         ipv4_set = 1;
457       }
458     else if (unformat (line_input, "src %U", 
459                        unformat_ip6_address, &src.ip6))
460       {
461         src_set = 1;
462         ipv6_set = 1;
463       }
464     else if (unformat (line_input, "dst %U",
465                        unformat_ip6_address, &dst.ip6))
466       {
467         dst_set = 1;
468         ipv6_set = 1;
469       }
470     else if (unformat (line_input, "encap-vrf-id %d", &tmp))
471       {
472         if (ipv6_set)
473           encap_fib_index = fib6_index_from_fib_id (tmp);
474         else
475           encap_fib_index = fib4_index_from_fib_id (tmp);
476         if (encap_fib_index == ~0)
477           return clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
478       }
479     else if (unformat (line_input, "decap-next %U", unformat_decap_next, 
480                        &decap_next_index))
481       ;
482     else if (unformat (line_input, "vni %d", &vni))
483       {
484         if (vni >> 24)  
485           return clib_error_return (0, "vni %d out of range", vni);
486       }
487     else 
488       return clib_error_return (0, "parse error: '%U'", 
489                                 format_unformat_error, line_input);
490   }
491
492   unformat_free (line_input);
493
494   if (src_set == 0)
495     return clib_error_return (0, "tunnel src address not specified");
496
497   if (dst_set == 0)
498     return clib_error_return (0, "tunnel dst address not specified");
499
500   if (ipv4_set && ipv6_set)
501     return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
502
503   if ((ipv4_set && memcmp(&src.ip4, &dst.ip4, sizeof(src.ip4)) == 0) ||
504       (ipv6_set && memcmp(&src.ip6, &dst.ip6, sizeof(src.ip6)) == 0))
505     return clib_error_return (0, "src and dst addresses are identical");
506
507   if (vni == 0)
508     return clib_error_return (0, "vni not specified");
509
510   memset (a, 0, sizeof (*a));
511
512   a->is_add = is_add;
513   a->is_ip6 = ipv6_set;
514
515 #define _(x) a->x = x;
516   foreach_copy_field;
517   if (ipv4_set) foreach_copy_ipv4
518   else          foreach_copy_ipv6
519 #undef _
520   
521   rv = vnet_vxlan_add_del_tunnel (a, &sw_if_index);
522
523   switch(rv)
524     {
525     case 0:
526       if (is_add)
527         vlib_cli_output(vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main(), sw_if_index);
528       break;
529     case VNET_API_ERROR_INVALID_DECAP_NEXT:
530       return clib_error_return (0, "invalid decap-next...");
531
532     case VNET_API_ERROR_TUNNEL_EXIST:
533       return clib_error_return (0, "tunnel already exists...");
534
535     case VNET_API_ERROR_NO_SUCH_ENTRY:
536       return clib_error_return (0, "tunnel does not exist...");
537
538     default:
539       return clib_error_return 
540         (0, "vnet_vxlan_add_del_tunnel returned %d", rv);
541     }
542
543   return 0;
544 }
545
546 VLIB_CLI_COMMAND (create_vxlan_tunnel_command, static) = {
547   .path = "create vxlan tunnel",
548   .short_help = 
549   "create vxlan tunnel src <local-vtep-addr> dst <remote-vtep-addr> vni <nn>" 
550   " [encap-vrf-id <nn>] [decap-next [l2|ip4|ip6] [del]\n",
551   .function = vxlan_add_del_tunnel_command_fn,
552 };
553
554 static clib_error_t *
555 show_vxlan_tunnel_command_fn (vlib_main_t * vm,
556                                 unformat_input_t * input,
557                                 vlib_cli_command_t * cmd)
558 {
559   vxlan_main_t * vxm = &vxlan_main;
560   vxlan_tunnel_t * t;
561   
562   if (pool_elts (vxm->tunnels) == 0)
563     vlib_cli_output (vm, "No vxlan tunnels configured...");
564
565   pool_foreach (t, vxm->tunnels,
566   ({
567     vlib_cli_output (vm, "%U", format_vxlan_tunnel, t);
568   }));
569   
570   return 0;
571 }
572
573 VLIB_CLI_COMMAND (show_vxlan_tunnel_command, static) = {
574     .path = "show vxlan tunnel",
575     .function = show_vxlan_tunnel_command_fn,
576 };
577
578
579 clib_error_t *vxlan_init (vlib_main_t *vm)
580 {
581   vxlan_main_t * vxm = &vxlan_main;
582   ip4_vxlan_header_t * hdr4;
583   ip4_header_t * ip4;
584   ip6_vxlan_header_t * hdr6;
585   ip6_header_t * ip6;
586   
587   vxm->vnet_main = vnet_get_main();
588   vxm->vlib_main = vm;
589
590   /* initialize the ip6 hash */
591   vxm->vxlan6_tunnel_by_key = hash_create_mem(0,
592         sizeof(vxlan6_tunnel_key_t),
593         sizeof(uword));
594
595   /* init dummy rewrite string for deleted vxlan tunnels */
596   _vec_len(vxlan4_dummy_rewrite) = sizeof(ip4_vxlan_header_t);
597   hdr4 = (ip4_vxlan_header_t *) vxlan4_dummy_rewrite;
598   ip4 = &hdr4->ip4;
599   /* minimal rewrite setup, see vxlan_rewite() above as reference */
600   ip4->ip_version_and_header_length = 0x45;
601   ip4->checksum = ip4_header_checksum (ip4);
602
603   /* Same again for IPv6 */
604   _vec_len(vxlan6_dummy_rewrite) = sizeof(ip6_vxlan_header_t);
605   hdr6 = (ip6_vxlan_header_t *) vxlan6_dummy_rewrite;
606   ip6 = &hdr6->ip6;
607   /* minimal rewrite setup, see vxlan_rewite() above as reference */
608   ip6->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32(6 << 28);
609  
610   udp_register_dst_port (vm, UDP_DST_PORT_vxlan, 
611                          vxlan4_input_node.index, /* is_ip4 */ 1);
612   udp_register_dst_port (vm, UDP_DST_PORT_vxlan6,
613                          vxlan6_input_node.index, /* is_ip4 */ 0);
614   return 0;
615 }
616
617 VLIB_INIT_FUNCTION(vxlan_init);