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 10436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov Copyright (C) 2000-2013 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" 40436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanov#include "pub_core_basics.h" // UnwindStartRegs 41ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 42ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Useful for making failing stubs, when certain things haven't yet been 43ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// implemented. 44ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define I_die_here \ 45ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_(assert_fail) (/*isCore*//*BOGUS*/True, \ 46ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown "Unimplemented functionality", \ 47ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown __FILE__, __LINE__, __PRETTY_FUNCTION__, \ 48ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown "valgrind", VG_BUGS_TO, "") 49ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 50ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define vg_assert(expr) \ 51b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov ((void) (LIKELY(expr) ? 0 : \ 52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown (VG_(assert_fail) (/*isCore*/True, #expr, \ 53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown __FILE__, __LINE__, __PRETTY_FUNCTION__, \ 54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ""), \ 55ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 0))) 56ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 57ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define vg_assert2(expr, format, args...) \ 58b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov ((void) (LIKELY(expr) ? 0 : \ 59ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown (VG_(assert_fail) (/*isCore*/True, #expr, \ 60ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown __FILE__, __LINE__, __PRETTY_FUNCTION__, \ 61ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown format, ##args), \ 62ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 0))) 63ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 64ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown__attribute__ ((__noreturn__)) 65436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovextern void VG_(core_panic) ( const HChar* str ); 66ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown__attribute__ ((__noreturn__)) 67436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovextern void VG_(core_panic_at) ( const HChar* str, UnwindStartRegs* ); 68ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 69eb0bae136f4eeaaf29761dddb148b118fb824632Dmitriy Ivanov/* Exits with status as client exit code. */ 70eb0bae136f4eeaaf29761dddb148b118fb824632Dmitriy Ivanovextern void VG_(client_exit)( Int status ); 71eb0bae136f4eeaaf29761dddb148b118fb824632Dmitriy Ivanov 72ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Called when some unhandleable client behaviour is detected. 73ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Prints a msg and aborts. */ 74436e89c602e787e7a27dd6624b09beed41a0da8aDmitriy Ivanovextern void VG_(unimplemented) ( const HChar* msg ) 75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown __attribute__((__noreturn__)); 76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 77eb0bae136f4eeaaf29761dddb148b118fb824632Dmitriy Ivanov/* Show the state of various threads related information, such 78eb0bae136f4eeaaf29761dddb148b118fb824632Dmitriy Ivanov as the guest stacktrace for each thread. 79eb0bae136f4eeaaf29761dddb148b118fb824632Dmitriy Ivanov Mostly for debugging V. 80eb0bae136f4eeaaf29761dddb148b118fb824632Dmitriy Ivanov The following activates optional output: 81eb0bae136f4eeaaf29761dddb148b118fb824632Dmitriy Ivanov host_stacktrace : shows the host stacktrace. 82eb0bae136f4eeaaf29761dddb148b118fb824632Dmitriy Ivanov valgrind_stack_usage : shows how much of the valgrind stack was used. 83eb0bae136f4eeaaf29761dddb148b118fb824632Dmitriy Ivanov exited_thread_slots : show information for thread slots that were used 84eb0bae136f4eeaaf29761dddb148b118fb824632Dmitriy Ivanov but the thread has now exited. */ 85eb0bae136f4eeaaf29761dddb148b118fb824632Dmitriy Ivanovextern void VG_(show_sched_status) ( Bool host_stacktrace, 86eb0bae136f4eeaaf29761dddb148b118fb824632Dmitriy Ivanov Bool valgrind_stack_usage, 87eb0bae136f4eeaaf29761dddb148b118fb824632Dmitriy Ivanov Bool exited_threads); 88ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 89ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif // __PUB_CORE_LIBCASSERT_H 90ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 91ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 92ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end ---*/ 93ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 94