Environment Variables

This page lists all environment variables that can modify dtFFT behavior at runtime, offering users granular control over logging, performance measurement, and data transposition strategies.

DTFFT_ENABLE_LOG

Enables logging within the dtFFT library. By default, the library runs silently with no output. When enabled, it provides detailed insights into internal processes, aiding analysis and debugging.

Purpose

Logging enables monitoring of key operations, including:

  • Z-Slab Usage: Indicates whether the plan utilizes Z-slab optimization.

  • Selected Datatype IDs: Reports the datatype IDs or GPU backend chosen during autotuning when effort is DTFFT_PATIENT.

  • Execution Times During Autotune: Logs timing data for autotuning stages.

  • Detected Input Errors: Highlights errors from invalid user input for easier diagnosis.

Accepted Values

  • Type: Integer

  • Values: 0 (disabled), 1 (enabled)

  • Default: 0

DTFFT_MEASURE_WARMUP_ITERS

Defines the number of warmup iterations performed when effort exceeds DTFFT_ESTIMATE. Warmup iterations ensure stable performance measurements in parallel environments.

Purpose

Warmup iterations stabilize system performance by preloading caches, establishing communication channels, and mitigating initial overhead. This is crucial for accurate benchmarking, especially in distributed setups, preventing skewed results from cold starts.

Accepted Values

  • Type: Non-negative integer

  • Recommended Range: 2–10 (values > 0 are advised for reliable results)

  • Default: 2

DTFFT_MEASURE_ITERS

Specifies the number of measurement iterations for transposition and data exchange when effort exceeds DTFFT_ESTIMATE. Multiple iterations enhance measurement reliability.

Purpose

Single measurements may be inconsistent due to system noise or cache effects. By repeating transpositions, dtFFT averages performance data, ensuring robust selection of optimal GPU backends or MPI datatypes during autotuning.

Accepted Values

  • Type: Positive integer

  • Recommended Range: 5–20 (values > 1 balance accuracy and runtime)

  • Default: 5

DTFFT_PLATFORM

Specifies the execution platform for dtFFT plans. This environment variable allows users to override the platform set via the dtfft_config_t structure, taking precedence over API configuration.

Purpose

The DTFFT_PLATFORM variable provides a flexible way to control whether dtFFT executes on the host (CPU) or a CUDA-enabled GPU without modifying code or API calls. It ensures that runtime platform selection aligns with user preferences or system capabilities, prioritizing environment settings over programmatic defaults.

Accepted Values

  • Type: String

  • Supported Values:

    • host: Execute on the host (CPU).

    • cuda: Execute on a CUDA device (GPU).

  • Default: host

Note

  • Case-insensitive (e.g., HOST is equivalent to host).

  • Only applicable in builds with CUDA support (DTFFT_WITH_CUDA defined). In non-CUDA builds, it is ignored, and execution defaults to the host.

  • If an unsupported value is provided, it is silently ignored, and the default (host) is used.

DTFFT_BACKEND

Specifies the GPU backend used by dtFFT for data transposition and communication when executing plans on a CUDA device. This environment variable allows users to override the backend selected through the dtfft_config_t structure, taking precedence over API configuration.

Purpose

The DTFFT_BACKEND variable enables users to select a specific GPU backend for optimizing data movement and computation in dtFFT plans. Different backends offer varying performance characteristics depending on the system configuration, workload, and MPI implementation, allowing fine-tuned control over GPU execution without modifying code.

Accepted Values

  • Type: String

  • Supported Values:

    • mpi_dt: Backend using MPI datatypes.

    • mpi_p2p: MPI peer-to-peer backend.

    • mpi_a2a: MPI backend using MPI_Alltoallv.

    • mpi_p2p_pipe: Pipelined MPI peer-to-peer backend with overlapping data copying and unpacking.

    • nccl: NCCL backend.

    • nccl_pipe: Pipelined NCCL backend with overlapping data copying and unpacking.

    • cufftmp: cuFFTMp backend.

  • Default: nccl if NCCL is available in the library build; otherwise, mpi_p2p.

Note

  • Case-insensitive (e.g., MPI_DT is equivalent to mpi_dt).

  • Only applicable in builds with CUDA support (DTFFT_WITH_CUDA defined) and when the execution platform is set to cuda (via DTFFT_PLATFORM or dtfft_config_t).

  • If an unsupported value is provided, it is silently ignored, and the default backend (nccl or mpi_p2p, depending on build) is used.

  • Availability of some backends (e.g., nccl, nccl_pipe, cufftmp) depends on additional library support (e.g., NCCL, cuFFTMp) during compilation.

DTFFT_NCCL_BUFFER_REGISTER

Specifies whether to enable buffer registration for NCCL operations. When enabled, NCCL buffers are registered, which can improve performance for certain workloads.

Purpose

Buffer registration can reduce the overhead of memory operations in NCCL by pre-registering memory regions. This is particularly useful for workloads with repeated communication patterns. However, in some cases, disabling registration may be beneficial, depending on the specific system configuration or workload characteristics.

Accepted Values

  • Type: Integer

  • Accepted Values:

    • 0: Disable NCCL buffer registration.

    • 1: Enable NCCL buffer registration.

  • Default: 1

DTFFT_ENABLE_Z_SLAB

Specifies whether to enable Z-slab optimization for dtFFT plans. When enabled, Z-slab optimization reduces network data transfers by employing a two-dimensional FFT algorithm.

Purpose

Z-slab optimization is designed to improve performance for plans decomposed as NX × NY × NZ / P. Disabling it may resolve issues like DTFFT_ERROR_VKFFT_R2R_2D_PLAN or improve performance if the underlying 2D FFT implementation is suboptimal.

Accepted Values

  • Type: Integer

  • Accepted Values:

    • 0: Disable Z-slab optimization.

    • 1: Enable Z-slab optimization.

  • Default: 1

Note

If this environment variable is set, it takes precedence over the value specified in dtfft_config_t.

DTFFT_ENABLE_MPI

Specifies whether to enable MPI-based GPU backends for dtFFT plans. When enabled, MPI backends (e.g., MPI P2P) are tested during autotuning.

Purpose

MPI backends are useful for distributed GPU systems but may cause GPU memory leaks in certain OpenMPI versions. Disabling this option can prevent such issues.

Accepted Values

  • Type: Integer

  • Accepted Values:

    • 0: Disable MPI-based GPU backends.

    • 1: Enable MPI-based GPU backends.

  • Default: 0

Note

  • Only applicable in builds with CUDA support (DTFFT_WITH_CUDA defined) and when the execution platform is set to cuda (via DTFFT_PLATFORM or dtfft_config_t).

  • If this environment variable is set, it takes precedence over the value specified in dtfft_config_t.

DTFFT_ENABLE_NCCL

Specifies whether to enable NCCL backends for dtFFT plans. When enabled, NCCL backends are tested during autotuning.

Purpose

NCCL backends are optimized for GPU-to-GPU communication and can significantly improve performance in multi-GPU systems.

Accepted Values

  • Type: Integer

  • Accepted Values:

    • 0: Disable NCCL backends.

    • 1: Enable NCCL backends.

  • Default: 1

Note

  • Only applicable in builds with CUDA support (DTFFT_WITH_CUDA defined) and when the execution platform is set to cuda (via DTFFT_PLATFORM or dtfft_config_t).

  • If this environment variable is set, it takes precedence over the value specified in dtfft_config_t.

DTFFT_ENABLE_NVSHMEM

Specifies whether to enable NVSHMEM backends for dtFFT plans. When enabled, NVSHMEM backends are tested during autotuning.

Purpose

NVSHMEM backends provide efficient communication for GPU clusters, leveraging shared memory capabilities.

Accepted Values

  • Type: Integer

  • Accepted Values:

    • 0: Disable NVSHMEM backends.

    • 1: Enable NVSHMEM backends.

  • Default: 1

Note

  • Only applicable in builds with CUDA support (DTFFT_WITH_CUDA defined) and when the execution platform is set to cuda (via DTFFT_PLATFORM or dtfft_config_t).

  • If this environment variable is set, it takes precedence over the value specified in dtfft_config_t.

DTFFT_ENABLE_PIPE

Specifies whether to enable pipelined GPU backends for dtFFT plans. When enabled, pipelined backends (e.g., overlapping data copy and unpack) are tested during autotuning.

Purpose

Pipelined backends improve performance by overlapping communication and computation, but they require additional internal buffers.

Accepted Values

  • Type: Integer

  • Accepted Values:

    • 0: Disable pipelined GPU backends.

    • 1: Enable pipelined GPU backends.

  • Default: 1

Note

  • Only applicable in builds with CUDA support (DTFFT_WITH_CUDA defined) and when the execution platform is set to cuda (via DTFFT_PLATFORM or dtfft_config_t).

  • If this environment variable is set, it takes precedence over the value specified in dtfft_config_t.

MPI Datatype Selection Variables

These environment variables control how MPI derived datatypes are constructed for global data transpositions in the host version of dtFFT. They apply only when effort is DTFFT_ESTIMATE or DTFFT_MEASURE; for DTFFT_PATIENT, the library autotunes the best datatype automatically.

Purpose

MPI derived datatypes define the memory layout for data exchanged between processes during transposition. Two construction methods are supported:

  • Method 1 (1): Contiguous send datatype with sparse receive datatype.

  • Method 2 (2): Sparse send datatype with contiguous receive datatype (default).

These variables allow manual selection based on data characteristics or system requirements.

Accepted Values

  • Type: Integer

  • Values: 1 (Method 1), 2 (Method 2)

DTFFT_DTYPE_X_Y

Controls datatype construction for X-to-Y transposition. - Default: 2

DTFFT_DTYPE_Y_Z

Controls datatype construction for Y-to-Z transposition. - Default: 2

DTFFT_DTYPE_X_Z

Controls datatype construction for X-to-Z transposition. - Default: 2

DTFFT_DTYPE_Y_X

Controls datatype construction for Y-to-X transposition. - Default: 2

DTFFT_DTYPE_Z_Y

Controls datatype construction for Z-to-Y transposition. - Default: 2

DTFFT_DTYPE_Z_X

Controls datatype construction for Z-to-X transposition. - Default: 2