SynthesisTool.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 _SYNTHESIS_TOOL_HPP_
#define _SYNTHESIS_TOOL_HPP_

#include "refcount.hpp"
#include <map>
#include <string>
#include <vector>

CONSTREF_FORWARD_DECL(Parameter);
REF_FORWARD_DECL(SynthesisTool);
REF_FORWARD_DECL(ToolManager);
REF_FORWARD_DECL(xml_node);
REF_FORWARD_DECL(xml_script_node_t);
REF_FORWARD_DECL(xml_set_variable_t);
REF_FORWARD_DECL(xml_parameter_t);
REF_FORWARD_DECL(generic_device);
REF_FORWARD_DECL(DesignParameters);
class xml_element;

#define ADD_RES_VAR(name) \
   xml_reserved_vars.push_back(xml_set_variable_tRef(new xml_set_variable_t((name), nullptr, nullptr)))

#define PARAM_top_id "top_id"
#define PARAM_target_device "target_device"
#define PARAM_target_family "target_family"
#define PARAM_HDL_files "HDL_files"
#define PARAM_clk_name "clk_name"
#define PARAM_clk_period "clk_period"
#define PARAM_clk_period_ps "clk_period_ps"
#define PARAM_clk_period_default (1.0 / 50)
#define PARAM_clk_freq "clk_freq"
#define PARAM_time_constrained "time_constrained"
#define PARAM_is_combinational "is_combinational"
#define PARAM_sdc_file "sdc_file"
#define PARAM_backend_script_extensions "backend_script_extensions"
#define PARAM_has_script_extensions "has_script_extensions"
#define PARAM_has_VHDL_library "has_VHDL_library"
#define PARAM_VHDL_library "VHDL_library"
#define PARAM_connect_iob "connect_iob"
#define PARAM_power_optimization "power_optimization"
#define PARAM_parallel_backend "parallel_backend"

#define PARAM_fu "fu"

class SynthesisTool
{
 public:
   using type_t = enum {
      UNKNOWN = 0,
      XST,
      NGDBUILD,
      MAP,
      PAR,
      TRCE,
      VIVADO_FLOW,
      QUARTUS_13_FLOW,
      QUARTUS_13_SETUP,
      QUARTUS_13_STA,
      QUARTUS_SETUP,
      QUARTUS_FLOW,
      QUARTUS_POW,
      QUARTUS_STA,
      LATTICE_FLOW,
      NXPYTHON_FLOW,
      BASH_FLOW
   };

 protected:
   const generic_deviceRef device;

   const ParameterConstRef Param;

   int debug_level;

   unsigned int output_level;

   ToolManagerRef tool;

   const std::string tool_exec;

   std::string output_dir;

   std::string script_name;

   std::map<unsigned int, std::string> script_map;

   void create_output_directory(const std::string& sub_dir);

   // Script from XML
   std::vector<xml_parameter_tRef> xml_tool_options;
   std::vector<xml_script_node_tRef> xml_script_nodes;
   std::vector<xml_set_variable_tRef> xml_reserved_vars;

   virtual void init_reserved_vars();

 public:
   SynthesisTool(const ParameterConstRef& Param, std::string tool_exec, const generic_deviceRef& device,
                 const std::string& _flow_name, std::string default_output_dir);

   virtual ~SynthesisTool();

   virtual void CheckExecution();

   virtual void EvaluateVariables(const DesignParametersRef dp);

   virtual void generate_synthesis_script(const DesignParametersRef& dp, const std::string& file_name) = 0;

   virtual std::string get_command_line(const DesignParametersRef& dp) const = 0;

   virtual std::string toString(const xml_script_node_tRef node, const DesignParametersRef dp) const = 0;

   virtual std::string getStringValue(const xml_script_node_tRef node, const DesignParametersRef& dp) const = 0;

   std::string get_output_directory() const;

   std::string generate_bare_script(const std::vector<xml_script_node_tRef>& nodes, const DesignParametersRef& dp);

   xml_set_variable_tRef get_reserved_parameter(const std::string& name);

   void replace_parameters(const DesignParametersRef& dp, std::string& script) const;

   static SynthesisToolRef create_synthesis_tool(type_t type, const ParameterConstRef& Param,
                                                 const std::string& output_dir, const generic_deviceRef& device);

   void xload_scripts(const xml_element* child);

   void xload(const xml_element* node, const std::string& tool_config);

   xml_nodeRef xwrite() const;

   bool has_scripts() const;

   virtual std::string get_tool_exec() const;
};
using SynthesisToolRef = refcount<SynthesisTool>;

#endif