lsOxidationGpuAbi.hpp

Go to the documentation of this file.

// Stable C ABI exported by the ViennaLS_GPU shared library: the linear solves
// of the oxidation solvers on the GPU (gpu/lsOxidationGpu.cu).
//
// The library links against the CUDA runtime.  ViennaLS itself must NOT, so
// that a build with GPU support still loads on machines with no CUDA runtime
// installed.  The library is therefore opened lazily with dlopen() and these
// symbols are resolved with dlsym() -- see lsOxidationGpuInterface.hpp.
//
// Everything here is deliberately plain C: opaque void* handles, no
// references, int instead of bool.  That keeps the boundary independent of
// C++ name mangling and of the standard library, so the two sides stay
// compatible even when built by different compilers (nvcc vs g++).
//
// Bump VIENNALS_GPU_ABI_VERSION on any incompatible change to the signatures
// below; the loader refuses a library reporting a different version.
 
#pragma once
 
#include <cstddef>
#include <cstdint>
 
#define VIENNALS_GPU_ABI_VERSION 3
 
// The exporting side (lsOxidationGpu.cu) must keep these visible even under
// -fvisibility=hidden, or dlsym() cannot find them.
#if defined(_WIN32)
#define VIENNALS_GPU_ABI __declspec(dllexport)
#else
#define VIENNALS_GPU_ABI __attribute__((visibility("default")))
#endif
 
extern "C" {

VIENNALS_GPU_ABI int viennalsGpuAbiVersion(void);

VIENNALS_GPU_ABI const char *viennalsGpuGetLastErrorMessage(void);

VIENNALS_GPU_ABI int
viennalsGpuDiffusionSolve(int64_t n, const int64_t *ptr, const int64_t *col,
                          const double *val, const double *rhs, double *x,
                          unsigned maxIterations, double absTolerance,
                          unsigned *outIterations);

VIENNALS_GPU_ABI void *viennalsGpuMacSetup(int64_t n, const int64_t *ptr,
                                           const int64_t *col,
                                           const double *val, int64_t nvel,
                                           int dim, const double *nullspace);

VIENNALS_GPU_ABI int
viennalsGpuMacSolve(void *handle, int64_t n, const int64_t *ptr,
                    const int64_t *col, const double *val, const double *rhs,
                    double *x, unsigned maxIterations, double tolerance,
                    unsigned *outIterations, double *outResidual);

VIENNALS_GPU_ABI void viennalsGpuMacFree(void *handle);
 
} // extern "C"