mirror of
https://github.com/torvalds/linux.git
synced 2024-11-25 05:32:00 +00:00
a4311c274e
While kunit/visibility.h is today not included in any generated kernel documentation, also likely due to the fact that none of the existing comments are correctly recognized as kernel-doc, but once we decide to add this header and fix the tool, there will be: ../include/kunit/visibility.h:61: warning: Function parameter or struct member 'symbol' not described in 'EXPORT_SYMBOL_IF_KUNIT' Signed-off-by: Michal Wajdeczko <michal.wajdeczko@intel.com> Reviewed-by: Rae Moar <rmoar@google.com> Acked-by: David Gow <davidgow@google.com> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
35 lines
1.0 KiB
C
35 lines
1.0 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
/*
|
|
* KUnit API to allow symbols to be conditionally visible during KUnit
|
|
* testing
|
|
*
|
|
* Copyright (C) 2022, Google LLC.
|
|
* Author: Rae Moar <rmoar@google.com>
|
|
*/
|
|
|
|
#ifndef _KUNIT_VISIBILITY_H
|
|
#define _KUNIT_VISIBILITY_H
|
|
|
|
#if IS_ENABLED(CONFIG_KUNIT)
|
|
/**
|
|
* VISIBLE_IF_KUNIT - A macro that sets symbols to be static if
|
|
* CONFIG_KUNIT is not enabled. Otherwise if CONFIG_KUNIT is enabled
|
|
* there is no change to the symbol definition.
|
|
*/
|
|
#define VISIBLE_IF_KUNIT
|
|
/**
|
|
* EXPORT_SYMBOL_IF_KUNIT(symbol) - Exports symbol into
|
|
* EXPORTED_FOR_KUNIT_TESTING namespace only if CONFIG_KUNIT is
|
|
* enabled. Must use MODULE_IMPORT_NS(EXPORTED_FOR_KUNIT_TESTING)
|
|
* in test file in order to use symbols.
|
|
* @symbol: the symbol identifier to export
|
|
*/
|
|
#define EXPORT_SYMBOL_IF_KUNIT(symbol) EXPORT_SYMBOL_NS(symbol, \
|
|
EXPORTED_FOR_KUNIT_TESTING)
|
|
#else
|
|
#define VISIBLE_IF_KUNIT static
|
|
#define EXPORT_SYMBOL_IF_KUNIT(symbol)
|
|
#endif
|
|
|
|
#endif /* _KUNIT_VISIBILITY_H */
|