a7935918bb1e885b0f76bfc845e9e294cf605446
[people/mdeck/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 /** DHCP network device descriptor */
96 struct dhcp_netdev_desc {
97         /** Bus type ID */
98         uint8_t type;
99         /** Vendor ID */
100         uint16_t vendor;
101         /** Device ID */
102         uint16_t device;
103 } __attribute__ (( packed ));
104
105 /** DHCP client identifier */
106 struct dhcp_client_id {
107         /** Link-layer protocol */
108         uint8_t ll_proto;
109         /** Link-layer address */
110         uint8_t ll_addr[MAX_LL_ADDR_LEN];
111 } __attribute__ (( packed ));
112
113 /** DHCP client UUID */
114 struct dhcp_client_uuid {
115         /** Identifier type */
116         uint8_t type;
117         /** UUID */
118         union uuid uuid;
119 } __attribute__ (( packed ));
120
121 #define DHCP_CLIENT_UUID_TYPE 0
122
123 /**
124  * Name a DHCP packet type
125  *
126  * @v msgtype           DHCP message type
127  * @ret string          DHCP mesasge type name
128  */
129 static inline const char * dhcp_msgtype_name ( unsigned int msgtype ) {
130         switch ( msgtype ) {
131         case 0:                 return "BOOTP"; /* Non-DHCP packet */
132         case DHCPDISCOVER:      return "DHCPDISCOVER";
133         case DHCPOFFER:         return "DHCPOFFER";
134         case DHCPREQUEST:       return "DHCPREQUEST";
135         case DHCPDECLINE:       return "DHCPDECLINE";
136         case DHCPACK:           return "DHCPACK";
137         case DHCPNAK:           return "DHCPNAK";
138         case DHCPRELEASE:       return "DHCPRELEASE";
139         case DHCPINFORM:        return "DHCPINFORM";
140         default:                return "DHCP<invalid>";
141         }
142 }
143
144 /**
145  * Calculate DHCP transaction ID for a network device
146  *
147  * @v netdev            Network device
148  * @ret xid             DHCP XID
149  *
150  * Extract the least significant bits of the hardware address for use
151  * as the transaction ID.
152  */
153 static uint32_t dhcp_xid ( struct net_device *netdev ) {
154         uint32_t xid;
155
156         memcpy ( &xid, ( netdev->ll_addr + netdev->ll_protocol->ll_addr_len
157                          - sizeof ( xid ) ), sizeof ( xid ) );
158         return xid;
159 }
160
161 /****************************************************************************
162  *
163  * DHCP settings
164  *
165  */
166
167 /** A DHCP settings block */
168 struct dhcp_settings {
169         /** Reference counter */
170         struct refcnt refcnt;
171         /** DHCP packet */
172         struct dhcp_packet dhcppkt;
173         /** Setting interface */
174         struct settings settings;
175 };
176
177 /**
178  * Increment reference count on DHCP settings block
179  *
180  * @v dhcpset           DHCP settings block
181  * @ret dhcpset         DHCP settings block
182  */
183 static inline __attribute__ (( always_inline )) struct dhcp_settings *
184 dhcpset_get ( struct dhcp_settings *dhcpset ) {
185         ref_get ( &dhcpset->refcnt );
186         return dhcpset;
187 }
188
189 /**
190  * Decrement reference count on DHCP settings block
191  *
192  * @v dhcpset           DHCP settings block
193  */
194 static inline __attribute__ (( always_inline )) void
195 dhcpset_put ( struct dhcp_settings *dhcpset ) {
196         ref_put ( &dhcpset->refcnt );
197 }
198
199 /**
200  * Store value of DHCP setting
201  *
202  * @v settings          Settings block
203  * @v setting           Setting to store
204  * @v data              Setting data, or NULL to clear setting
205  * @v len               Length of setting data
206  * @ret rc              Return status code
207  */
208 static int dhcpset_store ( struct settings *settings, struct setting *setting,
209                            const void *data, size_t len ) {
210         struct dhcp_settings *dhcpset =
211                 container_of ( settings, struct dhcp_settings, settings );
212
213         return dhcppkt_store ( &dhcpset->dhcppkt, setting->tag, data, len );
214 }
215
216 /**
217  * Fetch value of setting
218  *
219  * @v settings          Settings block, or NULL to search all blocks
220  * @v setting           Setting to fetch
221  * @v data              Buffer to fill with setting data
222  * @v len               Length of buffer
223  * @ret len             Length of setting data, or negative error
224  */
225 static int dhcpset_fetch ( struct settings *settings, struct setting *setting,
226                            void *data, size_t len ) {
227         struct dhcp_settings *dhcpset =
228                 container_of ( settings, struct dhcp_settings, settings );
229
230         return dhcppkt_fetch ( &dhcpset->dhcppkt, setting->tag, data, len );
231 }
232
233 /** DHCP settings operations */
234 static struct settings_operations dhcpset_settings_operations = {
235         .store = dhcpset_store,
236         .fetch = dhcpset_fetch,
237 };
238
239 /**
240  * Create DHCP setting block
241  *
242  * @v dhcphdr           DHCP packet
243  * @v len               Length of DHCP packet
244  * @ret dhcpset         DHCP settings block
245  */
246 static struct dhcp_settings * dhcpset_create ( const struct dhcphdr *dhcphdr,
247                                                size_t len ) {
248         struct dhcp_settings *dhcpset;
249         void *data;
250
251         dhcpset = zalloc ( sizeof ( *dhcpset ) + len );
252         if ( dhcpset ) {
253                 data = ( ( ( void * ) dhcpset ) + sizeof ( *dhcpset ) );
254                 memcpy ( data, dhcphdr, len );
255                 dhcppkt_init ( &dhcpset->dhcppkt, data, len );
256                 settings_init ( &dhcpset->settings,
257                                 &dhcpset_settings_operations, &dhcpset->refcnt,
258                                 DHCP_SETTINGS_NAME );
259         }
260         return dhcpset;
261 }
262
263 /****************************************************************************
264  *
265  * DHCP session
266  *
267  */
268
269 /** DHCP session states */
270 enum dhcp_session_state {
271         /** Sending DHCPDISCOVERs, collecting DHCPOFFERs and ProxyDHCPOFFERs */
272         DHCP_STATE_DISCOVER = 0,
273         /** Sending DHCPREQUESTs, waiting for DHCPACK */
274         DHCP_STATE_REQUEST,
275         /** Sending ProxyDHCPREQUESTs, waiting for ProxyDHCPACK */
276         DHCP_STATE_PROXYREQUEST,
277 };
278
279 /**
280  * Name a DHCP session state
281  *
282  * @v state             DHCP session state
283  * @ret string          DHCP session state name
284  */
285 static inline const char * dhcp_state_name ( enum dhcp_session_state state ) {
286         switch ( state ) {
287         case DHCP_STATE_DISCOVER:       return "DHCPDISCOVER";
288         case DHCP_STATE_REQUEST:        return "DHCPREQUEST";
289         case DHCP_STATE_PROXYREQUEST:   return "ProxyDHCPREQUEST";
290         default:                        return "<invalid>";
291         }
292 }
293
294 /** A DHCP session */
295 struct dhcp_session {
296         /** Reference counter */
297         struct refcnt refcnt;
298         /** Job control interface */
299         struct job_interface job;
300         /** Data transfer interface */
301         struct xfer_interface xfer;
302
303         /** Network device being configured */
304         struct net_device *netdev;
305
306         /** State of the session
307          *
308          * This is a value for the @c DHCP_MESSAGE_TYPE option
309          * (e.g. @c DHCPDISCOVER).
310          */
311         enum dhcp_session_state state;
312         /** DHCPOFFER obtained during DHCPDISCOVER */
313         struct dhcp_settings *dhcpoffer;
314         /** ProxyDHCPOFFER obtained during DHCPDISCOVER */
315         struct dhcp_settings *proxydhcpoffer;
316         /** Retransmission timer */
317         struct retry_timer timer;
318         /** Start time of the current state (in ticks) */
319         unsigned long start;
320 };
321
322 /**
323  * Free DHCP session
324  *
325  * @v refcnt            Reference counter
326  */
327 static void dhcp_free ( struct refcnt *refcnt ) {
328         struct dhcp_session *dhcp =
329                 container_of ( refcnt, struct dhcp_session, refcnt );
330
331         netdev_put ( dhcp->netdev );
332         dhcpset_put ( dhcp->dhcpoffer );
333         dhcpset_put ( dhcp->proxydhcpoffer );
334         free ( dhcp );
335 }
336
337 /**
338  * Mark DHCP session as complete
339  *
340  * @v dhcp              DHCP session
341  * @v rc                Return status code
342  */
343 static void dhcp_finished ( struct dhcp_session *dhcp, int rc ) {
344
345         /* Block futher incoming messages */
346         job_nullify ( &dhcp->job );
347         xfer_nullify ( &dhcp->xfer );
348
349         /* Stop retry timer */
350         stop_timer ( &dhcp->timer );
351
352         /* Free resources and close interfaces */
353         xfer_close ( &dhcp->xfer, rc );
354         job_done ( &dhcp->job, rc );
355 }
356
357 /****************************************************************************
358  *
359  * Data transfer interface
360  *
361  */
362
363 /**
364  * Create a DHCP packet
365  *
366  * @v dhcppkt           DHCP packet structure to fill in
367  * @v netdev            Network device
368  * @v msgtype           DHCP message type
369  * @v options           Initial options to include (or NULL)
370  * @v data              Buffer for DHCP packet
371  * @v max_len           Size of DHCP packet buffer
372  * @ret rc              Return status code
373  *
374  * Creates a DHCP packet in the specified buffer, and fills out a @c
375  * dhcp_packet structure.
376  */
377 int dhcp_create_packet ( struct dhcp_packet *dhcppkt,
378                          struct net_device *netdev, uint8_t msgtype,
379                          struct dhcp_options *options, 
380                          void *data, size_t max_len ) {
381         struct dhcphdr *dhcphdr = data;
382         size_t options_len;
383         unsigned int hlen;
384         int rc;
385
386         /* Sanity check */
387         options_len = ( options ? options->len : 0 );
388         if ( max_len < ( sizeof ( *dhcphdr ) + options_len ) )
389                 return -ENOSPC;
390
391         /* Initialise DHCP packet content */
392         memset ( dhcphdr, 0, max_len );
393         dhcphdr->xid = dhcp_xid ( netdev );
394         dhcphdr->magic = htonl ( DHCP_MAGIC_COOKIE );
395         dhcphdr->htype = ntohs ( netdev->ll_protocol->ll_proto );
396         dhcphdr->op = dhcp_op[msgtype];
397         /* If hardware length exceeds the chaddr field length, don't
398          * use the chaddr field.  This is as per RFC4390.
399          */
400         hlen = netdev->ll_protocol->ll_addr_len;
401         if ( hlen > sizeof ( dhcphdr->chaddr ) ) {
402                 hlen = 0;
403                 dhcphdr->flags = htons ( BOOTP_FL_BROADCAST );
404         }
405         dhcphdr->hlen = hlen;
406         memcpy ( dhcphdr->chaddr, netdev->ll_addr, hlen );
407         memcpy ( dhcphdr->options, options->data, options_len );
408
409         /* Initialise DHCP packet structure */
410         memset ( dhcppkt, 0, sizeof ( *dhcppkt ) );
411         dhcppkt_init ( dhcppkt, data, max_len );
412         
413         /* Set DHCP_MESSAGE_TYPE option */
414         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_MESSAGE_TYPE,
415                                     &msgtype, sizeof ( msgtype ) ) ) != 0 )
416                 return rc;
417
418         return 0;
419 }
420
421 /**
422  * Create DHCP request packet
423  *
424  * @v dhcppkt           DHCP packet structure to fill in
425  * @v netdev            Network device
426  * @v ciaddr            Client IP address
427  * @v offer             DHCP offer, if applicable
428  * @v data              Buffer for DHCP packet
429  * @v max_len           Size of DHCP packet buffer
430  * @ret rc              Return status code
431  */
432 int dhcp_create_request ( struct dhcp_packet *dhcppkt,
433                           struct net_device *netdev, struct in_addr ciaddr,
434                           struct dhcp_packet *offer,
435                           void *data, size_t max_len ) {
436         struct device_description *desc = &netdev->dev->desc;
437         struct dhcp_netdev_desc dhcp_desc;
438         struct dhcp_client_id client_id;
439         struct dhcp_client_uuid client_uuid;
440         unsigned int msgtype;
441         size_t dhcp_features_len;
442         size_t ll_addr_len;
443         int rc;
444
445         /* Create DHCP packet */
446         msgtype = ( offer ? DHCPREQUEST : DHCPDISCOVER );
447         if ( ( rc = dhcp_create_packet ( dhcppkt, netdev, msgtype,
448                                          &dhcp_request_options, data,
449                                          max_len ) ) != 0 ) {
450                 DBG ( "DHCP could not create DHCP packet: %s\n",
451                       strerror ( rc ) );
452                 return rc;
453         }
454
455         /* Set client IP address */
456         dhcppkt->dhcphdr->ciaddr = ciaddr;
457
458         /* Copy any required options from previous server repsonse */
459         if ( offer ) {
460                 struct in_addr server = { 0 };
461                 struct in_addr *ip = &offer->dhcphdr->yiaddr;
462
463                 /* Copy server identifier, if present */
464                 if ( ( dhcppkt_fetch ( offer, DHCP_SERVER_IDENTIFIER, &server,
465                                        sizeof ( server ) ) >= 0 ) &&
466                      ( ( rc = dhcppkt_store ( dhcppkt, DHCP_SERVER_IDENTIFIER,
467                                               &server,
468                                               sizeof ( server ) ) ) != 0 ) ) {
469                         DBG ( "DHCP could not set server ID: %s\n",
470                               strerror ( rc ) );
471                         return rc;
472                 }
473
474                 /* Copy requested IP address, if present */
475                 if ( ( ip->s_addr != 0 ) &&
476                      ( ( rc = dhcppkt_store ( dhcppkt, DHCP_REQUESTED_ADDRESS,
477                                               ip, sizeof ( *ip ) ) ) != 0 ) ) {
478                         DBG ( "DHCP could not set requested address: %s\n",
479                               strerror ( rc ) );
480                         return rc;
481                 }
482         }
483
484         /* Add options to identify the feature list */
485         dhcp_features_len = ( dhcp_features_end - dhcp_features );
486         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_EB_ENCAP, dhcp_features,
487                                     dhcp_features_len ) ) != 0 ) {
488                 DBG ( "DHCP could not set features list option: %s\n",
489                       strerror ( rc ) );
490                 return rc;
491         }
492
493         /* Add options to identify the network device */
494         dhcp_desc.type = desc->bus_type;
495         dhcp_desc.vendor = htons ( desc->vendor );
496         dhcp_desc.device = htons ( desc->device );
497         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_EB_BUS_ID, &dhcp_desc,
498                                     sizeof ( dhcp_desc ) ) ) != 0 ) {
499                 DBG ( "DHCP could not set bus ID option: %s\n",
500                       strerror ( rc ) );
501                 return rc;
502         }
503
504         /* Add DHCP client identifier.  Required for Infiniband, and
505          * doesn't hurt other link layers.
506          */
507         client_id.ll_proto = ntohs ( netdev->ll_protocol->ll_proto );
508         ll_addr_len = netdev->ll_protocol->ll_addr_len;
509         assert ( ll_addr_len <= sizeof ( client_id.ll_addr ) );
510         memcpy ( client_id.ll_addr, netdev->ll_addr, ll_addr_len );
511         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_CLIENT_ID, &client_id,
512                                     ( ll_addr_len + 1 ) ) ) != 0 ) {
513                 DBG ( "DHCP could not set client ID: %s\n",
514                       strerror ( rc ) );
515                 return rc;
516         }
517
518         /* Add client UUID, if we have one.  Required for PXE. */
519         client_uuid.type = DHCP_CLIENT_UUID_TYPE;
520         if ( ( rc = get_uuid ( &client_uuid.uuid ) ) == 0 ) {
521                 if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_CLIENT_UUID,
522                                             &client_uuid,
523                                             sizeof ( client_uuid ) ) ) != 0 ) {
524                         DBG ( "DHCP could not set client UUID: %s\n",
525                               strerror ( rc ) );
526                         return rc;
527                 }
528         }
529
530         return 0;
531 }
532
533 /**
534  * Transmit DHCP request
535  *
536  * @v dhcp              DHCP session
537  * @ret rc              Return status code
538  */
539 static int dhcp_tx ( struct dhcp_session *dhcp ) {
540         static struct sockaddr_in proxydhcp_server = {
541                 .sin_family = AF_INET,
542                 .sin_port = htons ( PROXYDHCP_PORT ),
543         };
544         struct xfer_metadata meta = {
545                 .netdev = dhcp->netdev,
546         };
547         struct io_buffer *iobuf;
548         struct dhcp_packet dhcppkt;
549         struct dhcp_packet *offer = NULL;
550         struct in_addr ciaddr = { 0 };
551         int check_len;
552         int rc;
553
554         /* Start retry timer.  Do this first so that failures to
555          * transmit will be retried.
556          */
557         start_timer ( &dhcp->timer );
558
559         /* Determine packet contents based on current state */
560         switch ( dhcp->state ) {
561         case DHCP_STATE_DISCOVER:
562                 DBGC ( dhcp, "DHCP %p transmitting DHCPDISCOVER\n", dhcp );
563                 break;
564         case DHCP_STATE_REQUEST:
565                 DBGC ( dhcp, "DHCP %p transmitting DHCPREQUEST\n", dhcp );
566                 assert ( dhcp->dhcpoffer );
567                 offer = &dhcp->dhcpoffer->dhcppkt;
568                 break;
569         case DHCP_STATE_PROXYREQUEST:
570                 DBGC ( dhcp, "DHCP %p transmitting ProxyDHCPREQUEST\n", dhcp );
571                 assert ( dhcp->dhcpoffer );
572                 assert ( dhcp->proxydhcpoffer );
573                 offer = &dhcp->proxydhcpoffer->dhcppkt;
574                 ciaddr = dhcp->dhcpoffer->dhcppkt.dhcphdr->yiaddr;
575                 check_len = dhcppkt_fetch ( offer, DHCP_SERVER_IDENTIFIER,
576                                             &proxydhcp_server.sin_addr,
577                                             sizeof(proxydhcp_server.sin_addr));
578                 meta.dest = ( struct sockaddr * ) &proxydhcp_server;
579                 assert ( ciaddr.s_addr != 0 );
580                 assert ( proxydhcp_server.sin_addr.s_addr != 0 );
581                 assert ( check_len == sizeof ( proxydhcp_server.sin_addr ) );
582                 break;
583         default:
584                 assert ( 0 );
585                 break;
586         }
587
588         /* Allocate buffer for packet */
589         iobuf = xfer_alloc_iob ( &dhcp->xfer, DHCP_MIN_LEN );
590         if ( ! iobuf )
591                 return -ENOMEM;
592
593         /* Create DHCP packet in temporary buffer */
594         if ( ( rc = dhcp_create_request ( &dhcppkt, dhcp->netdev,
595                                           ciaddr, offer, iobuf->data,
596                                           iob_tailroom ( iobuf ) ) ) != 0 ) {
597                 DBGC ( dhcp, "DHCP %p could not construct DHCP request: %s\n",
598                        dhcp, strerror ( rc ) );
599                 goto done;
600         }
601
602         /* Transmit the packet */
603         iob_put ( iobuf, dhcppkt.len );
604         rc = xfer_deliver_iob_meta ( &dhcp->xfer, iobuf, &meta );
605         iobuf = NULL;
606         if ( rc != 0 ) {
607                 DBGC ( dhcp, "DHCP %p could not transmit UDP packet: %s\n",
608                        dhcp, strerror ( rc ) );
609                 goto done;
610         }
611
612  done:
613         free_iob ( iobuf );
614         return rc;
615 }
616
617 /**
618  * Transition to new DHCP session state
619  *
620  * @v dhcp              DHCP session
621  * @v state             New session state
622  */
623 static void dhcp_set_state ( struct dhcp_session *dhcp,
624                              enum dhcp_session_state state ) {
625         DBGC ( dhcp, "DHCP %p entering %s state\n",
626                dhcp, dhcp_state_name ( state ) );
627         dhcp->state = state;
628         dhcp->start = currticks();
629         start_timer_nodelay ( &dhcp->timer );
630 }
631
632 /**
633  * Store received DHCPOFFER
634  *
635  * @v dhcp              DHCP session
636  * @v dhcpoffer         Received DHCPOFFER
637  * @v stored_dhcpoffer  Location to store DHCPOFFER
638  *
639  * The DHCPOFFER will be stored in place of the existing stored
640  * DHCPOFFER if its priority is equal to or greater than the stored
641  * DHCPOFFER.
642  */
643 static void dhcp_store_dhcpoffer ( struct dhcp_session *dhcp,
644                                    struct dhcp_settings *dhcpoffer,
645                                    struct dhcp_settings **stored_dhcpoffer ) {
646         uint8_t stored_priority = 0;
647         uint8_t priority = 0;
648
649         /* Get priorities of the two DHCPOFFERs */
650         if ( *stored_dhcpoffer ) {
651                 dhcppkt_fetch ( &(*stored_dhcpoffer)->dhcppkt,
652                                 DHCP_EB_PRIORITY, &stored_priority,
653                                 sizeof ( stored_priority ) );
654         }
655         dhcppkt_fetch ( &dhcpoffer->dhcppkt, DHCP_EB_PRIORITY, &priority,
656                         sizeof ( priority ) );
657
658         /* Replace stored offer only if priority is equal or greater */
659         if ( priority >= stored_priority ) {
660                 if ( *stored_dhcpoffer ) {
661                         DBGC ( dhcp, "DHCP %p stored DHCPOFFER %p discarded\n",
662                                dhcp, *stored_dhcpoffer );
663                 }
664                 DBGC ( dhcp, "DHCP %p received DHCPOFFER %p stored\n",
665                        dhcp, dhcpoffer );
666                 dhcpset_put ( *stored_dhcpoffer );
667                 *stored_dhcpoffer = dhcpset_get ( dhcpoffer );
668         }
669 }
670
671 /**
672  * Handle received DHCPOFFER
673  *
674  * @v dhcp              DHCP session
675  * @v dhcpoffer         Received DHCPOFFER
676  */
677 static void dhcp_rx_dhcpoffer ( struct dhcp_session *dhcp,
678                                 struct dhcp_settings *dhcpoffer ) {
679         char vci[9]; /* "PXEClient" */
680         int len;
681         uint8_t ignore_proxy = 0;
682         unsigned long elapsed;
683
684         /* Check for presence of DHCP server ID */
685         if ( dhcppkt_fetch ( &dhcpoffer->dhcppkt, DHCP_SERVER_IDENTIFIER,
686                              NULL, 0 ) != sizeof ( struct in_addr ) ) {
687                 DBGC ( dhcp, "DHCP %p received DHCPOFFER %p missing server "
688                        "identifier\n", dhcp, dhcpoffer );
689                 return;
690         }
691
692         /* If there is an IP address, it's a normal DHCPOFFER */
693         if ( dhcpoffer->dhcppkt.dhcphdr->yiaddr.s_addr != 0 ) {
694                 DBGC ( dhcp, "DHCP %p received DHCPOFFER %p has IP address\n",
695                        dhcp, dhcpoffer );
696                 dhcp_store_dhcpoffer ( dhcp, dhcpoffer, &dhcp->dhcpoffer );
697         }
698
699         /* If there is a "PXEClient" vendor class ID, it's a
700          * ProxyDHCPOFFER.  Note that it could be both a normal
701          * DHCPOFFER and a ProxyDHCPOFFER.
702          */
703         len = dhcppkt_fetch ( &dhcpoffer->dhcppkt, DHCP_VENDOR_CLASS_ID,
704                               vci, sizeof ( vci ) );
705         if ( ( len >= ( int ) sizeof ( vci ) ) &&
706              ( strncmp ( "PXEClient", vci, sizeof ( vci ) ) == 0 ) ) {
707                 DBGC ( dhcp, "DHCP %p received DHCPOFFER %p is a "
708                        "ProxyDHCPOFFER\n", dhcp, dhcpoffer );
709                 dhcp_store_dhcpoffer ( dhcp, dhcpoffer,
710                                        &dhcp->proxydhcpoffer );
711         }
712
713         /* We can transition to making the DHCPREQUEST when we have a
714          * valid DHCPOFFER, and either:
715          *
716          *  o  The DHCPOFFER instructs us to not wait for ProxyDHCP, or
717          *  o  We have a valid ProxyDHCPOFFER, or
718          *  o  We have allowed sufficient time for ProxyDHCPOFFERs.
719          */
720
721         /* If we don't yet have a DHCPOFFER, do nothing */
722         if ( ! dhcp->dhcpoffer )
723                 return;
724
725         /* If the DHCPOFFER instructs us to ignore ProxyDHCP, discard
726          * any ProxyDHCPOFFER
727          */
728         dhcppkt_fetch ( &dhcp->dhcpoffer->dhcppkt, DHCP_EB_NO_PROXYDHCP,
729                         &ignore_proxy, sizeof ( ignore_proxy ) );
730         if ( ignore_proxy && dhcp->proxydhcpoffer ) {
731                 DBGC ( dhcp, "DHCP %p discarding ProxyDHCPOFFER\n", dhcp );
732                 dhcpset_put ( dhcp->proxydhcpoffer );
733                 dhcp->proxydhcpoffer = NULL;
734         }
735
736         /* If we can't yet transition to DHCPREQUEST, do nothing */
737         elapsed = ( currticks() - dhcp->start );
738         if ( ! ( ignore_proxy || dhcp->proxydhcpoffer ||
739                  ( elapsed > PROXYDHCP_WAIT_TIME ) ) )
740                 return;
741
742         /* Transition to DHCPREQUEST */
743         dhcp_set_state ( dhcp, DHCP_STATE_REQUEST );
744 }
745
746 /**
747  * Store received DHCPACK
748  *
749  * @v dhcp              DHCP session
750  * @v dhcpack           Received DHCPACK
751  *
752  * The DHCPACK will be registered as a settings block.
753  */
754 static int dhcp_store_dhcpack ( struct dhcp_session *dhcp,
755                                 struct dhcp_settings *dhcpack,
756                                 struct settings *parent ) {
757         struct settings *settings = &dhcpack->settings;
758         struct settings *old_settings;
759         int rc;
760
761         /* Unregister any old settings obtained via DHCP */
762         if ( ( old_settings = find_child_settings ( parent, settings->name ) ))
763                 unregister_settings ( old_settings );
764
765         /* Register new settings */
766         if ( ( rc = register_settings ( settings, parent ) ) != 0 ) {
767                 DBGC ( dhcp, "DHCP %p could not register settings: %s\n",
768                        dhcp, strerror ( rc ) );
769                 dhcp_finished ( dhcp, rc ); /* This is a fatal error */
770                 return rc;
771         }
772
773         return 0;
774 }
775
776 /**
777  * Handle received DHCPACK
778  *
779  * @v dhcp              DHCP session
780  * @v dhcpack           Received DHCPACK
781  */
782 static void dhcp_rx_dhcpack ( struct dhcp_session *dhcp,
783                               struct dhcp_settings *dhcpack ) {
784         struct settings *parent;
785         struct in_addr offer_server_id = { 0 };
786         struct in_addr ack_server_id = { 0 };
787         int rc;
788
789         /* Verify server ID matches */
790         assert ( dhcp->dhcpoffer != NULL );
791         dhcppkt_fetch ( &dhcp->dhcpoffer->dhcppkt, DHCP_SERVER_IDENTIFIER,
792                         &offer_server_id, sizeof ( offer_server_id ) );
793         dhcppkt_fetch ( &dhcpack->dhcppkt, DHCP_SERVER_IDENTIFIER,
794                         &ack_server_id, sizeof ( ack_server_id ) );
795         if ( offer_server_id.s_addr != ack_server_id.s_addr ) {
796                 DBGC ( dhcp, "DHCP %p ignoring DHCPACK with wrong server ID\n",
797                        dhcp );
798                 return;
799         }
800
801         /* Register settings */
802         parent = netdev_settings ( dhcp->netdev );
803         if ( ( rc = dhcp_store_dhcpack ( dhcp, dhcpack, parent ) ) !=0 )
804                 return;
805
806         /* If we have a ProxyDHCPOFFER, transition to PROXYDHCPREQUEST */
807         if ( dhcp->proxydhcpoffer ) {
808                 dhcp_set_state ( dhcp, DHCP_STATE_PROXYREQUEST );
809                 return;
810         }
811
812         /* Terminate DHCP */
813         dhcp_finished ( dhcp, 0 );
814 }
815
816 /**
817  * Handle received ProxyDHCPACK
818  *
819  * @v dhcp              DHCP session
820  * @v proxydhcpack      Received ProxyDHCPACK
821  */
822 static void dhcp_rx_proxydhcpack ( struct dhcp_session *dhcp,
823                                    struct dhcp_settings *proxydhcpack ) {
824         int rc;
825
826         /* Rename settings */
827         proxydhcpack->settings.name = PROXYDHCP_SETTINGS_NAME;
828
829         /* Register settings */
830         if ( ( rc = dhcp_store_dhcpack ( dhcp, proxydhcpack, NULL ) ) != 0 )
831                 return;
832
833         /* Terminate DHCP */
834         dhcp_finished ( dhcp, 0 );
835 }
836
837 /**
838  * Receive new data
839  *
840  * @v xfer              Data transfer interface
841  * @v data              Received data
842  * @v len               Length of received data
843  * @ret rc              Return status code
844  */
845 static int dhcp_deliver_raw ( struct xfer_interface *xfer,
846                               const void *data, size_t len ) {
847         struct dhcp_session *dhcp =
848                 container_of ( xfer, struct dhcp_session, xfer );
849         struct dhcp_settings *dhcpset;
850         struct dhcphdr *dhcphdr;
851         uint8_t msgtype = 0;
852
853         /* Convert packet into a DHCP settings block */
854         dhcpset = dhcpset_create ( data, len );
855         if ( ! dhcpset ) {
856                 DBGC ( dhcp, "DHCP %p could not store DHCP packet\n", dhcp );
857                 return -ENOMEM;
858         }
859         dhcphdr = dhcpset->dhcppkt.dhcphdr;
860
861         /* Identify message type */
862         dhcppkt_fetch ( &dhcpset->dhcppkt, DHCP_MESSAGE_TYPE, &msgtype,
863                         sizeof ( msgtype ) );
864         DBGC ( dhcp, "DHCP %p received %s %p\n",
865                dhcp, dhcp_msgtype_name ( msgtype ), dhcpset );
866
867         /* Check for matching transaction ID */
868         if ( dhcphdr->xid != dhcp_xid ( dhcp->netdev ) ) {
869                 DBGC ( dhcp, "DHCP %p received %s %p has bad transaction ID\n",
870                        dhcp, dhcp_msgtype_name ( msgtype ), dhcpset );
871                 goto out;
872         };
873
874         /* Handle packet based on current state */
875         switch ( dhcp->state ) {
876         case DHCP_STATE_DISCOVER:
877                 if ( msgtype == DHCPOFFER )
878                         dhcp_rx_dhcpoffer ( dhcp, dhcpset );
879                 break;
880         case DHCP_STATE_REQUEST:
881                 if ( msgtype == DHCPACK )
882                         dhcp_rx_dhcpack ( dhcp, dhcpset );
883                 break;
884         case DHCP_STATE_PROXYREQUEST:
885                 if ( msgtype == DHCPACK )
886                         dhcp_rx_proxydhcpack ( dhcp, dhcpset );
887                 break;
888         default:
889                 assert ( 0 );
890                 break;
891         }
892
893  out:
894         dhcpset_put ( dhcpset );
895         return 0;
896 }
897
898 /** DHCP data transfer interface operations */
899 static struct xfer_interface_operations dhcp_xfer_operations = {
900         .close          = ignore_xfer_close,
901         .vredirect      = xfer_vopen,
902         .window         = unlimited_xfer_window,
903         .alloc_iob      = default_xfer_alloc_iob,
904         .deliver_iob    = xfer_deliver_as_raw,
905         .deliver_raw    = dhcp_deliver_raw,
906 };
907
908 /**
909  * Handle DHCP retry timer expiry
910  *
911  * @v timer             DHCP retry timer
912  * @v fail              Failure indicator
913  */
914 static void dhcp_timer_expired ( struct retry_timer *timer, int fail ) {
915         struct dhcp_session *dhcp =
916                 container_of ( timer, struct dhcp_session, timer );
917         unsigned long elapsed = ( currticks() - dhcp->start );
918
919         /* If we have failed, terminate DHCP */
920         if ( fail ) {
921                 dhcp_finished ( dhcp, -ETIMEDOUT );
922                 return;
923         }
924
925         /* Give up waiting for ProxyDHCP before we reach the failure point */
926         if ( elapsed > PROXYDHCP_WAIT_TIME ) {
927                 if ( dhcp->state == DHCP_STATE_DISCOVER ) {
928                         dhcp_set_state ( dhcp, DHCP_STATE_REQUEST );
929                         return;
930                 } else if ( dhcp->state == DHCP_STATE_PROXYREQUEST ) {
931                         dhcp_finished ( dhcp, 0 );
932                         return;
933                 }
934         }
935
936         /* Otherwise, retransmit current packet */
937         dhcp_tx ( dhcp );
938 }
939
940 /****************************************************************************
941  *
942  * Job control interface
943  *
944  */
945
946 /**
947  * Handle kill() event received via job control interface
948  *
949  * @v job               DHCP job control interface
950  */
951 static void dhcp_job_kill ( struct job_interface *job ) {
952         struct dhcp_session *dhcp =
953                 container_of ( job, struct dhcp_session, job );
954
955         /* Terminate DHCP session */
956         dhcp_finished ( dhcp, -ECANCELED );
957 }
958
959 /** DHCP job control interface operations */
960 static struct job_interface_operations dhcp_job_operations = {
961         .done           = ignore_job_done,
962         .kill           = dhcp_job_kill,
963         .progress       = ignore_job_progress,
964 };
965
966 /****************************************************************************
967  *
968  * Instantiator
969  *
970  */
971
972 /**
973  * Start DHCP on a network device
974  *
975  * @v job               Job control interface
976  * @v netdev            Network device
977  * @v register_options  DHCP option block registration routine
978  * @ret rc              Return status code
979  *
980  * Starts DHCP on the specified network device.  If successful, the @c
981  * register_options() routine will be called with the acquired
982  * options.
983  */
984 int start_dhcp ( struct job_interface *job, struct net_device *netdev ) {
985         static struct sockaddr_in server = {
986                 .sin_family = AF_INET,
987                 .sin_addr.s_addr = INADDR_BROADCAST,
988                 .sin_port = htons ( BOOTPS_PORT ),
989         };
990         static struct sockaddr_in client = {
991                 .sin_family = AF_INET,
992                 .sin_port = htons ( BOOTPC_PORT ),
993         };
994         struct dhcp_session *dhcp;
995         int rc;
996
997         /* Allocate and initialise structure */
998         dhcp = zalloc ( sizeof ( *dhcp ) );
999         if ( ! dhcp )
1000                 return -ENOMEM;
1001         dhcp->refcnt.free = dhcp_free;
1002         job_init ( &dhcp->job, &dhcp_job_operations, &dhcp->refcnt );
1003         xfer_init ( &dhcp->xfer, &dhcp_xfer_operations, &dhcp->refcnt );
1004         dhcp->netdev = netdev_get ( netdev );
1005         dhcp->timer.expired = dhcp_timer_expired;
1006         dhcp->start = currticks();
1007
1008         /* Instantiate child objects and attach to our interfaces */
1009         if ( ( rc = xfer_open_socket ( &dhcp->xfer, SOCK_DGRAM,
1010                                        ( struct sockaddr * ) &server,
1011                                        ( struct sockaddr * ) &client ) ) != 0 )
1012                 goto err;
1013
1014         /* Start timer to initiate initial DHCPREQUEST */
1015         start_timer_nodelay ( &dhcp->timer );
1016
1017         /* Attach parent interface, mortalise self, and return */
1018         job_plug_plug ( &dhcp->job, job );
1019         ref_put ( &dhcp->refcnt );
1020         return 0;
1021
1022  err:
1023         dhcp_finished ( dhcp, rc );
1024         ref_put ( &dhcp->refcnt );
1025         return rc;
1026 }