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