Merge branch 'PHP-8.4'

petk · petk · commit e831e079d0ea · 2024-11-22T22:53:48.000+01:00
diff --git a/cmake/ext/opcache/CMakeLists.txt b/cmake/ext/opcache/CMakeLists.txt
@@ -1,7 +1,5 @@
 #[=============================================================================[
-# The opcache extension
-
-Configure the `opcache` extension.
+# The Zend OPcache extension
 
 This extension enables the PHP OPcode caching engine.
 
@@ -17,7 +15,7 @@ Enable the extension. This extension is always built as shared when enabled.
 * Default: `ON`
 * Values: `ON|OFF`
 
-Enable copying PHP CODE pages into HUGE PAGES
+Enable copying PHP CODE pages into HUGE PAGES.
 
 ## EXT_OPCACHE_JIT
 
@@ -31,7 +29,7 @@ Enable JIT (Just-In-Time compiler).
 * Default: `OFF`
 * Values: `ON|OFF`
 
-Enable opcache JIT disassembly through Capstone.
+Enable OPcache JIT disassembly through Capstone engine.
 #]=============================================================================]
 
 project(
@@ -44,8 +42,7 @@ include(CMakeDependentOption)
 include(FeatureSummary)
 include(PHP/SearchLibraries)
 
-option(EXT_OPCACHE "Enable the opcache extension" ON)
-
+option(EXT_OPCACHE "Enable the Zend OPcache extension" ON)
 add_feature_info(
   "ext/opcache"
   EXT_OPCACHE
@@ -64,21 +61,15 @@ cmake_dependent_option(
   EXT_OPCACHE_JIT
   "Enable JIT"
   ON
-  "EXT_OPCACHE"
+  EXT_OPCACHE
   OFF
 )
 
-add_feature_info(
-  "ext/opcache JIT"
-  EXT_OPCACHE_JIT
-  "Opcache's JIT (Just-In-Time compiler)"
-)
-
 cmake_dependent_option(
   EXT_OPCACHE_CAPSTONE
-  "Support opcache JIT disassembly through Capstone"
+  "Support OPcache JIT disassembly through Capstone engine"
   OFF
-  "EXT_OPCACHE"
+  EXT_OPCACHE
   OFF
 )
 
@@ -112,13 +103,6 @@ target_sources(
     ZendAccelerator.c
 )
 
-target_include_directories(
-  php_opcache
-  PRIVATE
-    ${CMAKE_CURRENT_SOURCE_DIR}/jit
-    ${CMAKE_CURRENT_BINARY_DIR}/jit
-)
-
 add_dependencies(php_opcache php_date php_pcre)
 
 if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
@@ -141,7 +125,7 @@ endif()
 # JIT.
 ################################################################################
 
-# Check JIT requirements.
+# Check if JIT is supported by the target architecture.
 if(EXT_OPCACHE_JIT)
   if(
     # *nix:
@@ -168,50 +152,6 @@ if(EXT_OPCACHE_JIT)
 endif()
 
 if(EXT_OPCACHE_JIT)
-  set(HAVE_JIT 1)
-
-  target_sources(
-    php_opcache
-    PRIVATE
-      jit/ir/ir_cfg.c
-      jit/ir/ir_check.c
-      jit/ir/ir_dump.c
-      jit/ir/ir_emit.c
-      jit/ir/ir_gcm.c
-      $<$<NOT:$<PLATFORM_ID:Windows>>:jit/ir/ir_gdb.c>
-      jit/ir/ir_patch.c
-      $<$<NOT:$<PLATFORM_ID:Windows>>:jit/ir/ir_perf.c>
-      jit/ir/ir_ra.c
-      jit/ir/ir_save.c
-      jit/ir/ir_sccp.c
-      jit/ir/ir_strtab.c
-      jit/ir/ir.c
-      jit/zend_jit_vm_helpers.c
-      jit/zend_jit.c
-  )
-
-  target_include_directories(
-    php_opcache
-    PRIVATE ${CMAKE_CURRENT_BINARY_DIR}/jit/ir
-  )
-
-  # Check for Capstone.
-  if(EXT_OPCACHE_CAPSTONE)
-    find_package(Capstone 3.0.0)
-    set_package_properties(
-      Capstone
-      PROPERTIES
-        TYPE REQUIRED
-        PURPOSE "Necessary to enable OPcache JIT disassembly through Capstone."
-    )
-
-    target_sources(php_opcache PRIVATE jit/ir/ir_disasm.c)
-
-    target_link_libraries(php_opcache PRIVATE Capstone::Capstone)
-
-    set(HAVE_CAPSTONE 1)
-  endif()
-
   # Find out which ABI to use.
   if(CMAKE_SYSTEM_PROCESSOR MATCHES "^(x86_64|amd64|AMD64|ARM64)$")
     set(IR_TARGET "IR_TARGET_X64")
@@ -243,23 +183,12 @@ if(EXT_OPCACHE_JIT)
     list(APPEND DASM_FLAGS -D X64WIN=1)
   endif()
 
-  target_compile_definitions(
-    php_opcache
-    PRIVATE
-      IR_PHP
-      ${IR_TARGET}
-      $<$<CONFIG:Debug,DebugAssertions>:IR_DEBUG>
-  )
-
-  add_executable(
-    php_opcache_jit_minilua
-    jit/ir/dynasm/minilua.c
-  )
+  # Generate ir_emit_<arch>.h file.
+  add_executable(php_opcache_jit_minilua jit/ir/dynasm/minilua.c)
   set_target_properties(
     php_opcache_jit_minilua
     PROPERTIES
-      OUTPUT_NAME minilua
-      RUNTIME_OUTPUT_DIRECTORY jit/ir
+      RUNTIME_OUTPUT_DIRECTORY CMakeFiles
   )
 
   # Link math library as needed.
@@ -271,18 +200,27 @@ if(EXT_OPCACHE_JIT)
     TARGET php_opcache_jit_minilua PRIVATE
   )
 
-  # Create jit directory in the current build directory if it doesn't exist yet.
+  # Help generators create a jit/ir build directory.
+  file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/jit/ir)
+
+  # Generate native code generator for selected architecture.
   add_custom_command(
-    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/jit
-    COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/jit
-    COMMENT "[ext/opcache] Creating ext/opcache/jit directory"
+    OUTPUT jit/ir/ir_emit_${DASM_ARCH}.h
+    COMMAND
+      php_opcache_jit_minilua ${CMAKE_CURRENT_SOURCE_DIR}/jit/ir/dynasm/dynasm.lua
+        ${DASM_FLAGS}
+        -o ${CMAKE_CURRENT_BINARY_DIR}/jit/ir/ir_emit_${DASM_ARCH}.h
+        ${CMAKE_CURRENT_SOURCE_DIR}/jit/ir/ir_${DASM_ARCH}.dasc
+    COMMENT "[ext/opcache] Generating native code generator ext/opcache/jit/ir/ir_emit_${DASM_ARCH}.h"
+    DEPENDS
+      jit/ir/dynasm/dynasm.lua
+      jit/ir/ir_${DASM_ARCH}.dasc
+    VERBATIM
+    COMMAND_EXPAND_LISTS
   )
 
   # Create IR folding engine generator.
-  add_executable(
-    php_opcache_jit_generator
-    jit/ir/gen_ir_fold_hash.c
-  )
+  add_executable(php_opcache_jit_generator jit/ir/gen_ir_fold_hash.c)
   target_compile_definitions(
     php_opcache_jit_generator
     PRIVATE
@@ -293,45 +231,90 @@ if(EXT_OPCACHE_JIT)
   set_target_properties(
     php_opcache_jit_generator
     PROPERTIES
-      OUTPUT_NAME gen_ir_fold_hash
-      RUNTIME_OUTPUT_DIRECTORY jit/ir
+      RUNTIME_OUTPUT_DIRECTORY CMakeFiles
   )
 
   # Generate IR folding engine rules header.
   add_custom_command(
-    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/jit/ir/ir_fold_hash.h
+    OUTPUT jit/ir/ir_fold_hash.h
     COMMAND php_opcache_jit_generator
       < ${CMAKE_CURRENT_SOURCE_DIR}/jit/ir/ir_fold.h
       > ${CMAKE_CURRENT_BINARY_DIR}/jit/ir/ir_fold_hash.h
-    DEPENDS php_opcache_jit_generator ${CMAKE_CURRENT_BINARY_DIR}/jit
     COMMENT "[ext/opcache] Generating folding engine rules ext/opcache/jit/ir/ir_fold_hash.h"
-  )
-
-  # Generate native code generator for selected architecture.
-  add_custom_command(
-    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/jit/ir/ir_emit_${DASM_ARCH}.h
-    COMMAND
-      php_opcache_jit_minilua ${CMAKE_CURRENT_SOURCE_DIR}/jit/ir/dynasm/dynasm.lua
-        ${DASM_FLAGS}
-        -o ${CMAKE_CURRENT_BINARY_DIR}/jit/ir/ir_emit_${DASM_ARCH}.h
-        ${CMAKE_CURRENT_SOURCE_DIR}/jit/ir/ir_${DASM_ARCH}.dasc
     DEPENDS
-      php_opcache_jit_minilua
-      ${CMAKE_CURRENT_BINARY_DIR}/jit
-    COMMENT "[ext/opcache] Generating native code generator ext/opcache/jit/ir/ir_emit_${DASM_ARCH}.h"
+      jit/ir/ir_fold.h
+    VERBATIM
+    COMMAND_EXPAND_LISTS
   )
 
-  add_custom_target(
-    php_opcache_jit
-    DEPENDS
+  target_sources(
+    php_opcache
+    PRIVATE
+      jit/ir/ir_cfg.c
+      jit/ir/ir_check.c
+      jit/ir/ir_dump.c
+      jit/ir/ir_emit.c
+      jit/ir/ir_gcm.c
+      $<$<NOT:$<PLATFORM_ID:Windows>>:jit/ir/ir_gdb.c>
+      jit/ir/ir_patch.c
+      $<$<NOT:$<PLATFORM_ID:Windows>>:jit/ir/ir_perf.c>
+      jit/ir/ir_ra.c
+      jit/ir/ir_save.c
+      jit/ir/ir_sccp.c
+      jit/ir/ir_strtab.c
+      jit/ir/ir.c
+      jit/zend_jit_vm_helpers.c
+      jit/zend_jit.c
       ${CMAKE_CURRENT_BINARY_DIR}/jit/ir/ir_emit_${DASM_ARCH}.h
       ${CMAKE_CURRENT_BINARY_DIR}/jit/ir/ir_fold_hash.h
-    COMMENT "[ext/opcache] Building JIT for architecture ${DASM_ARCH}"
   )
 
-  add_dependencies(php_opcache php_opcache_jit)
+  target_include_directories(
+    php_opcache
+    PRIVATE
+      ${CMAKE_CURRENT_BINARY_DIR}/jit/ir
+  )
+
+  target_compile_definitions(
+    php_opcache
+    PRIVATE
+      IR_PHP
+      ${IR_TARGET}
+      $<$<CONFIG:Debug,DebugAssertions>:IR_DEBUG>
+  )
+
+  # Check for Capstone.
+  if(EXT_OPCACHE_CAPSTONE)
+    find_package(Capstone 3.0.0)
+    set_package_properties(
+      Capstone
+      PROPERTIES
+        TYPE REQUIRED
+        PURPOSE "Necessary to enable OPcache JIT disassembly through Capstone."
+    )
+
+    target_sources(php_opcache PRIVATE jit/ir/ir_disasm.c)
+
+    target_link_libraries(php_opcache PRIVATE Capstone::Capstone)
+
+    set(HAVE_CAPSTONE 1)
+  endif()
+
+  set(HAVE_JIT 1)
 endif()
 
+add_feature_info(
+  "ext/opcache JIT"
+  HAVE_JIT
+  "OPcache JIT (Just-In-Time compiler)"
+)
+
+add_feature_info(
+  "ext/opcache JIT Capstone"
+  HAVE_CAPSTONE
+  "OPcache JIT disassembly supported through Capstone engine"
+)
+
 ################################################################################
 # Configuration checks.
 ################################################################################
diff --git a/docs/cmake/cmake-code-style.md b/docs/cmake/cmake-code-style.md
@@ -675,7 +675,7 @@ For convenience there is a custom helper script added to this repository that
 checks CMake files:
 
 ```sh
-./bin/check-cmake.php cmake
+./bin/check-cmake.php
 ```
 
 #### 10.1.6. cmake-format.json
diff --git a/docs/cmake/cmake.md b/docs/cmake/cmake.md
@@ -68,8 +68,6 @@ repository:
     └─📄 config.cmake.h.in     # SAPI's configuration header template
 └─📂 scripts
   └─📄 CMakeLists.txt          # CMake file for creating scripts files
-└─📂 TSRM
-  └─📄 CMakeLists.txt          # CMake file for Thread Safe Resource Manager
 └─📂 win32                     # Windows build files
   └─📂 build                   # Windows build files
     └─📄 wsyslog.mc            # Message template file for win32/wsyslog.h
diff --git a/docs/cmake/ext/opcache.md b/docs/cmake/ext/opcache.md
@@ -1,9 +1,7 @@
 <!-- This is auto-generated file. -->
 * Source code: [ext/opcache/CMakeLists.txt](https://github.com/petk/php-build-system/blob/master/cmake/ext/opcache/CMakeLists.txt)
 
-# The opcache extension
-
-Configure the `opcache` extension.
+# The Zend OPcache extension
 
 This extension enables the PHP OPcode caching engine.
 
@@ -19,7 +17,7 @@ Enable the extension. This extension is always built as shared when enabled.
 * Default: `ON`
 * Values: `ON|OFF`
 
-Enable copying PHP CODE pages into HUGE PAGES
+Enable copying PHP CODE pages into HUGE PAGES.
 
 ## EXT_OPCACHE_JIT
 
@@ -33,4 +31,4 @@ Enable JIT (Just-In-Time compiler).
 * Default: `OFF`
 * Values: `ON|OFF`
 
-Enable opcache JIT disassembly through Capstone.
+Enable OPcache JIT disassembly through Capstone engine.
diff --git a/docs/cmake/ext/pcntl.md b/docs/cmake/ext/pcntl.md
@@ -11,7 +11,7 @@ This extension provides support for process control support.
 > This extension is available only on \*nix systems.
 
 > [!IMPORTANT]
-> This extension should be used only with cgi, cli, embed, or phpdbg SAPI.
+> This extension should be used only with CLI-based PHP SAPIs.
 
 ## EXT_PCNTL
 
diff --git a/docs/cmake/ext/readline.md b/docs/cmake/ext/readline.md
@@ -8,7 +8,7 @@ Configure the `readline` extension.
 This extension provides interface for using Editline library.
 
 > [!IMPORTANT]
-> This extension should be used only with cgi, cli, embed, or phpdbg SAPI.
+> This extension should be used only with CLI-based PHP SAPIs.
 
 ## EXT_READLINE
 
diff --git a/docs/cmake/modules/FindCcache.md b/docs/cmake/modules/FindCcache.md
@@ -16,8 +16,8 @@ Find the Ccache compiler cache tool for faster compilation times.
 
 ## Hints
 
-* The `CCACHE_DISABLE` environment variable disables the ccache and doesn't add
-  it to the C and CXX launcher, see Ccache documentation for more info.
+* The `CCACHE_DISABLE` regular or environment variable which disables ccache and
+  doesn't adjust the C and CXX launcher. For more info see Ccache documentation.
 
 ## Basic usage
 
