[tsan] Expose __tsan_ignore_thread_begin and __tsan_ignore_thread_end in TSan interface

[zaks.anna]

Summary

This patch is needed to implement the function attribute that disable TSan checking at run time. (See https://reviews.llvm.org/D25857, and https://reviews.llvm.org/D25858)

[dvyukov]

test/tsan/Darwin/release-dealloc-norace-objcpp.mm

28

I don't understand ordering of the patches.
This patch is required for the tsan pass patch.
But this test will only pass if the tsan pass patch is submitted.
I think you need to split this patch into 2 parts: one adds the interface functions, another adds tests. Otherwise tree will be broken at some point.

[zaks.anna]

test/tsan/Darwin/release-dealloc-norace-objcpp.mm

28

You are correct. I'll split the patch into 2 before committing.

[zaks.anna]

Split out the test file into a separate patch. The test file has been updated to contain more tests and use TSan test barriers. It's submitted for review at https://reviews.llvm.org/D26228.

lib/tsan/rtl/tsan_interface.h

 
 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_vptr_read(void **vptr_p);
 SANITIZER_INTERFACE_ATTRIBUTE
 void __tsan_vptr_update(void **vptr_p, void *new_val);
 
 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_func_entry(void *call_pc);
 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_func_exit();
 
+SANITIZER_INTERFACE_ATTRIBUTE void __tsan_ignore_thread_begin();
+SANITIZER_INTERFACE_ATTRIBUTE void __tsan_ignore_thread_end();
+
 SANITIZER_INTERFACE_ATTRIBUTE
 void __tsan_read_range(void *addr, unsigned long size);  // NOLINT
 SANITIZER_INTERFACE_ATTRIBUTE
 void __tsan_write_range(void *addr, unsigned long size);  // NOLINT
 
 // User may provide function that would be called right when TSan detects
 // an error. The argument 'report' is an opaque pointer that can be used to
 // gather additional information using other TSan report API functions.

lib/tsan/rtl/tsan_interface_inl.h

 void __tsan_func_entry(void *pc) {
   FuncEntry(cur_thread(), (uptr)pc);
 }
 
 void __tsan_func_exit() {
   FuncExit(cur_thread());
 }
 
+void __tsan_ignore_thread_begin() {
+  ThreadIgnoreBegin(cur_thread(), CALLERPC);
+}
+
+void __tsan_ignore_thread_end() {
+  ThreadIgnoreEnd(cur_thread(), CALLERPC);
+}
+
 void __tsan_read_range(void *addr, uptr size) {
   MemoryAccessRange(cur_thread(), CALLERPC, (uptr)addr, size, false);
 }
 
 void __tsan_write_range(void *addr, uptr size) {
   MemoryAccessRange(cur_thread(), CALLERPC, (uptr)addr, size, true);
 }

test/tsan/Darwin/release-dealloc-norace-objcpp.mm

+// Check that we do not report races betwen object release and dealloc.
+
+// RUN: %clang_tsan %s -lc++ -fobjc-arc -lobjc -o %t -framework Foundation
+// RUN: %env_tsan_opts=ignore_interceptors_accesses=1 %run %t 2>&1 | FileCheck
+// %s
+
+#import <Foundation/Foundation.h>
+#include <pthread.h>
+
+pthread_t ThreadId;
+
+@interface MyObject : NSObject {
+@public
+  int v;
+}
+- (void)accessMember;
+@end
+
+@implementation MyObject
+
+- (void)accessMember {
+  v = 0;
+}
+
+- (void)dealloc {
+  uint64_t tid;
+  pthread_threadid_np(NULL, &tid);
+  [self accessMember];
+  printf("Dealloc from thread with id : %p \n", (void *)tid);
+}
+
+@end
+
+void *Thread1(void *x) {
+  uint64_t tid;
+  pthread_threadid_np(NULL, &tid);
+  printf("Access from thread with id : %p \n", (void *)tid);
+  int *v = (int *)x;
+  *v = 1;
+  sleep(1);
+  return 0;
+}
+
+void objectLifetimeContainer() {
+  MyObject *o = [MyObject new];
+  pthread_create(&ThreadId, NULL, Thread1, &(o->v));
+}
+
+int main(int argc, const char *argv[]) {
+  objectLifetimeContainer();
+  pthread_join(ThreadId, NULL);
+  return 0;
+}
+
+// CHECK-NOT: ThreadSanitizer: data race

test/tsan/Darwin/release-dealloc-norace.m

+// Check that we do not report races betwen object release and dealloc.
+
+// RUN: %clang_tsan %s -fobjc-arc -lobjc -o %t -framework Foundation
+// RUN: %env_tsan_opts=ignore_interceptors_accesses=1 %run %t 2>&1 | FileCheck
+// %s
+
+#import <Foundation/Foundation.h>
+#include <pthread.h>
+
+pthread_t ThreadId;
+
+@interface MyObject : NSObject {
+@public
+  int v;
+}
+- (void)accessMember;
+@end
+
+@implementation MyObject
+
+- (void)accessMember {
+  v = 0;
+}
+
+- (void)dealloc {
+  uint64_t tid;
+  pthread_threadid_np(NULL, &tid);
+  [self accessMember];
+  printf("Dealloc from thread with id : %p \n", (void *)tid);
+}
+
+@end
+
+void *Thread1(void *x) {
+  uint64_t tid;
+  pthread_threadid_np(NULL, &tid);
+  printf("Access from thread with id : %p \n", (void *)tid);
+  int *v = (int *)x;
+  *v = 1;
+  sleep(1);
+  return 0;
+}
+
+void objectLifetimeContainer() {
+  MyObject *o = [MyObject new];
+  pthread_create(&ThreadId, NULL, Thread1, &(o->v));
+}
+
+int main(int argc, const char *argv[]) {
+  objectLifetimeContainer();
+  pthread_join(ThreadId, NULL);
+  return 0;
+}
+
+// CHECK-NOT: ThreadSanitizer: data race