/***** SCHEDULING support */
-/* "now" is current program time, in milliseconds. It is derived
- (once) from tv_now. If nfds_io is insufficient for your needs, set
- it to the required number and return ERANGE. timeout is in milliseconds;
- if it is too high then lower it. It starts at -1 (==infinite) */
+/* If nfds_io is insufficient for your needs, set it to the required
+ number and return ERANGE. timeout is in milliseconds; if it is too
+ high then lower it. It starts at -1 (==infinite) */
typedef int beforepoll_fn(void *st, struct pollfd *fds, int *nfds_io,
- int *timeout_io, const struct timeval *tv_now,
- uint64_t *now);
-typedef void afterpoll_fn(void *st, struct pollfd *fds, int nfds,
- const struct timeval *tv_now, uint64_t *now);
+ int *timeout_io);
+typedef void afterpoll_fn(void *st, struct pollfd *fds, int nfds);
/* Register interest in the main loop of the program. Before a call
to poll() your supplied beforepoll function will be called. After
/* The secnet program goes through a number of phases in its lifetime.
Module code may arrange to be called just as various phases are
- entered. */
-
-#define PHASE_INIT 0
-#define PHASE_GETOPTS 1 /* Process command-line arguments */
-#define PHASE_READCONFIG 2 /* Parse and process configuration file */
-#define PHASE_SETUP 3 /* Process information in configuration */
-#define PHASE_GETRESOURCES 4 /* Obtain all external resources */
-#define PHASE_DROPPRIV 5 /* Last chance for privileged operations */
-#define PHASE_RUN 6
-#define PHASE_SHUTDOWN 7 /* About to die; delete key material, etc. */
-#define NR_PHASES 8
+ entered.
+
+ Remember to update the table in util.c if changing the set of
+ phases. */
+
+enum phase {
+ PHASE_INIT,
+ PHASE_GETOPTS, /* Process command-line arguments */
+ PHASE_READCONFIG, /* Parse and process configuration file */
+ PHASE_SETUP, /* Process information in configuration */
+ PHASE_DAEMONIZE, /* Become a daemon (if necessary) */
+ PHASE_GETRESOURCES, /* Obtain all external resources */
+ PHASE_DROPPRIV, /* Last chance for privileged operations */
+ PHASE_RUN,
+ PHASE_SHUTDOWN, /* About to die; delete key material, etc. */
+ /* Keep this last: */
+ NR_PHASES,
+};
typedef void hook_fn(void *self, uint32_t newphase);
bool_t add_hook(uint32_t phase, hook_fn *f, void *state);
/* COMM interface */
+struct comm_addr {
+ /* This struct is pure data; in particular comm's clients may
+ freely copy it. */
+ /* Everyone is also guaranteed that all padding is set to zero, ie
+ that comm_addrs referring to semantically identical peers will
+ compare equal with memcmp. Anyone who constructs a comm_addr
+ must start by memsetting it with FILLZERO, or some
+ equivalent. */
+ struct comm_if *comm;
+ struct sockaddr_in sin;
+};
+
/* Return True if the packet was processed, and shouldn't be passed to
any other potential receivers. */
typedef bool_t comm_notify_fn(void *state, struct buffer_if *buf,
- struct sockaddr_in *source);
+ const struct comm_addr *source);
typedef void comm_request_notify_fn(void *commst, void *nst,
comm_notify_fn *fn);
typedef void comm_release_notify_fn(void *commst, void *nst,
comm_notify_fn *fn);
typedef bool_t comm_sendmsg_fn(void *commst, struct buffer_if *buf,
- struct sockaddr_in *dest);
+ const struct comm_addr *dest);
+typedef const char *comm_addr_to_string_fn(void *commst,
+ const struct comm_addr *ca);
+ /* Returned string is in a static buffer. */
struct comm_if {
void *st;
int32_t min_start_pad;
comm_request_notify_fn *request_notify;
comm_release_notify_fn *release_notify;
comm_sendmsg_fn *sendmsg;
+ comm_addr_to_string_fn *addr_to_string;
};
/* LOG interface */
typedef void netlink_deliver_fn(void *st, struct buffer_if *buf);
/* site code can tell netlink when outgoing packets will be dropped,
so netlink can generate appropriate ICMP and make routing decisions */
-#define LINK_QUALITY_DOWN 0 /* No chance of a packet being delivered */
-#define LINK_QUALITY_DOWN_STALE_ADDRESS 1 /* Link down, old address information */
-#define LINK_QUALITY_DOWN_CURRENT_ADDRESS 2 /* Link down, current address information */
-#define LINK_QUALITY_UP 3 /* Link active */
+#define LINK_QUALITY_UNUSED 0 /* This link is unused, do not make this netlink */
+#define LINK_QUALITY_DOWN 1 /* No chance of a packet being delivered right away*/
+#define LINK_QUALITY_DOWN_STALE_ADDRESS 2 /* Link down, old address information */
+#define LINK_QUALITY_DOWN_CURRENT_ADDRESS 3 /* Link down, current address information */
+#define LINK_QUALITY_UP 4 /* Link active */
#define MAXIMUM_LINK_QUALITY 3
typedef void netlink_link_quality_fn(void *st, uint32_t quality);
typedef void netlink_register_fn(void *st, netlink_deliver_fn *deliver,
netlink_register_fn *reg;
netlink_deliver_fn *deliver;
netlink_link_quality_fn *set_quality;
- netlink_output_config_fn *output_config;
- netlink_check_config_fn *check_config;
netlink_set_mtu_fn *set_mtu;
};
/* HASH interface */
typedef void *hash_init_fn(void);
-typedef void hash_update_fn(void *st, uint8_t const *buf, int32_t len);
+typedef void hash_update_fn(void *st, const void *buf, int32_t len);
typedef void hash_final_fn(void *st, uint8_t *digest);
struct hash_if {
int32_t len; /* Hash output length in bytes */
/***** END of log functions *****/
+#define STRING2(x) #x
+#define STRING(x) STRING2(x)
+
+#define FILLZERO(obj) (memset(&(obj),0,sizeof((obj))))
+
#endif /* secnet_h */