feature: Initial Windows compilation and command support using MinGW

.gitignore

@@ -21,3 +21,6 @@ tests/*.pyc
 
 # Ignore PyPI build artifacts
 dist/
+
+.vscode/
+.github

ENVIRONMENT.md

@@ -0,0 +1,298 @@
+# Environment Setup for nvme-cli
+
+This guide covers how to set up your development environment for building nvme-cli and libnvme on Linux and Windows platforms.
+
+## Dependencies Overview
+
+### Core Build Tools
+
+**Both Platforms:**
+- Meson >= 0.62.0 (build system)
+- Ninja (build backend) or Samurai (minimal alternative)
+- C compiler (GCC or Clang on Linux, MinGW with GCC on Windows)
+
+### Platform-Specific Dependencies
+
+#### Linux Dependencies
+
+**Required:**
+- gcc or clang
+- meson
+- ninja-build or samurai
+
+**Optional (recommended):**
+- json-c >= 0.13 (for JSON output and plugins)
+- OpenSSL >= 3.0.0 (for security features)
+- libkeyutils (for key management)
+- liburing >= 2.2 (for io_uring support)
+- dbus-1 (for MCTP dbus scan support)
+
+**Documentation (optional):**
+- asciidoc or asciidoctor
+- xmlto
+
+**Testing (optional):**
+- Python 3 with pytest (for tests)
+- SWIG (for Python bindings)
+
+#### Windows Dependencies
+
+**Required:**
+- MinGW-w64
+- Meson
+- Ninja
+- Python 3.8+
+
+**Optional:**
+- OpenSSL >= 3.0.0 (for security features)
+- Perl (for documentation generation scripts)
+
+**Note:** On Windows, Linux-specific dependencies (json-c, liburing, keyutils, libdbus) are automatically disabled.
+
+## Linux Environment Setup
+
+### Ubuntu/Debian
+
+```bash
+# Install core build tools
+sudo apt update
+sudo apt install -y build-essential meson ninja-build pkg-config
+
+# Install optional dependencies
+sudo apt install -y \
+    libjson-c-dev \
+    libssl-dev \
+    libkeyutils-dev \
+    libdbus-1-dev
+
+# For io_uring support (optional)
+sudo apt install -y liburing-dev
+
+# For documentation generation (optional)
+sudo apt install -y asciidoc xmlto
+
+# For Python bindings (optional)
+sudo apt install -y python3-dev swig
+```
+
+### Fedora/RHEL/CentOS
+
+```bash
+# Install core build tools
+sudo dnf install -y gcc meson ninja-build pkgconfig
+
+# Install optional dependencies
+sudo dnf install -y \
+    json-c-devel \
+    openssl-devel \
+    keyutils-libs-devel \
+    dbus-devel
+
+# For io_uring support (optional)
+sudo dnf install -y liburing-devel
+
+# For documentation generation (optional)
+sudo dnf install -y asciidoc xmlto
+
+# For Python bindings (optional)
+sudo dnf install -y python3-devel swig
+```
+
+### Arch Linux
+
+```bash
+# Install core build tools
+sudo pacman -S base-devel meson ninja pkg-config
+
+# Install optional dependencies
+sudo pacman -S json-c openssl keyutils dbus
+
+# For io_uring support (optional)
+sudo pacman -S liburing
+
+# For documentation generation (optional)
+sudo pacman -S asciidoc xmlto
+
+# For Python bindings (optional)
+sudo pacman -S python swig
+```
+
+## Windows Environment Setup
+
+### Using WinGet (Windows 10/11)
+
+WinGet provides the easiest way to set up the build environment on Windows:
+
+#### Installation
+
+```powershell
+# Install MinGW-w64 (GCC compiler toolchain)
+winget install BrechtSanders.WinLibs.POSIX.UCRT
+
+# Install Python (required for meson)
+winget install Python.Python.3.12
+
+# Install Perl (required for documentation generation scripts)
+winget install StrawberryPerl.StrawberryPerl
+
+# Install Meson build system (after Python is installed)
+pip install meson
+
+# Install OpenSSL (optional, for security features)
+winget install ShiningLight.OpenSSL
+```
+
+#### Setting Up PATH
+
+After installation, you need to add the tools to your PATH:
+
+**Temporary PATH setup (for current PowerShell session):**
+
+```powershell
+# Set PATH to include MinGW, Python, and Meson
+$env:PATH = "C:\Users\$env:USERNAME\AppData\Local\Microsoft\WinGet\Packages\BrechtSanders.WinLibs.POSIX.UCRT_Microsoft.Winget.Source_8wekyb3d8bbwe\mingw64\bin;C:\Users\$env:USERNAME\AppData\Local\Programs\Python\Python312\Scripts;C:\Users\$env:USERNAME\AppData\Local\Programs\Python\Python312;$env:PATH"
+```
+
+**Note:** The exact path for MinGW may vary depending on your WinGet installation. Use this command to locate it:
+```powershell
+Get-ChildItem -Path "$env:LOCALAPPDATA\Microsoft\WinGet\Packages" -Filter "BrechtSanders.WinLibs*" -Directory
+```
+
+**Permanent PATH setup:**
+
+To avoid setting PATH every time:
+
+1. Open System Properties:
+   - Press `Win + X` → System → Advanced system settings
+   - Or search for "Environment Variables" in Start Menu
+
+2. Click "Environment Variables"
+
+3. Under "User variables", select "Path" and click "Edit"
+
+4. Click "New" and add these paths (adjust the username and exact paths as needed):
+   - `C:\Users\YourUsername\AppData\Local\Microsoft\WinGet\Packages\BrechtSanders.WinLibs.POSIX.UCRT_Microsoft.Winget.Source_8wekyb3d8bbwe\mingw64\bin`
+   - `C:\Users\YourUsername\AppData\Local\Programs\Python\Python312`
+   - `C:\Users\YourUsername\AppData\Local\Programs\Python\Python312\Scripts`
+
+5. Click OK on all dialogs
+
+6. Restart PowerShell or any open terminals
+
+#### Verification
+
+Verify the installation by checking versions:
+
+```powershell
+gcc --version
+python --version
+meson --version
+ninja --version
+```
+
+Expected output should show:
+- GCC 15.x or later
+- Python 3.12.x or later
+- Meson 1.x or later
+- Ninja 1.x or later
+
+## Troubleshooting Environment Setup
+
+### Windows: Finding Installation Paths
+
+If you need to locate where WinGet installed tools:
+
+**Find Python:**
+```powershell
+Get-ChildItem -Path "$env:LOCALAPPDATA\Programs\Python" -Recurse -Filter "python.exe" -ErrorAction SilentlyContinue | Select-Object -First 1 -ExpandProperty FullName
+```
+
+**Find Meson:**
+```powershell
+Get-ChildItem -Path "$env:LOCALAPPDATA" -Recurse -Filter "meson.exe" -ErrorAction SilentlyContinue | Select-Object -First 1 -ExpandProperty FullName
+```
+
+**Find GCC (MinGW):**
+```powershell
+Get-ChildItem -Path "$env:LOCALAPPDATA" -Recurse -Filter "gcc.exe" -ErrorAction SilentlyContinue | Select-Object -First 1 -ExpandProperty FullName
+```
+
+### Windows: Command Not Found Errors
+
+**"meson: command not found"**
+
+Solution: Add Python Scripts directory to PATH:
+```powershell
+$env:PATH = "C:\Users\$env:USERNAME\AppData\Local\Programs\Python\Python312\Scripts;$env:PATH"
+```
+
+**"gcc: command not found"**
+
+Solution: Add MinGW bin directory to PATH:
+```powershell
+$env:PATH = "C:\Users\$env:USERNAME\AppData\Local\Microsoft\WinGet\Packages\BrechtSanders.WinLibs.POSIX.UCRT_Microsoft.Winget.Source_8wekyb3d8bbwe\mingw64\bin;$env:PATH"
+```
+
+**"python: command not found"**
+
+Solution: Add Python to PATH:
+```powershell
+$env:PATH = "C:\Users\$env:USERNAME\AppData\Local\Programs\Python\Python312;$env:PATH"
+```
+
+### Linux: Missing Dependencies
+
+**json-c not found:**
+```bash
+# Ubuntu/Debian
+sudo apt install libjson-c-dev
+
+# Fedora/RHEL
+sudo dnf install json-c-devel
+
+# Arch
+sudo pacman -S json-c
+```
+
+**OpenSSL not found:**
+```bash
+# Ubuntu/Debian
+sudo apt install libssl-dev
+
+# Fedora/RHEL
+sudo dnf install openssl-devel
+
+# Arch
+sudo pacman -S openssl
+```
+
+**Meson too old:**
+```bash
+# Install newer version via pip
+pip3 install --user meson
+
+# Add to PATH if needed
+export PATH="$HOME/.local/bin:$PATH"
+```
+
+### Verifying Your Environment
+
+After setup, verify all required tools are available:
+
+**Linux:**
+```bash
+gcc --version
+meson --version
+ninja --version
+pkg-config --version
+```
+
+**Windows:**
+```powershell
+gcc --version
+python --version
+meson --version
+ninja --version
+```
+
+If any command fails, review the PATH setup instructions above.

WINDOWS-PORT-README.md

@@ -0,0 +1,43 @@
+# Windows Port README
+
+This document outlines some of the design choices and strategies used during the development of Windows support.
+
+## Windows support strategy using MinGW
+
+The mingw-w64 libraries and tools were chosen for the design to provide a more straightforward port to Windows, taking advantage of its headers and libraries and the GNU toolchain, including the gcc compiler. Benefits from this approach include faster turnaround, toolchain compatibility, and fewer code changes, which will help the code be more maintainable.
+
+Installation and configuration of mingw and other tools such as meson, python, perl, and OpenSSL is described in [ENVIRONMENT.md](ENVIRONMENT.md). Meson build configuration is the same on Windows as on Linux.
+
+## Windows build configuration support
+
+The Meson build configuration files have been updated to detect the platform, and configure the build accordingly. Configuration options remain unchanged. On Windows builds, some features are flagged as not supported, and some files are not yet included in the build.
+
+## Platform-specific includes
+
+To reduce preprocessor checks for `_WIN32` throughout the codebase, common platform-specific includes, type definitions, and utility functions are centralized in `platform/linux.h` and `platform/windows.h` under libnvme. Code can include `platform/include.h`, which includes the appropriate platform header based on the target platform.
+
+Some methods, macros, and types used throughout the code lack direct Windows equivalents. Windows-specific implementations and definitions have been added to `platform/windows.h` and `platform/windows.c`.
+
+For types defined by `linux/types.h` on Linux, a new `platform/types.h` was created to define equivalent types for Windows. On Linux, `platform/types.h` simply includes `linux/types.h`. All project includes of `linux/types.h` have been replaced with `platform/types.h`.
+
+## Stubs for currently unsupported methods
+
+To allow compilation while some features remain unsupported on Windows, `windows-stubs.c` files contain stubbed implementations of unsupported methods. As support is added, these stubs are removed. These stub files are temporary and will be phased out as development progresses.
+
+The Meson build configurations determine whether to build using the windows-stub.c files or the standard implementation files based on the target platform.
+
+## Platform-specific method implementation
+
+Many existing implementations work for both Linux and Windows. When platform-specific implementations are needed, we follow this pattern:
+
+- **Header files (.h)**: Method declarations remain unchanged and platform-agnostic.
+- **Windows implementations (filename-windows.c)**: Platform-specific implementations for Windows are placed in files following the naming convention `filename-windows.c` (for example, `ioctl-windows.c`).
+- **Platform-agnostic implementations**: Code that works on both Linux and Windows remains in the existing `.c` file.
+- **Linux-specific implementations**: Linux-only code remains in the existing `.c` file within `#ifndef _WIN32` guards. Eventually, we plan to extract these into separate `filename-linux.c` files. For now, keeping them inline simplifies upstream merging and ensures we don't miss method updates from the main project.
+- **Build configuration**: The Meson build configuration determines which implementation files to include in the build based on the target platform.
+
+Some Windows methods behave differently than their Linux counterparts and require project-specific implementations. Examples include `fstat` and `free`. We created wrapper methods such as `nvme_fstat` and `nvme_free` with platform-specific implementations to provide platform-agnostic interfaces throughout the codebase.
+
+### The linux.h / linux.c exception
+
+The files `nvme/linux.h` and `nvme/linux.c` present a problem for the pattern described above. Although the file names suggests that the methods they implement are Linux-specific, they are actually utility methods that are needed for both Linux and Windows implementations, and many of the existing implementations are compitible with Windows using MinGW. For now, a new file named `nvme/windows.c` contains the Windows-specific implementations of methods declared in `nvme/linux.h`, breaking with the pattern. Re-evaluation of the linux.h / linux.c names is needed.

ccan/ccan/minmax/minmax.h

@@ -21,6 +21,10 @@
 	do { } while (0)
 #endif
 
+/* Undefine any existing min/max macros. */
+#undef min
+#undef max
+
 #define min(a, b) \
 	({ \
 		typeof(a) _a = (a); \

common.h

@@ -9,8 +9,13 @@
 
 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
 
+/* On Windows, min/max may be provided by libnvme but ensure they exist */
+#ifndef min
 #define min(x, y) ((x) > (y) ? (y) : (x))
+#endif
+#ifndef max
 #define max(x, y) ((x) > (y) ? (x) : (y))
+#endif
 
 #ifdef __packed
 #else /* __packed */

fabrics.c

@@ -36,7 +36,7 @@
 #include <time.h>
 
 #include <sys/types.h>
-#include <linux/types.h>
+#include <platform/types.h>
 
 #include <libnvme.h>
 

libnvme-wrap.c

@@ -5,7 +5,9 @@
  * Copyright (c) 2022 Daniel Wagner, SUSE
  */
 
+#ifndef _WIN32
 #include <dlfcn.h>
+#endif
 #include <errno.h>
 #include <stdlib.h>