| // Copyright 2017 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.buildtool; |
| |
| import com.google.common.annotations.VisibleForTesting; |
| import com.google.common.cache.CacheBuilderSpec; |
| import com.google.devtools.build.lib.actions.LocalHostCapacity; |
| import com.google.devtools.build.lib.util.OptionsUtils; |
| import com.google.devtools.build.lib.util.ResourceConverter; |
| import com.google.devtools.build.lib.vfs.PathFragment; |
| import com.google.devtools.common.options.BoolOrEnumConverter; |
| import com.google.devtools.common.options.Converters; |
| import com.google.devtools.common.options.Converters.CacheBuilderSpecConverter; |
| import com.google.devtools.common.options.Converters.RangeConverter; |
| 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.OptionsBase; |
| import com.google.devtools.common.options.OptionsParser; |
| import com.google.devtools.common.options.OptionsParsingException; |
| import com.google.devtools.common.options.RegexPatternOption; |
| import java.util.List; |
| import java.util.logging.Logger; |
| import javax.annotation.Nullable; |
| |
| /** |
| * Options interface for {@link BuildRequest}: can be used to parse command-line arguments. |
| * |
| * <p>See also {@code ExecutionOptions}; from the user's point of view, there's no qualitative |
| * difference between these two sets of options. |
| */ |
| public class BuildRequestOptions extends OptionsBase { |
| public static final OptionDefinition EXPERIMENTAL_MULTI_CPU = |
| OptionsParser.getOptionDefinitionByName(BuildRequestOptions.class, "experimental_multi_cpu"); |
| private static final Logger logger = Logger.getLogger(BuildRequestOptions.class.getName()); |
| private static final int JOBS_TOO_HIGH_WARNING = 2500; |
| @VisibleForTesting public static final int MAX_JOBS = 5000; |
| |
| /* "Execution": options related to the execution of a build: */ |
| |
| @Option( |
| name = "jobs", |
| abbrev = 'j', |
| defaultValue = "auto", |
| documentationCategory = OptionDocumentationCategory.EXECUTION_STRATEGY, |
| effectTags = {OptionEffectTag.HOST_MACHINE_RESOURCE_OPTIMIZATIONS, OptionEffectTag.EXECUTION}, |
| converter = JobsConverter.class, |
| help = |
| "The number of concurrent jobs to run. Takes {@value FLAG_SYNTAX}. Values must be" |
| + " between 1 and" |
| + MAX_JOBS |
| + " values above " |
| + JOBS_TOO_HIGH_WARNING |
| + " may cause memory issues. \"auto\" calculates a reasonable default based on" |
| + " host resources.") |
| public int jobs; |
| |
| @Option( |
| name = "progress_report_interval", |
| defaultValue = "0", |
| documentationCategory = OptionDocumentationCategory.LOGGING, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| converter = ProgressReportIntervalConverter.class, |
| help = |
| "The number of seconds to wait between two reports on still running jobs. The " |
| + "default value 0 means to use the default 10:30:60 incremental algorithm." |
| ) |
| public int progressReportInterval; |
| |
| @Option( |
| name = "explain", |
| defaultValue = "null", |
| documentationCategory = OptionDocumentationCategory.LOGGING, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| converter = OptionsUtils.PathFragmentConverter.class, |
| help = |
| "Causes the build system to explain each executed step of the " |
| + "build. The explanation is written to the specified log file." |
| ) |
| public PathFragment explanationPath; |
| |
| @Option( |
| name = "verbose_explanations", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.LOGGING, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "Increases the verbosity of the explanations issued if --explain is enabled. " |
| + "Has no effect if --explain is not enabled." |
| ) |
| public boolean verboseExplanations; |
| |
| @Option( |
| name = "output_filter", |
| converter = Converters.RegexPatternConverter.class, |
| defaultValue = "null", |
| documentationCategory = OptionDocumentationCategory.LOGGING, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = "Only shows warnings for rules with a name matching the provided regular expression.") |
| @Nullable |
| public RegexPatternOption outputFilter; |
| |
| @Option( |
| name = "analyze", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "Execute the analysis phase; this is the usual behaviour. Specifying --noanalyze causes " |
| + "the build to stop before starting the analysis phase, returning zero iff the " |
| + "package loading completed successfully; this mode is useful for testing." |
| ) |
| public boolean performAnalysisPhase; |
| |
| @Option( |
| name = "build", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_SELECTION, |
| effectTags = {OptionEffectTag.EXECUTION, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "Execute the build; this is the usual behaviour. " |
| + "Specifying --nobuild causes the build to stop before executing the build " |
| + "actions, returning zero iff the package loading and analysis phases completed " |
| + "successfully; this mode is useful for testing those phases." |
| ) |
| public boolean performExecutionPhase; |
| |
| @Option( |
| name = "output_groups", |
| converter = Converters.CommaSeparatedOptionListConverter.class, |
| allowMultiple = true, |
| documentationCategory = OptionDocumentationCategory.OUTPUT_SELECTION, |
| effectTags = {OptionEffectTag.EXECUTION, OptionEffectTag.AFFECTS_OUTPUTS}, |
| defaultValue = "null", |
| help = |
| "Specifies which output groups of the top-level targets to build. If omitted, a default " |
| + "set of output groups are built. When specified the default set is overridden. " |
| + "However you may use --output_groups=+<output_group> or " |
| + "--output_groups=-<output_group> to instead modify the set of output groups.") |
| public List<String> outputGroups; |
| |
| @Option( |
| name = "experimental_run_validations", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_SELECTION, |
| effectTags = {OptionEffectTag.EXECUTION, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = "Whether to run validation actions as part of the build.") |
| public boolean runValidationActions; |
| |
| @Option( |
| name = "show_result", |
| defaultValue = "1", |
| documentationCategory = OptionDocumentationCategory.LOGGING, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "Show the results of the build. For each target, state whether or not it was brought " |
| + "up-to-date, and if so, a list of output files that were built. The printed files " |
| + "are convenient strings for copy+pasting to the shell, to execute them.\n" |
| + "This option requires an integer argument, which is the threshold number of " |
| + "targets above which result information is not printed. Thus zero causes " |
| + "suppression of the message and MAX_INT causes printing of the result to occur " |
| + "always. The default is one." |
| ) |
| public int maxResultTargets; |
| |
| @Option( |
| name = "experimental_show_artifacts", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "Output a list of all top level artifacts produced by this build." |
| + "Use output format suitable for tool consumption. " |
| + "This flag is temporary and intended to facilitate Android Studio integration. " |
| + "This output format will likely change in the future or disappear completely." |
| ) |
| public boolean showArtifacts; |
| |
| @Option( |
| name = "announce", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.LOGGING, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = "Deprecated. No-op.", |
| deprecationWarning = "This option is now deprecated and is a no-op" |
| ) |
| public boolean announce; |
| |
| @Option( |
| name = "symlink_prefix", |
| defaultValue = "null", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "The prefix that is prepended to any of the convenience symlinks that are created " |
| + "after a build. If omitted, the default value is the name of the build tool " |
| + "followed by a hyphen. If '/' is passed, then no symlinks are created and no " |
| + "warning is emitted. Warning: the special functionality for '/' will be deprecated " |
| + "soon; use --experimental_convenience_symlinks=ignore instead.") |
| @Nullable |
| public String symlinkPrefix; |
| |
| @Option( |
| name = "experimental_convenience_symlinks", |
| converter = ConvenienceSymlinksConverter.class, |
| defaultValue = "normal", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "This flag controls how the convenience symlinks (the symlinks that appear in the " |
| + "workspace after the build) will be managed. Possible values:\n" |
| + " normal (default): Each kind of convenience symlink will be created or deleted, " |
| + "as determined by the build.\n" |
| + " clean: All symlinks will be unconditionally deleted.\n" |
| + " ignore: Symlinks will be left alone.\n" |
| + " log_only: Generate log messages as if 'normal' were passed, but don't actually " |
| + "perform any filesystem operations (useful for tools).\n" |
| + "Note that only symlinks whose names are generated by the current value of " |
| + "--symlink_prefix can be affected; if the prefix changes, any pre-existing " |
| + "symlinks will be left alone.") |
| @Nullable |
| public ConvenienceSymlinksMode experimentalConvenienceSymlinks; |
| |
| @Option( |
| name = "experimental_convenience_symlinks_bep_event", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "This flag controls whether or not we will post the build event" |
| + "ConvenienceSymlinksIdentified to the BuildEventProtocol. If the value is true, " |
| + "the BuildEventProtocol will have an entry for convenienceSymlinksIdentified, " |
| + "listing all of the convenience symlinks created in your workspace. If false, then " |
| + "the convenienceSymlinksIdentified entry in the BuildEventProtocol will be empty.") |
| public boolean experimentalConvenienceSymlinksBepEvent; |
| |
| @Option( |
| name = "experimental_multi_cpu", |
| converter = Converters.CommaSeparatedOptionListConverter.class, |
| allowMultiple = true, |
| defaultValue = "null", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| metadataTags = {OptionMetadataTag.EXPERIMENTAL}, |
| help = |
| "This flag allows specifying multiple target CPUs. If this is specified, " |
| + "the --cpu option is ignored.") |
| public List<String> multiCpus; |
| |
| @Option( |
| name = "output_tree_tracking", |
| oldName = "experimental_output_tree_tracking", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| effectTags = {OptionEffectTag.BAZEL_INTERNAL_CONFIGURATION}, |
| help = |
| "If set, tell the output service (if any) to track when files in the output " |
| + "tree have been modified externally (not by the build system). " |
| + "This should improve incremental build speed when an appropriate output service " |
| + "is enabled." |
| ) |
| public boolean finalizeActions; |
| |
| @Option( |
| name = "directory_creation_cache", |
| defaultValue = "maximumSize=100000", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| effectTags = {OptionEffectTag.EXECUTION}, |
| converter = CacheBuilderSpecConverter.class, |
| help = |
| "Describes the cache used to store known regular directories as they're created. Parent" |
| + " directories of output files are created on-demand during action execution.") |
| public CacheBuilderSpec directoryCreationCacheSpec; |
| |
| @Option( |
| name = "aspects", |
| converter = Converters.CommaSeparatedOptionListConverter.class, |
| defaultValue = "null", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.UNKNOWN}, |
| allowMultiple = true, |
| help = |
| "Comma-separated list of aspects to be applied to top-level targets. All aspects " |
| + "are applied to all top-level targets independently. Aspects are specified in " |
| + "the form <bzl-file-label>%<aspect_name>, " |
| + "for example '//tools:my_def.bzl%my_aspect', where 'my_aspect' is a top-level " |
| + "value from from a file tools/my_def.bzl") |
| public List<String> aspects; |
| |
| public BuildRequestOptions() throws OptionsParsingException {} |
| |
| public String getSymlinkPrefix(String productName) { |
| return symlinkPrefix == null ? productName + "-" : symlinkPrefix; |
| } |
| |
| // Transitional flag for safely rolling out new convenience symlink behavior. |
| // To be made a no-op and deleted once new symlink behavior is battle-tested. |
| @Option( |
| name = "use_top_level_targets_for_symlinks", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "If enabled, the symlinks are based on the configurations of the top-level targets " |
| + " rather than the top-level target configuration. If this would be ambiguous, " |
| + " the symlinks will be deleted to avoid confusion." |
| ) |
| public boolean useTopLevelTargetsForSymlinks; |
| |
| /** |
| * Returns whether to use the output directories used by the top-level targets for convenience |
| * symlinks. |
| * |
| * <p>If true, then symlinks use the actual output directories of the top-level targets. The |
| * symlinks will be created iff all top-level targets share the same output directory. Otherwise, |
| * any stale symlinks from previous invocations will be deleted to avoid ambiguity. |
| * |
| * <p>If false, then symlinks use the output directory implied by command-line flags, regardless |
| * of whether top-level targets have transitions which change them (or even have any output |
| * directories at all, as in the case of a build with no targets or one which only builds source |
| * files). |
| */ |
| public boolean useTopLevelTargetsForSymlinks() { |
| return useTopLevelTargetsForSymlinks; |
| } |
| |
| @Option( |
| name = "experimental_create_py_symlinks", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "If enabled, two convenience symlinks, `py2` and `py3`, will be created (with the" |
| + " appropriate prefix). These point to the output directories for the Python 2 and" |
| + " Python 3 configurations, respectively. This can be used to access outputs in the" |
| + " bin directory of a specific Python version. For instance, if --symlink_prefix is" |
| + " `foo-`, the path `foo-py2/bin` behaves like `foo-bin` except that it is" |
| + " guaranteed to contain artifacts built in the Python 2 configuration. IMPORTANT:" |
| + " This flag is not planned to be enabled by default, and should not be relied on.") |
| public boolean experimentalCreatePySymlinks; |
| |
| @Option( |
| name = "print_workspace_in_output_paths_if_needed", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| effectTags = {OptionEffectTag.TERMINAL_OUTPUT}, |
| help = |
| "If enabled, when the current working directory is deeper than the workspace (for" |
| + " example, when running from <workspace>/foo instead of <workspace>), printed" |
| + " output paths include the absolute path to the workspace (for example," |
| + " <workspace>/<symlink_prefix>-bin/foo/binary instead of " |
| + "<symlink_prefix>-bin/foo/binary).") |
| public boolean printWorkspaceInOutputPathsIfNeeded; |
| |
| @Option( |
| name = "use_action_cache", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| effectTags = { |
| OptionEffectTag.BAZEL_INTERNAL_CONFIGURATION, |
| OptionEffectTag.HOST_MACHINE_RESOURCE_OPTIMIZATIONS |
| }, |
| help = "Whether to use the action cache" |
| ) |
| public boolean useActionCache; |
| |
| @Option( |
| name = "discard_actions_after_execution", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| metadataTags = OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| effectTags = {OptionEffectTag.LOSES_INCREMENTAL_STATE}, |
| help = "This option is deprecated and has no effect.") |
| public boolean discardActionsAfterExecution; |
| |
| @Option( |
| name = "experimental_async_execution", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| metadataTags = OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| effectTags = {OptionEffectTag.BAZEL_INTERNAL_CONFIGURATION}, |
| help = |
| "If set to true, Bazel is allowed to run aynchronously, i.e., without reserving a local " |
| + "thread. This only has an effect if the action implementation and the lower-level " |
| + "strategy support it. This setting effectively circumvents the implicit limit of " |
| + "number of concurrently running actions otherwise imposed by the --jobs flag. Use " |
| + "with caution.") |
| public boolean useAsyncExecution; |
| |
| @Option( |
| name = "experimental_strict_conflict_checks", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| metadataTags = OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| effectTags = {OptionEffectTag.BAZEL_INTERNAL_CONFIGURATION}, |
| help = |
| "Check for action prefix file path conflicts, regardless of action-specific overrides.") |
| public boolean strictConflictChecks; |
| |
| @Option( |
| name = "incompatible_skip_genfiles_symlink", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| effectTags = {OptionEffectTag.LOSES_INCREMENTAL_STATE}, |
| help = |
| "If set to true, the genfiles symlink will not be created. For more information, see " |
| + "https://github.com/bazelbuild/bazel/issues/8651") |
| public boolean incompatibleSkipGenfilesSymlink; |
| |
| @Option( |
| name = "experimental_nested_set_as_skykey_threshold", |
| defaultValue = "0", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| metadataTags = OptionMetadataTag.EXPERIMENTAL, |
| effectTags = {OptionEffectTag.EXECUTION, OptionEffectTag.LOSES_INCREMENTAL_STATE}, |
| help = |
| "If this flag is set with a non-zero value, NestedSets whose size exceeds the threshold" |
| + " will be evaluated as a unit on Skyframe.") |
| public int nestedSetAsSkyKeyThreshold; |
| |
| @Option( |
| name = "experimental_use_fork_join_pool", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| metadataTags = OptionMetadataTag.EXPERIMENTAL, |
| effectTags = {OptionEffectTag.EXECUTION}, |
| help = "If this flag is set, use a fork join pool in the abstract queue visitor.") |
| public boolean useForkJoinPool; |
| |
| @Option( |
| name = "experimental_replay_action_out_err", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| metadataTags = OptionMetadataTag.EXPERIMENTAL, |
| effectTags = {OptionEffectTag.EXECUTION}, |
| help = "If this flag is set, replay action out/err on incremental builds.") |
| public boolean replayActionOutErr; |
| |
| @Option( |
| name = "target_pattern_file", |
| defaultValue = "", |
| documentationCategory = OptionDocumentationCategory.GENERIC_INPUTS, |
| effectTags = {OptionEffectTag.CHANGES_INPUTS}, |
| help = |
| "If set, build will read patterns from the file named here, rather than on the command " |
| + "line. It is an error to specify a file here as well as command-line patterns.") |
| public String targetPatternFile; |
| |
| /** |
| * Converter for jobs: Takes keyword ({@value #FLAG_SYNTAX}). Values must be between 1 and |
| * MAX_JOBS. |
| */ |
| public static class JobsConverter extends ResourceConverter { |
| public JobsConverter() { |
| super( |
| () -> (int) Math.ceil(LocalHostCapacity.getLocalHostCapacity().getCpuUsage()), |
| 1, |
| MAX_JOBS); |
| } |
| |
| @Override |
| public int checkAndLimit(int value) throws OptionsParsingException { |
| if (value < minValue) { |
| throw new OptionsParsingException( |
| String.format("Value '(%d)' must be at least %d.", value, minValue)); |
| } |
| if (value > maxValue) { |
| logger.warning( |
| String.format( |
| "Flag remoteWorker \"jobs\" ('%d') was set too high. " |
| + "This is a result of passing large values to --local_resources or --jobs. " |
| + "Using '%d' jobs", |
| value, maxValue)); |
| value = maxValue; |
| } |
| return value; |
| } |
| } |
| |
| /** Converter for progress_report_interval: [0, 3600]. */ |
| public static class ProgressReportIntervalConverter extends RangeConverter { |
| public ProgressReportIntervalConverter() { |
| super(0, 3600); |
| } |
| } |
| |
| /** |
| * The {@link BoolOrEnumConverter} for the {@link ConvenienceSymlinksMode} where NORMAL is true |
| * and IGNORE is false. |
| */ |
| public static class ConvenienceSymlinksConverter |
| extends BoolOrEnumConverter<ConvenienceSymlinksMode> { |
| public ConvenienceSymlinksConverter() { |
| super( |
| ConvenienceSymlinksMode.class, |
| "convenience symlinks mode", |
| ConvenienceSymlinksMode.NORMAL, |
| ConvenienceSymlinksMode.IGNORE); |
| } |
| } |
| |
| /** Determines how the convenience symlinks are presented to the user */ |
| enum ConvenienceSymlinksMode { |
| /** Will manage symlinks based on the symlink prefix. */ |
| NORMAL, |
| /** Will clean up any existing symlinks. */ |
| CLEAN, |
| /** Will not create or clean up any symlinks. */ |
| IGNORE, |
| /** Will not create or clean up any symlinks, but will record the symlinks. */ |
| LOG_ONLY |
| } |
| } |
