[ESan] [MIPS] Fix tests mmap-shadow-conflict.c and struct-simple.cpp on MIPS

[slthakur]

Summary

• For mips assember '#' is the start of comment. We get assembler error messages if # is used in the struct names. Therefore using '$' which works for all architectures.
• Changed expected output of some tests accordingly.

[bruening]

Depends on https://reviews.llvm.org/D24334 where the s/#/_/ is under discussion

[slthakur]

Addressed review comments.

[zhaoqin]

Please update the commit message, because I do not see any fix related to mmap-shadow-conflict.c

[slthakur]

Committed in rL282142

lib/esan/cache_frag.cpp

static void reportStructCounter(StructHashMap::Handle &Handle) {
   // Remove the '.' after class/struct during print.
   if (strncmp(Struct->StructName, "class.", 6) == 0) {
     type = "class";
     start = &Struct->StructName[6];
   } else {
     type = "struct";
     start = &Struct->StructName[7];
   }
-  // Remove the suffixes with '#' during print.
-  end = strchr(start, '#');
+  // Remove the suffixes with '_' during print.
+  end = strchr(start, '_');
   CHECK(end != nullptr);
   Report("  %s %.*s\n", type, end - start, start);
   Report("   size = %u, count = %llu, ratio = %llu, array access = %llu\n",
          Struct->Size, Handle->Count, Handle->Ratio, *Struct->ArrayCounter);
   if (Struct->hasAuxFieldInfo()) {
     for (u32 i = 0; i < Struct->NumFields; ++i) {
       Report("   #%2u: offset = %u,\t size = %u,"
              "\t count = %llu,\t type = %.*s\n",

test/esan/TestCases/mmap-shadow-conflict.c

 // RUN: %clang_esan_frag -O0 %s -o %t 2>&1
-// RUN: %env_esan_opts=verbosity=1 %run %t 2>&1 | FileCheck %s
+// RUN: %env_esan_opts=verbosity=1 %run %t 2>&1 | FileCheck --check-prefix=%arch %s
 
 #include <unistd.h>
 #include <sys/mman.h>
 #include <stdio.h>
 
 int main(int argc, char **argv) {
-  void *Map = mmap((void *)0x0000016000000000ULL, 0x1000, PROT_READ,
+#if defined(__mips64)
+  void *Map = mmap((void *)0x0000001600000000ULL, 0x1000, PROT_READ,
                    MAP_ANON|MAP_PRIVATE|MAP_FIXED, -1, 0);
+#else
+  void *Map = mmap((void *)0x0000016000000000ULL, 0x1000, PROT_READ,
+#endif
   if (Map == (void *)-1)
     fprintf(stderr, "map failed\n");
   else
     fprintf(stderr, "mapped %p\n", Map);
+#if defined(__mips64)
+  Map = mmap((void *)0x0000001600000000ULL, 0x1000, PROT_READ,
+                   MAP_ANON|MAP_PRIVATE, -1, 0);
+#else
   Map = mmap((void *)0x0000016000000000ULL, 0x1000, PROT_READ,
                    MAP_ANON|MAP_PRIVATE, -1, 0);
+#endif
   fprintf(stderr, "mapped %p\n", Map);
   // CHECK:      in esan::initializeLibrary
   // (There can be a re-exec for stack limit here.)
-  // CHECK:      Shadow scale=2 offset=0x440000000000
-  // CHECK-NEXT: Shadow #0: [110000000000-114000000000) (256GB)
-  // CHECK-NEXT: Shadow #1: [124000000000-12c000000000) (512GB)
-  // CHECK-NEXT: Shadow #2: [148000000000-150000000000) (512GB)
+  // x86_64:      Shadow scale=2 offset=0x440000000000
+  // x86_64-NEXT: Shadow #0: [110000000000-114000000000) (256GB)
+  // x86_64-NEXT: Shadow #1: [124000000000-12c000000000) (512GB)
+  // x86_64-NEXT: Shadow #2: [148000000000-150000000000) (512GB)
+  // mips64:      Shadow scale=2 offset=0x4400000000
+  // mips64-NEXT: Shadow #0: [1140000000-1180000000) (1GB)
+  // mips64-NEXT: Shadow #1: [1380000000-13c0000000) (1GB)
+  // mips64-NEXT: Shadow #2: [14c0000000-1500000000) (1GB)
   // CHECK-NEXT: mmap conflict: {{.*}}
   // CHECK-NEXT: map failed
   // CHECK-NEXT: mmap conflict: {{.*}}
   // CHECK-NEXT: mapped {{.*}}
   // CHECK-NEXT: in esan::finalizeLibrary
   return 0;
 }

test/esan/TestCases/struct-simple.cpp

struct D {
   int d3;
 };
 
 int main(int argc, char **argv) {
   // CHECK:      in esan::initializeLibrary
   // CHECK:      in esan::initializeCacheFrag
   // CHECK-NEXT: in esan::processCompilationUnitInit
   // CHECK-NEXT: in esan::processCacheFragCompilationUnitInit: {{.*}}struct-simple.cpp with 6 class(es)/struct(s)
-  // CHECK-NEXT:  Register struct.A#2#11#11: 2 fields
-  // CHECK-NEXT:  Register struct.B#2#3#2:   2 fields
-  // CHECK-NEXT:  Register union.U#1#3:      1 fields
-  // CHECK-NEXT:  Register struct.S#2#11#11: 2 fields
-  // CHECK-NEXT:  Register struct.D#3#14#11#11: 3 fields
-  // CHECK-NEXT:  Register struct.anon#3#11#11#11: 3 fields
+  // CHECK-NEXT:  Register struct.A_2_11_11: 2 fields
+  // CHECK-NEXT:  Register struct.B_2_3_2:   2 fields
+  // CHECK-NEXT:  Register union.U_1_3:      1 fields
+  // CHECK-NEXT:  Register struct.S_2_11_11: 2 fields
+  // CHECK-NEXT:  Register struct.D_3_14_11_11: 3 fields
+  // CHECK-NEXT:  Register struct.anon_3_11_11_11: 3 fields
   // CHECK-NEXT: in esan::processCompilationUnitInit
   // CHECK-NEXT: in esan::processCacheFragCompilationUnitInit: {{.*}}struct-simple.cpp with 0 class(es)/struct(s)
   // CHECK-NEXT: in esan::processCompilationUnitInit
   // CHECK-NEXT: in esan::processCacheFragCompilationUnitInit: {{.*}}struct-simple.cpp with 5 class(es)/struct(s)
-  // CHECK-NEXT:  Register class.C#3#14#13#13:  3 fields
-  // CHECK-NEXT:  Register struct.anon#2#11#11: 2 fields
-  // CHECK-NEXT:  Register union.anon#1#3:      1 fields
-  // CHECK-NEXT:  Duplicated struct.S#2#11#11:  2 fields
-  // CHECK-NEXT:  Register struct.D#3#11#11#11: 3 fields
+  // CHECK-NEXT:  Register class.C_3_14_13_13:  3 fields
+  // CHECK-NEXT:  Register struct.anon_2_11_11: 2 fields
+  // CHECK-NEXT:  Register union.anon_1_3:      1 fields
+  // CHECK-NEXT:  Duplicated struct.S_2_11_11:  2 fields
+  // CHECK-NEXT:  Register struct.D_3_11_11_11: 3 fields
   struct C c[2];
   struct S s;
   struct D d;
   c[0].cs.x = 0;
   c[1].cs.y = 1;
   c[0].cu.f = 0.0;
   c[1].cu.d = 1.0;
   c[0].c[2] = 0;
   s.s1 = 0;
   d.d1 = 0;
   d.d2 = 0;
   part1();
   part2();
   return 0;
   // CHECK:      in esan::finalizeLibrary
   // CHECK-NEXT: in esan::finalizeCacheFrag
   // CHECK-NEXT: in esan::processCompilationUnitExit
   // CHECK-NEXT: in esan::processCacheFragCompilationUnitExit: {{.*}}struct-simple.cpp with 5 class(es)/struct(s)
-  // CHECK-NEXT:  Unregister class.C#3#14#13#13:  3 fields
+  // CHECK-NEXT:  Unregister class.C_3_14_13_13:  3 fields
   // CHECK-NEXT:   {{.*}} class C
   // CHECK-NEXT:   {{.*}}  size = 32, count = 5, ratio = 3, array access = 5
   // CHECK-NEXT:   {{.*}}  # 0: offset = 0,  size = 8,  count = 2, type = %struct.anon = type { i32, i32 }
   // CHECK-NEXT:   {{.*}}  # 1: offset = 8,  size = 8,  count = 2, type = %union.anon = type { double }
   // CHECK-NEXT:   {{.*}}  # 2: offset = 16, size = 10, count = 1, type = [10 x i8]
-  // CHECK-NEXT:  Unregister struct.anon#2#11#11: 2 fields
+  // CHECK-NEXT:  Unregister struct.anon_2_11_11: 2 fields
   // CHECK-NEXT:   {{.*}} struct anon
   // CHECK-NEXT:   {{.*}}  size = 8, count = 2, ratio = 1, array access = 0
   // CHECK-NEXT:   {{.*}}  # 0: offset = 0, size = 4, count = 1, type = i32
   // CHECK-NEXT:   {{.*}}  # 1: offset = 4, size = 4, count = 1, type = i32
-  // CHECK-NEXT:  Unregister union.anon#1#3:      1 fields
-  // CHECK-NEXT:  Unregister struct.S#2#11#11:    2 fields
+  // CHECK-NEXT:  Unregister union.anon_1_3:      1 fields
+  // CHECK-NEXT:  Unregister struct.S_2_11_11:    2 fields
   // CHECK-NEXT:   {{.*}} struct S
   // CHECK-NEXT:   {{.*}}  size = 8, count = 2, ratio = 2, array access = 0
   // CHECK-NEXT:   {{.*}}  # 0: count = 2
   // CHECK-NEXT:   {{.*}}  # 1: count = 0
-  // CHECK-NEXT:  Unregister struct.D#3#11#11#11: 3 fields
+  // CHECK-NEXT:  Unregister struct.D_3_11_11_11: 3 fields
   // CHECK-NEXT:   {{.*}} struct D
   // CHECK-NEXT:   {{.*}}  size = 12, count = 2, ratio = 2, array access = 0
   // CHECK-NEXT:   {{.*}}  # 0: offset = 0, size = 4, count = 1, type = i32
   // CHECK-NEXT:   {{.*}}  # 1: offset = 4, size = 4, count = 1, type = i32
   // CHECK-NEXT:   {{.*}}  # 2: offset = 8, size = 4, count = 0, type = i32
   // CHECK-NEXT: in esan::processCompilationUnitExit
   // CHECK-NEXT: in esan::processCacheFragCompilationUnitExit: {{.*}}struct-simple.cpp with 0 class(es)/struct(s)
   // CHECK-NEXT: in esan::processCompilationUnitExit
   // CHECK-NEXT: in esan::processCacheFragCompilationUnitExit: {{.*}}struct-simple.cpp with 6 class(es)/struct(s)
-  // CHECK-NEXT:  Unregister struct.A#2#11#11:    2 fields
+  // CHECK-NEXT:  Unregister struct.A_2_11_11:    2 fields
   // CHECK-NEXT:   {{.*}} struct A
   // CHECK-NEXT:   {{.*}}  size = 8, count = 2049, ratio = 2048, array access = 0
   // CHECK-NEXT:   {{.*}}  # 0: count = 2048
   // CHECK-NEXT:   {{.*}}  # 1: count = 1
-  // CHECK-NEXT:  Unregister struct.B#2#3#2:      2 fields
+  // CHECK-NEXT:  Unregister struct.B_2_3_2:      2 fields
   // CHECK-NEXT:   {{.*}} struct B
   // CHECK-NEXT:   {{.*}}  size = 16, count = 2097153, ratio = 2097152, array access = 0
   // CHECK-NEXT:   {{.*}}  # 0: count = 1
   // CHECK-NEXT:   {{.*}}  # 1: count = 2097152
-  // CHECK-NEXT:  Unregister union.U#1#3:         1 fields
-  // CHECK-NEXT:  Duplicated struct.S#2#11#11:    2 fields
-  // CHECK-NEXT:  Unregister struct.D#3#14#11#11: 3 fields
+  // CHECK-NEXT:  Unregister union.U_1_3:         1 fields
+  // CHECK-NEXT:  Duplicated struct.S_2_11_11:    2 fields
+  // CHECK-NEXT:  Unregister struct.D_3_14_11_11: 3 fields
   // CHECK-NEXT:  {{.*}} struct D
   // CHECK-NEXT:  {{.*}}  size = 128, count = 2097153, ratio = 2097153, array access = 0
   // CHECK-NEXT:  {{.*}}  # 0: count = 1
   // CHECK-NEXT:  {{.*}}  # 1: count = 0
   // CHECK-NEXT:  {{.*}}  # 2: count = 2097152
-  // CHECK-NEXT:  Unregister struct.anon#3#11#11#11: 3 fields
+  // CHECK-NEXT:  Unregister struct.anon_3_11_11_11: 3 fields
   // CHECK-NEXT:  {{.*}} struct anon
   // CHECK-NEXT:  {{.*}}  size = 12, count = 2097152, ratio = 4194304, array access = 2097152
   // CHECK-NEXT:  {{.*}}  # 0: count = 0
   // CHECK-NEXT:  {{.*}}  # 1: count = 2097152
   // CHECK-NEXT:  {{.*}}  # 2: count = 0
   // CHECK-NEXT: {{.*}}EfficiencySanitizer: total struct field access count = 6293518
 }
 #endif // MAIN

test/esan/TestCases/verbose-simple.c

 // RUN: %clang_esan_frag -O0 %s -o %t 2>&1
-// RUN: %env_esan_opts="verbosity=1 log_exe_name=1" %run %t 2>&1 | FileCheck --check-prefix=CHECK-%arch %s
+// RUN: %env_esan_opts="verbosity=1 log_exe_name=1" %run %t 2>&1 | FileCheck --check-prefix=%arch %s
 
 int main(int argc, char **argv) {
   // CHECK:      in esan::initializeLibrary
   // (There can be a re-exec for stack limit here.)
-  // CHECK-x86_64: Shadow scale=2 offset=0x440000000000
-  // CHECK-x86_64: Shadow #0: [110000000000-114000000000) (256GB)
-  // CHECK-x86_64: Shadow #1: [124000000000-12c000000000) (512GB)
-  // CHECK-x86_64: Shadow #2: [148000000000-150000000000) (512GB)
-  // CHECK-mips64: Shadow scale=2 offset=0x4400000000
-  // CHECK-mips64: Shadow #0: [1140000000-1180000000) (1GB)
-  // CHECK-mips64: Shadow #1: [1380000000-13c0000000) (1GB)
-  // CHECK-mips64: Shadow #2: [14c0000000-1500000000) (1GB)
+  // x86_64:      Shadow scale=2 offset=0x440000000000
+  // x86_64-NEXT: Shadow #0: [110000000000-114000000000) (256GB)
+  // x86_64-NEXT: Shadow #1: [124000000000-12c000000000) (512GB)
+  // x86_64-NEXT: Shadow #2: [148000000000-150000000000) (512GB)
+  // mips64:      Shadow scale=2 offset=0x4400000000
+  // mips64-NEXT: Shadow #0: [1140000000-1180000000) (1GB)
+  // mips64-NEXT: Shadow #1: [1380000000-13c0000000) (1GB)
+  // mips64-NEXT: Shadow #2: [14c0000000-1500000000) (1GB)
   // CHECK: in esan::finalizeLibrary
   // CHECK: ==verbose-simple{{.*}}EfficiencySanitizer: total struct field access count = 0
   return 0;
 }

test/lit.common.cfg

config.substitutions.append(
      instead define '%clangXXX' substitution in lit config. ***\n\n""") )
 
 # Allow tests to be executed on a simulator or remotely.
 config.substitutions.append( ('%run', config.emulator) )
 
 # Define CHECK-%os to check for OS-dependent output.
 config.substitutions.append( ('CHECK-%os', ("CHECK-" + config.host_os)))
 
-# Define CHECK-%arch to check for architecture-dependent output.
-config.substitutions.append( ('CHECK-%arch', ("CHECK-" + config.host_arch)))
+# Define %arch to check for architecture-dependent output.
+config.substitutions.append( ('%arch', (config.host_arch)))
 
 if config.host_os == 'Windows':
   # FIXME: This isn't quite right. Specifically, it will succeed if the program
   # does not crash but exits with a non-zero exit code. We ought to merge
   # KillTheDoctor and not --crash to make the latter more useful and remove the
   # need for this substitution.
   config.expect_crash = "not KillTheDoctor "
 else: