1ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
2ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
3ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- Assertions, etc.                       pub_core_libcassert.h ---*/
4ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
5ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
6ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*
7ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This file is part of Valgrind, a dynamic binary instrumentation
8ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   framework.
9ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
10663860b1408516d02ebfcb3a9999a134e6cfb223Ben Cheng   Copyright (C) 2000-2012 Julian Seward
11ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown      jseward@acm.org
12ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
13ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This program is free software; you can redistribute it and/or
14ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   modify it under the terms of the GNU General Public License as
15ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   published by the Free Software Foundation; either version 2 of the
16ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   License, or (at your option) any later version.
17ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
18ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   This program is distributed in the hope that it will be useful, but
19ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   WITHOUT ANY WARRANTY; without even the implied warranty of
20ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
21ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   General Public License for more details.
22ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
23ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   You should have received a copy of the GNU General Public License
24ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   along with this program; if not, write to the Free Software
25ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
26ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   02111-1307, USA.
27ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
28ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   The GNU General Public License is contained in the file COPYING.
29ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/
30ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
31ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#ifndef __PUB_CORE_LIBCASSERT_H
32ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define __PUB_CORE_LIBCASSERT_H
33ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
34ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown//--------------------------------------------------------------------
35ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// PURPOSE: This module contains all the libc code related to assertions,
36ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// panics and aborting.
37ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown//--------------------------------------------------------------------
38ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
39ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "pub_tool_libcassert.h"
40ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
41ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Useful for making failing stubs, when certain things haven't yet been
42ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// implemented.
43ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define I_die_here                                             \
44ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   VG_(assert_fail) (/*isCore*//*BOGUS*/True,                  \
45ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                     "Unimplemented functionality",            \
46ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                     __FILE__, __LINE__, __PRETTY_FUNCTION__,  \
47ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                     "valgrind", VG_BUGS_TO, "")
48ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
49ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define vg_assert(expr)                                                 \
50b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov  ((void) (LIKELY(expr) ? 0 :                                           \
51ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown           (VG_(assert_fail) (/*isCore*/True, #expr,                    \
52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                              __FILE__, __LINE__, __PRETTY_FUNCTION__,  \
53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                              ""),                                      \
54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                              0)))
55ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
56ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define vg_assert2(expr, format, args...)                               \
57b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov  ((void) (LIKELY(expr) ? 0 :                                           \
58ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown           (VG_(assert_fail) (/*isCore*/True, #expr,                    \
59ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                              __FILE__, __LINE__, __PRETTY_FUNCTION__,  \
60ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                              format, ##args),                          \
61ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown                              0)))
62ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
63ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown__attribute__ ((__noreturn__))
64ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void  VG_(core_panic)      ( Char* str );
65ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown__attribute__ ((__noreturn__))
66ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void  VG_(core_panic_at)   ( Char* str, UnwindStartRegs* );
67ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
68ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Called when some unhandleable client behaviour is detected.
69ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown   Prints a msg and aborts. */
70ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void VG_(unimplemented) ( Char* msg )
71ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown            __attribute__((__noreturn__));
72ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
73ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Show the state of all threads.  Mostly for debugging V. */
74ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern void VG_(show_sched_status) ( void );
75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif   // __PUB_CORE_LIBCASSERT_H
77ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown
78ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
79ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end                                                          ---*/
80ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/
81