[compiler] Prevent empty weak function stubs from being removed
[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 FILE_LICENCE ( GPL2_OR_LATER );
20
21 #include <string.h>
22 #include <stdlib.h>
23 #include <stdio.h>
24 #include <ctype.h>
25 #include <errno.h>
26 #include <assert.h>
27 #include <byteswap.h>
28 #include <gpxe/if_ether.h>
29 #include <gpxe/netdevice.h>
30 #include <gpxe/device.h>
31 #include <gpxe/xfer.h>
32 #include <gpxe/open.h>
33 #include <gpxe/job.h>
34 #include <gpxe/retry.h>
35 #include <gpxe/tcpip.h>
36 #include <gpxe/ip.h>
37 #include <gpxe/uuid.h>
38 #include <gpxe/timer.h>
39 #include <gpxe/settings.h>
40 #include <gpxe/dhcp.h>
41 #include <gpxe/dhcpopts.h>
42 #include <gpxe/dhcppkt.h>
43 #include <gpxe/dhcp_arch.h>
44 #include <gpxe/features.h>
45
46 /** @file
47  *
48  * Dynamic Host Configuration Protocol
49  *
50  */
51
52 struct dhcp_session;
53 static int dhcp_tx ( struct dhcp_session *dhcp );
54
55 /**
56  * DHCP operation types
57  *
58  * This table maps from DHCP message types (i.e. values of the @c
59  * DHCP_MESSAGE_TYPE option) to values of the "op" field within a DHCP
60  * packet.
61  */
62 static const uint8_t dhcp_op[] = {
63         [DHCPDISCOVER]  = BOOTP_REQUEST,
64         [DHCPOFFER]     = BOOTP_REPLY,
65         [DHCPREQUEST]   = BOOTP_REQUEST,
66         [DHCPDECLINE]   = BOOTP_REQUEST,
67         [DHCPACK]       = BOOTP_REPLY,
68         [DHCPNAK]       = BOOTP_REPLY,
69         [DHCPRELEASE]   = BOOTP_REQUEST,
70         [DHCPINFORM]    = BOOTP_REQUEST,
71 };
72
73 /** Raw option data for options common to all DHCP requests */
74 static uint8_t dhcp_request_options_data[] = {
75         DHCP_MESSAGE_TYPE, DHCP_BYTE ( 0 ),
76         DHCP_MAX_MESSAGE_SIZE,
77         DHCP_WORD ( ETH_MAX_MTU - 20 /* IP header */ - 8 /* UDP header */ ),
78         DHCP_CLIENT_ARCHITECTURE, DHCP_ARCH_CLIENT_ARCHITECTURE,
79         DHCP_CLIENT_NDI, DHCP_ARCH_CLIENT_NDI,
80         DHCP_VENDOR_CLASS_ID, DHCP_ARCH_VENDOR_CLASS_ID,
81         DHCP_USER_CLASS_ID, 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 /** Version number feature */
92 FEATURE_VERSION ( VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH );
93
94 /** DHCP server address setting */
95 struct setting dhcp_server_setting __setting = {
96         .name = "dhcp-server",
97         .description = "DHCP server address",
98         .tag = DHCP_SERVER_IDENTIFIER,
99         .type = &setting_type_ipv4,
100 };
101
102 /** DHCP user class setting */
103 struct setting user_class_setting __setting = {
104         .name = "user-class",
105         .description = "User class identifier",
106         .tag = DHCP_USER_CLASS_ID,
107         .type = &setting_type_string,
108 };
109
110 /** Use cached network settings */
111 struct setting use_cached_setting __setting = {
112         .name = "use-cached",
113         .description = "Use cached network settings",
114         .tag = DHCP_EB_USE_CACHED,
115         .type = &setting_type_uint8,
116 };
117
118 /**
119  * Name a DHCP packet type
120  *
121  * @v msgtype           DHCP message type
122  * @ret string          DHCP mesasge type name
123  */
124 static inline const char * dhcp_msgtype_name ( unsigned int msgtype ) {
125         switch ( msgtype ) {
126         case DHCPNONE:          return "BOOTP"; /* Non-DHCP packet */
127         case DHCPDISCOVER:      return "DHCPDISCOVER";
128         case DHCPOFFER:         return "DHCPOFFER";
129         case DHCPREQUEST:       return "DHCPREQUEST";
130         case DHCPDECLINE:       return "DHCPDECLINE";
131         case DHCPACK:           return "DHCPACK";
132         case DHCPNAK:           return "DHCPNAK";
133         case DHCPRELEASE:       return "DHCPRELEASE";
134         case DHCPINFORM:        return "DHCPINFORM";
135         default:                return "DHCP<invalid>";
136         }
137 }
138
139 /**
140  * Calculate DHCP transaction ID for a network device
141  *
142  * @v netdev            Network device
143  * @ret xid             DHCP XID
144  *
145  * Extract the least significant bits of the hardware address for use
146  * as the transaction ID.
147  */
148 static uint32_t dhcp_xid ( struct net_device *netdev ) {
149         uint32_t xid;
150
151         memcpy ( &xid, ( netdev->ll_addr + netdev->ll_protocol->ll_addr_len
152                          - sizeof ( xid ) ), sizeof ( xid ) );
153         return xid;
154 }
155
156 /****************************************************************************
157  *
158  * DHCP session
159  *
160  */
161
162 struct dhcp_session;
163
164 /** DHCP session state operations */
165 struct dhcp_session_state {
166         /** State name */
167         const char *name;
168         /**
169          * Construct transmitted packet
170          *
171          * @v dhcp              DHCP session
172          * @v dhcppkt           DHCP packet
173          * @v peer              Destination address
174          */
175         int ( * tx ) ( struct dhcp_session *dhcp,
176                        struct dhcp_packet *dhcppkt,
177                        struct sockaddr_in *peer );
178         /** Handle received packet
179          *
180          * @v dhcp              DHCP session
181          * @v dhcppkt           DHCP packet
182          * @v peer              DHCP server address
183          * @v msgtype           DHCP message type
184          * @v server_id         DHCP server ID
185          */
186         void ( * rx ) ( struct dhcp_session *dhcp,
187                         struct dhcp_packet *dhcppkt,
188                         struct sockaddr_in *peer,
189                         uint8_t msgtype, struct in_addr server_id );
190         /** Handle timer expiry
191          *
192          * @v dhcp              DHCP session
193          */
194         void ( * expired ) ( struct dhcp_session *dhcp );
195         /** Transmitted message type */
196         uint8_t tx_msgtype;
197         /** Apply minimum timeout */
198         uint8_t apply_min_timeout;
199 };
200
201 static struct dhcp_session_state dhcp_state_discover;
202 static struct dhcp_session_state dhcp_state_request;
203 static struct dhcp_session_state dhcp_state_proxy;
204 static struct dhcp_session_state dhcp_state_pxebs;
205
206 /** DHCP offer is valid for IP lease */
207 #define DHCP_OFFER_IP   1
208
209 /** DHCP offer is valid for PXE options */
210 #define DHCP_OFFER_PXE  2
211
212 /** A DHCP offer */
213 struct dhcp_offer {
214         /** IP address of server granting offer */
215         struct in_addr server;
216
217         /** IP address being offered, or 0.0.0.0 for a pure proxy */
218         struct in_addr ip;
219
220         /** DHCP packet containing PXE options; NULL if missing or proxied */
221         struct dhcp_packet *pxe;
222
223         /** Valid uses for this offer, a combination of DHCP_OFFER bits */
224         uint8_t valid;
225
226         /** Priority of this offer */
227         int8_t priority;
228
229         /** Whether to ignore PXE DHCP extensions */
230         uint8_t no_pxedhcp;
231 };
232
233 /** Maximum number of DHCP offers to queue */
234 #define DHCP_MAX_OFFERS   6
235
236 /** A DHCP session */
237 struct dhcp_session {
238         /** Reference counter */
239         struct refcnt refcnt;
240         /** Job control interface */
241         struct job_interface job;
242         /** Data transfer interface */
243         struct xfer_interface xfer;
244
245         /** Network device being configured */
246         struct net_device *netdev;
247         /** Local socket address */
248         struct sockaddr_in local;
249         /** State of the session */
250         struct dhcp_session_state *state;
251
252         /** PXE Boot Server type */
253         uint16_t pxe_type;
254         /** List of PXE Boot Servers to attempt */
255         struct in_addr *pxe_attempt;
256         /** List of PXE Boot Servers to accept */
257         struct in_addr *pxe_accept;
258
259         /** Retransmission timer */
260         struct retry_timer timer;
261         /** Start time of the current state (in ticks) */
262         unsigned long start;
263
264         /** DHCP offer just requested */
265         struct dhcp_offer *current_offer;
266         /** List of DHCP offers received */
267         struct dhcp_offer offers[DHCP_MAX_OFFERS];
268 };
269
270 /**
271  * Free DHCP session
272  *
273  * @v refcnt            Reference counter
274  */
275 static void dhcp_free ( struct refcnt *refcnt ) {
276         struct dhcp_session *dhcp =
277                 container_of ( refcnt, struct dhcp_session, refcnt );
278         int i;
279
280         for ( i = 0 ; i < DHCP_MAX_OFFERS ; i++ ) {
281                 if ( dhcp->offers[i].pxe )
282                         dhcppkt_put ( dhcp->offers[i].pxe );
283         }
284
285         netdev_put ( dhcp->netdev );
286         free ( dhcp );
287 }
288
289 /**
290  * Mark DHCP session as complete
291  *
292  * @v dhcp              DHCP session
293  * @v rc                Return status code
294  */
295 static void dhcp_finished ( struct dhcp_session *dhcp, int rc ) {
296
297         /* Block futher incoming messages */
298         job_nullify ( &dhcp->job );
299         xfer_nullify ( &dhcp->xfer );
300
301         /* Stop retry timer */
302         stop_timer ( &dhcp->timer );
303
304         /* Free resources and close interfaces */
305         xfer_close ( &dhcp->xfer, rc );
306         job_done ( &dhcp->job, rc );
307 }
308
309 /**
310  * Transition to new DHCP session state
311  *
312  * @v dhcp              DHCP session
313  * @v state             New session state
314  */
315 static void dhcp_set_state ( struct dhcp_session *dhcp,
316                              struct dhcp_session_state *state ) {
317
318         DBGC ( dhcp, "DHCP %p entering %s state\n", dhcp, state->name );
319         dhcp->state = state;
320         dhcp->start = currticks();
321         stop_timer ( &dhcp->timer );
322         dhcp->timer.min_timeout =
323                 ( state->apply_min_timeout ? DHCP_MIN_TIMEOUT : 0 );
324         dhcp->timer.max_timeout = DHCP_MAX_TIMEOUT;
325         start_timer_nodelay ( &dhcp->timer );
326 }
327
328 /**
329  * Determine next DHCP offer to try
330  *
331  * @v dhcp              DHCP session
332  * @v type              DHCP offer type
333  * @ret offer           Next DHCP offer to try
334  *
335  * Offers are ranked by priority, then by completeness (combined
336  * IP+PXE are tried before @a type alone), then by order of receipt.
337  */
338 static struct dhcp_offer * dhcp_next_offer ( struct dhcp_session *dhcp,
339                                              uint8_t type ) {
340
341         struct dhcp_offer *offer;
342         struct dhcp_offer *best = NULL;
343
344         for ( offer = dhcp->offers ; offer < dhcp->offers + DHCP_MAX_OFFERS ;
345               offer++ ) {
346                 if ( ( offer->valid & type ) &&
347                      ( ( best == NULL ) ||
348                        ( offer->priority > best->priority ) ||
349                        ( ( offer->priority == best->priority ) &&
350                          ( offer->valid & ~best->valid ) ) ) )
351                         best = offer;
352         }
353
354         return best;
355 }
356
357 /****************************************************************************
358  *
359  * DHCP state machine
360  *
361  */
362
363 /**
364  * Construct transmitted packet for DHCP discovery
365  *
366  * @v dhcp              DHCP session
367  * @v dhcppkt           DHCP packet
368  * @v peer              Destination address
369  */
370 static int dhcp_discovery_tx ( struct dhcp_session *dhcp,
371                                struct dhcp_packet *dhcppkt __unused,
372                                struct sockaddr_in *peer ) {
373
374         DBGC ( dhcp, "DHCP %p DHCPDISCOVER\n", dhcp );
375
376         /* Set server address */
377         peer->sin_addr.s_addr = INADDR_BROADCAST;
378         peer->sin_port = htons ( BOOTPS_PORT );
379
380         return 0;
381 }
382
383 /**
384  * Handle received DHCPOFFER during any state
385  *
386  * @v dhcp              DHCP session
387  * @v dhcppkt           DHCP packet
388  * @v peer              DHCP server address
389  * @v msgtype           DHCP message type
390  * @v server_id         DHCP server ID
391  */
392 static void dhcp_rx_offer ( struct dhcp_session *dhcp,
393                             struct dhcp_packet *dhcppkt,
394                             struct sockaddr_in *peer, uint8_t msgtype,
395                             struct in_addr server_id ) {
396         char vci[9]; /* "PXEClient" */
397         int vci_len;
398         int has_pxeclient;
399         int pxeopts_len;
400         int has_pxeopts;
401         uint8_t discovery_control;
402         struct dhcp_offer *offer;
403         int i;
404
405         DBGC ( dhcp, "DHCP %p %s from %s:%d", dhcp,
406                dhcp_msgtype_name ( msgtype ), inet_ntoa ( peer->sin_addr ),
407                ntohs ( peer->sin_port ) );
408         if ( server_id.s_addr != peer->sin_addr.s_addr )
409                 DBGC ( dhcp, " (%s)", inet_ntoa ( server_id ) );
410
411         /* Identify offered IP address */
412         if ( dhcppkt->dhcphdr->yiaddr.s_addr )
413                 DBGC ( dhcp, " for %s", inet_ntoa ( dhcppkt->dhcphdr->yiaddr ));
414
415         /* Enqueue an offer to be filled in */
416         for ( i = 0 ; i < DHCP_MAX_OFFERS ; i++ ) {
417                 if ( ! dhcp->offers[i].valid )
418                         break;
419
420                 if ( dhcp->offers[i].server.s_addr == server_id.s_addr ) {
421                         DBGC ( dhcp, " dup\n" );
422                         return;
423                 }
424         }
425         if ( i == DHCP_MAX_OFFERS ) {
426                 DBGC ( dhcp, " dropped\n" );
427                 return;
428         }
429
430         offer = &dhcp->offers[i];
431         offer->server = server_id;
432         offer->ip = dhcppkt->dhcphdr->yiaddr;
433
434         /* Identify "PXEClient" vendor class */
435         vci_len = dhcppkt_fetch ( dhcppkt, DHCP_VENDOR_CLASS_ID,
436                                   vci, sizeof ( vci ) );
437         has_pxeclient = ( ( vci_len >= ( int ) sizeof ( vci ) ) &&
438                           ( strncmp ( "PXEClient", vci, sizeof (vci) ) == 0 ));
439
440         /*
441          * Identify presence of PXE-specific options
442          *
443          * The Intel firmware appears to check for:
444          * - PXE_DISCOVERY_CONTROL exists and has bit 3 set, or
445          * - both PXE_BOOT_MENU and PXE_BOOT_MENU_PROMPT exist
446          *
447          * If DISCOVERY_CONTROL bit 3 is set, the firmware treats this
448          * packet like a "normal" non-PXE DHCP packet with respect to
449          * boot filename, except that it can come from ProxyDHCP. This
450          * is the scheme that dnsmasq uses in the simple case.
451          *
452          * Otherwise, if one of the boot menu / boot menu prompt
453          * options exists but not both, the firmware signals an
454          * error. If neither exists, the packet is not considered to
455          * contain DHCP options.
456          *
457          * In an effort to preserve semantics but be more flexible, we
458          * check only for bit 3 of DISCOVERY_CONTROL or the presence
459          * of BOOT_MENU. We don't care (yet) about the menu prompt.
460          */
461         pxeopts_len = dhcppkt_fetch ( dhcppkt, DHCP_PXE_BOOT_MENU, NULL, 0 );
462         has_pxeopts = ( pxeopts_len >= 0 );
463         if ( dhcppkt_fetch ( dhcppkt, DHCP_PXE_DISCOVERY_CONTROL,
464                              &discovery_control, 1 ) >= 0 ) {
465                 /* Honor request to skip boot server discovery and use
466                    the provided filename */
467                 has_pxeopts = has_pxeopts || ( discovery_control & PXEBS_SKIP );
468         }
469         if ( has_pxeclient )
470                 DBGC ( dhcp, "%s", ( has_pxeopts ? " pxe" : " proxy" ) );
471
472         if ( has_pxeclient && has_pxeopts ) {
473                 /* Save reference to packet for future use */
474                 if ( offer->pxe )
475                         dhcppkt_put ( offer->pxe );
476                 offer->pxe = dhcppkt_get ( dhcppkt );
477         }
478
479         /* Identify priority */
480         dhcppkt_fetch ( dhcppkt, DHCP_EB_PRIORITY, &offer->priority,
481                         sizeof ( offer->priority ) );
482         if ( offer->priority )
483                 DBGC ( dhcp, " pri %d", offer->priority );
484
485         /* Identify ignore-PXE flag */
486         dhcppkt_fetch ( dhcppkt, DHCP_EB_NO_PXEDHCP, &offer->no_pxedhcp,
487                         sizeof ( offer->no_pxedhcp ) );
488         if ( offer->no_pxedhcp )
489                 DBGC ( dhcp, " nopxe" );
490         DBGC ( dhcp, "\n" );
491
492         /* Determine roles this offer can fill */
493         if ( offer->ip.s_addr &&
494              ( peer->sin_port == htons ( BOOTPS_PORT ) ) &&
495              ( ( msgtype == DHCPOFFER ) || ( ! msgtype /* BOOTP */ ) ) )
496                 offer->valid |= DHCP_OFFER_IP;
497
498         if ( has_pxeclient && ( msgtype == DHCPOFFER ) )
499                 offer->valid |= DHCP_OFFER_PXE;
500 }
501
502 /**
503  * Handle received packet during DHCP discovery
504  *
505  * @v dhcp              DHCP session
506  * @v dhcppkt           DHCP packet
507  * @v peer              DHCP server address
508  * @v msgtype           DHCP message type
509  * @v server_id         DHCP server ID
510  */
511 static void dhcp_discovery_rx ( struct dhcp_session *dhcp,
512                                 struct dhcp_packet *dhcppkt,
513                                 struct sockaddr_in *peer, uint8_t msgtype,
514                                 struct in_addr server_id ) {
515         unsigned long elapsed;
516         struct dhcp_offer *ip_offer;
517
518         dhcp_rx_offer ( dhcp, dhcppkt, peer, msgtype, server_id );
519
520         /* We can exit the discovery state when we have a valid
521          * DHCPOFFER, and either:
522          *
523          *  o  The DHCPOFFER instructs us to ignore ProxyDHCPOFFERs, or
524          *  o  We have a valid ProxyDHCPOFFER, or
525          *  o  We have allowed sufficient time for ProxyDHCPOFFERs.
526          */
527
528         /* If we don't yet have a DHCPOFFER, do nothing */
529         ip_offer = dhcp_next_offer ( dhcp, DHCP_OFFER_IP );
530         if ( ! ip_offer )
531                 return;
532
533         /* If we can't yet transition to DHCPREQUEST, do nothing */
534         elapsed = ( currticks() - dhcp->start );
535         if ( ! ( ip_offer->no_pxedhcp ||
536                  dhcp_next_offer ( dhcp, DHCP_OFFER_PXE ) ||
537                  ( elapsed > PROXYDHCP_MAX_TIMEOUT ) ) )
538                 return;
539
540         /* Transition to DHCPREQUEST */
541         dhcp_set_state ( dhcp, &dhcp_state_request );
542 }
543
544 /**
545  * Handle timer expiry during DHCP discovery
546  *
547  * @v dhcp              DHCP session
548  */
549 static void dhcp_discovery_expired ( struct dhcp_session *dhcp ) {
550         unsigned long elapsed = ( currticks() - dhcp->start );
551
552         /* Give up waiting for ProxyDHCP before we reach the failure point */
553         if ( dhcp_next_offer ( dhcp, DHCP_OFFER_IP ) &&
554              ( elapsed > PROXYDHCP_MAX_TIMEOUT ) ) {
555                 dhcp_set_state ( dhcp, &dhcp_state_request );
556                 return;
557         }
558
559         /* Otherwise, retransmit current packet */
560         dhcp_tx ( dhcp );
561 }
562
563 /** DHCP discovery state operations */
564 static struct dhcp_session_state dhcp_state_discover = {
565         .name                   = "discovery",
566         .tx                     = dhcp_discovery_tx,
567         .rx                     = dhcp_discovery_rx,
568         .expired                = dhcp_discovery_expired,
569         .tx_msgtype             = DHCPDISCOVER,
570         .apply_min_timeout      = 1,
571 };
572
573 /**
574  * Construct transmitted packet for DHCP request
575  *
576  * @v dhcp              DHCP session
577  * @v dhcppkt           DHCP packet
578  * @v peer              Destination address
579  */
580 static int dhcp_request_tx ( struct dhcp_session *dhcp,
581                              struct dhcp_packet *dhcppkt,
582                              struct sockaddr_in *peer ) {
583         int rc;
584         struct dhcp_offer *offer;
585
586         offer = dhcp->current_offer = dhcp_next_offer ( dhcp, DHCP_OFFER_IP );
587
588         DBGC ( dhcp, "DHCP %p DHCPREQUEST to %s:%d",
589                dhcp, inet_ntoa ( offer->server ), BOOTPS_PORT );
590         DBGC ( dhcp, " for %s\n", inet_ntoa ( offer->ip ) );
591
592         /* Set server ID */
593         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_SERVER_IDENTIFIER,
594                                     &offer->server,
595                                     sizeof ( offer->server ) ) ) != 0 )
596                 return rc;
597
598         /* Set requested IP address */
599         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_REQUESTED_ADDRESS,
600                                     &offer->ip, sizeof ( offer->ip ) ) ) != 0 )
601                 return rc;
602
603         /* Set server address */
604         peer->sin_addr.s_addr = INADDR_BROADCAST;
605         peer->sin_port = htons ( BOOTPS_PORT );
606
607         return 0;
608 }
609
610 /**
611  * Handle received packet during DHCP request
612  *
613  * @v dhcp              DHCP session
614  * @v dhcppkt           DHCP packet
615  * @v peer              DHCP server address
616  * @v msgtype           DHCP message type
617  * @v server_id         DHCP server ID
618  */
619 static void dhcp_request_rx ( struct dhcp_session *dhcp,
620                               struct dhcp_packet *dhcppkt,
621                               struct sockaddr_in *peer, uint8_t msgtype,
622                               struct in_addr server_id ) {
623         struct in_addr ip;
624         struct settings *parent;
625         int rc;
626         struct dhcp_offer *pxe_offer;
627
628         if ( msgtype == DHCPOFFER ) {
629                 dhcp_rx_offer ( dhcp, dhcppkt, peer, msgtype, server_id );
630                 if ( dhcp_next_offer ( dhcp, DHCP_OFFER_IP ) !=
631                      dhcp->current_offer ) {
632                         /* Restart due to higher-priority offer received */
633                         DBGC ( dhcp, "DHCP %p re-requesting\n", dhcp );
634                         dhcp_set_state ( dhcp, &dhcp_state_request );
635                 }
636                 return;
637         }
638
639         DBGC ( dhcp, "DHCP %p %s from %s:%d", dhcp,
640                dhcp_msgtype_name ( msgtype ), inet_ntoa ( peer->sin_addr ),
641                ntohs ( peer->sin_port ) );
642         if ( server_id.s_addr != peer->sin_addr.s_addr )
643                 DBGC ( dhcp, " (%s)", inet_ntoa ( server_id ) );
644
645         /* Identify leased IP address */
646         ip = dhcppkt->dhcphdr->yiaddr;
647         if ( ip.s_addr )
648                 DBGC ( dhcp, " for %s", inet_ntoa ( ip ) );
649         DBGC ( dhcp, "\n" );
650
651         /* Filter out unacceptable responses */
652         if ( peer->sin_port != htons ( BOOTPS_PORT ) )
653                 return;
654         if ( msgtype /* BOOTP */ && ( msgtype != DHCPACK ) )
655                 return;
656         if ( server_id.s_addr != dhcp->current_offer->server.s_addr )
657                 return;
658
659         /* Record assigned address */
660         dhcp->local.sin_addr = ip;
661
662         /* Register settings */
663         parent = netdev_settings ( dhcp->netdev );
664         if ( ( rc = register_settings ( &dhcppkt->settings, parent ) ) != 0 ){
665                 DBGC ( dhcp, "DHCP %p could not register settings: %s\n",
666                        dhcp, strerror ( rc ) );
667                 dhcp_finished ( dhcp, rc );
668                 return;
669         }
670
671         /* Locate best source of PXE settings */
672         pxe_offer = dhcp_next_offer ( dhcp, DHCP_OFFER_PXE );
673
674         if ( ( ! pxe_offer ) || /* No PXE available */
675              /* IP offer instructs us to ignore PXE */
676              dhcp->current_offer->no_pxedhcp ||
677              /* PXE settings already registered with IP offer */
678              ( ( dhcp->current_offer == pxe_offer ) && ( pxe_offer->pxe ) ) ) {
679
680                 /* Terminate DHCP */
681                 dhcp_finished ( dhcp, 0 );
682
683         } else if ( pxe_offer->pxe ) {
684                 /* Register PXE settings and terminate DHCP */
685                 pxe_offer->pxe->settings.name = PROXYDHCP_SETTINGS_NAME;
686                 if ( ( rc = register_settings ( &pxe_offer->pxe->settings,
687                                                 NULL ) ) != 0 ) {
688                         DBGC ( dhcp, "DHCP %p could not register settings: "
689                                "%s\n", dhcp, strerror ( rc ) );
690                 }
691                 dhcp_finished ( dhcp, rc );
692         } else {
693                 /* Start ProxyDHCP */
694                 dhcp_set_state ( dhcp, &dhcp_state_proxy );
695         }
696 }
697
698 /**
699  * Handle timer expiry during DHCP discovery
700  *
701  * @v dhcp              DHCP session
702  */
703 static void dhcp_request_expired ( struct dhcp_session *dhcp ) {
704
705         /* Retransmit current packet */
706         dhcp_tx ( dhcp );
707 }
708
709 /** DHCP request state operations */
710 static struct dhcp_session_state dhcp_state_request = {
711         .name                   = "request",
712         .tx                     = dhcp_request_tx,
713         .rx                     = dhcp_request_rx,
714         .expired                = dhcp_request_expired,
715         .tx_msgtype             = DHCPREQUEST,
716         .apply_min_timeout      = 0,
717 };
718
719 /**
720  * Construct transmitted packet for ProxyDHCP request
721  *
722  * @v dhcp              DHCP session
723  * @v dhcppkt           DHCP packet
724  * @v peer              Destination address
725  */
726 static int dhcp_proxy_tx ( struct dhcp_session *dhcp,
727                            struct dhcp_packet *dhcppkt,
728                            struct sockaddr_in *peer ) {
729         int rc;
730         struct dhcp_offer *offer;
731
732         offer = dhcp->current_offer = dhcp_next_offer ( dhcp, DHCP_OFFER_PXE );
733
734         DBGC ( dhcp, "DHCP %p ProxyDHCP REQUEST to %s:%d\n", dhcp,
735                inet_ntoa ( offer->server ), PXE_PORT );
736
737         /* Set server ID */
738         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_SERVER_IDENTIFIER,
739                                     &offer->server,
740                                     sizeof ( offer->server ) ) )  != 0 )
741                 return rc;
742
743         /* Set server address */
744         peer->sin_addr = offer->server;
745         peer->sin_port = htons ( PXE_PORT );
746
747         return 0;
748 }
749
750 /**
751  * Handle received packet during ProxyDHCP request
752  *
753  * @v dhcp              DHCP session
754  * @v dhcppkt           DHCP packet
755  * @v peer              DHCP server address
756  * @v msgtype           DHCP message type
757  * @v server_id         DHCP server ID
758  */
759 static void dhcp_proxy_rx ( struct dhcp_session *dhcp,
760                             struct dhcp_packet *dhcppkt,
761                             struct sockaddr_in *peer, uint8_t msgtype,
762                             struct in_addr server_id ) {
763         int rc;
764
765         /* Enqueue last-minute DHCPOFFERs for use in case of failure */
766         if ( peer->sin_port == htons ( BOOTPS_PORT ) &&
767              msgtype == DHCPOFFER ) {
768                 dhcp_rx_offer ( dhcp, dhcppkt, peer, msgtype, server_id );
769                 return;
770         }
771
772         DBGC ( dhcp, "DHCP %p %s from %s:%d", dhcp,
773                dhcp_msgtype_name ( msgtype ), inet_ntoa ( peer->sin_addr ),
774                ntohs ( peer->sin_port ) );
775         if ( server_id.s_addr != peer->sin_addr.s_addr )
776                 DBGC ( dhcp, " (%s)", inet_ntoa ( server_id ) );
777         DBGC ( dhcp, "\n" );
778
779         /* Filter out unacceptable responses */
780         if ( peer->sin_port != htons ( PXE_PORT ) )
781                 return;
782         if ( msgtype != DHCPACK && msgtype != DHCPOFFER )
783                 return;
784         if ( server_id.s_addr /* Linux PXE server omits server ID */ &&
785              ( server_id.s_addr != dhcp->current_offer->server.s_addr ) )
786                 return;
787
788         /* Register settings */
789         dhcppkt->settings.name = PROXYDHCP_SETTINGS_NAME;
790         if ( ( rc = register_settings ( &dhcppkt->settings, NULL ) ) != 0 ) {
791                 DBGC ( dhcp, "DHCP %p could not register settings: %s\n",
792                        dhcp, strerror ( rc ) );
793                 dhcp_finished ( dhcp, rc );
794                 return;
795         }
796
797         /* Terminate DHCP */
798         dhcp_finished ( dhcp, 0 );
799 }
800
801 /**
802  * Handle timer expiry during ProxyDHCP request
803  *
804  * @v dhcp              DHCP session
805  */
806 static void dhcp_proxy_expired ( struct dhcp_session *dhcp ) {
807         unsigned long elapsed = ( currticks() - dhcp->start );
808
809         /* Give up waiting for ProxyDHCP before we reach the failure point */
810         if ( elapsed > PROXYDHCP_MAX_TIMEOUT ) {
811
812                 /* Mark failed offer as unsuitable for ProxyDHCP */
813                 dhcp->current_offer->valid &= ~DHCP_OFFER_PXE;
814
815                 /* Prefer not to use only half of a PXE+IP offer if we
816                  * have other offers available
817                  */
818                 dhcp->current_offer->priority = -1;
819
820                 /* If we have any other PXE offers we can try, go back
821                  * to DHCPREQUEST (since they might not be proxied
822                  * offers, or might be coupled to a new IP address).
823                  * We should probably DHCPRELEASE our old IP, but the
824                  * standard does not require it.
825                  */
826                 if ( dhcp_next_offer ( dhcp, DHCP_OFFER_PXE ) ) {
827                         dhcp->local.sin_addr.s_addr = 0;
828                         dhcp_set_state ( dhcp, &dhcp_state_request );
829                         return;
830                 }
831
832                 /* No possibilities left; finish without PXE options */
833                 dhcp_finished ( dhcp, 0 );
834                 return;
835         }
836
837         /* Retransmit current packet */
838         dhcp_tx ( dhcp );
839 }
840
841 /** ProxyDHCP request state operations */
842 static struct dhcp_session_state dhcp_state_proxy = {
843         .name                   = "ProxyDHCP",
844         .tx                     = dhcp_proxy_tx,
845         .rx                     = dhcp_proxy_rx,
846         .expired                = dhcp_proxy_expired,
847         .tx_msgtype             = DHCPREQUEST,
848         .apply_min_timeout      = 0,
849 };
850
851 /**
852  * Construct transmitted packet for PXE Boot Server Discovery
853  *
854  * @v dhcp              DHCP session
855  * @v dhcppkt           DHCP packet
856  * @v peer              Destination address
857  */
858 static int dhcp_pxebs_tx ( struct dhcp_session *dhcp,
859                            struct dhcp_packet *dhcppkt,
860                            struct sockaddr_in *peer ) {
861         struct dhcp_pxe_boot_menu_item menu_item = { 0, 0 };
862         int rc;
863
864         /* Set server address */
865         peer->sin_addr = *(dhcp->pxe_attempt);
866         peer->sin_port = ( ( peer->sin_addr.s_addr == INADDR_BROADCAST ) ?
867                            htons ( BOOTPS_PORT ) : htons ( PXE_PORT ) );
868
869         DBGC ( dhcp, "DHCP %p PXEBS REQUEST to %s:%d for type %d\n",
870                dhcp, inet_ntoa ( peer->sin_addr ), ntohs ( peer->sin_port ),
871                le16_to_cpu ( dhcp->pxe_type ) );
872
873         /* Set boot menu item */
874         menu_item.type = dhcp->pxe_type;
875         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_PXE_BOOT_MENU_ITEM,
876                                     &menu_item, sizeof ( menu_item ) ) ) != 0 )
877                 return rc;
878
879         return 0;
880 }
881
882 /**
883  * Check to see if PXE Boot Server address is acceptable
884  *
885  * @v dhcp              DHCP session
886  * @v bs                Boot Server address
887  * @ret accept          Boot Server is acceptable
888  */
889 static int dhcp_pxebs_accept ( struct dhcp_session *dhcp,
890                                struct in_addr bs ) {
891         struct in_addr *accept;
892
893         /* Accept if we have no acceptance filter */
894         if ( ! dhcp->pxe_accept )
895                 return 1;
896
897         /* Scan through acceptance list */
898         for ( accept = dhcp->pxe_accept ; accept->s_addr ; accept++ ) {
899                 if ( accept->s_addr == bs.s_addr )
900                         return 1;
901         }
902
903         DBGC ( dhcp, "DHCP %p rejecting server %s\n",
904                dhcp, inet_ntoa ( bs ) );
905         return 0;
906 }
907
908 /**
909  * Handle received packet during PXE Boot Server Discovery
910  *
911  * @v dhcp              DHCP session
912  * @v dhcppkt           DHCP packet
913  * @v peer              DHCP server address
914  * @v msgtype           DHCP message type
915  * @v server_id         DHCP server ID
916  */
917 static void dhcp_pxebs_rx ( struct dhcp_session *dhcp,
918                             struct dhcp_packet *dhcppkt,
919                             struct sockaddr_in *peer, uint8_t msgtype,
920                             struct in_addr server_id ) {
921         struct dhcp_pxe_boot_menu_item menu_item = { 0, 0 };
922         int rc;
923
924         DBGC ( dhcp, "DHCP %p %s from %s:%d", dhcp,
925                dhcp_msgtype_name ( msgtype ), inet_ntoa ( peer->sin_addr ),
926                ntohs ( peer->sin_port ) );
927         if ( server_id.s_addr != peer->sin_addr.s_addr )
928                 DBGC ( dhcp, " (%s)", inet_ntoa ( server_id ) );
929
930         /* Identify boot menu item */
931         dhcppkt_fetch ( dhcppkt, DHCP_PXE_BOOT_MENU_ITEM,
932                         &menu_item, sizeof ( menu_item ) );
933         if ( menu_item.type )
934                 DBGC ( dhcp, " for type %d", ntohs ( menu_item.type ) );
935         DBGC ( dhcp, "\n" );
936
937         /* Filter out unacceptable responses */
938         if ( ( peer->sin_port != htons ( BOOTPS_PORT ) ) &&
939              ( peer->sin_port != htons ( PXE_PORT ) ) )
940                 return;
941         if ( msgtype != DHCPACK )
942                 return;
943         if ( menu_item.type != dhcp->pxe_type )
944                 return;
945         if ( ! dhcp_pxebs_accept ( dhcp, ( server_id.s_addr ?
946                                            server_id : peer->sin_addr ) ) )
947                 return;
948
949         /* Register settings */
950         dhcppkt->settings.name = PXEBS_SETTINGS_NAME;
951         if ( ( rc = register_settings ( &dhcppkt->settings, NULL ) ) != 0 ) {
952                 DBGC ( dhcp, "DHCP %p could not register settings: %s\n",
953                        dhcp, strerror ( rc ) );
954                 dhcp_finished ( dhcp, rc );
955                 return;
956         }
957
958         /* Terminate DHCP */
959         dhcp_finished ( dhcp, 0 );
960 }
961
962 /**
963  * Handle timer expiry during PXE Boot Server Discovery
964  *
965  * @v dhcp              DHCP session
966  */
967 static void dhcp_pxebs_expired ( struct dhcp_session *dhcp ) {
968         unsigned long elapsed = ( currticks() - dhcp->start );
969
970         /* Give up waiting before we reach the failure point, and fail
971          * over to the next server in the attempt list
972          */
973         if ( elapsed > PXEBS_MAX_TIMEOUT ) {
974                 dhcp->pxe_attempt++;
975                 if ( dhcp->pxe_attempt->s_addr ) {
976                         dhcp_set_state ( dhcp, &dhcp_state_pxebs );
977                         return;
978                 } else {
979                         dhcp_finished ( dhcp, -ETIMEDOUT );
980                         return;
981                 }
982         }
983
984         /* Retransmit current packet */
985         dhcp_tx ( dhcp );
986 }
987
988 /** PXE Boot Server Discovery state operations */
989 static struct dhcp_session_state dhcp_state_pxebs = {
990         .name                   = "PXEBS",
991         .tx                     = dhcp_pxebs_tx,
992         .rx                     = dhcp_pxebs_rx,
993         .expired                = dhcp_pxebs_expired,
994         .tx_msgtype             = DHCPREQUEST,
995         .apply_min_timeout      = 1,
996 };
997
998 /****************************************************************************
999  *
1000  * Packet construction
1001  *
1002  */
1003
1004 /**
1005  * Construct DHCP client hardware address field and broadcast flag
1006  *
1007  * @v netdev            Network device
1008  * @v hlen              DHCP hardware address length to fill in
1009  * @v flags             DHCP flags to fill in
1010  * @ret chaddr          DHCP client hardware address
1011  */
1012 void * dhcp_chaddr ( struct net_device *netdev, uint8_t *hlen,
1013                      uint16_t *flags ) {
1014         struct ll_protocol *ll_protocol = netdev->ll_protocol;
1015         typeof ( ( ( struct dhcphdr * ) NULL )->chaddr ) chaddr;
1016
1017         /* If the link-layer address cannot fit into the chaddr field
1018          * (as is the case for IPoIB) then try using the hardware
1019          * address instead.  If we do this, set the broadcast flag,
1020          * since chaddr then does not represent a valid link-layer
1021          * address for the return path.
1022          *
1023          * If even the hardware address is too large, use an empty
1024          * chaddr field and set the broadcast flag.
1025          *
1026          * This goes against RFC4390, but RFC4390 mandates that we use
1027          * a DHCP client identifier that conforms with RFC4361, which
1028          * we cannot do without either persistent (NIC-independent)
1029          * storage, or by eliminating the hardware address completely
1030          * from the DHCP packet, which seems unfriendly to users.
1031          */
1032         if ( ( *hlen = ll_protocol->ll_addr_len ) <= sizeof ( chaddr ) ) {
1033                 return netdev->ll_addr;
1034         }
1035         *flags = htons ( BOOTP_FL_BROADCAST );
1036         if ( ( *hlen = ll_protocol->hw_addr_len ) <= sizeof ( chaddr ) ) {
1037                 return netdev->hw_addr;
1038         } else {
1039                 *hlen = 0;
1040                 return NULL;
1041         }
1042 }
1043
1044 /**
1045  * Create a DHCP packet
1046  *
1047  * @v dhcppkt           DHCP packet structure to fill in
1048  * @v netdev            Network device
1049  * @v msgtype           DHCP message type
1050  * @v options           Initial options to include (or NULL)
1051  * @v options_len       Length of initial options
1052  * @v data              Buffer for DHCP packet
1053  * @v max_len           Size of DHCP packet buffer
1054  * @ret rc              Return status code
1055  *
1056  * Creates a DHCP packet in the specified buffer, and initialise a
1057  * DHCP packet structure.
1058  */
1059 int dhcp_create_packet ( struct dhcp_packet *dhcppkt,
1060                          struct net_device *netdev, uint8_t msgtype,
1061                          const void *options, size_t options_len,
1062                          void *data, size_t max_len ) {
1063         struct dhcphdr *dhcphdr = data;
1064         void *chaddr;
1065         int rc;
1066
1067         /* Sanity check */
1068         if ( max_len < ( sizeof ( *dhcphdr ) + options_len ) )
1069                 return -ENOSPC;
1070
1071         /* Initialise DHCP packet content */
1072         memset ( dhcphdr, 0, max_len );
1073         dhcphdr->xid = dhcp_xid ( netdev );
1074         dhcphdr->magic = htonl ( DHCP_MAGIC_COOKIE );
1075         dhcphdr->htype = ntohs ( netdev->ll_protocol->ll_proto );
1076         dhcphdr->op = dhcp_op[msgtype];
1077         chaddr = dhcp_chaddr ( netdev, &dhcphdr->hlen, &dhcphdr->flags );
1078         memcpy ( dhcphdr->chaddr, chaddr, dhcphdr->hlen );
1079         memcpy ( dhcphdr->options, options, options_len );
1080
1081         /* Initialise DHCP packet structure */
1082         memset ( dhcppkt, 0, sizeof ( *dhcppkt ) );
1083         dhcppkt_init ( dhcppkt, data, max_len );
1084         
1085         /* Set DHCP_MESSAGE_TYPE option */
1086         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_MESSAGE_TYPE,
1087                                     &msgtype, sizeof ( msgtype ) ) ) != 0 )
1088                 return rc;
1089
1090         return 0;
1091 }
1092
1093 /**
1094  * Create DHCP request packet
1095  *
1096  * @v dhcppkt           DHCP packet structure to fill in
1097  * @v netdev            Network device
1098  * @v msgtype           DHCP message type
1099  * @v ciaddr            Client IP address
1100  * @v data              Buffer for DHCP packet
1101  * @v max_len           Size of DHCP packet buffer
1102  * @ret rc              Return status code
1103  *
1104  * Creates a DHCP request packet in the specified buffer, and
1105  * initialise a DHCP packet structure.
1106  */
1107 int dhcp_create_request ( struct dhcp_packet *dhcppkt,
1108                           struct net_device *netdev, unsigned int msgtype,
1109                           struct in_addr ciaddr, void *data, size_t max_len ) {
1110         struct dhcp_netdev_desc dhcp_desc;
1111         struct dhcp_client_id client_id;
1112         struct dhcp_client_uuid client_uuid;
1113         uint8_t *dhcp_features;
1114         size_t dhcp_features_len;
1115         size_t ll_addr_len;
1116         ssize_t len;
1117         int rc;
1118
1119         /* Create DHCP packet */
1120         if ( ( rc = dhcp_create_packet ( dhcppkt, netdev, msgtype,
1121                                          dhcp_request_options_data,
1122                                          sizeof ( dhcp_request_options_data ),
1123                                          data, max_len ) ) != 0 ) {
1124                 DBG ( "DHCP could not create DHCP packet: %s\n",
1125                       strerror ( rc ) );
1126                 return rc;
1127         }
1128
1129         /* Set client IP address */
1130         dhcppkt->dhcphdr->ciaddr = ciaddr;
1131
1132         /* Add options to identify the feature list */
1133         dhcp_features = table_start ( DHCP_FEATURES );
1134         dhcp_features_len = table_num_entries ( DHCP_FEATURES );
1135         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_EB_ENCAP, dhcp_features,
1136                                     dhcp_features_len ) ) != 0 ) {
1137                 DBG ( "DHCP could not set features list option: %s\n",
1138                       strerror ( rc ) );
1139                 return rc;
1140         }
1141
1142         /* Add options to identify the network device */
1143         fetch_setting ( &netdev->settings.settings, &busid_setting, &dhcp_desc,
1144                 sizeof ( dhcp_desc ) );
1145         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_EB_BUS_ID, &dhcp_desc,
1146                                     sizeof ( dhcp_desc ) ) ) != 0 ) {
1147                 DBG ( "DHCP could not set bus ID option: %s\n",
1148                       strerror ( rc ) );
1149                 return rc;
1150         }
1151
1152         /* Add DHCP client identifier.  Required for Infiniband, and
1153          * doesn't hurt other link layers.
1154          */
1155         client_id.ll_proto = ntohs ( netdev->ll_protocol->ll_proto );
1156         ll_addr_len = netdev->ll_protocol->ll_addr_len;
1157         assert ( ll_addr_len <= sizeof ( client_id.ll_addr ) );
1158         memcpy ( client_id.ll_addr, netdev->ll_addr, ll_addr_len );
1159         if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_CLIENT_ID, &client_id,
1160                                     ( ll_addr_len + 1 ) ) ) != 0 ) {
1161                 DBG ( "DHCP could not set client ID: %s\n",
1162                       strerror ( rc ) );
1163                 return rc;
1164         }
1165
1166         /* Add client UUID, if we have one.  Required for PXE. */
1167         client_uuid.type = DHCP_CLIENT_UUID_TYPE;
1168         if ( ( len = fetch_uuid_setting ( NULL, &uuid_setting,
1169                                           &client_uuid.uuid ) ) >= 0 ) {
1170                 if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_CLIENT_UUID,
1171                                             &client_uuid,
1172                                             sizeof ( client_uuid ) ) ) != 0 ) {
1173                         DBG ( "DHCP could not set client UUID: %s\n",
1174                               strerror ( rc ) );
1175                         return rc;
1176                 }
1177         }
1178
1179         /* Add user class, if we have one. */
1180         if ( ( len = fetch_setting_len ( NULL, &user_class_setting ) ) >= 0 ) {
1181                 char user_class[len];
1182                 fetch_setting ( NULL, &user_class_setting, user_class,
1183                                 sizeof ( user_class ) );
1184                 if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_USER_CLASS_ID,
1185                                             &user_class,
1186                                             sizeof ( user_class ) ) ) != 0 ) {
1187                         DBG ( "DHCP could not set user class: %s\n",
1188                               strerror ( rc ) );
1189                         return rc;
1190                 }
1191         }
1192
1193         return 0;
1194 }
1195
1196 /****************************************************************************
1197  *
1198  * Data transfer interface
1199  *
1200  */
1201
1202 /**
1203  * Transmit DHCP request
1204  *
1205  * @v dhcp              DHCP session
1206  * @ret rc              Return status code
1207  */
1208 static int dhcp_tx ( struct dhcp_session *dhcp ) {
1209         static struct sockaddr_in peer = {
1210                 .sin_family = AF_INET,
1211         };
1212         struct xfer_metadata meta = {
1213                 .netdev = dhcp->netdev,
1214                 .src = ( struct sockaddr * ) &dhcp->local,
1215                 .dest = ( struct sockaddr * ) &peer,
1216         };
1217         struct io_buffer *iobuf;
1218         uint8_t msgtype = dhcp->state->tx_msgtype;
1219         struct dhcp_packet dhcppkt;
1220         int rc;
1221
1222         /* Start retry timer.  Do this first so that failures to
1223          * transmit will be retried.
1224          */
1225         start_timer ( &dhcp->timer );
1226
1227         /* Allocate buffer for packet */
1228         iobuf = xfer_alloc_iob ( &dhcp->xfer, DHCP_MIN_LEN );
1229         if ( ! iobuf )
1230                 return -ENOMEM;
1231
1232         /* Create basic DHCP packet in temporary buffer */
1233         if ( ( rc = dhcp_create_request ( &dhcppkt, dhcp->netdev, msgtype,
1234                                           dhcp->local.sin_addr, iobuf->data,
1235                                           iob_tailroom ( iobuf ) ) ) != 0 ) {
1236                 DBGC ( dhcp, "DHCP %p could not construct DHCP request: %s\n",
1237                        dhcp, strerror ( rc ) );
1238                 goto done;
1239         }
1240
1241         /* Fill in packet based on current state */
1242         if ( ( rc = dhcp->state->tx ( dhcp, &dhcppkt, &peer ) ) != 0 ) {
1243                 DBGC ( dhcp, "DHCP %p could not fill DHCP request: %s\n",
1244                        dhcp, strerror ( rc ) );
1245                 goto done;
1246         }
1247
1248         /* Transmit the packet */
1249         iob_put ( iobuf, dhcppkt.len );
1250         if ( ( rc = xfer_deliver_iob_meta ( &dhcp->xfer, iob_disown ( iobuf ),
1251                                             &meta ) ) != 0 ) {
1252                 DBGC ( dhcp, "DHCP %p could not transmit UDP packet: %s\n",
1253                        dhcp, strerror ( rc ) );
1254                 goto done;
1255         }
1256
1257  done:
1258         free_iob ( iobuf );
1259         return rc;
1260 }
1261
1262 /**
1263  * Receive new data
1264  *
1265  * @v xfer              Data transfer interface
1266  * @v iobuf             I/O buffer
1267  * @v meta              Transfer metadata
1268  * @ret rc              Return status code
1269  */
1270 static int dhcp_deliver_iob ( struct xfer_interface *xfer,
1271                               struct io_buffer *iobuf,
1272                               struct xfer_metadata *meta ) {
1273         struct dhcp_session *dhcp =
1274                 container_of ( xfer, struct dhcp_session, xfer );
1275         struct sockaddr_in *peer;
1276         size_t data_len;
1277         struct dhcp_packet *dhcppkt;
1278         struct dhcphdr *dhcphdr;
1279         uint8_t msgtype = 0;
1280         struct in_addr server_id = { 0 };
1281         int rc = 0;
1282
1283         /* Sanity checks */
1284         if ( ! meta->src ) {
1285                 DBGC ( dhcp, "DHCP %p received packet without source port\n",
1286                        dhcp );
1287                 rc = -EINVAL;
1288                 goto err_no_src;
1289         }
1290         peer = ( struct sockaddr_in * ) meta->src;
1291
1292         /* Create a DHCP packet containing the I/O buffer contents.
1293          * Whilst we could just use the original buffer in situ, that
1294          * would waste the unused space in the packet buffer, and also
1295          * waste a relatively scarce fully-aligned I/O buffer.
1296          */
1297         data_len = iob_len ( iobuf );
1298         dhcppkt = zalloc ( sizeof ( *dhcppkt ) + data_len );
1299         if ( ! dhcppkt ) {
1300                 rc = -ENOMEM;
1301                 goto err_alloc_dhcppkt;
1302         }
1303         dhcphdr = ( ( ( void * ) dhcppkt ) + sizeof ( *dhcppkt ) );
1304         memcpy ( dhcphdr, iobuf->data, data_len );
1305         dhcppkt_init ( dhcppkt, dhcphdr, data_len );
1306
1307         /* Identify message type */
1308         dhcppkt_fetch ( dhcppkt, DHCP_MESSAGE_TYPE, &msgtype,
1309                         sizeof ( msgtype ) );
1310
1311         /* Identify server ID */
1312         dhcppkt_fetch ( dhcppkt, DHCP_SERVER_IDENTIFIER,
1313                         &server_id, sizeof ( server_id ) );
1314
1315         /* Check for matching transaction ID */
1316         if ( dhcphdr->xid != dhcp_xid ( dhcp->netdev ) ) {
1317                 DBGC ( dhcp, "DHCP %p %s from %s:%d has bad transaction "
1318                        "ID\n", dhcp, dhcp_msgtype_name ( msgtype ),
1319                        inet_ntoa ( peer->sin_addr ),
1320                        ntohs ( peer->sin_port ) );
1321                 rc = -EINVAL;
1322                 goto err_xid;
1323         };
1324
1325         /* Handle packet based on current state */
1326         dhcp->state->rx ( dhcp, dhcppkt, peer, msgtype, server_id );
1327
1328  err_xid:
1329         dhcppkt_put ( dhcppkt );
1330  err_alloc_dhcppkt:
1331  err_no_src:
1332         free_iob ( iobuf );
1333         return rc;
1334 }
1335
1336 /** DHCP data transfer interface operations */
1337 static struct xfer_interface_operations dhcp_xfer_operations = {
1338         .close          = ignore_xfer_close,
1339         .vredirect      = xfer_vreopen,
1340         .window         = unlimited_xfer_window,
1341         .alloc_iob      = default_xfer_alloc_iob,
1342         .deliver_iob    = dhcp_deliver_iob,
1343         .deliver_raw    = xfer_deliver_as_iob,
1344 };
1345
1346 /**
1347  * Handle DHCP retry timer expiry
1348  *
1349  * @v timer             DHCP retry timer
1350  * @v fail              Failure indicator
1351  */
1352 static void dhcp_timer_expired ( struct retry_timer *timer, int fail ) {
1353         struct dhcp_session *dhcp =
1354                 container_of ( timer, struct dhcp_session, timer );
1355
1356         /* If we have failed, terminate DHCP */
1357         if ( fail ) {
1358                 dhcp_finished ( dhcp, -ETIMEDOUT );
1359                 return;
1360         }
1361
1362         /* Handle timer expiry based on current state */
1363         dhcp->state->expired ( dhcp );
1364 }
1365
1366 /****************************************************************************
1367  *
1368  * Job control interface
1369  *
1370  */
1371
1372 /**
1373  * Handle kill() event received via job control interface
1374  *
1375  * @v job               DHCP job control interface
1376  */
1377 static void dhcp_job_kill ( struct job_interface *job ) {
1378         struct dhcp_session *dhcp =
1379                 container_of ( job, struct dhcp_session, job );
1380
1381         /* Terminate DHCP session */
1382         dhcp_finished ( dhcp, -ECANCELED );
1383 }
1384
1385 /** DHCP job control interface operations */
1386 static struct job_interface_operations dhcp_job_operations = {
1387         .done           = ignore_job_done,
1388         .kill           = dhcp_job_kill,
1389         .progress       = ignore_job_progress,
1390 };
1391
1392 /****************************************************************************
1393  *
1394  * Instantiators
1395  *
1396  */
1397
1398 /**
1399  * DHCP peer address for socket opening
1400  *
1401  * This is a dummy address; the only useful portion is the socket
1402  * family (so that we get a UDP connection).  The DHCP client will set
1403  * the IP address and source port explicitly on each transmission.
1404  */
1405 static struct sockaddr dhcp_peer = {
1406         .sa_family = AF_INET,
1407 };
1408
1409 /**
1410  * Get cached DHCPACK where none exists
1411  */
1412 __weak void get_cached_dhcpack ( void ) { __keepme }
1413
1414 /**
1415  * Start DHCP state machine on a network device
1416  *
1417  * @v job               Job control interface
1418  * @v netdev            Network device
1419  * @ret rc              Return status code, or positive if cached
1420  *
1421  * Starts DHCP on the specified network device.  If successful, the
1422  * DHCPACK (and ProxyDHCPACK, if applicable) will be registered as
1423  * option sources.
1424  *
1425  * On a return of 0, a background job has been started to perform the
1426  * DHCP request. Any nonzero return means the job has not been
1427  * started; a positive return value indicates the success condition of
1428  * having fetched the appropriate data from cached information.
1429  */
1430 int start_dhcp ( struct job_interface *job, struct net_device *netdev ) {
1431         struct dhcp_session *dhcp;
1432         int rc;
1433
1434         /* Check for cached DHCP information */
1435         get_cached_dhcpack();
1436         if ( fetch_uintz_setting ( NULL, &use_cached_setting ) ) {
1437                 DBG ( "DHCP using cached network settings\n" );
1438                 return 1;
1439         }
1440
1441         /* Allocate and initialise structure */
1442         dhcp = zalloc ( sizeof ( *dhcp ) );
1443         if ( ! dhcp )
1444                 return -ENOMEM;
1445         ref_init ( &dhcp->refcnt, dhcp_free );
1446         job_init ( &dhcp->job, &dhcp_job_operations, &dhcp->refcnt );
1447         xfer_init ( &dhcp->xfer, &dhcp_xfer_operations, &dhcp->refcnt );
1448         timer_init ( &dhcp->timer, dhcp_timer_expired );
1449         dhcp->netdev = netdev_get ( netdev );
1450         dhcp->local.sin_family = AF_INET;
1451         dhcp->local.sin_port = htons ( BOOTPC_PORT );
1452
1453         /* Instantiate child objects and attach to our interfaces */
1454         if ( ( rc = xfer_open_socket ( &dhcp->xfer, SOCK_DGRAM, &dhcp_peer,
1455                                   ( struct sockaddr * ) &dhcp->local ) ) != 0 )
1456                 goto err;
1457
1458         /* Enter DHCPDISCOVER state */
1459         dhcp_set_state ( dhcp, &dhcp_state_discover );
1460
1461         /* Attach parent interface, mortalise self, and return */
1462         job_plug_plug ( &dhcp->job, job );
1463         ref_put ( &dhcp->refcnt );
1464         return 0;
1465
1466  err:
1467         dhcp_finished ( dhcp, rc );
1468         ref_put ( &dhcp->refcnt );
1469         return rc;
1470 }
1471
1472 /**
1473  * Retrieve list of PXE boot servers for a given server type
1474  *
1475  * @v dhcp              DHCP session
1476  * @v raw               DHCP PXE boot server list
1477  * @v raw_len           Length of DHCP PXE boot server list
1478  * @v ip                IP address list to fill in
1479  *
1480  * The caller must ensure that the IP address list has sufficient
1481  * space.
1482  */
1483 static void pxebs_list ( struct dhcp_session *dhcp, void *raw,
1484                          size_t raw_len, struct in_addr *ip ) {
1485         struct dhcp_pxe_boot_server *server = raw;
1486         size_t server_len;
1487         unsigned int i;
1488
1489         while ( raw_len ) {
1490                 if ( raw_len < sizeof ( *server ) ) {
1491                         DBGC ( dhcp, "DHCP %p malformed PXE server list\n",
1492                                dhcp );
1493                         break;
1494                 }
1495                 server_len = offsetof ( typeof ( *server ),
1496                                         ip[ server->num_ip ] );
1497                 if ( raw_len < server_len ) {
1498                         DBGC ( dhcp, "DHCP %p malformed PXE server list\n",
1499                                dhcp );
1500                         break;
1501                 }
1502                 if ( server->type == dhcp->pxe_type ) {
1503                         for ( i = 0 ; i < server->num_ip ; i++ )
1504                                 *(ip++) = server->ip[i];
1505                 }
1506                 server = ( ( ( void * ) server ) + server_len );
1507                 raw_len -= server_len;
1508         }
1509 }
1510
1511 /**
1512  * Start PXE Boot Server Discovery on a network device
1513  *
1514  * @v job               Job control interface
1515  * @v netdev            Network device
1516  * @v pxe_type          PXE server type
1517  * @ret rc              Return status code
1518  *
1519  * Starts PXE Boot Server Discovery on the specified network device.
1520  * If successful, the Boot Server ACK will be registered as an option
1521  * source.
1522  */
1523 int start_pxebs ( struct job_interface *job, struct net_device *netdev,
1524                   unsigned int pxe_type ) {
1525         struct setting pxe_discovery_control_setting =
1526                 { .tag = DHCP_PXE_DISCOVERY_CONTROL };
1527         struct setting pxe_boot_servers_setting =
1528                 { .tag = DHCP_PXE_BOOT_SERVERS };
1529         struct setting pxe_boot_server_mcast_setting =
1530                 { .tag = DHCP_PXE_BOOT_SERVER_MCAST };
1531         ssize_t pxebs_list_len;
1532         struct dhcp_session *dhcp;
1533         struct in_addr *ip;
1534         unsigned int pxe_discovery_control;
1535         int rc;
1536
1537         /* Get upper bound for PXE boot server IP address list */
1538         pxebs_list_len = fetch_setting_len ( NULL, &pxe_boot_servers_setting );
1539         if ( pxebs_list_len < 0 )
1540                 pxebs_list_len = 0;
1541
1542         /* Allocate and initialise structure */
1543         dhcp = zalloc ( sizeof ( *dhcp ) + sizeof ( *ip ) /* mcast */ +
1544                         sizeof ( *ip ) /* bcast */ + pxebs_list_len +
1545                         sizeof ( *ip ) /* terminator */ );
1546         if ( ! dhcp )
1547                 return -ENOMEM;
1548         ref_init ( &dhcp->refcnt, dhcp_free );
1549         job_init ( &dhcp->job, &dhcp_job_operations, &dhcp->refcnt );
1550         xfer_init ( &dhcp->xfer, &dhcp_xfer_operations, &dhcp->refcnt );
1551         timer_init ( &dhcp->timer, dhcp_timer_expired );
1552         dhcp->netdev = netdev_get ( netdev );
1553         dhcp->local.sin_family = AF_INET;
1554         fetch_ipv4_setting ( netdev_settings ( netdev ), &ip_setting,
1555                              &dhcp->local.sin_addr );
1556         dhcp->local.sin_port = htons ( BOOTPC_PORT );
1557         dhcp->pxe_type = cpu_to_le16 ( pxe_type );
1558
1559         /* Construct PXE boot server IP address lists */
1560         pxe_discovery_control =
1561                 fetch_uintz_setting ( NULL, &pxe_discovery_control_setting );
1562         ip = ( ( ( void * ) dhcp ) + sizeof ( *dhcp ) );
1563         dhcp->pxe_attempt = ip;
1564         if ( ! ( pxe_discovery_control & PXEBS_NO_MULTICAST ) ) {
1565                 fetch_ipv4_setting ( NULL, &pxe_boot_server_mcast_setting, ip);
1566                 if ( ip->s_addr )
1567                         ip++;
1568         }
1569         if ( ! ( pxe_discovery_control & PXEBS_NO_BROADCAST ) )
1570                 (ip++)->s_addr = INADDR_BROADCAST;
1571         if ( pxe_discovery_control & PXEBS_NO_UNKNOWN_SERVERS )
1572                 dhcp->pxe_accept = ip;
1573         if ( pxebs_list_len ) {
1574                 uint8_t buf[pxebs_list_len];
1575
1576                 fetch_setting ( NULL, &pxe_boot_servers_setting,
1577                                 buf, sizeof ( buf ) );
1578                 pxebs_list ( dhcp, buf, sizeof ( buf ), ip );
1579         }
1580         if ( ! dhcp->pxe_attempt->s_addr ) {
1581                 DBGC ( dhcp, "DHCP %p has no PXE boot servers for type %04x\n",
1582                        dhcp, pxe_type );
1583                 rc = -EINVAL;
1584                 goto err;
1585         }
1586
1587         /* Dump out PXE server lists */
1588         DBGC ( dhcp, "DHCP %p attempting", dhcp );
1589         for ( ip = dhcp->pxe_attempt ; ip->s_addr ; ip++ )
1590                 DBGC ( dhcp, " %s", inet_ntoa ( *ip ) );
1591         DBGC ( dhcp, "\n" );
1592         if ( dhcp->pxe_accept ) {
1593                 DBGC ( dhcp, "DHCP %p accepting", dhcp );
1594                 for ( ip = dhcp->pxe_accept ; ip->s_addr ; ip++ )
1595                         DBGC ( dhcp, " %s", inet_ntoa ( *ip ) );
1596                 DBGC ( dhcp, "\n" );
1597         }
1598
1599         /* Instantiate child objects and attach to our interfaces */
1600         if ( ( rc = xfer_open_socket ( &dhcp->xfer, SOCK_DGRAM, &dhcp_peer,
1601                                   ( struct sockaddr * ) &dhcp->local ) ) != 0 )
1602                 goto err;
1603
1604         /* Enter PXEBS state */
1605         dhcp_set_state ( dhcp, &dhcp_state_pxebs );
1606
1607         /* Attach parent interface, mortalise self, and return */
1608         job_plug_plug ( &dhcp->job, job );
1609         ref_put ( &dhcp->refcnt );
1610         return 0;
1611
1612  err:
1613         dhcp_finished ( dhcp, rc );
1614         ref_put ( &dhcp->refcnt );
1615         return rc;
1616 }