Change a couple of COMPILE_ASSERTs to static_assert
[WebKit-https.git] / Source / WTF / wtf / text / AtomicString.cpp
1 /*
2  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2013 Apple Inc. All rights reserved.
3  * Copyright (C) 2010 Patrick Gansterer <paroga@paroga.com>
4  * Copyright (C) 2012 Google 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
25 #include "AtomicString.h"
26
27 #include "AtomicStringTable.h"
28 #include "StringHash.h"
29 #include <wtf/HashSet.h>
30 #include <wtf/Threading.h>
31 #include <wtf/WTFThreadData.h>
32 #include <wtf/unicode/UTF8.h>
33
34 #if USE(WEB_THREAD)
35 #include <wtf/MainThread.h>
36 #include <wtf/TCSpinLock.h>
37 #endif
38
39 namespace WTF {
40
41 using namespace Unicode;
42
43 static_assert(sizeof(AtomicString) == sizeof(String), "AtomicString and String must be same size!");
44
45 #if USE(WEB_THREAD)
46 class AtomicStringTableLocker : public SpinLockHolder {
47     WTF_MAKE_NONCOPYABLE(AtomicStringTableLocker);
48
49     static SpinLock s_stringTableLock;
50 public:
51     AtomicStringTableLocker()
52         : SpinLockHolder(&s_stringTableLock)
53     {
54     }
55 };
56
57 SpinLock AtomicStringTableLocker::s_stringTableLock = SPINLOCK_INITIALIZER;
58 #else
59
60 class AtomicStringTableLocker {
61     WTF_MAKE_NONCOPYABLE(AtomicStringTableLocker);
62 public:
63     AtomicStringTableLocker() { }
64     ~AtomicStringTableLocker() { }
65 };
66 #endif // USE(WEB_THREAD)
67
68 static ALWAYS_INLINE HashSet<StringImpl*>& stringTable()
69 {
70     return wtfThreadData().atomicStringTable()->table();
71 }
72
73 template<typename T, typename HashTranslator>
74 static inline PassRefPtr<StringImpl> addToStringTable(const T& value)
75 {
76     AtomicStringTableLocker locker;
77
78     HashSet<StringImpl*>::AddResult addResult = stringTable().add<HashTranslator>(value);
79
80     // If the string is newly-translated, then we need to adopt it.
81     // The boolean in the pair tells us if that is so.
82     return addResult.isNewEntry ? adoptRef(*addResult.iterator) : *addResult.iterator;
83 }
84
85 struct CStringTranslator {
86     static unsigned hash(const LChar* c)
87     {
88         return StringHasher::computeHashAndMaskTop8Bits(c);
89     }
90
91     static inline bool equal(StringImpl* r, const LChar* s)
92     {
93         return WTF::equal(r, s);
94     }
95
96     static void translate(StringImpl*& location, const LChar* const& c, unsigned hash)
97     {
98         location = StringImpl::create(c).leakRef();
99         location->setHash(hash);
100         location->setIsAtomic(true);
101     }
102 };
103
104 PassRefPtr<StringImpl> AtomicString::add(const LChar* c)
105 {
106     if (!c)
107         return 0;
108     if (!*c)
109         return StringImpl::empty();
110
111     return addToStringTable<const LChar*, CStringTranslator>(c);
112 }
113
114 template<typename CharacterType>
115 struct HashTranslatorCharBuffer {
116     const CharacterType* s;
117     unsigned length;
118 };
119
120 typedef HashTranslatorCharBuffer<UChar> UCharBuffer;
121 struct UCharBufferTranslator {
122     static unsigned hash(const UCharBuffer& buf)
123     {
124         return StringHasher::computeHashAndMaskTop8Bits(buf.s, buf.length);
125     }
126
127     static bool equal(StringImpl* const& str, const UCharBuffer& buf)
128     {
129         return WTF::equal(str, buf.s, buf.length);
130     }
131
132     static void translate(StringImpl*& location, const UCharBuffer& buf, unsigned hash)
133     {
134         location = StringImpl::create8BitIfPossible(buf.s, buf.length).leakRef();
135         location->setHash(hash);
136         location->setIsAtomic(true);
137     }
138 };
139
140 template<typename CharacterType>
141 struct HashAndCharacters {
142     unsigned hash;
143     const CharacterType* characters;
144     unsigned length;
145 };
146
147 template<typename CharacterType>
148 struct HashAndCharactersTranslator {
149     static unsigned hash(const HashAndCharacters<CharacterType>& buffer)
150     {
151         ASSERT(buffer.hash == StringHasher::computeHashAndMaskTop8Bits(buffer.characters, buffer.length));
152         return buffer.hash;
153     }
154
155     static bool equal(StringImpl* const& string, const HashAndCharacters<CharacterType>& buffer)
156     {
157         return WTF::equal(string, buffer.characters, buffer.length);
158     }
159
160     static void translate(StringImpl*& location, const HashAndCharacters<CharacterType>& buffer, unsigned hash)
161     {
162         location = StringImpl::create(buffer.characters, buffer.length).leakRef();
163         location->setHash(hash);
164         location->setIsAtomic(true);
165     }
166 };
167
168 struct HashAndUTF8Characters {
169     unsigned hash;
170     const char* characters;
171     unsigned length;
172     unsigned utf16Length;
173 };
174
175 struct HashAndUTF8CharactersTranslator {
176     static unsigned hash(const HashAndUTF8Characters& buffer)
177     {
178         return buffer.hash;
179     }
180
181     static bool equal(StringImpl* const& string, const HashAndUTF8Characters& buffer)
182     {
183         if (buffer.utf16Length != string->length())
184             return false;
185
186         // If buffer contains only ASCII characters UTF-8 and UTF16 length are the same.
187         if (buffer.utf16Length != buffer.length) {
188             const UChar* stringCharacters = string->characters();
189
190             return equalUTF16WithUTF8(stringCharacters, stringCharacters + string->length(), buffer.characters, buffer.characters + buffer.length);
191         }
192
193         if (string->is8Bit()) {
194             const LChar* stringCharacters = string->characters8();
195
196             for (unsigned i = 0; i < buffer.length; ++i) {
197                 ASSERT(isASCII(buffer.characters[i]));
198                 if (stringCharacters[i] != buffer.characters[i])
199                     return false;
200             }
201
202             return true;
203         }
204
205         const UChar* stringCharacters = string->characters16();
206
207         for (unsigned i = 0; i < buffer.length; ++i) {
208             ASSERT(isASCII(buffer.characters[i]));
209             if (stringCharacters[i] != buffer.characters[i])
210                 return false;
211         }
212
213         return true;
214     }
215
216     static void translate(StringImpl*& location, const HashAndUTF8Characters& buffer, unsigned hash)
217     {
218         UChar* target;
219         RefPtr<StringImpl> newString = StringImpl::createUninitialized(buffer.utf16Length, target);
220
221         bool isAllASCII;
222         const char* source = buffer.characters;
223         if (convertUTF8ToUTF16(&source, source + buffer.length, &target, target + buffer.utf16Length, &isAllASCII) != conversionOK)
224             ASSERT_NOT_REACHED();
225
226         if (isAllASCII)
227             newString = StringImpl::create(buffer.characters, buffer.length);
228
229         location = newString.release().leakRef();
230         location->setHash(hash);
231         location->setIsAtomic(true);
232     }
233 };
234
235 PassRefPtr<StringImpl> AtomicString::add(const UChar* s, unsigned length)
236 {
237     if (!s)
238         return 0;
239
240     if (!length)
241         return StringImpl::empty();
242     
243     UCharBuffer buffer = { s, length };
244     return addToStringTable<UCharBuffer, UCharBufferTranslator>(buffer);
245 }
246
247 PassRefPtr<StringImpl> AtomicString::add(const UChar* s, unsigned length, unsigned existingHash)
248 {
249     ASSERT(s);
250     ASSERT(existingHash);
251
252     if (!length)
253         return StringImpl::empty();
254
255     HashAndCharacters<UChar> buffer = { existingHash, s, length };
256     return addToStringTable<HashAndCharacters<UChar>, HashAndCharactersTranslator<UChar> >(buffer);
257 }
258
259 PassRefPtr<StringImpl> AtomicString::add(const UChar* s)
260 {
261     if (!s)
262         return 0;
263
264     unsigned length = 0;
265     while (s[length] != UChar(0))
266         ++length;
267
268     if (!length)
269         return StringImpl::empty();
270
271     UCharBuffer buffer = { s, length };
272     return addToStringTable<UCharBuffer, UCharBufferTranslator>(buffer);
273 }
274
275 struct SubstringLocation {
276     StringImpl* baseString;
277     unsigned start;
278     unsigned length;
279 };
280
281 struct SubstringTranslator {
282     static unsigned hash(const SubstringLocation& buffer)
283     {
284         return StringHasher::computeHashAndMaskTop8Bits(buffer.baseString->characters() + buffer.start, buffer.length);
285     }
286
287     static bool equal(StringImpl* const& string, const SubstringLocation& buffer)
288     {
289         return WTF::equal(string, buffer.baseString->characters() + buffer.start, buffer.length);
290     }
291
292     static void translate(StringImpl*& location, const SubstringLocation& buffer, unsigned hash)
293     {
294         location = StringImpl::create(buffer.baseString, buffer.start, buffer.length).leakRef();
295         location->setHash(hash);
296         location->setIsAtomic(true);
297     }
298 };
299
300 PassRefPtr<StringImpl> AtomicString::add(StringImpl* baseString, unsigned start, unsigned length)
301 {
302     if (!baseString)
303         return 0;
304
305     if (!length || start >= baseString->length())
306         return StringImpl::empty();
307
308     unsigned maxLength = baseString->length() - start;
309     if (length >= maxLength) {
310         if (!start)
311             return add(baseString);
312         length = maxLength;
313     }
314
315     SubstringLocation buffer = { baseString, start, length };
316     return addToStringTable<SubstringLocation, SubstringTranslator>(buffer);
317 }
318     
319 typedef HashTranslatorCharBuffer<LChar> LCharBuffer;
320 struct LCharBufferTranslator {
321     static unsigned hash(const LCharBuffer& buf)
322     {
323         return StringHasher::computeHashAndMaskTop8Bits(buf.s, buf.length);
324     }
325
326     static bool equal(StringImpl* const& str, const LCharBuffer& buf)
327     {
328         return WTF::equal(str, buf.s, buf.length);
329     }
330
331     static void translate(StringImpl*& location, const LCharBuffer& buf, unsigned hash)
332     {
333         location = StringImpl::create(buf.s, buf.length).leakRef();
334         location->setHash(hash);
335         location->setIsAtomic(true);
336     }
337 };
338
339 typedef HashTranslatorCharBuffer<char> CharBuffer;
340 struct CharBufferFromLiteralDataTranslator {
341     static unsigned hash(const CharBuffer& buf)
342     {
343         return StringHasher::computeHashAndMaskTop8Bits(reinterpret_cast<const LChar*>(buf.s), buf.length);
344     }
345
346     static bool equal(StringImpl* const& str, const CharBuffer& buf)
347     {
348         return WTF::equal(str, buf.s, buf.length);
349     }
350
351     static void translate(StringImpl*& location, const CharBuffer& buf, unsigned hash)
352     {
353         location = StringImpl::createFromLiteral(buf.s, buf.length).leakRef();
354         location->setHash(hash);
355         location->setIsAtomic(true);
356     }
357 };
358
359 PassRefPtr<StringImpl> AtomicString::add(const LChar* s, unsigned length)
360 {
361     if (!s)
362         return 0;
363
364     if (!length)
365         return StringImpl::empty();
366
367     LCharBuffer buffer = { s, length };
368     return addToStringTable<LCharBuffer, LCharBufferTranslator>(buffer);
369 }
370
371 PassRefPtr<StringImpl> AtomicString::addFromLiteralData(const char* characters, unsigned length)
372 {
373     ASSERT(characters);
374     ASSERT(length);
375
376     CharBuffer buffer = { characters, length };
377     return addToStringTable<CharBuffer, CharBufferFromLiteralDataTranslator>(buffer);
378 }
379
380 PassRefPtr<StringImpl> AtomicString::addSlowCase(StringImpl* string)
381 {
382     if (!string->length())
383         return StringImpl::empty();
384
385     ASSERT_WITH_MESSAGE(!string->isAtomic(), "AtomicString should not hit the slow case if the string is already atomic.");
386
387     AtomicStringTableLocker locker;
388     HashSet<StringImpl*>::AddResult addResult = stringTable().add(string);
389
390     if (addResult.isNewEntry) {
391         ASSERT(*addResult.iterator == string);
392         string->setIsAtomic(true);
393     }
394
395     return *addResult.iterator;
396 }
397
398 template<typename CharacterType>
399 static inline HashSet<StringImpl*>::iterator findString(const StringImpl* stringImpl)
400 {
401     HashAndCharacters<CharacterType> buffer = { stringImpl->existingHash(), stringImpl->getCharacters<CharacterType>(), stringImpl->length() };
402     return stringTable().find<HashAndCharactersTranslator<CharacterType> >(buffer);
403 }
404
405 AtomicStringImpl* AtomicString::find(const StringImpl* stringImpl)
406 {
407     ASSERT(stringImpl);
408     ASSERT(stringImpl->existingHash());
409
410     if (!stringImpl->length())
411         return static_cast<AtomicStringImpl*>(StringImpl::empty());
412
413     AtomicStringTableLocker locker;
414     HashSet<StringImpl*>::iterator iterator;
415     if (stringImpl->is8Bit())
416         iterator = findString<LChar>(stringImpl);
417     else
418         iterator = findString<UChar>(stringImpl);
419     if (iterator == stringTable().end())
420         return 0;
421     return static_cast<AtomicStringImpl*>(*iterator);
422 }
423
424 void AtomicString::remove(StringImpl* string)
425 {
426     ASSERT(string->isAtomic());
427     AtomicStringTableLocker locker;
428     HashSet<StringImpl*>& atomicStringTable = stringTable();
429     HashSet<StringImpl*>::iterator iterator = atomicStringTable.find(string);
430     ASSERT_WITH_MESSAGE(iterator != atomicStringTable.end(), "The string being removed is atomic in the string table of an other thread!");
431     atomicStringTable.remove(iterator);
432 }
433
434 AtomicString AtomicString::lower() const
435 {
436     // Note: This is a hot function in the Dromaeo benchmark.
437     StringImpl* impl = this->impl();
438     if (UNLIKELY(!impl))
439         return AtomicString();
440
441     RefPtr<StringImpl> lowerImpl = impl->lower();
442     AtomicString returnValue;
443     if (LIKELY(lowerImpl == impl))
444         returnValue.m_string = lowerImpl.release();
445     else
446         returnValue.m_string = addSlowCase(lowerImpl.get());
447     return returnValue;
448 }
449
450 AtomicString AtomicString::fromUTF8Internal(const char* charactersStart, const char* charactersEnd)
451 {
452     HashAndUTF8Characters buffer;
453     buffer.characters = charactersStart;
454     buffer.hash = calculateStringHashAndLengthFromUTF8MaskingTop8Bits(charactersStart, charactersEnd, buffer.length, buffer.utf16Length);
455
456     if (!buffer.hash)
457         return nullAtom;
458
459     AtomicString atomicString;
460     atomicString.m_string = addToStringTable<HashAndUTF8Characters, HashAndUTF8CharactersTranslator>(buffer);
461     return atomicString;
462 }
463
464 #if !ASSERT_DISABLED
465 bool AtomicString::isInAtomicStringTable(StringImpl* string)
466 {
467     AtomicStringTableLocker locker;
468     return stringTable().contains(string);
469 }
470 #endif
471
472 #ifndef NDEBUG
473 void AtomicString::show() const
474 {
475     m_string.show();
476 }
477 #endif
478
479 } // namespace WTF