Adds macros to annotate variables and functions used from same thread or queue.

webrtc/base/thread_checker_unittest.cc

 /*
  *  Copyright (c) 2014 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.
  */
 
 // Borrowed from Chromium's src/base/threading/thread_checker_unittest.cc.
 
 #include <memory>
 
 #include "testing/gtest/include/gtest/gtest.h"
 #include "webrtc/base/checks.h"
 #include "webrtc/base/constructormagic.h"
+#include "webrtc/base/task_queue.h"
 #include "webrtc/base/thread.h"
 #include "webrtc/base/thread_checker.h"
 
 // Duplicated from base/threading/thread_checker.h so that we can be
 // good citizens there and undef the macro.
 #if !defined(NDEBUG) || defined(DCHECK_ALWAYS_ON)
 #define ENABLE_THREAD_CHECKER 1
 #else
 #define ENABLE_THREAD_CHECKER 0
 #endif
@@ skipping 159 matching lines @@
     }, "");
 }
 #else
 TEST(ThreadCheckerTest, DetachFromThreadInRelease) {
   ThreadCheckerClass::DetachThenCallFromDifferentThreadImpl();
 }
 #endif  // ENABLE_THREAD_CHECKER
 
 #endif  // GTEST_HAS_DEATH_TEST || !ENABLE_THREAD_CHECKER
 
+class ThreadAnnotateTest {
+ public:
+  rtc::Thread* thread;

[tommi, 2016/05/19 08:26:14]

move these member variables to the bottom of the class, add the postfix _ and
make them private.

If you could update the example code too to follow the style guide, that would
be good.

[danilchap, 2016/05/19 11:45:29]

Done.

+  rtc::ThreadChecker checker;
+  rtc::TaskQueue* queue;
+
+  int var_thread ACCESS_ON(thread);
+  int var_checker ACCESS_ON(checker);
+  int var_queue ACCESS_ON(queue);
+  void function() RUN_ON(thread) {}
+  void fun_acccess_var() RUN_ON(thread) { var_thread = 13; }
+
+  // Next two function should create warnings when compile (e.g. if used with
+  // specific T)
+  // TODO(danilchap): Find a way to test they do not compile when thread
+  // annotation checks enabled.
+  template<typename T>
+  void access_var_no_annotate() {
+    var_thread = 42;
+  }
+
+  template<typename T>
+  void access_fun_no_annotate() {
+    function();
+  }
+
+  // Functions below should be able to compile.
+  void access_var_annotate_thread() {
+    RTC_DCHECK_RUN_ON(thread);
+    var_thread = 42;
+  }
+
+  void access_var_annotate_checker() {
+    RTC_DCHECK_RUN_ON(&checker);
+    var_checker = 44;
+  }
+
+  void access_var_annotate_queue() {
+    RTC_DCHECK_RUN_ON(queue);
+    var_queue = 46;
+  }
+
+  void access_fun_annotate() {
+    RTC_DCHECK_RUN_ON(thread);
+    function();
+  }
+
+  void access_fun_and_var() {
+    RTC_DCHECK_RUN_ON(thread);
+    fun_acccess_var();
+  }
+};
+
 // Just in case we ever get lumped together with other compilation units.
 #undef ENABLE_THREAD_CHECKER
 
 }  // namespace rtc