[Settings] Introduce settings applicators.
[people/mcb30/gpxe.git] / src / net / dhcpopts.c
1 /*
2  * Copyright (C) 2006 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 <byteswap.h>
23 #include <errno.h>
24 #include <string.h>
25 #include <assert.h>
26 #include <gpxe/list.h>
27 #include <gpxe/in.h>
28 #include <gpxe/uri.h>
29 #include <gpxe/dhcp.h>
30
31 /** @file
32  *
33  * DHCP options
34  *
35  */
36
37 /** List of registered DHCP option blocks */
38 LIST_HEAD ( dhcp_option_blocks );
39
40 /**
41  * Obtain printable version of a DHCP option tag
42  *
43  * @v tag               DHCP option tag
44  * @ret name            String representation of the tag
45  *
46  */
47 static inline char * dhcp_tag_name ( unsigned int tag ) {
48         static char name[8];
49
50         if ( DHCP_IS_ENCAP_OPT ( tag ) ) {
51                 snprintf ( name, sizeof ( name ), "%d.%d",
52                            DHCP_ENCAPSULATOR ( tag ),
53                            DHCP_ENCAPSULATED ( tag ) );
54         } else {
55                 snprintf ( name, sizeof ( name ), "%d", tag );
56         }
57         return name;
58 }
59
60 /**
61  * Obtain value of a numerical DHCP option
62  *
63  * @v option            DHCP option, or NULL
64  * @ret value           Numerical value of the option, or 0
65  *
66  * Parses the numerical value from a DHCP option, if present.  It is
67  * permitted to call dhcp_num_option() with @c option set to NULL; in
68  * this case 0 will be returned.
69  *
70  * The caller does not specify the size of the DHCP option data; this
71  * is implied by the length field stored within the DHCP option
72  * itself.
73  */
74 unsigned long dhcp_num_option ( struct dhcp_option *option ) {
75         unsigned long value = 0;
76         uint8_t *data;
77
78         if ( option ) {
79                 /* This is actually smaller code than using htons()
80                  * etc., and will also cope well with malformed
81                  * options (such as zero-length options).
82                  */
83                 for ( data = option->data.bytes ;
84                       data < ( option->data.bytes + option->len ) ; data++ )
85                         value = ( ( value << 8 ) | *data );
86         }
87         return value;
88 }
89
90 /**
91  * Obtain value of an IPv4-address DHCP option
92  *
93  * @v option            DHCP option, or NULL
94  * @v inp               IPv4 address to fill in
95  *
96  * Parses the IPv4 address value from a DHCP option, if present.  It
97  * is permitted to call dhcp_ipv4_option() with @c option set to NULL;
98  * in this case the address will be set to 0.0.0.0.
99  */
100 void dhcp_ipv4_option ( struct dhcp_option *option, struct in_addr *inp ) {
101         if ( option )
102                 *inp = option->data.in;
103 }
104
105 /**
106  * Print DHCP string option value into buffer
107  *
108  * @v buf               Buffer into which to write the string
109  * @v size              Size of buffer
110  * @v option            DHCP option, or NULL
111  * @ret len             Length of formatted string
112  *
113  * DHCP option strings are stored without a NUL terminator.  This
114  * function provides a convenient way to extract these DHCP strings
115  * into standard C strings.  It is permitted to call dhcp_snprintf()
116  * with @c option set to NULL; in this case the buffer will be filled
117  * with an empty string.
118  *
119  * The usual snprintf() semantics apply with regard to buffer size,
120  * return value when the buffer is too small, etc.
121  */
122 int dhcp_snprintf ( char *buf, size_t size, struct dhcp_option *option ) {
123         size_t len;
124         char *content = "";
125
126         if ( option ) {
127                 /* Shrink buffer size so that it is only just large
128                  * enough to contain the option data.  snprintf() will
129                  * take care of everything else (inserting the NUL etc.)
130                  */
131                 len = ( option->len + 1 );
132                 if ( len < size )
133                         size = len;
134                 content = option->data.string;
135         }
136         return snprintf ( buf, size, "%s", content );
137 }
138
139 /**
140  * Calculate length of a normal DHCP option
141  *
142  * @v option            DHCP option
143  * @ret len             Length (including tag and length field)
144  *
145  * @c option may not be a @c DHCP_PAD or @c DHCP_END option.
146  */
147 static inline unsigned int dhcp_option_len ( struct dhcp_option *option ) {
148         assert ( option->tag != DHCP_PAD );
149         assert ( option->tag != DHCP_END );
150         return ( option->len + DHCP_OPTION_HEADER_LEN );
151 }
152
153 /**
154  * Calculate length of any DHCP option
155  *
156  * @v option            DHCP option
157  * @ret len             Length (including tag and length field)
158  */
159 static inline unsigned int dhcp_any_option_len ( struct dhcp_option *option ) {
160         if ( ( option->tag == DHCP_END ) || ( option->tag == DHCP_PAD ) ) {
161                 return 1;
162         } else {
163                 return dhcp_option_len ( option );
164         }
165 }
166
167 /**
168  * Find DHCP option within DHCP options block, and its encapsulator (if any)
169  *
170  * @v options           DHCP options block
171  * @v tag               DHCP option tag to search for
172  * @ret encapsulator    Encapsulating DHCP option
173  * @ret option          DHCP option, or NULL if not found
174  *
175  * Searches for the DHCP option matching the specified tag within the
176  * DHCP option block.  Encapsulated options may be searched for by
177  * using DHCP_ENCAP_OPT() to construct the tag value.
178  *
179  * If the option is encapsulated, and @c encapsulator is non-NULL, it
180  * will be filled in with a pointer to the encapsulating option.
181  *
182  * This routine is designed to be paranoid.  It does not assume that
183  * the option data is well-formatted, and so must guard against flaws
184  * such as options missing a @c DHCP_END terminator, or options whose
185  * length would take them beyond the end of the data block.
186  */
187 static struct dhcp_option *
188 find_dhcp_option_with_encap ( struct dhcp_option_block *options,
189                               unsigned int tag,
190                               struct dhcp_option **encapsulator ) {
191         unsigned int original_tag __attribute__ (( unused )) = tag;
192         struct dhcp_option *option = options->data;
193         ssize_t remaining = options->len;
194         unsigned int option_len;
195
196         while ( remaining ) {
197                 /* Calculate length of this option.  Abort processing
198                  * if the length is malformed (i.e. takes us beyond
199                  * the end of the data block).
200                  */
201                 option_len = dhcp_any_option_len ( option );
202                 remaining -= option_len;
203                 if ( remaining < 0 )
204                         break;
205                 /* Check for matching tag */
206                 if ( option->tag == tag ) {
207                         DBG ( "Found DHCP option %s (length %d) in block %p\n",
208                               dhcp_tag_name ( original_tag ), option->len,
209                               options );
210                         return option;
211                 }
212                 /* Check for explicit end marker */
213                 if ( option->tag == DHCP_END )
214                         break;
215                 /* Check for start of matching encapsulation block */
216                 if ( DHCP_IS_ENCAP_OPT ( tag ) &&
217                      ( option->tag == DHCP_ENCAPSULATOR ( tag ) ) ) {
218                         if ( encapsulator )
219                                 *encapsulator = option;
220                         /* Continue search within encapsulated option block */
221                         tag = DHCP_ENCAPSULATED ( tag );
222                         remaining = option->len;
223                         option = ( void * ) &option->data;
224                         continue;
225                 }
226                 option = ( ( ( void * ) option ) + option_len );
227         }
228         return NULL;
229 }
230
231 /**
232  * Find DHCP option within DHCP options block
233  *
234  * @v options           DHCP options block, or NULL
235  * @v tag               DHCP option tag to search for
236  * @ret option          DHCP option, or NULL if not found
237  *
238  * Searches for the DHCP option matching the specified tag within the
239  * DHCP option block.  Encapsulated options may be searched for by
240  * using DHCP_ENCAP_OPT() to construct the tag value.
241  *
242  * If @c options is NULL, all registered option blocks will be
243  * searched.  Where multiple option blocks contain the same DHCP
244  * option, the option from the highest-priority block will be
245  * returned.  (Priority of an options block is determined by the value
246  * of the @c DHCP_EB_PRIORITY option within the block, if present; the
247  * default priority is zero).
248  */
249 struct dhcp_option * find_dhcp_option ( struct dhcp_option_block *options,
250                                         unsigned int tag ) {
251         struct dhcp_option *option;
252
253         if ( options ) {
254                 return find_dhcp_option_with_encap ( options, tag, NULL );
255         } else {
256                 list_for_each_entry ( options, &dhcp_option_blocks, list ) {
257                         if ( ( option = find_dhcp_option ( options, tag ) ) )
258                                 return option;
259                 }
260                 return NULL;
261         }
262 }
263
264 /**
265  * Register DHCP option block
266  *
267  * @v options           DHCP option block
268  *
269  * Register a block of DHCP options.
270  */
271 void register_dhcp_options ( struct dhcp_option_block *options ) {
272         struct dhcp_option_block *existing;
273
274         /* Determine priority of new block */
275         options->priority = find_dhcp_num_option ( options, DHCP_EB_PRIORITY );
276         DBG ( "Registering DHCP options block %p with priority %d\n",
277               options, options->priority );
278
279         /* Insert after any existing blocks which have a higher priority */
280         list_for_each_entry ( existing, &dhcp_option_blocks, list ) {
281                 if ( options->priority > existing->priority )
282                         break;
283         }
284         dhcpopt_get ( options );
285         list_add_tail ( &options->list, &existing->list );
286
287         /* Apply all registered DHCP options */
288         apply_global_dhcp_options();
289 }
290
291 /**
292  * Unregister DHCP option block
293  *
294  * @v options           DHCP option block
295  */
296 void unregister_dhcp_options ( struct dhcp_option_block *options ) {
297         list_del ( &options->list );
298         dhcpopt_put ( options );
299 }
300
301 /**
302  * Initialise empty block of DHCP options
303  *
304  * @v options           Uninitialised DHCP option block
305  * @v data              Memory for DHCP option data
306  * @v max_len           Length of memory for DHCP option data
307  *
308  * Populates the DHCP option data with a single @c DHCP_END option and
309  * fills in the fields of the @c dhcp_option_block structure.
310  */
311 void init_dhcp_options ( struct dhcp_option_block *options,
312                          void *data, size_t max_len ) {
313         struct dhcp_option *option;
314
315         options->data = data;
316         options->max_len = max_len;
317         option = options->data;
318         option->tag = DHCP_END;
319         options->len = 1;
320
321         DBG ( "DHCP options block %p initialised (data %p max_len %#zx)\n",
322               options, options->data, options->max_len );
323 }
324
325 /**
326  * Allocate space for a block of DHCP options
327  *
328  * @v max_len           Maximum length of option block
329  * @ret options         DHCP option block, or NULL
330  *
331  * Creates a new DHCP option block and populates it with an empty
332  * options list.  This call does not register the options block.
333  */
334 struct dhcp_option_block * alloc_dhcp_options ( size_t max_len ) {
335         struct dhcp_option_block *options;
336
337         options = malloc ( sizeof ( *options ) + max_len );
338         if ( options ) {
339                 init_dhcp_options ( options, 
340                                     ( (void *) options + sizeof ( *options ) ),
341                                     max_len );
342         }
343         return options;
344 }
345
346 /**
347  * Resize a DHCP option
348  *
349  * @v options           DHCP option block
350  * @v option            DHCP option to resize
351  * @v encapsulator      Encapsulating option (or NULL)
352  * @v old_len           Old length (including header)
353  * @v new_len           New length (including header)
354  * @ret rc              Return status code
355  */
356 static int resize_dhcp_option ( struct dhcp_option_block *options,
357                                 struct dhcp_option *option,
358                                 struct dhcp_option *encapsulator,
359                                 size_t old_len, size_t new_len ) {
360         void *source = ( ( ( void * ) option ) + old_len );
361         void *dest = ( ( ( void * ) option ) + new_len );
362         void *end = ( options->data + options->max_len );
363         ssize_t delta = ( new_len - old_len );
364         size_t new_options_len;
365         size_t new_encapsulator_len;
366
367         /* Check for sufficient space, and update length fields */
368         if ( new_len > DHCP_MAX_LEN )
369                 return -ENOMEM;
370         new_options_len = ( options->len + delta );
371         if ( new_options_len > options->max_len )
372                 return -ENOMEM;
373         if ( encapsulator ) {
374                 new_encapsulator_len = ( encapsulator->len + delta );
375                 if ( new_encapsulator_len > DHCP_MAX_LEN )
376                         return -ENOMEM;
377                 encapsulator->len = new_encapsulator_len;
378         }
379         options->len = new_options_len;
380
381         /* Move remainder of option data */
382         memmove ( dest, source, ( end - dest ) );
383
384         return 0;
385 }
386
387 /**
388  * Set value of DHCP option
389  *
390  * @v options           DHCP option block
391  * @v tag               DHCP option tag
392  * @v data              New value for DHCP option
393  * @v len               Length of value, in bytes
394  * @ret option          DHCP option, or NULL
395  *
396  * Sets the value of a DHCP option within the options block.  The
397  * option may or may not already exist.  Encapsulators will be created
398  * (and deleted) as necessary.
399  *
400  * This call may fail due to insufficient space in the options block.
401  * If it does fail, and the option existed previously, the option will
402  * be left with its original value.
403  */
404 struct dhcp_option * set_dhcp_option ( struct dhcp_option_block *options,
405                                        unsigned int tag,
406                                        const void *data, size_t len ) {
407         static const uint8_t empty_encapsulator[] = { DHCP_END };
408         struct dhcp_option *option;
409         void *insertion_point;
410         struct dhcp_option *encapsulator = NULL;
411         unsigned int encap_tag = DHCP_ENCAPSULATOR ( tag );
412         size_t old_len = 0;
413         size_t new_len = ( len ? ( len + DHCP_OPTION_HEADER_LEN ) : 0 );
414
415         /* Return NULL if no options block specified */
416         if ( ! options )
417                 return NULL;
418
419         /* Find old instance of this option, if any */
420         option = find_dhcp_option_with_encap ( options, tag, &encapsulator );
421         if ( option ) {
422                 old_len = dhcp_option_len ( option );
423                 DBG ( "Resizing DHCP option %s from length %d to %zd in block "
424                       "%p\n", dhcp_tag_name (tag), option->len, len, options );
425         } else {
426                 old_len = 0;
427                 DBG ( "Creating DHCP option %s (length %zd) in block %p\n",
428                       dhcp_tag_name ( tag ), len, options );
429         }
430         
431         /* Ensure that encapsulator exists, if required */
432         insertion_point = options->data;
433         if ( DHCP_IS_ENCAP_OPT ( tag ) ) {
434                 if ( ! encapsulator )
435                         encapsulator = set_dhcp_option ( options, encap_tag,
436                                                          empty_encapsulator,
437                                                 sizeof ( empty_encapsulator) );
438                 if ( ! encapsulator )
439                         return NULL;
440                 insertion_point = &encapsulator->data;
441         }
442
443         /* Create new option if necessary */
444         if ( ! option )
445                 option = insertion_point;
446         
447         /* Resize option to fit new data */
448         if ( resize_dhcp_option ( options, option, encapsulator,
449                                   old_len, new_len ) != 0 )
450                 return NULL;
451
452         /* Copy new data into option, if applicable */
453         if ( len ) {
454                 option->tag = tag;
455                 option->len = len;
456                 memcpy ( &option->data, data, len );
457         }
458
459         /* Delete encapsulator if there's nothing else left in it */
460         if ( encapsulator && ( encapsulator->len <= 1 ) )
461                 set_dhcp_option ( options, encap_tag, NULL, 0 );
462
463         return option;
464 }
465
466 /**
467  * Find DHCP option within all registered DHCP options blocks
468  *
469  * @v tag               DHCP option tag to search for
470  * @ret option          DHCP option, or NULL if not found
471  *
472  * This function exists merely as a notational shorthand for
473  * find_dhcp_option() with @c options set to NULL.
474  */
475 struct dhcp_option * find_global_dhcp_option ( unsigned int tag ) {
476         return find_dhcp_option ( NULL, tag );
477 }
478
479 /**
480  * Find DHCP numerical option, and return its value
481  *
482  * @v options           DHCP options block
483  * @v tag               DHCP option tag to search for
484  * @ret value           Numerical value of the option, or 0 if not found
485  *
486  * This function exists merely as a notational shorthand for a call to
487  * find_dhcp_option() followed by a call to dhcp_num_option().  It is
488  * not possible to distinguish between the cases "option not found"
489  * and "option has a value of zero" using this function; if this
490  * matters to you then issue the two constituent calls directly and
491  * check that find_dhcp_option() returns a non-NULL value.
492  */
493 unsigned long find_dhcp_num_option ( struct dhcp_option_block *options,
494                                      unsigned int tag ) {
495         return dhcp_num_option ( find_dhcp_option ( options, tag ) );
496 }
497
498 /**
499  * Find DHCP numerical option, and return its value
500  *
501  * @v tag               DHCP option tag to search for
502  * @ret value           Numerical value of the option, or 0 if not found
503  *
504  * This function exists merely as a notational shorthand for a call to
505  * find_global_dhcp_option() followed by a call to dhcp_num_option().
506  * It is not possible to distinguish between the cases "option not
507  * found" and "option has a value of zero" using this function; if
508  * this matters to you then issue the two constituent calls directly
509  * and check that find_global_dhcp_option() returns a non-NULL value.
510  */
511 unsigned long find_global_dhcp_num_option ( unsigned int tag ) {
512         return dhcp_num_option ( find_global_dhcp_option ( tag ) );
513 }
514
515 /**
516  * Find DHCP IPv4-address option, and return its value
517  *
518  * @v options           DHCP options block
519  * @v tag               DHCP option tag to search for
520  * @v inp               IPv4 address to fill in
521  * @ret value           Numerical value of the option, or 0 if not found
522  *
523  * This function exists merely as a notational shorthand for a call to
524  * find_dhcp_option() followed by a call to dhcp_ipv4_option().  It is
525  * not possible to distinguish between the cases "option not found"
526  * and "option has a value of 0.0.0.0" using this function; if this
527  * matters to you then issue the two constituent calls directly and
528  * check that find_dhcp_option() returns a non-NULL value.
529  */
530 void find_dhcp_ipv4_option ( struct dhcp_option_block *options,
531                              unsigned int tag, struct in_addr *inp ) {
532         dhcp_ipv4_option ( find_dhcp_option ( options, tag ), inp );
533 }
534
535 /**
536  * Find DHCP IPv4-address option, and return its value
537  *
538  * @v options           DHCP options block
539  * @v tag               DHCP option tag to search for
540  * @v inp               IPv4 address to fill in
541  * @ret value           Numerical value of the option, or 0 if not found
542  *
543  * This function exists merely as a notational shorthand for a call to
544  * find_dhcp_option() followed by a call to dhcp_ipv4_option().  It is
545  * not possible to distinguish between the cases "option not found"
546  * and "option has a value of 0.0.0.0" using this function; if this
547  * matters to you then issue the two constituent calls directly and
548  * check that find_dhcp_option() returns a non-NULL value.
549  */
550 void find_global_dhcp_ipv4_option ( unsigned int tag, struct in_addr *inp ) {
551         dhcp_ipv4_option ( find_global_dhcp_option ( tag ), inp );
552 }
553
554 /**
555  * Delete DHCP option
556  *
557  * @v options           DHCP options block
558  * @v tag               DHCP option tag
559  *
560  * This function exists merely as a notational shorthand for a call to
561  * set_dhcp_option() with @c len set to zero.
562  */
563 void delete_dhcp_option ( struct dhcp_option_block *options,
564                           unsigned int tag ) {
565         set_dhcp_option ( options, tag, NULL, 0 );
566 }
567
568 /**
569  * Apply DHCP options
570  *
571  * @v options           DHCP options block, or NULL
572  * @ret rc              Return status code
573  */
574 int apply_dhcp_options ( struct dhcp_option_block *options ) {
575         struct in_addr tftp_server;
576         struct uri *uri;
577         char uri_string[32];
578
579         /* Set current working URI based on TFTP server */
580         find_dhcp_ipv4_option ( options, DHCP_EB_SIADDR, &tftp_server );
581         snprintf ( uri_string, sizeof ( uri_string ),
582                    "tftp://%s/", inet_ntoa ( tftp_server ) );
583         uri = parse_uri ( uri_string );
584         if ( ! uri )
585                 return -ENOMEM;
586         churi ( uri );
587         uri_put ( uri );
588
589         return 0;
590 }
591
592 /**
593  * Apply global DHCP options
594  *
595  * @ret rc              Return status code
596  */
597 int apply_global_dhcp_options ( void ) {
598         return apply_dhcp_options ( NULL );
599 }