Add initial support for python bindings
[alexxy/gromacs.git] / cmake / FindFFTW.cmake
index 5905c465643ee530f6589d6beef6baec94558113..326805a163df244547184e715a4f0e03ff61b9d0 100644 (file)
@@ -1,36 +1,58 @@
-# - Find FFTW 2/3 single double
-# Find the native FFTW headers and libraries.
 #
-#  FFTW_INCLUDE_DIRS - where to find FFTW headers
-#  FFTW_LIBRARIES    - List of libraries when using FFTW.
-#  FFTW_PKG          - The name of the pkg-config package needed
-#  FFTW_HAVE_SSE     - True if FFTW was build with SSE support
-#  FFTW_FOUND        - True if FFTW was found
+# This file is part of the GROMACS molecular simulation package.
 #
-#  This file is part of Gromacs        Copyright (c) 2012
-
-#  This program is free software; you can redistribute it and/or
-#  modify it under the terms of the GNU General Public License
-#  as published by the Free Software Foundation; either version 2
-#  of the License, or (at your option) any later version.
+# Copyright (c) 2012,2013,2014, by the GROMACS development team, led by
+# Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
+# and including many others, as listed in the AUTHORS file in the
+# top-level source directory and at http://www.gromacs.org.
+#
+# GROMACS is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public License
+# as published by the Free Software Foundation; either version 2.1
+# of the License, or (at your option) any later version.
+#
+# GROMACS is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with GROMACS; if not, see
+# http://www.gnu.org/licenses, or write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
+#
+# If you want to redistribute modifications to GROMACS, please
+# consider that scientific software is very special. Version
+# control is crucial - bugs must be traceable. We will be happy to
+# consider code for inclusion in the official distribution, but
+# derived work must not be called official GROMACS. Details are found
+# in the README & COPYING files - if they are missing, get the
+# official version at http://www.gromacs.org.
+#
+# To help us fund GROMACS development, we humbly ask that you cite
+# the research papers on the package. Check out http://www.gromacs.org.
 
-#  To help us fund GROMACS development, we humbly ask that you cite
-#  the research papers on the package. Check out http://www.gromacs.org
+# - Find FFTW 3
+# Find the native FFTW headers and libraries.
+#
+#  ${FFTW}_INCLUDE_DIRS - where to find FFTW headers
+#  ${FFTW}_LIBRARIES    - List of libraries when using FFTW.
+#  ${FFTW}_PKG          - The name of the pkg-config package needed
+#  ${FFTW}_HAVE_SIMD    - True if FFTW was built with SIMD support
+#  ${FFTW}_HAVE_AVX     - True if FFTW was built with AVX support
+#  ${FFTW}_FOUND        - True if FFTW was found
+#  where ${FFTW} is FFTW or FFTWF
 
-find_package(PkgConfig)
 list(LENGTH FFTW_FIND_COMPONENTS FFTW_NUM_COMPONENTS_WANTED)
 if(${FFTW_NUM_COMPONENTS_WANTED} LESS 1)
   message(FATAL_ERROR "No FFTW component to search given")
 elseif(${FFTW_NUM_COMPONENTS_WANTED} GREATER 1)
   message(FATAL_ERROR "We only support finding one FFTW component at the time, go and implement it ;-)")
 elseif(${FFTW_FIND_COMPONENTS} MATCHES "^fftw(f)?$")
-  if (${FFTW_FIND_VERSION} EQUAL 3 OR NOT FFTW_FIND_VERSION) #find FFTW3 by default
-    string(REGEX REPLACE "fftw" "fftw3" FFTW_PKG "${FFTW_FIND_COMPONENTS}")
-    set(FFTW_HEADER "fftw3.h")
-    set(FFTW_FUNCTION "${FFTW_FIND_COMPONENTS}_plan_r2r_1d")
-  #elseif(${FFTW_FIND_VERSION} EQUAL 2)
-  #  set(FFTW_PKG "${FFTW_FIND_COMPONENTS}")
-  #  set(FFTW_HEADER "${FFTW_FIND_COMPONENTS}.h")
+  if (NOT FFTW_FIND_VERSION OR FFTW_FIND_VERSION EQUAL 3) #find FFTW3 by default
+    string(TOUPPER "${FFTW_FIND_COMPONENTS}" FFTW)
+    string(REGEX REPLACE "fftw" "fftw3" ${FFTW}_PKG "${FFTW_FIND_COMPONENTS}")
+    set(${FFTW}_FUNCTION_PREFIX "${FFTW_FIND_COMPONENTS}")
   else()
     message(FATAL_ERROR "We only support finding FFTW version 3, go and implement it ;-)")
   endif()
@@ -38,66 +60,78 @@ else()
   message(FATAL_ERROR "We do not support finding ${FFTW_FIND_COMPONENTS}, go and implement it ;-)")
 endif()
 
-if(NOT __pkg_config_checked_PC_FFTW_${FFTW_PKG})
-  pkg_check_modules(PC_FFTW_${FFTW_PKG} "${FFTW_PKG}")
-endif(NOT __pkg_config_checked_PC_FFTW_${FFTW_PKG})
-
-if(FFTW_LIBRARY)
-  set(FFTW_LIBRARY_${FFTW_PKG} "${FFTW_LIBRARY}" CACHE INTERNAL "Path to ${FFTW_PKG} library" FORCE)
-else(FFTW_LIBRARY)
-  set(FFTW_LIBRARY "" CACHE FILEPATH "Path to ${FFTW_PKG} library")
-endif(FFTW_LIBRARY)
-
-if(FFTW_INCLUDE_DIR)
-  set(FFTW_INCLUDE_DIR_${FFTW_PKG} "${FFTW_INCLUDE_DIR}" CACHE INTERNAL "Path to ${FFTW_HEADER}" FORCE)
-else(FFTW_INCLUDE_DIR)
-  set(FFTW_INCLUDE_DIR "" CACHE DIRECTORY "Path to ${FFTW_HEADER}")
-endif(FFTW_INCLUDE_DIR)
-
-#we use _${FFTW_PKG} variables to have different cache entries for fftw3 and ffw3f
-find_path(FFTW_INCLUDE_DIR_${FFTW_PKG} "${FFTW_HEADER}" HINTS ${PC_FFTW_${FFTW_PKG}_INCLUDE_DIRS})
-find_library(FFTW_LIBRARY_${FFTW_PKG} NAMES "${FFTW_PKG}" HINTS ${PC_FFTW_${FFTW_PKG}_LIBRARY_DIRS})
+find_package(PkgConfig QUIET)
+if(NOT __pkg_config_checked_PC_${FFTW} OR NOT ${FFTW}_LIBRARY)
+  pkg_check_modules(PC_${FFTW} "${${FFTW}_PKG}")
+  if(NOT PC_${FFTW}_FOUND)
+    message(STATUS "pkg-config could not detect ${${FFTW}_PKG}, trying generic detection")
+  endif()
+endif()
 
-#make _${FFTW_PKG} variables INTERNAL to avoid confusion in cmake-gui
-set(FFTW_LIBRARY_${FFTW_PKG} ${FFTW_LIBRARY_${FFTW_PKG}} CACHE INTERNAL "Path to ${FFTW_PKG} library" FORCE)
-set(FFTW_INCLUDE_DIR_${FFTW_PKG} ${FFTW_INCLUDE_DIR_${FFTW_PKG}} CACHE INTERNAL "Path to ${FFTW_HEADER}" FORCE)
+find_path(${FFTW}_INCLUDE_DIR "fftw3.h" HINTS ${PC_${FFTW}_INCLUDE_DIRS})
+find_library(${FFTW}_LIBRARY NAMES "${${FFTW}_PKG}" HINTS ${PC_${FFTW}_LIBRARY_DIRS})
 
-# set default find_package outcome variables
-set(FFTW_LIBRARIES "${FFTW_LIBRARY_${FFTW_PKG}}")
-set(FFTW_INCLUDE_DIRS "${FFTW_INCLUDE_DIR_${FFTW_PKG}}")
+set(${FFTW}_LIBRARIES "${${FFTW}_LIBRARY}")
+set(${FFTW}_INCLUDE_DIRS "${${FFTW}_INCLUDE_DIR}")
 
-set(FFTW_FOUND FALSE)
-if (FFTW_LIBRARY_${FFTW_PKG} AND FFTW_INCLUDE_DIR_${FFTW_PKG})
-  set(FFTW_FOUND TRUE)
-elseif (NOT FFTW_LIBRARY_${FFTW_PKG})
-  message("Could not find ${FFTW_PKG} library named lib${FFTW_PKG}, please specify its location in FFTW_LIBRARY by hand (e.g. -DFFTW_LIBRARY='/path/to/lib${FFTW_PKG}.so')")
-elseif (NOT FFTW_INCLUDE_DIR_${FFTW_PKG})
-  message("Could not the ${FFTW_PKG} header ${FFTW_HEADER}, please specify its path in FFTW_INCLUDE_DIR by hand (e.g. -DFFTW_INCLUDE_DIR='/path/to/include')")
+#better error message than find_package_handle_standard_args
+if (${FFTW}_LIBRARY AND ${FFTW}_INCLUDE_DIR)
+  set(${FFTW}_FOUND TRUE)
+elseif (NOT ${FFTW}_LIBRARY)
+  message("Could not find ${${FFTW}_PKG} library named lib${${FFTW}_PKG}, please specify its location in CMAKE_PREFIX_PATH or ${FFTW}_LIBRARY by hand (e.g. -D${FFTW}_LIBRARY='/path/to/lib${${FFTW}_PKG}.so')")
+elseif (NOT ${FFTW}_INCLUDE_DIR)
+  message("Could not the ${${FFTW}_PKG} header fftw3.h, please specify its path in ${FFTW}_INCLUDE_DIR by hand (e.g. -D${FFTW}_INCLUDE_DIR='/path/to/include')")
 endif()
 
-set(FFTW_HAVE_SSE FALSE CACHE BOOL "If ${FFTW_PKG} was built with SSE support")
-if (FFTW_FOUND AND HAVE_LIBM AND NOT "${FFTW_LIBRARY_PREVIOUS}" STREQUAL "${FFTW_LIBRARY}")
-  #The user could specify trash in FFTW_LIBRARY, so test if we can link it
+if (${FFTW}_FOUND)
+  #The user could specify trash in ${FFTW}_LIBRARY, so test if we can link it
   include(CheckLibraryExists)
-  #adding MATH_LIBRARIES here to allow static libs, this does not harm us as we are anyway using it
-  set(CMAKE_REQUIRED_LIBRARIES m)
-  unset(FOUND_FFTW_PLAN_${FFTW_PKG} CACHE)
-  check_library_exists("${FFTW_LIBRARIES}" "${FFTW_FUNCTION}" "" FOUND_FFTW_PLAN_${FFTW_PKG})
-  if(NOT FOUND_FFTW_PLAN_${FFTW_PKG})
-    message(FATAL_ERROR "Could not find ${FFTW_FUNCTION} in ${FFTW_LIBRARY_${FFTW_PKG}}, take a look at the error message in ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeError.log to find out what went wrong. If you are using a static lib (.a) make sure you have specified all dependencies of ${FFTW_PKG} in FFTW_LIBRARY by hand (e.g. -DFFTW_LIBRARY='/path/to/lib${FFTW_PKG}.so;/path/to/libm.so') !")
-  endif(NOT FOUND_FFTW_PLAN_${FFTW_PKG})
+  include(gmxOptionUtilities)
+  if (HAVE_LIBM)
+    #adding MATH_LIBRARIES here to allow static libs, this does not harm us as we are anyway using it
+    set(CMAKE_REQUIRED_LIBRARIES m)
+  endif ()
+  gmx_check_if_changed(FFTW_LIBRARY_CHANGED ${FFTW}_LIBRARIES)
+  if (FFTW_LIBRARY_CHANGED)
+    unset(FOUND_${FFTW}_PLAN CACHE)
+  endif()
+  check_library_exists("${${FFTW}_LIBRARIES}" "${${FFTW}_FUNCTION_PREFIX}_plan_r2r_1d" "" FOUND_${FFTW}_PLAN)
+  if(NOT FOUND_${FFTW}_PLAN)
+    message(FATAL_ERROR "Could not find ${${FFTW}_FUNCTION_PREFIX}_plan_r2r_1d in ${${FFTW}_LIBRARY}, take a look at the error message in ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeError.log to find out what went wrong. If you are using a static lib (.a) make sure you have specified all dependencies of ${${FFTW}_PKG} in ${FFTW}_LIBRARY by hand (e.g. -D${FFTW}_LIBRARY='/path/to/lib${${FFTW}_PKG}.so;/path/to/libm.so') !")
+  endif()
+
+  # Check for FFTW3 compiled with --enable-avx, which is slower for GROMACS than --enable-sse or --enable-sse2
+  foreach(AVX_FUNCTION ${${FFTW}_FUNCTION_PREFIX}_have_simd_avx)
+    if (FFTW_LIBRARY_CHANGED)
+      unset(${FFTW}_HAVE_${AVX_FUNCTION} CACHE)
+    endif()
+    check_library_exists("${${FFTW}_LIBRARIES}" "${AVX_FUNCTION}" "" ${FFTW}_HAVE_${AVX_FUNCTION})
+    if(${FFTW}_HAVE_${AVX_FUNCTION})
+      set(${FFTW}_HAVE_AVX TRUE)
+      break()
+    endif()
+  endforeach()
+
   #in 3.3 sse function name has changed
-  foreach(SSE_FCT fftwf_have_simd_sse2;fftw_have_simd_sse2;fftwf_have_sse;fftw_have_sse2)
-    unset(FFTW_HAVE_${SSE_FCT}_${FFTW_PKG} CACHE)
-    check_library_exists("${FFTW_LIBRARIES}" "${SSE_FCT}" "" FFTW_HAVE_${SSE_FCT}_${FFTW_PKG})
-    if(FFTW_HAVE_${SSE_FCT}_${FFTW_PKG})
-      set(FFTW_HAVE_SSE_${FFTW_PKG} "${FFTW_HAVE_${SSE_FCT}_${FFTW_PKG}}")
+  foreach(SIMD_FCT ${${FFTW}_FUNCTION_PREFIX}_have_simd_sse2;${${FFTW}_FUNCTION_PREFIX}_have_simd_avx;${${FFTW}_FUNCTION_PREFIX}_have_simd_altivec;${${FFTW}_FUNCTION_PREFIX}_have_simd_neon;${${FFTW}_FUNCTION_PREFIX}_have_sse2;${${FFTW}_FUNCTION_PREFIX}_have_sse;${${FFTW}_FUNCTION_PREFIX}_have_altivec)
+    if (FFTW_LIBRARY_CHANGED)
+      unset(${FFTW}_HAVE_${SIMD_FCT} CACHE)
+    endif()
+    check_library_exists("${${FFTW}_LIBRARIES}" "${SIMD_FCT}" "" ${FFTW}_HAVE_${SIMD_FCT})
+    if(${FFTW}_HAVE_${SIMD_FCT})
+      set(${FFTW}_HAVE_SIMD TRUE)
       break()
-    endif(FFTW_HAVE_${SSE_FCT}_${FFTW_PKG})
+    endif()
   endforeach()
-  set(FFTW_HAVE_SSE "${FFTW_HAVE_SSE_${FFTW_PKG}}" CACHE BOOL "If ${FFTW_PKG} was built with SSE support" FORCE)
+  #Verify FFTW is compiled with fPIC (necessary for shared libraries)
+  if (CMAKE_OBJDUMP AND CMAKE_SYSTEM_PROCESSOR STREQUAL "x86_64" AND BUILD_SHARED_LIBS AND NOT CYGWIN)
+      execute_process(COMMAND ${CMAKE_OBJDUMP} --reloc ${${FFTW}_LIBRARY} OUTPUT_VARIABLE ${FFTW}_OBJDUMP)
+      if (${${FFTW}_OBJDUMP} MATCHES "R_X86_64" #Should always be true for static libraries. Checks that objdump works properly and that the library isn't dynamic
+              AND NOT ${${FFTW}_OBJDUMP} MATCHES "R_X86_64_PLT32")
+          message(FATAL_ERROR "The FFTW library ${${FFTW}_LIBRARY} cannot be used with shared libraries. Provide a different FFTW library by setting ${FFTW}_LIBRARY. If you don't have a different one, recompile FFTW with \"--enable-shared\" or \"--with-pic\". Or disable shared libraries for Gromacs by setting BUILD_SHARED_LIBS to \"no\". Note: Disabling shared libraries requires up to 10x as much disk space.")
+      endif()
+  endif()
   set(CMAKE_REQUIRED_LIBRARIES)
-  set(FFTW_LIBRARY_PREVIOUS "${FFTW_LIBRARY}" CACHE INTERNAL "Value of FFTW_LIBRARY when executing the linking check that last time" FORCE)
-endif (FFTW_FOUND AND HAVE_LIBM AND NOT "${FFTW_LIBRARY_PREVIOUS}" STREQUAL "${FFTW_LIBRARY}")
+endif ()
 
-mark_as_advanced(FFTW_INCLUDE_DIR FFTW_LIBRARY FFTW_HAVE_SSE)
+mark_as_advanced(${FFTW}_INCLUDE_DIR ${FFTW}_LIBRARY)