2 * Copyright (c) 2018 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.
16 #include <vnet/vnet.h>
17 #include <vlibmemory/api.h>
18 #include <vnet/vnet_msg_enum.h>
19 #include <dhcp/dhcp6_packet.h>
20 #include <dhcp/dhcp6_ia_na_client_dp.h>
21 #include <vnet/ip/ip.h>
22 #include <vnet/ip/ip6.h>
29 ip6_address_t address;
49 address_info_t *address_pool;
50 client_state_t *client_state_by_sw_if_index;
52 f64 max_valid_due_time;
55 vlib_main_t *vlib_main;
56 vnet_main_t *vnet_main;
59 } dhcp6_client_cp_main_t;
61 static dhcp6_client_cp_main_t dhcp6_client_cp_main;
65 RD_CP_EVENT_INTERRUPT,
70 send_client_message_start_stop (u32 sw_if_index, u32 server_index,
71 u8 msg_type, address_info_t * address_list,
74 dhcp6_client_cp_main_t *rm = &dhcp6_client_cp_main;
75 dhcp6_send_client_message_params_t params = { 0, };
76 dhcp6_send_client_message_params_address_t *addresses = 0, *addr;
79 ASSERT (sw_if_index < vec_len (rm->client_state_by_sw_if_index) &&
80 rm->client_state_by_sw_if_index[sw_if_index].enabled);
81 client_state_t *client_state =
82 &rm->client_state_by_sw_if_index[sw_if_index];
84 params.sw_if_index = sw_if_index;
85 params.server_index = server_index;
86 params.msg_type = msg_type;
89 if (msg_type == DHCPV6_MSG_SOLICIT)
94 else if (msg_type == DHCPV6_MSG_REQUEST)
100 else if (msg_type == DHCPV6_MSG_RENEW)
104 f64 current_time = vlib_time_now (rm->vlib_main);
105 i32 diff_time = client_state->T2 - current_time;
108 params.mrd = diff_time;
110 else if (msg_type == DHCPV6_MSG_REBIND)
114 f64 current_time = vlib_time_now (rm->vlib_main);
115 i32 diff_time = rm->max_valid_due_time - current_time;
118 params.mrd = diff_time;
120 else if (msg_type == DHCPV6_MSG_RELEASE)
128 if (vec_len (address_list) != 0)
129 vec_validate (addresses, vec_len (address_list) - 1);
130 for (i = 0; i < vec_len (address_list); i++)
132 address_info_t *address = &address_list[i];
133 addr = &addresses[i];
134 addr->valid_lt = address->valid_lt;
135 addr->preferred_lt = address->preferred_lt;
136 addr->address = address->address;
138 params.addresses = addresses;
140 dhcp6_send_client_message (rm->vlib_main, sw_if_index, !start, ¶ms);
142 vec_free (params.addresses);
145 static void interrupt_process (void);
148 ip6_enable (u32 sw_if_index)
150 dhcp6_client_cp_main_t *rm = &dhcp6_client_cp_main;
153 rv = enable_ip6_interface (rm->vlib_main, sw_if_index);
159 ip6_addresses_equal (ip6_address_t * address1, ip6_address_t * address2)
161 if (address1->as_u64[0] != address2->as_u64[0])
163 return address1->as_u64[1] == address2->as_u64[1];
166 static clib_error_t *
167 dhcp6_reply_event_handler (vl_api_dhcp6_reply_event_t * mp)
169 dhcp6_client_cp_main_t *rm = &dhcp6_client_cp_main;
170 vlib_main_t *vm = rm->vlib_main;
171 client_state_t *client_state;
172 ip6_address_t *address;
175 vl_api_dhcp6_address_info_t *api_address;
176 u32 inner_status_code;
180 clib_error_t *error = 0;
183 current_time = vlib_time_now (vm);
185 sw_if_index = ntohl (mp->sw_if_index);
187 if (sw_if_index >= vec_len (rm->client_state_by_sw_if_index))
190 client_state = &rm->client_state_by_sw_if_index[sw_if_index];
192 if (!client_state->enabled)
195 server_index = ntohl (mp->server_index);
197 n_addresses = ntohl (mp->n_addresses);
199 inner_status_code = ntohs (mp->inner_status_code);
200 status_code = ntohs (mp->status_code);
202 if (mp->msg_type == DHCPV6_MSG_API_ADVERTISE
203 && client_state->server_index == ~0)
205 address_info_t *address_list = 0, *address_info;
207 if (inner_status_code == DHCPV6_STATUS_NOADDRS_AVAIL)
210 ("Advertise message arrived with NoAddrsAvail status code");
215 vec_validate (address_list, n_addresses - 1);
216 for (i = 0; i < n_addresses; i++)
218 api_address = &mp->addresses[i];
219 address = (ip6_address_t *) api_address->address;
221 address_info = &address_list[i];
222 address_info->address = *address;
223 address_info->preferred_lt = 0;
224 address_info->valid_lt = 0;
227 client_state->server_index = server_index;
229 send_client_message_start_stop (sw_if_index, server_index,
230 DHCPV6_MSG_REQUEST, address_list, 1);
231 vec_free (address_list);
234 if (mp->msg_type != DHCPV6_MSG_API_REPLY)
237 if (!client_state->rebinding && client_state->server_index != server_index)
239 clib_warning ("Reply message arrived with Server ID different "
240 "from that in Request or Renew message");
244 if (inner_status_code == DHCPV6_STATUS_NOADDRS_AVAIL)
246 clib_warning ("Reply message arrived with NoAddrsAvail status code");
250 ("Invalid Reply message arrived: It contains NoAddrsAvail "
251 "status code but also contains addresses");
256 if (status_code == DHCPV6_STATUS_UNSPEC_FAIL)
258 clib_warning ("Reply message arrived with UnspecFail status code");
262 send_client_message_start_stop (sw_if_index, server_index,
265 for (i = 0; i < n_addresses; i++)
267 address_info_t *address_info = 0;
271 api_address = &mp->addresses[i];
273 address = (ip6_address_t *) api_address->address;
275 if (ip6_address_is_link_local_unicast (address))
278 valid_time = ntohl (api_address->valid_time);
279 preferred_time = ntohl (api_address->preferred_time);
281 if (preferred_time > valid_time)
284 u8 address_already_present = 0;
286 pool_foreach (address_info, rm->address_pool,
288 if (address_info->sw_if_index != sw_if_index)
290 else if (!ip6_addresses_equal (&address_info->address, address))
294 address_already_present = 1;
295 goto address_pool_foreach_out;
299 address_pool_foreach_out:
301 if (address_already_present)
303 address_info->preferred_lt = preferred_time;
304 address_info->valid_lt = valid_time;
305 address_info->due_time = current_time;
306 /* Renew the lease at the preferred time, if non-zero */
307 address_info->due_time += (preferred_time > 0) ?
308 preferred_time : valid_time;
310 if (address_info->due_time > rm->max_valid_due_time)
311 rm->max_valid_due_time = address_info->due_time;
318 pool_get (rm->address_pool, address_info);
319 address_info->sw_if_index = sw_if_index;
320 address_info->address = *address;
321 address_info->preferred_lt = preferred_time;
322 address_info->valid_lt = valid_time;
323 address_info->due_time = current_time;
324 /* Renew the lease at the preferred time, if non-zero */
325 address_info->due_time += (preferred_time > 0) ?
326 preferred_time : valid_time;
328 if (address_info->due_time > rm->max_valid_due_time)
329 rm->max_valid_due_time = address_info->due_time;
330 rm->client_state_by_sw_if_index[sw_if_index].address_count++;
332 error = ip6_add_del_interface_address (vm, sw_if_index,
333 &address_info->address, 64, 0);
335 clib_warning ("Failed to add interface address");
338 client_state->server_index = server_index;
339 client_state->T1 = ntohl (mp->T1);
340 client_state->T2 = ntohl (mp->T2);
341 if (client_state->T1 != 0)
342 client_state->T1_due_time = current_time + client_state->T1;
343 if (client_state->T2 != 0)
344 client_state->T2_due_time = current_time + client_state->T2;
345 client_state->rebinding = 0;
347 interrupt_process ();
352 static address_info_t *
353 create_address_list (u32 sw_if_index)
355 dhcp6_client_cp_main_t *rm = &dhcp6_client_cp_main;
356 address_info_t *address_info, *address_list = 0;;
359 pool_foreach (address_info, rm->address_pool,
361 if (address_info->sw_if_index == sw_if_index)
363 u32 pos = vec_len (address_list);
364 vec_validate (address_list, pos);
365 clib_memcpy (&address_list[pos], address_info, sizeof (*address_info));
373 VNET_DHCP6_REPLY_EVENT_FUNCTION (dhcp6_reply_event_handler);
376 dhcp6_client_cp_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
379 dhcp6_client_cp_main_t *rm = &dhcp6_client_cp_main;
380 address_info_t *address_info;
381 client_state_t *client_state;
382 f64 sleep_time = 1e9;
387 uword *event_data = 0;
392 vlib_process_wait_for_event_or_clock (vm, sleep_time);
393 event_type = vlib_process_get_events (vm, &event_data);
394 vec_reset_length (event_data);
396 if (event_type == RD_CP_EVENT_DISABLE)
398 vlib_node_set_state (vm, rm->node_index, VLIB_NODE_STATE_DISABLED);
403 current_time = vlib_time_now (vm);
406 due_time = current_time + 1e9;
408 pool_foreach (address_info, rm->address_pool,
410 if (address_info->due_time > current_time)
412 if (address_info->due_time < due_time)
413 due_time = address_info->due_time;
417 u32 sw_if_index = address_info->sw_if_index;
418 error = ip6_add_del_interface_address (vm, sw_if_index,
419 &address_info->address,
422 clib_warning ("Failed to delete interface address");
423 pool_put (rm->address_pool, address_info);
424 /* make sure ip6 stays enabled */
425 ip6_enable (sw_if_index);
426 client_state = &rm->client_state_by_sw_if_index[sw_if_index];
427 if (--client_state->address_count == 0)
429 client_state->rebinding = 0;
430 client_state->server_index = ~0;
431 send_client_message_start_stop (sw_if_index, ~0,
438 for (i = 0; i < vec_len (rm->client_state_by_sw_if_index); i++)
440 client_state_t *cs = &rm->client_state_by_sw_if_index[i];
441 if (cs->enabled && cs->server_index != ~0)
443 if (cs->T2_due_time > current_time)
445 if (cs->T2_due_time < due_time)
446 due_time = cs->T2_due_time;
447 if (cs->T1_due_time > current_time)
449 if (cs->T1_due_time < due_time)
450 due_time = cs->T1_due_time;
454 cs->T1_due_time = DBL_MAX;
455 address_info_t *address_list;
456 address_list = create_address_list (i);
458 send_client_message_start_stop (i, cs->server_index,
461 vec_free (address_list);
466 cs->T2_due_time = DBL_MAX;
467 address_info_t *address_list;
468 address_list = create_address_list (i);
470 send_client_message_start_stop (i, ~0,
473 vec_free (address_list);
477 current_time = vlib_time_now (vm);
479 while (due_time < current_time);
481 sleep_time = due_time - current_time;
488 VLIB_REGISTER_NODE (dhcp6_client_cp_process_node) = {
489 .function = dhcp6_client_cp_process,
490 .type = VLIB_NODE_TYPE_PROCESS,
491 .name = "dhcp6-client-cp-process",
496 interrupt_process (void)
498 dhcp6_client_cp_main_t *rm = &dhcp6_client_cp_main;
499 vlib_main_t *vm = rm->vlib_main;
501 vlib_process_signal_event (vm, dhcp6_client_cp_process_node.index,
502 RD_CP_EVENT_INTERRUPT, 0);
506 disable_process (void)
508 dhcp6_client_cp_main_t *rm = &dhcp6_client_cp_main;
509 vlib_main_t *vm = rm->vlib_main;
511 vlib_process_signal_event (vm, dhcp6_client_cp_process_node.index,
512 RD_CP_EVENT_DISABLE, 0);
516 enable_process (void)
518 dhcp6_client_cp_main_t *rm = &dhcp6_client_cp_main;
519 vlib_main_t *vm = rm->vlib_main;
522 node = vec_elt (vm->node_main.nodes, rm->node_index);
524 vlib_node_set_state (vm, rm->node_index, VLIB_NODE_STATE_POLLING);
525 vlib_start_process (vm, node->runtime_index);
528 static clib_error_t *
529 dhcp6_addresses_show_command_function (vlib_main_t * vm,
530 unformat_input_t * input,
531 vlib_cli_command_t * cmd)
533 dhcp6_client_cp_main_t *dm = &dhcp6_client_cp_main;
534 clib_error_t *error = 0;
535 address_info_t *address_info;
536 f64 current_time = vlib_time_now (vm);
539 pool_foreach (address_info, dm->address_pool,
541 vlib_cli_output (vm, "address: %U, "
542 "preferred lifetime: %u, valid lifetime: %u "
544 format_ip6_address, &address_info->address,
545 address_info->preferred_lt, address_info->valid_lt,
546 address_info->due_time - current_time);
554 VLIB_CLI_COMMAND (dhcp6_addresses_show_command, static) = {
555 .path = "show dhcp6 addresses",
556 .short_help = "show dhcp6 addresses",
557 .function = dhcp6_addresses_show_command_function,
561 static clib_error_t *
562 dhcp6_clients_show_command_function (vlib_main_t * vm,
563 unformat_input_t * input,
564 vlib_cli_command_t * cmd)
566 dhcp6_client_cp_main_t *rm = &dhcp6_client_cp_main;
567 clib_error_t *error = 0;
569 f64 current_time = vlib_time_now (vm);
572 const char *rebinding;
575 for (i = 0; i < vec_len (rm->client_state_by_sw_if_index); i++)
577 cs = &rm->client_state_by_sw_if_index[i];
580 if (cs->T1_due_time != DBL_MAX && cs->T1_due_time > current_time)
582 sprintf (buf1, "%u remaining",
583 (u32) round (cs->T1_due_time - current_time));
586 sprintf (buf1, "timeout");
587 if (cs->T2_due_time != DBL_MAX && cs->T2_due_time > current_time)
588 sprintf (buf2, "%u remaining",
589 (u32) round (cs->T2_due_time - current_time));
591 sprintf (buf2, "timeout");
593 rebinding = ", REBINDING";
598 "sw_if_index: %u, T1: %u (%s), "
599 "T2: %u (%s), server index: %d%s", i,
600 cs->T1, buf1, cs->T2, buf2,
601 cs->server_index, rebinding);
603 vlib_cli_output (vm, "sw_if_index: %u%s", i, rebinding);
611 VLIB_CLI_COMMAND (dhcp6_clients_show_command, static) = {
612 .path = "show dhcp6 clients",
613 .short_help = "show dhcp6 clients",
614 .function = dhcp6_clients_show_command_function,
619 dhcp6_client_enable_disable (u32 sw_if_index, u8 enable)
621 dhcp6_client_cp_main_t *rm = &dhcp6_client_cp_main;
622 vnet_main_t *vnm = rm->vnet_main;
623 vlib_main_t *vm = rm->vlib_main;
624 client_state_t *client_state;
625 client_state_t empty_config = { 0 };
626 address_info_t *address_info;
629 if (!vnet_sw_interface_is_api_valid (vnm, sw_if_index))
631 clib_warning ("Invalid sw_if_index");
635 vec_validate_init_empty (rm->client_state_by_sw_if_index, sw_if_index,
637 client_state = &rm->client_state_by_sw_if_index[sw_if_index];
639 u8 old_enabled = client_state->enabled;
641 client_state->enabled = 1;
642 client_state->server_index = ~0;
644 if (!old_enabled && enable)
647 if (rm->n_clients == 1)
650 dhcp6_clients_enable_disable (1);
653 ip6_enable (sw_if_index);
654 send_client_message_start_stop (sw_if_index, ~0, DHCPV6_MSG_SOLICIT,
657 else if (old_enabled && !enable)
659 send_client_message_start_stop (sw_if_index, ~0, ~0, 0, 0);
662 if (rm->n_clients == 0)
664 dhcp6_clients_enable_disable (0);
669 pool_foreach (address_info, rm->address_pool,
671 if (address_info->sw_if_index == sw_if_index)
673 ASSERT (sw_if_index < vec_len (rm->client_state_by_sw_if_index) &&
674 rm->client_state_by_sw_if_index[sw_if_index].enabled);
675 client_state_t *client_state =
676 &rm->client_state_by_sw_if_index[sw_if_index];
677 send_client_message_start_stop (sw_if_index,
678 client_state->server_index,
679 DHCPV6_MSG_RELEASE, address_info,
681 error = ip6_add_del_interface_address (vm, sw_if_index,
682 &address_info->address,
685 clib_warning ("Failed to delete interface address");
686 pool_put (rm->address_pool, address_info);
693 client_state->enabled = 0;
698 static clib_error_t *
699 dhcp6_client_enable_disable_command_fn (vlib_main_t * vm,
700 unformat_input_t * input,
701 vlib_cli_command_t * cmd)
703 dhcp6_client_cp_main_t *rm = &dhcp6_client_cp_main;
704 vnet_main_t *vnm = rm->vnet_main;
705 clib_error_t *error = 0;
706 u32 sw_if_index = ~0;
708 unformat_input_t _line_input, *line_input = &_line_input;
710 if (!unformat_user (input, unformat_line_input, line_input))
713 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
716 (line_input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
718 else if (unformat (line_input, "disable"))
722 error = clib_error_return (0, "unexpected input `%U'",
723 format_unformat_error, line_input);
728 unformat_free (line_input);
730 if (sw_if_index != ~0)
732 if (dhcp6_client_enable_disable (sw_if_index, enable) != 0)
733 error = clib_error_return (0, "Invalid sw_if_index");
736 error = clib_error_return (0, "Missing sw_if_index");
743 * This command is used to enable/disable DHCPv6 client
744 * on particular interface.
748 * Example of how to enable DHCPv6 client:
749 * @cliexcmd{dhcp6 client GigabitEthernet2/0/0}
750 * Example of how to disable DHCPv6 client:
751 * @cliexcmd{dhcp6 client GigabitEthernet2/0/0 disable}
755 VLIB_CLI_COMMAND (dhcp6_client_enable_disable_command, static) = {
756 .path = "dhcp6 client",
757 .short_help = "dhcp6 client <interface> [disable]",
758 .function = dhcp6_client_enable_disable_command_fn,
762 static clib_error_t *
763 dhcp_ia_na_client_cp_init (vlib_main_t * vm)
765 dhcp6_client_cp_main_t *rm = &dhcp6_client_cp_main;
768 rm->vnet_main = vnet_get_main ();
769 rm->api_main = &api_main;
770 rm->node_index = dhcp6_client_cp_process_node.index;
775 VLIB_INIT_FUNCTION (dhcp_ia_na_client_cp_init);
778 * fd.io coding-style-patch-verification: ON
781 * eval: (c-set-style "gnu")