2011-01-27 Oliver Hunt <oliver@apple.com>
[WebKit-https.git] / Source / JavaScriptCore / runtime / SmallStrings.cpp
1 /*
2  * Copyright (C) 2008, 2010 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 #include "config.h"
27 #include "SmallStrings.h"
28
29 #include "JSGlobalObject.h"
30 #include "JSString.h"
31 #include <wtf/Noncopyable.h>
32 #include <wtf/PassOwnPtr.h>
33
34 namespace JSC {
35
36 static const unsigned numCharactersToStore = 0x100;
37
38 static inline bool isMarked(JSCell* string)
39 {
40     return string && Heap::isCellMarked(string);
41 }
42
43 class SmallStringsStorage {
44     WTF_MAKE_NONCOPYABLE(SmallStringsStorage); WTF_MAKE_FAST_ALLOCATED;
45 public:
46     SmallStringsStorage();
47
48     StringImpl* rep(unsigned char character) { return m_reps[character].get(); }
49
50 private:
51     RefPtr<StringImpl> m_reps[numCharactersToStore];
52 };
53
54 SmallStringsStorage::SmallStringsStorage()
55 {
56     UChar* characterBuffer = 0;
57     RefPtr<StringImpl> baseString = StringImpl::createUninitialized(numCharactersToStore, characterBuffer);
58     for (unsigned i = 0; i < numCharactersToStore; ++i) {
59         characterBuffer[i] = i;
60         m_reps[i] = StringImpl::create(baseString, i, 1);
61     }
62 }
63
64 SmallStrings::SmallStrings()
65 {
66     COMPILE_ASSERT(numCharactersToStore == sizeof(m_singleCharacterStrings) / sizeof(m_singleCharacterStrings[0]), IsNumCharactersConstInSyncWithClassUsage);
67     clear();
68 }
69
70 SmallStrings::~SmallStrings()
71 {
72 }
73
74 void SmallStrings::markChildren(MarkStack& markStack)
75 {
76     /*
77        Our hypothesis is that small strings are very common. So, we cache them
78        to avoid GC churn. However, in cases where this hypothesis turns out to
79        be false -- including the degenerate case where all JavaScript execution
80        has terminated -- we don't want to waste memory.
81
82        To test our hypothesis, we check if any small string has been marked. If
83        so, it's probably reasonable to mark the rest. If not, we clear the cache.
84      */
85
86     bool isAnyStringMarked = isMarked(m_emptyString.get());
87     for (unsigned i = 0; i < numCharactersToStore && !isAnyStringMarked; ++i)
88         isAnyStringMarked = isMarked(m_singleCharacterStrings[i].get());
89     
90     if (!isAnyStringMarked) {
91         clear();
92         return;
93     }
94     
95     if (m_emptyString)
96         markStack.append(&m_emptyString);
97     for (unsigned i = 0; i < numCharactersToStore; ++i) {
98         if (m_singleCharacterStrings[i])
99             markStack.append(&m_singleCharacterStrings[i]);
100     }
101 }
102
103 void SmallStrings::clear()
104 {
105     m_emptyString = 0;
106     for (unsigned i = 0; i < numCharactersToStore; ++i)
107         m_singleCharacterStrings[i] = 0;
108 }
109
110 unsigned SmallStrings::count() const
111 {
112     unsigned count = 0;
113     if (m_emptyString)
114         ++count;
115     for (unsigned i = 0; i < numCharactersToStore; ++i) {
116         if (m_singleCharacterStrings[i])
117             ++count;
118     }
119     return count;
120 }
121
122 void SmallStrings::createEmptyString(JSGlobalData* globalData)
123 {
124     ASSERT(!m_emptyString);
125     m_emptyString = new (globalData) JSString(globalData, "", JSString::HasOtherOwner);
126 }
127
128 void SmallStrings::createSingleCharacterString(JSGlobalData* globalData, unsigned char character)
129 {
130     if (!m_storage)
131         m_storage = adoptPtr(new SmallStringsStorage);
132     ASSERT(!m_singleCharacterStrings[character]);
133     m_singleCharacterStrings[character] = new (globalData) JSString(globalData, PassRefPtr<StringImpl>(m_storage->rep(character)), JSString::HasOtherOwner);
134 }
135
136 StringImpl* SmallStrings::singleCharacterStringRep(unsigned char character)
137 {
138     if (!m_storage)
139         m_storage = adoptPtr(new SmallStringsStorage);
140     return m_storage->rep(character);
141 }
142
143 } // namespace JSC