libstdc++-v3/include/profile/impl/profiler_node.h

   1 // -*- C++ -*-
   2 //
   3 // Copyright (C) 2009 Free Software Foundation, Inc.
   4 //
   5 // This file is part of the GNU ISO C++ Library.  This library is free
   6 // software; you can redistribute it and/or modify it under the terms
   7 // of the GNU General Public License as published by the Free Software
   8 // Foundation; either version 2, or (at your option) any later
   9 // version.
  10
  11 // This library is distributed in the hope that it will be useful, but
  12 // WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // General Public License for more details.
  15
  16 // You should have received a copy of the GNU General Public License
  17 // along with this library; see the file COPYING.  If not, write to
  18 // the Free Software Foundation, 59 Temple Place - Suite 330, Boston,
  19 // MA 02111-1307, USA.
  20
  21 // As a special exception, you may use this file as part of a free
  22 // software library without restriction.  Specifically, if other files
  23 // instantiate templates or use macros or inline functions from this
  24 // file, or you compile this file and link it with other files to
  25 // produce an executable, this file does not by itself cause the
  26 // resulting executable to be covered by the GNU General Public
  27 // License.  This exception does not however invalidate any other
  28 // reasons why the executable file might be covered by the GNU General
  29 // Public License.
  30
  31 /** @file profile/impl/profiler_node.h
  32  *  @brief Data structures to represent a single profiling event.
  33  */
  34
  35 // Written by Lixia Liu and Silvius Rus.
  36
  37 #ifndef _GLIBCXX_PROFILE_PROFILER_NODE_H
  38 #define _GLIBCXX_PROFILE_PROFILER_NODE_H 1
  39
  40 #ifdef __GXX_EXPERIMENTAL_CXX0X__
  41 #include <cstdio>
  42 #include <cstdint>
  43 #include <cstring>
  44 #else
  45 #include <stdio.h>
  46 #include <stdint.h>
  47 #include <string.h>
  48 #endif
  49 #include <vector>
  50 #if defined HAVE_EXECINFO_H
  51 #include <execinfo.h>
  52 #endif
  53
  54 namespace __gnu_profile
  55 {
  56   typedef const void* __object_t;
  57   typedef void* __instruction_address_t;
  58   typedef std::_GLIBCXX_STD_PR::vector<__instruction_address_t> __stack_npt;
  59   typedef __stack_npt* __stack_t;
  60
  61   size_t __stack_max_depth();
  62
  63   inline __stack_t __get_stack()
  64   {
  65 #if defined HAVE_EXECINFO_H
  66     size_t __max_depth = __stack_max_depth();
  67     if (__max_depth == 0)
  68       return NULL;
  69     __stack_npt __buffer(__max_depth);
  70     int __depth = backtrace(&__buffer[0], __max_depth);
  71     __stack_t __stack = new __stack_npt(__depth);
  72     memcpy(&(*__stack)[0], &__buffer[0], __depth * sizeof(__object_t));
  73     return __stack;
  74 #else
  75     return NULL;
  76 #endif
  77   }
  78
  79   inline __size(const __stack_t& __stack)
  80   {
  81     if (!__stack)
  82       return 0;
  83     else
  84       return __stack->size();
  85   }
  86
  87   inline void __write(FILE* __f, const __stack_t __stack)
  88   {
  89     if (!__stack)
  90       return;
  91
  92     __stack_npt::const_iterator __it;
  93     for (__it = __stack->begin(); __it != __stack->end(); ++__it)
  94       fprintf(__f, "%p ", *__it);
  95   }
  96
  97   /** @brief Hash function for summary trace using call stack as index.  */
  98   class __stack_hash
  99   {
 100   public:
 101     size_t operator()(const __stack_t __s) const
 102     {
 103       if (!__s)
 104         return 0;
 105
 106       uintptr_t __index = 0;
 107       __stack_npt::const_iterator __it;
 108       for (__it = __s->begin(); __it != __s->end(); ++__it)
 109         {
 110           __index += reinterpret_cast<uintptr_t>(*__it);
 111         }
 112       return __index;
 113     }
 114
 115     bool operator() (const __stack_t __stack1, const __stack_t __stack2) const
 116     {
 117       if (!__stack1 && !__stack2) return true;
 118       if (!__stack1 || !__stack2) return false;
 119       if (__stack1->size() != __stack2->size()) return false;
 120
 121       size_t __byte_size = __stack1->size() * sizeof(__stack_npt::value_type);
 122       return memcmp(&(*__stack1)[0], &(*__stack2)[0], __byte_size) == 0;
 123     }
 124   };
 125
 126   /** @brief Base class for a line in the object table.  */
 127   class __object_info_base
 128   {
 129   public:
 130     __object_info_base() { }
 131     __object_info_base(__stack_t __stack);
 132     __object_info_base(const __object_info_base& o);
 133     virtual ~__object_info_base() { }
 134     bool __is_valid() const { return _M_valid; }
 135     __stack_t __stack() const { return _M_stack; }
 136     virtual void __write(FILE* f) const = 0;
 137
 138   protected:
 139     __stack_t _M_stack;
 140     bool _M_valid;
 141   };
 142
 143   inline __object_info_base::__object_info_base(__stack_t __stack)
 144   {
 145     _M_stack = __stack;
 146     _M_valid = true;
 147   }
 148
 149   inline __object_info_base::__object_info_base(const __object_info_base& __o)
 150   {
 151     _M_stack = __o._M_stack;
 152     _M_valid = __o._M_valid;
 153   }
 154
 155   /** @brief Base class for a line in the stack table.  */
 156   template<typename __object_info>
 157     class __stack_info_base
 158     {
 159     public:
 160       __stack_info_base() { }
 161       __stack_info_base(const __object_info& __info) = 0;
 162       virtual ~__stack_info_base() { }
 163       void __merge(const __object_info& __info) = 0;
 164       virtual float __magnitude() const = 0;
 165       virtual const char* __get_id() const = 0;
 166     };
 167 } // namespace __gnu_profile
 168 #endif /* _GLIBCXX_PROFILE_PROFILER_NODE_H */