Class generating minimal interfaces. More...

#include <minimal_interface.hpp>

Inheritance diagram for minimal_interface:

[legend]

Collaboration diagram for minimal_interface:

[legend]

Public Member Functions
	minimal_interface (const ParameterConstRef Param, const HLS_managerRef HLSMgr, unsigned int funId, const DesignFlowManagerConstRef design_flow_manager, const HLSFlowStep_Type hls_flow_step_type=HLSFlowStep_Type::MINIMAL_INTERFACE_GENERATION)
	Constructor. More...

	~minimal_interface () override
	Destructor. More...

DesignFlowStep_Status	InternalExec () override
	Execute the step. More...

Public Member Functions inherited from module_interface
	module_interface (const ParameterConstRef _parameters, const HLS_managerRef HLSMgr, unsigned int funId, const DesignFlowManagerConstRef design_flow_manager, const HLSFlowStep_Type hls_flow_step_type)
	Constructor. More...

	~module_interface () 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...

Private Member Functions
void	build_wrapper (structural_objectRef wrappedObj, structural_objectRef interfaceObj, structural_managerRef SM_minimal_interface)

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 Member Functions inherited from module_interface
void	add_sign (const structural_managerRef SM, const structural_objectRef sig1, const structural_objectRef sig2, const std::string &sig_name)
	Connects two ports by adding a signal (i.e., wire) More...

void	AddSignal (const structural_managerRef SM, const structural_objectRef component1, const std::string &port1, const structural_objectRef component2, const std::string &port2, const std::string &signal_name)
	Connects two ports by adding a signal. More...

void	AddConnection (const structural_managerRef SM, const structural_objectRef component1, const std::string &port1, const structural_objectRef component2, const std::string &port2)
	Connects two ports by adding a signal. More...

void	AddConstant (const structural_managerRef SM, const structural_objectRef component, const std::string &port, const std::string &constant, const unsigned long long size)
	Connects a constant to a port. More...

void	add_sign_vector (const structural_managerRef SM, const structural_objectRef sig1, const structural_objectRef sig2, const std::string &sig_name)
	Connects two ports by adding a vector signal (i.e., wire) 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...

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...

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 DesignFlowManager >	design_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_Type >	command_line_name_to_enum
	Map hls step name to enum. More...

Detailed Description

Class generating minimal interfaces.

Definition at line 56 of file minimal_interface.hpp.

Constructor & Destructor Documentation

◆ minimal_interface()

minimal_interface::minimal_interface	(	const ParameterConstRef	Param,
		const HLS_managerRef	HLSMgr,
		unsigned int	funId,
		const DesignFlowManagerConstRef	design_flow_manager,
		const HLSFlowStep_Type	hls_flow_step_type = `HLSFlowStep_Type::MINIMAL_INTERFACE_GENERATION`
	)

Constructor.

Definition at line 75 of file minimal_interface.cpp.

References HLSFunctionStep::funId, THROW_ASSERT, and ~minimal_interface().

Here is the call graph for this function:

◆ ~minimal_interface()

minimal_interface::~minimal_interface ( )

overridedefault

Destructor.

Referenced by minimal_interface().

Here is the caller graph for this function:

Member Function Documentation

◆ build_wrapper()

void minimal_interface::build_wrapper	(	structural_objectRef	wrappedObj,
		structural_objectRef	interfaceObj,
		structural_managerRef	SM_minimal_interface
	)

private

list of ports that have to be connected to constant 0

slave INs connections

slave INs

slave OUTs

do nothing it may happen with ALL_BRAM memory allocation policy

intern data is not externally visible slave INs

slave OUTs

slave INs connections

master INs connections

slave OUTs skip

master OUTs skip

do nothing

allocate the unique shared memory

data padding

alignment padding

slave INs connections

master INs connections

master OUTs skip

slave INs connections

master INs connections

slave OUTs skip

master OUTs skip

slave INs

slave OUTs

Check if we have an I/O interface

check if we have fifo-in interface

check if we have fifo-out interface

check if we have array single port in interface

check if we have array single port out interface

check if we have axis master interface

check if we have axis slave interface

Definition at line 140 of file minimal_interface.cpp.

References structural_manager::add_connection(), structural_manager::add_constant(), structural_manager::add_module_from_technology_library(), structural_manager::add_port(), structural_manager::add_port_vector(), structural_manager::add_sign(), structural_manager::add_sign_vector(), tree_helper::CGetPointedType(), tree_helper::CGetType(), CLOCK_PORT_NAME, compareMemVarsPair(), counter, DONE_PORT_NAME, EXT_PIPELINED_BRAM, structural_object::find_member(), port_o::fix_port_properties(), hls::functionId, HLSFunctionStep::funId, structural_object::get_id(), structural_object::get_kind(), structural_object::get_owner(), GET_TYPE_SIZE, structural_object::get_typeRef(), GetPath(), HLSFunctionStep::HLS, HLS_step::HLSMgr, INFERRED_INTERFACE_GENERATION, structural_type_descriptor::INT, tree_helper::IsPointerType(), LIBRARY_STD, MEM_ACC_11, MEM_ACC_N1, MEM_ACC_P1N, NO_BRAM, DesignFlowStep::parameters, port_o_K, port_vector_o_K, TestbenchGeneration::print_var_init(), RESET_PORT_NAME, sign, tree_helper::Size(), structural_type_descriptor::size, START_PORT_NAME, STD_BRAM, STD_BRAMN, STR, THROW_ASSERT, THROW_ERROR, structural_type_descriptor::treenode, structural_type_descriptor::type, structural_object::type_resize(), U, structural_type_descriptor::UINT, VIEW_CONVERT_STD_INT, and VIEW_CONVERT_STD_UINT.

Referenced by InternalExec().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InternalExec()

DesignFlowStep_Status minimal_interface::InternalExec ( )

overridevirtual

Execute the step.

Returns: the exit status of this step

Set some descriptions and legal stuff

Implements HLSFunctionStep.

Reimplemented in WB4_interface.

Definition at line 85 of file minimal_interface.cpp.

References build_wrapper(), HLSFunctionStep::funId, GENERATED_COPYRIGHT, GENERATED_LICENSE, structural_manager::get_circ(), HLSFunctionStep::HLS, HLS_step::HLSMgr, DesignFlowStep::parameters, memory::propagate_memory_parameters(), structural_object::set_owner(), structural_manager::set_top_info(), SUCCESS, THROW_ERROR, and hls::top.

Referenced by WB4_interface::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:

/workspace/src/HLS/interface/minimal/minimal_interface.hpp
/workspace/src/HLS/interface/minimal/minimal_interface.cpp

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ minimal_interface()

◆ ~minimal_interface()

Member Function Documentation

◆ build_wrapper()

◆ InternalExec()