Fix for intermittent tsan2 errors from SendRtpToRtpOnThread and SendSrtpToSrtpOnThread.

webrtc/pc/channel_unittest.cc

 /*
  *  Copyright 2009 The WebRTC project authors. All Rights Reserved.
  *
  *  Use of this source code is governed by a BSD-style license
  *  that can be found in the LICENSE file in the root of the source
  *  tree. An additional intellectual property rights grant can be found
  *  in the file PATENTS.  All contributing project authors may
  *  be found in the AUTHORS file in the root of the source tree.
  */
 
 #include "webrtc/base/arraysize.h"
+#include "webrtc/base/criticalsection.h"
 #include "webrtc/base/fileutils.h"
 #include "webrtc/base/gunit.h"
 #include "webrtc/base/helpers.h"
 #include "webrtc/base/logging.h"
 #include "webrtc/base/pathutils.h"
 #include "webrtc/base/signalthread.h"
 #include "webrtc/base/ssladapter.h"
 #include "webrtc/base/sslidentity.h"
 #include "webrtc/base/window.h"
 #include "webrtc/media/base/fakemediaengine.h"
@@ skipping 379 matching lines @@
      CreateContent(SECURE, kPcmuCodec, kH264Codec, &content);
      AddLegacyStreamInContent(ssrc, 0, &content);
      sdesc->AddContent("DUMMY_CONTENT_NAME",
                        cricket::NS_JINGLE_RTP, content.Copy());
      return sdesc;
   }
 
   class CallThread : public rtc::SignalThread {
    public:
     typedef bool (ChannelTest<T>::*Method)();
-    CallThread(ChannelTest<T>* obj, Method method, bool* result)
+    CallThread(ChannelTest<T>* obj, Method method, bool* result = nullptr)
         : obj_(obj),
           method_(method),
-          result_(result) {
-      *result = false;
+          result_(false),
+          result_ptr_(result) {
+      if (result_ptr_)
+        *result_ptr_ = false;
     }
-    virtual void DoWork() {
-      bool result = (*obj_.*method_)();
-      if (result_) {
-        *result_ = result;
+
+    ~CallThread() {
+      if (result_ptr_) {
+        rtc::CritScope cs(&result_lock_);
+        *result_ptr_ = result_;
       }
     }
+
+    virtual void DoWork() {
+      SetResult((*obj_.*method_)());
+    }
+
+    bool result() {
+      rtc::CritScope cs(&result_lock_);
+      return result_;
+    }
+
    private:
+    void SetResult(const bool& result) {
+      rtc::CritScope cs(&result_lock_);
+      result_ = result;
+    }
+
     ChannelTest<T>* obj_;
     Method method_;
-    bool* result_;
+    rtc::CriticalSection result_lock_;
+    bool result_ GUARDED_BY(result_lock_);
+    bool* result_ptr_;
   };
-  void CallOnThread(typename CallThread::Method method, bool* result) {
-    CallThread* thread = new CallThread(this, method, result);
-    thread->Start();
-    thread->Release();
-  }
+
+  // Will manage the lifetime of a CallThread, making sure it's
+  // destroyed before this object goes out of scope.
+  class ScopedCallThread {
+   public:
+    using Method = typename CallThread::Method;
+
+    ScopedCallThread(ChannelTest<T>* obj, Method method)
+        : thread_(new CallThread(obj, method)) {
+      thread_->Start();
+    }
+
+    ~ScopedCallThread() {
+      thread_->Destroy(true);
+    }
+
+    bool result() const { return thread_->result(); }
+
+   private:
+    CallThread* thread_;
+  };
 
   void CallOnThreadAndWaitForDone(typename CallThread::Method method,
                                   bool* result) {
     CallThread* thread = new CallThread(this, method, result);
     thread->Start();
     thread->Destroy(true);
   }
 
   bool CodecMatches(const typename T::Codec& c1, const typename T::Codec& c2) {
     return false;  // overridden in specialized classes
@@ skipping 876 matching lines @@
       EXPECT_TRUE(SendCustomRtp1(kSsrc1, ++sequence_number1_1));
       EXPECT_TRUE(CheckCustomRtp2(kSsrc1, sequence_number1_1));
       EXPECT_TRUE(SendCustomRtcp2(kSsrc2));
       EXPECT_TRUE(CheckCustomRtcp1(kSsrc2));
       EXPECT_TRUE(SendCustomRtp2(kSsrc2, ++sequence_number2_2));
       EXPECT_TRUE(CheckCustomRtp1(kSsrc2, sequence_number2_2));
   }
 
   // Test that we properly send RTP without SRTP from a thread.
   void SendRtpToRtpOnThread() {
-    bool sent_rtp1, sent_rtp2, sent_rtcp1, sent_rtcp2;
     CreateChannels(RTCP, RTCP);
     EXPECT_TRUE(SendInitiate());
     EXPECT_TRUE(SendAccept());
-    CallOnThread(&ChannelTest<T>::SendRtp1, &sent_rtp1);
-    CallOnThread(&ChannelTest<T>::SendRtp2, &sent_rtp2);
-    CallOnThread(&ChannelTest<T>::SendRtcp1, &sent_rtcp1);
-    CallOnThread(&ChannelTest<T>::SendRtcp2, &sent_rtcp2);
+    ScopedCallThread send_rtp1(this, &ChannelTest<T>::SendRtp1);
+    ScopedCallThread send_rtp2(this, &ChannelTest<T>::SendRtp2);
+    ScopedCallThread send_rtcp1(this, &ChannelTest<T>::SendRtcp1);
+    ScopedCallThread send_rtcp2(this, &ChannelTest<T>::SendRtcp2);
     EXPECT_TRUE_WAIT(CheckRtp1(), 1000);
     EXPECT_TRUE_WAIT(CheckRtp2(), 1000);
-    EXPECT_TRUE_WAIT(sent_rtp1, 1000);
-    EXPECT_TRUE_WAIT(sent_rtp2, 1000);
+    EXPECT_TRUE_WAIT(send_rtp1.result(), 1000);
+    EXPECT_TRUE_WAIT(send_rtp2.result(), 1000);
     EXPECT_TRUE(CheckNoRtp1());
     EXPECT_TRUE(CheckNoRtp2());
     EXPECT_TRUE_WAIT(CheckRtcp1(), 1000);
     EXPECT_TRUE_WAIT(CheckRtcp2(), 1000);
-    EXPECT_TRUE_WAIT(sent_rtcp1, 1000);
-    EXPECT_TRUE_WAIT(sent_rtcp2, 1000);
+    EXPECT_TRUE_WAIT(send_rtcp1.result(), 1000);
+    EXPECT_TRUE_WAIT(send_rtcp2.result(), 1000);
     EXPECT_TRUE(CheckNoRtcp1());
     EXPECT_TRUE(CheckNoRtcp2());
   }
 
   // Test that we properly send SRTP with RTCP from a thread.
   void SendSrtpToSrtpOnThread() {
-    bool sent_rtp1, sent_rtp2, sent_rtcp1, sent_rtcp2;
     CreateChannels(RTCP | SECURE, RTCP | SECURE);
     EXPECT_TRUE(SendInitiate());
     EXPECT_TRUE(SendAccept());
-    CallOnThread(&ChannelTest<T>::SendRtp1, &sent_rtp1);
-    CallOnThread(&ChannelTest<T>::SendRtp2, &sent_rtp2);
-    CallOnThread(&ChannelTest<T>::SendRtcp1, &sent_rtcp1);
-    CallOnThread(&ChannelTest<T>::SendRtcp2, &sent_rtcp2);
+    ScopedCallThread send_rtp1(this, &ChannelTest<T>::SendRtp1);
+    ScopedCallThread send_rtp2(this, &ChannelTest<T>::SendRtp2);
+    ScopedCallThread send_rtcp1(this, &ChannelTest<T>::SendRtcp1);
+    ScopedCallThread send_rtcp2(this, &ChannelTest<T>::SendRtcp2);
     EXPECT_TRUE_WAIT(CheckRtp1(), 1000);
     EXPECT_TRUE_WAIT(CheckRtp2(), 1000);
-    EXPECT_TRUE_WAIT(sent_rtp1, 1000);
-    EXPECT_TRUE_WAIT(sent_rtp2, 1000);
+    EXPECT_TRUE_WAIT(send_rtp1.result(), 1000);
+    EXPECT_TRUE_WAIT(send_rtp2.result(), 1000);
     EXPECT_TRUE(CheckNoRtp1());
     EXPECT_TRUE(CheckNoRtp2());
     EXPECT_TRUE_WAIT(CheckRtcp1(), 1000);
     EXPECT_TRUE_WAIT(CheckRtcp2(), 1000);
-    EXPECT_TRUE_WAIT(sent_rtcp1, 1000);
-    EXPECT_TRUE_WAIT(sent_rtcp2, 1000);
+    EXPECT_TRUE_WAIT(send_rtcp1.result(), 1000);
+    EXPECT_TRUE_WAIT(send_rtcp2.result(), 1000);
     EXPECT_TRUE(CheckNoRtcp1());
     EXPECT_TRUE(CheckNoRtcp2());
   }
 
   // Test that the mediachannel retains its sending state after the transport
   // becomes non-writable.
   void SendWithWritabilityLoss() {
     CreateChannels(0, 0);
     EXPECT_TRUE(SendInitiate());
     EXPECT_TRUE(SendAccept());
@@ skipping 237 matching lines @@
         CreateSessionDescriptionWithStream(3));
     EXPECT_TRUE(channel1_->PushdownRemoteDescription(
         sdesc3.get(), cricket::CA_ANSWER, &err));
     EXPECT_TRUE(media_channel1_->HasSendStream(1));
     EXPECT_FALSE(media_channel1_->HasRecvStream(2));
     EXPECT_TRUE(media_channel1_->HasRecvStream(3));
   }
 
   void TestFlushRtcp() {
     bool send_rtcp1;
-
     CreateChannels(RTCP, RTCP);
     EXPECT_TRUE(SendInitiate());
     EXPECT_TRUE(SendAccept());
     ASSERT_TRUE(GetTransport1());
     ASSERT_TRUE(GetTransport2());
     EXPECT_EQ(2U, GetTransport1()->channels().size());
     EXPECT_EQ(2U, GetTransport2()->channels().size());
 
     // Send RTCP1 from a different thread.
     CallOnThreadAndWaitForDone(&ChannelTest<T>::SendRtcp1, &send_rtcp1);
@@ skipping 1051 matching lines @@
   };
   rtc::Buffer payload(data, 3);
   cricket::SendDataResult result;
   ASSERT_TRUE(media_channel1_->SendData(params, payload, &result));
   EXPECT_EQ(params.ssrc,
             media_channel1_->last_sent_data_params().ssrc);
   EXPECT_EQ("foo", media_channel1_->last_sent_data());
 }
 
 // TODO(pthatcher): TestSetReceiver?