1c9d20889d297bdf6c2be9b0b46bd2a71d4bfa76
[reactos.git] / sdk / include / crt / mingw32 / intrin.h
1 /*
2 Compatibility <intrin.h> header for GCC -- GCC equivalents of intrinsic
3 Microsoft Visual C++ functions. Originally developed for the ReactOS
4 (<http://www.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 #ifdef __clang__
34 #define __ATTRIBUTE_ARTIFICIAL
35 #else
36 #define __ATTRIBUTE_ARTIFICIAL __attribute__((artificial))
37 #endif
38
39 #define __INTRIN_INLINE extern __inline__ __attribute__((__always_inline__,__gnu_inline__)) __ATTRIBUTE_ARTIFICIAL
40
41 #ifndef _SIZE_T_DEFINED
42 #define _SIZE_T_DEFINED
43 #ifdef _WIN64
44 typedef unsigned __int64 size_t;
45 #else
46 typedef unsigned int size_t;
47 #endif
48 #endif
49
50 #ifndef _UINTPTR_T_DEFINED
51 #define _UINTPTR_T_DEFINED
52 #ifdef _WIN64
53 typedef unsigned __int64 uintptr_t;
54 #else
55 typedef unsigned int uintptr_t;
56 #endif
57 #endif
58
59 /*
60 FIXME: review all "memory" clobbers, add/remove to match Visual C++
61 behavior: some "obvious" memory barriers are not present in the Visual C++
62 implementation - e.g. __stosX; on the other hand, some memory barriers that
63 *are* present could have been missed
64 */
65
66 /*
67 NOTE: this is a *compatibility* header. Some functions may look wrong at
68 first, but they're only "as wrong" as they would be on Visual C++. Our
69 priority is compatibility
70
71 NOTE: unlike most people who write inline asm for GCC, I didn't pull the
72 constraints and the uses of __volatile__ out of my... hat. Do not touch
73 them. I hate cargo cult programming
74
75 NOTE: be very careful with declaring "memory" clobbers. Some "obvious"
76 barriers aren't there in Visual C++ (e.g. __stosX)
77
78 NOTE: review all intrinsics with a return value, add/remove __volatile__
79 where necessary. If an intrinsic whose value is ignored generates a no-op
80 under Visual C++, __volatile__ must be omitted; if it always generates code
81 (for example, if it has side effects), __volatile__ must be specified. GCC
82 will only optimize out non-volatile asm blocks with outputs, so input-only
83 blocks are safe. Oddities such as the non-volatile 'rdmsr' are intentional
84 and follow Visual C++ behavior
85
86 NOTE: on GCC 4.1.0, please use the __sync_* built-ins for barriers and
87 atomic operations. Test the version like this:
88
89 #if (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__) > 40100
90 ...
91
92 Pay attention to the type of barrier. Make it match with what Visual C++
93 would use in the same case
94 */
95
96 #if defined(__i386__)
97 #include "intrin_x86.h"
98 #elif defined(_PPC_)
99 #include "intrin_ppc.h"
100 #elif defined(_MIPS_)
101 #include "intrin_mips.h"
102 #elif defined(_M_ARM)
103 #include "intrin_arm.h"
104 #elif defined(__x86_64__)
105 /* TODO: the x64 architecture shares most of the i386 intrinsics. It should be easy to support */
106 #include "intrin_x86.h"
107 #else
108 #error Unsupported architecture
109 #endif
110
111
112 /*** Miscellaneous ***/
113 /* BUGBUG: only good for use in macros. Cannot be taken the address of */
114 #define __noop(...) ((void)0)
115
116 #define __assume(x) if (!(x)) __builtin_unreachable()
117
118 #endif
119
120 #endif
121
122 /* EOF */