[clang] [flang] [flang] Implement -grecord-command-line for Flang (PR #181686)
via cfe-commits
cfe-commits at lists.llvm.org
Mon Feb 16 07:33:21 PST 2026
llvmbot wrote:
<!--LLVM PR SUMMARY COMMENT-->
@llvm/pr-subscribers-flang-fir-hlfir
Author: Yangyu Chen (cyyself)
<details>
<summary>Changes</summary>
Enable Flang to match Clang behavior for command-line recording in DWARF producer strings when using -grecord-command-line.
---
Full diff: https://github.com/llvm/llvm-project/pull/181686.diff
9 Files Affected:
- (modified) clang/include/clang/Options/Options.td (+4-2)
- (modified) flang/include/flang/Frontend/CodeGenOptions.h (+3)
- (modified) flang/include/flang/Optimizer/Passes/Pipelines.h (+5-2)
- (modified) flang/include/flang/Optimizer/Transforms/Passes.td (+4-1)
- (modified) flang/include/flang/Tools/CrossToolHelpers.h (+2)
- (modified) flang/lib/Frontend/CompilerInvocation.cpp (+5)
- (modified) flang/lib/Optimizer/Passes/Pipelines.cpp (+8-4)
- (modified) flang/lib/Optimizer/Transforms/AddDebugInfo.cpp (+4-2)
- (added) flang/test/Driver/grecord-command-line.f90 (+29)
``````````diff
diff --git a/clang/include/clang/Options/Options.td b/clang/include/clang/Options/Options.td
index a274017953b1d..3f5d0af6b6343 100644
--- a/clang/include/clang/Options/Options.td
+++ b/clang/include/clang/Options/Options.td
@@ -4938,9 +4938,11 @@ def gxcoff : Joined<["-"], "gxcoff">, Group<g_Group>, Flags<[Unsupported]>;
def gvms : Joined<["-"], "gvms">, Group<g_Group>, Flags<[Unsupported]>;
def gtoggle : Flag<["-"], "gtoggle">, Group<g_flags_Group>, Flags<[Unsupported]>;
def grecord_command_line : Flag<["-"], "grecord-command-line">,
- Group<g_flags_Group>;
+ Group<g_flags_Group>,
+ Visibility<[ClangOption, FlangOption]>;
def gno_record_command_line : Flag<["-"], "gno-record-command-line">,
- Group<g_flags_Group>;
+ Group<g_flags_Group>,
+ Visibility<[ClangOption, FlangOption]>;
def : Flag<["-"], "grecord-gcc-switches">, Alias<grecord_command_line>;
def : Flag<["-"], "gno-record-gcc-switches">, Alias<gno_record_command_line>;
defm strict_dwarf : BoolOption<"g", "strict-dwarf",
diff --git a/flang/include/flang/Frontend/CodeGenOptions.h b/flang/include/flang/Frontend/CodeGenOptions.h
index 3dca169d43b39..179457558f01b 100644
--- a/flang/include/flang/Frontend/CodeGenOptions.h
+++ b/flang/include/flang/Frontend/CodeGenOptions.h
@@ -73,6 +73,9 @@ class CodeGenOptions : public CodeGenOptionsBase {
/// The string containing the commandline for the llvm.commandline metadata.
std::optional<std::string> RecordCommandLine;
+ /// The string to append to DWARF producer as debug flags.
+ std::string DwarfDebugFlags;
+
/// The name of the file to which the backend should save YAML optimization
/// records.
std::string OptRecordFile;
diff --git a/flang/include/flang/Optimizer/Passes/Pipelines.h b/flang/include/flang/Optimizer/Passes/Pipelines.h
index 1a7ff4ff3dfa2..8f2ff5f82299d 100644
--- a/flang/include/flang/Optimizer/Passes/Pipelines.h
+++ b/flang/include/flang/Optimizer/Passes/Pipelines.h
@@ -103,7 +103,9 @@ void addCompilerGeneratedNamesConversionPass(mlir::PassManager &pm);
void addDebugInfoPass(mlir::PassManager &pm,
llvm::codegenoptions::DebugInfoKind debugLevel,
llvm::OptimizationLevel optLevel,
- llvm::StringRef inputFilename, int32_t dwarfVersion);
+ llvm::StringRef inputFilename, int32_t dwarfVersion,
+ llvm::StringRef splitDwarfFile,
+ llvm::StringRef dwarfDebugFlags);
/// Create FIRToLLVMPassOptions from pipeline configuration.
FIRToLLVMPassOptions
@@ -164,7 +166,8 @@ void createDebugPasses(mlir::PassManager &pm,
llvm::codegenoptions::DebugInfoKind debugLevel,
llvm::OptimizationLevel OptLevel,
llvm::StringRef inputFilename, int32_t dwarfVersion,
- llvm::StringRef splitDwarfFile);
+ llvm::StringRef splitDwarfFile,
+ llvm::StringRef dwarfDebugFlags);
void createDefaultFIRCodeGenPassPipeline(mlir::PassManager &pm,
MLIRToLLVMPassPipelineConfig config,
diff --git a/flang/include/flang/Optimizer/Transforms/Passes.td b/flang/include/flang/Optimizer/Transforms/Passes.td
index d812e271b158d..bdee252d14c72 100644
--- a/flang/include/flang/Optimizer/Transforms/Passes.td
+++ b/flang/include/flang/Optimizer/Transforms/Passes.td
@@ -260,7 +260,10 @@ def AddDebugInfo : Pass<"add-debug-info", "mlir::ModuleOp"> {
"dwarf version">,
Option<"splitDwarfFile", "split-dwarf-file",
"std::string", /*default=*/"std::string{}",
- "Name of the split dwarf file">
+ "Name of the split dwarf file">,
+ Option<"dwarfDebugFlags", "dwarf-debug-flags",
+ "std::string", /*default=*/"std::string{}",
+ "Command-line flags to append to DWARF producer">
];
}
diff --git a/flang/include/flang/Tools/CrossToolHelpers.h b/flang/include/flang/Tools/CrossToolHelpers.h
index 44fb252d2b366..f29fc8ef0ea56 100644
--- a/flang/include/flang/Tools/CrossToolHelpers.h
+++ b/flang/include/flang/Tools/CrossToolHelpers.h
@@ -110,6 +110,7 @@ struct MLIRToLLVMPassPipelineConfig : public FlangEPCallBacks {
}
DwarfVersion = opts.DwarfVersion;
SplitDwarfFile = opts.SplitDwarfFile;
+ DwarfDebugFlags = opts.DwarfDebugFlags;
}
llvm::OptimizationLevel OptLevel; ///< optimisation level
@@ -148,6 +149,7 @@ struct MLIRToLLVMPassPipelineConfig : public FlangEPCallBacks {
CX_Full; ///< Method for calculating complex number division
int32_t DwarfVersion = 0; ///< Version of DWARF debug info to generate
std::string SplitDwarfFile = ""; ///< File name for the split debug info
+ std::string DwarfDebugFlags = ""; ///< Debug flags to append to DWARF producer
};
struct OffloadModuleOpts {
diff --git a/flang/lib/Frontend/CompilerInvocation.cpp b/flang/lib/Frontend/CompilerInvocation.cpp
index fc4975f9592eb..72b766e52ab3b 100644
--- a/flang/lib/Frontend/CompilerInvocation.cpp
+++ b/flang/lib/Frontend/CompilerInvocation.cpp
@@ -165,6 +165,11 @@ static bool parseDebugArgs(Fortran::frontend::CodeGenOptions &opts,
args.getLastArg(clang::options::OPT_split_dwarf_output))
opts.SplitDwarfOutput = a->getValue();
}
+
+ if (const llvm::opt::Arg *arg =
+ args.getLastArg(clang::options::OPT_dwarf_debug_flags))
+ opts.DwarfDebugFlags = arg->getValue();
+
return true;
}
diff --git a/flang/lib/Optimizer/Passes/Pipelines.cpp b/flang/lib/Optimizer/Passes/Pipelines.cpp
index 9b73d587ee7bc..64e925c0a4922 100644
--- a/flang/lib/Optimizer/Passes/Pipelines.cpp
+++ b/flang/lib/Optimizer/Passes/Pipelines.cpp
@@ -97,13 +97,15 @@ void addDebugInfoPass(mlir::PassManager &pm,
llvm::codegenoptions::DebugInfoKind debugLevel,
llvm::OptimizationLevel optLevel,
llvm::StringRef inputFilename, int32_t dwarfVersion,
- llvm::StringRef splitDwarfFile) {
+ llvm::StringRef splitDwarfFile,
+ llvm::StringRef dwarfDebugFlags) {
fir::AddDebugInfoOptions options;
options.debugLevel = getEmissionKind(debugLevel);
options.isOptimized = optLevel != llvm::OptimizationLevel::O0;
options.inputFilename = inputFilename;
options.dwarfVersion = dwarfVersion;
options.splitDwarfFile = splitDwarfFile;
+ options.dwarfDebugFlags = dwarfDebugFlags;
addPassConditionally(pm, disableDebugInfo,
[&]() { return fir::createAddDebugInfoPass(options); });
}
@@ -362,10 +364,11 @@ void createDebugPasses(mlir::PassManager &pm,
llvm::codegenoptions::DebugInfoKind debugLevel,
llvm::OptimizationLevel OptLevel,
llvm::StringRef inputFilename, int32_t dwarfVersion,
- llvm::StringRef splitDwarfFile) {
+ llvm::StringRef splitDwarfFile,
+ llvm::StringRef dwarfDebugFlags) {
if (debugLevel != llvm::codegenoptions::NoDebugInfo)
addDebugInfoPass(pm, debugLevel, OptLevel, inputFilename, dwarfVersion,
- splitDwarfFile);
+ splitDwarfFile, dwarfDebugFlags);
}
void createDefaultFIRCodeGenPassPipeline(mlir::PassManager &pm,
@@ -384,7 +387,8 @@ void createDefaultFIRCodeGenPassPipeline(mlir::PassManager &pm,
pm, (config.DebugInfo != llvm::codegenoptions::NoDebugInfo));
fir::addExternalNameConversionPass(pm, config.Underscoring);
fir::createDebugPasses(pm, config.DebugInfo, config.OptLevel, inputFilename,
- config.DwarfVersion, config.SplitDwarfFile);
+ config.DwarfVersion, config.SplitDwarfFile,
+ config.DwarfDebugFlags);
fir::addTargetRewritePass(pm);
fir::addCompilerGeneratedNamesConversionPass(pm);
diff --git a/flang/lib/Optimizer/Transforms/AddDebugInfo.cpp b/flang/lib/Optimizer/Transforms/AddDebugInfo.cpp
index 35d8a2f6c3aa9..836089d357ee8 100644
--- a/flang/lib/Optimizer/Transforms/AddDebugInfo.cpp
+++ b/flang/lib/Optimizer/Transforms/AddDebugInfo.cpp
@@ -861,8 +861,10 @@ void AddDebugInfoPass::runOnOperation() {
mlir::LLVM::DIFileAttr fileAttr =
mlir::LLVM::DIFileAttr::get(context, fileName, filePath);
- mlir::StringAttr producer =
- mlir::StringAttr::get(context, Fortran::common::getFlangFullVersion());
+ std::string producerString = Fortran::common::getFlangFullVersion();
+ if (!dwarfDebugFlags.empty())
+ producerString += " " + dwarfDebugFlags;
+ mlir::StringAttr producer = mlir::StringAttr::get(context, producerString);
mlir::LLVM::DICompileUnitAttr cuAttr = mlir::LLVM::DICompileUnitAttr::get(
mlir::DistinctAttr::create(mlir::UnitAttr::get(context)),
llvm::dwarf::getLanguage("DW_LANG_Fortran95"), fileAttr, producer,
diff --git a/flang/test/Driver/grecord-command-line.f90 b/flang/test/Driver/grecord-command-line.f90
new file mode 100644
index 0000000000000..41d3947b5c829
--- /dev/null
+++ b/flang/test/Driver/grecord-command-line.f90
@@ -0,0 +1,29 @@
+! This checks that -grecord-command-line is forwarded by the flang driver to
+! an FC1 -dwarf-debug-flags argument and that -gno-record-command-line
+! disables it, matching clang behavior.
+!
+! RUN: %flang -### -c -grecord-command-line %s 2>&1 | FileCheck --check-prefix=GRECORD %s
+! RUN: %flang -### -c -gno-record-command-line %s 2>&1 | FileCheck --check-prefix=GNO_RECORD %s
+! RUN: %flang -### -c -grecord-command-line -gno-record-command-line %s 2>&1 | FileCheck --check-prefix=GNO_RECORD %s
+! RUN: %flang -### -c -grecord-command-line -o - %s 2>&1 | FileCheck --check-prefix=GRECORD_O %s
+! RUN: %flang -c -g -grecord-command-line %s -o %t.o
+! RUN: llvm-dwarfdump --debug-info %t.o | FileCheck --check-prefix=WITH_GRECORD %s
+! RUN: %flang -c -g -gno-record-command-line %s -o %t.norecord.o
+! RUN: llvm-dwarfdump --debug-info %t.norecord.o | FileCheck --check-prefix=NO_GRECORD %s
+!
+! GRECORD: "-dwarf-debug-flags"
+! GRECORD: -### -c -grecord-command-line
+!
+! GNO_RECORD-NOT: "-dwarf-debug-flags"
+! GNO_RECORD-NOT: -### -c -grecord-command-line
+!
+! GRECORD_O: -### -c -grecord-command-line -o -
+!
+! WITH_GRECORD: DW_AT_producer
+! WITH_GRECORD-SAME: -grecord-command-line
+!
+! NO_GRECORD: DW_AT_producer
+! NO_GRECORD-NOT: -grecord-command-line
+
+program p
+end program p
``````````
</details>
https://github.com/llvm/llvm-project/pull/181686
More information about the cfe-commits
mailing list