Skip to content

[CodeView] Flatten cmd args in frontend for LF_BUILDINFO #106369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 16, 2024
Merged

[CodeView] Flatten cmd args in frontend for LF_BUILDINFO #106369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e190d07
[Codeview] Moved flattening of commandline arguments into frontend.
nebulark Aug 28, 2024
124cb33
shortend null check
nebulark Sep 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 38 additions & 2 deletions clang/lib/CodeGen/BackendUtil.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/MemoryBuffer.h"
#include "llvm/Support/PrettyStackTrace.h"
#include "llvm/Support/Program.h"
#include "llvm/Support/TimeProfiler.h"
#include "llvm/Support/Timer.h"
#include "llvm/Support/ToolOutputFile.h"
Expand Down Expand Up @@ -322,6 +323,40 @@ static bool actionRequiresCodeGen(BackendAction Action) {
Action != Backend_EmitLL;
}

static std::string flattenClangCommandLine(ArrayRef<std::string> Args,
StringRef MainFilename) {
if (Args.empty())
return std::string{};

std::string FlatCmdLine;
raw_string_ostream OS(FlatCmdLine);
bool PrintedOneArg = false;
if (!StringRef(Args[0]).contains("-cc1")) {
llvm::sys::printArg(OS, "-cc1", /*Quote=*/true);
PrintedOneArg = true;
}
for (unsigned i = 0; i < Args.size(); i++) {
StringRef Arg = Args[i];
if (Arg.empty())
continue;
if (Arg == "-main-file-name" || Arg == "-o") {
i++; // Skip this argument and next one.
continue;
}
if (Arg.starts_with("-object-file-name") || Arg == MainFilename)
continue;
// Skip fmessage-length for reproducibility.
if (Arg.starts_with("-fmessage-length"))
continue;
if (PrintedOneArg)
OS << " ";
llvm::sys::printArg(OS, Arg, /*Quote=*/true);
PrintedOneArg = true;
}
OS.flush();
return FlatCmdLine;
}

static bool initTargetOptions(DiagnosticsEngine &Diags,
llvm::TargetOptions &Options,
const CodeGenOptions &CodeGenOpts,
Expand Down Expand Up @@ -484,8 +519,9 @@ static bool initTargetOptions(DiagnosticsEngine &Diags,
Entry.Group == frontend::IncludeDirGroup::System))
Options.MCOptions.IASSearchPaths.push_back(
Entry.IgnoreSysRoot ? Entry.Path : HSOpts.Sysroot + Entry.Path);
Options.MCOptions.Argv0 = CodeGenOpts.Argv0;
Options.MCOptions.CommandLineArgs = CodeGenOpts.CommandLineArgs;
Options.MCOptions.Argv0 = CodeGenOpts.Argv0 ? CodeGenOpts.Argv0 : "";
Options.MCOptions.CommandlineArgs = flattenClangCommandLine(
CodeGenOpts.CommandLineArgs, CodeGenOpts.MainFileName);
Options.MCOptions.AsSecureLogFile = CodeGenOpts.AsSecureLogFile;
Options.MCOptions.PPCUseFullRegisterNames =
CodeGenOpts.PPCUseFullRegisterNames;
Expand Down
4 changes: 2 additions & 2 deletions clang/test/CodeGen/debug-info-codeview-buildinfo.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ int main(void) { return 42; }
// DISABLE-NOT: "-cc1"
// DISABLE: 0x{{.+}} | LF_BUILDINFO [size = {{.+}}]
// DISABLE-NEXT: 0x{{.+}}: `{{.*}}`
// DISABLE-NEXT: <no type>: ``
// DISABLE-NEXT: 0x{{.+}}: `{{.*}}`
// DISABLE-NEXT: 0x{{.+}}: `{{.*}}`
// DISABLE-NEXT: 0x{{.+}}: ``
// DISABLE-NEXT: <no type>: ``
// DISABLE-NEXT: 0x{{.+}}: `{{.*}}`

// MESSAGELEN: Types (.debug$T)
// MESSAGELEN: ============================================================
Expand Down
5 changes: 3 additions & 2 deletions llvm/include/llvm/MC/MCTargetOptions.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,9 @@ class MCTargetOptions {
std::string SplitDwarfFile;
std::string AsSecureLogFile;

const char *Argv0 = nullptr;
ArrayRef<std::string> CommandLineArgs;
// Used for codeview debug info. These will be set as compiler path and commandline arguments in LF_BUILDINFO
std::string Argv0;
std::string CommandlineArgs;

/// Additional paths to search for `.include` directives when using the
/// integrated assembler.
Expand Down
43 changes: 5 additions & 38 deletions llvm/lib/CodeGen/AsmPrinter/CodeViewDebug.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -893,37 +893,6 @@ static TypeIndex getStringIdTypeIdx(GlobalTypeTableBuilder &TypeTable,
return TypeTable.writeLeafType(SIR);
}

static std::string flattenCommandLine(ArrayRef<std::string> Args,
StringRef MainFilename) {
std::string FlatCmdLine;
raw_string_ostream OS(FlatCmdLine);
bool PrintedOneArg = false;
if (!StringRef(Args[0]).contains("-cc1")) {
llvm::sys::printArg(OS, "-cc1", /*Quote=*/true);
PrintedOneArg = true;
}
for (unsigned i = 0; i < Args.size(); i++) {
StringRef Arg = Args[i];
if (Arg.empty())
continue;
if (Arg == "-main-file-name" || Arg == "-o") {
i++; // Skip this argument and next one.
continue;
}
if (Arg.starts_with("-object-file-name") || Arg == MainFilename)
continue;
// Skip fmessage-length for reproduciability.
if (Arg.starts_with("-fmessage-length"))
continue;
if (PrintedOneArg)
OS << " ";
llvm::sys::printArg(OS, Arg, /*Quote=*/true);
PrintedOneArg = true;
}
OS.flush();
return FlatCmdLine;
}

void CodeViewDebug::emitBuildInfo() {
// First, make LF_BUILDINFO. It's a sequence of strings with various bits of
// build info. The known prefix is:
Expand All @@ -947,13 +916,11 @@ void CodeViewDebug::emitBuildInfo() {
// FIXME: PDB is intentionally blank unless we implement /Zi type servers.
BuildInfoArgs[BuildInfoRecord::TypeServerPDB] =
getStringIdTypeIdx(TypeTable, "");
if (Asm->TM.Options.MCOptions.Argv0 != nullptr) {
BuildInfoArgs[BuildInfoRecord::BuildTool] =
getStringIdTypeIdx(TypeTable, Asm->TM.Options.MCOptions.Argv0);
BuildInfoArgs[BuildInfoRecord::CommandLine] = getStringIdTypeIdx(
TypeTable, flattenCommandLine(Asm->TM.Options.MCOptions.CommandLineArgs,
MainSourceFile->getFilename()));
}
BuildInfoArgs[BuildInfoRecord::BuildTool] =
getStringIdTypeIdx(TypeTable, Asm->TM.Options.MCOptions.Argv0);
BuildInfoArgs[BuildInfoRecord::CommandLine] = getStringIdTypeIdx(
TypeTable, Asm->TM.Options.MCOptions.CommandlineArgs);

BuildInfoRecord BIR(BuildInfoArgs);
TypeIndex BuildInfoIndex = TypeTable.writeLeafType(BIR);

Expand Down
4 changes: 2 additions & 2 deletions llvm/test/DebugInfo/COFF/build-info.ll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@

; CHECK: [[INFO_IDX:0x[^ ]*]] | LF_BUILDINFO
; CHECK-NEXT: 0x{{.*}}: `D:\src\scopes\clang`
; CHECK-NEXT: <no type>: ``
; CHECK-NEXT: 0x{{.*}}: ``
; CHECK-NEXT: 0x{{.*}}: `D:\src\scopes\foo.cpp`
; CHECK-NEXT: 0x{{.*}}: ``
; CHECK-NEXT: <no type>: ``
; CHECK-NEXT: 0x{{.*}}: ``

; CHECK: {{.*}} | S_BUILDINFO [size = 8] BuildId = `[[INFO_IDX]]`

Expand Down
4 changes: 2 additions & 2 deletions llvm/test/DebugInfo/COFF/global-type-hashes.ll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ attributes #3 = { mustprogress noinline nounwind optnone "frame-pointer"="none"
; YAML: String: ''
; YAML: - Kind: LF_BUILDINFO
; YAML: BuildInfo:
; YAML: ArgIndices: [ 4113, 0, 4114, 4115, 0 ]
; YAML: ArgIndices: [ 4113, 4115, 4114, 4115, 4115 ]
; YAML: - Name: '.debug$H'
; YAML: Characteristics: [ IMAGE_SCN_CNT_INITIALIZED_DATA, IMAGE_SCN_MEM_DISCARDABLE, IMAGE_SCN_MEM_READ ]
; YAML: Alignment: 4
Expand Down Expand Up @@ -328,7 +328,7 @@ attributes #3 = { mustprogress noinline nounwind optnone "frame-pointer"="none"
; YAML: - 174CF4A3F5448049
; YAML: - 5349856AF14E2246
; YAML: - 55A48E0466FDCDA6
; YAML: - 886A1B73D31E9877
; YAML: - EE6329A02D9F4959

; ASM: .section .debug$H,"dr"
; ASM-NEXT: .p2align 2
Expand Down
4 changes: 2 additions & 2 deletions llvm/test/DebugInfo/COFF/types-basic.ll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -525,10 +525,10 @@
; ASM: .short 0x1603 # Record kind: LF_BUILDINFO
; ASM: .short 0x5 # NumArgs
; ASM: .long 0x1013 # Argument: D:\src\llvm\build
; ASM: .long 0x0 # Argument
; ASM: .long 0x1015 # Argument
; ASM: .long 0x1014 # Argument: t.cpp
; ASM: .long 0x1015 # Argument
; ASM: .long 0x0 # Argument
; ASM: .long 0x1015 # Argument
; ASM: .byte 242
; ASM: .byte 241

Expand Down
4 changes: 2 additions & 2 deletions llvm/test/DebugInfo/COFF/types-data-members.ll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -740,10 +740,10 @@
; ASM: .short 0x1603 # Record kind: LF_BUILDINFO
; ASM: .short 0x5 # NumArgs
; ASM: .long 0x1020 # Argument: D:\src\llvm\build
; ASM: .long 0x0 # Argument
; ASM: .long 0x1022 # Argument
; ASM: .long 0x1021 # Argument: t.cpp
; ASM: .long 0x1022 # Argument
; ASM: .long 0x0 # Argument
; ASM: .long 0x1022 # Argument
; ASM: .byte 242
; ASM: .byte 241

Expand Down
Loading