cmd_options.h

Go to the documentation of this file.

/*! @file
@code_uid{cmd_options.h, Preprocessor macros that are usually defined on the command-line to the compiler}
@endcode_uid
*/
 
//------------------------------------------------------------------------------
/*!
@code_uid{#Q_UNSAFE, Disable the QP Functional Safety (FuSa) Subsystem}
@code_litem{Details}
Defining the macro #Q_UNSAFE (in the application-specific qp_config.h header file)
disables most of the QP FuSa Subsystem, affecting the following facilities:
- Software assertions as a recommended technique
  (called @ref def-qp-fap "failure assertion programming (FAP)" in IEC 61508-7 C.3.3)
- Software Self-Monitoring Safety Functions, which encompasses such techniques:
  + @ref def-qp_dim-dis "Duplicate Inverse Storage" for critical variables
  + @ref def-qp_cfm-lbound "Fixed Upper Loop Bound" for all loops
  + @ref def-qp_cfm-icf "Invalid Control Flow" for all unreachable code paths
 
The intent of the #Q_UNSAFE macro is to support verification (during development)
that assertions (and more generally, Safety Functions) have _no side effects_
on the primary functionality — and are truly independent from the nominal
flow of control.
 
However, quite specifically, the #Q_UNSAFE macro should _not_ be used to permanently
disable the @QPX FuSa Subsystem in the final, production release of the @QPX
Application, especially in the context of a safety-related system.
 
@attention
Disabling QP FuSa Subsystem (by defining the macro #Q_UNSAFE) in the final production
release, _contradicts_ the most fundamental principles of functional safety and
is <b>not allowed</b>  in safety-related applications.
 
@endcode_uid
*/
#define Q_UNSAFE
 
//----------------------------------------------------------------------------
/*!
@code_uid{Q_SPY, The preprocessor switch to activate the QS software tracing instrumentation in @QPX Framework and @QPX Application code}
@code_litem{Details}
When defined, #Q_SPY activates the QS software tracing instrumentation. When #Q_SPY is not defined, the QS instrumentation in the code does not generate any code.
@note
The #Q_SPY is typically defined only in the Spy build configuration and is not defined in other build configurations.
@endcode_uid
*/
#define Q_SPY
 
//----------------------------------------------------------------------------
/*!
@code_uid{Q_UTEST, The preprocessor switch to activate the QUTest testing instrumentation in @QPX Framework and @QPX Application code}
@code_litem{Details}
When defined, #Q_UTEST activates the QUTest testing instrumentation, which also requires QS software tracing (see #Q_SPY).
 
Also, the #Q_UTEST macro can have a value that decides whether the @QPX Framework "stub" is included or not. The following values are supported:
@code{c}
#define Q_UTEST   // the @QPX Framework testing "stub" is included
 
#define Q_UTEST 0 // the @QPX Framework testing "stub" is NOT included
@endcode
@note
The #Q_UTEST is typically defined only in the test fixtures.
@endcode_uid
*/
#define Q_UTEST