Refactor configuration checks

This moves php-src internal checks into checks directory and sorts out
cache variable names, Windows target etc.

Author: petk

cmake/cmake/ConfigureChecks.cmake

@@ -19,6 +19,7 @@ include(CheckTypeSize)
 include(CMakePushCheckState)
 include(FeatureSummary)
 include(PHP/CheckAttribute)
+include(PHP/CheckBuiltin)
 include(PHP/SearchLibraries)
 
 ################################################################################
@@ -237,9 +238,6 @@ cmake_pop_check_state()
 # Check builtins.
 ################################################################################
 
-# Import builtins checker function.
-include(PHP/CheckBuiltin)
-
 php_check_builtin(__builtin_clz PHP_HAVE_BUILTIN_CLZ)
 php_check_builtin(__builtin_clzl PHP_HAVE_BUILTIN_CLZL)
 php_check_builtin(__builtin_clzll PHP_HAVE_BUILTIN_CLZLL)
@@ -264,9 +262,6 @@ php_check_builtin(__builtin_usub_overflow PHP_HAVE_BUILTIN_USUB_OVERFLOW)
 # Check compiler inline keyword.
 include(PHP/CheckInline)
 
-# Check AVX-512 extensions.
-include(PHP/CheckAVX512)
-
 ################################################################################
 # Check functions.
 ################################################################################
@@ -401,12 +396,6 @@ check_symbol_exists(strlcat string.h HAVE_STRLCAT)
 check_symbol_exists(strlcpy string.h HAVE_STRLCPY)
 check_symbol_exists(explicit_bzero string.h HAVE_EXPLICIT_BZERO)
 
-# Check reentrant functions.
-include(${CMAKE_CURRENT_LIST_DIR}/checks/CheckReentrantFunctions.cmake)
-
-# Check fopencookie.
-include(PHP/CheckFopencookie)
-
 # Some systems, notably Solaris, cause getcwd() or realpath to fail if a
 # component of the path has execute but not read permissions.
 message(CHECK_START "Checking for broken getcwd()")
@@ -423,16 +412,18 @@ if(TARGET PHP::CheckGetaddrinfoLibrary)
   target_link_libraries(php_config INTERFACE PHP::CheckGetaddrinfoLibrary)
 endif()
 
-# Check copy_file_range().
-include(PHP/CheckCopyFileRange)
-
-# Check whether writing to stdout works.
-include(PHP/CheckWrite)
-
 ################################################################################
 # Miscellaneous checks.
 ################################################################################
 
+include(${CMAKE_CURRENT_LIST_DIR}/checks/CheckAVX512.cmake)
+include(${CMAKE_CURRENT_LIST_DIR}/checks/CheckCopyFileRange.cmake)
+include(${CMAKE_CURRENT_LIST_DIR}/checks/CheckFlushIo.cmake)
+include(${CMAKE_CURRENT_LIST_DIR}/checks/CheckFopencookie.cmake)
+include(${CMAKE_CURRENT_LIST_DIR}/checks/CheckIPv6.cmake)
+include(${CMAKE_CURRENT_LIST_DIR}/checks/CheckReentrantFunctions.cmake)
+include(${CMAKE_CURRENT_LIST_DIR}/checks/CheckWrite.cmake)
+
 # Checking file descriptor sets.
 message(CHECK_START "Checking file descriptor sets size")
 if(PHP_FD_SETSIZE MATCHES "^[0-9]+$" AND PHP_FD_SETSIZE GREATER 0)
@@ -452,12 +443,6 @@ else()
   message(CHECK_PASS "using system default")
 endif()
 
-# Check for IPv6 support.
-include(PHP/CheckIPv6)
-
-# Check how flush should be called.
-include(PHP/CheckFlushIo)
-
 if(HAVE_ALLOCA_H)
   # Most *.nix systems.
   check_symbol_exists(alloca alloca.h HAVE_ALLOCA)

cmake/cmake/modules/PHP/CheckAVX512.cmake renamed to cmake/cmake/checks/CheckAVX512.cmake

@@ -1,39 +1,29 @@
 #[=============================================================================[
-# PHP/CheckAVX512
-
 Check whether compiler supports AVX-512 extensions. Note that this is a compiler
 check, not a runtime check where further adjustments are done in the php-src C
 code to use these extensions.
 
-TODO: Adjust checks for MSVC.
-
-## Cache variables
-
-* `PHP_HAVE_AVX512_SUPPORTS`
-
-  Whether compiler supports AVX-512.
-
-* `PHP_HAVE_AVX512_VBMI_SUPPORTS`
-
-  Whether compiler supports AVX-512 VBMI.
-
-## Usage
+Cache variables:
 
-```cmake
-# CMakeLists.txt
-include(PHP/CheckAVX512)
-```
+* PHP_HAVE_AVX512_SUPPORTS - Whether compiler supports AVX-512.
+* PHP_HAVE_AVX512_VBMI_SUPPORTS - Whether compiler supports AVX-512 VBMI.
 #]=============================================================================]
 
 include_guard(GLOBAL)
 
+include(CheckSourceCompiles)
+include(CMakePushCheckState)
+
 # Skip in consecutive configuration phases.
 if(DEFINED PHP_HAVE_AVX512_SUPPORTS AND DEFINED PHP_HAVE_AVX512_VBMI_SUPPORTS)
   return()
 endif()
 
-include(CheckSourceCompiles)
-include(CMakePushCheckState)
+if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
+  set(PHP_HAVE_AVX512_SUPPORTS FALSE)
+  set(PHP_HAVE_AVX512_VBMI_SUPPORTS FALSE)
+  return()
+endif()
 
 message(CHECK_START "Checking for AVX-512 extensions support")
 

cmake/cmake/modules/PHP/CheckCopyFileRange.cmake renamed to cmake/cmake/checks/CheckCopyFileRange.cmake

@@ -1,34 +1,35 @@
 #[=============================================================================[
-# PHP/CheckCopyFileRange
+Check copy_file_range().
 
-On FreeBSD, `copy_file_range()` works only with the undocumented flag
-`0x01000000`. Until the problem is fixed properly, `copy_file_range()` is used
+On FreeBSD, copy_file_range() works only with the undocumented flag
+'0x01000000'. Until the problem is fixed properly, 'copy_file_range()' is used
 only on Linux.
 
-## Cache variables
+Result variables:
 
-* `HAVE_COPY_FILE_RANGE`
+* HAVE_COPY_FILE_RANGE - Whether 'copy_file_range()' is supported.
+#]=============================================================================]
 
-  Whether `copy_file_range()` is supported.
+include_guard(GLOBAL)
 
-## Usage
+include(CheckSourceCompiles)
+include(CMakePushCheckState)
 
-```cmake
-# CMakeLists.txt
-include(PHP/CheckCopyFileRange)
-```
-#]=============================================================================]
+set(HAVE_COPY_FILE_RANGE FALSE)
 
-include_guard(GLOBAL)
+if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
+  return()
+endif()
 
 # Skip in consecutive configuration phases.
-if(DEFINED HAVE_COPY_FILE_RANGE)
+if(DEFINED PHP_HAS_COPY_FILE_RANGE)
+  if(PHP_HAS_COPY_FILE_RANGE)
+    set(HAVE_COPY_FILE_RANGE TRUE)
+  endif()
+
   return()
 endif()
 
-include(CheckSourceCompiles)
-include(CMakePushCheckState)
-
 message(CHECK_START "Checking for copy_file_range")
 
 cmake_push_check_state(RESET)
@@ -53,10 +54,11 @@ cmake_push_check_state(RESET)
       (void)copy_file_range(-1, 0, -1, 0, 0, 0);
       return 0;
     }
-  ]] HAVE_COPY_FILE_RANGE)
+  ]] PHP_HAS_COPY_FILE_RANGE)
 cmake_pop_check_state()
 
-if(HAVE_COPY_FILE_RANGE)
+if(PHP_HAS_COPY_FILE_RANGE)
+  set(HAVE_COPY_FILE_RANGE TRUE)
   message(CHECK_PASS "yes")
 else()
   message(CHECK_FAIL "no")

cmake/cmake/modules/PHP/CheckFlushIo.cmake renamed to cmake/cmake/checks/CheckFlushIo.cmake

@@ -1,46 +1,37 @@
 #[=============================================================================[
-# PHP/CheckFlushIo
-
 Check if flush should be called explicitly after buffered io.
 
-## Cache variables
-
-* `HAVE_FLUSHIO`
-
-## Usage
+Result variables:
 
-```cmake
-# CMakeLists.txt
-include(PHP/CheckFlushIo)
-```
+* HAVE_FLUSHIO
 #]=============================================================================]
 
 include_guard(GLOBAL)
 
-# Skip in consecutive configuration phases.
-if(DEFINED HAVE_FLUSHIO)
-  return()
-endif()
-
 include(CheckIncludeFiles)
 include(CheckSourceRuns)
 include(CMakePushCheckState)
 
-message(CHECK_START
-  "Checking whether flush should be called explicitly after a buffered io"
-)
+set(HAVE_FLUSHIO FALSE)
 
 if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
-  message(CHECK_FAIL "no")
-  set(
-    HAVE_FLUSHIO
-    FALSE
-    CACHE INTERNAL
-    "Whether flush should be called explicitly after a buffered io."
-  )
   return()
 endif()
 
+# Skip in consecutive configuration phases.
+if(DEFINED PHP_HAS_FLUSHIO)
+  if(PHP_HAS_FLUSHIO)
+    set(HAVE_FLUSHIO TRUE)
+  endif()
+
+  return()
+endif()
+
+message(
+  CHECK_START
+  "Checking whether flush should be called explicitly after a buffered io"
+)
+
 cmake_push_check_state(RESET)
   set(CMAKE_REQUIRED_QUIET TRUE)
 
@@ -108,10 +99,11 @@ cmake_push_check_state(RESET)
 
       return result;
     }
-  ]] HAVE_FLUSHIO)
+  ]] PHP_HAS_FLUSHIO)
 cmake_pop_check_state()
 
-if(HAVE_FLUSHIO)
+if(PHP_HAS_FLUSHIO)
+  set(HAVE_FLUSHIO TRUE)
   message(CHECK_PASS "yes")
 else()
   message(CHECK_FAIL "no")

cmake/cmake/modules/PHP/CheckFopencookie.cmake renamed to cmake/cmake/checks/CheckFopencookie.cmake

@@ -1,31 +1,19 @@
 #[=============================================================================[
-# PHP/CheckFopencookie
+Check if 'fopencookie()' works as expected.
 
-Check if `fopencookie()` works as expected.
+Module first checks if 'fopencookie()' and type 'cookie_io_functions_t' are
+available. Then it checks whether the 'fopencookie' seeker uses type 'off64_t'.
+Since 'off64_t' is non-standard and obsolescent, the standard 'off_t' type can
+be used on both 64-bit and 32-bit systems, where the '_FILE_OFFSET_BITS=64' can
+make it behave like 'off64_t' on 32-bit. Since code is in the transition process
+to use 'off_t' only, check is left here when using glibc.
 
-Module first checks if `fopencookie()` and type `cookie_io_functions_t` are
-available. Then it checks whether the fopencookie seeker uses type `off64_t`.
-Since `off64_t` is non-standard and obsolescent, the standard `off_t` type can
-be used on both 64-bit and 32-bit systems, where the `_FILE_OFFSET_BITS=64` can
-make it behave like `off64_t` on 32-bit. Since code is in the transition process
-to use `off_t` only, check is left here when using glibc.
+Result variables:
 
-## Cache variables
-
-* `HAVE_FOPENCOOKIE`
-
-  Whether `fopencookie()` and `cookie_io_functions_t` are available.
-
-* `COOKIE_SEEKER_USES_OFF64_T`
-
-  Whether `fopencookie` seeker uses the `off64_t` type.
-
-## Usage
-
-```cmake
-# CMakeLists.txt
-include(PHP/CheckFopencookie)
-```
+* HAVE_FOPENCOOKIE - Whether 'fopencookie()' and 'cookie_io_functions_t' are
+  available.
+* COOKIE_SEEKER_USES_OFF64_T - Whether 'fopencookie' seeker uses the 'off64_t'
+  type.
 #]=============================================================================]
 
 include_guard(GLOBAL)
@@ -35,6 +23,13 @@ include(CheckSymbolExists)
 include(CheckTypeSize)
 include(CMakePushCheckState)
 
+set(COOKIE_SEEKER_USES_OFF64_T FALSE)
+set(HAVE_FOPENCOOKIE FALSE)
+
+if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
+  return()
+endif()
+
 cmake_push_check_state(RESET)
   set(CMAKE_REQUIRED_DEFINITIONS -D_GNU_SOURCE)
   check_symbol_exists(fopencookie stdio.h PHP_HAS_FOPENCOOKIE)
@@ -47,29 +42,34 @@ endif()
 cmake_push_check_state(RESET)
   set(CMAKE_REQUIRED_DEFINITIONS -D_GNU_SOURCE)
   set(CMAKE_EXTRA_INCLUDE_FILES "stdio.h")
-  check_type_size("cookie_io_functions_t" FOPENCOOKIE)
+  check_type_size("cookie_io_functions_t" PHP_COOKIE_IO_FUNCTIONS_T)
 cmake_pop_check_state()
 
-if(NOT HAVE_FOPENCOOKIE)
+if(NOT HAVE_PHP_COOKIE_IO_FUNCTIONS_T)
   return()
 endif()
 
+set(HAVE_FOPENCOOKIE TRUE)
+
 # Skip in consecutive configuration phases.
-if(DEFINED COOKIE_SEEKER_USES_OFF64_T)
+if(DEFINED PHP_HAS_COOKIE_SEEKER_OFF64_T)
+  if(PHP_HAS_COOKIE_SEEKER_OFF64_T)
+    set(COOKIE_SEEKER_USES_OFF64_T TRUE)
+  endif()
   return()
 endif()
 
 # GNU C library can have a different seeker definition using off64_t.
 message(CHECK_START "Checking whether fopencookie seeker uses off64_t")
 
 if(
-  NOT DEFINED COOKIE_SEEKER_USES_OFF64_T_EXITCODE
+  NOT DEFINED PHP_HAS_COOKIE_SEEKER_OFF64_T_EXITCODE
   AND CMAKE_CROSSCOMPILING
   AND NOT CMAKE_CROSSCOMPILING_EMULATOR
   AND CMAKE_SYSTEM_NAME STREQUAL "Linux"
   AND PHP_C_STANDARD_LIBRARY STREQUAL "glibc"
 )
-  set(COOKIE_SEEKER_USES_OFF64_T_EXITCODE 0)
+  set(PHP_HAS_COOKIE_SEEKER_OFF64_T_EXITCODE 0)
 endif()
 
 cmake_push_check_state(RESET)
@@ -123,10 +123,11 @@ cmake_push_check_state(RESET)
 
       return 1;
     }
-  ]] COOKIE_SEEKER_USES_OFF64_T)
+  ]] PHP_HAS_COOKIE_SEEKER_OFF64_T)
 cmake_pop_check_state()
 
-if(COOKIE_SEEKER_USES_OFF64_T)
+if(PHP_HAS_COOKIE_SEEKER_OFF64_T)
+  set(COOKIE_SEEKER_USES_OFF64_T TRUE)
   message(CHECK_PASS "yes")
 else()
   message(CHECK_FAIL "no")