/*
GPU energy monitor code:
This header goes with the matching CUDA code and allows for easy querying of the GPU energy sensor
All codes using this monitor must be compiled with -lnvidia-ml

Copyright 2022 Texas State University

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Authors: Alex Fallin and Martin Burtscher

URL: The latest version of this code is available at
https://cs.txstate.edu/~burtscher/research/bit-flips/.
*/

#ifndef ECL_GPU_MON_H
#define ECL_GPU_MON_H

#include <nvml.h>

class GPUMonitor {
 public:
  void initMonitor(int cuda_device);
  // Returns temperature in degrees C
  unsigned int getTemperature();
  void startEnergy();
  // Returns the difference between current energy consumption and the start in mJ
  unsigned long long getEnergyConsumption();
  // Returns the memory clock speed in MHz
  unsigned int getMemClock();
  // Returns the SM clock speed in MHz
  unsigned int getSMClock();
  // Returns the graphics clock speed in MHz
  unsigned int getGraphicsClock();

 private:
  bool device_initialized = false;
  nvmlDevice_t device;
  unsigned long long starting_energy;
};
#endif