imgmgmt.c File Reference

Image management. More...

#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <errno.h>
#include <gpxe/image.h>
#include <gpxe/downloader.h>
#include <gpxe/monojob.h>
#include <gpxe/open.h>
#include <gpxe/uri.h>
#include <usr/imgmgmt.h>

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER)
int	imgfetch (struct image *image, const char *uri_string, int(*image_register)(struct image *image))
	Fetch an image.
int	imgload (struct image *image)
	Load an image.
int	imgexec (struct image *image)
	Execute an image.
struct image *	imgautoselect (void)
	Identify the only loaded image.
void	imgstat (struct image *image)
	Display status of an image.
void	imgfree (struct image *image)
	Free an image.

---

Detailed Description

Image management.

Definition in file imgmgmt.c.

---

Function Documentation

FILE_LICENCE

(

GPL2_OR_LATER

)

int imgfetch	(	struct image *	image,
		const char *	uri_string,
		int(*)(struct image *image)	image_register
	)

Fetch an image.

Parameters:

	uri_string	URI as a string (e.g. "http://www.nowhere.com/vmlinuz")
	name	Name for image, or NULL
	register_image	Image registration routine

Return values:

rc

Return status code

Definition at line 46 of file imgmgmt.c.

References create_downloader(), ENOMEM, image_set_uri(), LOCATION_URI, monojob, monojob_wait(), parse_uri(), uri::password, strlen(), unparse_uri(), and URI_ALL.

Referenced by boot_next_server_and_filename(), comboot_fetch_kernel(), and imgfetch_core_exec().

                                                                  {
        char uri_string_redacted[ strlen ( uri_string ) + 3 /* "***" */
                                  + 1 /* NUL */ ];
        struct uri *uri;
        const char *password;
        int rc;

        if ( ! ( uri = parse_uri ( uri_string ) ) )
                return -ENOMEM;

        image_set_uri ( image, uri );

        /* Redact password portion of URI, if necessary */
        password = uri->password;
        if ( password )
                uri->password = "***";
        unparse_uri ( uri_string_redacted, sizeof ( uri_string_redacted ),
                      uri, URI_ALL );
        uri->password = password;

        if ( ( rc = create_downloader ( &monojob, image, image_register,
                                        LOCATION_URI, uri ) ) == 0 )
                rc = monojob_wait ( uri_string_redacted );

        uri_put ( uri );
        return rc;
}

int imgload

(

struct image *

image

)

Load an image.

Parameters:

image

Image

Return values:

rc

Return status code

Definition at line 81 of file imgmgmt.c.

References image_autoload().

Referenced by imgload_exec().

                                    {
        int rc;

        /* Try to load image */
        if ( ( rc = image_autoload ( image ) ) != 0 )
                return rc;

        return 0;
}

int imgexec

(

struct image *

image

)

Execute an image.

Parameters:

image

Image

Return values:

rc

Return status code

Definition at line 97 of file imgmgmt.c.

References image_exec().

Referenced by boot_next_server_and_filename(), and imgexec_exec().

                                    {
        return image_exec ( image );
}

struct image* imgautoselect

(

void

)

[read]

Identify the only loaded image.

Return values:

image

Image, or NULL if 0 or >1 images are loaded

Definition at line 106 of file imgmgmt.c.

References image::flags, for_each_image, IMAGE_LOADED, and NULL.

Referenced by imgexec_exec().

                                      {
        struct image *image;
        struct image *selected_image = NULL;
        int flagged_images = 0;

        for_each_image ( image ) {
                if ( image->flags & IMAGE_LOADED ) {
                        selected_image = image;
                        flagged_images++;
                }
        }

        return ( ( flagged_images == 1 ) ? selected_image : NULL );
}

void imgstat

(

struct image *

image

)

Display status of an image.

Parameters:

image

Executable/loadable image

Definition at line 126 of file imgmgmt.c.

References image::cmdline, image::flags, IMAGE_LOADED, image::len, image_type::name, image::name, printf(), and image::type.

Referenced by imgstat_exec().

                                     {
        printf ( "%s: %zd bytes", image->name, image->len );
        if ( image->type )
                printf ( " [%s]", image->type->name );
        if ( image->flags & IMAGE_LOADED )
                printf ( " [LOADED]" );
        if ( image->cmdline )
                printf ( " \"%s\"", image->cmdline );
        printf ( "\n" );
}

void imgfree

(

struct image *

image

)

Free an image.

Parameters:

image

Executable/loadable image

Definition at line 142 of file imgmgmt.c.

References unregister_image().

Referenced by imgfree_exec().

                                     {
        unregister_image ( image );
}