[llvm] [RFC] Emit dwarf data for signature-changed or new functions (PR #157349)

via llvm-commits llvm-commits at lists.llvm.org
Thu Sep 18 12:59:45 PDT 2025


https://github.com/yonghong-song updated https://github.com/llvm/llvm-project/pull/157349

>From 9f187bfb497f1901b4821a2ae15f955d24972991 Mon Sep 17 00:00:00 2001
From: Yonghong Song <yonghong.song at linux.dev>
Date: Sat, 6 Sep 2025 23:09:01 -0700
Subject: [PATCH 1/2] [ArgPromotion] Add DW_CC_nocall to DISubprogram

ArgumentPromotion pass may change function signatures.
If this happens and debuginfo is enabled, let us add
DW_CC_nocall to debuginfo so it is clear that the function
signature has changed.

Also fix a ArgumentPromotion test due to adding DW_CC_nocall
to debuginfo.
---
 llvm/lib/Transforms/IPO/ArgumentPromotion.cpp | 9 +++++++++
 llvm/test/Transforms/ArgumentPromotion/dbg.ll | 6 +++++-
 2 files changed, 14 insertions(+), 1 deletion(-)

diff --git a/llvm/lib/Transforms/IPO/ArgumentPromotion.cpp b/llvm/lib/Transforms/IPO/ArgumentPromotion.cpp
index 262c902d40d2d..609e4f8e4d23a 100644
--- a/llvm/lib/Transforms/IPO/ArgumentPromotion.cpp
+++ b/llvm/lib/Transforms/IPO/ArgumentPromotion.cpp
@@ -50,6 +50,7 @@
 #include "llvm/IR/BasicBlock.h"
 #include "llvm/IR/CFG.h"
 #include "llvm/IR/Constants.h"
+#include "llvm/IR/DIBuilder.h"
 #include "llvm/IR/DataLayout.h"
 #include "llvm/IR/DerivedTypes.h"
 #include "llvm/IR/Dominators.h"
@@ -432,6 +433,14 @@ doPromotion(Function *F, FunctionAnalysisManager &FAM,
     PromoteMemToReg(Allocas, DT, &AC);
   }
 
+  // DW_CC_nocall to DISubroutineType to inform debugger that it may not be safe
+  // to call this function.
+  DISubprogram *SP = NF->getSubprogram();
+  if (SP) {
+    auto Temp = SP->getType()->cloneWithCC(llvm::dwarf::DW_CC_nocall);
+    SP->replaceType(MDNode::replaceWithPermanent(std::move(Temp)));
+  }
+
   return NF;
 }
 
diff --git a/llvm/test/Transforms/ArgumentPromotion/dbg.ll b/llvm/test/Transforms/ArgumentPromotion/dbg.ll
index 6a14facfb36a2..ce86aaa3884de 100644
--- a/llvm/test/Transforms/ArgumentPromotion/dbg.ll
+++ b/llvm/test/Transforms/ArgumentPromotion/dbg.ll
@@ -53,7 +53,11 @@ define void @caller(ptr %Y, ptr %P) {
 
 !0 = !{i32 2, !"Debug Info Version", i32 3}
 !1 = !DILocation(line: 8, scope: !2)
-!2 = distinct !DISubprogram(name: "test", file: !5, line: 3, isLocal: true, isDefinition: true, virtualIndex: 6, flags: DIFlagPrototyped, isOptimized: false, unit: !3, scopeLine: 3, scope: null)
+!2 = distinct !DISubprogram(name: "test", file: !5, line: 3, type: !7, isLocal: true, isDefinition: true, flags: DIFlagPrototyped, isOptimized: false, unit: !3, scopeLine: 3, scope: null)
 !3 = distinct !DICompileUnit(language: DW_LANG_C_plus_plus, producer: "clang version 3.5.0 ", isOptimized: false, emissionKind: LineTablesOnly, file: !5)
 !5 = !DIFile(filename: "test.c", directory: "")
 !6 = !DILocation(line: 9, scope: !2)
+!7 = !DISubroutineType(types: !8)
+!8 = !{null, !9}
+!9 = !DIDerivedType(tag: DW_TAG_pointer_type, baseType: !10)
+!10 = !DIBasicType(name: "int",  size: 32, encoding: DW_ATE_signed)

>From 73d1a30b286a6aac2c9bfdabd3559d4fa41bee0b Mon Sep 17 00:00:00 2001
From: Yonghong Song <yonghong.song at linux.dev>
Date: Tue, 29 Jul 2025 16:29:44 -0700
Subject: [PATCH 2/2] [LLVM] Emit dwarf data for changed-signature and new
 functions

Add a new pass EmitChangedFuncDebugInfo which will add dwarf for
additional functions including functions with signature change
and new functions.

The previous approach in [1] tries to add debuginfo for those
optimization passes which cause signature changes. Based on
discussion in [1], it is preferred to have a specific pass to
add debuginfo and later on dwarf generation can include those
new debuginfo.

The ultimate goal is to add new information to dwarf like below:

  DW_TAG_compile_unit
    ...
    // New functions with suffix
    DW_TAG_inlined_subroutine
      DW_AT_name      ("foo.1")
      DW_AT_type      (0x0000000000000091 "int")
      DW_AT_artificial (true)
      DW_AT_specificiation (original DW_TAG_subprogram)

      DW_TAG_formal_parameter
        DW_AT_name    ("b")
        DW_AT_type    (0x0000000000000091 "int")

      DW_TAG_formal_parameter
        DW_AT_name    ("c")
        DW_AT_type    (0x0000000000000095 "long")

    ...
    // Functions with changed signatures
    DW_TAG_inlined_subroutine
      DW_AT_name      ("bar")
      DW_AT_type      (0x0000000000000091 "int")
      DW_AT_artificial (true)
      DW_AT_specificiation (original DW_TAG_subprogram)

      DW_TAG_formal_parameter
        DW_AT_name    ("c")
        DW_AT_type    (0x0000000000000095 "unsigned int")

The new functions will not include those functions whose
return value is a struct/union or the function has
variable arguments.

In rare cases, if DIExpression is complex and not handled
by this pull request, the following dwarf entry will
be issued:
    // The DW_CC_nocall presence indicates such cases.
    DW_TAG_inlined_subroutine
      DW_AT_name      ("bar" or "bar.1")
      DW_AT_calling_convention        (DW_CC_nocall)
      DW_AT_artificial (true)
      DW_AT_specificiation (original DW_TAG_subprogram)

The parent tag of above DW_TAG_inlined_subroutine is
DW_TAG_compile_unit. This is a new feature for dwarf
so it won't cause issues with existing dwarf related tools.
Total three patterns are introduced as the above.
  . New functions with suffix, e.g., 'foo.1' or 'foo.llvm.<hash>'.
  . Functions with changed signature due to ArgumentPromotion
    or DeadArgumentElimination.
  . Functions the current implementation cannot get proper
    signature in which case, DW_CC_nocall is set to indicate
    signature is lost.

A special CompileUnit with file name "<artificial>" is created
to hold special DISubprograms for the above three kinds of functions.
During actual dwarf generation, these special DISubprograms
will turn to above to proper DW_TAG_inlined_subroutine tags.

The below are some discussions with not handled cases and
some other alternative things:
 (1) Current implementation only supports C language and only
     supports 64bit architecture as this particularly needed
     for linux kernel.
 (2) Currently, I am using a special CompileUnit "<artificial>" to hold
     newly created DISubprograms. But there is an alternative.
     For example, "llvm.dbg.cu" metadata is used to hold all CompileUnits.
     We could introduce "llvm.dbg.sp.extra" to hold all new
     DISubprograms instead of a new CompileUnit.

I have tested this patch set by building latest bpf-next linux kernel.
For no-lto case:
  65341 original number of functions
  1082  new functions with this patch
For thin-lto case:
  65595 original number of functions
  2484  new functions with this patch

For a particular linux kernel with bpf-next tree, There are no
new functions with DW_CC_nocall. That is, all new functions have
proper signatures.

The following are some examples with thinlto with generated dwarf:

  ...
  0x0001707f:   DW_TAG_inlined_subroutine
                  DW_AT_name      ("msr_build_context")
                  DW_AT_type      (0x00004163 "int")
                  DW_AT_artificial        (true)
                  DW_AT_specification     (0x0000440b "msr_build_context")

  0x0001708b:     DW_TAG_formal_parameter
                    DW_AT_name    ("msr_id")
                    DW_AT_type    (0x0000e55c "const u32 *")

  0x00017093:     NULL
  ...
  0x004225e5:   DW_TAG_inlined_subroutine
                  DW_AT_name      ("__die_body.llvm.14794269134614576759")
                  DW_AT_type      (0x00418a14 "int")
                  DW_AT_artificial        (true)
                  DW_AT_specification     (0x00422348 "__die_body")

  0x004225f1:     DW_TAG_formal_parameter
                    DW_AT_name    ("")
                    DW_AT_type    (0x004181f3 "const char *")

  0x004225f9:     DW_TAG_formal_parameter
                    DW_AT_name    ("")
                    DW_AT_type    (0x00419118 "pt_regs *")

  0x00422601:     DW_TAG_formal_parameter
                    DW_AT_name    ("")
                    DW_AT_type    (0x0041af2f "long")

  0x00422609:     NULL
  ...

  [1] https://github.com/llvm/llvm-project/pull/127855
---
 .../Utils/EmitChangedFuncDebugInfo.h          |  33 ++
 llvm/lib/CodeGen/AsmPrinter/DwarfDebug.cpp    |  66 +++
 llvm/lib/CodeGen/AsmPrinter/DwarfDebug.h      |   2 +
 llvm/lib/Passes/PassBuilder.cpp               |   1 +
 llvm/lib/Passes/PassBuilderPipelines.cpp      |   8 +-
 llvm/lib/Passes/PassRegistry.def              |   1 +
 llvm/lib/Transforms/Utils/CMakeLists.txt      |   1 +
 .../Utils/EmitChangedFuncDebugInfo.cpp        | 410 ++++++++++++++++++
 llvm/test/Other/new-pm-defaults.ll            |   2 +
 .../Other/new-pm-thinlto-postlink-defaults.ll |   1 +
 .../new-pm-thinlto-postlink-pgo-defaults.ll   |   1 +
 ...-pm-thinlto-postlink-samplepgo-defaults.ll |   1 +
 12 files changed, 525 insertions(+), 2 deletions(-)
 create mode 100644 llvm/include/llvm/Transforms/Utils/EmitChangedFuncDebugInfo.h
 create mode 100644 llvm/lib/Transforms/Utils/EmitChangedFuncDebugInfo.cpp

diff --git a/llvm/include/llvm/Transforms/Utils/EmitChangedFuncDebugInfo.h b/llvm/include/llvm/Transforms/Utils/EmitChangedFuncDebugInfo.h
new file mode 100644
index 0000000000000..8d569cd95d7f7
--- /dev/null
+++ b/llvm/include/llvm/Transforms/Utils/EmitChangedFuncDebugInfo.h
@@ -0,0 +1,33 @@
+//===- EmitChangedFuncDebugInfo.h - Emit Additional Debug Info -*- C++ --*-===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+//
+/// \file
+/// Emit debug info for changed or new funcs.
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_TRANSFORMS_UTILS_EMITCHANGEDFUNCDEBUGINFO_H
+#define LLVM_TRANSFORMS_UTILS_EMITCHANGEDFUNCDEBUGINFO_H
+
+#include "llvm/IR/PassManager.h"
+
+namespace llvm {
+
+class Module;
+
+// Pass that emits late dwarf.
+class EmitChangedFuncDebugInfoPass
+    : public PassInfoMixin<EmitChangedFuncDebugInfoPass> {
+public:
+  EmitChangedFuncDebugInfoPass() = default;
+
+  PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM);
+};
+
+} // end namespace llvm
+
+#endif // LLVM_TRANSFORMS_UTILS_EMITCHANGEDFUNCDEBUGINFO_H
diff --git a/llvm/lib/CodeGen/AsmPrinter/DwarfDebug.cpp b/llvm/lib/CodeGen/AsmPrinter/DwarfDebug.cpp
index 25e291c53ea6a..101f26bd5c760 100644
--- a/llvm/lib/CodeGen/AsmPrinter/DwarfDebug.cpp
+++ b/llvm/lib/CodeGen/AsmPrinter/DwarfDebug.cpp
@@ -1267,11 +1267,77 @@ void DwarfDebug::finishSubprogramDefinitions() {
   }
 }
 
+void DwarfDebug::addChangedSubprograms() {
+  // Generate additional dwarf for functions with signature changed.
+  DICompileUnit *ExtraCU = nullptr;
+  for (DICompileUnit *CUNode : MMI->getModule()->debug_compile_units()) {
+    if (CUNode->getFile()->getFilename() == "<artificial>") {
+      ExtraCU = CUNode;
+      break;
+    }
+  }
+  if (!ExtraCU)
+    return;
+
+  llvm::DebugInfoFinder DIF;
+  DIF.processModule(*MMI->getModule());
+  for (auto *ExtraSP : DIF.subprograms()) {
+    if (ExtraSP->getUnit() != ExtraCU)
+      continue;
+
+    DISubprogram *SP = cast<DISubprogram>(ExtraSP->getScope());
+    DwarfCompileUnit &Cu = getOrCreateDwarfCompileUnit(SP->getUnit());
+    DIE *ScopeDIE =
+        DIE::get(DIEValueAllocator, dwarf::DW_TAG_inlined_subroutine);
+    Cu.getUnitDie().addChild(ScopeDIE);
+
+    Cu.addString(*ScopeDIE, dwarf::DW_AT_name, ExtraSP->getName());
+
+    DITypeRefArray Args = ExtraSP->getType()->getTypeArray();
+
+    if (Args[0])
+      Cu.addType(*ScopeDIE, Args[0]);
+
+    if (ExtraSP->getType()->getCC() == llvm::dwarf::DW_CC_nocall) {
+      Cu.addUInt(*ScopeDIE, dwarf::DW_AT_calling_convention,
+                 dwarf::DW_FORM_data1, llvm::dwarf::DW_CC_nocall);
+    }
+
+    Cu.addFlag(*ScopeDIE, dwarf::DW_AT_artificial);
+
+    // dereference the DIE* for DIEEntry
+    DIE *OriginDIE = Cu.getOrCreateSubprogramDIE(SP, nullptr);
+    Cu.addDIEEntry(*ScopeDIE, dwarf::DW_AT_specification, DIEEntry(*OriginDIE));
+
+    SmallVector<const DILocalVariable *> ArgVars(Args.size());
+    for (const DINode *DN : ExtraSP->getRetainedNodes()) {
+      if (const auto *DV = dyn_cast<DILocalVariable>(DN)) {
+        uint32_t Arg = DV->getArg();
+        if (Arg)
+          ArgVars[Arg - 1] = DV;
+      }
+    }
+
+    // The func does not have variant arguments.
+    for (unsigned i = 1, N = Args.size(); i < N; ++i) {
+      const DIType *Ty = Args[i];
+      DIE &Arg =
+          Cu.createAndAddDIE(dwarf::DW_TAG_formal_parameter, *ScopeDIE);
+      const DILocalVariable *DV = ArgVars[i - 1];
+      if (DV)
+        Cu.addString(Arg, dwarf::DW_AT_name, DV->getName());
+      Cu.addType(Arg, Ty);
+    }
+  }
+}
+
 void DwarfDebug::finalizeModuleInfo() {
   const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
 
   finishSubprogramDefinitions();
 
+  addChangedSubprograms();
+
   finishEntityDefinitions();
 
   bool HasEmittedSplitCU = false;
diff --git a/llvm/lib/CodeGen/AsmPrinter/DwarfDebug.h b/llvm/lib/CodeGen/AsmPrinter/DwarfDebug.h
index 89813dcf0fdab..417ffb19633c3 100644
--- a/llvm/lib/CodeGen/AsmPrinter/DwarfDebug.h
+++ b/llvm/lib/CodeGen/AsmPrinter/DwarfDebug.h
@@ -565,6 +565,8 @@ class DwarfDebug : public DebugHandlerBase {
 
   void finishSubprogramDefinitions();
 
+  void addChangedSubprograms();
+
   /// Finish off debug information after all functions have been
   /// processed.
   void finalizeModuleInfo();
diff --git a/llvm/lib/Passes/PassBuilder.cpp b/llvm/lib/Passes/PassBuilder.cpp
index 0f038e6eb2430..09a27c4f7ca8a 100644
--- a/llvm/lib/Passes/PassBuilder.cpp
+++ b/llvm/lib/Passes/PassBuilder.cpp
@@ -348,6 +348,7 @@
 #include "llvm/Transforms/Utils/DXILUpgrade.h"
 #include "llvm/Transforms/Utils/Debugify.h"
 #include "llvm/Transforms/Utils/DeclareRuntimeLibcalls.h"
+#include "llvm/Transforms/Utils/EmitChangedFuncDebugInfo.h"
 #include "llvm/Transforms/Utils/EntryExitInstrumenter.h"
 #include "llvm/Transforms/Utils/FixIrreducible.h"
 #include "llvm/Transforms/Utils/HelloWorld.h"
diff --git a/llvm/lib/Passes/PassBuilderPipelines.cpp b/llvm/lib/Passes/PassBuilderPipelines.cpp
index 30c6f06be139d..ee6153a3902ae 100644
--- a/llvm/lib/Passes/PassBuilderPipelines.cpp
+++ b/llvm/lib/Passes/PassBuilderPipelines.cpp
@@ -135,6 +135,7 @@
 #include "llvm/Transforms/Utils/AssumeBundleBuilder.h"
 #include "llvm/Transforms/Utils/CanonicalizeAliases.h"
 #include "llvm/Transforms/Utils/CountVisits.h"
+#include "llvm/Transforms/Utils/EmitChangedFuncDebugInfo.h"
 #include "llvm/Transforms/Utils/EntryExitInstrumenter.h"
 #include "llvm/Transforms/Utils/ExtraPassManager.h"
 #include "llvm/Transforms/Utils/InjectTLIMappings.h"
@@ -1640,9 +1641,12 @@ PassBuilder::buildModuleOptimizationPipeline(OptimizationLevel Level,
   if (PTO.CallGraphProfile && !LTOPreLink)
     MPM.addPass(CGProfilePass(isLTOPostLink(LTOPhase)));
 
-  // RelLookupTableConverterPass runs later in LTO post-link pipeline.
-  if (!LTOPreLink)
+  // RelLookupTableConverterPass and EmitChangedFuncDebugInfoPass run later in
+  // LTO post-link pipeline.
+  if (!LTOPreLink) {
     MPM.addPass(RelLookupTableConverterPass());
+    MPM.addPass(EmitChangedFuncDebugInfoPass());
+  }
 
   return MPM;
 }
diff --git a/llvm/lib/Passes/PassRegistry.def b/llvm/lib/Passes/PassRegistry.def
index 924aa3eb5d492..8384d4aaac508 100644
--- a/llvm/lib/Passes/PassRegistry.def
+++ b/llvm/lib/Passes/PassRegistry.def
@@ -73,6 +73,7 @@ MODULE_PASS("debugify", NewPMDebugifyPass())
 MODULE_PASS("declare-runtime-libcalls", DeclareRuntimeLibcallsPass())
 MODULE_PASS("dfsan", DataFlowSanitizerPass())
 MODULE_PASS("dot-callgraph", CallGraphDOTPrinterPass())
+MODULE_PASS("dwarf-emit-late", EmitChangedFuncDebugInfoPass())
 MODULE_PASS("dxil-upgrade", DXILUpgradePass())
 MODULE_PASS("elim-avail-extern", EliminateAvailableExternallyPass())
 MODULE_PASS("extract-blocks", BlockExtractorPass({}, false))
diff --git a/llvm/lib/Transforms/Utils/CMakeLists.txt b/llvm/lib/Transforms/Utils/CMakeLists.txt
index f367ca2fdf56b..72291a0c7d8b0 100644
--- a/llvm/lib/Transforms/Utils/CMakeLists.txt
+++ b/llvm/lib/Transforms/Utils/CMakeLists.txt
@@ -23,6 +23,7 @@ add_llvm_component_library(LLVMTransformUtils
   DebugSSAUpdater.cpp
   DeclareRuntimeLibcalls.cpp
   DemoteRegToStack.cpp
+  EmitChangedFuncDebugInfo.cpp
   DXILUpgrade.cpp
   EntryExitInstrumenter.cpp
   EscapeEnumerator.cpp
diff --git a/llvm/lib/Transforms/Utils/EmitChangedFuncDebugInfo.cpp b/llvm/lib/Transforms/Utils/EmitChangedFuncDebugInfo.cpp
new file mode 100644
index 0000000000000..6ffbd09715ac3
--- /dev/null
+++ b/llvm/lib/Transforms/Utils/EmitChangedFuncDebugInfo.cpp
@@ -0,0 +1,410 @@
+//==- EmitChangedFuncDebugInfoPass - Emit Additional Debug Info -*- C++ -*-===//
+//
+// 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 file implements emitting debug info for functions with changed
+// signatures or new functions.
+//
+//===----------------------------------------------------------------------===//
+
+#include "llvm/Transforms/Utils/EmitChangedFuncDebugInfo.h"
+#include "llvm/IR/DIBuilder.h"
+#include "llvm/IR/IRBuilder.h"
+#include "llvm/IR/IntrinsicInst.h"
+#include "llvm/IR/Module.h"
+#include "llvm/TargetParser/Triple.h"
+
+using namespace llvm;
+
+// A struct param breaks into two actual arguments like
+//    static int count(struct user_arg_ptr argv, int max)
+// and the actual func signature:
+//    i32 @count(i8 range(i8 0, 2) %argv.coerce0, ptr %argv.coerce1)
+//    {
+//      #dbg_value(i8 %argv.coerce0, !14759,
+//      !DIExpression(DW_OP_LLVM_fragment, 0, 8), !14768)
+//      #dbg_value(ptr %argv.coerce1, !14759,
+//      !DIExpression(DW_OP_LLVM_fragment, 64, 64), !14768)
+//      ...
+//    }
+static DIType *getTypeFromExpr(DIBuilder &DIB, DIExpression *Expr,
+                               DICompositeType *DTy) {
+  for (auto Op : Expr->expr_ops()) {
+    if (Op.getOp() != dwarf::DW_OP_LLVM_fragment)
+      continue;
+
+    uint64_t BitOffset = Op.getArg(0);
+    uint64_t BitSize = Op.getArg(1);
+
+    for (auto *Element : DTy->getElements()) {
+      auto Elem = cast<DIDerivedType>(Element);
+      if (Elem->getSizeInBits() == BitSize &&
+          Elem->getOffsetInBits() == BitOffset)
+        return Elem->getBaseType();
+      else
+        // Create a new int type. For example, original debuginfo is an array.
+        return DIB.createBasicType("int" + std::to_string(BitSize), BitSize,
+                                   dwarf::DW_ATE_signed);
+    }
+  }
+  return nullptr;
+}
+
+static bool getArg(unsigned Idx, BasicBlock &FirstBB, DIBuilder &DIB,
+                   DIFile *NewFile, Function *F, DISubprogram *OldSP,
+                   SmallVector<Metadata *, 5> &TypeList,
+                   SmallVector<Metadata *, 5> &ArgList) {
+  for (Instruction &I : FirstBB) {
+    for (const DbgRecord &DR : I.getDbgRecordRange()) {
+      auto *DVR = dyn_cast<DbgVariableRecord>(&DR);
+      if (!DVR)
+        continue;
+      // All of DbgVariableRecord::LocationType::{Value,Assign,Declare}
+      // are covered.
+      Metadata *Loc = DVR->getRawLocation();
+      auto *ValueMDN = dyn_cast<ValueAsMetadata>(Loc);
+      if (!ValueMDN)
+        continue;
+
+      Value *MDNValue = ValueMDN->getValue();
+      if (!MDNValue)
+        continue;
+
+      Type *Ty = ValueMDN->getType();
+      auto *Var = DVR->getVariable();
+      if (!Var->getArg())
+        continue;
+
+      if (dyn_cast<AllocaInst>(MDNValue)) {
+        // A struct turned into a pointer to struct.
+        //   @rhashtable_lookup_fast(ptr noundef %key,
+        //        ptr noundef readonly byval(%struct.rhashtable_params)
+        //        align 8 captures(none) %params) {
+        //      ...
+        //      %MyAlloca = alloca [160 x i8], align 32
+        //      %0 = ptrtoint ptr %MyAlloca to i64
+        //      %1 = add i64 %0, 32
+        //      %2 = inttoptr i64 %1 to ptr
+        //      ...
+        //      call void @llvm.memcpy.p0.p0.i64(ptr align 8 %2, ptr align 8
+        //                                       %params, i64 40, i1 false)
+        //        #dbg_value(ptr @offdevs, !15308, !DIExpression(), !15312)
+        //        #dbg_value(ptr %key, !15309, !DIExpression(), !15312)
+        //        #dbg_declare(ptr %MyAlloca, !15310,
+        //                     !DIExpression(DW_OP_plus_uconst, 32), !15313)
+        //      tail call void @__rcu_read_lock() #14, !dbg !15314
+        //   }
+        if (Var->getName() != F->getArg(Idx)->getName())
+          continue;
+      } else if (MDNValue != F->getArg(Idx)) {
+        // Handle the following pattern:
+        //   ... @vgacon_do_font_op(..., i32 noundef, i1 noundef zeroext %ch512)
+        //   ... {
+        //     ...
+        //       #dbg_value(i32 %set, !8568, !DIExpression(), !8589)
+        //     %storedv = zext i1 %ch512 to i8
+        //       #dbg_value(i8 %storedv, !8569, !DIExpression(), !8589)
+        //     ...
+        //   }
+        Instruction *PrevI = I.getPrevNode();
+        if (!PrevI)
+          continue;
+        if (MDNValue != PrevI)
+          continue;
+        auto *ZExt = dyn_cast<ZExtInst>(PrevI);
+        if (!ZExt)
+          continue;
+        if (ZExt->getOperand(0) != F->getArg(Idx))
+          continue;
+      }
+
+      auto *Expr = DVR->getExpression();
+
+      // Strip modifiers (const, volatile, etc.)
+      DIType *DITy = Var->getType();
+      while (auto *DTy = dyn_cast<DIDerivedType>(DITy)) {
+        if (DTy->getTag() == dwarf::DW_TAG_pointer_type) {
+          DITy = DTy;
+          break;
+        }
+        DITy = DTy->getBaseType();
+      }
+
+      DIType *ParamType = Var->getType();
+      if (Ty->isIntegerTy()) {
+        if (auto *DTy = dyn_cast<DICompositeType>(DITy)) {
+          if (!Ty->isIntegerTy(DTy->getSizeInBits())) {
+            ParamType = getTypeFromExpr(DIB, Expr, DTy);
+            if (!ParamType)
+              return false;
+          }
+        }
+      } else if (Ty->isPointerTy()) {
+        if (dyn_cast<DICompositeType>(DITy)) {
+          ParamType = DIB.createPointerType(DITy, 64);
+        } else {
+          auto *DTy = dyn_cast<DIDerivedType>(DITy);
+          if (!DTy)
+            continue;
+          if (DTy->getTag() != dwarf::DW_TAG_pointer_type)
+            continue;
+        }
+      }
+
+      TypeList.push_back(ParamType);
+      if (Var->getArg() != (Idx + 1) ||
+          Var->getName() != F->getArg(Idx)->getName()) {
+        Var = DIB.createParameterVariable(OldSP, F->getArg(Idx)->getName(),
+                                          Idx + 1, OldSP->getUnit()->getFile(),
+                                          OldSP->getLine(), ParamType);
+      }
+      ArgList.push_back(Var);
+      return true;
+    }
+  }
+
+  /* The parameter is not handled due to poison value, so just create a new type
+   */
+  Type *Ty = F->getArg(Idx)->getType();
+  unsigned IntBitWidth = 32;
+  if (Ty->isIntegerTy())
+    IntBitWidth = cast<IntegerType>(Ty)->getBitWidth();
+
+  DIType *ParamType = DIB.createBasicType("int" + std::to_string(IntBitWidth),
+                                          IntBitWidth, dwarf::DW_ATE_signed);
+  DILocalVariable *Var =
+      DIB.createParameterVariable(OldSP, F->getArg(Idx)->getName(), Idx + 1,
+                                  NewFile, OldSP->getLine(), ParamType);
+  TypeList.push_back(ParamType);
+  ArgList.push_back(Var);
+  return true;
+}
+
+static bool getTypeArgList(DIBuilder &DIB, DIFile *NewFile, Function *F,
+                           FunctionType *FTy, DISubprogram *OldSP,
+                           SmallVector<Metadata *, 5> &TypeList,
+                           SmallVector<Metadata *, 5> &ArgList) {
+  Type *RetTy = FTy->getReturnType();
+  if (RetTy->isVoidTy()) {
+    // Void return type may be due to optimization.
+    TypeList.push_back(nullptr);
+  } else {
+    // Optimization does not change return type from one
+    // non-void type to another non-void type.
+    DITypeRefArray TyArray = OldSP->getType()->getTypeArray();
+    TypeList.push_back(TyArray[0]);
+  }
+
+  unsigned NumArgs = FTy->getNumParams();
+  if (!NumArgs)
+    return true;
+
+  BasicBlock &FirstBB = F->getEntryBlock();
+  for (unsigned i = 0; i < NumArgs; ++i) {
+    if (!getArg(i, FirstBB, DIB, NewFile, F, OldSP, TypeList, ArgList))
+      return false;
+  }
+
+  return true;
+}
+
+static void generateDebugInfo(Module &M, Function *F) {
+  // For this CU, we want generate the following three dwarf units:
+  // DW_TAG_compile_unit
+  //   ...
+  //   // New functions with suffix
+  //   DW_TAG_inlined_subroutine
+  //     DW_AT_name      ("foo.1")
+  //     DW_AT_type      (0x0000000000000091 "int")
+  //     DW_AT_artificial (true)
+  //     DW_AT_specificiation (original DW_TAG_subprogram)
+  //
+  //     DW_TAG_formal_parameter
+  //       DW_AT_name    ("b")
+  //       DW_AT_type    (0x0000000000000091 "int")
+  //
+  //     DW_TAG_formal_parameter
+  //       DW_AT_name    ("c")
+  //       DW_AT_type    (0x0000000000000095 "long")
+  //   ...
+  //   // Functions with changed signatures
+  //   DW_TAG_inlined_subroutine
+  //     DW_AT_name      ("bar")
+  //     DW_AT_type      (0x0000000000000091 "int")
+  //     DW_AT_artificial (true)
+  //     DW_AT_specificiation (original DW_TAG_subprogram)
+  //
+  //     DW_TAG_formal_parameter
+  //       DW_AT_name    ("c")
+  //       DW_AT_type    (0x0000000000000095 "unsigned int")
+  //   ...
+  //   // Functions not obtained function changed signatures yet
+  //   // The DW_CC_nocall presence indicates such cases.
+  //   DW_TAG_inlined_subroutine
+  //     DW_AT_name      ("bar" or "bar.1")
+  //     DW_AT_calling_convention        (DW_CC_nocall)
+  //     DW_AT_artificial (true)
+  //     DW_AT_specificiation (original DW_TAG_subprogram)
+  //   ...
+
+  // A new ComputeUnit is created with file name "<artificial>"
+  // to host newly-created DISubprogram's.
+  DICompileUnit *NewCU = nullptr;
+  NamedMDNode *CUs = M.getNamedMetadata("llvm.dbg.cu");
+  for (MDNode *Node : CUs->operands()) {
+    auto *CU = cast<DICompileUnit>(Node);
+    if (CU->getFile()->getFilename() == "<artificial>") {
+      NewCU = CU;
+      break;
+    }
+  }
+
+  DISubprogram *OldSP = F->getSubprogram();
+  DIBuilder DIB(M, /*AllowUnresolved=*/false, NewCU);
+  DIFile *NewFile;
+
+  if (NewCU) {
+    NewFile = NewCU->getFile();
+  } else {
+    DIFile *OldFile = OldSP->getFile();
+    NewFile = DIB.createFile("<artificial>", OldFile->getDirectory());
+    NewCU = DIB.createCompileUnit(dwarf::DW_LANG_C, NewFile, "", false, "", 0);
+  }
+
+  SmallVector<Metadata *, 5> TypeList;
+  SmallVector<Metadata *, 5> ArgList;
+
+  FunctionType *FTy = F->getFunctionType();
+  bool Success = getTypeArgList(DIB, NewFile, F, FTy, OldSP, TypeList, ArgList);
+  if (!Success) {
+    fprintf(stderr, "YHS20 ...\n");
+    F->dump();
+    TypeList.clear();
+    TypeList.push_back(nullptr);
+    ArgList.clear();
+  }
+
+  DITypeRefArray DITypeArray = DIB.getOrCreateTypeArray(TypeList);
+  auto *SubroutineType = DIB.createSubroutineType(DITypeArray);
+  DINodeArray ArgArray = DIB.getOrCreateArray(ArgList);
+
+  Function *DummyF =
+      Function::Create(FTy, GlobalValue::AvailableExternallyLinkage,
+                       F->getName() + ".newsig", &M);
+
+  DISubprogram *NewSP =
+      DIB.createFunction(OldSP,                   // Scope
+                         F->getName(),            // Name
+                         OldSP->getLinkageName(), // Linkage name
+                         NewFile,                 // File
+                         OldSP->getLine(),        // Line
+                         SubroutineType,          // DISubroutineType
+                         OldSP->getScopeLine(),   // ScopeLine
+                         DINode::FlagZero, DISubprogram::SPFlagDefinition);
+  NewSP->replaceRetainedNodes(ArgArray);
+
+  if (!Success) {
+    auto Temp = NewSP->getType()->cloneWithCC(llvm::dwarf::DW_CC_nocall);
+    NewSP->replaceType(MDNode::replaceWithPermanent(std::move(Temp)));
+  }
+
+  DIB.finalizeSubprogram(NewSP);
+
+  // Add dummy return block
+  BasicBlock *BB = BasicBlock::Create(M.getContext(), "entry", DummyF);
+  IRBuilder<> IRB(BB);
+  IRB.CreateUnreachable();
+
+  DummyF->setSubprogram(NewSP);
+
+  DIB.finalize();
+}
+
+PreservedAnalyses EmitChangedFuncDebugInfoPass::run(Module &M,
+                                                    ModuleAnalysisManager &AM) {
+  /* For C only */
+  for (DICompileUnit *CU : M.debug_compile_units()) {
+    auto L = static_cast<llvm::dwarf::SourceLanguage>(CU->getSourceLanguage());
+    if (L != dwarf::DW_LANG_C && L != dwarf::DW_LANG_C89 &&
+        L != dwarf::DW_LANG_C99 && L != dwarf::DW_LANG_C11 &&
+        L != dwarf::DW_LANG_C17)
+      return PreservedAnalyses::all();
+  }
+
+  llvm::Triple T(M.getTargetTriple());
+  if (!T.isArch64Bit())
+    return PreservedAnalyses::all();
+
+  SmallVector<Function *> ChangedFuncs;
+  for (auto &F : M) {
+    // Function must already have DebugInfo.
+    DISubprogram *SP = F.getSubprogram();
+    if (!SP)
+      continue;
+
+    // Ignore all intrinsics/declare-only functions.
+    if (F.isIntrinsic() || F.isDeclaration())
+      continue;
+
+    // Skip if the return value is a DICompositeType.
+    DITypeRefArray TyArray = SP->getType()->getTypeArray();
+    // FIXME: workaround for some selftests
+    if (TyArray.size() == 0)
+      continue;
+    DIType *DITy = TyArray[0];
+    while (auto *DTy = dyn_cast_or_null<DIDerivedType>(DITy)) {
+      if (DTy->getTag() == dwarf::DW_TAG_pointer_type) {
+        DITy = DTy;
+        break;
+      }
+      DITy = DTy->getBaseType();
+    }
+    if (dyn_cast_or_null<DICompositeType>(DITy))
+      continue;
+
+    // Skip if the func has variable number of arguments
+    if (TyArray.size() > 1 && TyArray[TyArray.size() - 1] == nullptr)
+      continue;
+
+    // For original functions with struct/union as the argument and
+    // if the argument size is greater than 8 bytes, consider this
+    // function as signature changed.
+    StringRef FName = F.getName();
+    if (!FName.contains('.')) {
+      uint8_t cc = SP->getType()->getCC();
+      if (cc != llvm::dwarf::DW_CC_nocall) {
+        bool SigChanged = false;
+        for (unsigned i = 1; i < TyArray.size(); ++i) {
+          DITy = TyArray[i];
+          while (auto *DTy = dyn_cast<DIDerivedType>(DITy)) {
+            if (DTy->getTag() == dwarf::DW_TAG_pointer_type) {
+              DITy = DTy;
+              break;
+            }
+            DITy = DTy->getBaseType();
+          }
+          if (auto *DTy = dyn_cast<DICompositeType>(DITy)) {
+            if (DTy->getSizeInBits() <= 64)
+              continue;
+            SigChanged = true;
+            break;
+          }
+        }
+        if (!SigChanged)
+          continue;
+      }
+    }
+
+    ChangedFuncs.push_back(&F);
+  }
+
+  bool Changed = ChangedFuncs.size() != 0;
+  for (auto *F : ChangedFuncs)
+    generateDebugInfo(M, F);
+
+  return Changed ? PreservedAnalyses::none() : PreservedAnalyses::all();
+}
diff --git a/llvm/test/Other/new-pm-defaults.ll b/llvm/test/Other/new-pm-defaults.ll
index 94e860b8ce304..650bcd6f0f98d 100644
--- a/llvm/test/Other/new-pm-defaults.ll
+++ b/llvm/test/Other/new-pm-defaults.ll
@@ -295,6 +295,8 @@
 ; CHECK-DEFAULT-NEXT: Running pass: CGProfilePass
 ; CHECK-DEFAULT-NEXT: Running pass: RelLookupTableConverterPass
 ; CHECK-LTO-NOT: Running pass: RelLookupTableConverterPass
+; CHECK-DEFAULT-NEXT: Running pass: EmitChangedFuncDebugInfoPass
+; CHECK-LTO-NOT: Running pass: EmitChangedFuncDebugInfoPass
 ; CHECK-O-NEXT: Running pass: AnnotationRemarksPass on foo
 ; CHECK-LTO-NEXT: Running pass: CanonicalizeAliasesPass
 ; CHECK-LTO-NEXT: Running pass: NameAnonGlobalPass
diff --git a/llvm/test/Other/new-pm-thinlto-postlink-defaults.ll b/llvm/test/Other/new-pm-thinlto-postlink-defaults.ll
index a08a140a35166..b913cd3e2d90b 100644
--- a/llvm/test/Other/new-pm-thinlto-postlink-defaults.ll
+++ b/llvm/test/Other/new-pm-thinlto-postlink-defaults.ll
@@ -208,6 +208,7 @@
 ; CHECK-POSTLINK-O-NEXT: Running pass: ConstantMergePass
 ; CHECK-POSTLINK-O-NEXT: Running pass: CGProfilePass
 ; CHECK-POSTLINK-O-NEXT: Running pass: RelLookupTableConverterPass
+; CHECK-POSTLINK-O-NEXT: Running pass: EmitChangedFuncDebugInfoPass
 ; CHECK-EP-OPT-EARLY-NEXT: Running pass: NoOpModulePass
 ; CHECK-EP-OPT-LAST-NEXT: Running pass: NoOpModulePass
 ; CHECK-O-NEXT:          Running pass: AnnotationRemarksPass on foo
diff --git a/llvm/test/Other/new-pm-thinlto-postlink-pgo-defaults.ll b/llvm/test/Other/new-pm-thinlto-postlink-pgo-defaults.ll
index d9e2dd37a7985..38e3238b3c170 100644
--- a/llvm/test/Other/new-pm-thinlto-postlink-pgo-defaults.ll
+++ b/llvm/test/Other/new-pm-thinlto-postlink-pgo-defaults.ll
@@ -192,6 +192,7 @@
 ; CHECK-O-NEXT: Running pass: ConstantMergePass
 ; CHECK-O-NEXT: Running pass: CGProfilePass
 ; CHECK-O-NEXT: Running pass: RelLookupTableConverterPass
+; CHECK-O-NEXT: Running pass: EmitChangedFuncDebugInfoPass
 ; CHECK-O-NEXT: Running pass: AnnotationRemarksPass on foo
 ; CHECK-O-NEXT: Running pass: PrintModulePass
 
diff --git a/llvm/test/Other/new-pm-thinlto-postlink-samplepgo-defaults.ll b/llvm/test/Other/new-pm-thinlto-postlink-samplepgo-defaults.ll
index 2f6fa4b27d354..2ec67d01424e7 100644
--- a/llvm/test/Other/new-pm-thinlto-postlink-samplepgo-defaults.ll
+++ b/llvm/test/Other/new-pm-thinlto-postlink-samplepgo-defaults.ll
@@ -201,6 +201,7 @@
 ; CHECK-O-NEXT: Running pass: ConstantMergePass
 ; CHECK-O-NEXT: Running pass: CGProfilePass
 ; CHECK-O-NEXT: Running pass: RelLookupTableConverterPass
+; CHECK-O-NEXT: Running pass: EmitChangedFuncDebugInfoPass
 ; CHECK-O-NEXT: Running pass: AnnotationRemarksPass on foo
 ; CHECK-O-NEXT: Running pass: PrintModulePass
 



More information about the llvm-commits mailing list