<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/1732/">https://reviewboard.asterisk.org/r/1732/</a>
</td>
</tr>
</table>
<br />
<table bgcolor="#fefadf" width="100%" cellspacing="0" cellpadding="8" style="background-image: url('https://reviewboard.asterisk.org/media/rb/images/review_request_box_top_bg.png'); background-position: left top; background-repeat: repeat-x; border: 1px black solid;">
<tr>
<td>
<div>Review request for Asterisk Developers.</div>
<div>By Terry Wilson.</div>
<p style="color: grey;"><i>Updated March 8, 2012, 6:09 p.m.</i></p>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Changes</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;">Do a safer set of changes and remove unneeded a[sizeof(a) -1] = '\0' lines:
@@
expression a, b;
@@
- strncpy(a, b, sizeof(a) - 1)
+ ast_copy_string(a, b, sizeof(a))
@@
expression a, b;
@@
- strncpy(a, b, sizeof(a))
+ ast_copy_string(a, b, sizeof(a))
@@
expression a, b;
@@
ast_copy_string(a, b, sizeof(a));
- a[sizeof(a) - 1] = '\0';
</pre>
</td>
</tr>
</table>
<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;">One of the janitor projects is to replace strncpy with ast_copy_string where possible. As a brief example of using the coccinelle tool, I thought I'd post an example for using it. There are some cases of strncpy which where ast_copy_string wouldn't be appropriate--sepcifically when it is used to copy non-NULL terminated buffers (instead of memcpy, which should be used for that). Two cases that I think should be completely safe are where we have something like strncpy(src, dst, ${something} - 1) and strncpy(src, dst, sizeof(src)) (which is a bug waiting to happen).
Here is the coccinelle patch to do the translation:
strncpy.cocci
@@
expression a, b, c;
@@
- strncpy(a, b, c - 1)
+ ast_copy_string(a, b, c)
@@
expression a, b;
@@
- strncpy(a, b, sizeof(a))
+ ast_copy_string(a, b, sizeof(a))
Coccinelle needs a little help with some of the macros in Asterisk--so far it looks like the ones in linkedlists.h and app.h give it the most trouble. You can generate a macro file to use by doing:
spatch -extract_macros include/asterisk/linkedlists.h > /tmp/spatch.h
spatch -extract_macros include/asterisk/app.h >> /tmp/spatch.h
I've found that doing all of the includes sometimes makes it miss stuff for some reason...
Then to run the patch file on all the files in the asterisk directory:
spatch -sp_file strncpy.cocci -preprocess -c -in_place -I include/ -local_includes -macro_file /tmp/spatch.h -smpl_spacing -dir .
You may have to fix some stuff up manually, but it goes a long way to making things a lot easier. This is a simple example of how the channel opaquification is done. I'll write this all up on the Wiki, but am basically just doing a quick brain dump before I leave for the night.</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;">It compiles.</pre>
</td>
</tr>
</table>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Diffs</b> (updated)</h1>
<ul style="margin-left: 3em; padding-left: 0;">
<li>/trunk/addons/chan_ooh323.c <span style="color: grey">(358725)</span></li>
<li>/trunk/addons/ooh323c/src/ooCalls.c <span style="color: grey">(358725)</span></li>
<li>/trunk/addons/ooh323c/src/ooCmdChannel.c <span style="color: grey">(358725)</span></li>
<li>/trunk/addons/ooh323c/src/ooh323ep.c <span style="color: grey">(358725)</span></li>
<li>/trunk/addons/ooh323c/src/ooq931.c <span style="color: grey">(358725)</span></li>
<li>/trunk/apps/app_alarmreceiver.c <span style="color: grey">(358725)</span></li>
<li>/trunk/apps/app_rpt.c <span style="color: grey">(358725)</span></li>
<li>/trunk/channels/iax2-provision.c <span style="color: grey">(358725)</span></li>
<li>/trunk/res/snmp/agent.c <span style="color: grey">(358725)</span></li>
<li>/trunk/utils/ael_main.c <span style="color: grey">(358725)</span></li>
<li>/trunk/utils/astman.c <span style="color: grey">(358725)</span></li>
<li>/trunk/utils/muted.c <span style="color: grey">(358725)</span></li>
</ul>
<p><a href="https://reviewboard.asterisk.org/r/1732/diff/" style="margin-left: 3em;">View Diff</a></p>
</td>
</tr>
</table>
</div>
</body>
</html>