Simulator provides an array of features — including single- and multi-step
forward and backward execution, breakpoints, and simulations driven by
Tester-generated tests or user inputs — for simulating Simulink / Stateflow models (and
C code if using the Reactis for C Plugin). The tool also allows visual tracking of coverage
data and the values data items in the model assume during simulation.
| Figure 7.1: The Reactis Simulator toolbar controls. |
Figure 7.1 contains an annotated screen shot of a portion of
the top-level Reactis window when Simulator is enabled. Some of the
buttons and pull-down menus on the leftmost part of the window have been elided;
Chapter 4 contains descriptions of these items. The next
section describes the labeled items in Figure 7.1, while the
section following discusses the Simulator-related menu entries. The
subsequent sections discuss the different modes for generating inputs during
simulation, ways to track data values, how to monitor model coverage, importing
and exporting test suites, and the different model highlighting styles used by
Simulator.
7.1 Labeled Window Items
-
Disable Reactis Simulator.
-
Enable Reactis Simulator.
-
Reset the simulation; the model is returned to the
start state, and coverage information is appropriately reset.
-
Take n steps back, where n is specified by window item 10.
Coverage information is updated appropriately upon completion
of the last backward step.
-
Take one step back. Coverage information is updated appropriately.
-
Advance by one mini-step. In Simulink, a mini-step evaluates the next
block in the evaluation order. In Stateflow, a mini-step evaluates the
next transition segment condition or transition action. In C, a mini-step
executes a single C statement, stepping into a function when at a function
call.
-
Advance forward by one full step; that is, values are read on the top-
level inports, the model’s response is computed and values are written to
the top-level outports. If a step has been partially computed using the
step-into button (window item 6), then execution
picks up with the current partially computed step and continues until the
end of the step, at which point values are written to the top-level
outports.
-
Execute n slow simulation steps, where n is specified by window
item 10. The diagram in the main panel (window
item 17) is updated during simulation to reflect the
currently active Simulink block, Stateflow state / transition, or C
statement. When Coverage -> Show Details is selected, coverage
targets will change from red to black as they are covered during the
simulation run. If a single test is selected and the end of
the test is reached before n steps execute, then simulation stops.
When executing multiple tests (including an entire suite) the tests
are executed one after another and simulation stops when n steps
have executed or the end of the test suite is reached.
When a slow simulation is running, clicking this button pauses the
simulation.
Execute n fast simulation steps, where n is specified by window
item 10. The diagram in the main panel (window
item 17) is not updated while the simulation is in
progress but is updated when simulation halts. If the end of the current
test or test suite is reached then simulation halts.
When a fast simulation is running, clicking this button pauses the
simulation.
-
This window item determines how many steps are taken when buttons
corresponding to window
items 4, 8 ,
or 9 are clicked. When the
Source-of-Inputs dialog (window item 11) is set to a
test or test suite, the number of steps may be set to 0 to indicate
that the entire test or test suite should be executed.
-
The Source-of-Inputs dialog determines what values are fed into inports
to drive a simulation: random values, values from the user, or values
from a test. See Section 7.3 for details.
-
Create a new, empty test suite. The name of the .rst file
containing the
suite is initially “unnamed.rst” and is displayed in the title
bar of the Reactis window.
-
Open a dialog for selecting a test suite (.rst file) to be loaded into
Simulator. After it is loaded, the test suite’s name is displayed in
the title bar, and the tests are listed in the Source-of-Inputs dialog (window
item 11).
-
Save the current test suite.
- View Reactis Simulator help.
-
The model hierarchy panel (not shown explicitly) supports the
structure-based navigation of a model, as described in
Section 4.1. Right-clicking on an item in the
navigation panel brings up a menu that also allows you to view data
items and set breakpoints. Data viewing is covered in more detail in
Section 7.4.
Breakpoints may be set by right-clicking on a
subsystem or Stateflow state in the hierarchy panel and
selecting Toggle Breakpoint. The name in the hierarchy
panel is then decorated with a “stop sign” icon
(
). When a subsystem breakpoint is set,
simulation pauses whenever an item in the subsystem (Simulink
block or Stateflow transition) executes. When a Stateflow
state breakpoint is set, simulation pauses whenever the state is
entered or exited. -
The main panel displays the currently selected Simulink or
Stateflow diagram or C code if you are using Reactis for C Plugin. You
may interact with the diagram
in a number of different ways using the mouse including hovering
over model items, double-clicking on items, or right-clicking
in various parts of the panel. Section 4.1
describes how you interact with the main pane when Simulator
is disabled. The following mouse operations are available when
Simulator is enabled:
-
Hovering...
-
over a data item (Simulink block or signal line,
Stateflow variable, or C variable) will display its current value and type.
- over a Goto block will cause it and its associated
From block(s) to be highlighted in yellow.
- over a From block will cause it and its associated
Goto block to be highlighted in yellow.
- over any Tester coverage target will display the
test and step within the test during which the target was first
executed. This information is presented in a message of the
form “Covered: test/step”. A “.” in the test location
indicates the current simulation run. “-/-” indicates
the target has not yet been covered. For more details
on querying coverage information
see Section 7.5,
Chapter 10,
and Chapter 6.
- over a Validator objective will cause its wiring
information to be drawn in blue.
- over an output of a Logical Operator block that roots a
Multi-Block MC/DC group will cause blue lines to be drawn to
the conditions of the group (when multi-block MC/DC is enabled).
See Section 6.3.1 for a description of
multi-block MC/DC.
- Double-Clicking...
-
on a Scope block will open a scope window for that block (see Section 7.4.2).
- on a Display block will add that block as a watched variable (see Section 7.4.1).
- on a From or Goto block will open a dialog listing all other
From or Goto blocks in the model associated with the block.
- on a Data Store Memory, Data Store Read, or Data Store Write
block will open a dialog listing all matching Data Store blocks.
- on a Simulink subsystem will cause the subsystem diagram
to be displayed in the main panel.
- on a Stateflow state will cause the state’s diagram
to be displayed in the main panel.
- on a top-level input port while running in user-guided simulation
mode will bring up a panel to modify that inport’s current input value.
- on a configuration variable in the Configuration Variable Panel
(see Section 4.5) while Simulator is in the
initial state (no simulation steps have been taken)
will bring up a panel to modify the variable’s current value.
- on a line number within a C source file will toggle a breakpoint on that line.
- on any other Simulink block will display the block’s parameters.
- Right Clicking...
Causes different pop-up menus to be displayed. The contents of the menus
vary based on where the click occurs and whether or not Simulator is
enabled. A summary of the menu items available when Simulator is
enabled follows. For descriptions of the menu entries available when
Simulator is disabled, see Section 4.1. Right-Click Location | Menu Entries (when Simulator is enabled) |
Simulink signals, Simulink blocks, Stateflow variables | -
Add To Watched
- Add item to watched variables list (see section 7.4.1).
- Open Scope
- Display item in scope (see section 7.4.2).
- Open Distribution Scope
- Display item in distribution scope (see section 7.4.3).
- Add To Scope
- Add item to previously opened scope. This item only appears
when other scopes are open.
|
User defined target or assertion | -
View Properties
- View assertion, user defined target, or virtual source
properties in read-only mode.
|
Logical Operator block, Lookup Table, top-level Inport, non-else outport of If block, or
Stateflow transition segment, Stateflow state | -
View Coverage Details
- Display dialog containing detailed coverage information
for the item.
(see sections 6.1.3, 6.3.1, 6.3.2,
6.2,
and 7.5.2)
|
Simulink blocks | -
View Block Parameters
- Display Simulink block parameters.
|
Top-level inport or configuration variable in Configuration
Variable Panel (see Section 4.5) | - Change Value
- Modify current value of top-level inports or
configuration variables. Note that top-level input values may only be
updated when in user-guided input mode (see Section 7.3.1)
and configuration variables may only be updated in between
tests (not during a test).
|
Top-level outport. |
-
Open Difference Scope
- This menu item is enabled when a test suite is loaded.
The feature is used when differences exist between the value stored in the test for
the outport and the value computed by the model for the outport. The resulting scope
plots the expected value (from the test) against the actual value (from the model)
as shown in Figure 7.8.
|
non-virtual Simulink block or Stateflow transition | -
Toggle Breakpoint
- Enable or disable breakpoint for an item.
|
Simulink subsystem | -
Extract Subsystem
- Extract a subsystem and save it in a separate
model file (see section 4.6).
|
- Left-Clicking on Signals...
Causes the signal wire to be highlighted in yellow. The highlighting
travels in both directions: back to its block source and forward to one
or several block destinations. To make it easy to identify the relevant
signal path, the subsystems the signal penetrates are highlighted as well.
The signal highlighting will travel through virtual blocks such as
Subsystems, Froms, Gotos, inports, outports, data-store reads and data-
store writes. To continue tracing a signal through a block, click on the
wire on the non-highlighted side of the block. To remove signal
highlighting, left-click the mouse button in empty space.
@percentThe following five entries
are only available in the toolbar if you are using the Reactis for C Plugin to
step through C code.
-
Step backwards to just before the currently executing function was called.
-
When paused after a function call, clicking this button steps back to
just before the function was called.
-
Step backwards one statement.
-
When paused at a function call, clicking this button steps over the function
(executes the function and pauses at the following statement).
-
Advance until the currently executing function returns.
Except for the documented exceptions related to editing
.rsi files 1,
the menus described in Section 4.2 work in the
same manner when Simulator is enabled. The following additional
menu items are also active when Simulator is enabled.
-
View menu.
- The following entries become enabled when
Simulator is “on”.
-
Show Watched Variables.
-
Toggle whether or not watched-variable list is displayed. The default
is not to show them; adding to the list automatically
causes the list to be displayed.
- Add Watched Variables.
- Add data items (Simulink blocks or signal lines,
Stateflow variables, or C variables) to the watched-variable
list. Selecting this entry brings up a list of data items.
You can toggle whether or not an entry in the list is
selected by control-left-clicking on it; clicking OK
causes the selected items to be added to the watch list.
- Clear Watched Variables.
- Remove all items from the
watch list.
- Open Scopes...
- Open scopes for data items (Simulink blocks or signal lines,
Stateflow variables, or C variables). Selecting this
entry brings up a list of items. You can toggle
whether or not an entry in the list is selected by control-left-clicking on
the variable; clicking OK causes scopes to be opened
for each selected item.
- Open Distribution Scopes...
-
Open distribution scopes for data items (Simulink blocks or signal lines,
Stateflow variables, or C variables). Selecting
this
entry brings up a list of items. You can toggle
whether or not an entry in the list is selected by control-left-clicking on
the variable; clicking OK causes distribution scopes to be
opened for each selected item.
- Close All Scopes.
- Close all open scopes.
- Save Profile as...
-
Save the current view profile under a new name. The view profile
contains the currently opened scopes and watched variables.
Profiles are saved in a file with the .rsp suffix.
- Load Profile...
- Load a different view profile
(.rsp file
). This will automatically open all scopes and watched variables
stored in the profile.
- Use Classic Toolbar.
- Use the toolbar icons that were used prior to
Reactis V2010.2.
- Simulate menu.
- The following entries are available when
Simulator is enabled. Note that some entries (Step Over,
Step Out Of, Reverse Step Into, Reverse Step Over, Reverse Step
Out Of) are only available when using the Reactis for C Plugin with a model
containing C code.
-
Simulator on/off.
- Enable or disable Simulator.
When disabled Simulator behaves as a model viewer; that is, the model can
be viewed but simulation capabilities are disabled.
- Fast Run with Report.
- Execute a fast simulation
simulation and produce a summary report that lists any runtime errors
uncovered (divide-by-zero, overflow, memory errors, missing cases, assertion
violations, etc.) or differences between outport values stored in the test
suite and those computed by the model. If a runtime error is encountered,
the remaining steps of the current test are skipped and Simulator continues
execution with the following test. To get a report for a complete test suite,
load the test suite then select Simulate -> Fast Run with Report. A sample
report is shown in Figure 7.2. An HTML version of the
report can be saved by clicking the Save button in the report window.
| Figure 7.2: A test execution report can be generated by
loading a test suite in Simulator and selecting Simulate -> Fast Run
with Report. |
- Fast Run.
- Same as window item 9.
- Run.
- Same as window item 8.
- Step.
- Same as window item 7.
- Step Into.
- Same as window item 6.
- Step Over.
- Same as window item 21.
- Step Out Of.
- Same as window item 22.
- Stop.
- Stop a fast or slow simulation run.
- Reverse Step Into.
- Same as window item 20.
- Reverse Step Over.
- Same as window item 19.
- Reverse Step Out Of.
- Same as window item 18.
- Back.
- Same as window item 5.
- Fast Back.
- Same as window item 4.
- Reset.
- Same as window item 3.
- Toggle Breakpoint.
- Sets a breakpoint for the currently
selected item in the model-hierarchy panel if none exists, or
clears the breakpoint if one has already been set. Simulation
will halt when the item becomes active, which may be in the middle
of a simulation step. The simulator controls may then be used to
continue execution of the model.
- Clear Breakpoints.
- Removes all breakpoints.
- Set Animation Delay...
- When running a slow simulation,
this value specifies the duration of the pause between the
evaluation and highlighting of different model elements.
- Update Configuration Variable...
-
Initiates a dialog for changing values of configuration variables, which are
workspace variables whose values can only change between tests/simulation
runs (but not during a test/simulation run). The simulation must be reset
to the start state (by clicking the reset button
, window item 3)
before the value of a configuration variable may be updated. Note also that
whenever inputs are read from a test, the configuration variable values from
the test will be used. In other words, manual updates to a configuration
variable using this menu item will only have effect when in random or user
input mode.
- Test Suite menu.
-
-
-
- New.
- Same as window item 12.
- Open.
- Same as window item 13.
- Save.
- Same as window item 14.
- Save and Defragment.
- Removing tests from a test suite can
cause the test suite to become fragmented, meaning that space within
the file becomes unused. Reactis will reuse those gaps when you add tests.
Selecting this menu item will save the current test suite and reorganize
it, removing all gaps.
- Save As...
- Save current test suite in an .rst file
. A
file-selection dialog is opened to determine into which file the test
suite should be saved.
- Import...
- Import tests and add them to the current test suite.
Importing is described in more detail in Section 7.6.2.
- Export...
- Export the current test suite in different formats.
Exporting is described in more detail in Section 7.6.1.
- Create...
- Launch Reactis Tester.
See Chapter 8 for details.
- Update...
-
Create a new test suite by simulating the current model using inputs from the
current test suite, but recording values for outputs and test points generated
by the model. This feature is described in Section 7.7.
- Browse...
- Open a file selection dialog, and then
launch the Test-Suite Browser on the selected file.
See Chapter 11 for details.
- Browse Current.
- Launch the Test-Suite Browser on the
currently loaded test suite. See Chapter 11
for details.
- Add/Extend Test.
-
At any point during a simulation, the
current execution sequence (from the start state to the current state)
may be added as a test to the current test suite by selecting this menu item.
After the test is added it will appear in the Source-of-Inputs dialog (window
item 11). Note that the new test will not
be written to an .rst file until the current test suite has been saved
using window item 14 or the Test Suite -> Save menu item.
- Remove Test.
- Remove the current test from the current test suite.
Note that the test will not be removed from the .rst file until the
current test suite has been saved using window item 14 or the
Test Suite -> Save menu item.
- Compare Outputs.
-
Specify whether or not Simulator should
compare the simulation outputs against the outputs contained in the
test suite being executed. When enabled if a difference is detected
then the difference between the computed value and the value stored
in test suite is reported in a warning. A difference scope
may then be opened by right-clicking on a top-level outport and
selecting Open Difference Scope (see Figure 7.8).
A tolerance for this compare may be specified as described in
Section 5.1.4
- Validate menu.
- See Chapter 9 for a description
of this menu.
- Coverage menu.
-
The Coverage menu contains the following entries. Details about the
different coverage objectives may be found in
Chapter 6. The coverage information available from
the various menu items is for the current simulation run. If a test
suite is being executed, the coverage data is cumulative. That means
all targets covered by the portion of the current test executed
so far, plus those targets exercised in previous tests are listed as
covered.
-
Show Summary.
- Open the coverage summary dialog shown in
Figure 7.10.
- Show Details.
- Report coverage information by coloring diagram
elements as defined in the Line Style dialog shown in
Figure 7.16. Generally, uncovered targets are drawn in red.
- Show Report.
- Start the Coverage-Report Browser.
See Chapter 10 for details.
- Highlight Subsystems,
- Branches, States, CSEPT,
Condition Actions, Transition Actions, C Statements,
Decisions, Conditions, MC/DC, Boundaries, Lookup Targets,
User-Defined Targets, Assertion Violations.
Each of these menu entries corresponds to one of the model coverage
criteria tracked by Reactis and described in Chapter 6.
When a menu entry is selected and Show Details is selected, any
uncovered target in the corresponding coverage criterion will be colored.
- Select All.
- When Show Details is selected, show
coverage information for all criteria.
- Deselect All.
- When Show Details is selected, show
no coverage information.
- Unreachable Targets.
- When Show Details is
selected, color unreachable targets. A target is
unreachable if it can be determined to be unexecutable without
running the model. The analysis used is conservative: marked
items are always unreachable, but some unmarked items may also
be unreachable.
7.3 Specifying the Simulation Input Mode
| Figure 7.3: The Source-of-Inputs dialog enables you to
specify how Simulator computes input values. |
Reactis Simulator performs simulations in a step-by-step manner: at each
simulation step inputs are generated for each top-level inport, and resultant
outputs reported on each top-level outport. You can control how Simulator
computes input values using the Source-of-Inputs dialog (window item
11 in Figure 7.1) shown in
Figure 7.3.
This dialog always includes the
Random Simulation and User Guided Simulation entries; if a test
suite has been loaded, then the dialog also includes an entry for each test and
the All button becomes enabled. The dialog is used to specify
how input values are generated as follows.
-
Random Simulation.
- For each inport, Reactis randomly selects a value from
the set of allowed values for the inport, using type and probability
information contained in the associated .rsi file
. See
Chapter 5 for a description of how to enter this
information using the Reactis Info File Editor.
- User Guided Simulation.
- You determine the value for each inport using the
Next Input Values dialog, which appears when the
User Guided Simulation
entry is selected. See Section 7.3.1 below for more
information on this mode.
- Individual Tests.
- When a test suite is loaded, each test in
the suite has a row in the dialog that contains a test number,
a sequence number, a name and the number of steps in the test.
Selecting a test and clicking okay will cause inputs to be read from
the test.
- Subset of Tests.
- You may specify that a subset of tests
should be run by holding down the control key and clicking on each
test to be run with the left mouse button. The tests will be run
in the order they are selected. As tests are selected the sequence
number column is updated to indicate the execution order of the
tests. When a new test is started, the model is reset to its
starting configuration, although coverage information is
not reset, thereby allowing you to view cumulative
coverage information for the subset of tests.
- All Tests.
- Clicking the All button in the lower left
corner specifies that all tests in the suite should be executed
one after another. The tests are executed sequentially. When a new
test is started, the model is reset to its starting configuration,
although coverage information is not reset, thereby
allowing you to view cumulative coverage information for the
entire test suite. Section 7.3.2 contains more
information on this mode.
You can change the sorting order of the tests in the table by clicking
on the column headers. For example, to sort the tests by the number
of steps, simply click on the header of the “Steps” column. Clicking
again on that header will sort by number of steps in descending order.
You may also use the Inputs Source dialog to change the name of a
test. To do so, select the test by clicking on it, then
click on the name and, when the cursor appears, type in a new name.
7.3.1 User Input Mode
When the User Guided Simulation mode is selected from the
Source-of-Inputs dialog, you provide values for inports at each
execution step. This section describes how this is done.
| Figure 7.4: The Next Input Values dialog. |
To enter the user-guided mode of operation, select User Guided
Simulation from the Source-of-Inputs dialog (window item 11).
Upon selecting user-guided mode, a Next Input Values
dialog appears, as shown in Figure 7.4, that allows
you to specify the input values for the next simulation step. Each
top-level inport of the model has a row in the dialog containing
entries 1-5 (see numbering in
Figure 7.4). The header row includes the elements
labeled 6-8.
-
The inport number and name.
- This pull-down menu has three entries that determine
how the next value for the port is specified:
-
Random.
- Randomly select the next value for the inport
from the type given for the inport in the .rsi file.
- Entry.
- Specify the next value with the text-entry box
in column three.
- Panel.
- Open a sub-panel to specify the next value. This
input mode is primarily used when the port reads
vector values.
- If the pull-down menu in column two is set to “Entry”,
then the next input value is taken from this text-entry box.
- If the pull-down menu in column two is set to “Entry”,
then clicking this history button displays recent values
the inport has assumed. Selecting a value from the list
causes it to be placed in the text-entry box of column three.
- The arrow buttons in this column enable scrolling through
the possible values for the port. The arrows are available
for inports:
-
having a base type of integer, boolean or fixed point; or
- having a base type of
double or single and
either a resolution or subset of values constraint.
- This pull-down menu sets the input type for all ports at once to either
“Random” or “Entry.”
- Clicking this button sorts the rows by port number.
- Clicking this button sorts the rows by port name.
When “run” or “fast run” (window item 8
or 9 in Figure 7.1) is selected, the
inport value specifications in the Next Inputs Values dialog are
used for each step in the simulation run.
7.3.2 Test Input Mode
Simulation inputs may also be drawn from tests in a Reactis test
suite. Such tests may be generated automatically by Reactis
Tester, constructed manually in Reactis Simulator, or
imported using a comma separated value file format. By convention
files storing Reactis test suites have names suffixed by .rst.
A Reactis test suite may be loaded into Simulator by clicking
the
in the tool bar to the right of Source-of-Inputs dialog (window
item 13 in Figure 7.1) or by selecting the
Test Suite -> Open menu item.
When a test suite is loaded, the name of the test suite
appears in the Reactis title bar and the tests of the suite
are listed in the Source-of-Inputs dialog.
When executing in test input mode while Test Suite -> Compare Outputs is
selected, after each simulation step, Simulator
compares the values computed by the model for test points and top-level output
ports against the values stored in the test suite for those items. A
difference is flagged if it exceeds the relative error tolerance specified for
that port. See Section 5.1.4 for more information on specifying
error tolerances for output ports.
If a value in the test differs from that computed by the model for a top-level
outport, the difference may be visualized (as shown in
Figure 7.8) by right-clicking on the outport and selecting
Open Difference Scope.
7.4 Tracking Data-Item Values
Reactis Simulator includes several facilities for interactively displaying
the values that data items (Simulink blocks or signal lines,
Stateflow variables, or C variables) assume during simulation. The
watched-variable list, or “watch list” for short, displays the current values
of data items designated by the user as “watched variables.” You may also attach
scopes to data items in order to display values as they vary over time.
Scopes behave like Simulink Scope blocks except that they are not hard-wired
into models and are instead opened and closed during simulation. Distribution scopes enable you to view the set of values a data item has
assumed during simulation (but not the time at which they occur). Difference scopes may be opened for top-level outports when reading inputs
from a test in order to plot the values computed by the model against the values
stored in the test for the outport.
You may add data items to the watch list, or attach scopes to them,
as follows.
-
Using the View menu.
- The View menu contains
operations for adding data items to the watch list, opening scopes,
and opening distribution scopes. These are described in more detail
in Section 7.2.
- Using pop-up menus in the model hierarchy panel.
-
Right-clicking on a subsystem in the hierarchy panel brings up a
pop-up menu that includes the entries:
-
Add Watched Variables...
- Open Scopes...
- Open Distribution Scopes...
Selecting one of these entries will cause a dialog to appear listing
data items in the subsystem which may be added to the watched variable
list or to which scopes may be attached.
- Using pop-up menus in the main panel.
- Right-clicking on a
data item in the main panel of Simulator invokes a menu that
enables you to add the data item to the list of watched variables
or open a scope or distribution scope to monitor the values of the
data item during simulation. This menu also includes an entry
Add To Scope that enables you to plot the data item on
a previously opened scope.
You
may save the current configuration of the data tracking facilities
(the variables in the watch list and currently open scopes along with
their locations) for use in a future Simulator session. Do
so by selecting View -> Save Profile As... and using the
resulting file selection dialog to specify a file in which to save a
Reactis profile (.rsp file
). The profile may be loaded at
a future time by selecting View -> Load Profile....
7.4.1 The Watched-Variable List
| Figure 7.5: The watched variable panel tracks the current values of data items. |
The watch list is displayed in a panel at the bottom of the
Simulator screen as shown in Figure 7.5. By
default this panel is hidden, although adding a variable to the watch
list causes the panel to become visible. Visibility of the panel may
also be toggled using the View menu as described in
Section 7.2. The panel displays a list of
data items and their values. The values are updated when Simulator
pauses.
The contents of the watch list may be edited using a pop-up menu that
is activated from inside the watch-list panel. Individual data items
in the panel may be selected by left-clicking on them. Once an item
is selected, right-clicking invokes a pop-up menu that enables the
selected item(s) to be deleted, have a scope opened, or have a
distribution scope opened. If no item is selected, then these
choices are grayed out. The right-click pop-up menu also includes
an entry Add Variables which displays a list of all data
items in the model which may be added to the watch list.
The View menu contains operations for displaying / hiding the
watch list, adding data items to the watch list, clearing the watch
list.
Scopes appear in separate windows, an example of which may be found in
Figure 7.6. The tool bar of each scope window contains
seven or more items. The first two, window items 1 and 2, are toggle
buttons for controlling the scaling of the coordinate system used to
display values, and third (window item 3) is a “zoom to fit” button.
If both toggles are “on” (the default), then left-clicking in the
scope window causes the view to become zoomed-in and re-centered;
right-clicking causes the scale to become zoomed-out and re-centered.
Turning off either of the buttons 1 or 2 disables scaling for the
indicated axis: X or Y respectively.
| Figure 7.6: A scope window plotting desired speed (green) and
actual speed (yellow). |
The fourth and fifth tool bar items are toggle buttons to indicate
whether data items should be plotted as solid lines (window item 4)
or as points (window item 5).
Clicking the CSV button (window item 6) causes the data
presented in the scope to be saved to a CSV (comma separated value)
file.
Clicking the ? button displays help for scopes.
If more than one data item is plotted on a scope, then a toggle button will
appear in the tool bar for each data item (window items 8 and 9). Turning one
of these buttons off will hide the corresponding data item in the scope.
Hovering over the button will display the data item to which the button
corresponds.
7.4.3 Distribution Scopes
Distribution scopes also appear in separate windows, an example of
which may be found in Figure 7.7. The values
a data item assumes are displayed as data points distributed across
the X-axis. Left-clicking in the distribution scope causes the view
to be zoomed-in and re-centered; right-clicking causes the scale to
become zoomed-out and re-centered. Clicking the “zoom to fit”
button re-scales the view so that the minimum value appears at the
left edge of the plot and the maximum value appears at the right edge.
| Figure 7.7: Distribution
scopes plot the values a data item has assumed during simulation. |
7.4.4 Difference Scopes
When executing tests from a test suite, a difference scope may be opened by
right-clicking on a top-level outport and selecting Open Difference
Scope. The resulting scope plots the expected value (from the test) against
the actual value (from the model) as shown in Figure 7.8.
If the the values differ by more than the relative tolerance specified for the
output port (see Section 5.1.4) then a red background in the
difference scope and a red bar on the X-axis highlight the difference.
After zooming into an area of difference, white and yellow and green background
regions around the plotted values visualize the tolerances as shown in
Figure 7.9. The green region represents the overlap
between the tolerance regions of test and model values. A difference is flagged
if either the test or model value is outside of the green region.
| Figure 7.8: A difference scope may be opened by right-clicking
on a top-level outport and selecting Open Difference Scope. The scope plots
the values stored in a test for an output and the values computed by the model
for the output. Differences are flagged in red. |
| Figure 7.9: The white and yellow colored backgrounds around the
value lines visualize the relative tolerances around the test and model values.
The overlap between the yellow and white regions is colored green. If either the
test or model value is outside the green region then a difference is flagged. |
7.5 Tracking Model Coverage
Chapter 6 describes the coverage criteria that
Reactis employs for measuring how many of a given class of
syntactic constructs or coverage targets that appear in a model
have been executed at least once. Simulator includes extensive
support for viewing this coverage information about the parts of the
model that have been exercised by the current simulation run. If a
test suite is being executed the coverage data is cumulative. That is
all targets covered by the portion of the current test executed so
far, plus those targets exercised in previous tests are listed as
covered.
7.5.1 The Coverage Summary Dialog
The Coverage Summary Dialog shown in Figure 7.10
may be invoked at any time Simulator is enabled by selecting
Coverage -> Show Summary. The dialog reports summary
statistics for each coverage criterion tracked by Reactis.
Each row in the dialog corresponds to one of the criterion
and includes five columns described below from left to right.
-
The name of the coverage criterion reported in the row.
- The number of targets in the criterion that have been exercised
at least once.
- The number of targets in the criterion that are unreachable.
A conservative analysis is performed to check for unreachable
targets. Any target listed as unreachable is provably unreachable;
however, some unreachable targets might not be flagged as unreachable.
- The number of reachable targets in the criterion that have not been exercised.
- The percentage of reachable targets in the criterion that have been exercised
at least once.
| Figure 7.10: The Coverage Summary Dialog |
7.5.2 Coverage Information in the Main Panel
Selecting Coverage -> Show Details causes unexercised targets to
be drawn in red in the main panel. Targets that have been covered are
drawn in black. Hovering over an exercised target will cause a pop-up
to be displayed that gives the test and step in which the target was
first executed. This type of test and step coverage information is
displayed with a message of the form test/step. A “.”
appearing in the test position ./step denotes the current
simulation run which has not yet been added to a test suite.
If -/- is displayed, the target has not yet been covered.
| Figure 7.11: The dialog for viewing MC/DC related coverage information. |
For items included in the MC/DC coverage measure (Simulink
Logic and If blocks and Stateflow transition segments whose label includes an
event and/or condition) or CSEPT coverage (states, transition segments) ,
detailed coverage information may be obtained by right-clicking on the item and
selecting View Coverage Details. A dialog similar to that in
Figure 7.11 will appear and give coverage information for
decision coverage, condition coverage, and MC/DC.
The table in this figure describes coverage for the decision:
set == 1 && deactivate == 0
which itself contains the two conditions:
-
set == 1
deactivate == 0.
Conditions are the atomic
boolean expressions that are used in decisions. The first two columns
of the table list the test/step information for when the decision
first evaluated to true and when it first evaluated to false. A value
-/- indicates that a target has not yet been exercised. The
third column lists the conditions that make up the decision, while the
forth and fifth columns give test/step information for when each
condition was evaluated to true and the false.
MC/DC Coverage requires that each condition independently affect the
outcome of the decision in which it resides. When a condition has
met the MC/DC criterion in a set of tests, the sixth and seventh
columns of the table explain how. Each element of these two columns
has the form bb:test/step, where each b reports the
outcome of evaluating one of the conditions in the decision during the
test and step specified. Each b is either T to indicate
the condition evaluated to true, F to indicate the condition
evaluated to false, or x to mean the condition was not
evaluated due to short circuiting.
| Figure 7.12: If a Stateflow state or transition segment has
CSEPT targets, then you can right click on the state or transition and select
View Coverage Details to view the relevant CSEPT coverage
information. |
Figure 7.12 shows the Coverage Details dialog for
Child State Exit via Parent Transition (CSEPT) coverage . For the
full definition of this metric see Section 6.2.4. Conceptually
CSEPT tracks whether each child of a Stateflow state S has been exited by
each transition that causes S to exit. In the figure, CSEPT tracks
that each of the states Inactive, Active, and Init have been exited as a
result of the transition from On to Off firing.
Right-clicking on a (non-top-level) state S and selecting View Coverage
Details causes the display of a dialog that lists the transitions that
cause the parent of S to exit. Clicking the Highlight buttons
in the dialog lets you identify the state and transitions from the list
in the main panel.
Right-clicking on a transition segment that is part of a transition T that
causes a parent state to exit and selecting View Coverage Details causes
the display of a dialog that lists the child states that can be exited as a
result of T firing. Clicking the Highlight buttons causes each
transition to be highlighted in the main panel.
7.5.3 The Coverage Report Browser
The Coverage-Report Browser enables you to view detailed coverage information and
export the reports in HTML format. It is invoked by selecting
Coverage -> Show Report and is described in detail in
Chapter 10.
7.6 Exporting and Importing Test Suites
7.6.1 Exporting Test Suites
| Figure 7.13: The Reactis test-suite export window. |
The export feature of Reactis allows you to save .rst files in different
formats so that they may be processed easily by other tools. The feature is
launched by selecting Test Suite -> Export... when a test suite is loaded
in Simulator. You specify the format and name of the exported file in the
General tab of the Export Dialog (Figure 7.13).
For some export formats, other tabs appear in the dialog to enable you to
fine-tune exactly what is included in the exported file. In the case of .csv files,
you may specify a subset of tests from the test suite to be exported as well as
which data items (inputs, outputs, test points, configuration variables) should
be included in each test step. The following formats are currently supported:
- .m files:
- Suites may be saved as MATLAB scripts
so that they may be run using The MathWorks’ Simulink / Stateflow environment.
Section 12.2 describes how to execute
exported .m files
in Simulink.
That section describes how the runtests utility distributed
with Reactis enables you to load an exported .m file, execute
the tests therein, and report any differences between the values
computed by Simulink for outputs and the values stored in the
tests. When exporting to this format you have a choice of exporting
fixpoint values on top-level input or output ports as either “double”
values (easier to read) or Simulink fixpoint objects (more precise).
Enumerated values can be exported as either their underlying integer
values or instances of their enumeration objects.
- .mat files:
-
Suites may be saved as .mat files
so that they may be run using
The MathWorks’ Simulink / Stateflow environment. This binary format enables
values in tests to be represented with more precision than is
possible in the ASCII-based .m file format. When running a
Reactis-generated test suite on a Simulink model, the higher
precision of test data helps avoid some rounding errors.
Section 12.2 describes how to execute
exported .mat files in Simulink. The runtests utility
works for .mat files exactly as described above for .m files.
When exporting to this format, fixpoint values will always be
exported as “double” values and enumerated values will be
exported as their underlying integers.
- .mat files (for FromWorkspace blocks):
-
Suites may be saved in an alternative .mat file format so that
they may be run using The MathWorks’ Simulink / Stateflow environment on a
modified version of the model that uses ’FromWorkspace’ blocks in
place of top-level inports. Section 12.2
describes the contents of these exported files and how to
execute them in Simulink.
- .csv files:
-
Suites may be saved as comma separated value (CSV) files.
The different tabs of the export dialog enable you to
specify which data from a test suite should be exported. Namely,
you can indicate which tests should be exported and for each test
step which inputs, outputs, test points, and configuration variables
should have values recorded.
If the Compress output check box is selected, then test steps
will be omitted if no item that would be recorded in the step is
different from the corresponding value in the previously recorded step.
This is especially useful when exporting only inport data for
a test in which inputs are held constant for a number of steps.
The first line of an exported file will contain a comma separated list of
the names of the model’s input and output ports, test points, and
configuration variables that were selected for export. A column recording
the simulation time has the label ___t___. Any
names containing non-alphanumeric characters will be surrounded by double
quotes (") and newlines in names will be translated to \n.
The General Tab of the Export Dialog gives you
the option to prefix configuration variables | to avoid problems
if a port and configuration variable have the same name. Subsequent lines
contain either:
- A comma-separated list of values that includes one value for
each item appearing in the first row. The order of the values in a
row corresponds to the order the items appeared in the first line.
Each such line contains the values for one simulation step. If
a port carries a vector signal, then the values of the vector
appear within double quotes (
") as a comma-separated
list. - An empty line signaling the end of a test.
- Reactis V2005 and earlier:
- Suites may be saved in the old .rst file
format used prior to V2006.
- .txt files:
- Suites may be saved as easy-to-process plain ASCII files.
The format of these files is described in Section 12.3.
7.6.2 Importing Test Suites
Reactis can also import tests and add them to the current test suite.
Test suites may be imported if they are stored in the Reactis’s native
.rst file format or in the comma separated value (CSV) format
(described above) that Reactis exports. The import feature is
launched by selecting Test Suite -> Import... when Simulator
is enabled.
To execute a test suite in Simulator, the test suite must match the
executing model. A test suite matches a model if it contains data for the same
set of inports, outports, test points, and configuration variables as the model.
If an externally visible data item (inport, outport, test point, or
configuration variable) is added to or removed from a model, then previously
constructed test suites will no longer match the new version of the model. The
import facility gives you a way to transform the old test suite so that it
matches the new version of the model. Such remapping is also available when
importing .csv files.
The Import Dialog, shown in Figure 7.14, is used to
specify how test data should be remapped during import. The dialog contains a
tab for each type of data item stored in a test suite (inputs, outputs, test
points, configuration variables). In the case of .csv files, the import dialog
also contains a tab Not Imported that lists items present in the CSV file
that are not scheduled to be imported into the new test suite. When an .rst file
includes an item not scheduled to be imported, it is placed at the bottom of the
appropriate tab. For example, if a test suite contains an inport X and is
being imported with respect to a model that has no inport X, then X will appear
at the bottom of the Input Ports tab and be highlighted in yellow.
Each data item tab (e.g. Input Ports) includes a column (e.g.
Model Port Name) listing the model items in that category. The
Suite column lists items from the file being imported that map to the
corresponding model item. In most cases a data item X in the test suite being
imported will map to an item with the same name in the model. If the model
contains an item not found in the test suite being imported, then the corresponding
Suite column entry will be listed as Random Value and be
highlighted in yellow (as shown in Figure 7.14 for inport brake).
If this setting is not changed, then upon import a random value will be
generated for the inport at each test step. The value to be assigned for any
model item may be changed by double clicking on the corresponding entry in the
Suite column (alternatively selecting the item and clicking the
button Select Suite Item) and then using the resulting dialog to
either select an item from the test suite being imported or set it to
Random Value.
| Figure 7.14: The Import Dialog allows you to import external
test data (comma separated value format) and if necessary transform the data
to produce a test suite that matches a model. The import facility is also
used to transform an .rst file to make it match a model. |
When loading a test suite stored in the pre-V2006 format, the test
suite will be automatically converted to the new format.
7.7 Updating Test Suites
This feature is invoked by selecting menu item Test Suite -> Update...
to open the dialog shown in Figure 7.15. The dialog
offers two options for updating an existing test suite to reflect changes
to a model.
- Update using Reactis
-
Create a new test suite by simulating the current model
using inputs from the current test suite, but recording values for outputs and
test points generated by the model. This feature is useful for updating test
suites when a model is modified, but its input ports remain
unchanged. The result of invoking this routine is a new test
suite with the same input values at each step, but with outputs and test points
updated (as specified in the dialog)
with values generated by the currently loaded version of the model.
The three checkboxes in the Items to update section specify what
is written to the new test suite as follows:
| | Contents of new test suite when: |
| | Checked | Not Checked |
| Update inputs controlled by virtual sources | Each input currently controlled by a virtual source shall be updated with the
values computed by the controlling virtual source at each step as the tests
execute. | The values for each input shall be those from the original test suite. |
Update test points | Each test point shall be updated with the value computed by the model
for the test point as the tests execute. | The values for each test point shall be those from the original test suite. |
Update outputs | Each output shall be updated with the value computed by the model
for the output as the tests execute. | The values for each outport shall be those from the original test suite. |
- Update using Simulink
-
Invoking this option causes the following:
-
Load the current model in Simulink.
- In Simulink execute the tests from the currently loaded test suite.
- Capture the outputs produced by the model.
- Store the inputs and outputs in the .mat file format supported by
the Reactis runtests utility.
| Figure 7.15: The Update Test Suite dialog offers several
options to configure how a test suite is updated. |
7.8 Model Highlighting
Simulator renders model diagrams using a number of different
colors and line styles to convey information during
simulation. In this section, we describe these different drawing
styles and their semantics.
Some of the default drawing colors are as follows. During slow,
single-step, or mini-step simulation, a model element is drawn in
green while it is being evaluated. Selecting Coverage -> Show
Details configures Reactis to highlight unexercised model elements
in red and unreachable model elements in purple. Please refer to
Chapter 6 for a description of the different
coverage criteria tracked by Reactis.
| Figure 7.16: The Select Line Style dialog. |
The dialog shown in Figure 7.16 (invoked by selecting
View -> Select Line Styles...) enables you to configure
how Simulator should draw various diagram elements. Each row in
the dialog specifies the rendering of one group of model elements.
The different groups of configurable diagram elements are:
-
Uncovered Block.
- A Simulink block B is in this group
if it has not been fully exercised, i.e. one of the following
holds:
-
B is a block included in the branch coverage criterion
and at least one of B’s branches remains uncovered.
- B is a conditional subsystem that has never been exercised.
- B is a logical operator block that has not satisfied the
requirements for all MC/DC-related coverage criteria (decision,
condition, and MC/DC).
- B is a relational operator block and some boundary value
has not been exercised.
- B is a top-level inport and not all boundary values have been
exercised.
- B is a Lookup table and has uncovered lookup targets.
- B is an uncovered user-defined target.
- B is a violated assertion.
- Uncovered State.
- A Stateflow state is in this group if it
has never been entered.
- Uncovered Condition Action.
- A Stateflow transition segment
is in this group if it has not met the requirements for condition
action coverage. In other words, its condition action has never
been evaluated. If a segment has no condition action, then it is
considered uncovered according to condition action coverage if its
condition has never evaluated to true. Note that a segment with an
empty condition is assumed to evaluate to true whenever the segment
is evaluated during simulation.
- Uncovered Transition Target.
-
A Stateflow transition segment is in this group if it has met
the requirements for condition action coverage, but has not met the
requirements for one of the other coverage criteria associated with
transition segments. These criteria include transition action
coverage, decision coverage, condition coverage 2, MC/DC, and CSEPT .
- Unreachable Block.
- A Simulink block B is in this group
if Reactis has determined that some aspect of the block’s behavior
can never happen and that all behaviors that are possible have
occurred. If some reachable behavior has not occurred, then
the block is considered a member of the “Uncovered Block” group and
rendered accordingly.
- Unreachable State.
- A Stateflow state is in this group if it
can never be entered.
- Unreachable Condition Action.
- A Stateflow transition segment
is in this group if it can never meet the condition action coverage
requirement.
- Unreachable Transition Target.
-
A Stateflow transition segment is in this group if it has met
the requirements for condition action coverage, but cannot meet the
requirements for one of the other coverage criteria associated with
transition segments.
- Active Block.
- A Simulink block is in this group if it is currently
being evaluated.
- Active State.
- A Stateflow state is in this group if it is currently
active.
- Active Condition Action.
- A Stateflow transition segment is in this
group after its condition evaluates to true and until the next model element
is highlighted as active.
- Active Transition Action.
- A Stateflow transition segment is in this
group as it is firing as a part of a transition.