linux-kernel - [PATCH] Documentation/CodingStyle: Mention multi-line macros using expressions

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <alpine.DEB.2.02.1207111329280.3642@oneiric>
Date:	Wed, 11 Jul 2012 13:32:27 -0400 (EDT)
From:	"Robert P. J. Day" <rpjday@...shcourse.ca>
To:	Linux Kernel Mailing List <linux-kernel@...r.kernel.org>
Subject: [PATCH] Documentation/CodingStyle: Mention multi-line macros using
 expressions


Since defining multi-line macros using statements and declarations in
expressions is fairly common in the kernel, add this to CodingStyle.

Signed-off-by: Robert P. J. Day <rpjday@...shcourse.ca>

---
diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
index cb9258b..7eb0734 100644
--- a/Documentation/CodingStyle
+++ b/Documentation/CodingStyle
@@ -600,7 +600,8 @@ may be named in lower case.

 Generally, inline functions are preferable to macros resembling functions.

-Macros with multiple statements should be enclosed in a do - while block:
+Macros with multiple statements can be defined in one of two ways.  The
+earlier technique enclosed the macro in a do - while block, as in:

 #define macrofun(a, b, c) 			\
 	do {					\
@@ -608,6 +609,17 @@ Macros with multiple statements should be enclosed in a do - while block:
 			do_this(b, c);		\
 	} while (0)

+A newer technique is to use the GCC extension of being able to place
+statements and declarations in an expression, as with this example from
+the <linux/kernel.h> header file:
+
+#define roundup(x, y) (				\
+{						\
+        const typeof(y) __y = y;		\
+        (((x) + (__y - 1)) / __y) * __y;	\
+}						\
+)
+
 Things to avoid when using macros:

 1) macros that affect control flow:


-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/