param_cmd.c File Reference

Request parameter commands. More...

#include <stdlib.h>
#include <errno.h>
#include <getopt.h>
#include <ipxe/params.h>
#include <ipxe/parseopt.h>
#include <ipxe/command.h>

Go to the source code of this file.

Data Structures
struct	params_options
	"params" options More...
struct	param_options
	"param" options More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static int	params_exec (int argc, char **argv)
	The "params" command.
static int	param_exec (int argc, char **argv)
	The "param" command.
	COMMAND (params, params_exec)
	Request parameter commands.
	COMMAND (param, param_exec)

Variables
static struct option_descriptor	params_opts []
	"params" option list
static struct command_descriptor	params_cmd
	"params" command descriptor
static struct option_descriptor	param_opts []
	"param" option list
static struct command_descriptor	param_cmd
	"param" command descriptor

Detailed Description

Request parameter commands.

Definition in file param_cmd.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

params_exec()

int params_exec ( int argc, char ** argv )

static

The "params" command.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 71 of file param_cmd.c.

                                                 {
        struct params_options opts;
        struct parameters *params;
        int rc;
 
        /* Parse options */
        if ( ( rc = parse_options ( argc, argv, &params_cmd, &opts ) ) != 0)
                return rc;
 
        /* Create parameter list */
        params = create_parameters ( opts.name, opts.method );
        if ( ! params )
                return -ENOMEM;
 
        /* Destroy parameter list, if applicable */
        if ( opts.delete ) {
                claim_parameters ( params );
                params_put ( params );
        }
 
        return 0;
}

References create_parameters(), ENOMEM, opts, params_cmd, parse_options(), and rc.

Referenced by COMMAND().

param_exec()

int param_exec ( int argc, char ** argv )

static

The "param" command.

Parameters

argc	Argument count
argv	Argument list

Return values

rc	Return status code

Definition at line 122 of file param_cmd.c.

                                                {
        struct param_options opts;
        char *key;
        char *value;
        unsigned int flags;
        struct parameters *params;
        struct parameter *param;
        int rc;
 
        /* Parse options */
        if ( ( rc = parse_options ( argc, argv, &param_cmd, &opts ) ) != 0 )
                goto err_parse_options;
 
        /* Parse key */
        key = argv[optind];
 
        /* Parse value */
        value = concat_args ( &argv[ optind + 1 ] );
        if ( ! value ) {
                rc = -ENOMEM;
                goto err_parse_value;
        }
 
        /* Construct flags */
        flags = ( opts.header ? PARAMETER_HEADER : PARAMETER_FORM );
 
        /* Identify parameter list */
        if ( ( rc = parse_parameters ( opts.params, &params ) ) != 0 )
                goto err_parse_parameters;
 
        /* Add parameter */
        param = add_parameter ( params, key, value, flags );
        if ( ! param ) {
                rc = -ENOMEM;
                goto err_add_parameter;
        }
 
        /* Success */
        rc = 0;
 
 err_add_parameter:
 err_parse_parameters:
        free ( value );
 err_parse_value:
 err_parse_options:
        return rc;
}

References add_parameter(), concat_args(), ENOMEM, flags, free, key, optind, opts, param, param_cmd, PARAMETER_FORM, PARAMETER_HEADER, parse_options(), parse_parameters(), rc, and value.

Referenced by COMMAND().

COMMAND() [1/2]

COMMAND	(	params	,
		params_exec	)

Request parameter commands.

References params_exec().

COMMAND() [2/2]

COMMAND	(	param	,
		param_exec	)

References param, and param_exec().

Variable Documentation

params_opts

struct option_descriptor params_opts[]

static

Initial value:

                               = {
        OPTION_DESC ( "name", 'n', required_argument,
                      struct params_options, name, parse_string ),
        OPTION_DESC ( "method", 'm', required_argument,
                      struct params_options, method, parse_string ),
        OPTION_DESC ( "delete", 'd', no_argument,
                      struct params_options, delete, parse_flag ),
}

"params" option list

Definition at line 51 of file param_cmd.c.

                                              {
        OPTION_DESC ( "name", 'n', required_argument,
                      struct params_options, name, parse_string ),
        OPTION_DESC ( "method", 'm', required_argument,
                      struct params_options, method, parse_string ),
        OPTION_DESC ( "delete", 'd', no_argument,
                      struct params_options, delete, parse_flag ),
};

params_cmd

struct command_descriptor params_cmd

static

Initial value:

                       =
COMMAND_DESC ( struct params_options, params_opts, 0, 0, NULL )

"params" command descriptor

Definition at line 61 of file param_cmd.c.

Referenced by params_exec().

param_opts

struct option_descriptor param_opts[]

static

Initial value:

                               = {
        OPTION_DESC ( "params", 'p', required_argument,
                      struct param_options, params, parse_string ),
        OPTION_DESC ( "header", 'H', no_argument,
                      struct param_options, header, parse_flag ),
}

"param" option list

Definition at line 103 of file param_cmd.c.

                                             {
        OPTION_DESC ( "params", 'p', required_argument,
                      struct param_options, params, parse_string ),
        OPTION_DESC ( "header", 'H', no_argument,
                      struct param_options, header, parse_flag ),
};

param_cmd

struct command_descriptor param_cmd

static

Initial value:

                       =
COMMAND_DESC ( struct param_options, param_opts, 1, MAX_ARGUMENTS,
               "<key> [<value>]" )

"param" command descriptor

Definition at line 111 of file param_cmd.c.

Referenced by param_exec(), and PROVIDE_REQUIRING_SYMBOL().