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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
|
// 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/file_util.h"
#include "base/logging.h"
#include "base/process/kill.h"
#include "base/process/launch.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/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"
#if defined(OS_WIN)
#include <windows.h>
#include "base/win/scoped_handle.h"
#include "base/win/scoped_process_information.h"
#endif
#if defined(OS_POSIX)
#include <fcntl.h>
#include <unistd.h>
#include "base/posix/file_descriptor_shuffle.h"
#endif
namespace functions {
namespace {
const char kNoExecSwitch[] = "no-exec";
#if defined(OS_WIN)
bool ExecProcess(const CommandLine& cmdline,
const base::FilePath& startup_dir,
std::string* std_out,
std::string* std_err,
int* exit_code) {
SECURITY_ATTRIBUTES sa_attr;
// Set the bInheritHandle flag so pipe handles are inherited.
sa_attr.nLength = sizeof(SECURITY_ATTRIBUTES);
sa_attr.bInheritHandle = TRUE;
sa_attr.lpSecurityDescriptor = NULL;
// Create the pipe for the child process's STDOUT.
HANDLE out_read = NULL;
HANDLE out_write = NULL;
if (!CreatePipe(&out_read, &out_write, &sa_attr, 0)) {
NOTREACHED() << "Failed to create pipe";
return false;
}
base::win::ScopedHandle scoped_out_read(out_read);
base::win::ScopedHandle scoped_out_write(out_write);
// Create the pipe for the child process's STDERR.
HANDLE err_read = NULL;
HANDLE err_write = NULL;
if (!CreatePipe(&err_read, &err_write, &sa_attr, 0)) {
NOTREACHED() << "Failed to create pipe";
return false;
}
base::win::ScopedHandle scoped_err_read(err_read);
base::win::ScopedHandle scoped_err_write(err_write);
// Ensure the read handle to the pipe for STDOUT/STDERR is not inherited.
if (!SetHandleInformation(out_read, HANDLE_FLAG_INHERIT, 0)) {
NOTREACHED() << "Failed to disabled pipe inheritance";
return false;
}
if (!SetHandleInformation(err_read, HANDLE_FLAG_INHERIT, 0)) {
NOTREACHED() << "Failed to disabled pipe inheritance";
return false;
}
base::FilePath::StringType cmdline_str(cmdline.GetCommandLineString());
STARTUPINFO start_info = {};
start_info.cb = sizeof(STARTUPINFO);
start_info.hStdOutput = out_write;
// Keep the normal stdin.
start_info.hStdInput = GetStdHandle(STD_INPUT_HANDLE);
// FIXME(brettw) set stderr here when we actually read it below.
//start_info.hStdError = err_write;
start_info.hStdError = GetStdHandle(STD_ERROR_HANDLE);
start_info.dwFlags |= STARTF_USESTDHANDLES;
// Create the child process.
PROCESS_INFORMATION temp_process_info = {};
if (!CreateProcess(NULL,
&cmdline_str[0],
NULL, NULL,
TRUE, // Handles are inherited.
0, NULL,
startup_dir.value().c_str(),
&start_info, &temp_process_info)) {
return false;
}
base::win::ScopedProcessInformation proc_info(temp_process_info);
// Close our writing end of pipes now. Otherwise later read would not be able
// to detect end of child's output.
scoped_out_write.Close();
scoped_err_write.Close();
// Read output from the child process's pipe for STDOUT
const int kBufferSize = 1024;
char buffer[kBufferSize];
// FIXME(brettw) read from stderr here! This is complicated because we want
// to read both of them at the same time, probably need overlapped I/O.
// Also uncomment start_info code above.
for (;;) {
DWORD bytes_read = 0;
BOOL success = ReadFile(out_read, buffer, kBufferSize, &bytes_read, NULL);
if (!success || bytes_read == 0)
break;
std_out->append(buffer, bytes_read);
}
// Let's wait for the process to finish.
WaitForSingleObject(proc_info.process_handle(), INFINITE);
DWORD dw_exit_code;
GetExitCodeProcess(proc_info.process_handle(), &dw_exit_code);
*exit_code = static_cast<int>(dw_exit_code);
return true;
}
#else
bool ExecProcess(const CommandLine& cmdline,
const base::FilePath& startup_dir,
std::string* std_out,
std::string* std_err,
int* exit_code) {
*exit_code = EXIT_FAILURE;
std::vector<std::string> argv = cmdline.argv();
int pipe_fd[2];
pid_t pid;
base::InjectiveMultimap fd_shuffle1, fd_shuffle2;
scoped_ptr<char*[]> argv_cstr(new char*[argv.size() + 1]);
fd_shuffle1.reserve(3);
fd_shuffle2.reserve(3);
if (pipe(pipe_fd) < 0)
return false;
switch (pid = fork()) {
case -1: // error
close(pipe_fd[0]);
close(pipe_fd[1]);
return false;
case 0: // child
{
// DANGER: no calls to malloc are allowed from now on:
// http://crbug.com/36678
// Obscure fork() rule: in the child, if you don't end up doing exec*(),
// you call _exit() instead of exit(). This is because _exit() does not
// call any previously-registered (in the parent) exit handlers, which
// might do things like block waiting for threads that don't even exist
// in the child.
int dev_null = open("/dev/null", O_WRONLY);
if (dev_null < 0)
_exit(127);
fd_shuffle1.push_back(
base::InjectionArc(pipe_fd[1], STDOUT_FILENO, true));
fd_shuffle1.push_back(
base::InjectionArc(dev_null, STDERR_FILENO, true));
fd_shuffle1.push_back(
base::InjectionArc(dev_null, STDIN_FILENO, true));
// Adding another element here? Remeber to increase the argument to
// reserve(), above.
std::copy(fd_shuffle1.begin(), fd_shuffle1.end(),
std::back_inserter(fd_shuffle2));
if (!ShuffleFileDescriptors(&fd_shuffle1))
_exit(127);
base::SetCurrentDirectory(startup_dir);
// TODO(brettw) the base version GetAppOutput does a
// CloseSuperfluousFds call here. Do we need this?
for (size_t i = 0; i < argv.size(); i++)
argv_cstr[i] = const_cast<char*>(argv[i].c_str());
argv_cstr[argv.size()] = NULL;
execvp(argv_cstr[0], argv_cstr.get());
_exit(127);
}
default: // parent
{
// Close our writing end of pipe now. Otherwise later read would not
// be able to detect end of child's output (in theory we could still
// write to the pipe).
close(pipe_fd[1]);
char buffer[256];
ssize_t bytes_read = 0;
while (true) {
bytes_read = HANDLE_EINTR(read(pipe_fd[0], buffer, sizeof(buffer)));
if (bytes_read <= 0)
break;
std_out->append(buffer, bytes_read);
}
close(pipe_fd[0]);
return base::WaitForExitCode(pid, exit_code);
}
}
return false;
}
#endif
} // namespace
const char kExecScript[] = "exec_script";
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());
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 (size_t i = 0; i < deps_value.list_value().size(); i++) {
if (!deps_value.list_value()[0].VerifyTypeIs(Value::STRING, err))
return Value();
g_scheduler->AddGenDependency(
build_settings->GetFullPath(cur_dir.ResolveRelativeFile(
deps_value.list_value()[0].string_value())));
}
}
// Make the command line.
const base::FilePath& python_path = build_settings->python_path();
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 (size_t i = 0; i < script_args.list_value().size(); i++) {
if (!script_args.list_value()[i].VerifyTypeIs(Value::STRING, err))
return Value();
cmdline.AppendArg(script_args.list_value()[i].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; // TODO(brettw) not hooked up, see above.
int exit_code = 0;
if (!CommandLine::ForCurrentProcess()->HasSwitch(kNoExecSwitch)) {
if (!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");
}
// TODO(brettw) maybe we need stderr also for reasonable stack dumps.
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 += ".";
*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(output, function,
args.size() >= 3 ? args[2] : Value(), err);
}
} // namespace functions
|