#include <otawa/cache/cat2/ACSBuilder.h>

Inheritance diagram for otawa::ACSBuilder:

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

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

virtual void	processWorkSpace (otawa::WorkSpace *)
	Process the given framework. More...

Public Member Functions inherited from otawa::Processor
virtual void *	interfaceFor (const AbstractFeature &feature)
	Get the interface corresponding to the given feature. More...

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

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

Private Member Functions
void	processLBlockSet (otawa::WorkSpace , LBlockSet , const hard::Cache *)

Private Attributes
fmlevel_t	level

Vector< MUSTProblem::Domain * > *	must_entry

Vector< PERSProblem::Domain * > *	pers_entry

bool	unrolling

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 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	cleanup (WorkSpace *ws)
	This method is called after the end of the processor analysis to let it do some clean up. More...

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	destroy (WorkSpace *ws)
	This method is called when the properties produced by a processor are no more useful and can be release. 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...

virtual void	setup (WorkSpace *ws)
	This method is called before an anlysis to let the processor do some initialization. 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...

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 builds the MUST and PERS cache states before each basic block. The MUST cache state lists the ID of cache blocks which must be in the cache and is useful to determine ALWAYS_HIT blocks. The PERS cache state lists the ID of cache blocks which may be in the cache, but cannot be replaced once they have been loaded. It is useful to determine the FIRST_MISS blocks.

The Persistence can be computed in 3 ways:

Outer: A block is FIRST_MISS if it can not be replaced within the whole program
Inner: A block is FIRST_MISS if it can not be replaced from the inner-most loop containing it.
Multi: The FIRST_MISS is parametrized by a variable L, representing the outer-most loop whose execution does not replace the block.

The analysis can be used with Pseudo-Unrolling: In this case, unroll (using FirstUnrollingFixPoint with HalfAbsInt) the first iteration of each loop during abstract interpretation. But the ACS corresponding to multiple iterations of a basic block are merged back into one ACS at the end of the analysis.

Configuration

FIRSTMISS_LEVEL identifier determines the First Miss method (FML_OUTER, FML_INNER, FML_MULTI, FML_NONE). FML_MULTI is the default.
PSEUDO_UNROLLING identifier determines if we do the Pseudo-Unrolling while doing the abstract interpretation.

Required features

Provided features

ICACHE_ACS_FEATURE

Statistics: none

This processor produces the Abstract Cache States (ACS), for the May and Persistence problems.

Configuration: none

Required features

Provided features

ICACHE_FIRSTLAST_FEATURE

Statistics: none

Constructor & Destructor Documentation

◆ ACSBuilder()

otawa::dcache::ACSBuilder::ACSBuilder ( p::declare & r = reg )

Member Function Documentation

◆ configure()

void otawa::dcache::ACSBuilder::configure ( const PropList & props )

virtual

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

Parameters

props Configuration information.

Reimplemented from otawa::Processor.

References otawa::CACHE_ACS_MUST_ENTRY, otawa::CACHE_ACS_PERS, otawa::Processor::configure(), otawa::FIRSTMISS_LEVEL, level, must_entry, pers_entry, otawa::PSEUDO_UNROLLING, and unrolling.

◆ processLBlockSet()

void otawa::ACSBuilder::processLBlockSet	(	otawa::WorkSpace *	fw,
		LBlockSet *	lbset,
		const hard::Cache *	cache
	)

private

References otawa::cache::LBlockSet::cacheBlockCount(), cout, otawa::FML_NONE, level, otawa::cache::LBlockSet::line(), must_entry, otawa::dfa::hai::HalfAbsInt< FixPoint >::solve(), unrolling, and otawa::hard::Cache::wayCount().

◆ processWorkSpace()

void otawa::dcache::ACSBuilder::processWorkSpace ( otawa::WorkSpace * fw )

virtual

Process the given framework.

Parameters

fw	Framework to process.

Deprecated:: Use processWorkSpace() instead.

Reimplemented from otawa::Processor.

References endl, otawa::FIRSTMISS_LEVEL, level, otawa::Monitor::log, otawa::Monitor::LOG_FUN, otawa::Monitor::logFor(), must_entry, pers_entry, and unrolling.

Member Data Documentation

◆ level

fmlevel_t otawa::ACSBuilder::level

private

Referenced by configure(), processLBlockSet(), and processWorkSpace().

◆ must_entry

Vector<MUSTProblem::Domain *>* otawa::ACSBuilder::must_entry

private

Referenced by configure(), processLBlockSet(), and processWorkSpace().

◆ pers_entry

Vector<PERSProblem::Domain *>* otawa::ACSBuilder::pers_entry

private

Referenced by configure(), and processWorkSpace().

◆ reg

p::declare otawa::dcache::ACSBuilder::reg

static

Initial value:

= p::init("otawa::ACSBuilder", Version(1, 1, 0))
        .base(Processor::reg)
        .maker<ACSBuilder>()
        .require(DOMINANCE_FEATURE)
        .require(LOOP_HEADERS_FEATURE)
        .require(LOOP_INFO_FEATURE)
        .require(cache::COLLECTED_LBLOCKS_FEATURE)
        .require(ICACHE_FIRSTLAST_FEATURE)
        .provide(ICACHE_ACS_FEATURE)
        .require(hard::CACHE_CONFIGURATION_FEATURE)

◆ unrolling

bool otawa::ACSBuilder::unrolling

private

Referenced by configure(), processLBlockSet(), and processWorkSpace().

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

include/otawa/cache/cat2/ACSBuilder.h
src/prog/cache_ACSBuilder.cpp
src/dcache/dcache_ACSBuilder.cpp

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ACSBuilder()

Member Function Documentation

◆ configure()

◆ processLBlockSet()

◆ processWorkSpace()

Member Data Documentation

◆ level

◆ must_entry

◆ pers_entry

◆ reg

◆ unrolling