Skip to contentSkip to conversation

log: Allow LOG_DEBUG to always enable log output

PATCH Superseded Simon Glass 2 participants 4 messages Sep 12, 2020 – Oct 12, 2020 Library code

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/2 log: Allow LOG_DEBUG to always enable log output

At present if CONFIG_LOG enabled, putting LOG_DEBUG at the top of a file (before log.h inclusion) causes _log() to be executed for every log() call, regardless of the build- or run-time logging level.

However there is no guarantee that the log record will actually be displayed. If the current log level is lower than LOGL_DEBUG then it will not be.

Add a way to signal that the log record should always be displayed and update log_passes_filters() to handle this.

With the new behaviour, log_debug() will always log if LOG_DEBUG is enabled.

Move log_test_syslog_nodebug() into its own file since it cannot be made to work where it is, with LOG_DEBUG defined.

---

Changes in v2:
- Move log_test_syslog_nodebug() into its own file
- Add casts for the enum to keep clang happy

 common/log.c                  |  6 ++-
 doc/README.log                |  7 +---
 include/log.h                 | 18 +++++++--
 test/log/Makefile             |  1 +
 test/log/syslog_test.c        | 76 +----------------------------------
 test/log/syslog_test.h        | 50 +++++++++++++++++++++++
 test/log/syslog_test_ndebug.c | 55 +++++++++++++++++++++++++
 7 files changed, 129 insertions(+), 84 deletions(-)
 create mode 100644 test/log/syslog_test.h
 create mode 100644 test/log/syslog_test_ndebug.c
common/log.c +5 -1
index 734d26de4af..f44f15743ff 100644
@@ -157,6 +157,9 @@ static bool log_passes_filters(struct log_device *ldev, struct log_rec *rec)
 {
 	struct log_filter *filt;
 
+	if (rec->force_debug)
+		return true;
+
 	/* If there are no filters, filter on the default log level */
 	if (list_empty(&ldev->filter_head)) {
 		if (rec->level > gd->default_log_level)
@@ -208,7 +211,8 @@ int _log(enum log_category_t cat, enum log_level_t level, const char *file,
 	va_list args;
 
 	rec.cat = cat;
-	rec.level = level;
+	rec.level = level & LOGL_LEVEL_MASK;
+	rec.force_debug = level & LOGL_FORCE_DEBUG;
 	rec.file = file;
 	rec.line = line;
 	rec.func = func;
doc/README.log +2 -5
index ba838824a99..a313399fc93 100644
@@ -78,11 +78,8 @@ Sometimes it is useful to turn on logging just in one file. You can use this:
    #define LOG_DEBUG
 
 to enable building in of all logging statements in a single file. Put it at
-the top of the file, before any #includes.
-
-To actually get U-Boot to output this you need to also set the default logging
-level - e.g. set CONFIG_LOG_DEFAULT_LEVEL to 7 (LOGL_DEBUG) or more. Otherwise
-debug output is suppressed and will not be generated.
+the top of the file, before any #includes. This overrides any log-level setting
+in U-Boot, including CONFIG_LOG_DEFAULT_LEVEL, but just for that file.
 
 
 Convenience functions
include/log.h +14 -4
index 2859ce1f2e7..86c8d7be09d 100644
@@ -33,6 +33,9 @@ enum log_level_t {
 	LOGL_COUNT,
 	LOGL_NONE,
 
+	LOGL_LEVEL_MASK = 0xf,	/* Mask for valid log levels */
+	LOGL_FORCE_DEBUG = 0x10, /* Mask to force output due to LOG_DEBUG */
+
 	LOGL_FIRST = LOGL_EMERG,
 	LOGL_MAX = LOGL_DEBUG_IO,
 };
@@ -133,7 +136,7 @@ static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
 
 #if CONFIG_IS_ENABLED(LOG)
 #ifdef LOG_DEBUG
-#define _LOG_DEBUG	1
+#define _LOG_DEBUG	LOGL_FORCE_DEBUG
 #else
 #define _LOG_DEBUG	0
 #endif
@@ -141,9 +144,11 @@ static inline int _log_nop(enum log_category_t cat, enum log_level_t level,
 /* Emit a log record if the level is less that the maximum */
 #define log(_cat, _level, _fmt, _args...) ({ \
 	int _l = _level; \
-	if (CONFIG_IS_ENABLED(LOG) && (_l <= _LOG_MAX_LEVEL || _LOG_DEBUG)) \
-		_log((enum log_category_t)(_cat), _l, __FILE__, __LINE__, \
-		      __func__, \
+	if (CONFIG_IS_ENABLED(LOG) && \
+	    (_LOG_DEBUG != 0 || _l <= _LOG_MAX_LEVEL)) \
+		_log((enum log_category_t)(_cat), \
+		     (enum log_level_t)(_l | _LOG_DEBUG), __FILE__, \
+		     __LINE__, __func__, \
 		      pr_fmt(_fmt), ##_args); \
 	})
 #else
@@ -279,8 +284,12 @@ void __assert_fail(const char *assertion, const char *file, unsigned int line,
  * Memebers marked as 'allocated' are allocated (e.g. via strdup()) by the log
  * system.
  *
+ * TODO([email protected]): Compress this struct down a bit to reduce space, e.g.
+ * a single u32 for cat, level, line and force_debug
+ *
  * @cat: Category, representing a uclass or part of U-Boot
  * @level: Severity level, less severe is higher
+ * @force_debug: Force output of debug
  * @file: Name of file where the log record was generated (not allocated)
  * @line: Line number where the log record was generated
  * @func: Function where the log record was generated (not allocated)
@@ -289,6 +298,7 @@ void __assert_fail(const char *assertion, const char *file, unsigned int line,
 struct log_rec {
 	enum log_category_t cat;
 	enum log_level_t level;
+	bool force_debug;
 	const char *file;
 	int line;
 	const char *func;
test/log/Makefile +1 -0
index 4c92550f6e3..52e2f7b41c3 100644
@@ -10,6 +10,7 @@ obj-y += test-main.o
 
 ifdef CONFIG_SANDBOX
 obj-$(CONFIG_LOG_SYSLOG) += syslog_test.o
+obj-$(CONFIG_LOG_SYSLOG) += syslog_test_ndebug.o
 endif
 
 ifndef CONFIG_LOG
test/log/syslog_test.c +2 -74

88 lines not on this page · raw message

test/log/syslog_test.h new file +50 -0

50 lines not on this page · raw message

test/log/syslog_test_ndebug.c new file +55 -0

55 lines not on this page · raw message

Signature · 1 line
2.28.0.618.gf4bc123cb7-goog
#1 lore raw

PATCH v2 2/2 lib: Allow hexdump to be used in SPL

It is sometimes useful to output hex dumps in SPL. Add a config option to allow this.

---

Changes in v2:
- Leave the Makefile alone as the logic is in the C file

 lib/Kconfig | 8 ++++++++
 1 file changed, 8 insertions(+)
lib/Kconfig +8 -0
index 8efb154f734..37aae73a266 100644
@@ -542,6 +542,14 @@ config HEXDUMP
 	help
 	  This enables functions for printing dumps of binary data.
 
+config SPL_HEXDUMP
+	bool "Enable hexdump in SPL"
+	depends on HEXDUMP
+	default y
+	help
+	  This enables functions for printing dumps of binary data in
+	  SPL.
+
 config OF_LIBFDT
 	bool "Enable the FDT library"
 	default y if OF_CONTROL
Signature · 1 line
2.28.0.618.gf4bc123cb7-goog
#2 lore raw

PATCH v2 2/2 lib: Allow hexdump to be used in SPL

Quoted 5 lines · Simon Glass

It is sometimes useful to output hex dumps in SPL. Add a config option to allow this.

Applied to u-boot/master, thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20201011/357d2dc2/attachment.sig>
#3 lore raw

PATCH v2 1/2 log: Allow LOG_DEBUG to always enable log output

In reply to Simon Glass
Quoted 11 lines · Simon Glass

At present if CONFIG_LOG enabled, putting LOG_DEBUG at the top of a file (before log.h inclusion) causes _log() to be executed for every log() call, regardless of the build- or run-time logging level.

However there is no guarantee that the log record will actually be displayed. If the current log level is lower than LOGL_DEBUG then it will not be.

Add a way to signal that the log record should always be displayed and update log_passes_filters() to handle this.

Quoted 7 lines

With the new behaviour, log_debug() will always log if LOG_DEBUG is enabled.

Move log_test_syslog_nodebug() into its own file since it cannot be made to work where it is, with LOG_DEBUG defined.

Applied to u-boot/master, thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20201011/6b1c9588/attachment.sig>