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.
17 * @brief Common utility functions for IPv4 and IPv6 VXLAN GPE tunnels
20 #include <vnet/vxlan-gpe/vxlan_gpe.h>
21 #include <vnet/fib/fib.h>
22 #include <vnet/ip/format.h>
24 vxlan_gpe_main_t vxlan_gpe_main;
27 * @brief Tracing function for VXLAN GPE tunnel packets
29 * @param *s formatting string
32 * @return *s formatted string
35 u8 * format_vxlan_gpe_tunnel (u8 * s, va_list * args)
37 vxlan_gpe_tunnel_t * t = va_arg (*args, vxlan_gpe_tunnel_t *);
38 vxlan_gpe_main_t * gm = &vxlan_gpe_main;
40 s = format (s, "[%d] local: %U remote: %U ",
42 format_ip46_address, &t->local, IP46_TYPE_ANY,
43 format_ip46_address, &t->remote, IP46_TYPE_ANY);
45 s = format (s, " vxlan VNI %d ", t->vni);
49 case VXLAN_GPE_PROTOCOL_IP4:
50 s = format (s, "next-protocol ip4");
52 case VXLAN_GPE_PROTOCOL_IP6:
53 s = format (s, "next-protocol ip6");
55 case VXLAN_GPE_PROTOCOL_ETHERNET:
56 s = format (s, "next-protocol ethernet");
58 case VXLAN_GPE_PROTOCOL_NSH:
59 s = format (s, "next-protocol nsh");
62 s = format (s, "next-protocol unknown %d", t->protocol);
65 s = format (s, " fibs: (encap %d, decap %d)",
73 * @brief Naming for VXLAN GPE tunnel
75 * @param *s formatting string
78 * @return *s formatted string
81 static u8 * format_vxlan_gpe_name (u8 * s, va_list * args)
83 u32 dev_instance = va_arg (*args, u32);
84 return format (s, "vxlan_gpe_tunnel%d", dev_instance);
87 static uword dummy_interface_tx (vlib_main_t * vm,
88 vlib_node_runtime_t * node,
91 clib_warning ("you shouldn't be here, leaking buffers...");
92 return frame->n_vectors;
96 * @brief CLI function for VXLAN GPE admin up/down
105 static clib_error_t *
106 vxlan_gpe_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
108 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
109 vnet_hw_interface_set_flags (vnm, hw_if_index, VNET_HW_INTERFACE_FLAG_LINK_UP);
111 vnet_hw_interface_set_flags (vnm, hw_if_index, 0);
116 VNET_DEVICE_CLASS (vxlan_gpe_device_class,static) = {
118 .format_device_name = format_vxlan_gpe_name,
119 .format_tx_trace = format_vxlan_gpe_encap_trace,
120 .tx_function = dummy_interface_tx,
121 .admin_up_down_function = vxlan_gpe_interface_admin_up_down,
126 * @brief Formatting function for tracing VXLAN GPE with length
134 static u8 * format_vxlan_gpe_header_with_length (u8 * s, va_list * args)
136 u32 dev_instance = va_arg (*args, u32);
137 s = format (s, "unimplemented dev %u", dev_instance);
141 VNET_HW_INTERFACE_CLASS (vxlan_gpe_hw_class) = {
143 .format_header = format_vxlan_gpe_header_with_length,
144 .build_rewrite = default_build_rewrite,
145 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
149 #define foreach_gpe_copy_field \
155 #define foreach_copy_ipv4 { \
156 _(local.ip4.as_u32) \
157 _(remote.ip4.as_u32) \
160 #define foreach_copy_ipv6 { \
161 _(local.ip6.as_u64[0]) \
162 _(local.ip6.as_u64[1]) \
163 _(remote.ip6.as_u64[0]) \
164 _(remote.ip6.as_u64[1]) \
169 * @brief Calculate IPv4 VXLAN GPE rewrite header
176 int vxlan4_gpe_rewrite (vxlan_gpe_tunnel_t * t, u32 extension_size,
177 u8 protocol_override, uword encap_next_node)
181 ip4_vxlan_gpe_header_t * h0;
184 len = sizeof (*h0) + extension_size;
186 vec_free(t->rewrite);
187 vec_validate_aligned (rw, len-1, CLIB_CACHE_LINE_BYTES);
189 h0 = (ip4_vxlan_gpe_header_t *) rw;
191 /* Fixed portion of the (outer) ip4 header */
193 ip0->ip_version_and_header_length = 0x45;
195 ip0->protocol = IP_PROTOCOL_UDP;
197 /* we fix up the ip4 header length and checksum after-the-fact */
198 ip0->src_address.as_u32 = t->local.ip4.as_u32;
199 ip0->dst_address.as_u32 = t->remote.ip4.as_u32;
200 ip0->checksum = ip4_header_checksum (ip0);
202 /* UDP header, randomize src port on something, maybe? */
203 h0->udp.src_port = clib_host_to_net_u16 (4790);
204 h0->udp.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan_gpe);
206 /* VXLAN header. Are we having fun yet? */
207 h0->vxlan.flags = VXLAN_GPE_FLAGS_I | VXLAN_GPE_FLAGS_P;
208 h0->vxlan.ver_res = VXLAN_GPE_VERSION;
209 if (protocol_override)
211 h0->vxlan.protocol = protocol_override;
215 h0->vxlan.protocol = t->protocol;
217 t->rewrite_size = sizeof(ip4_vxlan_gpe_header_t) + extension_size;
218 h0->vxlan.vni_res = clib_host_to_net_u32 (t->vni<<8);
221 t->encap_next_node = encap_next_node;
226 * @brief Calculate IPv6 VXLAN GPE rewrite header
233 int vxlan6_gpe_rewrite (vxlan_gpe_tunnel_t * t, u32 extension_size,
234 u8 protocol_override, uword encap_next_node)
238 ip6_vxlan_gpe_header_t * h0;
241 len = sizeof (*h0) + extension_size;
243 vec_free(t->rewrite);
244 vec_validate_aligned (rw, len-1, CLIB_CACHE_LINE_BYTES);
246 h0 = (ip6_vxlan_gpe_header_t *) rw;
248 /* Fixed portion of the (outer) ip4 header */
250 ip0->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32(6 << 28);
251 ip0->hop_limit = 255;
252 ip0->protocol = IP_PROTOCOL_UDP;
254 ip0->src_address.as_u64[0] = t->local.ip6.as_u64[0];
255 ip0->src_address.as_u64[1] = t->local.ip6.as_u64[1];
256 ip0->dst_address.as_u64[0] = t->remote.ip6.as_u64[0];
257 ip0->dst_address.as_u64[1] = t->remote.ip6.as_u64[1];
259 /* UDP header, randomize src port on something, maybe? */
260 h0->udp.src_port = clib_host_to_net_u16 (4790);
261 h0->udp.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan_gpe);
263 /* VXLAN header. Are we having fun yet? */
264 h0->vxlan.flags = VXLAN_GPE_FLAGS_I | VXLAN_GPE_FLAGS_P;
265 h0->vxlan.ver_res = VXLAN_GPE_VERSION;
266 if (protocol_override)
268 h0->vxlan.protocol = t->protocol;
272 h0->vxlan.protocol = protocol_override;
274 t->rewrite_size = sizeof(ip4_vxlan_gpe_header_t) + extension_size;
275 h0->vxlan.vni_res = clib_host_to_net_u32 (t->vni<<8);
278 t->encap_next_node = encap_next_node;
283 * @brief Add or Del a VXLAN GPE tunnel
286 * @param *sw_if_index
291 int vnet_vxlan_gpe_add_del_tunnel
292 (vnet_vxlan_gpe_add_del_tunnel_args_t *a, u32 * sw_if_indexp)
294 vxlan_gpe_main_t * gm = &vxlan_gpe_main;
295 vxlan_gpe_tunnel_t *t = 0;
296 vnet_main_t * vnm = gm->vnet_main;
297 vnet_hw_interface_t * hi;
299 u32 hw_if_index = ~0;
300 u32 sw_if_index = ~0;
302 vxlan4_gpe_tunnel_key_t key4, *key4_copy;
303 vxlan6_gpe_tunnel_key_t key6, *key6_copy;
308 key4.local = a->local.ip4.as_u32;
309 key4.remote = a->remote.ip4.as_u32;
310 key4.vni = clib_host_to_net_u32 (a->vni << 8);
313 p = hash_get_mem(gm->vxlan4_gpe_tunnel_by_key, &key4);
317 key6.local.as_u64[0] = a->local.ip6.as_u64[0];
318 key6.local.as_u64[1] = a->local.ip6.as_u64[1];
319 key6.remote.as_u64[0] = a->remote.ip6.as_u64[0];
320 key6.remote.as_u64[1] = a->remote.ip6.as_u64[1];
321 key6.vni = clib_host_to_net_u32 (a->vni << 8);
323 p = hash_get_mem(gm->vxlan6_gpe_tunnel_by_key, &key6);
328 /* adding a tunnel: tunnel must not already exist */
330 return VNET_API_ERROR_INVALID_VALUE;
332 pool_get_aligned (gm->tunnels, t, CLIB_CACHE_LINE_BYTES);
333 memset (t, 0, sizeof (*t));
335 /* copy from arg structure */
336 #define _(x) t->x = a->x;
337 foreach_gpe_copy_field;
338 if (!a->is_ip6) foreach_copy_ipv4
339 else foreach_copy_ipv6
342 if (!a->is_ip6) t->flags |= VXLAN_GPE_TUNNEL_IS_IPV4;
345 rv = vxlan4_gpe_rewrite (t, 0, 0, VXLAN_GPE_ENCAP_NEXT_IP4_LOOKUP);
347 rv = vxlan6_gpe_rewrite (t, 0, 0, VXLAN_GPE_ENCAP_NEXT_IP6_LOOKUP);
352 pool_put (gm->tunnels, t);
358 key4_copy = clib_mem_alloc (sizeof (*key4_copy));
359 clib_memcpy (key4_copy, &key4, sizeof (*key4_copy));
360 hash_set_mem (gm->vxlan4_gpe_tunnel_by_key, key4_copy,
365 key6_copy = clib_mem_alloc (sizeof (*key6_copy));
366 clib_memcpy (key6_copy, &key6, sizeof (*key6_copy));
367 hash_set_mem (gm->vxlan6_gpe_tunnel_by_key, key6_copy,
371 if (vec_len (gm->free_vxlan_gpe_tunnel_hw_if_indices) > 0)
373 hw_if_index = gm->free_vxlan_gpe_tunnel_hw_if_indices
374 [vec_len (gm->free_vxlan_gpe_tunnel_hw_if_indices)-1];
375 _vec_len (gm->free_vxlan_gpe_tunnel_hw_if_indices) -= 1;
377 hi = vnet_get_hw_interface (vnm, hw_if_index);
378 hi->dev_instance = t - gm->tunnels;
379 hi->hw_instance = hi->dev_instance;
383 hw_if_index = vnet_register_interface
384 (vnm, vxlan_gpe_device_class.index, t - gm->tunnels,
385 vxlan_gpe_hw_class.index, t - gm->tunnels);
386 hi = vnet_get_hw_interface (vnm, hw_if_index);
387 hi->output_node_index = vxlan_gpe_encap_node.index;
390 t->hw_if_index = hw_if_index;
391 t->sw_if_index = sw_if_index = hi->sw_if_index;
392 vec_validate_init_empty (gm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
393 gm->tunnel_index_by_sw_if_index[sw_if_index] = t - gm->tunnels;
395 vnet_sw_interface_set_flags (vnm, hi->sw_if_index,
396 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
400 /* deleting a tunnel: tunnel must exist */
402 return VNET_API_ERROR_NO_SUCH_ENTRY;
404 t = pool_elt_at_index (gm->tunnels, p[0]);
406 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */);
407 vec_add1 (gm->free_vxlan_gpe_tunnel_hw_if_indices, t->hw_if_index);
409 gm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
413 hp = hash_get_pair (gm->vxlan4_gpe_tunnel_by_key, &key4);
414 key4_copy = (void *)(hp->key);
415 hash_unset_mem (gm->vxlan4_gpe_tunnel_by_key, &key4);
416 clib_mem_free (key4_copy);
420 hp = hash_get_pair (gm->vxlan6_gpe_tunnel_by_key, &key6);
421 key6_copy = (void *)(hp->key);
422 hash_unset_mem (gm->vxlan4_gpe_tunnel_by_key, &key6);
423 clib_mem_free (key6_copy);
426 vec_free (t->rewrite);
427 pool_put (gm->tunnels, t);
431 *sw_if_indexp = sw_if_index;
436 static clib_error_t *
437 vxlan_gpe_add_del_tunnel_command_fn (vlib_main_t * vm,
438 unformat_input_t * input,
439 vlib_cli_command_t * cmd)
441 unformat_input_t _line_input, * line_input = &_line_input;
443 ip46_address_t local, remote;
448 u32 encap_fib_index = 0;
449 u32 decap_fib_index = 0;
450 u8 protocol = VXLAN_GPE_PROTOCOL_IP4;
455 vnet_vxlan_gpe_add_del_tunnel_args_t _a, * a = &_a;
457 clib_error_t *error = NULL;
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"))
466 else if (unformat (line_input, "local %U",
467 unformat_ip4_address, &local.ip4))
472 else if (unformat (line_input, "remote %U",
473 unformat_ip4_address, &remote.ip4))
478 else if (unformat (line_input, "local %U",
479 unformat_ip6_address, &local.ip6))
484 else if (unformat (line_input, "remote %U",
485 unformat_ip6_address, &remote.ip6))
490 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
493 encap_fib_index = ip6_fib_index_from_table_id (tmp);
495 encap_fib_index = ip4_fib_index_from_table_id (tmp);
497 if (encap_fib_index == ~0)
499 error = clib_error_return (0, "nonexistent encap fib id %d", tmp);
503 else if (unformat (line_input, "decap-vrf-id %d", &tmp))
506 decap_fib_index = ip6_fib_index_from_table_id (tmp);
508 decap_fib_index = ip4_fib_index_from_table_id (tmp);
510 if (decap_fib_index == ~0)
512 error = clib_error_return (0, "nonexistent decap fib id %d", tmp);
516 else if (unformat (line_input, "vni %d", &vni))
518 else if (unformat(line_input, "next-ip4"))
519 protocol = VXLAN_GPE_PROTOCOL_IP4;
520 else if (unformat(line_input, "next-ip6"))
521 protocol = VXLAN_GPE_PROTOCOL_IP6;
522 else if (unformat(line_input, "next-ethernet"))
523 protocol = VXLAN_GPE_PROTOCOL_ETHERNET;
524 else if (unformat(line_input, "next-nsh"))
525 protocol = VXLAN_GPE_PROTOCOL_NSH;
528 error = clib_error_return (0, "parse error: '%U'",
529 format_unformat_error, line_input);
536 error = clib_error_return (0, "tunnel local address not specified");
542 error = clib_error_return (0, "tunnel remote address not specified");
546 if (ipv4_set && ipv6_set)
548 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
552 if ((ipv4_set && memcmp(&local.ip4, &remote.ip4, sizeof(local.ip4)) == 0) ||
553 (ipv6_set && memcmp(&local.ip6, &remote.ip6, sizeof(local.ip6)) == 0))
555 error = clib_error_return (0, "src and dst addresses are identical");
561 error = clib_error_return (0, "vni not specified");
565 memset (a, 0, sizeof (*a));
568 a->is_ip6 = ipv6_set;
570 #define _(x) a->x = x;
571 foreach_gpe_copy_field;
572 if (ipv4_set) foreach_copy_ipv4
573 else foreach_copy_ipv6
576 rv = vnet_vxlan_gpe_add_del_tunnel (a, &sw_if_index);
581 vlib_cli_output(vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main(), sw_if_index);
583 case VNET_API_ERROR_INVALID_DECAP_NEXT:
584 error = clib_error_return (0, "invalid decap-next...");
587 case VNET_API_ERROR_TUNNEL_EXIST:
588 error = clib_error_return (0, "tunnel already exists...");
591 case VNET_API_ERROR_NO_SUCH_ENTRY:
592 error = clib_error_return (0, "tunnel does not exist...");
596 error = clib_error_return
597 (0, "vnet_vxlan_gpe_add_del_tunnel returned %d", rv);
602 unformat_free (line_input);
607 VLIB_CLI_COMMAND (create_vxlan_gpe_tunnel_command, static) = {
608 .path = "create vxlan-gpe tunnel",
610 "create vxlan-gpe tunnel local <local-addr> remote <remote-addr>"
611 " vni <nn> [next-ip4][next-ip6][next-ethernet][next-nsh]"
612 " [encap-vrf-id <nn>] [decap-vrf-id <nn>]"
614 .function = vxlan_gpe_add_del_tunnel_command_fn,
618 * @brief CLI function for showing VXLAN GPE tunnels
627 static clib_error_t *
628 show_vxlan_gpe_tunnel_command_fn (vlib_main_t * vm,
629 unformat_input_t * input,
630 vlib_cli_command_t * cmd)
632 vxlan_gpe_main_t * gm = &vxlan_gpe_main;
633 vxlan_gpe_tunnel_t * t;
635 if (pool_elts (gm->tunnels) == 0)
636 vlib_cli_output (vm, "No vxlan-gpe tunnels configured.");
638 pool_foreach (t, gm->tunnels,
640 vlib_cli_output (vm, "%U", format_vxlan_gpe_tunnel, t);
646 VLIB_CLI_COMMAND (show_vxlan_gpe_tunnel_command, static) = {
647 .path = "show vxlan-gpe",
648 .function = show_vxlan_gpe_tunnel_command_fn,
652 * @brief Feature init function for VXLAN GPE
659 clib_error_t *vxlan_gpe_init (vlib_main_t *vm)
661 vxlan_gpe_main_t *gm = &vxlan_gpe_main;
663 gm->vnet_main = vnet_get_main();
666 gm->vxlan4_gpe_tunnel_by_key
667 = hash_create_mem (0, sizeof(vxlan4_gpe_tunnel_key_t), sizeof (uword));
669 gm->vxlan6_gpe_tunnel_by_key
670 = hash_create_mem (0, sizeof(vxlan6_gpe_tunnel_key_t), sizeof (uword));
673 udp_register_dst_port (vm, UDP_DST_PORT_vxlan_gpe,
674 vxlan4_gpe_input_node.index, 1 /* is_ip4 */);
675 udp_register_dst_port (vm, UDP_DST_PORT_vxlan6_gpe,
676 vxlan6_gpe_input_node.index, 0 /* is_ip4 */);
678 /* Register the list of standard decap protocols supported */
679 vxlan_gpe_register_decap_protocol (VXLAN_GPE_PROTOCOL_IP4,
680 VXLAN_GPE_INPUT_NEXT_IP4_INPUT);
681 vxlan_gpe_register_decap_protocol (VXLAN_GPE_PROTOCOL_IP6,
682 VXLAN_GPE_INPUT_NEXT_IP6_INPUT);
683 vxlan_gpe_register_decap_protocol (VXLAN_GPE_PROTOCOL_ETHERNET,
684 VXLAN_GPE_INPUT_NEXT_ETHERNET_INPUT);
688 VLIB_INIT_FUNCTION(vxlan_gpe_init);