Warning, /PerfTools/Callgrind/doc/Callgrind.doc is written in an unsupported language. File is not indexed.
0001
0002 /*!
0003
0004 \page PerfTools_Callgrind Package PerfTools/Callgrind
0005
0006 <center>
0007 <small>
0008
0009 <!-- @CVS_TAG@ will be substituted at build time, no need to touch -->
0010 <a href=http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/PerfTools/Callgrind/?cvsroot=CMSSW&only_with_tag=@CVS_TAG@>Source code (CVS tag: @CVS_TAG@)</a> -
0011 <a href=http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/PerfTools/Callgrind/.admin/developers?rev=HEAD&cvsroot=CMSSW&content-type=text/vnd.viewcvs-markup>Administrative privileges</a>
0012 </small>
0013 </center>
0014
0015 \section desc Description
0016 <!-- Short description of what this package is supposed to provide -->
0017 This Package contains a service <b>ProfilerService</b> and two analyzer modules
0018 <b>StartProfilerAnalyzer</b> and <b>StopProfilerAnalyzer</b>
0019 that allow to instrument only some portion of a cmsRun with
0020 performance measurument tools. At the moment only callgrind is supported.
0021 Extending it to other tools such as IgProf is easy.
0022
0023 \subsection interface Public interface
0024 <!-- List the classes that are provided for use in other packages (if any) -->
0025
0026 - ProfilerService: provides a public interface mainly for the Start and Stop ProfilerAnalyzers.
0027 It can be used by other modules and services though...
0028
0029 \subsection modules Modules
0030 <!-- Describe modules implemented in this package and their parameter set -->
0031
0032 - StartProfilerAnalyzer: start profiler (callgrind) instrumentation
0033 - StopProfilerAnalyzer: stop profiler instrumentation
0034
0035 No set of parameters required
0036
0037 \subsection services Services
0038 <!-- Describe services implemented in this package and their parameter set -->
0039
0040 - ProfilerService
0041
0042 Parameter Set
0043
0044 untracked int32 firstEvent <br>
0045 untracked int32 lastEvent <br>
0046 untracked vstring paths <br>
0047
0048
0049 \subsection tests Unit tests and examples
0050 <!-- Describe cppunit tests and example configuration files -->
0051 - testPerfToolsCallgrind: a unit test of public and internal API of the ProfilerService
0052 - test.cfg: integration test of Service and Analyzers
0053
0054 \section status Status and planned development
0055 <!-- e.g. completed, stable, missing features -->
0056 Service and Analyzer Completed<br>
0057 One may need to add some addional control in case a StopAnalyzer is not called:
0058 for the time being the instrumentation is forced to stop at the end of each event.<br>
0059 The Service may be extended to tools other than callgrind such as IgProf
0060
0061 <hr>
0062 Last updated:
0063 @DATE@ Author: Vincenzo Innocente.
0064 */
0065
