udhcp: rename fields in struct dhcpOfferedAddr
[oweals/busybox.git] / networking / udhcp / dhcpd.h
1 /* vi: set sw=4 ts=4: */
2 /* dhcpd.h */
3 #ifndef UDHCP_DHCPD_H
4 #define UDHCP_DHCPD_H 1
5
6 PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
7
8 /************************************/
9 /* Defaults _you_ may want to tweak */
10 /************************************/
11
12 /* the period of time the client is allowed to use that address */
13 #define LEASE_TIME              (60*60*24*10) /* 10 days of seconds */
14 #define LEASES_FILE             CONFIG_DHCPD_LEASES_FILE
15
16 /* where to find the DHCP server configuration file */
17 #define DHCPD_CONF_FILE         "/etc/udhcpd.conf"
18
19 struct option_set {
20         uint8_t *data;
21         struct option_set *next;
22 };
23
24 struct static_lease {
25         struct static_lease *next;
26         uint32_t ip;
27         uint8_t mac[6];
28 };
29
30 struct server_config_t {
31         uint32_t server;                /* Our IP, in network order */
32 #if ENABLE_FEATURE_UDHCP_PORT
33         uint16_t port;
34 #endif
35         /* start,end are in host order: we need to compare start <= ip <= end */
36         uint32_t start_ip;              /* Start address of leases, in host order */
37         uint32_t end_ip;                /* End of leases, in host order */
38         struct option_set *options;     /* List of DHCP options loaded from the config file */
39         char *interface;                /* The name of the interface to use */
40         int ifindex;                    /* Index number of the interface to use */
41         uint8_t arp[6];                 /* Our arp address */
42 // disabled: dumpleases has no way of knowing this value,
43 // and will break if it's off. Now it's on always.
44 //      char remaining;                 /* Should the lease time in lease file
45 //                                       * be written as lease time remaining, or
46 //                                       * as the absolute time the lease expires */
47         uint32_t lease;                 /* lease time in seconds (host order) */
48         uint32_t max_leases;            /* maximum number of leases (including reserved address) */
49         uint32_t auto_time;             /* how long should udhcpd wait before writing a config file.
50                                          * if this is zero, it will only write one on SIGUSR1 */
51         uint32_t decline_time;          /* how long an address is reserved if a client returns a
52                                          * decline message */
53         uint32_t conflict_time;         /* how long an arp conflict offender is leased for */
54         uint32_t offer_time;            /* how long an offered address is reserved */
55         uint32_t min_lease;             /* minimum lease time a client can request */
56         uint32_t siaddr;                /* next server bootp option */
57         char *lease_file;
58         char *pidfile;
59         char *notify_file;              /* What to run whenever leases are written */
60         char *sname;                    /* bootp server name */
61         char *boot_file;                /* bootp boot file option */
62         struct static_lease *static_leases; /* List of ip/mac pairs to assign static leases */
63 };
64
65 #define server_config (*(struct server_config_t*)&bb_common_bufsiz1)
66 /* client_config sits in 2nd half of bb_common_bufsiz1 */
67
68 #if ENABLE_FEATURE_UDHCP_PORT
69 #define SERVER_PORT (server_config.port)
70 #else
71 #define SERVER_PORT 67
72 #endif
73
74
75 /*** leases.h ***/
76
77 typedef uint32_t leasetime_t;
78 typedef int32_t signed_leasetime_t;
79
80 struct dhcpOfferedAddr {
81         uint8_t lease_mac16[16];
82         /* "nip": IP in network order */
83         uint32_t lease_nip;
84         /* Unix time when lease expires, regardless of value of
85          * server_config.remaining. Kept in memory in host order.
86          * When written to file, converted to network order
87          * and optionally adjusted (current time subtracted)
88          * if server_config.remaining = 1 */
89         leasetime_t expires;
90         uint8_t hostname[20]; /* (size is a multiply of 4) */
91 };
92
93 extern struct dhcpOfferedAddr *leases;
94
95 struct dhcpOfferedAddr *add_lease(
96                 const uint8_t *chaddr, uint32_t yiaddr,
97                 leasetime_t leasetime, uint8_t *hostname
98                 ) FAST_FUNC;
99 int lease_expired(struct dhcpOfferedAddr *lease) FAST_FUNC;
100 struct dhcpOfferedAddr *find_lease_by_chaddr(const uint8_t *chaddr) FAST_FUNC;
101 struct dhcpOfferedAddr *find_lease_by_yiaddr(uint32_t yiaddr) FAST_FUNC;
102 uint32_t find_free_or_expired_address(const uint8_t *chaddr) FAST_FUNC;
103
104
105 /*** static_leases.h ***/
106
107 /* Config file will pass static lease info to this function which will add it
108  * to a data structure that can be searched later */
109 void addStaticLease(struct static_lease **lease_struct, uint8_t *mac, uint32_t ip) FAST_FUNC;
110 /* Check to see if a mac has an associated static lease */
111 uint32_t getIpByMac(struct static_lease *lease_struct, void *arg) FAST_FUNC;
112 /* Check to see if an ip is reserved as a static ip */
113 int reservedIp(struct static_lease *lease_struct, uint32_t ip) FAST_FUNC;
114 /* Print out static leases just to check what's going on (debug code) */
115 void printStaticLeases(struct static_lease **lease_struct) FAST_FUNC;
116
117
118 /*** serverpacket.h ***/
119
120 int send_offer(struct dhcpMessage *oldpacket) FAST_FUNC;
121 int send_NAK(struct dhcpMessage *oldpacket) FAST_FUNC;
122 int send_ACK(struct dhcpMessage *oldpacket, uint32_t yiaddr) FAST_FUNC;
123 int send_inform(struct dhcpMessage *oldpacket) FAST_FUNC;
124
125
126 /*** files.h ***/
127
128 void read_config(const char *file) FAST_FUNC;
129 void write_leases(void) FAST_FUNC;
130 void read_leases(const char *file) FAST_FUNC;
131 struct option_set *find_option(struct option_set *opt_list, uint8_t code) FAST_FUNC;
132
133
134 POP_SAVED_FUNCTION_VISIBILITY
135
136 #endif