image_cmd.c File Reference

Image management commands. More...

#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <errno.h>
#include <libgen.h>
#include <getopt.h>
#include <gpxe/image.h>
#include <gpxe/command.h>
#include <usr/imgmgmt.h>

Go to the source code of this file.

Enumerations
enum	image_action { IMG_FETCH = 0, IMG_LOAD, IMG_EXEC }
Functions
	FILE_LICENCE (GPL2_OR_LATER)
static int	imgfill_cmdline (struct image *image, unsigned int nargs, char **args)
	Fill in image command line.
static void	imgfetch_core_syntax (char **argv, enum image_action action)
	"imgfetch"/"module"/"kernel" command syntax message
static int	imgfetch_core_exec (struct image_type *image_type, enum image_action action, int argc, char **argv)
	The "imgfetch"/"module"/"kernel" command body.
static int	imgfetch_exec (int argc, char **argv)
	The "imgfetch"/"module" command.
static int	kernel_exec (int argc, char **argv)
	The "kernel" command.
static int	chain_exec (int argc, char **argv)
	The "chain" command.
static void	imgload_syntax (char **argv)
	"imgload" command syntax message
static int	imgload_exec (int argc, char **argv)
	The "imgload" command.
static void	imgargs_syntax (char **argv)
	"imgargs" command syntax message
static int	imgargs_exec (int argc, char **argv)
	The "imgargs" command body.
static void	imgexec_syntax (char **argv)
	"imgexec" command syntax message
static int	imgexec_exec (int argc, char **argv)
	The "imgexec" command.
static void	imgstat_syntax (char **argv)
	"imgstat" command syntax message
static int	imgstat_exec (int argc, char **argv)
	The "imgstat" command.
static void	imgfree_syntax (char **argv)
	"imgstat" command syntax message
static int	imgfree_exec (int argc, char **argv)
	The "imgfree" command.
Variables
struct command image_commands[]	__command
	Image management commands.

---

Detailed Description

Image management commands.

Definition in file image_cmd.c.

---

Enumeration Type Documentation

enum image_action

Enumerator:

IMG_FETCH
IMG_LOAD
IMG_EXEC

Definition at line 37 of file image_cmd.c.

                  {
        IMG_FETCH = 0,
        IMG_LOAD,
        IMG_EXEC,
};

---

Function Documentation

FILE_LICENCE

(

GPL2_OR_LATER

)

static int imgfill_cmdline	(	struct image *	image,
		unsigned int	nargs,
		char **	args
	)			[static]

Fill in image command line.

Parameters:

	image	Image
	nargs	Argument count
	args	Argument list

Return values:

rc

Return status code

Definition at line 51 of file image_cmd.c.

References assert, image_set_cmdline(), sprintf, and strlen().

Referenced by imgargs_exec(), and imgfetch_core_exec().

                                           {
        size_t len;
        unsigned int i;

        /* Determine total length of command line */
        len = 1; /* NUL */
        for ( i = 0 ; i < nargs ; i++ )
                len += ( 1 /* possible space */ + strlen ( args[i] ) );

        {
                char buf[len];
                char *ptr = buf;

                /* Assemble command line */
                buf[0] = '\0';
                for ( i = 0 ; i < nargs ; i++ ) {
                        ptr += sprintf ( ptr, "%s%s", ( i ? " " : "" ),
                                         args[i] );
                }
                assert ( ptr < ( buf + len ) );

                return image_set_cmdline ( image, buf );
        }
}

static void imgfetch_core_syntax	(	char **	argv,
		enum image_action	action
	)			[static]

"imgfetch"/"module"/"kernel" command syntax message

Parameters:

argv

Argument list

Definition at line 82 of file image_cmd.c.

References IMG_EXEC, IMG_FETCH, IMG_LOAD, and printf().

Referenced by imgfetch_core_exec().

                                                                           {
        static const char *actions[] = {
                [IMG_FETCH]     = "Fetch",
                [IMG_LOAD]      = "Fetch and load",
                [IMG_EXEC]      = "Fetch and execute",
        };

        printf ( "Usage:\n"
                 "  %s [-n|--name <name>] filename [arguments...]\n"
                 "\n"
                 "%s executable/loadable image\n",
                 argv[0], actions[action] );
}

static int imgfetch_core_exec	(	struct image_type *	image_type,
		enum image_action	action,
		int	argc,
		char **	argv
	)			[static]

The "imgfetch"/"module"/"kernel" command body.

Parameters:

	image_type	Image type to assign (or NULL)
	load	Image will be automatically loaded after fetching
	argc	Argument count
	argv	Argument list

Return values:

rc

Return status code

Definition at line 105 of file image_cmd.c.

References alloc_image(), assert, basename(), EINVAL, ENOMEM, getopt_long(), image_put(), image_set_name(), IMG_EXEC, IMG_FETCH, IMG_LOAD, imgfetch(), imgfetch_core_syntax(), imgfill_cmdline(), name, NULL, optarg, optind, printf(), register_and_autoexec_image(), register_and_autoload_image(), register_image(), required_argument, strerror(), and image::type.

Referenced by chain_exec(), imgfetch_exec(), and kernel_exec().

                                                        {
        static struct option longopts[] = {
                { "help", 0, NULL, 'h' },
                { "name", required_argument, NULL, 'n' },
                { NULL, 0, NULL, 0 },
        };
        struct image *image;
        const char *name = NULL;
        char *filename;
        int ( * image_register ) ( struct image *image );
        int c;
        int rc;

        /* Parse options */
        while ( ( c = getopt_long ( argc, argv, "hn:",
                                    longopts, NULL ) ) >= 0 ) {
                switch ( c ) {
                case 'n':
                        /* Set image name */
                        name = optarg;
                        break;
                case 'h':
                        /* Display help text */
                default:
                        /* Unrecognised/invalid option */
                        imgfetch_core_syntax ( argv, action );
                        return -EINVAL;
                }
        }

        /* Need at least a filename remaining after the options */
        if ( optind == argc ) {
                imgfetch_core_syntax ( argv, action );
                return -EINVAL;
        }
        filename = argv[optind++];
        if ( ! name )
                name = basename ( filename );

        /* Allocate image */
        image = alloc_image();
        if ( ! image ) {
                printf ( "%s\n", strerror ( -ENOMEM ) );
                return -ENOMEM;
        }

        /* Fill in image name */
        if ( name ) {
                if ( ( rc = image_set_name ( image, name ) ) != 0 )
                        return rc;
        }

        /* Set image type (if specified) */
        image->type = image_type;

        /* Fill in command line */
        if ( ( rc = imgfill_cmdline ( image, ( argc - optind ),
                                      &argv[optind] ) ) != 0 )
                return rc;

        /* Fetch the image */
        switch ( action ) {
        case IMG_FETCH:
                image_register = register_image;
                break;
        case IMG_LOAD:
                image_register = register_and_autoload_image;
                break;
        case IMG_EXEC:
                image_register = register_and_autoexec_image;
                break;
        default:
                assert ( 0 );
                return -EINVAL;
        }
        if ( ( rc = imgfetch ( image, filename, image_register ) ) != 0 ) {
                printf ( "Could not fetch %s: %s\n",
                         filename, strerror ( rc ) );
                image_put ( image );
                return rc;
        }

        image_put ( image );
        return 0;
}

static int imgfetch_exec	(	int	argc,
		char **	argv
	)			[static]

The "imgfetch"/"module" command.

Parameters:

	argc	Argument count
	argv	Argument list

Return values:

rc

Exit code

Definition at line 200 of file image_cmd.c.

References IMG_FETCH, imgfetch_core_exec(), and NULL.

                                                   {
        int rc;

        if ( ( rc = imgfetch_core_exec ( NULL, IMG_FETCH,
                                         argc, argv ) ) != 0 )
                return rc;

        return 0;
}

static int kernel_exec	(	int	argc,
		char **	argv
	)			[static]

The "kernel" command.

Parameters:

	argc	Argument count
	argv	Argument list

Return values:

rc

Exit code

Definition at line 217 of file image_cmd.c.

References IMG_LOAD, imgfetch_core_exec(), and NULL.

                                                 {
        int rc;

        if ( ( rc = imgfetch_core_exec ( NULL, IMG_LOAD, argc, argv ) ) != 0 )
                return rc;

        return 0;
}

static int chain_exec	(	int	argc,
		char **	argv
	)			[static]

The "chain" command.

Parameters:

	argc	Argument count
	argv	Argument list

Return values:

rc

Exit code

Definition at line 233 of file image_cmd.c.

References IMG_EXEC, imgfetch_core_exec(), and NULL.

                                               {
        int rc;

        if ( ( rc = imgfetch_core_exec ( NULL, IMG_EXEC, argc, argv ) ) != 0 )
                return rc;

        return 0;
}

static void imgload_syntax

(

char **

argv

)

[static]

"imgload" command syntax message

Parameters:

argv

Argument list

Definition at line 247 of file image_cmd.c.

References printf().

Referenced by imgload_exec().

                                           {
        printf ( "Usage:\n"
                 "  %s <image name>\n"
                 "\n"
                 "Load executable/loadable image\n",
                 argv[0] );
}

static int imgload_exec	(	int	argc,
		char **	argv
	)			[static]

The "imgload" command.

Parameters:

	argc	Argument count
	argv	Argument list

Return values:

rc

Exit code

Definition at line 262 of file image_cmd.c.

References find_image(), getopt_long(), imgload(), imgload_syntax(), name, NULL, optind, printf(), and strerror().

                                                  {
        static struct option longopts[] = {
                { "help", 0, NULL, 'h' },
                { NULL, 0, NULL, 0 },
        };
        struct image *image;
        const char *name;
        int c;
        int rc;

        /* Parse options */
        while ( ( c = getopt_long ( argc, argv, "h", longopts, NULL ) ) >= 0 ){
                switch ( c ) {
                case 'h':
                        /* Display help text */
                default:
                        /* Unrecognised/invalid option */
                        imgload_syntax ( argv );
                        return 1;
                }
        }

        /* Need exactly one image name remaining after the options */
        if ( optind != ( argc - 1 ) ) {
                imgload_syntax ( argv );
                return 1;
        }
        name = argv[optind];

        /* Load all specified images */
        image = find_image ( name );
        if ( ! image ) {
                printf ( "No such image: %s\n", name );
                return 1;
        }
        if ( ( rc = imgload ( image ) ) != 0 ) {
                printf ( "Could not load %s: %s\n", name, strerror ( rc ) );
                return rc;
        }

        return 0;
}

static void imgargs_syntax

(

char **

argv

)

[static]

"imgargs" command syntax message

Parameters:

argv

Argument list

Definition at line 310 of file image_cmd.c.

References printf().

Referenced by imgargs_exec().

                                           {
        printf ( "Usage:\n"
                 "  %s <image name> [<arguments>...]\n"
                 "\n"
                 "Set arguments for executable/loadable image\n",
                 argv[0] );
}

static int imgargs_exec	(	int	argc,
		char **	argv
	)			[static]

The "imgargs" command body.

Parameters:

	argc	Argument count
	argv	Argument list

Return values:

rc

Exit code

Definition at line 325 of file image_cmd.c.

References find_image(), getopt_long(), imgargs_syntax(), imgfill_cmdline(), name, NULL, optind, and printf().

                                                  {
        static struct option longopts[] = {
                { "help", 0, NULL, 'h' },
                { NULL, 0, NULL, 0 },
        };
        struct image *image;
        const char *name;
        int c;
        int rc;

        /* Parse options */
        while ( ( c = getopt_long ( argc, argv, "h", longopts, NULL ) ) >= 0 ){
                switch ( c ) {
                case 'h':
                        /* Display help text */
                default:
                        /* Unrecognised/invalid option */
                        imgargs_syntax ( argv );
                        return 1;
                }
        }

        /* Need at least an image name remaining after the options */
        if ( optind == argc ) {
                imgargs_syntax ( argv );
                return 1;
        }
        name = argv[optind++];

        /* Fill in command line */
        image = find_image ( name );
        if ( ! image ) {
                printf ( "No such image: %s\n", name );
                return 1;
        }
        if ( ( rc = imgfill_cmdline ( image, ( argc - optind ),
                                      &argv[optind] ) ) != 0 )
                return rc;


        return 0;
}

static void imgexec_syntax

(

char **

argv

)

[static]

"imgexec" command syntax message

Parameters:

argv

Argument list

Definition at line 373 of file image_cmd.c.

References printf().

Referenced by imgexec_exec().

                                           {
        printf ( "Usage:\n"
                 "  %s <image name>\n"
                 "\n"
                 "Execute executable/loadable image\n",
                 argv[0] );
}

static int imgexec_exec	(	int	argc,
		char **	argv
	)			[static]

The "imgexec" command.

Parameters:

	argc	Argument count
	argv	Argument list

Return values:

rc

Exit code

Definition at line 388 of file image_cmd.c.

References find_image(), getopt_long(), imgautoselect(), imgexec(), imgexec_syntax(), image::name, name, NULL, optind, printf(), and strerror().

                                                  {
        static struct option longopts[] = {
                { "help", 0, NULL, 'h' },
                { NULL, 0, NULL, 0 },
        };
        struct image *image;
        const char *name = NULL;
        int c;
        int rc;

        /* Parse options */
        while ( ( c = getopt_long ( argc, argv, "h", longopts, NULL ) ) >= 0 ){
                switch ( c ) {
                case 'h':
                        /* Display help text */
                default:
                        /* Unrecognised/invalid option */
                        imgexec_syntax ( argv );
                        return 1;
                }
        }

        /* Need no more than one image name */
        if ( optind != argc )
                name = argv[optind++];
        if ( optind != argc ) {
                imgexec_syntax ( argv );
                return 1;
        }
        
        /* Execute specified image */
        if ( name ) {
                image = find_image ( name );
                if ( ! image ) {
                        printf ( "No such image: %s\n", name );
                        return 1;
                }
        } else {
                image = imgautoselect();
                if ( ! image ) {
                        printf ( "No (unique) loaded image\n" );
                        return 1;
                }
        }

        if ( ( rc = imgexec ( image ) ) != 0 ) {
                printf ( "Could not execute %s: %s\n",
                         image->name, strerror ( rc ) );
                return 1;
        }

        return 0;
}

static void imgstat_syntax

(

char **

argv

)

[static]

"imgstat" command syntax message

Parameters:

argv

Argument list

Definition at line 447 of file image_cmd.c.

References printf().

Referenced by imgstat_exec().

                                           {
        printf ( "Usage:\n"
                 "  %s\n"
                 "\n"
                 "List executable/loadable images\n",
                 argv[0] );
}

static int imgstat_exec	(	int	argc,
		char **	argv
	)			[static]

The "imgstat" command.

Parameters:

	argc	Argument count
	argv	Argument list

Return values:

rc

Exit code

Definition at line 462 of file image_cmd.c.

References for_each_image, getopt_long(), imgstat(), imgstat_syntax(), NULL, and optind.

                                                  {
        static struct option longopts[] = {
                { "help", 0, NULL, 'h' },
                { NULL, 0, NULL, 0 },
        };
        struct image *image;
        int c;

        /* Parse options */
        while ( ( c = getopt_long ( argc, argv, "h", longopts, NULL ) ) >= 0 ){
                switch ( c ) {
                case 'h':
                        /* Display help text */
                default:
                        /* Unrecognised/invalid option */
                        imgstat_syntax ( argv );
                        return 1;
                }
        }

        /* No arguments */
        if ( optind != argc ) {
                imgstat_syntax ( argv );
                return 1;
        }

        /* Show status of all images */
        for_each_image ( image ) {
                imgstat ( image );
        }
        return 0;
}

static void imgfree_syntax

(

char **

argv

)

[static]

"imgstat" command syntax message

Parameters:

argv

Argument list

Definition at line 500 of file image_cmd.c.

References printf().

Referenced by imgfree_exec().

                                           {
        printf ( "Usage:\n"
                 "  %s [<image name>]\n"
                 "\n"
                 "Free one or all executable/loadable images\n",
                 argv[0] );
}

static int imgfree_exec	(	int	argc,
		char **	argv
	)			[static]

The "imgfree" command.

Parameters:

	argc	Argument count
	argv	Argument list

Return values:

rc

Exit code

Definition at line 515 of file image_cmd.c.

References find_image(), getopt_long(), images, imgfree(), imgfree_syntax(), image::list, list_for_each_entry_safe, name, NULL, optind, and printf().

                                                  {
        static struct option longopts[] = {
                { "help", 0, NULL, 'h' },
                { NULL, 0, NULL, 0 },
        };
        struct image *image;
        struct image *tmp;
        const char *name = NULL;
        int c;

        /* Parse options */
        while ( ( c = getopt_long ( argc, argv, "h", longopts, NULL ) ) >= 0 ){
                switch ( c ) {
                case 'h':
                        /* Display help text */
                default:
                        /* Unrecognised/invalid option */
                        imgfree_syntax ( argv );
                        return 1;
                }
        }

        /* Need no more than one image name */
        if ( optind != argc )
                name = argv[optind++];
        if ( optind != argc ) {
                imgfree_syntax ( argv );
                return 1;
        }

        if ( name ) {
                /* Free specified image (may leak) */
                image = find_image ( name );
                if ( ! image ) {
                        printf ( "No such image: %s\n", name );
                        return 1;
                }
                imgfree ( image );
        } else {
                /* Free all images */
                list_for_each_entry_safe ( image, tmp, &images, list ) {
                        imgfree ( image );
                }
        }
        return 0;
}

---

Variable Documentation

struct command image_commands [] __command

Image management commands.

Definition at line 563 of file image_cmd.c.