cg_node.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 CG_NODE_HPP
#define CG_NODE_HPP

#include "edge_info.hpp"       // for EdgeInfo
#include "graph.hpp"           // for graph, vertex
#include "graph_info.hpp"      // for GraphInfo
#include "refcount.hpp"        // for REF_FORWARD_DECL
#include "typed_node_info.hpp" // for TypedNodeInfo
#include <ostream>             // for operator<<, ostream
#include <string>              // for operator<<, string
#include <utility>

REF_FORWARD_DECL(structural_object);

#define DATA_SELECTOR 1
#define CLOCK_SELECTOR 2
#define CHANNEL_SELECTOR 4
#define ALL_LINES_SELECTOR (DATA_SELECTOR | CLOCK_SELECTOR | CHANNEL_SELECTOR)
#define PURE_DATA_SELECTOR (DATA_SELECTOR | CHANNEL_SELECTOR)

struct cg_node_info : public TypedNodeInfo
{
   structural_objectRef reference;

   bool is_critical;
   void print(std::ostream& os, int detail_level = 0) const override
   {
      TypedNodeInfo::print(os, detail_level);
      os << " " << reference << std::endl;
   }

   cg_node_info() : TypedNodeInfo(), is_critical(false)
   {
   }
};

#define GET_REFERENCE(data, node_index) Cget_node_info<cg_node_info>(node_index, *(data))->reference

#define GET_CRITICAL(data, node_index) Cget_node_info<cg_node_info>(node_index, *(data))->is_critical

struct cg_edge_info : public EdgeInfo
{
   structural_objectRef from_port;
   structural_objectRef to_port;
   bool is_critical;
   void print(std::ostream& os) const;

   cg_edge_info() : is_critical(false)
   {
   }
};

#define GET_FROM_PORT(data, edge_index) Cget_edge_info<cg_edge_info>(edge_index, *(data))->from_port

#define GET_EDGE_CRITICAL(data, edge_index) Cget_node_info<cg_edge_info>(edge_index, *(data))->is_critical

#define EDGE_ADD_FROM_PORT(data, edge_index, from) get_edge_info<cg_edge_info>(edge_index, *(data))->from_port = from

#define GET_TO_PORT(data, edge_index) Cget_edge_info<cg_edge_info>(edge_index, *(data))->to_port

#define EDGE_ADD_TO_PORT(data, edge_index, _to) get_edge_info<cg_edge_info>(edge_index, *(data))->to_port = _to

#define EDGE_SET_CRITICAL(data, edge_index, critical) \
   get_edge_info<cg_edge_info>(edge_index, *(data))->is_critical = critical

struct cg_graph_info : public GraphInfo
{
   vertex Entry;

   vertex Exit;

   std::string Entry_name;
   std::string Exit_name;

   void print(std::ostream& os) const
   {
      os << "Entry " << Entry_name << "Exit " << Exit_name << std::endl;
   }

   cg_graph_info(vertex en, const std::string& en_name, vertex ex, const std::string& ex_name)
       : Entry(en), Exit(ex), Entry_name(en_name), Exit_name(ex_name)
   {
   }

   cg_graph_info() : Entry_name(ENTRY), Exit_name(EXIT)
   {
   }

   ~cg_graph_info() override = default;
};

class cg_edge_writer
{
 public:
   explicit cg_edge_writer(const graph* _g);
   void operator()(std::ostream& out, const EdgeDescriptor& e) const;

 private:
   const graph* g;
};

class cg_label_writer
{
 public:
   explicit cg_label_writer(const graph* _g);

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

 private:
   const graph* g;
};

#endif