log.h 5.49 KB
Newer Older
1
2
3
4
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
5
 *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
6
7
 *   oyvind.harboe@zylin.com                                               *
 *                                                                         *
8
9
10
 *   Copyright (C) 2008 by Spencer Oliver                                  *
 *   spen@spen-soft.co.uk                                                  *
 *                                                                         *
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef ERROR_H
#define ERROR_H

29
#include <helper/command.h>
30

31
32
33
34
/* To achieve C99 printf compatibility in MinGW, gnu_printf should be
 * used for __attribute__((format( ... ))), with GCC v4.4 or later
 */
#if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
35
36
37
38
39
#define PRINTF_ATTRIBUTE_FORMAT gnu_printf
#else
#define PRINTF_ATTRIBUTE_FORMAT printf
#endif

40
41
/* logging priorities
 * LOG_LVL_SILENT - turn off all output. In lieu of try + catch this can be used as a
42
 *                  feeble ersatz.
43
 * LOG_LVL_USER - user messages. Could be anything from information
44
 *                to progress messags. These messages do not represent
45
 *                incorrect or unexpected behaviour, just normal execution.
46
47
48
49
 * LOG_LVL_ERROR - fatal errors, that are likely to cause program abort
 * LOG_LVL_WARNING - non-fatal errors, that may be resolved later
 * LOG_LVL_INFO - state information, etc.
 * LOG_LVL_DEBUG - debug statements, execution trace
50
51
52
 */
enum log_levels
{
53
54
55
56
57
58
59
	LOG_LVL_SILENT = -3,
	LOG_LVL_OUTPUT = -2,
	LOG_LVL_USER = -1,
	LOG_LVL_ERROR = 0,
	LOG_LVL_WARNING = 1,
	LOG_LVL_INFO = 2,
	LOG_LVL_DEBUG = 3
60
61
};

62
void log_printf(enum log_levels level, const char *file, unsigned line,
63
	const char *function, const char *format, ...)
64
__attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 5, 6)));
65
void log_printf_lf(enum log_levels level, const char *file, unsigned line,
66
	const char *function, const char *format, ...)
67
__attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 5, 6)));
68

Zachary T Welch's avatar
Zachary T Welch committed
69
70
71
72
/**
 * Initialize logging module.  Call during program startup.
 */
void log_init(void);
73
int set_log_output(struct command_context *cmd_ctx, FILE *output);
74

75
int log_register_commands(struct command_context *cmd_ctx);
76
77
78
79

void keep_alive(void);
void kept_alive(void);

80
81
void alive_sleep(uint64_t ms);
void busy_sleep(uint64_t ms);
82

83
typedef void (*log_callback_fn)(void *priv, const char *file, unsigned line,
84
		const char *function, const char *string);
85

86
struct log_callback {
87
	log_callback_fn fn;
88
	void *priv;
89
90
	struct log_callback *next;
};
91

92
93
int log_add_callback(log_callback_fn fn, void *priv);
int log_remove_callback(log_callback_fn fn, void *priv);
94

oharboe's avatar
oharboe committed
95
96
char *alloc_vprintf(const char *fmt, va_list ap);
char *alloc_printf(const char *fmt, ...);
97
98
99
100
101
102

extern int debug_level;

/* Avoid fn call and building parameter list if we're not outputting the information.
 * Matters on feeble CPUs for DEBUG/INFO statements that are involved frequently */

103
#define LOG_LEVEL_IS(FOO)  ((debug_level) >= (FOO))
104

105
#define LOG_DEBUG(expr ...) \
Alex Austin's avatar
Alex Austin committed
106
107
108
109
110
111
		do { \
			if (debug_level >= LOG_LVL_DEBUG) \
				log_printf_lf(LOG_LVL_DEBUG, \
					__FILE__, __LINE__, __func__, \
					expr); \
		} while (0)
112

113
114
#define LOG_INFO(expr ...) \
		log_printf_lf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
115

116
117
#define LOG_WARNING(expr ...) \
		log_printf_lf (LOG_LVL_WARNING, __FILE__, __LINE__, __FUNCTION__, expr)
118

119
120
#define LOG_ERROR(expr ...) \
		log_printf_lf (LOG_LVL_ERROR, __FILE__, __LINE__, __FUNCTION__, expr)
121

122
123
#define LOG_USER(expr ...) \
		log_printf_lf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
124

125
126
#define LOG_USER_N(expr ...) \
		log_printf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
127

128
129
#define LOG_OUTPUT(expr ...) \
		log_printf (LOG_LVL_OUTPUT, __FILE__, __LINE__, __FUNCTION__, expr)
130
131
132
133
134

/* general failures
 * error codes < 100
 */
#define ERROR_OK					(0)
135
#define ERROR_INVALID_ARGUMENTS		ERROR_COMMAND_SYNTAX_ERROR
136
137
#define ERROR_NO_CONFIG_FILE		(-2)
#define ERROR_BUF_TOO_SMALL			(-3)
138
/* see "Error:" log entry for meaningful message to the user. The caller should
139
140
 * make no assumptions about what went wrong and try to handle the problem.
 */
141
#define ERROR_FAIL					(-4)
142
143

#endif /* LOG_H */