[settings] Add the uristring setting type
[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         /* NULL settings implies starting at the global settings root */
337         if ( ! settings )
338                 settings = &settings_root;
339
340         /* Try this block first */
341         if ( ( ret = settings->op->fetch ( settings, setting,
342                                            data, len ) ) >= 0 )
343                 return ret;
344
345         /* Recurse into each child block in turn */
346         list_for_each_entry ( child, &settings->children, siblings ) {
347                 if ( ( ret = fetch_setting ( child, setting,
348                                              data, len ) ) >= 0 )
349                         return ret;
350         }
351
352         return -ENOENT;
353 }
354
355 /**
356  * Fetch length of setting
357  *
358  * @v settings          Settings block, or NULL to search all blocks
359  * @v setting           Setting to fetch
360  * @ret len             Length of setting data, or negative error
361  *
362  * This function can also be used as an existence check for the
363  * setting.
364  */
365 int fetch_setting_len ( struct settings *settings, struct setting *setting ) {
366         return fetch_setting ( settings, setting, NULL, 0 );
367 }
368
369 /**
370  * Fetch value of string setting
371  *
372  * @v settings          Settings block, or NULL to search all blocks
373  * @v setting           Setting to fetch
374  * @v data              Buffer to fill with setting string data
375  * @v len               Length of buffer
376  * @ret len             Length of string setting, or negative error
377  *
378  * The resulting string is guaranteed to be correctly NUL-terminated.
379  * The returned length will be the length of the underlying setting
380  * data.
381  */
382 int fetch_string_setting ( struct settings *settings, struct setting *setting,
383                            char *data, size_t len ) {
384         memset ( data, 0, len );
385         return fetch_setting ( settings, setting, data,
386                                ( ( len > 0 ) ? ( len - 1 ) : 0 ) );
387 }
388
389 /**
390  * Fetch value of IPv4 address setting
391  *
392  * @v settings          Settings block, or NULL to search all blocks
393  * @v setting           Setting to fetch
394  * @v inp               IPv4 address to fill in
395  * @ret len             Length of setting, or negative error
396  */
397 int fetch_ipv4_setting ( struct settings *settings, struct setting *setting,
398                          struct in_addr *inp ) {
399         int len;
400
401         len = fetch_setting ( settings, setting, inp, sizeof ( *inp ) );
402         if ( len < 0 )
403                 return len;
404         if ( len < ( int ) sizeof ( *inp ) )
405                 return -ERANGE;
406         return len;
407 }
408
409 /**
410  * Fetch value of signed integer setting
411  *
412  * @v settings          Settings block, or NULL to search all blocks
413  * @v setting           Setting to fetch
414  * @v value             Integer value to fill in
415  * @ret len             Length of setting, or negative error
416  */
417 int fetch_int_setting ( struct settings *settings, struct setting *setting,
418                         long *value ) {
419         union {
420                 long value;
421                 uint8_t u8[ sizeof ( long ) ];
422                 int8_t s8[ sizeof ( long ) ];
423         } buf;
424         int len;
425         int i;
426
427         buf.value = 0;
428         len = fetch_setting ( settings, setting, &buf, sizeof ( buf ) );
429         if ( len < 0 )
430                 return len;
431         if ( len > ( int ) sizeof ( buf ) )
432                 return -ERANGE;
433
434         *value = ( ( buf.s8[0] >= 0 ) ? 0 : -1L );
435         for ( i = 0 ; i < len ; i++ ) {
436                 *value = ( ( *value << 8 ) | buf.u8[i] );
437         }
438
439         return len;
440 }
441
442 /**
443  * Fetch value of unsigned integer setting
444  *
445  * @v settings          Settings block, or NULL to search all blocks
446  * @v setting           Setting to fetch
447  * @v value             Integer value to fill in
448  * @ret len             Length of setting, or negative error
449  */
450 int fetch_uint_setting ( struct settings *settings, struct setting *setting,
451                          unsigned long *value ) {
452         long svalue;
453         int len;
454
455         len = fetch_int_setting ( settings, setting, &svalue );
456         if ( len < 0 )
457                 return len;
458
459         *value = ( svalue & ( -1UL >> ( sizeof ( long ) - len ) ) );
460
461         return len;
462 }
463
464 /**
465  * Fetch value of signed integer setting, or zero
466  *
467  * @v settings          Settings block, or NULL to search all blocks
468  * @v setting           Setting to fetch
469  * @ret value           Setting value, or zero
470  */
471 long fetch_intz_setting ( struct settings *settings, struct setting *setting ){
472         long value = 0;
473
474         fetch_int_setting ( settings, setting, &value );
475         return value;
476 }
477
478 /**
479  * Fetch value of unsigned integer setting, or zero
480  *
481  * @v settings          Settings block, or NULL to search all blocks
482  * @v setting           Setting to fetch
483  * @ret value           Setting value, or zero
484  */
485 unsigned long fetch_uintz_setting ( struct settings *settings,
486                                     struct setting *setting ) {
487         unsigned long value = 0;
488
489         fetch_uint_setting ( settings, setting, &value );
490         return value;
491 }
492
493 /**
494  * Fetch value of UUID setting
495  *
496  * @v settings          Settings block, or NULL to search all blocks
497  * @v setting           Setting to fetch
498  * @v uuid              UUID to fill in
499  * @ret len             Length of setting, or negative error
500  */
501 int fetch_uuid_setting ( struct settings *settings, struct setting *setting,
502                          union uuid *uuid ) {
503         int len;
504
505         len = fetch_setting ( settings, setting, uuid, sizeof ( *uuid ) );
506         if ( len < 0 )
507                 return len;
508         if ( len != sizeof ( *uuid ) )
509                 return -ERANGE;
510         return len;
511 }
512
513 /**
514  * Compare two settings
515  *
516  * @v a                 Setting to compare
517  * @v b                 Setting to compare
518  * @ret 0               Settings are the same
519  * @ret non-zero        Settings are not the same
520  */
521 int setting_cmp ( struct setting *a, struct setting *b ) {
522
523         /* If the settings have tags, compare them */
524         if ( a->tag && ( a->tag == b->tag ) )
525                 return 0;
526
527         /* Otherwise, compare the names */
528         return strcmp ( a->name, b->name );
529 }
530
531 /******************************************************************************
532  *
533  * Formatted setting routines
534  *
535  ******************************************************************************
536  */
537
538 /**
539  * Store value of typed setting
540  *
541  * @v settings          Settings block
542  * @v setting           Setting to store
543  * @v type              Settings type
544  * @v value             Formatted setting data, or NULL
545  * @ret rc              Return status code
546  */
547 int storef_setting ( struct settings *settings, struct setting *setting,
548                      const char *value ) {
549
550         /* NULL value implies deletion.  Avoid imposing the burden of
551          * checking for NULL values on each typed setting's storef()
552          * method.
553          */
554         if ( ! value )
555                 return delete_setting ( settings, setting );
556                 
557         return setting->type->storef ( settings, setting, value );
558 }
559
560 /**
561  * Find named setting
562  *
563  * @v name              Name
564  * @ret setting         Named setting, or NULL
565  */
566 static struct setting * find_setting ( const char *name ) {
567         struct setting *setting;
568
569         for ( setting = settings ; setting < settings_end ; setting++ ) {
570                 if ( strcmp ( name, setting->name ) == 0 )
571                         return setting;
572         }
573         return NULL;
574 }
575
576 /**
577  * Find setting type
578  *
579  * @v name              Name
580  * @ret type            Setting type, or NULL
581  */
582 static struct setting_type * find_setting_type ( const char *name ) {
583         struct setting_type *type;
584
585         for ( type = setting_types ; type < setting_types_end ; type++ ) {
586                 if ( strcmp ( name, type->name ) == 0 )
587                         return type;
588         }
589         return NULL;
590 }
591
592 /**
593  * Parse setting name
594  *
595  * @v name              Name of setting
596  * @v settings          Settings block to fill in
597  * @v setting           Setting to fill in
598  * @ret rc              Return status code
599  *
600  * Interprets a name of the form
601  * "[settings_name/]tag_name[:type_name]" and fills in the appropriate
602  * fields.
603  */
604 static int parse_setting_name ( const char *name, struct settings **settings,
605                                 struct setting *setting ) {
606         char tmp_name[ strlen ( name ) + 1 ];
607         char *settings_name;
608         char *setting_name;
609         char *type_name;
610         struct setting *named_setting;
611         char *tmp;
612
613         /* Set defaults */
614         *settings = &settings_root;
615         memset ( setting, 0, sizeof ( *setting ) );
616         setting->type = &setting_type_hex;
617
618         /* Split name into "[settings_name/]setting_name[:type_name]" */
619         memcpy ( tmp_name, name, sizeof ( tmp_name ) );
620         if ( ( setting_name = strchr ( tmp_name, '/' ) ) != NULL ) {
621                 *(setting_name++) = 0;
622                 settings_name = tmp_name;
623         } else {
624                 setting_name = tmp_name;
625                 settings_name = NULL;
626         }
627         if ( ( type_name = strchr ( setting_name, ':' ) ) != NULL )
628                 *(type_name++) = 0;
629
630         /* Identify settings block, if specified */
631         if ( settings_name ) {
632                 *settings = find_settings ( settings_name );
633                 if ( *settings == NULL ) {
634                         DBG ( "Unrecognised settings block \"%s\" in \"%s\"\n",
635                               settings_name, name );
636                         return -ENODEV;
637                 }
638         }
639
640         /* Identify tag number */
641         if ( ( named_setting = find_setting ( setting_name ) ) != NULL ) {
642                 memcpy ( setting, named_setting, sizeof ( *setting ) );
643         } else {
644                 /* Unrecognised name: try to interpret as a tag number */
645                 tmp = setting_name;
646                 while ( 1 ) {
647                         setting->tag = ( ( setting->tag << 8 ) |
648                                          strtoul ( tmp, &tmp, 0 ) );
649                         if ( *tmp == 0 )
650                                 break;
651                         if ( *tmp != '.' ) {
652                                 DBG ( "Invalid setting \"%s\" in \"%s\"\n",
653                                       setting_name, name );
654                                 return -ENOENT;
655                         }
656                         tmp++;
657                 }
658         }
659
660         /* Identify setting type, if specified */
661         if ( type_name ) {
662                 setting->type = find_setting_type ( type_name );
663                 if ( setting->type == NULL ) {
664                         DBG ( "Invalid setting type \"%s\" in \"%s\"\n",
665                               type_name, name );
666                         return -ENOTSUP;
667                 }
668         }
669
670         return 0;
671 }
672
673 /**
674  * Parse and store value of named setting
675  *
676  * @v name              Name of setting
677  * @v value             Formatted setting data, or NULL
678  * @ret rc              Return status code
679  */
680 int storef_named_setting ( const char *name, const char *value ) {
681         struct settings *settings;
682         struct setting setting;
683         int rc;
684
685         if ( ( rc = parse_setting_name ( name, &settings, &setting ) ) != 0 )
686                 return rc;
687         return storef_setting ( settings, &setting, value );
688 }
689
690 /**
691  * Fetch and format value of named setting
692  *
693  * @v name              Name of setting
694  * @v buf               Buffer to contain formatted value
695  * @v len               Length of buffer
696  * @ret len             Length of formatted value, or negative error
697  */
698 int fetchf_named_setting ( const char *name, char *buf, size_t len ) {
699         struct settings *settings;
700         struct setting setting;
701         int rc;
702
703         if ( ( rc = parse_setting_name ( name, &settings, &setting ) ) != 0 )
704                 return rc;
705         return fetchf_setting ( settings, &setting, buf, len );
706 }
707
708 /******************************************************************************
709  *
710  * Setting types
711  *
712  ******************************************************************************
713  */
714
715 /**
716  * Parse and store value of string setting
717  *
718  * @v settings          Settings block
719  * @v setting           Setting to store
720  * @v value             Formatted setting data
721  * @ret rc              Return status code
722  */
723 static int storef_string ( struct settings *settings, struct setting *setting,
724                            const char *value ) {
725         return store_setting ( settings, setting, value, strlen ( value ) );
726 }
727
728 /**
729  * Fetch and format value of string setting
730  *
731  * @v settings          Settings block, or NULL to search all blocks
732  * @v setting           Setting to fetch
733  * @v buf               Buffer to contain formatted value
734  * @v len               Length of buffer
735  * @ret len             Length of formatted value, or negative error
736  */
737 static int fetchf_string ( struct settings *settings, struct setting *setting,
738                            char *buf, size_t len ) {
739         return fetch_string_setting ( settings, setting, buf, len );
740 }
741
742 /** A string setting type */
743 struct setting_type setting_type_string __setting_type = {
744         .name = "string",
745         .storef = storef_string,
746         .fetchf = fetchf_string,
747 };
748
749 /**
750  * Parse and store value of URI-encoded string setting
751  *
752  * @v settings          Settings block
753  * @v setting           Setting to store
754  * @v value             Formatted setting data
755  * @ret rc              Return status code
756  */
757 static int storef_uristring ( struct settings *settings,
758                               struct setting *setting,
759                               const char *value ) {
760         char buf[ strlen ( value ) + 1 ]; /* Decoding never expands string */
761         size_t len;
762
763         len = uri_decode ( value, buf, sizeof ( buf ) );
764         return store_setting ( settings, setting, buf, len );
765 }
766
767 /**
768  * Fetch and format value of URI-encoded string setting
769  *
770  * @v settings          Settings block, or NULL to search all blocks
771  * @v setting           Setting to fetch
772  * @v buf               Buffer to contain formatted value
773  * @v len               Length of buffer
774  * @ret len             Length of formatted value, or negative error
775  */
776 static int fetchf_uristring ( struct settings *settings,
777                               struct setting *setting,
778                               char *buf, size_t len ) {
779         size_t raw_len;
780
781         /* We need to always retrieve the full raw string to know the
782          * length of the encoded string.
783          */
784         raw_len = fetch_setting ( settings, setting, NULL, 0 );
785         {
786                 char raw_buf[ raw_len + 1 ];
787        
788                 fetch_string_setting ( settings, setting, raw_buf,
789                                        sizeof ( raw_buf ) );
790                 return uri_encode ( raw_buf, buf, len );
791         }
792 }
793
794 /** A URI-encoded string setting type */
795 struct setting_type setting_type_uristring __setting_type = {
796         .name = "uristring",
797         .storef = storef_uristring,
798         .fetchf = fetchf_uristring,
799 };
800
801 /**
802  * Parse and store value of IPv4 address setting
803  *
804  * @v settings          Settings block
805  * @v setting           Setting to store
806  * @v value             Formatted setting data
807  * @ret rc              Return status code
808  */
809 static int storef_ipv4 ( struct settings *settings, struct setting *setting,
810                          const char *value ) {
811         struct in_addr ipv4;
812
813         if ( inet_aton ( value, &ipv4 ) == 0 )
814                 return -EINVAL;
815         return store_setting ( settings, setting, &ipv4, sizeof ( ipv4 ) );
816 }
817
818 /**
819  * Fetch and format value of IPv4 address setting
820  *
821  * @v settings          Settings block, or NULL to search all blocks
822  * @v setting           Setting to fetch
823  * @v buf               Buffer to contain formatted value
824  * @v len               Length of buffer
825  * @ret len             Length of formatted value, or negative error
826  */
827 static int fetchf_ipv4 ( struct settings *settings, struct setting *setting,
828                          char *buf, size_t len ) {
829         struct in_addr ipv4;
830         int raw_len;
831
832         if ( ( raw_len = fetch_ipv4_setting ( settings, setting, &ipv4 ) ) < 0)
833                 return raw_len;
834         return snprintf ( buf, len, "%s", inet_ntoa ( ipv4 ) );
835 }
836
837 /** An IPv4 address setting type */
838 struct setting_type setting_type_ipv4 __setting_type = {
839         .name = "ipv4",
840         .storef = storef_ipv4,
841         .fetchf = fetchf_ipv4,
842 };
843
844 /**
845  * Parse and store value of integer setting
846  *
847  * @v settings          Settings block
848  * @v setting           Setting to store
849  * @v value             Formatted setting data
850  * @v size              Integer size, in bytes
851  * @ret rc              Return status code
852  */
853 static int storef_int ( struct settings *settings, struct setting *setting,
854                         const char *value, unsigned int size ) {
855         union {
856                 uint32_t num;
857                 uint8_t bytes[4];
858         } u;
859         char *endp;
860
861         u.num = htonl ( strtoul ( value, &endp, 0 ) );
862         if ( *endp )
863                 return -EINVAL;
864         return store_setting ( settings, setting, 
865                                &u.bytes[ sizeof ( u ) - size ], size );
866 }
867
868 /**
869  * Parse and store value of 8-bit integer setting
870  *
871  * @v settings          Settings block
872  * @v setting           Setting to store
873  * @v value             Formatted setting data
874  * @v size              Integer size, in bytes
875  * @ret rc              Return status code
876  */
877 static int storef_int8 ( struct settings *settings, struct setting *setting,
878                          const char *value ) {
879         return storef_int ( settings, setting, value, 1 );
880 }
881
882 /**
883  * Parse and store value of 16-bit integer setting
884  *
885  * @v settings          Settings block
886  * @v setting           Setting to store
887  * @v value             Formatted setting data
888  * @v size              Integer size, in bytes
889  * @ret rc              Return status code
890  */
891 static int storef_int16 ( struct settings *settings, struct setting *setting,
892                           const char *value ) {
893         return storef_int ( settings, setting, value, 2 );
894 }
895
896 /**
897  * Parse and store value of 32-bit integer setting
898  *
899  * @v settings          Settings block
900  * @v setting           Setting to store
901  * @v value             Formatted setting data
902  * @v size              Integer size, in bytes
903  * @ret rc              Return status code
904  */
905 static int storef_int32 ( struct settings *settings, struct setting *setting,
906                           const char *value ) {
907         return storef_int ( settings, setting, value, 4 );
908 }
909
910 /**
911  * Fetch and format value of signed integer setting
912  *
913  * @v settings          Settings block, or NULL to search all blocks
914  * @v setting           Setting to fetch
915  * @v buf               Buffer to contain formatted value
916  * @v len               Length of buffer
917  * @ret len             Length of formatted value, or negative error
918  */
919 static int fetchf_int ( struct settings *settings, struct setting *setting,
920                         char *buf, size_t len ) {
921         long value;
922         int rc;
923
924         if ( ( rc = fetch_int_setting ( settings, setting, &value ) ) < 0 )
925                 return rc;
926         return snprintf ( buf, len, "%ld", value );
927 }
928
929 /**
930  * Fetch and format value of unsigned integer setting
931  *
932  * @v settings          Settings block, or NULL to search all blocks
933  * @v setting           Setting to fetch
934  * @v buf               Buffer to contain formatted value
935  * @v len               Length of buffer
936  * @ret len             Length of formatted value, or negative error
937  */
938 static int fetchf_uint ( struct settings *settings, struct setting *setting,
939                          char *buf, size_t len ) {
940         unsigned long value;
941         int rc;
942
943         if ( ( rc = fetch_uint_setting ( settings, setting, &value ) ) < 0 )
944                 return rc;
945         return snprintf ( buf, len, "%#lx", value );
946 }
947
948 /** A signed 8-bit integer setting type */
949 struct setting_type setting_type_int8 __setting_type = {
950         .name = "int8",
951         .storef = storef_int8,
952         .fetchf = fetchf_int,
953 };
954
955 /** A signed 16-bit integer setting type */
956 struct setting_type setting_type_int16 __setting_type = {
957         .name = "int16",
958         .storef = storef_int16,
959         .fetchf = fetchf_int,
960 };
961
962 /** A signed 32-bit integer setting type */
963 struct setting_type setting_type_int32 __setting_type = {
964         .name = "int32",
965         .storef = storef_int32,
966         .fetchf = fetchf_int,
967 };
968
969 /** An unsigned 8-bit integer setting type */
970 struct setting_type setting_type_uint8 __setting_type = {
971         .name = "uint8",
972         .storef = storef_int8,
973         .fetchf = fetchf_uint,
974 };
975
976 /** An unsigned 16-bit integer setting type */
977 struct setting_type setting_type_uint16 __setting_type = {
978         .name = "uint16",
979         .storef = storef_int16,
980         .fetchf = fetchf_uint,
981 };
982
983 /** An unsigned 32-bit integer setting type */
984 struct setting_type setting_type_uint32 __setting_type = {
985         .name = "uint32",
986         .storef = storef_int32,
987         .fetchf = fetchf_uint,
988 };
989
990 /**
991  * Parse and store value of hex string setting
992  *
993  * @v settings          Settings block
994  * @v setting           Setting to store
995  * @v value             Formatted setting data
996  * @ret rc              Return status code
997  */
998 static int storef_hex ( struct settings *settings, struct setting *setting,
999                         const char *value ) {
1000         char *ptr = ( char * ) value;
1001         uint8_t bytes[ strlen ( value ) ]; /* cannot exceed strlen(value) */
1002         unsigned int len = 0;
1003
1004         while ( 1 ) {
1005                 bytes[len++] = strtoul ( ptr, &ptr, 16 );
1006                 switch ( *ptr ) {
1007                 case '\0' :
1008                         return store_setting ( settings, setting, bytes, len );
1009                 case ':' :
1010                         ptr++;
1011                         break;
1012                 default :
1013                         return -EINVAL;
1014                 }
1015         }
1016 }
1017
1018 /**
1019  * Fetch and format value of hex string setting
1020  *
1021  * @v settings          Settings block, or NULL to search all blocks
1022  * @v setting           Setting to fetch
1023  * @v buf               Buffer to contain formatted value
1024  * @v len               Length of buffer
1025  * @ret len             Length of formatted value, or negative error
1026  */
1027 static int fetchf_hex ( struct settings *settings, struct setting *setting,
1028                         char *buf, size_t len ) {
1029         int raw_len;
1030         int check_len;
1031         int used = 0;
1032         int i;
1033
1034         raw_len = fetch_setting_len ( settings, setting );
1035         if ( raw_len < 0 )
1036                 return raw_len;
1037
1038         {
1039                 uint8_t raw[raw_len];
1040
1041                 check_len = fetch_setting ( settings, setting, raw,
1042                                             sizeof ( raw ) );
1043                 assert ( check_len == raw_len );
1044                 
1045                 if ( len )
1046                         buf[0] = 0; /* Ensure that a terminating NUL exists */
1047                 for ( i = 0 ; i < raw_len ; i++ ) {
1048                         used += ssnprintf ( ( buf + used ), ( len - used ),
1049                                             "%s%02x", ( used ? ":" : "" ),
1050                                             raw[i] );
1051                 }
1052                 return used;
1053         }
1054 }
1055
1056 /** A hex-string setting */
1057 struct setting_type setting_type_hex __setting_type = {
1058         .name = "hex",
1059         .storef = storef_hex,
1060         .fetchf = fetchf_hex,
1061 };
1062
1063 /**
1064  * Parse and store value of UUID setting
1065  *
1066  * @v settings          Settings block
1067  * @v setting           Setting to store
1068  * @v value             Formatted setting data
1069  * @ret rc              Return status code
1070  */
1071 static int storef_uuid ( struct settings *settings __unused,
1072                          struct setting *setting __unused,
1073                          const char *value __unused ) {
1074         return -ENOTSUP;
1075 }
1076
1077 /**
1078  * Fetch and format value of UUID setting
1079  *
1080  * @v settings          Settings block, or NULL to search all blocks
1081  * @v setting           Setting to fetch
1082  * @v buf               Buffer to contain formatted value
1083  * @v len               Length of buffer
1084  * @ret len             Length of formatted value, or negative error
1085  */
1086 static int fetchf_uuid ( struct settings *settings, struct setting *setting,
1087                          char *buf, size_t len ) {
1088         union uuid uuid;
1089         int raw_len;
1090
1091         if ( ( raw_len = fetch_uuid_setting ( settings, setting, &uuid ) ) < 0)
1092                 return raw_len;
1093         return snprintf ( buf, len, "%s", uuid_ntoa ( &uuid ) );
1094 }
1095
1096 /** UUID setting type */
1097 struct setting_type setting_type_uuid __setting_type = {
1098         .name = "uuid",
1099         .storef = storef_uuid,
1100         .fetchf = fetchf_uuid,
1101 };
1102
1103 /******************************************************************************
1104  *
1105  * Settings
1106  *
1107  ******************************************************************************
1108  */
1109
1110 /** Hostname setting */
1111 struct setting hostname_setting __setting = {
1112         .name = "hostname",
1113         .description = "Host name",
1114         .tag = DHCP_HOST_NAME,
1115         .type = &setting_type_string,
1116 };
1117
1118 /** Filename setting */
1119 struct setting filename_setting __setting = {
1120         .name = "filename",
1121         .description = "Boot filename",
1122         .tag = DHCP_BOOTFILE_NAME,
1123         .type = &setting_type_string,
1124 };
1125
1126 /** Root path setting */
1127 struct setting root_path_setting __setting = {
1128         .name = "root-path",
1129         .description = "NFS/iSCSI root path",
1130         .tag = DHCP_ROOT_PATH,
1131         .type = &setting_type_string,
1132 };
1133
1134 /** Username setting */
1135 struct setting username_setting __setting = {
1136         .name = "username",
1137         .description = "User name",
1138         .tag = DHCP_EB_USERNAME,
1139         .type = &setting_type_string,
1140 };
1141
1142 /** Password setting */
1143 struct setting password_setting __setting = {
1144         .name = "password",
1145         .description = "Password",
1146         .tag = DHCP_EB_PASSWORD,
1147         .type = &setting_type_string,
1148 };
1149
1150 /** Priority setting */
1151 struct setting priority_setting __setting = {
1152         .name = "priority",
1153         .description = "Priority of these settings",
1154         .tag = DHCP_EB_PRIORITY,
1155         .type = &setting_type_int8,
1156 };