platform-intrinsics.h File Reference

User mode Cross platform APIs for intrinsic functions (x86 instructions). More...

Go to the source code of this file.

Functions
VOID	CpuCpuId (INT32 *CpuInfo, INT32 FunctionId)
	Execute CPUID.
VOID	CpuCpuIdEx (INT32 *CpuInfo, INT32 FunctionId, INT32 SubFunctionId)
	Execute CPUID with sub-leaf.
UINT64	CpuReadTsc (VOID)
	Read Time-Stamp Counter.
UINT64	CpuReadTscp (UINT32 *Aux)
	Read Time-Stamp Counter and Processor ID.
VOID	CpuPause (VOID)
	Execute PAUSE (spin-wait hint).
INT64	CpuInterlockedExchange64 (INT64 volatile *Target, INT64 Value)
	Atomic 64-bit exchange.
INT64	CpuInterlockedExchangeAdd64 (INT64 volatile *Addend, INT64 Value)
	Atomic 64-bit exchange-add.
INT64	CpuInterlockedIncrement64 (INT64 volatile *Addend)
	Atomic 64-bit increment.
INT64	CpuInterlockedDecrement64 (INT64 volatile *Addend)
	Atomic 64-bit decrement.
INT64	CpuInterlockedCompareExchange64 (INT64 volatile *Destination, INT64 ExChange, INT64 Comparand)
	Atomic 64-bit compare-exchange.
UCHAR	CpuInterlockedBitTestAndSet (volatile LONG *Base, LONG Bit)

Detailed Description

User mode Cross platform APIs for intrinsic functions (x86 instructions).

Author

Sina Karvandi (sina@.nosp@m.hype.nosp@m.rdbg..nosp@m.org)

Version

0.19

Date

2026-05-06

Copyright

This project is released under the GNU Public License v3.

Function Documentation

CpuCpuId()

VOID CpuCpuId ( INT32 * CpuInfo, INT32 FunctionId )

inline

Execute CPUID.

Parameters

CpuInfo
FunctionId

{
#if defined(_WIN32) || defined(_WIN64)
    __cpuid(CpuInfo, FunctionId);
#elif defined(__linux__)
    __asm__ __volatile__("cpuid" : "=a"(CpuInfo[0]), "=b"(CpuInfo[1]), "=c"(CpuInfo[2]), "=d"(CpuInfo[3]) : "a"(FunctionId), "c"(0));
#else
#    error "Unsupported platform"
#endif
}

CpuCpuIdEx()

VOID CpuCpuIdEx ( INT32 * CpuInfo, INT32 FunctionId, INT32 SubFunctionId )

inline

Execute CPUID with sub-leaf.

Parameters

CpuInfo
FunctionId
SubFunctionId

{
#if defined(_WIN32) || defined(_WIN64)
    __cpuidex(CpuInfo, FunctionId, SubFunctionId);
#elif defined(__linux__)
    __asm__ __volatile__("cpuid" : "=a"(CpuInfo[0]), "=b"(CpuInfo[1]), "=c"(CpuInfo[2]), "=d"(CpuInfo[3]) : "a"(FunctionId), "c"(SubFunctionId));
#else
#    error "Unsupported platform"
#endif
}

CpuInterlockedBitTestAndSet()

UCHAR CpuInterlockedBitTestAndSet	(	volatile LONG *	Base,
		LONG	Bit )

{
#if defined(_WIN32) || defined(_WIN64)
    return _interlockedbittestandset(Base, Bit);
#elif defined(__linux__)
    LONG Mask = (1L << Bit);
    LONG Old  = __atomic_fetch_or(Base, Mask, __ATOMIC_SEQ_CST);
    return (UCHAR)((Old >> Bit) & 1);
#else
#    error "Unsupported platform"
#endif
}

CpuInterlockedCompareExchange64()

INT64 CpuInterlockedCompareExchange64 ( INT64 volatile * Destination, INT64 ExChange, INT64 Comparand )

inline

Atomic 64-bit compare-exchange.

{
#if defined(_WIN32) || defined(_WIN64)
    return InterlockedCompareExchange64(Destination, ExChange, Comparand);
#elif defined(__linux__)
    INT64 Expected = Comparand;
    __atomic_compare_exchange_n(Destination, &Expected, ExChange, 0, __ATOMIC_SEQ_CST, __ATOMIC_SEQ_CST);
    return Expected;
#else
#    error "Unsupported platform"
#endif
}

CpuInterlockedDecrement64()

INT64 CpuInterlockedDecrement64 ( INT64 volatile * Addend )

inline

Atomic 64-bit decrement.

{
#if defined(_WIN32) || defined(_WIN64)
    return InterlockedDecrement64(Addend);
#elif defined(__linux__)
    return __atomic_sub_fetch(Addend, 1LL, __ATOMIC_SEQ_CST);
#else
#    error "Unsupported platform"
#endif
}

CpuInterlockedExchange64()

INT64 CpuInterlockedExchange64 ( INT64 volatile * Target, INT64 Value )

inline

Atomic 64-bit exchange.

{
#if defined(_WIN32) || defined(_WIN64)
    return InterlockedExchange64(Target, Value);
#elif defined(__linux__)
    return __atomic_exchange_n(Target, Value, __ATOMIC_SEQ_CST);
#else
#    error "Unsupported platform"
#endif
}

CpuInterlockedExchangeAdd64()

INT64 CpuInterlockedExchangeAdd64 ( INT64 volatile * Addend, INT64 Value )

inline

Atomic 64-bit exchange-add.

{
#if defined(_WIN32) || defined(_WIN64)
    return InterlockedExchangeAdd64(Addend, Value);
#elif defined(__linux__)
    return __atomic_fetch_add(Addend, Value, __ATOMIC_SEQ_CST);
#else
#    error "Unsupported platform"
#endif
}

CpuInterlockedIncrement64()

INT64 CpuInterlockedIncrement64 ( INT64 volatile * Addend )

inline

Atomic 64-bit increment.

{
#if defined(_WIN32) || defined(_WIN64)
    return InterlockedIncrement64(Addend);
#elif defined(__linux__)
    return __atomic_add_fetch(Addend, 1LL, __ATOMIC_SEQ_CST);
#else
#    error "Unsupported platform"
#endif
}

CpuPause()

VOID CpuPause ( VOID )

inline

Execute PAUSE (spin-wait hint).

{
#if defined(_WIN32) || defined(_WIN64)
    _mm_pause();
#elif defined(__linux__)
    __asm__ __volatile__("pause");
#else
#    error "Unsupported platform"
#endif
}

CpuReadTsc()

UINT64 CpuReadTsc ( VOID )

inline

Read Time-Stamp Counter.

Returns

UINT64

{
#if defined(_WIN32) || defined(_WIN64)
    return __rdtsc();
#elif defined(__linux__)
    UINT32 __lo, __hi;
    __asm__ __volatile__("rdtsc" : "=a"(__lo), "=d"(__hi));
    return ((UINT64)__hi << 32) | __lo;
#else
#    error "Unsupported platform"
#endif
}

CpuReadTscp()

UINT64 CpuReadTscp ( UINT32 * Aux )

inline

Read Time-Stamp Counter and Processor ID.

Parameters

Aux

Returns

UINT64

{
#if defined(_WIN32) || defined(_WIN64)
    return __rdtscp(Aux);
#elif defined(__linux__)
    UINT32 __lo, __hi;
    __asm__ __volatile__("rdtscp" : "=a"(__lo), "=d"(__hi), "=c"(*Aux));
    return ((UINT64)__hi << 32) | __lo;
#else
#    error "Unsupported platform"
#endif
}