-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathmessages.h
123 lines (108 loc) · 4.83 KB
/
messages.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
/*
* Prototypes for message and error reporting (possibly fatal).
*
* The canonical version of this file is maintained in the rra-c-util package,
* which can be found at <https://www.eyrie.org/~eagle/software/rra-c-util/>.
*
* Written by Russ Allbery <[email protected]>
* Copyright 2015 Russ Allbery <[email protected]>
* Copyright 2008, 2010, 2013-2014
* The Board of Trustees of the Leland Stanford Junior University
* Copyright 2004-2006 Internet Systems Consortium, Inc. ("ISC")
* Copyright 1991, 1994-2003 The Internet Software Consortium and Rich Salz
*
* This code is derived from software contributed to the Internet Software
* Consortium by Rich Salz.
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
* REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
* AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
* INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
* LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
* OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*
* SPDX-License-Identifier: ISC
*/
#ifndef UTIL_MESSAGES_H
#define UTIL_MESSAGES_H 1
#include <config.h>
#include <portable/macros.h>
#include <stdarg.h>
#include <stddef.h>
BEGIN_DECLS
/* Default to a hidden visibility for all util functions. */
#pragma GCC visibility push(hidden)
/*
* The reporting functions. The ones prefaced by "sys" add a colon, a space,
* and the results of strerror(errno) to the output and are intended for
* reporting failures of system calls.
*/
void debug(const char *, ...)
__attribute__((__nonnull__, __format__(printf, 1, 2)));
void notice(const char *, ...)
__attribute__((__nonnull__, __format__(printf, 1, 2)));
void sysnotice(const char *, ...)
__attribute__((__nonnull__, __format__(printf, 1, 2)));
void warn(const char *, ...)
__attribute__((__nonnull__, __format__(printf, 1, 2)));
void syswarn(const char *, ...)
__attribute__((__nonnull__, __format__(printf, 1, 2)));
void die(const char *, ...)
__attribute__((__nonnull__, __noreturn__, __format__(printf, 1, 2)));
void sysdie(const char *, ...)
__attribute__((__nonnull__, __noreturn__, __format__(printf, 1, 2)));
/*
* Set the handlers for various message functions. All of these functions
* take a count of the number of handlers and then function pointers for each
* of those handlers. These functions are not thread-safe; they set global
* variables.
*/
void message_handlers_debug(unsigned int count, ...);
void message_handlers_notice(unsigned int count, ...);
void message_handlers_warn(unsigned int count, ...);
void message_handlers_die(unsigned int count, ...);
/*
* Reset all message handlers back to the defaults and free any memory that
* was allocated by the other message_handlers_* functions.
*/
void message_handlers_reset(void);
/*
* Some useful handlers, intended to be passed to message_handlers_*. All
* handlers take the length of the formatted message, the format, a variadic
* argument list, and the errno setting if any.
*/
void message_log_stdout(size_t, const char *, va_list, int)
__attribute__((__format__(printf, 2, 0), __nonnull__));
void message_log_stderr(size_t, const char *, va_list, int)
__attribute__((__format__(printf, 2, 0), __nonnull__));
void message_log_syslog_debug(size_t, const char *, va_list, int)
__attribute__((__format__(printf, 2, 0), __nonnull__));
void message_log_syslog_info(size_t, const char *, va_list, int)
__attribute__((__format__(printf, 2, 0), __nonnull__));
void message_log_syslog_notice(size_t, const char *, va_list, int)
__attribute__((__format__(printf, 2, 0), __nonnull__));
void message_log_syslog_warning(size_t, const char *, va_list, int)
__attribute__((__format__(printf, 2, 0), __nonnull__));
void message_log_syslog_err(size_t, const char *, va_list, int)
__attribute__((__format__(printf, 2, 0), __nonnull__));
void message_log_syslog_crit(size_t, const char *, va_list, int)
__attribute__((__format__(printf, 2, 0), __nonnull__));
/* The type of a message handler. */
typedef void (*message_handler_func)(size_t, const char *, va_list, int)
__attribute__((__format__(printf, 2, 0)));
/* If non-NULL, called before exit and its return value passed to exit. */
extern int (*message_fatal_cleanup)(void);
/*
* If non-NULL, prepended (followed by ": ") to all messages printed by either
* message_log_stdout or message_log_stderr.
*/
extern const char *message_program_name;
/* Undo default visibility change. */
#pragma GCC visibility pop
END_DECLS
#endif /* UTIL_MESSAGES_H */