Move util_bug into libtor-log

6 files changed, 3 insertions, 363 deletions

diff --git a/src/common/address.h b/src/common/address.h
index 8abff072c0..b95ee364ab 100644
--- a/src/common/address.h
+++ b/src/common/address.h
@@ -15,7 +15,7 @@
 #include "orconfig.h"
 #include "lib/cc/torint.h"
 #include "common/compat.h"
-#include "common/util_bug.h"
+#include "lib/log/util_bug.h"
 
 #ifdef ADDRESS_PRIVATE
 
diff --git a/src/common/include.am b/src/common/include.am
index d4404fb1b7..4927f57425 100644
--- a/src/common/include.am
+++ b/src/common/include.am
@@ -40,7 +40,6 @@ LIBOR_A_SRC = \
   src/common/confline.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					\
@@ -94,7 +93,6 @@ COMMONHEADERS = \
   src/common/timers.h				\
   src/common/token_bucket.h			\
   src/common/util.h				\
-  src/common/util_bug.h				\
   src/common/util_format.h			\
   src/common/util_process.h			\
   src/common/workqueue.h
diff --git a/src/common/token_bucket.c b/src/common/token_bucket.c
index 502e8eac56..3a16720d7f 100644
--- a/src/common/token_bucket.c
+++ b/src/common/token_bucket.c
@@ -20,7 +20,7 @@
 
 #include "common/token_bucket.h"
 #include "common/compat.h"
-#include "common/util_bug.h"
+#include "lib/log/util_bug.h"
 
 /**
  * Set the <b>rate</b> and <b>burst</b> value in a token_bucket_cfg.
diff --git a/src/common/util.h b/src/common/util.h
index 3f6476d753..d1b4e8fe9e 100644
--- a/src/common/util.h
+++ b/src/common/util.h
@@ -32,7 +32,7 @@
 #include "lib/intmath/muldiv.h"
 #include "lib/intmath/cmp.h"
 #include "lib/log/ratelim.h"
-#include "common/util_bug.h"
+#include "lib/log/util_bug.h"
 
 #ifndef O_BINARY
 #define O_BINARY 0
diff --git a/src/common/util_bug.c b/src/common/util_bug.c
deleted file mode 100644
index c68519b746..0000000000
--- a/src/common/util_bug.c
+++ /dev/null
@@ -1,148 +0,0 @@
-/* Copyright (c) 2003, Roger Dingledine
- * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
- * Copyright (c) 2007-2018, The Tor Project, Inc. */
-/* See LICENSE for licensing information */
-
-/**
- * \file util_bug.c
- **/
-
-#include "orconfig.h"
-#include "common/util_bug.h"
-#include "lib/log/torlog.h"
-#include "lib/err/backtrace.h"
-#ifdef TOR_UNIT_TESTS
-#include "lib/container/smartlist.h"
-#endif
-#include "lib/malloc/util_malloc.h"
-#include "lib/string/printf.h"
-
-#ifdef __COVERITY__
-int bug_macro_deadcode_dummy__ = 0;
-#endif
-
-#ifdef TOR_UNIT_TESTS
-static void (*failed_assertion_cb)(void) = NULL;
-static int n_bugs_to_capture = 0;
-static smartlist_t *bug_messages = NULL;
-#define capturing_bugs() (bug_messages != NULL && n_bugs_to_capture)
-void
-tor_capture_bugs_(int n)
-{
-  tor_end_capture_bugs_();
-  bug_messages = smartlist_new();
-  n_bugs_to_capture = n;
-}
-void
-tor_end_capture_bugs_(void)
-{
-  n_bugs_to_capture = 0;
-  if (!bug_messages)
-    return;
-  SMARTLIST_FOREACH(bug_messages, char *, cp, tor_free(cp));
-  smartlist_free(bug_messages);
-nn  bug_messages = NULL;
-}
-const smartlist_t *
-tor_get_captured_bug_log_(void)
-{
-  return bug_messages;
-}
-static void
-add_captured_bug(const char *s)
-{
-  --n_bugs_to_capture;
-  smartlist_add_strdup(bug_messages, s);
-}
-/** Set a callback to be invoked when we get any tor_bug_occurred_
- * invocation. We use this in the unit tests so that a nonfatal
- * assertion failure can also count as a test failure.
- */
-void
-tor_set_failed_assertion_callback(void (*fn)(void))
-{
-  failed_assertion_cb = fn;
-}
-#else /* !(defined(TOR_UNIT_TESTS)) */
-#define capturing_bugs() (0)
-#define add_captured_bug(s) do { } while (0)
-#endif /* defined(TOR_UNIT_TESTS) */
-
-/** 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);
-}
-
-/** Helper for tor_assert_nonfatal: report the assertion failure. */
-void
-tor_bug_occurred_(const char *fname, unsigned int line,
-                  const char *func, const char *expr,
-                  int once)
-{
-  char buf[256];
-  const char *once_str = once ?
-    " (Future instances of this warning will be silenced.)": "";
-  if (! expr) {
-    if (capturing_bugs()) {
-      add_captured_bug("This line should not have been reached.");
-      return;
-    }
-    log_warn(LD_BUG, "%s:%u: %s: This line should not have been reached.%s",
-             fname, line, func, once_str);
-    tor_snprintf(buf, sizeof(buf),
-                 "Line unexpectedly reached at %s at %s:%u",
-                 func, fname, line);
-  } else {
-    if (capturing_bugs()) {
-      add_captured_bug(expr);
-      return;
-    }
-    log_warn(LD_BUG, "%s:%u: %s: Non-fatal assertion %s failed.%s",
-             fname, line, func, expr, once_str);
-    tor_snprintf(buf, sizeof(buf),
-                 "Non-fatal assertion %s failed in %s at %s:%u",
-                 expr, func, fname, line);
-  }
-  log_backtrace(LOG_WARN, LD_BUG, buf);
-
-#ifdef TOR_UNIT_TESTS
-  if (failed_assertion_cb) {
-    failed_assertion_cb();
-  }
-#endif
-}
-
-#ifdef _WIN32
-/** Take a filename and return a pointer to its final element.  This
- * function is called on __FILE__ to fix a MSVC nit where __FILE__
- * contains the full path to the file.  This is bad, because it
- * confuses users to find the home directory of the person who
- * compiled the binary in their warning messages.
- */
-const char *
-tor_fix_source_file(const char *fname)
-{
-  const char *cp1, *cp2, *r;
-  cp1 = strrchr(fname, '/');
-  cp2 = strrchr(fname, '\\');
-  if (cp1 && cp2) {
-    r = (cp1<cp2)?(cp2+1):(cp1+1);
-  } else if (cp1) {
-    r = cp1+1;
-  } else if (cp2) {
-    r = cp2+1;
-  } else {
-    r = fname;
-  }
-  return r;
-}
-#endif /* defined(_WIN32) */
diff --git a/src/common/util_bug.h b/src/common/util_bug.h
deleted file mode 100644
index a0753c807b..0000000000
--- a/src/common/util_bug.h
+++ /dev/null
@@ -1,210 +0,0 @@
-/* Copyright (c) 2003-2004, Roger Dingledine
- * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
- * Copyright (c) 2007-2018, The Tor Project, Inc. */
-/* See LICENSE for licensing information */
-
-/**
- * \file util_bug.h
- *
- * \brief Macros to manage assertions, fatal and non-fatal.
- *
- * Guidelines: All the different kinds of assertion in this file are for
- * bug-checking only. Don't write code that can assert based on bad inputs.
- *
- * We provide two kinds of assertion here: "fatal" and "nonfatal". Use
- * nonfatal assertions for any bug you can reasonably recover from -- and
- * please, try to recover!  Many severe bugs in Tor have been caused by using
- * a regular assertion when a nonfatal assertion would have been better.
- *
- * If you need to check a condition with a nonfatal assertion, AND recover
- * from that same condition, consider using the BUG() macro inside a
- * conditional.  For example:
- *
- * <code>
- *  // wrong -- use tor_assert_nonfatal() if you just want an assertion.
- *  BUG(ptr == NULL);
- *
- *  // okay, but needlessly verbose
- *  tor_assert_nonfatal(ptr != NULL);
- *  if (ptr == NULL) { ... }
- *
- *  // this is how we do it:
- *  if (BUG(ptr == NULL)) { ... }
- * </code>
- **/
-
-#ifndef TOR_UTIL_BUG_H
-#define TOR_UTIL_BUG_H
-
-#include "orconfig.h"
-#include "lib/cc/compat_compiler.h"
-#include "lib/log/torlog.h"
-#include "lib/testsupport/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 /* defined(NDEBUG) */
-
-/* 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 /* defined(TOR_UNIT_TESTS) && defined(DISABLE_ASSERTS_IN_UNIT_TESTS) */
-
-#define tor_assert_unreached() tor_assert(0)
-
-/* Non-fatal bug assertions. The "unreached" variants mean "this line should
- * never be reached." The "once" variants mean "Don't log a warning more than
- * once".
- *
- * The 'BUG' macro checks a boolean condition and logs an error message if it
- * is true.  Example usage:
- *   if (BUG(x == NULL))
- *     return -1;
- */
-
-#ifdef __COVERITY__
-extern int bug_macro_deadcode_dummy__;
-#undef BUG
-// Coverity defines this in global headers; let's override it.  This is a
-// magic coverity-only preprocessor thing.
-// We use this "deadcode_dummy__" trick to prevent coverity from
-// complaining about unreachable bug cases.
-#nodef BUG(x) ((x)?(__coverity_panic__(),1):(0+bug_macro_deadcode_dummy__))
-#endif /* defined(__COVERITY__) */
-
-#if defined(__COVERITY__) || defined(__clang_analyzer__)
-// We're running with a static analysis tool: let's treat even nonfatal
-// assertion failures as something that we need to avoid.
-#define ALL_BUGS_ARE_FATAL
-#endif
-
-#ifdef ALL_BUGS_ARE_FATAL
-#define tor_assert_nonfatal_unreached() tor_assert(0)
-#define tor_assert_nonfatal(cond) tor_assert((cond))
-#define tor_assert_nonfatal_unreached_once() tor_assert(0)
-#define tor_assert_nonfatal_once(cond) tor_assert((cond))
-#define BUG(cond)                                                       \
-  (PREDICT_UNLIKELY(cond) ?                                             \
-   (tor_assertion_failed_(SHORT_FILE__,__LINE__,__func__,"!("#cond")"), \
-    abort(), 1)                                                         \
-   : 0)
-#elif defined(TOR_UNIT_TESTS) && defined(DISABLE_ASSERTS_IN_UNIT_TESTS)
-#define tor_assert_nonfatal_unreached() STMT_NIL
-#define tor_assert_nonfatal(cond) ((void)(cond))
-#define tor_assert_nonfatal_unreached_once() STMT_NIL
-#define tor_assert_nonfatal_once(cond) ((void)(cond))
-#define BUG(cond) (PREDICT_UNLIKELY(cond) ? 1 : 0)
-#else /* Normal case, !ALL_BUGS_ARE_FATAL, !DISABLE_ASSERTS_IN_UNIT_TESTS */
-#define tor_assert_nonfatal_unreached() STMT_BEGIN                      \
-  tor_bug_occurred_(SHORT_FILE__, __LINE__, __func__, NULL, 0);         \
-  STMT_END
-#define tor_assert_nonfatal(cond) STMT_BEGIN                            \
-  if (PREDICT_UNLIKELY(!(cond))) {                                      \
-    tor_bug_occurred_(SHORT_FILE__, __LINE__, __func__, #cond, 0);  \
-  }                                                                     \
-  STMT_END
-#define tor_assert_nonfatal_unreached_once() STMT_BEGIN                 \
-  static int warning_logged__ = 0;                                      \
-  if (!warning_logged__) {                                              \
-    warning_logged__ = 1;                                               \
-    tor_bug_occurred_(SHORT_FILE__, __LINE__, __func__, NULL, 1);       \
-  }                                                                     \
-  STMT_END
-#define tor_assert_nonfatal_once(cond) STMT_BEGIN                       \
-  static int warning_logged__ = 0;                                      \
-  if (!warning_logged__ && PREDICT_UNLIKELY(!(cond))) {                 \
-    warning_logged__ = 1;                                               \
-    tor_bug_occurred_(SHORT_FILE__, __LINE__, __func__, #cond, 1);      \
-  }                                                                     \
-  STMT_END
-#define BUG(cond)                                                       \
-  (PREDICT_UNLIKELY(cond) ?                                             \
-   (tor_bug_occurred_(SHORT_FILE__,__LINE__,__func__,"!("#cond")",0), 1) \
-   : 0)
-#endif /* defined(ALL_BUGS_ARE_FATAL) || ... */
-
-#ifdef __GNUC__
-#define IF_BUG_ONCE__(cond,var)                                         \
-  if (( {                                                               \
-      static int var = 0;                                               \
-      int bool_result = (cond);                                         \
-      if (PREDICT_UNLIKELY(bool_result) && !var) {                      \
-        var = 1;                                                        \
-        tor_bug_occurred_(SHORT_FILE__, __LINE__, __func__,             \
-                          "!("#cond")", 1);                             \
-      }                                                                 \
-      PREDICT_UNLIKELY(bool_result); } ))
-#else /* !(defined(__GNUC__)) */
-#define IF_BUG_ONCE__(cond,var)                                         \
-  static int var = 0;                                                   \
-  if (PREDICT_UNLIKELY(cond) ?                                          \
-      (var ? 1 :                                                        \
-       (var=1,                                                          \
-        tor_bug_occurred_(SHORT_FILE__, __LINE__, __func__,             \
-                           "!("#cond")", 1),                            \
-        1))                                                             \
-      : 0)
-#endif /* defined(__GNUC__) */
-#define IF_BUG_ONCE_VARNAME_(a)               \
-  warning_logged_on_ ## a ## __
-#define IF_BUG_ONCE_VARNAME__(a)              \
-  IF_BUG_ONCE_VARNAME_(a)
-
-/** This macro behaves as 'if (bug(x))', except that it only logs its
- * warning once, no matter how many times it triggers.
- */
-
-#define IF_BUG_ONCE(cond)                                       \
-  IF_BUG_ONCE__((cond),                                         \
-                IF_BUG_ONCE_VARNAME__(__LINE__))
-
-/** 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_unreached(0)
-#define tor_fragile_assert() tor_assert_nonfatal_unreached_once()
-
-void tor_assertion_failed_(const char *fname, unsigned int line,
-                           const char *func, const char *expr);
-void tor_bug_occurred_(const char *fname, unsigned int line,
-                       const char *func, const char *expr,
-                       int once);
-
-#ifdef _WIN32
-#define SHORT_FILE__ (tor_fix_source_file(__FILE__))
-const char *tor_fix_source_file(const char *fname);
-#else
-#define SHORT_FILE__ (__FILE__)
-#define tor_fix_source_file(s) (s)
-#endif /* defined(_WIN32) */
-
-#ifdef TOR_UNIT_TESTS
-void tor_capture_bugs_(int n);
-void tor_end_capture_bugs_(void);
-const struct smartlist_t *tor_get_captured_bug_log_(void);
-void tor_set_failed_assertion_callback(void (*fn)(void));
-#endif /* defined(TOR_UNIT_TESTS) */
-
-#endif /* !defined(TOR_UTIL_BUG_H) */