Add channel locking for channel snapshot creation.

This adds channel locks around calls to create channel snapshots as well
as other functions which operate on a channel and then end up
creating a channel snapshot. Functions that expect the channel to be
locked prior to being called have had their documentation updated to
indicate such.
........

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


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

3 files changed, 51 insertions, 0 deletions

diff --git a/tests/test_cdr.c b/tests/test_cdr.c
index 57d5b2e32..efbda86c4 100644
--- a/tests/test_cdr.c
+++ b/tests/test_cdr.c
@@ -272,9 +272,11 @@ static void clear_mock_cdr_backend(void)
 	if ((priority) > 0) { \
 		ast_channel_priority_set((channel), (priority)); \
 	} \
+	ast_channel_lock((channel)); \
 	ast_channel_appl_set((channel), (application)); \
 	ast_channel_data_set((channel), (data)); \
 	ast_channel_publish_snapshot((channel)); \
+	ast_channel_unlock((channel)); \
 	} while (0)
 
 /*! \brief Hang up a test channel safely */
@@ -630,9 +632,11 @@ AST_TEST_DEFINE(test_cdr_single_party)
 	SWAP_CONFIG(config, debug_cdr_config);
 	CREATE_ALICE_CHANNEL(chan, &caller, &expected);
 
+	ast_channel_lock(chan);
 	EMULATE_APP_DATA(chan, 1, "Answer", "");
 	ast_setstate(chan, AST_STATE_UP);
 	EMULATE_APP_DATA(chan, 2, "VoiceMailMain", "1");
+	ast_channel_unlock(chan);
 
 	HANGUP_CHANNEL(chan, AST_CAUSE_NORMAL);
 
@@ -679,9 +683,11 @@ AST_TEST_DEFINE(test_cdr_single_bridge)
 	SWAP_CONFIG(config, debug_cdr_config);
 	CREATE_ALICE_CHANNEL(chan, &caller, &expected);
 
+	ast_channel_lock(chan);
 	EMULATE_APP_DATA(chan, 1, "Answer", "");
 	ast_setstate(chan, AST_STATE_UP);
 	EMULATE_APP_DATA(chan, 2, "Bridge", "");
+	ast_channel_unlock(chan);
 
 	bridge = ast_bridge_basic_new();
 	ast_test_validate(test, bridge != NULL);
@@ -754,9 +760,11 @@ AST_TEST_DEFINE(test_cdr_single_bridge_continue)
 	CREATE_ALICE_CHANNEL(chan, &caller, &expected_one);
 	COPY_IDS(chan, &expected_two);
 
+	ast_channel_lock(chan);
 	EMULATE_APP_DATA(chan, 1, "Answer", "");
 	ast_setstate(chan, AST_STATE_UP);
 	EMULATE_APP_DATA(chan, 2, "Bridge", "");
+	ast_channel_unlock(chan);
 
 	bridge_one = ast_bridge_basic_new();
 	ast_test_validate(test, bridge_one != NULL);
@@ -838,9 +846,11 @@ AST_TEST_DEFINE(test_cdr_single_twoparty_bridge_a)
 	CREATE_BOB_CHANNEL(chan_bob, &caller_bob, &bob_expected);
 	ast_copy_string(bob_expected.linkedid, ast_channel_linkedid(chan_alice), sizeof(bob_expected.linkedid));
 
+	ast_channel_lock(chan_alice);
 	EMULATE_APP_DATA(chan_alice, 1, "Answer", "");
 	ast_setstate(chan_alice, AST_STATE_UP);
 	EMULATE_APP_DATA(chan_alice, 2, "Bridge", "");
+	ast_channel_unlock(chan_alice);
 
 	bridge = ast_bridge_basic_new();
 	ast_test_validate(test, bridge != NULL);
@@ -848,9 +858,11 @@ AST_TEST_DEFINE(test_cdr_single_twoparty_bridge_a)
 	ast_test_validate(test, !ast_bridge_impart(bridge, chan_alice, NULL, NULL, AST_BRIDGE_IMPART_CHAN_DEPARTABLE));
 	while ((nanosleep(&to_sleep, &to_sleep) == -1) && (errno == EINTR));
 
+	ast_channel_lock(chan_bob);
 	EMULATE_APP_DATA(chan_bob, 1, "Answer", "");
 	ast_setstate(chan_bob, AST_STATE_UP);
 	EMULATE_APP_DATA(chan_bob, 2, "Bridge", "");
+	ast_channel_unlock(chan_bob);
 
 	ast_test_validate(test, !ast_bridge_impart(bridge, chan_bob, NULL, NULL, AST_BRIDGE_IMPART_CHAN_DEPARTABLE));
 	while ((nanosleep(&to_sleep, &to_sleep) == -1) && (errno == EINTR));
@@ -926,16 +938,20 @@ AST_TEST_DEFINE(test_cdr_single_twoparty_bridge_b)
 	CREATE_BOB_CHANNEL(chan_bob, &caller_bob, &bob_expected);
 	ast_copy_string(bob_expected.linkedid, ast_channel_linkedid(chan_alice), sizeof(bob_expected.linkedid));
 
+	ast_channel_unlock(chan_alice);
 	EMULATE_APP_DATA(chan_alice, 1, "Answer", "");
 	ast_setstate(chan_alice, AST_STATE_UP);
 	EMULATE_APP_DATA(chan_alice, 2, "Bridge", "");
+	ast_channel_unlock(chan_alice);
 
 	bridge = ast_bridge_basic_new();
 	ast_test_validate(test, bridge != NULL);
 
+	ast_channel_lock(chan_bob);
 	EMULATE_APP_DATA(chan_bob, 1, "Answer", "");
 	ast_setstate(chan_bob, AST_STATE_UP);
 	EMULATE_APP_DATA(chan_bob, 2, "Bridge", "");
+	ast_channel_unlock(chan_bob);
 	while ((nanosleep(&to_sleep, &to_sleep) == -1) && (errno == EINTR));
 
 	ast_test_validate(test, !ast_bridge_impart(bridge, chan_bob, NULL, NULL, AST_BRIDGE_IMPART_CHAN_DEPARTABLE));
@@ -1049,9 +1065,11 @@ AST_TEST_DEFINE(test_cdr_single_multiparty_bridge)
 	CREATE_CHARLIE_CHANNEL(chan_charlie, &caller_charlie, &charlie_expected);
 	ast_copy_string(charlie_expected.linkedid, ast_channel_linkedid(chan_alice), sizeof(charlie_expected.linkedid));
 
+	ast_channel_lock(chan_alice);
 	EMULATE_APP_DATA(chan_alice, 1, "Answer", "");
 	ast_setstate(chan_alice, AST_STATE_UP);
 	EMULATE_APP_DATA(chan_alice, 2, "Bridge", "");
+	ast_channel_unlock(chan_alice);
 
 	bridge = ast_bridge_basic_new();
 	ast_test_validate(test, bridge != NULL);
@@ -1059,18 +1077,22 @@ AST_TEST_DEFINE(test_cdr_single_multiparty_bridge)
 
 	ast_test_validate(test, !ast_bridge_impart(bridge, chan_alice, NULL, NULL, AST_BRIDGE_IMPART_CHAN_DEPARTABLE));
 
+	ast_channel_lock(chan_bob);
 	EMULATE_APP_DATA(chan_bob, 1, "Answer", "");
 	ast_setstate(chan_bob, AST_STATE_UP);
 	EMULATE_APP_DATA(chan_bob, 2, "Bridge", "");
+	ast_channel_unlock(chan_bob);
 	while ((nanosleep(&to_sleep, &to_sleep) == -1) && (errno == EINTR));
 
 	ast_test_validate(test, !ast_bridge_impart(bridge, chan_bob, NULL, NULL, AST_BRIDGE_IMPART_CHAN_DEPARTABLE));
 
 	while ((nanosleep(&to_sleep, &to_sleep) == -1) && (errno == EINTR));
 
+	ast_channel_lock(chan_charlie);
 	EMULATE_APP_DATA(chan_charlie, 1, "Answer", "");
 	ast_setstate(chan_charlie, AST_STATE_UP);
 	EMULATE_APP_DATA(chan_charlie, 2, "Bridge", "");
+	ast_channel_unlock(chan_charlie);
 	ast_test_validate(test, !ast_bridge_impart(bridge, chan_charlie, NULL, NULL, AST_BRIDGE_IMPART_CHAN_DEPARTABLE));
 
 	while ((nanosleep(&to_sleep, &to_sleep) == -1) && (errno == EINTR));
@@ -2000,10 +2022,15 @@ AST_TEST_DEFINE(test_cdr_park)
 	CREATE_ALICE_CHANNEL(chan_alice, &alice_caller, &alice_expected);
 	CREATE_BOB_CHANNEL(chan_bob, &bob_caller, &bob_expected);
 
+	ast_channel_lock(chan_alice);
 	EMULATE_APP_DATA(chan_alice, 1, "Park", "700");
 	ast_setstate(chan_alice, AST_STATE_UP);
+	ast_channel_unlock(chan_alice);
+
+	ast_channel_lock(chan_bob);
 	EMULATE_APP_DATA(chan_bob, 1, "Park", "701");
 	ast_setstate(chan_bob, AST_STATE_UP);
+	ast_channel_unlock(chan_bob);
 
 	bridge = ast_bridge_base_new(AST_BRIDGE_CAPABILITY_HOLDING,
 		AST_BRIDGE_FLAG_MERGE_INHIBIT_TO | AST_BRIDGE_FLAG_MERGE_INHIBIT_FROM
@@ -2108,6 +2135,7 @@ AST_TEST_DEFINE(test_cdr_fields)
 	ast_copy_string(fork_expected_two.linkedid, ast_channel_linkedid(chan), sizeof(fork_expected_two.linkedid));
 
 	/* Channel enters Wait app */
+	ast_channel_lock(chan);
 	ast_channel_appl_set(chan, "Wait");
 	ast_channel_data_set(chan, "10");
 	ast_channel_priority_set(chan, 1);
@@ -2116,6 +2144,7 @@ AST_TEST_DEFINE(test_cdr_fields)
 	/* Set properties on the channel that propagate to the CDR */
 	ast_channel_amaflags_set(chan, AST_AMA_OMIT);
 	ast_channel_accountcode_set(chan, "XXX");
+	ast_channel_unlock(chan);
 
 	/* Wait one second so we get a duration. */
 	while ((nanosleep(&to_sleep, &to_sleep) == -1) && (errno == EINTR));
@@ -2208,6 +2237,7 @@ AST_TEST_DEFINE(test_cdr_fields)
 	ast_test_validate(test, ast_cdr_fork(ast_channel_name(chan), &fork_options) == 0);
 
 	/* Channel enters Answer app */
+	ast_channel_lock(chan);
 	ast_channel_appl_set(chan, "Answer");
 	ast_channel_data_set(chan, "");
 	ast_channel_priority_set(chan, 1);
@@ -2216,6 +2246,7 @@ AST_TEST_DEFINE(test_cdr_fields)
 
 	/* Set properties on the last record */
 	ast_channel_accountcode_set(chan, "ZZZ");
+	ast_channel_unlock(chan);
 	ast_cdr_setuserfield(ast_channel_name(chan), "schmackity");
 	ast_test_validate(test, ast_cdr_setvar(ast_channel_name(chan), "test_variable", "record_2") == 0);
 
@@ -2385,7 +2416,9 @@ AST_TEST_DEFINE(test_cdr_fork_cdr)
 	ast_test_validate(test, ast_cdr_fork(ast_channel_name(chan), &fork_options) == 0);
 
 	/* Test keep variables; setting a new answer time */
+	ast_channel_lock(chan);
 	ast_setstate(chan, AST_STATE_UP);
+	ast_channel_unlock(chan);
 	while ((nanosleep(&to_sleep, &to_sleep) == -1) && (errno == EINTR));
 	ast_test_validate(test, ast_cdr_setvar(ast_channel_name(chan), "test_variable", "record_2") == 0);
 	ast_test_validate(test, ast_cdr_getvar(ast_channel_name(chan), "test_variable", varbuffer, sizeof(varbuffer)) == 0);
diff --git a/tests/test_cel.c b/tests/test_cel.c
index 0aa8b601c..a90dfbf3e 100644
--- a/tests/test_cel.c
+++ b/tests/test_cel.c
@@ -1551,10 +1551,14 @@ AST_TEST_DEFINE(test_cel_local_optimize)
 	CREATE_ALICE_CHANNEL(chan_alice, &alice_caller);
 	CREATE_BOB_CHANNEL(chan_bob, &bob_caller);
 
+	ast_channel_lock(chan_alice);
 	alice_snapshot = ast_channel_snapshot_create(chan_alice);
+	ast_channel_unlock(chan_alice);
 	ast_test_validate(test, alice_snapshot != NULL);
 
+	ast_channel_lock(chan_bob);
 	bob_snapshot = ast_channel_snapshot_create(chan_bob);
+	ast_channel_unlock(chan_bob);
 	ast_test_validate(test, bob_snapshot != NULL);
 
 	ast_multi_channel_blob_add_channel(mc_blob, "1", alice_snapshot);
@@ -1675,7 +1679,9 @@ static int append_expected_event(
 	const char *peer)
 {
 	RAII_VAR(struct ast_channel_snapshot *, snapshot, NULL, ao2_cleanup);
+	ast_channel_lock(chan);
 	snapshot = ast_channel_snapshot_create(chan);
+	ast_channel_unlock(chan);
 	if (!snapshot) {
 		return -1;
 	}
diff --git a/tests/test_stasis_channels.c b/tests/test_stasis_channels.c
index 45f1e2ba3..b7c9fe2c5 100644
--- a/tests/test_stasis_channels.c
+++ b/tests/test_stasis_channels.c
@@ -77,10 +77,12 @@ AST_TEST_DEFINE(channel_blob_create)
 		     "foo", "bar");
 
 	/* Off nominal creation */
+	ast_channel_lock(chan);
 	ast_test_validate(test, NULL == ast_channel_blob_create(chan, NULL, json));
 
 	/* Test for single channel */
 	msg = ast_channel_blob_create(chan, type, json);
+	ast_channel_unlock(chan);
 	ast_test_validate(test, NULL != msg);
 	blob = stasis_message_data(msg);
 	ast_test_validate(test, NULL != blob);
@@ -129,7 +131,9 @@ AST_TEST_DEFINE(null_blob)
 		     "foo", "bar");
 
 	/* Test for single channel */
+	ast_channel_lock(chan);
 	msg = ast_channel_blob_create(chan, type, NULL);
+	ast_channel_unlock(chan);
 	ast_test_validate(test, NULL != msg);
 	blob = stasis_message_data(msg);
 	ast_test_validate(test, NULL != blob);
@@ -196,9 +200,15 @@ AST_TEST_DEFINE(multi_channel_blob_snapshots)
 	chan_charlie = ast_channel_alloc(0, AST_STATE_DOWN, "300", "Bob", "300", "300", "default", NULL, 0, "TEST/Charlie");
 
 	blob = ast_multi_channel_blob_create(json);
+	ast_channel_lock(chan_alice);
 	ast_multi_channel_blob_add_channel(blob, "Caller", ast_channel_snapshot_create(chan_alice));
+	ast_channel_unlock(chan_alice);
+	ast_channel_lock(chan_bob);
 	ast_multi_channel_blob_add_channel(blob, "Peer", ast_channel_snapshot_create(chan_bob));
+	ast_channel_unlock(chan_bob);
+	ast_channel_lock(chan_charlie);
 	ast_multi_channel_blob_add_channel(blob, "Peer", ast_channel_snapshot_create(chan_charlie));
+	ast_channel_unlock(chan_charlie);
 
 	/* Test for unknown role */
 	ast_test_validate(test, NULL == ast_multi_channel_blob_get_channel(blob, "Foobar"));
@@ -252,7 +262,9 @@ AST_TEST_DEFINE(channel_snapshot_json)
 
 	chan = ast_channel_alloc(0, AST_STATE_DOWN, "cid_num", "cid_name", "acctcode", "exten", "context", NULL, 0, "TEST/name");
 	ast_test_validate(test, NULL != chan);
+	ast_channel_lock(chan);
 	snapshot = ast_channel_snapshot_create(chan);
+	ast_channel_unlock(chan);
 	ast_test_validate(test, NULL != snapshot);
 
 	actual = ast_channel_snapshot_to_json(snapshot, NULL);