Interpret Code Prover Results in Polyspace Desktop User Interface

This topic shows how to review Code Prover results in the user interface of the Polyspace desktop products. To see how to review results in the Polyspace Access web interface, see Interpret Code Prover Results in Polyspace Access Web Interface.

When you open the results of a Polyspace^® Code Prover™ analysis, you see a list on the Results List pane. The list consists of run-time checks, coding rule violations, code metrics and global variable usage.

You can first narrow down the focus of your review:

Use filters on the results list columns. For instance, you can first focus on red checks.
Organize results by file and function. Use the icon above the list.
Because the results of a Code Prover run-time check are dependent on the results of previous checks, it helps to go through run-time checks from the beginning to the end of a function.

See also Filter and Group Results in Polyspace Desktop User Interface. Once you narrow down the list, you can begin reviewing individual results. This topic describes how to review a result.

To begin your review, select a result in the list.

Interpret Result

Interpret Message

The first step is to understand what the issue is. Read the message on the Result Details pane and the related line of code on the Source pane.

At this point, you might be ready to decide whether to fix the issue.

The message consists of several parts:

Check color and icon: See Code Prover Result and Source Code Colors. In case of checks for run-time errors:
- : Red indicates a definite error.
- : Orange indicates a possible error.
- : Gray indicates unreachable code.
- : Green indicates that a specific error cannot happen.
Description of the run-time check.
In the preceding example, the check determines if an array index goes outside the array bounds.
Values relevant to the run-time check.
In the example, the message states the array size (127), the array bounds (0..126), and the range of values that the array index variable can take at that point in the code (0..555).
Relevant sources of imprecision (for orange checks).
In the example, the message states that two volatile variables might be responsible for the check.

See Variable Ranges in Source Code Tooltips

On the Source pane, variables and operations with tooltips are underlined.

In this example, tooltips appear on:

s8_ret: You see its data type and range of values before the + operation.
If a data type conversion occurs during the + operation, you also see this conversion in the tooltip.
+: You see the value of the left and right operand, and the result.
=: You see any data type conversion that occurs during the assignment and the result.

Get Additional Help

Sometimes, you need additional help for certain results. To open a help page for the selected result, click the icon. See code examples that illustrate the result.

Find Root Cause of Result

Sometimes, the root cause might be far from the actual location where the result is displayed. For instance, a variable that you read might be non-initialized because the initialization is not reachable. The defect is shown when you read the variable, but the root cause is possibly a previous if or while condition that is always false.

Navigate in Source Code

Sometimes, the Result Details pane shows one sequence of events that leads to the result. However, in most situations, you have to find your own navigation pathways through the code. Using tooltips on variables, follow the propagation of variable ranges as you navigate through the code.

int func (int var) { /* Initial range of var */
     … 
     var -= get ();  /* New range of var */
     …
     set(&var);     /* New range of var */
}

Use these quick navigation pathways in the user interface:

Search for all references to a variable and browse through them.
Right-click the variable name on the Source pane and select Search For All References. Alternatively, double-click the variable. These options perform more than a string match. The options show only instances of a specific variable and not other variables with the same name in other scopes.
Navigate from a function call to its definition.
Right-click the function name on the Source pane. Select Go To Definition.
Navigate from a function to its callers and callees.
Click the icon on the Result Details pane. You see the function containing the result, with its callers and callees. Click a caller or callee name to navigate to the call site. Double-click a name to navigate to the definition.
Alternatively, click the icon to see a graphical representation of the call sequence leading to the result. To navigate to functions in this sequence, click through nodes in the graph.
Navigate from a function call or loop keyword to an error in the function or loop body.
If the error occurs only in a specific function call or specific loop iteration, the function call or loop iteration is highlighted red. Right-click the red function call or loop keyword. Select Go To Cause if the option is available.
Navigate across all instances of a global variable.
Click the icon on the Result Details pane. See all global variables in the result and read/write operations on them.

Before you begin navigating through pathways in your code, determine what you are looking for and choose the appropriate navigation tool. For instance:

To investigate a Non-initialized variable check, you might want to make sure that the variable is not initialized at all. Look for previous instances of the variable and see if it is initialized.
To investigate a violation of MISRA C:2012 Rule 17.7:
```
The value returned by a function having non-void return type shall be used.
```
you might want to navigate from a function call to the function definition.

For other examples of what to look for, see Code Prover Run-Time Checks. After you navigate away from the current result, use the icon on the Result Details pane to return to that result.

If you click a source code token containing a result, the previous result selection on the Results List and details on the Result Details pane do not change. You can keep the result in the results list and the result details pinned while navigating in the source code. Sometimes, you might want to see the result associated with a token. To update the result selection and the details, Ctrl-click the token or right-click and select Select Results At This Location.

Navigate in Separate Window

If reviewing a result requires deeper navigation in your source code, you can create a duplicate source code window that focuses on the result while you navigate in the original source code window.

Right-click in the Source pane and select Create Duplicate Code Window. Right-click the tab showing the duplicate file name (ending with -spawn 1) and select New Vertical Group.

Perform the navigation steps in the duplicate file window while the defect still appears in the original file window. After the investigation is complete, close the duplicate window.