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