1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program; if not, write to the *
20 * Free Software Foundation, Inc., *
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
22 ***************************************************************************/
26 #include "replacements.h"
32 * LOG_LVL_SILENT - turn off all output. In lieu of try+catch this can be used as a
34 * LOG_LVL_USER - user messages. Could be anything from information
35 * to progress messags. These messages do not represent
36 * incorrect or unexpected behaviour, just normal execution.
37 * LOG_LVL_ERROR - fatal errors, that are likely to cause program abort
38 * LOG_LVL_WARNING - non-fatal errors, that may be resolved later
39 * LOG_LVL_INFO - state information, etc.
40 * LOG_LVL_DEBUG - debug statements, execution trace
53 extern void log_printf(enum log_levels level, const char *file, int line,
54 const char *function, const char *format, ...)
55 __attribute__ ((format (printf, 5, 6)));
56 extern void log_printf_lf(enum log_levels level, const char *file, int line,
57 const char *function, const char *format, ...)
58 __attribute__ ((format (printf, 5, 6)));
59 extern int log_register_commands(struct command_context_s *cmd_ctx);
60 extern int log_init(struct command_context_s *cmd_ctx);
61 extern int set_log_output(struct command_context_s *cmd_ctx, FILE *output);
62 extern void keep_alive(void);
63 extern void kept_alive(void);
64 extern void alive_sleep(int ms);
66 typedef void (*log_callback_fn)(void *priv, const char *file, int line,
67 const char *function, const char *string);
69 typedef struct log_callback_s
73 struct log_callback_s *next;
76 extern int log_add_callback(log_callback_fn fn, void *priv);
77 extern int log_remove_callback(log_callback_fn fn, void *priv);
79 char *alloc_vprintf(const char *fmt, va_list ap);
80 char *alloc_printf(const char *fmt, ...);
82 extern int debug_level;
84 /* Avoid fn call and building parameter list if we're not outputting the information.
85 * Matters on feeble CPUs for DEBUG/INFO statements that are involved frequently */
88 #define LOG_DEBUG(expr ...) \
89 ((debug_level >= LOG_LVL_DEBUG) ? log_printf_lf (LOG_LVL_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr) , 0 : 0)
91 #define LOG_INFO(expr ...) \
92 log_printf_lf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
94 #define LOG_INFO_N(expr ...) \
95 log_printf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
97 #define LOG_WARNING(expr ...) \
98 log_printf_lf (LOG_LVL_WARNING, __FILE__, __LINE__, __FUNCTION__, expr)
100 #define LOG_ERROR(expr ...) \
101 log_printf_lf (LOG_LVL_ERROR, __FILE__, __LINE__, __FUNCTION__, expr)
103 #define LOG_USER(expr ...) \
104 log_printf_lf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
106 #define LOG_USER_N(expr ...) \
107 log_printf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
109 #define LOG_OUTPUT(expr ...) \
110 log_printf (LOG_LVL_OUTPUT, __FILE__, __LINE__, __FUNCTION__, expr)
116 #define ERROR_INVALID_ARGUMENTS ERROR_COMMAND_SYNTAX_ERROR
117 #define ERROR_NO_CONFIG_FILE (-2)
118 #define ERROR_BUF_TOO_SMALL (-3)
119 /* see "Error:" log entry for meaningful message to the user. The caller should
120 * make no assumptions about what went wrong and try to handle the problem.
122 #define ERROR_FAIL (-4)