src/net/udp/dhcp.c

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