1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
// Copyright (c) 2013 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "tools/gn/ninja_action_target_writer.h"
#include "base/strings/string_util.h"
#include "tools/gn/deps_iterator.h"
#include "tools/gn/err.h"
#include "tools/gn/settings.h"
#include "tools/gn/string_utils.h"
#include "tools/gn/substitution_writer.h"
#include "tools/gn/target.h"
NinjaActionTargetWriter::NinjaActionTargetWriter(const Target* target,
std::ostream& out)
: NinjaTargetWriter(target, out),
path_output_no_escaping_(
target->settings()->build_settings()->build_dir(),
target->settings()->build_settings()->root_path_utf8(),
ESCAPE_NONE) {
}
NinjaActionTargetWriter::~NinjaActionTargetWriter() {
}
void NinjaActionTargetWriter::Run() {
std::string custom_rule_name = WriteRuleDefinition();
// Collect our deps to pass as "extra hard dependencies" for input deps. This
// will force all of the action's dependencies to be completed before the
// action is run. Usually, if an action has a dependency, it will be
// operating on the result of that previous step, so we need to be sure to
// serialize these.
std::vector<const Target*> extra_hard_deps;
for (const auto& pair : target_->GetDeps(Target::DEPS_LINKED))
extra_hard_deps.push_back(pair.ptr);
// For ACTIONs this is a bit inefficient since it creates an input dep
// stamp file even though we're only going to use it once. It would save a
// build step to skip this and write the order-only deps directly on the
// build rule. This should probably be handled by WriteInputDepsStampAndGetDep
// automatically if we supply a count of sources (so it can optimize based on
// how many times things would be duplicated).
OutputFile input_dep = WriteInputDepsStampAndGetDep(extra_hard_deps);
out_ << std::endl;
// Collects all output files for writing below.
std::vector<OutputFile> output_files;
if (target_->output_type() == Target::ACTION_FOREACH) {
// Write separate build lines for each input source file.
WriteSourceRules(custom_rule_name, input_dep, &output_files);
} else {
DCHECK(target_->output_type() == Target::ACTION);
// Write a rule that invokes the script once with the outputs as outputs,
// and the data as inputs. It does not depend on the sources.
out_ << "build";
SubstitutionWriter::GetListAsOutputFiles(
settings_, target_->action_values().outputs(), &output_files);
path_output_.WriteFiles(out_, output_files);
out_ << ": " << custom_rule_name;
if (!input_dep.value().empty()) {
// As in WriteSourceRules, we want to force this target to rebuild any
// time any of its dependencies change.
out_ << " | ";
path_output_.WriteFile(out_, input_dep);
}
out_ << std::endl;
if (target_->action_values().has_depfile()) {
out_ << " depfile = ";
WriteDepfile(SourceFile());
out_ << std::endl;
}
}
out_ << std::endl;
// Write the stamp, which also depends on all data deps. These are needed at
// runtime and should be compiled when the action is, but don't need to be
// done before we run the action.
std::vector<OutputFile> data_outs;
for (const auto& dep : target_->data_deps())
data_outs.push_back(dep.ptr->dependency_output_file());
WriteStampForTarget(output_files, data_outs);
}
std::string NinjaActionTargetWriter::WriteRuleDefinition() {
// Make a unique name for this rule.
//
// Use a unique name for the response file when there are multiple build
// steps so that they don't stomp on each other. When there are no sources,
// there will be only one invocation so we can use a simple name.
std::string target_label = target_->label().GetUserVisibleName(true);
std::string custom_rule_name(target_label);
base::ReplaceChars(custom_rule_name, ":/()", "_", &custom_rule_name);
custom_rule_name.append("_rule");
const SubstitutionList& args = target_->action_values().args();
EscapeOptions args_escape_options;
args_escape_options.mode = ESCAPE_NINJA_COMMAND;
if (settings_->IsWin()) {
// Send through gyp-win-tool and use a response file.
std::string rspfile = custom_rule_name;
if (!target_->sources().empty())
rspfile += ".$unique_name";
rspfile += ".rsp";
out_ << "rule " << custom_rule_name << std::endl;
out_ << " command = ";
path_output_.WriteFile(out_, settings_->build_settings()->python_path());
// TODO(brettw) this hardcodes "environment.x86" which is something that
// the Chrome Windows toolchain writes. We should have a way to invoke
// python without requiring this gyp_win_tool thing.
out_ << " gyp-win-tool action-wrapper environment.x86 " << rspfile
<< std::endl;
out_ << " description = ACTION " << target_label << std::endl;
out_ << " restat = 1" << std::endl;
out_ << " rspfile = " << rspfile << std::endl;
// The build command goes in the rsp file.
out_ << " rspfile_content = ";
path_output_.WriteFile(out_, settings_->build_settings()->python_path());
out_ << " ";
path_output_.WriteFile(out_, target_->action_values().script());
for (const auto& arg : args.list()) {
out_ << " ";
SubstitutionWriter::WriteWithNinjaVariables(
arg, args_escape_options, out_);
}
out_ << std::endl;
} else {
// Posix can execute Python directly.
out_ << "rule " << custom_rule_name << std::endl;
out_ << " command = ";
path_output_.WriteFile(out_, settings_->build_settings()->python_path());
out_ << " ";
path_output_.WriteFile(out_, target_->action_values().script());
for (const auto& arg : args.list()) {
out_ << " ";
SubstitutionWriter::WriteWithNinjaVariables(
arg, args_escape_options, out_);
}
out_ << std::endl;
out_ << " description = ACTION " << target_label << std::endl;
out_ << " restat = 1" << std::endl;
}
return custom_rule_name;
}
void NinjaActionTargetWriter::WriteSourceRules(
const std::string& custom_rule_name,
const OutputFile& input_dep,
std::vector<OutputFile>* output_files) {
EscapeOptions args_escape_options;
args_escape_options.mode = ESCAPE_NINJA_COMMAND;
// We're writing the substitution values, these should not be quoted since
// they will get pasted into the real command line.
args_escape_options.inhibit_quoting = true;
const std::vector<SubstitutionType>& args_substitutions_used =
target_->action_values().args().required_types();
const Target::FileList& sources = target_->sources();
for (size_t i = 0; i < sources.size(); i++) {
out_ << "build";
WriteOutputFilesForBuildLine(sources[i], output_files);
out_ << ": " << custom_rule_name << " ";
path_output_.WriteFile(out_, sources[i]);
if (!input_dep.value().empty()) {
// Using "|" for the dependencies forces all implicit dependencies to be
// fully up-to-date before running the action, and will re-run this
// action if any input dependencies change. This is important because
// this action may consume the outputs of previous steps.
out_ << " | ";
path_output_.WriteFile(out_, input_dep);
}
out_ << std::endl;
// Windows needs a unique ID for the response file.
if (target_->settings()->IsWin())
out_ << " unique_name = " << i << std::endl;
SubstitutionWriter::WriteNinjaVariablesForSource(
settings_, sources[i], args_substitutions_used,
args_escape_options, out_);
if (target_->action_values().has_depfile()) {
out_ << " depfile = ";
WriteDepfile(sources[i]);
out_ << std::endl;
}
}
}
void NinjaActionTargetWriter::WriteOutputFilesForBuildLine(
const SourceFile& source,
std::vector<OutputFile>* output_files) {
size_t first_output_index = output_files->size();
SubstitutionWriter::ApplyListToSourceAsOutputFile(
settings_, target_->action_values().outputs(), source, output_files);
for (size_t i = first_output_index; i < output_files->size(); i++) {
out_ << " ";
path_output_.WriteFile(out_, (*output_files)[i]);
}
}
void NinjaActionTargetWriter::WriteDepfile(const SourceFile& source) {
path_output_.WriteFile(out_,
SubstitutionWriter::ApplyPatternToSourceAsOutputFile(
settings_, target_->action_values().depfile(), source));
}
|
