PK_DEBUG_SESSION_check_o_t

struct PK_DEBUG_SESSION_check_o_s
{
    int o_t_version;                          --- version number
    int max_faults;                           --- maximum number of faults (10)
    int n_partitions;                         --- number of partitions to check
                                              --- (0)
    const PK_PARTITION_t *partitions;         --- list of partitions to check
                                              --- (NULL)
    PK_DEBUG_roll_direction_t roll_direction; --- whether and the direction to
                                              --- roll the list of 'partitions'
                                              --- (PK_DEBUG_roll_no_c).

};
typedef struct PK_DEBUG_SESSION_check_o_s PK_DEBUG_SESSION_check_o_t;

Used in:

PK_DEBUG_SESSION_check

This structure contains optional controls for PK_DEBUG_session_check.

Description of fields:

'max_faults'        The caller may set an upper limit on the number
                    of faults found. If 'max_faults' is zero the first
                    fault found will be returned as a PK error.

'n_partitions'      Length of the 'partitions' array.

'partitions'        Array of length 'n_partitions' containing partitions
                    to check.

'roll_direction'    When checking the list of 'partitions' it is also
                    possible to roll each partition to other states
                    and perform checks.

                    Permitted values are:

                    PK_DEBUG_roll_no_c: Check partitions in their current
                    state only. Do not roll to other states.

                    PK_DEBUG_roll_back_main_c: Roll the partitions to pmarks
                    in the main line backwards from the current pmark only
                    and perform checks in these states.

                    PK_DEBUG_roll_back_c: Perform a complete traversal
                    of all the pmarks backwards from the current
                    pmark. Initially, roll to the next pmark back along
                    the main line and then roll backwards and forwards
                    such that all pmarks on the main line and all pmarks
                    along any branches of the main line are visited and
                    checks are performed in these states.

                    PK_DEBUG_roll_fwd_c: Roll the partitions to all pmarks
                    forwards from the current pmark and perform checks in
                    these states.

                    PK_DEBUG_roll_both_c: Roll the partitions to all pmarks
                    backwards and forwards from the current pmark and
                    perform checks in these states.