[runtime] Unify and fix the strict equality comparison.
[platform/upstream/v8.git] / src / objects.h
1 // Copyright 2012 the V8 project authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #ifndef V8_OBJECTS_H_
6 #define V8_OBJECTS_H_
7
8 #include <iosfwd>
9
10 #include "src/allocation.h"
11 #include "src/assert-scope.h"
12 #include "src/bailout-reason.h"
13 #include "src/base/bits.h"
14 #include "src/base/smart-pointers.h"
15 #include "src/builtins.h"
16 #include "src/checks.h"
17 #include "src/elements-kind.h"
18 #include "src/field-index.h"
19 #include "src/flags.h"
20 #include "src/list.h"
21 #include "src/property-details.h"
22 #include "src/unicode-inl.h"
23 #include "src/unicode-decoder.h"
24 #include "src/zone.h"
25
26 #if V8_TARGET_ARCH_ARM
27 #include "src/arm/constants-arm.h"  // NOLINT
28 #elif V8_TARGET_ARCH_ARM64
29 #include "src/arm64/constants-arm64.h"  // NOLINT
30 #elif V8_TARGET_ARCH_MIPS
31 #include "src/mips/constants-mips.h"  // NOLINT
32 #elif V8_TARGET_ARCH_MIPS64
33 #include "src/mips64/constants-mips64.h"  // NOLINT
34 #elif V8_TARGET_ARCH_PPC
35 #include "src/ppc/constants-ppc.h"  // NOLINT
36 #endif
37
38
39 //
40 // Most object types in the V8 JavaScript are described in this file.
41 //
42 // Inheritance hierarchy:
43 // - Object
44 //   - Smi          (immediate small integer)
45 //   - HeapObject   (superclass for everything allocated in the heap)
46 //     - JSReceiver  (suitable for property access)
47 //       - JSObject
48 //         - JSArray
49 //         - JSArrayBuffer
50 //         - JSArrayBufferView
51 //           - JSTypedArray
52 //           - JSDataView
53 //         - JSCollection
54 //           - JSSet
55 //           - JSMap
56 //         - JSSetIterator
57 //         - JSMapIterator
58 //         - JSWeakCollection
59 //           - JSWeakMap
60 //           - JSWeakSet
61 //         - JSRegExp
62 //         - JSFunction
63 //         - JSGeneratorObject
64 //         - JSModule
65 //         - GlobalObject
66 //           - JSGlobalObject
67 //           - JSBuiltinsObject
68 //         - JSGlobalProxy
69 //         - JSValue
70 //           - JSDate
71 //         - JSMessageObject
72 //       - JSProxy
73 //         - JSFunctionProxy
74 //     - FixedArrayBase
75 //       - ByteArray
76 //       - BytecodeArray
77 //       - FixedArray
78 //         - DescriptorArray
79 //         - HashTable
80 //           - Dictionary
81 //           - StringTable
82 //           - CompilationCacheTable
83 //           - CodeCacheHashTable
84 //           - MapCache
85 //         - OrderedHashTable
86 //           - OrderedHashSet
87 //           - OrderedHashMap
88 //         - Context
89 //         - TypeFeedbackVector
90 //         - ScopeInfo
91 //         - TransitionArray
92 //         - ScriptContextTable
93 //         - WeakFixedArray
94 //       - FixedDoubleArray
95 //     - Name
96 //       - String
97 //         - SeqString
98 //           - SeqOneByteString
99 //           - SeqTwoByteString
100 //         - SlicedString
101 //         - ConsString
102 //         - ExternalString
103 //           - ExternalOneByteString
104 //           - ExternalTwoByteString
105 //         - InternalizedString
106 //           - SeqInternalizedString
107 //             - SeqOneByteInternalizedString
108 //             - SeqTwoByteInternalizedString
109 //           - ConsInternalizedString
110 //           - ExternalInternalizedString
111 //             - ExternalOneByteInternalizedString
112 //             - ExternalTwoByteInternalizedString
113 //       - Symbol
114 //     - HeapNumber
115 //     - Simd128Value
116 //       - Float32x4
117 //       - Int32x4
118 //       - Bool32x4
119 //       - Int16x8
120 //       - Bool16x8
121 //       - Int8x16
122 //       - Bool8x16
123 //     - Cell
124 //     - PropertyCell
125 //     - Code
126 //     - Map
127 //     - Oddball
128 //     - Foreign
129 //     - SharedFunctionInfo
130 //     - Struct
131 //       - Box
132 //       - AccessorInfo
133 //         - ExecutableAccessorInfo
134 //       - AccessorPair
135 //       - AccessCheckInfo
136 //       - InterceptorInfo
137 //       - CallHandlerInfo
138 //       - TemplateInfo
139 //         - FunctionTemplateInfo
140 //         - ObjectTemplateInfo
141 //       - Script
142 //       - TypeSwitchInfo
143 //       - DebugInfo
144 //       - BreakPointInfo
145 //       - CodeCache
146 //       - PrototypeInfo
147 //     - WeakCell
148 //
149 // Formats of Object*:
150 //  Smi:        [31 bit signed int] 0
151 //  HeapObject: [32 bit direct pointer] (4 byte aligned) | 01
152
153 namespace v8 {
154 namespace internal {
155
156 enum KeyedAccessStoreMode {
157   STANDARD_STORE,
158   STORE_TRANSITION_SMI_TO_OBJECT,
159   STORE_TRANSITION_SMI_TO_DOUBLE,
160   STORE_TRANSITION_DOUBLE_TO_OBJECT,
161   STORE_TRANSITION_HOLEY_SMI_TO_OBJECT,
162   STORE_TRANSITION_HOLEY_SMI_TO_DOUBLE,
163   STORE_TRANSITION_HOLEY_DOUBLE_TO_OBJECT,
164   STORE_AND_GROW_NO_TRANSITION,
165   STORE_AND_GROW_TRANSITION_SMI_TO_OBJECT,
166   STORE_AND_GROW_TRANSITION_SMI_TO_DOUBLE,
167   STORE_AND_GROW_TRANSITION_DOUBLE_TO_OBJECT,
168   STORE_AND_GROW_TRANSITION_HOLEY_SMI_TO_OBJECT,
169   STORE_AND_GROW_TRANSITION_HOLEY_SMI_TO_DOUBLE,
170   STORE_AND_GROW_TRANSITION_HOLEY_DOUBLE_TO_OBJECT,
171   STORE_NO_TRANSITION_IGNORE_OUT_OF_BOUNDS,
172   STORE_NO_TRANSITION_HANDLE_COW
173 };
174
175
176 enum TypeofMode { INSIDE_TYPEOF, NOT_INSIDE_TYPEOF };
177
178
179 enum MutableMode {
180   MUTABLE,
181   IMMUTABLE
182 };
183
184
185 enum ExternalArrayType {
186   kExternalInt8Array = 1,
187   kExternalUint8Array,
188   kExternalInt16Array,
189   kExternalUint16Array,
190   kExternalInt32Array,
191   kExternalUint32Array,
192   kExternalFloat32Array,
193   kExternalFloat64Array,
194   kExternalUint8ClampedArray,
195 };
196
197
198 static const int kGrowICDelta = STORE_AND_GROW_NO_TRANSITION -
199     STANDARD_STORE;
200 STATIC_ASSERT(STANDARD_STORE == 0);
201 STATIC_ASSERT(kGrowICDelta ==
202               STORE_AND_GROW_TRANSITION_SMI_TO_OBJECT -
203               STORE_TRANSITION_SMI_TO_OBJECT);
204 STATIC_ASSERT(kGrowICDelta ==
205               STORE_AND_GROW_TRANSITION_SMI_TO_DOUBLE -
206               STORE_TRANSITION_SMI_TO_DOUBLE);
207 STATIC_ASSERT(kGrowICDelta ==
208               STORE_AND_GROW_TRANSITION_DOUBLE_TO_OBJECT -
209               STORE_TRANSITION_DOUBLE_TO_OBJECT);
210
211
212 static inline KeyedAccessStoreMode GetGrowStoreMode(
213     KeyedAccessStoreMode store_mode) {
214   if (store_mode < STORE_AND_GROW_NO_TRANSITION) {
215     store_mode = static_cast<KeyedAccessStoreMode>(
216         static_cast<int>(store_mode) + kGrowICDelta);
217   }
218   return store_mode;
219 }
220
221
222 static inline bool IsTransitionStoreMode(KeyedAccessStoreMode store_mode) {
223   return store_mode > STANDARD_STORE &&
224       store_mode <= STORE_AND_GROW_TRANSITION_HOLEY_DOUBLE_TO_OBJECT &&
225       store_mode != STORE_AND_GROW_NO_TRANSITION;
226 }
227
228
229 static inline KeyedAccessStoreMode GetNonTransitioningStoreMode(
230     KeyedAccessStoreMode store_mode) {
231   if (store_mode >= STORE_NO_TRANSITION_IGNORE_OUT_OF_BOUNDS) {
232     return store_mode;
233   }
234   if (store_mode >= STORE_AND_GROW_NO_TRANSITION) {
235     return STORE_AND_GROW_NO_TRANSITION;
236   }
237   return STANDARD_STORE;
238 }
239
240
241 static inline bool IsGrowStoreMode(KeyedAccessStoreMode store_mode) {
242   return store_mode >= STORE_AND_GROW_NO_TRANSITION &&
243       store_mode <= STORE_AND_GROW_TRANSITION_HOLEY_DOUBLE_TO_OBJECT;
244 }
245
246
247 enum IcCheckType { ELEMENT, PROPERTY };
248
249
250 // SKIP_WRITE_BARRIER skips the write barrier.
251 // UPDATE_WEAK_WRITE_BARRIER skips the marking part of the write barrier and
252 // only performs the generational part.
253 // UPDATE_WRITE_BARRIER is doing the full barrier, marking and generational.
254 enum WriteBarrierMode {
255   SKIP_WRITE_BARRIER,
256   UPDATE_WEAK_WRITE_BARRIER,
257   UPDATE_WRITE_BARRIER
258 };
259
260
261 // Indicates whether a value can be loaded as a constant.
262 enum StoreMode { ALLOW_IN_DESCRIPTOR, FORCE_FIELD };
263
264
265 // PropertyNormalizationMode is used to specify whether to keep
266 // inobject properties when normalizing properties of a JSObject.
267 enum PropertyNormalizationMode {
268   CLEAR_INOBJECT_PROPERTIES,
269   KEEP_INOBJECT_PROPERTIES
270 };
271
272
273 // Indicates how aggressively the prototype should be optimized. FAST_PROTOTYPE
274 // will give the fastest result by tailoring the map to the prototype, but that
275 // will cause polymorphism with other objects. REGULAR_PROTOTYPE is to be used
276 // (at least for now) when dynamically modifying the prototype chain of an
277 // object using __proto__ or Object.setPrototypeOf.
278 enum PrototypeOptimizationMode { REGULAR_PROTOTYPE, FAST_PROTOTYPE };
279
280
281 // Indicates whether transitions can be added to a source map or not.
282 enum TransitionFlag {
283   INSERT_TRANSITION,
284   OMIT_TRANSITION
285 };
286
287
288 // Indicates whether the transition is simple: the target map of the transition
289 // either extends the current map with a new property, or it modifies the
290 // property that was added last to the current map.
291 enum SimpleTransitionFlag {
292   SIMPLE_PROPERTY_TRANSITION,
293   PROPERTY_TRANSITION,
294   SPECIAL_TRANSITION
295 };
296
297
298 // Indicates whether we are only interested in the descriptors of a particular
299 // map, or in all descriptors in the descriptor array.
300 enum DescriptorFlag {
301   ALL_DESCRIPTORS,
302   OWN_DESCRIPTORS
303 };
304
305 // The GC maintains a bit of information, the MarkingParity, which toggles
306 // from odd to even and back every time marking is completed. Incremental
307 // marking can visit an object twice during a marking phase, so algorithms that
308 // that piggy-back on marking can use the parity to ensure that they only
309 // perform an operation on an object once per marking phase: they record the
310 // MarkingParity when they visit an object, and only re-visit the object when it
311 // is marked again and the MarkingParity changes.
312 enum MarkingParity {
313   NO_MARKING_PARITY,
314   ODD_MARKING_PARITY,
315   EVEN_MARKING_PARITY
316 };
317
318 // ICs store extra state in a Code object. The default extra state is
319 // kNoExtraICState.
320 typedef int ExtraICState;
321 static const ExtraICState kNoExtraICState = 0;
322
323 // Instance size sentinel for objects of variable size.
324 const int kVariableSizeSentinel = 0;
325
326 // We may store the unsigned bit field as signed Smi value and do not
327 // use the sign bit.
328 const int kStubMajorKeyBits = 7;
329 const int kStubMinorKeyBits = kSmiValueSize - kStubMajorKeyBits - 1;
330
331 // All Maps have a field instance_type containing a InstanceType.
332 // It describes the type of the instances.
333 //
334 // As an example, a JavaScript object is a heap object and its map
335 // instance_type is JS_OBJECT_TYPE.
336 //
337 // The names of the string instance types are intended to systematically
338 // mirror their encoding in the instance_type field of the map.  The default
339 // encoding is considered TWO_BYTE.  It is not mentioned in the name.  ONE_BYTE
340 // encoding is mentioned explicitly in the name.  Likewise, the default
341 // representation is considered sequential.  It is not mentioned in the
342 // name.  The other representations (e.g. CONS, EXTERNAL) are explicitly
343 // mentioned.  Finally, the string is either a STRING_TYPE (if it is a normal
344 // string) or a INTERNALIZED_STRING_TYPE (if it is a internalized string).
345 //
346 // NOTE: The following things are some that depend on the string types having
347 // instance_types that are less than those of all other types:
348 // HeapObject::Size, HeapObject::IterateBody, the typeof operator, and
349 // Object::IsString.
350 //
351 // NOTE: Everything following JS_VALUE_TYPE is considered a
352 // JSObject for GC purposes. The first four entries here have typeof
353 // 'object', whereas JS_FUNCTION_TYPE has typeof 'function'.
354 #define INSTANCE_TYPE_LIST(V)                                   \
355   V(STRING_TYPE)                                                \
356   V(ONE_BYTE_STRING_TYPE)                                       \
357   V(CONS_STRING_TYPE)                                           \
358   V(CONS_ONE_BYTE_STRING_TYPE)                                  \
359   V(SLICED_STRING_TYPE)                                         \
360   V(SLICED_ONE_BYTE_STRING_TYPE)                                \
361   V(EXTERNAL_STRING_TYPE)                                       \
362   V(EXTERNAL_ONE_BYTE_STRING_TYPE)                              \
363   V(EXTERNAL_STRING_WITH_ONE_BYTE_DATA_TYPE)                    \
364   V(SHORT_EXTERNAL_STRING_TYPE)                                 \
365   V(SHORT_EXTERNAL_ONE_BYTE_STRING_TYPE)                        \
366   V(SHORT_EXTERNAL_STRING_WITH_ONE_BYTE_DATA_TYPE)              \
367                                                                 \
368   V(INTERNALIZED_STRING_TYPE)                                   \
369   V(ONE_BYTE_INTERNALIZED_STRING_TYPE)                          \
370   V(EXTERNAL_INTERNALIZED_STRING_TYPE)                          \
371   V(EXTERNAL_ONE_BYTE_INTERNALIZED_STRING_TYPE)                 \
372   V(EXTERNAL_INTERNALIZED_STRING_WITH_ONE_BYTE_DATA_TYPE)       \
373   V(SHORT_EXTERNAL_INTERNALIZED_STRING_TYPE)                    \
374   V(SHORT_EXTERNAL_ONE_BYTE_INTERNALIZED_STRING_TYPE)           \
375   V(SHORT_EXTERNAL_INTERNALIZED_STRING_WITH_ONE_BYTE_DATA_TYPE) \
376                                                                 \
377   V(SYMBOL_TYPE)                                                \
378   V(SIMD128_VALUE_TYPE)                                         \
379                                                                 \
380   V(MAP_TYPE)                                                   \
381   V(CODE_TYPE)                                                  \
382   V(ODDBALL_TYPE)                                               \
383   V(CELL_TYPE)                                                  \
384   V(PROPERTY_CELL_TYPE)                                         \
385                                                                 \
386   V(HEAP_NUMBER_TYPE)                                           \
387   V(MUTABLE_HEAP_NUMBER_TYPE)                                   \
388   V(FOREIGN_TYPE)                                               \
389   V(BYTE_ARRAY_TYPE)                                            \
390   V(BYTECODE_ARRAY_TYPE)                                        \
391   V(FREE_SPACE_TYPE)                                            \
392                                                                 \
393   V(FIXED_INT8_ARRAY_TYPE)                                      \
394   V(FIXED_UINT8_ARRAY_TYPE)                                     \
395   V(FIXED_INT16_ARRAY_TYPE)                                     \
396   V(FIXED_UINT16_ARRAY_TYPE)                                    \
397   V(FIXED_INT32_ARRAY_TYPE)                                     \
398   V(FIXED_UINT32_ARRAY_TYPE)                                    \
399   V(FIXED_FLOAT32_ARRAY_TYPE)                                   \
400   V(FIXED_FLOAT64_ARRAY_TYPE)                                   \
401   V(FIXED_UINT8_CLAMPED_ARRAY_TYPE)                             \
402                                                                 \
403   V(FILLER_TYPE)                                                \
404                                                                 \
405   V(DECLARED_ACCESSOR_DESCRIPTOR_TYPE)                          \
406   V(DECLARED_ACCESSOR_INFO_TYPE)                                \
407   V(EXECUTABLE_ACCESSOR_INFO_TYPE)                              \
408   V(ACCESSOR_PAIR_TYPE)                                         \
409   V(ACCESS_CHECK_INFO_TYPE)                                     \
410   V(INTERCEPTOR_INFO_TYPE)                                      \
411   V(CALL_HANDLER_INFO_TYPE)                                     \
412   V(FUNCTION_TEMPLATE_INFO_TYPE)                                \
413   V(OBJECT_TEMPLATE_INFO_TYPE)                                  \
414   V(SIGNATURE_INFO_TYPE)                                        \
415   V(TYPE_SWITCH_INFO_TYPE)                                      \
416   V(ALLOCATION_MEMENTO_TYPE)                                    \
417   V(ALLOCATION_SITE_TYPE)                                       \
418   V(SCRIPT_TYPE)                                                \
419   V(CODE_CACHE_TYPE)                                            \
420   V(POLYMORPHIC_CODE_CACHE_TYPE)                                \
421   V(TYPE_FEEDBACK_INFO_TYPE)                                    \
422   V(ALIASED_ARGUMENTS_ENTRY_TYPE)                               \
423   V(BOX_TYPE)                                                   \
424   V(PROTOTYPE_INFO_TYPE)                                        \
425                                                                 \
426   V(FIXED_ARRAY_TYPE)                                           \
427   V(FIXED_DOUBLE_ARRAY_TYPE)                                    \
428   V(SHARED_FUNCTION_INFO_TYPE)                                  \
429   V(WEAK_CELL_TYPE)                                             \
430                                                                 \
431   V(JS_MESSAGE_OBJECT_TYPE)                                     \
432                                                                 \
433   V(JS_VALUE_TYPE)                                              \
434   V(JS_DATE_TYPE)                                               \
435   V(JS_OBJECT_TYPE)                                             \
436   V(JS_CONTEXT_EXTENSION_OBJECT_TYPE)                           \
437   V(JS_GENERATOR_OBJECT_TYPE)                                   \
438   V(JS_MODULE_TYPE)                                             \
439   V(JS_GLOBAL_OBJECT_TYPE)                                      \
440   V(JS_BUILTINS_OBJECT_TYPE)                                    \
441   V(JS_GLOBAL_PROXY_TYPE)                                       \
442   V(JS_ARRAY_TYPE)                                              \
443   V(JS_ARRAY_BUFFER_TYPE)                                       \
444   V(JS_TYPED_ARRAY_TYPE)                                        \
445   V(JS_DATA_VIEW_TYPE)                                          \
446   V(JS_PROXY_TYPE)                                              \
447   V(JS_SET_TYPE)                                                \
448   V(JS_MAP_TYPE)                                                \
449   V(JS_SET_ITERATOR_TYPE)                                       \
450   V(JS_MAP_ITERATOR_TYPE)                                       \
451   V(JS_WEAK_MAP_TYPE)                                           \
452   V(JS_WEAK_SET_TYPE)                                           \
453   V(JS_REGEXP_TYPE)                                             \
454                                                                 \
455   V(JS_FUNCTION_TYPE)                                           \
456   V(JS_FUNCTION_PROXY_TYPE)                                     \
457   V(DEBUG_INFO_TYPE)                                            \
458   V(BREAK_POINT_INFO_TYPE)
459
460
461 // Since string types are not consecutive, this macro is used to
462 // iterate over them.
463 #define STRING_TYPE_LIST(V)                                                   \
464   V(STRING_TYPE, kVariableSizeSentinel, string, String)                       \
465   V(ONE_BYTE_STRING_TYPE, kVariableSizeSentinel, one_byte_string,             \
466     OneByteString)                                                            \
467   V(CONS_STRING_TYPE, ConsString::kSize, cons_string, ConsString)             \
468   V(CONS_ONE_BYTE_STRING_TYPE, ConsString::kSize, cons_one_byte_string,       \
469     ConsOneByteString)                                                        \
470   V(SLICED_STRING_TYPE, SlicedString::kSize, sliced_string, SlicedString)     \
471   V(SLICED_ONE_BYTE_STRING_TYPE, SlicedString::kSize, sliced_one_byte_string, \
472     SlicedOneByteString)                                                      \
473   V(EXTERNAL_STRING_TYPE, ExternalTwoByteString::kSize, external_string,      \
474     ExternalString)                                                           \
475   V(EXTERNAL_ONE_BYTE_STRING_TYPE, ExternalOneByteString::kSize,              \
476     external_one_byte_string, ExternalOneByteString)                          \
477   V(EXTERNAL_STRING_WITH_ONE_BYTE_DATA_TYPE, ExternalTwoByteString::kSize,    \
478     external_string_with_one_byte_data, ExternalStringWithOneByteData)        \
479   V(SHORT_EXTERNAL_STRING_TYPE, ExternalTwoByteString::kShortSize,            \
480     short_external_string, ShortExternalString)                               \
481   V(SHORT_EXTERNAL_ONE_BYTE_STRING_TYPE, ExternalOneByteString::kShortSize,   \
482     short_external_one_byte_string, ShortExternalOneByteString)               \
483   V(SHORT_EXTERNAL_STRING_WITH_ONE_BYTE_DATA_TYPE,                            \
484     ExternalTwoByteString::kShortSize,                                        \
485     short_external_string_with_one_byte_data,                                 \
486     ShortExternalStringWithOneByteData)                                       \
487                                                                               \
488   V(INTERNALIZED_STRING_TYPE, kVariableSizeSentinel, internalized_string,     \
489     InternalizedString)                                                       \
490   V(ONE_BYTE_INTERNALIZED_STRING_TYPE, kVariableSizeSentinel,                 \
491     one_byte_internalized_string, OneByteInternalizedString)                  \
492   V(EXTERNAL_INTERNALIZED_STRING_TYPE, ExternalTwoByteString::kSize,          \
493     external_internalized_string, ExternalInternalizedString)                 \
494   V(EXTERNAL_ONE_BYTE_INTERNALIZED_STRING_TYPE, ExternalOneByteString::kSize, \
495     external_one_byte_internalized_string, ExternalOneByteInternalizedString) \
496   V(EXTERNAL_INTERNALIZED_STRING_WITH_ONE_BYTE_DATA_TYPE,                     \
497     ExternalTwoByteString::kSize,                                             \
498     external_internalized_string_with_one_byte_data,                          \
499     ExternalInternalizedStringWithOneByteData)                                \
500   V(SHORT_EXTERNAL_INTERNALIZED_STRING_TYPE,                                  \
501     ExternalTwoByteString::kShortSize, short_external_internalized_string,    \
502     ShortExternalInternalizedString)                                          \
503   V(SHORT_EXTERNAL_ONE_BYTE_INTERNALIZED_STRING_TYPE,                         \
504     ExternalOneByteString::kShortSize,                                        \
505     short_external_one_byte_internalized_string,                              \
506     ShortExternalOneByteInternalizedString)                                   \
507   V(SHORT_EXTERNAL_INTERNALIZED_STRING_WITH_ONE_BYTE_DATA_TYPE,               \
508     ExternalTwoByteString::kShortSize,                                        \
509     short_external_internalized_string_with_one_byte_data,                    \
510     ShortExternalInternalizedStringWithOneByteData)
511
512 // A struct is a simple object a set of object-valued fields.  Including an
513 // object type in this causes the compiler to generate most of the boilerplate
514 // code for the class including allocation and garbage collection routines,
515 // casts and predicates.  All you need to define is the class, methods and
516 // object verification routines.  Easy, no?
517 //
518 // Note that for subtle reasons related to the ordering or numerical values of
519 // type tags, elements in this list have to be added to the INSTANCE_TYPE_LIST
520 // manually.
521 #define STRUCT_LIST(V)                                                       \
522   V(BOX, Box, box)                                                           \
523   V(EXECUTABLE_ACCESSOR_INFO, ExecutableAccessorInfo,                        \
524     executable_accessor_info)                                                \
525   V(ACCESSOR_PAIR, AccessorPair, accessor_pair)                              \
526   V(ACCESS_CHECK_INFO, AccessCheckInfo, access_check_info)                   \
527   V(INTERCEPTOR_INFO, InterceptorInfo, interceptor_info)                     \
528   V(CALL_HANDLER_INFO, CallHandlerInfo, call_handler_info)                   \
529   V(FUNCTION_TEMPLATE_INFO, FunctionTemplateInfo, function_template_info)    \
530   V(OBJECT_TEMPLATE_INFO, ObjectTemplateInfo, object_template_info)          \
531   V(TYPE_SWITCH_INFO, TypeSwitchInfo, type_switch_info)                      \
532   V(SCRIPT, Script, script)                                                  \
533   V(ALLOCATION_SITE, AllocationSite, allocation_site)                        \
534   V(ALLOCATION_MEMENTO, AllocationMemento, allocation_memento)               \
535   V(CODE_CACHE, CodeCache, code_cache)                                       \
536   V(POLYMORPHIC_CODE_CACHE, PolymorphicCodeCache, polymorphic_code_cache)    \
537   V(TYPE_FEEDBACK_INFO, TypeFeedbackInfo, type_feedback_info)                \
538   V(ALIASED_ARGUMENTS_ENTRY, AliasedArgumentsEntry, aliased_arguments_entry) \
539   V(DEBUG_INFO, DebugInfo, debug_info)                                       \
540   V(BREAK_POINT_INFO, BreakPointInfo, break_point_info)                      \
541   V(PROTOTYPE_INFO, PrototypeInfo, prototype_info)
542
543 // We use the full 8 bits of the instance_type field to encode heap object
544 // instance types.  The high-order bit (bit 7) is set if the object is not a
545 // string, and cleared if it is a string.
546 const uint32_t kIsNotStringMask = 0x80;
547 const uint32_t kStringTag = 0x0;
548 const uint32_t kNotStringTag = 0x80;
549
550 // Bit 6 indicates that the object is an internalized string (if set) or not.
551 // Bit 7 has to be clear as well.
552 const uint32_t kIsNotInternalizedMask = 0x40;
553 const uint32_t kNotInternalizedTag = 0x40;
554 const uint32_t kInternalizedTag = 0x0;
555
556 // If bit 7 is clear then bit 2 indicates whether the string consists of
557 // two-byte characters or one-byte characters.
558 const uint32_t kStringEncodingMask = 0x4;
559 const uint32_t kTwoByteStringTag = 0x0;
560 const uint32_t kOneByteStringTag = 0x4;
561
562 // If bit 7 is clear, the low-order 2 bits indicate the representation
563 // of the string.
564 const uint32_t kStringRepresentationMask = 0x03;
565 enum StringRepresentationTag {
566   kSeqStringTag = 0x0,
567   kConsStringTag = 0x1,
568   kExternalStringTag = 0x2,
569   kSlicedStringTag = 0x3
570 };
571 const uint32_t kIsIndirectStringMask = 0x1;
572 const uint32_t kIsIndirectStringTag = 0x1;
573 STATIC_ASSERT((kSeqStringTag & kIsIndirectStringMask) == 0);  // NOLINT
574 STATIC_ASSERT((kExternalStringTag & kIsIndirectStringMask) == 0);  // NOLINT
575 STATIC_ASSERT((kConsStringTag &
576                kIsIndirectStringMask) == kIsIndirectStringTag);  // NOLINT
577 STATIC_ASSERT((kSlicedStringTag &
578                kIsIndirectStringMask) == kIsIndirectStringTag);  // NOLINT
579
580 // Use this mask to distinguish between cons and slice only after making
581 // sure that the string is one of the two (an indirect string).
582 const uint32_t kSlicedNotConsMask = kSlicedStringTag & ~kConsStringTag;
583 STATIC_ASSERT(IS_POWER_OF_TWO(kSlicedNotConsMask));
584
585 // If bit 7 is clear, then bit 3 indicates whether this two-byte
586 // string actually contains one byte data.
587 const uint32_t kOneByteDataHintMask = 0x08;
588 const uint32_t kOneByteDataHintTag = 0x08;
589
590 // If bit 7 is clear and string representation indicates an external string,
591 // then bit 4 indicates whether the data pointer is cached.
592 const uint32_t kShortExternalStringMask = 0x10;
593 const uint32_t kShortExternalStringTag = 0x10;
594
595
596 // A ConsString with an empty string as the right side is a candidate
597 // for being shortcut by the garbage collector. We don't allocate any
598 // non-flat internalized strings, so we do not shortcut them thereby
599 // avoiding turning internalized strings into strings. The bit-masks
600 // below contain the internalized bit as additional safety.
601 // See heap.cc, mark-compact.cc and objects-visiting.cc.
602 const uint32_t kShortcutTypeMask =
603     kIsNotStringMask |
604     kIsNotInternalizedMask |
605     kStringRepresentationMask;
606 const uint32_t kShortcutTypeTag = kConsStringTag | kNotInternalizedTag;
607
608 static inline bool IsShortcutCandidate(int type) {
609   return ((type & kShortcutTypeMask) == kShortcutTypeTag);
610 }
611
612
613 enum InstanceType {
614   // String types.
615   INTERNALIZED_STRING_TYPE = kTwoByteStringTag | kSeqStringTag |
616                              kInternalizedTag,  // FIRST_PRIMITIVE_TYPE
617   ONE_BYTE_INTERNALIZED_STRING_TYPE =
618       kOneByteStringTag | kSeqStringTag | kInternalizedTag,
619   EXTERNAL_INTERNALIZED_STRING_TYPE =
620       kTwoByteStringTag | kExternalStringTag | kInternalizedTag,
621   EXTERNAL_ONE_BYTE_INTERNALIZED_STRING_TYPE =
622       kOneByteStringTag | kExternalStringTag | kInternalizedTag,
623   EXTERNAL_INTERNALIZED_STRING_WITH_ONE_BYTE_DATA_TYPE =
624       EXTERNAL_INTERNALIZED_STRING_TYPE | kOneByteDataHintTag |
625       kInternalizedTag,
626   SHORT_EXTERNAL_INTERNALIZED_STRING_TYPE = EXTERNAL_INTERNALIZED_STRING_TYPE |
627                                             kShortExternalStringTag |
628                                             kInternalizedTag,
629   SHORT_EXTERNAL_ONE_BYTE_INTERNALIZED_STRING_TYPE =
630       EXTERNAL_ONE_BYTE_INTERNALIZED_STRING_TYPE | kShortExternalStringTag |
631       kInternalizedTag,
632   SHORT_EXTERNAL_INTERNALIZED_STRING_WITH_ONE_BYTE_DATA_TYPE =
633       EXTERNAL_INTERNALIZED_STRING_WITH_ONE_BYTE_DATA_TYPE |
634       kShortExternalStringTag | kInternalizedTag,
635   STRING_TYPE = INTERNALIZED_STRING_TYPE | kNotInternalizedTag,
636   ONE_BYTE_STRING_TYPE =
637       ONE_BYTE_INTERNALIZED_STRING_TYPE | kNotInternalizedTag,
638   CONS_STRING_TYPE = kTwoByteStringTag | kConsStringTag | kNotInternalizedTag,
639   CONS_ONE_BYTE_STRING_TYPE =
640       kOneByteStringTag | kConsStringTag | kNotInternalizedTag,
641   SLICED_STRING_TYPE =
642       kTwoByteStringTag | kSlicedStringTag | kNotInternalizedTag,
643   SLICED_ONE_BYTE_STRING_TYPE =
644       kOneByteStringTag | kSlicedStringTag | kNotInternalizedTag,
645   EXTERNAL_STRING_TYPE =
646       EXTERNAL_INTERNALIZED_STRING_TYPE | kNotInternalizedTag,
647   EXTERNAL_ONE_BYTE_STRING_TYPE =
648       EXTERNAL_ONE_BYTE_INTERNALIZED_STRING_TYPE | kNotInternalizedTag,
649   EXTERNAL_STRING_WITH_ONE_BYTE_DATA_TYPE =
650       EXTERNAL_INTERNALIZED_STRING_WITH_ONE_BYTE_DATA_TYPE |
651       kNotInternalizedTag,
652   SHORT_EXTERNAL_STRING_TYPE =
653       SHORT_EXTERNAL_INTERNALIZED_STRING_TYPE | kNotInternalizedTag,
654   SHORT_EXTERNAL_ONE_BYTE_STRING_TYPE =
655       SHORT_EXTERNAL_ONE_BYTE_INTERNALIZED_STRING_TYPE | kNotInternalizedTag,
656   SHORT_EXTERNAL_STRING_WITH_ONE_BYTE_DATA_TYPE =
657       SHORT_EXTERNAL_INTERNALIZED_STRING_WITH_ONE_BYTE_DATA_TYPE |
658       kNotInternalizedTag,
659
660   // Non-string names
661   SYMBOL_TYPE = kNotStringTag,  // FIRST_NONSTRING_TYPE, LAST_NAME_TYPE
662
663   // Other primitives (cannot contain non-map-word pointers to heap objects).
664   HEAP_NUMBER_TYPE,
665   SIMD128_VALUE_TYPE,
666   ODDBALL_TYPE,  // LAST_PRIMITIVE_TYPE
667
668   // Objects allocated in their own spaces (never in new space).
669   MAP_TYPE,
670   CODE_TYPE,
671
672   // "Data", objects that cannot contain non-map-word pointers to heap
673   // objects.
674   MUTABLE_HEAP_NUMBER_TYPE,
675   FOREIGN_TYPE,
676   BYTE_ARRAY_TYPE,
677   BYTECODE_ARRAY_TYPE,
678   FREE_SPACE_TYPE,
679   FIXED_INT8_ARRAY_TYPE,  // FIRST_FIXED_TYPED_ARRAY_TYPE
680   FIXED_UINT8_ARRAY_TYPE,
681   FIXED_INT16_ARRAY_TYPE,
682   FIXED_UINT16_ARRAY_TYPE,
683   FIXED_INT32_ARRAY_TYPE,
684   FIXED_UINT32_ARRAY_TYPE,
685   FIXED_FLOAT32_ARRAY_TYPE,
686   FIXED_FLOAT64_ARRAY_TYPE,
687   FIXED_UINT8_CLAMPED_ARRAY_TYPE,  // LAST_FIXED_TYPED_ARRAY_TYPE
688   FIXED_DOUBLE_ARRAY_TYPE,
689   FILLER_TYPE,  // LAST_DATA_TYPE
690
691   // Structs.
692   DECLARED_ACCESSOR_DESCRIPTOR_TYPE,
693   DECLARED_ACCESSOR_INFO_TYPE,
694   EXECUTABLE_ACCESSOR_INFO_TYPE,
695   ACCESSOR_PAIR_TYPE,
696   ACCESS_CHECK_INFO_TYPE,
697   INTERCEPTOR_INFO_TYPE,
698   CALL_HANDLER_INFO_TYPE,
699   FUNCTION_TEMPLATE_INFO_TYPE,
700   OBJECT_TEMPLATE_INFO_TYPE,
701   SIGNATURE_INFO_TYPE,
702   TYPE_SWITCH_INFO_TYPE,
703   ALLOCATION_SITE_TYPE,
704   ALLOCATION_MEMENTO_TYPE,
705   SCRIPT_TYPE,
706   CODE_CACHE_TYPE,
707   POLYMORPHIC_CODE_CACHE_TYPE,
708   TYPE_FEEDBACK_INFO_TYPE,
709   ALIASED_ARGUMENTS_ENTRY_TYPE,
710   BOX_TYPE,
711   DEBUG_INFO_TYPE,
712   BREAK_POINT_INFO_TYPE,
713   FIXED_ARRAY_TYPE,
714   SHARED_FUNCTION_INFO_TYPE,
715   CELL_TYPE,
716   WEAK_CELL_TYPE,
717   PROPERTY_CELL_TYPE,
718   PROTOTYPE_INFO_TYPE,
719
720   // All the following types are subtypes of JSReceiver, which corresponds to
721   // objects in the JS sense. The first and the last type in this range are
722   // the two forms of function. This organization enables using the same
723   // compares for checking the JS_RECEIVER/SPEC_OBJECT range and the
724   // NONCALLABLE_JS_OBJECT range.
725   JS_FUNCTION_PROXY_TYPE,  // FIRST_JS_RECEIVER_TYPE, FIRST_JS_PROXY_TYPE
726   JS_PROXY_TYPE,           // LAST_JS_PROXY_TYPE
727   JS_VALUE_TYPE,           // FIRST_JS_OBJECT_TYPE
728   JS_MESSAGE_OBJECT_TYPE,
729   JS_DATE_TYPE,
730   JS_OBJECT_TYPE,
731   JS_CONTEXT_EXTENSION_OBJECT_TYPE,
732   JS_GENERATOR_OBJECT_TYPE,
733   JS_MODULE_TYPE,
734   JS_GLOBAL_OBJECT_TYPE,
735   JS_BUILTINS_OBJECT_TYPE,
736   JS_GLOBAL_PROXY_TYPE,
737   JS_ARRAY_TYPE,
738   JS_ARRAY_BUFFER_TYPE,
739   JS_TYPED_ARRAY_TYPE,
740   JS_DATA_VIEW_TYPE,
741   JS_SET_TYPE,
742   JS_MAP_TYPE,
743   JS_SET_ITERATOR_TYPE,
744   JS_MAP_ITERATOR_TYPE,
745   JS_WEAK_MAP_TYPE,
746   JS_WEAK_SET_TYPE,
747   JS_REGEXP_TYPE,
748   JS_FUNCTION_TYPE,  // LAST_JS_OBJECT_TYPE, LAST_JS_RECEIVER_TYPE
749
750   // Pseudo-types
751   FIRST_TYPE = 0x0,
752   LAST_TYPE = JS_FUNCTION_TYPE,
753   FIRST_NAME_TYPE = FIRST_TYPE,
754   LAST_NAME_TYPE = SYMBOL_TYPE,
755   FIRST_UNIQUE_NAME_TYPE = INTERNALIZED_STRING_TYPE,
756   LAST_UNIQUE_NAME_TYPE = SYMBOL_TYPE,
757   FIRST_NONSTRING_TYPE = SYMBOL_TYPE,
758   FIRST_PRIMITIVE_TYPE = FIRST_NAME_TYPE,
759   LAST_PRIMITIVE_TYPE = ODDBALL_TYPE,
760   // Boundaries for testing for a fixed typed array.
761   FIRST_FIXED_TYPED_ARRAY_TYPE = FIXED_INT8_ARRAY_TYPE,
762   LAST_FIXED_TYPED_ARRAY_TYPE = FIXED_UINT8_CLAMPED_ARRAY_TYPE,
763   // Boundary for promotion to old space.
764   LAST_DATA_TYPE = FILLER_TYPE,
765   // Boundary for objects represented as JSReceiver (i.e. JSObject or JSProxy).
766   // Note that there is no range for JSObject or JSProxy, since their subtypes
767   // are not continuous in this enum! The enum ranges instead reflect the
768   // external class names, where proxies are treated as either ordinary objects,
769   // or functions.
770   FIRST_JS_RECEIVER_TYPE = JS_FUNCTION_PROXY_TYPE,
771   LAST_JS_RECEIVER_TYPE = LAST_TYPE,
772   // Boundaries for testing the types represented as JSObject
773   FIRST_JS_OBJECT_TYPE = JS_VALUE_TYPE,
774   LAST_JS_OBJECT_TYPE = LAST_TYPE,
775   // Boundaries for testing the types represented as JSProxy
776   FIRST_JS_PROXY_TYPE = JS_FUNCTION_PROXY_TYPE,
777   LAST_JS_PROXY_TYPE = JS_PROXY_TYPE,
778   // Boundaries for testing whether the type is a JavaScript object.
779   FIRST_SPEC_OBJECT_TYPE = FIRST_JS_RECEIVER_TYPE,
780   LAST_SPEC_OBJECT_TYPE = LAST_JS_RECEIVER_TYPE,
781   // Boundaries for testing the types for which typeof is "object".
782   FIRST_NONCALLABLE_SPEC_OBJECT_TYPE = JS_PROXY_TYPE,
783   LAST_NONCALLABLE_SPEC_OBJECT_TYPE = JS_REGEXP_TYPE,
784   // Note that the types for which typeof is "function" are not continuous.
785   // Define this so that we can put assertions on discrete checks.
786   NUM_OF_CALLABLE_SPEC_OBJECT_TYPES = 2
787 };
788
789 STATIC_ASSERT(JS_OBJECT_TYPE == Internals::kJSObjectType);
790 STATIC_ASSERT(FIRST_NONSTRING_TYPE == Internals::kFirstNonstringType);
791 STATIC_ASSERT(ODDBALL_TYPE == Internals::kOddballType);
792 STATIC_ASSERT(FOREIGN_TYPE == Internals::kForeignType);
793
794
795 #define FIXED_ARRAY_SUB_INSTANCE_TYPE_LIST(V) \
796   V(FAST_ELEMENTS_SUB_TYPE)                   \
797   V(DICTIONARY_ELEMENTS_SUB_TYPE)             \
798   V(FAST_PROPERTIES_SUB_TYPE)                 \
799   V(DICTIONARY_PROPERTIES_SUB_TYPE)           \
800   V(MAP_CODE_CACHE_SUB_TYPE)                  \
801   V(SCOPE_INFO_SUB_TYPE)                      \
802   V(STRING_TABLE_SUB_TYPE)                    \
803   V(DESCRIPTOR_ARRAY_SUB_TYPE)                \
804   V(TRANSITION_ARRAY_SUB_TYPE)
805
806 enum FixedArraySubInstanceType {
807 #define DEFINE_FIXED_ARRAY_SUB_INSTANCE_TYPE(name) name,
808   FIXED_ARRAY_SUB_INSTANCE_TYPE_LIST(DEFINE_FIXED_ARRAY_SUB_INSTANCE_TYPE)
809 #undef DEFINE_FIXED_ARRAY_SUB_INSTANCE_TYPE
810   LAST_FIXED_ARRAY_SUB_TYPE = TRANSITION_ARRAY_SUB_TYPE
811 };
812
813
814 enum CompareResult {
815   LESS      = -1,
816   EQUAL     =  0,
817   GREATER   =  1,
818
819   NOT_EQUAL = GREATER
820 };
821
822
823 #define DECL_BOOLEAN_ACCESSORS(name)   \
824   inline bool name() const;            \
825   inline void set_##name(bool value);  \
826
827
828 #define DECL_ACCESSORS(name, type)                                      \
829   inline type* name() const;                                            \
830   inline void set_##name(type* value,                                   \
831                          WriteBarrierMode mode = UPDATE_WRITE_BARRIER); \
832
833
834 #define DECLARE_CAST(type)                              \
835   INLINE(static type* cast(Object* object));            \
836   INLINE(static const type* cast(const Object* object));
837
838
839 class AccessorPair;
840 class AllocationSite;
841 class AllocationSiteCreationContext;
842 class AllocationSiteUsageContext;
843 class Cell;
844 class ConsString;
845 class ElementsAccessor;
846 class FixedArrayBase;
847 class FunctionLiteral;
848 class GlobalObject;
849 class JSBuiltinsObject;
850 class LayoutDescriptor;
851 class LookupIterator;
852 class ObjectHashTable;
853 class ObjectVisitor;
854 class PropertyCell;
855 class SafepointEntry;
856 class SharedFunctionInfo;
857 class StringStream;
858 class TypeFeedbackInfo;
859 class TypeFeedbackVector;
860 class WeakCell;
861
862 // We cannot just say "class HeapType;" if it is created from a template... =8-?
863 template<class> class TypeImpl;
864 struct HeapTypeConfig;
865 typedef TypeImpl<HeapTypeConfig> HeapType;
866
867
868 // A template-ized version of the IsXXX functions.
869 template <class C> inline bool Is(Object* obj);
870
871 #ifdef VERIFY_HEAP
872 #define DECLARE_VERIFIER(Name) void Name##Verify();
873 #else
874 #define DECLARE_VERIFIER(Name)
875 #endif
876
877 #ifdef OBJECT_PRINT
878 #define DECLARE_PRINTER(Name) void Name##Print(std::ostream& os);  // NOLINT
879 #else
880 #define DECLARE_PRINTER(Name)
881 #endif
882
883
884 #define OBJECT_TYPE_LIST(V) \
885   V(Smi)                    \
886   V(HeapObject)             \
887   V(Number)
888
889 #define HEAP_OBJECT_TYPE_LIST(V)   \
890   V(HeapNumber)                    \
891   V(MutableHeapNumber)             \
892   V(Simd128Value)                  \
893   V(Float32x4)                     \
894   V(Int32x4)                       \
895   V(Bool32x4)                      \
896   V(Int16x8)                       \
897   V(Bool16x8)                      \
898   V(Int8x16)                       \
899   V(Bool8x16)                      \
900   V(Name)                          \
901   V(UniqueName)                    \
902   V(String)                        \
903   V(SeqString)                     \
904   V(ExternalString)                \
905   V(ConsString)                    \
906   V(SlicedString)                  \
907   V(ExternalTwoByteString)         \
908   V(ExternalOneByteString)         \
909   V(SeqTwoByteString)              \
910   V(SeqOneByteString)              \
911   V(InternalizedString)            \
912   V(Symbol)                        \
913                                    \
914   V(FixedTypedArrayBase)           \
915   V(FixedUint8Array)               \
916   V(FixedInt8Array)                \
917   V(FixedUint16Array)              \
918   V(FixedInt16Array)               \
919   V(FixedUint32Array)              \
920   V(FixedInt32Array)               \
921   V(FixedFloat32Array)             \
922   V(FixedFloat64Array)             \
923   V(FixedUint8ClampedArray)        \
924   V(ByteArray)                     \
925   V(BytecodeArray)                 \
926   V(FreeSpace)                     \
927   V(JSReceiver)                    \
928   V(JSObject)                      \
929   V(JSContextExtensionObject)      \
930   V(JSGeneratorObject)             \
931   V(JSModule)                      \
932   V(LayoutDescriptor)              \
933   V(Map)                           \
934   V(DescriptorArray)               \
935   V(TransitionArray)               \
936   V(TypeFeedbackVector)            \
937   V(DeoptimizationInputData)       \
938   V(DeoptimizationOutputData)      \
939   V(DependentCode)                 \
940   V(HandlerTable)                  \
941   V(FixedArray)                    \
942   V(FixedDoubleArray)              \
943   V(WeakFixedArray)                \
944   V(ArrayList)                     \
945   V(Context)                       \
946   V(ScriptContextTable)            \
947   V(NativeContext)                 \
948   V(ScopeInfo)                     \
949   V(JSFunction)                    \
950   V(Code)                          \
951   V(Oddball)                       \
952   V(SharedFunctionInfo)            \
953   V(JSValue)                       \
954   V(JSDate)                        \
955   V(JSMessageObject)               \
956   V(StringWrapper)                 \
957   V(Foreign)                       \
958   V(Boolean)                       \
959   V(JSArray)                       \
960   V(JSArrayBuffer)                 \
961   V(JSArrayBufferView)             \
962   V(JSTypedArray)                  \
963   V(JSDataView)                    \
964   V(JSProxy)                       \
965   V(JSFunctionProxy)               \
966   V(JSSet)                         \
967   V(JSMap)                         \
968   V(JSSetIterator)                 \
969   V(JSMapIterator)                 \
970   V(JSWeakCollection)              \
971   V(JSWeakMap)                     \
972   V(JSWeakSet)                     \
973   V(JSRegExp)                      \
974   V(HashTable)                     \
975   V(Dictionary)                    \
976   V(StringTable)                   \
977   V(NormalizedMapCache)            \
978   V(CompilationCacheTable)         \
979   V(CodeCacheHashTable)            \
980   V(PolymorphicCodeCacheHashTable) \
981   V(MapCache)                      \
982   V(Primitive)                     \
983   V(GlobalObject)                  \
984   V(JSGlobalObject)                \
985   V(JSBuiltinsObject)              \
986   V(JSGlobalProxy)                 \
987   V(UndetectableObject)            \
988   V(AccessCheckNeeded)             \
989   V(Cell)                          \
990   V(PropertyCell)                  \
991   V(WeakCell)                      \
992   V(ObjectHashTable)               \
993   V(WeakHashTable)                 \
994   V(WeakValueHashTable)            \
995   V(OrderedHashTable)
996
997 // Object is the abstract superclass for all classes in the
998 // object hierarchy.
999 // Object does not use any virtual functions to avoid the
1000 // allocation of the C++ vtable.
1001 // Since both Smi and HeapObject are subclasses of Object no
1002 // data members can be present in Object.
1003 class Object {
1004  public:
1005   // Type testing.
1006   bool IsObject() const { return true; }
1007
1008 #define IS_TYPE_FUNCTION_DECL(type_)  INLINE(bool Is##type_() const);
1009   OBJECT_TYPE_LIST(IS_TYPE_FUNCTION_DECL)
1010   HEAP_OBJECT_TYPE_LIST(IS_TYPE_FUNCTION_DECL)
1011 #undef IS_TYPE_FUNCTION_DECL
1012
1013   // A non-keyed store is of the form a.x = foo or a["x"] = foo whereas
1014   // a keyed store is of the form a[expression] = foo.
1015   enum StoreFromKeyed {
1016     MAY_BE_STORE_FROM_KEYED,
1017     CERTAINLY_NOT_STORE_FROM_KEYED
1018   };
1019
1020   INLINE(bool IsFixedArrayBase() const);
1021   INLINE(bool IsExternal() const);
1022   INLINE(bool IsAccessorInfo() const);
1023
1024   INLINE(bool IsStruct() const);
1025 #define DECLARE_STRUCT_PREDICATE(NAME, Name, name) \
1026   INLINE(bool Is##Name() const);
1027   STRUCT_LIST(DECLARE_STRUCT_PREDICATE)
1028 #undef DECLARE_STRUCT_PREDICATE
1029
1030   INLINE(bool IsSpecObject()) const;
1031   INLINE(bool IsSpecFunction()) const;
1032   INLINE(bool IsTemplateInfo()) const;
1033   INLINE(bool IsNameDictionary() const);
1034   INLINE(bool IsGlobalDictionary() const);
1035   INLINE(bool IsSeededNumberDictionary() const);
1036   INLINE(bool IsUnseededNumberDictionary() const);
1037   INLINE(bool IsOrderedHashSet() const);
1038   INLINE(bool IsOrderedHashMap() const);
1039   bool IsCallable() const;
1040   static bool IsPromise(Handle<Object> object);
1041
1042   // Oddball testing.
1043   INLINE(bool IsUndefined() const);
1044   INLINE(bool IsNull() const);
1045   INLINE(bool IsTheHole() const);
1046   INLINE(bool IsException() const);
1047   INLINE(bool IsUninitialized() const);
1048   INLINE(bool IsTrue() const);
1049   INLINE(bool IsFalse() const);
1050   INLINE(bool IsArgumentsMarker() const);
1051
1052   // Filler objects (fillers and free space objects).
1053   INLINE(bool IsFiller() const);
1054
1055   // Extract the number.
1056   inline double Number();
1057   INLINE(bool IsNaN() const);
1058   INLINE(bool IsMinusZero() const);
1059   bool ToInt32(int32_t* value);
1060   bool ToUint32(uint32_t* value);
1061
1062   inline Representation OptimalRepresentation();
1063
1064   inline ElementsKind OptimalElementsKind();
1065
1066   inline bool FitsRepresentation(Representation representation);
1067
1068   // Checks whether two valid primitive encodings of a property name resolve to
1069   // the same logical property. E.g., the smi 1, the string "1" and the double
1070   // 1 all refer to the same property, so this helper will return true.
1071   inline bool KeyEquals(Object* other);
1072
1073   Handle<HeapType> OptimalType(Isolate* isolate, Representation representation);
1074
1075   inline static Handle<Object> NewStorageFor(Isolate* isolate,
1076                                              Handle<Object> object,
1077                                              Representation representation);
1078
1079   inline static Handle<Object> WrapForRead(Isolate* isolate,
1080                                            Handle<Object> object,
1081                                            Representation representation);
1082
1083   // Returns true if the object is of the correct type to be used as a
1084   // implementation of a JSObject's elements.
1085   inline bool HasValidElements();
1086
1087   inline bool HasSpecificClassOf(String* name);
1088
1089   bool BooleanValue();                                      // ECMA-262 9.2.
1090
1091   // ES6 section 7.2.13 Strict Equality Comparison
1092   bool StrictEquals(Object* that);
1093
1094   // Convert to a JSObject if needed.
1095   // native_context is used when creating wrapper object.
1096   static inline MaybeHandle<JSReceiver> ToObject(Isolate* isolate,
1097                                                  Handle<Object> object);
1098   static MaybeHandle<JSReceiver> ToObject(Isolate* isolate,
1099                                           Handle<Object> object,
1100                                           Handle<Context> context);
1101
1102   MUST_USE_RESULT static MaybeHandle<Object> GetProperty(
1103       LookupIterator* it, LanguageMode language_mode = SLOPPY);
1104
1105   // Implementation of [[Put]], ECMA-262 5th edition, section 8.12.5.
1106   MUST_USE_RESULT static MaybeHandle<Object> SetProperty(
1107       Handle<Object> object, Handle<Name> name, Handle<Object> value,
1108       LanguageMode language_mode,
1109       StoreFromKeyed store_mode = MAY_BE_STORE_FROM_KEYED);
1110
1111   MUST_USE_RESULT static MaybeHandle<Object> SetProperty(
1112       LookupIterator* it, Handle<Object> value, LanguageMode language_mode,
1113       StoreFromKeyed store_mode);
1114
1115   MUST_USE_RESULT static MaybeHandle<Object> SetSuperProperty(
1116       LookupIterator* it, Handle<Object> value, LanguageMode language_mode,
1117       StoreFromKeyed store_mode);
1118
1119   MUST_USE_RESULT static MaybeHandle<Object> ReadAbsentProperty(
1120       LookupIterator* it, LanguageMode language_mode);
1121   MUST_USE_RESULT static MaybeHandle<Object> ReadAbsentProperty(
1122       Isolate* isolate, Handle<Object> receiver, Handle<Object> name,
1123       LanguageMode language_mode);
1124   MUST_USE_RESULT static MaybeHandle<Object> WriteToReadOnlyProperty(
1125       LookupIterator* it, Handle<Object> value, LanguageMode language_mode);
1126   MUST_USE_RESULT static MaybeHandle<Object> WriteToReadOnlyProperty(
1127       Isolate* isolate, Handle<Object> receiver, Handle<Object> name,
1128       Handle<Object> value, LanguageMode language_mode);
1129   MUST_USE_RESULT static MaybeHandle<Object> RedefineNonconfigurableProperty(
1130       Isolate* isolate, Handle<Object> name, Handle<Object> value,
1131       LanguageMode language_mode);
1132   MUST_USE_RESULT static MaybeHandle<Object> SetDataProperty(
1133       LookupIterator* it, Handle<Object> value);
1134   MUST_USE_RESULT static MaybeHandle<Object> AddDataProperty(
1135       LookupIterator* it, Handle<Object> value, PropertyAttributes attributes,
1136       LanguageMode language_mode, StoreFromKeyed store_mode);
1137   MUST_USE_RESULT static inline MaybeHandle<Object> GetPropertyOrElement(
1138       Handle<Object> object, Handle<Name> name,
1139       LanguageMode language_mode = SLOPPY);
1140   MUST_USE_RESULT static inline MaybeHandle<Object> GetProperty(
1141       Isolate* isolate, Handle<Object> object, const char* key,
1142       LanguageMode language_mode = SLOPPY);
1143   MUST_USE_RESULT static inline MaybeHandle<Object> GetProperty(
1144       Handle<Object> object, Handle<Name> name,
1145       LanguageMode language_mode = SLOPPY);
1146
1147   MUST_USE_RESULT static MaybeHandle<Object> GetPropertyWithAccessor(
1148       LookupIterator* it, LanguageMode language_mode);
1149   MUST_USE_RESULT static MaybeHandle<Object> SetPropertyWithAccessor(
1150       LookupIterator* it, Handle<Object> value, LanguageMode language_mode);
1151
1152   MUST_USE_RESULT static MaybeHandle<Object> GetPropertyWithDefinedGetter(
1153       Handle<Object> receiver,
1154       Handle<JSReceiver> getter);
1155   MUST_USE_RESULT static MaybeHandle<Object> SetPropertyWithDefinedSetter(
1156       Handle<Object> receiver,
1157       Handle<JSReceiver> setter,
1158       Handle<Object> value);
1159
1160   MUST_USE_RESULT static inline MaybeHandle<Object> GetElement(
1161       Isolate* isolate, Handle<Object> object, uint32_t index,
1162       LanguageMode language_mode = SLOPPY);
1163
1164   MUST_USE_RESULT static inline MaybeHandle<Object> SetElement(
1165       Isolate* isolate, Handle<Object> object, uint32_t index,
1166       Handle<Object> value, LanguageMode language_mode);
1167
1168   static inline Handle<Object> GetPrototypeSkipHiddenPrototypes(
1169       Isolate* isolate, Handle<Object> receiver);
1170
1171   bool HasInPrototypeChain(Isolate* isolate, Object* object);
1172
1173   // Returns the permanent hash code associated with this object. May return
1174   // undefined if not yet created.
1175   Object* GetHash();
1176
1177   // Returns undefined for JSObjects, but returns the hash code for simple
1178   // objects.  This avoids a double lookup in the cases where we know we will
1179   // add the hash to the JSObject if it does not already exist.
1180   Object* GetSimpleHash();
1181
1182   // Returns the permanent hash code associated with this object depending on
1183   // the actual object type. May create and store a hash code if needed and none
1184   // exists.
1185   static Handle<Smi> GetOrCreateHash(Isolate* isolate, Handle<Object> object);
1186
1187   // Checks whether this object has the same value as the given one.  This
1188   // function is implemented according to ES5, section 9.12 and can be used
1189   // to implement the Harmony "egal" function.
1190   bool SameValue(Object* other);
1191
1192   // Checks whether this object has the same value as the given one.
1193   // +0 and -0 are treated equal. Everything else is the same as SameValue.
1194   // This function is implemented according to ES6, section 7.2.4 and is used
1195   // by ES6 Map and Set.
1196   bool SameValueZero(Object* other);
1197
1198   // Tries to convert an object to an array length. Returns true and sets the
1199   // output parameter if it succeeds.
1200   inline bool ToArrayLength(uint32_t* index);
1201
1202   // Tries to convert an object to an array index. Returns true and sets the
1203   // output parameter if it succeeds. Equivalent to ToArrayLength, but does not
1204   // allow kMaxUInt32.
1205   inline bool ToArrayIndex(uint32_t* index);
1206
1207   // Returns true if this is a JSValue containing a string and the index is
1208   // < the length of the string.  Used to implement [] on strings.
1209   inline bool IsStringObjectWithCharacterAt(uint32_t index);
1210
1211   DECLARE_VERIFIER(Object)
1212 #ifdef VERIFY_HEAP
1213   // Verify a pointer is a valid object pointer.
1214   static void VerifyPointer(Object* p);
1215 #endif
1216
1217   inline void VerifyApiCallResultType();
1218
1219   // Prints this object without details.
1220   void ShortPrint(FILE* out = stdout);
1221
1222   // Prints this object without details to a message accumulator.
1223   void ShortPrint(StringStream* accumulator);
1224
1225   void ShortPrint(std::ostream& os);  // NOLINT
1226
1227   DECLARE_CAST(Object)
1228
1229   // Layout description.
1230   static const int kHeaderSize = 0;  // Object does not take up any space.
1231
1232 #ifdef OBJECT_PRINT
1233   // For our gdb macros, we should perhaps change these in the future.
1234   void Print();
1235
1236   // Prints this object with details.
1237   void Print(std::ostream& os);  // NOLINT
1238 #else
1239   void Print() { ShortPrint(); }
1240   void Print(std::ostream& os) { ShortPrint(os); }  // NOLINT
1241 #endif
1242
1243  private:
1244   friend class LookupIterator;
1245   friend class PrototypeIterator;
1246
1247   // Return the map of the root of object's prototype chain.
1248   Map* GetRootMap(Isolate* isolate);
1249
1250   // Helper for SetProperty and SetSuperProperty.
1251   MUST_USE_RESULT static MaybeHandle<Object> SetPropertyInternal(
1252       LookupIterator* it, Handle<Object> value, LanguageMode language_mode,
1253       StoreFromKeyed store_mode, bool* found);
1254
1255   DISALLOW_IMPLICIT_CONSTRUCTORS(Object);
1256 };
1257
1258
1259 // In objects.h to be usable without objects-inl.h inclusion.
1260 bool Object::IsSmi() const { return HAS_SMI_TAG(this); }
1261 bool Object::IsHeapObject() const { return Internals::HasHeapObjectTag(this); }
1262
1263
1264 struct Brief {
1265   explicit Brief(const Object* const v) : value(v) {}
1266   const Object* value;
1267 };
1268
1269
1270 std::ostream& operator<<(std::ostream& os, const Brief& v);
1271
1272
1273 // Smi represents integer Numbers that can be stored in 31 bits.
1274 // Smis are immediate which means they are NOT allocated in the heap.
1275 // The this pointer has the following format: [31 bit signed int] 0
1276 // For long smis it has the following format:
1277 //     [32 bit signed int] [31 bits zero padding] 0
1278 // Smi stands for small integer.
1279 class Smi: public Object {
1280  public:
1281   // Returns the integer value.
1282   inline int value() const { return Internals::SmiValue(this); }
1283
1284   // Convert a value to a Smi object.
1285   static inline Smi* FromInt(int value) {
1286     DCHECK(Smi::IsValid(value));
1287     return reinterpret_cast<Smi*>(Internals::IntToSmi(value));
1288   }
1289
1290   static inline Smi* FromIntptr(intptr_t value) {
1291     DCHECK(Smi::IsValid(value));
1292     int smi_shift_bits = kSmiTagSize + kSmiShiftSize;
1293     return reinterpret_cast<Smi*>((value << smi_shift_bits) | kSmiTag);
1294   }
1295
1296   // Returns whether value can be represented in a Smi.
1297   static inline bool IsValid(intptr_t value) {
1298     bool result = Internals::IsValidSmi(value);
1299     DCHECK_EQ(result, value >= kMinValue && value <= kMaxValue);
1300     return result;
1301   }
1302
1303   DECLARE_CAST(Smi)
1304
1305   // Dispatched behavior.
1306   void SmiPrint(std::ostream& os) const;  // NOLINT
1307   DECLARE_VERIFIER(Smi)
1308
1309   static const int kMinValue =
1310       (static_cast<unsigned int>(-1)) << (kSmiValueSize - 1);
1311   static const int kMaxValue = -(kMinValue + 1);
1312
1313  private:
1314   DISALLOW_IMPLICIT_CONSTRUCTORS(Smi);
1315 };
1316
1317
1318 // Heap objects typically have a map pointer in their first word.  However,
1319 // during GC other data (e.g. mark bits, forwarding addresses) is sometimes
1320 // encoded in the first word.  The class MapWord is an abstraction of the
1321 // value in a heap object's first word.
1322 class MapWord BASE_EMBEDDED {
1323  public:
1324   // Normal state: the map word contains a map pointer.
1325
1326   // Create a map word from a map pointer.
1327   static inline MapWord FromMap(const Map* map);
1328
1329   // View this map word as a map pointer.
1330   inline Map* ToMap();
1331
1332
1333   // Scavenge collection: the map word of live objects in the from space
1334   // contains a forwarding address (a heap object pointer in the to space).
1335
1336   // True if this map word is a forwarding address for a scavenge
1337   // collection.  Only valid during a scavenge collection (specifically,
1338   // when all map words are heap object pointers, i.e. not during a full GC).
1339   inline bool IsForwardingAddress();
1340
1341   // Create a map word from a forwarding address.
1342   static inline MapWord FromForwardingAddress(HeapObject* object);
1343
1344   // View this map word as a forwarding address.
1345   inline HeapObject* ToForwardingAddress();
1346
1347   static inline MapWord FromRawValue(uintptr_t value) {
1348     return MapWord(value);
1349   }
1350
1351   inline uintptr_t ToRawValue() {
1352     return value_;
1353   }
1354
1355  private:
1356   // HeapObject calls the private constructor and directly reads the value.
1357   friend class HeapObject;
1358
1359   explicit MapWord(uintptr_t value) : value_(value) {}
1360
1361   uintptr_t value_;
1362 };
1363
1364
1365 // The content of an heap object (except for the map pointer). kTaggedValues
1366 // objects can contain both heap pointers and Smis, kMixedValues can contain
1367 // heap pointers, Smis, and raw values (e.g. doubles or strings), and kRawValues
1368 // objects can contain raw values and Smis.
1369 enum class HeapObjectContents { kTaggedValues, kMixedValues, kRawValues };
1370
1371
1372 // HeapObject is the superclass for all classes describing heap allocated
1373 // objects.
1374 class HeapObject: public Object {
1375  public:
1376   // [map]: Contains a map which contains the object's reflective
1377   // information.
1378   inline Map* map() const;
1379   inline void set_map(Map* value);
1380   // The no-write-barrier version.  This is OK if the object is white and in
1381   // new space, or if the value is an immortal immutable object, like the maps
1382   // of primitive (non-JS) objects like strings, heap numbers etc.
1383   inline void set_map_no_write_barrier(Map* value);
1384
1385   // Get the map using acquire load.
1386   inline Map* synchronized_map();
1387   inline MapWord synchronized_map_word() const;
1388
1389   // Set the map using release store
1390   inline void synchronized_set_map(Map* value);
1391   inline void synchronized_set_map_no_write_barrier(Map* value);
1392   inline void synchronized_set_map_word(MapWord map_word);
1393
1394   // During garbage collection, the map word of a heap object does not
1395   // necessarily contain a map pointer.
1396   inline MapWord map_word() const;
1397   inline void set_map_word(MapWord map_word);
1398
1399   // The Heap the object was allocated in. Used also to access Isolate.
1400   inline Heap* GetHeap() const;
1401
1402   // Convenience method to get current isolate.
1403   inline Isolate* GetIsolate() const;
1404
1405   // Converts an address to a HeapObject pointer.
1406   static inline HeapObject* FromAddress(Address address) {
1407     DCHECK_TAG_ALIGNED(address);
1408     return reinterpret_cast<HeapObject*>(address + kHeapObjectTag);
1409   }
1410
1411   // Returns the address of this HeapObject.
1412   inline Address address() {
1413     return reinterpret_cast<Address>(this) - kHeapObjectTag;
1414   }
1415
1416   // Iterates over pointers contained in the object (including the Map)
1417   void Iterate(ObjectVisitor* v);
1418
1419   // Iterates over all pointers contained in the object except the
1420   // first map pointer.  The object type is given in the first
1421   // parameter. This function does not access the map pointer in the
1422   // object, and so is safe to call while the map pointer is modified.
1423   void IterateBody(InstanceType type, int object_size, ObjectVisitor* v);
1424
1425   // Returns the heap object's size in bytes
1426   inline int Size();
1427
1428   // Indicates what type of values this heap object may contain.
1429   inline HeapObjectContents ContentType();
1430
1431   // Given a heap object's map pointer, returns the heap size in bytes
1432   // Useful when the map pointer field is used for other purposes.
1433   // GC internal.
1434   inline int SizeFromMap(Map* map);
1435
1436   // Returns the field at offset in obj, as a read/write Object* reference.
1437   // Does no checking, and is safe to use during GC, while maps are invalid.
1438   // Does not invoke write barrier, so should only be assigned to
1439   // during marking GC.
1440   static inline Object** RawField(HeapObject* obj, int offset);
1441
1442   // Adds the |code| object related to |name| to the code cache of this map. If
1443   // this map is a dictionary map that is shared, the map copied and installed
1444   // onto the object.
1445   static void UpdateMapCodeCache(Handle<HeapObject> object,
1446                                  Handle<Name> name,
1447                                  Handle<Code> code);
1448
1449   DECLARE_CAST(HeapObject)
1450
1451   // Return the write barrier mode for this. Callers of this function
1452   // must be able to present a reference to an DisallowHeapAllocation
1453   // object as a sign that they are not going to use this function
1454   // from code that allocates and thus invalidates the returned write
1455   // barrier mode.
1456   inline WriteBarrierMode GetWriteBarrierMode(
1457       const DisallowHeapAllocation& promise);
1458
1459   // Dispatched behavior.
1460   void HeapObjectShortPrint(std::ostream& os);  // NOLINT
1461 #ifdef OBJECT_PRINT
1462   void PrintHeader(std::ostream& os, const char* id);  // NOLINT
1463 #endif
1464   DECLARE_PRINTER(HeapObject)
1465   DECLARE_VERIFIER(HeapObject)
1466 #ifdef VERIFY_HEAP
1467   inline void VerifyObjectField(int offset);
1468   inline void VerifySmiField(int offset);
1469
1470   // Verify a pointer is a valid HeapObject pointer that points to object
1471   // areas in the heap.
1472   static void VerifyHeapPointer(Object* p);
1473 #endif
1474
1475   inline AllocationAlignment RequiredAlignment();
1476
1477   // Layout description.
1478   // First field in a heap object is map.
1479   static const int kMapOffset = Object::kHeaderSize;
1480   static const int kHeaderSize = kMapOffset + kPointerSize;
1481
1482   STATIC_ASSERT(kMapOffset == Internals::kHeapObjectMapOffset);
1483
1484  protected:
1485   // helpers for calling an ObjectVisitor to iterate over pointers in the
1486   // half-open range [start, end) specified as integer offsets
1487   inline void IteratePointers(ObjectVisitor* v, int start, int end);
1488   // as above, for the single element at "offset"
1489   inline void IteratePointer(ObjectVisitor* v, int offset);
1490   // as above, for the next code link of a code object.
1491   inline void IterateNextCodeLink(ObjectVisitor* v, int offset);
1492
1493  private:
1494   DISALLOW_IMPLICIT_CONSTRUCTORS(HeapObject);
1495 };
1496
1497
1498 // This class describes a body of an object of a fixed size
1499 // in which all pointer fields are located in the [start_offset, end_offset)
1500 // interval.
1501 template<int start_offset, int end_offset, int size>
1502 class FixedBodyDescriptor {
1503  public:
1504   static const int kStartOffset = start_offset;
1505   static const int kEndOffset = end_offset;
1506   static const int kSize = size;
1507
1508   static inline void IterateBody(HeapObject* obj, ObjectVisitor* v);
1509
1510   template<typename StaticVisitor>
1511   static inline void IterateBody(HeapObject* obj) {
1512     StaticVisitor::VisitPointers(HeapObject::RawField(obj, start_offset),
1513                                  HeapObject::RawField(obj, end_offset));
1514   }
1515 };
1516
1517
1518 // This class describes a body of an object of a variable size
1519 // in which all pointer fields are located in the [start_offset, object_size)
1520 // interval.
1521 template<int start_offset>
1522 class FlexibleBodyDescriptor {
1523  public:
1524   static const int kStartOffset = start_offset;
1525
1526   static inline void IterateBody(HeapObject* obj,
1527                                  int object_size,
1528                                  ObjectVisitor* v);
1529
1530   template<typename StaticVisitor>
1531   static inline void IterateBody(HeapObject* obj, int object_size) {
1532     StaticVisitor::VisitPointers(HeapObject::RawField(obj, start_offset),
1533                                  HeapObject::RawField(obj, object_size));
1534   }
1535 };
1536
1537
1538 // The HeapNumber class describes heap allocated numbers that cannot be
1539 // represented in a Smi (small integer)
1540 class HeapNumber: public HeapObject {
1541  public:
1542   // [value]: number value.
1543   inline double value() const;
1544   inline void set_value(double value);
1545
1546   DECLARE_CAST(HeapNumber)
1547
1548   // Dispatched behavior.
1549   bool HeapNumberBooleanValue();
1550
1551   void HeapNumberPrint(std::ostream& os);  // NOLINT
1552   DECLARE_VERIFIER(HeapNumber)
1553
1554   inline int get_exponent();
1555   inline int get_sign();
1556
1557   // Layout description.
1558   static const int kValueOffset = HeapObject::kHeaderSize;
1559   // IEEE doubles are two 32 bit words.  The first is just mantissa, the second
1560   // is a mixture of sign, exponent and mantissa. The offsets of two 32 bit
1561   // words within double numbers are endian dependent and they are set
1562   // accordingly.
1563 #if defined(V8_TARGET_LITTLE_ENDIAN)
1564   static const int kMantissaOffset = kValueOffset;
1565   static const int kExponentOffset = kValueOffset + 4;
1566 #elif defined(V8_TARGET_BIG_ENDIAN)
1567   static const int kMantissaOffset = kValueOffset + 4;
1568   static const int kExponentOffset = kValueOffset;
1569 #else
1570 #error Unknown byte ordering
1571 #endif
1572
1573   static const int kSize = kValueOffset + kDoubleSize;
1574   static const uint32_t kSignMask = 0x80000000u;
1575   static const uint32_t kExponentMask = 0x7ff00000u;
1576   static const uint32_t kMantissaMask = 0xfffffu;
1577   static const int kMantissaBits = 52;
1578   static const int kExponentBits = 11;
1579   static const int kExponentBias = 1023;
1580   static const int kExponentShift = 20;
1581   static const int kInfinityOrNanExponent =
1582       (kExponentMask >> kExponentShift) - kExponentBias;
1583   static const int kMantissaBitsInTopWord = 20;
1584   static const int kNonMantissaBitsInTopWord = 12;
1585
1586  private:
1587   DISALLOW_IMPLICIT_CONSTRUCTORS(HeapNumber);
1588 };
1589
1590
1591 // The Simd128Value class describes heap allocated 128 bit SIMD values.
1592 class Simd128Value : public HeapObject {
1593  public:
1594   DECLARE_CAST(Simd128Value)
1595
1596   DECLARE_PRINTER(Simd128Value)
1597   DECLARE_VERIFIER(Simd128Value)
1598
1599   // Equality operations.
1600   inline bool Equals(Simd128Value* that);
1601
1602   // Checks that another instance is bit-wise equal.
1603   bool BitwiseEquals(const Simd128Value* other) const;
1604   // Computes a hash from the 128 bit value, viewed as 4 32-bit integers.
1605   uint32_t Hash() const;
1606   // Copies the 16 bytes of SIMD data to the destination address.
1607   void CopyBits(void* destination) const;
1608
1609   // Layout description.
1610   static const int kValueOffset = HeapObject::kHeaderSize;
1611   static const int kSize = kValueOffset + kSimd128Size;
1612
1613  private:
1614   DISALLOW_IMPLICIT_CONSTRUCTORS(Simd128Value);
1615 };
1616
1617
1618 // V has parameters (TYPE, Type, type, lane count, lane type)
1619 #define SIMD128_TYPES(V)                       \
1620   V(FLOAT32X4, Float32x4, float32x4, 4, float) \
1621   V(INT32X4, Int32x4, int32x4, 4, int32_t)     \
1622   V(BOOL32X4, Bool32x4, bool32x4, 4, bool)     \
1623   V(INT16X8, Int16x8, int16x8, 8, int16_t)     \
1624   V(BOOL16X8, Bool16x8, bool16x8, 8, bool)     \
1625   V(INT8X16, Int8x16, int8x16, 16, int8_t)     \
1626   V(BOOL8X16, Bool8x16, bool8x16, 16, bool)
1627
1628 #define SIMD128_VALUE_CLASS(TYPE, Type, type, lane_count, lane_type) \
1629   class Type final : public Simd128Value {                           \
1630    public:                                                           \
1631     inline lane_type get_lane(int lane) const;                       \
1632     inline void set_lane(int lane, lane_type value);                 \
1633                                                                      \
1634     DECLARE_CAST(Type)                                               \
1635                                                                      \
1636     DECLARE_PRINTER(Type)                                            \
1637                                                                      \
1638     inline bool Equals(Type* that);                                  \
1639                                                                      \
1640    private:                                                          \
1641     DISALLOW_IMPLICIT_CONSTRUCTORS(Type);                            \
1642   };
1643 SIMD128_TYPES(SIMD128_VALUE_CLASS)
1644 #undef SIMD128_VALUE_CLASS
1645
1646
1647 enum EnsureElementsMode {
1648   DONT_ALLOW_DOUBLE_ELEMENTS,
1649   ALLOW_COPIED_DOUBLE_ELEMENTS,
1650   ALLOW_CONVERTED_DOUBLE_ELEMENTS
1651 };
1652
1653
1654 // Indicator for one component of an AccessorPair.
1655 enum AccessorComponent {
1656   ACCESSOR_GETTER,
1657   ACCESSOR_SETTER
1658 };
1659
1660
1661 // JSReceiver includes types on which properties can be defined, i.e.,
1662 // JSObject and JSProxy.
1663 class JSReceiver: public HeapObject {
1664  public:
1665   DECLARE_CAST(JSReceiver)
1666
1667   // Implementation of [[HasProperty]], ECMA-262 5th edition, section 8.12.6.
1668   MUST_USE_RESULT static inline Maybe<bool> HasProperty(
1669       Handle<JSReceiver> object, Handle<Name> name);
1670   MUST_USE_RESULT static inline Maybe<bool> HasOwnProperty(Handle<JSReceiver>,
1671                                                            Handle<Name> name);
1672   MUST_USE_RESULT static inline Maybe<bool> HasElement(
1673       Handle<JSReceiver> object, uint32_t index);
1674   MUST_USE_RESULT static inline Maybe<bool> HasOwnElement(
1675       Handle<JSReceiver> object, uint32_t index);
1676
1677   // Implementation of [[Delete]], ECMA-262 5th edition, section 8.12.7.
1678   MUST_USE_RESULT static MaybeHandle<Object> DeletePropertyOrElement(
1679       Handle<JSReceiver> object, Handle<Name> name,
1680       LanguageMode language_mode = SLOPPY);
1681   MUST_USE_RESULT static MaybeHandle<Object> DeleteProperty(
1682       Handle<JSReceiver> object, Handle<Name> name,
1683       LanguageMode language_mode = SLOPPY);
1684   MUST_USE_RESULT static MaybeHandle<Object> DeleteProperty(
1685       LookupIterator* it, LanguageMode language_mode);
1686   MUST_USE_RESULT static MaybeHandle<Object> DeleteElement(
1687       Handle<JSReceiver> object, uint32_t index,
1688       LanguageMode language_mode = SLOPPY);
1689
1690   // Tests for the fast common case for property enumeration.
1691   bool IsSimpleEnum();
1692
1693   // Returns the class name ([[Class]] property in the specification).
1694   String* class_name();
1695
1696   // Returns the constructor name (the name (possibly, inferred name) of the
1697   // function that was used to instantiate the object).
1698   String* constructor_name();
1699
1700   MUST_USE_RESULT static inline Maybe<PropertyAttributes> GetPropertyAttributes(
1701       Handle<JSReceiver> object, Handle<Name> name);
1702   MUST_USE_RESULT static inline Maybe<PropertyAttributes>
1703   GetOwnPropertyAttributes(Handle<JSReceiver> object, Handle<Name> name);
1704
1705   MUST_USE_RESULT static inline Maybe<PropertyAttributes> GetElementAttributes(
1706       Handle<JSReceiver> object, uint32_t index);
1707   MUST_USE_RESULT static inline Maybe<PropertyAttributes>
1708   GetOwnElementAttributes(Handle<JSReceiver> object, uint32_t index);
1709
1710   MUST_USE_RESULT static Maybe<PropertyAttributes> GetPropertyAttributes(
1711       LookupIterator* it);
1712
1713
1714   static Handle<Object> GetDataProperty(Handle<JSReceiver> object,
1715                                         Handle<Name> name);
1716   static Handle<Object> GetDataProperty(LookupIterator* it);
1717
1718
1719   // Retrieves a permanent object identity hash code. The undefined value might
1720   // be returned in case no hash was created yet.
1721   inline Object* GetIdentityHash();
1722
1723   // Retrieves a permanent object identity hash code. May create and store a
1724   // hash code if needed and none exists.
1725   inline static Handle<Smi> GetOrCreateIdentityHash(
1726       Handle<JSReceiver> object);
1727
1728   enum KeyCollectionType { OWN_ONLY, INCLUDE_PROTOS };
1729
1730   // Computes the enumerable keys for a JSObject. Used for implementing
1731   // "for (n in object) { }".
1732   MUST_USE_RESULT static MaybeHandle<FixedArray> GetKeys(
1733       Handle<JSReceiver> object,
1734       KeyCollectionType type);
1735
1736  private:
1737   DISALLOW_IMPLICIT_CONSTRUCTORS(JSReceiver);
1738 };
1739
1740
1741 // The JSObject describes real heap allocated JavaScript objects with
1742 // properties.
1743 // Note that the map of JSObject changes during execution to enable inline
1744 // caching.
1745 class JSObject: public JSReceiver {
1746  public:
1747   // [properties]: Backing storage for properties.
1748   // properties is a FixedArray in the fast case and a Dictionary in the
1749   // slow case.
1750   DECL_ACCESSORS(properties, FixedArray)  // Get and set fast properties.
1751   inline void initialize_properties();
1752   inline bool HasFastProperties();
1753   // Gets slow properties for non-global objects.
1754   inline NameDictionary* property_dictionary();
1755   // Gets global object properties.
1756   inline GlobalDictionary* global_dictionary();
1757
1758   // [elements]: The elements (properties with names that are integers).
1759   //
1760   // Elements can be in two general modes: fast and slow. Each mode
1761   // corrensponds to a set of object representations of elements that
1762   // have something in common.
1763   //
1764   // In the fast mode elements is a FixedArray and so each element can
1765   // be quickly accessed. This fact is used in the generated code. The
1766   // elements array can have one of three maps in this mode:
1767   // fixed_array_map, sloppy_arguments_elements_map or
1768   // fixed_cow_array_map (for copy-on-write arrays). In the latter case
1769   // the elements array may be shared by a few objects and so before
1770   // writing to any element the array must be copied. Use
1771   // EnsureWritableFastElements in this case.
1772   //
1773   // In the slow mode the elements is either a NumberDictionary, a
1774   // FixedArray parameter map for a (sloppy) arguments object.
1775   DECL_ACCESSORS(elements, FixedArrayBase)
1776   inline void initialize_elements();
1777   static void ResetElements(Handle<JSObject> object);
1778   static inline void SetMapAndElements(Handle<JSObject> object,
1779                                        Handle<Map> map,
1780                                        Handle<FixedArrayBase> elements);
1781   inline ElementsKind GetElementsKind();
1782   ElementsAccessor* GetElementsAccessor();
1783   // Returns true if an object has elements of FAST_SMI_ELEMENTS ElementsKind.
1784   inline bool HasFastSmiElements();
1785   // Returns true if an object has elements of FAST_ELEMENTS ElementsKind.
1786   inline bool HasFastObjectElements();
1787   // Returns true if an object has elements of FAST_ELEMENTS or
1788   // FAST_SMI_ONLY_ELEMENTS.
1789   inline bool HasFastSmiOrObjectElements();
1790   // Returns true if an object has any of the fast elements kinds.
1791   inline bool HasFastElements();
1792   // Returns true if an object has elements of FAST_DOUBLE_ELEMENTS
1793   // ElementsKind.
1794   inline bool HasFastDoubleElements();
1795   // Returns true if an object has elements of FAST_HOLEY_*_ELEMENTS
1796   // ElementsKind.
1797   inline bool HasFastHoleyElements();
1798   inline bool HasSloppyArgumentsElements();
1799   inline bool HasDictionaryElements();
1800
1801   inline bool HasFixedTypedArrayElements();
1802
1803   inline bool HasFixedUint8ClampedElements();
1804   inline bool HasFixedArrayElements();
1805   inline bool HasFixedInt8Elements();
1806   inline bool HasFixedUint8Elements();
1807   inline bool HasFixedInt16Elements();
1808   inline bool HasFixedUint16Elements();
1809   inline bool HasFixedInt32Elements();
1810   inline bool HasFixedUint32Elements();
1811   inline bool HasFixedFloat32Elements();
1812   inline bool HasFixedFloat64Elements();
1813
1814   inline bool HasFastArgumentsElements();
1815   inline bool HasSlowArgumentsElements();
1816   inline SeededNumberDictionary* element_dictionary();  // Gets slow elements.
1817
1818   // Requires: HasFastElements().
1819   static Handle<FixedArray> EnsureWritableFastElements(
1820       Handle<JSObject> object);
1821
1822   // Collects elements starting at index 0.
1823   // Undefined values are placed after non-undefined values.
1824   // Returns the number of non-undefined values.
1825   static Handle<Object> PrepareElementsForSort(Handle<JSObject> object,
1826                                                uint32_t limit);
1827   // As PrepareElementsForSort, but only on objects where elements is
1828   // a dictionary, and it will stay a dictionary.  Collates undefined and
1829   // unexisting elements below limit from position zero of the elements.
1830   static Handle<Object> PrepareSlowElementsForSort(Handle<JSObject> object,
1831                                                    uint32_t limit);
1832
1833   MUST_USE_RESULT static MaybeHandle<Object> SetPropertyWithInterceptor(
1834       LookupIterator* it, Handle<Object> value);
1835
1836   // SetLocalPropertyIgnoreAttributes converts callbacks to fields. We need to
1837   // grant an exemption to ExecutableAccessor callbacks in some cases.
1838   enum ExecutableAccessorInfoHandling { DEFAULT_HANDLING, DONT_FORCE_FIELD };
1839
1840   MUST_USE_RESULT static MaybeHandle<Object> DefineOwnPropertyIgnoreAttributes(
1841       LookupIterator* it, Handle<Object> value, PropertyAttributes attributes,
1842       ExecutableAccessorInfoHandling handling = DEFAULT_HANDLING);
1843
1844   MUST_USE_RESULT static MaybeHandle<Object> SetOwnPropertyIgnoreAttributes(
1845       Handle<JSObject> object, Handle<Name> name, Handle<Object> value,
1846       PropertyAttributes attributes,
1847       ExecutableAccessorInfoHandling handling = DEFAULT_HANDLING);
1848
1849   MUST_USE_RESULT static MaybeHandle<Object> SetOwnElementIgnoreAttributes(
1850       Handle<JSObject> object, uint32_t index, Handle<Object> value,
1851       PropertyAttributes attributes,
1852       ExecutableAccessorInfoHandling handling = DEFAULT_HANDLING);
1853
1854   // Equivalent to one of the above depending on whether |name| can be converted
1855   // to an array index.
1856   MUST_USE_RESULT static MaybeHandle<Object>
1857   DefinePropertyOrElementIgnoreAttributes(
1858       Handle<JSObject> object, Handle<Name> name, Handle<Object> value,
1859       PropertyAttributes attributes = NONE,
1860       ExecutableAccessorInfoHandling handling = DEFAULT_HANDLING);
1861
1862   // Adds or reconfigures a property to attributes NONE. It will fail when it
1863   // cannot.
1864   MUST_USE_RESULT static Maybe<bool> CreateDataProperty(LookupIterator* it,
1865                                                         Handle<Object> value);
1866
1867   static void AddProperty(Handle<JSObject> object, Handle<Name> name,
1868                           Handle<Object> value, PropertyAttributes attributes);
1869
1870   MUST_USE_RESULT static MaybeHandle<Object> AddDataElement(
1871       Handle<JSObject> receiver, uint32_t index, Handle<Object> value,
1872       PropertyAttributes attributes);
1873
1874   // Extend the receiver with a single fast property appeared first in the
1875   // passed map. This also extends the property backing store if necessary.
1876   static void AllocateStorageForMap(Handle<JSObject> object, Handle<Map> map);
1877
1878   // Migrates the given object to a map whose field representations are the
1879   // lowest upper bound of all known representations for that field.
1880   static void MigrateInstance(Handle<JSObject> instance);
1881
1882   // Migrates the given object only if the target map is already available,
1883   // or returns false if such a map is not yet available.
1884   static bool TryMigrateInstance(Handle<JSObject> instance);
1885
1886   // Sets the property value in a normalized object given (key, value, details).
1887   // Handles the special representation of JS global objects.
1888   static void SetNormalizedProperty(Handle<JSObject> object, Handle<Name> name,
1889                                     Handle<Object> value,
1890                                     PropertyDetails details);
1891   static void SetDictionaryElement(Handle<JSObject> object, uint32_t index,
1892                                    Handle<Object> value,
1893                                    PropertyAttributes attributes);
1894   static void SetDictionaryArgumentsElement(Handle<JSObject> object,
1895                                             uint32_t index,
1896                                             Handle<Object> value,
1897                                             PropertyAttributes attributes);
1898
1899   static void OptimizeAsPrototype(Handle<JSObject> object,
1900                                   PrototypeOptimizationMode mode);
1901   static void ReoptimizeIfPrototype(Handle<JSObject> object);
1902   static void LazyRegisterPrototypeUser(Handle<Map> user, Isolate* isolate);
1903   static bool UnregisterPrototypeUser(Handle<Map> user, Isolate* isolate);
1904   static void InvalidatePrototypeChains(Map* map);
1905
1906   // Alternative implementation of WeakFixedArray::NullCallback.
1907   class PrototypeRegistryCompactionCallback {
1908    public:
1909     static void Callback(Object* value, int old_index, int new_index);
1910   };
1911
1912   // Retrieve interceptors.
1913   InterceptorInfo* GetNamedInterceptor();
1914   InterceptorInfo* GetIndexedInterceptor();
1915
1916   // Used from JSReceiver.
1917   MUST_USE_RESULT static Maybe<PropertyAttributes>
1918   GetPropertyAttributesWithInterceptor(LookupIterator* it);
1919   MUST_USE_RESULT static Maybe<PropertyAttributes>
1920       GetPropertyAttributesWithFailedAccessCheck(LookupIterator* it);
1921
1922   // Retrieves an AccessorPair property from the given object. Might return
1923   // undefined if the property doesn't exist or is of a different kind.
1924   MUST_USE_RESULT static MaybeHandle<Object> GetAccessor(
1925       Handle<JSObject> object,
1926       Handle<Name> name,
1927       AccessorComponent component);
1928
1929   // Defines an AccessorPair property on the given object.
1930   // TODO(mstarzinger): Rename to SetAccessor().
1931   static MaybeHandle<Object> DefineAccessor(Handle<JSObject> object,
1932                                             Handle<Name> name,
1933                                             Handle<Object> getter,
1934                                             Handle<Object> setter,
1935                                             PropertyAttributes attributes);
1936
1937   // Defines an AccessorInfo property on the given object.
1938   MUST_USE_RESULT static MaybeHandle<Object> SetAccessor(
1939       Handle<JSObject> object,
1940       Handle<AccessorInfo> info);
1941
1942   // The result must be checked first for exceptions. If there's no exception,
1943   // the output parameter |done| indicates whether the interceptor has a result
1944   // or not.
1945   MUST_USE_RESULT static MaybeHandle<Object> GetPropertyWithInterceptor(
1946       LookupIterator* it, bool* done);
1947
1948   // Accessors for hidden properties object.
1949   //
1950   // Hidden properties are not own properties of the object itself.
1951   // Instead they are stored in an auxiliary structure kept as an own
1952   // property with a special name Heap::hidden_string(). But if the
1953   // receiver is a JSGlobalProxy then the auxiliary object is a property
1954   // of its prototype, and if it's a detached proxy, then you can't have
1955   // hidden properties.
1956
1957   // Sets a hidden property on this object. Returns this object if successful,
1958   // undefined if called on a detached proxy.
1959   static Handle<Object> SetHiddenProperty(Handle<JSObject> object,
1960                                           Handle<Name> key,
1961                                           Handle<Object> value);
1962   // Gets the value of a hidden property with the given key. Returns the hole
1963   // if the property doesn't exist (or if called on a detached proxy),
1964   // otherwise returns the value set for the key.
1965   Object* GetHiddenProperty(Handle<Name> key);
1966   // Deletes a hidden property. Deleting a non-existing property is
1967   // considered successful.
1968   static void DeleteHiddenProperty(Handle<JSObject> object,
1969                                    Handle<Name> key);
1970   // Returns true if the object has a property with the hidden string as name.
1971   static bool HasHiddenProperties(Handle<JSObject> object);
1972
1973   static void SetIdentityHash(Handle<JSObject> object, Handle<Smi> hash);
1974
1975   static void ValidateElements(Handle<JSObject> object);
1976
1977   // Makes sure that this object can contain HeapObject as elements.
1978   static inline void EnsureCanContainHeapObjectElements(Handle<JSObject> obj);
1979
1980   // Makes sure that this object can contain the specified elements.
1981   static inline void EnsureCanContainElements(
1982       Handle<JSObject> object,
1983       Object** elements,
1984       uint32_t count,
1985       EnsureElementsMode mode);
1986   static inline void EnsureCanContainElements(
1987       Handle<JSObject> object,
1988       Handle<FixedArrayBase> elements,
1989       uint32_t length,
1990       EnsureElementsMode mode);
1991   static void EnsureCanContainElements(
1992       Handle<JSObject> object,
1993       Arguments* arguments,
1994       uint32_t first_arg,
1995       uint32_t arg_count,
1996       EnsureElementsMode mode);
1997
1998   // Would we convert a fast elements array to dictionary mode given
1999   // an access at key?
2000   bool WouldConvertToSlowElements(uint32_t index);
2001
2002   // Computes the new capacity when expanding the elements of a JSObject.
2003   static uint32_t NewElementsCapacity(uint32_t old_capacity) {
2004     // (old_capacity + 50%) + 16
2005     return old_capacity + (old_capacity >> 1) + 16;
2006   }
2007
2008   // These methods do not perform access checks!
2009   static void UpdateAllocationSite(Handle<JSObject> object,
2010                                    ElementsKind to_kind);
2011
2012   // Lookup interceptors are used for handling properties controlled by host
2013   // objects.
2014   inline bool HasNamedInterceptor();
2015   inline bool HasIndexedInterceptor();
2016
2017   // Computes the enumerable keys from interceptors. Used for debug mirrors and
2018   // by JSReceiver::GetKeys.
2019   MUST_USE_RESULT static MaybeHandle<JSObject> GetKeysForNamedInterceptor(
2020       Handle<JSObject> object,
2021       Handle<JSReceiver> receiver);
2022   MUST_USE_RESULT static MaybeHandle<JSObject> GetKeysForIndexedInterceptor(
2023       Handle<JSObject> object,
2024       Handle<JSReceiver> receiver);
2025
2026   // Support functions for v8 api (needed for correct interceptor behavior).
2027   MUST_USE_RESULT static Maybe<bool> HasRealNamedProperty(
2028       Handle<JSObject> object, Handle<Name> name);
2029   MUST_USE_RESULT static Maybe<bool> HasRealElementProperty(
2030       Handle<JSObject> object, uint32_t index);
2031   MUST_USE_RESULT static Maybe<bool> HasRealNamedCallbackProperty(
2032       Handle<JSObject> object, Handle<Name> name);
2033
2034   // Get the header size for a JSObject.  Used to compute the index of
2035   // internal fields as well as the number of internal fields.
2036   inline int GetHeaderSize();
2037
2038   inline int GetInternalFieldCount();
2039   inline int GetInternalFieldOffset(int index);
2040   inline Object* GetInternalField(int index);
2041   inline void SetInternalField(int index, Object* value);
2042   inline void SetInternalField(int index, Smi* value);
2043
2044   // Returns the number of properties on this object filtering out properties
2045   // with the specified attributes (ignoring interceptors).
2046   int NumberOfOwnProperties(PropertyAttributes filter = NONE);
2047   // Fill in details for properties into storage starting at the specified
2048   // index. Returns the number of properties added.
2049   int GetOwnPropertyNames(FixedArray* storage, int index,
2050                           PropertyAttributes filter = NONE);
2051
2052   // Returns the number of properties on this object filtering out properties
2053   // with the specified attributes (ignoring interceptors).
2054   int NumberOfOwnElements(PropertyAttributes filter);
2055   // Returns the number of enumerable elements (ignoring interceptors).
2056   int NumberOfEnumElements();
2057   // Returns the number of elements on this object filtering out elements
2058   // with the specified attributes (ignoring interceptors).
2059   int GetOwnElementKeys(FixedArray* storage, PropertyAttributes filter);
2060   // Count and fill in the enumerable elements into storage.
2061   // (storage->length() == NumberOfEnumElements()).
2062   // If storage is NULL, will count the elements without adding
2063   // them to any storage.
2064   // Returns the number of enumerable elements.
2065   int GetEnumElementKeys(FixedArray* storage);
2066
2067   static Handle<FixedArray> GetEnumPropertyKeys(Handle<JSObject> object,
2068                                                 bool cache_result);
2069
2070   // Returns a new map with all transitions dropped from the object's current
2071   // map and the ElementsKind set.
2072   static Handle<Map> GetElementsTransitionMap(Handle<JSObject> object,
2073                                               ElementsKind to_kind);
2074   static void TransitionElementsKind(Handle<JSObject> object,
2075                                      ElementsKind to_kind);
2076
2077   // Always use this to migrate an object to a new map.
2078   // |expected_additional_properties| is only used for fast-to-slow transitions
2079   // and ignored otherwise.
2080   static void MigrateToMap(Handle<JSObject> object, Handle<Map> new_map,
2081                            int expected_additional_properties = 0);
2082
2083   // Convert the object to use the canonical dictionary
2084   // representation. If the object is expected to have additional properties
2085   // added this number can be indicated to have the backing store allocated to
2086   // an initial capacity for holding these properties.
2087   static void NormalizeProperties(Handle<JSObject> object,
2088                                   PropertyNormalizationMode mode,
2089                                   int expected_additional_properties,
2090                                   const char* reason);
2091
2092   // Convert and update the elements backing store to be a
2093   // SeededNumberDictionary dictionary.  Returns the backing after conversion.
2094   static Handle<SeededNumberDictionary> NormalizeElements(
2095       Handle<JSObject> object);
2096
2097   void RequireSlowElements(SeededNumberDictionary* dictionary);
2098
2099   // Transform slow named properties to fast variants.
2100   static void MigrateSlowToFast(Handle<JSObject> object,
2101                                 int unused_property_fields, const char* reason);
2102
2103   inline bool IsUnboxedDoubleField(FieldIndex index);
2104
2105   // Access fast-case object properties at index.
2106   static Handle<Object> FastPropertyAt(Handle<JSObject> object,
2107                                        Representation representation,
2108                                        FieldIndex index);
2109   inline Object* RawFastPropertyAt(FieldIndex index);
2110   inline double RawFastDoublePropertyAt(FieldIndex index);
2111
2112   inline void FastPropertyAtPut(FieldIndex index, Object* value);
2113   inline void RawFastPropertyAtPut(FieldIndex index, Object* value);
2114   inline void RawFastDoublePropertyAtPut(FieldIndex index, double value);
2115   inline void WriteToField(int descriptor, Object* value);
2116
2117   // Access to in object properties.
2118   inline int GetInObjectPropertyOffset(int index);
2119   inline Object* InObjectPropertyAt(int index);
2120   inline Object* InObjectPropertyAtPut(int index,
2121                                        Object* value,
2122                                        WriteBarrierMode mode
2123                                        = UPDATE_WRITE_BARRIER);
2124
2125   // Set the object's prototype (only JSReceiver and null are allowed values).
2126   MUST_USE_RESULT static MaybeHandle<Object> SetPrototype(
2127       Handle<JSObject> object, Handle<Object> value, bool from_javascript);
2128
2129   // Initializes the body after properties slot, properties slot is
2130   // initialized by set_properties.  Fill the pre-allocated fields with
2131   // pre_allocated_value and the rest with filler_value.
2132   // Note: this call does not update write barrier, the caller is responsible
2133   // to ensure that |filler_value| can be collected without WB here.
2134   inline void InitializeBody(Map* map,
2135                              Object* pre_allocated_value,
2136                              Object* filler_value);
2137
2138   // Check whether this object references another object
2139   bool ReferencesObject(Object* obj);
2140
2141   // Disalow further properties to be added to the oject.
2142   MUST_USE_RESULT static MaybeHandle<Object> PreventExtensions(
2143       Handle<JSObject> object);
2144
2145   bool IsExtensible();
2146
2147   // ES5 Object.seal
2148   MUST_USE_RESULT static MaybeHandle<Object> Seal(Handle<JSObject> object);
2149
2150   // ES5 Object.freeze
2151   MUST_USE_RESULT static MaybeHandle<Object> Freeze(Handle<JSObject> object);
2152
2153   // Called the first time an object is observed with ES7 Object.observe.
2154   static void SetObserved(Handle<JSObject> object);
2155
2156   // Copy object.
2157   enum DeepCopyHints { kNoHints = 0, kObjectIsShallow = 1 };
2158
2159   MUST_USE_RESULT static MaybeHandle<JSObject> DeepCopy(
2160       Handle<JSObject> object,
2161       AllocationSiteUsageContext* site_context,
2162       DeepCopyHints hints = kNoHints);
2163   MUST_USE_RESULT static MaybeHandle<JSObject> DeepWalk(
2164       Handle<JSObject> object,
2165       AllocationSiteCreationContext* site_context);
2166
2167   DECLARE_CAST(JSObject)
2168
2169   // Dispatched behavior.
2170   void JSObjectShortPrint(StringStream* accumulator);
2171   DECLARE_PRINTER(JSObject)
2172   DECLARE_VERIFIER(JSObject)
2173 #ifdef OBJECT_PRINT
2174   void PrintProperties(std::ostream& os);   // NOLINT
2175   void PrintElements(std::ostream& os);     // NOLINT
2176 #endif
2177 #if defined(DEBUG) || defined(OBJECT_PRINT)
2178   void PrintTransitions(std::ostream& os);  // NOLINT
2179 #endif
2180
2181   static void PrintElementsTransition(
2182       FILE* file, Handle<JSObject> object,
2183       ElementsKind from_kind, Handle<FixedArrayBase> from_elements,
2184       ElementsKind to_kind, Handle<FixedArrayBase> to_elements);
2185
2186   void PrintInstanceMigration(FILE* file, Map* original_map, Map* new_map);
2187
2188 #ifdef DEBUG
2189   // Structure for collecting spill information about JSObjects.
2190   class SpillInformation {
2191    public:
2192     void Clear();
2193     void Print();
2194     int number_of_objects_;
2195     int number_of_objects_with_fast_properties_;
2196     int number_of_objects_with_fast_elements_;
2197     int number_of_fast_used_fields_;
2198     int number_of_fast_unused_fields_;
2199     int number_of_slow_used_properties_;
2200     int number_of_slow_unused_properties_;
2201     int number_of_fast_used_elements_;
2202     int number_of_fast_unused_elements_;
2203     int number_of_slow_used_elements_;
2204     int number_of_slow_unused_elements_;
2205   };
2206
2207   void IncrementSpillStatistics(SpillInformation* info);
2208 #endif
2209
2210 #ifdef VERIFY_HEAP
2211   // If a GC was caused while constructing this object, the elements pointer
2212   // may point to a one pointer filler map. The object won't be rooted, but
2213   // our heap verification code could stumble across it.
2214   bool ElementsAreSafeToExamine();
2215 #endif
2216
2217   Object* SlowReverseLookup(Object* value);
2218
2219   // Maximal number of elements (numbered 0 .. kMaxElementCount - 1).
2220   // Also maximal value of JSArray's length property.
2221   static const uint32_t kMaxElementCount = 0xffffffffu;
2222
2223   // Constants for heuristics controlling conversion of fast elements
2224   // to slow elements.
2225
2226   // Maximal gap that can be introduced by adding an element beyond
2227   // the current elements length.
2228   static const uint32_t kMaxGap = 1024;
2229
2230   // Maximal length of fast elements array that won't be checked for
2231   // being dense enough on expansion.
2232   static const int kMaxUncheckedFastElementsLength = 5000;
2233
2234   // Same as above but for old arrays. This limit is more strict. We
2235   // don't want to be wasteful with long lived objects.
2236   static const int kMaxUncheckedOldFastElementsLength = 500;
2237
2238   // Note that Page::kMaxRegularHeapObjectSize puts a limit on
2239   // permissible values (see the DCHECK in heap.cc).
2240   static const int kInitialMaxFastElementArray = 100000;
2241
2242   // This constant applies only to the initial map of "global.Object" and
2243   // not to arbitrary other JSObject maps.
2244   static const int kInitialGlobalObjectUnusedPropertiesCount = 4;
2245
2246   static const int kMaxInstanceSize = 255 * kPointerSize;
2247   // When extending the backing storage for property values, we increase
2248   // its size by more than the 1 entry necessary, so sequentially adding fields
2249   // to the same object requires fewer allocations and copies.
2250   static const int kFieldsAdded = 3;
2251
2252   // Layout description.
2253   static const int kPropertiesOffset = HeapObject::kHeaderSize;
2254   static const int kElementsOffset = kPropertiesOffset + kPointerSize;
2255   static const int kHeaderSize = kElementsOffset + kPointerSize;
2256
2257   STATIC_ASSERT(kHeaderSize == Internals::kJSObjectHeaderSize);
2258
2259   class BodyDescriptor : public FlexibleBodyDescriptor<kPropertiesOffset> {
2260    public:
2261     static inline int SizeOf(Map* map, HeapObject* object);
2262   };
2263
2264   Context* GetCreationContext();
2265
2266   // Enqueue change record for Object.observe. May cause GC.
2267   MUST_USE_RESULT static MaybeHandle<Object> EnqueueChangeRecord(
2268       Handle<JSObject> object, const char* type, Handle<Name> name,
2269       Handle<Object> old_value);
2270
2271   // Gets the number of currently used elements.
2272   int GetFastElementsUsage();
2273
2274   // Deletes an existing named property in a normalized object.
2275   static void DeleteNormalizedProperty(Handle<JSObject> object,
2276                                        Handle<Name> name, int entry);
2277
2278   static bool AllCanRead(LookupIterator* it);
2279   static bool AllCanWrite(LookupIterator* it);
2280
2281  private:
2282   friend class JSReceiver;
2283   friend class Object;
2284
2285   static void MigrateFastToFast(Handle<JSObject> object, Handle<Map> new_map);
2286   static void MigrateFastToSlow(Handle<JSObject> object,
2287                                 Handle<Map> new_map,
2288                                 int expected_additional_properties);
2289
2290   // Used from Object::GetProperty().
2291   MUST_USE_RESULT static MaybeHandle<Object> GetPropertyWithFailedAccessCheck(
2292       LookupIterator* it);
2293
2294   MUST_USE_RESULT static MaybeHandle<Object> SetPropertyWithFailedAccessCheck(
2295       LookupIterator* it, Handle<Object> value);
2296
2297   // Add a property to a slow-case object.
2298   static void AddSlowProperty(Handle<JSObject> object,
2299                               Handle<Name> name,
2300                               Handle<Object> value,
2301                               PropertyAttributes attributes);
2302
2303   MUST_USE_RESULT static MaybeHandle<Object> DeletePropertyWithInterceptor(
2304       LookupIterator* it);
2305
2306   bool ReferencesObjectFromElements(FixedArray* elements,
2307                                     ElementsKind kind,
2308                                     Object* object);
2309
2310   // Return the hash table backing store or the inline stored identity hash,
2311   // whatever is found.
2312   MUST_USE_RESULT Object* GetHiddenPropertiesHashTable();
2313
2314   // Return the hash table backing store for hidden properties.  If there is no
2315   // backing store, allocate one.
2316   static Handle<ObjectHashTable> GetOrCreateHiddenPropertiesHashtable(
2317       Handle<JSObject> object);
2318
2319   // Set the hidden property backing store to either a hash table or
2320   // the inline-stored identity hash.
2321   static Handle<Object> SetHiddenPropertiesHashTable(
2322       Handle<JSObject> object,
2323       Handle<Object> value);
2324
2325   MUST_USE_RESULT Object* GetIdentityHash();
2326
2327   static Handle<Smi> GetOrCreateIdentityHash(Handle<JSObject> object);
2328
2329   static Handle<SeededNumberDictionary> GetNormalizedElementDictionary(
2330       Handle<JSObject> object, Handle<FixedArrayBase> elements);
2331
2332   // Helper for fast versions of preventExtensions, seal, and freeze.
2333   // attrs is one of NONE, SEALED, or FROZEN (depending on the operation).
2334   template <PropertyAttributes attrs>
2335   MUST_USE_RESULT static MaybeHandle<Object> PreventExtensionsWithTransition(
2336       Handle<JSObject> object);
2337
2338   DISALLOW_IMPLICIT_CONSTRUCTORS(JSObject);
2339 };
2340
2341
2342 // Common superclass for FixedArrays that allow implementations to share
2343 // common accessors and some code paths.
2344 class FixedArrayBase: public HeapObject {
2345  public:
2346   // [length]: length of the array.
2347   inline int length() const;
2348   inline void set_length(int value);
2349
2350   // Get and set the length using acquire loads and release stores.
2351   inline int synchronized_length() const;
2352   inline void synchronized_set_length(int value);
2353
2354   DECLARE_CAST(FixedArrayBase)
2355
2356   // Layout description.
2357   // Length is smi tagged when it is stored.
2358   static const int kLengthOffset = HeapObject::kHeaderSize;
2359   static const int kHeaderSize = kLengthOffset + kPointerSize;
2360 };
2361
2362
2363 class FixedDoubleArray;
2364 class IncrementalMarking;
2365
2366
2367 // FixedArray describes fixed-sized arrays with element type Object*.
2368 class FixedArray: public FixedArrayBase {
2369  public:
2370   // Setter and getter for elements.
2371   inline Object* get(int index) const;
2372   void SetValue(uint32_t index, Object* value);
2373   static inline Handle<Object> get(Handle<FixedArray> array, int index);
2374   // Setter that uses write barrier.
2375   inline void set(int index, Object* value);
2376   inline bool is_the_hole(int index);
2377
2378   // Setter that doesn't need write barrier.
2379   inline void set(int index, Smi* value);
2380   // Setter with explicit barrier mode.
2381   inline void set(int index, Object* value, WriteBarrierMode mode);
2382
2383   // Setters for frequently used oddballs located in old space.
2384   inline void set_undefined(int index);
2385   inline void set_null(int index);
2386   inline void set_the_hole(int index);
2387
2388   inline Object** GetFirstElementAddress();
2389   inline bool ContainsOnlySmisOrHoles();
2390
2391   // Gives access to raw memory which stores the array's data.
2392   inline Object** data_start();
2393
2394   inline void FillWithHoles(int from, int to);
2395
2396   // Shrink length and insert filler objects.
2397   void Shrink(int length);
2398
2399   enum KeyFilter { ALL_KEYS, NON_SYMBOL_KEYS };
2400
2401   // Add the elements of a JSArray to this FixedArray.
2402   MUST_USE_RESULT static MaybeHandle<FixedArray> AddKeysFromArrayLike(
2403       Handle<FixedArray> content, Handle<JSObject> array,
2404       KeyFilter filter = ALL_KEYS);
2405
2406   // Computes the union of keys and return the result.
2407   // Used for implementing "for (n in object) { }"
2408   MUST_USE_RESULT static MaybeHandle<FixedArray> UnionOfKeys(
2409       Handle<FixedArray> first,
2410       Handle<FixedArray> second);
2411
2412   // Copy a sub array from the receiver to dest.
2413   void CopyTo(int pos, FixedArray* dest, int dest_pos, int len);
2414
2415   // Garbage collection support.
2416   static int SizeFor(int length) { return kHeaderSize + length * kPointerSize; }
2417
2418   // Code Generation support.
2419   static int OffsetOfElementAt(int index) { return SizeFor(index); }
2420
2421   // Garbage collection support.
2422   inline Object** RawFieldOfElementAt(int index);
2423
2424   DECLARE_CAST(FixedArray)
2425
2426   // Maximal allowed size, in bytes, of a single FixedArray.
2427   // Prevents overflowing size computations, as well as extreme memory
2428   // consumption.
2429   static const int kMaxSize = 128 * MB * kPointerSize;
2430   // Maximally allowed length of a FixedArray.
2431   static const int kMaxLength = (kMaxSize - kHeaderSize) / kPointerSize;
2432
2433   // Dispatched behavior.
2434   DECLARE_PRINTER(FixedArray)
2435   DECLARE_VERIFIER(FixedArray)
2436 #ifdef DEBUG
2437   // Checks if two FixedArrays have identical contents.
2438   bool IsEqualTo(FixedArray* other);
2439 #endif
2440
2441   // Swap two elements in a pair of arrays.  If this array and the
2442   // numbers array are the same object, the elements are only swapped
2443   // once.
2444   void SwapPairs(FixedArray* numbers, int i, int j);
2445
2446   // Sort prefix of this array and the numbers array as pairs wrt. the
2447   // numbers.  If the numbers array and the this array are the same
2448   // object, the prefix of this array is sorted.
2449   void SortPairs(FixedArray* numbers, uint32_t len);
2450
2451   class BodyDescriptor : public FlexibleBodyDescriptor<kHeaderSize> {
2452    public:
2453     static inline int SizeOf(Map* map, HeapObject* object);
2454   };
2455
2456  protected:
2457   // Set operation on FixedArray without using write barriers. Can
2458   // only be used for storing old space objects or smis.
2459   static inline void NoWriteBarrierSet(FixedArray* array,
2460                                        int index,
2461                                        Object* value);
2462
2463   // Set operation on FixedArray without incremental write barrier. Can
2464   // only be used if the object is guaranteed to be white (whiteness witness
2465   // is present).
2466   static inline void NoIncrementalWriteBarrierSet(FixedArray* array,
2467                                                   int index,
2468                                                   Object* value);
2469
2470  private:
2471   STATIC_ASSERT(kHeaderSize == Internals::kFixedArrayHeaderSize);
2472
2473   DISALLOW_IMPLICIT_CONSTRUCTORS(FixedArray);
2474 };
2475
2476
2477 // FixedDoubleArray describes fixed-sized arrays with element type double.
2478 class FixedDoubleArray: public FixedArrayBase {
2479  public:
2480   // Setter and getter for elements.
2481   inline double get_scalar(int index);
2482   inline uint64_t get_representation(int index);
2483   static inline Handle<Object> get(Handle<FixedDoubleArray> array, int index);
2484   // This accessor has to get a Number as |value|.
2485   void SetValue(uint32_t index, Object* value);
2486   inline void set(int index, double value);
2487   inline void set_the_hole(int index);
2488
2489   // Checking for the hole.
2490   inline bool is_the_hole(int index);
2491
2492   // Garbage collection support.
2493   inline static int SizeFor(int length) {
2494     return kHeaderSize + length * kDoubleSize;
2495   }
2496
2497   // Gives access to raw memory which stores the array's data.
2498   inline double* data_start();
2499
2500   inline void FillWithHoles(int from, int to);
2501
2502   // Code Generation support.
2503   static int OffsetOfElementAt(int index) { return SizeFor(index); }
2504
2505   DECLARE_CAST(FixedDoubleArray)
2506
2507   // Maximal allowed size, in bytes, of a single FixedDoubleArray.
2508   // Prevents overflowing size computations, as well as extreme memory
2509   // consumption.
2510   static const int kMaxSize = 512 * MB;
2511   // Maximally allowed length of a FixedArray.
2512   static const int kMaxLength = (kMaxSize - kHeaderSize) / kDoubleSize;
2513
2514   // Dispatched behavior.
2515   DECLARE_PRINTER(FixedDoubleArray)
2516   DECLARE_VERIFIER(FixedDoubleArray)
2517
2518  private:
2519   DISALLOW_IMPLICIT_CONSTRUCTORS(FixedDoubleArray);
2520 };
2521
2522
2523 class WeakFixedArray : public FixedArray {
2524  public:
2525   // If |maybe_array| is not a WeakFixedArray, a fresh one will be allocated.
2526   // This function does not check if the value exists already, callers must
2527   // ensure this themselves if necessary.
2528   static Handle<WeakFixedArray> Add(Handle<Object> maybe_array,
2529                                     Handle<HeapObject> value,
2530                                     int* assigned_index = NULL);
2531
2532   // Returns true if an entry was found and removed.
2533   bool Remove(Handle<HeapObject> value);
2534
2535   class NullCallback {
2536    public:
2537     static void Callback(Object* value, int old_index, int new_index) {}
2538   };
2539
2540   template <class CompactionCallback>
2541   void Compact();
2542
2543   inline Object* Get(int index) const;
2544   inline void Clear(int index);
2545   inline int Length() const;
2546
2547   inline bool IsEmptySlot(int index) const;
2548   static Object* Empty() { return Smi::FromInt(0); }
2549
2550   DECLARE_CAST(WeakFixedArray)
2551
2552  private:
2553   static const int kLastUsedIndexIndex = 0;
2554   static const int kFirstIndex = 1;
2555
2556   static Handle<WeakFixedArray> Allocate(
2557       Isolate* isolate, int size, Handle<WeakFixedArray> initialize_from);
2558
2559   static void Set(Handle<WeakFixedArray> array, int index,
2560                   Handle<HeapObject> value);
2561   inline void clear(int index);
2562
2563   inline int last_used_index() const;
2564   inline void set_last_used_index(int index);
2565
2566   // Disallow inherited setters.
2567   void set(int index, Smi* value);
2568   void set(int index, Object* value);
2569   void set(int index, Object* value, WriteBarrierMode mode);
2570   DISALLOW_IMPLICIT_CONSTRUCTORS(WeakFixedArray);
2571 };
2572
2573
2574 // Generic array grows dynamically with O(1) amortized insertion.
2575 class ArrayList : public FixedArray {
2576  public:
2577   enum AddMode {
2578     kNone,
2579     // Use this if GC can delete elements from the array.
2580     kReloadLengthAfterAllocation,
2581   };
2582   static Handle<ArrayList> Add(Handle<ArrayList> array, Handle<Object> obj,
2583                                AddMode mode = kNone);
2584   static Handle<ArrayList> Add(Handle<ArrayList> array, Handle<Object> obj1,
2585                                Handle<Object> obj2, AddMode = kNone);
2586   inline int Length();
2587   inline void SetLength(int length);
2588   inline Object* Get(int index);
2589   inline Object** Slot(int index);
2590   inline void Set(int index, Object* obj);
2591   inline void Clear(int index, Object* undefined);
2592   DECLARE_CAST(ArrayList)
2593
2594  private:
2595   static Handle<ArrayList> EnsureSpace(Handle<ArrayList> array, int length);
2596   static const int kLengthIndex = 0;
2597   static const int kFirstIndex = 1;
2598   DISALLOW_IMPLICIT_CONSTRUCTORS(ArrayList);
2599 };
2600
2601
2602 // DescriptorArrays are fixed arrays used to hold instance descriptors.
2603 // The format of the these objects is:
2604 //   [0]: Number of descriptors
2605 //   [1]: Either Smi(0) if uninitialized, or a pointer to small fixed array:
2606 //          [0]: pointer to fixed array with enum cache
2607 //          [1]: either Smi(0) or pointer to fixed array with indices
2608 //   [2]: first key
2609 //   [2 + number of descriptors * kDescriptorSize]: start of slack
2610 class DescriptorArray: public FixedArray {
2611  public:
2612   // Returns true for both shared empty_descriptor_array and for smis, which the
2613   // map uses to encode additional bit fields when the descriptor array is not
2614   // yet used.
2615   inline bool IsEmpty();
2616
2617   // Returns the number of descriptors in the array.
2618   inline int number_of_descriptors();
2619
2620   inline int number_of_descriptors_storage();
2621
2622   inline int NumberOfSlackDescriptors();
2623
2624   inline void SetNumberOfDescriptors(int number_of_descriptors);
2625   inline int number_of_entries();
2626
2627   inline bool HasEnumCache();
2628
2629   inline void CopyEnumCacheFrom(DescriptorArray* array);
2630
2631   inline FixedArray* GetEnumCache();
2632
2633   inline bool HasEnumIndicesCache();
2634
2635   inline FixedArray* GetEnumIndicesCache();
2636
2637   inline Object** GetEnumCacheSlot();
2638
2639   void ClearEnumCache();
2640
2641   // Initialize or change the enum cache,
2642   // using the supplied storage for the small "bridge".
2643   void SetEnumCache(FixedArray* bridge_storage,
2644                     FixedArray* new_cache,
2645                     Object* new_index_cache);
2646
2647   bool CanHoldValue(int descriptor, Object* value);
2648
2649   // Accessors for fetching instance descriptor at descriptor number.
2650   inline Name* GetKey(int descriptor_number);
2651   inline Object** GetKeySlot(int descriptor_number);
2652   inline Object* GetValue(int descriptor_number);
2653   inline void SetValue(int descriptor_number, Object* value);
2654   inline Object** GetValueSlot(int descriptor_number);
2655   static inline int GetValueOffset(int descriptor_number);
2656   inline Object** GetDescriptorStartSlot(int descriptor_number);
2657   inline Object** GetDescriptorEndSlot(int descriptor_number);
2658   inline PropertyDetails GetDetails(int descriptor_number);
2659   inline PropertyType GetType(int descriptor_number);
2660   inline int GetFieldIndex(int descriptor_number);
2661   inline HeapType* GetFieldType(int descriptor_number);
2662   inline Object* GetConstant(int descriptor_number);
2663   inline Object* GetCallbacksObject(int descriptor_number);
2664   inline AccessorDescriptor* GetCallbacks(int descriptor_number);
2665
2666   inline Name* GetSortedKey(int descriptor_number);
2667   inline int GetSortedKeyIndex(int descriptor_number);
2668   inline void SetSortedKey(int pointer, int descriptor_number);
2669   inline void SetRepresentation(int descriptor_number,
2670                                 Representation representation);
2671
2672   // Accessor for complete descriptor.
2673   inline void Get(int descriptor_number, Descriptor* desc);
2674   inline void Set(int descriptor_number, Descriptor* desc);
2675   void Replace(int descriptor_number, Descriptor* descriptor);
2676
2677   // Append automatically sets the enumeration index. This should only be used
2678   // to add descriptors in bulk at the end, followed by sorting the descriptor
2679   // array.
2680   inline void Append(Descriptor* desc);
2681
2682   static Handle<DescriptorArray> CopyUpTo(Handle<DescriptorArray> desc,
2683                                           int enumeration_index,
2684                                           int slack = 0);
2685
2686   static Handle<DescriptorArray> CopyUpToAddAttributes(
2687       Handle<DescriptorArray> desc,
2688       int enumeration_index,
2689       PropertyAttributes attributes,
2690       int slack = 0);
2691
2692   // Sort the instance descriptors by the hash codes of their keys.
2693   void Sort();
2694
2695   // Search the instance descriptors for given name.
2696   INLINE(int Search(Name* name, int number_of_own_descriptors));
2697
2698   // As the above, but uses DescriptorLookupCache and updates it when
2699   // necessary.
2700   INLINE(int SearchWithCache(Name* name, Map* map));
2701
2702   // Allocates a DescriptorArray, but returns the singleton
2703   // empty descriptor array object if number_of_descriptors is 0.
2704   static Handle<DescriptorArray> Allocate(Isolate* isolate,
2705                                           int number_of_descriptors,
2706                                           int slack = 0);
2707
2708   DECLARE_CAST(DescriptorArray)
2709
2710   // Constant for denoting key was not found.
2711   static const int kNotFound = -1;
2712
2713   static const int kDescriptorLengthIndex = 0;
2714   static const int kEnumCacheIndex = 1;
2715   static const int kFirstIndex = 2;
2716
2717   // The length of the "bridge" to the enum cache.
2718   static const int kEnumCacheBridgeLength = 2;
2719   static const int kEnumCacheBridgeCacheIndex = 0;
2720   static const int kEnumCacheBridgeIndicesCacheIndex = 1;
2721
2722   // Layout description.
2723   static const int kDescriptorLengthOffset = FixedArray::kHeaderSize;
2724   static const int kEnumCacheOffset = kDescriptorLengthOffset + kPointerSize;
2725   static const int kFirstOffset = kEnumCacheOffset + kPointerSize;
2726
2727   // Layout description for the bridge array.
2728   static const int kEnumCacheBridgeCacheOffset = FixedArray::kHeaderSize;
2729
2730   // Layout of descriptor.
2731   static const int kDescriptorKey = 0;
2732   static const int kDescriptorDetails = 1;
2733   static const int kDescriptorValue = 2;
2734   static const int kDescriptorSize = 3;
2735
2736 #if defined(DEBUG) || defined(OBJECT_PRINT)
2737   // For our gdb macros, we should perhaps change these in the future.
2738   void Print();
2739
2740   // Print all the descriptors.
2741   void PrintDescriptors(std::ostream& os);  // NOLINT
2742 #endif
2743
2744 #ifdef DEBUG
2745   // Is the descriptor array sorted and without duplicates?
2746   bool IsSortedNoDuplicates(int valid_descriptors = -1);
2747
2748   // Is the descriptor array consistent with the back pointers in targets?
2749   bool IsConsistentWithBackPointers(Map* current_map);
2750
2751   // Are two DescriptorArrays equal?
2752   bool IsEqualTo(DescriptorArray* other);
2753 #endif
2754
2755   // Returns the fixed array length required to hold number_of_descriptors
2756   // descriptors.
2757   static int LengthFor(int number_of_descriptors) {
2758     return ToKeyIndex(number_of_descriptors);
2759   }
2760
2761  private:
2762   // WhitenessWitness is used to prove that a descriptor array is white
2763   // (unmarked), so incremental write barriers can be skipped because the
2764   // marking invariant cannot be broken and slots pointing into evacuation
2765   // candidates will be discovered when the object is scanned. A witness is
2766   // always stack-allocated right after creating an array. By allocating a
2767   // witness, incremental marking is globally disabled. The witness is then
2768   // passed along wherever needed to statically prove that the array is known to
2769   // be white.
2770   class WhitenessWitness {
2771    public:
2772     inline explicit WhitenessWitness(DescriptorArray* array);
2773     inline ~WhitenessWitness();
2774
2775    private:
2776     IncrementalMarking* marking_;
2777   };
2778
2779   // An entry in a DescriptorArray, represented as an (array, index) pair.
2780   class Entry {
2781    public:
2782     inline explicit Entry(DescriptorArray* descs, int index) :
2783         descs_(descs), index_(index) { }
2784
2785     inline PropertyType type();
2786     inline Object* GetCallbackObject();
2787
2788    private:
2789     DescriptorArray* descs_;
2790     int index_;
2791   };
2792
2793   // Conversion from descriptor number to array indices.
2794   static int ToKeyIndex(int descriptor_number) {
2795     return kFirstIndex +
2796            (descriptor_number * kDescriptorSize) +
2797            kDescriptorKey;
2798   }
2799
2800   static int ToDetailsIndex(int descriptor_number) {
2801     return kFirstIndex +
2802            (descriptor_number * kDescriptorSize) +
2803            kDescriptorDetails;
2804   }
2805
2806   static int ToValueIndex(int descriptor_number) {
2807     return kFirstIndex +
2808            (descriptor_number * kDescriptorSize) +
2809            kDescriptorValue;
2810   }
2811
2812   // Transfer a complete descriptor from the src descriptor array to this
2813   // descriptor array.
2814   void CopyFrom(int index, DescriptorArray* src, const WhitenessWitness&);
2815
2816   inline void Set(int descriptor_number,
2817                   Descriptor* desc,
2818                   const WhitenessWitness&);
2819
2820   // Swap first and second descriptor.
2821   inline void SwapSortedKeys(int first, int second);
2822
2823   DISALLOW_IMPLICIT_CONSTRUCTORS(DescriptorArray);
2824 };
2825
2826
2827 enum SearchMode { ALL_ENTRIES, VALID_ENTRIES };
2828
2829 template <SearchMode search_mode, typename T>
2830 inline int Search(T* array, Name* name, int valid_entries = 0,
2831                   int* out_insertion_index = NULL);
2832
2833
2834 // HashTable is a subclass of FixedArray that implements a hash table
2835 // that uses open addressing and quadratic probing.
2836 //
2837 // In order for the quadratic probing to work, elements that have not
2838 // yet been used and elements that have been deleted are
2839 // distinguished.  Probing continues when deleted elements are
2840 // encountered and stops when unused elements are encountered.
2841 //
2842 // - Elements with key == undefined have not been used yet.
2843 // - Elements with key == the_hole have been deleted.
2844 //
2845 // The hash table class is parameterized with a Shape and a Key.
2846 // Shape must be a class with the following interface:
2847 //   class ExampleShape {
2848 //    public:
2849 //      // Tells whether key matches other.
2850 //     static bool IsMatch(Key key, Object* other);
2851 //     // Returns the hash value for key.
2852 //     static uint32_t Hash(Key key);
2853 //     // Returns the hash value for object.
2854 //     static uint32_t HashForObject(Key key, Object* object);
2855 //     // Convert key to an object.
2856 //     static inline Handle<Object> AsHandle(Isolate* isolate, Key key);
2857 //     // The prefix size indicates number of elements in the beginning
2858 //     // of the backing storage.
2859 //     static const int kPrefixSize = ..;
2860 //     // The Element size indicates number of elements per entry.
2861 //     static const int kEntrySize = ..;
2862 //   };
2863 // The prefix size indicates an amount of memory in the
2864 // beginning of the backing storage that can be used for non-element
2865 // information by subclasses.
2866
2867 template<typename Key>
2868 class BaseShape {
2869  public:
2870   static const bool UsesSeed = false;
2871   static uint32_t Hash(Key key) { return 0; }
2872   static uint32_t SeededHash(Key key, uint32_t seed) {
2873     DCHECK(UsesSeed);
2874     return Hash(key);
2875   }
2876   static uint32_t HashForObject(Key key, Object* object) { return 0; }
2877   static uint32_t SeededHashForObject(Key key, uint32_t seed, Object* object) {
2878     DCHECK(UsesSeed);
2879     return HashForObject(key, object);
2880   }
2881 };
2882
2883
2884 class HashTableBase : public FixedArray {
2885  public:
2886   // Returns the number of elements in the hash table.
2887   inline int NumberOfElements();
2888
2889   // Returns the number of deleted elements in the hash table.
2890   inline int NumberOfDeletedElements();
2891
2892   // Returns the capacity of the hash table.
2893   inline int Capacity();
2894
2895   // ElementAdded should be called whenever an element is added to a
2896   // hash table.
2897   inline void ElementAdded();
2898
2899   // ElementRemoved should be called whenever an element is removed from
2900   // a hash table.
2901   inline void ElementRemoved();
2902   inline void ElementsRemoved(int n);
2903
2904   // Computes the required capacity for a table holding the given
2905   // number of elements. May be more than HashTable::kMaxCapacity.
2906   static inline int ComputeCapacity(int at_least_space_for);
2907
2908   // Tells whether k is a real key.  The hole and undefined are not allowed
2909   // as keys and can be used to indicate missing or deleted elements.
2910   inline bool IsKey(Object* k);
2911
2912   // Compute the probe offset (quadratic probing).
2913   INLINE(static uint32_t GetProbeOffset(uint32_t n)) {
2914     return (n + n * n) >> 1;
2915   }
2916
2917   static const int kNumberOfElementsIndex = 0;
2918   static const int kNumberOfDeletedElementsIndex = 1;
2919   static const int kCapacityIndex = 2;
2920   static const int kPrefixStartIndex = 3;
2921
2922   // Constant used for denoting a absent entry.
2923   static const int kNotFound = -1;
2924
2925  protected:
2926   // Update the number of elements in the hash table.
2927   inline void SetNumberOfElements(int nof);
2928
2929   // Update the number of deleted elements in the hash table.
2930   inline void SetNumberOfDeletedElements(int nod);
2931
2932   // Returns probe entry.
2933   static uint32_t GetProbe(uint32_t hash, uint32_t number, uint32_t size) {
2934     DCHECK(base::bits::IsPowerOfTwo32(size));
2935     return (hash + GetProbeOffset(number)) & (size - 1);
2936   }
2937
2938   inline static uint32_t FirstProbe(uint32_t hash, uint32_t size) {
2939     return hash & (size - 1);
2940   }
2941
2942   inline static uint32_t NextProbe(
2943       uint32_t last, uint32_t number, uint32_t size) {
2944     return (last + number) & (size - 1);
2945   }
2946 };
2947
2948
2949 template <typename Derived, typename Shape, typename Key>
2950 class HashTable : public HashTableBase {
2951  public:
2952   // Wrapper methods
2953   inline uint32_t Hash(Key key) {
2954     if (Shape::UsesSeed) {
2955       return Shape::SeededHash(key, GetHeap()->HashSeed());
2956     } else {
2957       return Shape::Hash(key);
2958     }
2959   }
2960
2961   inline uint32_t HashForObject(Key key, Object* object) {
2962     if (Shape::UsesSeed) {
2963       return Shape::SeededHashForObject(key, GetHeap()->HashSeed(), object);
2964     } else {
2965       return Shape::HashForObject(key, object);
2966     }
2967   }
2968
2969   // Returns a new HashTable object.
2970   MUST_USE_RESULT static Handle<Derived> New(
2971       Isolate* isolate, int at_least_space_for,
2972       MinimumCapacity capacity_option = USE_DEFAULT_MINIMUM_CAPACITY,
2973       PretenureFlag pretenure = NOT_TENURED);
2974
2975   DECLARE_CAST(HashTable)
2976
2977   // Garbage collection support.
2978   void IteratePrefix(ObjectVisitor* visitor);
2979   void IterateElements(ObjectVisitor* visitor);
2980
2981   // Find entry for key otherwise return kNotFound.
2982   inline int FindEntry(Key key);
2983   inline int FindEntry(Isolate* isolate, Key key, int32_t hash);
2984   int FindEntry(Isolate* isolate, Key key);
2985
2986   // Rehashes the table in-place.
2987   void Rehash(Key key);
2988
2989   // Returns the key at entry.
2990   Object* KeyAt(int entry) { return get(EntryToIndex(entry)); }
2991
2992   static const int kElementsStartIndex = kPrefixStartIndex + Shape::kPrefixSize;
2993   static const int kEntrySize = Shape::kEntrySize;
2994   static const int kElementsStartOffset =
2995       kHeaderSize + kElementsStartIndex * kPointerSize;
2996   static const int kCapacityOffset =
2997       kHeaderSize + kCapacityIndex * kPointerSize;
2998
2999   // Returns the index for an entry (of the key)
3000   static inline int EntryToIndex(int entry) {
3001     return (entry * kEntrySize) + kElementsStartIndex;
3002   }
3003
3004  protected:
3005   friend class ObjectHashTable;
3006
3007   // Find the entry at which to insert element with the given key that
3008   // has the given hash value.
3009   uint32_t FindInsertionEntry(uint32_t hash);
3010
3011   // Attempt to shrink hash table after removal of key.
3012   MUST_USE_RESULT static Handle<Derived> Shrink(Handle<Derived> table, Key key);
3013
3014   // Ensure enough space for n additional elements.
3015   MUST_USE_RESULT static Handle<Derived> EnsureCapacity(
3016       Handle<Derived> table,
3017       int n,
3018       Key key,
3019       PretenureFlag pretenure = NOT_TENURED);
3020
3021   // Sets the capacity of the hash table.
3022   void SetCapacity(int capacity) {
3023     // To scale a computed hash code to fit within the hash table, we
3024     // use bit-wise AND with a mask, so the capacity must be positive
3025     // and non-zero.
3026     DCHECK(capacity > 0);
3027     DCHECK(capacity <= kMaxCapacity);
3028     set(kCapacityIndex, Smi::FromInt(capacity));
3029   }
3030
3031   // Maximal capacity of HashTable. Based on maximal length of underlying
3032   // FixedArray. Staying below kMaxCapacity also ensures that EntryToIndex
3033   // cannot overflow.
3034   static const int kMaxCapacity =
3035       (FixedArray::kMaxLength - kElementsStartOffset) / kEntrySize;
3036
3037  private:
3038   // Returns _expected_ if one of entries given by the first _probe_ probes is
3039   // equal to  _expected_. Otherwise, returns the entry given by the probe
3040   // number _probe_.
3041   uint32_t EntryForProbe(Key key, Object* k, int probe, uint32_t expected);
3042
3043   void Swap(uint32_t entry1, uint32_t entry2, WriteBarrierMode mode);
3044
3045   // Rehashes this hash-table into the new table.
3046   void Rehash(Handle<Derived> new_table, Key key);
3047 };
3048
3049
3050 // HashTableKey is an abstract superclass for virtual key behavior.
3051 class HashTableKey {
3052  public:
3053   // Returns whether the other object matches this key.
3054   virtual bool IsMatch(Object* other) = 0;
3055   // Returns the hash value for this key.
3056   virtual uint32_t Hash() = 0;
3057   // Returns the hash value for object.
3058   virtual uint32_t HashForObject(Object* key) = 0;
3059   // Returns the key object for storing into the hash table.
3060   MUST_USE_RESULT virtual Handle<Object> AsHandle(Isolate* isolate) = 0;
3061   // Required.
3062   virtual ~HashTableKey() {}
3063 };
3064
3065
3066 class StringTableShape : public BaseShape<HashTableKey*> {
3067  public:
3068   static inline bool IsMatch(HashTableKey* key, Object* value) {
3069     return key->IsMatch(value);
3070   }
3071
3072   static inline uint32_t Hash(HashTableKey* key) {
3073     return key->Hash();
3074   }
3075
3076   static inline uint32_t HashForObject(HashTableKey* key, Object* object) {
3077     return key->HashForObject(object);
3078   }
3079
3080   static inline Handle<Object> AsHandle(Isolate* isolate, HashTableKey* key);
3081
3082   static const int kPrefixSize = 0;
3083   static const int kEntrySize = 1;
3084 };
3085
3086 class SeqOneByteString;
3087
3088 // StringTable.
3089 //
3090 // No special elements in the prefix and the element size is 1
3091 // because only the string itself (the key) needs to be stored.
3092 class StringTable: public HashTable<StringTable,
3093                                     StringTableShape,
3094                                     HashTableKey*> {
3095  public:
3096   // Find string in the string table. If it is not there yet, it is
3097   // added. The return value is the string found.
3098   static Handle<String> LookupString(Isolate* isolate, Handle<String> key);
3099   static Handle<String> LookupKey(Isolate* isolate, HashTableKey* key);
3100   static String* LookupKeyIfExists(Isolate* isolate, HashTableKey* key);
3101
3102   // Tries to internalize given string and returns string handle on success
3103   // or an empty handle otherwise.
3104   MUST_USE_RESULT static MaybeHandle<String> InternalizeStringIfExists(
3105       Isolate* isolate,
3106       Handle<String> string);
3107
3108   // Looks up a string that is equal to the given string and returns
3109   // string handle if it is found, or an empty handle otherwise.
3110   MUST_USE_RESULT static MaybeHandle<String> LookupStringIfExists(
3111       Isolate* isolate,
3112       Handle<String> str);
3113   MUST_USE_RESULT static MaybeHandle<String> LookupTwoCharsStringIfExists(
3114       Isolate* isolate,
3115       uint16_t c1,
3116       uint16_t c2);
3117
3118   static void EnsureCapacityForDeserialization(Isolate* isolate, int expected);
3119
3120   DECLARE_CAST(StringTable)
3121
3122  private:
3123   template <bool seq_one_byte>
3124   friend class JsonParser;
3125
3126   DISALLOW_IMPLICIT_CONSTRUCTORS(StringTable);
3127 };
3128
3129
3130 template <typename Derived, typename Shape, typename Key>
3131 class Dictionary: public HashTable<Derived, Shape, Key> {
3132   typedef HashTable<Derived, Shape, Key> DerivedHashTable;
3133
3134  public:
3135   // Returns the value at entry.
3136   Object* ValueAt(int entry) {
3137     return this->get(Derived::EntryToIndex(entry) + 1);
3138   }
3139
3140   // Set the value for entry.
3141   void ValueAtPut(int entry, Object* value) {
3142     this->set(Derived::EntryToIndex(entry) + 1, value);
3143   }
3144
3145   // Returns the property details for the property at entry.
3146   PropertyDetails DetailsAt(int entry) {
3147     return Shape::DetailsAt(static_cast<Derived*>(this), entry);
3148   }
3149
3150   // Set the details for entry.
3151   void DetailsAtPut(int entry, PropertyDetails value) {
3152     Shape::DetailsAtPut(static_cast<Derived*>(this), entry, value);
3153   }
3154
3155   // Returns true if property at given entry is deleted.
3156   bool IsDeleted(int entry) {
3157     return Shape::IsDeleted(static_cast<Derived*>(this), entry);
3158   }
3159
3160   // Delete a property from the dictionary.
3161   static Handle<Object> DeleteProperty(Handle<Derived> dictionary, int entry);
3162
3163   // Attempt to shrink the dictionary after deletion of key.
3164   MUST_USE_RESULT static inline Handle<Derived> Shrink(
3165       Handle<Derived> dictionary,
3166       Key key) {
3167     return DerivedHashTable::Shrink(dictionary, key);
3168   }
3169
3170   // Sorting support
3171   // TODO(dcarney): templatize or move to SeededNumberDictionary
3172   void CopyValuesTo(FixedArray* elements);
3173
3174   // Returns the number of elements in the dictionary filtering out properties
3175   // with the specified attributes.
3176   int NumberOfElementsFilterAttributes(PropertyAttributes filter);
3177
3178   // Returns the number of enumerable elements in the dictionary.
3179   int NumberOfEnumElements() {
3180     return NumberOfElementsFilterAttributes(
3181         static_cast<PropertyAttributes>(DONT_ENUM | SYMBOLIC));
3182   }
3183
3184   // Returns true if the dictionary contains any elements that are non-writable,
3185   // non-configurable, non-enumerable, or have getters/setters.
3186   bool HasComplexElements();
3187
3188   enum SortMode { UNSORTED, SORTED };
3189
3190   // Fill in details for properties into storage.
3191   // Returns the number of properties added.
3192   int CopyKeysTo(FixedArray* storage, int index, PropertyAttributes filter,
3193                  SortMode sort_mode);
3194
3195   // Copies enumerable keys to preallocated fixed array.
3196   void CopyEnumKeysTo(FixedArray* storage);
3197
3198   // Accessors for next enumeration index.
3199   void SetNextEnumerationIndex(int index) {
3200     DCHECK(index != 0);
3201     this->set(kNextEnumerationIndexIndex, Smi::FromInt(index));
3202   }
3203
3204   int NextEnumerationIndex() {
3205     return Smi::cast(this->get(kNextEnumerationIndexIndex))->value();
3206   }
3207
3208   // Creates a new dictionary.
3209   MUST_USE_RESULT static Handle<Derived> New(
3210       Isolate* isolate,
3211       int at_least_space_for,
3212       PretenureFlag pretenure = NOT_TENURED);
3213
3214   // Ensure enough space for n additional elements.
3215   static Handle<Derived> EnsureCapacity(Handle<Derived> obj, int n, Key key);
3216
3217 #ifdef OBJECT_PRINT
3218   void Print(std::ostream& os);  // NOLINT
3219 #endif
3220   // Returns the key (slow).
3221   Object* SlowReverseLookup(Object* value);
3222
3223   // Sets the entry to (key, value) pair.
3224   inline void SetEntry(int entry,
3225                        Handle<Object> key,
3226                        Handle<Object> value);
3227   inline void SetEntry(int entry,
3228                        Handle<Object> key,
3229                        Handle<Object> value,
3230                        PropertyDetails details);
3231
3232   MUST_USE_RESULT static Handle<Derived> Add(
3233       Handle<Derived> dictionary,
3234       Key key,
3235       Handle<Object> value,
3236       PropertyDetails details);
3237
3238   // Returns iteration indices array for the |dictionary|.
3239   // Values are direct indices in the |HashTable| array.
3240   static Handle<FixedArray> BuildIterationIndicesArray(
3241       Handle<Derived> dictionary);
3242
3243  protected:
3244   // Generic at put operation.
3245   MUST_USE_RESULT static Handle<Derived> AtPut(
3246       Handle<Derived> dictionary,
3247       Key key,
3248       Handle<Object> value);
3249
3250   // Add entry to dictionary.
3251   static void AddEntry(
3252       Handle<Derived> dictionary,
3253       Key key,
3254       Handle<Object> value,
3255       PropertyDetails details,
3256       uint32_t hash);
3257
3258   // Generate new enumeration indices to avoid enumeration index overflow.
3259   // Returns iteration indices array for the |dictionary|.
3260   static Handle<FixedArray> GenerateNewEnumerationIndices(
3261       Handle<Derived> dictionary);
3262   static const int kMaxNumberKeyIndex = DerivedHashTable::kPrefixStartIndex;
3263   static const int kNextEnumerationIndexIndex = kMaxNumberKeyIndex + 1;
3264 };
3265
3266
3267 template <typename Derived, typename Shape>
3268 class NameDictionaryBase : public Dictionary<Derived, Shape, Handle<Name> > {
3269   typedef Dictionary<Derived, Shape, Handle<Name> > DerivedDictionary;
3270
3271  public:
3272   // Find entry for key, otherwise return kNotFound. Optimized version of
3273   // HashTable::FindEntry.
3274   int FindEntry(Handle<Name> key);
3275 };
3276
3277
3278 template <typename Key>
3279 class BaseDictionaryShape : public BaseShape<Key> {
3280  public:
3281   template <typename Dictionary>
3282   static inline PropertyDetails DetailsAt(Dictionary* dict, int entry) {
3283     STATIC_ASSERT(Dictionary::kEntrySize == 3);
3284     DCHECK(entry >= 0);  // Not found is -1, which is not caught by get().
3285     return PropertyDetails(
3286         Smi::cast(dict->get(Dictionary::EntryToIndex(entry) + 2)));
3287   }
3288
3289   template <typename Dictionary>
3290   static inline void DetailsAtPut(Dictionary* dict, int entry,
3291                                   PropertyDetails value) {
3292     STATIC_ASSERT(Dictionary::kEntrySize == 3);
3293     dict->set(Dictionary::EntryToIndex(entry) + 2, value.AsSmi());
3294   }
3295
3296   template <typename Dictionary>
3297   static bool IsDeleted(Dictionary* dict, int entry) {
3298     return false;
3299   }
3300
3301   template <typename Dictionary>
3302   static inline void SetEntry(Dictionary* dict, int entry, Handle<Object> key,
3303                               Handle<Object> value, PropertyDetails details);
3304 };
3305
3306
3307 class NameDictionaryShape : public BaseDictionaryShape<Handle<Name> > {
3308  public:
3309   static inline bool IsMatch(Handle<Name> key, Object* other);
3310   static inline uint32_t Hash(Handle<Name> key);
3311   static inline uint32_t HashForObject(Handle<Name> key, Object* object);
3312   static inline Handle<Object> AsHandle(Isolate* isolate, Handle<Name> key);
3313   static const int kPrefixSize = 2;
3314   static const int kEntrySize = 3;
3315   static const bool kIsEnumerable = true;
3316 };
3317
3318
3319 class NameDictionary
3320     : public NameDictionaryBase<NameDictionary, NameDictionaryShape> {
3321   typedef NameDictionaryBase<NameDictionary, NameDictionaryShape>
3322       DerivedDictionary;
3323
3324  public:
3325   DECLARE_CAST(NameDictionary)
3326
3327   inline static Handle<FixedArray> DoGenerateNewEnumerationIndices(
3328       Handle<NameDictionary> dictionary);
3329 };
3330
3331
3332 class GlobalDictionaryShape : public NameDictionaryShape {
3333  public:
3334   static const int kEntrySize = 2;  // Overrides NameDictionaryShape::kEntrySize
3335
3336   template <typename Dictionary>
3337   static inline PropertyDetails DetailsAt(Dictionary* dict, int entry);
3338
3339   template <typename Dictionary>
3340   static inline void DetailsAtPut(Dictionary* dict, int entry,
3341                                   PropertyDetails value);
3342
3343   template <typename Dictionary>
3344   static bool IsDeleted(Dictionary* dict, int entry);
3345
3346   template <typename Dictionary>
3347   static inline void SetEntry(Dictionary* dict, int entry, Handle<Object> key,
3348                               Handle<Object> value, PropertyDetails details);
3349 };
3350
3351
3352 class GlobalDictionary
3353     : public NameDictionaryBase<GlobalDictionary, GlobalDictionaryShape> {
3354  public:
3355   DECLARE_CAST(GlobalDictionary)
3356 };
3357
3358
3359 class NumberDictionaryShape : public BaseDictionaryShape<uint32_t> {
3360  public:
3361   static inline bool IsMatch(uint32_t key, Object* other);
3362   static inline Handle<Object> AsHandle(Isolate* isolate, uint32_t key);
3363   static const int kEntrySize = 3;
3364   static const bool kIsEnumerable = false;
3365 };
3366
3367
3368 class SeededNumberDictionaryShape : public NumberDictionaryShape {
3369  public:
3370   static const bool UsesSeed = true;
3371   static const int kPrefixSize = 2;
3372
3373   static inline uint32_t SeededHash(uint32_t key, uint32_t seed);
3374   static inline uint32_t SeededHashForObject(uint32_t key,
3375                                              uint32_t seed,
3376                                              Object* object);
3377 };
3378
3379
3380 class UnseededNumberDictionaryShape : public NumberDictionaryShape {
3381  public:
3382   static const int kPrefixSize = 0;
3383
3384   static inline uint32_t Hash(uint32_t key);
3385   static inline uint32_t HashForObject(uint32_t key, Object* object);
3386 };
3387
3388
3389 class SeededNumberDictionary
3390     : public Dictionary<SeededNumberDictionary,
3391                         SeededNumberDictionaryShape,
3392                         uint32_t> {
3393  public:
3394   DECLARE_CAST(SeededNumberDictionary)
3395
3396   // Type specific at put (default NONE attributes is used when adding).
3397   MUST_USE_RESULT static Handle<SeededNumberDictionary> AtNumberPut(
3398       Handle<SeededNumberDictionary> dictionary, uint32_t key,
3399       Handle<Object> value, bool used_as_prototype);
3400   MUST_USE_RESULT static Handle<SeededNumberDictionary> AddNumberEntry(
3401       Handle<SeededNumberDictionary> dictionary, uint32_t key,
3402       Handle<Object> value, PropertyDetails details, bool used_as_prototype);
3403
3404   // Set an existing entry or add a new one if needed.
3405   // Return the updated dictionary.
3406   MUST_USE_RESULT static Handle<SeededNumberDictionary> Set(
3407       Handle<SeededNumberDictionary> dictionary, uint32_t key,
3408       Handle<Object> value, PropertyDetails details, bool used_as_prototype);
3409
3410   void UpdateMaxNumberKey(uint32_t key, bool used_as_prototype);
3411
3412   // If slow elements are required we will never go back to fast-case
3413   // for the elements kept in this dictionary.  We require slow
3414   // elements if an element has been added at an index larger than
3415   // kRequiresSlowElementsLimit or set_requires_slow_elements() has been called
3416   // when defining a getter or setter with a number key.
3417   inline bool requires_slow_elements();
3418   inline void set_requires_slow_elements();
3419
3420   // Get the value of the max number key that has been added to this
3421   // dictionary.  max_number_key can only be called if
3422   // requires_slow_elements returns false.
3423   inline uint32_t max_number_key();
3424
3425   // Bit masks.
3426   static const int kRequiresSlowElementsMask = 1;
3427   static const int kRequiresSlowElementsTagSize = 1;
3428   static const uint32_t kRequiresSlowElementsLimit = (1 << 29) - 1;
3429 };
3430
3431
3432 class UnseededNumberDictionary
3433     : public Dictionary<UnseededNumberDictionary,
3434                         UnseededNumberDictionaryShape,
3435                         uint32_t> {
3436  public:
3437   DECLARE_CAST(UnseededNumberDictionary)
3438
3439   // Type specific at put (default NONE attributes is used when adding).
3440   MUST_USE_RESULT static Handle<UnseededNumberDictionary> AtNumberPut(
3441       Handle<UnseededNumberDictionary> dictionary,
3442       uint32_t key,
3443       Handle<Object> value);
3444   MUST_USE_RESULT static Handle<UnseededNumberDictionary> AddNumberEntry(
3445       Handle<UnseededNumberDictionary> dictionary,
3446       uint32_t key,
3447       Handle<Object> value);
3448
3449   // Set an existing entry or add a new one if needed.
3450   // Return the updated dictionary.
3451   MUST_USE_RESULT static Handle<UnseededNumberDictionary> Set(
3452       Handle<UnseededNumberDictionary> dictionary,
3453       uint32_t key,
3454       Handle<Object> value);
3455 };
3456
3457
3458 class ObjectHashTableShape : public BaseShape<Handle<Object> > {
3459  public:
3460   static inline bool IsMatch(Handle<Object> key, Object* other);
3461   static inline uint32_t Hash(Handle<Object> key);
3462   static inline uint32_t HashForObject(Handle<Object> key, Object* object);
3463   static inline Handle<Object> AsHandle(Isolate* isolate, Handle<Object> key);
3464   static const int kPrefixSize = 0;
3465   static const int kEntrySize = 2;
3466 };
3467
3468
3469 // ObjectHashTable maps keys that are arbitrary objects to object values by
3470 // using the identity hash of the key for hashing purposes.
3471 class ObjectHashTable: public HashTable<ObjectHashTable,
3472                                         ObjectHashTableShape,
3473                                         Handle<Object> > {
3474   typedef HashTable<
3475       ObjectHashTable, ObjectHashTableShape, Handle<Object> > DerivedHashTable;
3476  public:
3477   DECLARE_CAST(ObjectHashTable)
3478
3479   // Attempt to shrink hash table after removal of key.
3480   MUST_USE_RESULT static inline Handle<ObjectHashTable> Shrink(
3481       Handle<ObjectHashTable> table,
3482       Handle<Object> key);
3483
3484   // Looks up the value associated with the given key. The hole value is
3485   // returned in case the key is not present.
3486   Object* Lookup(Handle<Object> key);
3487   Object* Lookup(Handle<Object> key, int32_t hash);
3488   Object* Lookup(Isolate* isolate, Handle<Object> key, int32_t hash);
3489
3490   // Adds (or overwrites) the value associated with the given key.
3491   static Handle<ObjectHashTable> Put(Handle<ObjectHashTable> table,
3492                                      Handle<Object> key,
3493                                      Handle<Object> value);
3494   static Handle<ObjectHashTable> Put(Handle<ObjectHashTable> table,
3495                                      Handle<Object> key, Handle<Object> value,
3496                                      int32_t hash);
3497
3498   // Returns an ObjectHashTable (possibly |table|) where |key| has been removed.
3499   static Handle<ObjectHashTable> Remove(Handle<ObjectHashTable> table,
3500                                         Handle<Object> key,
3501                                         bool* was_present);
3502   static Handle<ObjectHashTable> Remove(Handle<ObjectHashTable> table,
3503                                         Handle<Object> key, bool* was_present,
3504                                         int32_t hash);
3505
3506  protected:
3507   friend class MarkCompactCollector;
3508
3509   void AddEntry(int entry, Object* key, Object* value);
3510   void RemoveEntry(int entry);
3511
3512   // Returns the index to the value of an entry.
3513   static inline int EntryToValueIndex(int entry) {
3514     return EntryToIndex(entry) + 1;
3515   }
3516 };
3517
3518
3519 // OrderedHashTable is a HashTable with Object keys that preserves
3520 // insertion order. There are Map and Set interfaces (OrderedHashMap
3521 // and OrderedHashTable, below). It is meant to be used by JSMap/JSSet.
3522 //
3523 // Only Object* keys are supported, with Object::SameValueZero() used as the
3524 // equality operator and Object::GetHash() for the hash function.
3525 //
3526 // Based on the "Deterministic Hash Table" as described by Jason Orendorff at
3527 // https://wiki.mozilla.org/User:Jorend/Deterministic_hash_tables
3528 // Originally attributed to Tyler Close.
3529 //
3530 // Memory layout:
3531 //   [0]: bucket count
3532 //   [1]: element count
3533 //   [2]: deleted element count
3534 //   [3..(3 + NumberOfBuckets() - 1)]: "hash table", where each item is an
3535 //                            offset into the data table (see below) where the
3536 //                            first item in this bucket is stored.
3537 //   [3 + NumberOfBuckets()..length]: "data table", an array of length
3538 //                            Capacity() * kEntrySize, where the first entrysize
3539 //                            items are handled by the derived class and the
3540 //                            item at kChainOffset is another entry into the
3541 //                            data table indicating the next entry in this hash
3542 //                            bucket.
3543 //
3544 // When we transition the table to a new version we obsolete it and reuse parts
3545 // of the memory to store information how to transition an iterator to the new
3546 // table:
3547 //
3548 // Memory layout for obsolete table:
3549 //   [0]: bucket count
3550 //   [1]: Next newer table
3551 //   [2]: Number of removed holes or -1 when the table was cleared.
3552 //   [3..(3 + NumberOfRemovedHoles() - 1)]: The indexes of the removed holes.
3553 //   [3 + NumberOfRemovedHoles()..length]: Not used
3554 //
3555 template<class Derived, class Iterator, int entrysize>
3556 class OrderedHashTable: public FixedArray {
3557  public:
3558   // Returns an OrderedHashTable with a capacity of at least |capacity|.
3559   static Handle<Derived> Allocate(
3560       Isolate* isolate, int capacity, PretenureFlag pretenure = NOT_TENURED);
3561
3562   // Returns an OrderedHashTable (possibly |table|) with enough space
3563   // to add at least one new element.
3564   static Handle<Derived> EnsureGrowable(Handle<Derived> table);
3565
3566   // Returns an OrderedHashTable (possibly |table|) that's shrunken
3567   // if possible.
3568   static Handle<Derived> Shrink(Handle<Derived> table);
3569
3570   // Returns a new empty OrderedHashTable and records the clearing so that
3571   // exisiting iterators can be updated.
3572   static Handle<Derived> Clear(Handle<Derived> table);
3573
3574   int NumberOfElements() {
3575     return Smi::cast(get(kNumberOfElementsIndex))->value();
3576   }
3577
3578   int NumberOfDeletedElements() {
3579     return Smi::cast(get(kNumberOfDeletedElementsIndex))->value();
3580   }
3581
3582   int UsedCapacity() { return NumberOfElements() + NumberOfDeletedElements(); }
3583
3584   int NumberOfBuckets() {
3585     return Smi::cast(get(kNumberOfBucketsIndex))->value();
3586   }
3587
3588   // Returns an index into |this| for the given entry.
3589   int EntryToIndex(int entry) {
3590     return kHashTableStartIndex + NumberOfBuckets() + (entry * kEntrySize);
3591   }
3592
3593   Object* KeyAt(int entry) { return get(EntryToIndex(entry)); }
3594
3595   bool IsObsolete() {
3596     return !get(kNextTableIndex)->IsSmi();
3597   }
3598
3599   // The next newer table. This is only valid if the table is obsolete.
3600   Derived* NextTable() {
3601     return Derived::cast(get(kNextTableIndex));
3602   }
3603
3604   // When the table is obsolete we store the indexes of the removed holes.
3605   int RemovedIndexAt(int index) {
3606     return Smi::cast(get(kRemovedHolesIndex + index))->value();
3607   }
3608
3609   static const int kNotFound = -1;
3610   static const int kMinCapacity = 4;
3611
3612   static const int kNumberOfBucketsIndex = 0;
3613   static const int kNumberOfElementsIndex = kNumberOfBucketsIndex + 1;
3614   static const int kNumberOfDeletedElementsIndex = kNumberOfElementsIndex + 1;
3615   static const int kHashTableStartIndex = kNumberOfDeletedElementsIndex + 1;
3616   static const int kNextTableIndex = kNumberOfElementsIndex;
3617
3618   static const int kNumberOfBucketsOffset =
3619       kHeaderSize + kNumberOfBucketsIndex * kPointerSize;
3620   static const int kNumberOfElementsOffset =
3621       kHeaderSize + kNumberOfElementsIndex * kPointerSize;
3622   static const int kNumberOfDeletedElementsOffset =
3623       kHeaderSize + kNumberOfDeletedElementsIndex * kPointerSize;
3624   static const int kHashTableStartOffset =
3625       kHeaderSize + kHashTableStartIndex * kPointerSize;
3626   static const int kNextTableOffset =
3627       kHeaderSize + kNextTableIndex * kPointerSize;
3628
3629   static const int kEntrySize = entrysize + 1;
3630   static const int kChainOffset = entrysize;
3631
3632   static const int kLoadFactor = 2;
3633
3634   // NumberOfDeletedElements is set to kClearedTableSentinel when
3635   // the table is cleared, which allows iterator transitions to
3636   // optimize that case.
3637   static const int kClearedTableSentinel = -1;
3638
3639  private:
3640   static Handle<Derived> Rehash(Handle<Derived> table, int new_capacity);
3641
3642   void SetNumberOfBuckets(int num) {
3643     set(kNumberOfBucketsIndex, Smi::FromInt(num));
3644   }
3645
3646   void SetNumberOfElements(int num) {
3647     set(kNumberOfElementsIndex, Smi::FromInt(num));
3648   }
3649
3650   void SetNumberOfDeletedElements(int num) {
3651     set(kNumberOfDeletedElementsIndex, Smi::FromInt(num));
3652   }
3653
3654   int Capacity() {
3655     return NumberOfBuckets() * kLoadFactor;
3656   }
3657
3658   void SetNextTable(Derived* next_table) {
3659     set(kNextTableIndex, next_table);
3660   }
3661
3662   void SetRemovedIndexAt(int index, int removed_index) {
3663     return set(kRemovedHolesIndex + index, Smi::FromInt(removed_index));
3664   }
3665
3666   static const int kRemovedHolesIndex = kHashTableStartIndex;
3667
3668   static const int kMaxCapacity =
3669       (FixedArray::kMaxLength - kHashTableStartIndex)
3670       / (1 + (kEntrySize * kLoadFactor));
3671 };
3672
3673
3674 class JSSetIterator;
3675
3676
3677 class OrderedHashSet: public OrderedHashTable<
3678     OrderedHashSet, JSSetIterator, 1> {
3679  public:
3680   DECLARE_CAST(OrderedHashSet)
3681 };
3682
3683
3684 class JSMapIterator;
3685
3686
3687 class OrderedHashMap
3688     : public OrderedHashTable<OrderedHashMap, JSMapIterator, 2> {
3689  public:
3690   DECLARE_CAST(OrderedHashMap)
3691
3692   inline Object* ValueAt(int entry);
3693
3694   static const int kValueOffset = 1;
3695 };
3696
3697
3698 template <int entrysize>
3699 class WeakHashTableShape : public BaseShape<Handle<Object> > {
3700  public:
3701   static inline bool IsMatch(Handle<Object> key, Object* other);
3702   static inline uint32_t Hash(Handle<Object> key);
3703   static inline uint32_t HashForObject(Handle<Object> key, Object* object);
3704   static inline Handle<Object> AsHandle(Isolate* isolate, Handle<Object> key);
3705   static const int kPrefixSize = 0;
3706   static const int kEntrySize = entrysize;
3707 };
3708
3709
3710 // WeakHashTable maps keys that are arbitrary heap objects to heap object
3711 // values. The table wraps the keys in weak cells and store values directly.
3712 // Thus it references keys weakly and values strongly.
3713 class WeakHashTable: public HashTable<WeakHashTable,
3714                                       WeakHashTableShape<2>,
3715                                       Handle<Object> > {
3716   typedef HashTable<
3717       WeakHashTable, WeakHashTableShape<2>, Handle<Object> > DerivedHashTable;
3718  public:
3719   DECLARE_CAST(WeakHashTable)
3720
3721   // Looks up the value associated with the given key. The hole value is
3722   // returned in case the key is not present.
3723   Object* Lookup(Handle<HeapObject> key);
3724
3725   // Adds (or overwrites) the value associated with the given key. Mapping a
3726   // key to the hole value causes removal of the whole entry.
3727   MUST_USE_RESULT static Handle<WeakHashTable> Put(Handle<WeakHashTable> table,
3728                                                    Handle<HeapObject> key,
3729                                                    Handle<HeapObject> value);
3730
3731   static Handle<FixedArray> GetValues(Handle<WeakHashTable> table);
3732
3733  private:
3734   friend class MarkCompactCollector;
3735
3736   void AddEntry(int entry, Handle<WeakCell> key, Handle<HeapObject> value);
3737
3738   // Returns the index to the value of an entry.
3739   static inline int EntryToValueIndex(int entry) {
3740     return EntryToIndex(entry) + 1;
3741   }
3742 };
3743
3744
3745 class WeakValueHashTable : public ObjectHashTable {
3746  public:
3747   DECLARE_CAST(WeakValueHashTable)
3748
3749 #ifdef DEBUG
3750   // Looks up the value associated with the given key. The hole value is
3751   // returned in case the key is not present.
3752   Object* LookupWeak(Handle<Object> key);
3753 #endif  // DEBUG
3754
3755   // Adds (or overwrites) the value associated with the given key. Mapping a
3756   // key to the hole value causes removal of the whole entry.
3757   MUST_USE_RESULT static Handle<WeakValueHashTable> PutWeak(
3758       Handle<WeakValueHashTable> table, Handle<Object> key,
3759       Handle<HeapObject> value);
3760
3761   static Handle<FixedArray> GetWeakValues(Handle<WeakValueHashTable> table);
3762 };
3763
3764
3765 // ScopeInfo represents information about different scopes of a source
3766 // program  and the allocation of the scope's variables. Scope information
3767 // is stored in a compressed form in ScopeInfo objects and is used
3768 // at runtime (stack dumps, deoptimization, etc.).
3769
3770 // This object provides quick access to scope info details for runtime
3771 // routines.
3772 class ScopeInfo : public FixedArray {
3773  public:
3774   DECLARE_CAST(ScopeInfo)
3775
3776   // Return the type of this scope.
3777   ScopeType scope_type();
3778
3779   // Does this scope call eval?
3780   bool CallsEval();
3781
3782   // Return the language mode of this scope.
3783   LanguageMode language_mode();
3784
3785   // Does this scope make a sloppy eval call?
3786   bool CallsSloppyEval() { return CallsEval() && is_sloppy(language_mode()); }
3787
3788   // Return the total number of locals allocated on the stack and in the
3789   // context. This includes the parameters that are allocated in the context.
3790   int LocalCount();
3791
3792   // Return the number of stack slots for code. This number consists of two
3793   // parts:
3794   //  1. One stack slot per stack allocated local.
3795   //  2. One stack slot for the function name if it is stack allocated.
3796   int StackSlotCount();
3797
3798   // Return the number of context slots for code if a context is allocated. This
3799   // number consists of three parts:
3800   //  1. Size of fixed header for every context: Context::MIN_CONTEXT_SLOTS
3801   //  2. One context slot per context allocated local.
3802   //  3. One context slot for the function name if it is context allocated.
3803   // Parameters allocated in the context count as context allocated locals. If
3804   // no contexts are allocated for this scope ContextLength returns 0.
3805   int ContextLength();
3806
3807   // Does this scope declare a "this" binding?
3808   bool HasReceiver();
3809
3810   // Does this scope declare a "this" binding, and the "this" binding is stack-
3811   // or context-allocated?
3812   bool HasAllocatedReceiver();
3813
3814   // Is this scope the scope of a named function expression?
3815   bool HasFunctionName();
3816
3817   // Return if this has context allocated locals.
3818   bool HasHeapAllocatedLocals();
3819
3820   // Return if contexts are allocated for this scope.
3821   bool HasContext();
3822
3823   // Return if this is a function scope with "use asm".
3824   inline bool IsAsmModule();
3825
3826   // Return if this is a nested function within an asm module scope.
3827   inline bool IsAsmFunction();
3828
3829   inline bool HasSimpleParameters();
3830
3831   // Return the function_name if present.
3832   String* FunctionName();
3833
3834   // Return the name of the given parameter.
3835   String* ParameterName(int var);
3836
3837   // Return the name of the given local.
3838   String* LocalName(int var);
3839
3840   // Return the name of the given stack local.
3841   String* StackLocalName(int var);
3842
3843   // Return the name of the given stack local.
3844   int StackLocalIndex(int var);
3845
3846   // Return the name of the given context local.
3847   String* ContextLocalName(int var);
3848
3849   // Return the mode of the given context local.
3850   VariableMode ContextLocalMode(int var);
3851
3852   // Return the initialization flag of the given context local.
3853   InitializationFlag ContextLocalInitFlag(int var);
3854
3855   // Return the initialization flag of the given context local.
3856   MaybeAssignedFlag ContextLocalMaybeAssignedFlag(int var);
3857
3858   // Return true if this local was introduced by the compiler, and should not be
3859   // exposed to the user in a debugger.
3860   bool LocalIsSynthetic(int var);
3861
3862   String* StrongModeFreeVariableName(int var);
3863   int StrongModeFreeVariableStartPosition(int var);
3864   int StrongModeFreeVariableEndPosition(int var);
3865
3866   // Lookup support for serialized scope info. Returns the
3867   // the stack slot index for a given slot name if the slot is
3868   // present; otherwise returns a value < 0. The name must be an internalized
3869   // string.
3870   int StackSlotIndex(String* name);
3871
3872   // Lookup support for serialized scope info. Returns the
3873   // context slot index for a given slot name if the slot is present; otherwise
3874   // returns a value < 0. The name must be an internalized string.
3875   // If the slot is present and mode != NULL, sets *mode to the corresponding
3876   // mode for that variable.
3877   static int ContextSlotIndex(Handle<ScopeInfo> scope_info, Handle<String> name,
3878                               VariableMode* mode, VariableLocation* location,
3879                               InitializationFlag* init_flag,
3880                               MaybeAssignedFlag* maybe_assigned_flag);
3881
3882   // Lookup the name of a certain context slot by its index.
3883   String* ContextSlotName(int slot_index);
3884
3885   // Lookup support for serialized scope info. Returns the
3886   // parameter index for a given parameter name if the parameter is present;
3887   // otherwise returns a value < 0. The name must be an internalized string.
3888   int ParameterIndex(String* name);
3889
3890   // Lookup support for serialized scope info. Returns the function context
3891   // slot index if the function name is present and context-allocated (named
3892   // function expressions, only), otherwise returns a value < 0. The name
3893   // must be an internalized string.
3894   int FunctionContextSlotIndex(String* name, VariableMode* mode);
3895
3896   // Lookup support for serialized scope info.  Returns the receiver context
3897   // slot index if scope has a "this" binding, and the binding is
3898   // context-allocated.  Otherwise returns a value < 0.
3899   int ReceiverContextSlotIndex();
3900
3901   FunctionKind function_kind();
3902
3903   static Handle<ScopeInfo> Create(Isolate* isolate, Zone* zone, Scope* scope);
3904   static Handle<ScopeInfo> CreateGlobalThisBinding(Isolate* isolate);
3905
3906   // Serializes empty scope info.
3907   static ScopeInfo* Empty(Isolate* isolate);
3908
3909 #ifdef DEBUG
3910   void Print();
3911 #endif
3912
3913   // The layout of the static part of a ScopeInfo is as follows. Each entry is
3914   // numeric and occupies one array slot.
3915   // 1. A set of properties of the scope
3916   // 2. The number of parameters. This only applies to function scopes. For
3917   //    non-function scopes this is 0.
3918   // 3. The number of non-parameter variables allocated on the stack.
3919   // 4. The number of non-parameter and parameter variables allocated in the
3920   //    context.
3921 #define FOR_EACH_SCOPE_INFO_NUMERIC_FIELD(V) \
3922   V(Flags)                                   \
3923   V(ParameterCount)                          \
3924   V(StackLocalCount)                         \
3925   V(ContextLocalCount)                       \
3926   V(ContextGlobalCount)                      \
3927   V(StrongModeFreeVariableCount)
3928
3929 #define FIELD_ACCESSORS(name)       \
3930   inline void Set##name(int value); \
3931   inline int name();
3932   FOR_EACH_SCOPE_INFO_NUMERIC_FIELD(FIELD_ACCESSORS)
3933 #undef FIELD_ACCESSORS
3934
3935  private:
3936   enum {
3937 #define DECL_INDEX(name) k##name,
3938     FOR_EACH_SCOPE_INFO_NUMERIC_FIELD(DECL_INDEX)
3939 #undef DECL_INDEX
3940     kVariablePartIndex
3941   };
3942
3943   // The layout of the variable part of a ScopeInfo is as follows:
3944   // 1. ParameterEntries:
3945   //    This part stores the names of the parameters for function scopes. One
3946   //    slot is used per parameter, so in total this part occupies
3947   //    ParameterCount() slots in the array. For other scopes than function
3948   //    scopes ParameterCount() is 0.
3949   // 2. StackLocalFirstSlot:
3950   //    Index of a first stack slot for stack local. Stack locals belonging to
3951   //    this scope are located on a stack at slots starting from this index.
3952   // 3. StackLocalEntries:
3953   //    Contains the names of local variables that are allocated on the stack,
3954   //    in increasing order of the stack slot index. First local variable has
3955   //    a stack slot index defined in StackLocalFirstSlot (point 2 above).
3956   //    One slot is used per stack local, so in total this part occupies
3957   //    StackLocalCount() slots in the array.
3958   // 4. ContextLocalNameEntries:
3959   //    Contains the names of local variables and parameters that are allocated
3960   //    in the context. They are stored in increasing order of the context slot
3961   //    index starting with Context::MIN_CONTEXT_SLOTS. One slot is used per
3962   //    context local, so in total this part occupies ContextLocalCount() slots
3963   //    in the array.
3964   // 5. ContextLocalInfoEntries:
3965   //    Contains the variable modes and initialization flags corresponding to
3966   //    the context locals in ContextLocalNameEntries. One slot is used per
3967   //    context local, so in total this part occupies ContextLocalCount()
3968   //    slots in the array.
3969   // 6. StrongModeFreeVariableNameEntries:
3970   //    Stores the names of strong mode free variables.
3971   // 7. StrongModeFreeVariablePositionEntries:
3972   //    Stores the locations (start and end position) of strong mode free
3973   //    variables.
3974   // 8. RecieverEntryIndex:
3975   //    If the scope binds a "this" value, one slot is reserved to hold the
3976   //    context or stack slot index for the variable.
3977   // 9. FunctionNameEntryIndex:
3978   //    If the scope belongs to a named function expression this part contains
3979   //    information about the function variable. It always occupies two array
3980   //    slots:  a. The name of the function variable.
3981   //            b. The context or stack slot index for the variable.
3982   int ParameterEntriesIndex();
3983   int StackLocalFirstSlotIndex();
3984   int StackLocalEntriesIndex();
3985   int ContextLocalNameEntriesIndex();
3986   int ContextGlobalNameEntriesIndex();
3987   int ContextLocalInfoEntriesIndex();
3988   int ContextGlobalInfoEntriesIndex();
3989   int StrongModeFreeVariableNameEntriesIndex();
3990   int StrongModeFreeVariablePositionEntriesIndex();
3991   int ReceiverEntryIndex();
3992   int FunctionNameEntryIndex();
3993
3994   int Lookup(Handle<String> name, int start, int end, VariableMode* mode,
3995              VariableLocation* location, InitializationFlag* init_flag,
3996              MaybeAssignedFlag* maybe_assigned_flag);
3997
3998   // Used for the function name variable for named function expressions, and for
3999   // the receiver.
4000   enum VariableAllocationInfo { NONE, STACK, CONTEXT, UNUSED };
4001
4002   // Properties of scopes.
4003   class ScopeTypeField : public BitField<ScopeType, 0, 4> {};
4004   class CallsEvalField : public BitField<bool, ScopeTypeField::kNext, 1> {};
4005   STATIC_ASSERT(LANGUAGE_END == 3);
4006   class LanguageModeField
4007       : public BitField<LanguageMode, CallsEvalField::kNext, 2> {};
4008   class ReceiverVariableField
4009       : public BitField<VariableAllocationInfo, LanguageModeField::kNext, 2> {};
4010   class FunctionVariableField
4011       : public BitField<VariableAllocationInfo, ReceiverVariableField::kNext,
4012                         2> {};
4013   class FunctionVariableMode
4014       : public BitField<VariableMode, FunctionVariableField::kNext, 3> {};
4015   class AsmModuleField : public BitField<bool, FunctionVariableMode::kNext, 1> {
4016   };
4017   class AsmFunctionField : public BitField<bool, AsmModuleField::kNext, 1> {};
4018   class HasSimpleParametersField
4019       : public BitField<bool, AsmFunctionField::kNext, 1> {};
4020   class FunctionKindField
4021       : public BitField<FunctionKind, HasSimpleParametersField::kNext, 8> {};
4022
4023   // BitFields representing the encoded information for context locals in the
4024   // ContextLocalInfoEntries part.
4025   class ContextLocalMode:      public BitField<VariableMode,         0, 3> {};
4026   class ContextLocalInitFlag:  public BitField<InitializationFlag,   3, 1> {};
4027   class ContextLocalMaybeAssignedFlag
4028       : public BitField<MaybeAssignedFlag, 4, 1> {};
4029
4030   friend class ScopeIterator;
4031 };
4032
4033
4034 // The cache for maps used by normalized (dictionary mode) objects.
4035 // Such maps do not have property descriptors, so a typical program
4036 // needs very limited number of distinct normalized maps.
4037 class NormalizedMapCache: public FixedArray {
4038  public:
4039   static Handle<NormalizedMapCache> New(Isolate* isolate);
4040
4041   MUST_USE_RESULT MaybeHandle<Map> Get(Handle<Map> fast_map,
4042                                        PropertyNormalizationMode mode);
4043   void Set(Handle<Map> fast_map, Handle<Map> normalized_map);
4044
4045   void Clear();
4046
4047   DECLARE_CAST(NormalizedMapCache)
4048
4049   static inline bool IsNormalizedMapCache(const Object* obj);
4050
4051   DECLARE_VERIFIER(NormalizedMapCache)
4052  private:
4053   static const int kEntries = 64;
4054
4055   static inline int GetIndex(Handle<Map> map);
4056
4057   // The following declarations hide base class methods.
4058   Object* get(int index);
4059   void set(int index, Object* value);
4060 };
4061
4062
4063 // ByteArray represents fixed sized byte arrays.  Used for the relocation info
4064 // that is attached to code objects.
4065 class ByteArray: public FixedArrayBase {
4066  public:
4067   inline int Size();
4068
4069   // Setter and getter.
4070   inline byte get(int index);
4071   inline void set(int index, byte value);
4072
4073   // Treat contents as an int array.
4074   inline int get_int(int index);
4075
4076   static int SizeFor(int length) {
4077     return OBJECT_POINTER_ALIGN(kHeaderSize + length);
4078   }
4079   // We use byte arrays for free blocks in the heap.  Given a desired size in
4080   // bytes that is a multiple of the word size and big enough to hold a byte
4081   // array, this function returns the number of elements a byte array should
4082   // have.
4083   static int LengthFor(int size_in_bytes) {
4084     DCHECK(IsAligned(size_in_bytes, kPointerSize));
4085     DCHECK(size_in_bytes >= kHeaderSize);
4086     return size_in_bytes - kHeaderSize;
4087   }
4088
4089   // Returns data start address.
4090   inline Address GetDataStartAddress();
4091
4092   // Returns a pointer to the ByteArray object for a given data start address.
4093   static inline ByteArray* FromDataStartAddress(Address address);
4094
4095   DECLARE_CAST(ByteArray)
4096
4097   // Dispatched behavior.
4098   inline int ByteArraySize();
4099   DECLARE_PRINTER(ByteArray)
4100   DECLARE_VERIFIER(ByteArray)
4101
4102   // Layout description.
4103   static const int kAlignedSize = OBJECT_POINTER_ALIGN(kHeaderSize);
4104
4105   // Maximal memory consumption for a single ByteArray.
4106   static const int kMaxSize = 512 * MB;
4107   // Maximal length of a single ByteArray.
4108   static const int kMaxLength = kMaxSize - kHeaderSize;
4109
4110  private:
4111   DISALLOW_IMPLICIT_CONSTRUCTORS(ByteArray);
4112 };
4113
4114
4115 // BytecodeArray represents a sequence of interpreter bytecodes.
4116 class BytecodeArray : public FixedArrayBase {
4117  public:
4118   static int SizeFor(int length) {
4119     return OBJECT_POINTER_ALIGN(kHeaderSize + length);
4120   }
4121
4122   // Setter and getter
4123   inline byte get(int index);
4124   inline void set(int index, byte value);
4125
4126   // Returns data start address.
4127   inline Address GetFirstBytecodeAddress();
4128
4129   // Accessors for frame size and the number of locals
4130   inline int frame_size() const;
4131   inline void set_frame_size(int value);
4132
4133   DECLARE_CAST(BytecodeArray)
4134
4135   // Dispatched behavior.
4136   inline int BytecodeArraySize();
4137
4138   DECLARE_PRINTER(BytecodeArray)
4139   DECLARE_VERIFIER(BytecodeArray)
4140
4141   void Disassemble(std::ostream& os);
4142
4143   // Layout description.
4144   static const int kFrameSizeOffset = FixedArrayBase::kHeaderSize;
4145   static const int kHeaderSize = kFrameSizeOffset + kIntSize;
4146
4147   static const int kAlignedSize = OBJECT_POINTER_ALIGN(kHeaderSize);
4148
4149   // Maximal memory consumption for a single BytecodeArray.
4150   static const int kMaxSize = 512 * MB;
4151   // Maximal length of a single BytecodeArray.
4152   static const int kMaxLength = kMaxSize - kHeaderSize;
4153
4154  private:
4155   DISALLOW_IMPLICIT_CONSTRUCTORS(BytecodeArray);
4156 };
4157
4158
4159 // FreeSpace are fixed-size free memory blocks used by the heap and GC.
4160 // They look like heap objects (are heap object tagged and have a map) so that
4161 // the heap remains iterable.  They have a size and a next pointer.
4162 // The next pointer is the raw address of the next FreeSpace object (or NULL)
4163 // in the free list.
4164 class FreeSpace: public HeapObject {
4165  public:
4166   // [size]: size of the free space including the header.
4167   inline int size() const;
4168   inline void set_size(int value);
4169
4170   inline int nobarrier_size() const;
4171   inline void nobarrier_set_size(int value);
4172
4173   inline int Size();
4174
4175   // Accessors for the next field.
4176   inline FreeSpace* next();
4177   inline FreeSpace** next_address();
4178   inline void set_next(FreeSpace* next);
4179
4180   inline static FreeSpace* cast(HeapObject* obj);
4181
4182   // Dispatched behavior.
4183   DECLARE_PRINTER(FreeSpace)
4184   DECLARE_VERIFIER(FreeSpace)
4185
4186   // Layout description.
4187   // Size is smi tagged when it is stored.
4188   static const int kSizeOffset = HeapObject::kHeaderSize;
4189   static const int kNextOffset = POINTER_SIZE_ALIGN(kSizeOffset + kPointerSize);
4190
4191  private:
4192   DISALLOW_IMPLICIT_CONSTRUCTORS(FreeSpace);
4193 };
4194
4195
4196 // V has parameters (Type, type, TYPE, C type, element_size)
4197 #define TYPED_ARRAYS(V) \
4198   V(Uint8, uint8, UINT8, uint8_t, 1)                                           \
4199   V(Int8, int8, INT8, int8_t, 1)                                               \
4200   V(Uint16, uint16, UINT16, uint16_t, 2)                                       \
4201   V(Int16, int16, INT16, int16_t, 2)                                           \
4202   V(Uint32, uint32, UINT32, uint32_t, 4)                                       \
4203   V(Int32, int32, INT32, int32_t, 4)                                           \
4204   V(Float32, float32, FLOAT32, float, 4)                                       \
4205   V(Float64, float64, FLOAT64, double, 8)                                      \
4206   V(Uint8Clamped, uint8_clamped, UINT8_CLAMPED, uint8_t, 1)
4207
4208
4209 class FixedTypedArrayBase: public FixedArrayBase {
4210  public:
4211   // [base_pointer]: Either points to the FixedTypedArrayBase itself or nullptr.
4212   DECL_ACCESSORS(base_pointer, Object)
4213
4214   // [external_pointer]: Contains the offset between base_pointer and the start
4215   // of the data. If the base_pointer is a nullptr, the external_pointer
4216   // therefore points to the actual backing store.
4217   DECL_ACCESSORS(external_pointer, void)
4218
4219   // Dispatched behavior.
4220   inline void FixedTypedArrayBaseIterateBody(ObjectVisitor* v);
4221
4222   template <typename StaticVisitor>
4223   inline void FixedTypedArrayBaseIterateBody();
4224
4225   DECLARE_CAST(FixedTypedArrayBase)
4226
4227   static const int kBasePointerOffset = FixedArrayBase::kHeaderSize;
4228   static const int kExternalPointerOffset = kBasePointerOffset + kPointerSize;
4229   static const int kHeaderSize =
4230       DOUBLE_POINTER_ALIGN(kExternalPointerOffset + kPointerSize);
4231
4232   static const int kDataOffset = kHeaderSize;
4233
4234   inline int size();
4235
4236   static inline int TypedArraySize(InstanceType type, int length);
4237   inline int TypedArraySize(InstanceType type);
4238
4239   // Use with care: returns raw pointer into heap.
4240   inline void* DataPtr();
4241
4242   inline int DataSize();
4243
4244  private:
4245   static inline int ElementSize(InstanceType type);
4246
4247   inline int DataSize(InstanceType type);
4248
4249   DISALLOW_IMPLICIT_CONSTRUCTORS(FixedTypedArrayBase);
4250 };
4251
4252
4253 template <class Traits>
4254 class FixedTypedArray: public FixedTypedArrayBase {
4255  public:
4256   typedef typename Traits::ElementType ElementType;
4257   static const InstanceType kInstanceType = Traits::kInstanceType;
4258
4259   DECLARE_CAST(FixedTypedArray<Traits>)
4260
4261   inline ElementType get_scalar(int index);
4262   static inline Handle<Object> get(Handle<FixedTypedArray> array, int index);
4263   inline void set(int index, ElementType value);
4264
4265   static inline ElementType from_int(int value);
4266   static inline ElementType from_double(double value);
4267
4268   // This accessor applies the correct conversion from Smi, HeapNumber
4269   // and undefined.
4270   void SetValue(uint32_t index, Object* value);
4271
4272   DECLARE_PRINTER(FixedTypedArray)
4273   DECLARE_VERIFIER(FixedTypedArray)
4274
4275  private:
4276   DISALLOW_IMPLICIT_CONSTRUCTORS(FixedTypedArray);
4277 };
4278
4279 #define FIXED_TYPED_ARRAY_TRAITS(Type, type, TYPE, elementType, size)         \
4280   class Type##ArrayTraits {                                                   \
4281    public:   /* NOLINT */                                                     \
4282     typedef elementType ElementType;                                          \
4283     static const InstanceType kInstanceType = FIXED_##TYPE##_ARRAY_TYPE;      \
4284     static const char* Designator() { return #type " array"; }                \
4285     static inline Handle<Object> ToHandle(Isolate* isolate,                   \
4286                                           elementType scalar);                \
4287     static inline elementType defaultValue();                                 \
4288   };                                                                          \
4289                                                                               \
4290   typedef FixedTypedArray<Type##ArrayTraits> Fixed##Type##Array;
4291
4292 TYPED_ARRAYS(FIXED_TYPED_ARRAY_TRAITS)
4293
4294 #undef FIXED_TYPED_ARRAY_TRAITS
4295
4296
4297 // DeoptimizationInputData is a fixed array used to hold the deoptimization
4298 // data for code generated by the Hydrogen/Lithium compiler.  It also
4299 // contains information about functions that were inlined.  If N different
4300 // functions were inlined then first N elements of the literal array will
4301 // contain these functions.
4302 //
4303 // It can be empty.
4304 class DeoptimizationInputData: public FixedArray {
4305  public:
4306   // Layout description.  Indices in the array.
4307   static const int kTranslationByteArrayIndex = 0;
4308   static const int kInlinedFunctionCountIndex = 1;
4309   static const int kLiteralArrayIndex = 2;
4310   static const int kOsrAstIdIndex = 3;
4311   static const int kOsrPcOffsetIndex = 4;
4312   static const int kOptimizationIdIndex = 5;
4313   static const int kSharedFunctionInfoIndex = 6;
4314   static const int kWeakCellCacheIndex = 7;
4315   static const int kFirstDeoptEntryIndex = 8;
4316
4317   // Offsets of deopt entry elements relative to the start of the entry.
4318   static const int kAstIdRawOffset = 0;
4319   static const int kTranslationIndexOffset = 1;
4320   static const int kArgumentsStackHeightOffset = 2;
4321   static const int kPcOffset = 3;
4322   static const int kDeoptEntrySize = 4;
4323
4324   // Simple element accessors.
4325 #define DECLARE_ELEMENT_ACCESSORS(name, type) \
4326   inline type* name();                        \
4327   inline void Set##name(type* value);
4328
4329   DECLARE_ELEMENT_ACCESSORS(TranslationByteArray, ByteArray)
4330   DECLARE_ELEMENT_ACCESSORS(InlinedFunctionCount, Smi)
4331   DECLARE_ELEMENT_ACCESSORS(LiteralArray, FixedArray)
4332   DECLARE_ELEMENT_ACCESSORS(OsrAstId, Smi)
4333   DECLARE_ELEMENT_ACCESSORS(OsrPcOffset, Smi)
4334   DECLARE_ELEMENT_ACCESSORS(OptimizationId, Smi)
4335   DECLARE_ELEMENT_ACCESSORS(SharedFunctionInfo, Object)
4336   DECLARE_ELEMENT_ACCESSORS(WeakCellCache, Object)
4337
4338 #undef DECLARE_ELEMENT_ACCESSORS
4339
4340   // Accessors for elements of the ith deoptimization entry.
4341 #define DECLARE_ENTRY_ACCESSORS(name, type) \
4342   inline type* name(int i);                 \
4343   inline void Set##name(int i, type* value);
4344
4345   DECLARE_ENTRY_ACCESSORS(AstIdRaw, Smi)
4346   DECLARE_ENTRY_ACCESSORS(TranslationIndex, Smi)
4347   DECLARE_ENTRY_ACCESSORS(ArgumentsStackHeight, Smi)
4348   DECLARE_ENTRY_ACCESSORS(Pc, Smi)
4349
4350 #undef DECLARE_ENTRY_ACCESSORS
4351
4352   inline BailoutId AstId(int i);
4353
4354   inline void SetAstId(int i, BailoutId value);
4355
4356   inline int DeoptCount();
4357
4358   // Allocates a DeoptimizationInputData.
4359   static Handle<DeoptimizationInputData> New(Isolate* isolate,
4360                                              int deopt_entry_count,
4361                                              PretenureFlag pretenure);
4362
4363   DECLARE_CAST(DeoptimizationInputData)
4364
4365 #ifdef ENABLE_DISASSEMBLER
4366   void DeoptimizationInputDataPrint(std::ostream& os);  // NOLINT
4367 #endif
4368
4369  private:
4370   static int IndexForEntry(int i) {
4371     return kFirstDeoptEntryIndex + (i * kDeoptEntrySize);
4372   }
4373
4374
4375   static int LengthFor(int entry_count) { return IndexForEntry(entry_count); }
4376 };
4377
4378
4379 // DeoptimizationOutputData is a fixed array used to hold the deoptimization
4380 // data for code generated by the full compiler.
4381 // The format of the these objects is
4382 //   [i * 2]: Ast ID for ith deoptimization.
4383 //   [i * 2 + 1]: PC and state of ith deoptimization
4384 class DeoptimizationOutputData: public FixedArray {
4385  public:
4386   inline int DeoptPoints();
4387
4388   inline BailoutId AstId(int index);
4389
4390   inline void SetAstId(int index, BailoutId id);
4391
4392   inline Smi* PcAndState(int index);
4393   inline void SetPcAndState(int index, Smi* offset);
4394
4395   static int LengthOfFixedArray(int deopt_points) {
4396     return deopt_points * 2;
4397   }
4398
4399   // Allocates a DeoptimizationOutputData.
4400   static Handle<DeoptimizationOutputData> New(Isolate* isolate,
4401                                               int number_of_deopt_points,
4402                                               PretenureFlag pretenure);
4403
4404   DECLARE_CAST(DeoptimizationOutputData)
4405
4406 #if defined(OBJECT_PRINT) || defined(ENABLE_DISASSEMBLER)
4407   void DeoptimizationOutputDataPrint(std::ostream& os);  // NOLINT
4408 #endif
4409 };
4410
4411
4412 // HandlerTable is a fixed array containing entries for exception handlers in
4413 // the code object it is associated with. The tables comes in two flavors:
4414 // 1) Based on ranges: Used for unoptimized code. Contains one entry per
4415 //    exception handler and a range representing the try-block covered by that
4416 //    handler. Layout looks as follows:
4417 //      [ range-start , range-end , handler-offset , stack-depth ]
4418 // 2) Based on return addresses: Used for turbofanned code. Contains one entry
4419 //    per call-site that could throw an exception. Layout looks as follows:
4420 //      [ return-address-offset , handler-offset ]
4421 class HandlerTable : public FixedArray {
4422  public:
4423   // Conservative prediction whether a given handler will locally catch an
4424   // exception or cause a re-throw to outside the code boundary. Since this is
4425   // undecidable it is merely an approximation (e.g. useful for debugger).
4426   enum CatchPrediction { UNCAUGHT, CAUGHT };
4427
4428   // Accessors for handler table based on ranges.
4429   inline void SetRangeStart(int index, int value);
4430   inline void SetRangeEnd(int index, int value);
4431   inline void SetRangeHandler(int index, int offset, CatchPrediction pred);
4432   inline void SetRangeDepth(int index, int value);
4433
4434   // Accessors for handler table based on return addresses.
4435   inline void SetReturnOffset(int index, int value);
4436   inline void SetReturnHandler(int index, int offset, CatchPrediction pred);
4437
4438   // Lookup handler in a table based on ranges.
4439   int LookupRange(int pc_offset, int* stack_depth, CatchPrediction* prediction);
4440
4441   // Lookup handler in a table based on return addresses.
4442   int LookupReturn(int pc_offset, CatchPrediction* prediction);
4443
4444   // Returns the required length of the underlying fixed array.
4445   static int LengthForRange(int entries) { return entries * kRangeEntrySize; }
4446   static int LengthForReturn(int entries) { return entries * kReturnEntrySize; }
4447
4448   DECLARE_CAST(HandlerTable)
4449
4450 #if defined(OBJECT_PRINT) || defined(ENABLE_DISASSEMBLER)
4451   void HandlerTableRangePrint(std::ostream& os);   // NOLINT
4452   void HandlerTableReturnPrint(std::ostream& os);  // NOLINT
4453 #endif
4454
4455  private:
4456   // Layout description for handler table based on ranges.
4457   static const int kRangeStartIndex = 0;
4458   static const int kRangeEndIndex = 1;
4459   static const int kRangeHandlerIndex = 2;
4460   static const int kRangeDepthIndex = 3;
4461   static const int kRangeEntrySize = 4;
4462
4463   // Layout description for handler table based on return addresses.
4464   static const int kReturnOffsetIndex = 0;
4465   static const int kReturnHandlerIndex = 1;
4466   static const int kReturnEntrySize = 2;
4467
4468   // Encoding of the {handler} field.
4469   class HandlerPredictionField : public BitField<CatchPrediction, 0, 1> {};
4470   class HandlerOffsetField : public BitField<int, 1, 30> {};
4471 };
4472
4473
4474 // Code describes objects with on-the-fly generated machine code.
4475 class Code: public HeapObject {
4476  public:
4477   // Opaque data type for encapsulating code flags like kind, inline
4478   // cache state, and arguments count.
4479   typedef uint32_t Flags;
4480
4481 #define NON_IC_KIND_LIST(V) \
4482   V(FUNCTION)               \
4483   V(OPTIMIZED_FUNCTION)     \
4484   V(STUB)                   \
4485   V(HANDLER)                \
4486   V(BUILTIN)                \
4487   V(REGEXP)
4488
4489 #define IC_KIND_LIST(V) \
4490   V(LOAD_IC)            \
4491   V(KEYED_LOAD_IC)      \
4492   V(CALL_IC)            \
4493   V(STORE_IC)           \
4494   V(KEYED_STORE_IC)     \
4495   V(BINARY_OP_IC)       \
4496   V(COMPARE_IC)         \
4497   V(COMPARE_NIL_IC)     \
4498   V(TO_BOOLEAN_IC)
4499
4500 #define CODE_KIND_LIST(V) \
4501   NON_IC_KIND_LIST(V)     \
4502   IC_KIND_LIST(V)
4503
4504   enum Kind {
4505 #define DEFINE_CODE_KIND_ENUM(name) name,
4506     CODE_KIND_LIST(DEFINE_CODE_KIND_ENUM)
4507 #undef DEFINE_CODE_KIND_ENUM
4508     NUMBER_OF_KINDS
4509   };
4510
4511   // No more than 16 kinds. The value is currently encoded in four bits in
4512   // Flags.
4513   STATIC_ASSERT(NUMBER_OF_KINDS <= 16);
4514
4515   static const char* Kind2String(Kind kind);
4516
4517   // Types of stubs.
4518   enum StubType {
4519     NORMAL,
4520     FAST
4521   };
4522
4523   static const int kPrologueOffsetNotSet = -1;
4524
4525 #ifdef ENABLE_DISASSEMBLER
4526   // Printing
4527   static const char* ICState2String(InlineCacheState state);
4528   static const char* StubType2String(StubType type);
4529   static void PrintExtraICState(std::ostream& os,  // NOLINT
4530                                 Kind kind, ExtraICState extra);
4531   void Disassemble(const char* name, std::ostream& os);  // NOLINT
4532 #endif  // ENABLE_DISASSEMBLER
4533
4534   // [instruction_size]: Size of the native instructions
4535   inline int instruction_size() const;
4536   inline void set_instruction_size(int value);
4537
4538   // [relocation_info]: Code relocation information
4539   DECL_ACCESSORS(relocation_info, ByteArray)
4540   void InvalidateRelocation();
4541   void InvalidateEmbeddedObjects();
4542
4543   // [handler_table]: Fixed array containing offsets of exception handlers.
4544   DECL_ACCESSORS(handler_table, FixedArray)
4545
4546   // [deoptimization_data]: Array containing data for deopt.
4547   DECL_ACCESSORS(deoptimization_data, FixedArray)
4548
4549   // [raw_type_feedback_info]: This field stores various things, depending on
4550   // the kind of the code object.
4551   //   FUNCTION           => type feedback information.
4552   //   STUB and ICs       => major/minor key as Smi.
4553   DECL_ACCESSORS(raw_type_feedback_info, Object)
4554   inline Object* type_feedback_info();
4555   inline void set_type_feedback_info(
4556       Object* value, WriteBarrierMode mode = UPDATE_WRITE_BARRIER);
4557   inline uint32_t stub_key();
4558   inline void set_stub_key(uint32_t key);
4559
4560   // [next_code_link]: Link for lists of optimized or deoptimized code.
4561   // Note that storage for this field is overlapped with typefeedback_info.
4562   DECL_ACCESSORS(next_code_link, Object)
4563
4564   // [gc_metadata]: Field used to hold GC related metadata. The contents of this
4565   // field does not have to be traced during garbage collection since
4566   // it is only used by the garbage collector itself.
4567   DECL_ACCESSORS(gc_metadata, Object)
4568
4569   // [ic_age]: Inline caching age: the value of the Heap::global_ic_age
4570   // at the moment when this object was created.
4571   inline void set_ic_age(int count);
4572   inline int ic_age() const;
4573
4574   // [prologue_offset]: Offset of the function prologue, used for aging
4575   // FUNCTIONs and OPTIMIZED_FUNCTIONs.
4576   inline int prologue_offset() const;
4577   inline void set_prologue_offset(int offset);
4578
4579   // [constant_pool offset]: Offset of the constant pool.
4580   // Valid for FLAG_enable_embedded_constant_pool only
4581   inline int constant_pool_offset() const;
4582   inline void set_constant_pool_offset(int offset);
4583
4584   // Unchecked accessors to be used during GC.
4585   inline ByteArray* unchecked_relocation_info();
4586
4587   inline int relocation_size();
4588
4589   // [flags]: Various code flags.
4590   inline Flags flags();
4591   inline void set_flags(Flags flags);
4592
4593   // [flags]: Access to specific code flags.
4594   inline Kind kind();
4595   inline InlineCacheState ic_state();  // Only valid for IC stubs.
4596   inline ExtraICState extra_ic_state();  // Only valid for IC stubs.
4597
4598   inline StubType type();  // Only valid for monomorphic IC stubs.
4599
4600   // Testers for IC stub kinds.
4601   inline bool is_inline_cache_stub();
4602   inline bool is_debug_stub();
4603   inline bool is_handler();
4604   inline bool is_load_stub();
4605   inline bool is_keyed_load_stub();
4606   inline bool is_store_stub();
4607   inline bool is_keyed_store_stub();
4608   inline bool is_call_stub();
4609   inline bool is_binary_op_stub();
4610   inline bool is_compare_ic_stub();
4611   inline bool is_compare_nil_ic_stub();
4612   inline bool is_to_boolean_ic_stub();
4613   inline bool is_keyed_stub();
4614   inline bool is_optimized_code();
4615   inline bool embeds_maps_weakly();
4616
4617   inline bool IsCodeStubOrIC();
4618
4619   inline void set_raw_kind_specific_flags1(int value);
4620   inline void set_raw_kind_specific_flags2(int value);
4621
4622   // [is_crankshafted]: For kind STUB or ICs, tells whether or not a code
4623   // object was generated by either the hydrogen or the TurboFan optimizing
4624   // compiler (but it may not be an optimized function).
4625   inline bool is_crankshafted();
4626   inline bool is_hydrogen_stub();  // Crankshafted, but not a function.
4627   inline void set_is_crankshafted(bool value);
4628
4629   // [is_turbofanned]: For kind STUB or OPTIMIZED_FUNCTION, tells whether the
4630   // code object was generated by the TurboFan optimizing compiler.
4631   inline bool is_turbofanned();
4632   inline void set_is_turbofanned(bool value);
4633
4634   // [can_have_weak_objects]: For kind OPTIMIZED_FUNCTION, tells whether the
4635   // embedded objects in code should be treated weakly.
4636   inline bool can_have_weak_objects();
4637   inline void set_can_have_weak_objects(bool value);
4638
4639   // [has_deoptimization_support]: For FUNCTION kind, tells if it has
4640   // deoptimization support.
4641   inline bool has_deoptimization_support();
4642   inline void set_has_deoptimization_support(bool value);
4643
4644   // [has_debug_break_slots]: For FUNCTION kind, tells if it has
4645   // been compiled with debug break slots.
4646   inline bool has_debug_break_slots();
4647   inline void set_has_debug_break_slots(bool value);
4648
4649   // [has_reloc_info_for_serialization]: For FUNCTION kind, tells if its
4650   // reloc info includes runtime and external references to support
4651   // serialization/deserialization.
4652   inline bool has_reloc_info_for_serialization();
4653   inline void set_has_reloc_info_for_serialization(bool value);
4654
4655   // [allow_osr_at_loop_nesting_level]: For FUNCTION kind, tells for
4656   // how long the function has been marked for OSR and therefore which
4657   // level of loop nesting we are willing to do on-stack replacement
4658   // for.
4659   inline void set_allow_osr_at_loop_nesting_level(int level);
4660   inline int allow_osr_at_loop_nesting_level();
4661
4662   // [profiler_ticks]: For FUNCTION kind, tells for how many profiler ticks
4663   // the code object was seen on the stack with no IC patching going on.
4664   inline int profiler_ticks();
4665   inline void set_profiler_ticks(int ticks);
4666
4667   // [builtin_index]: For BUILTIN kind, tells which builtin index it has.
4668   // For builtins, tells which builtin index it has.
4669   // Note that builtins can have a code kind other than BUILTIN, which means
4670   // that for arbitrary code objects, this index value may be random garbage.
4671   // To verify in that case, compare the code object to the indexed builtin.
4672   inline int builtin_index();
4673   inline void set_builtin_index(int id);
4674
4675   // [stack_slots]: For kind OPTIMIZED_FUNCTION, the number of stack slots
4676   // reserved in the code prologue.
4677   inline unsigned stack_slots();
4678   inline void set_stack_slots(unsigned slots);
4679
4680   // [safepoint_table_start]: For kind OPTIMIZED_FUNCTION, the offset in
4681   // the instruction stream where the safepoint table starts.
4682   inline unsigned safepoint_table_offset();
4683   inline void set_safepoint_table_offset(unsigned offset);
4684
4685   // [back_edge_table_start]: For kind FUNCTION, the offset in the
4686   // instruction stream where the back edge table starts.
4687   inline unsigned back_edge_table_offset();
4688   inline void set_back_edge_table_offset(unsigned offset);
4689
4690   inline bool back_edges_patched_for_osr();
4691
4692   // [to_boolean_foo]: For kind TO_BOOLEAN_IC tells what state the stub is in.
4693   inline uint16_t to_boolean_state();
4694
4695   // [has_function_cache]: For kind STUB tells whether there is a function
4696   // cache is passed to the stub.
4697   inline bool has_function_cache();
4698   inline void set_has_function_cache(bool flag);
4699
4700
4701   // [marked_for_deoptimization]: For kind OPTIMIZED_FUNCTION tells whether
4702   // the code is going to be deoptimized because of dead embedded maps.
4703   inline bool marked_for_deoptimization();
4704   inline void set_marked_for_deoptimization(bool flag);
4705
4706   // [constant_pool]: The constant pool for this function.
4707   inline Address constant_pool();
4708
4709   // Get the safepoint entry for the given pc.
4710   SafepointEntry GetSafepointEntry(Address pc);
4711
4712   // Find an object in a stub with a specified map
4713   Object* FindNthObject(int n, Map* match_map);
4714
4715   // Find the first allocation site in an IC stub.
4716   AllocationSite* FindFirstAllocationSite();
4717
4718   // Find the first map in an IC stub.
4719   Map* FindFirstMap();
4720   void FindAllMaps(MapHandleList* maps);
4721
4722   // Find the first handler in an IC stub.
4723   Code* FindFirstHandler();
4724
4725   // Find |length| handlers and put them into |code_list|. Returns false if not
4726   // enough handlers can be found.
4727   bool FindHandlers(CodeHandleList* code_list, int length = -1);
4728
4729   // Find the handler for |map|.
4730   MaybeHandle<Code> FindHandlerForMap(Map* map);
4731
4732   // Find the first name in an IC stub.
4733   Name* FindFirstName();
4734
4735   class FindAndReplacePattern;
4736   // For each (map-to-find, object-to-replace) pair in the pattern, this
4737   // function replaces the corresponding placeholder in the code with the
4738   // object-to-replace. The function assumes that pairs in the pattern come in
4739   // the same order as the placeholders in the code.
4740   // If the placeholder is a weak cell, then the value of weak cell is matched
4741   // against the map-to-find.
4742   void FindAndReplace(const FindAndReplacePattern& pattern);
4743
4744   // The entire code object including its header is copied verbatim to the
4745   // snapshot so that it can be written in one, fast, memcpy during
4746   // deserialization. The deserializer will overwrite some pointers, rather
4747   // like a runtime linker, but the random allocation addresses used in the
4748   // mksnapshot process would still be present in the unlinked snapshot data,
4749   // which would make snapshot production non-reproducible. This method wipes
4750   // out the to-be-overwritten header data for reproducible snapshots.
4751   inline void WipeOutHeader();
4752
4753   // Flags operations.
4754   static inline Flags ComputeFlags(
4755       Kind kind, InlineCacheState ic_state = UNINITIALIZED,
4756       ExtraICState extra_ic_state = kNoExtraICState, StubType type = NORMAL,
4757       CacheHolderFlag holder = kCacheOnReceiver);
4758
4759   static inline Flags ComputeMonomorphicFlags(
4760       Kind kind, ExtraICState extra_ic_state = kNoExtraICState,
4761       CacheHolderFlag holder = kCacheOnReceiver, StubType type = NORMAL);
4762
4763   static inline Flags ComputeHandlerFlags(
4764       Kind handler_kind, StubType type = NORMAL,
4765       CacheHolderFlag holder = kCacheOnReceiver);
4766
4767   static inline InlineCacheState ExtractICStateFromFlags(Flags flags);
4768   static inline StubType ExtractTypeFromFlags(Flags flags);
4769   static inline CacheHolderFlag ExtractCacheHolderFromFlags(Flags flags);
4770   static inline Kind ExtractKindFromFlags(Flags flags);
4771   static inline ExtraICState ExtractExtraICStateFromFlags(Flags flags);
4772
4773   static inline Flags RemoveTypeFromFlags(Flags flags);
4774   static inline Flags RemoveTypeAndHolderFromFlags(Flags flags);
4775
4776   // Convert a target address into a code object.
4777   static inline Code* GetCodeFromTargetAddress(Address address);
4778
4779   // Convert an entry address into an object.
4780   static inline Object* GetObjectFromEntryAddress(Address location_of_address);
4781
4782   // Returns the address of the first instruction.
4783   inline byte* instruction_start();
4784
4785   // Returns the address right after the last instruction.
4786   inline byte* instruction_end();
4787
4788   // Returns the size of the instructions, padding, and relocation information.
4789   inline int body_size();
4790
4791   // Returns the address of the first relocation info (read backwards!).
4792   inline byte* relocation_start();
4793
4794   // Code entry point.
4795   inline byte* entry();
4796
4797   // Returns true if pc is inside this object's instructions.
4798   inline bool contains(byte* pc);
4799
4800   // Relocate the code by delta bytes. Called to signal that this code
4801   // object has been moved by delta bytes.
4802   void Relocate(intptr_t delta);
4803
4804   // Migrate code described by desc.
4805   void CopyFrom(const CodeDesc& desc);
4806
4807   // Returns the object size for a given body (used for allocation).
4808   static int SizeFor(int body_size) {
4809     DCHECK_SIZE_TAG_ALIGNED(body_size);
4810     return RoundUp(kHeaderSize + body_size, kCodeAlignment);
4811   }
4812
4813   // Calculate the size of the code object to report for log events. This takes
4814   // the layout of the code object into account.
4815   inline int ExecutableSize();
4816
4817   // Locating source position.
4818   int SourcePosition(Address pc);
4819   int SourceStatementPosition(Address pc);
4820
4821   DECLARE_CAST(Code)
4822
4823   // Dispatched behavior.
4824   inline int CodeSize();
4825   inline void CodeIterateBody(ObjectVisitor* v);
4826
4827   template<typename StaticVisitor>
4828   inline void CodeIterateBody(Heap* heap);
4829
4830   DECLARE_PRINTER(Code)
4831   DECLARE_VERIFIER(Code)
4832
4833   void ClearInlineCaches();
4834   void ClearInlineCaches(Kind kind);
4835
4836   BailoutId TranslatePcOffsetToAstId(uint32_t pc_offset);
4837   uint32_t TranslateAstIdToPcOffset(BailoutId ast_id);
4838
4839 #define DECLARE_CODE_AGE_ENUM(X) k##X##CodeAge,
4840   enum Age {
4841     kToBeExecutedOnceCodeAge = -3,
4842     kNotExecutedCodeAge = -2,
4843     kExecutedOnceCodeAge = -1,
4844     kNoAgeCodeAge = 0,
4845     CODE_AGE_LIST(DECLARE_CODE_AGE_ENUM)
4846     kAfterLastCodeAge,
4847     kFirstCodeAge = kToBeExecutedOnceCodeAge,
4848     kLastCodeAge = kAfterLastCodeAge - 1,
4849     kCodeAgeCount = kAfterLastCodeAge - kFirstCodeAge - 1,
4850     kIsOldCodeAge = kSexagenarianCodeAge,
4851     kPreAgedCodeAge = kIsOldCodeAge - 1
4852   };
4853 #undef DECLARE_CODE_AGE_ENUM
4854
4855   // Code aging.  Indicates how many full GCs this code has survived without
4856   // being entered through the prologue.  Used to determine when it is
4857   // relatively safe to flush this code object and replace it with the lazy
4858   // compilation stub.
4859   static void MakeCodeAgeSequenceYoung(byte* sequence, Isolate* isolate);
4860   static void MarkCodeAsExecuted(byte* sequence, Isolate* isolate);
4861   void MakeYoung(Isolate* isolate);
4862   void MarkToBeExecutedOnce(Isolate* isolate);
4863   void MakeOlder(MarkingParity);
4864   static bool IsYoungSequence(Isolate* isolate, byte* sequence);
4865   bool IsOld();
4866   Age GetAge();
4867   static inline Code* GetPreAgedCodeAgeStub(Isolate* isolate) {
4868     return GetCodeAgeStub(isolate, kNotExecutedCodeAge, NO_MARKING_PARITY);
4869   }
4870
4871   void PrintDeoptLocation(FILE* out, Address pc);
4872   bool CanDeoptAt(Address pc);
4873
4874 #ifdef VERIFY_HEAP
4875   void VerifyEmbeddedObjectsDependency();
4876 #endif
4877
4878 #ifdef DEBUG
4879   enum VerifyMode { kNoContextSpecificPointers, kNoContextRetainingPointers };
4880   void VerifyEmbeddedObjects(VerifyMode mode = kNoContextRetainingPointers);
4881   static void VerifyRecompiledCode(Code* old_code, Code* new_code);
4882 #endif  // DEBUG
4883
4884   inline bool CanContainWeakObjects();
4885
4886   inline bool IsWeakObject(Object* object);
4887
4888   static inline bool IsWeakObjectInOptimizedCode(Object* object);
4889
4890   static Handle<WeakCell> WeakCellFor(Handle<Code> code);
4891   WeakCell* CachedWeakCell();
4892
4893   // Max loop nesting marker used to postpose OSR. We don't take loop
4894   // nesting that is deeper than 5 levels into account.
4895   static const int kMaxLoopNestingMarker = 6;
4896
4897   static const int kConstantPoolSize =
4898       FLAG_enable_embedded_constant_pool ? kIntSize : 0;
4899
4900   // Layout description.
4901   static const int kRelocationInfoOffset = HeapObject::kHeaderSize;
4902   static const int kHandlerTableOffset = kRelocationInfoOffset + kPointerSize;
4903   static const int kDeoptimizationDataOffset =
4904       kHandlerTableOffset + kPointerSize;
4905   // For FUNCTION kind, we store the type feedback info here.
4906   static const int kTypeFeedbackInfoOffset =
4907       kDeoptimizationDataOffset + kPointerSize;
4908   static const int kNextCodeLinkOffset = kTypeFeedbackInfoOffset + kPointerSize;
4909   static const int kGCMetadataOffset = kNextCodeLinkOffset + kPointerSize;
4910   static const int kInstructionSizeOffset = kGCMetadataOffset + kPointerSize;
4911   static const int kICAgeOffset = kInstructionSizeOffset + kIntSize;
4912   static const int kFlagsOffset = kICAgeOffset + kIntSize;
4913   static const int kKindSpecificFlags1Offset = kFlagsOffset + kIntSize;
4914   static const int kKindSpecificFlags2Offset =
4915       kKindSpecificFlags1Offset + kIntSize;
4916   // Note: We might be able to squeeze this into the flags above.
4917   static const int kPrologueOffset = kKindSpecificFlags2Offset + kIntSize;
4918   static const int kConstantPoolOffset = kPrologueOffset + kIntSize;
4919   static const int kHeaderPaddingStart =
4920       kConstantPoolOffset + kConstantPoolSize;
4921
4922   // Add padding to align the instruction start following right after
4923   // the Code object header.
4924   static const int kHeaderSize =
4925       (kHeaderPaddingStart + kCodeAlignmentMask) & ~kCodeAlignmentMask;
4926
4927   // Byte offsets within kKindSpecificFlags1Offset.
4928   static const int kFullCodeFlags = kKindSpecificFlags1Offset;
4929   class FullCodeFlagsHasDeoptimizationSupportField:
4930       public BitField<bool, 0, 1> {};  // NOLINT
4931   class FullCodeFlagsHasDebugBreakSlotsField: public BitField<bool, 1, 1> {};
4932   class FullCodeFlagsHasRelocInfoForSerialization
4933       : public BitField<bool, 2, 1> {};
4934   // Bit 3 in this bitfield is unused.
4935   class ProfilerTicksField : public BitField<int, 4, 28> {};
4936
4937   // Flags layout.  BitField<type, shift, size>.
4938   class ICStateField : public BitField<InlineCacheState, 0, 4> {};
4939   class TypeField : public BitField<StubType, 4, 1> {};
4940   class CacheHolderField : public BitField<CacheHolderFlag, 5, 2> {};
4941   class KindField : public BitField<Kind, 7, 4> {};
4942   class ExtraICStateField: public BitField<ExtraICState, 11,
4943       PlatformSmiTagging::kSmiValueSize - 11 + 1> {};  // NOLINT
4944
4945   // KindSpecificFlags1 layout (STUB and OPTIMIZED_FUNCTION)
4946   static const int kStackSlotsFirstBit = 0;
4947   static const int kStackSlotsBitCount = 24;
4948   static const int kHasFunctionCacheBit =
4949       kStackSlotsFirstBit + kStackSlotsBitCount;
4950   static const int kMarkedForDeoptimizationBit = kHasFunctionCacheBit + 1;
4951   static const int kIsTurbofannedBit = kMarkedForDeoptimizationBit + 1;
4952   static const int kCanHaveWeakObjects = kIsTurbofannedBit + 1;
4953
4954   STATIC_ASSERT(kStackSlotsFirstBit + kStackSlotsBitCount <= 32);
4955   STATIC_ASSERT(kCanHaveWeakObjects + 1 <= 32);
4956
4957   class StackSlotsField: public BitField<int,
4958       kStackSlotsFirstBit, kStackSlotsBitCount> {};  // NOLINT
4959   class HasFunctionCacheField : public BitField<bool, kHasFunctionCacheBit, 1> {
4960   };  // NOLINT
4961   class MarkedForDeoptimizationField
4962       : public BitField<bool, kMarkedForDeoptimizationBit, 1> {};   // NOLINT
4963   class IsTurbofannedField : public BitField<bool, kIsTurbofannedBit, 1> {
4964   };  // NOLINT
4965   class CanHaveWeakObjectsField
4966       : public BitField<bool, kCanHaveWeakObjects, 1> {};  // NOLINT
4967
4968   // KindSpecificFlags2 layout (ALL)
4969   static const int kIsCrankshaftedBit = 0;
4970   class IsCrankshaftedField: public BitField<bool,
4971       kIsCrankshaftedBit, 1> {};  // NOLINT
4972
4973   // KindSpecificFlags2 layout (STUB and OPTIMIZED_FUNCTION)
4974   static const int kSafepointTableOffsetFirstBit = kIsCrankshaftedBit + 1;
4975   static const int kSafepointTableOffsetBitCount = 30;
4976
4977   STATIC_ASSERT(kSafepointTableOffsetFirstBit +
4978                 kSafepointTableOffsetBitCount <= 32);
4979   STATIC_ASSERT(1 + kSafepointTableOffsetBitCount <= 32);
4980
4981   class SafepointTableOffsetField: public BitField<int,
4982       kSafepointTableOffsetFirstBit,
4983       kSafepointTableOffsetBitCount> {};  // NOLINT
4984
4985   // KindSpecificFlags2 layout (FUNCTION)
4986   class BackEdgeTableOffsetField: public BitField<int,
4987       kIsCrankshaftedBit + 1, 27> {};  // NOLINT
4988   class AllowOSRAtLoopNestingLevelField: public BitField<int,
4989       kIsCrankshaftedBit + 1 + 27, 4> {};  // NOLINT
4990   STATIC_ASSERT(AllowOSRAtLoopNestingLevelField::kMax >= kMaxLoopNestingMarker);
4991
4992   static const int kArgumentsBits = 16;
4993   static const int kMaxArguments = (1 << kArgumentsBits) - 1;
4994
4995   // This constant should be encodable in an ARM instruction.
4996   static const int kFlagsNotUsedInLookup =
4997       TypeField::kMask | CacheHolderField::kMask;
4998
4999  private:
5000   friend class RelocIterator;
5001   friend class Deoptimizer;  // For FindCodeAgeSequence.
5002
5003   void ClearInlineCaches(Kind* kind);
5004
5005   // Code aging
5006   byte* FindCodeAgeSequence();
5007   static void GetCodeAgeAndParity(Code* code, Age* age,
5008                                   MarkingParity* parity);
5009   static void GetCodeAgeAndParity(Isolate* isolate, byte* sequence, Age* age,
5010                                   MarkingParity* parity);
5011   static Code* GetCodeAgeStub(Isolate* isolate, Age age, MarkingParity parity);
5012
5013   // Code aging -- platform-specific
5014   static void PatchPlatformCodeAge(Isolate* isolate,
5015                                    byte* sequence, Age age,
5016                                    MarkingParity parity);
5017
5018   DISALLOW_IMPLICIT_CONSTRUCTORS(Code);
5019 };
5020
5021
5022 // This class describes the layout of dependent codes array of a map. The
5023 // array is partitioned into several groups of dependent codes. Each group
5024 // contains codes with the same dependency on the map. The array has the
5025 // following layout for n dependency groups:
5026 //
5027 // +----+----+-----+----+---------+----------+-----+---------+-----------+
5028 // | C1 | C2 | ... | Cn | group 1 |  group 2 | ... | group n | undefined |
5029 // +----+----+-----+----+---------+----------+-----+---------+-----------+
5030 //
5031 // The first n elements are Smis, each of them specifies the number of codes
5032 // in the corresponding group. The subsequent elements contain grouped code
5033 // objects in weak cells. The suffix of the array can be filled with the
5034 // undefined value if the number of codes is less than the length of the
5035 // array. The order of the code objects within a group is not preserved.
5036 //
5037 // All code indexes used in the class are counted starting from the first
5038 // code object of the first group. In other words, code index 0 corresponds
5039 // to array index n = kCodesStartIndex.
5040
5041 class DependentCode: public FixedArray {
5042  public:
5043   enum DependencyGroup {
5044     // Group of code that weakly embed this map and depend on being
5045     // deoptimized when the map is garbage collected.
5046     kWeakCodeGroup,
5047     // Group of code that embed a transition to this map, and depend on being
5048     // deoptimized when the transition is replaced by a new version.
5049     kTransitionGroup,
5050     // Group of code that omit run-time prototype checks for prototypes
5051     // described by this map. The group is deoptimized whenever an object
5052     // described by this map changes shape (and transitions to a new map),
5053     // possibly invalidating the assumptions embedded in the code.
5054     kPrototypeCheckGroup,
5055     // Group of code that depends on global property values in property cells
5056     // not being changed.
5057     kPropertyCellChangedGroup,
5058     // Group of code that omit run-time type checks for the field(s) introduced
5059     // by this map.
5060     kFieldTypeGroup,
5061     // Group of code that omit run-time type checks for initial maps of
5062     // constructors.
5063     kInitialMapChangedGroup,
5064     // Group of code that depends on tenuring information in AllocationSites
5065     // not being changed.
5066     kAllocationSiteTenuringChangedGroup,
5067     // Group of code that depends on element transition information in
5068     // AllocationSites not being changed.
5069     kAllocationSiteTransitionChangedGroup
5070   };
5071
5072   static const int kGroupCount = kAllocationSiteTransitionChangedGroup + 1;
5073
5074   // Array for holding the index of the first code object of each group.
5075   // The last element stores the total number of code objects.
5076   class GroupStartIndexes {
5077    public:
5078     explicit GroupStartIndexes(DependentCode* entries);
5079     void Recompute(DependentCode* entries);
5080     int at(int i) { return start_indexes_[i]; }
5081     int number_of_entries() { return start_indexes_[kGroupCount]; }
5082    private:
5083     int start_indexes_[kGroupCount + 1];
5084   };
5085
5086   bool Contains(DependencyGroup group, WeakCell* code_cell);
5087
5088   static Handle<DependentCode> InsertCompilationDependencies(
5089       Handle<DependentCode> entries, DependencyGroup group,
5090       Handle<Foreign> info);
5091
5092   static Handle<DependentCode> InsertWeakCode(Handle<DependentCode> entries,
5093                                               DependencyGroup group,
5094                                               Handle<WeakCell> code_cell);
5095
5096   void UpdateToFinishedCode(DependencyGroup group, Foreign* info,
5097                             WeakCell* code_cell);
5098
5099   void RemoveCompilationDependencies(DependentCode::DependencyGroup group,
5100                                      Foreign* info);
5101
5102   void DeoptimizeDependentCodeGroup(Isolate* isolate,
5103                                     DependentCode::DependencyGroup group);
5104
5105   bool MarkCodeForDeoptimization(Isolate* isolate,
5106                                  DependentCode::DependencyGroup group);
5107
5108   // The following low-level accessors should only be used by this class
5109   // and the mark compact collector.
5110   inline int number_of_entries(DependencyGroup group);
5111   inline void set_number_of_entries(DependencyGroup group, int value);
5112   inline Object* object_at(int i);
5113   inline void set_object_at(int i, Object* object);
5114   inline void clear_at(int i);
5115   inline void copy(int from, int to);
5116   DECLARE_CAST(DependentCode)
5117
5118   static const char* DependencyGroupName(DependencyGroup group);
5119   static void SetMarkedForDeoptimization(Code* code, DependencyGroup group);
5120
5121  private:
5122   static Handle<DependentCode> Insert(Handle<DependentCode> entries,
5123                                       DependencyGroup group,
5124                                       Handle<Object> object);
5125   static Handle<DependentCode> EnsureSpace(Handle<DependentCode> entries);
5126   // Make a room at the end of the given group by moving out the first
5127   // code objects of the subsequent groups.
5128   inline void ExtendGroup(DependencyGroup group);
5129   // Compact by removing cleared weak cells and return true if there was
5130   // any cleared weak cell.
5131   bool Compact();
5132   static int Grow(int number_of_entries) {
5133     if (number_of_entries < 5) return number_of_entries + 1;
5134     return number_of_entries * 5 / 4;
5135   }
5136   static const int kCodesStartIndex = kGroupCount;
5137 };
5138
5139
5140 class PrototypeInfo;
5141
5142
5143 // All heap objects have a Map that describes their structure.
5144 //  A Map contains information about:
5145 //  - Size information about the object
5146 //  - How to iterate over an object (for garbage collection)
5147 class Map: public HeapObject {
5148  public:
5149   // Instance size.
5150   // Size in bytes or kVariableSizeSentinel if instances do not have
5151   // a fixed size.
5152   inline int instance_size();
5153   inline void set_instance_size(int value);
5154
5155   // Only to clear an unused byte, remove once byte is used.
5156   inline void clear_unused();
5157
5158   // [inobject_properties_or_constructor_function_index]: Provides access
5159   // to the inobject properties in case of JSObject maps, or the constructor
5160   // function index in case of primitive maps.
5161   inline int inobject_properties_or_constructor_function_index();
5162   inline void set_inobject_properties_or_constructor_function_index(int value);
5163   // Count of properties allocated in the object (JSObject only).
5164   inline int GetInObjectProperties();
5165   inline void SetInObjectProperties(int value);
5166   // Index of the constructor function in the native context (primitives only),
5167   // or the special sentinel value to indicate that there is no object wrapper
5168   // for the primitive (i.e. in case of null or undefined).
5169   static const int kNoConstructorFunctionIndex = 0;
5170   inline int GetConstructorFunctionIndex();
5171   inline void SetConstructorFunctionIndex(int value);
5172
5173   // Instance type.
5174   inline InstanceType instance_type();
5175   inline void set_instance_type(InstanceType value);
5176
5177   // Tells how many unused property fields are available in the
5178   // instance (only used for JSObject in fast mode).
5179   inline int unused_property_fields();
5180   inline void set_unused_property_fields(int value);
5181
5182   // Bit field.
5183   inline byte bit_field() const;
5184   inline void set_bit_field(byte value);
5185
5186   // Bit field 2.
5187   inline byte bit_field2() const;
5188   inline void set_bit_field2(byte value);
5189
5190   // Bit field 3.
5191   inline uint32_t bit_field3() const;
5192   inline void set_bit_field3(uint32_t bits);
5193
5194   class EnumLengthBits:             public BitField<int,
5195       0, kDescriptorIndexBitCount> {};  // NOLINT
5196   class NumberOfOwnDescriptorsBits: public BitField<int,
5197       kDescriptorIndexBitCount, kDescriptorIndexBitCount> {};  // NOLINT
5198   STATIC_ASSERT(kDescriptorIndexBitCount + kDescriptorIndexBitCount == 20);
5199   class DictionaryMap : public BitField<bool, 20, 1> {};
5200   class OwnsDescriptors : public BitField<bool, 21, 1> {};
5201   class HasInstanceCallHandler : public BitField<bool, 22, 1> {};
5202   class Deprecated : public BitField<bool, 23, 1> {};
5203   class IsUnstable : public BitField<bool, 24, 1> {};
5204   class IsMigrationTarget : public BitField<bool, 25, 1> {};
5205   class IsStrong : public BitField<bool, 26, 1> {};
5206   // Bit 27 is free.
5207
5208   // Keep this bit field at the very end for better code in
5209   // Builtins::kJSConstructStubGeneric stub.
5210   // This counter is used for in-object slack tracking and for map aging.
5211   // The in-object slack tracking is considered enabled when the counter is
5212   // in the range [kSlackTrackingCounterStart, kSlackTrackingCounterEnd].
5213   class Counter : public BitField<int, 28, 4> {};
5214   static const int kSlackTrackingCounterStart = 14;
5215   static const int kSlackTrackingCounterEnd = 8;
5216   static const int kRetainingCounterStart = kSlackTrackingCounterEnd - 1;
5217   static const int kRetainingCounterEnd = 0;
5218
5219   // Tells whether the object in the prototype property will be used
5220   // for instances created from this function.  If the prototype
5221   // property is set to a value that is not a JSObject, the prototype
5222   // property will not be used to create instances of the function.
5223   // See ECMA-262, 13.2.2.
5224   inline void set_non_instance_prototype(bool value);
5225   inline bool has_non_instance_prototype();
5226
5227   // Tells whether function has special prototype property. If not, prototype
5228   // property will not be created when accessed (will return undefined),
5229   // and construction from this function will not be allowed.
5230   inline void set_function_with_prototype(bool value);
5231   inline bool function_with_prototype();
5232
5233   // Tells whether the instance with this map should be ignored by the
5234   // Object.getPrototypeOf() function and the __proto__ accessor.
5235   inline void set_is_hidden_prototype();
5236   inline bool is_hidden_prototype();
5237
5238   // Records and queries whether the instance has a named interceptor.
5239   inline void set_has_named_interceptor();
5240   inline bool has_named_interceptor();
5241
5242   // Records and queries whether the instance has an indexed interceptor.
5243   inline void set_has_indexed_interceptor();
5244   inline bool has_indexed_interceptor();
5245
5246   // Tells whether the instance is undetectable.
5247   // An undetectable object is a special class of JSObject: 'typeof' operator
5248   // returns undefined, ToBoolean returns false. Otherwise it behaves like
5249   // a normal JS object.  It is useful for implementing undetectable
5250   // document.all in Firefox & Safari.
5251   // See https://bugzilla.mozilla.org/show_bug.cgi?id=248549.
5252   inline void set_is_undetectable();
5253   inline bool is_undetectable();
5254
5255   // Tells whether the instance has a call-as-function handler.
5256   inline void set_is_observed();
5257   inline bool is_observed();
5258
5259   inline void set_is_strong();
5260   inline bool is_strong();
5261   inline void set_is_extensible(bool value);
5262   inline bool is_extensible();
5263   inline void set_is_prototype_map(bool value);
5264   inline bool is_prototype_map() const;
5265
5266   inline void set_elements_kind(ElementsKind elements_kind);
5267   inline ElementsKind elements_kind();
5268
5269   // Tells whether the instance has fast elements that are only Smis.
5270   inline bool has_fast_smi_elements();
5271
5272   // Tells whether the instance has fast elements.
5273   inline bool has_fast_object_elements();
5274   inline bool has_fast_smi_or_object_elements();
5275   inline bool has_fast_double_elements();
5276   inline bool has_fast_elements();
5277   inline bool has_sloppy_arguments_elements();
5278   inline bool has_fixed_typed_array_elements();
5279   inline bool has_dictionary_elements();
5280
5281   static bool IsValidElementsTransition(ElementsKind from_kind,
5282                                         ElementsKind to_kind);
5283
5284   // Returns true if the current map doesn't have DICTIONARY_ELEMENTS but if a
5285   // map with DICTIONARY_ELEMENTS was found in the prototype chain.
5286   bool DictionaryElementsInPrototypeChainOnly();
5287
5288   inline Map* ElementsTransitionMap();
5289
5290   inline FixedArrayBase* GetInitialElements();
5291
5292   // [raw_transitions]: Provides access to the transitions storage field.
5293   // Don't call set_raw_transitions() directly to overwrite transitions, use
5294   // the TransitionArray::ReplaceTransitions() wrapper instead!
5295   DECL_ACCESSORS(raw_transitions, Object)
5296   // [prototype_info]: Per-prototype metadata. Aliased with transitions
5297   // (which prototype maps don't have).
5298   DECL_ACCESSORS(prototype_info, Object)
5299   // PrototypeInfo is created lazily using this helper (which installs it on
5300   // the given prototype's map).
5301   static Handle<PrototypeInfo> GetOrCreatePrototypeInfo(
5302       Handle<JSObject> prototype, Isolate* isolate);
5303   static Handle<PrototypeInfo> GetOrCreatePrototypeInfo(
5304       Handle<Map> prototype_map, Isolate* isolate);
5305
5306   // [prototype chain validity cell]: Associated with a prototype object,
5307   // stored in that object's map's PrototypeInfo, indicates that prototype
5308   // chains through this object are currently valid. The cell will be
5309   // invalidated and replaced when the prototype chain changes.
5310   static Handle<Cell> GetOrCreatePrototypeChainValidityCell(Handle<Map> map,
5311                                                             Isolate* isolate);
5312   static const int kPrototypeChainValid = 0;
5313   static const int kPrototypeChainInvalid = 1;
5314
5315   Map* FindRootMap();
5316   Map* FindFieldOwner(int descriptor);
5317
5318   inline int GetInObjectPropertyOffset(int index);
5319
5320   int NumberOfFields();
5321
5322   // TODO(ishell): candidate with JSObject::MigrateToMap().
5323   bool InstancesNeedRewriting(Map* target, int target_number_of_fields,
5324                               int target_inobject, int target_unused,
5325                               int* old_number_of_fields);
5326   // TODO(ishell): moveit!
5327   static Handle<Map> GeneralizeAllFieldRepresentations(Handle<Map> map);
5328   MUST_USE_RESULT static Handle<HeapType> GeneralizeFieldType(
5329       Handle<HeapType> type1,
5330       Handle<HeapType> type2,
5331       Isolate* isolate);
5332   static void GeneralizeFieldType(Handle<Map> map, int modify_index,
5333                                   Representation new_representation,
5334                                   Handle<HeapType> new_field_type);
5335   static Handle<Map> ReconfigureProperty(Handle<Map> map, int modify_index,
5336                                          PropertyKind new_kind,
5337                                          PropertyAttributes new_attributes,
5338                                          Representation new_representation,
5339                                          Handle<HeapType> new_field_type,
5340                                          StoreMode store_mode);
5341   static Handle<Map> CopyGeneralizeAllRepresentations(
5342       Handle<Map> map, int modify_index, StoreMode store_mode,
5343       PropertyKind kind, PropertyAttributes attributes, const char* reason);
5344
5345   static Handle<Map> PrepareForDataProperty(Handle<Map> old_map,
5346                                             int descriptor_number,
5347                                             Handle<Object> value);
5348
5349   static Handle<Map> Normalize(Handle<Map> map, PropertyNormalizationMode mode,
5350                                const char* reason);
5351
5352   // Returns the constructor name (the name (possibly, inferred name) of the
5353   // function that was used to instantiate the object).
5354   String* constructor_name();
5355
5356   // Tells whether the map is used for JSObjects in dictionary mode (ie
5357   // normalized objects, ie objects for which HasFastProperties returns false).
5358   // A map can never be used for both dictionary mode and fast mode JSObjects.
5359   // False by default and for HeapObjects that are not JSObjects.
5360   inline void set_dictionary_map(bool value);
5361   inline bool is_dictionary_map();
5362
5363   // Tells whether the instance needs security checks when accessing its
5364   // properties.
5365   inline void set_is_access_check_needed(bool access_check_needed);
5366   inline bool is_access_check_needed();
5367
5368   // Returns true if map has a non-empty stub code cache.
5369   inline bool has_code_cache();
5370
5371   // [prototype]: implicit prototype object.
5372   DECL_ACCESSORS(prototype, Object)
5373   // TODO(jkummerow): make set_prototype private.
5374   static void SetPrototype(
5375       Handle<Map> map, Handle<Object> prototype,
5376       PrototypeOptimizationMode proto_mode = FAST_PROTOTYPE);
5377
5378   // [constructor]: points back to the function responsible for this map.
5379   // The field overlaps with the back pointer. All maps in a transition tree
5380   // have the same constructor, so maps with back pointers can walk the
5381   // back pointer chain until they find the map holding their constructor.
5382   DECL_ACCESSORS(constructor_or_backpointer, Object)
5383   inline Object* GetConstructor() const;
5384   inline void SetConstructor(Object* constructor,
5385                              WriteBarrierMode mode = UPDATE_WRITE_BARRIER);
5386   // [back pointer]: points back to the parent map from which a transition
5387   // leads to this map. The field overlaps with the constructor (see above).
5388   inline Object* GetBackPointer();
5389   inline void SetBackPointer(Object* value,
5390                              WriteBarrierMode mode = UPDATE_WRITE_BARRIER);
5391
5392   // [instance descriptors]: describes the object.
5393   DECL_ACCESSORS(instance_descriptors, DescriptorArray)
5394
5395   // [layout descriptor]: describes the object layout.
5396   DECL_ACCESSORS(layout_descriptor, LayoutDescriptor)
5397   // |layout descriptor| accessor which can be used from GC.
5398   inline LayoutDescriptor* layout_descriptor_gc_safe();
5399   inline bool HasFastPointerLayout() const;
5400
5401   // |layout descriptor| accessor that is safe to call even when
5402   // FLAG_unbox_double_fields is disabled (in this case Map does not contain
5403   // |layout_descriptor| field at all).
5404   inline LayoutDescriptor* GetLayoutDescriptor();
5405
5406   inline void UpdateDescriptors(DescriptorArray* descriptors,
5407                                 LayoutDescriptor* layout_descriptor);
5408   inline void InitializeDescriptors(DescriptorArray* descriptors,
5409                                     LayoutDescriptor* layout_descriptor);
5410
5411   // [stub cache]: contains stubs compiled for this map.
5412   DECL_ACCESSORS(code_cache, Object)
5413
5414   // [dependent code]: list of optimized codes that weakly embed this map.
5415   DECL_ACCESSORS(dependent_code, DependentCode)
5416
5417   // [weak cell cache]: cache that stores a weak cell pointing to this map.
5418   DECL_ACCESSORS(weak_cell_cache, Object)
5419
5420   inline PropertyDetails GetLastDescriptorDetails();
5421
5422   inline int LastAdded();
5423
5424   inline int NumberOfOwnDescriptors();
5425   inline void SetNumberOfOwnDescriptors(int number);
5426
5427   inline Cell* RetrieveDescriptorsPointer();
5428
5429   inline int EnumLength();
5430   inline void SetEnumLength(int length);
5431
5432   inline bool owns_descriptors();
5433   inline void set_owns_descriptors(bool owns_descriptors);
5434   inline bool has_instance_call_handler();
5435   inline void set_has_instance_call_handler();
5436   inline void mark_unstable();
5437   inline bool is_stable();
5438   inline void set_migration_target(bool value);
5439   inline bool is_migration_target();
5440   inline void set_counter(int value);
5441   inline int counter();
5442   inline void deprecate();
5443   inline bool is_deprecated();
5444   inline bool CanBeDeprecated();
5445   // Returns a non-deprecated version of the input. If the input was not
5446   // deprecated, it is directly returned. Otherwise, the non-deprecated version
5447   // is found by re-transitioning from the root of the transition tree using the
5448   // descriptor array of the map. Returns MaybeHandle<Map>() if no updated map
5449   // is found.
5450   static MaybeHandle<Map> TryUpdate(Handle<Map> map) WARN_UNUSED_RESULT;
5451
5452   // Returns a non-deprecated version of the input. This method may deprecate
5453   // existing maps along the way if encodings conflict. Not for use while
5454   // gathering type feedback. Use TryUpdate in those cases instead.
5455   static Handle<Map> Update(Handle<Map> map);
5456
5457   static Handle<Map> CopyDropDescriptors(Handle<Map> map);
5458   static Handle<Map> CopyInsertDescriptor(Handle<Map> map,
5459                                           Descriptor* descriptor,
5460                                           TransitionFlag flag);
5461
5462   MUST_USE_RESULT static MaybeHandle<Map> CopyWithField(
5463       Handle<Map> map,
5464       Handle<Name> name,
5465       Handle<HeapType> type,
5466       PropertyAttributes attributes,
5467       Representation representation,
5468       TransitionFlag flag);
5469
5470   MUST_USE_RESULT static MaybeHandle<Map> CopyWithConstant(
5471       Handle<Map> map,
5472       Handle<Name> name,
5473       Handle<Object> constant,
5474       PropertyAttributes attributes,
5475       TransitionFlag flag);
5476
5477   // Returns a new map with all transitions dropped from the given map and
5478   // the ElementsKind set.
5479   static Handle<Map> TransitionElementsTo(Handle<Map> map,
5480                                           ElementsKind to_kind);
5481
5482   static Handle<Map> AsElementsKind(Handle<Map> map, ElementsKind kind);
5483
5484   static Handle<Map> CopyAsElementsKind(Handle<Map> map,
5485                                         ElementsKind kind,
5486                                         TransitionFlag flag);
5487
5488   static Handle<Map> CopyForObserved(Handle<Map> map);
5489
5490   static Handle<Map> CopyForPreventExtensions(Handle<Map> map,
5491                                               PropertyAttributes attrs_to_add,
5492                                               Handle<Symbol> transition_marker,
5493                                               const char* reason);
5494
5495   static Handle<Map> FixProxy(Handle<Map> map, InstanceType type, int size);
5496
5497
5498   // Maximal number of fast properties. Used to restrict the number of map
5499   // transitions to avoid an explosion in the number of maps for objects used as
5500   // dictionaries.
5501   inline bool TooManyFastProperties(StoreFromKeyed store_mode);
5502   static Handle<Map> TransitionToDataProperty(Handle<Map> map,
5503                                               Handle<Name> name,
5504                                               Handle<Object> value,
5505                                               PropertyAttributes attributes,
5506                                               StoreFromKeyed store_mode);
5507   static Handle<Map> TransitionToAccessorProperty(
5508       Handle<Map> map, Handle<Name> name, AccessorComponent component,
5509       Handle<Object> accessor, PropertyAttributes attributes);
5510   static Handle<Map> ReconfigureExistingProperty(Handle<Map> map,
5511                                                  int descriptor,
5512                                                  PropertyKind kind,
5513                                                  PropertyAttributes attributes);
5514
5515   inline void AppendDescriptor(Descriptor* desc);
5516
5517   // Returns a copy of the map, prepared for inserting into the transition
5518   // tree (if the |map| owns descriptors then the new one will share
5519   // descriptors with |map|).
5520   static Handle<Map> CopyForTransition(Handle<Map> map, const char* reason);
5521
5522   // Returns a copy of the map, with all transitions dropped from the
5523   // instance descriptors.
5524   static Handle<Map> Copy(Handle<Map> map, const char* reason);
5525   static Handle<Map> Create(Isolate* isolate, int inobject_properties);
5526
5527   // Returns the next free property index (only valid for FAST MODE).
5528   int NextFreePropertyIndex();
5529
5530   // Returns the number of properties described in instance_descriptors
5531   // filtering out properties with the specified attributes.
5532   int NumberOfDescribedProperties(DescriptorFlag which = OWN_DESCRIPTORS,
5533                                   PropertyAttributes filter = NONE);
5534
5535   DECLARE_CAST(Map)
5536
5537   // Code cache operations.
5538
5539   // Clears the code cache.
5540   inline void ClearCodeCache(Heap* heap);
5541
5542   // Update code cache.
5543   static void UpdateCodeCache(Handle<Map> map,
5544                               Handle<Name> name,
5545                               Handle<Code> code);
5546
5547   // Extend the descriptor array of the map with the list of descriptors.
5548   // In case of duplicates, the latest descriptor is used.
5549   static void AppendCallbackDescriptors(Handle<Map> map,
5550                                         Handle<Object> descriptors);
5551
5552   static inline int SlackForArraySize(int old_size, int size_limit);
5553
5554   static void EnsureDescriptorSlack(Handle<Map> map, int slack);
5555
5556   // Returns the found code or undefined if absent.
5557   Object* FindInCodeCache(Name* name, Code::Flags flags);
5558
5559   // Returns the non-negative index of the code object if it is in the
5560   // cache and -1 otherwise.
5561   int IndexInCodeCache(Object* name, Code* code);
5562
5563   // Removes a code object from the code cache at the given index.
5564   void RemoveFromCodeCache(Name* name, Code* code, int index);
5565
5566   // Computes a hash value for this map, to be used in HashTables and such.
5567   int Hash();
5568
5569   // Returns the map that this map transitions to if its elements_kind
5570   // is changed to |elements_kind|, or NULL if no such map is cached yet.
5571   // |safe_to_add_transitions| is set to false if adding transitions is not
5572   // allowed.
5573   Map* LookupElementsTransitionMap(ElementsKind elements_kind);
5574
5575   // Returns the transitioned map for this map with the most generic
5576   // elements_kind that's found in |candidates|, or null handle if no match is
5577   // found at all.
5578   static Handle<Map> FindTransitionedMap(Handle<Map> map,
5579                                          MapHandleList* candidates);
5580
5581   inline bool CanTransition();
5582
5583   inline bool IsPrimitiveMap();
5584   inline bool IsJSObjectMap();
5585   inline bool IsJSArrayMap();
5586   inline bool IsStringMap();
5587   inline bool IsJSProxyMap();
5588   inline bool IsJSGlobalProxyMap();
5589   inline bool IsJSGlobalObjectMap();
5590   inline bool IsGlobalObjectMap();
5591
5592   inline bool CanOmitMapChecks();
5593
5594   static void AddDependentCode(Handle<Map> map,
5595                                DependentCode::DependencyGroup group,
5596                                Handle<Code> code);
5597
5598   bool IsMapInArrayPrototypeChain();
5599
5600   static Handle<WeakCell> WeakCellForMap(Handle<Map> map);
5601
5602   // Dispatched behavior.
5603   DECLARE_PRINTER(Map)
5604   DECLARE_VERIFIER(Map)
5605
5606 #ifdef VERIFY_HEAP
5607   void DictionaryMapVerify();
5608   void VerifyOmittedMapChecks();
5609 #endif
5610
5611   inline int visitor_id();
5612   inline void set_visitor_id(int visitor_id);
5613
5614   static Handle<Map> TransitionToPrototype(Handle<Map> map,
5615                                            Handle<Object> prototype,
5616                                            PrototypeOptimizationMode mode);
5617
5618   static const int kMaxPreAllocatedPropertyFields = 255;
5619
5620   // Layout description.
5621   static const int kInstanceSizesOffset = HeapObject::kHeaderSize;
5622   static const int kInstanceAttributesOffset = kInstanceSizesOffset + kIntSize;
5623   static const int kBitField3Offset = kInstanceAttributesOffset + kIntSize;
5624   static const int kPrototypeOffset = kBitField3Offset + kPointerSize;
5625   static const int kConstructorOrBackPointerOffset =
5626       kPrototypeOffset + kPointerSize;
5627   // When there is only one transition, it is stored directly in this field;
5628   // otherwise a transition array is used.
5629   // For prototype maps, this slot is used to store this map's PrototypeInfo
5630   // struct.
5631   static const int kTransitionsOrPrototypeInfoOffset =
5632       kConstructorOrBackPointerOffset + kPointerSize;
5633   static const int kDescriptorsOffset =
5634       kTransitionsOrPrototypeInfoOffset + kPointerSize;
5635 #if V8_DOUBLE_FIELDS_UNBOXING
5636   static const int kLayoutDecriptorOffset = kDescriptorsOffset + kPointerSize;
5637   static const int kCodeCacheOffset = kLayoutDecriptorOffset + kPointerSize;
5638 #else
5639   static const int kLayoutDecriptorOffset = 1;  // Must not be ever accessed.
5640   static const int kCodeCacheOffset = kDescriptorsOffset + kPointerSize;
5641 #endif
5642   static const int kDependentCodeOffset = kCodeCacheOffset + kPointerSize;
5643   static const int kWeakCellCacheOffset = kDependentCodeOffset + kPointerSize;
5644   static const int kSize = kWeakCellCacheOffset + kPointerSize;
5645
5646   // Layout of pointer fields. Heap iteration code relies on them
5647   // being continuously allocated.
5648   static const int kPointerFieldsBeginOffset = Map::kPrototypeOffset;
5649   static const int kPointerFieldsEndOffset = kSize;
5650
5651   // Byte offsets within kInstanceSizesOffset.
5652   static const int kInstanceSizeOffset = kInstanceSizesOffset + 0;
5653   static const int kInObjectPropertiesOrConstructorFunctionIndexByte = 1;
5654   static const int kInObjectPropertiesOrConstructorFunctionIndexOffset =
5655       kInstanceSizesOffset + kInObjectPropertiesOrConstructorFunctionIndexByte;
5656   // Note there is one byte available for use here.
5657   static const int kUnusedByte = 2;
5658   static const int kUnusedOffset = kInstanceSizesOffset + kUnusedByte;
5659   static const int kVisitorIdByte = 3;
5660   static const int kVisitorIdOffset = kInstanceSizesOffset + kVisitorIdByte;
5661
5662   // Byte offsets within kInstanceAttributesOffset attributes.
5663 #if V8_TARGET_LITTLE_ENDIAN
5664   // Order instance type and bit field together such that they can be loaded
5665   // together as a 16-bit word with instance type in the lower 8 bits regardless
5666   // of endianess. Also provide endian-independent offset to that 16-bit word.
5667   static const int kInstanceTypeOffset = kInstanceAttributesOffset + 0;
5668   static const int kBitFieldOffset = kInstanceAttributesOffset + 1;
5669 #else
5670   static const int kBitFieldOffset = kInstanceAttributesOffset + 0;
5671   static const int kInstanceTypeOffset = kInstanceAttributesOffset + 1;
5672 #endif
5673   static const int kInstanceTypeAndBitFieldOffset =
5674       kInstanceAttributesOffset + 0;
5675   static const int kBitField2Offset = kInstanceAttributesOffset + 2;
5676   static const int kUnusedPropertyFieldsByte = 3;
5677   static const int kUnusedPropertyFieldsOffset = kInstanceAttributesOffset + 3;
5678
5679   STATIC_ASSERT(kInstanceTypeAndBitFieldOffset ==
5680                 Internals::kMapInstanceTypeAndBitFieldOffset);
5681
5682   // Bit positions for bit field.
5683   static const int kHasNonInstancePrototype = 0;
5684   static const int kIsHiddenPrototype = 1;
5685   static const int kHasNamedInterceptor = 2;
5686   static const int kHasIndexedInterceptor = 3;
5687   static const int kIsUndetectable = 4;
5688   static const int kIsObserved = 5;
5689   static const int kIsAccessCheckNeeded = 6;
5690   class FunctionWithPrototype: public BitField<bool, 7,  1> {};
5691
5692   // Bit positions for bit field 2
5693   static const int kIsExtensible = 0;
5694   static const int kStringWrapperSafeForDefaultValueOf = 1;
5695   class IsPrototypeMapBits : public BitField<bool, 2, 1> {};
5696   class ElementsKindBits: public BitField<ElementsKind, 3, 5> {};
5697
5698   // Derived values from bit field 2
5699   static const int8_t kMaximumBitField2FastElementValue = static_cast<int8_t>(
5700       (FAST_ELEMENTS + 1) << Map::ElementsKindBits::kShift) - 1;
5701   static const int8_t kMaximumBitField2FastSmiElementValue =
5702       static_cast<int8_t>((FAST_SMI_ELEMENTS + 1) <<
5703                           Map::ElementsKindBits::kShift) - 1;
5704   static const int8_t kMaximumBitField2FastHoleyElementValue =
5705       static_cast<int8_t>((FAST_HOLEY_ELEMENTS + 1) <<
5706                           Map::ElementsKindBits::kShift) - 1;
5707   static const int8_t kMaximumBitField2FastHoleySmiElementValue =
5708       static_cast<int8_t>((FAST_HOLEY_SMI_ELEMENTS + 1) <<
5709                           Map::ElementsKindBits::kShift) - 1;
5710
5711   typedef FixedBodyDescriptor<kPointerFieldsBeginOffset,
5712                               kPointerFieldsEndOffset,
5713                               kSize> BodyDescriptor;
5714
5715   // Compares this map to another to see if they describe equivalent objects.
5716   // If |mode| is set to CLEAR_INOBJECT_PROPERTIES, |other| is treated as if
5717   // it had exactly zero inobject properties.
5718   // The "shared" flags of both this map and |other| are ignored.
5719   bool EquivalentToForNormalization(Map* other, PropertyNormalizationMode mode);
5720
5721   // Returns true if given field is unboxed double.
5722   inline bool IsUnboxedDoubleField(FieldIndex index);
5723
5724 #if TRACE_MAPS
5725   static void TraceTransition(const char* what, Map* from, Map* to, Name* name);
5726   static void TraceAllTransitions(Map* map);
5727 #endif
5728
5729   static inline Handle<Map> CopyInstallDescriptorsForTesting(
5730       Handle<Map> map, int new_descriptor, Handle<DescriptorArray> descriptors,
5731       Handle<LayoutDescriptor> layout_descriptor);
5732
5733  private:
5734   static void ConnectTransition(Handle<Map> parent, Handle<Map> child,
5735                                 Handle<Name> name, SimpleTransitionFlag flag);
5736
5737   bool EquivalentToForTransition(Map* other);
5738   static Handle<Map> RawCopy(Handle<Map> map, int instance_size);
5739   static Handle<Map> ShareDescriptor(Handle<Map> map,
5740                                      Handle<DescriptorArray> descriptors,
5741                                      Descriptor* descriptor);
5742   static Handle<Map> CopyInstallDescriptors(
5743       Handle<Map> map, int new_descriptor, Handle<DescriptorArray> descriptors,
5744       Handle<LayoutDescriptor> layout_descriptor);
5745   static Handle<Map> CopyAddDescriptor(Handle<Map> map,
5746                                        Descriptor* descriptor,
5747                                        TransitionFlag flag);
5748   static Handle<Map> CopyReplaceDescriptors(
5749       Handle<Map> map, Handle<DescriptorArray> descriptors,
5750       Handle<LayoutDescriptor> layout_descriptor, TransitionFlag flag,
5751       MaybeHandle<Name> maybe_name, const char* reason,
5752       SimpleTransitionFlag simple_flag);
5753
5754   static Handle<Map> CopyReplaceDescriptor(Handle<Map> map,
5755                                            Handle<DescriptorArray> descriptors,
5756                                            Descriptor* descriptor,
5757                                            int index,
5758                                            TransitionFlag flag);
5759   static MUST_USE_RESULT MaybeHandle<Map> TryReconfigureExistingProperty(
5760       Handle<Map> map, int descriptor, PropertyKind kind,
5761       PropertyAttributes attributes, const char** reason);
5762
5763   static Handle<Map> CopyNormalized(Handle<Map> map,
5764                                     PropertyNormalizationMode mode);
5765
5766   // Fires when the layout of an object with a leaf map changes.
5767   // This includes adding transitions to the leaf map or changing
5768   // the descriptor array.
5769   inline void NotifyLeafMapLayoutChange();
5770
5771   void DeprecateTransitionTree();
5772   bool DeprecateTarget(PropertyKind kind, Name* key,
5773                        PropertyAttributes attributes,
5774                        DescriptorArray* new_descriptors,
5775                        LayoutDescriptor* new_layout_descriptor);
5776
5777   Map* FindLastMatchMap(int verbatim, int length, DescriptorArray* descriptors);
5778
5779   // Update field type of the given descriptor to new representation and new
5780   // type. The type must be prepared for storing in descriptor array:
5781   // it must be either a simple type or a map wrapped in a weak cell.
5782   void UpdateFieldType(int descriptor_number, Handle<Name> name,
5783                        Representation new_representation,
5784                        Handle<Object> new_wrapped_type);
5785
5786   void PrintReconfiguration(FILE* file, int modify_index, PropertyKind kind,
5787                             PropertyAttributes attributes);
5788   void PrintGeneralization(FILE* file,
5789                            const char* reason,
5790                            int modify_index,
5791                            int split,
5792                            int descriptors,
5793                            bool constant_to_field,
5794                            Representation old_representation,
5795                            Representation new_representation,
5796                            HeapType* old_field_type,
5797                            HeapType* new_field_type);
5798
5799   static const int kFastPropertiesSoftLimit = 12;
5800   static const int kMaxFastProperties = 128;
5801
5802   DISALLOW_IMPLICIT_CONSTRUCTORS(Map);
5803 };
5804
5805
5806 // An abstract superclass, a marker class really, for simple structure classes.
5807 // It doesn't carry much functionality but allows struct classes to be
5808 // identified in the type system.
5809 class Struct: public HeapObject {
5810  public:
5811   inline void InitializeBody(int object_size);
5812   DECLARE_CAST(Struct)
5813 };
5814
5815
5816 // A simple one-element struct, useful where smis need to be boxed.
5817 class Box : public Struct {
5818  public:
5819   // [value]: the boxed contents.
5820   DECL_ACCESSORS(value, Object)
5821
5822   DECLARE_CAST(Box)
5823
5824   // Dispatched behavior.
5825   DECLARE_PRINTER(Box)
5826   DECLARE_VERIFIER(Box)
5827
5828   static const int kValueOffset = HeapObject::kHeaderSize;
5829   static const int kSize = kValueOffset + kPointerSize;
5830
5831  private:
5832   DISALLOW_IMPLICIT_CONSTRUCTORS(Box);
5833 };
5834
5835
5836 // Container for metadata stored on each prototype map.
5837 class PrototypeInfo : public Struct {
5838  public:
5839   static const int UNREGISTERED = -1;
5840
5841   // [prototype_users]: WeakFixedArray containing maps using this prototype,
5842   // or Smi(0) if uninitialized.
5843   DECL_ACCESSORS(prototype_users, Object)
5844   // [registry_slot]: Slot in prototype's user registry where this user
5845   // is stored. Returns UNREGISTERED if this prototype has not been registered.
5846   inline int registry_slot() const;
5847   inline void set_registry_slot(int slot);
5848   // [validity_cell]: Cell containing the validity bit for prototype chains
5849   // going through this object, or Smi(0) if uninitialized.
5850   DECL_ACCESSORS(validity_cell, Object)
5851   // [constructor_name]: User-friendly name of the original constructor.
5852   DECL_ACCESSORS(constructor_name, Object)
5853
5854   DECLARE_CAST(PrototypeInfo)
5855
5856   // Dispatched behavior.
5857   DECLARE_PRINTER(PrototypeInfo)
5858   DECLARE_VERIFIER(PrototypeInfo)
5859
5860   static const int kPrototypeUsersOffset = HeapObject::kHeaderSize;
5861   static const int kRegistrySlotOffset = kPrototypeUsersOffset + kPointerSize;
5862   static const int kValidityCellOffset = kRegistrySlotOffset + kPointerSize;
5863   static const int kConstructorNameOffset = kValidityCellOffset + kPointerSize;
5864   static const int kSize = kConstructorNameOffset + kPointerSize;
5865
5866  private:
5867   DISALLOW_IMPLICIT_CONSTRUCTORS(PrototypeInfo);
5868 };
5869
5870
5871 // Script describes a script which has been added to the VM.
5872 class Script: public Struct {
5873  public:
5874   // Script types.
5875   enum Type {
5876     TYPE_NATIVE = 0,
5877     TYPE_EXTENSION = 1,
5878     TYPE_NORMAL = 2
5879   };
5880
5881   // Script compilation types.
5882   enum CompilationType {
5883     COMPILATION_TYPE_HOST = 0,
5884     COMPILATION_TYPE_EVAL = 1
5885   };
5886
5887   // Script compilation state.
5888   enum CompilationState {
5889     COMPILATION_STATE_INITIAL = 0,
5890     COMPILATION_STATE_COMPILED = 1
5891   };
5892
5893   // [source]: the script source.
5894   DECL_ACCESSORS(source, Object)
5895
5896   // [name]: the script name.
5897   DECL_ACCESSORS(name, Object)
5898
5899   // [id]: the script id.
5900   DECL_ACCESSORS(id, Smi)
5901
5902   // [line_offset]: script line offset in resource from where it was extracted.
5903   DECL_ACCESSORS(line_offset, Smi)
5904
5905   // [column_offset]: script column offset in resource from where it was
5906   // extracted.
5907   DECL_ACCESSORS(column_offset, Smi)
5908
5909   // [context_data]: context data for the context this script was compiled in.
5910   DECL_ACCESSORS(context_data, Object)
5911
5912   // [wrapper]: the wrapper cache.  This is either undefined or a WeakCell.
5913   DECL_ACCESSORS(wrapper, HeapObject)
5914
5915   // [type]: the script type.
5916   DECL_ACCESSORS(type, Smi)
5917
5918   // [line_ends]: FixedArray of line ends positions.
5919   DECL_ACCESSORS(line_ends, Object)
5920
5921   // [eval_from_shared]: for eval scripts the shared funcion info for the
5922   // function from which eval was called.
5923   DECL_ACCESSORS(eval_from_shared, Object)
5924
5925   // [eval_from_instructions_offset]: the instruction offset in the code for the
5926   // function from which eval was called where eval was called.
5927   DECL_ACCESSORS(eval_from_instructions_offset, Smi)
5928
5929   // [shared_function_infos]: weak fixed array containing all shared
5930   // function infos created from this script.
5931   DECL_ACCESSORS(shared_function_infos, Object)
5932
5933   // [flags]: Holds an exciting bitfield.
5934   DECL_ACCESSORS(flags, Smi)
5935
5936   // [source_url]: sourceURL from magic comment
5937   DECL_ACCESSORS(source_url, Object)
5938
5939   // [source_url]: sourceMappingURL magic comment
5940   DECL_ACCESSORS(source_mapping_url, Object)
5941
5942   // [compilation_type]: how the the script was compiled. Encoded in the
5943   // 'flags' field.
5944   inline CompilationType compilation_type();
5945   inline void set_compilation_type(CompilationType type);
5946
5947   // [compilation_state]: determines whether the script has already been
5948   // compiled. Encoded in the 'flags' field.
5949   inline CompilationState compilation_state();
5950   inline void set_compilation_state(CompilationState state);
5951
5952   // [origin_options]: optional attributes set by the embedder via ScriptOrigin,
5953   // and used by the embedder to make decisions about the script. V8 just passes
5954   // this through. Encoded in the 'flags' field.
5955   inline v8::ScriptOriginOptions origin_options();
5956   inline void set_origin_options(ScriptOriginOptions origin_options);
5957
5958   DECLARE_CAST(Script)
5959
5960   // If script source is an external string, check that the underlying
5961   // resource is accessible. Otherwise, always return true.
5962   inline bool HasValidSource();
5963
5964   // Convert code position into column number.
5965   static int GetColumnNumber(Handle<Script> script, int code_pos);
5966
5967   // Convert code position into (zero-based) line number.
5968   // The non-handlified version does not allocate, but may be much slower.
5969   static int GetLineNumber(Handle<Script> script, int code_pos);
5970   int GetLineNumber(int code_pos);
5971
5972   static Handle<Object> GetNameOrSourceURL(Handle<Script> script);
5973
5974   // Init line_ends array with code positions of line ends inside script source.
5975   static void InitLineEnds(Handle<Script> script);
5976
5977   // Get the JS object wrapping the given script; create it if none exists.
5978   static Handle<JSObject> GetWrapper(Handle<Script> script);
5979
5980   // Look through the list of existing shared function infos to find one
5981   // that matches the function literal.  Return empty handle if not found.
5982   MaybeHandle<SharedFunctionInfo> FindSharedFunctionInfo(FunctionLiteral* fun);
5983
5984   // Dispatched behavior.
5985   DECLARE_PRINTER(Script)
5986   DECLARE_VERIFIER(Script)
5987
5988   static const int kSourceOffset = HeapObject::kHeaderSize;
5989   static const int kNameOffset = kSourceOffset + kPointerSize;
5990   static const int kLineOffsetOffset = kNameOffset + kPointerSize;
5991   static const int kColumnOffsetOffset = kLineOffsetOffset + kPointerSize;
5992   static const int kContextOffset = kColumnOffsetOffset + kPointerSize;
5993   static const int kWrapperOffset = kContextOffset + kPointerSize;
5994   static const int kTypeOffset = kWrapperOffset + kPointerSize;
5995   static const int kLineEndsOffset = kTypeOffset + kPointerSize;
5996   static const int kIdOffset = kLineEndsOffset + kPointerSize;
5997   static const int kEvalFromSharedOffset = kIdOffset + kPointerSize;
5998   static const int kEvalFrominstructionsOffsetOffset =
5999       kEvalFromSharedOffset + kPointerSize;
6000   static const int kSharedFunctionInfosOffset =
6001       kEvalFrominstructionsOffsetOffset + kPointerSize;
6002   static const int kFlagsOffset = kSharedFunctionInfosOffset + kPointerSize;
6003   static const int kSourceUrlOffset = kFlagsOffset + kPointerSize;
6004   static const int kSourceMappingUrlOffset = kSourceUrlOffset + kPointerSize;
6005   static const int kSize = kSourceMappingUrlOffset + kPointerSize;
6006
6007  private:
6008   int GetLineNumberWithArray(int code_pos);
6009
6010   // Bit positions in the flags field.
6011   static const int kCompilationTypeBit = 0;
6012   static const int kCompilationStateBit = 1;
6013   static const int kOriginOptionsShift = 2;
6014   static const int kOriginOptionsSize = 3;
6015   static const int kOriginOptionsMask = ((1 << kOriginOptionsSize) - 1)
6016                                         << kOriginOptionsShift;
6017
6018   DISALLOW_IMPLICIT_CONSTRUCTORS(Script);
6019 };
6020
6021
6022 // List of builtin functions we want to identify to improve code
6023 // generation.
6024 //
6025 // Each entry has a name of a global object property holding an object
6026 // optionally followed by ".prototype", a name of a builtin function
6027 // on the object (the one the id is set for), and a label.
6028 //
6029 // Installation of ids for the selected builtin functions is handled
6030 // by the bootstrapper.
6031 #define FUNCTIONS_WITH_ID_LIST(V)                   \
6032   V(Array.prototype, indexOf, ArrayIndexOf)         \
6033   V(Array.prototype, lastIndexOf, ArrayLastIndexOf) \
6034   V(Array.prototype, push, ArrayPush)               \
6035   V(Array.prototype, pop, ArrayPop)                 \
6036   V(Array.prototype, shift, ArrayShift)             \
6037   V(Function.prototype, apply, FunctionApply)       \
6038   V(Function.prototype, call, FunctionCall)         \
6039   V(String.prototype, charCodeAt, StringCharCodeAt) \
6040   V(String.prototype, charAt, StringCharAt)         \
6041   V(String, fromCharCode, StringFromCharCode)       \
6042   V(Math, random, MathRandom)                       \
6043   V(Math, floor, MathFloor)                         \
6044   V(Math, round, MathRound)                         \
6045   V(Math, ceil, MathCeil)                           \
6046   V(Math, abs, MathAbs)                             \
6047   V(Math, log, MathLog)                             \
6048   V(Math, exp, MathExp)                             \
6049   V(Math, sqrt, MathSqrt)                           \
6050   V(Math, pow, MathPow)                             \
6051   V(Math, max, MathMax)                             \
6052   V(Math, min, MathMin)                             \
6053   V(Math, cos, MathCos)                             \
6054   V(Math, sin, MathSin)                             \
6055   V(Math, tan, MathTan)                             \
6056   V(Math, acos, MathAcos)                           \
6057   V(Math, asin, MathAsin)                           \
6058   V(Math, atan, MathAtan)                           \
6059   V(Math, atan2, MathAtan2)                         \
6060   V(Math, imul, MathImul)                           \
6061   V(Math, clz32, MathClz32)                         \
6062   V(Math, fround, MathFround)
6063
6064 #define ATOMIC_FUNCTIONS_WITH_ID_LIST(V) \
6065   V(Atomics, load, AtomicsLoad)          \
6066   V(Atomics, store, AtomicsStore)
6067
6068 enum BuiltinFunctionId {
6069   kArrayCode,
6070 #define DECLARE_FUNCTION_ID(ignored1, ignore2, name)    \
6071   k##name,
6072   FUNCTIONS_WITH_ID_LIST(DECLARE_FUNCTION_ID)
6073       ATOMIC_FUNCTIONS_WITH_ID_LIST(DECLARE_FUNCTION_ID)
6074 #undef DECLARE_FUNCTION_ID
6075   // Fake id for a special case of Math.pow. Note, it continues the
6076   // list of math functions.
6077   kMathPowHalf
6078 };
6079
6080
6081 // Result of searching in an optimized code map of a SharedFunctionInfo. Note
6082 // that both {code} and {literals} can be NULL to pass search result status.
6083 struct CodeAndLiterals {
6084   Code* code;            // Cached optimized code.
6085   FixedArray* literals;  // Cached literals array.
6086 };
6087
6088
6089 // SharedFunctionInfo describes the JSFunction information that can be
6090 // shared by multiple instances of the function.
6091 class SharedFunctionInfo: public HeapObject {
6092  public:
6093   // [name]: Function name.
6094   DECL_ACCESSORS(name, Object)
6095
6096   // [code]: Function code.
6097   DECL_ACCESSORS(code, Code)
6098   inline void ReplaceCode(Code* code);
6099
6100   // [optimized_code_map]: Map from native context to optimized code
6101   // and a shared literals array or Smi(0) if none.
6102   DECL_ACCESSORS(optimized_code_map, Object)
6103
6104   // Returns entry from optimized code map for specified context and OSR entry.
6105   // Note that {code == nullptr} indicates no matching entry has been found,
6106   // whereas {literals == nullptr} indicates the code is context-independent.
6107   CodeAndLiterals SearchOptimizedCodeMap(Context* native_context,
6108                                          BailoutId osr_ast_id);
6109
6110   // Clear optimized code map.
6111   void ClearOptimizedCodeMap();
6112
6113   // Removed a specific optimized code object from the optimized code map.
6114   void EvictFromOptimizedCodeMap(Code* optimized_code, const char* reason);
6115
6116   // Trims the optimized code map after entries have been removed.
6117   void TrimOptimizedCodeMap(int shrink_by);
6118
6119   // Add a new entry to the optimized code map for context-independent code.
6120   static void AddSharedCodeToOptimizedCodeMap(Handle<SharedFunctionInfo> shared,
6121                                               Handle<Code> code);
6122
6123   // Add a new entry to the optimized code map for context-dependent code.
6124   static void AddToOptimizedCodeMap(Handle<SharedFunctionInfo> shared,
6125                                     Handle<Context> native_context,
6126                                     Handle<Code> code,
6127                                     Handle<FixedArray> literals,
6128                                     BailoutId osr_ast_id);
6129
6130   // Set up the link between shared function info and the script. The shared
6131   // function info is added to the list on the script.
6132   static void SetScript(Handle<SharedFunctionInfo> shared,
6133                         Handle<Object> script_object);
6134
6135   // Layout description of the optimized code map.
6136   static const int kNextMapIndex = 0;
6137   static const int kSharedCodeIndex = 1;
6138   static const int kEntriesStart = 2;
6139   static const int kContextOffset = 0;
6140   static const int kCachedCodeOffset = 1;
6141   static const int kLiteralsOffset = 2;
6142   static const int kOsrAstIdOffset = 3;
6143   static const int kEntryLength = 4;
6144   static const int kInitialLength = kEntriesStart + kEntryLength;
6145
6146   // [scope_info]: Scope info.
6147   DECL_ACCESSORS(scope_info, ScopeInfo)
6148
6149   // [construct stub]: Code stub for constructing instances of this function.
6150   DECL_ACCESSORS(construct_stub, Code)
6151
6152   // Returns if this function has been compiled to native code yet.
6153   inline bool is_compiled();
6154
6155   // [length]: The function length - usually the number of declared parameters.
6156   // Use up to 2^30 parameters.
6157   inline int length() const;
6158   inline void set_length(int value);
6159
6160   // [internal formal parameter count]: The declared number of parameters.
6161   // For subclass constructors, also includes new.target.
6162   // The size of function's frame is internal_formal_parameter_count + 1.
6163   inline int internal_formal_parameter_count() const;
6164   inline void set_internal_formal_parameter_count(int value);
6165
6166   // Set the formal parameter count so the function code will be
6167   // called without using argument adaptor frames.
6168   inline void DontAdaptArguments();
6169
6170   // [expected_nof_properties]: Expected number of properties for the function.
6171   inline int expected_nof_properties() const;
6172   inline void set_expected_nof_properties(int value);
6173
6174   // [feedback_vector] - accumulates ast node feedback from full-codegen and
6175   // (increasingly) from crankshafted code where sufficient feedback isn't
6176   // available.
6177   DECL_ACCESSORS(feedback_vector, TypeFeedbackVector)
6178
6179   // Unconditionally clear the type feedback vector (including vector ICs).
6180   void ClearTypeFeedbackInfo();
6181
6182   // Clear the type feedback vector with a more subtle policy at GC time.
6183   void ClearTypeFeedbackInfoAtGCTime();
6184
6185 #if TRACE_MAPS
6186   // [unique_id] - For --trace-maps purposes, an identifier that's persistent
6187   // even if the GC moves this SharedFunctionInfo.
6188   inline int unique_id() const;
6189   inline void set_unique_id(int value);
6190 #endif
6191
6192   // [instance class name]: class name for instances.
6193   DECL_ACCESSORS(instance_class_name, Object)
6194
6195   // [function data]: This field holds some additional data for function.
6196   // Currently it has one of:
6197   //  - a FunctionTemplateInfo to make benefit the API [IsApiFunction()].
6198   //  - a Smi identifying a builtin function [HasBuiltinFunctionId()].
6199   //  - a BytecodeArray for the interpreter [HasBytecodeArray()].
6200   // In the long run we don't want all functions to have this field but
6201   // we can fix that when we have a better model for storing hidden data
6202   // on objects.
6203   DECL_ACCESSORS(function_data, Object)
6204
6205   inline bool IsApiFunction();
6206   inline FunctionTemplateInfo* get_api_func_data();
6207   inline bool HasBuiltinFunctionId();
6208   inline BuiltinFunctionId builtin_function_id();
6209   inline bool HasBytecodeArray();
6210   inline BytecodeArray* bytecode_array();
6211
6212   // [script info]: Script from which the function originates.
6213   DECL_ACCESSORS(script, Object)
6214
6215   // [num_literals]: Number of literals used by this function.
6216   inline int num_literals() const;
6217   inline void set_num_literals(int value);
6218
6219   // [start_position_and_type]: Field used to store both the source code
6220   // position, whether or not the function is a function expression,
6221   // and whether or not the function is a toplevel function. The two
6222   // least significants bit indicates whether the function is an
6223   // expression and the rest contains the source code position.
6224   inline int start_position_and_type() const;
6225   inline void set_start_position_and_type(int value);
6226
6227   // The function is subject to debugging if a debug info is attached.
6228   inline bool HasDebugInfo();
6229   inline DebugInfo* GetDebugInfo();
6230
6231   // A function has debug code if the compiled code has debug break slots.
6232   inline bool HasDebugCode();
6233
6234   // [debug info]: Debug information.
6235   DECL_ACCESSORS(debug_info, Object)
6236
6237   // [inferred name]: Name inferred from variable or property
6238   // assignment of this function. Used to facilitate debugging and
6239   // profiling of JavaScript code written in OO style, where almost
6240   // all functions are anonymous but are assigned to object
6241   // properties.
6242   DECL_ACCESSORS(inferred_name, String)
6243
6244   // The function's name if it is non-empty, otherwise the inferred name.
6245   String* DebugName();
6246
6247   // Position of the 'function' token in the script source.
6248   inline int function_token_position() const;
6249   inline void set_function_token_position(int function_token_position);
6250
6251   // Position of this function in the script source.
6252   inline int start_position() const;
6253   inline void set_start_position(int start_position);
6254
6255   // End position of this function in the script source.
6256   inline int end_position() const;
6257   inline void set_end_position(int end_position);
6258
6259   // Is this function a function expression in the source code.
6260   DECL_BOOLEAN_ACCESSORS(is_expression)
6261
6262   // Is this function a top-level function (scripts, evals).
6263   DECL_BOOLEAN_ACCESSORS(is_toplevel)
6264
6265   // Bit field containing various information collected by the compiler to
6266   // drive optimization.
6267   inline int compiler_hints() const;
6268   inline void set_compiler_hints(int value);
6269
6270   inline int ast_node_count() const;
6271   inline void set_ast_node_count(int count);
6272
6273   inline int profiler_ticks() const;
6274   inline void set_profiler_ticks(int ticks);
6275
6276   // Inline cache age is used to infer whether the function survived a context
6277   // disposal or not. In the former case we reset the opt_count.
6278   inline int ic_age();
6279   inline void set_ic_age(int age);
6280
6281   // Indicates if this function can be lazy compiled.
6282   // This is used to determine if we can safely flush code from a function
6283   // when doing GC if we expect that the function will no longer be used.
6284   DECL_BOOLEAN_ACCESSORS(allows_lazy_compilation)
6285
6286   // Indicates if this function can be lazy compiled without a context.
6287   // This is used to determine if we can force compilation without reaching
6288   // the function through program execution but through other means (e.g. heap
6289   // iteration by the debugger).
6290   DECL_BOOLEAN_ACCESSORS(allows_lazy_compilation_without_context)
6291
6292   // Indicates whether optimizations have been disabled for this
6293   // shared function info. If a function is repeatedly optimized or if
6294   // we cannot optimize the function we disable optimization to avoid
6295   // spending time attempting to optimize it again.
6296   DECL_BOOLEAN_ACCESSORS(optimization_disabled)
6297
6298   // Indicates the language mode.
6299   inline LanguageMode language_mode();
6300   inline void set_language_mode(LanguageMode language_mode);
6301
6302   // False if the function definitely does not allocate an arguments object.
6303   DECL_BOOLEAN_ACCESSORS(uses_arguments)
6304
6305   // Indicates that this function uses a super property (or an eval that may
6306   // use a super property).
6307   // This is needed to set up the [[HomeObject]] on the function instance.
6308   DECL_BOOLEAN_ACCESSORS(needs_home_object)
6309
6310   // True if the function has any duplicated parameter names.
6311   DECL_BOOLEAN_ACCESSORS(has_duplicate_parameters)
6312
6313   // Indicates whether the function is a native function.
6314   // These needs special treatment in .call and .apply since
6315   // null passed as the receiver should not be translated to the
6316   // global object.
6317   DECL_BOOLEAN_ACCESSORS(native)
6318
6319   // Indicate that this function should always be inlined in optimized code.
6320   DECL_BOOLEAN_ACCESSORS(force_inline)
6321
6322   // Indicates that the function was created by the Function function.
6323   // Though it's anonymous, toString should treat it as if it had the name
6324   // "anonymous".  We don't set the name itself so that the system does not
6325   // see a binding for it.
6326   DECL_BOOLEAN_ACCESSORS(name_should_print_as_anonymous)
6327
6328   // Indicates whether the function is a bound function created using
6329   // the bind function.
6330   DECL_BOOLEAN_ACCESSORS(bound)
6331
6332   // Indicates that the function is anonymous (the name field can be set
6333   // through the API, which does not change this flag).
6334   DECL_BOOLEAN_ACCESSORS(is_anonymous)
6335
6336   // Is this a function or top-level/eval code.
6337   DECL_BOOLEAN_ACCESSORS(is_function)
6338
6339   // Indicates that code for this function cannot be compiled with Crankshaft.
6340   DECL_BOOLEAN_ACCESSORS(dont_crankshaft)
6341
6342   // Indicates that code for this function cannot be flushed.
6343   DECL_BOOLEAN_ACCESSORS(dont_flush)
6344
6345   // Indicates that this function is a generator.
6346   DECL_BOOLEAN_ACCESSORS(is_generator)
6347
6348   // Indicates that this function is an arrow function.
6349   DECL_BOOLEAN_ACCESSORS(is_arrow)
6350
6351   // Indicates that this function is a concise method.
6352   DECL_BOOLEAN_ACCESSORS(is_concise_method)
6353
6354   // Indicates that this function is an accessor (getter or setter).
6355   DECL_BOOLEAN_ACCESSORS(is_accessor_function)
6356
6357   // Indicates that this function is a default constructor.
6358   DECL_BOOLEAN_ACCESSORS(is_default_constructor)
6359
6360   // Indicates that this function is an asm function.
6361   DECL_BOOLEAN_ACCESSORS(asm_function)
6362
6363   // Indicates that the the shared function info is deserialized from cache.
6364   DECL_BOOLEAN_ACCESSORS(deserialized)
6365
6366   // Indicates that the the shared function info has never been compiled before.
6367   DECL_BOOLEAN_ACCESSORS(never_compiled)
6368
6369   inline FunctionKind kind();
6370   inline void set_kind(FunctionKind kind);
6371
6372   // Indicates whether or not the code in the shared function support
6373   // deoptimization.
6374   inline bool has_deoptimization_support();
6375
6376   // Enable deoptimization support through recompiled code.
6377   void EnableDeoptimizationSupport(Code* recompiled);
6378
6379   // Disable (further) attempted optimization of all functions sharing this
6380   // shared function info.
6381   void DisableOptimization(BailoutReason reason);
6382
6383   inline BailoutReason disable_optimization_reason();
6384
6385   // Lookup the bailout ID and DCHECK that it exists in the non-optimized
6386   // code, returns whether it asserted (i.e., always true if assertions are
6387   // disabled).
6388   bool VerifyBailoutId(BailoutId id);
6389
6390   // [source code]: Source code for the function.
6391   bool HasSourceCode() const;
6392   Handle<Object> GetSourceCode();
6393
6394   // Number of times the function was optimized.
6395   inline int opt_count();
6396   inline void set_opt_count(int opt_count);
6397
6398   // Number of times the function was deoptimized.
6399   inline void set_deopt_count(int value);
6400   inline int deopt_count();
6401   inline void increment_deopt_count();
6402
6403   // Number of time we tried to re-enable optimization after it
6404   // was disabled due to high number of deoptimizations.
6405   inline void set_opt_reenable_tries(int value);
6406   inline int opt_reenable_tries();
6407
6408   inline void TryReenableOptimization();
6409
6410   // Stores deopt_count, opt_reenable_tries and ic_age as bit-fields.
6411   inline void set_counters(int value);
6412   inline int counters() const;
6413
6414   // Stores opt_count and bailout_reason as bit-fields.
6415   inline void set_opt_count_and_bailout_reason(int value);
6416   inline int opt_count_and_bailout_reason() const;
6417
6418   inline void set_disable_optimization_reason(BailoutReason reason);
6419
6420   // Tells whether this function should be subject to debugging.
6421   inline bool IsSubjectToDebugging();
6422
6423   // Check whether or not this function is inlineable.
6424   bool IsInlineable();
6425
6426   // Source size of this function.
6427   int SourceSize();
6428
6429   // Calculate the instance size.
6430   int CalculateInstanceSize();
6431
6432   // Calculate the number of in-object properties.
6433   int CalculateInObjectProperties();
6434
6435   inline bool has_simple_parameters();
6436
6437   // Initialize a SharedFunctionInfo from a parsed function literal.
6438   static void InitFromFunctionLiteral(Handle<SharedFunctionInfo> shared_info,
6439                                       FunctionLiteral* lit);
6440
6441   // Dispatched behavior.
6442   DECLARE_PRINTER(SharedFunctionInfo)
6443   DECLARE_VERIFIER(SharedFunctionInfo)
6444
6445   void ResetForNewContext(int new_ic_age);
6446
6447   DECLARE_CAST(SharedFunctionInfo)
6448
6449   // Constants.
6450   static const int kDontAdaptArgumentsSentinel = -1;
6451
6452   // Layout description.
6453   // Pointer fields.
6454   static const int kNameOffset = HeapObject::kHeaderSize;
6455   static const int kCodeOffset = kNameOffset + kPointerSize;
6456   static const int kOptimizedCodeMapOffset = kCodeOffset + kPointerSize;
6457   static const int kScopeInfoOffset = kOptimizedCodeMapOffset + kPointerSize;
6458   static const int kConstructStubOffset = kScopeInfoOffset + kPointerSize;
6459   static const int kInstanceClassNameOffset =
6460       kConstructStubOffset + kPointerSize;
6461   static const int kFunctionDataOffset =
6462       kInstanceClassNameOffset + kPointerSize;
6463   static const int kScriptOffset = kFunctionDataOffset + kPointerSize;
6464   static const int kDebugInfoOffset = kScriptOffset + kPointerSize;
6465   static const int kInferredNameOffset = kDebugInfoOffset + kPointerSize;
6466   static const int kFeedbackVectorOffset =
6467       kInferredNameOffset + kPointerSize;
6468 #if TRACE_MAPS
6469   static const int kUniqueIdOffset = kFeedbackVectorOffset + kPointerSize;
6470   static const int kLastPointerFieldOffset = kUniqueIdOffset;
6471 #else
6472   // Just to not break the postmortrem support with conditional offsets
6473   static const int kUniqueIdOffset = kFeedbackVectorOffset;
6474   static const int kLastPointerFieldOffset = kFeedbackVectorOffset;
6475 #endif
6476
6477 #if V8_HOST_ARCH_32_BIT
6478   // Smi fields.
6479   static const int kLengthOffset = kLastPointerFieldOffset + kPointerSize;
6480   static const int kFormalParameterCountOffset = kLengthOffset + kPointerSize;
6481   static const int kExpectedNofPropertiesOffset =
6482       kFormalParameterCountOffset + kPointerSize;
6483   static const int kNumLiteralsOffset =
6484       kExpectedNofPropertiesOffset + kPointerSize;
6485   static const int kStartPositionAndTypeOffset =
6486       kNumLiteralsOffset + kPointerSize;
6487   static const int kEndPositionOffset =
6488       kStartPositionAndTypeOffset + kPointerSize;
6489   static const int kFunctionTokenPositionOffset =
6490       kEndPositionOffset + kPointerSize;
6491   static const int kCompilerHintsOffset =
6492       kFunctionTokenPositionOffset + kPointerSize;
6493   static const int kOptCountAndBailoutReasonOffset =
6494       kCompilerHintsOffset + kPointerSize;
6495   static const int kCountersOffset =
6496       kOptCountAndBailoutReasonOffset + kPointerSize;
6497   static const int kAstNodeCountOffset =
6498       kCountersOffset + kPointerSize;
6499   static const int kProfilerTicksOffset =
6500       kAstNodeCountOffset + kPointerSize;
6501
6502   // Total size.
6503   static const int kSize = kProfilerTicksOffset + kPointerSize;
6504 #else
6505   // The only reason to use smi fields instead of int fields
6506   // is to allow iteration without maps decoding during
6507   // garbage collections.
6508   // To avoid wasting space on 64-bit architectures we use
6509   // the following trick: we group integer fields into pairs
6510 // The least significant integer in each pair is shifted left by 1.
6511 // By doing this we guarantee that LSB of each kPointerSize aligned
6512 // word is not set and thus this word cannot be treated as pointer
6513 // to HeapObject during old space traversal.
6514 #if V8_TARGET_LITTLE_ENDIAN
6515   static const int kLengthOffset = kLastPointerFieldOffset + kPointerSize;
6516   static const int kFormalParameterCountOffset =
6517       kLengthOffset + kIntSize;
6518
6519   static const int kExpectedNofPropertiesOffset =
6520       kFormalParameterCountOffset + kIntSize;
6521   static const int kNumLiteralsOffset =
6522       kExpectedNofPropertiesOffset + kIntSize;
6523
6524   static const int kEndPositionOffset =
6525       kNumLiteralsOffset + kIntSize;
6526   static const int kStartPositionAndTypeOffset =
6527       kEndPositionOffset + kIntSize;
6528
6529   static const int kFunctionTokenPositionOffset =
6530       kStartPositionAndTypeOffset + kIntSize;
6531   static const int kCompilerHintsOffset =
6532       kFunctionTokenPositionOffset + kIntSize;
6533
6534   static const int kOptCountAndBailoutReasonOffset =
6535       kCompilerHintsOffset + kIntSize;
6536   static const int kCountersOffset =
6537       kOptCountAndBailoutReasonOffset + kIntSize;
6538
6539   static const int kAstNodeCountOffset =
6540       kCountersOffset + kIntSize;
6541   static const int kProfilerTicksOffset =
6542       kAstNodeCountOffset + kIntSize;
6543
6544   // Total size.
6545   static const int kSize = kProfilerTicksOffset + kIntSize;
6546
6547 #elif V8_TARGET_BIG_ENDIAN
6548   static const int kFormalParameterCountOffset =
6549       kLastPointerFieldOffset + kPointerSize;
6550   static const int kLengthOffset = kFormalParameterCountOffset + kIntSize;
6551
6552   static const int kNumLiteralsOffset = kLengthOffset + kIntSize;
6553   static const int kExpectedNofPropertiesOffset = kNumLiteralsOffset + kIntSize;
6554
6555   static const int kStartPositionAndTypeOffset =
6556       kExpectedNofPropertiesOffset + kIntSize;
6557   static const int kEndPositionOffset = kStartPositionAndTypeOffset + kIntSize;
6558
6559   static const int kCompilerHintsOffset = kEndPositionOffset + kIntSize;
6560   static const int kFunctionTokenPositionOffset =
6561       kCompilerHintsOffset + kIntSize;
6562
6563   static const int kCountersOffset = kFunctionTokenPositionOffset + kIntSize;
6564   static const int kOptCountAndBailoutReasonOffset = kCountersOffset + kIntSize;
6565
6566   static const int kProfilerTicksOffset =
6567       kOptCountAndBailoutReasonOffset + kIntSize;
6568   static const int kAstNodeCountOffset = kProfilerTicksOffset + kIntSize;
6569
6570   // Total size.
6571   static const int kSize = kAstNodeCountOffset + kIntSize;
6572
6573 #else
6574 #error Unknown byte ordering
6575 #endif  // Big endian
6576 #endif  // 64-bit
6577
6578
6579   static const int kAlignedSize = POINTER_SIZE_ALIGN(kSize);
6580
6581   typedef FixedBodyDescriptor<kNameOffset,
6582                               kLastPointerFieldOffset + kPointerSize,
6583                               kSize> BodyDescriptor;
6584
6585   // Bit positions in start_position_and_type.
6586   // The source code start position is in the 30 most significant bits of
6587   // the start_position_and_type field.
6588   static const int kIsExpressionBit    = 0;
6589   static const int kIsTopLevelBit      = 1;
6590   static const int kStartPositionShift = 2;
6591   static const int kStartPositionMask  = ~((1 << kStartPositionShift) - 1);
6592
6593   // Bit positions in compiler_hints.
6594   enum CompilerHints {
6595     kAllowLazyCompilation,
6596     kAllowLazyCompilationWithoutContext,
6597     kOptimizationDisabled,
6598     kStrictModeFunction,
6599     kStrongModeFunction,
6600     kUsesArguments,
6601     kNeedsHomeObject,
6602     kHasDuplicateParameters,
6603     kNative,
6604     kForceInline,
6605     kBoundFunction,
6606     kIsAnonymous,
6607     kNameShouldPrintAsAnonymous,
6608     kIsFunction,
6609     kDontCrankshaft,
6610     kDontFlush,
6611     kIsArrow,
6612     kIsGenerator,
6613     kIsConciseMethod,
6614     kIsAccessorFunction,
6615     kIsDefaultConstructor,
6616     kIsSubclassConstructor,
6617     kIsBaseConstructor,
6618     kInClassLiteral,
6619     kIsAsmFunction,
6620     kDeserialized,
6621     kNeverCompiled,
6622     kCompilerHintsCount  // Pseudo entry
6623   };
6624   // Add hints for other modes when they're added.
6625   STATIC_ASSERT(LANGUAGE_END == 3);
6626
6627   class FunctionKindBits : public BitField<FunctionKind, kIsArrow, 8> {};
6628
6629   class DeoptCountBits : public BitField<int, 0, 4> {};
6630   class OptReenableTriesBits : public BitField<int, 4, 18> {};
6631   class ICAgeBits : public BitField<int, 22, 8> {};
6632
6633   class OptCountBits : public BitField<int, 0, 22> {};
6634   class DisabledOptimizationReasonBits : public BitField<int, 22, 8> {};
6635
6636  private:
6637 #if V8_HOST_ARCH_32_BIT
6638   // On 32 bit platforms, compiler hints is a smi.
6639   static const int kCompilerHintsSmiTagSize = kSmiTagSize;
6640   static const int kCompilerHintsSize = kPointerSize;
6641 #else
6642   // On 64 bit platforms, compiler hints is not a smi, see comment above.
6643   static const int kCompilerHintsSmiTagSize = 0;
6644   static const int kCompilerHintsSize = kIntSize;
6645 #endif
6646
6647   STATIC_ASSERT(SharedFunctionInfo::kCompilerHintsCount <=
6648                 SharedFunctionInfo::kCompilerHintsSize * kBitsPerByte);
6649
6650  public:
6651   // Constants for optimizing codegen for strict mode function and
6652   // native tests.
6653   // Allows to use byte-width instructions.
6654   static const int kStrictModeBitWithinByte =
6655       (kStrictModeFunction + kCompilerHintsSmiTagSize) % kBitsPerByte;
6656   static const int kStrongModeBitWithinByte =
6657       (kStrongModeFunction + kCompilerHintsSmiTagSize) % kBitsPerByte;
6658
6659   static const int kNativeBitWithinByte =
6660       (kNative + kCompilerHintsSmiTagSize) % kBitsPerByte;
6661
6662 #if defined(V8_TARGET_LITTLE_ENDIAN)
6663   static const int kStrictModeByteOffset = kCompilerHintsOffset +
6664       (kStrictModeFunction + kCompilerHintsSmiTagSize) / kBitsPerByte;
6665   static const int kStrongModeByteOffset =
6666       kCompilerHintsOffset +
6667       (kStrongModeFunction + kCompilerHintsSmiTagSize) / kBitsPerByte;
6668   static const int kNativeByteOffset = kCompilerHintsOffset +
6669       (kNative + kCompilerHintsSmiTagSize) / kBitsPerByte;
6670 #elif defined(V8_TARGET_BIG_ENDIAN)
6671   static const int kStrictModeByteOffset = kCompilerHintsOffset +
6672       (kCompilerHintsSize - 1) -
6673       ((kStrictModeFunction + kCompilerHintsSmiTagSize) / kBitsPerByte);
6674   static const int kStrongModeByteOffset =
6675       kCompilerHintsOffset + (kCompilerHintsSize - 1) -
6676       ((kStrongModeFunction + kCompilerHintsSmiTagSize) / kBitsPerByte);
6677   static const int kNativeByteOffset = kCompilerHintsOffset +
6678       (kCompilerHintsSize - 1) -
6679       ((kNative + kCompilerHintsSmiTagSize) / kBitsPerByte);
6680 #else
6681 #error Unknown byte ordering
6682 #endif
6683
6684  private:
6685   DISALLOW_IMPLICIT_CONSTRUCTORS(SharedFunctionInfo);
6686 };
6687
6688
6689 // Printing support.
6690 struct SourceCodeOf {
6691   explicit SourceCodeOf(SharedFunctionInfo* v, int max = -1)
6692       : value(v), max_length(max) {}
6693   const SharedFunctionInfo* value;
6694   int max_length;
6695 };
6696
6697
6698 std::ostream& operator<<(std::ostream& os, const SourceCodeOf& v);
6699
6700
6701 class JSGeneratorObject: public JSObject {
6702  public:
6703   // [function]: The function corresponding to this generator object.
6704   DECL_ACCESSORS(function, JSFunction)
6705
6706   // [context]: The context of the suspended computation.
6707   DECL_ACCESSORS(context, Context)
6708
6709   // [receiver]: The receiver of the suspended computation.
6710   DECL_ACCESSORS(receiver, Object)
6711
6712   // [continuation]: Offset into code of continuation.
6713   //
6714   // A positive offset indicates a suspended generator.  The special
6715   // kGeneratorExecuting and kGeneratorClosed values indicate that a generator
6716   // cannot be resumed.
6717   inline int continuation() const;
6718   inline void set_continuation(int continuation);
6719   inline bool is_closed();
6720   inline bool is_executing();
6721   inline bool is_suspended();
6722
6723   // [operand_stack]: Saved operand stack.
6724   DECL_ACCESSORS(operand_stack, FixedArray)
6725
6726   DECLARE_CAST(JSGeneratorObject)
6727
6728   // Dispatched behavior.
6729   DECLARE_PRINTER(JSGeneratorObject)
6730   DECLARE_VERIFIER(JSGeneratorObject)
6731
6732   // Magic sentinel values for the continuation.
6733   static const int kGeneratorExecuting = -1;
6734   static const int kGeneratorClosed = 0;
6735
6736   // Layout description.
6737   static const int kFunctionOffset = JSObject::kHeaderSize;
6738   static const int kContextOffset = kFunctionOffset + kPointerSize;
6739   static const int kReceiverOffset = kContextOffset + kPointerSize;
6740   static const int kContinuationOffset = kReceiverOffset + kPointerSize;
6741   static const int kOperandStackOffset = kContinuationOffset + kPointerSize;
6742   static const int kSize = kOperandStackOffset + kPointerSize;
6743
6744   // Resume mode, for use by runtime functions.
6745   enum ResumeMode { NEXT, THROW };
6746
6747   // Yielding from a generator returns an object with the following inobject
6748   // properties.  See Context::iterator_result_map() for the map.
6749   static const int kResultValuePropertyIndex = 0;
6750   static const int kResultDonePropertyIndex = 1;
6751   static const int kResultPropertyCount = 2;
6752
6753   static const int kResultValuePropertyOffset = JSObject::kHeaderSize;
6754   static const int kResultDonePropertyOffset =
6755       kResultValuePropertyOffset + kPointerSize;
6756   static const int kResultSize = kResultDonePropertyOffset + kPointerSize;
6757
6758  private:
6759   DISALLOW_IMPLICIT_CONSTRUCTORS(JSGeneratorObject);
6760 };
6761
6762
6763 // Representation for module instance objects.
6764 class JSModule: public JSObject {
6765  public:
6766   // [context]: the context holding the module's locals, or undefined if none.
6767   DECL_ACCESSORS(context, Object)
6768
6769   // [scope_info]: Scope info.
6770   DECL_ACCESSORS(scope_info, ScopeInfo)
6771
6772   DECLARE_CAST(JSModule)
6773
6774   // Dispatched behavior.
6775   DECLARE_PRINTER(JSModule)
6776   DECLARE_VERIFIER(JSModule)
6777
6778   // Layout description.
6779   static const int kContextOffset = JSObject::kHeaderSize;
6780   static const int kScopeInfoOffset = kContextOffset + kPointerSize;
6781   static const int kSize = kScopeInfoOffset + kPointerSize;
6782
6783  private:
6784   DISALLOW_IMPLICIT_CONSTRUCTORS(JSModule);
6785 };
6786
6787
6788 // JSFunction describes JavaScript functions.
6789 class JSFunction: public JSObject {
6790  public:
6791   // [prototype_or_initial_map]:
6792   DECL_ACCESSORS(prototype_or_initial_map, Object)
6793
6794   // [shared]: The information about the function that
6795   // can be shared by instances.
6796   DECL_ACCESSORS(shared, SharedFunctionInfo)
6797
6798   // [context]: The context for this function.
6799   inline Context* context();
6800   inline void set_context(Object* context);
6801   inline JSObject* global_proxy();
6802
6803   // [code]: The generated code object for this function.  Executed
6804   // when the function is invoked, e.g. foo() or new foo(). See
6805   // [[Call]] and [[Construct]] description in ECMA-262, section
6806   // 8.6.2, page 27.
6807   inline Code* code();
6808   inline void set_code(Code* code);
6809   inline void set_code_no_write_barrier(Code* code);
6810   inline void ReplaceCode(Code* code);
6811
6812   // Tells whether this function is builtin.
6813   inline bool IsBuiltin();
6814
6815   // Tells whether this function inlines the given shared function info.
6816   bool Inlines(SharedFunctionInfo* candidate);
6817
6818   // Tells whether this function should be subject to debugging.
6819   inline bool IsSubjectToDebugging();
6820
6821   // Tells whether or not the function needs arguments adaption.
6822   inline bool NeedsArgumentsAdaption();
6823
6824   // Tells whether or not this function has been optimized.
6825   inline bool IsOptimized();
6826
6827   // Mark this function for lazy recompilation. The function will be
6828   // recompiled the next time it is executed.
6829   void MarkForOptimization();
6830   void AttemptConcurrentOptimization();
6831
6832   // Tells whether or not the function is already marked for lazy
6833   // recompilation.
6834   inline bool IsMarkedForOptimization();
6835   inline bool IsMarkedForConcurrentOptimization();
6836
6837   // Tells whether or not the function is on the concurrent recompilation queue.
6838   inline bool IsInOptimizationQueue();
6839
6840   // Inobject slack tracking is the way to reclaim unused inobject space.
6841   //
6842   // The instance size is initially determined by adding some slack to
6843   // expected_nof_properties (to allow for a few extra properties added
6844   // after the constructor). There is no guarantee that the extra space
6845   // will not be wasted.
6846   //
6847   // Here is the algorithm to reclaim the unused inobject space:
6848   // - Detect the first constructor call for this JSFunction.
6849   //   When it happens enter the "in progress" state: initialize construction
6850   //   counter in the initial_map.
6851   // - While the tracking is in progress create objects filled with
6852   //   one_pointer_filler_map instead of undefined_value. This way they can be
6853   //   resized quickly and safely.
6854   // - Once enough objects have been created  compute the 'slack'
6855   //   (traverse the map transition tree starting from the
6856   //   initial_map and find the lowest value of unused_property_fields).
6857   // - Traverse the transition tree again and decrease the instance size
6858   //   of every map. Existing objects will resize automatically (they are
6859   //   filled with one_pointer_filler_map). All further allocations will
6860   //   use the adjusted instance size.
6861   // - SharedFunctionInfo's expected_nof_properties left unmodified since
6862   //   allocations made using different closures could actually create different
6863   //   kind of objects (see prototype inheritance pattern).
6864   //
6865   //  Important: inobject slack tracking is not attempted during the snapshot
6866   //  creation.
6867
6868   // True if the initial_map is set and the object constructions countdown
6869   // counter is not zero.
6870   static const int kGenerousAllocationCount =
6871       Map::kSlackTrackingCounterStart - Map::kSlackTrackingCounterEnd + 1;
6872   inline bool IsInobjectSlackTrackingInProgress();
6873
6874   // Starts the tracking.
6875   // Initializes object constructions countdown counter in the initial map.
6876   void StartInobjectSlackTracking();
6877
6878   // Completes the tracking.
6879   void CompleteInobjectSlackTracking();
6880
6881   // [literals_or_bindings]: Fixed array holding either
6882   // the materialized literals or the bindings of a bound function.
6883   //
6884   // If the function contains object, regexp or array literals, the
6885   // literals array prefix contains the object, regexp, and array
6886   // function to be used when creating these literals.  This is
6887   // necessary so that we do not dynamically lookup the object, regexp
6888   // or array functions.  Performing a dynamic lookup, we might end up
6889   // using the functions from a new context that we should not have
6890   // access to.
6891   //
6892   // On bound functions, the array is a (copy-on-write) fixed-array containing
6893   // the function that was bound, bound this-value and any bound
6894   // arguments. Bound functions never contain literals.
6895   DECL_ACCESSORS(literals_or_bindings, FixedArray)
6896
6897   inline FixedArray* literals();
6898   inline void set_literals(FixedArray* literals);
6899
6900   inline FixedArray* function_bindings();
6901   inline void set_function_bindings(FixedArray* bindings);
6902
6903   // The initial map for an object created by this constructor.
6904   inline Map* initial_map();
6905   static void SetInitialMap(Handle<JSFunction> function, Handle<Map> map,
6906                             Handle<Object> prototype);
6907   inline bool has_initial_map();
6908   static void EnsureHasInitialMap(Handle<JSFunction> function);
6909
6910   // Get and set the prototype property on a JSFunction. If the
6911   // function has an initial map the prototype is set on the initial
6912   // map. Otherwise, the prototype is put in the initial map field
6913   // until an initial map is needed.
6914   inline bool has_prototype();
6915   inline bool has_instance_prototype();
6916   inline Object* prototype();
6917   inline Object* instance_prototype();
6918   static void SetPrototype(Handle<JSFunction> function,
6919                            Handle<Object> value);
6920   static void SetInstancePrototype(Handle<JSFunction> function,
6921                                    Handle<Object> value);
6922
6923   // Creates a new closure for the fucntion with the same bindings,
6924   // bound values, and prototype. An equivalent of spec operations
6925   // ``CloneMethod`` and ``CloneBoundFunction``.
6926   static Handle<JSFunction> CloneClosure(Handle<JSFunction> function);
6927
6928   // After prototype is removed, it will not be created when accessed, and
6929   // [[Construct]] from this function will not be allowed.
6930   bool RemovePrototype();
6931   inline bool should_have_prototype();
6932
6933   // Accessor for this function's initial map's [[class]]
6934   // property. This is primarily used by ECMA native functions.  This
6935   // method sets the class_name field of this function's initial map
6936   // to a given value. It creates an initial map if this function does
6937   // not have one. Note that this method does not copy the initial map
6938   // if it has one already, but simply replaces it with the new value.
6939   // Instances created afterwards will have a map whose [[class]] is
6940   // set to 'value', but there is no guarantees on instances created
6941   // before.
6942   void SetInstanceClassName(String* name);
6943
6944   // Returns if this function has been compiled to native code yet.
6945   inline bool is_compiled();
6946
6947   // Returns `false` if formal parameters include rest parameters, optional
6948   // parameters, or destructuring parameters.
6949   // TODO(caitp): make this a flag set during parsing
6950   inline bool has_simple_parameters();
6951
6952   // [next_function_link]: Links functions into various lists, e.g. the list
6953   // of optimized functions hanging off the native_context. The CodeFlusher
6954   // uses this link to chain together flushing candidates. Treated weakly
6955   // by the garbage collector.
6956   DECL_ACCESSORS(next_function_link, Object)
6957
6958   // Prints the name of the function using PrintF.
6959   void PrintName(FILE* out = stdout);
6960
6961   DECLARE_CAST(JSFunction)
6962
6963   // Iterates the objects, including code objects indirectly referenced
6964   // through pointers to the first instruction in the code object.
6965   void JSFunctionIterateBody(int object_size, ObjectVisitor* v);
6966
6967   // Dispatched behavior.
6968   DECLARE_PRINTER(JSFunction)
6969   DECLARE_VERIFIER(JSFunction)
6970
6971   // Returns the number of allocated literals.
6972   inline int NumberOfLiterals();
6973
6974   // Used for flags such as --hydrogen-filter.
6975   bool PassesFilter(const char* raw_filter);
6976
6977   // The function's name if it is configured, otherwise shared function info
6978   // debug name.
6979   static Handle<String> GetDebugName(Handle<JSFunction> function);
6980
6981   // Layout descriptors. The last property (from kNonWeakFieldsEndOffset to
6982   // kSize) is weak and has special handling during garbage collection.
6983   static const int kCodeEntryOffset = JSObject::kHeaderSize;
6984   static const int kPrototypeOrInitialMapOffset =
6985       kCodeEntryOffset + kPointerSize;
6986   static const int kSharedFunctionInfoOffset =
6987       kPrototypeOrInitialMapOffset + kPointerSize;
6988   static const int kContextOffset = kSharedFunctionInfoOffset + kPointerSize;
6989   static const int kLiteralsOffset = kContextOffset + kPointerSize;
6990   static const int kNonWeakFieldsEndOffset = kLiteralsOffset + kPointerSize;
6991   static const int kNextFunctionLinkOffset = kNonWeakFieldsEndOffset;
6992   static const int kSize = kNextFunctionLinkOffset + kPointerSize;
6993
6994   // Layout of the bound-function binding array.
6995   static const int kBoundFunctionIndex = 0;
6996   static const int kBoundThisIndex = 1;
6997   static const int kBoundArgumentsStartIndex = 2;
6998
6999  private:
7000   DISALLOW_IMPLICIT_CONSTRUCTORS(JSFunction);
7001 };
7002
7003
7004 // JSGlobalProxy's prototype must be a JSGlobalObject or null,
7005 // and the prototype is hidden. JSGlobalProxy always delegates
7006 // property accesses to its prototype if the prototype is not null.
7007 //
7008 // A JSGlobalProxy can be reinitialized which will preserve its identity.
7009 //
7010 // Accessing a JSGlobalProxy requires security check.
7011
7012 class JSGlobalProxy : public JSObject {
7013  public:
7014   // [native_context]: the owner native context of this global proxy object.
7015   // It is null value if this object is not used by any context.
7016   DECL_ACCESSORS(native_context, Object)
7017
7018   // [hash]: The hash code property (undefined if not initialized yet).
7019   DECL_ACCESSORS(hash, Object)
7020
7021   DECLARE_CAST(JSGlobalProxy)
7022
7023   inline bool IsDetachedFrom(GlobalObject* global) const;
7024
7025   // Dispatched behavior.
7026   DECLARE_PRINTER(JSGlobalProxy)
7027   DECLARE_VERIFIER(JSGlobalProxy)
7028
7029   // Layout description.
7030   static const int kNativeContextOffset = JSObject::kHeaderSize;
7031   static const int kHashOffset = kNativeContextOffset + kPointerSize;
7032   static const int kSize = kHashOffset + kPointerSize;
7033
7034  private:
7035   DISALLOW_IMPLICIT_CONSTRUCTORS(JSGlobalProxy);
7036 };
7037
7038
7039 // Common super class for JavaScript global objects and the special
7040 // builtins global objects.
7041 class GlobalObject: public JSObject {
7042  public:
7043   // [builtins]: the object holding the runtime routines written in JS.
7044   DECL_ACCESSORS(builtins, JSBuiltinsObject)
7045
7046   // [native context]: the natives corresponding to this global object.
7047   DECL_ACCESSORS(native_context, Context)
7048
7049   // [global proxy]: the global proxy object of the context
7050   DECL_ACCESSORS(global_proxy, JSObject)
7051
7052   DECLARE_CAST(GlobalObject)
7053
7054   static void InvalidatePropertyCell(Handle<GlobalObject> object,
7055                                      Handle<Name> name);
7056   // Ensure that the global object has a cell for the given property name.
7057   static Handle<PropertyCell> EnsurePropertyCell(Handle<GlobalObject> global,
7058                                                  Handle<Name> name);
7059
7060   // Layout description.
7061   static const int kBuiltinsOffset = JSObject::kHeaderSize;
7062   static const int kNativeContextOffset = kBuiltinsOffset + kPointerSize;
7063   static const int kGlobalProxyOffset = kNativeContextOffset + kPointerSize;
7064   static const int kHeaderSize = kGlobalProxyOffset + kPointerSize;
7065
7066  private:
7067   DISALLOW_IMPLICIT_CONSTRUCTORS(GlobalObject);
7068 };
7069
7070
7071 // JavaScript global object.
7072 class JSGlobalObject: public GlobalObject {
7073  public:
7074   DECLARE_CAST(JSGlobalObject)
7075
7076   inline bool IsDetached();
7077
7078   // Dispatched behavior.
7079   DECLARE_PRINTER(JSGlobalObject)
7080   DECLARE_VERIFIER(JSGlobalObject)
7081
7082   // Layout description.
7083   static const int kSize = GlobalObject::kHeaderSize;
7084
7085  private:
7086   DISALLOW_IMPLICIT_CONSTRUCTORS(JSGlobalObject);
7087 };
7088
7089
7090 // Builtins global object which holds the runtime routines written in
7091 // JavaScript.
7092 class JSBuiltinsObject: public GlobalObject {
7093  public:
7094   // Accessors for the runtime routines written in JavaScript.
7095   inline Object* javascript_builtin(Builtins::JavaScript id);
7096   inline void set_javascript_builtin(Builtins::JavaScript id, Object* value);
7097
7098   DECLARE_CAST(JSBuiltinsObject)
7099
7100   // Dispatched behavior.
7101   DECLARE_PRINTER(JSBuiltinsObject)
7102   DECLARE_VERIFIER(JSBuiltinsObject)
7103
7104   // Layout description.  The size of the builtins object includes
7105   // room for two pointers per runtime routine written in javascript
7106   // (function and code object).
7107   static const int kJSBuiltinsCount = Builtins::id_count;
7108   static const int kJSBuiltinsOffset = GlobalObject::kHeaderSize;
7109   static const int kSize =
7110       GlobalObject::kHeaderSize + (kJSBuiltinsCount * kPointerSize);
7111
7112   static int OffsetOfFunctionWithId(Builtins::JavaScript id) {
7113     return kJSBuiltinsOffset + id * kPointerSize;
7114   }
7115
7116  private:
7117   DISALLOW_IMPLICIT_CONSTRUCTORS(JSBuiltinsObject);
7118 };
7119
7120
7121 // Representation for JS Wrapper objects, String, Number, Boolean, etc.
7122 class JSValue: public JSObject {
7123  public:
7124   // [value]: the object being wrapped.
7125   DECL_ACCESSORS(value, Object)
7126
7127   DECLARE_CAST(JSValue)
7128
7129   // Dispatched behavior.
7130   DECLARE_PRINTER(JSValue)
7131   DECLARE_VERIFIER(JSValue)
7132
7133   // Layout description.
7134   static const int kValueOffset = JSObject::kHeaderSize;
7135   static const int kSize = kValueOffset + kPointerSize;
7136
7137  private:
7138   DISALLOW_IMPLICIT_CONSTRUCTORS(JSValue);
7139 };
7140
7141
7142 class DateCache;
7143
7144 // Representation for JS date objects.
7145 class JSDate: public JSObject {
7146  public:
7147   // If one component is NaN, all of them are, indicating a NaN time value.
7148   // [value]: the time value.
7149   DECL_ACCESSORS(value, Object)
7150   // [year]: caches year. Either undefined, smi, or NaN.
7151   DECL_ACCESSORS(year, Object)
7152   // [month]: caches month. Either undefined, smi, or NaN.
7153   DECL_ACCESSORS(month, Object)
7154   // [day]: caches day. Either undefined, smi, or NaN.
7155   DECL_ACCESSORS(day, Object)
7156   // [weekday]: caches day of week. Either undefined, smi, or NaN.
7157   DECL_ACCESSORS(weekday, Object)
7158   // [hour]: caches hours. Either undefined, smi, or NaN.
7159   DECL_ACCESSORS(hour, Object)
7160   // [min]: caches minutes. Either undefined, smi, or NaN.
7161   DECL_ACCESSORS(min, Object)
7162   // [sec]: caches seconds. Either undefined, smi, or NaN.
7163   DECL_ACCESSORS(sec, Object)
7164   // [cache stamp]: sample of the date cache stamp at the
7165   // moment when chached fields were cached.
7166   DECL_ACCESSORS(cache_stamp, Object)
7167
7168   DECLARE_CAST(JSDate)
7169
7170   // Returns the date field with the specified index.
7171   // See FieldIndex for the list of date fields.
7172   static Object* GetField(Object* date, Smi* index);
7173
7174   void SetValue(Object* value, bool is_value_nan);
7175
7176
7177   // Dispatched behavior.
7178   DECLARE_PRINTER(JSDate)
7179   DECLARE_VERIFIER(JSDate)
7180
7181   // The order is important. It must be kept in sync with date macros
7182   // in macros.py.
7183   enum FieldIndex {
7184     kDateValue,
7185     kYear,
7186     kMonth,
7187     kDay,
7188     kWeekday,
7189     kHour,
7190     kMinute,
7191     kSecond,
7192     kFirstUncachedField,
7193     kMillisecond = kFirstUncachedField,
7194     kDays,
7195     kTimeInDay,
7196     kFirstUTCField,
7197     kYearUTC = kFirstUTCField,
7198     kMonthUTC,
7199     kDayUTC,
7200     kWeekdayUTC,
7201     kHourUTC,
7202     kMinuteUTC,
7203     kSecondUTC,
7204     kMillisecondUTC,
7205     kDaysUTC,
7206     kTimeInDayUTC,
7207     kTimezoneOffset
7208   };
7209
7210   // Layout description.
7211   static const int kValueOffset = JSObject::kHeaderSize;
7212   static const int kYearOffset = kValueOffset + kPointerSize;
7213   static const int kMonthOffset = kYearOffset + kPointerSize;
7214   static const int kDayOffset = kMonthOffset + kPointerSize;
7215   static const int kWeekdayOffset = kDayOffset + kPointerSize;
7216   static const int kHourOffset = kWeekdayOffset  + kPointerSize;
7217   static const int kMinOffset = kHourOffset + kPointerSize;
7218   static const int kSecOffset = kMinOffset + kPointerSize;
7219   static const int kCacheStampOffset = kSecOffset + kPointerSize;
7220   static const int kSize = kCacheStampOffset + kPointerSize;
7221
7222  private:
7223   inline Object* DoGetField(FieldIndex index);
7224
7225   Object* GetUTCField(FieldIndex index, double value, DateCache* date_cache);
7226
7227   // Computes and caches the cacheable fields of the date.
7228   inline void SetCachedFields(int64_t local_time_ms, DateCache* date_cache);
7229
7230
7231   DISALLOW_IMPLICIT_CONSTRUCTORS(JSDate);
7232 };
7233
7234
7235 // Representation of message objects used for error reporting through
7236 // the API. The messages are formatted in JavaScript so this object is
7237 // a real JavaScript object. The information used for formatting the
7238 // error messages are not directly accessible from JavaScript to
7239 // prevent leaking information to user code called during error
7240 // formatting.
7241 class JSMessageObject: public JSObject {
7242  public:
7243   // [type]: the type of error message.
7244   inline int type() const;
7245   inline void set_type(int value);
7246
7247   // [arguments]: the arguments for formatting the error message.
7248   DECL_ACCESSORS(argument, Object)
7249
7250   // [script]: the script from which the error message originated.
7251   DECL_ACCESSORS(script, Object)
7252
7253   // [stack_frames]: an array of stack frames for this error object.
7254   DECL_ACCESSORS(stack_frames, Object)
7255
7256   // [start_position]: the start position in the script for the error message.
7257   inline int start_position() const;
7258   inline void set_start_position(int value);
7259
7260   // [end_position]: the end position in the script for the error message.
7261   inline int end_position() const;
7262   inline void set_end_position(int value);
7263
7264   DECLARE_CAST(JSMessageObject)
7265
7266   // Dispatched behavior.
7267   DECLARE_PRINTER(JSMessageObject)
7268   DECLARE_VERIFIER(JSMessageObject)
7269
7270   // Layout description.
7271   static const int kTypeOffset = JSObject::kHeaderSize;
7272   static const int kArgumentsOffset = kTypeOffset + kPointerSize;
7273   static const int kScriptOffset = kArgumentsOffset + kPointerSize;
7274   static const int kStackFramesOffset = kScriptOffset + kPointerSize;
7275   static const int kStartPositionOffset = kStackFramesOffset + kPointerSize;
7276   static const int kEndPositionOffset = kStartPositionOffset + kPointerSize;
7277   static const int kSize = kEndPositionOffset + kPointerSize;
7278
7279   typedef FixedBodyDescriptor<HeapObject::kMapOffset,
7280                               kStackFramesOffset + kPointerSize,
7281                               kSize> BodyDescriptor;
7282 };
7283
7284
7285 // Regular expressions
7286 // The regular expression holds a single reference to a FixedArray in
7287 // the kDataOffset field.
7288 // The FixedArray contains the following data:
7289 // - tag : type of regexp implementation (not compiled yet, atom or irregexp)
7290 // - reference to the original source string
7291 // - reference to the original flag string
7292 // If it is an atom regexp
7293 // - a reference to a literal string to search for
7294 // If it is an irregexp regexp:
7295 // - a reference to code for Latin1 inputs (bytecode or compiled), or a smi
7296 // used for tracking the last usage (used for code flushing).
7297 // - a reference to code for UC16 inputs (bytecode or compiled), or a smi
7298 // used for tracking the last usage (used for code flushing)..
7299 // - max number of registers used by irregexp implementations.
7300 // - number of capture registers (output values) of the regexp.
7301 class JSRegExp: public JSObject {
7302  public:
7303   // Meaning of Type:
7304   // NOT_COMPILED: Initial value. No data has been stored in the JSRegExp yet.
7305   // ATOM: A simple string to match against using an indexOf operation.
7306   // IRREGEXP: Compiled with Irregexp.
7307   // IRREGEXP_NATIVE: Compiled to native code with Irregexp.
7308   enum Type { NOT_COMPILED, ATOM, IRREGEXP };
7309   enum Flag {
7310     NONE = 0,
7311     GLOBAL = 1,
7312     IGNORE_CASE = 2,
7313     MULTILINE = 4,
7314     STICKY = 8,
7315     UNICODE_ESCAPES = 16
7316   };
7317
7318   class Flags {
7319    public:
7320     explicit Flags(uint32_t value) : value_(value) { }
7321     bool is_global() { return (value_ & GLOBAL) != 0; }
7322     bool is_ignore_case() { return (value_ & IGNORE_CASE) != 0; }
7323     bool is_multiline() { return (value_ & MULTILINE) != 0; }
7324     bool is_sticky() { return (value_ & STICKY) != 0; }
7325     bool is_unicode() { return (value_ & UNICODE_ESCAPES) != 0; }
7326     uint32_t value() { return value_; }
7327    private:
7328     uint32_t value_;
7329   };
7330
7331   DECL_ACCESSORS(data, Object)
7332
7333   inline Type TypeTag();
7334   inline int CaptureCount();
7335   inline Flags GetFlags();
7336   inline String* Pattern();
7337   inline Object* DataAt(int index);
7338   // Set implementation data after the object has been prepared.
7339   inline void SetDataAt(int index, Object* value);
7340
7341   static int code_index(bool is_latin1) {
7342     if (is_latin1) {
7343       return kIrregexpLatin1CodeIndex;
7344     } else {
7345       return kIrregexpUC16CodeIndex;
7346     }
7347   }
7348
7349   static int saved_code_index(bool is_latin1) {
7350     if (is_latin1) {
7351       return kIrregexpLatin1CodeSavedIndex;
7352     } else {
7353       return kIrregexpUC16CodeSavedIndex;
7354     }
7355   }
7356
7357   DECLARE_CAST(JSRegExp)
7358
7359   // Dispatched behavior.
7360   DECLARE_VERIFIER(JSRegExp)
7361
7362   static const int kDataOffset = JSObject::kHeaderSize;
7363   static const int kSize = kDataOffset + kPointerSize;
7364
7365   // Indices in the data array.
7366   static const int kTagIndex = 0;
7367   static const int kSourceIndex = kTagIndex + 1;
7368   static const int kFlagsIndex = kSourceIndex + 1;
7369   static const int kDataIndex = kFlagsIndex + 1;
7370   // The data fields are used in different ways depending on the
7371   // value of the tag.
7372   // Atom regexps (literal strings).
7373   static const int kAtomPatternIndex = kDataIndex;
7374
7375   static const int kAtomDataSize = kAtomPatternIndex + 1;
7376
7377   // Irregexp compiled code or bytecode for Latin1. If compilation
7378   // fails, this fields hold an exception object that should be
7379   // thrown if the regexp is used again.
7380   static const int kIrregexpLatin1CodeIndex = kDataIndex;
7381   // Irregexp compiled code or bytecode for UC16.  If compilation
7382   // fails, this fields hold an exception object that should be
7383   // thrown if the regexp is used again.
7384   static const int kIrregexpUC16CodeIndex = kDataIndex + 1;
7385
7386   // Saved instance of Irregexp compiled code or bytecode for Latin1 that
7387   // is a potential candidate for flushing.
7388   static const int kIrregexpLatin1CodeSavedIndex = kDataIndex + 2;
7389   // Saved instance of Irregexp compiled code or bytecode for UC16 that is
7390   // a potential candidate for flushing.
7391   static const int kIrregexpUC16CodeSavedIndex = kDataIndex + 3;
7392
7393   // Maximal number of registers used by either Latin1 or UC16.
7394   // Only used to check that there is enough stack space
7395   static const int kIrregexpMaxRegisterCountIndex = kDataIndex + 4;
7396   // Number of captures in the compiled regexp.
7397   static const int kIrregexpCaptureCountIndex = kDataIndex + 5;
7398
7399   static const int kIrregexpDataSize = kIrregexpCaptureCountIndex + 1;
7400
7401   // Offsets directly into the data fixed array.
7402   static const int kDataTagOffset =
7403       FixedArray::kHeaderSize + kTagIndex * kPointerSize;
7404   static const int kDataOneByteCodeOffset =
7405       FixedArray::kHeaderSize + kIrregexpLatin1CodeIndex * kPointerSize;
7406   static const int kDataUC16CodeOffset =
7407       FixedArray::kHeaderSize + kIrregexpUC16CodeIndex * kPointerSize;
7408   static const int kIrregexpCaptureCountOffset =
7409       FixedArray::kHeaderSize + kIrregexpCaptureCountIndex * kPointerSize;
7410
7411   // In-object fields.
7412   static const int kSourceFieldIndex = 0;
7413   static const int kGlobalFieldIndex = 1;
7414   static const int kIgnoreCaseFieldIndex = 2;
7415   static const int kMultilineFieldIndex = 3;
7416   static const int kLastIndexFieldIndex = 4;
7417   static const int kInObjectFieldCount = 5;
7418
7419   // The uninitialized value for a regexp code object.
7420   static const int kUninitializedValue = -1;
7421
7422   // The compilation error value for the regexp code object. The real error
7423   // object is in the saved code field.
7424   static const int kCompilationErrorValue = -2;
7425
7426   // When we store the sweep generation at which we moved the code from the
7427   // code index to the saved code index we mask it of to be in the [0:255]
7428   // range.
7429   static const int kCodeAgeMask = 0xff;
7430 };
7431
7432
7433 class CompilationCacheShape : public BaseShape<HashTableKey*> {
7434  public:
7435   static inline bool IsMatch(HashTableKey* key, Object* value) {
7436     return key->IsMatch(value);
7437   }
7438
7439   static inline uint32_t Hash(HashTableKey* key) {
7440     return key->Hash();
7441   }
7442
7443   static inline uint32_t HashForObject(HashTableKey* key, Object* object) {
7444     return key->HashForObject(object);
7445   }
7446
7447   static inline Handle<Object> AsHandle(Isolate* isolate, HashTableKey* key);
7448
7449   static const int kPrefixSize = 0;
7450   static const int kEntrySize = 2;
7451 };
7452
7453
7454 // This cache is used in two different variants. For regexp caching, it simply
7455 // maps identifying info of the regexp to the cached regexp object. Scripts and
7456 // eval code only gets cached after a second probe for the code object. To do
7457 // so, on first "put" only a hash identifying the source is entered into the
7458 // cache, mapping it to a lifetime count of the hash. On each call to Age all
7459 // such lifetimes get reduced, and removed once they reach zero. If a second put
7460 // is called while such a hash is live in the cache, the hash gets replaced by
7461 // an actual cache entry. Age also removes stale live entries from the cache.
7462 // Such entries are identified by SharedFunctionInfos pointing to either the
7463 // recompilation stub, or to "old" code. This avoids memory leaks due to
7464 // premature caching of scripts and eval strings that are never needed later.
7465 class CompilationCacheTable: public HashTable<CompilationCacheTable,
7466                                               CompilationCacheShape,
7467                                               HashTableKey*> {
7468  public:
7469   // Find cached value for a string key, otherwise return null.
7470   Handle<Object> Lookup(
7471       Handle<String> src, Handle<Context> context, LanguageMode language_mode);
7472   Handle<Object> LookupEval(
7473       Handle<String> src, Handle<SharedFunctionInfo> shared,
7474       LanguageMode language_mode, int scope_position);
7475   Handle<Object> LookupRegExp(Handle<String> source, JSRegExp::Flags flags);
7476   static Handle<CompilationCacheTable> Put(
7477       Handle<CompilationCacheTable> cache, Handle<String> src,
7478       Handle<Context> context, LanguageMode language_mode,
7479       Handle<Object> value);
7480   static Handle<CompilationCacheTable> PutEval(
7481       Handle<CompilationCacheTable> cache, Handle<String> src,
7482       Handle<SharedFunctionInfo> context, Handle<SharedFunctionInfo> value,
7483       int scope_position);
7484   static Handle<CompilationCacheTable> PutRegExp(
7485       Handle<CompilationCacheTable> cache, Handle<String> src,
7486       JSRegExp::Flags flags, Handle<FixedArray> value);
7487   void Remove(Object* value);
7488   void Age();
7489   static const int kHashGenerations = 10;
7490
7491   DECLARE_CAST(CompilationCacheTable)
7492
7493  private:
7494   DISALLOW_IMPLICIT_CONSTRUCTORS(CompilationCacheTable);
7495 };
7496
7497
7498 class CodeCache: public Struct {
7499  public:
7500   DECL_ACCESSORS(default_cache, FixedArray)
7501   DECL_ACCESSORS(normal_type_cache, Object)
7502
7503   // Add the code object to the cache.
7504   static void Update(
7505       Handle<CodeCache> cache, Handle<Name> name, Handle<Code> code);
7506
7507   // Lookup code object in the cache. Returns code object if found and undefined
7508   // if not.
7509   Object* Lookup(Name* name, Code::Flags flags);
7510
7511   // Get the internal index of a code object in the cache. Returns -1 if the
7512   // code object is not in that cache. This index can be used to later call
7513   // RemoveByIndex. The cache cannot be modified between a call to GetIndex and
7514   // RemoveByIndex.
7515   int GetIndex(Object* name, Code* code);
7516
7517   // Remove an object from the cache with the provided internal index.
7518   void RemoveByIndex(Object* name, Code* code, int index);
7519
7520   DECLARE_CAST(CodeCache)
7521
7522   // Dispatched behavior.
7523   DECLARE_PRINTER(CodeCache)
7524   DECLARE_VERIFIER(CodeCache)
7525
7526   static const int kDefaultCacheOffset = HeapObject::kHeaderSize;
7527   static const int kNormalTypeCacheOffset =
7528       kDefaultCacheOffset + kPointerSize;
7529   static const int kSize = kNormalTypeCacheOffset + kPointerSize;
7530
7531  private:
7532   static void UpdateDefaultCache(
7533       Handle<CodeCache> code_cache, Handle<Name> name, Handle<Code> code);
7534   static void UpdateNormalTypeCache(
7535       Handle<CodeCache> code_cache, Handle<Name> name, Handle<Code> code);
7536   Object* LookupDefaultCache(Name* name, Code::Flags flags);
7537   Object* LookupNormalTypeCache(Name* name, Code::Flags flags);
7538
7539   // Code cache layout of the default cache. Elements are alternating name and
7540   // code objects for non normal load/store/call IC's.
7541   static const int kCodeCacheEntrySize = 2;
7542   static const int kCodeCacheEntryNameOffset = 0;
7543   static const int kCodeCacheEntryCodeOffset = 1;
7544
7545   DISALLOW_IMPLICIT_CONSTRUCTORS(CodeCache);
7546 };
7547
7548
7549 class CodeCacheHashTableShape : public BaseShape<HashTableKey*> {
7550  public:
7551   static inline bool IsMatch(HashTableKey* key, Object* value) {
7552     return key->IsMatch(value);
7553   }
7554
7555   static inline uint32_t Hash(HashTableKey* key) {
7556     return key->Hash();
7557   }
7558
7559   static inline uint32_t HashForObject(HashTableKey* key, Object* object) {
7560     return key->HashForObject(object);
7561   }
7562
7563   static inline Handle<Object> AsHandle(Isolate* isolate, HashTableKey* key);
7564
7565   static const int kPrefixSize = 0;
7566   static const int kEntrySize = 2;
7567 };
7568
7569
7570 class CodeCacheHashTable: public HashTable<CodeCacheHashTable,
7571                                            CodeCacheHashTableShape,
7572                                            HashTableKey*> {
7573  public:
7574   Object* Lookup(Name* name, Code::Flags flags);
7575   static Handle<CodeCacheHashTable> Put(
7576       Handle<CodeCacheHashTable> table,
7577       Handle<Name> name,
7578       Handle<Code> code);
7579
7580   int GetIndex(Name* name, Code::Flags flags);
7581   void RemoveByIndex(int index);
7582
7583   DECLARE_CAST(CodeCacheHashTable)
7584
7585   // Initial size of the fixed array backing the hash table.
7586   static const int kInitialSize = 64;
7587
7588  private:
7589   DISALLOW_IMPLICIT_CONSTRUCTORS(CodeCacheHashTable);
7590 };
7591
7592
7593 class PolymorphicCodeCache: public Struct {
7594  public:
7595   DECL_ACCESSORS(cache, Object)
7596
7597   static void Update(Handle<PolymorphicCodeCache> cache,
7598                      MapHandleList* maps,
7599                      Code::Flags flags,
7600                      Handle<Code> code);
7601
7602
7603   // Returns an undefined value if the entry is not found.
7604   Handle<Object> Lookup(MapHandleList* maps, Code::Flags flags);
7605
7606   DECLARE_CAST(PolymorphicCodeCache)
7607
7608   // Dispatched behavior.
7609   DECLARE_PRINTER(PolymorphicCodeCache)
7610   DECLARE_VERIFIER(PolymorphicCodeCache)
7611
7612   static const int kCacheOffset = HeapObject::kHeaderSize;
7613   static const int kSize = kCacheOffset + kPointerSize;
7614
7615  private:
7616   DISALLOW_IMPLICIT_CONSTRUCTORS(PolymorphicCodeCache);
7617 };
7618
7619
7620 class PolymorphicCodeCacheHashTable
7621     : public HashTable<PolymorphicCodeCacheHashTable,
7622                        CodeCacheHashTableShape,
7623                        HashTableKey*> {
7624  public:
7625   Object* Lookup(MapHandleList* maps, int code_kind);
7626
7627   static Handle<PolymorphicCodeCacheHashTable> Put(
7628       Handle<PolymorphicCodeCacheHashTable> hash_table,
7629       MapHandleList* maps,
7630       int code_kind,
7631       Handle<Code> code);
7632
7633   DECLARE_CAST(PolymorphicCodeCacheHashTable)
7634
7635   static const int kInitialSize = 64;
7636  private:
7637   DISALLOW_IMPLICIT_CONSTRUCTORS(PolymorphicCodeCacheHashTable);
7638 };
7639
7640
7641 class TypeFeedbackInfo: public Struct {
7642  public:
7643   inline int ic_total_count();
7644   inline void set_ic_total_count(int count);
7645
7646   inline int ic_with_type_info_count();
7647   inline void change_ic_with_type_info_count(int delta);
7648
7649   inline int ic_generic_count();
7650   inline void change_ic_generic_count(int delta);
7651
7652   inline void initialize_storage();
7653
7654   inline void change_own_type_change_checksum();
7655   inline int own_type_change_checksum();
7656
7657   inline void set_inlined_type_change_checksum(int checksum);
7658   inline bool matches_inlined_type_change_checksum(int checksum);
7659
7660   DECLARE_CAST(TypeFeedbackInfo)
7661
7662   // Dispatched behavior.
7663   DECLARE_PRINTER(TypeFeedbackInfo)
7664   DECLARE_VERIFIER(TypeFeedbackInfo)
7665
7666   static const int kStorage1Offset = HeapObject::kHeaderSize;
7667   static const int kStorage2Offset = kStorage1Offset + kPointerSize;
7668   static const int kStorage3Offset = kStorage2Offset + kPointerSize;
7669   static const int kSize = kStorage3Offset + kPointerSize;
7670
7671  private:
7672   static const int kTypeChangeChecksumBits = 7;
7673
7674   class ICTotalCountField: public BitField<int, 0,
7675       kSmiValueSize - kTypeChangeChecksumBits> {};  // NOLINT
7676   class OwnTypeChangeChecksum: public BitField<int,
7677       kSmiValueSize - kTypeChangeChecksumBits,
7678       kTypeChangeChecksumBits> {};  // NOLINT
7679   class ICsWithTypeInfoCountField: public BitField<int, 0,
7680       kSmiValueSize - kTypeChangeChecksumBits> {};  // NOLINT
7681   class InlinedTypeChangeChecksum: public BitField<int,
7682       kSmiValueSize - kTypeChangeChecksumBits,
7683       kTypeChangeChecksumBits> {};  // NOLINT
7684
7685   DISALLOW_IMPLICIT_CONSTRUCTORS(TypeFeedbackInfo);
7686 };
7687
7688
7689 enum AllocationSiteMode {
7690   DONT_TRACK_ALLOCATION_SITE,
7691   TRACK_ALLOCATION_SITE,
7692   LAST_ALLOCATION_SITE_MODE = TRACK_ALLOCATION_SITE
7693 };
7694
7695
7696 class AllocationSite: public Struct {
7697  public:
7698   static const uint32_t kMaximumArrayBytesToPretransition = 8 * 1024;
7699   static const double kPretenureRatio;
7700   static const int kPretenureMinimumCreated = 100;
7701
7702   // Values for pretenure decision field.
7703   enum PretenureDecision {
7704     kUndecided = 0,
7705     kDontTenure = 1,
7706     kMaybeTenure = 2,
7707     kTenure = 3,
7708     kZombie = 4,
7709     kLastPretenureDecisionValue = kZombie
7710   };
7711
7712   const char* PretenureDecisionName(PretenureDecision decision);
7713
7714   DECL_ACCESSORS(transition_info, Object)
7715   // nested_site threads a list of sites that represent nested literals
7716   // walked in a particular order. So [[1, 2], 1, 2] will have one
7717   // nested_site, but [[1, 2], 3, [4]] will have a list of two.
7718   DECL_ACCESSORS(nested_site, Object)
7719   DECL_ACCESSORS(pretenure_data, Smi)
7720   DECL_ACCESSORS(pretenure_create_count, Smi)
7721   DECL_ACCESSORS(dependent_code, DependentCode)
7722   DECL_ACCESSORS(weak_next, Object)
7723
7724   inline void Initialize();
7725
7726   // This method is expensive, it should only be called for reporting.
7727   bool IsNestedSite();
7728
7729   // transition_info bitfields, for constructed array transition info.
7730   class ElementsKindBits:       public BitField<ElementsKind, 0,  15> {};
7731   class UnusedBits:             public BitField<int,          15, 14> {};
7732   class DoNotInlineBit:         public BitField<bool,         29,  1> {};
7733
7734   // Bitfields for pretenure_data
7735   class MementoFoundCountBits:  public BitField<int,               0, 26> {};
7736   class PretenureDecisionBits:  public BitField<PretenureDecision, 26, 3> {};
7737   class DeoptDependentCodeBit:  public BitField<bool,              29, 1> {};
7738   STATIC_ASSERT(PretenureDecisionBits::kMax >= kLastPretenureDecisionValue);
7739
7740   // Increments the mementos found counter and returns true when the first
7741   // memento was found for a given allocation site.
7742   inline bool IncrementMementoFoundCount();
7743
7744   inline void IncrementMementoCreateCount();
7745
7746   PretenureFlag GetPretenureMode();
7747
7748   void ResetPretenureDecision();
7749
7750   inline PretenureDecision pretenure_decision();
7751   inline void set_pretenure_decision(PretenureDecision decision);
7752
7753   inline bool deopt_dependent_code();
7754   inline void set_deopt_dependent_code(bool deopt);
7755
7756   inline int memento_found_count();
7757   inline void set_memento_found_count(int count);
7758
7759   inline int memento_create_count();
7760   inline void set_memento_create_count(int count);
7761
7762   // The pretenuring decision is made during gc, and the zombie state allows
7763   // us to recognize when an allocation site is just being kept alive because
7764   // a later traversal of new space may discover AllocationMementos that point
7765   // to this AllocationSite.
7766   inline bool IsZombie();
7767
7768   inline bool IsMaybeTenure();
7769
7770   inline void MarkZombie();
7771
7772   inline bool MakePretenureDecision(PretenureDecision current_decision,
7773                                     double ratio,
7774                                     bool maximum_size_scavenge);
7775
7776   inline bool DigestPretenuringFeedback(bool maximum_size_scavenge);
7777
7778   inline ElementsKind GetElementsKind();
7779   inline void SetElementsKind(ElementsKind kind);
7780
7781   inline bool CanInlineCall();
7782   inline void SetDoNotInlineCall();
7783
7784   inline bool SitePointsToLiteral();
7785
7786   static void DigestTransitionFeedback(Handle<AllocationSite> site,
7787                                        ElementsKind to_kind);
7788
7789   DECLARE_PRINTER(AllocationSite)
7790   DECLARE_VERIFIER(AllocationSite)
7791
7792   DECLARE_CAST(AllocationSite)
7793   static inline AllocationSiteMode GetMode(
7794       ElementsKind boilerplate_elements_kind);
7795   static inline AllocationSiteMode GetMode(ElementsKind from, ElementsKind to);
7796   static inline bool CanTrack(InstanceType type);
7797
7798   static const int kTransitionInfoOffset = HeapObject::kHeaderSize;
7799   static const int kNestedSiteOffset = kTransitionInfoOffset + kPointerSize;
7800   static const int kPretenureDataOffset = kNestedSiteOffset + kPointerSize;
7801   static const int kPretenureCreateCountOffset =
7802       kPretenureDataOffset + kPointerSize;
7803   static const int kDependentCodeOffset =
7804       kPretenureCreateCountOffset + kPointerSize;
7805   static const int kWeakNextOffset = kDependentCodeOffset + kPointerSize;
7806   static const int kSize = kWeakNextOffset + kPointerSize;
7807
7808   // During mark compact we need to take special care for the dependent code
7809   // field.
7810   static const int kPointerFieldsBeginOffset = kTransitionInfoOffset;
7811   static const int kPointerFieldsEndOffset = kWeakNextOffset;
7812
7813   // For other visitors, use the fixed body descriptor below.
7814   typedef FixedBodyDescriptor<HeapObject::kHeaderSize,
7815                               kDependentCodeOffset + kPointerSize,
7816                               kSize> BodyDescriptor;
7817
7818  private:
7819   inline bool PretenuringDecisionMade();
7820
7821   DISALLOW_IMPLICIT_CONSTRUCTORS(AllocationSite);
7822 };
7823
7824
7825 class AllocationMemento: public Struct {
7826  public:
7827   static const int kAllocationSiteOffset = HeapObject::kHeaderSize;
7828   static const int kSize = kAllocationSiteOffset + kPointerSize;
7829
7830   DECL_ACCESSORS(allocation_site, Object)
7831
7832   inline bool IsValid();
7833   inline AllocationSite* GetAllocationSite();
7834
7835   DECLARE_PRINTER(AllocationMemento)
7836   DECLARE_VERIFIER(AllocationMemento)
7837
7838   DECLARE_CAST(AllocationMemento)
7839
7840  private:
7841   DISALLOW_IMPLICIT_CONSTRUCTORS(AllocationMemento);
7842 };
7843
7844
7845 // Representation of a slow alias as part of a sloppy arguments objects.
7846 // For fast aliases (if HasSloppyArgumentsElements()):
7847 // - the parameter map contains an index into the context
7848 // - all attributes of the element have default values
7849 // For slow aliases (if HasDictionaryArgumentsElements()):
7850 // - the parameter map contains no fast alias mapping (i.e. the hole)
7851 // - this struct (in the slow backing store) contains an index into the context
7852 // - all attributes are available as part if the property details
7853 class AliasedArgumentsEntry: public Struct {
7854  public:
7855   inline int aliased_context_slot() const;
7856   inline void set_aliased_context_slot(int count);
7857
7858   DECLARE_CAST(AliasedArgumentsEntry)
7859
7860   // Dispatched behavior.
7861   DECLARE_PRINTER(AliasedArgumentsEntry)
7862   DECLARE_VERIFIER(AliasedArgumentsEntry)
7863
7864   static const int kAliasedContextSlot = HeapObject::kHeaderSize;
7865   static const int kSize = kAliasedContextSlot + kPointerSize;
7866
7867  private:
7868   DISALLOW_IMPLICIT_CONSTRUCTORS(AliasedArgumentsEntry);
7869 };
7870
7871
7872 enum AllowNullsFlag {ALLOW_NULLS, DISALLOW_NULLS};
7873 enum RobustnessFlag {ROBUST_STRING_TRAVERSAL, FAST_STRING_TRAVERSAL};
7874
7875
7876 class StringHasher {
7877  public:
7878   explicit inline StringHasher(int length, uint32_t seed);
7879
7880   template <typename schar>
7881   static inline uint32_t HashSequentialString(const schar* chars,
7882                                               int length,
7883                                               uint32_t seed);
7884
7885   // Reads all the data, even for long strings and computes the utf16 length.
7886   static uint32_t ComputeUtf8Hash(Vector<const char> chars,
7887                                   uint32_t seed,
7888                                   int* utf16_length_out);
7889
7890   // Calculated hash value for a string consisting of 1 to
7891   // String::kMaxArrayIndexSize digits with no leading zeros (except "0").
7892   // value is represented decimal value.
7893   static uint32_t MakeArrayIndexHash(uint32_t value, int length);
7894
7895   // No string is allowed to have a hash of zero.  That value is reserved
7896   // for internal properties.  If the hash calculation yields zero then we
7897   // use 27 instead.
7898   static const int kZeroHash = 27;
7899
7900   // Reusable parts of the hashing algorithm.
7901   INLINE(static uint32_t AddCharacterCore(uint32_t running_hash, uint16_t c));
7902   INLINE(static uint32_t GetHashCore(uint32_t running_hash));
7903   INLINE(static uint32_t ComputeRunningHash(uint32_t running_hash,
7904                                             const uc16* chars, int length));
7905   INLINE(static uint32_t ComputeRunningHashOneByte(uint32_t running_hash,
7906                                                    const char* chars,
7907                                                    int length));
7908
7909  protected:
7910   // Returns the value to store in the hash field of a string with
7911   // the given length and contents.
7912   uint32_t GetHashField();
7913   // Returns true if the hash of this string can be computed without
7914   // looking at the contents.
7915   inline bool has_trivial_hash();
7916   // Adds a block of characters to the hash.
7917   template<typename Char>
7918   inline void AddCharacters(const Char* chars, int len);
7919
7920  private:
7921   // Add a character to the hash.
7922   inline void AddCharacter(uint16_t c);
7923   // Update index. Returns true if string is still an index.
7924   inline bool UpdateIndex(uint16_t c);
7925
7926   int length_;
7927   uint32_t raw_running_hash_;
7928   uint32_t array_index_;
7929   bool is_array_index_;
7930   bool is_first_char_;
7931   DISALLOW_COPY_AND_ASSIGN(StringHasher);
7932 };
7933
7934
7935 class IteratingStringHasher : public StringHasher {
7936  public:
7937   static inline uint32_t Hash(String* string, uint32_t seed);
7938   inline void VisitOneByteString(const uint8_t* chars, int length);
7939   inline void VisitTwoByteString(const uint16_t* chars, int length);
7940
7941  private:
7942   inline IteratingStringHasher(int len, uint32_t seed);
7943   void VisitConsString(ConsString* cons_string);
7944   DISALLOW_COPY_AND_ASSIGN(IteratingStringHasher);
7945 };
7946
7947
7948 // The characteristics of a string are stored in its map.  Retrieving these
7949 // few bits of information is moderately expensive, involving two memory
7950 // loads where the second is dependent on the first.  To improve efficiency
7951 // the shape of the string is given its own class so that it can be retrieved
7952 // once and used for several string operations.  A StringShape is small enough
7953 // to be passed by value and is immutable, but be aware that flattening a
7954 // string can potentially alter its shape.  Also be aware that a GC caused by
7955 // something else can alter the shape of a string due to ConsString
7956 // shortcutting.  Keeping these restrictions in mind has proven to be error-
7957 // prone and so we no longer put StringShapes in variables unless there is a
7958 // concrete performance benefit at that particular point in the code.
7959 class StringShape BASE_EMBEDDED {
7960  public:
7961   inline explicit StringShape(const String* s);
7962   inline explicit StringShape(Map* s);
7963   inline explicit StringShape(InstanceType t);
7964   inline bool IsSequential();
7965   inline bool IsExternal();
7966   inline bool IsCons();
7967   inline bool IsSliced();
7968   inline bool IsIndirect();
7969   inline bool IsExternalOneByte();
7970   inline bool IsExternalTwoByte();
7971   inline bool IsSequentialOneByte();
7972   inline bool IsSequentialTwoByte();
7973   inline bool IsInternalized();
7974   inline StringRepresentationTag representation_tag();
7975   inline uint32_t encoding_tag();
7976   inline uint32_t full_representation_tag();
7977   inline uint32_t size_tag();
7978 #ifdef DEBUG
7979   inline uint32_t type() { return type_; }
7980   inline void invalidate() { valid_ = false; }
7981   inline bool valid() { return valid_; }
7982 #else
7983   inline void invalidate() { }
7984 #endif
7985
7986  private:
7987   uint32_t type_;
7988 #ifdef DEBUG
7989   inline void set_valid() { valid_ = true; }
7990   bool valid_;
7991 #else
7992   inline void set_valid() { }
7993 #endif
7994 };
7995
7996
7997 // The Name abstract class captures anything that can be used as a property
7998 // name, i.e., strings and symbols.  All names store a hash value.
7999 class Name: public HeapObject {
8000  public:
8001   // Get and set the hash field of the name.
8002   inline uint32_t hash_field();
8003   inline void set_hash_field(uint32_t value);
8004
8005   // Tells whether the hash code has been computed.
8006   inline bool HasHashCode();
8007
8008   // Returns a hash value used for the property table
8009   inline uint32_t Hash();
8010
8011   // Equality operations.
8012   inline bool Equals(Name* other);
8013   inline static bool Equals(Handle<Name> one, Handle<Name> two);
8014
8015   // Conversion.
8016   inline bool AsArrayIndex(uint32_t* index);
8017
8018   // If the name is private, it can only name own properties.
8019   inline bool IsPrivate();
8020
8021   // If the name is a non-flat string, this method returns a flat version of the
8022   // string. Otherwise it'll just return the input.
8023   static inline Handle<Name> Flatten(Handle<Name> name,
8024                                      PretenureFlag pretenure = NOT_TENURED);
8025
8026   DECLARE_CAST(Name)
8027
8028   DECLARE_PRINTER(Name)
8029 #if TRACE_MAPS
8030   void NameShortPrint();
8031   int NameShortPrint(Vector<char> str);
8032 #endif
8033
8034   // Layout description.
8035   static const int kHashFieldSlot = HeapObject::kHeaderSize;
8036 #if V8_TARGET_LITTLE_ENDIAN || !V8_HOST_ARCH_64_BIT
8037   static const int kHashFieldOffset = kHashFieldSlot;
8038 #else
8039   static const int kHashFieldOffset = kHashFieldSlot + kIntSize;
8040 #endif
8041   static const int kSize = kHashFieldSlot + kPointerSize;
8042
8043   // Mask constant for checking if a name has a computed hash code
8044   // and if it is a string that is an array index.  The least significant bit
8045   // indicates whether a hash code has been computed.  If the hash code has
8046   // been computed the 2nd bit tells whether the string can be used as an
8047   // array index.
8048   static const int kHashNotComputedMask = 1;
8049   static const int kIsNotArrayIndexMask = 1 << 1;
8050   static const int kNofHashBitFields = 2;
8051
8052   // Shift constant retrieving hash code from hash field.
8053   static const int kHashShift = kNofHashBitFields;
8054
8055   // Only these bits are relevant in the hash, since the top two are shifted
8056   // out.
8057   static const uint32_t kHashBitMask = 0xffffffffu >> kHashShift;
8058
8059   // Array index strings this short can keep their index in the hash field.
8060   static const int kMaxCachedArrayIndexLength = 7;
8061
8062   // For strings which are array indexes the hash value has the string length
8063   // mixed into the hash, mainly to avoid a hash value of zero which would be
8064   // the case for the string '0'. 24 bits are used for the array index value.
8065   static const int kArrayIndexValueBits = 24;
8066   static const int kArrayIndexLengthBits =
8067       kBitsPerInt - kArrayIndexValueBits - kNofHashBitFields;
8068
8069   STATIC_ASSERT((kArrayIndexLengthBits > 0));
8070
8071   class ArrayIndexValueBits : public BitField<unsigned int, kNofHashBitFields,
8072       kArrayIndexValueBits> {};  // NOLINT
8073   class ArrayIndexLengthBits : public BitField<unsigned int,
8074       kNofHashBitFields + kArrayIndexValueBits,
8075       kArrayIndexLengthBits> {};  // NOLINT
8076
8077   // Check that kMaxCachedArrayIndexLength + 1 is a power of two so we
8078   // could use a mask to test if the length of string is less than or equal to
8079   // kMaxCachedArrayIndexLength.
8080   STATIC_ASSERT(IS_POWER_OF_TWO(kMaxCachedArrayIndexLength + 1));
8081
8082   static const unsigned int kContainsCachedArrayIndexMask =
8083       (~static_cast<unsigned>(kMaxCachedArrayIndexLength)
8084        << ArrayIndexLengthBits::kShift) |
8085       kIsNotArrayIndexMask;
8086
8087   // Value of empty hash field indicating that the hash is not computed.
8088   static const int kEmptyHashField =
8089       kIsNotArrayIndexMask | kHashNotComputedMask;
8090
8091  protected:
8092   static inline bool IsHashFieldComputed(uint32_t field);
8093
8094  private:
8095   DISALLOW_IMPLICIT_CONSTRUCTORS(Name);
8096 };
8097
8098
8099 // ES6 symbols.
8100 class Symbol: public Name {
8101  public:
8102   // [name]: The print name of a symbol, or undefined if none.
8103   DECL_ACCESSORS(name, Object)
8104
8105   DECL_ACCESSORS(flags, Smi)
8106
8107   // [is_private]: Whether this is a private symbol.  Private symbols can only
8108   // be used to designate own properties of objects.
8109   DECL_BOOLEAN_ACCESSORS(is_private)
8110
8111   DECLARE_CAST(Symbol)
8112
8113   // Dispatched behavior.
8114   DECLARE_PRINTER(Symbol)
8115   DECLARE_VERIFIER(Symbol)
8116
8117   // Layout description.
8118   static const int kNameOffset = Name::kSize;
8119   static const int kFlagsOffset = kNameOffset + kPointerSize;
8120   static const int kSize = kFlagsOffset + kPointerSize;
8121
8122   typedef FixedBodyDescriptor<kNameOffset, kFlagsOffset, kSize> BodyDescriptor;
8123
8124   void SymbolShortPrint(std::ostream& os);
8125
8126  private:
8127   static const int kPrivateBit = 0;
8128
8129   const char* PrivateSymbolToName() const;
8130
8131 #if TRACE_MAPS
8132   friend class Name;  // For PrivateSymbolToName.
8133 #endif
8134
8135   DISALLOW_IMPLICIT_CONSTRUCTORS(Symbol);
8136 };
8137
8138
8139 class ConsString;
8140
8141 // The String abstract class captures JavaScript string values:
8142 //
8143 // Ecma-262:
8144 //  4.3.16 String Value
8145 //    A string value is a member of the type String and is a finite
8146 //    ordered sequence of zero or more 16-bit unsigned integer values.
8147 //
8148 // All string values have a length field.
8149 class String: public Name {
8150  public:
8151   enum Encoding { ONE_BYTE_ENCODING, TWO_BYTE_ENCODING };
8152
8153   // Array index strings this short can keep their index in the hash field.
8154   static const int kMaxCachedArrayIndexLength = 7;
8155
8156   // For strings which are array indexes the hash value has the string length
8157   // mixed into the hash, mainly to avoid a hash value of zero which would be
8158   // the case for the string '0'. 24 bits are used for the array index value.
8159   static const int kArrayIndexValueBits = 24;
8160   static const int kArrayIndexLengthBits =
8161       kBitsPerInt - kArrayIndexValueBits - kNofHashBitFields;
8162
8163   STATIC_ASSERT((kArrayIndexLengthBits > 0));
8164
8165   class ArrayIndexValueBits : public BitField<unsigned int, kNofHashBitFields,
8166       kArrayIndexValueBits> {};  // NOLINT
8167   class ArrayIndexLengthBits : public BitField<unsigned int,
8168       kNofHashBitFields + kArrayIndexValueBits,
8169       kArrayIndexLengthBits> {};  // NOLINT
8170
8171   // Check that kMaxCachedArrayIndexLength + 1 is a power of two so we
8172   // could use a mask to test if the length of string is less than or equal to
8173   // kMaxCachedArrayIndexLength.
8174   STATIC_ASSERT(IS_POWER_OF_TWO(kMaxCachedArrayIndexLength + 1));
8175
8176   static const unsigned int kContainsCachedArrayIndexMask =
8177       (~static_cast<unsigned>(kMaxCachedArrayIndexLength)
8178        << ArrayIndexLengthBits::kShift) |
8179       kIsNotArrayIndexMask;
8180
8181   class SubStringRange {
8182    public:
8183     explicit inline SubStringRange(String* string, int first = 0,
8184                                    int length = -1);
8185     class iterator;
8186     inline iterator begin();
8187     inline iterator end();
8188
8189    private:
8190     String* string_;
8191     int first_;
8192     int length_;
8193   };
8194
8195   // Representation of the flat content of a String.
8196   // A non-flat string doesn't have flat content.
8197   // A flat string has content that's encoded as a sequence of either
8198   // one-byte chars or two-byte UC16.
8199   // Returned by String::GetFlatContent().
8200   class FlatContent {
8201    public:
8202     // Returns true if the string is flat and this structure contains content.
8203     bool IsFlat() { return state_ != NON_FLAT; }
8204     // Returns true if the structure contains one-byte content.
8205     bool IsOneByte() { return state_ == ONE_BYTE; }
8206     // Returns true if the structure contains two-byte content.
8207     bool IsTwoByte() { return state_ == TWO_BYTE; }
8208
8209     // Return the one byte content of the string. Only use if IsOneByte()
8210     // returns true.
8211     Vector<const uint8_t> ToOneByteVector() {
8212       DCHECK_EQ(ONE_BYTE, state_);
8213       return Vector<const uint8_t>(onebyte_start, length_);
8214     }
8215     // Return the two-byte content of the string. Only use if IsTwoByte()
8216     // returns true.
8217     Vector<const uc16> ToUC16Vector() {
8218       DCHECK_EQ(TWO_BYTE, state_);
8219       return Vector<const uc16>(twobyte_start, length_);
8220     }
8221
8222     uc16 Get(int i) {
8223       DCHECK(i < length_);
8224       DCHECK(state_ != NON_FLAT);
8225       if (state_ == ONE_BYTE) return onebyte_start[i];
8226       return twobyte_start[i];
8227     }
8228
8229     bool UsesSameString(const FlatContent& other) const {
8230       return onebyte_start == other.onebyte_start;
8231     }
8232
8233    private:
8234     enum State { NON_FLAT, ONE_BYTE, TWO_BYTE };
8235
8236     // Constructors only used by String::GetFlatContent().
8237     explicit FlatContent(const uint8_t* start, int length)
8238         : onebyte_start(start), length_(length), state_(ONE_BYTE) {}
8239     explicit FlatContent(const uc16* start, int length)
8240         : twobyte_start(start), length_(length), state_(TWO_BYTE) { }
8241     FlatContent() : onebyte_start(NULL), length_(0), state_(NON_FLAT) { }
8242
8243     union {
8244       const uint8_t* onebyte_start;
8245       const uc16* twobyte_start;
8246     };
8247     int length_;
8248     State state_;
8249
8250     friend class String;
8251     friend class IterableSubString;
8252   };
8253
8254   template <typename Char>
8255   INLINE(Vector<const Char> GetCharVector());
8256
8257   // Get and set the length of the string.
8258   inline int length() const;
8259   inline void set_length(int value);
8260
8261   // Get and set the length of the string using acquire loads and release
8262   // stores.
8263   inline int synchronized_length() const;
8264   inline void synchronized_set_length(int value);
8265
8266   // Returns whether this string has only one-byte chars, i.e. all of them can
8267   // be one-byte encoded.  This might be the case even if the string is
8268   // two-byte.  Such strings may appear when the embedder prefers
8269   // two-byte external representations even for one-byte data.
8270   inline bool IsOneByteRepresentation() const;
8271   inline bool IsTwoByteRepresentation() const;
8272
8273   // Cons and slices have an encoding flag that may not represent the actual
8274   // encoding of the underlying string.  This is taken into account here.
8275   // Requires: this->IsFlat()
8276   inline bool IsOneByteRepresentationUnderneath();
8277   inline bool IsTwoByteRepresentationUnderneath();
8278
8279   // NOTE: this should be considered only a hint.  False negatives are
8280   // possible.
8281   inline bool HasOnlyOneByteChars();
8282
8283   // Get and set individual two byte chars in the string.
8284   inline void Set(int index, uint16_t value);
8285   // Get individual two byte char in the string.  Repeated calls
8286   // to this method are not efficient unless the string is flat.
8287   INLINE(uint16_t Get(int index));
8288
8289   // Flattens the string.  Checks first inline to see if it is
8290   // necessary.  Does nothing if the string is not a cons string.
8291   // Flattening allocates a sequential string with the same data as
8292   // the given string and mutates the cons string to a degenerate
8293   // form, where the first component is the new sequential string and
8294   // the second component is the empty string.  If allocation fails,
8295   // this function returns a failure.  If flattening succeeds, this
8296   // function returns the sequential string that is now the first
8297   // component of the cons string.
8298   //
8299   // Degenerate cons strings are handled specially by the garbage
8300   // collector (see IsShortcutCandidate).
8301
8302   static inline Handle<String> Flatten(Handle<String> string,
8303                                        PretenureFlag pretenure = NOT_TENURED);
8304
8305   // Tries to return the content of a flat string as a structure holding either
8306   // a flat vector of char or of uc16.
8307   // If the string isn't flat, and therefore doesn't have flat content, the
8308   // returned structure will report so, and can't provide a vector of either
8309   // kind.
8310   FlatContent GetFlatContent();
8311
8312   // Returns the parent of a sliced string or first part of a flat cons string.
8313   // Requires: StringShape(this).IsIndirect() && this->IsFlat()
8314   inline String* GetUnderlying();
8315
8316   // String equality operations.
8317   inline bool Equals(String* other);
8318   inline static bool Equals(Handle<String> one, Handle<String> two);
8319   bool IsUtf8EqualTo(Vector<const char> str, bool allow_prefix_match = false);
8320   bool IsOneByteEqualTo(Vector<const uint8_t> str);
8321   bool IsTwoByteEqualTo(Vector<const uc16> str);
8322
8323   // Return a UTF8 representation of the string.  The string is null
8324   // terminated but may optionally contain nulls.  Length is returned
8325   // in length_output if length_output is not a null pointer  The string
8326   // should be nearly flat, otherwise the performance of this method may
8327   // be very slow (quadratic in the length).  Setting robustness_flag to
8328   // ROBUST_STRING_TRAVERSAL invokes behaviour that is robust  This means it
8329   // handles unexpected data without causing assert failures and it does not
8330   // do any heap allocations.  This is useful when printing stack traces.
8331   base::SmartArrayPointer<char> ToCString(AllowNullsFlag allow_nulls,
8332                                           RobustnessFlag robustness_flag,
8333                                           int offset, int length,
8334                                           int* length_output = 0);
8335   base::SmartArrayPointer<char> ToCString(
8336       AllowNullsFlag allow_nulls = DISALLOW_NULLS,
8337       RobustnessFlag robustness_flag = FAST_STRING_TRAVERSAL,
8338       int* length_output = 0);
8339
8340   // Return a 16 bit Unicode representation of the string.
8341   // The string should be nearly flat, otherwise the performance of
8342   // of this method may be very bad.  Setting robustness_flag to
8343   // ROBUST_STRING_TRAVERSAL invokes behaviour that is robust  This means it
8344   // handles unexpected data without causing assert failures and it does not
8345   // do any heap allocations.  This is useful when printing stack traces.
8346   base::SmartArrayPointer<uc16> ToWideCString(
8347       RobustnessFlag robustness_flag = FAST_STRING_TRAVERSAL);
8348
8349   bool ComputeArrayIndex(uint32_t* index);
8350
8351   // Externalization.
8352   bool MakeExternal(v8::String::ExternalStringResource* resource);
8353   bool MakeExternal(v8::String::ExternalOneByteStringResource* resource);
8354
8355   // Conversion.
8356   inline bool AsArrayIndex(uint32_t* index);
8357
8358   DECLARE_CAST(String)
8359
8360   void PrintOn(FILE* out);
8361
8362   // For use during stack traces.  Performs rudimentary sanity check.
8363   bool LooksValid();
8364
8365   // Dispatched behavior.
8366   void StringShortPrint(StringStream* accumulator);
8367   void PrintUC16(std::ostream& os, int start = 0, int end = -1);  // NOLINT
8368 #if defined(DEBUG) || defined(OBJECT_PRINT)
8369   char* ToAsciiArray();
8370 #endif
8371   DECLARE_PRINTER(String)
8372   DECLARE_VERIFIER(String)
8373
8374   inline bool IsFlat();
8375
8376   // Layout description.
8377   static const int kLengthOffset = Name::kSize;
8378   static const int kSize = kLengthOffset + kPointerSize;
8379
8380   // Maximum number of characters to consider when trying to convert a string
8381   // value into an array index.
8382   static const int kMaxArrayIndexSize = 10;
8383   STATIC_ASSERT(kMaxArrayIndexSize < (1 << kArrayIndexLengthBits));
8384
8385   // Max char codes.
8386   static const int32_t kMaxOneByteCharCode = unibrow::Latin1::kMaxChar;
8387   static const uint32_t kMaxOneByteCharCodeU = unibrow::Latin1::kMaxChar;
8388   static const int kMaxUtf16CodeUnit = 0xffff;
8389   static const uint32_t kMaxUtf16CodeUnitU = kMaxUtf16CodeUnit;
8390
8391   // Value of hash field containing computed hash equal to zero.
8392   static const int kEmptyStringHash = kIsNotArrayIndexMask;
8393
8394   // Maximal string length.
8395   static const int kMaxLength = (1 << 28) - 16;
8396
8397   // Max length for computing hash. For strings longer than this limit the
8398   // string length is used as the hash value.
8399   static const int kMaxHashCalcLength = 16383;
8400
8401   // Limit for truncation in short printing.
8402   static const int kMaxShortPrintLength = 1024;
8403
8404   // Support for regular expressions.
8405   const uc16* GetTwoByteData(unsigned start);
8406
8407   // Helper function for flattening strings.
8408   template <typename sinkchar>
8409   static void WriteToFlat(String* source,
8410                           sinkchar* sink,
8411                           int from,
8412                           int to);
8413
8414   // The return value may point to the first aligned word containing the first
8415   // non-one-byte character, rather than directly to the non-one-byte character.
8416   // If the return value is >= the passed length, the entire string was
8417   // one-byte.
8418   static inline int NonAsciiStart(const char* chars, int length) {
8419     const char* start = chars;
8420     const char* limit = chars + length;
8421
8422     if (length >= kIntptrSize) {
8423       // Check unaligned bytes.
8424       while (!IsAligned(reinterpret_cast<intptr_t>(chars), sizeof(uintptr_t))) {
8425         if (static_cast<uint8_t>(*chars) > unibrow::Utf8::kMaxOneByteChar) {
8426           return static_cast<int>(chars - start);
8427         }
8428         ++chars;
8429       }
8430       // Check aligned words.
8431       DCHECK(unibrow::Utf8::kMaxOneByteChar == 0x7F);
8432       const uintptr_t non_one_byte_mask = kUintptrAllBitsSet / 0xFF * 0x80;
8433       while (chars + sizeof(uintptr_t) <= limit) {
8434         if (*reinterpret_cast<const uintptr_t*>(chars) & non_one_byte_mask) {
8435           return static_cast<int>(chars - start);
8436         }
8437         chars += sizeof(uintptr_t);
8438       }
8439     }
8440     // Check remaining unaligned bytes.
8441     while (chars < limit) {
8442       if (static_cast<uint8_t>(*chars) > unibrow::Utf8::kMaxOneByteChar) {
8443         return static_cast<int>(chars - start);
8444       }
8445       ++chars;
8446     }
8447
8448     return static_cast<int>(chars - start);
8449   }
8450
8451   static inline bool IsAscii(const char* chars, int length) {
8452     return NonAsciiStart(chars, length) >= length;
8453   }
8454
8455   static inline bool IsAscii(const uint8_t* chars, int length) {
8456     return
8457         NonAsciiStart(reinterpret_cast<const char*>(chars), length) >= length;
8458   }
8459
8460   static inline int NonOneByteStart(const uc16* chars, int length) {
8461     const uc16* limit = chars + length;
8462     const uc16* start = chars;
8463     while (chars < limit) {
8464       if (*chars > kMaxOneByteCharCodeU) return static_cast<int>(chars - start);
8465       ++chars;
8466     }
8467     return static_cast<int>(chars - start);
8468   }
8469
8470   static inline bool IsOneByte(const uc16* chars, int length) {
8471     return NonOneByteStart(chars, length) >= length;
8472   }
8473
8474   template<class Visitor>
8475   static inline ConsString* VisitFlat(Visitor* visitor,
8476                                       String* string,
8477                                       int offset = 0);
8478
8479   static Handle<FixedArray> CalculateLineEnds(Handle<String> string,
8480                                               bool include_ending_line);
8481
8482   // Use the hash field to forward to the canonical internalized string
8483   // when deserializing an internalized string.
8484   inline void SetForwardedInternalizedString(String* string);
8485   inline String* GetForwardedInternalizedString();
8486
8487  private:
8488   friend class Name;
8489   friend class StringTableInsertionKey;
8490
8491   static Handle<String> SlowFlatten(Handle<ConsString> cons,
8492                                     PretenureFlag tenure);
8493
8494   // Slow case of String::Equals.  This implementation works on any strings
8495   // but it is most efficient on strings that are almost flat.
8496   bool SlowEquals(String* other);
8497
8498   static bool SlowEquals(Handle<String> one, Handle<String> two);
8499
8500   // Slow case of AsArrayIndex.
8501   bool SlowAsArrayIndex(uint32_t* index);
8502
8503   // Compute and set the hash code.
8504   uint32_t ComputeAndSetHash();
8505
8506   DISALLOW_IMPLICIT_CONSTRUCTORS(String);
8507 };
8508
8509
8510 // The SeqString abstract class captures sequential string values.
8511 class SeqString: public String {
8512  public:
8513   DECLARE_CAST(SeqString)
8514
8515   // Layout description.
8516   static const int kHeaderSize = String::kSize;
8517
8518   // Truncate the string in-place if possible and return the result.
8519   // In case of new_length == 0, the empty string is returned without
8520   // truncating the original string.
8521   MUST_USE_RESULT static Handle<String> Truncate(Handle<SeqString> string,
8522                                                  int new_length);
8523  private:
8524   DISALLOW_IMPLICIT_CONSTRUCTORS(SeqString);
8525 };
8526
8527
8528 // The OneByteString class captures sequential one-byte string objects.
8529 // Each character in the OneByteString is an one-byte character.
8530 class SeqOneByteString: public SeqString {
8531  public:
8532   static const bool kHasOneByteEncoding = true;
8533
8534   // Dispatched behavior.
8535   inline uint16_t SeqOneByteStringGet(int index);
8536   inline void SeqOneByteStringSet(int index, uint16_t value);
8537
8538   // Get the address of the characters in this string.
8539   inline Address GetCharsAddress();
8540
8541   inline uint8_t* GetChars();
8542
8543   DECLARE_CAST(SeqOneByteString)
8544
8545   // Garbage collection support.  This method is called by the
8546   // garbage collector to compute the actual size of an OneByteString
8547   // instance.
8548   inline int SeqOneByteStringSize(InstanceType instance_type);
8549
8550   // Computes the size for an OneByteString instance of a given length.
8551   static int SizeFor(int length) {
8552     return OBJECT_POINTER_ALIGN(kHeaderSize + length * kCharSize);
8553   }
8554
8555   // Maximal memory usage for a single sequential one-byte string.
8556   static const int kMaxSize = 512 * MB - 1;
8557   STATIC_ASSERT((kMaxSize - kHeaderSize) >= String::kMaxLength);
8558
8559  private:
8560   DISALLOW_IMPLICIT_CONSTRUCTORS(SeqOneByteString);
8561 };
8562
8563
8564 // The TwoByteString class captures sequential unicode string objects.
8565 // Each character in the TwoByteString is a two-byte uint16_t.
8566 class SeqTwoByteString: public SeqString {
8567  public:
8568   static const bool kHasOneByteEncoding = false;
8569
8570   // Dispatched behavior.
8571   inline uint16_t SeqTwoByteStringGet(int index);
8572   inline void SeqTwoByteStringSet(int index, uint16_t value);
8573
8574   // Get the address of the characters in this string.
8575   inline Address GetCharsAddress();
8576
8577   inline uc16* GetChars();
8578
8579   // For regexp code.
8580   const uint16_t* SeqTwoByteStringGetData(unsigned start);
8581
8582   DECLARE_CAST(SeqTwoByteString)
8583
8584   // Garbage collection support.  This method is called by the
8585   // garbage collector to compute the actual size of a TwoByteString
8586   // instance.
8587   inline int SeqTwoByteStringSize(InstanceType instance_type);
8588
8589   // Computes the size for a TwoByteString instance of a given length.
8590   static int SizeFor(int length) {
8591     return OBJECT_POINTER_ALIGN(kHeaderSize + length * kShortSize);
8592   }
8593
8594   // Maximal memory usage for a single sequential two-byte string.
8595   static const int kMaxSize = 512 * MB - 1;
8596   STATIC_ASSERT(static_cast<int>((kMaxSize - kHeaderSize)/sizeof(uint16_t)) >=
8597                String::kMaxLength);
8598
8599  private:
8600   DISALLOW_IMPLICIT_CONSTRUCTORS(SeqTwoByteString);
8601 };
8602
8603
8604 // The ConsString class describes string values built by using the
8605 // addition operator on strings.  A ConsString is a pair where the
8606 // first and second components are pointers to other string values.
8607 // One or both components of a ConsString can be pointers to other
8608 // ConsStrings, creating a binary tree of ConsStrings where the leaves
8609 // are non-ConsString string values.  The string value represented by
8610 // a ConsString can be obtained by concatenating the leaf string
8611 // values in a left-to-right depth-first traversal of the tree.
8612 class ConsString: public String {
8613  public:
8614   // First string of the cons cell.
8615   inline String* first();
8616   // Doesn't check that the result is a string, even in debug mode.  This is
8617   // useful during GC where the mark bits confuse the checks.
8618   inline Object* unchecked_first();
8619   inline void set_first(String* first,
8620                         WriteBarrierMode mode = UPDATE_WRITE_BARRIER);
8621
8622   // Second string of the cons cell.
8623   inline String* second();
8624   // Doesn't check that the result is a string, even in debug mode.  This is
8625   // useful during GC where the mark bits confuse the checks.
8626   inline Object* unchecked_second();
8627   inline void set_second(String* second,
8628                          WriteBarrierMode mode = UPDATE_WRITE_BARRIER);
8629
8630   // Dispatched behavior.
8631   uint16_t ConsStringGet(int index);
8632
8633   DECLARE_CAST(ConsString)
8634
8635   // Layout description.
8636   static const int kFirstOffset = POINTER_SIZE_ALIGN(String::kSize);
8637   static const int kSecondOffset = kFirstOffset + kPointerSize;
8638   static const int kSize = kSecondOffset + kPointerSize;
8639
8640   // Minimum length for a cons string.
8641   static const int kMinLength = 13;
8642
8643   typedef FixedBodyDescriptor<kFirstOffset, kSecondOffset + kPointerSize, kSize>
8644           BodyDescriptor;
8645
8646   DECLARE_VERIFIER(ConsString)
8647
8648  private:
8649   DISALLOW_IMPLICIT_CONSTRUCTORS(ConsString);
8650 };
8651
8652
8653 // The Sliced String class describes strings that are substrings of another
8654 // sequential string.  The motivation is to save time and memory when creating
8655 // a substring.  A Sliced String is described as a pointer to the parent,
8656 // the offset from the start of the parent string and the length.  Using
8657 // a Sliced String therefore requires unpacking of the parent string and
8658 // adding the offset to the start address.  A substring of a Sliced String
8659 // are not nested since the double indirection is simplified when creating
8660 // such a substring.
8661 // Currently missing features are:
8662 //  - handling externalized parent strings
8663 //  - external strings as parent
8664 //  - truncating sliced string to enable otherwise unneeded parent to be GC'ed.
8665 class SlicedString: public String {
8666  public:
8667   inline String* parent();
8668   inline void set_parent(String* parent,
8669                          WriteBarrierMode mode = UPDATE_WRITE_BARRIER);
8670   inline int offset() const;
8671   inline void set_offset(int offset);
8672
8673   // Dispatched behavior.
8674   uint16_t SlicedStringGet(int index);
8675
8676   DECLARE_CAST(SlicedString)
8677
8678   // Layout description.
8679   static const int kParentOffset = POINTER_SIZE_ALIGN(String::kSize);
8680   static const int kOffsetOffset = kParentOffset + kPointerSize;
8681   static const int kSize = kOffsetOffset + kPointerSize;
8682
8683   // Minimum length for a sliced string.
8684   static const int kMinLength = 13;
8685
8686   typedef FixedBodyDescriptor<kParentOffset,
8687                               kOffsetOffset + kPointerSize, kSize>
8688           BodyDescriptor;
8689
8690   DECLARE_VERIFIER(SlicedString)
8691
8692  private:
8693   DISALLOW_IMPLICIT_CONSTRUCTORS(SlicedString);
8694 };
8695
8696
8697 // The ExternalString class describes string values that are backed by
8698 // a string resource that lies outside the V8 heap.  ExternalStrings
8699 // consist of the length field common to all strings, a pointer to the
8700 // external resource.  It is important to ensure (externally) that the
8701 // resource is not deallocated while the ExternalString is live in the
8702 // V8 heap.
8703 //
8704 // The API expects that all ExternalStrings are created through the
8705 // API.  Therefore, ExternalStrings should not be used internally.
8706 class ExternalString: public String {
8707  public:
8708   DECLARE_CAST(ExternalString)
8709
8710   // Layout description.
8711   static const int kResourceOffset = POINTER_SIZE_ALIGN(String::kSize);
8712   static const int kShortSize = kResourceOffset + kPointerSize;
8713   static const int kResourceDataOffset = kResourceOffset + kPointerSize;
8714   static const int kSize = kResourceDataOffset + kPointerSize;
8715
8716   static const int kMaxShortLength =
8717       (kShortSize - SeqString::kHeaderSize) / kCharSize;
8718
8719   // Return whether external string is short (data pointer is not cached).
8720   inline bool is_short();
8721
8722   STATIC_ASSERT(kResourceOffset == Internals::kStringResourceOffset);
8723
8724  private:
8725   DISALLOW_IMPLICIT_CONSTRUCTORS(ExternalString);
8726 };
8727
8728
8729 // The ExternalOneByteString class is an external string backed by an
8730 // one-byte string.
8731 class ExternalOneByteString : public ExternalString {
8732  public:
8733   static const bool kHasOneByteEncoding = true;
8734
8735   typedef v8::String::ExternalOneByteStringResource Resource;
8736
8737   // The underlying resource.
8738   inline const Resource* resource();
8739   inline void set_resource(const Resource* buffer);
8740
8741   // Update the pointer cache to the external character array.
8742   // The cached pointer is always valid, as the external character array does =
8743   // not move during lifetime.  Deserialization is the only exception, after
8744   // which the pointer cache has to be refreshed.
8745   inline void update_data_cache();
8746
8747   inline const uint8_t* GetChars();
8748
8749   // Dispatched behavior.
8750   inline uint16_t ExternalOneByteStringGet(int index);
8751
8752   DECLARE_CAST(ExternalOneByteString)
8753
8754   // Garbage collection support.
8755   inline void ExternalOneByteStringIterateBody(ObjectVisitor* v);
8756
8757   template <typename StaticVisitor>
8758   inline void ExternalOneByteStringIterateBody();
8759
8760  private:
8761   DISALLOW_IMPLICIT_CONSTRUCTORS(ExternalOneByteString);
8762 };
8763
8764
8765 // The ExternalTwoByteString class is an external string backed by a UTF-16
8766 // encoded string.
8767 class ExternalTwoByteString: public ExternalString {
8768  public:
8769   static const bool kHasOneByteEncoding = false;
8770
8771   typedef v8::String::ExternalStringResource Resource;
8772
8773   // The underlying string resource.
8774   inline const Resource* resource();
8775   inline void set_resource(const Resource* buffer);
8776
8777   // Update the pointer cache to the external character array.
8778   // The cached pointer is always valid, as the external character array does =
8779   // not move during lifetime.  Deserialization is the only exception, after
8780   // which the pointer cache has to be refreshed.
8781   inline void update_data_cache();
8782
8783   inline const uint16_t* GetChars();
8784
8785   // Dispatched behavior.
8786   inline uint16_t ExternalTwoByteStringGet(int index);
8787
8788   // For regexp code.
8789   inline const uint16_t* ExternalTwoByteStringGetData(unsigned start);
8790
8791   DECLARE_CAST(ExternalTwoByteString)
8792
8793   // Garbage collection support.
8794   inline void ExternalTwoByteStringIterateBody(ObjectVisitor* v);
8795
8796   template<typename StaticVisitor>
8797   inline void ExternalTwoByteStringIterateBody();
8798
8799  private:
8800   DISALLOW_IMPLICIT_CONSTRUCTORS(ExternalTwoByteString);
8801 };
8802
8803
8804 // Utility superclass for stack-allocated objects that must be updated
8805 // on gc.  It provides two ways for the gc to update instances, either
8806 // iterating or updating after gc.
8807 class Relocatable BASE_EMBEDDED {
8808  public:
8809   explicit inline Relocatable(Isolate* isolate);
8810   inline virtual ~Relocatable();
8811   virtual void IterateInstance(ObjectVisitor* v) { }
8812   virtual void PostGarbageCollection() { }
8813
8814   static void PostGarbageCollectionProcessing(Isolate* isolate);
8815   static int ArchiveSpacePerThread();
8816   static char* ArchiveState(Isolate* isolate, char* to);
8817   static char* RestoreState(Isolate* isolate, char* from);
8818   static void Iterate(Isolate* isolate, ObjectVisitor* v);
8819   static void Iterate(ObjectVisitor* v, Relocatable* top);
8820   static char* Iterate(ObjectVisitor* v, char* t);
8821
8822  private:
8823   Isolate* isolate_;
8824   Relocatable* prev_;
8825 };
8826
8827
8828 // A flat string reader provides random access to the contents of a
8829 // string independent of the character width of the string.  The handle
8830 // must be valid as long as the reader is being used.
8831 class FlatStringReader : public Relocatable {
8832  public:
8833   FlatStringReader(Isolate* isolate, Handle<String> str);
8834   FlatStringReader(Isolate* isolate, Vector<const char> input);
8835   void PostGarbageCollection();
8836   inline uc32 Get(int index);
8837   template <typename Char>
8838   inline Char Get(int index);
8839   int length() { return length_; }
8840  private:
8841   String** str_;
8842   bool is_one_byte_;
8843   int length_;
8844   const void* start_;
8845 };
8846
8847
8848 // This maintains an off-stack representation of the stack frames required
8849 // to traverse a ConsString, allowing an entirely iterative and restartable
8850 // traversal of the entire string
8851 class ConsStringIterator {
8852  public:
8853   inline ConsStringIterator() {}
8854   inline explicit ConsStringIterator(ConsString* cons_string, int offset = 0) {
8855     Reset(cons_string, offset);
8856   }
8857   inline void Reset(ConsString* cons_string, int offset = 0) {
8858     depth_ = 0;
8859     // Next will always return NULL.
8860     if (cons_string == NULL) return;
8861     Initialize(cons_string, offset);
8862   }
8863   // Returns NULL when complete.
8864   inline String* Next(int* offset_out) {
8865     *offset_out = 0;
8866     if (depth_ == 0) return NULL;
8867     return Continue(offset_out);
8868   }
8869
8870  private:
8871   static const int kStackSize = 32;
8872   // Use a mask instead of doing modulo operations for stack wrapping.
8873   static const int kDepthMask = kStackSize-1;
8874   STATIC_ASSERT(IS_POWER_OF_TWO(kStackSize));
8875   static inline int OffsetForDepth(int depth);
8876
8877   inline void PushLeft(ConsString* string);
8878   inline void PushRight(ConsString* string);
8879   inline void AdjustMaximumDepth();
8880   inline void Pop();
8881   inline bool StackBlown() { return maximum_depth_ - depth_ == kStackSize; }
8882   void Initialize(ConsString* cons_string, int offset);
8883   String* Continue(int* offset_out);
8884   String* NextLeaf(bool* blew_stack);
8885   String* Search(int* offset_out);
8886
8887   // Stack must always contain only frames for which right traversal
8888   // has not yet been performed.
8889   ConsString* frames_[kStackSize];
8890   ConsString* root_;
8891   int depth_;
8892   int maximum_depth_;
8893   int consumed_;
8894   DISALLOW_COPY_AND_ASSIGN(ConsStringIterator);
8895 };
8896
8897
8898 class StringCharacterStream {
8899  public:
8900   inline StringCharacterStream(String* string,
8901                                int offset = 0);
8902   inline uint16_t GetNext();
8903   inline bool HasMore();
8904   inline void Reset(String* string, int offset = 0);
8905   inline void VisitOneByteString(const uint8_t* chars, int length);
8906   inline void VisitTwoByteString(const uint16_t* chars, int length);
8907
8908  private:
8909   ConsStringIterator iter_;
8910   bool is_one_byte_;
8911   union {
8912     const uint8_t* buffer8_;
8913     const uint16_t* buffer16_;
8914   };
8915   const uint8_t* end_;
8916   DISALLOW_COPY_AND_ASSIGN(StringCharacterStream);
8917 };
8918
8919
8920 template <typename T>
8921 class VectorIterator {
8922  public:
8923   VectorIterator(T* d, int l) : data_(Vector<const T>(d, l)), index_(0) { }
8924   explicit VectorIterator(Vector<const T> data) : data_(data), index_(0) { }
8925   T GetNext() { return data_[index_++]; }
8926   bool has_more() { return index_ < data_.length(); }
8927  private:
8928   Vector<const T> data_;
8929   int index_;
8930 };
8931
8932
8933 // The Oddball describes objects null, undefined, true, and false.
8934 class Oddball: public HeapObject {
8935  public:
8936   // [to_string]: Cached to_string computed at startup.
8937   DECL_ACCESSORS(to_string, String)
8938
8939   // [to_number]: Cached to_number computed at startup.
8940   DECL_ACCESSORS(to_number, Object)
8941
8942   // [typeof]: Cached type_of computed at startup.
8943   DECL_ACCESSORS(type_of, String)
8944
8945   inline byte kind() const;
8946   inline void set_kind(byte kind);
8947
8948   DECLARE_CAST(Oddball)
8949
8950   // Dispatched behavior.
8951   DECLARE_VERIFIER(Oddball)
8952
8953   // Initialize the fields.
8954   static void Initialize(Isolate* isolate, Handle<Oddball> oddball,
8955                          const char* to_string, Handle<Object> to_number,
8956                          const char* type_of, byte kind);
8957
8958   // Layout description.
8959   static const int kToStringOffset = HeapObject::kHeaderSize;
8960   static const int kToNumberOffset = kToStringOffset + kPointerSize;
8961   static const int kTypeOfOffset = kToNumberOffset + kPointerSize;
8962   static const int kKindOffset = kTypeOfOffset + kPointerSize;
8963   static const int kSize = kKindOffset + kPointerSize;
8964
8965   static const byte kFalse = 0;
8966   static const byte kTrue = 1;
8967   static const byte kNotBooleanMask = ~1;
8968   static const byte kTheHole = 2;
8969   static const byte kNull = 3;
8970   static const byte kArgumentMarker = 4;
8971   static const byte kUndefined = 5;
8972   static const byte kUninitialized = 6;
8973   static const byte kOther = 7;
8974   static const byte kException = 8;
8975
8976   typedef FixedBodyDescriptor<kToStringOffset, kTypeOfOffset + kPointerSize,
8977                               kSize> BodyDescriptor;
8978
8979   STATIC_ASSERT(kKindOffset == Internals::kOddballKindOffset);
8980   STATIC_ASSERT(kNull == Internals::kNullOddballKind);
8981   STATIC_ASSERT(kUndefined == Internals::kUndefinedOddballKind);
8982
8983  private:
8984   DISALLOW_IMPLICIT_CONSTRUCTORS(Oddball);
8985 };
8986
8987
8988 class Cell: public HeapObject {
8989  public:
8990   // [value]: value of the cell.
8991   DECL_ACCESSORS(value, Object)
8992
8993   DECLARE_CAST(Cell)
8994
8995   static inline Cell* FromValueAddress(Address value) {
8996     Object* result = FromAddress(value - kValueOffset);
8997     return static_cast<Cell*>(result);
8998   }
8999
9000   inline Address ValueAddress() {
9001     return address() + kValueOffset;
9002   }
9003
9004   // Dispatched behavior.
9005   DECLARE_PRINTER(Cell)
9006   DECLARE_VERIFIER(Cell)
9007
9008   // Layout description.
9009   static const int kValueOffset = HeapObject::kHeaderSize;
9010   static const int kSize = kValueOffset + kPointerSize;
9011
9012   typedef FixedBodyDescriptor<kValueOffset,
9013                               kValueOffset + kPointerSize,
9014                               kSize> BodyDescriptor;
9015
9016  private:
9017   DISALLOW_IMPLICIT_CONSTRUCTORS(Cell);
9018 };
9019
9020
9021 class PropertyCell : public HeapObject {
9022  public:
9023   // [property_details]: details of the global property.
9024   DECL_ACCESSORS(property_details_raw, Object)
9025   // [value]: value of the global property.
9026   DECL_ACCESSORS(value, Object)
9027   // [dependent_code]: dependent code that depends on the type of the global
9028   // property.
9029   DECL_ACCESSORS(dependent_code, DependentCode)
9030
9031   inline PropertyDetails property_details();
9032   inline void set_property_details(PropertyDetails details);
9033
9034   PropertyCellConstantType GetConstantType();
9035
9036   // Computes the new type of the cell's contents for the given value, but
9037   // without actually modifying the details.
9038   static PropertyCellType UpdatedType(Handle<PropertyCell> cell,
9039                                       Handle<Object> value,
9040                                       PropertyDetails details);
9041   static void UpdateCell(Handle<GlobalDictionary> dictionary, int entry,
9042                          Handle<Object> value, PropertyDetails details);
9043
9044   static Handle<PropertyCell> InvalidateEntry(
9045       Handle<GlobalDictionary> dictionary, int entry);
9046
9047   static void SetValueWithInvalidation(Handle<PropertyCell> cell,
9048                                        Handle<Object> new_value);
9049
9050   DECLARE_CAST(PropertyCell)
9051
9052   // Dispatched behavior.
9053   DECLARE_PRINTER(PropertyCell)
9054   DECLARE_VERIFIER(PropertyCell)
9055
9056   // Layout description.
9057   static const int kDetailsOffset = HeapObject::kHeaderSize;
9058   static const int kValueOffset = kDetailsOffset + kPointerSize;
9059   static const int kDependentCodeOffset = kValueOffset + kPointerSize;
9060   static const int kSize = kDependentCodeOffset + kPointerSize;
9061
9062   static const int kPointerFieldsBeginOffset = kValueOffset;
9063   static const int kPointerFieldsEndOffset = kSize;
9064
9065   typedef FixedBodyDescriptor<kValueOffset,
9066                               kSize,
9067                               kSize> BodyDescriptor;
9068
9069  private:
9070   DISALLOW_IMPLICIT_CONSTRUCTORS(PropertyCell);
9071 };
9072
9073
9074 class WeakCell : public HeapObject {
9075  public:
9076   inline Object* value() const;
9077
9078   // This should not be called by anyone except GC.
9079   inline void clear();
9080
9081   // This should not be called by anyone except allocator.
9082   inline void initialize(HeapObject* value);
9083
9084   inline bool cleared() const;
9085
9086   DECL_ACCESSORS(next, Object)
9087
9088   inline void clear_next(Heap* heap);
9089
9090   inline bool next_cleared();
9091
9092   DECLARE_CAST(WeakCell)
9093
9094   DECLARE_PRINTER(WeakCell)
9095   DECLARE_VERIFIER(WeakCell)
9096
9097   // Layout description.
9098   static const int kValueOffset = HeapObject::kHeaderSize;
9099   static const int kNextOffset = kValueOffset + kPointerSize;
9100   static const int kSize = kNextOffset + kPointerSize;
9101
9102   typedef FixedBodyDescriptor<kValueOffset, kSize, kSize> BodyDescriptor;
9103
9104  private:
9105   DISALLOW_IMPLICIT_CONSTRUCTORS(WeakCell);
9106 };
9107
9108
9109 // The JSProxy describes EcmaScript Harmony proxies
9110 class JSProxy: public JSReceiver {
9111  public:
9112   // [handler]: The handler property.
9113   DECL_ACCESSORS(handler, Object)
9114
9115   // [hash]: The hash code property (undefined if not initialized yet).
9116   DECL_ACCESSORS(hash, Object)
9117
9118   DECLARE_CAST(JSProxy)
9119
9120   MUST_USE_RESULT static MaybeHandle<Object> GetPropertyWithHandler(
9121       Handle<JSProxy> proxy,
9122       Handle<Object> receiver,
9123       Handle<Name> name);
9124
9125   // If the handler defines an accessor property with a setter, invoke it.
9126   // If it defines an accessor property without a setter, or a data property
9127   // that is read-only, throw. In all these cases set '*done' to true,
9128   // otherwise set it to false.
9129   MUST_USE_RESULT
9130   static MaybeHandle<Object> SetPropertyViaPrototypesWithHandler(
9131       Handle<JSProxy> proxy, Handle<Object> receiver, Handle<Name> name,
9132       Handle<Object> value, LanguageMode language_mode, bool* done);
9133
9134   MUST_USE_RESULT static Maybe<PropertyAttributes>
9135       GetPropertyAttributesWithHandler(Handle<JSProxy> proxy,
9136                                        Handle<Object> receiver,
9137                                        Handle<Name> name);
9138   MUST_USE_RESULT static MaybeHandle<Object> SetPropertyWithHandler(
9139       Handle<JSProxy> proxy, Handle<Object> receiver, Handle<Name> name,
9140       Handle<Object> value, LanguageMode language_mode);
9141
9142   // Turn the proxy into an (empty) JSObject.
9143   static void Fix(Handle<JSProxy> proxy);
9144
9145   // Initializes the body after the handler slot.
9146   inline void InitializeBody(int object_size, Object* value);
9147
9148   // Invoke a trap by name. If the trap does not exist on this's handler,
9149   // but derived_trap is non-NULL, invoke that instead.  May cause GC.
9150   MUST_USE_RESULT static MaybeHandle<Object> CallTrap(
9151       Handle<JSProxy> proxy,
9152       const char* name,
9153       Handle<Object> derived_trap,
9154       int argc,
9155       Handle<Object> args[]);
9156
9157   // Dispatched behavior.
9158   DECLARE_PRINTER(JSProxy)
9159   DECLARE_VERIFIER(JSProxy)
9160
9161   // Layout description. We add padding so that a proxy has the same
9162   // size as a virgin JSObject. This is essential for becoming a JSObject
9163   // upon freeze.
9164   static const int kHandlerOffset = HeapObject::kHeaderSize;
9165   static const int kHashOffset = kHandlerOffset + kPointerSize;
9166   static const int kPaddingOffset = kHashOffset + kPointerSize;
9167   static const int kSize = JSObject::kHeaderSize;
9168   static const int kHeaderSize = kPaddingOffset;
9169   static const int kPaddingSize = kSize - kPaddingOffset;
9170
9171   STATIC_ASSERT(kPaddingSize >= 0);
9172
9173   typedef FixedBodyDescriptor<kHandlerOffset,
9174                               kPaddingOffset,
9175                               kSize> BodyDescriptor;
9176
9177  private:
9178   friend class JSReceiver;
9179
9180   MUST_USE_RESULT static Maybe<bool> HasPropertyWithHandler(
9181       Handle<JSProxy> proxy, Handle<Name> name);
9182
9183   MUST_USE_RESULT static MaybeHandle<Object> DeletePropertyWithHandler(
9184       Handle<JSProxy> proxy, Handle<Name> name, LanguageMode language_mode);
9185
9186   MUST_USE_RESULT Object* GetIdentityHash();
9187
9188   static Handle<Smi> GetOrCreateIdentityHash(Handle<JSProxy> proxy);
9189
9190   DISALLOW_IMPLICIT_CONSTRUCTORS(JSProxy);
9191 };
9192
9193
9194 class JSFunctionProxy: public JSProxy {
9195  public:
9196   // [call_trap]: The call trap.
9197   DECL_ACCESSORS(call_trap, Object)
9198
9199   // [construct_trap]: The construct trap.
9200   DECL_ACCESSORS(construct_trap, Object)
9201
9202   DECLARE_CAST(JSFunctionProxy)
9203
9204   // Dispatched behavior.
9205   DECLARE_PRINTER(JSFunctionProxy)
9206   DECLARE_VERIFIER(JSFunctionProxy)
9207
9208   // Layout description.
9209   static const int kCallTrapOffset = JSProxy::kPaddingOffset;
9210   static const int kConstructTrapOffset = kCallTrapOffset + kPointerSize;
9211   static const int kPaddingOffset = kConstructTrapOffset + kPointerSize;
9212   static const int kSize = JSFunction::kSize;
9213   static const int kPaddingSize = kSize - kPaddingOffset;
9214
9215   STATIC_ASSERT(kPaddingSize >= 0);
9216
9217   typedef FixedBodyDescriptor<kHandlerOffset,
9218                               kConstructTrapOffset + kPointerSize,
9219                               kSize> BodyDescriptor;
9220
9221  private:
9222   DISALLOW_IMPLICIT_CONSTRUCTORS(JSFunctionProxy);
9223 };
9224
9225
9226 class JSCollection : public JSObject {
9227  public:
9228   // [table]: the backing hash table
9229   DECL_ACCESSORS(table, Object)
9230
9231   static const int kTableOffset = JSObject::kHeaderSize;
9232   static const int kSize = kTableOffset + kPointerSize;
9233
9234  private:
9235   DISALLOW_IMPLICIT_CONSTRUCTORS(JSCollection);
9236 };
9237
9238
9239 // The JSSet describes EcmaScript Harmony sets
9240 class JSSet : public JSCollection {
9241  public:
9242   DECLARE_CAST(JSSet)
9243
9244   // Dispatched behavior.
9245   DECLARE_PRINTER(JSSet)
9246   DECLARE_VERIFIER(JSSet)
9247
9248  private:
9249   DISALLOW_IMPLICIT_CONSTRUCTORS(JSSet);
9250 };
9251
9252
9253 // The JSMap describes EcmaScript Harmony maps
9254 class JSMap : public JSCollection {
9255  public:
9256   DECLARE_CAST(JSMap)
9257
9258   // Dispatched behavior.
9259   DECLARE_PRINTER(JSMap)
9260   DECLARE_VERIFIER(JSMap)
9261
9262  private:
9263   DISALLOW_IMPLICIT_CONSTRUCTORS(JSMap);
9264 };
9265
9266
9267 // OrderedHashTableIterator is an iterator that iterates over the keys and
9268 // values of an OrderedHashTable.
9269 //
9270 // The iterator has a reference to the underlying OrderedHashTable data,
9271 // [table], as well as the current [index] the iterator is at.
9272 //
9273 // When the OrderedHashTable is rehashed it adds a reference from the old table
9274 // to the new table as well as storing enough data about the changes so that the
9275 // iterator [index] can be adjusted accordingly.
9276 //
9277 // When the [Next] result from the iterator is requested, the iterator checks if
9278 // there is a newer table that it needs to transition to.
9279 template<class Derived, class TableType>
9280 class OrderedHashTableIterator: public JSObject {
9281  public:
9282   // [table]: the backing hash table mapping keys to values.
9283   DECL_ACCESSORS(table, Object)
9284
9285   // [index]: The index into the data table.
9286   DECL_ACCESSORS(index, Object)
9287
9288   // [kind]: The kind of iteration this is. One of the [Kind] enum values.
9289   DECL_ACCESSORS(kind, Object)
9290
9291 #ifdef OBJECT_PRINT
9292   void OrderedHashTableIteratorPrint(std::ostream& os);  // NOLINT
9293 #endif
9294
9295   static const int kTableOffset = JSObject::kHeaderSize;
9296   static const int kIndexOffset = kTableOffset + kPointerSize;
9297   static const int kKindOffset = kIndexOffset + kPointerSize;
9298   static const int kSize = kKindOffset + kPointerSize;
9299
9300   enum Kind {
9301     kKindKeys = 1,
9302     kKindValues = 2,
9303     kKindEntries = 3
9304   };
9305
9306   // Whether the iterator has more elements. This needs to be called before
9307   // calling |CurrentKey| and/or |CurrentValue|.
9308   bool HasMore();
9309
9310   // Move the index forward one.
9311   void MoveNext() {
9312     set_index(Smi::FromInt(Smi::cast(index())->value() + 1));
9313   }
9314
9315   // Populates the array with the next key and value and then moves the iterator
9316   // forward.
9317   // This returns the |kind| or 0 if the iterator is already at the end.
9318   Smi* Next(JSArray* value_array);
9319
9320   // Returns the current key of the iterator. This should only be called when
9321   // |HasMore| returns true.
9322   inline Object* CurrentKey();
9323
9324  private:
9325   // Transitions the iterator to the non obsolete backing store. This is a NOP
9326   // if the [table] is not obsolete.
9327   void Transition();
9328
9329   DISALLOW_IMPLICIT_CONSTRUCTORS(OrderedHashTableIterator);
9330 };
9331
9332
9333 class JSSetIterator: public OrderedHashTableIterator<JSSetIterator,
9334                                                      OrderedHashSet> {
9335  public:
9336   // Dispatched behavior.
9337   DECLARE_PRINTER(JSSetIterator)
9338   DECLARE_VERIFIER(JSSetIterator)
9339
9340   DECLARE_CAST(JSSetIterator)
9341
9342   // Called by |Next| to populate the array. This allows the subclasses to
9343   // populate the array differently.
9344   inline void PopulateValueArray(FixedArray* array);
9345
9346  private:
9347   DISALLOW_IMPLICIT_CONSTRUCTORS(JSSetIterator);
9348 };
9349
9350
9351 class JSMapIterator: public OrderedHashTableIterator<JSMapIterator,
9352                                                      OrderedHashMap> {
9353  public:
9354   // Dispatched behavior.
9355   DECLARE_PRINTER(JSMapIterator)
9356   DECLARE_VERIFIER(JSMapIterator)
9357
9358   DECLARE_CAST(JSMapIterator)
9359
9360   // Called by |Next| to populate the array. This allows the subclasses to
9361   // populate the array differently.
9362   inline void PopulateValueArray(FixedArray* array);
9363
9364  private:
9365   // Returns the current value of the iterator. This should only be called when
9366   // |HasMore| returns true.
9367   inline Object* CurrentValue();
9368
9369   DISALLOW_IMPLICIT_CONSTRUCTORS(JSMapIterator);
9370 };
9371
9372
9373 // Base class for both JSWeakMap and JSWeakSet
9374 class JSWeakCollection: public JSObject {
9375  public:
9376   // [table]: the backing hash table mapping keys to values.
9377   DECL_ACCESSORS(table, Object)
9378
9379   // [next]: linked list of encountered weak maps during GC.
9380   DECL_ACCESSORS(next, Object)
9381
9382   static const int kTableOffset = JSObject::kHeaderSize;
9383   static const int kNextOffset = kTableOffset + kPointerSize;
9384   static const int kSize = kNextOffset + kPointerSize;
9385
9386  private:
9387   DISALLOW_IMPLICIT_CONSTRUCTORS(JSWeakCollection);
9388 };
9389
9390
9391 // The JSWeakMap describes EcmaScript Harmony weak maps
9392 class JSWeakMap: public JSWeakCollection {
9393  public:
9394   DECLARE_CAST(JSWeakMap)
9395
9396   // Dispatched behavior.
9397   DECLARE_PRINTER(JSWeakMap)
9398   DECLARE_VERIFIER(JSWeakMap)
9399
9400  private:
9401   DISALLOW_IMPLICIT_CONSTRUCTORS(JSWeakMap);
9402 };
9403
9404
9405 // The JSWeakSet describes EcmaScript Harmony weak sets
9406 class JSWeakSet: public JSWeakCollection {
9407  public:
9408   DECLARE_CAST(JSWeakSet)
9409
9410   // Dispatched behavior.
9411   DECLARE_PRINTER(JSWeakSet)
9412   DECLARE_VERIFIER(JSWeakSet)
9413
9414  private:
9415   DISALLOW_IMPLICIT_CONSTRUCTORS(JSWeakSet);
9416 };
9417
9418
9419 // Whether a JSArrayBuffer is a SharedArrayBuffer or not.
9420 enum class SharedFlag { kNotShared, kShared };
9421
9422
9423 class JSArrayBuffer: public JSObject {
9424  public:
9425   // [backing_store]: backing memory for this array
9426   DECL_ACCESSORS(backing_store, void)
9427
9428   // [byte_length]: length in bytes
9429   DECL_ACCESSORS(byte_length, Object)
9430
9431   inline uint32_t bit_field() const;
9432   inline void set_bit_field(uint32_t bits);
9433
9434   inline bool is_external();
9435   inline void set_is_external(bool value);
9436
9437   inline bool is_neuterable();
9438   inline void set_is_neuterable(bool value);
9439
9440   inline bool was_neutered();
9441   inline void set_was_neutered(bool value);
9442
9443   inline bool is_shared();
9444   inline void set_is_shared(bool value);
9445
9446   DECLARE_CAST(JSArrayBuffer)
9447
9448   void Neuter();
9449
9450   // Dispatched behavior.
9451   DECLARE_PRINTER(JSArrayBuffer)
9452   DECLARE_VERIFIER(JSArrayBuffer)
9453
9454   static const int kBackingStoreOffset = JSObject::kHeaderSize;
9455   static const int kByteLengthOffset = kBackingStoreOffset + kPointerSize;
9456   static const int kBitFieldSlot = kByteLengthOffset + kPointerSize;
9457 #if V8_TARGET_LITTLE_ENDIAN || !V8_HOST_ARCH_64_BIT
9458   static const int kBitFieldOffset = kBitFieldSlot;
9459 #else
9460   static const int kBitFieldOffset = kBitFieldSlot + kIntSize;
9461 #endif
9462   static const int kSize = kBitFieldSlot + kPointerSize;
9463
9464   static const int kSizeWithInternalFields =
9465       kSize + v8::ArrayBuffer::kInternalFieldCount * kPointerSize;
9466
9467   class IsExternal : public BitField<bool, 1, 1> {};
9468   class IsNeuterable : public BitField<bool, 2, 1> {};
9469   class WasNeutered : public BitField<bool, 3, 1> {};
9470   class IsShared : public BitField<bool, 4, 1> {};
9471
9472  private:
9473   DISALLOW_IMPLICIT_CONSTRUCTORS(JSArrayBuffer);
9474 };
9475
9476
9477 class JSArrayBufferView: public JSObject {
9478  public:
9479   // [buffer]: ArrayBuffer that this typed array views.
9480   DECL_ACCESSORS(buffer, Object)
9481
9482   // [byte_offset]: offset of typed array in bytes.
9483   DECL_ACCESSORS(byte_offset, Object)
9484
9485   // [byte_length]: length of typed array in bytes.
9486   DECL_ACCESSORS(byte_length, Object)
9487
9488   DECLARE_CAST(JSArrayBufferView)
9489
9490   DECLARE_VERIFIER(JSArrayBufferView)
9491
9492   inline bool WasNeutered() const;
9493
9494   static const int kBufferOffset = JSObject::kHeaderSize;
9495   static const int kByteOffsetOffset = kBufferOffset + kPointerSize;
9496   static const int kByteLengthOffset = kByteOffsetOffset + kPointerSize;
9497   static const int kViewSize = kByteLengthOffset + kPointerSize;
9498
9499  private:
9500 #ifdef VERIFY_HEAP
9501   DECL_ACCESSORS(raw_byte_offset, Object)
9502   DECL_ACCESSORS(raw_byte_length, Object)
9503 #endif
9504
9505   DISALLOW_IMPLICIT_CONSTRUCTORS(JSArrayBufferView);
9506 };
9507
9508
9509 class JSTypedArray: public JSArrayBufferView {
9510  public:
9511   // [length]: length of typed array in elements.
9512   DECL_ACCESSORS(length, Object)
9513   inline uint32_t length_value() const;
9514
9515   DECLARE_CAST(JSTypedArray)
9516
9517   ExternalArrayType type();
9518   size_t element_size();
9519
9520   Handle<JSArrayBuffer> GetBuffer();
9521
9522   // Dispatched behavior.
9523   DECLARE_PRINTER(JSTypedArray)
9524   DECLARE_VERIFIER(JSTypedArray)
9525
9526   static const int kLengthOffset = kViewSize + kPointerSize;
9527   static const int kSize = kLengthOffset + kPointerSize;
9528
9529   static const int kSizeWithInternalFields =
9530       kSize + v8::ArrayBufferView::kInternalFieldCount * kPointerSize;
9531
9532  private:
9533   static Handle<JSArrayBuffer> MaterializeArrayBuffer(
9534       Handle<JSTypedArray> typed_array);
9535 #ifdef VERIFY_HEAP
9536   DECL_ACCESSORS(raw_length, Object)
9537 #endif
9538
9539   DISALLOW_IMPLICIT_CONSTRUCTORS(JSTypedArray);
9540 };
9541
9542
9543 class JSDataView: public JSArrayBufferView {
9544  public:
9545   DECLARE_CAST(JSDataView)
9546
9547   // Dispatched behavior.
9548   DECLARE_PRINTER(JSDataView)
9549   DECLARE_VERIFIER(JSDataView)
9550
9551   static const int kSize = kViewSize;
9552
9553   static const int kSizeWithInternalFields =
9554       kSize + v8::ArrayBufferView::kInternalFieldCount * kPointerSize;
9555
9556  private:
9557   DISALLOW_IMPLICIT_CONSTRUCTORS(JSDataView);
9558 };
9559
9560
9561 // Foreign describes objects pointing from JavaScript to C structures.
9562 class Foreign: public HeapObject {
9563  public:
9564   // [address]: field containing the address.
9565   inline Address foreign_address();
9566   inline void set_foreign_address(Address value);
9567
9568   DECLARE_CAST(Foreign)
9569
9570   // Dispatched behavior.
9571   inline void ForeignIterateBody(ObjectVisitor* v);
9572
9573   template<typename StaticVisitor>
9574   inline void ForeignIterateBody();
9575
9576   // Dispatched behavior.
9577   DECLARE_PRINTER(Foreign)
9578   DECLARE_VERIFIER(Foreign)
9579
9580   // Layout description.
9581
9582   static const int kForeignAddressOffset = HeapObject::kHeaderSize;
9583   static const int kSize = kForeignAddressOffset + kPointerSize;
9584
9585   STATIC_ASSERT(kForeignAddressOffset == Internals::kForeignAddressOffset);
9586
9587  private:
9588   DISALLOW_IMPLICIT_CONSTRUCTORS(Foreign);
9589 };
9590
9591
9592 // The JSArray describes JavaScript Arrays
9593 //  Such an array can be in one of two modes:
9594 //    - fast, backing storage is a FixedArray and length <= elements.length();
9595 //       Please note: push and pop can be used to grow and shrink the array.
9596 //    - slow, backing storage is a HashTable with numbers as keys.
9597 class JSArray: public JSObject {
9598  public:
9599   // [length]: The length property.
9600   DECL_ACCESSORS(length, Object)
9601
9602   // Overload the length setter to skip write barrier when the length
9603   // is set to a smi. This matches the set function on FixedArray.
9604   inline void set_length(Smi* length);
9605
9606   static bool HasReadOnlyLength(Handle<JSArray> array);
9607   static bool WouldChangeReadOnlyLength(Handle<JSArray> array, uint32_t index);
9608   static MaybeHandle<Object> ReadOnlyLengthError(Handle<JSArray> array);
9609
9610   // Initialize the array with the given capacity. The function may
9611   // fail due to out-of-memory situations, but only if the requested
9612   // capacity is non-zero.
9613   static void Initialize(Handle<JSArray> array, int capacity, int length = 0);
9614
9615   // If the JSArray has fast elements, and new_length would result in
9616   // normalization, returns true.
9617   bool SetLengthWouldNormalize(uint32_t new_length);
9618   static inline bool SetLengthWouldNormalize(Heap* heap, uint32_t new_length);
9619
9620   // Initializes the array to a certain length.
9621   inline bool AllowsSetLength();
9622
9623   static void SetLength(Handle<JSArray> array, uint32_t length);
9624   // Same as above but will also queue splice records if |array| is observed.
9625   static MaybeHandle<Object> ObservableSetLength(Handle<JSArray> array,
9626                                                  uint32_t length);
9627
9628   // Set the content of the array to the content of storage.
9629   static inline void SetContent(Handle<JSArray> array,
9630                                 Handle<FixedArrayBase> storage);
9631
9632   DECLARE_CAST(JSArray)
9633
9634   // Dispatched behavior.
9635   DECLARE_PRINTER(JSArray)
9636   DECLARE_VERIFIER(JSArray)
9637
9638   // Number of element slots to pre-allocate for an empty array.
9639   static const int kPreallocatedArrayElements = 4;
9640
9641   // Layout description.
9642   static const int kLengthOffset = JSObject::kHeaderSize;
9643   static const int kSize = kLengthOffset + kPointerSize;
9644
9645  private:
9646   DISALLOW_IMPLICIT_CONSTRUCTORS(JSArray);
9647 };
9648
9649
9650 Handle<Object> CacheInitialJSArrayMaps(Handle<Context> native_context,
9651                                        Handle<Map> initial_map);
9652
9653
9654 // JSRegExpResult is just a JSArray with a specific initial map.
9655 // This initial map adds in-object properties for "index" and "input"
9656 // properties, as assigned by RegExp.prototype.exec, which allows
9657 // faster creation of RegExp exec results.
9658 // This class just holds constants used when creating the result.
9659 // After creation the result must be treated as a JSArray in all regards.
9660 class JSRegExpResult: public JSArray {
9661  public:
9662   // Offsets of object fields.
9663   static const int kIndexOffset = JSArray::kSize;
9664   static const int kInputOffset = kIndexOffset + kPointerSize;
9665   static const int kSize = kInputOffset + kPointerSize;
9666   // Indices of in-object properties.
9667   static const int kIndexIndex = 0;
9668   static const int kInputIndex = 1;
9669  private:
9670   DISALLOW_IMPLICIT_CONSTRUCTORS(JSRegExpResult);
9671 };
9672
9673
9674 class AccessorInfo: public Struct {
9675  public:
9676   DECL_ACCESSORS(name, Object)
9677   DECL_ACCESSORS(flag, Smi)
9678   DECL_ACCESSORS(expected_receiver_type, Object)
9679
9680   inline bool all_can_read();
9681   inline void set_all_can_read(bool value);
9682
9683   inline bool all_can_write();
9684   inline void set_all_can_write(bool value);
9685
9686   inline bool is_special_data_property();
9687   inline void set_is_special_data_property(bool value);
9688
9689   inline PropertyAttributes property_attributes();
9690   inline void set_property_attributes(PropertyAttributes attributes);
9691
9692   // Checks whether the given receiver is compatible with this accessor.
9693   static bool IsCompatibleReceiverMap(Isolate* isolate,
9694                                       Handle<AccessorInfo> info,
9695                                       Handle<Map> map);
9696   inline bool IsCompatibleReceiver(Object* receiver);
9697
9698   DECLARE_CAST(AccessorInfo)
9699
9700   // Dispatched behavior.
9701   DECLARE_VERIFIER(AccessorInfo)
9702
9703   // Append all descriptors to the array that are not already there.
9704   // Return number added.
9705   static int AppendUnique(Handle<Object> descriptors,
9706                           Handle<FixedArray> array,
9707                           int valid_descriptors);
9708
9709   static const int kNameOffset = HeapObject::kHeaderSize;
9710   static const int kFlagOffset = kNameOffset + kPointerSize;
9711   static const int kExpectedReceiverTypeOffset = kFlagOffset + kPointerSize;
9712   static const int kSize = kExpectedReceiverTypeOffset + kPointerSize;
9713
9714  private:
9715   inline bool HasExpectedReceiverType();
9716
9717   // Bit positions in flag.
9718   static const int kAllCanReadBit = 0;
9719   static const int kAllCanWriteBit = 1;
9720   static const int kSpecialDataProperty = 2;
9721   class AttributesField : public BitField<PropertyAttributes, 3, 3> {};
9722
9723   DISALLOW_IMPLICIT_CONSTRUCTORS(AccessorInfo);
9724 };
9725
9726
9727 // An accessor must have a getter, but can have no setter.
9728 //
9729 // When setting a property, V8 searches accessors in prototypes.
9730 // If an accessor was found and it does not have a setter,
9731 // the request is ignored.
9732 //
9733 // If the accessor in the prototype has the READ_ONLY property attribute, then
9734 // a new value is added to the derived object when the property is set.
9735 // This shadows the accessor in the prototype.
9736 class ExecutableAccessorInfo: public AccessorInfo {
9737  public:
9738   DECL_ACCESSORS(getter, Object)
9739   DECL_ACCESSORS(setter, Object)
9740   DECL_ACCESSORS(data, Object)
9741
9742   DECLARE_CAST(ExecutableAccessorInfo)
9743
9744   // Dispatched behavior.
9745   DECLARE_PRINTER(ExecutableAccessorInfo)
9746   DECLARE_VERIFIER(ExecutableAccessorInfo)
9747
9748   static const int kGetterOffset = AccessorInfo::kSize;
9749   static const int kSetterOffset = kGetterOffset + kPointerSize;
9750   static const int kDataOffset = kSetterOffset + kPointerSize;
9751   static const int kSize = kDataOffset + kPointerSize;
9752
9753   static void ClearSetter(Handle<ExecutableAccessorInfo> info);
9754
9755  private:
9756   DISALLOW_IMPLICIT_CONSTRUCTORS(ExecutableAccessorInfo);
9757 };
9758
9759
9760 // Support for JavaScript accessors: A pair of a getter and a setter. Each
9761 // accessor can either be
9762 //   * a pointer to a JavaScript function or proxy: a real accessor
9763 //   * undefined: considered an accessor by the spec, too, strangely enough
9764 //   * the hole: an accessor which has not been set
9765 //   * a pointer to a map: a transition used to ensure map sharing
9766 class AccessorPair: public Struct {
9767  public:
9768   DECL_ACCESSORS(getter, Object)
9769   DECL_ACCESSORS(setter, Object)
9770
9771   DECLARE_CAST(AccessorPair)
9772
9773   static Handle<AccessorPair> Copy(Handle<AccessorPair> pair);
9774
9775   inline Object* get(AccessorComponent component);
9776   inline void set(AccessorComponent component, Object* value);
9777
9778   // Note: Returns undefined instead in case of a hole.
9779   Object* GetComponent(AccessorComponent component);
9780
9781   // Set both components, skipping arguments which are a JavaScript null.
9782   inline void SetComponents(Object* getter, Object* setter);
9783
9784   inline bool Equals(AccessorPair* pair);
9785   inline bool Equals(Object* getter_value, Object* setter_value);
9786
9787   inline bool ContainsAccessor();
9788
9789   // Dispatched behavior.
9790   DECLARE_PRINTER(AccessorPair)
9791   DECLARE_VERIFIER(AccessorPair)
9792
9793   static const int kGetterOffset = HeapObject::kHeaderSize;
9794   static const int kSetterOffset = kGetterOffset + kPointerSize;
9795   static const int kSize = kSetterOffset + kPointerSize;
9796
9797  private:
9798   // Strangely enough, in addition to functions and harmony proxies, the spec
9799   // requires us to consider undefined as a kind of accessor, too:
9800   //    var obj = {};
9801   //    Object.defineProperty(obj, "foo", {get: undefined});
9802   //    assertTrue("foo" in obj);
9803   inline bool IsJSAccessor(Object* obj);
9804
9805   DISALLOW_IMPLICIT_CONSTRUCTORS(AccessorPair);
9806 };
9807
9808
9809 class AccessCheckInfo: public Struct {
9810  public:
9811   DECL_ACCESSORS(named_callback, Object)
9812   DECL_ACCESSORS(indexed_callback, Object)
9813   DECL_ACCESSORS(data, Object)
9814
9815   DECLARE_CAST(AccessCheckInfo)
9816
9817   // Dispatched behavior.
9818   DECLARE_PRINTER(AccessCheckInfo)
9819   DECLARE_VERIFIER(AccessCheckInfo)
9820
9821   static const int kNamedCallbackOffset   = HeapObject::kHeaderSize;
9822   static const int kIndexedCallbackOffset = kNamedCallbackOffset + kPointerSize;
9823   static const int kDataOffset = kIndexedCallbackOffset + kPointerSize;
9824   static const int kSize = kDataOffset + kPointerSize;
9825
9826  private:
9827   DISALLOW_IMPLICIT_CONSTRUCTORS(AccessCheckInfo);
9828 };
9829
9830
9831 class InterceptorInfo: public Struct {
9832  public:
9833   DECL_ACCESSORS(getter, Object)
9834   DECL_ACCESSORS(setter, Object)
9835   DECL_ACCESSORS(query, Object)
9836   DECL_ACCESSORS(deleter, Object)
9837   DECL_ACCESSORS(enumerator, Object)
9838   DECL_ACCESSORS(data, Object)
9839   DECL_BOOLEAN_ACCESSORS(can_intercept_symbols)
9840   DECL_BOOLEAN_ACCESSORS(all_can_read)
9841   DECL_BOOLEAN_ACCESSORS(non_masking)
9842
9843   inline int flags() const;
9844   inline void set_flags(int flags);
9845
9846   DECLARE_CAST(InterceptorInfo)
9847
9848   // Dispatched behavior.
9849   DECLARE_PRINTER(InterceptorInfo)
9850   DECLARE_VERIFIER(InterceptorInfo)
9851
9852   static const int kGetterOffset = HeapObject::kHeaderSize;
9853   static const int kSetterOffset = kGetterOffset + kPointerSize;
9854   static const int kQueryOffset = kSetterOffset + kPointerSize;
9855   static const int kDeleterOffset = kQueryOffset + kPointerSize;
9856   static const int kEnumeratorOffset = kDeleterOffset + kPointerSize;
9857   static const int kDataOffset = kEnumeratorOffset + kPointerSize;
9858   static const int kFlagsOffset = kDataOffset + kPointerSize;
9859   static const int kSize = kFlagsOffset + kPointerSize;
9860
9861   static const int kCanInterceptSymbolsBit = 0;
9862   static const int kAllCanReadBit = 1;
9863   static const int kNonMasking = 2;
9864
9865  private:
9866   DISALLOW_IMPLICIT_CONSTRUCTORS(InterceptorInfo);
9867 };
9868
9869
9870 class CallHandlerInfo: public Struct {
9871  public:
9872   DECL_ACCESSORS(callback, Object)
9873   DECL_ACCESSORS(data, Object)
9874
9875   DECLARE_CAST(CallHandlerInfo)
9876
9877   // Dispatched behavior.
9878   DECLARE_PRINTER(CallHandlerInfo)
9879   DECLARE_VERIFIER(CallHandlerInfo)
9880
9881   static const int kCallbackOffset = HeapObject::kHeaderSize;
9882   static const int kDataOffset = kCallbackOffset + kPointerSize;
9883   static const int kSize = kDataOffset + kPointerSize;
9884
9885  private:
9886   DISALLOW_IMPLICIT_CONSTRUCTORS(CallHandlerInfo);
9887 };
9888
9889
9890 class TemplateInfo: public Struct {
9891  public:
9892   DECL_ACCESSORS(tag, Object)
9893   inline int number_of_properties() const;
9894   inline void set_number_of_properties(int value);
9895   DECL_ACCESSORS(property_list, Object)
9896   DECL_ACCESSORS(property_accessors, Object)
9897
9898   DECLARE_VERIFIER(TemplateInfo)
9899
9900   static const int kTagOffset = HeapObject::kHeaderSize;
9901   static const int kNumberOfProperties = kTagOffset + kPointerSize;
9902   static const int kPropertyListOffset = kNumberOfProperties + kPointerSize;
9903   static const int kPropertyAccessorsOffset =
9904       kPropertyListOffset + kPointerSize;
9905   static const int kHeaderSize = kPropertyAccessorsOffset + kPointerSize;
9906
9907  private:
9908   DISALLOW_IMPLICIT_CONSTRUCTORS(TemplateInfo);
9909 };
9910
9911
9912 class FunctionTemplateInfo: public TemplateInfo {
9913  public:
9914   DECL_ACCESSORS(serial_number, Object)
9915   DECL_ACCESSORS(call_code, Object)
9916   DECL_ACCESSORS(prototype_template, Object)
9917   DECL_ACCESSORS(parent_template, Object)
9918   DECL_ACCESSORS(named_property_handler, Object)
9919   DECL_ACCESSORS(indexed_property_handler, Object)
9920   DECL_ACCESSORS(instance_template, Object)
9921   DECL_ACCESSORS(class_name, Object)
9922   DECL_ACCESSORS(signature, Object)
9923   DECL_ACCESSORS(instance_call_handler, Object)
9924   DECL_ACCESSORS(access_check_info, Object)
9925   DECL_ACCESSORS(flag, Smi)
9926
9927   inline int length() const;
9928   inline void set_length(int value);
9929
9930   // Following properties use flag bits.
9931   DECL_BOOLEAN_ACCESSORS(hidden_prototype)
9932   DECL_BOOLEAN_ACCESSORS(undetectable)
9933   // If the bit is set, object instances created by this function
9934   // requires access check.
9935   DECL_BOOLEAN_ACCESSORS(needs_access_check)
9936   DECL_BOOLEAN_ACCESSORS(read_only_prototype)
9937   DECL_BOOLEAN_ACCESSORS(remove_prototype)
9938   DECL_BOOLEAN_ACCESSORS(do_not_cache)
9939   DECL_BOOLEAN_ACCESSORS(instantiated)
9940   DECL_BOOLEAN_ACCESSORS(accept_any_receiver)
9941
9942   DECLARE_CAST(FunctionTemplateInfo)
9943
9944   // Dispatched behavior.
9945   DECLARE_PRINTER(FunctionTemplateInfo)
9946   DECLARE_VERIFIER(FunctionTemplateInfo)
9947
9948   static const int kSerialNumberOffset = TemplateInfo::kHeaderSize;
9949   static const int kCallCodeOffset = kSerialNumberOffset + kPointerSize;
9950   static const int kPrototypeTemplateOffset =
9951       kCallCodeOffset + kPointerSize;
9952   static const int kParentTemplateOffset =
9953       kPrototypeTemplateOffset + kPointerSize;
9954   static const int kNamedPropertyHandlerOffset =
9955       kParentTemplateOffset + kPointerSize;
9956   static const int kIndexedPropertyHandlerOffset =
9957       kNamedPropertyHandlerOffset + kPointerSize;
9958   static const int kInstanceTemplateOffset =
9959       kIndexedPropertyHandlerOffset + kPointerSize;
9960   static const int kClassNameOffset = kInstanceTemplateOffset + kPointerSize;
9961   static const int kSignatureOffset = kClassNameOffset + kPointerSize;
9962   static const int kInstanceCallHandlerOffset = kSignatureOffset + kPointerSize;
9963   static const int kAccessCheckInfoOffset =
9964       kInstanceCallHandlerOffset + kPointerSize;
9965   static const int kFlagOffset = kAccessCheckInfoOffset + kPointerSize;
9966   static const int kLengthOffset = kFlagOffset + kPointerSize;
9967   static const int kSize = kLengthOffset + kPointerSize;
9968
9969   // Returns true if |object| is an instance of this function template.
9970   bool IsTemplateFor(Object* object);
9971   bool IsTemplateFor(Map* map);
9972
9973   // Returns the holder JSObject if the function can legally be called with this
9974   // receiver.  Returns Heap::null_value() if the call is illegal.
9975   Object* GetCompatibleReceiver(Isolate* isolate, Object* receiver);
9976
9977  private:
9978   // Bit position in the flag, from least significant bit position.
9979   static const int kHiddenPrototypeBit   = 0;
9980   static const int kUndetectableBit      = 1;
9981   static const int kNeedsAccessCheckBit  = 2;
9982   static const int kReadOnlyPrototypeBit = 3;
9983   static const int kRemovePrototypeBit   = 4;
9984   static const int kDoNotCacheBit        = 5;
9985   static const int kInstantiatedBit      = 6;
9986   static const int kAcceptAnyReceiver = 7;
9987
9988   DISALLOW_IMPLICIT_CONSTRUCTORS(FunctionTemplateInfo);
9989 };
9990
9991
9992 class ObjectTemplateInfo: public TemplateInfo {
9993  public:
9994   DECL_ACCESSORS(constructor, Object)
9995   DECL_ACCESSORS(internal_field_count, Object)
9996
9997   DECLARE_CAST(ObjectTemplateInfo)
9998
9999   // Dispatched behavior.
10000   DECLARE_PRINTER(ObjectTemplateInfo)
10001   DECLARE_VERIFIER(ObjectTemplateInfo)
10002
10003   static const int kConstructorOffset = TemplateInfo::kHeaderSize;
10004   static const int kInternalFieldCountOffset =
10005       kConstructorOffset + kPointerSize;
10006   static const int kSize = kInternalFieldCountOffset + kPointerSize;
10007 };
10008
10009
10010 class TypeSwitchInfo: public Struct {
10011  public:
10012   DECL_ACCESSORS(types, Object)
10013
10014   DECLARE_CAST(TypeSwitchInfo)
10015
10016   // Dispatched behavior.
10017   DECLARE_PRINTER(TypeSwitchInfo)
10018   DECLARE_VERIFIER(TypeSwitchInfo)
10019
10020   static const int kTypesOffset = Struct::kHeaderSize;
10021   static const int kSize        = kTypesOffset + kPointerSize;
10022 };
10023
10024
10025 // The DebugInfo class holds additional information for a function being
10026 // debugged.
10027 class DebugInfo: public Struct {
10028  public:
10029   // The shared function info for the source being debugged.
10030   DECL_ACCESSORS(shared, SharedFunctionInfo)
10031   // Code object for the patched code. This code object is the code object
10032   // currently active for the function.
10033   DECL_ACCESSORS(code, Code)
10034   // Fixed array holding status information for each active break point.
10035   DECL_ACCESSORS(break_points, FixedArray)
10036
10037   // Check if there is a break point at a code position.
10038   bool HasBreakPoint(int code_position);
10039   // Get the break point info object for a code position.
10040   Object* GetBreakPointInfo(int code_position);
10041   // Clear a break point.
10042   static void ClearBreakPoint(Handle<DebugInfo> debug_info,
10043                               int code_position,
10044                               Handle<Object> break_point_object);
10045   // Set a break point.
10046   static void SetBreakPoint(Handle<DebugInfo> debug_info, int code_position,
10047                             int source_position, int statement_position,
10048                             Handle<Object> break_point_object);
10049   // Get the break point objects for a code position.
10050   Handle<Object> GetBreakPointObjects(int code_position);
10051   // Find the break point info holding this break point object.
10052   static Handle<Object> FindBreakPointInfo(Handle<DebugInfo> debug_info,
10053                                            Handle<Object> break_point_object);
10054   // Get the number of break points for this function.
10055   int GetBreakPointCount();
10056
10057   DECLARE_CAST(DebugInfo)
10058
10059   // Dispatched behavior.
10060   DECLARE_PRINTER(DebugInfo)
10061   DECLARE_VERIFIER(DebugInfo)
10062
10063   static const int kSharedFunctionInfoIndex = Struct::kHeaderSize;
10064   static const int kCodeIndex = kSharedFunctionInfoIndex + kPointerSize;
10065   static const int kBreakPointsStateIndex = kCodeIndex + kPointerSize;
10066   static const int kSize = kBreakPointsStateIndex + kPointerSize;
10067
10068   static const int kEstimatedNofBreakPointsInFunction = 16;
10069
10070  private:
10071   static const int kNoBreakPointInfo = -1;
10072
10073   // Lookup the index in the break_points array for a code position.
10074   int GetBreakPointInfoIndex(int code_position);
10075
10076   DISALLOW_IMPLICIT_CONSTRUCTORS(DebugInfo);
10077 };
10078
10079
10080 // The BreakPointInfo class holds information for break points set in a
10081 // function. The DebugInfo object holds a BreakPointInfo object for each code
10082 // position with one or more break points.
10083 class BreakPointInfo: public Struct {
10084  public:
10085   // The position in the code for the break point.
10086   DECL_ACCESSORS(code_position, Smi)
10087   // The position in the source for the break position.
10088   DECL_ACCESSORS(source_position, Smi)
10089   // The position in the source for the last statement before this break
10090   // position.
10091   DECL_ACCESSORS(statement_position, Smi)
10092   // List of related JavaScript break points.
10093   DECL_ACCESSORS(break_point_objects, Object)
10094
10095   // Removes a break point.
10096   static void ClearBreakPoint(Handle<BreakPointInfo> info,
10097                               Handle<Object> break_point_object);
10098   // Set a break point.
10099   static void SetBreakPoint(Handle<BreakPointInfo> info,
10100                             Handle<Object> break_point_object);
10101   // Check if break point info has this break point object.
10102   static bool HasBreakPointObject(Handle<BreakPointInfo> info,
10103                                   Handle<Object> break_point_object);
10104   // Get the number of break points for this code position.
10105   int GetBreakPointCount();
10106
10107   DECLARE_CAST(BreakPointInfo)
10108
10109   // Dispatched behavior.
10110   DECLARE_PRINTER(BreakPointInfo)
10111   DECLARE_VERIFIER(BreakPointInfo)
10112
10113   static const int kCodePositionIndex = Struct::kHeaderSize;
10114   static const int kSourcePositionIndex = kCodePositionIndex + kPointerSize;
10115   static const int kStatementPositionIndex =
10116       kSourcePositionIndex + kPointerSize;
10117   static const int kBreakPointObjectsIndex =
10118       kStatementPositionIndex + kPointerSize;
10119   static const int kSize = kBreakPointObjectsIndex + kPointerSize;
10120
10121  private:
10122   DISALLOW_IMPLICIT_CONSTRUCTORS(BreakPointInfo);
10123 };
10124
10125
10126 #undef DECL_BOOLEAN_ACCESSORS
10127 #undef DECL_ACCESSORS
10128 #undef DECLARE_CAST
10129 #undef DECLARE_VERIFIER
10130
10131 #define VISITOR_SYNCHRONIZATION_TAGS_LIST(V)                               \
10132   V(kStringTable, "string_table", "(Internalized strings)")                \
10133   V(kExternalStringsTable, "external_strings_table", "(External strings)") \
10134   V(kStrongRootList, "strong_root_list", "(Strong roots)")                 \
10135   V(kSmiRootList, "smi_root_list", "(Smi roots)")                          \
10136   V(kInternalizedString, "internalized_string", "(Internal string)")       \
10137   V(kBootstrapper, "bootstrapper", "(Bootstrapper)")                       \
10138   V(kTop, "top", "(Isolate)")                                              \
10139   V(kRelocatable, "relocatable", "(Relocatable)")                          \
10140   V(kDebug, "debug", "(Debugger)")                                         \
10141   V(kCompilationCache, "compilationcache", "(Compilation cache)")          \
10142   V(kHandleScope, "handlescope", "(Handle scope)")                         \
10143   V(kBuiltins, "builtins", "(Builtins)")                                   \
10144   V(kGlobalHandles, "globalhandles", "(Global handles)")                   \
10145   V(kEternalHandles, "eternalhandles", "(Eternal handles)")                \
10146   V(kThreadManager, "threadmanager", "(Thread manager)")                   \
10147   V(kStrongRoots, "strong roots", "(Strong roots)")                        \
10148   V(kExtensions, "Extensions", "(Extensions)")
10149
10150 class VisitorSynchronization : public AllStatic {
10151  public:
10152 #define DECLARE_ENUM(enum_item, ignore1, ignore2) enum_item,
10153   enum SyncTag {
10154     VISITOR_SYNCHRONIZATION_TAGS_LIST(DECLARE_ENUM)
10155     kNumberOfSyncTags
10156   };
10157 #undef DECLARE_ENUM
10158
10159   static const char* const kTags[kNumberOfSyncTags];
10160   static const char* const kTagNames[kNumberOfSyncTags];
10161 };
10162
10163 // Abstract base class for visiting, and optionally modifying, the
10164 // pointers contained in Objects. Used in GC and serialization/deserialization.
10165 class ObjectVisitor BASE_EMBEDDED {
10166  public:
10167   virtual ~ObjectVisitor() {}
10168
10169   // Visits a contiguous arrays of pointers in the half-open range
10170   // [start, end). Any or all of the values may be modified on return.
10171   virtual void VisitPointers(Object** start, Object** end) = 0;
10172
10173   // Handy shorthand for visiting a single pointer.
10174   virtual void VisitPointer(Object** p) { VisitPointers(p, p + 1); }
10175
10176   // Visit weak next_code_link in Code object.
10177   virtual void VisitNextCodeLink(Object** p) { VisitPointers(p, p + 1); }
10178
10179   // To allow lazy clearing of inline caches the visitor has
10180   // a rich interface for iterating over Code objects..
10181
10182   // Visits a code target in the instruction stream.
10183   virtual void VisitCodeTarget(RelocInfo* rinfo);
10184
10185   // Visits a code entry in a JS function.
10186   virtual void VisitCodeEntry(Address entry_address);
10187
10188   // Visits a global property cell reference in the instruction stream.
10189   virtual void VisitCell(RelocInfo* rinfo);
10190
10191   // Visits a runtime entry in the instruction stream.
10192   virtual void VisitRuntimeEntry(RelocInfo* rinfo) {}
10193
10194   // Visits the resource of an one-byte or two-byte string.
10195   virtual void VisitExternalOneByteString(
10196       v8::String::ExternalOneByteStringResource** resource) {}
10197   virtual void VisitExternalTwoByteString(
10198       v8::String::ExternalStringResource** resource) {}
10199
10200   // Visits a debug call target in the instruction stream.
10201   virtual void VisitDebugTarget(RelocInfo* rinfo);
10202
10203   // Visits the byte sequence in a function's prologue that contains information
10204   // about the code's age.
10205   virtual void VisitCodeAgeSequence(RelocInfo* rinfo);
10206
10207   // Visit pointer embedded into a code object.
10208   virtual void VisitEmbeddedPointer(RelocInfo* rinfo);
10209
10210   // Visits an external reference embedded into a code object.
10211   virtual void VisitExternalReference(RelocInfo* rinfo);
10212
10213   // Visits an external reference.
10214   virtual void VisitExternalReference(Address* p) {}
10215
10216   // Visits an (encoded) internal reference.
10217   virtual void VisitInternalReference(RelocInfo* rinfo) {}
10218
10219   // Visits a handle that has an embedder-assigned class ID.
10220   virtual void VisitEmbedderReference(Object** p, uint16_t class_id) {}
10221
10222   // Intended for serialization/deserialization checking: insert, or
10223   // check for the presence of, a tag at this position in the stream.
10224   // Also used for marking up GC roots in heap snapshots.
10225   virtual void Synchronize(VisitorSynchronization::SyncTag tag) {}
10226 };
10227
10228
10229 class StructBodyDescriptor : public
10230   FlexibleBodyDescriptor<HeapObject::kHeaderSize> {
10231  public:
10232   static inline int SizeOf(Map* map, HeapObject* object);
10233 };
10234
10235
10236 // BooleanBit is a helper class for setting and getting a bit in an
10237 // integer or Smi.
10238 class BooleanBit : public AllStatic {
10239  public:
10240   static inline bool get(Smi* smi, int bit_position) {
10241     return get(smi->value(), bit_position);
10242   }
10243
10244   static inline bool get(int value, int bit_position) {
10245     return (value & (1 << bit_position)) != 0;
10246   }
10247
10248   static inline Smi* set(Smi* smi, int bit_position, bool v) {
10249     return Smi::FromInt(set(smi->value(), bit_position, v));
10250   }
10251
10252   static inline int set(int value, int bit_position, bool v) {
10253     if (v) {
10254       value |= (1 << bit_position);
10255     } else {
10256       value &= ~(1 << bit_position);
10257     }
10258     return value;
10259   }
10260 };
10261
10262 } }  // namespace v8::internal
10263
10264 #endif  // V8_OBJECTS_H_