WIP

Author: NoiseByNorthwest

.github/workflows/main.yml

@@ -16,6 +16,8 @@ on:
 jobs:
   build:
     name: build / php-${{ matrix.php }}-${{ matrix.ts }}-${{ matrix.name }}-${{ matrix.compiler }}
+    # FIXME temporary disabled
+    if: false
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
@@ -87,8 +89,64 @@ jobs:
           name: ${{ steps.setup-artifact.outputs.spx_file_name }}.zip
           path: ${{ steps.setup-artifact.outputs.spx_file_name }}.zip
 
+  build-win-old:
+    # FIXME this hacky pipeline will be cleaned later
+    if: false
+    runs-on: windows-latest
+    steps:
+      - name: Install zlib
+        run: |
+          vcpkg.exe install zlib
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - uses: ilammy/msvc-dev-cmd@0b201ec74fa43914dc39ae48a89fd1d8cb592756 # v1.13.0
+      - name: Setup PHP SDK with Developer Pack
+        uses: zephir-lang/setup-php-sdk@fd5f1bce00956a7e8ac30faaa1ff0692d6dacdfb # v1.0
+        with:
+          php_version: '8.3'
+          ts: 'nts'
+          msvc: 'vs16'
+          arch: 'x64'
+          install_dir: 'C:\tools'
+          cache_dir: 'C:\Temp'
+      - name: Clone PHP-src
+        run: |
+          git clone https://github.com/php/php-src.git C:\php-src
+      - name: Copy SPX to PHP-src ext directory
+        run: |
+          xcopy  /e /k /h /i . C:\php-src\ext\php-spx
+      - name: Configure and build 1
+        run: |
+          cd C:\php-src
+          ./buildconf.bat
+      - name: Configure and build 2
+        run: |
+          cd C:\php-src
+          ./configure --help
+          ./configure --disable-all --enable-cli --enable-spx
+      - name: Configure and build 3
+        run: |
+          cd C:\php-src
+          nmake
+
+  build-win:
+    runs-on: windows-latest
+    steps:
+      - name: Build the extension
+        uses: php/php-windows-builder/extension@5199585cd19be6fb11e6b229d4b662649dc79ac8
+        #uses: php/php-windows-builder/extension@2a031a68a7ed21340248d07946a8f655faf1d6aa
+        with:
+          #extension-url: https://github.com/xdebug/xdebug
+          #extension-ref: '3.3.1'
+          php-version: '8.3'
+          ts: nts
+          run-tests: false
+          arch: x64
+          args: --enable-spx
+          libs: zlib
+
   release:
-    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    # FIXME temporary disabled
+    if: false && github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
 
     needs: [ build ]
     name: Create Release

Makefile.frag.w32

@@ -0,0 +1,9 @@
+
+spx_ui_assets_dir = $(PHP_PREFIX)/share/misc/php-spx/assets/web-ui
+
+install-spx-ui-assets:
+	@echo "Installing SPX web UI to: $(spx_ui_assets_dir)"
+	@mkdir -p $(spx_ui_assets_dir)
+	@cp -r assets/web-ui/* $(spx_ui_assets_dir)
+
+install: $(all_targets) $(install_targets) install-spx-ui-assets

README.md

@@ -2,7 +2,7 @@
 
 [![Build Status][:badge-ci:]][:link-ci:]
 ![Supported PHP versions: 5.4 .. 8.x][:badge-php-versions:]
-![Supported platforms: GNU/Linux, macOS & FreeBSD][:badge-supported-platforms:]
+![Supported platforms: Linux, macOS, FreeBSD & Windows][:badge-supported-platforms:]
 ![Supported architectures: x86-64 or ARM64][:badge-supported-arch:]
 [![License][:badge-license:]][:link-license:]
 
@@ -34,12 +34,8 @@ It differentiates itself from other similar extensions as being:
 
 ## Requirements
 
-Platforms support is currently quite limited. Feel free to open an issue if your platform is not supported.
-Current requirements are:
-
 * x86-64 or ARM64
-* **GNU/Linux**, **macOS** or **FreeBSD**
-* zlib dev package (e.g. zlib1g-dev on Debian based distros)
+* **Linux**, **macOS**, **FreeBSD** or **Windows**
 * PHP 5.4 to 8.4
 
 ## Installation
@@ -66,6 +62,12 @@ sudo make install
 Then add `extension=spx.so` to your *php.ini*, or in a dedicated *spx.ini* file created within the include directory.
 You may also want to override [default SPX configuration](#configuration) to be able to profile a web request, with [this one](#private-environment) for example for a local development environment.
 
+### Windows
+
+Windows is supported, with these extra limitations:
+- live update of flat profile in CLI (`SPX_FP_LIVE=1`) is not supported.
+
+Also, consider Windows support as still being in beta.
 
 ### ZTS PHP (multi-thread)
 
@@ -78,7 +80,7 @@ Also, consider ZTS PHP support as still being in beta.
 
 ### Linux, PHP-FPM & I/O stats
 
-On GNU/Linux, SPX uses procfs (i.e. by reading files under `/proc` directory) to get some stats for the current process or thread. This is what is done under the hood when you select at least one of these metrics: `mor`, `io`, `ior` or `iow`.
+On Linux, SPX uses procfs (i.e. by reading files under `/proc` directory) to get some stats for the current process or thread. This is what is done under the hood when you select at least one of these metrics: `mor`, `io`, `ior` or `iow`.
 
 But, on most PHP-FPM setups, you will have a permission issue preventing SPX to open a file under `/proc/self` directory.
 This is due to the fact that PHP-FPM master process runs as root when child processes run as another unprivileged user.
@@ -315,7 +317,7 @@ Here is the list of available metrics to collect. By default only _Wall time_ an
 
 _\*: Allocated and freed byte counts will not be collected if you use a custom allocator or if you force the libc one through the `USE_ZEND_ALLOC` environment variable set to `0`._
 
-_\*\*: RSS & I/O metrics are not supported on macOS and FreeBSD. On GNU/Linux you should [read this if you use PHP-FPM](#linux-php-fpm--io-stats)._
+_\*\*: RSS & I/O metrics are not supported on macOS and FreeBSD. On Linux you should [read this if you use PHP-FPM](#linux-php-fpm--io-stats)._
 
 ### Command line script
 
@@ -504,7 +506,7 @@ See the [LICENSE][:link-license:] file for more information.
 [:link-ci:]:            https://github.com/NoiseByNorthwest/php-spx/actions/workflows/main.yml
 
 [:badge-php-versions:]: https://img.shields.io/badge/php-5.4--8.4-blue.svg
-[:badge-supported-platforms:]: https://img.shields.io/badge/platform-GNU/Linux%20|%20macOS%20|%20FreeBSD%20-yellow
+[:badge-supported-platforms:]: https://img.shields.io/badge/platform-Linux%20|%20macOS%20|%20FreeBSD%20-yellow
 [:badge-supported-arch:]: https://img.shields.io/badge/architecture-x86--64%20|%20ARM64%20-silver
 
 [:badge-license:]:      https://img.shields.io/github/license/NoiseByNorthwest/php-spx

config.w32

@@ -0,0 +1,46 @@
+ARG_ENABLE("spx", "Enable SPX extension", "no");
+
+ARG_ENABLE("spx-dev", "Compile SPX with debugging symbols", "no");
+
+if (PHP_SPX == "yes") {
+    AC_DEFINE("HAVE_SPX", 1, "spx");
+
+    base_dir = get_define('BUILD_DIR');
+    WScript.Echo("Creating " + base_dir + "\\src" + "...");
+    FSO.CreateFolder(base_dir+"\\src");
+
+    ADD_FLAG("CFLAGS", "/Ox /Wall /W2 /wd4820 /wd4774 /wd4711 /wd4710 /wd4464 /wd4005");
+
+    if (PHP_SPX_DEV == "yes") {
+        ADD_FLAG("CFLAGS", "/Zi");
+    }
+
+    if (
+        ! CHECK_LIB("zlib_a.lib;zlib.lib", "zlib", PHP_ZLIB) ||
+        ! CHECK_HEADER_ADD_INCLUDE("zlib.h", "CFLAGS", "..\\zlib;" + php_usual_include_suspects)
+    ) {
+        ERROR("zlib not found");
+    }
+
+    AC_DEFINE("SPX_HTTP_UI_ASSETS_DIR", PHP_PREFIX.replace(/\\/g, "/") + "/share/misc/php-spx/assets/web-ui");
+
+    EXTENSION("spx", "src/php_spx.c \
+        src/spx_profiler.c \
+        src/spx_profiler_tracer.c \
+        src/spx_profiler_sampler.c \
+        src/spx_reporter_full.c \
+        src/spx_reporter_fp.c \
+        src/spx_reporter_trace.c \
+        src/spx_metric.c \
+        src/spx_resource_stats.c \
+        src/spx_hmap.c \
+        src/spx_str_builder.c \
+        src/spx_output_stream.c \
+        src/spx_php.c \
+        src/spx_stdio.c \
+        src/spx_config.c \
+        src/spx_utils.c \
+        src/spx_fmt.c", true);
+
+    ADD_MAKEFILE_FRAGMENT();
+}

src/php_spx.h

@@ -23,8 +23,8 @@
 #include "main/php.h"
 
 /* linux 2.6+ or OSX */
-#if !defined(linux) && !(defined(__APPLE__) && defined(__MACH__)) && !defined(__FreeBSD__)
-#   error "Only Linux-based OSes, Apple MacOS and FreeBSD are supported"
+#if !defined(linux) && !(defined(__APPLE__) && defined(__MACH__)) && !defined(__FreeBSD__) && !defined(_WIN32)
+#   error "Only Linux-based OSes, Apple MacOS, FreeBSD and Windows are supported"
 #endif
 
 #if (defined(_MSC_VER) && !(defined(_M_X64) || defined(_M_ARM64))) || (!defined(_MSC_VER) && !(defined(__x86_64__) || defined(__aarch64__)))