iPXE
Data Structures | Functions | Variables
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. More...
 
static int param_exec (int argc, char **argv)
 The "param" command. More...
 
 COMMAND (params, params_exec)
 Request parameter commands. More...
 
 COMMAND (param, param_exec)
 

Variables

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

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()

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

The "params" command.

Parameters
argcArgument count
argvArgument list
Return values
rcReturn status code

Definition at line 67 of file param_cmd.c.

67  {
68  struct params_options opts;
69  struct parameters *params;
70  int rc;
71 
72  /* Parse options */
73  if ( ( rc = parse_options ( argc, argv, &params_cmd, &opts ) ) != 0)
74  return rc;
75 
76  /* Create parameter list */
77  params = create_parameters ( opts.name );
78  if ( ! params )
79  return -ENOMEM;
80 
81  /* Destroy parameter list, if applicable */
82  if ( opts.delete ) {
83  claim_parameters ( params );
84  params_put ( params );
85  }
86 
87  return 0;
88 }
rc
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
parameters
A request parameter list.
Definition: params.h:17
parse_options
int parse_options(int argc, char **argv, struct command_descriptor *cmd, void *opts)
Parse command-line options.
Definition: parseopt.c:485
ENOMEM
#define ENOMEM
Not enough space.
Definition: errno.h:535
params_options
"params" options
Definition: param_cmd.c:41
create_parameters
struct parameters * create_parameters(const char *name)
Create request parameter list.
Definition: params.c:87
params_cmd
static struct command_descriptor params_cmd
"params" command descriptor
Definition: param_cmd.c:57
opts
static union @447 opts
"cert<xxx>" option list

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

◆ param_exec()

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

The "param" command.

Parameters
argcArgument count
argvArgument list
Return values
rcReturn status code

Definition at line 118 of file param_cmd.c.

118  {
119  struct param_options opts;
120  char *key;
121  char *value;
122  unsigned int flags;
123  struct parameters *params;
124  struct parameter *param;
125  int rc;
126 
127  /* Parse options */
128  if ( ( rc = parse_options ( argc, argv, &param_cmd, &opts ) ) != 0 )
129  goto err_parse_options;
130 
131  /* Parse key */
132  key = argv[optind];
133 
134  /* Parse value */
135  value = concat_args ( &argv[ optind + 1 ] );
136  if ( ! value ) {
137  rc = -ENOMEM;
138  goto err_parse_value;
139  }
140 
141  /* Construct flags */
142  flags = ( opts.header ? PARAMETER_HEADER : PARAMETER_FORM );
143 
144  /* Identify parameter list */
145  if ( ( rc = parse_parameters ( opts.params, &params ) ) != 0 )
146  goto err_parse_parameters;
147 
148  /* Add parameter */
149  param = add_parameter ( params, key, value, flags );
150  if ( ! param ) {
151  rc = -ENOMEM;
152  goto err_add_parameter;
153  }
154 
155  /* Success */
156  rc = 0;
157 
158  err_add_parameter:
159  err_parse_parameters:
160  free ( value );
161  err_parse_value:
162  err_parse_options:
163  return rc;
164 }
rc
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
optind
int optind
Current option index.
Definition: getopt.c:52
parameters
A request parameter list.
Definition: params.h:17
parse_options
int parse_options(int argc, char **argv, struct command_descriptor *cmd, void *opts)
Parse command-line options.
Definition: parseopt.c:485
ENOMEM
#define ENOMEM
Not enough space.
Definition: errno.h:535
value
pseudo_bit_t value[0x00020]
Definition: arbel.h:13
concat_args
char * concat_args(char **args)
Concatenate arguments.
Definition: exec.c:359
param_options
"param" options
Definition: param_cmd.c:91
flags
uint8_t flags
Flags.
Definition: ena.h:18
free
static void(* free)(struct refcnt *refcnt))
Definition: refcnt.h:55
parse_parameters
int parse_parameters(char *text, struct parameters **params)
Parse request parameter list name.
Definition: parseopt.c:349
param
struct hv_monitor_parameter param[4][32]
Parameters.
Definition: hyperv.h:24
PARAMETER_FORM
#define PARAMETER_FORM
Request parameter is a form parameter.
Definition: params.h:41
param_cmd
static struct command_descriptor param_cmd
"param" command descriptor
Definition: param_cmd.c:107
opts
static union @447 opts
"cert<xxx>" option list
parameter
A request parameter.
Definition: params.h:29
add_parameter
struct parameter * add_parameter(struct parameters *params, const char *key, const char *value, unsigned int flags)
Add request parameter.
Definition: params.c:130
PARAMETER_HEADER
#define PARAMETER_HEADER
Request parameter is a header parameter.
Definition: params.h:44
key
union @391 key
Sense key.
Definition: scsi.h:18

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.

◆ COMMAND() [1/2]

COMMAND ( params  ,
params_exec   
)

Request parameter commands.

◆ COMMAND() [2/2]

COMMAND ( param  ,
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 ( "delete", 'd', no_argument,
struct params_options, delete, parse_flag ),
}
name
const char * name
Definition: ath9k_hw.c:1986
parse_string
int parse_string(char *text, char **value)
Parse string value.
Definition: parseopt.c:74
params_options
"params" options
Definition: param_cmd.c:41
parse_flag
int parse_flag(char *text __unused, int *flag)
Parse flag.
Definition: parseopt.c:227
no_argument
Option does not take an argument.
Definition: getopt.h:17
OPTION_DESC
#define OPTION_DESC(_longopt, _shortopt, _has_arg, _struct, _field, _parse)
Construct option descriptor.
Definition: parseopt.h:68
required_argument
Option requires an argument.
Definition: getopt.h:19

"params" option list

Definition at line 49 of file param_cmd.c.

◆ params_cmd

struct command_descriptor params_cmd
static
Initial value:
=
COMMAND_DESC ( struct params_options, params_opts, 0, 0, NULL )
params_opts
static struct option_descriptor params_opts[]
"params" option list
Definition: param_cmd.c:49
params_options
"params" options
Definition: param_cmd.c:41
COMMAND_DESC
#define COMMAND_DESC(_struct, _options, _min_args, _max_args, _usage)
Construct command descriptor.
Definition: parseopt.h:109
NULL
#define NULL
NULL pointer (VOID *)
Definition: Base.h:322

"params" command descriptor

Definition at line 57 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 ),
}
parse_string
int parse_string(char *text, char **value)
Parse string value.
Definition: parseopt.c:74
param_options
"param" options
Definition: param_cmd.c:91
parse_flag
int parse_flag(char *text __unused, int *flag)
Parse flag.
Definition: parseopt.c:227
no_argument
Option does not take an argument.
Definition: getopt.h:17
OPTION_DESC
#define OPTION_DESC(_longopt, _shortopt, _has_arg, _struct, _field, _parse)
Construct option descriptor.
Definition: parseopt.h:68
required_argument
Option requires an argument.
Definition: getopt.h:19
header
struct ena_llq_option header
Header locations.
Definition: ena.h:16

"param" option list

Definition at line 99 of file param_cmd.c.

◆ param_cmd

struct command_descriptor param_cmd
static
Initial value:
=
COMMAND_DESC ( struct param_options, param_opts, 1, MAX_ARGUMENTS,
"<key> [<value>]" )
MAX_ARGUMENTS
#define MAX_ARGUMENTS
No maximum number of arguments.
Definition: parseopt.h:98
param_options
"param" options
Definition: param_cmd.c:91
COMMAND_DESC
#define COMMAND_DESC(_struct, _options, _min_args, _max_args, _usage)
Construct command descriptor.
Definition: parseopt.h:109
param_opts
static struct option_descriptor param_opts[]
"param" option list
Definition: param_cmd.c:99

"param" command descriptor

Definition at line 107 of file param_cmd.c.

Referenced by param_exec().

Generated by   doxygen 1.8.15