imgmgmt.h File Reference

Image management. More...

#include <ipxe/image.h>

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
int	imgdownload (struct uri *uri, unsigned long timeout, struct image **image)
	Download a new image.
int	imgdownload_string (const char *uri_string, unsigned long timeout, struct image **image)
	Download a new image.
int	imgacquire (const char *name, unsigned long timeout, struct image **image)
	Acquire an image.
void	imgstat (struct image *image)
	Display status of an image.
int	imgmem (const char *name, const void *data, size_t len)
	Create image from block of memory.

Detailed Description

Image management.

Definition in file imgmgmt.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

References data, len, name, and timeout().

imgdownload()

int imgdownload ( struct uri * uri, unsigned long timeout, struct image ** image )

extern

Download a new image.

Parameters

uri	URI
timeout	Download timeout
image	Image to fill in

Return values

rc	Return status code

Definition at line 53 of file imgmgmt.c.

                                         {
        struct uri uri_redacted;
        char *uri_string_redacted;
        int rc;
 
        /* Construct redacted URI */
        memcpy ( &uri_redacted, uri, sizeof ( uri_redacted ) );
        uri_redacted.user = NULL;
        uri_redacted.password = NULL;
        uri_redacted.equery = NULL;
        uri_redacted.efragment = NULL;
        uri_string_redacted = format_uri_alloc ( &uri_redacted );
        if ( ! uri_string_redacted ) {
                rc = -ENOMEM;
                goto err_uri_string;
        }
 
        /* Resolve URI */
        uri = resolve_uri ( cwuri, uri );
        if ( ! uri ) {
                rc = -ENOMEM;
                goto err_resolve_uri;
        }
 
        /* Allocate image */
        *image = alloc_image ( uri );
        if ( ! *image ) {
                rc = -ENOMEM;
                goto err_alloc_image;
        }
 
        /* Create downloader */
        if ( ( rc = create_downloader ( &monojob, *image ) ) != 0 ) {
                printf ( "Could not start download: %s\n", strerror ( rc ) );
                goto err_create_downloader;
        }
 
        /* Wait for download to complete */
        if ( ( rc = monojob_wait ( uri_string_redacted, timeout ) ) != 0 )
                goto err_monojob_wait;
 
        /* Register image */
        if ( ( rc = register_image ( *image ) ) != 0 ) {
                printf ( "Could not register image: %s\n", strerror ( rc ) );
                goto err_register_image;
        }
 
 err_register_image:
 err_monojob_wait:
 err_create_downloader:
        image_put ( *image );
 err_alloc_image:
        uri_put ( uri );
 err_resolve_uri:
        free ( uri_string_redacted );
 err_uri_string:
        return rc;
}

References alloc_image(), create_downloader(), cwuri, uri::efragment, ENOMEM, uri::equery, format_uri_alloc(), free, image_put(), memcpy(), monojob, monojob_wait(), NULL, uri::password, printf(), rc, register_image(), resolve_uri(), strerror(), timeout(), uri_put(), and uri::user.

Referenced by imgdownload_string(), and uriboot().

imgdownload_string()

int imgdownload_string ( const char * uri_string, unsigned long timeout, struct image ** image )

extern

Download a new image.

Parameters

uri_string	URI string
timeout	Download timeout
image	Image to fill in

Return values

rc	Return status code

Definition at line 121 of file imgmgmt.c.

                                                {
        struct uri *uri;
        int rc;
 
        if ( ! ( uri = parse_uri ( uri_string ) ) )
                return -ENOMEM;
 
        rc = imgdownload ( uri, timeout, image );
 
        uri_put ( uri );
        return rc;
}

References ENOMEM, imgdownload(), parse_uri(), rc, timeout(), and uri_put().

Referenced by comboot_fetch_kernel(), and imgacquire().

imgacquire()

int imgacquire ( const char * name_uri, unsigned long timeout, struct image ** image )

extern

Acquire an image.

Parameters

name_uri	Name or URI string
timeout	Download timeout
image	Image to fill in

Return values

rc	Return status code

Definition at line 143 of file imgmgmt.c.

                                        {
 
        /* If we already have an image with the specified name, use it */
        *image = find_image ( name_uri );
        if ( *image )
                return 0;
 
        /* Otherwise, download a new image */
        return imgdownload_string ( name_uri, timeout, image );
}

References find_image(), imgdownload_string(), and timeout().

Referenced by cert_exec(), console_exec(), digest_exec(), efi_autoexec_filesystem(), efi_autoexec_network(), fdt_exec(), imgdecrypt_exec(), imgextract_exec(), imgverify_exec(), and shim_exec().

imgstat()

void imgstat ( struct image * image )

extern

Display status of an image.

Parameters

image

Executable/loadable image

Definition at line 160 of file imgmgmt.c.

                                     {
        struct image_tag *tag;
 
        printf ( "%s : %zd bytes", image->name, image->len );
        if ( image->type )
                printf ( " [%s]", image->type->name );
        for_each_table_entry ( tag, IMAGE_TAGS ) {
                if ( tag->image == image )
                        printf ( " [%s]", tag->name );
        }
        if ( image->flags & IMAGE_TRUSTED )
                printf ( " [TRUSTED]" );
        if ( image->flags & IMAGE_AUTO_UNREGISTER )
                printf ( " [AUTOFREE]" );
        if ( image->flags & IMAGE_HIDDEN )
                printf ( " [HIDDEN]" );
        if ( image->cmdline )
                printf ( " \"%s\"", image->cmdline );
        printf ( "\n" );
}

References image::cmdline, image::flags, for_each_table_entry, IMAGE_AUTO_UNREGISTER, IMAGE_HIDDEN, IMAGE_TAGS, IMAGE_TRUSTED, image::len, image::name, image_type::name, printf(), tag, and image::type.

Referenced by COMMAND(), imgstat_exec(), and uriboot().

imgmem()

int imgmem ( const char * name, const void * data, size_t len )

extern

Create image from block of memory.

Parameters

name	Name
data	Image data
len	Length

Return values

rc	Return status code

Definition at line 189 of file imgmgmt.c.

                                                              {
        struct image *image;
 
        /* Create image */
        image = image_memory ( name, data, len );
        if ( ! image ) {
                printf ( "Could not create image\n" );
                return -ENOMEM;
        }
 
        return 0;
}

References data, ENOMEM, image_memory(), len, name, and printf().

Referenced by COMMAND(), and imgmem_exec().