include/xbt/backtrace.h

   1 /* Copyright (c) 2005-2019. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /*  Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>       */
   5 /*  Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>         */
   6 /*  Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>           */
   7 /*  All rights reserved.                                                    */
   8
   9 /* This code is inspirated from the OSSP version (as retrieved back in 2004)*/
  10 /* It was heavily modified to fit the SimGrid framework.                    */
  11
  12 /* The OSSP version has the following copyright notice:
  13 **  OSSP ex - Exception Handling
  14 **  Copyright (c) 2002-2004 Ralf S. Engelschall <rse@engelschall.com>
  15 **  Copyright (c) 2002-2004 The OSSP Project <http://www.ossp.org/>
  16 **  Copyright (c) 2002-2004 Cable & Wireless <http://www.cw.com/>
  17 **
  18 **  This file is part of OSSP ex, an exception handling library
  19 **  which can be found at http://www.ossp.org/pkg/lib/ex/.
  20 **
  21 **  Permission to use, copy, modify, and distribute this software for
  22 **  any purpose with or without fee is hereby granted, provided that
  23 **  the above copyright notice and this permission notice appear in all
  24 **  copies.
  25 **
  26 **  THIS SOFTWARE IS PROVIDED `AS IS'' AND ANY EXPRESSED OR IMPLIED
  27 **  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  28 **  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  29 **  IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
  30 **  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  31 **  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  32 **  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  33 **  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  34 **  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  35 **  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  36 **  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37 **  SUCH DAMAGE.
  38  */
  39
  40 /* The extensions made for the SimGrid project can either be distributed    */
  41 /* under the same license, or under the LGPL v2.1                           */
  42
  43 #ifndef SIMGRIX_XBT_BACKTRACE_H
  44 #define SIMGRIX_XBT_BACKTRACE_H
  45
  46 #include <cstddef>
  47
  48 #include <xbt/base.h>
  49
  50 SG_BEGIN_DECL()
  51
  52 typedef void* xbt_backtrace_location_t;
  53
  54 /** @brief Shows a backtrace of the current location */
  55 XBT_PUBLIC(void) xbt_backtrace_display_current(void);
  56
  57 /** @brief reimplementation of glibc backtrace based directly on gcc library, without implicit malloc  */
  58 XBT_PUBLIC(int) xbt_backtrace_no_malloc(void**bt, int size);
  59
  60 /** @brief Captures a backtrace for further use */
  61 XBT_PUBLIC(size_t) xbt_backtrace_current(xbt_backtrace_location_t* loc, size_t count);
  62
  63 /** @brief Display a previously captured backtrace */
  64 XBT_PUBLIC(void) xbt_backtrace_display(xbt_backtrace_location_t* loc, size_t count);
  65
  66 /** @brief Get current backtrace with libunwind */
  67 XBT_PUBLIC(int) xbt_libunwind_backtrace(void** bt, int size);
  68
  69 SG_END_DECL()
  70
  71 #endif