mirror of
https://gitlab.torproject.org/tpo/core/tor.git
synced 2024-11-11 05:33:47 +01:00
Move tor_assert implementation into its own header/module.
This commit is contained in:
Nick Mathewson
parent
705d3b221e
commit
7865402106
@ -68,6 +68,7 @@ LIBOR_A_SOURCES = \
|
||||
src/common/log.c \
|
||||
src/common/memarea.c \
|
||||
src/common/util.c \
|
||||
src/common/util_bug.c \
|
||||
src/common/util_format.c \
|
||||
src/common/util_process.c \
|
||||
src/common/sandbox.c \
|
||||
@ -139,6 +140,7 @@ COMMONHEADERS = \
|
||||
src/common/torlog.h \
|
||||
src/common/tortls.h \
|
||||
src/common/util.h \
|
||||
src/common/util_bug.h \
|
||||
src/common/util_format.h \
|
||||
src/common/util_process.h \
|
||||
src/common/workqueue.h
|
||||
|
||||
@ -104,23 +104,6 @@
|
||||
#undef MALLOC_ZERO_WORKS
|
||||
#endif
|
||||
|
||||
/* =====
|
||||
* Assertion helper.
|
||||
* ===== */
|
||||
/** Helper for tor_assert: report the assertion failure. */
|
||||
void
|
||||
tor_assertion_failed_(const char *fname, unsigned int line,
|
||||
const char *func, const char *expr)
|
||||
{
|
||||
char buf[256];
|
||||
log_err(LD_BUG, "%s:%u: %s: Assertion %s failed; aborting.",
|
||||
fname, line, func, expr);
|
||||
tor_snprintf(buf, sizeof(buf),
|
||||
"Assertion %s failed in %s at %s:%u",
|
||||
expr, func, fname, line);
|
||||
log_backtrace(LOG_ERR, LD_BUG, buf);
|
||||
}
|
||||
|
||||
/* =====
|
||||
* Memory management
|
||||
* ===== */
|
||||
|
||||
@ -22,6 +22,7 @@
|
||||
/* for the correct alias to struct stat */
|
||||
#include <sys/stat.h>
|
||||
#endif
|
||||
#include "util_bug.h"
|
||||
|
||||
#ifndef O_BINARY
|
||||
#define O_BINARY 0
|
||||
@ -33,41 +34,6 @@
|
||||
#define O_NOFOLLOW 0
|
||||
#endif
|
||||
|
||||
/* Replace assert() with a variant that sends failures to the log before
|
||||
* calling assert() normally.
|
||||
*/
|
||||
#ifdef NDEBUG
|
||||
/* Nobody should ever want to build with NDEBUG set. 99% of our asserts will
|
||||
* be outside the critical path anyway, so it's silly to disable bug-checking
|
||||
* throughout the entire program just because a few asserts are slowing you
|
||||
* down. Profile, optimize the critical path, and keep debugging on.
|
||||
*
|
||||
* And I'm not just saying that because some of our asserts check
|
||||
* security-critical properties.
|
||||
*/
|
||||
#error "Sorry; we don't support building with NDEBUG."
|
||||
#endif
|
||||
|
||||
/* Sometimes we don't want to use assertions during branch coverage tests; it
|
||||
* leads to tons of unreached branches which in reality are only assertions we
|
||||
* didn't hit. */
|
||||
#if defined(TOR_UNIT_TESTS) && defined(DISABLE_ASSERTS_IN_UNIT_TESTS)
|
||||
#define tor_assert(a) STMT_BEGIN \
|
||||
(void)(a); \
|
||||
STMT_END
|
||||
#else
|
||||
/** Like assert(3), but send assertion failures to the log as well as to
|
||||
* stderr. */
|
||||
#define tor_assert(expr) STMT_BEGIN \
|
||||
if (PREDICT_UNLIKELY(!(expr))) { \
|
||||
tor_assertion_failed_(SHORT_FILE__, __LINE__, __func__, #expr); \
|
||||
abort(); \
|
||||
} STMT_END
|
||||
#endif
|
||||
|
||||
void tor_assertion_failed_(const char *fname, unsigned int line,
|
||||
const char *func, const char *expr);
|
||||
|
||||
/* If we're building with dmalloc, we want all of our memory allocation
|
||||
* functions to take an extra file/line pair of arguments. If not, not.
|
||||
* We define DMALLOC_PARAMS to the extra parameters to insert in the
|
||||
@ -81,11 +47,6 @@ void tor_assertion_failed_(const char *fname, unsigned int line,
|
||||
#define DMALLOC_ARGS
|
||||
#endif
|
||||
|
||||
/** Define this if you want Tor to crash when any problem comes up,
|
||||
* so you can get a coredump and track things down. */
|
||||
// #define tor_fragile_assert() tor_assert(0)
|
||||
#define tor_fragile_assert()
|
||||
|
||||
/* Memory management */
|
||||
void *tor_malloc_(size_t size DMALLOC_PARAMS) ATTR_MALLOC;
|
||||
void *tor_malloc_zero_(size_t size DMALLOC_PARAMS) ATTR_MALLOC;
|
||||
|
||||
28
src/common/util_bug.c
Normal file
28
src/common/util_bug.c
Normal file
@ -0,0 +1,28 @@
|
||||
/* Copyright (c) 2003, Roger Dingledine
|
||||
* Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
|
||||
* Copyright (c) 2007-2016, The Tor Project, Inc. */
|
||||
/* See LICENSE for licensing information */
|
||||
|
||||
/**
|
||||
* \file util_bug.c
|
||||
**/
|
||||
|
||||
#include "orconfig.h"
|
||||
#include "util_bug.h"
|
||||
#include "torlog.h"
|
||||
#include "backtrace.h"
|
||||
|
||||
/** Helper for tor_assert: report the assertion failure. */
|
||||
void
|
||||
tor_assertion_failed_(const char *fname, unsigned int line,
|
||||
const char *func, const char *expr)
|
||||
{
|
||||
char buf[256];
|
||||
log_err(LD_BUG, "%s:%u: %s: Assertion %s failed; aborting.",
|
||||
fname, line, func, expr);
|
||||
tor_snprintf(buf, sizeof(buf),
|
||||
"Assertion %s failed in %s at %s:%u",
|
||||
expr, func, fname, line);
|
||||
log_backtrace(LOG_ERR, LD_BUG, buf);
|
||||
}
|
||||
|
||||
58
src/common/util_bug.h
Normal file
58
src/common/util_bug.h
Normal file
@ -0,0 +1,58 @@
|
||||
/* Copyright (c) 2003-2004, Roger Dingledine
|
||||
* Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
|
||||
* Copyright (c) 2007-2016, The Tor Project, Inc. */
|
||||
/* See LICENSE for licensing information */
|
||||
|
||||
/**
|
||||
* \file util_bug.h
|
||||
**/
|
||||
|
||||
#ifndef TOR_UTIL_BUG_H
|
||||
#define TOR_UTIL_BUG_H
|
||||
|
||||
#include "orconfig.h"
|
||||
#include "compat.h"
|
||||
#include "testsupport.h"
|
||||
|
||||
/* Replace assert() with a variant that sends failures to the log before
|
||||
* calling assert() normally.
|
||||
*/
|
||||
#ifdef NDEBUG
|
||||
/* Nobody should ever want to build with NDEBUG set. 99% of our asserts will
|
||||
* be outside the critical path anyway, so it's silly to disable bug-checking
|
||||
* throughout the entire program just because a few asserts are slowing you
|
||||
* down. Profile, optimize the critical path, and keep debugging on.
|
||||
*
|
||||
* And I'm not just saying that because some of our asserts check
|
||||
* security-critical properties.
|
||||
*/
|
||||
#error "Sorry; we don't support building with NDEBUG."
|
||||
#endif
|
||||
|
||||
/* Sometimes we don't want to use assertions during branch coverage tests; it
|
||||
* leads to tons of unreached branches which in reality are only assertions we
|
||||
* didn't hit. */
|
||||
#if defined(TOR_UNIT_TESTS) && defined(DISABLE_ASSERTS_IN_UNIT_TESTS)
|
||||
#define tor_assert(a) STMT_BEGIN \
|
||||
(void)(a); \
|
||||
STMT_END
|
||||
#else
|
||||
/** Like assert(3), but send assertion failures to the log as well as to
|
||||
* stderr. */
|
||||
#define tor_assert(expr) STMT_BEGIN \
|
||||
if (PREDICT_UNLIKELY(!(expr))) { \
|
||||
tor_assertion_failed_(SHORT_FILE__, __LINE__, __func__, #expr); \
|
||||
abort(); \
|
||||
} STMT_END
|
||||
#endif
|
||||
|
||||
/** Define this if you want Tor to crash when any problem comes up,
|
||||
* so you can get a coredump and track things down. */
|
||||
// #define tor_fragile_assert() tor_assert(0)
|
||||
#define tor_fragile_assert()
|
||||
|
||||
void tor_assertion_failed_(const char *fname, unsigned int line,
|
||||
const char *func, const char *expr);
|
||||
|
||||
#endif
|
||||
|
||||
Loading…
Reference in New Issue
Block a user