Web Inspector: Move the computation that results in UI strings from JSC to the Web...
[WebKit-https.git] / Source / JavaScriptCore / runtime / TypeSet.cpp
1 /*
2  * Copyright (C) 2008, 2014 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 "TypeSet.h"
28
29 #include "InspectorJSProtocolTypes.h"
30 #include "JSCJSValue.h"
31 #include "JSCJSValueInlines.h"
32 #include <wtf/text/CString.h>
33 #include <wtf/text/WTFString.h>
34 #include <wtf/text/StringBuilder.h>
35 #include <wtf/Vector.h>
36
37 namespace JSC {
38
39 TypeSet::TypeSet()
40     : m_seenTypes(TypeNothing)
41     , m_isOverflown(false)
42 {
43 }
44
45 RuntimeType TypeSet::getRuntimeTypeForValue(JSValue v)
46 {
47     RuntimeType ret;
48     if (v.isFunction())
49         ret = TypeFunction;
50     else if (v.isUndefined())
51         ret = TypeUndefined;
52     else if (v.isNull())
53         ret = TypeNull;
54     else if (v.isBoolean())
55         ret = TypeBoolean;
56     else if (v.isMachineInt())
57         ret = TypeMachineInt;
58     else if (v.isNumber())
59         ret = TypeNumber;
60     else if (v.isString())
61         ret = TypeString;
62     else if (v.isObject())
63         ret = TypeObject;
64     else
65         ret = TypeNothing;
66
67     return ret;
68 }
69
70 void TypeSet::addTypeInformation(RuntimeType type, PassRefPtr<StructureShape> prpNewShape, StructureID id) 
71 {
72     RefPtr<StructureShape> newShape = prpNewShape;
73     m_seenTypes = m_seenTypes | type;
74
75     if (id && newShape && type != TypeString) {
76         ASSERT(m_structureIDCache.isValidValue(id));
77         auto addResult = m_structureIDCache.add(id);
78         if (addResult.isNewEntry) {
79             // Make one more pass making sure that: 
80             // - We don't have two instances of the same shape. (Same shapes may have different StructureIDs).
81             // - We don't have two shapes that share the same prototype chain. If these shapes share the same 
82             //   prototype chain, they will be merged into one shape.
83             bool found = false;
84             String hash = newShape->propertyHash();
85             for (size_t i = 0; i < m_structureHistory.size(); i++) {
86                 RefPtr<StructureShape>& seenShape = m_structureHistory.at(i);
87                 if (seenShape->propertyHash() == hash) {
88                     found = true;
89                     break;
90                 } 
91                 if (seenShape->hasSamePrototypeChain(newShape)) {
92                     seenShape = StructureShape::merge(seenShape, newShape);
93                     found = true;
94                     break;
95                 }
96             }
97
98             if (!found) {
99                 if (m_structureHistory.size() < 100)
100                     m_structureHistory.append(newShape);
101                 else if (!m_isOverflown)
102                     m_isOverflown = true;
103             }
104         }
105     }
106 }
107
108 void TypeSet::invalidateCache()
109 {
110     m_structureIDCache.clear();
111 }
112
113 String TypeSet::dumpTypes() const
114 {
115     if (m_seenTypes == TypeNothing)
116         return ASCIILiteral("(Unreached Statement)");
117
118     StringBuilder seen;
119
120     if (m_seenTypes & TypeFunction)
121          seen.append("Function ");
122     if (m_seenTypes & TypeUndefined)
123          seen.append("Undefined ");
124     if (m_seenTypes & TypeNull)
125          seen.append("Null ");
126     if (m_seenTypes & TypeBoolean)
127          seen.append("Boolean ");
128     if (m_seenTypes & TypeMachineInt)
129          seen.append("MachineInt ");
130     if (m_seenTypes & TypeNumber)
131          seen.append("Number ");
132     if (m_seenTypes & TypeString)
133          seen.append("String ");
134     if (m_seenTypes & TypeObject)
135          seen.append("Object ");
136
137     for (size_t i = 0; i < m_structureHistory.size(); i++) {
138         RefPtr<StructureShape> shape = m_structureHistory.at(i);
139         seen.append(shape->m_constructorName);
140         seen.append(' ');
141     }
142
143     if (m_structureHistory.size()) 
144         seen.append("\nStructures:[ ");
145     for (size_t i = 0; i < m_structureHistory.size(); i++) {
146         seen.append(m_structureHistory.at(i)->stringRepresentation());
147         seen.append(' ');
148     }
149     if (m_structureHistory.size())
150         seen.append(']');
151
152     if (m_structureHistory.size()) {
153         seen.append("\nLeast Common Ancestor: ");
154         seen.append(leastCommonAncestor());
155     }
156
157     return seen.toString();
158 }
159
160 bool TypeSet::doesTypeConformTo(uint32_t test) const
161 {
162     // This function checks if our seen types conform  to the types described by the test bitstring. (i.e we haven't seen more types than test).
163     // We are <= to those types if ANDing with the bitstring doesn't zero out any of our bits.
164
165     // For example:
166
167     // 0b0110 (seen)
168     // 0b1111 (test)
169     // ------ (AND)
170     // 0b0110 == seen
171
172     // 0b0110 (seen)
173     // 0b0010 (test)
174     // ------ (AND)
175     // 0b0010 != seen
176
177     return m_seenTypes != TypeNothing && (m_seenTypes & test) == m_seenTypes;
178 }
179
180 String TypeSet::displayName() const
181 {
182     if (m_seenTypes == TypeNothing)
183         return emptyString();
184
185     if (m_structureHistory.size() && doesTypeConformTo(TypeObject | TypeNull | TypeUndefined)) {
186         String ctorName = leastCommonAncestor(); 
187
188         if (doesTypeConformTo(TypeObject))
189             return ctorName;
190         if (doesTypeConformTo(TypeObject | TypeNull | TypeUndefined))
191             return ctorName + '?';
192     }
193
194     // The order of these checks are important. For example, if a value is only a function, it conforms to TypeFunction, but it also conforms to TypeFunction | TypeNull.
195     // Therefore, more specific types must be checked first.
196
197     if (doesTypeConformTo(TypeFunction))
198         return ASCIILiteral("Function");
199     if (doesTypeConformTo(TypeUndefined))
200         return ASCIILiteral("Undefined");
201     if (doesTypeConformTo(TypeNull))
202         return ASCIILiteral("Null");
203     if (doesTypeConformTo(TypeBoolean))
204         return ASCIILiteral("Boolean");
205     if (doesTypeConformTo(TypeMachineInt))
206         return ASCIILiteral("Integer");
207     if (doesTypeConformTo(TypeNumber | TypeMachineInt))
208         return ASCIILiteral("Number");
209     if (doesTypeConformTo(TypeString))
210         return ASCIILiteral("String");
211
212     if (doesTypeConformTo(TypeNull | TypeUndefined))
213         return ASCIILiteral("(?)");
214
215     if (doesTypeConformTo(TypeFunction | TypeNull | TypeUndefined))
216         return ASCIILiteral("Function?");
217     if (doesTypeConformTo(TypeBoolean | TypeNull | TypeUndefined))
218         return ASCIILiteral("Boolean?");
219     if (doesTypeConformTo(TypeMachineInt | TypeNull | TypeUndefined))
220         return ASCIILiteral("Integer?");
221     if (doesTypeConformTo(TypeNumber | TypeMachineInt | TypeNull | TypeUndefined))
222         return ASCIILiteral("Number?");
223     if (doesTypeConformTo(TypeString | TypeNull | TypeUndefined))
224         return ASCIILiteral("String?");
225    
226     if (doesTypeConformTo(TypeObject | TypeFunction | TypeString))
227         return ASCIILiteral("Object");
228     if (doesTypeConformTo(TypeObject | TypeFunction | TypeString | TypeNull | TypeUndefined))
229         return ASCIILiteral("Object?");
230
231     return ASCIILiteral("(many)");
232 }
233
234 String TypeSet::leastCommonAncestor() const
235 {
236     return StructureShape::leastCommonAncestor(m_structureHistory);
237 }
238
239 #if ENABLE(INSPECTOR)
240 PassRefPtr<Inspector::Protocol::Array<Inspector::Protocol::Runtime::StructureDescription>> TypeSet::allStructureRepresentations() const
241 {
242     RefPtr<Inspector::Protocol::Array<Inspector::Protocol::Runtime::StructureDescription>> description = Inspector::Protocol::Array<Inspector::Protocol::Runtime::StructureDescription>::create();
243
244     for (size_t i = 0; i < m_structureHistory.size(); i++)
245         description->addItem(m_structureHistory.at(i)->inspectorRepresentation());
246
247     return description.release();
248 }
249
250 PassRefPtr<Inspector::Protocol::Runtime::TypeSet> TypeSet::inspectorTypeSet() const
251 {
252     return Inspector::Protocol::Runtime::TypeSet::create()
253         .setIsFunction((m_seenTypes & TypeFunction) != TypeNothing)
254         .setIsUndefined((m_seenTypes & TypeUndefined) != TypeNothing)
255         .setIsNull((m_seenTypes & TypeNull) != TypeNothing)
256         .setIsBoolean((m_seenTypes & TypeBoolean) != TypeNothing)
257         .setIsInteger((m_seenTypes & TypeMachineInt) != TypeNothing)
258         .setIsNumber((m_seenTypes & TypeNumber) != TypeNothing)
259         .setIsString((m_seenTypes & TypeString) != TypeNothing)
260         .setIsObject((m_seenTypes & TypeObject) != TypeNothing)
261         .release();
262 }
263 #endif
264
265 String TypeSet::toJSONString() const
266 {
267     // This returns a JSON string representing an Object with the following properties:
268     //     displayTypeName: 'String'
269     //     primitiveTypeNames: 'Array<String>'
270     //     structures: 'Array<JSON<StructureShape>>'
271
272     StringBuilder json;
273     json.append("{");
274
275     json.append("\"displayTypeName\":");
276     json.append("\"");
277     json.append(displayName());
278     json.append("\"");
279     json.append(",");
280
281     json.append("\"primitiveTypeNames\":");
282     json.append("[");
283     bool hasAnItem = false;
284     if (m_seenTypes & TypeUndefined) {
285         hasAnItem = true;
286         json.append("\"Undefined\"");
287     }
288     if (m_seenTypes & TypeNull) {
289         if (hasAnItem)
290             json.append(",");
291         hasAnItem = true;
292         json.append("\"Null\"");
293     }
294     if (m_seenTypes & TypeBoolean) {
295         if (hasAnItem)
296             json.append(",");
297         hasAnItem = true;
298         json.append("\"Boolean\"");
299     }
300     if (m_seenTypes & TypeMachineInt) {
301         if (hasAnItem)
302             json.append(",");
303         hasAnItem = true;
304         json.append("\"Integer\"");
305     }
306     if (m_seenTypes & TypeNumber) {
307         if (hasAnItem)
308             json.append(",");
309         hasAnItem = true;
310         json.append("\"Number\"");
311     }
312     if (m_seenTypes & TypeString) {
313         if (hasAnItem)
314             json.append(",");
315         hasAnItem = true;
316         json.append("\"String\"");
317     }
318     json.append("]");
319
320     json.append(",");
321
322     json.append("\"structures\":");
323     json.append("[");
324     hasAnItem = false;
325     for (size_t i = 0; i < m_structureHistory.size(); i++) {
326         if (hasAnItem)
327             json.append(",");
328         hasAnItem = true;
329         json.append(m_structureHistory[i]->toJSONString());
330     }
331     json.append("]");
332
333     json.append("}");
334     return json.toString();
335 }
336
337 StructureShape::StructureShape()
338     : m_proto(nullptr)
339     , m_propertyHash(nullptr)
340     , m_final(false)
341     , m_isInDictionaryMode(false)
342 {
343 }
344
345 void StructureShape::markAsFinal()
346 {
347     ASSERT(!m_final);
348     m_final = true;
349 }
350
351 void StructureShape::addProperty(RefPtr<StringImpl> impl)
352 {
353     ASSERT(!m_final);
354     m_fields.add(impl);
355 }
356
357 String StructureShape::propertyHash() 
358 {
359     ASSERT(m_final);
360     if (m_propertyHash)
361         return *m_propertyHash;
362
363     StringBuilder builder;
364     builder.append(':');
365     builder.append(m_constructorName);
366     builder.append(':');
367     
368     for (auto iter = m_fields.begin(), end = m_fields.end(); iter != end; ++iter) {
369         String property = String((*iter));
370         property.replace(":", "\\:"); // Ensure that hash({"foo:", "bar"}) != hash({"foo", ":bar"}) because we're using colons as a separator and colons are legal characters in field names in JS.
371         builder.append(property);
372     }
373
374     if (m_proto) {
375         builder.append(':');
376         builder.append("__proto__");
377         builder.append(m_proto->propertyHash());
378     }
379
380     m_propertyHash = std::make_unique<String>(builder.toString());
381     return *m_propertyHash;
382 }
383
384 String StructureShape::leastCommonAncestor(const Vector<RefPtr<StructureShape>> shapes)
385 {
386     if (!shapes.size())
387         return emptyString();
388
389     RefPtr<StructureShape> origin = shapes.at(0);
390     for (size_t i = 1; i < shapes.size(); i++) {
391         bool foundLUB = false;
392         while (!foundLUB) {
393             RefPtr<StructureShape> check = shapes.at(i);
394             String curCtorName = origin->m_constructorName;
395             while (check) {
396                 if (check->m_constructorName == curCtorName) {
397                     foundLUB = true;
398                     break;
399                 }
400                 check = check->m_proto;
401             }
402             if (!foundLUB) {
403                 origin = origin->m_proto;
404                 // All Objects must share the 'Object' Prototype. Therefore, at the very least, we should always converge on 'Object' before reaching a null prototype.
405                 RELEASE_ASSERT(origin); 
406             }
407         }
408
409         if (origin->m_constructorName == "Object")
410             break;
411     }
412
413     return origin->m_constructorName;
414 }
415
416 String StructureShape::stringRepresentation()
417 {
418     StringBuilder representation;
419     RefPtr<StructureShape> curShape = this;
420
421     representation.append('{');
422     while (curShape) {
423         for (auto it = curShape->m_fields.begin(), end = curShape->m_fields.end(); it != end; ++it) {
424             String prop((*it).get());
425             representation.append(prop);
426             representation.append(", ");
427         }
428
429         if (curShape->m_proto) {
430             String prot = makeString("__proto__ [", curShape->m_proto->m_constructorName, ']');
431             representation.append(prot);
432             representation.append(", ");
433         }
434
435         curShape = curShape->m_proto;
436     }
437
438     if (representation.length() >= 3)
439         representation.resize(representation.length() - 2);
440
441     representation.append('}');
442
443     return representation.toString();
444 }
445
446 String StructureShape::toJSONString() const
447 {
448     // This returns a JSON string representing an Object with the following properties:
449     //     constructorName: 'String'
450     //     fields: 'Array<String>'
451     //     optionalFields: 'Array<String>'
452     //     proto: 'JSON<StructureShape> | null'
453
454     StringBuilder json;
455     json.append("{");
456
457     json.append("\"constructorName\":");
458     json.append("\"");
459     json.append(m_constructorName);
460     json.append("\"");
461     json.append(",");
462
463     json.append("\"isInDictionaryMode\":");
464     if (m_isInDictionaryMode)
465         json.append("true");
466     else
467         json.append("false");
468     json.append(",");
469
470     json.append("\"fields\":");
471     json.append("[");
472     bool hasAnItem = false;
473     for (auto it = m_fields.begin(), end = m_fields.end(); it != end; ++it) {
474         if (hasAnItem)
475             json.append(",");
476         hasAnItem = true;
477
478         String fieldName((*it).get());
479         json.append("\"");
480         json.append(fieldName);
481         json.append("\"");
482     }
483     json.append("]");
484     json.append(",");
485
486     json.append("\"optionalFields\":");
487     json.append("[");
488     hasAnItem = false;
489     for (auto it = m_optionalFields.begin(), end = m_optionalFields.end(); it != end; ++it) {
490         if (hasAnItem)
491             json.append(",");
492         hasAnItem = true;
493
494         String fieldName((*it).get());
495         json.append("\"");
496         json.append(fieldName);
497         json.append("\"");
498     }
499     json.append("]");
500     json.append(",");
501
502     json.append("\"proto\":");
503     if (m_proto)
504         json.append(m_proto->toJSONString());
505     else
506         json.append("null");
507
508     json.append("}");
509
510     return json.toString();
511 }
512
513 #if ENABLE(INSPECTOR)
514 PassRefPtr<Inspector::Protocol::Runtime::StructureDescription> StructureShape::inspectorRepresentation()
515 {
516     RefPtr<Inspector::Protocol::Runtime::StructureDescription> base = Inspector::Protocol::Runtime::StructureDescription::create();
517     RefPtr<Inspector::Protocol::Runtime::StructureDescription> currentObject = base;
518     RefPtr<StructureShape> currentShape = this;
519
520     while (currentShape) {
521         auto fields = Inspector::Protocol::Array<String>::create();
522         auto optionalFields = Inspector::Protocol::Array<String>::create();
523         for (auto field : currentShape->m_fields)
524             fields->addItem(field.get());
525         for (auto field : currentShape->m_optionalFields)
526             optionalFields->addItem(field.get());
527
528         currentObject->setFields(fields);
529         currentObject->setOptionalFields(optionalFields);
530         currentObject->setConstructorName(currentShape->m_constructorName);
531         currentObject->setIsImprecise(currentShape->m_isInDictionaryMode);
532
533         if (currentShape->m_proto) {
534             RefPtr<Inspector::Protocol::Runtime::StructureDescription> nextObject = Inspector::Protocol::Runtime::StructureDescription::create();
535             currentObject->setPrototypeStructure(nextObject);
536             currentObject = nextObject;
537         }
538
539         currentShape = currentShape->m_proto;
540     }
541
542     return base.release();
543 }
544 #endif
545
546 bool StructureShape::hasSamePrototypeChain(PassRefPtr<StructureShape> prpOther)
547 {
548     RefPtr<StructureShape> self = this;
549     RefPtr<StructureShape> other = prpOther;
550     while (self && other) {
551         if (self->m_constructorName != other->m_constructorName)
552             return false;
553         self = self->m_proto;
554         other = other->m_proto;
555     }
556
557     return !self && !other;
558 }
559
560 PassRefPtr<StructureShape> StructureShape::merge(const PassRefPtr<StructureShape> prpA, const PassRefPtr<StructureShape> prpB)
561 {
562     RefPtr<StructureShape> a = prpA;
563     RefPtr<StructureShape> b = prpB;
564     ASSERT(a->hasSamePrototypeChain(b));
565
566     RefPtr<StructureShape> merged = StructureShape::create();
567     for (auto field : a->m_fields) {
568         if (b->m_fields.contains(field))
569             merged->m_fields.add(field);
570         else
571             merged->m_optionalFields.add(field);
572     }
573
574     for (auto field : b->m_fields) {
575         if (!merged->m_fields.contains(field)) {
576             auto addResult = merged->m_optionalFields.add(field);
577             ASSERT_UNUSED(addResult, addResult.isNewEntry);
578         }
579     }
580
581     for (auto field : a->m_optionalFields)
582         merged->m_optionalFields.add(field);
583     for (auto field : b->m_optionalFields)
584         merged->m_optionalFields.add(field);
585
586     ASSERT(a->m_constructorName == b->m_constructorName);
587     merged->setConstructorName(a->m_constructorName);
588
589     if (a->m_proto) {
590         RELEASE_ASSERT(b->m_proto);
591         merged->setProto(StructureShape::merge(a->m_proto, b->m_proto));
592     }
593
594     merged->markAsFinal();
595
596     return merged.release();
597 }
598
599 void StructureShape::enterDictionaryMode()
600 {
601     m_isInDictionaryMode = true;
602 }
603
604 } //namespace JSC