ITask.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_ITASK_HPP
#define HTGS_ITASK_HPP

#include <functional>
#include <iostream>
#include <vector>
#include <unordered_map>
#include <memory>
#include <list>
#include <assert.h>
#include <sstream>
#include <htgs/core/graph/Connector.hpp>
#include <htgs/core/task/TaskManager.hpp>

#ifdef USE_NVTX
#include <nvtx3/nvToolsExt.h>
#endif

#if defined( __GLIBCXX__ ) || defined( __GLIBCPP__ )
#include <cxxabi.h>
#endif

namespace htgs {

template<class T, class U>
class TaskManager;

template<class T, class U>
class ITask : public AnyITask {
  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:

  ITask() : super() {}

  ITask(size_t numThreads) : super(numThreads) {}

  ITask(size_t numThreads, bool isStartTask, bool poll, size_t microTimeoutTime) : super(numThreads,
                                                                                         isStartTask,
                                                                                         poll,
                                                                                         microTimeoutTime) {}



  virtual ~ITask() override {}

  virtual void initialize() override {}

  virtual void executeTask(std::shared_ptr<T> data) = 0;

  virtual bool canTerminate(std::shared_ptr<AnyConnector> inputConnector) override {
    if (inputConnector == nullptr)
      return true;

    return inputConnector->isInputTerminated();
  }

  virtual void shutdown() override {}

  virtual void executeTaskFinal() override {}


  virtual std::string getName() override {
    return "UnnamedITask";
  }

  virtual std::string getDotLabelName() override {
    return this->getName();
  }

  virtual std::string getDotShapeColor() override {
    return "black";
  }

  virtual std::string getDotFillColor() override {
    return "white";
  }

  virtual std::string getDotShape() override {
    return "box";
  }

  virtual std::string getDotCustomProfile() override {
    return "";
  }

  virtual void printProfile() override {}

  virtual ITask<T, U> *copy() = 0;

  virtual size_t getNumGraphsSpawned() { return 0; }

  virtual std::string genDotProducerEdgeToTask(std::map<std::shared_ptr<AnyConnector>, AnyITask *> &inputConnectorDotMap, int dotFlags) override
  {
    auto connectorPair = inputConnectorDotMap.find(this->ownerTask->getOutputConnector());
    if (connectorPair != inputConnectorDotMap.end())
    {
      auto consumerIds = connectorPair->second->getConsumerDotIds();
      if (consumerIds != "")
        return this->getDotId() + " -> " + connectorPair->second->getConsumerDotIds() + ";\n";
    }

    return "";
  }


  virtual std::string genDotConsumerEdgeFromConnector(std::shared_ptr<AnyConnector> connector, int flags) override
  {
    if (this->ownerTask->getInputConnector() != nullptr &&
        connector != nullptr && this->ownerTask->getInputConnector() == connector)
    {
      auto consumerIds = this->getConsumerDotIds();
      if (consumerIds != "")
        return connector->getDotId() + " -> " + this->getConsumerDotIds() + ";\n";
    }
    return "";
  }

  virtual std::string genDotProducerEdgeFromConnector(std::shared_ptr<AnyConnector> connector, int flags)
  {
    if (this->ownerTask->getOutputConnector() != nullptr &&
      connector != nullptr && this->ownerTask->getOutputConnector() == connector)
    {
      // TODO: Use a new getProducerDotIds ?
      return this->getDotId() + " -> " + connector->getDotId() + ";\n";
    }

    return "";
  }




  ITask<T, U> *copyITask(bool deep) override {
    ITask<T, U> *iTaskCopy = copy();

    HTGS_ASSERT(iTaskCopy != nullptr, "Copying Task '" << this->getName() << "' resulted in nullptr. Make sure you have the 'copy' function implemented (see https://pages.nist.gov/HTGS/doxygen/classhtgs_1_1_i_task.html#acaedf1466b238036d880efcbf1feafe6)");


    if (deep)
      copyMemoryEdges(iTaskCopy);

    return iTaskCopy;
  }

  void addResult(std::shared_ptr<U> result) {
    this->ownerTask->addResult(result);
  }

  void addResult(U *result) {
    this->ownerTask->addResult(std::shared_ptr<U>(result));
  }

  void initialize(size_t pipelineId, size_t numPipeline, TaskManager<T, U> *ownerTask) {
    this->ownerTask = ownerTask;
    super::initialize(pipelineId, numPipeline);
  }


  template<class V>
  m_data_t<V> getMemory(std::string name, IMemoryReleaseRule *releaseRule) {
    return getMemory<V>(name, releaseRule, MMType::Static, 0);
  }

  template<class V>
  m_data_t<V> getDynamicMemory(std::string name, IMemoryReleaseRule *releaseRule, size_t numElems) {
    return getMemory<V>(name, releaseRule, MMType::Dynamic, numElems);
  }

  template<class V>
  [[gnu::deprecated("Replaced by calling 'releaseMemory' directory with htgs::MemoryData (or m_data_t)")]]
  void releaseMemory(m_data_t<V> memory) {
    memory->releaseMemory();
    // TODO: Delete or Add #ifdef
//    std::shared_ptr<DataPacket> dataPacket = std::shared_ptr<DataPacket>(new DataPacket(this->getName(),
//                                                                                        this->getAddress(),
//                                                                                        memory->getMemoryManagerName(),
//                                                                                        memory->getAddress(),
//                                                                                        memory));
#ifdef USE_NVTX
    this->getOwnerTaskManager()->getProfiler()->addReleaseMarker();
#endif
//    this->getTaskGraphCommunicator()->produceDataPacket(dataPacket);
  }


  void resetProfile()
  {
    this->ownerTask->resetProfile();
  }

  size_t getThreadID()
  {
    return this->ownerTask->getThreadId();
  }

  unsigned long long int getTaskComputeTime() const {
    return this->ownerTask->getTaskComputeTime();
  }


  std::string inTypeName() override final {
#if defined( __GLIBCXX__ ) || defined( __GLIBCPP__ )
    int status;
    char *realName = abi::__cxa_demangle(typeid(T).name(), 0, 0, &status);
    std::string ret(realName);

    free(realName);

    return ret;
#else
    return typeid(T).name();
#endif

  }

  std::string outTypeName() override final {
#if defined( __GLIBCXX__ ) || defined( __GLIBCPP__ )
    int status;
    char *realName = abi::__cxa_demangle(typeid(U).name(), 0, 0, &status);
    std::string ret(realName);

    free(realName);

    return ret;
#else
    return typeid(U).name();
#endif

  }

  std::string getAddress() override final {
    return ownerTask->getAddress();
  }

  void setTaskManager(TaskManager<T, U> *ownerTask) {
    this->ownerTask = ownerTask;
  }

  TaskManager<T, U> *getOwnerTaskManager() {
    return this->ownerTask;
  }

  virtual void gatherProfileData(std::map<AnyTaskManager *, TaskManagerProfile *> *taskManagerProfiles) {}

 private:
  typedef AnyITask super;


  template<class V>
  m_data_t<V> getMemory(std::string name, IMemoryReleaseRule *releaseRule, MMType type, size_t nElem) {
    HTGS_ASSERT(this->getMemoryEdges()->find(name) != this->getMemoryEdges()->end(), "Task '" << this->getName() << "' cannot getMemory as it does not have the memory edge '" << name << "'"  );

    auto conn = getMemoryEdges()->find(name)->second;
    auto connector = std::dynamic_pointer_cast<Connector<MemoryData<V>>>(conn);

#ifdef WS_PROFILE
    sendWSProfileUpdate(StatusCode::WAITING_FOR_MEM);
#endif

#ifdef USE_NVTX
    nvtxRangeId_t rangeId = this->getOwnerTaskManager()->getProfiler()->startRangeWaitingForMemory();
#endif

#ifdef PROFILE
    auto start = std::chrono::high_resolution_clock::now();
#endif
    m_data_t<V> memory = connector->consumeData();

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

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

#ifdef WS_PROFILE
    sendWSProfileUpdate(StatusCode::EXECUTE);
#endif



    memory->setMemoryReleaseRule(releaseRule);

    if (memory->getType() != type) {
      std::cerr
        << "Error: Incorrect usage of getMemory. Dynamic memory managers use 'getDynamicMemory', Static memory managers use 'getMemory' for task '"
        << this->getName() << "' on memory edge " << name << std::endl;
      exit(-1);
    }

    if (type == MMType::Dynamic)
      memory->memAlloc(nElem);

    return memory;
  }


  TaskManager<T, U> *ownerTask; 


};

}

#endif //HTGS_ITASK_HPP