From dd873bcada4e257ba8e8b497b1a36036b09f5635 Mon Sep 17 00:00:00 2001
From: Corey Farrell <git@cfware.com>
Date: Fri, 7 Oct 2016 18:32:16 -0400
Subject: [PATCH] astobj2: Add backtrace to log_bad_ao2.

* Compile __ast_assert_failed unconditionally.
* Use __ast_assert_failed to log messages from log_bad_ao2
* Remove calls to ast_assert(0) that happen after log_bad_ao2 was run.

Change-Id: I48f1af44b2718ad74a421ff75cb6397b924a9751
---
 include/asterisk/utils.h |  4 +++-
 main/astobj2.c           | 25 ++++++-------------------
 main/astobj2_container.c | 36 +++++++++++++++++++++++++-----------
 main/astobj2_hash.c      |  4 +++-
 main/astobj2_rbtree.c    |  4 +++-
 main/utils.c             |  6 ++----
 6 files changed, 42 insertions(+), 37 deletions(-)

diff --git a/include/asterisk/utils.h b/include/asterisk/utils.h
index c3df4779ff..a504a5da13 100644
--- a/include/asterisk/utils.h
+++ b/include/asterisk/utils.h
@@ -849,8 +849,10 @@ int ast_parse_digest(const char *digest, struct ast_http_digest *d, int request,
 #define DO_CRASH_NORETURN
 #endif
 
+void DO_CRASH_NORETURN __ast_assert_failed(int condition, const char *condition_str,
+	const char *file, int line, const char *function);
+
 #ifdef AST_DEVMODE
-void DO_CRASH_NORETURN __ast_assert_failed(int condition, const char *condition_str, const char *file, int line, const char *function);
 #define ast_assert(a) _ast_assert(a, # a, __FILE__, __LINE__, __PRETTY_FUNCTION__)
 static void force_inline _ast_assert(int condition, const char *condition_str, const char *file, int line, const char *function)
 {
diff --git a/main/astobj2.c b/main/astobj2.c
index 1bb5237f1b..f5175ea153 100644
--- a/main/astobj2.c
+++ b/main/astobj2.c
@@ -116,21 +116,17 @@ static struct astobj2 *INTERNAL_OBJ(void *user_data)
 	struct astobj2 *p;
 
 	if (!user_data) {
-		ast_log(LOG_ERROR, "user_data is NULL\n");
+		__ast_assert_failed(0, "user_data is NULL", __FILE__, __LINE__, __PRETTY_FUNCTION__);
 		return NULL;
 	}
 
 	p = (struct astobj2 *) ((char *) user_data - sizeof(*p));
 	if (AO2_MAGIC != p->priv_data.magic) {
-		if (p->priv_data.magic) {
-			ast_log(LOG_ERROR, "bad magic number 0x%x for object %p\n",
-				p->priv_data.magic, user_data);
-		} else {
-			ast_log(LOG_ERROR,
-				"bad magic number for object %p. Object is likely destroyed.\n",
-				user_data);
-		}
-		ast_assert(0);
+		char bad_magic[100];
+
+		snprintf(bad_magic, sizeof(bad_magic), "bad magic number 0x%x for object %p",
+			p->priv_data.magic, user_data);
+		__ast_assert_failed(0, bad_magic, __FILE__, __LINE__, __PRETTY_FUNCTION__);
 		return NULL;
 	}
 
@@ -157,7 +153,6 @@ int __ao2_lock(void *user_data, enum ao2_lock_req lock_how, const char *file, co
 	int res = 0;
 
 	if (obj == NULL) {
-		ast_assert(0);
 		return -1;
 	}
 
@@ -216,7 +211,6 @@ int __ao2_unlock(void *user_data, const char *file, const char *func, int line,
 	int current_value;
 
 	if (obj == NULL) {
-		ast_assert(0);
 		return -1;
 	}
 
@@ -265,7 +259,6 @@ int __ao2_trylock(void *user_data, enum ao2_lock_req lock_how, const char *file,
 	int res = 0;
 
 	if (obj == NULL) {
-		ast_assert(0);
 		return -1;
 	}
 
@@ -385,7 +378,6 @@ void *ao2_object_get_lockaddr(void *user_data)
 	struct astobj2_lock *obj_mutex;
 
 	if (obj == NULL) {
-		ast_assert(0);
 		return NULL;
 	}
 
@@ -409,7 +401,6 @@ static int internal_ao2_ref(void *user_data, int delta, const char *file, int li
 	int ret;
 
 	if (obj == NULL) {
-		ast_assert(0);
 		return -1;
 	}
 
@@ -504,10 +495,6 @@ int __ao2_ref_debug(void *user_data, int delta, const char *tag, const char *fil
 		}
 	}
 
-	if (obj == NULL) {
-		ast_assert(0);
-	}
-
 	return old_refcount;
 }
 
diff --git a/main/astobj2_container.c b/main/astobj2_container.c
index 5a27a0ae55..466c10372b 100644
--- a/main/astobj2_container.c
+++ b/main/astobj2_container.c
@@ -103,8 +103,11 @@ static int internal_ao2_link(struct ao2_container *self, void *obj_new, int flag
 	enum ao2_lock_req orig_lock;
 	struct ao2_container_node *node;
 
-	if (!is_ao2_object(obj_new) || !is_ao2_object(self)
-		|| !self->v_table || !self->v_table->new_node || !self->v_table->insert) {
+	if (!is_ao2_object(obj_new) || !is_ao2_object(self)) {
+		return 0;
+	}
+
+	if (!self->v_table || !self->v_table->new_node || !self->v_table->insert) {
 		/* Sanity checks. */
 		ast_assert(0);
 		return 0;
@@ -187,8 +190,6 @@ void *__ao2_unlink_debug(struct ao2_container *c, void *user_data, int flags,
 	const char *tag, const char *file, int line, const char *func)
 {
 	if (!is_ao2_object(user_data)) {
-		/* Sanity checks. */
-		ast_assert(0);
 		return NULL;
 	}
 
@@ -202,8 +203,6 @@ void *__ao2_unlink_debug(struct ao2_container *c, void *user_data, int flags,
 void *__ao2_unlink(struct ao2_container *c, void *user_data, int flags)
 {
 	if (!is_ao2_object(user_data)) {
-		/* Sanity checks. */
-		ast_assert(0);
 		return NULL;
 	}
 
@@ -268,7 +267,11 @@ static void *internal_ao2_traverse(struct ao2_container *self, enum search_flags
 	struct ao2_container *multi_container = NULL;
 	struct ao2_iterator *multi_iterator = NULL;
 
-	if (!is_ao2_object(self) || !self->v_table || !self->v_table->traverse_first
+	if (!is_ao2_object(self)) {
+		return NULL;
+	}
+
+	if (!self->v_table || !self->v_table->traverse_first
 		|| !self->v_table->traverse_next) {
 		/* Sanity checks. */
 		ast_assert(0);
@@ -512,7 +515,6 @@ void ao2_iterator_restart(struct ao2_iterator *iter)
 {
 	if (!is_ao2_object(iter->c)) {
 		ast_log(LOG_ERROR, "Iterator container is not valid.\n");
-		ast_assert(0);
 		return;
 	}
 
@@ -577,7 +579,11 @@ static void *internal_ao2_iterator_next(struct ao2_iterator *iter, const char *t
 	struct ao2_container_node *node;
 	void *ret;
 
-	if (!is_ao2_object(iter->c) || !iter->c->v_table || !iter->c->v_table->iterator_next) {
+	if (!is_ao2_object(iter->c)) {
+		return NULL;
+	}
+
+	if (!iter->c->v_table || !iter->c->v_table->iterator_next) {
 		/* Sanity checks. */
 		ast_assert(0);
 		return NULL;
@@ -748,7 +754,11 @@ struct ao2_container *__ao2_container_clone(struct ao2_container *orig, enum sea
 	int failed;
 
 	/* Create the clone container with the same properties as the original. */
-	if (!is_ao2_object(orig) || !orig->v_table || !orig->v_table->alloc_empty_clone) {
+	if (!is_ao2_object(orig)) {
+		return NULL;
+	}
+
+	if (!orig->v_table || !orig->v_table->alloc_empty_clone) {
 		/* Sanity checks. */
 		ast_assert(0);
 		return NULL;
@@ -779,7 +789,11 @@ struct ao2_container *__ao2_container_clone_debug(struct ao2_container *orig, en
 	int failed;
 
 	/* Create the clone container with the same properties as the original. */
-	if (!is_ao2_object(orig) || !orig->v_table || !orig->v_table->alloc_empty_clone_debug) {
+	if (!is_ao2_object(orig)) {
+		return NULL;
+	}
+
+	if (!orig->v_table || !orig->v_table->alloc_empty_clone_debug) {
 		/* Sanity checks. */
 		ast_assert(0);
 		return NULL;
diff --git a/main/astobj2_hash.c b/main/astobj2_hash.c
index 341ff79e06..f5c678740c 100644
--- a/main/astobj2_hash.c
+++ b/main/astobj2_hash.c
@@ -186,7 +186,9 @@ static void hash_ao2_node_destructor(void *v_doomed)
 		 * same node.
 		 */
 		my_container = (struct ao2_container_hash *) doomed->common.my_container;
-		ast_assert(is_ao2_object(my_container));
+#if defined(AST_DEVMODE)
+		is_ao2_object(my_container);
+#endif
 
 		__adjust_lock(my_container, AO2_LOCK_REQ_WRLOCK, 1);
 
diff --git a/main/astobj2_rbtree.c b/main/astobj2_rbtree.c
index a8d5e3ac1b..4362b83cb5 100644
--- a/main/astobj2_rbtree.c
+++ b/main/astobj2_rbtree.c
@@ -878,7 +878,9 @@ static void rb_ao2_node_destructor(void *v_doomed)
 		 * same node.
 		 */
 		my_container = (struct ao2_container_rbtree *) doomed->common.my_container;
-		ast_assert(is_ao2_object(my_container));
+#if defined(AST_DEVMODE)
+		is_ao2_object(my_container);
+#endif
 
 		__adjust_lock(my_container, AO2_LOCK_REQ_WRLOCK, 1);
 
diff --git a/main/utils.c b/main/utils.c
index 1a034c1019..af0ee7f6b6 100644
--- a/main/utils.c
+++ b/main/utils.c
@@ -2437,17 +2437,16 @@ void DO_CRASH_NORETURN ast_do_crash(void)
 #endif	/* defined(DO_CRASH) */
 }
 
-#if defined(AST_DEVMODE)
 void DO_CRASH_NORETURN __ast_assert_failed(int condition, const char *condition_str, const char *file, int line, const char *function)
 {
 	/*
 	 * Attempt to put it into the logger, but hope that at least
 	 * someone saw the message on stderr ...
 	 */
-	ast_log(__LOG_ERROR, file, line, function, "FRACK!, Failed assertion %s (%d)\n",
-		condition_str, condition);
 	fprintf(stderr, "FRACK!, Failed assertion %s (%d) at line %d in %s of %s\n",
 		condition_str, condition, line, function, file);
+	ast_log(__LOG_ERROR, file, line, function, "FRACK!, Failed assertion %s (%d)\n",
+		condition_str, condition);
 
 	/* Generate a backtrace for the assert */
 	ast_log_backtrace();
@@ -2460,7 +2459,6 @@ void DO_CRASH_NORETURN __ast_assert_failed(int condition, const char *condition_
 	usleep(1);
 	ast_do_crash();
 }
-#endif	/* defined(AST_DEVMODE) */
 
 char *ast_eid_to_str(char *s, int maxlen, struct ast_eid *eid)
 {
-- 
GitLab