X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=src%2Fhelper%2Flog.h;h=6d61cf5f267e0a6fb762f436fbf235cf27a12860;hb=8b916771331a17231c9501d86b10e6bd37bfae2c;hp=6988bfcb9921721a385c8a4e5f5beaa48b67b6b8;hpb=5ed126c4f90948fbf53d186dc4ef49018fb5ecfc;p=openocd diff --git a/src/helper/log.h b/src/helper/log.h index 6988bfcb..6d61cf5f 100644 --- a/src/helper/log.h +++ b/src/helper/log.h @@ -20,71 +20,88 @@ #ifndef ERROR_H #define ERROR_H +#include "replacements.h" #include "command.h" #include /* logging priorities - * 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_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))); +__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, + const char *function, const char *string); + +typedef struct log_callback_s +{ + log_callback_fn fn; + void *priv; + 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_vprintf(const char *fmt, va_list ap); +char *alloc_printf(const char *fmt, ...); extern int debug_level; -#define DEBUG(expr ...) \ - do { \ - log_printf (LOG_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr); \ - } while(0) - -#define INFO(expr ...) \ - do { \ - log_printf (LOG_INFO, __FILE__, __LINE__, __FUNCTION__, expr); \ - } while(0) - -#define WARNING(expr ...) \ - do { \ - log_printf (LOG_WARNING, __FILE__, __LINE__, __FUNCTION__, expr); \ - } while(0) - -#define ERROR(expr ...) \ - do { \ - log_printf (LOG_ERROR, __FILE__, __LINE__, __FUNCTION__, expr); \ - } while(0) - -#define SDEBUG(expr ...) \ - do { \ - short_log_printf (LOG_DEBUG, expr); \ - } while(0) - -#define SINFO(expr ...) \ - do { \ - short_log_printf (LOG_INFO, expr); \ - } while(0) - -#define SWARNING(expr ...) \ - do { \ - short_log_printf (LOG_WARNING, expr); \ - } while(0) - -#define SERROR(expr ...) \ - do { \ - short_log_printf (LOG_ERROR, expr); \ - } while(0) +/* 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_DEBUG(expr ...) \ + if (debug_level >= LOG_LVL_DEBUG) { log_printf_lf (LOG_LVL_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr); } + +#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) + +#define LOG_WARNING(expr ...) \ + log_printf_lf (LOG_LVL_WARNING, __FILE__, __LINE__, __FUNCTION__, expr) + +#define LOG_ERROR(expr ...) \ + log_printf_lf (LOG_LVL_ERROR, __FILE__, __LINE__, __FUNCTION__, expr) + +#define LOG_USER(expr ...) \ + log_printf_lf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr) + +#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 @@ -93,5 +110,9 @@ extern int debug_level; #define ERROR_INVALID_ARGUMENTS (-1) #define ERROR_NO_CONFIG_FILE (-2) #define ERROR_BUF_TOO_SMALL (-3) +/* see "Error:" message 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 /* ERROR_H */ +#endif /* LOG_H */