pxe_file.c File Reference

PXE FILE API. More...

#include <stdlib.h>
#include <stdio.h>
#include <errno.h>
#include <byteswap.h>
#include <ipxe/posix_io.h>
#include <ipxe/features.h>
#include <pxe.h>
#include <realmode.h>

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FEATURE (FEATURE_MISC, "PXEXT", DHCP_EB_FEATURE_PXE_EXT, 2)
static PXENV_EXIT_t	pxenv_file_open (struct s_PXENV_FILE_OPEN *file_open)
	FILE OPEN. More...
static PXENV_EXIT_t	pxenv_file_close (struct s_PXENV_FILE_CLOSE *file_close)
	FILE CLOSE. More...
static PXENV_EXIT_t	pxenv_file_select (struct s_PXENV_FILE_SELECT *file_select)
	FILE SELECT. More...
static PXENV_EXIT_t	pxenv_file_read (struct s_PXENV_FILE_READ *file_read)
	FILE READ. More...
static PXENV_EXIT_t	pxenv_get_file_size (struct s_PXENV_GET_FILE_SIZE *get_file_size)
	GET FILE SIZE. More...
static PXENV_EXIT_t	pxenv_file_exec (struct s_PXENV_FILE_EXEC *file_exec)
	FILE EXEC. More...
static PXENV_EXIT_t	pxenv_file_cmdline (struct s_PXENV_FILE_CMDLINE *file_cmdline)
	FILE CMDLINE. More...
static PXENV_EXIT_t	pxenv_file_api_check (struct s_PXENV_FILE_API_CHECK *file_api_check)
	FILE API CHECK. More...

Variables
struct pxe_api_call pxe_file_api []	__pxe_api_call
	PXE file API. More...

Detailed Description

PXE FILE API.

Definition in file pxe_file.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FEATURE()

FEATURE	(	FEATURE_MISC	,
		"PXEXT"	,
		DHCP_EB_FEATURE_PXE_EXT	,
		2
	)

pxenv_file_open()

static PXENV_EXIT_t pxenv_file_open ( struct s_PXENV_FILE_OPEN *  file_open )

static

FILE OPEN.

Parameters

file_open	Pointer to a struct s_PXENV_FILE_OPEN
s_PXENV_FILE_OPEN::FileName	URL of file to open

Return values

PXENV_EXIT_SUCCESS	File was opened
PXENV_EXIT_FAILURE	File was not opened
s_PXENV_FILE_OPEN::Status	PXE status code
s_PXENV_FILE_OPEN::FileHandle	Handle of opened file

Definition at line 54 of file pxe_file.c.

                                                                            {
        const char *filename;
        int fd;

        DBG ( "PXENV_FILE_OPEN" );

        /* Open specified filename */
        filename = real_to_virt ( file_open->FileName.segment,
                                  file_open->FileName.offset );
        DBG ( " %s", filename );
        fd = open ( filename );
        if ( fd < 0 ) {
                file_open->Status = PXENV_STATUS ( fd );
                return PXENV_EXIT_FAILURE;
        }
        DBG ( " as file %d", fd );

        file_open->FileHandle = fd;
        file_open->Status = PXENV_STATUS_SUCCESS;
        return PXENV_EXIT_SUCCESS;
}

References DBG, s_PXENV_FILE_OPEN::FileHandle, s_PXENV_FILE_OPEN::FileName, open(), PXENV_EXIT_FAILURE, PXENV_EXIT_SUCCESS, PXENV_STATUS, PXENV_STATUS_SUCCESS, real_to_virt(), and s_PXENV_FILE_OPEN::Status.

pxenv_file_close()

static PXENV_EXIT_t pxenv_file_close ( struct s_PXENV_FILE_CLOSE *  file_close )

static

FILE CLOSE.

Parameters

file_close	Pointer to a struct s_PXENV_FILE_CLOSE
s_PXENV_FILE_CLOSE::FileHandle	File handle

Return values

PXENV_EXIT_SUCCESS	File was closed
PXENV_EXIT_FAILURE	File was not closed
s_PXENV_FILE_CLOSE::Status	PXE status code

Definition at line 86 of file pxe_file.c.

                                                                               {

        DBG ( "PXENV_FILE_CLOSE %d", file_close->FileHandle );

        close ( file_close->FileHandle );
        file_close->Status = PXENV_STATUS_SUCCESS;
        return PXENV_EXIT_SUCCESS;
}

References close, DBG, s_PXENV_FILE_CLOSE::FileHandle, PXENV_EXIT_SUCCESS, PXENV_STATUS_SUCCESS, and s_PXENV_FILE_CLOSE::Status.

pxenv_file_select()

static PXENV_EXIT_t pxenv_file_select ( struct s_PXENV_FILE_SELECT *  file_select )

static

FILE SELECT.

Parameters

file_select	Pointer to a struct s_PXENV_FILE_SELECT
s_PXENV_FILE_SELECT::FileHandle	File handle

Return values

PXENV_EXIT_SUCCESS	File has been checked for readiness
PXENV_EXIT_FAILURE	File has not been checked for readiness
s_PXENV_FILE_SELECT::Status	PXE status code
s_PXENV_FILE_SELECT::Ready	Indication of readiness

Definition at line 107 of file pxe_file.c.

                                                              {
        fd_set fdset;
        int ready;

        DBG ( "PXENV_FILE_SELECT %d", file_select->FileHandle );

        FD_ZERO ( &fdset );
        FD_SET ( file_select->FileHandle, &fdset );
        if ( ( ready = select ( &fdset, 0 ) ) < 0 ) {
                file_select->Status = PXENV_STATUS ( ready );
                return PXENV_EXIT_FAILURE;
        }

        file_select->Ready = ( ready ? RDY_READ : 0 );
        file_select->Status = PXENV_STATUS_SUCCESS;
        return PXENV_EXIT_SUCCESS;
}

References DBG, s_PXENV_FILE_SELECT::FileHandle, PXENV_EXIT_FAILURE, PXENV_EXIT_SUCCESS, PXENV_STATUS, PXENV_STATUS_SUCCESS, RDY_READ, s_PXENV_FILE_SELECT::Ready, select(), and s_PXENV_FILE_SELECT::Status.

pxenv_file_read()

static PXENV_EXIT_t pxenv_file_read ( struct s_PXENV_FILE_READ *  file_read )

static

FILE READ.

Parameters

file_read	Pointer to a struct s_PXENV_FILE_READ
s_PXENV_FILE_READ::FileHandle	File handle
s_PXENV_FILE_READ::BufferSize	Size of data buffer
s_PXENV_FILE_READ::Buffer	Data buffer

Return values

PXENV_EXIT_SUCCESS	Data has been read from file
PXENV_EXIT_FAILURE	Data has not been read from file
s_PXENV_FILE_READ::Status	PXE status code
s_PXENV_FILE_READ::Ready	Indication of readiness
s_PXENV_FILE_READ::BufferSize	Length of data read

Definition at line 139 of file pxe_file.c.

                                                                            {
        void *buffer;
        ssize_t len;

        DBG ( "PXENV_FILE_READ %d to %04x:%04x+%04x", file_read->FileHandle,
              file_read->Buffer.segment, file_read->Buffer.offset,
              file_read->BufferSize );

        buffer = real_to_virt ( file_read->Buffer.segment,
                                file_read->Buffer.offset );
        if ( ( len = read ( file_read->FileHandle, buffer,
                            file_read->BufferSize ) ) < 0 ) {
                file_read->Status = PXENV_STATUS ( len );
                return PXENV_EXIT_FAILURE;
        }

        DBG ( " read %04zx", ( ( size_t ) len ) );

        file_read->BufferSize = len;
        file_read->Status = PXENV_STATUS_SUCCESS;
        return PXENV_EXIT_SUCCESS;
}

References buffer, s_PXENV_FILE_READ::Buffer, s_PXENV_FILE_READ::BufferSize, DBG, s_PXENV_FILE_READ::FileHandle, len, PXENV_EXIT_FAILURE, PXENV_EXIT_SUCCESS, PXENV_STATUS, PXENV_STATUS_SUCCESS, read, real_to_virt(), and s_PXENV_FILE_READ::Status.

pxenv_get_file_size()

static PXENV_EXIT_t pxenv_get_file_size ( struct s_PXENV_GET_FILE_SIZE *  get_file_size )

static

GET FILE SIZE.

Parameters

get_file_size	Pointer to a struct s_PXENV_GET_FILE_SIZE
s_PXENV_GET_FILE_SIZE::FileHandle	File handle

Return values

PXENV_EXIT_SUCCESS	File size has been determined
PXENV_EXIT_FAILURE	File size has not been determined
s_PXENV_GET_FILE_SIZE::Status	PXE status code
s_PXENV_GET_FILE_SIZE::FileSize	Size of file

Definition at line 173 of file pxe_file.c.

                                                                    {
        ssize_t filesize;

        DBG ( "PXENV_GET_FILE_SIZE %d", get_file_size->FileHandle );

        filesize = fsize ( get_file_size->FileHandle );
        if ( filesize < 0 ) {
                get_file_size->Status = PXENV_STATUS ( filesize );
                return PXENV_EXIT_FAILURE;
        }

        DBG ( " is %zd", ( ( size_t ) filesize ) );

        get_file_size->FileSize = filesize;
        get_file_size->Status = PXENV_STATUS_SUCCESS;
        return PXENV_EXIT_SUCCESS;
}

References DBG, s_PXENV_GET_FILE_SIZE::FileHandle, s_PXENV_GET_FILE_SIZE::FileSize, fsize(), PXENV_EXIT_FAILURE, PXENV_EXIT_SUCCESS, PXENV_STATUS, PXENV_STATUS_SUCCESS, and s_PXENV_GET_FILE_SIZE::Status.

pxenv_file_exec()

static PXENV_EXIT_t pxenv_file_exec ( struct s_PXENV_FILE_EXEC *  file_exec )

static

FILE EXEC.

Parameters

file_exec	Pointer to a struct s_PXENV_FILE_EXEC
s_PXENV_FILE_EXEC::Command	Command to execute

Return values

PXENV_EXIT_SUCCESS	Command was executed successfully
PXENV_EXIT_FAILURE	Command was not executed successfully
s_PXENV_FILE_EXEC::Status	PXE status code

Definition at line 201 of file pxe_file.c.

                                                                            {
        const char *command;
        int rc;

        DBG ( "PXENV_FILE_EXEC" );

        /* Execute specified command */
        command = real_to_virt ( file_exec->Command.segment,
                                 file_exec->Command.offset );
        DBG ( " %s", command );
        if ( ( rc = system ( command ) ) != 0 ) {
                file_exec->Status = PXENV_STATUS ( rc );
                return PXENV_EXIT_FAILURE;
        }

        file_exec->Status = PXENV_STATUS_SUCCESS;
        return PXENV_EXIT_SUCCESS;
}

References command, s_PXENV_FILE_EXEC::Command, DBG, PXENV_EXIT_FAILURE, PXENV_EXIT_SUCCESS, PXENV_STATUS, PXENV_STATUS_SUCCESS, rc, real_to_virt(), s_PXENV_FILE_EXEC::Status, and system.

pxenv_file_cmdline()

static PXENV_EXIT_t pxenv_file_cmdline ( struct s_PXENV_FILE_CMDLINE *  file_cmdline )

static

FILE CMDLINE.

Parameters

file_cmdline	Pointer to a struct s_PXENV_FILE_CMDLINE
s_PXENV_FILE_CMDLINE::Buffer	Buffer to contain command line
s_PXENV_FILE_CMDLINE::BufferSize	Size of buffer

Return values

PXENV_EXIT_SUCCESS	Command was executed successfully
PXENV_EXIT_FAILURE	Command was not executed successfully
s_PXENV_FILE_EXEC::Status	PXE status code
s_PXENV_FILE_EXEC::BufferSize	Length of command line (including NUL)

Definition at line 233 of file pxe_file.c.

                                                                 {
        char *buffer;
        size_t len;

        DBG ( "PXENV_FILE_CMDLINE to %04x:%04x+%04x \"%s\"\n",
              file_cmdline->Buffer.segment, file_cmdline->Buffer.offset,
              file_cmdline->BufferSize, pxe_cmdline );

        buffer = real_to_virt ( file_cmdline->Buffer.segment,
                                file_cmdline->Buffer.offset );
        len = file_cmdline->BufferSize;
        if ( pxe_cmdline ) {
                len = snprintf ( buffer, len, "%s", pxe_cmdline );
                file_cmdline->BufferSize = ( len + 1 /* NUL */ );
        } else {
                file_cmdline->BufferSize = 0;
        }

        file_cmdline->Status = PXENV_STATUS_SUCCESS;
        return PXENV_EXIT_SUCCESS;
}

References buffer, s_PXENV_FILE_CMDLINE::Buffer, s_PXENV_FILE_CMDLINE::BufferSize, DBG, len, pxe_cmdline, PXENV_EXIT_SUCCESS, PXENV_STATUS_SUCCESS, real_to_virt(), snprintf(), and s_PXENV_FILE_CMDLINE::Status.

pxenv_file_api_check()

static PXENV_EXIT_t pxenv_file_api_check ( struct s_PXENV_FILE_API_CHECK *  file_api_check )

static

FILE API CHECK.

Parameters

file_exec	Pointer to a struct s_PXENV_FILE_API_CHECK
s_PXENV_FILE_API_CHECK::Magic	Inbound magic number (0x91d447b2)

Return values

PXENV_EXIT_SUCCESS	Command was executed successfully
PXENV_EXIT_FAILURE	Command was not executed successfully
s_PXENV_FILE_API_CHECK::Status	PXE status code
s_PXENV_FILE_API_CHECK::Magic	Outbound magic number (0xe9c17b20)
s_PXENV_FILE_API_CHECK::Provider	"iPXE" (0x45585067)
s_PXENV_FILE_API_CHECK::APIMask	API function bitmask
s_PXENV_FILE_API_CHECK::Flags	Reserved

Definition at line 270 of file pxe_file.c.

                                                                       {
        struct pxe_api_call *call;
        unsigned int mask = 0;
        unsigned int offset;

        DBG ( "PXENV_FILE_API_CHECK" );

        /* Check for magic value */
        if ( file_api_check->Magic != 0x91d447b2 ) {
                file_api_check->Status = PXENV_STATUS_BAD_FUNC;
                return PXENV_EXIT_FAILURE;
        }

        /* Check for required parameter size */
        if ( file_api_check->Size < sizeof ( *file_api_check ) ) {
                file_api_check->Status = PXENV_STATUS_OUT_OF_RESOURCES;
                return PXENV_EXIT_FAILURE;
        }

        /* Determine supported calls */
        for_each_table_entry ( call, PXE_API_CALLS ) {
                offset = ( call->opcode - PXENV_FILE_MIN );
                if ( offset <= ( PXENV_FILE_MAX - PXENV_FILE_MIN ) )
                        mask |= ( 1 << offset );
        }

        /* Fill in parameters */
        file_api_check->Size = sizeof ( *file_api_check );
        file_api_check->Magic = 0xe9c17b20;
        file_api_check->Provider = 0x45585067; /* "iPXE" */
        file_api_check->APIMask = mask;
        file_api_check->Flags = 0; /* None defined */

        file_api_check->Status = PXENV_STATUS_SUCCESS;
        return PXENV_EXIT_SUCCESS;
}

References s_PXENV_FILE_API_CHECK::APIMask, DBG, s_PXENV_FILE_API_CHECK::Flags, for_each_table_entry, s_PXENV_FILE_API_CHECK::Magic, offset, pxe_api_call::opcode, s_PXENV_FILE_API_CHECK::Provider, PXE_API_CALLS, PXENV_EXIT_FAILURE, PXENV_EXIT_SUCCESS, PXENV_FILE_MAX, PXENV_FILE_MIN, PXENV_STATUS_BAD_FUNC, PXENV_STATUS_OUT_OF_RESOURCES, PXENV_STATUS_SUCCESS, s_PXENV_FILE_API_CHECK::Size, and s_PXENV_FILE_API_CHECK::Status.

Variable Documentation

__pxe_api_call

struct pxe_api_call pxe_file_api [] __pxe_api_call

Initial value:

= {
        PXE_API_CALL ( PXENV_FILE_OPEN, pxenv_file_open,
                       struct s_PXENV_FILE_OPEN ),
        PXE_API_CALL ( PXENV_FILE_CLOSE, pxenv_file_close,
                       struct s_PXENV_FILE_CLOSE ),
        PXE_API_CALL ( PXENV_FILE_SELECT, pxenv_file_select,
                       struct s_PXENV_FILE_SELECT ),
        PXE_API_CALL ( PXENV_FILE_READ, pxenv_file_read,
                       struct s_PXENV_FILE_READ ),
        PXE_API_CALL ( PXENV_GET_FILE_SIZE, pxenv_get_file_size,
                       struct s_PXENV_GET_FILE_SIZE ),
        PXE_API_CALL ( PXENV_FILE_EXEC, pxenv_file_exec,
                       struct s_PXENV_FILE_EXEC ),
        PXE_API_CALL ( PXENV_FILE_CMDLINE, pxenv_file_cmdline,
                       struct s_PXENV_FILE_CMDLINE ),
        PXE_API_CALL ( PXENV_FILE_API_CHECK, pxenv_file_api_check,
                       struct s_PXENV_FILE_API_CHECK ),
}

PXE file API.

Definition at line 308 of file pxe_file.c.