[dhcp] Pass PXE boot menu item to PXE Boot Server
[people/oremanj/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 <stdio.h>
22 #include <errno.h>
23 #include <assert.h>
24 #include <byteswap.h>
25 #include <gpxe/if_ether.h>
26 #include <gpxe/netdevice.h>
27 #include <gpxe/device.h>
28 #include <gpxe/xfer.h>
29 #include <gpxe/open.h>
30 #include <gpxe/job.h>
31 #include <gpxe/retry.h>
32 #include <gpxe/tcpip.h>
33 #include <gpxe/ip.h>
34 #include <gpxe/uuid.h>
35 #include <gpxe/dhcp.h>
36 #include <gpxe/timer.h>
37 #include <gpxe/settings.h>
38 #include <gpxe/dhcp.h>
39 #include <gpxe/dhcpopts.h>
40 #include <gpxe/dhcppkt.h>
41 #include <gpxe/features.h>
42
43 /** @file
44  *
45  * Dynamic Host Configuration Protocol
46  *
47  */
48
49 /**
50  * DHCP operation types
51  *
52  * This table maps from DHCP message types (i.e. values of the @c
53  * DHCP_MESSAGE_TYPE option) to values of the "op" field within a DHCP
54  * packet.
55  */
56 static const uint8_t dhcp_op[] = {
57         [DHCPDISCOVER]  = BOOTP_REQUEST,
58         [DHCPOFFER]     = BOOTP_REPLY,
59         [DHCPREQUEST]   = BOOTP_REQUEST,
60         [DHCPDECLINE]   = BOOTP_REQUEST,
61         [DHCPACK]       = BOOTP_REPLY,
62         [DHCPNAK]       = BOOTP_REPLY,
63         [DHCPRELEASE]   = BOOTP_REQUEST,
64         [DHCPINFORM]    = BOOTP_REQUEST,
65 };
66
67 /** Raw option data for options common to all DHCP requests */
68 static uint8_t dhcp_request_options_data[] = {
69         DHCP_MAX_MESSAGE_SIZE,
70         DHCP_WORD ( ETH_MAX_MTU - 20 /* IP header */ - 8 /* UDP header */ ),
71         DHCP_CLIENT_ARCHITECTURE, DHCP_WORD ( 0 ),
72         DHCP_CLIENT_NDI, DHCP_OPTION ( 1 /* UNDI */ , 2, 1 /* v2.1 */ ),
73         DHCP_VENDOR_CLASS_ID,
74         DHCP_STRING (  'P', 'X', 'E', 'C', 'l', 'i', 'e', 'n', 't', ':',
75                        'A', 'r', 'c', 'h', ':', '0', '0', '0', '0', '0', ':',
76                        'U', 'N', 'D', 'I', ':', '0', '0', '2', '0', '0', '1' ),
77         DHCP_PARAMETER_REQUEST_LIST,
78         DHCP_OPTION ( DHCP_SUBNET_MASK, DHCP_ROUTERS, DHCP_DNS_SERVERS,
79                       DHCP_LOG_SERVERS, DHCP_HOST_NAME, DHCP_DOMAIN_NAME,
80                       DHCP_ROOT_PATH, DHCP_VENDOR_ENCAP, DHCP_VENDOR_CLASS_ID,
81                       DHCP_TFTP_SERVER_NAME, DHCP_BOOTFILE_NAME,
82                       DHCP_EB_ENCAP, DHCP_ISCSI_INITIATOR_IQN ),
83         DHCP_END
84 };
85
86 /** Options common to all DHCP requests */
87 static struct dhcp_options dhcp_request_options = {
88         .data = dhcp_request_options_data,
89         .max_len = sizeof ( dhcp_request_options_data ),
90         .len = sizeof ( dhcp_request_options_data ),
91 };
92
93 /** DHCP feature codes */
94 static uint8_t dhcp_features[0] __table_start ( uint8_t, dhcp_features );
95 static uint8_t dhcp_features_end[0] __table_end ( uint8_t, dhcp_features );
96
97 /** Version number feature */
98 FEATURE_VERSION ( VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH );
99
100 /** DHCP network device descriptor */
101 struct dhcp_netdev_desc {
102         /** Bus type ID */
103         uint8_t type;
104         /** Vendor ID */
105         uint16_t vendor;
106         /** Device ID */
107         uint16_t device;
108 } __attribute__ (( packed ));
109
110 /** DHCP client identifier */
111 struct dhcp_client_id {
112         /** Link-layer protocol */
113         uint8_t ll_proto;
114         /** Link-layer address */
115         uint8_t ll_addr[MAX_LL_ADDR_LEN];
116 } __attribute__ (( packed ));
117
118 /** DHCP client UUID */
119 struct dhcp_client_uuid {
120         /** Identifier type */
121         uint8_t type;
122         /** UUID */
123         union uuid uuid;
124 } __attribute__ (( packed ));
125
126 #define DHCP_CLIENT_UUID_TYPE 0
127
128 /** DHCP PXE boot menu item */
129 struct dhcp_pxe_boot_menu_item {
130         /** "Type"
131          *
132          * This field actually identifies the specific boot server (or
133          * cluster of boot servers offering identical boot files).
134          */
135         uint16_t type;
136         /** "Layer"
137          *
138          * Just don't ask.
139          */
140         uint16_t layer;
141 } __attribute__ (( packed ));
142
143 /**
144  * Name a DHCP packet type
145  *
146  * @v msgtype           DHCP message type
147  * @ret string          DHCP mesasge type name
148  */
149 static inline const char * dhcp_msgtype_name ( unsigned int msgtype ) {
150         switch ( msgtype ) {
151         case DHCPNONE:          return "BOOTP"; /* Non-DHCP packet */
152         case DHCPDISCOVER:      return "DHCPDISCOVER";
153         case DHCPOFFER:         return "DHCPOFFER";
154         case DHCPREQUEST:       return "DHCPREQUEST";
155         case DHCPDECLINE:       return "DHCPDECLINE";
156         case DHCPACK:           return "DHCPACK";
157         case DHCPNAK:           return "DHCPNAK";
158         case DHCPRELEASE:       return "DHCPRELEASE";
159         case DHCPINFORM:        return "DHCPINFORM";
160         default:                return "DHCP<invalid>";
161         }
162 }
163
164 /**
165  * Calculate DHCP transaction ID for a network device
166  *
167  * @v netdev            Network device
168  * @ret xid             DHCP XID
169  *
170  * Extract the least significant bits of the hardware address for use
171  * as the transaction ID.
172  */
173 static uint32_t dhcp_xid ( struct net_device *netdev ) {
174         uint32_t xid;
175
176         memcpy ( &xid, ( netdev->ll_addr + netdev->ll_protocol->ll_addr_len
177                          - sizeof ( xid ) ), sizeof ( xid ) );
178         return xid;
179 }
180
181 /****************************************************************************
182  *
183  * DHCP settings
184  *
185  */
186
187 /** A DHCP settings block */
188 struct dhcp_settings {
189         /** Reference counter */
190         struct refcnt refcnt;
191         /** DHCP packet */
192         struct dhcp_packet dhcppkt;
193         /** Setting interface */
194         struct settings settings;
195 };
196
197 /**
198  * Increment reference count on DHCP settings block
199  *
200  * @v dhcpset           DHCP settings block
201  * @ret dhcpset         DHCP settings block
202  */
203 static inline __attribute__ (( always_inline )) struct dhcp_settings *
204 dhcpset_get ( struct dhcp_settings *dhcpset ) {
205         ref_get ( &dhcpset->refcnt );
206         return dhcpset;
207 }
208
209 /**
210  * Decrement reference count on DHCP settings block
211  *
212  * @v dhcpset           DHCP settings block
213  */
214 static inline __attribute__ (( always_inline )) void
215 dhcpset_put ( struct dhcp_settings *dhcpset ) {
216         ref_put ( &dhcpset->refcnt );
217 }
218
219 /**
220  * Store value of DHCP setting
221  *
222  * @v settings          Settings block
223  * @v setting           Setting to store
224  * @v data              Setting data, or NULL to clear setting
225  * @v len               Length of setting data
226  * @ret rc              Return status code
227  */
228 static int dhcpset_store ( struct settings *settings, struct setting *setting,
229                            const void *data, size_t len ) {
230         struct dhcp_settings *dhcpset =
231                 container_of ( settings, struct dhcp_settings, settings );
232
233         return dhcppkt_store ( &dhcpset->dhcppkt, setting->tag, data, len );
234 }
235
236 /**
237  * Fetch value of DHCP setting
238  *
239  * @v settings          Settings block, or NULL to search all blocks
240  * @v setting           Setting to fetch
241  * @v data              Buffer to fill with setting data
242  * @v len               Length of buffer
243  * @ret len             Length of setting data, or negative error
244  */
245 static int dhcpset_fetch ( struct settings *settings, struct setting *setting,
246                            void *data, size_t len ) {
247         struct dhcp_settings *dhcpset =
248                 container_of ( settings, struct dhcp_settings, settings );
249
250         return dhcppkt_fetch ( &dhcpset->dhcppkt, setting->tag, data, len );
251 }
252
253 /** DHCP settings operations */
254 static struct settings_operations dhcpset_settings_operations = {
255         .store = dhcpset_store,
256         .fetch = dhcpset_fetch,
257 };
258
259 /**
260  * Create DHCP setting block
261  *
262  * @v dhcphdr           DHCP packet
263  * @v len               Length of DHCP packet
264  * @ret dhcpset         DHCP settings block
265  */
266 static struct dhcp_settings * dhcpset_create ( const struct dhcphdr *dhcphdr,
267                                                size_t len ) {
268         struct dhcp_settings *dhcpset;
269         void *data;
270
271         dhcpset = zalloc ( sizeof ( *dhcpset ) + len );
272         if ( dhcpset ) {
273                 data = ( ( ( void * ) dhcpset ) + sizeof ( *dhcpset ) );
274                 memcpy ( data, dhcphdr, len );
275                 dhcppkt_init ( &dhcpset->dhcppkt, data, len );
276                 settings_init ( &dhcpset->settings,
277                                 &dhcpset_settings_operations, &dhcpset->refcnt,
278                                 DHCP_SETTINGS_NAME, 0 );
279         }
280         return dhcpset;
281 }
282
283 /** DHCP server address setting */
284 struct setting dhcp_server_setting __setting = {
285         .name = "dhcp-server",
286         .description = "DHCP server address",
287         .tag = DHCP_SERVER_IDENTIFIER,
288         .type = &setting_type_ipv4,
289 };
290
291 /****************************************************************************
292  *
293  * DHCP session
294  *
295  */
296
297 /** DHCP session states */
298 enum dhcp_session_state {
299         /** Sending DHCPDISCOVERs, collecting DHCPOFFERs and ProxyDHCPOFFERs */
300         DHCP_STATE_DISCOVER = 0,
301         /** Sending DHCPREQUESTs, waiting for DHCPACK */
302         DHCP_STATE_REQUEST,
303         /** Sending ProxyDHCPREQUESTs, waiting for ProxyDHCPACK */
304         DHCP_STATE_PROXYREQUEST,
305         /** Sending BootServerDHCPREQUESTs, waiting for BootServerDHCPACK */
306         DHCP_STATE_BSREQUEST,
307 };
308
309 /**
310  * Name a DHCP session state
311  *
312  * @v state             DHCP session state
313  * @ret string          DHCP session state name
314  */
315 static inline const char * dhcp_state_name ( enum dhcp_session_state state ) {
316         switch ( state ) {
317         case DHCP_STATE_DISCOVER:       return "DHCPDISCOVER";
318         case DHCP_STATE_REQUEST:        return "DHCPREQUEST";
319         case DHCP_STATE_PROXYREQUEST:   return "ProxyDHCPREQUEST";
320         case DHCP_STATE_BSREQUEST:      return "BootServerREQUEST";
321         default:                        return "<invalid>";
322         }
323 }
324
325 /** A DHCP session */
326 struct dhcp_session {
327         /** Reference counter */
328         struct refcnt refcnt;
329         /** Job control interface */
330         struct job_interface job;
331         /** Data transfer interface */
332         struct xfer_interface xfer;
333
334         /** Network device being configured */
335         struct net_device *netdev;
336
337         /** State of the session
338          *
339          * This is a value for the @c DHCP_MESSAGE_TYPE option
340          * (e.g. @c DHCPDISCOVER).
341          */
342         enum dhcp_session_state state;
343         /** DHCPOFFER obtained during DHCPDISCOVER */
344         struct dhcp_settings *dhcpoffer;
345         /** ProxyDHCPOFFER obtained during DHCPDISCOVER */
346         struct dhcp_settings *proxydhcpoffer;
347         /** DHCPACK obtained during DHCPREQUEST */
348         struct dhcp_settings *dhcpack;
349         /** ProxyDHCPACK obtained during ProxyDHCPREQUEST */
350         struct dhcp_settings *proxydhcpack;
351         /** BootServerDHCPACK obtained during BootServerDHCPREQUEST */
352         struct dhcp_settings *bsdhcpack;
353         /** Retransmission timer */
354         struct retry_timer timer;
355         /** Start time of the current state (in ticks) */
356         unsigned long start;
357 };
358
359 /**
360  * Free DHCP session
361  *
362  * @v refcnt            Reference counter
363  */
364 static void dhcp_free ( struct refcnt *refcnt ) {
365         struct dhcp_session *dhcp =
366                 container_of ( refcnt, struct dhcp_session, refcnt );
367
368         netdev_put ( dhcp->netdev );
369         dhcpset_put ( dhcp->dhcpoffer );
370         dhcpset_put ( dhcp->proxydhcpoffer );
371         dhcpset_put ( dhcp->dhcpack );
372         dhcpset_put ( dhcp->proxydhcpack );
373         dhcpset_put ( dhcp->bsdhcpack );
374         free ( dhcp );
375 }
376
377 /**
378  * Mark DHCP session as complete
379  *
380  * @v dhcp              DHCP session
381  * @v rc                Return status code
382  */
383 static void dhcp_finished ( struct dhcp_session *dhcp, int rc ) {
384
385         /* Block futher incoming messages */
386         job_nullify ( &dhcp->job );
387         xfer_nullify ( &dhcp->xfer );
388
389         /* Stop retry timer */
390         stop_timer ( &dhcp->timer );
391
392         /* Free resources and close interfaces */
393         xfer_close ( &dhcp->xfer, rc );
394         job_done ( &dhcp->job, rc );
395 }
396
397 /****************************************************************************
398  *
399  * Data transfer interface
400  *
401  */
402
403 /**
404  * Create a DHCP packet
405  *
406  * @v dhcppkt           DHCP packet structure to fill in
407  * @v netdev            Network device
408  * @v msgtype           DHCP message type
409  * @v options           Initial options to include (or NULL)
410  * @v data              Buffer for DHCP packet
411  * @v max_len           Size of DHCP packet buffer
412  * @ret rc              Return status code
413  *
414  * Creates a DHCP packet in the specified buffer, and fills out a @c
415  * dhcp_packet structure.
416  */
417 int dhcp_create_packet ( struct dhcp_packet *dhcppkt,
418                          struct net_device *netdev, uint8_t msgtype,
419                          struct dhcp_options *options, 
420                          void *data, size_t max_len ) {
421         struct dhcphdr *dhcphdr = data;
422         size_t options_len;
423         unsigned int hlen;
424         int rc;
425
426         /* Sanity check */
427         options_len = ( options ? options->len : 0 );
428         if ( max_len < ( sizeof ( *dhcphdr ) + options_len ) )
429                 return -ENOSPC;
430
431         /* Initialise DHCP packet content */
432         memset ( dhcphdr, 0, max_len );
433         dhcphdr->xid = dhcp_xid ( netdev );
434         dhcphdr->magic = htonl ( DHCP_MAGIC_COOKIE );
435         dhcphdr->htype = ntohs ( netdev->ll_protocol->ll_proto );
436         dhcphdr->op = dhcp_op[msgtype];
437         /* If hardware length exceeds the chaddr field length, don't
438          * use the chaddr field.  This is as per RFC4390.
439          */
440         hlen = netdev->ll_protocol->ll_addr_len;
441         if ( hlen > sizeof ( dhcphdr->chaddr ) ) {
442                 hlen = 0;
443                 dhcphdr->flags = htons ( BOOTP_FL_BROADCAST );
444         }
445         dhcphdr->hlen = hlen;
446         memcpy ( dhcphdr->chaddr, netdev->ll_addr, hlen );
447         memcpy ( dhcphdr->options, options->data, options_len );
448
449         /* Initialise DHCP packet structure */
450         memset ( dhcppkt, 0, sizeof ( *dhcppkt ) );
451         dhcppkt_init ( dhcppkt, data, max_len );
452         
453         /* Set DHCP_MESSAGE_TYPE option */
454         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_MESSAGE_TYPE,
455                                     &msgtype, sizeof ( msgtype ) ) ) != 0 )
456                 return rc;
457
458         return 0;
459 }
460
461 /**
462  * Create DHCP request packet
463  *
464  * @v dhcppkt           DHCP packet structure to fill in
465  * @v netdev            Network device
466  * @v msgtype           DHCP message type
467  * @v ciaddr            Client IP address, if applicable
468  * @v server            Server identifier, if applicable
469  * @v requested_ip      Requested address, if applicable
470  * @v menu_item         PXE menu item, if applicable
471  * @v data              Buffer for DHCP packet
472  * @v max_len           Size of DHCP packet buffer
473  * @ret rc              Return status code
474  */
475 int dhcp_create_request ( struct dhcp_packet *dhcppkt,
476                           struct net_device *netdev, unsigned int msgtype,
477                           struct in_addr ciaddr, struct in_addr server,
478                           struct in_addr requested_ip,
479                           struct dhcp_pxe_boot_menu_item *menu_item,
480                           void *data, size_t max_len ) {
481         struct device_description *desc = &netdev->dev->desc;
482         struct dhcp_netdev_desc dhcp_desc;
483         struct dhcp_client_id client_id;
484         struct dhcp_client_uuid client_uuid;
485         size_t dhcp_features_len;
486         size_t ll_addr_len;
487         int rc;
488
489         /* Create DHCP packet */
490         if ( ( rc = dhcp_create_packet ( dhcppkt, netdev, msgtype,
491                                          &dhcp_request_options, data,
492                                          max_len ) ) != 0 ) {
493                 DBG ( "DHCP could not create DHCP packet: %s\n",
494                       strerror ( rc ) );
495                 return rc;
496         }
497
498         /* Set client IP address */
499         dhcppkt->dhcphdr->ciaddr = ciaddr;
500
501         /* Set server ID, if present */
502         if ( server.s_addr &&
503              ( ( rc = dhcppkt_store ( dhcppkt, DHCP_SERVER_IDENTIFIER,
504                                       &server, sizeof ( server ) ) ) != 0 ) ) {
505                         DBG ( "DHCP could not set server ID: %s\n",
506                               strerror ( rc ) );
507                         return rc;
508         }
509
510         /* Set requested IP address, if present */
511         if ( requested_ip.s_addr &&
512              ( ( rc = dhcppkt_store ( dhcppkt, DHCP_REQUESTED_ADDRESS,
513                                       &requested_ip,
514                                       sizeof ( requested_ip ) ) ) != 0 ) ) {
515                 DBG ( "DHCP could not set requested address: %s\n",
516                       strerror ( rc ) );
517                 return rc;
518         }
519
520         /* Add options to identify the feature list */
521         dhcp_features_len = ( dhcp_features_end - dhcp_features );
522         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_EB_ENCAP, dhcp_features,
523                                     dhcp_features_len ) ) != 0 ) {
524                 DBG ( "DHCP could not set features list option: %s\n",
525                       strerror ( rc ) );
526                 return rc;
527         }
528
529         /* Add options to identify the network device */
530         dhcp_desc.type = desc->bus_type;
531         dhcp_desc.vendor = htons ( desc->vendor );
532         dhcp_desc.device = htons ( desc->device );
533         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_EB_BUS_ID, &dhcp_desc,
534                                     sizeof ( dhcp_desc ) ) ) != 0 ) {
535                 DBG ( "DHCP could not set bus ID option: %s\n",
536                       strerror ( rc ) );
537                 return rc;
538         }
539
540         /* Add DHCP client identifier.  Required for Infiniband, and
541          * doesn't hurt other link layers.
542          */
543         client_id.ll_proto = ntohs ( netdev->ll_protocol->ll_proto );
544         ll_addr_len = netdev->ll_protocol->ll_addr_len;
545         assert ( ll_addr_len <= sizeof ( client_id.ll_addr ) );
546         memcpy ( client_id.ll_addr, netdev->ll_addr, ll_addr_len );
547         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_CLIENT_ID, &client_id,
548                                     ( ll_addr_len + 1 ) ) ) != 0 ) {
549                 DBG ( "DHCP could not set client ID: %s\n",
550                       strerror ( rc ) );
551                 return rc;
552         }
553
554         /* Add client UUID, if we have one.  Required for PXE. */
555         client_uuid.type = DHCP_CLIENT_UUID_TYPE;
556         if ( ( rc = fetch_uuid_setting ( NULL, &uuid_setting,
557                                          &client_uuid.uuid ) ) >= 0 ) {
558                 if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_CLIENT_UUID,
559                                             &client_uuid,
560                                             sizeof ( client_uuid ) ) ) != 0 ) {
561                         DBG ( "DHCP could not set client UUID: %s\n",
562                               strerror ( rc ) );
563                         return rc;
564                 }
565         }
566
567         /* Set PXE boot menu item, if present */
568         if ( menu_item && menu_item->type &&
569              ( ( rc = dhcppkt_store ( dhcppkt, DHCP_PXE_BOOT_MENU_ITEM,
570                                       menu_item,
571                                       sizeof ( *menu_item ) ) ) != 0 ) ) {
572                 DBG ( "DHCP could not set PXE menu item: %s\n",
573                       strerror ( rc ) );
574                 return rc;
575         }
576
577         return 0;
578 }
579
580 /**
581  * Transmit DHCP request
582  *
583  * @v dhcp              DHCP session
584  * @ret rc              Return status code
585  */
586 static int dhcp_tx ( struct dhcp_session *dhcp ) {
587         static struct sockaddr_in dest = {
588                 .sin_family = AF_INET,
589                 .sin_port = htons ( PROXYDHCP_PORT ),
590         };
591         static struct sockaddr_in src = {
592                 .sin_family = AF_INET,
593                 .sin_port = htons ( BOOTPC_PORT ),
594         };
595         struct xfer_metadata meta = {
596                 .netdev = dhcp->netdev,
597         };
598         struct io_buffer *iobuf;
599         struct dhcp_packet dhcppkt;
600         struct in_addr ciaddr = { 0 };
601         struct in_addr server = { 0 };
602         struct in_addr requested_ip = { 0 };
603         struct dhcp_pxe_boot_menu_item menu_item = { 0, 0 };
604         unsigned int msgtype;
605         int rc;
606
607         /* Start retry timer.  Do this first so that failures to
608          * transmit will be retried.
609          */
610         start_timer ( &dhcp->timer );
611
612         /* Determine packet contents based on current state */
613         switch ( dhcp->state ) {
614         case DHCP_STATE_DISCOVER:
615                 msgtype = DHCPDISCOVER;
616                 break;
617         case DHCP_STATE_REQUEST:
618                 assert ( dhcp->dhcpoffer );
619                 msgtype = DHCPREQUEST;
620                 dhcppkt_fetch ( &dhcp->dhcpoffer->dhcppkt,
621                                 DHCP_SERVER_IDENTIFIER, &server,
622                                 sizeof ( server ) );
623                 requested_ip = dhcp->dhcpoffer->dhcppkt.dhcphdr->yiaddr;
624                 break;
625         case DHCP_STATE_PROXYREQUEST:
626                 assert ( dhcp->dhcpoffer );
627                 assert ( dhcp->proxydhcpoffer );
628                 assert ( dhcp->dhcpack );
629                 msgtype = DHCPREQUEST;
630                 ciaddr = dhcp->dhcpoffer->dhcppkt.dhcphdr->yiaddr;
631                 dhcppkt_fetch ( &dhcp->proxydhcpoffer->dhcppkt,
632                                 DHCP_SERVER_IDENTIFIER, &dest.sin_addr,
633                                 sizeof ( dest.sin_addr ) );
634                 meta.dest = ( struct sockaddr * ) &dest;
635                 server = dest.sin_addr;
636                 assert ( dest.sin_addr.s_addr );
637                 assert ( ciaddr.s_addr );
638                 break;
639         case DHCP_STATE_BSREQUEST:
640                 assert ( dhcp->dhcpoffer );
641                 assert ( dhcp->proxydhcpoffer );
642                 assert ( dhcp->dhcpack );
643                 assert ( dhcp->proxydhcpack );
644                 msgtype = DHCPREQUEST;
645                 ciaddr = dhcp->dhcpoffer->dhcppkt.dhcphdr->yiaddr;
646                 dhcppkt_fetch ( &dhcp->proxydhcpack->dhcppkt,
647                                 DHCP_PXE_BOOT_SERVER_MCAST,
648                                 &dest.sin_addr, sizeof ( dest.sin_addr ) );
649                 meta.dest = ( struct sockaddr * ) &dest;
650                 dhcppkt_fetch ( &dhcp->proxydhcpack->dhcppkt,
651                                 DHCP_PXE_BOOT_MENU, &menu_item.type,
652                                 sizeof ( menu_item.type ) );
653                 assert ( dest.sin_addr.s_addr );
654                 assert ( menu_item.type );
655                 assert ( ciaddr.s_addr );
656                 break;
657         default:
658                 assert ( 0 );
659                 return -EINVAL;
660         }
661
662         DBGC ( dhcp, "DHCP %p %s", dhcp, dhcp_msgtype_name ( msgtype ) );
663         if ( server.s_addr )
664                 DBGC ( dhcp, " to %s", inet_ntoa ( server ) );
665         if ( meta.dest ) {
666                 if ( dest.sin_addr.s_addr == server.s_addr ) {
667                         DBGC ( dhcp, ":%d (unicast)",
668                                ntohs ( dest.sin_port ) );
669                 } else {
670                         DBGC ( dhcp, " via %s:%d", inet_ntoa ( dest.sin_addr ),
671                                ntohs ( dest.sin_port ) );
672                 }
673         } else {
674                 DBGC ( dhcp, " (broadcast)" );
675         }
676         if ( requested_ip.s_addr )
677                 DBGC ( dhcp, " for %s", inet_ntoa ( requested_ip ) );
678         if ( menu_item.type )
679                 DBGC ( dhcp, " for item %04x", ntohs ( menu_item.type ) );
680         DBGC ( dhcp, "\n" );
681
682         /* Allocate buffer for packet */
683         iobuf = xfer_alloc_iob ( &dhcp->xfer, DHCP_MIN_LEN );
684         if ( ! iobuf )
685                 return -ENOMEM;
686
687         /* Create DHCP packet in temporary buffer */
688         if ( ( rc = dhcp_create_request ( &dhcppkt, dhcp->netdev, msgtype,
689                                           ciaddr, server, requested_ip,
690                                           &menu_item, iobuf->data,
691                                           iob_tailroom ( iobuf ) ) ) != 0 ) {
692                 DBGC ( dhcp, "DHCP %p could not construct DHCP request: %s\n",
693                        dhcp, strerror ( rc ) );
694                 goto done;
695         }
696
697         /* Explicitly specify source address, if available. */
698         if ( ciaddr.s_addr ) {
699                 src.sin_addr = ciaddr;
700                 meta.src = ( struct sockaddr * ) &src;
701         }
702
703         /* Transmit the packet */
704         iob_put ( iobuf, dhcppkt.len );
705         rc = xfer_deliver_iob_meta ( &dhcp->xfer, iobuf, &meta );
706         iobuf = NULL;
707         if ( rc != 0 ) {
708                 DBGC ( dhcp, "DHCP %p could not transmit UDP packet: %s\n",
709                        dhcp, strerror ( rc ) );
710                 goto done;
711         }
712
713  done:
714         free_iob ( iobuf );
715         return rc;
716 }
717
718 /**
719  * Transition to new DHCP session state
720  *
721  * @v dhcp              DHCP session
722  * @v state             New session state
723  */
724 static void dhcp_set_state ( struct dhcp_session *dhcp,
725                              enum dhcp_session_state state ) {
726         DBGC ( dhcp, "DHCP %p entering %s state\n",
727                dhcp, dhcp_state_name ( state ) );
728         dhcp->state = state;
729         dhcp->start = currticks();
730         dhcp->timer.min_timeout = 0;
731         start_timer_nodelay ( &dhcp->timer );
732 }
733
734 /**
735  * Transition to next DHCP state
736  *
737  * @v dhcp              DHCP session
738  */
739 static void dhcp_next_state ( struct dhcp_session *dhcp ) {
740         struct in_addr bs_mcast = { 0 };
741
742         switch ( dhcp->state ) {
743         case DHCP_STATE_DISCOVER:
744                 dhcp_set_state ( dhcp, DHCP_STATE_REQUEST );
745                 break;
746         case DHCP_STATE_REQUEST:
747                 if ( dhcp->proxydhcpoffer ) {
748                         dhcp_set_state ( dhcp, DHCP_STATE_PROXYREQUEST );
749                         break;
750                 }
751                 /* Fall through */
752         case DHCP_STATE_PROXYREQUEST:
753                 if ( dhcp->proxydhcpack ) {
754                         dhcppkt_fetch ( &dhcp->proxydhcpack->dhcppkt,
755                                         DHCP_PXE_BOOT_SERVER_MCAST,
756                                         &bs_mcast, sizeof ( bs_mcast ) );
757                         if ( bs_mcast.s_addr ) {
758                                 dhcp_set_state ( dhcp, DHCP_STATE_BSREQUEST );
759                                 break;
760                         }
761                 }
762                 /* Fall through */
763         case DHCP_STATE_BSREQUEST:
764                 dhcp_finished ( dhcp, 0 );
765                 break;
766         default:
767                 assert ( 0 );
768                 return;
769         }
770
771 }
772
773 /**
774  * Store received DHCPOFFER
775  *
776  * @v dhcp              DHCP session
777  * @v dhcpoffer         Received DHCPOFFER
778  * @v stored_dhcpoffer  Location to store DHCPOFFER
779  *
780  * The DHCPOFFER will be stored in place of the existing stored
781  * DHCPOFFER if its priority is equal to or greater than the stored
782  * DHCPOFFER.
783  */
784 static void dhcp_store_dhcpoffer ( struct dhcp_session *dhcp,
785                                    struct dhcp_settings *dhcpoffer,
786                                    struct dhcp_settings **stored_dhcpoffer ) {
787         uint8_t stored_priority = 0;
788         uint8_t priority = 0;
789
790         /* Get priorities of the two DHCPOFFERs */
791         if ( *stored_dhcpoffer ) {
792                 dhcppkt_fetch ( &(*stored_dhcpoffer)->dhcppkt,
793                                 DHCP_EB_PRIORITY, &stored_priority,
794                                 sizeof ( stored_priority ) );
795         }
796         dhcppkt_fetch ( &dhcpoffer->dhcppkt, DHCP_EB_PRIORITY, &priority,
797                         sizeof ( priority ) );
798
799         /* Replace stored offer only if priority is equal or greater */
800         if ( priority >= stored_priority ) {
801                 if ( *stored_dhcpoffer ) {
802                         DBGC ( dhcp, "DHCP %p stored DHCPOFFER %p discarded\n",
803                                dhcp, *stored_dhcpoffer );
804                 }
805                 DBGC ( dhcp, "DHCP %p DHCPOFFER %p stored\n",
806                        dhcp, dhcpoffer );
807                 dhcpset_put ( *stored_dhcpoffer );
808                 *stored_dhcpoffer = dhcpset_get ( dhcpoffer );
809         }
810 }
811
812 /**
813  * Handle received DHCPOFFER
814  *
815  * @v dhcp              DHCP session
816  * @v dhcpoffer         Received DHCPOFFER
817  */
818 static void dhcp_rx_dhcpoffer ( struct dhcp_session *dhcp,
819                                 struct dhcp_settings *dhcpoffer ) {
820         struct in_addr server_id = { 0 };
821         char vci[9]; /* "PXEClient" */
822         int len;
823         uint8_t ignore_proxy = 0;
824         unsigned long elapsed;
825
826         /* Check for presence of DHCP server ID */
827         if ( dhcppkt_fetch ( &dhcpoffer->dhcppkt, DHCP_SERVER_IDENTIFIER,
828                              &server_id, sizeof ( server_id ) )
829              != sizeof ( server_id ) ) {
830                 DBGC ( dhcp, "DHCP %p DHCPOFFER %p missing server ID\n",
831                        dhcp, dhcpoffer );
832                 /* Could be a valid BOOTP offer; do not abort processing */
833         }
834
835         /* If there is an IP address, it's a normal DHCPOFFER */
836         if ( dhcpoffer->dhcppkt.dhcphdr->yiaddr.s_addr != 0 ) {
837                 DBGC ( dhcp, "DHCP %p DHCPOFFER %p from %s",
838                        dhcp, dhcpoffer, inet_ntoa ( server_id ) );
839                 DBGC ( dhcp, " has IP %s\n",
840                        inet_ntoa ( dhcpoffer->dhcppkt.dhcphdr->yiaddr ) );
841                 dhcp_store_dhcpoffer ( dhcp, dhcpoffer, &dhcp->dhcpoffer );
842         }
843
844         /* If there is a "PXEClient" vendor class ID, it's a
845          * ProxyDHCPOFFER.  Note that it could be both a normal
846          * DHCPOFFER and a ProxyDHCPOFFER.
847          */
848         len = dhcppkt_fetch ( &dhcpoffer->dhcppkt, DHCP_VENDOR_CLASS_ID,
849                               vci, sizeof ( vci ) );
850         if ( ( server_id.s_addr != 0 ) &&
851              ( len >= ( int ) sizeof ( vci ) ) &&
852              ( strncmp ( "PXEClient", vci, sizeof ( vci ) ) == 0 ) ) {
853                 DBGC ( dhcp, "DHCP %p DHCPOFFER %p from %s is a "
854                        "ProxyDHCPOFFER\n",
855                        dhcp, dhcpoffer, inet_ntoa ( server_id ) );
856                 dhcp_store_dhcpoffer ( dhcp, dhcpoffer,
857                                        &dhcp->proxydhcpoffer );
858         }
859
860         /* We can transition to making the DHCPREQUEST when we have a
861          * valid DHCPOFFER, and either:
862          *
863          *  o  The DHCPOFFER instructs us to not wait for ProxyDHCP, or
864          *  o  We have a valid ProxyDHCPOFFER, or
865          *  o  We have allowed sufficient time for ProxyDHCPOFFERs.
866          */
867
868         /* If we don't yet have a DHCPOFFER, do nothing */
869         if ( ! dhcp->dhcpoffer )
870                 return;
871
872         /* If the DHCPOFFER instructs us to ignore ProxyDHCP, discard
873          * any ProxyDHCPOFFER
874          */
875         dhcppkt_fetch ( &dhcp->dhcpoffer->dhcppkt, DHCP_EB_NO_PROXYDHCP,
876                         &ignore_proxy, sizeof ( ignore_proxy ) );
877         if ( ignore_proxy && dhcp->proxydhcpoffer ) {
878                 DBGC ( dhcp, "DHCP %p discarding ProxyDHCPOFFER\n", dhcp );
879                 dhcpset_put ( dhcp->proxydhcpoffer );
880                 dhcp->proxydhcpoffer = NULL;
881         }
882
883         /* If we can't yet transition to DHCPREQUEST, do nothing */
884         elapsed = ( currticks() - dhcp->start );
885         if ( ! ( ignore_proxy || dhcp->proxydhcpoffer ||
886                  ( elapsed > PROXYDHCP_WAIT_TIME ) ) )
887                 return;
888
889         /* Transition to DHCPREQUEST */
890         dhcp_next_state ( dhcp );
891 }
892
893 /**
894  * Store received DHCPACK
895  *
896  * @v dhcp              DHCP session
897  * @v dhcpack           Received DHCPACK
898  *
899  * The DHCPACK will be registered as a settings block.
900  */
901 static int dhcp_store_dhcpack ( struct dhcp_session *dhcp,
902                                 struct dhcp_settings *dhcpack,
903                                 struct settings *parent ) {
904         struct settings *settings = &dhcpack->settings;
905         struct settings *old_settings;
906         int rc;
907
908         /* Unregister any old settings obtained via DHCP */
909         if ( ( old_settings = find_child_settings ( parent, settings->name ) ))
910                 unregister_settings ( old_settings );
911
912         /* Register new settings */
913         if ( ( rc = register_settings ( settings, parent ) ) != 0 ) {
914                 DBGC ( dhcp, "DHCP %p could not register settings: %s\n",
915                        dhcp, strerror ( rc ) );
916                 dhcp_finished ( dhcp, rc ); /* This is a fatal error */
917                 return rc;
918         }
919
920         return 0;
921 }
922
923 /**
924  * Handle received DHCPACK
925  *
926  * @v dhcp              DHCP session
927  * @v dhcpack           Received DHCPACK
928  */
929 static void dhcp_rx_dhcpack ( struct dhcp_session *dhcp,
930                               struct dhcp_settings *dhcpack ) {
931         struct settings *parent;
932         struct in_addr offer_server_id = { 0 };
933         struct in_addr ack_server_id = { 0 };
934         int rc;
935
936         /* Verify server ID matches */
937         assert ( dhcp->dhcpoffer != NULL );
938         dhcppkt_fetch ( &dhcp->dhcpoffer->dhcppkt, DHCP_SERVER_IDENTIFIER,
939                         &offer_server_id, sizeof ( offer_server_id ) );
940         dhcppkt_fetch ( &dhcpack->dhcppkt, DHCP_SERVER_IDENTIFIER,
941                         &ack_server_id, sizeof ( ack_server_id ) );
942         if ( offer_server_id.s_addr != ack_server_id.s_addr ) {
943                 DBGC ( dhcp, "DHCP %p ignoring DHCPACK with wrong server ID "
944                        "%s\n", dhcp, inet_ntoa ( ack_server_id ) );
945                 return;
946         }
947
948         /* Record DHCPACK */
949         assert ( dhcp->dhcpack == NULL );
950         dhcp->dhcpack = dhcpset_get ( dhcpack );
951
952         /* Register settings */
953         parent = netdev_settings ( dhcp->netdev );
954         if ( ( rc = dhcp_store_dhcpack ( dhcp, dhcpack, parent ) ) != 0 )
955                 return;
956
957         /* Transition to next state */
958         dhcp_next_state ( dhcp );
959 }
960
961 /**
962  * Handle received ProxyDHCPACK
963  *
964  * @v dhcp              DHCP session
965  * @v proxydhcpack      Received ProxyDHCPACK
966  */
967 static void dhcp_rx_proxydhcpack ( struct dhcp_session *dhcp,
968                                    struct dhcp_settings *proxydhcpack ) {
969         struct in_addr offer_server_id = { 0 };
970         struct in_addr ack_server_id = { 0 };
971         int rc;
972
973         /* Verify server ID matches, if present */
974         assert ( dhcp->proxydhcpoffer != NULL );
975         if ( ( rc = dhcppkt_fetch ( &proxydhcpack->dhcppkt,
976                                     DHCP_SERVER_IDENTIFIER, &ack_server_id,
977                                     sizeof ( ack_server_id ) ) ) > 0 ) {
978                 dhcppkt_fetch ( &dhcp->proxydhcpoffer->dhcppkt,
979                                 DHCP_SERVER_IDENTIFIER, &offer_server_id,
980                                 sizeof ( offer_server_id ) );
981                 if ( offer_server_id.s_addr != ack_server_id.s_addr ) {
982                         DBGC ( dhcp, "DHCP %p ignoring ProxyDHCPACK with "
983                                "wrong server ID %s\n",
984                                dhcp, inet_ntoa ( ack_server_id ) );
985                         return;
986                 }
987         }
988
989         /* Rename settings */
990         proxydhcpack->settings.name = PROXYDHCP_SETTINGS_NAME;
991
992         /* Record ProxyDHCPACK */
993         assert ( dhcp->proxydhcpack == NULL );
994         dhcp->proxydhcpack = dhcpset_get ( proxydhcpack );
995
996         /* Register settings */
997         if ( ( rc = dhcp_store_dhcpack ( dhcp, proxydhcpack, NULL ) ) != 0 )
998                 return;
999
1000         /* Transition to next state */
1001         dhcp_next_state ( dhcp );
1002 }
1003
1004 /**
1005  * Handle received BootServerDHCPACK
1006  *
1007  * @v dhcp              DHCP session
1008  * @v bsdhcpack Received BootServerDHCPACK
1009  */
1010 static void dhcp_rx_bsdhcpack ( struct dhcp_session *dhcp,
1011                                 struct dhcp_settings *bsdhcpack ) {
1012         int rc;
1013
1014         /* Rename settings */
1015         bsdhcpack->settings.name = BSDHCP_SETTINGS_NAME;
1016
1017         /* Record ProxyDHCPACK */
1018         assert ( dhcp->bsdhcpack == NULL );
1019         dhcp->bsdhcpack = dhcpset_get ( bsdhcpack );
1020
1021         /* Register settings */
1022         if ( ( rc = dhcp_store_dhcpack ( dhcp, bsdhcpack, NULL ) ) != 0 )
1023                 return;
1024
1025         /* Transition to next state */
1026         dhcp_next_state ( dhcp );
1027 }
1028
1029 /**
1030  * Receive new data
1031  *
1032  * @v xfer              Data transfer interface
1033  * @v iobuf             I/O buffer
1034  * @v meta              Transfer metadata
1035  * @ret rc              Return status code
1036  */
1037 static int dhcp_deliver_iob ( struct xfer_interface *xfer,
1038                               struct io_buffer *iobuf,
1039                               struct xfer_metadata *meta ) {
1040         struct dhcp_session *dhcp =
1041                 container_of ( xfer, struct dhcp_session, xfer );
1042         struct sockaddr_in *sin_src;
1043         unsigned int src_port;
1044         struct dhcp_settings *dhcpset;
1045         struct dhcphdr *dhcphdr;
1046         uint8_t msgtype = 0;
1047         int rc = 0;
1048
1049         /* Sanity checks */
1050         if ( ! meta ) {
1051                 DBGC ( dhcp, "DHCP %p received packet without metadata\n",
1052                        dhcp );
1053                 rc = -EINVAL;
1054                 goto err_no_meta;
1055         }
1056         if ( ! meta->src ) {
1057                 DBGC ( dhcp, "DHCP %p received packet without source port\n",
1058                        dhcp );
1059                 rc = -EINVAL;
1060                 goto err_no_src;
1061         }
1062         sin_src = ( struct sockaddr_in * ) meta->src;
1063         src_port = sin_src->sin_port;
1064
1065         /* Convert packet into a DHCP settings block */
1066         dhcpset = dhcpset_create ( iobuf->data, iob_len ( iobuf ) );
1067         if ( ! dhcpset ) {
1068                 DBGC ( dhcp, "DHCP %p could not store DHCP packet\n", dhcp );
1069                 rc = -ENOMEM;
1070                 goto err_dhcpset_create;
1071         }
1072         dhcphdr = dhcpset->dhcppkt.dhcphdr;
1073
1074         /* Identify message type */
1075         dhcppkt_fetch ( &dhcpset->dhcppkt, DHCP_MESSAGE_TYPE, &msgtype,
1076                         sizeof ( msgtype ) );
1077         DBGC ( dhcp, "DHCP %p %s %p from %s:%d\n", dhcp,
1078                dhcp_msgtype_name ( msgtype ), dhcpset,
1079                inet_ntoa ( sin_src->sin_addr ), ntohs ( src_port ) );
1080
1081         /* Check for matching transaction ID */
1082         if ( dhcphdr->xid != dhcp_xid ( dhcp->netdev ) ) {
1083                 DBGC ( dhcp, "DHCP %p %s %p has bad transaction ID\n",
1084                        dhcp, dhcp_msgtype_name ( msgtype ), dhcpset );
1085                 rc = -EINVAL;
1086                 goto err_xid;
1087         };
1088
1089         /* Handle packet based on current state */
1090         switch ( dhcp->state ) {
1091         case DHCP_STATE_DISCOVER:
1092                 if ( ( ( msgtype == DHCPOFFER ) || ( msgtype == DHCPNONE ) ) &&
1093                      ( src_port == htons ( BOOTPS_PORT ) ) )
1094                         dhcp_rx_dhcpoffer ( dhcp, dhcpset );
1095                 break;
1096         case DHCP_STATE_REQUEST:
1097                 if ( ( ( msgtype == DHCPACK ) || ( msgtype == DHCPNONE ) ) &&
1098                      ( src_port == htons ( BOOTPS_PORT ) ) )
1099                         dhcp_rx_dhcpack ( dhcp, dhcpset );
1100                 break;
1101         case DHCP_STATE_PROXYREQUEST:
1102                 if ( ( msgtype == DHCPACK ) &&
1103                      ( src_port == htons ( PROXYDHCP_PORT ) ) )
1104                         dhcp_rx_proxydhcpack ( dhcp, dhcpset );
1105                 break;
1106         case DHCP_STATE_BSREQUEST:
1107                 if ( ( msgtype == DHCPACK ) &&
1108                      ( src_port == htons ( PROXYDHCP_PORT ) ) )
1109                         dhcp_rx_bsdhcpack ( dhcp, dhcpset );
1110                 break;
1111         default:
1112                 assert ( 0 );
1113                 break;
1114         }
1115
1116  err_xid:
1117         dhcpset_put ( dhcpset );
1118  err_dhcpset_create:
1119  err_no_src:
1120  err_no_meta:
1121         free_iob ( iobuf );
1122         return rc;
1123 }
1124
1125 /** DHCP data transfer interface operations */
1126 static struct xfer_interface_operations dhcp_xfer_operations = {
1127         .close          = ignore_xfer_close,
1128         .vredirect      = xfer_vopen,
1129         .window         = unlimited_xfer_window,
1130         .alloc_iob      = default_xfer_alloc_iob,
1131         .deliver_iob    = dhcp_deliver_iob,
1132         .deliver_raw    = xfer_deliver_as_iob,
1133 };
1134
1135 /**
1136  * Handle DHCP retry timer expiry
1137  *
1138  * @v timer             DHCP retry timer
1139  * @v fail              Failure indicator
1140  */
1141 static void dhcp_timer_expired ( struct retry_timer *timer, int fail ) {
1142         struct dhcp_session *dhcp =
1143                 container_of ( timer, struct dhcp_session, timer );
1144         unsigned long elapsed = ( currticks() - dhcp->start );
1145
1146         /* If we have failed, terminate DHCP */
1147         if ( fail ) {
1148                 dhcp_finished ( dhcp, -ETIMEDOUT );
1149                 return;
1150         }
1151
1152         /* Give up waiting for ProxyDHCP before we reach the failure point */
1153         if ( dhcp->dhcpoffer && ( elapsed > PROXYDHCP_WAIT_TIME ) ) {
1154                 dhcp_next_state ( dhcp );
1155                 return;
1156         }
1157
1158         /* Otherwise, retransmit current packet */
1159         dhcp_tx ( dhcp );
1160 }
1161
1162 /****************************************************************************
1163  *
1164  * Job control interface
1165  *
1166  */
1167
1168 /**
1169  * Handle kill() event received via job control interface
1170  *
1171  * @v job               DHCP job control interface
1172  */
1173 static void dhcp_job_kill ( struct job_interface *job ) {
1174         struct dhcp_session *dhcp =
1175                 container_of ( job, struct dhcp_session, job );
1176
1177         /* Terminate DHCP session */
1178         dhcp_finished ( dhcp, -ECANCELED );
1179 }
1180
1181 /** DHCP job control interface operations */
1182 static struct job_interface_operations dhcp_job_operations = {
1183         .done           = ignore_job_done,
1184         .kill           = dhcp_job_kill,
1185         .progress       = ignore_job_progress,
1186 };
1187
1188 /****************************************************************************
1189  *
1190  * Instantiator
1191  *
1192  */
1193
1194 /**
1195  * Start DHCP on a network device
1196  *
1197  * @v job               Job control interface
1198  * @v netdev            Network device
1199  * @v register_options  DHCP option block registration routine
1200  * @ret rc              Return status code
1201  *
1202  * Starts DHCP on the specified network device.  If successful, the @c
1203  * register_options() routine will be called with the acquired
1204  * options.
1205  */
1206 int start_dhcp ( struct job_interface *job, struct net_device *netdev ) {
1207         static struct sockaddr_in server = {
1208                 .sin_family = AF_INET,
1209                 .sin_addr.s_addr = INADDR_BROADCAST,
1210                 .sin_port = htons ( BOOTPS_PORT ),
1211         };
1212         static struct sockaddr_in client = {
1213                 .sin_family = AF_INET,
1214                 .sin_port = htons ( BOOTPC_PORT ),
1215         };
1216         struct dhcp_session *dhcp;
1217         int rc;
1218
1219         /* Allocate and initialise structure */
1220         dhcp = zalloc ( sizeof ( *dhcp ) );
1221         if ( ! dhcp )
1222                 return -ENOMEM;
1223         dhcp->refcnt.free = dhcp_free;
1224         job_init ( &dhcp->job, &dhcp_job_operations, &dhcp->refcnt );
1225         xfer_init ( &dhcp->xfer, &dhcp_xfer_operations, &dhcp->refcnt );
1226         dhcp->netdev = netdev_get ( netdev );
1227         dhcp->timer.expired = dhcp_timer_expired;
1228         dhcp->timer.min_timeout = DHCP_MIN_TIMEOUT;
1229         dhcp->timer.max_timeout = DHCP_MAX_TIMEOUT;
1230         dhcp->start = currticks();
1231
1232         /* Instantiate child objects and attach to our interfaces */
1233         if ( ( rc = xfer_open_socket ( &dhcp->xfer, SOCK_DGRAM,
1234                                        ( struct sockaddr * ) &server,
1235                                        ( struct sockaddr * ) &client ) ) != 0 )
1236                 goto err;
1237
1238         /* Start timer to initiate initial DHCPREQUEST */
1239         start_timer_nodelay ( &dhcp->timer );
1240
1241         /* Attach parent interface, mortalise self, and return */
1242         job_plug_plug ( &dhcp->job, job );
1243         ref_put ( &dhcp->refcnt );
1244         return 0;
1245
1246  err:
1247         dhcp_finished ( dhcp, rc );
1248         ref_put ( &dhcp->refcnt );
1249         return rc;
1250 }