localMemorySlot.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 <memory>
#include <hicr/core/definitions.hpp>
#include <hicr/core/memorySpace.hpp>
#include <utility>
 
namespace HiCR
{
class CommunicationManager;
}
 
namespace HiCR
{
 
class LocalMemorySlot
{
  friend class HiCR::CommunicationManager;
 
  public:
 
  LocalMemorySlot(void *const pointer, const size_t size, std::shared_ptr<HiCR::MemorySpace> memorySpace = nullptr)
    : _pointer(pointer),
      _size(size),
      _memorySpace(std::move(memorySpace))
  {
    _messagesRecv = &_messagesRecvStorage;
    _messagesSent = &_messagesSentStorage;
  }
 
  virtual ~LocalMemorySlot() = default;
 
  __INLINE__ void *&getPointer() noexcept { return _pointer; }
 
  [[nodiscard]] __INLINE__ size_t getSize() const noexcept { return _size; }
 
  [[nodiscard]] __INLINE__ std::shared_ptr<HiCR::MemorySpace> getMemorySpace() const noexcept { return _memorySpace; }
 
  [[nodiscard]] __INLINE__ size_t getMessagesRecv() const noexcept { return *_messagesRecv; }
 
  [[nodiscard]] __INLINE__ size_t getMessagesSent() const noexcept { return *_messagesSent; }
 
  private:
 
  __INLINE__ void increaseMessagesRecv() noexcept { *_messagesRecv = *_messagesRecv + 1; }
 
  __INLINE__ void increaseMessagesSent() noexcept { *_messagesSent = *_messagesSent + 1; }
 
  __INLINE__ __volatile__ size_t *&getMessagesRecvPointer() noexcept { return _messagesRecv; }
 
  __INLINE__ __volatile__ size_t *&getMessagesSentPointer() noexcept { return _messagesSent; }
 
  __INLINE__ void setMessagesRecv(const size_t count) noexcept { *_messagesRecv = count; }
 
  __INLINE__ void setMessagesSent(const size_t count) noexcept { *_messagesSent = count; }
 
  void *_pointer;
 
  const size_t _size;
 
  std::shared_ptr<MemorySpace> const _memorySpace;
 
  __volatile__ size_t *_messagesRecv;
 
  __volatile__ size_t *_messagesSent;
 
  __volatile__ size_t _messagesRecvStorage{0};
 
  __volatile__ size_t _messagesSentStorage{0};
};
 
} // namespace HiCR