The probes Python package allows convenient methods for accessing
all probes which has been registered in Simics.
When probes are enabled with the enable-probes command the probe
framework will create Python ProbeProxy objects for all existing
probes in the system. Any additional created objects with probes will
also automatically get ProbeProxy objects.
- NAME
-
CellFormatter — helper object for various format properties
- DESCRIPTION
-
Helper Class for summary-probe formatting. Simply holds various
formatting properties together, in one class object.
- NAME
-
ProbeProxy — wrapper class of probes that exists in Simics
- DESCRIPTION
-
The ProbeProxy class represents a Python object for the detected
probes in the system. The object wrapping allows easier access
to the probe objects through the different probe interfaces.
Object implementing the indexed probe interface, will get a
dedicated ProbeProxy object per index.
The formatting of the different types of probes are also
automatically handled by this class.
- NAME
-
get_all_probe_names — get all registered probe names in the system
- SYNOPSIS
-
get_all_probe_names(internals=False)
- DESCRIPTION
-
Returns all registered probe names in the system. The probe name is
the unique probe identifier, not including the objects associated
with it. If the internals argument is True, the list also includes
internal probes.
- SEE ALSO
-
probes.get_probes, probes.get_all_probes
- NAME
-
get_all_probes — get all ProbeProxy instances
- SYNOPSIS
-
get_all_probes()
- DESCRIPTION
-
Returns all Python 'ProbeProxy' objects that exists currently.
These objects can be used to access the probe interfaces in a
convenient way by using methods in them.
- SEE ALSO
-
probes.get_all_probe_names, probes.get_probes
- NAME
-
get_probe_by_object — get the ProbeProxy instance for an object
- SYNOPSIS
-
get_probe_by_object(name, obj)
- DESCRIPTION
-
Returns the 'ProbeProxy' Python object for a probe name in a
specific conf object.
- SEE ALSO
-
probes.get_all_probe_names, probes.get_probes
- NAME
-
get_probes — get hold of all ProbeProxy instances implementing a specific probe name
- SYNOPSIS
-
get_probes(name)
- DESCRIPTION
-
Returns the Python 'ProbeProxy' objects, for probes matching the specific
probe-name.
These objects can be used to access the probe interfaces in a
convenient way by using methods in them.
- SEE ALSO
-
probes.get_all_probe_names, probes.get_all_probes
- NAME
-
register_probe_delete_cb — request a callback when a probe is deleted
- SYNOPSIS
-
register_probe_delete_cb(cb)
- DESCRIPTION
-
Register a function which will be called when a probe is deleted from
the system. The function only takes a single argument; the ProbeProxy
instances that is about to be deleted.
- SEE ALSO
-
probes.unregister_probe_delete_cb
- NAME
-
unregister_probe_delete_cb — cancel a callback for probe deletion
- SYNOPSIS
-
unregister_probe_delete_cb(cb)
- DESCRIPTION
-
Unregister a function callback when probes are deleted.
Typically needed when a python module itself is removed.
- SEE ALSO
-
probes.register_probe_delete_cb