2 This file is part of systemd.
4 Copyright (C) 2013 Intel Corporation. All rights reserved.
6 systemd is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
11 systemd is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with systemd; If not, see <http://www.gnu.org/licenses/>.
24 #include <net/ethernet.h>
25 #include <sys/param.h>
30 #include "dhcp-protocol.h"
31 #include "dhcp-lease.h"
32 #include "dhcp-internal.h"
33 #include "sd-dhcp-client.h"
35 struct sd_dhcp_client {
39 sd_event_source *timeout_resend;
42 union sockaddr_union link;
43 sd_event_source *receive_message;
45 size_t req_opts_allocated;
48 struct ether_addr mac_addr;
54 sd_event_source *timeout_t1;
55 sd_event_source *timeout_t2;
56 sd_event_source *timeout_expire;
57 sd_dhcp_client_cb_t cb;
62 static const uint8_t default_req_opts[] = {
63 DHCP_OPTION_SUBNET_MASK,
65 DHCP_OPTION_HOST_NAME,
66 DHCP_OPTION_DOMAIN_NAME,
67 DHCP_OPTION_DOMAIN_NAME_SERVER,
68 DHCP_OPTION_NTP_SERVER,
71 static int client_receive_message_raw(sd_event_source *s, int fd,
72 uint32_t revents, void *userdata);
73 static int client_receive_message_udp(sd_event_source *s, int fd,
74 uint32_t revents, void *userdata);
76 int sd_dhcp_client_set_callback(sd_dhcp_client *client, sd_dhcp_client_cb_t cb,
78 assert_return(client, -EINVAL);
81 client->userdata = userdata;
86 int sd_dhcp_client_set_request_option(sd_dhcp_client *client, uint8_t option) {
89 assert_return(client, -EINVAL);
90 assert_return (client->state == DHCP_STATE_INIT, -EBUSY);
94 case DHCP_OPTION_OVERLOAD:
95 case DHCP_OPTION_MESSAGE_TYPE:
96 case DHCP_OPTION_PARAMETER_REQUEST_LIST:
104 for (i = 0; i < client->req_opts_size; i++)
105 if (client->req_opts[i] == option)
108 if (!GREEDY_REALLOC(client->req_opts, client->req_opts_allocated,
109 client->req_opts_size + 1))
112 client->req_opts[client->req_opts_size++] = option;
117 int sd_dhcp_client_set_request_address(sd_dhcp_client *client,
118 const struct in_addr *last_addr) {
119 assert_return(client, -EINVAL);
120 assert_return(client->state == DHCP_STATE_INIT, -EBUSY);
123 client->last_addr = last_addr->s_addr;
125 client->last_addr = INADDR_ANY;
130 int sd_dhcp_client_set_index(sd_dhcp_client *client, int interface_index) {
131 assert_return(client, -EINVAL);
132 assert_return(client->state == DHCP_STATE_INIT, -EBUSY);
133 assert_return(interface_index >= -1, -EINVAL);
135 client->index = interface_index;
140 int sd_dhcp_client_set_mac(sd_dhcp_client *client,
141 const struct ether_addr *addr) {
142 assert_return(client, -EINVAL);
143 assert_return(client->state == DHCP_STATE_INIT, -EBUSY);
145 memcpy(&client->mac_addr, addr, ETH_ALEN);
150 int sd_dhcp_client_get_lease(sd_dhcp_client *client, sd_dhcp_lease **ret) {
151 assert_return(client, -EINVAL);
152 assert_return(ret, -EINVAL);
154 if (client->state != DHCP_STATE_BOUND &&
155 client->state != DHCP_STATE_RENEWING &&
156 client->state != DHCP_STATE_REBINDING)
157 return -EADDRNOTAVAIL;
159 *ret = sd_dhcp_lease_ref(client->lease);
164 static int client_notify(sd_dhcp_client *client, int event) {
166 client->cb(client, event, client->userdata);
171 static int client_stop(sd_dhcp_client *client, int error) {
172 assert_return(client, -EINVAL);
174 client->receive_message =
175 sd_event_source_unref(client->receive_message);
181 client->timeout_resend = sd_event_source_unref(client->timeout_resend);
183 client->timeout_t1 = sd_event_source_unref(client->timeout_t1);
184 client->timeout_t2 = sd_event_source_unref(client->timeout_t2);
185 client->timeout_expire = sd_event_source_unref(client->timeout_expire);
189 client_notify(client, error);
191 client->start_time = 0;
193 client->state = DHCP_STATE_INIT;
196 client->lease = sd_dhcp_lease_unref(client->lease);
201 static int client_message_init(sd_dhcp_client *client, DHCPMessage *message,
202 uint8_t type, uint16_t secs, uint8_t **opt,
206 r = dhcp_message_init(message, BOOTREQUEST, client->xid, type,
211 memcpy(&message->chaddr, &client->mac_addr, ETH_ALEN);
213 if (client->state == DHCP_STATE_RENEWING ||
214 client->state == DHCP_STATE_REBINDING)
215 message->ciaddr = client->lease->address;
217 /* Some DHCP servers will refuse to issue an DHCP lease if the Cliient
218 Identifier option is not set */
219 r = dhcp_option_append(opt, optlen, DHCP_OPTION_CLIENT_IDENTIFIER,
220 ETH_ALEN, &client->mac_addr);
224 if (type == DHCP_DISCOVER || type == DHCP_REQUEST) {
227 r = dhcp_option_append(opt, optlen,
228 DHCP_OPTION_PARAMETER_REQUEST_LIST,
229 client->req_opts_size,
234 /* Some DHCP servers will send bigger DHCP packets than the
235 defined default size unless the Maximum Messge Size option
236 is explicitely set */
237 max_size = htobe16(DHCP_IP_UDP_SIZE + DHCP_MESSAGE_SIZE +
238 DHCP_MIN_OPTIONS_SIZE);
239 r = dhcp_option_append(opt, optlen,
240 DHCP_OPTION_MAXIMUM_MESSAGE_SIZE,
249 static int client_send_discover(sd_dhcp_client *client, uint16_t secs) {
251 _cleanup_free_ DHCPPacket *discover;
255 optlen = DHCP_MIN_OPTIONS_SIZE;
256 len = sizeof(DHCPPacket) + optlen;
258 discover = malloc0(len);
263 err = client_message_init(client, &discover->dhcp, DHCP_DISCOVER,
264 secs, &opt, &optlen);
268 if (client->last_addr != INADDR_ANY) {
269 err = dhcp_option_append(&opt, &optlen,
270 DHCP_OPTION_REQUESTED_IP_ADDRESS,
271 4, &client->last_addr);
276 err = dhcp_option_append(&opt, &optlen, DHCP_OPTION_END, 0, NULL);
280 dhcp_packet_append_ip_headers(discover, BOOTREQUEST, len);
282 err = dhcp_network_send_raw_socket(client->fd, &client->link,
288 static int client_send_request(sd_dhcp_client *client, uint16_t secs) {
289 _cleanup_free_ DHCPPacket *request;
294 optlen = DHCP_MIN_OPTIONS_SIZE;
295 len = DHCP_MESSAGE_SIZE + optlen;
297 request = malloc0(len);
301 err = client_message_init(client, &request->dhcp, DHCP_REQUEST, secs,
306 if (client->state == DHCP_STATE_REQUESTING) {
307 err = dhcp_option_append(&opt, &optlen,
308 DHCP_OPTION_REQUESTED_IP_ADDRESS,
309 4, &client->lease->address);
313 err = dhcp_option_append(&opt, &optlen,
314 DHCP_OPTION_SERVER_IDENTIFIER,
315 4, &client->lease->server_address);
320 err = dhcp_option_append(&opt, &optlen, DHCP_OPTION_END, 0, NULL);
324 if (client->state == DHCP_STATE_RENEWING) {
325 err = dhcp_network_send_udp_socket(client->fd,
326 client->lease->server_address,
329 len - DHCP_IP_UDP_SIZE);
331 dhcp_packet_append_ip_headers(request, BOOTREQUEST, len);
333 err = dhcp_network_send_raw_socket(client->fd, &client->link,
340 static uint16_t client_update_secs(sd_dhcp_client *client, usec_t time_now)
342 client->secs = ((time_now - client->start_time) / USEC_PER_SEC) ? : 1;
347 static int client_timeout_resend(sd_event_source *s, uint64_t usec,
349 sd_dhcp_client *client = userdata;
350 usec_t next_timeout = 0;
356 assert(client->event);
358 switch (client->state) {
359 case DHCP_STATE_RENEWING:
361 time_left = (client->lease->t2 - client->lease->t1) / 2;
365 next_timeout = usec + time_left * USEC_PER_SEC;
369 case DHCP_STATE_REBINDING:
371 time_left = (client->lease->lifetime - client->lease->t2) / 2;
375 next_timeout = usec + time_left * USEC_PER_SEC;
378 case DHCP_STATE_INIT:
379 case DHCP_STATE_INIT_REBOOT:
380 case DHCP_STATE_REBOOTING:
381 case DHCP_STATE_SELECTING:
382 case DHCP_STATE_REQUESTING:
383 case DHCP_STATE_BOUND:
385 if (client->attempt < 64)
386 client->attempt *= 2;
388 next_timeout = usec + (client->attempt - 1) * USEC_PER_SEC;
393 next_timeout += (random_u32() & 0x1fffff);
395 r = sd_event_add_monotonic(client->event,
396 &client->timeout_resend,
399 client_timeout_resend, client);
403 r = sd_event_source_set_priority(client->timeout_resend,
404 client->event_priority);
408 switch (client->state) {
409 case DHCP_STATE_INIT:
411 client_update_secs(client, usec);
413 r = client_send_discover(client, client->secs);
415 client->state = DHCP_STATE_SELECTING;
418 if (client->attempt >= 64)
424 case DHCP_STATE_SELECTING:
425 client_update_secs(client, usec);
427 r = client_send_discover(client, client->secs);
428 if (r < 0 && client->attempt >= 64)
433 case DHCP_STATE_REQUESTING:
434 case DHCP_STATE_RENEWING:
435 case DHCP_STATE_REBINDING:
436 r = client_send_request(client, client->secs);
437 if (r < 0 && client->attempt >= 64)
440 client->request_sent = usec;
444 case DHCP_STATE_INIT_REBOOT:
445 case DHCP_STATE_REBOOTING:
446 case DHCP_STATE_BOUND:
454 client_stop(client, r);
456 /* Errors were dealt with when stopping the client, don't spill
457 errors into the event loop handler */
461 static int client_initialize_events(sd_dhcp_client *client,
462 sd_event_io_handler_t io_callback,
467 assert(client->event);
469 r = sd_event_add_io(client->event, &client->receive_message,
470 client->fd, EPOLLIN, io_callback,
475 r = sd_event_source_set_priority(client->receive_message,
476 client->event_priority);
480 r = sd_event_add_monotonic(client->event,
481 &client->timeout_resend,
483 client_timeout_resend, client);
487 r = sd_event_source_set_priority(client->timeout_resend,
488 client->event_priority);
492 client_stop(client, r);
498 static int client_timeout_expire(sd_event_source *s, uint64_t usec,
500 sd_dhcp_client *client = userdata;
502 client_stop(client, DHCP_EVENT_EXPIRED);
507 static int client_timeout_t2(sd_event_source *s, uint64_t usec, void *userdata) {
508 sd_dhcp_client *client = userdata;
511 if (client->fd >= 0) {
512 client->receive_message =
513 sd_event_source_unref(client->receive_message);
518 client->state = DHCP_STATE_REBINDING;
521 r = dhcp_network_bind_raw_socket(client->index, &client->link);
523 client_stop(client, r);
529 return client_initialize_events(client, client_receive_message_raw,
533 static int client_timeout_t1(sd_event_source *s, uint64_t usec,
535 sd_dhcp_client *client = userdata;
538 client->state = DHCP_STATE_RENEWING;
541 r = dhcp_network_bind_udp_socket(client->index,
542 client->lease->address,
545 client_stop(client, r);
551 return client_initialize_events(client, client_receive_message_udp, usec);
554 static int client_handle_offer(sd_dhcp_client *client, DHCPMessage *offer,
556 _cleanup_dhcp_lease_unref_ sd_dhcp_lease *lease = NULL;
559 r = dhcp_lease_new(&lease);
563 r = dhcp_option_parse(offer, len, dhcp_lease_parse_options, lease);
567 lease->address = offer->yiaddr;
569 if (lease->address == INADDR_ANY ||
570 lease->server_address == INADDR_ANY ||
571 lease->subnet_mask == INADDR_ANY ||
572 lease->lifetime == 0)
575 client->lease = lease;
581 static int client_handle_ack(sd_dhcp_client *client, DHCPMessage *ack,
583 _cleanup_dhcp_lease_unref_ sd_dhcp_lease *lease = NULL;
586 r = dhcp_lease_new(&lease);
590 r = dhcp_option_parse(ack, len, dhcp_lease_parse_options, lease);
592 return DHCP_EVENT_NO_LEASE;
597 lease->address = ack->yiaddr;
599 if (lease->address == INADDR_ANY ||
600 lease->server_address == INADDR_ANY ||
601 lease->subnet_mask == INADDR_ANY || lease->lifetime == 0)
604 r = DHCP_EVENT_IP_ACQUIRE;
606 if (client->lease->address != lease->address ||
607 client->lease->subnet_mask != lease->subnet_mask ||
608 client->lease->router != lease->router) {
609 r = DHCP_EVENT_IP_CHANGE;
612 client->lease = sd_dhcp_lease_unref(client->lease);
615 client->lease = lease;
621 static uint64_t client_compute_timeout(uint64_t request_sent,
623 return request_sent + (lifetime - 3) * USEC_PER_SEC +
624 + (random_u32() & 0x1fffff);
627 static int client_set_lease_timeouts(sd_dhcp_client *client, uint64_t usec) {
628 uint64_t next_timeout;
632 assert(client->event);
634 if (client->lease->lifetime < 10)
637 client->timeout_t1 = sd_event_source_unref(client->timeout_t1);
638 client->timeout_t2 = sd_event_source_unref(client->timeout_t2);
639 client->timeout_expire = sd_event_source_unref(client->timeout_expire);
641 if (!client->lease->t1)
642 client->lease->t1 = client->lease->lifetime / 2;
644 next_timeout = client_compute_timeout(client->request_sent,
646 if (next_timeout < usec)
649 r = sd_event_add_monotonic(client->event,
653 client_timeout_t1, client);
657 r = sd_event_source_set_priority(client->timeout_t1,
658 client->event_priority);
662 if (!client->lease->t2)
663 client->lease->t2 = client->lease->lifetime * 7 / 8;
665 if (client->lease->t2 < client->lease->t1)
668 if (client->lease->lifetime < client->lease->t2)
671 next_timeout = client_compute_timeout(client->request_sent,
673 if (next_timeout < usec)
676 r = sd_event_add_monotonic(client->event,
680 client_timeout_t2, client);
684 r = sd_event_source_set_priority(client->timeout_t2,
685 client->event_priority);
689 next_timeout = client_compute_timeout(client->request_sent,
690 client->lease->lifetime);
691 if (next_timeout < usec)
694 r = sd_event_add_monotonic(client->event,
695 &client->timeout_expire, next_timeout,
697 client_timeout_expire, client);
701 r = sd_event_source_set_priority(client->timeout_expire,
702 client->event_priority);
709 static int client_handle_message(sd_dhcp_client *client, DHCPMessage *message,
710 int len, usec_t time_now) {
711 int r = 0, notify_event = 0;
714 assert(client->event);
717 if (be32toh(message->xid) != client->xid)
720 if (memcmp(&message->chaddr[0], &client->mac_addr.ether_addr_octet,
724 switch (client->state) {
725 case DHCP_STATE_SELECTING:
727 r = client_handle_offer(client, message, len);
730 client->timeout_resend =
731 sd_event_source_unref(client->timeout_resend);
733 client->state = DHCP_STATE_REQUESTING;
736 r = sd_event_add_monotonic(client->event,
737 &client->timeout_resend,
739 client_timeout_resend,
744 r = sd_event_source_set_priority(client->timeout_resend,
745 client->event_priority);
752 case DHCP_STATE_REQUESTING:
753 case DHCP_STATE_RENEWING:
754 case DHCP_STATE_REBINDING:
756 r = client_handle_ack(client, message, len);
758 if (r == DHCP_EVENT_NO_LEASE)
762 client->timeout_resend =
763 sd_event_source_unref(client->timeout_resend);
765 if (client->state == DHCP_STATE_REQUESTING)
766 notify_event = DHCP_EVENT_IP_ACQUIRE;
767 else if (r != DHCP_EVENT_IP_ACQUIRE)
770 client->state = DHCP_STATE_BOUND;
773 client->last_addr = client->lease->address;
775 r = client_set_lease_timeouts(client, time_now);
780 client_notify(client, notify_event);
782 client->receive_message =
783 sd_event_source_unref(client->receive_message);
792 case DHCP_STATE_INIT:
793 case DHCP_STATE_INIT_REBOOT:
794 case DHCP_STATE_REBOOTING:
795 case DHCP_STATE_BOUND:
801 if (r < 0 || r == DHCP_EVENT_NO_LEASE)
802 return client_stop(client, r);
807 static int client_receive_message_udp(sd_event_source *s, int fd,
808 uint32_t revents, void *userdata) {
809 sd_dhcp_client *client = userdata;
810 uint8_t buf[sizeof(DHCPMessage) + DHCP_MIN_OPTIONS_SIZE];
811 int buflen = sizeof(buf);
817 assert(client->event);
819 len = read(fd, &buf, buflen);
823 r = sd_event_get_now_monotonic(client->event, &time_now);
825 return client_stop(client, r);
827 return client_handle_message(client, (DHCPMessage *) buf, len,
831 static int client_receive_message_raw(sd_event_source *s, int fd,
832 uint32_t revents, void *userdata) {
833 sd_dhcp_client *client = userdata;
834 uint8_t buf[sizeof(DHCPPacket) + DHCP_MIN_OPTIONS_SIZE];
835 int buflen = sizeof(buf);
842 assert(client->event);
844 len = read(fd, &buf, buflen);
848 packet = (DHCPPacket *) buf;
850 r = dhcp_packet_verify_headers(packet, BOOTREPLY, len);
854 len -= DHCP_IP_UDP_SIZE;
856 r = sd_event_get_now_monotonic(client->event, &time_now);
858 return client_stop(client, r);
860 return client_handle_message(client, &packet->dhcp, len, time_now);
863 int sd_dhcp_client_start(sd_dhcp_client *client) {
866 assert_return(client, -EINVAL);
867 assert_return(client->event, -EINVAL);
868 assert_return(client->index > 0, -EINVAL);
869 assert_return(client->state == DHCP_STATE_INIT ||
870 client->state == DHCP_STATE_INIT_REBOOT, -EBUSY);
872 client->xid = random_u32();
874 r = dhcp_network_bind_raw_socket(client->index, &client->link);
877 client_stop(client, r);
882 client->start_time = now(CLOCK_MONOTONIC);
885 return client_initialize_events(client, client_receive_message_raw,
889 int sd_dhcp_client_stop(sd_dhcp_client *client) {
890 return client_stop(client, DHCP_EVENT_STOP);
893 int sd_dhcp_client_attach_event(sd_dhcp_client *client, sd_event *event,
897 assert_return(client, -EINVAL);
898 assert_return(!client->event, -EBUSY);
901 client->event = sd_event_ref(event);
903 r = sd_event_default(&client->event);
908 client->event_priority = priority;
913 int sd_dhcp_client_detach_event(sd_dhcp_client *client) {
914 assert_return(client, -EINVAL);
916 client->event = sd_event_unref(client->event);
921 sd_event *sd_dhcp_client_get_event(sd_dhcp_client *client) {
925 return client->event;
928 void sd_dhcp_client_free(sd_dhcp_client *client) {
932 sd_dhcp_client_stop(client);
933 sd_dhcp_client_detach_event(client);
935 free(client->req_opts);
939 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_dhcp_client*, sd_dhcp_client_free);
940 #define _cleanup_dhcp_client_free_ _cleanup_(sd_dhcp_client_freep)
942 int sd_dhcp_client_new(sd_dhcp_client **ret) {
943 _cleanup_dhcp_client_free_ sd_dhcp_client *client = NULL;
945 assert_return(ret, -EINVAL);
947 client = new0(sd_dhcp_client, 1);
951 client->state = DHCP_STATE_INIT;
956 client->req_opts_size = ELEMENTSOF(default_req_opts);
958 client->req_opts = memdup(default_req_opts, client->req_opts_size);
959 if (!client->req_opts)