Skip to content

chore: clean up cufile fixtures #1313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rwgk merged 2 commits into from
Dec 5, 2025
Merged

chore: clean up cufile fixtures #1313

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
732999c
chore: clean up cufile fixtures
cpcloud Dec 4, 2025
ab443fc
chore: remove somewhat useless `raw_driver`
cpcloud Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
139 changes: 51 additions & 88 deletions cuda_bindings/tests/test_cufile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,46 +24,18 @@
force=True, # Override any existing logging configuration
)


def platform_is_tegra_linux():
return pathlib.Path("/etc/nv_tegra_release").exists()


if platform_is_tegra_linux():
pytest.skip("skipping cuFile tests on Tegra Linux", allow_module_level=True)


def platform_is_wsl():
"""Check if running on Windows Subsystem for Linux (WSL)."""
return platform.system() == "Linux" and "microsoft" in pathlib.Path("/proc/version").read_text().lower()


if platform_is_wsl():
pytest.skip("skipping cuFile tests on WSL", allow_module_level=True)


from cuda.bindings.cufile import cuFileError
cufile = pytest.importorskip("cuda.bindings.cufile", reason="skipping tests on Windows")
Copy link
Collaborator

@rwgk rwgk Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a duplicate, see line 18.

I think it's best to not give a reason, the default message is fine:

SKIPPED [1] tests\test_cufile.py:18: could not import 'cuda.bindings.cufile': No module named 'cuda.bindings.cufile'

Note that I had reasons to temporarily disable building the cufile bindings in the CTK 13.1 pre-release testing on platforms other than Windows. In such cases a manually specified reason can be misleading.



@pytest.fixture
def cufile_env_json():
def cufile_env_json(monkeypatch):
"""Set CUFILE_ENV_PATH_JSON environment variable for async tests."""
original_value = os.environ.get("CUFILE_ENV_PATH_JSON")

# Get absolute path to cufile.json in the same directory as this test file
test_dir = os.path.dirname(os.path.abspath(__file__))
config_path = os.path.join(test_dir, "cufile.json")
logging.info(f"Using cuFile config: {config_path}")
assert os.path.isfile(config_path)
os.environ["CUFILE_ENV_PATH_JSON"] = config_path

yield

# Restore original value or remove if it wasn't set
if original_value is not None:
os.environ["CUFILE_ENV_PATH_JSON"] = original_value
else:
del os.environ["CUFILE_ENV_PATH_JSON"]
monkeypatch.setenv("CUFILE_ENV_PATH_JSON", config_path)
logging.info(f"Using cuFile config: {config_path}")


@cache
Expand Down Expand Up @@ -108,11 +80,18 @@ def isSupportedFilesystem():


# Global skip condition for all tests if cuFile library is not available
pytestmark = pytest.mark.skipif(not cufileLibraryAvailable(), reason="cuFile library not available on this system")
pytestmark = [
Copy link
Collaborator

@rwgk rwgk Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pytestmark is not referenced. I removed it locally and pre-commit didn't complain:

-pytestmark = [
+[

Copy link
Contributor Author

@cpcloud cpcloud Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That will break the test suite, because pytestmark is a special variable: https://docs.pytest.org/en/stable/example/markers.html#marking-whole-classes-or-modules.

pytest.mark.skipif(not cufileLibraryAvailable(), reason="cuFile library not available on this system"),
pytest.mark.skipif(
platform.system() == "Linux" and "microsoft" in pathlib.Path("/proc/version").read_text().lower(),
Copy link
Collaborator

@rwgk rwgk Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For readability, and to make it easier to experiment when requirements change (e.g. new platforms), I'd prefer if we kept the helper functions and call them from here.

Copy link
Contributor Author

@cpcloud cpcloud Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find them incredibly noisy. Can't you just add a line to the pytestmark list when you're experimenting?

Copy link
Contributor Author

@cpcloud cpcloud Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then you can comment things in and out without having to jump around to function definitions.

Copy link
Contributor Author

@cpcloud cpcloud Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That said, I don't really have a major issue with the function version, I just really don't want to do the actual skipping there (the previous pattern).

reason="skipping cuFile tests on WSL",
),
pytest.mark.skipif(pathlib.Path("/etc/nv_tegra_release").exists(), reason="skipping cuFile tests on Tegra Linux"),
]

xfail_handle_register = pytest.mark.xfail(
condition=isSupportedFilesystem() and os.environ.get("CI") is not None,
raises=cuFileError,
raises=cufile.cuFileError,
reason="handle_register call fails in CI for unknown reasons",
)

Expand Down Expand Up @@ -615,13 +594,10 @@ def test_cufile_read_write_large():


@pytest.mark.skipif(not isSupportedFilesystem(), reason="cuFile handle_register requires ext4 or xfs filesystem")
@pytest.mark.usefixtures("ctx")
@pytest.mark.usefixtures("ctx", "cufile_env_json", "driver")
@xfail_handle_register
def test_cufile_write_async(cufile_env_json):
def test_cufile_write_async():
"""Test cuFile asynchronous write operations."""
# Open cuFile driver
cufile.driver_open()

# Create test file
file_path = "test_cufile_write_async.bin"
fd = os.open(file_path, os.O_CREAT | os.O_RDWR | os.O_DIRECT, 0o600)
Expand Down Expand Up @@ -693,17 +669,13 @@ def test_cufile_write_async(cufile_env_json):
os.close(fd)
with suppress(OSError):
os.unlink(file_path)
cufile.driver_close()


@pytest.mark.skipif(not isSupportedFilesystem(), reason="cuFile handle_register requires ext4 or xfs filesystem")
@pytest.mark.usefixtures("ctx")
@pytest.mark.usefixtures("ctx", "cufile_env_json", "driver")
@xfail_handle_register
def test_cufile_read_async(cufile_env_json):
def test_cufile_read_async():
"""Test cuFile asynchronous read operations."""
# Open cuFile driver
cufile.driver_open()

# Create test file
file_path = "test_cufile_read_async.bin"

Expand Down Expand Up @@ -788,17 +760,13 @@ def test_cufile_read_async(cufile_env_json):
os.close(fd)
with suppress(OSError):
os.unlink(file_path)
cufile.driver_close()


@pytest.mark.skipif(not isSupportedFilesystem(), reason="cuFile handle_register requires ext4 or xfs filesystem")
@pytest.mark.usefixtures("ctx")
@xfail_handle_register
def test_cufile_async_read_write(cufile_env_json):
@pytest.mark.usefixtures("ctx", "cufile_env_json", "driver")
def test_cufile_async_read_write():
"""Test cuFile asynchronous read and write operations in sequence."""
# Open cuFile driver
cufile.driver_open()

# Create test file
file_path = "test_cufile_async_rw.bin"
fd = os.open(file_path, os.O_CREAT | os.O_RDWR | os.O_DIRECT, 0o600)
Expand Down Expand Up @@ -906,7 +874,6 @@ def test_cufile_async_read_write(cufile_env_json):
os.close(fd)
with suppress(OSError):
os.unlink(file_path)
cufile.driver_close()


@pytest.mark.skipif(not isSupportedFilesystem(), reason="cuFile handle_register requires ext4 or xfs filesystem")
Expand Down Expand Up @@ -1864,30 +1831,30 @@ def test_get_bar_size_in_kb():
logging.info(f"GPU BAR size: {bar_size_kb} KB ({bar_size_kb / 1024 / 1024:.2f} GB)")


@pytest.mark.skipif(
cufileVersionLessThan(1150), reason="cuFile parameter APIs require cuFile library version 13.0 or later"
)
@pytest.mark.usefixtures("ctx")
def test_set_parameter_posix_pool_slab_array():
"""Test cuFile POSIX pool slab array configuration."""
# Define slab sizes for POSIX I/O pool (common I/O buffer sizes) - BEFORE driver open
import ctypes

slab_sizes = [
@pytest.fixture(scope="module")
def slab_sizes():
"""Define slab sizes for POSIX I/O pool (common I/O buffer sizes) - BEFORE driver open"""
return [
4096, # 4KB - small files
65536, # 64KB - medium files
1048576, # 1MB - large files
16777216, # 16MB - very large files
]

# Define counts for each slab size (number of buffers)
slab_counts = [

@pytest.fixture(scope="module")
def slab_counts():
"""Define counts for each slab size (number of buffers)"""
return [
10, # 10 buffers of 4KB
5, # 5 buffers of 64KB
3, # 3 buffers of 1MB
2, # 2 buffers of 16MB
]


@pytest.fixture
def driver_config(slab_sizes, slab_counts):
# Convert to ctypes arrays
size_array_type = ctypes.c_size_t * len(slab_sizes)
count_array_type = ctypes.c_size_t * len(slab_counts)
Expand All @@ -1899,32 +1866,28 @@ def test_set_parameter_posix_pool_slab_array():
ctypes.addressof(size_array), ctypes.addressof(count_array), len(slab_sizes)
)

# Open cuFile driver AFTER setting parameters
cufile.driver_open()

try:
# After setting parameters, retrieve them back to verify
retrieved_sizes = (ctypes.c_size_t * len(slab_sizes))()
retrieved_counts = (ctypes.c_size_t * len(slab_counts))()

cufile.get_parameter_posix_pool_slab_array(
ctypes.addressof(retrieved_sizes), ctypes.addressof(retrieved_counts), len(slab_sizes)
)

# Verify they match what we set
for i in range(len(slab_sizes)):
assert retrieved_sizes[i] == slab_sizes[i], (
f"Size mismatch at index {i}: expected {slab_sizes[i]}, got {retrieved_sizes[i]}"
)
assert retrieved_counts[i] == slab_counts[i], (
f"Count mismatch at index {i}: expected {slab_counts[i]}, got {retrieved_counts[i]}"
)
@pytest.mark.skipif(
cufileVersionLessThan(1150), reason="cuFile parameter APIs require cuFile library version 13.0 or later"
)
@pytest.mark.usefixtures("ctx")
def test_set_parameter_posix_pool_slab_array(slab_sizes, slab_counts, driver_config):
"""Test cuFile POSIX pool slab array configuration."""
# After setting parameters, retrieve them back to verify
n_slab_sizes = len(slab_sizes)
retrieved_sizes = (ctypes.c_size_t * n_slab_sizes)()
retrieved_counts = (ctypes.c_size_t * len(slab_counts))()

# Verify configuration was accepted successfully
logging.info(f"POSIX pool slab array configured with {len(slab_sizes)} slab sizes")
logging.info(f"Slab sizes: {[f'{size // 1024}KB' for size in slab_sizes]}")
logging.info("Round-trip verification successful: set and retrieved values match")
retrieved_sizes_addr = ctypes.addressof(retrieved_sizes)
retrieved_counts_addr = ctypes.addressof(retrieved_counts)

# Open cuFile driver AFTER setting parameters
cufile.driver_open()
try:
cufile.get_parameter_posix_pool_slab_array(retrieved_sizes_addr, retrieved_counts_addr, n_slab_sizes)
finally:
# Close cuFile driver
cufile.driver_close()

# Verify they match what we set
assert list(retrieved_sizes) == slab_sizes
assert list(retrieved_counts) == slab_counts
Loading