paddlepaddle--paddle/paddle/phi/backends/device_base.h

// Copyright (c) 2022 PaddlePaddle Authors. All Rights Reserved.
//
// 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 <vector>

#include "paddle/phi/backends/c_comm_lib.h"
#include "paddle/phi/backends/c_cuda_graph_lib.h"
#include "paddle/phi/backends/event.h"
#include "paddle/phi/backends/stream.h"
#include "paddle/phi/common/place.h"
#include "paddle/phi/core/allocator.h"

struct C_CinnInterface;
namespace phi {

struct DeviceProp {
  std::string name;
  int deviceMajor = 0;
  int deviceMinor = 0;
  size_t totalGlobalMem = 0;
  int multiProcessorCount = 0;
  bool isMultiGpuBoard = false;
  bool integrated = false;

  DeviceProp() = default;

  DeviceProp(const std::string& name_,
             int deviceMajor_,
             int deviceMinor_,
             size_t totalGlobalMem_,
             int multiProcessorCount_,
             bool isMultiGpuBoard_,
             bool integrated_)
      : name(name_),
        deviceMajor(deviceMajor_),
        deviceMinor(deviceMinor_),
        totalGlobalMem(totalGlobalMem_),
        multiProcessorCount(multiProcessorCount_),
        isMultiGpuBoard(isMultiGpuBoard_),
        integrated(integrated_) {}
};

class TraceEventCollector;

class DeviceInterface {  // Driver / Runtime
 public:
  DeviceInterface(const std::string& type, uint8_t priority, bool is_custom)
      : type_(type), priority_(priority), is_custom_(is_custom) {}
  uint8_t Priority() { return priority_; }
  std::string Type() { return type_; }
  bool IsCustom() { return is_custom_; }

  virtual ~DeviceInterface() {}

  virtual C_CinnInterface* GetCinnInterface() { return nullptr; }

  // Info
  virtual size_t GetComputeCapability(size_t dev_id);

  virtual DeviceProp& GetDeviceProperties(size_t dev_id);

  virtual size_t GetRuntimeVersion(size_t dev_id);

  virtual size_t GetDriverVersion(size_t dev_id);

  virtual size_t GetMultiProcessors(size_t dev_id);

  virtual size_t GetMaxThreadsPerMultiProcessor(size_t dev_id);

  virtual size_t GetMaxThreadsPerBlock(size_t dev_id);

  virtual size_t GetMaxSharedMemPerBlock(size_t dev_id);

  virtual size_t GetMaxBlocksPerMultiProcessor(size_t dev_id);

  virtual size_t GetWarpSize(size_t dev_id);

  virtual size_t GetMaxRegistersPerMultiProcessor(size_t dev_id);

  virtual size_t GetPreferredVectorWidth(size_t dev_id);

  virtual std::array<unsigned int, 3> GetMaxGridDimSize(size_t dev_id);

  virtual std::array<unsigned int, 3> GetMaxBlockDimSize(size_t dev_id);

  virtual bool IsFloat16Supported(size_t dev_id);

  virtual bool IsBFloat16Supported(size_t dev_id);

  virtual bool IsDnnAvailable(size_t dev_id);

  virtual void* InitEigenDevice(const Place& place,
                                stream::stream_t stream,
                                phi::Allocator* allocator);

  virtual void DestroyEigenDevice(size_t dev_id, void* eigen_device);

  // Platform
  //! Initialize
  virtual void Initialize();

  //! Finalize
  virtual void Finalize();

  // Device
  virtual size_t GetDeviceCount() = 0;
  virtual std::vector<size_t> GetDeviceList() = 0;

  //! Wait for compute device to finish.
  virtual void SynchronizeDevice(size_t dev_id);

  //! Initialize device.
  virtual void InitDevice(size_t dev_id);

  //! Deinitialize device.
  virtual void DeInitDevice(size_t dev_id);

  // ! Set device to be used.
  virtual void SetDevice(size_t dev_id);

  // ! Returns which device is currently being used.
  virtual int GetDevice();

  // Stream
  // ! Create an asynchronous stream
  virtual void CreateStream(
      size_t dev_id,
      stream::Stream* stream,
      const stream::Stream::Priority& priority =
          stream::Stream::Priority::kNormal,
      const stream::Stream::Flag& flag = stream::Stream::Flag::kDefaultFlag);

  // ! Destroys an asynchronous stream.
  virtual void DestroyStream(size_t dev_id, stream::stream_t stream);

  // ! Waits for stream tasks to complete.
  virtual void SynchronizeStream(size_t dev_id, stream::stream_t stream);

  // ! Queries an asynchronous stream for completion status.
  virtual bool QueryStream(size_t dev_id, stream::stream_t stream);

  // ! Add a callback to a compute stream.
  virtual void AddCallback(size_t dev_id,
                           stream::Stream* stream,
                           stream::Stream::Callback* callback);

  // Event
  // ! Create an event.
  virtual void CreateEvent(
      size_t dev_id,
      event::Event* event,
      event::Event::Flag flags = event::Event::Flag::Default);

  // ! Destroy an event.
  virtual void DestroyEvent(size_t dev_id, event::Event* event);

  // ! Records an event.
  virtual void RecordEvent(size_t dev_id,
                           const event::Event* event,
                           const stream::Stream* stream);

  // ! Waits for event to complete.
  virtual void SynchronizeEvent(size_t dev_id, const event::Event* event);
  // ! Queries an event for completion status.
  virtual bool QueryEvent(size_t dev_id, const event::Event* event);

  // ! Make a compute stream wait on an event
  virtual void StreamWaitEvent(size_t dev_id,
                               const stream::Stream* stream,
                               const event::Event* event);

  // Memory
  virtual void MemoryCopyH2D(size_t dev_id,
                             void* dst,
                             const void* src,
                             size_t size,
                             const stream::Stream* stream = nullptr);

  virtual void MemoryCopyD2H(size_t dev_id,
                             void* dst,
                             const void* src,
                             size_t size,
                             const stream::Stream* stream = nullptr);

  virtual void MemoryCopyD2D(size_t dev_id,
                             void* dst,
                             const void* src,
                             size_t size,
                             const stream::Stream* stream = nullptr);

  virtual void MemoryCopyP2P(const Place& dst_place,
                             void* dst,
                             size_t src_id,
                             const void* src,
                             size_t size,
                             const stream::Stream* stream = nullptr);

  virtual void* MemoryAllocate(size_t dev_id, size_t size);

  virtual void MemoryDeallocate(size_t dev_id, void* ptr, size_t size);

  virtual void* MemoryAllocateHost(size_t dev_id, size_t size);

  virtual void MemoryDeallocateHost(size_t dev_id, void* ptr, size_t size);

  virtual void* MemoryAllocateUnified(size_t dev_id, size_t size);

  virtual void MemoryDeallocateUnified(size_t dev_id, void* ptr, size_t size);

  virtual void MemorySet(size_t dev_id, void* ptr, uint8_t value, size_t size);

  virtual void MemoryStats(size_t dev_id, size_t* total, size_t* free);

  virtual size_t GetMinChunkSize(size_t dev_id);

  virtual size_t GetInitAllocSize(size_t dev_id);

  virtual size_t GetReallocSize(size_t dev_id);

  virtual size_t GetMaxAllocSize(size_t dev_id);

  virtual size_t GetMaxChunkSize(size_t dev_id);

  virtual size_t GetExtraPaddingSize(size_t dev_id);

  // CCL
  virtual void CCLCommName(ccl::CCLComm ccl_comm, char* comm_name);

  virtual void CCLDestroyComm(ccl::CCLComm ccl_comm);

  virtual void CCLCommInitRank(size_t num_ranks,
                               ccl::CCLRootId* root_id,
                               size_t rank_id,
                               ccl::CCLComm* ccl_comm);

  virtual void CCLGetUniqueId(ccl::CCLRootId* root_id);

  virtual void CCLBroadcast(void* data,
                            size_t num,
                            phi::DataType data_type,
                            size_t root,
                            const ccl::CCLComm& ccl_comm,
                            const stream::stream_t& stream);

  virtual void CCLAllReduce(void* in_data,
                            void* out_data,
                            size_t num,
                            phi::DataType data_type,
                            ccl::CCLReduceOp reduce_op,
                            const ccl::CCLComm& ccl_comm,
                            const stream::stream_t& stream);
  virtual void CCLReduce(void* in_data,
                         void* out_data,
                         size_t num,
                         phi::DataType data_type,
                         ccl::CCLReduceOp reduce_op,
                         size_t root_id,
                         const ccl::CCLComm& ccl_comm,
                         const stream::stream_t& stream);
  virtual void CCLAllGather(void* in_data,
                            void* out_data,
                            size_t num,
                            phi::DataType data_type,
                            const ccl::CCLComm& ccl_comm,
                            const stream::stream_t& stream);
  virtual void CCLReduceScatter(void* in_data,
                                void* out_data,
                                size_t num,
                                phi::DataType data_type,
                                ccl::CCLReduceOp op,
                                const ccl::CCLComm& ccl_comm,
                                const stream::stream_t& stream);
  virtual void CCLGroupStart();
  virtual void CCLGroupEnd();
  virtual void CCLSend(void* sendbuf,
                       size_t num,
                       phi::DataType data_type,
                       size_t dst_rank,
                       const ccl::CCLComm& ccl_comm,
                       const stream::stream_t& stream);
  virtual void CCLRecv(void* recvbuf,
                       size_t num,
                       phi::DataType data_type,
                       size_t src_rank,
                       const ccl::CCLComm& ccl_comm,
                       const stream::stream_t& stream);

  virtual void CCLAllToAll(const void** send_buf,
                           const size_t* send_count,
                           const phi::DataType* send_dtype,
                           void** recv_buf,
                           const size_t* recv_count,
                           const phi::DataType* recv_dtype,
                           size_t rank,
                           size_t nranks,
                           const ccl::CCLComm& comm,
                           const stream::stream_t& stream);
  // blas
  virtual void BlasAXPBY(size_t dev_id,
                         const stream::stream_t& stream,
                         phi::DataType dtype,
                         size_t numel,
                         float alpha,
                         void* x,
                         float beta,
                         void* y);

  // profiler
  virtual void ProfilerInitialize(phi::TraceEventCollector* collector,
                                  void** user_data);

  virtual void ProfilerFinalize(phi::TraceEventCollector* collector,
                                void* user_data);

  virtual void ProfilerPrepareTracing(phi::TraceEventCollector* collector,
                                      void* user_data);

  virtual void ProfilerStartTracing(phi::TraceEventCollector* collector,
                                    void* user_data);

  virtual void ProfilerStopTracing(phi::TraceEventCollector* collector,
                                   void* user_data);

  virtual void ProfilerCollectTraceData(phi::TraceEventCollector* collector,
                                        uint64_t start_ns,
                                        void* user_data);

  virtual void InitBlasHandle(size_t dev_id,
                              void** blas_handle,
                              stream::stream_t stream);

  virtual void BlasSetMathMode(size_t dev_id, void* blas_handle, int math_mode);

  virtual void InitBlasLtHandle(size_t dev_id, void** blaslt_handle);

  virtual void DestroyBlasHandle(size_t dev_id, void* blas_handle);

  virtual void DestroyBlasLtHandle(size_t dev_id, void* blaslt_handle);

  virtual void InitDnnHandle(size_t dev_id,
                             void** dnn_handle,
                             phi::stream::stream_t stream);

  virtual void DestroyDnnHandle(size_t dev_id, void* dnn_handle);

  // CudaGraph
  virtual void CUDAStreamBeginCapture(size_t dev_id,
                                      stream::stream_t stream,
                                      graph::streamCaptureMode mode);

  virtual void CudaStreamEndCapture(size_t dev_id,
                                    stream::stream_t stream,
                                    graph::CUDAGraph_t* pGraph);

  virtual void CudaGraphLaunch(size_t dev_id,
                               graph::CUDAGraphExec_t exec,
                               stream::stream_t stream);

  virtual void CudaGraphDestroy(graph::CUDAGraph_t graph);

  virtual void CudaGraphExecDestroy(graph::CUDAGraphExec_t graphExec);

  virtual void CudaGraphInstantiate(graph::CUDAGraphExec_t* pGraphExec,
                                    graph::CUDAGraph_t* pGraph,
                                    void** pErrorNode,
                                    char* pLogBuffer,
                                    size_t bufferSize);

  virtual void CudaGraphGetNodes(graph::CUDAGraph_t graph,
                                 graph::CUDAGraphNode_t* pNodes,
                                 size_t* numNodes);

  virtual void CudaStreamGetCaptureInfo(
      size_t dev_id,
      stream::stream_t stream,
      graph::streamCaptureStatus* captureStatus_out,
      unsigned long long* id_out = nullptr,  // NOLINT
      graph::CUDAGraph_t* graph_out = nullptr,
      graph::CUDAGraphNode_t* dependencies_out = nullptr,
      void** edgeData_out = nullptr,
      size_t* numDependencies_out = nullptr);

  virtual void GetParameterSetterForExecGraph(graph::CUDAGraph_t graph,
                                              graph::GraphHookManager* hook);

  virtual void CudaGraphDebugDotPrint(graph::CUDAGraph_t graph,
                                      const char* path,
                                      unsigned flags);

  virtual void CudaThreadExchangeStreamCaptureMode(
      graph::streamCaptureMode* mode);

 private:
  const std::string type_;
  const uint8_t priority_;
  const bool is_custom_;

  size_t AllocSize(size_t dev_id, bool realloc);

  size_t AvailableAllocSize(size_t dev_id);
};

}  // namespace phi