/
CoreOptions.java
996 lines (905 loc) · 43.9 KB
/
CoreOptions.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
// 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.config;
import static com.google.common.collect.ImmutableList.toImmutableList;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.analysis.config.CoreOptionConverters.EmptyToNullLabelConverter;
import com.google.devtools.build.lib.analysis.config.CoreOptionConverters.LabelListConverter;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.util.RegexFilter;
import com.google.devtools.common.options.Converter;
import com.google.devtools.common.options.Converters;
import com.google.devtools.common.options.Converters.BooleanConverter;
import com.google.devtools.common.options.EnumConverter;
import com.google.devtools.common.options.Option;
import com.google.devtools.common.options.OptionDefinition;
import com.google.devtools.common.options.OptionDocumentationCategory;
import com.google.devtools.common.options.OptionEffectTag;
import com.google.devtools.common.options.OptionMetadataTag;
import com.google.devtools.common.options.OptionsParser;
import com.google.devtools.common.options.OptionsParsingException;
import com.google.devtools.common.options.TriState;
import java.util.AbstractMap.SimpleEntry;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
/**
* Core options affecting a {@link BuildConfigurationValue} that don't belong in domain-specific
* {@link FragmentOptions}. All options defined here should be universal in that they affect
* configuration regardless of which languages a build uses. In other words, this should only
* contain options that aren't suitable for Starlark configuration.
*
* <p>(Note: any client that creates a view will also need to declare BuildView.Options, which
* affect the <i>mechanism</i> of view construction, even if they don't affect the value of the
* BuildConfigurationValue instances.)
*
* <p>IMPORTANT: when adding new options, be sure to consider whether those values should be
* propagated to the host configuration or not.
*
* <p>ALSO IMPORTANT: all option types MUST define a toString method that gives identical results
* for semantically identical option values. The simplest way to ensure that is to return the input
* string.
*/
public class CoreOptions extends FragmentOptions implements Cloneable {
public static final OptionDefinition CPU =
OptionsParser.getOptionDefinitionByName(CoreOptions.class, "cpu");
@Option(
name = "incompatible_merge_genfiles_directory",
defaultValue = "true",
documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
metadataTags = {OptionMetadataTag.INCOMPATIBLE_CHANGE},
help = "If true, the genfiles directory is folded into the bin directory.")
public boolean mergeGenfilesDirectory;
@Option(
name = "experimental_platform_in_output_dir",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
metadataTags = {OptionMetadataTag.EXPERIMENTAL},
help =
"If true, the target platform is used in the output directory name instead of the CPU.")
public boolean platformInOutputDir;
@Option(
name = "incompatible_use_platforms_repo_for_constraints",
defaultValue = "true",
documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
metadataTags = {OptionMetadataTag.INCOMPATIBLE_CHANGE},
help = "If true, constraint settings from @bazel_tools are removed.")
public boolean usePlatformsRepoForConstraints;
// Note: This value may contain conflicting duplicate values for the same define.
// Use `getNormalizedCommandLineBuildVariables` if you wish for these to be deduplicated
// (last-wins).
@Option(
name = "define",
converter = Converters.AssignmentConverter.class,
defaultValue = "null",
allowMultiple = true,
documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS,
effectTags = {OptionEffectTag.CHANGES_INPUTS, OptionEffectTag.AFFECTS_OUTPUTS},
help = "Each --define option specifies an assignment for a build variable.")
public List<Map.Entry<String, String>> commandLineBuildVariables;
@Option(
name = "collapse_duplicate_defines",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.BUILD_TIME_OPTIMIZATION,
effectTags = {
OptionEffectTag.LOADING_AND_ANALYSIS,
OptionEffectTag.LOSES_INCREMENTAL_STATE,
},
help =
"When enabled, redundant --defines will be removed early in the build. This avoids"
+ " unnecessary loss of the analysis cache for certain types of equivalent"
+ " builds.")
public boolean collapseDuplicateDefines;
@Option(
name = "cpu",
defaultValue = "",
converter = AutoCpuConverter.class,
documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS,
effectTags = {OptionEffectTag.CHANGES_INPUTS, OptionEffectTag.AFFECTS_OUTPUTS},
metadataTags = {OptionMetadataTag.EXPLICIT_IN_OUTPUT_PATH},
help = "The target CPU.")
public String cpu;
@Option(
name = "min_param_file_size",
defaultValue = "32768",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = {
OptionEffectTag.LOADING_AND_ANALYSIS,
OptionEffectTag.EXECUTION,
OptionEffectTag.ACTION_COMMAND_LINES
},
help = "Minimum command line length before creating a parameter file.")
public int minParamFileSize;
@Option(
name = "defer_param_files",
defaultValue = "true",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = {
OptionEffectTag.LOADING_AND_ANALYSIS,
OptionEffectTag.EXECUTION,
OptionEffectTag.ACTION_COMMAND_LINES
},
help = "This option is deprecated and has no effect and will be removed in the future.")
public boolean deferParamFiles;
@Option(
name = "experimental_extended_sanity_checks",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = {OptionEffectTag.BAZEL_INTERNAL_CONFIGURATION},
metadataTags = {OptionMetadataTag.EXPERIMENTAL},
help =
"Enables internal validation checks to make sure that configured target "
+ "implementations only access things they should. Causes a performance hit.")
public boolean extendedSanityChecks;
@Option(
name = "strict_filesets",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.INPUT_STRICTNESS,
effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS, OptionEffectTag.EAGERNESS_TO_EXIT},
help =
"If this option is enabled, filesets crossing package boundaries are reported "
+ "as errors. It does not work when check_fileset_dependencies_recursively is "
+ "disabled.")
public boolean strictFilesets;
@Option(
name = "experimental_strict_fileset_output",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.EXECUTION_STRATEGY,
effectTags = {OptionEffectTag.EXECUTION},
help =
"If this option is enabled, filesets will treat all output artifacts as regular files. "
+ "They will not traverse directories or be sensitive to symlinks.")
public boolean strictFilesetOutput;
@Option(
name = "stamp",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
help = "Stamp binaries with the date, username, hostname, workspace information, etc.")
public boolean stampBinaries;
// This default value is always overwritten in the case of "bazel coverage" by
// a value returned by InstrumentationFilterSupport.computeInstrumentationFilter.
@Option(
name = "instrumentation_filter",
converter = RegexFilter.RegexFilterConverter.class,
defaultValue = "-/javatests[/:],-/test/java[/:]",
documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
help =
"When coverage is enabled, only rules with names included by the "
+ "specified regex-based filter will be instrumented. Rules prefixed "
+ "with '-' are excluded instead. Note that only non-test rules are "
+ "instrumented unless --instrument_test_targets is enabled.")
public RegexFilter instrumentationFilter;
@Option(
name = "instrument_test_targets",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
help =
"When coverage is enabled, specifies whether to consider instrumenting test rules. "
+ "When set, test rules included by --instrumentation_filter are instrumented. "
+ "Otherwise, test rules are always excluded from coverage instrumentation.")
public boolean instrumentTestTargets;
@Option(
name = "host_cpu",
defaultValue = "",
converter = AutoCpuConverter.class,
documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS,
effectTags = {OptionEffectTag.CHANGES_INPUTS, OptionEffectTag.AFFECTS_OUTPUTS},
help = "The host CPU.")
public String hostCpu;
@Option(
name = "compilation_mode",
abbrev = 'c',
converter = CompilationMode.Converter.class,
defaultValue = "fastbuild",
documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS, OptionEffectTag.ACTION_COMMAND_LINES},
metadataTags = {OptionMetadataTag.EXPLICIT_IN_OUTPUT_PATH},
help = "Specify the mode the binary will be built in. Values: 'fastbuild', 'dbg', 'opt'.")
public CompilationMode compilationMode;
@Option(
name = "host_compilation_mode",
converter = CompilationMode.Converter.class,
defaultValue = "opt",
documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS, OptionEffectTag.ACTION_COMMAND_LINES},
help =
"Specify the mode the tools used during the build will be built in. Values: "
+ "'fastbuild', 'dbg', 'opt'.")
public CompilationMode hostCompilationMode;
@Option(
name = "experimental_enable_aspect_hints",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS},
metadataTags = {OptionMetadataTag.EXPERIMENTAL})
public boolean enableAspectHints;
/** Regardless of input, converts to an empty list. For use with affectedByStarlarkTransition */
public static class EmptyListConverter extends Converter.Contextless<List<String>> {
@Override
public List<String> convert(String input) throws OptionsParsingException {
return ImmutableList.of();
}
@Override
public String getTypeDescription() {
return "Regardless of input, converts to an empty list. For use with"
+ " affectedByStarlarkTransition";
}
}
/**
* This internal option is a *set* of names of options that have been changed by starlark
* transitions at any point in the build at the time of accessing. It contains both native and
* starlark options in label form. e.g. "//command_line_option:cpu" for native options and
* "//myapp:foo" for starlark options. This is used to regenerate {@code
* transitionDirectoryNameFragment} after each starlark transition.
*/
@Option(
name = "affected by starlark transition",
defaultValue = "",
converter = EmptyListConverter.class,
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = {
OptionEffectTag.LOSES_INCREMENTAL_STATE,
OptionEffectTag.AFFECTS_OUTPUTS,
OptionEffectTag.LOADING_AND_ANALYSIS
},
metadataTags = {OptionMetadataTag.INTERNAL})
public List<String> affectedByStarlarkTransition;
/** Values for the --experimental_exec_configuration_distinguisher options * */
public enum ExecConfigurationDistinguisherScheme {
/** Use hash of selected execution platform for platform_suffix. * */
LEGACY,
/** Do not touch platform_suffix or do anything else. * */
OFF,
/** Use hash of entire configuration (with platform_suffix="") for platform_suffix. * */
FULL_HASH,
/** Set platform_suffix to "exec", instead update `affected by starlark transition` * */
DIFF_TO_AFFECTED
}
/** Converter for the {@code --experimental_exec_configuration_distinguisher} options. */
public static class ExecConfigurationDistinguisherSchemeConverter
extends EnumConverter<ExecConfigurationDistinguisherScheme> {
public ExecConfigurationDistinguisherSchemeConverter() {
super(
ExecConfigurationDistinguisherScheme.class,
"Exec transition configuration distinguisher scheme");
}
}
@Option(
name = "experimental_exec_configuration_distinguisher",
defaultValue = "legacy",
converter = ExecConfigurationDistinguisherSchemeConverter.class,
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
metadataTags = {OptionMetadataTag.EXPERIMENTAL},
help =
"Please only use this flag as part of a suggested migration or testing strategy due to"
+ " potential for action conflicts. Controls how the execution transition changes the"
+ " platform_suffix flag. In legacy mode, sets it to a hash of the execution"
+ " platform. In fullhash mode, sets it to a hash of the entire configuration. In off"
+ " mode, does not touch it.")
public ExecConfigurationDistinguisherScheme execConfigurationDistinguisherScheme;
/* At the moment, EXPLICIT_IN_OUTPUT_PATH is not being set here because platform_suffix
* is being used as a configuration distinguisher for the exec transition. */
@Option(
name = "platform_suffix",
defaultValue = "null",
documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS,
effectTags = {
OptionEffectTag.LOSES_INCREMENTAL_STATE,
OptionEffectTag.AFFECTS_OUTPUTS,
OptionEffectTag.LOADING_AND_ANALYSIS
},
help = "Specifies a suffix to be added to the configuration directory.")
public String platformSuffix;
// TODO(bazel-team): The test environment is actually computed in BlazeRuntime and this option
// is not read anywhere else. Thus, it should be in a different options class, preferably one
// specific to the "test" command or maybe in its own configuration fragment.
@Option(
name = "test_env",
converter = Converters.OptionalAssignmentConverter.class,
allowMultiple = true,
defaultValue = "null",
documentationCategory = OptionDocumentationCategory.TESTING,
effectTags = {OptionEffectTag.TEST_RUNNER},
help =
"Specifies additional environment variables to be injected into the test runner "
+ "environment. Variables can be either specified by name, in which case its value "
+ "will be read from the Bazel client environment, or by the name=value pair. "
+ "This option can be used multiple times to specify several variables. "
+ "Used only by the 'bazel test' command.")
public List<Map.Entry<String, String>> testEnvironment;
// TODO(bazel-team): The set of available variables from the client environment for actions
// is computed independently in CommandEnvironment to inject a more restricted client
// environment to skyframe.
@Option(
name = "action_env",
converter = Converters.OptionalAssignmentConverter.class,
allowMultiple = true,
defaultValue = "null",
documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS,
effectTags = {OptionEffectTag.ACTION_COMMAND_LINES},
help =
"Specifies the set of environment variables available to actions with target"
+ " configuration. Variables can be either specified by name, in which case the"
+ " value will be taken from the invocation environment, or by the name=value pair"
+ " which sets the value independent of the invocation environment. This option can"
+ " be used multiple times; for options given for the same variable, the latest"
+ " wins, options for different variables accumulate.")
public List<Map.Entry<String, String>> actionEnvironment;
@Option(
name = "host_action_env",
converter = Converters.OptionalAssignmentConverter.class,
allowMultiple = true,
defaultValue = "null",
documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS,
effectTags = {OptionEffectTag.ACTION_COMMAND_LINES},
help =
"Specifies the set of environment variables available to actions with host or execution"
+ " configurations. Variables can be either specified by name, in which case the"
+ " value will be taken from the invocation environment, or by the name=value pair"
+ " which sets the value independent of the invocation environment. This option can"
+ " be used multiple times; for options given for the same variable, the latest"
+ " wins, options for different variables accumulate.")
public List<Map.Entry<String, String>> hostActionEnvironment;
@Option(
name = "collect_code_coverage",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
help =
"If specified, Bazel will instrument code (using offline instrumentation where "
+ "possible) and will collect coverage information during tests. Only targets that "
+ " match --instrumentation_filter will be affected. Usually this option should "
+ " not be specified directly - 'bazel coverage' command should be used instead.")
public boolean collectCodeCoverage;
@Option(
name = "build_runfile_manifests",
defaultValue = "true",
documentationCategory = OptionDocumentationCategory.OUTPUT_SELECTION,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
help =
"If true, write runfiles manifests for all targets. If false, omit them. Local tests will"
+ " fail to run when false.")
public boolean buildRunfilesManifests;
@Option(
name = "build_runfile_links",
defaultValue = "true",
documentationCategory = OptionDocumentationCategory.OUTPUT_SELECTION,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
help =
"If true, build runfiles symlink forests for all targets. "
+ "If false, write only manifests when possible.")
public boolean buildRunfiles;
@Option(
name = "legacy_external_runfiles",
defaultValue = "true",
documentationCategory = OptionDocumentationCategory.OUTPUT_SELECTION,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
help =
"If true, build runfiles symlink forests for external repositories under "
+ ".runfiles/wsname/external/repo (in addition to .runfiles/repo).")
public boolean legacyExternalRunfiles;
@Option(
name = "check_fileset_dependencies_recursively",
defaultValue = "true",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
deprecationWarning =
"This flag is a no-op and fileset dependencies are always checked "
+ "to ensure correctness of builds.",
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS})
public boolean checkFilesetDependenciesRecursively;
@Option(
name = "experimental_skyframe_native_filesets",
defaultValue = "true",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = {OptionEffectTag.BAZEL_INTERNAL_CONFIGURATION},
deprecationWarning = "This flag is a no-op and skyframe-native-filesets is always true.")
public boolean skyframeNativeFileset;
@Option(
name = "run_under",
defaultValue = "null",
converter = RunUnderConverter.class,
documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS,
effectTags = {OptionEffectTag.ACTION_COMMAND_LINES},
help =
"Prefix to insert before the executables for the 'test' and 'run' commands. "
+ "If the value is 'foo -bar', and the execution command line is 'test_binary -baz', "
+ "then the final command line is 'foo -bar test_binary -baz'."
+ "This can also be a label to an executable target. Some examples are: "
+ "'valgrind', 'strace', 'strace -c', "
+ "'valgrind --quiet --num-callers=20', '//package:target', "
+ " '//package:target --options'.")
public RunUnder runUnder;
@Option(
name = "check_visibility",
defaultValue = "true",
documentationCategory = OptionDocumentationCategory.INPUT_STRICTNESS,
effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS},
help = "If disabled, visibility errors are demoted to warnings.")
public boolean checkVisibility;
@Option(
name = "incompatible_check_testonly_for_output_files",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.INPUT_STRICTNESS,
effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS},
help =
"If enabled, check testonly for prerequisite targets that are output files by"
+ " looking up the testonly of the generating rule. This matches visibility"
+ " checking.")
public boolean checkTestonlyForOutputFiles;
// Moved from viewOptions to here because license information is very expensive to serialize.
// Having it here allows us to skip computation of transitive license information completely
// when the setting is disabled.
@Option(
name = "check_licenses",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.INPUT_STRICTNESS,
effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS},
help =
"Check that licensing constraints imposed by dependent packages "
+ "do not conflict with distribution modes of the targets being built. "
+ "By default, licenses are not checked.")
public boolean checkLicenses;
@Option(
name = "enforce_constraints",
defaultValue = "true",
documentationCategory = OptionDocumentationCategory.INPUT_STRICTNESS,
effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS},
help =
"Checks the environments each target is compatible with and reports errors if any "
+ "target has dependencies that don't support the same environments",
oldName = "experimental_enforce_constraints")
public boolean enforceConstraints;
@Option(
name = "experimental_action_listener",
allowMultiple = true,
defaultValue = "null",
converter = LabelListConverter.class,
documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS,
effectTags = {OptionEffectTag.EXECUTION},
metadataTags = {OptionMetadataTag.EXPERIMENTAL},
help =
"Deprecated in favor of aspects. Use action_listener to attach an extra_action to"
+ " existing build actions.")
public List<Label> actionListeners;
/** Values for the --experimental_output_directory_naming_scheme options */
public enum OutputDirectoryNamingScheme {
/** Use `affected by starlark transition` to track configuration changes */
LEGACY,
/** Produce name based on diff from some baseline BuildOptions (usually top-level) */
DIFF_AGAINST_BASELINE
}
/** Converter for the {@code --experimental_output_directory_naming_scheme} options. */
public static class OutputDirectoryNamingSchemeConverter
extends EnumConverter<OutputDirectoryNamingScheme> {
public OutputDirectoryNamingSchemeConverter() {
super(OutputDirectoryNamingScheme.class, "Output directory naming scheme");
}
}
@Option(
name = "experimental_output_directory_naming_scheme",
defaultValue = "legacy",
converter = OutputDirectoryNamingSchemeConverter.class,
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
metadataTags = {OptionMetadataTag.EXPERIMENTAL},
help =
"Please only use this flag as part of a suggested migration or testing strategy. In"
+ " legacy mode, transitions (generally only Starlark) set and use `affected by"
+ " Starlark transition` to determine the ST hash. In diff_against_baseline mode,"
+ " `affected by Starlark transition` is ignored and instead ST hash is determined,"
+ " for all configuration, by diffing against the top-level configuration.")
public OutputDirectoryNamingScheme outputDirectoryNamingScheme;
@Option(
name = "is host configuration",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = {OptionEffectTag.BAZEL_INTERNAL_CONFIGURATION},
metadataTags = {OptionMetadataTag.INTERNAL},
help = "Shows whether these options are set for host configuration.")
public boolean isHost;
@Option(
name = "is exec configuration",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = {OptionEffectTag.BAZEL_INTERNAL_CONFIGURATION},
metadataTags = {OptionMetadataTag.INTERNAL},
help = "Shows whether these options are set for an execution configuration.")
public boolean isExec;
@Option(
name = "allow_analysis_failures",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.TESTING,
effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS},
metadataTags = {OptionMetadataTag.EXPERIMENTAL},
help =
"If true, an analysis failure of a rule target results in the target's propagation "
+ "of an instance of AnalysisFailureInfo containing the error description, instead "
+ "of resulting in a build failure.")
public boolean allowAnalysisFailures;
@Option(
name = "evaluating for analysis test",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = {OptionEffectTag.BAZEL_INTERNAL_CONFIGURATION},
metadataTags = {OptionMetadataTag.INTERNAL},
help =
"If true, targets in the current configuration are being analyzed only for purposes "
+ "of an analysis test. This, for example, imposes the restriction described by "
+ "--analysis_testing_deps_limit.")
public boolean evaluatingForAnalysisTest;
@Option(
name = "analysis_testing_deps_limit",
defaultValue = "2000",
documentationCategory = OptionDocumentationCategory.TESTING,
effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS},
help =
"Sets the maximum number of transitive dependencies through a rule attribute with "
+ "a for_analysis_testing configuration transition. "
+ "Exceeding this limit will result in a rule error.")
public int analysisTestingDepsLimit;
@Option(
name = "features",
allowMultiple = true,
defaultValue = "null",
documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS,
effectTags = {OptionEffectTag.CHANGES_INPUTS, OptionEffectTag.AFFECTS_OUTPUTS},
help =
"The given features will be enabled or disabled by default for all packages. "
+ "Specifying -<feature> will disable the feature globally. "
+ "Negative features always override positive ones. "
+ "This flag is used to enable rolling out default feature changes without a "
+ "Bazel release.")
public List<String> defaultFeatures;
@Option(
name = "target_environment",
converter = LabelListConverter.class,
allowMultiple = true,
defaultValue = "null",
documentationCategory = OptionDocumentationCategory.INPUT_STRICTNESS,
effectTags = {OptionEffectTag.CHANGES_INPUTS},
help =
"Declares this build's target environment. Must be a label reference to an "
+ "\"environment\" rule. If specified, all top-level targets must be "
+ "compatible with this environment.")
public List<Label> targetEnvironments;
@Option(
name = "auto_cpu_environment_group",
converter = EmptyToNullLabelConverter.class,
defaultValue = "",
documentationCategory = OptionDocumentationCategory.INPUT_STRICTNESS,
effectTags = {OptionEffectTag.CHANGES_INPUTS, OptionEffectTag.LOADING_AND_ANALYSIS},
metadataTags = {OptionMetadataTag.EXPERIMENTAL},
help =
"Declare the environment_group to use for automatically mapping cpu values to "
+ "target_environment values.")
public Label autoCpuEnvironmentGroup;
@Option(
name = "experimental_allow_unresolved_symlinks",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = {
OptionEffectTag.LOSES_INCREMENTAL_STATE,
OptionEffectTag.LOADING_AND_ANALYSIS,
},
help =
"If enabled, Bazel allows the use of ctx.action.declare_symlink() and the use of "
+ "ctx.actions.symlink() without a target file, thus allowing the creation of "
+ "unresolved symlinks")
public boolean allowUnresolvedSymlinks;
/** Values for --experimental_output_paths. */
public enum OutputPathsMode {
/** Use the production output path model. */
OFF,
/**
* Use <a href="https://github.com/bazelbuild/bazel/issues/6526#issuecomment-488103473">
* content-based paths</a>.
*
* <p>Rule implementations also have to individually opt into this. So this setting doesn't mean
* all outputs follow this. Non-opted-in outputs continue to use the production model.
*
* <p>Follow the above link for latest details on exact scope.
*/
CONTENT,
/**
* Strip the config prefix (i.e. {@code /x86-fastbuild/} from output paths for actions that are
* registered to support this feature.
*
* <p>See {@link com.google.devtools.build.lib.actions.PathStripper} for details.
*/
STRIP,
}
/** Converter for --experimental_output_paths. */
public static class OutputPathsConverter extends EnumConverter<OutputPathsMode> {
public OutputPathsConverter() {
super(OutputPathsMode.class, "output path mode");
}
}
@Option(
name = "experimental_output_paths",
converter = OutputPathsConverter.class,
defaultValue = "off",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = {
OptionEffectTag.LOSES_INCREMENTAL_STATE,
OptionEffectTag.BAZEL_INTERNAL_CONFIGURATION,
OptionEffectTag.AFFECTS_OUTPUTS,
OptionEffectTag.EXECUTION
},
help =
"Which model to use for where in the output tree rules write their outputs, particularly "
+ "for multi-platform / multi-configuration builds. This is highly experimental. See "
+ "https://github.com/bazelbuild/bazel/issues/6526 for details.")
public OutputPathsMode outputPathsMode;
@Option(
name = "enable_runfiles",
defaultValue = "auto",
documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
help =
"Enable runfiles symlink tree; By default, it's off on Windows, on on other platforms.")
public TriState enableRunfiles;
@Option(
name = "modify_execution_info",
converter = ExecutionInfoModifier.Converter.class,
documentationCategory = OptionDocumentationCategory.EXECUTION_STRATEGY,
effectTags = {
OptionEffectTag.EXECUTION,
OptionEffectTag.AFFECTS_OUTPUTS,
OptionEffectTag.LOADING_AND_ANALYSIS,
},
defaultValue = "",
help =
"Add or remove keys from an action's execution info based on action mnemonic. "
+ "Applies only to actions which support execution info. Many common actions "
+ "support execution info, e.g. Genrule, CppCompile, Javac, StarlarkAction, "
+ "TestRunner. When specifying multiple values, order matters because "
+ "many regexes may apply to the same mnemonic.\n\n"
+ "Syntax: \"regex=[+-]key,regex=[+-]key,...\".\n\n"
+ "Examples:\n"
+ " '.*=+x,.*=-y,.*=+z' adds 'x' and 'z' to, and removes 'y' from, "
+ "the execution info for all actions.\n"
+ " 'Genrule=+requires-x' adds 'requires-x' to the execution info for "
+ "all Genrule actions.\n"
+ " '(?!Genrule).*=-requires-x' removes 'requires-x' from the execution info for "
+ "all non-Genrule actions.\n")
public ExecutionInfoModifier executionInfoModifier;
@Option(
name = "incompatible_genquery_use_graphless_query",
defaultValue = "null",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
expansion = {
"--experimental_genquery_use_graphless_query=auto",
},
effectTags = {
OptionEffectTag.BAZEL_INTERNAL_CONFIGURATION,
OptionEffectTag.AFFECTS_OUTPUTS,
OptionEffectTag.LOADING_AND_ANALYSIS
},
metadataTags = {OptionMetadataTag.INCOMPATIBLE_CHANGE},
help = "Use graphless query and disable output ordering for genquery.")
public Void incompatibleUseGraphlessQuery;
@Option(
name = "noincompatible_genquery_use_graphless_query",
defaultValue = "null",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
expansion = {
"--experimental_genquery_use_graphless_query=false",
},
effectTags = {
OptionEffectTag.BAZEL_INTERNAL_CONFIGURATION,
OptionEffectTag.AFFECTS_OUTPUTS,
OptionEffectTag.LOADING_AND_ANALYSIS
},
help = "Do not use graphless query for genquery.")
public Void noincompatibleUseGraphlessQuery;
@Option(
name = "experimental_genquery_use_graphless_query",
defaultValue = "auto",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = {
OptionEffectTag.BAZEL_INTERNAL_CONFIGURATION,
OptionEffectTag.AFFECTS_OUTPUTS,
OptionEffectTag.LOADING_AND_ANALYSIS
},
help = "Whether to use graphless query and disable output ordering.")
public TriState useGraphlessQuery;
@Option(
name = "include_config_fragments_provider",
defaultValue = "off",
converter = IncludeConfigFragmentsEnumConverter.class,
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
metadataTags = OptionMetadataTag.HIDDEN,
effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS, OptionEffectTag.LOSES_INCREMENTAL_STATE},
help =
"INTERNAL BLAZE DEVELOPER FEATURE: If \"direct\", all configured targets expose "
+ "RequiredConfigFragmentsProvider with the configuration fragments they directly "
+ "require. "
+ "If \"transitive\", they do the same but also include the fragments their "
+ "transitive dependencies require. If \"off\", the provider is omitted. "
+ ""
+ "If not \"off\", this also populates config_setting's "
+ "ConfigMatchingProvider.requiredFragmentOptions with the fragment options the "
+ "config_setting requires."
+ ""
+ "Be careful using this feature: it adds memory to every configured target in the "
+ "build.")
public IncludeConfigFragmentsEnum includeRequiredConfigFragmentsProvider;
@Option(
name = "experimental_inprocess_symlink_creation",
defaultValue = "false",
converter = BooleanConverter.class,
documentationCategory = OptionDocumentationCategory.EXECUTION_STRATEGY,
metadataTags = OptionMetadataTag.EXPERIMENTAL,
effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS, OptionEffectTag.EXECUTION},
help = "Whether to make direct file system calls to create symlink trees")
public boolean inprocessSymlinkCreation;
@Option(
name = "experimental_skip_runfiles_manifests",
defaultValue = "false",
converter = BooleanConverter.class,
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
metadataTags = OptionMetadataTag.HIDDEN,
effectTags = {
OptionEffectTag.LOADING_AND_ANALYSIS,
OptionEffectTag.EXECUTION,
OptionEffectTag.LOSES_INCREMENTAL_STATE,
OptionEffectTag.AFFECTS_OUTPUTS
},
help =
"If enabled, Bazel does not create runfiles symlink manifests. This flag is ignored "
+ "if --experimental_enable_runfiles is set to false.")
public boolean skipRunfilesManifests;
@Option(
name = "experimental_remotable_source_manifests",
defaultValue = "false",
converter = BooleanConverter.class,
documentationCategory = OptionDocumentationCategory.EXECUTION_STRATEGY,
metadataTags = OptionMetadataTag.EXPERIMENTAL,
effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS, OptionEffectTag.EXECUTION},
help = "Whether to make source manifest actions remotable")
public boolean remotableSourceManifestActions;
@Option(
name = "flag_alias",
converter = Converters.FlagAliasConverter.class,
defaultValue = "null",
allowMultiple = true,
documentationCategory = OptionDocumentationCategory.GENERIC_INPUTS,
effectTags = {OptionEffectTag.CHANGES_INPUTS},
help =
"Sets a shorthand name for a Starlark flag. It takes a single key-value pair in the form"
+ " \"<key>=<value>\" as an argument.")
public List<Map.Entry<String, String>> commandLineFlagAliases;
@Option(
name = "archived_tree_artifact_mnemonics_filter",
defaultValue = "-.*", // disabled by default
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS, OptionEffectTag.EXECUTION},
converter = RegexFilter.RegexFilterConverter.class,
help =
"Regex filter for mnemonics of actions for which we should create archived tree"
+ " artifacts. This option is a no-op for actions which do not generate tree"
+ " artifacts.")
public RegexFilter archivedArtifactsMnemonicsFilter;
@Option(
name = "experimental_debug_selects_always_succeed",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS},
help =
"When set, select functions with no matching clause will return an empty value, instead"
+ " of failing. This is to help use cquery diagnose failures in select.")
public boolean debugSelectsAlwaysSucceed;
/** Ways configured targets may provide the {@link Fragment}s they require. */
public enum IncludeConfigFragmentsEnum {
/**
* Don't offer the provider at all. This is best for most builds, which don't use this
* information and don't need the extra memory hit over every configured target.
*/
OFF,
/** Provide the fragments required <em>directly</em> by this rule. */
DIRECT,
/** Provide the fragments required by this rule and its transitive dependencies. */
TRANSITIVE
}
/** Enum converter for --include_config_fragments_provider. */
public static class IncludeConfigFragmentsEnumConverter
extends EnumConverter<IncludeConfigFragmentsEnum> {
public IncludeConfigFragmentsEnumConverter() {
super(IncludeConfigFragmentsEnum.class, "include config fragments provider option");
}
}
@Override
public FragmentOptions getHost() {
CoreOptions host = (CoreOptions) getDefault();
host.affectedByStarlarkTransition = affectedByStarlarkTransition;
host.outputDirectoryNamingScheme = outputDirectoryNamingScheme;
host.compilationMode = hostCompilationMode;
host.isHost = true;
host.isExec = false;
host.execConfigurationDistinguisherScheme = execConfigurationDistinguisherScheme;
host.outputPathsMode = outputPathsMode;
host.enableRunfiles = enableRunfiles;
host.executionInfoModifier = executionInfoModifier;
host.commandLineBuildVariables = commandLineBuildVariables;
host.enforceConstraints = enforceConstraints;
host.mergeGenfilesDirectory = mergeGenfilesDirectory;
host.platformInOutputDir = platformInOutputDir;
host.cpu = hostCpu;
host.includeRequiredConfigFragmentsProvider = includeRequiredConfigFragmentsProvider;
host.debugSelectsAlwaysSucceed = debugSelectsAlwaysSucceed;
// === Runfiles ===
host.buildRunfilesManifests = buildRunfilesManifests;
host.buildRunfiles = buildRunfiles;
host.legacyExternalRunfiles = legacyExternalRunfiles;
host.remotableSourceManifestActions = remotableSourceManifestActions;
host.skipRunfilesManifests = skipRunfilesManifests;
// === Filesets ===
host.strictFilesetOutput = strictFilesetOutput;
host.strictFilesets = strictFilesets;
// === Linkstamping ===
// Disable all link stamping for the host configuration, to improve action
// cache hit rates for tools.
host.stampBinaries = false;
// === Visibility ===
host.checkVisibility = checkVisibility;
// === Licenses ===
host.checkLicenses = checkLicenses;
// === Pass on C++ compiler features.
host.defaultFeatures = ImmutableList.copyOf(defaultFeatures);
// Save host options in case of a further exec->host transition.
host.hostCpu = hostCpu;
host.hostCompilationMode = hostCompilationMode;
// Pass host action environment variables
host.actionEnvironment = hostActionEnvironment;
host.hostActionEnvironment = hostActionEnvironment;
// Pass archived tree artifacts filter.
host.archivedArtifactsMnemonicsFilter = archivedArtifactsMnemonicsFilter;
host.enableAspectHints = enableAspectHints;
host.allowUnresolvedSymlinks = allowUnresolvedSymlinks;
return host;
}
/// Normalizes --define flags, preserving the last one to appear in the event of conflicts.
public LinkedHashMap<String, String> getNormalizedCommandLineBuildVariables() {
LinkedHashMap<String, String> flagValueByName = new LinkedHashMap<>();
for (Map.Entry<String, String> entry : commandLineBuildVariables) {
// If the same --define flag is passed multiple times we keep the last value.
flagValueByName.put(entry.getKey(), entry.getValue());
}
return flagValueByName;
}
@Override
public CoreOptions getNormalized() {
CoreOptions result = (CoreOptions) clone();
if (collapseDuplicateDefines) {
LinkedHashMap<String, String> flagValueByName = getNormalizedCommandLineBuildVariables();
// This check is an optimization to avoid creating a new list if the normalization was a
// no-op.
if (flagValueByName.size() != result.commandLineBuildVariables.size()) {
result.commandLineBuildVariables =
flagValueByName.entrySet().stream()
// The entries in the transformed list must be serializable.
.map(SimpleEntry::new)
.collect(toImmutableList());
}
}
return result;
}
}