coregrind/pub_core_execontext.h

   1
   2 /*--------------------------------------------------------------------*/
   3 /*--- ExeContexts: long-lived, non-dup'd stack traces.             ---*/
   4 /*---                                        pub_core_execontext.h ---*/
   5 /*--------------------------------------------------------------------*/
   6
   7 /*
   8    This file is part of Valgrind, a dynamic binary instrumentation
   9    framework.
  10
  11    Copyright (C) 2000-2017 Julian Seward
  12       jseward@acm.org
  13
  14    This program is free software; you can redistribute it and/or
  15    modify it under the terms of the GNU General Public License as
  16    published by the Free Software Foundation; either version 2 of the
  17    License, or (at your option) any later version.
  18
  19    This program is distributed in the hope that it will be useful, but
  20    WITHOUT ANY WARRANTY; without even the implied warranty of
  21    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  22    General Public License for more details.
  23
  24    You should have received a copy of the GNU General Public License
  25    along with this program; if not, see <http://www.gnu.org/licenses/>.
  26
  27    The GNU General Public License is contained in the file COPYING.
  28 */
  29
  30 #ifndef __PUB_CORE_EXECONTEXT_H
  31 #define __PUB_CORE_EXECONTEXT_H
  32
  33 //--------------------------------------------------------------------
  34 // PURPOSE: This module provides an abstract data type, ExeContext,
  35 // which is a stack trace stored in such a way that duplicates are
  36 // avoided.  This also facilitates fast comparisons if necessary.
  37 //--------------------------------------------------------------------
  38
  39 #include "pub_tool_execontext.h"
  40
  41 /* The maximum number of calls we're prepared to save in an ExeContext. */
  42 #define VG_DEEPEST_BACKTRACE 500
  43
  44 // Print stats (informational only).
  45 // If with_stacktraces, outputs all the recorded stacktraces.
  46 extern void VG_(print_ExeContext_stats) ( Bool with_stacktraces );
  47
  48 // All ExeContext that are valid in the current epoch and have one or more
  49 // ips in the given range are archived, i.e. their epoch is frozen to
  50 // the given last_epoch.
  51 extern void VG_(archive_ExeContext_in_range) (DiEpoch last_epoch,
  52                                               Addr text_avma, SizeT length );
  53
  54 // Extract the StackTrace from an ExeContext.
  55 // (Minor hack: we use Addr* as the return type instead of StackTrace so
  56 // that modules #including this file don't also have to #include
  57 // pub_core_stacktrace.h also.)
  58 extern
  59 /*StackTrace*/Addr* VG_(get_ExeContext_StackTrace) ( ExeContext* e );
  60
  61
  62 #endif   // __PUB_CORE_EXECONTEXT_H
  63
  64 /*--------------------------------------------------------------------*/
  65 /*--- end                                                          ---*/
  66 /*--------------------------------------------------------------------*/