]> git.sur5r.net Git - openocd/blob - src/helper/log.h
Remove FSF address from GPL notices
[openocd] / 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, see <http://www.gnu.org/licenses/>. *
23  ***************************************************************************/
24
25 #ifndef ERROR_H
26 #define ERROR_H
27
28 #include <helper/command.h>
29
30 /* To achieve C99 printf compatibility in MinGW, gnu_printf should be
31  * used for __attribute__((format( ... ))), with GCC v4.4 or later
32  */
33 #if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
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         LOG_LVL_SILENT = -3,
52         LOG_LVL_OUTPUT = -2,
53         LOG_LVL_USER = -1,
54         LOG_LVL_ERROR = 0,
55         LOG_LVL_WARNING = 1,
56         LOG_LVL_INFO = 2,
57         LOG_LVL_DEBUG = 3
58 };
59
60 void log_printf(enum log_levels level, const char *file, unsigned line,
61                 const char *function, const char *format, ...)
62 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 5, 6)));
63 void log_printf_lf(enum log_levels level, const char *file, unsigned line,
64                 const char *function, const char *format, ...)
65 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 5, 6)));
66
67 /**
68  * Initialize logging module.  Call during program startup.
69  */
70 void log_init(void);
71 int set_log_output(struct command_context *cmd_ctx, FILE *output);
72
73 int log_register_commands(struct command_context *cmd_ctx);
74
75 void keep_alive(void);
76 void kept_alive(void);
77
78 void alive_sleep(uint64_t ms);
79 void busy_sleep(uint64_t ms);
80
81 typedef void (*log_callback_fn)(void *priv, const char *file, unsigned line,
82                 const char *function, const char *string);
83
84 struct log_callback {
85         log_callback_fn fn;
86         void *priv;
87         struct log_callback *next;
88 };
89
90 int log_add_callback(log_callback_fn fn, void *priv);
91 int log_remove_callback(log_callback_fn fn, void *priv);
92
93 char *alloc_vprintf(const char *fmt, va_list ap);
94 char *alloc_printf(const char *fmt, ...);
95
96 extern int debug_level;
97
98 /* Avoid fn call and building parameter list if we're not outputting the information.
99  * Matters on feeble CPUs for DEBUG/INFO statements that are involved frequently */
100
101 #define LOG_LEVEL_IS(FOO)  ((debug_level) >= (FOO))
102
103 #define LOG_DEBUG(expr ...) \
104         do { \
105                 if (debug_level >= LOG_LVL_DEBUG) \
106                         log_printf_lf(LOG_LVL_DEBUG, \
107                                 __FILE__, __LINE__, __func__, \
108                                 expr); \
109         } while (0)
110
111 #define LOG_INFO(expr ...) \
112         log_printf_lf(LOG_LVL_INFO, __FILE__, __LINE__, __func__, expr)
113
114 #define LOG_WARNING(expr ...) \
115         log_printf_lf(LOG_LVL_WARNING, __FILE__, __LINE__, __func__, expr)
116
117 #define LOG_ERROR(expr ...) \
118         log_printf_lf(LOG_LVL_ERROR, __FILE__, __LINE__, __func__, expr)
119
120 #define LOG_USER(expr ...) \
121         log_printf_lf(LOG_LVL_USER, __FILE__, __LINE__, __func__, expr)
122
123 #define LOG_USER_N(expr ...) \
124         log_printf(LOG_LVL_USER, __FILE__, __LINE__, __func__, expr)
125
126 #define LOG_OUTPUT(expr ...) \
127         log_printf(LOG_LVL_OUTPUT, __FILE__, __LINE__, __func__, expr)
128
129 /* general failures
130  * error codes < 100
131  */
132 #define ERROR_OK                                                (0)
133 #define ERROR_NO_CONFIG_FILE                    (-2)
134 #define ERROR_BUF_TOO_SMALL                             (-3)
135 /* see "Error:" log entry for meaningful message to the user. The caller should
136  * make no assumptions about what went wrong and try to handle the problem.
137  */
138 #define ERROR_FAIL                                              (-4)
139 #define ERROR_WAIT                                              (-5)
140
141
142 #endif  /* LOG_H */