-
Notifications
You must be signed in to change notification settings - Fork 4k
/
BlazeOptionHandler.java
536 lines (495 loc) · 22.8 KB
/
BlazeOptionHandler.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
// 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.runtime;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Joiner;
import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.ListMultimap;
import com.google.common.flogger.GoogleLogger;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.events.EventHandler;
import com.google.devtools.build.lib.events.ExtendedEventHandler;
import com.google.devtools.build.lib.runtime.proto.InvocationPolicyOuterClass.InvocationPolicy;
import com.google.devtools.build.lib.server.FailureDetails;
import com.google.devtools.build.lib.server.FailureDetails.Command.Code;
import com.google.devtools.build.lib.server.FailureDetails.FailureDetail;
import com.google.devtools.build.lib.util.AbruptExitException;
import com.google.devtools.build.lib.util.DetailedExitCode;
import com.google.devtools.build.lib.vfs.FileSystemUtils;
import com.google.devtools.build.lib.vfs.Path;
import com.google.devtools.common.options.Converters;
import com.google.devtools.common.options.InvocationPolicyEnforcer;
import com.google.devtools.common.options.OptionDefinition;
import com.google.devtools.common.options.OptionPriority.PriorityCategory;
import com.google.devtools.common.options.OptionsParser;
import com.google.devtools.common.options.OptionsParsingException;
import com.google.devtools.common.options.OptionsParsingResult;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.function.Function;
import java.util.logging.Level;
/**
* Handles parsing the blaze command arguments.
*
* <p>This class manages rc options, configs, default options, and invocation policy.
*/
public final class BlazeOptionHandler {
private static final GoogleLogger logger = GoogleLogger.forEnclosingClass();
// Keep in sync with options added in OptionProcessor::AddRcfileArgsAndOptions()
private static final ImmutableSet<String> INTERNAL_COMMAND_OPTIONS =
ImmutableSet.of(
"rc_source",
"default_override",
"isatty",
"terminal_columns",
"ignore_client_env",
"client_env",
"client_cwd");
// Marks an event to indicate a parsing error.
static final String BAD_OPTION_TAG = "invalidOption";
// Separates the invalid tag from the full error message for easier parsing.
static final String ERROR_SEPARATOR = " :: ";
private final BlazeRuntime runtime;
private final OptionsParser optionsParser;
private final BlazeWorkspace workspace;
private final BlazeCommand command;
private final Command commandAnnotation;
private final InvocationPolicy invocationPolicy;
private final List<String> rcfileNotes = new ArrayList<>();
BlazeOptionHandler(
BlazeRuntime runtime,
BlazeWorkspace workspace,
BlazeCommand command,
Command commandAnnotation,
OptionsParser optionsParser,
InvocationPolicy invocationPolicy) {
this.runtime = runtime;
this.workspace = workspace;
this.command = command;
this.commandAnnotation = commandAnnotation;
this.optionsParser = optionsParser;
this.invocationPolicy = invocationPolicy;
}
/**
* Return options as {@link OptionsParsingResult} so the options can't be easily modified after
* we've applied the invocation policy.
*/
OptionsParsingResult getOptionsResult() {
return optionsParser;
}
public List<String> getRcfileNotes() {
return rcfileNotes;
}
/**
* Only some commands work if cwd != workspaceSuffix in Blaze. In that case, also check if Blaze
* was called from the output directory and fail if it was.
*/
private DetailedExitCode checkCwdInWorkspace(EventHandler eventHandler) {
if (!commandAnnotation.mustRunInWorkspace()) {
return DetailedExitCode.success();
}
if (!workspace.getDirectories().inWorkspace()) {
String message =
"The '"
+ commandAnnotation.name()
+ "' command is only supported from within a workspace"
+ " (below a directory having a WORKSPACE file).\n"
+ "See documentation at"
+ " https://docs.bazel.build/versions/master/build-ref.html#workspace";
eventHandler.handle(Event.error(message));
return createDetailedExitCode(message, Code.NOT_IN_WORKSPACE);
}
Path workspacePath = workspace.getWorkspace();
// TODO(kchodorow): Remove this once spaces are supported.
if (workspacePath.getPathString().contains(" ")) {
String message =
runtime.getProductName()
+ " does not currently work properly from paths "
+ "containing spaces ("
+ workspacePath
+ ").";
eventHandler.handle(Event.error(message));
return createDetailedExitCode(message, Code.SPACES_IN_WORKSPACE_PATH);
}
if (workspacePath.getParentDirectory() != null) {
Path doNotBuild =
workspacePath.getParentDirectory().getRelative(BlazeWorkspace.DO_NOT_BUILD_FILE_NAME);
if (doNotBuild.exists()) {
if (!commandAnnotation.canRunInOutputDirectory()) {
String message = getNotInRealWorkspaceError(doNotBuild);
eventHandler.handle(Event.error(message));
return createDetailedExitCode(message, Code.IN_OUTPUT_DIRECTORY);
} else {
eventHandler.handle(
Event.warn(
runtime.getProductName() + " is run from output directory. This is unsound."));
}
}
}
return DetailedExitCode.success();
}
/**
* Parses the unconditional options from .rc files for the current command.
*
* <p>This is not as trivial as simply taking the list of options for the specified command
* because commands can inherit arguments from each other, and we have to respect that (e.g. if an
* option is specified for 'build', it needs to take effect for the 'test' command, too). More
* specific commands should have priority over the broader commands (say a "build" option that
* conflicts with a "common" option should override the common one regardless of order.)
*
* <p>For each command, the options are parsed in rc order. This uses the master rc file first,
* and follows import statements. This is the order in which they were passed by the client.
*/
void parseRcOptions(
EventHandler eventHandler, ListMultimap<String, RcChunkOfArgs> commandToRcArgs)
throws OptionsParsingException {
for (String commandToParse : getCommandNamesToParse(commandAnnotation)) {
// Get all args defined for this command (or "common"), grouped by rc chunk.
for (RcChunkOfArgs rcArgs : commandToRcArgs.get(commandToParse)) {
if (!rcArgs.getArgs().isEmpty()) {
String inherited = commandToParse.equals(commandAnnotation.name()) ? "" : "Inherited ";
String source =
rcArgs.getRcFile().equals("client")
? "Options provided by the client"
: String.format(
"Reading rc options for '%s' from %s",
commandAnnotation.name(), rcArgs.getRcFile());
rcfileNotes.add(
String.format(
"%s:\n %s'%s' options: %s",
source, inherited, commandToParse, Joiner.on(' ').join(rcArgs.getArgs())));
}
optionsParser.parse(PriorityCategory.RC_FILE, rcArgs.getRcFile(), rcArgs.getArgs());
}
}
}
private void parseArgsAndConfigs(List<String> args, ExtendedEventHandler eventHandler)
throws OptionsParsingException, InterruptedException, AbruptExitException {
Path workspaceDirectory = workspace.getWorkspace();
// TODO(ulfjack): The working directory is passed by the client as part of CommonCommandOptions,
// and we can't know it until after we've parsed the options, so use the workspace for now.
Path workingDirectory = workspace.getWorkspace();
Function<OptionDefinition, String> commandOptionSourceFunction =
option -> {
if (INTERNAL_COMMAND_OPTIONS.contains(option.getOptionName())) {
return "options generated by " + runtime.getProductName() + " launcher";
} else {
return "command line options";
}
};
// Explicit command-line options:
List<String> cmdLineAfterCommand = args.subList(1, args.size());
// Before parsing any rcfiles we need to first parse --rc_source so the parser can reference the
// proper rcfiles. The --default_override options should be parsed with the --rc_source since
// {@link #parseRcOptions} depends on the list populated by the {@link
// ClientOptions#OptionOverrideConverter}.
ImmutableList.Builder<String> defaultOverridesAndRcSources = new ImmutableList.Builder<>();
ImmutableList.Builder<String> remainingCmdLine = new ImmutableList.Builder<>();
partitionCommandLineArgs(cmdLineAfterCommand, defaultOverridesAndRcSources, remainingCmdLine);
// Parses options needed to parse rcfiles properly.
optionsParser.parseWithSourceFunction(
PriorityCategory.COMMAND_LINE,
commandOptionSourceFunction,
defaultOverridesAndRcSources.build());
// Command-specific options from .blazerc passed in via --default_override and --rc_source.
ClientOptions rcFileOptions = optionsParser.getOptions(ClientOptions.class);
ListMultimap<String, RcChunkOfArgs> commandToRcArgs =
structureRcOptionsAndConfigs(
eventHandler,
rcFileOptions.rcSource,
rcFileOptions.optionsOverrides,
runtime.getCommandMap().keySet());
parseRcOptions(eventHandler, commandToRcArgs);
// Parses the remaining command-line options.
optionsParser.parseWithSourceFunction(
PriorityCategory.COMMAND_LINE, commandOptionSourceFunction, remainingCmdLine.build());
if (commandAnnotation.builds()) {
// splits project files from targets in the traditional sense
ProjectFileSupport.handleProjectFiles(
eventHandler,
runtime.getProjectFileProvider(),
workspaceDirectory.asFragment(),
workingDirectory,
optionsParser,
commandAnnotation.name());
}
expandConfigOptions(eventHandler, commandToRcArgs);
}
/**
* TODO(bazel-team): When we move CoreOptions options to be defined in starlark, make sure they're
* not passed in here during {@link #getOptionsResult}.
*/
DetailedExitCode parseStarlarkOptions(CommandEnvironment env, ExtendedEventHandler eventHandler) {
// For now, restrict starlark options to commands that already build to ensure that loading
// will work. We may want to open this up to other commands in the future. The "info"
// and "clean" commands have builds=true set in their annotation but don't actually do any
// building (b/120041419).
if (!commandAnnotation.builds()
|| commandAnnotation.name().equals("info")
|| commandAnnotation.name().equals("clean")) {
return DetailedExitCode.success();
}
try {
StarlarkOptionsParser.newStarlarkOptionsParser(env, optionsParser).parse(eventHandler);
} catch (OptionsParsingException e) {
String logMessage = "Error parsing Starlark options";
logger.atInfo().withCause(e).log(logMessage);
return processOptionsParsingException(
eventHandler, e, logMessage, Code.STARLARK_OPTIONS_PARSE_FAILURE);
}
return DetailedExitCode.success();
}
/**
* Parses the options, taking care not to generate any output to outErr, return, or throw an
* exception.
*
* @return {@code DetailedExitCode.success()} if everything went well, or some other value if not
*/
DetailedExitCode parseOptions(List<String> args, ExtendedEventHandler eventHandler) {
// The initialization code here was carefully written to parse the options early before we call
// into the BlazeModule APIs, which means we must not generate any output to outErr, return, or
// throw an exception. All the events happening here are instead stored in a temporary event
// handler, and later replayed.
DetailedExitCode earlyExitCode = checkCwdInWorkspace(eventHandler);
if (!earlyExitCode.isSuccess()) {
return earlyExitCode;
}
try {
parseArgsAndConfigs(args, eventHandler);
// Allow the command to edit the options.
command.editOptions(optionsParser);
// Migration of --watchfs to a command option.
// TODO(ulfjack): Get rid of the startup option and drop this code.
if (runtime.getStartupOptionsProvider().getOptions(BlazeServerStartupOptions.class).watchFS) {
try {
optionsParser.parse("--watchfs");
} catch (OptionsParsingException e) {
// This should never happen.
throw new IllegalStateException(e);
}
}
// Merge the invocation policy that is user-supplied, from the command line, and any
// invocation policy that was added by a module. The module one goes 'first,' so the user
// one has priority.
InvocationPolicy combinedPolicy =
InvocationPolicy.newBuilder()
.mergeFrom(runtime.getModuleInvocationPolicy())
.mergeFrom(invocationPolicy)
.build();
InvocationPolicyEnforcer optionsPolicyEnforcer =
new InvocationPolicyEnforcer(combinedPolicy, Level.INFO);
// Enforce the invocation policy. It is intentional that this is the last step in preparing
// the options. The invocation policy is used in security-critical contexts, and may be used
// as a last resort to override flags. That means that the policy can override flags set in
// BlazeCommand.editOptions, so the code needs to be safe regardless of the actual flag
// values. At the time of this writing, editOptions was only used as a convenience feature or
// to improve the user experience, but not required for safety or correctness.
optionsPolicyEnforcer.enforce(optionsParser, commandAnnotation.name());
// Print warnings for odd options usage
for (String warning : optionsParser.getWarnings()) {
eventHandler.handle(Event.warn(warning));
}
CommonCommandOptions commonOptions = optionsParser.getOptions(CommonCommandOptions.class);
for (String warning : commonOptions.deprecationWarnings) {
eventHandler.handle(Event.warn(warning));
}
} catch (OptionsParsingException e) {
String logMessage = "Error parsing options";
logger.atInfo().withCause(e).log(logMessage);
return processOptionsParsingException(
eventHandler, e, logMessage, Code.OPTIONS_PARSE_FAILURE);
} catch (InterruptedException e) {
return DetailedExitCode.of(
FailureDetail.newBuilder()
.setInterrupted(
FailureDetails.Interrupted.newBuilder()
.setCode(FailureDetails.Interrupted.Code.INTERRUPTED))
.build());
} catch (AbruptExitException e) {
return e.getDetailedExitCode();
}
return DetailedExitCode.success();
}
/**
* Expand the values of --config according to the definitions provided in the rc files and the
* applicable command.
*/
void expandConfigOptions(
EventHandler eventHandler, ListMultimap<String, RcChunkOfArgs> commandToRcArgs)
throws OptionsParsingException {
ConfigExpander.expandConfigOptions(
eventHandler,
commandToRcArgs,
getCommandNamesToParse(commandAnnotation),
rcfileNotes::add,
optionsParser);
}
private static List<String> getCommandNamesToParse(Command commandAnnotation) {
List<String> result = new ArrayList<>();
result.add("common");
getCommandNamesToParseHelper(commandAnnotation, result);
return result;
}
private static void getCommandNamesToParseHelper(
Command commandAnnotation, List<String> accumulator) {
for (Class<? extends BlazeCommand> base : commandAnnotation.inherits()) {
getCommandNamesToParseHelper(base.getAnnotation(Command.class), accumulator);
}
accumulator.add(commandAnnotation.name());
}
private static DetailedExitCode processOptionsParsingException(
ExtendedEventHandler eventHandler,
OptionsParsingException e,
String logMessage,
Code failureCode) {
Event error;
// Differentiates errors stemming from an invalid argument and errors from different parts of
// the codebase.
if (e.getInvalidArgument() != null) {
error =
Event.error(e.getInvalidArgument() + ERROR_SEPARATOR + e.getMessage())
.withTag(BAD_OPTION_TAG);
} else {
error = Event.error(e.getMessage());
}
eventHandler.handle(error);
return createDetailedExitCode(logMessage + ": " + e.getMessage(), failureCode);
}
private String getNotInRealWorkspaceError(Path doNotBuildFile) {
String message =
String.format(
"%1$s should not be called from a %1$s output directory. ", runtime.getProductName());
try {
String realWorkspace = new String(FileSystemUtils.readContentAsLatin1(doNotBuildFile));
message += String.format("The pertinent workspace directory is: '%s'", realWorkspace);
} catch (IOException e) {
// We are exiting anyway.
}
return message;
}
/**
* The rc options are passed via {@link ClientOptions#optionsOverrides} and {@link
* ClientOptions#rcSource}, which is basically a line-by-line transfer of the rc files read by the
* client. This is not a particularly useful format for expanding the options, so this method
* structures the list so that it is easier to find the arguments that apply to a command, or to
* find the definitions of a config value.
*/
@VisibleForTesting
static ListMultimap<String, RcChunkOfArgs> structureRcOptionsAndConfigs(
EventHandler eventHandler,
List<String> rcFiles,
List<ClientOptions.OptionOverride> rawOverrides,
Set<String> validCommands)
throws OptionsParsingException {
ListMultimap<String, RcChunkOfArgs> commandToRcArgs = ArrayListMultimap.create();
String lastRcFile = null;
ListMultimap<String, String> commandToArgMapForLastRc = null;
for (ClientOptions.OptionOverride override : rawOverrides) {
if (override.blazeRc < 0 || override.blazeRc >= rcFiles.size()) {
eventHandler.handle(
Event.warn("inconsistency in generated command line args. Ignoring bogus argument\n"));
continue;
}
String rcFile = rcFiles.get(override.blazeRc);
// The canonicalize-flags command only inherits bazelrc "build" commands. Not "test", not
// "build:foo". Restrict --flag_alias accordingly to prevent building with flags that
// canonicalize-flags can't recognize.
if ((override.option.startsWith("--" + Converters.BLAZE_ALIASING_FLAG + "=")
|| override.option.equals("--" + Converters.BLAZE_ALIASING_FLAG))
// In production, "build" is always a valid command, but not necessarily in tests.
// Particularly C0Command, which some tests use for low-level options parsing logic. We
// don't want to interfere with those.
&& validCommands.contains("build")
&& !override.command.equals("build")) {
throw new OptionsParsingException(
String.format(
"%s: \"%s %s\" disallowed. --%s only supports the \"build\" command.",
rcFile, override.command, override.option, Converters.BLAZE_ALIASING_FLAG));
}
String command = override.command;
int index = command.indexOf(':');
if (index > 0) {
command = command.substring(0, index);
}
if (!validCommands.contains(command) && !command.equals("common")) {
eventHandler.handle(
Event.warn(
"while reading option defaults file '"
+ rcFile
+ "':\n"
+ " invalid command name '"
+ override.command
+ "'."));
continue;
}
// We've moved on to another rc file "chunk," store the accumulated args from the last one.
if (!rcFile.equals(lastRcFile)) {
if (lastRcFile != null) {
// Go through the various commands identified in this rc file (or chunk of file) and
// store them grouped first by command, then by rc chunk.
for (String commandKey : commandToArgMapForLastRc.keySet()) {
commandToRcArgs.put(
commandKey,
new RcChunkOfArgs(lastRcFile, commandToArgMapForLastRc.get(commandKey)));
}
}
lastRcFile = rcFile;
commandToArgMapForLastRc = ArrayListMultimap.create();
}
commandToArgMapForLastRc.put(override.command, override.option);
}
if (lastRcFile != null) {
// Once again, for this last rc file chunk, store them grouped by command.
for (String commandKey : commandToArgMapForLastRc.keySet()) {
commandToRcArgs.put(
commandKey, new RcChunkOfArgs(lastRcFile, commandToArgMapForLastRc.get(commandKey)));
}
}
return commandToRcArgs;
}
private static DetailedExitCode createDetailedExitCode(String message, Code detailedCode) {
return DetailedExitCode.of(
FailureDetail.newBuilder()
.setMessage(message)
.setCommand(FailureDetails.Command.newBuilder().setCode(detailedCode))
.build());
}
private static void partitionCommandLineArgs(
List<String> cmdLine,
ImmutableList.Builder<String> defaultOverridesAndRcSources,
ImmutableList.Builder<String> remainingCmdLine) {
Iterator<String> cmdLineIterator = cmdLine.iterator();
while (cmdLineIterator.hasNext()) {
String option = cmdLineIterator.next();
if (option.startsWith("--rc_source=") || option.startsWith("--default_override=")) {
defaultOverridesAndRcSources.add(option);
} else if (option.equals("--rc_source") || option.equals("--default_override")) {
Optional<String> possibleArgument =
cmdLineIterator.hasNext() ? Optional.of(cmdLineIterator.next()) : Optional.empty();
defaultOverridesAndRcSources.add(option);
if (possibleArgument.isPresent()) {
defaultOverridesAndRcSources.add(possibleArgument.get());
}
} else {
remainingCmdLine.add(option);
}
}
}
}