sanboot_cmd.c File Reference

SAN commands. More...

#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <getopt.h>
#include <ipxe/command.h>
#include <ipxe/parseopt.h>
#include <ipxe/uri.h>
#include <ipxe/sanboot.h>
#include <usr/autoboot.h>

Go to the source code of this file.

Data Structures
struct	sanboot_options
	"sanboot" options More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static int	sanboot_core_exec (int argc, char **argv, struct command_descriptor *cmd, int default_flags, int no_root_path_flags)
	The "sanboot", "sanhook" and "sanunhook" commands.
static int	sanhook_exec (int argc, char **argv)
	The "sanhook" command.
static int	sanboot_exec (int argc, char **argv)
	The "sanboot" command.
static int	sanunhook_exec (int argc, char **argv)
	The "sanunhook" command.
	COMMAND (sanhook, sanhook_exec)
	SAN commands.
	COMMAND (sanboot, sanboot_exec)
	COMMAND (sanunhook, sanunhook_exec)

Variables
union {
struct option_descriptor   sanboot [7]
struct option_descriptor   sanhook [2]
struct option_descriptor   sanunhook [1]
}	opts
	"sanboot" option list
static struct command_descriptor	sanhook_cmd
	"sanhook" command descriptor
static struct command_descriptor	sanboot_cmd
	"sanboot" command descriptor
static struct command_descriptor	sanunhook_cmd
	"sanunhook" command descriptor

Detailed Description

SAN commands.

Definition in file sanboot_cmd.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

sanboot_core_exec()

int sanboot_core_exec ( int argc, char ** argv, struct command_descriptor * cmd, int default_flags, int no_root_path_flags )

static

The "sanboot", "sanhook" and "sanunhook" commands.

Parameters

argc	Argument count
argv	Argument list
default_flags	Default set of flags for uriboot()
no_root_path_flags	Additional flags to apply if no root path is present

Return values

rc	Return status code

Definition at line 111 of file sanboot_cmd.c.

                                                                           {
        struct sanboot_options opts;
        struct san_boot_config config;
        struct uri *uris[argc];
        int count;
        int flags;
        int i;
        int rc;
 
        /* Initialise options */
        memset ( &opts, 0, sizeof ( opts ) );
        opts.drive = san_default_drive();
 
        /* Parse options */
        if ( ( rc = reparse_options ( argc, argv, cmd, &opts ) ) != 0 )
                goto err_parse_options;
 
        /* Parse root paths, if present */
        count = ( argc - optind );
        for ( i = 0 ; i < count ; i++ ) {
                uris[i] = parse_uri ( argv[ optind + i ] );
                if ( ! uris[i] ) {
                        rc = -ENOMEM;
                        goto err_parse_uri;
                }
        }
 
        /* Construct configuration parameters */
        config.filename = opts.filename;
        config.extra = opts.extra;
        config.label = opts.label;
        config.uuid = opts.uuid.value;
 
        /* Construct flags */
        flags = default_flags;
        if ( opts.no_describe )
                flags |= URIBOOT_NO_SAN_DESCRIBE;
        if ( opts.keep )
                flags |= URIBOOT_NO_SAN_UNHOOK;
        if ( ! count )
                flags |= no_root_path_flags;
 
        /* Boot from root path */
        if ( ( rc = uriboot ( NULL, uris, count, opts.drive, &config,
                              flags ) ) != 0 )
                goto err_uriboot;
 
 err_uriboot:
        i = count;
 err_parse_uri:
        for ( i-- ; i >= 0 ; i-- )
                uri_put ( uris[i] );
 err_parse_options:
        return rc;
}

References cmd, count, ENOMEM, san_boot_config::extra, san_boot_config::filename, flags, san_boot_config::label, memset(), NULL, optind, opts, parse_uri(), rc, reparse_options(), san_default_drive(), uri_put(), uriboot(), URIBOOT_NO_SAN_DESCRIBE, URIBOOT_NO_SAN_UNHOOK, and san_boot_config::uuid.

Referenced by sanboot_exec(), sanhook_exec(), and sanunhook_exec().

sanhook_exec()

int sanhook_exec ( int argc, char ** argv )

static

The "sanhook" command.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 176 of file sanboot_cmd.c.

                                                  {
        return sanboot_core_exec ( argc, argv, &sanhook_cmd,
                                   ( URIBOOT_NO_SAN_BOOT |
                                     URIBOOT_NO_SAN_UNHOOK ), 0 );
}

References sanboot_core_exec(), sanhook_cmd, URIBOOT_NO_SAN_BOOT, and URIBOOT_NO_SAN_UNHOOK.

Referenced by COMMAND().

sanboot_exec()

int sanboot_exec ( int argc, char ** argv )

static

The "sanboot" command.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 189 of file sanboot_cmd.c.

                                                  {
        return sanboot_core_exec ( argc, argv, &sanboot_cmd,
                                   0, URIBOOT_NO_SAN_UNHOOK );
}

References sanboot_cmd, sanboot_core_exec(), and URIBOOT_NO_SAN_UNHOOK.

Referenced by COMMAND().

sanunhook_exec()

int sanunhook_exec ( int argc, char ** argv )

static

The "sanunhook" command.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 201 of file sanboot_cmd.c.

                                                    {
        return sanboot_core_exec ( argc, argv, &sanunhook_cmd,
                                   ( URIBOOT_NO_SAN_DESCRIBE |
                                     URIBOOT_NO_SAN_BOOT ), 0 );
}

References sanboot_core_exec(), sanunhook_cmd, URIBOOT_NO_SAN_BOOT, and URIBOOT_NO_SAN_DESCRIBE.

Referenced by COMMAND().

COMMAND() [1/3]

COMMAND	(	sanhook	,
		sanhook_exec	)

SAN commands.

References sanhook, and sanhook_exec().

COMMAND() [2/3]

COMMAND	(	sanboot	,
		sanboot_exec	)

References sanboot, and sanboot_exec().

COMMAND() [3/3]

COMMAND	(	sanunhook	,
		sanunhook_exec	)

References sanunhook, and sanunhook_exec().

Variable Documentation

sanboot

struct option_descriptor sanboot[7]

Definition at line 64 of file sanboot_cmd.c.

Referenced by COMMAND().

sanhook

struct option_descriptor sanhook[2]

Definition at line 66 of file sanboot_cmd.c.

Referenced by COMMAND().

sanunhook

struct option_descriptor sanunhook[1]

Definition at line 68 of file sanboot_cmd.c.

Referenced by COMMAND().

[union]

union { ... } opts

Initial value:

= {
        .sanboot = {
                OPTION_DESC ( "drive", 'd', required_argument,
                              struct sanboot_options, drive, parse_integer ),
                OPTION_DESC ( "no-describe", 'n', no_argument,
                              struct sanboot_options, no_describe, parse_flag ),
                OPTION_DESC ( "keep", 'k', no_argument,
                              struct sanboot_options, keep, parse_flag ),
                OPTION_DESC ( "filename", 'f', required_argument,
                              struct sanboot_options, filename, parse_string ),
                OPTION_DESC ( "extra", 'e', required_argument,
                              struct sanboot_options, extra, parse_string ),
                OPTION_DESC ( "label", 'l', required_argument,
                              struct sanboot_options, label, parse_string ),
                OPTION_DESC ( "uuid", 'u', required_argument,
                              struct sanboot_options, uuid, parse_uuid ),
        },
}

"sanboot" option list

sanhook_cmd

struct command_descriptor sanhook_cmd

static

Initial value:

=
        COMMAND_DESC ( struct sanboot_options, opts.sanhook, 1, MAX_ARGUMENTS,
                       "<root-path>" )

"sanhook" command descriptor

Definition at line 89 of file sanboot_cmd.c.

Referenced by sanhook_exec().

sanboot_cmd

struct command_descriptor sanboot_cmd

static

Initial value:

=
        COMMAND_DESC ( struct sanboot_options, opts.sanboot, 0, MAX_ARGUMENTS,
                       "[<root-path>]" )

"sanboot" command descriptor

Definition at line 94 of file sanboot_cmd.c.

Referenced by PROVIDE_REQUIRING_SYMBOL(), and sanboot_exec().

sanunhook_cmd

struct command_descriptor sanunhook_cmd

static

Initial value:

=
        COMMAND_DESC ( struct sanboot_options, opts.sanunhook, 0, 0, NULL )

"sanunhook" command descriptor

Definition at line 99 of file sanboot_cmd.c.

Referenced by sanunhook_exec().