AnyITask.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_ANYITASK_HPP
#define HTGS_ANYITASK_HPP

#include <memory>
#include <cassert>
#include <sstream>

#include <htgs/core/task/AnyTaskManager.hpp>
#include <htgs/api/MemoryData.hpp>
#include <htgs/core/graph/Connector.hpp>
#include <htgs/core/graph/AnyConnector.hpp>
#include <htgs/types/Types.hpp>
#include <htgs/types/MMType.hpp>
#include <htgs/debug/debug_message.hpp>
#include <htgs/types/TaskGraphDotGenFlags.hpp>
#include <htgs/utils/ProfileUtils.hpp>


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


namespace htgs {

  class AnyTaskManager;

class AnyITask {
 public:

  AnyITask() {
    this->numThreads = 1;
    this->startTask = false;
    this->poll = false;
    this->microTimeoutTime = 0;
    this->memoryWaitTime = 0;

    memoryEdges = std::shared_ptr<ConnectorMap>(new ConnectorMap());
    releaseMemoryEdges = std::shared_ptr<ConnectorMap>(new ConnectorMap());

    this->pipelineId = 0;
    this->numPipelines = 1;
  }

  AnyITask(size_t numThreads) {
    this->numThreads = numThreads;
    this->startTask = false;
    this->poll = false;
    this->microTimeoutTime = 0L;
    this->memoryWaitTime = 0;

    memoryEdges = std::shared_ptr<ConnectorMap>(new ConnectorMap());
    releaseMemoryEdges = std::shared_ptr<ConnectorMap>(new ConnectorMap());

    this->pipelineId = 0;
    this->numPipelines = 1;
  }

  AnyITask(size_t numThreads, bool isStartTask, bool poll, size_t microTimeoutTime) {
    this->numThreads = numThreads;
    this->startTask = isStartTask;
    this->poll = poll;
    this->microTimeoutTime = microTimeoutTime;
    this->memoryWaitTime = 0;

    memoryEdges = std::shared_ptr<ConnectorMap>(new ConnectorMap());
    releaseMemoryEdges = std::shared_ptr<ConnectorMap>(new ConnectorMap());

    this->pipelineId = 0;
    this->numPipelines = 1;
  }



  virtual ~AnyITask() {}

  virtual AnyITask *copy() = 0;

  virtual std::string getName() = 0;

  virtual std::string getDotLabelName() = 0;

  virtual std::string getDotShapeColor() = 0;

  virtual std::string getDotFillColor() = 0;

  virtual std::string getDotShape() = 0;

  virtual std::string getDotCustomProfile() = 0;

  virtual void shutdown() = 0;

  virtual void initialize() = 0;

  virtual void executeTaskFinal() = 0;

  virtual bool canTerminate(std::shared_ptr<AnyConnector> inputConnector) = 0;

  virtual std::string genDot(int flags,
                             std::string dotId,
                             std::shared_ptr<htgs::AnyConnector> input,
                             std::shared_ptr<htgs::AnyConnector> output) {
    std::ostringstream oss;

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

      if (input != nullptr) {
        oss << input->getDotId() << " -> " << dotId << ";" << std::endl;
        oss << input->genDot(flags);
      }

      if (output != nullptr) {
        oss << dotId << " -> " << output->getDotId() << ";" << std::endl;
        oss << output->genDot(flags);
      }
    }

    oss << genDot(flags, dotId);

    return oss.str();
  }


  virtual std::string getConsumerDotIds() {
    return this->getDotId();
  }

  virtual std::string getProducerDotIds() {
    return this->getDotId();
  }


  virtual std::string genDotProducerEdgeToTask(std::map<std::shared_ptr<AnyConnector>, AnyITask *> &inputConnectorDotMap, int dotFlags) = 0;

  virtual std::string genDotConsumerEdgeFromConnector(std::shared_ptr<AnyConnector> connector, int flags) = 0;
  virtual std::string genDotProducerEdgeFromConnector(std::shared_ptr<AnyConnector> connector, int flags) = 0;
//  {
//
//  }

//  virtual std::string genDotConsumerEdgeWithoutConnector(std::string producerDotId, int flags)
//  {
//    return producerDotId + " -> " + this->getDotId() + ";\n";
//  }

  virtual std::string genDot(int flags, std::string dotId) {
    return dotId + ";\n";
//    std::string inOutLabel = (((flags & DOTGEN_FLAG_SHOW_IN_OUT_TYPES) != 0) ? ("\nin: "+ this->inTypeName() + "\nout: " + this->outTypeName()) : "");
//    std::string threadLabel = (((flags & DOTGEN_FLAG_SHOW_ALL_THREADING) != 0) ? "" : (" x" + std::to_string(this->getNumThreads())));
//    return dotId + "[label=\"" + this->getName() +
//        (this->debugDotNode() != "" ? ("\n"+this->debugDotNode()+"\n") : "") +
//        threadLabel + inOutLabel + "\",shape=box,color=black,width=.2,height=.2];\n";
  }

  virtual std::string genCustomDot(ProfileUtils *profileUtils, int colorFlag)
  { return ""; }

  virtual void debug() {}

  virtual std::string debugDotNode() { return ""; }



  virtual void profile() {}

  virtual std::string profileStr() { return ""; }

  virtual std::string inTypeName() = 0;

  virtual std::string outTypeName() = 0;

  virtual std::string getAddress() = 0;

  virtual AnyITask *copyITask(bool deep) = 0;

  virtual void printProfile() = 0;



  void initialize(size_t pipelineId, size_t numPipeline) {
    this->pipelineId = pipelineId;
    this->numPipelines = numPipeline;
    this->initialize();
  }

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

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

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

  // TODO: Delete or Add #ifdef
//  /**
//   * Sets the task graph communicator.
//   * @param communicator
//   */
//  void setTaskGraphCommunicator(TaskGraphCommunicator *communicator) {
//    this->taskGraphCommunicator = communicator;
//  }
//
//  /**
//   * Gets the task graph communicator
//   * @return the task graph communicator
//   */
//  TaskGraphCommunicator *getTaskGraphCommunicator() const {
//    return taskGraphCommunicator;
//  }


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

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

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

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

  size_t getMicroTimeoutTime() const {
    return this->microTimeoutTime;
  }

  void copyMemoryEdges(AnyITask *iTaskCopy) {
    iTaskCopy->setMemoryEdges(this->memoryEdges);
    iTaskCopy->setReleaseMemoryEdges(this->releaseMemoryEdges);
  }

  std::string genDot(int flags, std::shared_ptr<AnyConnector> input, std::shared_ptr<AnyConnector> output) {
    std::string dotId = this->getDotId();
    std::ostringstream oss;
    oss << genDot(flags, dotId, input, output);

    if ((flags & DOTGEN_FLAG_HIDE_MEM_EDGES) == 0) {
      if (memoryEdges->size() > 0) {
        for (const auto &kv : *this->memoryEdges) {
          oss << kv.second->getDotId() << " -> " << dotId << "[label=\"get\", color=sienna];" << std::endl;
        }
      }
    }

    return oss.str();
  }

  void profileITask() {
    if (memoryEdges->size() > 0) {
      for (const auto &kv : *this->memoryEdges) {
        std::cout << "Mem getter: " << kv.first << " profile; ";
        // consume
        kv.second->profileConsume(this->numThreads, false);
      }
    }
    this->profile();
  }

  std::string getDotId() {
    std::ostringstream id;
    id << "x" << this;
    std::string idStr = id.str();

    return idStr;
  }

  std::string getNameWithPipelineId() { return this->getName() + std::to_string(this->pipelineId); }

  const std::shared_ptr<ConnectorMap> &getMemoryEdges() const {
    return memoryEdges;
  }

  const std::shared_ptr<ConnectorMap> &getReleaseMemoryEdges() const {
    return releaseMemoryEdges;
  }

  bool hasMemoryEdge(std::string name) {
    return memoryEdges->find(name) != memoryEdges->end();
  }

  void attachMemoryEdge(std::string name, std::shared_ptr<AnyConnector> getMemoryConnector,
                        std::shared_ptr<AnyConnector> releaseMemoryConnector, MMType type) {
    if (hasMemoryEdge(name)) {
      std::cerr << "ERROR: " << this->getName() << " already has a memory edge named " << name << std::endl;
    } else {
      memoryEdges->insert(ConnectorPair(name, getMemoryConnector));
      releaseMemoryEdges->insert(ConnectorPair(name, releaseMemoryConnector));
    }

    HTGS_DEBUG("Num memory getters " << memoryEdges->size());
  }


  unsigned long long int getMemoryWaitTime() const {
    return memoryWaitTime;
  }

  void incMemoryWaitTime(unsigned long long int val) { this->memoryWaitTime += val; }

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

 private:
  void setMemoryEdges(std::shared_ptr<ConnectorMap> memGetter) { this->memoryEdges = memGetter; }

  void setReleaseMemoryEdges(const std::shared_ptr<ConnectorMap> &releaseMemoryEdges) {
    AnyITask::releaseMemoryEdges = releaseMemoryEdges;
  }




  size_t
      numThreads; 
  bool startTask; 
  bool poll; 
  size_t microTimeoutTime; 
  size_t pipelineId; 
  size_t numPipelines; 

  std::shared_ptr<ConnectorMap>
      memoryEdges; 
  std::shared_ptr<ConnectorMap>
      releaseMemoryEdges; 

  // TODO: Delete or Add #ifdef
//  TaskGraphCommunicator *taskGraphCommunicator; //!< Task graph connector communicator

  unsigned long long int memoryWaitTime; 

};
}

#endif //HTGS_ANYITASK_HPP