cufft_utils.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021-2025, NVIDIA CORPORATION.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#pragma once
 
#include <raft/core/error.hpp>
 
#include <cufft.h>
 
// TODO move to raft https://github.com/rapidsai/raft/issues/91
namespace raft {
 
struct cufft_error : public raft::exception {
  explicit cufft_error(char const* const message) : raft::exception(message) {}
  explicit cufft_error(std::string const& message) : raft::exception(message) {}
};
 
const char* getCufftErrStr(cufftResult status)
{
  // https://docs.nvidia.com/cuda/cufft/index.html#cufftresult
  switch (status) {
    case CUFFT_SUCCESS: return "The cuFFT operation was successful.";
    case CUFFT_INVALID_PLAN: return "cuFFT was passed an invalid plan handle.";
    case CUFFT_ALLOC_FAILED: return "cuFFT failed to allocate GPU or CPU memory.";
    case CUFFT_INVALID_VALUE: return "User specified an invalid pointer or parameter.";
    case CUFFT_INTERNAL_ERROR: return "Driver or internal cuFFT library error.";
    case CUFFT_EXEC_FAILED: return "Failed to execute an FFT on the GPU.";
    case CUFFT_SETUP_FAILED: return "The cuFFT library failed to initialize.";
    case CUFFT_INVALID_SIZE: return "User specified an invalid transform size.";
#if defined(CUDART_VERSION) && CUDART_VERSION < 13000
    case CUFFT_INCOMPLETE_PARAMETER_LIST: return "Missing parameters in call.";
#endif
    case CUFFT_INVALID_DEVICE:
      return "Execution of a plan was on different GPU than plan creation.";
#if defined(CUDART_VERSION) && CUDART_VERSION < 13000
    case CUFFT_PARSE_ERROR: return "Internal plan database error.";
#endif
    case CUFFT_NO_WORKSPACE: return "No workspace has been provided prior to plan execution.";
    case CUFFT_NOT_IMPLEMENTED:
      return "Function does not implement functionality for parameters given.";
    case CUFFT_NOT_SUPPORTED: return "Operation is not supported for parameters given.";
    default: return "Unknown error.";
  }
}
 
#define CUFFT_TRY(call)                             \
  do {                                              \
    const cufftResult status = call;                \
    if (status != CUFFT_SUCCESS) {                  \
      std::string msg{};                            \
      SET_ERROR_MSG(msg,                            \
                    "cuFFT error encountered at: ", \
                    "call='%s', Reason=%s",         \
                    #call,                          \
                    raft::getCufftErrStr(status));  \
      throw raft::cufft_error(msg);                 \
    }                                               \
  } while (0)
 
class CuFFTHandle {
 public:
  CuFFTHandle(cudaStream_t stream)
  {
    CUFFT_TRY(cufftCreate(&handle));
    CUFFT_TRY(cufftSetStream(handle, stream));
  }
  ~CuFFTHandle() { cufftDestroy(handle); }
  operator cufftHandle() const { return handle; }
 
 private:
  cufftHandle handle;
};
 
}  // namespace raft