check that directive

Skip to main content

IAR Embedded Workbench for RL78 5.20

check that directive

In this section:

Syntax

check that expression [, "errormsg"];

Parameters

`expression`	A boolean expression.
`errormsg`	A string that is output if the check fails.

Description

You can use the check that directive to compare the results of stack usage analysis against the sizes of blocks and regions. If the expression evaluates to zero, an error is emitted.

These extra operators are available:

`maxstack("``category``")`	The stack depth of the deepest call chain for any call graph root function in the category.
`totalstack("``category``")`	The sum of the stack depths of the deepest call chains for each call graph root function in the category.
`size(block name)`	The size of the block.
`exists(block)`	Returns `1` if a block with that name has been defined, and `0` if it there is no block with that name.

Examples

check that maxstack("Program entry")
         + totalstack("interrupt")
         + 1K
         <= size(block CSTACK);

check that !(exists(block HEAP)) || size(block HEAP) >= 50, "not enough heap";

See also

Stack usage analysis.