LLVM OpenMP* Runtime Library
kmp_platform.h
1 /*
2  * kmp_platform.h -- header for determining operating system and architecture
3  */
4 
5 //===----------------------------------------------------------------------===//
6 //
7 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
8 // See https://llvm.org/LICENSE.txt for license information.
9 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef KMP_PLATFORM_H
14 #define KMP_PLATFORM_H
15 
16 /* ---------------------- Operating system recognition ------------------- */
17 
18 #define KMP_OS_LINUX 0
19 #define KMP_OS_DRAGONFLY 0
20 #define KMP_OS_FREEBSD 0
21 #define KMP_OS_NETBSD 0
22 #define KMP_OS_OPENBSD 0
23 #define KMP_OS_DARWIN 0
24 #define KMP_OS_WINDOWS 0
25 #define KMP_OS_HURD 0
26 #define KMP_OS_UNIX 0 /* disjunction of KMP_OS_LINUX, KMP_OS_DARWIN etc. */
27 
28 #ifdef _WIN32
29 #undef KMP_OS_WINDOWS
30 #define KMP_OS_WINDOWS 1
31 #endif
32 
33 #if (defined __APPLE__ && defined __MACH__)
34 #undef KMP_OS_DARWIN
35 #define KMP_OS_DARWIN 1
36 #endif
37 
38 // in some ppc64 linux installations, only the second condition is met
39 #if (defined __linux)
40 #undef KMP_OS_LINUX
41 #define KMP_OS_LINUX 1
42 #elif (defined __linux__)
43 #undef KMP_OS_LINUX
44 #define KMP_OS_LINUX 1
45 #else
46 #endif
47 
48 #if (defined __DragonFly__)
49 #undef KMP_OS_DRAGONFLY
50 #define KMP_OS_DRAGONFLY 1
51 #endif
52 
53 #if (defined __FreeBSD__)
54 #undef KMP_OS_FREEBSD
55 #define KMP_OS_FREEBSD 1
56 #endif
57 
58 #if (defined __NetBSD__)
59 #undef KMP_OS_NETBSD
60 #define KMP_OS_NETBSD 1
61 #endif
62 
63 #if (defined __OpenBSD__)
64 #undef KMP_OS_OPENBSD
65 #define KMP_OS_OPENBSD 1
66 #endif
67 
68 #if (defined __GNU__)
69 #undef KMP_OS_HURD
70 #define KMP_OS_HURD 1
71 #endif
72 
73 #if (1 != KMP_OS_LINUX + KMP_OS_DRAGONFLY + KMP_OS_FREEBSD + KMP_OS_NETBSD + \
74  KMP_OS_OPENBSD + KMP_OS_DARWIN + KMP_OS_WINDOWS + KMP_OS_HURD)
75 #error Unknown OS
76 #endif
77 
78 #if KMP_OS_LINUX || KMP_OS_DRAGONFLY || KMP_OS_FREEBSD || KMP_OS_NETBSD || \
79  KMP_OS_OPENBSD || KMP_OS_DARWIN || KMP_OS_HURD
80 #undef KMP_OS_UNIX
81 #define KMP_OS_UNIX 1
82 #endif
83 
84 /* ---------------------- Architecture recognition ------------------- */
85 
86 #define KMP_ARCH_X86 0
87 #define KMP_ARCH_X86_64 0
88 #define KMP_ARCH_AARCH64 0
89 #define KMP_ARCH_PPC64_ELFv1 0
90 #define KMP_ARCH_PPC64_ELFv2 0
91 #define KMP_ARCH_PPC64 (KMP_ARCH_PPC64_ELFv2 || KMP_ARCH_PPC64_ELFv1)
92 #define KMP_ARCH_MIPS 0
93 #define KMP_ARCH_MIPS64 0
94 #define KMP_ARCH_RISCV64 0
95 
96 #if KMP_OS_WINDOWS
97 #if defined(_M_AMD64) || defined(__x86_64)
98 #undef KMP_ARCH_X86_64
99 #define KMP_ARCH_X86_64 1
100 #else
101 #undef KMP_ARCH_X86
102 #define KMP_ARCH_X86 1
103 #endif
104 #endif
105 
106 #if KMP_OS_UNIX
107 #if defined __x86_64
108 #undef KMP_ARCH_X86_64
109 #define KMP_ARCH_X86_64 1
110 #elif defined __i386
111 #undef KMP_ARCH_X86
112 #define KMP_ARCH_X86 1
113 #elif defined __powerpc64__
114 #if defined(_CALL_ELF) && _CALL_ELF == 2
115 #undef KMP_ARCH_PPC64_ELFv2
116 #define KMP_ARCH_PPC64_ELFv2 1
117 #else
118 #undef KMP_ARCH_PPC64_ELFv1
119 #define KMP_ARCH_PPC64_ELFv1 1
120 #endif
121 #elif defined __aarch64__
122 #undef KMP_ARCH_AARCH64
123 #define KMP_ARCH_AARCH64 1
124 #elif defined __mips__
125 #if defined __mips64
126 #undef KMP_ARCH_MIPS64
127 #define KMP_ARCH_MIPS64 1
128 #else
129 #undef KMP_ARCH_MIPS
130 #define KMP_ARCH_MIPS 1
131 #endif
132 #elif defined __riscv && __riscv_xlen == 64
133 #undef KMP_ARCH_RISCV64
134 #define KMP_ARCH_RISCV64 1
135 #endif
136 #endif
137 
138 #if defined(__ARM_ARCH_7__) || defined(__ARM_ARCH_7R__) || \
139  defined(__ARM_ARCH_7A__) || defined(__ARM_ARCH_7VE__)
140 #define KMP_ARCH_ARMV7 1
141 #endif
142 
143 #if defined(KMP_ARCH_ARMV7) || defined(__ARM_ARCH_6__) || \
144  defined(__ARM_ARCH_6J__) || defined(__ARM_ARCH_6K__) || \
145  defined(__ARM_ARCH_6Z__) || defined(__ARM_ARCH_6T2__) || \
146  defined(__ARM_ARCH_6ZK__)
147 #define KMP_ARCH_ARMV6 1
148 #endif
149 
150 #if defined(KMP_ARCH_ARMV6) || defined(__ARM_ARCH_5T__) || \
151  defined(__ARM_ARCH_5E__) || defined(__ARM_ARCH_5TE__) || \
152  defined(__ARM_ARCH_5TEJ__)
153 #define KMP_ARCH_ARMV5 1
154 #endif
155 
156 #if defined(KMP_ARCH_ARMV5) || defined(__ARM_ARCH_4__) || \
157  defined(__ARM_ARCH_4T__)
158 #define KMP_ARCH_ARMV4 1
159 #endif
160 
161 #if defined(KMP_ARCH_ARMV4) || defined(__ARM_ARCH_3__) || \
162  defined(__ARM_ARCH_3M__)
163 #define KMP_ARCH_ARMV3 1
164 #endif
165 
166 #if defined(KMP_ARCH_ARMV3) || defined(__ARM_ARCH_2__)
167 #define KMP_ARCH_ARMV2 1
168 #endif
169 
170 #if defined(KMP_ARCH_ARMV2)
171 #define KMP_ARCH_ARM 1
172 #endif
173 
174 #if defined(__MIC__) || defined(__MIC2__)
175 #define KMP_MIC 1
176 #if __MIC2__ || __KNC__
177 #define KMP_MIC1 0
178 #define KMP_MIC2 1
179 #else
180 #define KMP_MIC1 1
181 #define KMP_MIC2 0
182 #endif
183 #else
184 #define KMP_MIC 0
185 #define KMP_MIC1 0
186 #define KMP_MIC2 0
187 #endif
188 
189 /* Specify 32 bit architectures here */
190 #define KMP_32_BIT_ARCH (KMP_ARCH_X86 || KMP_ARCH_ARM || KMP_ARCH_MIPS)
191 
192 // Platforms which support Intel(R) Many Integrated Core Architecture
193 #define KMP_MIC_SUPPORTED \
194  ((KMP_ARCH_X86 || KMP_ARCH_X86_64) && (KMP_OS_LINUX || KMP_OS_WINDOWS))
195 
196 // TODO: Fixme - This is clever, but really fugly
197 #if (1 != KMP_ARCH_X86 + KMP_ARCH_X86_64 + KMP_ARCH_ARM + KMP_ARCH_PPC64 + \
198  KMP_ARCH_AARCH64 + KMP_ARCH_MIPS + KMP_ARCH_MIPS64 + \
199  KMP_ARCH_RISCV64)
200 #error Unknown or unsupported architecture
201 #endif
202 
203 #endif // KMP_PLATFORM_H