1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 /***************************************************************************
4 * Copyright (C) 2005 by Dominic Rath *
5 * Dominic.Rath@gmx.de *
7 * Copyright (C) 2007,2008 Øyvind Harboe *
8 * oyvind.harboe@zylin.com *
10 * Copyright (C) 2008 by Spencer Oliver *
11 * spen@spen-soft.co.uk *
12 ***************************************************************************/
14 #ifndef OPENOCD_HELPER_LOG_H
15 #define OPENOCD_HELPER_LOG_H
17 #include <helper/command.h>
19 /* To achieve C99 printf compatibility in MinGW, gnu_printf should be
20 * used for __attribute__((format( ... ))), with GCC v4.4 or later
22 #if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
23 #define PRINTF_ATTRIBUTE_FORMAT gnu_printf
25 #define PRINTF_ATTRIBUTE_FORMAT printf
29 * LOG_LVL_SILENT - turn off all output. In lieu of try + catch this can be used as a
31 * LOG_LVL_USER - user messages. Could be anything from information
32 * to progress messages. These messages do not represent
33 * incorrect or unexpected behaviour, just normal execution.
34 * LOG_LVL_ERROR - fatal errors, that are likely to cause program abort
35 * LOG_LVL_WARNING - non-fatal errors, that may be resolved later
36 * LOG_LVL_INFO - state information, etc.
37 * LOG_LVL_DEBUG - debug statements, execution trace
38 * LOG_LVL_DEBUG_IO - verbose debug, low-level I/O trace
51 void log_printf(enum log_levels level, const char *file, unsigned line,
52 const char *function, const char *format, ...)
53 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 5, 6)));
54 void log_vprintf_lf(enum log_levels level, const char *file, unsigned line,
55 const char *function, const char *format, va_list args);
56 void log_printf_lf(enum log_levels level, const char *file, unsigned line,
57 const char *function, const char *format, ...)
58 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 5, 6)));
61 * Initialize logging module. Call during program startup.
65 int set_log_output(struct command_context *cmd_ctx, FILE *output);
67 int log_register_commands(struct command_context *cmd_ctx);
69 void keep_alive(void);
70 void kept_alive(void);
72 void alive_sleep(uint64_t ms);
73 void busy_sleep(uint64_t ms);
75 void log_socket_error(const char *socket_desc);
77 typedef void (*log_callback_fn)(void *priv, const char *file, unsigned line,
78 const char *function, const char *string);
83 struct log_callback *next;
86 int log_add_callback(log_callback_fn fn, void *priv);
87 int log_remove_callback(log_callback_fn fn, void *priv);
89 char *alloc_vprintf(const char *fmt, va_list ap);
90 char *alloc_printf(const char *fmt, ...)
91 __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 1, 2)));
93 char *find_nonprint_char(char *buf, unsigned buf_len);
95 extern int debug_level;
97 /* Avoid fn call and building parameter list if we're not outputting the information.
98 * Matters on feeble CPUs for DEBUG/INFO statements that are involved frequently */
100 #define LOG_LEVEL_IS(FOO) ((debug_level) >= (FOO))
102 #define LOG_DEBUG_IO(expr ...) \
104 if (debug_level >= LOG_LVL_DEBUG_IO) \
105 log_printf_lf(LOG_LVL_DEBUG, \
106 __FILE__, __LINE__, __func__, \
110 #define LOG_DEBUG(expr ...) \
112 if (debug_level >= LOG_LVL_DEBUG) \
113 log_printf_lf(LOG_LVL_DEBUG, \
114 __FILE__, __LINE__, __func__, \
118 #define LOG_INFO(expr ...) \
119 log_printf_lf(LOG_LVL_INFO, __FILE__, __LINE__, __func__, expr)
121 #define LOG_WARNING(expr ...) \
122 log_printf_lf(LOG_LVL_WARNING, __FILE__, __LINE__, __func__, expr)
124 #define LOG_ERROR(expr ...) \
125 log_printf_lf(LOG_LVL_ERROR, __FILE__, __LINE__, __func__, expr)
127 #define LOG_USER(expr ...) \
128 log_printf_lf(LOG_LVL_USER, __FILE__, __LINE__, __func__, expr)
130 #define LOG_USER_N(expr ...) \
131 log_printf(LOG_LVL_USER, __FILE__, __LINE__, __func__, expr)
133 #define LOG_OUTPUT(expr ...) \
134 log_printf(LOG_LVL_OUTPUT, __FILE__, __LINE__, __func__, expr)
136 /* Output a log entry that is related to a given target */
138 #define LOG_TARGET_DEBUG_IO(target, fmt_str, ...) \
139 LOG_DEBUG_IO("[%s] " fmt_str, target_name(target), ##__VA_ARGS__)
141 #define LOG_TARGET_DEBUG(target, fmt_str, ...) \
142 LOG_DEBUG("[%s] " fmt_str, target_name(target), ##__VA_ARGS__)
144 #define LOG_TARGET_INFO(target, fmt_str, ...) \
145 LOG_INFO("[%s] " fmt_str, target_name(target), ##__VA_ARGS__)
147 #define LOG_TARGET_WARNING(target, fmt_str, ...) \
148 LOG_WARNING("[%s] " fmt_str, target_name(target), ##__VA_ARGS__)
150 #define LOG_TARGET_ERROR(target, fmt_str, ...) \
151 LOG_ERROR("[%s] " fmt_str, target_name(target), ##__VA_ARGS__)
157 #define ERROR_NO_CONFIG_FILE (-2)
158 #define ERROR_BUF_TOO_SMALL (-3)
159 /* see "Error:" log entry for meaningful message to the user. The caller should
160 * make no assumptions about what went wrong and try to handle the problem.
162 #define ERROR_FAIL (-4)
163 #define ERROR_WAIT (-5)
164 /* ERROR_TIMEOUT is already taken by winerror.h. */
165 #define ERROR_TIMEOUT_REACHED (-6)
166 #define ERROR_NOT_IMPLEMENTED (-7)
169 #endif /* OPENOCD_HELPER_LOG_H */