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