8f6ac7706d365afd1c01a73e7187d71d5ae02cc9
[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 /* To achieve C99 printf compatibility in MinGW, gnu_printf should */
32 /* be used for __attribute__((format( ... ))) */
33 #ifdef IS_MINGW
34 #define PRINTF_ATTRIBUTE_FORMAT gnu_printf
35 #else
36 #define PRINTF_ATTRIBUTE_FORMAT printf
37 #endif
38
39 /* logging priorities
40 * LOG_LVL_SILENT - turn off all output. In lieu of try + catch this can be used as a
41 * feeble ersatz.
42 * LOG_LVL_USER - user messages. Could be anything from information
43 * to progress messags. These messages do not represent
44 * incorrect or unexpected behaviour, just normal execution.
45 * LOG_LVL_ERROR - fatal errors, that are likely to cause program abort
46 * LOG_LVL_WARNING - non-fatal errors, that may be resolved later
47 * LOG_LVL_INFO - state information, etc.
48 * LOG_LVL_DEBUG - debug statements, execution trace
49 */
50 enum log_levels
51 {
52 LOG_LVL_SILENT = -3,
53 LOG_LVL_OUTPUT = -2,
54 LOG_LVL_USER = -1,
55 LOG_LVL_ERROR = 0,
56 LOG_LVL_WARNING = 1,
57 LOG_LVL_INFO = 2,
58 LOG_LVL_DEBUG = 3
59 };
60
61 extern void log_printf(enum log_levels level, const char *file, int line,
62 const char *function, const char *format, ...)
63 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 5, 6)));
64 extern void log_printf_lf(enum log_levels level, const char *file, int line,
65 const char *function, const char *format, ...)
66 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 5, 6)));
67 extern int log_register_commands(struct command_context_s *cmd_ctx);
68 extern int log_init(struct command_context_s *cmd_ctx);
69 extern int set_log_output(struct command_context_s *cmd_ctx, FILE *output);
70 extern void keep_alive(void);
71 extern void kept_alive(void);
72 extern void alive_sleep(int ms);
73 extern void busy_sleep(int ms);
74
75
76 /* log entries can be paused and replayed roughly according to the try/catch/rethrow
77 * concepts in C++
78 */
79 void log_try(void);
80 void log_catch(void);
81 void log_rethrow(void);
82
83
84 typedef void (*log_callback_fn)(void *priv, const char *file, int line,
85 const char *function, const char *string);
86
87 typedef struct log_callback_s
88 {
89 log_callback_fn fn;
90 void *priv;
91 struct log_callback_s *next;
92 } log_callback_t;
93
94 extern int log_add_callback(log_callback_fn fn, void *priv);
95 extern int log_remove_callback(log_callback_fn fn, void *priv);
96
97 char *alloc_vprintf(const char *fmt, va_list ap);
98 char *alloc_printf(const char *fmt, ...);
99
100 extern int debug_level;
101
102 /* Avoid fn call and building parameter list if we're not outputting the information.
103 * Matters on feeble CPUs for DEBUG/INFO statements that are involved frequently */
104
105 #define LOG_LEVEL_IS(FOO) ((debug_level) >= (FOO))
106
107 #define LOG_DEBUG(expr ...) \
108 ((debug_level >= LOG_LVL_DEBUG) ? log_printf_lf (LOG_LVL_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr) , 0 : 0)
109
110 #define LOG_INFO(expr ...) \
111 log_printf_lf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
112
113 #define LOG_INFO_N(expr ...) \
114 log_printf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
115
116 #define LOG_WARNING(expr ...) \
117 log_printf_lf (LOG_LVL_WARNING, __FILE__, __LINE__, __FUNCTION__, expr)
118
119 #define LOG_ERROR(expr ...) \
120 log_printf_lf (LOG_LVL_ERROR, __FILE__, __LINE__, __FUNCTION__, expr)
121
122 #define LOG_USER(expr ...) \
123 log_printf_lf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
124
125 #define LOG_USER_N(expr ...) \
126 log_printf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
127
128 #define LOG_OUTPUT(expr ...) \
129 log_printf (LOG_LVL_OUTPUT, __FILE__, __LINE__, __FUNCTION__, expr)
130
131 /* general failures
132 * error codes < 100
133 */
134 #define ERROR_OK (0)
135 #define ERROR_INVALID_ARGUMENTS ERROR_COMMAND_SYNTAX_ERROR
136 #define ERROR_NO_CONFIG_FILE (-2)
137 #define ERROR_BUF_TOO_SMALL (-3)
138 /* see "Error:" log entry for meaningful message to the user. The caller should
139 * make no assumptions about what went wrong and try to handle the problem.
140 */
141 #define ERROR_FAIL (-4)
142
143 #endif /* LOG_H */