include/SDL_cpuinfo.h
author Sam Lantinga <slouken@libsdl.org>
Fri, 04 Jan 2019 22:01:14 -0800
changeset 12503 806492103856
parent 12452 983247abc7e5
child 12719 b9da55e54f98
permissions -rw-r--r--
Updated copyright for 2019
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2019 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 
    22 /**
    23  *  \file SDL_cpuinfo.h
    24  *
    25  *  CPU feature detection for SDL.
    26  */
    27 
    28 #ifndef SDL_cpuinfo_h_
    29 #define SDL_cpuinfo_h_
    30 
    31 #include "SDL_stdinc.h"
    32 
    33 /* Need to do this here because intrin.h has C++ code in it */
    34 /* Visual Studio 2005 has a bug where intrin.h conflicts with winnt.h */
    35 #if defined(_MSC_VER) && (_MSC_VER >= 1500) && (defined(_M_IX86) || defined(_M_X64))
    36 #ifdef __clang__
    37 /* Many of the intrinsics SDL uses are not implemented by clang with Visual Studio */
    38 #undef __MMX__
    39 #undef __SSE__
    40 #undef __SSE2__
    41 #else
    42 #include <intrin.h>
    43 #ifndef _WIN64
    44 #define __MMX__
    45 #define __3dNOW__
    46 #endif
    47 #define __SSE__
    48 #define __SSE2__
    49 #endif /* __clang__ */
    50 #elif defined(__MINGW64_VERSION_MAJOR)
    51 #include <intrin.h>
    52 #else
    53 /* altivec.h redefining bool causes a number of problems, see bugs 3993 and 4392, so you need to explicitly define SDL_ENABLE_ALTIVEC_H to have it included. */
    54 #if defined(HAVE_ALTIVEC_H) && defined(__ALTIVEC__) && !defined(__APPLE_ALTIVEC__) && defined(SDL_ENABLE_ALTIVEC_H)
    55 #include <altivec.h>
    56 #endif
    57 #if !defined(SDL_DISABLE_ARM_NEON_H)
    58 #  if defined(__ARM_NEON)
    59 #    include <arm_neon.h>
    60 #  elif defined(__WINDOWS__) || defined(__WINRT__)
    61 /* Visual Studio doesn't define __ARM_ARCH, but _M_ARM (if set, always 7), and _M_ARM64 (if set, always 1). */
    62 #    if defined(_M_ARM)
    63 #      include <armintr.h>
    64 #      include <arm_neon.h>
    65 #    endif
    66 #    if defined (_M_ARM64)
    67 #      include <armintr.h>
    68 #      include <arm_neon.h>
    69 #    endif
    70 /* Set __ARM_NEON so that it can be used elsewhere, at compile time */
    71 #    define __ARM_NEON 1
    72 #  endif
    73 #endif
    74 #if defined(__3dNOW__) && !defined(SDL_DISABLE_MM3DNOW_H)
    75 #include <mm3dnow.h>
    76 #endif
    77 #if defined(HAVE_IMMINTRIN_H) && !defined(SDL_DISABLE_IMMINTRIN_H)
    78 #include <immintrin.h>
    79 #else
    80 #if defined(__MMX__) && !defined(SDL_DISABLE_MMINTRIN_H)
    81 #include <mmintrin.h>
    82 #endif
    83 #if defined(__SSE__) && !defined(SDL_DISABLE_XMMINTRIN_H)
    84 #include <xmmintrin.h>
    85 #endif
    86 #if defined(__SSE2__) && !defined(SDL_DISABLE_EMMINTRIN_H)
    87 #include <emmintrin.h>
    88 #endif
    89 #if defined(__SSE3__) && !defined(SDL_DISABLE_PMMINTRIN_H)
    90 #include <pmmintrin.h>
    91 #endif
    92 #endif /* HAVE_IMMINTRIN_H */
    93 #endif /* compiler version */
    94 
    95 #include "begin_code.h"
    96 /* Set up for C function definitions, even when using C++ */
    97 #ifdef __cplusplus
    98 extern "C" {
    99 #endif
   100 
   101 /* This is a guess for the cacheline size used for padding.
   102  * Most x86 processors have a 64 byte cache line.
   103  * The 64-bit PowerPC processors have a 128 byte cache line.
   104  * We'll use the larger value to be generally safe.
   105  */
   106 #define SDL_CACHELINE_SIZE  128
   107 
   108 /**
   109  *  This function returns the number of CPU cores available.
   110  */
   111 extern DECLSPEC int SDLCALL SDL_GetCPUCount(void);
   112 
   113 /**
   114  *  This function returns the L1 cache line size of the CPU
   115  *
   116  *  This is useful for determining multi-threaded structure padding
   117  *  or SIMD prefetch sizes.
   118  */
   119 extern DECLSPEC int SDLCALL SDL_GetCPUCacheLineSize(void);
   120 
   121 /**
   122  *  This function returns true if the CPU has the RDTSC instruction.
   123  */
   124 extern DECLSPEC SDL_bool SDLCALL SDL_HasRDTSC(void);
   125 
   126 /**
   127  *  This function returns true if the CPU has AltiVec features.
   128  */
   129 extern DECLSPEC SDL_bool SDLCALL SDL_HasAltiVec(void);
   130 
   131 /**
   132  *  This function returns true if the CPU has MMX features.
   133  */
   134 extern DECLSPEC SDL_bool SDLCALL SDL_HasMMX(void);
   135 
   136 /**
   137  *  This function returns true if the CPU has 3DNow! features.
   138  */
   139 extern DECLSPEC SDL_bool SDLCALL SDL_Has3DNow(void);
   140 
   141 /**
   142  *  This function returns true if the CPU has SSE features.
   143  */
   144 extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE(void);
   145 
   146 /**
   147  *  This function returns true if the CPU has SSE2 features.
   148  */
   149 extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE2(void);
   150 
   151 /**
   152  *  This function returns true if the CPU has SSE3 features.
   153  */
   154 extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE3(void);
   155 
   156 /**
   157  *  This function returns true if the CPU has SSE4.1 features.
   158  */
   159 extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE41(void);
   160 
   161 /**
   162  *  This function returns true if the CPU has SSE4.2 features.
   163  */
   164 extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE42(void);
   165 
   166 /**
   167  *  This function returns true if the CPU has AVX features.
   168  */
   169 extern DECLSPEC SDL_bool SDLCALL SDL_HasAVX(void);
   170 
   171 /**
   172  *  This function returns true if the CPU has AVX2 features.
   173  */
   174 extern DECLSPEC SDL_bool SDLCALL SDL_HasAVX2(void);
   175 
   176 /**
   177  *  This function returns true if the CPU has AVX-512F (foundation) features.
   178  */
   179 extern DECLSPEC SDL_bool SDLCALL SDL_HasAVX512F(void);
   180 
   181 /**
   182  *  This function returns true if the CPU has NEON (ARM SIMD) features.
   183  */
   184 extern DECLSPEC SDL_bool SDLCALL SDL_HasNEON(void);
   185 
   186 /**
   187  *  This function returns the amount of RAM configured in the system, in MB.
   188  */
   189 extern DECLSPEC int SDLCALL SDL_GetSystemRAM(void);
   190 
   191 /* Ends C function definitions when using C++ */
   192 #ifdef __cplusplus
   193 }
   194 #endif
   195 #include "close_code.h"
   196 
   197 #endif /* SDL_cpuinfo_h_ */
   198 
   199 /* vi: set ts=4 sw=4 expandtab: */