176c0849ed3fb481a56e0e6f3ccef0f93e551122
[WebKit-https.git] / Source / JavaScriptCore / heap / GCSegmentedArray.h
1 /*
2  * Copyright (C) 2014-2016 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include <wtf/DoublyLinkedList.h>
29 #include <wtf/ListDump.h>
30 #include <wtf/PrintStream.h>
31 #include <wtf/Vector.h>
32
33 namespace JSC {
34
35 template <typename T>
36 class GCArraySegment : public DoublyLinkedListNode<GCArraySegment<T>> {
37     friend class WTF::DoublyLinkedListNode<GCArraySegment<T>>;
38 public:
39     GCArraySegment()
40         : DoublyLinkedListNode<GCArraySegment<T>>()
41 #if !ASSERT_DISABLED
42         , m_top(0)
43 #endif
44     {
45     }
46
47     static GCArraySegment* create();
48     static void destroy(GCArraySegment*);
49
50     T* data()
51     {
52         return bitwise_cast<T*>(this + 1);
53     }
54
55     static const size_t blockSize = 4 * KB;
56
57     GCArraySegment* m_prev;
58     GCArraySegment* m_next;
59 #if !ASSERT_DISABLED
60     size_t m_top;
61 #endif
62 };
63
64 template <typename T> class GCSegmentedArrayIterator;
65
66 template <typename T>
67 class GCSegmentedArray {
68     friend class GCSegmentedArrayIterator<T>;
69     friend class GCSegmentedArrayIterator<const T>;
70 public:
71     GCSegmentedArray();
72     ~GCSegmentedArray();
73
74     void append(T);
75
76     bool canRemoveLast();
77     const T removeLast();
78     bool refill();
79     
80     size_t size();
81     bool isEmpty();
82
83     void fillVector(Vector<T>&);
84     void clear();
85
86     typedef GCSegmentedArrayIterator<T> iterator;
87     iterator begin() const { return GCSegmentedArrayIterator<T>(m_segments.head(), m_top); }
88     iterator end() const { return GCSegmentedArrayIterator<T>(); }
89
90 protected:
91     template <size_t size> struct CapacityFromSize {
92         static const size_t value = (size - sizeof(GCArraySegment<T>)) / sizeof(T);
93     };
94
95     void expand();
96     
97     size_t postIncTop();
98     size_t preDecTop();
99     void setTopForFullSegment();
100     void setTopForEmptySegment();
101     size_t top();
102     
103     void validatePrevious();
104
105     DoublyLinkedList<GCArraySegment<T>> m_segments;
106
107     JS_EXPORT_PRIVATE static const size_t s_segmentCapacity = CapacityFromSize<GCArraySegment<T>::blockSize>::value;
108     size_t m_top;
109     size_t m_numberOfSegments;
110 };
111
112 template <typename T>
113 class GCSegmentedArrayIterator {
114     friend class GCSegmentedArray<T>;
115 public:
116     GCSegmentedArrayIterator()
117         : m_currentSegment(0)
118         , m_currentOffset(0)
119     {
120     }
121
122     T& get() { return m_currentSegment->data()[m_currentOffset]; }
123     T& operator*() { return get(); }
124     T& operator->() { return get(); }
125
126     bool operator==(const GCSegmentedArrayIterator& other)
127     {
128         return m_currentSegment == other.m_currentSegment && m_currentOffset == other.m_currentOffset;
129     }
130
131     bool operator!=(const GCSegmentedArrayIterator& other)
132     {
133         return !(*this == other);
134     }
135
136     GCSegmentedArrayIterator& operator++()
137     {
138         ASSERT(m_currentSegment);
139
140         m_currentOffset++;
141
142         if (m_currentOffset >= m_offsetLimit) {
143             m_currentSegment = m_currentSegment->next();
144             m_currentOffset = 0;
145             m_offsetLimit = GCSegmentedArray<T>::s_segmentCapacity;
146         }
147
148         return *this;
149     }
150
151 private:
152     GCSegmentedArrayIterator(GCArraySegment<T>* start, size_t top)
153         : m_currentSegment(start)
154         , m_currentOffset(0)
155         , m_offsetLimit(top)
156     {
157         if (!m_offsetLimit)
158             m_currentSegment = nullptr;
159     }
160
161     GCArraySegment<T>* m_currentSegment;
162     size_t m_currentOffset;
163     size_t m_offsetLimit;
164 };
165
166 } // namespace JSC
167