GGEMSRAMManager.hh

Go to the documentation of this file.

#ifndef GUARD_GGEMS_TOOLS_GGEMSRAMMANAGER_HH
#define GUARD_GGEMS_TOOLS_GGEMSRAMMANAGER_HH
 
// ************************************************************************
// * This file is part of GGEMS.                                          *
// *                                                                      *
// * GGEMS is free software: you can redistribute it and/or modify        *
// * it under the terms of the GNU General Public License as published by *
// * the Free Software Foundation, either version 3 of the License, or    *
// * (at your option) any later version.                                  *
// *                                                                      *
// * GGEMS is distributed in the hope that it will be useful,             *
// * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
// * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
// * GNU General Public License for more details.                         *
// *                                                                      *
// * You should have received a copy of the GNU General Public License    *
// * along with GGEMS.  If not, see <https://www.gnu.org/licenses/>.      *
// *                                                                      *
// ************************************************************************
 
#ifdef _MSC_VER
#pragma warning(disable: 4251) // Deleting warning exporting STL members!!!
#endif
 
#include <vector>
#include <unordered_map>
 
#include "GGEMS/tools/GGEMSTypes.hh"
#include "GGEMS/global/GGEMSExport.hh"
 
typedef std::unordered_map<std::string, GGsize> AllocatedMemoryUMap; 
class GGEMS_EXPORT GGEMSRAMManager
{
  private:
    GGEMSRAMManager(void);
 
    ~GGEMSRAMManager(void);
 
  public:
    static GGEMSRAMManager& GetInstance(void)
    {
      static GGEMSRAMManager instance;
      return instance;
    }
 
    GGEMSRAMManager(GGEMSRAMManager const& ram_manager) = delete;
 
    GGEMSRAMManager& operator=(GGEMSRAMManager const& ram_manager) = delete;
 
    GGEMSRAMManager(GGEMSRAMManager const&& ram_manager) = delete;
 
    GGEMSRAMManager& operator=(GGEMSRAMManager const&& ram_manager) = delete;
 
    void PrintRAMStatus(void) const;
 
    inline bool IsEnoughAvailableRAMMemory(GGsize const& index, GGsize const& size) const
    {
      if (size + allocated_ram_[index] < max_available_ram_[index]) return true;
      else return false;
    }
 
    inline bool IsBufferSizeCorrect(GGsize const& index, GGsize const& size) const
    {
      if (size < max_buffer_size_[index]) return true;
      else return false;
    }
 
    void IncrementRAMMemory(std::string const& class_name, GGsize const& index, GGsize const& size);
 
    void DecrementRAMMemory(std::string const& class_name, GGsize const& index, GGsize const& size);
 
    void Clean(void);
 
  private:
    GGsize number_detected_devices_; 
    GGsize* allocated_ram_; 
    GGsize* max_available_ram_; 
    GGsize* max_buffer_size_; 
    AllocatedMemoryUMap* allocated_memories_; 
};
 
extern "C" GGEMS_EXPORT GGEMSRAMManager* get_instance_ggems_ram_manager(void);
 
extern "C" GGEMS_EXPORT void print_infos_ram_manager(GGEMSRAMManager* ram_manager);
 
#endif // End of GUARD_GGEMS_TOOLS_GGEMSRAMMANAGER_HH