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