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

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