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