1 //===-- sanitizer_symbolizer_internal.h -------------------------*- C++ -*-===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 // Header for internal classes and functions to be used by implementations of
12 //===----------------------------------------------------------------------===//
13 #ifndef SANITIZER_SYMBOLIZER_INTERNAL_H
14 #define SANITIZER_SYMBOLIZER_INTERNAL_H
16 #include "sanitizer_symbolizer.h"
17 #include "sanitizer_file.h"
18 #include "sanitizer_vector.h"
20 namespace __sanitizer {
22 // Parsing helpers, 'str' is searched for delimiter(s) and a string or uptr
23 // is extracted. When extracting a string, a newly allocated (using
24 // InternalAlloc) and null-terminataed buffer is returned. They return a pointer
25 // to the next characted after the found delimiter.
26 const char *ExtractToken(const char *str, const char *delims, char **result);
27 const char *ExtractInt(const char *str, const char *delims, int *result);
28 const char *ExtractUptr(const char *str, const char *delims, uptr *result);
29 const char *ExtractTokenUpToDelimiter(const char *str, const char *delimiter,
32 const char *DemangleSwiftAndCXX(const char *name);
34 // SymbolizerTool is an interface that is implemented by individual "tools"
35 // that can perform symbolication (external llvm-symbolizer, libbacktrace,
36 // Windows DbgHelp symbolizer, etc.).
37 class SymbolizerTool {
39 // The main |Symbolizer| class implements a "fallback chain" of symbolizer
40 // tools. In a request to symbolize an address, if one tool returns false,
41 // the next tool in the chain will be tried.
44 SymbolizerTool() : next(nullptr) { }
46 // Can't declare pure virtual functions in sanitizer runtimes:
47 // __cxa_pure_virtual might be unavailable.
49 // The |stack| parameter is inout. It is pre-filled with the address,
50 // module base and module offset values and is to be used to construct
51 // other stack frames.
52 virtual bool SymbolizePC(uptr addr, SymbolizedStack *stack) {
56 // The |info| parameter is inout. It is pre-filled with the module base
57 // and module offset values.
58 virtual bool SymbolizeData(uptr addr, DataInfo *info) {
62 virtual bool SymbolizeFrame(uptr addr, FrameInfo *info) {
66 virtual void Flush() {}
68 // Return nullptr to fallback to the default platform-specific demangler.
69 virtual const char *Demangle(const char *name) {
74 // SymbolizerProcess encapsulates communication between the tool and
75 // external symbolizer program, running in a different subprocess.
76 // SymbolizerProcess may not be used from two threads simultaneously.
77 class SymbolizerProcess {
79 explicit SymbolizerProcess(const char *path, bool use_forkpty = false);
80 const char *SendCommand(const char *command);
83 virtual bool ReachedEndOfOutput(const char *buffer, uptr length) const {
87 /// The maximum number of arguments required to invoke a tool process.
88 enum { kArgVMax = 6 };
90 /// Fill in an argv array to invoke the child process.
91 virtual void GetArgV(const char *path_to_binary,
92 const char *(&argv)[kArgVMax]) const {
96 virtual bool ReadFromSymbolizer(char *buffer, uptr max_length);
100 const char *SendCommandImpl(const char *command);
101 bool WriteToSymbolizer(const char *buffer, uptr length);
102 bool StartSymbolizerSubprocess();
108 static const uptr kBufferSize = 16 * 1024;
109 char buffer_[kBufferSize];
111 static const uptr kMaxTimesRestarted = 5;
112 static const int kSymbolizerStartupTimeMillis = 10;
113 uptr times_restarted_;
114 bool failed_to_start_;
115 bool reported_invalid_path_;
119 class LLVMSymbolizerProcess;
121 // This tool invokes llvm-symbolizer in a subprocess. It should be as portable
122 // as the llvm-symbolizer tool is.
123 class LLVMSymbolizer : public SymbolizerTool {
125 explicit LLVMSymbolizer(const char *path, LowLevelAllocator *allocator);
127 bool SymbolizePC(uptr addr, SymbolizedStack *stack) override;
128 bool SymbolizeData(uptr addr, DataInfo *info) override;
129 bool SymbolizeFrame(uptr addr, FrameInfo *info) override;
132 const char *FormatAndSendCommand(const char *command_prefix,
133 const char *module_name, uptr module_offset,
136 LLVMSymbolizerProcess *symbolizer_process_;
137 static const uptr kBufferSize = 16 * 1024;
138 char buffer_[kBufferSize];
141 // Parses one or more two-line strings in the following format:
143 // <file_name>:<line_number>[:<column_number>]
144 // Used by LLVMSymbolizer, Addr2LinePool and InternalSymbolizer, since all of
145 // them use the same output format. Returns true if any useful debug
146 // information was found.
147 void ParseSymbolizePCOutput(const char *str, SymbolizedStack *res);
149 // Parses a two-line string in the following format:
151 // <start_address> <size>
152 // Used by LLVMSymbolizer and InternalSymbolizer.
153 void ParseSymbolizeDataOutput(const char *str, DataInfo *info);
155 } // namespace __sanitizer
157 #endif // SANITIZER_SYMBOLIZER_INTERNAL_H