Skip to content

[DevSAN] Change DeviceType to specialization constant #19798

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: sycl
Choose a base branch
from
Open

[DevSAN] Change DeviceType to specialization constant #19798

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions libdevice/include/sanitizer_defs.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@ extern SYCL_EXTERNAL __attribute__((convergent)) void
__spirv_ControlBarrier(int32_t Execution, int32_t Memory,
int32_t Semantics) noexcept;

template <typename T>
extern SYCL_EXTERNAL T __spirv_SpecConstant(int ID, T default_value) noexcept;

extern "C" SYCL_EXTERNAL void __devicelib_exit();

#endif // __SPIR__ || __SPIRV__
7 changes: 6 additions & 1 deletion libdevice/include/sanitizer_utils.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
//===----------------------------------------------------------------------===//
#pragma once

#include "sanitizer_common/sanitizer_libdevice.hpp"
#include "sanitizer_defs.hpp"
#include "spirv_vars.h"

#if defined(__SPIR__) || defined(__SPIRV__)

Expand Down Expand Up @@ -49,6 +49,11 @@ inline __SYCL_PRIVATE__ void *ToPrivate(void *ptr) {
return __spirv_GenericCastToPtrExplicit_ToPrivate(ptr, 7);
}

inline DeviceType GetDeviceTy() {
return static_cast<DeviceType>(
__spirv_SpecConstant(SpecConstantDeviceTyID, 0));
}

template <typename T> T Memset(T ptr, int value, size_t size) {
for (size_t i = 0; i < size; i++) {
ptr[i] = value;
Expand Down
25 changes: 18 additions & 7 deletions libdevice/sanitizer/asan_rtl.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,16 +264,15 @@ inline uptr MemToShadow(uptr addr, uint32_t as,
#elif defined(__LIBDEVICE_DG2__)
shadow_ptr = MemToShadow_DG2(addr, as, debug);
#else
auto launch_info = (__SYCL_GLOBAL__ const AsanRuntimeData *)__AsanLaunchInfo;
if (launch_info->DeviceTy == DeviceType::CPU) {
if (GetDeviceTy() == DeviceType::CPU) {
shadow_ptr = MemToShadow_CPU(addr);
} else if (launch_info->DeviceTy == DeviceType::GPU_PVC) {
} else if (GetDeviceTy() == DeviceType::GPU_PVC) {
shadow_ptr = MemToShadow_PVC(addr, as, debug);
} else if (launch_info->DeviceTy == DeviceType::GPU_DG2) {
} else if (GetDeviceTy() == DeviceType::GPU_DG2) {
shadow_ptr = MemToShadow_DG2(addr, as, debug);
} else {
ASAN_DEBUG(__spirv_ocl_printf(__asan_print_unsupport_device_type,
(int)launch_info->DeviceTy));
(int)GetDeviceTy()));
ReportUnknownDevice(debug);
return 0;
}
Expand Down Expand Up @@ -889,8 +888,7 @@ DEVICE_EXTERN_C_NOINLINE void __asan_set_shadow_private(uptr shadow, uptr size,
static __SYCL_CONSTANT__ const char __asan_print_private_base[] =
"[kernel] set_private_base: %llu -> %p\n";

DEVICE_EXTERN_C_NOINLINE void
__asan_set_private_base(__SYCL_PRIVATE__ void *ptr) {
inline void SetPrivateBaseImpl(__SYCL_PRIVATE__ void *ptr) {
auto launch_info = (__SYCL_GLOBAL__ const AsanRuntimeData *)__AsanLaunchInfo;
const size_t sid = SubGroupLinearId();
if (!launch_info || sid >= ASAN_MAX_SG_PRIVATE ||
Expand All @@ -904,4 +902,17 @@ __asan_set_private_base(__SYCL_PRIVATE__ void *ptr) {
SubGroupBarrier();
}

DEVICE_EXTERN_C_NOINLINE void
__asan_set_private_base(__SYCL_PRIVATE__ void *ptr) {
#if defined(__LIBDEVICE_CPU__)
return;
#elif defined(__LIBDEVICE_DG2__) || defined(__LIBDEVICE_PVC__)
SetPrivateBaseImpl(ptr);
#else
if (GetDeviceTy() == DeviceType::CPU)
return;
SetPrivateBaseImpl(ptr);
#endif
}

#endif // __SPIR__ || __SPIRV__
36 changes: 24 additions & 12 deletions libdevice/sanitizer/msan_rtl.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,16 +212,16 @@ inline uptr MemToShadow(uptr addr, uint32_t as) {
#elif defined(__LIBDEVICE_CPU__)
shadow_ptr = MemToShadow_CPU(addr);
#else
if (LIKELY(GetMsanLaunchInfo->DeviceTy == DeviceType::CPU)) {
if (GetDeviceTy() == DeviceType::CPU) {
shadow_ptr = MemToShadow_CPU(addr);
} else if (GetMsanLaunchInfo->DeviceTy == DeviceType::GPU_PVC) {
} else if (GetDeviceTy() == DeviceType::GPU_PVC) {
shadow_ptr = MemToShadow_PVC(addr, as);
} else if (GetMsanLaunchInfo->DeviceTy == DeviceType::GPU_DG2) {
} else if (GetDeviceTy() == DeviceType::GPU_DG2) {
shadow_ptr = MemToShadow_DG2(addr, as);
} else {
shadow_ptr = GetMsanLaunchInfo->CleanShadow;
MSAN_DEBUG(__spirv_ocl_printf(__msan_print_unsupport_device_type,
GetMsanLaunchInfo->DeviceTy));
MSAN_DEBUG(
__spirv_ocl_printf(__msan_print_unsupport_device_type, GetDeviceTy()));
}
#endif

Expand Down Expand Up @@ -269,17 +269,17 @@ inline uptr MemToOrigin(uptr addr, uint32_t as) {
#elif defined(__LIBDEVICE_CPU__)
origin_ptr = MemToOrigin_CPU(addr);
#else
if (LIKELY(GetMsanLaunchInfo->DeviceTy == DeviceType::CPU)) {
if (GetDeviceTy() == DeviceType::CPU) {
origin_ptr = MemToOrigin_CPU(aligned_addr);
} else if (GetMsanLaunchInfo->DeviceTy == DeviceType::GPU_PVC) {
} else if (GetDeviceTy() == DeviceType::GPU_PVC) {
origin_ptr = MemToOrigin_PVC(aligned_addr, as);
} else if (GetMsanLaunchInfo->DeviceTy == DeviceType::GPU_DG2) {
} else if (GetDeviceTy() == DeviceType::GPU_DG2) {
origin_ptr = MemToOrigin_DG2(aligned_addr, as);
} else {
// Return clean shadow (0s) by default
origin_ptr = GetMsanLaunchInfo->CleanShadow;
MSAN_DEBUG(__spirv_ocl_printf(__msan_print_unsupport_device_type,
GetMsanLaunchInfo->DeviceTy));
MSAN_DEBUG(
__spirv_ocl_printf(__msan_print_unsupport_device_type, GetDeviceTy()));
}
#endif

Expand Down Expand Up @@ -719,8 +719,7 @@ DEVICE_EXTERN_C_NOINLINE void __msan_unpoison_stack(__SYCL_PRIVATE__ void *ptr,
static __SYCL_CONSTANT__ const char __msan_print_private_base[] =
"[kernel] __msan_set_private_base(sid=%llu): %p\n";

DEVICE_EXTERN_C_NOINLINE void
__msan_set_private_base(__SYCL_PRIVATE__ void *ptr) {
inline void SetPrivateBaseImpl(__SYCL_PRIVATE__ void *ptr) {
const size_t sid = SubGroupLinearId();
if (!GetMsanLaunchInfo || sid >= MSAN_MAX_SG_PRIVATE ||
GetMsanLaunchInfo->PrivateShadowOffset == 0 ||
Expand All @@ -734,6 +733,19 @@ __msan_set_private_base(__SYCL_PRIVATE__ void *ptr) {
SubGroupBarrier();
}

DEVICE_EXTERN_C_NOINLINE void
__msan_set_private_base(__SYCL_PRIVATE__ void *ptr) {
#if defined(__LIBDEVICE_CPU__)
return;
#elif defined(__LIBDEVICE_DG2__) || defined(__LIBDEVICE_PVC__)
SetPrivateBaseImpl(ptr);
#else
if (GetDeviceTy() == DeviceType::CPU)
return;
SetPrivateBaseImpl(ptr);
#endif
}

static __SYCL_CONSTANT__ const char __msan_print_strided_copy_unsupport_type[] =
"[kernel] __msan_unpoison_strided_copy: unsupported type(%d)\n";

Expand Down
18 changes: 12 additions & 6 deletions libdevice/sanitizer/tsan_rtl.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,13 +127,13 @@ inline __SYCL_GLOBAL__ RawShadow *MemToShadow(uptr addr, uint32_t as) {
#elif defined(__LIBDEVICE_PVC__)
shadow_ptr = MemToShadow_PVC(addr, as);
#else
if (TsanLaunchInfo->DeviceTy == DeviceType::CPU) {
if (GetDeviceTy() == DeviceType::CPU) {
shadow_ptr = MemToShadow_CPU(addr, as);
} else if (TsanLaunchInfo->DeviceTy == DeviceType::GPU_PVC) {
} else if (GetDeviceTy() == DeviceType::GPU_PVC) {
shadow_ptr = MemToShadow_PVC(addr, as);
} else {
TSAN_DEBUG(__spirv_ocl_printf(__tsan_print_unsupport_device_type,
(int)TsanLaunchInfo->DeviceTy));
(int)GetDeviceTy()));
return nullptr;
}
#endif
Expand Down Expand Up @@ -186,10 +186,16 @@ inline void DoReportRace(__SYCL_GLOBAL__ RawShadow *s, AccessType type,
return;
}

if (as == ADDRESS_SPACE_GENERIC &&
TsanLaunchInfo->DeviceTy != DeviceType::CPU) {
#if defined(__LIBDEVICE_CPU__)
#elif defined(__LIBDEVICE_DG2__) || defined(__LIBDEVICE_PVC__)
if (as == ADDRESS_SPACE_GENERIC) {
ConvertGenericPointer(addr, as);
}
#else
if (as == ADDRESS_SPACE_GENERIC && GetDeviceTy() != DeviceType::CPU) {
ConvertGenericPointer(addr, as);
}
#endif

// Check if current address already being recorded before.
for (uint32_t i = 0; i < TsanLaunchInfo->RecordedReportCount; i++) {
Expand Down Expand Up @@ -467,7 +473,7 @@ DEVICE_EXTERN_C_NOINLINE void __tsan_cleanup_private(uptr addr, size_t size) {
#elif defined(__LIBDEVICE_PVC__)
return;
#else
if (TsanLaunchInfo->DeviceTy != DeviceType::CPU)
if (GetDeviceTy() != DeviceType::CPU)
return;

__tsan_cleanup_private_cpu_impl(addr, size);
Expand Down
20 changes: 15 additions & 5 deletions unified-runtime/source/loader/layers/sanitizer/asan/asan_interceptor.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -643,6 +643,19 @@ ur_result_t AsanInterceptor::insertProgram(ur_program_handle_t Program) {
if (m_ProgramMap.find(Program) != m_ProgramMap.end()) {
return UR_RESULT_SUCCESS;
}
auto CI = getContextInfo(GetContext(Program));
auto DI = getDeviceInfo(CI->DeviceList[0]);
ur_specialization_constant_info_t SpecConstantInfo{
SpecConstantDeviceTyID, sizeof(DeviceType), &DI->Type};
ur_result_t URes =
getContext()->urDdiTable.Program.pfnSetSpecializationConstants(
Program, 1, &SpecConstantInfo);
if (URes != UR_RESULT_SUCCESS) {
UR_LOG_L(getContext()->logger, DEBUG,
"Set specilization constant for device type failed: {}, the "
"program may not be sanitized or is created from binary.",
URes);
}
m_ProgramMap.emplace(Program, std::make_shared<ProgramInfo>(Program));
return UR_RESULT_SUCCESS;
}
Expand Down Expand Up @@ -812,7 +825,6 @@ ur_result_t AsanInterceptor::prepareLaunch(
// Prepare asan runtime data
LaunchInfo.Data.Host.GlobalShadowOffset = DeviceInfo->Shadow->ShadowBegin;
LaunchInfo.Data.Host.GlobalShadowOffsetEnd = DeviceInfo->Shadow->ShadowEnd;
LaunchInfo.Data.Host.DeviceTy = DeviceInfo->Type;
LaunchInfo.Data.Host.Debug = getContext()->Options.Debug ? 1 : 0;

// Write shadow memory offset for local memory
Expand Down Expand Up @@ -874,16 +886,14 @@ ur_result_t AsanInterceptor::prepareLaunch(

UR_LOG_L(getContext()->logger, INFO,
"LaunchInfo {} (GlobalShadow={}, LocalShadow={}, PrivateBase={}, "
"PrivateShadow={}, LocalArgs={}, NumLocalArgs={}, "
"Device={}, Debug={})",
"PrivateShadow={}, LocalArgs={}, NumLocalArgs={}, Debug={})",
(void *)LaunchInfo.Data.getDevicePtr(),
(void *)LaunchInfo.Data.Host.GlobalShadowOffset,
(void *)LaunchInfo.Data.Host.LocalShadowOffset,
(void *)LaunchInfo.Data.Host.PrivateBase,
(void *)LaunchInfo.Data.Host.PrivateShadowOffset,
(void *)LaunchInfo.Data.Host.LocalArgs,
LaunchInfo.Data.Host.NumLocalArgs,
ToString(LaunchInfo.Data.Host.DeviceTy), LaunchInfo.Data.Host.Debug);
LaunchInfo.Data.Host.NumLocalArgs, LaunchInfo.Data.Host.Debug);

return UR_RESULT_SUCCESS;
}
Expand Down
1 change: 0 additions & 1 deletion unified-runtime/source/loader/layers/sanitizer/asan/asan_libdevice.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,6 @@ struct AsanRuntimeData {
LocalArgsInfo *LocalArgs = nullptr; // Ordered by ArgIndex
uint32_t NumLocalArgs = 0;

DeviceType DeviceTy = DeviceType::UNKNOWN;
uint32_t Debug = 0;

int ReportFlag = 0;
Expand Down
19 changes: 15 additions & 4 deletions unified-runtime/source/loader/layers/sanitizer/msan/msan_interceptor.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,6 +384,19 @@ ur_result_t MsanInterceptor::insertProgram(ur_program_handle_t Program) {
if (m_ProgramMap.find(Program) != m_ProgramMap.end()) {
return UR_RESULT_SUCCESS;
}
auto CI = getContextInfo(GetContext(Program));
auto DI = getDeviceInfo(CI->DeviceList[0]);
ur_specialization_constant_info_t SpecConstantInfo{
SpecConstantDeviceTyID, sizeof(DeviceType), &DI->Type};
ur_result_t URes =
getContext()->urDdiTable.Program.pfnSetSpecializationConstants(
Program, 1, &SpecConstantInfo);
if (URes != UR_RESULT_SUCCESS) {
UR_LOG_L(getContext()->logger, DEBUG,
"Set specilization constant for device type failed: {}, the "
"program may not be sanitized or is created from binary.",
URes);
}
m_ProgramMap.emplace(Program, std::make_shared<ProgramInfo>(Program));
return UR_RESULT_SUCCESS;
}
Expand Down Expand Up @@ -492,7 +505,6 @@ ur_result_t MsanInterceptor::prepareLaunch(
LaunchInfo.Data.Host.GlobalShadowOffset = DeviceInfo->Shadow->ShadowBegin;
LaunchInfo.Data.Host.GlobalShadowOffsetEnd = DeviceInfo->Shadow->ShadowEnd;

LaunchInfo.Data.Host.DeviceTy = DeviceInfo->Type;
LaunchInfo.Data.Host.Debug = getContext()->Options.Debug ? 1 : 0;
LaunchInfo.Data.Host.IsRecover = getContext()->Options.Recover ? 1 : 0;

Expand Down Expand Up @@ -599,16 +611,15 @@ ur_result_t MsanInterceptor::prepareLaunch(
UR_LOG_L(getContext()->logger, INFO,
"LaunchInfo {} (GlobalShadow={}, LocalShadow={}, PrivateBase={}, "
"PrivateShadow={}, CleanShadow={}, LocalArgs={}, NumLocalArgs={}, "
"Device={}, Debug={})",
"Debug={})",
(void *)LaunchInfo.Data.getDevicePtr(),
(void *)LaunchInfo.Data.Host.GlobalShadowOffset,
(void *)LaunchInfo.Data.Host.LocalShadowOffset,
(void *)LaunchInfo.Data.Host.PrivateBase,
(void *)LaunchInfo.Data.Host.PrivateShadowOffset,
(void *)LaunchInfo.Data.Host.CleanShadow,
(void *)LaunchInfo.Data.Host.LocalArgs,
LaunchInfo.Data.Host.NumLocalArgs,
ToString(LaunchInfo.Data.Host.DeviceTy), LaunchInfo.Data.Host.Debug);
LaunchInfo.Data.Host.NumLocalArgs, LaunchInfo.Data.Host.Debug);

ur_result_t URes =
getContext()->urDdiTable.Enqueue.pfnDeviceGlobalVariableWrite(
Expand Down
1 change: 0 additions & 1 deletion unified-runtime/source/loader/layers/sanitizer/msan/msan_libdevice.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ struct MsanRuntimeData {

uintptr_t CleanShadow = 0;

DeviceType DeviceTy = DeviceType::UNKNOWN;
uint32_t Debug = 0;
uint32_t IsRecover = 0;

Expand Down
3 changes: 3 additions & 0 deletions unified-runtime/source/loader/layers/sanitizer/sanitizer_common/sanitizer_libdevice.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ namespace ur_sanitizer_layer {

enum class DeviceType : uint32_t { UNKNOWN = 0, CPU, GPU_PVC, GPU_DG2 };

// Try to use a larger ID number to avoid conflict with user ID.
constexpr int SpecConstantDeviceTyID = 99;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this value is high enough to avoid conflicts. Normally the frontend would give our specialization constants a value based on the other specialization constants in the same TU. Is there a way we could leverage this to get a guaranteed unique ID?

Of course, it begs the question how the unified runtime would know what it would be. Maybe we can make the frontend offset the start of its assigned specialization constants based when the sanitizer is enabled? That way this could use 0 and the other specialization constants would start from 1 and increment.


inline const char *ToString(DeviceType Type) {
switch (Type) {
case DeviceType::UNKNOWN:
Expand Down
14 changes: 13 additions & 1 deletion unified-runtime/source/loader/layers/sanitizer/tsan/tsan_interceptor.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,19 @@ ur_result_t TsanInterceptor::insertProgram(ur_program_handle_t Program) {
if (m_ProgramMap.find(Program) != m_ProgramMap.end()) {
return UR_RESULT_SUCCESS;
}
auto CI = getContextInfo(GetContext(Program));
auto DI = getDeviceInfo(CI->DeviceList[0]);
ur_specialization_constant_info_t SpecConstantInfo{
SpecConstantDeviceTyID, sizeof(DeviceType), &DI->Type};
ur_result_t URes =
getContext()->urDdiTable.Program.pfnSetSpecializationConstants(
Program, 1, &SpecConstantInfo);
if (URes != UR_RESULT_SUCCESS) {
UR_LOG_L(getContext()->logger, DEBUG,
"Set specilization constant for device type failed: {}, the "
"program may not be sanitized or is created from binary.",
URes);
}
m_ProgramMap.emplace(Program, Program);
return UR_RESULT_SUCCESS;
}
Expand Down Expand Up @@ -425,7 +438,6 @@ ur_result_t TsanInterceptor::prepareLaunch(std::shared_ptr<ContextInfo> &,
// Prepare launch info data
LaunchInfo.Data.Host.GlobalShadowOffset = DI->Shadow->ShadowBegin;
LaunchInfo.Data.Host.GlobalShadowOffsetEnd = DI->Shadow->ShadowEnd;
LaunchInfo.Data.Host.DeviceTy = DI->Type;
LaunchInfo.Data.Host.Debug = getContext()->Options.Debug ? 1 : 0;

const size_t *LocalWorkSize = LaunchInfo.LocalWorkSize.data();
Expand Down
2 changes: 0 additions & 2 deletions unified-runtime/source/loader/layers/sanitizer/tsan/tsan_libdevice.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,6 @@ struct TsanRuntimeData {
// The last one is to record global state
VectorClock Clock[kThreadSlotCount + 1];

DeviceType DeviceTy = DeviceType::UNKNOWN;

uint32_t Debug = 0;

int Lock = 0;
Expand Down
Loading