dataObject.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 <hicr/core/localMemorySlot.hpp>
#include <hicr/core/globalMemorySlot.hpp>
#include <hicr/core/instance.hpp>
 
namespace HiCR::objectStore
{
 
using blockId = uint32_t;
 
struct serializedMetadata_t
{
  Instance::instanceId_t instanceId;
 
  blockId id;
 
  size_t size;
 
  uint8_t serializedGlobalSlot[28 + sizeof(size_t)]; // TODO fix hard-coded size
};
 
using handle = serializedMetadata_t;
 
// Ensure the struct is trivially copyable
static_assert(std::is_trivially_copyable<serializedMetadata_t>::value, "DataObject handle must be trivially copyable");
 
class DataObject
{
  friend class ObjectStore;
 
  public:
 
  DataObject(Instance::instanceId_t instanceId, blockId id, std::shared_ptr<LocalMemorySlot> localSlot)
    : _instanceId(instanceId),
      _id(id),
      _size(0),
      _localSlot(localSlot),
      _globalSlot(nullptr)
  {
    if (_localSlot) _size = _localSlot->getSize();
  }
 
  __INLINE__ Instance::instanceId_t getInstanceId() const { return _instanceId; }
 
  __INLINE__ blockId getId() const { return _id; }
 
  __INLINE__ LocalMemorySlot &getLocalSlot() const { return *_localSlot; }
 
  private:
 
  const Instance::instanceId_t _instanceId;
 
  const blockId _id;
 
  size_t _size;
 
  std::shared_ptr<LocalMemorySlot> _localSlot;
 
  std::shared_ptr<GlobalMemorySlot> _globalSlot;
};
 
} // namespace HiCR::objectStore