[v3,08/11] eal: expand most macros to empty when using msvc
Checks
Commit Message
For now expand a lot of common rte macros empty. The catch here is we
need to test that most of the macros do what they should but at the same
time they are blocking work needed to bootstrap of the unit tests.
Later we will return and provide (where possible) expansions that work
correctly for msvc and where not possible provide some alternate macros
to achieve the same outcome.
Signed-off-by: Tyler Retzlaff <roretzla@linux.microsoft.com>
---
lib/eal/include/rte_branch_prediction.h | 8 ++++++++
lib/eal/include/rte_common.h | 33 +++++++++++++++++++++++++++++++++
lib/eal/include/rte_compat.h | 20 ++++++++++++++++++++
3 files changed, 61 insertions(+)
Comments
On Wed, 5 Apr 2023 17:45:16 -0700
Tyler Retzlaff <roretzla@linux.microsoft.com> wrote:
> For now expand a lot of common rte macros empty. The catch here is we
> need to test that most of the macros do what they should but at the same
> time they are blocking work needed to bootstrap of the unit tests.
>
> Later we will return and provide (where possible) expansions that work
> correctly for msvc and where not possible provide some alternate macros
> to achieve the same outcome.
>
> Signed-off-by: Tyler Retzlaff <roretzla@linux.microsoft.com>
Ok, but doesn't SAL have definitions for most of these?
On Wed, Apr 05, 2023 at 07:25:45PM -0700, Stephen Hemminger wrote:
> On Wed, 5 Apr 2023 17:45:16 -0700
> Tyler Retzlaff <roretzla@linux.microsoft.com> wrote:
>
> > For now expand a lot of common rte macros empty. The catch here is we
> > need to test that most of the macros do what they should but at the same
> > time they are blocking work needed to bootstrap of the unit tests.
> >
> > Later we will return and provide (where possible) expansions that work
> > correctly for msvc and where not possible provide some alternate macros
> > to achieve the same outcome.
> >
> > Signed-off-by: Tyler Retzlaff <roretzla@linux.microsoft.com>
>
> Ok, but doesn't SAL have definitions for most of these?
SAL could be used too, but i was considering that more as an integration
with David's recent clang annotation additions. SAL is a broader topic
since to be useful it would need to leverage tooling.
depending on the macros some will come from existing msvc e.g. __declspec
some will come from standard C e.g. _Noreturn
many may not be critical for correct behavior but when used can decrease
misuse or increase performance through better codegen. once we have
things functioning correctly there will naturally be improvements in
both areas that follow.
@@ -25,7 +25,11 @@
*
*/
#ifndef likely
+#ifndef RTE_TOOLCHAIN_MSVC
#define likely(x) __builtin_expect(!!(x), 1)
+#else
+#define likely(x) (x)
+#endif
#endif /* likely */
/**
@@ -39,7 +43,11 @@
*
*/
#ifndef unlikely
+#ifndef RTE_TOOLCHAIN_MSVC
#define unlikely(x) __builtin_expect(!!(x), 0)
+#else
+#define unlikely(x) (x)
+#endif
#endif /* unlikely */
#ifdef __cplusplus
@@ -65,7 +65,11 @@
/**
* Force alignment
*/
+#ifndef RTE_TOOLCHAIN_MSVC
#define __rte_aligned(a) __attribute__((__aligned__(a)))
+#else
+#define __rte_aligned(a)
+#endif
#ifdef RTE_ARCH_STRICT_ALIGN
typedef uint64_t unaligned_uint64_t __rte_aligned(1);
@@ -88,8 +92,13 @@
#define __rte_may_alias __attribute__((__may_alias__))
/******* Macro to mark functions and fields scheduled for removal *****/
+#ifndef RTE_TOOLCHAIN_MSVC
#define __rte_deprecated __attribute__((__deprecated__))
#define __rte_deprecated_msg(msg) __attribute__((__deprecated__(msg)))
+#else
+#define __rte_deprecated
+#define __rte_deprecated_msg(msg)
+#endif
/**
* Macro to mark macros and defines scheduled for removal
@@ -117,7 +126,11 @@
/**
* short definition to mark a function parameter unused
*/
+#ifndef RTE_TOOLCHAIN_MSVC
#define __rte_unused __attribute__((__unused__))
+#else
+#define __rte_unused
+#endif
/**
* Mark pointer as restricted with regard to pointer aliasing.
@@ -141,6 +154,7 @@
* even if the underlying stdio implementation is ANSI-compliant,
* so this must be overridden.
*/
+#ifndef RTE_TOOLCHAIN_MSVC
#if RTE_CC_IS_GNU
#define __rte_format_printf(format_index, first_arg) \
__attribute__((format(gnu_printf, format_index, first_arg)))
@@ -148,6 +162,9 @@
#define __rte_format_printf(format_index, first_arg) \
__attribute__((format(printf, format_index, first_arg)))
#endif
+#else
+#define __rte_format_printf(format_index, first_arg)
+#endif
/**
* Tells compiler that the function returns a value that points to
@@ -222,7 +239,11 @@ static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void)
/**
* Hint never returning function
*/
+#ifndef RTE_TOOLCHAIN_MSVC
#define __rte_noreturn __attribute__((noreturn))
+#else
+#define __rte_noreturn
+#endif
/**
* Issue a warning in case the function's return value is ignored.
@@ -247,12 +268,20 @@ static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void)
* }
* @endcode
*/
+#ifndef RTE_TOOLCHAIN_MSVC
#define __rte_warn_unused_result __attribute__((warn_unused_result))
+#else
+#define __rte_warn_unused_result
+#endif
/**
* Force a function to be inlined
*/
+#ifndef RTE_TOOLCHAIN_MSVC
#define __rte_always_inline inline __attribute__((always_inline))
+#else
+#define __rte_always_inline
+#endif
/**
* Force a function to be noinlined
@@ -437,7 +466,11 @@ static void __attribute__((destructor(RTE_PRIO(prio)), used)) func(void)
#define RTE_CACHE_LINE_MIN_SIZE 64
/** Force alignment to cache line. */
+#ifndef RTE_TOOLCHAIN_MSVC
#define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE)
+#else
+#define __rte_cache_aligned
+#endif
/** Force minimum cache line alignment. */
#define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE)
@@ -12,14 +12,22 @@
#ifndef ALLOW_EXPERIMENTAL_API
+#ifndef RTE_TOOLCHAIN_MSVC
#define __rte_experimental \
__attribute__((deprecated("Symbol is not yet part of stable ABI"), \
section(".text.experimental")))
+#else
+#define __rte_experimental
+#endif
#else
+#ifndef RTE_TOOLCHAIN_MSVC
#define __rte_experimental \
__attribute__((section(".text.experimental")))
+#else
+#define __rte_experimental
+#endif
#endif
@@ -30,23 +38,35 @@
#if !defined ALLOW_INTERNAL_API && __has_attribute(error) /* For GCC */
+#ifndef RTE_TOOLCHAIN_MSVC
#define __rte_internal \
__attribute__((error("Symbol is not public ABI"), \
section(".text.internal")))
+#else
+#define __rte_internal
+#endif
#elif !defined ALLOW_INTERNAL_API && __has_attribute(diagnose_if) /* For clang */
+#ifndef RTE_TOOLCHAIN_MSVC
#define __rte_internal \
_Pragma("GCC diagnostic push") \
_Pragma("GCC diagnostic ignored \"-Wgcc-compat\"") \
__attribute__((diagnose_if(1, "Symbol is not public ABI", "error"), \
section(".text.internal"))) \
_Pragma("GCC diagnostic pop")
+#else
+#define __rte_internal
+#endif
#else
+#ifndef RTE_TOOLCHAIN_MSVC
#define __rte_internal \
__attribute__((section(".text.internal")))
+#else
+#define __rte_internal
+#endif
#endif