udhcp: add PXELINUX config file option (code 209) definition
[platform/upstream/busybox.git] / networking / udhcp / common.h
index 2ce6759..5e70d60 100644 (file)
@@ -1,10 +1,9 @@
 /* vi: set sw=4 ts=4: */
-/* common.h
- *
+/*
  * Russ Dill <Russ.Dill@asu.edu> September 2001
  * Rewritten by Vladimir Oleynik <dzo@simtreas.ru> (C) 2003
  *
- * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
+ * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
 #ifndef UDHCP_COMMON_H
 #define UDHCP_COMMON_H 1
@@ -15,7 +14,7 @@
 
 PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
 
-extern const uint8_t MAC_BCAST_ADDR[6]; /* six all-ones */
+extern const uint8_t MAC_BCAST_ADDR[6] ALIGN2; /* six all-ones */
 
 
 /*** DHCP packet ***/
@@ -58,10 +57,20 @@ struct ip_udp_dhcp_packet {
        struct dhcp_packet data;
 } PACKED;
 
+struct udp_dhcp_packet {
+       struct udphdr udp;
+       struct dhcp_packet data;
+} PACKED;
+
+enum {
+       IP_UDP_DHCP_SIZE = sizeof(struct ip_udp_dhcp_packet) - CONFIG_UDHCPC_SLACK_FOR_BUGGY_SERVERS,
+       UDP_DHCP_SIZE    = sizeof(struct udp_dhcp_packet) - CONFIG_UDHCPC_SLACK_FOR_BUGGY_SERVERS,
+       DHCP_SIZE        = sizeof(struct dhcp_packet) - CONFIG_UDHCPC_SLACK_FOR_BUGGY_SERVERS,
+};
+
 /* Let's see whether compiler understood us right */
 struct BUG_bad_sizeof_struct_ip_udp_dhcp_packet {
-       char BUG_bad_sizeof_struct_ip_udp_dhcp_packet
-               [(sizeof(struct ip_udp_dhcp_packet) != 576 + CONFIG_UDHCPC_SLACK_FOR_BUGGY_SERVERS) ? -1 : 1];
+       char c[IP_UDP_DHCP_SIZE == 576 ? 1 : -1];
 };
 
 
@@ -71,16 +80,22 @@ enum {
        OPTION_IP = 1,
        OPTION_IP_PAIR,
        OPTION_STRING,
-#if ENABLE_FEATURE_UDHCP_RFC3397
-       OPTION_STR1035, /* RFC1035 compressed domain name list */
-#endif
-       OPTION_BOOLEAN,
+       /* Opts of STRING_HOST type will be sanitized before they are passed
+        * to udhcpc script's environment: */
+       OPTION_STRING_HOST,
+//     OPTION_BOOLEAN,
        OPTION_U8,
        OPTION_U16,
-       OPTION_S16,
+//     OPTION_S16,
        OPTION_U32,
        OPTION_S32,
+       OPTION_BIN,
        OPTION_STATIC_ROUTES,
+       OPTION_6RD,
+#if ENABLE_FEATURE_UDHCP_RFC3397
+       OPTION_DNS_STRING,  /* RFC1035 compressed domain name list */
+       OPTION_SIP_SERVERS,
+#endif
 
        OPTION_TYPE_MASK = 0x0f,
        /* Client requests this option by default */
@@ -92,7 +107,7 @@ enum {
 /* DHCP option codes (partial list). See RFC 2132 and
  * http://www.iana.org/assignments/bootp-dhcp-parameters/
  * Commented out options are handled by common option machinery,
- * uncommented ones have spacial cases (grep for them to see).
+ * uncommented ones have special cases (grep for them to see).
  */
 #define DHCP_PADDING            0x00
 #define DHCP_SUBNET             0x01
@@ -112,6 +127,7 @@ enum {
 //#define DHCP_IP_TTL           0x17
 //#define DHCP_MTU              0x1a
 //#define DHCP_BROADCAST        0x1c
+//#define DHCP_ROUTES           0x21
 //#define DHCP_NIS_DOMAIN       0x28
 //#define DHCP_NIS_SERVER       0x29
 //#define DHCP_NTP_SERVER       0x2a
@@ -131,7 +147,12 @@ enum {
 //#define DHCP_USER_CLASS       0x4d /* RFC 3004. set of LASCII strings. "I am a printer" etc */
 #define DHCP_FQDN               0x51 /* client asks to update DNS to map its FQDN to its new IP */
 //#define DHCP_DOMAIN_SEARCH    0x77 /* RFC 3397. set of ASCIZ string, DNS-style compressed */
+//#define DHCP_SIP_SERVERS      0x78 /* RFC 3361. flag byte, then: 0: domain names, 1: IP addrs */
 //#define DHCP_STATIC_ROUTES    0x79 /* RFC 3442. (mask,ip,router) tuples */
+//#define DHCP_VLAN_ID          0x84 /* 802.1P VLAN ID */
+//#define DHCP_VLAN_PRIORITY    0x85 /* 802.1Q VLAN priority */
+//#define DHCP_PXE_CONF_FILE    0xd1 /* RFC 5071 Configuration File */
+//#define DHCP_MS_STATIC_ROUTES 0xf9 /* Microsoft's pre-RFC 3442 code for 0x79? */
 //#define DHCP_WPAD             0xfc /* MSIE's Web Proxy Autodiscovery Protocol */
 #define DHCP_END                0xff
 
@@ -156,92 +177,83 @@ enum {
 #define DHCP_MINTYPE DHCPDISCOVER
 #define DHCP_MAXTYPE DHCPINFORM
 
-struct dhcp_option {
+struct dhcp_optflag {
        uint8_t flags;
        uint8_t code;
 };
 
-extern const struct dhcp_option dhcp_options[];
-extern const char dhcp_option_strings[];
-extern const uint8_t dhcp_option_lengths[];
+struct option_set {
+       uint8_t *data;
+       struct option_set *next;
+};
+
+extern const struct dhcp_optflag dhcp_optflags[];
+extern const char dhcp_option_strings[] ALIGN1;
+extern const uint8_t dhcp_option_lengths[] ALIGN1;
+
+unsigned FAST_FUNC udhcp_option_idx(const char *name);
 
 uint8_t *udhcp_get_option(struct dhcp_packet *packet, int code) FAST_FUNC;
 int udhcp_end_option(uint8_t *optionptr) FAST_FUNC;
-void udhcp_add_option_string(uint8_t *optionptr, uint8_t *string) FAST_FUNC;
-void udhcp_add_simple_option(uint8_t *optionptr, uint8_t code, uint32_t data) FAST_FUNC;
+void udhcp_add_binary_option(struct dhcp_packet *packet, uint8_t *addopt) FAST_FUNC;
+void udhcp_add_simple_option(struct dhcp_packet *packet, uint8_t code, uint32_t data) FAST_FUNC;
 #if ENABLE_FEATURE_UDHCP_RFC3397
 char *dname_dec(const uint8_t *cstr, int clen, const char *pre) FAST_FUNC;
 uint8_t *dname_enc(const uint8_t *cstr, int clen, const char *src, int *retlen) FAST_FUNC;
 #endif
+struct option_set *udhcp_find_option(struct option_set *opt_list, uint8_t code) FAST_FUNC;
+
 
 // RFC 2131  Table 5: Fields and options used by DHCP clients
 //
-// Field      DHCPDISCOVER          DHCPREQUEST           DHCPDECLINE,
-//            DHCPINFORM                                  DHCPRELEASE
-// -----      ------------          -----------           -----------
-// 'op'       BOOTREQUEST           BOOTREQUEST           BOOTREQUEST
-// 'hops'     0                     0                     0
-// 'xid'      selected by client    'xid' from server     selected by
-//                                  DHCPOFFER message     client
-// 'secs'     0 or seconds since    0 or seconds since    0
-//            DHCP process started  DHCP process started
-// 'flags'    Set 'BROADCAST'       Set 'BROADCAST'       0
-//            flag if client        flag if client
-//            requires broadcast    requires broadcast
-//            reply                 reply
-// 'ciaddr'   0 (DHCPDISCOVER)      0 or client's         0 (DHCPDECLINE)
-//            client's              network address       client's network
-//            network address       (BOUND/RENEW/REBIND)  address
-//            (DHCPINFORM)                                (DHCPRELEASE)
-// 'yiaddr'   0                     0                     0
-// 'siaddr'   0                     0                     0
-// 'giaddr'   0                     0                     0
-// 'chaddr'   client's hardware     client's hardware     client's hardware
-//            address               address               address
-// 'sname'    options, if           options, if           (unused)
-//            indicated in          indicated in
-//            'sname/file'          'sname/file'
-//            option; otherwise     option; otherwise
-//            unused                unused
-// 'file'     options, if           options, if           (unused)
-//            indicated in          indicated in
-//            'sname/file'          'sname/file'
-//            option; otherwise     option; otherwise
-//            unused                unused
-// 'options'  options               options               (unused)
+// Fields 'hops', 'yiaddr', 'siaddr', 'giaddr' are always zero
 //
-// Option                     DHCPDISCOVER  DHCPREQUEST      DHCPDECLINE,
-//                            DHCPINFORM                     DHCPRELEASE
-// ------                     ------------  -----------      -----------
-// Requested IP address       MAY           MUST (in         MUST
-//                            (DISCOVER)    SELECTING or     (DHCPDECLINE),
-//                            MUST NOT      INIT-REBOOT)     MUST NOT
-//                            (INFORM)      MUST NOT (in     (DHCPRELEASE)
-//                                          BOUND or
-//                                          RENEWING)
-// IP address lease time      MAY           MAY              MUST NOT
-//                            (DISCOVER)
-//                            MUST NOT
-//                            (INFORM)
-// Use 'file'/'sname' fields  MAY           MAY              MAY
-// Client identifier          MAY           MAY              MAY
-// Vendor class identifier    MAY           MAY              MUST NOT
-// Server identifier          MUST NOT      MUST (after      MUST
-//                                          SELECTING)
-//                                          MUST NOT (after
-//                                          INIT-REBOOT,
-//                                          BOUND, RENEWING
-//                                          or REBINDING)
-// Parameter request list     MAY           MAY              MUST NOT
-// Maximum message size       MAY           MAY              MUST NOT
-// Message                    SHOULD NOT    SHOULD NOT       SHOULD
-// Site-specific              MAY           MAY              MUST NOT
-// All others                 MAY           MAY              MUST NOT
+// Field      DHCPDISCOVER          DHCPINFORM            DHCPREQUEST           DHCPDECLINE         DHCPRELEASE
+// -----      ------------          ------------          -----------           -----------         -----------
+// 'xid'      selected by client    selected by client    'xid' from server     selected by client  selected by client
+//                                                        DHCPOFFER message
+// 'secs'     0 or seconds since    0 or seconds since    0 or seconds since    0                   0
+//            DHCP process started  DHCP process started  DHCP process started
+// 'flags'    Set 'BROADCAST'       Set 'BROADCAST'       Set 'BROADCAST'       0                   0
+//            flag if client        flag if client        flag if client
+//            requires broadcast    requires broadcast    requires broadcast
+//            reply                 reply                 reply
+// 'ciaddr'   0                     client's IP           0 or client's IP      0                   client's IP
+//                                                        (BOUND/RENEW/REBIND)
+// 'chaddr'   client's MAC          client's MAC          client's MAC          client's MAC        client's MAC
+// 'sname'    options or sname      options or sname      options or sname      (unused)            (unused)
+// 'file'     options or file       options or file       options or file       (unused)            (unused)
+// 'options'  options               options               options               message type opt    message type opt
+//
+// Option                     DHCPDISCOVER  DHCPINFORM  DHCPREQUEST      DHCPDECLINE  DHCPRELEASE
+// ------                     ------------  ----------  -----------      -----------  -----------
+// Requested IP address       MAY           MUST NOT    MUST (in         MUST         MUST NOT
+//                                                      SELECTING or
+//                                                      INIT-REBOOT)
+//                                                      MUST NOT (in
+//                                                      BOUND or
+//                                                      RENEWING)
+// IP address lease time      MAY           MUST NOT    MAY              MUST NOT     MUST NOT
+// Use 'file'/'sname' fields  MAY           MAY         MAY              MAY          MAY
+// Client identifier          MAY           MAY         MAY              MAY          MAY
+// Vendor class identifier    MAY           MAY         MAY              MUST NOT     MUST NOT
+// Server identifier          MUST NOT      MUST NOT    MUST (after      MUST         MUST
+//                                                      SELECTING)
+//                                                      MUST NOT (after
+//                                                      INIT-REBOOT,
+//                                                      BOUND, RENEWING
+//                                                      or REBINDING)
+// Parameter request list     MAY           MAY         MAY              MUST NOT     MUST NOT
+// Maximum message size       MAY           MAY         MAY              MUST NOT     MUST NOT
+// Message                    SHOULD NOT    SHOULD NOT  SHOULD NOT       SHOULD       SHOULD
+// Site-specific              MAY           MAY         MAY              MUST NOT     MUST NOT
+// All others                 MAY           MAY         MAY              MUST NOT     MUST NOT
 
 
 /*** Logging ***/
 
 #if defined CONFIG_UDHCP_DEBUG && CONFIG_UDHCP_DEBUG >= 1
+# define IF_UDHCP_VERBOSE(...) __VA_ARGS__
 extern unsigned dhcp_verbose;
 # define log1(...) do { if (dhcp_verbose >= 1) bb_info_msg(__VA_ARGS__); } while (0)
 # if CONFIG_UDHCP_DEBUG >= 2
@@ -257,6 +269,7 @@ void udhcp_dump_packet(struct dhcp_packet *packet) FAST_FUNC;
 #  define log3(...) ((void)0)
 # endif
 #else
+# define IF_UDHCP_VERBOSE(...)
 # define udhcp_dump_packet(...) ((void)0)
 # define log1(...) ((void)0)
 # define log2(...) ((void)0)
@@ -266,20 +279,23 @@ void udhcp_dump_packet(struct dhcp_packet *packet) FAST_FUNC;
 
 /*** Other shared functions ***/
 
-uint16_t udhcp_checksum(void *addr, int count) FAST_FUNC;
+/* 2nd param is "uint32_t*" */
+int FAST_FUNC udhcp_str2nip(const char *str, void *arg);
+/* 2nd param is "struct option_set**" */
+int FAST_FUNC udhcp_str2optset(const char *str, void *arg);
 
 void udhcp_init_header(struct dhcp_packet *packet, char type) FAST_FUNC;
 
 int udhcp_recv_kernel_packet(struct dhcp_packet *packet, int fd) FAST_FUNC;
 
 int udhcp_send_raw_packet(struct dhcp_packet *dhcp_pkt,
-               uint32_t source_ip, int source_port,
-               uint32_t dest_ip, int dest_port, const uint8_t *dest_arp,
+               uint32_t source_nip, int source_port,
+               uint32_t dest_nip, int dest_port, const uint8_t *dest_arp,
                int ifindex) FAST_FUNC;
 
 int udhcp_send_kernel_packet(struct dhcp_packet *dhcp_pkt,
-               uint32_t source_ip, int source_port,
-               uint32_t dest_ip, int dest_port) FAST_FUNC;
+               uint32_t source_nip, int source_port,
+               uint32_t dest_nip, int dest_port) FAST_FUNC;
 
 void udhcp_sp_setup(void) FAST_FUNC;
 int udhcp_sp_fd_set(fd_set *rfds, int extra_fd) FAST_FUNC;
@@ -296,6 +312,9 @@ int arpping(uint32_t test_nip,
                uint8_t *from_mac,
                const char *interface) FAST_FUNC;
 
+/* note: ip is a pointer to an IPv6 in network order, possibly misaliged */
+int sprint_nip6(char *dest, /*const char *pre,*/ const uint8_t *ip) FAST_FUNC;
+
 POP_SAVED_FUNCTION_VISIBILITY
 
 #endif