[Settings] Migrate DHCP and NVO code to the new settings API (untested)
[people/dverkamp/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 /**
134  * Create a DHCP packet
135  *
136  * @v dhcppkt           DHCP packet structure to fill in
137  * @v netdev            Network device
138  * @v msgtype           DHCP message type
139  * @v options           Initial options to include (or NULL)
140  * @v data              Buffer for DHCP packet
141  * @v max_len           Size of DHCP packet buffer
142  * @ret rc              Return status code
143  *
144  * Creates a DHCP packet in the specified buffer, and fills out a @c
145  * dhcp_packet structure that can be passed to
146  * set_dhcp_packet_option() or copy_dhcp_packet_options().
147  */
148 static int create_dhcp_packet ( struct dhcp_packet *dhcppkt,
149                                 struct net_device *netdev, uint8_t msgtype,
150                                 struct dhcp_options *options, 
151                                 void *data, size_t max_len ) {
152         struct dhcphdr *dhcphdr = data;
153         size_t options_len;
154         unsigned int hlen;
155         int rc;
156
157         /* Sanity check */
158         options_len = ( options ? options->len : 0 );
159         if ( max_len < ( sizeof ( *dhcphdr ) + options_len ) )
160                 return -ENOSPC;
161
162         /* Initialise DHCP packet content */
163         memset ( dhcphdr, 0, max_len );
164         dhcphdr->xid = dhcp_xid ( netdev );
165         dhcphdr->magic = htonl ( DHCP_MAGIC_COOKIE );
166         dhcphdr->htype = ntohs ( netdev->ll_protocol->ll_proto );
167         dhcphdr->op = dhcp_op[msgtype];
168         /* If hardware length exceeds the chaddr field length, don't
169          * use the chaddr field.  This is as per RFC4390.
170          */
171         hlen = netdev->ll_protocol->ll_addr_len;
172         if ( hlen > sizeof ( dhcphdr->chaddr ) ) {
173                 hlen = 0;
174                 dhcphdr->flags = htons ( BOOTP_FL_BROADCAST );
175         }
176         dhcphdr->hlen = hlen;
177         memcpy ( dhcphdr->chaddr, netdev->ll_addr, hlen );
178         memcpy ( dhcphdr->options, options, options_len );
179
180         /* Initialise DHCP packet structure and settings interface */
181         dhcppkt_init ( dhcppkt, NULL, data, max_len );
182         
183         /* Set DHCP_MESSAGE_TYPE option */
184         if ( ( rc = store_setting ( &dhcppkt->settings, DHCP_MESSAGE_TYPE,
185                                     &msgtype, sizeof ( msgtype ) ) ) != 0 )
186                 return rc;
187
188         return 0;
189 }
190
191 /** DHCP network device descriptor */
192 struct dhcp_netdev_desc {
193         /** Bus type ID */
194         uint8_t type;
195         /** Vendor ID */
196         uint16_t vendor;
197         /** Device ID */
198         uint16_t device;
199 } __attribute__ (( packed ));
200
201 /** DHCP client identifier */
202 struct dhcp_client_id {
203         /** Link-layer protocol */
204         uint8_t ll_proto;
205         /** Link-layer address */
206         uint8_t ll_addr[MAX_LL_ADDR_LEN];
207 } __attribute__ (( packed ));
208
209 /** DHCP client UUID */
210 struct dhcp_client_uuid {
211         /** Identifier type */
212         uint8_t type;
213         /** UUID */
214         union uuid uuid;
215 } __attribute__ (( packed ));
216
217 #define DHCP_CLIENT_UUID_TYPE 0
218
219 /**
220  * Create DHCP request
221  *
222  * @v dhcppkt           DHCP packet structure to fill in
223  * @v netdev            Network device
224  * @v msgtype           DHCP message type
225  * @v offer_settings    Settings received in DHCPOFFER, or NULL
226  * @v data              Buffer for DHCP packet
227  * @v max_len           Size of DHCP packet buffer
228  * @ret rc              Return status code
229  */
230 int create_dhcp_request ( struct dhcp_packet *dhcppkt,
231                           struct net_device *netdev, int msgtype,
232                           struct settings *offer_settings,
233                           void *data, size_t max_len ) {
234         struct device_description *desc = &netdev->dev->desc;
235         struct dhcp_netdev_desc dhcp_desc;
236         struct dhcp_client_id client_id;
237         struct dhcp_client_uuid client_uuid;
238         size_t dhcp_features_len;
239         size_t ll_addr_len;
240         int rc;
241
242         /* Create DHCP packet */
243         if ( ( rc = create_dhcp_packet ( dhcppkt, netdev, msgtype,
244                                          &dhcp_request_options, data,
245                                          max_len ) ) != 0 ) {
246                 DBG ( "DHCP could not create DHCP packet: %s\n",
247                       strerror ( rc ) );
248                 return rc;
249         }
250
251         /* Copy any required options from previous server repsonse */
252         if ( offer_settings ) {
253                 if ( ( rc = copy_setting ( &dhcppkt->settings,
254                                            DHCP_SERVER_IDENTIFIER,
255                                            offer_settings,
256                                            DHCP_SERVER_IDENTIFIER ) ) != 0 ) {
257                         DBG ( "DHCP could not set server identifier "
258                               "option: %s\n", strerror ( rc ) );
259                         return rc;
260                 }
261                 if ( ( rc = copy_setting ( &dhcppkt->settings, DHCP_EB_YIADDR,
262                                            offer_settings,
263                                            DHCP_REQUESTED_ADDRESS ) ) != 0 ) {
264                         DBG ( "DHCP could not set requested address "
265                               "option: %s\n", strerror ( rc ) );
266                         return rc;
267                 }
268         }
269
270         /* Add options to identify the feature list */
271         dhcp_features_len = ( dhcp_features_end - dhcp_features );
272         if ( ( rc = store_setting ( &dhcppkt->settings, DHCP_EB_ENCAP,
273                                     dhcp_features, dhcp_features_len ) ) !=0 ){
274                 DBG ( "DHCP could not set features list option: %s\n",
275                       strerror ( rc ) );
276                 return rc;
277         }
278
279         /* Add options to identify the network device */
280         dhcp_desc.type = desc->bus_type;
281         dhcp_desc.vendor = htons ( desc->vendor );
282         dhcp_desc.device = htons ( desc->device );
283         if ( ( rc = store_setting ( &dhcppkt->settings, DHCP_EB_BUS_ID,
284                                     &dhcp_desc, sizeof ( dhcp_desc ) ) ) !=0 ){
285                 DBG ( "DHCP could not set bus ID option: %s\n",
286                       strerror ( rc ) );
287                 return rc;
288         }
289
290         /* Add DHCP client identifier.  Required for Infiniband, and
291          * doesn't hurt other link layers.
292          */
293         client_id.ll_proto = ntohs ( netdev->ll_protocol->ll_proto );
294         ll_addr_len = netdev->ll_protocol->ll_addr_len;
295         assert ( ll_addr_len <= sizeof ( client_id.ll_addr ) );
296         memcpy ( client_id.ll_addr, netdev->ll_addr, ll_addr_len );
297         if ( ( rc = store_setting ( &dhcppkt->settings, DHCP_CLIENT_ID,
298                                     &client_id, ( ll_addr_len + 1 ) ) ) != 0 ){
299                 DBG ( "DHCP could not set client ID: %s\n",
300                       strerror ( rc ) );
301                 return rc;
302         }
303
304         /* Add client UUID, if we have one.  Required for PXE. */
305         client_uuid.type = DHCP_CLIENT_UUID_TYPE;
306         if ( ( rc = get_uuid ( &client_uuid.uuid ) ) == 0 ) {
307                 if ( ( rc = store_setting ( &dhcppkt->settings,
308                                             DHCP_CLIENT_UUID, &client_uuid,
309                                             sizeof ( client_uuid ) ) ) != 0 ) {
310                         DBG ( "DHCP could not set client UUID: %s\n",
311                               strerror ( rc ) );
312                         return rc;
313                 }
314         }
315
316         return 0;
317 }
318
319 /**
320  * Create DHCP response
321  *
322  * @v dhcppkt           DHCP packet structure to fill in
323  * @v netdev            Network device
324  * @v msgtype           DHCP message type
325  * @v settings          Settings to include, or NULL
326  * @v data              Buffer for DHCP packet
327  * @v max_len           Size of DHCP packet buffer
328  * @ret rc              Return status code
329  */
330 int create_dhcp_response ( struct dhcp_packet *dhcppkt,
331                            struct net_device *netdev, int msgtype,
332                            struct settings *settings,
333                            void *data, size_t max_len ) {
334         int rc;
335
336         /* Create packet and copy in options */
337         if ( ( rc = create_dhcp_packet ( dhcppkt, netdev, msgtype, NULL,
338                                          data, max_len ) ) != 0 )
339                 return rc;
340         if ( ( rc = copy_settings ( &dhcppkt->settings, settings ) ) != 0 )
341                 return rc;
342
343         return 0;
344 }
345
346 /****************************************************************************
347  *
348  * DHCP packets contained in I/O buffers
349  *
350  */
351
352 /** A DHCP packet contained in an I/O buffer */
353 struct dhcp_iobuf_packet {
354         /** Reference counter */
355         struct refcnt refcnt;
356         /** DHCP packet */
357         struct dhcp_packet dhcppkt;
358         /** Containing I/O buffer */
359         struct io_buffer *iobuf;
360 };
361
362 /**
363  * Free DHCP packet contained in an I/O buffer
364  *
365  * @v refcnt            Reference counter
366  */
367 static void dhcpiob_free ( struct refcnt *refcnt ) {
368         struct dhcp_iobuf_packet *dhcpiob =
369                 container_of ( refcnt, struct dhcp_iobuf_packet, refcnt );
370
371         free_iob ( dhcpiob->iobuf );
372         free ( dhcpiob );
373 }
374
375 /**
376  * Create DHCP packet from I/O buffer
377  *
378  * @v iobuf             I/O buffer
379  * @ret dhcpiob         DHCP packet contained in I/O buffer
380  *
381  * This function takes ownership of the I/O buffer.  Future accesses
382  * must be via the @c dhcpiob data structure.
383  */
384 static struct dhcp_iobuf_packet * dhcpiob_create ( struct io_buffer *iobuf ) {
385         struct dhcp_iobuf_packet *dhcpiob;
386
387         dhcpiob = zalloc ( sizeof ( *dhcpiob ) );
388         if ( dhcpiob ) {
389                 dhcpiob->refcnt.free = dhcpiob_free;
390                 dhcpiob->iobuf = iobuf;
391                 dhcppkt_init ( &dhcpiob->dhcppkt, &dhcpiob->refcnt,
392                                iobuf->data, iob_len ( iobuf ) );
393         }
394         return dhcpiob;
395 }
396
397 static void dhcpiob_put ( struct dhcp_iobuf_packet *dhcpiob ) {
398         if ( dhcpiob )
399                 ref_put ( &dhcpiob->refcnt );
400 }
401
402 /****************************************************************************
403  *
404  * DHCP to UDP interface
405  *
406  */
407
408 /** A DHCP session */
409 struct dhcp_session {
410         /** Reference counter */
411         struct refcnt refcnt;
412         /** Job control interface */
413         struct job_interface job;
414         /** Data transfer interface */
415         struct xfer_interface xfer;
416
417         /** Network device being configured */
418         struct net_device *netdev;
419
420         /** State of the session
421          *
422          * This is a value for the @c DHCP_MESSAGE_TYPE option
423          * (e.g. @c DHCPDISCOVER).
424          */
425         int state;
426         /** Response obtained from DHCP server */
427         struct dhcp_iobuf_packet *response;
428         /** Response obtained from ProxyDHCP server */
429         struct dhcp_iobuf_packet *proxy_response;
430         /** Retransmission timer */
431         struct retry_timer timer;
432         /** Session start time (in ticks) */
433         unsigned long start;
434 };
435
436 /**
437  * Free DHCP session
438  *
439  * @v refcnt            Reference counter
440  */
441 static void dhcp_free ( struct refcnt *refcnt ) {
442         struct dhcp_session *dhcp =
443                 container_of ( refcnt, struct dhcp_session, refcnt );
444
445         netdev_put ( dhcp->netdev );
446         dhcpiob_put ( dhcp->response );
447         dhcpiob_put ( dhcp->proxy_response );
448         free ( dhcp );
449 }
450
451 /**
452  * Mark DHCP session as complete
453  *
454  * @v dhcp              DHCP session
455  * @v rc                Return status code
456  */
457 static void dhcp_finished ( struct dhcp_session *dhcp, int rc ) {
458
459         /* Block futher incoming messages */
460         job_nullify ( &dhcp->job );
461         xfer_nullify ( &dhcp->xfer );
462
463         /* Stop retry timer */
464         stop_timer ( &dhcp->timer );
465
466         /* Free resources and close interfaces */
467         xfer_close ( &dhcp->xfer, rc );
468         job_done ( &dhcp->job, rc );
469 }
470
471 /**
472  * Register options received via DHCP
473  *
474  * @v dhcp              DHCP session
475  * @ret rc              Return status code
476  */
477 static int dhcp_register_settings ( struct dhcp_session *dhcp ) {
478         struct settings *settings;
479         struct settings *parent;
480         int rc;
481
482         if ( dhcp->proxy_response ) {
483                 settings = &dhcp->proxy_response->dhcppkt.settings;
484                 if ( ( rc = register_settings ( settings, NULL ) ) != 0 )
485                         return rc;
486         }
487
488         settings = &dhcp->response->dhcppkt.settings;
489         parent = netdev_settings ( dhcp->netdev );
490         if ( ( rc = register_settings ( settings, parent ) ) != 0 )
491                 return rc;
492
493         return 0;
494 }
495
496 /****************************************************************************
497  *
498  * Data transfer interface
499  *
500  */
501
502 /**
503  * Transmit DHCP request
504  *
505  * @v dhcp              DHCP session
506  * @ret rc              Return status code
507  */
508 static int dhcp_send_request ( struct dhcp_session *dhcp ) {
509         struct xfer_metadata meta = {
510                 .netdev = dhcp->netdev,
511         };
512         struct settings *offer_settings = NULL;
513         struct io_buffer *iobuf;
514         struct dhcp_packet dhcppkt;
515         int rc;
516         
517         DBGC ( dhcp, "DHCP %p transmitting %s\n",
518                dhcp, dhcp_msgtype_name ( dhcp->state ) );
519
520         assert ( ( dhcp->state == DHCPDISCOVER ) ||
521                  ( dhcp->state == DHCPREQUEST ) );
522
523         /* Start retry timer.  Do this first so that failures to
524          * transmit will be retried.
525          */
526         start_timer ( &dhcp->timer );
527
528         /* Allocate buffer for packet */
529         iobuf = xfer_alloc_iob ( &dhcp->xfer, DHCP_MIN_LEN );
530         if ( ! iobuf )
531                 return -ENOMEM;
532
533         /* Create DHCP packet in temporary buffer */
534         if ( dhcp->response )
535                 offer_settings = &dhcp->response->dhcppkt.settings;
536         if ( ( rc = create_dhcp_request ( &dhcppkt, dhcp->netdev, dhcp->state,
537                                           offer_settings, iobuf->data,
538                                           iob_tailroom ( iobuf ) ) ) != 0 ) {
539                 DBGC ( dhcp, "DHCP %p could not construct DHCP request: %s\n",
540                        dhcp, strerror ( rc ) );
541                 goto done;
542         }
543
544         /* Transmit the packet */
545         iob_put ( iobuf, dhcppkt.len );
546         rc = xfer_deliver_iob_meta ( &dhcp->xfer, iobuf, &meta );
547         iobuf = NULL;
548         if ( rc != 0 ) {
549                 DBGC ( dhcp, "DHCP %p could not transmit UDP packet: %s\n",
550                        dhcp, strerror ( rc ) );
551                 goto done;
552         }
553
554  done:
555         free_iob ( iobuf );
556         return rc;
557 }
558
559 /**
560  * Handle DHCP retry timer expiry
561  *
562  * @v timer             DHCP retry timer
563  * @v fail              Failure indicator
564  */
565 static void dhcp_timer_expired ( struct retry_timer *timer, int fail ) {
566         struct dhcp_session *dhcp =
567                 container_of ( timer, struct dhcp_session, timer );
568
569         if ( fail ) {
570                 dhcp_finished ( dhcp, -ETIMEDOUT );
571         } else {
572                 dhcp_send_request ( dhcp );
573         }
574 }
575
576 /**
577  * Receive new data
578  *
579  * @v xfer              Data transfer interface
580  * @v iobuf             I/O buffer
581  * @v data              Received data
582  * @v len               Length of received data
583  * @ret rc              Return status code
584  */
585 static int dhcp_deliver_iob ( struct xfer_interface *xfer,
586                               struct io_buffer *iobuf,
587                               struct xfer_metadata *meta __unused ) {
588         struct dhcp_session *dhcp =
589                 container_of ( xfer, struct dhcp_session, xfer );
590         struct dhcp_iobuf_packet *response;
591         struct dhcp_iobuf_packet **store_response;
592         struct dhcphdr *dhcphdr;
593         struct settings *settings;
594         unsigned int msgtype;
595         unsigned long elapsed;
596         int is_proxy;
597         int ignore_proxy;
598         int rc;
599
600         /* Convert packet into a DHCP-packet-in-iobuf */
601         response = dhcpiob_create ( iobuf );
602         if ( ! response ) {
603                 DBGC ( dhcp, "DHCP %p could not store DHCP packet\n", dhcp );
604                 return -ENOMEM;
605         }
606         dhcphdr = response->dhcppkt.dhcphdr;
607         settings = &response->dhcppkt.settings;
608
609         /* Check for matching transaction ID */
610         if ( dhcphdr->xid != dhcp_xid ( dhcp->netdev ) ) {
611                 DBGC ( dhcp, "DHCP %p wrong transaction ID (wanted %08lx, "
612                         "got %08lx)\n", dhcp, ntohl ( dhcphdr->xid ),
613                         ntohl ( dhcp_xid ( dhcp->netdev ) ) );
614                 goto out_discard;
615         };      
616
617         /* Determine and verify message type */
618         is_proxy = ( dhcphdr->yiaddr.s_addr == 0 );
619         msgtype = fetch_uintz_setting ( settings, DHCP_MESSAGE_TYPE );
620         DBGC ( dhcp, "DHCP %p received %s%s\n", dhcp,
621                ( is_proxy ? "Proxy" : "" ), dhcp_msgtype_name ( msgtype ) );
622         if ( ( ( dhcp->state != DHCPDISCOVER ) || ( msgtype != DHCPOFFER ) ) &&
623              ( ( dhcp->state != DHCPREQUEST ) || ( msgtype != DHCPACK ) ) ) {
624                 DBGC ( dhcp, "DHCP %p discarding %s while in %s state\n",
625                        dhcp, dhcp_msgtype_name ( msgtype ),
626                        dhcp_msgtype_name ( dhcp->state ) );
627                 goto out_discard;
628         }
629
630         /* Update stored standard/ProxyDHCP options, if the new
631          * options have equal or higher priority than the
632          * currently-stored options.
633          */
634         store_response = ( is_proxy ? &dhcp->proxy_response : &dhcp->response);
635         if ( ( ! *store_response ) || 
636              ( fetch_uintz_setting ( settings, DHCP_EB_PRIORITY ) >=
637                fetch_uintz_setting ( &(*store_response)->dhcppkt.settings,
638                                      DHCP_EB_PRIORITY ) ) ) {
639                 dhcpiob_put ( *store_response );
640                 *store_response = response;
641         } else {
642                 dhcpiob_put ( response );
643         }
644
645         /* If we don't yet have a standard DHCP response (i.e. one
646          * with an IP address), then just leave the timer running.
647          */
648         if ( ! dhcp->response )
649                 goto out;
650
651         /* Handle DHCP response */
652         ignore_proxy = fetch_uintz_setting ( &dhcp->response->dhcppkt.settings,
653                                              DHCP_EB_NO_PROXYDHCP );
654         switch ( dhcp->state ) {
655         case DHCPDISCOVER:
656                 /* If we have allowed sufficient time for ProxyDHCP
657                  * reponses, then transition to making the DHCPREQUEST.
658                  */
659                 elapsed = ( currticks() - dhcp->start );
660                 if ( ignore_proxy || ( elapsed > PROXYDHCP_WAIT_TIME ) ) {
661                         stop_timer ( &dhcp->timer );
662                         dhcp->state = DHCPREQUEST;
663                         dhcp_send_request ( dhcp );
664                 }
665                 break;
666         case DHCPREQUEST:
667                 /* DHCP finished; register options and exit */
668                 if ( ignore_proxy && dhcp->proxy_response ) {
669                         dhcpiob_put ( dhcp->proxy_response );
670                         dhcp->proxy_response = NULL;
671                 }
672                 if ( ( rc = dhcp_register_settings ( dhcp ) ) != 0 ) {
673                         dhcp_finished ( dhcp, rc );
674                         break;
675                 }
676                 dhcp_finished ( dhcp, 0 );
677                 break;
678         default:
679                 assert ( 0 );
680         }
681
682  out:
683         return 0;
684
685  out_discard:
686         dhcpiob_put ( response );
687         return 0;
688 }
689
690 /** DHCP data transfer interface operations */
691 static struct xfer_interface_operations dhcp_xfer_operations = {
692         .close          = ignore_xfer_close,
693         .vredirect      = xfer_vopen,
694         .window         = unlimited_xfer_window,
695         .alloc_iob      = default_xfer_alloc_iob,
696         .deliver_iob    = dhcp_deliver_iob,
697         .deliver_raw    = xfer_deliver_as_iob,
698 };
699
700 /****************************************************************************
701  *
702  * Job control interface
703  *
704  */
705
706 /**
707  * Handle kill() event received via job control interface
708  *
709  * @v job               DHCP job control interface
710  */
711 static void dhcp_job_kill ( struct job_interface *job ) {
712         struct dhcp_session *dhcp =
713                 container_of ( job, struct dhcp_session, job );
714
715         /* Terminate DHCP session */
716         dhcp_finished ( dhcp, -ECANCELED );
717 }
718
719 /** DHCP job control interface operations */
720 static struct job_interface_operations dhcp_job_operations = {
721         .done           = ignore_job_done,
722         .kill           = dhcp_job_kill,
723         .progress       = ignore_job_progress,
724 };
725
726 /****************************************************************************
727  *
728  * Instantiator
729  *
730  */
731
732 /**
733  * Start DHCP on a network device
734  *
735  * @v job               Job control interface
736  * @v netdev            Network device
737  * @v register_options  DHCP option block registration routine
738  * @ret rc              Return status code
739  *
740  * Starts DHCP on the specified network device.  If successful, the @c
741  * register_options() routine will be called with the acquired
742  * options.
743  */
744 int start_dhcp ( struct job_interface *job, struct net_device *netdev ) {
745         static struct sockaddr_in server = {
746                 .sin_family = AF_INET,
747                 .sin_addr.s_addr = INADDR_BROADCAST,
748                 .sin_port = htons ( BOOTPS_PORT ),
749         };
750         static struct sockaddr_in client = {
751                 .sin_family = AF_INET,
752                 .sin_port = htons ( BOOTPC_PORT ),
753         };
754         struct dhcp_session *dhcp;
755         int rc;
756
757         /* Allocate and initialise structure */
758         dhcp = zalloc ( sizeof ( *dhcp ) );
759         if ( ! dhcp )
760                 return -ENOMEM;
761         dhcp->refcnt.free = dhcp_free;
762         job_init ( &dhcp->job, &dhcp_job_operations, &dhcp->refcnt );
763         xfer_init ( &dhcp->xfer, &dhcp_xfer_operations, &dhcp->refcnt );
764         dhcp->netdev = netdev_get ( netdev );
765         dhcp->timer.expired = dhcp_timer_expired;
766         dhcp->state = DHCPDISCOVER;
767         dhcp->start = currticks();
768
769         /* Instantiate child objects and attach to our interfaces */
770         if ( ( rc = xfer_open_socket ( &dhcp->xfer, SOCK_DGRAM,
771                                        ( struct sockaddr * ) &server,
772                                        ( struct sockaddr * ) &client ) ) != 0 )
773                 goto err;
774
775         /* Start timer to initiate initial DHCPREQUEST */
776         start_timer_nodelay ( &dhcp->timer );
777
778         /* Attach parent interface, mortalise self, and return */
779         job_plug_plug ( &dhcp->job, job );
780         ref_put ( &dhcp->refcnt );
781         return 0;
782
783  err:
784         dhcp_finished ( dhcp, rc );
785         ref_put ( &dhcp->refcnt );
786         return rc;
787 }