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