X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=src%2Fhelper%2Flog.h;h=512bcc5126d5bd9563c52899f0873d90c2d1462d;hb=19f8f58c0d4d9ee618969254a368e4396657b946;hp=15bd3c86236a401f0fdd16e00a858a92f251967d;hpb=1712d7835e0fbba60d578b52b21b95b046805757;p=openocd.git
diff --git a/src/helper/log.h b/src/helper/log.h
index 15bd3c8623..512bcc5126 100644
--- a/src/helper/log.h
+++ b/src/helper/log.h
@@ -19,14 +19,13 @@
* 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 "command.h"
+#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
@@ -47,53 +46,50 @@
* 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, int line,
- const char *function, const char *format, ...)
+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_printf_lf(enum log_levels level, const char *file, int line,
- const char *function, const char *format, ...)
+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)));
-int log_init(struct command_context_s *cmd_ctx);
-int set_log_output(struct command_context_s *cmd_ctx, FILE *output);
+/**
+ * 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_s *cmd_ctx);
+int log_register_commands(struct command_context *cmd_ctx);
void keep_alive(void);
void kept_alive(void);
-void alive_sleep(int ms);
-void busy_sleep(int 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 alive_sleep(uint64_t ms);
+void busy_sleep(uint64_t ms);
-typedef void (*log_callback_fn)(void *priv, const char *file, int line,
+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;
+};
int log_add_callback(log_callback_fn fn, void *priv);
int log_remove_callback(log_callback_fn fn, void *priv);
@@ -108,40 +104,51 @@ 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 ...) \
- ((debug_level >= LOG_LVL_DEBUG) ? log_printf_lf (LOG_LVL_DEBUG, __FILE__, __LINE__, __FUNCTION__, expr) , 0 : 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)
/* 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)
+
-#endif /* LOG_H */
+#endif /* OPENOCD_HELPER_LOG_H */