secnet.h

   1 /* Core interface of secnet, to be used by all modules */
   2
   3 #ifndef secnet_h
   4 #define secnet_h
   5
   6 #define ADNS_FEATURE_MANYAF
   7
   8 #include "config.h"
   9 #include <stdlib.h>
  10 #include <stdarg.h>
  11 #include <stdio.h>
  12 #include <string.h>
  13 #include <assert.h>
  14 #include <fcntl.h>
  15 #include <unistd.h>
  16 #include <errno.h>
  17 #include <sys/poll.h>
  18 #include <sys/types.h>
  19 #include <sys/wait.h>
  20 #include <sys/time.h>
  21 #include <netinet/in.h>
  22 #include <arpa/inet.h>
  23
  24 #include <bsd/sys/queue.h>
  25
  26 #define MAX_PEER_ADDRS 5
  27 /* send at most this many copies; honour at most that many addresses */
  28
  29 struct comm_if;
  30 struct comm_addr;
  31
  32 typedef char *string_t;
  33 typedef const char *cstring_t;
  34
  35 #define False (_Bool)0
  36 #define True  (_Bool)1
  37 typedef _Bool bool_t;
  38
  39 union iaddr {
  40     struct sockaddr sa;
  41     struct sockaddr_in sin;
  42 #ifdef CONFIG_IPV6
  43     struct sockaddr_in6 sin6;
  44 #endif
  45 };
  46
  47 #define ASSERT(x) do { if (!(x)) { fatal("assertion failed line %d file " \
  48                                          __FILE__,__LINE__); } } while(0)
  49
  50 /* from version.c */
  51
  52 extern char version[];
  53
  54 /* from logmsg.c */
  55 extern uint32_t message_level;
  56 extern bool_t secnet_is_daemon;
  57 extern struct log_if *system_log;
  58
  59 /* from process.c */
  60 extern void start_signal_handling(void);
  61
  62 void afterfork(void);
  63 /* Must be called before exec in every child made after
  64    start_signal_handling.  Safe to call in earlier children too. */
  65
  66 /***** CONFIGURATION support *****/
  67
  68 extern bool_t just_check_config; /* If True then we're going to exit after
  69                                     reading the configuration file */
  70 extern bool_t background; /* If True then we'll eventually run as a daemon */
  71
  72 typedef struct dict dict_t;        /* Configuration dictionary */
  73 typedef struct closure closure_t;
  74 typedef struct item item_t;
  75 typedef struct list list_t;        /* A list of items */
  76
  77 /* Configuration file location, for error-reporting */
  78 struct cloc {
  79     cstring_t file;
  80     int line;
  81 };
  82
  83 /* Modules export closures, which can be invoked from the configuration file.
  84    "Invoking" a closure usually returns another closure (of a different
  85    type), but can actually return any configuration object. */
  86 typedef list_t *(apply_fn)(closure_t *self, struct cloc loc,
  87                            dict_t *context, list_t *data);
  88 struct closure {
  89     cstring_t description; /* For debugging */
  90     uint32_t type; /* Central registry... */
  91     apply_fn *apply;
  92     void *interface; /* Interface for use inside secnet; depends on type */
  93 };
  94
  95 enum types { t_null, t_bool, t_string, t_number, t_dict, t_closure };
  96 struct item {
  97     enum types type;
  98     union {
  99         bool_t bool;
 100         string_t string;
 101         uint32_t number;
 102         dict_t *dict;
 103         closure_t *closure;
 104     } data;
 105     struct cloc loc;
 106 };
 107
 108 /* Note that it is unwise to use this structure directly; use the list
 109    manipulation functions instead. */
 110 struct list {
 111     item_t *item;
 112     struct list *next;
 113 };
 114
 115 /* In the following two lookup functions, NULL means 'not found' */
 116 /* Lookup a value in the specified dictionary, or its parents */
 117 extern list_t *dict_lookup(dict_t *dict, cstring_t key);
 118 /* Lookup a value in just the specified dictionary */
 119 extern list_t *dict_lookup_primitive(dict_t *dict, cstring_t key);
 120 /* Add a value to the specified dictionary */
 121 extern void dict_add(dict_t *dict, cstring_t key, list_t *val);
 122 /* Obtain an array of keys in the dictionary. malloced; caller frees */
 123 extern cstring_t *dict_keys(dict_t *dict);
 124
 125 /* List-manipulation functions */
 126 extern list_t *list_new(void);
 127 extern int32_t list_length(const list_t *a);
 128 extern list_t *list_append(list_t *a, item_t *i);
 129 extern list_t *list_append_list(list_t *a, list_t *b);
 130 /* Returns an item from the list (index starts at 0), or NULL */
 131 extern item_t *list_elem(list_t *l, int32_t index);
 132
 133 /* Convenience functions */
 134 extern list_t *new_closure(closure_t *cl);
 135 extern void add_closure(dict_t *dict, cstring_t name, apply_fn apply);
 136 extern void *find_cl_if(dict_t *dict, cstring_t name, uint32_t type,
 137                         bool_t fail_if_invalid, cstring_t desc,
 138                         struct cloc loc);
 139 extern item_t *dict_find_item(dict_t *dict, cstring_t key, bool_t required,
 140                               cstring_t desc, struct cloc loc);
 141 extern string_t dict_read_string(dict_t *dict, cstring_t key, bool_t required,
 142                                  cstring_t desc, struct cloc loc);
 143 extern uint32_t dict_read_number(dict_t *dict, cstring_t key, bool_t required,
 144                                  cstring_t desc, struct cloc loc,
 145                                  uint32_t def);
 146   /* return value can safely be assigned to int32_t */
 147 extern bool_t dict_read_bool(dict_t *dict, cstring_t key, bool_t required,
 148                              cstring_t desc, struct cloc loc, bool_t def);
 149 const char **dict_read_string_array(dict_t *dict, cstring_t key,
 150                                     bool_t required, cstring_t desc,
 151                                     struct cloc loc, const char *const *def);
 152   /* Return value is a NULL-terminated array obtained from malloc;
 153    * Individual string values are still owned by config file machinery
 154    * and must not be modified or freed.  Returns NULL if key not
 155    * found. */
 156
 157 struct flagstr {
 158     cstring_t name;
 159     uint32_t value;
 160 };
 161 extern uint32_t string_to_word(cstring_t s, struct cloc loc,
 162                                struct flagstr *f, cstring_t desc);
 163 extern uint32_t string_list_to_word(list_t *l, struct flagstr *f,
 164                                     cstring_t desc);
 165
 166 /***** END of configuration support *****/
 167
 168 /***** UTILITY functions *****/
 169
 170 extern char *safe_strdup(const char *string, const char *message);
 171 extern void *safe_malloc(size_t size, const char *message);
 172 extern void *safe_malloc_ary(size_t size, size_t count, const char *message);
 173 extern void *safe_realloc_ary(void *p, size_t size, size_t count,
 174                               const char *message);
 175
 176 void setcloexec(int fd); /* cannot fail */
 177 void pipe_cloexec(int fd[2]); /* pipe(), setcloexec() twice; cannot fail */
 178
 179 extern int sys_cmd(const char *file, const char *argc, ...);
 180
 181 extern uint64_t now_global;
 182 extern struct timeval tv_now_global;
 183
 184 static const uint64_t       *const now    = &now_global;
 185 static const struct timeval *const tv_now = &tv_now_global;
 186
 187 /* "now" is current program time, in milliseconds. It is derived
 188    from tv_now. Both are provided by the event loop. */
 189
 190 /***** END of utility functions *****/
 191
 192 /***** START of max_start_pad handling *****/
 193
 194 extern int32_t site_max_start_pad, transform_max_start_pad,
 195     comm_max_start_pad;
 196
 197 void update_max_start_pad(int32_t *our_module_global, int32_t our_instance);
 198 int32_t calculate_max_start_pad(void);
 199
 200 /***** END of max_start_pad handling *****/
 201
 202 /***** SCHEDULING support */
 203
 204 /* If nfds_io is insufficient for your needs, set it to the required
 205    number and return ERANGE. timeout is in milliseconds; if it is too
 206    high then lower it. It starts at -1 (==infinite). */
 207 /* Note that beforepoll_fn may NOT do anything which might change the
 208    fds or timeouts wanted by other registered poll loop loopers.
 209    Callers should make sure of this by not making any calls into other
 210    modules from the beforepoll_fn; the easiest way to ensure this is
 211    for beforepoll_fn to only retreive information and not take any
 212    action.
 213  */
 214 typedef int beforepoll_fn(void *st, struct pollfd *fds, int *nfds_io,
 215                           int *timeout_io);
 216 typedef void afterpoll_fn(void *st, struct pollfd *fds, int nfds);
 217   /* If beforepoll_fn returned ERANGE, afterpoll_fn gets nfds==0.
 218      afterpoll_fn never gets !!(fds[].revents & POLLNVAL) - such
 219      a report is detected as a fatal error by the event loop. */
 220
 221 /* void BEFOREPOLL_WANT_FDS(int want);
 222  *   Expects: int *nfds_io;
 223  *   Can perform non-local exit.
 224  * Checks whether there is space for want fds.  If so, sets *nfds_io.
 225  * If not, sets *nfds_io and returns. */
 226 #define BEFOREPOLL_WANT_FDS(want) do{                           \
 227     if (*nfds_io<(want)) { *nfds_io=(want); return ERANGE; }    \
 228     *nfds_io=(want);                                            \
 229   }while(0)
 230
 231 /* Register interest in the main loop of the program. Before a call
 232    to poll() your supplied beforepoll function will be called. After
 233    the call to poll() the supplied afterpoll function will be called. */
 234 struct poll_interest *register_for_poll(void *st, beforepoll_fn *before,
 235                               afterpoll_fn *after, cstring_t desc);
 236 void deregister_for_poll(struct poll_interest *i);
 237
 238 /***** END of scheduling support */
 239
 240 /***** PROGRAM LIFETIME support */
 241
 242 /* The secnet program goes through a number of phases in its lifetime.
 243    Module code may arrange to be called just as various phases are
 244    entered.
 245
 246    Remember to update the table in util.c if changing the set of
 247    phases. */
 248
 249 enum phase {
 250     PHASE_INIT,
 251     PHASE_GETOPTS,             /* Process command-line arguments */
 252     PHASE_READCONFIG,          /* Parse and process configuration file */
 253     PHASE_SETUP,               /* Process information in configuration */
 254     PHASE_DAEMONIZE,           /* Become a daemon (if necessary) */
 255     PHASE_GETRESOURCES,        /* Obtain all external resources */
 256     PHASE_DROPPRIV,            /* Last chance for privileged operations */
 257     PHASE_RUN,
 258     PHASE_SHUTDOWN,            /* About to die; delete key material, etc. */
 259     /* Keep this last: */
 260     NR_PHASES,
 261 };
 262
 263 typedef void hook_fn(void *self, uint32_t newphase);
 264 bool_t add_hook(uint32_t phase, hook_fn *f, void *state);
 265 bool_t remove_hook(uint32_t phase, hook_fn *f, void *state);
 266
 267 extern uint32_t current_phase;
 268 extern void enter_phase(uint32_t new_phase);
 269
 270 /* Some features (like netlink 'soft' routes) require that secnet
 271    retain root privileges.  They should indicate that here when
 272    appropriate. */
 273 extern bool_t require_root_privileges;
 274 extern cstring_t require_root_privileges_explanation;
 275
 276 /***** END of program lifetime support *****/
 277
 278 /***** MODULE support *****/
 279
 280 /* Module initialisation function type - modules export one function of
 281    this type which is called to initialise them. For dynamically loaded
 282    modules it's called "secnet_module". */
 283 typedef void init_module(dict_t *dict);
 284
 285 extern void init_builtin_modules(dict_t *dict);
 286
 287 extern init_module resolver_module;
 288 extern init_module random_module;
 289 extern init_module udp_module;
 290 extern init_module util_module;
 291 extern init_module site_module;
 292 extern init_module transform_eax_module;
 293 extern init_module transform_cbcmac_module;
 294 extern init_module netlink_module;
 295 extern init_module rsa_module;
 296 extern init_module dh_module;
 297 extern init_module md5_module;
 298 extern init_module slip_module;
 299 extern init_module tun_module;
 300 extern init_module sha1_module;
 301 extern init_module log_module;
 302
 303 /***** END of module support *****/
 304
 305 /***** CLOSURE TYPES and interface definitions *****/
 306
 307 #define CL_PURE         0
 308 #define CL_RESOLVER     1
 309 #define CL_RANDOMSRC    2
 310 #define CL_RSAPUBKEY    3
 311 #define CL_RSAPRIVKEY   4
 312 #define CL_COMM         5
 313 #define CL_IPIF         6
 314 #define CL_LOG          7
 315 #define CL_SITE         8
 316 #define CL_TRANSFORM    9
 317 #define CL_DH          11
 318 #define CL_HASH        12
 319 #define CL_BUFFER      13
 320 #define CL_NETLINK     14
 321
 322 struct buffer_if;
 323
 324 /* PURE closure requires no interface */
 325
 326 /* RESOLVER interface */
 327
 328 /* Answers to queries are delivered to a function of this
 329    type. 'address' will be NULL if there was a problem with the query. It
 330    will be freed once resolve_answer_fn returns.  naddrs is the actual
 331    size of the array at addrs; was_naddrs is the number of addresses
 332    actually found in the DNS, which may be bigger if addrs is equal
 333    to MAX_PEER_ADDRS (ie there were too many). */
 334 typedef void resolve_answer_fn(void *st, const struct comm_addr *addrs,
 335                                int naddrs, int was_naddrs,
 336                                const char *name, const char *failwhy);
 337   /* name is the same ptr as passed to request, so its lifetime must
 338    * be suitable*/
 339 typedef bool_t resolve_request_fn(void *st, cstring_t name,
 340                                   int remoteport, struct comm_if *comm,
 341                                   resolve_answer_fn *cb, void *cst);
 342 struct resolver_if {
 343     void *st;
 344     resolve_request_fn *request;
 345 };
 346
 347 /* RANDOMSRC interface */
 348
 349 /* Return some random data. Returns TRUE for success. */
 350 typedef bool_t random_fn(void *st, int32_t bytes, uint8_t *buff);
 351
 352 struct random_if {
 353     void *st;
 354     bool_t blocking;
 355     random_fn *generate;
 356 };
 357
 358 /* RSAPUBKEY interface */
 359
 360 typedef bool_t rsa_checksig_fn(void *st, uint8_t *data, int32_t datalen,
 361                                cstring_t signature);
 362 struct rsapubkey_if {
 363     void *st;
 364     rsa_checksig_fn *check;
 365 };
 366
 367 /* RSAPRIVKEY interface */
 368
 369 typedef string_t rsa_makesig_fn(void *st, uint8_t *data, int32_t datalen);
 370 struct rsaprivkey_if {
 371     void *st;
 372     rsa_makesig_fn *sign;
 373 };
 374
 375 /* COMM interface */
 376
 377 struct comm_addr {
 378     /* This struct is pure data; in particular comm's clients may
 379        freely copy it. */
 380     struct comm_if *comm;
 381     union iaddr ia;
 382     int ix; /* see comment `Re comm_addr.ix' in udp.c */
 383 };
 384
 385 /* Return True if the packet was processed, and shouldn't be passed to
 386    any other potential receivers. (buf is freed iff True returned.) */
 387 typedef bool_t comm_notify_fn(void *state, struct buffer_if *buf,
 388                               const struct comm_addr *source);
 389 typedef void comm_request_notify_fn(void *commst, void *nst,
 390                                     comm_notify_fn *fn);
 391 typedef void comm_release_notify_fn(void *commst, void *nst,
 392                                     comm_notify_fn *fn);
 393 typedef bool_t comm_sendmsg_fn(void *commst, struct buffer_if *buf,
 394                                const struct comm_addr *dest);
 395   /* Only returns false if (we know that) the local network
 396    * environment is such that this address cannot work; transient
 397    * or unknown/unexpected failures return true. */
 398 typedef const char *comm_addr_to_string_fn(void *commst,
 399                                            const struct comm_addr *ca);
 400         /* Returned string is in a static buffer. */
 401 struct comm_if {
 402     void *st;
 403     comm_request_notify_fn *request_notify;
 404     comm_release_notify_fn *release_notify;
 405     comm_sendmsg_fn *sendmsg;
 406     comm_addr_to_string_fn *addr_to_string;
 407 };
 408
 409 bool_t iaddr_equal(const union iaddr *ia, const union iaddr *ib);
 410
 411 static inline const char *comm_addr_to_string(const struct comm_addr *ca)
 412 {
 413     return ca->comm->addr_to_string(ca->comm->st, ca);
 414 }
 415
 416 static inline bool_t comm_addr_equal(const struct comm_addr *a,
 417                                      const struct comm_addr *b)
 418 {
 419     return a->comm==b->comm && iaddr_equal(&a->ia,&b->ia);
 420 }
 421
 422 /* LOG interface */
 423
 424 #define LOG_MESSAGE_BUFLEN 1023
 425
 426 typedef void log_msg_fn(void *st, int class, const char *message, ...);
 427 typedef void log_vmsg_fn(void *st, int class, const char *message,
 428                          va_list args);
 429 struct log_if {
 430     void *st;
 431     log_vmsg_fn *vlogfn; /* printf format checking.  Use [v]slilog instead */
 432     char buff[LOG_MESSAGE_BUFLEN+1];
 433 };
 434 /* (convenience functions, defined in util.c) */
 435 extern void slilog(struct log_if *lf, int class, const char *message, ...)
 436 FORMAT(printf,3,4);
 437 extern void vslilog(struct log_if *lf, int class, const char *message, va_list)
 438 FORMAT(printf,3,0);
 439
 440 /* Versions which take (parts of) (multiple) messages, using \n to
 441  * distinguish one message from another. */
 442 extern void slilog_part(struct log_if *lf, int class, const char *message, ...)
 443 FORMAT(printf,3,4);
 444 extern void vslilog_part(struct log_if *lf, int class, const char *message,
 445                          va_list) FORMAT(printf,3,0);
 446
 447 /* SITE interface */
 448
 449 /* Pretty much a placeholder; allows starting and stopping of processing,
 450    key expiry, etc. */
 451 typedef void site_control_fn(void *st, bool_t run);
 452 typedef uint32_t site_status_fn(void *st);
 453 struct site_if {
 454     void *st;
 455     site_control_fn *control;
 456     site_status_fn *status;
 457 };
 458
 459 /* TRANSFORM interface */
 460
 461 /* A reversable transformation. Transforms buffer in-place; may add
 462    data to start or end. (Reverse transformations decrease
 463    length, of course.)  Transformations may be key-dependent, in which
 464    case key material is passed in at initialisation time. They may
 465    also depend on internal factors (eg. time) and keep internal
 466    state. A struct transform_if only represents a particular type of
 467    transformation; instances of the transformation (eg. with
 468    particular key material) have a different C type. The same
 469    secret key will be used in opposite directions between a pair of
 470    secnets; one of these pairs will get direction==False, the other True. */
 471
 472 typedef struct transform_inst_if *transform_createinstance_fn(void *st);
 473 typedef bool_t transform_setkey_fn(void *st, uint8_t *key, int32_t keylen,
 474                                    bool_t direction);
 475 typedef bool_t transform_valid_fn(void *st); /* 0: no key; 1: ok */
 476 typedef void transform_delkey_fn(void *st);
 477 typedef void transform_destroyinstance_fn(void *st);
 478 /* Returns:
 479  *   0: all is well
 480  *   1: for any other problem
 481  *   2: message decrypted but sequence number was out of range
 482  */
 483 typedef uint32_t transform_apply_fn(void *st, struct buffer_if *buf,
 484                                     const char **errmsg);
 485
 486 struct transform_inst_if {
 487     void *st;
 488     transform_setkey_fn *setkey;
 489     transform_valid_fn *valid;
 490     transform_delkey_fn *delkey;
 491     transform_apply_fn *forwards;
 492     transform_apply_fn *reverse;
 493     transform_destroyinstance_fn *destroy;
 494 };
 495
 496 struct transform_if {
 497     void *st;
 498     int capab_transformnum;
 499     int32_t keylen; /* <<< INT_MAX */
 500     transform_createinstance_fn *create;
 501 };
 502
 503 /* NETLINK interface */
 504
 505 /* Used by netlink to deliver to site, and by site to deliver to
 506    netlink.  cid is the client identifier returned by
 507    netlink_regnets_fn.  If buf has size 0 then the function is just
 508    being called for its site-effects (eg. making the site code attempt
 509    to bring up a network link) */
 510 typedef void netlink_deliver_fn(void *st, struct buffer_if *buf);
 511 /* site code can tell netlink when outgoing packets will be dropped,
 512    so netlink can generate appropriate ICMP and make routing decisions */
 513 #define LINK_QUALITY_UNUSED 0   /* This link is unused, do not make this netlink */
 514 #define LINK_QUALITY_DOWN 1   /* No chance of a packet being delivered right away*/
 515 #define LINK_QUALITY_DOWN_STALE_ADDRESS 2 /* Link down, old address information */
 516 #define LINK_QUALITY_DOWN_CURRENT_ADDRESS 3 /* Link down, current address information */
 517 #define LINK_QUALITY_UP 4     /* Link active */
 518 #define MAXIMUM_LINK_QUALITY 3
 519 typedef void netlink_link_quality_fn(void *st, uint32_t quality);
 520 typedef void netlink_register_fn(void *st, netlink_deliver_fn *deliver,
 521                                  void *dst, uint32_t *localmtu_r /* NULL ok */);
 522 typedef void netlink_output_config_fn(void *st, struct buffer_if *buf);
 523 typedef bool_t netlink_check_config_fn(void *st, struct buffer_if *buf);
 524 typedef void netlink_set_mtu_fn(void *st, int32_t new_mtu);
 525 struct netlink_if {
 526     void *st;
 527     netlink_register_fn *reg;
 528     netlink_deliver_fn *deliver;
 529     netlink_link_quality_fn *set_quality;
 530     netlink_set_mtu_fn *set_mtu;
 531 };
 532
 533 /* DH interface */
 534
 535 /* Returns public key as a malloced hex string */
 536 typedef string_t dh_makepublic_fn(void *st, uint8_t *secret,
 537                                   int32_t secretlen);
 538 /* Fills buffer (up to buflen) with shared secret */
 539 typedef void dh_makeshared_fn(void *st, uint8_t *secret,
 540                               int32_t secretlen, cstring_t rempublic,
 541                               uint8_t *sharedsecret, int32_t buflen);
 542 struct dh_if {
 543     void *st;
 544     int32_t len; /* Approximate size of modulus in bytes */
 545     int32_t ceil_len; /* Number of bytes just sufficient to contain modulus */
 546     dh_makepublic_fn *makepublic;
 547     dh_makeshared_fn *makeshared;
 548 };
 549
 550 /* HASH interface */
 551
 552 typedef void *hash_init_fn(void);
 553 typedef void hash_update_fn(void *st, const void *buf, int32_t len);
 554 typedef void hash_final_fn(void *st, uint8_t *digest);
 555 struct hash_if {
 556     int32_t len; /* Hash output length in bytes */
 557     hash_init_fn *init;
 558     hash_update_fn *update;
 559     hash_final_fn *final;
 560 };
 561
 562 /* BUFFER interface */
 563
 564 struct buffer_if {
 565     bool_t free;
 566     cstring_t owner; /* Set to constant string */
 567     uint32_t flags; /* How paranoid should we be? */
 568     struct cloc loc; /* Where we were defined */
 569     uint8_t *base;
 570     uint8_t *start;
 571     int32_t size; /* Size of buffer contents */
 572     int32_t alloclen; /* Total length allocated at base */
 573 };
 574
 575 /***** LOG functions *****/
 576
 577 #define M_DEBUG_CONFIG 0x001
 578 #define M_DEBUG_PHASE  0x002
 579 #define M_DEBUG        0x004
 580 #define M_INFO         0x008
 581 #define M_NOTICE       0x010
 582 #define M_WARNING      0x020
 583 #define M_ERR          0x040
 584 #define M_SECURITY     0x080
 585 #define M_FATAL        0x100
 586
 587 /* The fatal() family of functions require messages that do not end in '\n' */
 588 extern NORETURN(fatal(const char *message, ...)) FORMAT(printf,1,2);
 589 extern NORETURN(fatal_perror(const char *message, ...)) FORMAT(printf,1,2);
 590 extern NORETURN(fatal_status(int status, const char *message, ...))
 591        FORMAT(printf,2,3);
 592 extern NORETURN(fatal_perror_status(int status, const char *message, ...))
 593        FORMAT(printf,2,3);
 594
 595 /* Convenient nonfatal logging.  Requires message that does not end in '\n'.
 596  * If class contains M_FATAL, exits (after entering PHASE_SHUTDOWN).
 597  * lg, errnoval and loc may sensibly be 0.  desc must NOT be 0.
 598  * lg_[v]perror save and restore errno. */
 599 void lg_vperror(struct log_if *lg, const char *desc, struct cloc *loc,
 600                 int class, int errnoval, const char *fmt, va_list al)
 601     FORMAT(printf,6,0);
 602 void lg_perror(struct log_if *lg, const char *desc, struct cloc *loc,
 603                int class, int errnoval, const char *fmt, ...)
 604     FORMAT(printf,6,7);
 605 void lg_exitstatus(struct log_if *lg, const char *desc, struct cloc *loc,
 606                    int class, int status, const char *progname);
 607
 608 /* The cfgfatal() family of functions require messages that end in '\n' */
 609 extern NORETURN(cfgfatal(struct cloc loc, cstring_t facility,
 610                          const char *message, ...)) FORMAT(printf,3,4);
 611 extern void cfgfile_postreadcheck(struct cloc loc, FILE *f);
 612 extern NORETURN(vcfgfatal_maybefile(FILE *maybe_f, struct cloc loc,
 613                                     cstring_t facility, const char *message,
 614                                     va_list))
 615     FORMAT(printf,4,0);
 616 extern NORETURN(cfgfatal_maybefile(FILE *maybe_f, struct cloc loc,
 617                                    cstring_t facility,
 618                                    const char *message, ...))
 619     FORMAT(printf,4,5);
 620
 621 extern void Message(uint32_t class, const char *message, ...)
 622     FORMAT(printf,2,3);
 623 extern void log_from_fd(int fd, cstring_t prefix, struct log_if *log);
 624
 625 /***** END of log functions *****/
 626
 627 #define STRING2(x) #x
 628 #define STRING(x) STRING2(x)
 629
 630 #define FILLZERO(obj) (memset(&(obj),0,sizeof((obj))))
 631 #define ARRAY_SIZE(ary) (sizeof((ary))/sizeof((ary)[0]))
 632
 633 /*
 634  * void COPY_OBJ(  OBJECT& dst, const OBJECT& src);
 635  * void COPY_ARRAY(OBJECT *dst, const OBJECT *src, INTEGER count);
 636  *   // Typesafe: we check that the type OBJECT is the same in both cases.
 637  *   // It is OK to use COPY_OBJ on an array object, provided it's
 638  *   // _actually_ the whole array object and not decayed into a
 639  *   // pointer (e.g. a formal parameter).
 640  */
 641 #define COPY_OBJ(dst,src) \
 642     (&(dst)==&(src), memcpy(&(dst),&(src),sizeof((dst))))
 643 #define COPY_ARRAY(dst,src,count) \
 644     (&(dst)[0]==&(src)[0], memcpy((dst),(src),sizeof((dst)[0])*(count)))
 645
 646 #endif /* secnet_h */