tree_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 TREE_HELPER_HPP
#define TREE_HELPER_HPP

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

#include <cstddef>
#include <list>
#include <string>
#include <tuple>
#include <vector>

struct binfo;
struct integer_cst;
struct function_decl;
struct ssa_name;
struct statement_list;
template <typename value>
class TreeNodeMap;
class TreeNodeConstSorter;
enum class TreeVocabularyTokenTypes_TokenEnum;
CONSTREF_FORWARD_DECL(tree_manager);
REF_FORWARD_DECL(tree_manager);
CONSTREF_FORWARD_DECL(tree_node);
REF_FORWARD_DECL(tree_node);
REF_FORWARD_DECL(bloc);
CONSTREF_FORWARD_DECL(var_pp_functor);

class tree_helper
{
 private:
   static const std::set<std::string> SC_tmpl_class;

   static const std::set<std::string> SC_builtin_scalar_type;

   static const std::set<std::string> TLM_SC_builtin_scalar_type;

   static void RecursiveGetTypesToBeDeclared(std::set<tree_nodeConstRef, TreeNodeConstSorter>& returned_types,
                                             const tree_nodeConstRef& type, const bool recursion,
                                             const bool without_transformation, const bool before);

   static void ComputeSsaUses(const tree_nodeRef&, TreeNodeMap<size_t>& uses);

 public:
   static int debug_level;

   static unsigned long long Size(const tree_nodeConstRef& tn);

   static std::string GetTemplateTypeName(const tree_nodeConstRef& type);

   static std::string GetRecordTypeName(const tree_nodeConstRef& type);

   static
       std::string
       name_function(const tree_managerConstRef& tm, const unsigned int index);

   static
       std::string
       GetFunctionName(const tree_managerConstRef& TM, const tree_nodeConstRef& decl);

   static std::tuple<std::string, unsigned int, unsigned int> GetSourcePath(const tree_nodeConstRef& node,
                                                                            bool& is_system);

   static
       bool
       has_function_return(const tree_managerConstRef& tm, const unsigned int index);

   static bool HasReturnType(const tree_managerConstRef& tm, const unsigned int index);

   static std::string getFunctionTypeString(const tree_nodeRef& FT);

   static void get_used_variables(bool first_level_only, const tree_nodeConstRef& t,
                                  CustomUnorderedSet<unsigned int>& list_of_variable);

   static bool look_for_binfo_inheritance(const binfo* b, const std::string& bcs);

   static tree_nodeRef find_obj_type_ref_function(const tree_nodeConstRef& tn);

   static std::set<tree_nodeConstRef, TreeNodeConstSorter>
   GetTypesToBeDeclaredBefore(const tree_nodeConstRef& tn, const bool without_transformation);

   static std::set<tree_nodeConstRef, TreeNodeConstSorter> GetTypesToBeDeclaredAfter(const tree_nodeConstRef& tn,
                                                                                     const bool without_transformation);

   static
       unsigned int
       get_type_index(const tree_managerConstRef& TM, const unsigned int index, long long int& vec_size,
                      bool& is_a_pointer, bool& is_a_function);

   static
       unsigned int
       get_type_index(const tree_managerConstRef& TM, const unsigned int index);

   static tree_nodeConstRef GetFunctionReturnType(const tree_nodeConstRef& function, bool void_as_null = true);

   static
       unsigned int
       get_pointed_type(const tree_managerConstRef& TM, const unsigned int index);

   static tree_nodeConstRef CGetPointedType(const tree_nodeConstRef& pointer);

   static
       unsigned int
       GetElements(const tree_managerConstRef& TM, const unsigned int index);

   static tree_nodeConstRef CGetElements(const tree_nodeConstRef& type);

   static bool IsSameType(const tree_nodeConstRef& tn0, const tree_nodeConstRef& tn1);

   static
       std::string
       get_type_name(const tree_managerConstRef& TM, const unsigned int index);

   static std::string GetTypeName(const tree_nodeConstRef& type);

   static
       void
       get_parameter_types(const tree_managerConstRef& TM, const unsigned int index, std::list<unsigned int>& params);

   static std::vector<tree_nodeConstRef> GetParameterTypes(const tree_nodeConstRef& ftype);

   static std::vector<tree_nodeConstRef> CGetFieldTypes(const tree_nodeConstRef& type);

   static
       unsigned int
       get_field_idx(const tree_managerConstRef& TM, const unsigned int index, unsigned int idx);

   static tree_nodeRef GetFieldIdx(const tree_nodeConstRef& type, unsigned int idx);

   static tree_nodeConstRef CGetType(const tree_nodeConstRef& node);

   static
       bool
       is_system(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsSystemType(const tree_nodeConstRef& type);

   static
       bool
       IsInLibbambu(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsInLibbambu(const tree_nodeConstRef& type);

   static
       bool
       is_an_enum(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsEnumType(const tree_nodeConstRef& type);

   static
       bool
       is_a_struct(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsStructType(const tree_nodeConstRef& type);

   static
       bool
       is_an_union(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsUnionType(const tree_nodeConstRef& type);

   static
       bool
       is_a_complex(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsComplexType(const tree_nodeConstRef& type);

   static
       bool
       is_an_array(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsArrayEquivType(const tree_nodeConstRef& type);

   static bool IsArrayType(const tree_nodeConstRef& type);

   static tree_nodeConstRef CGetArrayBaseType(const tree_nodeConstRef& type);

   static
       bool
       is_a_pointer(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsPointerType(const tree_nodeConstRef& type);

   static
       bool
       is_a_function(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsFunctionDeclaration(const tree_nodeConstRef& type);

   static
       bool
       is_a_vector(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsVectorType(const tree_nodeConstRef& type);

   static bool is_a_misaligned_vector(const tree_managerConstRef& TM, const unsigned int index);

   static bool is_an_addr_expr(const tree_managerConstRef& TM, const unsigned int index);

   static bool HasToBeDeclared(const tree_managerConstRef& TM, const tree_nodeConstRef& type);

   static
       bool
       is_const_type(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsConstType(const tree_nodeConstRef& type);

   static
       bool
       is_bool(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsBooleanType(const tree_nodeConstRef& type);

   static
       bool
       is_a_void(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsVoidType(const tree_nodeConstRef& type);

   static
       bool
       is_natural(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsPositiveIntegerValue(const tree_nodeConstRef& type);

   static
       bool
       is_int(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsSignedIntegerType(const tree_nodeConstRef& type);

   static
       bool
       is_real(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsRealType(const tree_nodeConstRef& type);

   static
       bool
       is_unsigned(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsUnsignedIntegerType(const tree_nodeConstRef& type);

   static
       bool
       is_scalar(const tree_managerConstRef& TM, const unsigned int var);

   static bool IsScalarType(const tree_nodeConstRef& type);

   static
       bool
       is_a_variable(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsVariableType(const tree_nodeConstRef& node);

   static
       bool
       is_static(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsStaticDeclaration(const tree_nodeConstRef& decl);

   static
       bool
       is_extern(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsExternDeclaration(const tree_nodeConstRef& decl);

   static
       bool
       is_function_type(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsFunctionType(const tree_nodeConstRef& type);

   static
       bool
       is_function_pointer_type(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsFunctionPointerType(const tree_nodeConstRef& type);

   static
       unsigned int
       get_base_index(const tree_managerConstRef& TM, const unsigned int index);

   static tree_nodeConstRef GetBaseVariable(const tree_nodeConstRef& mem);

   static
       bool
       is_fully_resolved(const tree_managerConstRef& TM, const unsigned int index,
                         CustomOrderedSet<unsigned int>& res_set);

   static bool IsPointerResolved(const tree_nodeConstRef& ptr, CustomOrderedSet<unsigned int>& res_set);

   static std::string return_qualifier_prefix(const TreeVocabularyTokenTypes_TokenEnum quals);

   static std::string return_C_qualifiers(const TreeVocabularyTokenTypes_TokenEnum quals, bool real_const);

   static bool is_module(const tree_managerConstRef& TM, unsigned int index);

   static bool is_channel(const tree_managerConstRef& TM, const unsigned int index);

   static bool is_builtin_channel(const tree_managerConstRef& TM, const unsigned int index);

   static bool is_signal(const tree_managerConstRef& TM, const unsigned int index);

   static bool is_port(const tree_managerConstRef& TM, const unsigned int index);

   static bool is_in_port(const tree_managerConstRef& TM, const unsigned int index);

   static bool is_out_port(const tree_managerConstRef& TM, const unsigned int index);

   static bool is_inout_port(const tree_managerConstRef& TM, const unsigned int index);

   static bool is_event(const tree_managerConstRef& TM, const unsigned int index);

   static bool is_clock(const tree_managerConstRef& TM, const unsigned int index);

   static bool is_SC_BIND_PROXY_NIL(const tree_managerConstRef& TM, const unsigned int index);


   static bool is_ssa_name(const tree_managerConstRef& TM, const unsigned int index);

   static
       bool
       is_volatile(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsVolatile(const tree_nodeConstRef& tn);

   static bool is_parameter(const tree_managerConstRef& TM, const unsigned int index);

   static bool is_virtual(const tree_managerConstRef& TM, const unsigned int index);

   static
       integer_cst_t
       get_integer_cst_value(const integer_cst* ic);

   static integer_cst_t GetConstValue(const tree_nodeConstRef& tn, bool is_signed = true);

   static unsigned int get_array_var(const tree_managerConstRef& TM, const unsigned int index, bool is_written,
                                     bool& two_dim_p);

   static
       unsigned long long
       get_array_data_bitsize(const tree_managerConstRef& TM, const unsigned int index);

   static unsigned long long GetArrayElementSize(const tree_nodeConstRef& node);

   static
       void
       get_array_dimensions(const tree_managerConstRef& TM, const unsigned int index,
                            std::vector<unsigned long long>& dims);

   static std::vector<unsigned long long> GetArrayDimensions(const tree_nodeConstRef& node);

   static
       void
       get_array_dim_and_bitsize(const tree_managerConstRef& TM, const unsigned int index,
                                 std::vector<unsigned long long>& dims, unsigned long long& elts_bitsize);

   static
       unsigned long long
       get_array_num_elements(const tree_managerConstRef& TM, const unsigned int index);

   static unsigned long long GetArrayTotalSize(const tree_nodeConstRef& node);

   static void extract_array_indexes(const tree_managerConstRef& TM, const unsigned int index,
                                     std::vector<unsigned long long>& indexes,
                                     std::vector<unsigned long long>& size_indexes, unsigned int& base_object);

   static bool is_concat_bit_ior_expr(const tree_managerConstRef& TM, const unsigned int index);

   static bool is_simple_pointer_plus_test(const tree_managerConstRef& TM, const unsigned int index);

   static
       bool
       is_constant(const tree_managerConstRef& TM, const unsigned int index);

   static bool IsConstant(const tree_nodeConstRef& node);

   static std::string op_symbol(const tree_nodeConstRef& op);

   static std::string op_symbol(const tree_node* op);

   static
       unsigned int
       GetUnqualified(const tree_managerConstRef& TM, unsigned int type);

   static tree_nodeConstRef GetUnqualifiedType(const tree_nodeConstRef& type);

   static
       unsigned int
       GetRealType(const tree_managerConstRef& TM, unsigned int index);

   static tree_nodeConstRef GetRealType(const tree_nodeConstRef& type);

   static bool IsAligned(const tree_managerConstRef& TM, unsigned int type);

   static bool IsAligned(const tree_nodeConstRef& tn);

   static unsigned int get_var_alignment(const tree_managerConstRef& TM, unsigned int var);

   static std::string NormalizeTypename(const std::string& id);

   static std::string GetMangledFunctionName(const function_decl* fd);

   static std::string print_function_name(const tree_managerConstRef& TM, const function_decl* fd);

   static
       std::string
       print_type(const tree_managerConstRef& TM, 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 = "");

   static std::string PrintType(const tree_managerConstRef& TM, const tree_nodeConstRef& type, bool global = false,
                                bool print_qualifiers = false, bool print_storage = false,
                                const tree_nodeConstRef& var = nullptr,
                                const var_pp_functorConstRef& vppf = var_pp_functorConstRef(),
                                const std::string& prefix = "", const std::string& tail = "");

   static
       unsigned int
       get_formal_ith(const tree_managerConstRef& TM, unsigned int index_obj, unsigned int parm_index);

   static tree_nodeConstRef GetFormalIth(const tree_nodeConstRef& obj, unsigned int parm_index);

   static
       bool
       is_packed(const tree_managerConstRef& TreeM, unsigned int node_index);

   static bool IsPackedType(const tree_nodeConstRef& type);

   static bool is_packed_access(const tree_managerConstRef& TreeM, unsigned int node_index);

   static unsigned long long AccessedMaximumBitsize(const tree_nodeConstRef& type_node, unsigned long long bitsize);

   static unsigned long long AccessedMinimunBitsize(const tree_nodeConstRef& type_node, unsigned long long bitsize);

   static size_t AllocatedMemorySize(const tree_nodeConstRef& parameter);

   static size_t CountPointers(const tree_nodeConstRef&);

   static unsigned int get_multi_way_if_pos(const tree_managerConstRef& TM, unsigned int node_id, unsigned int cond);

   static void compute_ssa_uses_rec_ptr(const tree_nodeConstRef& tn, CustomOrderedSet<const ssa_name*>& ssa_uses);

   static TreeNodeMap<size_t> ComputeSsaUses(const tree_nodeRef& tn);

   static bool is_a_nop_function_decl(const function_decl* fd);

   static void get_required_values(std::vector<std::tuple<unsigned int, unsigned int>>& required,
                                   const tree_nodeRef& tn);

   static bool LastStatement(const tree_nodeConstRef& statement);

   static size_t GetFunctionSize(const tree_managerConstRef& TM, const unsigned int function_index);

   static std::string get_asm_string(const tree_managerConstRef& TM, const unsigned int node_index);

   static bool IsStore(const tree_nodeConstRef& tn, const CustomOrderedSet<unsigned int>& fun_mem_data);

   static bool IsLoad(const tree_nodeConstRef& tn, const CustomOrderedSet<unsigned int>& fun_mem_data);

   static bool IsLut(const tree_nodeConstRef& tn);

   static bool has_omp_simd(const statement_list* sl);

   tree_helper();

   ~tree_helper();
};

class FunctionExpander
{
 private:
   CustomOrderedSet<std::string> no_serialize;

   CustomOrderedSet<std::string> internal_serialize;

   CustomOrderedSet<std::string> transparent;

   CustomOrderedSet<std::string> headers;

   CustomOrderedSet<tree_nodeRef> lib_types;

 public:
   enum serialization
   {
      none,     
      internal, 
      total     
   };

   serialization get_serialization(const std::string& name) const;

   bool is_transparent(const std::string& name) const;

   void check_lib_type(const tree_nodeRef& var);

   bool virtual operator()(const tree_nodeRef& t) const;

   FunctionExpander();

   virtual ~FunctionExpander() = default;
};
using FunctionExpanderRef = refcount<FunctionExpander>;
#endif