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