-
Notifications
You must be signed in to change notification settings - Fork 64
/
local_build_executor.go
377 lines (339 loc) · 14.8 KB
/
local_build_executor.go
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
package builder
import (
"context"
"os"
"sync"
"time"
remoteexecution "github.com/bazelbuild/remote-apis/build/bazel/remote/execution/v2"
re_clock "github.com/buildbarn/bb-remote-execution/pkg/clock"
re_filesystem "github.com/buildbarn/bb-remote-execution/pkg/filesystem"
"github.com/buildbarn/bb-remote-execution/pkg/filesystem/access"
"github.com/buildbarn/bb-remote-execution/pkg/proto/remoteworker"
runner_pb "github.com/buildbarn/bb-remote-execution/pkg/proto/runner"
"github.com/buildbarn/bb-storage/pkg/blobstore"
"github.com/buildbarn/bb-storage/pkg/clock"
"github.com/buildbarn/bb-storage/pkg/digest"
"github.com/buildbarn/bb-storage/pkg/filesystem"
"github.com/buildbarn/bb-storage/pkg/filesystem/path"
"github.com/buildbarn/bb-storage/pkg/util"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"google.golang.org/protobuf/types/known/durationpb"
"google.golang.org/protobuf/types/known/emptypb"
)
// Filenames of objects to be created inside the build directory.
var (
stdoutComponent = path.MustNewComponent("stdout")
stderrComponent = path.MustNewComponent("stderr")
deviceDirectoryComponent = path.MustNewComponent("dev")
inputRootDirectoryComponent = path.MustNewComponent("root")
serverLogsDirectoryComponent = path.MustNewComponent("server_logs")
temporaryDirectoryComponent = path.MustNewComponent("tmp")
checkReadinessComponent = path.MustNewComponent("check_readiness")
)
// capturingErrorLogger is an error logger that stores up to a single
// error. When the error is stored, a context cancelation function is
// invoked. This is used by localBuildExecutor to kill a build action in
// case an I/O error occurs on the FUSE file system.
type capturingErrorLogger struct {
lock sync.Mutex
cancel context.CancelFunc
error error
}
func (el *capturingErrorLogger) Log(err error) {
el.lock.Lock()
defer el.lock.Unlock()
if el.cancel != nil {
el.error = err
el.cancel()
el.cancel = nil
}
}
func (el *capturingErrorLogger) GetError() error {
el.lock.Lock()
defer el.lock.Unlock()
return el.error
}
type localBuildExecutor struct {
contentAddressableStorage blobstore.BlobAccess
buildDirectoryCreator BuildDirectoryCreator
runner runner_pb.RunnerClient
clock clock.Clock
inputRootCharacterDevices map[path.Component]filesystem.DeviceNumber
maximumMessageSizeBytes int
environmentVariables map[string]string
forceUploadTreesAndDirectories bool
}
// NewLocalBuildExecutor returns a BuildExecutor that executes build
// steps on the local system.
func NewLocalBuildExecutor(contentAddressableStorage blobstore.BlobAccess, buildDirectoryCreator BuildDirectoryCreator, runner runner_pb.RunnerClient, clock clock.Clock, inputRootCharacterDevices map[path.Component]filesystem.DeviceNumber, maximumMessageSizeBytes int, environmentVariables map[string]string, forceUploadTreesAndDirectories bool) BuildExecutor {
return &localBuildExecutor{
contentAddressableStorage: contentAddressableStorage,
buildDirectoryCreator: buildDirectoryCreator,
runner: runner,
clock: clock,
inputRootCharacterDevices: inputRootCharacterDevices,
maximumMessageSizeBytes: maximumMessageSizeBytes,
environmentVariables: environmentVariables,
forceUploadTreesAndDirectories: forceUploadTreesAndDirectories,
}
}
func (be *localBuildExecutor) createCharacterDevices(inputRootDirectory BuildDirectory) error {
if err := inputRootDirectory.Mkdir(deviceDirectoryComponent, 0o777); err != nil && !os.IsExist(err) {
return util.StatusWrap(err, "Unable to create /dev directory in input root")
}
deviceDirectory, err := inputRootDirectory.EnterBuildDirectory(deviceDirectoryComponent)
if err != nil {
return util.StatusWrap(err, "Unable to enter /dev directory in input root")
}
defer deviceDirectory.Close()
for name, number := range be.inputRootCharacterDevices {
if err := deviceDirectory.Mknod(name, os.ModeDevice|os.ModeCharDevice|0o666, number); err != nil {
return util.StatusWrapf(err, "Failed to create character device %#v", name.String())
}
}
return nil
}
func (be *localBuildExecutor) CheckReadiness(ctx context.Context) error {
buildDirectory, buildDirectoryPath, err := be.buildDirectoryCreator.GetBuildDirectory(ctx, nil)
if err != nil {
return util.StatusWrap(err, "Failed to get build directory")
}
defer buildDirectory.Close()
// Create a useless directory inside the build directory. The
// runner will validate that it exists.
if err := buildDirectory.Mkdir(checkReadinessComponent, 0o777); err != nil {
return util.StatusWrap(err, "Failed to create readiness checking directory")
}
_, err = be.runner.CheckReadiness(ctx, &runner_pb.CheckReadinessRequest{
Path: buildDirectoryPath.Append(checkReadinessComponent).String(),
})
return err
}
func (be *localBuildExecutor) Execute(ctx context.Context, filePool re_filesystem.FilePool, monitor access.UnreadDirectoryMonitor, digestFunction digest.Function, request *remoteworker.DesiredState_Executing, executionStateUpdates chan<- *remoteworker.CurrentState_Executing) *remoteexecution.ExecuteResponse {
// Timeout handling.
response := NewDefaultExecuteResponse(request)
action := request.Action
if action == nil {
attachErrorToExecuteResponse(response, status.Error(codes.InvalidArgument, "Request does not contain an action"))
return response
}
if err := action.Timeout.CheckValid(); err != nil {
attachErrorToExecuteResponse(
response,
util.StatusWrapWithCode(err, codes.InvalidArgument, "Invalid execution timeout"))
return response
}
executionTimeout := action.Timeout.AsDuration()
// Obtain build directory.
actionDigest, err := digestFunction.NewDigestFromProto(request.ActionDigest)
if err != nil {
attachErrorToExecuteResponse(response, util.StatusWrap(err, "Failed to extract digest for action"))
return response
}
var actionDigestIfNotRunInParallel *digest.Digest
if !action.DoNotCache {
actionDigestIfNotRunInParallel = &actionDigest
}
buildDirectory, buildDirectoryPath, err := be.buildDirectoryCreator.GetBuildDirectory(ctx, actionDigestIfNotRunInParallel)
if err != nil {
attachErrorToExecuteResponse(
response,
util.StatusWrap(err, "Failed to acquire build environment"))
return response
}
defer buildDirectory.Close()
// Install hooks on build directory to capture file creation and
// I/O error events.
ctxWithIOError, cancelIOError := context.WithCancel(ctx)
defer cancelIOError()
ioErrorCapturer := capturingErrorLogger{cancel: cancelIOError}
buildDirectory.InstallHooks(filePool, &ioErrorCapturer)
executionStateUpdates <- &remoteworker.CurrentState_Executing{
ActionDigest: request.ActionDigest,
ExecutionState: &remoteworker.CurrentState_Executing_FetchingInputs{
FetchingInputs: &emptypb.Empty{},
},
}
// Create input root directory inside of build directory.
if err := buildDirectory.Mkdir(inputRootDirectoryComponent, 0o777); err != nil {
attachErrorToExecuteResponse(
response,
util.StatusWrap(err, "Failed to create input root directory"))
return response
}
inputRootDirectory, err := buildDirectory.EnterBuildDirectory(inputRootDirectoryComponent)
if err != nil {
attachErrorToExecuteResponse(
response,
util.StatusWrap(err, "Failed to enter input root directory"))
return response
}
defer inputRootDirectory.Close()
inputRootDigest, err := digestFunction.NewDigestFromProto(action.InputRootDigest)
if err != nil {
attachErrorToExecuteResponse(
response,
util.StatusWrap(err, "Failed to extract digest for input root"))
return response
}
if err := inputRootDirectory.MergeDirectoryContents(ctx, &ioErrorCapturer, inputRootDigest, monitor); err != nil {
attachErrorToExecuteResponse(response, err)
return response
}
if len(be.inputRootCharacterDevices) > 0 {
if err := be.createCharacterDevices(inputRootDirectory); err != nil {
attachErrorToExecuteResponse(response, err)
return response
}
}
// Create parent directories of output files and directories.
// These are not declared in the input root explicitly.
commandDigest, err := digestFunction.NewDigestFromProto(action.CommandDigest)
if err != nil {
attachErrorToExecuteResponse(response, util.StatusWrap(err, "Failed to extract digest for command"))
return response
}
commandMessage, err := be.contentAddressableStorage.Get(ctx, commandDigest).ToProto(&remoteexecution.Command{}, be.maximumMessageSizeBytes)
if err != nil {
attachErrorToExecuteResponse(response, util.StatusWrap(err, "Failed to obtain command"))
return response
}
command := commandMessage.(*remoteexecution.Command)
outputHierarchy, err := NewOutputHierarchy(command)
if err != nil {
attachErrorToExecuteResponse(response, err)
return response
}
if err := outputHierarchy.CreateParentDirectories(inputRootDirectory); err != nil {
attachErrorToExecuteResponse(response, err)
return response
}
// Create a directory inside the build directory that build
// actions may use to store temporary files. This ensures that
// temporary files are automatically removed when the build
// action completes. When using FUSE, it also causes quotas to
// be applied to them.
if err := buildDirectory.Mkdir(temporaryDirectoryComponent, 0o777); err != nil {
attachErrorToExecuteResponse(
response,
util.StatusWrap(err, "Failed to create temporary directory inside build directory"))
return response
}
if err := buildDirectory.Mkdir(serverLogsDirectoryComponent, 0o777); err != nil {
attachErrorToExecuteResponse(
response,
util.StatusWrap(err, "Failed to create server logs directory inside build directory"))
return response
}
executionStateUpdates <- &remoteworker.CurrentState_Executing{
ActionDigest: request.ActionDigest,
ExecutionState: &remoteworker.CurrentState_Executing_Running{
Running: &emptypb.Empty{},
},
}
environmentVariables := map[string]string{}
for name, value := range be.environmentVariables {
environmentVariables[name] = value
}
for _, environmentVariable := range command.EnvironmentVariables {
environmentVariables[environmentVariable.Name] = environmentVariable.Value
}
// Invoke the command.
ctxWithTimeout, cancelTimeout := be.clock.NewContextWithTimeout(ctxWithIOError, executionTimeout)
runResponse, runErr := be.runner.Run(ctxWithTimeout, &runner_pb.RunRequest{
Arguments: command.Arguments,
EnvironmentVariables: environmentVariables,
WorkingDirectory: command.WorkingDirectory,
StdoutPath: buildDirectoryPath.Append(stdoutComponent).String(),
StderrPath: buildDirectoryPath.Append(stderrComponent).String(),
InputRootDirectory: buildDirectoryPath.Append(inputRootDirectoryComponent).String(),
TemporaryDirectory: buildDirectoryPath.Append(temporaryDirectoryComponent).String(),
ServerLogsDirectory: buildDirectoryPath.Append(serverLogsDirectoryComponent).String(),
})
cancelTimeout()
<-ctxWithTimeout.Done()
// If an I/O error occurred during execution, attach any errors
// related to it to the response first. These errors should be
// preferred over the cancelation errors that are a result of it.
if err := ioErrorCapturer.GetError(); err != nil {
attachErrorToExecuteResponse(response, util.StatusWrap(err, "I/O error while running command"))
}
// Attach the exit code or execution error.
if runErr == nil {
response.Result.ExitCode = runResponse.ExitCode
response.Result.ExecutionMetadata.AuxiliaryMetadata = append(response.Result.ExecutionMetadata.AuxiliaryMetadata, runResponse.ResourceUsage...)
} else {
attachErrorToExecuteResponse(response, util.StatusWrap(runErr, "Failed to run command"))
}
// For FUSE-based workers: Attach the amount of time the action
// ran, minus the time it was delayed reading data from storage.
if unsuspendedDuration, ok := ctxWithTimeout.Value(re_clock.UnsuspendedDurationKey{}).(time.Duration); ok {
response.Result.ExecutionMetadata.VirtualExecutionDuration = durationpb.New(unsuspendedDuration)
}
executionStateUpdates <- &remoteworker.CurrentState_Executing{
ActionDigest: request.ActionDigest,
ExecutionState: &remoteworker.CurrentState_Executing_UploadingOutputs{
UploadingOutputs: &emptypb.Empty{},
},
}
// Upload command output. In the common case, the stdout and
// stderr files are empty. If that's the case, don't bother
// setting the digest to keep the ActionResult small.
if stdoutDigest, err := buildDirectory.UploadFile(ctx, stdoutComponent, digestFunction); err != nil {
attachErrorToExecuteResponse(response, util.StatusWrap(err, "Failed to store stdout"))
} else if stdoutDigest.GetSizeBytes() > 0 {
response.Result.StdoutDigest = stdoutDigest.GetProto()
}
if stderrDigest, err := buildDirectory.UploadFile(ctx, stderrComponent, digestFunction); err != nil {
attachErrorToExecuteResponse(response, util.StatusWrap(err, "Failed to store stderr"))
} else if stderrDigest.GetSizeBytes() > 0 {
response.Result.StderrDigest = stderrDigest.GetProto()
}
if err := outputHierarchy.UploadOutputs(ctx, inputRootDirectory, be.contentAddressableStorage, digestFunction, response.Result, be.forceUploadTreesAndDirectories); err != nil {
attachErrorToExecuteResponse(response, err)
}
// Recursively traverse the server logs directory and attach any
// file stored within to the ExecuteResponse.
serverLogsDirectoryUploader := serverLogsDirectoryUploader{
context: ctx,
executeResponse: response,
digestFunction: digestFunction,
}
serverLogsDirectoryUploader.uploadDirectory(buildDirectory, serverLogsDirectoryComponent, nil)
return response
}
type serverLogsDirectoryUploader struct {
context context.Context
executeResponse *remoteexecution.ExecuteResponse
digestFunction digest.Function
}
func (u *serverLogsDirectoryUploader) uploadDirectory(parentDirectory UploadableDirectory, dName path.Component, dPath *path.Trace) {
d, err := parentDirectory.EnterUploadableDirectory(dName)
if err != nil {
attachErrorToExecuteResponse(u.executeResponse, util.StatusWrapf(err, "Failed to enter server logs directory %#v", dPath.String()))
return
}
defer d.Close()
files, err := d.ReadDir()
if err != nil {
attachErrorToExecuteResponse(u.executeResponse, util.StatusWrapf(err, "Failed to read server logs directory %#v", dPath.String()))
return
}
for _, file := range files {
childName := file.Name()
childPath := dPath.Append(childName)
switch fileType := file.Type(); fileType {
case filesystem.FileTypeRegularFile:
if childDigest, err := d.UploadFile(u.context, childName, u.digestFunction); err == nil {
u.executeResponse.ServerLogs[childPath.String()] = &remoteexecution.LogFile{
Digest: childDigest.GetProto(),
}
} else {
attachErrorToExecuteResponse(u.executeResponse, util.StatusWrapf(err, "Failed to store server log %#v", childPath.String()))
}
case filesystem.FileTypeDirectory:
u.uploadDirectory(d, childName, childPath)
}
}
}