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
|
// 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 "base/command_line.h"
#include "base/files/file_util.h"
#include "base/logging.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/utf_string_conversions.h"
#include "base/time/time.h"
#include "build/build_config.h"
#include "tools/gn/err.h"
#include "tools/gn/exec_process.h"
#include "tools/gn/filesystem_utils.h"
#include "tools/gn/functions.h"
#include "tools/gn/input_conversion.h"
#include "tools/gn/input_file.h"
#include "tools/gn/parse_tree.h"
#include "tools/gn/scheduler.h"
#include "tools/gn/trace.h"
#include "tools/gn/value.h"
namespace functions {
const char kExecScript[] = "exec_script";
const char kExecScript_HelpShort[] =
"exec_script: Synchronously run a script and return the output.";
const char kExecScript_Help[] =
"exec_script: Synchronously run a script and return the output.\n"
"\n"
" exec_script(filename,\n"
" arguments = [],\n"
" input_conversion = \"\",\n"
" file_dependencies = [])\n"
"\n"
" Runs the given script, returning the stdout of the script. The build\n"
" generation will fail if the script does not exist or returns a nonzero\n"
" exit code.\n"
"\n"
" The current directory when executing the script will be the root\n"
" build directory. If you are passing file names, you will want to use\n"
" the rebase_path() function to make file names relative to this\n"
" path (see \"gn help rebase_path\").\n"
"\n"
"Arguments:\n"
"\n"
" filename:\n"
" File name of python script to execute. Non-absolute names will\n"
" be treated as relative to the current build file.\n"
"\n"
" arguments:\n"
" A list of strings to be passed to the script as arguments.\n"
" May be unspecified or the empty list which means no arguments.\n"
"\n"
" input_conversion:\n"
" Controls how the file is read and parsed.\n"
" See \"gn help input_conversion\".\n"
"\n"
" If unspecified, defaults to the empty string which causes the\n"
" script result to be discarded. exec script will return None.\n"
"\n"
" dependencies:\n"
" (Optional) A list of files that this script reads or otherwise\n"
" depends on. These dependencies will be added to the build result\n"
" such that if any of them change, the build will be regenerated and\n"
" the script will be re-run.\n"
"\n"
" The script itself will be an implicit dependency so you do not\n"
" need to list it.\n"
"\n"
"Example:\n"
"\n"
" all_lines = exec_script(\n"
" \"myscript.py\", [some_input], \"list lines\",\n"
" [ rebase_path(\"data_file.txt\", root_build_dir) ])\n"
"\n"
" # This example just calls the script with no arguments and discards\n"
" # the result.\n"
" exec_script(\"//foo/bar/myscript.py\")\n";
Value RunExecScript(Scope* scope,
const FunctionCallNode* function,
const std::vector<Value>& args,
Err* err) {
if (args.size() < 1 || args.size() > 4) {
*err = Err(function->function(), "Wrong number of arguments to exec_script",
"I expected between one and four arguments.");
return Value();
}
const Settings* settings = scope->settings();
const BuildSettings* build_settings = settings->build_settings();
const SourceDir& cur_dir = scope->GetSourceDir();
// Find the python script to run.
if (!args[0].VerifyTypeIs(Value::STRING, err))
return Value();
SourceFile script_source =
cur_dir.ResolveRelativeFile(args[0].string_value(),
scope->settings()->build_settings()->root_path_utf8());
base::FilePath script_path = build_settings->GetFullPath(script_source);
if (!build_settings->secondary_source_path().empty() &&
!base::PathExists(script_path)) {
// Fall back to secondary source root when the file doesn't exist.
script_path = build_settings->GetFullPathSecondary(script_source);
}
ScopedTrace trace(TraceItem::TRACE_SCRIPT_EXECUTE, script_source.value());
trace.SetToolchain(settings->toolchain_label());
// Add all dependencies of this script, including the script itself, to the
// build deps.
g_scheduler->AddGenDependency(script_path);
if (args.size() == 4) {
const Value& deps_value = args[3];
if (!deps_value.VerifyTypeIs(Value::LIST, err))
return Value();
for (const auto& dep : deps_value.list_value()) {
if (!dep.VerifyTypeIs(Value::STRING, err))
return Value();
g_scheduler->AddGenDependency(
build_settings->GetFullPath(cur_dir.ResolveRelativeFile(
dep.string_value(),
scope->settings()->build_settings()->root_path_utf8())));
}
}
// Make the command line.
const base::FilePath& python_path = build_settings->python_path();
base::CommandLine cmdline(python_path);
cmdline.AppendArgPath(script_path);
if (args.size() >= 2) {
// Optional command-line arguments to the script.
const Value& script_args = args[1];
if (!script_args.VerifyTypeIs(Value::LIST, err))
return Value();
for (const auto& arg : script_args.list_value()) {
if (!arg.VerifyTypeIs(Value::STRING, err))
return Value();
cmdline.AppendArg(arg.string_value());
}
}
// Log command line for debugging help.
trace.SetCommandLine(cmdline);
base::TimeTicks begin_exec;
if (g_scheduler->verbose_logging()) {
#if defined(OS_WIN)
g_scheduler->Log("Pythoning",
base::UTF16ToUTF8(cmdline.GetCommandLineString()));
#else
g_scheduler->Log("Pythoning", cmdline.GetCommandLineString());
#endif
begin_exec = base::TimeTicks::Now();
}
base::FilePath startup_dir =
build_settings->GetFullPath(build_settings->build_dir());
// The first time a build is run, no targets will have been written so the
// build output directory won't exist. We need to make sure it does before
// running any scripts with this as its startup directory, although it will
// be relatively rare that the directory won't exist by the time we get here.
//
// If this shows up on benchmarks, we can cache whether we've done this
// or not and skip creating the directory.
base::CreateDirectory(startup_dir);
// Execute the process.
// TODO(brettw) set the environment block.
std::string output;
std::string stderr_output;
int exit_code = 0;
if (!internal::ExecProcess(
cmdline, startup_dir, &output, &stderr_output, &exit_code)) {
*err = Err(function->function(), "Could not execute python.",
"I was trying to execute \"" + FilePathToUTF8(python_path) + "\".");
return Value();
}
if (g_scheduler->verbose_logging()) {
g_scheduler->Log("Pythoning", script_source.value() + " took " +
base::Int64ToString(
(base::TimeTicks::Now() - begin_exec).InMilliseconds()) +
"ms");
}
if (exit_code != 0) {
std::string msg = "Current dir: " + FilePathToUTF8(startup_dir) +
"\nCommand: " + FilePathToUTF8(cmdline.GetCommandLineString()) +
"\nReturned " + base::IntToString(exit_code);
if (!output.empty())
msg += " and printed out:\n\n" + output;
else
msg += ".";
if (!stderr_output.empty())
msg += "\nstderr:\n\n" + stderr_output;
*err = Err(function->function(), "Script returned non-zero exit code.",
msg);
return Value();
}
// Default to None value for the input conversion if unspecified.
return ConvertInputToValue(scope->settings(), output, function,
args.size() >= 3 ? args[2] : Value(), err);
}
} // namespace functions
|
