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