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