html chart for peak memory consumption, some Array tracing fixes

This commit is contained in:
Matthias Hochsteger 2020-11-19 14:57:45 +01:00
parent f143995f27
commit a17066a387
5 changed files with 290 additions and 92 deletions

View File

@ -701,6 +701,8 @@ namespace ngcore
NETGEN_INLINE Array (Array && a2) NETGEN_INLINE Array (Array && a2)
{ {
TraceMemoryChange(mem_tracing_id, sizeof(T)*(a2.allocsize-allocsize));
size = a2.size; size = a2.size;
data = a2.data; data = a2.data;
allocsize = a2.allocsize; allocsize = a2.allocsize;
@ -772,6 +774,7 @@ namespace ngcore
NETGEN_INLINE ~Array() NETGEN_INLINE ~Array()
{ {
delete [] mem_to_delete; delete [] mem_to_delete;
TraceMemoryFree(mem_tracing_id, sizeof(T)*allocsize);
} }
// Only provide this function if T is archivable // Only provide this function if T is archivable
@ -826,6 +829,7 @@ namespace ngcore
NETGEN_INLINE const Array & Assign (size_t asize, LocalHeap & lh) NETGEN_INLINE const Array & Assign (size_t asize, LocalHeap & lh)
{ {
delete [] mem_to_delete; delete [] mem_to_delete;
TraceMemoryFree(mem_tracing_id, sizeof(T)*allocsize);
size = allocsize = asize; size = allocsize = asize;
data = lh.Alloc<T> (asize); data = lh.Alloc<T> (asize);
mem_to_delete = nullptr; mem_to_delete = nullptr;
@ -933,6 +937,7 @@ namespace ngcore
NETGEN_INLINE void DeleteAll () NETGEN_INLINE void DeleteAll ()
{ {
delete [] mem_to_delete; delete [] mem_to_delete;
TraceMemoryFree(mem_tracing_id, sizeof(T)*allocsize);
mem_to_delete = NULL; mem_to_delete = NULL;
data = 0; data = 0;
size = allocsize = 0; size = allocsize = 0;
@ -964,6 +969,8 @@ namespace ngcore
/// steal array /// steal array
NETGEN_INLINE Array & operator= (Array && a2) NETGEN_INLINE Array & operator= (Array && a2)
{ {
TraceMemoryChange(mem_tracing_id, sizeof(T)*(a2.allocsize-allocsize));
ngcore::Swap (size, a2.size); ngcore::Swap (size, a2.size);
ngcore::Swap (data, a2.data); ngcore::Swap (data, a2.data);
ngcore::Swap (allocsize, a2.allocsize); ngcore::Swap (allocsize, a2.allocsize);
@ -1037,6 +1044,8 @@ namespace ngcore
NETGEN_INLINE void Swap (Array & b) NETGEN_INLINE void Swap (Array & b)
{ {
TraceMemoryChange(mem_tracing_id, sizeof(T)*(b.allocsize-allocsize));
ngcore::Swap (size, b.size); ngcore::Swap (size, b.size);
ngcore::Swap (data, b.data); ngcore::Swap (data, b.data);
ngcore::Swap (allocsize, b.allocsize); ngcore::Swap (allocsize, b.allocsize);
@ -1069,10 +1078,9 @@ namespace ngcore
size_t nsize = 2 * allocsize; size_t nsize = 2 * allocsize;
if (nsize < minsize) nsize = minsize; if (nsize < minsize) nsize = minsize;
TraceMemoryAlloc(mem_tracing_id, sizeof(T)*nsize );
T * hdata = data; T * hdata = data;
data = new T[nsize]; data = new T[nsize];
TraceMemoryAlloc(mem_tracing_id, sizeof(T)*nsize );
if (hdata) if (hdata)
{ {

View File

@ -243,7 +243,8 @@ namespace ngcore
PajeFile( const std::string & filename) PajeFile( const std::string & filename)
{ {
ctrace_stream = fopen (filename.c_str(),"w"); // NOLINT std::string fname = filename + ".trace";
ctrace_stream = fopen (fname.c_str(),"w"); // NOLINT
fprintf(ctrace_stream, "%s", header ); // NOLINT fprintf(ctrace_stream, "%s", header ); // NOLINT
alias_counter = 0; alias_counter = 0;
} }
@ -809,24 +810,25 @@ namespace ngcore
int id = 0; int id = 0;
std::map<int, TreeNode> children; std::map<int, TreeNode> children;
double chart_size = 0.0; // time without children (the chart lib accumulates children sizes again) double chart_size = 0.0; // time without children (the chart lib accumulates children sizes again)
double time = 0.0; double size = 0.0;
double min_time = 1e99; double min_size = 1e99;
double max_time = 0.0; double max_size = 0.0;
size_t calls = 0;
std::string name; std::string name;
size_t calls = 0;
TTimePoint start_time = 0; TTimePoint start_time = 0;
}; };
void PrintNode (const TreeNode &n, int &level, std::ofstream & f); void PrintNode (const TreeNode &n, std::ofstream & f)
void PrintNode (const TreeNode &n, int &level, std::ofstream & f)
{ {
f << "{ name: \"" + n.name + "\""; f << "{ name: \"" + n.name + "\"";
f << ", calls: " << n.calls; f << ", calls: " << n.calls;
f << ", size: " << n.chart_size; f << ", size: " << n.chart_size;
f << ", time: " << n.time; f << ", value: " << n.size;
f << ", min: " << n.min_time; f << ", min: " << n.min_size;
f << ", max: " << n.max_time; f << ", max: " << n.max_size;
f << ", avg: " << n.time/n.calls; if(n.calls)
f << ", avg: " << n.size/n.calls;
int size = n.children.size(); int size = n.children.size();
if(size>0) if(size>0)
{ {
@ -834,7 +836,7 @@ namespace ngcore
f << ", children: ["; f << ", children: [";
for(auto & c : n.children) for(auto & c : n.children)
{ {
PrintNode(c.second, level, f); PrintNode(c.second, f);
if(++i<size) if(++i<size)
f << " , "; f << " , ";
} }
@ -843,6 +845,183 @@ namespace ngcore
f << '}'; f << '}';
} }
void WriteSunburstHTML( TreeNode & root, std::string filename, bool time_or_memory )
{
std::ofstream f(filename+".html");
f.precision(4);
f << R"CODE_(
<head>
<script src="https://d3js.org/d3.v5.min.js"></script>
<script src="https://unpkg.com/sunburst-chart"></script>
<style>body { margin: 0 }</style>
)CODE_";
if(!time_or_memory)
f << "<title>Maximum Memory Consumption</title>\n";
f << R"CODE_(
</head>
<body>
<div id="chart"></div>
<script>
const data =
)CODE_";
PrintNode(root, f);
f << ";\n\n";
if(time_or_memory)
f << "const chart_type = 'time';\n";
else
f << "const chart_type = 'memory';\n";
f << R"CODE_(
const color = d3.scaleOrdinal(d3.schemePaired);
let getTime = (t) =>
{
if(t>=1000) return (t/1000).toPrecision(4) + ' s';
if(t>=0.1) return t.toPrecision(4) + ' ms';
if(t>=1e-4) return (t*1e3).toPrecision(4) + ' us';
return (t/1e6).toPrecision(4) + ' ns';
};
const KB_ = 1024;
const MB_ = KB_*1024;
const GB_ = MB_*1024;
let getMemory = (m) =>
{
if(m>=GB_) return (m/GB_).toPrecision(4) + ' GB';
if(m>=MB_) return (m/MB_).toPrecision(4) + ' MB';
if(m>=KB_) return (m/KB_).toPrecision(4) + ' KB';
return m.toPrecision(4) + ' B';
};
Sunburst()
.data(data)
.size('size')
.color(d => color(d.name))
.tooltipTitle((d, node) => { return node.parent ? node.parent.data.name + " &rarr; " + d.name : d.name; })
.tooltipContent((d, node) => {
if(chart_type=="memory")
{
return `Total Memory: <i>${getMemory(d.value)}</i> <br>`
+ `Memory: <i>${getMemory(d.size)}</i>`
}
else
{
return `Time: <i>${getTime(d.value)}</i> <br>`
+ `calls: <i>${d.calls}</i> <br>`
+ `min: <i>${getTime(d.min)}</i> <br>`
+ `max: <i>${getTime(d.max)}</i> <br>`
+ `avg: <i>${getTime(d.avg)}</i>`
}
})
(document.getElementById('chart'));
// Line breaks in tooltip
var all = document.getElementsByClassName('sunbirst-tooltip');
for (var i = 0; i < all.length; i++) {
all[i].white_space = "";
}
</script>
</body>
)CODE_" << std::endl;
}
void WriteMemorySunburstHTML( std::vector<PajeTrace::MemoryEvent> & events, std::string filename )
{
size_t mem_allocated;
size_t max_mem_allocated;
size_t imax_mem_allocated;
const auto & names = MemoryTracer::GetNames();
const auto & tree = MemoryTracer::GetTree();
auto N = names.size();
Array<size_t> mem_allocated_id(N);
mem_allocated_id = 0;
// Find point with maximum memory allocation, check for missing allocs/frees
for(auto i : IntRange(events.size()))
{
const auto & ev = events[i];
if(ev.is_alloc)
{
mem_allocated += ev.size;
mem_allocated_id[ev.id] += ev.size;
if(mem_allocated > max_mem_allocated)
{
imax_mem_allocated = i;
max_mem_allocated = mem_allocated;
}
}
else
{
if(ev.size > mem_allocated)
std::cerr << "Error in memory tracer: have total allocated memory < 0" << std::endl;
if(ev.size > mem_allocated_id[ev.id])
std::cerr << "Error in memory tracer: have allocated memory < 0 in tracer " << names[ev.id] << std::endl;
mem_allocated -= ev.size;
mem_allocated_id[ev.id] -= ev.size;
}
}
// reconstruct again the memory consumption after event imax_mem_allocated
mem_allocated_id = 0;
for(auto i : IntRange(imax_mem_allocated+1))
{
const auto & ev = events[i];
if(ev.is_alloc)
mem_allocated_id[ev.id] += ev.size;
else
mem_allocated_id[ev.id] -= ev.size;
}
TreeNode root;
root.name="all";
Array<TreeNode*> nodes(N);
nodes = nullptr;
// find root nodes in memory tracer tree, i.e. they have no parents
Array<int> parents(N);
parents = -1;
for( const auto & [iparent, children] : tree )
for (auto child_id : children)
{
if(parents[child_id] != -1)
std::cerr << "Error in memory tracer: multiple parents found for " << names[child_id] << std::endl;
parents[child_id] = iparent;
}
for(auto i : IntRange(1, N))
{
TreeNode * parent = &root;
if(parents[i]!=-1)
parent = nodes[parents[i]];
auto & node = parent->children[i];
nodes[i] = &node;
node.id = i;
node.chart_size = mem_allocated_id[i];
node.size = mem_allocated_id[i];
node.name = names[i];
}
for(auto i : IntRange(1, N))
if(parents[N-i]==-1)
root.size += nodes[N-i]->size;
else
nodes[parents[N-i]]->size += nodes[N-i]->size;
WriteSunburstHTML( root, filename, false );
}
void PajeTrace::WriteSunburstHTML( ) void PajeTrace::WriteSunburstHTML( )
{ {
std::vector<TimerEvent> events; std::vector<TimerEvent> events;
@ -884,10 +1063,10 @@ namespace ngcore
std::sort (events.begin(), events.end()); std::sort (events.begin(), events.end());
root.time = 1000.0*static_cast<double>(stop_time) * seconds_per_tick; root.size = 1000.0*static_cast<double>(stop_time) * seconds_per_tick;
root.calls = 1; root.calls = 1;
root.min_time = root.time; root.min_size = root.size;
root.max_time = root.time; root.max_size = root.size;
for(auto & event : events) for(auto & event : events)
{ {
@ -904,7 +1083,7 @@ namespace ngcore
if(need_init) if(need_init)
{ {
current->name = is_timer_event ? GetTimerName(id) : job_names[id]; current->name = is_timer_event ? GetTimerName(id) : job_names[id];
current->time = 0.0; current->size = 0.0;
current->id = id; current->id = id;
} }
@ -916,73 +1095,23 @@ namespace ngcore
std::cout << "node stack empty!" << std::endl; std::cout << "node stack empty!" << std::endl;
break; break;
} }
double time = 1000.0*static_cast<double>(event.time-current->start_time) * seconds_per_tick; double size = 1000.0*static_cast<double>(event.time-current->start_time) * seconds_per_tick;
current->time += time; current->size += size;
current->chart_size += time; current->chart_size += size;
current->min_time = std::min(current->min_time, time); current->min_size = std::min(current->min_size, size);
current->max_time = std::max(current->max_time, time); current->max_size = std::max(current->max_size, size);
current->calls++; current->calls++;
current = node_stack.back(); current = node_stack.back();
current->chart_size -= time; current->chart_size -= size;
node_stack.pop_back(); node_stack.pop_back();
} }
} }
root.chart_size = 0.0; root.chart_size = 0.0;
int level = 0; ngcore::WriteSunburstHTML( root, tracefile_name, true );
std::ofstream f(tracefile_name+".html"); WriteMemorySunburstHTML( memory_events, tracefile_name+"_memory" );
f.precision(4);
f << R"CODE_(
<head>
<script src="https://d3js.org/d3.v5.min.js"></script>
<script src="https://unpkg.com/sunburst-chart"></script>
<style>body { margin: 0 }</style>
</head>
<body>
<div id="chart"></div>
<script>
const data =
)CODE_";
PrintNode(root, level, f);
f << R"CODE_( ;
const color = d3.scaleOrdinal(d3.schemePaired);
let getTime = (t) =>
{
if(t>=1000) return (t/1000).toPrecision(4) + ' s';
if(t>=0.1) return t.toPrecision(4) + ' ms';
if(t>=1e-4) return (t*1e3).toPrecision(4) + ' us';
return (t/1e6).toPrecision(4) + ' ns';
};
Sunburst()
.data(data)
.size('size')
.color(d => color(d.name))
.tooltipTitle((d, node) => { return node.parent ? node.parent.data.name + " &rarr; " + d.name : d.name; })
.tooltipContent((d, node) => {
return `Time: <i>${getTime(d.time)}</i> <br>`
+ `calls: <i>${d.calls}</i> <br>`
+ `min: <i>${getTime(d.min)}</i> <br>`
+ `max: <i>${getTime(d.max)}</i> <br>`
+ `avg: <i>${getTime(d.avg)}</i>`
})
(document.getElementById('chart'));
// Line breaks in tooltip
var all = document.getElementsByClassName('sunbirst-tooltip');
for (var i = 0; i < all.length; i++) {
all[i].white_space = "";
}
</script>
</body>
)CODE_" << std::endl;
} }
} // namespace ngcore } // namespace ngcore

View File

@ -106,7 +106,7 @@ namespace ngcore
{ {
TTimePoint time; TTimePoint time;
size_t size; size_t size;
int region_id; int id;
bool is_alloc; bool is_alloc;
bool operator < (const MemoryEvent & other) const { return time < other.time; } bool operator < (const MemoryEvent & other) const { return time < other.time; }

View File

@ -300,10 +300,48 @@ namespace ngcore
return tres; return tres;
} }
class MemoryTracer;
namespace detail
{
//Type trait to check if a class implements a 'const MemoryTracer& GetMemoryTracer()' function
template<typename T>
struct has_GetMemoryTracer
{
private:
template<typename T2>
static constexpr auto check(T2*) ->
typename std::is_same<decltype(std::declval<T2>().GetMemoryTracer()),const MemoryTracer &>::type;
template<typename>
static constexpr std::false_type check(...);
using type = decltype(check<T>(nullptr)); // NOLINT
public:
static constexpr bool value = type::value;
};
//Type trait to check if a class implements a 'void SetMemoryTacing(int)' function
template<typename T>
struct has_SetMemoryTracing
{
private:
template<typename T2>
static constexpr auto check(T2*) ->
typename std::is_same<decltype(std::declval<T2>().SetMemoryTracing(0)),void>::type;
template<typename>
static constexpr std::false_type check(...);
using type = decltype(check<T>(nullptr)); // NOLINT
public:
static constexpr bool value = type::value;
};
} // namespace detail
class MemoryTracer class MemoryTracer
{ {
NGCORE_API static std::vector<std::string> names; NGCORE_API static std::vector<std::string> names;
NGCORE_API static std::map< int, std::vector<int> > tree;
static int GetId(std::string name) static int GetId(std::string name)
{ {
int id = names.size(); int id = names.size();
@ -313,7 +351,6 @@ namespace ngcore
return id; return id;
} }
NGCORE_API static std::map< int, std::vector<int> > tree;
int id; int id;
@ -332,32 +369,50 @@ namespace ngcore
} }
template <typename T1, typename... TRest> template <typename T1, typename... TRest>
void Track( T1 & obj, std::string name, TRest & ... rest ) void Track( T1 & obj, std::string name, TRest & ... rest ) const
{ {
Track(obj, name); Track(obj, name);
Track(rest...); Track(rest...);
} }
template<typename T> template<typename T>
void Track( T & obj, std::string name ) void Track( T & obj, std::string name ) const
{
if constexpr(detail::has_SetMemoryTracing<T>::value)
{ {
int child_id = GetId(name); int child_id = GetId(name);
tree[id].push_back(child_id); tree[id].push_back(child_id);
obj.SetMemoryTracing(child_id); obj.SetMemoryTracing(child_id);
} }
if constexpr(detail::has_GetMemoryTracer<T>::value)
template<typename T>
void Track( T & obj )
{ {
auto & mt = obj.GetMemoryTracer(); auto & mt = obj.GetMemoryTracer();
int child_id = mt.id; int child_id = mt.id;
if(name!="")
names[mt.id] = name;
tree[id].push_back(child_id); tree[id].push_back(child_id);
} }
}
static std::string GetName(int id) static std::string GetName(int id)
{ {
return names[id]; return names[id];
} }
std::string GetName() const
{
return names[id];
}
void SetName(std::string name) const
{
names[id] = name;
}
static const std::vector<std::string> & GetNames() { return names; }
static const std::map<int, std::vector<int>> & GetTree() { return tree; }
}; };
NETGEN_INLINE void TraceMemoryAlloc( int mem_id, size_t size ) NETGEN_INLINE void TraceMemoryAlloc( int mem_id, size_t size )
@ -372,6 +427,12 @@ namespace ngcore
trace->FreeMemory(mem_id, size); trace->FreeMemory(mem_id, size);
} }
NETGEN_INLINE void TraceMemoryChange( int mem_id, long long size )
{
if(mem_id && trace)
trace->ChangeMemory(mem_id, size);
}
} // namespace ngcore } // namespace ngcore
// Helper macro to easily add multiple timers in a function for profiling // Helper macro to easily add multiple timers in a function for profiling

View File

@ -160,7 +160,7 @@ namespace ngcore
static int cnt = 0; static int cnt = 0;
if (use_paje_trace) if (use_paje_trace)
trace = new PajeTrace(num_threads, "ng" + ToString(cnt++) + ".trace"); trace = new PajeTrace(num_threads, "ng" + ToString(cnt++));
} }