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