1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098 |
- /*
- * Copyright (C) 2008 Michael Brown <mbrown@fensystems.co.uk>.
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
- * published by the Free Software Foundation; either version 2 of the
- * License, or any later version.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
- * 02110-1301, USA.
- */
-
- FILE_LICENCE ( GPL2_OR_LATER );
-
- #include <stdint.h>
- #include <stdlib.h>
- #include <stdio.h>
- #include <string.h>
- #include <strings.h>
- #include <byteswap.h>
- #include <errno.h>
- #include <assert.h>
- #include <ipxe/in.h>
- #include <ipxe/vsprintf.h>
- #include <ipxe/dhcp.h>
- #include <ipxe/uuid.h>
- #include <ipxe/uri.h>
- #include <ipxe/init.h>
- #include <ipxe/settings.h>
-
- /** @file
- *
- * Configuration settings
- *
- */
-
- /******************************************************************************
- *
- * Generic settings blocks
- *
- ******************************************************************************
- */
-
- /**
- * A generic setting
- *
- */
- struct generic_setting {
- /** List of generic settings */
- struct list_head list;
- /** Setting */
- struct setting setting;
- /** Size of setting name */
- size_t name_len;
- /** Size of setting data */
- size_t data_len;
- };
-
- /**
- * Get generic setting name
- *
- * @v generic Generic setting
- * @ret name Generic setting name
- */
- static inline void * generic_setting_name ( struct generic_setting *generic ) {
- return ( ( ( void * ) generic ) + sizeof ( *generic ) );
- }
-
- /**
- * Get generic setting data
- *
- * @v generic Generic setting
- * @ret data Generic setting data
- */
- static inline void * generic_setting_data ( struct generic_setting *generic ) {
- return ( ( ( void * ) generic ) + sizeof ( *generic ) +
- generic->name_len );
- }
-
- /**
- * Find generic setting
- *
- * @v generics Generic settings block
- * @v setting Setting to find
- * @ret generic Generic setting, or NULL
- */
- static struct generic_setting *
- find_generic_setting ( struct generic_settings *generics,
- struct setting *setting ) {
- struct generic_setting *generic;
-
- list_for_each_entry ( generic, &generics->list, list ) {
- if ( setting_cmp ( &generic->setting, setting ) == 0 )
- return generic;
- }
- return NULL;
- }
-
- /**
- * Store value of generic setting
- *
- * @v settings Settings block
- * @v setting Setting to store
- * @v data Setting data, or NULL to clear setting
- * @v len Length of setting data
- * @ret rc Return status code
- */
- int generic_settings_store ( struct settings *settings,
- struct setting *setting,
- const void *data, size_t len ) {
- struct generic_settings *generics =
- container_of ( settings, struct generic_settings, settings );
- struct generic_setting *old;
- struct generic_setting *new = NULL;
- size_t name_len;
-
- /* Identify existing generic setting, if any */
- old = find_generic_setting ( generics, setting );
-
- /* Create new generic setting, if required */
- if ( len ) {
- /* Allocate new generic setting */
- name_len = ( strlen ( setting->name ) + 1 );
- new = zalloc ( sizeof ( *new ) + name_len + len );
- if ( ! new )
- return -ENOMEM;
-
- /* Populate new generic setting */
- new->name_len = name_len;
- new->data_len = len;
- memcpy ( &new->setting, setting, sizeof ( new->setting ) );
- new->setting.name = generic_setting_name ( new );
- memcpy ( generic_setting_name ( new ),
- setting->name, name_len );
- memcpy ( generic_setting_data ( new ), data, len );
- }
-
- /* Delete existing generic setting, if any */
- if ( old ) {
- list_del ( &old->list );
- free ( old );
- }
-
- /* Add new setting to list, if any */
- if ( new )
- list_add ( &new->list, &generics->list );
-
- return 0;
- }
-
- /**
- * Fetch value of generic setting
- *
- * @v settings Settings block
- * @v setting Setting to fetch
- * @v data Buffer to fill with setting data
- * @v len Length of buffer
- * @ret len Length of setting data, or negative error
- */
- int generic_settings_fetch ( struct settings *settings,
- struct setting *setting,
- void *data, size_t len ) {
- struct generic_settings *generics =
- container_of ( settings, struct generic_settings, settings );
- struct generic_setting *generic;
-
- /* Find generic setting */
- generic = find_generic_setting ( generics, setting );
- if ( ! generic )
- return -ENOENT;
-
- /* Copy out generic setting data */
- if ( len > generic->data_len )
- len = generic->data_len;
- memcpy ( data, generic_setting_data ( generic ), len );
-
- /* Set setting type, if not yet specified */
- if ( ! setting->type )
- setting->type = generic->setting.type;
-
- return generic->data_len;
- }
-
- /**
- * Clear generic settings block
- *
- * @v settings Settings block
- */
- void generic_settings_clear ( struct settings *settings ) {
- struct generic_settings *generics =
- container_of ( settings, struct generic_settings, settings );
- struct generic_setting *generic;
- struct generic_setting *tmp;
-
- list_for_each_entry_safe ( generic, tmp, &generics->list, list ) {
- list_del ( &generic->list );
- free ( generic );
- }
- assert ( list_empty ( &generics->list ) );
- }
-
- /** Generic settings operations */
- struct settings_operations generic_settings_operations = {
- .store = generic_settings_store,
- .fetch = generic_settings_fetch,
- .clear = generic_settings_clear,
- };
-
- /******************************************************************************
- *
- * Registered settings blocks
- *
- ******************************************************************************
- */
-
- /** Root generic settings block */
- struct generic_settings generic_settings_root = {
- .settings = {
- .refcnt = NULL,
- .name = "",
- .siblings =
- LIST_HEAD_INIT ( generic_settings_root.settings.siblings ),
- .children =
- LIST_HEAD_INIT ( generic_settings_root.settings.children ),
- .op = &generic_settings_operations,
- },
- .list = LIST_HEAD_INIT ( generic_settings_root.list ),
- };
-
- /** Root settings block */
- #define settings_root generic_settings_root.settings
-
- /** Autovivified settings block */
- struct autovivified_settings {
- /** Reference count */
- struct refcnt refcnt;
- /** Generic settings block */
- struct generic_settings generic;
- };
-
- /**
- * Free autovivified settings block
- *
- * @v refcnt Reference count
- */
- static void autovivified_settings_free ( struct refcnt *refcnt ) {
- struct autovivified_settings *autovivified =
- container_of ( refcnt, struct autovivified_settings, refcnt );
-
- generic_settings_clear ( &autovivified->generic.settings );
- free ( autovivified );
- }
-
- /**
- * Find child named settings block
- *
- * @v parent Parent settings block
- * @v name Name within this parent
- * @ret settings Settings block, or NULL
- */
- struct settings * find_child_settings ( struct settings *parent,
- const char *name ) {
- struct settings *settings;
-
- /* Treat empty name as meaning "this block" */
- if ( ! *name )
- return parent;
-
- /* Look for child with matching name */
- list_for_each_entry ( settings, &parent->children, siblings ) {
- if ( strcmp ( settings->name, name ) == 0 )
- return settings;
- }
-
- return NULL;
- }
-
- /**
- * Find or create child named settings block
- *
- * @v parent Parent settings block
- * @v name Name within this parent
- * @ret settings Settings block, or NULL
- */
- static struct settings * autovivify_child_settings ( struct settings *parent,
- const char *name ) {
- struct {
- struct autovivified_settings autovivified;
- char name[ strlen ( name ) + 1 /* NUL */ ];
- } *new_child;
- struct settings *settings;
-
- /* Return existing settings, if existent */
- if ( ( settings = find_child_settings ( parent, name ) ) != NULL )
- return settings;
-
- /* Create new generic settings block */
- new_child = zalloc ( sizeof ( *new_child ) );
- if ( ! new_child ) {
- DBGC ( parent, "Settings %p could not create child %s\n",
- parent, name );
- return NULL;
- }
- memcpy ( new_child->name, name, sizeof ( new_child->name ) );
- ref_init ( &new_child->autovivified.refcnt,
- autovivified_settings_free );
- generic_settings_init ( &new_child->autovivified.generic,
- &new_child->autovivified.refcnt );
- settings = &new_child->autovivified.generic.settings;
- register_settings ( settings, parent, new_child->name );
- return settings;
- }
-
- /**
- * Return settings block name
- *
- * @v settings Settings block
- * @ret name Settings block name
- */
- const char * settings_name ( struct settings *settings ) {
- static char buf[16];
- char tmp[ sizeof ( buf ) ];
-
- for ( buf[2] = buf[0] = 0 ; settings ; settings = settings->parent ) {
- memcpy ( tmp, buf, sizeof ( tmp ) );
- snprintf ( buf, sizeof ( buf ), ".%s%s", settings->name, tmp );
- }
- return ( buf + 2 );
- }
-
- /**
- * Parse settings block name
- *
- * @v name Name
- * @v get_child Function to find or create child settings block
- * @ret settings Settings block, or NULL
- */
- static struct settings *
- parse_settings_name ( const char *name,
- struct settings * ( * get_child ) ( struct settings *,
- const char * ) ) {
- struct settings *settings = &settings_root;
- char name_copy[ strlen ( name ) + 1 ];
- char *subname;
- char *remainder;
-
- /* Create modifiable copy of name */
- memcpy ( name_copy, name, sizeof ( name_copy ) );
- remainder = name_copy;
-
- /* Parse each name component in turn */
- while ( remainder ) {
- struct net_device *netdev;
-
- subname = remainder;
- remainder = strchr ( subname, '.' );
- if ( remainder )
- *(remainder++) = '\0';
-
- /* Special case "netX" root settings block */
- if ( ( subname == name_copy ) && ! strcmp ( subname, "netX" ) &&
- ( ( netdev = last_opened_netdev() ) != NULL ) )
- settings = get_child ( settings, netdev->name );
- else
- settings = get_child ( settings, subname );
-
- if ( ! settings )
- break;
- }
-
- return settings;
- }
-
- /**
- * Find named settings block
- *
- * @v name Name
- * @ret settings Settings block, or NULL
- */
- struct settings * find_settings ( const char *name ) {
-
- return parse_settings_name ( name, find_child_settings );
- }
-
- /**
- * Apply all settings
- *
- * @ret rc Return status code
- */
- static int apply_settings ( void ) {
- struct settings_applicator *applicator;
- int rc;
-
- /* Call all settings applicators */
- for_each_table_entry ( applicator, SETTINGS_APPLICATORS ) {
- if ( ( rc = applicator->apply() ) != 0 ) {
- DBG ( "Could not apply settings using applicator "
- "%p: %s\n", applicator, strerror ( rc ) );
- return rc;
- }
- }
-
- return 0;
- }
-
- /**
- * Reprioritise settings
- *
- * @v settings Settings block
- *
- * Reorders the settings block amongst its siblings according to its
- * priority.
- */
- static void reprioritise_settings ( struct settings *settings ) {
- struct settings *parent = settings->parent;
- long priority;
- struct settings *tmp;
- long tmp_priority;
-
- /* Stop when we reach the top of the tree */
- if ( ! parent )
- return;
-
- /* Read priority, if present */
- priority = fetch_intz_setting ( settings, &priority_setting );
-
- /* Remove from siblings list */
- list_del ( &settings->siblings );
-
- /* Reinsert after any existing blocks which have a higher priority */
- list_for_each_entry ( tmp, &parent->children, siblings ) {
- tmp_priority = fetch_intz_setting ( tmp, &priority_setting );
- if ( priority > tmp_priority )
- break;
- }
- list_add_tail ( &settings->siblings, &tmp->siblings );
-
- /* Recurse up the tree */
- reprioritise_settings ( parent );
- }
-
- /**
- * Register settings block
- *
- * @v settings Settings block
- * @v parent Parent settings block, or NULL
- * @v name Settings block name
- * @ret rc Return status code
- */
- int register_settings ( struct settings *settings, struct settings *parent,
- const char *name ) {
- struct settings *old_settings;
-
- /* NULL parent => add to settings root */
- assert ( settings != NULL );
- if ( parent == NULL )
- parent = &settings_root;
-
- /* Apply settings block name */
- settings->name = name;
-
- /* Remove any existing settings with the same name */
- if ( ( old_settings = find_child_settings ( parent, settings->name ) ))
- unregister_settings ( old_settings );
-
- /* Add to list of settings */
- ref_get ( settings->refcnt );
- ref_get ( parent->refcnt );
- settings->parent = parent;
- list_add_tail ( &settings->siblings, &parent->children );
- DBGC ( settings, "Settings %p (\"%s\") registered\n",
- settings, settings_name ( settings ) );
-
- /* Fix up settings priority */
- reprioritise_settings ( settings );
-
- /* Apply potentially-updated settings */
- apply_settings();
-
- return 0;
- }
-
- /**
- * Unregister settings block
- *
- * @v settings Settings block
- */
- void unregister_settings ( struct settings *settings ) {
- struct settings *child;
- struct settings *tmp;
-
- /* Unregister child settings */
- list_for_each_entry_safe ( child, tmp, &settings->children, siblings ) {
- unregister_settings ( child );
- }
-
- DBGC ( settings, "Settings %p (\"%s\") unregistered\n",
- settings, settings_name ( settings ) );
-
- /* Remove from list of settings */
- ref_put ( settings->parent->refcnt );
- settings->parent = NULL;
- list_del ( &settings->siblings );
- ref_put ( settings->refcnt );
-
- /* Apply potentially-updated settings */
- apply_settings();
- }
-
- /******************************************************************************
- *
- * Core settings routines
- *
- ******************************************************************************
- */
-
- /**
- * Check applicability of setting
- *
- * @v settings Settings block
- * @v setting Setting
- * @ret applies Setting applies within this settings block
- */
- int setting_applies ( struct settings *settings, struct setting *setting ) {
-
- return ( settings->op->applies ?
- settings->op->applies ( settings, setting ) : 1 );
- }
-
- /**
- * Store value of setting
- *
- * @v settings Settings block, or NULL
- * @v setting Setting to store
- * @v data Setting data, or NULL to clear setting
- * @v len Length of setting data
- * @ret rc Return status code
- */
- int store_setting ( struct settings *settings, struct setting *setting,
- const void *data, size_t len ) {
- int rc;
-
- /* NULL settings implies storing into the global settings root */
- if ( ! settings )
- settings = &settings_root;
-
- /* Fail if tag does not apply to this settings block */
- if ( ! setting_applies ( settings, setting ) )
- return -ENOTTY;
-
- /* Sanity check */
- if ( ! settings->op->store )
- return -ENOTSUP;
-
- /* Store setting */
- if ( ( rc = settings->op->store ( settings, setting,
- data, len ) ) != 0 )
- return rc;
-
- /* Reprioritise settings if necessary */
- if ( setting_cmp ( setting, &priority_setting ) == 0 )
- reprioritise_settings ( settings );
-
- /* If these settings are registered, apply potentially-updated
- * settings
- */
- for ( ; settings ; settings = settings->parent ) {
- if ( settings == &settings_root ) {
- if ( ( rc = apply_settings() ) != 0 )
- return rc;
- break;
- }
- }
-
- return 0;
- }
-
- /**
- * Fetch value and origin of setting
- *
- * @v settings Settings block, or NULL to search all blocks
- * @v setting Setting to fetch
- * @v origin Origin of setting to fill in
- * @v data Buffer to fill with setting data
- * @v len Length of buffer
- * @ret len Length of setting data, or negative error
- *
- * The actual length of the setting will be returned even if
- * the buffer was too small.
- */
- static int fetch_setting_and_origin ( struct settings *settings,
- struct setting *setting,
- struct settings **origin,
- void *data, size_t len ) {
- struct settings *child;
- int ret;
-
- /* Avoid returning uninitialised data on error */
- memset ( data, 0, len );
- if ( origin )
- *origin = NULL;
-
- /* NULL settings implies starting at the global settings root */
- if ( ! settings )
- settings = &settings_root;
-
- /* Sanity check */
- if ( ! settings->op->fetch )
- return -ENOTSUP;
-
- /* Try this block first, if applicable */
- if ( setting_applies ( settings, setting ) &&
- ( ( ret = settings->op->fetch ( settings, setting,
- data, len ) ) >= 0 ) ) {
- /* Record origin, if applicable */
- if ( origin )
- *origin = settings;
- /* Default to string setting type, if not yet specified */
- if ( ! setting->type )
- setting->type = &setting_type_string;
- return ret;
- }
-
- /* Recurse into each child block in turn */
- list_for_each_entry ( child, &settings->children, siblings ) {
- if ( ( ret = fetch_setting_and_origin ( child, setting, origin,
- data, len ) ) >= 0 )
- return ret;
- }
-
- return -ENOENT;
- }
-
- /**
- * Fetch value of setting
- *
- * @v settings Settings block, or NULL to search all blocks
- * @v setting Setting to fetch
- * @v data Buffer to fill with setting data
- * @v len Length of buffer
- * @ret len Length of setting data, or negative error
- *
- * The actual length of the setting will be returned even if
- * the buffer was too small.
- */
- int fetch_setting ( struct settings *settings, struct setting *setting,
- void *data, size_t len ) {
- return fetch_setting_and_origin ( settings, setting, NULL, data, len );
- }
-
- /**
- * Fetch origin of setting
- *
- * @v settings Settings block, or NULL to search all blocks
- * @v setting Setting to fetch
- * @ret origin Origin of setting, or NULL if not found
- *
- * This function can also be used as an existence check for the
- * setting.
- */
- struct settings * fetch_setting_origin ( struct settings *settings,
- struct setting *setting ) {
- struct settings *origin;
-
- fetch_setting_and_origin ( settings, setting, &origin, NULL, 0 );
- return origin;
- }
-
- /**
- * Fetch length of setting
- *
- * @v settings Settings block, or NULL to search all blocks
- * @v setting Setting to fetch
- * @ret len Length of setting data, or negative error
- *
- * This function can also be used as an existence check for the
- * setting.
- */
- int fetch_setting_len ( struct settings *settings, struct setting *setting ) {
- return fetch_setting ( settings, setting, NULL, 0 );
- }
-
- /**
- * Fetch copy of setting
- *
- * @v settings Settings block, or NULL to search all blocks
- * @v setting Setting to fetch
- * @v data Buffer to allocate and fill with setting data
- * @ret len Length of setting, or negative error
- *
- * The caller is responsible for eventually freeing the allocated
- * buffer.
- *
- * To allow the caller to distinguish between a non-existent setting
- * and an error in allocating memory for the copy, this function will
- * return success (and a NULL buffer pointer) for a non-existent
- * setting.
- */
- int fetch_setting_copy ( struct settings *settings, struct setting *setting,
- void **data ) {
- int len;
- int check_len = 0;
-
- /* Avoid returning uninitialised data on error */
- *data = NULL;
-
- /* Fetch setting length, and return success if non-existent */
- len = fetch_setting_len ( settings, setting );
- if ( len < 0 )
- return 0;
-
- /* Allocate buffer */
- *data = malloc ( len );
- if ( ! *data )
- return -ENOMEM;
-
- /* Fetch setting */
- check_len = fetch_setting ( settings, setting, *data, len );
- assert ( check_len == len );
- return len;
- }
-
- /**
- * Fetch value of string setting
- *
- * @v settings Settings block, or NULL to search all blocks
- * @v setting Setting to fetch
- * @v data Buffer to fill with setting string data
- * @v len Length of buffer
- * @ret len Length of string setting, or negative error
- *
- * The resulting string is guaranteed to be correctly NUL-terminated.
- * The returned length will be the length of the underlying setting
- * data.
- */
- int fetch_string_setting ( struct settings *settings, struct setting *setting,
- char *data, size_t len ) {
- memset ( data, 0, len );
- return fetch_setting ( settings, setting, data,
- ( ( len > 0 ) ? ( len - 1 ) : 0 ) );
- }
-
- /**
- * Fetch value of string setting
- *
- * @v settings Settings block, or NULL to search all blocks
- * @v setting Setting to fetch
- * @v data Buffer to allocate and fill with setting string data
- * @ret len Length of string setting, or negative error
- *
- * The resulting string is guaranteed to be correctly NUL-terminated.
- * The returned length will be the length of the underlying setting
- * data. The caller is responsible for eventually freeing the
- * allocated buffer.
- *
- * To allow the caller to distinguish between a non-existent setting
- * and an error in allocating memory for the copy, this function will
- * return success (and a NULL buffer pointer) for a non-existent
- * setting.
- */
- int fetch_string_setting_copy ( struct settings *settings,
- struct setting *setting,
- char **data ) {
- int len;
- int check_len = 0;
-
- /* Avoid returning uninitialised data on error */
- *data = NULL;
-
- /* Fetch setting length, and return success if non-existent */
- len = fetch_setting_len ( settings, setting );
- if ( len < 0 )
- return 0;
-
- /* Allocate string buffer */
- *data = malloc ( len + 1 );
- if ( ! *data )
- return -ENOMEM;
-
- /* Fetch setting */
- check_len = fetch_string_setting ( settings, setting, *data,
- ( len + 1 ) );
- assert ( check_len == len );
- return len;
- }
-
- /**
- * Fetch value of IPv4 address setting
- *
- * @v settings Settings block, or NULL to search all blocks
- * @v setting Setting to fetch
- * @v inp IPv4 addresses to fill in
- * @v count Maximum number of IPv4 addresses
- * @ret len Length of setting, or negative error
- */
- int fetch_ipv4_array_setting ( struct settings *settings,
- struct setting *setting,
- struct in_addr *inp, unsigned int count ) {
- int len;
-
- len = fetch_setting ( settings, setting, inp,
- ( sizeof ( *inp ) * count ) );
- if ( len < 0 )
- return len;
- if ( ( len % sizeof ( *inp ) ) != 0 )
- return -ERANGE;
- return len;
- }
-
- /**
- * Fetch value of IPv4 address setting
- *
- * @v settings Settings block, or NULL to search all blocks
- * @v setting Setting to fetch
- * @v inp IPv4 address to fill in
- * @ret len Length of setting, or negative error
- */
- int fetch_ipv4_setting ( struct settings *settings, struct setting *setting,
- struct in_addr *inp ) {
- return fetch_ipv4_array_setting ( settings, setting, inp, 1 );
- }
-
- /**
- * Extract numeric value of setting
- *
- * @v raw Raw setting data
- * @v len Length of raw setting data
- * @ret signed_value Value, when interpreted as a signed integer
- * @ret unsigned_value Value, when interpreted as an unsigned integer
- * @ret len Length of setting, or negative error
- */
- static int numeric_setting_value ( const void *raw, size_t len,
- signed long *signed_value,
- unsigned long *unsigned_value ) {
- const uint8_t *unsigned_bytes = raw;
- const int8_t *signed_bytes = raw;
- int is_negative;
- unsigned int i;
- uint8_t byte;
-
- /* Range check */
- if ( len > sizeof ( long ) )
- return -ERANGE;
-
- /* Convert to host-ordered longs */
- is_negative = ( len && ( signed_bytes[0] < 0 ) );
- *signed_value = ( is_negative ? -1L : 0 );
- *unsigned_value = 0;
- for ( i = 0 ; i < len ; i++ ) {
- byte = unsigned_bytes[i];
- *signed_value = ( ( *signed_value << 8 ) | byte );
- *unsigned_value = ( ( *unsigned_value << 8 ) | byte );
- }
-
- return len;
- }
-
- /**
- * Fetch value of signed integer setting
- *
- * @v settings Settings block, or NULL to search all blocks
- * @v setting Setting to fetch
- * @v value Integer value to fill in
- * @ret len Length of setting, or negative error
- */
- int fetch_int_setting ( struct settings *settings, struct setting *setting,
- long *value ) {
- unsigned long dummy;
- long tmp;
- int len;
-
- /* Avoid returning uninitialised data on error */
- *value = 0;
-
- /* Fetch raw (network-ordered, variable-length) setting */
- len = fetch_setting ( settings, setting, &tmp, sizeof ( tmp ) );
- if ( len < 0 )
- return len;
-
- /* Extract numeric value */
- return numeric_setting_value ( &tmp, len, value, &dummy );
- }
-
- /**
- * Fetch value of unsigned integer setting
- *
- * @v settings Settings block, or NULL to search all blocks
- * @v setting Setting to fetch
- * @v value Integer value to fill in
- * @ret len Length of setting, or negative error
- */
- int fetch_uint_setting ( struct settings *settings, struct setting *setting,
- unsigned long *value ) {
- signed long dummy;
- long tmp;
- int len;
-
- /* Avoid returning uninitialised data on error */
- *value = 0;
-
- /* Fetch raw (network-ordered, variable-length) setting */
- len = fetch_setting ( settings, setting, &tmp, sizeof ( tmp ) );
- if ( len < 0 )
- return len;
-
- /* Extract numeric value */
- return numeric_setting_value ( &tmp, len, &dummy, value );
- }
-
- /**
- * Fetch value of signed integer setting, or zero
- *
- * @v settings Settings block, or NULL to search all blocks
- * @v setting Setting to fetch
- * @ret value Setting value, or zero
- */
- long fetch_intz_setting ( struct settings *settings, struct setting *setting ){
- long value;
-
- fetch_int_setting ( settings, setting, &value );
- return value;
- }
-
- /**
- * Fetch value of unsigned integer setting, or zero
- *
- * @v settings Settings block, or NULL to search all blocks
- * @v setting Setting to fetch
- * @ret value Setting value, or zero
- */
- unsigned long fetch_uintz_setting ( struct settings *settings,
- struct setting *setting ) {
- unsigned long value;
-
- fetch_uint_setting ( settings, setting, &value );
- return value;
- }
-
- /**
- * Fetch value of UUID setting
- *
- * @v settings Settings block, or NULL to search all blocks
- * @v setting Setting to fetch
- * @v uuid UUID to fill in
- * @ret len Length of setting, or negative error
- */
- int fetch_uuid_setting ( struct settings *settings, struct setting *setting,
- union uuid *uuid ) {
- int len;
-
- len = fetch_setting ( settings, setting, uuid, sizeof ( *uuid ) );
- if ( len < 0 )
- return len;
- if ( len != sizeof ( *uuid ) )
- return -ERANGE;
- return len;
- }
-
- /**
- * Clear settings block
- *
- * @v settings Settings block
- */
- void clear_settings ( struct settings *settings ) {
- if ( settings->op->clear )
- settings->op->clear ( settings );
- }
-
- /**
- * Compare two settings
- *
- * @v a Setting to compare
- * @v b Setting to compare
- * @ret 0 Settings are the same
- * @ret non-zero Settings are not the same
- */
- int setting_cmp ( struct setting *a, struct setting *b ) {
-
- /* If the settings have tags, compare them */
- if ( a->tag && ( a->tag == b->tag ) )
- return 0;
-
- /* Otherwise, if the settings have names, compare them */
- if ( a->name && b->name && a->name[0] )
- return strcmp ( a->name, b->name );
-
- /* Otherwise, return a non-match */
- return ( ! 0 );
- }
-
- /******************************************************************************
- *
- * Formatted setting routines
- *
- ******************************************************************************
- */
-
- /**
- * Fetch and format value of setting
- *
- * @v settings Settings block, or NULL to search all blocks
- * @v setting Setting to fetch
- * @v type Settings type
- * @v buf Buffer to contain formatted value
- * @v len Length of buffer
- * @ret len Length of formatted value, or negative error
- */
- int fetchf_setting ( struct settings *settings, struct setting *setting,
- char *buf, size_t len ) {
- int raw_len;
- int check_len;
- int rc;
-
- /* Fetch raw value */
- raw_len = fetch_setting_len ( settings, setting );
- if ( raw_len < 0 ) {
- rc = raw_len;
- return rc;
- } else {
- uint8_t raw[raw_len];
-
- /* Fetch raw value */
- check_len = fetch_setting ( settings, setting, raw,
- sizeof ( raw ) );
- if ( check_len < 0 )
- return check_len;
- assert ( check_len == raw_len );
-
- /* Format value */
- return setting->type->format ( raw, sizeof ( raw ), buf, len );
- }
- }
-
- /**
- * Store formatted value of setting
- *
- * @v settings Settings block
- * @v setting Setting to store
- * @v value Formatted setting data, or NULL
- * @ret rc Return status code
- */
- int storef_setting ( struct settings *settings, struct setting *setting,
- const char *value ) {
- int raw_len;
- int check_len;
- int rc;
-
- /* NULL value or empty string implies deletion */
- if ( ( ! value ) || ( ! value[0] ) )
- return delete_setting ( settings, setting );
-
- /* Parse formatted value */
- raw_len = setting->type->parse ( value, NULL, 0 );
- if ( raw_len < 0 ) {
- rc = raw_len;
- return rc;
- } else {
- uint8_t raw[raw_len];
-
- /* Parse formatted value */
- check_len = setting->type->parse ( value, raw, sizeof ( raw ) );
- assert ( check_len == raw_len );
-
- /* Store raw value */
- return store_setting ( settings, setting, raw, sizeof ( raw ) );
- }
- }
-
- /******************************************************************************
- *
- * Named settings
- *
- ******************************************************************************
- */
-
- /**
- * Find named setting
- *
- * @v name Name
- * @ret setting Named setting, or NULL
- */
- struct setting * find_setting ( const char *name ) {
- struct setting *setting;
-
- for_each_table_entry ( setting, SETTINGS ) {
- if ( strcmp ( name, setting->name ) == 0 )
- return setting;
- }
- return NULL;
- }
-
- /**
- * Parse setting name as tag number
- *
- * @v settings Settings block
- * @v name Name
- * @ret tag Tag number, or 0 if not a valid number
- */
- static unsigned int parse_setting_tag ( struct settings *settings,
- const char *name ) {
- char *tmp = ( ( char * ) name );
- unsigned int tag = 0;
-
- while ( 1 ) {
- tag = ( ( tag << 8 ) | strtoul ( tmp, &tmp, 0 ) );
- if ( *tmp == 0 )
- return ( tag | settings->tag_magic );
- if ( *tmp != '.' )
- return 0;
- tmp++;
- }
- }
-
- /**
- * Find setting type
- *
- * @v name Name
- * @ret type Setting type, or NULL
- */
- static struct setting_type * find_setting_type ( const char *name ) {
- struct setting_type *type;
-
- for_each_table_entry ( type, SETTING_TYPES ) {
- if ( strcmp ( name, type->name ) == 0 )
- return type;
- }
- return NULL;
- }
-
- /**
- * Parse setting name
- *
- * @v name Name of setting
- * @v get_child Function to find or create child settings block
- * @v settings Settings block to fill in
- * @v setting Setting to fill in
- * @v default_type Default type to use, if none specified
- * @v tmp_name Buffer for copy of setting name
- * @ret rc Return status code
- *
- * Interprets a name of the form
- * "[settings_name/]tag_name[:type_name]" and fills in the appropriate
- * fields.
- *
- * The @c tmp_name buffer must be large enough to hold a copy of the
- * setting name.
- */
- static int
- parse_setting_name ( const char *name,
- struct settings * ( * get_child ) ( struct settings *,
- const char * ),
- struct settings **settings, struct setting *setting,
- struct setting_type *default_type,
- char *tmp_name ) {
- char *settings_name;
- char *setting_name;
- char *type_name;
- struct setting *named_setting;
-
- /* Set defaults */
- *settings = &settings_root;
- memset ( setting, 0, sizeof ( *setting ) );
- setting->name = "";
- setting->type = default_type;
-
- /* Split name into "[settings_name/]setting_name[:type_name]" */
- strcpy ( tmp_name, name );
- if ( ( setting_name = strchr ( tmp_name, '/' ) ) != NULL ) {
- *(setting_name++) = 0;
- settings_name = tmp_name;
- } else {
- setting_name = tmp_name;
- settings_name = NULL;
- }
- if ( ( type_name = strchr ( setting_name, ':' ) ) != NULL )
- *(type_name++) = 0;
-
- /* Identify settings block, if specified */
- if ( settings_name ) {
- *settings = parse_settings_name ( settings_name, get_child );
- if ( *settings == NULL ) {
- DBG ( "Unrecognised settings block \"%s\" in \"%s\"\n",
- settings_name, name );
- return -ENODEV;
- }
- }
-
- /* Identify setting */
- setting->tag = parse_setting_tag ( *settings, setting_name );
- setting->name = setting_name;
- for_each_table_entry ( named_setting, SETTINGS ) {
- /* Matches a defined named setting; use that setting */
- if ( setting_cmp ( named_setting, setting ) == 0 ) {
- memcpy ( setting, named_setting, sizeof ( *setting ) );
- break;
- }
- }
-
- /* Identify setting type, if specified */
- if ( type_name ) {
- setting->type = find_setting_type ( type_name );
- if ( setting->type == NULL ) {
- DBG ( "Invalid setting type \"%s\" in \"%s\"\n",
- type_name, name );
- return -ENOTSUP;
- }
- }
-
- return 0;
- }
-
- /**
- * Return full setting name
- *
- * @v settings Settings block, or NULL
- * @v setting Setting
- * @v buf Buffer
- * @v len Length of buffer
- * @ret len Length of setting name, or negative error
- */
- int setting_name ( struct settings *settings, struct setting *setting,
- char *buf, size_t len ) {
- const char *name;
-
- if ( ! settings )
- settings = &settings_root;
-
- name = settings_name ( settings );
- return snprintf ( buf, len, "%s%s%s:%s", name, ( name[0] ? "/" : "" ),
- setting->name, setting->type->name );
- }
-
- /**
- * Store value of named setting
- *
- * @v name Name of setting
- * @v default_type Default type to use, if none specified
- * @v data Setting data, or NULL to clear setting
- * @v len Length of setting data
- * @ret rc Return status code
- */
- int store_named_setting ( const char *name, struct setting_type *default_type,
- const void *data, size_t len ) {
- struct settings *settings;
- struct setting setting;
- char tmp_name[ strlen ( name ) + 1 ];
- int rc;
-
- /* Parse setting name */
- if ( ( rc = parse_setting_name ( name, autovivify_child_settings,
- &settings, &setting, default_type,
- tmp_name ) ) != 0 )
- return rc;
-
- /* Store setting */
- if ( ( rc = store_setting ( settings, &setting, data, len ) ) != 0 )
- return rc;
-
- return 0;
- }
-
- /**
- * Parse and store value of named setting
- *
- * @v name Name of setting
- * @v default_type Default type to use, if none specified
- * @v value Formatted setting data, or NULL
- * @ret rc Return status code
- */
- int storef_named_setting ( const char *name, struct setting_type *default_type,
- const char *value ) {
- struct settings *settings;
- struct setting setting;
- char tmp_name[ strlen ( name ) + 1 ];
- int rc;
-
- /* Parse setting name */
- if ( ( rc = parse_setting_name ( name, autovivify_child_settings,
- &settings, &setting, default_type,
- tmp_name ) ) != 0 )
- return rc;
-
- /* Store setting */
- if ( ( rc = storef_setting ( settings, &setting, value ) ) != 0 )
- return rc;
-
- return 0;
- }
-
- /**
- * Fetch and format value of named setting
- *
- * @v name Name of setting
- * @v name_buf Buffer to contain canonicalised name
- * @v name_len Length of canonicalised name buffer
- * @v value_buf Buffer to contain formatted value
- * @v value_len Length of formatted value buffer
- * @ret len Length of formatted value, or negative error
- */
- int fetchf_named_setting ( const char *name,
- char *name_buf, size_t name_len,
- char *value_buf, size_t value_len ) {
- struct settings *settings;
- struct setting setting;
- struct settings *origin;
- char tmp_name[ strlen ( name ) + 1 ];
- int len;
- int rc;
-
- /* Parse setting name */
- if ( ( rc = parse_setting_name ( name, find_child_settings, &settings,
- &setting, NULL, tmp_name ) ) != 0 )
- return rc;
-
- /* Fetch setting */
- if ( ( len = fetchf_setting ( settings, &setting, value_buf,
- value_len ) ) < 0 )
- return len;
-
- /* Construct setting name */
- origin = fetch_setting_origin ( settings, &setting );
- assert ( origin != NULL );
- setting_name ( origin, &setting, name_buf, name_len );
-
- return len;
- }
-
- /**
- * Fetch and format copy of value of named setting
- *
- * @v name Name of setting
- * @v data Buffer to allocate and fill with formatted value
- * @ret len Length of formatted value, or negative error
- *
- * The caller is responsible for eventually freeing the allocated
- * buffer.
- *
- * To allow the caller to distinguish between a non-existent setting
- * and an error in allocating memory for the copy, this function will
- * return success (and a NULL buffer pointer) for a non-existent
- * setting.
- */
- int fetchf_named_setting_copy ( const char *name, char **data ) {
- int len;
- int check_len;
-
- /* Avoid returning uninitialised data on error */
- *data = NULL;
-
- /* Fetch formatted value length, and return success if non-existent */
- len = fetchf_named_setting ( name, NULL, 0, NULL, 0 );
- if ( len < 0 )
- return 0;
-
- /* Allocate buffer */
- *data = malloc ( len + 1 /* NUL */ );
- if ( ! *data )
- return -ENOMEM;
-
- /* Fetch formatted value */
- check_len = fetchf_named_setting ( name, NULL, 0, *data,
- ( len + 1 /* NUL */ ) );
- assert ( check_len == len );
- return len;
- }
-
- /******************************************************************************
- *
- * Setting types
- *
- ******************************************************************************
- */
-
- /**
- * Parse string setting value
- *
- * @v value Formatted setting value
- * @v buf Buffer to contain raw value
- * @v len Length of buffer
- * @ret len Length of raw value, or negative error
- */
- static int parse_string_setting ( const char *value, void *buf, size_t len ) {
- size_t raw_len = strlen ( value ); /* Exclude terminating NUL */
-
- /* Copy string to buffer */
- if ( len > raw_len )
- len = raw_len;
- memcpy ( buf, value, len );
-
- return raw_len;
- }
-
- /**
- * Format string setting value
- *
- * @v raw Raw setting value
- * @v raw_len Length of raw setting value
- * @v buf Buffer to contain formatted value
- * @v len Length of buffer
- * @ret len Length of formatted value, or negative error
- */
- static int format_string_setting ( const void *raw, size_t raw_len, char *buf,
- size_t len ) {
-
- /* Copy string to buffer, and terminate */
- memset ( buf, 0, len );
- if ( len > raw_len )
- len = raw_len;
- memcpy ( buf, raw, len );
-
- return raw_len;
- }
-
- /** A string setting type */
- struct setting_type setting_type_string __setting_type = {
- .name = "string",
- .parse = parse_string_setting,
- .format = format_string_setting,
- };
-
- /**
- * Parse URI-encoded string setting value
- *
- * @v value Formatted setting value
- * @v buf Buffer to contain raw value
- * @v len Length of buffer
- * @ret len Length of raw value, or negative error
- */
- static int parse_uristring_setting ( const char *value, void *buf,
- size_t len ) {
- char tmp[ len + 1 /* NUL */ ];
- size_t raw_len;
-
- /* Decode to temporary buffer (including NUL) */
- raw_len = uri_decode ( value, tmp, sizeof ( tmp ) );
-
- /* Copy to output buffer (excluding NUL) */
- if ( len > raw_len )
- len = raw_len;
- memcpy ( buf, tmp, len );
-
- return raw_len;
- }
-
- /**
- * Format URI-encoded string setting value
- *
- * @v raw Raw setting value
- * @v raw_len Length of raw setting value
- * @v buf Buffer to contain formatted value
- * @v len Length of buffer
- * @ret len Length of formatted value, or negative error
- */
- static int format_uristring_setting ( const void *raw, size_t raw_len,
- char *buf, size_t len ) {
- char tmp[ raw_len + 1 /* NUL */ ];
-
- /* Copy to temporary buffer and terminate */
- memcpy ( tmp, raw, raw_len );
- tmp[raw_len] = '\0';
-
- /* Encode directly into output buffer */
- return uri_encode ( tmp, buf, len, URI_FRAGMENT );
- }
-
- /** A URI-encoded string setting type */
- struct setting_type setting_type_uristring __setting_type = {
- .name = "uristring",
- .parse = parse_uristring_setting,
- .format = format_uristring_setting,
- };
-
- /**
- * Parse IPv4 address setting value
- *
- * @v value Formatted setting value
- * @v buf Buffer to contain raw value
- * @v len Length of buffer
- * @ret len Length of raw value, or negative error
- */
- static int parse_ipv4_setting ( const char *value, void *buf, size_t len ) {
- struct in_addr ipv4;
-
- /* Parse IPv4 address */
- if ( inet_aton ( value, &ipv4 ) == 0 )
- return -EINVAL;
-
- /* Copy to buffer */
- if ( len > sizeof ( ipv4 ) )
- len = sizeof ( ipv4 );
- memcpy ( buf, &ipv4, len );
-
- return ( sizeof ( ipv4 ) );
- }
-
- /**
- * Format IPv4 address setting value
- *
- * @v raw Raw setting value
- * @v raw_len Length of raw setting value
- * @v buf Buffer to contain formatted value
- * @v len Length of buffer
- * @ret len Length of formatted value, or negative error
- */
- static int format_ipv4_setting ( const void *raw, size_t raw_len, char *buf,
- size_t len ) {
- const struct in_addr *ipv4 = raw;
-
- if ( raw_len < sizeof ( *ipv4 ) )
- return -EINVAL;
- return snprintf ( buf, len, "%s", inet_ntoa ( *ipv4 ) );
- }
-
- /** An IPv4 address setting type */
- struct setting_type setting_type_ipv4 __setting_type = {
- .name = "ipv4",
- .parse = parse_ipv4_setting,
- .format = format_ipv4_setting,
- };
-
- /**
- * Parse integer setting value
- *
- * @v value Formatted setting value
- * @v buf Buffer to contain raw value
- * @v len Length of buffer
- * @v size Integer size, in bytes
- * @ret len Length of raw value, or negative error
- */
- static int parse_int_setting ( const char *value, void *buf, size_t len,
- unsigned int size ) {
- union {
- uint32_t num;
- uint8_t bytes[4];
- } u;
- char *endp;
-
- /* Parse value */
- u.num = htonl ( strtoul ( value, &endp, 0 ) );
- if ( *endp )
- return -EINVAL;
-
- /* Copy to buffer */
- if ( len > size )
- len = size;
- memcpy ( buf, &u.bytes[ sizeof ( u ) - size ], len );
-
- return size;
- }
-
- /**
- * Parse 8-bit integer setting value
- *
- * @v value Formatted setting value
- * @v buf Buffer to contain raw value
- * @v len Length of buffer
- * @v size Integer size, in bytes
- * @ret len Length of raw value, or negative error
- */
- static int parse_int8_setting ( const char *value, void *buf, size_t len ) {
- return parse_int_setting ( value, buf, len, sizeof ( uint8_t ) );
- }
-
- /**
- * Parse 16-bit integer setting value
- *
- * @v value Formatted setting value
- * @v buf Buffer to contain raw value
- * @v len Length of buffer
- * @v size Integer size, in bytes
- * @ret len Length of raw value, or negative error
- */
- static int parse_int16_setting ( const char *value, void *buf, size_t len ) {
- return parse_int_setting ( value, buf, len, sizeof ( uint16_t ) );
- }
-
- /**
- * Parse 32-bit integer setting value
- *
- * @v value Formatted setting value
- * @v buf Buffer to contain raw value
- * @v len Length of buffer
- * @v size Integer size, in bytes
- * @ret len Length of raw value, or negative error
- */
- static int parse_int32_setting ( const char *value, void *buf, size_t len ) {
- return parse_int_setting ( value, buf, len, sizeof ( uint32_t ) );
- }
-
- /**
- * Format signed integer setting value
- *
- * @v raw Raw setting value
- * @v raw_len Length of raw setting value
- * @v buf Buffer to contain formatted value
- * @v len Length of buffer
- * @ret len Length of formatted value, or negative error
- */
- static int format_int_setting ( const void *raw, size_t raw_len, char *buf,
- size_t len ) {
- signed long value;
- unsigned long dummy;
- int check_len;
-
- /* Extract numeric value */
- check_len = numeric_setting_value ( raw, raw_len, &value, &dummy );
- if ( check_len < 0 )
- return check_len;
- assert ( check_len == ( int ) raw_len );
-
- /* Format value */
- return snprintf ( buf, len, "%ld", value );
- }
-
- /**
- * Format unsigned integer setting value
- *
- * @v raw Raw setting value
- * @v raw_len Length of raw setting value
- * @v buf Buffer to contain formatted value
- * @v len Length of buffer
- * @ret len Length of formatted value, or negative error
- */
- static int format_uint_setting ( const void *raw, size_t raw_len, char *buf,
- size_t len ) {
- signed long dummy;
- unsigned long value;
- int check_len;
-
- /* Extract numeric value */
- check_len = numeric_setting_value ( raw, raw_len, &dummy, &value );
- if ( check_len < 0 )
- return check_len;
- assert ( check_len == ( int ) raw_len );
-
- /* Format value */
- return snprintf ( buf, len, "%#lx", value );
- }
-
- /** A signed 8-bit integer setting type */
- struct setting_type setting_type_int8 __setting_type = {
- .name = "int8",
- .parse = parse_int8_setting,
- .format = format_int_setting,
- };
-
- /** A signed 16-bit integer setting type */
- struct setting_type setting_type_int16 __setting_type = {
- .name = "int16",
- .parse = parse_int16_setting,
- .format = format_int_setting,
- };
-
- /** A signed 32-bit integer setting type */
- struct setting_type setting_type_int32 __setting_type = {
- .name = "int32",
- .parse = parse_int32_setting,
- .format = format_int_setting,
- };
-
- /** An unsigned 8-bit integer setting type */
- struct setting_type setting_type_uint8 __setting_type = {
- .name = "uint8",
- .parse = parse_int8_setting,
- .format = format_uint_setting,
- };
-
- /** An unsigned 16-bit integer setting type */
- struct setting_type setting_type_uint16 __setting_type = {
- .name = "uint16",
- .parse = parse_int16_setting,
- .format = format_uint_setting,
- };
-
- /** An unsigned 32-bit integer setting type */
- struct setting_type setting_type_uint32 __setting_type = {
- .name = "uint32",
- .parse = parse_int32_setting,
- .format = format_uint_setting,
- };
-
- /**
- * Parse hex string setting value
- *
- * @v value Formatted setting value
- * @v buf Buffer to contain raw value
- * @v len Length of buffer
- * @ret len Length of raw value, or negative error
- */
- static int parse_hex_setting ( const char *value, void *buf, size_t len ) {
- char *ptr = ( char * ) value;
- uint8_t *bytes = buf;
- unsigned int count = 0;
- uint8_t byte;
-
- while ( 1 ) {
- byte = strtoul ( ptr, &ptr, 16 );
- if ( count++ < len )
- *bytes++ = byte;
- switch ( *ptr ) {
- case '\0' :
- return count;
- case ':' :
- case '-' :
- ptr++;
- break;
- default :
- return -EINVAL;
- }
- }
- }
-
- /**
- * Format hex string setting value
- *
- * @v raw Raw setting value
- * @v raw_len Length of raw setting value
- * @v buf Buffer to contain formatted value
- * @v len Length of buffer
- * @v delimiter Byte delimiter
- * @ret len Length of formatted value, or negative error
- */
- static int format_hex_setting ( const void *raw, size_t raw_len, char *buf,
- size_t len, const char *delimiter ) {
- const uint8_t *bytes = raw;
- int used = 0;
- unsigned int i;
-
- if ( len )
- buf[0] = 0; /* Ensure that a terminating NUL exists */
- for ( i = 0 ; i < raw_len ; i++ ) {
- used += ssnprintf ( ( buf + used ), ( len - used ),
- "%s%02x", ( used ? delimiter : "" ),
- bytes[i] );
- }
- return used;
- }
-
- /**
- * Format hex string setting value (using colon delimiter)
- *
- * @v raw Raw setting value
- * @v raw_len Length of raw setting value
- * @v buf Buffer to contain formatted value
- * @v len Length of buffer
- * @ret len Length of formatted value, or negative error
- */
- static int format_hex_colon_setting ( const void *raw, size_t raw_len,
- char *buf, size_t len ) {
- return format_hex_setting ( raw, raw_len, buf, len, ":" );
- }
-
- /**
- * Format hex string setting value (using hyphen delimiter)
- *
- * @v raw Raw setting value
- * @v raw_len Length of raw setting value
- * @v buf Buffer to contain formatted value
- * @v len Length of buffer
- * @ret len Length of formatted value, or negative error
- */
- static int format_hex_hyphen_setting ( const void *raw, size_t raw_len,
- char *buf, size_t len ) {
- return format_hex_setting ( raw, raw_len, buf, len, "-" );
- }
-
- /** A hex-string setting (colon-delimited) */
- struct setting_type setting_type_hex __setting_type = {
- .name = "hex",
- .parse = parse_hex_setting,
- .format = format_hex_colon_setting,
- };
-
- /** A hex-string setting (hyphen-delimited) */
- struct setting_type setting_type_hexhyp __setting_type = {
- .name = "hexhyp",
- .parse = parse_hex_setting,
- .format = format_hex_hyphen_setting,
- };
-
- /**
- * Parse UUID setting value
- *
- * @v value Formatted setting value
- * @v buf Buffer to contain raw value
- * @v len Length of buffer
- * @ret len Length of raw value, or negative error
- */
- static int parse_uuid_setting ( const char *value __unused,
- void *buf __unused, size_t len __unused ) {
- return -ENOTSUP;
- }
-
- /**
- * Format UUID setting value
- *
- * @v raw Raw setting value
- * @v raw_len Length of raw setting value
- * @v buf Buffer to contain formatted value
- * @v len Length of buffer
- * @ret len Length of formatted value, or negative error
- */
- static int format_uuid_setting ( const void *raw, size_t raw_len, char *buf,
- size_t len ) {
- const union uuid *uuid = raw;
-
- /* Range check */
- if ( raw_len != sizeof ( *uuid ) )
- return -ERANGE;
-
- /* Format value */
- return snprintf ( buf, len, "%s", uuid_ntoa ( uuid ) );
- }
-
- /** UUID setting type */
- struct setting_type setting_type_uuid __setting_type = {
- .name = "uuid",
- .parse = parse_uuid_setting,
- .format = format_uuid_setting,
- };
-
- /******************************************************************************
- *
- * Setting expansion
- *
- ******************************************************************************
- */
-
- /**
- * Expand variables within string
- *
- * @v string String
- * @ret expstr Expanded string
- *
- * The expanded string is allocated with malloc() and the caller must
- * eventually free() it.
- */
- char * expand_settings ( const char *string ) {
- char *expstr;
- char *start;
- char *end;
- char *head;
- char *name;
- char *tail;
- int setting_len;
- int new_len;
- char *tmp;
-
- /* Obtain temporary modifiable copy of string */
- expstr = strdup ( string );
- if ( ! expstr )
- return NULL;
-
- /* Expand while expansions remain */
- while ( 1 ) {
-
- head = expstr;
-
- /* Locate setting to be expanded */
- start = NULL;
- end = NULL;
- for ( tmp = expstr ; *tmp ; tmp++ ) {
- if ( ( tmp[0] == '$' ) && ( tmp[1] == '{' ) )
- start = tmp;
- if ( start && ( tmp[0] == '}' ) ) {
- end = tmp;
- break;
- }
- }
- if ( ! end )
- break;
- *start = '\0';
- name = ( start + 2 );
- *end = '\0';
- tail = ( end + 1 );
-
- /* Determine setting length */
- setting_len = fetchf_named_setting ( name, NULL, 0, NULL, 0 );
- if ( setting_len < 0 )
- setting_len = 0; /* Treat error as empty setting */
-
- /* Read setting into temporary buffer */
- {
- char setting_buf[ setting_len + 1 ];
-
- setting_buf[0] = '\0';
- fetchf_named_setting ( name, NULL, 0, setting_buf,
- sizeof ( setting_buf ) );
-
- /* Construct expanded string and discard old string */
- tmp = expstr;
- new_len = asprintf ( &expstr, "%s%s%s",
- head, setting_buf, tail );
- free ( tmp );
- if ( new_len < 0 )
- return NULL;
- }
- }
-
- return expstr;
- }
-
- /******************************************************************************
- *
- * Settings
- *
- ******************************************************************************
- */
-
- /** Hostname setting */
- struct setting hostname_setting __setting ( SETTING_HOST ) = {
- .name = "hostname",
- .description = "Host name",
- .tag = DHCP_HOST_NAME,
- .type = &setting_type_string,
- };
-
- /** Domain name setting */
- struct setting domain_setting __setting ( SETTING_IPv4_EXTRA ) = {
- .name = "domain",
- .description = "DNS domain",
- .tag = DHCP_DOMAIN_NAME,
- .type = &setting_type_string,
- };
-
- /** TFTP server setting */
- struct setting next_server_setting __setting ( SETTING_BOOT ) = {
- .name = "next-server",
- .description = "TFTP server",
- .tag = DHCP_EB_SIADDR,
- .type = &setting_type_ipv4,
- };
-
- /** Filename setting */
- struct setting filename_setting __setting ( SETTING_BOOT ) = {
- .name = "filename",
- .description = "Boot filename",
- .tag = DHCP_BOOTFILE_NAME,
- .type = &setting_type_string,
- };
-
- /** Root path setting */
- struct setting root_path_setting __setting ( SETTING_SANBOOT ) = {
- .name = "root-path",
- .description = "SAN root path",
- .tag = DHCP_ROOT_PATH,
- .type = &setting_type_string,
- };
-
- /** Username setting */
- struct setting username_setting __setting ( SETTING_AUTH ) = {
- .name = "username",
- .description = "User name",
- .tag = DHCP_EB_USERNAME,
- .type = &setting_type_string,
- };
-
- /** Password setting */
- struct setting password_setting __setting ( SETTING_AUTH ) = {
- .name = "password",
- .description = "Password",
- .tag = DHCP_EB_PASSWORD,
- .type = &setting_type_string,
- };
-
- /** Priority setting */
- struct setting priority_setting __setting ( SETTING_MISC ) = {
- .name = "priority",
- .description = "Settings priority",
- .tag = DHCP_EB_PRIORITY,
- .type = &setting_type_int8,
- };
-
- /******************************************************************************
- *
- * Built-in settings block
- *
- ******************************************************************************
- */
-
- /** Built-in setting tag magic */
- #define BUILTIN_SETTING_TAG_MAGIC 0xb1
-
- /**
- * Construct built-in setting tag
- *
- * @v id Unique identifier
- * @ret tag Setting tag
- */
- #define BUILTIN_SETTING_TAG( id ) ( ( BUILTIN_SETTING_TAG_MAGIC << 24 ) | (id) )
-
- /** "errno" setting tag */
- #define BUILTIN_SETTING_TAG_ERRNO BUILTIN_SETTING_TAG ( 0x01 )
-
- /** Error number setting */
- struct setting errno_setting __setting ( SETTING_MISC ) = {
- .name = "errno",
- .description = "Last error",
- .tag = BUILTIN_SETTING_TAG_ERRNO,
- .type = &setting_type_uint32,
- };
-
- /**
- * Fetch error number setting
- *
- * @v settings Settings block
- * @v setting Setting to fetch
- * @v data Setting data, or NULL to clear setting
- * @v len Length of setting data
- * @ret rc Return status code
- */
- static int errno_fetch ( struct settings *settings __unused,
- struct setting *setting __unused,
- void *data, size_t len ) {
- uint32_t content;
-
- /* Return current error */
- content = htonl ( errno );
- if ( len > sizeof ( content ) )
- len = sizeof ( content );
- memcpy ( data, &content, len );
- return sizeof ( content );
- }
-
- /**
- * Fetch built-in setting
- *
- * @v settings Settings block
- * @v setting Setting to fetch
- * @v data Setting data, or NULL to clear setting
- * @v len Length of setting data
- * @ret rc Return status code
- */
- static int builtin_fetch ( struct settings *settings __unused,
- struct setting *setting,
- void *data, size_t len ) {
-
- if ( setting_cmp ( setting, &errno_setting ) == 0 ) {
- return errno_fetch ( settings, setting, data, len );
- } else {
- return -ENOENT;
- }
- }
-
- /**
- * Check applicability of built-in setting
- *
- * @v settings Settings block
- * @v setting Setting
- * @ret applies Setting applies within this settings block
- */
- static int builtin_applies ( struct settings *settings __unused,
- struct setting *setting ) {
- unsigned int tag_magic;
-
- /* Check tag magic */
- tag_magic = ( setting->tag >> 24 );
- return ( tag_magic == BUILTIN_SETTING_TAG_MAGIC );
- }
-
- /** Built-in settings operations */
- static struct settings_operations builtin_settings_operations = {
- .applies = builtin_applies,
- .fetch = builtin_fetch,
- };
-
- /** Built-in settings */
- static struct settings builtin_settings = {
- .refcnt = NULL,
- .tag_magic = BUILTIN_SETTING_TAG ( 0 ),
- .siblings = LIST_HEAD_INIT ( builtin_settings.siblings ),
- .children = LIST_HEAD_INIT ( builtin_settings.children ),
- .op = &builtin_settings_operations,
- };
-
- /** Initialise built-in settings */
- static void builtin_init ( void ) {
- int rc;
-
- if ( ( rc = register_settings ( &builtin_settings, NULL,
- "builtin" ) ) != 0 ) {
- DBG ( "Could not register built-in settings: %s\n",
- strerror ( rc ) );
- return;
- }
- }
-
- /** Built-in settings initialiser */
- struct init_fn builtin_init_fn __init_fn ( INIT_NORMAL ) = {
- .initialise = builtin_init,
- };
|