#include <otawa/cfg/CFGCollector.h>

Inheritance diagram for otawa::CFGCollector:

Public Member Functions
	CFGCollector (p::declare &r=reg)

void	configure (const PropList &props) override
	This method may be called for configuring a processor thanks to information passed in the property list. More...

void *	interfaceFor (const AbstractFeature &f) override
	Get the interface corresponding to the given feature. More...

Public Member Functions inherited from otawa::AbstractCFGBuilder
	AbstractCFGBuilder (p::declare &r)

Public Member Functions inherited from otawa::Processor
elm::String	name (void) const

	Processor (AbstractRegistration &registration)
	For internal use only. More...

	Processor (const PropList &props)
	Build a new processor. More...

	Processor (elm::String name, elm::Version version, const PropList &props)
	Build a new processor with name and version. More...

	Processor (String name, Version version)
	Build a new processor with name and version. More...

	Processor (String name, Version version, AbstractRegistration &registration)
	For internal use only. More...

	Processor (void)
	Build a simple anonymous processor. More...

AbstractRegistration &	registration (void) const

elm::Version	version (void) const

virtual	~Processor (void)

Public Member Functions inherited from otawa::Monitor
void	configure (const PropList &props, string name="")

bool	isQuiet () const

bool	isVerbose () const

bool	logFor (log_level_t tested) const

log_level_t	logLevel (void) const

	Monitor ()

	Monitor (Monitor &mon)
	Build a monitor by copy. More...

WorkSpace *	workspace (void)

	~Monitor ()

Static Public Attributes
static p::declare	reg
	CFGCollector registration. More...

Static Public Attributes inherited from otawa::Processor
static p::id< bool >	COLLECT_STATS
	This property allows to activate collection of statistics for the work of the current processor. More...

static p::id< elm::io::OutStream * > &	LOG = otawa::LOG
	This property identifier is used for setting the log stream used by the processor to write messages (information, warning, error). More...

static p::id< string > &	LOG_FOR = otawa::LOG_FOR
	Logging message will only be displayed for the named processor. More...

static p::id< log_level_t > &	LOG_LEVEL = otawa::LOG_LEVEL
	Property passed in the configuration property list of a processor to select the log level between LOG_PROC, LOG_CFG or LOG_BB. More...

static Processor &	null = _null
	Singleton representing a null processor. More...

static p::id< elm::io::OutStream * > &	OUTPUT = otawa::OUTPUT
	This property identifier is used for setting the output stream used by the processor to write results. More...

static p::id< Progress * >	PROGRESS
	Record a progress listener for the execution of the processors. More...

static p::id< bool >	RECURSIVE

static p::declare	reg

static p::id< elm::sys::time_t >	RUNTIME
	This property identifier is used to store in the statistics of a processor the overall run time of the processor work. More...

static p::id< PropList * >	STATS
	This property identifiers is used to pass a property list to the processor that will be used to store statistics about the performed work. More...

static p::id< bool >	TIMED
	If the value of the associated property is true (default to false), time statistics will also be collected with other processor statistics. More...

static p::id< bool > &	VERBOSE = otawa::VERBOSE
	This property activates the verbose mode of the processor: information about the processor work will be displayed. More...

Static Public Attributes inherited from otawa::Monitor
static Monitor &	null = __null_mon
	Monitor that output nothing. More...

Protected Member Functions
void	cleanup (WorkSpace *ws) override
	This method is called after the end of the processor analysis to let it do some clean up. More...

void	destroy (WorkSpace *ws) override
	This method is called when the properties produced by a processor are no more useful and can be release. More...

void	setup (WorkSpace *ws) override
	This method is called before an anlysis to let the processor do some initialization. More...

Protected Member Functions inherited from otawa::AbstractCFGBuilder
CFGMaker &	maker (Inst *i)
	Get maker for the given instruction as function entry. More...

void	processWorkSpace (WorkSpace *ws)
	Process the given framework. More...

Protected Member Functions inherited from otawa::Processor
void	addCleaner (const AbstractFeature &feature, Cleaner *cleaner)

template<class T >
void	addDeletor (const AbstractFeature &feature, const Ref< T , Identifier< T > > &ref)

template<class T >
void	addRemover (const AbstractFeature &feature, const Ref< T, Identifier< T > > &ref)

virtual void	collectStats (WorkSpace *ws)
	This method is invoked if the user has required to collect statistics about the processor. More...

virtual void	commit (WorkSpace *ws)
	This processor is called as soon as all the required and invalidated features has been removed to let the processor install its own properties. More...

virtual void	dump (WorkSpace *ws, Output &out)
	Function called for debugging purpose when dump properties (otawa::DUMP, otawa::DUMP_FOR) are provided. More...

void	invalidate (const AbstractFeature &feature)
	Usually called from a processor constructor, this method records a feature invalidated by the work of the current processor. More...

bool	isAllocated (void) const

bool	isCollectingStats (void) const

bool	isDone () const

bool	isDumping () const

bool	isPrepared (void) const

bool	isTimed (void) const

virtual void	prepare (WorkSpace *ws)
	This method called to let the processor customize its requirements according to some generic feature. More...

Progress &	progress (void)

void	provide (const AbstractFeature &feature)
	Usually called from a processor constructor, this method records a feature provided by the work of the current processor. More...

void	record (StatCollector *collector)
	Add a statistics collector to the current workspace collection. More...

bool	recordsStats (void) const

void	recordStat (const AbstractFeature &feature, StatCollector *collector)
	Add a statistics collector to the current workspace collection. More...

void	require (const AbstractFeature &feature)
	Usually called from a processor constructor, this method records a required feature for the work of the current processor. More...

virtual void	requireDyn (WorkSpace *ws, const PropList &props)
	Method called after registration requirements to support dynamic requirements. More...

void	track (Cleaner *cleaner)
	Track the given cleaner, that is, record the cleaner in the analysis and trigger when the analysis is deleted. More...

template<class T >
void	track (const AbstractFeature &feature, const Ref< T , const Identifier< T > > &ref)

template<class T >
void	track (const AbstractFeature &feature, const Ref< T , Identifier< T > > &ref)

template<class T >
void	track (const AbstractFeature &feature, const Ref< T, const Identifier< T > > &ref)

template<class T >
void	track (const AbstractFeature &feature, const Ref< T, Identifier< T > > &ref)

template<class T >
T *	track (const AbstractFeature &feature, T *object)

template<class T >
void	track (const Ref< T , const Identifier< T > > &ref)

template<class T >
void	track (const Ref< T, const Identifier< T > > &ref)

template<class T >
T *	track (T *object)

void	use (const AbstractFeature &feature)
	Usually called from a processor constructor, this method records a feature as used by the work of the current processor. More...

void	warn (const String &message)
	Display a warning. More...

WorkSpace *	workspace (void) const

Protected Member Functions inherited from otawa::Monitor
void	setWorkspace (WorkSpace *workspace)
	Update the workspace in the monitor. More...

Private Attributes
Vector< Address >	added_cfgs

Vector< string >	added_funs

CFGCollection *	coll

Additional Inherited Members
Public Types inherited from otawa::Monitor
enum	log_level_t { LOG_NONE = 0, LOG_PROC = 1, LOG_FILE = 2, LOG_DEPS = LOG_FILE, LOG_FUN = 3, LOG_CFG = LOG_FUN, LOG_BLOCK = 4, LOG_BB = LOG_BLOCK, LOG_INST = 5 }

typedef enum otawa::Monitor::log_level_t	log_level_t

Public Attributes inherited from otawa::Monitor
elm::io::Output	log

elm::io::Output	out

Protected Attributes inherited from otawa::Processor
PropList *	stats

Protected Attributes inherited from otawa::Monitor
t::uint32	flags

Static Protected Attributes inherited from otawa::Processor
static const t::uint32	CLOSE_DUMP = 0x100 << CUSTOM_SHIFT

static const t::uint32	IS_ALLOCATED = 0x004 << CUSTOM_SHIFT

static const t::uint32	IS_COLLECTING = 0x010 << CUSTOM_SHIFT

static const t::uint32	IS_DONE = 0x040 << CUSTOM_SHIFT

static const t::uint32	IS_DUMPING = 0x080 << CUSTOM_SHIFT

static const t::uint32	IS_PREPARED = 0x008 << CUSTOM_SHIFT

static const t::uint32	IS_TIED = 0x020 << CUSTOM_SHIFT

static const t::uint32	IS_TIMED = 0x001 << CUSTOM_SHIFT

Static Protected Attributes inherited from otawa::Monitor
static const t::uint32	CUSTOM_SHIFT = 16

static const t::uint32	IS_QUIET = 0x02

static const t::uint32	IS_VERBOSE = 0x01

Detailed Description

This processor is used to collect all CFG implied in a computation. It uses the otawa::ENTRY_CFG or otawa::TASK_ENTRY properties to find the base CFG and explore in depth the CFG along subprograms calls.

Configuration

ENTRY_CFG – CFG of the entry of the current task,
TASK_ENTRY – name if the entry function of the current task,
CFGCollector::ADDED_CFG – CFG to add to the collection.
CFGCollector::ADDED_FUNCTION – function name to add to the collection.

Note: otawa::ENTRY_CFG is first looked on the WorkSpace and then in the configuration properties.

Provided Features: COLLECTED_CFG_FEATURE

Constructor & Destructor Documentation

◆ CFGCollector()

otawa::CFGCollector::CFGCollector ( p::declare & r = reg )

Member Function Documentation

◆ cleanup()

void otawa::CFGCollector::cleanup ( WorkSpace * ws )

overrideprotectedvirtual

This method is called after the end of the processor analysis to let it do some clean up.

Some data such as Identifiers set in in the processor analysis may still be used in the later analysis. Please refer to elm::addCleaner() to clean the such data when the feature provided by the processor analysis is removed/invalidated.

Parameters

ws	Workspace to work on.

Reimplemented from otawa::AbstractCFGBuilder.

References otawa::CFGCollection::add(), otawa::AbstractCFGBuilder::cleanup(), coll, otawa::CFGCollection::entry(), otawa::ENTRY_CFG, otawa::INVOLVED_CFGS, otawa::WorkSpace::name(), otawa::CFG::name(), and otawa::Processor::ws.

◆ configure()

void otawa::CFGCollector::configure ( const PropList & props )

overridevirtual

This method may be called for configuring a processor thanks to information passed in the property list.

Parameters

props Configuration information.

Reimplemented from otawa::AbstractCFGBuilder.

References elm::Vector< class, class, class >::add(), Vector< string >::add(), added_cfgs, added_funs, otawa::AbstractCFGBuilder::configure(), otawa::Address::isNull(), otawa::Processor::name(), otawa::TASK_ADDRESS, and otawa::TASK_ENTRY.

◆ destroy()

void otawa::CFGCollector::destroy ( WorkSpace * ws )

overrideprotectedvirtual

This method is called when the properties produced by a processor are no more useful and can be release.

This happens (a) when the workspace is release or (b) the features provided by the processor are invalidated.

The processor has to retain the properties of the provided features until this function is called.

The default implementation activates the clean list.

Reimplemented from otawa::Processor.

References coll, otawa::ENTRY_CFG, otawa::INVOLVED_CFGS, and otawa::Processor::ws.

◆ interfaceFor()

void * otawa::CFGCollector::interfaceFor ( const AbstractFeature & feature )

overridevirtual

Get the interface corresponding to the given feature.

The feature can only be part of the processor provided feature. This function can only be called once the processor has been executed.

Parameters

feature Feature of the looked interface.

Returns: Null pointer or interface corresponding to the feature.

Reimplemented from otawa::Processor.

References coll.

◆ setup()

void otawa::CFGCollector::setup ( WorkSpace * ws )

overrideprotectedvirtual

This method is called before an anlysis to let the processor do some initialization.

Parameters

ws	Processed workspace.

Reimplemented from otawa::AbstractCFGBuilder.

References _, added_cfgs, added_funs, Vector< string >::count(), elm::Vector< class, class, class >::count(), otawa::WorkSpace::findInstAt(), otawa::File::findLabel(), otawa::Address::isNull(), otawa::AbstractCFGBuilder::maker(), otawa::WorkSpace::process(), otawa::Process::program(), otawa::AbstractCFGBuilder::setup(), and otawa::Processor::ws.

Member Data Documentation

◆ added_cfgs

Vector<Address> otawa::CFGCollector::added_cfgs

private

Referenced by configure(), and setup().

◆ added_funs

Vector<string> otawa::CFGCollector::added_funs

private

Referenced by configure(), and setup().

◆ coll

CFGCollection* otawa::CFGCollector::coll

private

Referenced by cleanup(), destroy(), and interfaceFor().

◆ reg

p::declare otawa::CFGCollector::reg

static

Initial value:

= p::init("otawa::CFGCollector", Version(2, 1, 0))
        .require(FLOW_FACTS_FEATURE)
        .require(LABEL_FEATURE)
        .require(view::FEATURE)
        .provide(COLLECTED_CFG_FEATURE)
        .maker<CFGCollector>()

CFGCollector registration.

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

include/otawa/cfg/CFGCollector.h
src/prog/cfg_CFGCollector.cpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CFGCollector()

Member Function Documentation

◆ cleanup()

◆ configure()

◆ destroy()

◆ interfaceFor()

◆ setup()

Member Data Documentation

◆ added_cfgs

◆ added_funs

◆ coll

◆ reg