language_writer.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 LANGUAGE_WRITER_HPP
#define LANGUAGE_WRITER_HPP

#include "config_HAVE_FROM_C_BUILT.hpp"

#include "custom_set.hpp"
#include "dbgPrintHelper.hpp"
#include "refcount.hpp"

#include <list>
#include <map>
#include <set>
#include <string>
#include <vector>

REF_FORWARD_DECL(IndentedOutputStream);
REF_FORWARD_DECL(language_writer);
CONSTREF_FORWARD_DECL(Parameter);
REF_FORWARD_DECL(structural_type_descriptor);
CONSTREF_FORWARD_DECL(structural_object);
REF_FORWARD_DECL(structural_object);
CONSTREF_FORWARD_DECL(technology_manager);

#define BITSIZE_PREFIX "BITSIZE_"
#define PORTSIZE_PREFIX "PORTSIZE_"
#define NUM_ELEM_PREFIX "NUM_ELEM_"
enum class HDLWriter_Language
{
   VERILOG = 0,
   SYSTEM_VERILOG,
   VHDL
};

class language_writer
{
 protected:
   inline std::string encode_one_hot(unsigned int n_states, unsigned int val) const
   {
      std::string res;
      for(unsigned int i = 0; i < n_states; ++i)
      {
         res = (val == i ? "1" : "0") + res;
      }
      return res;
   }

   const IndentedOutputStreamRef indented_output_stream;

   CustomOrderedSet<std::string> list_of_lib;

   CustomOrderedSet<std::string> list_of_customized_gates;

   const ParameterConstRef parameters;

   int debug_level;

 public:
   language_writer(char open_char, char close_char, const ParameterConstRef parameters);

   virtual ~language_writer();

   static language_writerRef create_writer(HDLWriter_Language language, const technology_managerConstRef TM,
                                           const ParameterConstRef parameters);

   virtual std::string get_name() const = 0;

   virtual std::string get_extension() const = 0;

   virtual void write(const std::string& rawString);

   virtual void write_header();

   virtual void write_comment(const std::string& comment_string) = 0;

   virtual std::string type_converter(structural_type_descriptorRef Type) = 0;

   virtual std::string type_converter_size(const structural_objectRef& cir) = 0;

   virtual void write_library_declaration(const structural_objectRef& cir) = 0;
   virtual void write_module_declaration(const structural_objectRef& cir) = 0;
   virtual void write_module_internal_declaration(const structural_objectRef& cir) = 0;
   virtual void write_port_declaration(const structural_objectRef& cir, bool first_port_analyzed) = 0;
   virtual void write_component_declaration(const structural_objectRef& cir) = 0;
   virtual void write_signal_declaration(const structural_objectRef& cir) = 0;
   virtual void write_module_definition_begin(const structural_objectRef& cir) = 0;
   virtual void write_module_instance_begin(const structural_objectRef& cir, const std::string& module_name,
                                            bool write_parametrization) = 0;
   virtual void write_module_instance_end(const structural_objectRef& cir) = 0;
   virtual void write_port_binding(const structural_objectRef& port, const structural_objectRef& top,
                                   bool first_port_analyzed) = 0;

   virtual void write_vector_port_binding(const structural_objectRef& port, bool first_port_analyzed) = 0;
   virtual void write_module_definition_end(const structural_objectRef& cir) = 0;
   virtual void write_io_signal_post_fix(const structural_objectRef& port, const structural_objectRef& sig) = 0;
   virtual void write_io_signal_post_fix_vector(const structural_objectRef& port, const structural_objectRef& sig) = 0;
   virtual void write_module_parametrization(const structural_objectRef& cir) = 0;
   virtual void write_state_declaration(const structural_objectRef& cir, const std::list<std::string>& list_of_states,
                                        const std::string& reset_port, const std::string& reset_state,
                                        bool one_hot) = 0;
   virtual void write_present_state_update(const structural_objectRef cir, const std::string& reset_state,
                                           const std::string& reset_port, const std::string& clock_port,
                                           const std::string& reset_type, bool connect_present_next_state_signals) = 0;
   virtual void write_transition_output_functions(
       bool single_proc, unsigned int output_index, const structural_objectRef& cir, const std::string& reset_state,
       const std::string& reset_port, const std::string& start_port, const std::string& clock_port,
       std::vector<std::string>::const_iterator& first, std::vector<std::string>::const_iterator& end, bool is_yosys,
       const std::map<unsigned int, std::map<std::string, std::set<unsigned int>>>& bypass_signals) = 0;

   virtual void write_NP_functionalities(const structural_objectRef& cir) = 0;

   virtual void write_port_decl_header() = 0;

   virtual void write_port_decl_tail() = 0;

   virtual void write_module_parametrization_decl(const structural_objectRef& cir) = 0;

   virtual void write_assign(const std::string& op0, const std::string& op1) = 0;

   virtual bool has_output_prefix() const = 0;

   static unsigned int bitnumber(unsigned long long n);

   virtual bool check_keyword(const std::string& id) const = 0;

   virtual void WriteBuiltin(const structural_objectConstRef component) = 0;

   const std::string WriteString() const;

   void WriteFile(const std::string& filename) const;

   CustomSet<std::string> GetHDLReservedNames() const;

   void WriteLicense();
};
using language_writerRef = refcount<language_writer>;

#endif