GC constraint solving should be parallel
[WebKit-https.git] / Source / WTF / wtf / StackShot.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/Assertions.h>
29
30 namespace WTF {
31
32 class StackShot {
33 public:
34     StackShot() { }
35     
36     ALWAYS_INLINE StackShot(size_t size)
37         : m_size(size)
38     {
39         if (size) {
40             m_array = std::make_unique<void*[]>(size);
41             int intSize = size;
42             WTFGetBacktrace(m_array.get(), &intSize);
43             RELEASE_ASSERT(static_cast<size_t>(intSize) <= size);
44             m_size = intSize;
45             if (!m_size)
46                 m_array = nullptr;
47         }
48     }
49     
50     StackShot(WTF::HashTableDeletedValueType)
51         : m_array(deletedValueArray())
52         , m_size(0)
53     {
54     }
55     
56     StackShot& operator=(const StackShot& other)
57     {
58         std::unique_ptr<void*[]> newArray = std::make_unique<void*[]>(other.m_size);
59         for (size_t i = other.m_size; i--;)
60             newArray[i] = other.m_array[i];
61         m_size = other.m_size;
62         m_array = WTFMove(newArray);
63         return *this;
64     }
65     
66     StackShot(const StackShot& other)
67     {
68         *this = other;
69     }
70     
71     void** array() const { return m_array.get(); }
72     size_t size() const { return m_size; }
73     
74     explicit operator bool() const { return !!m_array; }
75     
76     bool operator==(const StackShot& other) const
77     {
78         if (m_size != other.m_size)
79             return false;
80         
81         for (size_t i = m_size; i--;) {
82             if (m_array[i] != other.m_array[i])
83                 return false;
84         }
85         
86         return true;
87     }
88     
89     unsigned hash() const
90     {
91         unsigned result = m_size;
92         
93         for (size_t i = m_size; i--;)
94             result ^= PtrHash<void*>::hash(m_array[i]);
95         
96         return result;
97     }
98     
99     bool isHashTableDeletedValue() const
100     {
101         return !m_size && m_array.get() == deletedValueArray();
102     }
103     
104     // Make Spectrum<> happy.
105     bool operator>(const StackShot&) const { return false; }
106     
107 private:
108     static void** deletedValueArray() { return bitwise_cast<void**>(static_cast<uintptr_t>(1)); }
109     
110     std::unique_ptr<void*[]> m_array;
111     size_t m_size { 0 };
112 };
113
114 struct StackShotHash {
115     static unsigned hash(const StackShot& shot) { return shot.hash(); }
116     static bool equal(const StackShot& a, const StackShot& b) { return a == b; }
117     static const bool safeToCompareToEmptyOrDeleted = false;
118 };
119
120 template<typename T> struct DefaultHash;
121 template<> struct DefaultHash<StackShot> {
122     typedef StackShotHash Hash;
123 };
124
125 template<typename T> struct HashTraits;
126 template<> struct HashTraits<StackShot> : SimpleClassHashTraits<StackShot> { };
127
128 } // namespace WTF
129