[builtins] Remove the weird STACK_OVERFLOW builtin.
[platform/upstream/v8.git] / src / contexts.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_CONTEXTS_H_
6 #define V8_CONTEXTS_H_
7
8 #include "src/heap/heap.h"
9 #include "src/objects.h"
10
11 namespace v8 {
12 namespace internal {
13
14
15 enum ContextLookupFlags {
16   FOLLOW_CONTEXT_CHAIN = 1,
17   FOLLOW_PROTOTYPE_CHAIN = 2,
18
19   DONT_FOLLOW_CHAINS = 0,
20   FOLLOW_CHAINS = FOLLOW_CONTEXT_CHAIN | FOLLOW_PROTOTYPE_CHAIN
21 };
22
23
24 // ES5 10.2 defines lexical environments with mutable and immutable bindings.
25 // Immutable bindings have two states, initialized and uninitialized, and
26 // their state is changed by the InitializeImmutableBinding method. The
27 // BindingFlags enum represents information if a binding has definitely been
28 // initialized. A mutable binding does not need to be checked and thus has
29 // the BindingFlag MUTABLE_IS_INITIALIZED.
30 //
31 // There are two possibilities for immutable bindings
32 //  * 'const' declared variables. They are initialized when evaluating the
33 //    corresponding declaration statement. They need to be checked for being
34 //    initialized and thus get the flag IMMUTABLE_CHECK_INITIALIZED.
35 //  * The function name of a named function literal. The binding is immediately
36 //    initialized when entering the function and thus does not need to be
37 //    checked. it gets the BindingFlag IMMUTABLE_IS_INITIALIZED.
38 // Accessing an uninitialized binding produces the undefined value.
39 //
40 // The harmony proposal for block scoped bindings also introduces the
41 // uninitialized state for mutable bindings.
42 //  * A 'let' declared variable. They are initialized when evaluating the
43 //    corresponding declaration statement. They need to be checked for being
44 //    initialized and thus get the flag MUTABLE_CHECK_INITIALIZED.
45 //  * A 'var' declared variable. It is initialized immediately upon creation
46 //    and thus doesn't need to be checked. It gets the flag
47 //    MUTABLE_IS_INITIALIZED.
48 //  * Catch bound variables, function parameters and variables introduced by
49 //    function declarations are initialized immediately and do not need to be
50 //    checked. Thus they get the flag MUTABLE_IS_INITIALIZED.
51 // Immutable bindings in harmony mode get the _HARMONY flag variants. Accessing
52 // an uninitialized binding produces a reference error.
53 //
54 // In V8 uninitialized bindings are set to the hole value upon creation and set
55 // to a different value upon initialization.
56 enum BindingFlags {
57   MUTABLE_IS_INITIALIZED,
58   MUTABLE_CHECK_INITIALIZED,
59   IMMUTABLE_IS_INITIALIZED,
60   IMMUTABLE_CHECK_INITIALIZED,
61   IMMUTABLE_IS_INITIALIZED_HARMONY,
62   IMMUTABLE_CHECK_INITIALIZED_HARMONY,
63   MISSING_BINDING
64 };
65
66
67 // Heap-allocated activation contexts.
68 //
69 // Contexts are implemented as FixedArray objects; the Context
70 // class is a convenience interface casted on a FixedArray object.
71 //
72 // Note: Context must have no virtual functions and Context objects
73 // must always be allocated via Heap::AllocateContext() or
74 // Factory::NewContext.
75
76 #define NATIVE_CONTEXT_INTRINSIC_FUNCTIONS(V)                             \
77   V(CONCAT_ITERABLE_TO_ARRAY_INDEX, JSFunction, concat_iterable_to_array) \
78   V(GET_TEMPLATE_CALL_SITE_INDEX, JSFunction, get_template_call_site)     \
79   V(MAKE_RANGE_ERROR_INDEX, JSFunction, make_range_error)                 \
80   V(MAKE_TYPE_ERROR_INDEX, JSFunction, make_type_error)                   \
81   V(NON_NUMBER_TO_NUMBER_INDEX, JSFunction, non_number_to_number)         \
82   V(NON_STRING_TO_STRING_INDEX, JSFunction, non_string_to_string)         \
83   V(REFLECT_APPLY_INDEX, JSFunction, reflect_apply)                       \
84   V(REFLECT_CONSTRUCT_INDEX, JSFunction, reflect_construct)               \
85   V(SPREAD_ARGUMENTS_INDEX, JSFunction, spread_arguments)                 \
86   V(SPREAD_ITERABLE_INDEX, JSFunction, spread_iterable)                   \
87   V(TO_LENGTH_FUN_INDEX, JSFunction, to_length_fun)                       \
88   V(TO_NUMBER_FUN_INDEX, JSFunction, to_number_fun)                       \
89   V(TO_PRIMITIVE_INDEX, JSFunction, to_primitive)                         \
90   V(TO_STRING_FUN_INDEX, JSFunction, to_string_fun)
91
92
93 #define NATIVE_CONTEXT_JS_BUILTINS(V)                                   \
94   V(APPLY_PREPARE_BUILTIN_INDEX, JSFunction, apply_prepare_builtin)     \
95   V(COMPARE_BUILTIN_INDEX, JSFunction, compare_builtin)                 \
96   V(COMPARE_STRONG_BUILTIN_INDEX, JSFunction, compare_strong_builtin)   \
97   V(CONCAT_ITERABLE_TO_ARRAY_BUILTIN_INDEX, JSFunction,                 \
98     concat_iterable_to_array_builtin)                                   \
99   V(EQUALS_BUILTIN_INDEX, JSFunction, equals_builtin)                   \
100   V(REFLECT_APPLY_PREPARE_BUILTIN_INDEX, JSFunction,                    \
101     reflect_apply_prepare_builtin)                                      \
102   V(REFLECT_CONSTRUCT_PREPARE_BUILTIN_INDEX, JSFunction,                \
103     reflect_construct_prepare_builtin)                                  \
104   V(STRING_ADD_LEFT_BUILTIN_INDEX, JSFunction, string_add_left_builtin) \
105   V(STRING_ADD_RIGHT_BUILTIN_INDEX, JSFunction, string_add_right_builtin)
106
107
108 #define NATIVE_CONTEXT_IMPORTED_FIELDS(V)                                     \
109   V(ARRAY_CONCAT_INDEX, JSFunction, array_concat)                             \
110   V(ARRAY_POP_INDEX, JSFunction, array_pop)                                   \
111   V(ARRAY_PUSH_INDEX, JSFunction, array_push)                                 \
112   V(ARRAY_SHIFT_INDEX, JSFunction, array_shift)                               \
113   V(ARRAY_SPLICE_INDEX, JSFunction, array_splice)                             \
114   V(ARRAY_SLICE_INDEX, JSFunction, array_slice)                               \
115   V(ARRAY_UNSHIFT_INDEX, JSFunction, array_unshift)                           \
116   V(ARRAY_VALUES_ITERATOR_INDEX, JSFunction, array_values_iterator)           \
117   V(CREATE_DATE_FUN_INDEX, JSFunction, create_date_fun)                       \
118   V(DERIVED_GET_TRAP_INDEX, JSFunction, derived_get_trap)                     \
119   V(DERIVED_HAS_TRAP_INDEX, JSFunction, derived_has_trap)                     \
120   V(DERIVED_SET_TRAP_INDEX, JSFunction, derived_set_trap)                     \
121   V(ERROR_FUNCTION_INDEX, JSFunction, error_function)                         \
122   V(EVAL_ERROR_FUNCTION_INDEX, JSFunction, eval_error_function)               \
123   V(GET_STACK_TRACE_LINE_INDEX, JSFunction, get_stack_trace_line_fun)         \
124   V(GLOBAL_EVAL_FUN_INDEX, JSFunction, global_eval_fun)                       \
125   V(JSON_SERIALIZE_ADAPTER_INDEX, JSFunction, json_serialize_adapter)         \
126   V(MAKE_ERROR_FUNCTION_INDEX, JSFunction, make_error_function)               \
127   V(MAP_DELETE_METHOD_INDEX, JSFunction, map_delete)                          \
128   V(MAP_FROM_ARRAY_INDEX, JSFunction, map_from_array)                         \
129   V(MAP_GET_METHOD_INDEX, JSFunction, map_get)                                \
130   V(MAP_HAS_METHOD_INDEX, JSFunction, map_has)                                \
131   V(MAP_SET_METHOD_INDEX, JSFunction, map_set)                                \
132   V(MESSAGE_GET_COLUMN_NUMBER_INDEX, JSFunction, message_get_column_number)   \
133   V(MESSAGE_GET_LINE_NUMBER_INDEX, JSFunction, message_get_line_number)       \
134   V(MESSAGE_GET_SOURCE_LINE_INDEX, JSFunction, message_get_source_line)       \
135   V(NATIVE_OBJECT_GET_NOTIFIER_INDEX, JSFunction, native_object_get_notifier) \
136   V(NATIVE_OBJECT_NOTIFIER_PERFORM_CHANGE, JSFunction,                        \
137     native_object_notifier_perform_change)                                    \
138   V(NATIVE_OBJECT_OBSERVE_INDEX, JSFunction, native_object_observe)           \
139   V(NO_SIDE_EFFECT_TO_STRING_FUN_INDEX, JSFunction,                           \
140     no_side_effect_to_string_fun)                                             \
141   V(OBJECT_DEFINE_OWN_PROPERTY_INDEX, JSFunction, object_define_own_property) \
142   V(OBJECT_GET_OWN_PROPERTY_DESCROPTOR_INDEX, JSFunction,                     \
143     object_get_own_property_descriptor)                                       \
144   V(OBSERVERS_BEGIN_SPLICE_INDEX, JSFunction, observers_begin_perform_splice) \
145   V(OBSERVERS_END_SPLICE_INDEX, JSFunction, observers_end_perform_splice)     \
146   V(OBSERVERS_ENQUEUE_SPLICE_INDEX, JSFunction, observers_enqueue_splice)     \
147   V(OBSERVERS_NOTIFY_CHANGE_INDEX, JSFunction, observers_notify_change)       \
148   V(PROMISE_CATCH_INDEX, JSFunction, promise_catch)                           \
149   V(PROMISE_CHAIN_INDEX, JSFunction, promise_chain)                           \
150   V(PROMISE_CREATE_INDEX, JSFunction, promise_create)                         \
151   V(PROMISE_HAS_USER_DEFINED_REJECT_HANDLER_INDEX, JSFunction,                \
152     promise_has_user_defined_reject_handler)                                  \
153   V(PROMISE_REJECT_INDEX, JSFunction, promise_reject)                         \
154   V(PROMISE_RESOLVE_INDEX, JSFunction, promise_resolve)                       \
155   V(PROMISE_THEN_INDEX, JSFunction, promise_then)                             \
156   V(PROXY_ENUMERATE_INDEX, JSFunction, proxy_enumerate)                       \
157   V(RANGE_ERROR_FUNCTION_INDEX, JSFunction, range_error_function)             \
158   V(REFERENCE_ERROR_FUNCTION_INDEX, JSFunction, reference_error_function)     \
159   V(SET_ADD_METHOD_INDEX, JSFunction, set_add)                                \
160   V(SET_DELETE_METHOD_INDEX, JSFunction, set_delete)                          \
161   V(SET_FROM_ARRAY_INDEX, JSFunction, set_from_array)                         \
162   V(SET_HAS_METHOD_INDEX, JSFunction, set_has)                                \
163   V(STACK_OVERFLOW_BOILERPLATE_INDEX, JSObject, stack_overflow_boilerplate)   \
164   V(SYNTAX_ERROR_FUNCTION_INDEX, JSFunction, syntax_error_function)           \
165   V(TO_COMPLETE_PROPERTY_DESCRIPTOR_INDEX, JSFunction,                        \
166     to_complete_property_descriptor)                                          \
167   V(TO_DETAIL_STRING_FUN_INDEX, JSFunction, to_detail_string_fun)             \
168   V(TO_INTEGER_FUN_INDEX, JSFunction, to_integer_fun)                         \
169   V(TYPE_ERROR_FUNCTION_INDEX, JSFunction, type_error_function)               \
170   V(URI_ERROR_FUNCTION_INDEX, JSFunction, uri_error_function)                 \
171   NATIVE_CONTEXT_JS_BUILTINS(V)
172
173 #define NATIVE_CONTEXT_FIELDS(V)                                               \
174   V(GLOBAL_PROXY_INDEX, JSObject, global_proxy_object)                         \
175   V(EMBEDDER_DATA_INDEX, FixedArray, embedder_data)                            \
176   /* Below is alpha-sorted */                                                  \
177   V(ALLOW_CODE_GEN_FROM_STRINGS_INDEX, Object, allow_code_gen_from_strings)    \
178   V(ARRAY_BUFFER_FUN_INDEX, JSFunction, array_buffer_fun)                      \
179   V(ARRAY_BUFFER_MAP_INDEX, Map, array_buffer_map)                             \
180   V(ARRAY_FUNCTION_INDEX, JSFunction, array_function)                          \
181   V(BOOL16X8_FUNCTION_INDEX, JSFunction, bool16x8_function)                    \
182   V(BOOL32X4_FUNCTION_INDEX, JSFunction, bool32x4_function)                    \
183   V(BOOL8X16_FUNCTION_INDEX, JSFunction, bool8x16_function)                    \
184   V(BOOLEAN_FUNCTION_INDEX, JSFunction, boolean_function)                      \
185   V(BOUND_FUNCTION_MAP_INDEX, Map, bound_function_map)                         \
186   V(CALL_AS_CONSTRUCTOR_DELEGATE_INDEX, JSFunction,                            \
187     call_as_constructor_delegate)                                              \
188   V(CALL_AS_FUNCTION_DELEGATE_INDEX, JSFunction, call_as_function_delegate)    \
189   V(CONTEXT_EXTENSION_FUNCTION_INDEX, JSFunction, context_extension_function)  \
190   V(DATA_VIEW_FUN_INDEX, JSFunction, data_view_fun)                            \
191   V(ERROR_MESSAGE_FOR_CODE_GEN_FROM_STRINGS_INDEX, Object,                     \
192     error_message_for_code_gen_from_strings)                                   \
193   V(EXTRAS_EXPORTS_OBJECT_INDEX, JSObject, extras_binding_object)              \
194   V(FAST_ALIASED_ARGUMENTS_MAP_INDEX, Map, fast_aliased_arguments_map)         \
195   V(FLOAT32_ARRAY_FUN_INDEX, JSFunction, float32_array_fun)                    \
196   V(FLOAT32X4_FUNCTION_INDEX, JSFunction, float32x4_function)                  \
197   V(FLOAT64_ARRAY_FUN_INDEX, JSFunction, float64_array_fun)                    \
198   V(FUNCTION_CACHE_INDEX, ObjectHashTable, function_cache)                     \
199   V(GENERATOR_OBJECT_PROTOTYPE_MAP_INDEX, Map, generator_object_prototype_map) \
200   V(INITIAL_ARRAY_PROTOTYPE_INDEX, JSObject, initial_array_prototype)          \
201   V(INITIAL_OBJECT_PROTOTYPE_INDEX, JSObject, initial_object_prototype)        \
202   V(INT16_ARRAY_FUN_INDEX, JSFunction, int16_array_fun)                        \
203   V(INT16X8_FUNCTION_INDEX, JSFunction, int16x8_function)                      \
204   V(INT32_ARRAY_FUN_INDEX, JSFunction, int32_array_fun)                        \
205   V(INT32X4_FUNCTION_INDEX, JSFunction, int32x4_function)                      \
206   V(INT8_ARRAY_FUN_INDEX, JSFunction, int8_array_fun)                          \
207   V(INT8X16_FUNCTION_INDEX, JSFunction, int8x16_function)                      \
208   V(INTERNAL_ARRAY_FUNCTION_INDEX, JSFunction, internal_array_function)        \
209   V(ITERATOR_RESULT_MAP_INDEX, Map, iterator_result_map)                       \
210   V(JS_ARRAY_MAPS_INDEX, Object, js_array_maps)                                \
211   V(JS_ARRAY_STRONG_MAPS_INDEX, Object, js_array_strong_maps)                  \
212   V(JS_MAP_FUN_INDEX, JSFunction, js_map_fun)                                  \
213   V(JS_MAP_MAP_INDEX, Map, js_map_map)                                         \
214   V(JS_OBJECT_STRONG_MAP_INDEX, Map, js_object_strong_map)                     \
215   V(JS_SET_FUN_INDEX, JSFunction, js_set_fun)                                  \
216   V(JS_SET_MAP_INDEX, Map, js_set_map)                                         \
217   V(MAP_CACHE_INDEX, Object, map_cache)                                        \
218   V(MAP_ITERATOR_MAP_INDEX, Map, map_iterator_map)                             \
219   V(STRING_ITERATOR_MAP_INDEX, Map, string_iterator_map)                       \
220   V(MESSAGE_LISTENERS_INDEX, JSObject, message_listeners)                      \
221   V(NATIVES_UTILS_OBJECT_INDEX, Object, natives_utils_object)                  \
222   V(NORMALIZED_MAP_CACHE_INDEX, Object, normalized_map_cache)                  \
223   V(NUMBER_FUNCTION_INDEX, JSFunction, number_function)                        \
224   V(OBJECT_FUNCTION_INDEX, JSFunction, object_function)                        \
225   V(OPAQUE_REFERENCE_FUNCTION_INDEX, JSFunction, opaque_reference_function)    \
226   V(REGEXP_FUNCTION_INDEX, JSFunction, regexp_function)                        \
227   V(REGEXP_RESULT_MAP_INDEX, Map, regexp_result_map)                           \
228   V(RUNTIME_CONTEXT_INDEX, Context, runtime_context)                           \
229   V(SCRIPT_CONTEXT_TABLE_INDEX, ScriptContextTable, script_context_table)      \
230   V(SCRIPT_FUNCTION_INDEX, JSFunction, script_function)                        \
231   V(SECURITY_TOKEN_INDEX, Object, security_token)                              \
232   V(SET_ITERATOR_MAP_INDEX, Map, set_iterator_map)                             \
233   V(SHARED_ARRAY_BUFFER_FUN_INDEX, JSFunction, shared_array_buffer_fun)        \
234   V(SLOPPY_ARGUMENTS_MAP_INDEX, Map, sloppy_arguments_map)                     \
235   V(SLOPPY_FUNCTION_MAP_INDEX, Map, sloppy_function_map)                       \
236   V(SLOPPY_FUNCTION_WITHOUT_PROTOTYPE_MAP_INDEX, Map,                          \
237     sloppy_function_without_prototype_map)                                     \
238   V(SLOPPY_FUNCTION_WITH_READONLY_PROTOTYPE_MAP_INDEX, Map,                    \
239     sloppy_function_with_readonly_prototype_map)                               \
240   V(SLOPPY_GENERATOR_FUNCTION_MAP_INDEX, Map, sloppy_generator_function_map)   \
241   V(SLOW_ALIASED_ARGUMENTS_MAP_INDEX, Map, slow_aliased_arguments_map)         \
242   V(STRICT_ARGUMENTS_MAP_INDEX, Map, strict_arguments_map)                     \
243   V(STRICT_FUNCTION_MAP_INDEX, Map, strict_function_map)                       \
244   V(STRICT_FUNCTION_WITHOUT_PROTOTYPE_MAP_INDEX, Map,                          \
245     strict_function_without_prototype_map)                                     \
246   V(STRICT_GENERATOR_FUNCTION_MAP_INDEX, Map, strict_generator_function_map)   \
247   V(STRING_FUNCTION_INDEX, JSFunction, string_function)                        \
248   V(STRING_FUNCTION_PROTOTYPE_MAP_INDEX, Map, string_function_prototype_map)   \
249   V(STRONG_CONSTRUCTOR_MAP_INDEX, Map, strong_constructor_map)                 \
250   V(STRONG_FUNCTION_MAP_INDEX, Map, strong_function_map)                       \
251   V(STRONG_GENERATOR_FUNCTION_MAP_INDEX, Map, strong_generator_function_map)   \
252   V(STRONG_MAP_CACHE_INDEX, Object, strong_map_cache)                          \
253   V(SYMBOL_FUNCTION_INDEX, JSFunction, symbol_function)                        \
254   V(UINT16_ARRAY_FUN_INDEX, JSFunction, uint16_array_fun)                      \
255   V(UINT16X8_FUNCTION_INDEX, JSFunction, uint16x8_function)                    \
256   V(UINT32_ARRAY_FUN_INDEX, JSFunction, uint32_array_fun)                      \
257   V(UINT32X4_FUNCTION_INDEX, JSFunction, uint32x4_function)                    \
258   V(UINT8_ARRAY_FUN_INDEX, JSFunction, uint8_array_fun)                        \
259   V(UINT8_CLAMPED_ARRAY_FUN_INDEX, JSFunction, uint8_clamped_array_fun)        \
260   V(UINT8X16_FUNCTION_INDEX, JSFunction, uint8x16_function)                    \
261   NATIVE_CONTEXT_INTRINSIC_FUNCTIONS(V)                                        \
262   NATIVE_CONTEXT_IMPORTED_FIELDS(V)
263
264 // A table of all script contexts. Every loaded top-level script with top-level
265 // lexical declarations contributes its ScriptContext into this table.
266 //
267 // The table is a fixed array, its first slot is the current used count and
268 // the subsequent slots 1..used contain ScriptContexts.
269 class ScriptContextTable : public FixedArray {
270  public:
271   // Conversions.
272   static inline ScriptContextTable* cast(Object* context);
273
274   struct LookupResult {
275     int context_index;
276     int slot_index;
277     VariableMode mode;
278     InitializationFlag init_flag;
279     MaybeAssignedFlag maybe_assigned_flag;
280   };
281
282   inline int used() const;
283   inline void set_used(int used);
284
285   static inline Handle<Context> GetContext(Handle<ScriptContextTable> table,
286                                            int i);
287
288   // Lookup a variable `name` in a ScriptContextTable.
289   // If it returns true, the variable is found and `result` contains
290   // valid information about its location.
291   // If it returns false, `result` is untouched.
292   MUST_USE_RESULT
293   static bool Lookup(Handle<ScriptContextTable> table, Handle<String> name,
294                      LookupResult* result);
295
296   MUST_USE_RESULT
297   static Handle<ScriptContextTable> Extend(Handle<ScriptContextTable> table,
298                                            Handle<Context> script_context);
299
300   static int GetContextOffset(int context_index) {
301     return kFirstContextOffset + context_index * kPointerSize;
302   }
303
304  private:
305   static const int kUsedSlot = 0;
306   static const int kFirstContextSlot = kUsedSlot + 1;
307   static const int kFirstContextOffset =
308       FixedArray::kHeaderSize + kFirstContextSlot * kPointerSize;
309
310   DISALLOW_IMPLICIT_CONSTRUCTORS(ScriptContextTable);
311 };
312
313 // JSFunctions are pairs (context, function code), sometimes also called
314 // closures. A Context object is used to represent function contexts and
315 // dynamically pushed 'with' contexts (or 'scopes' in ECMA-262 speak).
316 //
317 // At runtime, the contexts build a stack in parallel to the execution
318 // stack, with the top-most context being the current context. All contexts
319 // have the following slots:
320 //
321 // [ closure   ]  This is the current function. It is the same for all
322 //                contexts inside a function. It provides access to the
323 //                incoming context (i.e., the outer context, which may
324 //                or may not become the current function's context), and
325 //                it provides access to the functions code and thus it's
326 //                scope information, which in turn contains the names of
327 //                statically allocated context slots. The names are needed
328 //                for dynamic lookups in the presence of 'with' or 'eval'.
329 //
330 // [ previous  ]  A pointer to the previous context. It is NULL for
331 //                function contexts, and non-NULL for 'with' contexts.
332 //                Used to implement the 'with' statement.
333 //
334 // [ extension ]  A pointer to an extension JSObject, or NULL. Used to
335 //                implement 'with' statements and dynamic declarations
336 //                (through 'eval'). The object in a 'with' statement is
337 //                stored in the extension slot of a 'with' context.
338 //                Dynamically declared variables/functions are also added
339 //                to lazily allocated extension object. Context::Lookup
340 //                searches the extension object for properties.
341 //                For script and block contexts, contains the respective
342 //                ScopeInfo. For block contexts representing sloppy declaration
343 //                block scopes, it may also be a struct being a
344 //                SloppyBlockWithEvalContextExtension, pairing the ScopeInfo
345 //                with an extension object.
346 //                For module contexts, points back to the respective JSModule.
347 //
348 // [ global_object ]  A pointer to the global object. Provided for quick
349 //                access to the global object from inside the code (since
350 //                we always have a context pointer).
351 //
352 // In addition, function contexts may have statically allocated context slots
353 // to store local variables/functions that are accessed from inner functions
354 // (via static context addresses) or through 'eval' (dynamic context lookups).
355 // The native context contains additional slots for fast access to native
356 // properties.
357 //
358 // Finally, with Harmony scoping, the JSFunction representing a top level
359 // script will have the ScriptContext rather than a FunctionContext.
360 // Script contexts from all top-level scripts are gathered in
361 // ScriptContextTable.
362
363 class Context: public FixedArray {
364  public:
365   // Conversions.
366   static inline Context* cast(Object* context);
367
368   // The default context slot layout; indices are FixedArray slot indices.
369   enum {
370     // These slots are in all contexts.
371     CLOSURE_INDEX,
372     PREVIOUS_INDEX,
373     // The extension slot is used for either the global object (in global
374     // contexts), eval extension object (function contexts), subject of with
375     // (with contexts), or the variable name (catch contexts), the serialized
376     // scope info (block contexts), or the module instance (module contexts).
377     EXTENSION_INDEX,
378     GLOBAL_OBJECT_INDEX,
379
380     // These slots are only in native contexts.
381 #define NATIVE_CONTEXT_SLOT(index, type, name) index,
382     NATIVE_CONTEXT_FIELDS(NATIVE_CONTEXT_SLOT)
383 #undef NATIVE_CONTEXT_SLOT
384
385     // Properties from here are treated as weak references by the full GC.
386     // Scavenge treats them as strong references.
387     OPTIMIZED_FUNCTIONS_LIST,  // Weak.
388     OPTIMIZED_CODE_LIST,       // Weak.
389     DEOPTIMIZED_CODE_LIST,     // Weak.
390     NEXT_CONTEXT_LINK,         // Weak.
391
392     // Total number of slots.
393     NATIVE_CONTEXT_SLOTS,
394     FIRST_WEAK_SLOT = OPTIMIZED_FUNCTIONS_LIST,
395
396     MIN_CONTEXT_SLOTS = GLOBAL_PROXY_INDEX,
397     // This slot holds the thrown value in catch contexts.
398     THROWN_OBJECT_INDEX = MIN_CONTEXT_SLOTS,
399   };
400
401   // Direct slot access.
402   inline JSFunction* closure();
403   inline void set_closure(JSFunction* closure);
404
405   inline Context* previous();
406   inline void set_previous(Context* context);
407
408   inline bool has_extension();
409   inline Object* extension();
410   inline void set_extension(Object* object);
411   JSObject* extension_object();
412   JSReceiver* extension_receiver();
413   ScopeInfo* scope_info();
414   String* catch_name();
415
416   inline JSModule* module();
417   inline void set_module(JSModule* module);
418
419   // Get the context where var declarations will be hoisted to, which
420   // may be the context itself.
421   Context* declaration_context();
422   bool is_declaration_context();
423
424   inline GlobalObject* global_object();
425   inline void set_global_object(GlobalObject* object);
426
427   // Returns a JSGlobalProxy object or null.
428   JSObject* global_proxy();
429   void set_global_proxy(JSObject* global);
430
431   // The builtins object.
432   JSBuiltinsObject* builtins();
433
434   // Get the script context by traversing the context chain.
435   Context* script_context();
436
437   // Compute the native context by traversing the context chain.
438   Context* native_context();
439
440   // Predicates for context types.  IsNativeContext is also defined on Object
441   // because we frequently have to know if arbitrary objects are natives
442   // contexts.
443   inline bool IsNativeContext();
444   inline bool IsFunctionContext();
445   inline bool IsCatchContext();
446   inline bool IsWithContext();
447   inline bool IsBlockContext();
448   inline bool IsModuleContext();
449   inline bool IsScriptContext();
450
451   inline bool HasSameSecurityTokenAs(Context* that);
452
453   // Initializes global variable bindings in given script context.
454   void InitializeGlobalSlots();
455
456   // A native context holds a list of all functions with optimized code.
457   void AddOptimizedFunction(JSFunction* function);
458   void RemoveOptimizedFunction(JSFunction* function);
459   void SetOptimizedFunctionsListHead(Object* head);
460   Object* OptimizedFunctionsListHead();
461
462   // The native context also stores a list of all optimized code and a
463   // list of all deoptimized code, which are needed by the deoptimizer.
464   void AddOptimizedCode(Code* code);
465   void SetOptimizedCodeListHead(Object* head);
466   Object* OptimizedCodeListHead();
467   void SetDeoptimizedCodeListHead(Object* head);
468   Object* DeoptimizedCodeListHead();
469
470   Handle<Object> ErrorMessageForCodeGenerationFromStrings();
471
472   static int ImportedFieldIndexForName(Handle<String> name);
473   static int IntrinsicIndexForName(Handle<String> name);
474
475   static bool IsJSBuiltin(Handle<Context> native_context,
476                           Handle<JSFunction> function);
477
478 #define NATIVE_CONTEXT_FIELD_ACCESSORS(index, type, name) \
479   inline void set_##name(type* value);                    \
480   inline bool is_##name(type* value);                     \
481   inline type* name();
482   NATIVE_CONTEXT_FIELDS(NATIVE_CONTEXT_FIELD_ACCESSORS)
483 #undef NATIVE_CONTEXT_FIELD_ACCESSORS
484
485   // Lookup the slot called name, starting with the current context.
486   // There are three possibilities:
487   //
488   // 1) result->IsContext():
489   //    The binding was found in a context.  *index is always the
490   //    non-negative slot index.  *attributes is NONE for var and let
491   //    declarations, READ_ONLY for const declarations (never ABSENT).
492   //
493   // 2) result->IsJSObject():
494   //    The binding was found as a named property in a context extension
495   //    object (i.e., was introduced via eval), as a property on the subject
496   //    of with, or as a property of the global object.  *index is -1 and
497   //    *attributes is not ABSENT.
498   //
499   // 3) result.is_null():
500   //    There was no binding found, *index is always -1 and *attributes is
501   //    always ABSENT.
502   Handle<Object> Lookup(Handle<String> name,
503                         ContextLookupFlags flags,
504                         int* index,
505                         PropertyAttributes* attributes,
506                         BindingFlags* binding_flags);
507
508   // Code generation support.
509   static int SlotOffset(int index) {
510     return kHeaderSize + index * kPointerSize - kHeapObjectTag;
511   }
512
513   static int FunctionMapIndex(LanguageMode language_mode, FunctionKind kind) {
514     if (IsGeneratorFunction(kind)) {
515       return is_strong(language_mode) ? STRONG_GENERATOR_FUNCTION_MAP_INDEX :
516              is_strict(language_mode) ? STRICT_GENERATOR_FUNCTION_MAP_INDEX
517                                       : SLOPPY_GENERATOR_FUNCTION_MAP_INDEX;
518     }
519
520     if (IsConstructor(kind)) {
521       // Use strict function map (no own "caller" / "arguments")
522       return is_strong(language_mode) ? STRONG_CONSTRUCTOR_MAP_INDEX
523                                       : STRICT_FUNCTION_MAP_INDEX;
524     }
525
526     if (IsArrowFunction(kind) || IsConciseMethod(kind) ||
527         IsAccessorFunction(kind)) {
528       return is_strong(language_mode)
529                  ? STRONG_FUNCTION_MAP_INDEX
530                  : STRICT_FUNCTION_WITHOUT_PROTOTYPE_MAP_INDEX;
531     }
532
533     return is_strong(language_mode) ? STRONG_FUNCTION_MAP_INDEX :
534            is_strict(language_mode) ? STRICT_FUNCTION_MAP_INDEX
535                                     : SLOPPY_FUNCTION_MAP_INDEX;
536   }
537
538   static const int kSize = kHeaderSize + NATIVE_CONTEXT_SLOTS * kPointerSize;
539   static const int kNotFound = -1;
540
541   // GC support.
542   typedef FixedBodyDescriptor<
543       kHeaderSize, kSize, kSize> ScavengeBodyDescriptor;
544
545   typedef FixedBodyDescriptor<
546       kHeaderSize,
547       kHeaderSize + FIRST_WEAK_SLOT * kPointerSize,
548       kSize> MarkCompactBodyDescriptor;
549
550  private:
551 #ifdef DEBUG
552   // Bootstrapping-aware type checks.
553   static bool IsBootstrappingOrValidParentContext(Object* object, Context* kid);
554   static bool IsBootstrappingOrGlobalObject(Isolate* isolate, Object* object);
555 #endif
556
557   STATIC_ASSERT(kHeaderSize == Internals::kContextHeaderSize);
558   STATIC_ASSERT(EMBEDDER_DATA_INDEX == Internals::kContextEmbedderDataIndex);
559 };
560
561 } }  // namespace v8::internal
562
563 #endif  // V8_CONTEXTS_H_