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