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