Merge pull request #50 from Algebraic-Programming/feat/channelsVarSizeHelper

Feat: channels var size helper

Author: lterrac

examples/channels/variableSize/spsc/include/consumer.hpp

@@ -36,7 +36,7 @@ void consumerFc(HiCR::MemoryManager               &coordinationMemoryManager,
   auto sizesBufferSlot = coordinationMemoryManager.allocateLocalMemorySlot(coordinationMemorySpace, sizesBufferSize);
 
   // Allocating payload buffer as a local memory slot
-  auto payloadBufferSlot = payloadMemoryManager.allocateLocalMemorySlot(payloadMemorySpace, PAYLOAD_CAPACITY * 2);
+  auto payloadBufferSlot = payloadMemoryManager.allocateLocalMemorySlot(payloadMemorySpace, HiCR::channel::variableSize::SPSC::Consumer::getPayloadBufferSize(PAYLOAD_CAPACITY));
 
   // Getting required buffer size
   auto coordinationBufferSize = HiCR::channel::variableSize::Base::getCoordinationBufferSize();

include/hicr/backends/pthreads/core.hpp

@@ -45,10 +45,10 @@ class Core
   /**
    * Constructor
    * 
-   * \param[in] fenceCount barrier size. Indicates how many threads should reach the barrier before continuing
+   * \param[in] instanceCount how many instances will be in the application
   */
-  Core(const size_t fenceCount)
-    : _fenceCount(fenceCount),
+  Core(const size_t instanceCount)
+    : _fenceCount(instanceCount),
       _currentInstanceId(0)
   {
     // Init barrier

include/hicr/frontends/channel/variableSize/spsc/consumer.hpp

@@ -134,6 +134,16 @@ class Consumer final : public variableSize::Base
     return bufferPos;
   }
 
+  /**
+   * This function can be used to check the size of the payload buffer that needs to be provided
+   * in the creation of the channel. The returned size might differ based on the specific channle implementation
+   *
+   * \param[in] payloadSize the desired payload buffer size
+   * 
+   * \return Size (bytes) of the payload buffer
+   */
+  __INLINE__ static size_t getPayloadBufferSize(const size_t payloadSize) noexcept { return payloadSize * 2; }
+
   /**
    * This function gets the (starting position, size) pair for a given element in the consumer channel
    * @param[in] pos The payload position required. \p pos = 0 indicates earliest payload that

tests/frontends/channel/variableSize/spsc/include/channelFixture.hpp

@@ -102,7 +102,8 @@ class ChannelFixture : public ::testing::Test
     auto sizesBufferSlot = coordinationMemoryManager.allocateLocalMemorySlot(coordinationMemorySpace, sizesBufferSize);
 
     // Allocating payload buffer as a local memory slot
-    auto payloadBufferSlot = payloadMemoryManager.allocateLocalMemorySlot(payloadMemorySpace, 2 * CHANNEL_CAPACITY * sizeof(ELEMENT_TYPE));
+    auto payloadBufferSlot =
+      payloadMemoryManager.allocateLocalMemorySlot(payloadMemorySpace, HiCR::channel::variableSize::SPSC::Consumer::getPayloadBufferSize(CHANNEL_CAPACITY * sizeof(ELEMENT_TYPE)));
 
     // Getting required buffer size
     auto coordinationBufferSize = HiCR::channel::variableSize::Base::getCoordinationBufferSize();