feat: pthread instance manager supports only creation and not detection of new instances

Author: lterrac

examples/createInstance/include/createInstance.hpp

@@ -4,13 +4,27 @@
 #include <hicr/core/instanceManager.hpp>
 #include <hicr/core/topology.hpp>
 
-void createInstances(HiCR::InstanceManager &im, size_t instanceCount, HiCR::Topology &t)
+/**
+ * Create new HiCR instances
+ * 
+ * \param[in] instanceManager
+ * \param[in] instanceCount
+ * \param[in] topology
+*/
+void createInstances(HiCR::InstanceManager &instanceManager, size_t instanceCount, HiCR::Topology &topology)
 {
-  auto instanceTemplate = im.createInstanceTemplate(t);
+  auto instanceTemplate = instanceManager.createInstanceTemplate(topology);
 
   for (size_t i = 0; i < instanceCount; i++)
   {
-    auto instance = im.createInstance(*instanceTemplate);
-    printf("[Instance %lu] Create instance %lu\n", im.getCurrentInstance()->getId(), instance->getId());
+    auto instance = instanceManager.createInstance(*instanceTemplate);
+    printf("[Instance %lu] Create instance %lu\n", instanceManager.getCurrentInstance()->getId(), instance->getId());
   }
-}
+}
+
+/**
+ * Function that all the created instances should execute
+ * 
+ * \param[in] instanceManager
+*/
+void workerFc(HiCR::InstanceManager &instanceManager) { printf("[Instance %lu] Hello World\n", instanceManager.getCurrentInstance()->getId()); }

examples/createInstance/source/pthreads.cpp

@@ -4,65 +4,47 @@
 
 #include <hicr/backends/hwloc/topologyManager.hpp>
 #include <hicr/backends/pthreads/instanceManager.hpp>
-#include <hicr/backends/pthreads/instancePool.hpp>
 
 #include "../include/createInstance.hpp"
 
 int main(int argc, char const *argv[])
 {
   // Check argvs
-  if (argc != 3) { HICR_THROW_RUNTIME("Pass the instance count as argument"); }
+  if (argc != 2) { HICR_THROW_RUNTIME("Pass the number of instances to create as argument"); }
 
   // Get instance count
-  size_t instanceCount    = std::atoi(argv[1]);
-  size_t instanceToCreate = std::atoi(argv[2]);
+  size_t instancesToCreate = std::atoi(argv[1]);
 
   // Determine the root instance id
   HiCR::Instance::instanceId_t rootInstanceId = pthread_self();
 
-  // Create Instance pool
-  HiCR::backend::pthreads::InstancePool instancePool(0);
-
   // Declare entrypoint
-  auto entrypoint = [&](HiCR::backend::pthreads::InstanceManager *creatorIm) {
-    auto im = HiCR::backend::pthreads::InstanceManager(rootInstanceId, creatorIm->getEntrypoint(), instancePool);
-    printf("[Instance %lu] Hello World\n", im.getCurrentInstance()->getId());
-  };
-
-  // Define initial threads function
-  auto workload = [&]() {
-    // Create instance manager
-    auto im = HiCR::backend::pthreads::InstanceManager(rootInstanceId, entrypoint, instancePool);
-
-    // Detect already started instances
-    im.detectInstances(instanceCount);
+  auto entrypoint = [&](HiCR::InstanceManager *parentInstanceManager) {
+    // Cast to pthread instance manager
+    auto p = dynamic_cast<HiCR::backend::pthreads::InstanceManager *>(parentInstanceManager);
 
-    // Discover local topology
-    auto tm = HiCR::backend::hwloc::TopologyManager::createDefault();
-    auto t  = tm->queryTopology();
+    // Fail if the casting is not successful
+    if (p == nullptr) { HICR_THROW_RUNTIME("Can not cast instance manager to a pthread-specific one"); }
 
-    // Create the new instance
-    createInstances(im, instanceToCreate, t);
+    // Create instance manager
+    auto createdInstanceManager = HiCR::backend::pthreads::InstanceManager(rootInstanceId, p->getEntrypoint());
 
-    // Finalize instance manager
-    im.finalize();
+    // Run worker function
+    workerFc(createdInstanceManager);
   };
 
-  std::vector<std::unique_ptr<std::thread>> initialThreads;
-  for (size_t i = 0; i < instanceCount - 1; i++)
-  {
-    // Create thread running the workload
-    auto thread = std::make_unique<std::thread>(workload);
+  // Create instance manager
+  auto instanceManager = HiCR::backend::pthreads::InstanceManager(rootInstanceId, entrypoint);
 
-    // Add to the vector of initial threads
-    initialThreads.push_back(std::move(thread));
-  }
+  // Discover local topology
+  auto topologyManager = HiCR::backend::hwloc::TopologyManager::createDefault();
+  auto topology        = topologyManager->queryTopology();
 
-  // Run the workload
-  workload();
+  // Create the new instance
+  createInstances(instanceManager, instancesToCreate, topology);
 
-  // Wait for all the threads to join
-  for (auto &thread : initialThreads) { thread->join(); }
+  // Finalize instance manager
+  instanceManager.finalize();
 
   printf("Terminating execution\n");
 

include/hicr/backends/pthreads/instance.hpp

@@ -1,3 +1,26 @@
+/*
+ *   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.
+ */
+
+/**
+ * @file instance.hpp
+ * @brief This file implements the instance class for the Pthreads backend
+ * @author L. Terracciano
+ * @date 10/10/2025
+ */
+
 #pragma once
 
 #include <pthread.h>
@@ -7,12 +30,21 @@
 namespace HiCR::backend::pthreads
 {
 
+/**
+ * Implementation of the HiCR Instance
+*/
 class Instance : public HiCR::Instance
 {
   public:
 
-  Instance(instanceId_t currentInstanceId, instanceId_t rootInstanceId)
-    : HiCR::Instance(currentInstanceId),
+  /**
+   * Constructor
+   * 
+   * \param[in] instanceId the id of the instance
+   * \param[in] rootInstanceId the id of root
+  */
+  Instance(instanceId_t instanceId, instanceId_t rootInstanceId)
+    : HiCR::Instance(instanceId),
       _rootInstanceId(rootInstanceId){};
 
   ~Instance() = default;
@@ -21,6 +53,9 @@ class Instance : public HiCR::Instance
 
   private:
 
+  /**
+   * Id of HiCR root instance
+  */
   instanceId_t _rootInstanceId;
 };
 } // namespace HiCR::backend::pthreads