Revised processor-specific hints for back-off
[libcds.git] / cds / compiler / clang / defs.h
1 /*
2     This file is a part of libcds - Concurrent Data Structures library
3
4     (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2017
5
6     Source code repo: http://github.com/khizmax/libcds/
7     Download: http://sourceforge.net/projects/libcds/files/
8
9     Redistribution and use in source and binary forms, with or without
10     modification, are permitted provided that the following conditions are met:
11
12     * Redistributions of source code must retain the above copyright notice, this
13       list of conditions and the following disclaimer.
14
15     * Redistributions in binary form must reproduce the above copyright notice,
16       this list of conditions and the following disclaimer in the documentation
17       and/or other materials provided with the distribution.
18
19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27     OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31 #ifndef CDSLIB_COMPILER_CLANG_DEFS_H
32 #define CDSLIB_COMPILER_CLANG_DEFS_H
33
34 // Compiler version
35 #define CDS_COMPILER_VERSION (__clang_major__ * 10000 + __clang_minor__ * 100 + __clang_patchlevel__)
36
37 // Compiler name
38 #define  CDS_COMPILER__NAME    ("clang " __clang_version__)
39 #define  CDS_COMPILER__NICK    "clang"
40
41 #if CDS_COMPILER_VERSION < 30600
42 #   error "Compiler version error. Clang version 3.6.0 and above is supported"
43 #endif
44
45 #if defined(_LIBCPP_VERSION) && !defined(CDS_USE_BOOST_ATOMIC) && CDS_COMPILER_VERSION < 30700
46     // Note: Clang libc++ atomic leads to program crash.
47     // So, we use libcds atomic implementation
48 #   define CDS_USE_LIBCDS_ATOMIC
49 #endif
50
51 // clang for Windows
52 #if defined( _MSC_VER )
53 #   define CDS_OS_INTERFACE     CDS_OSI_WINDOWS
54 #   if defined(_WIN64)
55 #       define CDS_OS_TYPE      CDS_OS_WIN64
56 #       define CDS_OS__NAME     "Win64"
57 #       define CDS_OS__NICK     "Win64"
58 #   elif defined(_WIN32)
59 #       define CDS_OS_TYPE      CDS_OS_WIN32
60 #       define CDS_OS__NAME     "Win32"
61 #       define CDS_OS__NICK     "Win32"
62 #   endif
63 #endif
64
65 #include <cds/compiler/gcc/compiler_macro.h>
66
67 #define alignof __alignof__
68
69 // C++11 inline namespace
70 #define CDS_CXX11_INLINE_NAMESPACE_SUPPORT
71
72 #define CDS_CONSTEXPR    constexpr
73
74 #define CDS_NOEXCEPT_SUPPORT        noexcept
75 #define CDS_NOEXCEPT_SUPPORT_(expr) noexcept(expr)
76
77 // C++11 thread_local keyword
78 #if !(CDS_OS_TYPE == CDS_OS_OSX && CDS_COMPILER_VERSION < 30600)
79     // OS X error?
80     // See http://stackoverflow.com/questions/23791060/c-thread-local-storage-clang-503-0-40-mac-osx
81     // http://stackoverflow.com/questions/28094794/why-does-apple-clang-disallow-c11-thread-local-when-official-clang-supports
82     // clang 3.6 ok?..
83 #   define CDS_CXX11_THREAD_LOCAL_SUPPORT
84 #endif
85
86 // Full SFINAE support
87 #define CDS_CXX11_SFINAE
88
89 // Inheriting constructors
90 #define CDS_CXX11_INHERITING_CTOR
91
92 // Attributes
93 #if CDS_COMPILER_VERSION >= 30400
94 #   if __cplusplus < 201103
95 #       define CDS_DEPRECATED( reason ) __attribute__((deprecated( reason )))
96 #   elif __cplusplus == 201103 // C++11
97 #       define CDS_DEPRECATED( reason ) [[gnu::deprecated(reason)]]
98 #   else  // C++14
99 #       define CDS_DEPRECATED( reason ) [[deprecated(reason)]]
100 #   endif
101 #else
102 #   define CDS_DEPRECATED( reason ) __attribute__((deprecated( reason )))
103 #endif
104
105 #define CDS_NORETURN __attribute__((__noreturn__))
106
107 // *************************************************
108 // Features
109 #if defined(__has_feature) && __has_feature(thread_sanitizer)
110 #   define CDS_THREAD_SANITIZER_ENABLED
111 #endif
112
113 #if defined(__has_feature) && __has_feature(address_sanitizer)
114 #   ifndef CDS_ADDRESS_SANITIZER_ENABLED
115 #       define CDS_ADDRESS_SANITIZER_ENABLED
116 #   endif
117 #endif
118
119
120 // *************************************************
121 // Alignment macro
122
123 #define CDS_TYPE_ALIGNMENT(n)   __attribute__ ((aligned (n)))
124 #define CDS_CLASS_ALIGNMENT(n)  __attribute__ ((aligned (n)))
125 #define CDS_DATA_ALIGNMENT(n)   __attribute__ ((aligned (n)))
126
127
128 // likely/unlikely
129
130 #define cds_likely( expr )   __builtin_expect( !!( expr ), 1 )
131 #define cds_unlikely( expr ) __builtin_expect( !!( expr ), 0 )
132
133 // Exceptions
134
135 #if defined( __EXCEPTIONS ) && __EXCEPTIONS == 1
136 #   define CDS_EXCEPTION_ENABLED
137 #endif
138
139
140 // double-width CAS support - only for libc++
141 #ifdef _LIBCPP_VERSION
142 #   if CDS_BUILD_BITS == 64
143 #       ifdef __GCC_HAVE_SYNC_COMPARE_AND_SWAP_16
144 #           define CDS_DCAS_SUPPORT
145 #       endif
146 #   else
147 #       ifdef __GCC_HAVE_SYNC_COMPARE_AND_SWAP_8
148 #           define CDS_DCAS_SUPPORT
149 #       endif
150 #   endif
151 #endif
152
153 #include <cds/compiler/gcc/compiler_barriers.h>
154
155 #endif // #ifndef CDSLIB_COMPILER_GCC_DEFS_H