git.sur5r.net Git - openocd/blob - src/helper/log.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
   6  *   oyvind.harboe@zylin.com                                               *
   7  *                                                                         *
   8  *   Copyright (C) 2008 by Spencer Oliver                                  *
   9  *   spen@spen-soft.co.uk                                                  *
  10  *                                                                         *
  11  *   This program is free software; you can redistribute it and/or modify  *
  12  *   it under the terms of the GNU General Public License as published by  *
  13  *   the Free Software Foundation; either version 2 of the License, or     *
  14  *   (at your option) any later version.                                   *
  15  *                                                                         *
  16  *   This program is distributed in the hope that it will be useful,       *
  17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  19  *   GNU General Public License for more details.                          *
  20  *                                                                         *
  21  *   You should have received a copy of the GNU General Public License     *
  22  *   along with this program; if not, write to the                         *
  23  *   Free Software Foundation, Inc.,                                       *
  24  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  25  ***************************************************************************/
  26 #ifndef ERROR_H
  27 #define ERROR_H
  28
  29 #include "replacements.h"
  30 #include "command.h"
  31
  32 /* logging priorities
  33  * LOG_LVL_SILENT - turn off all output. In lieu of try+catch this can be used as a
  34  *                  feeble ersatz.
  35  * LOG_LVL_USER - user messages. Could be anything from information
  36  *                to progress messags. These messages do not represent
  37  *                incorrect or unexpected behaviour, just normal execution.
  38  * LOG_LVL_ERROR - fatal errors, that are likely to cause program abort
  39  * LOG_LVL_WARNING - non-fatal errors, that may be resolved later
  40  * LOG_LVL_INFO - state information, etc.
  41  * LOG_LVL_DEBUG - debug statements, execution trace
  42  */
  43 enum log_levels
  44 {
  45         LOG_LVL_SILENT = -3,
  46         LOG_LVL_OUTPUT = -2,
  47         LOG_LVL_USER = -1,
  48         LOG_LVL_ERROR = 0,
  49         LOG_LVL_WARNING = 1,
  50         LOG_LVL_INFO = 2,
  51         LOG_LVL_DEBUG = 3
  52 };
  53
  54 extern void log_printf(enum log_levels level, const char *file, int line,
  55         const char *function, const char *format, ...)
  56 __attribute__ ((format (printf, 5, 6)));
  57 extern void log_printf_lf(enum log_levels level, const char *file, int line,
  58         const char *function, const char *format, ...)
  59 __attribute__ ((format (printf, 5, 6)));
  60 extern int log_register_commands(struct command_context_s *cmd_ctx);
  61 extern int log_init(struct command_context_s *cmd_ctx);
  62 extern int set_log_output(struct command_context_s *cmd_ctx, FILE *output);
  63 extern void keep_alive(void);
  64 extern void kept_alive(void);
  65 extern void alive_sleep(int ms);
  66 extern void busy_sleep(int ms);
  67
  68 typedef void (*log_callback_fn)(void *priv, const char *file, int line,
  69                 const char *function, const char *string);
  70
  71 typedef struct log_callback_s
  72 {
  73         log_callback_fn fn;
  74         void *priv;
  75         struct log_callback_s *next;
  76 } log_callback_t;
  77
  78 extern int log_add_callback(log_callback_fn fn, void *priv);
  79 extern int log_remove_callback(log_callback_fn fn, void *priv);
  80
  81 char *alloc_vprintf(const char *fmt, va_list ap);
  82 char *alloc_printf(const char *fmt, ...);
  83
  84 extern int debug_level;
  85
  86 /* Avoid fn call and building parameter list if we're not outputting the information.
  87  * Matters on feeble CPUs for DEBUG/INFO statements that are involved frequently */
  88
  89 #define LOG_LEVEL_IS( FOO )  ((debug_level) >= (FOO))
  90
  91 #define LOG_DEBUG(expr ...) \
  92                 ((debug_level >= LOG_LVL_DEBUG) ? log_printf_lf (LOG_LVL_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr) , 0 : 0)
  93
  94 #define LOG_INFO(expr ...) \
  95                 log_printf_lf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
  96
  97 #define LOG_INFO_N(expr ...) \
  98                 log_printf (LOG_LVL_INFO, __FILE__, __LINE__, __FUNCTION__, expr)
  99
 100 #define LOG_WARNING(expr ...) \
 101                 log_printf_lf (LOG_LVL_WARNING, __FILE__, __LINE__, __FUNCTION__, expr)
 102
 103 #define LOG_ERROR(expr ...) \
 104                 log_printf_lf (LOG_LVL_ERROR, __FILE__, __LINE__, __FUNCTION__, expr)
 105
 106 #define LOG_USER(expr ...) \
 107                 log_printf_lf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
 108
 109 #define LOG_USER_N(expr ...) \
 110                 log_printf (LOG_LVL_USER, __FILE__, __LINE__, __FUNCTION__, expr)
 111
 112 #define LOG_OUTPUT(expr ...) \
 113                 log_printf (LOG_LVL_OUTPUT, __FILE__, __LINE__, __FUNCTION__, expr)
 114
 115 /* general failures
 116  * error codes < 100
 117  */
 118 #define ERROR_OK                                        (0)
 119 #define ERROR_INVALID_ARGUMENTS         ERROR_COMMAND_SYNTAX_ERROR
 120 #define ERROR_NO_CONFIG_FILE            (-2)
 121 #define ERROR_BUF_TOO_SMALL                     (-3)
 122 /* see "Error:" log entry for meaningful message to the user. The caller should
 123  * make no assumptions about what went wrong and try to handle the problem.
 124  */
 125 #define ERROR_FAIL                                      (-4)
 126
 127 #endif /* LOG_H */