image_cmd.c File Reference

Image management commands. More...

#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <getopt.h>
#include <ipxe/image.h>
#include <ipxe/command.h>
#include <ipxe/parseopt.h>
#include <ipxe/shell.h>
#include <usr/imgmgmt.h>

Go to the source code of this file.

Data Structures
struct	imgsingle_options
	"img{single}" options More...
struct	imgsingle_descriptor
	An "img{single}" family command descriptor. More...
struct	imgmulti_options
	"img{multi}" options More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static int	imgsingle_exec (int argc, char **argv, struct imgsingle_descriptor *desc)
	The "img{single}" family of commands. More...
static int	imgfetch_exec (int argc, char **argv)
	The "imgfetch" command. More...
static int	imgselect (struct image *image, struct imgsingle_options *opts __unused)
	"imgselect" command action More...
static int	imgselect_exec (int argc, char **argv)
	The "imgselect" command. More...
static int	imgexec (struct image *image, struct imgsingle_options *opts)
	"imgexec" command action More...
static int	imgexec_exec (int argc, char **argv)
	The "imgexec" command. More...
static int	imgargs_exec (int argc, char **argv)
	The "imgargs" command body. More...
static int	imgmulti_exec (int argc, char **argv, void(*payload)(struct image *image))
	The "img{multi}" family of commands. More...
static int	imgstat_exec (int argc, char **argv)
	The "imgstat" command. More...
static int	imgfree_exec (int argc, char **argv)
	The "imgfree" command. More...
	COMMAND (imgfetch, imgfetch_exec)
	COMMAND (module, imgfetch_exec)
	COMMAND (initrd, imgfetch_exec)
	COMMAND (imgselect, imgselect_exec)
	COMMAND (imgload, imgselect_exec)
	COMMAND (kernel, imgselect_exec)
	COMMAND (imgexec, imgexec_exec)
	COMMAND (chain, imgexec_exec)
	COMMAND (boot, imgexec_exec)
	COMMAND (imgargs, imgargs_exec)
	COMMAND (imgstat, imgstat_exec)
	COMMAND (imgfree, imgfree_exec)

Variables
union {
struct option_descriptor   imgexec [4]
struct option_descriptor   imgsingle [3]
}	opts
	"img{single}" option list More...
static struct command_descriptor	imgfetch_cmd
	"imgfetch" command descriptor More...
struct imgsingle_descriptor	imgfetch_desc
	"imgfetch" family command descriptor More...
static struct command_descriptor	imgselect_cmd
	"imgselect" command descriptor More...
struct imgsingle_descriptor	imgselect_desc
	"imgselect" family command descriptor More...
static struct command_descriptor	imgexec_cmd
	"imgexec" command descriptor More...
struct imgsingle_descriptor	imgexec_desc
	"imgexec" family command descriptor More...
static struct command_descriptor	imgargs_cmd
	"imgargs" command descriptor More...
struct imgsingle_descriptor	imgargs_desc
	"imgargs" family command descriptor More...
static struct option_descriptor	imgmulti_opts [] = {}
	"img{multi}" option list More...
static struct command_descriptor	imgmulti_cmd
	"img{multi}" command descriptor More...

Detailed Description

Image management commands.

Definition in file image_cmd.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

imgsingle_exec()

static int imgsingle_exec ( int  argc, char **  argv, struct imgsingle_descriptor *  desc  )

static

The "img{single}" family of commands.

Parameters

argc	Argument count
argv	Argument list
desc	"img{single}" command descriptor
action_name	Action name (for error messages)
action	Action to take upon image

Return values

rc	Return status code

Definition at line 104 of file image_cmd.c.

                                                                {
        struct imgsingle_options opts;
        char *name_uri = NULL;
        char *cmdline = NULL;
        struct image *image;
        int rc;

        /* Parse options */
        if ( ( rc = parse_options ( argc, argv, desc->cmd, &opts ) ) != 0 )
                goto err_parse_options;

        /* Parse name/URI string and command line, if present */
        if ( optind < argc ) {
                name_uri = argv[optind];
                if ( argv[ optind + 1 ] != NULL ) {
                        cmdline = concat_args ( &argv[ optind + 1 ] );
                        if ( ! cmdline ) {
                                rc = -ENOMEM;
                                goto err_parse_cmdline;
                        }
                }
        }

        /* Acquire the image */
        if ( name_uri ) {
                if ( ( rc = desc->acquire ( name_uri, opts.timeout,
                                            &image ) ) != 0 )
                        goto err_acquire;
        } else {
                image = find_image_tag ( &selected_image );
                if ( ! image ) {
                        printf ( "No image selected\n" );
                        goto err_acquire;
                }
        }

        /* Carry out command pre-action, if applicable */
        if ( desc->preaction )
                desc->preaction ( image );

        /* Set the image name, if applicable */
        if ( opts.name ) {
                if ( ( rc = image_set_name ( image, opts.name ) ) != 0 ) {
                        printf ( "Could not name image: %s\n",
                                 strerror ( rc ) );
                        goto err_set_name;
                }
        }

        /* Set the command-line arguments, if applicable */
        if ( cmdline ) {
                if ( ( rc = image_set_cmdline ( image, cmdline ) ) != 0 ) {
                        printf ( "Could not set arguments: %s\n",
                                 strerror ( rc ) );
                        goto err_set_cmdline;
                }
        }

        /* Set the auto-unregister flag, if applicable */
        if ( opts.autofree )
                image->flags |= IMAGE_AUTO_UNREGISTER;

        /* Carry out command action, if applicable */
        if ( desc->action ) {
                if ( ( rc = desc->action ( image, &opts ) ) != 0 ) {
                        printf ( "Could not %s: %s\n",
                                 desc->verb, strerror ( rc ) );
                        goto err_action;
                }
        }

        /* Success */
        rc = 0;

 err_action:
 err_set_cmdline:
 err_set_name:
 err_acquire:
        free ( cmdline );
 err_parse_cmdline:
 err_parse_options:
        return rc;
}

References cmdline, concat_args(), desc, ENOMEM, find_image_tag(), image::flags, free, IMAGE_AUTO_UNREGISTER, image_set_cmdline(), image_set_name(), NULL, optind, opts, parse_options(), printf(), rc, selected_image, and strerror().

Referenced by imgargs_exec(), imgexec_exec(), imgfetch_exec(), and imgselect_exec().

imgfetch_exec()

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

static

The "imgfetch" command.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 207 of file image_cmd.c.

                                                   {
        return imgsingle_exec ( argc, argv, &imgfetch_desc );
}

References imgfetch_desc, and imgsingle_exec().

imgselect()

static int imgselect ( struct image *  image, struct imgsingle_options *opts  __unused  )

static

"imgselect" command action

Parameters

image	Image
opts	Options

Return values

rc	Return status code

Definition at line 218 of file image_cmd.c.

                                                                 {
        return image_select ( image );
}

References image_select().

imgselect_exec()

static int imgselect_exec ( int  argc, char **  argv  )

static

The "imgselect" command.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 243 of file image_cmd.c.

                                                    {
        return imgsingle_exec ( argc, argv, &imgselect_desc );
}

References imgselect_desc, and imgsingle_exec().

imgexec()

static int imgexec ( struct image *  image, struct imgsingle_options *  opts  )

static

"imgexec" command action

Parameters

image	Image
opts	Options

Return values

rc	Return status code

Definition at line 259 of file image_cmd.c.

                                                                           {
        int rc;

        /* Perform replacement or execution as applicable */
        if ( opts->replace ) {

                /* Try to replace image */
                if ( ( rc = image_replace ( image ) ) != 0 )
                        return rc;

                /* Stop script and tail-recurse into replacement image */
                shell_stop ( SHELL_STOP_COMMAND_SEQUENCE );

        } else {

                /* Try to execute image */
                if ( ( rc = image_exec ( image ) ) != 0 )
                        return rc;
        }

        return 0;
}

References image_exec(), image_replace(), opts, rc, shell_stop(), and SHELL_STOP_COMMAND_SEQUENCE.

imgexec_exec()

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

static

The "imgexec" command.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 297 of file image_cmd.c.

                                                 {
        return imgsingle_exec ( argc, argv, &imgexec_desc );
}

References imgexec_desc, and imgsingle_exec().

imgargs_exec()

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

static

The "imgargs" command body.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 320 of file image_cmd.c.

                                                  {
        return imgsingle_exec ( argc, argv, &imgargs_desc );
}

References imgargs_desc, and imgsingle_exec().

imgmulti_exec()

static int imgmulti_exec ( int  argc, char **  argv, void(*)(struct image *image)  payload  )

static

The "img{multi}" family of commands.

Parameters

argc	Argument count
argv	Argument list
payload	Function to execute on each image

Return values

rc	Return status code

Definition at line 343 of file image_cmd.c.

                                                                        {
        struct imgmulti_options opts;
        struct image *image;
        struct image *tmp;
        int i;
        int rc;

        /* Parse options */
        if ( ( rc = parse_options ( argc, argv, &imgmulti_cmd, &opts ) ) != 0 )
                return rc;

        /* If no images are explicitly specified, process all images */
        if ( optind == argc ) {
                for_each_image_safe ( image, tmp )
                        payload ( image );
                return 0;
        }

        /* Otherwise, process specified images */
        for ( i = optind ; i < argc ; i++ ) {
                image = find_image ( argv[i] );
                if ( ! image ) {
                        printf ( "\"%s\": no such image\n", argv[i] );
                        return -ENOENT;
                }
                payload ( image );
        }

        return 0;
}

References ENOENT, find_image(), for_each_image_safe, imgmulti_cmd, optind, opts, parse_options(), printf(), rc, and tmp.

Referenced by imgfree_exec(), and imgstat_exec().

imgstat_exec()

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

static

The "imgstat" command.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 382 of file image_cmd.c.

                                                  {
        return imgmulti_exec ( argc, argv, imgstat );
}

References imgmulti_exec(), and imgstat().

imgfree_exec()

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

static

The "imgfree" command.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 393 of file image_cmd.c.

                                                  {
        return imgmulti_exec ( argc, argv, unregister_image );
}

References imgmulti_exec(), and unregister_image().

COMMAND() [1/12]

COMMAND	(	imgfetch	,
		imgfetch_exec
	)

COMMAND() [2/12]

COMMAND	(	module	,
		imgfetch_exec
	)

COMMAND() [3/12]

COMMAND	(	initrd	,
		imgfetch_exec
	)

COMMAND() [4/12]

COMMAND	(	imgselect	,
		imgselect_exec
	)

COMMAND() [5/12]

COMMAND	(	imgload	,
		imgselect_exec
	)

COMMAND() [6/12]

COMMAND	(	kernel	,
		imgselect_exec
	)

COMMAND() [7/12]

COMMAND	(	imgexec	,
		imgexec_exec
	)

COMMAND() [8/12]

COMMAND	(	chain	,
		imgexec_exec
	)

COMMAND() [9/12]

COMMAND	(	boot	,
		imgexec_exec
	)

COMMAND() [10/12]

COMMAND	(	imgargs	,
		imgargs_exec
	)

COMMAND() [11/12]

COMMAND	(	imgstat	,
		imgstat_exec
	)

COMMAND() [12/12]

COMMAND	(	imgfree	,
		imgfree_exec
	)

Variable Documentation

imgexec

struct option_descriptor imgexec[4]

Definition at line 60 of file image_cmd.c.

imgsingle

struct option_descriptor imgsingle[3]

Definition at line 64 of file image_cmd.c.

opts

union { ... } opts

Initial value:

= {
        .imgexec = {
                OPTION_DESC ( "name", 'n', required_argument,
                              struct imgsingle_options, name, parse_string ),
                OPTION_DESC ( "timeout", 't', required_argument,
                              struct imgsingle_options, timeout, parse_timeout),
                OPTION_DESC ( "autofree", 'a', no_argument,
                              struct imgsingle_options, autofree, parse_flag ),
                OPTION_DESC ( "replace", 'r', no_argument,
                              struct imgsingle_options, replace, parse_flag ),
        },
}

"img{single}" option list

Referenced by imgexec(), imgmulti_exec(), and imgsingle_exec().

imgfetch_cmd

struct command_descriptor imgfetch_cmd

static

Initial value:

=
        COMMAND_DESC ( struct imgsingle_options, opts.imgsingle,
                       1, MAX_ARGUMENTS, "<uri> [<arguments>...]" )

"imgfetch" command descriptor

Definition at line 190 of file image_cmd.c.

imgfetch_desc

struct imgsingle_descriptor imgfetch_desc

Initial value:

= {
        .cmd = &imgfetch_cmd,
        .acquire = imgdownload_string,
}

"imgfetch" family command descriptor

Definition at line 195 of file image_cmd.c.

Referenced by imgfetch_exec().

imgselect_cmd

struct command_descriptor imgselect_cmd

static

Initial value:

=
        COMMAND_DESC ( struct imgsingle_options, opts.imgsingle,
                       1, MAX_ARGUMENTS, "<uri|image> [<arguments>...]" )

"imgselect" command descriptor

Definition at line 224 of file image_cmd.c.

imgselect_desc

struct imgsingle_descriptor imgselect_desc

Initial value:

= {
        .cmd = &imgselect_cmd,
        .acquire = imgacquire,
        .action = imgselect,
        .verb = "select",
}

"imgselect" family command descriptor

Definition at line 229 of file image_cmd.c.

Referenced by imgselect_exec().

imgexec_cmd

struct command_descriptor imgexec_cmd

static

Initial value:

=
        COMMAND_DESC ( struct imgsingle_options, opts.imgexec,
                       0, MAX_ARGUMENTS, "[<uri|image> [<arguments>...]]" )

"imgexec" command descriptor

Definition at line 248 of file image_cmd.c.

imgexec_desc

struct imgsingle_descriptor imgexec_desc

Initial value:

= {
        .cmd = &imgexec_cmd,
        .acquire = imgacquire,
        .action = imgexec,
        .verb = "boot",
}

"imgexec" family command descriptor

Definition at line 283 of file image_cmd.c.

Referenced by imgexec_exec().

imgargs_cmd

struct command_descriptor imgargs_cmd

static

Initial value:

=
        COMMAND_DESC ( struct imgsingle_options, opts.imgsingle,
                       1, MAX_ARGUMENTS, "<uri|image> [<arguments>...]" )

"imgargs" command descriptor

Definition at line 302 of file image_cmd.c.

imgargs_desc

struct imgsingle_descriptor imgargs_desc

Initial value:

= {
        .cmd = &imgargs_cmd,
        .acquire = imgacquire,
        .preaction = image_clear_cmdline,
}

"imgargs" family command descriptor

Definition at line 307 of file image_cmd.c.

Referenced by imgargs_exec().

imgmulti_opts

struct option_descriptor imgmulti_opts[] = {}

static

"img{multi}" option list

Definition at line 328 of file image_cmd.c.

imgmulti_cmd

struct command_descriptor imgmulti_cmd

static

Initial value:

=
        COMMAND_DESC ( struct imgmulti_options, imgmulti_opts, 0, MAX_ARGUMENTS,
                       "[<image>...]" )

"img{multi}" command descriptor

Definition at line 331 of file image_cmd.c.

Referenced by imgmulti_exec().