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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
15 #include <vnet/vxlan/vxlan.h>
16 #include <vnet/ip/format.h>
22 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
23 * to span multiple servers. This is done by building an L2 overlay on
24 * top of an L3 network underlay using VXLAN tunnels.
26 * This makes it possible for servers to be co-located in the same data
27 * center or be separated geographically as long as they are reachable
28 * through the underlay L3 network.
30 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
31 * (Virtual eXtensible VLAN) segment.
35 vxlan_main_t vxlan_main;
37 static u8 * format_decap_next (u8 * s, va_list * args)
39 u32 next_index = va_arg (*args, u32);
43 case VXLAN_INPUT_NEXT_DROP:
44 return format (s, "drop");
45 case VXLAN_INPUT_NEXT_L2_INPUT:
46 return format (s, "l2");
47 case VXLAN_INPUT_NEXT_IP4_INPUT:
48 return format (s, "ip4");
49 case VXLAN_INPUT_NEXT_IP6_INPUT:
50 return format (s, "ip6");
52 return format (s, "unknown %d", next_index);
57 u8 * format_vxlan_tunnel (u8 * s, va_list * args)
59 vxlan_tunnel_t * t = va_arg (*args, vxlan_tunnel_t *);
60 vxlan_main_t * ngm = &vxlan_main;
63 "[%d] %U (src) %U (dst) vni %d encap_fib_index %d",
65 format_ip46_address, &t->src, IP46_TYPE_ANY,
66 format_ip46_address, &t->dst, IP46_TYPE_ANY,
69 s = format (s, " decap_next %U\n", format_decap_next, t->decap_next_index);
73 static u8 * format_vxlan_name (u8 * s, va_list * args)
75 u32 dev_instance = va_arg (*args, u32);
76 return format (s, "vxlan_tunnel%d", dev_instance);
79 static uword dummy_interface_tx (vlib_main_t * vm,
80 vlib_node_runtime_t * node,
83 clib_warning ("you shouldn't be here, leaking buffers...");
84 return frame->n_vectors;
88 vxlan_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
90 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
91 vnet_hw_interface_set_flags (vnm, hw_if_index, VNET_HW_INTERFACE_FLAG_LINK_UP);
93 vnet_hw_interface_set_flags (vnm, hw_if_index, 0);
95 return /* no error */ 0;
98 VNET_DEVICE_CLASS (vxlan_device_class,static) = {
100 .format_device_name = format_vxlan_name,
101 .format_tx_trace = format_vxlan_encap_trace,
102 .tx_function = dummy_interface_tx,
103 .admin_up_down_function = vxlan_interface_admin_up_down,
106 static uword dummy_set_rewrite (vnet_main_t * vnm,
111 uword max_rewrite_bytes)
116 static u8 * format_vxlan_header_with_length (u8 * s, va_list * args)
118 u32 dev_instance = va_arg (*args, u32);
119 s = format (s, "unimplemented dev %u", dev_instance);
123 VNET_HW_INTERFACE_CLASS (vxlan_hw_class) = {
125 .format_header = format_vxlan_header_with_length,
126 .set_rewrite = dummy_set_rewrite,
129 #define foreach_copy_field \
134 #define foreach_copy_ipv4 { \
139 #define foreach_copy_ipv6 { \
140 _(src.ip6.as_u64[0]) \
141 _(src.ip6.as_u64[1]) \
142 _(dst.ip6.as_u64[0]) \
143 _(dst.ip6.as_u64[1]) \
146 static int vxlan4_rewrite (vxlan_tunnel_t * t)
150 ip4_vxlan_header_t * h0;
151 int len = sizeof (*h0);
153 vec_validate_aligned (rw, len-1, CLIB_CACHE_LINE_BYTES);
155 h0 = (ip4_vxlan_header_t *) rw;
157 /* Fixed portion of the (outer) ip4 header */
159 ip0->ip_version_and_header_length = 0x45;
161 ip0->protocol = IP_PROTOCOL_UDP;
163 /* we fix up the ip4 header length and checksum after-the-fact */
164 ip0->src_address.as_u32 = t->src.ip4.as_u32;
165 ip0->dst_address.as_u32 = t->dst.ip4.as_u32;
166 ip0->checksum = ip4_header_checksum (ip0);
168 /* UDP header, randomize src port on something, maybe? */
169 h0->udp.src_port = clib_host_to_net_u16 (4789);
170 h0->udp.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan);
173 vnet_set_vni_and_flags(&h0->vxlan, t->vni);
179 static int vxlan6_rewrite (vxlan_tunnel_t * t)
183 ip6_vxlan_header_t * h0;
184 int len = sizeof (*h0);
186 vec_validate_aligned (rw, len-1, CLIB_CACHE_LINE_BYTES);
188 h0 = (ip6_vxlan_header_t *) rw;
190 /* Fixed portion of the (outer) ip6 header */
192 ip0->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32(6 << 28);
193 ip0->hop_limit = 255;
194 ip0->protocol = IP_PROTOCOL_UDP;
196 ip0->src_address.as_u64[0] = t->src.ip6.as_u64[0];
197 ip0->src_address.as_u64[1] = t->src.ip6.as_u64[1];
198 ip0->dst_address.as_u64[0] = t->dst.ip6.as_u64[0];
199 ip0->dst_address.as_u64[1] = t->dst.ip6.as_u64[1];
201 /* UDP header, randomize src port on something, maybe? */
202 h0->udp.src_port = clib_host_to_net_u16 (4789);
203 h0->udp.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan);
206 vnet_set_vni_and_flags(&h0->vxlan, t->vni);
212 int vnet_vxlan_add_del_tunnel
213 (vnet_vxlan_add_del_tunnel_args_t *a, u32 * sw_if_indexp)
215 vxlan_main_t * vxm = &vxlan_main;
216 vxlan_tunnel_t *t = 0;
217 vnet_main_t * vnm = vxm->vnet_main;
218 ip4_main_t * im4 = &ip4_main;
219 ip6_main_t * im6 = &ip6_main;
220 vnet_hw_interface_t * hi;
222 u32 hw_if_index = ~0;
223 u32 sw_if_index = ~0;
225 vxlan4_tunnel_key_t key4;
226 vxlan6_tunnel_key_t key6;
227 l2output_main_t * l2om = &l2output_main;
230 key4.src = a->dst.ip4.as_u32; /* decap src in key is encap dst in config */
231 key4.vni = clib_host_to_net_u32 (a->vni << 8);
233 p = hash_get (vxm->vxlan4_tunnel_by_key, key4.as_u64);
235 key6.src.as_u64[0] = a->dst.ip6.as_u64[0];
236 key6.src.as_u64[1] = a->dst.ip6.as_u64[1];
237 key6.vni = clib_host_to_net_u32 (a->vni << 8);
239 p = hash_get_mem (vxm->vxlan6_tunnel_by_key, &key6);
244 /* adding a tunnel: tunnel must not already exist */
246 return VNET_API_ERROR_TUNNEL_EXIST;
248 if (a->decap_next_index == ~0)
249 a->decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
251 if (a->decap_next_index >= VXLAN_INPUT_N_NEXT)
252 return VNET_API_ERROR_INVALID_DECAP_NEXT;
254 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
255 memset (t, 0, sizeof (*t));
257 /* copy from arg structure */
258 #define _(x) t->x = a->x;
260 if (!a->is_ip6) foreach_copy_ipv4
261 else foreach_copy_ipv6
267 t->key6 = clib_mem_alloc (sizeof(vxlan6_tunnel_key_t));
268 clib_memcpy (t->key6, &key6, sizeof(key6));
272 t->key4 = 0; /* not yet used */
275 if (!a->is_ip6) t->flags |= VXLAN_TUNNEL_IS_IPV4;
278 rv = vxlan4_rewrite (t);
280 rv = vxlan6_rewrite (t);
285 pool_put (vxm->tunnels, t);
290 hash_set (vxm->vxlan4_tunnel_by_key, key4.as_u64, t - vxm->tunnels);
292 hash_set_mem (vxm->vxlan6_tunnel_by_key, t->key6, t - vxm->tunnels);
294 if (vec_len (vxm->free_vxlan_tunnel_hw_if_indices) > 0)
296 vnet_interface_main_t * im = &vnm->interface_main;
297 hw_if_index = vxm->free_vxlan_tunnel_hw_if_indices
298 [vec_len (vxm->free_vxlan_tunnel_hw_if_indices)-1];
299 _vec_len (vxm->free_vxlan_tunnel_hw_if_indices) -= 1;
301 hi = vnet_get_hw_interface (vnm, hw_if_index);
302 hi->dev_instance = t - vxm->tunnels;
303 hi->hw_instance = hi->dev_instance;
305 /* clear old stats of freed tunnel before reuse */
306 sw_if_index = hi->sw_if_index;
307 vnet_interface_counter_lock(im);
308 vlib_zero_combined_counter
309 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX], sw_if_index);
310 vlib_zero_combined_counter
311 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_RX], sw_if_index);
312 vlib_zero_simple_counter
313 (&im->sw_if_counters[VNET_INTERFACE_COUNTER_DROP], sw_if_index);
314 vnet_interface_counter_unlock(im);
318 hw_if_index = vnet_register_interface
319 (vnm, vxlan_device_class.index, t - vxm->tunnels,
320 vxlan_hw_class.index, t - vxm->tunnels);
321 hi = vnet_get_hw_interface (vnm, hw_if_index);
322 hi->output_node_index = vxlan_encap_node.index;
325 t->hw_if_index = hw_if_index;
326 t->sw_if_index = sw_if_index = hi->sw_if_index;
328 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
329 vxm->tunnel_index_by_sw_if_index[sw_if_index] = t - vxm->tunnels;
331 if (a->decap_next_index == VXLAN_INPUT_NEXT_L2_INPUT)
333 l2input_main_t * l2im = &l2input_main;
334 /* setup l2 input config with l2 feature and bd 0 to drop packet */
335 vec_validate (l2im->configs, sw_if_index);
336 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
337 l2im->configs[sw_if_index].bd_index = 0;
341 * Directs the l2 output path to work out the interface
342 * output next-arc itself. Needed when recycling a tunnel.
344 vec_validate_init_empty(l2om->next_nodes.output_node_index_vec,
346 l2om->next_nodes.output_node_index_vec[t->sw_if_index]
348 vnet_sw_interface_set_flags (vnm, sw_if_index,
349 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
351 vec_validate (im4->fib_index_by_sw_if_index, sw_if_index);
352 im4->fib_index_by_sw_if_index[sw_if_index] = t->encap_fib_index;
354 vec_validate (im6->fib_index_by_sw_if_index, sw_if_index);
355 im6->fib_index_by_sw_if_index[sw_if_index] = t->encap_fib_index;
360 /* deleting a tunnel: tunnel must exist */
362 return VNET_API_ERROR_NO_SUCH_ENTRY;
364 t = pool_elt_at_index (vxm->tunnels, p[0]);
366 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */);
367 /* make sure tunnel is removed from l2 bd or xconnect */
368 set_int_l2_mode(vxm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0, 0, 0, 0);
369 vec_add1 (vxm->free_vxlan_tunnel_hw_if_indices, t->hw_if_index);
371 vxm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
373 /* Directs the l2 path to turf packets sent to this sw_if_index */
374 l2om->next_nodes.output_node_index_vec[t->sw_if_index]
375 = L2OUTPUT_NEXT_DEL_TUNNEL;
378 hash_unset (vxm->vxlan4_tunnel_by_key, key4.as_u64);
381 hash_unset_mem (vxm->vxlan6_tunnel_by_key, t->key6);
382 clib_mem_free (t->key6);
385 vec_free (t->rewrite);
386 pool_put (vxm->tunnels, t);
390 *sw_if_indexp = sw_if_index;
395 static u32 fib4_index_from_fib_id (u32 fib_id)
397 ip4_main_t * im = &ip4_main;
400 p = hash_get (im->fib_index_by_table_id, fib_id);
407 static u32 fib6_index_from_fib_id (u32 fib_id)
409 ip6_main_t * im = &ip6_main;
412 p = hash_get (im->fib_index_by_table_id, fib_id);
419 static uword unformat_decap_next (unformat_input_t * input, va_list * args)
421 u32 * result = va_arg (*args, u32 *);
424 if (unformat (input, "l2"))
425 *result = VXLAN_INPUT_NEXT_L2_INPUT;
426 else if (unformat (input, "drop"))
427 *result = VXLAN_INPUT_NEXT_DROP;
428 else if (unformat (input, "ip4"))
429 *result = VXLAN_INPUT_NEXT_IP4_INPUT;
430 else if (unformat (input, "ip6"))
431 *result = VXLAN_INPUT_NEXT_IP6_INPUT;
432 else if (unformat (input, "%d", &tmp))
439 static clib_error_t *
440 vxlan_add_del_tunnel_command_fn (vlib_main_t * vm,
441 unformat_input_t * input,
442 vlib_cli_command_t * cmd)
444 unformat_input_t _line_input, * line_input = &_line_input;
445 ip46_address_t src, dst;
451 u32 encap_fib_index = 0;
452 u32 decap_next_index = ~0;
456 vnet_vxlan_add_del_tunnel_args_t _a, * a = &_a;
459 /* Get a line of input. */
460 if (! unformat_user (input, unformat_line_input, line_input))
463 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) {
464 if (unformat (line_input, "del"))
468 else if (unformat (line_input, "src %U",
469 unformat_ip4_address, &src.ip4))
474 else if (unformat (line_input, "dst %U",
475 unformat_ip4_address, &dst.ip4))
480 else if (unformat (line_input, "src %U",
481 unformat_ip6_address, &src.ip6))
486 else if (unformat (line_input, "dst %U",
487 unformat_ip6_address, &dst.ip6))
492 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
495 encap_fib_index = fib6_index_from_fib_id (tmp);
497 encap_fib_index = fib4_index_from_fib_id (tmp);
498 if (encap_fib_index == ~0)
499 return clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
501 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
504 else if (unformat (line_input, "vni %d", &vni))
507 return clib_error_return (0, "vni %d out of range", vni);
510 return clib_error_return (0, "parse error: '%U'",
511 format_unformat_error, line_input);
514 unformat_free (line_input);
517 return clib_error_return (0, "tunnel src address not specified");
520 return clib_error_return (0, "tunnel dst address not specified");
522 if (ipv4_set && ipv6_set)
523 return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
525 if ((ipv4_set && memcmp(&src.ip4, &dst.ip4, sizeof(src.ip4)) == 0) ||
526 (ipv6_set && memcmp(&src.ip6, &dst.ip6, sizeof(src.ip6)) == 0))
527 return clib_error_return (0, "src and dst addresses are identical");
530 return clib_error_return (0, "vni not specified");
532 memset (a, 0, sizeof (*a));
535 a->is_ip6 = ipv6_set;
537 #define _(x) a->x = x;
539 if (ipv4_set) foreach_copy_ipv4
540 else foreach_copy_ipv6
543 rv = vnet_vxlan_add_del_tunnel (a, &sw_if_index);
549 vlib_cli_output(vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main(), sw_if_index);
551 case VNET_API_ERROR_INVALID_DECAP_NEXT:
552 return clib_error_return (0, "invalid decap-next...");
554 case VNET_API_ERROR_TUNNEL_EXIST:
555 return clib_error_return (0, "tunnel already exists...");
557 case VNET_API_ERROR_NO_SUCH_ENTRY:
558 return clib_error_return (0, "tunnel does not exist...");
561 return clib_error_return
562 (0, "vnet_vxlan_add_del_tunnel returned %d", rv);
569 * Add or delete a VXLAN Tunnel.
571 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
572 * to span multiple servers. This is done by building an L2 overlay on
573 * top of an L3 network underlay using VXLAN tunnels.
575 * This makes it possible for servers to be co-located in the same data
576 * center or be separated geographically as long as they are reachable
577 * through the underlay L3 network.
579 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
580 * (Virtual eXtensible VLAN) segment.
583 * Example of how to create a VXLAN Tunnel:
584 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id 7 decap-next l2}
585 * Example of how to delete a VXLAN Tunnel:
586 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
589 VLIB_CLI_COMMAND (create_vxlan_tunnel_command, static) = {
590 .path = "create vxlan tunnel",
592 "create vxlan tunnel src <local-vtep-addr> dst <remote-vtep-addr> vni <nn>"
593 " [encap-vrf-id <nn>] [decap-next [l2|ip4|ip6]] [del]",
594 .function = vxlan_add_del_tunnel_command_fn,
598 static clib_error_t *
599 show_vxlan_tunnel_command_fn (vlib_main_t * vm,
600 unformat_input_t * input,
601 vlib_cli_command_t * cmd)
603 vxlan_main_t * vxm = &vxlan_main;
606 if (pool_elts (vxm->tunnels) == 0)
607 vlib_cli_output (vm, "No vxlan tunnels configured...");
609 pool_foreach (t, vxm->tunnels,
611 vlib_cli_output (vm, "%U", format_vxlan_tunnel, t);
618 * Display all the VXLAN Tunnel entries.
621 * Example of how to display the VXLAN Tunnel entries:
622 * @cliexstart{show vxlan tunnel}
623 * [0] 10.0.3.1 (src) 10.0.3.3 (dst) vni 13 encap_fib_index 1 decap_next l2
627 VLIB_CLI_COMMAND (show_vxlan_tunnel_command, static) = {
628 .path = "show vxlan tunnel",
629 .short_help = "show vxlan tunnel",
630 .function = show_vxlan_tunnel_command_fn,
635 clib_error_t *vxlan_init (vlib_main_t *vm)
637 vxlan_main_t * vxm = &vxlan_main;
639 vxm->vnet_main = vnet_get_main();
642 /* initialize the ip6 hash */
643 vxm->vxlan6_tunnel_by_key = hash_create_mem(0,
644 sizeof(vxlan6_tunnel_key_t),
647 udp_register_dst_port (vm, UDP_DST_PORT_vxlan,
648 vxlan4_input_node.index, /* is_ip4 */ 1);
649 udp_register_dst_port (vm, UDP_DST_PORT_vxlan6,
650 vxlan6_input_node.index, /* is_ip4 */ 0);
654 VLIB_INIT_FUNCTION(vxlan_init);