blob: 95256a0549fd2434348fc61ad998c0cc19e7daed [file] [log] [blame]
// Copyright 2018 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;
import com.google.devtools.build.lib.util.CpuResourceConverter;
import com.google.devtools.build.lib.util.RegexFilter;
import com.google.devtools.common.options.Option;
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;
/**
* Options that affect the <i>mechanism</i> of analysis. These are distinct from {@link
* com.google.devtools.build.lib.analysis.config.BuildOptions}, which affect the <i>value</i> of a
* BuildConfigurationValue.
*/
public class AnalysisOptions extends OptionsBase {
@Option(
name = "discard_analysis_cache",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
effectTags = {OptionEffectTag.UNKNOWN},
help =
"Discard the analysis cache immediately after the analysis phase completes."
+ " Reduces memory usage by ~10%, but makes further incremental builds slower."
)
public boolean discardAnalysisCache;
@Option(
name = "max_config_changes_to_show",
defaultValue = "3",
documentationCategory = OptionDocumentationCategory.LOGGING,
effectTags = {OptionEffectTag.TERMINAL_OUTPUT},
help =
"When discarding the analysis cache due to a change in the build options, "
+ "displays up to the given number of changed option names. "
+ "If the number given is -1, all changed options will be displayed."
)
public int maxConfigChangesToShow;
@Option(
name = "experimental_extra_action_filter",
defaultValue = "",
converter = RegexFilter.RegexFilterConverter.class,
documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
effectTags = {OptionEffectTag.UNKNOWN},
help =
"Deprecated in favor of aspects. Filters set of targets to schedule extra_actions for.")
public RegexFilter extraActionFilter;
@Option(
name = "experimental_extra_action_top_level_only",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
effectTags = {OptionEffectTag.UNKNOWN},
help = "Deprecated in favor of aspects. Only schedules extra_actions for top level targets.")
public boolean extraActionTopLevelOnly;
@Option(
name = "version_window_for_dirty_node_gc",
defaultValue = "0",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = {OptionEffectTag.UNKNOWN},
help =
"Nodes that have been dirty for more than this many versions will be deleted"
+ " from the graph upon the next update. Values must be non-negative long integers,"
+ " or -1 indicating the maximum possible window."
)
public long versionWindowForDirtyNodeGc;
@Option(
name = "experimental_skyframe_prepare_analysis",
deprecationWarning = "This flag is a no-op and will be deleted in a future release.",
defaultValue = "false",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = {OptionEffectTag.BAZEL_INTERNAL_CONFIGURATION},
help = "Deprecated. No-op.")
public boolean skyframePrepareAnalysis;
@Option(
name = "experimental_skyframe_cpu_heavy_skykeys_thread_pool_size",
defaultValue = "HOST_CPUS",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
metadataTags = OptionMetadataTag.EXPERIMENTAL,
effectTags = {
OptionEffectTag.LOADING_AND_ANALYSIS,
OptionEffectTag.BAZEL_INTERNAL_CONFIGURATION
},
help =
"If set to a positive value (e.g. \"HOST_CPUS*1.5\"), Skyframe will run the"
+ " loading/analysis phase with 2 separate thread pools: 1 with <value> threads"
+ " (ideally close to HOST_CPUS) reserved for CPU-heavy SkyKeys, and 1 \"standard\""
+ " thread pool (whose size is controlled by --loading_phase_threads) for the rest.",
converter = CpuResourceConverter.class)
public int cpuHeavySkyKeysThreadPoolSize;
@Option(
name = "experimental_oom_sensitive_skyfunctions_semaphore_size",
defaultValue = "HOST_CPUS",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
metadataTags = OptionMetadataTag.EXPERIMENTAL,
effectTags = {
OptionEffectTag.LOADING_AND_ANALYSIS,
OptionEffectTag.BAZEL_INTERNAL_CONFIGURATION
},
help =
"Sets the size of the semaphore used to prevent SkyFunctions with large peak memory"
+ " requirement from OOM-ing blaze. A value of 0 indicates that no semaphore should"
+ " be used. Example value: \"HOST_CPUS*0.5\".",
converter = CpuResourceConverter.class)
public int oomSensitiveSkyFunctionsSemaphoreSize;
}