PandA-2024.02
quartus_power_wrapper.cpp
Go to the documentation of this file.
1 /*
2  *
3  * _/_/_/ _/_/ _/ _/ _/_/_/ _/_/
4  * _/ _/ _/ _/ _/_/ _/ _/ _/ _/ _/
5  * _/_/_/ _/_/_/_/ _/ _/_/ _/ _/ _/_/_/_/
6  * _/ _/ _/ _/ _/ _/ _/ _/ _/
7  * _/ _/ _/ _/ _/ _/_/_/ _/ _/
8  *
9  * ***********************************************
10  * PandA Project
11  * URL: http://panda.dei.polimi.it
12  * Politecnico di Milano - DEIB
13  * System Architectures Group
14  * ***********************************************
15  * Copyright (C) 2017-2024 Politecnico di Milano
16  *
17  * This file is part of the PandA framework.
18  *
19  * The PandA framework is free software; you can redistribute it and/or modify
20  * it under the terms of the GNU General Public License as published by
21  * the Free Software Foundation; either version 3 of the License, or
22  * (at your option) any later version.
23  *
24  * This program is distributed in the hope that it will be useful,
25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27  * GNU General Public License for more details.
28  *
29  * You should have received a copy of the GNU General Public License
30  * along with this program. If not, see <http://www.gnu.org/licenses/>.
31  *
32  */
38 
39 #include "DesignParameters.hpp"
40 #include "Parameter.hpp"
41 #include "ToolManager.hpp"
42 #include "dbgPrintHelper.hpp"
43 #include "string_manipulation.hpp"
44 #include "xml_script_command.hpp"
45 #include <filesystem>
46 
47 // constructor
48 QuartusPowerWrapper::QuartusPowerWrapper(const ParameterConstRef _Param, const std::string& _output_dir,
49  const generic_deviceRef _device)
50  : AlteraWrapper(_Param, QUARTUS_POWER_TOOL_EXEC, _device, _output_dir, QUARTUS_POWER_TOOL_ID)
51 {
52  PRINT_DBG_MEX(DEBUG_LEVEL_PEDANTIC, debug_level, "Creating the QUARTUS_POWER wrapper...");
53 }
54 
55 // destructor
57 
59 {
60  std::string top_id = dp->component_name;
61  dp->parameter_values[PARAM_quartus_report] = output_dir + "/" + top_id + "_report.xml";
62 }
63 
65 {
66  std::ostringstream s;
67  s << get_tool_exec() << " -f " << script_name;
68  for(const auto& option : xml_tool_options)
69  {
70  if(option->checkCondition(dp))
71  {
72  std::string value = toString(option, dp);
73  replace_parameters(dp, value);
74  s << " " << value;
75  }
76  }
77  s << std::endl;
78  return s.str();
79 }
80 
81 void QuartusPowerWrapper::generate_synthesis_script(const DesignParametersRef& dp, const std::string& file_name)
82 {
83  // Export reserved (constant) values to design parameters
84  for(auto& var : xml_reserved_vars)
85  {
86  dp->assign(var->name, getStringValue(var, dp), false);
87  }
88 
89  // Bare script generation
90  std::ostringstream script;
92 
93  // Replace all reserved variables with their value
94  std::string script_string = script.str();
95  replace_parameters(dp, script_string);
97  remove_escaped(script_string);
98 
99  // Save the generated script
100  if(std::filesystem::exists(file_name))
101  {
102  std::filesystem::remove_all(file_name);
103  }
104  script_name = file_name;
105  std::ofstream file_stream(file_name.c_str());
106  file_stream << script_string << std::endl;
107  file_stream.close();
108 }
File containing functions and utilities to support the printing of debug messagges.
QuartusPowerWrapper(const ParameterConstRef Param, const std::string &_output_dir, const generic_deviceRef _device)
Constructor.
#define PRINT_DBG_MEX(dbgLevel, curDbgLevel, mex)
We are producing a debug version of the program, so the message is printed;.
void remove_escaped(std::string &ioString)
Function converting all the escaped characters in the associated character.
#define DEBUG_LEVEL_PEDANTIC
very verbose debugging print is performed.
void EvaluateVariables(const DesignParametersRef dp) override
Evaluates the design variables.
int debug_level
debug level of the class
#define QUARTUS_POWER_TOOL_EXEC
void generate_synthesis_script(const DesignParametersRef &dp, const std::string &file_name) override
Creates the proper configuration script.
#define QUARTUS_POWER_TOOL_ID
std::string output_dir
the output directory
std::string toString(const xml_script_node_tRef node, const DesignParametersRef dp) const override
Returns the string-based representation of the XML element.
Auxiliary methods for manipulating string.
map_t parameter_values
Map between the name of the parameter and the corresponding string-based value.
std::vector< xml_script_node_tRef > xml_script_nodes
void assign(const std::string &name, const std::string &value, bool checkExisting)
Assigns a value to a saved parameter.
std::vector< xml_set_variable_tRef > xml_reserved_vars
This file contains the definition of the parameters for the synthesis tools.
std::string script_name
name of the script
~QuartusPowerWrapper() override
Destructor.
std::string getStringValue(const xml_script_node_tRef node, const DesignParametersRef &dp) const override
Returns the string-based representation of the XML element.
void replace_parameters(const DesignParametersRef &dp, std::string &script) const
Replaces occurrences of parameters inside a script.
std::vector< xml_parameter_tRef > xml_tool_options
Classes for handling configuration files.
#define PARAM_quartus_report
std::string get_command_line(const DesignParametersRef &dp) const override
Returns the proper command line.
Class to manage a wrapped tool.
std::string component_name
Name of the component.
Template borrowed from the ANTLR library by Terence Parr (http://www.jGuru.com - Software rights: htt...
Definition: refcount.hpp:94
virtual std::string get_tool_exec() const
Returns the name of the tool executable.
this class is used to manage the command-line or XML options.
std::string generate_bare_script(const std::vector< xml_script_node_tRef > &nodes, const DesignParametersRef &dp)

Generated on Mon Feb 12 2024 13:02:56 for PandA-2024.02 by doxygen 1.8.13