include/pub_tool_libcassert.h

   1
   2 /*--------------------------------------------------------------------*/
   3 /*--- Assertions, etc.                       pub_tool_libcassert.h ---*/
   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_TOOL_LIBCBASSERT_H
  32 #define __PUB_TOOL_LIBCBASSERT_H
  33
  34 #include "pub_tool_basics.h"   // VG_ macro
  35
  36 #define tl_assert(expr)                                                 \
  37   ((void) (LIKELY(expr) ? 0 :                                           \
  38            (VG_(assert_fail) (/*isCore?*/False, #expr,                  \
  39                               __FILE__, __LINE__,                       \
  40                               __PRETTY_FUNCTION__,                      \
  41                               ""),                                      \
  42                               0)))
  43
  44 #define tl_assert2(expr, format, args...)                               \
  45   ((void) (LIKELY(expr) ? 0 :                                           \
  46            (VG_(assert_fail) (/*isCore?*/False, #expr,                  \
  47                               __FILE__, __LINE__,                       \
  48                               __PRETTY_FUNCTION__,                      \
  49                               format, ##args),                          \
  50                               0)))
  51
  52 __attribute__ ((__noreturn__))
  53 extern void VG_(exit)( Int status );
  54
  55 /* Prints a panic message, appends newline and bug reporting info, aborts. */
  56 __attribute__ ((__noreturn__))
  57 extern void  VG_(tool_panic) ( const HChar* str );
  58
  59 __attribute__ ((__noreturn__))
  60 extern void VG_(assert_fail) ( Bool isCore, const HChar* expr, const HChar* file,
  61                                Int line, const HChar* fn,
  62                                const HChar* format, ... );
  63
  64 /* Show the state of various threads related information, such
  65    as the guest stacktrace for each thread.
  66    Mostly for debugging V.
  67    The following activates optional output:
  68      host_stacktrace : shows the host stacktrace.
  69      stack_usage True means:
  70                    shows how much of the valgrind stack was used.
  71                    shows the client stack range
  72      exited_thread_slots : show information for thread slots that were used
  73         but the thread has now exited. */
  74 extern void VG_(show_sched_status) ( Bool host_stacktrace,
  75                                      Bool stack_usage,
  76                                      Bool exited_threads);
  77
  78 #endif   // __PUB_TOOL_LIBCBASSERT_H
  79
  80 /*--------------------------------------------------------------------*/
  81 /*--- end                                                          ---*/
  82 /*--------------------------------------------------------------------*/