hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/java/org/apache/hadoop/yarn/server/nodemanager/webapp/dao/gpu/PerGpuTemperature.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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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.nodemanager.webapp.dao.gpu;

import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.classification.InterfaceStability;

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;

/**
 * Temperature of GPU
 */
@InterfaceAudience.Private
@InterfaceStability.Unstable
@XmlRootElement(name = "temperature")
public class PerGpuTemperature {
  private float currentGpuTemp = Float.MIN_VALUE;
  private float maxGpuTemp = Float.MIN_VALUE;
  private float slowThresholdGpuTemp = Float.MIN_VALUE;

  /**
   * Get current celsius GPU temperature
   * @return temperature
   */
  @XmlJavaTypeAdapter(PerGpuDeviceInformation.StrToFloatBeforeSpaceAdapter.class)
  @XmlElement(name = "gpu_temp")
  public Float getCurrentGpuTemp() {
    return currentGpuTemp;
  }

  public void setCurrentGpuTemp(Float currentGpuTemp) {
    this.currentGpuTemp = currentGpuTemp;
  }

  /**
   * Get max possible celsius GPU temperature
   * @return temperature
   */
  @XmlJavaTypeAdapter(PerGpuDeviceInformation.StrToFloatBeforeSpaceAdapter.class)
  @XmlElement(name = "gpu_temp_max_threshold")
  public Float getMaxGpuTemp() {
    return maxGpuTemp;
  }

  public void setMaxGpuTemp(Float maxGpuTemp) {
    this.maxGpuTemp = maxGpuTemp;
  }

  /**
   * Get celsius GPU temperature which could make GPU runs slower
   * @return temperature
   */
  @XmlJavaTypeAdapter(PerGpuDeviceInformation.StrToFloatBeforeSpaceAdapter.class)
  @XmlElement(name = "gpu_temp_slow_threshold")
  public Float getSlowThresholdGpuTemp() {
    return slowThresholdGpuTemp;
  }

  public void setSlowThresholdGpuTemp(Float slowThresholdGpuTemp) {
    this.slowThresholdGpuTemp = slowThresholdGpuTemp;
  }
}