coregrind/pub_core_libcassert.h

   1
   2 /*--------------------------------------------------------------------*/
   3 /*--- Assertions, etc.                       pub_core_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, see <http://www.gnu.org/licenses/>.
  25
  26    The GNU General Public License is contained in the file COPYING.
  27 */
  28
  29 #ifndef __PUB_CORE_LIBCASSERT_H
  30 #define __PUB_CORE_LIBCASSERT_H
  31
  32 //--------------------------------------------------------------------
  33 // PURPOSE: This module contains all the libc code related to assertions,
  34 // panics and aborting.
  35 //--------------------------------------------------------------------
  36
  37 #include "pub_tool_libcassert.h"
  38 #include "pub_core_basics.h"      // UnwindStartRegs
  39
  40 // Useful for making failing stubs, when certain things haven't yet been
  41 // implemented.
  42 #define I_die_here                                             \
  43    VG_(assert_fail) (/*isCore*//*BOGUS*/True,                  \
  44                      "Unimplemented functionality",            \
  45                      __FILE__, __LINE__, __PRETTY_FUNCTION__,  \
  46                      "valgrind", VG_BUGS_TO, "")
  47
  48 #define vg_assert(expr)                                                 \
  49   ((void) (LIKELY(expr) ? 0 :                                           \
  50            (VG_(assert_fail) (/*isCore*/True, #expr,                    \
  51                               __FILE__, __LINE__, __PRETTY_FUNCTION__,  \
  52                               ""),                                      \
  53                               0)))
  54
  55 #define vg_assert2(expr, format, args...)                               \
  56   ((void) (LIKELY(expr) ? 0 :                                           \
  57            (VG_(assert_fail) (/*isCore*/True, #expr,                    \
  58                               __FILE__, __LINE__, __PRETTY_FUNCTION__,  \
  59                               format, ##args),                          \
  60                               0)))
  61
  62 __attribute__ ((__noreturn__))
  63 extern void  VG_(core_panic)      ( const HChar* str );
  64 __attribute__ ((__noreturn__))
  65 extern void  VG_(core_panic_at)   ( const HChar* str, const UnwindStartRegs* );
  66
  67 /* Exits with status as client exit code. */
  68 extern void VG_(client_exit)( Int status );
  69
  70 /* Lightweight exit without any dependencies. */
  71 __attribute__ ((__noreturn__))
  72 extern void VG_(exit_now)( Int status );
  73
  74 /* Called when some unhandleable client behaviour is detected.
  75    Prints a msg and aborts. */
  76 extern void VG_(unimplemented) ( const HChar* format, ... )
  77             __attribute__((__noreturn__))
  78             PRINTF_CHECK(1, 2);
  79
  80 #endif   // __PUB_CORE_LIBCASSERT_H
  81
  82 /*--------------------------------------------------------------------*/
  83 /*--- end                                                          ---*/
  84 /*--------------------------------------------------------------------*/