2 * Copyright 2017 Facebook, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 /* These definitions are in a separate file so that they
20 * may be included from C- as well as C++-based projects. */
23 * Portable version check.
26 # if defined __GNUC__ && defined __GNUC_MINOR__
28 # define __GNUC_PREREQ(maj, min) ((__GNUC__ << 16) + __GNUC_MINOR__ >= \
29 ((maj) << 16) + (min))
32 # define __GNUC_PREREQ(maj, min) 0
36 // portable version check for clang
37 #ifndef __CLANG_PREREQ
38 # if defined __clang__ && defined __clang_major__ && defined __clang_minor__
40 # define __CLANG_PREREQ(maj, min) \
41 ((__clang_major__ << 16) + __clang_minor__ >= ((maj) << 16) + (min))
44 # define __CLANG_PREREQ(maj, min) 0
48 #if defined(__has_builtin)
49 #define FOLLY_HAS_BUILTIN(...) __has_builtin(__VA_ARGS__)
51 #define FOLLY_HAS_BUILTIN(...) 0
54 #if defined(__has_feature)
55 #define FOLLY_HAS_FEATURE(...) __has_feature(__VA_ARGS__)
57 #define FOLLY_HAS_FEATURE(...) 0
60 /* Define a convenience macro to test when address sanitizer is being used
61 * across the different compilers (e.g. clang, gcc) */
62 #if FOLLY_HAS_FEATURE(address_sanitizer) || __SANITIZE_ADDRESS__
63 # define FOLLY_SANITIZE_ADDRESS 1
66 /* Define attribute wrapper for function attribute used to disable
67 * address sanitizer instrumentation. Unfortunately, this attribute
68 * has issues when inlining is used, so disable that as well. */
69 #ifdef FOLLY_SANITIZE_ADDRESS
70 # if defined(__clang__)
71 # if __has_attribute(__no_sanitize__)
72 # define FOLLY_DISABLE_ADDRESS_SANITIZER \
73 __attribute__((__no_sanitize__("address"), __noinline__))
74 # elif __has_attribute(__no_address_safety_analysis__)
75 # define FOLLY_DISABLE_ADDRESS_SANITIZER \
76 __attribute__((__no_address_safety_analysis__, __noinline__))
77 # elif __has_attribute(__no_sanitize_address__)
78 # define FOLLY_DISABLE_ADDRESS_SANITIZER \
79 __attribute__((__no_sanitize_address__, __noinline__))
81 # elif defined(__GNUC__)
82 # define FOLLY_DISABLE_ADDRESS_SANITIZER \
83 __attribute__((__no_address_safety_analysis__, __noinline__))
86 #ifndef FOLLY_DISABLE_ADDRESS_SANITIZER
87 # define FOLLY_DISABLE_ADDRESS_SANITIZER
90 /* Define a convenience macro to test when thread sanitizer is being used
91 * across the different compilers (e.g. clang, gcc) */
92 #if FOLLY_HAS_FEATURE(thread_sanitizer) || __SANITIZE_THREAD__
93 # define FOLLY_SANITIZE_THREAD 1
97 * Define a convenience macro to test when ASAN, UBSAN or TSAN sanitizer are
100 #if defined(FOLLY_SANITIZE_ADDRESS) || defined(FOLLY_SANITIZE_THREAD) || \
101 defined(UNDEFINED_SANITIZER)
102 #define FOLLY_SANITIZE 1
106 * ASAN/MSAN/TSAN define pre-processor symbols:
107 * ADDRESS_SANITIZER/MEMORY_SANITIZER/THREAD_SANITIZER.
109 * UBSAN doesn't define anything and makes it hard to
110 * conditionally compile.
112 * The build system should define UNDEFINED_SANITIZER=1 when UBSAN is
113 * used as folly whitelists some functions.
115 #if UNDEFINED_SANITIZER
116 #define FOLLY_DISABLE_UNDEFINED_BEHAVIOR_SANITIZER(...) \
117 __attribute__((no_sanitize(__VA_ARGS__)))
119 #define FOLLY_DISABLE_UNDEFINED_BEHAVIOR_SANITIZER(...)
120 #endif // UNDEFINED_SANITIZER
123 * Macro for marking functions as having public visibility.
125 #if defined(__GNUC__)
126 # if __GNUC_PREREQ(4, 9)
127 # define FOLLY_EXPORT [[gnu::visibility("default")]]
129 # define FOLLY_EXPORT __attribute__((__visibility__("default")))
132 # define FOLLY_EXPORT
137 # define FOLLY_NOINLINE __declspec(noinline)
138 #elif defined(__clang__) || defined(__GNUC__)
139 # define FOLLY_NOINLINE __attribute__((__noinline__))
141 # define FOLLY_NOINLINE
146 # define FOLLY_ALWAYS_INLINE __forceinline
147 #elif defined(__clang__) || defined(__GNUC__)
148 # define FOLLY_ALWAYS_INLINE inline __attribute__((__always_inline__))
150 # define FOLLY_ALWAYS_INLINE inline
155 #define FOLLY_ATTR_VISIBILITY_HIDDEN
156 #elif defined(__clang__) || defined(__GNUC__)
157 #define FOLLY_ATTR_VISIBILITY_HIDDEN __attribute__((__visibility__("hidden")))
159 #define FOLLY_ATTR_VISIBILITY_HIDDEN