source: mainline/uspace/srv/net/dhcp/dhcp.c@ 048cd69

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 048cd69 was 048cd69, checked in by Jiri Svoboda <jiri@…>, 10 years ago

Merge network transport layer API rewrite.
  • Property mode set to 100644
File size: 15.2 KB
Line 
1/*
2 * Copyright (c) 2013 Jiri Svoboda
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup dhcp
30 * @{
31 */
32/**
33 * @file
34 * @brief DHCP client
35 */
36
37#include <adt/list.h>
38#include <bitops.h>
39#include <byteorder.h>
40#include <errno.h>
41#include <fibril_synch.h>
42#include <inet/addr.h>
43#include <inet/dnsr.h>
44#include <inet/inetcfg.h>
45#include <io/log.h>
46#include <loc.h>
47#include <stdio.h>
48#include <stdlib.h>
49
50#include "dhcp.h"
51#include "dhcp_std.h"
52#include "transport.h"
53
54enum {
55 /** In microseconds */
56 dhcp_discover_timeout_val = 5 * 1000 * 1000,
57 /** In microseconds */
58 dhcp_request_timeout_val = 1 * 1000 * 1000,
59 dhcp_discover_retries = 5,
60 dhcp_request_retries = 3
61};
62
63#define MAX_MSG_SIZE 1024
64static uint8_t msgbuf[MAX_MSG_SIZE];
65
66/** List of registered links (of dhcp_link_t) */
67static list_t dhcp_links;
68
69static void dhcpsrv_discover_timeout(void *);
70static void dhcpsrv_request_timeout(void *);
71
72typedef enum {
73 ds_bound,
74 ds_fail,
75 ds_init,
76 ds_init_reboot,
77 ds_rebinding,
78 ds_renewing,
79 ds_requesting,
80 ds_selecting
81} dhcp_state_t;
82
83typedef struct {
84 /** Message type */
85 enum dhcp_msg_type msg_type;
86 /** Offered address */
87 inet_naddr_t oaddr;
88 /** Server address */
89 inet_addr_t srv_addr;
90 /** Router address */
91 inet_addr_t router;
92 /** DNS server */
93 inet_addr_t dns_server;
94} dhcp_offer_t;
95
96typedef struct {
97 /** Link to dhcp_links list */
98 link_t links;
99 /** Link service ID */
100 service_id_t link_id;
101 /** Link info */
102 inet_link_info_t link_info;
103 /** Transport */
104 dhcp_transport_t dt;
105 /** Transport timeout */
106 fibril_timer_t *timeout;
107 /** Number of retries */
108 int retries_left;
109 /** Link state */
110 dhcp_state_t state;
111 /** Last received offer */
112 dhcp_offer_t offer;
113} dhcp_link_t;
114
115static void dhcpsrv_recv(void *, void *, size_t);
116
117/** Decode subnet mask into subnet prefix length. */
118static int subnet_mask_decode(uint32_t mask, int *bits)
119{
120 int zbits;
121 uint32_t nmask;
122
123 if (mask == 0xffffffff) {
124 *bits = 32;
125 return EOK;
126 }
127
128 zbits = 1 + fnzb32(mask ^ 0xffffffff);
129 nmask = BIT_RRANGE(uint32_t, zbits);
130
131 if ((mask ^ nmask) != 0xffffffff) {
132 /* The mask is not in the form 1**n,0**m */
133 return EINVAL;
134 }
135
136 *bits = 32 - zbits;
137 return EOK;
138}
139
140static uint32_t dhcp_uint32_decode(uint8_t *data)
141{
142 return
143 ((uint32_t)data[0] << 24) |
144 ((uint32_t)data[1] << 16) |
145 ((uint32_t)data[2] << 8) |
146 ((uint32_t)data[3]);
147}
148
149static int dhcp_send_discover(dhcp_link_t *dlink)
150{
151 dhcp_hdr_t *hdr = (dhcp_hdr_t *)msgbuf;
152 uint8_t *opt = msgbuf + sizeof(dhcp_hdr_t);
153
154 memset(msgbuf, 0, MAX_MSG_SIZE);
155 hdr->op = op_bootrequest;
156 hdr->htype = 1; /* AHRD_ETHERNET */
157 hdr->hlen = sizeof(addr48_t);
158 hdr->xid = host2uint32_t_be(42);
159 hdr->flags = flag_broadcast;
160
161 addr48(dlink->link_info.mac_addr, hdr->chaddr);
162 hdr->opt_magic = host2uint32_t_be(dhcp_opt_magic);
163
164 opt[0] = opt_msg_type;
165 opt[1] = 1;
166 opt[2] = msg_dhcpdiscover;
167 opt[3] = opt_end;
168
169 return dhcp_send(&dlink->dt, msgbuf, sizeof(dhcp_hdr_t) + 4);
170}
171
172static int dhcp_send_request(dhcp_link_t *dlink, dhcp_offer_t *offer)
173{
174 dhcp_hdr_t *hdr = (dhcp_hdr_t *)msgbuf;
175 uint8_t *opt = msgbuf + sizeof(dhcp_hdr_t);
176 size_t i;
177
178 memset(msgbuf, 0, MAX_MSG_SIZE);
179 hdr->op = op_bootrequest;
180 hdr->htype = 1; /* AHRD_ETHERNET */
181 hdr->hlen = 6;
182 hdr->xid = host2uint32_t_be(42);
183 hdr->flags = flag_broadcast;
184 hdr->ciaddr = host2uint32_t_be(offer->oaddr.addr);
185 addr48(dlink->link_info.mac_addr, hdr->chaddr);
186 hdr->opt_magic = host2uint32_t_be(dhcp_opt_magic);
187
188 i = 0;
189
190 opt[i++] = opt_msg_type;
191 opt[i++] = 1;
192 opt[i++] = msg_dhcprequest;
193
194 opt[i++] = opt_req_ip_addr;
195 opt[i++] = 4;
196 opt[i++] = offer->oaddr.addr >> 24;
197 opt[i++] = (offer->oaddr.addr >> 16) & 0xff;
198 opt[i++] = (offer->oaddr.addr >> 8) & 0xff;
199 opt[i++] = offer->oaddr.addr & 0xff;
200
201 opt[i++] = opt_server_id;
202 opt[i++] = 4;
203 opt[i++] = offer->srv_addr.addr >> 24;
204 opt[i++] = (offer->srv_addr.addr >> 16) & 0xff;
205 opt[i++] = (offer->srv_addr.addr >> 8) & 0xff;
206 opt[i++] = offer->srv_addr.addr & 0xff;
207
208 opt[i++] = opt_end;
209
210 return dhcp_send(&dlink->dt, msgbuf, sizeof(dhcp_hdr_t) + i);
211}
212
213static int dhcp_parse_reply(void *msg, size_t size, dhcp_offer_t *offer)
214{
215 dhcp_hdr_t *hdr = (dhcp_hdr_t *)msg;
216 inet_addr_t yiaddr;
217 inet_addr_t siaddr;
218 inet_addr_t giaddr;
219 uint32_t subnet_mask;
220 bool have_subnet_mask = false;
221 bool have_server_id = false;
222 int subnet_bits;
223 char *saddr;
224 uint8_t opt_type, opt_len;
225 uint8_t *msgb;
226 int rc;
227 size_t i;
228
229 log_msg(LOG_DEFAULT, LVL_DEBUG, "Receive reply");
230 memset(offer, 0, sizeof(*offer));
231
232 inet_addr_set(uint32_t_be2host(hdr->yiaddr), &yiaddr);
233 rc = inet_addr_format(&yiaddr, &saddr);
234 if (rc != EOK)
235 return rc;
236
237 log_msg(LOG_DEFAULT, LVL_DEBUG, "Your IP address: %s", saddr);
238 free(saddr);
239
240 inet_addr_set(uint32_t_be2host(hdr->siaddr), &siaddr);
241 rc = inet_addr_format(&siaddr, &saddr);
242 if (rc != EOK)
243 return rc;
244
245 log_msg(LOG_DEFAULT, LVL_DEBUG, "Next server IP address: %s", saddr);
246 free(saddr);
247
248 inet_addr_set(uint32_t_be2host(hdr->giaddr), &giaddr);
249 rc = inet_addr_format(&giaddr, &saddr);
250 if (rc != EOK)
251 return rc;
252
253 log_msg(LOG_DEFAULT, LVL_DEBUG, "Relay agent IP address: %s", saddr);
254 free(saddr);
255
256 inet_naddr_set(yiaddr.addr, 0, &offer->oaddr);
257
258 msgb = (uint8_t *)msg;
259
260 i = sizeof(dhcp_hdr_t);
261 while (i < size) {
262 opt_type = msgb[i++];
263
264 if (opt_type == opt_pad)
265 continue;
266 if (opt_type == opt_end)
267 break;
268
269 if (i >= size)
270 return EINVAL;
271
272 opt_len = msgb[i++];
273
274 if (i + opt_len > size)
275 return EINVAL;
276
277 switch (opt_type) {
278 case opt_subnet_mask:
279 if (opt_len != 4)
280 return EINVAL;
281 subnet_mask = dhcp_uint32_decode(&msgb[i]);
282 rc = subnet_mask_decode(subnet_mask, &subnet_bits);
283 if (rc != EOK)
284 return EINVAL;
285 offer->oaddr.prefix = subnet_bits;
286 have_subnet_mask = true;
287 break;
288 case opt_msg_type:
289 if (opt_len != 1)
290 return EINVAL;
291 offer->msg_type = msgb[i];
292 break;
293 case opt_server_id:
294 if (opt_len != 4)
295 return EINVAL;
296 inet_addr_set(dhcp_uint32_decode(&msgb[i]),
297 &offer->srv_addr);
298 have_server_id = true;
299 break;
300 case opt_router:
301 if (opt_len != 4)
302 return EINVAL;
303 inet_addr_set(dhcp_uint32_decode(&msgb[i]),
304 &offer->router);
305 break;
306 case opt_dns_server:
307 if (opt_len < 4 || opt_len % 4 != 0)
308 return EINVAL;
309 /* XXX Handle multiple DNS servers properly */
310 inet_addr_set(dhcp_uint32_decode(&msgb[i]),
311 &offer->dns_server);
312 break;
313 case opt_end:
314 break;
315 default:
316 break;
317 }
318
319 /* Advance to the next option */
320 i = i + opt_len;
321 }
322
323 if (!have_server_id) {
324 log_msg(LOG_DEFAULT, LVL_ERROR, "Missing server ID option.");
325 return rc;
326 }
327
328 if (!have_subnet_mask) {
329 log_msg(LOG_DEFAULT, LVL_ERROR, "Missing subnet mask option.");
330 return rc;
331 }
332
333 rc = inet_naddr_format(&offer->oaddr, &saddr);
334 if (rc != EOK)
335 return rc;
336
337 log_msg(LOG_DEFAULT, LVL_DEBUG, "Offered network address: %s", saddr);
338 free(saddr);
339
340 if (offer->router.addr != 0) {
341 rc = inet_addr_format(&offer->router, &saddr);
342 if (rc != EOK)
343 return rc;
344
345 log_msg(LOG_DEFAULT, LVL_DEBUG, "Router address: %s", saddr);
346 free(saddr);
347 }
348
349 if (offer->dns_server.addr != 0) {
350 rc = inet_addr_format(&offer->dns_server, &saddr);
351 if (rc != EOK)
352 return rc;
353
354 log_msg(LOG_DEFAULT, LVL_DEBUG, "DNS server: %s", saddr);
355 free(saddr);
356 }
357
358 return EOK;
359}
360
361static int dhcp_cfg_create(service_id_t iplink, dhcp_offer_t *offer)
362{
363 int rc;
364 service_id_t addr_id;
365 service_id_t sroute_id;
366 inet_naddr_t defr;
367
368 rc = inetcfg_addr_create_static("dhcp4a", &offer->oaddr, iplink,
369 &addr_id);
370 if (rc != EOK) {
371 log_msg(LOG_DEFAULT, LVL_ERROR,
372 "Error creating IP address %s (%d)", "dhcp4a", rc);
373 return rc;
374 }
375
376 if (offer->router.addr != 0) {
377 inet_naddr_set(0, 0, &defr);
378
379 rc = inetcfg_sroute_create("dhcpdef", &defr, &offer->router, &sroute_id);
380 if (rc != EOK) {
381 log_msg(LOG_DEFAULT, LVL_ERROR, "Error creating "
382 "default route %s (%d).", "dhcpdef", rc);
383 return rc;
384 }
385 }
386
387 if (offer->dns_server.addr != 0) {
388 rc = dnsr_set_srvaddr(&offer->dns_server);
389 if (rc != EOK) {
390 log_msg(LOG_DEFAULT, LVL_ERROR, "Error setting "
391 "nameserver address (%d))", rc);
392 return rc;
393 }
394 }
395
396 return EOK;
397}
398
399void dhcpsrv_links_init(void)
400{
401 list_initialize(&dhcp_links);
402}
403
404static dhcp_link_t *dhcpsrv_link_find(service_id_t link_id)
405{
406 list_foreach(dhcp_links, links, dhcp_link_t, dlink) {
407 if (dlink->link_id == link_id)
408 return dlink;
409 }
410
411 return NULL;
412}
413
414static void dhcp_link_set_failed(dhcp_link_t *dlink)
415{
416 log_msg(LOG_DEFAULT, LVL_NOTE, "Giving up on link %s",
417 dlink->link_info.name);
418 dlink->state = ds_fail;
419}
420
421static int dhcp_discover_proc(dhcp_link_t *dlink)
422{
423 dlink->state = ds_selecting;
424
425 int rc = dhcp_send_discover(dlink);
426 if (rc != EOK)
427 return EIO;
428
429 dlink->retries_left = dhcp_discover_retries;
430
431 if ((dlink->timeout->state == fts_not_set) ||
432 (dlink->timeout->state == fts_fired))
433 fibril_timer_set(dlink->timeout, dhcp_discover_timeout_val,
434 dhcpsrv_discover_timeout, dlink);
435
436 return rc;
437}
438
439int dhcpsrv_link_add(service_id_t link_id)
440{
441 dhcp_link_t *dlink;
442 int rc;
443
444 log_msg(LOG_DEFAULT, LVL_DEBUG, "dhcpsrv_link_add(%zu)", link_id);
445
446 if (dhcpsrv_link_find(link_id) != NULL) {
447 log_msg(LOG_DEFAULT, LVL_NOTE, "Link %zu already added",
448 link_id);
449 return EEXIST;
450 }
451
452 dlink = calloc(1, sizeof(dhcp_link_t));
453 if (dlink == NULL)
454 return ENOMEM;
455
456 dlink->link_id = link_id;
457 dlink->timeout = fibril_timer_create(NULL);
458 if (dlink->timeout == NULL) {
459 rc = ENOMEM;
460 goto error;
461 }
462
463 /* Get link hardware address */
464 rc = inetcfg_link_get(link_id, &dlink->link_info);
465 if (rc != EOK) {
466 log_msg(LOG_DEFAULT, LVL_ERROR, "Error getting properties "
467 "for link %zu.", link_id);
468 rc = EIO;
469 goto error;
470 }
471
472 rc = dhcp_transport_init(&dlink->dt, link_id, dhcpsrv_recv, dlink);
473 if (rc != EOK) {
474 log_msg(LOG_DEFAULT, LVL_ERROR, "Error initializing DHCP "
475 "transport for link %s.", dlink->link_info.name);
476 rc = EIO;
477 goto error;
478 }
479
480 log_msg(LOG_DEFAULT, LVL_DEBUG, "Send DHCPDISCOVER");
481 rc = dhcp_discover_proc(dlink);
482 if (rc != EOK) {
483 log_msg(LOG_DEFAULT, LVL_ERROR, "Error sending DHCPDISCOVER.");
484 dhcp_link_set_failed(dlink);
485 rc = EIO;
486 goto error;
487 }
488
489 list_append(&dlink->links, &dhcp_links);
490
491 return EOK;
492error:
493 if (dlink != NULL && dlink->timeout != NULL)
494 fibril_timer_destroy(dlink->timeout);
495 free(dlink);
496 return rc;
497}
498
499int dhcpsrv_link_remove(service_id_t link_id)
500{
501 return ENOTSUP;
502}
503
504int dhcpsrv_discover(service_id_t link_id)
505{
506 log_msg(LOG_DEFAULT, LVL_DEBUG, "dhcpsrv_link_add(%zu)", link_id);
507
508 dhcp_link_t *dlink = dhcpsrv_link_find(link_id);
509
510 if (dlink == NULL) {
511 log_msg(LOG_DEFAULT, LVL_NOTE, "Link %zu doesn't exist",
512 link_id);
513 return EINVAL;
514 }
515
516 return dhcp_discover_proc(dlink);
517}
518
519static void dhcpsrv_recv_offer(dhcp_link_t *dlink, dhcp_offer_t *offer)
520{
521 int rc;
522
523 if (dlink->state != ds_selecting) {
524 log_msg(LOG_DEFAULT, LVL_DEBUG, "Received offer in state "
525 " %d, ignoring.", (int)dlink->state);
526 return;
527 }
528
529 fibril_timer_clear(dlink->timeout);
530 dlink->offer = *offer;
531 dlink->state = ds_requesting;
532
533 log_msg(LOG_DEFAULT, LVL_DEBUG, "Send DHCPREQUEST");
534 rc = dhcp_send_request(dlink, offer);
535 if (rc != EOK) {
536 log_msg(LOG_DEFAULT, LVL_DEBUG, "Error sending request.");
537 return;
538 }
539
540 dlink->retries_left = dhcp_request_retries;
541 fibril_timer_set(dlink->timeout, dhcp_request_timeout_val,
542 dhcpsrv_request_timeout, dlink);
543}
544
545static void dhcpsrv_recv_ack(dhcp_link_t *dlink, dhcp_offer_t *offer)
546{
547 int rc;
548
549 if (dlink->state != ds_requesting) {
550 log_msg(LOG_DEFAULT, LVL_DEBUG, "Received ack in state "
551 " %d, ignoring.", (int)dlink->state);
552 return;
553 }
554
555 fibril_timer_clear(dlink->timeout);
556 dlink->offer = *offer;
557 dlink->state = ds_bound;
558
559 rc = dhcp_cfg_create(dlink->link_id, offer);
560 if (rc != EOK) {
561 log_msg(LOG_DEFAULT, LVL_DEBUG, "Error creating configuration.");
562 return;
563 }
564
565 /* XXX Work around multiple simultaneous sessions issue */
566 dhcp_transport_fini(&dlink->dt);
567
568 log_msg(LOG_DEFAULT, LVL_NOTE, "%s: Successfully configured.",
569 dlink->link_info.name);
570}
571
572static void dhcpsrv_recv(void *arg, void *msg, size_t size)
573{
574 dhcp_link_t *dlink = (dhcp_link_t *)arg;
575 dhcp_offer_t offer;
576 int rc;
577
578 log_msg(LOG_DEFAULT, LVL_DEBUG, "%s: dhcpsrv_recv() %zu bytes",
579 dlink->link_info.name, size);
580
581 rc = dhcp_parse_reply(msg, size, &offer);
582 if (rc != EOK) {
583 log_msg(LOG_DEFAULT, LVL_DEBUG, "Error parsing reply");
584 return;
585 }
586
587 switch (offer.msg_type) {
588 case msg_dhcpoffer:
589 dhcpsrv_recv_offer(dlink, &offer);
590 break;
591 case msg_dhcpack:
592 dhcpsrv_recv_ack(dlink, &offer);
593 break;
594 default:
595 log_msg(LOG_DEFAULT, LVL_DEBUG, "Received unexpected "
596 "message type. %d", (int)offer.msg_type);
597 break;
598 }
599}
600
601static void dhcpsrv_discover_timeout(void *arg)
602{
603 dhcp_link_t *dlink = (dhcp_link_t *)arg;
604 int rc;
605
606 assert(dlink->state == ds_selecting);
607 log_msg(LOG_DEFAULT, LVL_NOTE, "%s: dcpsrv_discover_timeout",
608 dlink->link_info.name);
609
610 if (dlink->retries_left == 0) {
611 log_msg(LOG_DEFAULT, LVL_NOTE, "Retries exhausted");
612 dhcp_link_set_failed(dlink);
613 return;
614 }
615 --dlink->retries_left;
616
617 log_msg(LOG_DEFAULT, LVL_DEBUG, "Send DHCPDISCOVER");
618 rc = dhcp_send_discover(dlink);
619 if (rc != EOK) {
620 log_msg(LOG_DEFAULT, LVL_ERROR, "Error sending DHCPDISCOVER");
621 dhcp_link_set_failed(dlink);
622 return;
623 }
624
625 fibril_timer_set(dlink->timeout, dhcp_discover_timeout_val,
626 dhcpsrv_discover_timeout, dlink);
627}
628
629static void dhcpsrv_request_timeout(void *arg)
630{
631 dhcp_link_t *dlink = (dhcp_link_t *)arg;
632 int rc;
633
634 assert(dlink->state == ds_requesting);
635 log_msg(LOG_DEFAULT, LVL_NOTE, "%s: dcpsrv_request_timeout",
636 dlink->link_info.name);
637
638 if (dlink->retries_left == 0) {
639 log_msg(LOG_DEFAULT, LVL_NOTE, "Retries exhausted");
640 dhcp_link_set_failed(dlink);
641 return;
642 }
643 --dlink->retries_left;
644
645 log_msg(LOG_DEFAULT, LVL_DEBUG, "Send DHCPREQUEST");
646 rc = dhcp_send_request(dlink, &dlink->offer);
647 if (rc != EOK) {
648 log_msg(LOG_DEFAULT, LVL_DEBUG, "Error sending request.");
649 dhcp_link_set_failed(dlink);
650 return;
651 }
652
653 fibril_timer_set(dlink->timeout, dhcp_request_timeout_val,
654 dhcpsrv_request_timeout, dlink);
655}
656
657/** @}
658 */
Note: See TracBrowser for help on using the repository browser.