osa_mapper_control osa_micro_checkpoint
API Reference Manual  /  7 Simulator-to-Simulator Interfaces  / 

osa_mapper_query

Description

The optional get_process_list function provides data for the 'list' command. It should return a two-element list, where the first element is a list of column headers, and the second element is a list of (row, subtable) two-element lists. All rows should have the same number of elements as the header list (this is the number of columns in the resulting table).

The elements of the header list and row lists---that is, the individual elements in the table---should be of type string or integer. Integers will be formatted by the system, so in order to force a specific base, such as decimal or hexadecimal, convert them to strings.

The subtables paired with each row should either be None (meaning no subtable) or a nested list such as that returned by get_process_list(), in which case that list will be printed, slightly indented, below the row. This makes it possible for the list command to handle stacked trackers. An example of how a complete return value from get_process_list function can look like:

[["Process", "Pid"], [[["ls", 1], None], [["cat", 2], None]]]

If the function is not implemented, the function pointer should be set to NIL.

The optional get_mapper function returns the mapper that is responsible for the given node. A mapper that has guest mappers should forward the request to the guests as well if the node belongs to one of the guests. If the function is not implemented by the mapper, it is assumed that the node is owned by the mapper.

If this function is not implemented, the function pointer should be set to NIL. Stacked trackers, which support guest trackers must implement this function.

SIM_INTERFACE(osa_mapper_query) {
        attr_value_t (*get_process_list)(conf_object_t *NOTNULL obj);
        conf_object_t *(*get_mapper)(conf_object_t *NOTNULL obj,
                                     node_id_t node_id);
};
#define OSA_MAPPER_QUERY_INTERFACE "osa_mapper_query"

Execution Context
Global Context for all methods.

osa_mapper_control osa_micro_checkpoint