// Copyright (c) Microsoft Corporation. // Licensed under the MIT license. #pragma once #ifndef MSO_DEBUGASSERTAPI_DEBUGASSERTAPI_H #define MSO_DEBUGASSERTAPI_DEBUGASSERTAPI_H /** API for debug asserts. Must support C callers */ #ifndef RC_INVOKED #pragma pack(push, 8) #include #include #include #include #include /** Basic debug assert macros to use. Assert: evaluate in debug, call the debug handler on failure AssertDo: always evaluate, call the debug handler on failure */ #define Assert(f) AssertTag(f, UNTAGGED) #define AssertSz(f, _sz) AssertSzTag(f, _sz, UNTAGGED) #define AssertSz0(f, _sz) AssertSzTag(f, _sz, UNTAGGED) #define AssertSz1(f, _sz, a) AssertSz1Tag(f, _sz, a, UNTAGGED) #define AssertSz2(f, _sz, a, b) AssertSz2Tag(f, _sz, a, b, UNTAGGED) #define AssertSz3(f, _sz, a, b, c) AssertSz3Tag(f, _sz, a, b, c, UNTAGGED) #define AssertSz4(f, _sz, a, b, c, d) AssertSz4Tag(f, _sz, a, b, c, d, UNTAGGED) #define AssertSz5(f, _sz, a, b, c, d, e) AssertSz5Tag(f, _sz, a, b, c, d, e, UNTAGGED) #define AssertDo(f) AssertDoTag(f, UNTAGGED) #define AssertDoSz(f, _sz) AssertDoSzTag(f, _sz, UNTAGGED) #define AssertDoSz1(f, _sz, a) AssertDoSz1Tag(f, _sz, a, UNTAGGED) #define AssertDoSz2(f, _sz, a, b) AssertDoSz2Tag(f, _sz, a, b, UNTAGGED) #define AssertDoSz3(f, _sz, a, b, c) AssertDoSz3Tag(f, _sz, a, b, c, UNTAGGED) #define AssertDoSz4(f, _sz, a, b, c, d) AssertDoSz4Tag(f, _sz, a, b, c, d, UNTAGGED) #define AssertDoSz5(f, _sz, a, b, c, d, e) AssertDoSz5Tag(f, _sz, a, b, c, d, e, UNTAGGED) /** The following macros can be used to assert inside an expression. Note: Always returns (f), the assert is purely a side-effect. LATER: add more if needed or ShipAssert versions. if (FAssertDo(f)) { ... } // same as "if (f) { ... } else Assert(false);" */ #define FAssertDo(f) FAssertDoTag(f, UNTAGGED) #define FAssertDoSz(f, _sz) FAssertDoSzTag(f, _sz, UNTAGGED) #define FAssertDoSz1(f, _sz, a) FAssertDoSz1Tag(f, _sz, a, UNTAGGED) #define FAssertDoSz2(f, _sz, a, b) FAssertDoSz2Tag(f, _sz, a, b, UNTAGGED) #ifdef __cplusplus #define AssertDetails_SzCast(sz) static_cast(sz) #else #define AssertDetails_SzCast(sz) (const char *)(sz) #endif /** Suppressed warnings in Assert macros: C4127 - if/while loop condition is a constant C4389 - operation involved signed/unsigned variables 6239 - OACR left expression is always false 25011 - OACR missing 'break' or '__fallthrough' statement 25037 - OACR expression is always false 25038 - OACR expression is always false 25039 - OACR expression is always true 25041 - OACR if/while loop condition is true 25042 - OACR if/while loop condition is false 25064 - OACR function called twice in macro */ #define AssertDetails_Statement_Begin \ __pragma(warning(push)) __pragma(warning(disable : 4127 4389 6239 25037 25038 25039 25041 25042 25064 25306)) do { #define AssertDetails_Statement_End \ } \ while (0) \ __pragma(warning(suppress : 25011)) __pragma(warning(pop)) // NOTE: OACR_ASSUME uses the Assert macro, so oacr.h must be included after Assert is defined #include "oacr/oacr.h" /** Return Address FUTURE: get rid of this and just use void* */ typedef struct _MSORADDR { void *pfnCaller; } MSORADDR; /** Ugly workarounds to support C callers, essentially: C++: pass by reference, use constructor C : pass by pointer, use initializer list */ #if defined(__cplusplus) using MsoAssertParamsType = const struct _MsoAssertParams &; #ifdef DEBUG #define DeclareMsoAssertParams(...) MsoAssertParams params(__VA_ARGS__) #else #define DeclareMsoAssertParams(...) #endif // DEBUG #define AccessMsoAssertParams(_p) (&(_p)) #define InlineMsoAssertParams(...) MsoAssertParams(__VA_ARGS__) #define DeclareInlineMsoAssertParams(_p) #define PassMsoAssertParams(_p) _p #else // __cplusplus typedef struct _MsoAssertParams *MsoAssertParamsType; #ifdef DEBUG #define DeclareMsoAssertParams(...) (__pragma(warning(suppress : 4204)) MsoAssertParams params = {__VA_ARGS__}) #else #define DeclareMsoAssertParams(...) #endif // DEBUG #define AccessMsoAssertParams(_p) _p #define InlineMsoAssertParams(szCondition, ...) DeclareMsoAssertParams(__VA_ARGS__) #define DeclareInlineMsoAssertParamsUnwrap(...) __VA_ARGS__ #define DeclareInlineMsoAssertParams(_p) DeclareInlineMsoAssertParamsUnwrap _p #define PassMsoAssertParams(_p) ¶ms #endif // __cplusplus #ifdef DEBUG /** Various parameters that can be passed to the assert functions. This structure is duplicated in MotifTest project. */ typedef struct _MsoAssertParams { uint32_t dwTag; const char *szFile; uint32_t iLine; const char *szTitle; const MSORADDR *rgCallstack; uint32_t cCallstack; const char *szCondition; // Skip this many frames if a callstack is generated. #ifdef __cplusplus mutable #endif // __cplusplus uint32_t framesToSkip; #ifdef __cplusplus explicit _MsoAssertParams( uint32_t dwTagLocal = UNTAGGED, _In_z_ const char *szFileLocal = __FILE__, uint32_t iLineLocal = __LINE__, _In_opt_z_ const char *szTitleLocal = nullptr, _In_opt_count_(cCallstackLocal) const MSORADDR *rgCallstackLocal = nullptr, uint32_t cCallstackLocal = 0, _In_opt_z_ const char *szConditionLocal = "false") MSONOEXCEPT : dwTag(dwTagLocal), szFile(szFileLocal), iLine(iLineLocal), szTitle(szTitleLocal), rgCallstack(rgCallstackLocal), cCallstack(cCallstackLocal), szCondition(szConditionLocal), framesToSkip(0) {} explicit _MsoAssertParams( _In_z_ const char *szConditionLocal, uint32_t dwTagLocal, _In_z_ const char *szFileLocal, int32_t iLineLocal) MSONOEXCEPT : dwTag(dwTagLocal), szFile(szFileLocal), iLine(static_cast(iLineLocal)), szTitle(nullptr), rgCallstack(nullptr), cCallstack(0), szCondition(szConditionLocal), framesToSkip(0) {} #endif // __cplusplus } MsoAssertParams; /** Function for handling asserts with strings. Return value is AssertResult. Note: this function has to be callable from C code */ #if defined(__cplusplus) extern "C" { #endif // C++ LIBLET_PUBLICAPI int32_t MsoAssertSzTagProc(MsoAssertParamsType params, _Printf_format_string_ const char *szFmt, va_list argList) MSONOEXCEPT; #if defined(__cplusplus) } #endif // C++ #endif // DEBUG #include "debugAssertDetails.h" #ifdef DEBUG #ifdef __cplusplus namespace Mso { namespace DebugAsserts { using AssertIgnorer = bool (*)(const MsoAssertParams ¶ms, const char *szMsg); /** Add an assert ignorer for this process. Note: this API is not thread-safe. */ LIBLET_PUBLICAPI void AddAssertIgnorer(AssertIgnorer ignorer) noexcept; /** Remove an assert ignorer for this process. Note: this API is not thread-safe. */ LIBLET_PUBLICAPI void RemoveAssertIgnorer(AssertIgnorer ignorer) noexcept; struct AutoRegisterAssertIgnorer { AutoRegisterAssertIgnorer(AssertIgnorer ignorer) noexcept : m_ignorer(ignorer) { AddAssertIgnorer(m_ignorer); } ~AutoRegisterAssertIgnorer() noexcept { RemoveAssertIgnorer(m_ignorer); } private: AssertIgnorer m_ignorer; }; using AssertListener = void (*)(const MsoAssertParams ¶ms, const char *szMsg); /** Add an assert listener for this process. Note: this API is not thread-safe. */ LIBLET_PUBLICAPI void AddAssertListener(AssertListener listener) noexcept; /** Remove a previously registered assert listener for this process. Note: this API is not thread-safe. */ LIBLET_PUBLICAPI void RemoveAssertListener(AssertListener listener) noexcept; struct AutoRegisterAssertListener { AutoRegisterAssertListener(AssertListener listener) noexcept : m_listener(listener) { AddAssertListener(m_listener); } ~AutoRegisterAssertListener() noexcept { RemoveAssertListener(m_listener); } private: AssertListener m_listener; }; using AssertHandler = AssertResult (*)(const MsoAssertParams ¶ms, const char *szMsg); /** Set the assert handler for this process. The previous handler is returned. Note: this API is not thread-safe. */ LIBLET_PUBLICAPI AssertHandler SetAssertHandler(AssertHandler handler) noexcept; /** Get the current assert handler for this process. */ LIBLET_PUBLICAPI AssertHandler GetAssertHandler() noexcept; struct AutoRegisterAssertHandler { AutoRegisterAssertHandler(AssertHandler handler) noexcept : m_previous(SetAssertHandler(handler)) {} ~AutoRegisterAssertHandler() noexcept { SetAssertHandler(m_previous); } private: AssertHandler m_previous; }; } // namespace DebugAsserts } // namespace Mso #endif // __cplusplus #endif // DEBUG #pragma pack(pop) #endif // RC_INVOKED #endif // MSO_DEBUGASSERTAPI_DEBUGASSERTAPI_H