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