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