X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fhelper%2Flog.h;h=6b938165b45e46ef9f4fb5d61e8d605f8c4d0f28;hp=f7d703941ac2bc956daf18c88ab1c886aaee9d69;hb=5be455a710c57bbbbd49c2d671b42098db7be5dc;hpb=d9ac6b1d09443c165c497bb99c07f04617386ae7 diff --git a/src/helper/log.h b/src/helper/log.h index f7d703941a..6b938165b4 100644 --- a/src/helper/log.h +++ b/src/helper/log.h @@ -2,6 +2,12 @@ * Copyright (C) 2005 by Dominic Rath * * Dominic.Rath@gmx.de * * * + * Copyright (C) 2007,2008 Øyvind Harboe * + * oyvind.harboe@zylin.com * + * * + * 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 * @@ -13,59 +19,78 @@ * 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. * + * along with this program. If not, see . * ***************************************************************************/ -#ifndef ERROR_H -#define ERROR_H - -#include "replacements.h" -#include "command.h" - -#include - -/* logging priorities - * LOG_USER - user messages. Could be anything from information - * to progress messags. These messages do not represent - * incorrect or unexpected behaviour, just normal execution. - * LOG_ERROR - fatal errors, that are likely to cause program abort - * LOG_WARNING - non-fatal errors, that may be resolved later - * LOG_INFO - state information, etc. - * LOG_DEBUG - debug statements, execution trace + +#ifndef OPENOCD_HELPER_LOG_H +#define OPENOCD_HELPER_LOG_H + +#include + +/* To achieve C99 printf compatibility in MinGW, gnu_printf should be + * used for __attribute__((format( ... ))), with GCC v4.4 or later + */ +#if (defined(IS_MINGW) && (((__GNUC__ << 16) + __GNUC_MINOR__) >= 0x00040004)) +#define PRINTF_ATTRIBUTE_FORMAT gnu_printf +#else +#define PRINTF_ATTRIBUTE_FORMAT printf +#endif + +/* logging priorities + * 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 + * 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 */ -enum log_levels -{ - LOG_OUTPUT = -2, - LOG_USER = -1, - LOG_ERROR = 0, - LOG_WARNING = 1, - LOG_INFO = 2, - LOG_DEBUG = 3 +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 }; -extern void log_printf(enum log_levels level, const char *file, int line, - const char *function, const char *format, ...) -__attribute__ ((format (printf, 5, 6))); -extern void log_printf_lf(enum log_levels level, const char *file, int line, - const char *function, const char *format, ...) -__attribute__ ((format (printf, 5, 6))); -extern int log_register_commands(struct command_context_s *cmd_ctx); -extern int log_init(struct command_context_s *cmd_ctx); -extern int set_log_output(struct command_context_s *cmd_ctx, FILE *output); - -typedef void (*log_callback_fn)(void *priv, const char *file, int line, +void log_printf(enum log_levels level, const char *file, unsigned line, + 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, ...) +__attribute__ ((format (PRINTF_ATTRIBUTE_FORMAT, 5, 6))); + +/** + * Initialize logging module. Call during program startup. + */ +void log_init(void); +int set_log_output(struct command_context *cmd_ctx, FILE *output); + +int log_register_commands(struct command_context *cmd_ctx); + +void keep_alive(void); +void kept_alive(void); + +void alive_sleep(uint64_t ms); +void busy_sleep(uint64_t ms); + +typedef void (*log_callback_fn)(void *priv, const char *file, unsigned line, const char *function, const char *string); -typedef struct log_callback_s -{ +struct log_callback { log_callback_fn fn; void *priv; - struct log_callback_s *next; -} log_callback_t; + struct log_callback *next; +}; -extern int log_add_callback(log_callback_fn fn, void *priv); -extern int log_remove_callback(log_callback_fn fn, void *priv); +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, ...); @@ -75,38 +100,45 @@ extern int debug_level; /* Avoid fn call and building parameter list if we're not outputting the information. * Matters on feeble CPUs for DEBUG/INFO statements that are involved frequently */ +#define LOG_LEVEL_IS(FOO) ((debug_level) >= (FOO)) -#define DEBUG(expr ...) \ - log_printf_lf (LOG_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr) +#define LOG_DEBUG(expr ...) \ + do { \ + if (debug_level >= LOG_LVL_DEBUG) \ + log_printf_lf(LOG_LVL_DEBUG, \ + __FILE__, __LINE__, __func__, \ + expr); \ + } while (0) -#define INFO(expr ...) \ - log_printf_lf (LOG_INFO, __FILE__, __LINE__, __FUNCTION__, expr) +#define LOG_INFO(expr ...) \ + log_printf_lf(LOG_LVL_INFO, __FILE__, __LINE__, __func__, expr) -#define INFO_N(expr ...) \ - log_printf (LOG_INFO, __FILE__, __LINE__, __FUNCTION__, expr) +#define LOG_WARNING(expr ...) \ + log_printf_lf(LOG_LVL_WARNING, __FILE__, __LINE__, __func__, expr) -#define WARNING(expr ...) \ - log_printf_lf (LOG_WARNING, __FILE__, __LINE__, __FUNCTION__, expr) +#define LOG_ERROR(expr ...) \ + log_printf_lf(LOG_LVL_ERROR, __FILE__, __LINE__, __func__, expr) -#define ERROR(expr ...) \ - log_printf_lf (LOG_ERROR, __FILE__, __LINE__, __FUNCTION__, expr) +#define LOG_USER(expr ...) \ + log_printf_lf(LOG_LVL_USER, __FILE__, __LINE__, __func__, expr) -#define USER(expr ...) \ - log_printf_lf (LOG_USER, __FILE__, __LINE__, __FUNCTION__, expr) - -#define USER_N(expr ...) \ - log_printf (LOG_USER, __FILE__, __LINE__, __FUNCTION__, expr) - -#define OUTPUT(expr ...) \ - log_printf (LOG_OUTPUT, __FILE__, __LINE__, __FUNCTION__, expr) +#define LOG_USER_N(expr ...) \ + log_printf(LOG_LVL_USER, __FILE__, __LINE__, __func__, expr) +#define LOG_OUTPUT(expr ...) \ + log_printf(LOG_LVL_OUTPUT, __FILE__, __LINE__, __func__, expr) /* general failures * error codes < 100 */ -#define ERROR_OK (0) -#define ERROR_INVALID_ARGUMENTS (-1) -#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_WAIT (-5) + -#endif /* LOG_H */ +#endif /* OPENOCD_HELPER_LOG_H */