TaskManager.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_TASKMANAGER_HPP
#define HTGS_TASKMANAGER_HPP

#include <chrono>
#include <vector>
#include <memory>
#include <unordered_map>
#include <mutex>
#include <sstream>

#include <htgs/core/task/AnyTaskManager.hpp>
#include <htgs/api/ITask.hpp>

#ifdef USE_NVTX
#include <nvtx3/nvToolsExt.h>
#ifdef __linux__
#include <syscall.h>
#elif __APPLE__
#include <sys/syscall.h>
#elif _WIN32
#include <windows.h>
#endif
#endif

namespace htgs {

template<class T, class U>
class ITask;

template<class T, class U>
class TaskManager : public AnyTaskManager {
  static_assert(std::is_base_of<IData, T>::value, "T must derive from IData");
  static_assert(std::is_base_of<IData, U>::value, "U must derive from IData");

 public:
  TaskManager(ITask<T, U> *taskFunction,
              size_t numThreads,
              bool isStartTask,
              size_t pipelineId,
              size_t numPipelines,
              std::string address) :
      super(numThreads, isStartTask, pipelineId, numPipelines, address),
      inputConnector(nullptr), outputConnector(nullptr), taskFunction(taskFunction), runtimeThread(nullptr) {
    taskFunction->setTaskManager(this);
  }

  TaskManager(ITask<T, U> *taskFunction, size_t numThreads, bool isStartTask, bool poll, size_t microTimeoutTime,
              size_t pipelineId, size_t numPipelines, std::string address) : super(numThreads,
                                                                                   isStartTask,
                                                                                   poll,
                                                                                   microTimeoutTime,
                                                                                   pipelineId,
                                                                                   numPipelines,
                                                                                   address),
                                                                             inputConnector(nullptr),
                                                                             outputConnector(nullptr),
                                                                             taskFunction(taskFunction),
                                                                             runtimeThread(nullptr) {
    taskFunction->setTaskManager(this);
  }



  ~TaskManager() override {
    HTGS_DEBUG_VERBOSE("TaskManager: " << this << " is deleting task function " << taskFunction);
    delete taskFunction;
    taskFunction = nullptr;
  }

  std::shared_ptr<AnyConnector> getInputConnector() override { return this->inputConnector; }

  std::shared_ptr<AnyConnector> getOutputConnector() override { return this->outputConnector; }

  void initialize() override {
    HTGS_DEBUG("initializing: " << this->prefix() << " " << this->getName() << std::endl);
#ifdef USE_NVTX
    nvtxThreadName = this->getName() + " (" + std::to_string(this->getThreadId()) + ")";
#ifdef __linux__
    nvtxNameOsThreadA(static_cast<uint32_t>(syscall(SYS_gettid)), nvtxThreadName.c_str());
#elif __APPLE__
    nvtxNameOsThreadA(syscall(SYS_thread_selfid), nvtxThreadName.c_str());
#elif _WIN32
    nvtxNameOsThread(GetCurrentThreadId(), nvtxThreadName.c_str());
#endif
    nvtxRangeId_t rangeId = this->getProfiler()->startRangeInitializing();
#endif

    this->taskFunction->initialize(this->getPipelineId(), this->getNumPipelines(), this);

#ifdef USE_NVTX
    this->getProfiler()->endRangeInitializing(rangeId);
#endif

    this->setInitialized(true);
  }

  void setRuntimeThread(TaskManagerThread *runtimeThread) override { this->runtimeThread = runtimeThread; }

  ITask<T, U> *getTaskFunction() override {
    return this->taskFunction;
  }

  AnyTaskManager *copy(bool deep) override {
    ITask<T, U> *iTask = this->taskFunction->copyITask(deep);

    TaskManager<T, U>
        *newTask =
        new TaskManager<T, U>(iTask, this->getNumThreads(), this->isStartTask(), this->isPoll(), this->getTimeout(),
                              this->getPipelineId(), this->getNumPipelines(), this->getAddress());
    if (deep) {
      newTask->setInputConnector(this->getInputConnector());
      newTask->setOutputConnector(this->getOutputConnector());
    }
    return (AnyTaskManager *) newTask;
  }

  void executeTask() override {
#ifdef USE_NVTX
    nvtxRangeId_t rangeId;
#endif
    std::shared_ptr<T> data = nullptr;

    HTGS_DEBUG_VERBOSE(prefix() << "Running task: " << this->getName());

    if (this->isStartTask()) {
      HTGS_DEBUG_VERBOSE(prefix() << this->getName() << " is a start task");
      this->setStartTask(false);
#ifdef PROFILE
      auto start = std::chrono::high_resolution_clock::now();
#endif
#ifdef WS_PROFILE
      this->sendWSProfileUpdate(StatusCode::EXECUTE);
#endif
#ifdef USE_NVTX
      rangeId = this->getProfiler()->startRangeExecuting();
#endif
      this->taskFunction->executeTask(nullptr);

#ifdef USE_NVTX
      this->getProfiler()->endRangeExecuting(rangeId);
#endif

#ifdef WS_PROFILE
      this->sendWSProfileUpdate(StatusCode::WAITING);
#endif

#ifdef PROFILE
      auto finish = std::chrono::high_resolution_clock::now();
      this->incTaskComputeTime(std::chrono::duration_cast<std::chrono::microseconds>(finish - start).count());
#endif
      return;
    } else if (this->taskFunction->canTerminate(this->inputConnector)) {

      HTGS_DEBUG(prefix() << this->getName() << " task function is terminated");
      this->processTaskFunctionTerminated();

      return;
    }
#ifdef PROFILE
    auto start = std::chrono::high_resolution_clock::now();
#endif

#ifdef WS_PROFILE
    this->sendWSProfileUpdate(StatusCode::WAITING);
#endif

#ifdef USE_NVTX
    rangeId = this->getProfiler()->startRangeWaiting(this->inputConnector->getQueueSize());
#endif

    if (this->isPoll())
      data = this->inputConnector->pollConsumeData(this->getTimeout());
    else
      data = this->inputConnector->consumeData();

#ifdef USE_NVTX
    this->getProfiler()->endRangeWaiting(rangeId);
#endif


#ifdef PROFILE
    auto finish = std::chrono::high_resolution_clock::now();
#endif

#if defined (WS_PROFILE) && defined (VERBOSE_WS_PROFILE)
    auto waitTime = std::chrono::duration_cast<std::chrono::microseconds>(finish - start);
#endif
#ifdef PROFILE
    this->incWaitTime(std::chrono::duration_cast<std::chrono::microseconds>(finish - start).count());
#endif

    HTGS_DEBUG_VERBOSE(prefix() << this->getName() << " received data: " << data << " from " << inputConnector);

    if (data != nullptr || this->isPoll()) {
#ifdef PROFILE
      start = std::chrono::high_resolution_clock::now();
#endif
#ifdef WS_PROFILE
//      sendWSProfileUpdate(this->inputConnector.get(), StatusCode::CONSUME_DATA);
      this->sendWSProfileUpdate(StatusCode::EXECUTE);
#endif
#ifdef USE_NVTX
      rangeId = this->getProfiler()->startRangeExecuting();
#endif

      this->taskFunction->executeTask(data);

#ifdef USE_NVTX
      this->getProfiler()->endRangeExecuting(rangeId);
#endif

#ifdef PROFILE
      finish = std::chrono::high_resolution_clock::now();
      this->incTaskComputeTime(std::chrono::duration_cast<std::chrono::microseconds>(finish - start).count());
#endif



#ifdef WS_PROFILE
      // Produce meta data for task
      std::string metaDataString = this->taskFunction->profileStr();
#ifdef VERBOSE_WS_PROFILE
      // Send compute time and wait time meta
      metaDataString = metaDataString + ";waitTime:" + std::to_string(waitTime.count()) + ";computeTime:" + std::to_string(std::chrono::duration_cast<std::chrono::microseconds>(finish - start).count());

      // Send input connector queue size
      sendWSMetaProfileUpdate(this->inputConnector.get(),
      "queueSize: " + std::to_string(this->inputConnector->getQueueSize()) +
      ";maxQueueSize: " + std::to_string(this->inputConnector->getMaxQueueSize()));
#endif
      if (metaDataString != "")
      {
        sendWSMetaProfileUpdate(metaDataString);
      }
#endif

    }

  }

  size_t getThreadsRemaining() override {
    return this->runtimeThread->getThreadsRemaining();
  }



  void gatherProfileData(std::map<AnyTaskManager *, TaskManagerProfile *> *taskManagerProfiles) override {
#ifdef WS_PROFILE
    if (this->getName() == "WebSocketProfiler")
      return;
#endif
    // Create profile data for this task
    TaskManagerProfile
        *profileData = new TaskManagerProfile(this->getComputeTime(), this->getWaitTime(), this->getMaxQueueSize(), taskFunction->getMemoryWaitTime());
    taskManagerProfiles->insert(std::pair<AnyTaskManager *, TaskManagerProfile *>(this, profileData));

    // Pass gatherProfileData to ITask for further processing
    this->taskFunction->gatherProfileData(taskManagerProfiles);

  }

  void setInputConnector(std::shared_ptr<AnyConnector> connector) override {
    if (connector != nullptr)
      this->inputConnector = std::static_pointer_cast<Connector<T>>(connector);
    else
      this->inputConnector = nullptr;

  }

  void setOutputConnector(std::shared_ptr<AnyConnector> connector) override {
    if (connector != nullptr)
      this->outputConnector = std::static_pointer_cast<Connector<U>>(connector);
    else
      this->outputConnector = nullptr;
  }

  void addResult(std::shared_ptr<U> result) {
    if (this->outputConnector != nullptr) {
      this->outputConnector->produceData(result);
#ifdef WS_PROFILE
      if (result != nullptr)
        sendWSProfileUpdate(this->outputConnector.get(), StatusCode::PRODUCE_DATA);
#endif
    }
  }

  void terminateConnections() override
  {
#ifdef WS_PROFILE
    // Update output connector, this task is no longer producing for it
        this->sendWSProfileUpdate(this->getOutputConnector().get(), StatusCode::DECREMENT);
#endif
    if (this->getOutputConnector() != nullptr) {
      this->getOutputConnector()->producerFinished();

//          if (this->getOutputConnector()->isInputTerminated())
      this->getOutputConnector()->wakeupConsumer();
    }

    auto memManagerConnectorMap = this->getTaskFunction()->getReleaseMemoryEdges();

    HTGS_DEBUG(prefix() << " " << this->getName() << " Shutting down " << memManagerConnectorMap->size()
                        << " memory releasers");
    for (auto nameManagerPair : *memManagerConnectorMap) {
      HTGS_DEBUG(prefix() << " " << this->getName() << " Shutting down memory manager: " << nameManagerPair.first);


      std::shared_ptr<AnyConnector> connector = nameManagerPair.second;
#ifdef WS_PROFILE
      // TODO: This might not be necessary
          // Update memory manager connector, this task is no longer producing for it
          this->sendWSProfileUpdate(connector.get(), StatusCode::DECREMENT);
#endif
      connector->producerFinished();

      if (connector->isInputTerminated())
        connector->wakeupConsumer();
    }
  }

 private:

  void processTaskFunctionTerminated() {
    // Task is now terminated, so it is no longer alive
    this->setAlive(false);

    // Wake up the threads for this task
    if (this->getInputConnector() != nullptr)
      this->getInputConnector()->wakeupConsumer();

    // If there is a runtime thread, then begin termination
    if (this->runtimeThread != nullptr) {
      this->runtimeThread->terminate();

#ifdef WS_PROFILE
      this->sendWSProfileUpdate(StatusCode::SHUTDOWN);
#endif

      // If this is the last thread for this task then execute the task a final time (only the last thread will call this)
      if (this->runtimeThread->decrementAndCheckNumThreadsRemaining()) {

        auto start = std::chrono::high_resolution_clock::now();
        // Final execution for the task
#ifdef USE_NVTX
        nvtxRangeId_t rangeId = this->getProfiler()->startRangeExecuting();
#endif
        this->taskFunction->executeTaskFinal();

#ifdef USE_NVTX
        this->getProfiler()->endRangeExecuting(rangeId);
#endif
        auto finish = std::chrono::high_resolution_clock::now();
        this->incTaskComputeTime(std::chrono::duration_cast<std::chrono::microseconds>(finish - start).count());
      }
    } else {
      if (this->getOutputConnector() != nullptr) {
        this->getOutputConnector()->producerFinished();

        if (this->getOutputConnector()->isInputTerminated()) {
          this->getOutputConnector()->wakeupConsumer();
        }
      }
    }
  }

#ifdef WS_PROFILE
  void sendWSProfileUpdate(StatusCode code)
  {
    if (this->getName() == "WebSocketProfiler" || this->getName() == "Execution Pipeline")
      return;
    std::shared_ptr<ProfileData> updateStatus(new ChangeStatusProfile(this->getTaskFunction(), code));
    std::shared_ptr<DataPacket> dataPacket(new DataPacket(this->getName(), this->getAddress(), "WebSocketProfiler", "0", updateStatus));
    this->sendDataPacket(dataPacket);
  }

  void sendWSProfileUpdate(void * addr, StatusCode code)
  {
    if (this->getName() == "WebSocketProfiler" || this->getName() == "Execution Pipeline")
      return;
    std::shared_ptr<ProfileData> updateStatus(new ChangeStatusProfile(addr, code));
    std::shared_ptr<DataPacket> dataPacket(new DataPacket(this->getName(), this->getAddress(), "WebSocketProfiler", "0", updateStatus));
    this->sendDataPacket(dataPacket);
  }


  void sendWSMetaProfileUpdate(std::string metaData)
  {
    if (this->getName() == "WebSocketProfiler" || this->getName() == "Execution Pipeline")
      return;
    std::shared_ptr<ProfileData> updateStatus(new UpdateMetadataProfile(this->getTaskFunction(), metaData));
    std::shared_ptr<DataPacket> dataPacket(new DataPacket(this->getName(), this->getAddress(), "WebSocketProfiler", "0", updateStatus));
    this->sendDataPacket(dataPacket);
  }


  void sendWSMetaProfileUpdate(void *addr, std::string metaData)
  {
    if (this->getName() == "WebSocketProfiler" || this->getName() == "Execution Pipeline")
      return;
    std::shared_ptr<ProfileData> updateStatus(new UpdateMetadataProfile(addr, metaData));
    std::shared_ptr<DataPacket> dataPacket(new DataPacket(this->getName(), this->getAddress(), "WebSocketProfiler", "0", updateStatus));
    this->sendDataPacket(dataPacket);
  }

#endif

#ifdef USE_NVTX
  std::string nvtxThreadName;
#endif


  typedef AnyTaskManager super;

  std::shared_ptr<Connector<T>> inputConnector; 
  std::shared_ptr<Connector<U>> outputConnector; 
  ITask<T, U> *taskFunction; 
  TaskManagerThread *runtimeThread; 
};
}

#endif //HTGS_TASKMANAGER_HPP