[settings] Fix erroneous bit-masking in fetch_uintz_setting()
[people/lynusvaz/gpxe.git] / src / core / settings.c
1 /*
2  * Copyright (C) 2008 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 FILE_LICENCE ( GPL2_OR_LATER );
20
21 #include <stdint.h>
22 #include <stdlib.h>
23 #include <stdio.h>
24 #include <string.h>
25 #include <strings.h>
26 #include <byteswap.h>
27 #include <errno.h>
28 #include <assert.h>
29 #include <gpxe/in.h>
30 #include <gpxe/vsprintf.h>
31 #include <gpxe/dhcp.h>
32 #include <gpxe/uuid.h>
33 #include <gpxe/uri.h>
34 #include <gpxe/settings.h>
35
36 /** @file
37  *
38  * Configuration settings
39  *
40  */
41
42 /******************************************************************************
43  *
44  * Registered settings blocks
45  *
46  ******************************************************************************
47  */
48
49 /**
50  * Store value of simple setting
51  *
52  * @v options           DHCP option block
53  * @v setting           Setting to store
54  * @v data              Setting data, or NULL to clear setting
55  * @v len               Length of setting data
56  * @ret rc              Return status code
57  */
58 int simple_settings_store ( struct settings *settings, struct setting *setting,
59                             const void *data, size_t len ) {
60         struct simple_settings *simple =
61                 container_of ( settings, struct simple_settings, settings );
62         return dhcpopt_extensible_store ( &simple->dhcpopts, setting->tag,
63                                           data, len );
64 }
65
66 /**
67  * Fetch value of simple setting
68  *
69  * @v options           DHCP option block
70  * @v setting           Setting to fetch
71  * @v data              Buffer to fill with setting data
72  * @v len               Length of buffer
73  * @ret len             Length of setting data, or negative error
74  */
75 int simple_settings_fetch ( struct settings *settings, struct setting *setting,
76                             void *data, size_t len ) {
77         struct simple_settings *simple =
78                 container_of ( settings, struct simple_settings, settings );
79         return dhcpopt_fetch ( &simple->dhcpopts, setting->tag, data, len );
80 }
81
82 /** Simple settings operations */
83 struct settings_operations simple_settings_operations = {
84         .store = simple_settings_store,
85         .fetch = simple_settings_fetch,
86 };
87
88 /** Root simple settings block */
89 struct simple_settings simple_settings_root = {
90         .settings = {
91                 .refcnt = NULL,
92                 .name = "",
93                 .siblings =
94                      LIST_HEAD_INIT ( simple_settings_root.settings.siblings ),
95                 .children =
96                      LIST_HEAD_INIT ( simple_settings_root.settings.children ),
97                 .op = &simple_settings_operations,
98         },
99 };
100
101 /** Root settings block */
102 #define settings_root simple_settings_root.settings
103
104 /**
105  * Find child named settings block
106  *
107  * @v parent            Parent settings block
108  * @v name              Name within this parent
109  * @ret settings        Settings block, or NULL
110  */
111 static struct settings * find_child_settings ( struct settings *parent,
112                                                const char *name ) {
113         struct settings *settings;
114
115         /* Treat empty name as meaning "this block" */
116         if ( ! *name )
117                 return parent;
118
119         /* Look for child with matching name */
120         list_for_each_entry ( settings, &parent->children, siblings ) {
121                 if ( strcmp ( settings->name, name ) == 0 )
122                         return settings;
123         }
124
125         return NULL;
126 }
127
128 /**
129  * Find or create child named settings block
130  *
131  * @v parent            Parent settings block
132  * @v name              Name within this parent
133  * @ret settings        Settings block, or NULL
134  */
135 static struct settings * autovivify_child_settings ( struct settings *parent,
136                                                      const char *name ) {
137         struct {
138                 struct simple_settings simple;
139                 char name[ strlen ( name ) + 1 /* NUL */ ];
140         } *new_child;
141         struct settings *settings;
142
143         /* Return existing settings, if existent */
144         if ( ( settings = find_child_settings ( parent, name ) ) != NULL )
145                 return settings;
146
147         /* Create new simple settings block */
148         new_child = zalloc ( sizeof ( *new_child ) );
149         if ( ! new_child ) {
150                 DBGC ( parent, "Settings %p could not create child %s\n",
151                        parent, name );
152                 return NULL;
153         }
154         memcpy ( new_child->name, name, sizeof ( new_child->name ) );
155         simple_settings_init ( &new_child->simple, NULL, new_child->name );
156         settings = &new_child->simple.settings;
157         register_settings ( settings, parent );
158         return settings;
159 }
160
161 /**
162  * Parse settings block name
163  *
164  * @v name              Name
165  * @v get_child         Function to find or create child settings block
166  * @ret settings        Settings block, or NULL
167  */
168 static struct settings *
169 parse_settings_name ( const char *name,
170                       struct settings * ( * get_child ) ( struct settings *,
171                                                           const char * ) ) {
172         struct settings *settings = &settings_root;
173         char name_copy[ strlen ( name ) + 1 ];
174         char *subname;
175         char *remainder;
176
177         /* Create modifiable copy of name */
178         memcpy ( name_copy, name, sizeof ( name_copy ) );
179         remainder = name_copy;
180
181         /* Parse each name component in turn */
182         while ( remainder ) {
183                 subname = remainder;
184                 remainder = strchr ( subname, '.' );
185                 if ( remainder )
186                         *(remainder++) = '\0';
187                 settings = get_child ( settings, subname );
188                 if ( ! settings )
189                         break;
190         }
191
192         return settings;
193 }
194
195 /**
196  * Find named settings block
197  *
198  * @v name              Name
199  * @ret settings        Settings block, or NULL
200  */
201 struct settings * find_settings ( const char *name ) {
202
203         return parse_settings_name ( name, find_child_settings );
204 }
205
206 /**
207  * Apply all settings
208  *
209  * @ret rc              Return status code
210  */
211 static int apply_settings ( void ) {
212         struct settings_applicator *applicator;
213         int rc;
214
215         /* Call all settings applicators */
216         for_each_table_entry ( applicator, SETTINGS_APPLICATORS ) {
217                 if ( ( rc = applicator->apply() ) != 0 ) {
218                         DBG ( "Could not apply settings using applicator "
219                               "%p: %s\n", applicator, strerror ( rc ) );
220                         return rc;
221                 }
222         }
223
224         return 0;
225 }
226
227 /**
228  * Reprioritise settings
229  *
230  * @v settings          Settings block
231  *
232  * Reorders the settings block amongst its siblings according to its
233  * priority.
234  */
235 static void reprioritise_settings ( struct settings *settings ) {
236         struct settings *parent = settings->parent;
237         long priority;
238         struct settings *tmp;
239         long tmp_priority;
240
241         /* Stop when we reach the top of the tree */
242         if ( ! parent )
243                 return;
244
245         /* Read priority, if present */
246         priority = fetch_intz_setting ( settings, &priority_setting );
247
248         /* Remove from siblings list */
249         list_del ( &settings->siblings );
250
251         /* Reinsert after any existing blocks which have a higher priority */
252         list_for_each_entry ( tmp, &parent->children, siblings ) {
253                 tmp_priority = fetch_intz_setting ( tmp, &priority_setting );
254                 if ( priority > tmp_priority )
255                         break;
256         }
257         list_add_tail ( &settings->siblings, &tmp->siblings );
258
259         /* Recurse up the tree */
260         reprioritise_settings ( parent );
261 }
262
263 /**
264  * Register settings block
265  *
266  * @v settings          Settings block
267  * @v parent            Parent settings block, or NULL
268  * @ret rc              Return status code
269  */
270 int register_settings ( struct settings *settings, struct settings *parent ) {
271         struct settings *old_settings;
272
273         /* NULL parent => add to settings root */
274         assert ( settings != NULL );
275         if ( parent == NULL )
276                 parent = &settings_root;
277
278         /* Remove any existing settings with the same name */
279         if ( ( old_settings = find_child_settings ( parent, settings->name ) ))
280                 unregister_settings ( old_settings );
281
282         /* Add to list of settings */
283         ref_get ( settings->refcnt );
284         ref_get ( parent->refcnt );
285         settings->parent = parent;
286         list_add_tail ( &settings->siblings, &parent->children );
287         DBGC ( settings, "Settings %p registered\n", settings );
288
289         /* Fix up settings priority */
290         reprioritise_settings ( settings );
291
292         /* Apply potentially-updated settings */
293         apply_settings();
294
295         return 0;
296 }
297
298 /**
299  * Unregister settings block
300  *
301  * @v settings          Settings block
302  */
303 void unregister_settings ( struct settings *settings ) {
304
305         /* Remove from list of settings */
306         ref_put ( settings->refcnt );
307         ref_put ( settings->parent->refcnt );
308         settings->parent = NULL;
309         list_del ( &settings->siblings );
310         DBGC ( settings, "Settings %p unregistered\n", settings );
311
312         /* Apply potentially-updated settings */
313         apply_settings();
314 }
315
316 /******************************************************************************
317  *
318  * Core settings routines
319  *
320  ******************************************************************************
321  */
322
323 /**
324  * Store value of setting
325  *
326  * @v settings          Settings block, or NULL
327  * @v setting           Setting to store
328  * @v data              Setting data, or NULL to clear setting
329  * @v len               Length of setting data
330  * @ret rc              Return status code
331  */
332 int store_setting ( struct settings *settings, struct setting *setting,
333                     const void *data, size_t len ) {
334         int rc;
335
336         /* NULL settings implies storing into the global settings root */
337         if ( ! settings )
338                 settings = &settings_root;
339
340         /* Store setting */
341         if ( ( rc = settings->op->store ( settings, setting,
342                                           data, len ) ) != 0 )
343                 return rc;
344
345         /* Reprioritise settings if necessary */
346         if ( setting_cmp ( setting, &priority_setting ) == 0 )
347                 reprioritise_settings ( settings );
348
349         /* If these settings are registered, apply potentially-updated
350          * settings
351          */
352         for ( ; settings ; settings = settings->parent ) {
353                 if ( settings == &settings_root ) {
354                         if ( ( rc = apply_settings() ) != 0 )
355                                 return rc;
356                         break;
357                 }
358         }
359
360         return 0;
361 }
362
363 /**
364  * Fetch value of setting
365  *
366  * @v settings          Settings block, or NULL to search all blocks
367  * @v setting           Setting to fetch
368  * @v data              Buffer to fill with setting data
369  * @v len               Length of buffer
370  * @ret len             Length of setting data, or negative error
371  *
372  * The actual length of the setting will be returned even if
373  * the buffer was too small.
374  */
375 int fetch_setting ( struct settings *settings, struct setting *setting,
376                     void *data, size_t len ) {
377         struct settings *child;
378         int ret;
379
380         /* Avoid returning uninitialised data on error */
381         memset ( data, 0, len );
382
383         /* NULL settings implies starting at the global settings root */
384         if ( ! settings )
385                 settings = &settings_root;
386
387         /* Try this block first */
388         if ( ( ret = settings->op->fetch ( settings, setting,
389                                            data, len ) ) >= 0 )
390                 return ret;
391
392         /* Recurse into each child block in turn */
393         list_for_each_entry ( child, &settings->children, siblings ) {
394                 if ( ( ret = fetch_setting ( child, setting,
395                                              data, len ) ) >= 0 )
396                         return ret;
397         }
398
399         return -ENOENT;
400 }
401
402 /**
403  * Fetch length of setting
404  *
405  * @v settings          Settings block, or NULL to search all blocks
406  * @v setting           Setting to fetch
407  * @ret len             Length of setting data, or negative error
408  *
409  * This function can also be used as an existence check for the
410  * setting.
411  */
412 int fetch_setting_len ( struct settings *settings, struct setting *setting ) {
413         return fetch_setting ( settings, setting, NULL, 0 );
414 }
415
416 /**
417  * Fetch value of string setting
418  *
419  * @v settings          Settings block, or NULL to search all blocks
420  * @v setting           Setting to fetch
421  * @v data              Buffer to fill with setting string data
422  * @v len               Length of buffer
423  * @ret len             Length of string setting, or negative error
424  *
425  * The resulting string is guaranteed to be correctly NUL-terminated.
426  * The returned length will be the length of the underlying setting
427  * data.
428  */
429 int fetch_string_setting ( struct settings *settings, struct setting *setting,
430                            char *data, size_t len ) {
431         memset ( data, 0, len );
432         return fetch_setting ( settings, setting, data,
433                                ( ( len > 0 ) ? ( len - 1 ) : 0 ) );
434 }
435
436 /**
437  * Fetch value of string setting
438  *
439  * @v settings          Settings block, or NULL to search all blocks
440  * @v setting           Setting to fetch
441  * @v data              Buffer to allocate and fill with setting string data
442  * @ret len             Length of string setting, or negative error
443  *
444  * The resulting string is guaranteed to be correctly NUL-terminated.
445  * The returned length will be the length of the underlying setting
446  * data.  The caller is responsible for eventually freeing the
447  * allocated buffer.
448  */
449 int fetch_string_setting_copy ( struct settings *settings,
450                                 struct setting *setting,
451                                 char **data ) {
452         int len;
453         int check_len = 0;
454
455         len = fetch_setting_len ( settings, setting );
456         if ( len < 0 )
457                 return len;
458
459         *data = malloc ( len + 1 );
460         if ( ! *data )
461                 return -ENOMEM;
462
463         check_len = fetch_string_setting ( settings, setting, *data,
464                                            ( len + 1 ) );
465         assert ( check_len == len );
466         return len;
467 }
468
469 /**
470  * Fetch value of IPv4 address setting
471  *
472  * @v settings          Settings block, or NULL to search all blocks
473  * @v setting           Setting to fetch
474  * @v inp               IPv4 address to fill in
475  * @ret len             Length of setting, or negative error
476  */
477 int fetch_ipv4_setting ( struct settings *settings, struct setting *setting,
478                          struct in_addr *inp ) {
479         int len;
480
481         len = fetch_setting ( settings, setting, inp, sizeof ( *inp ) );
482         if ( len < 0 )
483                 return len;
484         if ( len < ( int ) sizeof ( *inp ) )
485                 return -ERANGE;
486         return len;
487 }
488
489 /**
490  * Fetch value of signed integer setting
491  *
492  * @v settings          Settings block, or NULL to search all blocks
493  * @v setting           Setting to fetch
494  * @v value             Integer value to fill in
495  * @ret len             Length of setting, or negative error
496  */
497 int fetch_int_setting ( struct settings *settings, struct setting *setting,
498                         long *value ) {
499         union {
500                 uint8_t u8[ sizeof ( long ) ];
501                 int8_t s8[ sizeof ( long ) ];
502         } buf;
503         int len;
504         int i;
505
506         /* Avoid returning uninitialised data on error */
507         *value = 0;
508
509         /* Fetch raw (network-ordered, variable-length) setting */
510         len = fetch_setting ( settings, setting, &buf, sizeof ( buf ) );
511         if ( len < 0 )
512                 return len;
513         if ( len > ( int ) sizeof ( buf ) )
514                 return -ERANGE;
515
516         /* Convert to host-ordered signed long */
517         *value = ( ( buf.s8[0] >= 0 ) ? 0 : -1L );
518         for ( i = 0 ; i < len ; i++ ) {
519                 *value = ( ( *value << 8 ) | buf.u8[i] );
520         }
521
522         return len;
523 }
524
525 /**
526  * Fetch value of unsigned integer setting
527  *
528  * @v settings          Settings block, or NULL to search all blocks
529  * @v setting           Setting to fetch
530  * @v value             Integer value to fill in
531  * @ret len             Length of setting, or negative error
532  */
533 int fetch_uint_setting ( struct settings *settings, struct setting *setting,
534                          unsigned long *value ) {
535         long svalue;
536         int len;
537
538         /* Avoid returning uninitialised data on error */
539         *value = 0;
540
541         /* Fetch as a signed long */
542         len = fetch_int_setting ( settings, setting, &svalue );
543         if ( len < 0 )
544                 return len;
545
546         /* Mask off sign-extended bits */
547         assert ( len <= ( int ) sizeof ( long ) );
548         *value = ( svalue & ( -1UL >> ( 8 * ( sizeof ( long ) - len ) ) ) );
549
550         return len;
551 }
552
553 /**
554  * Fetch value of signed integer setting, or zero
555  *
556  * @v settings          Settings block, or NULL to search all blocks
557  * @v setting           Setting to fetch
558  * @ret value           Setting value, or zero
559  */
560 long fetch_intz_setting ( struct settings *settings, struct setting *setting ){
561         long value;
562
563         fetch_int_setting ( settings, setting, &value );
564         return value;
565 }
566
567 /**
568  * Fetch value of unsigned integer setting, or zero
569  *
570  * @v settings          Settings block, or NULL to search all blocks
571  * @v setting           Setting to fetch
572  * @ret value           Setting value, or zero
573  */
574 unsigned long fetch_uintz_setting ( struct settings *settings,
575                                     struct setting *setting ) {
576         unsigned long value;
577
578         fetch_uint_setting ( settings, setting, &value );
579         return value;
580 }
581
582 /**
583  * Fetch value of UUID setting
584  *
585  * @v settings          Settings block, or NULL to search all blocks
586  * @v setting           Setting to fetch
587  * @v uuid              UUID to fill in
588  * @ret len             Length of setting, or negative error
589  */
590 int fetch_uuid_setting ( struct settings *settings, struct setting *setting,
591                          union uuid *uuid ) {
592         int len;
593
594         len = fetch_setting ( settings, setting, uuid, sizeof ( *uuid ) );
595         if ( len < 0 )
596                 return len;
597         if ( len != sizeof ( *uuid ) )
598                 return -ERANGE;
599         return len;
600 }
601
602 /**
603  * Compare two settings
604  *
605  * @v a                 Setting to compare
606  * @v b                 Setting to compare
607  * @ret 0               Settings are the same
608  * @ret non-zero        Settings are not the same
609  */
610 int setting_cmp ( struct setting *a, struct setting *b ) {
611
612         /* If the settings have tags, compare them */
613         if ( a->tag && ( a->tag == b->tag ) )
614                 return 0;
615
616         /* Otherwise, compare the names */
617         return strcmp ( a->name, b->name );
618 }
619
620 /******************************************************************************
621  *
622  * Formatted setting routines
623  *
624  ******************************************************************************
625  */
626
627 /**
628  * Store value of typed setting
629  *
630  * @v settings          Settings block
631  * @v setting           Setting to store
632  * @v type              Settings type
633  * @v value             Formatted setting data, or NULL
634  * @ret rc              Return status code
635  */
636 int storef_setting ( struct settings *settings, struct setting *setting,
637                      const char *value ) {
638
639         /* NULL value implies deletion.  Avoid imposing the burden of
640          * checking for NULL values on each typed setting's storef()
641          * method.
642          */
643         if ( ! value )
644                 return delete_setting ( settings, setting );
645                 
646         return setting->type->storef ( settings, setting, value );
647 }
648
649 /**
650  * Find named setting
651  *
652  * @v name              Name
653  * @ret setting         Named setting, or NULL
654  */
655 static struct setting * find_setting ( const char *name ) {
656         struct setting *setting;
657
658         for_each_table_entry ( setting, SETTINGS ) {
659                 if ( strcmp ( name, setting->name ) == 0 )
660                         return setting;
661         }
662         return NULL;
663 }
664
665 /**
666  * Find setting type
667  *
668  * @v name              Name
669  * @ret type            Setting type, or NULL
670  */
671 static struct setting_type * find_setting_type ( const char *name ) {
672         struct setting_type *type;
673
674         for_each_table_entry ( type, SETTING_TYPES ) {
675                 if ( strcmp ( name, type->name ) == 0 )
676                         return type;
677         }
678         return NULL;
679 }
680
681 /**
682  * Parse setting name
683  *
684  * @v name              Name of setting
685  * @v get_child         Function to find or create child settings block
686  * @v settings          Settings block to fill in
687  * @v setting           Setting to fill in
688  * @ret rc              Return status code
689  *
690  * Interprets a name of the form
691  * "[settings_name/]tag_name[:type_name]" and fills in the appropriate
692  * fields.
693  */
694 static int
695 parse_setting_name ( const char *name,
696                      struct settings * ( * get_child ) ( struct settings *,
697                                                          const char * ),
698                      struct settings **settings, struct setting *setting ) {
699         char tmp_name[ strlen ( name ) + 1 ];
700         char *settings_name;
701         char *setting_name;
702         char *type_name;
703         struct setting *named_setting;
704         char *tmp;
705
706         /* Set defaults */
707         *settings = &settings_root;
708         memset ( setting, 0, sizeof ( *setting ) );
709         setting->type = &setting_type_hex;
710
711         /* Split name into "[settings_name/]setting_name[:type_name]" */
712         memcpy ( tmp_name, name, sizeof ( tmp_name ) );
713         if ( ( setting_name = strchr ( tmp_name, '/' ) ) != NULL ) {
714                 *(setting_name++) = 0;
715                 settings_name = tmp_name;
716         } else {
717                 setting_name = tmp_name;
718                 settings_name = NULL;
719         }
720         if ( ( type_name = strchr ( setting_name, ':' ) ) != NULL )
721                 *(type_name++) = 0;
722
723         /* Identify settings block, if specified */
724         if ( settings_name ) {
725                 *settings = parse_settings_name ( settings_name, get_child );
726                 if ( *settings == NULL ) {
727                         DBG ( "Unrecognised settings block \"%s\" in \"%s\"\n",
728                               settings_name, name );
729                         return -ENODEV;
730                 }
731         }
732
733         /* Identify tag number */
734         if ( ( named_setting = find_setting ( setting_name ) ) != NULL ) {
735                 memcpy ( setting, named_setting, sizeof ( *setting ) );
736         } else {
737                 /* Unrecognised name: try to interpret as a tag number */
738                 tmp = setting_name;
739                 while ( 1 ) {
740                         setting->tag = ( ( setting->tag << 8 ) |
741                                          strtoul ( tmp, &tmp, 0 ) );
742                         if ( *tmp == 0 )
743                                 break;
744                         if ( *tmp != '.' ) {
745                                 DBG ( "Invalid setting \"%s\" in \"%s\"\n",
746                                       setting_name, name );
747                                 return -ENOENT;
748                         }
749                         tmp++;
750                 }
751                 setting->tag |= (*settings)->tag_magic;
752         }
753
754         /* Identify setting type, if specified */
755         if ( type_name ) {
756                 setting->type = find_setting_type ( type_name );
757                 if ( setting->type == NULL ) {
758                         DBG ( "Invalid setting type \"%s\" in \"%s\"\n",
759                               type_name, name );
760                         return -ENOTSUP;
761                 }
762         }
763
764         return 0;
765 }
766
767 /**
768  * Parse and store value of named setting
769  *
770  * @v name              Name of setting
771  * @v value             Formatted setting data, or NULL
772  * @ret rc              Return status code
773  */
774 int storef_named_setting ( const char *name, const char *value ) {
775         struct settings *settings;
776         struct setting setting;
777         int rc;
778
779         if ( ( rc = parse_setting_name ( name, autovivify_child_settings,
780                                          &settings, &setting ) ) != 0 )
781                 return rc;
782         return storef_setting ( settings, &setting, value );
783 }
784
785 /**
786  * Fetch and format value of named setting
787  *
788  * @v name              Name of setting
789  * @v buf               Buffer to contain formatted value
790  * @v len               Length of buffer
791  * @ret len             Length of formatted value, or negative error
792  */
793 int fetchf_named_setting ( const char *name, char *buf, size_t len ) {
794         struct settings *settings;
795         struct setting setting;
796         int rc;
797
798         if ( ( rc = parse_setting_name ( name, find_child_settings,
799                                          &settings, &setting ) ) != 0 )
800                 return rc;
801         return fetchf_setting ( settings, &setting, buf, len );
802 }
803
804 /******************************************************************************
805  *
806  * Setting types
807  *
808  ******************************************************************************
809  */
810
811 /**
812  * Parse and store value of string setting
813  *
814  * @v settings          Settings block
815  * @v setting           Setting to store
816  * @v value             Formatted setting data
817  * @ret rc              Return status code
818  */
819 static int storef_string ( struct settings *settings, struct setting *setting,
820                            const char *value ) {
821         return store_setting ( settings, setting, value, strlen ( value ) );
822 }
823
824 /**
825  * Fetch and format value of string setting
826  *
827  * @v settings          Settings block, or NULL to search all blocks
828  * @v setting           Setting to fetch
829  * @v buf               Buffer to contain formatted value
830  * @v len               Length of buffer
831  * @ret len             Length of formatted value, or negative error
832  */
833 static int fetchf_string ( struct settings *settings, struct setting *setting,
834                            char *buf, size_t len ) {
835         return fetch_string_setting ( settings, setting, buf, len );
836 }
837
838 /** A string setting type */
839 struct setting_type setting_type_string __setting_type = {
840         .name = "string",
841         .storef = storef_string,
842         .fetchf = fetchf_string,
843 };
844
845 /**
846  * Parse and store value of URI-encoded string setting
847  *
848  * @v settings          Settings block
849  * @v setting           Setting to store
850  * @v value             Formatted setting data
851  * @ret rc              Return status code
852  */
853 static int storef_uristring ( struct settings *settings,
854                               struct setting *setting,
855                               const char *value ) {
856         char buf[ strlen ( value ) + 1 ]; /* Decoding never expands string */
857         size_t len;
858
859         len = uri_decode ( value, buf, sizeof ( buf ) );
860         return store_setting ( settings, setting, buf, len );
861 }
862
863 /**
864  * Fetch and format value of URI-encoded string setting
865  *
866  * @v settings          Settings block, or NULL to search all blocks
867  * @v setting           Setting to fetch
868  * @v buf               Buffer to contain formatted value
869  * @v len               Length of buffer
870  * @ret len             Length of formatted value, or negative error
871  */
872 static int fetchf_uristring ( struct settings *settings,
873                               struct setting *setting,
874                               char *buf, size_t len ) {
875         ssize_t raw_len;
876
877         /* We need to always retrieve the full raw string to know the
878          * length of the encoded string.
879          */
880         raw_len = fetch_setting ( settings, setting, NULL, 0 );
881         if ( raw_len < 0 )
882                 return raw_len;
883
884         {
885                 char raw_buf[ raw_len + 1 ];
886        
887                 fetch_string_setting ( settings, setting, raw_buf,
888                                        sizeof ( raw_buf ) );
889                 return uri_encode ( raw_buf, buf, len );
890         }
891 }
892
893 /** A URI-encoded string setting type */
894 struct setting_type setting_type_uristring __setting_type = {
895         .name = "uristring",
896         .storef = storef_uristring,
897         .fetchf = fetchf_uristring,
898 };
899
900 /**
901  * Parse and store value of IPv4 address setting
902  *
903  * @v settings          Settings block
904  * @v setting           Setting to store
905  * @v value             Formatted setting data
906  * @ret rc              Return status code
907  */
908 static int storef_ipv4 ( struct settings *settings, struct setting *setting,
909                          const char *value ) {
910         struct in_addr ipv4;
911
912         if ( inet_aton ( value, &ipv4 ) == 0 )
913                 return -EINVAL;
914         return store_setting ( settings, setting, &ipv4, sizeof ( ipv4 ) );
915 }
916
917 /**
918  * Fetch and format value of IPv4 address setting
919  *
920  * @v settings          Settings block, or NULL to search all blocks
921  * @v setting           Setting to fetch
922  * @v buf               Buffer to contain formatted value
923  * @v len               Length of buffer
924  * @ret len             Length of formatted value, or negative error
925  */
926 static int fetchf_ipv4 ( struct settings *settings, struct setting *setting,
927                          char *buf, size_t len ) {
928         struct in_addr ipv4;
929         int raw_len;
930
931         if ( ( raw_len = fetch_ipv4_setting ( settings, setting, &ipv4 ) ) < 0)
932                 return raw_len;
933         return snprintf ( buf, len, "%s", inet_ntoa ( ipv4 ) );
934 }
935
936 /** An IPv4 address setting type */
937 struct setting_type setting_type_ipv4 __setting_type = {
938         .name = "ipv4",
939         .storef = storef_ipv4,
940         .fetchf = fetchf_ipv4,
941 };
942
943 /**
944  * Parse and store value of integer setting
945  *
946  * @v settings          Settings block
947  * @v setting           Setting to store
948  * @v value             Formatted setting data
949  * @v size              Integer size, in bytes
950  * @ret rc              Return status code
951  */
952 static int storef_int ( struct settings *settings, struct setting *setting,
953                         const char *value, unsigned int size ) {
954         union {
955                 uint32_t num;
956                 uint8_t bytes[4];
957         } u;
958         char *endp;
959
960         u.num = htonl ( strtoul ( value, &endp, 0 ) );
961         if ( *endp )
962                 return -EINVAL;
963         return store_setting ( settings, setting, 
964                                &u.bytes[ sizeof ( u ) - size ], size );
965 }
966
967 /**
968  * Parse and store value of 8-bit integer setting
969  *
970  * @v settings          Settings block
971  * @v setting           Setting to store
972  * @v value             Formatted setting data
973  * @v size              Integer size, in bytes
974  * @ret rc              Return status code
975  */
976 static int storef_int8 ( struct settings *settings, struct setting *setting,
977                          const char *value ) {
978         return storef_int ( settings, setting, value, 1 );
979 }
980
981 /**
982  * Parse and store value of 16-bit integer setting
983  *
984  * @v settings          Settings block
985  * @v setting           Setting to store
986  * @v value             Formatted setting data
987  * @v size              Integer size, in bytes
988  * @ret rc              Return status code
989  */
990 static int storef_int16 ( struct settings *settings, struct setting *setting,
991                           const char *value ) {
992         return storef_int ( settings, setting, value, 2 );
993 }
994
995 /**
996  * Parse and store value of 32-bit integer setting
997  *
998  * @v settings          Settings block
999  * @v setting           Setting to store
1000  * @v value             Formatted setting data
1001  * @v size              Integer size, in bytes
1002  * @ret rc              Return status code
1003  */
1004 static int storef_int32 ( struct settings *settings, struct setting *setting,
1005                           const char *value ) {
1006         return storef_int ( settings, setting, value, 4 );
1007 }
1008
1009 /**
1010  * Fetch and format value of signed integer setting
1011  *
1012  * @v settings          Settings block, or NULL to search all blocks
1013  * @v setting           Setting to fetch
1014  * @v buf               Buffer to contain formatted value
1015  * @v len               Length of buffer
1016  * @ret len             Length of formatted value, or negative error
1017  */
1018 static int fetchf_int ( struct settings *settings, struct setting *setting,
1019                         char *buf, size_t len ) {
1020         long value;
1021         int rc;
1022
1023         if ( ( rc = fetch_int_setting ( settings, setting, &value ) ) < 0 )
1024                 return rc;
1025         return snprintf ( buf, len, "%ld", value );
1026 }
1027
1028 /**
1029  * Fetch and format value of unsigned integer setting
1030  *
1031  * @v settings          Settings block, or NULL to search all blocks
1032  * @v setting           Setting to fetch
1033  * @v buf               Buffer to contain formatted value
1034  * @v len               Length of buffer
1035  * @ret len             Length of formatted value, or negative error
1036  */
1037 static int fetchf_uint ( struct settings *settings, struct setting *setting,
1038                          char *buf, size_t len ) {
1039         unsigned long value;
1040         int rc;
1041
1042         if ( ( rc = fetch_uint_setting ( settings, setting, &value ) ) < 0 )
1043                 return rc;
1044         return snprintf ( buf, len, "%#lx", value );
1045 }
1046
1047 /** A signed 8-bit integer setting type */
1048 struct setting_type setting_type_int8 __setting_type = {
1049         .name = "int8",
1050         .storef = storef_int8,
1051         .fetchf = fetchf_int,
1052 };
1053
1054 /** A signed 16-bit integer setting type */
1055 struct setting_type setting_type_int16 __setting_type = {
1056         .name = "int16",
1057         .storef = storef_int16,
1058         .fetchf = fetchf_int,
1059 };
1060
1061 /** A signed 32-bit integer setting type */
1062 struct setting_type setting_type_int32 __setting_type = {
1063         .name = "int32",
1064         .storef = storef_int32,
1065         .fetchf = fetchf_int,
1066 };
1067
1068 /** An unsigned 8-bit integer setting type */
1069 struct setting_type setting_type_uint8 __setting_type = {
1070         .name = "uint8",
1071         .storef = storef_int8,
1072         .fetchf = fetchf_uint,
1073 };
1074
1075 /** An unsigned 16-bit integer setting type */
1076 struct setting_type setting_type_uint16 __setting_type = {
1077         .name = "uint16",
1078         .storef = storef_int16,
1079         .fetchf = fetchf_uint,
1080 };
1081
1082 /** An unsigned 32-bit integer setting type */
1083 struct setting_type setting_type_uint32 __setting_type = {
1084         .name = "uint32",
1085         .storef = storef_int32,
1086         .fetchf = fetchf_uint,
1087 };
1088
1089 /**
1090  * Parse and store value of hex string setting
1091  *
1092  * @v settings          Settings block
1093  * @v setting           Setting to store
1094  * @v value             Formatted setting data
1095  * @ret rc              Return status code
1096  */
1097 static int storef_hex ( struct settings *settings, struct setting *setting,
1098                         const char *value ) {
1099         char *ptr = ( char * ) value;
1100         uint8_t bytes[ strlen ( value ) ]; /* cannot exceed strlen(value) */
1101         unsigned int len = 0;
1102
1103         while ( 1 ) {
1104                 bytes[len++] = strtoul ( ptr, &ptr, 16 );
1105                 switch ( *ptr ) {
1106                 case '\0' :
1107                         return store_setting ( settings, setting, bytes, len );
1108                 case ':' :
1109                         ptr++;
1110                         break;
1111                 default :
1112                         return -EINVAL;
1113                 }
1114         }
1115 }
1116
1117 /**
1118  * Fetch and format value of hex string setting
1119  *
1120  * @v settings          Settings block, or NULL to search all blocks
1121  * @v setting           Setting to fetch
1122  * @v buf               Buffer to contain formatted value
1123  * @v len               Length of buffer
1124  * @ret len             Length of formatted value, or negative error
1125  */
1126 static int fetchf_hex ( struct settings *settings, struct setting *setting,
1127                         char *buf, size_t len ) {
1128         int raw_len;
1129         int check_len;
1130         int used = 0;
1131         int i;
1132
1133         raw_len = fetch_setting_len ( settings, setting );
1134         if ( raw_len < 0 )
1135                 return raw_len;
1136
1137         {
1138                 uint8_t raw[raw_len];
1139
1140                 check_len = fetch_setting ( settings, setting, raw,
1141                                             sizeof ( raw ) );
1142                 if ( check_len < 0 )
1143                         return check_len;
1144                 assert ( check_len == raw_len );
1145                 
1146                 if ( len )
1147                         buf[0] = 0; /* Ensure that a terminating NUL exists */
1148                 for ( i = 0 ; i < raw_len ; i++ ) {
1149                         used += ssnprintf ( ( buf + used ), ( len - used ),
1150                                             "%s%02x", ( used ? ":" : "" ),
1151                                             raw[i] );
1152                 }
1153                 return used;
1154         }
1155 }
1156
1157 /** A hex-string setting */
1158 struct setting_type setting_type_hex __setting_type = {
1159         .name = "hex",
1160         .storef = storef_hex,
1161         .fetchf = fetchf_hex,
1162 };
1163
1164 /**
1165  * Parse and store value of UUID setting
1166  *
1167  * @v settings          Settings block
1168  * @v setting           Setting to store
1169  * @v value             Formatted setting data
1170  * @ret rc              Return status code
1171  */
1172 static int storef_uuid ( struct settings *settings __unused,
1173                          struct setting *setting __unused,
1174                          const char *value __unused ) {
1175         return -ENOTSUP;
1176 }
1177
1178 /**
1179  * Fetch and format value of UUID setting
1180  *
1181  * @v settings          Settings block, or NULL to search all blocks
1182  * @v setting           Setting to fetch
1183  * @v buf               Buffer to contain formatted value
1184  * @v len               Length of buffer
1185  * @ret len             Length of formatted value, or negative error
1186  */
1187 static int fetchf_uuid ( struct settings *settings, struct setting *setting,
1188                          char *buf, size_t len ) {
1189         union uuid uuid;
1190         int raw_len;
1191
1192         if ( ( raw_len = fetch_uuid_setting ( settings, setting, &uuid ) ) < 0)
1193                 return raw_len;
1194         return snprintf ( buf, len, "%s", uuid_ntoa ( &uuid ) );
1195 }
1196
1197 /** UUID setting type */
1198 struct setting_type setting_type_uuid __setting_type = {
1199         .name = "uuid",
1200         .storef = storef_uuid,
1201         .fetchf = fetchf_uuid,
1202 };
1203
1204 /******************************************************************************
1205  *
1206  * Settings
1207  *
1208  ******************************************************************************
1209  */
1210
1211 /** Hostname setting */
1212 struct setting hostname_setting __setting = {
1213         .name = "hostname",
1214         .description = "Host name",
1215         .tag = DHCP_HOST_NAME,
1216         .type = &setting_type_string,
1217 };
1218
1219 /** Filename setting */
1220 struct setting filename_setting __setting = {
1221         .name = "filename",
1222         .description = "Boot filename",
1223         .tag = DHCP_BOOTFILE_NAME,
1224         .type = &setting_type_string,
1225 };
1226
1227 /** Root path setting */
1228 struct setting root_path_setting __setting = {
1229         .name = "root-path",
1230         .description = "NFS/iSCSI root path",
1231         .tag = DHCP_ROOT_PATH,
1232         .type = &setting_type_string,
1233 };
1234
1235 /** Username setting */
1236 struct setting username_setting __setting = {
1237         .name = "username",
1238         .description = "User name",
1239         .tag = DHCP_EB_USERNAME,
1240         .type = &setting_type_string,
1241 };
1242
1243 /** Password setting */
1244 struct setting password_setting __setting = {
1245         .name = "password",
1246         .description = "Password",
1247         .tag = DHCP_EB_PASSWORD,
1248         .type = &setting_type_string,
1249 };
1250
1251 /** Priority setting */
1252 struct setting priority_setting __setting = {
1253         .name = "priority",
1254         .description = "Priority of these settings",
1255         .tag = DHCP_EB_PRIORITY,
1256         .type = &setting_type_int8,
1257 };