The class of Instruction-Level Abstraction (ILA). An ILA contains: More...

#include <instr_lvl_abs.h>

Inheritance diagram for ilang::InstrLvlAbs:

Public Types
typedef std::shared_ptr < InstrLvlAbs >	InstrLvlAbsPtr
	Pointer type for normal use of InstrLvlAbs.

typedef std::shared_ptr< const InstrLvlAbs >	InstrLvlAbsCnstPtr
	Pointer type for read-only usage of InstrLvlAbs.

typedef KeyVec< Symbol, InstrLvlAbsPtr >	InstrLvlAbsMap
	Type for storing a set of ILA (child-ILAs).

Public Types inherited from ilang::Object
typedef std::shared_ptr< Object >	ObjPtr
	Pointer type for normal use of Object.

Public Member Functions
	InstrLvlAbs (const std::string &name="", const InstrLvlAbsPtr &parent=nullptr)
	Consturctor.

	~InstrLvlAbs ()
	Default destructor.

bool	is_instr_lvl_abs () const
	Return true if is InstrLvlAbs.

bool	is_spec () const
	Return true if is specification (not implementation).

const InstrLvlAbsPtr	parent () const
	Return the parent ILA.

const ExprMngrPtr	expr_mngr () const
	Return the ast simplifier.

void	set_spec (bool spec)
	Set the ILA to be specification if true.

void	set_expr_mngr (const ExprMngrPtr expr_mngr)
	Update the ast simplifier.

size_t	input_num () const
	Return the number of input variables.

size_t	state_num () const
	Return the number of state variables.

size_t	instr_num () const
	Return the number of instructions.

size_t	child_num () const
	Return the number of child-ILAs.

size_t	init_num () const
	Return the number of initial condition.

const ExprPtr	fetch () const
	Return the fetch function.

const ExprPtr	valid () const
	Return the valid function.

const ExprPtr	input (const size_t &i) const
	Access the i-th input variable.

const ExprPtr	state (const size_t &i) const
	Access the i-th state variable.

const InstrPtr	instr (const size_t &i) const
	Access the i-th instruction.

const InstrLvlAbsPtr	child (const size_t &i) const
	Access the i-th child-ILA.

const ExprPtr	init (const size_t &i) const
	Access the i-th initial condition.

const ExprPtr	input (const std::string &name) const
	Return the named input variable; return NULL if not registered.

const ExprPtr	state (const std::string &name) const
	Return the named state variable; return NULL if not registered.

const InstrPtr	instr (const std::string &name) const
	Return the named instruction; return NULL if not registered.

const InstrLvlAbsPtr	child (const std::string &name) const
	Return the named child-ILA; return NULL if not registered.

const ExprPtr	find_input (const Symbol &name) const
	Return the named input variable; return NULL if not registered.

const ExprPtr	find_state (const Symbol &name) const
	Return the named state variable; return NULL if not registered.

const InstrPtr	find_instr (const Symbol &name) const
	Return the named instruction; return NULL if not registered.

const InstrLvlAbsPtr	find_child (const Symbol &name) const
	Return the named child-ILA; return NULL if not registered.

const InstrSeqPtr &	instr_seq () const

void	AddInput (const ExprPtr &input_var)
	Add one input variable to the ILA, and register to the simplifier. More...

void	AddState (const ExprPtr &state_var)
	Add one state variable to the ILA, and register to the simplifier. More...

void	AddInit (const ExprPtr &cntr_expr)
	Add one constraint to the initial condition, i.e. no contraint means arbitrary initial values to the state variables. More...

void	SetFetch (const ExprPtr &fetch_expr)
	Set the fetch function, and simplify (if needed) by the simplifier. More...

void	SetValid (const ExprPtr &valid_expr)
	Set the valid function, and simplify (if needed) by the simplifier. More...

void	AddInstr (const InstrPtr &instr)
	Add one instruction to the ILA, and simplify (if needed). Note that only fully constructed instruction can be added. More...

void	AddChild (const InstrLvlAbsPtr &child)
	Add one ILA to the child list. No simplification between ILAs. More...

const ExprPtr	NewBoolInput (const std::string &name)
	Create one Boolean variable and register as an input. More...

const ExprPtr	NewBvInput (const std::string &name, const int &bit_width)
	Create one Bitvector variable and register as an input. More...

const ExprPtr	NewMemInput (const std::string &name, const int &addr_width, const int &data_width)
	Create one Memory variable and register as an input. More...

const ExprPtr	NewBoolState (const std::string &name)
	Create one Boolean variable and register as a state. More...

const ExprPtr	NewBvState (const std::string &name, const int &bit_width)
	Create one Bitvector variable and register as a state. More...

const ExprPtr	NewMemState (const std::string &name, const int &addr_width, const int &data_width)
	Create one Memory variable and register as a state. More...

const ExprPtr	NewBoolFreeVar (const std::string &name)
	Create one free Boolean variable. More...

const ExprPtr	NewBvFreeVar (const std::string &name, const int &bit_width)
	Create one free bit-vector variable. More...

const ExprPtr	NewMemFreeVar (const std::string &name, const int &addr_width, const int &data_width)
	Create one free Memory variable. More...

const InstrPtr	NewInstr (const std::string &name="")
	Create and register one instruction. More...

const InstrLvlAbsPtr	NewChild (const std::string &name)
	Create and register one child-ILA. More...

void	ForceSetFetch (const ExprPtr &fetch_expr)
	Set the fetch function no matter if is already set. More...

void	ForceSetValid (const ExprPtr &valid_expr)
	Set the valid function no matter if is already set. More...

void	AddSeqTran (const InstrPtr &src, const InstrPtr &dst, const ExprPtr &cnd)
	Define instruction sequencing by adding a transition edge. More...

std::string	GetRootName () const
	Return the ancestor names in sequence.

std::ostream &	Print (std::ostream &out) const
	Output stream function.

template<class F >
void	DepthFirstVisit (F &func) const
	Templated visitor: visit each child-ILA in a depth-first order.

template<class F >
void	DepthFirstVisitPrePost (F &func) const
	Templated visitor: visit each child-ILA in a depth-first order and apply the function object F pre/pose on it.

Public Member Functions inherited from ilang::Object
	Object ()
	Default constructor.

	Object (const std::string &name)
	Constructor with string name.

virtual	~Object ()
	Default destructor.

const Symbol &	name () const
	Get the symbol (name).

virtual bool	is_instr () const
	Is type Instr.

virtual bool	is_ast () const
	Is type Ast.

Static Public Member Functions
static InstrLvlAbsPtr	New (const std::string &name, const InstrLvlAbsPtr &parent=nullptr)
	Create a new ILA (InstrLvlAbs) with the name. Used for hiding implementation specific type details.

Friends
class	Instr

std::ostream &	operator<< (std::ostream &out, InstrLvlAbs &ila)
	Overload output stream for object.

std::ostream &	operator<< (std::ostream &out, InstrLvlAbsPtr ila)
	Overload output stream for pointer.

std::ostream &	operator<< (std::ostream &out, InstrLvlAbsCnstPtr ila)
	Overload output stream for pointer.

Detailed Description

The class of Instruction-Level Abstraction (ILA). An ILA contains:

a set of state variables
a set of input variables
the set constraints for initial conditiona
the valid function
the fetch function
the set of instructions
1. the decode function
2. a set of update functions
the set of child-ILAs
the child-instruction sequencing (if not parent)

Member Function Documentation

void ilang::InstrLvlAbs::AddChild ( const InstrLvlAbsPtr & child )

Add one ILA to the child list. No simplification between ILAs.

Parameters

[in] child pointer to the child-ILA being added.

void ilang::InstrLvlAbs::AddInit ( const ExprPtr & cntr_expr )

Add one constraint to the initial condition, i.e. no contraint means arbitrary initial values to the state variables.

Parameters

[in] cntr_expr pointer to the constraint being added.

void ilang::InstrLvlAbs::AddInput ( const ExprPtr & input_var )

Add one input variable to the ILA, and register to the simplifier.

Parameters

[in] input_var pointer to the input variable being added.

void ilang::InstrLvlAbs::AddInstr ( const InstrPtr & instr )

Add one instruction to the ILA, and simplify (if needed). Note that only fully constructed instruction can be added.

Parameters

[in] instr pointer to the instruction being added.

void ilang::InstrLvlAbs::AddSeqTran	(	const InstrPtr &	src,
		const InstrPtr &	dst,
		const ExprPtr &	cnd
	)

Define instruction sequencing by adding a transition edge.

Parameters

[in]	src	source instruction
[in]	dst	target instruction (destination)
[in]	cnd	transition condition (guard), i.e. dst.DECODE

void ilang::InstrLvlAbs::AddState ( const ExprPtr & state_var )

Add one state variable to the ILA, and register to the simplifier.

Parameters

[in] state_var pointer to the state variable being added.

void ilang::InstrLvlAbs::ForceSetFetch ( const ExprPtr & fetch_expr )

Set the fetch function no matter if is already set.

Parameters

[in] fetch_expr pointer to the fetch function (as an expression).

void ilang::InstrLvlAbs::ForceSetValid ( const ExprPtr & valid_expr )

Set the valid function no matter if is already set.

Parameters

[in] valid_expr pointer to the valid function (as an expression).

const ExprPtr ilang::InstrLvlAbs::NewBoolFreeVar ( const std::string & name )

Create one free Boolean variable.

Parameters

[in] name of the Boolean variable.

Returns: pointer to the variable.

const ExprPtr ilang::InstrLvlAbs::NewBoolInput ( const std::string & name )

Create one Boolean variable and register as an input.

Parameters

[in] name of the bool input.

Returns: pointer to the input.

const ExprPtr ilang::InstrLvlAbs::NewBoolState ( const std::string & name )

Create one Boolean variable and register as a state.

Parameters

[in] name of the bool state.

Returns: pointer to the state variable.

const ExprPtr ilang::InstrLvlAbs::NewBvFreeVar	(	const std::string &	name,
		const int &	bit_width
	)

Create one free bit-vector variable.

Parameters

[in]	name	of the bit-vector variable.
[in]	bit_width	length of the bit-vector variable.

Returns: pointer to the variable.

const ExprPtr ilang::InstrLvlAbs::NewBvInput	(	const std::string &	name,
		const int &	bit_width
	)

Create one Bitvector variable and register as an input.

Parameters

[in]	name	of the bitvector input.
[in]	bit_width	length of the bitvector variable.

Returns: pointer to the input.

const ExprPtr ilang::InstrLvlAbs::NewBvState	(	const std::string &	name,
		const int &	bit_width
	)

Create one Bitvector variable and register as a state.

Parameters

[in]	name	of the bitvector state.
[in]	bit_width	value bit-width.

Returns: pointer to the state variable.

const InstrLvlAbsPtr ilang::InstrLvlAbs::NewChild ( const std::string & name )

Create and register one child-ILA.

Parameters

[in] name of the child.

Returns: pointer to the child-ILA.

const InstrPtr ilang::InstrLvlAbs::NewInstr ( const std::string & name = "" )

Create and register one instruction.

Parameters

[in] name of the instruction.

Returns: pointer to the instruction.

const ExprPtr ilang::InstrLvlAbs::NewMemFreeVar	(	const std::string &	name,
		const int &	addr_width,
		const int &	data_width
	)

Create one free Memory variable.

Parameters

[in]	name	of the memory variable.
[in]	addr_width	address bit-width.
[in]	data_width	data bit-width.

Returns: pointer to the variable.

const ExprPtr ilang::InstrLvlAbs::NewMemInput	(	const std::string &	name,
		const int &	addr_width,
		const int &	data_width
	)

Create one Memory variable and register as an input.

Parameters

[in]	name	of the memory input
[in]	addr_width	address bit-width.
[in]	data_width	data bit-width.

Returns: pointer to the memory state.

const ExprPtr ilang::InstrLvlAbs::NewMemState	(	const std::string &	name,
		const int &	addr_width,
		const int &	data_width
	)

Create one Memory variable and register as a state.

Parameters

[in]	name	of the memory state.
[in]	addr_width	address bit-width.
[in]	data_width	data bit-width.

Returns: pointer to the memory state.

void ilang::InstrLvlAbs::SetFetch ( const ExprPtr & fetch_expr )

Set the fetch function, and simplify (if needed) by the simplifier.

Parameters

[in] fetch_expr pointer to the fetch function (as an expression).

void ilang::InstrLvlAbs::SetValid ( const ExprPtr & valid_expr )

Set the valid function, and simplify (if needed) by the simplifier.

Parameters

[in] valid_expr pointer to the valid function (as an expression).

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

instr_lvl_abs.h

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Function Documentation