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