From 0a99e4099b66a026f8c69d22d382e5e30ebe6f5e Mon Sep 17 00:00:00 2001
From: Scott Griepentrog <sgriepentrog@digium.com>
Date: Fri, 18 Jul 2014 17:55:38 +0000
Subject: [PATCH] astobj2: assert on invalid ref and backtrace cleanup

If a reference count goes negative, instead of
just logging that fact, be more helpful with a
backtrace and an assert that will DO_CRASH.

This patch also removes the duplicate ao2_bt()
function and cleans up extraneous usage of the
ast_log_backtrace() call.

Review: https://reviewboard.asterisk.org/r/3765/



git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@418963 65c4cc65-6c06-0410-ace0-fbb531ad65f3
---
 include/asterisk/astobj2.h |  3 ---
 main/astobj2.c             | 27 +++------------------------
 main/logger.c              |  6 +++---
 main/utils.c               |  2 +-
 res/res_pjsip_pubsub.c     |  2 --
 5 files changed, 7 insertions(+), 33 deletions(-)

diff --git a/include/asterisk/astobj2.h b/include/asterisk/astobj2.h
index f10e1d3dec..692cc7cb44 100644
--- a/include/asterisk/astobj2.h
+++ b/include/asterisk/astobj2.h
@@ -1961,9 +1961,6 @@ void *__ao2_iterator_next(struct ao2_iterator *iter) attribute_warn_unused_resul
  */
 void ao2_iterator_restart(struct ao2_iterator *iter);
 
-/* extra functions */
-void ao2_bt(void);	/* backtrace */
-
 /*! gcc __attribute__(cleanup()) functions
  * \note they must be able to handle NULL parameters because most of the
  * allocation/find functions can fail and we don't want to try to tear
diff --git a/main/astobj2.c b/main/astobj2.c
index d2592ecb52..2dd9f05362 100644
--- a/main/astobj2.c
+++ b/main/astobj2.c
@@ -97,29 +97,6 @@ struct astobj2_rwlock {
 struct ao2_stats ao2;
 #endif
 
-#ifdef HAVE_BKTR
-#include <execinfo.h>    /* for backtrace */
-#endif
-
-void ao2_bt(void)
-{
-#ifdef HAVE_BKTR
-	int depth;
-	int idx;
-#define N1	20
-	void *addresses[N1];
-	char **strings;
-
-	depth = backtrace(addresses, N1);
-	strings = ast_bt_get_symbols(addresses, depth);
-	ast_verbose("backtrace returned: %d\n", depth);
-	for (idx = 0; idx < depth; ++idx) {
-		ast_verbose("%d: %p %s\n", idx, addresses[idx], strings[idx]);
-	}
-	ast_std_free(strings);
-#endif
-}
-
 #define INTERNAL_OBJ_MUTEX(user_data) \
 	((struct astobj2_lock *) (((char *) (user_data)) - sizeof(struct astobj2_lock)))
 
@@ -455,6 +432,9 @@ static int internal_ao2_ref(void *user_data, int delta, const char *file, int li
 	if (current_value < 0) {
 		ast_log(__LOG_ERROR, file, line, func,
 			"Invalid refcount %d on ao2 object %p\n", current_value, user_data);
+		ast_assert(0);
+		/* stop here even if assert doesn't DO_CRASH */
+		return -1;
 	}
 
 	/* last reference, destroy the object */
@@ -516,7 +496,6 @@ int __ao2_ref_debug(void *user_data, int delta, const char *tag, const char *fil
 	}
 
 	if (obj == NULL) {
-		ast_log_backtrace();
 		ast_assert(0);
 	}
 
diff --git a/main/logger.c b/main/logger.c
index 86cd0d4a66..13d074c6db 100644
--- a/main/logger.c
+++ b/main/logger.c
@@ -1759,14 +1759,14 @@ void ast_log_backtrace(void)
 	}
 
 	if ((strings = ast_bt_get_symbols(bt->addresses, bt->num_frames))) {
-		ast_debug(1, "Got %d backtrace record%c\n", bt->num_frames, bt->num_frames != 1 ? 's' : ' ');
+		ast_verbose("Got %d backtrace record%c\n", bt->num_frames, bt->num_frames != 1 ? 's' : ' ');
 		for (i = 3; i < bt->num_frames - 2; i++) {
-			ast_debug(1, "#%d: [%p] %s\n", i - 3, bt->addresses[i], strings[i]);
+			ast_verbose("#%d: [%p] %s\n", i - 3, bt->addresses[i], strings[i]);
 		}
 
 		ast_std_free(strings);
 	} else {
-		ast_debug(1, "Could not allocate memory for backtrace\n");
+		ast_verbose("Could not allocate memory for backtrace\n");
 	}
 	ast_bt_destroy(bt);
 #else
diff --git a/main/utils.c b/main/utils.c
index b32e71b6c1..0097487a32 100644
--- a/main/utils.c
+++ b/main/utils.c
@@ -2544,7 +2544,7 @@ void __ast_assert_failed(int condition, const char *condition_str, const char *f
 		condition_str, condition, line, function, file);
 
 	/* Generate a backtrace for the assert */
-	ao2_bt();
+	ast_log_backtrace();
 
 	/*
 	 * Give the logger a chance to get the message out, just in case
diff --git a/res/res_pjsip_pubsub.c b/res/res_pjsip_pubsub.c
index cfda0aeb59..2b283079a4 100644
--- a/res/res_pjsip_pubsub.c
+++ b/res/res_pjsip_pubsub.c
@@ -992,8 +992,6 @@ int ast_sip_subscription_notify(struct ast_sip_subscription *sub, void *notify_d
 			PJSIP_EVSUB_STATE_ACTIVE : PJSIP_EVSUB_STATE_TERMINATED;
 	}
 
-	ast_log_backtrace();
-
 	if (pjsip_evsub_notify(evsub, state, NULL, NULL, &tdata) != PJ_SUCCESS) {
 		ast_free(body_text);
 		return -1;
-- 
GitLab