rocm-systems/rocclr/runtime/device/pal/palsettings.hpp

//
// Copyright (c) 2015 Advanced Micro Devices, Inc. All rights reserved.
//
#pragma once

#include "top.hpp"
#include "library.hpp"
#include "inc/core/palDevice.h"

/*! \addtogroup pal PAL Resource Implementation
 *  @{
 */

//! PAL Device Implementation
namespace pal {

//! Device settings
class Settings : public device::Settings {
 public:
  //! Debug GPU flags
  enum DebugGpuFlags {
    CheckForILSource = 0x00000001,
    StubCLPrograms = 0x00000002,  //!< Enables OpenCL programs stubbing
    LockGlobalMemory = 0x00000004,
  };

  enum BlitEngineType {
    BlitEngineDefault = 0x00000000,
    BlitEngineHost = 0x00000001,
    BlitEngineCAL = 0x00000002,
    BlitEngineKernel = 0x00000003,
  };

  enum HostMemFlags {
    HostMemDisable = 0x00000000,
    HostMemBuffer = 0x00000001,
    HostMemImage = 0x00000002,
  };

  union {
    struct {
      uint remoteAlloc_ : 1;             //!< Allocate remote memory for the heap
      uint stagedXferRead_ : 1;          //!< Uses a staged buffer read
      uint stagedXferWrite_ : 1;         //!< Uses a staged buffer write
      uint disablePersistent_ : 1;       //!< Disables using persistent memory for staging
      uint imageSupport_ : 1;            //!< Report images support
      uint doublePrecision_ : 1;         //!< Enables double precision support
      uint use64BitPtr_ : 1;             //!< Use 64bit pointers on GPU
      uint force32BitOcl20_ : 1;         //!< Force 32bit apps to take CLANG/HSAIL path on GPU
      uint imageDMA_ : 1;                //!< Enable direct image DMA transfers
      uint viPlus_ : 1;                  //!< VI and post VI features
      uint aiPlus_ : 1;                  //!< AI and post AI features
      uint gfx10Plus_ : 1;               //!< gfx10 and post gfx10 features
      uint threadTraceEnable_ : 1;       //!< Thread trace enable
      uint linearPersistentImage_ : 1;   //!< Allocates linear images in persistent
      uint useSingleScratch_ : 1;        //!< Allocates single scratch per device
      uint svmAtomics_ : 1;              //!< SVM device atomics
      uint svmFineGrainSystem_ : 1;      //!< SVM fine grain system support
      uint useDeviceQueue_ : 1;          //!< Submit to separate device queue
      uint sdamPageFaultWar_ : 1;        //!< SDMA page fault workaround
      uint rgpSqttWaitIdle_: 1;          //!< Wait for idle after SQTT trace
      uint rgpSqttForceDisable_: 1;      //!< Disables SQTT
      uint reserved_ : 12;
    };
    uint value_;
  };

  uint oclVersion_;            //!< Reported OpenCL version support
  uint debugFlags_;            //!< Debug GPU flags
  uint hwLDSSize_;             //!< HW local data store size
  uint maxWorkGroupSize_;      //!< Requested workgroup size for this device
  uint preferredWorkGroupSize_;//!< Requested preferred workgroup size for this device
  uint workloadSplitSize_;     //!< Workload split size
  uint minWorkloadTime_;       //!< Minimal workload time in 0.1 ms
  uint maxWorkloadTime_;       //!< Maximum workload time in 0.1 ms
  uint blitEngine_;            //!< Blit engine type
  uint cacheLineSize_;         //!< Cache line size in bytes
  uint cacheSize_;             //!< L1 cache size in bytes
  uint numComputeRings_;       //!< 0 - disabled, 1 , 2,.. - the number of compute rings
  uint numDeviceEvents_;       //!< The number of device events
  uint numWaitEvents_;         //!< The number of wait events for device enqueue
  uint hostMemDirectAccess_;   //!< Enables direct access to the host memory
  uint numScratchWavesPerCu_;  //!< Maximum number of waves when scratch is enabled
  size_t xferBufSize_;         //!< Transfer buffer size for image copy optimization
  size_t stagedXferSize_;      //!< Staged buffer size
  size_t pinnedXferSize_;      //!< Pinned buffer size for transfer
  size_t pinnedMinXferSize_;   //!< Minimal buffer size for pinned transfer
  size_t resourceCacheSize_;   //!< Resource cache size in MB
  size_t numMemDependencies_;  //!< The array size for memory dependencies tracking
  uint64_t maxAllocSize_;      //!< Maximum single allocation size
  uint rgpSqttDispCount_;      //!< The number of dispatches captured in SQTT
  uint maxCmdBuffers_;         //!< Maximum number of command buffers allocated per queue

  uint64_t subAllocationMinSize_;   //!< Minimum size allowed for suballocations
  uint64_t subAllocationMaxSize_;   //!< Maximum size allowed with suballocations
  uint64_t subAllocationChunkSize_; //!< Chunk size for suballocaitons
  
  amd::LibrarySelector libSelector_;  //!< Select linking libraries for compiler

  //! Default constructor
  Settings();

  //! Creates settings
  bool create(const Pal::DeviceProperties& palProp,       //!< PAL  device properties
              const Pal::GpuMemoryHeapProperties* heaps,  //!< PAL heap settings
              const Pal::WorkStationCaps& wscaps,         //!< PAL  workstation settings
              bool reportAsOCL12Device = false            //!< Report As OpenCL1.2 Device
              );

 private:
  //! Disable copy constructor
  Settings(const Settings&);

  //! Disable assignment
  Settings& operator=(const Settings&);

  //! Overrides current settings based on registry/environment
  void override();
};

/*@}*/} // namespace pal