4f7f98efa32e7e3778a02908f359dc45d950ab98
[people/sha0/gpxe.git] / src / include / gpxe / settings.h
1 #ifndef _GPXE_SETTINGS_H
2 #define _GPXE_SETTINGS_H
3
4 /** @file
5  *
6  * Configuration settings
7  *
8  */
9
10 #include <stdint.h>
11 #include <gpxe/tables.h>
12 #include <gpxe/list.h>
13 #include <gpxe/refcnt.h>
14 #include <gpxe/dhcpopts.h>
15
16 struct settings;
17 struct in_addr;
18 union uuid;
19
20 /** A setting */
21 struct setting {
22         /** Name
23          *
24          * This is the human-readable name for the setting.
25          */
26         const char *name;
27         /** Description */
28         const char *description;
29         /** Setting type
30          *
31          * This identifies the type of setting (e.g. string, IPv4
32          * address, etc.).
33          */
34         struct setting_type *type;
35         /** DHCP option number, if applicable */
36         unsigned int tag;
37 };
38
39 /** Configuration setting table */
40 #define SETTINGS "settings"
41
42 /** Declare a configuration setting */
43 #define __setting __table ( struct setting, SETTINGS, 01 )
44
45 /** Settings block operations */
46 struct settings_operations {
47         /** Store value of setting
48          *
49          * @v settings          Settings block
50          * @v setting           Setting to store
51          * @v data              Setting data, or NULL to clear setting
52          * @v len               Length of setting data
53          * @ret rc              Return status code
54          */
55         int ( * store ) ( struct settings *settings, struct setting *setting,
56                           const void *data, size_t len );
57         /** Fetch value of setting
58          *
59          * @v settings          Settings block
60          * @v setting           Setting to fetch
61          * @v data              Buffer to fill with setting data
62          * @v len               Length of buffer
63          * @ret len             Length of setting data, or negative error
64          *
65          * The actual length of the setting will be returned even if
66          * the buffer was too small.
67          */
68         int ( * fetch ) ( struct settings *settings, struct setting *setting,
69                           void *data, size_t len );
70 };
71
72 /** A settings block */
73 struct settings {
74         /** Reference counter */
75         struct refcnt *refcnt;
76         /** Name */
77         const char *name;
78         /** Tag magic
79          *
80          * This value will be ORed in to any numerical tags
81          * constructed by parse_setting_name(), and can be used to
82          * avoid e.g. attempting to retrieve the subnet mask from
83          * SMBIOS, or the system UUID from DHCP.
84          */
85         unsigned int tag_magic;
86         /** Parent settings block */
87         struct settings *parent;
88         /** Sibling settings blocks */
89         struct list_head siblings;
90         /** Child settings blocks */
91         struct list_head children;
92         /** Settings block operations */
93         struct settings_operations *op;
94 };
95
96 /**
97  * A setting type
98  *
99  * This represents a type of setting (e.g. string, IPv4 address,
100  * etc.).
101  */
102 struct setting_type {
103         /** Name
104          *
105          * This is the name exposed to the user (e.g. "string").
106          */
107         const char *name;
108         /** Parse and set value of setting
109          *
110          * @v settings          Settings block
111          * @v setting           Setting to store
112          * @v value             Formatted setting data
113          * @ret rc              Return status code
114          */
115         int ( * storef ) ( struct settings *settings, struct setting *setting,
116                            const char *value );
117         /** Fetch and format value of setting
118          *
119          * @v settings          Settings block
120          * @v setting           Setting to fetch
121          * @v buf               Buffer to contain formatted value
122          * @v len               Length of buffer
123          * @ret len             Length of formatted value, or negative error
124          */
125         int ( * fetchf ) ( struct settings *settings, struct setting *setting,
126                            char *buf, size_t len );
127 };
128
129 /** Configuration setting type table */
130 #define SETTING_TYPES "setting_types"
131
132 /** Declare a configuration setting type */
133 #define __setting_type \
134         __table ( struct setting_type, SETTING_TYPES, 01 )
135
136 /**
137  * A settings applicator
138  *
139  */
140 struct settings_applicator {
141         /** Apply updated settings
142          *
143          * @ret rc              Return status code
144          */
145         int ( * apply ) ( void );
146 };
147
148 /** Settings applicator table */
149 #define SETTINGS_APPLICATORS "settings_applicators"
150
151 /** Declare a settings applicator */
152 #define __settings_applicator \
153         __table ( struct settings_applicator, SETTINGS_APPLICATORS, 01 )
154
155 /**
156  * A simple settings block
157  *
158  */
159 struct simple_settings {
160         /** Settings block */
161         struct settings settings;
162         /** DHCP options */
163         struct dhcp_options dhcpopts;
164 };
165
166 extern struct settings_operations simple_settings_operations;
167 extern int simple_settings_store ( struct settings *settings,
168                                    struct setting *setting,
169                                    const void *data, size_t len );
170 extern int simple_settings_fetch ( struct settings *settings,
171                                    struct setting *setting,
172                                    void *data, size_t len );
173
174 extern int register_settings ( struct settings *settings,
175                                struct settings *parent );
176 extern void unregister_settings ( struct settings *settings );
177
178 extern int store_setting ( struct settings *settings, struct setting *setting,
179                            const void *data, size_t len );
180 extern int fetch_setting ( struct settings *settings, struct setting *setting,
181                            void *data, size_t len );
182 extern int fetch_setting_len ( struct settings *settings,
183                                struct setting *setting );
184 extern int fetch_string_setting ( struct settings *settings,
185                                   struct setting *setting,
186                                   char *data, size_t len );
187 extern int fetch_string_setting_copy ( struct settings *settings,
188                                        struct setting *setting,
189                                        char **data );
190 extern int fetch_ipv4_setting ( struct settings *settings,
191                                 struct setting *setting, struct in_addr *inp );
192 extern int fetch_int_setting ( struct settings *settings,
193                                struct setting *setting, long *value );
194 extern int fetch_uint_setting ( struct settings *settings,
195                                 struct setting *setting,
196                                 unsigned long *value );
197 extern long fetch_intz_setting ( struct settings *settings,
198                                  struct setting *setting );
199 extern unsigned long fetch_uintz_setting ( struct settings *settings,
200                                            struct setting *setting );
201 extern int fetch_uuid_setting ( struct settings *settings,
202                                 struct setting *setting, union uuid *uuid );
203 extern int setting_cmp ( struct setting *a, struct setting *b );
204
205 extern struct settings * find_settings ( const char *name );
206
207 extern int storef_setting ( struct settings *settings,
208                             struct setting *setting,
209                             const char *value );
210 extern int storef_named_setting ( const char *name, const char *value );
211 extern int fetchf_named_setting ( const char *name, char *buf, size_t len );
212
213 extern struct setting_type setting_type_string __setting_type;
214 extern struct setting_type setting_type_ipv4 __setting_type;
215 extern struct setting_type setting_type_int8 __setting_type;
216 extern struct setting_type setting_type_int16 __setting_type;
217 extern struct setting_type setting_type_int32 __setting_type;
218 extern struct setting_type setting_type_uint8 __setting_type;
219 extern struct setting_type setting_type_uint16 __setting_type;
220 extern struct setting_type setting_type_uint32 __setting_type;
221 extern struct setting_type setting_type_hex __setting_type;
222 extern struct setting_type setting_type_uuid __setting_type;
223
224 extern struct setting ip_setting __setting;
225 extern struct setting netmask_setting __setting;
226 extern struct setting gateway_setting __setting;
227 extern struct setting dns_setting __setting;
228 extern struct setting domain_setting __setting;
229 extern struct setting hostname_setting __setting;
230 extern struct setting filename_setting __setting;
231 extern struct setting root_path_setting __setting;
232 extern struct setting username_setting __setting;
233 extern struct setting password_setting __setting;
234 extern struct setting priority_setting __setting;
235 extern struct setting uuid_setting __setting;
236 extern struct setting next_server_setting __setting;
237 extern struct setting mac_setting __setting;
238 extern struct setting user_class_setting __setting;
239
240 /**
241  * Initialise a settings block
242  *
243  * @v settings          Settings block
244  * @v op                Settings block operations
245  * @v refcnt            Containing object reference counter, or NULL
246  * @v name              Settings block name
247  * @v tag_magic         Tag magic
248  */
249 static inline void settings_init ( struct settings *settings,
250                                    struct settings_operations *op,
251                                    struct refcnt *refcnt,
252                                    const char *name,
253                                    unsigned int tag_magic ) {
254         INIT_LIST_HEAD ( &settings->siblings );
255         INIT_LIST_HEAD ( &settings->children );
256         settings->op = op;
257         settings->refcnt = refcnt;
258         settings->name = name;
259         settings->tag_magic = tag_magic;
260 }
261
262 /**
263  * Initialise a settings block
264  *
265  * @v simple            Simple settings block
266  * @v refcnt            Containing object reference counter, or NULL
267  * @v name              Settings block name
268  */
269 static inline void simple_settings_init ( struct simple_settings *simple,
270                                           struct refcnt *refcnt,
271                                           const char *name ) {
272         settings_init ( &simple->settings, &simple_settings_operations,
273                         refcnt, name, 0 );
274 }
275
276 /**
277  * Delete setting
278  *
279  * @v settings          Settings block
280  * @v setting           Setting to delete
281  * @ret rc              Return status code
282  */
283 static inline int delete_setting ( struct settings *settings,
284                                    struct setting *setting ) {
285         return store_setting ( settings, setting, NULL, 0 );
286 }
287
288 /**
289  * Fetch and format value of setting
290  *
291  * @v settings          Settings block, or NULL to search all blocks
292  * @v setting           Setting to fetch
293  * @v type              Settings type
294  * @v buf               Buffer to contain formatted value
295  * @v len               Length of buffer
296  * @ret len             Length of formatted value, or negative error
297  */
298 static inline int fetchf_setting ( struct settings *settings,
299                                    struct setting *setting,
300                                    char *buf, size_t len ) {
301         return setting->type->fetchf ( settings, setting, buf, len );
302 }
303
304 /**
305  * Delete named setting
306  *
307  * @v name              Name of setting
308  * @ret rc              Return status code
309  */
310 static inline int delete_named_setting ( const char *name ) {
311         return storef_named_setting ( name, NULL );
312 }
313
314 /**
315  * Check existence of setting
316  *
317  * @v settings          Settings block, or NULL to search all blocks
318  * @v setting           Setting to fetch
319  * @ret exists          Setting exists
320  */
321 static inline int setting_exists ( struct settings *settings,
322                                    struct setting *setting ) {
323         return ( fetch_setting_len ( settings, setting ) >= 0 );
324 }
325
326 #endif /* _GPXE_SETTINGS_H */