libstdc++-v3/doc/html/manual/profile_mode_devel.html

   1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Developer Information</title><meta name="generator" content="DocBook XSL-NS Stylesheets V1.78.1" /><meta name="keywords" content="C++, library, profile" /><meta name="keywords" content="ISO C++, library" /><meta name="keywords" content="ISO C++, runtime, library" /><link rel="home" href="../index.html" title="The GNU C++ Library" /><link rel="up" href="profile_mode.html" title="Chapter 19. Profile Mode" /><link rel="prev" href="profile_mode_impl.html" title="Implementation Issues" /><link rel="next" href="profile_mode_diagnostics.html" title="Diagnostics" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Developer Information</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="profile_mode_impl.html">Prev</a> </td><th width="60%" align="center">Chapter 19. Profile Mode</th><td width="20%" align="right"> <a accesskey="n" href="profile_mode_diagnostics.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="manual.ext.profile_mode.developer"></a>Developer Information</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="manual.ext.profile_mode.developer.bigpic"></a>Big Picture</h3></div></div></div><p>The profile mode headers are included with
   3    <code class="code">-D_GLIBCXX_PROFILE</code> through preprocessor directives in
   4    <code class="code">include/std/*</code>.
   5   </p><p>Instrumented implementations are provided in
   6    <code class="code">include/profile/*</code>.  All instrumentation hooks are macros
   7    defined in <code class="code">include/profile/profiler.h</code>.
   8   </p><p>All the implementation of the instrumentation hooks is in
   9    <code class="code">include/profile/impl/*</code>.  Although all the code gets included,
  10    thus is publicly visible, only a small number of functions are called from
  11    outside this directory.  All calls to hook implementations must be
  12    done through macros defined in <code class="code">profiler.h</code>.  The macro
  13    must ensure (1) that the call is guarded against reentrance and
  14    (2) that the call can be turned off at compile time using a
  15    <code class="code">-D_GLIBCXX_PROFILE_...</code> compiler option.
  16   </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="manual.ext.profile_mode.developer.howto"></a>How To Add A Diagnostic</h3></div></div></div><p>Let's say the diagnostic name is "magic".
  17   </p><p>If you need to instrument a header not already under
  18    <code class="code">include/profile/*</code>, first edit the corresponding header
  19    under <code class="code">include/std/</code> and add a preprocessor directive such
  20    as the one in <code class="code">include/std/vector</code>:
  21 </p><pre class="programlisting">
  22 #ifdef _GLIBCXX_PROFILE
  23 # include &lt;profile/vector&gt;
  24 #endif
  25 </pre><p>
  26   </p><p>If the file you need to instrument is not yet under
  27    <code class="code">include/profile/</code>, make a copy of the one in
  28    <code class="code">include/debug</code>, or the main implementation.
  29    You'll need to include the main implementation and inherit the classes
  30    you want to instrument.  Then define the methods you want to instrument,
  31    define the instrumentation hooks and add calls to them.
  32    Look at <code class="code">include/profile/vector</code> for an example.
  33   </p><p>Add macros for the instrumentation hooks in
  34    <code class="code">include/profile/impl/profiler.h</code>.
  35    Hook names must start with <code class="code">__profcxx_</code>.
  36    Make sure they transform
  37    in no code with <code class="code">-D_NO_GLBICXX_PROFILE_MAGIC</code>.
  38    Make sure all calls to any method in namespace <code class="code">__gnu_profile</code>
  39    is protected against reentrance using macro
  40    <code class="code">_GLIBCXX_PROFILE_REENTRANCE_GUARD</code>.
  41    All names of methods in namespace <code class="code">__gnu_profile</code> called from
  42    <code class="code">profiler.h</code> must start with <code class="code">__trace_magic_</code>.
  43   </p><p>Add the implementation of the diagnostic.
  44    </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>
  45       Create new file <code class="code">include/profile/impl/profiler_magic.h</code>.
  46      </p></li><li class="listitem"><p>
  47       Define class <code class="code">__magic_info: public __object_info_base</code>.
  48       This is the representation of a line in the object table.
  49       The <code class="code">__merge</code> method is used to aggregate information
  50       across all dynamic instances created at the same call context.
  51       The <code class="code">__magnitude</code> must return the estimation of the benefit
  52       as a number of small operations, e.g., number of words copied.
  53       The <code class="code">__write</code> method is used to produce the raw trace.
  54       The <code class="code">__advice</code> method is used to produce the advice string.
  55      </p></li><li class="listitem"><p>
  56       Define class <code class="code">__magic_stack_info: public __magic_info</code>.
  57       This defines the content of a line in the stack table.
  58      </p></li><li class="listitem"><p>
  59       Define class <code class="code">__trace_magic: public __trace_base&lt;__magic_info,
  60       __magic_stack_info&gt;</code>.
  61       It defines the content of the trace associated with this diagnostic.
  62      </p></li></ul></div><p>
  63   </p><p>Add initialization and reporting calls in
  64    <code class="code">include/profile/impl/profiler_trace.h</code>.  Use
  65    <code class="code">__trace_vector_to_list</code> as an example.
  66   </p><p>Add documentation in file <code class="code">doc/xml/manual/profile_mode.xml</code>.
  67   </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="profile_mode_impl.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="profile_mode.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="profile_mode_diagnostics.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Implementation Issues </td><td width="20%" align="center"><a accesskey="h" href="../index.html">Home</a></td><td width="40%" align="right" valign="top"> Diagnostics</td></tr></table></div></body></html>