xref: /freebsd/contrib/libevent/log-internal.h (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1 /*
2  * Copyright (c) 2000-2007 Niels Provos <provos@citi.umich.edu>
3  * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. The name of the author may not be used to endorse or promote products
14  *    derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 #ifndef LOG_INTERNAL_H_INCLUDED_
28 #define LOG_INTERNAL_H_INCLUDED_
29 
30 #include "event2/util.h"
31 
32 #ifdef __GNUC__
33 #define EV_CHECK_FMT(a,b) __attribute__((format(printf, a, b)))
34 #define EV_NORETURN __attribute__((noreturn))
35 #else
36 #define EV_CHECK_FMT(a,b)
37 #define EV_NORETURN
38 #endif
39 
40 #define EVENT_ERR_ABORT_ ((int)0xdeaddead)
41 
42 #define USE_GLOBAL_FOR_DEBUG_LOGGING
43 
44 #if !defined(EVENT__DISABLE_DEBUG_MODE) || defined(USE_DEBUG)
45 #define EVENT_DEBUG_LOGGING_ENABLED
46 #endif
47 
48 #ifdef EVENT_DEBUG_LOGGING_ENABLED
49 #ifdef USE_GLOBAL_FOR_DEBUG_LOGGING
50 extern ev_uint32_t event_debug_logging_mask_;
51 #define event_debug_get_logging_mask_() (event_debug_logging_mask_)
52 #else
53 ev_uint32_t event_debug_get_logging_mask_(void);
54 #endif
55 #else
56 #define event_debug_get_logging_mask_() (0)
57 #endif
58 
59 void event_err(int eval, const char *fmt, ...) EV_CHECK_FMT(2,3) EV_NORETURN;
60 void event_warn(const char *fmt, ...) EV_CHECK_FMT(1,2);
61 void event_sock_err(int eval, evutil_socket_t sock, const char *fmt, ...) EV_CHECK_FMT(3,4) EV_NORETURN;
62 void event_sock_warn(evutil_socket_t sock, const char *fmt, ...) EV_CHECK_FMT(2,3);
63 void event_errx(int eval, const char *fmt, ...) EV_CHECK_FMT(2,3) EV_NORETURN;
64 void event_warnx(const char *fmt, ...) EV_CHECK_FMT(1,2);
65 void event_msgx(const char *fmt, ...) EV_CHECK_FMT(1,2);
66 void event_debugx_(const char *fmt, ...) EV_CHECK_FMT(1,2);
67 
68 void event_logv_(int severity, const char *errstr, const char *fmt, va_list ap)
69 	EV_CHECK_FMT(3,0);
70 
71 #ifdef EVENT_DEBUG_LOGGING_ENABLED
72 #define event_debug(x) do {			\
73 	if (event_debug_get_logging_mask_()) {	\
74 		event_debugx_ x;		\
75 	}					\
76 	} while (0)
77 #else
78 #define event_debug(x) ((void)0)
79 #endif
80 
81 #undef EV_CHECK_FMT
82 
83 #endif
84