SkPreConfig.h revision 05332d9c8aefe00c361c893410deca33f4438695 
1/*
2 * Copyright 2006 The Android Open Source Project
3 *
4 * Use of this source code is governed by a BSD-style license that can be
5 * found in the LICENSE file.
6 */
7
8// IWYU pragma: private, include "SkTypes.h"
9
10#ifndef SkPreConfig_DEFINED
11#define SkPreConfig_DEFINED
12
13// Allows embedders that want to disable macros that take arguments to just
14// define that symbol to be one of these
15#define SK_NOTHING_ARG1(arg1)
16#define SK_NOTHING_ARG2(arg1, arg2)
17#define SK_NOTHING_ARG3(arg1, arg2, arg3)
18
19//////////////////////////////////////////////////////////////////////
20
21#if !defined(SK_BUILD_FOR_ANDROID) && !defined(SK_BUILD_FOR_IOS) && !defined(SK_BUILD_FOR_WIN32) && !defined(SK_BUILD_FOR_UNIX) && !defined(SK_BUILD_FOR_MAC)
22
23    #ifdef __APPLE__
24        #include "TargetConditionals.h"
25    #endif
26
27    #if defined(WIN32) || defined(__SYMBIAN32__)
28        #define SK_BUILD_FOR_WIN32
29    #elif defined(ANDROID)
30        #define SK_BUILD_FOR_ANDROID
31    #elif defined(linux) || defined(__linux) || defined(__FreeBSD__) || \
32          defined(__OpenBSD__) || defined(__sun) || defined(__NetBSD__) || \
33          defined(__DragonFly__) || defined(__GLIBC__) || defined(__GNU__) || \
34          defined(__unix__)
35        #define SK_BUILD_FOR_UNIX
36    #elif TARGET_OS_IPHONE || TARGET_IPHONE_SIMULATOR
37        #define SK_BUILD_FOR_IOS
38    #else
39        #define SK_BUILD_FOR_MAC
40    #endif
41
42#endif
43
44/* Even if the user only defined the framework variant we still need to build
45 * the default (NDK-compliant) Android code. Therefore, when attempting to
46 * include/exclude something from the framework variant check first that we are
47 * building for Android then check the status of the framework define.
48 */
49#if defined(SK_BUILD_FOR_ANDROID_FRAMEWORK) && !defined(SK_BUILD_FOR_ANDROID)
50    #define SK_BUILD_FOR_ANDROID
51#endif
52
53//////////////////////////////////////////////////////////////////////
54
55#if !defined(SK_DEBUG) && !defined(SK_RELEASE)
56    #ifdef NDEBUG
57        #define SK_RELEASE
58    #else
59        #define SK_DEBUG
60    #endif
61#endif
62
63#ifdef SK_BUILD_FOR_WIN32
64    #if !defined(SK_RESTRICT)
65        #define SK_RESTRICT __restrict
66    #endif
67    #if !defined(SK_WARN_UNUSED_RESULT)
68        #define SK_WARN_UNUSED_RESULT
69    #endif
70#endif
71
72//////////////////////////////////////////////////////////////////////
73
74#if !defined(SK_RESTRICT)
75    #define SK_RESTRICT __restrict__
76#endif
77
78#if !defined(SK_WARN_UNUSED_RESULT)
79    #define SK_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
80#endif
81
82//////////////////////////////////////////////////////////////////////
83
84#if !defined(SK_CPU_BENDIAN) && !defined(SK_CPU_LENDIAN)
85    #if defined(__sparc) || defined(__sparc__) || \
86      defined(_POWER) || defined(__powerpc__) || \
87      defined(__ppc__) || defined(__hppa) || \
88      defined(__PPC__) || defined(__PPC64__) || \
89      defined(_MIPSEB) || defined(__ARMEB__) || \
90      defined(__s390__) || \
91      (defined(__sh__) && defined(__BIG_ENDIAN__)) || \
92      (defined(__ia64) && defined(__BIG_ENDIAN__))
93         #define SK_CPU_BENDIAN
94    #else
95        #define SK_CPU_LENDIAN
96    #endif
97#endif
98
99//////////////////////////////////////////////////////////////////////
100
101#if defined(__i386) || defined(_M_IX86) ||  defined(__x86_64__) || defined(_M_X64)
102  #define SK_CPU_X86 1
103#endif
104
105/**
106 *  SK_CPU_SSE_LEVEL
107 *
108 *  If defined, SK_CPU_SSE_LEVEL should be set to the highest supported level.
109 *  On non-intel CPU this should be undefined.
110 */
111
112#define SK_CPU_SSE_LEVEL_SSE1     10
113#define SK_CPU_SSE_LEVEL_SSE2     20
114#define SK_CPU_SSE_LEVEL_SSE3     30
115#define SK_CPU_SSE_LEVEL_SSSE3    31
116#define SK_CPU_SSE_LEVEL_SSE41    41
117#define SK_CPU_SSE_LEVEL_SSE42    42
118#define SK_CPU_SSE_LEVEL_AVX      51
119#define SK_CPU_SSE_LEVEL_AVX2     52
120
121// Are we in GCC?
122#ifndef SK_CPU_SSE_LEVEL
123    // These checks must be done in descending order to ensure we set the highest
124    // available SSE level.
125    #if defined(__AVX2__)
126        #define SK_CPU_SSE_LEVEL    SK_CPU_SSE_LEVEL_AVX2
127    #elif defined(__AVX__)
128        #define SK_CPU_SSE_LEVEL    SK_CPU_SSE_LEVEL_AVX
129    #elif defined(__SSE4_2__)
130        #define SK_CPU_SSE_LEVEL    SK_CPU_SSE_LEVEL_SSE42
131    #elif defined(__SSE4_1__)
132        #define SK_CPU_SSE_LEVEL    SK_CPU_SSE_LEVEL_SSE41
133    #elif defined(__SSSE3__)
134        #define SK_CPU_SSE_LEVEL    SK_CPU_SSE_LEVEL_SSSE3
135    #elif defined(__SSE3__)
136        #define SK_CPU_SSE_LEVEL    SK_CPU_SSE_LEVEL_SSE3
137    #elif defined(__SSE2__)
138        #define SK_CPU_SSE_LEVEL    SK_CPU_SSE_LEVEL_SSE2
139    #endif
140#endif
141
142// Are we in VisualStudio?
143#ifndef SK_CPU_SSE_LEVEL
144    // These checks must be done in descending order to ensure we set the highest
145    // available SSE level. 64-bit intel guarantees at least SSE2 support.
146    #if defined(__AVX2__)
147        #define SK_CPU_SSE_LEVEL        SK_CPU_SSE_LEVEL_AVX2
148    #elif defined(__AVX__)
149        #define SK_CPU_SSE_LEVEL        SK_CPU_SSE_LEVEL_AVX
150    #elif defined(_M_X64) || defined(_M_AMD64)
151        #define SK_CPU_SSE_LEVEL        SK_CPU_SSE_LEVEL_SSE2
152    #elif defined(_M_IX86_FP)
153        #if _M_IX86_FP >= 2
154            #define SK_CPU_SSE_LEVEL    SK_CPU_SSE_LEVEL_SSE2
155        #elif _M_IX86_FP == 1
156            #define SK_CPU_SSE_LEVEL    SK_CPU_SSE_LEVEL_SSE1
157        #endif
158    #endif
159#endif
160
161//////////////////////////////////////////////////////////////////////
162// ARM defines
163
164#if defined(__arm__) && (!defined(__APPLE__) || !TARGET_IPHONE_SIMULATOR)
165    #define SK_CPU_ARM32
166
167    #if defined(__GNUC__)
168        #if defined(__ARM_ARCH_7__) || defined(__ARM_ARCH_7A__) \
169                || defined(__ARM_ARCH_7R__) || defined(__ARM_ARCH_7M__) \
170                || defined(__ARM_ARCH_7EM__) || defined(_ARM_ARCH_7)
171            #define SK_ARM_ARCH 7
172        #elif defined(__ARM_ARCH_6__) || defined(__ARM_ARCH_6J__) \
173                || defined(__ARM_ARCH_6K__) || defined(__ARM_ARCH_6Z__) \
174                || defined(__ARM_ARCH_6ZK__) || defined(__ARM_ARCH_6T2__) \
175                || defined(__ARM_ARCH_6M__) || defined(_ARM_ARCH_6)
176            #define SK_ARM_ARCH 6
177        #elif defined(__ARM_ARCH_5__) || defined(__ARM_ARCH_5T__) \
178                || defined(__ARM_ARCH_5E__) || defined(__ARM_ARCH_5TE__) \
179                || defined(__ARM_ARCH_5TEJ__) || defined(_ARM_ARCH_5)
180            #define SK_ARM_ARCH 5
181        #elif defined(__ARM_ARCH_4__) || defined(__ARM_ARCH_4T__) || defined(_ARM_ARCH_4)
182            #define SK_ARM_ARCH 4
183        #else
184            #define SK_ARM_ARCH 3
185        #endif
186    #endif
187#endif
188
189// Disable ARM64 optimizations for iOS due to complications regarding gyp and iOS.
190#if defined(__aarch64__) && !defined(SK_BUILD_FOR_IOS)
191    #define SK_CPU_ARM64
192#endif
193
194// All 64-bit ARM chips have NEON.  Many 32-bit ARM chips do too.
195// TODO: Why don't we want NEON on iOS?
196#if !defined(SK_ARM_HAS_NEON) && !defined(SK_BUILD_FOR_IOS) && (defined(__ARM_NEON__) || defined(__ARM_NEON))
197    #define SK_ARM_HAS_NEON
198#endif
199
200//////////////////////////////////////////////////////////////////////
201
202#if !defined(SKIA_IMPLEMENTATION)
203    #define SKIA_IMPLEMENTATION 0
204#endif
205
206#if defined(SKIA_DLL)
207    #if defined(WIN32)
208        #if SKIA_IMPLEMENTATION
209            #define SK_API __declspec(dllexport)
210        #else
211            #define SK_API __declspec(dllimport)
212        #endif
213    #else
214        #define SK_API __attribute__((visibility("default")))
215    #endif
216#else
217    #define SK_API
218#endif
219
220//////////////////////////////////////////////////////////////////////
221
222/**
223 * Use SK_PURE_FUNC as an attribute to indicate that a function's
224 * return value only depends on the value of its parameters. This
225 * can help the compiler optimize out successive calls.
226 *
227 * Usage:
228 *      void  function(int params)  SK_PURE_FUNC;
229 */
230#if defined(__GNUC__)
231#  define  SK_PURE_FUNC  __attribute__((pure))
232#else
233#  define  SK_PURE_FUNC  /* nothing */
234#endif
235
236//////////////////////////////////////////////////////////////////////
237
238/**
239 * SK_HAS_ATTRIBUTE(<name>) should return true iff the compiler
240 * supports __attribute__((<name>)). Mostly important because
241 * Clang doesn't support all of GCC attributes.
242 */
243#if defined(__has_attribute)
244#   define SK_HAS_ATTRIBUTE(x) __has_attribute(x)
245#elif defined(__GNUC__)
246#   define SK_HAS_ATTRIBUTE(x) 1
247#else
248#   define SK_HAS_ATTRIBUTE(x) 0
249#endif
250
251/**
252 * SK_ATTRIBUTE_OPTIMIZE_O1 can be used as a function attribute
253 * to specify individual optimization level of -O1, if the compiler
254 * supports it.
255 *
256 * NOTE: Clang/ARM (r161757) does not support the 'optimize' attribute.
257 */
258#if SK_HAS_ATTRIBUTE(optimize)
259#   define SK_ATTRIBUTE_OPTIMIZE_O1 __attribute__((optimize("O1")))
260#else
261#   define SK_ATTRIBUTE_OPTIMIZE_O1 /* nothing */
262#endif
263
264#endif
265