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