FTL should lower its abstract heaps to B3 heap ranges
[WebKit-https.git] / Source / JavaScriptCore / b3 / B3HeapRange.h
1 /*
2  * Copyright (C) 2015 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 B3HeapRange_h
27 #define B3HeapRange_h
28
29 #if ENABLE(B3_JIT)
30
31 #include <limits.h>
32 #include <wtf/MathExtras.h>
33 #include <wtf/PrintStream.h>
34
35 namespace JSC { namespace B3 {
36
37 // Alias analysis in B3 is done by checking if two integer ranges overlap. This is powerful enough
38 // to be used for TBAA-style alias analysis used by the DFG, FTL, and LLVM: you just turn each node
39 // in the tree of abstract heaps into a pre/post range.
40 //
41 // Note that the 'begin' is inclusive, while the 'end' is exclusive. These two ranges are non-
42 // overlapping:
43 //
44 //     rangeA = 0...8
45 //     rangeB = 8...16
46
47 class HeapRange {
48 public:
49     typedef unsigned Type;
50     
51     HeapRange()
52         : m_begin(0)
53         , m_end(0)
54     {
55     }
56
57     explicit HeapRange(unsigned value)
58         : m_begin(value)
59         , m_end(value + 1)
60     {
61         ASSERT(m_end >= m_begin);
62     }
63
64     HeapRange(unsigned begin, unsigned end)
65         : m_begin(begin)
66         , m_end(end)
67     {
68         ASSERT(m_end >= m_begin);
69         if (m_begin == m_end) {
70             // Canonicalize empty ranges.
71             m_begin = 0;
72             m_end = 0;
73         }
74     }
75
76     static HeapRange top()
77     {
78         return HeapRange(0, UINT_MAX);
79     }
80
81     bool operator==(const HeapRange& other) const
82     {
83         return m_begin == other.m_begin
84             && m_end == other.m_end;
85     }
86
87     bool operator!=(const HeapRange& other) const
88     {
89         return !(*this == other);
90     }
91     
92     explicit operator bool() const { return m_begin != m_end; }
93
94     unsigned begin() const { return m_begin; }
95     unsigned end() const { return m_end; }
96
97     bool overlaps(const HeapRange& other) const
98     {
99         return WTF::rangesOverlap(m_begin, m_end, other.m_begin, other.m_end);
100     }
101
102     void dump(PrintStream& out) const;
103
104 private:
105     unsigned m_begin;
106     unsigned m_end;
107 };
108
109 } } // namespace JSC::B3
110
111 #endif // ENABLE(B3_JIT)
112
113 #endif // B3HeapRange_h
114