src/main/java/com/google/devtools/build/lib/actions/LocalHostCapacity.java

// 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.actions;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.flogger.GoogleLogger;
import com.google.devtools.build.lib.concurrent.ThreadSafety.ThreadCompatible;
import com.google.devtools.build.lib.util.OS;

/**
 * This class estimates the local host's resource capacity.
 */
@ThreadCompatible
public final class LocalHostCapacity {

  private static final GoogleLogger logger = GoogleLogger.forEnclosingClass();
  private static final OS currentOS = OS.getCurrent();
  private static ResourceSet localHostCapacity;

  private LocalHostCapacity() {}

  public static ResourceSet getLocalHostCapacity() {
    if (localHostCapacity == null) {
      localHostCapacity = getNewLocalHostCapacity();
    }
    return localHostCapacity;
  }

  private static ResourceSet getNewLocalHostCapacity() {
    ResourceSet localResources = null;
    switch (currentOS) {
      case DARWIN:
        localResources = LocalHostResourceManagerDarwin.getLocalHostResources();
        break;
      case LINUX:
        localResources = LocalHostResourceManagerLinux.getLocalHostResources();
        break;
      default:
        break;
    }
    if (localResources == null) {
      localResources = LocalHostResourceFallback.getLocalHostResources();
    }

    logger.atInfo().log(
        "Determined local resources: RAM=%dMB, CPU=%.1f",
        (int) localResources.getMemoryMb(), localResources.getCpuUsage());
    return localResources;
  }

  /**
   * Sets the local host capacity to hardcoded values.
   *
   * @param capacity the explicit capacity, or null to use the machine-specific values again
   */
  @VisibleForTesting
  public static void setLocalHostCapacity(ResourceSet capacity) {
    localHostCapacity = capacity;
  }
}