source: mainline/uspace/srv/net/dhcp/dhcp.c@ f5c03a8

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

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