params.c File Reference

Request parameters. More...

#include <stdlib.h>
#include <string.h>
#include <ipxe/params.h>

Go to the source code of this file.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static	LIST_HEAD (parameters)
	List of all parameter lists.
static void	free_parameters (struct refcnt *refcnt)
	Free request parameter list.
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.c.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

LIST_HEAD()

LIST_HEAD ( parameters )

static

List of all parameter lists.

free_parameters()

void free_parameters ( struct refcnt * refcnt )

static

Free request parameter list.

Parameters

refcnt

Reference count

Definition at line 45 of file params.c.

                                                      {
        struct parameters *params =
                container_of ( refcnt, struct parameters, refcnt );
        struct parameter *param;
        struct parameter *tmp;
 
        DBGC ( params, "PARAMS \"%s\" destroyed\n", params->name );
 
        /* Free all parameters */
        list_for_each_entry_safe ( param, tmp, &params->entries, list ) {
                list_del ( &param->list );
                free ( param );
        }
 
        /* Free parameter list */
        free ( params );
}

References container_of, DBGC, parameters::entries, free, parameter::list, list_del, list_for_each_entry_safe, parameters::name, param, and tmp.

Referenced by create_parameters().

find_parameters()

struct parameters * find_parameters

(

const char *

name

)

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 )

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 )

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