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