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.

Collaboration diagram for Checks and Assertions:

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

Macro Functions
#define	chDbgCheck(c)
	Function parameters check.
#define	chDbgAssert(c, r)
	Condition assertion.

Data Structures
struct	ch_system_debug
	System debug data structure. More...

Macros
#define	__dbg_check_disable()
#define	__dbg_check_suspend()
#define	__dbg_check_enable()
#define	__dbg_check_lock()
#define	__dbg_check_unlock()
#define	__dbg_check_lock_from_isr()
#define	__dbg_check_unlock_from_isr()
#define	__dbg_check_enter_isr()
#define	__dbg_check_leave_isr()
#define	chDbgCheckClassI()
#define	chDbgCheckClassS()

Typedefs
typedef struct ch_system_debug	system_debug_t
	System debug data structure.

Functions
void	__dbg_check_disable (void)
	Guard code for `chSysDisable()`.
void	__dbg_check_suspend (void)
	Guard code for `chSysSuspend()`.
void	__dbg_check_enable (void)
	Guard code for `chSysEnable()`.
void	__dbg_check_lock (void)
	Guard code for `chSysLock()`.
void	__dbg_check_unlock (void)
	Guard code for `chSysUnlock()`.
void	__dbg_check_lock_from_isr (void)
	Guard code for `chSysLockFromIsr()`.
void	__dbg_check_unlock_from_isr (void)
	Guard code for `chSysUnlockFromIsr()`.
void	__dbg_check_enter_isr (void)
	Guard code for `CH_IRQ_PROLOGUE()`.
void	__dbg_check_leave_isr (void)
	Guard code for `CH_IRQ_EPILOGUE()`.
void	chDbgCheckClassI (void)
	I-class functions context check.
void	chDbgCheckClassS (void)
	S-class functions context check.
static void	__dbg_object_init (system_debug_t *sdp)
	Debug support initialization.

Macro Definition Documentation

◆ __dbg_check_disable

void __dbg_check_disable ( )

Definition at line 90 of file chdebug.h.

Referenced by chSysDisable().

◆ __dbg_check_suspend

void __dbg_check_suspend ( )

Definition at line 91 of file chdebug.h.

Referenced by chSysSuspend().

◆ __dbg_check_enable

void __dbg_check_enable ( )

Definition at line 92 of file chdebug.h.

Referenced by chSysEnable().

◆ __dbg_check_lock

void __dbg_check_lock ( )

Definition at line 93 of file chdebug.h.

Referenced by chSysLock().

◆ __dbg_check_unlock

void __dbg_check_unlock ( )

Definition at line 94 of file chdebug.h.

Referenced by chSysUnlock().

◆ __dbg_check_lock_from_isr

void __dbg_check_lock_from_isr ( )

Definition at line 95 of file chdebug.h.

Referenced by chSysLockFromISR().

◆ __dbg_check_unlock_from_isr

void __dbg_check_unlock_from_isr ( )

Definition at line 96 of file chdebug.h.

Referenced by chSysUnlockFromISR().

◆ __dbg_check_enter_isr

void __dbg_check_enter_isr ( )

Definition at line 97 of file chdebug.h.

◆ __dbg_check_leave_isr

void __dbg_check_leave_isr ( )

Definition at line 98 of file chdebug.h.

◆ chDbgCheckClassI

void chDbgCheckClassI ( )

Definition at line 99 of file chdebug.h.

Referenced by chBSemGetStateI(), chBSemResetI(), chBSemSignalI(), chCondBroadcastI(), chCondSignalI(), chCoreAllocFromBaseI(), chCoreAllocFromTopI(), chEvtBroadcastFlagsI(), chEvtGetAndClearEventsI(), chEvtGetAndClearFlagsI(), chEvtRegisterMaskWithFlagsI(), chEvtSignalI(), chMBFetchI(), chMBGetFreeCountI(), chMBGetUsedCountI(), chMBPeekI(), chMBPostAheadI(), chMBPostI(), chMBResetI(), chMsgIsPendingI(), chMtxGetOwnerI(), chPoolAllocI(), chPoolFreeI(), chSchReadyI(), chSemAddCounterI(), chSemFastSignalI(), chSemFastWaitI(), chSemGetCounterI(), chSemResetWithMessageI(), chSemSignalI(), chSysIntegrityCheckI(), chSysTimerHandlerI(), chThdCreateSuspendedI(), chThdQueueIsEmptyI(), chTraceResumeI(), chTraceSuspendI(), chTraceWriteI(), chVTDoResetI(), chVTDoSetContinuousI(), chVTDoSetI(), chVTDoTickI(), chVTGetRemainingIntervalI(), chVTGetTimersStateI(), chVTGetTimeStampI(), chVTIsArmedI(), and chVTResetTimeStampI().

◆ chDbgCheckClassS

void chDbgCheckClassS ( )

◆ CH_DBG_STACK_FILL_VALUE

#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 __thd_stackfill().

◆ chDbgCheck

#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 (unlikely(!(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 118 of file chdebug.h.

Referenced by chCacheObjectInit(), chCondBroadcastI(), chCondObjectInit(), chCondSignal(), chCondSignalI(), chCondWaitS(), chCondWaitTimeoutS(), chCoreAllocFromBaseI(), chCoreAllocFromTopI(), chEvtBroadcastFlagsI(), chEvtDispatch(), chEvtGetAndClearFlags(), chEvtGetAndClearFlagsI(), chEvtRegisterMaskWithFlags(), chEvtRegisterMaskWithFlagsI(), chEvtSignal(), chEvtSignalI(), chEvtUnregister(), chFifoObjectInitAligned(), chGuardedPoolLoadArray(), chHeapAllocAligned(), chHeapFree(), chHeapObjectInit(), chJobObjectInit(), chMBFetchI(), chMBFetchTimeoutS(), chMBObjectInit(), chMBPostAheadI(), chMBPostAheadTimeoutS(), chMBPostI(), chMBPostTimeoutS(), chMBResetI(), chMsgSend(), chMtxLockS(), chMtxObjectInit(), chMtxTryLockS(), chMtxUnlock(), chMtxUnlockS(), chPipeObjectInit(), chPipeReadTimeout(), chPipeReset(), chPipeWriteTimeout(), chPoolAllocI(), chPoolFreeI(), chPoolLoadArray(), chPoolObjectInitAligned(), chSchReadyI(), chSchReadyI(), chSemAddCounterI(), chSemObjectInit(), chSemResetWithMessageI(), chSemSignal(), chSemSignalI(), chSemSignalWait(), chSemWaitS(), chSemWaitTimeoutS(), chThdCreateFromMemoryPool(), chThdCreateI(), chThdCreateStatic(), chThdCreateSuspendedI(), chThdDequeueAllI(), chThdDequeueNextI(), chThdEnqueueTimeoutS(), chThdSetPriority(), chThdSleepS(), chThdWait(), chTimeAddX(), chVTDoResetI(), chVTDoSetContinuousI(), chVTDoSetI(), dyn_create_object_heap(), dyn_create_object_pool(), dyn_find_object(), dyn_release_object_heap(), and dyn_release_object_pool().

◆ chDbgAssert

#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 (unlikely(!(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