reven.api.Trace : API documentation

A trace is the list of all executed sequences. The Trace concept wraps the Run concepts used in axion and the low-level API.

Cache: If the execution was resumed since the creation of a Trace instance, then this instance is outdated. Create a new one from a Project instance that has been refreshed using Project.refresh.

def __init__(self, project, run):

Raises	reven_api.ServiceNotAllowedDuringExecutionError	If this method is called during the execution.
	RuntimeError	If the connection is lost, in case of bad input, or in case of internal service error.

@property
def _rvn(self):

Undocumented

def _cache_sequence(self, sid):

Return the sequence of index sid from the cache or cache it before.

Parameters	sid	Index of the sequence in this trace.
Raises	reven_api.ServiceNotAllowedDuringExecutionError	If this method is called during the execution.
	RuntimeError	If the connection is lost, in case of bad input, or in case of internal service error.

@property
def name(self):

Property: The trace name.

@property
def sequence_count(self):

Property: The count of executed basic blocks.

def sequence_length(self, sequence):

The number of instructions in a given executed basic block.

Parameters	sequence	The sequence index.
Raises	ValueError	if the sequence index is negative or greater than `Trace.sequence_count`.

def search_point(self, criterions, begin_point=None, end_point=None, conjunction=True, step_max_results=500, step_max_sequences=1000000):

Search for points matching the given criteria.

Due to limitations in the current search engine, the returned results are the first points of a sequence in which at least one point matches the criteria. The precise points matching the criteria inside the sequence are lost.

Even if several points match in a sequence, the sequence is returned only once.

Parameters	criterions	A list of `Criterion` objects used to match a point.
	begin_point	The search range lower bound. If None (default), will start at the beginning of the trace.
	end_point	The search range upper bound. If None (default), will stop at the end of the trace.
	conjunction	Whether multiple criteria should be applied in conjunction (logical and) or disjunction (logical or). By default, use conjunction.
	step_max_results	The maximum amount of results to cache before yielding. Tweak for response time adjustement.
	step_max_sequences	The maximum amount of sequences to search before yielding. Tweak for response time adjustement.
Returns	a generator of points of index 0 in matching sequences.
Raises	reven_api.ServiceNotAllowedDuringExecutionError	If this method is called during the execution.
	RuntimeError	If the connection is lost, in case of bad input, or in case of internal service error.

def search_symbol(self, name, is_regex=False, is_called=False, is_renamed=False, step_max_results=1000):

Search for symbols.

Parameters	name	The symbol name.
	is_regex	Whether or not to consider `name` as a regular expression.
	is_called	Whether or not to restrict search to called symbols.
	is_renamed	Whether or not to restrict search to renamed symbols.
	step_max_results	The maximum amount of results to cache before yielding. Tweak for response time adjustement.
Returns	A generator of symbols matching the given criteria.
Raises	reven_api.ServiceNotAllowedDuringExecutionError	If this method is called during the execution.
	RuntimeError	If the connection is lost, in case of bad input, or in case of internal service error.

def point(self, sequence, instruction=0):

Get the point at the specified sequence and instruction indexes.

Parameters	sequence	The sequence index.
	instruction	The instruction index, 0 (first instruction) by default.

def __iter__(self):

Undocumented

def __repr__(self):

Undocumented

Class	PointIterator	Iterator allowing to iterate over trace points.
Method	__init__
Method	name	Property: The trace name.
Method	sequence_count	Property: The count of executed basic blocks.
Method	sequence_length	The number of instructions in a given executed basic block.
Method	search_point	Search for points matching the given criteria.
Method	search_symbol	Search for symbols.
Method	point	Get the point at the specified sequence and instruction indexes.
Method	__iter__	Undocumented
Method	__repr__	Undocumented
Method	_rvn	Undocumented
Method	_cache_sequence	Return the sequence of index sid from the cache or cache it before.

reven.api.Trace(object) class documentation

`reven.api.Trace(object)` class documentation