xref: /petsc/src/sys/objects/device/impls/cupm/cupmdevice.cxx (revision e5265faf5e3e5d0db06dbb9f30d95b1e01199e35)
1030f984aSJacob Faibussowitsch #include "../../interface/cupmdevice.hpp"
2a4af0ceeSJacob Faibussowitsch #include <algorithm>
3a4af0ceeSJacob Faibussowitsch #include <csetjmp> // for cuda mpi awareness
4a4af0ceeSJacob Faibussowitsch #include <csignal> // SIGSEGV
5a4af0ceeSJacob Faibussowitsch #include <iterator>
6a4af0ceeSJacob Faibussowitsch #include <type_traits>
7030f984aSJacob Faibussowitsch 
8a4af0ceeSJacob Faibussowitsch #if PetscDefined(USE_LOG)
9a4af0ceeSJacob Faibussowitsch PETSC_INTERN PetscErrorCode PetscLogInitialize(void);
10a4af0ceeSJacob Faibussowitsch #else
11a4af0ceeSJacob Faibussowitsch #define PetscLogInitialize() 0
12a4af0ceeSJacob Faibussowitsch #endif
13a4af0ceeSJacob Faibussowitsch 
14a4af0ceeSJacob Faibussowitsch namespace Petsc
15a4af0ceeSJacob Faibussowitsch {
16030f984aSJacob Faibussowitsch 
1717f48955SJacob Faibussowitsch namespace Device
18030f984aSJacob Faibussowitsch {
1917f48955SJacob Faibussowitsch 
2017f48955SJacob Faibussowitsch namespace CUPM
2117f48955SJacob Faibussowitsch {
2217f48955SJacob Faibussowitsch 
2317f48955SJacob Faibussowitsch // internal "impls" class for CUPMDevice. Each instance represents a single cupm device
2417f48955SJacob Faibussowitsch template <DeviceType T>
2517f48955SJacob Faibussowitsch class Device<T>::DeviceInternal
2617f48955SJacob Faibussowitsch {
2717f48955SJacob Faibussowitsch   const int        id_;
2817f48955SJacob Faibussowitsch   bool             devInitialized_ = false;
2917f48955SJacob Faibussowitsch   cupmDeviceProp_t dprop_; // cudaDeviceProp appears to be an actual struct, i.e. you can't
30a4af0ceeSJacob Faibussowitsch                            // initialize it with nullptr or NULL (i've tried)
31a4af0ceeSJacob Faibussowitsch 
3217f48955SJacob Faibussowitsch   PETSC_CXX_COMPAT_DECL(bool CUPMAwareMPI_());
33030f984aSJacob Faibussowitsch 
34030f984aSJacob Faibussowitsch public:
35030f984aSJacob Faibussowitsch   // default constructor
3617f48955SJacob Faibussowitsch   explicit constexpr DeviceInternal(int dev) noexcept : id_(dev) { }
37030f984aSJacob Faibussowitsch 
38030f984aSJacob Faibussowitsch   // gather all relevant information for a particular device, a cupmDeviceProp_t is
39030f984aSJacob Faibussowitsch   // usually sufficient here
40a4af0ceeSJacob Faibussowitsch   PETSC_NODISCARD PetscErrorCode initialize() noexcept;
41a4af0ceeSJacob Faibussowitsch   PETSC_NODISCARD PetscErrorCode configure() noexcept;
42a4af0ceeSJacob Faibussowitsch   PETSC_NODISCARD PetscErrorCode view(PetscViewer) const noexcept;
43a4af0ceeSJacob Faibussowitsch   PETSC_NODISCARD PetscErrorCode finalize() noexcept;
44a4af0ceeSJacob Faibussowitsch 
4517f48955SJacob Faibussowitsch   PETSC_NODISCARD auto id()          const -> decltype(id_)             { return id_;             }
4617f48955SJacob Faibussowitsch   PETSC_NODISCARD auto initialized() const -> decltype(devInitialized_) { return devInitialized_; }
4717f48955SJacob Faibussowitsch   PETSC_NODISCARD auto prop()        const -> const decltype(dprop_)&   { return dprop_;          }
48a4af0ceeSJacob Faibussowitsch 
49a4af0ceeSJacob Faibussowitsch   // factory
5017f48955SJacob Faibussowitsch   PETSC_CXX_COMPAT_DECL(std::unique_ptr<DeviceInternal> makeDevice(int i))
51030f984aSJacob Faibussowitsch   {
5217f48955SJacob Faibussowitsch     return std::unique_ptr<DeviceInternal>(new DeviceInternal(i));
53030f984aSJacob Faibussowitsch   }
54030f984aSJacob Faibussowitsch };
55030f984aSJacob Faibussowitsch 
56a4af0ceeSJacob Faibussowitsch // the goal here is simply to get the cupm backend to create its context, not to do any type of
57a4af0ceeSJacob Faibussowitsch // modification of it, or create objects (since these may be affected by subsequent
58a4af0ceeSJacob Faibussowitsch // configuration changes)
5917f48955SJacob Faibussowitsch template <DeviceType T>
6017f48955SJacob Faibussowitsch PetscErrorCode Device<T>::DeviceInternal::initialize() noexcept
61030f984aSJacob Faibussowitsch {
62030f984aSJacob Faibussowitsch   cupmError_t cerr;
63030f984aSJacob Faibussowitsch 
64030f984aSJacob Faibussowitsch   PetscFunctionBegin;
6517f48955SJacob Faibussowitsch   if (devInitialized_) PetscFunctionReturn(0);
6617f48955SJacob Faibussowitsch   devInitialized_ = true;
67a4af0ceeSJacob Faibussowitsch   // need to do this BEFORE device has been set, although if the user
68a4af0ceeSJacob Faibussowitsch   // has already done this then we just ignore it
69a4af0ceeSJacob Faibussowitsch   if (cupmSetDeviceFlags(cupmDeviceMapHost) == cupmErrorSetOnActiveProcess) {
70a4af0ceeSJacob Faibussowitsch     // reset the error if it was cupmErrorSetOnActiveProcess
71a4af0ceeSJacob Faibussowitsch     const auto PETSC_UNUSED unused = cupmGetLastError();
72a4af0ceeSJacob Faibussowitsch   } else {CHKERRCUPM(cupmGetLastError());}
73a4af0ceeSJacob Faibussowitsch   // cuda 5.0+ will create a context when cupmSetDevice is called
7417f48955SJacob Faibussowitsch   if (cupmSetDevice(id_) != cupmErrorDeviceAlreadyInUse) CHKERRCUPM(cupmGetLastError());
75a4af0ceeSJacob Faibussowitsch   // forces cuda < 5.0 to initialize a context
76a4af0ceeSJacob Faibussowitsch   cerr = cupmFree(nullptr);CHKERRCUPM(cerr);
77a4af0ceeSJacob Faibussowitsch   // where is this variable defined and when is it set? who knows! but it is defined and set
78a4af0ceeSJacob Faibussowitsch   // at this point. either way, each device must make this check since I guess MPI might not be
79a4af0ceeSJacob Faibussowitsch   // aware of all of them?
80a4af0ceeSJacob Faibussowitsch   if (use_gpu_aware_mpi) {
81a4af0ceeSJacob Faibussowitsch     // For OpenMPI, we could do a compile time check with
82a4af0ceeSJacob Faibussowitsch     // "defined(PETSC_HAVE_OMPI_MAJOR_VERSION) && defined(MPIX_CUDA_AWARE_SUPPORT) &&
83a4af0ceeSJacob Faibussowitsch     // MPIX_CUDA_AWARE_SUPPORT" to see if it is CUDA-aware. However, recent versions of IBM
84a4af0ceeSJacob Faibussowitsch     // Spectrum MPI (e.g., 10.3.1) on Summit meet above conditions, but one has to use jsrun
85a4af0ceeSJacob Faibussowitsch     // --smpiargs=-gpu to really enable GPU-aware MPI. So we do the check at runtime with a
86a4af0ceeSJacob Faibussowitsch     // code that works only with GPU-aware MPI.
8717f48955SJacob Faibussowitsch     if (PetscUnlikely(!CUPMAwareMPI_())) {
88a4af0ceeSJacob Faibussowitsch       (*PetscErrorPrintf)("PETSc is configured with GPU support, but your MPI is not GPU-aware. For better performance, please use a GPU-aware MPI.\n");
89a4af0ceeSJacob Faibussowitsch       (*PetscErrorPrintf)("If you do not care, add option -use_gpu_aware_mpi 0. To not see the message again, add the option to your .petscrc, OR add it to the env var PETSC_OPTIONS.\n");
90a4af0ceeSJacob Faibussowitsch       (*PetscErrorPrintf)("If you do care, for IBM Spectrum MPI on OLCF Summit, you may need jsrun --smpiargs=-gpu.\n");
91a4af0ceeSJacob Faibussowitsch       (*PetscErrorPrintf)("For OpenMPI, you need to configure it --with-cuda (https://www.open-mpi.org/faq/?category=buildcuda)\n");
92a4af0ceeSJacob Faibussowitsch       (*PetscErrorPrintf)("For MVAPICH2-GDR, you need to set MV2_USE_CUDA=1 (http://mvapich.cse.ohio-state.edu/userguide/gdr/)\n");
93a4af0ceeSJacob Faibussowitsch       (*PetscErrorPrintf)("For Cray-MPICH, you need to set MPICH_RDMA_ENABLED_CUDA=1 (https://www.olcf.ornl.gov/tutorials/gpudirect-mpich-enabled-cuda/)\n");
94a4af0ceeSJacob Faibussowitsch       PETSCABORT(PETSC_COMM_SELF,PETSC_ERR_LIB);
95a4af0ceeSJacob Faibussowitsch     }
96a4af0ceeSJacob Faibussowitsch   }
97a4af0ceeSJacob Faibussowitsch   PetscFunctionReturn(0);
98a4af0ceeSJacob Faibussowitsch }
99a4af0ceeSJacob Faibussowitsch 
10017f48955SJacob Faibussowitsch template <DeviceType T>
10117f48955SJacob Faibussowitsch PetscErrorCode Device<T>::DeviceInternal::configure() noexcept
102a4af0ceeSJacob Faibussowitsch {
103a4af0ceeSJacob Faibussowitsch   cupmError_t    cerr;
104a4af0ceeSJacob Faibussowitsch   PetscErrorCode ierr;
105a4af0ceeSJacob Faibussowitsch 
106a4af0ceeSJacob Faibussowitsch   PetscFunctionBegin;
107bf025ffbSJacob Faibussowitsch   PetscAssert(devInitialized_,PETSC_COMM_SELF,PETSC_ERR_COR,"Device %d being configured before it was initialized",id_);
108030f984aSJacob Faibussowitsch   // why on EARTH nvidia insists on making otherwise informational states into
109030f984aSJacob Faibussowitsch   // fully-fledged error codes is beyond me. Why couldn't a pointer to bool argument have
110030f984aSJacob Faibussowitsch   // sufficed?!?!?!
11117f48955SJacob Faibussowitsch   if (cupmSetDevice(id_) != cupmErrorDeviceAlreadyInUse) CHKERRCUPM(cupmGetLastError());
112a4af0ceeSJacob Faibussowitsch   // need to update the device properties
11317f48955SJacob Faibussowitsch   cerr = cupmGetDeviceProperties(&dprop_,id_);CHKERRCUPM(cerr);
1147d3de750SJacob Faibussowitsch   ierr = PetscInfo(nullptr,"Configured device %d\n",id_);CHKERRQ(ierr);
115a4af0ceeSJacob Faibussowitsch   PetscFunctionReturn(0);
116a4af0ceeSJacob Faibussowitsch }
117a4af0ceeSJacob Faibussowitsch 
11817f48955SJacob Faibussowitsch template <DeviceType T>
11917f48955SJacob Faibussowitsch PetscErrorCode Device<T>::DeviceInternal::view(PetscViewer viewer) const noexcept
120a4af0ceeSJacob Faibussowitsch {
121a4af0ceeSJacob Faibussowitsch   PetscBool      iascii;
122a4af0ceeSJacob Faibussowitsch   PetscErrorCode ierr;
123a4af0ceeSJacob Faibussowitsch 
124a4af0ceeSJacob Faibussowitsch   PetscFunctionBegin;
125bf025ffbSJacob Faibussowitsch   PetscAssert(devInitialized_,PETSC_COMM_SELF,PETSC_ERR_COR,"Device %d being viewed before it was initialized or configured",id_);
12617f48955SJacob Faibussowitsch   ierr = PetscObjectTypeCompare(PetscObjectCast(viewer),PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
12717f48955SJacob Faibussowitsch   if (iascii) {
12817f48955SJacob Faibussowitsch     MPI_Comm    comm;
12917f48955SJacob Faibussowitsch     PetscMPIInt rank;
130c0b02e83SStefano Zampini     PetscViewer sviewer;
13117f48955SJacob Faibussowitsch 
13217f48955SJacob Faibussowitsch     ierr = PetscObjectGetComm(PetscObjectCast(viewer),&comm);CHKERRQ(ierr);
133a4af0ceeSJacob Faibussowitsch     ierr = MPI_Comm_rank(comm,&rank);CHKERRMPI(ierr);
134c0b02e83SStefano Zampini     ierr = PetscViewerGetSubViewer(viewer,PETSC_COMM_SELF,&sviewer);CHKERRQ(ierr);
135c0b02e83SStefano Zampini     ierr = PetscViewerASCIIPrintf(sviewer,"[%d] device %d: %s\n",rank,id_,dprop_.name);CHKERRQ(ierr);
136c0b02e83SStefano Zampini     ierr = PetscViewerASCIIPushTab(sviewer);CHKERRQ(ierr);
137c0b02e83SStefano Zampini     ierr = PetscViewerASCIIPrintf(sviewer,"Compute capability: %d.%d\n",dprop_.major,dprop_.minor);CHKERRQ(ierr);
138c0b02e83SStefano Zampini     ierr = PetscViewerASCIIPrintf(sviewer,"Multiprocessor Count: %d\n",dprop_.multiProcessorCount);CHKERRQ(ierr);
139c0b02e83SStefano Zampini     ierr = PetscViewerASCIIPrintf(sviewer,"Maximum Grid Dimensions: %d x %d x %d\n",dprop_.maxGridSize[0],dprop_.maxGridSize[1],dprop_.maxGridSize[2]);CHKERRQ(ierr);
140c0b02e83SStefano Zampini     ierr = PetscViewerASCIIPrintf(sviewer,"Maximum Block Dimensions: %d x %d x %d\n",dprop_.maxThreadsDim[0],dprop_.maxThreadsDim[1],dprop_.maxThreadsDim[2]);CHKERRQ(ierr);
141c0b02e83SStefano Zampini     ierr = PetscViewerASCIIPrintf(sviewer,"Maximum Threads Per Block: %d\n",dprop_.maxThreadsPerBlock);CHKERRQ(ierr);
142c0b02e83SStefano Zampini     ierr = PetscViewerASCIIPrintf(sviewer,"Warp Size: %d\n",dprop_.warpSize);CHKERRQ(ierr);
143c0b02e83SStefano Zampini     ierr = PetscViewerASCIIPrintf(sviewer,"Total Global Memory (bytes): %zu\n",dprop_.totalGlobalMem);CHKERRQ(ierr);
144c0b02e83SStefano Zampini     ierr = PetscViewerASCIIPrintf(sviewer,"Total Constant Memory (bytes): %zu\n",dprop_.totalConstMem);CHKERRQ(ierr);
145c0b02e83SStefano Zampini     ierr = PetscViewerASCIIPrintf(sviewer,"Shared Memory Per Block (bytes): %zu\n",dprop_.sharedMemPerBlock);CHKERRQ(ierr);
146c0b02e83SStefano Zampini     ierr = PetscViewerASCIIPrintf(sviewer,"Multiprocessor Clock Rate (KHz): %d\n",dprop_.clockRate);CHKERRQ(ierr);
147c0b02e83SStefano Zampini     ierr = PetscViewerASCIIPrintf(sviewer,"Memory Clock Rate (KHz): %d\n",dprop_.memoryClockRate);CHKERRQ(ierr);
148c0b02e83SStefano Zampini     ierr = PetscViewerASCIIPrintf(sviewer,"Memory Bus Width (bits): %d\n",dprop_.memoryBusWidth);CHKERRQ(ierr);
149c0b02e83SStefano Zampini     ierr = PetscViewerASCIIPrintf(sviewer,"Peak Memory Bandwidth (GB/s): %f\n",2.0*dprop_.memoryClockRate*(dprop_.memoryBusWidth/8)/1.0e6);CHKERRQ(ierr);
150c0b02e83SStefano Zampini     ierr = PetscViewerASCIIPrintf(sviewer,"Can map host memory: %s\n",dprop_.canMapHostMemory ? "PETSC_TRUE" : "PETSC_FALSE");CHKERRQ(ierr);
151c0b02e83SStefano Zampini     ierr = PetscViewerASCIIPrintf(sviewer,"Can execute multiple kernels concurrently: %s\n",dprop_.concurrentKernels ? "PETSC_TRUE" : "PETSC_FALSE");CHKERRQ(ierr);
152c0b02e83SStefano Zampini     ierr = PetscViewerASCIIPopTab(sviewer);CHKERRQ(ierr);
153c0b02e83SStefano Zampini     ierr = PetscViewerFlush(sviewer);CHKERRQ(ierr);
154c0b02e83SStefano Zampini     ierr = PetscViewerRestoreSubViewer(viewer,PETSC_COMM_SELF,&sviewer);CHKERRQ(ierr);
15517f48955SJacob Faibussowitsch     ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
15617f48955SJacob Faibussowitsch   }
157a4af0ceeSJacob Faibussowitsch   PetscFunctionReturn(0);
158a4af0ceeSJacob Faibussowitsch }
159a4af0ceeSJacob Faibussowitsch 
160a4af0ceeSJacob Faibussowitsch static std::jmp_buf cupmMPIAwareJumpBuffer;
161a4af0ceeSJacob Faibussowitsch static bool         cupmMPIAwareJumpBufferSet;
162a4af0ceeSJacob Faibussowitsch 
163a4af0ceeSJacob Faibussowitsch // godspeed to anyone that attempts to call this function
164a4af0ceeSJacob Faibussowitsch void SilenceVariableIsNotNeededAndWillNotBeEmittedWarning_ThisFunctionShouldNeverBeCalled()
165a4af0ceeSJacob Faibussowitsch {
166a4af0ceeSJacob Faibussowitsch   PETSCABORT(MPI_COMM_NULL,INT_MAX);
167a4af0ceeSJacob Faibussowitsch   if (cupmMPIAwareJumpBufferSet) (void)cupmMPIAwareJumpBuffer;
168a4af0ceeSJacob Faibussowitsch }
169a4af0ceeSJacob Faibussowitsch 
170bf025ffbSJacob Faibussowitsch #define CHKCUPMAWARE(expr) if (PetscUnlikely((expr) != cupmSuccess)) return false
171a4af0ceeSJacob Faibussowitsch 
17217f48955SJacob Faibussowitsch template <DeviceType T>
17317f48955SJacob Faibussowitsch PETSC_CXX_COMPAT_DEFN(bool Device<T>::DeviceInternal::CUPMAwareMPI_())
174a4af0ceeSJacob Faibussowitsch {
175a4af0ceeSJacob Faibussowitsch   constexpr int  bufSize = 2;
176a4af0ceeSJacob Faibussowitsch   constexpr int  hbuf[bufSize] = {1,0};
177a4af0ceeSJacob Faibussowitsch   int            *dbuf = nullptr;
17817f48955SJacob Faibussowitsch   constexpr auto bytes = bufSize*sizeof(*dbuf);
17917f48955SJacob Faibussowitsch   auto           awareness = false;
180a4af0ceeSJacob Faibussowitsch   cupmError_t    cerr;
181a4af0ceeSJacob Faibussowitsch   PetscErrorCode ierr;
182a4af0ceeSJacob Faibussowitsch   const auto     cupmSignalHandler = [](int signal, void *ptr) -> PetscErrorCode {
183a4af0ceeSJacob Faibussowitsch     if ((signal == SIGSEGV) && cupmMPIAwareJumpBufferSet) std::longjmp(cupmMPIAwareJumpBuffer,1);
184a4af0ceeSJacob Faibussowitsch     return PetscSignalHandlerDefault(signal,ptr);
185a4af0ceeSJacob Faibussowitsch   };
186a4af0ceeSJacob Faibussowitsch 
187a4af0ceeSJacob Faibussowitsch   PetscFunctionBegin;
18817f48955SJacob Faibussowitsch   cerr = cupmMalloc(reinterpret_cast<void**>(&dbuf),bytes);CHKCUPMAWARE(cerr);
18917f48955SJacob Faibussowitsch   cerr = cupmMemcpy(dbuf,hbuf,bytes,cupmMemcpyHostToDevice);CHKCUPMAWARE(cerr);
190a4af0ceeSJacob Faibussowitsch   ierr = PetscPushSignalHandler(cupmSignalHandler,nullptr);CHKERRABORT(PETSC_COMM_SELF,ierr);
191a4af0ceeSJacob Faibussowitsch   cupmMPIAwareJumpBufferSet = true;
192a4af0ceeSJacob Faibussowitsch   if (setjmp(cupmMPIAwareJumpBuffer)) {
193a4af0ceeSJacob Faibussowitsch     // if a segv was triggered in the MPI_Allreduce below, it is very likely due to MPI not
194a4af0ceeSJacob Faibussowitsch     // being GPU-aware
195a4af0ceeSJacob Faibussowitsch     awareness = false;
196a4af0ceeSJacob Faibussowitsch     // control flow up until this point:
19717f48955SJacob Faibussowitsch     // 1. CUPMDevice<T>::CUPMDeviceInternal::MPICUPMAware__()
198a4af0ceeSJacob Faibussowitsch     // 2. MPI_Allreduce
199a4af0ceeSJacob Faibussowitsch     // 3. SIGSEGV
200a4af0ceeSJacob Faibussowitsch     // 4. PetscSignalHandler_Private
201a4af0ceeSJacob Faibussowitsch     // 5. cupmSignalHandler (lambda function)
202a4af0ceeSJacob Faibussowitsch     // 6. here
203a4af0ceeSJacob Faibussowitsch     // PetscSignalHandler_Private starts with PetscFunctionBegin and is pushed onto the stack
204a4af0ceeSJacob Faibussowitsch     // so we must undo this. This would be most naturally done in cupmSignalHandler, however
205a4af0ceeSJacob Faibussowitsch     // the C/C++ standard dictates:
206a4af0ceeSJacob Faibussowitsch     //
207a4af0ceeSJacob Faibussowitsch     // After invoking longjmp(), non-volatile-qualified local objects should not be accessed if
208a4af0ceeSJacob Faibussowitsch     // their values could have changed since the invocation of setjmp(). Their value in this
209a4af0ceeSJacob Faibussowitsch     // case is considered indeterminate, and accessing them is undefined behavior.
210a4af0ceeSJacob Faibussowitsch     //
211a4af0ceeSJacob Faibussowitsch     // so for safety (since we don't know what PetscStackPop may try to read/declare) we do it
212a4af0ceeSJacob Faibussowitsch     // outside of the longjmp control flow
213a4af0ceeSJacob Faibussowitsch     PetscStackPop;
214a4af0ceeSJacob Faibussowitsch   } else if (!MPI_Allreduce(dbuf,dbuf+1,1,MPI_INT,MPI_SUM,PETSC_COMM_SELF)) awareness = true;
215a4af0ceeSJacob Faibussowitsch   cupmMPIAwareJumpBufferSet = false;
216a4af0ceeSJacob Faibussowitsch   ierr = PetscPopSignalHandler();CHKERRABORT(PETSC_COMM_SELF,ierr);
217a4af0ceeSJacob Faibussowitsch   cerr = cupmFree(dbuf);CHKCUPMAWARE(cerr);
218a4af0ceeSJacob Faibussowitsch   PetscFunctionReturn(awareness);
219a4af0ceeSJacob Faibussowitsch }
220a4af0ceeSJacob Faibussowitsch 
221bf025ffbSJacob Faibussowitsch #undef CHKCUPMAWARE
222bf025ffbSJacob Faibussowitsch 
22317f48955SJacob Faibussowitsch template <DeviceType T>
22417f48955SJacob Faibussowitsch PetscErrorCode Device<T>::DeviceInternal::finalize() noexcept
225a4af0ceeSJacob Faibussowitsch {
226a4af0ceeSJacob Faibussowitsch   PetscFunctionBegin;
22717f48955SJacob Faibussowitsch   devInitialized_ = false;
228a4af0ceeSJacob Faibussowitsch   PetscFunctionReturn(0);
229a4af0ceeSJacob Faibussowitsch }
230a4af0ceeSJacob Faibussowitsch 
23117f48955SJacob Faibussowitsch template <DeviceType T>
23217f48955SJacob Faibussowitsch PetscErrorCode Device<T>::finalize_() noexcept
233a4af0ceeSJacob Faibussowitsch {
234a4af0ceeSJacob Faibussowitsch   PetscFunctionBegin;
23517f48955SJacob Faibussowitsch   if (!initialized_) PetscFunctionReturn(0);
23617f48955SJacob Faibussowitsch   for (auto&& device : devices_) {
237a4af0ceeSJacob Faibussowitsch     if (device) {
238a4af0ceeSJacob Faibussowitsch       const auto ierr = device->finalize();CHKERRQ(ierr);
239a4af0ceeSJacob Faibussowitsch       device.reset();
240a4af0ceeSJacob Faibussowitsch     }
241a4af0ceeSJacob Faibussowitsch   }
24217f48955SJacob Faibussowitsch   defaultDevice_ = PETSC_CUPM_DEVICE_NONE;  // disabled by default
24317f48955SJacob Faibussowitsch   initialized_   = false;
244a4af0ceeSJacob Faibussowitsch   PetscFunctionReturn(0);
245a4af0ceeSJacob Faibussowitsch }
246a4af0ceeSJacob Faibussowitsch 
24717f48955SJacob Faibussowitsch // these functions should be named identically to the option they produce where "CUPMTYPE" and
24817f48955SJacob Faibussowitsch // "cupmtype" are the uppercase and lowercase string versions of the cupm backend respectively
24917f48955SJacob Faibussowitsch template <DeviceType T>
25017f48955SJacob Faibussowitsch PETSC_CXX_COMPAT_DECL(PETSC_CONSTEXPR_14 const char* PetscDevice_CUPMTYPE_Options())
25117f48955SJacob Faibussowitsch {
25217f48955SJacob Faibussowitsch   switch (T) {
25317f48955SJacob Faibussowitsch   case DeviceType::CUDA: return "PetscDevice CUDA Options";
25417f48955SJacob Faibussowitsch   case DeviceType::HIP:  return "PetscDevice HIP Options";
25517f48955SJacob Faibussowitsch   }
256bf025ffbSJacob Faibussowitsch   PetscUnreachable();
257bf025ffbSJacob Faibussowitsch   return "PETSC_ERROR_PLIB";
258a4af0ceeSJacob Faibussowitsch }
259a4af0ceeSJacob Faibussowitsch 
26017f48955SJacob Faibussowitsch template <DeviceType T>
26117f48955SJacob Faibussowitsch PETSC_CXX_COMPAT_DECL(PETSC_CONSTEXPR_14 const char* device_enable_cupmtype())
26217f48955SJacob Faibussowitsch {
26317f48955SJacob Faibussowitsch   switch (T) {
26417f48955SJacob Faibussowitsch   case DeviceType::CUDA: return "-device_enable_cuda";
26517f48955SJacob Faibussowitsch   case DeviceType::HIP:  return "-device_enable_hip";
26617f48955SJacob Faibussowitsch   }
267bf025ffbSJacob Faibussowitsch   PetscUnreachable();
268bf025ffbSJacob Faibussowitsch   return "PETSC_ERROR_PLIB";
26917f48955SJacob Faibussowitsch }
270a4af0ceeSJacob Faibussowitsch 
27117f48955SJacob Faibussowitsch template <DeviceType T>
27217f48955SJacob Faibussowitsch PETSC_CXX_COMPAT_DECL(PETSC_CONSTEXPR_14 const char* device_select_cupmtype())
27317f48955SJacob Faibussowitsch {
27417f48955SJacob Faibussowitsch   switch (T) {
27517f48955SJacob Faibussowitsch   case DeviceType::CUDA: return "-device_select_cuda";
27617f48955SJacob Faibussowitsch   case DeviceType::HIP:  return "-device_select_hip";
27717f48955SJacob Faibussowitsch   }
278bf025ffbSJacob Faibussowitsch   PetscUnreachable();
279bf025ffbSJacob Faibussowitsch   return "PETSC_ERROR_PLIB";
28017f48955SJacob Faibussowitsch }
281a4af0ceeSJacob Faibussowitsch 
28217f48955SJacob Faibussowitsch template <DeviceType T>
28317f48955SJacob Faibussowitsch PETSC_CXX_COMPAT_DECL(PETSC_CONSTEXPR_14 const char* device_view_cupmtype())
28417f48955SJacob Faibussowitsch {
28517f48955SJacob Faibussowitsch   switch (T) {
28617f48955SJacob Faibussowitsch   case DeviceType::CUDA: return "-device_view_cuda";
28717f48955SJacob Faibussowitsch   case DeviceType::HIP:  return "-device_view_hip";
28817f48955SJacob Faibussowitsch   }
289bf025ffbSJacob Faibussowitsch   PetscUnreachable();
290bf025ffbSJacob Faibussowitsch   return "PETSC_ERROR_PLIB";
29117f48955SJacob Faibussowitsch }
29217f48955SJacob Faibussowitsch 
29317f48955SJacob Faibussowitsch template <DeviceType T>
294*e5265fafSJacob Faibussowitsch PETSC_CXX_COMPAT_DECL(PETSC_CONSTEXPR_14 const char* CUPM_VISIBLE_DEVICES())
295*e5265fafSJacob Faibussowitsch {
296*e5265fafSJacob Faibussowitsch   switch (T) {
297*e5265fafSJacob Faibussowitsch   case DeviceType::CUDA: return "CUDA_VISIBLE_DEVICES";
298*e5265fafSJacob Faibussowitsch   case DeviceType::HIP:  return "HIP_VISIBLE_DEVICES";
299*e5265fafSJacob Faibussowitsch   }
300*e5265fafSJacob Faibussowitsch   PetscUnreachable();
301*e5265fafSJacob Faibussowitsch   return "PETSC_ERROR_PLIB";
302*e5265fafSJacob Faibussowitsch }
303*e5265fafSJacob Faibussowitsch 
304*e5265fafSJacob Faibussowitsch template <DeviceType T>
30517f48955SJacob Faibussowitsch PetscErrorCode Device<T>::initialize(MPI_Comm comm, PetscInt *defaultDeviceId, PetscDeviceInitType *defaultInitType) noexcept
306a4af0ceeSJacob Faibussowitsch {
307a4af0ceeSJacob Faibussowitsch   PetscInt       initTypeCUPM = *defaultInitType,id = *defaultDeviceId;
308a4af0ceeSJacob Faibussowitsch   PetscBool      view = PETSC_FALSE,flg;
309a4af0ceeSJacob Faibussowitsch   int            ndev;
310b2f36b75SJacob Faibussowitsch   cupmError_t    cerr;
311a4af0ceeSJacob Faibussowitsch   PetscErrorCode ierr;
312a4af0ceeSJacob Faibussowitsch 
313a4af0ceeSJacob Faibussowitsch   PetscFunctionBegin;
31417f48955SJacob Faibussowitsch   if (initialized_) PetscFunctionReturn(0);
31517f48955SJacob Faibussowitsch   initialized_ = true;
31617f48955SJacob Faibussowitsch   ierr = PetscRegisterFinalize(finalize_);CHKERRQ(ierr);
317a4af0ceeSJacob Faibussowitsch 
318a4af0ceeSJacob Faibussowitsch   {
31917f48955SJacob Faibussowitsch     // the functions to populate the command line strings are named after the string they return
32017f48955SJacob Faibussowitsch     ierr = PetscOptionsBegin(comm,nullptr,PetscDevice_CUPMTYPE_Options<T>(),"Sys");CHKERRQ(ierr);
32117f48955SJacob Faibussowitsch     ierr = PetscOptionsEList(device_enable_cupmtype<T>(),"How (or whether) to initialize a device","CUPMDevice<CUPMDeviceType>::initialize()",PetscDeviceInitTypes,3,PetscDeviceInitTypes[initTypeCUPM],&initTypeCUPM,nullptr);CHKERRQ(ierr);
32217f48955SJacob Faibussowitsch     ierr = PetscOptionsRangeInt(device_select_cupmtype<T>(),"Which device to use. Pass " PetscStringize(PETSC_DECIDE) " to have PETSc decide or (given they exist) [0-NUM_DEVICE) for a specific device","PetscDeviceCreate",id,&id,nullptr,PETSC_DECIDE,std::numeric_limits<decltype(defaultDevice_)>::max());CHKERRQ(ierr);
32317f48955SJacob Faibussowitsch     ierr = PetscOptionsBool(device_view_cupmtype<T>(),"Display device information and assignments (forces eager initialization)",nullptr,view,&view,&flg);CHKERRQ(ierr);
324a4af0ceeSJacob Faibussowitsch     ierr = PetscOptionsEnd();CHKERRQ(ierr);
325a4af0ceeSJacob Faibussowitsch   }
326a4af0ceeSJacob Faibussowitsch 
327a4af0ceeSJacob Faibussowitsch   cerr = cupmGetDeviceCount(&ndev);
328*e5265fafSJacob Faibussowitsch   switch (cerr) {
329*e5265fafSJacob Faibussowitsch   case cupmErrorNoDevice: {
330*e5265fafSJacob Faibussowitsch     PetscBool found;
331*e5265fafSJacob Faibussowitsch     PetscBool ignoreCupmError = PETSC_FALSE;
332*e5265fafSJacob Faibussowitsch     auto      buf = std::array<char,PETSC_DEVICE_MAX_DEVICES>{};
333*e5265fafSJacob Faibussowitsch 
334*e5265fafSJacob Faibussowitsch     ierr = PetscOptionsGetenv(comm,CUPM_VISIBLE_DEVICES<T>(),buf.data(),buf.size(),&found);CHKERRQ(ierr);
335*e5265fafSJacob Faibussowitsch     if (found) {
336*e5265fafSJacob Faibussowitsch       for (auto it = buf.cbegin(); it != buf.cend(); ++it) {
337*e5265fafSJacob Faibussowitsch         if (!*it) continue;
338*e5265fafSJacob Faibussowitsch         // find out the first non-empty characters in buf are '-<some number>', which indicates
339*e5265fafSJacob Faibussowitsch         // no devices should be visible so we can ignore the errors about not finding devices
340*e5265fafSJacob Faibussowitsch         ignoreCupmError = static_cast<PetscBool>((*it == '-') && (std::next(it) != buf.cend()) && isdigit(*std::next(it)));
341*e5265fafSJacob Faibussowitsch         break;
342*e5265fafSJacob Faibussowitsch       }
343*e5265fafSJacob Faibussowitsch     }
344*e5265fafSJacob Faibussowitsch     id = PETSC_CUPM_DEVICE_NONE; // there are no devices anyway
345*e5265fafSJacob Faibussowitsch     if (ignoreCupmError) {auto PETSC_UNUSED ignored = cupmGetLastError(); break;}
346*e5265fafSJacob Faibussowitsch     // if we don't outright ignore the error we then drop and check if the user tried to
347*e5265fafSJacob Faibussowitsch     // eagerly initialize the device
348*e5265fafSJacob Faibussowitsch   }
349*e5265fafSJacob Faibussowitsch   case cupmErrorStubLibrary:
350a4af0ceeSJacob Faibussowitsch     if (PetscUnlikely((initTypeCUPM == PETSC_DEVICE_INIT_EAGER) || (view && flg))) {
351a4af0ceeSJacob Faibussowitsch       const auto name    = cupmGetErrorName(cerr);
352a4af0ceeSJacob Faibussowitsch       const auto desc    = cupmGetErrorString(cerr);
353a4af0ceeSJacob Faibussowitsch       const auto backend = cupmName();
35498921bdaSJacob Faibussowitsch       SETERRQ(comm,PETSC_ERR_USER_INPUT,"Cannot eagerly initialize %s, as doing so results in %s error %d (%s) : %s",backend,backend,static_cast<PetscErrorCode>(cerr),name,desc);
355a4af0ceeSJacob Faibussowitsch     }
356a4af0ceeSJacob Faibussowitsch     initTypeCUPM = PETSC_DEVICE_INIT_NONE;
357*e5265fafSJacob Faibussowitsch     {auto PETSC_UNUSED ignored = cupmGetLastError();}
358*e5265fafSJacob Faibussowitsch     break;
359*e5265fafSJacob Faibussowitsch   default:
360*e5265fafSJacob Faibussowitsch     CHKERRCUPM(cerr);
361*e5265fafSJacob Faibussowitsch     break;
362*e5265fafSJacob Faibussowitsch   }
363a4af0ceeSJacob Faibussowitsch 
364b2f36b75SJacob Faibussowitsch   if (initTypeCUPM == PETSC_DEVICE_INIT_NONE) {
365b2f36b75SJacob Faibussowitsch     if ((id > 0) || (id == PETSC_DECIDE)) id = PETSC_CUPM_DEVICE_NONE;
366b2f36b75SJacob Faibussowitsch   } else {
367a4af0ceeSJacob Faibussowitsch     ierr = PetscDeviceCheckDeviceCount_Internal(ndev);CHKERRQ(ierr);
368a4af0ceeSJacob Faibussowitsch     if (id == PETSC_DECIDE) {
369a4af0ceeSJacob Faibussowitsch       if (ndev) {
370a4af0ceeSJacob Faibussowitsch         PetscMPIInt rank;
371a4af0ceeSJacob Faibussowitsch 
372a4af0ceeSJacob Faibussowitsch         ierr = MPI_Comm_rank(comm,&rank);CHKERRMPI(ierr);
373a4af0ceeSJacob Faibussowitsch         id   = rank % ndev;
374a4af0ceeSJacob Faibussowitsch       } else id = 0;
375a4af0ceeSJacob Faibussowitsch     }
376a4af0ceeSJacob Faibussowitsch     view = static_cast<decltype(view)>(view && flg);
377a4af0ceeSJacob Faibussowitsch     if (view) initTypeCUPM = PETSC_DEVICE_INIT_EAGER;
378a4af0ceeSJacob Faibussowitsch   }
379a4af0ceeSJacob Faibussowitsch 
38017f48955SJacob Faibussowitsch   static_assert(std::is_same<PetscMPIInt,decltype(defaultDevice_)>::value,"");
381b2f36b75SJacob Faibussowitsch   // id is PetscInt, _defaultDevice is int
38217f48955SJacob Faibussowitsch   ierr = PetscMPIIntCast(id,&defaultDevice_);CHKERRQ(ierr);
383a4af0ceeSJacob Faibussowitsch   if (initTypeCUPM == PETSC_DEVICE_INIT_EAGER) {
38417f48955SJacob Faibussowitsch     devices_[defaultDevice_] = DeviceInternal::makeDevice(defaultDevice_);
38517f48955SJacob Faibussowitsch     ierr = devices_[defaultDevice_]->initialize();CHKERRQ(ierr);
38617f48955SJacob Faibussowitsch     ierr = devices_[defaultDevice_]->configure();CHKERRQ(ierr);
387a4af0ceeSJacob Faibussowitsch     if (view) {
388a4af0ceeSJacob Faibussowitsch       PetscViewer vwr;
389a4af0ceeSJacob Faibussowitsch 
390a4af0ceeSJacob Faibussowitsch       ierr = PetscLogInitialize();CHKERRQ(ierr);
391a4af0ceeSJacob Faibussowitsch       ierr = PetscViewerASCIIGetStdout(comm,&vwr);CHKERRQ(ierr);
39217f48955SJacob Faibussowitsch       ierr = devices_[defaultDevice_]->view(vwr);CHKERRQ(ierr);
393a4af0ceeSJacob Faibussowitsch     }
394a4af0ceeSJacob Faibussowitsch   }
395a4af0ceeSJacob Faibussowitsch 
396a4af0ceeSJacob Faibussowitsch   // record the results of the initialization
397a4af0ceeSJacob Faibussowitsch   *defaultInitType = static_cast<PetscDeviceInitType>(initTypeCUPM);
398a4af0ceeSJacob Faibussowitsch   *defaultDeviceId = id;
399a4af0ceeSJacob Faibussowitsch   PetscFunctionReturn(0);
400a4af0ceeSJacob Faibussowitsch }
401a4af0ceeSJacob Faibussowitsch 
40217f48955SJacob Faibussowitsch template <DeviceType T>
40317f48955SJacob Faibussowitsch PetscErrorCode Device<T>::getDevice(PetscDevice device, PetscInt id) const noexcept
404a4af0ceeSJacob Faibussowitsch {
405bf025ffbSJacob Faibussowitsch   const auto     cerr = static_cast<cupmError_t>(-defaultDevice_);
406a4af0ceeSJacob Faibussowitsch   PetscErrorCode ierr;
407a4af0ceeSJacob Faibussowitsch 
408a4af0ceeSJacob Faibussowitsch   PetscFunctionBegin;
409bf025ffbSJacob Faibussowitsch   PetscCheck(defaultDevice_ != PETSC_CUPM_DEVICE_NONE,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Trying to retrieve a %s PetscDevice when it has been disabled",cupmName());
410bf025ffbSJacob Faibussowitsch   PetscCheck(defaultDevice_ >= 0,PETSC_COMM_SELF,PETSC_ERR_GPU,"Cannot lazily initialize PetscDevice: %s error %d (%s) : %s",cupmName(),static_cast<PetscErrorCode>(cerr),cupmGetErrorName(cerr),cupmGetErrorString(cerr));
41117f48955SJacob Faibussowitsch   if (id == PETSC_DECIDE) id = defaultDevice_;
412bf025ffbSJacob Faibussowitsch   PetscAssert(static_cast<decltype(devices_.size())>(id) < devices_.size(),PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Only supports %zu number of devices but trying to get device with id %" PetscInt_FMT,devices_.size(),id);
41317f48955SJacob Faibussowitsch   if (devices_[id]) {
4142c71b3e2SJacob Faibussowitsch     PetscAssert(id == devices_[id]->id(),PETSC_COMM_SELF,PETSC_ERR_PLIB,"Entry %" PetscInt_FMT " contains device with mismatching id %d",id,devices_[id]->id());
41517f48955SJacob Faibussowitsch   } else devices_[id] = DeviceInternal::makeDevice(id);
41617f48955SJacob Faibussowitsch   ierr = devices_[id]->initialize();CHKERRQ(ierr);
41717f48955SJacob Faibussowitsch   device->deviceId           = devices_[id]->id(); // technically id = _devices[id]->_id here
41817f48955SJacob Faibussowitsch   device->ops->createcontext = create_;
419a4af0ceeSJacob Faibussowitsch   device->ops->configure     = this->configureDevice;
420a4af0ceeSJacob Faibussowitsch   device->ops->view          = this->viewDevice;
421a4af0ceeSJacob Faibussowitsch   PetscFunctionReturn(0);
422a4af0ceeSJacob Faibussowitsch }
423a4af0ceeSJacob Faibussowitsch 
42417f48955SJacob Faibussowitsch template <DeviceType T>
42517f48955SJacob Faibussowitsch PetscErrorCode Device<T>::configureDevice(PetscDevice device) noexcept
426a4af0ceeSJacob Faibussowitsch {
427a4af0ceeSJacob Faibussowitsch   PetscErrorCode ierr;
428a4af0ceeSJacob Faibussowitsch 
429a4af0ceeSJacob Faibussowitsch   PetscFunctionBegin;
43017f48955SJacob Faibussowitsch   ierr = devices_[device->deviceId]->configure();CHKERRQ(ierr);
431a4af0ceeSJacob Faibussowitsch   PetscFunctionReturn(0);
432a4af0ceeSJacob Faibussowitsch }
433a4af0ceeSJacob Faibussowitsch 
43417f48955SJacob Faibussowitsch template <DeviceType T>
43517f48955SJacob Faibussowitsch PetscErrorCode Device<T>::viewDevice(PetscDevice device, PetscViewer viewer) noexcept
436a4af0ceeSJacob Faibussowitsch {
437a4af0ceeSJacob Faibussowitsch   PetscErrorCode ierr;
438a4af0ceeSJacob Faibussowitsch 
439a4af0ceeSJacob Faibussowitsch   PetscFunctionBegin;
440a4af0ceeSJacob Faibussowitsch   // now this __shouldn't__ reconfigure the device, but there is a petscinfo call to indicate
441a4af0ceeSJacob Faibussowitsch   // it is being reconfigured
44217f48955SJacob Faibussowitsch   ierr = devices_[device->deviceId]->configure();CHKERRQ(ierr);
44317f48955SJacob Faibussowitsch   ierr = devices_[device->deviceId]->view(viewer);CHKERRQ(ierr);
444030f984aSJacob Faibussowitsch   PetscFunctionReturn(0);
445030f984aSJacob Faibussowitsch }
446030f984aSJacob Faibussowitsch 
447030f984aSJacob Faibussowitsch // explicitly instantiate the classes
448030f984aSJacob Faibussowitsch #if PetscDefined(HAVE_CUDA)
44917f48955SJacob Faibussowitsch template class Device<DeviceType::CUDA>;
450030f984aSJacob Faibussowitsch #endif
451030f984aSJacob Faibussowitsch #if PetscDefined(HAVE_HIP)
45217f48955SJacob Faibussowitsch template class Device<DeviceType::HIP>;
453030f984aSJacob Faibussowitsch #endif
454030f984aSJacob Faibussowitsch 
45517f48955SJacob Faibussowitsch } // namespace CUPM
45617f48955SJacob Faibussowitsch 
45717f48955SJacob Faibussowitsch } // namespace Device
45817f48955SJacob Faibussowitsch 
459030f984aSJacob Faibussowitsch } // namespace Petsc
460