OpenOCD
log.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 
3 /***************************************************************************
4  * Copyright (C) 2005 by Dominic Rath *
5  * Dominic.Rath@gmx.de *
6  * *
7  * Copyright (C) 2007,2008 Øyvind Harboe *
8  * oyvind.harboe@zylin.com *
9  * *
10  * Copyright (C) 2008 by Spencer Oliver *
11  * spen@spen-soft.co.uk *
12  ***************************************************************************/
13 
14 #ifndef OPENOCD_HELPER_LOG_H
15 #define OPENOCD_HELPER_LOG_H
16 
17 #include <helper/command.h>
18 
19 /* To achieve C99 printf compatibility in MinGW, gnu_printf should be
20  * used for __attribute__((format( ... ))), with GCC v4.4 or later
21  */
22 #if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004))
23 #define PRINTF_ATTRIBUTE_FORMAT gnu_printf
24 #else
25 #define PRINTF_ATTRIBUTE_FORMAT printf
26 #endif
27 
28 /* logging priorities
29  * LOG_LVL_SILENT - turn off all output. In lieu of try + catch this can be used as a
30  * feeble ersatz.
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
39  */
40 enum log_levels {
49 };
50 
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)));
59 
63 void log_init(void);
64 void log_exit(void);
65 
66 int log_register_commands(struct command_context *cmd_ctx);
67 
68 void keep_alive(void);
69 void kept_alive(void);
70 
71 void alive_sleep(uint64_t ms);
72 void busy_sleep(uint64_t ms);
73 
74 void log_socket_error(const char *socket_desc);
75 
76 typedef void (*log_callback_fn)(void *priv, const char *file, unsigned line,
77  const char *function, const char *string);
78 
79 struct log_callback {
81  void *priv;
82  struct log_callback *next;
83 };
84 
87 
88 char *alloc_vprintf(const char *fmt, va_list ap);
89 char *alloc_printf(const char *fmt, ...)
90  __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 1, 2)));
91 
92 char *find_nonprint_char(char *buf, unsigned buf_len);
93 
94 extern int debug_level;
95 
96 /* Avoid fn call and building parameter list if we're not outputting the information.
97  * Matters on feeble CPUs for DEBUG/INFO statements that are involved frequently */
98 
99 #define LOG_LEVEL_IS(FOO) ((debug_level) >= (FOO))
100 
101 #define LOG_DEBUG_IO(expr ...) \
102  do { \
103  if (debug_level >= LOG_LVL_DEBUG_IO) \
104  log_printf_lf(LOG_LVL_DEBUG, \
105  __FILE__, __LINE__, __func__, \
106  expr); \
107  } while (0)
108 
109 #define LOG_DEBUG(expr ...) \
110  do { \
111  if (debug_level >= LOG_LVL_DEBUG) \
112  log_printf_lf(LOG_LVL_DEBUG, \
113  __FILE__, __LINE__, __func__, \
114  expr); \
115  } while (0)
116 
117 #define LOG_CUSTOM_LEVEL(level, expr ...) \
118  do { \
119  enum log_levels _level = level; \
120  if (debug_level >= _level) \
121  log_printf_lf(_level, \
122  __FILE__, __LINE__, __func__, \
123  expr); \
124  } while (0)
125 
126 #define LOG_INFO(expr ...) \
127  log_printf_lf(LOG_LVL_INFO, __FILE__, __LINE__, __func__, expr)
128 
129 #define LOG_WARNING(expr ...) \
130  log_printf_lf(LOG_LVL_WARNING, __FILE__, __LINE__, __func__, expr)
131 
132 #define LOG_ERROR(expr ...) \
133  log_printf_lf(LOG_LVL_ERROR, __FILE__, __LINE__, __func__, expr)
134 
135 #define LOG_USER(expr ...) \
136  log_printf_lf(LOG_LVL_USER, __FILE__, __LINE__, __func__, expr)
137 
138 #define LOG_USER_N(expr ...) \
139  log_printf(LOG_LVL_USER, __FILE__, __LINE__, __func__, expr)
140 
141 #define LOG_OUTPUT(expr ...) \
142  log_printf(LOG_LVL_OUTPUT, __FILE__, __LINE__, __func__, expr)
143 
144 /* Output a log entry that is related to a given target */
145 
146 #define LOG_TARGET_DEBUG_IO(target, fmt_str, ...) \
147  LOG_DEBUG_IO("[%s] " fmt_str, target_name(target), ##__VA_ARGS__)
148 
149 #define LOG_TARGET_DEBUG(target, fmt_str, ...) \
150  LOG_DEBUG("[%s] " fmt_str, target_name(target), ##__VA_ARGS__)
151 
152 #define LOG_TARGET_INFO(target, fmt_str, ...) \
153  LOG_INFO("[%s] " fmt_str, target_name(target), ##__VA_ARGS__)
154 
155 #define LOG_TARGET_WARNING(target, fmt_str, ...) \
156  LOG_WARNING("[%s] " fmt_str, target_name(target), ##__VA_ARGS__)
157 
158 #define LOG_TARGET_ERROR(target, fmt_str, ...) \
159  LOG_ERROR("[%s] " fmt_str, target_name(target), ##__VA_ARGS__)
160 
161 /* general failures
162  * error codes < 100
163  */
164 #define ERROR_OK (0)
165 #define ERROR_NO_CONFIG_FILE (-2)
166 #define ERROR_BUF_TOO_SMALL (-3)
167 /* see "Error:" log entry for meaningful message to the user. The caller should
168  * make no assumptions about what went wrong and try to handle the problem.
169  */
170 #define ERROR_FAIL (-4)
171 #define ERROR_WAIT (-5)
172 /* ERROR_TIMEOUT is already taken by winerror.h. */
173 #define ERROR_TIMEOUT_REACHED (-6)
174 #define ERROR_NOT_IMPLEMENTED (-7)
175 
176 
177 #endif /* OPENOCD_HELPER_LOG_H */
static struct esp_usb_jtag * priv
Definition: esp_usb_jtag.c:219
int log_remove_callback(log_callback_fn fn, void *priv)
Definition: log.c:322
int log_register_commands(struct command_context *cmd_ctx)
Definition: log.c:262
char char * find_nonprint_char(char *buf, unsigned buf_len)
Find the first non-printable character in the char buffer, return a pointer to it.
Definition: log.c:508
int log_add_callback(log_callback_fn fn, void *priv)
Definition: log.c:297
char * alloc_printf(const char *fmt,...) __attribute__((format(PRINTF_ATTRIBUTE_FORMAT
#define PRINTF_ATTRIBUTE_FORMAT
Definition: log.h:25
char * alloc_vprintf(const char *fmt, va_list ap)
Definition: log.c:339
int debug_level
Definition: log.c:35
void alive_sleep(uint64_t ms)
Definition: log.c:456
void log_printf(enum log_levels level, const char *file, unsigned line, const char *function, const char *format,...) __attribute__((format(PRINTF_ATTRIBUTE_FORMAT
void busy_sleep(uint64_t ms)
Definition: log.c:469
void keep_alive(void)
Definition: log.c:415
void log_printf_lf(enum log_levels level, const char *file, unsigned line, const char *function, const char *format,...) __attribute__((format(PRINTF_ATTRIBUTE_FORMAT
void log_socket_error(const char *socket_desc)
Definition: log.c:484
void log_exit(void)
Definition: log.c:287
void void log_vprintf_lf(enum log_levels level, const char *file, unsigned line, const char *function, const char *format, va_list args)
Definition: log.c:159
void kept_alive(void)
Definition: log.c:443
void(* log_callback_fn)(void *priv, const char *file, unsigned line, const char *function, const char *string)
Definition: log.h:76
void void log_init(void)
Initialize logging module.
Definition: log.c:267
log_levels
Definition: log.h:40
@ LOG_LVL_OUTPUT
Definition: log.h:42
@ LOG_LVL_INFO
Definition: log.h:46
@ LOG_LVL_USER
Definition: log.h:43
@ LOG_LVL_DEBUG
Definition: log.h:47
@ LOG_LVL_DEBUG_IO
Definition: log.h:48
@ LOG_LVL_WARNING
Definition: log.h:45
@ LOG_LVL_SILENT
Definition: log.h:41
@ LOG_LVL_ERROR
Definition: log.h:44
struct qn908x_flash_bank __attribute__
Definition: armv8.c:932
struct log_callback * next
Definition: log.h:82
void * priv
Definition: log.h:81
log_callback_fn fn
Definition: log.h:80