cmake/ThreadMPI.cmake

   1 # This source code file is part of thread_mpi.
   2 # Written by Sander Pronk, Erik Lindahl, and possibly others.
   3 #
   4 # Copyright (c) 2009, Sander Pronk, Erik Lindahl.
   5 # All rights reserved.
   6 #
   7 # Redistribution and use in source and binary forms, with or without
   8 # modification, are permitted provided that the following conditions are met:
   9 # 1) Redistributions of source code must retain the above copyright
  10 # notice, this list of conditions and the following disclaimer.
  11 # 2) Redistributions in binary form must reproduce the above copyright
  12 # notice, this list of conditions and the following disclaimer in the
  13 # documentation and/or other materials provided with the distribution.
  14 # 3) Neither the name of the copyright holders nor the
  15 # names of its contributors may be used to endorse or promote products
  16 # derived from this software without specific prior written permission.
  17 #
  18 # THIS SOFTWARE IS PROVIDED BY US ''AS IS'' AND ANY
  19 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  20 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  21 # DISCLAIMED. IN NO EVENT SHALL WE BE LIABLE FOR ANY
  22 # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  24 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  25 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 #
  29 # If you want to redistribute modifications, please consider that
  30 # scientific software is very special. Version control is crucial -
  31 # bugs must be traceable. We will be happy to consider code for
  32 # inclusion in the official distribution, but derived work should not
  33 # be called official thread_mpi. Details are found in the README & COPYING
  34 # files.
  35
  36 include(CheckIncludeFiles)
  37 include(CheckFunctionExists)
  38 include(CheckCSourceCompiles)
  39
  40 # sets TMPI_ATOMICS to 1 if atomic operations are found, 0 otherwise
  41 # Options:
  42 # include directory for thread_mpi/atomic.h
  43 MACRO(TMPI_TEST_ATOMICS INCDIR)
  44     if (NOT DEFINED TMPI_ATOMICS)
  45         try_compile(TEST_ATOMICS "${CMAKE_BINARY_DIR}"
  46                 "${CMAKE_SOURCE_DIR}/cmake/TestAtomics.c"
  47                 COMPILE_DEFINITIONS "-I${INCDIR}")
  48         if (TEST_ATOMICS)
  49             message(STATUS "Atomic operations found")
  50         else (TEST_ATOMICS)
  51             message(STATUS "Atomic operations not found")
  52         endif(TEST_ATOMICS)
  53         set(TMPI_ATOMICS ${TEST_ATOMICS} CACHE INTERNAL "Whether atomic operations are found")
  54         set(TMPI_ATOMICS_INCDIR ${INCDIR} CACHE INTERNAL "Atomic operations check include dir")
  55     endif(NOT DEFINED TMPI_ATOMICS)
  56 ENDMACRO(TMPI_TEST_ATOMICS VARIABLE)
  57
  58
  59 include(FindThreads)
  60 if (CMAKE_USE_PTHREADS_INIT)
  61     check_include_files(pthread.h    HAVE_PTHREAD_H)
  62     set(THREAD_PTHREADS 1)
  63     set(THREAD_LIB ${CMAKE_THREAD_LIBS_INIT})
  64 elseif (CMAKE_USE_WIN32_THREADS_INIT)
  65     set(THREAD_WINDOWS 1)
  66     set(THREAD_LIB)
  67 else ()
  68     message(FATAL_ERROR "Thread support required")
  69 endif (CMAKE_USE_PTHREADS_INIT)
  70
  71 # Turns on thread_mpi core threading functions.
  72 MACRO(TMPI_ENABLE_CORE INCDIR)
  73     TMPI_TEST_ATOMICS(${INCDIR})
  74
  75 # affinity checks
  76     include(CheckFunctionExists)
  77     if (THREAD_PTHREADS)
  78         set(CMAKE_REQUIRED_LIBRARIES ${CMAKE_THREAD_LIBS_INIT})
  79         # check for sched_setaffinity
  80         check_c_source_compiles(
  81             "#define _GNU_SOURCE
  82 #include <pthread.h>
  83 #include <stdlib.h>
  84 #include <stdio.h>
  85 #include <errno.h>
  86     int main(void) { cpu_set_t set;
  87         CPU_ZERO(&set);
  88         CPU_SET(0, &set);
  89         pthread_setaffinity_np(pthread_self(), sizeof(set), &set);
  90         return 0;
  91     }"
  92             PTHREAD_SETAFFINITY
  93         )
  94         if (PTHREAD_SETAFFINITY)
  95             set(HAVE_PTHREAD_SETAFFINITY 1)
  96         endif (PTHREAD_SETAFFINITY)
  97         set(CMAKE_REQUIRED_LIBRARIES)
  98     endif (THREAD_PTHREADS)
  99
 100
 101 # this runs on POSIX systems
 102     check_include_files(unistd.h        HAVE_UNISTD_H)
 103     check_include_files(sched.h         HAVE_SCHED_H)
 104     check_include_files(sys/time.h      HAVE_SYS_TIME_H)
 105     check_function_exists(sysconf       HAVE_SYSCONF)
 106 # this runs on windows
 107 #check_include_files(windows.h          HAVE_WINDOWS_H)
 108 ENDMACRO(TMPI_ENABLE_CORE)
 109
 110 # enable C++ library build.
 111 MACRO(TMPI_ENABLE_CXX)
 112     set(TMPI_CXX_LIB 1)
 113 ENDMACRO(TMPI_ENABLE_CXX)
 114
 115 # Turns on thread_mpi MPI functions.
 116 MACRO(TMPI_ENABLE)
 117     # first check whether threads and atomics are available.
 118     if(NOT TMPI_ATOMICS)
 119         # check again, to allow the user to fix this.
 120         unset(TMPI_ATOMICS CACHE)
 121         TMPI_TEST_ATOMICS(${TMPI_ATOMICS_INCDIR})
 122     endif(NOT TMPI_ATOMICS)
 123     if(NOT TMPI_ATOMICS)
 124         message(WARNING "Atomic operations not found for this CPU+compiler combination. Thread support will be unbearably slow: disable threads. Atomic operations should work on all but the most obscure CPU+compiler combinations; if your system is not obscure -- like, for example, x86 with gcc --  please contact the developers.")
 125     endif(NOT TMPI_ATOMICS)
 126
 127     set(TMPI_ENABLED 1)
 128
 129 # the spin-waiting option
 130     option(THREAD_MPI_WAIT_FOR_NO_ONE "Use busy waits without yielding to the OS scheduler. Turning this on might improve performance (very) slightly at the cost of very poor performance if the threads are competing for CPU time." OFF)
 131     mark_as_advanced(THREAD_MPI_WAIT_FOR_NO_ONE)
 132     if (THREAD_MPI_WAIT_FOR_NO_ONE)
 133         set(TMPI_WAIT_FOR_NO_ONE 1)
 134     else (THREAD_MPI_WAIT_FOR_NO_ONE)
 135         set(TMPI_WAIT_FOR_NO_ONE 0)
 136     endif (THREAD_MPI_WAIT_FOR_NO_ONE)
 137
 138 # the copy buffer option
 139     option(THREAD_MPI_COPY_BUFFER "Use an intermediate copy buffer for small message sizes, to allow blocking sends to return quickly. Only useful in programs with relatively uncoupled threads (infrequent MPI communication)" OFF)
 140     mark_as_advanced(THREAD_MPI_COPY_BUFFER)
 141     if (THREAD_MPI_COPY_BUFFER)
 142         set(TMPI_COPY_BUFFER 1)
 143     else (THREAD_MPI_COPY_BUFFER)
 144         set(TMPI_COPY_BUFFER 0)
 145     endif (THREAD_MPI_COPY_BUFFER)
 146
 147 # the profiling option
 148     option(THREAD_MPI_PROFILING "Turn on simple MPI profiling." OFF)
 149     mark_as_advanced(THREAD_MPI_PROFILING)
 150     if (THREAD_MPI_PROFILING)
 151         set(TMPI_PROFILE 1)
 152     else (THREAD_MPI_PROFILING)
 153         set(TMPI_PROFILE 0)
 154     endif (THREAD_MPI_PROFILING)
 155
 156 # tmpi warnings for testing
 157     option(THREAD_MPI_WARNINGS "Turn thread_mpi warnings for testing." OFF)
 158     mark_as_advanced(THREAD_MPI_WARNINGS)
 159     if (THREAD_MPI_WARNINGS)
 160         set(TMPI_WARNINGS 1)
 161     else (THREAD_MPI_WARNINGS)
 162         set(TMPI_WARNINGS 0)
 163     endif (THREAD_MPI_WARNINGS)
 164
 165     include(CheckCSourceCompiles)
 166 ENDMACRO(TMPI_ENABLE)
 167
 168
 169 MACRO(TMPI_GET_SOURCE_LIST SRC_VARIABLE)
 170     set(${SRC_VARIABLE}
 171         thread_mpi/errhandler.c
 172         thread_mpi/tmpi_malloc.c
 173         thread_mpi/atomic.c)
 174     if (THREAD_PTHREADS)
 175         list(APPEND ${SRC_VARIABLE} thread_mpi/pthreads.c)
 176     elseif (THREAD_WINDOWS)
 177         list(APPEND ${SRC_VARIABLE} thread_mpi/winthreads.c)
 178     endif (THREAD_PTHREADS)
 179     if (TMPI_CXX_LIB)
 180         list(APPEND ${SRC_VARIABLE} thread_mpi/system_error.cpp)
 181     endif (TMPI_CXX_LIB)
 182     if (TMPI_ENABLED)
 183         list(APPEND ${SRC_VARIABLE}
 184              thread_mpi/alltoall.c      thread_mpi/p2p_protocol.c
 185              thread_mpi/barrier.c       thread_mpi/p2p_send_recv.c
 186              thread_mpi/bcast.c         thread_mpi/p2p_wait.c
 187              thread_mpi/collective.c    thread_mpi/profile.c
 188              thread_mpi/comm.c          thread_mpi/reduce.c
 189              thread_mpi/event.c         thread_mpi/reduce_fast.c
 190              thread_mpi/gather.c        thread_mpi/scatter.c
 191              thread_mpi/group.c         thread_mpi/tmpi_init.c
 192              thread_mpi/topology.c      thread_mpi/list.c
 193              thread_mpi/type.c          thread_mpi/lock.c
 194              thread_mpi/numa_malloc.c   thread_mpi/once.c
 195              thread_mpi/scan.c)
 196     endif()
 197 ENDMACRO(TMPI_GET_SOURCE_LIST)
 198