d3c73b0358e28eb5cbcedee5aa42f362f9457bb5
[WebKit-https.git] / Source / JavaScriptCore / llint / LowLevelInterpreter.cpp
1 /*
2  * Copyright (C) 2012 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #include "config.h"
27 #include "LowLevelInterpreter.h"
28
29 #if ENABLE(LLINT)
30
31 #include "LLIntOfflineAsmConfig.h"
32 #include <wtf/InlineASM.h>
33
34 #if ENABLE(LLINT_C_LOOP)
35 #include "CodeBlock.h"
36 #include "LLIntCLoop.h"
37 #include "LLIntSlowPaths.h"
38 #include "Operations.h"
39 #include "VMInspector.h"
40 #include <wtf/Assertions.h>
41 #include <wtf/MathExtras.h>
42
43 using namespace JSC::LLInt;
44
45 // LLInt C Loop opcodes
46 // ====================
47 // In the implementation of the C loop, the LLint trampoline glue functions
48 // (e.g. llint_program_prologue, llint_eval_prologue, etc) are addressed as
49 // if they are bytecode handlers. That means the names of the trampoline
50 // functions will be added to the OpcodeID list via the
51 // FOR_EACH_LLINT_OPCODE_EXTENSION() macro that FOR_EACH_OPCODE_ID()
52 // includes.
53 //
54 // In addition, some JIT trampoline functions which are needed by LLInt
55 // (e.g. getHostCallReturnValue, ctiOpThrowNotCaught) are also added as
56 // bytecodes, and the CLoop will provide bytecode handlers for them.
57 //
58 // In the CLoop, we can only dispatch indirectly to these bytecodes
59 // (including the LLInt and JIT extensions). All other dispatches
60 // (i.e. goto's) must be to a known label (i.e. local / global labels).
61
62
63 // How are the opcodes named?
64 // ==========================
65 // Here is a table to show examples of how each of the manifestation of the
66 // opcodes are named:
67 //
68 //   Type:                        Opcode            Trampoline Glue
69 //                                ======            ===============
70 //   [In the llint .asm files]
71 //   llint labels:                llint_op_enter    llint_program_prologue
72 //
73 //   OpcodeID:                    op_enter          llint_program
74 //                                [in Opcode.h]     [in LLIntOpcode.h]
75 //
76 //   When using a switch statement dispatch in the CLoop, each "opcode" is
77 //   a case statement:
78 //   Opcode:                      case op_enter:    case llint_program_prologue:
79 //
80 //   When using a computed goto dispatch in the CLoop, each opcode is a label:
81 //   Opcode:                      op_enter:         llint_program_prologue:
82
83
84 //============================================================================
85 // Define the opcode dispatch mechanism when using the C loop:
86 //
87
88 // These are for building a C Loop interpreter:
89 #define OFFLINE_ASM_BEGIN
90 #define OFFLINE_ASM_END
91
92
93 #define OFFLINE_ASM_OPCODE_LABEL(opcode) DEFINE_OPCODE(opcode)
94 #if ENABLE(COMPUTED_GOTO_OPCODES)
95     #define OFFLINE_ASM_GLUE_LABEL(label)  label:
96 #else
97     #define OFFLINE_ASM_GLUE_LABEL(label)  case label: label:
98 #endif
99
100 #define OFFLINE_ASM_LOCAL_LABEL(label)   label:
101
102
103 //============================================================================
104 // Some utilities:
105 //
106
107 namespace JSC {
108 namespace LLInt {
109
110 #if USE(JSVALUE32_64)
111 static double Ints2Double(uint32_t lo, uint32_t hi)
112 {
113     union {
114         double dval;
115         uint64_t ival64;
116     } u;
117     u.ival64 = (static_cast<uint64_t>(hi) << 32) | lo;
118     return u.dval;
119 }
120 #endif // USE(JSVALUE32_64)
121
122 } // namespace LLint
123
124
125 //============================================================================
126 // CLoopRegister is the storage for an emulated CPU register.
127 // It defines the policy of how ints smaller than intptr_t are packed into the
128 // pseudo register, as well as hides endianness differences.
129
130 struct CLoopRegister {
131     union {
132         intptr_t i;
133         uintptr_t u;
134 #if USE(JSVALUE64)
135 #if CPU(BIG_ENDIAN)
136         struct {
137             int32_t i32padding;
138             int32_t i32;
139         };
140         struct {
141             uint32_t u32padding;
142             uint32_t u32;
143         };
144         struct {
145             int8_t i8padding[7];
146             int8_t i8;
147         };
148         struct {
149             uint8_t u8padding[7];
150             uint8_t u8;
151         };
152 #else // !CPU(BIG_ENDIAN)
153         struct {
154             int32_t i32;
155             int32_t i32padding;
156         };
157         struct {
158             uint32_t u32;
159             uint32_t u32padding;
160         };
161         struct {
162             int8_t i8;
163             int8_t i8padding[7];
164         };
165         struct {
166             uint8_t u8;
167             uint8_t u8padding[7];
168         };
169 #endif // !CPU(BIG_ENDIAN)
170 #else // !USE(JSVALUE64)
171         int32_t i32;
172         uint32_t u32;
173
174 #if CPU(BIG_ENDIAN)
175         struct {
176             int8_t i8padding[3];
177             int8_t i8;
178         };
179         struct {
180             uint8_t u8padding[3];
181             uint8_t u8;
182         };
183
184 #else // !CPU(BIG_ENDIAN)
185         struct {
186             int8_t i8;
187             int8_t i8padding[3];
188         };
189         struct {
190             uint8_t u8;
191             uint8_t u8padding[3];
192         };
193 #endif // !CPU(BIG_ENDIAN)
194 #endif // !USE(JSVALUE64)
195
196         int8_t* i8p;
197         void* vp;
198         ExecState* execState;
199         void* instruction;
200         NativeFunction nativeFunc;
201 #if USE(JSVALUE64)
202         int64_t i64;
203         uint64_t u64;
204         EncodedJSValue encodedJSValue;
205         double castToDouble;
206 #endif
207         Opcode opcode;
208     };
209
210 #if USE(JSVALUE64)
211     inline void clearHighWord() { i32padding = 0; }
212 #else
213     inline void clearHighWord() { }
214 #endif
215 };
216
217 //============================================================================
218 // The llint C++ interpreter loop:
219 //
220
221 JSValue CLoop::execute(CallFrame* callFrame, OpcodeID bootstrapOpcodeId,
222                        bool isInitializationPass)
223 {
224     #define CAST reinterpret_cast
225     #define SIGN_BIT32(x) ((x) & 0x80000000)
226
227     // One-time initialization of our address tables. We have to put this code
228     // here because our labels are only in scope inside this function. The
229     // caller (or one of its ancestors) is responsible for ensuring that this
230     // is only called once during the initialization of the VM before threads
231     // are at play.
232     if (UNLIKELY(isInitializationPass)) {
233 #if ENABLE(COMPUTED_GOTO_OPCODES)
234         Opcode* opcodeMap = LLInt::opcodeMap();
235         #define OPCODE_ENTRY(__opcode, length) \
236             opcodeMap[__opcode] = bitwise_cast<void*>(&&__opcode);
237         FOR_EACH_OPCODE_ID(OPCODE_ENTRY)
238         #undef OPCODE_ENTRY
239
240         #define LLINT_OPCODE_ENTRY(__opcode, length) \
241             opcodeMap[__opcode] = bitwise_cast<void*>(&&__opcode);
242
243         FOR_EACH_LLINT_NATIVE_HELPER(LLINT_OPCODE_ENTRY)
244         #undef LLINT_OPCODE_ENTRY
245 #endif
246         // Note: we can only set the exceptionInstructions after we have
247         // initialized the opcodeMap above. This is because getCodePtr()
248         // can depend on the opcodeMap.
249         Instruction* exceptionInstructions = LLInt::exceptionInstructions();
250         for (int i = 0; i < maxOpcodeLength + 1; ++i)
251             exceptionInstructions[i].u.pointer =
252                 LLInt::getCodePtr(llint_throw_from_slow_path_trampoline);
253
254         return JSValue();
255     }
256
257     ASSERT(callFrame->globalData().topCallFrame == callFrame);
258
259     // Define the pseudo registers used by the LLINT C Loop backend:
260     ASSERT(sizeof(CLoopRegister) == sizeof(intptr_t));
261
262     union CLoopDoubleRegister {
263         double d;
264 #if USE(JSVALUE64)
265         int64_t castToInt64;
266 #endif
267     };
268
269     // The CLoop llint backend is initially based on the ARMv7 backend, and
270     // then further enhanced with a few instructions from the x86 backend to
271     // support building for X64 targets. Hence, the shape of the generated
272     // code and the usage convention of registers will look a lot like the
273     // ARMv7 backend's.
274     //
275     // For example, on a 32-bit build:
276     // 1. Outgoing args will be set up as follows:
277     //    arg1 in t0 (r0 on ARM)
278     //    arg2 in t1 (r1 on ARM)
279     // 2. 32 bit return values will be in t0 (r0 on ARM).
280     // 3. 64 bit return values (e.g. doubles) will be in t0,t1 (r0,r1 on ARM).
281     //
282     // But instead of naming these simulator registers based on their ARM
283     // counterparts, we'll name them based on their original llint asm names.
284     // This will make it easier to correlate the generated code with the
285     // original llint asm code.
286     //
287     // On a 64-bit build, it more like x64 in that the registers are 64 bit.
288     // Hence:
289     // 1. Outgoing args are still the same: arg1 in t0, arg2 in t1, etc.
290     // 2. 32 bit result values will be in the low 32-bit of t0.
291     // 3. 64 bit result values will be in t0.
292
293     CLoopRegister t0, t1, t2, t3;
294 #if USE(JSVALUE64)
295     CLoopRegister rBasePC, tagTypeNumber, tagMask;
296 #endif
297     CLoopRegister rRetVPC;
298     CLoopDoubleRegister d0, d1;
299
300 #if COMPILER(MSVC)
301     // Keep the compiler happy. We don't really need this, but the compiler
302     // will complain. This makes the warning go away.
303     t0.i = 0;
304     t1.i = 0;
305 #endif
306
307     // Instantiate the pseudo JIT stack frame used by the LLINT C Loop backend:
308     JITStackFrame jitStackFrame;
309
310     // The llint expects the native stack pointer, sp, to be pointing to the
311     // jitStackFrame (which is the simulation of the native stack frame):
312     JITStackFrame* const sp = &jitStackFrame;
313     sp->globalData = &callFrame->globalData();
314
315     // Set up an alias for the globalData ptr in the JITStackFrame:
316     JSGlobalData* &globalData = sp->globalData;
317
318     CodeBlock* codeBlock = callFrame->codeBlock();
319     Instruction* vPC;
320
321     // rPC is an alias for vPC. Set up the alias:
322     CLoopRegister& rPC = *CAST<CLoopRegister*>(&vPC);
323
324 #if USE(JSVALUE32_64)
325     vPC = codeBlock->instructions().begin();
326 #else // USE(JSVALUE64)
327     vPC = 0;
328     rBasePC.vp = codeBlock->instructions().begin();
329
330     // For the ASM llint, JITStubs takes care of this initialization. We do
331     // it explicitly here for the C loop:
332     tagTypeNumber.i = 0xFFFF000000000000;
333     tagMask.i = 0xFFFF000000000002;
334 #endif // USE(JSVALUE64)
335
336     // cfr is an alias for callFrame. Set up this alias:
337     CLoopRegister& cfr = *CAST<CLoopRegister*>(&callFrame);
338
339     // Simulate a native return PC which should never be used:
340     rRetVPC.i = 0xbbadbeef;
341
342     // Interpreter variables for value passing between opcodes and/or helpers:
343     NativeFunction nativeFunc = 0;
344     JSValue functionReturnValue;
345     Opcode opcode;
346
347     opcode = LLInt::getOpcode(bootstrapOpcodeId);
348
349     #if ENABLE(OPCODE_STATS)
350         #define RECORD_OPCODE_STATS(__opcode) \
351             OpcodeStats::recordInstruction(__opcode)
352     #else
353         #define RECORD_OPCODE_STATS(__opcode)
354     #endif
355
356     #if USE(JSVALUE32_64)
357         #define FETCH_OPCODE() vPC->u.opcode
358     #else // USE(JSVALUE64)
359         #define FETCH_OPCODE() *bitwise_cast<Opcode*>(rBasePC.i8p + rPC.i * 8)
360     #endif // USE(JSVALUE64)
361
362     #define NEXT_INSTRUCTION() \
363         do {                         \
364             opcode = FETCH_OPCODE(); \
365             DISPATCH_OPCODE();       \
366         } while (false)
367
368 #if ENABLE(COMPUTED_GOTO_OPCODES)
369
370     //========================================================================
371     // Loop dispatch mechanism using computed goto statements:
372
373     #define DISPATCH_OPCODE() goto *opcode
374
375     #define DEFINE_OPCODE(__opcode) \
376         __opcode: \
377             RECORD_OPCODE_STATS(__opcode);
378
379     // Dispatch to the current PC's bytecode:
380     DISPATCH_OPCODE();
381
382 #else // !ENABLE(COMPUTED_GOTO_OPCODES)
383     //========================================================================
384     // Loop dispatch mechanism using a C switch statement:
385
386     #define DISPATCH_OPCODE() goto dispatchOpcode
387
388     #define DEFINE_OPCODE(__opcode) \
389         case __opcode: \
390         __opcode: \
391             RECORD_OPCODE_STATS(__opcode);
392
393     // Dispatch to the current PC's bytecode:
394     dispatchOpcode:
395     switch (opcode)
396
397 #endif // !ENABLE(COMPUTED_GOTO_OPCODES)
398
399     //========================================================================
400     // Bytecode handlers:
401     {
402         // This is the file generated by offlineasm, which contains all of the
403         // bytecode handlers for the interpreter, as compiled from
404         // LowLevelInterpreter.asm and its peers.
405
406         #include "LLIntAssembly.h"
407
408         // In the ASM llint, getHostCallReturnValue() is a piece of glue
409         // function provided by the JIT (see dfg/DFGOperations.cpp).
410         // We simulate it here with a pseduo-opcode handler.
411         OFFLINE_ASM_GLUE_LABEL(getHostCallReturnValue)
412         {
413             // The ASM part pops the frame:
414             callFrame = callFrame->callerFrame();
415
416             // The part in getHostCallReturnValueWithExecState():
417             JSValue result = globalData->hostCallReturnValue;
418 #if USE(JSVALUE32_64)
419             t1.i = result.tag();
420             t0.i = result.payload();
421 #else
422             t0.encodedJSValue = JSValue::encode(result);
423 #endif
424             goto doReturnHelper;
425         }
426
427         OFFLINE_ASM_GLUE_LABEL(ctiOpThrowNotCaught)
428         {
429             return globalData->exception;
430         }
431
432 #if !ENABLE(COMPUTED_GOTO_OPCODES)
433     default:
434         ASSERT(false);
435 #endif
436
437     } // END bytecode handler cases.
438
439     //========================================================================
440     // Bytecode helpers:
441
442     doReturnHelper: {
443         ASSERT(!!callFrame);
444         if (callFrame->hasHostCallFrameFlag()) {
445 #if USE(JSVALUE32_64)
446             return JSValue(t1.i, t0.i); // returning JSValue(tag, payload);
447 #else
448             return JSValue::decode(t0.encodedJSValue);
449 #endif
450         }
451
452         // The normal ASM llint call implementation returns to the caller as
453         // recorded in rRetVPC, and the caller would fetch the return address
454         // from ArgumentCount.tag() (see the dispatchAfterCall() macro used in
455         // the callTargetFunction() macro in the llint asm files).
456         //
457         // For the C loop, we don't have the JIT stub to this work for us.
458         // So, we need to implement the equivalent of dispatchAfterCall() here
459         // before dispatching to the PC.
460
461         vPC = callFrame->currentVPC();
462
463 #if USE(JSVALUE64)
464         // Based on LowLevelInterpreter64.asm's dispatchAfterCall():
465
466         // When returning from a native trampoline call, unlike the assembly
467         // LLInt, we can't simply return to the caller. In our case, we grab
468         // the caller's VPC and resume execution there. However, the caller's
469         // VPC returned by callFrame->currentVPC() is in the form of the real
470         // address of the target bytecode, but the 64-bit llint expects the
471         // VPC to be a bytecode offset. Hence, we need to map it back to a
472         // bytecode offset before we dispatch via the usual dispatch mechanism
473         // i.e. NEXT_INSTRUCTION():
474
475         codeBlock = callFrame->codeBlock();
476         ASSERT(codeBlock);
477         rPC.vp = callFrame->currentVPC();
478         rPC.i = rPC.i8p - reinterpret_cast<int8_t*>(codeBlock->instructions().begin());
479         rPC.i >>= 3;
480
481         rBasePC.vp = codeBlock->instructions().begin();
482 #endif // USE(JSVALUE64)
483
484         NEXT_INSTRUCTION();
485
486     } // END doReturnHelper.
487
488
489     // Keep the compiler happy so that it doesn't complain about unused
490     // labels for the LLInt trampoline glue. The labels are automatically
491     // emitted by label macros above, and some of them are referenced by
492     // the llint generated code. Since we can't tell ahead of time which
493     // will be referenced and which will be not, we'll just passify the
494     // compiler on all such labels:
495     #define LLINT_OPCODE_ENTRY(__opcode, length) \
496         UNUSED_LABEL(__opcode);
497         FOR_EACH_OPCODE_ID(LLINT_OPCODE_ENTRY);
498     #undef LLINT_OPCODE_ENTRY
499
500
501     #undef NEXT_INSTRUCTION
502     #undef DEFINE_OPCODE
503     #undef CHECK_FOR_TIMEOUT
504     #undef CAST
505     #undef SIGN_BIT32
506
507 } // Interpreter::llintCLoopExecute()
508
509 } // namespace JSC
510
511 #else // !ENABLE(LLINT_C_LOOP)
512
513 //============================================================================
514 // Define the opcode dispatch mechanism when using an ASM loop:
515 //
516
517 // These are for building an interpreter from generated assembly code:
518 #define OFFLINE_ASM_BEGIN   asm (
519 #define OFFLINE_ASM_END     );
520
521 #define OFFLINE_ASM_OPCODE_LABEL(__opcode) OFFLINE_ASM_GLOBAL_LABEL(llint_##__opcode)
522 #define OFFLINE_ASM_GLUE_LABEL(__opcode)   OFFLINE_ASM_GLOBAL_LABEL(__opcode)
523
524 #if CPU(ARM_THUMB2)
525 #define OFFLINE_ASM_GLOBAL_LABEL(label)          \
526     ".globl " SYMBOL_STRING(label) "\n"          \
527     HIDE_SYMBOL(label) "\n"                      \
528     ".thumb\n"                                   \
529     ".thumb_func " THUMB_FUNC_PARAM(label) "\n"  \
530     SYMBOL_STRING(label) ":\n"
531 #else
532 #define OFFLINE_ASM_GLOBAL_LABEL(label)         \
533     ".globl " SYMBOL_STRING(label) "\n"         \
534     HIDE_SYMBOL(label) "\n"                     \
535     SYMBOL_STRING(label) ":\n"
536 #endif
537
538 #define OFFLINE_ASM_LOCAL_LABEL(label)   LOCAL_LABEL_STRING(label) ":\n"
539
540 // This is a file generated by offlineasm, which contains all of the assembly code
541 // for the interpreter, as compiled from LowLevelInterpreter.asm.
542 #include "LLIntAssembly.h"
543
544 #endif // !ENABLE(LLINT_C_LOOP)
545
546 #endif // ENABLE(LLINT)