task_inputs_management_abstraction.h

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 HEDGEHOG_TASK_INPUTS_MANAGEMENT_ABSTRACTION_H
#define HEDGEHOG_TASK_INPUTS_MANAGEMENT_ABSTRACTION_H
 
#include <mutex>
#include <condition_variable>
#include <ostream>
 
#include "../base/node/node_abstraction.h"
#include "../base/execute_abstraction.h"
#include "../base/input_output/slot_abstraction.h"
 
#include "../../../tools/concepts.h"
#include "../../implementors/concrete_implementor/default_slot.h"
#include "../../implementors/concrete_implementor/queue_receiver.h"
#include "../../implementors/concrete_implementor/default_execute.h"
namespace hh {
namespace core {
namespace abstraction {
 
template<class ...Inputs>
class TaskInputsManagementAbstraction :
    public SlotAbstraction,
    public ReceiverAbstraction<Inputs> ...,
    public ExecuteAbstraction<Inputs> ... {
 private:
  TaskNodeAbstraction *const coreTask_ = nullptr; 
 public:
  using inputs_t = std::tuple<Inputs...>; 
 
  template<class NodeType>
  explicit TaskInputsManagementAbstraction(NodeType *const nodeTask, TaskNodeAbstraction *const coreTask)
      : SlotAbstraction(std::make_shared<implementor::DefaultSlot>()),
        ReceiverAbstraction<Inputs>(
            std::make_shared<implementor::QueueReceiver<Inputs>>(), SlotAbstraction::mutex()
        )...,
      ExecuteAbstraction<Inputs>(std::make_shared<implementor::DefaultExecute<Inputs>>(
  static_cast<behavior::Execute<Inputs>*>(nodeTask)))...,
  coreTask_(coreTask) {}
 
  template<
      hh::tool::ConcreteMultiReceiverImplementation<Inputs...> ConcreteMultiReceivers,
      hh::tool::ConcreteMultiExecuteImplementation<Inputs...> ConcreteMultiExecutes
  >
  explicit TaskInputsManagementAbstraction(
      TaskNodeAbstraction *const coreTask,
      std::shared_ptr<implementor::ImplementorSlot> concreteSlot,
      std::shared_ptr<ConcreteMultiReceivers> concreteMultiReceivers,
      std::shared_ptr<ConcreteMultiExecutes> concreteMultiExecutes) :
      SlotAbstraction(concreteSlot),
      ReceiverAbstraction<Inputs>(concreteMultiReceivers,
                                  SlotAbstraction::mutex())...,
      ExecuteAbstraction<Inputs>(concreteMultiExecutes)
  ...,
  coreTask_(coreTask) {}
 
  ~TaskInputsManagementAbstraction() override = default;
 
  [[nodiscard]] bool receiversEmpty() const { return (ReceiverAbstraction<Inputs>::empty() && ...); }
 
 protected:
 
  [[nodiscard]] size_t totalNumberElementsReceived() const {
    return (ReceiverAbstraction<Inputs>::numberElementsReceived() + ...);
  }
 
  void operateReceivers() { (this->operateReceiver<Inputs>(), ...); }
 
  void callAllExecuteWithNullptr() { (ExecuteAbstraction<Inputs>::callExecute(nullptr), ...); }
 
  void wakeUp() final { this->slotConditionVariable()->notify_one(); }
 
  void copyInnerStructure(TaskInputsManagementAbstraction<Inputs...> *copyableCore) {
    (ReceiverAbstraction<Inputs>::copyInnerStructure(copyableCore), ...);
    SlotAbstraction::copyInnerStructure(copyableCore);
  }
 
  void printEdgesInformation(Printer *printer) {
    (ReceiverAbstraction<Inputs>::printEdgeInformation(printer), ...);
  }
 
 private:
  template<tool::ContainsConcept<Inputs...> InputDataType>
  void operateReceiver() {
    this->lockSlotMutex();
    auto typedReceiver = static_cast<ReceiverAbstraction<InputDataType> *>(this);
    if (!typedReceiver->empty()) {
      std::shared_ptr<InputDataType> data = typedReceiver->getInputData();
      coreTask_->incrementNumberReceivedElements();
      this->unlockSlotMutex();
      std::chrono::time_point<std::chrono::system_clock> start = std::chrono::system_clock::now();
      coreTask_->nvtxProfiler()->startRangeExecuting();
      ExecuteAbstraction<InputDataType>::callExecute(data);
      coreTask_->nvtxProfiler()->endRangeExecuting();
      std::chrono::time_point<std::chrono::system_clock> finish = std::chrono::system_clock::now();
      coreTask_->incrementPerElementExecutionDuration(
          std::chrono::duration_cast<std::chrono::nanoseconds>(finish - start)
      );
    } else {
      this->unlockSlotMutex();
    }
  }
 
};
}
}
}
#endif //HEDGEHOG_TASK_INPUTS_MANAGEMENT_ABSTRACTION_H