diff options
| author | Simon Glass <sjg@chromium.org> | 2017-12-28 13:14:23 -0700 |
|---|---|---|
| committer | Simon Glass <sjg@chromium.org> | 2018-02-03 10:09:27 -0700 |
| commit | 3707c6ee0d1f939130a62c945b56045d9a83fafc (patch) | |
| tree | 86b7c70cf64113d77001fed0b2a57396aa3439a2 /include/log.h | |
| parent | 8cb7c04248c9f0c3b79325b82844d79a680ef2eb (diff) | |
log: Add a way to log error-return values
When functions return an error it propagates up the stack to the point
where it is reported. Often the error code provides enough information
about the root cause of the error that this is obvious what went wrong.
However in some cases the error may be hard to trace. For example if a
driver uses several devices to perform an operation, it may not be
obvious which one failed.
Add a log_ret() macro to help with this. This can be used to wrap any
error-return value. The logging system will then output a log record when
the original error is generated, making it easy to trace the call stack
of the error.
This macro can significantly impact code size, so its use is controlled
by a Kconfig option, which is enabled for sandbox.
Signed-off-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'include/log.h')
| -rw-r--r-- | include/log.h | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/include/log.h b/include/log.h index 828919a409..68368d5cf1 100644 --- a/include/log.h +++ b/include/log.h @@ -159,6 +159,17 @@ void __assert_fail(const char *assertion, const char *file, unsigned int line, ({ if (!(x) && _DEBUG) \ __assert_fail(#x, __FILE__, __LINE__, __func__); }) +#ifdef CONFIG_LOG_ERROR_RETURN +#define log_ret(_ret) ({ \ + int __ret = (_ret); \ + if (__ret < 0) \ + log(LOG_CATEGORY, LOGL_ERR, "returning err=%d\n", __ret); \ + __ret; \ + }) +#else +#define log_ret(_ret) (_ret) +#endif + /** * struct log_rec - a single log record * |