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