AnyTaskManager.hpp

Go to the documentation of this file.

// NIST-developed software is provided by NIST as a public service. You may use, copy and distribute copies of the software in any medium, provided that you keep intact this entire notice. You may improve, modify and create derivative works of the software or any portion of the software, and you may copy and distribute such modifications or works. Modified works should carry a notice stating that you changed the software and should note the date and nature of any such change. Please explicitly acknowledge the National Institute of Standards and Technology as the source of the software.
// NIST-developed software is expressly provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED, IN FACT OR ARISING BY OPERATION OF LAW, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT AND DATA ACCURACY. NIST NEITHER REPRESENTS NOR WARRANTS THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR-FREE, OR THAT ANY DEFECTS WILL BE CORRECTED. NIST DOES NOT WARRANT OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF THE SOFTWARE OR THE RESULTS THEREOF, INCLUDING BUT NOT LIMITED TO THE CORRECTNESS, ACCURACY, RELIABILITY, OR USEFULNESS OF THE SOFTWARE.
// You are solely responsible for determining the appropriateness of using and distributing the software and you assume all risks associated with its use, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and the unavailability or interruption of operation. This software is not intended to be used in any situation where a failure could cause risk of injury or damage to property. The software developed by NIST employees is not subject to copyright protection within the United States.

#ifndef HTGS_ANYTASKMANAGER_HPP
#define HTGS_ANYTASKMANAGER_HPP

#include <atomic>
#include <memory>
#include <vector>

#include <htgs/types/Types.hpp>
#include <htgs/core/comm/TaskGraphCommunicator.hpp>
#include <htgs/core/graph/profile/TaskManagerProfile.hpp>
#include <htgs/core/task/AnyITask.hpp>
#include <htgs/core/graph/profile/NVTXProfiler.hpp>
#ifdef USE_NVTX
#include <nvtx3/nvToolsExt.h>
#endif

#ifdef WS_PROFILE
#include <htgs/core/graph/profile/ProfileData.hpp>
#include <htgs/core/graph/profile/CustomProfile.hpp>
#endif

namespace htgs {
class TaskManagerThread;

class AnyTaskManager {
 public:

  AnyTaskManager(size_t numThreads, bool isStartTask, size_t pipelineId, size_t numPipelines, std::string address) {
    this->taskComputeTime = 0L;
    this->taskWaitTime = 0L;
    this->poll = false;
    this->timeout = 0L;
    this->numThreads = numThreads;
    this->threadId = 0;
    this->startTask = isStartTask;
    this->pipelineId = pipelineId;
    this->numPipelines = numPipelines;
    this->alive = true;
    this->initialized = false;
    this->address = address;
  }

  AnyTaskManager(size_t numThreads,
                 bool isStartTask,
                 bool poll,
                 size_t microTimeoutTime,
                 size_t pipelineId,
                 size_t numPipelines,
                 std::string address) {
    this->taskComputeTime = 0L;
    this->taskWaitTime = 0L;
    this->poll = poll;
    this->timeout = microTimeoutTime;
    this->numThreads = numThreads;
    this->threadId = 0;
    this->startTask = isStartTask;
    this->pipelineId = pipelineId;
    this->numPipelines = numPipelines;
    this->alive = true;
    this->initialized = false;
    this->address = address;
  }


  virtual ~AnyTaskManager() {  };

  virtual AnyITask *getTaskFunction() = 0;

  virtual std::shared_ptr<AnyConnector> getInputConnector() = 0;

  virtual std::shared_ptr<AnyConnector> getOutputConnector() = 0;

  virtual AnyTaskManager *copy(bool deep)  = 0;

  virtual void initialize() = 0;

  virtual void executeTask() = 0;

  virtual void setRuntimeThread(TaskManagerThread *runtimeThread) = 0;

  virtual void setInputConnector(std::shared_ptr<AnyConnector> connector) = 0;

  virtual void setOutputConnector(std::shared_ptr<AnyConnector> connector) = 0;

  virtual void terminateConnections() = 0;

  virtual void gatherProfileData(std::map<AnyTaskManager *, TaskManagerProfile *> *taskManagerProfiles)  = 0;

  virtual size_t getThreadsRemaining() = 0;


  void printProfile() {
    std::cout << "===================== " << this->getName() << " " << prefix() << " ===================" << std::endl;
    std::cout << "COMPUTE TIME: " << getComputeTime() << " us   WAIT TIME: " << getWaitTime() << " us" << std::endl;

    if (this->getInputConnector() != nullptr) {
      std::cout << "Input connector: ";
      this->getInputConnector()->profileConsume(this->getNumThreads(), true);
    }
//    if (this->getOutputConnector() != nullptr) {
//      std::cout << "Output connector: ";
//      this->getOutputConnector()->profileProduce(this->getNumThreads());
//    }
    this->getTaskFunction()->profileITask();
    std::cout << "-------------------------- " << this->getName() << " (thread: " << this->getThreadId()
              << ") -------------------------- " << std::endl << std::endl;

    this->getTaskFunction()->printProfile();

  }


  // TODO: Delete or Add #ifdef
//  /**
//   * Sets the task graph communicator
//   * @param communicator the task graph communicator
//   */
//  void setTaskGraphCommunicator(TaskGraphCommunicator *communicator) {
//    this->taskGraphCommunicator = communicator;
//    this->getTaskFunction()->setTaskGraphCommunicator(this->taskGraphCommunicator);
//  }
//
//  /**
//   * Sends data packet along task graph communicator
//   * @param packet the data packet to communicate
//   */
//  void sendDataPacket(std::shared_ptr<DataPacket> packet)
//  {
//    this->taskGraphCommunicator->produceDataPacket(packet);
//  }

  void updateAddressAndPipelines(std::string address, size_t pipelineId, size_t numPipelines) {
    this->numPipelines = numPipelines;
    this->address = address;
    this->pipelineId = pipelineId;
  }

  std::string getAddress() {
    return this->address;
  }

  void setNumPipelines(size_t numPipelines) {
    this->numPipelines = numPipelines;
    this->getTaskFunction()->setNumPipelines(numPipelines);
  }

  size_t getNumPipelines() { return this->numPipelines; }

  void setPipelineId(size_t id) {
    this->pipelineId = id;
    this->getTaskFunction()->setPipelineId(id);
  }

  size_t getPipelineId() { return this->pipelineId; }

  size_t getNumThreads() const { return this->numThreads; }

  void setAlive(bool val) { this->alive = val; }

  bool isAlive() { return this->alive; }


  void setInitialized(bool val) {this->initialized = val; }

  bool isInitialized() { return this->initialized; }

  void setStartTask(bool val) { this->startTask = val; }

  bool isStartTask() { return this->startTask; }

  bool isPoll() { return this->poll; }

  size_t getTimeout() { return this->timeout; }

  void incTaskComputeTime(int64_t val) { this->taskComputeTime += val; }

  void incWaitTime(int64_t val) { this->taskWaitTime += val; }

  void shutdown() {
    HTGS_DEBUG("shutting down: " << this->prefix() << " " << this->getName() << std::endl);
#ifdef USE_NVTX
    nvtxRangeId_t rangeId = this->nvtxProfiler->startRangeShuttingDown();
#endif
    this->getTaskFunction()->shutdown();

#ifdef USE_NVTX
    this->nvtxProfiler->endRangeShuttingDown(rangeId);
#endif
  }

  std::string getName() { return this->getTaskFunction()->getName(); }

  void debug() {
    HTGS_DEBUG(prefix() << this->getName() << " input connector: " << getInputConnector() << " output connector: " <<
                   getOutputConnector() << " Details: " << std::endl);
    this->getTaskFunction()->debug();
  }

  std::string getNameWithPipelineId() { return this->getTaskFunction()->getNameWithPipelineId(); }

  std::string getDot(int flags) {
    if ((flags & DOTGEN_FLAG_SHOW_ALL_THREADING) != 0) {
      return this->getTaskFunction()->genDot(flags, this->getInputConnector(), this->getOutputConnector());
    } else if (this->threadId == 0) {
      return this->getTaskFunction()->genDot(flags, this->getInputConnector(), this->getOutputConnector());
    } else {
      return "";
    }
  }

  void setThreadId(size_t id) {
    this->threadId = id;
  }

  size_t getThreadId() {
    return this->threadId;
  }
  unsigned long long int getComputeTime() {
#ifdef PROFILE
    return taskComputeTime - this->getTaskFunction()->getMemoryWaitTime();
#else
    return 0;
#endif
  }

  unsigned long long int getExecuteTime() {
#ifdef PROFILE
    return taskComputeTime;
#else
    return 0;
#endif
  }

  unsigned long long int getWaitTime() {
#ifdef PROFILE
    return taskWaitTime;
#else
    return 0;
#endif
  }

  size_t getMaxQueueSize() {
#ifdef PROFILE
    return this->getInputConnector() != nullptr ? this->getInputConnector()->getMaxQueueSize() : 0;
#else
    return 0;
#endif
  }

  void resetProfile() {
    taskComputeTime = 0;
    taskWaitTime = 0;
    if (this->getInputConnector() != nullptr)
    {
      this->getInputConnector()->resetMaxQueueSize();
    }

  }

  unsigned long long int getTaskComputeTime()
  {
    return taskComputeTime;
  }

  std::string prefix() {
    return std::string(
        "Thread id: " + std::to_string(this->threadId) + " (out of " + std::to_string(this->numThreads)
            + "); Pipeline id " + std::to_string(this->pipelineId) + " (out of " + std::to_string(this->numPipelines));
    // TODO: Delete or Add #ifdef
//            ") Address: " + this->getAddress());
  }


#ifdef USE_NVTX
  void setProfiler(NVTXProfiler *profiler) {
    this->nvtxProfiler = profiler;
  }
  NVTXProfiler *getProfiler() const {
    return nvtxProfiler;
  }

  void releaseProfiler() {
    delete nvtxProfiler;
    nvtxProfiler = nullptr;
  }
#endif


 private:

  unsigned long long int taskComputeTime; 
  unsigned long long int taskWaitTime; 

  size_t timeout; 
  bool poll; 

  bool startTask; 
  bool alive; 
  bool initialized; 

  size_t threadId; 
  size_t numThreads; 

  size_t pipelineId; 
  size_t numPipelines; 
  std::string address; 

  // TODO: Delete or Add #ifdef
//  TaskGraphCommunicator *taskGraphCommunicator; //!< Task graph communicator
#ifdef USE_NVTX
  NVTXProfiler *nvtxProfiler;
#endif
};

class TaskManagerThread {
 public:
  TaskManagerThread(size_t threadId, AnyTaskManager *task, std::shared_ptr<std::atomic_size_t> numThreads, std::condition_variable *taskGraphInitializeCond, std::mutex *taskGraphInitializeMutex) {
    this->task = task;
    this->terminated = false;
    this->numThreads = numThreads;
    this->task->setRuntimeThread(this);
    this->task->setThreadId(threadId);
    this->numThreadsAfterDecrement = *this->numThreads;
    this->taskGraphInitializeCond = taskGraphInitializeCond;
    this->taskGraphInitializeMutex = taskGraphInitializeMutex;
  }

  ~TaskManagerThread() {
    HTGS_DEBUG_VERBOSE("TaskManagerThread: " << this << " is deleted");
  }

  int run() {
    // TODO: Remove?
//#ifdef USE_NVTX
//    NVTXProfiler *profiler = new NVTXProfiler();
//    task->setProfiler(profiler);
//#endif

    HTGS_DEBUG("Starting Thread for task : " << task->getName());
    this->task->initialize();

    {
      std::unique_lock<std::mutex> lock(*this->taskGraphInitializeMutex);
      this->taskGraphInitializeCond->notify_all();
    }

    while (!this->terminated) {
      this->task->executeTask();
    }
    this->task->shutdown();


    if (numThreadsAfterDecrement == 0)
    {
      this->task->terminateConnections();
    }

#ifdef USE_NVTX
    if(hasNoThreadsRemaining())
    {
      this->task->releaseProfiler();
    }
#endif

    return 0;
  }

  size_t getThreadsRemaining() { return *this->numThreads; }

  void decrementNumThreadsRemaining() { (*this->numThreads)--; }

  bool decrementAndCheckNumThreadsRemaining() {
    // Performs pre-decrement
    size_t current = this->numThreads->fetch_sub(1) - 1;
    numThreadsAfterDecrement = current;
    return current == 0;
  }

  bool hasNoThreadsRemaining() { return (*this->numThreads) == 0; }

  void terminate() { this->terminated = true; }

 private:
  volatile bool terminated; 
  std::shared_ptr<std::atomic_size_t> numThreads; 
  AnyTaskManager *task; 
  size_t numThreadsAfterDecrement; // !< The number of threads after being decremented
  std::condition_variable *taskGraphInitializeCond; 
  std::mutex *taskGraphInitializeMutex; 
};

}

#endif //HTGS_ANYTASKMANAGER_HPP