efi_autoexec.c File Reference

EFI autoexec script. More...

#include <string.h>
#include <errno.h>
#include <ipxe/timer.h>
#include <ipxe/image.h>
#include <ipxe/netdevice.h>
#include <ipxe/uri.h>
#include <ipxe/efi/efi.h>
#include <ipxe/efi/efi_utils.h>
#include <ipxe/efi/efi_autoexec.h>
#include <ipxe/efi/mnpnet.h>
#include <usr/imgmgmt.h>
#include <usr/sync.h>

Go to the source code of this file.

Data Structures
struct	efi_autoexec_loader
	An EFI autoexec script loader. More...

Macros
#define	EFI_AUTOEXEC_TIMEOUT   ( 30 * TICKS_PER_SEC )
	Timeout for autoexec script downloads.
#define	EFI_AUTOEXEC_SYNC_TIMEOUT   ( 1 * TICKS_PER_SEC )
	Timeout for autoexec pending operation completion.
#define	EFI_AUTOEXEC_NAME   "autoexec.ipxe"
	Autoexec script image name.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static int	efi_autoexec_filesystem (EFI_HANDLE handle, struct image **image)
	Load autoexec script from filesystem.
static int	efi_autoexec_network (EFI_HANDLE handle, struct image **image)
	Load autoexec script via temporary network device.
int	efi_autoexec_load (void)
	Load autoexec script.

Variables
static struct efi_autoexec_loader	efi_autoexec_loaders []
	Autoexec script loaders.

Detailed Description

EFI autoexec script.

Definition in file efi_autoexec.c.

Macro Definition Documentation

EFI_AUTOEXEC_TIMEOUT

#define EFI_AUTOEXEC_TIMEOUT   ( 30 * TICKS_PER_SEC )

Timeout for autoexec script downloads.

Definition at line 47 of file efi_autoexec.c.

Referenced by efi_autoexec_filesystem(), and efi_autoexec_network().

EFI_AUTOEXEC_SYNC_TIMEOUT

#define EFI_AUTOEXEC_SYNC_TIMEOUT   ( 1 * TICKS_PER_SEC )

Timeout for autoexec pending operation completion.

Definition at line 50 of file efi_autoexec.c.

Referenced by efi_autoexec_network().

EFI_AUTOEXEC_NAME

#define EFI_AUTOEXEC_NAME   "autoexec.ipxe"

Autoexec script image name.

Definition at line 53 of file efi_autoexec.c.

Referenced by efi_autoexec_filesystem(), and efi_autoexec_network().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

efi_autoexec_filesystem()

int efi_autoexec_filesystem ( EFI_HANDLE handle, struct image ** image )

static

Load autoexec script from filesystem.

Parameters

handle	Simple filesystem protocol handle
image	Image to fill in

Return values

rc	Return status code

Definition at line 76 of file efi_autoexec.c.

                                                                               {
        EFI_HANDLE device = efi_loaded_image->DeviceHandle;
        int rc;
 
        /* Check that we were loaded from a filesystem */
        if ( handle != device ) {
                DBGC ( device, "EFI %s is not the file system handle\n",
                       efi_handle_name ( device ) );
                return -ENOTTY;
        }
 
        /* Try loading from loaded image directory, if supported */
        if ( ( rc = imgacquire ( "file:" EFI_AUTOEXEC_NAME,
                                 EFI_AUTOEXEC_TIMEOUT, image ) ) == 0 )
                return 0;
 
        /* Try loading from root directory, if supported */
        if ( ( rc = imgacquire ( "file:/" EFI_AUTOEXEC_NAME,
                                 EFI_AUTOEXEC_TIMEOUT, image ) ) == 0 )
                return 0;
 
        return rc;
}

References DBGC, EFI_AUTOEXEC_NAME, EFI_AUTOEXEC_TIMEOUT, EFI_HANDLE, efi_handle_name(), efi_loaded_image, ENOTTY, handle, imgacquire(), and rc.

efi_autoexec_network()

int efi_autoexec_network ( EFI_HANDLE handle, struct image ** image )

static

Load autoexec script via temporary network device.

Parameters

handle	Managed network protocol service binding handle
image	Image to fill in

Return values

rc	Return status code

Definition at line 107 of file efi_autoexec.c.

                                                                            {
        EFI_HANDLE device = efi_loaded_image->DeviceHandle;
        struct net_device *netdev;
        int rc;
 
        /* Create temporary network device */
        if ( ( rc = mnptemp_create ( handle, &netdev ) ) != 0 ) {
                DBGC ( device, "EFI %s could not create net device: %s\n",
                       efi_handle_name ( device ), strerror ( rc ) );
                goto err_create;
        }
 
        /* Do nothing unless we have a usable current working URI */
        if ( ! cwuri ) {
                DBGC ( device, "EFI %s has no current working URI\n",
                       efi_handle_name ( device ) );
                rc = -ENOTTY;
                goto err_cwuri;
        }
 
        /* Open network device */
        if ( ( rc = netdev_open ( netdev ) ) != 0 ) {
                DBGC ( device, "EFI %s could not open net device: %s\n",
                       efi_handle_name ( device ), strerror ( rc ) );
                goto err_open;
        }
 
        /* Attempt download from current working URI, then from root */
        if ( ( rc = imgacquire ( EFI_AUTOEXEC_NAME, EFI_AUTOEXEC_TIMEOUT,
                                 image ) != 0 ) &&
             ( rc = imgacquire ( "/" EFI_AUTOEXEC_NAME, EFI_AUTOEXEC_TIMEOUT,
                                 image ) != 0 ) ) {
                DBGC ( device, "EFI %s could not download [/]%s: %s\n",
                       efi_handle_name ( device ), EFI_AUTOEXEC_NAME,
                       strerror ( rc ) );
                goto err_acquire;
        }
 
 err_acquire:
        /* Ensure network exchanges have completed */
        sync ( EFI_AUTOEXEC_SYNC_TIMEOUT );
 err_open:
 err_cwuri:
        mnptemp_destroy ( netdev );
 err_create:
        return rc;
}

References cwuri, DBGC, EFI_AUTOEXEC_NAME, EFI_AUTOEXEC_SYNC_TIMEOUT, EFI_AUTOEXEC_TIMEOUT, EFI_HANDLE, efi_handle_name(), efi_loaded_image, ENOTTY, handle, imgacquire(), mnptemp_create(), mnptemp_destroy(), netdev, netdev_open(), rc, strerror(), and sync().

efi_autoexec_load()

int efi_autoexec_load

(

void

)

Load autoexec script.

Return values

rc	Return status code

Definition at line 172 of file efi_autoexec.c.

                               {
        EFI_HANDLE device = efi_loaded_image->DeviceHandle;
        EFI_HANDLE handle;
        struct efi_autoexec_loader *loader;
        struct image *image;
        unsigned int i;
        int rc;
 
        /* Use first applicable loader */
        for ( i = 0 ; i < ( sizeof ( efi_autoexec_loaders ) /
                            sizeof ( efi_autoexec_loaders[0] ) ) ; i ++ ) {
 
                /* Locate required protocol for this loader */
                loader = &efi_autoexec_loaders[i];
                if ( ( rc = efi_locate_device ( device, loader->protocol,
                                                &handle, 0 ) ) != 0 ) {
                        DBGC ( device, "EFI %s found no %s: %s\n",
                               efi_handle_name ( device ),
                               efi_guid_ntoa ( loader->protocol ),
                               strerror ( rc ) );
                        continue;
                }
                DBGC ( device, "EFI %s found %s on ",
                       efi_handle_name ( device ),
                       efi_guid_ntoa ( loader->protocol ) );
                DBGC ( device, "%s\n", efi_handle_name ( handle ) );
 
                /* Try loading */
                if ( ( rc = loader->load ( handle, &image ) ) != 0 )
                        continue;
 
                /* Discard zero-length images */
                if ( ! image->len ) {
                        DBGC ( device, "EFI %s discarding zero-length %s\n",
                               efi_handle_name ( device ), image->name );
                        unregister_image ( image );
                        return -ENOENT;
                }
 
                DBGC ( device, "EFI %s loaded %s (%zd bytes)\n",
                       efi_handle_name ( device ), image->name, image->len );
                return 0;
        }
 
        return -ENOENT;
}

References DBGC, efi_autoexec_loaders, efi_guid_ntoa(), EFI_HANDLE, efi_handle_name(), efi_loaded_image, efi_locate_device(), ENOENT, handle, image::len, efi_autoexec_loader::load, image::name, efi_autoexec_loader::protocol, rc, strerror(), and unregister_image().

Referenced by efi_probe().

Variable Documentation

efi_autoexec_loaders

struct efi_autoexec_loader efi_autoexec_loaders[]

static

Initial value:

= {
        {
                .protocol = &efi_simple_file_system_protocol_guid,
                .load = efi_autoexec_filesystem,
        },
        {
                .protocol = &efi_managed_network_service_binding_protocol_guid,
                .load = efi_autoexec_network,
        },
}

Autoexec script loaders.

Definition at line 156 of file efi_autoexec.c.

                                                           {
        {
                .protocol = &efi_simple_file_system_protocol_guid,
                .load = efi_autoexec_filesystem,
        },
        {
                .protocol = &efi_managed_network_service_binding_protocol_guid,
                .load = efi_autoexec_network,
        },
};

Referenced by efi_autoexec_load().