[docs] Fix build-docs.sh
[llvm-project.git] / llvm / cmake / modules / CheckAtomic.cmake
blob3c5ba72993a3a189cc4703cb0106651d65e8a10b
1 # atomic builtins are required for threading support.
3 INCLUDE(CheckCXXSourceCompiles)
4 INCLUDE(CheckLibraryExists)
6 # Sometimes linking against libatomic is required for atomic ops, if
7 # the platform doesn't support lock-free atomics.
9 function(check_working_cxx_atomics varname)
10   set(OLD_CMAKE_REQUIRED_FLAGS ${CMAKE_REQUIRED_FLAGS})
11   set(CMAKE_REQUIRED_FLAGS "${CMAKE_REQUIRED_FLAGS} -std=c++11")
12   CHECK_CXX_SOURCE_COMPILES("
13 #include <atomic>
14 std::atomic<int> x;
15 std::atomic<short> y;
16 std::atomic<char> z;
17 int main() {
18   ++z;
19   ++y;
20   return ++x;
22 " ${varname})
23   set(CMAKE_REQUIRED_FLAGS ${OLD_CMAKE_REQUIRED_FLAGS})
24 endfunction(check_working_cxx_atomics)
26 function(check_working_cxx_atomics64 varname)
27   set(OLD_CMAKE_REQUIRED_FLAGS ${CMAKE_REQUIRED_FLAGS})
28   set(CMAKE_REQUIRED_FLAGS "-std=c++11 ${CMAKE_REQUIRED_FLAGS}")
29   CHECK_CXX_SOURCE_COMPILES("
30 #include <atomic>
31 #include <cstdint>
32 std::atomic<uint64_t> x (0);
33 int main() {
34   uint64_t i = x.load(std::memory_order_relaxed);
35   (void)i;
36   return 0;
38 " ${varname})
39   set(CMAKE_REQUIRED_FLAGS ${OLD_CMAKE_REQUIRED_FLAGS})
40 endfunction(check_working_cxx_atomics64)
43 # Check for (non-64-bit) atomic operations.
44 if(MSVC)
45   set(HAVE_CXX_ATOMICS_WITHOUT_LIB True)
46 elseif(LLVM_COMPILER_IS_GCC_COMPATIBLE OR CMAKE_CXX_COMPILER_ID MATCHES "XL")
47   # First check if atomics work without the library.
48   check_working_cxx_atomics(HAVE_CXX_ATOMICS_WITHOUT_LIB)
49   # If not, check if the library exists, and atomics work with it.
50   if(NOT HAVE_CXX_ATOMICS_WITHOUT_LIB)
51     check_library_exists(atomic __atomic_fetch_add_4 "" HAVE_LIBATOMIC)
52     if(HAVE_LIBATOMIC)
53       list(APPEND CMAKE_REQUIRED_LIBRARIES "atomic")
54       check_working_cxx_atomics(HAVE_CXX_ATOMICS_WITH_LIB)
55       if (NOT HAVE_CXX_ATOMICS_WITH_LIB)
56         message(FATAL_ERROR "Host compiler must support std::atomic!")
57       endif()
58     else()
59       message(FATAL_ERROR "Host compiler appears to require libatomic, but cannot find it.")
60     endif()
61   endif()
62 endif()
64 # Check for 64 bit atomic operations.
65 if(MSVC)
66   set(HAVE_CXX_ATOMICS64_WITHOUT_LIB True)
67 elseif(LLVM_COMPILER_IS_GCC_COMPATIBLE OR CMAKE_CXX_COMPILER_ID MATCHES "XL")
68   # First check if atomics work without the library.
69   check_working_cxx_atomics64(HAVE_CXX_ATOMICS64_WITHOUT_LIB)
70   # If not, check if the library exists, and atomics work with it.
71   if(NOT HAVE_CXX_ATOMICS64_WITHOUT_LIB)
72     check_library_exists(atomic __atomic_load_8 "" HAVE_CXX_LIBATOMICS64)
73     if(HAVE_CXX_LIBATOMICS64)
74       list(APPEND CMAKE_REQUIRED_LIBRARIES "atomic")
75       check_working_cxx_atomics64(HAVE_CXX_ATOMICS64_WITH_LIB)
76       if (NOT HAVE_CXX_ATOMICS64_WITH_LIB)
77         message(FATAL_ERROR "Host compiler must support 64-bit std::atomic!")
78       endif()
79     else()
80       message(FATAL_ERROR "Host compiler appears to require libatomic for 64-bit operations, but cannot find it.")
81     endif()
82   endif()
83 endif()
85 ## TODO: This define is only used for the legacy atomic operations in
86 ## llvm's Atomic.h, which should be replaced.  Other code simply
87 ## assumes C++11 <atomic> works.
88 CHECK_CXX_SOURCE_COMPILES("
89 #ifdef _MSC_VER
90 #include <windows.h>
91 #endif
92 int main() {
93 #ifdef _MSC_VER
94         volatile LONG val = 1;
95         MemoryBarrier();
96         InterlockedCompareExchange(&val, 0, 1);
97         InterlockedIncrement(&val);
98         InterlockedDecrement(&val);
99 #else
100         volatile unsigned long val = 1;
101         __sync_synchronize();
102         __sync_val_compare_and_swap(&val, 1, 0);
103         __sync_add_and_fetch(&val, 1);
104         __sync_sub_and_fetch(&val, 1);
105 #endif
106         return 0;
107       }
108 " LLVM_HAS_ATOMICS)
110 if( NOT LLVM_HAS_ATOMICS )
111   message(STATUS "Warning: LLVM will be built thread-unsafe because atomic builtins are missing")
112 endif()