<p>George Joseph <strong>submitted</strong> this change.</p><p><a href="https://gerrit.asterisk.org/c/asterisk/+/14738">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Joshua Colp: Looks good to me, but someone else must approve
George Joseph: Looks good to me, approved
Friendly Automation: Approved for Submit
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">scope_trace: Added debug messages and added additional macros<br><br>The SCOPE_ENTER and SCOPE_EXIT* macros now print debug messages<br>at the same level as the scope level. This allows the same<br>messages to be printed to the debug log when AST_DEVMODE<br>isn't enabled.<br><br>Also added a few variants of the SCOPE_EXIT macros that will<br>also call ast_log instead of ast_debug to make it easier to<br>use scope tracing and still print error messages.<br><br>Change-Id: I7fe55f7ec28069919a0fc0b11a82235ce904cc21<br>---<br>M include/asterisk/logger.h<br>1 file changed, 76 insertions(+), 10 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/include/asterisk/logger.h b/include/asterisk/logger.h</span><br><span>index 5514d83..72c938d 100644</span><br><span>--- a/include/asterisk/logger.h</span><br><span>+++ b/include/asterisk/logger.h</span><br><span>@@ -662,6 +662,7 @@</span><br><span> *</span><br><span> */</span><br><span> #define ast_trace_raw(level, indent_type, ...) \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_debug(level < 0 ? __scope_level : level, " " __VA_ARGS__); \</span><br><span> if (TRACE_ATLEAST(level)) { \</span><br><span> __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, indent_type, 0, " " __VA_ARGS__); \</span><br><span> }</span><br><span>@@ -676,6 +677,7 @@</span><br><span> * This will print the file, line and function at the current indent level</span><br><span> */</span><br><span> #define ast_trace(level, ...) \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_debug(level < 0 ? __scope_level : level, " " __VA_ARGS__); \</span><br><span> if (TRACE_ATLEAST(level)) { \</span><br><span> __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, AST_TRACE_INDENT_SAME, 0, " " __VA_ARGS__); \</span><br><span> }</span><br><span>@@ -765,6 +767,7 @@</span><br><span> #define SCOPE_ENTER(level, ...) \</span><br><span> int __scope_level = level; \</span><br><span> int __scope_task = 0; \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_debug(__scope_level, " " __VA_ARGS__); \</span><br><span> if (TRACE_ATLEAST(level)) { \</span><br><span> __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, AST_TRACE_INDENT_INC_AFTER, 0, " " __VA_ARGS__); \</span><br><span> } \</span><br><span>@@ -772,6 +775,7 @@</span><br><span> #define SCOPE_ENTER_TASK(level, indent, ...) \</span><br><span> int __scope_level = level; \</span><br><span> int __scope_task = 1; \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_debug(__scope_level, " " __VA_ARGS__); \</span><br><span> if (TRACE_ATLEAST(level)) { \</span><br><span> __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, AST_TRACE_INDENT_PROVIDED, indent, " " __VA_ARGS__); \</span><br><span> } \</span><br><span>@@ -786,6 +790,7 @@</span><br><span> * This macro can be used at the exit points of a statement block since it just prints the message.</span><br><span> */</span><br><span> #define SCOPE_EXIT(...) \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_debug(__scope_level, " " __VA_ARGS__); \</span><br><span> if (TRACE_ATLEAST(__scope_level)) { \</span><br><span> __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, AST_TRACE_INDENT_DEC_BEFORE, 0, " " __VA_ARGS__); \</span><br><span> if (__scope_task) { \</span><br><span>@@ -814,6 +819,7 @@</span><br><span> * }</span><br><span> */</span><br><span> #define SCOPE_EXIT_EXPR(__expr, ...) \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_debug(__scope_level, " " __VA_ARGS__); \</span><br><span> if (TRACE_ATLEAST(__scope_level)) { \</span><br><span> __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, AST_TRACE_INDENT_DEC_BEFORE, 0, " " __VA_ARGS__); \</span><br><span> if (__scope_task) { \</span><br><span>@@ -833,6 +839,7 @@</span><br><span> * needs to be returned.</span><br><span> */</span><br><span> #define SCOPE_EXIT_RTN(...) \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_debug(__scope_level, " " __VA_ARGS__); \</span><br><span> if (TRACE_ATLEAST(__scope_level)) { \</span><br><span> __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, AST_TRACE_INDENT_DEC_BEFORE, 0, " " __VA_ARGS__); \</span><br><span> if (__scope_task) { \</span><br><span>@@ -853,6 +860,7 @@</span><br><span> * needs to be returned.</span><br><span> */</span><br><span> #define SCOPE_EXIT_RTN_VALUE(__return_value, ...) \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_debug(__scope_level, " " __VA_ARGS__); \</span><br><span> if (TRACE_ATLEAST(__scope_level)) { \</span><br><span> __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, AST_TRACE_INDENT_DEC_BEFORE, 0, " " __VA_ARGS__); \</span><br><span> if (__scope_task) { \</span><br><span>@@ -861,21 +869,79 @@</span><br><span> } \</span><br><span> return(__return_value)</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-#else</span><br><span style="color: hsl(0, 100%, 40%);">-#define ast_trace_raw(__level, __indent_type, ...)</span><br><span style="color: hsl(0, 100%, 40%);">-#define ast_trace(__level, ...)</span><br><span style="color: hsl(120, 100%, 40%);">+#else /* AST_DEVMODE */</span><br><span style="color: hsl(120, 100%, 40%);">+#define ast_trace_raw(level, indent_type, ...) \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_debug(level < 0 ? __scope_level : level, " " __VA_ARGS__)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#define ast_trace(level, ...) \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_debug(level < 0 ? __scope_level : level, " " __VA_ARGS__)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> #define ast_trace_get_indent() (0)</span><br><span> #define ast_trace_set_indent(indent)</span><br><span> #define ast_trace_inc_indent()</span><br><span> #define ast_trace_dec_indent()</span><br><span> #define SCOPE_TRACE(__level, ...)</span><br><span style="color: hsl(0, 100%, 40%);">-#define SCOPE_ENTER(level, ...)</span><br><span style="color: hsl(0, 100%, 40%);">-#define SCOPE_ENTER_TASK(level, indent, ...)</span><br><span style="color: hsl(0, 100%, 40%);">-#define SCOPE_EXIT(...)</span><br><span style="color: hsl(0, 100%, 40%);">-#define SCOPE_EXIT_EXPR(__expr, ...) __expr</span><br><span style="color: hsl(0, 100%, 40%);">-#define SCOPE_EXIT_RTN(...) return</span><br><span style="color: hsl(0, 100%, 40%);">-#define SCOPE_EXIT_RTN_VALUE(__return_value, ...) return __return_value</span><br><span style="color: hsl(0, 100%, 40%);">-#endif</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#define SCOPE_ENTER(level, ...) \</span><br><span style="color: hsl(120, 100%, 40%);">+ int __scope_level = level; \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_debug(level, " " __VA_ARGS__)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#define SCOPE_ENTER_TASK(level, indent, ...) \</span><br><span style="color: hsl(120, 100%, 40%);">+ int __scope_level = level; \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_debug(level, " " __VA_ARGS__)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#define SCOPE_EXIT(...) \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_debug(__scope_level, " " __VA_ARGS__)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#define SCOPE_EXIT_EXPR(__expr, ...) \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_debug(__scope_level, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+ __expr</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#define SCOPE_EXIT_RTN(...) \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_debug(__scope_level, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+ return</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#define SCOPE_EXIT_RTN_VALUE(__return_value, ...) \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_debug(__scope_level, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+ return __return_value</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#endif /* AST_DEVMODE */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * The following macros will print log messages before running</span><br><span style="color: hsl(120, 100%, 40%);">+ * the associated SCOPE_ macro.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#define SCOPE_EXIT_LOG(__log_level, ...) \</span><br><span style="color: hsl(120, 100%, 40%);">+({ \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_log(__log_level, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+ SCOPE_EXIT(" " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+})</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#define SCOPE_EXIT_LOG_RTN(__log_level, ...) \</span><br><span style="color: hsl(120, 100%, 40%);">+({ \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_log(__log_level, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+ SCOPE_EXIT_RTN(" " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+})</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#define SCOPE_EXIT_LOG_RTN_VALUE(__value, __log_level, ...) \</span><br><span style="color: hsl(120, 100%, 40%);">+({ \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_log(__log_level, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+ SCOPE_EXIT_RTN_VALUE(__value, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+})</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#define SCOPE_EXIT_LOG_EXPR(__expr, __log_level, ...) \</span><br><span style="color: hsl(120, 100%, 40%);">+({ \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_log(__log_level, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+ SCOPE_EXIT_EXPR(__expr, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+})</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#define ast_trace_log(__level, __log_level, ...) \</span><br><span style="color: hsl(120, 100%, 40%);">+({ \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_log(__log_level, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_trace(__level < 0 ? __scope_level : __level, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+})</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> </span><br><span> #if defined(__cplusplus) || defined(c_plusplus)</span><br><span> }</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.asterisk.org/c/asterisk/+/14738">change 14738</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.asterisk.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.asterisk.org/c/asterisk/+/14738"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: asterisk </div>
<div style="display:none"> Gerrit-Branch: certified/16.8 </div>
<div style="display:none"> Gerrit-Change-Id: I7fe55f7ec28069919a0fc0b11a82235ce904cc21 </div>
<div style="display:none"> Gerrit-Change-Number: 14738 </div>
<div style="display:none"> Gerrit-PatchSet: 5 </div>
<div style="display:none"> Gerrit-Owner: George Joseph <gjoseph@digium.com> </div>
<div style="display:none"> Gerrit-Reviewer: Friendly Automation </div>
<div style="display:none"> Gerrit-Reviewer: George Joseph <gjoseph@digium.com> </div>
<div style="display:none"> Gerrit-Reviewer: Joshua Colp <jcolp@sangoma.com> </div>
<div style="display:none"> Gerrit-Reviewer: Kevin Harwell <kharwell@digium.com> </div>
<div style="display:none"> Gerrit-MessageType: merged </div>