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