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