bash_flow_wrapper.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) 2020-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 "bash_flow_wrapper.hpp"

#include "BashBackendFlow.hpp"
#include "DesignParameters.hpp"
#include "Parameter.hpp"
#include "ToolManager.hpp"
#include "dbgPrintHelper.hpp" // for DEBUG_LEVEL_
#include "fileIO.hpp"
#include "string_manipulation.hpp"
#include "xml_script_command.hpp"

#define PARAM_bash_outdir "bash_outdir"

// constructor
bash_flow_wrapper::bash_flow_wrapper(const ParameterConstRef& _Param, const std::string& _output_dir,
                                     const generic_deviceRef& _device)
    : SynthesisTool(_Param, BASH_FLOW_TOOL_EXEC, _device, _output_dir, BASH_FLOW_TOOL_ID)
{
   PRINT_DBG_MEX(DEBUG_LEVEL_PEDANTIC, debug_level, "Creating the bash_flow wrapper...");
}

// destructor
bash_flow_wrapper::~bash_flow_wrapper() = default;

void bash_flow_wrapper::EvaluateVariables(const DesignParametersRef dp)
{
   std::string top_id = dp->component_name;
   dp->assign(PARAM_bash_outdir, output_dir, false);
   dp->parameter_values[PARAM_bash_backend_report] = output_dir + "/" + top_id + "_report.xml";
   dp->parameter_values[PARAM_bash_backend_timing_report] = output_dir + "/post_route_timing_summary.rpt";
}

void bash_flow_wrapper::generate_synthesis_script(const DesignParametersRef& dp, const std::string& file_name)
{
   // Export reserved (constant) values to design parameters
   for(auto& var : xml_reserved_vars)
   {
      dp->assign(var->name, getStringValue(var, dp), false);
   }

   // Bare script generation
   std::ostringstream script;
   script << "##########################################################" << std::endl;
   script << "#     Automatically generated by the PandA framework     #" << std::endl;
   script << "##########################################################" << std::endl << std::endl;
   script << generate_bare_script(xml_script_nodes, dp);

   // Replace all reserved variables with their value
   std::string script_string = script.str();
   replace_parameters(dp, script_string);
   remove_escaped(script_string);

   // Save the generated script
   if(std::filesystem::exists(file_name))
   {
      std::filesystem::remove_all(file_name);
   }
   script_name = file_name;
   std::ofstream file_stream(file_name.c_str());
   file_stream << script_string << std::endl;
   file_stream.close();
}

std::string bash_flow_wrapper::getStringValue(const xml_script_node_tRef node, const DesignParametersRef& dp) const
{
   switch(node->nodeType)
   {
      case NODE_VARIABLE:
      {
         std::string result;
         const xml_set_variable_t* var = GetPointer<xml_set_variable_t>(node);
         if(var->singleValue)
         {
            result += *(var->singleValue);
         }
         else if(!var->multiValues.empty())
         {
            result += "{";
            for(auto it = var->multiValues.begin(); it != var->multiValues.end(); ++it)
            {
               const xml_set_entry_tRef e = *it;
               if(it != var->multiValues.begin())
               {
                  result += " ";
               }
               result += toString(e, dp);
            }
            result += "}";
         }
         else
         {
            result += "\"\"";
         }
         return result;
      }
      case NODE_COMMAND:
      case NODE_ENTRY:
      case NODE_FOREACH:
      case NODE_ITE_BLOCK:
      case NODE_PARAMETER:
      case NODE_SHELL:
      case NODE_UNKNOWN:
      default:
         THROW_ERROR("Not supported node type: " + STR(node->nodeType));
   }
   return "";
}

std::string bash_flow_wrapper::toString(const xml_script_node_tRef node, const DesignParametersRef dp) const
{
   switch(node->nodeType)
   {
      case NODE_ENTRY:
      {
         const xml_set_entry_t* ent = GetPointer<xml_set_entry_t>(node);
         return ent->value;
      }
      case NODE_VARIABLE:
      {
         const xml_set_variable_t* var = GetPointer<xml_set_variable_t>(node);
         return "set " + var->name + " " + getStringValue(node, dp) + ";";
      }
      case NODE_PARAMETER:
      {
         const xml_parameter_t* par = GetPointer<xml_parameter_t>(node);
         std::string result;
         if(par->name)
         {
            result += *(par->name);
         }
         if(par->name && (par->singleValue || !par->multiValues.empty()))
         {
            result += par->separator;
         }
         if(par->singleValue)
         {
            result += *(par->singleValue);
         }
         else if(!par->multiValues.empty())
         {
            result += par->curlyBrackets ? "{" : "\"";
            for(auto it = par->multiValues.begin(); it != par->multiValues.end(); ++it)
            {
               const xml_set_entry_tRef p = *it;
               if(it != par->multiValues.begin())
               {
                  result += " ";
               }
               result += toString(p, dp);
            }
            result += par->curlyBrackets ? "}" : "\"";
         }
         return result;
      }
      case NODE_COMMAND:
      {
         const xml_command_t* comm = GetPointer<xml_command_t>(node);
         // TODO: Evaluate the condition
         std::string result;
         if(comm->name)
         {
            result += *(comm->name);
         }
         if(comm->name && comm->value)
         {
            result += " ";
         }
         if(comm->value)
         {
            result += *(comm->value);
         }
         if(!comm->parameters.empty())
         {
            for(const auto& p : comm->parameters)
            {
               result += " " + toString(p, dp);
            }
         }
         if(comm->output)
         {
            result += " >> " + *(comm->output);
         }
         return result;
      }
      case NODE_SHELL:
      {
         const xml_shell_t* sh = GetPointer<xml_shell_t>(node);
         // TODO: Evaluate the condition
         std::string result = "sh ";
         if(sh->name)
         {
            result += *(sh->name);
         }
         if(sh->name && sh->value)
         {
            result += " ";
         }
         if(sh->value)
         {
            result += *(sh->value);
         }
         if(!sh->parameters.empty())
         {
            for(const auto& p : sh->parameters)
            {
               result += " " + toString(p, dp);
            }
         }
         if(sh->output)
         {
            result += " >> " + *(sh->output);
         }
         return result;
      }
      case NODE_ITE_BLOCK:
      {
         const xml_ite_block_t* ite = GetPointer<xml_ite_block_t>(node);
         std::string result;
         bool conditionValue = xml_ite_block_t::evaluate_condition(&(ite->condition), dp), first = true;
         const std::vector<xml_script_node_tRef>& block = conditionValue ? ite->thenNodes : ite->elseNodes;
         for(const auto& n : block)
         {
            if(n->checkCondition(dp))
            {
               if(!first)
               {
                  result += "\n";
               }
               first = false;
               result += toString(n, dp);
            }
         }
         return result;
      }
      case NODE_UNKNOWN:
      case NODE_FOREACH:
      default:
         THROW_ERROR("Not supported node type: " + STR(node->nodeType));
   }
   return "";
}

std::string bash_flow_wrapper::get_command_line(const DesignParametersRef& dp) const
{
   std::ostringstream s;
   s << get_tool_exec() << " " << script_name;
   for(const auto& option : xml_tool_options)
   {
      if(option->checkCondition(dp))
      {
         std::string value = toString(option, dp);
         replace_parameters(dp, value);
         s << " " << value;
      }
   }
   s << std::endl;
   return s.str();
}