#include <control_flow_checker.hpp>

Inheritance diagram for ControlFlowChecker:

Collaboration diagram for ControlFlowChecker:

[legend]

Public Member Functions
	ControlFlowChecker (const ParameterConstRef Param, const HLS_managerRef HLSMgr, unsigned int funId, const DesignFlowManagerConstRef design_flow_manager)
	Constructor. More...

	~ControlFlowChecker () override
	Destructor. More...

DesignFlowStep_Status	InternalExec () override
	Execute the step. 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...

Static Public Member Functions
static bool	IsOneHotFSM (unsigned int function_id, const HLS_managerRef HLSMgr)

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

void	add_clock_reset (structural_objectRef circuit)

void	add_done_port (structural_objectRef circuit)

void	add_start_port (structural_objectRef circuit)

void	add_present_state (structural_objectRef circuit, unsigned int state_bitsize)

void	add_notifiers (structural_objectRef circuit)

void	add_common_ports (structural_objectRef circuit, unsigned int state_bitsize)

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

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

Definition at line 53 of file control_flow_checker.hpp.

Constructor & Destructor Documentation

◆ ControlFlowChecker()

ControlFlowChecker::ControlFlowChecker	(	const ParameterConstRef	_Param,
		const HLS_managerRef	_HLSMgr,
		unsigned int	_funId,
		const DesignFlowManagerConstRef	_design_flow_manager
	)

Constructor.

Author: Pietro Fezzardi pietr.nosp@m.ofez.nosp@m.zardi.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Definition at line 62 of file control_flow_checker.cpp.

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

Here is the call graph for this function:

◆ ~ControlFlowChecker()

ControlFlowChecker::~ControlFlowChecker ( )

overridedefault

Destructor.

Referenced by ControlFlowChecker().

Here is the caller graph for this function:

Member Function Documentation

◆ add_clock_reset()

void ControlFlowChecker::add_clock_reset ( structural_objectRef circuit )

protected

define boolean type for the clock and reset signals

add clock port

add entry in in_port_map between port id and port index

add reset port

Definition at line 624 of file control_flow_checker.cpp.

References structural_manager::add_port(), CLOCK_PORT_NAME, hls::control_flow_checker, DesignFlowStep::debug_level, DEBUG_LEVEL_PEDANTIC, DEBUG_LEVEL_VERY_PEDANTIC, HLSFunctionStep::HLS, PRINT_DBG_MEX, and RESET_PORT_NAME.

Referenced by add_common_ports().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ add_common_ports()

void ControlFlowChecker::add_common_ports	(	structural_objectRef	circuit,
		unsigned int	state_bitsize
	)

protected

Definition at line 699 of file control_flow_checker.cpp.

References add_clock_reset(), add_done_port(), add_notifiers(), add_present_state(), add_start_port(), DesignFlowStep::debug_level, DEBUG_LEVEL_PEDANTIC, and PRINT_DBG_MEX.

Referenced by InternalExec().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ add_done_port()

void ControlFlowChecker::add_done_port ( structural_objectRef circuit )

protected

define boolean type for the done port

add done port

Definition at line 643 of file control_flow_checker.cpp.

References structural_manager::add_port(), hls::control_flow_checker, DesignFlowStep::debug_level, DEBUG_LEVEL_PEDANTIC, DEBUG_LEVEL_VERY_PEDANTIC, DONE_PORT_NAME, HLSFunctionStep::HLS, and PRINT_DBG_MEX.

Referenced by add_common_ports().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ add_notifiers()

void ControlFlowChecker::add_notifiers ( structural_objectRef circuit )

protected

define boolean type for the start port

add the notifiers

Definition at line 678 of file control_flow_checker.cpp.

References structural_manager::add_port(), hls::control_flow_checker, DesignFlowStep::debug_level, DEBUG_LEVEL_PEDANTIC, DEBUG_LEVEL_VERY_PEDANTIC, HLSFunctionStep::HLS, NOTIFIER_PORT_MISMATCH, NOTIFIER_PORT_MISMATCH_ID, NOTIFIER_PORT_MISMATCH_OFFSET, and PRINT_DBG_MEX.

Referenced by add_common_ports().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ add_present_state()

void ControlFlowChecker::add_present_state	(	structural_objectRef	circuit,
		unsigned int	state_bitsize
	)

protected

define boolean type for the start port

add the present/next state

Definition at line 665 of file control_flow_checker.cpp.

References structural_manager::add_port(), hls::control_flow_checker, DesignFlowStep::debug_level, DEBUG_LEVEL_PEDANTIC, DEBUG_LEVEL_VERY_PEDANTIC, HLSFunctionStep::HLS, NEXT_STATE_PORT_NAME, PRESENT_STATE_PORT_NAME, and PRINT_DBG_MEX.

Referenced by add_common_ports().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ add_start_port()

void ControlFlowChecker::add_start_port ( structural_objectRef circuit )

protected

define boolean type for the start port

add the start port

Definition at line 654 of file control_flow_checker.cpp.

References structural_manager::add_port(), hls::control_flow_checker, DesignFlowStep::debug_level, DEBUG_LEVEL_PEDANTIC, DEBUG_LEVEL_VERY_PEDANTIC, HLSFunctionStep::HLS, PRINT_DBG_MEX, and START_PORT_NAME.

Referenced by add_common_ports().

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 > > ControlFlowChecker::ComputeHLSRelationships ( const DesignFlowStep::RelationshipType relationship_type ) const

overrideprotectedvirtual

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

Parameters

relationship_type is the type of relationship to be considered

Reimplemented from HLS_step.

Definition at line 72 of file control_flow_checker.cpp.

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

◆ InternalExec()

DesignFlowStep_Status ControlFlowChecker::InternalExec ( )

overridevirtual

Execute the step.

Returns: the exit status of this step

Implements HLSFunctionStep.

Definition at line 717 of file control_flow_checker.cpp.

References add_common_ports(), structural_manager::add_NP_functionality(), FunctionBehavior::CGetBehavioralHelper(), StateTransitionGraphManager::CGetStg(), comp_state_bitsize(), hls::control_flow_checker, create_control_flow_checker(), DesignFlowStep::debug_level, HLSFunctionStep::funId, GENERATED_COPYRIGHT, GENERATED_LICENSE, structural_manager::get_circ(), BehavioralHelper::get_function_name(), GetPath(), HLSFunctionStep::HLS, IsOneHotFSM(), NP_functionality::LIBRARY, max, hls::Param, structural_manager::set_top_info(), hls::STG, STR, SUCCESS, and NP_functionality::VERILOG_PROVIDED.

Here is the call graph for this function:

◆ IsOneHotFSM()

bool ControlFlowChecker::IsOneHotFSM	(	unsigned int	function_id,
		const HLS_managerRef	HLSMgr
	)

static

Definition at line 97 of file control_flow_checker.cpp.

Referenced by vcd_utility::Exec(), and InternalExec().

Here is the caller graph for this function:

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

/workspace/src/HLS/architecture_creation/controller_creation/control_flow_checker.hpp
/workspace/src/HLS/architecture_creation/controller_creation/control_flow_checker.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ControlFlowChecker()

◆ ~ControlFlowChecker()

Member Function Documentation

◆ add_clock_reset()

◆ add_common_ports()

◆ add_done_port()

◆ add_notifiers()

◆ add_present_state()

◆ add_start_port()

◆ ComputeHLSRelationships()

◆ InternalExec()

◆ IsOneHotFSM()