23 #ifndef HIP_SRC_HIP_HCC_INTERNAL_H 24 #define HIP_SRC_HIP_HCC_INTERNAL_H 28 #include <unordered_map> 31 #include "hsa/hsa_ext_amd.h" 32 #include "hip/hip_runtime.h" 33 #include "hip_prof_api.h" 38 #if (__hcc_workweek__ < 16354) 39 #error("This version of HIP requires a newer version of HCC."); 44 #if defined(__HCC_HAS_EXTENDED_AM_MEMTRACKER_UPDATE) and \ 45 (__HCC_HAS_EXTENDED_AM_MEMTRACKER_UPDATE != 0) 46 #define USE_APP_PTR_FOR_CTX 1 58 extern const int release;
62 extern int HIP_LAUNCH_BLOCKING;
63 extern int HIP_API_BLOCKING;
65 extern int HIP_PRINT_ENV;
66 extern int HIP_PROFILE_API;
70 extern int HIP_STAGING_SIZE;
71 extern int HIP_STREAM_SIGNALS;
72 extern int HIP_VISIBLE_DEVICES;
73 extern int HIP_FORCE_P2P_HOST;
75 extern int HIP_HOST_COHERENT;
77 extern int HIP_HIDDEN_FREE_MEM;
80 extern int HIP_SYNC_HOST_ALLOC;
81 extern int HIP_SYNC_STREAM_WAIT;
83 extern int HIP_SYNC_NULL_STREAM;
84 extern int HIP_INIT_ALLOC;
85 extern int HIP_FORCE_NULL_STREAM;
87 extern int HIP_SYNC_FREE;
89 extern int HIP_DUMP_CODE_OBJECT;
92 extern int HCC_OPT_FLUSH;
94 #define IMAGE_PITCH_ALIGNMENT 256 95 template <
typename T>
inline T alignDown(T value,
size_t alignment) {
96 return (T)(value & ~(alignment - 1));
99 template <
typename T>
inline T* alignDown(T* value,
size_t alignment) {
100 return (T*)alignDown((intptr_t)value, alignment);
103 template <
typename T>
inline T alignUp(T value,
size_t alignment) {
104 return alignDown((T)(value + alignment - 1), alignment);
107 template <
typename T>
inline T* alignUp(T* value,
size_t alignment) {
108 return (T*)alignDown((intptr_t)(value + alignment - 1), alignment);
111 size_t getNumChannels(hsa_ext_image_channel_order_t channelOrder) {
112 switch (channelOrder) {
113 case HSA_EXT_IMAGE_CHANNEL_ORDER_RG:
115 case HSA_EXT_IMAGE_CHANNEL_ORDER_RGB:
117 case HSA_EXT_IMAGE_CHANNEL_ORDER_RGBA:
119 case HSA_EXT_IMAGE_CHANNEL_ORDER_R:
125 size_t getElementSize(hsa_ext_image_channel_order_t channelOrder, hsa_ext_image_channel_type_t channelType) {
126 size_t bytesPerPixel = getNumChannels(channelOrder);
127 switch (channelType) {
128 case HSA_EXT_IMAGE_CHANNEL_TYPE_UNSIGNED_INT8:
129 case HSA_EXT_IMAGE_CHANNEL_TYPE_SIGNED_INT8:
132 case HSA_EXT_IMAGE_CHANNEL_TYPE_SIGNED_INT32:
133 case HSA_EXT_IMAGE_CHANNEL_TYPE_UNSIGNED_INT32:
134 case HSA_EXT_IMAGE_CHANNEL_TYPE_FLOAT:
142 return bytesPerPixel;
150 int tid()
const {
return _shortTid; };
151 pid_t pid()
const {
return _pid; };
152 uint64_t incApiSeqNum() {
return ++_apiSeqNum; };
153 uint64_t apiSeqNum()
const {
return _apiSeqNum; };
164 static const uint64_t MAX_TRIGGER = std::numeric_limits<uint64_t>::max();
166 void print(
int tid) {
167 std::cout <<
"Enabling tracing for ";
168 for (
auto iter = _profTrigger.begin(); iter != _profTrigger.end(); iter++) {
169 std::cout <<
"tid:" << tid <<
"." << *iter <<
",";
174 uint64_t nextTrigger() {
return _profTrigger.empty() ? MAX_TRIGGER : _profTrigger.back(); };
175 void add(uint64_t trigger) { _profTrigger.push_back(trigger); };
176 void sort() { std::sort(_profTrigger.begin(), _profTrigger.end(), std::greater<int>()); };
179 std::vector<uint64_t> _profTrigger;
188 lastHipError = hipSuccess;
189 getPrimaryCtx =
true;
190 defaultCtx =
nullptr;
193 hipError_t lastHipError;
199 std::stack<ihipCtx_t*> ctxStack;
203 #define GET_TLS() TlsData *tls = tls_get_ptr() 205 extern std::vector<ProfTrigger> g_dbStartTriggers;
206 extern std::vector<ProfTrigger> g_dbStopTriggers;
216 #define KNRM "\x1B[0m" 217 #define KRED "\x1B[31m" 218 #define KGRN "\x1B[32m" 219 #define KYEL "\x1B[33m" 220 #define KBLU "\x1B[34m" 221 #define KMAG "\x1B[35m" 222 #define KCYN "\x1B[36m" 223 #define KWHT "\x1B[37m" 225 extern const char* API_COLOR;
226 extern const char* API_COLOR_END;
232 #define EVENT_THREAD_SAFE 1 234 #define STREAM_THREAD_SAFE 1 236 #define CTX_THREAD_SAFE 1 238 #define DEVICE_THREAD_SAFE 1 243 #define COMPILE_HIP_DB 1 251 #define COMPILE_HIP_TRACE_API 0x3 256 #ifndef COMPILE_HIP_ATP_MARKER 257 #define COMPILE_HIP_ATP_MARKER 0 266 #if COMPILE_HIP_ATP_MARKER 267 #include "CXLActivityLogger.h" 268 #define MARKER_BEGIN(markerName, group) amdtBeginMarker(markerName, group, nullptr); 269 #define MARKER_END() amdtEndMarker(); 270 #define RESUME_PROFILING amdtResumeProfiling(AMDT_ALL_PROFILING); 271 #define STOP_PROFILING amdtStopProfiling(AMDT_ALL_PROFILING); 274 #define MARKER_BEGIN(markerName, group) 276 #define RESUME_PROFILING 277 #define STOP_PROFILING 283 #define TRACE_ALL 0 // 0x01 284 #define TRACE_KCMD 1 // 0x02, kernel command 285 #define TRACE_MCMD 2 // 0x04, memory command 286 #define TRACE_MEM 3 // 0x08, memory allocation or deallocation. 287 #define TRACE_SYNC 4 // 0x10, synchronization (host or hipStreamWaitEvent) 288 #define TRACE_QUERY 5 // 0x20, hipEventRecord, hipEventQuery, hipStreamQuery 299 #define DB_MAX_FLAG 6 306 const char* _shortName;
310 static const DbName dbName[] = {
312 {KYEL,
"sync"}, {KCYN,
"mem"}, {KMAG,
"copy"}, {KRED,
"warn"},
318 #define tprintf(trace_level, ...) \ 320 if (HIP_DB & (1 << (trace_level))) { \ 323 snprintf(msgStr, sizeof(msgStr), __VA_ARGS__); \ 324 fprintf(stderr, " %ship-%s pid:%d tid:%d:%s%s", dbName[trace_level]._color, \ 325 dbName[trace_level]._shortName, tls->tidInfo.pid(), tls->tidInfo.tid(), msgStr, KNRM); \ 330 #define tprintf(trace_level, ...) 334 static inline uint64_t getTicks() {
return hc::get_system_ticks(); }
337 extern uint64_t recordApiTrace(
TlsData *tls, std::string* fullStr,
const std::string& apiStr);
339 #if COMPILE_HIP_ATP_MARKER || (COMPILE_HIP_TRACE_API & 0x1) 340 #define API_TRACE(forceTrace, ...) \ 342 uint64_t hipApiStartTick = 0; \ 344 tls->tidInfo.incApiSeqNum(); \ 346 (HIP_PROFILE_API || (COMPILE_HIP_DB && (HIP_TRACE_API & (1 << TRACE_ALL))))) { \ 347 std::string apiStr = std::string(__func__) + " (" + ToString(__VA_ARGS__) + ')'; \ 348 std::string fullStr; \ 349 hipApiStartTick = recordApiTrace(tls, &fullStr, apiStr); \ 350 if (HIP_PROFILE_API == 0x1) { \ 351 MARKER_BEGIN(__func__, "HIP") \ 352 } else if (HIP_PROFILE_API == 0x2) { \ 353 MARKER_BEGIN(fullStr.c_str(), "HIP"); \ 360 #define API_TRACE(IS_CMD, ...) GET_TLS(); tls->tidInfo.incApiSeqNum(); 363 #define ihipGetTlsDefaultCtx() iihipGetTlsDefaultCtx(tls) 364 #define ihipSetTlsDefaultCtx(ctx) tls->defaultCtx = ctx 366 #define HIP_SET_DEVICE() ihipDeviceSetState(tls); 371 #define HIP_INIT_API(cid, ...) \ 372 hip_impl::hip_init(); \ 373 API_TRACE(0, __VA_ARGS__); \ 374 HIP_CB_SPAWNER_OBJECT(cid); 380 #define HIP_INIT_SPECIAL_API(cid, tbit, ...) \ 381 hip_impl::hip_init(); \ 382 API_TRACE((HIP_TRACE_API & (1 << tbit)), __VA_ARGS__); \ 383 HIP_CB_SPAWNER_OBJECT(cid); 389 #define ihipLogStatus(hipStatus) \ 391 hipError_t localHipStatus = hipStatus; \ 392 tls->lastHipError = localHipStatus; \ 394 if ((COMPILE_HIP_TRACE_API & 0x2) && HIP_TRACE_API & (1 << TRACE_ALL)) { \ 395 auto ticks = getTicks() - hipApiStartTick; \ 396 fprintf(stderr, " %ship-api pid:%d tid:%d.%lu %-30s ret=%2d (%s)>> +%lu ns%s\n", \ 397 (localHipStatus == 0) ? API_COLOR : KRED, tls->tidInfo.pid(), tls->tidInfo.tid(), \ 398 tls->tidInfo.apiSeqNum(), __func__, localHipStatus, \ 399 ihipErrorString(localHipStatus), ticks, API_COLOR_END); \ 401 if (HIP_PROFILE_API) { \ 431 #define HIP_IPC_RESERVED_SIZE 24 438 char reserved[HIP_IPC_RESERVED_SIZE];
443 std::string fileName;
444 hsa_executable_t executable = {};
445 hsa_code_object_reader_t coReader = {};
448 std::string, std::vector<std::pair<std::size_t, std::size_t>>> kernargs;
451 if (executable.handle) hsa_executable_destroy(executable);
452 if (coReader.handle) hsa_code_object_reader_destroy(coReader);
462 bool try_lock() {
return true; }
466 #if EVENT_THREAD_SAFE 467 typedef std::mutex EventMutex;
469 #warning "Stream thread-safe disabled" 473 #if STREAM_THREAD_SAFE 474 typedef std::mutex StreamMutex;
476 #warning "Stream thread-safe disabled" 482 typedef std::mutex CtxMutex;
485 #warning "Ctx thread-safe disabled" 488 #if DEVICE_THREAD_SAFE 489 typedef std::mutex DeviceMutex;
492 #warning "Device thread-safe disabled" 499 template <
typename T>
503 : _criticalData(&criticalData),
504 _autoUnlock(autoUnlock)
507 tprintf(DB_SYNC,
"locking criticalData=%p for %s..\n", _criticalData,
508 ToString(_criticalData->_parent).c_str());
509 _criticalData->_mutex.lock();
514 tprintf(DB_SYNC,
"auto-unlocking criticalData=%p for %s...\n", _criticalData,
515 ToString(_criticalData->_parent).c_str());
516 _criticalData->_mutex.unlock();
521 tprintf(DB_SYNC,
"unlocking criticalData=%p for %s...\n", _criticalData,
522 ToString(_criticalData->_parent).c_str());
523 _criticalData->_mutex.unlock();
527 T* operator->() {
return _criticalData; };
535 template <
typename MUTEX_TYPE>
539 void lock() { _mutex.lock(); }
540 void unlock() { _mutex.unlock(); }
541 bool try_lock() {
return _mutex.try_lock(); }
547 template <
typename MUTEX_TYPE>
551 : _parent{parentStream}, _av{av}, _last_op_was_a_copy{
false}
562 tprintf(DB_SYNC,
"munlocking criticalData=%p for %s...\n",
this,
563 ToString(this->_parent).c_str());
569 tprintf(DB_SYNC,
"mtry_locking=%d criticalData=%p for %s...\n", gotLock,
this,
570 ToString(this->_parent).c_str());
571 return gotLock ?
this :
nullptr;
575 hc::accelerator_view _av;
576 bool _last_op_was_a_copy;
595 enum ScheduleMode { Auto, Spin, Yield };
596 typedef uint64_t SeqNum_t;
603 void locked_copySync(
void* dst,
const void* src,
size_t sizeBytes,
unsigned kind,
604 bool resolveOn =
true);
606 bool locked_copy2DSync(
void* dst,
const void* src,
size_t width,
size_t height,
size_t srcPitch,
size_t dstPitch,
unsigned kind,
607 bool resolveOn =
true);
609 void locked_copyAsync(
void* dst,
const void* src,
size_t sizeBytes,
unsigned kind);
611 bool locked_copy2DAsync(
void* dst,
const void* src,
size_t width,
size_t height,
size_t srcPitch,
size_t dstPitch,
unsigned kind);
613 void lockedSymbolCopySync(hc::accelerator& acc,
void* dst,
void* src,
size_t sizeBytes,
614 size_t offset,
unsigned kind);
615 void lockedSymbolCopyAsync(hc::accelerator& acc,
void* dst,
void* src,
size_t sizeBytes,
616 size_t offset,
unsigned kind);
621 LockedAccessor_StreamCrit_t lockopen_preKernelCommand();
622 void lockclose_postKernelCommand(
const char* kernelName, hc::accelerator_view* av,
bool unlockNotNeeded = 0);
624 void locked_wait(
bool& waited);
627 hc::accelerator_view* locked_getAv() {
628 LockedAccessor_StreamCrit_t crit(_criticalData);
633 hc::completion_future locked_recordEvent(
hipEvent_t event);
635 ihipStreamCritical_t& criticalData() {
return _criticalData; };
638 hc::hcWaitMode waitMode()
const;
641 void wait(LockedAccessor_StreamCrit_t& crit);
643 void launchModuleKernel(hc::accelerator_view av, hsa_signal_t signal, uint32_t blockDimX,
644 uint32_t blockDimY, uint32_t blockDimZ, uint32_t gridDimX,
645 uint32_t gridDimY, uint32_t gridDimZ, uint32_t groupSegmentSize,
646 uint32_t sharedMemBytes,
void* kernarg,
size_t kernSize,
657 bool isDefaultStream()
const {
return _id == 0; };
668 unsigned resolveMemcpyDirection(
bool srcInDeviceMem,
bool dstInDeviceMem);
669 void resolveHcMemcpyDirection(
unsigned hipMemKind,
const hc::AmPointerInfo* dstPtrInfo,
670 const hc::AmPointerInfo* srcPtrInfo, hc::hcCommandKind* hcCopyDir,
671 ihipCtx_t** copyDevice,
bool* forceUnpinnedCopy);
673 bool canSeeMemory(
const ihipCtx_t* thisCtx,
const hc::AmPointerInfo* dstInfo,
674 const hc::AmPointerInfo* srcInfo);
676 void addSymbolPtrToTracker(hc::accelerator& acc,
void* ptr,
size_t sizeBytes);
680 ihipStreamCritical_t _criticalData;
682 std::mutex _hasQueueLock;
687 friend std::ostream& operator<<(std::ostream& os,
const ihipStream_t& s);
690 ScheduleMode _scheduleMode;
699 : _stream(stream), _callback(callback), _userData(userData) {
709 enum hipEventStatus_t {
710 hipEventStatusUnitialized = 0,
711 hipEventStatusCreated = 1,
712 hipEventStatusRecording = 2,
713 hipEventStatusComplete = 3,
717 enum ihipEventType_t {
718 hipEventTypeIndependent,
719 hipEventTypeStartCommand,
720 hipEventTypeStopCommand,
726 _state = hipEventStatusCreated;
729 _type = hipEventTypeIndependent;
732 void marker(
const hc::completion_future& marker) { _marker = marker; };
733 hc::completion_future& marker() {
return _marker; }
734 uint64_t timestamp()
const {
return _timestamp; };
735 ihipEventType_t type()
const {
return _type; };
737 ihipEventType_t _type;
738 hipEventStatus_t _state;
743 hc::completion_future _marker;
749 template <
typename MUTEX_TYPE>
772 void attachToCompletionFuture(
const hc::completion_future* cf,
hipStream_t stream,
773 ihipEventType_t eventType);
777 LockedAccessor_EventCrit_t crit(_criticalData);
778 return _criticalData._eventData;
781 ihipEventCritical_t& criticalData() {
return _criticalData; };
787 ihipEventCritical_t _criticalData;
795 template <
typename MUTEX_TYPE>
799 : _parent(parentDevice), _ctxCount(0){};
806 std::list<ihipCtx_t*>& ctxs() {
return _ctxs; };
807 const std::list<ihipCtx_t*>& const_ctxs()
const {
return _ctxs; };
808 int getcount() {
return _ctxCount; };
815 std::list<ihipCtx_t*> _ctxs;
829 ihipDevice_t(
unsigned deviceId,
unsigned deviceCnt, hc::accelerator& acc);
833 ihipCtx_t* getPrimaryCtx()
const {
return _primaryCtx; };
836 ihipDeviceCritical_t& criticalData() {
return _criticalData; };
841 hc::accelerator _acc;
842 hsa_agent_t _hsaAgent;
859 ihipDeviceCritical_t _criticalData;
871 std::vector<char> _arguments;
876 template <
typename MUTEX_TYPE>
880 : _parent(parentCtx), _peerCnt(0) {
881 _peerAgents =
new hsa_agent_t[deviceCnt];
885 if (_peerAgents !=
nullptr) {
887 _peerAgents =
nullptr;
894 std::list<ihipStream_t*>& streams() {
return _streams; };
895 const std::list<ihipStream_t*>& const_streams()
const {
return _streams; };
899 bool isPeerWatcher(
const ihipCtx_t* peer);
903 void resetPeerWatchers(
ihipCtx_t* thisDevice);
904 void printPeerWatchers(FILE* f)
const;
906 uint32_t peerCnt()
const {
return _peerCnt; };
907 hsa_agent_t* peerAgents()
const {
return _peerAgents; };
911 std::list<ihipCtx_t*> _peers;
913 std::stack<ihipExec_t> _execStack;
921 std::list<ihipStream_t*> _streams;
929 hsa_agent_t* _peerAgents;
931 void recomputePeerAgents();
962 void locked_waitAllStreams();
963 void locked_syncDefaultStream(
bool waitOnSelf,
bool syncHost);
965 ihipCtxCritical_t& criticalData() {
return _criticalData; };
967 const ihipDevice_t* getDevice()
const {
return _device; };
968 int getDeviceNum()
const {
return _device->_deviceId; };
971 ihipDevice_t* getWriteableDevice()
const {
return _device; };
973 std::string toString()
const;
991 ihipCtxCritical_t _criticalData;
997 extern unsigned g_deviceCnt;
998 extern hsa_agent_t g_cpu_agent;
999 extern hsa_agent_t* g_allAgents;
1003 extern void ihipInit();
1004 extern const char* ihipErrorString(hipError_t);
1005 extern hipError_t ihipSynchronize(
TlsData *tls);
1006 extern void ihipCtxStackUpdate();
1007 extern hipError_t ihipDeviceSetState(
TlsData *tls);
1010 ihipCtx_t* ihipGetPrimaryCtx(
unsigned deviceIndex);
1012 const char* name, hsa_agent_t *agent);
1020 inline std::ostream& operator<<(std::ostream& os,
const ihipStream_t& s) {
1022 os << s.getDevice()->_deviceId;
1029 inline std::ostream& operator<<(std::ostream& os,
const dim3& s) {
1040 inline std::ostream& operator<<(std::ostream& os,
const gl_dim3& s) {
1052 inline std::ostream& operator<<(std::ostream& os,
const hipEvent_t& e) {
1053 os <<
"event:" << std::hex << static_cast<void*>(e);
1057 inline std::ostream& operator<<(std::ostream& os,
const ihipCtx_t* c) {
1058 os <<
"ctx:" <<
static_cast<const void*
>(c) <<
".dev:" << c->getDevice()->_deviceId;
1065 hipError_t memcpyAsync(
void* dst,
const void* src,
size_t sizeBytes, hipMemcpyKind kind,
1068 hipError_t ihipHostMalloc(
TlsData *tls,
void** ptr,
size_t sizeBytes,
unsigned int flags);
1070 hipError_t ihipHostFree(
TlsData *tls,
void* ptr);
1074 #define MAX_COOPERATIVE_GPUs 255 1098 if ((tls->defaultCtx ==
nullptr) && (g_deviceCnt > 0)) {
1099 tls->defaultCtx = ihipGetPrimaryCtx(0);
1101 return tls->defaultCtx;
Definition: hip_hcc_internal.h:304
Definition: hip_hcc_internal.h:1077
Definition: hip_hcc_internal.h:827
Definition: hip_hcc_internal.h:536
Definition: hip_hcc_internal.h:163
Definition: hip_hcc_internal.h:459
Definition: hip_hcc_internal.h:432
uint32_t x
x
Definition: hip_runtime_api.h:270
Definition: grid_launch.h:17
Definition: hip_hcc_internal.h:1082
Definition: hip_module.cpp:108
Definition: hip_hcc_internal.h:186
Definition: hip_hcc_internal.h:866
Definition: hip_hcc_internal.h:947
Definition: hip_runtime_api.h:269
uint32_t y
y
Definition: hip_runtime_api.h:271
void(* hipStreamCallback_t)(hipStream_t stream, hipError_t status, void *userData)
Definition: hip_runtime_api.h:843
Definition: hip_hcc_internal.h:696
Definition: hip_hcc_internal.h:796
unsigned _computeUnits
Number of compute units supported by the device:
Definition: hip_hcc_internal.h:845
uint32_t z
z
Definition: hip_runtime_api.h:272
Definition: hip_runtime_api.h:83
Definition: hip_hcc_internal.h:724
Definition: hip_hcc_internal.h:750
Definition: hip_hcc_internal.h:1064
Definition: hip_hcc_internal.h:408
Definition: hip_hcc_internal.h:769
Definition: hip_hcc_internal.h:877
Definition: hip_hcc_internal.h:593
Definition: hip_hcc_internal.h:548
hipError_t hipEventRecord(hipEvent_t event, hipStream_t stream)
Record an event in the specified stream.
Definition: hip_event.cpp:104
hsa_amd_ipc_memory_t ipc_handle
ipc memory handle on ROCr
Definition: hip_hcc_internal.h:435
Definition: hip_hcc_internal.h:500
Definition: hip_hcc_internal.h:442
hipError_t hipStreamQuery(hipStream_t stream)
Return #hipSuccess if all of the operations in the specified stream have completed, or #hipErrorNotReady if not.
Definition: hip_stream.cpp:160
Definition: hip_hcc_internal.h:146