find_max_transformations.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 "find_max_transformations.hpp"
#include "Parameter.hpp"           // for Parameter, OPT_output_tem...
#include "dbgPrintHelper.hpp"      // for INDENT_OUT_MEX, OUTPUT_LE...
#include "exceptions.hpp"          // for IsError, THROW_ASSERT
#include "fileIO.hpp"              // for PandaSystem
#include "hash_helper.hpp"         // for hash
#include "string_manipulation.hpp" // for STR GET_CLASS
#include <filesystem>              // for create_directory, exists

FindMaxTransformations::FindMaxTransformations(const application_managerRef _AppM,
                                               const DesignFlowManagerConstRef _design_flow_manager,
                                               const ParameterConstRef _parameters)
    : ApplicationFrontendFlowStep(_AppM, FrontendFlowStepType::FIND_MAX_TRANSFORMATIONS, _design_flow_manager,
                                  _parameters)
{
   debug_level = parameters->get_class_debug_level(GET_CLASS(*this));
}

FindMaxTransformations::~FindMaxTransformations() = default;

const CustomUnorderedSet<std::pair<FrontendFlowStepType, FrontendFlowStep::FunctionRelationship>>
FindMaxTransformations::ComputeFrontendRelationships(const DesignFlowStep::RelationshipType) const
{
   return CustomUnorderedSet<std::pair<FrontendFlowStepType, FrontendFlowStep::FunctionRelationship>>();
}

const std::string FindMaxTransformations::ComputeArgString(const size_t max_transformations) const
{
   const auto argv = parameters->CGetArgv();
   std::string arg_string;
   for(const auto& arg : argv)
   {
      if(arg_string == "")
      {
         THROW_ASSERT(arg.size() and arg[0] == '/', "Relative path executable not supported " + arg);
         arg_string += arg;
      }
      else
      {
         arg_string += " ";
         if(arg.find("--max-transformations") == std::string::npos and
            arg.find("--find-max-transformations") == std::string::npos)
         {
            arg_string += arg;
         }
      }
   }
   arg_string += " --max-transformations=" + STR(max_transformations);
   return arg_string;
}

bool FindMaxTransformations::ExecuteBambu(const size_t max_transformations) const
{
   INDENT_DBG_MEX(DEBUG_LEVEL_VERY_PEDANTIC, debug_level,
                  "-->Executing with max transformations " + STR(max_transformations));
   const auto arg_string = ComputeArgString(max_transformations);
   const auto temp_directory = parameters->getOption<std::string>(OPT_output_temporary_directory);
   const auto new_directory = temp_directory + "/" + STR(max_transformations);
   if(std::filesystem::exists(new_directory))
   {
      std::filesystem::remove_all(new_directory);
   }
   std::filesystem::create_directory(new_directory);
   const auto ret = PandaSystem(parameters, "cd " + new_directory + "; " + arg_string, false,
                                new_directory + "/bambu_execution_output");
   std::filesystem::remove_all(new_directory);
   if(IsError(ret))
   {
      INDENT_DBG_MEX(DEBUG_LEVEL_VERY_PEDANTIC, debug_level, "<--Failure");
      return false;
   }
   else
   {
      INDENT_DBG_MEX(DEBUG_LEVEL_VERY_PEDANTIC, debug_level, "<--Success");
      return true;
   }
}

DesignFlowStep_Status FindMaxTransformations::Exec()
{
   size_t correct_cmt = 1;
   size_t wrong_cmt = 0;
   if(parameters->IsParameter("wrong-transformation"))
   {
      wrong_cmt = parameters->GetParameter<unsigned int>("wrong-transformation");
   }
   if(parameters->IsParameter("correct-transformation"))
   {
      correct_cmt = parameters->GetParameter<unsigned int>("correct-transformation");
   }

   if(!wrong_cmt)
   {
      const auto zero_execution = ExecuteBambu(0);
      if(not zero_execution)
      {
         INDENT_OUT_MEX(0, 0, "Bambu fails with --max-transformations=0");
         return DesignFlowStep_Status::ABORTED;
      }
      INDENT_OUT_MEX(OUTPUT_LEVEL_MINIMUM, output_level, "-->Looking for upper bound of max transformations");

      while(ExecuteBambu(correct_cmt))
      {
         correct_cmt *= 2;
      }
      INDENT_OUT_MEX(OUTPUT_LEVEL_MINIMUM, output_level, "<--Upper bound is " + STR(correct_cmt));
      wrong_cmt = correct_cmt;
      correct_cmt = wrong_cmt / 2;
   }
   while(wrong_cmt - correct_cmt > 1)
   {
      INDENT_OUT_MEX(OUTPUT_LEVEL_MINIMUM, output_level,
                     "---Current range is [" + STR(correct_cmt) + ":" + STR(wrong_cmt) + "]");
      size_t middle_cmt = (wrong_cmt + correct_cmt) / 2;
      const auto middle_execution = ExecuteBambu(middle_cmt);
      if(middle_execution)
      {
         correct_cmt = middle_cmt;
      }
      else
      {
         wrong_cmt = middle_cmt;
      }
   }
   INDENT_OUT_MEX(OUTPUT_LEVEL_MINIMUM, output_level, "---Error occours at " + STR(wrong_cmt) + " transformation");
   return DesignFlowStep_Status::ABORTED;
}