config: Fix SEGV in unit test with MALLOC_DEBUG

With MALLOC_DEBUG the /main/config config_basic_ops test was causing a
SEGV while doing an ast_category_delete in an ast_category_browse loop.
Apparently this never worked but was also never tested.  I removed the
test, added 2 notes to config.h indicating that it's not supported and
added a few lines of code to ast_category_delete to prevent the SEGV
should someone attempt it in the future.

Tested-by: George Joseph

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

Merged revisions 425525 from http://svn.asterisk.org/svn/asterisk/branches/12
........

Merged revisions 425526 from http://svn.asterisk.org/svn/asterisk/branches/13


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@425527 65c4cc65-6c06-0410-ace0-fbb531ad65f3

include/asterisk/config.h

@@ -257,6 +257,10 @@ char *ast_category_browse(struct ast_config *config, const char *prev_name);
  *
  * \retval ast_variable list on success
  * \retval NULL on failure
+ *
+ * \note ast_category_browse is not thread safe and it is not safe to call
+ * ast_category_delete while browsing using ast_category_browse.
+ * ast_category_browse_filtered does not have these restrictions.
  */
 struct ast_variable *ast_variable_browse_filtered(const struct ast_config *config,
 	const char *category_name, const char *filter);
@@ -794,6 +798,9 @@ int ast_category_insert(struct ast_config *config, struct ast_category *cat, con
  * \param category category to delete
  *
  * \return the category after the deleted one which could be NULL.
+ *
+ * \note It is not safe to call ast_category_delete while browsing with
+ * ast_category_browse.  It is safe with ast_category_browse_filtered.
  */
 struct ast_category *ast_category_delete(struct ast_config *cfg, struct ast_category *category);
 

main/config.c

@@ -1336,6 +1336,10 @@ struct ast_category *ast_category_delete(struct ast_config *config,
 
 	prev = category->prev;
 
+	if (config->last_browse == category) {
+		config->last_browse = prev;
+	}
+
 	ast_category_destroy(category);
 
 	return prev;

tests/test_config.c

@@ -395,26 +395,6 @@ AST_TEST_DEFINE(config_basic_ops)
 		}
 	}
 
-	/* Now: test0 test1 test3 test4 test2 */
-	/* Test in-flight deletion using ast_category_browse */
-	/* Delete test1 and continue */
-	cat_name = NULL;
-	for(i = 0; i < 5; i++) {
-		if (i == 2) {  /* 2 was already deleted above */
-			continue;
-		}
-		snprintf(temp, sizeof(temp), "test%d", i);
-		cat_name = ast_category_browse(cfg, cat_name);
-		cat = ast_category_get(cfg, cat_name, NULL);
-		if (strcmp(cat_name, temp)) {
-			ast_test_status_update(test, "Should have returned %s instead of %s: %d\n", temp, cat_name, i);
-			goto out;
-		}
-		if (i == 1) {
-			ast_category_delete(cfg, cat);
-		}
-	}
-
 	/* Now: test0 test3 test4 test2 */
 	/* delete the head item */
 	cat = ast_category_browse_filtered(cfg, NULL, NULL, NULL);
@@ -429,7 +409,7 @@ AST_TEST_DEFINE(config_basic_ops)
 	/* make sure head got updated to the new first element */
 	cat = ast_category_browse_filtered(cfg, NULL, NULL, NULL);
 	cat_name = ast_category_get_name(cat);
-	if (strcmp(cat_name, "test3")) {
+	if (strcmp(cat_name, "test1")) {
 		ast_test_status_update(test, "Should have returned test3 instead of %s\n", cat_name);
 		goto out;
 	}
@@ -446,6 +426,13 @@ AST_TEST_DEFINE(config_basic_ops)
 
 	/* There should now only be 2 elements in the list */
 	cat = NULL;
+	cat = ast_category_browse_filtered(cfg, NULL, cat, NULL);
+	cat_name = ast_category_get_name(cat);
+	if (strcmp(cat_name, "test1")) {
+		ast_test_status_update(test, "Should have returned test1 instead of %s\n", cat_name);
+		goto out;
+	}
+
 	cat = ast_category_browse_filtered(cfg, NULL, cat, NULL);
 	cat_name = ast_category_get_name(cat);
 	if (strcmp(cat_name, "test3")) {