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