Group missing generated input errors by target and improve error messages. Generated-input validation previously grouped errors by generated file, which is inconsistent with the rest of GN. Grouping it by target also allows us to output error messages containing suggested fixes. Bug: 556959580 Change-Id: Ie0625e6b8ac9c2c4926c3c878daf0f9e6a6a6964 Reviewed-on: https://gn-review.googlesource.com/c/gn/+/28780 Commit-Queue: Matt Stark <msta@google.com> Reviewed-by: Takuto Ikuta <tikuta@google.com>
diff --git a/src/gn/command_gen.cc b/src/gn/command_gen.cc index 1d6668a..704e504 100644 --- a/src/gn/command_gen.cc +++ b/src/gn/command_gen.cc
@@ -4,8 +4,12 @@ #include <inttypes.h> +#include <algorithm> +#include <map> #include <mutex> +#include <set> #include <thread> +#include <tuple> #include <unordered_map> #include "base/command_line.h" @@ -17,6 +21,7 @@ #include "gn/commands.h" #include "gn/compile_commands_writer.h" #include "gn/eclipse_writer.h" +#include "gn/err.h" #include "gn/filesystem_utils.h" #include "gn/json_project_writer.h" #include "gn/label_pattern.h" @@ -24,6 +29,7 @@ #include "gn/ninja_target_writer.h" #include "gn/ninja_tools.h" #include "gn/ninja_writer.h" +#include "gn/output_file.h" #include "gn/qt_creator_writer.h" #include "gn/runtime_deps.h" #include "gn/rust_project_writer.h" @@ -146,100 +152,116 @@ } } -// Returns a pointer to the target with the given file as an output, or null -// if no targets generate the file. This is brute force since this is an -// error condition and performance shouldn't matter. -const Target* FindTargetThatGeneratesFile(const Builder& builder, - const SourceFile& file) { - std::vector<const Target*> targets = builder.GetAllResolvedTargets(); - if (targets.empty()) - return nullptr; - - OutputFile output_file(targets[0]->settings()->build_settings(), file); - for (const Target* target : targets) { - for (const auto& cur_output : target->computed_outputs()) { - if (cur_output == output_file) - return target; - } +struct CompareTargets { + bool operator()(const Target* lhs, const Target* rhs) const { + if (!lhs) + return false; + if (!rhs) + return true; + auto key = [](const Target* target) { + const Label& l = target->label(); + return std::make_tuple( + l.dir(), l.name_atom(), !target->settings()->is_default(), + l.toolchain_dir(), l.toolchain_name_atom(), target); + }; + return key(lhs) < key(rhs); } - return nullptr; +}; + +template <typename T> +using OrderedTargetMap = std::map<const Target*, T, CompareTargets>; + +// Returns an error for a target that declared source or input files in the +// output directory without the required dependency on the generating target. +Err CreateInvalidGeneratedInputError( + const Target* target, + const OrderedTargetMap<std::set<SourceFile>>& missing_files) { + const Label& default_toolchain = + target->settings()->default_toolchain_label(); + + std::string err = "The target:\n " + + target->label().GetUserVisibleName(default_toolchain) + + "\n"; + size_t file_count = 0; + for (const auto& [generator, files] : missing_files) + file_count += files.size(); + err += file_count > 1 + ? "has inputs or sources not generated by any dependencies:\n" + : "has an input or source not generated by any dependencies:\n"; + + std::string deps_str; + for (const auto& [generator, files] : missing_files) { + std::string suffix; + if (generator) { + std::string gen_name = generator->label().AsRelative(target->label()); + suffix = " (generated by " + gen_name + ")\n"; + deps_str += " " + gen_name; + } else { + suffix = " (not generated by any target)\n"; + } + for (const SourceFile& file : files) + err += " " + file.value() + suffix; + } + + if (!deps_str.empty()) { + err += "\nTo fix this, run:\n gn edit \"add deps" + deps_str + "\" " + + target->label().GetUserVisibleName(false); + } else if (!err.empty() && err.back() == '\n') { + err.pop_back(); + } + + return Err(Location(), "Input to target not generated by a dependency.", err); } -// Prints an error that the given file was present as a source or input in -// the given target(s) but was not generated by any of its dependencies. -// Returns true if the error was actually printed, or false if it was -// suppressed. -bool PrintInvalidGeneratedInput(const Builder& builder, - const SourceFile& file, - const std::vector<const Target*>& targets) { - std::string err; +using UnknownGeneratedInputs = std::multimap<SourceFile, const Target*>; - // Only show the toolchain labels (which can be confusing) if something - // isn't the default. - bool show_toolchains = false; - const Label& default_toolchain = - targets[0]->settings()->default_toolchain_label(); - for (const Target* target : targets) { - if (target->settings()->toolchain_label() != default_toolchain) { - show_toolchains = true; - break; - } +std::vector<Err> ComputeInvalidGeneratedInputErrors( + const UnknownGeneratedInputs& unknown_inputs, + const std::vector<const Target*>& all_targets) { + if (unknown_inputs.empty()) + return {}; + + std::unordered_map<OutputFile, const Target*> generators; + for (const Target* target : all_targets) { + for (const OutputFile& output : target->computed_outputs()) + generators.emplace(output, target); } - const Target* generator = FindTargetThatGeneratesFile(builder, file); - if (generator && - generator->settings()->toolchain_label() != default_toolchain) - show_toolchains = true; - - const std::string target_str = targets.size() > 1 ? "targets" : "target"; - err += "The file:\n"; - err += " " + file.value() + "\n"; - err += "is listed as an input or source for the " + target_str + ":\n"; - for (const Target* target : targets) - err += " " + target->label().GetUserVisibleName(show_toolchains) + "\n"; - - if (generator) { - err += "but this file was not generated by any dependencies of the " + - target_str + ". The target\nthat generates the file is:\n "; - err += generator->label().GetUserVisibleName(show_toolchains); - } else { - err += "but no targets in the build generate that file."; + // Map from Target with missing inputs to target generating a set of inputs. + OrderedTargetMap<OrderedTargetMap<std::set<SourceFile>>> by_target; + for (const auto& [file, target] : unknown_inputs) { + auto it = + generators.find(OutputFile(target->settings()->build_settings(), file)); + const Target* generator = it != generators.end() ? it->second : nullptr; + by_target[target][generator].insert(file); } - return Err(Location(), - "Input to " + target_str + " not generated by a dependency.", err) - .PrintToStdout(); + std::vector<Err> errors; + Label prev_target_label; + // Only print one toolchain per target. + // If //foo(//tc1) and //foo(//tc2) is failing, it's probably the same error. + for (const auto& [target, missing] : by_target) { + Label label_without_toolchain = target->label().GetWithNoToolchain(); + if (label_without_toolchain == prev_target_label) + continue; + prev_target_label = std::move(label_without_toolchain); + errors.push_back(CreateInvalidGeneratedInputError(target, missing)); + } + return errors; } bool CheckForInvalidGeneratedInputs(Setup* setup) { - std::multimap<SourceFile, const Target*> unknown_inputs = + UnknownGeneratedInputs unknown_inputs = g_scheduler->GetUnknownGeneratedInputs(); if (unknown_inputs.empty()) return true; // No bad files. - int errors_found = 0; - bool print_errors = true; - auto cur = unknown_inputs.begin(); - while (cur != unknown_inputs.end()) { - errors_found++; - auto end_of_range = unknown_inputs.upper_bound(cur->first); - - if (print_errors) { - // Package the values more conveniently for printing. - SourceFile bad_input = cur->first; - std::vector<const Target*> targets; - auto temp_cur = cur; - while (temp_cur != end_of_range) - targets.push_back((temp_cur++)->second); - - if (PrintInvalidGeneratedInput(setup->builder(), bad_input, targets)) { - OutputString("\n"); - } else { - print_errors = false; - } - } - - cur = end_of_range; + std::vector<Err> errors = ComputeInvalidGeneratedInputErrors( + unknown_inputs, setup->builder().GetAllResolvedTargets()); + for (const Err& err : errors) { + if (!err.PrintToStdout()) + break; + OutputString("\n"); } OutputString( @@ -250,9 +272,9 @@ "you think a dependency chain exists, it might be\nbecause the chain " "is private. Try \"gn path\" to analyze.\n"); - if (errors_found > 1) { - OutputString(base::StringPrintf("\n%d generated input errors found.\n", - errors_found), + if (errors.size() > 1) { + OutputString("\n" + base::NumberToString(errors.size()) + + " generated input errors found.\n", DECORATION_YELLOW); } return false; @@ -971,4 +993,13 @@ return 0; } +std::vector<Err> GetInvalidGeneratedInputErrors( + const std::vector<const Target*>& all_targets) { + UnknownGeneratedInputs unknown_inputs = + g_scheduler->GetUnknownGeneratedInputs(); + if (unknown_inputs.empty()) + return {}; + return ComputeInvalidGeneratedInputErrors(unknown_inputs, all_targets); +} + } // namespace commands
diff --git a/src/gn/commands.h b/src/gn/commands.h index f9228a3..f725c92 100644 --- a/src/gn/commands.h +++ b/src/gn/commands.h
@@ -18,6 +18,7 @@ #include "base/values.h" #include "gn/build_file_editor.h" +#include "gn/err.h" #include "gn/header_checker.h" #include "gn/standard_out.h" #include "gn/target.h" @@ -71,6 +72,12 @@ extern const char kGen_Help[]; int RunGen(const std::vector<std::string>& args); +// Returns one Err per target (deduplicated across toolchains) that declared a +// source or input file in the output directory without the required generating +// dependency. Exposed for testing. +std::vector<Err> GetInvalidGeneratedInputErrors( + const std::vector<const Target*>& all_targets); + extern const char kFormat[]; extern const char kFormat_HelpShort[]; extern const char kFormat_Help[];
diff --git a/src/gn/commands_unittest.cc b/src/gn/commands_unittest.cc index 5f241ba..b1abd5d 100644 --- a/src/gn/commands_unittest.cc +++ b/src/gn/commands_unittest.cc
@@ -8,9 +8,12 @@ #include "base/command_line.h" #include "base/values.h" +#include "gn/err.h" #include "gn/label_pattern.h" #include "gn/standard_out.h" +#include "gn/substitution_list.h" #include "gn/target.h" +#include "gn/test_with_scheduler.h" #include "gn/test_with_scope.h" #include "util/test/test.h" @@ -237,3 +240,137 @@ commands::CommandSwitches::Set(empty_switches); } } + +using CommandsGenTest = TestWithScheduler; + +TEST_F(CommandsGenTest, InvalidGeneratedInputErrors) { + TestWithScope setup; + Err err; + + // Name the secondary toolchain directory so it sorts before + // //toolchain:default lexicographically, verifying is_default takes priority. + Toolchain alt_toolchain(setup.settings(), Label(SourceDir("//aaa/"), "alt")); + TestWithScope::SetupToolchain(&alt_toolchain); + Settings alt_settings(setup.build_settings(), "alt/"); + alt_settings.set_toolchain_label(alt_toolchain.label()); + alt_settings.set_default_toolchain_label(setup.toolchain()->label()); + + TestTarget gen_alpha(setup, "//gen:alpha", Target::ACTION); + gen_alpha.action_values().outputs() = + SubstitutionList::MakeForTest("//out/Debug/z.cc"); + ASSERT_TRUE(gen_alpha.OnResolved(&err)); + + TestTarget gen_beta(setup, "//gen:beta", Target::ACTION); + gen_beta.action_values().outputs() = + SubstitutionList::MakeForTest("//out/Debug/b.cc", "//out/Debug/a.cc"); + ASSERT_TRUE(gen_beta.OnResolved(&err)); + + Target alt_gen(&alt_settings, Label(SourceDir("//gen/"), "alt_gen", + alt_toolchain.label().dir(), + alt_toolchain.label().name())); + alt_gen.visibility().SetPublic(); + alt_gen.set_output_type(Target::ACTION); + ASSERT_TRUE(alt_gen.SetToolchain(&alt_toolchain, &err)); + alt_gen.action_values().outputs() = + SubstitutionList::MakeForTest("//out/Debug/alt/alt.cc"); + ASSERT_TRUE(alt_gen.OnResolved(&err)); + + TestTarget single_missing(setup, "//a:single_missing", Target::SOURCE_SET); + single_missing.sources().emplace_back("//out/Debug/z.cc"); + ASSERT_TRUE(single_missing.OnResolved(&err)); + + TestTarget grouped_by_gen(setup, "//b:grouped_by_gen", Target::SOURCE_SET); + grouped_by_gen.sources().emplace_back("//out/Debug/missing.cc"); + grouped_by_gen.sources().emplace_back("//out/Debug/b.cc"); + grouped_by_gen.sources().emplace_back("//out/Debug/z.cc"); + grouped_by_gen.sources().emplace_back("//out/Debug/a.cc"); + ASSERT_TRUE(grouped_by_gen.OnResolved(&err)); + + Target multi_tc_alt(&alt_settings, Label(SourceDir("//e/"), "multi_tc", + alt_toolchain.label().dir(), + alt_toolchain.label().name())); + multi_tc_alt.visibility().SetPublic(); + multi_tc_alt.set_output_type(Target::SOURCE_SET); + ASSERT_TRUE(multi_tc_alt.SetToolchain(&alt_toolchain, &err)); + multi_tc_alt.sources().emplace_back("//out/Debug/alt/missing.cc"); + ASSERT_TRUE(multi_tc_alt.OnResolved(&err)); + + TestTarget multi_tc_default(setup, "//e:multi_tc", Target::SOURCE_SET); + multi_tc_default.sources().emplace_back("//out/Debug/alt/alt.cc"); + ASSERT_TRUE(multi_tc_default.OnResolved(&err)); + + Target alt_only(&alt_settings, Label(SourceDir("//f/"), "alt_only", + alt_toolchain.label().dir(), + alt_toolchain.label().name())); + alt_only.visibility().SetPublic(); + alt_only.set_output_type(Target::SOURCE_SET); + ASSERT_TRUE(alt_only.SetToolchain(&alt_toolchain, &err)); + alt_only.sources().emplace_back("//out/Debug/alt/missing.cc"); + ASSERT_TRUE(alt_only.OnResolved(&err)); + + // Pass targets out of order to verify deterministic target sorting. + std::vector<Err> errors = commands::GetInvalidGeneratedInputErrors({ + &alt_only, + &multi_tc_default, + &multi_tc_alt, + &grouped_by_gen, + &single_missing, + &alt_gen, + &gen_beta, + &gen_alpha, + }); + ASSERT_EQ(4u, errors.size()); + + // Single missing file uses singular phrasing. + EXPECT_EQ("Input to target not generated by a dependency.", + errors[0].message()); + EXPECT_EQ( + "The target:\n" + " //a:single_missing\n" + "has an input or source not generated by any dependencies:\n" + " //out/Debug/z.cc (generated by //gen:alpha)\n" + "\n" + "To fix this, run:\n" + " gn edit \"add deps //gen:alpha\" //a:single_missing", + errors[0].help_text()); + + // Files are grouped by generator target, sorted by path, with ungenerated + // files last. + EXPECT_EQ("Input to target not generated by a dependency.", + errors[1].message()); + EXPECT_EQ( + "The target:\n" + " //b:grouped_by_gen\n" + "has inputs or sources not generated by any dependencies:\n" + " //out/Debug/z.cc (generated by //gen:alpha)\n" + " //out/Debug/a.cc (generated by //gen:beta)\n" + " //out/Debug/b.cc (generated by //gen:beta)\n" + " //out/Debug/missing.cc (not generated by any target)\n" + "\n" + "To fix this, run:\n" + " gn edit \"add deps //gen:alpha //gen:beta\" //b:grouped_by_gen", + errors[1].help_text()); + + // Toolchain deduplication prefers default toolchain and prints dep toolchain. + EXPECT_EQ("Input to target not generated by a dependency.", + errors[2].message()); + EXPECT_EQ( + "The target:\n" + " //e:multi_tc\n" + "has an input or source not generated by any dependencies:\n" + " //out/Debug/alt/alt.cc (generated by //gen:alt_gen(//aaa:alt))\n" + "\n" + "To fix this, run:\n" + " gn edit \"add deps //gen:alt_gen(//aaa:alt)\" //e:multi_tc", + errors[2].help_text()); + + // Non-default target with only ungenerated inputs omits gn edit instructions. + EXPECT_EQ("Input to target not generated by a dependency.", + errors[3].message()); + EXPECT_EQ( + "The target:\n" + " //f:alt_only(//aaa:alt)\n" + "has an input or source not generated by any dependencies:\n" + " //out/Debug/alt/missing.cc (not generated by any target)", + errors[3].help_text()); +}