70f3897b0a
Summary: This commit introduces function __sanitizer::RenderFrame() that allows to render the contents of AddressInfo (essentially, symbolized stack frame) using the custom format string. This function can be used to implement stack frame formatting for both ThreadSanitizer and generic StackTrace::Print(), used in another places. This paves the way towards allowing user to control the format of stack frames, obtaining them in any format he desires, and/or enforcing the consistent output from all sanitizers. Test Plan: compiler-rt test suite Reviewers: kcc Reviewed By: kcc Subscribers: llvm-commits Differential Revision: http://reviews.llvm.org/D6140 llvm-svn: 221409
63 lines
2.7 KiB
C++
63 lines
2.7 KiB
C++
//===-- sanitizer_stacktrace_printer.h --------------------------*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// 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,
|
|
const AddressInfo &info, const char *strip_path_prefix = "",
|
|
const char *strip_func_prefix = "");
|
|
|
|
void RenderSourceLocation(InternalScopedString *buffer, const char *file,
|
|
int line, int column, const char *strip_path_prefix);
|
|
|
|
void RenderModuleLocation(InternalScopedString *buffer, const char *module,
|
|
uptr offset, const char *strip_path_prefix);
|
|
|
|
} // namespace __sanitizer
|
|
|
|
#endif // SANITIZER_STACKTRACE_PRINTER_H
|