Cortex-A8: stop using CP15 ops
[openocd/libswd.git] / src / helper / log.h
blobf2d19d16b13531152a7a8983a4cc02880e962bb3
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
29 #include "command.h"
31 /* To achieve C99 printf compatibility in MinGW, gnu_printf should be
32 * used for __attribute__((format( ... ))), with GCC v4.4 or later
34 #if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
35 #define PRINTF_ATTRIBUTE_FORMAT gnu_printf
36 #else
37 #define PRINTF_ATTRIBUTE_FORMAT printf
38 #endif
40 /* logging priorities
41 * LOG_LVL_SILENT - turn off all output. In lieu of try + catch this can be used as a
42 * feeble ersatz.
43 * LOG_LVL_USER - user messages. Could be anything from information
44 * to progress messags. These messages do not represent
45 * incorrect or unexpected behaviour, just normal execution.
46 * LOG_LVL_ERROR - fatal errors, that are likely to cause program abort
47 * LOG_LVL_WARNING - non-fatal errors, that may be resolved later
48 * LOG_LVL_INFO - state information, etc.
49 * LOG_LVL_DEBUG - debug statements, execution trace
51 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
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)));
69 /**
70 * Initialize logging module. Call during program startup.
72 void log_init(void);
73 int set_log_output(struct command_context *cmd_ctx, FILE *output);
75 int log_register_commands(struct command_context *cmd_ctx);
77 void keep_alive(void);
78 void kept_alive(void);
80 void alive_sleep(uint64_t ms);
81 void busy_sleep(uint64_t ms);
83 /* log entries can be paused and replayed roughly according to the try/catch/rethrow
84 * concepts in C++
86 void log_try(void);
87 void log_catch(void);
88 void log_rethrow(void);
91 typedef void (*log_callback_fn)(void *priv, const char *file, unsigned line,
92 const char *function, const char *string);
94 struct log_callback {
95 log_callback_fn fn;
96 void *priv;
97 struct log_callback *next;
100 int log_add_callback(log_callback_fn fn, void *priv);
101 int log_remove_callback(log_callback_fn fn, void *priv);
103 char *alloc_vprintf(const char *fmt, va_list ap);
104 char *alloc_printf(const char *fmt, ...);
106 extern int debug_level;
108 /* Avoid fn call and building parameter list if we're not outputting the information.
109 * Matters on feeble CPUs for DEBUG/INFO statements that are involved frequently */
111 #define LOG_LEVEL_IS(FOO) ((debug_level) >= (FOO))
113 #define LOG_DEBUG(expr ...) \
114 ((debug_level >= LOG_LVL_DEBUG) ? log_printf_lf (LOG_LVL_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr) , 0 : 0)
116 #define LOG_INFO(expr ...) \
117 log_printf_lf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
119 #define LOG_INFO_N(expr ...) \
120 log_printf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
122 #define LOG_WARNING(expr ...) \
123 log_printf_lf (LOG_LVL_WARNING, __FILE__, __LINE__, __FUNCTION__, expr)
125 #define LOG_ERROR(expr ...) \
126 log_printf_lf (LOG_LVL_ERROR, __FILE__, __LINE__, __FUNCTION__, expr)
128 #define LOG_USER(expr ...) \
129 log_printf_lf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
131 #define LOG_USER_N(expr ...) \
132 log_printf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
134 #define LOG_OUTPUT(expr ...) \
135 log_printf (LOG_LVL_OUTPUT, __FILE__, __LINE__, __FUNCTION__, expr)
137 /* general failures
138 * error codes < 100
140 #define ERROR_OK (0)
141 #define ERROR_INVALID_ARGUMENTS ERROR_COMMAND_SYNTAX_ERROR
142 #define ERROR_NO_CONFIG_FILE (-2)
143 #define ERROR_BUF_TOO_SMALL (-3)
144 /* see "Error:" log entry for meaningful message to the user. The caller should
145 * make no assumptions about what went wrong and try to handle the problem.
147 #define ERROR_FAIL (-4)
149 #endif /* LOG_H */