Collaboration diagram for Checks and Assertions:

Detailed Description

Debug APIs and services:

Runtime system state and call protocol check. The following panic messages can be generated:
- SV#1, misplaced chSysDisable().
  - Called from an ISR.
  - Called from a critical zone.
- SV#2, misplaced chSysSuspend()
  - Called from an ISR.
  - Called from a critical zone.
- SV#3, misplaced chSysEnable().
  - Called from an ISR.
  - Called from a critical zone.
- SV#4, misplaced chSysLock().
  - Called from an ISR.
  - Called from a critical zone.
- SV#5, misplaced chSysUnlock().
  - Called from an ISR.
  - Not called from a critical zone.
- SV#6, misplaced chSysLockFromISR().
  - Not called from an ISR.
  - Called from a critical zone.
- SV#7, misplaced chSysUnlockFromISR().
  - Not called from an ISR.
  - Not called from a critical zone.
- SV#8, misplaced CH_IRQ_PROLOGUE().
  - Not called at ISR begin.
  - Called from a critical zone.
- SV#9, misplaced CH_IRQ_EPILOGUE().
  - CH_IRQ_PROLOGUE() missing.
  - Not called at ISR end.
  - Called from a critical zone.
- SV#10, misplaced I-class function.
  - I-class function not called from within a critical zone.
- SV#11, misplaced S-class function.
  - S-class function not called from within a critical zone.
  - Called from an ISR.
Parameters check.
Kernel assertions.

Note: Stack checks are not implemented in this module but in the port layer in an architecture-dependent way.

Debug related settings
#define	CH_DBG_STACK_FILL_VALUE 0x55
	Fill value for thread stack area in debug mode. More...

Macro Functions
#define	chDbgCheck(c)
	Function parameters check. More...

#define	chDbgAssert(c, r)
	Condition assertion. More...

Functions
void	_dbg_check_disable (void)
	Guard code for `chSysDisable()`. More...

void	_dbg_check_suspend (void)
	Guard code for `chSysSuspend()`. More...

void	_dbg_check_enable (void)
	Guard code for `chSysEnable()`. More...

void	_dbg_check_lock (void)
	Guard code for `chSysLock()`. More...

void	_dbg_check_unlock (void)
	Guard code for `chSysUnlock()`. More...

void	_dbg_check_lock_from_isr (void)
	Guard code for `chSysLockFromIsr()`. More...

void	_dbg_check_unlock_from_isr (void)
	Guard code for `chSysUnlockFromIsr()`. More...

void	_dbg_check_enter_isr (void)
	Guard code for `CH_IRQ_PROLOGUE()`. More...

void	_dbg_check_leave_isr (void)
	Guard code for `CH_IRQ_EPILOGUE()`. More...

void	chDbgCheckClassI (void)
	I-class functions context check. More...

void	chDbgCheckClassS (void)
	S-class functions context check. More...

Macro Definition Documentation

#define CH_DBG_STACK_FILL_VALUE 0x55

Fill value for thread stack area in debug mode.

Definition at line 47 of file chdebug.h.

Referenced by chThdCreate(), chThdCreateFromHeap(), chThdCreateFromMemoryPool(), chThdCreateStatic(), and chThdCreateSuspended().

#define chDbgCheck ( c )

Value:

do {                                                  \
  /*lint -save -e506 -e774 [2.1, 14.3] Can be a constant by design.*/       \
  if (CH_DBG_ENABLE_CHECKS != FALSE) {                                      \
    if (!(c)) {                                                             \
  /*lint -restore*/                                                         \
      chSysHalt(__func__);                                                  \
    }                                                                       \
  }                                                                         \
} while (false)

Function parameters check.

If the condition check fails then the kernel panics and halts.

Note: The condition is tested only if the CH_DBG_ENABLE_CHECKS switch is specified in chconf.h else the macro does nothing.

Parameters

[in] c the condition to be verified to be true

Function Class:: Normal API, this function can be invoked by regular system threads but not from within a lock zone.

Definition at line 101 of file chdebug.h.

Referenced by chCondBroadcastI(), chCondObjectInit(), chCondSignal(), chCondSignalI(), chCondWaitS(), chCondWaitTimeoutS(), chCoreAllocAlignedWithOffsetI(), chEvtBroadcastFlagsI(), chEvtDispatch(), chEvtRegisterMaskWithFlags(), chEvtSignal(), chEvtSignalI(), chEvtUnregister(), chFifoObjectInitAligned(), chGuardedPoolLoadArray(), chHeapAllocAligned(), chHeapFree(), chHeapObjectInit(), chMBFetchI(), chMBFetchTimeoutS(), chMBObjectInit(), chMBPostAheadI(), chMBPostAheadTimeoutS(), chMBPostI(), chMBPostTimeoutS(), chMBResetI(), chMsgSend(), chMtxLockS(), chMtxObjectInit(), chMtxTryLockS(), chMtxUnlock(), chMtxUnlockS(), chPipeObjectInit(), chPipeReadTimeout(), chPipeReset(), chPipeWriteTimeout(), chPoolAllocI(), chPoolFreeI(), chPoolLoadArray(), chPoolObjectInitAligned(), chSchReadyAheadI(), chSchReadyI(), chSemAddCounterI(), chSemObjectInit(), chSemResetI(), chSemSignal(), chSemSignalI(), chSemSignalWait(), chSemWaitS(), chSemWaitTimeoutS(), chThdCreateFromMemoryPool(), chThdCreateStatic(), chThdCreateSuspendedI(), chThdSetPriority(), chThdSleepS(), chThdWait(), chTimeAddX(), chVTDoResetI(), and chVTDoSetI().

#define chDbgAssert	(	c,
		r
	)

Value:

do {                                              \
  /*lint -save -e506 -e774 [2.1, 14.3] Can be a constant by design.*/       \
  if (CH_DBG_ENABLE_ASSERTS != FALSE) {                                     \
    if (!(c)) {                                                             \
  /*lint -restore*/                                                         \
      chSysHalt(__func__);                                                  \
    }                                                                       \
  }                                                                         \
} while (false)

Condition assertion.

If the condition check fails then the kernel panics with a message and halts.

Note: The condition is tested only if the CH_DBG_ENABLE_ASSERTS switch is specified in chconf.h else the macro does nothing.; The remark string is not currently used except for putting a comment in the code about the assertion.

Parameters