[DeviceSanitizer] Support "-fsanitize-ignorelist=" to disable sanitizing on some of kernels (#15294)

UR: oneapi-src/unified-runtime#2055

We reuse `-fsanitize-ignorelist=` to support kernel filtering.

Usage: https://clang.llvm.org/docs/SanitizerSpecialCaseList.html

We implement this feature by adding a device global
"__AsanKernelMetadata" which records the sanitized kernel name, so that
we can check if we need specially handle kernel in UR.

---------

Co-authored-by: Callum Fare <[email protected]>

Author: AllanZyne

clang/lib/Driver/OffloadBundler.cpp

@@ -687,12 +687,12 @@ class ObjectFileHandler final : public FileHandler {
         if (Error Err = Symbol.printName(NameOS))
           return std::move(Err);
 
-        // If we are dealing with a bitcode file do not add special globals
-        // llvm.used and llvm.compiler.used and __AsanDeviceGlobalMetadata to
+        // If we are dealing with a bitcode file do not add special globals to
         // the list of defined symbols.
         if (SF->isIR() &&
             (Name == "llvm.used" || Name == "llvm.compiler.used" ||
-             Name == "__AsanDeviceGlobalMetadata"))
+             Name == "__AsanDeviceGlobalMetadata" ||
+             Name == "__AsanKernelMetadata"))
           continue;
 
         // Add symbol name with the target prefix to the buffer.

clang/lib/Driver/SanitizerArgs.cpp

@@ -1197,6 +1197,9 @@ void SanitizerArgs::addArgs(const ToolChain &TC, const llvm::opt::ArgList &Args,
 
       CmdArgs.push_back("-mllvm");
       CmdArgs.push_back("-asan-mapping-scale=4");
+
+      addSpecialCaseListOpt(Args, CmdArgs,
+                            "-fsanitize-ignorelist=", UserIgnorelistFiles);
     }
     return;
   }

libdevice/sanitizer/asan_rtl.cpp

@@ -665,11 +665,16 @@ constexpr size_t AlignMask(size_t n) { return n - 1; }
 ///
 /// ASAN Load/Store Report Built-ins
 ///
+/// NOTE:
+///   if __AsanLaunchInfo equals 0, the sanitizer is disabled for this launch
+///
 
 #define ASAN_REPORT_ERROR_BASE(type, is_write, size, as)                       \
   DEVICE_EXTERN_C_NOINLINE void __asan_##type##size##_as##as(                  \
       uptr addr, const char __SYCL_CONSTANT__ *file, uint32_t line,            \
       const char __SYCL_CONSTANT__ *func) {                                    \
+    if (!__AsanLaunchInfo)                                                     \
+      return;                                                                  \
     if (addr & AlignMask(size)) {                                              \
       __asan_report_misalign_error(addr, as, size, is_write, addr, file, line, \
                                    func);                                      \
@@ -682,6 +687,8 @@ constexpr size_t AlignMask(size_t n) { return n - 1; }
   DEVICE_EXTERN_C_NOINLINE void __asan_##type##size##_as##as##_noabort(        \
       uptr addr, const char __SYCL_CONSTANT__ *file, uint32_t line,            \
       const char __SYCL_CONSTANT__ *func) {                                    \
+    if (!__AsanLaunchInfo)                                                     \
+      return;                                                                  \
     if (addr & AlignMask(size)) {                                              \
       __asan_report_misalign_error(addr, as, size, is_write, addr, file, line, \
                                    func, true);                                \
@@ -714,6 +721,8 @@ ASAN_REPORT_ERROR(store, true, 16)
   DEVICE_EXTERN_C_NOINLINE void __asan_##type##N_as##as(                       \
       uptr addr, size_t size, const char __SYCL_CONSTANT__ *file,              \
       uint32_t line, const char __SYCL_CONSTANT__ *func) {                     \
+    if (!__AsanLaunchInfo)                                                     \
+      return;                                                                  \
     if (auto poisoned_addr = __asan_region_is_poisoned(addr, as, size)) {      \
       __asan_report_access_error(addr, as, size, is_write, poisoned_addr,      \
                                  file, line, func);                            \
@@ -722,6 +731,8 @@ ASAN_REPORT_ERROR(store, true, 16)
   DEVICE_EXTERN_C_NOINLINE void __asan_##type##N_as##as##_noabort(             \
       uptr addr, size_t size, const char __SYCL_CONSTANT__ *file,              \
       uint32_t line, const char __SYCL_CONSTANT__ *func) {                     \
+    if (!__AsanLaunchInfo)                                                     \
+      return;                                                                  \
     if (auto poisoned_addr = __asan_region_is_poisoned(addr, as, size)) {      \
       __asan_report_access_error(addr, as, size, is_write, poisoned_addr,      \
                                  file, line, func, true);                      \
@@ -743,6 +754,9 @@ ASAN_REPORT_ERROR_N(store, true)
 ///
 
 DEVICE_EXTERN_C_NOINLINE uptr __asan_mem_to_shadow(uptr ptr, uint32_t as) {
+  if (!__AsanLaunchInfo)
+    return 0;
+
   return MemToShadow(ptr, as);
 }
 
@@ -756,6 +770,9 @@ static __SYCL_CONSTANT__ const char __mem_set_shadow_local[] =
 DEVICE_EXTERN_C_NOINLINE void
 __asan_set_shadow_static_local(uptr ptr, size_t size,
                                size_t size_with_redzone) {
+  if (!__AsanLaunchInfo)
+    return;
+
   // Since ptr is aligned to ASAN_SHADOW_GRANULARITY,
   // if size != aligned_size, then the buffer tail of ptr is not aligned
   uptr aligned_size = RoundUpTo(size, ASAN_SHADOW_GRANULARITY);
@@ -795,6 +812,9 @@ static __SYCL_CONSTANT__ const char __mem_unpoison_shadow_static_local_end[] =
 DEVICE_EXTERN_C_NOINLINE void
 __asan_unpoison_shadow_static_local(uptr ptr, size_t size,
                                     size_t size_with_redzone) {
+  if (!__AsanLaunchInfo)
+    return;
+
   ASAN_DEBUG(__spirv_ocl_printf(__mem_unpoison_shadow_static_local_begin));
 
   auto shadow_begin = MemToShadow(ptr + size, ADDRESS_SPACE_LOCAL);
@@ -828,6 +848,9 @@ static __SYCL_CONSTANT__ const char __mem_report_arg_count_incorrect[] =
 
 DEVICE_EXTERN_C_NOINLINE void
 __asan_set_shadow_dynamic_local(uptr ptr, uint32_t num_args) {
+  if (!__AsanLaunchInfo)
+    return;
+
   ASAN_DEBUG(__spirv_ocl_printf(__mem_set_shadow_dynamic_local_begin));
 
   auto *launch_info = (__SYCL_GLOBAL__ const LaunchInfo *)__AsanLaunchInfo;
@@ -859,6 +882,9 @@ static __SYCL_CONSTANT__ const char __mem_unpoison_shadow_dynamic_local_end[] =
 
 DEVICE_EXTERN_C_NOINLINE void
 __asan_unpoison_shadow_dynamic_local(uptr ptr, uint32_t num_args) {
+  if (!__AsanLaunchInfo)
+    return;
+
   ASAN_DEBUG(__spirv_ocl_printf(__mem_unpoison_shadow_dynamic_local_begin));
 
   auto *launch_info = (__SYCL_GLOBAL__ const LaunchInfo *)__AsanLaunchInfo;
@@ -895,6 +921,9 @@ static __SYCL_CONSTANT__ const char __mem_set_shadow_private[] =
 
 DEVICE_EXTERN_C_NOINLINE void __asan_set_shadow_private(uptr begin, uptr size,
                                                         char val) {
+  if (!__AsanLaunchInfo)
+    return;
+
   ASAN_DEBUG(__spirv_ocl_printf(__mem_set_shadow_private_begin));
 
   auto *launch_info = (__SYCL_GLOBAL__ const LaunchInfo *)__AsanLaunchInfo;

llvm/include/llvm/SYCLLowerIR/AsanKernelMetadata.h

@@ -0,0 +1,23 @@
+//===-- AsanKernelMetadata.h - fix kernel medatadata for sanitizer ---===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+// This pass fixes attributes and metadata of the global variable
+// "__AsanKernelMetadata"
+//===----------------------------------------------------------------------===//
+
+#pragma once
+
+#include "llvm/IR/PassManager.h"
+
+namespace llvm {
+
+class AsanKernelMetadataPass : public PassInfoMixin<AsanKernelMetadataPass> {
+public:
+  PreservedAnalyses run(Module &M, ModuleAnalysisManager &MAM);
+};
+
+} // namespace llvm

llvm/lib/SYCLLowerIR/AsanKernelMetadata.cpp

@@ -0,0 +1,63 @@
+//===-- AsanKernelMetadata.cpp - fix kernel medatadata for sanitizer -===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+// This pass fixes attributes and metadata of global variable
+// "__AsanKernelMetadata".
+// We treat "__AsanKernelMetadata" as a device global variable, so that it can
+// be read by runtime.
+// "spirv.Decorations" is removed by llvm-link, so we add it here again.
+//===----------------------------------------------------------------------===//
+
+#include "llvm/SYCLLowerIR/AsanKernelMetadata.h"
+
+#include "llvm/IR/IRBuilder.h"
+
+#define DEBUG_TYPE "AsanKernelMetadata"
+
+using namespace llvm;
+
+namespace llvm {
+
+constexpr StringRef SPIRV_DECOR_MD_KIND = "spirv.Decorations";
+constexpr uint32_t SPIRV_HOST_ACCESS_DECOR = 6147;
+
+PreservedAnalyses AsanKernelMetadataPass::run(Module &M,
+                                              ModuleAnalysisManager &MAM) {
+  auto *KernelMetadata = M.getNamedGlobal("__AsanKernelMetadata");
+  if (!KernelMetadata) {
+    return PreservedAnalyses::all();
+  }
+
+  auto &DL = M.getDataLayout();
+  auto &Ctx = M.getContext();
+
+  // Fix attributes
+  KernelMetadata->addAttribute(
+      "sycl-device-global-size",
+      std::to_string(DL.getTypeAllocSize(KernelMetadata->getValueType())));
+
+  // Fix metadata
+  unsigned MDKindID = Ctx.getMDKindID(SPIRV_DECOR_MD_KIND);
+
+  SmallVector<Metadata *, 1> MDOps;
+
+  SmallVector<Metadata *, 3> MD;
+  auto *Ty = Type::getInt32Ty(Ctx);
+  MD.push_back(ConstantAsMetadata::get(
+      Constant::getIntegerValue(Ty, APInt(32, SPIRV_HOST_ACCESS_DECOR))));
+  MD.push_back(
+      ConstantAsMetadata::get(Constant::getIntegerValue(Ty, APInt(32, 0))));
+  MD.push_back(MDString::get(Ctx, "_Z20__AsanKernelMetadata"));
+
+  MDOps.push_back(MDNode::get(Ctx, MD));
+
+  KernelMetadata->addMetadata(MDKindID, *MDNode::get(Ctx, MDOps));
+
+  return PreservedAnalyses::none();
+}
+
+} // namespace llvm

llvm/lib/SYCLLowerIR/CMakeLists.txt

@@ -69,6 +69,7 @@ add_llvm_component_library(LLVMSYCLLowerIR
   SYCLPropagateJointMatrixUsage.cpp
   SYCLVirtualFunctionsAnalysis.cpp
   SYCLUtils.cpp
+  AsanKernelMetadata.cpp
 
   LocalAccessorToSharedMemory.cpp
   GlobalOffset.cpp

llvm/lib/SYCLLowerIR/ComputeModuleRuntimeInfo.cpp

@@ -46,16 +46,7 @@ getSYCLESIMDSplitStatusFromMetadata(const Module &M) {
 } // namespace
 
 bool isModuleUsingAsan(const Module &M) {
-  for (const auto &F : M) {
-    if (F.getCallingConv() != CallingConv::SPIR_KERNEL)
-      continue;
-    if (F.arg_size() == 0)
-      continue;
-    const auto *LastArg = F.getArg(F.arg_size() - 1);
-    if (LastArg->getName() == "__asan_launch")
-      return true;
-  }
-  return false;
+  return M.getNamedGlobal("__AsanKernelMetadata");
 }
 
 // This function traverses over reversed call graph by BFS algorithm.