un_comparison_lowering.cpp

Go to the documentation of this file.

/*
 *
 *                   _/_/_/    _/_/   _/    _/ _/_/_/    _/_/
 *                  _/   _/ _/    _/ _/_/  _/ _/   _/ _/    _/
 *                 _/_/_/  _/_/_/_/ _/  _/_/ _/   _/ _/_/_/_/
 *                _/      _/    _/ _/    _/ _/   _/ _/    _/
 *               _/      _/    _/ _/    _/ _/_/_/  _/    _/
 *
 *             ***********************************************
 *                              PandA Project
 *                     URL: http://panda.dei.polimi.it
 *                       Politecnico di Milano - DEIB
 *                        System Architectures Group
 *             ***********************************************
 *              Copyright (C) 2016-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/>.
 *
 */
#include "un_comparison_lowering.hpp"

#include "Parameter.hpp"

#include "application_manager.hpp"
#include "function_behavior.hpp"

#include "dbgPrintHelper.hpp"      // for DEBUG_LEVEL_
#include "string_manipulation.hpp" // for GET_CLASS
#include "tree_basic_block.hpp"
#include "tree_helper.hpp"
#include "tree_manager.hpp"
#include "tree_manipulation.hpp"
#include "tree_node.hpp"
#include "tree_reindex.hpp"

UnComparisonLowering::UnComparisonLowering(const application_managerRef _AppM, unsigned int _function_id,
                                           const DesignFlowManagerConstRef _design_flow_manager,
                                           const ParameterConstRef _parameters)
    : FunctionFrontendFlowStep(_AppM, _function_id, UN_COMPARISON_LOWERING, _design_flow_manager, _parameters)
{
   debug_level = parameters->get_class_debug_level(GET_CLASS(*this));
}

UnComparisonLowering::~UnComparisonLowering() = default;

const CustomUnorderedSet<std::pair<FrontendFlowStepType, FrontendFlowStep::FunctionRelationship>>
UnComparisonLowering::ComputeFrontendRelationships(const DesignFlowStep::RelationshipType relationship_type) const
{
   CustomUnorderedSet<std::pair<FrontendFlowStepType, FunctionRelationship>> relationships;
   switch(relationship_type)
   {
      case(DEPENDENCE_RELATIONSHIP):
      {
         relationships.insert(std::make_pair(EXTRACT_GIMPLE_COND_OP, SAME_FUNCTION));
         relationships.insert(std::make_pair(USE_COUNTING, SAME_FUNCTION));
         break;
      }
      case(INVALIDATION_RELATIONSHIP):
      {
         break;
      }
      case(PRECEDENCE_RELATIONSHIP):
      {
         break;
      }
      default:
      {
         THROW_UNREACHABLE("");
      }
   }
   return relationships;
}

DesignFlowStep_Status UnComparisonLowering::InternalExec()
{
   bool modified = false;
   const auto TreeM = AppM->get_tree_manager();
   const auto tree_man = tree_manipulationRef(new tree_manipulation(TreeM, parameters, AppM));
   const auto curr_tn = TreeM->CGetTreeNode(function_id);
   const auto Scpe = TreeM->CGetTreeReindex(function_id);
   const auto fd = GetPointerS<const function_decl>(curr_tn);
   const auto sl = GetPointerS<const statement_list>(GET_CONST_NODE(fd->body));
   for(const auto& block : sl->list_of_bloc)
   {
      INDENT_DBG_MEX(DEBUG_LEVEL_VERY_PEDANTIC, debug_level, "-->Analyzing BB" + STR(block.first));
      for(const auto& stmt : block.second->CGetStmtList())
      {
         INDENT_DBG_MEX(DEBUG_LEVEL_VERY_PEDANTIC, debug_level, "-->Analyzing " + stmt->ToString());
         if(GET_CONST_NODE(stmt)->get_kind() != gimple_assign_K)
         {
            INDENT_DBG_MEX(DEBUG_LEVEL_VERY_PEDANTIC, debug_level, "<--Skipped" + STR(stmt));
            continue;
         }
         const auto ga = GetPointerS<const gimple_assign>(GET_CONST_NODE(stmt));
         const auto rhs_kind = GET_CONST_NODE(ga->op1)->get_kind();
         if(rhs_kind == unlt_expr_K || rhs_kind == unge_expr_K || rhs_kind == ungt_expr_K || rhs_kind == unle_expr_K ||
            rhs_kind == ltgt_expr_K)
         {
            const auto be = GetPointerS<const binary_expr>(GET_CONST_NODE(ga->op1));
            const auto srcp_string = be->include_name + ":" + STR(be->line_number) + ":" + STR(be->column_number);
            kind new_kind = error_mark_K;
            if(rhs_kind == unlt_expr_K)
            {
               new_kind = ge_expr_K;
            }
            else if(rhs_kind == unge_expr_K)
            {
               new_kind = lt_expr_K;
            }
            else if(rhs_kind == ungt_expr_K)
            {
               new_kind = le_expr_K;
            }
            else if(rhs_kind == unle_expr_K)
            {
               new_kind = gt_expr_K;
            }
            else if(rhs_kind == ltgt_expr_K)
            {
               new_kind = eq_expr_K;
            }
            else
            {
               THROW_UNREACHABLE("");
            }

            const auto booleanType = tree_man->GetBooleanType();
            const auto new_be = tree_man->create_binary_operation(booleanType, be->op0, be->op1, srcp_string, new_kind);
            const auto new_ga = tree_man->CreateGimpleAssign(booleanType, TreeM->CreateUniqueIntegerCst(0, booleanType),
                                                             TreeM->CreateUniqueIntegerCst(1, booleanType), new_be,
                                                             function_id, srcp_string);
            block.second->PushBefore(new_ga, stmt, AppM);
            INDENT_DBG_MEX(DEBUG_LEVEL_VERY_PEDANTIC, debug_level, "---Created " + STR(new_ga));
            const auto new_not = tree_man->create_unary_operation(
                booleanType, GetPointerS<const gimple_assign>(GET_CONST_NODE(new_ga))->op0, srcp_string,
                truth_not_expr_K);
            if(GET_INDEX_CONST_NODE(be->type) != GET_INDEX_CONST_NODE(booleanType))
            {
               const auto new_ga_not = tree_man->CreateGimpleAssign(
                   booleanType, TreeM->CreateUniqueIntegerCst(0, booleanType),
                   TreeM->CreateUniqueIntegerCst(1, booleanType), new_not, function_id, srcp_string);
               block.second->PushBefore(new_ga_not, stmt, AppM);
               const auto new_nop = tree_man->create_unary_operation(
                   be->type, GetPointerS<const gimple_assign>(GET_CONST_NODE(new_ga_not))->op0, srcp_string,
                   nop_expr_K);
               TreeM->ReplaceTreeNode(stmt, ga->op1, new_nop);
            }
            else
            {
               TreeM->ReplaceTreeNode(stmt, ga->op1, new_not);
            }
            INDENT_DBG_MEX(DEBUG_LEVEL_VERY_PEDANTIC, debug_level, "<--Transformed into " + STR(stmt));
            THROW_ASSERT(!ga->vdef && ga->vuses.empty() && ga->vovers.empty(), "Unhandled virtual ssas");
            modified = true;
         }
         else
         {
            INDENT_DBG_MEX(DEBUG_LEVEL_VERY_PEDANTIC, debug_level, "<--Skipped" + STR(stmt));
         }
      }
      INDENT_DBG_MEX(DEBUG_LEVEL_VERY_PEDANTIC, debug_level, "<--Analyzed BB" + STR(block.first));
   }
   if(modified)
   {
      function_behavior->UpdateBBVersion();
   }
   return modified ? DesignFlowStep_Status::SUCCESS : DesignFlowStep_Status::UNCHANGED;
}