llvm-project/compiler-rt/lib/memprof/memprof_descriptions.h
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

46 lines
1.3 KiB
C++

//===-- memprof_descriptions.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 memprof_descriptions.cpp.
//===----------------------------------------------------------------------===//
#ifndef MEMPROF_DESCRIPTIONS_H
#define MEMPROF_DESCRIPTIONS_H
#include "memprof_allocator.h"
#include "memprof_thread.h"
#include "sanitizer_common/sanitizer_common.h"
#include "sanitizer_common/sanitizer_report_decorator.h"
namespace __memprof {
void DescribeThread(MemprofThreadContext *context);
inline void DescribeThread(MemprofThread *t) {
if (t)
DescribeThread(t->context());
}
class MemprofThreadIdAndName {
public:
explicit MemprofThreadIdAndName(MemprofThreadContext *t);
explicit MemprofThreadIdAndName(u32 tid);
// Contains "T%tid (%name)" or "T%tid" if the name is empty.
const char *c_str() const { return &name[0]; }
private:
void Init(u32 tid, const char *tname);
char name[128];
};
} // namespace __memprof
#endif // MEMPROF_DESCRIPTIONS_H