hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-resourcemanager/src/main/java/org/apache/hadoop/yarn/server/resourcemanager/scheduler/fair/FSContext.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.hadoop.yarn.server.resourcemanager.scheduler.fair;

import org.apache.hadoop.yarn.api.records.Resource;

/**
 * Helper class that holds basic information to be passed around
 * FairScheduler classes. Think of this as a glorified map that holds key
 * information about the scheduler.
 */
public class FSContext {
  // Preemption-related info
  private boolean preemptionEnabled = false;
  private float preemptionUtilizationThreshold;
  private FSStarvedApps starvedApps;
  private final FairScheduler scheduler;

  FSContext(FairScheduler scheduler) {
    this.scheduler = scheduler;
  }

  boolean isPreemptionEnabled() {
    return preemptionEnabled;
  }

  void setPreemptionEnabled() {
    this.preemptionEnabled = true;
    if (starvedApps == null) {
      starvedApps = new FSStarvedApps();
    }
  }

  FSStarvedApps getStarvedApps() {
    return starvedApps;
  }

  float getPreemptionUtilizationThreshold() {
    return preemptionUtilizationThreshold;
  }

  void setPreemptionUtilizationThreshold(
      float preemptionUtilizationThreshold) {
    this.preemptionUtilizationThreshold = preemptionUtilizationThreshold;
  }

  public Resource getClusterResource() {
    return scheduler.getClusterResource();
  }
}