zend_cpuinfo.h

Go to the documentation of this file.

/*
   +----------------------------------------------------------------------+
   | Zend Engine                                                          |
   +----------------------------------------------------------------------+
   | Copyright (c) Zend Technologies Ltd. (http://www.zend.com)           |
   +----------------------------------------------------------------------+
   | This source file is subject to version 2.00 of the Zend license,     |
   | that is bundled with this package in the file LICENSE, and is        |
   | available through the world-wide-web at the following url:           |
   | http://www.zend.com/license/2_00.txt.                                |
   | If you did not receive a copy of the Zend license and are unable to  |
   | obtain it through the world-wide-web, please send a note to          |
   | license@zend.com so we can mail you a copy immediately.              |
   +----------------------------------------------------------------------+
   | Authors: Xinchen Hui <laruence@php.net>                              |
   +----------------------------------------------------------------------+
*/
 
#ifndef ZEND_CPU_INFO_H
#define ZEND_CPU_INFO_H
 
#include "zend.h"
 
#define ZEND_CPU_EBX_MASK     (1<<30)
#define ZEND_CPU_EDX_MASK     (1U<<31)
 
typedef enum _zend_cpu_feature {
    /* ECX */
    ZEND_CPU_FEATURE_SSE3          = (1<<0),
    ZEND_CPU_FEATURE_PCLMULQDQ        = (1<<1),
    ZEND_CPU_FEATURE_DTES64          = (1<<2),
    ZEND_CPU_FEATURE_MONITOR        = (1<<3),
    ZEND_CPU_FEATURE_DSCPL            = (1<<4),
    ZEND_CPU_FEATURE_VMX            = (1<<5),
    ZEND_CPU_FEATURE_SMX            = (1<<6),
    ZEND_CPU_FEATURE_EST            = (1<<7),
    ZEND_CPU_FEATURE_TM2            = (1<<8),
    ZEND_CPU_FEATURE_SSSE3            = (1<<9),
    ZEND_CPU_FEATURE_CID            = (1<<10),
    ZEND_CPU_FEATURE_SDBG          = (1<<11),
    ZEND_CPU_FEATURE_FMA            = (1<<12),
    ZEND_CPU_FEATURE_CX16          = (1<<13),
    ZEND_CPU_FEATURE_XTPR          = (1<<14),
    ZEND_CPU_FEATURE_PDCM          = (1<<15),
    /* reserved                     = (1<<16),*/
    ZEND_CPU_FEATURE_PCID          = (1<<17),
    ZEND_CPU_FEATURE_DCA            = (1<<18),
    ZEND_CPU_FEATURE_SSE41            = (1<<19),
    ZEND_CPU_FEATURE_SSE42            = (1<<20),
    ZEND_CPU_FEATURE_X2APIC          = (1<<21),
    ZEND_CPU_FEATURE_MOVBE            = (1<<22),
    ZEND_CPU_FEATURE_POPCNT          = (1<<23),
    ZEND_CPU_FEATURE_TSC_DEADLINE  = (1<<24),
    ZEND_CPU_FEATURE_AES            = (1<<25),
    ZEND_CPU_FEATURE_XSAVE            = (1<<26),
    ZEND_CPU_FEATURE_OSXSAVE        = (1<<27) ,
    ZEND_CPU_FEATURE_AVX            = (1<<28),
    ZEND_CPU_FEATURE_F16C          = (1<<29),
    /* intentionally don't support  = (1<<30) */
    /* intentionally don't support  = (1<<31) */
 
    /* EBX */
    ZEND_CPU_FEATURE_AVX2          = (1<<5 | ZEND_CPU_EBX_MASK),
    ZEND_CPU_FEATURE_AVX512F        = (1<<16 | ZEND_CPU_EBX_MASK),
    ZEND_CPU_FEATURE_AVX512DQ      = (1<<17 | ZEND_CPU_EBX_MASK),
    ZEND_CPU_FEATURE_AVX512CD      = (1<<28 | ZEND_CPU_EBX_MASK),
    ZEND_CPU_FEATURE_SHA            = (1<<29 | ZEND_CPU_EBX_MASK),
    /* intentionally don't support      = (1<<30 | ZEND_CPU_EBX_MASK) */
    /* intentionally don't support      = (1<<31 | ZEND_CPU_EBX_MASK) */
 
    /* EDX */
    ZEND_CPU_FEATURE_FPU            = (1<<0 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_VME            = (1<<1 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_DE              = (1<<2 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_PSE            = (1<<3 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_TSC            = (1<<4 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_MSR            = (1<<5 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_PAE            = (1<<6 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_MCE            = (1<<7 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_CX8            = (1<<8 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_APIC          = (1<<9 | ZEND_CPU_EDX_MASK),
    /* reserved                     = (1<<10 | ZEND_CPU_EDX_MASK),*/
    ZEND_CPU_FEATURE_SEP            = (1<<11 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_MTRR          = (1<<12 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_PGE            = (1<<13 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_MCA            = (1<<14 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_CMOV          = (1<<15 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_PAT            = (1<<16 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_PSE36            = (1<<17 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_PN              = (1<<18 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_CLFLUSH        = (1<<19 | ZEND_CPU_EDX_MASK),
    /* reserved                     = (1<<20 | ZEND_CPU_EDX_MASK),*/
    ZEND_CPU_FEATURE_DS              = (1<<21 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_ACPI          = (1<<22 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_MMX            = (1<<23 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_FXSR          = (1<<24 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_SSE            = (1<<25 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_SSE2          = (1<<26 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_SS              = (1<<27 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_HT              = (1<<28 | ZEND_CPU_EDX_MASK),
    ZEND_CPU_FEATURE_TM              = (1<<29 | ZEND_CPU_EDX_MASK)
    /*intentionally don't support   = (1<<30 | ZEND_CPU_EDX_MASK)*/
    /*intentionally don't support   = (1<<31 | ZEND_CPU_EDX_MASK)*/
} zend_cpu_feature;
 
void zend_cpu_startup(void);
ZEND_API int zend_cpu_supports(zend_cpu_feature feature);
 
#ifndef __has_attribute
# define __has_attribute(x) 0
#endif
 
/* Address sanitizer is incompatible with ifunc resolvers, so exclude the
 * CPU support helpers from asan.
 * See also https://github.com/google/sanitizers/issues/342. */
#if __has_attribute(no_sanitize_address)
# define ZEND_NO_SANITIZE_ADDRESS __attribute__((no_sanitize_address))
#else
# define ZEND_NO_SANITIZE_ADDRESS
#endif
 
#ifdef PHP_HAVE_BUILTIN_CPU_SUPPORTS
/* NOTE: you should use following inline function in
 * resolver functions (ifunc), as it could be called
 * before all PLT symbols are resolved. in other words,
 * resolver functions should not depend on any external
 * functions */
ZEND_NO_SANITIZE_ADDRESS
static inline int zend_cpu_supports_sse2(void) {
#ifdef PHP_HAVE_BUILTIN_CPU_INIT
    __builtin_cpu_init();
#endif
    return __builtin_cpu_supports("sse2");
}
 
ZEND_NO_SANITIZE_ADDRESS
static inline int zend_cpu_supports_sse3(void) {
#ifdef PHP_HAVE_BUILTIN_CPU_INIT
    __builtin_cpu_init();
#endif
    return __builtin_cpu_supports("sse3");
}
 
ZEND_NO_SANITIZE_ADDRESS
static inline int zend_cpu_supports_ssse3(void) {
#ifdef PHP_HAVE_BUILTIN_CPU_INIT
    __builtin_cpu_init();
#endif
    return __builtin_cpu_supports("ssse3");
}
 
ZEND_NO_SANITIZE_ADDRESS
static inline int zend_cpu_supports_sse41(void) {
#ifdef PHP_HAVE_BUILTIN_CPU_INIT
    __builtin_cpu_init();
#endif
    return __builtin_cpu_supports("sse4.1");
}
 
ZEND_NO_SANITIZE_ADDRESS
static inline int zend_cpu_supports_sse42(void) {
#ifdef PHP_HAVE_BUILTIN_CPU_INIT
    __builtin_cpu_init();
#endif
    return __builtin_cpu_supports("sse4.2");
}
 
ZEND_NO_SANITIZE_ADDRESS
static inline int zend_cpu_supports_avx(void) {
#ifdef PHP_HAVE_BUILTIN_CPU_INIT
    __builtin_cpu_init();
#endif
    return __builtin_cpu_supports("avx");
}
 
ZEND_NO_SANITIZE_ADDRESS
static inline int zend_cpu_supports_avx2(void) {
#ifdef PHP_HAVE_BUILTIN_CPU_INIT
    __builtin_cpu_init();
#endif
    return __builtin_cpu_supports("avx2");
}
 
#ifdef PHP_HAVE_AVX512_SUPPORTS
ZEND_NO_SANITIZE_ADDRESS
static inline int zend_cpu_supports_avx512(void) {
#ifdef PHP_HAVE_BUILTIN_CPU_INIT
    __builtin_cpu_init();
#endif
    return __builtin_cpu_supports("avx512f") && __builtin_cpu_supports("avx512dq")
        && __builtin_cpu_supports("avx512cd") && __builtin_cpu_supports("avx512bw")
        && __builtin_cpu_supports("avx512vl");
}
#endif
 
#ifdef PHP_HAVE_AVX512_VBMI_SUPPORTS
ZEND_NO_SANITIZE_ADDRESS
static inline int zend_cpu_supports_avx512_vbmi(void) {
#ifdef PHP_HAVE_BUILTIN_CPU_INIT
    __builtin_cpu_init();
#endif
    return zend_cpu_supports_avx512() && __builtin_cpu_supports("avx512vbmi");
}
#endif
 
#else
 
static inline int zend_cpu_supports_sse2(void) {
    return zend_cpu_supports(ZEND_CPU_FEATURE_SSE2);
}
 
static inline int zend_cpu_supports_sse3(void) {
    return zend_cpu_supports(ZEND_CPU_FEATURE_SSE3);
}
 
static inline int zend_cpu_supports_ssse3(void) {
    return zend_cpu_supports(ZEND_CPU_FEATURE_SSSE3);
}
 
static inline int zend_cpu_supports_sse41(void) {
    return zend_cpu_supports(ZEND_CPU_FEATURE_SSE41);
}
 
static inline int zend_cpu_supports_sse42(void) {
    return zend_cpu_supports(ZEND_CPU_FEATURE_SSE42);
}
 
static inline int zend_cpu_supports_avx(void) {
    return zend_cpu_supports(ZEND_CPU_FEATURE_AVX);
}
 
static inline int zend_cpu_supports_avx2(void) {
    return zend_cpu_supports(ZEND_CPU_FEATURE_AVX2);
}
 
static inline int zend_cpu_supports_avx512(void) {
    /* TODO: avx512_bw/avx512_vl use bit 30/31 which are reserved for mask */
    return 0;
}
 
static zend_always_inline int zend_cpu_supports_avx512_vbmi(void) {
    /* TODO: avx512_vbmi use ECX of cpuid 7 */
    return 0;
}
#endif
 
/* __builtin_cpu_supports has pclmul from gcc9 */
#if defined(PHP_HAVE_BUILTIN_CPU_SUPPORTS) && (!defined(__GNUC__) || (ZEND_GCC_VERSION >= 9000))
ZEND_NO_SANITIZE_ADDRESS
static inline int zend_cpu_supports_pclmul(void) {
#ifdef PHP_HAVE_BUILTIN_CPU_INIT
    __builtin_cpu_init();
#endif
    return __builtin_cpu_supports("pclmul");
}
#else
static inline int zend_cpu_supports_pclmul(void) {
    return zend_cpu_supports(ZEND_CPU_FEATURE_PCLMULQDQ);
}
#endif
 
/* __builtin_cpu_supports has cldemote from gcc11 */
#if defined(PHP_HAVE_BUILTIN_CPU_SUPPORTS) && defined(__GNUC__) && (ZEND_GCC_VERSION >= 11000)
ZEND_NO_SANITIZE_ADDRESS
static inline int zend_cpu_supports_cldemote(void) {
#ifdef PHP_HAVE_BUILTIN_CPU_INIT
    __builtin_cpu_init();
#endif
    return __builtin_cpu_supports("cldemote");
}
#endif
 
#endif