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>
26 #include <sys/ioctl.h>
31 #include "dhcp-protocol.h"
32 #include "dhcp-internal.h"
33 #include "dhcp-lease-internal.h"
34 #include "sd-dhcp-client.h"
36 struct sd_dhcp_client {
40 sd_event_source *timeout_resend;
43 union sockaddr_union link;
44 sd_event_source *receive_message;
46 size_t req_opts_allocated;
49 struct ether_addr mac_addr;
55 sd_event_source *timeout_t1;
56 sd_event_source *timeout_t2;
57 sd_event_source *timeout_expire;
58 sd_dhcp_client_cb_t cb;
63 static const uint8_t default_req_opts[] = {
64 DHCP_OPTION_SUBNET_MASK,
66 DHCP_OPTION_HOST_NAME,
67 DHCP_OPTION_DOMAIN_NAME,
68 DHCP_OPTION_DOMAIN_NAME_SERVER,
69 DHCP_OPTION_NTP_SERVER,
72 static int client_receive_message_raw(sd_event_source *s, int fd,
73 uint32_t revents, void *userdata);
74 static int client_receive_message_udp(sd_event_source *s, int fd,
75 uint32_t revents, void *userdata);
77 int sd_dhcp_client_set_callback(sd_dhcp_client *client, sd_dhcp_client_cb_t cb,
79 assert_return(client, -EINVAL);
82 client->userdata = userdata;
87 int sd_dhcp_client_set_request_option(sd_dhcp_client *client, uint8_t option) {
90 assert_return(client, -EINVAL);
91 assert_return (client->state == DHCP_STATE_INIT, -EBUSY);
95 case DHCP_OPTION_OVERLOAD:
96 case DHCP_OPTION_MESSAGE_TYPE:
97 case DHCP_OPTION_PARAMETER_REQUEST_LIST:
105 for (i = 0; i < client->req_opts_size; i++)
106 if (client->req_opts[i] == option)
109 if (!GREEDY_REALLOC(client->req_opts, client->req_opts_allocated,
110 client->req_opts_size + 1))
113 client->req_opts[client->req_opts_size++] = option;
118 int sd_dhcp_client_set_request_address(sd_dhcp_client *client,
119 const struct in_addr *last_addr) {
120 assert_return(client, -EINVAL);
121 assert_return(client->state == DHCP_STATE_INIT, -EBUSY);
124 client->last_addr = last_addr->s_addr;
126 client->last_addr = INADDR_ANY;
131 int sd_dhcp_client_set_index(sd_dhcp_client *client, int interface_index) {
132 assert_return(client, -EINVAL);
133 assert_return(client->state == DHCP_STATE_INIT, -EBUSY);
134 assert_return(interface_index >= -1, -EINVAL);
136 client->index = interface_index;
141 int sd_dhcp_client_set_mac(sd_dhcp_client *client,
142 const struct ether_addr *addr) {
143 assert_return(client, -EINVAL);
144 assert_return(client->state == DHCP_STATE_INIT, -EBUSY);
146 log_dhcp_client(client, "set MAC address to "
147 "%02hhx:%02hhx:%02hhx:%02hhx:%02hhx:%02hhx",
148 addr->ether_addr_octet[0],
149 addr->ether_addr_octet[1],
150 addr->ether_addr_octet[2],
151 addr->ether_addr_octet[3],
152 addr->ether_addr_octet[4],
153 addr->ether_addr_octet[5]);
155 memcpy(&client->mac_addr, addr, ETH_ALEN);
160 int sd_dhcp_client_get_lease(sd_dhcp_client *client, sd_dhcp_lease **ret) {
161 assert_return(client, -EINVAL);
162 assert_return(ret, -EINVAL);
164 if (client->state != DHCP_STATE_BOUND &&
165 client->state != DHCP_STATE_RENEWING &&
166 client->state != DHCP_STATE_REBINDING)
167 return -EADDRNOTAVAIL;
169 *ret = sd_dhcp_lease_ref(client->lease);
174 static int client_notify(sd_dhcp_client *client, int event) {
176 client->cb(client, event, client->userdata);
181 static int client_stop(sd_dhcp_client *client, int error) {
182 assert_return(client, -EINVAL);
184 client->receive_message =
185 sd_event_source_unref(client->receive_message);
187 client->fd = safe_close(client->fd);
189 client->timeout_resend = sd_event_source_unref(client->timeout_resend);
191 client->timeout_t1 = sd_event_source_unref(client->timeout_t1);
192 client->timeout_t2 = sd_event_source_unref(client->timeout_t2);
193 client->timeout_expire = sd_event_source_unref(client->timeout_expire);
197 client_notify(client, error);
199 client->start_time = 0;
201 client->state = DHCP_STATE_INIT;
204 client->lease = sd_dhcp_lease_unref(client->lease);
206 log_dhcp_client(client, "STOPPED");
211 static int client_message_init(sd_dhcp_client *client, DHCPMessage *message,
212 uint8_t type, uint16_t secs, uint8_t **opt,
218 r = dhcp_message_init(message, BOOTREQUEST, client->xid, type, opt,
223 /* Although 'secs' field is a SHOULD in RFC 2131, certain DHCP servers
224 refuse to issue an DHCP lease if 'secs' is set to zero */
225 message->secs = htobe16(secs);
227 memcpy(&message->chaddr, &client->mac_addr, ETH_ALEN);
229 if (client->state == DHCP_STATE_RENEWING ||
230 client->state == DHCP_STATE_REBINDING)
231 message->ciaddr = client->lease->address;
233 /* Some DHCP servers will refuse to issue an DHCP lease if the Client
234 Identifier option is not set */
235 r = dhcp_option_append(opt, optlen, DHCP_OPTION_CLIENT_IDENTIFIER,
236 ETH_ALEN, &client->mac_addr);
240 if (type == DHCP_DISCOVER || type == DHCP_REQUEST) {
243 r = dhcp_option_append(opt, optlen,
244 DHCP_OPTION_PARAMETER_REQUEST_LIST,
245 client->req_opts_size,
250 /* Some DHCP servers will send bigger DHCP packets than the
251 defined default size unless the Maximum Messge Size option
252 is explicitely set */
253 max_size = htobe16(DHCP_IP_UDP_SIZE + DHCP_MESSAGE_SIZE +
254 DHCP_MIN_OPTIONS_SIZE);
255 r = dhcp_option_append(opt, optlen,
256 DHCP_OPTION_MAXIMUM_MESSAGE_SIZE,
265 static int dhcp_client_send_raw(sd_dhcp_client *client, DHCPPacket *packet,
267 dhcp_packet_append_ip_headers(packet, INADDR_ANY, DHCP_PORT_CLIENT,
268 INADDR_BROADCAST, DHCP_PORT_SERVER, len);
270 return dhcp_network_send_raw_socket(client->fd, &client->link,
274 static int client_send_discover(sd_dhcp_client *client, uint16_t secs) {
276 _cleanup_free_ DHCPPacket *discover;
280 optlen = DHCP_MIN_OPTIONS_SIZE;
281 len = sizeof(DHCPPacket) + optlen;
283 discover = malloc0(len);
288 err = client_message_init(client, &discover->dhcp, DHCP_DISCOVER,
289 secs, &opt, &optlen);
293 if (client->last_addr != INADDR_ANY) {
294 err = dhcp_option_append(&opt, &optlen,
295 DHCP_OPTION_REQUESTED_IP_ADDRESS,
296 4, &client->last_addr);
301 err = dhcp_option_append(&opt, &optlen, DHCP_OPTION_END, 0, NULL);
305 err = dhcp_client_send_raw(client, discover, len);
309 log_dhcp_client(client, "DISCOVER");
314 static int client_send_request(sd_dhcp_client *client, uint16_t secs) {
315 _cleanup_free_ DHCPPacket *request;
320 optlen = DHCP_MIN_OPTIONS_SIZE;
321 len = sizeof(DHCPPacket) + optlen;
323 request = malloc0(len);
327 err = client_message_init(client, &request->dhcp, DHCP_REQUEST, secs,
332 if (client->state == DHCP_STATE_REQUESTING) {
333 err = dhcp_option_append(&opt, &optlen,
334 DHCP_OPTION_REQUESTED_IP_ADDRESS,
335 4, &client->lease->address);
339 err = dhcp_option_append(&opt, &optlen,
340 DHCP_OPTION_SERVER_IDENTIFIER,
341 4, &client->lease->server_address);
346 err = dhcp_option_append(&opt, &optlen, DHCP_OPTION_END, 0, NULL);
350 if (client->state == DHCP_STATE_RENEWING) {
351 err = dhcp_network_send_udp_socket(client->fd,
352 client->lease->server_address,
355 len - DHCP_IP_UDP_SIZE);
357 err = dhcp_client_send_raw(client, request, len);
362 log_dhcp_client(client, "REQUEST");
367 static uint16_t client_update_secs(sd_dhcp_client *client, usec_t time_now)
369 client->secs = ((time_now - client->start_time) / USEC_PER_SEC) ? : 1;
374 static int client_timeout_resend(sd_event_source *s, uint64_t usec,
376 sd_dhcp_client *client = userdata;
377 usec_t next_timeout = 0;
384 assert(client->event);
386 r = sd_event_get_now_monotonic(client->event, &time_now);
390 switch (client->state) {
391 case DHCP_STATE_RENEWING:
393 time_left = (client->lease->t2 - client->lease->t1) / 2;
397 next_timeout = time_now + time_left * USEC_PER_SEC;
401 case DHCP_STATE_REBINDING:
403 time_left = (client->lease->lifetime - client->lease->t2) / 2;
407 next_timeout = time_now + time_left * USEC_PER_SEC;
410 case DHCP_STATE_INIT:
411 case DHCP_STATE_INIT_REBOOT:
412 case DHCP_STATE_REBOOTING:
413 case DHCP_STATE_SELECTING:
414 case DHCP_STATE_REQUESTING:
415 case DHCP_STATE_BOUND:
417 if (client->attempt < 64)
418 client->attempt *= 2;
420 next_timeout = time_now + (client->attempt - 1) * USEC_PER_SEC;
425 next_timeout += (random_u32() & 0x1fffff);
427 client->timeout_resend = sd_event_source_unref(client->timeout_resend);
429 r = sd_event_add_monotonic(client->event,
430 &client->timeout_resend,
433 client_timeout_resend, client);
437 r = sd_event_source_set_priority(client->timeout_resend,
438 client->event_priority);
442 switch (client->state) {
443 case DHCP_STATE_INIT:
445 client_update_secs(client, time_now);
447 r = client_send_discover(client, client->secs);
449 client->state = DHCP_STATE_SELECTING;
452 if (client->attempt >= 64)
458 case DHCP_STATE_SELECTING:
459 client_update_secs(client, time_now);
461 r = client_send_discover(client, client->secs);
462 if (r < 0 && client->attempt >= 64)
467 case DHCP_STATE_REQUESTING:
468 case DHCP_STATE_RENEWING:
469 case DHCP_STATE_REBINDING:
470 r = client_send_request(client, client->secs);
471 if (r < 0 && client->attempt >= 64)
474 client->request_sent = time_now;
478 case DHCP_STATE_INIT_REBOOT:
479 case DHCP_STATE_REBOOTING:
480 case DHCP_STATE_BOUND:
488 client_stop(client, r);
490 /* Errors were dealt with when stopping the client, don't spill
491 errors into the event loop handler */
495 static int client_initialize_events(sd_dhcp_client *client,
496 sd_event_io_handler_t io_callback) {
500 assert(client->event);
502 r = sd_event_add_io(client->event, &client->receive_message,
503 client->fd, EPOLLIN, io_callback,
508 r = sd_event_source_set_priority(client->receive_message,
509 client->event_priority);
513 client->timeout_resend = sd_event_source_unref(client->timeout_resend);
515 r = sd_event_add_monotonic(client->event,
516 &client->timeout_resend, 0, 0,
517 client_timeout_resend, client);
521 r = sd_event_source_set_priority(client->timeout_resend,
522 client->event_priority);
526 client_stop(client, r);
532 static int client_timeout_expire(sd_event_source *s, uint64_t usec,
534 sd_dhcp_client *client = userdata;
536 log_dhcp_client(client, "EXPIRED");
538 client_stop(client, DHCP_EVENT_EXPIRED);
543 static int client_timeout_t2(sd_event_source *s, uint64_t usec, void *userdata) {
544 sd_dhcp_client *client = userdata;
547 client->receive_message = sd_event_source_unref(client->receive_message);
548 client->fd = safe_close(client->fd);
550 client->state = DHCP_STATE_REBINDING;
553 r = dhcp_network_bind_raw_socket(client->index, &client->link);
555 client_stop(client, r);
561 log_dhcp_client(client, "TIMEOUT T2");
563 return client_initialize_events(client, client_receive_message_raw);
566 static int client_timeout_t1(sd_event_source *s, uint64_t usec,
568 sd_dhcp_client *client = userdata;
571 client->state = DHCP_STATE_RENEWING;
574 r = dhcp_network_bind_udp_socket(client->index,
575 client->lease->address,
578 client_stop(client, r);
584 log_dhcp_client(client, "TIMEOUT T1");
586 return client_initialize_events(client, client_receive_message_udp);
589 static int client_handle_offer(sd_dhcp_client *client, DHCPMessage *offer,
591 _cleanup_dhcp_lease_unref_ sd_dhcp_lease *lease = NULL;
594 r = dhcp_lease_new(&lease);
598 r = dhcp_option_parse(offer, len, dhcp_lease_parse_options, lease);
602 lease->next_server = offer->siaddr;
604 lease->address = offer->yiaddr;
606 if (lease->address == INADDR_ANY ||
607 lease->server_address == INADDR_ANY ||
608 lease->subnet_mask == INADDR_ANY ||
609 lease->lifetime == 0)
612 client->lease = lease;
615 log_dhcp_client(client, "OFFER");
620 static int client_handle_ack(sd_dhcp_client *client, DHCPMessage *ack,
622 _cleanup_dhcp_lease_unref_ sd_dhcp_lease *lease = NULL;
625 r = dhcp_lease_new(&lease);
629 r = dhcp_option_parse(ack, len, dhcp_lease_parse_options, lease);
631 log_dhcp_client(client, "NAK");
632 return DHCP_EVENT_NO_LEASE;
638 lease->next_server = ack->siaddr;
640 lease->address = ack->yiaddr;
642 if (lease->address == INADDR_ANY ||
643 lease->server_address == INADDR_ANY ||
644 lease->subnet_mask == INADDR_ANY || lease->lifetime == 0)
647 r = DHCP_EVENT_IP_ACQUIRE;
649 if (client->lease->address != lease->address ||
650 client->lease->subnet_mask != lease->subnet_mask ||
651 client->lease->router != lease->router) {
652 r = DHCP_EVENT_IP_CHANGE;
655 client->lease = sd_dhcp_lease_unref(client->lease);
658 client->lease = lease;
661 log_dhcp_client(client, "ACK");
666 static uint64_t client_compute_timeout(uint64_t request_sent,
668 return request_sent + (lifetime - 3) * USEC_PER_SEC +
669 + (random_u32() & 0x1fffff);
672 static int client_set_lease_timeouts(sd_dhcp_client *client, uint64_t usec) {
673 uint64_t next_timeout;
677 assert(client->event);
679 if (client->lease->lifetime < 10)
682 client->timeout_t1 = sd_event_source_unref(client->timeout_t1);
683 client->timeout_t2 = sd_event_source_unref(client->timeout_t2);
684 client->timeout_expire = sd_event_source_unref(client->timeout_expire);
686 if (!client->lease->t1)
687 client->lease->t1 = client->lease->lifetime / 2;
689 next_timeout = client_compute_timeout(client->request_sent,
691 if (next_timeout < usec)
694 r = sd_event_add_monotonic(client->event,
698 client_timeout_t1, client);
702 r = sd_event_source_set_priority(client->timeout_t1,
703 client->event_priority);
707 if (!client->lease->t2)
708 client->lease->t2 = client->lease->lifetime * 7 / 8;
710 if (client->lease->t2 < client->lease->t1)
713 if (client->lease->lifetime < client->lease->t2)
716 next_timeout = client_compute_timeout(client->request_sent,
718 if (next_timeout < usec)
721 r = sd_event_add_monotonic(client->event,
725 client_timeout_t2, client);
729 r = sd_event_source_set_priority(client->timeout_t2,
730 client->event_priority);
734 next_timeout = client_compute_timeout(client->request_sent,
735 client->lease->lifetime);
736 if (next_timeout < usec)
739 r = sd_event_add_monotonic(client->event,
740 &client->timeout_expire, next_timeout,
742 client_timeout_expire, client);
746 r = sd_event_source_set_priority(client->timeout_expire,
747 client->event_priority);
754 static int client_handle_message(sd_dhcp_client *client, DHCPMessage *message,
755 int len, usec_t time_now) {
756 int r = 0, notify_event = 0;
759 assert(client->event);
762 if (len < DHCP_MESSAGE_SIZE) {
763 log_dhcp_client(client, "message too small (%d bytes): "
768 if (message->op != BOOTREPLY) {
769 log_dhcp_client(client, "not a BOOTREPLY message: ignoring");
773 if (be32toh(message->xid) != client->xid) {
774 log_dhcp_client(client, "received xid (%u) does not match "
775 "expected (%u): ignoring",
776 be32toh(message->xid), client->xid);
780 if (memcmp(&message->chaddr[0], &client->mac_addr.ether_addr_octet,
782 log_dhcp_client(client, "received chaddr does not match "
783 "expected: ignoring");
787 switch (client->state) {
788 case DHCP_STATE_SELECTING:
790 r = client_handle_offer(client, message, len);
793 client->timeout_resend =
794 sd_event_source_unref(client->timeout_resend);
796 client->state = DHCP_STATE_REQUESTING;
799 r = sd_event_add_monotonic(client->event,
800 &client->timeout_resend, 0,
801 0, client_timeout_resend,
806 r = sd_event_source_set_priority(client->timeout_resend,
807 client->event_priority);
814 case DHCP_STATE_REQUESTING:
815 case DHCP_STATE_RENEWING:
816 case DHCP_STATE_REBINDING:
818 r = client_handle_ack(client, message, len);
820 if (r == DHCP_EVENT_NO_LEASE)
824 client->timeout_resend =
825 sd_event_source_unref(client->timeout_resend);
827 if (client->state == DHCP_STATE_REQUESTING)
828 notify_event = DHCP_EVENT_IP_ACQUIRE;
829 else if (r != DHCP_EVENT_IP_ACQUIRE)
832 client->state = DHCP_STATE_BOUND;
835 client->last_addr = client->lease->address;
837 r = client_set_lease_timeouts(client, time_now);
842 client_notify(client, notify_event);
844 client->receive_message =
845 sd_event_source_unref(client->receive_message);
846 client->fd = safe_close(client->fd);
853 case DHCP_STATE_INIT:
854 case DHCP_STATE_INIT_REBOOT:
855 case DHCP_STATE_REBOOTING:
856 case DHCP_STATE_BOUND:
862 if (r < 0 || r == DHCP_EVENT_NO_LEASE)
863 return client_stop(client, r);
868 static int client_receive_message_udp(sd_event_source *s, int fd,
869 uint32_t revents, void *userdata) {
870 sd_dhcp_client *client = userdata;
871 _cleanup_free_ DHCPMessage *message = NULL;
872 int buflen = 0, len, r;
877 assert(client->event);
879 r = ioctl(fd, FIONREAD, &buflen);
880 if (r < 0 || buflen <= 0)
881 buflen = sizeof(DHCPMessage) + DHCP_MIN_OPTIONS_SIZE;
883 message = malloc0(buflen);
887 len = read(fd, message, buflen);
891 r = sd_event_get_now_monotonic(client->event, &time_now);
893 return client_stop(client, r);
895 return client_handle_message(client, message, len,
899 static int client_receive_message_raw(sd_event_source *s, int fd,
900 uint32_t revents, void *userdata) {
901 sd_dhcp_client *client = userdata;
902 _cleanup_free_ DHCPPacket *packet = NULL;
904 uint8_t cmsgbuf[CMSG_LEN(sizeof(struct tpacket_auxdata))];
905 struct iovec iov = {};
906 struct msghdr msg = {
909 .msg_control = cmsgbuf,
910 .msg_controllen = sizeof(cmsgbuf),
912 struct cmsghdr *cmsg;
913 bool checksum = true;
914 int buflen = 0, len, r;
918 assert(client->event);
920 r = ioctl(fd, FIONREAD, &buflen);
921 if (r < 0 || buflen <= 0)
922 buflen = sizeof(DHCPPacket) + DHCP_MIN_OPTIONS_SIZE;
924 packet = malloc0(buflen);
928 iov.iov_base = packet;
929 iov.iov_len = buflen;
931 len = recvmsg(fd, &msg, 0);
933 log_dhcp_client(client, "could not receive message from raw "
934 "socket: %s", strerror(errno));
938 for (cmsg = CMSG_FIRSTHDR(&msg); cmsg; cmsg = CMSG_NXTHDR(&msg, cmsg)) {
939 if (cmsg->cmsg_level == SOL_PACKET && cmsg->cmsg_type == PACKET_AUXDATA) {
940 struct tpacket_auxdata *aux = (void *)CMSG_DATA(cmsg);
942 checksum = !(aux->tp_status & TP_STATUS_CSUMNOTREADY);
947 r = dhcp_packet_verify_headers(packet, len, checksum);
951 len -= DHCP_IP_UDP_SIZE;
953 r = sd_event_get_now_monotonic(client->event, &time_now);
955 return client_stop(client, r);
957 return client_handle_message(client, &packet->dhcp, len, time_now);
960 int sd_dhcp_client_start(sd_dhcp_client *client) {
963 assert_return(client, -EINVAL);
964 assert_return(client->event, -EINVAL);
965 assert_return(client->index > 0, -EINVAL);
966 assert_return(client->state == DHCP_STATE_INIT ||
967 client->state == DHCP_STATE_INIT_REBOOT, -EBUSY);
969 client->xid = random_u32();
971 r = dhcp_network_bind_raw_socket(client->index, &client->link);
974 client_stop(client, r);
979 client->start_time = now(CLOCK_MONOTONIC);
982 log_dhcp_client(client, "STARTED");
984 return client_initialize_events(client, client_receive_message_raw);
987 int sd_dhcp_client_stop(sd_dhcp_client *client) {
988 return client_stop(client, DHCP_EVENT_STOP);
991 int sd_dhcp_client_attach_event(sd_dhcp_client *client, sd_event *event,
995 assert_return(client, -EINVAL);
996 assert_return(!client->event, -EBUSY);
999 client->event = sd_event_ref(event);
1001 r = sd_event_default(&client->event);
1006 client->event_priority = priority;
1011 int sd_dhcp_client_detach_event(sd_dhcp_client *client) {
1012 assert_return(client, -EINVAL);
1014 client->event = sd_event_unref(client->event);
1019 sd_event *sd_dhcp_client_get_event(sd_dhcp_client *client) {
1023 return client->event;
1026 void sd_dhcp_client_free(sd_dhcp_client *client) {
1030 sd_dhcp_client_stop(client);
1031 sd_dhcp_client_detach_event(client);
1033 free(client->req_opts);
1037 DEFINE_TRIVIAL_CLEANUP_FUNC(sd_dhcp_client*, sd_dhcp_client_free);
1038 #define _cleanup_dhcp_client_free_ _cleanup_(sd_dhcp_client_freep)
1040 int sd_dhcp_client_new(sd_dhcp_client **ret) {
1041 _cleanup_dhcp_client_free_ sd_dhcp_client *client = NULL;
1043 assert_return(ret, -EINVAL);
1045 client = new0(sd_dhcp_client, 1);
1049 client->state = DHCP_STATE_INIT;
1052 client->attempt = 1;
1054 client->req_opts_size = ELEMENTSOF(default_req_opts);
1056 client->req_opts = memdup(default_req_opts, client->req_opts_size);
1057 if (!client->req_opts)