Files

173 lines
4.6 KiB
C++

/**
* @file include/ActivMiddleware/Optimizations.h
*
* @brief Header file for various optimizations.
*/
#if (!defined ACTIV_OPTIMIZATIONS_H)
#define ACTIV_OPTIMIZATIONS_H
#if (defined ACTIV_PROCESSOR_X86) || (defined ACTIV_PROCESSOR_X86_64)
#if (defined ACTIV_COMPILER_VISUAL_C) || ((defined ACTIV_COMPILER_GCC) && !(defined ACTIV_PLATFORM_SOLARIS))
#include <xmmintrin.h>
#define ACTIV_USE_MM_INTRINSICS
#endif // (defined ACTIV_COMPILER_VISUAL_C) || (defined ACTIV_COMPILER_GCC)
#endif // (defined ACTIV_PROCESSOR_X86) || (defined ACTIV_PROCESSOR_X86_64)
//! Activ namespace.
namespace Activ
{
#if (defined ACTIV_USE_MM_INTRINSICS)
#if (defined ACTIV_COMPILER_VISUAL_C) || (defined ACTIV_COMPILER_CLANG) || (defined ACTIV_COMPILER_INTEL)
typedef int _mm_hint;
#endif
// ---------------------------------------------------------------------------------------------------------------------------------
/**
* @brief Prefetch types.
*
* The actual behaviour is processor-dependent. Approximate definitions follow.
*/
enum PrefetchType
{
PREFETCH_TYPE_LEVEL_1 = _MM_HINT_T0, ///< Fetch into l1 data cache.
PREFETCH_TYPE_LEVEL_2 = _MM_HINT_T1, ///< Fetch into l2 cache.
PREFETCH_TYPE_LEVEL_3 = _MM_HINT_T2, ///< Fetch into l3 cache.
PREFETCH_TYPE_LEVEL_AVOID_CACHE = _MM_HINT_NTA ///< Avoid loading into cache.
};
// ---------------------------------------------------------------------------------------------------------------------------------
// ---------------------------------------------------------------------------------------------------------------------------------
/**
* @brief Prefetch memory.
*
* Template parameter is the prefetch type. VC++ requires _mm_prefetch takes a compile-time constant parameter,
* hence the templatizing.
*
* @param p address to prefetch.
*/
template<PrefetchType prefetchType>
inline void PrefetchMemory(const void *p)
{
#if (defined NDEBUG)
_mm_prefetch(reinterpret_cast<const char *>(p), static_cast<_mm_hint>(prefetchType));
#endif
}
#undef ACTIV_USE_MM_INTRINSICS
// ---------------------------------------------------------------------------------------------------------------------------------
#else
/**
* @brief Dummy prefetch types.
*/
enum PrefetchType
{
PREFETCH_TYPE_LEVEL_1,
PREFETCH_TYPE_LEVEL_2,
PREFETCH_TYPE_LEVEL_3,
PREFETCH_TYPE_LEVEL_AVOID_CACHE
};
// ---------------------------------------------------------------------------------------------------------------------------------
// ---------------------------------------------------------------------------------------------------------------------------------
/**
* @brief Dummy prefetch memory.
*
* @param p
*/
template<PrefetchType prefetchType>
inline void PrefetchMemory(const void *p)
{
// Do nothing.
}
#endif
// ---------------------------------------------------------------------------------------------------------------------------------
#if (!defined ACTIV_LIKELY_SWITCH_CASE)
/**
* @brief Dummy likely switch case hint.
*
* @param expr
* @param expected
*
* @return expr
*/
#define ACTIV_LIKELY_SWITCH_CASE(expr, expected) (expr)
#endif // (!defined ACTIV_LIKELY_SWITCH_CASE)
// ---------------------------------------------------------------------------------------------------------------------------------
#if (!defined ACTIV_LIKELY)
/**
* @brief Dummy likely hint.
*
* @param expr
*/
#define ACTIV_LIKELY(expr) (expr)
#endif // (!defined ACTIV_LIKELY)
// ---------------------------------------------------------------------------------------------------------------------------------
#if (!defined ACTIV_UNLIKELY)
/**
* @brief Dummy unlikely hint.
*
* @param expr
*/
#define ACTIV_UNLIKELY(expr) (expr)
#endif // (!defined ACTIV_UNLIKELY)
// ---------------------------------------------------------------------------------------------------------------------------------
#if (!defined ACTIV_HOT)
//! Dummy hot attribute.
#define ACTIV_HOT
#endif // (!defined ACTIV_HOT)
// ---------------------------------------------------------------------------------------------------------------------------------
#if (!defined ACTIV_COLD)
//! Dummy cold attribute.
#define ACTIV_COLD
#endif // (!defined ACTIV_COLD)
// ---------------------------------------------------------------------------------------------------------------------------------
/**
* @brief Macro to use for default switch cases that cannot be reached.
*/
#if (defined ACTIV_COMPILER_VISUAL_C) && (defined NDEBUG)
#define ACTIV_NO_DEFAULT __assume(false)
#else
#define ACTIV_NO_DEFAULT assert(false)
#endif
} // namespace Activ
#endif // (!defined ACTIV_OPTIMIZATIONS_H)