7f9f32c59aef73253f124ce4f7084086bdeb49d4
[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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
25 ***************************************************************************/
26
27 #ifndef ERROR_H
28 #define ERROR_H
29
30 #include <helper/command.h>
31
32 /* To achieve C99 printf compatibility in MinGW, gnu_printf should be
33 * used for __attribute__((format( ... ))), with GCC v4.4 or later
34 */
35 #if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
36 #define PRINTF_ATTRIBUTE_FORMAT gnu_printf
37 #else
38 #define PRINTF_ATTRIBUTE_FORMAT printf
39 #endif
40
41 /* logging priorities
42 * LOG_LVL_SILENT - turn off all output. In lieu of try + catch this can be used as a
43 * feeble ersatz.
44 * LOG_LVL_USER - user messages. Could be anything from information
45 * to progress messags. These messages do not represent
46 * incorrect or unexpected behaviour, just normal execution.
47 * LOG_LVL_ERROR - fatal errors, that are likely to cause program abort
48 * LOG_LVL_WARNING - non-fatal errors, that may be resolved later
49 * LOG_LVL_INFO - state information, etc.
50 * LOG_LVL_DEBUG - debug statements, execution trace
51 */
52 enum log_levels {
53 LOG_LVL_SILENT = -3,
54 LOG_LVL_OUTPUT = -2,
55 LOG_LVL_USER = -1,
56 LOG_LVL_ERROR = 0,
57 LOG_LVL_WARNING = 1,
58 LOG_LVL_INFO = 2,
59 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
69 /**
70 * Initialize logging module. Call during program startup.
71 */
72 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 void keep_alive(void);
78 void kept_alive(void);
79
80 void alive_sleep(uint64_t ms);
81 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 struct log_callback *next;
90 };
91
92 int log_add_callback(log_callback_fn fn, void *priv);
93 int log_remove_callback(log_callback_fn fn, void *priv);
94
95 char *alloc_vprintf(const char *fmt, va_list ap);
96 char *alloc_printf(const char *fmt, ...);
97
98 extern int debug_level;
99
100 /* Avoid fn call and building parameter list if we're not outputting the information.
101 * Matters on feeble CPUs for DEBUG/INFO statements that are involved frequently */
102
103 #define LOG_LEVEL_IS(FOO) ((debug_level) >= (FOO))
104
105 #define LOG_DEBUG(expr ...) \
106 do { \
107 if (debug_level >= LOG_LVL_DEBUG) \
108 log_printf_lf(LOG_LVL_DEBUG, \
109 __FILE__, __LINE__, __func__, \
110 expr); \
111 } while (0)
112
113 #define LOG_INFO(expr ...) \
114 log_printf_lf(LOG_LVL_INFO, __FILE__, __LINE__, __func__, expr)
115
116 #define LOG_WARNING(expr ...) \
117 log_printf_lf(LOG_LVL_WARNING, __FILE__, __LINE__, __func__, expr)
118
119 #define LOG_ERROR(expr ...) \
120 log_printf_lf(LOG_LVL_ERROR, __FILE__, __LINE__, __func__, expr)
121
122 #define LOG_USER(expr ...) \
123 log_printf_lf(LOG_LVL_USER, __FILE__, __LINE__, __func__, expr)
124
125 #define LOG_USER_N(expr ...) \
126 log_printf(LOG_LVL_USER, __FILE__, __LINE__, __func__, expr)
127
128 #define LOG_OUTPUT(expr ...) \
129 log_printf(LOG_LVL_OUTPUT, __FILE__, __LINE__, __func__, expr)
130
131 /* general failures
132 * error codes < 100
133 */
134 #define ERROR_OK (0)
135 #define ERROR_NO_CONFIG_FILE (-2)
136 #define ERROR_BUF_TOO_SMALL (-3)
137 /* see "Error:" log entry for meaningful message to the user. The caller should
138 * make no assumptions about what went wrong and try to handle the problem.
139 */
140 #define ERROR_FAIL (-4)
141 #define ERROR_WAIT (-5)
142
143
144 #endif /* LOG_H */