memorySpace.hpp

Go to the documentation of this file.

/*
 *   Copyright 2025 Huawei Technologies Co., Ltd.
 *
 * Licensed 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.
 */
 
#pragma once
 
#include <string>
#include <nlohmann_json/json.hpp>
#include <hicr/core/exceptions.hpp>
 
namespace HiCR
{
 
class MemorySpace
{
  public:
 
  [[nodiscard]] virtual std::string getType() const = 0;
 
  [[nodiscard]] __INLINE__ virtual const size_t getSize() const { return _size; }
 
  [[nodiscard]] __INLINE__ virtual size_t getUsage() const { return _usage; };
 
  __INLINE__ void increaseUsage(const size_t delta)
  {
    if (_usage + delta > _size)
      HICR_THROW_LOGIC("Increasing memory space usage beyond its capacity (current_usage + increase > capacity | %lu + %lu > %lu)\n", _usage, delta, _size);
 
    _usage += delta;
  }
 
  __INLINE__ void decreaseUsage(const size_t delta)
  {
    if (delta > _usage) HICR_THROW_LOGIC("Decreasing memory space usage below zero (probably a bug in HiCR) (current_usage - decrease < 0 | %lu - %lu < 0)\n", _usage, delta);
 
    _usage -= delta;
  }
 
  virtual ~MemorySpace() = default;
 
  [[nodiscard]] __INLINE__ nlohmann::json serialize() const
  {
    // Storage for newly created serialized output
    nlohmann::json output;
 
    // Adding backend-specific information
    serializeImpl(output);
 
    // Getting memory space type
    output["Type"] = getType();
 
    // Getting size
    output["Size"] = getSize();
 
    // Getting current usage
    output["Usage"] = getUsage();
 
    // Returning serialized information
    return output;
  }
 
  __INLINE__ void deserialize(const nlohmann::json &input)
  {
    // Obtaining backend-specific information
    deserializeImpl(input);
 
    // Deserializing size
    std::string key = "Size";
    if (input.contains(key) == false) HICR_THROW_LOGIC("The serialized object contains no '%s' key", key.c_str());
    if (input[key].is_number_unsigned() == false) HICR_THROW_LOGIC("The '%s' entry is not a number", key.c_str());
    _size = input[key].get<size_t>();
 
    // Deserializing usage
    key = "Usage";
    if (input.contains(key) == false) HICR_THROW_LOGIC("The serialized object contains no '%s' key", key.c_str());
    if (input[key].is_number_unsigned() == false) HICR_THROW_LOGIC("The '%s' entry is not a number", key.c_str());
    _usage = input[key].get<size_t>();
  }
 
  protected:
 
  MemorySpace(const size_t size)
    : _size(size){};
 
  MemorySpace() = default;
 
  virtual void serializeImpl(nlohmann::json &output) const = 0;
 
  virtual void deserializeImpl(const nlohmann::json &input) = 0;
 
  private:
 
  size_t _size{};
 
  size_t _usage = 0;
};
 
} // namespace HiCR