BackendFlow.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 _BACKEND_FLOW_HPP_
#define _BACKEND_FLOW_HPP_

#include "config_HAVE_SIMULATION_WRAPPER_BUILT.hpp"
#include "config_HAVE_TASTE.hpp"

#include <list>

#include "refcount.hpp"
CONSTREF_FORWARD_DECL(Parameter);
REF_FORWARD_DECL(SynthesisTool);
REF_FORWARD_DECL(generic_device);
REF_FORWARD_DECL(area_info);
REF_FORWARD_DECL(time_info);
REF_FORWARD_DECL(Design_manager);
REF_FORWARD_DECL(BackendFlow);
REF_FORWARD_DECL(HDL_manager);
REF_FORWARD_DECL(language_writer);
REF_FORWARD_DECL(structural_manager);
REF_FORWARD_DECL(technology_node);
REF_FORWARD_DECL(XMLDomParser);
REF_FORWARD_DECL(DesignParameters);
class xml_element;
using fileIO_istreamRef = refcount<std::istream>;

#include "custom_set.hpp"
#include <string>
#include <vector>

struct BackendStep
{
   std::string name;

   std::string config_name;

   std::string script_name;

   SynthesisToolRef tool;

   std::string out_dir;
};
using BackendStepRef = refcount<BackendStep>;

class BackendFlow
{
 public:
   using type_t = enum {
      UNKNOWN,
      XILINX_FPGA,
#if HAVE_TASTE
      XILINX_TASTE_FPGA,
#endif
      ALTERA_FPGA,
      LATTICE_FPGA,
      NANOXPLORE_FPGA,
      GENERIC,
   };

 protected:
   const ParameterConstRef Param;

   int debug_level;

   unsigned int output_level;

   std::string flow_name;

   std::string out_dir;

   std::map<std::string, std::string> default_data;

   const generic_deviceRef device;

   xml_element* root;

   area_infoRef area_m;

   time_infoRef time_m;

   std::vector<BackendStepRef> steps;

   DesignParametersRef default_flow_parameters;

   CustomOrderedSet<std::string> undefined_parameters;

   DesignParametersRef actual_parameters;

   std::string generated_synthesis_script;

   void ParseBackendFlow(const std::string& flow_name);

   void xload(const xml_element* node);

   virtual void WriteFlowConfiguration(std::ostream& script) = 0;

   virtual void CheckSynthesisResults() = 0;

 public:
   BackendFlow(const ParameterConstRef Param, std::string flow_name, const generic_deviceRef _device);

   virtual ~BackendFlow();

   static BackendFlowRef CreateFlow(const ParameterConstRef Param, const std::string& flow_name,
                                    const generic_deviceRef _device);

   static type_t DetermineBackendFlowType(const generic_deviceRef device, const ParameterConstRef parameters);

   virtual std::string GenerateSynthesisScripts(const std::string& fu_name, const structural_managerRef SM,
                                                const std::list<std::string>& hdl_files,
                                                const std::list<std::string>& aux_files);

   virtual void ExecuteSynthesis();

   void Execute(const std::string& top_id, const std::string& top_normalized, const std::string& filestring,
                const std::string& filename_bench, const std::string& clock, double clk_period, bool syntax_check);

   std::string CreateScripts(const DesignParametersRef dp);

   virtual void InitDesignParameters();

   void parse_flow(const XMLDomParserRef parser);

   void create_xml_scripts(const std::string& xml_file);

   void add_backend_step(const BackendStepRef& step);

   std::string get_flow_name() const;

   void set_initial_parameters(const DesignParametersRef& flow_parameters,
                               const CustomOrderedSet<std::string>& undefined_parameters);

   void set_parameters(const DesignParametersRef& _flow_parameters);

   area_infoRef get_used_resources() const;

   time_infoRef get_timing_results() const;
};
using BackendFlowRef = refcount<BackendFlow>;

#endif