sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1 | |
| 2 | /*--------------------------------------------------------------------*/ |
nethercote | 7cc9c23 | 2004-01-21 15:08:04 +0000 | [diff] [blame] | 3 | /*--- Profiling machinery. #include this file into a tool to ---*/ |
| 4 | /*--- enable --profile=yes, but not for release versions of tools, ---*/ |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 5 | /*--- because it uses glibc code. ---*/ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 6 | /*--- vg_profile.c ---*/ |
| 7 | /*--------------------------------------------------------------------*/ |
| 8 | |
| 9 | /* |
njn | b9c427c | 2004-12-01 14:14:42 +0000 | [diff] [blame] | 10 | This file is part of Valgrind, a dynamic binary instrumentation |
| 11 | framework. |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 12 | |
njn | 5361242 | 2005-03-12 16:22:54 +0000 | [diff] [blame] | 13 | Copyright (C) 2000-2005 Julian Seward |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 14 | jseward@acm.org |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 15 | |
| 16 | This program is free software; you can redistribute it and/or |
| 17 | modify it under the terms of the GNU General Public License as |
| 18 | published by the Free Software Foundation; either version 2 of the |
| 19 | License, or (at your option) any later version. |
| 20 | |
| 21 | This program is distributed in the hope that it will be useful, but |
| 22 | WITHOUT ANY WARRANTY; without even the implied warranty of |
| 23 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 24 | General Public License for more details. |
| 25 | |
| 26 | You should have received a copy of the GNU General Public License |
| 27 | along with this program; if not, write to the Free Software |
| 28 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
| 29 | 02111-1307, USA. |
| 30 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 31 | The GNU General Public License is contained in the file COPYING. |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 32 | */ |
| 33 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 34 | #ifndef __VG_PROFILE_C |
| 35 | #define __VG_PROFILE_C |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 36 | |
nethercote | 4606320 | 2004-09-02 08:51:43 +0000 | [diff] [blame] | 37 | #include "tool.h" |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 38 | |
| 39 | /* get rid of these, if possible */ |
| 40 | #include <signal.h> |
| 41 | #include <sys/time.h> |
| 42 | |
nethercote | 4606320 | 2004-09-02 08:51:43 +0000 | [diff] [blame] | 43 | /* Override the empty definitions from tool.h */ |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 44 | #undef VGP_PUSHCC |
| 45 | #undef VGP_POPCC |
njn | 31066fd | 2005-03-26 00:42:02 +0000 | [diff] [blame] | 46 | #define VGP_PUSHCC(x) if (VG_(clo_profile)) VG_(pushcc)(x) |
| 47 | #define VGP_POPCC(x) if (VG_(clo_profile)) VG_(popcc)(x) |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 48 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 49 | #define VGP_M_STACK 20 |
| 50 | #define VGP_MAX_CCS 50 |
| 51 | |
| 52 | |
| 53 | /* All zeroed initially because they're static */ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 54 | static Int vgp_nticks; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 55 | |
| 56 | static Int vgp_counts [VGP_MAX_CCS]; |
| 57 | static Int vgp_entries[VGP_MAX_CCS]; |
| 58 | static Char* vgp_names [VGP_MAX_CCS]; |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 59 | |
| 60 | static Int vgp_sp; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 61 | static UInt vgp_stack[VGP_M_STACK]; |
| 62 | |
| 63 | /* These definitions override the panicking ones in vg_profile.c */ |
| 64 | |
njn | 31066fd | 2005-03-26 00:42:02 +0000 | [diff] [blame] | 65 | void VG_(register_profile_event) ( Int n, Char* name ) |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 66 | { |
| 67 | /* Adjust for negative values */ |
| 68 | n += VgpUnc; |
| 69 | if (n >= VGP_MAX_CCS) { |
| 70 | VG_(printf)("\nProfile event #%d higher than VGP_MAX_CCS of %d.\n" |
| 71 | "If you really need this many profile events, increase\n" |
| 72 | "VGP_MAX_CCS and recompile Valgrind.\n", |
| 73 | n, VGP_MAX_CCS); |
njn | 6799325 | 2004-11-22 18:02:32 +0000 | [diff] [blame] | 74 | VG_(tool_panic)("profile event too high"); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 75 | } |
| 76 | if (vgp_names[n] != NULL) { |
njn | 02bc4b8 | 2005-05-15 17:28:26 +0000 | [diff] [blame^] | 77 | VG_(printf)("\nProfile event #%d being registered as '%s'\n" |
| 78 | "already registered as '%s'.\n" |
nethercote | 7cc9c23 | 2004-01-21 15:08:04 +0000 | [diff] [blame] | 79 | "Note that tool and core event numbers must not overlap.\n", |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 80 | n, name, vgp_names[n]); |
njn | 6799325 | 2004-11-22 18:02:32 +0000 | [diff] [blame] | 81 | VG_(tool_panic)("profile event already registered"); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 82 | } |
| 83 | |
| 84 | vgp_names[n] = name; |
| 85 | } |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 86 | |
njn | 31066fd | 2005-03-26 00:42:02 +0000 | [diff] [blame] | 87 | void VG_(tick) ( int sigNo ) |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 88 | { |
| 89 | Int cc; |
| 90 | vgp_nticks++; |
| 91 | cc = vgp_stack[vgp_sp]; |
njn | ca82cc0 | 2004-11-22 17:18:48 +0000 | [diff] [blame] | 92 | tl_assert(cc >= 0 && cc < VGP_MAX_CCS); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 93 | vgp_counts[ cc ]++; |
| 94 | } |
| 95 | |
njn | 31066fd | 2005-03-26 00:42:02 +0000 | [diff] [blame] | 96 | void VG_(init_profiling) ( void ) |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 97 | { |
| 98 | struct itimerval value; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 99 | Int ret; |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 100 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 101 | /* Register core events... tricky macro definition causes |
njn | 31066fd | 2005-03-26 00:42:02 +0000 | [diff] [blame] | 102 | VG_(register_profile_event)() to be called once for each core event |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 103 | in VGP_CORE_LIST. */ |
njn | ca82cc0 | 2004-11-22 17:18:48 +0000 | [diff] [blame] | 104 | tl_assert(VgpUnc == 0); |
njn | 31066fd | 2005-03-26 00:42:02 +0000 | [diff] [blame] | 105 | # define VGP_PAIR(n,name) VG_(register_profile_event)(n,name) |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 106 | VGP_CORE_LIST; |
| 107 | # undef VGP_PAIR |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 108 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 109 | vgp_sp = -1; |
njn | 31066fd | 2005-03-26 00:42:02 +0000 | [diff] [blame] | 110 | VG_(pushcc) ( VgpUnc ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 111 | |
| 112 | value.it_interval.tv_sec = 0; |
| 113 | value.it_interval.tv_usec = 10 * 1000; |
| 114 | value.it_value = value.it_interval; |
| 115 | |
njn | 31066fd | 2005-03-26 00:42:02 +0000 | [diff] [blame] | 116 | signal(SIGPROF, VG_(tick) ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 117 | ret = setitimer(ITIMER_PROF, &value, NULL); |
njn | 6799325 | 2004-11-22 18:02:32 +0000 | [diff] [blame] | 118 | if (ret != 0) VG_(tool_panic)("vgp_init_profiling"); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 119 | } |
| 120 | |
njn | 31066fd | 2005-03-26 00:42:02 +0000 | [diff] [blame] | 121 | void VG_(done_profiling) ( void ) |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 122 | { |
| 123 | Int i; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 124 | VG_(printf)("\nProfiling done, %d ticks\n", vgp_nticks); |
| 125 | for (i = 0; i < VGP_MAX_CCS; i++) |
| 126 | if (NULL != vgp_names[i]) |
| 127 | VG_(printf)( |
| 128 | "%2d: %4d (%3d %%%%) ticks, %10d entries for %s\n", |
| 129 | i, vgp_counts[i], |
| 130 | (Int)(1000.0 * (double)vgp_counts[i] / (double)vgp_nticks), |
| 131 | vgp_entries[i], vgp_names[i] ); |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 132 | } |
| 133 | |
njn | 31066fd | 2005-03-26 00:42:02 +0000 | [diff] [blame] | 134 | void VG_(pushcc) ( UInt cc ) |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 135 | { |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 136 | if (vgp_sp >= VGP_M_STACK-1) { |
| 137 | VG_(printf)( |
njn | 02bc4b8 | 2005-05-15 17:28:26 +0000 | [diff] [blame^] | 138 | "\nMaximum profile stack depth (%d) reached for event #%d ('%s').\n" |
njn | 31066fd | 2005-03-26 00:42:02 +0000 | [diff] [blame] | 139 | "This is probably due to a VG_(pushcc)() without a matching\n" |
| 140 | "VG_(popcc)(). Make sure they all match.\n" |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 141 | "Or if you are nesting profiling events very deeply, increase\n" |
| 142 | "VGP_M_STACK and recompile Valgrind.\n", |
| 143 | VGP_M_STACK, cc, vgp_names[cc]); |
njn | 6799325 | 2004-11-22 18:02:32 +0000 | [diff] [blame] | 144 | VG_(tool_panic)("Profiling stack overflow"); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 145 | } |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 146 | vgp_sp++; |
| 147 | vgp_stack[vgp_sp] = cc; |
| 148 | vgp_entries[ cc ] ++; |
| 149 | } |
| 150 | |
njn | 31066fd | 2005-03-26 00:42:02 +0000 | [diff] [blame] | 151 | void VG_(popcc) ( UInt cc ) |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 152 | { |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 153 | if (vgp_sp <= 0) { |
| 154 | VG_(printf)( |
njn | 31066fd | 2005-03-26 00:42:02 +0000 | [diff] [blame] | 155 | "\nProfile stack underflow. This is due to a VG_(popcc)() without\n" |
| 156 | "a matching VG_(pushcc)(). Make sure they all match.\n"); |
njn | 6799325 | 2004-11-22 18:02:32 +0000 | [diff] [blame] | 157 | VG_(tool_panic)("Profiling stack underflow"); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 158 | } |
| 159 | if (vgp_stack[vgp_sp] != cc) { |
| 160 | Int i; |
| 161 | VG_(printf)("popping %s, stack looks like:\n", vgp_names[cc]); |
| 162 | for (i = vgp_sp; i >= 0; i--) |
| 163 | VG_(printf)("%2d: %s\n", i, vgp_names[vgp_stack[i]]); |
| 164 | VG_(exit)(1); |
| 165 | } |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 166 | vgp_sp--; |
| 167 | } |
| 168 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 169 | #endif /* __VG_PROFILE_C */ |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 170 | |
| 171 | /*--------------------------------------------------------------------*/ |
| 172 | /*--- end vg_profile.c ---*/ |
| 173 | /*--------------------------------------------------------------------*/ |