AppTriggers.hpp

Go to the documentation of this file.

// <AppTriggers.hpp> -*- C++ -*-
 
 
#pragma once
 
 
#include "sparta/sparta.hpp"
#include "sparta/app/Simulation.hpp"
#include "sparta/app/SimulationConfiguration.hpp"
#include "sparta/trigger/Trigger.hpp"
#include "sparta/trigger/Triggerable.hpp"
#include "sparta/pevents/PeventTrigger.hpp"
#include "sparta/pevents/PeventController.hpp"
#include "sparta/collection/PipelineCollector.hpp"
#include "sparta/log/Tap.hpp"
 
namespace sparta {
    namespace app {
 
class PipelineTrigger : public trigger::Triggerable
{
public:
    PipelineTrigger(const std::string& pipeline_collection_path,
                    const std::set<std::string>& pipeline_enabled_node_names,
                    uint64_t pipeline_heartbeat,
                    bool multiple_triggers,
                    sparta::Clock * clk, sparta::RootTreeNode * rtn) :
        pipeline_collection_path_(pipeline_collection_path),
        pipeline_enabled_node_names_(pipeline_enabled_node_names),
        pipeline_heartbeat_(pipeline_heartbeat),
        multiple_triggers_(multiple_triggers),
        clk_(clk),
        root_(rtn)
    {
        pipeline_collector_.
            reset(new sparta::collection::PipelineCollector(multiple_triggers_ ? getCollectionPath_() : pipeline_collection_path_,
                                                            pipeline_heartbeat_,
                                                            clk_,
                                                            root_));
 
    }
 
    void go() override
    {
        sparta_assert(!triggered_, "Why has pipeline trigger been triggered?");
        triggered_ = true;
        std::cout << "Pipeline collection started, output to files with prefix '"
                  << pipeline_collector_->getFilePath() << "'" << std::endl;
        startCollection_();
 
        if(multiple_triggers_) {
            std::cout << "#" << num_collections_ << " pipeline collection started" << std::endl;
        }
    }
 
    void stop() override
    {
        sparta_assert(triggered_, "Why stop an inactivated trigger?");
        triggered_ = false;
        stopCollection_();
 
        if(multiple_triggers_) {
            std::cout << "#" << num_collections_ << " pipeline collection ended" << std::endl;
            ++num_collections_;
            pipeline_collector_->reactivate(getCollectionPath_());
        }
    }
 
private:
    void startCollection_()
    {
        if(pipeline_enabled_node_names_.empty()) {
            // Start collection at the root node
            pipeline_collector_->startCollection(root_);
        }
        else {
            // Find the nodes in the root and enable them
            for(const auto & node_name : pipeline_enabled_node_names_) {
                std::vector<TreeNode*> results;
                root_->getSearchScope()->findChildren(node_name, results);
                if(results.size() == 0) {
                    std::cerr << SPARTA_CURRENT_COLOR_RED
                              << "WARNING (Pipeline collection): Could not find node named: '"
                              << node_name
                              <<"' Collection will not occur on that node!"
                              << SPARTA_CURRENT_COLOR_NORMAL
                              << std::endl;
                }
                for(auto & tn : results) {
                    std::cout << "Collection enabled on node: '" << tn->getLocation() << "'" << std::endl;
                    pipeline_collector_->startCollection(tn);
                }
            }
        }
    }
 
    void stopCollection_()
    {
        if(pipeline_enabled_node_names_.empty()) {
            // Start collection at the root node
            pipeline_collector_->stopCollection(root_);
        }
        else {
            // Find the nodes in the root and enable them
            for(const auto & node_name : pipeline_enabled_node_names_) {
                std::vector<TreeNode*> results;
                root_->getSearchScope()->findChildren(node_name, results);
                for(auto & tn : results) {
                    pipeline_collector_->stopCollection(tn);
                }
            }
        }
        pipeline_collector_->destroy();
    }
 
    std::string getCollectionPath_() const
    {
        if(pipeline_collection_path_.back() == '/') {
            return pipeline_collection_path_ + std::to_string(num_collections_) + '_';
        }
        else {
            return pipeline_collection_path_ + '_' + std::to_string(num_collections_) + '_';
        }
    }
 
    std::unique_ptr<collection::PipelineCollector> pipeline_collector_;
    const std::string pipeline_collection_path_;
    const std::set<std::string> pipeline_enabled_node_names_;
    const uint64_t pipeline_heartbeat_;
    const bool multiple_triggers_;
    sparta::Clock * clk_ = nullptr;
    sparta::RootTreeNode * root_ = nullptr;
    uint32_t num_collections_ = 0;
};
 
class LoggingTrigger : public trigger::Triggerable
{
    Simulation& sim_;
    log::TapDescVec taps_;
 
public:
 
    LoggingTrigger(Simulation& sim,
                   const log::TapDescVec& taps) :
        Triggerable(),
        sim_(sim),
        taps_(taps)
    {;}
 
public:
 
    virtual void go() override {
        sim_.installTaps(taps_);
    }
    virtual void stop() override {
        std::cerr << "Warning: no support for STOPPING a LoggingTrigger" << std::endl;
    }
};
 
 
 
    } // namespace app
} // namespace sparta