diff options
Diffstat (limited to 'gpxe/src/net/udp')
-rw-r--r-- | gpxe/src/net/udp/dhcp.c | 1587 | ||||
-rw-r--r-- | gpxe/src/net/udp/dns.c | 603 | ||||
-rw-r--r-- | gpxe/src/net/udp/slam.c | 812 | ||||
-rw-r--r-- | gpxe/src/net/udp/tftp.c | 1288 |
4 files changed, 0 insertions, 4290 deletions
diff --git a/gpxe/src/net/udp/dhcp.c b/gpxe/src/net/udp/dhcp.c deleted file mode 100644 index ce2c8207..00000000 --- a/gpxe/src/net/udp/dhcp.c +++ /dev/null @@ -1,1587 +0,0 @@ -/* - * Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>. - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation; either version 2 of the - * License, or any later version. - * - * This program is distributed in the hope that it will be useful, but - * WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - */ - -FILE_LICENCE ( GPL2_OR_LATER ); - -#include <string.h> -#include <stdlib.h> -#include <stdio.h> -#include <ctype.h> -#include <errno.h> -#include <assert.h> -#include <byteswap.h> -#include <gpxe/if_ether.h> -#include <gpxe/netdevice.h> -#include <gpxe/device.h> -#include <gpxe/xfer.h> -#include <gpxe/open.h> -#include <gpxe/job.h> -#include <gpxe/retry.h> -#include <gpxe/tcpip.h> -#include <gpxe/ip.h> -#include <gpxe/uuid.h> -#include <gpxe/timer.h> -#include <gpxe/settings.h> -#include <gpxe/dhcp.h> -#include <gpxe/dhcpopts.h> -#include <gpxe/dhcppkt.h> -#include <gpxe/features.h> - -/** @file - * - * Dynamic Host Configuration Protocol - * - */ - -struct dhcp_session; -static int dhcp_tx ( struct dhcp_session *dhcp ); - -/** - * DHCP operation types - * - * This table maps from DHCP message types (i.e. values of the @c - * DHCP_MESSAGE_TYPE option) to values of the "op" field within a DHCP - * packet. - */ -static const uint8_t dhcp_op[] = { - [DHCPDISCOVER] = BOOTP_REQUEST, - [DHCPOFFER] = BOOTP_REPLY, - [DHCPREQUEST] = BOOTP_REQUEST, - [DHCPDECLINE] = BOOTP_REQUEST, - [DHCPACK] = BOOTP_REPLY, - [DHCPNAK] = BOOTP_REPLY, - [DHCPRELEASE] = BOOTP_REQUEST, - [DHCPINFORM] = BOOTP_REQUEST, -}; - -/** Raw option data for options common to all DHCP requests */ -static uint8_t dhcp_request_options_data[] = { - DHCP_MESSAGE_TYPE, DHCP_BYTE ( 0 ), - DHCP_MAX_MESSAGE_SIZE, - DHCP_WORD ( ETH_MAX_MTU - 20 /* IP header */ - 8 /* UDP header */ ), - DHCP_CLIENT_ARCHITECTURE, DHCP_WORD ( 0 ), - DHCP_CLIENT_NDI, DHCP_OPTION ( 1 /* UNDI */ , 2, 1 /* v2.1 */ ), - DHCP_VENDOR_CLASS_ID, - DHCP_STRING ( 'P', 'X', 'E', 'C', 'l', 'i', 'e', 'n', 't', ':', - 'A', 'r', 'c', 'h', ':', '0', '0', '0', '0', '0', ':', - 'U', 'N', 'D', 'I', ':', '0', '0', '2', '0', '0', '1' ), - DHCP_USER_CLASS_ID, - DHCP_STRING ( 'g', 'P', 'X', 'E' ), - DHCP_PARAMETER_REQUEST_LIST, - DHCP_OPTION ( DHCP_SUBNET_MASK, DHCP_ROUTERS, DHCP_DNS_SERVERS, - DHCP_LOG_SERVERS, DHCP_HOST_NAME, DHCP_DOMAIN_NAME, - DHCP_ROOT_PATH, DHCP_VENDOR_ENCAP, DHCP_VENDOR_CLASS_ID, - DHCP_TFTP_SERVER_NAME, DHCP_BOOTFILE_NAME, - DHCP_EB_ENCAP, DHCP_ISCSI_INITIATOR_IQN ), - DHCP_END -}; - -/** Version number feature */ -FEATURE_VERSION ( VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH ); - -/** DHCP server address setting */ -struct setting dhcp_server_setting __setting = { - .name = "dhcp-server", - .description = "DHCP server address", - .tag = DHCP_SERVER_IDENTIFIER, - .type = &setting_type_ipv4, -}; - -/** DHCP user class setting */ -struct setting user_class_setting __setting = { - .name = "user-class", - .description = "User class identifier", - .tag = DHCP_USER_CLASS_ID, - .type = &setting_type_string, -}; - -/** Use cached network settings */ -struct setting use_cached_setting __setting = { - .name = "use-cached", - .description = "Use cached network settings", - .tag = DHCP_EB_USE_CACHED, - .type = &setting_type_uint8, -}; - -/** - * Name a DHCP packet type - * - * @v msgtype DHCP message type - * @ret string DHCP mesasge type name - */ -static inline const char * dhcp_msgtype_name ( unsigned int msgtype ) { - switch ( msgtype ) { - case DHCPNONE: return "BOOTP"; /* Non-DHCP packet */ - case DHCPDISCOVER: return "DHCPDISCOVER"; - case DHCPOFFER: return "DHCPOFFER"; - case DHCPREQUEST: return "DHCPREQUEST"; - case DHCPDECLINE: return "DHCPDECLINE"; - case DHCPACK: return "DHCPACK"; - case DHCPNAK: return "DHCPNAK"; - case DHCPRELEASE: return "DHCPRELEASE"; - case DHCPINFORM: return "DHCPINFORM"; - default: return "DHCP<invalid>"; - } -} - -/** - * Calculate DHCP transaction ID for a network device - * - * @v netdev Network device - * @ret xid DHCP XID - * - * Extract the least significant bits of the hardware address for use - * as the transaction ID. - */ -static uint32_t dhcp_xid ( struct net_device *netdev ) { - uint32_t xid; - - memcpy ( &xid, ( netdev->ll_addr + netdev->ll_protocol->ll_addr_len - - sizeof ( xid ) ), sizeof ( xid ) ); - return xid; -} - -/**************************************************************************** - * - * DHCP session - * - */ - -struct dhcp_session; - -/** DHCP session state operations */ -struct dhcp_session_state { - /** State name */ - const char *name; - /** - * Construct transmitted packet - * - * @v dhcp DHCP session - * @v dhcppkt DHCP packet - * @v peer Destination address - */ - int ( * tx ) ( struct dhcp_session *dhcp, - struct dhcp_packet *dhcppkt, - struct sockaddr_in *peer ); - /** Handle received packet - * - * @v dhcp DHCP session - * @v dhcppkt DHCP packet - * @v peer DHCP server address - * @v msgtype DHCP message type - * @v server_id DHCP server ID - */ - void ( * rx ) ( struct dhcp_session *dhcp, - struct dhcp_packet *dhcppkt, - struct sockaddr_in *peer, - uint8_t msgtype, struct in_addr server_id ); - /** Handle timer expiry - * - * @v dhcp DHCP session - */ - void ( * expired ) ( struct dhcp_session *dhcp ); - /** Transmitted message type */ - uint8_t tx_msgtype; - /** Apply minimum timeout */ - uint8_t apply_min_timeout; -}; - -static struct dhcp_session_state dhcp_state_discover; -static struct dhcp_session_state dhcp_state_request; -static struct dhcp_session_state dhcp_state_proxy; -static struct dhcp_session_state dhcp_state_pxebs; - -/** DHCP offer is valid for IP lease */ -#define DHCP_OFFER_IP 1 - -/** DHCP offer is valid for PXE options */ -#define DHCP_OFFER_PXE 2 - -/** A DHCP offer */ -struct dhcp_offer { - /** IP address of server granting offer */ - struct in_addr server; - - /** IP address being offered, or 0.0.0.0 for a pure proxy */ - struct in_addr ip; - - /** DHCP packet containing PXE options; NULL if missing or proxied */ - struct dhcp_packet *pxe; - - /** Valid uses for this offer, a combination of DHCP_OFFER bits */ - uint8_t valid; - - /** Priority of this offer */ - int8_t priority; - - /** Whether to ignore PXE DHCP extensions */ - uint8_t no_pxedhcp; -}; - -/** Maximum number of DHCP offers to queue */ -#define DHCP_MAX_OFFERS 6 - -/** A DHCP session */ -struct dhcp_session { - /** Reference counter */ - struct refcnt refcnt; - /** Job control interface */ - struct job_interface job; - /** Data transfer interface */ - struct xfer_interface xfer; - - /** Network device being configured */ - struct net_device *netdev; - /** Local socket address */ - struct sockaddr_in local; - /** State of the session */ - struct dhcp_session_state *state; - - /** PXE Boot Server type */ - uint16_t pxe_type; - /** List of PXE Boot Servers to attempt */ - struct in_addr *pxe_attempt; - /** List of PXE Boot Servers to accept */ - struct in_addr *pxe_accept; - - /** Retransmission timer */ - struct retry_timer timer; - /** Start time of the current state (in ticks) */ - unsigned long start; - - /** DHCP offer just requested */ - struct dhcp_offer *current_offer; - /** List of DHCP offers received */ - struct dhcp_offer offers[DHCP_MAX_OFFERS]; -}; - -/** - * Free DHCP session - * - * @v refcnt Reference counter - */ -static void dhcp_free ( struct refcnt *refcnt ) { - struct dhcp_session *dhcp = - container_of ( refcnt, struct dhcp_session, refcnt ); - int i; - - for ( i = 0 ; i < DHCP_MAX_OFFERS ; i++ ) { - if ( dhcp->offers[i].pxe ) - dhcppkt_put ( dhcp->offers[i].pxe ); - } - - netdev_put ( dhcp->netdev ); - free ( dhcp ); -} - -/** - * Mark DHCP session as complete - * - * @v dhcp DHCP session - * @v rc Return status code - */ -static void dhcp_finished ( struct dhcp_session *dhcp, int rc ) { - - /* Block futher incoming messages */ - job_nullify ( &dhcp->job ); - xfer_nullify ( &dhcp->xfer ); - - /* Stop retry timer */ - stop_timer ( &dhcp->timer ); - - /* Free resources and close interfaces */ - xfer_close ( &dhcp->xfer, rc ); - job_done ( &dhcp->job, rc ); -} - -/** - * Transition to new DHCP session state - * - * @v dhcp DHCP session - * @v state New session state - */ -static void dhcp_set_state ( struct dhcp_session *dhcp, - struct dhcp_session_state *state ) { - - DBGC ( dhcp, "DHCP %p entering %s state\n", dhcp, state->name ); - dhcp->state = state; - dhcp->start = currticks(); - stop_timer ( &dhcp->timer ); - dhcp->timer.min_timeout = - ( state->apply_min_timeout ? DHCP_MIN_TIMEOUT : 0 ); - dhcp->timer.max_timeout = DHCP_MAX_TIMEOUT; - start_timer_nodelay ( &dhcp->timer ); -} - -/** - * Determine next DHCP offer to try - * - * @v dhcp DHCP session - * @v type DHCP offer type - * @ret offer Next DHCP offer to try - * - * Offers are ranked by priority, then by completeness (combined - * IP+PXE are tried before @a type alone), then by order of receipt. - */ -static struct dhcp_offer * dhcp_next_offer ( struct dhcp_session *dhcp, - uint8_t type ) { - - struct dhcp_offer *offer; - struct dhcp_offer *best = NULL; - - for ( offer = dhcp->offers ; offer < dhcp->offers + DHCP_MAX_OFFERS ; - offer++ ) { - if ( ( offer->valid & type ) && - ( ( best == NULL ) || - ( offer->priority > best->priority ) || - ( ( offer->priority == best->priority ) && - ( offer->valid & ~best->valid ) ) ) ) - best = offer; - } - - return best; -} - -/**************************************************************************** - * - * DHCP state machine - * - */ - -/** - * Construct transmitted packet for DHCP discovery - * - * @v dhcp DHCP session - * @v dhcppkt DHCP packet - * @v peer Destination address - */ -static int dhcp_discovery_tx ( struct dhcp_session *dhcp, - struct dhcp_packet *dhcppkt __unused, - struct sockaddr_in *peer ) { - - DBGC ( dhcp, "DHCP %p DHCPDISCOVER\n", dhcp ); - - /* Set server address */ - peer->sin_addr.s_addr = INADDR_BROADCAST; - peer->sin_port = htons ( BOOTPS_PORT ); - - return 0; -} - -/** - * Handle received DHCPOFFER during any state - * - * @v dhcp DHCP session - * @v dhcppkt DHCP packet - * @v peer DHCP server address - * @v msgtype DHCP message type - * @v server_id DHCP server ID - */ -static void dhcp_rx_offer ( struct dhcp_session *dhcp, - struct dhcp_packet *dhcppkt, - struct sockaddr_in *peer, uint8_t msgtype, - struct in_addr server_id ) { - char vci[9]; /* "PXEClient" */ - int vci_len; - int has_pxeclient; - int pxeopts_len; - int has_pxeopts; - struct dhcp_offer *offer; - int i; - - DBGC ( dhcp, "DHCP %p %s from %s:%d", dhcp, - dhcp_msgtype_name ( msgtype ), inet_ntoa ( peer->sin_addr ), - ntohs ( peer->sin_port ) ); - if ( server_id.s_addr != peer->sin_addr.s_addr ) - DBGC ( dhcp, " (%s)", inet_ntoa ( server_id ) ); - - /* Identify offered IP address */ - if ( dhcppkt->dhcphdr->yiaddr.s_addr ) - DBGC ( dhcp, " for %s", inet_ntoa ( dhcppkt->dhcphdr->yiaddr )); - - /* Enqueue an offer to be filled in */ - for ( i = 0 ; i < DHCP_MAX_OFFERS ; i++ ) { - if ( dhcp->offers[i].server.s_addr == server_id.s_addr ) { - DBGC ( dhcp, " dup\n" ); - return; - } - - if ( ! dhcp->offers[i].valid ) - break; - } - if ( i == DHCP_MAX_OFFERS ) { - DBGC ( dhcp, " dropped\n" ); - return; - } - - offer = &dhcp->offers[i]; - offer->server = server_id; - offer->ip = dhcppkt->dhcphdr->yiaddr; - - /* Identify "PXEClient" vendor class */ - vci_len = dhcppkt_fetch ( dhcppkt, DHCP_VENDOR_CLASS_ID, - vci, sizeof ( vci ) ); - has_pxeclient = ( ( vci_len >= ( int ) sizeof ( vci ) ) && - ( strncmp ( "PXEClient", vci, sizeof (vci) ) == 0 )); - - /* Identify presence of PXE-specific options */ - pxeopts_len = dhcppkt_fetch ( dhcppkt, DHCP_PXE_BOOT_MENU, NULL, 0 ); - has_pxeopts = ( pxeopts_len >= 0 ); - if ( has_pxeclient ) - DBGC ( dhcp, "%s", ( has_pxeopts ? " pxe" : " proxy" ) ); - - if ( has_pxeclient && has_pxeopts ) { - /* Save reference to packet for future use */ - if ( offer->pxe ) - dhcppkt_put ( offer->pxe ); - offer->pxe = dhcppkt_get ( dhcppkt ); - } - - /* Identify priority */ - dhcppkt_fetch ( dhcppkt, DHCP_EB_PRIORITY, &offer->priority, - sizeof ( offer->priority ) ); - if ( offer->priority ) - DBGC ( dhcp, " pri %d", offer->priority ); - - /* Identify ignore-PXE flag */ - dhcppkt_fetch ( dhcppkt, DHCP_EB_NO_PXEDHCP, &offer->no_pxedhcp, - sizeof ( offer->no_pxedhcp ) ); - if ( offer->no_pxedhcp ) - DBGC ( dhcp, " nopxe" ); - DBGC ( dhcp, "\n" ); - - /* Determine roles this offer can fill */ - if ( offer->ip.s_addr && - ( peer->sin_port == htons ( BOOTPS_PORT ) ) && - ( ( msgtype == DHCPOFFER ) || ( ! msgtype /* BOOTP */ ) ) ) - offer->valid |= DHCP_OFFER_IP; - - if ( has_pxeclient && ( msgtype == DHCPOFFER ) ) - offer->valid |= DHCP_OFFER_PXE; -} - -/** - * Handle received packet during DHCP discovery - * - * @v dhcp DHCP session - * @v dhcppkt DHCP packet - * @v peer DHCP server address - * @v msgtype DHCP message type - * @v server_id DHCP server ID - */ -static void dhcp_discovery_rx ( struct dhcp_session *dhcp, - struct dhcp_packet *dhcppkt, - struct sockaddr_in *peer, uint8_t msgtype, - struct in_addr server_id ) { - unsigned long elapsed; - struct dhcp_offer *ip_offer; - - dhcp_rx_offer ( dhcp, dhcppkt, peer, msgtype, server_id ); - - /* We can exit the discovery state when we have a valid - * DHCPOFFER, and either: - * - * o The DHCPOFFER instructs us to ignore ProxyDHCPOFFERs, or - * o We have a valid ProxyDHCPOFFER, or - * o We have allowed sufficient time for ProxyDHCPOFFERs. - */ - - /* If we don't yet have a DHCPOFFER, do nothing */ - ip_offer = dhcp_next_offer ( dhcp, DHCP_OFFER_IP ); - if ( ! ip_offer ) - return; - - /* If we can't yet transition to DHCPREQUEST, do nothing */ - elapsed = ( currticks() - dhcp->start ); - if ( ! ( ip_offer->no_pxedhcp || - dhcp_next_offer ( dhcp, DHCP_OFFER_PXE ) || - ( elapsed > PROXYDHCP_MAX_TIMEOUT ) ) ) - return; - - /* Transition to DHCPREQUEST */ - dhcp_set_state ( dhcp, &dhcp_state_request ); -} - -/** - * Handle timer expiry during DHCP discovery - * - * @v dhcp DHCP session - */ -static void dhcp_discovery_expired ( struct dhcp_session *dhcp ) { - unsigned long elapsed = ( currticks() - dhcp->start ); - - /* Give up waiting for ProxyDHCP before we reach the failure point */ - if ( dhcp_next_offer ( dhcp, DHCP_OFFER_IP ) && - ( elapsed > PROXYDHCP_MAX_TIMEOUT ) ) { - dhcp_set_state ( dhcp, &dhcp_state_request ); - return; - } - - /* Otherwise, retransmit current packet */ - dhcp_tx ( dhcp ); -} - -/** DHCP discovery state operations */ -static struct dhcp_session_state dhcp_state_discover = { - .name = "discovery", - .tx = dhcp_discovery_tx, - .rx = dhcp_discovery_rx, - .expired = dhcp_discovery_expired, - .tx_msgtype = DHCPDISCOVER, - .apply_min_timeout = 1, -}; - -/** - * Construct transmitted packet for DHCP request - * - * @v dhcp DHCP session - * @v dhcppkt DHCP packet - * @v peer Destination address - */ -static int dhcp_request_tx ( struct dhcp_session *dhcp, - struct dhcp_packet *dhcppkt, - struct sockaddr_in *peer ) { - int rc; - struct dhcp_offer *offer; - - offer = dhcp->current_offer = dhcp_next_offer ( dhcp, DHCP_OFFER_IP ); - - DBGC ( dhcp, "DHCP %p DHCPREQUEST to %s:%d", - dhcp, inet_ntoa ( offer->server ), BOOTPS_PORT ); - DBGC ( dhcp, " for %s\n", inet_ntoa ( offer->ip ) ); - - /* Set server ID */ - if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_SERVER_IDENTIFIER, - &offer->server, - sizeof ( offer->server ) ) ) != 0 ) - return rc; - - /* Set requested IP address */ - if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_REQUESTED_ADDRESS, - &offer->ip, sizeof ( offer->ip ) ) ) != 0 ) - return rc; - - /* Set server address */ - peer->sin_addr.s_addr = INADDR_BROADCAST; - peer->sin_port = htons ( BOOTPS_PORT ); - - return 0; -} - -/** - * Handle received packet during DHCP request - * - * @v dhcp DHCP session - * @v dhcppkt DHCP packet - * @v peer DHCP server address - * @v msgtype DHCP message type - * @v server_id DHCP server ID - */ -static void dhcp_request_rx ( struct dhcp_session *dhcp, - struct dhcp_packet *dhcppkt, - struct sockaddr_in *peer, uint8_t msgtype, - struct in_addr server_id ) { - struct in_addr ip; - struct settings *parent; - int rc; - struct dhcp_offer *pxe_offer; - - if ( msgtype == DHCPOFFER ) { - dhcp_rx_offer ( dhcp, dhcppkt, peer, msgtype, server_id ); - if ( dhcp_next_offer ( dhcp, DHCP_OFFER_IP ) != - dhcp->current_offer ) { - /* Restart due to higher-priority offer received */ - DBGC ( dhcp, "DHCP %p re-requesting\n", dhcp ); - dhcp_set_state ( dhcp, &dhcp_state_request ); - } - return; - } - - DBGC ( dhcp, "DHCP %p %s from %s:%d", dhcp, - dhcp_msgtype_name ( msgtype ), inet_ntoa ( peer->sin_addr ), - ntohs ( peer->sin_port ) ); - if ( server_id.s_addr != peer->sin_addr.s_addr ) - DBGC ( dhcp, " (%s)", inet_ntoa ( server_id ) ); - - /* Identify leased IP address */ - ip = dhcppkt->dhcphdr->yiaddr; - if ( ip.s_addr ) - DBGC ( dhcp, " for %s", inet_ntoa ( ip ) ); - DBGC ( dhcp, "\n" ); - - /* Filter out unacceptable responses */ - if ( peer->sin_port != htons ( BOOTPS_PORT ) ) - return; - if ( msgtype /* BOOTP */ && ( msgtype != DHCPACK ) ) - return; - if ( server_id.s_addr != dhcp->current_offer->server.s_addr ) - return; - - /* Record assigned address */ - dhcp->local.sin_addr = ip; - - /* Register settings */ - parent = netdev_settings ( dhcp->netdev ); - if ( ( rc = register_settings ( &dhcppkt->settings, parent ) ) != 0 ){ - DBGC ( dhcp, "DHCP %p could not register settings: %s\n", - dhcp, strerror ( rc ) ); - dhcp_finished ( dhcp, rc ); - return; - } - - /* Locate best source of PXE settings */ - pxe_offer = dhcp_next_offer ( dhcp, DHCP_OFFER_PXE ); - - if ( ( ! pxe_offer ) || /* No PXE available */ - /* IP offer instructs us to ignore PXE */ - dhcp->current_offer->no_pxedhcp || - /* PXE settings already registered with IP offer */ - ( ( dhcp->current_offer == pxe_offer ) && ( pxe_offer->pxe ) ) ) { - - /* Terminate DHCP */ - dhcp_finished ( dhcp, 0 ); - - } else if ( pxe_offer->pxe ) { - /* Register PXE settings and terminate DHCP */ - pxe_offer->pxe->settings.name = PROXYDHCP_SETTINGS_NAME; - if ( ( rc = register_settings ( &pxe_offer->pxe->settings, - NULL ) ) != 0 ) { - DBGC ( dhcp, "DHCP %p could not register settings: " - "%s\n", dhcp, strerror ( rc ) ); - } - dhcp_finished ( dhcp, rc ); - } else { - /* Start ProxyDHCP */ - dhcp_set_state ( dhcp, &dhcp_state_proxy ); - } -} - -/** - * Handle timer expiry during DHCP discovery - * - * @v dhcp DHCP session - */ -static void dhcp_request_expired ( struct dhcp_session *dhcp ) { - - /* Retransmit current packet */ - dhcp_tx ( dhcp ); -} - -/** DHCP request state operations */ -static struct dhcp_session_state dhcp_state_request = { - .name = "request", - .tx = dhcp_request_tx, - .rx = dhcp_request_rx, - .expired = dhcp_request_expired, - .tx_msgtype = DHCPREQUEST, - .apply_min_timeout = 0, -}; - -/** - * Construct transmitted packet for ProxyDHCP request - * - * @v dhcp DHCP session - * @v dhcppkt DHCP packet - * @v peer Destination address - */ -static int dhcp_proxy_tx ( struct dhcp_session *dhcp, - struct dhcp_packet *dhcppkt, - struct sockaddr_in *peer ) { - int rc; - struct dhcp_offer *offer; - - offer = dhcp->current_offer = dhcp_next_offer ( dhcp, DHCP_OFFER_PXE ); - - DBGC ( dhcp, "DHCP %p ProxyDHCP REQUEST to %s:%d\n", dhcp, - inet_ntoa ( offer->server ), PXE_PORT ); - - /* Set server ID */ - if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_SERVER_IDENTIFIER, - &offer->server, - sizeof ( offer->server ) ) ) != 0 ) - return rc; - - /* Set server address */ - peer->sin_addr = offer->server; - peer->sin_port = htons ( PXE_PORT ); - - return 0; -} - -/** - * Handle received packet during ProxyDHCP request - * - * @v dhcp DHCP session - * @v dhcppkt DHCP packet - * @v peer DHCP server address - * @v msgtype DHCP message type - * @v server_id DHCP server ID - */ -static void dhcp_proxy_rx ( struct dhcp_session *dhcp, - struct dhcp_packet *dhcppkt, - struct sockaddr_in *peer, uint8_t msgtype, - struct in_addr server_id ) { - int rc; - - /* Enqueue last-minute DHCPOFFERs for use in case of failure */ - if ( peer->sin_port == htons ( BOOTPS_PORT ) && - msgtype == DHCPOFFER ) { - dhcp_rx_offer ( dhcp, dhcppkt, peer, msgtype, server_id ); - return; - } - - DBGC ( dhcp, "DHCP %p %s from %s:%d", dhcp, - dhcp_msgtype_name ( msgtype ), inet_ntoa ( peer->sin_addr ), - ntohs ( peer->sin_port ) ); - if ( server_id.s_addr != peer->sin_addr.s_addr ) - DBGC ( dhcp, " (%s)", inet_ntoa ( server_id ) ); - DBGC ( dhcp, "\n" ); - - /* Filter out unacceptable responses */ - if ( peer->sin_port != htons ( PXE_PORT ) ) - return; - if ( msgtype != DHCPACK && msgtype != DHCPOFFER ) - return; - if ( server_id.s_addr /* Linux PXE server omits server ID */ && - ( server_id.s_addr != dhcp->current_offer->server.s_addr ) ) - return; - - /* Register settings */ - dhcppkt->settings.name = PROXYDHCP_SETTINGS_NAME; - if ( ( rc = register_settings ( &dhcppkt->settings, NULL ) ) != 0 ) { - DBGC ( dhcp, "DHCP %p could not register settings: %s\n", - dhcp, strerror ( rc ) ); - dhcp_finished ( dhcp, rc ); - return; - } - - /* Terminate DHCP */ - dhcp_finished ( dhcp, 0 ); -} - -/** - * Handle timer expiry during ProxyDHCP request - * - * @v dhcp DHCP session - */ -static void dhcp_proxy_expired ( struct dhcp_session *dhcp ) { - unsigned long elapsed = ( currticks() - dhcp->start ); - - /* Give up waiting for ProxyDHCP before we reach the failure point */ - if ( elapsed > PROXYDHCP_MAX_TIMEOUT ) { - - /* Mark failed offer as unsuitable for ProxyDHCP */ - dhcp->current_offer->valid &= ~DHCP_OFFER_PXE; - - /* Prefer not to use only half of a PXE+IP offer if we - * have other offers available - */ - dhcp->current_offer->priority = -1; - - /* If we have any other PXE offers we can try, go back - * to DHCPREQUEST (since they might not be proxied - * offers, or might be coupled to a new IP address). - * We should probably DHCPRELEASE our old IP, but the - * standard does not require it. - */ - if ( dhcp_next_offer ( dhcp, DHCP_OFFER_PXE ) ) { - dhcp->local.sin_addr.s_addr = 0; - dhcp_set_state ( dhcp, &dhcp_state_request ); - return; - } - - /* No possibilities left; finish without PXE options */ - dhcp_finished ( dhcp, 0 ); - return; - } - - /* Retransmit current packet */ - dhcp_tx ( dhcp ); -} - -/** ProxyDHCP request state operations */ -static struct dhcp_session_state dhcp_state_proxy = { - .name = "ProxyDHCP", - .tx = dhcp_proxy_tx, - .rx = dhcp_proxy_rx, - .expired = dhcp_proxy_expired, - .tx_msgtype = DHCPREQUEST, - .apply_min_timeout = 0, -}; - -/** - * Construct transmitted packet for PXE Boot Server Discovery - * - * @v dhcp DHCP session - * @v dhcppkt DHCP packet - * @v peer Destination address - */ -static int dhcp_pxebs_tx ( struct dhcp_session *dhcp, - struct dhcp_packet *dhcppkt, - struct sockaddr_in *peer ) { - struct dhcp_pxe_boot_menu_item menu_item = { 0, 0 }; - int rc; - - /* Set server address */ - peer->sin_addr = *(dhcp->pxe_attempt); - peer->sin_port = ( ( peer->sin_addr.s_addr == INADDR_BROADCAST ) ? - htons ( BOOTPS_PORT ) : htons ( PXE_PORT ) ); - - DBGC ( dhcp, "DHCP %p PXEBS REQUEST to %s:%d for type %d\n", - dhcp, inet_ntoa ( peer->sin_addr ), ntohs ( peer->sin_port ), - le16_to_cpu ( dhcp->pxe_type ) ); - - /* Set boot menu item */ - menu_item.type = dhcp->pxe_type; - if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_PXE_BOOT_MENU_ITEM, - &menu_item, sizeof ( menu_item ) ) ) != 0 ) - return rc; - - return 0; -} - -/** - * Check to see if PXE Boot Server address is acceptable - * - * @v dhcp DHCP session - * @v bs Boot Server address - * @ret accept Boot Server is acceptable - */ -static int dhcp_pxebs_accept ( struct dhcp_session *dhcp, - struct in_addr bs ) { - struct in_addr *accept; - - /* Accept if we have no acceptance filter */ - if ( ! dhcp->pxe_accept ) - return 1; - - /* Scan through acceptance list */ - for ( accept = dhcp->pxe_accept ; accept->s_addr ; accept++ ) { - if ( accept->s_addr == bs.s_addr ) - return 1; - } - - DBGC ( dhcp, "DHCP %p rejecting server %s\n", - dhcp, inet_ntoa ( bs ) ); - return 0; -} - -/** - * Handle received packet during PXE Boot Server Discovery - * - * @v dhcp DHCP session - * @v dhcppkt DHCP packet - * @v peer DHCP server address - * @v msgtype DHCP message type - * @v server_id DHCP server ID - */ -static void dhcp_pxebs_rx ( struct dhcp_session *dhcp, - struct dhcp_packet *dhcppkt, - struct sockaddr_in *peer, uint8_t msgtype, - struct in_addr server_id ) { - struct dhcp_pxe_boot_menu_item menu_item = { 0, 0 }; - int rc; - - DBGC ( dhcp, "DHCP %p %s from %s:%d", dhcp, - dhcp_msgtype_name ( msgtype ), inet_ntoa ( peer->sin_addr ), - ntohs ( peer->sin_port ) ); - if ( server_id.s_addr != peer->sin_addr.s_addr ) - DBGC ( dhcp, " (%s)", inet_ntoa ( server_id ) ); - - /* Identify boot menu item */ - dhcppkt_fetch ( dhcppkt, DHCP_PXE_BOOT_MENU_ITEM, - &menu_item, sizeof ( menu_item ) ); - if ( menu_item.type ) - DBGC ( dhcp, " for type %d", ntohs ( menu_item.type ) ); - DBGC ( dhcp, "\n" ); - - /* Filter out unacceptable responses */ - if ( ( peer->sin_port != htons ( BOOTPS_PORT ) ) && - ( peer->sin_port != htons ( PXE_PORT ) ) ) - return; - if ( msgtype != DHCPACK ) - return; - if ( menu_item.type != dhcp->pxe_type ) - return; - if ( ! dhcp_pxebs_accept ( dhcp, ( server_id.s_addr ? - server_id : peer->sin_addr ) ) ) - return; - - /* Register settings */ - dhcppkt->settings.name = PXEBS_SETTINGS_NAME; - if ( ( rc = register_settings ( &dhcppkt->settings, NULL ) ) != 0 ) { - DBGC ( dhcp, "DHCP %p could not register settings: %s\n", - dhcp, strerror ( rc ) ); - dhcp_finished ( dhcp, rc ); - return; - } - - /* Terminate DHCP */ - dhcp_finished ( dhcp, 0 ); -} - -/** - * Handle timer expiry during PXE Boot Server Discovery - * - * @v dhcp DHCP session - */ -static void dhcp_pxebs_expired ( struct dhcp_session *dhcp ) { - unsigned long elapsed = ( currticks() - dhcp->start ); - - /* Give up waiting before we reach the failure point, and fail - * over to the next server in the attempt list - */ - if ( elapsed > PXEBS_MAX_TIMEOUT ) { - dhcp->pxe_attempt++; - if ( dhcp->pxe_attempt->s_addr ) { - dhcp_set_state ( dhcp, &dhcp_state_pxebs ); - return; - } else { - dhcp_finished ( dhcp, -ETIMEDOUT ); - return; - } - } - - /* Retransmit current packet */ - dhcp_tx ( dhcp ); -} - -/** PXE Boot Server Discovery state operations */ -static struct dhcp_session_state dhcp_state_pxebs = { - .name = "PXEBS", - .tx = dhcp_pxebs_tx, - .rx = dhcp_pxebs_rx, - .expired = dhcp_pxebs_expired, - .tx_msgtype = DHCPREQUEST, - .apply_min_timeout = 1, -}; - -/**************************************************************************** - * - * Packet construction - * - */ - -/** - * Construct DHCP client hardware address field and broadcast flag - * - * @v netdev Network device - * @v hlen DHCP hardware address length to fill in - * @v flags DHCP flags to fill in - * @ret chaddr DHCP client hardware address - */ -void * dhcp_chaddr ( struct net_device *netdev, uint8_t *hlen, - uint16_t *flags ) { - struct ll_protocol *ll_protocol = netdev->ll_protocol; - typeof ( ( ( struct dhcphdr * ) NULL )->chaddr ) chaddr; - - /* If the link-layer address cannot fit into the chaddr field - * (as is the case for IPoIB) then try using the hardware - * address instead. If we do this, set the broadcast flag, - * since chaddr then does not represent a valid link-layer - * address for the return path. - * - * If even the hardware address is too large, use an empty - * chaddr field and set the broadcast flag. - * - * This goes against RFC4390, but RFC4390 mandates that we use - * a DHCP client identifier that conforms with RFC4361, which - * we cannot do without either persistent (NIC-independent) - * storage, or by eliminating the hardware address completely - * from the DHCP packet, which seems unfriendly to users. - */ - if ( ( *hlen = ll_protocol->ll_addr_len ) <= sizeof ( chaddr ) ) { - return netdev->ll_addr; - } - *flags = htons ( BOOTP_FL_BROADCAST ); - if ( ( *hlen = ll_protocol->hw_addr_len ) <= sizeof ( chaddr ) ) { - return netdev->hw_addr; - } else { - *hlen = 0; - return NULL; - } -} - -/** - * Create a DHCP packet - * - * @v dhcppkt DHCP packet structure to fill in - * @v netdev Network device - * @v msgtype DHCP message type - * @v options Initial options to include (or NULL) - * @v options_len Length of initial options - * @v data Buffer for DHCP packet - * @v max_len Size of DHCP packet buffer - * @ret rc Return status code - * - * Creates a DHCP packet in the specified buffer, and initialise a - * DHCP packet structure. - */ -int dhcp_create_packet ( struct dhcp_packet *dhcppkt, - struct net_device *netdev, uint8_t msgtype, - const void *options, size_t options_len, - void *data, size_t max_len ) { - struct dhcphdr *dhcphdr = data; - void *chaddr; - int rc; - - /* Sanity check */ - if ( max_len < ( sizeof ( *dhcphdr ) + options_len ) ) - return -ENOSPC; - - /* Initialise DHCP packet content */ - memset ( dhcphdr, 0, max_len ); - dhcphdr->xid = dhcp_xid ( netdev ); - dhcphdr->magic = htonl ( DHCP_MAGIC_COOKIE ); - dhcphdr->htype = ntohs ( netdev->ll_protocol->ll_proto ); - dhcphdr->op = dhcp_op[msgtype]; - chaddr = dhcp_chaddr ( netdev, &dhcphdr->hlen, &dhcphdr->flags ); - memcpy ( dhcphdr->chaddr, chaddr, dhcphdr->hlen ); - memcpy ( dhcphdr->options, options, options_len ); - - /* Initialise DHCP packet structure */ - memset ( dhcppkt, 0, sizeof ( *dhcppkt ) ); - dhcppkt_init ( dhcppkt, data, max_len ); - - /* Set DHCP_MESSAGE_TYPE option */ - if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_MESSAGE_TYPE, - &msgtype, sizeof ( msgtype ) ) ) != 0 ) - return rc; - - return 0; -} - -/** - * Create DHCP request packet - * - * @v dhcppkt DHCP packet structure to fill in - * @v netdev Network device - * @v msgtype DHCP message type - * @v ciaddr Client IP address - * @v data Buffer for DHCP packet - * @v max_len Size of DHCP packet buffer - * @ret rc Return status code - * - * Creates a DHCP request packet in the specified buffer, and - * initialise a DHCP packet structure. - */ -int dhcp_create_request ( struct dhcp_packet *dhcppkt, - struct net_device *netdev, unsigned int msgtype, - struct in_addr ciaddr, void *data, size_t max_len ) { - struct dhcp_netdev_desc dhcp_desc; - struct dhcp_client_id client_id; - struct dhcp_client_uuid client_uuid; - uint8_t *dhcp_features; - size_t dhcp_features_len; - size_t ll_addr_len; - ssize_t len; - int rc; - - /* Create DHCP packet */ - if ( ( rc = dhcp_create_packet ( dhcppkt, netdev, msgtype, - dhcp_request_options_data, - sizeof ( dhcp_request_options_data ), - data, max_len ) ) != 0 ) { - DBG ( "DHCP could not create DHCP packet: %s\n", - strerror ( rc ) ); - return rc; - } - - /* Set client IP address */ - dhcppkt->dhcphdr->ciaddr = ciaddr; - - /* Add options to identify the feature list */ - dhcp_features = table_start ( DHCP_FEATURES ); - dhcp_features_len = table_num_entries ( DHCP_FEATURES ); - if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_EB_ENCAP, dhcp_features, - dhcp_features_len ) ) != 0 ) { - DBG ( "DHCP could not set features list option: %s\n", - strerror ( rc ) ); - return rc; - } - - /* Add options to identify the network device */ - fetch_setting ( &netdev->settings.settings, &busid_setting, &dhcp_desc, - sizeof ( dhcp_desc ) ); - if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_EB_BUS_ID, &dhcp_desc, - sizeof ( dhcp_desc ) ) ) != 0 ) { - DBG ( "DHCP could not set bus ID option: %s\n", - strerror ( rc ) ); - return rc; - } - - /* Add DHCP client identifier. Required for Infiniband, and - * doesn't hurt other link layers. - */ - client_id.ll_proto = ntohs ( netdev->ll_protocol->ll_proto ); - ll_addr_len = netdev->ll_protocol->ll_addr_len; - assert ( ll_addr_len <= sizeof ( client_id.ll_addr ) ); - memcpy ( client_id.ll_addr, netdev->ll_addr, ll_addr_len ); - if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_CLIENT_ID, &client_id, - ( ll_addr_len + 1 ) ) ) != 0 ) { - DBG ( "DHCP could not set client ID: %s\n", - strerror ( rc ) ); - return rc; - } - - /* Add client UUID, if we have one. Required for PXE. */ - client_uuid.type = DHCP_CLIENT_UUID_TYPE; - if ( ( len = fetch_uuid_setting ( NULL, &uuid_setting, - &client_uuid.uuid ) ) >= 0 ) { - if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_CLIENT_UUID, - &client_uuid, - sizeof ( client_uuid ) ) ) != 0 ) { - DBG ( "DHCP could not set client UUID: %s\n", - strerror ( rc ) ); - return rc; - } - } - - /* Add user class, if we have one. */ - if ( ( len = fetch_setting_len ( NULL, &user_class_setting ) ) >= 0 ) { - char user_class[len]; - fetch_setting ( NULL, &user_class_setting, user_class, - sizeof ( user_class ) ); - if ( ( rc = dhcppkt_store ( dhcppkt, DHCP_USER_CLASS_ID, - &user_class, - sizeof ( user_class ) ) ) != 0 ) { - DBG ( "DHCP could not set user class: %s\n", - strerror ( rc ) ); - return rc; - } - } - - return 0; -} - -/**************************************************************************** - * - * Data transfer interface - * - */ - -/** - * Transmit DHCP request - * - * @v dhcp DHCP session - * @ret rc Return status code - */ -static int dhcp_tx ( struct dhcp_session *dhcp ) { - static struct sockaddr_in peer = { - .sin_family = AF_INET, - }; - struct xfer_metadata meta = { - .netdev = dhcp->netdev, - .src = ( struct sockaddr * ) &dhcp->local, - .dest = ( struct sockaddr * ) &peer, - }; - struct io_buffer *iobuf; - uint8_t msgtype = dhcp->state->tx_msgtype; - struct dhcp_packet dhcppkt; - int rc; - - /* Start retry timer. Do this first so that failures to - * transmit will be retried. - */ - start_timer ( &dhcp->timer ); - - /* Allocate buffer for packet */ - iobuf = xfer_alloc_iob ( &dhcp->xfer, DHCP_MIN_LEN ); - if ( ! iobuf ) - return -ENOMEM; - - /* Create basic DHCP packet in temporary buffer */ - if ( ( rc = dhcp_create_request ( &dhcppkt, dhcp->netdev, msgtype, - dhcp->local.sin_addr, iobuf->data, - iob_tailroom ( iobuf ) ) ) != 0 ) { - DBGC ( dhcp, "DHCP %p could not construct DHCP request: %s\n", - dhcp, strerror ( rc ) ); - goto done; - } - - /* Fill in packet based on current state */ - if ( ( rc = dhcp->state->tx ( dhcp, &dhcppkt, &peer ) ) != 0 ) { - DBGC ( dhcp, "DHCP %p could not fill DHCP request: %s\n", - dhcp, strerror ( rc ) ); - goto done; - } - - /* Transmit the packet */ - iob_put ( iobuf, dhcppkt.len ); - if ( ( rc = xfer_deliver_iob_meta ( &dhcp->xfer, iob_disown ( iobuf ), - &meta ) ) != 0 ) { - DBGC ( dhcp, "DHCP %p could not transmit UDP packet: %s\n", - dhcp, strerror ( rc ) ); - goto done; - } - - done: - free_iob ( iobuf ); - return rc; -} - -/** - * Receive new data - * - * @v xfer Data transfer interface - * @v iobuf I/O buffer - * @v meta Transfer metadata - * @ret rc Return status code - */ -static int dhcp_deliver_iob ( struct xfer_interface *xfer, - struct io_buffer *iobuf, - struct xfer_metadata *meta ) { - struct dhcp_session *dhcp = - container_of ( xfer, struct dhcp_session, xfer ); - struct sockaddr_in *peer; - size_t data_len; - struct dhcp_packet *dhcppkt; - struct dhcphdr *dhcphdr; - uint8_t msgtype = 0; - struct in_addr server_id = { 0 }; - int rc = 0; - - /* Sanity checks */ - if ( ! meta->src ) { - DBGC ( dhcp, "DHCP %p received packet without source port\n", - dhcp ); - rc = -EINVAL; - goto err_no_src; - } - peer = ( struct sockaddr_in * ) meta->src; - - /* Create a DHCP packet containing the I/O buffer contents. - * Whilst we could just use the original buffer in situ, that - * would waste the unused space in the packet buffer, and also - * waste a relatively scarce fully-aligned I/O buffer. - */ - data_len = iob_len ( iobuf ); - dhcppkt = zalloc ( sizeof ( *dhcppkt ) + data_len ); - if ( ! dhcppkt ) { - rc = -ENOMEM; - goto err_alloc_dhcppkt; - } - dhcphdr = ( ( ( void * ) dhcppkt ) + sizeof ( *dhcppkt ) ); - memcpy ( dhcphdr, iobuf->data, data_len ); - dhcppkt_init ( dhcppkt, dhcphdr, data_len ); - - /* Identify message type */ - dhcppkt_fetch ( dhcppkt, DHCP_MESSAGE_TYPE, &msgtype, - sizeof ( msgtype ) ); - - /* Identify server ID */ - dhcppkt_fetch ( dhcppkt, DHCP_SERVER_IDENTIFIER, - &server_id, sizeof ( server_id ) ); - - /* Check for matching transaction ID */ - if ( dhcphdr->xid != dhcp_xid ( dhcp->netdev ) ) { - DBGC ( dhcp, "DHCP %p %s from %s:%d has bad transaction " - "ID\n", dhcp, dhcp_msgtype_name ( msgtype ), - inet_ntoa ( peer->sin_addr ), - ntohs ( peer->sin_port ) ); - rc = -EINVAL; - goto err_xid; - }; - - /* Handle packet based on current state */ - dhcp->state->rx ( dhcp, dhcppkt, peer, msgtype, server_id ); - - err_xid: - dhcppkt_put ( dhcppkt ); - err_alloc_dhcppkt: - err_no_src: - free_iob ( iobuf ); - return rc; -} - -/** DHCP data transfer interface operations */ -static struct xfer_interface_operations dhcp_xfer_operations = { - .close = ignore_xfer_close, - .vredirect = xfer_vreopen, - .window = unlimited_xfer_window, - .alloc_iob = default_xfer_alloc_iob, - .deliver_iob = dhcp_deliver_iob, - .deliver_raw = xfer_deliver_as_iob, -}; - -/** - * Handle DHCP retry timer expiry - * - * @v timer DHCP retry timer - * @v fail Failure indicator - */ -static void dhcp_timer_expired ( struct retry_timer *timer, int fail ) { - struct dhcp_session *dhcp = - container_of ( timer, struct dhcp_session, timer ); - - /* If we have failed, terminate DHCP */ - if ( fail ) { - dhcp_finished ( dhcp, -ETIMEDOUT ); - return; - } - - /* Handle timer expiry based on current state */ - dhcp->state->expired ( dhcp ); -} - -/**************************************************************************** - * - * Job control interface - * - */ - -/** - * Handle kill() event received via job control interface - * - * @v job DHCP job control interface - */ -static void dhcp_job_kill ( struct job_interface *job ) { - struct dhcp_session *dhcp = - container_of ( job, struct dhcp_session, job ); - - /* Terminate DHCP session */ - dhcp_finished ( dhcp, -ECANCELED ); -} - -/** DHCP job control interface operations */ -static struct job_interface_operations dhcp_job_operations = { - .done = ignore_job_done, - .kill = dhcp_job_kill, - .progress = ignore_job_progress, -}; - -/**************************************************************************** - * - * Instantiators - * - */ - -/** - * DHCP peer address for socket opening - * - * This is a dummy address; the only useful portion is the socket - * family (so that we get a UDP connection). The DHCP client will set - * the IP address and source port explicitly on each transmission. - */ -static struct sockaddr dhcp_peer = { - .sa_family = AF_INET, -}; - -/** - * Start DHCP state machine on a network device - * - * @v job Job control interface - * @v netdev Network device - * @ret rc Return status code, or positive if cached - * - * Starts DHCP on the specified network device. If successful, the - * DHCPACK (and ProxyDHCPACK, if applicable) will be registered as - * option sources. - * - * On a return of 0, a background job has been started to perform the - * DHCP request. Any nonzero return means the job has not been - * started; a positive return value indicates the success condition of - * having fetched the appropriate data from cached information. - */ -int start_dhcp ( struct job_interface *job, struct net_device *netdev ) { - struct dhcp_session *dhcp; - int rc; - - /* Check for cached DHCP information */ - get_cached_dhcpack(); - if ( fetch_uintz_setting ( NULL, &use_cached_setting ) ) { - DBG ( "DHCP using cached network settings\n" ); - return 1; - } - - /* Allocate and initialise structure */ - dhcp = zalloc ( sizeof ( *dhcp ) ); - if ( ! dhcp ) - return -ENOMEM; - dhcp->refcnt.free = dhcp_free; - job_init ( &dhcp->job, &dhcp_job_operations, &dhcp->refcnt ); - xfer_init ( &dhcp->xfer, &dhcp_xfer_operations, &dhcp->refcnt ); - dhcp->netdev = netdev_get ( netdev ); - dhcp->local.sin_family = AF_INET; - dhcp->local.sin_port = htons ( BOOTPC_PORT ); - dhcp->timer.expired = dhcp_timer_expired; - - /* Instantiate child objects and attach to our interfaces */ - if ( ( rc = xfer_open_socket ( &dhcp->xfer, SOCK_DGRAM, &dhcp_peer, - ( struct sockaddr * ) &dhcp->local ) ) != 0 ) - goto err; - - /* Enter DHCPDISCOVER state */ - dhcp_set_state ( dhcp, &dhcp_state_discover ); - - /* Attach parent interface, mortalise self, and return */ - job_plug_plug ( &dhcp->job, job ); - ref_put ( &dhcp->refcnt ); - return 0; - - err: - dhcp_finished ( dhcp, rc ); - ref_put ( &dhcp->refcnt ); - return rc; -} - -/** - * Retrieve list of PXE boot servers for a given server type - * - * @v dhcp DHCP session - * @v raw DHCP PXE boot server list - * @v raw_len Length of DHCP PXE boot server list - * @v ip IP address list to fill in - * - * The caller must ensure that the IP address list has sufficient - * space. - */ -static void pxebs_list ( struct dhcp_session *dhcp, void *raw, - size_t raw_len, struct in_addr *ip ) { - struct dhcp_pxe_boot_server *server = raw; - size_t server_len; - unsigned int i; - - while ( raw_len ) { - if ( raw_len < sizeof ( *server ) ) { - DBGC ( dhcp, "DHCP %p malformed PXE server list\n", - dhcp ); - break; - } - server_len = offsetof ( typeof ( *server ), - ip[ server->num_ip ] ); - if ( raw_len < server_len ) { - DBGC ( dhcp, "DHCP %p malformed PXE server list\n", - dhcp ); - break; - } - if ( server->type == dhcp->pxe_type ) { - for ( i = 0 ; i < server->num_ip ; i++ ) - *(ip++) = server->ip[i]; - } - server = ( ( ( void * ) server ) + server_len ); - raw_len -= server_len; - } -} - -/** - * Start PXE Boot Server Discovery on a network device - * - * @v job Job control interface - * @v netdev Network device - * @v pxe_type PXE server type - * @ret rc Return status code - * - * Starts PXE Boot Server Discovery on the specified network device. - * If successful, the Boot Server ACK will be registered as an option - * source. - */ -int start_pxebs ( struct job_interface *job, struct net_device *netdev, - unsigned int pxe_type ) { - struct setting pxe_discovery_control_setting = - { .tag = DHCP_PXE_DISCOVERY_CONTROL }; - struct setting pxe_boot_servers_setting = - { .tag = DHCP_PXE_BOOT_SERVERS }; - struct setting pxe_boot_server_mcast_setting = - { .tag = DHCP_PXE_BOOT_SERVER_MCAST }; - ssize_t pxebs_list_len; - struct dhcp_session *dhcp; - struct in_addr *ip; - unsigned int pxe_discovery_control; - int rc; - - /* Get upper bound for PXE boot server IP address list */ - pxebs_list_len = fetch_setting_len ( NULL, &pxe_boot_servers_setting ); - if ( pxebs_list_len < 0 ) - pxebs_list_len = 0; - - /* Allocate and initialise structure */ - dhcp = zalloc ( sizeof ( *dhcp ) + sizeof ( *ip ) /* mcast */ + - sizeof ( *ip ) /* bcast */ + pxebs_list_len + - sizeof ( *ip ) /* terminator */ ); - if ( ! dhcp ) - return -ENOMEM; - dhcp->refcnt.free = dhcp_free; - job_init ( &dhcp->job, &dhcp_job_operations, &dhcp->refcnt ); - xfer_init ( &dhcp->xfer, &dhcp_xfer_operations, &dhcp->refcnt ); - dhcp->netdev = netdev_get ( netdev ); - dhcp->local.sin_family = AF_INET; - fetch_ipv4_setting ( netdev_settings ( netdev ), &ip_setting, - &dhcp->local.sin_addr ); - dhcp->local.sin_port = htons ( BOOTPC_PORT ); - dhcp->pxe_type = cpu_to_le16 ( pxe_type ); - dhcp->timer.expired = dhcp_timer_expired; - - /* Construct PXE boot server IP address lists */ - pxe_discovery_control = - fetch_uintz_setting ( NULL, &pxe_discovery_control_setting ); - ip = ( ( ( void * ) dhcp ) + sizeof ( *dhcp ) ); - dhcp->pxe_attempt = ip; - if ( ! ( pxe_discovery_control & PXEBS_NO_MULTICAST ) ) { - fetch_ipv4_setting ( NULL, &pxe_boot_server_mcast_setting, ip); - if ( ip->s_addr ) - ip++; - } - if ( ! ( pxe_discovery_control & PXEBS_NO_BROADCAST ) ) - (ip++)->s_addr = INADDR_BROADCAST; - if ( pxe_discovery_control & PXEBS_NO_UNKNOWN_SERVERS ) - dhcp->pxe_accept = ip; - if ( pxebs_list_len ) { - uint8_t buf[pxebs_list_len]; - - fetch_setting ( NULL, &pxe_boot_servers_setting, - buf, sizeof ( buf ) ); - pxebs_list ( dhcp, buf, sizeof ( buf ), ip ); - } - if ( ! dhcp->pxe_attempt->s_addr ) { - DBGC ( dhcp, "DHCP %p has no PXE boot servers for type %04x\n", - dhcp, pxe_type ); - rc = -EINVAL; - goto err; - } - - /* Dump out PXE server lists */ - DBGC ( dhcp, "DHCP %p attempting", dhcp ); - for ( ip = dhcp->pxe_attempt ; ip->s_addr ; ip++ ) - DBGC ( dhcp, " %s", inet_ntoa ( *ip ) ); - DBGC ( dhcp, "\n" ); - if ( dhcp->pxe_accept ) { - DBGC ( dhcp, "DHCP %p accepting", dhcp ); - for ( ip = dhcp->pxe_accept ; ip->s_addr ; ip++ ) - DBGC ( dhcp, " %s", inet_ntoa ( *ip ) ); - DBGC ( dhcp, "\n" ); - } - - /* Instantiate child objects and attach to our interfaces */ - if ( ( rc = xfer_open_socket ( &dhcp->xfer, SOCK_DGRAM, &dhcp_peer, - ( struct sockaddr * ) &dhcp->local ) ) != 0 ) - goto err; - - /* Enter PXEBS state */ - dhcp_set_state ( dhcp, &dhcp_state_pxebs ); - - /* Attach parent interface, mortalise self, and return */ - job_plug_plug ( &dhcp->job, job ); - ref_put ( &dhcp->refcnt ); - return 0; - - err: - dhcp_finished ( dhcp, rc ); - ref_put ( &dhcp->refcnt ); - return rc; -} diff --git a/gpxe/src/net/udp/dns.c b/gpxe/src/net/udp/dns.c deleted file mode 100644 index f94094aa..00000000 --- a/gpxe/src/net/udp/dns.c +++ /dev/null @@ -1,603 +0,0 @@ -/* - * Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>. - * - * Portions copyright (C) 2004 Anselm M. Hoffmeister - * <stockholm@users.sourceforge.net>. - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation; either version 2 of the - * License, or any later version. - * - * This program is distributed in the hope that it will be useful, but - * WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - */ - -FILE_LICENCE ( GPL2_OR_LATER ); - -#include <stdint.h> -#include <stdlib.h> -#include <string.h> -#include <stdio.h> -#include <errno.h> -#include <byteswap.h> -#include <gpxe/refcnt.h> -#include <gpxe/xfer.h> -#include <gpxe/open.h> -#include <gpxe/resolv.h> -#include <gpxe/retry.h> -#include <gpxe/tcpip.h> -#include <gpxe/settings.h> -#include <gpxe/features.h> -#include <gpxe/dns.h> - -/** @file - * - * DNS protocol - * - */ - -FEATURE ( FEATURE_PROTOCOL, "DNS", DHCP_EB_FEATURE_DNS, 1 ); - -/** The DNS server */ -static struct sockaddr_tcpip nameserver = { - .st_port = htons ( DNS_PORT ), -}; - -/** The local domain */ -static char *localdomain; - -/** A DNS request */ -struct dns_request { - /** Reference counter */ - struct refcnt refcnt; - /** Name resolution interface */ - struct resolv_interface resolv; - /** Data transfer interface */ - struct xfer_interface socket; - /** Retry timer */ - struct retry_timer timer; - - /** Socket address to fill in with resolved address */ - struct sockaddr sa; - /** Current query packet */ - struct dns_query query; - /** Location of query info structure within current packet - * - * The query info structure is located immediately after the - * compressed name. - */ - struct dns_query_info *qinfo; - /** Recursion counter */ - unsigned int recursion; -}; - -/** - * Mark DNS request as complete - * - * @v dns DNS request - * @v rc Return status code - */ -static void dns_done ( struct dns_request *dns, int rc ) { - - /* Stop the retry timer */ - stop_timer ( &dns->timer ); - - /* Close data transfer interface */ - xfer_nullify ( &dns->socket ); - xfer_close ( &dns->socket, rc ); - - /* Mark name resolution as complete */ - resolv_done ( &dns->resolv, &dns->sa, rc ); -} - -/** - * Compare DNS reply name against the query name from the original request - * - * @v dns DNS request - * @v reply DNS reply - * @v rname Reply name - * @ret zero Names match - * @ret non-zero Names do not match - */ -static int dns_name_cmp ( struct dns_request *dns, - const struct dns_header *reply, - const char *rname ) { - const char *qname = dns->query.payload; - int i; - - while ( 1 ) { - /* Obtain next section of rname */ - while ( ( *rname ) & 0xc0 ) { - rname = ( ( ( char * ) reply ) + - ( ntohs( *((uint16_t *)rname) ) & ~0xc000 )); - } - /* Check that lengths match */ - if ( *rname != *qname ) - return -1; - /* If length is zero, we have reached the end */ - if ( ! *qname ) - return 0; - /* Check that data matches */ - for ( i = *qname + 1; i > 0 ; i-- ) { - if ( *(rname++) != *(qname++) ) - return -1; - } - } -} - -/** - * Skip over a (possibly compressed) DNS name - * - * @v name DNS name - * @ret name Next DNS name - */ -static const char * dns_skip_name ( const char *name ) { - while ( 1 ) { - if ( ! *name ) { - /* End of name */ - return ( name + 1); - } - if ( *name & 0xc0 ) { - /* Start of a compressed name */ - return ( name + 2 ); - } - /* Uncompressed name portion */ - name += *name + 1; - } -} - -/** - * Find an RR in a reply packet corresponding to our query - * - * @v dns DNS request - * @v reply DNS reply - * @ret rr DNS RR, or NULL if not found - */ -static union dns_rr_info * dns_find_rr ( struct dns_request *dns, - const struct dns_header *reply ) { - int i, cmp; - const char *p = ( ( char * ) reply ) + sizeof ( struct dns_header ); - union dns_rr_info *rr_info; - - /* Skip over the questions section */ - for ( i = ntohs ( reply->qdcount ) ; i > 0 ; i-- ) { - p = dns_skip_name ( p ) + sizeof ( struct dns_query_info ); - } - - /* Process the answers section */ - for ( i = ntohs ( reply->ancount ) ; i > 0 ; i-- ) { - cmp = dns_name_cmp ( dns, reply, p ); - p = dns_skip_name ( p ); - rr_info = ( ( union dns_rr_info * ) p ); - if ( cmp == 0 ) - return rr_info; - p += ( sizeof ( rr_info->common ) + - ntohs ( rr_info->common.rdlength ) ); - } - - return NULL; -} - -/** - * Append DHCP domain name if available and name is not fully qualified - * - * @v string Name as a NUL-terminated string - * @ret fqdn Fully-qualified domain name, malloc'd copy - * - * The caller must free fqdn which is allocated even if the name is already - * fully qualified. - */ -static char * dns_qualify_name ( const char *string ) { - char *fqdn; - - /* Leave unchanged if already fully-qualified or no local domain */ - if ( ( ! localdomain ) || ( strchr ( string, '.' ) != 0 ) ) - return strdup ( string ); - - /* Append local domain to name */ - asprintf ( &fqdn, "%s.%s", string, localdomain ); - return fqdn; -} - -/** - * Convert a standard NUL-terminated string to a DNS name - * - * @v string Name as a NUL-terminated string - * @v buf Buffer in which to place DNS name - * @ret next Byte following constructed DNS name - * - * DNS names consist of "<length>element" pairs. - */ -static char * dns_make_name ( const char *string, char *buf ) { - char *length_byte = buf++; - char c; - - while ( ( c = *(string++) ) ) { - if ( c == '.' ) { - *length_byte = buf - length_byte - 1; - length_byte = buf; - } - *(buf++) = c; - } - *length_byte = buf - length_byte - 1; - *(buf++) = '\0'; - return buf; -} - -/** - * Convert an uncompressed DNS name to a NUL-terminated string - * - * @v name DNS name - * @ret string NUL-terminated string - * - * Produce a printable version of a DNS name. Used only for debugging. - */ -static inline char * dns_unmake_name ( char *name ) { - char *p; - unsigned int len; - - p = name; - while ( ( len = *p ) ) { - *(p++) = '.'; - p += len; - } - - return name + 1; -} - -/** - * Decompress a DNS name - * - * @v reply DNS replay - * @v name DNS name - * @v buf Buffer into which to decompress DNS name - * @ret next Byte following decompressed DNS name - */ -static char * dns_decompress_name ( const struct dns_header *reply, - const char *name, char *buf ) { - int i, len; - - do { - /* Obtain next section of name */ - while ( ( *name ) & 0xc0 ) { - name = ( ( char * ) reply + - ( ntohs ( *((uint16_t *)name) ) & ~0xc000 ) ); - } - /* Copy data */ - len = *name; - for ( i = len + 1 ; i > 0 ; i-- ) { - *(buf++) = *(name++); - } - } while ( len ); - return buf; -} - -/** - * Send next packet in DNS request - * - * @v dns DNS request - */ -static int dns_send_packet ( struct dns_request *dns ) { - static unsigned int qid = 0; - size_t qlen; - - /* Increment query ID */ - dns->query.dns.id = htons ( ++qid ); - - DBGC ( dns, "DNS %p sending query ID %d\n", dns, qid ); - - /* Start retransmission timer */ - start_timer ( &dns->timer ); - - /* Send the data */ - qlen = ( ( ( void * ) dns->qinfo ) - ( ( void * ) &dns->query ) - + sizeof ( dns->qinfo ) ); - return xfer_deliver_raw ( &dns->socket, &dns->query, qlen ); -} - -/** - * Handle DNS retransmission timer expiry - * - * @v timer Retry timer - * @v fail Failure indicator - */ -static void dns_timer_expired ( struct retry_timer *timer, int fail ) { - struct dns_request *dns = - container_of ( timer, struct dns_request, timer ); - - if ( fail ) { - dns_done ( dns, -ETIMEDOUT ); - } else { - dns_send_packet ( dns ); - } -} - -/** - * Receive new data - * - * @v socket UDP socket - * @v data DNS reply - * @v len Length of DNS reply - * @ret rc Return status code - */ -static int dns_xfer_deliver_raw ( struct xfer_interface *socket, - const void *data, size_t len ) { - struct dns_request *dns = - container_of ( socket, struct dns_request, socket ); - const struct dns_header *reply = data; - union dns_rr_info *rr_info; - struct sockaddr_in *sin; - unsigned int qtype = dns->qinfo->qtype; - - /* Sanity check */ - if ( len < sizeof ( *reply ) ) { - DBGC ( dns, "DNS %p received underlength packet length %zd\n", - dns, len ); - return -EINVAL; - } - - /* Check reply ID matches query ID */ - if ( reply->id != dns->query.dns.id ) { - DBGC ( dns, "DNS %p received unexpected reply ID %d " - "(wanted %d)\n", dns, ntohs ( reply->id ), - ntohs ( dns->query.dns.id ) ); - return -EINVAL; - } - - DBGC ( dns, "DNS %p received reply ID %d\n", dns, ntohs ( reply->id )); - - /* Stop the retry timer. After this point, each code path - * must either restart the timer by calling dns_send_packet(), - * or mark the DNS operation as complete by calling - * dns_done() - */ - stop_timer ( &dns->timer ); - - /* Search through response for useful answers. Do this - * multiple times, to take advantage of useful nameservers - * which send us e.g. the CNAME *and* the A record for the - * pointed-to name. - */ - while ( ( rr_info = dns_find_rr ( dns, reply ) ) ) { - switch ( rr_info->common.type ) { - - case htons ( DNS_TYPE_A ): - - /* Found the target A record */ - DBGC ( dns, "DNS %p found address %s\n", - dns, inet_ntoa ( rr_info->a.in_addr ) ); - sin = ( struct sockaddr_in * ) &dns->sa; - sin->sin_family = AF_INET; - sin->sin_addr = rr_info->a.in_addr; - - /* Mark operation as complete */ - dns_done ( dns, 0 ); - return 0; - - case htons ( DNS_TYPE_CNAME ): - - /* Found a CNAME record; update query and recurse */ - DBGC ( dns, "DNS %p found CNAME\n", dns ); - dns->qinfo = ( void * ) dns_decompress_name ( reply, - rr_info->cname.cname, - dns->query.payload ); - dns->qinfo->qtype = htons ( DNS_TYPE_A ); - dns->qinfo->qclass = htons ( DNS_CLASS_IN ); - - /* Terminate the operation if we recurse too far */ - if ( ++dns->recursion > DNS_MAX_CNAME_RECURSION ) { - DBGC ( dns, "DNS %p recursion exceeded\n", - dns ); - dns_done ( dns, -ELOOP ); - return 0; - } - break; - - default: - DBGC ( dns, "DNS %p got unknown record type %d\n", - dns, ntohs ( rr_info->common.type ) ); - break; - } - } - - /* Determine what to do next based on the type of query we - * issued and the reponse we received - */ - switch ( qtype ) { - - case htons ( DNS_TYPE_A ): - /* We asked for an A record and got nothing; - * try the CNAME. - */ - DBGC ( dns, "DNS %p found no A record; trying CNAME\n", dns ); - dns->qinfo->qtype = htons ( DNS_TYPE_CNAME ); - dns_send_packet ( dns ); - return 0; - - case htons ( DNS_TYPE_CNAME ): - /* We asked for a CNAME record. If we got a response - * (i.e. if the next A query is already set up), then - * issue it, otherwise abort. - */ - if ( dns->qinfo->qtype == htons ( DNS_TYPE_A ) ) { - dns_send_packet ( dns ); - return 0; - } else { - DBGC ( dns, "DNS %p found no CNAME record\n", dns ); - dns_done ( dns, -ENXIO ); - return 0; - } - - default: - assert ( 0 ); - dns_done ( dns, -EINVAL ); - return 0; - } -} - -/** - * Receive new data - * - * @v socket UDP socket - * @v rc Reason for close - */ -static void dns_xfer_close ( struct xfer_interface *socket, int rc ) { - struct dns_request *dns = - container_of ( socket, struct dns_request, socket ); - - if ( ! rc ) - rc = -ECONNABORTED; - - dns_done ( dns, rc ); -} - -/** DNS socket operations */ -static struct xfer_interface_operations dns_socket_operations = { - .close = dns_xfer_close, - .vredirect = xfer_vreopen, - .window = unlimited_xfer_window, - .alloc_iob = default_xfer_alloc_iob, - .deliver_iob = xfer_deliver_as_raw, - .deliver_raw = dns_xfer_deliver_raw, -}; - -/** - * Resolve name using DNS - * - * @v resolv Name resolution interface - * @v name Name to resolve - * @v sa Socket address to fill in - * @ret rc Return status code - */ -static int dns_resolv ( struct resolv_interface *resolv, - const char *name, struct sockaddr *sa ) { - struct dns_request *dns; - char *fqdn; - int rc; - - /* Fail immediately if no DNS servers */ - if ( ! nameserver.st_family ) { - DBG ( "DNS not attempting to resolve \"%s\": " - "no DNS servers\n", name ); - rc = -ENXIO; - goto err_no_nameserver; - } - - /* Ensure fully-qualified domain name if DHCP option was given */ - fqdn = dns_qualify_name ( name ); - if ( ! fqdn ) { - rc = -ENOMEM; - goto err_qualify_name; - } - - /* Allocate DNS structure */ - dns = zalloc ( sizeof ( *dns ) ); - if ( ! dns ) { - rc = -ENOMEM; - goto err_alloc_dns; - } - resolv_init ( &dns->resolv, &null_resolv_ops, &dns->refcnt ); - xfer_init ( &dns->socket, &dns_socket_operations, &dns->refcnt ); - dns->timer.expired = dns_timer_expired; - memcpy ( &dns->sa, sa, sizeof ( dns->sa ) ); - - /* Create query */ - dns->query.dns.flags = htons ( DNS_FLAG_QUERY | DNS_FLAG_OPCODE_QUERY | - DNS_FLAG_RD ); - dns->query.dns.qdcount = htons ( 1 ); - dns->qinfo = ( void * ) dns_make_name ( fqdn, dns->query.payload ); - dns->qinfo->qtype = htons ( DNS_TYPE_A ); - dns->qinfo->qclass = htons ( DNS_CLASS_IN ); - - /* Open UDP connection */ - if ( ( rc = xfer_open_socket ( &dns->socket, SOCK_DGRAM, - ( struct sockaddr * ) &nameserver, - NULL ) ) != 0 ) { - DBGC ( dns, "DNS %p could not open socket: %s\n", - dns, strerror ( rc ) ); - goto err_open_socket; - } - - /* Send first DNS packet */ - dns_send_packet ( dns ); - - /* Attach parent interface, mortalise self, and return */ - resolv_plug_plug ( &dns->resolv, resolv ); - ref_put ( &dns->refcnt ); - free ( fqdn ); - return 0; - - err_open_socket: - err_alloc_dns: - ref_put ( &dns->refcnt ); - err_qualify_name: - free ( fqdn ); - err_no_nameserver: - return rc; -} - -/** DNS name resolver */ -struct resolver dns_resolver __resolver ( RESOLV_NORMAL ) = { - .name = "DNS", - .resolv = dns_resolv, -}; - -/****************************************************************************** - * - * Settings - * - ****************************************************************************** - */ - -/** DNS server setting */ -struct setting dns_setting __setting = { - .name = "dns", - .description = "DNS server", - .tag = DHCP_DNS_SERVERS, - .type = &setting_type_ipv4, -}; - -/** Domain name setting */ -struct setting domain_setting __setting = { - .name = "domain", - .description = "Local domain", - .tag = DHCP_DOMAIN_NAME, - .type = &setting_type_string, -}; - -/** - * Apply DNS settings - * - * @ret rc Return status code - */ -static int apply_dns_settings ( void ) { - struct sockaddr_in *sin_nameserver = - ( struct sockaddr_in * ) &nameserver; - int len; - - if ( ( len = fetch_ipv4_setting ( NULL, &dns_setting, - &sin_nameserver->sin_addr ) ) >= 0 ){ - sin_nameserver->sin_family = AF_INET; - DBG ( "DNS using nameserver %s\n", - inet_ntoa ( sin_nameserver->sin_addr ) ); - } - - /* Get local domain DHCP option */ - if ( ( len = fetch_string_setting_copy ( NULL, &domain_setting, - &localdomain ) ) >= 0 ) - DBG ( "DNS local domain %s\n", localdomain ); - - return 0; -} - -/** DNS settings applicator */ -struct settings_applicator dns_applicator __settings_applicator = { - .apply = apply_dns_settings, -}; diff --git a/gpxe/src/net/udp/slam.c b/gpxe/src/net/udp/slam.c deleted file mode 100644 index 396f69b0..00000000 --- a/gpxe/src/net/udp/slam.c +++ /dev/null @@ -1,812 +0,0 @@ -/* - * Copyright (C) 2008 Michael Brown <mbrown@fensystems.co.uk>. - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation; either version 2 of the - * License, or any later version. - * - * This program is distributed in the hope that it will be useful, but - * WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - */ - -FILE_LICENCE ( GPL2_OR_LATER ); - -#include <stdint.h> -#include <stdlib.h> -#include <string.h> -#include <strings.h> -#include <errno.h> -#include <assert.h> -#include <byteswap.h> -#include <gpxe/features.h> -#include <gpxe/iobuf.h> -#include <gpxe/bitmap.h> -#include <gpxe/xfer.h> -#include <gpxe/open.h> -#include <gpxe/uri.h> -#include <gpxe/tcpip.h> -#include <gpxe/timer.h> -#include <gpxe/retry.h> - -/** @file - * - * Scalable Local Area Multicast protocol - * - * The SLAM protocol is supported only by Etherboot; it was designed - * and implemented by Eric Biederman. A server implementation is - * available in contrib/mini-slamd. There does not appear to be any - * documentation beyond a few sparse comments in Etherboot's - * proto_slam.c. - * - * SLAM packets use three types of data field: - * - * Nul : A single NUL (0) byte, used as a list terminator - * - * Raw : A block of raw data - * - * Int : A variable-length integer, in big-endian order. The length - * of the integer is encoded in the most significant three bits. - * - * Packets received by the client have the following layout: - * - * Int : Transaction identifier. This is an opaque value. - * - * Int : Total number of bytes in the transfer. - * - * Int : Block size, in bytes. - * - * Int : Packet sequence number within the transfer (if this packet - * contains data). - * - * Raw : Packet data (if this packet contains data). - * - * Packets transmitted by the client consist of a run-length-encoded - * representation of the received-blocks bitmap, looking something - * like: - * - * Int : Number of consecutive successfully-received packets - * Int : Number of consecutive missing packets - * Int : Number of consecutive successfully-received packets - * Int : Number of consecutive missing packets - * .... - * Nul - * - */ - -FEATURE ( FEATURE_PROTOCOL, "SLAM", DHCP_EB_FEATURE_SLAM, 1 ); - -/** Default SLAM server port */ -#define SLAM_DEFAULT_PORT 10000 - -/** Default SLAM multicast IP address */ -#define SLAM_DEFAULT_MULTICAST_IP \ - ( ( 239 << 24 ) | ( 255 << 16 ) | ( 1 << 8 ) | ( 1 << 0 ) ) - -/** Default SLAM multicast port */ -#define SLAM_DEFAULT_MULTICAST_PORT 10000 - -/** Maximum SLAM header length */ -#define SLAM_MAX_HEADER_LEN ( 7 /* transaction id */ + 7 /* total_bytes */ + \ - 7 /* block_size */ ) - -/** Maximum number of blocks to request per NACK - * - * This is a policy decision equivalent to selecting a TCP window - * size. - */ -#define SLAM_MAX_BLOCKS_PER_NACK 4 - -/** Maximum SLAM NACK length - * - * We only ever send a NACK for a single range of up to @c - * SLAM_MAX_BLOCKS_PER_NACK blocks. - */ -#define SLAM_MAX_NACK_LEN ( 7 /* block */ + 7 /* #blocks */ + 1 /* NUL */ ) - -/** SLAM slave timeout */ -#define SLAM_SLAVE_TIMEOUT ( 1 * TICKS_PER_SEC ) - -/** A SLAM request */ -struct slam_request { - /** Reference counter */ - struct refcnt refcnt; - - /** Data transfer interface */ - struct xfer_interface xfer; - /** Unicast socket */ - struct xfer_interface socket; - /** Multicast socket */ - struct xfer_interface mc_socket; - - /** Master client retry timer */ - struct retry_timer master_timer; - /** Slave client retry timer */ - struct retry_timer slave_timer; - - /** Cached header */ - uint8_t header[SLAM_MAX_HEADER_LEN]; - /** Size of cached header */ - size_t header_len; - /** Total number of bytes in transfer */ - unsigned long total_bytes; - /** Transfer block size */ - unsigned long block_size; - /** Number of blocks in transfer */ - unsigned long num_blocks; - /** Block bitmap */ - struct bitmap bitmap; - /** NACK sent flag */ - int nack_sent; -}; - -/** - * Free a SLAM request - * - * @v refcnt Reference counter - */ -static void slam_free ( struct refcnt *refcnt ) { - struct slam_request *slam = - container_of ( refcnt, struct slam_request, refcnt ); - - bitmap_free ( &slam->bitmap ); - free ( slam ); -} - -/** - * Mark SLAM request as complete - * - * @v slam SLAM request - * @v rc Return status code - */ -static void slam_finished ( struct slam_request *slam, int rc ) { - static const uint8_t slam_disconnect[] = { 0 }; - - DBGC ( slam, "SLAM %p finished with status code %d (%s)\n", - slam, rc, strerror ( rc ) ); - - /* Send a disconnect message if we ever sent anything to the - * server. - */ - if ( slam->nack_sent ) { - xfer_deliver_raw ( &slam->socket, slam_disconnect, - sizeof ( slam_disconnect ) ); - } - - /* Stop the retry timers */ - stop_timer ( &slam->master_timer ); - stop_timer ( &slam->slave_timer ); - - /* Close all data transfer interfaces */ - xfer_nullify ( &slam->socket ); - xfer_close ( &slam->socket, rc ); - xfer_nullify ( &slam->mc_socket ); - xfer_close ( &slam->mc_socket, rc ); - xfer_nullify ( &slam->xfer ); - xfer_close ( &slam->xfer, rc ); -} - -/**************************************************************************** - * - * TX datapath - * - */ - -/** - * Add a variable-length value to a SLAM packet - * - * @v slam SLAM request - * @v iobuf I/O buffer - * @v value Value to add - * @ret rc Return status code - * - * Adds a variable-length value to the end of an I/O buffer. Will - * always leave at least one byte of tailroom in the I/O buffer (to - * allow space for the terminating NUL). - */ -static int slam_put_value ( struct slam_request *slam, - struct io_buffer *iobuf, unsigned long value ) { - uint8_t *data; - size_t len; - unsigned int i; - - /* Calculate variable length required to store value. Always - * leave at least one byte in the I/O buffer. - */ - len = ( ( flsl ( value ) + 10 ) / 8 ); - if ( len >= iob_tailroom ( iobuf ) ) { - DBGC2 ( slam, "SLAM %p cannot add %zd-byte value\n", - slam, len ); - return -ENOBUFS; - } - /* There is no valid way within the protocol that we can end - * up trying to push a full-sized long (i.e. without space for - * the length encoding). - */ - assert ( len <= sizeof ( value ) ); - - /* Add value */ - data = iob_put ( iobuf, len ); - for ( i = len ; i-- ; ) { - data[i] = value; - value >>= 8; - } - *data |= ( len << 5 ); - assert ( value == 0 ); - - return 0; -} - -/** - * Send SLAM NACK packet - * - * @v slam SLAM request - * @ret rc Return status code - */ -static int slam_tx_nack ( struct slam_request *slam ) { - struct io_buffer *iobuf; - unsigned long first_block; - unsigned long num_blocks; - uint8_t *nul; - int rc; - - /* Mark NACK as sent, so that we know we have to disconnect later */ - slam->nack_sent = 1; - - /* Allocate I/O buffer */ - iobuf = xfer_alloc_iob ( &slam->socket, SLAM_MAX_NACK_LEN ); - if ( ! iobuf ) { - DBGC ( slam, "SLAM %p could not allocate I/O buffer\n", - slam ); - return -ENOMEM; - } - - /* Construct NACK. We always request only a single packet; - * this allows us to force multicast-TFTP-style flow control - * on the SLAM server, which will otherwise just blast the - * data out as fast as it can. On a gigabit network, without - * RX checksumming, this would inevitably cause packet drops. - */ - first_block = bitmap_first_gap ( &slam->bitmap ); - for ( num_blocks = 1 ; ; num_blocks++ ) { - if ( num_blocks >= SLAM_MAX_BLOCKS_PER_NACK ) - break; - if ( ( first_block + num_blocks ) >= slam->num_blocks ) - break; - if ( bitmap_test ( &slam->bitmap, - ( first_block + num_blocks ) ) ) - break; - } - if ( first_block ) { - DBGCP ( slam, "SLAM %p transmitting NACK for blocks " - "%ld-%ld\n", slam, first_block, - ( first_block + num_blocks - 1 ) ); - } else { - DBGC ( slam, "SLAM %p transmitting initial NACK for blocks " - "0-%ld\n", slam, ( num_blocks - 1 ) ); - } - if ( ( rc = slam_put_value ( slam, iobuf, first_block ) ) != 0 ) - return rc; - if ( ( rc = slam_put_value ( slam, iobuf, num_blocks ) ) != 0 ) - return rc; - nul = iob_put ( iobuf, 1 ); - *nul = 0; - - /* Transmit packet */ - return xfer_deliver_iob ( &slam->socket, iobuf ); -} - -/** - * Handle SLAM master client retry timer expiry - * - * @v timer Master retry timer - * @v fail Failure indicator - */ -static void slam_master_timer_expired ( struct retry_timer *timer, - int fail ) { - struct slam_request *slam = - container_of ( timer, struct slam_request, master_timer ); - - if ( fail ) { - /* Allow timer to stop running. We will terminate the - * connection only if the slave timer times out. - */ - DBGC ( slam, "SLAM %p giving up acting as master client\n", - slam ); - } else { - /* Retransmit NACK */ - start_timer ( timer ); - slam_tx_nack ( slam ); - } -} - -/** - * Handle SLAM slave client retry timer expiry - * - * @v timer Master retry timer - * @v fail Failure indicator - */ -static void slam_slave_timer_expired ( struct retry_timer *timer, - int fail ) { - struct slam_request *slam = - container_of ( timer, struct slam_request, slave_timer ); - - if ( fail ) { - /* Terminate connection */ - slam_finished ( slam, -ETIMEDOUT ); - } else { - /* Try sending a NACK */ - DBGC ( slam, "SLAM %p trying to become master client\n", - slam ); - start_timer ( timer ); - slam_tx_nack ( slam ); - } -} - -/**************************************************************************** - * - * RX datapath - * - */ - -/** - * Read and strip a variable-length value from a SLAM packet - * - * @v slam SLAM request - * @v iobuf I/O buffer - * @v value Value to fill in, or NULL to ignore value - * @ret rc Return status code - * - * Reads a variable-length value from the start of the I/O buffer. - */ -static int slam_pull_value ( struct slam_request *slam, - struct io_buffer *iobuf, - unsigned long *value ) { - uint8_t *data; - size_t len; - - /* Sanity check */ - if ( iob_len ( iobuf ) == 0 ) { - DBGC ( slam, "SLAM %p empty value\n", slam ); - return -EINVAL; - } - - /* Read and verify length of value */ - data = iobuf->data; - len = ( *data >> 5 ); - if ( ( len == 0 ) || - ( value && ( len > sizeof ( *value ) ) ) ) { - DBGC ( slam, "SLAM %p invalid value length %zd bytes\n", - slam, len ); - return -EINVAL; - } - if ( len > iob_len ( iobuf ) ) { - DBGC ( slam, "SLAM %p value extends beyond I/O buffer\n", - slam ); - return -EINVAL; - } - - /* Read value */ - iob_pull ( iobuf, len ); - *value = ( *data & 0x1f ); - while ( --len ) { - *value <<= 8; - *value |= *(++data); - } - - return 0; -} - -/** - * Read and strip SLAM header - * - * @v slam SLAM request - * @v iobuf I/O buffer - * @ret rc Return status code - */ -static int slam_pull_header ( struct slam_request *slam, - struct io_buffer *iobuf ) { - void *header = iobuf->data; - int rc; - - /* If header matches cached header, just pull it and return */ - if ( ( slam->header_len <= iob_len ( iobuf ) ) && - ( memcmp ( slam->header, iobuf->data, slam->header_len ) == 0 )){ - iob_pull ( iobuf, slam->header_len ); - return 0; - } - - DBGC ( slam, "SLAM %p detected changed header; resetting\n", slam ); - - /* Read and strip transaction ID, total number of bytes, and - * block size. - */ - if ( ( rc = slam_pull_value ( slam, iobuf, NULL ) ) != 0 ) - return rc; - if ( ( rc = slam_pull_value ( slam, iobuf, - &slam->total_bytes ) ) != 0 ) - return rc; - if ( ( rc = slam_pull_value ( slam, iobuf, - &slam->block_size ) ) != 0 ) - return rc; - - /* Update the cached header */ - slam->header_len = ( iobuf->data - header ); - assert ( slam->header_len <= sizeof ( slam->header ) ); - memcpy ( slam->header, header, slam->header_len ); - - /* Calculate number of blocks */ - slam->num_blocks = ( ( slam->total_bytes + slam->block_size - 1 ) / - slam->block_size ); - - DBGC ( slam, "SLAM %p has total bytes %ld, block size %ld, num " - "blocks %ld\n", slam, slam->total_bytes, slam->block_size, - slam->num_blocks ); - - /* Discard and reset the bitmap */ - bitmap_free ( &slam->bitmap ); - memset ( &slam->bitmap, 0, sizeof ( slam->bitmap ) ); - - /* Allocate a new bitmap */ - if ( ( rc = bitmap_resize ( &slam->bitmap, - slam->num_blocks ) ) != 0 ) { - /* Failure to allocate a bitmap is fatal */ - DBGC ( slam, "SLAM %p could not allocate bitmap for %ld " - "blocks: %s\n", slam, slam->num_blocks, - strerror ( rc ) ); - slam_finished ( slam, rc ); - return rc; - } - - /* Notify recipient of file size */ - xfer_seek ( &slam->xfer, slam->total_bytes, SEEK_SET ); - - return 0; -} - -/** - * Receive SLAM data packet - * - * @v mc_socket SLAM multicast socket - * @v iobuf I/O buffer - * @ret rc Return status code - */ -static int slam_mc_socket_deliver ( struct xfer_interface *mc_socket, - struct io_buffer *iobuf, - struct xfer_metadata *rx_meta __unused ) { - struct slam_request *slam = - container_of ( mc_socket, struct slam_request, mc_socket ); - struct xfer_metadata meta; - unsigned long packet; - size_t len; - int rc; - - /* Stop the master client timer. Restart the slave client timer. */ - stop_timer ( &slam->master_timer ); - stop_timer ( &slam->slave_timer ); - start_timer_fixed ( &slam->slave_timer, SLAM_SLAVE_TIMEOUT ); - - /* Read and strip packet header */ - if ( ( rc = slam_pull_header ( slam, iobuf ) ) != 0 ) - goto err_discard; - - /* Read and strip packet number */ - if ( ( rc = slam_pull_value ( slam, iobuf, &packet ) ) != 0 ) - goto err_discard; - - /* Sanity check packet number */ - if ( packet >= slam->num_blocks ) { - DBGC ( slam, "SLAM %p received out-of-range packet %ld " - "(num_blocks=%ld)\n", slam, packet, slam->num_blocks ); - rc = -EINVAL; - goto err_discard; - } - - /* Sanity check length */ - len = iob_len ( iobuf ); - if ( len > slam->block_size ) { - DBGC ( slam, "SLAM %p received oversize packet of %zd bytes " - "(block_size=%ld)\n", slam, len, slam->block_size ); - rc = -EINVAL; - goto err_discard; - } - if ( ( packet != ( slam->num_blocks - 1 ) ) && - ( len < slam->block_size ) ) { - DBGC ( slam, "SLAM %p received short packet of %zd bytes " - "(block_size=%ld)\n", slam, len, slam->block_size ); - rc = -EINVAL; - goto err_discard; - } - - /* If we have already seen this packet, discard it */ - if ( bitmap_test ( &slam->bitmap, packet ) ) { - goto discard; - } - - /* Pass to recipient */ - memset ( &meta, 0, sizeof ( meta ) ); - meta.whence = SEEK_SET; - meta.offset = ( packet * slam->block_size ); - if ( ( rc = xfer_deliver_iob_meta ( &slam->xfer, iobuf, - &meta ) ) != 0 ) - goto err; - - /* Mark block as received */ - bitmap_set ( &slam->bitmap, packet ); - - /* If we have received all blocks, terminate */ - if ( bitmap_full ( &slam->bitmap ) ) - slam_finished ( slam, 0 ); - - return 0; - - err_discard: - discard: - free_iob ( iobuf ); - err: - return rc; -} - -/** - * Receive SLAM non-data packet - * - * @v socket SLAM unicast socket - * @v iobuf I/O buffer - * @ret rc Return status code - */ -static int slam_socket_deliver ( struct xfer_interface *socket, - struct io_buffer *iobuf, - struct xfer_metadata *rx_meta __unused ) { - struct slam_request *slam = - container_of ( socket, struct slam_request, socket ); - int rc; - - /* Restart the master client timer */ - stop_timer ( &slam->master_timer ); - start_timer ( &slam->master_timer ); - - /* Read and strip packet header */ - if ( ( rc = slam_pull_header ( slam, iobuf ) ) != 0 ) - goto discard; - - /* Sanity check */ - if ( iob_len ( iobuf ) != 0 ) { - DBGC ( slam, "SLAM %p received trailing garbage:\n", slam ); - DBGC_HD ( slam, iobuf->data, iob_len ( iobuf ) ); - rc = -EINVAL; - goto discard; - } - - /* Discard packet */ - free_iob ( iobuf ); - - /* Send NACK in reply */ - slam_tx_nack ( slam ); - - return 0; - - discard: - free_iob ( iobuf ); - return rc; - -} - -/** - * Close SLAM unicast socket - * - * @v socket SLAM unicast socket - * @v rc Reason for close - */ -static void slam_socket_close ( struct xfer_interface *socket, int rc ) { - struct slam_request *slam = - container_of ( socket, struct slam_request, socket ); - - DBGC ( slam, "SLAM %p unicast socket closed: %s\n", - slam, strerror ( rc ) ); - - slam_finished ( slam, rc ); -} - -/** SLAM unicast socket data transfer operations */ -static struct xfer_interface_operations slam_socket_operations = { - .close = slam_socket_close, - .vredirect = xfer_vreopen, - .window = unlimited_xfer_window, - .alloc_iob = default_xfer_alloc_iob, - .deliver_iob = slam_socket_deliver, - .deliver_raw = xfer_deliver_as_iob, -}; - -/** - * Close SLAM multicast socket - * - * @v mc_socket SLAM multicast socket - * @v rc Reason for close - */ -static void slam_mc_socket_close ( struct xfer_interface *mc_socket, int rc ){ - struct slam_request *slam = - container_of ( mc_socket, struct slam_request, mc_socket ); - - DBGC ( slam, "SLAM %p multicast socket closed: %s\n", - slam, strerror ( rc ) ); - - slam_finished ( slam, rc ); -} - -/** SLAM multicast socket data transfer operations */ -static struct xfer_interface_operations slam_mc_socket_operations = { - .close = slam_mc_socket_close, - .vredirect = xfer_vreopen, - .window = unlimited_xfer_window, - .alloc_iob = default_xfer_alloc_iob, - .deliver_iob = slam_mc_socket_deliver, - .deliver_raw = xfer_deliver_as_iob, -}; - -/**************************************************************************** - * - * Data transfer interface - * - */ - -/** - * Close SLAM data transfer interface - * - * @v xfer SLAM data transfer interface - * @v rc Reason for close - */ -static void slam_xfer_close ( struct xfer_interface *xfer, int rc ) { - struct slam_request *slam = - container_of ( xfer, struct slam_request, xfer ); - - DBGC ( slam, "SLAM %p data transfer interface closed: %s\n", - slam, strerror ( rc ) ); - - slam_finished ( slam, rc ); -} - -/** SLAM data transfer operations */ -static struct xfer_interface_operations slam_xfer_operations = { - .close = slam_xfer_close, - .vredirect = ignore_xfer_vredirect, - .window = unlimited_xfer_window, - .alloc_iob = default_xfer_alloc_iob, - .deliver_iob = xfer_deliver_as_raw, - .deliver_raw = ignore_xfer_deliver_raw, -}; - -/** - * Parse SLAM URI multicast address - * - * @v slam SLAM request - * @v path Path portion of x-slam:// URI - * @v address Socket address to fill in - * @ret rc Return status code - */ -static int slam_parse_multicast_address ( struct slam_request *slam, - const char *path, - struct sockaddr_in *address ) { - char path_dup[ strlen ( path ) /* no +1 */ ]; - char *sep; - char *end; - - /* Create temporary copy of path, minus the leading '/' */ - assert ( *path == '/' ); - memcpy ( path_dup, ( path + 1 ) , sizeof ( path_dup ) ); - - /* Parse port, if present */ - sep = strchr ( path_dup, ':' ); - if ( sep ) { - *(sep++) = '\0'; - address->sin_port = htons ( strtoul ( sep, &end, 0 ) ); - if ( *end != '\0' ) { - DBGC ( slam, "SLAM %p invalid multicast port " - "\"%s\"\n", slam, sep ); - return -EINVAL; - } - } - - /* Parse address */ - if ( inet_aton ( path_dup, &address->sin_addr ) == 0 ) { - DBGC ( slam, "SLAM %p invalid multicast address \"%s\"\n", - slam, path_dup ); - return -EINVAL; - } - - return 0; -} - -/** - * Initiate a SLAM request - * - * @v xfer Data transfer interface - * @v uri Uniform Resource Identifier - * @ret rc Return status code - */ -static int slam_open ( struct xfer_interface *xfer, struct uri *uri ) { - static const struct sockaddr_in default_multicast = { - .sin_family = AF_INET, - .sin_port = htons ( SLAM_DEFAULT_MULTICAST_PORT ), - .sin_addr = { htonl ( SLAM_DEFAULT_MULTICAST_IP ) }, - }; - struct slam_request *slam; - struct sockaddr_tcpip server; - struct sockaddr_in multicast; - int rc; - - /* Sanity checks */ - if ( ! uri->host ) - return -EINVAL; - - /* Allocate and populate structure */ - slam = zalloc ( sizeof ( *slam ) ); - if ( ! slam ) - return -ENOMEM; - slam->refcnt.free = slam_free; - xfer_init ( &slam->xfer, &slam_xfer_operations, &slam->refcnt ); - xfer_init ( &slam->socket, &slam_socket_operations, &slam->refcnt ); - xfer_init ( &slam->mc_socket, &slam_mc_socket_operations, - &slam->refcnt ); - slam->master_timer.expired = slam_master_timer_expired; - slam->slave_timer.expired = slam_slave_timer_expired; - /* Fake an invalid cached header of { 0x00, ... } */ - slam->header_len = 1; - /* Fake parameters for initial NACK */ - slam->num_blocks = 1; - if ( ( rc = bitmap_resize ( &slam->bitmap, 1 ) ) != 0 ) { - DBGC ( slam, "SLAM %p could not allocate initial bitmap: " - "%s\n", slam, strerror ( rc ) ); - goto err; - } - - /* Open unicast socket */ - memset ( &server, 0, sizeof ( server ) ); - server.st_port = htons ( uri_port ( uri, SLAM_DEFAULT_PORT ) ); - if ( ( rc = xfer_open_named_socket ( &slam->socket, SOCK_DGRAM, - ( struct sockaddr * ) &server, - uri->host, NULL ) ) != 0 ) { - DBGC ( slam, "SLAM %p could not open unicast socket: %s\n", - slam, strerror ( rc ) ); - goto err; - } - - /* Open multicast socket */ - memcpy ( &multicast, &default_multicast, sizeof ( multicast ) ); - if ( uri->path && - ( ( rc = slam_parse_multicast_address ( slam, uri->path, - &multicast ) ) != 0 ) ) { - goto err; - } - if ( ( rc = xfer_open_socket ( &slam->mc_socket, SOCK_DGRAM, - ( struct sockaddr * ) &multicast, - ( struct sockaddr * ) &multicast ) ) != 0 ) { - DBGC ( slam, "SLAM %p could not open multicast socket: %s\n", - slam, strerror ( rc ) ); - goto err; - } - - /* Start slave retry timer */ - start_timer_fixed ( &slam->slave_timer, SLAM_SLAVE_TIMEOUT ); - - /* Attach to parent interface, mortalise self, and return */ - xfer_plug_plug ( &slam->xfer, xfer ); - ref_put ( &slam->refcnt ); - return 0; - - err: - slam_finished ( slam, rc ); - ref_put ( &slam->refcnt ); - return rc; -} - -/** SLAM URI opener */ -struct uri_opener slam_uri_opener __uri_opener = { - .scheme = "x-slam", - .open = slam_open, -}; diff --git a/gpxe/src/net/udp/tftp.c b/gpxe/src/net/udp/tftp.c deleted file mode 100644 index 3de2fb9b..00000000 --- a/gpxe/src/net/udp/tftp.c +++ /dev/null @@ -1,1288 +0,0 @@ -/* - * Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>. - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License as - * published by the Free Software Foundation; either version 2 of the - * License, or any later version. - * - * This program is distributed in the hope that it will be useful, but - * WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - */ - -FILE_LICENCE ( GPL2_OR_LATER ); - -#include <stdint.h> -#include <stdlib.h> -#include <stdio.h> -#include <string.h> -#include <strings.h> -#include <byteswap.h> -#include <errno.h> -#include <assert.h> -#include <gpxe/refcnt.h> -#include <gpxe/xfer.h> -#include <gpxe/open.h> -#include <gpxe/uri.h> -#include <gpxe/tcpip.h> -#include <gpxe/retry.h> -#include <gpxe/features.h> -#include <gpxe/bitmap.h> -#include <gpxe/settings.h> -#include <gpxe/dhcp.h> -#include <gpxe/uri.h> -#include <gpxe/tftp.h> - -/** @file - * - * TFTP protocol - * - */ - -FEATURE ( FEATURE_PROTOCOL, "TFTP", DHCP_EB_FEATURE_TFTP, 1 ); - -/* TFTP-specific error codes */ -#define ETFTP_INVALID_BLKSIZE EUNIQ_01 -#define ETFTP_INVALID_TSIZE EUNIQ_02 -#define ETFTP_MC_NO_PORT EUNIQ_03 -#define ETFTP_MC_NO_MC EUNIQ_04 -#define ETFTP_MC_INVALID_MC EUNIQ_05 -#define ETFTP_MC_INVALID_IP EUNIQ_06 -#define ETFTP_MC_INVALID_PORT EUNIQ_07 - -/** - * A TFTP request - * - * This data structure holds the state for an ongoing TFTP transfer. - */ -struct tftp_request { - /** Reference count */ - struct refcnt refcnt; - /** Data transfer interface */ - struct xfer_interface xfer; - - /** URI being fetched */ - struct uri *uri; - /** Transport layer interface */ - struct xfer_interface socket; - /** Multicast transport layer interface */ - struct xfer_interface mc_socket; - - /** Data block size - * - * This is the "blksize" option negotiated with the TFTP - * server. (If the TFTP server does not support TFTP options, - * this will default to 512). - */ - unsigned int blksize; - /** File size - * - * This is the value returned in the "tsize" option from the - * TFTP server. If the TFTP server does not support the - * "tsize" option, this value will be zero. - */ - unsigned long tsize; - - /** Server port - * - * This is the port to which RRQ packets are sent. - */ - unsigned int port; - /** Peer address - * - * The peer address is determined by the first response - * received to the TFTP RRQ. - */ - struct sockaddr_tcpip peer; - /** Request flags */ - unsigned int flags; - /** MTFTP timeout count */ - unsigned int mtftp_timeouts; - - /** Block bitmap */ - struct bitmap bitmap; - /** Maximum known length - * - * We don't always know the file length in advance. In - * particular, if the TFTP server doesn't support the tsize - * option, or we are using MTFTP, then we don't know the file - * length until we see the end-of-file block (which, in the - * case of MTFTP, may not be the last block we see). - * - * This value is updated whenever we obtain information about - * the file length. - */ - size_t filesize; - /** Retransmission timer */ - struct retry_timer timer; -}; - -/** TFTP request flags */ -enum { - /** Send ACK packets */ - TFTP_FL_SEND_ACK = 0x0001, - /** Request blksize and tsize options */ - TFTP_FL_RRQ_SIZES = 0x0002, - /** Request multicast option */ - TFTP_FL_RRQ_MULTICAST = 0x0004, - /** Perform MTFTP recovery on timeout */ - TFTP_FL_MTFTP_RECOVERY = 0x0008, - /** Only get filesize and then abort the transfer */ - TFTP_FL_SIZEONLY = 0x0010, -}; - -/** Maximum number of MTFTP open requests before falling back to TFTP */ -#define MTFTP_MAX_TIMEOUTS 3 - -/** - * Free TFTP request - * - * @v refcnt Reference counter - */ -static void tftp_free ( struct refcnt *refcnt ) { - struct tftp_request *tftp = - container_of ( refcnt, struct tftp_request, refcnt ); - - uri_put ( tftp->uri ); - bitmap_free ( &tftp->bitmap ); - free ( tftp ); -} - -/** - * Mark TFTP request as complete - * - * @v tftp TFTP connection - * @v rc Return status code - */ -static void tftp_done ( struct tftp_request *tftp, int rc ) { - - DBGC ( tftp, "TFTP %p finished with status %d (%s)\n", - tftp, rc, strerror ( rc ) ); - - /* Stop the retry timer */ - stop_timer ( &tftp->timer ); - - /* Close all data transfer interfaces */ - xfer_nullify ( &tftp->socket ); - xfer_close ( &tftp->socket, rc ); - xfer_nullify ( &tftp->mc_socket ); - xfer_close ( &tftp->mc_socket, rc ); - xfer_nullify ( &tftp->xfer ); - xfer_close ( &tftp->xfer, rc ); -} - -/** - * Reopen TFTP socket - * - * @v tftp TFTP connection - * @ret rc Return status code - */ -static int tftp_reopen ( struct tftp_request *tftp ) { - struct sockaddr_tcpip server; - int rc; - - /* Close socket */ - xfer_close ( &tftp->socket, 0 ); - - /* Disable ACK sending. */ - tftp->flags &= ~TFTP_FL_SEND_ACK; - - /* Reset peer address */ - memset ( &tftp->peer, 0, sizeof ( tftp->peer ) ); - - /* Open socket */ - memset ( &server, 0, sizeof ( server ) ); - server.st_port = htons ( tftp->port ); - if ( ( rc = xfer_open_named_socket ( &tftp->socket, SOCK_DGRAM, - ( struct sockaddr * ) &server, - tftp->uri->host, NULL ) ) != 0 ) { - DBGC ( tftp, "TFTP %p could not open socket: %s\n", - tftp, strerror ( rc ) ); - return rc; - } - - return 0; -} - -/** - * Reopen TFTP multicast socket - * - * @v tftp TFTP connection - * @v local Local socket address - * @ret rc Return status code - */ -static int tftp_reopen_mc ( struct tftp_request *tftp, - struct sockaddr *local ) { - int rc; - - /* Close multicast socket */ - xfer_close ( &tftp->mc_socket, 0 ); - - /* Open multicast socket. We never send via this socket, so - * use the local address as the peer address (since the peer - * address cannot be NULL). - */ - if ( ( rc = xfer_open_socket ( &tftp->mc_socket, SOCK_DGRAM, - local, local ) ) != 0 ) { - DBGC ( tftp, "TFTP %p could not open multicast " - "socket: %s\n", tftp, strerror ( rc ) ); - return rc; - } - - return 0; -} - -/** - * Presize TFTP receive buffers and block bitmap - * - * @v tftp TFTP connection - * @v filesize Known minimum file size - * @ret rc Return status code - */ -static int tftp_presize ( struct tftp_request *tftp, size_t filesize ) { - unsigned int num_blocks; - int rc; - - /* Do nothing if we are already large enough */ - if ( filesize <= tftp->filesize ) - return 0; - - /* Record filesize */ - tftp->filesize = filesize; - - /* Notify recipient of file size */ - xfer_seek ( &tftp->xfer, filesize, SEEK_SET ); - xfer_seek ( &tftp->xfer, 0, SEEK_SET ); - - /* Calculate expected number of blocks. Note that files whose - * length is an exact multiple of the blocksize will have a - * trailing zero-length block, which must be included. - */ - num_blocks = ( ( filesize / tftp->blksize ) + 1 ); - if ( ( rc = bitmap_resize ( &tftp->bitmap, num_blocks ) ) != 0 ) { - DBGC ( tftp, "TFTP %p could not resize bitmap to %d blocks: " - "%s\n", tftp, num_blocks, strerror ( rc ) ); - return rc; - } - - return 0; -} - -/** - * TFTP requested blocksize - * - * This is treated as a global configuration parameter. - */ -static unsigned int tftp_request_blksize = TFTP_MAX_BLKSIZE; - -/** - * Set TFTP request blocksize - * - * @v blksize Requested block size - */ -void tftp_set_request_blksize ( unsigned int blksize ) { - if ( blksize < TFTP_DEFAULT_BLKSIZE ) - blksize = TFTP_DEFAULT_BLKSIZE; - tftp_request_blksize = blksize; -} - -/** - * MTFTP multicast receive address - * - * This is treated as a global configuration parameter. - */ -static struct sockaddr_in tftp_mtftp_socket = { - .sin_family = AF_INET, - .sin_addr.s_addr = htonl ( 0xefff0101 ), - .sin_port = htons ( 3001 ), -}; - -/** - * Set MTFTP multicast address - * - * @v address Multicast IPv4 address - */ -void tftp_set_mtftp_address ( struct in_addr address ) { - tftp_mtftp_socket.sin_addr = address; -} - -/** - * Set MTFTP multicast port - * - * @v port Multicast port - */ -void tftp_set_mtftp_port ( unsigned int port ) { - tftp_mtftp_socket.sin_port = htons ( port ); -} - -/** - * Transmit RRQ - * - * @v tftp TFTP connection - * @ret rc Return status code - */ -static int tftp_send_rrq ( struct tftp_request *tftp ) { - struct tftp_rrq *rrq; - const char *path; - size_t len; - struct io_buffer *iobuf; - - /* Strip initial '/' if present. If we were opened via the - * URI interface, then there will be an initial '/', since a - * full tftp:// URI provides no way to specify a non-absolute - * path. However, many TFTP servers (particularly Windows - * TFTP servers) complain about having an initial '/', and it - * violates user expectations to have a '/' silently added to - * the DHCP-specified filename. - */ - path = tftp->uri->path; - if ( *path == '/' ) - path++; - - DBGC ( tftp, "TFTP %p requesting \"%s\"\n", tftp, path ); - - /* Allocate buffer */ - len = ( sizeof ( *rrq ) + strlen ( path ) + 1 /* NUL */ - + 5 + 1 /* "octet" + NUL */ - + 7 + 1 + 5 + 1 /* "blksize" + NUL + ddddd + NUL */ - + 5 + 1 + 1 + 1 /* "tsize" + NUL + "0" + NUL */ - + 9 + 1 + 1 /* "multicast" + NUL + NUL */ ); - iobuf = xfer_alloc_iob ( &tftp->socket, len ); - if ( ! iobuf ) - return -ENOMEM; - - /* Build request */ - rrq = iob_put ( iobuf, sizeof ( *rrq ) ); - rrq->opcode = htons ( TFTP_RRQ ); - iob_put ( iobuf, snprintf ( iobuf->tail, iob_tailroom ( iobuf ), - "%s%coctet", path, 0 ) + 1 ); - if ( tftp->flags & TFTP_FL_RRQ_SIZES ) { - iob_put ( iobuf, snprintf ( iobuf->tail, - iob_tailroom ( iobuf ), - "blksize%c%d%ctsize%c0", 0, - tftp_request_blksize, 0, 0 ) + 1 ); - } - if ( tftp->flags & TFTP_FL_RRQ_MULTICAST ) { - iob_put ( iobuf, snprintf ( iobuf->tail, - iob_tailroom ( iobuf ), - "multicast%c", 0 ) + 1 ); - } - - /* RRQ always goes to the address specified in the initial - * xfer_open() call - */ - return xfer_deliver_iob ( &tftp->socket, iobuf ); -} - -/** - * Transmit ACK - * - * @v tftp TFTP connection - * @ret rc Return status code - */ -static int tftp_send_ack ( struct tftp_request *tftp ) { - struct tftp_ack *ack; - struct io_buffer *iobuf; - struct xfer_metadata meta = { - .dest = ( struct sockaddr * ) &tftp->peer, - }; - unsigned int block; - - /* Determine next required block number */ - block = bitmap_first_gap ( &tftp->bitmap ); - DBGC2 ( tftp, "TFTP %p sending ACK for block %d\n", tftp, block ); - - /* Allocate buffer */ - iobuf = xfer_alloc_iob ( &tftp->socket, sizeof ( *ack ) ); - if ( ! iobuf ) - return -ENOMEM; - - /* Build ACK */ - ack = iob_put ( iobuf, sizeof ( *ack ) ); - ack->opcode = htons ( TFTP_ACK ); - ack->block = htons ( block ); - - /* ACK always goes to the peer recorded from the RRQ response */ - return xfer_deliver_iob_meta ( &tftp->socket, iobuf, &meta ); -} - -/** - * Transmit ERROR (Abort) - * - * @v tftp TFTP connection - * @v errcode TFTP error code - * @v errmsg Error message string - * @ret rc Return status code - */ -static int tftp_send_error ( struct tftp_request *tftp, int errcode, - const char *errmsg ) { - struct tftp_error *err; - struct io_buffer *iobuf; - struct xfer_metadata meta = { - .dest = ( struct sockaddr * ) &tftp->peer, - }; - size_t msglen; - - DBGC2 ( tftp, "TFTP %p sending ERROR %d: %s\n", tftp, errcode, - errmsg ); - - /* Allocate buffer */ - msglen = sizeof ( *err ) + strlen ( errmsg ) + 1 /* NUL */; - iobuf = xfer_alloc_iob ( &tftp->socket, msglen ); - if ( ! iobuf ) - return -ENOMEM; - - /* Build ERROR */ - err = iob_put ( iobuf, msglen ); - err->opcode = htons ( TFTP_ERROR ); - err->errcode = htons ( errcode ); - strcpy ( err->errmsg, errmsg ); - - /* ERR always goes to the peer recorded from the RRQ response */ - return xfer_deliver_iob_meta ( &tftp->socket, iobuf, &meta ); -} - -/** - * Transmit next relevant packet - * - * @v tftp TFTP connection - * @ret rc Return status code - */ -static int tftp_send_packet ( struct tftp_request *tftp ) { - - /* Update retransmission timer. While name resolution takes place the - * window is zero. Avoid unnecessary delay after name resolution - * completes by retrying immediately. - */ - stop_timer ( &tftp->timer ); - if ( xfer_window ( &tftp->socket ) ) { - start_timer ( &tftp->timer ); - } else { - start_timer_nodelay ( &tftp->timer ); - } - - /* Send RRQ or ACK as appropriate */ - if ( ! tftp->peer.st_family ) { - return tftp_send_rrq ( tftp ); - } else { - if ( tftp->flags & TFTP_FL_SEND_ACK ) { - return tftp_send_ack ( tftp ); - } else { - return 0; - } - } -} - -/** - * Handle TFTP retransmission timer expiry - * - * @v timer Retry timer - * @v fail Failure indicator - */ -static void tftp_timer_expired ( struct retry_timer *timer, int fail ) { - struct tftp_request *tftp = - container_of ( timer, struct tftp_request, timer ); - int rc; - - /* If we are doing MTFTP, attempt the various recovery strategies */ - if ( tftp->flags & TFTP_FL_MTFTP_RECOVERY ) { - if ( tftp->peer.st_family ) { - /* If we have received any response from the server, - * try resending the RRQ to restart the download. - */ - DBGC ( tftp, "TFTP %p attempting reopen\n", tftp ); - if ( ( rc = tftp_reopen ( tftp ) ) != 0 ) - goto err; - } else { - /* Fall back to plain TFTP after several attempts */ - tftp->mtftp_timeouts++; - DBGC ( tftp, "TFTP %p timeout %d waiting for MTFTP " - "open\n", tftp, tftp->mtftp_timeouts ); - - if ( tftp->mtftp_timeouts > MTFTP_MAX_TIMEOUTS ) { - DBGC ( tftp, "TFTP %p falling back to plain " - "TFTP\n", tftp ); - tftp->flags = TFTP_FL_RRQ_SIZES; - - /* Close multicast socket */ - xfer_close ( &tftp->mc_socket, 0 ); - - /* Reset retry timer */ - start_timer_nodelay ( &tftp->timer ); - - /* The blocksize may change: discard - * the block bitmap - */ - bitmap_free ( &tftp->bitmap ); - memset ( &tftp->bitmap, 0, - sizeof ( tftp->bitmap ) ); - - /* Reopen on standard TFTP port */ - tftp->port = TFTP_PORT; - if ( ( rc = tftp_reopen ( tftp ) ) != 0 ) - goto err; - } - } - } else { - /* Not doing MTFTP (or have fallen back to plain - * TFTP); fail as per normal. - */ - if ( fail ) { - rc = -ETIMEDOUT; - goto err; - } - } - tftp_send_packet ( tftp ); - return; - - err: - tftp_done ( tftp, rc ); -} - -/** - * Process TFTP "blksize" option - * - * @v tftp TFTP connection - * @v value Option value - * @ret rc Return status code - */ -static int tftp_process_blksize ( struct tftp_request *tftp, - const char *value ) { - char *end; - - tftp->blksize = strtoul ( value, &end, 10 ); - if ( *end ) { - DBGC ( tftp, "TFTP %p got invalid blksize \"%s\"\n", - tftp, value ); - return -( EINVAL | ETFTP_INVALID_BLKSIZE ); - } - DBGC ( tftp, "TFTP %p blksize=%d\n", tftp, tftp->blksize ); - - return 0; -} - -/** - * Process TFTP "tsize" option - * - * @v tftp TFTP connection - * @v value Option value - * @ret rc Return status code - */ -static int tftp_process_tsize ( struct tftp_request *tftp, - const char *value ) { - char *end; - - tftp->tsize = strtoul ( value, &end, 10 ); - if ( *end ) { - DBGC ( tftp, "TFTP %p got invalid tsize \"%s\"\n", - tftp, value ); - return -( EINVAL | ETFTP_INVALID_TSIZE ); - } - DBGC ( tftp, "TFTP %p tsize=%ld\n", tftp, tftp->tsize ); - - return 0; -} - -/** - * Process TFTP "multicast" option - * - * @v tftp TFTP connection - * @v value Option value - * @ret rc Return status code - */ -static int tftp_process_multicast ( struct tftp_request *tftp, - const char *value ) { - union { - struct sockaddr sa; - struct sockaddr_in sin; - } socket; - char buf[ strlen ( value ) + 1 ]; - char *addr; - char *port; - char *port_end; - char *mc; - char *mc_end; - int rc; - - /* Split value into "addr,port,mc" fields */ - memcpy ( buf, value, sizeof ( buf ) ); - addr = buf; - port = strchr ( addr, ',' ); - if ( ! port ) { - DBGC ( tftp, "TFTP %p multicast missing port,mc\n", tftp ); - return -( EINVAL | ETFTP_MC_NO_PORT ); - } - *(port++) = '\0'; - mc = strchr ( port, ',' ); - if ( ! mc ) { - DBGC ( tftp, "TFTP %p multicast missing mc\n", tftp ); - return -( EINVAL | ETFTP_MC_NO_MC ); - } - *(mc++) = '\0'; - - /* Parse parameters */ - if ( strtoul ( mc, &mc_end, 0 ) == 0 ) - tftp->flags &= ~TFTP_FL_SEND_ACK; - if ( *mc_end ) { - DBGC ( tftp, "TFTP %p multicast invalid mc %s\n", tftp, mc ); - return -( EINVAL | ETFTP_MC_INVALID_MC ); - } - DBGC ( tftp, "TFTP %p is%s the master client\n", - tftp, ( ( tftp->flags & TFTP_FL_SEND_ACK ) ? "" : " not" ) ); - if ( *addr && *port ) { - socket.sin.sin_family = AF_INET; - if ( inet_aton ( addr, &socket.sin.sin_addr ) == 0 ) { - DBGC ( tftp, "TFTP %p multicast invalid IP address " - "%s\n", tftp, addr ); - return -( EINVAL | ETFTP_MC_INVALID_IP ); - } - DBGC ( tftp, "TFTP %p multicast IP address %s\n", - tftp, inet_ntoa ( socket.sin.sin_addr ) ); - socket.sin.sin_port = htons ( strtoul ( port, &port_end, 0 ) ); - if ( *port_end ) { - DBGC ( tftp, "TFTP %p multicast invalid port %s\n", - tftp, port ); - return -( EINVAL | ETFTP_MC_INVALID_PORT ); - } - DBGC ( tftp, "TFTP %p multicast port %d\n", - tftp, ntohs ( socket.sin.sin_port ) ); - if ( ( rc = tftp_reopen_mc ( tftp, &socket.sa ) ) != 0 ) - return rc; - } - - return 0; -} - -/** A TFTP option */ -struct tftp_option { - /** Option name */ - const char *name; - /** Option processor - * - * @v tftp TFTP connection - * @v value Option value - * @ret rc Return status code - */ - int ( * process ) ( struct tftp_request *tftp, const char *value ); -}; - -/** Recognised TFTP options */ -static struct tftp_option tftp_options[] = { - { "blksize", tftp_process_blksize }, - { "tsize", tftp_process_tsize }, - { "multicast", tftp_process_multicast }, - { NULL, NULL } -}; - -/** - * Process TFTP option - * - * @v tftp TFTP connection - * @v name Option name - * @v value Option value - * @ret rc Return status code - */ -static int tftp_process_option ( struct tftp_request *tftp, - const char *name, const char *value ) { - struct tftp_option *option; - - for ( option = tftp_options ; option->name ; option++ ) { - if ( strcasecmp ( name, option->name ) == 0 ) - return option->process ( tftp, value ); - } - - DBGC ( tftp, "TFTP %p received unknown option \"%s\" = \"%s\"\n", - tftp, name, value ); - - /* Unknown options should be silently ignored */ - return 0; -} - -/** - * Receive OACK - * - * @v tftp TFTP connection - * @v buf Temporary data buffer - * @v len Length of temporary data buffer - * @ret rc Return status code - */ -static int tftp_rx_oack ( struct tftp_request *tftp, void *buf, size_t len ) { - struct tftp_oack *oack = buf; - char *end = buf + len; - char *name; - char *value; - char *next; - int rc = 0; - - /* Sanity check */ - if ( len < sizeof ( *oack ) ) { - DBGC ( tftp, "TFTP %p received underlength OACK packet " - "length %zd\n", tftp, len ); - rc = -EINVAL; - goto done; - } - - /* Process each option in turn */ - for ( name = oack->data ; name < end ; name = next ) { - - /* Parse option name and value - * - * We treat parsing errors as non-fatal, because there - * exists at least one TFTP server (IBM Tivoli PXE - * Server 5.1.0.3) that has been observed to send - * malformed OACKs containing trailing garbage bytes. - */ - value = ( name + strnlen ( name, ( end - name ) ) + 1 ); - if ( value > end ) { - DBGC ( tftp, "TFTP %p received OACK with malformed " - "option name:\n", tftp ); - DBGC_HD ( tftp, oack, len ); - break; - } - if ( value == end ) { - DBGC ( tftp, "TFTP %p received OACK missing value " - "for option \"%s\"\n", tftp, name ); - DBGC_HD ( tftp, oack, len ); - break; - } - next = ( value + strnlen ( value, ( end - value ) ) + 1 ); - if ( next > end ) { - DBGC ( tftp, "TFTP %p received OACK with malformed " - "value for option \"%s\":\n", tftp, name ); - DBGC_HD ( tftp, oack, len ); - break; - } - - /* Process option */ - if ( ( rc = tftp_process_option ( tftp, name, value ) ) != 0 ) - goto done; - } - - /* Process tsize information, if available */ - if ( tftp->tsize ) { - if ( ( rc = tftp_presize ( tftp, tftp->tsize ) ) != 0 ) - goto done; - } - - /* Abort request if only trying to determine file size */ - if ( tftp->flags & TFTP_FL_SIZEONLY ) { - rc = 0; - tftp_send_error ( tftp, 0, "TFTP Aborted" ); - tftp_done ( tftp, rc ); - return rc; - } - - /* Request next data block */ - tftp_send_packet ( tftp ); - - done: - if ( rc ) - tftp_done ( tftp, rc ); - return rc; -} - -/** - * Receive DATA - * - * @v tftp TFTP connection - * @v iobuf I/O buffer - * @ret rc Return status code - * - * Takes ownership of I/O buffer. - */ -static int tftp_rx_data ( struct tftp_request *tftp, - struct io_buffer *iobuf ) { - struct tftp_data *data = iobuf->data; - struct xfer_metadata meta; - unsigned int block; - off_t offset; - size_t data_len; - int rc; - - if ( tftp->flags & TFTP_FL_SIZEONLY ) { - /* If we get here then server doesn't support SIZE option */ - rc = -ENOTSUP; - tftp_send_error ( tftp, 0, "TFTP Aborted" ); - goto done; - } - - /* Sanity check */ - if ( iob_len ( iobuf ) < sizeof ( *data ) ) { - DBGC ( tftp, "TFTP %p received underlength DATA packet " - "length %zd\n", tftp, iob_len ( iobuf ) ); - rc = -EINVAL; - goto done; - } - - /* Calculate block number */ - block = ( ( bitmap_first_gap ( &tftp->bitmap ) + 1 ) & ~0xffff ); - if ( data->block == 0 && block == 0 ) { - DBGC ( tftp, "TFTP %p received data block 0\n", tftp ); - rc = -EINVAL; - goto done; - } - block += ( ntohs ( data->block ) - 1 ); - - /* Extract data */ - offset = ( block * tftp->blksize ); - iob_pull ( iobuf, sizeof ( *data ) ); - data_len = iob_len ( iobuf ); - if ( data_len > tftp->blksize ) { - DBGC ( tftp, "TFTP %p received overlength DATA packet " - "length %zd\n", tftp, data_len ); - rc = -EINVAL; - goto done; - } - - /* Deliver data */ - memset ( &meta, 0, sizeof ( meta ) ); - meta.whence = SEEK_SET; - meta.offset = offset; - if ( ( rc = xfer_deliver_iob_meta ( &tftp->xfer, iob_disown ( iobuf ), - &meta ) ) != 0 ) { - DBGC ( tftp, "TFTP %p could not deliver data: %s\n", - tftp, strerror ( rc ) ); - goto done; - } - - /* Ensure block bitmap is ready */ - if ( ( rc = tftp_presize ( tftp, ( offset + data_len ) ) ) != 0 ) - goto done; - - /* Mark block as received */ - bitmap_set ( &tftp->bitmap, block ); - - /* Acknowledge block */ - tftp_send_packet ( tftp ); - - /* If all blocks have been received, finish. */ - if ( bitmap_full ( &tftp->bitmap ) ) - tftp_done ( tftp, 0 ); - - done: - free_iob ( iobuf ); - if ( rc ) - tftp_done ( tftp, rc ); - return rc; -} - -/** Translation between TFTP errors and internal error numbers */ -static const int tftp_errors[] = { - [TFTP_ERR_FILE_NOT_FOUND] = ENOENT, - [TFTP_ERR_ACCESS_DENIED] = EACCES, - [TFTP_ERR_ILLEGAL_OP] = ENOTSUP, -}; - -/** - * Receive ERROR - * - * @v tftp TFTP connection - * @v buf Temporary data buffer - * @v len Length of temporary data buffer - * @ret rc Return status code - */ -static int tftp_rx_error ( struct tftp_request *tftp, void *buf, size_t len ) { - struct tftp_error *error = buf; - unsigned int err; - int rc = 0; - - /* Sanity check */ - if ( len < sizeof ( *error ) ) { - DBGC ( tftp, "TFTP %p received underlength ERROR packet " - "length %zd\n", tftp, len ); - return -EINVAL; - } - - DBGC ( tftp, "TFTP %p received ERROR packet with code %d, message " - "\"%s\"\n", tftp, ntohs ( error->errcode ), error->errmsg ); - - /* Determine final operation result */ - err = ntohs ( error->errcode ); - if ( err < ( sizeof ( tftp_errors ) / sizeof ( tftp_errors[0] ) ) ) - rc = -tftp_errors[err]; - if ( ! rc ) - rc = -ENOTSUP; - - /* Close TFTP request */ - tftp_done ( tftp, rc ); - - return 0; -} - -/** - * Receive new data - * - * @v tftp TFTP connection - * @v iobuf I/O buffer - * @v meta Transfer metadata - * @ret rc Return status code - */ -static int tftp_rx ( struct tftp_request *tftp, - struct io_buffer *iobuf, - struct xfer_metadata *meta ) { - struct sockaddr_tcpip *st_src; - struct tftp_common *common = iobuf->data; - size_t len = iob_len ( iobuf ); - int rc = -EINVAL; - - /* Sanity checks */ - if ( len < sizeof ( *common ) ) { - DBGC ( tftp, "TFTP %p received underlength packet length " - "%zd\n", tftp, len ); - goto done; - } - if ( ! meta->src ) { - DBGC ( tftp, "TFTP %p received packet without source port\n", - tftp ); - goto done; - } - - /* Filter by TID. Set TID on first response received */ - st_src = ( struct sockaddr_tcpip * ) meta->src; - if ( ! tftp->peer.st_family ) { - memcpy ( &tftp->peer, st_src, sizeof ( tftp->peer ) ); - DBGC ( tftp, "TFTP %p using remote port %d\n", tftp, - ntohs ( tftp->peer.st_port ) ); - } else if ( memcmp ( &tftp->peer, st_src, - sizeof ( tftp->peer ) ) != 0 ) { - DBGC ( tftp, "TFTP %p received packet from wrong source (got " - "%d, wanted %d)\n", tftp, ntohs ( st_src->st_port ), - ntohs ( tftp->peer.st_port ) ); - goto done; - } - - switch ( common->opcode ) { - case htons ( TFTP_OACK ): - rc = tftp_rx_oack ( tftp, iobuf->data, len ); - break; - case htons ( TFTP_DATA ): - rc = tftp_rx_data ( tftp, iob_disown ( iobuf ) ); - break; - case htons ( TFTP_ERROR ): - rc = tftp_rx_error ( tftp, iobuf->data, len ); - break; - default: - DBGC ( tftp, "TFTP %p received strange packet type %d\n", - tftp, ntohs ( common->opcode ) ); - break; - }; - - done: - free_iob ( iobuf ); - return rc; -} - -/** - * Receive new data via socket - * - * @v socket Transport layer interface - * @v iobuf I/O buffer - * @v meta Transfer metadata - * @ret rc Return status code - */ -static int tftp_socket_deliver_iob ( struct xfer_interface *socket, - struct io_buffer *iobuf, - struct xfer_metadata *meta ) { - struct tftp_request *tftp = - container_of ( socket, struct tftp_request, socket ); - - /* Enable sending ACKs when we receive a unicast packet. This - * covers three cases: - * - * 1. Standard TFTP; we should always send ACKs, and will - * always receive a unicast packet before we need to send the - * first ACK. - * - * 2. RFC2090 multicast TFTP; the only unicast packets we will - * receive are the OACKs; enable sending ACKs here (before - * processing the OACK) and disable it when processing the - * multicast option if we are not the master client. - * - * 3. MTFTP; receiving a unicast datagram indicates that we - * are the "master client" and should send ACKs. - */ - tftp->flags |= TFTP_FL_SEND_ACK; - - return tftp_rx ( tftp, iobuf, meta ); -} - -/** TFTP socket operations */ -static struct xfer_interface_operations tftp_socket_operations = { - .close = ignore_xfer_close, - .vredirect = xfer_vreopen, - .window = unlimited_xfer_window, - .alloc_iob = default_xfer_alloc_iob, - .deliver_iob = tftp_socket_deliver_iob, - .deliver_raw = xfer_deliver_as_iob, -}; - -/** - * Receive new data via multicast socket - * - * @v mc_socket Multicast transport layer interface - * @v iobuf I/O buffer - * @v meta Transfer metadata - * @ret rc Return status code - */ -static int tftp_mc_socket_deliver_iob ( struct xfer_interface *mc_socket, - struct io_buffer *iobuf, - struct xfer_metadata *meta ) { - struct tftp_request *tftp = - container_of ( mc_socket, struct tftp_request, mc_socket ); - - return tftp_rx ( tftp, iobuf, meta ); -} - -/** TFTP multicast socket operations */ -static struct xfer_interface_operations tftp_mc_socket_operations = { - .close = ignore_xfer_close, - .vredirect = xfer_vreopen, - .window = unlimited_xfer_window, - .alloc_iob = default_xfer_alloc_iob, - .deliver_iob = tftp_mc_socket_deliver_iob, - .deliver_raw = xfer_deliver_as_iob, -}; - -/** - * Close TFTP data transfer interface - * - * @v xfer Data transfer interface - * @v rc Reason for close - */ -static void tftp_xfer_close ( struct xfer_interface *xfer, int rc ) { - struct tftp_request *tftp = - container_of ( xfer, struct tftp_request, xfer ); - - DBGC ( tftp, "TFTP %p interface closed: %s\n", - tftp, strerror ( rc ) ); - - tftp_done ( tftp, rc ); -} - -/** - * Check flow control window - * - * @v xfer Data transfer interface - * @ret len Length of window - */ -static size_t tftp_xfer_window ( struct xfer_interface *xfer ) { - struct tftp_request *tftp = - container_of ( xfer, struct tftp_request, xfer ); - - /* We abuse this data-xfer method to convey the blocksize to - * the caller. This really should be done using some kind of - * stat() method, but we don't yet have the facility to do - * that. - */ - return tftp->blksize; -} - -/** TFTP data transfer interface operations */ -static struct xfer_interface_operations tftp_xfer_operations = { - .close = tftp_xfer_close, - .vredirect = ignore_xfer_vredirect, - .window = tftp_xfer_window, - .alloc_iob = default_xfer_alloc_iob, - .deliver_iob = xfer_deliver_as_raw, - .deliver_raw = ignore_xfer_deliver_raw, -}; - -/** - * Initiate TFTP/TFTM/MTFTP download - * - * @v xfer Data transfer interface - * @v uri Uniform Resource Identifier - * @ret rc Return status code - */ -static int tftp_core_open ( struct xfer_interface *xfer, struct uri *uri, - unsigned int default_port, - struct sockaddr *multicast, - unsigned int flags ) { - struct tftp_request *tftp; - int rc; - - /* Sanity checks */ - if ( ! uri->host ) - return -EINVAL; - if ( ! uri->path ) - return -EINVAL; - - /* Allocate and populate TFTP structure */ - tftp = zalloc ( sizeof ( *tftp ) ); - if ( ! tftp ) - return -ENOMEM; - tftp->refcnt.free = tftp_free; - xfer_init ( &tftp->xfer, &tftp_xfer_operations, &tftp->refcnt ); - tftp->uri = uri_get ( uri ); - xfer_init ( &tftp->socket, &tftp_socket_operations, &tftp->refcnt ); - xfer_init ( &tftp->mc_socket, &tftp_mc_socket_operations, - &tftp->refcnt ); - tftp->blksize = TFTP_DEFAULT_BLKSIZE; - tftp->flags = flags; - tftp->timer.expired = tftp_timer_expired; - - /* Open socket */ - tftp->port = uri_port ( tftp->uri, default_port ); - if ( ( rc = tftp_reopen ( tftp ) ) != 0 ) - goto err; - - /* Open multicast socket */ - if ( multicast ) { - if ( ( rc = tftp_reopen_mc ( tftp, multicast ) ) != 0 ) - goto err; - } - - /* Start timer to initiate RRQ */ - start_timer_nodelay ( &tftp->timer ); - - /* Attach to parent interface, mortalise self, and return */ - xfer_plug_plug ( &tftp->xfer, xfer ); - ref_put ( &tftp->refcnt ); - return 0; - - err: - DBGC ( tftp, "TFTP %p could not create request: %s\n", - tftp, strerror ( rc ) ); - tftp_done ( tftp, rc ); - ref_put ( &tftp->refcnt ); - return rc; -} - -/** - * Initiate TFTP download - * - * @v xfer Data transfer interface - * @v uri Uniform Resource Identifier - * @ret rc Return status code - */ -static int tftp_open ( struct xfer_interface *xfer, struct uri *uri ) { - return tftp_core_open ( xfer, uri, TFTP_PORT, NULL, - TFTP_FL_RRQ_SIZES ); - -} - -/** TFTP URI opener */ -struct uri_opener tftp_uri_opener __uri_opener = { - .scheme = "tftp", - .open = tftp_open, -}; - -/** - * Initiate TFTP-size request - * - * @v xfer Data transfer interface - * @v uri Uniform Resource Identifier - * @ret rc Return status code - */ -static int tftpsize_open ( struct xfer_interface *xfer, struct uri *uri ) { - return tftp_core_open ( xfer, uri, TFTP_PORT, NULL, - ( TFTP_FL_RRQ_SIZES | - TFTP_FL_SIZEONLY ) ); - -} - -/** TFTP URI opener */ -struct uri_opener tftpsize_uri_opener __uri_opener = { - .scheme = "tftpsize", - .open = tftpsize_open, -}; - -/** - * Initiate TFTM download - * - * @v xfer Data transfer interface - * @v uri Uniform Resource Identifier - * @ret rc Return status code - */ -static int tftm_open ( struct xfer_interface *xfer, struct uri *uri ) { - return tftp_core_open ( xfer, uri, TFTP_PORT, NULL, - ( TFTP_FL_RRQ_SIZES | - TFTP_FL_RRQ_MULTICAST ) ); - -} - -/** TFTM URI opener */ -struct uri_opener tftm_uri_opener __uri_opener = { - .scheme = "tftm", - .open = tftm_open, -}; - -/** - * Initiate MTFTP download - * - * @v xfer Data transfer interface - * @v uri Uniform Resource Identifier - * @ret rc Return status code - */ -static int mtftp_open ( struct xfer_interface *xfer, struct uri *uri ) { - return tftp_core_open ( xfer, uri, MTFTP_PORT, - ( struct sockaddr * ) &tftp_mtftp_socket, - TFTP_FL_MTFTP_RECOVERY ); -} - -/** MTFTP URI opener */ -struct uri_opener mtftp_uri_opener __uri_opener = { - .scheme = "mtftp", - .open = mtftp_open, -}; - -/****************************************************************************** - * - * Settings - * - ****************************************************************************** - */ - -/** TFTP server setting */ -struct setting next_server_setting __setting = { - .name = "next-server", - .description = "TFTP server", - .tag = DHCP_EB_SIADDR, - .type = &setting_type_ipv4, -}; - -/** - * Apply TFTP configuration settings - * - * @ret rc Return status code - */ -static int tftp_apply_settings ( void ) { - static struct in_addr tftp_server = { 0 }; - struct in_addr last_tftp_server; - char uri_string[32]; - struct uri *uri; - - /* Retrieve TFTP server setting */ - last_tftp_server = tftp_server; - fetch_ipv4_setting ( NULL, &next_server_setting, &tftp_server ); - - /* If TFTP server setting has changed, set the current working - * URI to match. Do it only when the TFTP server has changed - * to try to minimise surprises to the user, who probably - * won't expect the CWURI to change just because they updated - * an unrelated setting and triggered all the settings - * applicators. - */ - if ( tftp_server.s_addr != last_tftp_server.s_addr ) { - snprintf ( uri_string, sizeof ( uri_string ), - "tftp://%s/", inet_ntoa ( tftp_server ) ); - uri = parse_uri ( uri_string ); - if ( ! uri ) - return -ENOMEM; - churi ( uri ); - uri_put ( uri ); - } - - return 0; -} - -/** TFTP settings applicator */ -struct settings_applicator tftp_settings_applicator __settings_applicator = { - .apply = tftp_apply_settings, -}; |