Unverified Commit d860ea96 authored by Orlando Cazalet-Hyams's avatar Orlando Cazalet-Hyams Committed by GitHub
Browse files

[HWASAN] Update dbg.assign intrinsics in HWAsan pass (#79864) 

llvm.dbg.assign intrinsics have 2 {value, expression} pairs; fix hwasan to
update the second expression.

Fixes #76545. This is #78606 rebased and with the addition of DPValue handling.
Note the addition of --try-experimental-debuginfo-iterators in the tests and
some shuffling of code in MemoryTaggingSupport.cpp.
parent 5b015229

llvm/lib/IR/DebugInfo.cpp

+0 −4
Original line number Diff line number Diff line
@@ -2214,10 +2214,6 @@ bool AssignmentTrackingPass::runOnFunction(Function &F) { 
  if (F.hasFnAttribute(Attribute::OptimizeNone))

    return /*Changed*/ false;



  // FIXME: https://github.com/llvm/llvm-project/issues/76545

  if (F.hasFnAttribute(Attribute::SanitizeHWAddress))

    return /*Changed*/ false;



  bool Changed = false;

  auto *DL = &F.getParent()->getDataLayout();

  // Collect a map of {backing storage : dbg.declares} (currently "backing

llvm/lib/Transforms/Instrumentation/HWAddressSanitizer.cpp

+13 −0
Original line number Diff line number Diff line
@@ -1371,6 +1371,14 @@ static bool isLifetimeIntrinsic(Value *V) { 
  return II && II->isLifetimeStartOrEnd();

}



static DbgAssignIntrinsic *DynCastToDbgAssign(DbgVariableIntrinsic *DVI) {

  return dyn_cast<DbgAssignIntrinsic>(DVI);

}



static DPValue *DynCastToDbgAssign(DPValue *DPV) {

  return DPV->isDbgAssign() ? DPV : nullptr;

}



bool HWAddressSanitizer::instrumentStack(memtag::StackInfo &SInfo,

                                         Value *StackTag, Value *UARTag,

                                         const DominatorTree &DT,
@@ -1437,6 +1445,11 @@ bool HWAddressSanitizer::instrumentStack(memtag::StackInfo &SInfo, 
        if (DPtr->getVariableLocationOp(LocNo) == AI)

          DPtr->setExpression(DIExpression::appendOpsToArg(

              DPtr->getExpression(), NewOps, LocNo));

      if (auto *DAI = DynCastToDbgAssign(DPtr)) {

        if (DAI->getAddress() == AI)

          DAI->setAddressExpression(DIExpression::prependOpcodes(

              DAI->getAddressExpression(), NewOps));

      }

    };



    llvm::for_each(Info.DbgVariableIntrinsics, AnnotateDbgRecord);

llvm/lib/Transforms/Utils/MemoryTaggingSupport.cpp

+14 −7
Original line number Diff line number Diff line
@@ -110,18 +110,22 @@ Instruction *getUntagLocationIfFunctionExit(Instruction &Inst) { 
}



void StackInfoBuilder::visit(Instruction &Inst) {

  // Check for non-intrinsic debug-info records.

  // Visit non-intrinsic debug-info records attached to Inst.

  for (auto &DPV : Inst.getDbgValueRange()) {

    for (Value *V : DPV.location_ops()) {

    auto AddIfInteresting = [&](Value *V) {

      if (auto *AI = dyn_cast_or_null<AllocaInst>(V)) {

        if (!isInterestingAlloca(*AI))

          continue;

          return;

        AllocaInfo &AInfo = Info.AllocasToInstrument[AI];

        auto &DPVVec = AInfo.DbgVariableRecords;

        if (DPVVec.empty() || DPVVec.back() != &DPV)

          DPVVec.push_back(&DPV);

      }

    }

    };



    for_each(DPV.location_ops(), AddIfInteresting);

    if (DPV.isDbgAssign())

      AddIfInteresting(DPV.getAddress());

  }



  if (CallInst *CI = dyn_cast<CallInst>(&Inst)) {
@@ -152,16 +156,19 @@ void StackInfoBuilder::visit(Instruction &Inst) { 
    return;

  }

  if (auto *DVI = dyn_cast<DbgVariableIntrinsic>(&Inst)) {

    for (Value *V : DVI->location_ops()) {

    auto AddIfInteresting = [&](Value *V) {

      if (auto *AI = dyn_cast_or_null<AllocaInst>(V)) {

        if (!isInterestingAlloca(*AI))

          continue;

          return;

        AllocaInfo &AInfo = Info.AllocasToInstrument[AI];

        auto &DVIVec = AInfo.DbgVariableIntrinsics;

        if (DVIVec.empty() || DVIVec.back() != DVI)

          DVIVec.push_back(DVI);

      }

    }

    };

    for_each(DVI->location_ops(), AddIfInteresting);

    if (auto *DAI = dyn_cast<DbgAssignIntrinsic>(DVI))

      AddIfInteresting(DAI->getAddress());

  }



  Instruction *ExitUntag = getUntagLocationIfFunctionExit(Inst);

llvm/test/CodeGen/AArch64/dbg-assign-tag-offset-mix-loc.ll

0 → 100644
+72 −0
Original line number Diff line number Diff line 
; RUN: llc -filetype=obj -o - %s | llvm-dwarfdump - | FileCheck %s

; RUN: llc --try-experimental-debuginfo-iterators -filetype=obj -o - %s | llvm-dwarfdump - | FileCheck %s



;; Similar to dbg-assign-tag-offset.ll except the variable 'x' has been removed

;; and 'y' has an implicit location range as well as stack location range

;; (according to the hand-modified debug info -- see the dbg.value).



target datalayout = "e-m:e-i8:8:32-i16:16:32-i64:64-i128:128-n32:64-S128"

target triple = "aarch64-unknown-linux-android24"



; CHECK:      DW_TAG_variable

; CHECK-NOT:  DW_TAG

; CHECK:        DW_AT_LLVM_tag_offset (0x80)

; CHECK-NEXT:   DW_AT_name    ("y")



define dso_local void @f() !dbg !14 {

  %1 = alloca i32, align 4, !DIAssignID !31

  %2 = alloca i32, align 4, !DIAssignID !32

  call void @llvm.dbg.assign(metadata i1 undef, metadata !20, metadata !DIExpression(), metadata !32, metadata ptr %2, metadata !DIExpression(DW_OP_LLVM_tag_offset, 128)), !dbg !22

  call void @llvm.dbg.value(metadata i32 2, metadata !20, metadata !DIExpression()), !dbg !22

  call void @use(ptr null), !dbg !28

  store i32 1, ptr %2, align 4, !dbg !23, !tbaa !24, !DIAssignID !33

  call void @llvm.dbg.assign(metadata i32 1, metadata !20, metadata !DIExpression(), metadata !33, metadata ptr %2, metadata !DIExpression(DW_OP_LLVM_tag_offset, 128)), !dbg !22

  call void @use(ptr nonnull %1), !dbg !28

  call void @use(ptr nonnull %2), !dbg !29

  ret void, !dbg !30

}



declare !dbg !5 void @use(ptr)



declare void @llvm.dbg.value(metadata, metadata, metadata)

declare void @llvm.dbg.assign(metadata, metadata, metadata, metadata, metadata, metadata)



!llvm.dbg.cu = !{!0}

!llvm.module.flags = !{!8, !9, !10, !11, !12, !34}

!llvm.ident = !{!13}



!0 = distinct !DICompileUnit(language: DW_LANG_C_plus_plus_14, file: !1, producer: "clang version 10.0.0", isOptimized: true, runtimeVersion: 0, emissionKind: FullDebug, enums: !2, retainedTypes: !3, nameTableKind: None)

!1 = !DIFile(filename: "dbg.cc", directory: "/tmp")

!2 = !{}

!3 = !{!4, !5}

!4 = !DIDerivedType(tag: DW_TAG_pointer_type, baseType: null, size: 64)

!5 = !DISubprogram(name: "use", scope: !1, file: !1, line: 2, type: !6, flags: DIFlagPrototyped, spFlags: DISPFlagOptimized, retainedNodes: !2)

!6 = !DISubroutineType(types: !7)

!7 = !{null, !4}

!8 = !{i32 7, !"Dwarf Version", i32 4}

!9 = !{i32 2, !"Debug Info Version", i32 3}

!10 = !{i32 1, !"wchar_size", i32 4}

!11 = !{i32 7, !"PIC Level", i32 2}

!12 = !{i32 7, !"PIE Level", i32 2}

!13 = !{!"clang version 10.0.0"}

!14 = distinct !DISubprogram(name: "f", scope: !1, file: !1, line: 4, type: !15, scopeLine: 4, flags: DIFlagPrototyped | DIFlagAllCallsDescribed, spFlags: DISPFlagDefinition | DISPFlagOptimized, unit: !0, retainedNodes: !17)

!15 = !DISubroutineType(types: !16)

!16 = !{null}

!17 = !{!18, !20}

!18 = !DILocalVariable(name: "x", scope: !14, file: !1, line: 5, type: !19)

!19 = !DIBasicType(name: "int", size: 32, encoding: DW_ATE_signed)

!20 = !DILocalVariable(name: "y", scope: !14, file: !1, line: 5, type: !19)

!21 = !DILocation(line: 5, column: 3, scope: !14)

!22 = !DILocation(line: 0, scope: !14)

!23 = !DILocation(line: 5, column: 10, scope: !14)

!24 = !{!25, !25, i64 0}

!25 = !{!"int", !26, i64 0}

!26 = !{!"omnipotent char", !27, i64 0}

!27 = !{!"Simple C++ TBAA"}

!28 = !DILocation(line: 6, column: 3, scope: !14)

!29 = !DILocation(line: 7, column: 3, scope: !14)

!30 = !DILocation(line: 8, column: 1, scope: !14)

!31 = distinct !DIAssignID()

!32 = distinct !DIAssignID()

!33 = distinct !DIAssignID()

!34 = !{i32 7, !"debug-info-assignment-tracking", i1 true}

llvm/test/CodeGen/AArch64/dbg-assign-tag-offset.ll

0 → 100644
+76 −0
Original line number Diff line number Diff line 
; RUN: llc -filetype=obj -o - %s | llvm-dwarfdump - | FileCheck %s

; RUN: llc --try-experimental-debuginfo-iterators -filetype=obj -o - %s | llvm-dwarfdump - | FileCheck %s



;; Copied from dbg-value-tag-offset.ll. Check that variables with locations

;; tracked with dbg.assigns with DW_OP_LLVM_TAG_offset operators in their

;; expressions get a DW_AT_LLVM_tag_offset attribute on their DIE.



target datalayout = "e-m:e-i8:8:32-i16:16:32-i64:64-i128:128-n32:64-S128"

target triple = "aarch64-unknown-linux-android24"



; CHECK:      DW_TAG_variable

; CHECK-NOT:  DW_TAG

; CHECK:        DW_AT_LLVM_tag_offset (0x00)

; CHECK-NEXT:   DW_AT_name    ("x")



; CHECK:      DW_TAG_variable

; CHECK-NOT:  DW_TAG

; CHECK:        DW_AT_LLVM_tag_offset (0x80)

; CHECK-NEXT:   DW_AT_name    ("y")



define dso_local void @f() !dbg !14 {

  %1 = alloca i32, align 4, !DIAssignID !31

  call void @llvm.dbg.assign(metadata i1 undef, metadata !18, metadata !DIExpression(), metadata !31, metadata ptr %1, metadata !DIExpression(DW_OP_LLVM_tag_offset, 0)), !dbg !22

  %2 = alloca i32, align 4, !DIAssignID !32

  call void @llvm.dbg.assign(metadata i1 undef, metadata !20, metadata !DIExpression(), metadata !32, metadata ptr %2, metadata !DIExpression(DW_OP_LLVM_tag_offset, 128)), !dbg !22

  store i32 1, ptr %2, align 4, !dbg !23, !tbaa !24, !DIAssignID !33

  call void @llvm.dbg.assign(metadata i32 1, metadata !20, metadata !DIExpression(), metadata !33, metadata ptr %2, metadata !DIExpression(DW_OP_LLVM_tag_offset, 128)), !dbg !22

  call void @use(ptr nonnull %1), !dbg !28

  call void @use(ptr nonnull %2), !dbg !29

  ret void, !dbg !30

}



declare !dbg !5 void @use(ptr)



declare void @llvm.dbg.value(metadata, metadata, metadata)

declare void @llvm.dbg.assign(metadata, metadata, metadata, metadata, metadata, metadata)



!llvm.dbg.cu = !{!0}

!llvm.module.flags = !{!8, !9, !10, !11, !12, !34}

!llvm.ident = !{!13}



!0 = distinct !DICompileUnit(language: DW_LANG_C_plus_plus_14, file: !1, producer: "clang version 10.0.0", isOptimized: true, runtimeVersion: 0, emissionKind: FullDebug, enums: !2, retainedTypes: !3, nameTableKind: None)

!1 = !DIFile(filename: "dbg.cc", directory: "/tmp")

!2 = !{}

!3 = !{!4, !5}

!4 = !DIDerivedType(tag: DW_TAG_pointer_type, baseType: null, size: 64)

!5 = !DISubprogram(name: "use", scope: !1, file: !1, line: 2, type: !6, flags: DIFlagPrototyped, spFlags: DISPFlagOptimized, retainedNodes: !2)

!6 = !DISubroutineType(types: !7)

!7 = !{null, !4}

!8 = !{i32 7, !"Dwarf Version", i32 4}

!9 = !{i32 2, !"Debug Info Version", i32 3}

!10 = !{i32 1, !"wchar_size", i32 4}

!11 = !{i32 7, !"PIC Level", i32 2}

!12 = !{i32 7, !"PIE Level", i32 2}

!13 = !{!"clang version 10.0.0"}

!14 = distinct !DISubprogram(name: "f", scope: !1, file: !1, line: 4, type: !15, scopeLine: 4, flags: DIFlagPrototyped | DIFlagAllCallsDescribed, spFlags: DISPFlagDefinition | DISPFlagOptimized, unit: !0, retainedNodes: !17)

!15 = !DISubroutineType(types: !16)

!16 = !{null}

!17 = !{!18, !20}

!18 = !DILocalVariable(name: "x", scope: !14, file: !1, line: 5, type: !19)

!19 = !DIBasicType(name: "int", size: 32, encoding: DW_ATE_signed)

!20 = !DILocalVariable(name: "y", scope: !14, file: !1, line: 5, type: !19)

!21 = !DILocation(line: 5, column: 3, scope: !14)

!22 = !DILocation(line: 0, scope: !14)

!23 = !DILocation(line: 5, column: 10, scope: !14)

!24 = !{!25, !25, i64 0}

!25 = !{!"int", !26, i64 0}

!26 = !{!"omnipotent char", !27, i64 0}

!27 = !{!"Simple C++ TBAA"}

!28 = !DILocation(line: 6, column: 3, scope: !14)

!29 = !DILocation(line: 7, column: 3, scope: !14)

!30 = !DILocation(line: 8, column: 1, scope: !14)

!31 = distinct !DIAssignID()

!32 = distinct !DIAssignID()

!33 = distinct !DIAssignID()

!34 = !{i32 7, !"debug-info-assignment-tracking", i1 true}