Add identifier for the network device into the DHCP request.
[people/sha0/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 /** Network device descriptor
172  *
173  * Byte 0 is the bus type ID; remaining bytes depend on the bus type.
174  *
175  * PCI devices:
176  * Byte 0 : 1 (PCI)
177  * Byte 1 : PCI vendor ID MSB
178  * Byte 2 : PCI vendor ID LSB
179  * Byte 3 : PCI device ID MSB
180  * Byte 4 : PCI device ID LSB
181  */
182 #define DHCP_EB_BUS_ID DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 0xb1 )
183
184 /** BIOS drive number
185  *
186  * This is the drive number for a drive emulated via INT 13.  0x80 is
187  * the first hard disk, 0x81 is the second hard disk, etc.
188  */
189 #define DHCP_EB_BIOS_DRIVE DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 0xbd )
190
191 /** Username
192  *
193  * This will be used as the username for any required authentication.
194  * It is expected that this option's value will be held in
195  * non-volatile storage, rather than transmitted as part of a DHCP
196  * packet.
197  */
198 #define DHCP_EB_USERNAME DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 0xbe )
199
200 /** Password
201  *
202  * This will be used as the password for any required authentication.
203  * It is expected that this option's value will be held in
204  * non-volatile storage, rather than transmitted as part of a DHCP
205  * packet.
206  */
207 #define DHCP_EB_PASSWORD DHCP_ENCAP_OPT ( DHCP_EB_ENCAP, 0xbf )
208
209 /** iSCSI primary target IQN */
210 #define DHCP_ISCSI_PRIMARY_TARGET_IQN 201
211
212 /** iSCSI secondary target IQN */
213 #define DHCP_ISCSI_SECONDARY_TARGET_IQN 202
214
215 /** iSCSI initiator IQN */
216 #define DHCP_ISCSI_INITIATOR_IQN 203
217
218 /** Maximum normal DHCP option */
219 #define DHCP_MAX_OPTION 254
220
221 /** End of options
222  *
223  * This tag does not have a length field; it is always only a single
224  * byte in length.
225  */
226 #define DHCP_END 255
227
228 /** @} */
229
230 /**
231  * Count number of arguments to a variadic macro
232  *
233  * This rather neat, non-iterative solution is courtesy of Laurent
234  * Deniau.
235  *
236  */
237 #define _VA_ARG_COUNT(  _1,  _2,  _3,  _4,  _5,  _6,  _7,  _8,          \
238                         _9, _10, _11, _12, _13, _14, _15, _16,          \
239                        _17, _18, _19, _20, _21, _22, _23, _24,          \
240                        _25, _26, _27, _28, _29, _30, _31, _32,          \
241                        _33, _34, _35, _36, _37, _38, _39, _40,          \
242                        _41, _42, _43, _44, _45, _46, _47, _48,          \
243                        _49, _50, _51, _52, _53, _54, _55, _56,          \
244                        _57, _58, _59, _60, _61, _62, _63,   N, ... ) N
245 #define VA_ARG_COUNT( ... )                                             \
246         _VA_ARG_COUNT ( __VA_ARGS__,                                    \
247                         63, 62, 61, 60, 59, 58, 57, 56,                 \
248                         55, 54, 53, 52, 51, 50, 49, 48,                 \
249                         47, 46, 45, 44, 43, 42, 41, 40,                 \
250                         39, 38, 37, 36, 35, 34, 33, 32,                 \
251                         31, 30, 29, 28, 27, 26, 25, 24,                 \
252                         23, 22, 21, 20, 19, 18, 17, 16,                 \
253                         15, 14, 13, 12, 11, 10,  9,  8,                 \
254                          7,  6,  5,  4,  3,  2,  1,  0 )
255
256 /** Construct a DHCP option from a list of bytes */
257 #define DHCP_OPTION( ... ) VA_ARG_COUNT ( __VA_ARGS__ ), __VA_ARGS__
258
259 /** Construct a DHCP option from a list of characters */
260 #define DHCP_STRING( ... ) DHCP_OPTION ( __VA_ARGS__ )
261
262 /** Construct a byte-valued DHCP option */
263 #define DHCP_BYTE( value ) DHCP_OPTION ( value )
264
265 /** Construct a word-valued DHCP option */
266 #define DHCP_WORD( value ) DHCP_OPTION ( ( ( (value) >> 8 ) & 0xff ),   \
267                                          ( ( (value) >> 0  ) & 0xff ) )
268
269 /** Construct a dword-valued DHCP option */
270 #define DHCP_DWORD( value ) DHCP_OPTION ( ( ( (value) >> 24 ) & 0xff ), \
271                                           ( ( (value) >> 16 ) & 0xff ), \
272                                           ( ( (value) >> 8  ) & 0xff ), \
273                                           ( ( (value) >> 0  ) & 0xff ) )
274
275 /** Construct a DHCP encapsulated options field */
276 #define DHCP_ENCAP( ... ) DHCP_OPTION ( __VA_ARGS__, DHCP_END )
277
278 /**
279  * A DHCP option
280  *
281  * DHCP options consist of a mandatory tag, a length field that is
282  * mandatory for all options except @c DHCP_PAD and @c DHCP_END, and a
283  * payload.  
284  */
285 struct dhcp_option {
286         /** Tag
287          *
288          * Must be a @c DHCP_XXX value.
289          */
290         uint8_t tag;
291         /** Length
292          *
293          * This is the length of the data field (i.e. excluding the
294          * tag and length fields).  For the two tags @c DHCP_PAD and
295          * @c DHCP_END, the length field is implicitly zero and is
296          * also missing, i.e. these DHCP options are only a single
297          * byte in length.
298          */
299         uint8_t len;
300         /** Option data
301          *
302          * Interpretation of the content is entirely dependent upon
303          * the tag.  For fields containing a multi-byte integer, the
304          * field is defined to be in network-endian order (unless you
305          * are Intel and feel like violating the spec for fun).
306          */
307         union {
308                 uint8_t byte;
309                 uint16_t word;
310                 uint32_t dword;
311                 struct in_addr in;
312                 uint8_t bytes[0];
313                 char string[0];
314         } data;
315 } __attribute__ (( packed ));
316
317 /**
318  * Length of a DHCP option header
319  *
320  * The header is the portion excluding the data, i.e. the tag and the
321  * length.
322  */
323 #define DHCP_OPTION_HEADER_LEN ( offsetof ( struct dhcp_option, data ) )
324
325 /** Maximum length for a single DHCP option */
326 #define DHCP_MAX_LEN 0xff
327
328 /** A DHCP options block */
329 struct dhcp_option_block {
330         /** Reference counter */
331         struct refcnt refcnt;
332         /** List of option blocks */
333         struct list_head list;
334         /** Option block raw data */
335         void *data;
336         /** Option block length */
337         size_t len;
338         /** Option block maximum length */
339         size_t max_len;
340         /** Block priority
341          *
342          * This is determined at the time of the call to
343          * register_options() by searching for the @c DHCP_EB_PRIORITY
344          * option.
345          */
346         signed int priority;
347 };
348
349 /**
350  * A DHCP header
351  *
352  */
353 struct dhcphdr {
354         /** Operation
355          *
356          * This must be either @c BOOTP_REQUEST or @c BOOTP_REPLY.
357          */
358         uint8_t op;
359         /** Hardware address type
360          *
361          * This is an ARPHRD_XXX constant.  Note that ARPHRD_XXX
362          * constants are nominally 16 bits wide; this could be
363          * considered to be a bug in the BOOTP/DHCP specification.
364          */
365         uint8_t htype;
366         /** Hardware address length */
367         uint8_t hlen;
368         /** Number of hops from server */
369         uint8_t hops;
370         /** Transaction ID */
371         uint32_t xid;
372         /** Seconds since start of acquisition */
373         uint16_t secs;
374         /** Flags */
375         uint16_t flags;
376         /** "Client" IP address
377          *
378          * This is filled in if the client already has an IP address
379          * assigned and can respond to ARP requests.
380          */
381         struct in_addr ciaddr;
382         /** "Your" IP address
383          *
384          * This is the IP address assigned by the server to the client.
385          */
386         struct in_addr yiaddr;
387         /** "Server" IP address
388          *
389          * This is the IP address of the next server to be used in the
390          * boot process.
391          */
392         struct in_addr siaddr;
393         /** "Gateway" IP address
394          *
395          * This is the IP address of the DHCP relay agent, if any.
396          */
397         struct in_addr giaddr;
398         /** Client hardware address */
399         uint8_t chaddr[16];
400         /** Server host name (null terminated)
401          *
402          * This field may be overridden and contain DHCP options
403          */
404         char sname[64];
405         /** Boot file name (null terminated)
406          *
407          * This field may be overridden and contain DHCP options
408          */
409         char file[128];
410         /** DHCP magic cookie
411          *
412          * Must have the value @c DHCP_MAGIC_COOKIE.
413          */
414         uint32_t magic;
415         /** DHCP options
416          *
417          * Variable length; extends to the end of the packet.  Minimum
418          * length (for the sake of sanity) is 1, to allow for a single
419          * @c DHCP_END tag.
420          */
421         uint8_t options[1];
422 };
423
424 /** Opcode for a request from client to server */
425 #define BOOTP_REQUEST 1
426
427 /** Opcode for a reply from server to client */
428 #define BOOTP_REPLY 2
429
430 /** DHCP magic cookie */
431 #define DHCP_MAGIC_COOKIE 0x63825363UL
432
433 /** DHCP minimum packet length
434  *
435  * This is the mandated minimum packet length that a DHCP participant
436  * must be prepared to receive.
437  */
438 #define DHCP_MIN_LEN 552
439
440 /**
441  * A DHCP packet
442  *
443  */
444 struct dhcp_packet {
445         /** The DHCP packet contents */
446         struct dhcphdr *dhcphdr;
447         /** Maximum length of the DHCP packet buffer */
448         size_t max_len;
449         /** Used length of the DHCP packet buffer */
450         size_t len;
451         /** DHCP options */
452         struct dhcp_option_block options;
453 };
454
455 /** A DHCP option applicator */
456 struct dhcp_option_applicator {
457         /** DHCP option tag */
458         unsigned int tag;
459         /** Applicator
460          *
461          * @v tag       DHCP option tag
462          * @v option    DHCP option
463          * @ret rc      Return status code
464          */
465         int ( * apply ) ( unsigned int tag, struct dhcp_option *option );
466 };
467
468 /** Declare a DHCP option applicator */
469 #define __dhcp_applicator \
470         __table ( struct dhcp_option_applicator, dhcp_applicators, 01 )
471
472 /**
473  * Get reference to DHCP options block
474  *
475  * @v options           DHCP options block
476  * @ret options         DHCP options block
477  */
478 static inline __attribute__ (( always_inline )) struct dhcp_option_block *
479 dhcpopt_get ( struct dhcp_option_block *options ) {
480         ref_get ( &options->refcnt );
481         return options;
482 }
483
484 /**
485  * Drop reference to DHCP options block
486  *
487  * @v options           DHCP options block
488  */
489 static inline __attribute__ (( always_inline )) void
490 dhcpopt_put ( struct dhcp_option_block *options ) {
491         ref_put ( &options->refcnt );
492 }
493
494 extern unsigned long dhcp_num_option ( struct dhcp_option *option );
495 extern void dhcp_ipv4_option ( struct dhcp_option *option,
496                                struct in_addr *inp );
497 extern int dhcp_snprintf ( char *buf, size_t size,
498                            struct dhcp_option *option );
499 extern struct dhcp_option *
500 find_dhcp_option ( struct dhcp_option_block *options, unsigned int tag );
501 extern void register_dhcp_options ( struct dhcp_option_block *options );
502 extern void unregister_dhcp_options ( struct dhcp_option_block *options );
503 extern void init_dhcp_options ( struct dhcp_option_block *options,
504                                 void *data, size_t max_len );
505 extern struct dhcp_option_block * alloc_dhcp_options ( size_t max_len );
506 extern struct dhcp_option *
507 set_dhcp_option ( struct dhcp_option_block *options, unsigned int tag,
508                   const void *data, size_t len );
509 extern struct dhcp_option * find_global_dhcp_option ( unsigned int tag );
510 extern unsigned long find_dhcp_num_option ( struct dhcp_option_block *options,
511                                             unsigned int tag );
512 extern unsigned long find_global_dhcp_num_option ( unsigned int tag );
513 extern void find_dhcp_ipv4_option ( struct dhcp_option_block *options,
514                                     unsigned int tag, struct in_addr *inp );
515 extern void find_global_dhcp_ipv4_option ( unsigned int tag,
516                                            struct in_addr *inp );
517 extern void delete_dhcp_option ( struct dhcp_option_block *options,
518                                  unsigned int tag );
519
520 extern int apply_dhcp_options ( struct dhcp_option_block *options );
521 extern int apply_global_dhcp_options ( void );
522
523 extern int create_dhcp_request ( struct net_device *netdev, int msgtype,
524                                  struct dhcp_option_block *options,
525                                  void *data, size_t max_len,
526                                  struct dhcp_packet *dhcppkt );
527 extern int create_dhcp_response ( struct net_device *netdev, int msgtype,
528                                   struct dhcp_option_block *options,
529                                   void *data, size_t max_len,
530                                   struct dhcp_packet *dhcppkt );
531
532 extern int start_dhcp ( struct job_interface *job, struct net_device *netdev,
533                         int (*register_options) ( struct net_device *,
534                                                   struct dhcp_option_block * ));
535 extern int dhcp_configure_netdev ( struct net_device *netdev,
536                                    struct dhcp_option_block *options );
537
538 #endif /* _GPXE_DHCP_H */