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
|
// Copyright 2014 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.exec;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.actions.EnvironmentalExecException;
import com.google.devtools.build.lib.actions.ExecException;
import com.google.devtools.build.lib.analysis.BlazeDirectories;
import com.google.devtools.build.lib.vfs.Dirent;
import com.google.devtools.build.lib.vfs.FileSystemUtils;
import com.google.devtools.build.lib.vfs.Path;
import com.google.devtools.build.lib.vfs.PathFragment;
import com.google.devtools.build.lib.vfs.Symlinks;
import java.io.IOException;
/**
* Initializes the <execRoot>/_bin/ directory that contains auxiliary tools used during action
* execution (alarm, etc). The main purpose of this is to make sure that those tools are accessible
* using relative paths from the execution root.
*/
public final class BinTools {
private final Path embeddedBinariesRoot;
private final Path execrootParent;
private final ImmutableList<String> embeddedTools;
private Path binDir; // the working bin directory under execRoot
private BinTools(BlazeDirectories directories, ImmutableList<String> tools) {
this(
directories.getEmbeddedBinariesRoot(),
directories.getExecRoot().getParentDirectory(),
tools);
}
private BinTools(Path embeddedBinariesRoot, Path execrootParent, ImmutableList<String> tools) {
this.embeddedBinariesRoot = embeddedBinariesRoot;
this.execrootParent = execrootParent;
ImmutableList.Builder<String> builder = ImmutableList.builder();
// Files under embedded_tools shouldn't be copied to under _bin dir
// They won't be used during action execution time.
for (String tool : tools) {
if (!tool.startsWith("embedded_tools/")) {
builder.add(tool);
}
}
this.embeddedTools = builder.build();
this.binDir = null;
}
/**
* Creates an instance with the list of embedded tools obtained from scanning the directory
* into which said binaries were extracted by the launcher.
*/
public static BinTools forProduction(BlazeDirectories directories) throws IOException {
ImmutableList.Builder<String> builder = ImmutableList.builder();
scanDirectoryRecursively(builder, directories.getEmbeddedBinariesRoot(), "");
return new BinTools(directories, builder.build());
}
/**
* Creates an empty instance for testing.
*/
@VisibleForTesting
public static BinTools empty(BlazeDirectories directories) {
return new BinTools(directories, ImmutableList.<String>of())
.setBinDir(directories.getWorkspace().getBaseName());
}
/**
* Creates an instance for testing without actually symlinking the tools.
*
* <p>Used for tests that need a set of embedded tools to be present, but not the actual files.
*/
@VisibleForTesting
public static BinTools forUnitTesting(BlazeDirectories directories, Iterable<String> tools) {
return new BinTools(directories, ImmutableList.copyOf(tools))
.setBinDir(directories.getWorkspace().getBaseName());
}
/**
* Creates an instance for testing without actually symlinking the tools.
*
* <p>Used for tests that need a set of embedded tools to be present, but not the actual files.
*/
@VisibleForTesting
public static BinTools forUnitTesting(Path execroot, Iterable<String> tools) {
return new BinTools(
execroot.getRelative("/fake/embedded/tools"),
execroot.getParentDirectory(),
ImmutableList.copyOf(tools)).setBinDir(execroot.getBaseName());
}
/**
* Returns a BinTools instance. Before calling this method, you have to populate the
* {@link BlazeDirectories#getEmbeddedBinariesRoot} directory.
*/
@VisibleForTesting
public static BinTools forIntegrationTesting(
BlazeDirectories directories, Iterable<String> tools, String repositoryName) {
return new BinTools(directories, ImmutableList.copyOf(tools)).setBinDir(repositoryName);
}
private static void scanDirectoryRecursively(
ImmutableList.Builder<String> result, Path root, String relative) throws IOException {
for (Dirent dirent : root.readdir(Symlinks.NOFOLLOW)) {
String childRelative = relative.isEmpty()
? dirent.getName()
: relative + "/" + dirent.getName();
switch (dirent.getType()) {
case FILE:
result.add(childRelative);
break;
case DIRECTORY:
scanDirectoryRecursively(result, root.getChild(dirent.getName()), childRelative);
break;
default:
// Nothing to do here -- we ignore symlinks, since they should not be present in the
// embedded binaries tree.
break;
}
}
}
public PathFragment getExecPath(String embedPath) {
if (!embeddedTools.contains(embedPath)) {
return null;
}
return PathFragment.create("_bin").getRelative(PathFragment.create(embedPath).getBaseName());
}
private BinTools setBinDir(String workspaceName) {
binDir = execrootParent.getRelative(workspaceName).getRelative("_bin");
return this;
}
/**
* Initializes the build tools not available at absolute paths. Note that
* these must be constant across all configurations.
*/
public void setupBuildTools(String workspaceName) throws ExecException {
setBinDir(workspaceName);
try {
binDir.createDirectoryAndParents();
} catch (IOException e) {
throw new EnvironmentalExecException("could not create directory '" + binDir + "'", e);
}
for (String embeddedPath : embeddedTools) {
setupTool(embeddedPath);
}
}
private void setupTool(String embeddedPath) throws ExecException {
Preconditions.checkNotNull(binDir);
Path sourcePath = embeddedBinariesRoot.getRelative(embeddedPath);
Path linkPath = binDir.getRelative(PathFragment.create(embeddedPath).getBaseName());
linkTool(sourcePath, linkPath);
}
private void linkTool(Path sourcePath, Path linkPath) throws ExecException {
if (linkPath.getFileSystem().supportsSymbolicLinksNatively(linkPath)) {
try {
if (!linkPath.isSymbolicLink()) {
// ensureSymbolicLink() does not handle the case where there is already
// a file with the same name, so we need to handle it here.
linkPath.delete();
}
FileSystemUtils.ensureSymbolicLink(linkPath, sourcePath);
} catch (IOException e) {
throw new EnvironmentalExecException("failed to link '" + sourcePath + "'", e);
}
} else {
// For file systems that do not support linking, copy.
try {
FileSystemUtils.copyTool(sourcePath, linkPath);
} catch (IOException e) {
throw new EnvironmentalExecException("failed to copy '" + sourcePath + "'" , e);
}
}
}
}
|
