1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
|
/*--------------------------------------------------------------------*/
/*--- Callgrind ---*/
/*--- ct_callstack.c ---*/
/*--------------------------------------------------------------------*/
/*
This file is part of Callgrind, a Valgrind tool for call tracing.
Copyright (C) 2002-2015, Josef Weidendorfer (Josef.Weidendorfer@gmx.de)
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307, USA.
The GNU General Public License is contained in the file COPYING.
*/
#include "global.h"
/*------------------------------------------------------------*/
/*--- Call stack, operations ---*/
/*------------------------------------------------------------*/
/* Stack of current thread. Gets initialized when switching to 1st thread.
*
* The artificial call stack is an array of call_entry's, representing
* stack frames of the executing program.
* Array call_stack and call_stack_esp have same size and grow on demand.
* Array call_stack_esp holds SPs of corresponding stack frames.
*
*/
#define N_CALL_STACK_INITIAL_ENTRIES 500
call_stack CLG_(current_call_stack);
void CLG_(init_call_stack)(call_stack* s)
{
Int i;
CLG_ASSERT(s != 0);
s->size = N_CALL_STACK_INITIAL_ENTRIES;
s->entry = (call_entry*) CLG_MALLOC("cl.callstack.ics.1",
s->size * sizeof(call_entry));
s->sp = 0;
s->entry[0].cxt = 0; /* for assertion in push_cxt() */
for(i=0; i<s->size; i++) s->entry[i].enter_cost = 0;
}
call_entry* CLG_(get_call_entry)(Int sp)
{
CLG_ASSERT(sp <= CLG_(current_call_stack).sp);
return &(CLG_(current_call_stack).entry[sp]);
}
void CLG_(copy_current_call_stack)(call_stack* dst)
{
CLG_ASSERT(dst != 0);
dst->size = CLG_(current_call_stack).size;
dst->entry = CLG_(current_call_stack).entry;
dst->sp = CLG_(current_call_stack).sp;
}
void CLG_(set_current_call_stack)(call_stack* s)
{
CLG_ASSERT(s != 0);
CLG_(current_call_stack).size = s->size;
CLG_(current_call_stack).entry = s->entry;
CLG_(current_call_stack).sp = s->sp;
}
static __inline__
void ensure_stack_size(Int i)
{
Int oldsize;
call_stack *cs = &CLG_(current_call_stack);
if (i < cs->size) return;
oldsize = cs->size;
cs->size *= 2;
while (i > cs->size) cs->size *= 2;
cs->entry = (call_entry*) VG_(realloc)("cl.callstack.ess.1",
cs->entry,
cs->size * sizeof(call_entry));
for(i=oldsize; i<cs->size; i++)
cs->entry[i].enter_cost = 0;
CLG_(stat).call_stack_resizes++;
CLG_DEBUGIF(2)
VG_(printf)(" call stack enlarged to %u entries\n",
CLG_(current_call_stack).size);
}
/* Called when function entered nonrecursive */
static void function_entered(fn_node* fn)
{
CLG_ASSERT(fn != 0);
#if CLG_ENABLE_DEBUG
if (fn->verbosity >=0) {
Int old = CLG_(clo).verbose;
CLG_(clo).verbose = fn->verbosity;
fn->verbosity = old;
VG_(message)(Vg_DebugMsg,
"Entering %s: Verbosity set to %d\n",
fn->name, CLG_(clo).verbose);
}
#endif
if (fn->dump_before) {
HChar trigger[VG_(strlen)(fn->name) + 20];
VG_(sprintf)(trigger, "--dump-before=%s", fn->name);
CLG_(dump_profile)(trigger, True);
}
else if (fn->zero_before) {
CLG_(zero_all_cost)(True);
}
if (fn->toggle_collect) {
CLG_(current_state).collect = !CLG_(current_state).collect;
CLG_DEBUG(2," entering %s: toggled collection state to %s\n",
fn->name,
CLG_(current_state).collect ? "ON" : "OFF");
}
}
/* Called when function left (no recursive level active) */
static void function_left(fn_node* fn)
{
CLG_ASSERT(fn != 0);
if (fn->dump_after) {
HChar trigger[VG_(strlen)(fn->name) + 20];
VG_(sprintf)(trigger, "--dump-after=%s", fn->name);
CLG_(dump_profile)(trigger, True);
}
if (fn->toggle_collect) {
CLG_(current_state).collect = !CLG_(current_state).collect;
CLG_DEBUG(2," leaving %s: toggled collection state to %s\n",
fn->name,
CLG_(current_state).collect ? "ON" : "OFF");
}
#if CLG_ENABLE_DEBUG
if (fn->verbosity >=0) {
Int old = CLG_(clo).verbose;
CLG_(clo).verbose = fn->verbosity;
fn->verbosity = old;
VG_(message)(Vg_DebugMsg,
"Leaving %s: Verbosity set back to %d\n",
fn->name, CLG_(clo).verbose);
}
#endif
}
/* Push call on call stack.
*
* Increment the usage count for the function called.
* A jump from <from> to <to>, with <sp>.
* If <skip> is true, this is a call to a function to be skipped;
* for this, we set jcc = 0.
*/
void CLG_(push_call_stack)(BBCC* from, UInt jmp, BBCC* to, Addr sp, Bool skip)
{
jCC* jcc;
UInt* pdepth;
call_entry* current_entry;
Addr ret_addr;
/* Ensure a call stack of size <current_sp>+1.
* The +1 is needed as push_cxt will store the
* context at [current_sp]
*/
ensure_stack_size(CLG_(current_call_stack).sp +1);
current_entry = &(CLG_(current_call_stack).entry[CLG_(current_call_stack).sp]);
if (skip) {
jcc = 0;
}
else {
fn_node* to_fn = to->cxt->fn[0];
if (CLG_(current_state).nonskipped) {
/* this is a jmp from skipped to nonskipped */
CLG_ASSERT(CLG_(current_state).nonskipped == from);
}
/* As push_cxt() has to be called before push_call_stack if not
* skipping, the old context should already be saved on the stack */
CLG_ASSERT(current_entry->cxt != 0);
CLG_(copy_cost_lz)( CLG_(sets).full, &(current_entry->enter_cost),
CLG_(current_state).cost );
jcc = CLG_(get_jcc)(from, jmp, to);
CLG_ASSERT(jcc != 0);
pdepth = CLG_(get_fn_entry)(to_fn->number);
if (CLG_(clo).skip_direct_recursion) {
/* only increment depth if another function is called */
if (jcc->from->cxt->fn[0] != to_fn) (*pdepth)++;
}
else (*pdepth)++;
if (*pdepth>1)
CLG_(stat).rec_call_counter++;
jcc->call_counter++;
CLG_(stat).call_counter++;
if (*pdepth == 1) function_entered(to_fn);
}
/* return address is only is useful with a real call;
* used to detect RET w/o CALL */
if (from->bb->jmp[jmp].jmpkind == jk_Call) {
UInt instr = from->bb->jmp[jmp].instr;
ret_addr = bb_addr(from->bb) +
from->bb->instr[instr].instr_offset +
from->bb->instr[instr].instr_size;
}
else
ret_addr = 0;
/* put jcc on call stack */
current_entry->jcc = jcc;
current_entry->sp = sp;
current_entry->ret_addr = ret_addr;
current_entry->nonskipped = CLG_(current_state).nonskipped;
CLG_(current_call_stack).sp++;
/* To allow for above assertion we set context of next frame to 0 */
CLG_ASSERT(CLG_(current_call_stack).sp < CLG_(current_call_stack).size);
current_entry++;
current_entry->cxt = 0;
if (!skip)
CLG_(current_state).nonskipped = 0;
else if (!CLG_(current_state).nonskipped) {
/* a call from nonskipped to skipped */
CLG_(current_state).nonskipped = from;
if (!CLG_(current_state).nonskipped->skipped) {
CLG_(init_cost_lz)( CLG_(sets).full,
&CLG_(current_state).nonskipped->skipped);
CLG_(stat).distinct_skips++;
}
}
#if CLG_ENABLE_DEBUG
CLG_DEBUGIF(0) {
if (CLG_(clo).verbose<2) {
if (jcc && jcc->to && jcc->to->bb) {
const HChar spaces[][41] = {
" . . . . . . . . . .",
" . . . . . . . . . . ",
" . . . . . . . . . . ",
". . . . . . . . . . " };
int s = CLG_(current_call_stack).sp;
UInt* pars = (UInt*) sp;
BB* bb = jcc->to->bb;
if (s>40) s=40;
VG_(printf)("%s> %s(0x%x, 0x%x, ...) [%s / %#lx]\n", spaces[s%4]+40-s, bb->fn->name,
pars ? pars[1]:0,
pars ? pars[2]:0,
bb->obj->name + bb->obj->last_slash_pos,
(UWord)bb->offset);
}
}
else if (CLG_(clo).verbose<4) {
VG_(printf)("+ %2d ", CLG_(current_call_stack).sp);
CLG_(print_short_jcc)(jcc);
VG_(printf)(", SP %#lx, RA %#lx\n", sp, ret_addr);
}
else {
VG_(printf)(" Pushed ");
CLG_(print_stackentry)(3, CLG_(current_call_stack).sp-1);
}
}
#endif
}
/* Pop call stack and update inclusive sums.
* Returns modified fcc.
*
* If the JCC becomes inactive, call entries are freed if possible
*/
void CLG_(pop_call_stack)()
{
jCC* jcc;
Int depth = 0;
call_entry* lower_entry;
if (CLG_(current_state).sig >0) {
/* Check if we leave a signal handler; this can happen when
* calling longjmp() in the handler */
CLG_(run_post_signal_on_call_stack_bottom)();
}
lower_entry =
&(CLG_(current_call_stack).entry[CLG_(current_call_stack).sp-1]);
CLG_DEBUG(4,"+ pop_call_stack: frame %d, jcc %p\n",
CLG_(current_call_stack).sp, lower_entry->jcc);
/* jCC item not any more on real stack: pop */
jcc = lower_entry->jcc;
CLG_(current_state).nonskipped = lower_entry->nonskipped;
if (jcc) {
fn_node* to_fn = jcc->to->cxt->fn[0];
UInt* pdepth = CLG_(get_fn_entry)(to_fn->number);
if (CLG_(clo).skip_direct_recursion) {
/* only decrement depth if another function was called */
if (jcc->from->cxt->fn[0] != to_fn) (*pdepth)--;
}
else (*pdepth)--;
depth = *pdepth;
/* add cost difference to sum */
if ( CLG_(add_diff_cost_lz)( CLG_(sets).full, &(jcc->cost),
lower_entry->enter_cost,
CLG_(current_state).cost) ) {
/* only count this call if it attributed some cost.
* the ret_counter is used to check if a BBCC dump is needed.
*/
jcc->from->ret_counter++;
}
CLG_(stat).ret_counter++;
/* restore context */
CLG_(current_state).cxt = lower_entry->cxt;
CLG_(current_fn_stack).top =
CLG_(current_fn_stack).bottom + lower_entry->fn_sp;
CLG_ASSERT(CLG_(current_state).cxt != 0);
if (depth == 0) function_left(to_fn);
}
/* To allow for an assertion in push_call_stack() */
lower_entry->cxt = 0;
CLG_(current_call_stack).sp--;
#if CLG_ENABLE_DEBUG
CLG_DEBUGIF(1) {
if (CLG_(clo).verbose<4) {
if (jcc) {
/* popped JCC target first */
VG_(printf)("- %2d %#lx => ",
CLG_(current_call_stack).sp,
bb_addr(jcc->to->bb));
CLG_(print_addr)(bb_jmpaddr(jcc->from->bb));
VG_(printf)(", SP %#lx\n",
CLG_(current_call_stack).entry[CLG_(current_call_stack).sp].sp);
CLG_(print_cost)(10, CLG_(sets).full, jcc->cost);
}
else
VG_(printf)("- %2d [Skipped JCC], SP %#lx\n",
CLG_(current_call_stack).sp,
CLG_(current_call_stack).entry[CLG_(current_call_stack).sp].sp);
}
else {
VG_(printf)(" Popped ");
CLG_(print_stackentry)(7, CLG_(current_call_stack).sp);
if (jcc) {
VG_(printf)(" returned to ");
CLG_(print_addr_ln)(bb_jmpaddr(jcc->from->bb));
}
}
}
#endif
}
/* Unwind enough CallStack items to sync with current stack pointer.
* Returns the number of stack frames unwinded.
*/
Int CLG_(unwind_call_stack)(Addr sp, Int minpops)
{
Int csp;
Int unwind_count = 0;
CLG_DEBUG(4,"+ unwind_call_stack(sp %#lx, minpops %d): frame %d\n",
sp, minpops, CLG_(current_call_stack).sp);
/* We pop old stack frames.
* For a call, be p the stack address with return address.
* - call_stack_esp[] has SP after the CALL: p-4
* - current sp is after a RET: >= p
*/
while( (csp=CLG_(current_call_stack).sp) >0) {
call_entry* top_ce = &(CLG_(current_call_stack).entry[csp-1]);
if ((top_ce->sp < sp) ||
((top_ce->sp == sp) && minpops>0)) {
minpops--;
unwind_count++;
CLG_(pop_call_stack)();
csp=CLG_(current_call_stack).sp;
continue;
}
break;
}
CLG_DEBUG(4,"- unwind_call_stack\n");
return unwind_count;
}
|