cache.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 <utility>
#include <vector>
#include <string>
#include <hicr/core/definitions.hpp>
#include <hicr/core/exceptions.hpp>
#include <hicr/core/computeResource.hpp>
 
namespace HiCR::backend::hwloc
{
 
class Cache
{
  public:
 
  enum cacheLevel_t
  {
    L1 = 1,
 
    L2 = 2,
 
    L3 = 3,
 
    L4 = 4,
 
    L5 = 5
  };
 
  Cache(const cacheLevel_t level, std::string type, const size_t size, const size_t lineSize, const bool shared)
    : _level(level),
      _type(std::move(type)),
      _cacheSize(size),
      _lineSize(lineSize),
      _shared(shared)
  {}
 
  Cache(const nlohmann::json &input) { deserialize(input); }
 
  [[nodiscard]] __INLINE__ size_t getSize() const { return _cacheSize; }
 
  [[nodiscard]] __INLINE__ size_t getLineSize() const { return _lineSize; }
 
  [[nodiscard]] __INLINE__ cacheLevel_t getLevel() const { return _level; }
 
  [[nodiscard]] __INLINE__ bool getShared() const { return _shared; }
 
  [[nodiscard]] __INLINE__ const std::string &getType() const { return _type; }
 
  [[nodiscard]] __INLINE__ nlohmann::json serialize() const
  {
    // Storage for newly created serialized output
    nlohmann::json output;
 
    // Getting Cache information
    output["Size (Bytes)"]      = getSize();
    output["Line Size (Bytes)"] = getLineSize();
    output["Level"]             = getLevel();
    output["Type"]              = getType();
    output["Shared"]            = getShared();
 
    // Returning serialized information
    return output;
  }
 
  __INLINE__ void deserialize(const nlohmann::json &input)
  {
    std::string key = "Size (Bytes)";
    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());
    _cacheSize = input[key].get<size_t>();
 
    key = "Line Size (Bytes)";
    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());
    _lineSize = input[key].get<size_t>();
 
    key = "Level";
    if (input.contains(key) == false) HICR_THROW_LOGIC("The serialized object contains no '%s' key", key.c_str());
    if (input[key].is_number() == false) HICR_THROW_LOGIC("The '%s' entry is not a number. Value: '%s'", key.c_str(), input[key].dump().c_str());
    _level = input[key].get<cacheLevel_t>();
 
    key = "Type";
    if (input.contains(key) == false) HICR_THROW_LOGIC("The serialized object contains no '%s' key", key.c_str());
    if (input[key].is_string() == false) HICR_THROW_LOGIC("The '%s' entry is not a number", key.c_str());
    _type = input[key].get<std::string>();
 
    key = "Shared";
    if (input.contains(key) == false) HICR_THROW_LOGIC("The serialized object contains no '%s' key", key.c_str());
    if (input[key].is_boolean() == false) HICR_THROW_LOGIC("The '%s' entry is not a number", key.c_str());
    _shared = input[key].get<bool>();
  }
 
  private:
 
  cacheLevel_t _level{};
 
  std::string _type;
 
  size_t _cacheSize{};
 
  size_t _lineSize{};
 
  bool _shared{};
 
}; // class Cache
 
} // namespace HiCR::backend::hwloc