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