udhcp: change UDHCP_DEBUG into int, make verbosity selectable with -v
[platform/upstream/busybox.git] / networking / udhcp / common.h
1 /* vi: set sw=4 ts=4: */
2 /* common.h
3  *
4  * Russ Dill <Russ.Dill@asu.edu> September 2001
5  * Rewritten by Vladimir Oleynik <dzo@simtreas.ru> (C) 2003
6  *
7  * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
8  */
9 #ifndef UDHCP_COMMON_H
10 #define UDHCP_COMMON_H 1
11
12 #include "libbb.h"
13 #include <netinet/udp.h>
14 #include <netinet/ip.h>
15
16 PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
17
18 #define DEFAULT_SCRIPT   CONFIG_UDHCPC_DEFAULT_SCRIPT
19
20 extern const uint8_t MAC_BCAST_ADDR[6]; /* six all-ones */
21
22 /*** packet.h ***/
23
24 #define DHCP_OPTIONS_BUFSIZE  308
25
26 //TODO: rename to dhcp_packet; rename ciaddr/yiaddr/chaddr
27 struct dhcpMessage {
28         uint8_t op;      /* 1 = BOOTREQUEST, 2 = BOOTREPLY */
29         uint8_t htype;   /* hardware address type. 1 = 10mb ethernet */
30         uint8_t hlen;    /* hardware address length */
31         uint8_t hops;    /* used by relay agents only */
32         uint32_t xid;    /* unique id */
33         uint16_t secs;   /* elapsed since client began acquisition/renewal */
34         uint16_t flags;  /* only one flag so far: */
35 #define BROADCAST_FLAG 0x8000 /* "I need broadcast replies" */
36         uint32_t ciaddr; /* client IP (if client is in BOUND, RENEW or REBINDING state) */
37         uint32_t yiaddr; /* 'your' (client) IP address */
38         /* IP address of next server to use in bootstrap, returned in DHCPOFFER, DHCPACK by server */
39         uint32_t siaddr_nip;
40         uint32_t gateway_nip; /* relay agent IP address */
41         uint8_t chaddr[16];   /* link-layer client hardware address (MAC) */
42         uint8_t sname[64];    /* server host name (ASCIZ) */
43         uint8_t file[128];    /* boot file name (ASCIZ) */
44         uint32_t cookie;      /* fixed first four option bytes (99,130,83,99 dec) */
45         uint8_t options[DHCP_OPTIONS_BUFSIZE + CONFIG_UDHCPC_SLACK_FOR_BUGGY_SERVERS];
46 } PACKED;
47
48 //TODO: rename to ip_udp_dhcp_packet?
49 struct udp_dhcp_packet {
50         struct iphdr ip;
51         struct udphdr udp;
52         struct dhcpMessage data;
53 } PACKED;
54
55 /* Let's see whether compiler understood us right */
56 struct BUG_bad_sizeof_struct_udp_dhcp_packet {
57         char BUG_bad_sizeof_struct_udp_dhcp_packet
58                 [(sizeof(struct udp_dhcp_packet) != 576 + CONFIG_UDHCPC_SLACK_FOR_BUGGY_SERVERS) ? -1 : 1];
59 };
60
61 uint16_t udhcp_checksum(void *addr, int count) FAST_FUNC;
62
63 void udhcp_init_header(struct dhcpMessage *packet, char type) FAST_FUNC;
64
65 /*int udhcp_recv_raw_packet(struct dhcpMessage *dhcp_pkt, int fd); - in dhcpc.h */
66 int udhcp_recv_kernel_packet(struct dhcpMessage *packet, int fd) FAST_FUNC;
67
68 int udhcp_send_raw_packet(struct dhcpMessage *dhcp_pkt,
69                 uint32_t source_ip, int source_port,
70                 uint32_t dest_ip, int dest_port, const uint8_t *dest_arp,
71                 int ifindex) FAST_FUNC;
72
73 int udhcp_send_kernel_packet(struct dhcpMessage *dhcp_pkt,
74                 uint32_t source_ip, int source_port,
75                 uint32_t dest_ip, int dest_port) FAST_FUNC;
76
77
78 /**/
79
80 void udhcp_run_script(struct dhcpMessage *packet, const char *name) FAST_FUNC;
81
82 // Still need to clean these up...
83
84 /* from options.h */
85 #define get_option              udhcp_get_option
86 #define end_option              udhcp_end_option
87 #define add_option_string       udhcp_add_option_string
88 #define add_simple_option       udhcp_add_simple_option
89
90 void udhcp_sp_setup(void) FAST_FUNC;
91 int udhcp_sp_fd_set(fd_set *rfds, int extra_fd) FAST_FUNC;
92 int udhcp_sp_read(const fd_set *rfds) FAST_FUNC;
93 int udhcp_read_interface(const char *interface, int *ifindex, uint32_t *nip, uint8_t *mac) FAST_FUNC;
94 int udhcp_raw_socket(int ifindex) FAST_FUNC;
95 int udhcp_listen_socket(/*uint32_t ip,*/ int port, const char *inf) FAST_FUNC;
96 /* Returns 1 if no reply received */
97 int arpping(uint32_t test_ip,
98                 const uint8_t *safe_mac,
99                 uint32_t from_ip,
100                 uint8_t *from_mac,
101                 const char *interface) FAST_FUNC;
102
103 #if defined CONFIG_UDHCP_DEBUG && CONFIG_UDHCP_DEBUG >= 1
104 extern int dhcp_verbose;
105 # define log1(...) do { if (dhcp_verbose >= 1) bb_info_msg(__VA_ARGS__); } while (0)
106 # if CONFIG_UDHCP_DEBUG >= 2
107 void udhcp_dump_packet(struct dhcpMessage *packet) FAST_FUNC;
108 #  define log2(...) do { if (dhcp_verbose >= 2) bb_info_msg(__VA_ARGS__); } while (0)
109 # else
110 #  define udhcp_dump_packet(...) ((void)0)
111 #  define log2(...) ((void)0)
112 # endif
113 #else
114 # define udhcp_dump_packet(...) ((void)0)
115 # define log1(...) ((void)0)
116 # define log2(...) ((void)0)
117 #endif
118
119 POP_SAVED_FUNCTION_VISIBILITY
120
121 #endif