[TSan][MIPS64] Fix go build for MIPS64

[slthakur]

Summary

• Changes specific to MIPS64 architecture.
• Patch dependant on:
  • http://reviews.llvm.org/D7013
  • http://reviews.llvm.org/D6291

[samsonov]

lib/tsan/CMakeLists.txt

105

You need to have GotsanRuntimeCheck for every ${arch} from ${TSAN_SUPPORTED_ARCH}.

lib/tsan/go/buildgo.sh

92

This part is far too similar to linux_amd64. I believe you should generalize the former.

121

ditto

[slthakur]

Addressed review comments by @samsonov

[slthakur]

lib/tsan/go/buildgo.sh

54

I have shifed ../rtl/tsan_platform_linux.h down in the list because :

The file asm/stat is included in sanitizer_linux.cc file only for mips.
And sys/stat is included in ../rtl/tsan_platform_linux.h, which includes bits/stat.
Therefore when the structure stat defined in asm/stat.h included from sanitizer_linux.cc is compiled, st_atime in struct stat is interpreted as the macro defined in bits/stat.h, where as it is only the variable name. Because of this reason we were getting the following error in Go runtime check :

In file included from ./gotsan.cc:9678:
/usr/include/mips64el-linux-gnuabi64/asm/stat.h:113:16: error: expected ';' at end of declaration list
        unsigned int            st_atime;
                                ^
/usr/include/mips64el-linux-gnuabi64/bits/stat.h:166:26: note: expanded from macro 'st_atime'
# define st_atime st_atim.tv_sec        /* Backward compatibility.  */

I have also tested this patch on x86_64.

[dvyukov]

This is not right. Go tsan does not run on mips64.
C++ tsan needs to be tested on linux/amd64, freebsd/amd64 and linux/mips64.
Go tsan needs to be tested on linux/amd64, darwin/amd64, windows/amd64 and freebsd/amd64.

[slthakur]

Hi @dvyukov

I ran the check-tsan test suite on my mips64 board and GotsanRuntimeCheck is working fine.
How can I add support for tsan go runtime for mips64 and test it ?

[dvyukov]

I ran the check-tsan test suite on my mips64 board and GotsanRuntimeCheck is working fine.
How can I add support for tsan go runtime for mips64 and test it ?

You first need to add mips64 support to Go compiler, assemebler, linker and runtime :)
The test is very simplified and does not involve any Go code, but does not test most of the system as well. We probably can leave the test if it works. I just hope that it won't break.

But please add a comment in lib/tsan/rtl/tsan_platform.h saying that Go/mips64 is not a working configuration and it is there merely to satisfy rtl/go/buildgo.sh.

[slthakur]

OK. Then I think it will be better to enable GotsanRuntimeCheck only for x86_64 arch. I will just submit a patch for enabling GotsanRuntimeCheck on x86_64 arch only.

[slthakur]

Added code to enable GotsanRuntimeCheck for x86_64 only in lib/tsan/CMakeLists.txt in http://reviews.llvm.org/D6291

lib/tsan/CMakeLists.txt

if(CAN_TARGET_x86_64 AND UNIX AND NOT APPLE)
   add_dependencies(tsan clang_rt.tsan-${arch}
     clang_rt.tsan-${arch}-symbols)
 endif()
 
 add_dependencies(compiler-rt tsan)
 
 # Sanity check for Go runtime.
 set(BUILDGO_SCRIPT ${CMAKE_CURRENT_SOURCE_DIR}/go/buildgo.sh)
+foreach(arch ${TSAN_SUPPORTED_ARCH})
   add_custom_target(GotsanRuntimeCheck
     COMMAND CC=${CMAKE_C_COMPILER} IN_TMPDIR=1 SILENT=1 ${BUILDGO_SCRIPT}
     DEPENDS clang_rt.tsan-${arch} ${BUILDGO_SCRIPT}
     WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/go
     COMMENT "Checking TSan Go runtime..."
     VERBATIM)
+endforeach()
 
 # Build libcxx instrumented with TSan.
 if(TSAN_SUPPORTED_ARCH AND
    COMPILER_RT_HAS_LIBCXX_SOURCES AND
    COMPILER_RT_TEST_COMPILER_ID STREQUAL "Clang")
   set(LIBCXX_PREFIX ${CMAKE_CURRENT_BINARY_DIR}/libcxx_tsan)
   add_custom_libcxx(libcxx_tsan ${LIBCXX_PREFIX}
     DEPS ${TSAN_RUNTIME_LIBRARIES}
     CFLAGS -fsanitize=thread)
 endif()
 
 if(COMPILER_RT_INCLUDE_TESTS)
   add_subdirectory(tests)
 endif()

lib/tsan/go/buildgo.sh

SRCS="
   ../../sanitizer_common/sanitizer_suppressions.cc
   ../../sanitizer_common/sanitizer_thread_registry.cc
   ../../sanitizer_common/sanitizer_stackdepot.cc
   ../../sanitizer_common/sanitizer_stacktrace.cc
   ../../sanitizer_common/sanitizer_symbolizer.cc
 "
 
 if [ "`uname -a | grep Linux`" != "" ]; then
-  SUFFIX="linux_amd64"
   OSCFLAGS="-fPIC -ffreestanding -Wno-maybe-uninitialized -Wno-unused-const-variable -Werror -Wno-unknown-warning-option"
   OSLDFLAGS="-lpthread -fPIC -fpie"
+  if [ "`uname -a | grep x86_64`" != "" ]; then
+    SUFFIX="linux_amd64"
+  elif [ "`uname -a | grep mips64`" != "" ]; then
+    SUFFIX="linux_mips64"
+    OSCFLAGS="$OSCFLAGS -Wno-unused-function"
+  fi
   SRCS="
     $SRCS
-    ../rtl/tsan_platform_linux.cc
     ../../sanitizer_common/sanitizer_posix.cc
     ../../sanitizer_common/sanitizer_posix_libcdep.cc
     ../../sanitizer_common/sanitizer_procmaps_common.cc
     ../../sanitizer_common/sanitizer_procmaps_linux.cc
     ../../sanitizer_common/sanitizer_linux.cc
     ../../sanitizer_common/sanitizer_linux_libcdep.cc
     ../../sanitizer_common/sanitizer_stoptheworld_linux_libcdep.cc
+    ../rtl/tsan_platform_linux.cc
   "
 elif [ "`uname -a | grep FreeBSD`" != "" ]; then
         SUFFIX="freebsd_amd64"
         OSCFLAGS="-fno-strict-aliasing -fPIC -Werror"
         OSLDFLAGS="-lpthread -fPIC -fpie"
         SRCS="
                 $SRCS
                 ../rtl/tsan_platform_linux.cc
elif [ "`uname -a | grep MINGW`" != "" ]; then
   SUFFIX="windows_amd64"
   OSCFLAGS="-Wno-error=attributes -Wno-attributes -Wno-unused-const-variable -Wno-unknown-warning-option"
   OSLDFLAGS=""
   SRCS="
     $SRCS
     ../rtl/tsan_platform_windows.cc
     ../../sanitizer_common/sanitizer_win.cc
   "
 else
   echo Unknown platform
   exit 1
 fi
 
 CC=${CC:-gcc}
 IN_TMPDIR=${IN_TMPDIR:-0}
 SILENT=${SILENT:-0}
 

 
 rm -f $DIR/gotsan.cc
 for F in $SRCS; do
   cat $F >> $DIR/gotsan.cc
 done
 
 FLAGS=" -I../rtl -I../.. -I../../sanitizer_common -I../../../include -std=c++11 -m64 -Wall -fno-exceptions -fno-rtti -DSANITIZER_GO -DSANITIZER_DEADLOCK_DETECTOR_VERSION=2 $OSCFLAGS"
 if [ "$DEBUG" = "" ]; then
-  FLAGS="$FLAGS -DSANITIZER_DEBUG=0 -O3 -msse3 -fomit-frame-pointer"
+  FLAGS="$FLAGS -DSANITIZER_DEBUG=0 -O3 -fomit-frame-pointer"
 else
   FLAGS="$FLAGS -DSANITIZER_DEBUG=1 -g"
 fi
 
+if [ "`uname -a | grep x86_64`" != "" ]; then
+  FLAGS="$FLAGS -msse3"
+fi
+
 if [ "$SILENT" != "1" ]; then
   echo $CC gotsan.cc -c -o $DIR/race_$SUFFIX.syso $FLAGS $CFLAGS
 fi
 $CC $DIR/gotsan.cc -c -o $DIR/race_$SUFFIX.syso $FLAGS $CFLAGS
 
 $CC test.c $DIR/race_$SUFFIX.syso -m64 -o $DIR/test $OSLDFLAGS
 
 export GORACE="exitcode=0 atexit_sleep_ms=0"
 if [ "$SILENT" != "1" ]; then
   $DIR/test
 else
   $DIR/test 2>/dev/null
 fi

lib/tsan/rtl/tsan_platform.h

 static USED uptr UserRegions[] = {
   kLoAppMemBeg, kLoAppMemEnd,
   kHiAppMemBeg, kHiAppMemEnd,
   kHeapMemBeg,  kHeapMemEnd,
 };
 
 #elif defined(SANITIZER_GO) && !SANITIZER_WINDOWS
 
-/* Go on linux, darwin and freebsd
+#if defined(__x86_64__)
+/* Go on linux/x86_64, darwin/x86_64 and freebsd/x86_64
 0000 0000 1000 - 0000 1000 0000: executable
 0000 1000 0000 - 00c0 0000 0000: -
 00c0 0000 0000 - 00e0 0000 0000: heap
 00e0 0000 0000 - 2000 0000 0000: -
 2000 0000 0000 - 2380 0000 0000: shadow
 2380 0000 0000 - 3000 0000 0000: -
 3000 0000 0000 - 4000 0000 0000: metainfo (memory blocks and sync objects)
 4000 0000 0000 - 6000 0000 0000: -
 6000 0000 0000 - 6200 0000 0000: traces
 6200 0000 0000 - 8000 0000 0000: -
 */
 
 const uptr kMetaShadowBeg = 0x300000000000ull;
 const uptr kMetaShadowEnd = 0x400000000000ull;
 const uptr kTraceMemBeg   = 0x600000000000ull;
 const uptr kTraceMemEnd   = 0x620000000000ull;
 const uptr kShadowBeg     = 0x200000000000ull;
 const uptr kShadowEnd     = 0x238000000000ull;
 const uptr kAppMemBeg     = 0x000000001000ull;
 const uptr kAppMemEnd     = 0x00e000000000ull;
+#elif defined(__mips64)
+/* Go on linux/mips64
+0100 0000 00 - 0140 0000 00: executable and heap
+0140 0000 00 - 2200 0000 00: -
[phone] - 2700 0000 00: shadow
[phone] - 3000 0000 00: -
[phone] - 4000 0000 00: metainfo (memory blocks and sync objects)
[phone] - 6000 0000 00: -
[phone] - 6200 0000 00: traces
[phone] - ffff ffff ff: -
+*/
+
+const uptr kMetaShadowBeg = 0x3000000000ull;
+const uptr kMetaShadowEnd = 0x4000000000ull;
+const uptr kTraceMemBeg   = 0x6000000000ull;
+const uptr kTraceMemEnd   = 0x6200000000ull;
+const uptr kShadowBeg     = 0x2200000000ull;
+const uptr kShadowEnd     = 0x2700000000ull;
+const uptr kAppMemBeg     = 0x0100000000ull;
+const uptr kAppMemEnd     = 0x0140000000ull;
+#endif
 
 ALWAYS_INLINE
 bool IsAppMem(uptr mem) {
   return mem >= kAppMemBeg && mem < kAppMemEnd;
 }
 
 ALWAYS_INLINE
 bool IsShadowMem(uptr mem) {