2 * Copyright 2016 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 /* Define a convenience macro to test when address sanitizer is being used
37 * across the different compilers (e.g. clang, gcc) */
38 #if defined(__clang__)
39 # if __has_feature(address_sanitizer)
40 # define FOLLY_SANITIZE_ADDRESS 1
42 #elif defined (__GNUC__) && \
43 (((__GNUC__ == 4) && (__GNUC_MINOR__ >= 8)) || (__GNUC__ >= 5)) && \
45 # define FOLLY_SANITIZE_ADDRESS 1
48 /* Define attribute wrapper for function attribute used to disable
49 * address sanitizer instrumentation. Unfortunately, this attribute
50 * has issues when inlining is used, so disable that as well. */
51 #ifdef FOLLY_SANITIZE_ADDRESS
52 # if defined(__clang__)
53 # if __has_attribute(__no_sanitize__)
54 # define FOLLY_DISABLE_ADDRESS_SANITIZER \
55 __attribute__((__no_sanitize__("address"), __noinline__))
56 # elif __has_attribute(__no_address_safety_analysis__)
57 # define FOLLY_DISABLE_ADDRESS_SANITIZER \
58 __attribute__((__no_address_safety_analysis__, __noinline__))
59 # elif __has_attribute(__no_sanitize_address__)
60 # define FOLLY_DISABLE_ADDRESS_SANITIZER \
61 __attribute__((__no_sanitize_address__, __noinline__))
63 # elif defined(__GNUC__)
64 # define FOLLY_DISABLE_ADDRESS_SANITIZER \
65 __attribute__((__no_address_safety_analysis__, __noinline__))
68 #ifndef FOLLY_DISABLE_ADDRESS_SANITIZER
69 # define FOLLY_DISABLE_ADDRESS_SANITIZER
72 /* Define a convenience macro to test when thread sanitizer is being used
73 * across the different compilers (e.g. clang, gcc) */
74 #if defined(__clang__)
75 # if __has_feature(thread_sanitizer)
76 # define FOLLY_SANITIZE_THREAD 1
78 #elif defined(__GNUC__) && __SANITIZE_THREAD__
79 # define FOLLY_SANITIZE_THREAD 1
83 * ASAN/MSAN/TSAN define pre-processor symbols:
84 * ADDRESS_SANITIZER/MEMORY_SANITIZER/THREAD_SANITIZER.
86 * UBSAN doesn't define anything and makes it hard to
87 * conditionally compile.
89 * The build system should define UNDEFINED_SANITIZER=1 when UBSAN is
90 * used as folly whitelists some functions.
92 #if UNDEFINED_SANITIZER
93 # define UBSAN_DISABLE(x) __attribute__((no_sanitize(x)))
95 # define UBSAN_DISABLE(x)
96 #endif // UNDEFINED_SANITIZER
99 * Macro for marking functions as having public visibility.
101 #if defined(__GNUC__)
102 # if __GNUC_PREREQ(4, 9)
103 # define FOLLY_EXPORT [[gnu::visibility("default")]]
105 # define FOLLY_EXPORT __attribute__((__visibility__("default")))
108 # define FOLLY_EXPORT