blob: f9a5a13bd991be564a573efe7c880924aae5e514 [file] [log] [blame]
Ben Murdoch257744e2011-11-30 15:57:28 +00001// Copyright 2011 the V8 project authors. All rights reserved.
Steve Blocka7e24c12009-10-30 11:49:00 +00002// Redistribution and use in source and binary forms, with or without
3// modification, are permitted provided that the following conditions are
4// met:
5//
6// * Redistributions of source code must retain the above copyright
7// notice, this list of conditions and the following disclaimer.
8// * Redistributions in binary form must reproduce the above
9// copyright notice, this list of conditions and the following
10// disclaimer in the documentation and/or other materials provided
11// with the distribution.
12// * Neither the name of Google Inc. nor the names of its
13// contributors may be used to endorse or promote products derived
14// from this software without specific prior written permission.
15//
16// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
28#ifndef V8_BUILTINS_H_
29#define V8_BUILTINS_H_
30
31namespace v8 {
32namespace internal {
33
Leon Clarkee46be812010-01-19 14:06:41 +000034// Specifies extra arguments required by a C++ builtin.
35enum BuiltinExtraArguments {
36 NO_EXTRA_ARGUMENTS = 0,
37 NEEDS_CALLED_FUNCTION = 1
38};
39
40
41// Define list of builtins implemented in C++.
42#define BUILTIN_LIST_C(V) \
43 V(Illegal, NO_EXTRA_ARGUMENTS) \
44 \
45 V(EmptyFunction, NO_EXTRA_ARGUMENTS) \
46 \
47 V(ArrayCodeGeneric, NO_EXTRA_ARGUMENTS) \
48 \
49 V(ArrayPush, NO_EXTRA_ARGUMENTS) \
50 V(ArrayPop, NO_EXTRA_ARGUMENTS) \
Andrei Popescu402d9372010-02-26 13:31:12 +000051 V(ArrayShift, NO_EXTRA_ARGUMENTS) \
52 V(ArrayUnshift, NO_EXTRA_ARGUMENTS) \
53 V(ArraySlice, NO_EXTRA_ARGUMENTS) \
54 V(ArraySplice, NO_EXTRA_ARGUMENTS) \
Steve Block6ded16b2010-05-10 14:33:55 +010055 V(ArrayConcat, NO_EXTRA_ARGUMENTS) \
Leon Clarkee46be812010-01-19 14:06:41 +000056 \
57 V(HandleApiCall, NEEDS_CALLED_FUNCTION) \
Andrei Popescu402d9372010-02-26 13:31:12 +000058 V(FastHandleApiCall, NO_EXTRA_ARGUMENTS) \
Leon Clarkee46be812010-01-19 14:06:41 +000059 V(HandleApiCallConstruct, NEEDS_CALLED_FUNCTION) \
60 V(HandleApiCallAsFunction, NO_EXTRA_ARGUMENTS) \
Steve Block44f0eee2011-05-26 01:26:41 +010061 V(HandleApiCallAsConstructor, NO_EXTRA_ARGUMENTS) \
62 \
Ben Murdoch257744e2011-11-30 15:57:28 +000063 V(StrictModePoisonPill, NO_EXTRA_ARGUMENTS)
Steve Blocka7e24c12009-10-30 11:49:00 +000064
65// Define list of builtins implemented in assembly.
Ben Murdoch257744e2011-11-30 15:57:28 +000066#define BUILTIN_LIST_A(V) \
67 V(ArgumentsAdaptorTrampoline, BUILTIN, UNINITIALIZED, \
68 Code::kNoExtraICState) \
69 V(JSConstructCall, BUILTIN, UNINITIALIZED, \
70 Code::kNoExtraICState) \
71 V(JSConstructStubCountdown, BUILTIN, UNINITIALIZED, \
72 Code::kNoExtraICState) \
73 V(JSConstructStubGeneric, BUILTIN, UNINITIALIZED, \
74 Code::kNoExtraICState) \
75 V(JSConstructStubApi, BUILTIN, UNINITIALIZED, \
76 Code::kNoExtraICState) \
77 V(JSEntryTrampoline, BUILTIN, UNINITIALIZED, \
78 Code::kNoExtraICState) \
79 V(JSConstructEntryTrampoline, BUILTIN, UNINITIALIZED, \
80 Code::kNoExtraICState) \
81 V(LazyCompile, BUILTIN, UNINITIALIZED, \
82 Code::kNoExtraICState) \
83 V(LazyRecompile, BUILTIN, UNINITIALIZED, \
84 Code::kNoExtraICState) \
85 V(NotifyDeoptimized, BUILTIN, UNINITIALIZED, \
86 Code::kNoExtraICState) \
87 V(NotifyLazyDeoptimized, BUILTIN, UNINITIALIZED, \
88 Code::kNoExtraICState) \
89 V(NotifyOSR, BUILTIN, UNINITIALIZED, \
90 Code::kNoExtraICState) \
91 \
92 V(LoadIC_Miss, BUILTIN, UNINITIALIZED, \
93 Code::kNoExtraICState) \
94 V(KeyedLoadIC_Miss, BUILTIN, UNINITIALIZED, \
95 Code::kNoExtraICState) \
96 V(KeyedLoadIC_MissForceGeneric, BUILTIN, UNINITIALIZED, \
97 Code::kNoExtraICState) \
98 V(KeyedLoadIC_Slow, BUILTIN, UNINITIALIZED, \
99 Code::kNoExtraICState) \
100 V(StoreIC_Miss, BUILTIN, UNINITIALIZED, \
101 Code::kNoExtraICState) \
102 V(KeyedStoreIC_Miss, BUILTIN, UNINITIALIZED, \
103 Code::kNoExtraICState) \
104 V(KeyedStoreIC_MissForceGeneric, BUILTIN, UNINITIALIZED, \
105 Code::kNoExtraICState) \
106 V(KeyedStoreIC_Slow, BUILTIN, UNINITIALIZED, \
107 Code::kNoExtraICState) \
108 V(LoadIC_Initialize, LOAD_IC, UNINITIALIZED, \
109 Code::kNoExtraICState) \
110 V(LoadIC_PreMonomorphic, LOAD_IC, PREMONOMORPHIC, \
111 Code::kNoExtraICState) \
112 V(LoadIC_Normal, LOAD_IC, MONOMORPHIC, \
113 Code::kNoExtraICState) \
114 V(LoadIC_ArrayLength, LOAD_IC, MONOMORPHIC, \
115 Code::kNoExtraICState) \
116 V(LoadIC_StringLength, LOAD_IC, MONOMORPHIC, \
117 Code::kNoExtraICState) \
118 V(LoadIC_StringWrapperLength, LOAD_IC, MONOMORPHIC, \
119 Code::kNoExtraICState) \
120 V(LoadIC_FunctionPrototype, LOAD_IC, MONOMORPHIC, \
121 Code::kNoExtraICState) \
122 V(LoadIC_Megamorphic, LOAD_IC, MEGAMORPHIC, \
123 Code::kNoExtraICState) \
124 \
125 V(KeyedLoadIC_Initialize, KEYED_LOAD_IC, UNINITIALIZED, \
126 Code::kNoExtraICState) \
127 V(KeyedLoadIC_PreMonomorphic, KEYED_LOAD_IC, PREMONOMORPHIC, \
128 Code::kNoExtraICState) \
129 V(KeyedLoadIC_Generic, KEYED_LOAD_IC, MEGAMORPHIC, \
130 Code::kNoExtraICState) \
131 V(KeyedLoadIC_String, KEYED_LOAD_IC, MEGAMORPHIC, \
132 Code::kNoExtraICState) \
133 V(KeyedLoadIC_IndexedInterceptor, KEYED_LOAD_IC, MEGAMORPHIC, \
134 Code::kNoExtraICState) \
Ben Murdoch3fb3ca82011-12-02 17:19:32 +0000135 V(KeyedLoadIC_NonStrictArguments, KEYED_LOAD_IC, MEGAMORPHIC, \
136 Code::kNoExtraICState) \
Ben Murdoch257744e2011-11-30 15:57:28 +0000137 \
138 V(StoreIC_Initialize, STORE_IC, UNINITIALIZED, \
139 Code::kNoExtraICState) \
140 V(StoreIC_ArrayLength, STORE_IC, MONOMORPHIC, \
141 Code::kNoExtraICState) \
142 V(StoreIC_Normal, STORE_IC, MONOMORPHIC, \
143 Code::kNoExtraICState) \
144 V(StoreIC_Megamorphic, STORE_IC, MEGAMORPHIC, \
145 Code::kNoExtraICState) \
146 V(StoreIC_GlobalProxy, STORE_IC, MEGAMORPHIC, \
147 Code::kNoExtraICState) \
148 V(StoreIC_Initialize_Strict, STORE_IC, UNINITIALIZED, \
149 kStrictMode) \
150 V(StoreIC_ArrayLength_Strict, STORE_IC, MONOMORPHIC, \
151 kStrictMode) \
152 V(StoreIC_Normal_Strict, STORE_IC, MONOMORPHIC, \
153 kStrictMode) \
154 V(StoreIC_Megamorphic_Strict, STORE_IC, MEGAMORPHIC, \
155 kStrictMode) \
156 V(StoreIC_GlobalProxy_Strict, STORE_IC, MEGAMORPHIC, \
157 kStrictMode) \
158 \
159 V(KeyedStoreIC_Initialize, KEYED_STORE_IC, UNINITIALIZED, \
160 Code::kNoExtraICState) \
161 V(KeyedStoreIC_Generic, KEYED_STORE_IC, MEGAMORPHIC, \
162 Code::kNoExtraICState) \
163 \
164 V(KeyedStoreIC_Initialize_Strict, KEYED_STORE_IC, UNINITIALIZED, \
165 kStrictMode) \
166 V(KeyedStoreIC_Generic_Strict, KEYED_STORE_IC, MEGAMORPHIC, \
167 kStrictMode) \
Ben Murdoch3fb3ca82011-12-02 17:19:32 +0000168 V(KeyedStoreIC_NonStrictArguments, KEYED_STORE_IC, MEGAMORPHIC, \
169 Code::kNoExtraICState) \
Ben Murdoch257744e2011-11-30 15:57:28 +0000170 \
171 /* Uses KeyedLoadIC_Initialize; must be after in list. */ \
172 V(FunctionCall, BUILTIN, UNINITIALIZED, \
173 Code::kNoExtraICState) \
174 V(FunctionApply, BUILTIN, UNINITIALIZED, \
175 Code::kNoExtraICState) \
176 \
177 V(ArrayCode, BUILTIN, UNINITIALIZED, \
178 Code::kNoExtraICState) \
179 V(ArrayConstructCode, BUILTIN, UNINITIALIZED, \
180 Code::kNoExtraICState) \
181 \
182 V(StringConstructCode, BUILTIN, UNINITIALIZED, \
183 Code::kNoExtraICState) \
184 \
185 V(OnStackReplacement, BUILTIN, UNINITIALIZED, \
Ben Murdoche0cee9b2011-05-25 10:26:03 +0100186 Code::kNoExtraICState)
Kristian Monsen80d68ea2010-09-08 11:05:35 +0100187
Steve Blocka7e24c12009-10-30 11:49:00 +0000188
189#ifdef ENABLE_DEBUGGER_SUPPORT
190// Define list of builtins used by the debugger implemented in assembly.
191#define BUILTIN_LIST_DEBUG_A(V) \
Steve Block1e0659c2011-05-24 12:43:12 +0100192 V(Return_DebugBreak, BUILTIN, DEBUG_BREAK, \
193 Code::kNoExtraICState) \
194 V(ConstructCall_DebugBreak, BUILTIN, DEBUG_BREAK, \
195 Code::kNoExtraICState) \
196 V(StubNoRegisters_DebugBreak, BUILTIN, DEBUG_BREAK, \
197 Code::kNoExtraICState) \
198 V(LoadIC_DebugBreak, LOAD_IC, DEBUG_BREAK, \
199 Code::kNoExtraICState) \
200 V(KeyedLoadIC_DebugBreak, KEYED_LOAD_IC, DEBUG_BREAK, \
201 Code::kNoExtraICState) \
202 V(StoreIC_DebugBreak, STORE_IC, DEBUG_BREAK, \
203 Code::kNoExtraICState) \
204 V(KeyedStoreIC_DebugBreak, KEYED_STORE_IC, DEBUG_BREAK, \
205 Code::kNoExtraICState) \
206 V(Slot_DebugBreak, BUILTIN, DEBUG_BREAK, \
207 Code::kNoExtraICState) \
208 V(PlainReturn_LiveEdit, BUILTIN, DEBUG_BREAK, \
209 Code::kNoExtraICState) \
210 V(FrameDropper_LiveEdit, BUILTIN, DEBUG_BREAK, \
211 Code::kNoExtraICState)
Steve Blocka7e24c12009-10-30 11:49:00 +0000212#else
213#define BUILTIN_LIST_DEBUG_A(V)
214#endif
215
216// Define list of builtins implemented in JavaScript.
217#define BUILTINS_LIST_JS(V) \
218 V(EQUALS, 1) \
219 V(STRICT_EQUALS, 1) \
220 V(COMPARE, 2) \
221 V(ADD, 1) \
222 V(SUB, 1) \
223 V(MUL, 1) \
224 V(DIV, 1) \
225 V(MOD, 1) \
226 V(BIT_OR, 1) \
227 V(BIT_AND, 1) \
228 V(BIT_XOR, 1) \
229 V(UNARY_MINUS, 0) \
230 V(BIT_NOT, 0) \
231 V(SHL, 1) \
232 V(SAR, 1) \
233 V(SHR, 1) \
Ben Murdoche0cee9b2011-05-25 10:26:03 +0100234 V(DELETE, 2) \
Steve Blocka7e24c12009-10-30 11:49:00 +0000235 V(IN, 1) \
236 V(INSTANCE_OF, 1) \
237 V(GET_KEYS, 0) \
238 V(FILTER_KEY, 1) \
239 V(CALL_NON_FUNCTION, 0) \
240 V(CALL_NON_FUNCTION_AS_CONSTRUCTOR, 0) \
241 V(TO_OBJECT, 0) \
242 V(TO_NUMBER, 0) \
243 V(TO_STRING, 0) \
244 V(STRING_ADD_LEFT, 1) \
245 V(STRING_ADD_RIGHT, 1) \
246 V(APPLY_PREPARE, 1) \
Steve Block6ded16b2010-05-10 14:33:55 +0100247 V(APPLY_OVERFLOW, 1)
Steve Blocka7e24c12009-10-30 11:49:00 +0000248
249
Steve Block44f0eee2011-05-26 01:26:41 +0100250class BuiltinFunctionTable;
Steve Blocka7e24c12009-10-30 11:49:00 +0000251class ObjectVisitor;
252
253
Steve Block44f0eee2011-05-26 01:26:41 +0100254class Builtins {
Steve Blocka7e24c12009-10-30 11:49:00 +0000255 public:
Steve Block44f0eee2011-05-26 01:26:41 +0100256 ~Builtins();
257
Steve Blocka7e24c12009-10-30 11:49:00 +0000258 // Generate all builtin code objects. Should be called once during
Steve Block44f0eee2011-05-26 01:26:41 +0100259 // isolate initialization.
260 void Setup(bool create_heap_objects);
261 void TearDown();
Steve Blocka7e24c12009-10-30 11:49:00 +0000262
263 // Garbage collection support.
Steve Block44f0eee2011-05-26 01:26:41 +0100264 void IterateBuiltins(ObjectVisitor* v);
Steve Blocka7e24c12009-10-30 11:49:00 +0000265
266 // Disassembler support.
Steve Block44f0eee2011-05-26 01:26:41 +0100267 const char* Lookup(byte* pc);
Steve Blocka7e24c12009-10-30 11:49:00 +0000268
269 enum Name {
Steve Block44f0eee2011-05-26 01:26:41 +0100270#define DEF_ENUM_C(name, ignore) k##name,
271#define DEF_ENUM_A(name, kind, state, extra) k##name,
Steve Blocka7e24c12009-10-30 11:49:00 +0000272 BUILTIN_LIST_C(DEF_ENUM_C)
273 BUILTIN_LIST_A(DEF_ENUM_A)
274 BUILTIN_LIST_DEBUG_A(DEF_ENUM_A)
275#undef DEF_ENUM_C
276#undef DEF_ENUM_A
277 builtin_count
278 };
279
280 enum CFunctionId {
Leon Clarkee46be812010-01-19 14:06:41 +0000281#define DEF_ENUM_C(name, ignore) c_##name,
Steve Blocka7e24c12009-10-30 11:49:00 +0000282 BUILTIN_LIST_C(DEF_ENUM_C)
283#undef DEF_ENUM_C
284 cfunction_count
285 };
286
287 enum JavaScript {
288#define DEF_ENUM(name, ignore) name,
289 BUILTINS_LIST_JS(DEF_ENUM)
290#undef DEF_ENUM
291 id_count
292 };
293
Steve Block44f0eee2011-05-26 01:26:41 +0100294#define DECLARE_BUILTIN_ACCESSOR_C(name, ignore) Handle<Code> name();
295#define DECLARE_BUILTIN_ACCESSOR_A(name, kind, state, extra) \
296 Handle<Code> name();
297 BUILTIN_LIST_C(DECLARE_BUILTIN_ACCESSOR_C)
298 BUILTIN_LIST_A(DECLARE_BUILTIN_ACCESSOR_A)
299 BUILTIN_LIST_DEBUG_A(DECLARE_BUILTIN_ACCESSOR_A)
300#undef DECLARE_BUILTIN_ACCESSOR_C
301#undef DECLARE_BUILTIN_ACCESSOR_A
302
303 Code* builtin(Name name) {
Steve Blocka7e24c12009-10-30 11:49:00 +0000304 // Code::cast cannot be used here since we access builtins
305 // during the marking phase of mark sweep. See IC::Clear.
306 return reinterpret_cast<Code*>(builtins_[name]);
307 }
308
Steve Block44f0eee2011-05-26 01:26:41 +0100309 Address builtin_address(Name name) {
Steve Blocka7e24c12009-10-30 11:49:00 +0000310 return reinterpret_cast<Address>(&builtins_[name]);
311 }
312
313 static Address c_function_address(CFunctionId id) {
314 return c_functions_[id];
315 }
316
317 static const char* GetName(JavaScript id) { return javascript_names_[id]; }
318 static int GetArgumentsCount(JavaScript id) { return javascript_argc_[id]; }
Steve Block44f0eee2011-05-26 01:26:41 +0100319 Handle<Code> GetCode(JavaScript id, bool* resolved);
Steve Blocka7e24c12009-10-30 11:49:00 +0000320 static int NumberOfJavaScriptBuiltins() { return id_count; }
321
Steve Block44f0eee2011-05-26 01:26:41 +0100322 bool is_initialized() const { return initialized_; }
323
Steve Blocka7e24c12009-10-30 11:49:00 +0000324 private:
Steve Block44f0eee2011-05-26 01:26:41 +0100325 Builtins();
326
Steve Blocka7e24c12009-10-30 11:49:00 +0000327 // The external C++ functions called from the code.
Steve Block44f0eee2011-05-26 01:26:41 +0100328 static Address const c_functions_[cfunction_count];
Steve Blocka7e24c12009-10-30 11:49:00 +0000329
330 // Note: These are always Code objects, but to conform with
331 // IterateBuiltins() above which assumes Object**'s for the callback
332 // function f, we use an Object* array here.
Steve Block44f0eee2011-05-26 01:26:41 +0100333 Object* builtins_[builtin_count];
334 const char* names_[builtin_count];
335 static const char* const javascript_names_[id_count];
336 static int const javascript_argc_[id_count];
Steve Blocka7e24c12009-10-30 11:49:00 +0000337
Leon Clarkee46be812010-01-19 14:06:41 +0000338 static void Generate_Adaptor(MacroAssembler* masm,
339 CFunctionId id,
340 BuiltinExtraArguments extra_args);
Steve Blocka7e24c12009-10-30 11:49:00 +0000341 static void Generate_JSConstructCall(MacroAssembler* masm);
Kristian Monsen0d5e1162010-09-30 15:31:59 +0100342 static void Generate_JSConstructStubCountdown(MacroAssembler* masm);
Steve Blocka7e24c12009-10-30 11:49:00 +0000343 static void Generate_JSConstructStubGeneric(MacroAssembler* masm);
Leon Clarkee46be812010-01-19 14:06:41 +0000344 static void Generate_JSConstructStubApi(MacroAssembler* masm);
Steve Blocka7e24c12009-10-30 11:49:00 +0000345 static void Generate_JSEntryTrampoline(MacroAssembler* masm);
346 static void Generate_JSConstructEntryTrampoline(MacroAssembler* masm);
Iain Merrick75681382010-08-19 15:07:18 +0100347 static void Generate_LazyCompile(MacroAssembler* masm);
Ben Murdochb0fe1622011-05-05 13:52:32 +0100348 static void Generate_LazyRecompile(MacroAssembler* masm);
349 static void Generate_NotifyDeoptimized(MacroAssembler* masm);
350 static void Generate_NotifyLazyDeoptimized(MacroAssembler* masm);
351 static void Generate_NotifyOSR(MacroAssembler* masm);
Steve Blocka7e24c12009-10-30 11:49:00 +0000352 static void Generate_ArgumentsAdaptorTrampoline(MacroAssembler* masm);
353
354 static void Generate_FunctionCall(MacroAssembler* masm);
355 static void Generate_FunctionApply(MacroAssembler* masm);
356
357 static void Generate_ArrayCode(MacroAssembler* masm);
358 static void Generate_ArrayConstructCode(MacroAssembler* masm);
Kristian Monsen80d68ea2010-09-08 11:05:35 +0100359
360 static void Generate_StringConstructCode(MacroAssembler* masm);
Ben Murdochb0fe1622011-05-05 13:52:32 +0100361 static void Generate_OnStackReplacement(MacroAssembler* masm);
Steve Block44f0eee2011-05-26 01:26:41 +0100362
363 static void InitBuiltinFunctionTable();
364
365 bool initialized_;
366
367 friend class BuiltinFunctionTable;
368 friend class Isolate;
369
370 DISALLOW_COPY_AND_ASSIGN(Builtins);
Steve Blocka7e24c12009-10-30 11:49:00 +0000371};
372
373} } // namespace v8::internal
374
375#endif // V8_BUILTINS_H_