[Settings] Migrate DHCP and NVO code to the new settings API (untested)
[people/dverkamp/gpxe.git] / src / net / dhcpopts.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 <errno.h>
23 #include <string.h>
24 #include <gpxe/dhcp.h>
25 #include <gpxe/dhcpopts.h>
26
27 /** @file
28  *
29  * DHCP options
30  *
31  */
32
33 /**
34  * Obtain printable version of a DHCP option tag
35  *
36  * @v tag               DHCP option tag
37  * @ret name            String representation of the tag
38  *
39  */
40 static inline char * dhcp_tag_name ( unsigned int tag ) {
41         static char name[8];
42
43         if ( DHCP_IS_ENCAP_OPT ( tag ) ) {
44                 snprintf ( name, sizeof ( name ), "%d.%d",
45                            DHCP_ENCAPSULATOR ( tag ),
46                            DHCP_ENCAPSULATED ( tag ) );
47         } else {
48                 snprintf ( name, sizeof ( name ), "%d", tag );
49         }
50         return name;
51 }
52
53 /**
54  * Get pointer to DHCP option
55  *
56  * @v options           DHCP options block
57  * @v offset            Offset within options block
58  * @ret option          DHCP option
59  */
60 static inline __attribute__ (( always_inline )) struct dhcp_option *
61 dhcp_option ( struct dhcp_options *options, unsigned int offset ) {
62         return ( ( struct dhcp_option * ) ( options->data + offset ) );
63 }
64
65 /**
66  * Get offset of a DHCP option
67  *
68  * @v options           DHCP options block
69  * @v option            DHCP option
70  * @ret offset          Offset within options block
71  */
72 static inline __attribute__ (( always_inline )) int
73 dhcp_option_offset ( struct dhcp_options *options,
74                      struct dhcp_option *option ) {
75         return ( ( ( void * ) option ) - options->data );
76 }
77
78 /**
79  * Calculate length of any DHCP option
80  *
81  * @v option            DHCP option
82  * @ret len             Length (including tag and length field)
83  */
84 static unsigned int dhcp_option_len ( struct dhcp_option *option ) {
85         if ( ( option->tag == DHCP_END ) || ( option->tag == DHCP_PAD ) ) {
86                 return 1;
87         } else {
88                 return ( option->len + DHCP_OPTION_HEADER_LEN );
89         }
90 }
91
92 /**
93  * Find DHCP option within DHCP options block, and its encapsulator (if any)
94  *
95  * @v options           DHCP options block
96  * @v tag               DHCP option tag to search for
97  * @ret encap_offset    Offset of encapsulating DHCP option
98  * @ret offset          Offset of DHCP option, or negative error
99  *
100  * Searches for the DHCP option matching the specified tag within the
101  * DHCP option block.  Encapsulated options may be searched for by
102  * using DHCP_ENCAP_OPT() to construct the tag value.
103  *
104  * If the option is encapsulated, and @c encapsulator is non-NULL, it
105  * will be filled in with the offset of the encapsulating option.
106  *
107  * This routine is designed to be paranoid.  It does not assume that
108  * the option data is well-formatted, and so must guard against flaws
109  * such as options missing a @c DHCP_END terminator, or options whose
110  * length would take them beyond the end of the data block.
111  */
112 static int find_dhcp_option_with_encap ( struct dhcp_options *options,
113                                          unsigned int tag,
114                                          int *encap_offset ) {
115         unsigned int original_tag __attribute__ (( unused )) = tag;
116         struct dhcp_option *option;
117         int offset = 0;
118         ssize_t remaining = options->len;
119         unsigned int option_len;
120
121         while ( remaining ) {
122                 /* Calculate length of this option.  Abort processing
123                  * if the length is malformed (i.e. takes us beyond
124                  * the end of the data block).
125                  */
126                 option = dhcp_option ( options, offset );
127                 option_len = dhcp_option_len ( option );
128                 remaining -= option_len;
129                 if ( remaining < 0 )
130                         break;
131                 /* Check for matching tag */
132                 if ( option->tag == tag ) {
133                         DBGC ( options, "DHCPOPT %p found %s (length %d)\n",
134                                options, dhcp_tag_name ( original_tag ),
135                                option_len );
136                         return offset;
137                 }
138                 /* Check for explicit end marker */
139                 if ( option->tag == DHCP_END )
140                         break;
141                 /* Check for start of matching encapsulation block */
142                 if ( DHCP_IS_ENCAP_OPT ( tag ) &&
143                      ( option->tag == DHCP_ENCAPSULATOR ( tag ) ) ) {
144                         if ( encap_offset )
145                                 *encap_offset = offset;
146                         /* Continue search within encapsulated option block */
147                         tag = DHCP_ENCAPSULATED ( tag );
148                         remaining = option_len;
149                         offset += DHCP_OPTION_HEADER_LEN;
150                         continue;
151                 }
152                 offset += option_len;
153         }
154         return -ENOENT;
155 }
156
157 /**
158  * Resize a DHCP option
159  *
160  * @v options           DHCP option block
161  * @v offset            Offset of option to resize
162  * @v encap_offset      Offset of encapsulating offset (or -ve for none)
163  * @v old_len           Old length (including header)
164  * @v new_len           New length (including header)
165  * @v can_realloc       Can reallocate options data if necessary
166  * @ret rc              Return status code
167  */
168 static int resize_dhcp_option ( struct dhcp_options *options,
169                                 int offset, int encap_offset,
170                                 size_t old_len, size_t new_len,
171                                 int can_realloc ) {
172         struct dhcp_option *encapsulator;
173         struct dhcp_option *option;
174         ssize_t delta = ( new_len - old_len );
175         size_t new_options_len;
176         size_t new_encapsulator_len;
177         void *new_data;
178         void *source;
179         void *dest;
180         void *end;
181
182         /* Check for sufficient space, and update length fields */
183         if ( new_len > DHCP_MAX_LEN )
184                 return -ENOSPC;
185         new_options_len = ( options->len + delta );
186         if ( new_options_len > options->max_len ) {
187                 /* Reallocate options block if allowed to do so. */
188                 if ( can_realloc ) {
189                         new_data = realloc ( options->data, new_options_len );
190                         if ( ! new_data )
191                                 return -ENOMEM;
192                         options->data = new_data;
193                         options->max_len = new_options_len;
194                 } else {
195                         return -ENOMEM;
196                 }
197         }
198         if ( encap_offset >= 0 ) {
199                 encapsulator = dhcp_option ( options, encap_offset );
200                 new_encapsulator_len = ( encapsulator->len + delta );
201                 if ( new_encapsulator_len > DHCP_MAX_LEN )
202                         return -ENOSPC;
203                 encapsulator->len = new_encapsulator_len;
204         }
205         options->len = new_options_len;
206
207         /* Move remainder of option data */
208         option = dhcp_option ( options, offset );
209         source = ( ( ( void * ) option ) + old_len );
210         dest = ( ( ( void * ) option ) + new_len );
211         end = ( options->data + options->max_len );
212         memmove ( dest, source, ( end - dest ) );
213
214         return 0;
215 }
216
217 /**
218  * Set value of DHCP option
219  *
220  * @v options           DHCP option block
221  * @v tag               DHCP option tag
222  * @v data              New value for DHCP option
223  * @v len               Length of value, in bytes
224  * @v can_realloc       Can reallocate options data if necessary
225  * @ret offset          Offset of DHCP option, or negative error
226  *
227  * Sets the value of a DHCP option within the options block.  The
228  * option may or may not already exist.  Encapsulators will be created
229  * (and deleted) as necessary.
230  *
231  * This call may fail due to insufficient space in the options block.
232  * If it does fail, and the option existed previously, the option will
233  * be left with its original value.
234  */
235 static int set_dhcp_option ( struct dhcp_options *options, unsigned int tag,
236                              const void *data, size_t len,
237                              int can_realloc ) {
238         static const uint8_t empty_encapsulator[] = { DHCP_END };
239         int offset;
240         int encap_offset = -1;
241         int creation_offset = 0;
242         struct dhcp_option *option;
243         unsigned int encap_tag = DHCP_ENCAPSULATOR ( tag );
244         size_t old_len = 0;
245         size_t new_len = ( len ? ( len + DHCP_OPTION_HEADER_LEN ) : 0 );
246         int rc;
247
248         /* Find old instance of this option, if any */
249         offset = find_dhcp_option_with_encap ( options, tag, &encap_offset );
250         if ( offset >= 0 ) {
251                 old_len = dhcp_option_len ( dhcp_option ( options, offset ) );
252                 DBGC ( options, "DHCPOPT %p resizing %s from %zd to %zd\n",
253                        options, dhcp_tag_name ( tag ), old_len, new_len );
254         } else {
255                 DBGC ( options, "DHCPOPT %p creating %s (length %zd)\n",
256                        options, dhcp_tag_name ( tag ), len );
257         }
258
259         /* Ensure that encapsulator exists, if required */
260         if ( encap_tag ) {
261                 if ( encap_offset < 0 )
262                         encap_offset = set_dhcp_option ( options, encap_tag,
263                                                          empty_encapsulator, 1,
264                                                          can_realloc );
265                 if ( encap_offset < 0 )
266                         return encap_offset;
267                 creation_offset = ( encap_offset + DHCP_OPTION_HEADER_LEN );
268         }
269
270         /* Create new option if necessary */
271         if ( offset < 0 )
272                 offset = creation_offset;
273
274         /* Resize option to fit new data */
275         if ( ( rc = resize_dhcp_option ( options, offset, encap_offset,
276                                          old_len, new_len,
277                                          can_realloc ) ) != 0 )
278                 return rc;
279
280         /* Copy new data into option, if applicable */
281         if ( len ) {
282                 option = dhcp_option ( options, offset );
283                 option->tag = tag;
284                 option->len = len;
285                 memcpy ( &option->data, data, len );
286         }
287
288         /* Delete encapsulator if there's nothing else left in it */
289         if ( encap_offset >= 0 ) {
290                 option = dhcp_option ( options, encap_offset );
291                 if ( option->len <= 1 )
292                         set_dhcp_option ( options, encap_tag, NULL, 0, 0 );
293         }
294
295         return offset;
296 }
297
298 /**
299  * Store value of DHCP option setting
300  *
301  * @v options           DHCP option block
302  * @v tag               Setting tag number
303  * @v data              Setting data, or NULL to clear setting
304  * @v len               Length of setting data
305  * @ret rc              Return status code
306  */
307 int dhcpopt_store ( struct dhcp_options *options, unsigned int tag,
308                     const void *data, size_t len ) {
309         int offset;
310
311         offset = set_dhcp_option ( options, tag, data, len, 0 );
312         if ( offset < 0 )
313                 return offset;
314         return 0;
315 }
316
317 /**
318  * Store value of DHCP option setting, extending options block if necessary
319  *
320  * @v options           DHCP option block
321  * @v tag               Setting tag number
322  * @v data              Setting data, or NULL to clear setting
323  * @v len               Length of setting data
324  * @ret rc              Return status code
325  */
326 int dhcpopt_extensible_store ( struct dhcp_options *options, unsigned int tag,
327                                const void *data, size_t len ) {
328         int offset;
329
330         offset = set_dhcp_option ( options, tag, data, len, 1 );
331         if ( offset < 0 )
332                 return offset;
333         return 0;
334 }
335
336 /**
337  * Fetch value of DHCP option setting
338  *
339  * @v options           DHCP option block
340  * @v tag               Setting tag number
341  * @v data              Buffer to fill with setting data
342  * @v len               Length of buffer
343  * @ret len             Length of setting data, or negative error
344  */
345 int dhcpopt_fetch ( struct dhcp_options *options, unsigned int tag,
346                     void *data, size_t len ) {
347         int offset;
348         struct dhcp_option *option;
349         size_t option_len;
350
351         offset = find_dhcp_option_with_encap ( options, tag, NULL );
352         if ( offset < 0 )
353                 return offset;
354
355         option = dhcp_option ( options, offset );
356         option_len = dhcp_option_len ( option );
357         if ( len > option_len )
358                 len = option_len;
359         memcpy ( data, option->data, len );
360
361         return option_len;
362 }
363
364 /**
365  * Recalculate length of DHCP options block
366  *
367  * @v options           Uninitialised DHCP option block
368  *
369  * The "used length" field will be updated based on scanning through
370  * the block to find the end of the options.
371  */
372 static void dhcpopt_update_len ( struct dhcp_options *options ) {
373         struct dhcp_option *option;
374         int offset = 0;
375         ssize_t remaining = options->max_len;
376         unsigned int option_len;
377
378         /* Find last non-pad option */
379         options->len = 0;
380         while ( remaining ) {
381                 option = dhcp_option ( options, offset );
382                 option_len = dhcp_option_len ( option );
383                 remaining -= option_len;
384                 if ( remaining < 0 )
385                         break;
386                 offset += option_len;
387                 if ( option->tag != DHCP_PAD )
388                         options->len = offset;
389         }
390 }
391
392 /**
393  * Initialise prepopulated block of DHCP options
394  *
395  * @v options           Uninitialised DHCP option block
396  * @v data              Memory for DHCP option data
397  * @v max_len           Length of memory for DHCP option data
398  *
399  * The memory content must already be filled with valid DHCP options.
400  * A zeroed block counts as a block of valid DHCP options.
401  */
402 void dhcpopt_init ( struct dhcp_options *options, void *data,
403                     size_t max_len ) {
404
405         /* Fill in fields */
406         options->data = data;
407         options->max_len = max_len;
408
409         /* Update length */
410         dhcpopt_update_len ( options );
411
412         DBGC ( options, "DHCPOPT %p created (data %p len %#zx max_len %#zx)\n",
413                options, options->data, options->len, options->max_len );
414 }