[dhcp] Use a default user-class of "gPXE"
[people/asdlkf/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 <ctype.h>
23 #include <errno.h>
24 #include <assert.h>
25 #include <byteswap.h>
26 #include <gpxe/if_ether.h>
27 #include <gpxe/netdevice.h>
28 #include <gpxe/device.h>
29 #include <gpxe/xfer.h>
30 #include <gpxe/open.h>
31 #include <gpxe/job.h>
32 #include <gpxe/retry.h>
33 #include <gpxe/tcpip.h>
34 #include <gpxe/ip.h>
35 #include <gpxe/uuid.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 struct dhcp_session;
50 static int dhcp_tx ( struct dhcp_session *dhcp );
51
52 /**
53  * DHCP operation types
54  *
55  * This table maps from DHCP message types (i.e. values of the @c
56  * DHCP_MESSAGE_TYPE option) to values of the "op" field within a DHCP
57  * packet.
58  */
59 static const uint8_t dhcp_op[] = {
60         [DHCPDISCOVER]  = BOOTP_REQUEST,
61         [DHCPOFFER]     = BOOTP_REPLY,
62         [DHCPREQUEST]   = BOOTP_REQUEST,
63         [DHCPDECLINE]   = BOOTP_REQUEST,
64         [DHCPACK]       = BOOTP_REPLY,
65         [DHCPNAK]       = BOOTP_REPLY,
66         [DHCPRELEASE]   = BOOTP_REQUEST,
67         [DHCPINFORM]    = BOOTP_REQUEST,
68 };
69
70 /** Raw option data for options common to all DHCP requests */
71 static uint8_t dhcp_request_options_data[] = {
72         DHCP_MAX_MESSAGE_SIZE,
73         DHCP_WORD ( ETH_MAX_MTU - 20 /* IP header */ - 8 /* UDP header */ ),
74         DHCP_CLIENT_ARCHITECTURE, DHCP_WORD ( 0 ),
75         DHCP_CLIENT_NDI, DHCP_OPTION ( 1 /* UNDI */ , 2, 1 /* v2.1 */ ),
76         DHCP_VENDOR_CLASS_ID,
77         DHCP_STRING (  'P', 'X', 'E', 'C', 'l', 'i', 'e', 'n', 't', ':',
78                        'A', 'r', 'c', 'h', ':', '0', '0', '0', '0', '0', ':',
79                        'U', 'N', 'D', 'I', ':', '0', '0', '2', '0', '0', '1' ),
80         DHCP_USER_CLASS_ID,
81         DHCP_STRING ( 'g', 'P', 'X', 'E' ),
82         DHCP_PARAMETER_REQUEST_LIST,
83         DHCP_OPTION ( DHCP_SUBNET_MASK, DHCP_ROUTERS, DHCP_DNS_SERVERS,
84                       DHCP_LOG_SERVERS, DHCP_HOST_NAME, DHCP_DOMAIN_NAME,
85                       DHCP_ROOT_PATH, DHCP_VENDOR_ENCAP, DHCP_VENDOR_CLASS_ID,
86                       DHCP_TFTP_SERVER_NAME, DHCP_BOOTFILE_NAME,
87                       DHCP_EB_ENCAP, DHCP_ISCSI_INITIATOR_IQN ),
88         DHCP_END
89 };
90
91 /** DHCP feature codes */
92 static uint8_t dhcp_features[0] __table_start ( uint8_t, dhcp_features );
93 static uint8_t dhcp_features_end[0] __table_end ( uint8_t, dhcp_features );
94
95 /** Version number feature */
96 FEATURE_VERSION ( VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH );
97
98 /** DHCP server address setting */
99 struct setting dhcp_server_setting __setting = {
100         .name = "dhcp-server",
101         .description = "DHCP server address",
102         .tag = DHCP_SERVER_IDENTIFIER,
103         .type = &setting_type_ipv4,
104 };
105
106 /** DHCP user class setting */
107 struct setting user_class_setting __setting = {
108         .name = "user-class",
109         .description = "User class identifier",
110         .tag = DHCP_USER_CLASS_ID,
111         .type = &setting_type_string,
112 };
113
114 /**
115  * Name a DHCP packet type
116  *
117  * @v msgtype           DHCP message type
118  * @ret string          DHCP mesasge type name
119  */
120 static inline const char * dhcp_msgtype_name ( unsigned int msgtype ) {
121         switch ( msgtype ) {
122         case DHCPNONE:          return "BOOTP"; /* Non-DHCP packet */
123         case DHCPDISCOVER:      return "DHCPDISCOVER";
124         case DHCPOFFER:         return "DHCPOFFER";
125         case DHCPREQUEST:       return "DHCPREQUEST";
126         case DHCPDECLINE:       return "DHCPDECLINE";
127         case DHCPACK:           return "DHCPACK";
128         case DHCPNAK:           return "DHCPNAK";
129         case DHCPRELEASE:       return "DHCPRELEASE";
130         case DHCPINFORM:        return "DHCPINFORM";
131         default:                return "DHCP<invalid>";
132         }
133 }
134
135 /**
136  * Calculate DHCP transaction ID for a network device
137  *
138  * @v netdev            Network device
139  * @ret xid             DHCP XID
140  *
141  * Extract the least significant bits of the hardware address for use
142  * as the transaction ID.
143  */
144 static uint32_t dhcp_xid ( struct net_device *netdev ) {
145         uint32_t xid;
146
147         memcpy ( &xid, ( netdev->ll_addr + netdev->ll_protocol->ll_addr_len
148                          - sizeof ( xid ) ), sizeof ( xid ) );
149         return xid;
150 }
151
152 /****************************************************************************
153  *
154  * DHCP session
155  *
156  */
157
158 struct dhcp_session;
159
160 /** DHCP session state operations */
161 struct dhcp_session_state {
162         /** State name */
163         const char *name;
164         /**
165          * Construct transmitted packet
166          *
167          * @v dhcp              DHCP session
168          * @v dhcppkt           DHCP packet
169          * @v peer              Destination address
170          */
171         int ( * tx ) ( struct dhcp_session *dhcp,
172                        struct dhcp_packet *dhcppkt,
173                        struct sockaddr_in *peer );
174         /** Handle received packet
175          *
176          * @v dhcp              DHCP session
177          * @v dhcppkt           DHCP packet
178          * @v peer              DHCP server address
179          * @v msgtype           DHCP message type
180          * @v server_id         DHCP server ID
181          */
182         void ( * rx ) ( struct dhcp_session *dhcp,
183                         struct dhcp_packet *dhcppkt,
184                         struct sockaddr_in *peer,
185                         uint8_t msgtype, struct in_addr server_id );
186         /** Handle timer expiry
187          *
188          * @v dhcp              DHCP session
189          */
190         void ( * expired ) ( struct dhcp_session *dhcp );
191         /** Transmitted message type */
192         uint8_t tx_msgtype;
193         /** Apply minimum timeout */
194         uint8_t apply_min_timeout;
195 };
196
197 static struct dhcp_session_state dhcp_state_discover;
198 static struct dhcp_session_state dhcp_state_request;
199 static struct dhcp_session_state dhcp_state_proxy;
200 static struct dhcp_session_state dhcp_state_pxebs;
201
202 /** A DHCP session */
203 struct dhcp_session {
204         /** Reference counter */
205         struct refcnt refcnt;
206         /** Job control interface */
207         struct job_interface job;
208         /** Data transfer interface */
209         struct xfer_interface xfer;
210
211         /** Network device being configured */
212         struct net_device *netdev;
213         /** Local socket address */
214         struct sockaddr_in local;
215         /** State of the session */
216         struct dhcp_session_state *state;
217
218         /** Offered IP address */
219         struct in_addr offer;
220         /** DHCP server */
221         struct in_addr server;
222         /** DHCP offer priority */
223         int priority;
224
225         /** ProxyDHCP protocol extensions should be ignored */
226         int no_pxedhcp;
227         /** ProxyDHCP server */
228         struct in_addr proxy_server;
229         /** ProxyDHCP server priority */
230         int proxy_priority;
231
232         /** PXE Boot Server type */
233         uint16_t pxe_type;
234         /** List of PXE Boot Servers to attempt */
235         struct in_addr *pxe_attempt;
236         /** List of PXE Boot Servers to accept */
237         struct in_addr *pxe_accept;
238
239         /** Retransmission timer */
240         struct retry_timer timer;
241         /** Start time of the current state (in ticks) */
242         unsigned long start;
243 };
244
245 /**
246  * Free DHCP session
247  *
248  * @v refcnt            Reference counter
249  */
250 static void dhcp_free ( struct refcnt *refcnt ) {
251         struct dhcp_session *dhcp =
252                 container_of ( refcnt, struct dhcp_session, refcnt );
253
254         netdev_put ( dhcp->netdev );
255         free ( dhcp );
256 }
257
258 /**
259  * Mark DHCP session as complete
260  *
261  * @v dhcp              DHCP session
262  * @v rc                Return status code
263  */
264 static void dhcp_finished ( struct dhcp_session *dhcp, int rc ) {
265
266         /* Block futher incoming messages */
267         job_nullify ( &dhcp->job );
268         xfer_nullify ( &dhcp->xfer );
269
270         /* Stop retry timer */
271         stop_timer ( &dhcp->timer );
272
273         /* Free resources and close interfaces */
274         xfer_close ( &dhcp->xfer, rc );
275         job_done ( &dhcp->job, rc );
276 }
277
278 /**
279  * Transition to new DHCP session state
280  *
281  * @v dhcp              DHCP session
282  * @v state             New session state
283  */
284 static void dhcp_set_state ( struct dhcp_session *dhcp,
285                              struct dhcp_session_state *state ) {
286
287         DBGC ( dhcp, "DHCP %p entering %s state\n", dhcp, state->name );
288         dhcp->state = state;
289         dhcp->start = currticks();
290         stop_timer ( &dhcp->timer );
291         dhcp->timer.min_timeout =
292                 ( state->apply_min_timeout ? DHCP_MIN_TIMEOUT : 0 );
293         dhcp->timer.max_timeout = DHCP_MAX_TIMEOUT;
294         start_timer_nodelay ( &dhcp->timer );
295 }
296
297 /****************************************************************************
298  *
299  * DHCP state machine
300  *
301  */
302
303 /**
304  * Construct transmitted packet for DHCP discovery
305  *
306  * @v dhcp              DHCP session
307  * @v dhcppkt           DHCP packet
308  * @v peer              Destination address
309  */
310 static int dhcp_discovery_tx ( struct dhcp_session *dhcp,
311                                struct dhcp_packet *dhcppkt __unused,
312                                struct sockaddr_in *peer ) {
313
314         DBGC ( dhcp, "DHCP %p DHCPDISCOVER\n", dhcp );
315
316         /* Set server address */
317         peer->sin_addr.s_addr = INADDR_BROADCAST;
318         peer->sin_port = htons ( BOOTPS_PORT );
319
320         return 0;
321 }
322
323 /**
324  * Handle received packet during DHCP discovery
325  *
326  * @v dhcp              DHCP session
327  * @v dhcppkt           DHCP packet
328  * @v peer              DHCP server address
329  * @v msgtype           DHCP message type
330  * @v server_id         DHCP server ID
331  */
332 static void dhcp_discovery_rx ( struct dhcp_session *dhcp,
333                                 struct dhcp_packet *dhcppkt,
334                                 struct sockaddr_in *peer, uint8_t msgtype,
335                                 struct in_addr server_id ) {
336         struct in_addr ip;
337         char vci[9]; /* "PXEClient" */
338         int vci_len;
339         int has_pxeclient;
340         int8_t priority = 0;
341         uint8_t no_pxedhcp = 0;
342         unsigned long elapsed;
343
344         DBGC ( dhcp, "DHCP %p %s from %s:%d", dhcp,
345                dhcp_msgtype_name ( msgtype ), inet_ntoa ( peer->sin_addr ),
346                ntohs ( peer->sin_port ) );
347         if ( server_id.s_addr != peer->sin_addr.s_addr )
348                 DBGC ( dhcp, " (%s)", inet_ntoa ( server_id ) );
349
350         /* Identify offered IP address */
351         ip = dhcppkt->dhcphdr->yiaddr;
352         if ( ip.s_addr )
353                 DBGC ( dhcp, " for %s", inet_ntoa ( ip ) );
354
355         /* Identify "PXEClient" vendor class */
356         vci_len = dhcppkt_fetch ( dhcppkt, DHCP_VENDOR_CLASS_ID,
357                                   vci, sizeof ( vci ) );
358         has_pxeclient = ( ( vci_len >= ( int ) sizeof ( vci ) ) &&
359                           ( strncmp ( "PXEClient", vci, sizeof (vci) ) == 0 ));
360         if ( has_pxeclient )
361                 DBGC ( dhcp, " pxe" );
362
363         /* Identify priority */
364         dhcppkt_fetch ( dhcppkt, DHCP_EB_PRIORITY, &priority,
365                         sizeof ( priority ) );
366         if ( priority )
367                 DBGC ( dhcp, " pri %d", priority );
368
369         /* Identify ignore-PXE flag */
370         dhcppkt_fetch ( dhcppkt, DHCP_EB_NO_PXEDHCP, &no_pxedhcp,
371                         sizeof ( no_pxedhcp ) );
372         if ( no_pxedhcp )
373                 DBGC ( dhcp, " nopxe" );
374         DBGC ( dhcp, "\n" );
375
376         /* Select as DHCP offer, if applicable */
377         if ( ip.s_addr && ( peer->sin_port == htons ( BOOTPS_PORT ) ) &&
378              ( ( msgtype == DHCPOFFER ) || ( ! msgtype /* BOOTP */ ) ) &&
379              ( priority >= dhcp->priority ) ) {
380                 dhcp->offer = ip;
381                 dhcp->server = server_id;
382                 dhcp->priority = priority;
383                 dhcp->no_pxedhcp = no_pxedhcp;
384         }
385
386         /* Select as ProxyDHCP offer, if applicable */
387         if ( has_pxeclient && ( msgtype == DHCPOFFER ) &&
388              ( priority >= dhcp->proxy_priority ) ) {
389                 dhcp->proxy_server = server_id;
390                 dhcp->proxy_priority = priority;
391         }
392
393         /* We can exit the discovery state when we have a valid
394          * DHCPOFFER, and either:
395          *
396          *  o  The DHCPOFFER instructs us to ignore ProxyDHCPOFFERs, or
397          *  o  We have a valid ProxyDHCPOFFER, or
398          *  o  We have allowed sufficient time for ProxyDHCPOFFERs.
399          */
400
401         /* If we don't yet have a DHCPOFFER, do nothing */
402         if ( ! dhcp->offer.s_addr )
403                 return;
404
405         /* If we can't yet transition to DHCPREQUEST, do nothing */
406         elapsed = ( currticks() - dhcp->start );
407         if ( ! ( dhcp->no_pxedhcp || dhcp->proxy_server.s_addr ||
408                  ( elapsed > PROXYDHCP_MAX_TIMEOUT ) ) )
409                 return;
410
411         /* Transition to DHCPREQUEST */
412         dhcp_set_state ( dhcp, &dhcp_state_request );
413 }
414
415 /**
416  * Handle timer expiry during DHCP discovery
417  *
418  * @v dhcp              DHCP session
419  */
420 static void dhcp_discovery_expired ( struct dhcp_session *dhcp ) {
421         unsigned long elapsed = ( currticks() - dhcp->start );
422
423         /* Give up waiting for ProxyDHCP before we reach the failure point */
424         if ( dhcp->offer.s_addr && ( elapsed > PROXYDHCP_MAX_TIMEOUT ) ) {
425                 dhcp_set_state ( dhcp, &dhcp_state_request );
426                 return;
427         }
428
429         /* Otherwise, retransmit current packet */
430         dhcp_tx ( dhcp );
431 }
432
433 /** DHCP discovery state operations */
434 static struct dhcp_session_state dhcp_state_discover = {
435         .name                   = "discovery",
436         .tx                     = dhcp_discovery_tx,
437         .rx                     = dhcp_discovery_rx,
438         .expired                = dhcp_discovery_expired,
439         .tx_msgtype             = DHCPDISCOVER,
440         .apply_min_timeout      = 1,
441 };
442
443 /**
444  * Construct transmitted packet for DHCP request
445  *
446  * @v dhcp              DHCP session
447  * @v dhcppkt           DHCP packet
448  * @v peer              Destination address
449  */
450 static int dhcp_request_tx ( struct dhcp_session *dhcp,
451                              struct dhcp_packet *dhcppkt,
452                              struct sockaddr_in *peer ) {
453         int rc;
454
455         DBGC ( dhcp, "DHCP %p DHCPREQUEST to %s:%d",
456                dhcp, inet_ntoa ( dhcp->server ), BOOTPS_PORT );
457         DBGC ( dhcp, " for %s\n", inet_ntoa ( dhcp->offer ) );
458
459         /* Set server ID */
460         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_SERVER_IDENTIFIER,
461                                     &dhcp->server,
462                                     sizeof ( dhcp->server ) ) ) != 0 )
463                 return rc;
464
465         /* Set requested IP address */
466         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_REQUESTED_ADDRESS,
467                                     &dhcp->offer,
468                                     sizeof ( dhcp->offer ) ) ) != 0 )
469                 return rc;
470
471         /* Set server address */
472         peer->sin_addr.s_addr = INADDR_BROADCAST;
473         peer->sin_port = htons ( BOOTPS_PORT );
474
475         return 0;
476 }
477
478 /**
479  * Handle received packet during DHCP request
480  *
481  * @v dhcp              DHCP session
482  * @v dhcppkt           DHCP packet
483  * @v peer              DHCP server address
484  * @v msgtype           DHCP message type
485  * @v server_id         DHCP server ID
486  */
487 static void dhcp_request_rx ( struct dhcp_session *dhcp,
488                               struct dhcp_packet *dhcppkt,
489                               struct sockaddr_in *peer, uint8_t msgtype,
490                               struct in_addr server_id ) {
491         struct in_addr ip;
492         struct settings *parent;
493         int rc;
494
495         DBGC ( dhcp, "DHCP %p %s from %s:%d", dhcp,
496                dhcp_msgtype_name ( msgtype ), inet_ntoa ( peer->sin_addr ),
497                ntohs ( peer->sin_port ) );
498         if ( server_id.s_addr != peer->sin_addr.s_addr )
499                 DBGC ( dhcp, " (%s)", inet_ntoa ( server_id ) );
500
501         /* Identify leased IP address */
502         ip = dhcppkt->dhcphdr->yiaddr;
503         if ( ip.s_addr )
504                 DBGC ( dhcp, " for %s", inet_ntoa ( ip ) );
505         DBGC ( dhcp, "\n" );
506
507         /* Filter out unacceptable responses */
508         if ( peer->sin_port != htons ( BOOTPS_PORT ) )
509                 return;
510         if ( msgtype /* BOOTP */ && ( msgtype != DHCPACK ) )
511                 return;
512         if ( server_id.s_addr != dhcp->server.s_addr )
513                 return;
514
515         /* Record assigned address */
516         dhcp->local.sin_addr = ip;
517
518         /* Register settings */
519         parent = netdev_settings ( dhcp->netdev );
520         if ( ( rc = register_settings ( &dhcppkt->settings, parent ) ) != 0 ){
521                 DBGC ( dhcp, "DHCP %p could not register settings: %s\n",
522                        dhcp, strerror ( rc ) );
523                 dhcp_finished ( dhcp, rc );
524                 return;
525         }
526
527         /* Start ProxyDHCPREQUEST if applicable */
528         if ( dhcp->proxy_server.s_addr && ( ! dhcp->no_pxedhcp ) ) {
529                 dhcp_set_state ( dhcp, &dhcp_state_proxy );
530                 return;
531         }
532
533         /* Terminate DHCP */
534         dhcp_finished ( dhcp, 0 );
535 }
536
537 /**
538  * Handle timer expiry during DHCP discovery
539  *
540  * @v dhcp              DHCP session
541  */
542 static void dhcp_request_expired ( struct dhcp_session *dhcp ) {
543
544         /* Retransmit current packet */
545         dhcp_tx ( dhcp );
546 }
547
548 /** DHCP request state operations */
549 static struct dhcp_session_state dhcp_state_request = {
550         .name                   = "request",
551         .tx                     = dhcp_request_tx,
552         .rx                     = dhcp_request_rx,
553         .expired                = dhcp_request_expired,
554         .tx_msgtype             = DHCPREQUEST,
555         .apply_min_timeout      = 0,
556 };
557
558 /**
559  * Construct transmitted packet for ProxyDHCP request
560  *
561  * @v dhcp              DHCP session
562  * @v dhcppkt           DHCP packet
563  * @v peer              Destination address
564  */
565 static int dhcp_proxy_tx ( struct dhcp_session *dhcp,
566                            struct dhcp_packet *dhcppkt,
567                            struct sockaddr_in *peer ) {
568         int rc;
569
570         DBGC ( dhcp, "DHCP %p ProxyDHCP REQUEST to %s:%d\n",
571                dhcp, inet_ntoa ( dhcp->proxy_server ), PXE_PORT );
572
573         /* Set server ID */
574         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_SERVER_IDENTIFIER,
575                                     &dhcp->proxy_server,
576                                     sizeof ( dhcp->proxy_server ) ) ) != 0 )
577                 return rc;
578
579         /* Set server address */
580         peer->sin_addr = dhcp->proxy_server;
581         peer->sin_port = htons ( PXE_PORT );
582
583         return 0;
584 }
585
586 /**
587  * Handle received packet during ProxyDHCP request
588  *
589  * @v dhcp              DHCP session
590  * @v dhcppkt           DHCP packet
591  * @v peer              DHCP server address
592  * @v msgtype           DHCP message type
593  * @v server_id         DHCP server ID
594  */
595 static void dhcp_proxy_rx ( struct dhcp_session *dhcp,
596                             struct dhcp_packet *dhcppkt,
597                             struct sockaddr_in *peer, uint8_t msgtype,
598                             struct in_addr server_id ) {
599         int rc;
600
601         DBGC ( dhcp, "DHCP %p %s from %s:%d", dhcp,
602                dhcp_msgtype_name ( msgtype ), inet_ntoa ( peer->sin_addr ),
603                ntohs ( peer->sin_port ) );
604         if ( server_id.s_addr != peer->sin_addr.s_addr )
605                 DBGC ( dhcp, " (%s)", inet_ntoa ( server_id ) );
606         DBGC ( dhcp, "\n" );
607
608         /* Filter out unacceptable responses */
609         if ( peer->sin_port != htons ( PXE_PORT ) )
610                 return;
611         if ( msgtype != DHCPACK )
612                 return;
613         if ( server_id.s_addr /* Linux PXE server omits server ID */ &&
614              ( server_id.s_addr != dhcp->proxy_server.s_addr ) )
615                 return;
616
617         /* Register settings */
618         dhcppkt->settings.name = PROXYDHCP_SETTINGS_NAME;
619         if ( ( rc = register_settings ( &dhcppkt->settings, NULL ) ) != 0 ) {
620                 DBGC ( dhcp, "DHCP %p could not register settings: %s\n",
621                        dhcp, strerror ( rc ) );
622                 dhcp_finished ( dhcp, rc );
623                 return;
624         }
625
626         /* Terminate DHCP */
627         dhcp_finished ( dhcp, 0 );
628 }
629
630 /**
631  * Handle timer expiry during ProxyDHCP request
632  *
633  * @v dhcp              DHCP session
634  */
635 static void dhcp_proxy_expired ( struct dhcp_session *dhcp ) {
636         unsigned long elapsed = ( currticks() - dhcp->start );
637
638         /* Give up waiting for ProxyDHCP before we reach the failure point */
639         if ( elapsed > PROXYDHCP_MAX_TIMEOUT ) {
640                 dhcp_finished ( dhcp, 0 );
641                 return;
642         }
643
644         /* Retransmit current packet */
645         dhcp_tx ( dhcp );
646 }
647
648 /** ProxyDHCP request state operations */
649 static struct dhcp_session_state dhcp_state_proxy = {
650         .name                   = "ProxyDHCP",
651         .tx                     = dhcp_proxy_tx,
652         .rx                     = dhcp_proxy_rx,
653         .expired                = dhcp_proxy_expired,
654         .tx_msgtype             = DHCPREQUEST,
655         .apply_min_timeout      = 0,
656 };
657
658 /**
659  * Construct transmitted packet for PXE Boot Server Discovery
660  *
661  * @v dhcp              DHCP session
662  * @v dhcppkt           DHCP packet
663  * @v peer              Destination address
664  */
665 static int dhcp_pxebs_tx ( struct dhcp_session *dhcp,
666                            struct dhcp_packet *dhcppkt,
667                            struct sockaddr_in *peer ) {
668         struct dhcp_pxe_boot_menu_item menu_item = { 0, 0 };
669         int rc;
670
671         DBGC ( dhcp, "DHCP %p PXEBS REQUEST to %s:%d for type %d\n",
672                dhcp, inet_ntoa ( *(dhcp->pxe_attempt) ), PXE_PORT,
673                ntohs ( dhcp->pxe_type ) );
674
675         /* Set boot menu item */
676         menu_item.type = dhcp->pxe_type;
677         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_PXE_BOOT_MENU_ITEM,
678                                     &menu_item, sizeof ( menu_item ) ) ) != 0 )
679                 return rc;
680
681         /* Set server address */
682         peer->sin_addr = *(dhcp->pxe_attempt);
683         peer->sin_port = htons ( PXE_PORT );
684
685         return 0;
686 }
687
688 /**
689  * Check to see if PXE Boot Server address is acceptable
690  *
691  * @v dhcp              DHCP session
692  * @v bs                Boot Server address
693  * @ret accept          Boot Server is acceptable
694  */
695 static int dhcp_pxebs_accept ( struct dhcp_session *dhcp,
696                                struct in_addr bs ) {
697         struct in_addr *accept;
698
699         /* Accept if we have no acceptance filter */
700         if ( ! dhcp->pxe_accept )
701                 return 1;
702
703         /* Scan through acceptance list */
704         for ( accept = dhcp->pxe_accept ; accept->s_addr ; accept++ ) {
705                 if ( accept->s_addr == bs.s_addr )
706                         return 1;
707         }
708
709         DBGC ( dhcp, "DHCP %p rejecting server %s\n",
710                dhcp, inet_ntoa ( bs ) );
711         return 0;
712 }
713
714 /**
715  * Handle received packet during PXE Boot Server Discovery
716  *
717  * @v dhcp              DHCP session
718  * @v dhcppkt           DHCP packet
719  * @v peer              DHCP server address
720  * @v msgtype           DHCP message type
721  * @v server_id         DHCP server ID
722  */
723 static void dhcp_pxebs_rx ( struct dhcp_session *dhcp,
724                             struct dhcp_packet *dhcppkt,
725                             struct sockaddr_in *peer, uint8_t msgtype,
726                             struct in_addr server_id ) {
727         struct dhcp_pxe_boot_menu_item menu_item = { 0, 0 };
728         int rc;
729
730         DBGC ( dhcp, "DHCP %p %s from %s:%d", dhcp,
731                dhcp_msgtype_name ( msgtype ), inet_ntoa ( peer->sin_addr ),
732                ntohs ( peer->sin_port ) );
733         if ( server_id.s_addr != peer->sin_addr.s_addr )
734                 DBGC ( dhcp, " (%s)", inet_ntoa ( server_id ) );
735
736         /* Identify boot menu item */
737         dhcppkt_fetch ( dhcppkt, DHCP_PXE_BOOT_MENU_ITEM,
738                         &menu_item, sizeof ( menu_item ) );
739         if ( menu_item.type )
740                 DBGC ( dhcp, " for type %d", ntohs ( menu_item.type ) );
741         DBGC ( dhcp, "\n" );
742
743         /* Filter out unacceptable responses */
744         if ( peer->sin_port != htons ( PXE_PORT ) )
745                 return;
746         if ( msgtype != DHCPACK )
747                 return;
748         if ( menu_item.type != dhcp->pxe_type )
749                 return;
750         if ( ! dhcp_pxebs_accept ( dhcp, ( server_id.s_addr ?
751                                            server_id : peer->sin_addr ) ) )
752                 return;
753
754         /* Register settings */
755         dhcppkt->settings.name = PXEBS_SETTINGS_NAME;
756         if ( ( rc = register_settings ( &dhcppkt->settings, NULL ) ) != 0 ) {
757                 DBGC ( dhcp, "DHCP %p could not register settings: %s\n",
758                        dhcp, strerror ( rc ) );
759                 dhcp_finished ( dhcp, rc );
760                 return;
761         }
762
763         /* Terminate DHCP */
764         dhcp_finished ( dhcp, 0 );
765 }
766
767 /**
768  * Handle timer expiry during PXE Boot Server Discovery
769  *
770  * @v dhcp              DHCP session
771  */
772 static void dhcp_pxebs_expired ( struct dhcp_session *dhcp ) {
773         unsigned long elapsed = ( currticks() - dhcp->start );
774
775         /* Give up waiting before we reach the failure point, and fail
776          * over to the next server in the attempt list
777          */
778         if ( elapsed > PXEBS_MAX_TIMEOUT ) {
779                 dhcp->pxe_attempt++;
780                 if ( dhcp->pxe_attempt->s_addr ) {
781                         dhcp_set_state ( dhcp, &dhcp_state_pxebs );
782                         return;
783                 } else {
784                         dhcp_finished ( dhcp, -ETIMEDOUT );
785                         return;
786                 }
787         }
788
789         /* Retransmit current packet */
790         dhcp_tx ( dhcp );
791 }
792
793 /** PXE Boot Server Discovery state operations */
794 static struct dhcp_session_state dhcp_state_pxebs = {
795         .name                   = "PXEBS",
796         .tx                     = dhcp_pxebs_tx,
797         .rx                     = dhcp_pxebs_rx,
798         .expired                = dhcp_pxebs_expired,
799         .tx_msgtype             = DHCPREQUEST,
800         .apply_min_timeout      = 1,
801 };
802
803 /****************************************************************************
804  *
805  * Packet construction
806  *
807  */
808
809 /**
810  * Create a DHCP packet
811  *
812  * @v dhcppkt           DHCP packet structure to fill in
813  * @v netdev            Network device
814  * @v msgtype           DHCP message type
815  * @v options           Initial options to include (or NULL)
816  * @v options_len       Length of initial options
817  * @v data              Buffer for DHCP packet
818  * @v max_len           Size of DHCP packet buffer
819  * @ret rc              Return status code
820  *
821  * Creates a DHCP packet in the specified buffer, and initialise a
822  * DHCP packet structure.
823  */
824 int dhcp_create_packet ( struct dhcp_packet *dhcppkt,
825                          struct net_device *netdev, uint8_t msgtype,
826                          const void *options, size_t options_len,
827                          void *data, size_t max_len ) {
828         struct dhcphdr *dhcphdr = data;
829         unsigned int hlen;
830         int rc;
831
832         /* Sanity check */
833         if ( max_len < ( sizeof ( *dhcphdr ) + options_len ) )
834                 return -ENOSPC;
835
836         /* Initialise DHCP packet content */
837         memset ( dhcphdr, 0, max_len );
838         dhcphdr->xid = dhcp_xid ( netdev );
839         dhcphdr->magic = htonl ( DHCP_MAGIC_COOKIE );
840         dhcphdr->htype = ntohs ( netdev->ll_protocol->ll_proto );
841         dhcphdr->op = dhcp_op[msgtype];
842         /* If hardware length exceeds the chaddr field length, don't
843          * use the chaddr field.  This is as per RFC4390.
844          */
845         hlen = netdev->ll_protocol->ll_addr_len;
846         if ( hlen > sizeof ( dhcphdr->chaddr ) ) {
847                 hlen = 0;
848                 dhcphdr->flags = htons ( BOOTP_FL_BROADCAST );
849         }
850         dhcphdr->hlen = hlen;
851         memcpy ( dhcphdr->chaddr, netdev->ll_addr, hlen );
852         memcpy ( dhcphdr->options, options, options_len );
853
854         /* Initialise DHCP packet structure */
855         memset ( dhcppkt, 0, sizeof ( *dhcppkt ) );
856         dhcppkt_init ( dhcppkt, data, max_len );
857         
858         /* Set DHCP_MESSAGE_TYPE option */
859         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_MESSAGE_TYPE,
860                                     &msgtype, sizeof ( msgtype ) ) ) != 0 )
861                 return rc;
862
863         return 0;
864 }
865
866 /**
867  * Create DHCP request packet
868  *
869  * @v dhcppkt           DHCP packet structure to fill in
870  * @v netdev            Network device
871  * @v msgtype           DHCP message type
872  * @v ciaddr            Client IP address
873  * @v data              Buffer for DHCP packet
874  * @v max_len           Size of DHCP packet buffer
875  * @ret rc              Return status code
876  *
877  * Creates a DHCP request packet in the specified buffer, and
878  * initialise a DHCP packet structure.
879  */
880 int dhcp_create_request ( struct dhcp_packet *dhcppkt,
881                           struct net_device *netdev, unsigned int msgtype,
882                           struct in_addr ciaddr, void *data, size_t max_len ) {
883         struct device_description *desc = &netdev->dev->desc;
884         struct dhcp_netdev_desc dhcp_desc;
885         struct dhcp_client_id client_id;
886         struct dhcp_client_uuid client_uuid;
887         size_t dhcp_features_len;
888         size_t ll_addr_len;
889         ssize_t len;
890         int rc;
891
892         /* Create DHCP packet */
893         if ( ( rc = dhcp_create_packet ( dhcppkt, netdev, msgtype,
894                                          dhcp_request_options_data,
895                                          sizeof ( dhcp_request_options_data ),
896                                          data, max_len ) ) != 0 ) {
897                 DBG ( "DHCP could not create DHCP packet: %s\n",
898                       strerror ( rc ) );
899                 return rc;
900         }
901
902         /* Set client IP address */
903         dhcppkt->dhcphdr->ciaddr = ciaddr;
904
905         /* Add options to identify the feature list */
906         dhcp_features_len = ( dhcp_features_end - dhcp_features );
907         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_EB_ENCAP, dhcp_features,
908                                     dhcp_features_len ) ) != 0 ) {
909                 DBG ( "DHCP could not set features list option: %s\n",
910                       strerror ( rc ) );
911                 return rc;
912         }
913
914         /* Add options to identify the network device */
915         dhcp_desc.type = desc->bus_type;
916         dhcp_desc.vendor = htons ( desc->vendor );
917         dhcp_desc.device = htons ( desc->device );
918         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_EB_BUS_ID, &dhcp_desc,
919                                     sizeof ( dhcp_desc ) ) ) != 0 ) {
920                 DBG ( "DHCP could not set bus ID option: %s\n",
921                       strerror ( rc ) );
922                 return rc;
923         }
924
925         /* Add DHCP client identifier.  Required for Infiniband, and
926          * doesn't hurt other link layers.
927          */
928         client_id.ll_proto = ntohs ( netdev->ll_protocol->ll_proto );
929         ll_addr_len = netdev->ll_protocol->ll_addr_len;
930         assert ( ll_addr_len <= sizeof ( client_id.ll_addr ) );
931         memcpy ( client_id.ll_addr, netdev->ll_addr, ll_addr_len );
932         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_CLIENT_ID, &client_id,
933                                     ( ll_addr_len + 1 ) ) ) != 0 ) {
934                 DBG ( "DHCP could not set client ID: %s\n",
935                       strerror ( rc ) );
936                 return rc;
937         }
938
939         /* Add client UUID, if we have one.  Required for PXE. */
940         client_uuid.type = DHCP_CLIENT_UUID_TYPE;
941         if ( ( len = fetch_uuid_setting ( NULL, &uuid_setting,
942                                           &client_uuid.uuid ) ) >= 0 ) {
943                 if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_CLIENT_UUID,
944                                             &client_uuid,
945                                             sizeof ( client_uuid ) ) ) != 0 ) {
946                         DBG ( "DHCP could not set client UUID: %s\n",
947                               strerror ( rc ) );
948                         return rc;
949                 }
950         }
951
952         /* Add user class, if we have one. */
953         if ( ( len = fetch_setting_len ( NULL, &user_class_setting ) ) >= 0 ) {
954                 char user_class[len];
955                 fetch_setting ( NULL, &user_class_setting, user_class,
956                                 sizeof ( user_class ) );
957                 if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_USER_CLASS_ID,
958                                             &user_class,
959                                             sizeof ( user_class ) ) ) != 0 ) {
960                         DBG ( "DHCP could not set user class: %s\n",
961                               strerror ( rc ) );
962                         return rc;
963                 }
964         }
965
966         return 0;
967 }
968
969 /****************************************************************************
970  *
971  * Data transfer interface
972  *
973  */
974
975 /**
976  * Transmit DHCP request
977  *
978  * @v dhcp              DHCP session
979  * @ret rc              Return status code
980  */
981 static int dhcp_tx ( struct dhcp_session *dhcp ) {
982         static struct sockaddr_in peer = {
983                 .sin_family = AF_INET,
984         };
985         struct xfer_metadata meta = {
986                 .netdev = dhcp->netdev,
987                 .src = ( struct sockaddr * ) &dhcp->local,
988                 .dest = ( struct sockaddr * ) &peer,
989         };
990         struct io_buffer *iobuf;
991         uint8_t msgtype = dhcp->state->tx_msgtype;
992         struct dhcp_packet dhcppkt;
993         int rc;
994
995         /* Start retry timer.  Do this first so that failures to
996          * transmit will be retried.
997          */
998         start_timer ( &dhcp->timer );
999
1000         /* Allocate buffer for packet */
1001         iobuf = xfer_alloc_iob ( &dhcp->xfer, DHCP_MIN_LEN );
1002         if ( ! iobuf )
1003                 return -ENOMEM;
1004
1005         /* Create basic DHCP packet in temporary buffer */
1006         if ( ( rc = dhcp_create_request ( &dhcppkt, dhcp->netdev, msgtype,
1007                                           dhcp->local.sin_addr, iobuf->data,
1008                                           iob_tailroom ( iobuf ) ) ) != 0 ) {
1009                 DBGC ( dhcp, "DHCP %p could not construct DHCP request: %s\n",
1010                        dhcp, strerror ( rc ) );
1011                 goto done;
1012         }
1013
1014         /* Fill in packet based on current state */
1015         if ( ( rc = dhcp->state->tx ( dhcp, &dhcppkt, &peer ) ) != 0 ) {
1016                 DBGC ( dhcp, "DHCP %p could not fill DHCP request: %s\n",
1017                        dhcp, strerror ( rc ) );
1018                 goto done;
1019         }
1020
1021         /* Transmit the packet */
1022         iob_put ( iobuf, dhcppkt.len );
1023         if ( ( rc = xfer_deliver_iob_meta ( &dhcp->xfer, iob_disown ( iobuf ),
1024                                             &meta ) ) != 0 ) {
1025                 DBGC ( dhcp, "DHCP %p could not transmit UDP packet: %s\n",
1026                        dhcp, strerror ( rc ) );
1027                 goto done;
1028         }
1029
1030  done:
1031         free_iob ( iobuf );
1032         return rc;
1033 }
1034
1035 /**
1036  * Receive new data
1037  *
1038  * @v xfer              Data transfer interface
1039  * @v iobuf             I/O buffer
1040  * @v meta              Transfer metadata
1041  * @ret rc              Return status code
1042  */
1043 static int dhcp_deliver_iob ( struct xfer_interface *xfer,
1044                               struct io_buffer *iobuf,
1045                               struct xfer_metadata *meta ) {
1046         struct dhcp_session *dhcp =
1047                 container_of ( xfer, struct dhcp_session, xfer );
1048         struct sockaddr_in *peer;
1049         size_t data_len;
1050         struct dhcp_packet *dhcppkt;
1051         struct dhcphdr *dhcphdr;
1052         uint8_t msgtype = 0;
1053         struct in_addr server_id = { 0 };
1054         int rc = 0;
1055
1056         /* Sanity checks */
1057         if ( ! meta->src ) {
1058                 DBGC ( dhcp, "DHCP %p received packet without source port\n",
1059                        dhcp );
1060                 rc = -EINVAL;
1061                 goto err_no_src;
1062         }
1063         peer = ( struct sockaddr_in * ) meta->src;
1064
1065         /* Create a DHCP packet containing the I/O buffer contents.
1066          * Whilst we could just use the original buffer in situ, that
1067          * would waste the unused space in the packet buffer, and also
1068          * waste a relatively scarce fully-aligned I/O buffer.
1069          */
1070         data_len = iob_len ( iobuf );
1071         dhcppkt = zalloc ( sizeof ( *dhcppkt ) + data_len );
1072         if ( ! dhcppkt ) {
1073                 rc = -ENOMEM;
1074                 goto err_alloc_dhcppkt;
1075         }
1076         dhcphdr = ( ( ( void * ) dhcppkt ) + sizeof ( *dhcppkt ) );
1077         memcpy ( dhcphdr, iobuf->data, data_len );
1078         dhcppkt_init ( dhcppkt, dhcphdr, data_len );
1079
1080         /* Identify message type */
1081         dhcppkt_fetch ( dhcppkt, DHCP_MESSAGE_TYPE, &msgtype,
1082                         sizeof ( msgtype ) );
1083
1084         /* Identify server ID */
1085         dhcppkt_fetch ( dhcppkt, DHCP_SERVER_IDENTIFIER,
1086                         &server_id, sizeof ( server_id ) );
1087
1088         /* Check for matching transaction ID */
1089         if ( dhcphdr->xid != dhcp_xid ( dhcp->netdev ) ) {
1090                 DBGC ( dhcp, "DHCP %p %s from %s:%d has bad transaction "
1091                        "ID\n", dhcp, dhcp_msgtype_name ( msgtype ),
1092                        inet_ntoa ( peer->sin_addr ),
1093                        ntohs ( peer->sin_port ) );
1094                 rc = -EINVAL;
1095                 goto err_xid;
1096         };
1097
1098         /* Handle packet based on current state */
1099         dhcp->state->rx ( dhcp, dhcppkt, peer, msgtype, server_id );
1100
1101  err_xid:
1102         dhcppkt_put ( dhcppkt );
1103  err_alloc_dhcppkt:
1104  err_no_src:
1105         free_iob ( iobuf );
1106         return rc;
1107 }
1108
1109 /** DHCP data transfer interface operations */
1110 static struct xfer_interface_operations dhcp_xfer_operations = {
1111         .close          = ignore_xfer_close,
1112         .vredirect      = xfer_vopen,
1113         .window         = unlimited_xfer_window,
1114         .alloc_iob      = default_xfer_alloc_iob,
1115         .deliver_iob    = dhcp_deliver_iob,
1116         .deliver_raw    = xfer_deliver_as_iob,
1117 };
1118
1119 /**
1120  * Handle DHCP retry timer expiry
1121  *
1122  * @v timer             DHCP retry timer
1123  * @v fail              Failure indicator
1124  */
1125 static void dhcp_timer_expired ( struct retry_timer *timer, int fail ) {
1126         struct dhcp_session *dhcp =
1127                 container_of ( timer, struct dhcp_session, timer );
1128
1129         /* If we have failed, terminate DHCP */
1130         if ( fail ) {
1131                 dhcp_finished ( dhcp, -ETIMEDOUT );
1132                 return;
1133         }
1134
1135         /* Handle timer expiry based on current state */
1136         dhcp->state->expired ( dhcp );
1137 }
1138
1139 /****************************************************************************
1140  *
1141  * Job control interface
1142  *
1143  */
1144
1145 /**
1146  * Handle kill() event received via job control interface
1147  *
1148  * @v job               DHCP job control interface
1149  */
1150 static void dhcp_job_kill ( struct job_interface *job ) {
1151         struct dhcp_session *dhcp =
1152                 container_of ( job, struct dhcp_session, job );
1153
1154         /* Terminate DHCP session */
1155         dhcp_finished ( dhcp, -ECANCELED );
1156 }
1157
1158 /** DHCP job control interface operations */
1159 static struct job_interface_operations dhcp_job_operations = {
1160         .done           = ignore_job_done,
1161         .kill           = dhcp_job_kill,
1162         .progress       = ignore_job_progress,
1163 };
1164
1165 /****************************************************************************
1166  *
1167  * Instantiators
1168  *
1169  */
1170
1171 /**
1172  * DHCP peer address for socket opening
1173  *
1174  * This is a dummy address; the only useful portion is the socket
1175  * family (so that we get a UDP connection).  The DHCP client will set
1176  * the IP address and source port explicitly on each transmission.
1177  */
1178 static struct sockaddr dhcp_peer = {
1179         .sa_family = AF_INET,
1180 };
1181
1182 /**
1183  * Start DHCP state machine on a network device
1184  *
1185  * @v job               Job control interface
1186  * @v netdev            Network device
1187  * @ret rc              Return status code
1188  *
1189  * Starts DHCP on the specified network device.  If successful, the
1190  * DHCPACK (and ProxyDHCPACK, if applicable) will be registered as
1191  * option sources.
1192  */
1193 int start_dhcp ( struct job_interface *job, struct net_device *netdev ) {
1194         struct dhcp_session *dhcp;
1195         int rc;
1196
1197         /* Allocate and initialise structure */
1198         dhcp = zalloc ( sizeof ( *dhcp ) );
1199         if ( ! dhcp )
1200                 return -ENOMEM;
1201         dhcp->refcnt.free = dhcp_free;
1202         job_init ( &dhcp->job, &dhcp_job_operations, &dhcp->refcnt );
1203         xfer_init ( &dhcp->xfer, &dhcp_xfer_operations, &dhcp->refcnt );
1204         dhcp->netdev = netdev_get ( netdev );
1205         dhcp->local.sin_family = AF_INET;
1206         dhcp->local.sin_port = htons ( BOOTPC_PORT );
1207         dhcp->timer.expired = dhcp_timer_expired;
1208
1209         /* Instantiate child objects and attach to our interfaces */
1210         if ( ( rc = xfer_open_socket ( &dhcp->xfer, SOCK_DGRAM, &dhcp_peer,
1211                                   ( struct sockaddr * ) &dhcp->local ) ) != 0 )
1212                 goto err;
1213
1214         /* Enter DHCPDISCOVER state */
1215         dhcp_set_state ( dhcp, &dhcp_state_discover );
1216
1217         /* Attach parent interface, mortalise self, and return */
1218         job_plug_plug ( &dhcp->job, job );
1219         ref_put ( &dhcp->refcnt );
1220         return 0;
1221
1222  err:
1223         dhcp_finished ( dhcp, rc );
1224         ref_put ( &dhcp->refcnt );
1225         return rc;
1226 }
1227
1228 /**
1229  * Retrieve list of PXE boot servers for a given server type
1230  *
1231  * @v dhcp              DHCP session
1232  * @v raw               DHCP PXE boot server list
1233  * @v raw_len           Length of DHCP PXE boot server list
1234  * @v ip                IP address list to fill in
1235  *
1236  * The caller must ensure that the IP address list has sufficient
1237  * space.
1238  */
1239 static void pxebs_list ( struct dhcp_session *dhcp, void *raw,
1240                          size_t raw_len, struct in_addr *ip ) {
1241         struct dhcp_pxe_boot_server *server = raw;
1242         size_t server_len;
1243         unsigned int i;
1244
1245         while ( raw_len ) {
1246                 if ( raw_len < sizeof ( *server ) ) {
1247                         DBGC ( dhcp, "DHCP %p malformed PXE server list\n",
1248                                dhcp );
1249                         break;
1250                 }
1251                 server_len = offsetof ( typeof ( *server ),
1252                                         ip[ server->num_ip ] );
1253                 if ( raw_len < server_len ) {
1254                         DBGC ( dhcp, "DHCP %p malformed PXE server list\n",
1255                                dhcp );
1256                         break;
1257                 }
1258                 if ( server->type == dhcp->pxe_type ) {
1259                         for ( i = 0 ; i < server->num_ip ; i++ )
1260                                 *(ip++) = server->ip[i];
1261                 }
1262                 server = ( ( ( void * ) server ) + server_len );
1263                 raw_len -= server_len;
1264         }
1265 }
1266
1267 /**
1268  * Start PXE Boot Server Discovery on a network device
1269  *
1270  * @v job               Job control interface
1271  * @v netdev            Network device
1272  * @v pxe_type          PXE server type
1273  * @ret rc              Return status code
1274  *
1275  * Starts PXE Boot Server Discovery on the specified network device.
1276  * If successful, the Boot Server ACK will be registered as an option
1277  * source.
1278  */
1279 int start_pxebs ( struct job_interface *job, struct net_device *netdev,
1280                   unsigned int pxe_type ) {
1281         struct setting pxe_discovery_control_setting =
1282                 { .tag = DHCP_PXE_DISCOVERY_CONTROL };
1283         struct setting pxe_boot_servers_setting =
1284                 { .tag = DHCP_PXE_BOOT_SERVERS };
1285         struct setting pxe_boot_server_mcast_setting =
1286                 { .tag = DHCP_PXE_BOOT_SERVER_MCAST };
1287         ssize_t pxebs_list_len;
1288         struct dhcp_session *dhcp;
1289         struct in_addr *ip;
1290         unsigned int pxe_discovery_control;
1291         int rc;
1292
1293         /* Get upper bound for PXE boot server IP address list */
1294         pxebs_list_len = fetch_setting_len ( NULL, &pxe_boot_servers_setting );
1295         if ( pxebs_list_len < 0 )
1296                 pxebs_list_len = 0;
1297
1298         /* Allocate and initialise structure */
1299         dhcp = zalloc ( sizeof ( *dhcp ) + sizeof ( *ip ) /* mcast */ +
1300                         sizeof ( *ip ) /* bcast */ + pxebs_list_len +
1301                         sizeof ( *ip ) /* terminator */ );
1302         if ( ! dhcp )
1303                 return -ENOMEM;
1304         dhcp->refcnt.free = dhcp_free;
1305         job_init ( &dhcp->job, &dhcp_job_operations, &dhcp->refcnt );
1306         xfer_init ( &dhcp->xfer, &dhcp_xfer_operations, &dhcp->refcnt );
1307         dhcp->netdev = netdev_get ( netdev );
1308         dhcp->local.sin_family = AF_INET;
1309         fetch_ipv4_setting ( netdev_settings ( netdev ), &ip_setting,
1310                              &dhcp->local.sin_addr );
1311         dhcp->local.sin_port = htons ( BOOTPC_PORT );
1312         dhcp->pxe_type = htons ( pxe_type );
1313         dhcp->timer.expired = dhcp_timer_expired;
1314
1315         /* Construct PXE boot server IP address lists */
1316         pxe_discovery_control =
1317                 fetch_uintz_setting ( NULL, &pxe_discovery_control_setting );
1318         ip = ( ( ( void * ) dhcp ) + sizeof ( *dhcp ) );
1319         dhcp->pxe_attempt = ip;
1320         if ( ! ( pxe_discovery_control & PXEBS_NO_MULTICAST ) ) {
1321                 fetch_ipv4_setting ( NULL, &pxe_boot_server_mcast_setting, ip);
1322                 if ( ip->s_addr )
1323                         ip++;
1324         }
1325         if ( ! ( pxe_discovery_control & PXEBS_NO_BROADCAST ) )
1326                 (ip++)->s_addr = INADDR_BROADCAST;
1327         if ( pxe_discovery_control & PXEBS_NO_UNKNOWN_SERVERS )
1328                 dhcp->pxe_accept = ip;
1329         if ( pxebs_list_len ) {
1330                 uint8_t buf[pxebs_list_len];
1331
1332                 fetch_setting ( NULL, &pxe_boot_servers_setting,
1333                                 buf, sizeof ( buf ) );
1334                 pxebs_list ( dhcp, buf, sizeof ( buf ), ip );
1335         }
1336         if ( ! dhcp->pxe_attempt->s_addr ) {
1337                 DBGC ( dhcp, "DHCP %p has no PXE boot servers for type %04x\n",
1338                        dhcp, pxe_type );
1339                 rc = -EINVAL;
1340                 goto err;
1341         }
1342
1343         /* Dump out PXE server lists */
1344         DBGC ( dhcp, "DHCP %p attempting", dhcp );
1345         for ( ip = dhcp->pxe_attempt ; ip->s_addr ; ip++ )
1346                 DBGC ( dhcp, " %s", inet_ntoa ( *ip ) );
1347         DBGC ( dhcp, "\n" );
1348         if ( dhcp->pxe_accept ) {
1349                 DBGC ( dhcp, "DHCP %p accepting", dhcp );
1350                 for ( ip = dhcp->pxe_accept ; ip->s_addr ; ip++ )
1351                         DBGC ( dhcp, " %s", inet_ntoa ( *ip ) );
1352                 DBGC ( dhcp, "\n" );
1353         }
1354
1355         /* Instantiate child objects and attach to our interfaces */
1356         if ( ( rc = xfer_open_socket ( &dhcp->xfer, SOCK_DGRAM, &dhcp_peer,
1357                                   ( struct sockaddr * ) &dhcp->local ) ) != 0 )
1358                 goto err;
1359
1360         /* Enter PXEBS state */
1361         dhcp_set_state ( dhcp, &dhcp_state_pxebs );
1362
1363         /* Attach parent interface, mortalise self, and return */
1364         job_plug_plug ( &dhcp->job, job );
1365         ref_put ( &dhcp->refcnt );
1366         return 0;
1367
1368  err:
1369         dhcp_finished ( dhcp, rc );
1370         ref_put ( &dhcp->refcnt );
1371         return rc;
1372 }