behavioral_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_HELPER_HPP
#define BEHAVIORAL_HELPER_HPP

#include "config_HAVE_FROM_PRAGMA_BUILT.hpp"

#include "custom_map.hpp"
#include "custom_set.hpp" // for set
#include "custom_set.hpp"
#include "graph.hpp"
#include "refcount.hpp"
#include <list>   // for list
#include <string> // for string
#include <tuple>
#include <utility> // for pair
REF_FORWARD_DECL(application_manager);
REF_FORWARD_DECL(bloc);
CONSTREF_FORWARD_DECL(OpGraph);
CONSTREF_FORWARD_DECL(Parameter);
CONSTREF_FORWARD_DECL(tree_manager);
REF_FORWARD_DECL(tree_node);
CONSTREF_FORWARD_DECL(tree_node);
CONSTREF_FORWARD_DECL(var_pp_functor);
class TreeNodeConstSet;

using tree_class = unsigned int;

#define INTERNAL "internal_"

class BehavioralHelper
{
 protected:
   const application_managerRef AppM;

   const tree_managerConstRef TM;

   const ParameterConstRef Param;

   int debug_level;

   static std::map<unsigned int, std::pair<std::string, int>> definitions;

   static std::map<std::string, unsigned int> used_name;

   static std::map<unsigned int, std::string> vars_symbol_table;

   static std::map<unsigned int, std::string> vars_renaming_table;

   unsigned int function_index;

   std::string function_name;

   bool body;

   bool opaque;

   std::map<unsigned int, unsigned int> initializations;

   bool has_bit_field(unsigned int variable) const;

 public:
   BehavioralHelper(const application_managerRef AppM, unsigned int index, bool body,
                    const ParameterConstRef parameters);

   virtual ~BehavioralHelper();

   virtual std::tuple<std::string, unsigned int, unsigned int> get_definition(unsigned int index,
                                                                              bool& is_system) const;

   std::string print_vertex(const OpGraphConstRef g, const vertex v, const var_pp_functorConstRef vppf,
                            const bool dot = false) const;

   virtual std::string PrintInit(const tree_nodeConstRef& var, const var_pp_functorConstRef vppf) const;

   virtual std::string print_attributes(unsigned int var, const var_pp_functorConstRef vppf, bool first = true) const;

   std::string PrintVariable(unsigned int var) const;

   void InvaildateVariableName(const unsigned int index);

   virtual std::string PrintConstant(const tree_nodeConstRef& var,
                                     const var_pp_functorConstRef vppf = var_pp_functorConstRef()) const;

   virtual std::string print_type(unsigned int type, bool global = false, bool print_qualifiers = false,
                                  bool print_storage = false, unsigned int var = 0,
                                  const var_pp_functorConstRef vppf = var_pp_functorConstRef(),
                                  const std::string& prefix = "", const std::string& tail = "") const;

   virtual std::string print_type_declaration(unsigned int type) const;

   virtual unsigned long long get_size(unsigned int var) const;

   std::string get_function_name() const;

   std::string GetMangledFunctionName() const;

   unsigned int get_function_index() const;

   unsigned int
   GetFunctionReturnType(unsigned int function) const;

   virtual bool is_bool(unsigned int index) const;

   virtual bool is_natural(unsigned int index) const;

   virtual bool is_int(unsigned int index) const;

   virtual bool is_an_enum(unsigned int index) const;

   virtual bool is_unsigned(unsigned int index) const;

   virtual bool is_real(unsigned int index) const;

   virtual bool is_a_complex(unsigned int index) const;

   virtual bool is_a_struct(unsigned int variable) const;

   virtual bool is_an_union(unsigned int variable) const;

   virtual bool is_an_array(unsigned int variable) const;

   bool is_a_vector(unsigned int variable) const;

   virtual bool is_a_pointer(unsigned int variable) const;

   virtual bool is_an_indirect_ref(unsigned int variable) const;

   virtual bool is_an_array_ref(unsigned int variable) const;

   virtual bool is_a_component_ref(unsigned int variable) const;

   virtual bool is_an_addr_expr(unsigned int variable) const;

   virtual bool is_a_mem_ref(unsigned int variable) const;

   virtual bool is_static(unsigned int decl) const;

   virtual bool is_extern(unsigned int decl) const;

   virtual bool is_a_constant(unsigned int obj) const;

   virtual bool is_a_result_decl(unsigned int obj) const;

   virtual bool is_a_realpart_expr(unsigned int obj) const;

   virtual bool is_a_imagpart_expr(unsigned int obj) const;

   virtual bool is_operating_system_function(const unsigned int obj) const;

   virtual int unsigned start_with_a_label(const blocRef& block) const;

   virtual unsigned int end_with_a_cond_or_goto(const blocRef& block) const;

   virtual unsigned int get_indirect_ref_var(unsigned int obj) const;

   virtual unsigned int get_array_ref_array(unsigned int obj) const;

   virtual unsigned int get_array_ref_index(unsigned int obj) const;

   virtual unsigned int get_component_ref_record(unsigned int obj) const;

   virtual unsigned int get_component_ref_field(unsigned int obj) const;

   virtual unsigned int get_mem_ref_base(unsigned int obj) const;

   virtual unsigned int get_mem_ref_offset(unsigned int obj) const;

   virtual unsigned int get_operand_from_unary_expr(unsigned int obj) const;

   virtual unsigned int GetVarFromSsa(unsigned int index) const;

   virtual unsigned int get_intermediate_var(unsigned int obj) const;

   virtual unsigned int get_type(const unsigned int var) const;

   virtual unsigned int get_pointed_type(const unsigned int type) const;

   unsigned int GetElements(const unsigned int type) const;

   virtual TreeNodeConstSet GetParameterTypes() const;

   const std::list<unsigned int> get_parameters() const;

   std::vector<tree_nodeRef> GetParameters() const;

   bool has_implementation() const;

   virtual bool is_var_args() const;

   virtual bool is_va_start_call(unsigned int stm) const;

   virtual unsigned int GetInit(unsigned int var, CustomUnorderedSet<unsigned int>& list_of_variables) const;

   virtual unsigned int get_attributes(unsigned int var) const;

   virtual unsigned int is_named_pointer(const unsigned int index) const;

   unsigned int is_name_used(std::string var) const;

   void add_read_global_variable(unsigned int variable);

   void add_written_global_variable(unsigned int variable);

   CustomOrderedSet<unsigned int> get_read_global_variables() const;

   CustomOrderedSet<unsigned int> get_written_global_variables() const;

   void add_initialization(unsigned int var, unsigned int init);

   virtual std::string print_phinode_res(unsigned int phi_node_id, vertex v, const var_pp_functorConstRef vppf) const;

   void set_opaque();

   void set_not_opaque();

   bool get_opaque() const;

   virtual const std::string get_label_name(unsigned int label_expr_nid) const;

   virtual std::string print_forward_declaration(unsigned int type) const;

   virtual bool is_empty_return(unsigned int index) const;

   virtual std::string PrintNode(const tree_nodeConstRef& node, vertex v, const var_pp_functorConstRef vppf) const;

   virtual std::string PrintNode(unsigned int node_id, vertex v, const var_pp_functorConstRef vppf) const;

   std::string PrintVarDeclaration(unsigned int var, const var_pp_functorConstRef vppf,
                                   bool init_has_to_be_printed) const;

   unsigned int GetUnqualified(const unsigned int index) const;

   static void rename_a_variable(unsigned int var, const std::string& new_name);

   static void clear_renaming_table();

   virtual void GetTypecast(const tree_nodeConstRef& tn, TreeNodeConstSet& types) const;

   bool IsDefaultSsaName(const unsigned int ssa_name_index) const;

#if HAVE_FROM_PRAGMA_BUILT

   size_t GetOmpForDegree() const;

   bool IsOmpFunctionAtomic() const;

   bool IsOmpBodyLoop() const;
#endif

#if HAVE_FROM_PRAGMA_BUILT

   bool IsOmpAtomic() const;
#endif

   bool function_has_to_be_printed(unsigned int f_id) const;

   std::string get_asm_string(const unsigned int node_index) const;

   bool CanBeSpeculated(const unsigned int node_index) const;

   bool CanBeMoved(const unsigned int node_index) const;

   bool IsStore(const unsigned int statement_index) const;

   bool IsLoad(const unsigned int statement_index) const;

   bool IsLut(const unsigned int statement_index) const;
};

using BehavioralHelperRef = refcount<BehavioralHelper>;
using BehavioralHelperConstRef = refcount<const BehavioralHelper>;

#endif