memory_allocation.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 _MEMORY_ALLOCATION_HPP_
#define _MEMORY_ALLOCATION_HPP_

#include "custom_set.hpp"
#include "hls_step.hpp"
#include "refcount.hpp"
#include <list>
#include <map>
#include <string>
#include <tuple>

REF_FORWARD_DECL(memory_allocation);
REF_FORWARD_DECL(memory);

enum class MemoryAllocation_Policy
{
   LSS = 1,      
   GSS = 2,      
   ALL_BRAM = 3, 
   NO_BRAM = 0,  
   EXT_PIPELINED_BRAM =
       4,   
   NONE = 7 
};

enum class MemoryAllocation_ChannelsType
{
   MEM_ACC_11 = 0, 
   MEM_ACC_N1 = 1, 
   MEM_ACC_NN = 3, 
   MEM_ACC_P1N =
       6, 
   MEM_ACC_CS = 8 
};

class MemoryAllocationSpecialization : public HLSFlowStepSpecialization
{
 public:
   const MemoryAllocation_Policy memory_allocation_policy;

   const MemoryAllocation_ChannelsType memory_allocation_channels_type;

   MemoryAllocationSpecialization(const MemoryAllocation_Policy memory_allocation_policy,
                                  const MemoryAllocation_ChannelsType memory_allocation_channels_type);

   std::string GetKindText() const override;

   std::string GetSignature() const override;
};

class memory_allocation : public HLS_step
{
 protected:
   CustomOrderedSet<unsigned int> func_list;

   unsigned int memory_version;

   std::map<unsigned int, unsigned int> last_bb_ver;

   std::map<unsigned int, unsigned int> last_bitvalue_ver;

   void setup_memory_allocation();

   void finalize_memory_allocation();

   const CustomUnorderedSet<std::tuple<HLSFlowStep_Type, HLSFlowStepSpecializationConstRef, HLSFlowStep_Relationship>>
   ComputeHLSRelationships(const DesignFlowStep::RelationshipType relationship_type) const override;

   virtual DesignFlowStep_Status InternalExec() = 0;

 public:
   memory_allocation(
       const ParameterConstRef _parameters, const HLS_managerRef HLSMgr,
       const DesignFlowManagerConstRef design_flow_manager, const HLSFlowStep_Type hls_flow_step_type,
       const HLSFlowStepSpecializationConstRef hls_flow_step_specialization = HLSFlowStepSpecializationConstRef());

   ~memory_allocation() override;

   void allocate_parameters(unsigned int functionId, memoryRef Rmem = nullptr);

   bool HasToBeExecuted() const override;

   DesignFlowStep_Status Exec() override;
};

#endif