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