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