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