[ASan] Process functions in Asan module pass

[kstoimenov]

Summary

This came up as recommendation while reviewing D112098.

[kstoimenov]

Removed unrelated files.

[kstoimenov]

Reverted pass builder.

[kstoimenov]

Added AddressSanitizerOptions back.

[kstoimenov]

Tests are not passing. Hold off the review.

[vitalybuka]

In D112732#3094158, @kstoimenov wrote:

Tests are not passing. Hold off the review.

Yep, removed FUNCTION_PASS_WITH_PARAMS("asan", must affect some tests

llvm/include/llvm/Transforms/Instrumentation/AddressSanitizer.h

113 ↗

(On Diff #383072)

please run check-all
it was used in as well llvm-project/llvm/tools/opt/NewPMDriver.cpp

llvm/lib/Passes/PassRegistry.def

396 ↗

(On Diff #383072)

you should also rename MODULE_PASS_WITH_PARAMS("asan-module", to just MODULE_PASS_WITH_PARAMS("asan",

[kstoimenov]

Fixed test failures and crashes.

[kstoimenov]

llvm/lib/Transforms/Instrumentation/AddressSanitizer.cpp

1315

At first I had module sanitizer run first, but some tests failed. Is it possible that the function pass has some side effects, which are used by the module pass?

2857

This was a pain to figure out. Maybe we should apply the same check in HWAsan?

[kstoimenov]

Fixed remaing 2 tests.

[vitalybuka]

llvm/include/llvm/Transforms/Instrumentation/AddressSanitizer.h

92 ↗

(On Diff #383819)

Why do we need to remove AddressSanitizerOptions?

llvm/lib/Passes/PassRegistry.def

139 ↗

(On Diff #383819)

And I guess now we need to use parseASanPassOptions here?

396 ↗

(On Diff #383072)

I still see asan-module here

[kstoimenov]

Update after discussing with vitalybuka@.

[kstoimenov]

llvm/include/llvm/Transforms/Instrumentation/AddressSanitizer.h

92 ↗

(On Diff #383819)

Adding it back in as discussed offline.

llvm/lib/Passes/PassRegistry.def

139 ↗

(On Diff #383819)

I must have reverted by an accident. Should be done now.

146 ↗

(On Diff #383819)

I think parseModuleAddressSanitizerPassOptions does exactly the same thing as parseASanPassOptions, which is to look for the "kernel" param.

[vitalybuka]

rebase

[vitalybuka]

Lets keep AddressSanitizerPass for a while, we don't have to remove it in the same patch

llvm/lib/Transforms/Instrumentation/AddressSanitizer.cpp

1315

That's OK.

NewPMDriver.cpp was wrong, BackendUtil.cpp was wrong

if we put module in-front of function the following with disable globals instrumentation:

if (G && (!ClInitializers || GlobalIsLinkerInitialized(G)) &&
       isSafeAccess(ObjSizeVis, Addr, O.TypeSize)) {

2857

I looks like should be the first "if" in the function

[kstoimenov]

Moved module instumentation back ahead of function instrumentation.

[kstoimenov]

Moved empty check to the top of the function.

[kstoimenov]

Moved module after function.

[kstoimenov]

After rebase.

[rupprecht]

clang/lib/CodeGen/BackendUtil.cpp

1190

I'm seeing build errors here, and I'm not sure what this is supposed to be?

/home/rupprecht/src/llvm-project/clang/lib/CodeGen/BackendUtil.cpp:1189:37: error: use of undeclared identifier 'ModuleUseAfterScope'; did you mean 'UseAfterScope'?
            CompileKernel, Recover, ModuleUseAfterScope, UseOdrIndicator,
                                    ^~~~~~~~~~~~~~~~~~~
                                    UseAfterScope

https://buildkite.com/llvm-project/upstream-bazel-rbe/builds/11193#bbebbf99-a2c1-4959-b6f7-f7fb816591c0

[rupprecht]

clang/lib/CodeGen/BackendUtil.cpp

1190

I see it was reverted already, sorry!

[kstoimenov]

clang/lib/CodeGen/BackendUtil.cpp

1190

Sorry about breaking the build. I can't understand how my local tests passed. Functions with a long list of boolean params are so error prone. The downside of not using the builder pattern :-(

[vitalybuka]

rebase

[kstoimenov]

After merging D113072.

[aeubanks]

can we rename "asan-module" to "asan" after this change? and remove the extra "asan-pipeline"/"asan-function-pipeline" parsing callbacks in NewPMDriver.cpp? and previously we had -passes=require<asan-globals-md> because a function pass couldn't invoke a module analysis, but that's no longer relevant, so cleaning those up from RUN lines would also be good

[vitalybuka]

llvm/lib/Transforms/Instrumentation/AddressSanitizer.cpp

1315

Fixing typo in the comment.

NewPMDriver.cpp was wrong, BackendUtil.cpp was wrong

NewPMDriver.cpp was correct, BackendUtil.cpp was wrong

[vitalybuka]

In D112732#3107387, @aeubanks wrote:

can we rename "asan-module" to "asan" after this change? and remove the extra "asan-pipeline"/"asan-function-pipeline" parsing callbacks in NewPMDriver.cpp? and previously we had -passes=require<asan-globals-md> because a function pass couldn't invoke a module analysis, but that's no longer relevant, so cleaning those up from RUN lines would also be good

That was idea, but I changed my mind and recommended to do that in a separate patch.

clang/lib/CodeGen/BackendUtil.cpp

auto ASanPass = [&](SanitizerMask Mask, bool CompileKernel) {
             CodeGenOpts.getSanitizeAddressDtor();
         AddressSanitizerOptions Opts;
         Opts.CompileKernel = CompileKernel;
         Opts.Recover = CodeGenOpts.SanitizeRecover.has(Mask);
         Opts.UseAfterScope = CodeGenOpts.SanitizeAddressUseAfterScope;
         Opts.UseAfterReturn = CodeGenOpts.getSanitizeAddressUseAfterReturn();
         MPM.addPass(RequireAnalysisPass<ASanGlobalsMetadataAnalysis, Module>());
         MPM.addPass(ModuleAddressSanitizerPass(
             Opts, UseGlobalGC, UseOdrIndicator, DestructorKind));
-        MPM.addPass(
-            createModuleToFunctionPassAdaptor(AddressSanitizerPass(Opts)));
       }
     };
     ASanPass(SanitizerKind::Address, false);
     ASanPass(SanitizerKind::KernelAddress, true);
 
     auto HWASanPass = [&](SanitizerMask Mask, bool CompileKernel) {
       if (LangOpts.Sanitize.has(Mask)) {
         bool Recover = CodeGenOpts.SanitizeRecover.has(Mask);

llvm/lib/Transforms/Instrumentation/AddressSanitizer.cpp

 
 ModuleAddressSanitizerPass::ModuleAddressSanitizerPass(
     const AddressSanitizerOptions &Options, bool UseGlobalGC,
     bool UseOdrIndicator, AsanDtorKind DestructorKind)
     : Options(Options), UseGlobalGC(UseGlobalGC),
       UseOdrIndicator(UseOdrIndicator), DestructorKind(DestructorKind) {}
 
 PreservedAnalyses ModuleAddressSanitizerPass::run(Module &M,
-                                                  AnalysisManager<Module> &AM) {
-  GlobalsMetadata &GlobalsMD = AM.getResult<ASanGlobalsMetadataAnalysis>(M);
-  ModuleAddressSanitizer Sanitizer(M, &GlobalsMD, Options.CompileKernel,
+                                                  ModuleAnalysisManager &MAM) {
+  GlobalsMetadata &GlobalsMD = MAM.getResult<ASanGlobalsMetadataAnalysis>(M);
+  ModuleAddressSanitizer ModuleSanitizer(M, &GlobalsMD, Options.CompileKernel,
                                          Options.Recover, UseGlobalGC,
                                          UseOdrIndicator, DestructorKind);
-  if (Sanitizer.instrumentModule(M))
-    return PreservedAnalyses::none();
-  return PreservedAnalyses::all();
+  bool Modified = false;
+  auto &FAM = MAM.getResult<FunctionAnalysisManagerModuleProxy>(M).getManager();
+  for (Function &F : M) {
+    AddressSanitizer FunctionSanitizer(M, &GlobalsMD, Options.CompileKernel,
+                                       Options.Recover, Options.UseAfterScope,
+                                       Options.UseAfterReturn);
+    const TargetLibraryInfo &TLI = FAM.getResult<TargetLibraryAnalysis>(F);
+    Modified |= FunctionSanitizer.instrumentFunction(F, &TLI);
+  }
+  Modified |= ModuleSanitizer.instrumentModule(M);
+  return Modified ? PreservedAnalyses::none() : PreservedAnalyses::all();
 }
 
 INITIALIZE_PASS(ASanGlobalsMetadataWrapperPass, "asan-globals-md",
                 "Read metadata to mark which globals should be instrumented "
                 "when running ASan.",
                 false, true)
 
 char AddressSanitizerLegacyPass::ID = 0;
bool ShouldInstrument =
       ClDebugMin < 0 || ClDebugMax < 0 ||
       (Instrumented >= ClDebugMin && Instrumented <= ClDebugMax);
   Instrumented++;
   return !ShouldInstrument;
 }
 
 bool AddressSanitizer::instrumentFunction(Function &F,
                                           const TargetLibraryInfo *TLI) {
+  if (F.empty())
+    return false;
   if (F.getLinkage() == GlobalValue::AvailableExternallyLinkage) return false;
   if (!ClDebugFunc.empty() && ClDebugFunc == F.getName()) return false;
   if (F.getName().startswith("__asan_")) return false;
 
   bool FunctionModified = false;
 
   // If needed, insert __asan_init before checking for SanitizeAddress attr.
   // This function needs to be called even if the function body is not
   // instrumented.
   if (maybeInsertAsanInitAtFunctionEntry(F))
     FunctionModified = true;
 

llvm/test/Instrumentation/SanitizerCoverage/tracing-comdat.ll

 ; Test that the coverage guards have proper comdat
 ; Make sure asan does not instrument __sancov_gen_
 
 ; RUN: opt < %s -passes='module(sancov-module)' -sanitizer-coverage-level=3 -sanitizer-coverage-trace-pc-guard  -S  | FileCheck %s
-; RUN: opt < %s -passes='module(require<asan-globals-md>,sancov-module,asan-module),function(asan)' -sanitizer-coverage-level=3 -sanitizer-coverage-trace-pc-guard  -S  | FileCheck %s
+; RUN: opt < %s -passes='module(require<asan-globals-md>,sancov-module,asan-module)' -sanitizer-coverage-level=3 -sanitizer-coverage-trace-pc-guard  -S  | FileCheck %s
 target datalayout = "e-m:e-i64:64-f80:128-n8:16:32:64-S128"
 target triple = "x86_64-unknown-linux-gnu"
 $Foo = comdat any
 ; Function Attrs: uwtable
 define linkonce_odr void @Foo() comdat {
 entry:
   ret void
 }
 
 define linkonce_odr void @Bar() {
 entry:
   ret void
 }
 
 ; CHECK: @__sancov_gen_ = private global [1 x i32] zeroinitializer, section "__sancov_guards", comdat($Foo)
 ; CHECK: @__sancov_gen_.1 = private global [1 x i32] zeroinitializer, section "__sancov_guards"

llvm/tools/opt/NewPMDriver.cpp

PB.registerPipelineParsingCallback(
       });
   PB.registerPipelineParsingCallback(
       [](StringRef Name, ModulePassManager &MPM,
          ArrayRef<PassBuilder::PipelineElement>) {
         AddressSanitizerOptions Opts;
         if (Name == "asan-pipeline") {
           MPM.addPass(
               RequireAnalysisPass<ASanGlobalsMetadataAnalysis, Module>());
-          MPM.addPass(
-              createModuleToFunctionPassAdaptor(AddressSanitizerPass(Opts)));
           MPM.addPass(ModuleAddressSanitizerPass(Opts));
           return true;
         } else if (Name == "asan-function-pipeline") {
           MPM.addPass(
               RequireAnalysisPass<ASanGlobalsMetadataAnalysis, Module>());
           MPM.addPass(
               createModuleToFunctionPassAdaptor(AddressSanitizerPass(Opts)));
           return true;