From: Donatas Abraitis <donatas.abraitis@gmail.com>
Date: Mon, 27 Sep 2021 12:20:51 +0000 (+0300)
Subject: tools: Add coccinelle script to catch \n or \r at the end of zlog_*
X-Git-Tag: base_8.1~17^2
X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=refs%2Fpull%2F9677%2Fhead;p=mirror%2Ffrr.git

tools: Add coccinelle script to catch \n or \r at the end of zlog_*

Signed-off-by: Donatas Abraitis <donatas.abraitis@gmail.com>
---

diff --git a/tools/coccinelle/zlog_no_newline.cocci b/tools/coccinelle/zlog_no_newline.cocci
new file mode 100644
index 0000000000..20cf9d2c78
--- /dev/null
+++ b/tools/coccinelle/zlog_no_newline.cocci
@@ -0,0 +1,20 @@
+// zlog_* should not have \n or \r at the end usually.
+// spatch --sp-file tools/coccinelle/zlog_no_newline.cocci --macro-file tools/cocci.h ./ 2>/dev/null
+
+@r@
+expression fmt;
+identifier func =~ "zlog_";
+position p;
+@@
+(
+  func(fmt)@p
+|
+  func(fmt, ...)@p
+)
+
+@script:python@
+fmt << r.fmt;
+p << r.p;
+@@
+if "\\n" in str(fmt) or "\\r" in str(fmt):
+    print("Newline in logging function detected %s:%s:%s:%s" % (p[0].file, p[0].line, p[0].column, fmt))