behavioral_writer_helper.hpp

Go to the documentation of this file.

/*
 *
 *                   _/_/_/    _/_/   _/    _/ _/_/_/    _/_/
 *                  _/   _/ _/    _/ _/_/  _/ _/   _/ _/    _/
 *                 _/_/_/  _/_/_/_/ _/  _/_/ _/   _/ _/_/_/_/
 *                _/      _/    _/ _/    _/ _/   _/ _/    _/
 *               _/      _/    _/ _/    _/ _/_/_/  _/    _/
 *
 *             ***********************************************
 *                              PandA Project
 *                     URL: http://panda.dei.polimi.it
 *                       Politecnico di Milano - DEIB
 *                        System Architectures Group
 *             ***********************************************
 *              Copyright (C) 2004-2024 Politecnico di Milano
 *
 *   This file is part of the PandA framework.
 *
 *   The PandA framework is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
#ifndef BEHAVIORAL_WRITER_HELPER_HPP
#define BEHAVIORAL_WRITER_HELPER_HPP

#include "config_HAVE_HLS_BUILT.hpp"
#include "config_HAVE_HOST_PROFILING_BUILT.hpp"

#include "graph.hpp"

#include "custom_set.hpp"
#include "refcount.hpp"

#include <ostream>

CONSTREF_FORWARD_DECL(BBGraph);
CONSTREF_FORWARD_DECL(BehavioralHelper);
CONSTREF_FORWARD_DECL(FunctionBehavior);
CONSTREF_FORWARD_DECL(hls);
CONSTREF_FORWARD_DECL(OpGraph);
#if HAVE_HOST_PROFILING_BUILT
CONSTREF_FORWARD_DECL(ProfilingInformation);
#endif
CONSTREF_FORWARD_DECL(Schedule);

class OpEdgeWriter : public EdgeWriter
{
 private:
   const BehavioralHelperConstRef BH;

 public:
   explicit OpEdgeWriter(const OpGraph* operation_graph);

   void operator()(std::ostream& out, const EdgeDescriptor& e) const override;
};

class BBEdgeWriter : public EdgeWriter
{
 private:
   const BehavioralHelperConstRef BH;

 public:
   explicit BBEdgeWriter(const BBGraph* g);

   void operator()(std::ostream& out, const EdgeDescriptor& e) const override;
};

class OpWriter : public VertexWriter
{
 protected:
   const BehavioralHelperConstRef helper;

 public:
   OpWriter(const OpGraph* operation_graph, const int detail_level);

   void operator()(std::ostream& out, const vertex& v) const override;
};

class BBWriter : public VertexWriter
{
 private:
   const FunctionBehaviorConstRef function_behavior;

   const BehavioralHelperConstRef helper;

   CustomUnorderedSet<vertex> annotated;

#if HAVE_HLS_BUILT
   const ScheduleConstRef schedule;
#endif

 public:
   BBWriter(const BBGraph* g, CustomUnorderedSet<vertex> annotated = CustomUnorderedSet<vertex>());

   void operator()(std::ostream& out, const vertex& v) const override;
};

#if HAVE_HLS_BUILT
class TimedOpWriter : public OpWriter
{
 protected:
   const hlsConstRef HLS;

   CustomSet<unsigned int> critical_paths;

 public:
   TimedOpWriter(const OpGraph* op_graph, const hlsConstRef HLS, CustomSet<unsigned int> critical_paths);

   void operator()(std::ostream& out, const vertex& v) const override;
};

class TimedOpEdgeWriter : public OpEdgeWriter
{
 protected:
   const hlsConstRef HLS;

   CustomSet<unsigned int> critical_paths;

 public:
   TimedOpEdgeWriter(const OpGraph* operation_graph, const hlsConstRef HLS, CustomSet<unsigned int> critical_paths);

   void operator()(std::ostream& out, const EdgeDescriptor& e) const override;
};
#endif

#endif