[fix] Fix FUSE struct issues on NetBSD

Author: mxmlnkn

.github/workflows/tests.yml

@@ -132,7 +132,7 @@ jobs:
           # https://github.com/pyca/pynacl/issues/839
           # https://github.com/pyca/pynacl/pull/848
           python3 -m pip install --upgrade git+https://github.com/pyca/pynacl.git
-          python3 -m pip install --upgrade-strategy eager --upgrade twine build pytest ioctl-opt paramiko types-paramiko
+          python3 -m pip install --upgrade-strategy eager --upgrade twine build pytest pytest-order ioctl-opt paramiko types-paramiko
 
       - name: Test Installation From Tarball
         run: |
@@ -194,18 +194,24 @@ jobs:
     timeout-minutes: 10
 
     strategy:
-      fail-fast: false
       matrix:
          include:
            - os: freebsd
              version: '14.3'
              display_name: FreeBSD
+           - os: freebsd
+             version: '13.5'
+             display_name: FreeBSD
            - os: openbsd
              version: '7.7'
              display_name: OpenBSD
+           # OpenBSD 6.9 is not supported because it only has Python 3.8, which is not supported anymore.
            - os: netbsd
              version: '10.1'
              display_name: NetBSD
+           - os: netbsd
+             version: '9.4'
+             display_name: NetBSD
 
     steps:
       - name: Check out repository
@@ -241,11 +247,7 @@ jobs:
                 sudo -E chmod 666 /dev/fuse
 
                 # Install pip Dependencies
-                python3 -m pip install --upgrade pip
-                python3 -m pip install --upgrade wheel
-                python3 -m pip install --upgrade setuptools
-                python3 -m pip install "pynacl==1.5.0"
-                python3 -m pip install pytest ioctl-opt
+                python3 -m pip install pytest pytest-order ioctl-opt
 
                 # Test Installation From Source
                 python3 -m pip install .
@@ -267,11 +269,7 @@ jobs:
                 # Install pip Dependencies
                 python3 -m venv .venv
                 source .venv/bin/activate
-                python3 -m pip install --upgrade pip
-                python3 -m pip install --upgrade wheel
-                python3 -m pip install --upgrade setuptools
-                python3 -m pip install "pynacl==1.5.0"
-                python3 -m pip install pytest ioctl-opt
+                python3 -m pip install pytest pytest-order ioctl-opt
 
                 # Test Installation From Source
                 python3 -m pip install .
@@ -305,11 +303,7 @@ jobs:
                 sudo chmod 777 /var/run
 
                 # Install pip Dependencies
-                python3 -m pip install --upgrade pip
-                python3 -m pip install --upgrade wheel
-                python3 -m pip install --upgrade setuptools
-                python3 -m pip install "pynacl==1.5.0"
-                python3 -m pip install pytest ioctl-opt
+                python3 -m pip install pytest pytest-order ioctl-opt
 
                 # Test Installation From Source
                 python3 -m pip install .

mfusepy.py

@@ -34,6 +34,7 @@
 from typing import TYPE_CHECKING, Any, Optional, Union, get_type_hints
 
 FieldsEntry = Union[tuple[str, type], tuple[str, type, int]]
+BitFieldsEntry = tuple[str, type, int]
 ReadDirResult = Iterable[Union[str, tuple[str, dict[str, int], int], tuple[str, int, int]]]
 
 if TYPE_CHECKING:
@@ -742,9 +743,60 @@ class c_flock_t(ctypes.Structure):  # type: ignore
 #  - 3.14.1 -> 3.16.2: no change
 _fuse_int32 = ctypes.c_int32 if (fuse_version_major, fuse_version_minor) >= (3, 17) else ctypes.c_int
 _fuse_uint32 = ctypes.c_uint32 if (fuse_version_major, fuse_version_minor) >= (3, 17) else ctypes.c_uint
-if fuse_version_major == 2:
+_fuse_file_info_fields_: list[FieldsEntry] = []
+_fuse_file_info_fields_bitfield: list[BitFieldsEntry] = []
+if _system == 'NetBSD':
+    # NetBSD has its own FUSE library reimplementation with mismatching struct layouts!
+    # writepage is a bitfield (as in libFUSE 3.x), but the fh_old member still exists and the reported version is 2.9!
+    # https://www.netbsd.org/docs/puffs/
+    # https://github.com/NetBSD/src/blob/netbsd-11/lib/librefuse/fuse.h#L100-L129
+    # https://github.com/NetBSD/src/blob/netbsd-10/lib/librefuse/fuse.h#L100-L129
+    #  - fuse_file_info is unchanged between 10 and 11
+    #  - FUSE_USE_VERSION is not set, but is set to _REFUSE_VERSION_ (3.10) with a warning if not set!
+    #  - However, the CI prints FUSE version 2.9?!
+    #  - Seems there is no sane way to get the correct compiled version! This is again an absolute shit show!
+    # https://github.com/NetBSD/src/blob/netbsd-9/lib/librefuse/fuse.h#L51-L61
+    #  - fuse_file_info looks quite different and version is specified as 2.6!
+    #  - #define FUSE_USE_VERSION 26
+    fuse_version = (fuse_version_major, fuse_version_minor)
+    _fuse_file_info_fields_ = [
+        ('flags', ctypes.c_int32),
+        ('fh_old', ctypes.c_uint32),
+    ]
+
+    if fuse_version >= (2, 9):
+        _fuse_file_info_fields_bitfield += [('writepage', ctypes.c_int32, 1)]
+    else:
+        _fuse_file_info_fields_ += [('writepage', ctypes.c_int32)]
+
+    _fuse_file_info_fields_bitfield += [
+        ('direct_io', ctypes.c_uint32, 1),  # Introduced in FUSE 2.4
+        ('keep_cache', ctypes.c_uint32, 1),  # Introduced in FUSE 2.4
+        ('flush', ctypes.c_uint32, 1),  # Introduced in FUSE 2.6
+    ]
+    if fuse_version >= (2, 9):
+        _fuse_file_info_fields_bitfield += [
+            ('nonseekable', ctypes.c_uint, 1),  # Introduced in FUSE 2.8
+            ('flock_release', ctypes.c_uint, 1),  # Introduced in FUSE 2.9
+            ('cache_readdir', ctypes.c_uint, 1),  # Introduced in FUSE 3.5
+        ]
+
+    _fuse_file_info_flag_count = sum(x[2] for x in _fuse_file_info_fields_bitfield)
+    assert _fuse_file_info_flag_count < ctypes.sizeof(_fuse_uint32) * 8
+
+    _fuse_file_info_fields_ += _fuse_file_info_fields_bitfield
+    _fuse_file_info_fields_ += [
+        ('padding', _fuse_uint32, ctypes.sizeof(_fuse_uint32) * 8 - _fuse_file_info_flag_count),
+        ('fh', ctypes.c_uint64),
+        ('lock_owner', ctypes.c_uint64),
+    ]
+
+    if fuse_version >= (2, 9):
+        _fuse_file_info_fields_ += [('poll_events', ctypes.c_uint32)]
+
+elif fuse_version_major == 2:
     _fh_old_type = ctypes.c_uint if _system == 'OpenBSD' else ctypes.c_ulong
-    _fuse_file_info_fields_: list[FieldsEntry] = [
+    _fuse_file_info_fields_ = [
         ('flags', ctypes.c_int),
         ('fh_old', _fh_old_type),
         ('writepage', ctypes.c_int),
@@ -972,7 +1024,8 @@ class fuse_conn_info(ctypes.Structure):  # Added in 2.6 (ABI break of "init" fro
     # Another ABI break as discussed here: https://lists.debian.org/debian-devel/2024/03/msg00278.html
     # The break was in 3.14.1 NOT in 3.14.0, but I cannot query the bugfix version.
     # I'd hope that all 3.14.0 installations have been replaced by updates to 3.14.1.
-    if fuse_version_minor >= 14 and fuse_version_minor < 17:
+    # ... they have not. My own system, Ubuntu 24.04 uses fuse 3.14.0. Check for >= 3.15.
+    if fuse_version_minor >= 15 and fuse_version_minor < 17:
         _fuse_config_fields_ += [('parallel_direct_writes', ctypes.c_int)]
 
     _fuse_config_fields_ += [

tests/requirements-tests.txt

@@ -9,3 +9,4 @@ pylint
 pytest
 pytype
 mypy
+pytest-order