From: David Marchand <david.marchand@redhat.com>
To: dev@dpdk.org
Cc: thomas@monjalon.net, ferruh.yigit@amd.com,
bruce.richardson@intel.com, stephen@networkplumber.org,
mb@smartsharesystems.com
Subject: [RFC v2 11/14] log: add a per line log helper
Date: Fri, 8 Dec 2023 15:59:45 +0100 [thread overview]
Message-ID: <20231208145950.2184940-12-david.marchand@redhat.com> (raw)
In-Reply-To: <20231208145950.2184940-1-david.marchand@redhat.com>
gcc builtin __builtin_strchr can be used as a static assertion to check
whether passed format strings contain a \n.
This can be useful to detect double \n in log messages.
Signed-off-by: David Marchand <david.marchand@redhat.com>
---
Changes since RFC v1:
- added a check in checkpatches.sh,
---
devtools/checkpatches.sh | 8 ++++++++
lib/log/rte_log.h | 21 +++++++++++++++++++++
2 files changed, 29 insertions(+)
diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
index 10b79ca2bc..10d1bf490b 100755
--- a/devtools/checkpatches.sh
+++ b/devtools/checkpatches.sh
@@ -53,6 +53,14 @@ print_usage () {
check_forbidden_additions() { # <patch>
res=0
+ # refrain from new calls to RTE_LOG
+ awk -v FOLDERS="lib" \
+ -v EXPRESSIONS="RTE_LOG\\\(" \
+ -v RET_ON_FAIL=1 \
+ -v MESSAGE='Prefer RTE_LOG_LINE' \
+ -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
+ "$1" || res=1
+
# refrain from new additions of rte_panic() and rte_exit()
# multiple folders and expressions are separated by spaces
awk -v FOLDERS="lib drivers" \
diff --git a/lib/log/rte_log.h b/lib/log/rte_log.h
index 27fb6129a7..da7e672e81 100644
--- a/lib/log/rte_log.h
+++ b/lib/log/rte_log.h
@@ -17,6 +17,7 @@
extern "C" {
#endif
+#include <assert.h>
#include <stdint.h>
#include <stdio.h>
#include <stdarg.h>
@@ -358,6 +359,26 @@ int rte_vlog(uint32_t level, uint32_t logtype, const char *format, va_list ap)
RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__) : \
0)
+#ifdef RTE_TOOLCHAIN_GCC
+#define RTE_LOG_CHECK_NO_NEWLINE(fmt) \
+ static_assert(!__builtin_strchr(fmt, '\n'), \
+ "This log format string contains a \\n")
+#else
+#define RTE_LOG_CHECK_NO_NEWLINE(...)
+#endif
+
+#define RTE_LOG_LINE(l, t, ...) do { \
+ RTE_LOG_CHECK_NO_NEWLINE(RTE_FMT_HEAD(__VA_ARGS__,)); \
+ RTE_LOG(l, t, RTE_FMT(RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
+ RTE_FMT_TAIL(__VA_ARGS__ ,))); \
+} while (0)
+
+#define RTE_LOG_DP_LINE(l, t, ...) do { \
+ RTE_LOG_CHECK_NO_NEWLINE(RTE_FMT_HEAD(__VA_ARGS__,)); \
+ RTE_LOG_DP(l, t, RTE_FMT(RTE_FMT_HEAD(__VA_ARGS__,) "\n", \
+ RTE_FMT_TAIL(__VA_ARGS__ ,))); \
+} while (0)
+
#define RTE_LOG_REGISTER_IMPL(type, name, level) \
int type; \
RTE_INIT(__##type) \
--
2.43.0
next prev parent reply other threads:[~2023-12-08 15:01 UTC|newest]
Thread overview: 122+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-11-17 13:18 [RFC 0/3] Detect superfluous newline in logs David Marchand
2023-11-17 13:18 ` [RFC 1/3] lib: remove redundant newline from logs David Marchand
2023-11-17 13:18 ` [RFC 2/3] log: add a per line log helper David Marchand
2023-11-17 13:18 ` [RFC 3/3] lib: use per line logging David Marchand
2023-11-17 13:27 ` [RFC 0/3] Detect superfluous newline in logs Bruce Richardson
2023-11-17 13:48 ` David Marchand
2023-11-17 14:11 ` Bruce Richardson
2023-11-17 14:21 ` David Marchand
2023-11-17 13:47 ` Morten Brørup
2023-11-17 14:09 ` David Marchand
2023-11-17 14:17 ` Morten Brørup
2023-12-08 14:59 ` [RFC v2 00/14] " David Marchand
2023-12-08 14:59 ` [RFC v2 01/14] hash: remove some dead code David Marchand
2023-12-08 16:53 ` Stephen Hemminger
2023-12-08 20:46 ` Tyler Retzlaff
2023-12-08 14:59 ` [RFC v2 02/14] regexdev: fix logtype register David Marchand
2023-12-08 16:58 ` Stephen Hemminger
2023-12-08 20:46 ` Tyler Retzlaff
2023-12-14 10:11 ` Ori Kam
2023-12-08 14:59 ` [RFC v2 03/14] lib: use dedicated logtypes David Marchand
2023-12-08 17:00 ` Stephen Hemminger
2023-12-08 20:49 ` Tyler Retzlaff
2023-12-16 9:47 ` Andrew Rybchenko
2023-12-08 14:59 ` [RFC v2 04/14] lib: add newline in logs David Marchand
2023-12-08 17:01 ` Stephen Hemminger
2023-12-11 12:38 ` David Marchand
2023-12-08 20:50 ` Tyler Retzlaff
2023-12-16 9:43 ` Andrew Rybchenko
2023-12-08 14:59 ` [RFC v2 05/14] lib: remove redundant newline from logs David Marchand
2023-12-08 17:02 ` Stephen Hemminger
2023-12-09 7:15 ` fengchengwen
2023-12-11 8:48 ` Mattias Rönnblom
2023-12-08 14:59 ` [RFC v2 06/14] eal/linux: remove log paraphrasing the doc David Marchand
2023-12-08 17:03 ` Stephen Hemminger
2023-12-08 20:54 ` Tyler Retzlaff
2023-12-08 14:59 ` [RFC v2 07/14] bpf: remove log level in internal helper David Marchand
2023-12-08 17:04 ` Stephen Hemminger
2023-12-08 21:02 ` Tyler Retzlaff
2023-12-08 14:59 ` [RFC v2 08/14] lib: simplify multilines log messages David Marchand
2023-12-08 17:05 ` Stephen Hemminger
2023-12-16 9:26 ` Andrew Rybchenko
2023-12-08 21:03 ` Tyler Retzlaff
2023-12-08 14:59 ` [RFC v2 09/14] rcu: introduce a logging helper David Marchand
2023-12-08 17:08 ` Stephen Hemminger
2023-12-08 18:26 ` Honnappa Nagarahalli
2023-12-08 21:27 ` Tyler Retzlaff
2023-12-12 15:00 ` David Marchand
2023-12-12 19:11 ` Tyler Retzlaff
2023-12-18 9:37 ` David Marchand
2023-12-18 19:52 ` Tyler Retzlaff
2023-12-08 14:59 ` [RFC v2 10/14] vhost: improve log for memory dumping configuration David Marchand
2023-12-08 17:14 ` Stephen Hemminger
2023-12-08 14:59 ` David Marchand [this message]
2023-12-08 17:15 ` [RFC v2 11/14] log: add a per line log helper Stephen Hemminger
2023-12-09 7:21 ` fengchengwen
2023-12-08 14:59 ` [RFC v2 12/14] lib: convert to per line logging David Marchand
2023-12-08 17:16 ` Stephen Hemminger
2023-12-11 12:34 ` David Marchand
2023-12-16 9:30 ` Andrew Rybchenko
2023-12-08 14:59 ` [RFC v2 13/14] lib: replace logging helpers David Marchand
2023-12-08 17:18 ` Stephen Hemminger
2023-12-11 12:36 ` David Marchand
2023-12-16 9:42 ` Andrew Rybchenko
2023-12-08 14:59 ` [RFC v2 14/14] lib: use per line logging in helpers David Marchand
2023-12-09 7:19 ` fengchengwen
2023-12-16 9:41 ` Andrew Rybchenko
2023-12-18 9:27 ` [PATCH v3 00/14] Detect superfluous newline in logs David Marchand
2023-12-18 9:27 ` [PATCH v3 01/14] hash: remove some dead code David Marchand
2023-12-18 9:27 ` [PATCH v3 02/14] regexdev: fix logtype register David Marchand
2023-12-18 9:27 ` [PATCH v3 03/14] lib: use dedicated logtypes and macros David Marchand
2023-12-18 9:27 ` [PATCH v3 04/14] lib: add newline in logs David Marchand
2023-12-18 9:27 ` [PATCH v3 05/14] lib: remove redundant newline from logs David Marchand
2023-12-18 9:27 ` [PATCH v3 06/14] eal/linux: remove log paraphrasing the doc David Marchand
2023-12-18 9:27 ` [PATCH v3 07/14] bpf: remove log level in internal helper David Marchand
2023-12-18 9:27 ` [PATCH v3 08/14] lib: simplify multilines log messages David Marchand
2023-12-18 10:05 ` Andrew Rybchenko
2023-12-18 9:27 ` [PATCH v3 09/14] rcu: introduce a logging helper David Marchand
2023-12-18 9:27 ` [PATCH v3 10/14] vhost: improve log for memory dumping configuration David Marchand
2023-12-18 9:27 ` [PATCH v3 11/14] log: add a per line log helper David Marchand
2023-12-18 9:27 ` [PATCH v3 12/14] lib: convert to per line logging David Marchand
2023-12-18 9:27 ` [PATCH v3 13/14] lib: replace logging helpers David Marchand
2023-12-18 9:27 ` [PATCH v3 14/14] lib: use per line logging in helpers David Marchand
2023-12-18 14:37 ` [PATCH v4 00/14] Detect superfluous newline in logs David Marchand
2023-12-18 14:37 ` [PATCH v4 01/14] hash: remove some dead code David Marchand
2023-12-18 14:37 ` [PATCH v4 02/14] regexdev: fix logtype register David Marchand
2023-12-18 16:46 ` Stephen Hemminger
2023-12-18 14:37 ` [PATCH v4 03/14] lib: use dedicated logtypes and macros David Marchand
2023-12-18 14:37 ` [PATCH v4 04/14] lib: add newline in logs David Marchand
2023-12-18 14:37 ` [PATCH v4 05/14] lib: remove redundant newline from logs David Marchand
2023-12-18 14:37 ` [PATCH v4 06/14] eal/linux: remove log paraphrasing the doc David Marchand
2023-12-18 14:37 ` [PATCH v4 07/14] bpf: remove log level in internal helper David Marchand
2023-12-18 14:37 ` [PATCH v4 08/14] lib: simplify multilines log messages David Marchand
2023-12-18 14:37 ` [PATCH v4 09/14] rcu: introduce a logging helper David Marchand
2023-12-18 14:37 ` [PATCH v4 10/14] vhost: improve log for memory dumping configuration David Marchand
2023-12-18 14:38 ` [PATCH v4 11/14] log: add a per line log helper David Marchand
2023-12-19 15:45 ` Thomas Monjalon
2023-12-19 17:16 ` Stephen Hemminger
2023-12-20 8:26 ` David Marchand
2023-12-18 14:38 ` [PATCH v4 12/14] lib: convert to per line logging David Marchand
2023-12-20 13:46 ` Thomas Monjalon
2023-12-20 14:00 ` David Marchand
2023-12-18 14:38 ` [PATCH v4 13/14] lib: replace logging helpers David Marchand
2023-12-18 14:38 ` [PATCH v4 14/14] lib: use per line logging in helpers David Marchand
2023-12-20 15:35 ` [PATCH v5 00/13] Detect superfluous newline in logs David Marchand
2023-12-20 15:35 ` [PATCH v5 01/13] hash: remove some dead code David Marchand
2023-12-21 5:58 ` Ruifeng Wang
2023-12-21 6:26 ` Ruifeng Wang
2023-12-20 15:35 ` [PATCH v5 02/13] regexdev: fix logtype register David Marchand
2023-12-20 15:35 ` [PATCH v5 03/13] lib: use dedicated logtypes and macros David Marchand
2023-12-20 15:35 ` [PATCH v5 04/13] lib: add newline in logs David Marchand
2023-12-20 15:35 ` [PATCH v5 05/13] lib: remove redundant newline from logs David Marchand
2023-12-20 15:35 ` [PATCH v5 06/13] eal/linux: remove log paraphrasing the doc David Marchand
2023-12-20 15:36 ` [PATCH v5 07/13] bpf: remove log level in internal helper David Marchand
2023-12-20 15:36 ` [PATCH v5 08/13] lib: simplify multilines log messages David Marchand
2023-12-20 15:36 ` [PATCH v5 09/13] lib: add more logging helpers David Marchand
2023-12-20 15:36 ` [PATCH v5 10/13] vhost: improve log for memory dumping configuration David Marchand
2023-12-20 15:36 ` [PATCH v5 11/13] log: add a per line log helper David Marchand
2023-12-20 15:42 ` David Marchand
2023-12-20 15:36 ` [PATCH v5 12/13] lib: replace logging helpers David Marchand
2023-12-20 15:36 ` [PATCH v5 13/13] lib: use per line logging in helpers David Marchand
2023-12-21 9:31 ` [PATCH v5 00/13] Detect superfluous newline in logs David Marchand
2023-12-21 16:32 ` Stephen Hemminger
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20231208145950.2184940-12-david.marchand@redhat.com \
--to=david.marchand@redhat.com \
--cc=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@amd.com \
--cc=mb@smartsharesystems.com \
--cc=stephen@networkplumber.org \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).