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