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
|
// Copyright 2016 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.lib.runtime;
import com.google.devtools.build.lib.util.OsUtils;
import com.google.devtools.build.lib.vfs.Path;
import com.google.devtools.build.lib.vfs.PathFragment;
import java.time.Duration;
import java.util.ArrayList;
import java.util.List;
/**
* Utility functions for the process wrapper embedded tool, which should work on most platforms and
* gives at least some isolation between running actions.
*/
public final class ProcessWrapperUtil {
private static final String PROCESS_WRAPPER = "process-wrapper" + OsUtils.executableExtension();
/** Returns whether using the process wrapper is supported in the {@link CommandEnvironment}. */
public static boolean isSupported(CommandEnvironment cmdEnv) {
// We can only use this runner, if the process-wrapper exists in the embedded tools.
// This might not always be the case, e.g. while bootstrapping.
return getProcessWrapper(cmdEnv) != null;
}
/** Returns the {@link Path} of the process wrapper binary, or null if it doesn't exist. */
public static Path getProcessWrapper(CommandEnvironment cmdEnv) {
PathFragment execPath = cmdEnv.getBlazeWorkspace().getBinTools().getExecPath(PROCESS_WRAPPER);
return execPath != null ? cmdEnv.getExecRoot().getRelative(execPath) : null;
}
/** Returns a new {@link CommandLineBuilder} for the process wrapper tool. */
public static CommandLineBuilder commandLineBuilder(
String processWrapperPath, List<String> commandArguments) {
return new CommandLineBuilder(processWrapperPath, commandArguments);
}
/**
* A builder class for constructing the full command line to run a command using the
* process-wrapper tool.
*/
public static class CommandLineBuilder {
private final String processWrapperPath;
private final List<String> commandArguments;
private Path stdoutPath;
private Path stderrPath;
private Duration timeout;
private Duration killDelay;
private Path statisticsPath;
private CommandLineBuilder(String processWrapperPath, List<String> commandArguments) {
this.processWrapperPath = processWrapperPath;
this.commandArguments = commandArguments;
}
/** Sets the path to use for redirecting stdout, if any. */
public CommandLineBuilder setStdoutPath(Path stdoutPath) {
this.stdoutPath = stdoutPath;
return this;
}
/** Sets the path to use for redirecting stderr, if any. */
public CommandLineBuilder setStderrPath(Path stderrPath) {
this.stderrPath = stderrPath;
return this;
}
/** Sets the timeout for the command run using the process-wrapper tool. */
public CommandLineBuilder setTimeout(Duration timeout) {
this.timeout = timeout;
return this;
}
/**
* Sets the kill delay for commands run using the process-wrapper tool that exceed their
* timeout.
*/
public CommandLineBuilder setKillDelay(Duration killDelay) {
this.killDelay = killDelay;
return this;
}
/** Sets the path for writing execution statistics (e.g. resource usage). */
public CommandLineBuilder setStatisticsPath(Path statisticsPath) {
this.statisticsPath = statisticsPath;
return this;
}
/** Build the command line to invoke a specific command using the process wrapper tool. */
public List<String> build() {
List<String> fullCommandLine = new ArrayList<>();
fullCommandLine.add(processWrapperPath);
if (timeout != null) {
fullCommandLine.add("--timeout=" + timeout.getSeconds());
}
if (killDelay != null) {
fullCommandLine.add("--kill_delay=" + killDelay.getSeconds());
}
if (stdoutPath != null) {
fullCommandLine.add("--stdout=" + stdoutPath);
}
if (stderrPath != null) {
fullCommandLine.add("--stderr=" + stderrPath);
}
if (statisticsPath != null) {
fullCommandLine.add("--stats=" + statisticsPath);
}
fullCommandLine.addAll(commandArguments);
return fullCommandLine;
}
}
}
|
