udhcp: cleanup of static lease handling
[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 nip;
27         uint8_t mac[6];
28 };
29
30 struct server_config_t {
31         uint32_t server_nip;            /* 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         uint32_t lease;                 /* lease time in seconds (host order) */
43         uint32_t max_leases;            /* maximum number of leases (including reserved address) */
44         uint32_t auto_time;             /* how long should udhcpd wait before writing a config file.
45                                          * if this is zero, it will only write one on SIGUSR1 */
46         uint32_t decline_time;          /* how long an address is reserved if a client returns a
47                                          * decline message */
48         uint32_t conflict_time;         /* how long an arp conflict offender is leased for */
49         uint32_t offer_time;            /* how long an offered address is reserved */
50         uint32_t min_lease;             /* minimum lease time a client can request */
51         uint32_t siaddr_nip;                /* next server bootp option */
52         char *lease_file;
53         char *pidfile;
54         char *notify_file;              /* What to run whenever leases are written */
55         char *sname;                    /* bootp server name */
56         char *boot_file;                /* bootp boot file option */
57         struct static_lease *static_leases; /* List of ip/mac pairs to assign static leases */
58 };
59
60 #define server_config (*(struct server_config_t*)&bb_common_bufsiz1)
61 /* client_config sits in 2nd half of bb_common_bufsiz1 */
62
63 #if ENABLE_FEATURE_UDHCP_PORT
64 #define SERVER_PORT (server_config.port)
65 #else
66 #define SERVER_PORT 67
67 #endif
68
69
70 /*** leases.h ***/
71
72 typedef uint32_t leasetime_t;
73 typedef int32_t signed_leasetime_t;
74
75 struct dhcpOfferedAddr {
76         uint8_t lease_mac16[16];
77         /* "nip": IP in network order */
78         uint32_t lease_nip;
79         /* Unix time when lease expires. Kept in memory in host order.
80          * When written to file, converted to network order
81          * and adjusted (current time subtracted) */
82         leasetime_t expires;
83         uint8_t hostname[20]; /* (size is a multiply of 4) */
84 };
85
86 extern struct dhcpOfferedAddr *leases;
87
88 struct dhcpOfferedAddr *add_lease(
89                 const uint8_t *chaddr, uint32_t yiaddr,
90                 leasetime_t leasetime, uint8_t *hostname
91                 ) FAST_FUNC;
92 int lease_expired(struct dhcpOfferedAddr *lease) FAST_FUNC;
93 struct dhcpOfferedAddr *find_lease_by_chaddr(const uint8_t *chaddr) FAST_FUNC;
94 struct dhcpOfferedAddr *find_lease_by_yiaddr(uint32_t yiaddr) FAST_FUNC;
95 uint32_t find_free_or_expired_address(const uint8_t *chaddr) FAST_FUNC;
96
97
98 /*** static_leases.h ***/
99
100 /* Config file parser will pass static lease info to this function
101  * which will add it to a data structure that can be searched later */
102 void add_static_lease(struct static_lease **st_lease_pp, uint8_t *mac, uint32_t nip) FAST_FUNC;
103 /* Find static lease IP by mac */
104 uint32_t get_static_nip_by_mac(struct static_lease *st_lease, void *arg) FAST_FUNC;
105 /* Check to see if an IP is reserved as a static IP */
106 int is_nip_reserved(struct static_lease *st_lease, uint32_t nip) FAST_FUNC;
107 /* Print out static leases just to check what's going on (debug code) */
108 void print_static_leases(struct static_lease **st_lease_pp) FAST_FUNC;
109
110
111 /*** serverpacket.h ***/
112
113 int send_offer(struct dhcpMessage *oldpacket) FAST_FUNC;
114 int send_NAK(struct dhcpMessage *oldpacket) FAST_FUNC;
115 int send_ACK(struct dhcpMessage *oldpacket, uint32_t yiaddr) FAST_FUNC;
116 int send_inform(struct dhcpMessage *oldpacket) FAST_FUNC;
117
118
119 /*** files.h ***/
120
121 void read_config(const char *file) FAST_FUNC;
122 void write_leases(void) FAST_FUNC;
123 void read_leases(const char *file) FAST_FUNC;
124 struct option_set *find_option(struct option_set *opt_list, uint8_t code) FAST_FUNC;
125
126
127 POP_SAVED_FUNCTION_VISIBILITY
128
129 #endif