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 /* Defaults you may want to tweak */
   9 /* Default max_lease_sec */
  10 #define DEFAULT_LEASE_TIME      (60*60*24 * 10)
  11 #define LEASES_FILE             CONFIG_DHCPD_LEASES_FILE
  12 /* Where to find the DHCP server configuration file */
  13 #define DHCPD_CONF_FILE         "/etc/udhcpd.conf"
  14
  15
  16 struct static_lease {
  17         struct static_lease *next;
  18         uint32_t nip;
  19         uint8_t mac[6];
  20 };
  21
  22 struct server_config_t {
  23         char *interface;                /* interface to use */
  24 //TODO: ifindex, server_nip, server_mac
  25 // are obtained from interface name.
  26 // Instead of querying them *once*, create update_server_network_data_cache()
  27 // and call it before any usage of these fields.
  28 // update_server_network_data_cache() must re-query data
  29 // if more than N seconds have passed after last use.
  30         int ifindex;
  31         uint32_t server_nip;
  32 #if ENABLE_FEATURE_UDHCP_PORT
  33         uint16_t port;
  34 #endif
  35         uint8_t server_mac[6];          /* our MAC address (used only for ARP probing) */
  36         struct option_set *options;     /* list of DHCP options loaded from the config file */
  37         /* start,end are in host order: we need to compare start <= ip <= end */
  38         uint32_t start_ip;              /* start address of leases, in host order */
  39         uint32_t end_ip;                /* end of leases, in host order */
  40         uint32_t max_lease_sec;         /* maximum lease time (host order) */
  41         uint32_t min_lease_sec;         /* minimum lease time a client can request */
  42         uint32_t max_leases;            /* maximum number of leases (including reserved addresses) */
  43         uint32_t auto_time;             /* how long should udhcpd wait before writing a config file.
  44                                          * if this is zero, it will only write one on SIGUSR1 */
  45         uint32_t decline_time;          /* how long an address is reserved if a client returns a
  46                                          * decline message */
  47         uint32_t conflict_time;         /* how long an arp conflict offender is leased for */
  48         uint32_t offer_time;            /* how long an offered address is reserved */
  49         uint32_t siaddr_nip;            /* "next server" bootp option */
  50         char *lease_file;
  51         char *pidfile;
  52         char *notify_file;              /* what to run whenever leases are written */
  53         char *sname;                    /* bootp server name */
  54         char *boot_file;                /* bootp boot file option */
  55         struct static_lease *static_leases; /* List of ip/mac pairs to assign static leases */
  56 } FIX_ALIASING;
  57
  58 #define server_config (*(struct server_config_t*)&bb_common_bufsiz1)
  59 /* client_config sits in 2nd half of bb_common_bufsiz1 */
  60
  61 #if ENABLE_FEATURE_UDHCP_PORT
  62 #define SERVER_PORT (server_config.port)
  63 #else
  64 #define SERVER_PORT 67
  65 #endif
  66
  67
  68 /*** leases.h ***/
  69
  70 typedef uint32_t leasetime_t;
  71 typedef int32_t signed_leasetime_t;
  72
  73 struct dyn_lease {
  74         /* "nip": IP in network order */
  75         /* Unix time when lease expires. Kept in memory in host order.
  76          * When written to file, converted to network order
  77          * and adjusted (current time subtracted) */
  78         leasetime_t expires;
  79         uint32_t lease_nip;
  80         /* We use lease_mac[6], since e.g. ARP probing uses
  81          * only 6 first bytes anyway. We check received dhcp packets
  82          * that their hlen == 6 and thus chaddr has only 6 significant bytes
  83          * (dhcp packet has chaddr[16], not [6])
  84          */
  85         uint8_t lease_mac[6];
  86         char hostname[20];
  87         uint8_t pad[2];
  88         /* total size is a multiply of 4 */
  89 } PACKED;
  90
  91 extern struct dyn_lease *g_leases;
  92
  93 struct dyn_lease *add_lease(
  94                 const uint8_t *chaddr, uint32_t yiaddr,
  95                 leasetime_t leasetime,
  96                 const char *hostname, int hostname_len
  97                 ) FAST_FUNC;
  98 int is_expired_lease(struct dyn_lease *lease) FAST_FUNC;
  99 struct dyn_lease *find_lease_by_mac(const uint8_t *mac) FAST_FUNC;
 100 struct dyn_lease *find_lease_by_nip(uint32_t nip) FAST_FUNC;
 101 uint32_t find_free_or_expired_nip(const uint8_t *safe_mac) FAST_FUNC;
 102
 103
 104 /*** static_leases.h ***/
 105
 106 /* Config file parser will pass static lease info to this function
 107  * which will add it to a data structure that can be searched later */
 108 void add_static_lease(struct static_lease **st_lease_pp, uint8_t *mac, uint32_t nip) FAST_FUNC;
 109 /* Find static lease IP by mac */
 110 uint32_t get_static_nip_by_mac(struct static_lease *st_lease, void *arg) FAST_FUNC;
 111 /* Check to see if an IP is reserved as a static IP */
 112 int is_nip_reserved(struct static_lease *st_lease, uint32_t nip) FAST_FUNC;
 113 /* Print out static leases just to check what's going on (debug code) */
 114 #if defined CONFIG_UDHCP_DEBUG && CONFIG_UDHCP_DEBUG >= 2
 115 void log_static_leases(struct static_lease **st_lease_pp) FAST_FUNC;
 116 #else
 117 # define log_static_leases(st_lease_pp) ((void)0)
 118 #endif
 119
 120
 121 /*** files.h ***/
 122
 123 void read_config(const char *file) FAST_FUNC;
 124 void write_leases(void) FAST_FUNC;
 125 void read_leases(const char *file) FAST_FUNC;
 126
 127
 128 POP_SAVED_FUNCTION_VISIBILITY
 129
 130 #endif