PandA-2024.02
Public Member Functions | Protected Member Functions
top_entity_parallel_cs Class Reference

#include <top_entity_parallel_cs.hpp>

Inheritance diagram for top_entity_parallel_cs:
Inheritance graph
[legend]
Collaboration diagram for top_entity_parallel_cs:
Collaboration graph
[legend]

Public Member Functions

 top_entity_parallel_cs (const ParameterConstRef _parameters, const HLS_managerRef HLSMgr, unsigned int funId, const DesignFlowManagerConstRef design_flow_manager, const HLSFlowStep_Type _hls_flow_step_type)
 behavior include More...
 
 ~top_entity_parallel_cs () override
 Destructor. More...
 
DesignFlowStep_Status InternalExec () override
 Add selector and suspension. More...
 
- Public Member Functions inherited from top_entity
 top_entity (const ParameterConstRef _parameters, const HLS_managerRef HLSMgr, unsigned int funId, const DesignFlowManagerConstRef design_flow_manager, const HLSFlowStep_Type=HLSFlowStep_Type::TOP_ENTITY_CREATION)
 Constructor. More...
 
 ~top_entity () override
 Destructor. More...
 
- Public Member Functions inherited from HLSFunctionStep
 HLSFunctionStep (const ParameterConstRef Param, const HLS_managerRef HLSMgr, unsigned int funId, const DesignFlowManagerConstRef design_flow_manager, const HLSFlowStep_Type hls_flow_step_type, const HLSFlowStepSpecializationConstRef hls_flow_step_specialization=HLSFlowStepSpecializationConstRef())
 Constructor. More...
 
 ~HLSFunctionStep () override
 Destructor. More...
 
bool HasToBeExecuted () const override
 Check if this step has actually to be executed. More...
 
void Initialize () override
 Initialize the step (i.e., like a constructor, but executed just before exec. More...
 
std::string GetSignature () const final
 Return a unified identifier of this design step. More...
 
std::string GetName () const final
 Return the name of this design step. More...
 
DesignFlowStep_Status Exec () final
 Execute the step. More...
 
- Public Member Functions inherited from HLS_step
 HLS_step (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())
 Constructor. More...
 
 ~HLS_step () override
 Destructor. More...
 
std::string GetSignature () const override
 Return a unified identifier of this design step. More...
 
std::string GetName () const override
 Return the name of this design step. More...
 
virtual std::string GetKindText () const
 Return the name of the type of this frontend flow step. More...
 
DesignFlowStepFactoryConstRef CGetDesignFlowStepFactory () const final
 Return the factory to create this type of steps. More...
 
void ComputeRelationships (DesignFlowStepSet &design_flow_step_set, const DesignFlowStep::RelationshipType relationship_type) override
 Compute the relationships of a step with other steps. More...
 
- Public Member Functions inherited from DesignFlowStep
 DesignFlowStep (const DesignFlowManagerConstRef design_flow_manager, const ParameterConstRef parameters)
 Constructor. More...
 
virtual ~DesignFlowStep ()
 Destructor. More...
 
DesignFlowStep_Status GetStatus () const
 Return the status of this design step. More...
 
virtual void WriteDot (std::ostream &out) const
 Write the label for a dot graph. More...
 
bool IsComposed () const
 Returns if this step is composed. More...
 
int CGetDebugLevel () const
 Return the debug level of the step. More...
 
virtual void PrintInitialIR () const
 Dump the initial intermediate representation. More...
 
virtual void PrintFinalIR () const
 Dump the final intermediate representation. More...
 

Protected Member Functions

void connect_port_parallel (const structural_objectRef circuit, unsigned long long loopBW)
 connect_port_parallel connect datapath and controller More...
 
const CustomUnorderedSet< std::tuple< HLSFlowStep_Type, HLSFlowStepSpecializationConstRef, HLSFlowStep_Relationship > > ComputeHLSRelationships (const DesignFlowStep::RelationshipType relationship_type) const override
 Return the set of analyses in relationship with this design step. More...
 
unsigned long long BW_loop_iter (const structural_objectRef circuit)
 
void connect_loop_iter (const structural_objectRef circuit, unsigned long long loopBW)
 
void resize_controller_parallel (structural_objectRef controller_circuit, unsigned long long loopBW)
 resize_controller_parallel More...
 
- Protected Member Functions inherited from top_entity
void add_ports (structural_objectRef circuit, structural_objectRef clock_port, structural_objectRef reset_port)
 Adds the input/output ports to the circuit. More...
 
void add_command_signals (structural_objectRef circuit)
 Adds the command signals to the circuit. More...
 
virtual void add_input_register (structural_objectRef port_in, const std::string &port_prefix, structural_objectRef circuit, structural_objectRef clock_port, structural_objectRef reset_port, structural_objectRef e_port)
 Add the register to store input parameters. More...
 
- Protected Member Functions inherited from HLSFunctionStep
void ComputeRelationships (DesignFlowStepSet &design_flow_step_set, const DesignFlowStep::RelationshipType relationship_type) override
 Compute the relationships of a step with other steps. More...
 

Additional Inherited Members

- Public Types inherited from DesignFlowStep
enum  RelationshipType { DEPENDENCE_RELATIONSHIP, INVALIDATION_RELATIONSHIP, PRECEDENCE_RELATIONSHIP }
 The relationship type. More...
 
- Static Public Member Functions inherited from HLSFunctionStep
static std::string ComputeSignature (const HLSFlowStep_Type hls_flow_step_type, const HLSFlowStepSpecializationConstRef hls_flow_step_specialization, const unsigned int function_id)
 Compute the signature of a hls flow step. More...
 
- Static Public Member Functions inherited from HLS_step
static std::string EnumToName (const HLSFlowStep_Type hls_flow_step_type)
 Given a HLS flow step type, return the name of the type. More...
 
static const std::string ComputeSignature (const HLSFlowStep_Type hls_flow_step_type, const HLSFlowStepSpecializationConstRef hls_flow_step_specialization)
 Compute the signature of a hls flow step. More...
 
- Protected Attributes inherited from top_entity
structural_managerRef SM
 reference to the resulting circuit More...
 
- Protected Attributes inherited from HLSFunctionStep
std::map< unsigned int, unsigned int > last_bb_ver
 last bb version of the called functions More...
 
std::map< unsigned int, unsigned int > last_bitvalue_ver
 The version of bit value IR representation on which this step was applied. More...
 
const unsigned int funId
 identifier of the function to be processed (0 means that it is a global step) More...
 
hlsRef HLS
 HLS data structure of the function to be analyzed. More...
 
unsigned int bb_version
 The version of bb intermediate representation on which this step was applied. More...
 
unsigned int bitvalue_version
 The version of bitvalue on which this step was applied. More...
 
unsigned int memory_version
 The version of memory representation on which this step was applied. More...
 
- Protected Attributes inherited from HLS_step
const HLS_managerRef HLSMgr
 information about all the HLS synthesis More...
 
const HLSFlowStep_Type hls_flow_step_type
 The type of this step. More...
 
const HLSFlowStepSpecializationConstRef hls_flow_step_specialization
 The information about specialization. More...
 
- Protected Attributes inherited from DesignFlowStep
bool composed
 True if this step represents a composition of design flow steps (e.g., a flow); must be set by specialized constructors. More...
 
const Wrefcount< const DesignFlowManagerdesign_flow_manager
 The design flow manager. More...
 
const ParameterConstRef parameters
 Set of input parameters. More...
 
int debug_level
 The debug level. More...
 
const int output_level
 The output level. More...
 
- Static Protected Attributes inherited from HLS_step
static CustomUnorderedMap< std::string, HLSFlowStep_Typecommand_line_name_to_enum
 Map hls step name to enum. More...
 

Detailed Description

Definition at line 46 of file top_entity_parallel_cs.hpp.

Constructor & Destructor Documentation

◆ top_entity_parallel_cs()

top_entity_parallel_cs::top_entity_parallel_cs ( const ParameterConstRef  _parameters,
const HLS_managerRef  _HLSMgr,
unsigned int  _funId,
const DesignFlowManagerConstRef  _design_flow_manager,
const HLSFlowStep_Type  _hls_flow_step_type 
)

behavior include

STD includes STL includes utility includes

Definition at line 73 of file top_entity_parallel_cs.cpp.

References DesignFlowStep::debug_level, GET_CLASS, DesignFlowStep::parameters, and ~top_entity_parallel_cs().

Here is the call graph for this function:

◆ ~top_entity_parallel_cs()

top_entity_parallel_cs::~top_entity_parallel_cs ( )
overridedefault

Destructor.

Referenced by top_entity_parallel_cs().

Here is the caller graph for this function:

Member Function Documentation

◆ BW_loop_iter()

unsigned long long top_entity_parallel_cs::BW_loop_iter ( const structural_objectRef  circuit)
protected

Definition at line 277 of file top_entity_parallel_cs.cpp.

References ceil_log2(), FunctionBehavior::CGetLoops(), component_o_K, structural_object::find_member(), HLSFunctionStep::funId, HLS_step::HLSMgr, tree_helper::Size(), THROW_ASSERT, and THROW_ERROR.

Referenced by InternalExec().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ComputeHLSRelationships()

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

Return the set of analyses in relationship with this design step.

Parameters
relationship_typeis the type of relationship to be considered

Reimplemented from top_entity.

Definition at line 85 of file top_entity_parallel_cs.cpp.

References DATAPATH_CS_PARALLEL_CREATOR, DesignFlowStep::DEPENDENCE_RELATIONSHIP, DesignFlowStep::INVALIDATION_RELATIONSHIP, DesignFlowStep::PRECEDENCE_RELATIONSHIP, SAME_FUNCTION, and THROW_UNREACHABLE.

◆ connect_loop_iter()

void top_entity_parallel_cs::connect_loop_iter ( const structural_objectRef  circuit,
unsigned long long  loopBW 
)
protected

◆ connect_port_parallel()

void top_entity_parallel_cs::connect_port_parallel ( const structural_objectRef  circuit,
unsigned long long  loopBW 
)
protected

◆ InternalExec()

DesignFlowStep_Status top_entity_parallel_cs::InternalExec ( )
overridevirtual

Add selector and suspension.

Returns
the exit status of this step

function name to be synthesized

Test on previous steps. They checks if datapath and controller have been created. If they didn't, top circuit cannot be created.

top circuit creation

main circuit type

setting top circuit component

Set some descriptions and legal stuff

creating structural_manager

command signal type descriptor

add clock port

connect to datapath and controller clock

add reset port

connecting global reset port to the datapath one

connecting global reset port to the controller one

start port

check if datapath has a start signal

add done port

add entry in in_port_map between port id and port index

Reimplemented from top_entity.

Definition at line 110 of file top_entity_parallel_cs.cpp.

References structural_manager::add_connection(), structural_manager::add_module_from_technology_library(), structural_manager::add_port(), top_entity::add_ports(), structural_manager::add_sign(), BW_loop_iter(), FunctionBehavior::CGetBehavioralHelper(), CLOCK_PORT_NAME, connect_port_parallel(), hls::datapath, DesignFlowStep::debug_level, DEBUG_LEVEL_VERBOSE, DEBUG_LEVEL_VERY_PEDANTIC, DONE_PORT_NAME, structural_object::find_member(), flipflop_AR, flipflop_SR, FSM_CONTROLLER_CREATOR, FSM_CS_CONTROLLER_CREATOR, HLSFunctionStep::funId, GENERATED_COPYRIGHT, GENERATED_LICENSE, structural_manager::get_circ(), BehavioralHelper::get_function_name(), HLSFunctionStep::HLS, hls::HLS_D, HLS_step::HLSMgr, LIBRARY_STD, DesignFlowStep::parameters, PIPELINE_CONTROLLER_CREATOR, port_o_K, PRINT_DBG_MEX, memory::propagate_memory_parameters(), hls::registered_done_port, RESET_PORT_NAME, resize_controller_parallel(), structural_object::set_black_box(), structural_object::set_owner(), structural_manager::set_top_info(), top_entity::SM, START_PORT_NAME, SUCCESS, THROW_ASSERT, and hls::top.

Here is the call graph for this function:

◆ resize_controller_parallel()

void top_entity_parallel_cs::resize_controller_parallel ( structural_objectRef  controller_circuit,
unsigned long long  loopBW 
)
protected

resize_controller_parallel

Parameters
controller_circuit

Definition at line 358 of file top_entity_parallel_cs.cpp.

References DONE_PORT_NAME, DONE_REQUEST, structural_object::find_member(), DesignFlowStep::parameters, port_o_K, port_vector_o_K, START_PORT_NAME, and STR.

Referenced by InternalExec().

Here is the call graph for this function:
Here is the caller graph for this function:

The documentation for this class was generated from the following files:

Generated on Mon Feb 12 2024 13:04:06 for PandA-2024.02 by doxygen 1.8.13