1 // Copyright 2010 the V8 project authors. All rights reserved.
2 // Redistribution and use in source and binary forms, with or without
3 // modification, are permitted provided that the following conditions are
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.
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.
28 #ifndef V8_ARM_CODEGEN_ARM_H_
29 #define V8_ARM_CODEGEN_ARM_H_
37 // Forward declarations
38 class CompilationInfo;
41 class RegisterAllocator;
44 enum InitState { CONST_INIT, NOT_CONST_INIT };
45 enum TypeofState { INSIDE_TYPEOF, NOT_INSIDE_TYPEOF };
46 enum GenerateInlineSmi { DONT_GENERATE_INLINE_SMI, GENERATE_INLINE_SMI };
47 enum WriteBarrierCharacter { UNLIKELY_SMI, LIKELY_SMI, NEVER_NEWSPACE };
50 // -------------------------------------------------------------------------
53 // A reference is a C++ stack-allocated object that puts a
54 // reference on the virtual frame. The reference may be consumed
55 // by GetValue, TakeValue, SetValue, and Codegen::UnloadReference.
56 // When the lifetime (scope) of a valid reference ends, it must have
57 // been consumed, and be in state UNLOADED.
58 class Reference BASE_EMBEDDED {
60 // The values of the types is important, see size().
61 enum Type { UNLOADED = -2, ILLEGAL = -1, SLOT = 0, NAMED = 1, KEYED = 2 };
62 Reference(CodeGenerator* cgen,
63 Expression* expression,
64 bool persist_after_get = false);
67 Expression* expression() const { return expression_; }
68 Type type() const { return type_; }
69 void set_type(Type value) {
70 ASSERT_EQ(ILLEGAL, type_);
75 ASSERT_NE(ILLEGAL, type_);
76 ASSERT_NE(UNLOADED, type_);
79 // The size the reference takes up on the stack.
81 return (type_ < SLOT) ? 0 : type_;
84 bool is_illegal() const { return type_ == ILLEGAL; }
85 bool is_slot() const { return type_ == SLOT; }
86 bool is_property() const { return type_ == NAMED || type_ == KEYED; }
87 bool is_unloaded() const { return type_ == UNLOADED; }
89 // Return the name. Only valid for named property references.
90 Handle<String> GetName();
92 // Generate code to push the value of the reference on top of the
93 // expression stack. The reference is expected to be already on top of
94 // the expression stack, and it is consumed by the call unless the
95 // reference is for a compound assignment.
96 // If the reference is not consumed, it is left in place under its value.
99 // Generate code to store the value on top of the expression stack in the
100 // reference. The reference is expected to be immediately below the value
101 // on the expression stack. The value is stored in the location specified
102 // by the reference, and is left on top of the stack, after the reference
103 // is popped from beneath it (unloaded).
104 void SetValue(InitState init_state, WriteBarrierCharacter wb);
106 // This is in preparation for something that uses the reference on the stack.
107 // If we need this reference afterwards get then dup it now. Otherwise mark
109 inline void DupIfPersist();
112 CodeGenerator* cgen_;
113 Expression* expression_;
115 // Keep the reference on the stack after get, so it can be used by set later.
116 bool persist_after_get_;
120 // -------------------------------------------------------------------------
121 // Code generation state
123 // The state is passed down the AST by the code generator (and back up, in
124 // the form of the state of the label pair). It is threaded through the
125 // call stack. Constructing a state implicitly pushes it on the owning code
126 // generator's stack of states, and destroying one implicitly pops it.
128 class CodeGenState BASE_EMBEDDED {
130 // Create an initial code generator state. Destroying the initial state
131 // leaves the code generator with a NULL state.
132 explicit CodeGenState(CodeGenerator* owner);
134 // Destroy a code generator state and restore the owning code generator's
136 virtual ~CodeGenState();
138 virtual JumpTarget* true_target() const { return NULL; }
139 virtual JumpTarget* false_target() const { return NULL; }
142 inline CodeGenerator* owner() { return owner_; }
143 inline CodeGenState* previous() const { return previous_; }
146 CodeGenerator* owner_;
147 CodeGenState* previous_;
151 class ConditionCodeGenState : public CodeGenState {
153 // Create a code generator state based on a code generator's current
154 // state. The new state has its own pair of branch labels.
155 ConditionCodeGenState(CodeGenerator* owner,
156 JumpTarget* true_target,
157 JumpTarget* false_target);
159 virtual JumpTarget* true_target() const { return true_target_; }
160 virtual JumpTarget* false_target() const { return false_target_; }
163 JumpTarget* true_target_;
164 JumpTarget* false_target_;
168 class TypeInfoCodeGenState : public CodeGenState {
170 TypeInfoCodeGenState(CodeGenerator* owner,
173 ~TypeInfoCodeGenState();
175 virtual JumpTarget* true_target() const { return previous()->true_target(); }
176 virtual JumpTarget* false_target() const {
177 return previous()->false_target();
182 TypeInfo old_type_info_;
186 // -------------------------------------------------------------------------
187 // Arguments allocation mode
189 enum ArgumentsAllocationMode {
190 NO_ARGUMENTS_ALLOCATION,
191 EAGER_ARGUMENTS_ALLOCATION,
192 LAZY_ARGUMENTS_ALLOCATION
196 // Different nop operations are used by the code generator to detect certain
197 // states of the generated code.
198 enum NopMarkerTypes {
200 PROPERTY_ACCESS_INLINED
204 // -------------------------------------------------------------------------
207 class CodeGenerator: public AstVisitor {
209 // Takes a function literal, generates code for it. This function should only
210 // be called by compiler.cc.
211 static Handle<Code> MakeCode(CompilationInfo* info);
213 // Printing of AST, etc. as requested by flags.
214 static void MakeCodePrologue(CompilationInfo* info);
216 // Allocate and install the code.
217 static Handle<Code> MakeCodeEpilogue(MacroAssembler* masm,
219 CompilationInfo* info);
221 #ifdef ENABLE_LOGGING_AND_PROFILING
222 static bool ShouldGenerateLog(Expression* type);
225 static void SetFunctionInfo(Handle<JSFunction> fun,
226 FunctionLiteral* lit,
228 Handle<Script> script);
230 static bool RecordPositions(MacroAssembler* masm,
232 bool right_here = false);
235 MacroAssembler* masm() { return masm_; }
236 VirtualFrame* frame() const { return frame_; }
237 inline Handle<Script> script();
239 bool has_valid_frame() const { return frame_ != NULL; }
241 // Set the virtual frame to be new_frame, with non-frame register
242 // reference counts given by non_frame_registers. The non-frame
243 // register reference counts of the old frame are returned in
244 // non_frame_registers.
245 void SetFrame(VirtualFrame* new_frame, RegisterFile* non_frame_registers);
249 RegisterAllocator* allocator() const { return allocator_; }
251 CodeGenState* state() { return state_; }
252 void set_state(CodeGenState* state) { state_ = state; }
254 TypeInfo type_info(Slot* slot) {
255 int index = NumberOfSlot(slot);
256 if (index == kInvalidSlotNumber) return TypeInfo::Unknown();
257 return (*type_info_)[index];
260 TypeInfo set_type_info(Slot* slot, TypeInfo info) {
261 int index = NumberOfSlot(slot);
262 ASSERT(index >= kInvalidSlotNumber);
263 if (index != kInvalidSlotNumber) {
264 TypeInfo previous_value = (*type_info_)[index];
265 (*type_info_)[index] = info;
266 return previous_value;
268 return TypeInfo::Unknown();
271 void AddDeferred(DeferredCode* code) { deferred_.Add(code); }
273 static const int kUnknownIntValue = -1;
275 // If the name is an inline runtime function call return the number of
276 // expected arguments. Otherwise return -1.
277 static int InlineRuntimeCallArgumentsCount(Handle<String> name);
279 // Constants related to patching of inlined load/store.
280 static int GetInlinedKeyedLoadInstructionsAfterPatch() {
281 return FLAG_debug_code ? 32 : 13;
283 static const int kInlinedKeyedStoreInstructionsAfterPatch = 5;
284 static int GetInlinedNamedStoreInstructionsAfterPatch() {
285 ASSERT(inlined_write_barrier_size_ != -1);
286 return inlined_write_barrier_size_ + 4;
289 static MemOperand ContextOperand(Register context, int index) {
290 return MemOperand(context, Context::SlotOffset(index));
294 // Construction/Destruction
295 explicit CodeGenerator(MacroAssembler* masm);
298 inline bool is_eval();
299 inline Scope* scope();
301 // Generating deferred code.
302 void ProcessDeferred();
304 static const int kInvalidSlotNumber = -1;
306 int NumberOfSlot(Slot* slot);
309 bool has_cc() const { return cc_reg_ != al; }
310 JumpTarget* true_target() const { return state_->true_target(); }
311 JumpTarget* false_target() const { return state_->false_target(); }
313 // Track loop nesting level.
314 int loop_nesting() const { return loop_nesting_; }
315 void IncrementLoopNesting() { loop_nesting_++; }
316 void DecrementLoopNesting() { loop_nesting_--; }
319 void VisitStatements(ZoneList<Statement*>* statements);
321 #define DEF_VISIT(type) \
322 void Visit##type(type* node);
323 AST_NODE_LIST(DEF_VISIT)
326 // Main code generation function
327 void Generate(CompilationInfo* info);
329 // Generate the return sequence code. Should be called no more than
330 // once per compiled function, immediately after binding the return
331 // target (which can not be done more than once). The return value should
333 void GenerateReturnSequence();
335 // Returns the arguments allocation mode.
336 ArgumentsAllocationMode ArgumentsMode();
338 // Store the arguments object and allocate it if necessary.
339 void StoreArgumentsObject(bool initial);
341 // The following are used by class Reference.
342 void LoadReference(Reference* ref);
343 void UnloadReference(Reference* ref);
345 MemOperand SlotOperand(Slot* slot, Register tmp);
347 MemOperand ContextSlotOperandCheckExtensions(Slot* slot,
353 static MemOperand GlobalObject() {
354 return ContextOperand(cp, Context::GLOBAL_INDEX);
357 void LoadCondition(Expression* x,
358 JumpTarget* true_target,
359 JumpTarget* false_target,
361 void Load(Expression* expr);
363 void LoadGlobalReceiver(Register scratch);
365 // Read a value from a slot and leave it on top of the expression stack.
366 void LoadFromSlot(Slot* slot, TypeofState typeof_state);
367 void LoadFromSlotCheckForArguments(Slot* slot, TypeofState state);
369 // Store the value on top of the stack to a slot.
370 void StoreToSlot(Slot* slot, InitState init_state);
372 // Support for compiling assignment expressions.
373 void EmitSlotAssignment(Assignment* node);
374 void EmitNamedPropertyAssignment(Assignment* node);
375 void EmitKeyedPropertyAssignment(Assignment* node);
377 // Load a named property, returning it in r0. The receiver is passed on the
378 // stack, and remains there.
379 void EmitNamedLoad(Handle<String> name, bool is_contextual);
381 // Store to a named property. If the store is contextual, value is passed on
382 // the frame and consumed. Otherwise, receiver and value are passed on the
383 // frame and consumed. The result is returned in r0.
384 void EmitNamedStore(Handle<String> name, bool is_contextual);
386 // Load a keyed property, leaving it in r0. The receiver and key are
387 // passed on the stack, and remain there.
388 void EmitKeyedLoad();
390 // Store a keyed property. Key and receiver are on the stack and the value is
391 // in r0. Result is returned in r0.
392 void EmitKeyedStore(StaticType* key_type, WriteBarrierCharacter wb_info);
394 void LoadFromGlobalSlotCheckExtensions(Slot* slot,
395 TypeofState typeof_state,
398 // Support for loading from local/global variables and arguments
399 // whose location is known unless they are shadowed by
400 // eval-introduced bindings. Generates no code for unsupported slot
401 // types and therefore expects to fall through to the slow jump target.
402 void EmitDynamicLoadFromSlotFastCase(Slot* slot,
403 TypeofState typeof_state,
407 // Special code for typeof expressions: Unfortunately, we must
408 // be careful when loading the expression in 'typeof'
409 // expressions. We are not allowed to throw reference errors for
410 // non-existing properties of the global object, so we must make it
411 // look like an explicit property access, instead of an access
412 // through the context chain.
413 void LoadTypeofExpression(Expression* x);
415 void ToBoolean(JumpTarget* true_target, JumpTarget* false_target);
417 // Generate code that computes a shortcutting logical operation.
418 void GenerateLogicalBooleanOperation(BinaryOperation* node);
420 void GenericBinaryOperation(Token::Value op,
421 OverwriteMode overwrite_mode,
422 GenerateInlineSmi inline_smi,
423 int known_rhs = kUnknownIntValue);
424 void Comparison(Condition cc,
427 bool strict = false);
429 void SmiOperation(Token::Value op,
430 Handle<Object> value,
434 void CallWithArguments(ZoneList<Expression*>* arguments,
435 CallFunctionFlags flags,
438 // An optimized implementation of expressions of the form
439 // x.apply(y, arguments). We call x the applicand and y the receiver.
440 // The optimization avoids allocating an arguments object if possible.
441 void CallApplyLazy(Expression* applicand,
442 Expression* receiver,
443 VariableProxy* arguments,
447 void Branch(bool if_true, JumpTarget* target);
450 struct InlineRuntimeLUT {
451 void (CodeGenerator::*method)(ZoneList<Expression*>*);
456 static InlineRuntimeLUT* FindInlineRuntimeLUT(Handle<String> name);
457 bool CheckForInlineRuntimeCall(CallRuntime* node);
458 static bool PatchInlineRuntimeEntry(Handle<String> name,
459 const InlineRuntimeLUT& new_entry,
460 InlineRuntimeLUT* old_entry);
462 static Handle<Code> ComputeLazyCompile(int argc);
463 void ProcessDeclarations(ZoneList<Declaration*>* declarations);
465 static Handle<Code> ComputeCallInitialize(int argc, InLoopFlag in_loop);
467 static Handle<Code> ComputeKeyedCallInitialize(int argc, InLoopFlag in_loop);
469 // Declare global variables and functions in the given array of
471 void DeclareGlobals(Handle<FixedArray> pairs);
473 // Instantiate the function based on the shared function info.
474 void InstantiateFunction(Handle<SharedFunctionInfo> function_info);
476 // Support for type checks.
477 void GenerateIsSmi(ZoneList<Expression*>* args);
478 void GenerateIsNonNegativeSmi(ZoneList<Expression*>* args);
479 void GenerateIsArray(ZoneList<Expression*>* args);
480 void GenerateIsRegExp(ZoneList<Expression*>* args);
481 void GenerateIsObject(ZoneList<Expression*>* args);
482 void GenerateIsSpecObject(ZoneList<Expression*>* args);
483 void GenerateIsFunction(ZoneList<Expression*>* args);
484 void GenerateIsUndetectableObject(ZoneList<Expression*>* args);
485 void GenerateIsStringWrapperSafeForDefaultValueOf(
486 ZoneList<Expression*>* args);
488 // Support for construct call checks.
489 void GenerateIsConstructCall(ZoneList<Expression*>* args);
491 // Support for arguments.length and arguments[?].
492 void GenerateArgumentsLength(ZoneList<Expression*>* args);
493 void GenerateArguments(ZoneList<Expression*>* args);
495 // Support for accessing the class and value fields of an object.
496 void GenerateClassOf(ZoneList<Expression*>* args);
497 void GenerateValueOf(ZoneList<Expression*>* args);
498 void GenerateSetValueOf(ZoneList<Expression*>* args);
500 // Fast support for charCodeAt(n).
501 void GenerateStringCharCodeAt(ZoneList<Expression*>* args);
503 // Fast support for string.charAt(n) and string[n].
504 void GenerateStringCharFromCode(ZoneList<Expression*>* args);
506 // Fast support for string.charAt(n) and string[n].
507 void GenerateStringCharAt(ZoneList<Expression*>* args);
509 // Fast support for object equality testing.
510 void GenerateObjectEquals(ZoneList<Expression*>* args);
512 void GenerateLog(ZoneList<Expression*>* args);
514 // Fast support for Math.random().
515 void GenerateRandomHeapNumber(ZoneList<Expression*>* args);
517 // Fast support for StringAdd.
518 void GenerateStringAdd(ZoneList<Expression*>* args);
520 // Fast support for SubString.
521 void GenerateSubString(ZoneList<Expression*>* args);
523 // Fast support for StringCompare.
524 void GenerateStringCompare(ZoneList<Expression*>* args);
526 // Support for direct calls from JavaScript to native RegExp code.
527 void GenerateRegExpExec(ZoneList<Expression*>* args);
529 void GenerateRegExpConstructResult(ZoneList<Expression*>* args);
531 void GenerateRegExpCloneResult(ZoneList<Expression*>* args);
533 // Support for fast native caches.
534 void GenerateGetFromCache(ZoneList<Expression*>* args);
536 // Fast support for number to string.
537 void GenerateNumberToString(ZoneList<Expression*>* args);
539 // Fast swapping of elements.
540 void GenerateSwapElements(ZoneList<Expression*>* args);
542 // Fast call for custom callbacks.
543 void GenerateCallFunction(ZoneList<Expression*>* args);
545 // Fast call to math functions.
546 void GenerateMathPow(ZoneList<Expression*>* args);
547 void GenerateMathSin(ZoneList<Expression*>* args);
548 void GenerateMathCos(ZoneList<Expression*>* args);
549 void GenerateMathSqrt(ZoneList<Expression*>* args);
551 void GenerateIsRegExpEquivalent(ZoneList<Expression*>* args);
553 // Simple condition analysis.
554 enum ConditionAnalysis {
559 ConditionAnalysis AnalyzeCondition(Expression* cond);
561 // Methods used to indicate which source code is generated for. Source
562 // positions are collected by the assembler and emitted with the relocation
564 void CodeForFunctionPosition(FunctionLiteral* fun);
565 void CodeForReturnPosition(FunctionLiteral* fun);
566 void CodeForStatementPosition(Statement* node);
567 void CodeForDoWhileConditionPosition(DoWhileStatement* stmt);
568 void CodeForSourcePosition(int pos);
571 // True if the registers are valid for entry to a block.
572 bool HasValidEntryRegisters();
575 List<DeferredCode*> deferred_;
578 MacroAssembler* masm_; // to generate code
580 CompilationInfo* info_;
582 // Code generation state
583 VirtualFrame* frame_;
584 RegisterAllocator* allocator_;
586 CodeGenState* state_;
589 Vector<TypeInfo>* type_info_;
592 BreakTarget function_return_;
594 // True if the function return is shadowed (ie, jumping to the target
595 // function_return_ does not jump to the true function return, but rather
596 // to some unlinking code).
597 bool function_return_is_shadowed_;
599 // Size of inlined write barriers generated by EmitNamedStore.
600 static int inlined_write_barrier_size_;
602 static InlineRuntimeLUT kInlineRuntimeLUT[];
604 friend class VirtualFrame;
605 friend class JumpTarget;
606 friend class Reference;
607 friend class FastCodeGenerator;
608 friend class FullCodeGenerator;
609 friend class FullCodeGenSyntaxChecker;
611 DISALLOW_COPY_AND_ASSIGN(CodeGenerator);
615 } } // namespace v8::internal
617 #endif // V8_ARM_CODEGEN_ARM_H_