• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 //
2 // Copyright 2014 The ANGLE Project Authors. All rights reserved.
3 // Use of this source code is governed by a BSD-style license that can be
4 // found in the LICENSE file.
5 //
6 
7 // platform.h: Operating system specific includes and defines.
8 
9 #ifndef COMMON_PLATFORM_H_
10 #define COMMON_PLATFORM_H_
11 
12 #if defined(_WIN32)
13 #    define ANGLE_PLATFORM_WINDOWS 1
14 #elif defined(__Fuchsia__)
15 #    define ANGLE_PLATFORM_FUCHSIA 1
16 #    define ANGLE_PLATFORM_POSIX 1
17 #elif defined(__APPLE__)
18 #    define ANGLE_PLATFORM_APPLE 1
19 #    define ANGLE_PLATFORM_POSIX 1
20 #elif defined(ANDROID)
21 #    define ANGLE_PLATFORM_ANDROID 1
22 #    define ANGLE_PLATFORM_POSIX 1
23 #elif defined(__ggp__)
24 #    define ANGLE_PLATFORM_GGP 1
25 #    define ANGLE_PLATFORM_POSIX 1
26 #elif defined(__linux__) || defined(EMSCRIPTEN)
27 #    define ANGLE_PLATFORM_LINUX 1
28 #    define ANGLE_PLATFORM_POSIX 1
29 #elif defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__NetBSD__) ||              \
30     defined(__DragonFly__) || defined(__sun) || defined(__GLIBC__) || defined(__GNU__) || \
31     defined(__QNX__) || defined(__Fuchsia__) || defined(__HAIKU__)
32 #    define ANGLE_PLATFORM_POSIX 1
33 #else
34 #    error Unsupported platform.
35 #endif
36 
37 #ifdef ANGLE_PLATFORM_WINDOWS
38 #    ifndef STRICT
39 #        define STRICT 1
40 #    endif
41 #    ifndef WIN32_LEAN_AND_MEAN
42 #        define WIN32_LEAN_AND_MEAN 1
43 #    endif
44 #    ifndef NOMINMAX
45 #        define NOMINMAX 1
46 #    endif
47 
48 #    include <intrin.h>
49 
50 #    if defined(WINAPI_FAMILY) && (WINAPI_FAMILY != WINAPI_FAMILY_DESKTOP_APP)
51 #        define ANGLE_ENABLE_WINDOWS_UWP 1
52 #    endif
53 
54 #    if defined(ANGLE_ENABLE_D3D9)
55 #        include <d3d9.h>
56 #        include <d3dcompiler.h>
57 #    endif
58 
59 // Include D3D11 headers when OpenGL is enabled on Windows for interop extensions.
60 #    if defined(ANGLE_ENABLE_D3D11) || defined(ANGLE_ENABLE_OPENGL)
61 #        include <d3d10_1.h>
62 #        include <d3d11.h>
63 #        include <d3d11_3.h>
64 #        include <d3d11on12.h>
65 #        include <d3d12.h>
66 #        include <d3dcompiler.h>
67 #        include <dxgi.h>
68 #        include <dxgi1_2.h>
69 #        include <dxgi1_4.h>
70 #    endif
71 
72 #    if defined(ANGLE_ENABLE_D3D9) || defined(ANGLE_ENABLE_D3D11)
73 #        include <wrl.h>
74 #    endif
75 
76 #    if defined(ANGLE_ENABLE_WINDOWS_UWP)
77 #        include <dxgi1_3.h>
78 #        if defined(_DEBUG)
79 #            include <DXProgrammableCapture.h>
80 #            include <dxgidebug.h>
81 #        endif
82 #    endif
83 
84 // Macros 'near', 'far', 'NEAR' and 'FAR' are defined by 'shared/minwindef.h' in the Windows SDK.
85 // Macros 'near' and 'far' are empty. They are not used by other Windows headers and are undefined
86 // here to avoid identifier conflicts. Macros 'NEAR' and 'FAR' contain 'near' and 'far'. They are
87 // used by other Windows headers and are cleared here to avoid compilation errors.
88 #    undef near
89 #    undef far
90 #    undef NEAR
91 #    undef FAR
92 #    define NEAR
93 #    define FAR
94 #endif
95 
96 #if defined(_MSC_VER) && !defined(_M_ARM) && !defined(_M_ARM64)
97 #    include <intrin.h>
98 #    define ANGLE_USE_SSE
99 #elif defined(__GNUC__) && (defined(__x86_64__) || defined(__i386__))
100 #    include <x86intrin.h>
101 #    define ANGLE_USE_SSE
102 #endif
103 
104 // Mips and arm devices need to include stddef for size_t.
105 #if defined(__mips__) || defined(__arm__) || defined(__aarch64__)
106 #    include <stddef.h>
107 #endif
108 
109 // The MemoryBarrier function name collides with a macro under Windows
110 // We will undef the macro so that the function name does not get replaced
111 #undef MemoryBarrier
112 
113 // Macro for hinting that an expression is likely to be true/false.
114 #if !defined(ANGLE_LIKELY) || !defined(ANGLE_UNLIKELY)
115 #    if defined(__GNUC__) || defined(__clang__)
116 #        define ANGLE_LIKELY(x) __builtin_expect(!!(x), 1)
117 #        define ANGLE_UNLIKELY(x) __builtin_expect(!!(x), 0)
118 #    else
119 #        define ANGLE_LIKELY(x) (x)
120 #        define ANGLE_UNLIKELY(x) (x)
121 #    endif  // defined(__GNUC__) || defined(__clang__)
122 #endif      // !defined(ANGLE_LIKELY) || !defined(ANGLE_UNLIKELY)
123 
124 #ifdef ANGLE_PLATFORM_APPLE
125 #    include <TargetConditionals.h>
126 #    if TARGET_OS_OSX
127 #        define ANGLE_PLATFORM_MACOS 1
128 #    elif TARGET_OS_IPHONE
129 #        define ANGLE_PLATFORM_IOS 1
130 #        if TARGET_OS_SIMULATOR
131 #            define ANGLE_PLATFORM_IOS_SIMULATOR 1
132 #        endif
133 #        if TARGET_OS_MACCATALYST
134 #            define ANGLE_PLATFORM_MACCATALYST 1
135 #        endif
136 #    endif
137 #    // This might be useful globally. At the moment it is used
138 #    // to differentiate MacCatalyst on Intel and Apple Silicon.
139 #    if defined(__arm64__) || defined(__aarch64__)
140 #        define ANGLE_CPU_ARM64 1
141 #    endif
142 #    // EAGL should be enabled on iOS, but not Mac Catalyst unless it is running on Apple Silicon.
143 #    if (defined(ANGLE_PLATFORM_IOS) && !defined(ANGLE_PLATFORM_MACCATALYST)) || \
144         (defined(ANGLE_PLATFORM_MACCATALYST) && defined(ANGLE_CPU_ARM64))
145 #        define ANGLE_ENABLE_EAGL
146 #    endif
147 #    // Identify Metal API >= what shipped on macOS Catalina.
148 #    if (defined(ANGLE_PLATFORM_MACOS) && __MAC_OS_X_VERSION_MAX_ALLOWED >= 101500) || \
149         (defined(ANGLE_PLATFORM_IOS) && __IPHONE_OS_VERSION_MAX_ALLOWED >= 130000)
150 #        define ANGLE_WITH_MODERN_METAL_API 1
151 #    endif
152 #endif
153 
154 // Define ANGLE_WITH_ASAN macro.
155 #if defined(__has_feature)
156 #    if __has_feature(address_sanitizer)
157 #        define ANGLE_WITH_ASAN 1
158 #    endif
159 #endif
160 
161 // Define ANGLE_WITH_TSAN macro.
162 #if defined(__has_feature)
163 #    if __has_feature(thread_sanitizer)
164 #        define ANGLE_WITH_TSAN 1
165 #    endif
166 #endif
167 
168 // Define ANGLE_WITH_UBSAN macro.
169 #if defined(__has_feature)
170 #    if __has_feature(undefined_behavior_sanitizer)
171 #        define ANGLE_WITH_UBSAN 1
172 #    endif
173 #endif
174 
175 #if defined(ANGLE_WITH_ASAN) || defined(ANGLE_WITH_TSAN) || defined(ANGLE_WITH_UBSAN)
176 #    define ANGLE_WITH_SANITIZER 1
177 #endif  // defined(ANGLE_WITH_ASAN) || defined(ANGLE_WITH_TSAN) || defined(ANGLE_WITH_UBSAN)
178 
179 #include <cstdint>
180 #if INTPTR_MAX == INT64_MAX
181 #    define ANGLE_IS_64_BIT_CPU 1
182 #else
183 #    define ANGLE_IS_32_BIT_CPU 1
184 #endif
185 
186 #endif  // COMMON_PLATFORM_H_
187