Stop inlining of list reallocation in virtual frames.
[platform/upstream/v8.git] / src / list.h
1 // Copyright 2006-2009 the V8 project authors. All rights reserved.
2 // Redistribution and use in source and binary forms, with or without
3 // modification, are permitted provided that the following conditions are
4 // met:
5 //
6 //     * Redistributions of source code must retain the above copyright
7 //       notice, this list of conditions and the following disclaimer.
8 //     * Redistributions in binary form must reproduce the above
9 //       copyright notice, this list of conditions and the following
10 //       disclaimer in the documentation and/or other materials provided
11 //       with the distribution.
12 //     * Neither the name of Google Inc. nor the names of its
13 //       contributors may be used to endorse or promote products derived
14 //       from this software without specific prior written permission.
15 //
16 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
28 #ifndef V8_LIST_H_
29 #define V8_LIST_H_
30
31 namespace v8 { namespace internal {
32
33
34 // ----------------------------------------------------------------------------
35 // The list is a template for very light-weight lists. We are not
36 // using the STL because we want full control over space and speed of
37 // the code. This implementation is based on code by Robert Griesemer
38 // and Rob Pike.
39 //
40 // The list is parameterized by the type of its elements (T) and by an
41 // allocation policy (P). The policy is used for allocating lists in
42 // the C free store or the zone; see zone.h.
43
44 // Forward defined as
45 // template <typename T, class P = FreeStoreAllocationPolicy> class List;
46 template <typename T, class P>
47 class List {
48  public:
49
50   INLINE(explicit List(int capacity)) { Initialize(capacity); }
51   INLINE(~List()) { DeleteData(data_); }
52
53   INLINE(void* operator new(size_t size)) { return P::New(size); }
54   INLINE(void operator delete(void* p, size_t)) { return P::Delete(p); }
55
56   // Returns a reference to the element at index i.  This reference is
57   // not safe to use after operations that can change the list's
58   // backing store (eg, Add).
59   inline T& operator[](int i) const  {
60     ASSERT(0 <= i && i < length_);
61     return data_[i];
62   }
63   inline T& at(int i) const  { return operator[](i); }
64   inline T& last() const {
65     return at(length_ - 1);
66   }
67
68   INLINE(bool is_empty() const) { return length_ == 0; }
69   INLINE(int length() const) { return length_; }
70   INLINE(int capacity() const) { return capacity_; }
71
72   Vector<T> ToVector() { return Vector<T>(data_, length_); }
73
74   Vector<const T> ToConstVector() { return Vector<const T>(data_, length_); }
75
76   // Adds a copy of the given 'element' to the end of the list,
77   // expanding the list if necessary.
78   void Add(const T& element);
79
80   // Added 'count' elements with the value 'value' and returns a
81   // vector that allows access to the elements.  The vector is valid
82   // until the next change is made to this list.
83   Vector<T> AddBlock(T value, int count);
84
85   // Removes the i'th element without deleting it even if T is a
86   // pointer type; moves all elements above i "down". Returns the
87   // removed element.  This function's complexity is linear in the
88   // size of the list.
89   T Remove(int i);
90
91   // Removes the last element without deleting it even if T is a
92   // pointer type. Returns the removed element.
93   INLINE(T RemoveLast()) { return Remove(length_ - 1); }
94
95   // Clears the list by setting the length to zero. Even if T is a
96   // pointer type, clearing the list doesn't delete the entries.
97   INLINE(void Clear());
98
99   // Drops all but the first 'pos' elements from the list.
100   INLINE(void Rewind(int pos));
101
102   bool Contains(const T& elm);
103
104   // Iterate through all list entries, starting at index 0.
105   void Iterate(void (*callback)(T* x));
106
107   // Sort all list entries (using QuickSort)
108   void Sort(int (*cmp)(const T* x, const T* y));
109   void Sort();
110
111   INLINE(void Initialize(int capacity));
112
113  private:
114   T* data_;
115   int capacity_;
116   int length_;
117
118   INLINE(T* NewData(int n))  { return static_cast<T*>(P::New(n * sizeof(T))); }
119   INLINE(void DeleteData(T* data))  { P::Delete(data); }
120
121   // Increase the capacity of a full list, and add an element.
122   // List must be full already.
123   void ResizeAdd(const T& element);
124
125   // Inlined implementation of ResizeAdd, shared by inlined and
126   // non-inlined versions of ResizeAdd.
127   void ResizeAddInternal(const T& element);
128
129   DISALLOW_COPY_AND_ASSIGN(List);
130 };
131
132 class FrameElement;
133
134 // Add() is inlined, ResizeAdd() called by Add() is inlined except for
135 // Lists of FrameElements, and ResizeAddInternal() is inlined in ResizeAdd().
136 template <>
137 void List<FrameElement,
138           FreeStoreAllocationPolicy>::ResizeAdd(const FrameElement& element);
139
140 } }  // namespace v8::internal
141
142 #endif  // V8_LIST_H_