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