fourthTier: Count external memory usage towards heap footprint
[WebKit-https.git] / Source / JavaScriptCore / runtime / JSString.cpp
1 /*
2  *  Copyright (C) 1999-2002 Harri Porten (porten@kde.org)
3  *  Copyright (C) 2001 Peter Kelly (pmk@post.com)
4  *  Copyright (C) 2004, 2007, 2008 Apple Inc. All rights reserved.
5  *
6  *  This library is free software; you can redistribute it and/or
7  *  modify it under the terms of the GNU Library General Public
8  *  License as published by the Free Software Foundation; either
9  *  version 2 of the License, or (at your option) any later version.
10  *
11  *  This library is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  *  Library General Public License for more details.
15  *
16  *  You should have received a copy of the GNU Library General Public License
17  *  along with this library; see the file COPYING.LIB.  If not, write to
18  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  *  Boston, MA 02110-1301, USA.
20  *
21  */
22
23 #include "config.h"
24 #include "JSString.h"
25
26 #include "JSGlobalObject.h"
27 #include "JSGlobalObjectFunctions.h"
28 #include "JSObject.h"
29 #include "Operations.h"
30 #include "StringObject.h"
31 #include "StringPrototype.h"
32
33 namespace JSC {
34     
35 static const unsigned substringFromRopeCutoff = 4;
36
37 const ClassInfo JSString::s_info = { "string", 0, 0, 0, CREATE_METHOD_TABLE(JSString) };
38
39 void JSRopeString::RopeBuilder::expand()
40 {
41     ASSERT(m_index == JSRopeString::s_maxInternalRopeLength);
42     JSString* jsString = m_jsString;
43     m_jsString = jsStringBuilder(&m_vm);
44     m_index = 0;
45     append(jsString);
46 }
47
48 void JSString::destroy(JSCell* cell)
49 {
50     JSString* thisObject = static_cast<JSString*>(cell);
51     thisObject->JSString::~JSString();
52 }
53
54 void JSString::visitChildren(JSCell* cell, SlotVisitor& visitor)
55 {
56     JSString* thisObject = jsCast<JSString*>(cell);
57     Base::visitChildren(thisObject, visitor);
58     
59     MARK_LOG_MESSAGE1("[%u]: ", thisObject->length());
60
61 #if ENABLE(OBJECT_MARK_LOGGING)
62     if (!thisObject->isRope()) {
63         WTF::StringImpl* ourImpl = thisObject->m_value.impl();
64         if (ourImpl->is8Bit())
65             MARK_LOG_MESSAGE1("[8 %p]", ourImpl->characters8());
66         else
67             MARK_LOG_MESSAGE1("[16 %p]", ourImpl->characters16());
68     } else
69         MARK_LOG_MESSAGE0("[rope]: ");
70 #endif
71
72     if (thisObject->isRope())
73         static_cast<JSRopeString*>(thisObject)->visitFibers(visitor);
74     else {
75         StringImpl* impl = thisObject->m_value.impl();
76         ASSERT(impl);
77         visitor.reportExtraMemoryUsage(impl->costDuringGC());
78     }
79 }
80
81 void JSRopeString::visitFibers(SlotVisitor& visitor)
82 {
83     for (size_t i = 0; i < s_maxInternalRopeLength && m_fibers[i]; ++i)
84         visitor.append(&m_fibers[i]);
85 }
86
87 void JSRopeString::resolveRope(ExecState* exec) const
88 {
89     ASSERT(isRope());
90
91     if (is8Bit()) {
92         LChar* buffer;
93         if (RefPtr<StringImpl> newImpl = StringImpl::tryCreateUninitialized(m_length, buffer)) {
94             Heap::heap(this)->reportExtraMemoryCost(newImpl->cost());
95             m_value = newImpl.release();
96         } else {
97             outOfMemory(exec);
98             return;
99         }
100
101         for (size_t i = 0; i < s_maxInternalRopeLength && m_fibers[i]; ++i) {
102             if (m_fibers[i]->isRope())
103                 return resolveRopeSlowCase8(buffer);
104         }
105
106         LChar* position = buffer;
107         for (size_t i = 0; i < s_maxInternalRopeLength && m_fibers[i]; ++i) {
108             StringImpl* string = m_fibers[i]->m_value.impl();
109             unsigned length = string->length();
110             StringImpl::copyChars(position, string->characters8(), length);
111             position += length;
112             m_fibers[i].clear();
113         }
114         ASSERT((buffer + m_length) == position);
115         ASSERT(!isRope());
116
117         return;
118     }
119
120     UChar* buffer;
121     if (RefPtr<StringImpl> newImpl = StringImpl::tryCreateUninitialized(m_length, buffer)) {
122         Heap::heap(this)->reportExtraMemoryCost(newImpl->cost());
123         m_value = newImpl.release();
124     } else {
125         outOfMemory(exec);
126         return;
127     }
128
129     for (size_t i = 0; i < s_maxInternalRopeLength && m_fibers[i]; ++i) {
130         if (m_fibers[i]->isRope())
131             return resolveRopeSlowCase(buffer);
132     }
133
134     UChar* position = buffer;
135     for (size_t i = 0; i < s_maxInternalRopeLength && m_fibers[i]; ++i) {
136         StringImpl* string = m_fibers[i]->m_value.impl();
137         unsigned length = string->length();
138         if (string->is8Bit())
139             StringImpl::copyChars(position, string->characters8(), length);
140         else
141             StringImpl::copyChars(position, string->characters16(), length);
142         position += length;
143         m_fibers[i].clear();
144     }
145     ASSERT((buffer + m_length) == position);
146     ASSERT(!isRope());
147 }
148
149 // Overview: These functions convert a JSString from holding a string in rope form
150 // down to a simple String representation. It does so by building up the string
151 // backwards, since we want to avoid recursion, we expect that the tree structure
152 // representing the rope is likely imbalanced with more nodes down the left side
153 // (since appending to the string is likely more common) - and as such resolving
154 // in this fashion should minimize work queue size.  (If we built the queue forwards
155 // we would likely have to place all of the constituent StringImpls into the
156 // Vector before performing any concatenation, but by working backwards we likely
157 // only fill the queue with the number of substrings at any given level in a
158 // rope-of-ropes.)    
159 void JSRopeString::resolveRopeSlowCase8(LChar* buffer) const
160 {
161     LChar* position = buffer + m_length; // We will be working backwards over the rope.
162     Vector<JSString*, 32, UnsafeVectorOverflow> workQueue; // Putting strings into a Vector is only OK because there are no GC points in this method.
163     
164     for (size_t i = 0; i < s_maxInternalRopeLength && m_fibers[i]; ++i) {
165         workQueue.append(m_fibers[i].get());
166         // Clearing here works only because there are no GC points in this method.
167         m_fibers[i].clear();
168     }
169
170     while (!workQueue.isEmpty()) {
171         JSString* currentFiber = workQueue.last();
172         workQueue.removeLast();
173
174         if (currentFiber->isRope()) {
175             JSRopeString* currentFiberAsRope = static_cast<JSRopeString*>(currentFiber);
176             for (size_t i = 0; i < s_maxInternalRopeLength && currentFiberAsRope->m_fibers[i]; ++i)
177                 workQueue.append(currentFiberAsRope->m_fibers[i].get());
178             continue;
179         }
180
181         StringImpl* string = static_cast<StringImpl*>(currentFiber->m_value.impl());
182         unsigned length = string->length();
183         position -= length;
184         StringImpl::copyChars(position, string->characters8(), length);
185     }
186
187     ASSERT(buffer == position);
188     ASSERT(!isRope());
189 }
190
191 void JSRopeString::resolveRopeSlowCase(UChar* buffer) const
192 {
193     UChar* position = buffer + m_length; // We will be working backwards over the rope.
194     Vector<JSString*, 32, UnsafeVectorOverflow> workQueue; // These strings are kept alive by the parent rope, so using a Vector is OK.
195
196     for (size_t i = 0; i < s_maxInternalRopeLength && m_fibers[i]; ++i)
197         workQueue.append(m_fibers[i].get());
198
199     while (!workQueue.isEmpty()) {
200         JSString* currentFiber = workQueue.last();
201         workQueue.removeLast();
202
203         if (currentFiber->isRope()) {
204             JSRopeString* currentFiberAsRope = static_cast<JSRopeString*>(currentFiber);
205             for (size_t i = 0; i < s_maxInternalRopeLength && currentFiberAsRope->m_fibers[i]; ++i)
206                 workQueue.append(currentFiberAsRope->m_fibers[i].get());
207             continue;
208         }
209
210         StringImpl* string = static_cast<StringImpl*>(currentFiber->m_value.impl());
211         unsigned length = string->length();
212         position -= length;
213         if (string->is8Bit())
214             StringImpl::copyChars(position, string->characters8(), length);
215         else
216             StringImpl::copyChars(position, string->characters16(), length);
217     }
218
219     ASSERT(buffer == position);
220     ASSERT(!isRope());
221 }
222
223 void JSRopeString::outOfMemory(ExecState* exec) const
224 {
225     for (size_t i = 0; i < s_maxInternalRopeLength && m_fibers[i]; ++i)
226         m_fibers[i].clear();
227     ASSERT(isRope());
228     ASSERT(m_value.isNull());
229     if (exec)
230         throwOutOfMemoryError(exec);
231 }
232
233 JSString* JSRopeString::getIndexSlowCase(ExecState* exec, unsigned i)
234 {
235     ASSERT(isRope());
236     resolveRope(exec);
237     // Return a safe no-value result, this should never be used, since the excetion will be thrown.
238     if (exec->exception())
239         return jsEmptyString(exec);
240     ASSERT(!isRope());
241     RELEASE_ASSERT(i < m_value.length());
242     return jsSingleCharacterSubstring(exec, m_value, i);
243 }
244
245 JSValue JSString::toPrimitive(ExecState*, PreferredPrimitiveType) const
246 {
247     return const_cast<JSString*>(this);
248 }
249
250 bool JSString::getPrimitiveNumber(ExecState* exec, double& number, JSValue& result) const
251 {
252     result = this;
253     number = jsToNumber(value(exec));
254     return false;
255 }
256
257 bool JSString::toBoolean() const
258 {
259     return m_length;
260 }
261
262 double JSString::toNumber(ExecState* exec) const
263 {
264     return jsToNumber(value(exec));
265 }
266
267 inline StringObject* StringObject::create(ExecState* exec, JSGlobalObject* globalObject, JSString* string)
268 {
269     StringObject* object = new (NotNull, allocateCell<StringObject>(*exec->heap())) StringObject(exec->vm(), globalObject->stringObjectStructure());
270     object->finishCreation(exec->vm(), string);
271     return object;
272 }
273
274 JSObject* JSString::toObject(ExecState* exec, JSGlobalObject* globalObject) const
275 {
276     return StringObject::create(exec, globalObject, const_cast<JSString*>(this));
277 }
278
279 JSValue JSString::toThis(JSCell* cell, ExecState* exec, ECMAMode ecmaMode)
280 {
281     if (ecmaMode == StrictMode)
282         return cell;
283     return StringObject::create(exec, exec->lexicalGlobalObject(), jsCast<JSString*>(cell));
284 }
285
286 bool JSString::getOwnPropertySlot(JSCell* cell, ExecState* exec, PropertyName propertyName, PropertySlot& slot)
287 {
288     JSString* thisObject = jsCast<JSString*>(cell);
289     // The semantics here are really getPropertySlot, not getOwnPropertySlot.
290     // This function should only be called by JSValue::get.
291     if (thisObject->getStringPropertySlot(exec, propertyName, slot))
292         return true;
293     slot.setBase(thisObject);
294     JSObject* object;
295     for (JSValue prototype = exec->lexicalGlobalObject()->stringPrototype(); !prototype.isNull(); prototype = object->prototype()) {
296         object = asObject(prototype);
297         if (object->methodTable()->getOwnPropertySlot(object, exec, propertyName, slot))
298             return true;
299     }
300     slot.setUndefined();
301     return true;
302 }
303
304 bool JSString::getStringPropertyDescriptor(ExecState* exec, PropertyName propertyName, PropertyDescriptor& descriptor)
305 {
306     if (propertyName == exec->propertyNames().length) {
307         descriptor.setDescriptor(jsNumber(m_length), DontEnum | DontDelete | ReadOnly);
308         return true;
309     }
310     
311     unsigned i = propertyName.asIndex();
312     if (i < m_length) {
313         ASSERT(i != PropertyName::NotAnIndex); // No need for an explicit check, the above test would always fail!
314         descriptor.setDescriptor(getIndex(exec, i), DontDelete | ReadOnly);
315         return true;
316     }
317     
318     return false;
319 }
320
321 bool JSString::getOwnPropertySlotByIndex(JSCell* cell, ExecState* exec, unsigned propertyName, PropertySlot& slot)
322 {
323     JSString* thisObject = jsCast<JSString*>(cell);
324     // The semantics here are really getPropertySlot, not getOwnPropertySlot.
325     // This function should only be called by JSValue::get.
326     if (thisObject->getStringPropertySlot(exec, propertyName, slot))
327         return true;
328     return JSString::getOwnPropertySlot(thisObject, exec, Identifier::from(exec, propertyName), slot);
329 }
330
331 } // namespace JSC