5ed769a0dd201048e5b299de504094fe3ca3f11e
[gnupg.git] / common / logging.h
1 /* logging.h
2  * Copyright (C) 1999, 2000, 2001, 2004, 2006,
3  *               2010 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute and/or modify this
8  * part of GnuPG under the terms of either
9  *
10  *   - the GNU Lesser General Public License as published by the Free
11  *     Software Foundation; either version 3 of the License, or (at
12  *     your option) any later version.
13  *
14  * or
15  *
16  *   - the GNU General Public License as published by the Free
17  *     Software Foundation; either version 2 of the License, or (at
18  *     your option) any later version.
19  *
20  * or both in parallel, as here.
21  *
22  * GnuPG is distributed in the hope that it will be useful, but
23  * WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * General Public License for more details.
26  *
27  * You should have received a copies of the GNU General Public License
28  * and the GNU Lesser General Public License along with this program;
29  * if not, see <https://www.gnu.org/licenses/>.
30  */
31
32 #ifndef GNUPG_COMMON_LOGGING_H
33 #define GNUPG_COMMON_LOGGING_H
34
35 #include <stdio.h>
36 #include <stdarg.h>
37 #include <gpg-error.h>
38 #include "mischelp.h"
39 #include "w32help.h"
40
41 #if defined(GPGRT_ENABLE_LOG_MACROS) && defined(log_debug_string)
42   /* We use the libgpg-error provided log functions.  but we need one
43    * more function:  */
44 # ifdef GPGRT_HAVE_MACRO_FUNCTION
45 #  define BUG() bug_at ( __FILE__, __LINE__, __FUNCTION__)
46 static inline void bug_at (const char *file, int line, const char *func)
47                            GPGRT_ATTR_NORETURN;
48 static inline void
49 bug_at (const char *file, int line, const char *func)
50 {
51   gpgrt_log (GPGRT_LOG_BUG, "there is a bug at %s:%d:%s\n", file, line, func);
52   abort ();
53 }
54 # else
55 #  define BUG() bug_at ( __FILE__, __LINE__)
56 static inline void bug_at (const char *file, int line)
57                            GPGRT_ATTR_NORETURN;
58 static inline void
59 bug_at (const char *file, int line)
60 {
61   gpgrt_log (GPGRT_LOG_BUG, "there is a bug at %s:%d\n", file, line);
62   abort ();
63 }
64 # endif /*!GPGRT_HAVE_MACRO_FUNCTION*/
65
66
67 #else /* Use gnupg internal logging functions.  */
68
69 int  log_get_errorcount (int clear);
70 void log_inc_errorcount (void);
71 void log_set_file( const char *name );
72 void log_set_fd (int fd);
73 void log_set_socket_dir_cb (const char *(*fnc)(void));
74 void log_set_pid_suffix_cb (int (*cb)(unsigned long *r_value));
75 void log_set_prefix (const char *text, unsigned int flags);
76 const char *log_get_prefix (unsigned int *flags);
77 int log_test_fd (int fd);
78 int  log_get_fd(void);
79 estream_t log_get_stream (void);
80
81 #ifdef GPGRT_HAVE_MACRO_FUNCTION
82   void bug_at (const char *file, int line, const char *func)
83                GPGRT_ATTR_NORETURN;
84   void _log_assert (const char *expr, const char *file, int line,
85                     const char *func) GPGRT_ATTR_NORETURN;
86 # define BUG() bug_at( __FILE__ , __LINE__, __FUNCTION__)
87 # define log_assert(expr)                                       \
88   ((expr)                                                       \
89    ? (void) 0                                                   \
90    : _log_assert (#expr, __FILE__, __LINE__, __FUNCTION__))
91 #else /*!GPGRT_HAVE_MACRO_FUNCTION*/
92   void bug_at (const char *file, int line);
93   void _log_assert (const char *expr, const char *file, int line);
94 # define BUG() bug_at( __FILE__ , __LINE__ )
95 # define log_assert(expr)                                       \
96   ((expr)                                                       \
97    ? (void) 0                                                   \
98    : _log_assert (#expr, __FILE__, __LINE__))
99 #endif /*!GPGRT_HAVE_MACRO_FUNCTION*/
100
101 /* Flag values for log_set_prefix. */
102 #define GPGRT_LOG_WITH_PREFIX  1
103 #define GPGRT_LOG_WITH_TIME    2
104 #define GPGRT_LOG_WITH_PID     4
105 #define GPGRT_LOG_RUN_DETACHED 256
106 #define GPGRT_LOG_NO_REGISTRY  512
107
108 /* Log levels as used by log_log.  */
109 enum jnlib_log_levels {
110     GPGRT_LOG_BEGIN,
111     GPGRT_LOG_CONT,
112     GPGRT_LOG_INFO,
113     GPGRT_LOG_WARN,
114     GPGRT_LOG_ERROR,
115     GPGRT_LOG_FATAL,
116     GPGRT_LOG_BUG,
117     GPGRT_LOG_DEBUG
118 };
119 void log_log (int level, const char *fmt, ...) GPGRT_ATTR_PRINTF(2,3);
120 void log_logv (int level, const char *fmt, va_list arg_ptr);
121 void log_logv_prefix (int level, const char *prefix,
122                       const char *fmt, va_list arg_ptr);
123 void log_string (int level, const char *string);
124 void log_bug (const char *fmt, ...)    GPGRT_ATTR_NR_PRINTF(1,2);
125 void log_fatal (const char *fmt, ...)  GPGRT_ATTR_NR_PRINTF(1,2);
126 void log_error (const char *fmt, ...)  GPGRT_ATTR_PRINTF(1,2);
127 void log_info (const char *fmt, ...)   GPGRT_ATTR_PRINTF(1,2);
128 void log_debug (const char *fmt, ...)  GPGRT_ATTR_PRINTF(1,2);
129 void log_debug_string (const char *string, const char *fmt,
130                        ...) GPGRT_ATTR_PRINTF(2,3);
131 void log_printf (const char *fmt, ...) GPGRT_ATTR_PRINTF(1,2);
132 void log_flush (void);
133
134 /* Print a hexdump of BUFFER.  With TEXT passes as NULL print just the
135    raw dump, with TEXT being an empty string, print a trailing
136    linefeed, otherwise print an entire debug line with TEXT followed
137    by the hexdump and a final LF.  */
138 void log_printhex (const void *buffer, size_t length, const char *text);
139
140 void log_clock (const char *fmt, ...) GPGRT_ATTR_PRINTF(1,2);
141
142 #endif /* Use gnupg internal logging functions.  */
143 #endif /*GNUPG_COMMON_LOGGING_H*/