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)
int	imgdownload (struct uri *uri, unsigned long timeout, struct image **image)
	Download a new image. More...
int	imgdownload_string (const char *uri_string, unsigned long timeout, struct image **image)
	Download a new image. More...
int	imgacquire (const char *name, unsigned long timeout, struct image **image)
	Acquire an image. More...
void	imgstat (struct image *image)
	Display status of an image. More...
int	imgmem (const char *name, userptr_t data, size_t len)
	Create image from block of memory. More...

Detailed Description

Image management.

Definition in file imgmgmt.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

imgdownload()

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

Download a new image.

Parameters

uri	URI
timeout	Download timeout
image	Image to fill in

Return values

rc	Return status code

Definition at line 51 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
	)

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 119 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
	)

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 141 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(), imgextract_exec(), and imgverify_exec().

imgstat()

void imgstat

(

struct image *

image

)

Display status of an image.

Parameters

image

Executable/loadable image

Definition at line 158 of file imgmgmt.c.

                                     {
        printf ( "%s : %zd bytes", image->name, image->len );
        if ( image->type )
                printf ( " [%s]", image->type->name );
        if ( image->flags & IMAGE_TRUSTED )
                printf ( " [TRUSTED]" );
        if ( image->flags & IMAGE_SELECTED )
                printf ( " [SELECTED]" );
        if ( image->flags & IMAGE_AUTO_UNREGISTER )
                printf ( " [AUTOFREE]" );
        if ( image->cmdline )
                printf ( " \"%s\"", image->cmdline );
        printf ( "\n" );
}

References image::cmdline, image::flags, IMAGE_AUTO_UNREGISTER, IMAGE_SELECTED, IMAGE_TRUSTED, image::len, image::name, image_type::name, printf(), and image::type.

Referenced by imgstat_exec(), and uriboot().

imgmem()

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

Create image from block of memory.

Parameters

name	Name
data	Image data
len	Length

Return values

rc	Return status code

Definition at line 181 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 imgmem_exec().