xref: /reactos/sdk/include/vcruntime/mingw32/intrin.h (revision b09b5584)
1 /*
2 	Compatibility <intrin.h> header for GCC -- GCC equivalents of intrinsic
3 	Microsoft Visual C++ functions. Originally developed for the ReactOS
4 	(<https://reactos.org/>) and TinyKrnl (<http://www.tinykrnl.org/>)
5 	projects.
6 
7 	Copyright (c) 2006 KJK::Hyperion <hackbunny@reactos.com>
8 
9 	Permission is hereby granted, free of charge, to any person obtaining a
10 	copy of this software and associated documentation files (the "Software"),
11 	to deal in the Software without restriction, including without limitation
12 	the rights to use, copy, modify, merge, publish, distribute, sublicense,
13 	and/or sell copies of the Software, and to permit persons to whom the
14 	Software is furnished to do so, subject to the following conditions:
15 
16 	The above copyright notice and this permission notice shall be included in
17 	all copies or substantial portions of the Software.
18 
19 	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24 	FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25 	DEALINGS IN THE SOFTWARE.
26 */
27 
28 #ifndef KJK_INTRIN_H_
29 #define KJK_INTRIN_H_
30 
31 #ifndef RC_INVOKED
32 
33 #ifndef _SIZE_T_DEFINED
34 #define _SIZE_T_DEFINED
35 #ifdef _WIN64
36   typedef unsigned __int64 size_t;
37 #else
38   typedef unsigned int size_t;
39 #endif
40 #endif
41 
42 #ifndef _UINTPTR_T_DEFINED
43 #define _UINTPTR_T_DEFINED
44 #ifdef _WIN64
45   typedef unsigned __int64 uintptr_t;
46 #else
47   typedef unsigned int uintptr_t;
48 #endif
49 #endif
50 
51 /*
52 	FIXME: review all "memory" clobbers, add/remove to match Visual C++
53 	behavior: some "obvious" memory barriers are not present in the Visual C++
54 	implementation - e.g. __stosX; on the other hand, some memory barriers that
55 	*are* present could have been missed
56 */
57 
58 /*
59 	NOTE: this is a *compatibility* header. Some functions may look wrong at
60 	first, but they're only "as wrong" as they would be on Visual C++. Our
61 	priority is compatibility
62 
63 	NOTE: unlike most people who write inline asm for GCC, I didn't pull the
64 	constraints and the uses of __volatile__ out of my... hat. Do not touch
65 	them. I hate cargo cult programming
66 
67 	NOTE: be very careful with declaring "memory" clobbers. Some "obvious"
68 	barriers aren't there in Visual C++ (e.g. __stosX)
69 
70 	NOTE: review all intrinsics with a return value, add/remove __volatile__
71 	where necessary. If an intrinsic whose value is ignored generates a no-op
72 	under Visual C++, __volatile__ must be omitted; if it always generates code
73 	(for example, if it has side effects), __volatile__ must be specified. GCC
74 	will only optimize out non-volatile asm blocks with outputs, so input-only
75 	blocks are safe. Oddities such as the non-volatile 'rdmsr' are intentional
76 	and follow Visual C++ behavior
77 
78 	NOTE: on GCC 4.1.0, please use the __sync_* built-ins for barriers and
79 	atomic operations. Test the version like this:
80 
81 	#if (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__) > 40100
82 		...
83 
84 	Pay attention to the type of barrier. Make it match with what Visual C++
85 	would use in the same case
86 */
87 
88 #if defined(__i386__)
89 #include "intrin_x86.h"
90 #elif defined(_PPC_)
91 #include "intrin_ppc.h"
92 #elif defined(_MIPS_)
93 #include "intrin_mips.h"
94 #elif defined(_M_ARM)
95 #include "intrin_arm.h"
96 #elif defined(__x86_64__)
97 /* TODO: the x64 architecture shares most of the i386 intrinsics. It should be easy to support */
98 #include "intrin_x86.h"
99 #else
100 #error Unsupported architecture
101 #endif
102 
103 
104 /*** Miscellaneous ***/
105 /* BUGBUG: only good for use in macros. Cannot be taken the address of */
106 #define __noop(...) ((void)0)
107 
108 #define __assume(x) if (!(x)) __builtin_unreachable()
109 
110 #endif
111 
112 #endif
113 
114 /* EOF */
115