[Re-landing] Implement a StackTrace utility object that can capture stack traces...
[WebKit-https.git] / Source / JavaScriptCore / tools / StackTrace.cpp
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "StackTrace.h"
28
29 #include <wtf/Assertions.h>
30
31 #if OS(DARWIN) || (OS(LINUX) && defined(__GLIBC__) && !defined(__UCLIBC__))
32 #include <cxxabi.h>
33 #include <dlfcn.h>
34 #include <execinfo.h>
35 #endif
36
37 #if OS(DARWIN) || OS(LINUX)
38 #  if PLATFORM(GTK)
39 #    if defined(__GLIBC__) && !defined(__UCLIBC__)
40 #      define USE_BACKTRACE_SYMBOLS 1
41 #    endif
42 #  else
43 #    define USE_DLADDR 1
44 #  endif
45 #endif
46
47 namespace JSC {
48
49 ALWAYS_INLINE size_t StackTrace::instanceSize(int capacity)
50 {
51     ASSERT(capacity >= 1);
52     return sizeof(StackTrace) + (capacity - 1) * sizeof(void*);
53 }
54
55 StackTrace* StackTrace::captureStackTrace(int maxFrames)
56 {
57     maxFrames = std::max(1, maxFrames);
58     size_t sizeToAllocate = instanceSize(maxFrames);
59     StackTrace* trace = new (NotNull, fastMalloc(sizeToAllocate)) StackTrace();
60
61     static const int framesToSkip = 2;
62     int numberOfFrames = maxFrames + framesToSkip;
63     
64     WTFGetBacktrace(&trace->m_skippedFrame0, &numberOfFrames);
65     ASSERT(numberOfFrames > framesToSkip);
66     trace->m_size = numberOfFrames - framesToSkip;
67     trace->m_capacity = maxFrames;
68
69     return trace;
70 }
71
72 void StackTrace::dump(PrintStream& out) const
73 {
74 #if USE(BACKTRACE_SYMBOLS)
75     char** symbols = backtrace_symbols(m_stack, m_size);
76     if (!symbols)
77         return;
78 #endif
79     
80     for (int i = 0; i < m_size; ++i) {
81         const char* mangledName = 0;
82         char* cxaDemangled = 0;
83 #if USE(BACKTRACE_SYMBOLS)
84         mangledName = symbols[i];
85 #elif USE(DLADDR)
86         Dl_info info;
87         if (dladdr(m_stack[i], &info) && info.dli_sname)
88             mangledName = info.dli_sname;
89         if (mangledName)
90             cxaDemangled = abi::__cxa_demangle(mangledName, 0, 0, 0);
91 #endif
92         const int frameNumber = i + 1;
93         if (mangledName || cxaDemangled)
94             out.printf("%-3d %p %s\n", frameNumber, m_stack[i], cxaDemangled ? cxaDemangled : mangledName);
95         else
96             out.printf("%-3d %p\n", frameNumber, m_stack[i]);
97         free(cxaDemangled);
98     }
99     
100 #if USE(BACKTRACE_SYMBOLS)
101     free(symbols);
102 #endif
103 }
104
105 } // namespace JSC