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