<html>
<body>
<div style="font-family: Verdana, Arial, Helvetica, Sans-Serif;">
<table bgcolor="#f9f3c9" width="100%" cellpadding="8" style="border: 1px #c9c399 solid;">
<tr>
<td>
This is an automatically generated e-mail. To reply, visit:
<a href="https://reviewboard.asterisk.org/r/3377/">https://reviewboard.asterisk.org/r/3377/</a>
</td>
</tr>
</table>
<br />
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: 10px;">
<p style="margin-top: 0;">On March 28th, 2014, 1:42 p.m. CDT, <b>Corey Farrell</b> wrote:</p>
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: 10px;">
<table width="100%" border="0" bgcolor="white" style="border: 1px solid #C0C0C0; border-collapse: collapse; margin: 2px padding: 2px;">
<thead>
<tr>
<th colspan="4" bgcolor="#F0F0F0" style="border-bottom: 1px solid #C0C0C0; font-size: 9pt; padding: 4px 8px; text-align: left;">
<a href="https://reviewboard.asterisk.org/r/3377/diff/4/?file=56828#file56828line107" style="color: black; font-weight: bold; text-decoration: underline;">/branches/1.8/contrib/scripts/refcounter.py</a>
<span style="font-weight: normal;">
(Diff revision 4)
</span>
</th>
</tr>
</thead>
<tbody>
<tr>
<th bgcolor="#b1ebb0" style="border-right: 1px solid #C0C0C0;" align="right"><font size="2"></font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td>
<th bgcolor="#b1ebb0" style="border-left: 1px solid #C0C0C0; border-right: 1px solid #C0C0C0;" align="right"><font size="2">107</font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "> <span class="k">print</span> <span class="s">"</span><span class="si">%s</span><span class="s">[</span><span class="si">%s</span><span class="s">]:</span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s"> - [</span><span class="si">%s</span><span class="s">]"</span> <span class="o">%</span> <span class="p">(</span><span class="n">entry</span><span class="p">[</span><span class="s">'file'</span><span class="p">],</span> <span class="n">entry</span><span class="p">[</span><span class="s">'line'</span><span class="p">],</span></pre></td>
</tr>
<tr>
<th bgcolor="#b1ebb0" style="border-right: 1px solid #C0C0C0;" align="right"><font size="2"></font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td>
<th bgcolor="#b1ebb0" style="border-left: 1px solid #C0C0C0; border-right: 1px solid #C0C0C0;" align="right"><font size="2">108</font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "> <span class="n">entry</span><span class="p">[</span><span class="s">'function'</span><span class="p">],</span></pre></td>
</tr>
<tr>
<th bgcolor="#b1ebb0" style="border-right: 1px solid #C0C0C0;" align="right"><font size="2"></font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td>
<th bgcolor="#b1ebb0" style="border-left: 1px solid #C0C0C0; border-right: 1px solid #C0C0C0;" align="right"><font size="2">109</font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "> <span class="n">entry</span><span class="p">[</span><span class="s">'delta'</span><span class="p">],</span> <span class="n">entry</span><span class="p">[</span><span class="s">'tag'</span><span class="p">],</span></pre></td>
</tr>
<tr>
<th bgcolor="#b1ebb0" style="border-right: 1px solid #C0C0C0;" align="right"><font size="2"></font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "></pre></td>
<th bgcolor="#b1ebb0" style="border-left: 1px solid #C0C0C0; border-right: 1px solid #C0C0C0;" align="right"><font size="2">110</font></th>
<td bgcolor="#c5ffc4" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "> <span class="n">entry</span><span class="p">[</span><span class="s">'state'</span><span class="p">])</span></pre></td>
</tr>
</tbody>
</table>
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">file[line] looks too much like from logger.c level[threadid]. I suggest:
[threadid] file:line:function delta tag - [state]</pre>
</blockquote>
</blockquote>
<pre style="margin-left: 1em; white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">file:line function: is actually in line with the existing logging subsystems. I've gone ahead and put the extra space in there as well.</pre>
<br />
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: 10px;">
<p style="margin-top: 0;">On March 28th, 2014, 1:42 p.m. CDT, <b>Corey Farrell</b> wrote:</p>
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: 10px;">
<table width="100%" border="0" bgcolor="white" style="border: 1px solid #C0C0C0; border-collapse: collapse; margin: 2px padding: 2px;">
<thead>
<tr>
<th colspan="4" bgcolor="#F0F0F0" style="border-bottom: 1px solid #C0C0C0; font-size: 9pt; padding: 4px 8px; text-align: left;">
<a href="https://reviewboard.asterisk.org/r/3377/diff/4/?file=56831#file56831line238" style="color: black; font-weight: bold; text-decoration: underline;">/branches/1.8/main/astobj2.c</a>
<span style="font-weight: normal;">
(Diff revision 4)
</span>
</th>
</tr>
</thead>
<tbody style="background-color: #e4d9cb; padding: 4px 8px; text-align: center;">
<tr>
<td colspan="4"><pre style="font-size: 8pt; line-height: 140%; margin: 0; ">void *ao2_object_get_lockaddr(void *obj)</pre></td>
</tr>
</tbody>
<tbody>
<tr>
<th bgcolor="#e9eaa8" style="border-right: 1px solid #C0C0C0;" align="right"><font size="2">236</font></th>
<td bgcolor="#fdfebc" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "><span class="tb"> </span><span class="tb"> </span><span class="tb"> </span><span class="n">fprintf</span><span class="p">(</span><span class="n">ref<span class="hl">o</span></span><span class="p">,</span> <span class="s">"%p <span class="hl">**call </span>destructor** <span class="hl">%s:%d:%s (%s)</span></span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="n">user_data</span><span class="p">,</span> <span class="n">file</span><span class="p">,</span> <span class="n">line</span><span class="p">,</span> <span class="n">funcname</span><span class="p">,</span> <span class="n">tag</span><span class="p">);</span></pre></td>
<th bgcolor="#e9eaa8" style="border-left: 1px solid #C0C0C0; border-right: 1px solid #C0C0C0;" align="right"><font size="2">229</font></th>
<td bgcolor="#fdfebc" width="50%"><pre style="font-size: 8pt; line-height: 140%; margin: 0; "><span class="tb"> </span><span class="tb"> </span><span class="tb"> </span><span class="n">fprintf</span><span class="p">(</span><span class="n">ref<span class="hl">_log</span></span><span class="p">,</span> <span class="s">"%p<span class="hl">,%d,%s,%d,%s,**</span>destructor**<span class="hl">,%s</span></span><span class="se">\n</span><span class="s">"</span><span class="p">,</span> <span class="n">user_da<span class="hl">ta</span></span><span class="p"><span class="hl">,</span></span><span class="hl"> </span><span class="n"><span class="hl">del</span>ta</span><span class="p">,</span> <span class="n">file</span><span class="p">,</span> <span class="n">line</span><span class="p">,</span> <span class="n">funcname</span><span class="p">,</span> <span class="n">tag</span><span class="p">);</span></pre></td>
</tr>
</tbody>
</table>
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">Can we add thread id to all reflog entries (before tag so it is parsable)? ast_get_tid() was added to utils.c in Asterisk 11. Asterisk 1.8 has an inferior macro in logger.c that could probably just be copied. This would allow reflog entries to be associated with logger.c output. If a leak is associated with a specific channel we could see which one, examine traffic from PCAP, etc.
I don't think we need an option for refcounter.py to filter by thread id, grep can do that. In most situations where thread id would be useful we would want the original refs file and full debug logs from the same run.</pre>
</blockquote>
<p>On April 6th, 2014, 1:54 p.m. CDT, <b>Matt Jordan</b> wrote:</p>
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: 10px;">
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">I'm sitting in an airport right now trying to debug ref counting problems. I'll take a look at adding this.
At the same time, this review has had more findings and more enhancements than reviews for the bugs it seeks to fix. Unless something is critically necessary or is a finding against the actual functionality in this patch, I'm going to ask that we put it in another patch/review.</pre>
</blockquote>
<p>On April 6th, 2014, 3:19 p.m. CDT, <b>Corey Farrell</b> wrote:</p>
<blockquote style="margin-left: 1em; border-left: 2px solid #d0d0d0; padding-left: 10px;">
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">It's your call if you want to drop this enhancement. I was originally thinking that thread id was just something crazy that I added, but then I'm realizing it's not actually crazy at all given how much can be learned from it. I opened a finding against this since we're already breaking the format of the refs log, I assumed that breaking it once was best.
I understand if you don't want this change to deal with the fact that ast_get_tid() is not available in all supported versions. If you reserve a field (set to 0), this would allow me to submit a review to add TID later without breaking the format again. If you do that I would say fix the array indexes in refcounter.py, but don't output the reserved field.</pre>
</blockquote>
</blockquote>
<pre style="margin-left: 1em; white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">I've added it. I went ahead and backported the ast_get_tid() function, as it was far better than trying to use the macro in logger.c.
This enhancement aside, I was not suggesting I drop this patch; I was suggesting we take future enhancements to the ref debugging functionality and do it in a separate patch or review.
There's a fine line in code reviews between making sure that what is going into Asterisk is useful and good, and piling a bunch of other feature enhancements into a patch. To me, at least, it feels like we've reached that line where additional functionality is going way beyond the initial purpose of this patch. The existing ref debug properties in Asterisk are difficult to enable correctly, produce logs that suck to parse, and have an inadequate parsing tool that is difficult to extend and prone to breaking when changes affect utils. This patch seeks to make life a little bit better; not a lot. If we'd like to make life a lot better, that feels like it should be done as a separate patch.</pre>
<br />
<p>- Matt</p>
<br />
<p>On April 9th, 2014, 4:08 p.m. CDT, Matt Jordan wrote:</p>
<table bgcolor="#fefadf" width="100%" cellspacing="0" cellpadding="8" style="background-image: url('https://reviewboard.asterisk.org/static/rb/images/review_request_box_top_bg.ab6f3b1072c9.png'); background-position: left top; background-repeat: repeat-x; border: 1px black solid;">
<tr>
<td>
<div>Review request for Asterisk Developers, Corey Farrell and wdoekes.</div>
<div>By Matt Jordan.</div>
<p style="color: grey;"><i>Updated April 9, 2014, 4:08 p.m.</i></p>
<div style="margin-top: 1.5em;">
<b style="color: #575012; font-size: 10pt;">Repository: </b>
Asterisk
</div>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Description </h1>
<table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" style="border: 1px solid #b8b5a0">
<tr>
<td>
<pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">Note: while an improvement to Asterisk, this patch only affects Asterisk when compiled in -dev-mode. Since it has benefit only for developers looking to fix bugs, I'm proposing it for Asterisk 1.8+. The removal of refcounter should be done in trunk only.
Asterisk uses reference counted objects. A lot. As their use has spread, the bugs related to reference counting errors has grown as well. Central to resolving reference counting issues is the usage of REF_DEBUG; unfortunately, REF_DEBUG has had several problems:
(1) It could not be enabled through menuselect
(2) When not enabled globally, updates to objects were often lost, resulting in insufficient data to resolve problems
(3) The format of the ref debug log file was not suitable for parsing
This patch changes REF_DEBUG in the following ways:
(1) It makes REF_DEBUG a meneselect item when Asterisk is compiled with --enable-dev-mode
(2) The ref debug log file is now created in the AST_LOG_DIR directory. Every run will now blow away the previous run (as large ref files sometimes caused issues). We now also no longer open/close the file on each write, instead relying on fflush to make sure data gets written to the file (in case the ao2 call being performed is about to cause a crash)
(3) It goes with a comma delineated format for the ref debug file. This makes parsing much easier.
(4) It throws out the refcounter utility and goes with a python script instead.</pre>
</td>
</tr>
</table>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Testing </h1>
<table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" style="border: 1px solid #b8b5a0">
<tr>
<td>
<pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">Things spit out ref logs and the script parses them. Example below:
==== Object 0x21ed9b8 history ====
features.c[5427]:create_parkinglot 1 - [**constructor**]
features.c[5707]:build_parkinglot +1 - [1]
features.c[5392]:parkinglot_unref -1 - [2]
features.c[6358]:build_dialplan_useage_map +1 - [1]
features.c[6358]:build_dialplan_useage_map -1 - [2]
features.c[4985]:find_parkinglot +1 - [1]
features.c[5392]:parkinglot_unref -1 - [2]
features.c[6358]:build_dialplan_useage_map +1 - [1]
features.c[6358]:build_dialplan_useage_map -1 - [2]
features.c[4955]:do_parking_thread +1 - [1]
features.c[4957]:do_parking_thread -1 - [2]
astobj2.c[955]:cd_cb_debug -1 deref object via container destroy - [1]
astobj2.c[955]:cd_cb_debug -1 deref object via container destroy - [**call destructor**]
</pre>
</td>
</tr>
</table>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Diffs</b> </h1>
<ul style="margin-left: 3em; padding-left: 0;">
<li>/branches/1.8/utils/utils.xml <span style="color: grey">(410891)</span></li>
<li>/branches/1.8/utils/refcounter.c <span style="color: grey">(410891)</span></li>
<li>/branches/1.8/utils/Makefile <span style="color: grey">(410891)</span></li>
<li>/branches/1.8/main/utils.c <span style="color: grey">(410891)</span></li>
<li>/branches/1.8/main/logger.c <span style="color: grey">(410891)</span></li>
<li>/branches/1.8/main/astobj2.c <span style="color: grey">(410891)</span></li>
<li>/branches/1.8/main/asterisk.c <span style="color: grey">(410891)</span></li>
<li>/branches/1.8/include/asterisk/utils.h <span style="color: grey">(410891)</span></li>
<li>/branches/1.8/include/asterisk/astobj2.h <span style="color: grey">(410891)</span></li>
<li>/branches/1.8/contrib/scripts/refcounter.py <span style="color: grey">(PRE-CREATION)</span></li>
<li>/branches/1.8/channels/chan_sip.c <span style="color: grey">(410891)</span></li>
<li>/branches/1.8/build_tools/cflags.xml <span style="color: grey">(410891)</span></li>
</ul>
<p><a href="https://reviewboard.asterisk.org/r/3377/diff/" style="margin-left: 3em;">View Diff</a></p>
</td>
</tr>
</table>
</div>
</body>
</html>