hls.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 HLS_HPP
#define HLS_HPP

#include "op_graph.hpp"
#include "refcount.hpp"

#include <iosfwd>
#include <iostream>

REF_FORWARD_DECL(AllocationInformation);
REF_FORWARD_DECL(ChainingInformation);
REF_FORWARD_DECL(conn_binding);
REF_FORWARD_DECL(fu_binding);
REF_FORWARD_DECL(hls);
REF_FORWARD_DECL(HLS_constraints);
REF_FORWARD_DECL(HLS_device);
REF_FORWARD_DECL(liveness);
CONSTREF_FORWARD_DECL(OpGraph);
CONSTREF_FORWARD_DECL(Parameter);
REF_FORWARD_DECL(reg_binding);
REF_FORWARD_DECL(Schedule);
REF_FORWARD_DECL(StateTransitionGraphManager);
REF_FORWARD_DECL(StorageValueInformation);
REF_FORWARD_DECL(structural_manager);
class xml_element;
enum class HLSFlowStep_Type;

class hls
{
 public:
   unsigned int functionId;

   HLSFlowStep_Type controller_type;

   HLSFlowStep_Type module_binding_algorithm;

   HLSFlowStep_Type chaining_algorithm;

   HLSFlowStep_Type liveness_algorithm;

   OpVertexSet operations;

   // -------------- High Level Synthesis Specific -------------- //

   const HLS_deviceRef HLS_D;

   const HLS_constraintsRef HLS_C;

   // -------------- High Level Synthesis Results -------------- //

   AllocationInformationRef allocation_information;

   ScheduleRef Rsch;

   fu_bindingRef Rfu;

   StateTransitionGraphManagerRef STG;

   livenessRef Rliv;

   StorageValueInformationRef storage_value_information;

   reg_bindingRef Rreg;

   reg_bindingRef RregGroup;

   conn_bindingRef Rconn;

   ChainingInformationRef chaining_information;

   // -------------- high level synthesis structural representation -------------- //

   bool registered_inputs;
   bool registered_done_port;

   size_t call_sites_number;

   structural_managerRef datapath;

   structural_managerRef controller;

   structural_managerRef control_flow_checker;

   structural_managerRef top;

   // -------------- Parameters -------------- //

   const ParameterConstRef Param;

   int debug_level;

   int output_level;

   long HLS_execution_time;

   // -------------- Constructor & Destructor -------------- //

   hls(const ParameterConstRef Param, unsigned int function_id, OpVertexSet operations, const HLS_deviceRef HLS_D,
       const HLS_constraintsRef HLS_C);

   ~hls();

   void xload(const xml_element* rootnode, const OpGraphConstRef data);

   void xwrite(xml_element* rootnode, const OpGraphConstRef data);

   // -------------- Printing helpers -------------- //

   void print(std::ostream& os) const;

   void PrintScheduling() const;

   void print_register_binding(std::ostream& os) const;

   void print_register_grouping(std::ostream& os) const;

   void print_connection_binding(std::ostream& os) const;

   void PrintResources() const;

   friend std::ostream& operator<<(std::ostream& os, const hls& s)
   {
      s.print(os);
      return os;
   }
};
using hlsRef = refcount<hls>;

#endif