Release build debugging should be easier
[WebKit-https.git] / Source / JavaScriptCore / bytecode / DFGExitProfile.h
1 /*
2  * Copyright (C) 2011 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 #ifndef DFGExitProfile_h
27 #define DFGExitProfile_h
28
29 #include <wtf/HashSet.h>
30 #include <wtf/OwnPtr.h>
31 #include <wtf/Vector.h>
32
33 namespace JSC { namespace DFG {
34
35 enum ExitKind {
36     ExitKindUnset,
37     BadType, // We exited because a type prediction was wrong.
38     BadCache, // We exited because an inline cache was wrong.
39     Overflow, // We exited because of overflow.
40     NegativeZero, // We exited because we encountered negative zero.
41     Uncountable, // We exited for none of the above reasons, and we should not count it. Most uses of this should be viewed as a FIXME.
42 };
43
44 inline const char* exitKindToString(ExitKind kind)
45 {
46     switch (kind) {
47     case ExitKindUnset:
48         return "Unset";
49     case BadType:
50         return "BadType";
51     case BadCache:
52         return "BadCache";
53     case Overflow:
54         return "Overflow";
55     case NegativeZero:
56         return "NegativeZero";
57     default:
58         return "Unknown";
59     }
60 }
61
62 inline bool exitKindIsCountable(ExitKind kind)
63 {
64     switch (kind) {
65     case ExitKindUnset:
66         ASSERT_NOT_REACHED();
67     case BadType:
68     case Uncountable:
69         return false;
70     default:
71         return true;
72     }
73 }
74
75 class FrequentExitSite {
76 public:
77     FrequentExitSite()
78         : m_bytecodeOffset(0) // 0 = empty value
79         , m_kind(ExitKindUnset)
80     {
81     }
82     
83     FrequentExitSite(WTF::HashTableDeletedValueType)
84         : m_bytecodeOffset(1) // 1 = deleted value
85         , m_kind(ExitKindUnset)
86     {
87     }
88     
89     explicit FrequentExitSite(unsigned bytecodeOffset, ExitKind kind)
90         : m_bytecodeOffset(bytecodeOffset)
91         , m_kind(kind)
92     {
93         ASSERT(exitKindIsCountable(kind));
94     }
95     
96     bool operator!() const
97     {
98         return m_kind == ExitKindUnset;
99     }
100     
101     bool operator==(const FrequentExitSite& other) const
102     {
103         return m_bytecodeOffset == other.m_bytecodeOffset
104             && m_kind == other.m_kind;
105     }
106     
107     unsigned hash() const
108     {
109         return WTF::intHash(m_bytecodeOffset) + m_kind;
110     }
111     
112     unsigned bytecodeOffset() const { return m_bytecodeOffset; }
113     ExitKind kind() const { return m_kind; }
114
115     bool isHashTableDeletedValue() const
116     {
117         return m_kind == ExitKindUnset && m_bytecodeOffset;
118     }
119
120 private:
121     unsigned m_bytecodeOffset;
122     ExitKind m_kind;
123 };
124
125 struct FrequentExitSiteHash {
126     static unsigned hash(const FrequentExitSite& key) { return key.hash(); }
127     static bool equal(const FrequentExitSite& a, const FrequentExitSite& b) { return a == b; }
128     static const bool safeToCompareToEmptyOrDeleted = true;
129 };
130
131 } } // namespace JSC::DFG
132
133 namespace WTF {
134
135 template<typename T> struct DefaultHash;
136 template<> struct DefaultHash<JSC::DFG::FrequentExitSite> {
137     typedef JSC::DFG::FrequentExitSiteHash Hash;
138 };
139
140 template<typename T> struct HashTraits;
141 template<> struct HashTraits<JSC::DFG::FrequentExitSite> : SimpleClassHashTraits<JSC::DFG::FrequentExitSite> { };
142
143 } // namespace WTF
144
145 namespace JSC { namespace DFG {
146
147 class QueryableExitProfile;
148
149 class ExitProfile {
150 public:
151     ExitProfile();
152     ~ExitProfile();
153     
154     // Add a new frequent exit site. Return true if this is a new one, or false
155     // if we already knew about it. This is an O(n) operation, because it errs
156     // on the side of keeping the data structure compact. Also, this will only
157     // be called a fixed number of times per recompilation. Recompilation is
158     // rare to begin with, and implies doing O(n) operations on the CodeBlock
159     // anyway.
160     bool add(const FrequentExitSite&);
161     
162 private:
163     friend class QueryableExitProfile;
164     
165     OwnPtr<Vector<FrequentExitSite> > m_frequentExitSites;
166 };
167
168 class QueryableExitProfile {
169 public:
170     explicit QueryableExitProfile(const ExitProfile&);
171     ~QueryableExitProfile();
172     
173     bool hasExitSite(const FrequentExitSite& site) const
174     {
175         return m_frequentExitSites.find(site) != m_frequentExitSites.end();
176     }
177     
178     bool hasExitSite(unsigned bytecodeIndex, ExitKind kind) const
179     {
180         return hasExitSite(FrequentExitSite(bytecodeIndex, kind));
181     }
182 private:
183     HashSet<FrequentExitSite> m_frequentExitSites;
184 };
185
186 } } // namespace JSC::DFG
187
188 #endif // DFGExitProfile_h