Kill off hotplug.h and just make net devices normal reference-counted
[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 <errno.h>
21 #include <assert.h>
22 #include <byteswap.h>
23 #include <gpxe/if_ether.h>
24 #include <gpxe/netdevice.h>
25 #include <gpxe/udp.h>
26 #include <gpxe/dhcp.h>
27
28 /** @file
29  *
30  * Dynamic Host Configuration Protocol
31  *
32  */
33
34 /** DHCP operation types
35  *
36  * This table maps from DHCP message types (i.e. values of the @c
37  * DHCP_MESSAGE_TYPE option) to values of the "op" field within a DHCP
38  * packet.
39  */
40 static const uint8_t dhcp_op[] = {
41         [DHCPDISCOVER]  = BOOTP_REQUEST,
42         [DHCPOFFER]     = BOOTP_REPLY,
43         [DHCPREQUEST]   = BOOTP_REQUEST,
44         [DHCPDECLINE]   = BOOTP_REQUEST,
45         [DHCPACK]       = BOOTP_REPLY,
46         [DHCPNAK]       = BOOTP_REPLY,
47         [DHCPRELEASE]   = BOOTP_REQUEST,
48         [DHCPINFORM]    = BOOTP_REQUEST,
49 };
50
51 /** Raw option data for options common to all DHCP requests */
52 static uint8_t dhcp_request_options_data[] = {
53         DHCP_MAX_MESSAGE_SIZE, DHCP_WORD ( ETH_MAX_MTU ),
54         DHCP_VENDOR_CLASS_ID,
55         DHCP_STRING (  'E', 't', 'h', 'e', 'r', 'b', 'o', 'o', 't' ),
56         DHCP_PARAMETER_REQUEST_LIST,
57         DHCP_OPTION ( DHCP_SUBNET_MASK, DHCP_ROUTERS, DHCP_DNS_SERVERS, DHCP_LOG_SERVERS,
58                       DHCP_HOST_NAME, DHCP_DOMAIN_NAME, DHCP_ROOT_PATH,
59                       DHCP_VENDOR_ENCAP, DHCP_TFTP_SERVER_NAME,
60                       DHCP_BOOTFILE_NAME, DHCP_EB_ENCAP,
61                       DHCP_ISCSI_INITIATOR_IQN ),
62         DHCP_END
63 };
64
65 /**
66  * Name a DHCP packet type
67  *
68  * @v msgtype           DHCP message type
69  * @ret string          DHCP mesasge type name
70  */
71 static inline const char * dhcp_msgtype_name ( unsigned int msgtype ) {
72         switch ( msgtype ) {
73         case 0:                 return "BOOTP"; /* Non-DHCP packet */
74         case DHCPDISCOVER:      return "DHCPDISCOVER";
75         case DHCPOFFER:         return "DHCPOFFER";
76         case DHCPREQUEST:       return "DHCPREQUEST";
77         case DHCPDECLINE:       return "DHCPDECLINE";
78         case DHCPACK:           return "DHCPACK";
79         case DHCPNAK:           return "DHCPNAK";
80         case DHCPRELEASE:       return "DHCPRELEASE";
81         case DHCPINFORM:        return "DHCPINFORM";
82         default:                return "DHCP<invalid>";
83         }
84 }
85
86 /**
87  * Calculate DHCP transaction ID for a network device
88  *
89  * @v netdev            Network device
90  * @ret xid             DHCP XID
91  *
92  * Extract the least significant bits of the hardware address for use
93  * as the transaction ID.
94  */
95 static uint32_t dhcp_xid ( struct net_device *netdev ) {
96         uint32_t xid;
97
98         memcpy ( &xid, ( netdev->ll_addr + netdev->ll_protocol->ll_addr_len
99                          - sizeof ( xid ) ), sizeof ( xid ) );
100         return xid;
101 }
102
103 /** Options common to all DHCP requests */
104 struct dhcp_option_block dhcp_request_options = {
105         .data = dhcp_request_options_data,
106         .max_len = sizeof ( dhcp_request_options_data ),
107         .len = sizeof ( dhcp_request_options_data ),
108 };
109
110 /**
111  * Set option within DHCP packet
112  *
113  * @v dhcppkt           DHCP packet
114  * @v tag               DHCP option tag
115  * @v data              New value for DHCP option
116  * @v len               Length of value, in bytes
117  * @ret rc              Return status code
118  *
119  * Sets the option within the first available options block within the
120  * DHCP packet.  Option blocks are tried in the order specified by @c
121  * dhcp_option_block_fill_order.
122  *
123  * The magic options @c DHCP_EB_YIADDR and @c DHCP_EB_SIADDR are
124  * intercepted and inserted into the appropriate fixed fields within
125  * the DHCP packet.  The option @c DHCP_OPTION_OVERLOAD is silently
126  * ignored, since our DHCP packet assembly method relies on always
127  * having option overloading in use.
128  */
129 static int set_dhcp_packet_option ( struct dhcp_packet *dhcppkt,
130                                     unsigned int tag, const void *data,
131                                     size_t len ) {
132         struct dhcphdr *dhcphdr = dhcppkt->dhcphdr;
133         struct dhcp_option_block *options = dhcppkt->options;
134         struct dhcp_option *option = NULL;
135
136         /* Special-case the magic options */
137         switch ( tag ) {
138         case DHCP_OPTION_OVERLOAD:
139                 /* Hard-coded in packets we create; always ignore */
140                 return 0;
141         case DHCP_EB_YIADDR:
142                 memcpy ( &dhcphdr->yiaddr, data, sizeof ( dhcphdr->yiaddr ) );
143                 return 0;
144         case DHCP_EB_SIADDR:
145                 memcpy ( &dhcphdr->siaddr, data, sizeof ( dhcphdr->siaddr ) );
146                 return 0;
147         case DHCP_MESSAGE_TYPE:
148         case DHCP_REQUESTED_ADDRESS:
149         case DHCP_PARAMETER_REQUEST_LIST:
150                 /* These options have to be within the main options
151                  * block.  This doesn't seem to be required by the
152                  * RFCs, but at least ISC dhcpd refuses to recognise
153                  * them otherwise.
154                  */
155                 options = &dhcppkt->options[OPTS_MAIN];
156                 break;
157         default:
158                 /* Continue processing as normal */
159                 break;
160         }
161                 
162         /* Set option in first available options block */
163         for ( ; options < &dhcppkt->options[NUM_OPT_BLOCKS] ; options++ ) {
164                 option = set_dhcp_option ( options, tag, data, len );
165                 if ( option )
166                         break;
167         }
168
169         /* Update DHCP packet length */
170         dhcppkt->len = ( offsetof ( typeof ( *dhcppkt->dhcphdr ), options )
171                          + dhcppkt->options[OPTS_MAIN].len );
172
173         return ( option ? 0 : -ENOSPC );
174 }
175
176 /**
177  * Copy option into DHCP packet
178  *
179  * @v dhcppkt           DHCP packet
180  * @v options           DHCP option block, or NULL
181  * @v tag               DHCP option tag to search for
182  * @v new_tag           DHCP option tag to use for copied option
183  * @ret rc              Return status code
184  *
185  * Copies a single option, if present, from the DHCP options block
186  * into a DHCP packet.  The tag for the option may be changed if
187  * desired; this is required by other parts of the DHCP code.
188  *
189  * @c options may specify a single options block, or be left as NULL
190  * in order to search for the option within all registered options
191  * blocks.
192  */
193 static int copy_dhcp_packet_option ( struct dhcp_packet *dhcppkt,
194                                      struct dhcp_option_block *options,
195                                      unsigned int tag, unsigned int new_tag ) {
196         struct dhcp_option *option;
197         int rc;
198
199         option = find_dhcp_option ( options, tag );
200         if ( option ) {
201                 if ( ( rc = set_dhcp_packet_option ( dhcppkt, new_tag,
202                                                      &option->data,
203                                                      option->len ) ) != 0 )
204                         return rc;
205         }
206         return 0;
207 }
208
209 /**
210  * Copy options into DHCP packet
211  *
212  * @v dhcppkt           DHCP packet
213  * @v options           DHCP option block, or NULL
214  * @v encapsulator      Encapsulating option, or zero
215  * @ret rc              Return status code
216  * 
217  * Copies options with the specified encapsulator from DHCP options
218  * blocks into a DHCP packet.  Most options are copied verbatim.
219  * Recognised encapsulated options fields are handled as such.
220  *
221  * @c options may specify a single options block, or be left as NULL
222  * in order to copy options from all registered options blocks.
223  */
224 static int copy_dhcp_packet_encap_options ( struct dhcp_packet *dhcppkt,
225                                             struct dhcp_option_block *options,
226                                             unsigned int encapsulator ) {
227         unsigned int subtag;
228         unsigned int tag;
229         int rc;
230
231         for ( subtag = DHCP_MIN_OPTION; subtag <= DHCP_MAX_OPTION; subtag++ ) {
232                 tag = DHCP_ENCAP_OPT ( encapsulator, subtag );
233                 switch ( tag ) {
234                 case DHCP_EB_ENCAP:
235                 case DHCP_VENDOR_ENCAP:
236                         /* Process encapsulated options field */
237                         if ( ( rc = copy_dhcp_packet_encap_options ( dhcppkt,
238                                                                      options,
239                                                                      tag)) !=0)
240                                 return rc;
241                         break;
242                 default:
243                         /* Copy option to reassembled packet */
244                         if ( ( rc = copy_dhcp_packet_option ( dhcppkt, options,
245                                                               tag, tag ) ) !=0)
246                                 return rc;
247                         break;
248                 };
249         }
250
251         return 0;
252 }
253
254 /**
255  * Copy options into DHCP packet
256  *
257  * @v dhcppkt           DHCP packet
258  * @v options           DHCP option block, or NULL
259  * @ret rc              Return status code
260  * 
261  * Copies options from DHCP options blocks into a DHCP packet.  Most
262  * options are copied verbatim.  Recognised encapsulated options
263  * fields are handled as such.
264  *
265  * @c options may specify a single options block, or be left as NULL
266  * in order to copy options from all registered options blocks.
267  */
268 int copy_dhcp_packet_options ( struct dhcp_packet *dhcppkt,
269                                struct dhcp_option_block *options ) {
270         return copy_dhcp_packet_encap_options ( dhcppkt, options, 0 );
271 }
272
273 /**
274  * Create a DHCP packet
275  *
276  * @v netdev            Network device
277  * @v msgtype           DHCP message type
278  * @v data              Buffer for DHCP packet
279  * @v max_len           Size of DHCP packet buffer
280  * @v dhcppkt           DHCP packet structure to fill in
281  * @ret rc              Return status code
282  *
283  * Creates a DHCP packet in the specified buffer, and fills out a @c
284  * dhcp_packet structure that can be passed to
285  * set_dhcp_packet_option() or copy_dhcp_packet_options().
286  */
287 int create_dhcp_packet ( struct net_device *netdev, uint8_t msgtype,
288                          void *data, size_t max_len,
289                          struct dhcp_packet *dhcppkt ) {
290         struct dhcphdr *dhcphdr = data;
291         static const uint8_t overloading = ( DHCP_OPTION_OVERLOAD_FILE |
292                                              DHCP_OPTION_OVERLOAD_SNAME );
293         int rc;
294
295         /* Sanity check */
296         if ( max_len < sizeof ( *dhcphdr ) )
297                 return -ENOSPC;
298
299         /* Initialise DHCP packet content */
300         memset ( dhcphdr, 0, max_len );
301         dhcphdr->xid = dhcp_xid ( netdev );
302         dhcphdr->magic = htonl ( DHCP_MAGIC_COOKIE );
303         dhcphdr->htype = ntohs ( netdev->ll_protocol->ll_proto );
304         dhcphdr->hlen = netdev->ll_protocol->ll_addr_len;
305         memcpy ( dhcphdr->chaddr, netdev->ll_addr, dhcphdr->hlen );
306         dhcphdr->op = dhcp_op[msgtype];
307
308         /* Initialise DHCP packet structure */
309         dhcppkt->dhcphdr = dhcphdr;
310         dhcppkt->max_len = max_len;
311         init_dhcp_options ( &dhcppkt->options[OPTS_MAIN], dhcphdr->options,
312                             ( max_len -
313                               offsetof ( typeof ( *dhcphdr ), options ) ) );
314         init_dhcp_options ( &dhcppkt->options[OPTS_FILE], dhcphdr->file,
315                             sizeof ( dhcphdr->file ) );
316         init_dhcp_options ( &dhcppkt->options[OPTS_SNAME], dhcphdr->sname,
317                             sizeof ( dhcphdr->sname ) );
318         
319         /* Set DHCP_OPTION_OVERLOAD option within the main options block */
320         if ( set_dhcp_option ( &dhcppkt->options[OPTS_MAIN],
321                                DHCP_OPTION_OVERLOAD, &overloading,
322                                sizeof ( overloading ) ) == NULL )
323                 return -ENOSPC;
324
325         /* Set DHCP_MESSAGE_TYPE option */
326         if ( ( rc = set_dhcp_packet_option ( dhcppkt, DHCP_MESSAGE_TYPE,
327                                              &msgtype,
328                                              sizeof ( msgtype ) ) ) != 0 )
329                 return rc;
330
331         return 0;
332 }
333
334 /**
335  * Calculate used length of a field containing DHCP options
336  *
337  * @v data              Field containing DHCP options
338  * @v max_len           Field length
339  * @ret len             Used length (excluding the @c DHCP_END tag)
340  */
341 static size_t dhcp_field_len ( const void *data, size_t max_len ) {
342         struct dhcp_option_block options;
343         struct dhcp_option *end;
344
345         options.data = ( ( void * ) data );
346         options.len = max_len;
347         end = find_dhcp_option ( &options, DHCP_END );
348         return ( end ? ( ( ( void * ) end ) - data ) : 0 );
349 }
350
351 /**
352  * Merge field containing DHCP options or string into DHCP options block
353  *
354  * @v options           DHCP option block
355  * @v data              Field containing DHCP options
356  * @v max_len           Field length
357  * @v tag               DHCP option tag, or 0
358  *
359  * If @c tag is non-zero, the field will be treated as a
360  * NUL-terminated string representing the value of the specified DHCP
361  * option.  If @c tag is zero, the field will be treated as a block of
362  * DHCP options, and simply appended to the existing options in the
363  * option block.
364  *
365  * The caller must ensure that there is enough space in the options
366  * block to perform the merge.
367  */
368 static void merge_dhcp_field ( struct dhcp_option_block *options,
369                                const void *data, size_t max_len,
370                                unsigned int tag ) {
371         size_t len;
372         void *dest;
373         struct dhcp_option *end;
374
375         if ( tag ) {
376                 set_dhcp_option ( options, tag, data, strlen ( data ) );
377         } else {
378                 len = dhcp_field_len ( data, max_len );
379                 dest = ( options->data + options->len - 1 );
380                 memcpy ( dest, data, len );
381                 options->len += len;
382                 end = ( dest + len );
383                 end->tag = DHCP_END;
384         }
385 }
386
387 /**
388  * Parse DHCP packet and construct DHCP options block
389  *
390  * @v dhcp              DHCP session
391  * @v dhcphdr           DHCP packet
392  * @v len               Length of DHCP packet
393  * @ret options         DHCP options block, or NULL
394  *
395  * Parses a received DHCP packet and canonicalises its contents into a
396  * single DHCP options block.  The "file" and "sname" fields are
397  * converted into the corresponding DHCP options (@c
398  * DHCP_BOOTFILE_NAME and @c DHCP_TFTP_SERVER_NAME respectively).  If
399  * these fields are used for option overloading, their options are
400  * merged in to the options block.
401  *
402  * The values of the "yiaddr" and "siaddr" fields will be stored
403  * within the options block as the magic options @c DHCP_EB_YIADDR and
404  * @c DHCP_EB_SIADDR.
405  * 
406  * Note that this call allocates new memory for the constructed DHCP
407  * options block; it is the responsibility of the caller to eventually
408  * free this memory.
409  */
410 static struct dhcp_option_block * dhcp_parse ( struct dhcp_session *dhcp,
411                                                struct dhcphdr *dhcphdr,
412                                                size_t len ) {
413         struct dhcp_option_block *options;
414         size_t options_len;
415         unsigned int overloading;
416
417         /* Sanity check */
418         if ( len < sizeof ( *dhcphdr ) )
419                 return NULL;
420
421         /* Calculate size of resulting concatenated option block:
422          *
423          *   The "options" field : length of the field minus the DHCP_END tag.
424          *
425          *   The "file" field : maximum length of the field minus the
426          *   NUL terminator, plus a 2-byte DHCP header or, if used for
427          *   option overloading, the length of the field minus the
428          *   DHCP_END tag.
429          *
430          *   The "sname" field : as for the "file" field.
431          *
432          *   15 bytes for an encapsulated options field to contain the
433          *   value of the "yiaddr" and "siaddr" fields
434          *
435          *   1 byte for a final terminating DHCP_END tag.
436          */
437         options_len = ( ( len - offsetof ( typeof ( *dhcphdr ), options ) ) - 1
438                         + ( sizeof ( dhcphdr->file ) + 1 )
439                         + ( sizeof ( dhcphdr->sname ) + 1 )
440                         + 15 /* yiaddr and siaddr */
441                         + 1 /* DHCP_END tag */ );
442         
443         /* Allocate empty options block of required size */
444         options = alloc_dhcp_options ( options_len );
445         if ( ! options ) {
446                 DBGC ( dhcp, "DHCP %p could not allocate %d-byte option "
447                        "block\n", dhcp, options_len );
448                 return NULL;
449         }
450         
451         /* Merge in "options" field, if this is a DHCP packet */
452         if ( dhcphdr->magic == htonl ( DHCP_MAGIC_COOKIE ) ) {
453                 merge_dhcp_field ( options, dhcphdr->options,
454                                    ( len -
455                                      offsetof ( typeof (*dhcphdr), options ) ),
456                                    0 /* Always contains options */ );
457         }
458
459         /* Identify overloaded fields */
460         overloading = find_dhcp_num_option ( options, DHCP_OPTION_OVERLOAD );
461         
462         /* Merge in "file" and "sname" fields */
463         merge_dhcp_field ( options, dhcphdr->file, sizeof ( dhcphdr->file ),
464                            ( ( overloading & DHCP_OPTION_OVERLOAD_FILE ) ?
465                              0 : DHCP_BOOTFILE_NAME ) );
466         merge_dhcp_field ( options, dhcphdr->sname, sizeof ( dhcphdr->sname ),
467                            ( ( overloading & DHCP_OPTION_OVERLOAD_SNAME ) ?
468                              0 : DHCP_TFTP_SERVER_NAME ) );
469
470         /* Set magic options for "yiaddr" and "siaddr", if present */
471         if ( dhcphdr->yiaddr.s_addr ) {
472                 set_dhcp_option ( options, DHCP_EB_YIADDR,
473                                   &dhcphdr->yiaddr, sizeof (dhcphdr->yiaddr) );
474         }
475         if ( dhcphdr->siaddr.s_addr ) {
476                 set_dhcp_option ( options, DHCP_EB_SIADDR,
477                                   &dhcphdr->siaddr, sizeof (dhcphdr->siaddr) );
478         }
479         
480         assert ( options->len <= options->max_len );
481
482         return options;
483 }
484
485 /****************************************************************************
486  *
487  * DHCP to UDP interface
488  *
489  */
490
491 static inline struct dhcp_session *
492 udp_to_dhcp ( struct udp_connection *conn ) {
493         return container_of ( conn, struct dhcp_session, udp );
494 }
495
496 #if 0
497
498 /**
499  * Mark DHCP session as complete
500  *
501  * @v dhcp              DHCP session
502  * @v rc                Return status code
503  */
504 static void dhcp_done ( struct dhcp_session *dhcp, int rc ) {
505
506         /* Free up options if we failed */
507         if ( rc != 0 ) {
508                 if ( dhcp->options ) {
509                         free_dhcp_options ( dhcp->options );
510                         dhcp->options = NULL;
511                 }
512         }
513
514         /* Stop retry timer */
515         stop_timer ( &dhcp->timer );
516
517         /* Close UDP connection */
518         udp_close ( &dhcp->udp );
519
520         /* Mark async operation as complete */
521         async_done ( &dhcp->async, rc );
522 }
523
524 /** Address for transmitting DHCP requests */
525 static union {
526         struct sockaddr_tcpip st;
527         struct sockaddr_in sin;
528 } sa_dhcp_server = {
529         .sin = {
530                 .sin_family = AF_INET,
531                 .sin_addr.s_addr = INADDR_BROADCAST,
532                 .sin_port = htons ( BOOTPS_PORT ),
533         },
534 };
535
536 /**
537  * Transmit DHCP request
538  *
539  * @v conn              UDP connection
540  * @v buf               Temporary data buffer
541  * @v len               Length of temporary data buffer
542  * @ret rc              Return status code
543  */
544 static int dhcp_senddata ( struct udp_connection *conn,
545                            void *buf, size_t len ) {
546         struct dhcp_session *dhcp = udp_to_dhcp ( conn );
547         struct dhcp_packet dhcppkt;
548         int rc;
549         
550         DBGC ( dhcp, "DHCP %p transmitting %s\n",
551                dhcp, dhcp_msgtype_name ( dhcp->state ) );
552
553         assert ( ( dhcp->state == DHCPDISCOVER ) ||
554                  ( dhcp->state == DHCPREQUEST ) );
555
556         /* Create DHCP packet in temporary buffer */
557         if ( ( rc = create_dhcp_packet ( dhcp->netdev, dhcp->state, buf, len,
558                                          &dhcppkt ) ) != 0 ) {
559                 DBGC ( dhcp, "DHCP %p could not create DHCP packet: %s\n",
560                        dhcp, strerror ( rc ) );
561                 return rc;
562         }
563
564         /* Copy in options common to all requests */
565         if ( ( rc = copy_dhcp_packet_options ( &dhcppkt,
566                                                &dhcp_request_options ) ) != 0){
567                 DBGC ( dhcp, "DHCP %p could not set common DHCP options: %s\n",
568                        dhcp, strerror ( rc ) );
569                 return rc;
570         }
571
572         /* Copy any required options from previous server repsonse */
573         if ( dhcp->options ) {
574                 if ( ( rc = copy_dhcp_packet_option ( &dhcppkt, dhcp->options,
575                                             DHCP_SERVER_IDENTIFIER,
576                                             DHCP_SERVER_IDENTIFIER ) ) != 0 ) {
577                         DBGC ( dhcp, "DHCP %p could not set server identifier "
578                                "option: %s\n", dhcp, strerror ( rc ) );
579                         return rc;
580                 }
581                 if ( ( rc = copy_dhcp_packet_option ( &dhcppkt, dhcp->options,
582                                             DHCP_EB_YIADDR,
583                                             DHCP_REQUESTED_ADDRESS ) ) != 0 ) {
584                         DBGC ( dhcp, "DHCP %p could not set requested address "
585                                "option: %s\n", dhcp, strerror ( rc ) );
586                         return rc;
587                 }
588         }
589
590         /* Transmit the packet */
591         if ( ( rc = udp_sendto_via ( conn, &sa_dhcp_server.st, dhcp->netdev,
592                                      dhcppkt.dhcphdr, dhcppkt.len ) ) != 0 ) {
593                 DBGC ( dhcp, "DHCP %p could not transmit UDP packet: %s\n",
594                        dhcp, strerror ( rc ) );
595                 return rc;
596         }
597
598         return 0;
599 }
600
601 /**
602  * Transmit DHCP request
603  *
604  * @v dhcp              DHCP session
605  */
606 static void dhcp_send_request ( struct dhcp_session *dhcp ) {
607         start_timer ( &dhcp->timer );
608         udp_senddata ( &dhcp->udp );
609 }
610
611 /**
612  * Handle DHCP retry timer expiry
613  *
614  * @v timer             DHCP retry timer
615  * @v fail              Failure indicator
616  */
617 static void dhcp_timer_expired ( struct retry_timer *timer, int fail ) {
618         struct dhcp_session *dhcp =
619                 container_of ( timer, struct dhcp_session, timer );
620
621         if ( fail ) {
622                 dhcp_done ( dhcp, -ETIMEDOUT );
623         } else {
624                 dhcp_send_request ( dhcp );
625         }
626 }
627
628 /**
629  * Receive new data
630  *
631  * @v udp               UDP connection
632  * @v data              Received data
633  * @v len               Length of received data
634  * @v st_src            Partially-filled source address
635  * @v st_dest           Partially-filled destination address
636  */
637 static int dhcp_newdata ( struct udp_connection *conn, void *data, size_t len,
638                           struct sockaddr_tcpip *st_src __unused,
639                           struct sockaddr_tcpip *st_dest __unused ) {
640         struct dhcp_session *dhcp = udp_to_dhcp ( conn );
641         struct dhcphdr *dhcphdr = data;
642         struct dhcp_option_block *options;
643         unsigned int msgtype;
644
645         /* Check for matching transaction ID */
646         if ( dhcphdr->xid != dhcp_xid ( dhcp->netdev ) ) {
647                 DBGC ( dhcp, "DHCP %p wrong transaction ID (wanted %08lx, "
648                         "got %08lx)\n", dhcp, ntohl ( dhcphdr->xid ),
649                         ntohl ( dhcp_xid ( dhcp->netdev ) ) );
650                 return 0;
651         };
652
653         /* Parse packet and create options structure */
654         options = dhcp_parse ( dhcp, dhcphdr, len );
655         if ( ! options ) {
656                 DBGC ( dhcp, "DHCP %p could not parse DHCP packet\n", dhcp );
657                 return -EINVAL;
658         }
659
660         /* Determine message type */
661         msgtype = find_dhcp_num_option ( options, DHCP_MESSAGE_TYPE );
662         DBGC ( dhcp, "DHCP %p received %s\n",
663                dhcp, dhcp_msgtype_name ( msgtype ) );
664
665         /* Handle DHCP reply */
666         switch ( dhcp->state ) {
667         case DHCPDISCOVER:
668                 if ( msgtype != DHCPOFFER )
669                         goto out_discard;
670                 dhcp->state = DHCPREQUEST;
671                 break;
672         case DHCPREQUEST:
673                 if ( msgtype != DHCPACK )
674                         goto out_discard;
675                 dhcp->state = DHCPACK;
676                 break;
677         default:
678                 assert ( 0 );
679                 goto out_discard;
680         }
681
682         /* Stop timer and update stored options */
683         stop_timer ( &dhcp->timer );
684         if ( dhcp->options )
685                 free_dhcp_options ( dhcp->options );
686         dhcp->options = options;
687
688         /* Transmit next packet, or terminate session */
689         if ( dhcp->state < DHCPACK ) {
690                 dhcp_send_request ( dhcp );
691         } else {
692                 dhcp_done ( dhcp, 0 );
693         }
694         return 0;
695
696  out_discard:
697         free_dhcp_options ( options );
698         return 0;
699 }
700
701 /** DHCP UDP operations */
702 static struct udp_operations dhcp_udp_operations = {
703         .senddata       = dhcp_senddata,
704         .newdata        = dhcp_newdata,
705 };
706
707 /**
708  * Initiate DHCP on a network interface
709  *
710  * @v dhcp              DHCP session
711  * @v parent            Parent asynchronous operation
712  * @ret rc              Return status code
713  *
714  * If the DHCP operation completes successfully, the
715  * dhcp_session::options field will be filled in with the resulting
716  * options block.  The caller takes responsibility for eventually
717  * calling free_dhcp_options().
718  */
719 int start_dhcp ( struct dhcp_session *dhcp, struct async *parent ) {
720         int rc;
721
722         /* Initialise DHCP session */
723         dhcp->udp.udp_op = &dhcp_udp_operations;
724         dhcp->timer.expired = dhcp_timer_expired;
725         dhcp->state = DHCPDISCOVER;
726
727         /* Bind to local port */
728         if ( ( rc = udp_open ( &dhcp->udp, htons ( BOOTPC_PORT ) ) ) != 0 )
729                 return rc;
730
731         /* Proof of concept: just send a single DHCPDISCOVER */
732         dhcp_send_request ( dhcp );
733
734         async_init ( &dhcp->async, &default_async_operations, parent );
735         return 0;
736 }
737
738
739 #endif