TaskGraphProfiler.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.

//
// Created by tjb3 on 3/22/17.
//

#ifndef HTGS_TASKGRAPHPROFILER_HPP
#define HTGS_TASKGRAPHPROFILER_HPP

#include <htgs/core/graph/profile/TaskManagerProfile.hpp>
#include <htgs/core/graph/AnyTaskGraphConf.hpp>
#include <htgs/api/ExecutionPipeline.hpp>
#include <htgs/api/TGTask.hpp>
#include <htgs/utils/ProfileUtils.hpp>
#include <set>
namespace htgs {

  class TaskManagerProfile;

class TaskGraphProfiler {
 public:

  TaskGraphProfiler(int flags) : flags(flags) {
    taskManagerProfiles = new std::map<AnyTaskManager *, TaskManagerProfile *>();
  }

  ~TaskGraphProfiler() {
    for (auto v : *taskManagerProfiles) {
      delete v.second;
      v.second = nullptr;
    }

    delete taskManagerProfiles;
    taskManagerProfiles = nullptr;

    if (profileUtils) {
      delete profileUtils;
      profileUtils = nullptr;
    }
  }

  void buildProfile(AnyTaskGraphConf *graphConf) {
    graphConf->gatherProfilingData(taskManagerProfiles);
    taskGraphComputeTime = graphConf->getGraphComputeTime();
  }

  void printProfiles() {
    for (auto t : *taskManagerProfiles) {
      std::cout << t.first->getName() << " addr: " << t.first->getAddress() << " id: " << t.first->getThreadId()
                << " Profile: " << *t.second << std::endl;
    }
  }

  std::string genDotProfile(std::string curDotGraph, int colorFlag) {
    std::string ret = "";

    // If all threading is disabled, then compute the averages only, based on first thread
    if ((flags & DOTGEN_FLAG_SHOW_ALL_THREADING) == 0) {
      computeAverages();
    }

    bool useColorMap = false;
    std::unordered_map<std::string, std::string> *colorMap = nullptr;
    if (colorFlag != 0) {
      useColorMap = true;
      colorMap = genColorMap(colorFlag);
    }

    for (auto t : *taskManagerProfiles) {
      auto tMan = t.first;
      auto tProfile = t.second;

      auto tFun = tMan->getTaskFunction();

      std::string dotId = tMan->getTaskFunction()->getDotId();

      if (curDotGraph.find(dotId + ";") != std::string::npos) {

        std::string aliveLabel =
          ((flags & DOTGEN_FLAG_SHOW_TASK_LIVING_STATUS) != 0) ? ("\\nLiving threads: " + std::to_string(tMan->getThreadsRemaining())) : "";
        std::string inOutLabel =
            (((flags & DOTGEN_FLAG_SHOW_IN_OUT_TYPES) != 0) ? ("\\nin: " + tFun->inTypeName() + "\\nout: "
                + tFun->outTypeName()) : "");
        std::string threadLabel =
            (((flags & DOTGEN_FLAG_SHOW_ALL_THREADING) != 0) ? "" : (" x" + std::to_string(tFun->getNumThreads())));
        ret += dotId + "[label=\"" + tFun->getDotLabelName();
        ret += threadLabel + inOutLabel + "\\n";
        ret += tProfile->genDot(flags);
        ret += (tFun->debugDotNode() != "" ? ("\\n" + tFun->debugDotNode() + "\\n") : "");
        ret += aliveLabel;
        ret += (tFun->getDotCustomProfile() != "" ? ("\\n" + tFun->getDotCustomProfile() + "\\n") : "");
        ret += "\",shape=" + tFun->getDotShape();
        ret += ",style=filled";
        ret += ",fillcolor=" + tFun->getDotFillColor();
        ret +=(useColorMap ? ",penwidth=5,color=\"" + colorMap->at(dotId) + "\"" : ", color=" + tFun->getDotShapeColor());
        ret += ",width=.2,height=.2];\n";
      }
//      else if (curDotGraph.find("subgraph cluster_" + dotId) != std::string::npos)
//      {
//         Add custom profiling for execution pipeline and TGTask
//        ret += tMan->getTaskFunction()->genCustomDot(profileUtils, colorFlag);
//      }
    }

    delete colorMap;
    colorMap = nullptr;

    return ret;
  }


  ProfileUtils *getProfileUtils()
  {
    return profileUtils;
  }

  std::map<AnyTaskManager *, TaskManagerProfile *> *getTaskManagerProfiles()
  {
    return taskManagerProfiles;
  }


 private:

  void computeAverages() {
    std::map<AnyTaskManager *, TaskManagerProfile *> finalProfiles;
    // Address + name + thread ID = unique

    // Group using Address + name ... thread ID = 0 is final version

    std::multimap<std::string, std::pair<AnyTaskManager *, TaskManagerProfile *>> averageMap;

    std::set<std::string> keys;

    // Gather multimap
    for (auto t : *taskManagerProfiles) {
      auto tMan = t.first;
      std::string key =
          (tMan->getInputConnector() != nullptr ? tMan->getInputConnector()->getDotId() : "")
          + (tMan->getOutputConnector() != nullptr ? tMan->getOutputConnector()->getDotId() : "")
          + tMan->getAddress() + tMan->getName();

      keys.insert(key);
      averageMap.insert(std::pair<std::string, std::pair<AnyTaskManager *, TaskManagerProfile *>>(key, t));
    }

    // Loop through each key
    for (auto key : keys) {
      auto valRange = averageMap.equal_range(key);

      AnyTaskManager *mainManager = nullptr;
      TaskManagerProfile *finalProfile = new TaskManagerProfile();

      int count = 0;
      for (auto i = valRange.first; i != valRange.second; ++i) {
        auto profilePair = (*i).second;

        finalProfile->setMaxQueueSize(profilePair.second->getMaxQueueSize());
        finalProfile->sum(profilePair.second);

        delete profilePair.second;
        profilePair.second = nullptr;

        if (profilePair.first->getThreadId() == 0) {
          mainManager = profilePair.first;
        }

        count++;
      }

      if (finalProfile != nullptr && mainManager != nullptr) {
        finalProfile->average(count);
        finalProfiles.insert(std::pair<AnyTaskManager *, TaskManagerProfile *>(mainManager, finalProfile));
      } else {
        std::cout << "Something screwy happened . . ." << std::endl;
      }
    }

    taskManagerProfiles->clear();

    for (auto t : finalProfiles) {
      taskManagerProfiles->insert(t);
    }

  }

  std::unordered_map<std::string, std::string> *genColorMap(int colorFlag) {
    std::unordered_map<std::string, std::string> *colorMap = new std::unordered_map<std::string, std::string>();


    std::deque<double> vals;
    for (auto v : *taskManagerProfiles) {
      double val = v.second->getValue(colorFlag);
      if (val > 0) {
        totalTime += val;
      }

      if (maxTime < val)
        maxTime = val;
    }


    if (colorFlag == DOTGEN_COLOR_COMP_TIME)
    {
      profileUtils = new ProfileUtils(taskGraphComputeTime);
    } else {
      profileUtils = new ProfileUtils(maxTime);
    }



    for (auto v : *taskManagerProfiles) {
      if (v.second->getValue(colorFlag) == 0.0) {
        colorMap->insert(std::pair<std::string, std::string>(v.first->getTaskFunction()->getDotId(), "black"));
        continue;
      }

      double tManTime = v.second->getValue(colorFlag);

      std::string color = profileUtils->getColorForTime(tManTime);

      colorMap->insert(std::pair<std::string, std::string>(v.first->getTaskFunction()->getDotId(), color));
    }



    return colorMap;
  }


  std::map<AnyTaskManager *, TaskManagerProfile *> *taskManagerProfiles; 
  int flags; 

  ProfileUtils *profileUtils = nullptr;

  double totalTime = 0.0; 
  double maxTime = 0.0; 
  double taskGraphComputeTime;
};
}

#endif //HTGS_TASKGRAPHPROFILER_HPP