probes

Name

probes — Probe APIs usable both inside and outside Simics.

Synopsis

Python

import probes

Description

Importing this package does not enable the Simics probes framework. Pure probe types and formatting utilities are always available. Runtime queries return empty results until enable-probes installs a backend. Simics-specific runtime APIs are exposed only when imported inside Simics.

Synopsis

class probes.CellFormatter(
    max_lines=None,
    key_col_width=None,
    val_col_width=None,
    total_width=None,
    float_decimals=None,
    ignore_column_widths=False,
    value_column_properties=None,
    histogram_options=None
)

Description

Helper class for various format properties.

Helper Class for summary-probe formatting. Simply holds various formatting properties together, in one class object.

Synopsis

probes.get_all_probe_kinds()

Description

Gets all registered probe-kinds in the system.

Returns all registered probe-kinds in the system. The probe-kind is the unique probe identifier, not including the objects associated with it.

See Also

probes.get_probes, probes.get_all_probes

Synopsis

probes.get_all_probes()

Description

Gets all ProbeProxy instances.

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_kinds, probes.get_probes

Synopsis

probes.get_probe_by_object(kind, obj)

Description

Gets the ProbeProxy instance for an object .

Returns the ‘ProbeProxy’ Python object for a probe-kind in a specific conf object.

See Also

probes.get_all_probe_kinds, probes.get_probes

Synopsis

probes.get_probes(kind)

Description

Gets hold of all ProbeProxy instances implementing a specific probe-kind.

Returns the Python ‘ProbeProxy’ objects, for probes matching the specific probe-kind. 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_kinds, probes.get_all_probes

Synopsis

probes.is_singleton(obj)

Description

Check if the Simics object is a singleton object, currently only any of [sim, host]