2 * l2tp.c : L2TPv3 tunnel support
4 * Copyright (c) 2013 Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 #include <vppinfra/error.h>
19 #include <vppinfra/hash.h>
20 #include <vnet/vnet.h>
21 #include <vnet/ip/ip.h>
22 #include <vnet/l2/l2_input.h>
23 #include <vnet/ethernet/ethernet.h>
24 #include <vnet/l2tp/l2tp.h>
28 /* packet trace format function */
30 format_l2t_trace (u8 * s, va_list * args)
32 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
33 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
34 l2t_trace_t *t = va_arg (*args, l2t_trace_t *);
36 if (t->is_user_to_network)
37 s = format (s, "L2T: %U (client) -> %U (our) session %d",
38 format_ip6_address, &t->client_address,
39 format_ip6_address, &t->our_address, t->session_index);
41 s = format (s, "L2T: %U (our) -> %U (client) session %d)",
42 format_ip6_address, &t->our_address,
43 format_ip6_address, &t->client_address, t->session_index);
48 format_l2t_session (u8 * s, va_list * args)
50 l2t_session_t *session = va_arg (*args, l2t_session_t *);
51 l2t_main_t *lm = &l2t_main;
55 s = format (s, "[%d] %U (our) %U (client) %U (sw_if_index %d)\n",
56 session - lm->sessions,
57 format_ip6_address, &session->our_address,
58 format_ip6_address, &session->client_address,
59 format_vnet_sw_interface_name, lm->vnet_main,
60 vnet_get_sw_interface (lm->vnet_main, session->sw_if_index),
61 session->sw_if_index);
63 s = format (s, " local cookies %016llx %016llx remote cookie %016llx\n",
64 clib_net_to_host_u64 (session->local_cookie[0]),
65 clib_net_to_host_u64 (session->local_cookie[1]),
66 clib_net_to_host_u64 (session->remote_cookie));
68 s = format (s, " local session-id %d remote session-id %d\n",
69 clib_net_to_host_u32 (session->local_session_id),
70 clib_net_to_host_u32 (session->remote_session_id));
72 s = format (s, " l2 specific sublayer %s\n",
73 session->l2_sublayer_present ? "preset" : "absent");
76 session_index_to_counter_index (session - lm->sessions,
77 SESSION_COUNTER_USER_TO_NETWORK);
79 vlib_get_combined_counter (&lm->counter_main, counter_index, &v);
81 s = format (s, " user-to-net: %llu pkts %llu bytes\n",
84 vlib_get_combined_counter (&lm->counter_main, counter_index + 1, &v);
87 s = format (s, " net-to-user: %llu pkts %llu bytes\n",
93 show_l2tp_command_fn (vlib_main_t * vm,
94 unformat_input_t * input, vlib_cli_command_t * cmd)
96 l2t_session_t *session;
97 l2t_main_t *lm = &l2t_main;
101 if (unformat (input, "verbose") || unformat (input, "v"))
104 if (pool_elts (lm->sessions) == 0)
105 vlib_cli_output (vm, "No l2tp sessions...");
107 vlib_cli_output (vm, "%u l2tp sessions...", pool_elts (lm->sessions));
111 switch (lm->lookup_type)
113 case L2T_LOOKUP_SRC_ADDRESS:
114 keystr = "src address";
117 case L2T_LOOKUP_DST_ADDRESS:
118 keystr = "dst address";
121 case L2T_LOOKUP_SESSION_ID:
122 keystr = "session id";
130 vlib_cli_output (vm, "L2tp session lookup on %s", keystr);
133 pool_foreach (session, lm->sessions,
135 vlib_cli_output (vm, "%U", format_l2t_session, session);
144 VLIB_CLI_COMMAND (show_session_detail_command, static) = {
145 .path = "show l2tpv3",
146 .short_help = "show l2tpv3 [verbose]",
147 .function = show_l2tp_command_fn,
151 static clib_error_t *
152 test_counters_command_fn (vlib_main_t * vm,
153 unformat_input_t * input, vlib_cli_command_t * cmd)
155 l2t_session_t *session;
156 l2t_main_t *lm = &l2t_main;
160 u32 thread_index = vm->thread_index;
163 pool_foreach (session, lm->sessions,
165 session_index = session - lm->sessions;
167 session_index_to_counter_index (session_index,
168 SESSION_COUNTER_USER_TO_NETWORK);
169 vlib_increment_combined_counter (&lm->counter_main,
172 1/*pkt*/, 1111 /*bytes*/);
173 vlib_increment_combined_counter (&lm->counter_main,
176 1/*pkt*/, 2222 /*bytes*/);
181 vlib_cli_output (vm, "Incremented %d active counters\n", nincr);
187 VLIB_CLI_COMMAND (test_counters_command, static) = {
188 .path = "test counters",
189 .short_help = "increment all active counters",
190 .function = test_counters_command_fn,
194 static clib_error_t *
195 clear_counters_command_fn (vlib_main_t * vm,
196 unformat_input_t * input, vlib_cli_command_t * cmd)
198 l2t_session_t *session;
199 l2t_main_t *lm = &l2t_main;
205 pool_foreach (session, lm->sessions,
207 session_index = session - lm->sessions;
209 session_index_to_counter_index (session_index,
210 SESSION_COUNTER_USER_TO_NETWORK);
211 vlib_zero_combined_counter (&lm->counter_main, counter_index);
212 vlib_zero_combined_counter (&lm->counter_main, counter_index+1);
216 vlib_cli_output (vm, "Cleared %d active counters\n", nincr);
222 VLIB_CLI_COMMAND (clear_counters_command, static) = {
223 .path = "clear counters",
224 .short_help = "clear all active counters",
225 .function = clear_counters_command_fn,
230 format_l2tpv3_name (u8 * s, va_list * args)
232 l2t_main_t *lm = &l2t_main;
233 u32 i = va_arg (*args, u32);
234 u32 show_dev_instance = ~0;
236 if (i < vec_len (lm->dev_inst_by_real))
237 show_dev_instance = lm->dev_inst_by_real[i];
239 if (show_dev_instance != ~0)
240 i = show_dev_instance;
242 return format (s, "l2tpv3_tunnel%d", i);
246 l2tpv3_name_renumber (vnet_hw_interface_t * hi, u32 new_dev_instance)
248 l2t_main_t *lm = &l2t_main;
250 vec_validate_init_empty (lm->dev_inst_by_real, hi->dev_instance, ~0);
252 lm->dev_inst_by_real[hi->dev_instance] = new_dev_instance;
258 VNET_DEVICE_CLASS (l2tpv3_device_class,static) = {
260 .format_device_name = format_l2tpv3_name,
261 .name_renumber = l2tpv3_name_renumber,
266 format_l2tp_header_with_length (u8 * s, va_list * args)
268 u32 dev_instance = va_arg (*args, u32);
269 s = format (s, "unimplemented dev %u", dev_instance);
274 VNET_HW_INTERFACE_CLASS (l2tpv3_hw_class) = {
276 .format_header = format_l2tp_header_with_length,
277 .build_rewrite = default_build_rewrite,
278 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
283 create_l2tpv3_ipv6_tunnel (l2t_main_t * lm,
284 ip6_address_t * client_address,
285 ip6_address_t * our_address,
286 u32 local_session_id,
287 u32 remote_session_id,
290 int l2_sublayer_present,
291 u32 encap_fib_index, u32 * sw_if_index)
293 l2t_session_t *s = 0;
294 vnet_main_t *vnm = lm->vnet_main;
295 vnet_hw_interface_t *hi;
296 uword *p = (uword *) ~ 0;
298 l2tpv3_header_t l2tp_hdr;
299 ip6_address_t *dst_address_copy, *src_address_copy;
302 remote_session_id = clib_host_to_net_u32 (remote_session_id);
303 local_session_id = clib_host_to_net_u32 (local_session_id);
305 switch (lm->lookup_type)
307 case L2T_LOOKUP_SRC_ADDRESS:
308 p = hash_get_mem (lm->session_by_src_address, client_address);
311 case L2T_LOOKUP_DST_ADDRESS:
312 p = hash_get_mem (lm->session_by_dst_address, our_address);
315 case L2T_LOOKUP_SESSION_ID:
316 p = hash_get (lm->session_by_session_id, local_session_id);
323 /* adding a session: session must not already exist */
325 return VNET_API_ERROR_INVALID_VALUE;
327 pool_get (lm->sessions, s);
328 clib_memset (s, 0, sizeof (*s));
329 clib_memcpy (&s->our_address, our_address, sizeof (s->our_address));
330 clib_memcpy (&s->client_address, client_address,
331 sizeof (s->client_address));
332 s->local_cookie[0] = clib_host_to_net_u64 (local_cookie);
333 s->remote_cookie = clib_host_to_net_u64 (remote_cookie);
334 s->local_session_id = local_session_id;
335 s->remote_session_id = remote_session_id;
336 s->l2_sublayer_present = l2_sublayer_present;
337 /* precompute l2tp header size */
338 s->l2tp_hdr_size = l2_sublayer_present ?
339 sizeof (l2tpv3_header_t) :
340 sizeof (l2tpv3_header_t) - sizeof (l2tp_hdr.l2_specific_sublayer);
342 s->encap_fib_index = encap_fib_index;
344 /* Setup hash table entries */
345 switch (lm->lookup_type)
347 case L2T_LOOKUP_SRC_ADDRESS:
348 src_address_copy = clib_mem_alloc (sizeof (*src_address_copy));
349 clib_memcpy (src_address_copy, client_address,
350 sizeof (*src_address_copy));
351 hash_set_mem (lm->session_by_src_address, src_address_copy,
354 case L2T_LOOKUP_DST_ADDRESS:
355 dst_address_copy = clib_mem_alloc (sizeof (*dst_address_copy));
356 clib_memcpy (dst_address_copy, our_address, sizeof (*dst_address_copy));
357 hash_set_mem (lm->session_by_dst_address, dst_address_copy,
360 case L2T_LOOKUP_SESSION_ID:
361 hash_set (lm->session_by_session_id, local_session_id,
369 /* validate counters */
371 session_index_to_counter_index (s - lm->sessions,
372 SESSION_COUNTER_USER_TO_NETWORK);
373 vlib_validate_combined_counter (&lm->counter_main, counter_index);
374 vlib_validate_combined_counter (&lm->counter_main, counter_index + 1);
376 if (vec_len (lm->free_l2tpv3_tunnel_hw_if_indices) > 0)
378 hw_if_index = lm->free_l2tpv3_tunnel_hw_if_indices
379 [vec_len (lm->free_l2tpv3_tunnel_hw_if_indices) - 1];
380 _vec_len (lm->free_l2tpv3_tunnel_hw_if_indices) -= 1;
382 hi = vnet_get_hw_interface (vnm, hw_if_index);
383 hi->dev_instance = s - lm->sessions;
384 hi->hw_instance = hi->dev_instance;
388 hw_if_index = vnet_register_interface
389 (vnm, l2tpv3_device_class.index, s - lm->sessions,
390 l2tpv3_hw_class.index, s - lm->sessions);
391 hi = vnet_get_hw_interface (vnm, hw_if_index);
392 hi->output_node_index = l2t_encap_node.index;
393 /* $$$$ initialize custom dispositions, if needed */
396 s->hw_if_index = hw_if_index;
397 s->sw_if_index = hi->sw_if_index;
400 *sw_if_index = hi->sw_if_index;
405 static clib_error_t *
406 create_l2tpv3_tunnel_command_fn (vlib_main_t * vm,
407 unformat_input_t * input,
408 vlib_cli_command_t * cmd)
410 ip6_address_t client_address, our_address;
411 unformat_input_t _line_input, *line_input = &_line_input;
412 l2t_main_t *lm = &l2t_main;
413 u64 local_cookie = (u64) ~ 0, remote_cookie = (u64) ~ 0;
414 u32 local_session_id = 1, remote_session_id = 1;
415 int our_address_set = 0, client_address_set = 0;
416 int l2_sublayer_present = 0;
419 u32 encap_fib_id = ~0;
420 u32 encap_fib_index = ~0;
421 clib_error_t *error = NULL;
423 /* Get a line of input. */
424 if (!unformat_user (input, unformat_line_input, line_input))
427 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
429 if (unformat (line_input, "client %U",
430 unformat_ip6_address, &client_address))
431 client_address_set = 1;
432 else if (unformat (line_input, "our %U",
433 unformat_ip6_address, &our_address))
435 else if (unformat (line_input, "local-cookie %llx", &local_cookie))
437 else if (unformat (line_input, "remote-cookie %llx", &remote_cookie))
439 else if (unformat (line_input, "local-session-id %d",
442 else if (unformat (line_input, "remote-session-id %d",
445 else if (unformat (line_input, "fib-id %d", &encap_fib_id))
447 else if (unformat (line_input, "l2-sublayer-present"))
448 l2_sublayer_present = 1;
451 error = clib_error_return (0, "parse error: '%U'",
452 format_unformat_error, line_input);
457 if (encap_fib_id != ~0)
460 ip6_main_t *im = &ip6_main;
461 if (!(p = hash_get (im->fib_index_by_table_id, encap_fib_id)))
463 error = clib_error_return (0, "No fib with id %d", encap_fib_id);
466 encap_fib_index = p[0];
470 encap_fib_index = ~0;
473 if (our_address_set == 0)
475 error = clib_error_return (0, "our address not specified");
478 if (client_address_set == 0)
480 error = clib_error_return (0, "client address not specified");
484 rv = create_l2tpv3_ipv6_tunnel (lm, &client_address, &our_address,
485 local_session_id, remote_session_id,
486 local_cookie, remote_cookie,
488 encap_fib_index, &sw_if_index);
492 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
493 vnet_get_main (), sw_if_index);
495 case VNET_API_ERROR_INVALID_VALUE:
496 error = clib_error_return (0, "session already exists...");
499 case VNET_API_ERROR_NO_SUCH_ENTRY:
500 error = clib_error_return (0, "session does not exist...");
504 error = clib_error_return (0, "l2tp_session_add_del returned %d", rv);
509 unformat_free (line_input);
515 VLIB_CLI_COMMAND (create_l2tpv3_tunnel_command, static) =
517 .path = "create l2tpv3 tunnel",
519 "create l2tpv3 tunnel client <ip6> our <ip6> local-cookie <hex> remote-cookie <hex> local-session <dec> remote-session <dec>",
520 .function = create_l2tpv3_tunnel_command_fn,
525 l2tpv3_set_tunnel_cookies (l2t_main_t * lm,
527 u64 new_local_cookie, u64 new_remote_cookie)
530 vnet_hw_interface_t *hi;
531 vnet_main_t *vnm = vnet_get_main ();
532 hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
534 if (pool_is_free_index (lm->sessions, hi->dev_instance))
535 return VNET_API_ERROR_INVALID_VALUE;
537 s = pool_elt_at_index (lm->sessions, hi->dev_instance);
539 s->local_cookie[1] = s->local_cookie[0];
540 s->local_cookie[0] = clib_host_to_net_u64 (new_local_cookie);
541 s->remote_cookie = clib_host_to_net_u64 (new_remote_cookie);
547 static clib_error_t *
548 set_l2tp_tunnel_cookie_command_fn (vlib_main_t * vm,
549 unformat_input_t * input,
550 vlib_cli_command_t * cmd)
552 l2t_main_t *lm = &l2t_main;
553 vnet_main_t *vnm = vnet_get_main ();
554 u32 sw_if_index = ~0;
555 u64 local_cookie = (u64) ~ 0, remote_cookie = (u64) ~ 0;
559 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
561 if (unformat (input, "%U", unformat_vnet_sw_interface, vnm,
564 else if (unformat (input, "local %llx", &local_cookie))
566 else if (unformat (input, "remote %llx", &remote_cookie))
571 if (sw_if_index == ~0)
572 return clib_error_return (0, "unknown interface");
573 if (local_cookie == ~0)
574 return clib_error_return (0, "local cookie required");
575 if (remote_cookie == ~0)
576 return clib_error_return (0, "remote cookie required");
578 rv = l2tpv3_set_tunnel_cookies (lm, sw_if_index,
579 local_cookie, remote_cookie);
586 case VNET_API_ERROR_INVALID_SW_IF_INDEX:
587 return clib_error_return (0, "invalid interface");
590 return clib_error_return (0, "l2tp_session_set_cookies returned %d",
598 VLIB_CLI_COMMAND (set_l2tp_tunnel_cookie_command, static) =
600 .path = "set l2tpv3 tunnel cookie",
602 "set l2tpv3 tunnel cookie <intfc> local <hex> remote <hex>",
603 .function = set_l2tp_tunnel_cookie_command_fn,
608 l2tpv3_interface_enable_disable (vnet_main_t * vnm,
609 u32 sw_if_index, int enable_disable)
612 if (pool_is_free_index (vnm->interface_main.sw_interfaces, sw_if_index))
613 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
615 vnet_feature_enable_disable ("ip6-unicast", "l2tp-decap", sw_if_index,
616 enable_disable, 0, 0);
620 /* Enable/disable L2TPv3 intercept on IP6 forwarding path */
621 static clib_error_t *
622 set_ip6_l2tpv3 (vlib_main_t * vm,
623 unformat_input_t * input, vlib_cli_command_t * cmd)
625 u32 sw_if_index = ~0;
628 vnet_main_t *vnm = vnet_get_main ();
630 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
632 if (unformat (input, "%U", unformat_vnet_sw_interface, vnm,
635 else if (unformat (input, "del"))
641 if (sw_if_index == ~0)
642 return clib_error_return (0, "interface required");
644 rv = l2tpv3_interface_enable_disable (vnm, sw_if_index, is_add);
651 case VNET_API_ERROR_INVALID_SW_IF_INDEX:
652 return clib_error_return (0, "invalid interface");
655 return clib_error_return (0,
656 "l2tp_interface_enable_disable returned %d",
663 VLIB_CLI_COMMAND (set_interface_ip6_l2tpv3, static) =
665 .path = "set interface ip6 l2tpv3",
666 .function = set_ip6_l2tpv3,
667 .short_help = "set interface ip6 l2tpv3 <intfc> [del]",
671 static clib_error_t *
672 l2tp_config (vlib_main_t * vm, unformat_input_t * input)
674 l2t_main_t *lm = &l2t_main;
676 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
678 if (unformat (input, "lookup-v6-src"))
679 lm->lookup_type = L2T_LOOKUP_SRC_ADDRESS;
680 else if (unformat (input, "lookup-v6-dst"))
681 lm->lookup_type = L2T_LOOKUP_DST_ADDRESS;
682 else if (unformat (input, "lookup-session-id"))
683 lm->lookup_type = L2T_LOOKUP_SESSION_ID;
685 return clib_error_return (0, "unknown input `%U'",
686 format_unformat_error, input);
691 VLIB_CONFIG_FUNCTION (l2tp_config, "l2tp");
695 l2tp_sw_interface_up_down (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
697 l2t_main_t *lm = &l2t_main;
698 vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
699 if (hi->hw_class_index != l2tpv3_hw_class.index)
702 u32 session_index = hi->dev_instance;
703 l2t_session_t *s = pool_elt_at_index (lm->sessions, session_index);
704 s->admin_up = ! !(flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP);
708 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (l2tp_sw_interface_up_down);
711 l2tp_init (vlib_main_t * vm)
713 l2t_main_t *lm = &l2t_main;
714 ip_main_t *im = &ip_main;
715 ip_protocol_info_t *pi;
717 lm->vnet_main = vnet_get_main ();
719 lm->lookup_type = L2T_LOOKUP_DST_ADDRESS;
721 lm->session_by_src_address = hash_create_mem
722 (0, sizeof (ip6_address_t) /* key bytes */ ,
723 sizeof (u32) /* value bytes */ );
724 lm->session_by_dst_address = hash_create_mem
725 (0, sizeof (ip6_address_t) /* key bytes */ ,
726 sizeof (u32) /* value bytes */ );
727 lm->session_by_session_id = hash_create (0, sizeof (uword));
729 pi = ip_get_protocol_info (im, IP_PROTOCOL_L2TP);
730 pi->unformat_pg_edit = unformat_pg_l2tp_header;
732 /* insure these nodes are included in build */
733 l2tp_encap_init (vm);
739 VLIB_INIT_FUNCTION (l2tp_init);
742 l2tp_worker_init (vlib_main_t * vm)
744 l2tp_encap_init (vm);
749 VLIB_WORKER_INIT_FUNCTION (l2tp_worker_init);
752 * fd.io coding-style-patch-verification: ON
755 * eval: (c-set-style "gnu")