diff mbox series

[v3,2/6] kunit: Add macro to conditionally expose declarations to tests

Message ID 20240829181348.1572-3-michal.wajdeczko@intel.com
State New
Headers show
Series kunit: Add macros to help write more complex tests | expand

Commit Message

Michal Wajdeczko Aug. 29, 2024, 6:13 p.m. UTC 
The DECLARE_IF_KUNIT macro will introduces identifiers only if
CONFIG_KUNIT is enabled. Otherwise if CONFIG_KUNIT is not enabled
no identifiers from the param list will be defined.

Signed-off-by: Michal Wajdeczko <michal.wajdeczko@intel.com>
Reviewed-by: Rae Moar <rmoar@google.com>
Reviewed-by: David Gow <davidgow@google.com>
---
Cc: Lucas De Marchi <lucas.demarchi@intel.com>
---
v2: include struct example in macro comment (Lucas)
    reformat kernel-doc for better output (Michal)
---
 include/kunit/visibility.h | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
diff mbox series

Patch

diff --git a/include/kunit/visibility.h b/include/kunit/visibility.h
index 0dfe35feeec6..c1825381adfc 100644
--- a/include/kunit/visibility.h
+++ b/include/kunit/visibility.h
@@ -11,6 +11,25 @@ 
 #define _KUNIT_VISIBILITY_H
 
 #if IS_ENABLED(CONFIG_KUNIT)
+    /**
+     * DECLARE_IF_KUNIT - Conditionally introduce identifiers
+     * @body: identifiers to be introduced conditionally
+     *
+     * This macro introduces identifiers only if CONFIG_KUNIT is enabled.
+     * Otherwise if CONFIG_KUNIT is not enabled no identifiers will be defined.
+     *
+     * .. code-block:: C
+     *
+     *     struct example {
+     *         // @foo: regular data
+     *         int foo;
+     *
+     *         // private: data available only for CONFIG_KUNIT
+     *         DECLARE_IF_KUNIT(int bar);
+     *     };
+     */
+    #define DECLARE_IF_KUNIT(body...)	body
+
     /**
      * VISIBLE_IF_KUNIT - A macro that sets symbols to be static if
      * CONFIG_KUNIT is not enabled. Otherwise if CONFIG_KUNIT is enabled
@@ -26,6 +45,7 @@ 
     #define EXPORT_SYMBOL_IF_KUNIT(symbol) EXPORT_SYMBOL_NS(symbol, \
 	    EXPORTED_FOR_KUNIT_TESTING)
 #else
+    #define DECLARE_IF_KUNIT(body...)
     #define VISIBLE_IF_KUNIT static
     #define EXPORT_SYMBOL_IF_KUNIT(symbol)
 #endif