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