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