coregrind/pub_core_stacks.h

   1
   2 /*--------------------------------------------------------------------*/
   3 /*--- Stack management.                                 m_stacks.c ---*/
   4 /*--------------------------------------------------------------------*/
   5
   6 /*
   7    This file is part of Valgrind, a dynamic binary instrumentation
   8    framework.
   9
  10    Copyright (C) 2000-2017 Julian Seward
  11       jseward@acm.org
  12
  13    This program is free software; you can redistribute it and/or
  14    modify it under the terms of the GNU General Public License as
  15    published by the Free Software Foundation; either version 2 of the
  16    License, or (at your option) any later version.
  17
  18    This program is distributed in the hope that it will be useful, but
  19    WITHOUT ANY WARRANTY; without even the implied warranty of
  20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21    General Public License for more details.
  22
  23    You should have received a copy of the GNU General Public License
  24    along with this program; if not, write to the Free Software
  25    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  26    02111-1307, USA.
  27
  28    The GNU General Public License is contained in the file COPYING.
  29 */
  30
  31 #ifndef __PUB_CORE_STACKS_H
  32 #define __PUB_CORE_STACKS_H
  33
  34 #include "pub_core_basics.h"    // VG_ macro
  35
  36 //--------------------------------------------------------------------
  37 // PURPOSE: This module deals with the registration of stacks for the
  38 // purposes of detecting stack switches.
  39 //--------------------------------------------------------------------
  40
  41 /* Convention for start and end:
  42    'start' is the lowest address, 'end' is the highest address.
  43    'start' and 'end' bytes are included in the stack.
  44    In other words, the stack is the byte interval ['start', 'end']
  45    (both bounds are included).
  46
  47    Note: for compatibility reasons, VG_(register_stack) accepts
  48    'start' bigger than 'end' and will (transparently) swap 'start/end'
  49    to register the stack. */
  50 extern UWord VG_(register_stack)   ( Addr start, Addr end );
  51 extern void  VG_(deregister_stack) ( UWord id );
  52 extern void  VG_(change_stack)     ( UWord id, Addr start, Addr end );
  53 extern void  VG_(stack_limits)     ( Addr SP, Addr *start, Addr *end );
  54
  55 extern VG_REGPARM(3)
  56        void VG_(unknown_SP_update_w_ECU)
  57                                    ( Addr old_SP, Addr new_SP, UInt ecu );
  58 extern VG_REGPARM(2)
  59        void VG_(unknown_SP_update) ( Addr old_SP, Addr new_SP );
  60
  61 #endif   // __PUB_CORE_STACKS_H
  62
  63 /*--------------------------------------------------------------------*/
  64 /*--- end                                                          ---*/
  65 /*--------------------------------------------------------------------*/
  66