Changes between Initial Version and Version 1 of Doc/compiler/scripts/Profiling


Ignore:
Timestamp:
Oct 3, 2008, 4:30:43 PM (17 years ago)
Author:
/C=IE/O=Grid-Ireland/OU=cs.tcd.ie/L=RA-TCD/CN=Stephen O. Childs
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Doc/compiler/scripts/Profiling

    v1 v1  
     1{{{
     2#!html
     3<h1>PANC&minus;PROFILING.PL</h1>
     4<a href="#NAME">NAME</a><br>
     5<a href="#SYNOPSIS">SYNOPSIS</a><br>
     6<a href="#DESCRIPTION">DESCRIPTION</a><br>
     7<a href="#AUTHOR">AUTHOR</a><br>
     8
     9<hr>
     10<a name="NAME"></a>
     11<h2>NAME</h2>
     12<!-- INDENTATION -->
     13<table width="100%" border=0 rules="none" frame="void"
     14       cols="2" cellspacing="0" cellpadding="0">
     15<tr valign="top" align="left">
     16<td width="10%"></td>
     17<td width="89%">
     18<p>panc-profiling.pl &minus; generate profiling information
     19from panc log file</p>
     20</td>
     21</table>
     22<a name="SYNOPSIS"></a>
     23<h2>SYNOPSIS</h2>
     24<!-- INDENTATION -->
     25<table width="100%" border=0 rules="none" frame="void"
     26       cols="2" cellspacing="0" cellpadding="0">
     27<tr valign="top" align="left">
     28<td width="10%"></td>
     29<td width="89%">
     30<p><b>panc&minus;profiling.pl</b>
     31[<b>&minus;&minus;help</b>]
     32[<b>&minus;&minus;usefunctions</b>] {logfile}</p>
     33</td>
     34</table>
     35<a name="DESCRIPTION"></a>
     36<h2>DESCRIPTION</h2>
     37<!-- INDENTATION -->
     38<table width="100%" border=0 rules="none" frame="void"
     39       cols="2" cellspacing="0" cellpadding="0">
     40<tr valign="top" align="left">
     41<td width="10%"></td>
     42<td width="89%">
     43<p>The <b>panc&minus;profiling.pl</b> script will analyze a
     44panc log file and report profiling information. The script
     45takes the name of the log file as its first argument. The
     46second argument determines if function call information will
     47be included (flag=1) or not (flag=0). By default, the
     48function call information is not included. If no argument is
     49given or the <b>&minus;&minus;help</b> option is used, a
     50short usage message is printed. <i>The log file must have
     51been created with &quot;call&quot; logging enabled.</i></p>
     52<!-- INDENTATION -->
     53<p>Two files are created for each object template: one with
     54&acute;top&minus;down&acute; profile information and the
     55other with &acute;bottom&minus;up&acute; information.</p>
     56<!-- INDENTATION -->
     57<p>The top&minus;down file contains a text representation of
     58the call tree with each entry giving the total time spent in
     59that template and any templates called from that template.
     60At each level, one can use this to understand the relative
     61time spent in a node and each direct descendant.</p>
     62<!-- INDENTATION -->
     63<p>The bottom&minus;up file provides how much time is spent
     64directly in each template (or function), ignoring any time
     65spent in templates called from it. This allows one to see
     66how much time is spent in each template regardless of how
     67the template (or function) was called.</p>
     68<!-- INDENTATION -->
     69<p>All of the timing information is the
     70&quot;wall&minus;clock&quot; time, so other activity on the
     71machine and the logging itself can influence the output.
     72Nonetheless, the profiling information should be adequate to
     73understand inefficient parts of a particular build.</p>
     74</td>
     75</table>
     76<a name="AUTHOR"></a>
     77<h2>AUTHOR</h2>
     78<!-- INDENTATION -->
     79<table width="100%" border=0 rules="none" frame="void"
     80       cols="2" cellspacing="0" cellpadding="0">
     81<tr valign="top" align="left">
     82<td width="10%"></td>
     83<td width="89%">
     84<p><b>Charles Loomis</b></p></td>
     85</table>
     86}}}