ipxe/src/interface/linux/linux_api.c

/*
 * Copyright (C) 2010 Piotr Jaroszyński <p.jaroszynski@gmail.com>.
 * Copyright (C) 2021 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., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

#define _GNU_SOURCE
#include <stdint.h>
#include <stdarg.h>
#include <unistd.h>
#include <string.h>
#include <errno.h>
#include <assert.h>
#include <fcntl.h>
#include <time.h>
#include <poll.h>
#include <sys/ioctl.h>
#include <sys/mman.h>
#include <sys/socket.h>
#include <sys/time.h>
#include <sys/stat.h>
#include <netinet/in.h>
#include <ipxe/linux_api.h>
#include <ipxe/slirp.h>

#ifdef HAVE_LIBSLIRP
#include <slirp/libslirp.h>
#endif

#undef static_assert
#define static_assert(x) _Static_assert(x, #x)

/** @file
 *
 * Linux host API
 *
 */

/** Construct prefixed symbol name */
#define _C1( x, y ) x ## y
#define _C2( x, y ) _C1 ( x, y )

/** Construct prefixed symbol name for iPXE symbols */
#define IPXE_SYM( symbol ) _C2 ( SYMBOL_PREFIX, symbol )

/** Provide a prefixed symbol alias visible to iPXE code */
#define PROVIDE_IPXE_SYM( symbol )					\
	extern typeof ( symbol ) IPXE_SYM ( symbol )			\
		__attribute__ (( alias ( #symbol) ))

/** Most recent system call error */
int linux_errno __attribute__ (( nocommon ));

/******************************************************************************
 *
 * Host entry point
 *
 ******************************************************************************
 */

extern int IPXE_SYM ( _linux_start ) ( int argc, char **argv );

/**
 * Main entry point
 *
 * @v argc		Argument count
 * @v argv		Argument list
 * @ret rc		Exit status
 */
int main ( int argc, char **argv ) {

	return IPXE_SYM ( _linux_start ) ( argc, argv );
}

/******************************************************************************
 *
 * System call wrappers
 *
 ******************************************************************************
 */

/**
 * Wrap open()
 *
 */
int __asmcall linux_open ( const char *pathname, int flags, ... ) {
	va_list args;
	mode_t mode;
	int ret;

	va_start ( args, flags );
	mode = va_arg ( args, mode_t );
	va_end ( args );
	ret = open ( pathname, flags, mode );
	if ( ret == -1 )
		linux_errno = errno;
	return ret;
}

/**
 * Wrap close()
 *
 */
int __asmcall linux_close ( int fd ) {
	int ret;

	ret = close ( fd );
	if ( ret == -1 )
		linux_errno = errno;
	return ret;
}

/**
 * Wrap lseek()
 *
 */
off_t __asmcall linux_lseek ( int fd, off_t offset, int whence ) {
	off_t ret;

	ret = lseek ( fd, offset, whence );
	if ( ret == -1 )
		linux_errno = errno;
	return ret;
}

/**
 * Wrap read()
 *
 */
ssize_t __asmcall linux_read ( int fd, void *buf, size_t count ) {
	ssize_t ret;

	ret = read ( fd, buf, count );
	if ( ret == -1 )
		linux_errno = errno;
	return ret;
}

/**
 * Wrap write()
 *
 */
ssize_t __asmcall linux_write ( int fd, const void *buf, size_t count ) {
	ssize_t ret;

	ret = write ( fd, buf, count );
	if ( ret == -1 )
		linux_errno = errno;
	return ret;
}

/**
 * Wrap fcntl()
 *
 */
int __asmcall linux_fcntl ( int fd, int cmd, ... ) {
	va_list args;
	long arg;
	int ret;

	va_start ( args, cmd );
	arg = va_arg ( args, long );
	va_end ( args );
	ret = fcntl ( fd, cmd, arg );
	if ( ret == -1 )
		linux_errno = errno;
	return ret;
}

/**
 * Wrap ioctl()
 *
 */
int __asmcall linux_ioctl ( int fd, unsigned long request, ... ) {
	va_list args;
	void *arg;
	int ret;

	va_start ( args, request );
	arg = va_arg ( args, void * );
	va_end ( args );
	ret = ioctl ( fd, request, arg );
	if ( ret == -1 )
		linux_errno = errno;
	return ret;
}

/**
 * Wrap part of fstat()
 *
 */
int __asmcall linux_fstat_size ( int fd, size_t *size ) {
	struct stat stat;
	int ret;

	ret = fstat ( fd, &stat );
	*size = stat.st_size;
	if ( ret == -1 )
		linux_errno = errno;
	return ret;
}

/**
 * Wrap poll()
 *
 */
int __asmcall linux_poll ( struct pollfd *fds, unsigned int nfds,
			   int timeout ) {
	int ret;

	ret = poll ( fds, nfds, timeout );
	if ( ret == -1 )
		linux_errno = errno;
	return ret;
}

/**
 * Wrap nanosleep()
 *
 */
int __asmcall linux_nanosleep ( const struct timespec *req,
				struct timespec *rem ) {
	int ret;

	ret = nanosleep ( req, rem );
	if ( ret == -1 )
		linux_errno = errno;
	return ret;
}

/**
 * Wrap usleep()
 *
 */
int __asmcall linux_usleep ( unsigned int usec ) {
	int ret;

	ret = usleep ( usec );
	if ( ret == -1 )
		linux_errno = errno;
	return ret;
}

/**
 * Wrap gettimeofday()
 *
 */
int __asmcall linux_gettimeofday ( struct timeval *tv, struct timezone *tz ) {
	int ret;

	ret = gettimeofday ( tv, tz );
	if ( ret == -1 )
		linux_errno = errno;
	return ret;
}

/**
 * Wrap mmap()
 *
*/
void * __asmcall linux_mmap ( void *addr, size_t length, int prot, int flags,
			      int fd, off_t offset ) {
	void *ret;

	ret = mmap ( addr, length, prot, flags, fd, offset );
	if ( ret == MAP_FAILED )
		linux_errno = errno;
	return ret;
}

/**
 * Wrap mremap()
 *
 */
void * __asmcall linux_mremap ( void *old_address, size_t old_size,
				size_t new_size, int flags, ... ) {
	va_list args;
	void *new_address;
	void *ret;

	va_start ( args, flags );
	new_address = va_arg ( args, void * );
	va_end ( args );
	ret = mremap ( old_address, old_size, new_size, flags, new_address );
	if ( ret == MAP_FAILED )
		linux_errno = errno;
	return ret;
}

/**
 * Wrap munmap()
 *
 */
int __asmcall linux_munmap ( void *addr, size_t length ) {
	int ret;

	ret = munmap ( addr, length );
	if ( ret == -1 )
		linux_errno = errno;
	return ret;
}

/**
 * Wrap socket()
 *
 */
int __asmcall linux_socket ( int domain, int type, int protocol ) {
	int ret;

	ret = socket ( domain, type, protocol );
	if ( ret == -1 )
		linux_errno = errno;
	return ret;
}

/**
 * Wrap bind()
 *
 */
int __asmcall linux_bind ( int sockfd, const struct sockaddr *addr,
			   size_t addrlen ) {
	int ret;

	ret = bind ( sockfd, addr, addrlen );
	if ( ret == -1 )
		linux_errno = errno;
	return ret;
}

/**
 * Wrap sendto()
 *
 */
ssize_t __asmcall linux_sendto ( int sockfd, const void *buf, size_t len,
				 int flags, const struct sockaddr *dest_addr,
				 size_t addrlen ) {
	ssize_t ret;

	ret = sendto ( sockfd, buf, len, flags, dest_addr, addrlen );
	if ( ret == -1 )
		linux_errno = errno;
	return ret;
}

/******************************************************************************
 *
 * C library wrappers
 *
 ******************************************************************************
 */

/**
 * Wrap strerror()
 *
 */
const char * __asmcall linux_strerror ( int linux_errno ) {

	return strerror ( linux_errno );
}

/******************************************************************************
 *
 * libslirp wrappers
 *
 ******************************************************************************
 */

#ifdef HAVE_LIBSLIRP

/* Allow use of fd-based polling mechanism
 *
 * libslirp introduced a new API for constructing polling lists, to
 * accommodate Windows platforms where a handle descriptor may be too
 * large for an int.
 *
 * Older versions of libslirp do not have the new API calls, and the
 * older API calls were immediately marked as deprecated, with no
 * overlap.  We would therefore need to use #ifdef and always have
 * some code that is deliberately not compiled, depending on the
 * version of libslirp that we find on the user's system.  This is
 * highly undesirable.
 *
 * Work around this by disabling the deprecation warning (which is
 * what libslirp itself does for the portions of its code that
 * necessarily touch the deprecated functions).
 */
#ifdef __GNUC__
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#endif

/**
 * Wrap slirp_new()
 *
 */
struct Slirp * __asmcall
linux_slirp_new ( const struct slirp_config *config,
		  const struct slirp_callbacks *callbacks, void *opaque ) {
	const union {
		struct slirp_callbacks callbacks;
		SlirpCb cb;
	} *u = ( ( typeof ( u ) ) callbacks );
	SlirpConfig cfg;
	Slirp *slirp;

	/* Translate configuration */
	memset ( &cfg, 0, sizeof ( cfg ) );
	cfg.version = config->version;
	cfg.restricted = config->restricted;
	cfg.in_enabled = config->in_enabled;
	cfg.vnetwork = config->vnetwork;
	cfg.vnetmask = config->vnetmask;
	cfg.vhost = config->vhost;
	cfg.in6_enabled = config->in6_enabled;
	memcpy ( &cfg.vprefix_addr6, &config->vprefix_addr6,
		 sizeof ( cfg.vprefix_addr6 ) );
	cfg.vprefix_len = config->vprefix_len;
	memcpy ( &cfg.vhost6, &config->vhost6, sizeof ( cfg.vhost6 ) );
	cfg.vhostname = config->vhostname;
	cfg.tftp_server_name = config->tftp_server_name;
	cfg.tftp_path = config->tftp_path;
	cfg.bootfile = config->bootfile;
	cfg.vdhcp_start = config->vdhcp_start;
	cfg.vnameserver = config->vnameserver;
	memcpy ( &cfg.vnameserver6, &config->vnameserver6,
		 sizeof ( cfg.vnameserver6 ) );
	cfg.vdnssearch = config->vdnssearch;
	cfg.vdomainname = config->vdomainname;
	cfg.if_mtu = config->if_mtu;
	cfg.if_mru = config->if_mru;
	cfg.disable_host_loopback = config->disable_host_loopback;
	cfg.enable_emu = config->enable_emu;

	/* Validate callback structure */
	static_assert ( &u->cb.send_packet == &u->callbacks.send_packet );
	static_assert ( &u->cb.guest_error == &u->callbacks.guest_error );
	static_assert ( &u->cb.clock_get_ns == &u->callbacks.clock_get_ns );
	static_assert ( &u->cb.timer_new == &u->callbacks.timer_new );
	static_assert ( &u->cb.timer_free == &u->callbacks.timer_free );
	static_assert ( &u->cb.timer_mod == &u->callbacks.timer_mod );
	static_assert ( &u->cb.register_poll_fd ==
			&u->callbacks.register_poll_fd );
	static_assert ( &u->cb.unregister_poll_fd ==
			&u->callbacks.unregister_poll_fd );
	static_assert ( &u->cb.notify == &u->callbacks.notify );

	/* Create device */
	slirp = slirp_new ( &cfg, &u->cb, opaque );

	return slirp;
}

/**
 * Wrap slirp_cleanup()
 *
 */
void __asmcall linux_slirp_cleanup ( struct Slirp *slirp ) {

	slirp_cleanup ( slirp );
}

/**
 * Wrap slirp_input()
 *
 */
void __asmcall linux_slirp_input ( struct Slirp *slirp, const uint8_t *pkt,
				   int pkt_len ) {

	slirp_input ( slirp, pkt, pkt_len );
}

/**
 * Wrap slirp_pollfds_fill()
 *
 */
void __asmcall
linux_slirp_pollfds_fill ( struct Slirp *slirp, uint32_t *timeout,
			   int ( __asmcall * add_poll ) ( int fd, int events,
							  void *opaque ),
			   void *opaque ) {

	slirp_pollfds_fill ( slirp, timeout, add_poll, opaque );
}

/**
 * Wrap slirp_pollfds_poll()
 *
 */
void __asmcall
linux_slirp_pollfds_poll ( struct Slirp *slirp, int select_error,
			   int ( __asmcall * get_revents ) ( int idx,
							     void *opaque ),
			   void *opaque ) {

	slirp_pollfds_poll ( slirp, select_error, get_revents, opaque );
}

#ifdef __GNUC__
#pragma GCC diagnostic pop
#endif

#endif /* HAVE_LIBSLIRP */

/******************************************************************************
 *
 * Symbol aliases
 *
 ******************************************************************************
 */

PROVIDE_IPXE_SYM ( linux_errno );
PROVIDE_IPXE_SYM ( linux_open );
PROVIDE_IPXE_SYM ( linux_close );
PROVIDE_IPXE_SYM ( linux_lseek );
PROVIDE_IPXE_SYM ( linux_read );
PROVIDE_IPXE_SYM ( linux_write );
PROVIDE_IPXE_SYM ( linux_fcntl );
PROVIDE_IPXE_SYM ( linux_ioctl );
PROVIDE_IPXE_SYM ( linux_fstat_size );
PROVIDE_IPXE_SYM ( linux_poll );
PROVIDE_IPXE_SYM ( linux_nanosleep );
PROVIDE_IPXE_SYM ( linux_usleep );
PROVIDE_IPXE_SYM ( linux_gettimeofday );
PROVIDE_IPXE_SYM ( linux_mmap );
PROVIDE_IPXE_SYM ( linux_mremap );
PROVIDE_IPXE_SYM ( linux_munmap );
PROVIDE_IPXE_SYM ( linux_socket );
PROVIDE_IPXE_SYM ( linux_bind );
PROVIDE_IPXE_SYM ( linux_sendto );
PROVIDE_IPXE_SYM ( linux_strerror );

#ifdef HAVE_LIBSLIRP
PROVIDE_IPXE_SYM ( linux_slirp_new );
PROVIDE_IPXE_SYM ( linux_slirp_cleanup );
PROVIDE_IPXE_SYM ( linux_slirp_input );
PROVIDE_IPXE_SYM ( linux_slirp_pollfds_fill );
PROVIDE_IPXE_SYM ( linux_slirp_pollfds_poll );
#endif /* HAVE_LIBSLIRP */