Teresa Johnson 3d4bba302d [MemProf] Memory profiling runtime support
See RFC for background:
http://lists.llvm.org/pipermail/llvm-dev/2020-June/142744.html

Follow on companion to the clang/llvm instrumentation support in D85948
and committed earlier.

This patch adds the compiler-rt runtime support for the memory
profiling.

Note that much of this support was cloned from asan (and then greatly
simplified and renamed). For example the interactions with the
sanitizer_common allocators, error handling, interception, etc.

The bulk of the memory profiling specific code can be found in the
MemInfoBlock, MemInfoBlockCache, and related classes defined and used
in memprof_allocator.cpp.

For now, the memory profile is dumped to text (stderr by default, but
honors the sanitizer_common log_path flag). It is dumped in either a
default verbose format, or an optional terse format.

This patch also adds a set of tests for the core functionality.

Differential Revision: https://reviews.llvm.org/D87120
2020-10-16 09:47:02 -07:00

62 lines
1.9 KiB
C++

//===-- memprof_stats.h ----------------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This file is a part of MemProfiler, a memory profiler.
//
// MemProf-private header for statistics.
//===----------------------------------------------------------------------===//
#ifndef MEMPROF_STATS_H
#define MEMPROF_STATS_H
#include "memprof_allocator.h"
#include "memprof_internal.h"
namespace __memprof {
// MemprofStats struct is NOT thread-safe.
// Each MemprofThread has its own MemprofStats, which are sometimes flushed
// to the accumulated MemprofStats.
struct MemprofStats {
// MemprofStats must be a struct consisting of uptr fields only.
// When merging two MemprofStats structs, we treat them as arrays of uptr.
uptr mallocs;
uptr malloced;
uptr malloced_overhead;
uptr frees;
uptr freed;
uptr real_frees;
uptr really_freed;
uptr reallocs;
uptr realloced;
uptr mmaps;
uptr mmaped;
uptr munmaps;
uptr munmaped;
uptr malloc_large;
uptr malloced_by_size[kNumberOfSizeClasses];
// Ctor for global MemprofStats (accumulated stats for dead threads).
explicit MemprofStats(LinkerInitialized) {}
// Creates empty stats.
MemprofStats();
void Print(); // Prints formatted stats to stderr.
void Clear();
void MergeFrom(const MemprofStats *stats);
};
// Returns stats for GetCurrentThread(), or stats for fake "unknown thread"
// if GetCurrentThread() returns 0.
MemprofStats &GetCurrentThreadStats();
// Flushes a given stats into accumulated stats of dead threads.
void FlushToDeadThreadStats(MemprofStats *stats);
} // namespace __memprof
#endif // MEMPROF_STATS_H