[Settings] copy_settings() should not fail if some settings are missing!
[people/mcb30/gpxe.git] / src / net / udp / dhcp.c
1 /*
2  * Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <string.h>
20 #include <stdlib.h>
21 #include <stdio.h>
22 #include <errno.h>
23 #include <assert.h>
24 #include <byteswap.h>
25 #include <gpxe/if_ether.h>
26 #include <gpxe/netdevice.h>
27 #include <gpxe/device.h>
28 #include <gpxe/xfer.h>
29 #include <gpxe/open.h>
30 #include <gpxe/job.h>
31 #include <gpxe/retry.h>
32 #include <gpxe/tcpip.h>
33 #include <gpxe/ip.h>
34 #include <gpxe/uuid.h>
35 #include <gpxe/dhcp.h>
36 #include <gpxe/timer.h>
37 #include <gpxe/settings.h>
38 #include <gpxe/dhcp.h>
39 #include <gpxe/dhcpopts.h>
40 #include <gpxe/dhcppkt.h>
41
42 /** @file
43  *
44  * Dynamic Host Configuration Protocol
45  *
46  */
47
48 /**
49  * DHCP operation types
50  *
51  * This table maps from DHCP message types (i.e. values of the @c
52  * DHCP_MESSAGE_TYPE option) to values of the "op" field within a DHCP
53  * packet.
54  */
55 static const uint8_t dhcp_op[] = {
56         [DHCPDISCOVER]  = BOOTP_REQUEST,
57         [DHCPOFFER]     = BOOTP_REPLY,
58         [DHCPREQUEST]   = BOOTP_REQUEST,
59         [DHCPDECLINE]   = BOOTP_REQUEST,
60         [DHCPACK]       = BOOTP_REPLY,
61         [DHCPNAK]       = BOOTP_REPLY,
62         [DHCPRELEASE]   = BOOTP_REQUEST,
63         [DHCPINFORM]    = BOOTP_REQUEST,
64 };
65
66 /** Raw option data for options common to all DHCP requests */
67 static uint8_t dhcp_request_options_data[] = {
68         DHCP_MAX_MESSAGE_SIZE, DHCP_WORD ( ETH_MAX_MTU ),
69         DHCP_VENDOR_CLASS_ID,
70         DHCP_STRING (  'P', 'X', 'E', 'C', 'l', 'i', 'e', 'n', 't', ':',
71                        'A', 'r', 'c', 'h', ':', '0', '0', '0', '0', '0', ':',
72                        'U', 'N', 'D', 'I', ':', '0', '0', '2', '0', '0', '1' ),
73         DHCP_CLIENT_ARCHITECTURE, DHCP_WORD ( 0 ),
74         DHCP_CLIENT_NDI, DHCP_OPTION ( 1 /* UNDI */ , 2, 1 /* v2.1 */ ),
75         DHCP_PARAMETER_REQUEST_LIST,
76         DHCP_OPTION ( DHCP_SUBNET_MASK, DHCP_ROUTERS, DHCP_DNS_SERVERS,
77                       DHCP_LOG_SERVERS, DHCP_HOST_NAME, DHCP_DOMAIN_NAME,
78                       DHCP_ROOT_PATH, DHCP_VENDOR_ENCAP, DHCP_VENDOR_CLASS_ID,
79                       DHCP_TFTP_SERVER_NAME, DHCP_BOOTFILE_NAME,
80                       DHCP_EB_ENCAP, DHCP_ISCSI_INITIATOR_IQN ),
81         DHCP_END
82 };
83
84 /** Options common to all DHCP requests */
85 static struct dhcp_options dhcp_request_options = {
86         .data = dhcp_request_options_data,
87         .max_len = sizeof ( dhcp_request_options_data ),
88         .len = sizeof ( dhcp_request_options_data ),
89 };
90
91 /** DHCP feature codes */
92 static uint8_t dhcp_features[0] __table_start ( uint8_t, dhcp_features );
93 static uint8_t dhcp_features_end[0] __table_end ( uint8_t, dhcp_features );
94
95 /**
96  * Name a DHCP packet type
97  *
98  * @v msgtype           DHCP message type
99  * @ret string          DHCP mesasge type name
100  */
101 static inline const char * dhcp_msgtype_name ( unsigned int msgtype ) {
102         switch ( msgtype ) {
103         case 0:                 return "BOOTP"; /* Non-DHCP packet */
104         case DHCPDISCOVER:      return "DHCPDISCOVER";
105         case DHCPOFFER:         return "DHCPOFFER";
106         case DHCPREQUEST:       return "DHCPREQUEST";
107         case DHCPDECLINE:       return "DHCPDECLINE";
108         case DHCPACK:           return "DHCPACK";
109         case DHCPNAK:           return "DHCPNAK";
110         case DHCPRELEASE:       return "DHCPRELEASE";
111         case DHCPINFORM:        return "DHCPINFORM";
112         default:                return "DHCP<invalid>";
113         }
114 }
115
116 /**
117  * Calculate DHCP transaction ID for a network device
118  *
119  * @v netdev            Network device
120  * @ret xid             DHCP XID
121  *
122  * Extract the least significant bits of the hardware address for use
123  * as the transaction ID.
124  */
125 static uint32_t dhcp_xid ( struct net_device *netdev ) {
126         uint32_t xid;
127
128         memcpy ( &xid, ( netdev->ll_addr + netdev->ll_protocol->ll_addr_len
129                          - sizeof ( xid ) ), sizeof ( xid ) );
130         return xid;
131 }
132
133 /** Settings block name used for ProxyDHCP responses */
134 #define PROXYDHCP_SETTINGS_NAME "proxydhcp"
135
136 /**
137  * Create a DHCP packet
138  *
139  * @v dhcppkt           DHCP packet structure to fill in
140  * @v netdev            Network device
141  * @v msgtype           DHCP message type
142  * @v options           Initial options to include (or NULL)
143  * @v data              Buffer for DHCP packet
144  * @v max_len           Size of DHCP packet buffer
145  * @ret rc              Return status code
146  *
147  * Creates a DHCP packet in the specified buffer, and fills out a @c
148  * dhcp_packet structure that can be passed to
149  * set_dhcp_packet_option() or copy_dhcp_packet_options().
150  */
151 int create_dhcp_packet ( struct dhcp_packet *dhcppkt,
152                          struct net_device *netdev, uint8_t msgtype,
153                          struct dhcp_options *options, 
154                          void *data, size_t max_len ) {
155         struct dhcphdr *dhcphdr = data;
156         size_t options_len;
157         unsigned int hlen;
158         int rc;
159
160         /* Sanity check */
161         options_len = ( options ? options->len : 0 );
162         if ( max_len < ( sizeof ( *dhcphdr ) + options_len ) )
163                 return -ENOSPC;
164
165         /* Initialise DHCP packet content */
166         memset ( dhcphdr, 0, max_len );
167         dhcphdr->xid = dhcp_xid ( netdev );
168         dhcphdr->magic = htonl ( DHCP_MAGIC_COOKIE );
169         dhcphdr->htype = ntohs ( netdev->ll_protocol->ll_proto );
170         dhcphdr->op = dhcp_op[msgtype];
171         /* If hardware length exceeds the chaddr field length, don't
172          * use the chaddr field.  This is as per RFC4390.
173          */
174         hlen = netdev->ll_protocol->ll_addr_len;
175         if ( hlen > sizeof ( dhcphdr->chaddr ) ) {
176                 hlen = 0;
177                 dhcphdr->flags = htons ( BOOTP_FL_BROADCAST );
178         }
179         dhcphdr->hlen = hlen;
180         memcpy ( dhcphdr->chaddr, netdev->ll_addr, hlen );
181         memcpy ( dhcphdr->options, options->data, options_len );
182
183         /* Initialise DHCP packet structure and settings interface */
184         memset ( dhcppkt, 0, sizeof ( *dhcppkt ) );
185         dhcppkt_init ( dhcppkt, NULL, data, max_len );
186         
187         /* Set DHCP_MESSAGE_TYPE option */
188         if ( ( rc = store_setting ( &dhcppkt->settings, DHCP_MESSAGE_TYPE,
189                                     &msgtype, sizeof ( msgtype ) ) ) != 0 )
190                 return rc;
191
192         return 0;
193 }
194
195 /** DHCP network device descriptor */
196 struct dhcp_netdev_desc {
197         /** Bus type ID */
198         uint8_t type;
199         /** Vendor ID */
200         uint16_t vendor;
201         /** Device ID */
202         uint16_t device;
203 } __attribute__ (( packed ));
204
205 /** DHCP client identifier */
206 struct dhcp_client_id {
207         /** Link-layer protocol */
208         uint8_t ll_proto;
209         /** Link-layer address */
210         uint8_t ll_addr[MAX_LL_ADDR_LEN];
211 } __attribute__ (( packed ));
212
213 /** DHCP client UUID */
214 struct dhcp_client_uuid {
215         /** Identifier type */
216         uint8_t type;
217         /** UUID */
218         union uuid uuid;
219 } __attribute__ (( packed ));
220
221 #define DHCP_CLIENT_UUID_TYPE 0
222
223 /**
224  * Create DHCP request packet
225  *
226  * @v dhcppkt           DHCP packet structure to fill in
227  * @v netdev            Network device
228  * @v dhcpoffer         DHCPOFFER packet received from server
229  * @v data              Buffer for DHCP packet
230  * @v max_len           Size of DHCP packet buffer
231  * @ret rc              Return status code
232  */
233 static int create_dhcp_request ( struct dhcp_packet *dhcppkt,
234                                  struct net_device *netdev,
235                                  struct dhcp_packet *dhcpoffer,
236                                  void *data, size_t max_len ) {
237         struct device_description *desc = &netdev->dev->desc;
238         struct dhcp_netdev_desc dhcp_desc;
239         struct dhcp_client_id client_id;
240         struct dhcp_client_uuid client_uuid;
241         unsigned int msgtype;
242         size_t dhcp_features_len;
243         size_t ll_addr_len;
244         int rc;
245
246         /* Create DHCP packet */
247         msgtype = ( dhcpoffer ? DHCPREQUEST : DHCPDISCOVER );
248         if ( ( rc = create_dhcp_packet ( dhcppkt, netdev, msgtype,
249                                          &dhcp_request_options, data,
250                                          max_len ) ) != 0 ) {
251                 DBG ( "DHCP could not create DHCP packet: %s\n",
252                       strerror ( rc ) );
253                 return rc;
254         }
255
256         /* Copy any required options from previous server repsonse */
257         if ( dhcpoffer ) {
258                 struct in_addr server_id;
259                 struct in_addr requested_ip;
260
261                 if ( ( rc = fetch_ipv4_setting ( &dhcpoffer->settings,
262                                                  DHCP_SERVER_IDENTIFIER,
263                                                  &server_id ) ) < 0 ) {
264                         DBG ( "DHCP offer missing server identifier\n" );
265                         return -EINVAL;
266                 }
267                 if ( ( rc = fetch_ipv4_setting ( &dhcpoffer->settings,
268                                                  DHCP_EB_YIADDR,
269                                                  &requested_ip ) ) < 0 ) {
270                         DBG ( "DHCP offer missing IP address\n" );
271                         return -EINVAL;
272                 }
273                 if ( ( rc = store_setting ( &dhcppkt->settings,
274                                             DHCP_SERVER_IDENTIFIER, &server_id,
275                                             sizeof ( server_id ) ) ) != 0 ) {
276                         DBG ( "DHCP could not set server identifier: %s\n ",
277                               strerror ( rc ) );
278                         return rc;
279                 }
280                 if ( ( rc = store_setting ( &dhcppkt->settings,
281                                             DHCP_REQUESTED_ADDRESS,
282                                             &requested_ip,
283                                             sizeof ( requested_ip ) ) ) != 0 ){
284                         DBG ( "DHCP could not set requested address: %s\n",
285                               strerror ( rc ) );
286                         return rc;
287                 }
288         }
289
290         /* Add options to identify the feature list */
291         dhcp_features_len = ( dhcp_features_end - dhcp_features );
292         if ( ( rc = store_setting ( &dhcppkt->settings, DHCP_EB_ENCAP,
293                                     dhcp_features, dhcp_features_len ) ) !=0 ){
294                 DBG ( "DHCP could not set features list option: %s\n",
295                       strerror ( rc ) );
296                 return rc;
297         }
298
299         /* Add options to identify the network device */
300         dhcp_desc.type = desc->bus_type;
301         dhcp_desc.vendor = htons ( desc->vendor );
302         dhcp_desc.device = htons ( desc->device );
303         if ( ( rc = store_setting ( &dhcppkt->settings, DHCP_EB_BUS_ID,
304                                     &dhcp_desc, sizeof ( dhcp_desc ) ) ) !=0 ){
305                 DBG ( "DHCP could not set bus ID option: %s\n",
306                       strerror ( rc ) );
307                 return rc;
308         }
309
310         /* Add DHCP client identifier.  Required for Infiniband, and
311          * doesn't hurt other link layers.
312          */
313         client_id.ll_proto = ntohs ( netdev->ll_protocol->ll_proto );
314         ll_addr_len = netdev->ll_protocol->ll_addr_len;
315         assert ( ll_addr_len <= sizeof ( client_id.ll_addr ) );
316         memcpy ( client_id.ll_addr, netdev->ll_addr, ll_addr_len );
317         if ( ( rc = store_setting ( &dhcppkt->settings, DHCP_CLIENT_ID,
318                                     &client_id, ( ll_addr_len + 1 ) ) ) != 0 ){
319                 DBG ( "DHCP could not set client ID: %s\n",
320                       strerror ( rc ) );
321                 return rc;
322         }
323
324         /* Add client UUID, if we have one.  Required for PXE. */
325         client_uuid.type = DHCP_CLIENT_UUID_TYPE;
326         if ( ( rc = get_uuid ( &client_uuid.uuid ) ) == 0 ) {
327                 if ( ( rc = store_setting ( &dhcppkt->settings,
328                                             DHCP_CLIENT_UUID, &client_uuid,
329                                             sizeof ( client_uuid ) ) ) != 0 ) {
330                         DBG ( "DHCP could not set client UUID: %s\n",
331                               strerror ( rc ) );
332                         return rc;
333                 }
334         }
335
336         return 0;
337 }
338
339 /**
340  * Create DHCPDISCOVER packet
341  *
342  * @v netdev            Network device
343  * @v data              Buffer for DHCP packet
344  * @v max_len           Size of DHCP packet buffer
345  * @ret rc              Return status code
346  *
347  * Used by external code.
348  */
349 int create_dhcpdiscover ( struct net_device *netdev,
350                           void *data, size_t max_len ) {
351         struct dhcp_packet dhcppkt;
352         int rc;
353
354         if ( ( rc = create_dhcp_request ( &dhcppkt, netdev, NULL, data,
355                                           max_len ) ) != 0 ) {
356                 DBG ( "Could not create DHCPDISCOVER: %s\n",
357                       strerror ( rc ) );
358                 return rc;
359         }
360
361         return 0;
362 }
363
364 /**
365  * Create DHCPACK packet
366  *
367  * @v netdev            Network device
368  * @v data              Buffer for DHCP packet
369  * @v max_len           Size of DHCP packet buffer
370  * @ret rc              Return status code
371  *
372  * Used by external code.
373  */
374 int create_dhcpack ( struct net_device *netdev,
375                      void *data, size_t max_len ) {
376         struct dhcp_packet dhcppkt;
377         int rc;
378
379         /* Create base DHCPACK packet */
380         if ( ( rc = create_dhcp_packet ( &dhcppkt, netdev, DHCPACK, NULL,
381                                          data, max_len ) ) != 0 ) {
382                 DBG ( "Could not create DHCPACK: %s\n", strerror ( rc ) );
383                 return rc;
384         }
385
386         /* Merge in globally-scoped settings, then netdev-specific
387          * settings.  Do it in this order so that netdev-specific
388          * settings take precedence regardless of stated priorities.
389          */
390         if ( ( rc = copy_settings ( &dhcppkt.settings, NULL ) ) != 0 ) {
391                 DBG ( "Could not set DHCPACK global settings: %s\n",
392                       strerror ( rc ) );
393                 return rc;
394         }
395         if ( ( rc = copy_settings ( &dhcppkt.settings,
396                                     netdev_settings ( netdev ) ) ) != 0 ) {
397                 DBG ( "Could not set DHCPACK netdev settings: %s\n",
398                       strerror ( rc ) );
399                 return rc;
400         }
401
402         return 0;
403 }
404
405 /**
406  * Create ProxyDHCPACK packet
407  *
408  * @v netdev            Network device
409  * @v data              Buffer for DHCP packet
410  * @v max_len           Size of DHCP packet buffer
411  * @ret rc              Return status code
412  *
413  * Used by external code.
414  */
415 int create_proxydhcpack ( struct net_device *netdev,
416                           void *data, size_t max_len ) {
417         struct dhcp_packet dhcppkt;
418         struct settings *settings;
419         int rc;
420
421         /* Identify ProxyDHCP settings */
422         settings = find_settings ( PROXYDHCP_SETTINGS_NAME );
423
424         /* No ProxyDHCP settings => return empty block */
425         if ( ! settings ) {
426                 memset ( data, 0, max_len );
427                 return 0;
428         }
429
430         /* Create base DHCPACK packet */
431         if ( ( rc = create_dhcp_packet ( &dhcppkt, netdev, DHCPACK, NULL,
432                                          data, max_len ) ) != 0 ) {
433                 DBG ( "Could not create ProxyDHCPACK: %s\n",
434                       strerror ( rc ) );
435                 return rc;
436         }
437
438         /* Merge in ProxyDHCP options */
439         if ( ( rc = copy_settings ( &dhcppkt.settings, settings ) ) != 0 ) {
440                 DBG ( "Could not set ProxyDHCPACK settings: %s\n",
441                       strerror ( rc ) );
442                 return rc;
443         }
444
445         return 0;
446 }
447
448 /****************************************************************************
449  *
450  * DHCP packets contained in I/O buffers
451  *
452  */
453
454 /** A DHCP packet contained in an I/O buffer */
455 struct dhcp_iobuf_packet {
456         /** DHCP packet */
457         struct dhcp_packet dhcppkt;
458         /** Reference counter */
459         struct refcnt refcnt;
460         /** Containing I/O buffer */
461         struct io_buffer *iobuf;
462 };
463
464 /**
465  * Free DHCP packet contained in an I/O buffer
466  *
467  * @v refcnt            Reference counter
468  */
469 static void dhcpiob_free ( struct refcnt *refcnt ) {
470         struct dhcp_iobuf_packet *dhcpiob =
471                 container_of ( refcnt, struct dhcp_iobuf_packet, refcnt );
472
473         free_iob ( dhcpiob->iobuf );
474         free ( dhcpiob );
475 }
476
477 /**
478  * Create DHCP packet from I/O buffer
479  *
480  * @v iobuf             I/O buffer
481  * @ret dhcpiob         DHCP packet contained in I/O buffer
482  *
483  * This function takes ownership of the I/O buffer.  Future accesses
484  * must be via the @c dhcpiob data structure.
485  */
486 static struct dhcp_iobuf_packet * dhcpiob_create ( struct io_buffer *iobuf ) {
487         struct dhcp_iobuf_packet *dhcpiob;
488
489         dhcpiob = zalloc ( sizeof ( *dhcpiob ) );
490         if ( dhcpiob ) {
491                 dhcpiob->refcnt.free = dhcpiob_free;
492                 dhcpiob->iobuf = iobuf;
493                 dhcppkt_init ( &dhcpiob->dhcppkt, &dhcpiob->refcnt,
494                                iobuf->data, iob_len ( iobuf ) );
495         }
496         return dhcpiob;
497 }
498
499 static void dhcpiob_put ( struct dhcp_iobuf_packet *dhcpiob ) {
500         if ( dhcpiob )
501                 ref_put ( &dhcpiob->refcnt );
502 }
503
504 /****************************************************************************
505  *
506  * DHCP to UDP interface
507  *
508  */
509
510 /** A DHCP session */
511 struct dhcp_session {
512         /** Reference counter */
513         struct refcnt refcnt;
514         /** Job control interface */
515         struct job_interface job;
516         /** Data transfer interface */
517         struct xfer_interface xfer;
518
519         /** Network device being configured */
520         struct net_device *netdev;
521
522         /** State of the session
523          *
524          * This is a value for the @c DHCP_MESSAGE_TYPE option
525          * (e.g. @c DHCPDISCOVER).
526          */
527         int state;
528         /** Response obtained from DHCP server */
529         struct dhcp_iobuf_packet *response;
530         /** Response obtained from ProxyDHCP server */
531         struct dhcp_iobuf_packet *proxy_response;
532         /** Retransmission timer */
533         struct retry_timer timer;
534         /** Session start time (in ticks) */
535         unsigned long start;
536 };
537
538 /**
539  * Free DHCP session
540  *
541  * @v refcnt            Reference counter
542  */
543 static void dhcp_free ( struct refcnt *refcnt ) {
544         struct dhcp_session *dhcp =
545                 container_of ( refcnt, struct dhcp_session, refcnt );
546
547         netdev_put ( dhcp->netdev );
548         dhcpiob_put ( dhcp->response );
549         dhcpiob_put ( dhcp->proxy_response );
550         free ( dhcp );
551 }
552
553 /**
554  * Mark DHCP session as complete
555  *
556  * @v dhcp              DHCP session
557  * @v rc                Return status code
558  */
559 static void dhcp_finished ( struct dhcp_session *dhcp, int rc ) {
560
561         /* Block futher incoming messages */
562         job_nullify ( &dhcp->job );
563         xfer_nullify ( &dhcp->xfer );
564
565         /* Stop retry timer */
566         stop_timer ( &dhcp->timer );
567
568         /* Free resources and close interfaces */
569         xfer_close ( &dhcp->xfer, rc );
570         job_done ( &dhcp->job, rc );
571 }
572
573 /**
574  * Register options received via DHCP
575  *
576  * @v dhcp              DHCP session
577  * @ret rc              Return status code
578  */
579 static int dhcp_register_settings ( struct dhcp_session *dhcp ) {
580         struct settings *old_settings;
581         struct settings *settings;
582         struct settings *parent;
583         int rc;
584
585         /* Register ProxyDHCP settings, if present */
586         if ( dhcp->proxy_response ) {
587                 settings = &dhcp->proxy_response->dhcppkt.settings;
588                 settings->name = PROXYDHCP_SETTINGS_NAME;
589                 old_settings = find_settings ( settings->name );
590                 if ( old_settings )
591                         unregister_settings ( old_settings );
592                 if ( ( rc = register_settings ( settings, NULL ) ) != 0 )
593                         return rc;
594         }
595
596         /* Register DHCP settings */
597         parent = netdev_settings ( dhcp->netdev );
598         settings = &dhcp->response->dhcppkt.settings;
599         old_settings = find_child_settings ( parent, settings->name );
600         if ( old_settings )
601                 unregister_settings ( old_settings );
602         if ( ( rc = register_settings ( settings, parent ) ) != 0 )
603                 return rc;
604
605         return 0;
606 }
607
608 /****************************************************************************
609  *
610  * Data transfer interface
611  *
612  */
613
614 /**
615  * Transmit DHCP request
616  *
617  * @v dhcp              DHCP session
618  * @ret rc              Return status code
619  */
620 static int dhcp_send_request ( struct dhcp_session *dhcp ) {
621         struct xfer_metadata meta = {
622                 .netdev = dhcp->netdev,
623         };
624         struct io_buffer *iobuf;
625         struct dhcp_packet *dhcpoffer;
626         struct dhcp_packet dhcppkt;
627         int rc;
628         
629         DBGC ( dhcp, "DHCP %p transmitting %s\n",
630                dhcp, dhcp_msgtype_name ( dhcp->state ) );
631
632         assert ( ( dhcp->state == DHCPDISCOVER ) ||
633                  ( dhcp->state == DHCPREQUEST ) );
634
635         /* Start retry timer.  Do this first so that failures to
636          * transmit will be retried.
637          */
638         start_timer ( &dhcp->timer );
639
640         /* Allocate buffer for packet */
641         iobuf = xfer_alloc_iob ( &dhcp->xfer, DHCP_MIN_LEN );
642         if ( ! iobuf )
643                 return -ENOMEM;
644
645         /* Create DHCP packet in temporary buffer */
646         dhcpoffer = ( dhcp->response ? &dhcp->response->dhcppkt : NULL );
647         if ( ( rc = create_dhcp_request ( &dhcppkt, dhcp->netdev,
648                                           dhcpoffer, iobuf->data,
649                                           iob_tailroom ( iobuf ) ) ) != 0 ) {
650                 DBGC ( dhcp, "DHCP %p could not construct DHCP request: %s\n",
651                        dhcp, strerror ( rc ) );
652                 goto done;
653         }
654
655         /* Transmit the packet */
656         iob_put ( iobuf, dhcppkt.len );
657         rc = xfer_deliver_iob_meta ( &dhcp->xfer, iobuf, &meta );
658         iobuf = NULL;
659         if ( rc != 0 ) {
660                 DBGC ( dhcp, "DHCP %p could not transmit UDP packet: %s\n",
661                        dhcp, strerror ( rc ) );
662                 goto done;
663         }
664
665  done:
666         free_iob ( iobuf );
667         return rc;
668 }
669
670 /**
671  * Handle DHCP retry timer expiry
672  *
673  * @v timer             DHCP retry timer
674  * @v fail              Failure indicator
675  */
676 static void dhcp_timer_expired ( struct retry_timer *timer, int fail ) {
677         struct dhcp_session *dhcp =
678                 container_of ( timer, struct dhcp_session, timer );
679
680         if ( fail ) {
681                 dhcp_finished ( dhcp, -ETIMEDOUT );
682         } else {
683                 dhcp_send_request ( dhcp );
684         }
685 }
686
687 /**
688  * Receive new data
689  *
690  * @v xfer              Data transfer interface
691  * @v iobuf             I/O buffer
692  * @v data              Received data
693  * @v len               Length of received data
694  * @ret rc              Return status code
695  */
696 static int dhcp_deliver_iob ( struct xfer_interface *xfer,
697                               struct io_buffer *iobuf,
698                               struct xfer_metadata *meta __unused ) {
699         struct dhcp_session *dhcp =
700                 container_of ( xfer, struct dhcp_session, xfer );
701         struct dhcp_iobuf_packet *response;
702         struct dhcp_iobuf_packet **store_response;
703         struct dhcphdr *dhcphdr;
704         struct settings *settings;
705         unsigned int msgtype;
706         unsigned long elapsed;
707         int is_proxy;
708         int ignore_proxy;
709         int rc;
710
711         /* Convert packet into a DHCP-packet-in-iobuf */
712         response = dhcpiob_create ( iobuf );
713         if ( ! response ) {
714                 DBGC ( dhcp, "DHCP %p could not store DHCP packet\n", dhcp );
715                 return -ENOMEM;
716         }
717         dhcphdr = response->dhcppkt.dhcphdr;
718         settings = &response->dhcppkt.settings;
719
720         /* Check for matching transaction ID */
721         if ( dhcphdr->xid != dhcp_xid ( dhcp->netdev ) ) {
722                 DBGC ( dhcp, "DHCP %p wrong transaction ID (wanted %08lx, "
723                         "got %08lx)\n", dhcp, ntohl ( dhcphdr->xid ),
724                         ntohl ( dhcp_xid ( dhcp->netdev ) ) );
725                 goto out_discard;
726         };      
727
728         /* Determine and verify message type */
729         is_proxy = ( dhcphdr->yiaddr.s_addr == 0 );
730         msgtype = fetch_uintz_setting ( settings, DHCP_MESSAGE_TYPE );
731         DBGC ( dhcp, "DHCP %p received %s%s\n", dhcp,
732                ( is_proxy ? "Proxy" : "" ), dhcp_msgtype_name ( msgtype ) );
733         if ( ( ( dhcp->state != DHCPDISCOVER ) || ( msgtype != DHCPOFFER ) ) &&
734              ( ( dhcp->state != DHCPREQUEST ) || ( msgtype != DHCPACK ) ) ) {
735                 DBGC ( dhcp, "DHCP %p discarding %s while in %s state\n",
736                        dhcp, dhcp_msgtype_name ( msgtype ),
737                        dhcp_msgtype_name ( dhcp->state ) );
738                 goto out_discard;
739         }
740
741         /* Update stored standard/ProxyDHCP options, if the new
742          * options have equal or higher priority than the
743          * currently-stored options.
744          */
745         store_response = ( is_proxy ? &dhcp->proxy_response : &dhcp->response);
746         if ( ( ! *store_response ) || 
747              ( fetch_uintz_setting ( settings, DHCP_EB_PRIORITY ) >=
748                fetch_uintz_setting ( &(*store_response)->dhcppkt.settings,
749                                      DHCP_EB_PRIORITY ) ) ) {
750                 dhcpiob_put ( *store_response );
751                 *store_response = response;
752         } else {
753                 dhcpiob_put ( response );
754         }
755
756         /* If we don't yet have a standard DHCP response (i.e. one
757          * with an IP address), then just leave the timer running.
758          */
759         if ( ! dhcp->response )
760                 goto out;
761
762         /* Handle DHCP response */
763         ignore_proxy = fetch_uintz_setting ( &dhcp->response->dhcppkt.settings,
764                                              DHCP_EB_NO_PROXYDHCP );
765         switch ( dhcp->state ) {
766         case DHCPDISCOVER:
767                 /* If we have allowed sufficient time for ProxyDHCP
768                  * reponses, then transition to making the DHCPREQUEST.
769                  */
770                 elapsed = ( currticks() - dhcp->start );
771                 if ( ignore_proxy || ( elapsed > PROXYDHCP_WAIT_TIME ) ) {
772                         stop_timer ( &dhcp->timer );
773                         dhcp->state = DHCPREQUEST;
774                         dhcp_send_request ( dhcp );
775                 }
776                 break;
777         case DHCPREQUEST:
778                 /* DHCP finished; register options and exit */
779                 if ( ignore_proxy && dhcp->proxy_response ) {
780                         dhcpiob_put ( dhcp->proxy_response );
781                         dhcp->proxy_response = NULL;
782                 }
783                 if ( ( rc = dhcp_register_settings ( dhcp ) ) != 0 ) {
784                         dhcp_finished ( dhcp, rc );
785                         break;
786                 }
787                 dhcp_finished ( dhcp, 0 );
788                 break;
789         default:
790                 assert ( 0 );
791         }
792
793  out:
794         return 0;
795
796  out_discard:
797         dhcpiob_put ( response );
798         return 0;
799 }
800
801 /** DHCP data transfer interface operations */
802 static struct xfer_interface_operations dhcp_xfer_operations = {
803         .close          = ignore_xfer_close,
804         .vredirect      = xfer_vopen,
805         .window         = unlimited_xfer_window,
806         .alloc_iob      = default_xfer_alloc_iob,
807         .deliver_iob    = dhcp_deliver_iob,
808         .deliver_raw    = xfer_deliver_as_iob,
809 };
810
811 /****************************************************************************
812  *
813  * Job control interface
814  *
815  */
816
817 /**
818  * Handle kill() event received via job control interface
819  *
820  * @v job               DHCP job control interface
821  */
822 static void dhcp_job_kill ( struct job_interface *job ) {
823         struct dhcp_session *dhcp =
824                 container_of ( job, struct dhcp_session, job );
825
826         /* Terminate DHCP session */
827         dhcp_finished ( dhcp, -ECANCELED );
828 }
829
830 /** DHCP job control interface operations */
831 static struct job_interface_operations dhcp_job_operations = {
832         .done           = ignore_job_done,
833         .kill           = dhcp_job_kill,
834         .progress       = ignore_job_progress,
835 };
836
837 /****************************************************************************
838  *
839  * Instantiator
840  *
841  */
842
843 /**
844  * Start DHCP on a network device
845  *
846  * @v job               Job control interface
847  * @v netdev            Network device
848  * @v register_options  DHCP option block registration routine
849  * @ret rc              Return status code
850  *
851  * Starts DHCP on the specified network device.  If successful, the @c
852  * register_options() routine will be called with the acquired
853  * options.
854  */
855 int start_dhcp ( struct job_interface *job, struct net_device *netdev ) {
856         static struct sockaddr_in server = {
857                 .sin_family = AF_INET,
858                 .sin_addr.s_addr = INADDR_BROADCAST,
859                 .sin_port = htons ( BOOTPS_PORT ),
860         };
861         static struct sockaddr_in client = {
862                 .sin_family = AF_INET,
863                 .sin_port = htons ( BOOTPC_PORT ),
864         };
865         struct dhcp_session *dhcp;
866         int rc;
867
868         /* Allocate and initialise structure */
869         dhcp = zalloc ( sizeof ( *dhcp ) );
870         if ( ! dhcp )
871                 return -ENOMEM;
872         dhcp->refcnt.free = dhcp_free;
873         job_init ( &dhcp->job, &dhcp_job_operations, &dhcp->refcnt );
874         xfer_init ( &dhcp->xfer, &dhcp_xfer_operations, &dhcp->refcnt );
875         dhcp->netdev = netdev_get ( netdev );
876         dhcp->timer.expired = dhcp_timer_expired;
877         dhcp->state = DHCPDISCOVER;
878         dhcp->start = currticks();
879
880         /* Instantiate child objects and attach to our interfaces */
881         if ( ( rc = xfer_open_socket ( &dhcp->xfer, SOCK_DGRAM,
882                                        ( struct sockaddr * ) &server,
883                                        ( struct sockaddr * ) &client ) ) != 0 )
884                 goto err;
885
886         /* Start timer to initiate initial DHCPREQUEST */
887         start_timer_nodelay ( &dhcp->timer );
888
889         /* Attach parent interface, mortalise self, and return */
890         job_plug_plug ( &dhcp->job, job );
891         ref_put ( &dhcp->refcnt );
892         return 0;
893
894  err:
895         dhcp_finished ( dhcp, rc );
896         ref_put ( &dhcp->refcnt );
897         return rc;
898 }