Question

SystemVerilog extends the VPI module iterator model (i.e., the instance) to encompass assertions, as shown in Figure 28-1.

The following steps highlight how to obtain the assertion handles for named assertions.

Figure 28-1 — Encompassing assertions

Note: Iteration on assertions from interfaces is not shown in Figure 28-1 since the interface object type is not currently defined in VPI. However the assertion API permits iteration on assertions from interface instance handles and obtaining static information on assertions used in interfaces (see Section 28.3.2.1).

1) Iterate all assertions in the design: use a NULL reference handle (ref) to vpi_iterate(), e.g.,

itr = vpi_iterate(vpiAssertion, NULL);

while (assertion = vpi_scan(itr)) {
    /* process assertion */
}

2) Iterate all assertions in an instance: pass the appropriate instance handle as a reference handle to vpi_iterate(), e.g.,

itr = vpi_iterate(vpiAssertion, instanceHandle);
while (assertion = vpi_scan(itr)) {
    /* process assertion */
}

3) Obtain the assertion by name: extend vpi_handle_by_name to also search for assertion names in the appropriate scope(s), e.g.,

vpiHandle = vpi_handle_by_name(assertName, scope)

4) To obtain an assertion of a specific type, e.g. cover assertions, the following approach should be used:

vpiHandle assertion;

itr = vpi_iterate(vpiAssertionType, NULL);

while (assertion = vpi_scan(itr)) {
    if (vpi_get(vpiAssertionType, assertion) == vpiCoverType) {
        /* process cover type assertion */
    }
}

NOTES

1. As with all VPI handles, assertion handles are handles to a specific instance of a specific assertion.
2. Unnamed assertions cannot be found by name.