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