X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fhelper%2Flog.h;h=6b81e41e205d22b1b74f6857fa88bfdd04cd1354;hp=624aa29cee1404dee1bfc21419441f6d44be8211;hb=68c598e88d5e09728ea845a81ab279c615bbaf0f;hpb=2d48f25dcfc61c23de05b4eb897b17fcae3b9af2 diff --git a/src/helper/log.h b/src/helper/log.h index 624aa29cee..6b81e41e20 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 * @@ -26,48 +32,55 @@ #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 + * 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 + 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_printfnl(enum log_levels level, const char *file, int line, +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); +extern void keep_alive(void); +extern void kept_alive(void); +extern void alive_sleep(int ms); typedef void (*log_callback_fn)(void *priv, const char *file, int line, - const char *function, const char *format, va_list args); + const char *function, const char *string); typedef struct log_callback_s { - log_callback_fn fn; + log_callback_fn fn; void *priv; - struct log_callback_s *next; + struct log_callback_s *next; } log_callback_t; extern int log_add_callback(log_callback_fn fn, void *priv); extern int log_remove_callback(log_callback_fn fn, void *priv); -char *alloc_printf(const char *fmt, va_list ap); +char *alloc_vprintf(const char *fmt, va_list ap); +char *alloc_printf(const char *fmt, ...); extern int debug_level; @@ -75,53 +88,40 @@ extern int debug_level; * Matters on feeble CPUs for DEBUG/INFO statements that are involved frequently */ -#define DEBUG(expr ...) \ - do { if (debug_level >= LOG_DEBUG) \ - log_printfnl (LOG_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr); \ - } while(0) +#define LOG_DEBUG(expr ...) \ + ((debug_level >= LOG_LVL_DEBUG) ? log_printf_lf (LOG_LVL_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr) , 0 : 0) -#define INFO(expr ...) \ - do { if (debug_level >= LOG_INFO) \ - log_printfnl (LOG_INFO, __FILE__, __LINE__, __FUNCTION__, expr); \ - } while(0) +#define LOG_INFO(expr ...) \ + log_printf_lf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr) -#define INFO_SAMELINE(expr ...) \ - do { if (debug_level >= LOG_INFO) \ - log_printf (LOG_INFO, __FILE__, __LINE__, __FUNCTION__, expr); \ - } while(0) +#define LOG_INFO_N(expr ...) \ + log_printf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr) -#define WARNING(expr ...) \ - do { \ - log_printfnl (LOG_WARNING, __FILE__, __LINE__, __FUNCTION__, expr); \ - } while(0) +#define LOG_WARNING(expr ...) \ + log_printf_lf (LOG_LVL_WARNING, __FILE__, __LINE__, __FUNCTION__, expr) -#define ERROR(expr ...) \ - do { \ - log_printfnl (LOG_ERROR, __FILE__, __LINE__, __FUNCTION__, expr); \ - } while(0) +#define LOG_ERROR(expr ...) \ + log_printf_lf (LOG_LVL_ERROR, __FILE__, __LINE__, __FUNCTION__, expr) -#define USER(expr ...) \ - do { \ - log_printfnl (LOG_USER, __FILE__, __LINE__, __FUNCTION__, expr); \ - } while(0) +#define LOG_USER(expr ...) \ + log_printf_lf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr) -#define USER_SAMELINE(expr ...) \ - do { \ - log_printf (LOG_USER, __FILE__, __LINE__, __FUNCTION__, expr); \ - } while(0) - -#define OUTPUT(expr ...) \ - do { \ - log_printfnl (LOG_OUTPUT, __FILE__, __LINE__, __FUNCTION__, expr); \ - } while(0) +#define LOG_USER_N(expr ...) \ + log_printf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr) +#define LOG_OUTPUT(expr ...) \ + log_printf (LOG_LVL_OUTPUT, __FILE__, __LINE__, __FUNCTION__, expr) /* general failures * error codes < 100 */ #define ERROR_OK (0) -#define ERROR_INVALID_ARGUMENTS (-1) +#define ERROR_INVALID_ARGUMENTS ERROR_COMMAND_SYNTAX_ERROR #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) #endif /* LOG_H */