[esan|cfrag] Add the skeleton to handle the cfrag argument

[zhaoqin]

Summary

Adds the struct declaration for the cache-fragmentation tool variable
passed to the runtime library.

Updates test struct-simple.cpp.

[bruening]

[esan|cfrag] Adds struct CacheFragType

nit: title should be "Add" not "Adds" for consistency

[zhaoqin]

Update commit msg

[zhaoqin]

Rename CacheFragType to CacheFragTy for consistency.

[aizatsky]

lib/esan/cache_frag.cpp

21 ↗

(On Diff #58250)

Again, the same question as for D20541 - is there a reason to have this specialized rather than shared for all tools?

Tool & UnitName seem to be generic enough.

[aizatsky]

lib/esan/cache_frag.cpp

21 ↗

(On Diff #58250)

I saw following CLs and I've got my answers: different tools will have different structures.

[filcab]

lib/esan/cache_frag.cpp

22 ↗

(On Diff #58250)

Same as D20541: No need passing ToolType in the struct, since we're passing it to __esan_init

30 ↗

(On Diff #58250)

Same as above. If we get here and this test fails, then we should have failed on an __esan_init call.

[zhaoqin]

Rebase to ToT.
Remove ToolType.

[zhaoqin]

Add ToolInfo and CacheFragInfo

[filcab]

If we have a common ToolInfo struct, maybe we can switch __esan_init to
take it instead of a void* so we can do without a few of the casts.

LGTM, anyway.

Thank you,

Filipe

[zhaoqin]

Remove ToolInfo

[zhaoqin]

Final

compiler-rt/trunk/lib/esan/cache_frag.cpp

 //
 // This file contains cache fragmentation-specific code.
 //===----------------------------------------------------------------------===//
 
 #include "esan.h"
 
 namespace __esan {
 
+// This should be kept consistent with LLVM's EfficiencySanitizer StructInfo.
+struct StructInfo {
+  const char *StructName;
+  u32 NumOfFields;
+  u64 *FieldCounters;
+  const char **FieldTypeNames;
+};
+
+// This should be kept consistent with LLVM's EfficiencySanitizer CacheFragInfo.
+// The tool-specific information per compilation unit (module).
+struct CacheFragInfo {
+  const char *UnitName;
+  u32 NumOfStructs;
+  StructInfo *Structs;
+};
+
 //===-- 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);
 }
 
 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);
 }
 
 void initializeCacheFrag() {
   VPrintf(2, "in esan::%s\n", __FUNCTION__);
 }
 
 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);
   return 0;
 }
 
 } // namespace __esan

compiler-rt/trunk/lib/esan/esan.cpp

if (WhichTool == ESAN_CacheFrag) {
     return finalizeWorkingSet();
   }
   return 0;
 }
 
 void processCompilationUnitInit(void *Ptr) {
   VPrintf(2, "in esan::%s\n", __FUNCTION__);
   if (WhichTool == ESAN_CacheFrag) {
+    DCHECK(Ptr != nullptr);
     processCacheFragCompilationUnitInit(Ptr);
+  } else {
+    DCHECK(Ptr == nullptr);
   }
 }
 
 // This is called when the containing module is unloaded.
 // For the main executable module, this is called after finalizeLibrary.
 void processCompilationUnitExit(void *Ptr) {
   VPrintf(2, "in esan::%s\n", __FUNCTION__);
   if (WhichTool == ESAN_CacheFrag) {
+    DCHECK(Ptr != nullptr);
     processCacheFragCompilationUnitExit(Ptr);
+  } else {
+    DCHECK(Ptr == nullptr);
   }
 }
 
 } // namespace __esan

compiler-rt/trunk/test/esan/TestCases/struct-simple.cpp

 
 //===-- compilation unit with main function -------------------------------===//
 
 #ifdef MAIN
 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 0 class(es)/struct(s)
   // CHECK-NEXT: in esan::processCompilationUnitInit
-  // CHECK-NEXT: in esan::processCacheFragCompilationUnitInit
+  // CHECK-NEXT: in esan::processCacheFragCompilationUnitInit: {{.*}}struct-simple.cpp with 0 class(es)/struct(s)
   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 0 class(es)/struct(s)
   // CHECK-NEXT: in esan::processCompilationUnitExit
-  // CHECK-NEXT: in esan::processCacheFragCompilationUnitExit
+  // CHECK-NEXT: in esan::processCacheFragCompilationUnitExit: {{.*}}struct-simple.cpp with 0 class(es)/struct(s)
 }
 #endif // MAIN