pub_core_libcassert.h revision ed07e00d438c74b7a23c01bfffde77e3968305e4 
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-2010 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
41// Useful for making failing stubs, when certain things haven't yet been
42// implemented.
43#define I_die_here                                             \
44   VG_(assert_fail) (/*isCore*//*BOGUS*/True,                  \
45                     "Unimplemented functionality",            \
46                     __FILE__, __LINE__, __PRETTY_FUNCTION__,  \
47                     "valgrind", VG_BUGS_TO, "")
48
49#define vg_assert(expr)                                                 \
50  ((void) ((expr) ? 0 :                                                 \
51           (VG_(assert_fail) (/*isCore*/True, #expr,                    \
52                              __FILE__, __LINE__, __PRETTY_FUNCTION__,  \
53                              ""),                                      \
54                              0)))
55
56#define vg_assert2(expr, format, args...)                               \
57  ((void) ((expr) ? 0 :                                                 \
58           (VG_(assert_fail) (/*isCore*/True, #expr,                    \
59                              __FILE__, __LINE__, __PRETTY_FUNCTION__,  \
60                              format, ##args),                          \
61                              0)))
62
63__attribute__ ((__noreturn__))
64extern void  VG_(core_panic)      ( Char* str );
65__attribute__ ((__noreturn__))
66extern void  VG_(core_panic_at)   ( Char* str, UnwindStartRegs* );
67
68/* Called when some unhandleable client behaviour is detected.
69   Prints a msg and aborts. */
70extern void VG_(unimplemented) ( Char* msg )
71            __attribute__((__noreturn__));
72
73/* Show the state of all threads.  Mostly for debugging V. */
74extern void VG_(show_sched_status) ( void );
75
76#endif   // __PUB_CORE_LIBCASSERT_H
77
78/*--------------------------------------------------------------------*/
79/*--- end                                                          ---*/
80/*--------------------------------------------------------------------*/
81