AnyTaskGraphConf.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_ANYTASKGRAPHCONF_HPP
#define HTGS_ANYTASKGRAPHCONF_HPP

#include <list>
#include <string>
#include <cstddef>
#include <fstream>

#include <htgs/core/task/TaskManager.hpp>
#include <htgs/api/ITask.hpp>
#include <htgs/api/IRule.hpp>
#include <htgs/core/graph/edge/EdgeDescriptor.hpp>
#include <htgs/core/task/AnyITask.hpp>
#include <htgs/types/Types.hpp>
#include <htgs/core/graph/profile/TaskManagerProfile.hpp>
#ifdef WS_PROFILE
#include <htgs/core/graph/profile/ProfileData.hpp>
#endif

namespace htgs {

typedef std::map<AnyITask *, AnyTaskManager *> ITaskMap;

typedef std::pair<AnyITask *, AnyTaskManager *> ITaskPair;

typedef std::unordered_multimap<std::string, std::shared_ptr<AnyConnector>> TaskNameConnectorMap;

typedef std::pair<std::string, std::shared_ptr<AnyConnector>> TaskNameConnectorPair;

class AnyTaskGraphConf {
 public:

  AnyTaskGraphConf(size_t pipelineId, size_t numPipelines, std::string baseAddress) :
      pipelineId(pipelineId), numPipelines(numPipelines) {
    this->graphCreationTimestamp = std::chrono::high_resolution_clock::now();
    this->graphComputeTime = 0;
    this->graphCreationTime = 0;

    if (baseAddress == "")
      this->address = std::to_string(pipelineId);
    else
      this->address = baseAddress + ":" + std::to_string(this->pipelineId);
    this->taskManagers = new std::list<AnyTaskManager *>();
    this->taskCopyMap = new ITaskMap();
    this->taskConnectorNameMap = new TaskNameConnectorMap();
    this->numberOfSubGraphs = 0;
    this->iRuleMap = new IRuleMap();
    this->memAllocMap = new MemAllocMap();
  }


  virtual ~AnyTaskGraphConf() {
    for (auto task : *taskManagers) {
      if (task != nullptr) {
        HTGS_DEBUG_VERBOSE("AnyTaskGraphConf: " << this << " Freeing memory for TaskManager: " << task);

        delete task;
        task = nullptr;
      }
    }
    delete taskManagers;

    delete taskCopyMap;
    taskCopyMap = nullptr;

    delete taskConnectorNameMap;
    taskConnectorNameMap = nullptr;

    delete iRuleMap;
    iRuleMap = nullptr;

    delete memAllocMap;
    memAllocMap = nullptr;
  }

//  virtual AnyTaskManager *getGraphConsumerTaskManager() = 0;

//  virtual std::list<AnyTaskManager *> *getGraphProducerTaskManagers() = 0;

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

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

  // TODO: Delete or Add #ifdef
//  /**
//   * Virtual function that initiates updating the task graph communicator.
//   */
//  virtual void updateCommunicator() = 0;

  // TODO: Delete or Add #ifdef
//  /**
//   * Virtual function that gets the task graph communicator.
//   * @return
//   */
//  virtual TaskGraphCommunicator *getTaskGraphCommunicator() const = 0;

#ifdef WS_PROFILE

  virtual void sendProfileData(std::shared_ptr<ProfileData> profileData) = 0;
#endif



  std::list<AnyTaskManager *> *getTaskManagers() {
    return this->taskManagers;
  }

  void gatherProfilingData(std::map<AnyTaskManager *, TaskManagerProfile *> *taskManagerProfiles) {
    for (auto tMan : *taskManagers) {
      tMan->gatherProfileData(taskManagerProfiles);
    }
  }

  template<class V, class W>
  std::shared_ptr<IRule<V, W>> getIRule(IRule<V, W> *iRule) {
    std::shared_ptr<IRule<V, W>> iRuleShr;
    if (this->iRuleMap->find(iRule) != this->iRuleMap->end()) {
      std::shared_ptr<AnyIRule> baseRulePtr = this->iRuleMap->find(iRule)->second;
      iRuleShr = std::static_pointer_cast<IRule<V, W>>(baseRulePtr);
    } else {
      iRuleShr = std::shared_ptr<IRule<V, W>>(iRule);
      this->iRuleMap->insert(IRulePair(iRule, iRuleShr));
    }
    return iRuleShr;
  }

  template<class V>
  std::shared_ptr<IMemoryAllocator<V>> getMemoryAllocator(IMemoryAllocator<V> *allocator) {
    std::shared_ptr<IMemoryAllocator<V>> allocP;

    if (this->memAllocMap->find(allocator) == this->memAllocMap->end()) {
      allocP = std::shared_ptr<IMemoryAllocator<V>>(allocator);
      memAllocMap->insert(MemAllocPair(allocator, allocP));
    } else {
      allocP = std::static_pointer_cast<IMemoryAllocator<V>>(this->memAllocMap->at(allocator));
    }

    return allocP;
  }

  void initialize() {
    // TODO: Delete or Add #ifdef
//    this->getTaskGraphCommunicator()->setNumGraphsSpawned(this->getNumberOfSubGraphs());

    this->updateTaskManagersAddressingAndPipelines();
//    this->updateCommunicator();



    auto endTime = std::chrono::high_resolution_clock::now();
    this->graphCreationTime =
      static_cast<unsigned long long int>(std::chrono::duration_cast<std::chrono::microseconds>(endTime - graphCreationTimestamp).count());

    this->graphExecutingTimestamp = std::chrono::high_resolution_clock::now();
  }

  virtual void finishedSetup() { }

  void shutdown() {
    auto endTime = std::chrono::high_resolution_clock::now();

    graphComputeTime =
      static_cast<unsigned long long int>(std::chrono::duration_cast<std::chrono::microseconds>(endTime - graphExecutingTimestamp).count());

  }

    void waitForInitialization() {
      std::unique_lock<std::mutex> lock(this->initializeMutex);
      this->initializeCondition.wait(lock, [=]
      {
        bool ret = true;
        for (AnyTaskManager *tm : *taskManagers)
        {
          if(!tm->isInitialized()) {
            ret = false;
            break;
          }
        }

        return ret;
      });

    }

    std::condition_variable *getInitializationCondition() {
      return &this->initializeCondition;
    }

    std::mutex *getInitializationMutex() {
      return &this->initializeMutex;
    }

  TaskNameConnectorMap *getTaskConnectorNameMap() const {
    return taskConnectorNameMap;
  }

  template<class T, class U>
  ITask<T, U> *getCopy(ITask<T, U> *orig) {
    for (auto tCopy : *taskCopyMap) {
      if (tCopy.first == orig) {
        return (ITask<T, U> *) tCopy.second->getTaskFunction();
      }
    }

    return nullptr;
  }

  AnyITask *getCopy(AnyITask *orig) {
    for (auto tCopy : *taskCopyMap) {
      if (tCopy.first == orig) {
        return tCopy.second->getTaskFunction();
      }
    }

    return nullptr;
  }

  template<class T, class U>
  TaskManager<T, U> *getTaskManager(ITask<T, U> *task) {

    TaskManager<T, U> *taskManager = nullptr;

    for (auto tSched : *taskManagers) {
      if (tSched->getTaskFunction() == task) {
        taskManager = (TaskManager<T, U> *) tSched;
        break;
      }
    }

    if (taskManager == nullptr) {
      taskManager = new TaskManager<T, U>(task,
                                          task->getNumThreads(),
                                          task->isStartTask(),
                                          task->isPoll(),
                                          task->getMicroTimeoutTime(),
                                          pipelineId,
                                          numPipelines,
                                          address);
      this->taskManagers->push_back(taskManager);

      // Increment number of graphs spawned from the task
      this->numberOfSubGraphs += task->getNumGraphsSpawned();
    }

    return taskManager;

  }

  void addTaskManager(AnyTaskManager *taskManager) {
    for (auto tMan : *taskManagers) {
      if (tMan == taskManager)
        return;
    }

    this->taskManagers->push_back(taskManager);
  }

  void printProfile() {
    for (auto tMan : *taskManagers) {
      tMan->printProfile();
    }
  }

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

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

  void writeDotToFile(std::string file, int flags = 0, std::string graphTitle = "", std::string customTitleText = "") {

    if ((flags & DOTGEN_FLAG_SHOW_CONNECTORS) == 0 && (flags & DOTGEN_FLAG_SHOW_CONNECTOR_VERBOSE) == 0) {

      if ((flags & DOTGEN_FLAG_SHOW_ALL_THREADING) != 0) {
        std::cerr
            << "DOT visualization without connectors does not support showing all threading. Adding DOTGEN_FLAG_SHOW_CONNECTORS flag."
            << std::endl;
        flags = flags | DOTGEN_FLAG_SHOW_CONNECTORS;

      }
    }

    bool graphColored = false;
#ifdef PROFILE
    if ((flags & DOTGEN_COLOR_COMP_TIME) != 0) {
      std::string name = "color-compute-time-" + file;
      std::ofstream f(name);
      f << genDotGraph(flags, DOTGEN_COLOR_COMP_TIME, graphTitle, customTitleText);
      f.flush();

      std::cout << "Writing dot file for task graph with compute time coloring to " << name << std::endl;

      graphColored = true;
    }

    if ((flags & DOTGEN_COLOR_WAIT_TIME) != 0) {
      std::string name = "color-wait-time-" + file;

      std::ofstream f(name);
      f << genDotGraph(flags, DOTGEN_COLOR_WAIT_TIME, graphTitle, customTitleText);
      f.flush();

      std::cout << "Writing dot file for task graph with wait time coloring to " << name << std::endl;

      graphColored = true;
    }

    if ((flags & DOTGEN_COLOR_MAX_Q_SZ) != 0) {
      std::string name = "color-max-q-sz-" + file;

      std::ofstream f(name);
      f << genDotGraph(flags, DOTGEN_COLOR_MAX_Q_SZ, graphTitle, customTitleText);
      f.flush();

      std::cout << "Writing dot file for task graph with max Q size coloring to " << name << std::endl;

      graphColored = true;
    }
#endif

    if (!graphColored) {
      std::ofstream f(file);
      f << genDotGraph(flags, 0, graphTitle, customTitleText);
      f.flush();

      std::cout << "Writing dot file for task graph to " << file << std::endl;
    }
  }

  virtual void updateTaskManagersAddressingAndPipelines() = 0;

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

  size_t getNumberOfSubGraphs() const {
    return numberOfSubGraphs;
  }

  unsigned long long int getGraphComputeTime() const {
    return graphComputeTime;
  }
  unsigned long long int getGraphCreationTime() const {
    return graphCreationTime;
  }

  std::string genDotGraphContent(int flags) {
    std::ostringstream oss;

    for (AnyTaskManager *bTask : *taskManagers) {
      oss << bTask->getDot(flags);
    }

    return oss.str();
  }

  virtual AnyTaskGraphConf *copy() = 0;

  virtual std::string genDotGraph(int flags, int colorFlag, std::string graphTitle = "", std::string customTitleText = "") = 0;

  void copyTasks(std::list<AnyTaskManager *> *tasks) {
    for (auto task : *tasks) {
      this->createCopy(task);
    }
  }

  AnyTaskManager *getTaskManagerCopy(AnyITask *iTask) {
    for (auto tCopy : *taskCopyMap) {
      if (tCopy.first == iTask) {
        return tCopy.second;
      }
    }

    return nullptr;
  }

  bool hasTask(AnyITask *task) {
    for (auto taskSched : *taskManagers) {
      if (taskSched->getTaskFunction() == task)
        return true;
    }

    return false;
  }

 private:

  void createCopy(AnyTaskManager *taskManager) {
    AnyITask *origITask = taskManager->getTaskFunction();

    // If the original ITask is not in the taskCopyMap, then add a new copy and map it to the original
    if (this->taskCopyMap->find(origITask) == this->taskCopyMap->end()) {
      AnyTaskManager *taskManagerCopy = taskManager->copy(false);
      taskCopyMap->insert(ITaskPair(origITask, taskManagerCopy));
      taskManagers->push_back(taskManagerCopy);
    }
  }

  ITaskMap *taskCopyMap; 
  std::list<AnyTaskManager *> *taskManagers; 

  size_t pipelineId; 
  size_t numPipelines; 

  std::string address; 
  TaskNameConnectorMap *taskConnectorNameMap; 

  size_t numberOfSubGraphs; 

  IRuleMap *iRuleMap; 
  MemAllocMap *memAllocMap; 


  std::chrono::time_point<std::chrono::high_resolution_clock> graphCreationTimestamp; 
  std::chrono::time_point<std::chrono::high_resolution_clock> graphExecutingTimestamp; 
  unsigned long long int graphComputeTime; 
  unsigned long long int graphCreationTime; 

    std::condition_variable initializeCondition; 
    std::mutex initializeMutex; 

  };

}

#endif //HTGS_ANYTASKGRAPHCONF_HPP