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