Added some debug messages and DHCP test code
[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_END
59 };
60
61 /**
62  * Name a DHCP packet type
63  *
64  * @v msgtype           DHCP message type
65  * @ret string          DHCP mesasge type name
66  */
67 static inline const char * dhcp_message_type_name ( unsigned int msgtype ) {
68         switch ( msgtype ) {
69         case DHCPDISCOVER:      return "DHCPDISCOVER";
70         case DHCPOFFER:         return "DHCPOFFER";
71         case DHCPREQUEST:       return "DHCPREQUEST";
72         case DHCPDECLINE:       return "DHCPDECLINE";
73         case DHCPACK:           return "DHCPACK";
74         case DHCPNAK:           return "DHCPNAK";
75         case DHCPRELEASE:       return "DHCPRELEASE";
76         case DHCPINFORM:        return "DHCPINFORM";
77         default:                return "DHCP<invalid>";
78         }
79 }
80
81 /** Options common to all DHCP requests */
82 static struct dhcp_option_block dhcp_request_options = {
83         .data = dhcp_request_options_data,
84         .max_len = sizeof ( dhcp_request_options_data ),
85         .len = sizeof ( dhcp_request_options_data ),
86 };
87
88 /**
89  * Set option within DHCP packet
90  *
91  * @v dhcppkt           DHCP packet
92  * @v tag               DHCP option tag
93  * @v data              New value for DHCP option
94  * @v len               Length of value, in bytes
95  * @ret rc              Return status code
96  *
97  * Sets the option within the first available options block within the
98  * DHCP packet.  Option blocks are tried in the order specified by @c
99  * dhcp_option_block_fill_order.
100  *
101  * The magic options @c DHCP_EB_YIADDR and @c DHCP_EB_SIADDR are
102  * intercepted and inserted into the appropriate fixed fields within
103  * the DHCP packet.  The option @c DHCP_OPTION_OVERLOAD is silently
104  * ignored, since our DHCP packet assembly method relies on always
105  * having option overloading in use.
106  */
107 static int set_dhcp_packet_option ( struct dhcp_packet *dhcppkt,
108                                     unsigned int tag, const void *data,
109                                     size_t len ) {
110         struct dhcphdr *dhcphdr = dhcppkt->dhcphdr;
111         struct dhcp_option_block *options;
112         struct dhcp_option *option = NULL;
113
114         /* Special-case the magic options */
115         switch ( tag ) {
116         case DHCP_OPTION_OVERLOAD:
117                 /* Hard-coded in packets we create; always ignore */
118                 return 0;
119         case DHCP_EB_YIADDR:
120                 memcpy ( &dhcphdr->yiaddr, data, sizeof ( dhcphdr->yiaddr ) );
121                 return 0;
122         case DHCP_EB_SIADDR:
123                 memcpy ( &dhcphdr->siaddr, data, sizeof ( dhcphdr->siaddr ) );
124                 return 0;
125         default:
126                 /* Continue processing as normal */
127                 break;
128         }
129                 
130         /* Set option in first available options block */
131         for ( options = dhcppkt->options ;
132               options < &dhcppkt->options[NUM_OPT_BLOCKS] ; options++ ) {
133                 option = set_dhcp_option ( options, tag, data, len );
134                 if ( option )
135                         break;
136         }
137
138         /* Update DHCP packet length */
139         dhcppkt->len = ( offsetof ( typeof ( *dhcppkt->dhcphdr ), options )
140                          + dhcppkt->options[OPTS_MAIN].len );
141
142         return ( option ? 0 : -ENOSPC );
143 }
144
145 /**
146  * Set options within DHCP packet
147  *
148  * @v dhcppkt           DHCP packet
149  * @v options           DHCP option block, or NULL
150  * @v encapsulator      Encapsulating option, or zero
151  * @ret rc              Return status code
152  * 
153  * Copies options with the specified encapsulator from DHCP options
154  * blocks into a DHCP packet.  Most options are copied verbatim.
155  * Recognised encapsulated options fields are handled as such.
156  *
157  * @c options may specify a single options block, or be left as NULL
158  * in order to copy options from all registered options blocks.
159  */
160 static int set_dhcp_packet_encap_options ( struct dhcp_packet *dhcppkt,
161                                            struct dhcp_option_block *options,
162                                            unsigned int encapsulator ) {
163         unsigned int subtag;
164         unsigned int tag;
165         struct dhcp_option *option;
166         int rc;
167
168         for ( subtag = DHCP_MIN_OPTION; subtag <= DHCP_MAX_OPTION; subtag++ ) {
169                 tag = DHCP_ENCAP_OPT ( encapsulator, subtag );
170                 switch ( tag ) {
171                 case DHCP_EB_ENCAP:
172                 case DHCP_VENDOR_ENCAP:
173                         /* Process encapsulated options field */
174                         if ( ( rc = set_dhcp_packet_encap_options ( dhcppkt,
175                                                                     options,
176                                                                     tag )) !=0)
177                                 return rc;
178                         break;
179                 default:
180                         /* Copy option to reassembled packet */
181                         option = find_dhcp_option ( options, tag );
182                         if ( ! option )
183                                 break;
184                         if ( ( rc = set_dhcp_packet_option ( dhcppkt, tag,
185                                                              &option->data,
186                                                              option->len)) !=0)
187                                 return rc;
188                         break;
189                 };
190         }
191
192         return 0;
193 }
194
195 /**
196  * Set options within DHCP packet
197  *
198  * @v dhcppkt           DHCP packet
199  * @v options           DHCP option block, or NULL
200  * @ret rc              Return status code
201  * 
202  * Copies options from DHCP options blocks into a DHCP packet.  Most
203  * options are copied verbatim.  Recognised encapsulated options
204  * fields are handled as such.
205  *
206  * @c options may specify a single options block, or be left as NULL
207  * in order to copy options from all registered options blocks.
208  */
209 static int set_dhcp_packet_options ( struct dhcp_packet *dhcppkt,
210                                      struct dhcp_option_block *options ) {
211         return set_dhcp_packet_encap_options ( dhcppkt, options, 0 );
212 }
213
214 /**
215  * Create a DHCP packet
216  *
217  * @v dhcp              DHCP session
218  * @v msgtype           DHCP message type
219  * @v data              Buffer for DHCP packet
220  * @v max_len           Size of DHCP packet buffer
221  * @v dhcppkt           DHCP packet structure to fill in
222  * @ret rc              Return status code
223  *
224  * Creates a DHCP packet in the specified buffer, and fills out a @c
225  * dhcp_packet structure that can be passed to
226  * set_dhcp_packet_option() or set_dhcp_packet_options().
227  */
228 static int create_dhcp_packet ( struct dhcp_session *dhcp, uint8_t msgtype,
229                                 void *data, size_t max_len,
230                                 struct dhcp_packet *dhcppkt ) {
231         struct dhcphdr *dhcphdr = data;
232         static const uint8_t overloading = ( DHCP_OPTION_OVERLOAD_FILE |
233                                              DHCP_OPTION_OVERLOAD_SNAME );
234
235         /* Initialise DHCP packet structure */
236         dhcppkt->dhcphdr = dhcphdr;
237         dhcppkt->max_len = max_len;
238         init_dhcp_options ( &dhcppkt->options[OPTS_MAIN], dhcphdr->options,
239                             ( max_len -
240                               offsetof ( typeof ( *dhcphdr ), options ) ) );
241         init_dhcp_options ( &dhcppkt->options[OPTS_FILE], dhcphdr->file,
242                             sizeof ( dhcphdr->file ) );
243         init_dhcp_options ( &dhcppkt->options[OPTS_SNAME], dhcphdr->sname,
244                             sizeof ( dhcphdr->sname ) );
245         
246         /* Initialise DHCP packet content */
247         memset ( dhcphdr, 0, max_len );
248         dhcphdr->xid = dhcp->xid;
249         dhcphdr->magic = htonl ( DHCP_MAGIC_COOKIE );
250         dhcphdr->htype = ntohs ( dhcp->netdev->ll_protocol->ll_proto );
251         dhcphdr->hlen = dhcp->netdev->ll_protocol->ll_addr_len;
252         memcpy ( dhcphdr->chaddr, dhcp->netdev->ll_addr, dhcphdr->hlen );
253         dhcphdr->op = dhcp_op[msgtype];
254
255         /* Set DHCP_OPTION_OVERLOAD option within the main options block */
256         if ( ! set_dhcp_option ( &dhcppkt->options[OPTS_MAIN],
257                                  DHCP_OPTION_OVERLOAD, &overloading,
258                                  sizeof ( overloading ) ) )
259                 return -ENOSPC;
260
261         /* Set DHCP_MESSAGE_TYPE option */
262         if ( ! set_dhcp_packet_option ( dhcppkt, DHCP_MESSAGE_TYPE,
263                                         &msgtype, sizeof ( msgtype ) ) )
264                 return -ENOSPC;
265
266         return 0;
267 }
268
269 /**
270  * Calculate used length of a field containing DHCP options
271  *
272  * @v data              Field containing DHCP options
273  * @v max_len           Field length
274  * @ret len             Used length (excluding the @c DHCP_END tag)
275  */
276 static size_t dhcp_field_len ( const void *data, size_t max_len ) {
277         struct dhcp_option_block options;
278         struct dhcp_option *end;
279
280         options.data = ( ( void * ) data );
281         options.len = max_len;
282         end = find_dhcp_option ( &options, DHCP_END );
283         return ( end ? ( ( ( void * ) end ) - data ) : 0 );
284 }
285
286 /**
287  * Merge field containing DHCP options or string into DHCP options block
288  *
289  * @v options           DHCP option block
290  * @v data              Field containing DHCP options
291  * @v max_len           Field length
292  * @v tag               DHCP option tag, or 0
293  *
294  * If @c tag is non-zero, the field will be treated as a
295  * NUL-terminated string representing the value of the specified DHCP
296  * option.  If @c tag is zero, the field will be treated as a block of
297  * DHCP options, and simply appended to the existing options in the
298  * option block.
299  *
300  * The caller must ensure that there is enough space in the options
301  * block to perform the merge.
302  */
303 static void merge_dhcp_field ( struct dhcp_option_block *options,
304                                const void *data, size_t max_len,
305                                unsigned int tag ) {
306         size_t len;
307         void *dest;
308         struct dhcp_option *end;
309
310         if ( tag ) {
311                 set_dhcp_option ( options, tag, data, strlen ( data ) );
312         } else {
313                 len = dhcp_field_len ( data, max_len );
314                 dest = ( options->data + options->len - 1 );
315                 memcpy ( dest, data, len );
316                 options->len += len;
317                 end = ( dest + len );
318                 end->tag = DHCP_END;
319         }
320 }
321
322 /**
323  * Parse DHCP packet and construct DHCP options block
324  *
325  * @v dhcphdr           DHCP packet
326  * @v len               Length of DHCP packet
327  * @ret options         DHCP options block, or NULL
328  *
329  * Parses a received DHCP packet and canonicalises its contents into a
330  * single DHCP options block.  The "file" and "sname" fields are
331  * converted into the corresponding DHCP options (@c
332  * DHCP_BOOTFILE_NAME and @c DHCP_TFTP_SERVER_NAME respectively).  If
333  * these fields are used for option overloading, their options are
334  * merged in to the options block.
335  *
336  * The values of the "yiaddr" and "siaddr" fields will be stored
337  * within the options block as the magic options @c DHCP_EB_YIADDR and
338  * @c DHCP_EB_SIADDR.
339  * 
340  * Note that this call allocates new memory for the constructed DHCP
341  * options block; it is the responsibility of the caller to eventually
342  * free this memory.
343  */
344 static struct dhcp_option_block * dhcp_parse ( struct dhcphdr *dhcphdr,
345                                                size_t len ) {
346         struct dhcp_option_block *options;
347         size_t options_len;
348         unsigned int overloading;
349
350         /* Sanity check */
351         if ( len < sizeof ( *dhcphdr ) )
352                 return NULL;
353
354         /* Calculate size of resulting concatenated option block:
355          *
356          *   The "options" field : length of the field minus the DHCP_END tag.
357          *
358          *   The "file" field : maximum length of the field minus the
359          *   NUL terminator, plus a 2-byte DHCP header or, if used for
360          *   option overloading, the length of the field minus the
361          *   DHCP_END tag.
362          *
363          *   The "sname" field : as for the "file" field.
364          *
365          *   15 bytes for an encapsulated options field to contain the
366          *   value of the "yiaddr" and "siaddr" fields
367          *
368          *   1 byte for a final terminating DHCP_END tag.
369          */
370         options_len = ( ( len - offsetof ( typeof ( *dhcphdr ), options ) ) - 1
371                         + ( sizeof ( dhcphdr->file ) + 1 )
372                         + ( sizeof ( dhcphdr->sname ) + 1 )
373                         + 15 /* yiaddr and siaddr */
374                         + 1 /* DHCP_END tag */ );
375         
376         /* Allocate empty options block of required size */
377         options = alloc_dhcp_options ( options_len );
378         if ( ! options ) {
379                 DBG ( "DHCP could not allocate %d-byte option block\n",
380                       options_len );
381                 return NULL;
382         }
383         
384         /* Merge in "options" field, if this is a DHCP packet */
385         if ( dhcphdr->magic == htonl ( DHCP_MAGIC_COOKIE ) ) {
386                 merge_dhcp_field ( options, dhcphdr->options,
387                                    ( len -
388                                      offsetof ( typeof (*dhcphdr), options ) ),
389                                    0 /* Always contains options */ );
390         }
391
392         /* Identify overloaded fields */
393         overloading = find_dhcp_num_option ( options, DHCP_OPTION_OVERLOAD );
394         
395         /* Merge in "file" and "sname" fields */
396         merge_dhcp_field ( options, dhcphdr->file, sizeof ( dhcphdr->file ),
397                            ( ( overloading & DHCP_OPTION_OVERLOAD_FILE ) ?
398                              DHCP_BOOTFILE_NAME : 0 ) );
399         merge_dhcp_field ( options, dhcphdr->sname, sizeof ( dhcphdr->sname ),
400                            ( ( overloading & DHCP_OPTION_OVERLOAD_SNAME ) ?
401                              DHCP_TFTP_SERVER_NAME : 0 ) );
402
403         /* Set magic options for "yiaddr" and "siaddr", if present */
404         if ( dhcphdr->yiaddr.s_addr ) {
405                 set_dhcp_option ( options, DHCP_EB_YIADDR,
406                                   &dhcphdr->yiaddr, sizeof (dhcphdr->yiaddr) );
407         }
408         if ( dhcphdr->siaddr.s_addr ) {
409                 set_dhcp_option ( options, DHCP_EB_SIADDR,
410                                   &dhcphdr->siaddr, sizeof (dhcphdr->siaddr) );
411         }
412         
413         assert ( options->len <= options->max_len );
414
415         return options;
416 }
417
418 /****************************************************************************
419  *
420  * DHCP to UDP interface
421  *
422  */
423
424 static inline struct dhcp_session *
425 udp_to_dhcp ( struct udp_connection *conn ) {
426         return container_of ( conn, struct dhcp_session, udp );
427 }
428
429 /**
430  * Transmit DHCP request
431  *
432  * @v conn              UDP connection
433  * @v buf               Temporary data buffer
434  * @v len               Length of temporary data buffer
435  */
436 static void dhcp_senddata ( struct udp_connection *conn,
437                             void *buf, size_t len ) {
438         struct dhcp_session *dhcp = udp_to_dhcp ( conn );
439         struct dhcp_packet dhcppkt;
440         int rc;
441         
442         DBG ( "Transmitting %s\n", dhcp_message_type_name ( dhcp->state ) );
443
444         assert ( ( dhcp->state == DHCPDISCOVER ) ||
445                  ( dhcp->state == DHCPREQUEST ) );
446
447         /* Create DHCP packet in temporary buffer */
448         if ( ( rc = create_dhcp_packet ( dhcp, dhcp->state, buf, len,
449                                          &dhcppkt ) ) != 0 ) {
450                 DBG ( "Could not create DHCP packet\n" );
451                 return;
452         }
453
454         /* Copy in options common to all requests */
455         if ( ( rc = set_dhcp_packet_options ( &dhcppkt,
456                                               &dhcp_request_options ) ) != 0 ){
457                 DBG ( "Could not set common DHCP options\n" );
458                 return;
459         }
460
461         /* Transmit the packet */
462         udp_send ( conn, dhcppkt.dhcphdr, dhcppkt.len );
463 }
464
465 /**
466  * Receive new data
467  *
468  * @v udp               UDP connection
469  * @v data              Received data
470  * @v len               Length of received data
471  */
472 static void dhcp_newdata ( struct udp_connection *conn,
473                            void *data, size_t len ) {
474         struct dhcp_session *dhcp = udp_to_dhcp ( conn );
475         struct dhcphdr *dhcphdr = data;
476         struct dhcp_option_block *options;
477
478         /* Check for matching transaction ID */
479         if ( dhcphdr->xid != dhcp->xid ) {
480                 DBG ( "DHCP wrong transaction ID (wanted %08lx, got %08lx)\n",
481                       ntohl ( dhcphdr->xid ), ntohl ( dhcp->xid ) );
482                 return;
483         };
484
485         /* Parse packet and create options structure */
486         options = dhcp_parse ( dhcphdr, len );
487         if ( ! options ) {
488                 DBG ( "Could not parse DHCP packet\n" );
489                 return;
490         }
491
492         DBG ( "Received %s\n",
493               dhcp_message_type_name ( find_dhcp_num_option ( options,
494                                                        DHCP_MESSAGE_TYPE ) ) );
495
496         /* Proof of concept: just dump out the parsed options */
497         hex_dump ( options->data, options->len );
498         free_dhcp_options ( options );
499 }
500
501 /** DHCP UDP operations */
502 static struct udp_operations dhcp_udp_operations = {
503         .senddata       = dhcp_senddata,
504         .newdata        = dhcp_newdata,
505 };
506
507 /**
508  * Initiate DHCP on a network interface
509  *
510  * @v dhcp              DHCP session
511  * @ret aop             Asynchronous operation
512  */
513 struct async_operation * start_dhcp ( struct dhcp_session *dhcp ) {
514         dhcp->udp.udp_op = &dhcp_udp_operations;
515         dhcp->state = DHCPDISCOVER;
516         /* Use least significant 32 bits of link-layer address as XID */
517         memcpy ( &dhcp->xid, ( dhcp->netdev->ll_addr
518                                + dhcp->netdev->ll_protocol->ll_addr_len
519                                - sizeof ( dhcp->xid ) ), sizeof ( dhcp->xid ));
520
521         /* Proof of concept: just send a single DHCPDISCOVER */
522         udp_senddata ( &dhcp->udp );
523
524         return &dhcp->aop;
525 }