log.h 4.72 KB
Newer Older
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
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
 *   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

#include "replacements.h"
#include "command.h"

#include <stdarg.h>

/* logging priorities 
29
30
31
32
33
34
35
36
37
 * LOG_LVL_SILENT - turn off all output. In lieu of try+catch this can be used as a 
 *                  feeble ersatz.
 * LOG_LVL_USER - user messages. Could be anything from information 
 *                to progress messags. These messages do not represent
 *                incorrect or unexpected behaviour, just normal execution. 
 * 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
38
39
40
 */
enum log_levels
{
41
42
43
44
45
46
47
	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
48
49
50
51
};

extern void log_printf(enum log_levels level, const char *file, int line, 
	const char *function, const char *format, ...) 
52
__attribute__ ((format (printf, 5, 6)));
53
extern void log_printf_lf(enum log_levels level, const char *file, int line,
54
55
	const char *function, const char *format, ...) 
__attribute__ ((format (printf, 5, 6)));
56
57
58
extern int log_register_commands(struct command_context_s *cmd_ctx);
extern int log_init(struct command_context_s *cmd_ctx);
extern int set_log_output(struct command_context_s *cmd_ctx, FILE *output);
59
60
extern void keep_alive();
extern void kept_alive();
61
62

typedef void (*log_callback_fn)(void *priv, const char *file, int line,
63
		const char *function, const char *string);
64
65
66

typedef struct log_callback_s
{
67
	log_callback_fn fn;
68
	void *priv;
69
	struct log_callback_s *next;
70
71
72
73
74
} log_callback_t;

extern int log_add_callback(log_callback_fn fn, void *priv);
extern int log_remove_callback(log_callback_fn fn, void *priv);

oharboe's avatar
oharboe committed
75
76
char *alloc_vprintf(const char *fmt, va_list ap);
char *alloc_printf(const char *fmt, ...);
77
78
79
80
81
82

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 */

83

84
#define LOG_DEBUG(expr ...) \
85
		((debug_level >= LOG_LVL_DEBUG) ? log_printf_lf (LOG_LVL_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr) , 0 : 0)
86

87
88
#define LOG_INFO(expr ...) \
		log_printf_lf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
89

90
91
#define LOG_INFO_N(expr ...) \
		log_printf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
92

93
94
#define LOG_WARNING(expr ...) \
		log_printf_lf (LOG_LVL_WARNING, __FILE__, __LINE__, __FUNCTION__, expr)
95

96
97
#define LOG_ERROR(expr ...) \
		log_printf_lf (LOG_LVL_ERROR, __FILE__, __LINE__, __FUNCTION__, expr)
98

99
100
#define LOG_USER(expr ...) \
		log_printf_lf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
101

102
103
#define LOG_USER_N(expr ...) \
		log_printf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
104

105
106
#define LOG_OUTPUT(expr ...) \
		log_printf (LOG_LVL_OUTPUT, __FILE__, __LINE__, __FUNCTION__, expr)
107
108
109
110
111

/* general failures
 * error codes < 100
 */
#define ERROR_OK					(0)
112
#define ERROR_INVALID_ARGUMENTS		ERROR_COMMAND_SYNTAX_ERROR
113
114
#define ERROR_NO_CONFIG_FILE		(-2)
#define ERROR_BUF_TOO_SMALL			(-3)
115
/* see "Error:" log entry for meaningful message to the user. The caller should 
116
117
118
 * make no assumptions about what went wrong and try to handle the problem.
 */
#define ERROR_FAIL       			(-4)
119
120

#endif /* LOG_H */