params.h File Reference

Request parameters. More...

#include <ipxe/list.h>
#include <ipxe/refcnt.h>

Go to the source code of this file.

Data Structures
struct	parameters
	A request parameter list. More...
struct	parameter
	A request parameter. More...

Macros
#define	PARAMETER_FORM   0x0001
	Request parameter is a form parameter.
#define	PARAMETER_HEADER   0x0002
	Request parameter is a header parameter.
#define	for_each_param(param, params)
	Iterate over all request parameters in a list.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static	__attribute__ ((always_inline)) struct parameters *params_get(struct parameters *params)
	Increment request parameter list reference count.
struct parameters *	find_parameters (const char *name)
	Find request parameter list by name.
struct parameters *	create_parameters (const char *name, const char *method)
	Create request parameter list.
struct parameter *	add_parameter (struct parameters *params, const char *key, const char *value, unsigned int flags)
	Add request parameter.

Detailed Description

Request parameters.

Definition in file params.h.

Macro Definition Documentation

PARAMETER_FORM

#define PARAMETER_FORM   0x0001

Request parameter is a form parameter.

Definition at line 43 of file params.h.

Referenced by add_parameter(), http_form_params(), and param_exec().

PARAMETER_HEADER

#define PARAMETER_HEADER   0x0002

Request parameter is a header parameter.

Definition at line 46 of file params.h.

Referenced by add_parameter(), http_format_headers(), and param_exec().

for_each_param

#define for_each_param	(		param,
			params )

Value:

list_for_each_entry ( (param), &(params)->entries, list )

Iterate over all request parameters in a list.

Definition at line 86 of file params.h.

#define for_each_param( param, params )                         \
        list_for_each_entry ( (param), &(params)->entries, list )

Referenced by http_form_params(), http_format_headers(), and uri_params_list_okx().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

__attribute__()

__attribute__ ( (always_inline) )

inlinestatic

Increment request parameter list reference count.

Claim ownership of request parameter list.

Decrement request parameter list reference count.

Parameters

params

Parameter list, or NULL

Return values

params

Parameter list as passed in

Parameters

params	Parameter list, or NULL
params	Parameter list

Return values

params

Parameter list

Definition at line 54 of file params.h.

                                         {
        ref_get ( &params->refcnt );
        return params;
}

References ref_get, and parameters::refcnt.

find_parameters()

struct parameters * find_parameters ( const char * name )

extern

Find request parameter list by name.

Parameters

name	Parameter list name (may be NULL)

Return values

params

Parameter list, or NULL if not found

Definition at line 69 of file params.c.

                                                         {
        struct parameters *params;
 
        list_for_each_entry ( params, &parameters, list ) {
                if ( ( params->name == name ) ||
                     ( params->name && name &&
                       ( strcmp ( params->name, name ) == 0 ) ) ) {
                        return params;
                }
        }
        return NULL;
}

References parameters::list, list_for_each_entry, name, parameters::name, NULL, and strcmp().

Referenced by create_parameters(), parse_parameters(), and parse_uri().

create_parameters()

struct parameters * create_parameters ( const char * name, const char * method )

extern

Create request parameter list.

Parameters

name	Parameter list name (may be NULL)
method	Method name (may be NULL)

Return values

params

Parameter list, or NULL on failure

Definition at line 89 of file params.c.

                                                             {
        struct parameters *params;
        size_t name_len;
        size_t method_len;
        char *name_copy;
        char *method_copy;
 
        /* Destroy any existing parameter list of this name */
        params = find_parameters ( name );
        if ( params ) {
                claim_parameters ( params );
                params_put ( params );
        }
 
        /* Allocate parameter list */
        name_len = ( name ? ( strlen ( name ) + 1 /* NUL */ ) : 0 );
        method_len = ( method ? ( strlen ( method ) + 1 /* NUL */ ) : 0 );
        params = zalloc ( sizeof ( *params ) + name_len + method_len );
        if ( ! params )
                return NULL;
        ref_init ( &params->refcnt, free_parameters );
        name_copy = ( ( ( void * ) params ) + sizeof ( *params ) );
        method_copy = ( ( ( void * ) name_copy ) + name_len );
 
        /* Populate parameter list */
        if ( name ) {
                strcpy ( name_copy, name );
                params->name = name_copy;
        }
        if ( method ) {
                strcpy ( method_copy, method );
                params->method = method_copy;
        }
        INIT_LIST_HEAD ( &params->entries );
 
        /* Add to list of parameter lists */
        list_add_tail ( &params->list, &parameters );
 
        DBGC ( params, "PARAMS \"%s\" created\n", params->name );
        if ( params->method ) {
                DBGC ( params, "PARAMS \"%s\" method is \"%s\"\n",
                       params->name, params->method );
        }
        return params;
}

References DBGC, parameters::entries, find_parameters(), free_parameters(), INIT_LIST_HEAD, parameters::list, list_add_tail, method, parameters::method, name, parameters::name, NULL, ref_init, parameters::refcnt, strcpy(), strlen(), and zalloc().

Referenced by params_exec(), and uri_params_okx().

add_parameter()

struct parameter * add_parameter ( struct parameters * params, const char * key, const char * value, unsigned int flags )

extern

Add request parameter.

Parameters

params	Parameter list
key	Parameter key
value	Parameter value
flags	Parameter flags

Return values

param

Parameter, or NULL on failure

Definition at line 145 of file params.c.

                                                        {
        struct parameter *param;
        size_t key_len;
        size_t value_len;
        char *key_copy;
        char *value_copy;
 
        /* Allocate parameter */
        key_len = ( strlen ( key ) + 1 /* NUL */ );
        value_len = ( strlen ( value ) + 1 /* NUL */ );
        param = zalloc ( sizeof ( *param ) + key_len + value_len );
        if ( ! param )
                return NULL;
        key_copy = ( ( void * ) ( param + 1 ) );
        value_copy = ( key_copy + key_len );
 
        /* Populate parameter */
        strcpy ( key_copy, key );
        param->key = key_copy;
        strcpy ( value_copy, value );
        param->value = value_copy;
        param->flags = flags;
 
        /* Add to list of parameters */
        list_add_tail ( &param->list, &params->entries );
 
        DBGC ( params, "PARAMS \"%s\" added \"%s\"=\"%s\"%s%s\n",
               params->name, param->key, param->value,
               ( ( param->flags & PARAMETER_FORM ) ? " (form)" : "" ),
               ( ( param->flags & PARAMETER_HEADER ) ? " (header)" : "" ) );
        return param;
}

References DBGC, parameters::entries, flags, key, list_add_tail, parameters::name, NULL, param, PARAMETER_FORM, PARAMETER_HEADER, strcpy(), strlen(), value, and zalloc().

Referenced by param_exec(), and uri_params_okx().