Add dhcp_configure_netdev()
[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 <stdlib.h>
21 #include <errno.h>
22 #include <assert.h>
23 #include <byteswap.h>
24 #include <gpxe/if_ether.h>
25 #include <gpxe/netdevice.h>
26 #include <gpxe/xfer.h>
27 #include <gpxe/open.h>
28 #include <gpxe/job.h>
29 #include <gpxe/retry.h>
30 #include <gpxe/tcpip.h>
31 #include <gpxe/ip.h>
32 #include <gpxe/dhcp.h>
33
34 /** @file
35  *
36  * Dynamic Host Configuration Protocol
37  *
38  */
39
40 /** DHCP operation types
41  *
42  * This table maps from DHCP message types (i.e. values of the @c
43  * DHCP_MESSAGE_TYPE option) to values of the "op" field within a DHCP
44  * packet.
45  */
46 static const uint8_t dhcp_op[] = {
47         [DHCPDISCOVER]  = BOOTP_REQUEST,
48         [DHCPOFFER]     = BOOTP_REPLY,
49         [DHCPREQUEST]   = BOOTP_REQUEST,
50         [DHCPDECLINE]   = BOOTP_REQUEST,
51         [DHCPACK]       = BOOTP_REPLY,
52         [DHCPNAK]       = BOOTP_REPLY,
53         [DHCPRELEASE]   = BOOTP_REQUEST,
54         [DHCPINFORM]    = BOOTP_REQUEST,
55 };
56
57 /** Raw option data for options common to all DHCP requests */
58 static uint8_t dhcp_request_options_data[] = {
59         DHCP_MAX_MESSAGE_SIZE, DHCP_WORD ( ETH_MAX_MTU ),
60         DHCP_VENDOR_CLASS_ID,
61         DHCP_STRING (  'E', 't', 'h', 'e', 'r', 'b', 'o', 'o', 't' ),
62         DHCP_PARAMETER_REQUEST_LIST,
63         DHCP_OPTION ( DHCP_SUBNET_MASK, DHCP_ROUTERS, DHCP_DNS_SERVERS, DHCP_LOG_SERVERS,
64                       DHCP_HOST_NAME, DHCP_DOMAIN_NAME, DHCP_ROOT_PATH,
65                       DHCP_VENDOR_ENCAP, DHCP_TFTP_SERVER_NAME,
66                       DHCP_BOOTFILE_NAME, DHCP_EB_ENCAP,
67                       DHCP_ISCSI_INITIATOR_IQN ),
68         DHCP_END
69 };
70
71 /**
72  * Name a DHCP packet type
73  *
74  * @v msgtype           DHCP message type
75  * @ret string          DHCP mesasge type name
76  */
77 static inline const char * dhcp_msgtype_name ( unsigned int msgtype ) {
78         switch ( msgtype ) {
79         case 0:                 return "BOOTP"; /* Non-DHCP packet */
80         case DHCPDISCOVER:      return "DHCPDISCOVER";
81         case DHCPOFFER:         return "DHCPOFFER";
82         case DHCPREQUEST:       return "DHCPREQUEST";
83         case DHCPDECLINE:       return "DHCPDECLINE";
84         case DHCPACK:           return "DHCPACK";
85         case DHCPNAK:           return "DHCPNAK";
86         case DHCPRELEASE:       return "DHCPRELEASE";
87         case DHCPINFORM:        return "DHCPINFORM";
88         default:                return "DHCP<invalid>";
89         }
90 }
91
92 /**
93  * Calculate DHCP transaction ID for a network device
94  *
95  * @v netdev            Network device
96  * @ret xid             DHCP XID
97  *
98  * Extract the least significant bits of the hardware address for use
99  * as the transaction ID.
100  */
101 static uint32_t dhcp_xid ( struct net_device *netdev ) {
102         uint32_t xid;
103
104         memcpy ( &xid, ( netdev->ll_addr + netdev->ll_protocol->ll_addr_len
105                          - sizeof ( xid ) ), sizeof ( xid ) );
106         return xid;
107 }
108
109 /** Options common to all DHCP requests */
110 struct dhcp_option_block dhcp_request_options = {
111         .data = dhcp_request_options_data,
112         .max_len = sizeof ( dhcp_request_options_data ),
113         .len = sizeof ( dhcp_request_options_data ),
114 };
115
116 /**
117  * Set option within DHCP packet
118  *
119  * @v dhcppkt           DHCP packet
120  * @v tag               DHCP option tag
121  * @v data              New value for DHCP option
122  * @v len               Length of value, in bytes
123  * @ret rc              Return status code
124  *
125  * Sets the option within the first available options block within the
126  * DHCP packet.  Option blocks are tried in the order specified by @c
127  * dhcp_option_block_fill_order.
128  *
129  * The magic options @c DHCP_EB_YIADDR and @c DHCP_EB_SIADDR are
130  * intercepted and inserted into the appropriate fixed fields within
131  * the DHCP packet.  The option @c DHCP_OPTION_OVERLOAD is silently
132  * ignored, since our DHCP packet assembly method relies on always
133  * having option overloading in use.
134  */
135 static int set_dhcp_packet_option ( struct dhcp_packet *dhcppkt,
136                                     unsigned int tag, const void *data,
137                                     size_t len ) {
138         struct dhcphdr *dhcphdr = dhcppkt->dhcphdr;
139         struct dhcp_option_block *options = dhcppkt->options;
140         struct dhcp_option *option = NULL;
141
142         /* Special-case the magic options */
143         switch ( tag ) {
144         case DHCP_OPTION_OVERLOAD:
145                 /* Hard-coded in packets we create; always ignore */
146                 return 0;
147         case DHCP_EB_YIADDR:
148                 memcpy ( &dhcphdr->yiaddr, data, sizeof ( dhcphdr->yiaddr ) );
149                 return 0;
150         case DHCP_EB_SIADDR:
151                 memcpy ( &dhcphdr->siaddr, data, sizeof ( dhcphdr->siaddr ) );
152                 return 0;
153         case DHCP_MESSAGE_TYPE:
154         case DHCP_REQUESTED_ADDRESS:
155         case DHCP_PARAMETER_REQUEST_LIST:
156                 /* These options have to be within the main options
157                  * block.  This doesn't seem to be required by the
158                  * RFCs, but at least ISC dhcpd refuses to recognise
159                  * them otherwise.
160                  */
161                 options = &dhcppkt->options[OPTS_MAIN];
162                 break;
163         default:
164                 /* Continue processing as normal */
165                 break;
166         }
167                 
168         /* Set option in first available options block */
169         for ( ; options < &dhcppkt->options[NUM_OPT_BLOCKS] ; options++ ) {
170                 option = set_dhcp_option ( options, tag, data, len );
171                 if ( option )
172                         break;
173         }
174
175         /* Update DHCP packet length */
176         dhcppkt->len = ( offsetof ( typeof ( *dhcppkt->dhcphdr ), options )
177                          + dhcppkt->options[OPTS_MAIN].len );
178
179         return ( option ? 0 : -ENOSPC );
180 }
181
182 /**
183  * Copy option into DHCP packet
184  *
185  * @v dhcppkt           DHCP packet
186  * @v options           DHCP option block, or NULL
187  * @v tag               DHCP option tag to search for
188  * @v new_tag           DHCP option tag to use for copied option
189  * @ret rc              Return status code
190  *
191  * Copies a single option, if present, from the DHCP options block
192  * into a DHCP packet.  The tag for the option may be changed if
193  * desired; this is required by other parts of the DHCP code.
194  *
195  * @c options may specify a single options block, or be left as NULL
196  * in order to search for the option within all registered options
197  * blocks.
198  */
199 static int copy_dhcp_packet_option ( struct dhcp_packet *dhcppkt,
200                                      struct dhcp_option_block *options,
201                                      unsigned int tag, unsigned int new_tag ) {
202         struct dhcp_option *option;
203         int rc;
204
205         option = find_dhcp_option ( options, tag );
206         if ( option ) {
207                 if ( ( rc = set_dhcp_packet_option ( dhcppkt, new_tag,
208                                                      &option->data,
209                                                      option->len ) ) != 0 )
210                         return rc;
211         }
212         return 0;
213 }
214
215 /**
216  * Copy options into DHCP packet
217  *
218  * @v dhcppkt           DHCP packet
219  * @v options           DHCP option block, or NULL
220  * @v encapsulator      Encapsulating option, or zero
221  * @ret rc              Return status code
222  * 
223  * Copies options with the specified encapsulator from DHCP options
224  * blocks into a DHCP packet.  Most options are copied verbatim.
225  * Recognised encapsulated options fields are handled as such.
226  *
227  * @c options may specify a single options block, or be left as NULL
228  * in order to copy options from all registered options blocks.
229  */
230 static int copy_dhcp_packet_encap_options ( struct dhcp_packet *dhcppkt,
231                                             struct dhcp_option_block *options,
232                                             unsigned int encapsulator ) {
233         unsigned int subtag;
234         unsigned int tag;
235         int rc;
236
237         for ( subtag = DHCP_MIN_OPTION; subtag <= DHCP_MAX_OPTION; subtag++ ) {
238                 tag = DHCP_ENCAP_OPT ( encapsulator, subtag );
239                 switch ( tag ) {
240                 case DHCP_EB_ENCAP:
241                 case DHCP_VENDOR_ENCAP:
242                         /* Process encapsulated options field */
243                         if ( ( rc = copy_dhcp_packet_encap_options ( dhcppkt,
244                                                                      options,
245                                                                      tag)) !=0)
246                                 return rc;
247                         break;
248                 default:
249                         /* Copy option to reassembled packet */
250                         if ( ( rc = copy_dhcp_packet_option ( dhcppkt, options,
251                                                               tag, tag ) ) !=0)
252                                 return rc;
253                         break;
254                 };
255         }
256
257         return 0;
258 }
259
260 /**
261  * Copy options into DHCP packet
262  *
263  * @v dhcppkt           DHCP packet
264  * @v options           DHCP option block, or NULL
265  * @ret rc              Return status code
266  * 
267  * Copies options from DHCP options blocks into a DHCP packet.  Most
268  * options are copied verbatim.  Recognised encapsulated options
269  * fields are handled as such.
270  *
271  * @c options may specify a single options block, or be left as NULL
272  * in order to copy options from all registered options blocks.
273  */
274 int copy_dhcp_packet_options ( struct dhcp_packet *dhcppkt,
275                                struct dhcp_option_block *options ) {
276         return copy_dhcp_packet_encap_options ( dhcppkt, options, 0 );
277 }
278
279 /**
280  * Create a DHCP packet
281  *
282  * @v netdev            Network device
283  * @v msgtype           DHCP message type
284  * @v data              Buffer for DHCP packet
285  * @v max_len           Size of DHCP packet buffer
286  * @v dhcppkt           DHCP packet structure to fill in
287  * @ret rc              Return status code
288  *
289  * Creates a DHCP packet in the specified buffer, and fills out a @c
290  * dhcp_packet structure that can be passed to
291  * set_dhcp_packet_option() or copy_dhcp_packet_options().
292  */
293 int create_dhcp_packet ( struct net_device *netdev, uint8_t msgtype,
294                          void *data, size_t max_len,
295                          struct dhcp_packet *dhcppkt ) {
296         struct dhcphdr *dhcphdr = data;
297         static const uint8_t overloading = ( DHCP_OPTION_OVERLOAD_FILE |
298                                              DHCP_OPTION_OVERLOAD_SNAME );
299         int rc;
300
301         /* Sanity check */
302         if ( max_len < sizeof ( *dhcphdr ) )
303                 return -ENOSPC;
304
305         /* Initialise DHCP packet content */
306         memset ( dhcphdr, 0, max_len );
307         dhcphdr->xid = dhcp_xid ( netdev );
308         dhcphdr->magic = htonl ( DHCP_MAGIC_COOKIE );
309         dhcphdr->htype = ntohs ( netdev->ll_protocol->ll_proto );
310         dhcphdr->hlen = netdev->ll_protocol->ll_addr_len;
311         memcpy ( dhcphdr->chaddr, netdev->ll_addr, dhcphdr->hlen );
312         dhcphdr->op = dhcp_op[msgtype];
313
314         /* Initialise DHCP packet structure */
315         dhcppkt->dhcphdr = dhcphdr;
316         dhcppkt->max_len = max_len;
317         init_dhcp_options ( &dhcppkt->options[OPTS_MAIN], dhcphdr->options,
318                             ( max_len -
319                               offsetof ( typeof ( *dhcphdr ), options ) ) );
320         init_dhcp_options ( &dhcppkt->options[OPTS_FILE], dhcphdr->file,
321                             sizeof ( dhcphdr->file ) );
322         init_dhcp_options ( &dhcppkt->options[OPTS_SNAME], dhcphdr->sname,
323                             sizeof ( dhcphdr->sname ) );
324         
325         /* Set DHCP_OPTION_OVERLOAD option within the main options block */
326         if ( set_dhcp_option ( &dhcppkt->options[OPTS_MAIN],
327                                DHCP_OPTION_OVERLOAD, &overloading,
328                                sizeof ( overloading ) ) == NULL )
329                 return -ENOSPC;
330
331         /* Set DHCP_MESSAGE_TYPE option */
332         if ( ( rc = set_dhcp_packet_option ( dhcppkt, DHCP_MESSAGE_TYPE,
333                                              &msgtype,
334                                              sizeof ( msgtype ) ) ) != 0 )
335                 return rc;
336
337         return 0;
338 }
339
340 /**
341  * Calculate used length of a field containing DHCP options
342  *
343  * @v data              Field containing DHCP options
344  * @v max_len           Field length
345  * @ret len             Used length (excluding the @c DHCP_END tag)
346  */
347 static size_t dhcp_field_len ( const void *data, size_t max_len ) {
348         struct dhcp_option_block options;
349         struct dhcp_option *end;
350
351         options.data = ( ( void * ) data );
352         options.len = max_len;
353         end = find_dhcp_option ( &options, DHCP_END );
354         return ( end ? ( ( ( void * ) end ) - data ) : 0 );
355 }
356
357 /**
358  * Merge field containing DHCP options or string into DHCP options block
359  *
360  * @v options           DHCP option block
361  * @v data              Field containing DHCP options
362  * @v max_len           Field length
363  * @v tag               DHCP option tag, or 0
364  *
365  * If @c tag is non-zero, the field will be treated as a
366  * NUL-terminated string representing the value of the specified DHCP
367  * option.  If @c tag is zero, the field will be treated as a block of
368  * DHCP options, and simply appended to the existing options in the
369  * option block.
370  *
371  * The caller must ensure that there is enough space in the options
372  * block to perform the merge.
373  */
374 static void merge_dhcp_field ( struct dhcp_option_block *options,
375                                const void *data, size_t max_len,
376                                unsigned int tag ) {
377         size_t len;
378         void *dest;
379         struct dhcp_option *end;
380
381         if ( tag ) {
382                 set_dhcp_option ( options, tag, data, strlen ( data ) );
383         } else {
384                 len = dhcp_field_len ( data, max_len );
385                 dest = ( options->data + options->len - 1 );
386                 memcpy ( dest, data, len );
387                 options->len += len;
388                 end = ( dest + len );
389                 end->tag = DHCP_END;
390         }
391 }
392
393 /**
394  * Parse DHCP packet and construct DHCP options block
395  *
396  * @v dhcphdr           DHCP packet
397  * @v len               Length of DHCP packet
398  * @ret options         DHCP options block, or NULL
399  *
400  * Parses a received DHCP packet and canonicalises its contents into a
401  * single DHCP options block.  The "file" and "sname" fields are
402  * converted into the corresponding DHCP options (@c
403  * DHCP_BOOTFILE_NAME and @c DHCP_TFTP_SERVER_NAME respectively).  If
404  * these fields are used for option overloading, their options are
405  * merged in to the options block.
406  *
407  * The values of the "yiaddr" and "siaddr" fields will be stored
408  * within the options block as the magic options @c DHCP_EB_YIADDR and
409  * @c DHCP_EB_SIADDR.
410  * 
411  * Note that this call allocates new memory for the constructed DHCP
412  * options block; it is the responsibility of the caller to eventually
413  * free this memory.
414  */
415 static struct dhcp_option_block * dhcp_parse ( const struct dhcphdr *dhcphdr,
416                                                size_t len ) {
417         struct dhcp_option_block *options;
418         size_t options_len;
419         unsigned int overloading;
420
421         /* Sanity check */
422         if ( len < sizeof ( *dhcphdr ) )
423                 return NULL;
424
425         /* Calculate size of resulting concatenated option block:
426          *
427          *   The "options" field : length of the field minus the DHCP_END tag.
428          *
429          *   The "file" field : maximum length of the field minus the
430          *   NUL terminator, plus a 2-byte DHCP header or, if used for
431          *   option overloading, the length of the field minus the
432          *   DHCP_END tag.
433          *
434          *   The "sname" field : as for the "file" field.
435          *
436          *   15 bytes for an encapsulated options field to contain the
437          *   value of the "yiaddr" and "siaddr" fields
438          *
439          *   1 byte for a final terminating DHCP_END tag.
440          */
441         options_len = ( ( len - offsetof ( typeof ( *dhcphdr ), options ) ) - 1
442                         + ( sizeof ( dhcphdr->file ) + 1 )
443                         + ( sizeof ( dhcphdr->sname ) + 1 )
444                         + 15 /* yiaddr and siaddr */
445                         + 1 /* DHCP_END tag */ );
446         
447         /* Allocate empty options block of required size */
448         options = alloc_dhcp_options ( options_len );
449         if ( ! options ) {
450                 DBG ( "DHCP could not allocate %d-byte option block\n",
451                       options_len );
452                 return NULL;
453         }
454         
455         /* Merge in "options" field, if this is a DHCP packet */
456         if ( dhcphdr->magic == htonl ( DHCP_MAGIC_COOKIE ) ) {
457                 merge_dhcp_field ( options, dhcphdr->options,
458                                    ( len -
459                                      offsetof ( typeof (*dhcphdr), options ) ),
460                                    0 /* Always contains options */ );
461         }
462
463         /* Identify overloaded fields */
464         overloading = find_dhcp_num_option ( options, DHCP_OPTION_OVERLOAD );
465         
466         /* Merge in "file" and "sname" fields */
467         merge_dhcp_field ( options, dhcphdr->file, sizeof ( dhcphdr->file ),
468                            ( ( overloading & DHCP_OPTION_OVERLOAD_FILE ) ?
469                              0 : DHCP_BOOTFILE_NAME ) );
470         merge_dhcp_field ( options, dhcphdr->sname, sizeof ( dhcphdr->sname ),
471                            ( ( overloading & DHCP_OPTION_OVERLOAD_SNAME ) ?
472                              0 : DHCP_TFTP_SERVER_NAME ) );
473
474         /* Set magic options for "yiaddr" and "siaddr", if present */
475         if ( dhcphdr->yiaddr.s_addr ) {
476                 set_dhcp_option ( options, DHCP_EB_YIADDR,
477                                   &dhcphdr->yiaddr, sizeof (dhcphdr->yiaddr) );
478         }
479         if ( dhcphdr->siaddr.s_addr ) {
480                 set_dhcp_option ( options, DHCP_EB_SIADDR,
481                                   &dhcphdr->siaddr, sizeof (dhcphdr->siaddr) );
482         }
483         
484         assert ( options->len <= options->max_len );
485
486         return options;
487 }
488
489 /****************************************************************************
490  *
491  * DHCP to UDP interface
492  *
493  */
494
495 /** A DHCP session */
496 struct dhcp_session {
497         /** Reference counter */
498         struct refcnt refcnt;
499         /** Job control interface */
500         struct job_interface job;
501         /** Data transfer interface */
502         struct xfer_interface xfer;
503
504         /** Network device being configured */
505         struct net_device *netdev;
506         /** Option block registration routine */
507         int ( * register_options ) ( struct net_device *netdev,
508                                      struct dhcp_option_block *options );
509
510         /** State of the session
511          *
512          * This is a value for the @c DHCP_MESSAGE_TYPE option
513          * (e.g. @c DHCPDISCOVER).
514          */
515         int state;
516         /** Options obtained from server */
517         struct dhcp_option_block *options;
518         /** Retransmission timer */
519         struct retry_timer timer;
520 };
521
522 /**
523  * Free DHCP session
524  *
525  * @v refcnt            Reference counter
526  */
527 static void dhcp_free ( struct refcnt *refcnt ) {
528         struct dhcp_session *dhcp =
529                 container_of ( refcnt, struct dhcp_session, refcnt );
530
531         netdev_put ( dhcp->netdev );
532         dhcpopt_put ( dhcp->options );
533         free ( dhcp );
534 }
535
536 /**
537  * Mark DHCP session as complete
538  *
539  * @v dhcp              DHCP session
540  * @v rc                Return status code
541  */
542 static void dhcp_finished ( struct dhcp_session *dhcp, int rc ) {
543
544         /* Block futher incoming messages */
545         job_nullify ( &dhcp->job );
546         xfer_nullify ( &dhcp->xfer );
547
548         /* Stop retry timer */
549         stop_timer ( &dhcp->timer );
550
551         /* Free resources and close interfaces */
552         xfer_close ( &dhcp->xfer, rc );
553         job_done ( &dhcp->job, rc );
554 }
555
556 /****************************************************************************
557  *
558  * Data transfer interface
559  *
560  */
561
562 /**
563  * Transmit DHCP request
564  *
565  * @v dhcp              DHCP session
566  * @ret rc              Return status code
567  */
568 static int dhcp_send_request ( struct dhcp_session *dhcp ) {
569         struct xfer_metadata meta = {
570                 .netdev = dhcp->netdev,
571         };
572         struct dhcp_packet dhcppkt;
573         struct io_buffer *iobuf;
574         int rc;
575         
576         DBGC ( dhcp, "DHCP %p transmitting %s\n",
577                dhcp, dhcp_msgtype_name ( dhcp->state ) );
578
579         assert ( ( dhcp->state == DHCPDISCOVER ) ||
580                  ( dhcp->state == DHCPREQUEST ) );
581
582         /* Start retry timer.  Do this first so that failures to
583          * transmit will be retried.
584          */
585         start_timer ( &dhcp->timer );
586
587         /* Allocate buffer for packet */
588         iobuf = xfer_alloc_iob ( &dhcp->xfer, DHCP_MIN_LEN );
589         if ( ! iobuf )
590                 return -ENOMEM;
591
592         /* Create DHCP packet in temporary buffer */
593         if ( ( rc = create_dhcp_packet ( dhcp->netdev, dhcp->state,
594                                          iobuf->data, iob_tailroom ( iobuf ),
595                                          &dhcppkt ) ) != 0 ) {
596                 DBGC ( dhcp, "DHCP %p could not create DHCP packet: %s\n",
597                        dhcp, strerror ( rc ) );
598                 goto done;
599         }
600
601         /* Copy in options common to all requests */
602         if ( ( rc = copy_dhcp_packet_options ( &dhcppkt,
603                                                &dhcp_request_options ) ) != 0){
604                 DBGC ( dhcp, "DHCP %p could not set common DHCP options: %s\n",
605                        dhcp, strerror ( rc ) );
606                 goto done;
607         }
608
609         /* Copy any required options from previous server repsonse */
610         if ( dhcp->options ) {
611                 if ( ( rc = copy_dhcp_packet_option ( &dhcppkt, dhcp->options,
612                                             DHCP_SERVER_IDENTIFIER,
613                                             DHCP_SERVER_IDENTIFIER ) ) != 0 ) {
614                         DBGC ( dhcp, "DHCP %p could not set server identifier "
615                                "option: %s\n", dhcp, strerror ( rc ) );
616                         goto done;
617                 }
618                 if ( ( rc = copy_dhcp_packet_option ( &dhcppkt, dhcp->options,
619                                             DHCP_EB_YIADDR,
620                                             DHCP_REQUESTED_ADDRESS ) ) != 0 ) {
621                         DBGC ( dhcp, "DHCP %p could not set requested address "
622                                "option: %s\n", dhcp, strerror ( rc ) );
623                         goto done;
624                 }
625         }
626
627         /* Transmit the packet */
628         iob_put ( iobuf, dhcppkt.len );
629         rc = xfer_deliver_iob_meta ( &dhcp->xfer, iobuf, &meta );
630         iobuf = NULL;
631         if ( rc != 0 ) {
632                 DBGC ( dhcp, "DHCP %p could not transmit UDP packet: %s\n",
633                        dhcp, strerror ( rc ) );
634                 goto done;
635         }
636
637  done:
638         free_iob ( iobuf );
639         return rc;
640 }
641
642 /**
643  * Handle DHCP retry timer expiry
644  *
645  * @v timer             DHCP retry timer
646  * @v fail              Failure indicator
647  */
648 static void dhcp_timer_expired ( struct retry_timer *timer, int fail ) {
649         struct dhcp_session *dhcp =
650                 container_of ( timer, struct dhcp_session, timer );
651
652         if ( fail ) {
653                 dhcp_finished ( dhcp, -ETIMEDOUT );
654         } else {
655                 dhcp_send_request ( dhcp );
656         }
657 }
658
659 /**
660  * Receive new data
661  *
662  * @v xfer              Data transfer interface
663  * @v iobuf             I/O buffer
664  * @v data              Received data
665  * @v len               Length of received data
666  * @ret rc              Return status code
667  */
668 static int dhcp_deliver_raw ( struct xfer_interface *xfer,
669                               const void *data, size_t len ) {
670         struct dhcp_session *dhcp =
671                 container_of ( xfer, struct dhcp_session, xfer );
672         const struct dhcphdr *dhcphdr = data;
673         struct dhcp_option_block *options;
674         unsigned int msgtype;
675
676         /* Check for matching transaction ID */
677         if ( dhcphdr->xid != dhcp_xid ( dhcp->netdev ) ) {
678                 DBGC ( dhcp, "DHCP %p wrong transaction ID (wanted %08lx, "
679                         "got %08lx)\n", dhcp, ntohl ( dhcphdr->xid ),
680                         ntohl ( dhcp_xid ( dhcp->netdev ) ) );
681                 return 0;
682         };
683
684         /* Parse packet and create options structure */
685         options = dhcp_parse ( dhcphdr, len );
686         if ( ! options ) {
687                 DBGC ( dhcp, "DHCP %p could not parse DHCP packet\n", dhcp );
688                 return -EINVAL;
689         }
690
691         /* Determine message type */
692         msgtype = find_dhcp_num_option ( options, DHCP_MESSAGE_TYPE );
693         DBGC ( dhcp, "DHCP %p received %s\n",
694                dhcp, dhcp_msgtype_name ( msgtype ) );
695
696         /* Handle DHCP reply */
697         switch ( dhcp->state ) {
698         case DHCPDISCOVER:
699                 if ( msgtype != DHCPOFFER )
700                         goto out_discard;
701                 dhcp->state = DHCPREQUEST;
702                 break;
703         case DHCPREQUEST:
704                 if ( msgtype != DHCPACK )
705                         goto out_discard;
706                 dhcp->state = DHCPACK;
707                 break;
708         default:
709                 assert ( 0 );
710                 goto out_discard;
711         }
712
713         /* Stop timer and update stored options */
714         stop_timer ( &dhcp->timer );
715         if ( dhcp->options )
716                 dhcpopt_put ( dhcp->options );
717         dhcp->options = options;
718
719         /* Transmit next packet, or terminate session */
720         if ( dhcp->state < DHCPACK ) {
721                 dhcp_send_request ( dhcp );
722         } else {
723                 dhcp->register_options ( dhcp->netdev, dhcp->options );
724                 dhcp_finished ( dhcp, 0 );
725         }
726         return 0;
727
728  out_discard:
729         dhcpopt_put ( options );
730         return 0;
731 }
732
733 /** DHCP data transfer interface operations */
734 static struct xfer_interface_operations dhcp_xfer_operations = {
735         .close          = ignore_xfer_close,
736         .vredirect      = xfer_vopen,
737         .request        = ignore_xfer_request,
738         .seek           = ignore_xfer_seek,
739         .deliver_iob    = xfer_deliver_as_raw,
740         .deliver_raw    = dhcp_deliver_raw,
741 };
742
743 /****************************************************************************
744  *
745  * Job control interface
746  *
747  */
748
749 /**
750  * Handle kill() event received via job control interface
751  *
752  * @v job               DHCP job control interface
753  */
754 static void dhcp_job_kill ( struct job_interface *job ) {
755         struct dhcp_session *dhcp =
756                 container_of ( job, struct dhcp_session, job );
757
758         /* Terminate DHCP session */
759         dhcp_finished ( dhcp, -ECANCELED );
760 }
761
762 /** DHCP job control interface operations */
763 static struct job_interface_operations dhcp_job_operations = {
764         .done           = ignore_job_done,
765         .kill           = dhcp_job_kill,
766         .progress       = ignore_job_progress,
767 };
768
769 /****************************************************************************
770  *
771  * Instantiator
772  *
773  */
774
775 /**
776  * Start DHCP on a network device
777  *
778  * @v job               Job control interface
779  * @v netdev            Network device
780  * @v register_options  DHCP option block registration routine
781  * @ret rc              Return status code
782  *
783  * Starts DHCP on the specified network device.  If successful, the @c
784  * register_options() routine will be called with the acquired
785  * options.
786  */
787 int start_dhcp ( struct job_interface *job, struct net_device *netdev,
788                  int ( * register_options ) ( struct net_device *netdev,
789                                               struct dhcp_option_block * ) ) {
790         static struct sockaddr_in server = {
791                 .sin_family = AF_INET,
792                 .sin_addr.s_addr = INADDR_BROADCAST,
793                 .sin_port = htons ( BOOTPS_PORT ),
794         };
795         static struct sockaddr_in client = {
796                 .sin_family = AF_INET,
797                 .sin_port = htons ( BOOTPC_PORT ),
798         };
799         struct dhcp_session *dhcp;
800         int rc;
801
802         /* Allocate and initialise structure */
803         dhcp = malloc ( sizeof ( *dhcp ) );
804         if ( ! dhcp )
805                 return -ENOMEM;
806         memset ( dhcp, 0, sizeof ( *dhcp ) );
807         dhcp->refcnt.free = dhcp_free;
808         job_init ( &dhcp->job, &dhcp_job_operations, &dhcp->refcnt );
809         xfer_init ( &dhcp->xfer, &dhcp_xfer_operations, &dhcp->refcnt );
810         dhcp->netdev = netdev_get ( netdev );
811         dhcp->register_options = register_options;
812         dhcp->timer.expired = dhcp_timer_expired;
813         dhcp->state = DHCPDISCOVER;
814
815         /* Instantiate child objects and attach to our interfaces */
816         if ( ( rc = xfer_open_socket ( &dhcp->xfer, SOCK_DGRAM,
817                                        ( struct sockaddr * ) &server,
818                                        ( struct sockaddr * ) &client ) ) != 0 )
819                 goto err;
820
821         /* Start timer to initiate initial DHCPREQUEST */
822         start_timer ( &dhcp->timer );
823
824         /* Attach parent interface, mortalise self, and return */
825         job_plug_plug ( &dhcp->job, job );
826         ref_put ( &dhcp->refcnt );
827         return 0;
828
829  err:
830         dhcp_finished ( dhcp, rc );
831         ref_put ( &dhcp->refcnt );
832         return rc;
833 }
834
835 /****************************************************************************
836  *
837  * Network device configurator
838  *
839  */
840
841 /* Avoid dragging in dns.o */
842 struct sockaddr_tcpip nameserver;
843
844 /* Avoid dragging in syslog.o */
845 struct in_addr syslogserver;
846
847 /**
848  * Configure network device from DHCP options
849  *
850  * @v netdev            Network device
851  * @v options           DHCP options block
852  * @ret rc              Return status code
853  */
854 int dhcp_configure_netdev ( struct net_device *netdev,
855                             struct dhcp_option_block *options ) {
856         struct in_addr address = { 0 };
857         struct in_addr netmask = { 0 };
858         struct in_addr gateway = { INADDR_NONE };
859         struct sockaddr_in *sin_nameserver;
860         int rc;
861
862         /* Clear any existing routing table entry */
863         del_ipv4_address ( netdev );
864
865         /* Retrieve IP address configuration */
866         find_dhcp_ipv4_option ( options, DHCP_EB_YIADDR, &address );
867         find_dhcp_ipv4_option ( options, DHCP_SUBNET_MASK, &netmask );
868         find_dhcp_ipv4_option ( options, DHCP_ROUTERS, &gateway );
869
870         /* Set up new IP address configuration */
871         if ( ( rc = add_ipv4_address ( netdev, address, netmask,
872                                        gateway ) ) != 0 ) {
873                 DBG ( "Could not configure %s with DHCP results: %s\n",
874                       netdev->name, strerror ( rc ) );
875                 return rc;
876         }
877
878         /* Retrieve other DHCP options that we care about */
879         sin_nameserver = ( struct sockaddr_in * ) &nameserver;
880         sin_nameserver->sin_family = AF_INET;
881         find_dhcp_ipv4_option ( options, DHCP_DNS_SERVERS,
882                                 &sin_nameserver->sin_addr );
883         find_dhcp_ipv4_option ( options, DHCP_LOG_SERVERS,
884                                 &syslogserver );
885
886         return 0;
887 }