X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=src%2Fhelper%2Flog.h;h=da1e652df2b658e7273f1d90488b1a63e18dc46a;hb=b2b514be5bcca8b84736ed2abb8687477ade583c;hp=b936fee10f6fa33bb47e3ec1ed5aa8116c5ade8e;hpb=cd3017cffa68e6f56419177e66332f86ab45675b;p=fw%2Fopenocd diff --git a/src/helper/log.h b/src/helper/log.h index b936fee10..da1e652df 100644 --- a/src/helper/log.h +++ b/src/helper/log.h @@ -1,3 +1,5 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later */ + /*************************************************************************** * Copyright (C) 2005 by Dominic Rath * * Dominic.Rath@gmx.de * @@ -7,24 +9,10 @@ * * * Copyright (C) 2008 by Spencer Oliver * * spen@spen-soft.co.uk * - * * - * This program is free software; you can redistribute it and/or modify * - * it under the terms of the GNU General Public License as published by * - * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * - * * - * This program is distributed in the hope that it will be useful, * - * but WITHOUT ANY WARRANTY; without even the implied warranty of * - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * - * GNU General Public License for more details. * - * * - * You should have received a copy of the GNU General Public License * - * along with this program; if not, write to the * - * Free Software Foundation, Inc., * - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * ***************************************************************************/ -#ifndef ERROR_H -#define ERROR_H + +#ifndef OPENOCD_HELPER_LOG_H +#define OPENOCD_HELPER_LOG_H #include @@ -41,35 +29,39 @@ * LOG_LVL_SILENT - turn off all output. In lieu of try + catch this can be used as a * feeble ersatz. * LOG_LVL_USER - user messages. Could be anything from information - * to progress messags. These messages do not represent + * to progress messages. These messages do not represent * incorrect or unexpected behaviour, just normal execution. * LOG_LVL_ERROR - fatal errors, that are likely to cause program abort * LOG_LVL_WARNING - non-fatal errors, that may be resolved later * LOG_LVL_INFO - state information, etc. * LOG_LVL_DEBUG - debug statements, execution trace + * LOG_LVL_DEBUG_IO - verbose debug, low-level I/O trace */ -enum log_levels -{ +enum log_levels { LOG_LVL_SILENT = -3, LOG_LVL_OUTPUT = -2, LOG_LVL_USER = -1, LOG_LVL_ERROR = 0, LOG_LVL_WARNING = 1, LOG_LVL_INFO = 2, - LOG_LVL_DEBUG = 3 + LOG_LVL_DEBUG = 3, + LOG_LVL_DEBUG_IO = 4, }; void log_printf(enum log_levels level, const char *file, unsigned line, - const char *function, const char *format, ...) + const char *function, const char *format, ...) __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 5, 6))); +void log_vprintf_lf(enum log_levels level, const char *file, unsigned line, + const char *function, const char *format, va_list args); void log_printf_lf(enum log_levels level, const char *file, unsigned line, - const char *function, const char *format, ...) + const char *function, const char *format, ...) __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 5, 6))); /** * Initialize logging module. Call during program startup. */ void log_init(void); +void log_exit(void); int set_log_output(struct command_context *cmd_ctx, FILE *output); int log_register_commands(struct command_context *cmd_ctx); @@ -80,13 +72,7 @@ void kept_alive(void); void alive_sleep(uint64_t ms); void busy_sleep(uint64_t ms); -/* log entries can be paused and replayed roughly according to the try/catch/rethrow - * concepts in C++ - */ -void log_try(void); -void log_catch(void); -void log_rethrow(void); - +void log_socket_error(const char *socket_desc); typedef void (*log_callback_fn)(void *priv, const char *file, unsigned line, const char *function, const char *string); @@ -101,7 +87,10 @@ int log_add_callback(log_callback_fn fn, void *priv); int log_remove_callback(log_callback_fn fn, void *priv); char *alloc_vprintf(const char *fmt, va_list ap); -char *alloc_printf(const char *fmt, ...); +char *alloc_printf(const char *fmt, ...) + __attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 1, 2))); + +char *find_nonprint_char(char *buf, unsigned buf_len); extern int debug_level; @@ -110,45 +99,71 @@ extern int debug_level; #define LOG_LEVEL_IS(FOO) ((debug_level) >= (FOO)) +#define LOG_DEBUG_IO(expr ...) \ + do { \ + if (debug_level >= LOG_LVL_DEBUG_IO) \ + log_printf_lf(LOG_LVL_DEBUG, \ + __FILE__, __LINE__, __func__, \ + expr); \ + } while (0) + #define LOG_DEBUG(expr ...) \ - do { \ - if (debug_level >= LOG_LVL_DEBUG) \ - log_printf_lf(LOG_LVL_DEBUG, \ - __FILE__, __LINE__, __func__, \ - expr); \ - } while (0) + do { \ + if (debug_level >= LOG_LVL_DEBUG) \ + log_printf_lf(LOG_LVL_DEBUG, \ + __FILE__, __LINE__, __func__, \ + expr); \ + } while (0) #define LOG_INFO(expr ...) \ - log_printf_lf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr) - -#define LOG_INFO_N(expr ...) \ - log_printf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr) + log_printf_lf(LOG_LVL_INFO, __FILE__, __LINE__, __func__, expr) #define LOG_WARNING(expr ...) \ - log_printf_lf (LOG_LVL_WARNING, __FILE__, __LINE__, __FUNCTION__, expr) + log_printf_lf(LOG_LVL_WARNING, __FILE__, __LINE__, __func__, expr) #define LOG_ERROR(expr ...) \ - log_printf_lf (LOG_LVL_ERROR, __FILE__, __LINE__, __FUNCTION__, expr) + log_printf_lf(LOG_LVL_ERROR, __FILE__, __LINE__, __func__, expr) #define LOG_USER(expr ...) \ - log_printf_lf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr) + log_printf_lf(LOG_LVL_USER, __FILE__, __LINE__, __func__, expr) #define LOG_USER_N(expr ...) \ - log_printf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr) + log_printf(LOG_LVL_USER, __FILE__, __LINE__, __func__, expr) #define LOG_OUTPUT(expr ...) \ - log_printf (LOG_LVL_OUTPUT, __FILE__, __LINE__, __FUNCTION__, expr) + log_printf(LOG_LVL_OUTPUT, __FILE__, __LINE__, __func__, expr) + +/* Output a log entry that is related to a given target */ + +#define LOG_TARGET_DEBUG_IO(target, fmt_str, ...) \ + LOG_DEBUG_IO("[%s] " fmt_str, target_name(target), ##__VA_ARGS__) + +#define LOG_TARGET_DEBUG(target, fmt_str, ...) \ + LOG_DEBUG("[%s] " fmt_str, target_name(target), ##__VA_ARGS__) + +#define LOG_TARGET_INFO(target, fmt_str, ...) \ + LOG_INFO("[%s] " fmt_str, target_name(target), ##__VA_ARGS__) + +#define LOG_TARGET_WARNING(target, fmt_str, ...) \ + LOG_WARNING("[%s] " fmt_str, target_name(target), ##__VA_ARGS__) + +#define LOG_TARGET_ERROR(target, fmt_str, ...) \ + LOG_ERROR("[%s] " fmt_str, target_name(target), ##__VA_ARGS__) /* general failures * error codes < 100 */ -#define ERROR_OK (0) -#define ERROR_INVALID_ARGUMENTS ERROR_COMMAND_SYNTAX_ERROR -#define ERROR_NO_CONFIG_FILE (-2) -#define ERROR_BUF_TOO_SMALL (-3) +#define ERROR_OK (0) +#define ERROR_NO_CONFIG_FILE (-2) +#define ERROR_BUF_TOO_SMALL (-3) /* see "Error:" log entry for meaningful message to the user. The caller should * make no assumptions about what went wrong and try to handle the problem. */ -#define ERROR_FAIL (-4) +#define ERROR_FAIL (-4) +#define ERROR_WAIT (-5) +/* ERROR_TIMEOUT is already taken by winerror.h. */ +#define ERROR_TIMEOUT_REACHED (-6) +#define ERROR_NOT_IMPLEMENTED (-7) + -#endif /* LOG_H */ +#endif /* OPENOCD_HELPER_LOG_H */