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