| // 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.collect.ImmutableList; |
| import com.google.devtools.common.options.Converter; |
| import com.google.devtools.common.options.Converters.CommaSeparatedOptionListConverter; |
| import com.google.devtools.common.options.Converters.DurationConverter; |
| import com.google.devtools.common.options.Converters.PercentageConverter; |
| import com.google.devtools.common.options.Converters.RangeConverter; |
| 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.OptionsBase; |
| import com.google.devtools.common.options.OptionsParsingException; |
| import java.time.Duration; |
| |
| /** Options for responding to memory pressure. */ |
| public final class MemoryPressureOptions extends OptionsBase { |
| |
| @Option( |
| name = "experimental_oom_more_eagerly_threshold", |
| defaultValue = "100", |
| documentationCategory = OptionDocumentationCategory.EXECUTION_STRATEGY, |
| effectTags = {OptionEffectTag.HOST_MACHINE_RESOURCE_OPTIMIZATIONS}, |
| converter = PercentageConverter.class, |
| help = |
| "If this flag is set to a value less than 100, Bazel will OOM if, after two full GC's, " |
| + "more than this percentage of the (old gen) heap is still occupied.") |
| public int oomMoreEagerlyThreshold; |
| |
| @Option( |
| name = "min_time_between_triggered_gc", |
| defaultValue = "1m", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| effectTags = {OptionEffectTag.BAZEL_INTERNAL_CONFIGURATION}, |
| help = "The minimum amount of time between GCs triggered by RetainedHeapLimiter.") |
| public Duration minTimeBetweenTriggeredGc; |
| |
| @Option( |
| name = "skyframe_high_water_mark_threshold", |
| defaultValue = "85", |
| documentationCategory = OptionDocumentationCategory.BUILD_TIME_OPTIMIZATION, |
| effectTags = {OptionEffectTag.HOST_MACHINE_RESOURCE_OPTIMIZATIONS}, |
| help = |
| "Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects" |
| + " its retained heap percentage usage is at least this threshold, it will drop" |
| + " unnecessary temporary Skyframe state. Tweaking this may let you mitigate wall" |
| + " time impact of GC thrashing, when the GC thrashing is (i) caused by the memory" |
| + " usage of this temporary state and (ii) more costly than reconstituting the state" |
| + " when it is needed.") |
| public int skyframeHighWaterMarkMemoryThreshold; |
| |
| @Option( |
| name = "skyframe_high_water_mark_minor_gc_drops_per_invocation", |
| defaultValue = "" + Integer.MAX_VALUE, |
| documentationCategory = OptionDocumentationCategory.BUILD_TIME_OPTIMIZATION, |
| effectTags = {OptionEffectTag.HOST_MACHINE_RESOURCE_OPTIMIZATIONS}, |
| converter = NonNegativeIntegerConverter.class, |
| help = |
| "Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects" |
| + " its retained heap percentage usage exceeds the threshold set by" |
| + " --skyframe_high_water_mark_threshold, when a minor GC event occurs, it will drop" |
| + " unnecessary temporary Skyframe state, up to this many times per invocation." |
| + " Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that minor GC" |
| + " events will never trigger drops. If the limit is reached, Skyframe state will no" |
| + " longer be dropped when a minor GC event occurs and that retained heap percentage" |
| + " threshold is exceeded.") |
| public int skyframeHighWaterMarkMinorGcDropsPerInvocation; |
| |
| @Option( |
| name = "skyframe_high_water_mark_full_gc_drops_per_invocation", |
| defaultValue = "" + Integer.MAX_VALUE, |
| documentationCategory = OptionDocumentationCategory.BUILD_TIME_OPTIMIZATION, |
| effectTags = {OptionEffectTag.HOST_MACHINE_RESOURCE_OPTIMIZATIONS}, |
| converter = NonNegativeIntegerConverter.class, |
| help = |
| "Flag for advanced configuration of Bazel's internal Skyframe engine. If Bazel detects" |
| + " its retained heap percentage usage exceeds the threshold set by" |
| + " --skyframe_high_water_mark_threshold, when a full GC event occurs, it will drop" |
| + " unnecessary temporary Skyframe state, up to this many times per invocation." |
| + " Defaults to Integer.MAX_VALUE; effectively unlimited. Zero means that full GC" |
| + " events will never trigger drops. If the limit is reached, Skyframe state will no" |
| + " longer be dropped when a full GC event occurs and that retained heap percentage" |
| + " threshold is exceeded.") |
| public int skyframeHighWaterMarkFullGcDropsPerInvocation; |
| |
| @Option( |
| name = "experimental_gc_thrashing_limits", |
| defaultValue = "", |
| documentationCategory = OptionDocumentationCategory.BUILD_TIME_OPTIMIZATION, |
| effectTags = {OptionEffectTag.HOST_MACHINE_RESOURCE_OPTIMIZATIONS}, |
| converter = GcThrashingLimitsConverter.class, |
| help = |
| "Limits which, if reached, cause GcThrashingDetector to crash Bazel with an OOM. Each" |
| + " limit is specified as <period>:<count> where period is a duration and count is a" |
| + " positive integer. If more than --experimental_oom_more_eagerly_threshold percent" |
| + " of tenured space (old gen heap) remains occupied after <count> consecutive full" |
| + " GCs within <period>, an OOM is triggered. Multiple limits can be specified" |
| + " separated by commas.") |
| public ImmutableList<GcThrashingDetector.Limit> gcThrashingLimits; |
| |
| @Option( |
| name = "gc_thrashing_limits_retained_heap_limiter_mutually_exclusive", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.BUILD_TIME_OPTIMIZATION, |
| effectTags = {OptionEffectTag.HOST_MACHINE_RESOURCE_OPTIMIZATIONS}, |
| help = |
| "If true, specifying non-empty --experimental_gc_thrashing_limits deactivates" |
| + " RetainedHeapLimiter to make it mutually exclusive with GcThrashingDetector." |
| + " Setting to false permits both to be active for the same command.") |
| public boolean gcThrashingLimitsRetainedHeapLimiterMutuallyExclusive; |
| |
| static final class NonNegativeIntegerConverter extends RangeConverter { |
| NonNegativeIntegerConverter() { |
| super(0, Integer.MAX_VALUE); |
| } |
| } |
| |
| static final class GcThrashingLimitsConverter |
| extends Converter.Contextless<ImmutableList<GcThrashingDetector.Limit>> { |
| private final CommaSeparatedOptionListConverter commaListConverter = |
| new CommaSeparatedOptionListConverter(); |
| private final DurationConverter durationConverter = new DurationConverter(); |
| private final RangeConverter positiveIntConverter = new RangeConverter(1, Integer.MAX_VALUE); |
| |
| @Override |
| public ImmutableList<GcThrashingDetector.Limit> convert(String input) |
| throws OptionsParsingException { |
| ImmutableList.Builder<GcThrashingDetector.Limit> result = ImmutableList.builder(); |
| for (String part : commaListConverter.convert(input)) { |
| int colonIndex = part.indexOf(':'); |
| if (colonIndex == -1) { |
| throw new OptionsParsingException("Expected <period>:<count>, got " + part); |
| } |
| Duration period = durationConverter.convert(part.substring(0, colonIndex)); |
| int count = positiveIntConverter.convert(part.substring(colonIndex + 1)); |
| result.add(GcThrashingDetector.Limit.of(period, count)); |
| } |
| return result.build(); |
| } |
| |
| @Override |
| public String getTypeDescription() { |
| return "comma separated pairs of <period>:<count>"; |
| } |
| } |
| } |
