![]() |
OTAWA
2.0
Framework to perform machine analysis and compute WCET.
|
#include <otawa/proc/ContextualProcessor.h>
Public Member Functions | |
ContextualProcessor (p::declare &_reg=reg) | |
![]() | |
CFGProcessor (AbstractRegistration ®) | |
Build a new CFG processor with the given registration information. More... | |
CFGProcessor (cstring name, const Version &version, AbstractRegistration ®) | |
CFGProcessor (cstring name, elm::Version version) | |
Build a new named processor. More... | |
CFGProcessor (void) | |
Build a new CFG processor. More... | |
![]() | |
virtual void * | interfaceFor (const AbstractFeature &feature) |
Get the interface corresponding to the given feature. More... | |
elm::String | name (void) const |
Processor (AbstractRegistration ®istration) | |
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 ®istration) | |
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) |
![]() | |
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 p::declare | reg |
![]() | |
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 Monitor & | null = __null_mon |
Monitor that output nothing. More... | |
Protected Member Functions | |
virtual void | processBB (WorkSpace *ws, CFG *cfg, Block *bb, const ContextualPath &path)=0 |
void | processCFG (WorkSpace *fw, CFG *cfg) override |
![]() | |
CFG * | cfg (void) const |
const CFGCollection & | cfgs (void) const |
virtual void | cleanupCFG (WorkSpace *ws, CFG *cfg) |
This function may be overridden by a subclass to provide custom cleanup for a CFG. More... | |
void | configure (const PropList &props) override |
Configure the current processor. 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... | |
virtual void | destroyCFG (WorkSpace *ws, CFG *cfg) |
Propagate the destroy phase to CFG resources. More... | |
void | doCleanUp (void) |
Trigger associated with CFG. More... | |
void | dump (WorkSpace *ws, Output &out) override |
Function called for debugging purpose when dump properties (otawa::DUMP, otawa::DUMP_FOR) are provided. More... | |
virtual void | dumpCFG (CFG *cfg, Output &out) |
The default implementation of CFGProcessor dump calls this function for each CFG of the program. More... | |
Block * | entry () const |
Block * | exit () const |
virtual void | processAll (WorkSpace *ws) |
This function is called once the CFG collection has been obtained. More... | |
void | processWorkSpace (WorkSpace *ws) override |
Process the given framework. More... | |
string | str (const Address &address) |
Transform an address to a smart string, that is, if a source line is available, transform it to "source_file:source_line", if the CFG has a label, it gives "label + 0xoffset", else return the address. More... | |
string | str (const Address &base, const Address &address) |
Transform an address to a smart string, that is, if a source line is available, transform it to "source_file:source_line", if the CFG has a label, it gives "label + 0xoffset", else return the address. More... | |
CFG * | taskCFG () const |
Block * | taskEntry () const |
![]() | |
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... | |
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 |
![]() | |
void | setWorkspace (WorkSpace *workspace) |
Update the workspace in the monitor. More... | |
Additional Inherited Members | |
![]() | |
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 |
![]() | |
elm::io::Output | log |
elm::io::Output | out |
![]() | |
PropList * | stats |
![]() | |
t::uint32 | flags |
![]() | |
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 const t::uint32 | CUSTOM_SHIFT = 16 |
static const t::uint32 | IS_QUIET = 0x02 |
static const t::uint32 | IS_VERBOSE = 0x01 |
A contextual processor allows to process blocks in a call-aware way even with a virtual CFG (where called CFG are inlined).
First, the basic blocks of the top are processed. When a virtual call is found, enteringCall() method is called and the basic blocks of the called CFG are processed until end of the call (leavingCall() is called at this moment). Then the traversal of the caller CFG restarts. Note that thus behaviour is recursive and that a call in the callee is processed in the same way.
This processor may be used to build ContextPath.
As an example is often better than any discussion, let three functions : function f basic block f1 basic block f2 calling h basic block f3 calling g function g basic block g1 basic block g2 calling h basic block g3 function h basic block h1
First the function f is traversed: enteringCall(f), processBB(f1) and processBB(f2). As f2 calls h, we get enteringCall(h), processBB(h1), leavingCall(h). We continue with f3: processBB(f3). And we process the call to g: enteringCall(g), processBB(g1) and processBB(g2). We call another time h: enteringCall(h), processBB(h1) and leavingCall(h). Finally, we leaving g then g: processBB(g3), leavingCall(g), leavingCall(f).
otawa::ContextualProcessor::ContextualProcessor | ( | p::declare & | _reg = reg | ) |
|
protectedpure virtual |
This method is called each time a basic block is found.
ws | Current workspace. |
cfg | Current top CFG. |
bb | Current basic block. |
path | Current context path. |
Implemented in otawa::ipet::FlowFactLoader.
Implements otawa::CFGProcessor.
|
static |