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>
18 vxlan_main_t vxlan_main;
20 static u8 * format_decap_next (u8 * s, va_list * args)
22 u32 next_index = va_arg (*args, u32);
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");
35 return format (s, "unknown %d", next_index);
40 u8 * format_vxlan_tunnel (u8 * s, va_list * args)
42 vxlan_tunnel_t * t = va_arg (*args, vxlan_tunnel_t *);
43 vxlan_main_t * ngm = &vxlan_main;
46 "[%d] %U (src) %U (dst) vni %d encap_fib_index %d",
48 format_ip46_address, &t->src, IP46_TYPE_ANY,
49 format_ip46_address, &t->dst, IP46_TYPE_ANY,
52 s = format (s, " decap_next %U\n", format_decap_next, t->decap_next_index);
56 static u8 * format_vxlan_name (u8 * s, va_list * args)
58 u32 dev_instance = va_arg (*args, u32);
59 return format (s, "vxlan_tunnel%d", dev_instance);
62 static uword dummy_interface_tx (vlib_main_t * vm,
63 vlib_node_runtime_t * node,
66 clib_warning ("you shouldn't be here, leaking buffers...");
67 return frame->n_vectors;
71 vxlan_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
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);
76 vnet_hw_interface_set_flags (vnm, hw_if_index, 0);
78 return /* no error */ 0;
81 VNET_DEVICE_CLASS (vxlan_device_class,static) = {
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,
89 static uword dummy_set_rewrite (vnet_main_t * vnm,
94 uword max_rewrite_bytes)
99 static u8 * format_vxlan_header_with_length (u8 * s, va_list * args)
101 u32 dev_instance = va_arg (*args, u32);
102 s = format (s, "unimplemented dev %u", dev_instance);
106 VNET_HW_INTERFACE_CLASS (vxlan_hw_class) = {
108 .format_header = format_vxlan_header_with_length,
109 .set_rewrite = dummy_set_rewrite,
112 #define foreach_copy_field \
117 #define foreach_copy_ipv4 { \
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]) \
129 static int vxlan4_rewrite (vxlan_tunnel_t * t)
133 ip4_vxlan_header_t * h0;
134 int len = sizeof (*h0);
136 vec_validate_aligned (rw, len-1, CLIB_CACHE_LINE_BYTES);
138 h0 = (ip4_vxlan_header_t *) rw;
140 /* Fixed portion of the (outer) ip4 header */
142 ip0->ip_version_and_header_length = 0x45;
144 ip0->protocol = IP_PROTOCOL_UDP;
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);
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);
156 vnet_set_vni_and_flags(&h0->vxlan, t->vni);
162 static int vxlan6_rewrite (vxlan_tunnel_t * t)
166 ip6_vxlan_header_t * h0;
167 int len = sizeof (*h0);
169 vec_validate_aligned (rw, len-1, CLIB_CACHE_LINE_BYTES);
171 h0 = (ip6_vxlan_header_t *) rw;
173 /* Fixed portion of the (outer) ip6 header */
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;
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];
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);
189 vnet_set_vni_and_flags(&h0->vxlan, t->vni);
195 int vnet_vxlan_add_del_tunnel
196 (vnet_vxlan_add_del_tunnel_args_t *a, u32 * sw_if_indexp)
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;
205 u32 hw_if_index = ~0;
206 u32 sw_if_index = ~0;
208 vxlan4_tunnel_key_t key4;
209 vxlan6_tunnel_key_t key6;
210 l2output_main_t * l2om = &l2output_main;
213 key4.src = a->dst.ip4.as_u32; /* decap src in key is encap dst in config */
214 key4.vni = clib_host_to_net_u32 (a->vni << 8);
216 p = hash_get (vxm->vxlan4_tunnel_by_key, key4.as_u64);
218 key6.src.as_u64[0] = a->dst.ip6.as_u64[0];
219 key6.src.as_u64[1] = a->dst.ip6.as_u64[1];
220 key6.vni = clib_host_to_net_u32 (a->vni << 8);
222 p = hash_get_mem (vxm->vxlan6_tunnel_by_key, &key6);
227 /* adding a tunnel: tunnel must not already exist */
229 return VNET_API_ERROR_TUNNEL_EXIST;
231 if (a->decap_next_index == ~0)
232 a->decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
234 if (a->decap_next_index >= VXLAN_INPUT_N_NEXT)
235 return VNET_API_ERROR_INVALID_DECAP_NEXT;
237 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
238 memset (t, 0, sizeof (*t));
240 /* copy from arg structure */
241 #define _(x) t->x = a->x;
243 if (!a->is_ip6) foreach_copy_ipv4
244 else foreach_copy_ipv6
250 t->key6 = clib_mem_alloc (sizeof(vxlan6_tunnel_key_t));
251 clib_memcpy (t->key6, &key6, sizeof(key6));
255 t->key4 = 0; /* not yet used */
258 if (!a->is_ip6) t->flags |= VXLAN_TUNNEL_IS_IPV4;
261 rv = vxlan4_rewrite (t);
263 rv = vxlan6_rewrite (t);
268 pool_put (vxm->tunnels, t);
273 hash_set (vxm->vxlan4_tunnel_by_key, key4.as_u64, t - vxm->tunnels);
275 hash_set_mem (vxm->vxlan6_tunnel_by_key, t->key6, t - vxm->tunnels);
277 if (vec_len (vxm->free_vxlan_tunnel_hw_if_indices) > 0)
279 vnet_interface_main_t * im = &vnm->interface_main;
280 hw_if_index = vxm->free_vxlan_tunnel_hw_if_indices
281 [vec_len (vxm->free_vxlan_tunnel_hw_if_indices)-1];
282 _vec_len (vxm->free_vxlan_tunnel_hw_if_indices) -= 1;
284 hi = vnet_get_hw_interface (vnm, hw_if_index);
285 hi->dev_instance = t - vxm->tunnels;
286 hi->hw_instance = hi->dev_instance;
288 /* clear old stats of freed tunnel before reuse */
289 sw_if_index = hi->sw_if_index;
290 vnet_interface_counter_lock(im);
291 vlib_zero_combined_counter
292 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX], sw_if_index);
293 vlib_zero_combined_counter
294 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_RX], sw_if_index);
295 vlib_zero_simple_counter
296 (&im->sw_if_counters[VNET_INTERFACE_COUNTER_DROP], sw_if_index);
297 vnet_interface_counter_unlock(im);
301 hw_if_index = vnet_register_interface
302 (vnm, vxlan_device_class.index, t - vxm->tunnels,
303 vxlan_hw_class.index, t - vxm->tunnels);
304 hi = vnet_get_hw_interface (vnm, hw_if_index);
305 hi->output_node_index = vxlan_encap_node.index;
308 t->hw_if_index = hw_if_index;
309 t->sw_if_index = sw_if_index = hi->sw_if_index;
311 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
312 vxm->tunnel_index_by_sw_if_index[sw_if_index] = t - vxm->tunnels;
314 if (a->decap_next_index == VXLAN_INPUT_NEXT_L2_INPUT)
316 l2input_main_t * l2im = &l2input_main;
317 /* setup l2 input config with l2 feature and bd 0 to drop packet */
318 vec_validate (l2im->configs, sw_if_index);
319 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
320 l2im->configs[sw_if_index].bd_index = 0;
324 * Directs the l2 output path to work out the interface
325 * output next-arc itself. Needed when recycling a tunnel.
327 vec_validate_init_empty(l2om->next_nodes.output_node_index_vec,
329 l2om->next_nodes.output_node_index_vec[t->sw_if_index]
331 vnet_sw_interface_set_flags (vnm, sw_if_index,
332 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
334 vec_validate (im4->fib_index_by_sw_if_index, sw_if_index);
335 im4->fib_index_by_sw_if_index[sw_if_index] = t->encap_fib_index;
337 vec_validate (im6->fib_index_by_sw_if_index, sw_if_index);
338 im6->fib_index_by_sw_if_index[sw_if_index] = t->encap_fib_index;
343 /* deleting a tunnel: tunnel must exist */
345 return VNET_API_ERROR_NO_SUCH_ENTRY;
347 t = pool_elt_at_index (vxm->tunnels, p[0]);
349 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */);
350 /* make sure tunnel is removed from l2 bd or xconnect */
351 set_int_l2_mode(vxm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0, 0, 0, 0);
352 vec_add1 (vxm->free_vxlan_tunnel_hw_if_indices, t->hw_if_index);
354 vxm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
356 /* Directs the l2 path to turf packets sent to this sw_if_index */
357 l2om->next_nodes.output_node_index_vec[t->sw_if_index]
358 = L2OUTPUT_NEXT_DEL_TUNNEL;
361 hash_unset (vxm->vxlan4_tunnel_by_key, key4.as_u64);
364 hash_unset_mem (vxm->vxlan6_tunnel_by_key, t->key6);
365 clib_mem_free (t->key6);
368 vec_free (t->rewrite);
369 pool_put (vxm->tunnels, t);
373 *sw_if_indexp = sw_if_index;
378 static u32 fib4_index_from_fib_id (u32 fib_id)
380 ip4_main_t * im = &ip4_main;
383 p = hash_get (im->fib_index_by_table_id, fib_id);
390 static u32 fib6_index_from_fib_id (u32 fib_id)
392 ip6_main_t * im = &ip6_main;
395 p = hash_get (im->fib_index_by_table_id, fib_id);
402 static uword unformat_decap_next (unformat_input_t * input, va_list * args)
404 u32 * result = va_arg (*args, u32 *);
407 if (unformat (input, "l2"))
408 *result = VXLAN_INPUT_NEXT_L2_INPUT;
409 else if (unformat (input, "drop"))
410 *result = VXLAN_INPUT_NEXT_DROP;
411 else if (unformat (input, "ip4"))
412 *result = VXLAN_INPUT_NEXT_IP4_INPUT;
413 else if (unformat (input, "ip6"))
414 *result = VXLAN_INPUT_NEXT_IP6_INPUT;
415 else if (unformat (input, "%d", &tmp))
422 static clib_error_t *
423 vxlan_add_del_tunnel_command_fn (vlib_main_t * vm,
424 unformat_input_t * input,
425 vlib_cli_command_t * cmd)
427 unformat_input_t _line_input, * line_input = &_line_input;
428 ip46_address_t src, dst;
434 u32 encap_fib_index = 0;
435 u32 decap_next_index = ~0;
439 vnet_vxlan_add_del_tunnel_args_t _a, * a = &_a;
442 /* Get a line of input. */
443 if (! unformat_user (input, unformat_line_input, line_input))
446 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) {
447 if (unformat (line_input, "del"))
451 else if (unformat (line_input, "src %U",
452 unformat_ip4_address, &src.ip4))
457 else if (unformat (line_input, "dst %U",
458 unformat_ip4_address, &dst.ip4))
463 else if (unformat (line_input, "src %U",
464 unformat_ip6_address, &src.ip6))
469 else if (unformat (line_input, "dst %U",
470 unformat_ip6_address, &dst.ip6))
475 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
478 encap_fib_index = fib6_index_from_fib_id (tmp);
480 encap_fib_index = fib4_index_from_fib_id (tmp);
481 if (encap_fib_index == ~0)
482 return clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
484 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
487 else if (unformat (line_input, "vni %d", &vni))
490 return clib_error_return (0, "vni %d out of range", vni);
493 return clib_error_return (0, "parse error: '%U'",
494 format_unformat_error, line_input);
497 unformat_free (line_input);
500 return clib_error_return (0, "tunnel src address not specified");
503 return clib_error_return (0, "tunnel dst address not specified");
505 if (ipv4_set && ipv6_set)
506 return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
508 if ((ipv4_set && memcmp(&src.ip4, &dst.ip4, sizeof(src.ip4)) == 0) ||
509 (ipv6_set && memcmp(&src.ip6, &dst.ip6, sizeof(src.ip6)) == 0))
510 return clib_error_return (0, "src and dst addresses are identical");
513 return clib_error_return (0, "vni not specified");
515 memset (a, 0, sizeof (*a));
518 a->is_ip6 = ipv6_set;
520 #define _(x) a->x = x;
522 if (ipv4_set) foreach_copy_ipv4
523 else foreach_copy_ipv6
526 rv = vnet_vxlan_add_del_tunnel (a, &sw_if_index);
532 vlib_cli_output(vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main(), sw_if_index);
534 case VNET_API_ERROR_INVALID_DECAP_NEXT:
535 return clib_error_return (0, "invalid decap-next...");
537 case VNET_API_ERROR_TUNNEL_EXIST:
538 return clib_error_return (0, "tunnel already exists...");
540 case VNET_API_ERROR_NO_SUCH_ENTRY:
541 return clib_error_return (0, "tunnel does not exist...");
544 return clib_error_return
545 (0, "vnet_vxlan_add_del_tunnel returned %d", rv);
551 VLIB_CLI_COMMAND (create_vxlan_tunnel_command, static) = {
552 .path = "create vxlan tunnel",
554 "create vxlan tunnel src <local-vtep-addr> dst <remote-vtep-addr> vni <nn>"
555 " [encap-vrf-id <nn>] [decap-next [l2|ip4|ip6] [del]\n",
556 .function = vxlan_add_del_tunnel_command_fn,
559 static clib_error_t *
560 show_vxlan_tunnel_command_fn (vlib_main_t * vm,
561 unformat_input_t * input,
562 vlib_cli_command_t * cmd)
564 vxlan_main_t * vxm = &vxlan_main;
567 if (pool_elts (vxm->tunnels) == 0)
568 vlib_cli_output (vm, "No vxlan tunnels configured...");
570 pool_foreach (t, vxm->tunnels,
572 vlib_cli_output (vm, "%U", format_vxlan_tunnel, t);
578 VLIB_CLI_COMMAND (show_vxlan_tunnel_command, static) = {
579 .path = "show vxlan tunnel",
580 .function = show_vxlan_tunnel_command_fn,
584 clib_error_t *vxlan_init (vlib_main_t *vm)
586 vxlan_main_t * vxm = &vxlan_main;
588 vxm->vnet_main = vnet_get_main();
591 /* initialize the ip6 hash */
592 vxm->vxlan6_tunnel_by_key = hash_create_mem(0,
593 sizeof(vxlan6_tunnel_key_t),
596 udp_register_dst_port (vm, UDP_DST_PORT_vxlan,
597 vxlan4_input_node.index, /* is_ip4 */ 1);
598 udp_register_dst_port (vm, UDP_DST_PORT_vxlan6,
599 vxlan6_input_node.index, /* is_ip4 */ 0);
603 VLIB_INIT_FUNCTION(vxlan_init);