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