execution_pipeline_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_EXECUTION_PIPELINE_INPUTS_MANAGEMENT_ABSTRACTION_H_
#define HEDGEHOG_EXECUTION_PIPELINE_INPUTS_MANAGEMENT_ABSTRACTION_H_
 
#include "../../parts/core_switch.h"
 
#include "../base/input_output/slot_abstraction.h"
#include "../base/input_output/receiver_abstraction.h"
 
#include "../../implementors/concrete_implementor/default_slot.h"
#include "../../implementors/concrete_implementor/queue_receiver.h"
 
namespace hh {
namespace core {
namespace abstraction {
 
template<class ...Inputs>
class ExecutionPipelineInputsManagementAbstraction :
    public SlotAbstraction,
    public ReceiverAbstraction<Inputs> ... {
 private:
  std::unique_ptr<CoreSwitch < Inputs...>> coreSwitch_ = nullptr; 
 protected:
  using inputs_t = std::tuple<Inputs...>; 
 public:
 
  template<class ExecutionPipelineImplementation> requires std::is_base_of_v<behavior::MultiSwitchRules<Inputs...>,
                                                                             ExecutionPipelineImplementation>
  explicit ExecutionPipelineInputsManagementAbstraction(ExecutionPipelineImplementation *const executionPipeline)
      : SlotAbstraction(std::make_shared<implementor::DefaultSlot>()),
        ReceiverAbstraction<Inputs>(
            std::make_shared<implementor::QueueReceiver<Inputs>>(),
            SlotAbstraction::mutex())...,
      coreSwitch_(std::make_unique<CoreSwitch < Inputs...>>
  (static_cast<behavior::MultiSwitchRules<Inputs...> * >(executionPipeline))){}
 
  ~ExecutionPipelineInputsManagementAbstraction() override = default;
 
 protected:
  CoreSwitch<Inputs...> *coreSwitch() const {
    return coreSwitch_.get();
  }
 
  template<tool::ContainsConcept<Inputs...> Input>
  bool callSendToGraph(std::shared_ptr<Input> &data, size_t const &graphId) {
    return this->coreSwitch_->callSendToGraph(data, graphId);
  }
 
  [[nodiscard]] bool receiversEmpty() const { return (ReceiverAbstraction<Inputs>::empty() && ...); }
 
  void connectGraphToSwitch(std::shared_ptr<GraphInputsManagementAbstraction<Inputs...>> const graph) {
    auto switchAsNotifier = static_cast<NotifierAbstraction *>(this->coreSwitch_.get());
    (connectInputGraphForAType<Inputs>(graph), ...);
    for (auto slot : std::static_pointer_cast<SlotAbstraction>(graph)->slots()) {
      switchAsNotifier->addSlot(slot);
      slot->addNotifier(switchAsNotifier);
    }
  }
 
  void disconnectSwitch() {
    auto switchAsNotifier = static_cast<NotifierAbstraction *>(this->coreSwitch_.get());
    for (auto &slot : switchAsNotifier->connectedSlots()) {
      for (auto &s : slot->slots()) {
        s->removeNotifier(switchAsNotifier);
        s->wakeUp();
      }
    }
  }
 
  void wakeUp() override { this->slotConditionVariable()->notify_one(); }
 
  [[nodiscard]] bool canTerminate(bool lock) {
    bool result;
    if (lock) { lockSlotMutex(); }
    result = !this->hasNotifierConnected() && this->receiversEmpty();
    if (lock) { unlockSlotMutex(); }
    return result;
  }
 
  bool wait() {
    std::unique_lock<std::mutex> lock(*(this->mutex()));
    this->slotConditionVariable()->wait(
        lock,
        [this]() { return !this->receiversEmpty() || this->canTerminate(false); }
    );
 
    return canTerminate(false);
  }
 
  void printEdgesInformation(Printer *printer) {
    (ReceiverAbstraction<Inputs>::printEdgeInformation(printer), ...);
  }
 
 private:
  template<class Input>
  void connectInputGraphForAType(std::shared_ptr<GraphInputsManagementAbstraction<Inputs...>> const graph) {
    auto switchAsSender = static_cast<SenderAbstraction<Input> *>(this->coreSwitch_.get());
    for (auto const receiver : std::static_pointer_cast<ReceiverAbstraction<Input>>(graph)->receivers()) {
      switchAsSender->addReceiver(receiver);
      receiver->addSender(switchAsSender);
    }
  }
 
};
}
}
}
#endif //HEDGEHOG_EXECUTION_PIPELINE_INPUTS_MANAGEMENT_ABSTRACTION_H_