dc4d3d05d370db5f32c3955bfe515be822888543
[openocd.git] / src / helper / log.h
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007,2008 √ėyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
20 * *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
26 #ifndef ERROR_H
27 #define ERROR_H
28
29 #include "command.h"
30
31 /* logging priorities
32 * LOG_LVL_SILENT - turn off all output. In lieu of try + catch this can be used as a
33 * feeble ersatz.
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
41 */
42 enum log_levels
43 {
44 LOG_LVL_SILENT = -3,
45 LOG_LVL_OUTPUT = -2,
46 LOG_LVL_USER = -1,
47 LOG_LVL_ERROR = 0,
48 LOG_LVL_WARNING = 1,
49 LOG_LVL_INFO = 2,
50 LOG_LVL_DEBUG = 3
51 };
52
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);
65 extern void busy_sleep(int ms);
66
67 typedef void (*log_callback_fn)(void *priv, const char *file, int line,
68 const char *function, const char *string);
69
70 typedef struct log_callback_s
71 {
72 log_callback_fn fn;
73 void *priv;
74 struct log_callback_s *next;
75 } log_callback_t;
76
77 extern int log_add_callback(log_callback_fn fn, void *priv);
78 extern int log_remove_callback(log_callback_fn fn, void *priv);
79
80 char *alloc_vprintf(const char *fmt, va_list ap);
81 char *alloc_printf(const char *fmt, ...);
82
83 extern int debug_level;
84
85 /* Avoid fn call and building parameter list if we're not outputting the information.
86 * Matters on feeble CPUs for DEBUG/INFO statements that are involved frequently */
87
88 #define LOG_LEVEL_IS(FOO) ((debug_level) >= (FOO))
89
90 #define LOG_DEBUG(expr ...) \
91 ((debug_level >= LOG_LVL_DEBUG) ? log_printf_lf (LOG_LVL_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr) , 0 : 0)
92
93 #define LOG_INFO(expr ...) \
94 log_printf_lf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
95
96 #define LOG_INFO_N(expr ...) \
97 log_printf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
98
99 #define LOG_WARNING(expr ...) \
100 log_printf_lf (LOG_LVL_WARNING, __FILE__, __LINE__, __FUNCTION__, expr)
101
102 #define LOG_ERROR(expr ...) \
103 log_printf_lf (LOG_LVL_ERROR, __FILE__, __LINE__, __FUNCTION__, expr)
104
105 #define LOG_USER(expr ...) \
106 log_printf_lf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
107
108 #define LOG_USER_N(expr ...) \
109 log_printf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
110
111 #define LOG_OUTPUT(expr ...) \
112 log_printf (LOG_LVL_OUTPUT, __FILE__, __LINE__, __FUNCTION__, expr)
113
114 /* general failures
115 * error codes < 100
116 */
117 #define ERROR_OK (0)
118 #define ERROR_INVALID_ARGUMENTS ERROR_COMMAND_SYNTAX_ERROR
119 #define ERROR_NO_CONFIG_FILE (-2)
120 #define ERROR_BUF_TOO_SMALL (-3)
121 /* see "Error:" log entry for meaningful message to the user. The caller should
122 * make no assumptions about what went wrong and try to handle the problem.
123 */
124 #define ERROR_FAIL (-4)
125
126 #endif /* LOG_H */