<p>Friendly Automation <strong>submitted</strong> this change.</p><p><a href="https://gerrit.asterisk.org/c/asterisk/+/14627">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Joshua Colp: Looks good to me, but someone else must approve
Kevin Harwell: Looks good to me, approved
Friendly Automation: Approved for Submit
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">Scope Trace: Make it easier to trace through synchronous tasks<br><br>Tracing through synchronous tasks was a little troublesome because<br>the new thread's stack counter reset to 0. This change allows<br>a synchronous task to set its trace level to be the same as the<br>thread that pushed the task. For now, the task's level has to be<br>passed in the task's data structure but a future enhancement to the<br>taskprocessor subsystem could automatically set the trace level<br>of the servant to be that of the caller.<br><br>This doesn't really make sense for async tasks because you never<br>know when they're going to run anyway.<br><br>Change-Id: Ib8049c0b815063a45d8c7b0cb4e30b7b87b1d825<br>---<br>M include/asterisk/logger.h<br>M main/logger.c<br>2 files changed, 108 insertions(+), 19 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 67e4df7..5514d83 100644</span><br><span>--- a/include/asterisk/logger.h</span><br><span>+++ b/include/asterisk/logger.h</span><br><span>@@ -641,14 +641,16 @@</span><br><span> AST_TRACE_INDENT_DEC_BEFORE,</span><br><span> /*! Decrement the indent after printing the message */</span><br><span> AST_TRACE_INDENT_DEC_AFTER,</span><br><span style="color: hsl(120, 100%, 40%);">+ /*! Set the indent to the one provided */</span><br><span style="color: hsl(120, 100%, 40%);">+ AST_TRACE_INDENT_PROVIDED,</span><br><span> /*! Don't use or alter the level */</span><br><span> AST_TRACE_INDENT_NONE,</span><br><span> };</span><br><span> </span><br><span> #ifdef AST_DEVMODE</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-void __attribute__((format (printf, 5, 6))) __ast_trace(const char *file, int line, const char *func,</span><br><span style="color: hsl(0, 100%, 40%);">- enum ast_trace_indent_type indent_type, const char* format, ...);</span><br><span style="color: hsl(120, 100%, 40%);">+void __attribute__((format (printf, 6, 7))) __ast_trace(const char *file, int line, const char *func,</span><br><span style="color: hsl(120, 100%, 40%);">+ enum ast_trace_indent_type indent_type, unsigned long indent, const char* format, ...);</span><br><span> </span><br><span> /*!</span><br><span> * \brief Print a trace message</span><br><span>@@ -661,7 +663,7 @@</span><br><span> */</span><br><span> #define ast_trace_raw(level, indent_type, ...) \</span><br><span> if (TRACE_ATLEAST(level)) { \</span><br><span style="color: hsl(0, 100%, 40%);">- __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, indent_type, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+ __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, indent_type, 0, " " __VA_ARGS__); \</span><br><span> }</span><br><span> </span><br><span> /*!</span><br><span>@@ -675,10 +677,42 @@</span><br><span> */</span><br><span> #define ast_trace(level, ...) \</span><br><span> if (TRACE_ATLEAST(level)) { \</span><br><span style="color: hsl(0, 100%, 40%);">- __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, AST_TRACE_INDENT_SAME, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+ __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, AST_TRACE_INDENT_SAME, 0, " " __VA_ARGS__); \</span><br><span> }</span><br><span> </span><br><span> /*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Get the current indent level</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns The current indent level</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+unsigned long _ast_trace_get_indent(void);</span><br><span style="color: hsl(120, 100%, 40%);">+#define ast_trace_get_indent() _ast_trace_get_indent()</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%);">+ * \brief Set the current indent level</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param indent The new indent level</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+void _ast_trace_set_indent(unsigned long indent);</span><br><span style="color: hsl(120, 100%, 40%);">+#define ast_trace_set_indent(indent) _ast_trace_set_indent(indent)</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%);">+ * \brief Increment the indent level</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns The new indent level</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+unsigned long _ast_trace_inc_indent(void);</span><br><span style="color: hsl(120, 100%, 40%);">+#define ast_trace_inc_indent() _ast_trace_inc_indent()</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%);">+ * \brief Decrement the indent level</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns The new indent level</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+unsigned long _ast_trace_dec_indent(void);</span><br><span style="color: hsl(120, 100%, 40%);">+#define ast_trace_dec_indent() _ast_trace_dec_indent()</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span> * \brief Print a trace message with details when a scope is entered or existed.</span><br><span> *</span><br><span> * \param level The trace level</span><br><span>@@ -702,14 +736,14 @@</span><br><span> auto void __scopevar ## __LINE__ ## __EXIT(void * v); \</span><br><span> void __scopevar ## __LINE__ ## __EXIT(void * v __attribute__((unused))) { \</span><br><span> if (TRACE_ATLEAST(level)) { \</span><br><span style="color: hsl(0, 100%, 40%);">- __ast_trace(__FILE__, __LINE__, __trace_funcname, AST_TRACE_INDENT_DEC_BEFORE, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+ __ast_trace(__FILE__, __LINE__, __trace_funcname, AST_TRACE_INDENT_DEC_BEFORE, 0, " " __VA_ARGS__); \</span><br><span> } \</span><br><span> } \</span><br><span> void *__scopevar ## __LINE__ ## __TRACER __attribute__((cleanup(__scopevar ## __LINE__ ## __EXIT))) = (void *) __PRETTY_FUNCTION__ ; \</span><br><span> auto int __scopevar ## __LINE__ ## __ENTER(void); \</span><br><span> int __scopevar ## __LINE__ ## __ENTER(void) { \</span><br><span> if (TRACE_ATLEAST(level)) { \</span><br><span style="color: hsl(0, 100%, 40%);">- __ast_trace(__FILE__, __LINE__, __trace_funcname, AST_TRACE_INDENT_INC_AFTER, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+ __ast_trace(__FILE__, __LINE__, __trace_funcname, AST_TRACE_INDENT_INC_AFTER, 0, " " __VA_ARGS__); \</span><br><span> } \</span><br><span> return 0; \</span><br><span> } \</span><br><span>@@ -730,8 +764,16 @@</span><br><span> */</span><br><span> #define SCOPE_ENTER(level, ...) \</span><br><span> int __scope_level = level; \</span><br><span style="color: hsl(120, 100%, 40%);">+ int __scope_task = 0; \</span><br><span> if (TRACE_ATLEAST(level)) { \</span><br><span style="color: hsl(0, 100%, 40%);">- __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, AST_TRACE_INDENT_INC_AFTER, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+ __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, AST_TRACE_INDENT_INC_AFTER, 0, " " __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_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%);">+ int __scope_task = 1; \</span><br><span style="color: hsl(120, 100%, 40%);">+ if (TRACE_ATLEAST(level)) { \</span><br><span style="color: hsl(120, 100%, 40%);">+ __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, AST_TRACE_INDENT_PROVIDED, indent, " " __VA_ARGS__); \</span><br><span> } \</span><br><span> </span><br><span> /*!</span><br><span>@@ -745,7 +787,10 @@</span><br><span> */</span><br><span> #define SCOPE_EXIT(...) \</span><br><span> if (TRACE_ATLEAST(__scope_level)) { \</span><br><span style="color: hsl(0, 100%, 40%);">- __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, AST_TRACE_INDENT_DEC_BEFORE, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+ __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, AST_TRACE_INDENT_DEC_BEFORE, 0, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+ if (__scope_task) { \</span><br><span style="color: hsl(120, 100%, 40%);">+ _ast_trace_set_indent(0); \</span><br><span style="color: hsl(120, 100%, 40%);">+ } \</span><br><span> } \</span><br><span> </span><br><span> /*!</span><br><span>@@ -770,7 +815,10 @@</span><br><span> */</span><br><span> #define SCOPE_EXIT_EXPR(__expr, ...) \</span><br><span> if (TRACE_ATLEAST(__scope_level)) { \</span><br><span style="color: hsl(0, 100%, 40%);">- __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, AST_TRACE_INDENT_DEC_BEFORE, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+ __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, AST_TRACE_INDENT_DEC_BEFORE, 0, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+ if (__scope_task) { \</span><br><span style="color: hsl(120, 100%, 40%);">+ _ast_trace_set_indent(0); \</span><br><span style="color: hsl(120, 100%, 40%);">+ } \</span><br><span> } \</span><br><span> __expr</span><br><span> </span><br><span>@@ -786,7 +834,10 @@</span><br><span> */</span><br><span> #define SCOPE_EXIT_RTN(...) \</span><br><span> if (TRACE_ATLEAST(__scope_level)) { \</span><br><span style="color: hsl(0, 100%, 40%);">- __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, AST_TRACE_INDENT_DEC_BEFORE, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+ __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, AST_TRACE_INDENT_DEC_BEFORE, 0, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+ if (__scope_task) { \</span><br><span style="color: hsl(120, 100%, 40%);">+ _ast_trace_set_indent(0); \</span><br><span style="color: hsl(120, 100%, 40%);">+ } \</span><br><span> } \</span><br><span> return</span><br><span> </span><br><span>@@ -803,19 +854,27 @@</span><br><span> */</span><br><span> #define SCOPE_EXIT_RTN_VALUE(__return_value, ...) \</span><br><span> if (TRACE_ATLEAST(__scope_level)) { \</span><br><span style="color: hsl(0, 100%, 40%);">- __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, AST_TRACE_INDENT_DEC_BEFORE, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+ __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, AST_TRACE_INDENT_DEC_BEFORE, 0, " " __VA_ARGS__); \</span><br><span style="color: hsl(120, 100%, 40%);">+ if (__scope_task) { \</span><br><span style="color: hsl(120, 100%, 40%);">+ _ast_trace_set_indent(0); \</span><br><span style="color: hsl(120, 100%, 40%);">+ } \</span><br><span> } \</span><br><span> return(__return_value)</span><br><span> </span><br><span> #else</span><br><span> #define ast_trace_raw(__level, __indent_type, ...)</span><br><span> #define ast_trace(__level, ...)</span><br><span style="color: hsl(120, 100%, 40%);">+#define ast_trace_get_indent() (0)</span><br><span style="color: hsl(120, 100%, 40%);">+#define ast_trace_set_indent(indent)</span><br><span style="color: hsl(120, 100%, 40%);">+#define ast_trace_inc_indent()</span><br><span style="color: hsl(120, 100%, 40%);">+#define ast_trace_dec_indent()</span><br><span> #define SCOPE_TRACE(__level, ...)</span><br><span> #define SCOPE_ENTER(level, ...)</span><br><span style="color: hsl(120, 100%, 40%);">+#define SCOPE_ENTER_TASK(level, indent, ...)</span><br><span> #define SCOPE_EXIT(...)</span><br><span style="color: hsl(0, 100%, 40%);">-#define SCOPE_EXIT_EXPR(__expr, ...)</span><br><span style="color: hsl(0, 100%, 40%);">-#define SCOPE_EXIT_RTN(...)</span><br><span style="color: hsl(0, 100%, 40%);">-#define SCOPE_EXIT_RTN_VALUE(__return_value, ...)</span><br><span style="color: hsl(120, 100%, 40%);">+#define SCOPE_EXIT_EXPR(__expr, ...) __expr</span><br><span style="color: hsl(120, 100%, 40%);">+#define SCOPE_EXIT_RTN(...) return</span><br><span style="color: hsl(120, 100%, 40%);">+#define SCOPE_EXIT_RTN_VALUE(__return_value, ...) return __return_value</span><br><span> #endif</span><br><span> </span><br><span> #if defined(__cplusplus) || defined(c_plusplus)</span><br><span>diff --git a/main/logger.c b/main/logger.c</span><br><span>index c66d820..8894b05 100644</span><br><span>--- a/main/logger.c</span><br><span>+++ b/main/logger.c</span><br><span>@@ -2287,9 +2287,36 @@</span><br><span> AST_THREADSTORAGE_RAW(trace_indent);</span><br><span> #define LOTS_O_SPACES " "</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+unsigned long _ast_trace_get_indent(void)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ return (unsigned long)ast_threadstorage_get_ptr(&trace_indent);</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%);">+void _ast_trace_set_indent(unsigned long indent)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_threadstorage_set_ptr(&trace_indent, (void*)indent);</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%);">+unsigned long _ast_trace_inc_indent(void)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ unsigned long indent = (unsigned long)ast_threadstorage_get_ptr(&trace_indent);</span><br><span style="color: hsl(120, 100%, 40%);">+ indent++;</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_threadstorage_set_ptr(&trace_indent, (void*)indent);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return indent;</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%);">+unsigned long _ast_trace_dec_indent(void)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ unsigned long indent = (unsigned long)ast_threadstorage_get_ptr(&trace_indent);</span><br><span style="color: hsl(120, 100%, 40%);">+ indent--;</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_threadstorage_set_ptr(&trace_indent, (void*)indent);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return indent;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span> </span><br><span> void __ast_trace(const char *file, int line, const char *func, enum ast_trace_indent_type indent_type,</span><br><span style="color: hsl(0, 100%, 40%);">- const char* format, ...)</span><br><span style="color: hsl(120, 100%, 40%);">+ unsigned long new_indent, const char* format, ...)</span><br><span> {</span><br><span> va_list ap;</span><br><span> unsigned long indent = (unsigned long)ast_threadstorage_get_ptr(&trace_indent);</span><br><span>@@ -2300,11 +2327,13 @@</span><br><span> return;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- if (indent_type == AST_TRACE_INDENT_INC_BEFORE) {</span><br><span style="color: hsl(120, 100%, 40%);">+ if (indent_type == AST_TRACE_INDENT_PROVIDED) {</span><br><span style="color: hsl(120, 100%, 40%);">+ indent = new_indent;</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_threadstorage_set_ptr(&trace_indent, (void*)indent);</span><br><span style="color: hsl(120, 100%, 40%);">+ } else if (indent_type == AST_TRACE_INDENT_INC_BEFORE) {</span><br><span> indent++;</span><br><span> ast_threadstorage_set_ptr(&trace_indent, (void*)indent);</span><br><span style="color: hsl(0, 100%, 40%);">- }</span><br><span style="color: hsl(0, 100%, 40%);">- if (indent_type == AST_TRACE_INDENT_DEC_BEFORE) {</span><br><span style="color: hsl(120, 100%, 40%);">+ } else if (indent_type == AST_TRACE_INDENT_DEC_BEFORE) {</span><br><span> indent--;</span><br><span> ast_threadstorage_set_ptr(&trace_indent, (void*)indent);</span><br><span> }</span><br><span>@@ -2316,6 +2345,7 @@</span><br><span> break;</span><br><span> case AST_TRACE_INDENT_INC_BEFORE:</span><br><span> case AST_TRACE_INDENT_INC_AFTER:</span><br><span style="color: hsl(120, 100%, 40%);">+ case AST_TRACE_INDENT_PROVIDED:</span><br><span> direction = "--> ";</span><br><span> break;</span><br><span> case AST_TRACE_INDENT_DEC_BEFORE:</span><br><span>@@ -2327,7 +2357,7 @@</span><br><span> ast_str_set(&fmt, 0, "%2d %-.*s%s%s:%d %s: %s", (int)indent, (indent_type == AST_TRACE_INDENT_NONE ? 0 : (int)(indent * 4)),</span><br><span> LOTS_O_SPACES, direction, file, line, func, S_OR(ast_skip_blanks(format), "\n"));</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- if (indent_type == AST_TRACE_INDENT_INC_AFTER) {</span><br><span style="color: hsl(120, 100%, 40%);">+ if (indent_type == AST_TRACE_INDENT_INC_AFTER || indent_type == AST_TRACE_INDENT_PROVIDED) {</span><br><span> indent++;</span><br><span> ast_threadstorage_set_ptr(&trace_indent, (void*)indent);</span><br><span> }</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.asterisk.org/c/asterisk/+/14627">change 14627</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/+/14627"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: asterisk </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: Ib8049c0b815063a45d8c7b0cb4e30b7b87b1d825 </div>
<div style="display:none"> Gerrit-Change-Number: 14627 </div>
<div style="display:none"> Gerrit-PatchSet: 3 </div>
<div style="display:none"> Gerrit-Owner: George Joseph <gjoseph@digium.com> </div>
<div style="display:none"> Gerrit-Reviewer: Benjamin Keith Ford <bford@digium.com> </div>
<div style="display:none"> Gerrit-Reviewer: Friendly Automation </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>