mirror of
https://github.com/llvm/llvm-project.git
synced 2025-05-02 22:16:06 +00:00
4d5b1de40e
Adds a check to avoid symbolization when printing stack traces if the stack_trace_format flag does not need it. While there is a symbolize flag that can be turned off to skip some of the symbolization, SymbolizePC() still unconditionally looks up the module name and offset. Avoid invoking SymbolizePC() at all if not needed. This is an efficiency improvement when dumping all stack traces as part of the memory profiler in D87120, for large stripped apps where we want to symbolize as a post pass. Differential Revision: https://reviews.llvm.org/D88361
74 lines
3.1 KiB
C++
74 lines
3.1 KiB
C++
//===-- sanitizer_stacktrace_printer.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 shared between sanitizers' run-time libraries.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
#ifndef SANITIZER_STACKTRACE_PRINTER_H
|
|
#define SANITIZER_STACKTRACE_PRINTER_H
|
|
|
|
#include "sanitizer_common.h"
|
|
#include "sanitizer_symbolizer.h"
|
|
|
|
namespace __sanitizer {
|
|
|
|
// Render the contents of "info" structure, which represents the contents of
|
|
// stack frame "frame_no" and appends it to the "buffer". "format" is a
|
|
// string with placeholders, which is copied to the output with
|
|
// placeholders substituted with the contents of "info". For example,
|
|
// format string
|
|
// " frame %n: function %F at %S"
|
|
// will be turned into
|
|
// " frame 10: function foo::bar() at my/file.cc:10"
|
|
// You may additionally pass "strip_path_prefix" to strip prefixes of paths to
|
|
// source files and modules, and "strip_func_prefix" to strip prefixes of
|
|
// function names.
|
|
// Here's the full list of available placeholders:
|
|
// %% - represents a '%' character;
|
|
// %n - frame number (copy of frame_no);
|
|
// %p - PC in hex format;
|
|
// %m - path to module (binary or shared object);
|
|
// %o - offset in the module in hex format;
|
|
// %f - function name;
|
|
// %q - offset in the function in hex format (*if available*);
|
|
// %s - path to source file;
|
|
// %l - line in the source file;
|
|
// %c - column in the source file;
|
|
// %F - if function is known to be <foo>, prints "in <foo>", possibly
|
|
// followed by the offset in this function, but only if source file
|
|
// is unknown;
|
|
// %S - prints file/line/column information;
|
|
// %L - prints location information: file/line/column, if it is known, or
|
|
// module+offset if it is known, or (<unknown module>) string.
|
|
// %M - prints module basename and offset, if it is known, or PC.
|
|
void RenderFrame(InternalScopedString *buffer, const char *format, int frame_no,
|
|
uptr address, const AddressInfo *info, bool vs_style,
|
|
const char *strip_path_prefix = "",
|
|
const char *strip_func_prefix = "");
|
|
|
|
bool RenderNeedsSymbolization(const char *format);
|
|
|
|
void RenderSourceLocation(InternalScopedString *buffer, const char *file,
|
|
int line, int column, bool vs_style,
|
|
const char *strip_path_prefix);
|
|
|
|
void RenderModuleLocation(InternalScopedString *buffer, const char *module,
|
|
uptr offset, ModuleArch arch,
|
|
const char *strip_path_prefix);
|
|
|
|
// Same as RenderFrame, but for data section (global variables).
|
|
// Accepts %s, %l from above.
|
|
// Also accepts:
|
|
// %g - name of the global variable.
|
|
void RenderData(InternalScopedString *buffer, const char *format,
|
|
const DataInfo *DI, const char *strip_path_prefix = "");
|
|
|
|
} // namespace __sanitizer
|
|
|
|
#endif // SANITIZER_STACKTRACE_PRINTER_H
|