From: Francis Visoiu Mistrih Date: Mon, 17 Jun 2019 16:06:00 +0000 (+0000) Subject: [Remarks] Extend -fsave-optimization-record to specify the format X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=978bbd3821eac88307ad1b1c14bc20a3ee80f485;p=clang [Remarks] Extend -fsave-optimization-record to specify the format Use -fsave-optimization-record= to specify a different format than the default, which is YAML. For now, only YAML is supported. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@363573 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/docs/UsersManual.rst b/docs/UsersManual.rst index 54ff02cce1..0e2d1c82e9 100644 --- a/docs/UsersManual.rst +++ b/docs/UsersManual.rst @@ -324,13 +324,21 @@ output format of the diagnostics that it generates. .. _opt_fsave-optimization-record: -**-fsave-optimization-record** - Write optimization remarks to a YAML file. +.. option:: -fsave-optimization-record[=] + + Write optimization remarks to a separate file. This option, which defaults to off, controls whether Clang writes - optimization reports to a YAML file. By recording diagnostics in a file, - using a structured YAML format, users can parse or sort the remarks in a - convenient way. + optimization reports to a separate file. By recording diagnostics in a file, + users can parse or sort the remarks in a convenient way. + + By default, the serialization format is YAML. + + The supported serialization formats are: + + - .. _opt_fsave_optimization_record_yaml: + + ``-fsave-optimization-record=yaml``: A structured YAML format. .. _opt_foptimization-record-file: diff --git a/include/clang/Basic/CodeGenOptions.h b/include/clang/Basic/CodeGenOptions.h index 7c936c49d3..2ece9e7f14 100644 --- a/include/clang/Basic/CodeGenOptions.h +++ b/include/clang/Basic/CodeGenOptions.h @@ -246,6 +246,9 @@ public: /// records. std::string OptRecordPasses; + /// The format used for serializing remarks (default: YAML) + std::string OptRecordFormat; + /// The name of the partition that symbols are assigned to, specified with /// -fsymbol-partition (see https://lld.llvm.org/Partitions.html). std::string SymbolPartition; diff --git a/include/clang/Basic/DiagnosticDriverKinds.td b/include/clang/Basic/DiagnosticDriverKinds.td index b66aa22964..dd86ca49b7 100644 --- a/include/clang/Basic/DiagnosticDriverKinds.td +++ b/include/clang/Basic/DiagnosticDriverKinds.td @@ -230,6 +230,8 @@ def err_drv_emit_llvm_link : Error< "-emit-llvm cannot be used when linking">; def err_drv_optimization_remark_pattern : Error< "in pattern '%1': %0">; +def err_drv_optimization_remark_format : Error< + "unknown remark serializer format: '%0'">; def err_drv_no_neon_modifier : Error<"[no]neon is not accepted as modifier, please use [no]simd instead">; def err_drv_invalid_omp_target : Error<"OpenMP target is invalid: '%0'">; def err_drv_omp_host_ir_file_not_found : Error< diff --git a/include/clang/Driver/CC1Options.td b/include/clang/Driver/CC1Options.td index 1d96f1e1ee..062aae1f11 100644 --- a/include/clang/Driver/CC1Options.td +++ b/include/clang/Driver/CC1Options.td @@ -636,6 +636,8 @@ def opt_record_file : Separate<["-"], "opt-record-file">, HelpText<"File name to use for YAML optimization record output">; def opt_record_passes : Separate<["-"], "opt-record-passes">, HelpText<"Only record remark information for passes whose names match the given regular expression">; +def opt_record_format : Separate<["-"], "opt-record-format">, + HelpText<"The format used for serializing remarks (default: YAML)">; def print_stats : Flag<["-"], "print-stats">, HelpText<"Print performance metrics and statistics">; diff --git a/include/clang/Driver/Options.td b/include/clang/Driver/Options.td index c9c9984ffa..628fa4435d 100644 --- a/include/clang/Driver/Options.td +++ b/include/clang/Driver/Options.td @@ -1717,6 +1717,8 @@ def foperator_arrow_depth_EQ : Joined<["-"], "foperator-arrow-depth=">, def fsave_optimization_record : Flag<["-"], "fsave-optimization-record">, Group, HelpText<"Generate a YAML optimization record file">; +def fsave_optimization_record_EQ : Joined<["-"], "fsave-optimization-record=">, + Group, HelpText<"Generate an optimization record file in a specific format (default: YAML)">; def fno_save_optimization_record : Flag<["-"], "fno-save-optimization-record">, Group, Flags<[NoArgumentUnused]>; def foptimization_record_file_EQ : Joined<["-"], "foptimization-record-file=">, diff --git a/lib/CodeGen/BackendUtil.cpp b/lib/CodeGen/BackendUtil.cpp index 46b075ff12..2a904d5434 100644 --- a/lib/CodeGen/BackendUtil.cpp +++ b/lib/CodeGen/BackendUtil.cpp @@ -1428,6 +1428,7 @@ static void runThinLTOBackend(ModuleSummaryIndex *CombinedIndex, Module *M, Conf.RemarksWithHotness = CGOpts.DiagnosticsWithHotness; Conf.RemarksFilename = CGOpts.OptRecordFile; Conf.RemarksPasses = CGOpts.OptRecordPasses; + Conf.RemarksFormat = CGOpts.OptRecordFormat; Conf.SplitDwarfFile = CGOpts.SplitDwarfFile; Conf.SplitDwarfOutput = CGOpts.SplitDwarfOutput; switch (Action) { diff --git a/lib/CodeGen/CodeGenAction.cpp b/lib/CodeGen/CodeGenAction.cpp index e8022c0e63..0ae9ea427d 100644 --- a/lib/CodeGen/CodeGenAction.cpp +++ b/lib/CodeGen/CodeGenAction.cpp @@ -266,6 +266,7 @@ namespace clang { Expected> OptRecordFileOrErr = setupOptimizationRemarks(Ctx, CodeGenOpts.OptRecordFile, CodeGenOpts.OptRecordPasses, + CodeGenOpts.OptRecordFormat, CodeGenOpts.DiagnosticsWithHotness, CodeGenOpts.DiagnosticsHotnessThreshold); @@ -279,6 +280,10 @@ namespace clang { [&](const RemarkSetupPatternError &E) { Diags.Report(diag::err_drv_optimization_remark_pattern) << E.message() << CodeGenOpts.OptRecordPasses; + }, + [&](const RemarkSetupFormatError &E) { + Diags.Report(diag::err_drv_optimization_remark_format) + << CodeGenOpts.OptRecordFormat; }); return; } diff --git a/lib/Driver/ToolChains/Clang.cpp b/lib/Driver/ToolChains/Clang.cpp index 91993a4400..9ec6f7d9a9 100644 --- a/lib/Driver/ToolChains/Clang.cpp +++ b/lib/Driver/ToolChains/Clang.cpp @@ -5079,6 +5079,8 @@ void Clang::ConstructJob(Compilation &C, const JobAction &JA, if (Args.hasFlag(options::OPT_fsave_optimization_record, options::OPT_foptimization_record_file_EQ, options::OPT_fno_save_optimization_record, false) || + Args.hasFlag(options::OPT_fsave_optimization_record_EQ, + options::OPT_fno_save_optimization_record, false) || Args.hasFlag(options::OPT_foptimization_record_passes_EQ, options::OPT_fno_save_optimization_record, false)) { CmdArgs.push_back("-opt-record-file"); @@ -5119,6 +5121,12 @@ void Clang::ConstructJob(Compilation &C, const JobAction &JA, CmdArgs.push_back("-opt-record-passes"); CmdArgs.push_back(A->getValue()); } + + if (const Arg *A = + Args.getLastArg(options::OPT_fsave_optimization_record_EQ)) { + CmdArgs.push_back("-opt-record-format"); + CmdArgs.push_back(A->getValue()); + } } bool RewriteImports = Args.hasFlag(options::OPT_frewrite_imports, diff --git a/lib/Driver/ToolChains/Darwin.cpp b/lib/Driver/ToolChains/Darwin.cpp index 478e1111e1..fbdc0b5018 100644 --- a/lib/Driver/ToolChains/Darwin.cpp +++ b/lib/Driver/ToolChains/Darwin.cpp @@ -462,6 +462,7 @@ void darwin::Linker::ConstructJob(Compilation &C, const JobAction &JA, // For LTO, pass the name of the optimization record file and other // opt-remarks flags. if (Args.hasFlag(options::OPT_fsave_optimization_record, + options::OPT_fsave_optimization_record_EQ, options::OPT_fno_save_optimization_record, false)) { CmdArgs.push_back("-mllvm"); CmdArgs.push_back("-lto-pass-remarks-output"); @@ -492,6 +493,14 @@ void darwin::Linker::ConstructJob(Compilation &C, const JobAction &JA, std::string("-lto-pass-remarks-filter=") + A->getValue(); CmdArgs.push_back(Args.MakeArgString(Passes)); } + + if (const Arg *A = + Args.getLastArg(options::OPT_fsave_optimization_record_EQ)) { + CmdArgs.push_back("-mllvm"); + std::string Format = + std::string("-lto-pass-remarks-format=") + A->getValue(); + CmdArgs.push_back(Args.MakeArgString(Format)); + } } // Propagate the -moutline flag to the linker in LTO. diff --git a/lib/Frontend/CompilerInvocation.cpp b/lib/Frontend/CompilerInvocation.cpp index da7ed04bc4..fc49aa6f86 100644 --- a/lib/Frontend/CompilerInvocation.cpp +++ b/lib/Frontend/CompilerInvocation.cpp @@ -1237,6 +1237,11 @@ static bool ParseCodeGenArgs(CodeGenOptions &Opts, ArgList &Args, InputKind IK, NeedLocTracking = true; } + if (Arg *A = Args.getLastArg(OPT_opt_record_format)) { + Opts.OptRecordFormat = A->getValue(); + NeedLocTracking = true; + } + if (Arg *A = Args.getLastArg(OPT_Rpass_EQ)) { Opts.OptimizationRemarkPattern = GenerateOptimizationRemarkRegex(Diags, Args, A); diff --git a/test/CodeGen/opt-record-MIR.c b/test/CodeGen/opt-record-MIR.c index f9b4e74580..731c6591c2 100644 --- a/test/CodeGen/opt-record-MIR.c +++ b/test/CodeGen/opt-record-MIR.c @@ -5,6 +5,8 @@ // RUN: cat %t.yaml | FileCheck -check-prefix=YAML %s // RUN: %clang_cc1 -triple arm64-apple-ios -S -o /dev/null %s -O2 -dwarf-column-info -opt-record-file %t.yaml -opt-record-passes asm-printer // RUN: cat %t.yaml | FileCheck -check-prefix=PASSES %s +// RUN: %clang_cc1 -triple arm64-apple-ios -S -o /dev/null %s -O2 -dwarf-column-info -opt-record-file %t.yaml -opt-record-format yaml +// RUN: cat %t.yaml | FileCheck -check-prefix=YAML %s void bar(float); diff --git a/test/CodeGen/opt-record.c b/test/CodeGen/opt-record.c index da32f35728..481b45d9e9 100644 --- a/test/CodeGen/opt-record.c +++ b/test/CodeGen/opt-record.c @@ -6,6 +6,9 @@ // RUN: %clang_cc1 -O3 -triple x86_64-unknown-linux-gnu -target-cpu x86-64 %s -o %t -dwarf-column-info -opt-record-file %t.yaml -opt-record-passes inline -emit-obj // RUN: cat %t.yaml | FileCheck -check-prefix=CHECK-PASSES %s // RUN: not %clang_cc1 -O3 -triple x86_64-unknown-linux-gnu -target-cpu x86-64 %s -o %t -dwarf-column-info -opt-record-file %t.yaml -opt-record-passes "(foo" -emit-obj 2>&1 | FileCheck -check-prefix=CHECK-PATTERN-ERROR %s +// RUN: %clang_cc1 -O3 -triple x86_64-unknown-linux-gnu -target-cpu x86-64 %s -o %t -dwarf-column-info -opt-record-file %t.yaml -opt-record-format yaml -emit-obj +// RUN: cat %t.yaml | FileCheck %s +// RUN: not %clang_cc1 -O3 -triple x86_64-unknown-linux-gnu -target-cpu x86-64 %s -o %t -dwarf-column-info -opt-record-file %t.yaml -opt-record-format "unknown-format" -emit-obj 2>&1 | FileCheck -check-prefix=CHECK-FORMAT-ERROR %s // REQUIRES: x86-registered-target void bar(); @@ -37,3 +40,5 @@ void Test(int *res, int *c, int *d, int *p, int n) { // CHECK-PASSES-NOT: loop-vectorize // CHECK-PATTERN-ERROR: error: in pattern '(foo': parentheses not balanced + +// CHECK-FORMAT-ERROR: error: unknown remark serializer format: 'unknown-format' diff --git a/test/Driver/darwin-ld.c b/test/Driver/darwin-ld.c index 6886fbad25..9dc31297e8 100644 --- a/test/Driver/darwin-ld.c +++ b/test/Driver/darwin-ld.c @@ -330,6 +330,10 @@ // RUN: %clang -target x86_64-apple-darwin12 %t.o -fsave-optimization-record -foptimization-record-passes=inline -### -o foo/bar.out 2> %t.log // RUN: FileCheck -check-prefix=PASS_REMARKS_WITH_PASSES %s < %t.log // PASS_REMARKS_WITH_PASSES: "-mllvm" "-lto-pass-remarks-output" "-mllvm" "foo/bar.out.opt.yaml" "-mllvm" "-lto-pass-remarks-filter=inline" +// +// RUN: %clang -target x86_64-apple-darwin12 %t.o -fsave-optimization-record=some-format -### -o foo/bar.out 2> %t.log +// RUN: FileCheck -check-prefix=PASS_REMARKS_WITH_FORMAT %s < %t.log +// PASS_REMARKS_WITH_FORMAT: "-mllvm" "-lto-pass-remarks-output" "-mllvm" "foo/bar.out.opt.yaml" "-mllvm" "-lto-pass-remarks-format=some-format" // RUN: %clang -target x86_64-apple-ios6.0 -miphoneos-version-min=6.0 -fprofile-instr-generate -### %t.o 2> %t.log // RUN: FileCheck -check-prefix=LINK_PROFILE_FIRST %s < %t.log diff --git a/test/Driver/opt-record.c b/test/Driver/opt-record.c index 44ad4a2a6b..f7dd5eb740 100644 --- a/test/Driver/opt-record.c +++ b/test/Driver/opt-record.c @@ -15,6 +15,9 @@ // RUN: %clang -### -S -o FOO -fsave-optimization-record -foptimization-record-passes=inline %s 2>&1 | FileCheck %s -check-prefix=CHECK-EQ-PASSES // RUN: %clang -### -S -o FOO -foptimization-record-passes=inline %s 2>&1 | FileCheck %s -check-prefix=CHECK-EQ-PASSES // RUN: %clang -### -S -o FOO -foptimization-record-passes=inline -fno-save-optimization-record %s 2>&1 | FileCheck %s --check-prefix=CHECK-FOPT-DISABLE-PASSES +// RUN: %clang -### -S -o FOO -fsave-optimization-record -fsave-optimization-record=some-format %s 2>&1 | FileCheck %s -check-prefix=CHECK-EQ-FORMAT +// RUN: %clang -### -S -o FOO -fsave-optimization-record=some-format %s 2>&1 | FileCheck %s -check-prefix=CHECK-EQ-FORMAT +// RUN: %clang -### -S -o FOO -fsave-optimization-record=some-format -fno-save-optimization-record %s 2>&1 | FileCheck %s --check-prefix=CHECK-FOPT-DISABLE-FORMAT // // CHECK: "-cc1" // CHECK: "-opt-record-file" "FOO.opt.yaml" @@ -32,3 +35,8 @@ // CHECK-EQ-PASSES: "-opt-record-passes" "inline" // CHECK-FOPT-DISABLE-PASSES-NOT: "-fno-save-optimization-record" + +// CHECK-EQ-FORMAT: "-cc1" +// CHECK-EQ-FORMAT: "-opt-record-format" "some-format" + +// CHECK-FOPT-DISABLE-FORMAT-NOT: "-fno-save-optimization-record"