Index: lib/esan/cache_frag.cpp =================================================================== --- lib/esan/cache_frag.cpp +++ lib/esan/cache_frag.cpp @@ -13,27 +13,112 @@ //===----------------------------------------------------------------------===// #include "esan.h" +#include "sanitizer_common/sanitizer_addrhashmap.h" +#include "sanitizer_common/sanitizer_placement_new.h" namespace __esan { +//===-- Struct field access counter runtime -------------------------------===// + +// This should be kept consistent with LLVM's EfficiencySanitizer StructInfo. +struct StructInfo { + const char *StructName; + u32 NumOfFields; + u64 *Counters; + const char **TypeName; +}; + +// This should be kept consistent with LLVM's EfficiencySanitizer ToolInfo and +// its extension for the cache-fragmentation tool. +// The tool-specific information per compilation unit (module). +struct CacheFragInfo { + const char *UnitName; + u32 NumOfStructs; + StructInfo *Structs; +}; + +struct StructCounter { + StructInfo *Info; + u64 Count; // The total access count of the struct. + u32 Variance; // Variance score for the struct layout access. +}; + + +// We use StructHashMap to keep track of an unique copy of StructCounter. +typedef AddrHashMap StructHashMap; +struct Context { + StructHashMap StructMap; + u32 NumOfStructs; + u64 TotalCount; // The total access count of all structs. +}; +static Context *Ctx; + +static void registerStructInfo(CacheFragInfo *CacheFrag) { + for (u32 i = 0; i < CacheFrag->NumOfStructs; ++i) { + StructInfo *Info = &CacheFrag->Structs[i]; + StructHashMap::Handle H(&Ctx->StructMap, (uptr)Info->Counters); + if (H.created()) { + VPrintf(3, " Register %s: %u fields\n", + Info->StructName, Info->NumOfFields); + H->Info = Info; + ++Ctx->NumOfStructs; + } else { + VPrintf(3, " Duplicated %s: %u fields\n", + Info->StructName, Info->NumOfFields); + } + } +} + +static void unregisterStructInfo(CacheFragInfo *CacheFrag) { + // FIXME: if the library is unloaded before finalizeCacheFrag, we should + // collect the result for later report. + for (u32 i = 0; i < CacheFrag->NumOfStructs; ++i) { + StructInfo *Info = &CacheFrag->Structs[i]; + StructHashMap::Handle H(&Ctx->StructMap, (uptr)Info->Counters, true); + if (H.exists()) { + VPrintf(3, " Unregister %s: %u fields\n", + Info->StructName, Info->NumOfFields); + --Ctx->NumOfStructs; + } else { + VPrintf(3, " Duplicated %s: %u fields\n", + Info->StructName, Info->NumOfFields); + } + } +} + +static void reportStructSummary() { + // FIXME: iterate StructHashMap and generate the final report. + Report("%s is not finished: nothing yet to report\n", SanitizerToolName); +} + //===-- Init/exit functions -----------------------------------------------===// void processCacheFragCompilationUnitInit(void *Ptr) { - VPrintf(2, "in esan::%s\n", __FUNCTION__); + CacheFragInfo *CacheFrag = (CacheFragInfo *)Ptr; + VPrintf(2, "in esan::%s: %s with %u class(es)/struct(s)\n", + __FUNCTION__, CacheFrag->UnitName, CacheFrag->NumOfStructs); + registerStructInfo(CacheFrag); } void processCacheFragCompilationUnitExit(void *Ptr) { - VPrintf(2, "in esan::%s\n", __FUNCTION__); + CacheFragInfo *CacheFrag = (CacheFragInfo *)Ptr; + VPrintf(2, "in esan::%s: %s with %u class(es)/struct(s)\n", + __FUNCTION__, CacheFrag->UnitName, CacheFrag->NumOfStructs); + unregisterStructInfo(CacheFrag); } void initializeCacheFrag() { VPrintf(2, "in esan::%s\n", __FUNCTION__); + // We use placement new to initialize Ctx before C++ static initializaion. + // We make CtxMem 8-byte aligned for atomic operations in AddrHashMap. + static u64 CtxMem[sizeof(Context) / sizeof(u64) + 1]; + Ctx = new(CtxMem) Context(); + Ctx->NumOfStructs = 0; } int finalizeCacheFrag() { VPrintf(2, "in esan::%s\n", __FUNCTION__); - // FIXME: add the cache fragmentation final report. - Report("%s is not finished: nothing yet to report\n", SanitizerToolName); + reportStructSummary(); return 0; } Index: test/esan/TestCases/struct-simple.cpp =================================================================== --- test/esan/TestCases/struct-simple.cpp +++ test/esan/TestCases/struct-simple.cpp @@ -1,7 +1,7 @@ // RUN: %clang_esan_frag -O0 %s -DPART -c -o %t-part.o 2>&1 // RUN: %clang_esan_frag -O0 %s -DMAIN -c -o %t-main.o 2>&1 // RUN: %clang_esan_frag -O0 %t-part.o %t-main.o -o %t 2>&1 -// RUN: %env_esan_opts=verbosity=2 %run %t 2>&1 | FileCheck %s +// RUN: %env_esan_opts=verbosity=3 %run %t 2>&1 | FileCheck %s // We generate two different object files from this file with different // macros, and then link them together. We do this to test how we handle @@ -13,32 +13,121 @@ void part(); } +// Same struct in both main and part. +struct S { + int s1; + int s2; +}; + //===-- compilation unit without main function ----------------------------===// #ifdef PART +struct A { + int x; + int y; +}; + +struct B { + float m; + double n; +}; + +union U { + float f; + double d; +}; + +// Different structs with the same name in main and part. +struct D { + int d1; + int d2; +}; + void part() { + struct A a; + struct B b; + union U u; + struct S s; + struct D d; + for (int i = 0; i < (1 << 11); i++) + a.x = 0; + a.y = 1; + b.m = 2.0; + for (int i = 0; i < (1 << 21); i++) + b.n = 3.0; + u.f = 0.0; + u.d = 1.0; + s.s1 = 0; + d.d1 = 0; } #endif // PART //===-- compilation unit with main function -------------------------------===// #ifdef MAIN +class C { +public: + struct { + int x; + int y; + } cs; + union { + float f; + double d; + } cu; + char c[10]; +}; + +// Different structs with the same name in main and part. +struct D { + int d1; + int d2; + 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 + // CHECK-NEXT: in esan::processCacheFragCompilationUnitInit: {{.*}}struct-simple.cpp with 4 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 struct.S#2#11#11: 2 fields + // CHECK-NEXT: Register struct.D#2#11#11: 2 fields // CHECK-NEXT: in esan::processCompilationUnitInit - // CHECK-NEXT: in esan::processCacheFragCompilationUnitInit + // CHECK-NEXT: in esan::processCacheFragCompilationUnitInit: {{.*}}struct-simple.cpp with 4 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: 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; part(); return 0; // CHECK: in esan::finalizeLibrary // CHECK-NEXT: in esan::finalizeCacheFrag // CHECK-NEXT: {{.*}}EfficiencySanitizer is not finished: nothing yet to report // CHECK-NEXT: in esan::processCompilationUnitExit - // CHECK-NEXT: in esan::processCacheFragCompilationUnitExit + // CHECK-NEXT: in esan::processCacheFragCompilationUnitExit: {{.*}}struct-simple.cpp with 4 class(es)/struct(s) + // CHECK-NEXT: Unregister class.C#3#14#13#13: 3 fields + // CHECK-NEXT: Unregister struct.anon#2#11#11: 2 fields + // CHECK-NEXT: Unregister struct.S#2#11#11: 2 fields + // CHECK-NEXT: Unregister struct.D#3#11#11#11: 3 fields // CHECK-NEXT: in esan::processCompilationUnitExit - // CHECK-NEXT: in esan::processCacheFragCompilationUnitExit + // CHECK-NEXT: in esan::processCacheFragCompilationUnitExit: {{.*}}struct-simple.cpp with 4 class(es)/struct(s) + // CHECK-NEXT: Unregister struct.A#2#11#11: 2 fields + // CHECK-NEXT: Unregister struct.B#2#3#2: 2 fields + // CHECK-NEXT: Duplicated struct.S#2#11#11: 2 fields + // CHECK-NEXT: Unregister struct.D#2#11#11: 2 fields } #endif // MAIN