forked from bazelbuild/bazel
-
Notifications
You must be signed in to change notification settings - Fork 1
/
SpawnAction.java
1449 lines (1332 loc) · 55.3 KB
/
SpawnAction.java
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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// 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.analysis.actions;
import static com.google.devtools.build.lib.packages.ExecGroup.DEFAULT_EXEC_GROUP_NAME;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.CharMatcher;
import com.google.common.base.Preconditions;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.devtools.build.lib.actions.AbstractAction;
import com.google.devtools.build.lib.actions.ActionContinuationOrResult;
import com.google.devtools.build.lib.actions.ActionEnvironment;
import com.google.devtools.build.lib.actions.ActionExecutionContext;
import com.google.devtools.build.lib.actions.ActionExecutionException;
import com.google.devtools.build.lib.actions.ActionInput;
import com.google.devtools.build.lib.actions.ActionInputHelper;
import com.google.devtools.build.lib.actions.ActionKeyContext;
import com.google.devtools.build.lib.actions.ActionOwner;
import com.google.devtools.build.lib.actions.ActionResult;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.Artifact.ArtifactExpander;
import com.google.devtools.build.lib.actions.BaseSpawn;
import com.google.devtools.build.lib.actions.CommandAction;
import com.google.devtools.build.lib.actions.CommandLine;
import com.google.devtools.build.lib.actions.CommandLineExpansionException;
import com.google.devtools.build.lib.actions.CommandLines;
import com.google.devtools.build.lib.actions.CommandLines.CommandLineAndParamFileInfo;
import com.google.devtools.build.lib.actions.CommandLines.CommandLineLimits;
import com.google.devtools.build.lib.actions.CommandLines.ExpandedCommandLines;
import com.google.devtools.build.lib.actions.CompositeRunfilesSupplier;
import com.google.devtools.build.lib.actions.EmptyRunfilesSupplier;
import com.google.devtools.build.lib.actions.ExecException;
import com.google.devtools.build.lib.actions.FilesetOutputSymlink;
import com.google.devtools.build.lib.actions.ParamFileInfo;
import com.google.devtools.build.lib.actions.ResourceSetOrBuilder;
import com.google.devtools.build.lib.actions.RunfilesSupplier;
import com.google.devtools.build.lib.actions.Spawn;
import com.google.devtools.build.lib.actions.SpawnContinuation;
import com.google.devtools.build.lib.actions.SpawnResult;
import com.google.devtools.build.lib.actions.extra.EnvironmentVariable;
import com.google.devtools.build.lib.actions.extra.ExtraActionInfo;
import com.google.devtools.build.lib.actions.extra.SpawnInfo;
import com.google.devtools.build.lib.analysis.FilesToRunProvider;
import com.google.devtools.build.lib.analysis.TransitiveInfoCollection;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration;
import com.google.devtools.build.lib.analysis.starlark.Args;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.exec.SpawnStrategyResolver;
import com.google.devtools.build.lib.server.FailureDetails;
import com.google.devtools.build.lib.server.FailureDetails.FailureDetail;
import com.google.devtools.build.lib.server.FailureDetails.Spawn.Code;
import com.google.devtools.build.lib.starlarkbuildapi.CommandLineArgsApi;
import com.google.devtools.build.lib.util.DetailedExitCode;
import com.google.devtools.build.lib.util.Fingerprint;
import com.google.devtools.build.lib.util.OnDemandString;
import com.google.devtools.build.lib.util.Pair;
import com.google.devtools.build.lib.util.ShellEscaper;
import com.google.devtools.build.lib.vfs.PathFragment;
import com.google.errorprone.annotations.CompileTimeConstant;
import com.google.errorprone.annotations.DoNotCall;
import com.google.errorprone.annotations.FormatMethod;
import com.google.errorprone.annotations.FormatString;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nullable;
import net.starlark.java.eval.EvalException;
import net.starlark.java.eval.Sequence;
import net.starlark.java.eval.StarlarkList;
/** An Action representing an arbitrary subprocess to be forked and exec'd. */
public class SpawnAction extends AbstractAction implements CommandAction {
/** Sets extensions on {@link ExtraActionInfo}. */
public interface ExtraActionInfoSupplier {
void extend(ExtraActionInfo.Builder builder);
}
private static final String GUID = "ebd6fce3-093e-45ee-adb6-bf513b602f0d";
private final CommandLines commandLines;
private final CommandLineLimits commandLineLimits;
private final boolean executeUnconditionally;
private final boolean isShellCommand;
private final CharSequence progressMessage;
private final String mnemonic;
private final ResourceSetOrBuilder resourceSetOrBuilder;
private final ImmutableMap<String, String> executionInfo;
private final ExtraActionInfoSupplier extraActionInfoSupplier;
private final Artifact primaryOutput;
private final Consumer<Pair<ActionExecutionContext, List<SpawnResult>>> resultConsumer;
/**
* Constructs a SpawnAction using direct initialization arguments.
*
* <p>All collections provided must not be subsequently modified.
*
* @param owner the owner of the Action.
* @param tools the set of files comprising the tool that does the work (e.g. compiler).
* @param inputs the set of all files potentially read by this action; must not be subsequently
* modified.
* @param outputs the set of all files written by this action; must not be subsequently modified.
* @param primaryOutput the primary output of this action
* @param resourceSetOrBuilder the resources consumed by executing this Action.
* @param env the action environment
* @param commandLines the command lines to execute. This includes the main argv vector and any
* param file-backed command lines.
* @param commandLineLimits the command line limits, from the build configuration
* @param isShellCommand Whether the command line represents a shell command with the given shell
* executable. This is used to give better error messages.
* @param progressMessage the message printed during the progression of the build.
* @param mnemonic the mnemonic that is reported in the master log.
*/
public SpawnAction(
ActionOwner owner,
NestedSet<Artifact> tools,
NestedSet<Artifact> inputs,
Iterable<Artifact> outputs,
Artifact primaryOutput,
ResourceSetOrBuilder resourceSetOrBuilder,
CommandLines commandLines,
CommandLineLimits commandLineLimits,
boolean isShellCommand,
ActionEnvironment env,
CharSequence progressMessage,
String mnemonic) {
this(
owner,
tools,
inputs,
outputs,
primaryOutput,
resourceSetOrBuilder,
commandLines,
commandLineLimits,
isShellCommand,
env,
ImmutableMap.<String, String>of(),
progressMessage,
EmptyRunfilesSupplier.INSTANCE,
mnemonic,
false,
null,
null);
}
/**
* Constructs a SpawnAction using direct initialization arguments.
*
* <p>All collections provided must not be subsequently modified.
*
* @param owner the owner of the Action
* @param tools the set of files comprising the tool that does the work (e.g. compiler). This is a
* subset of "inputs" and is only used by the WorkerSpawnStrategy
* @param inputs the set of all files potentially read by this action; must not be subsequently
* modified
* @param outputs the set of all files written by this action; must not be subsequently modified.
* @param primaryOutput the primary output of this action
* @param resourceSetOrBuilder the resources consumed by executing this Action.
* @param env the action's environment
* @param executionInfo out-of-band information for scheduling the spawn
* @param commandLines the command lines to execute. This includes the main argv vector and any
* param file-backed command lines.
* @param commandLineLimits the command line limits, from the build configuration
* @param isShellCommand Whether the command line represents a shell command with the given shell
* executable. This is used to give better error messages.
* @param progressMessage the message printed during the progression of the build
* @param runfilesSupplier {@link RunfilesSupplier}s describing the runfiles for the action
* @param mnemonic the mnemonic that is reported in the master log
*/
public SpawnAction(
ActionOwner owner,
NestedSet<Artifact> tools,
NestedSet<Artifact> inputs,
Iterable<? extends Artifact> outputs,
Artifact primaryOutput,
ResourceSetOrBuilder resourceSetOrBuilder,
CommandLines commandLines,
CommandLineLimits commandLineLimits,
boolean isShellCommand,
ActionEnvironment env,
ImmutableMap<String, String> executionInfo,
CharSequence progressMessage,
RunfilesSupplier runfilesSupplier,
String mnemonic,
boolean executeUnconditionally,
ExtraActionInfoSupplier extraActionInfoSupplier,
Consumer<Pair<ActionExecutionContext, List<SpawnResult>>> resultConsumer) {
super(owner, tools, inputs, runfilesSupplier, outputs, env);
this.primaryOutput = primaryOutput;
this.resourceSetOrBuilder = resourceSetOrBuilder;
this.executionInfo = executionInfo;
this.commandLines = commandLines;
this.commandLineLimits = commandLineLimits;
this.isShellCommand = isShellCommand;
this.progressMessage = progressMessage;
this.mnemonic = mnemonic;
this.executeUnconditionally = executeUnconditionally;
this.extraActionInfoSupplier = extraActionInfoSupplier;
this.resultConsumer = resultConsumer;
}
@Override
public Artifact getPrimaryOutput() {
return primaryOutput;
}
@VisibleForTesting
public CommandLines getCommandLines() {
return commandLines;
}
@Override
public List<String> getArguments() throws CommandLineExpansionException, InterruptedException {
return ImmutableList.copyOf(commandLines.allArguments());
}
@Override
public Sequence<CommandLineArgsApi> getStarlarkArgs() throws EvalException {
ImmutableList.Builder<CommandLineArgsApi> result = ImmutableList.builder();
ImmutableSet<Artifact> directoryInputs =
getInputs().toList().stream()
.filter(artifact -> artifact.isDirectory())
.collect(ImmutableSet.toImmutableSet());
for (CommandLineAndParamFileInfo commandLine : commandLines.getCommandLines()) {
result.add(Args.forRegisteredAction(commandLine, directoryInputs));
}
return StarlarkList.immutableCopyOf(result.build());
}
@Override
public Sequence<String> getStarlarkArgv() throws EvalException, InterruptedException {
try {
return StarlarkList.immutableCopyOf(getArguments());
} catch (CommandLineExpansionException ex) {
throw new EvalException(ex);
}
}
@Override
@VisibleForTesting
public NestedSet<Artifact> getPossibleInputsForTesting() {
return getInputs();
}
/** Returns command argument, argv[0]. */
@VisibleForTesting
public String getCommandFilename() throws CommandLineExpansionException, InterruptedException {
return Iterables.getFirst(getArguments(), null);
}
/** Returns the (immutable) list of arguments, excluding the command name, argv[0]. */
@VisibleForTesting
public List<String> getRemainingArguments()
throws CommandLineExpansionException, InterruptedException {
return ImmutableList.copyOf(Iterables.skip(getArguments(), 1));
}
@VisibleForTesting
public boolean isShellCommand() {
return isShellCommand;
}
@Override
public boolean isVolatile() {
return executeUnconditionally;
}
@Override
public boolean executeUnconditionally() {
return executeUnconditionally;
}
/** Hook for subclasses to perform work before the spawn is executed. */
protected void beforeExecute(ActionExecutionContext actionExecutionContext)
throws ExecException {}
/**
* Hook for subclasses to perform work after the spawn is executed. This method is only executed
* if the subprocess execution returns normally, not in case of errors (non-zero exit,
* setup/network failures, etc.).
*/
protected void afterExecute(
ActionExecutionContext actionExecutionContext, List<SpawnResult> spawnResults)
throws ExecException {}
@Override
public final ActionContinuationOrResult beginExecution(
ActionExecutionContext actionExecutionContext)
throws ActionExecutionException, InterruptedException {
Spawn spawn;
try {
beforeExecute(actionExecutionContext);
spawn = getSpawn(actionExecutionContext);
} catch (ExecException e) {
throw e.toActionExecutionException(this);
} catch (CommandLineExpansionException e) {
throw createCommandLineException(e);
}
SpawnContinuation spawnContinuation =
actionExecutionContext
.getContext(SpawnStrategyResolver.class)
.beginExecution(spawn, actionExecutionContext);
return new SpawnActionContinuation(actionExecutionContext, spawnContinuation);
}
private ActionExecutionException createCommandLineException(CommandLineExpansionException e) {
DetailedExitCode detailedExitCode =
DetailedExitCode.of(
FailureDetail.newBuilder()
.setMessage(Strings.nullToEmpty(e.getMessage()))
.setSpawn(
FailureDetails.Spawn.newBuilder().setCode(Code.COMMAND_LINE_EXPANSION_FAILURE))
.build());
return new ActionExecutionException(e, this, /*catastrophe=*/ false, detailedExitCode);
}
@VisibleForTesting
public ResourceSetOrBuilder getResourceSetOrBuilder() {
return resourceSetOrBuilder;
}
/**
* Returns a Spawn that is representative of the command that this Action will execute. This
* function must not modify any state.
*
* <p>This method is final, as it is merely a shorthand use of the generic way to obtain a spawn,
* which also depends on the client environment. Subclasses that wish to override the way to get a
* spawn should override the other getSpawn() methods instead.
*/
@VisibleForTesting
public final Spawn getSpawn() throws CommandLineExpansionException, InterruptedException {
return getSpawn(getInputs());
}
final Spawn getSpawn(NestedSet<Artifact> inputs)
throws CommandLineExpansionException, InterruptedException {
return new ActionSpawn(
commandLines.allArguments(),
/*env=*/ ImmutableMap.of(),
/*envResolved=*/ false,
inputs,
/*additionalInputs=*/ ImmutableList.of(),
/*filesetMappings=*/ ImmutableMap.of(),
/*reportOutputs=*/ true);
}
/**
* Returns a spawn that is representative of the command that this Action will execute in the
* given client environment.
*/
public Spawn getSpawn(ActionExecutionContext actionExecutionContext)
throws CommandLineExpansionException, InterruptedException {
return getSpawn(
actionExecutionContext.getArtifactExpander(),
actionExecutionContext.getClientEnv(),
/*envResolved=*/ false,
actionExecutionContext.getTopLevelFilesets(),
/*reportOutputs=*/ true);
}
/**
* Return a spawn that is representative of the command that this Action will execute in the given
* environment.
*
* @param envResolved If set to true, the passed environment variables will be used as the Spawn
* effective environment. Otherwise they will be used as client environment to resolve the
* action env.
*/
protected Spawn getSpawn(
ArtifactExpander artifactExpander,
Map<String, String> env,
boolean envResolved,
Map<Artifact, ImmutableList<FilesetOutputSymlink>> filesetMappings,
boolean reportOutputs)
throws CommandLineExpansionException, InterruptedException {
ExpandedCommandLines expandedCommandLines =
commandLines.expand(artifactExpander, getPrimaryOutput().getExecPath(), commandLineLimits);
return new ActionSpawn(
ImmutableList.copyOf(expandedCommandLines.arguments()),
env,
envResolved,
getInputs(),
expandedCommandLines.getParamFiles(),
filesetMappings,
reportOutputs);
}
Spawn getSpawnForExtraAction() throws CommandLineExpansionException, InterruptedException {
return getSpawn(getInputs());
}
@Override
protected void computeKey(
ActionKeyContext actionKeyContext,
@Nullable ArtifactExpander artifactExpander,
Fingerprint fp)
throws CommandLineExpansionException, InterruptedException {
fp.addString(GUID);
commandLines.addToFingerprint(actionKeyContext, artifactExpander, fp);
fp.addString(getMnemonic());
// We don't need the toolManifests here, because they are a subset of the inputManifests by
// definition and the output of an action shouldn't change whether something is considered a
// tool or not.
fp.addPaths(getRunfilesSupplier().getRunfilesDirs());
ImmutableList<Artifact> runfilesManifests = getRunfilesSupplier().getManifests();
fp.addInt(runfilesManifests.size());
for (Artifact runfilesManifest : runfilesManifests) {
fp.addPath(runfilesManifest.getExecPath());
}
env.addTo(fp);
fp.addStringMap(getExecutionInfo());
}
@Override
public String describeKey() {
StringBuilder message = new StringBuilder();
message.append(getProgressMessage());
message.append('\n');
for (Map.Entry<String, String> entry : env.getFixedEnv().entrySet()) {
message.append(" Environment variable: ");
message.append(ShellEscaper.escapeString(entry.getKey()));
message.append('=');
message.append(ShellEscaper.escapeString(entry.getValue()));
message.append('\n');
}
for (String var : getClientEnvironmentVariables()) {
message.append(" Environment variables taken from the client environment: ");
message.append(ShellEscaper.escapeString(var));
message.append('\n');
}
try {
for (String argument : ShellEscaper.escapeAll(getArguments())) {
message.append(" Argument: ");
message.append(argument);
message.append('\n');
}
} catch (InterruptedException ex) {
Thread.currentThread().interrupt();
message.append("Interrupted while expanding command line\n");
} catch (CommandLineExpansionException e) {
message.append("Could not expand command line: ");
message.append(e);
message.append('\n');
}
return message.toString();
}
@Override
public final String getMnemonic() {
return mnemonic;
}
@Override
protected String getRawProgressMessage() {
if (progressMessage != null) {
if (progressMessage instanceof String) {
String progressMessageStr = (String) progressMessage;
if (progressMessageStr.contains("%{label}") && getOwner().getLabel() != null) {
progressMessageStr =
progressMessageStr.replace("%{label}", getOwner().getLabel().toString());
}
if (progressMessageStr.contains("%{output}") && getPrimaryOutput() != null) {
progressMessageStr =
progressMessageStr.replace("%{output}", getPrimaryOutput().getExecPathString());
}
if (progressMessageStr.contains("%{input}") && getPrimaryInput() != null) {
progressMessageStr =
progressMessageStr.replace("%{input}", getPrimaryInput().getExecPathString());
}
return progressMessageStr;
} else {
// handles OnDemandString
return progressMessage.toString();
}
}
return super.getRawProgressMessage();
}
@Override
public ExtraActionInfo.Builder getExtraActionInfo(ActionKeyContext actionKeyContext)
throws CommandLineExpansionException, InterruptedException {
ExtraActionInfo.Builder builder = super.getExtraActionInfo(actionKeyContext);
if (extraActionInfoSupplier == null) {
SpawnInfo spawnInfo = getExtraActionSpawnInfo();
return builder
.setExtension(SpawnInfo.spawnInfo, spawnInfo);
} else {
extraActionInfoSupplier.extend(builder);
return builder;
}
}
/**
* Returns information about this spawn action for use by the extra action mechanism.
*
* <p>Subclasses of SpawnAction may override this in order to provide action-specific behaviour.
* This can be necessary, for example, when the action discovers inputs.
*/
protected SpawnInfo getExtraActionSpawnInfo()
throws CommandLineExpansionException, InterruptedException {
SpawnInfo.Builder info = SpawnInfo.newBuilder();
Spawn spawn = getSpawnForExtraAction();
info.addAllArgument(spawn.getArguments());
for (Map.Entry<String, String> variable : spawn.getEnvironment().entrySet()) {
info.addVariable(
EnvironmentVariable.newBuilder()
.setName(variable.getKey())
.setValue(variable.getValue())
.build());
}
for (ActionInput input : spawn.getInputFiles().toList()) {
// Explicitly ignore middleman artifacts here.
if (!(input instanceof Artifact) || !((Artifact) input).isMiddlemanArtifact()) {
info.addInputFile(input.getExecPathString());
}
}
info.addAllOutputFile(ActionInputHelper.toExecPaths(spawn.getOutputFiles()));
return info.build();
}
@Override
@VisibleForTesting
public final ImmutableMap<String, String> getIncompleteEnvironmentForTesting() {
// TODO(ulfjack): AbstractAction should declare getEnvironment with a return value of type
// ActionEnvironment to avoid developers misunderstanding the purpose of this method. That
// requires first updating all subclasses and callers to actually handle environments correctly,
// so it's not a small change.
return env.getFixedEnv();
}
/**
* Returns the out-of-band execution data for this action.
*/
@Override
public Map<String, String> getExecutionInfo() {
return executionInfo;
}
/** A spawn instance that is tied to a specific SpawnAction. */
private final class ActionSpawn extends BaseSpawn {
private final NestedSet<ActionInput> inputs;
private final Map<Artifact, ImmutableList<FilesetOutputSymlink>> filesetMappings;
private final ImmutableMap<String, String> effectiveEnvironment;
private final boolean reportOutputs;
/**
* Creates an ActionSpawn with the given environment variables.
*
* <p>Subclasses of ActionSpawn may subclass in order to provide action-specific values for
* environment variables or action inputs.
*/
private ActionSpawn(
ImmutableList<String> arguments,
Map<String, String> env,
boolean envResolved,
NestedSet<Artifact> inputs,
Iterable<? extends ActionInput> additionalInputs,
Map<Artifact, ImmutableList<FilesetOutputSymlink>> filesetMappings,
boolean reportOutputs)
throws CommandLineExpansionException {
super(
arguments,
ImmutableMap.<String, String>of(),
executionInfo,
SpawnAction.this.getRunfilesSupplier(),
SpawnAction.this,
SpawnAction.this.resourceSetOrBuilder.buildResourceSet(inputs));
NestedSetBuilder<ActionInput> inputsBuilder = NestedSetBuilder.stableOrder();
ImmutableList<Artifact> manifests = getRunfilesSupplier().getManifests();
for (Artifact input : inputs.toList()) {
if (!input.isFileset() && !manifests.contains(input)) {
inputsBuilder.add(input);
}
}
inputsBuilder.addAll(additionalInputs);
this.inputs = inputsBuilder.build();
this.filesetMappings = filesetMappings;
// If the action environment is already resolved using the client environment, the given
// environment variables are used as they are. Otherwise, they are used as clientEnv to
// resolve the action environment variables.
if (envResolved) {
effectiveEnvironment = ImmutableMap.copyOf(env);
} else {
effectiveEnvironment = SpawnAction.this.getEffectiveEnvironment(env);
}
this.reportOutputs = reportOutputs;
}
@Override
public ImmutableMap<String, String> getEnvironment() {
return effectiveEnvironment;
}
@Override
public ImmutableMap<Artifact, ImmutableList<FilesetOutputSymlink>> getFilesetMappings() {
return ImmutableMap.copyOf(filesetMappings);
}
@Override
public NestedSet<? extends ActionInput> getInputFiles() {
return inputs;
}
@Override
public ImmutableSet<Artifact> getOutputFiles() {
return reportOutputs ? super.getOutputFiles() : ImmutableSet.of();
}
}
/**
* Builder class to construct {@link SpawnAction} instances.
*/
public static class Builder {
private final NestedSetBuilder<Artifact> toolsBuilder = NestedSetBuilder.stableOrder();
private final NestedSetBuilder<Artifact> inputsBuilder = NestedSetBuilder.stableOrder();
private final List<Artifact> outputs = new ArrayList<>();
private final List<RunfilesSupplier> inputRunfilesSuppliers = new ArrayList<>();
private ResourceSetOrBuilder resourceSetOrBuilder = AbstractAction.DEFAULT_RESOURCE_SET;
private ActionEnvironment actionEnvironment = null;
private ImmutableMap<String, String> environment = ImmutableMap.of();
private ImmutableSet<String> inheritedEnvironment = ImmutableSet.of();
private ImmutableMap<String, String> executionInfo = ImmutableMap.of();
private boolean isShellCommand = false;
private boolean useDefaultShellEnvironment = false;
protected boolean executeUnconditionally;
private Object executableArg;
private CustomCommandLine.Builder executableArgs;
private List<CommandLineAndParamFileInfo> commandLines = new ArrayList<>();
private CharSequence progressMessage;
private String mnemonic = "Unknown";
protected ExtraActionInfoSupplier extraActionInfoSupplier = null;
private boolean disableSandboxing = false;
private String execGroup = DEFAULT_EXEC_GROUP_NAME;
private Consumer<Pair<ActionExecutionContext, List<SpawnResult>>> resultConsumer = null;
/**
* Creates a SpawnAction builder.
*/
public Builder() {}
/**
* Creates a builder that is a copy of another builder.
*/
public Builder(Builder other) {
this.toolsBuilder.addTransitive(other.toolsBuilder.build());
this.inputsBuilder.addTransitive(other.inputsBuilder.build());
this.outputs.addAll(other.outputs);
this.inputRunfilesSuppliers.addAll(other.inputRunfilesSuppliers);
this.resourceSetOrBuilder = other.resourceSetOrBuilder;
this.actionEnvironment = other.actionEnvironment;
this.environment = other.environment;
this.executionInfo = other.executionInfo;
this.isShellCommand = other.isShellCommand;
this.useDefaultShellEnvironment = other.useDefaultShellEnvironment;
this.executableArg = other.executableArg;
this.executableArgs = other.executableArgs;
this.commandLines = new ArrayList<>(other.commandLines);
this.progressMessage = other.progressMessage;
this.mnemonic = other.mnemonic;
}
/**
* Builds the SpawnAction using the passed-in action configuration.
*
* <p>This method makes a copy of all the collections, so it is safe to reuse the builder after
* this method returns.
*
* <p>This is annotated with @CheckReturnValue, which causes a compiler error when you call this
* method and ignore its return value. This is because some time ago, calling .build() had the
* side-effect of registering it with the RuleContext that was passed in to the constructor.
* This logic was removed, but if people don't notice and still rely on the side-effect, things
* may break.
*
* @return the SpawnAction.
*/
@CheckReturnValue
public SpawnAction build(ActionConstructionContext context) {
return build(context.getActionOwner(execGroup), context.getConfiguration());
}
@VisibleForTesting
@CheckReturnValue
public SpawnAction build(ActionOwner owner, BuildConfiguration configuration) {
CommandLines.Builder result = CommandLines.builder();
if (executableArg != null) {
result.addSingleArgument(executableArg);
} else {
result.addCommandLine(executableArgs.build());
}
for (CommandLineAndParamFileInfo pair : this.commandLines) {
result.addCommandLine(pair);
}
CommandLines commandLines = result.build();
ActionEnvironment env =
actionEnvironment != null
? actionEnvironment
: useDefaultShellEnvironment
? configuration.getActionEnvironment()
: ActionEnvironment.create(environment, inheritedEnvironment);
return buildSpawnAction(
owner, commandLines, configuration.getCommandLineLimits(), configuration, env);
}
@CheckReturnValue
SpawnAction buildForActionTemplate(ActionOwner owner) {
CommandLines.Builder result = CommandLines.builder();
if (executableArg != null) {
result.addSingleArgument(executableArg);
} else {
result.addCommandLine(executableArgs.build());
}
for (CommandLineAndParamFileInfo pair : commandLines) {
result.addCommandLine(pair.commandLine);
}
return buildSpawnAction(
owner,
result.build(),
CommandLineLimits.UNLIMITED,
null,
ActionEnvironment.create(environment, inheritedEnvironment));
}
/**
* Builds the SpawnAction using the passed-in action configuration.
*
* <p>This method makes a copy of all the collections, so it is safe to reuse the builder after
* this method returns.
*/
private SpawnAction buildSpawnAction(
ActionOwner owner,
CommandLines commandLines,
CommandLineLimits commandLineLimits,
@Nullable BuildConfiguration configuration,
ActionEnvironment env) {
NestedSet<Artifact> tools = toolsBuilder.build();
// Tools are by definition a subset of the inputs, so make sure they're present there, too.
NestedSet<Artifact> inputsAndTools =
NestedSetBuilder.<Artifact>stableOrder()
.addTransitive(inputsBuilder.build())
.addTransitive(tools)
.build();
if (disableSandboxing) {
ImmutableMap.Builder<String, String> builder = ImmutableMap.builder();
builder.putAll(executionInfo);
builder.put("nosandbox", "1");
executionInfo = builder.build();
}
return createSpawnAction(
owner,
tools,
inputsAndTools,
ImmutableList.copyOf(outputs),
outputs.get(0),
resourceSetOrBuilder,
commandLines,
commandLineLimits,
isShellCommand,
env,
configuration,
configuration == null
? executionInfo
: configuration.modifiedExecutionInfo(executionInfo, mnemonic),
progressMessage,
CompositeRunfilesSupplier.fromSuppliers(this.inputRunfilesSuppliers),
mnemonic);
}
/** Creates a SpawnAction. */
protected SpawnAction createSpawnAction(
ActionOwner owner,
NestedSet<Artifact> tools,
NestedSet<Artifact> inputsAndTools,
ImmutableList<Artifact> outputs,
Artifact primaryOutput,
ResourceSetOrBuilder resourceSetOrBuilder,
CommandLines commandLines,
CommandLineLimits commandLineLimits,
boolean isShellCommand,
ActionEnvironment env,
@Nullable BuildConfiguration configuration,
ImmutableMap<String, String> executionInfo,
CharSequence progressMessage,
RunfilesSupplier runfilesSupplier,
String mnemonic) {
return new SpawnAction(
owner,
tools,
inputsAndTools,
outputs,
primaryOutput,
resourceSetOrBuilder,
commandLines,
commandLineLimits,
isShellCommand,
env,
executionInfo,
progressMessage,
runfilesSupplier,
mnemonic,
executeUnconditionally,
extraActionInfoSupplier,
resultConsumer);
}
/**
* Adds an artifact that is necessary for executing the spawn itself (e.g. a compiler), in
* contrast to an artifact that is necessary for the spawn to do its work (e.g. source code).
*
* <p>The artifact is implicitly added to the inputs of the action as well.
*/
public Builder addTool(Artifact tool) {
toolsBuilder.add(tool);
return this;
}
/**
* Adds an executable and its runfiles, which is necessary for executing the spawn itself (e.g.
* a compiler), in contrast to artifacts that are necessary for the spawn to do its work (e.g.
* source code).
*/
public Builder addTool(FilesToRunProvider tool) {
addTransitiveTools(tool.getFilesToRun());
addRunfilesSupplier(tool.getRunfilesSupplier());
return this;
}
/** Adds an input to this action. */
public Builder addInput(Artifact artifact) {
inputsBuilder.add(artifact);
return this;
}
/**
* Adds tools to this action.
*/
public Builder addTools(Iterable<Artifact> artifacts) {
toolsBuilder.addAll(artifacts);
return this;
}
/** Adds tools to this action. */
public Builder addTransitiveTools(NestedSet<Artifact> artifacts) {
toolsBuilder.addTransitive(artifacts);
return this;
}
/**
* Adds inputs to this action.
*/
public Builder addInputs(Iterable<Artifact> artifacts) {
inputsBuilder.addAll(artifacts);
return this;
}
/** @deprecated Use {@link #addTransitiveInputs} to avoid excessive memory use. */
@Deprecated
@DoNotCall
public final Builder addInputs(NestedSet<Artifact> artifacts) {
// Do not delete this method, or else addInputs(Iterable) calls with a NestedSet argument
// will not be flagged.
inputsBuilder.addAll(artifacts.toList());
return this;
}
/**
* Adds transitive inputs to this action.
*/
public Builder addTransitiveInputs(NestedSet<Artifact> artifacts) {
inputsBuilder.addTransitive(artifacts);
return this;
}
public Builder addRunfilesSupplier(RunfilesSupplier supplier) {
inputRunfilesSuppliers.add(supplier);
return this;
}
public Builder addOutput(Artifact artifact) {
outputs.add(artifact);
return this;
}
public Builder addOutputs(Iterable<Artifact> artifacts) {
Iterables.addAll(outputs, artifacts);
return this;
}
/**
* Checks whether the action produces any outputs
*/
public boolean hasOutputs() {
return !outputs.isEmpty();
}
/**
* Sets RecourceSet for builder. If ResourceSetBuilder set, then ResourceSetBuilder will
* override setResources.
*/
public Builder setResources(ResourceSetOrBuilder resourceSetOrBuilder) {
this.resourceSetOrBuilder = resourceSetOrBuilder;
return this;
}
/** Sets the action environment. */
public Builder setEnvironment(ActionEnvironment actionEnvironment) {
this.actionEnvironment = actionEnvironment;
return this;
}
/**
* Sets the map of environment variables. Do not use! This makes the builder ignore the
* 'default shell environment', which is computed from the --action_env command line option.
*/
public Builder setEnvironment(Map<String, String> environment) {
this.environment = ImmutableMap.copyOf(environment);
this.useDefaultShellEnvironment = false;
return this;
}
/**
* Sets the set of inherited environment variables. Do not use! This makes the builder ignore
* the 'default shell environment', which is computed from the --action_env command line option.
*/
public Builder setInheritedEnvironment(Iterable<String> inheritedEnvironment) {
this.inheritedEnvironment = ImmutableSet.copyOf(inheritedEnvironment);
this.useDefaultShellEnvironment = false;
return this;
}
/**
* Sets the map of execution info.
*/
public Builder setExecutionInfo(Map<String, String> info) {
this.executionInfo = ImmutableMap.copyOf(info);
return this;
}
/**
* Sets the environment to the configuration's default shell environment.
*
* <p><b>All actions should set this if possible and avoid using {@link #setEnvironment}.</b>
*
* <p>When this property is set, the action will use a minimal, standardized environment map.
*
* <p>The list of envvars available to the action (the keys in this map) comes from two places:
* from the rule class provider and from the command line or rc-files via {@code --action_env}
* flags.
*
* <p>The values for these variables may come from one of three places: from the configuration
* fragment, or from the {@code --action_env} flag (when the flag specifies a name-value pair,
* e.g. {@code --action_env=FOO=bar}), or from the client environment (when the flag only
* specifies a name, e.g. {@code --action_env=HOME}).
*
* <p>The client environment is specified by the {@code --client_env} flags. The Bazel client
* passes these flags to the Bazel server upon each build (e.g. {@code
* --client_env=HOME=/home/johndoe}), so the server can keep track of environmental changes
* between builds, and always use the up-to-date environment (as opposed to calling {@code
* System.getenv}, which it should never do, though as of 2017-08-02 it still does in a few
* places).
*
* <p>The {@code --action_env} has priority over configuration-fragment-dictated envvar values,
* i.e. if the configuration fragment tries to add FOO=bar to the environment, and there's also
* {@link --action_env=FOO=baz} or {@link --action_env=FOO}, then FOO will be available to the
* action and its value will be "baz", or whatever the corresponding {@code --client_env} flag
* specified, respectively.
*