Merge commit 'holger/strings'
[people/dverkamp/gpxe.git] / src / include / gpxe / dhcp.h
1 #ifndef _GPXE_DHCP_H
2 #define _GPXE_DHCP_H
3
4 /** @file
5  *
6  * Dynamic Host Configuration Protocol
7  *
8  */
9
10 #include <stdint.h>
11 #include <gpxe/list.h>
12 #include <gpxe/in.h>
13 #include <gpxe/refcnt.h>
14 #include <gpxe/tables.h>
15
16 struct net_device;
17 struct job_interface;
18
19 /** BOOTP/DHCP server port */
20 #define BOOTPS_PORT 67
21
22 /** BOOTP/DHCP client port */
23 #define BOOTPC_PORT 68
24
25 /** Construct a tag value for an encapsulated option
26  *
27  * This tag value can be passed to Etherboot functions when searching
28  * for DHCP options in order to search for a tag within an
29  * encapsulated options block.
30  */
31 #define DHCP_ENCAP_OPT( encapsulator, encapsulated ) \
32         ( ( (encapsulator) << 8 ) | (encapsulated) )
33 /** Extract encapsulating option block tag from encapsulated tag value */
34 #define DHCP_ENCAPSULATOR( encap_opt ) ( (encap_opt) >> 8 )
35 /** Extract encapsulated option tag from encapsulated tag value */
36 #define DHCP_ENCAPSULATED( encap_opt ) ( (encap_opt) & 0xff )
37 /** Option is encapsulated */
38 #define DHCP_IS_ENCAP_OPT( opt ) DHCP_ENCAPSULATOR( opt )
39
40 /**
41  * @defgroup dhcpopts DHCP option tags
42  * @{
43  */
44
45 /** Padding
46  *
47  * This tag does not have a length field; it is always only a single
48  * byte in length.
49  */
50 #define DHCP_PAD 0
51
52 /** Minimum normal DHCP option */
53 #define DHCP_MIN_OPTION 1
54
55 /** Subnet mask */
56 #define DHCP_SUBNET_MASK 1
57
58 /** Routers */
59 #define DHCP_ROUTERS 3
60
61 /** DNS servers */
62 #define DHCP_DNS_SERVERS 6
63
64 /** Syslog servers */
65 #define DHCP_LOG_SERVERS 7
66
67 /** Host name */
68 #define DHCP_HOST_NAME 12
69
70 /** Domain name */
71 #define DHCP_DOMAIN_NAME 15
72
73 /** Root path */
74 #define DHCP_ROOT_PATH 17
75
76 /** Vendor encapsulated options */
77 #define DHCP_VENDOR_ENCAP 43
78
79 /** Requested IP address */
80 #define DHCP_REQUESTED_ADDRESS 50
81
82 /** Lease time */
83 #define DHCP_LEASE_TIME 51
84
85 /** Option overloading
86  *
87  * The value of this option is the bitwise-OR of zero or more
88  * DHCP_OPTION_OVERLOAD_XXX constants.
89  */
90 #define DHCP_OPTION_OVERLOAD 52
91
92 /** The "file" field is overloaded to contain extra DHCP options */
93 #define DHCP_OPTION_OVERLOAD_FILE 1
94
95 /** The "sname" field is overloaded to contain extra DHCP options */
96 #define DHCP_OPTION_OVERLOAD_SNAME 2
97
98 /** DHCP message type */
99 #define DHCP_MESSAGE_TYPE 53
100 #define DHCPDISCOVER 1
101 #define DHCPOFFER 2
102 #define DHCPREQUEST 3
103 #define DHCPDECLINE 4
104 #define DHCPACK 5
105 #define DHCPNAK 6
106 #define DHCPRELEASE 7
107 #define DHCPINFORM 8
108
109 /** DHCP server identifier */
110 #define DHCP_SERVER_IDENTIFIER 54
111
112 /** Parameter request list */
113 #define DHCP_PARAMETER_REQUEST_LIST 55
114
115 /** Maximum DHCP message size */
116 #define DHCP_MAX_MESSAGE_SIZE 57
117
118 /** Vendor class identifier */
119 #define DHCP_VENDOR_CLASS_ID 60
120
121 /** Client identifier */
122 #define DHCP_CLIENT_ID 61
123
124 /** TFTP server name
125  *
126  * This option replaces the fixed "sname" field, when that field is
127  * used to contain overloaded options.
128  */
129 #define DHCP_TFTP_SERVER_NAME 66
130
131 /** Bootfile name
132  *
133  * This option replaces the fixed "file" field, when that field is
134  * used to contain overloaded options.
135  */
136 #define DHCP_BOOTFILE_NAME 67
137
138 /** Etherboot-specific encapsulated options
139  *
140  * This encapsulated options field is used to contain all options
141  * specific to Etherboot (i.e. not assigned by IANA or other standards
142  * bodies).
143  */
144 #define DHCP_EB_ENCAP 175
145
146 /** Priority of this options block
147  *
148  * This is a signed 8-bit integer field indicating the priority of
149  * this block of options.  It can be used to specify the relative
150  * priority of multiple option blocks (e.g. options from non-volatile
151  * storage versus options from a DHCP server).
152  */
153 #define DHCP_EB_PRIORITY DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 1 )
154
155 /** "Your" IP address
156  *
157  * This option is used internally to contain the value of the "yiaddr"
158  * field, in order to provide a consistent approach to storing and
159  * processing options.  It should never be present in a DHCP packet.
160  */
161 #define DHCP_EB_YIADDR DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 2 )
162
163 /** "Server" IP address
164  *
165  * This option is used internally to contain the value of the "siaddr"
166  * field, in order to provide a consistent approach to storing and
167  * processing options.  It should never be present in a DHCP packet.
168  */
169 #define DHCP_EB_SIADDR DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 3 )
170
171 /*
172  * Tags in the range 0x10-0x7f are reserved for feature markers
173  *
174  */
175
176 /** Network device descriptor
177  *
178  * Byte 0 is the bus type ID; remaining bytes depend on the bus type.
179  *
180  * PCI devices:
181  * Byte 0 : 1 (PCI)
182  * Byte 1 : PCI vendor ID MSB
183  * Byte 2 : PCI vendor ID LSB
184  * Byte 3 : PCI device ID MSB
185  * Byte 4 : PCI device ID LSB
186  */
187 #define DHCP_EB_BUS_ID DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 0xb1 )
188
189 /** BIOS drive number
190  *
191  * This is the drive number for a drive emulated via INT 13.  0x80 is
192  * the first hard disk, 0x81 is the second hard disk, etc.
193  */
194 #define DHCP_EB_BIOS_DRIVE DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 0xbd )
195
196 /** Username
197  *
198  * This will be used as the username for any required authentication.
199  * It is expected that this option's value will be held in
200  * non-volatile storage, rather than transmitted as part of a DHCP
201  * packet.
202  */
203 #define DHCP_EB_USERNAME DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 0xbe )
204
205 /** Password
206  *
207  * This will be used as the password for any required authentication.
208  * It is expected that this option's value will be held in
209  * non-volatile storage, rather than transmitted as part of a DHCP
210  * packet.
211  */
212 #define DHCP_EB_PASSWORD DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 0xbf )
213
214 /** iSCSI primary target IQN */
215 #define DHCP_ISCSI_PRIMARY_TARGET_IQN 201
216
217 /** iSCSI secondary target IQN */
218 #define DHCP_ISCSI_SECONDARY_TARGET_IQN 202
219
220 /** iSCSI initiator IQN */
221 #define DHCP_ISCSI_INITIATOR_IQN 203
222
223 /** Maximum normal DHCP option */
224 #define DHCP_MAX_OPTION 254
225
226 /** End of options
227  *
228  * This tag does not have a length field; it is always only a single
229  * byte in length.
230  */
231 #define DHCP_END 255
232
233 /** @} */
234
235 /**
236  * Count number of arguments to a variadic macro
237  *
238  * This rather neat, non-iterative solution is courtesy of Laurent
239  * Deniau.
240  *
241  */
242 #define _VA_ARG_COUNT(  _1,  _2,  _3,  _4,  _5,  _6,  _7,  _8,          \
243                         _9, _10, _11, _12, _13, _14, _15, _16,          \
244                        _17, _18, _19, _20, _21, _22, _23, _24,          \
245                        _25, _26, _27, _28, _29, _30, _31, _32,          \
246                        _33, _34, _35, _36, _37, _38, _39, _40,          \
247                        _41, _42, _43, _44, _45, _46, _47, _48,          \
248                        _49, _50, _51, _52, _53, _54, _55, _56,          \
249                        _57, _58, _59, _60, _61, _62, _63,   N, ... ) N
250 #define VA_ARG_COUNT( ... )                                             \
251         _VA_ARG_COUNT ( __VA_ARGS__,                                    \
252                         63, 62, 61, 60, 59, 58, 57, 56,                 \
253                         55, 54, 53, 52, 51, 50, 49, 48,                 \
254                         47, 46, 45, 44, 43, 42, 41, 40,                 \
255                         39, 38, 37, 36, 35, 34, 33, 32,                 \
256                         31, 30, 29, 28, 27, 26, 25, 24,                 \
257                         23, 22, 21, 20, 19, 18, 17, 16,                 \
258                         15, 14, 13, 12, 11, 10,  9,  8,                 \
259                          7,  6,  5,  4,  3,  2,  1,  0 )
260
261 /** Construct a DHCP option from a list of bytes */
262 #define DHCP_OPTION( ... ) VA_ARG_COUNT ( __VA_ARGS__ ), __VA_ARGS__
263
264 /** Construct a DHCP option from a list of characters */
265 #define DHCP_STRING( ... ) DHCP_OPTION ( __VA_ARGS__ )
266
267 /** Construct a byte-valued DHCP option */
268 #define DHCP_BYTE( value ) DHCP_OPTION ( value )
269
270 /** Construct a word-valued DHCP option */
271 #define DHCP_WORD( value ) DHCP_OPTION ( ( ( (value) >> 8 ) & 0xff ),   \
272                                          ( ( (value) >> 0  ) & 0xff ) )
273
274 /** Construct a dword-valued DHCP option */
275 #define DHCP_DWORD( value ) DHCP_OPTION ( ( ( (value) >> 24 ) & 0xff ), \
276                                           ( ( (value) >> 16 ) & 0xff ), \
277                                           ( ( (value) >> 8  ) & 0xff ), \
278                                           ( ( (value) >> 0  ) & 0xff ) )
279
280 /** Construct a DHCP encapsulated options field */
281 #define DHCP_ENCAP( ... ) DHCP_OPTION ( __VA_ARGS__, DHCP_END )
282
283 /**
284  * A DHCP option
285  *
286  * DHCP options consist of a mandatory tag, a length field that is
287  * mandatory for all options except @c DHCP_PAD and @c DHCP_END, and a
288  * payload.  
289  */
290 struct dhcp_option {
291         /** Tag
292          *
293          * Must be a @c DHCP_XXX value.
294          */
295         uint8_t tag;
296         /** Length
297          *
298          * This is the length of the data field (i.e. excluding the
299          * tag and length fields).  For the two tags @c DHCP_PAD and
300          * @c DHCP_END, the length field is implicitly zero and is
301          * also missing, i.e. these DHCP options are only a single
302          * byte in length.
303          */
304         uint8_t len;
305         /** Option data
306          *
307          * Interpretation of the content is entirely dependent upon
308          * the tag.  For fields containing a multi-byte integer, the
309          * field is defined to be in network-endian order (unless you
310          * are Intel and feel like violating the spec for fun).
311          */
312         union {
313                 uint8_t byte;
314                 uint16_t word;
315                 uint32_t dword;
316                 struct in_addr in;
317                 uint8_t bytes[0];
318                 char string[0];
319         } data;
320 } __attribute__ (( packed ));
321
322 /**
323  * Length of a DHCP option header
324  *
325  * The header is the portion excluding the data, i.e. the tag and the
326  * length.
327  */
328 #define DHCP_OPTION_HEADER_LEN ( offsetof ( struct dhcp_option, data ) )
329
330 /** Maximum length for a single DHCP option */
331 #define DHCP_MAX_LEN 0xff
332
333 /** A DHCP options block */
334 struct dhcp_option_block {
335         /** Reference counter */
336         struct refcnt refcnt;
337         /** List of option blocks */
338         struct list_head list;
339         /** Option block raw data */
340         void *data;
341         /** Option block length */
342         size_t len;
343         /** Option block maximum length */
344         size_t max_len;
345         /** Block priority
346          *
347          * This is determined at the time of the call to
348          * register_options() by searching for the @c DHCP_EB_PRIORITY
349          * option.
350          */
351         signed int priority;
352 };
353
354 /**
355  * A DHCP header
356  *
357  */
358 struct dhcphdr {
359         /** Operation
360          *
361          * This must be either @c BOOTP_REQUEST or @c BOOTP_REPLY.
362          */
363         uint8_t op;
364         /** Hardware address type
365          *
366          * This is an ARPHRD_XXX constant.  Note that ARPHRD_XXX
367          * constants are nominally 16 bits wide; this could be
368          * considered to be a bug in the BOOTP/DHCP specification.
369          */
370         uint8_t htype;
371         /** Hardware address length */
372         uint8_t hlen;
373         /** Number of hops from server */
374         uint8_t hops;
375         /** Transaction ID */
376         uint32_t xid;
377         /** Seconds since start of acquisition */
378         uint16_t secs;
379         /** Flags */
380         uint16_t flags;
381         /** "Client" IP address
382          *
383          * This is filled in if the client already has an IP address
384          * assigned and can respond to ARP requests.
385          */
386         struct in_addr ciaddr;
387         /** "Your" IP address
388          *
389          * This is the IP address assigned by the server to the client.
390          */
391         struct in_addr yiaddr;
392         /** "Server" IP address
393          *
394          * This is the IP address of the next server to be used in the
395          * boot process.
396          */
397         struct in_addr siaddr;
398         /** "Gateway" IP address
399          *
400          * This is the IP address of the DHCP relay agent, if any.
401          */
402         struct in_addr giaddr;
403         /** Client hardware address */
404         uint8_t chaddr[16];
405         /** Server host name (null terminated)
406          *
407          * This field may be overridden and contain DHCP options
408          */
409         char sname[64];
410         /** Boot file name (null terminated)
411          *
412          * This field may be overridden and contain DHCP options
413          */
414         char file[128];
415         /** DHCP magic cookie
416          *
417          * Must have the value @c DHCP_MAGIC_COOKIE.
418          */
419         uint32_t magic;
420         /** DHCP options
421          *
422          * Variable length; extends to the end of the packet.  Minimum
423          * length (for the sake of sanity) is 1, to allow for a single
424          * @c DHCP_END tag.
425          */
426         uint8_t options[1];
427 };
428
429 /** Opcode for a request from client to server */
430 #define BOOTP_REQUEST 1
431
432 /** Opcode for a reply from server to client */
433 #define BOOTP_REPLY 2
434
435 /** DHCP magic cookie */
436 #define DHCP_MAGIC_COOKIE 0x63825363UL
437
438 /** DHCP minimum packet length
439  *
440  * This is the mandated minimum packet length that a DHCP participant
441  * must be prepared to receive.
442  */
443 #define DHCP_MIN_LEN 552
444
445 /**
446  * A DHCP packet
447  *
448  */
449 struct dhcp_packet {
450         /** The DHCP packet contents */
451         struct dhcphdr *dhcphdr;
452         /** Maximum length of the DHCP packet buffer */
453         size_t max_len;
454         /** Used length of the DHCP packet buffer */
455         size_t len;
456         /** DHCP options */
457         struct dhcp_option_block options;
458 };
459
460 /** A DHCP option applicator */
461 struct dhcp_option_applicator {
462         /** DHCP option tag */
463         unsigned int tag;
464         /** Applicator
465          *
466          * @v tag       DHCP option tag
467          * @v option    DHCP option
468          * @ret rc      Return status code
469          */
470         int ( * apply ) ( unsigned int tag, struct dhcp_option *option );
471 };
472
473 /** Declare a DHCP option applicator */
474 #define __dhcp_applicator \
475         __table ( struct dhcp_option_applicator, dhcp_applicators, 01 )
476
477 /**
478  * Get reference to DHCP options block
479  *
480  * @v options           DHCP options block
481  * @ret options         DHCP options block
482  */
483 static inline __attribute__ (( always_inline )) struct dhcp_option_block *
484 dhcpopt_get ( struct dhcp_option_block *options ) {
485         ref_get ( &options->refcnt );
486         return options;
487 }
488
489 /**
490  * Drop reference to DHCP options block
491  *
492  * @v options           DHCP options block
493  */
494 static inline __attribute__ (( always_inline )) void
495 dhcpopt_put ( struct dhcp_option_block *options ) {
496         ref_put ( &options->refcnt );
497 }
498
499 extern unsigned long dhcp_num_option ( struct dhcp_option *option );
500 extern void dhcp_ipv4_option ( struct dhcp_option *option,
501                                struct in_addr *inp );
502 extern int dhcp_snprintf ( char *buf, size_t size,
503                            struct dhcp_option *option );
504 extern struct dhcp_option *
505 find_dhcp_option ( struct dhcp_option_block *options, unsigned int tag );
506 extern void register_dhcp_options ( struct dhcp_option_block *options );
507 extern void unregister_dhcp_options ( struct dhcp_option_block *options );
508 extern void init_dhcp_options ( struct dhcp_option_block *options,
509                                 void *data, size_t max_len );
510 extern struct dhcp_option_block * __malloc alloc_dhcp_options ( size_t max_len );
511 extern struct dhcp_option *
512 set_dhcp_option ( struct dhcp_option_block *options, unsigned int tag,
513                   const void *data, size_t len );
514 extern struct dhcp_option * find_global_dhcp_option ( unsigned int tag );
515 extern unsigned long find_dhcp_num_option ( struct dhcp_option_block *options,
516                                             unsigned int tag );
517 extern unsigned long find_global_dhcp_num_option ( unsigned int tag );
518 extern void find_dhcp_ipv4_option ( struct dhcp_option_block *options,
519                                     unsigned int tag, struct in_addr *inp );
520 extern void find_global_dhcp_ipv4_option ( unsigned int tag,
521                                            struct in_addr *inp );
522 extern void delete_dhcp_option ( struct dhcp_option_block *options,
523                                  unsigned int tag );
524
525 extern int apply_dhcp_options ( struct dhcp_option_block *options );
526 extern int apply_global_dhcp_options ( void );
527
528 extern int create_dhcp_request ( struct net_device *netdev, int msgtype,
529                                  struct dhcp_option_block *options,
530                                  void *data, size_t max_len,
531                                  struct dhcp_packet *dhcppkt );
532 extern int create_dhcp_response ( struct net_device *netdev, int msgtype,
533                                   struct dhcp_option_block *options,
534                                   void *data, size_t max_len,
535                                   struct dhcp_packet *dhcppkt );
536
537 extern int start_dhcp ( struct job_interface *job, struct net_device *netdev,
538                         int (*register_options) ( struct net_device *,
539                                                   struct dhcp_option_block * ));
540 extern int dhcp_configure_netdev ( struct net_device *netdev,
541                                    struct dhcp_option_block *options );
542
543 #endif /* _GPXE_DHCP_H */