Changes in src/Common/Stats.h [8f74a6a:1bb9a9a]

File:

• src/Common/Stats.h (modified) (2 diffs)

src/Common/Stats.h

@@ -5 +5 @@
 // file "LICENCE" distributed with Cforall.
 //
-// Heap.h --
+// Stats.h --
 //
 // Author           : Thierry Delisle
@@ -16 +16 @@
 #pragma once
 
+// Entry point for compiler analytics.
+/*
+The compiler currently supports 3 times of analytics:
+         - generic counters
+         - heap statistics
+         - timiing statistics
+
+These can be enabled using the --stats option, to which a comma seperated list of options can be passed.
+For more details see Stats.cc
+
+Counters:
+        The counters are a generic tree of counters that print in a 2-column output format.
+        They can count maximums, averages, totals, etc.
+
+        Currently all counters are under the same enable block, this could be changed if needed.
+
+Heap:
+        Measures the total calls malloc and free as the peak number of allocations per pass
+
+Timing:
+        Comming soon
+*/
+
+
 #include "Common/Stats/Counter.h"
 #include "Common/Stats/Heap.h"
+#include "Common/Stats/Time.h"
+
+namespace Stats {
+        void parse_params(const char * const params);
+        void print();
+}