[Re-landing] Implement a StackTrace utility object that can capture stack traces...
[WebKit-https.git] / Source / JavaScriptCore / tools / StackTrace.h
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 #pragma once
27
28 #include <wtf/PrintStream.h>
29
30 namespace JSC {
31
32 class StackTrace {
33     WTF_MAKE_FAST_ALLOCATED;
34 public:
35     static StackTrace* captureStackTrace(int maxFrames);
36
37     int size() const { return m_size; }
38
39     void dump(PrintStream&) const;
40
41 private:
42     inline static size_t instanceSize(int capacity);
43
44     StackTrace()
45         : m_size(0)
46     { }
47
48     // We structure the top fields this way because the underlying stack capture
49     // facility will capture from the top of the stack, and we'll need to skip the
50     // top 2 frame which is of no interest. Setting up the fields layout this way
51     // allows us to capture the stack in place and minimize space wastage.
52     union {
53         struct {
54             int m_size;
55             int m_capacity;
56         };
57         struct {
58             void* m_skippedFrame0;
59             void* m_skippedFrame1;
60         };
61     };
62     void* m_stack[1];
63 };
64
65 } // namespace JSC