abstract_memory_manager.h

Go to the documentation of this file.

// NIST-developed software is provided by NIST as a public service. You may use, copy and distribute copies of the
// software in any medium, provided that you keep intact this entire notice. You may improve, modify and create
// derivative works of the software or any portion of the software, and you may copy and distribute such modifications
// or works. Modified works should carry a notice stating that you changed the software and should note the date and
// nature of any such change. Please explicitly acknowledge the National Institute of Standards and Technology as the
// source of the software. NIST-developed software is expressly provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND,
// EXPRESS, IMPLIED, IN FACT OR ARISING BY OPERATION OF LAW, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT AND DATA ACCURACY. NIST NEITHER REPRESENTS NOR
// WARRANTS THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR-FREE, OR THAT ANY DEFECTS WILL BE
// CORRECTED. NIST DOES NOT WARRANT OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF THE SOFTWARE OR THE RESULTS
// THEREOF, INCLUDING BUT NOT LIMITED TO THE CORRECTNESS, ACCURACY, RELIABILITY, OR USEFULNESS OF THE SOFTWARE. You
// are solely responsible for determining the appropriateness of using and distributing the software and you assume
// all risks associated with its use, including but not limited to the risks and costs of program errors, compliance
// with applicable laws, damage to or loss of data, programs or equipment, and the unavailability or interruption of
// operation. This software is not intended to be used in any situation where a failure could cause risk of injury or
// damage to property. The software developed by NIST employees is not subject to copyright protection within the
// United States.
 
#ifndef HEDGEHOG_ABSTRACT_MEMORY_MANAGER_H_
#define HEDGEHOG_ABSTRACT_MEMORY_MANAGER_H_
 
#pragma once
 
#include <memory>
#include <mutex>
 
#include "../pool.h"
#include "../../../tools/nvtx_profiler.h"
 
namespace hh {
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
class ManagedMemory;
#endif //DOXYGEN_SHOULD_SKIP_THIS
 
class AbstractMemoryManager {
 private:
  int deviceId_ = 0; 
  bool initialized_ = false; 
  std::unique_ptr<tool::Pool<ManagedMemory>> pool_ = {}; 
  std::shared_ptr<NvtxProfiler> profiler_ = nullptr; 
 protected:
  std::mutex memoryManagerMutex_ = {}; 
 
 public:
  explicit AbstractMemoryManager(size_t const &capacity) :
      deviceId_(0),
      pool_(std::make_unique<tool::Pool<ManagedMemory>>(capacity > 0 ? capacity : 1)) {}
 
  virtual ~AbstractMemoryManager() = default;
 
  [[nodiscard]] int deviceId() const { return deviceId_; }
 
  [[nodiscard]] size_t currentSize() {
    memoryManagerMutex_.lock();
    auto s = this->pool()->size();
    memoryManagerMutex_.unlock();
    return s;
  }
 
  [[nodiscard]] size_t capacity() const {
    return this->pool()->capacity();
  };
 
  void deviceId(int deviceId) { deviceId_ = deviceId; }
 
  void profiler(const std::shared_ptr<NvtxProfiler> &profiler) { this->profiler_ = profiler; }
 
  virtual std::shared_ptr<ManagedMemory> getManagedMemory() = 0;
 
  virtual void recycleMemory(std::shared_ptr<ManagedMemory> const &managedMemory) = 0;
 
  virtual std::shared_ptr<AbstractMemoryManager> copy() = 0;
 
  virtual void initialize() = 0;
 
  [[nodiscard]] virtual std::string managedType() const = 0;
 
 protected:
  [[nodiscard]] std::shared_ptr<NvtxProfiler> const &profiler() const {
    return profiler_;
  }
 
  [[nodiscard]] std::unique_ptr<tool::Pool<ManagedMemory>> const &pool() const { return pool_; }
 
  [[nodiscard]] bool isInitialized() const { return initialized_; }
 
  [[nodiscard]] std::mutex &memoryManagerMutex() { return memoryManagerMutex_; }
 
  void initialized() { initialized_ = true; }
};
}
 
#endif //HEDGEHOG_ABSTRACT_MEMORY_MANAGER_H_