SDL  2.0
SDL_cpuinfo.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2018 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 #ifdef __ALTIVEC__
54 #if defined(HAVE_ALTIVEC_H) && !defined(__APPLE_ALTIVEC__) && !defined(SDL_DISABLE_ALTIVEC_H)
55 #include <altivec.h>
56 #undef pixel
57 #undef bool
58 #endif
59 #endif
60 #if defined(__ARM_NEON__) && !defined(SDL_DISABLE_ARM_NEON_H)
61 #include <arm_neon.h>
62 #endif
63 #if defined(__mips_msa) && defined(HAVE_MSA_H) && !defined(SDL_DISABLE_MSA_H)
64 #include <msa.h>
65 #define __MSA__
66 #endif
67 #if defined(__loongarch_sx) && defined(HAVE_LSX_H) && !defined(SDL_DISABLE_LSX_H)
68 #include <lsxintrin.h>
69 #define __LSX__
70 #endif
71 #if defined(__loongarch_asx) && defined(HAVE_LASX_H) && !defined(SDL_DISABLE_LASX_H)
72 #include <lasxintrin.h>
73 #define __LASX__
74 #endif
75 #if defined(__3dNOW__) && !defined(SDL_DISABLE_MM3DNOW_H)
76 #include <mm3dnow.h>
77 #endif
78 #if defined(HAVE_IMMINTRIN_H) && !defined(SDL_DISABLE_IMMINTRIN_H)
79 #include <immintrin.h>
80 #else
81 #if defined(__MMX__) && !defined(SDL_DISABLE_MMINTRIN_H)
82 #include <mmintrin.h>
83 #endif
84 #if defined(__SSE__) && !defined(SDL_DISABLE_XMMINTRIN_H)
85 #include <xmmintrin.h>
86 #endif
87 #if defined(__SSE2__) && !defined(SDL_DISABLE_EMMINTRIN_H)
88 #include <emmintrin.h>
89 #endif
90 #if defined(__SSE3__) && !defined(SDL_DISABLE_PMMINTRIN_H)
91 #include <pmmintrin.h>
92 #endif
93 #endif /* HAVE_IMMINTRIN_H */
94 #endif /* compiler version */
95 
96 #include "begin_code.h"
97 /* Set up for C function definitions, even when using C++ */
98 #ifdef __cplusplus
99 extern "C" {
100 #endif
101 
102 /* This is a guess for the cacheline size used for padding.
103  * Most x86 processors have a 64 byte cache line.
104  * The 64-bit PowerPC processors have a 128 byte cache line.
105  * We'll use the larger value to be generally safe.
106  */
107 #define SDL_CACHELINE_SIZE 128
108 
109 /**
110  * This function returns the number of CPU cores available.
111  */
112 extern DECLSPEC int SDLCALL SDL_GetCPUCount(void);
113 
114 /**
115  * This function returns the L1 cache line size of the CPU
116  *
117  * This is useful for determining multi-threaded structure padding
118  * or SIMD prefetch sizes.
119  */
120 extern DECLSPEC int SDLCALL SDL_GetCPUCacheLineSize(void);
121 
122 /**
123  * This function returns true if the CPU has the RDTSC instruction.
124  */
126 
127 /**
128  * This function returns true if the CPU has AltiVec features.
129  */
131 
132 /**
133  * This function returns true if the CPU has MMX features.
134  */
135 extern DECLSPEC SDL_bool SDLCALL SDL_HasMMX(void);
136 
137 /**
138  * This function returns true if the CPU has 3DNow! features.
139  */
141 
142 /**
143  * This function returns true if the CPU has SSE features.
144  */
145 extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE(void);
146 
147 /**
148  * This function returns true if the CPU has SSE2 features.
149  */
150 extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE2(void);
151 
152 /**
153  * This function returns true if the CPU has SSE3 features.
154  */
155 extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE3(void);
156 
157 /**
158  * This function returns true if the CPU has SSE4.1 features.
159  */
161 
162 /**
163  * This function returns true if the CPU has SSE4.2 features.
164  */
166 
167 /**
168  * This function returns true if the CPU has AVX features.
169  */
170 extern DECLSPEC SDL_bool SDLCALL SDL_HasAVX(void);
171 
172 /**
173  * This function returns true if the CPU has AVX2 features.
174  */
175 extern DECLSPEC SDL_bool SDLCALL SDL_HasAVX2(void);
176 
177 /**
178  * This function returns true if the CPU has AVX-512F (foundation) features.
179  */
181 
182 /**
183  * This function returns true if the CPU has NEON (ARM SIMD) features.
184  */
185 extern DECLSPEC SDL_bool SDLCALL SDL_HasNEON(void);
186 
187 /**
188  * This function returns true if the CPU has MSA (MIPS SIMD) features.
189  */
190 extern DECLSPEC SDL_bool SDLCALL SDL_HasMSA(void);
191 
192 /**
193  * This function returns true if the CPU has LSX (LOONGARCH SIMD) features.
194  */
195 extern DECLSPEC SDL_bool SDLCALL SDL_HasLSX(void);
196 
197 /**
198  * This function returns true if the CPU has LASX (LOONGARCH SIMD) features.
199  */
200 extern DECLSPEC SDL_bool SDLCALL SDL_HasLASX(void);
201 
202 /**
203  * This function returns the amount of RAM configured in the system, in MB.
204  */
205 extern DECLSPEC int SDLCALL SDL_GetSystemRAM(void);
206 
207 /* Ends C function definitions when using C++ */
208 #ifdef __cplusplus
209 }
210 #endif
211 #include "close_code.h"
212 
213 #endif /* SDL_cpuinfo_h_ */
214 
215 /* vi: set ts=4 sw=4 expandtab: */
int SDL_GetCPUCount(void)
Definition: SDL_cpuinfo.c:483
SDL_bool SDL_Has3DNow(void)
Definition: SDL_cpuinfo.c:747
SDL_bool SDL_HasRDTSC(void)
Definition: SDL_cpuinfo.c:729
SDL_bool SDL_HasNEON(void)
Definition: SDL_cpuinfo.c:801
SDL_bool SDL_HasAVX2(void)
Definition: SDL_cpuinfo.c:789
SDL_bool SDL_HasSSE41(void)
Definition: SDL_cpuinfo.c:771
SDL_bool SDL_HasSSE42(void)
Definition: SDL_cpuinfo.c:777
SDL_bool SDL_HasSSE3(void)
Definition: SDL_cpuinfo.c:765
SDL_bool SDL_HasSSE(void)
Definition: SDL_cpuinfo.c:753
SDL_bool SDL_HasLASX(void)
Definition: SDL_cpuinfo.c:819
#define DECLSPEC
Definition: SDL_internal.h:44
SDL_bool SDL_HasAVX512F(void)
Definition: SDL_cpuinfo.c:795
SDL_bool SDL_HasAVX(void)
Definition: SDL_cpuinfo.c:783
SDL_bool SDL_HasAltiVec(void)
Definition: SDL_cpuinfo.c:735
SDL_bool SDL_HasMSA(void)
Definition: SDL_cpuinfo.c:807
SDL_bool SDL_HasLSX(void)
Definition: SDL_cpuinfo.c:813
SDL_bool SDL_HasMMX(void)
Definition: SDL_cpuinfo.c:741
SDL_bool
Definition: SDL_stdinc.h:161
SDL_bool SDL_HasSSE2(void)
Definition: SDL_cpuinfo.c:759
int SDL_GetSystemRAM(void)
Definition: SDL_cpuinfo.c:827
#define SDLCALL
Definition: SDL_internal.h:45
int SDL_GetCPUCacheLineSize(void)
Definition: SDL_cpuinfo.c:633