// Copyright 2012 the V8 project authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. #ifndef INCLUDED_FROM_MACRO_ASSEMBLER_H #error This header must be included via macro-assembler.h #endif #ifndef V8_CODEGEN_IA32_MACRO_ASSEMBLER_IA32_H_ #define V8_CODEGEN_IA32_MACRO_ASSEMBLER_IA32_H_ #include #include "include/v8-internal.h" #include "src/base/logging.h" #include "src/base/macros.h" #include "src/builtins/builtins.h" #include "src/codegen/assembler.h" #include "src/codegen/bailout-reason.h" #include "src/codegen/cpu-features.h" #include "src/codegen/ia32/assembler-ia32.h" #include "src/codegen/ia32/register-ia32.h" #include "src/codegen/label.h" #include "src/codegen/reglist.h" #include "src/codegen/reloc-info.h" #include "src/codegen/shared-ia32-x64/macro-assembler-shared-ia32-x64.h" #include "src/codegen/turbo-assembler.h" #include "src/common/globals.h" #include "src/execution/frames.h" #include "src/handles/handles.h" #include "src/objects/heap-object.h" #include "src/objects/smi.h" #include "src/roots/roots.h" #include "src/runtime/runtime.h" namespace v8 { namespace internal { class Code; class ExternalReference; class StatsCounter; // Convenience for platform-independent signatures. We do not normally // distinguish memory operands from other operands on ia32. using MemOperand = Operand; // TODO(victorgomes): Move definition to macro-assembler.h, once all other // platforms are updated. enum class StackLimitKind { kInterruptStackLimit, kRealStackLimit }; // Convenient class to access arguments below the stack pointer. class StackArgumentsAccessor { public: // argc = the number of arguments not including the receiver. explicit StackArgumentsAccessor(Register argc) : argc_(argc) { DCHECK_NE(argc_, no_reg); } // Argument 0 is the receiver (despite argc not including the receiver). Operand operator[](int index) const { return GetArgumentOperand(index); } Operand GetArgumentOperand(int index) const; Operand GetReceiverOperand() const { return GetArgumentOperand(0); } private: const Register argc_; DISALLOW_IMPLICIT_CONSTRUCTORS(StackArgumentsAccessor); }; class V8_EXPORT_PRIVATE TurboAssembler : public SharedTurboAssemblerBase { public: using SharedTurboAssemblerBase::SharedTurboAssemblerBase; void CheckPageFlag(Register object, Register scratch, int mask, Condition cc, Label* condition_met, Label::Distance condition_met_distance = Label::kFar); // Activation support. void EnterFrame(StackFrame::Type type); void EnterFrame(StackFrame::Type type, bool load_constant_pool_pointer_reg) { // Out-of-line constant pool not implemented on ia32. UNREACHABLE(); } void LeaveFrame(StackFrame::Type type); // Allocate stack space of given size (i.e. decrement {esp} by the value // stored in the given register, or by a constant). If you need to perform a // stack check, do it before calling this function because this function may // write into the newly allocated space. It may also overwrite the given // register's value, in the version that takes a register. #ifdef V8_OS_WIN void AllocateStackSpace(Register bytes_scratch); void AllocateStackSpace(int bytes); #else void AllocateStackSpace(Register bytes) { sub(esp, bytes); } void AllocateStackSpace(int bytes) { DCHECK_GE(bytes, 0); if (bytes == 0) return; sub(esp, Immediate(bytes)); } #endif // Print a message to stdout and abort execution. void Abort(AbortReason reason); // Calls Abort(msg) if the condition cc is not satisfied. // Use --debug_code to enable. void Assert(Condition cc, AbortReason reason) NOOP_UNLESS_DEBUG_CODE // Like Assert(), but without condition. // Use --debug_code to enable. void AssertUnreachable(AbortReason reason) NOOP_UNLESS_DEBUG_CODE // Like Assert(), but always enabled. void Check(Condition cc, AbortReason reason); // Check that the stack is aligned. void CheckStackAlignment(); // Move a constant into a destination using the most efficient encoding. void Move(Register dst, int32_t x) { if (x == 0) { xor_(dst, dst); } else { mov(dst, Immediate(x)); } } void Move(Register dst, const Immediate& src); void Move(Register dst, Smi src) { Move(dst, Immediate(src)); } void Move(Register dst, Handle src); void Move(Register dst, Register src); void Move(Register dst, Operand src); void Move(Operand dst, const Immediate& src); // Move an immediate into an XMM register. void Move(XMMRegister dst, uint32_t src); void Move(XMMRegister dst, uint64_t src); void Move(XMMRegister dst, float src) { Move(dst, base::bit_cast(src)); } void Move(XMMRegister dst, double src) { Move(dst, base::bit_cast(src)); } Operand EntryFromBuiltinAsOperand(Builtin builtin); void Call(Register reg) { call(reg); } void Call(Operand op) { call(op); } void Call(Label* target) { call(target); } void Call(Handle code_object, RelocInfo::Mode rmode); // Load the builtin given by the Smi in |builtin_index| into the same // register. void LoadEntryFromBuiltinIndex(Register builtin_index); void CallBuiltinByIndex(Register builtin_index); void CallBuiltin(Builtin builtin); void TailCallBuiltin(Builtin builtin); void LoadCodeObjectEntry(Register destination, Register code_object); void CallCodeObject(Register code_object); void JumpCodeObject(Register code_object, JumpMode jump_mode = JumpMode::kJump); void Jump(const ExternalReference& reference); void Jump(Handle code_object, RelocInfo::Mode rmode); void LoadMap(Register destination, Register object); void Trap(); void DebugBreak(); void CallForDeoptimization(Builtin target, int deopt_id, Label* exit, DeoptimizeKind kind, Label* ret, Label* jump_deoptimization_entry_label); // Jump the register contains a smi. inline void JumpIfSmi(Register value, Label* smi_label, Label::Distance distance = Label::kFar) { test(value, Immediate(kSmiTagMask)); j(zero, smi_label, distance); } // Jump if the operand is a smi. inline void JumpIfSmi(Operand value, Label* smi_label, Label::Distance distance = Label::kFar) { test(value, Immediate(kSmiTagMask)); j(zero, smi_label, distance); } void JumpIfEqual(Register a, int32_t b, Label* dest) { cmp(a, Immediate(b)); j(equal, dest); } void JumpIfLessThan(Register a, int32_t b, Label* dest) { cmp(a, Immediate(b)); j(less, dest); } void SmiUntag(Register reg) { sar(reg, kSmiTagSize); } void SmiUntag(Register output, Register value) { mov(output, value); SmiUntag(output); } void SmiToInt32(Register reg) { SmiUntag(reg); } // Before calling a C-function from generated code, align arguments on stack. // After aligning the frame, arguments must be stored in esp[0], esp[4], // etc., not pushed. The argument count assumes all arguments are word sized. // Some compilers/platforms require the stack to be aligned when calling // C++ code. // Needs a scratch register to do some arithmetic. This register will be // trashed. void PrepareCallCFunction(int num_arguments, Register scratch); // Calls a C function and cleans up the space for arguments allocated // by PrepareCallCFunction. The called function is not allowed to trigger a // garbage collection, since that might move the code and invalidate the // return address (unless this is somehow accounted for by the called // function). void CallCFunction(ExternalReference function, int num_arguments); void CallCFunction(Register function, int num_arguments); void ShlPair(Register high, Register low, uint8_t imm8); void ShlPair_cl(Register high, Register low); void ShrPair(Register high, Register low, uint8_t imm8); void ShrPair_cl(Register high, Register low); void SarPair(Register high, Register low, uint8_t imm8); void SarPair_cl(Register high, Register low); // Generates function and stub prologue code. void StubPrologue(StackFrame::Type type); void Prologue(); // Helpers for argument handling enum ArgumentsCountMode { kCountIncludesReceiver, kCountExcludesReceiver }; enum ArgumentsCountType { kCountIsInteger, kCountIsSmi, kCountIsBytes }; void DropArguments(Register count, Register scratch, ArgumentsCountType type, ArgumentsCountMode mode); void DropArgumentsAndPushNewReceiver(Register argc, Register receiver, Register scratch, ArgumentsCountType type, ArgumentsCountMode mode); void DropArgumentsAndPushNewReceiver(Register argc, Operand receiver, Register scratch, ArgumentsCountType type, ArgumentsCountMode mode); void Lzcnt(Register dst, Register src) { Lzcnt(dst, Operand(src)); } void Lzcnt(Register dst, Operand src); void Tzcnt(Register dst, Register src) { Tzcnt(dst, Operand(src)); } void Tzcnt(Register dst, Operand src); void Popcnt(Register dst, Register src) { Popcnt(dst, Operand(src)); } void Popcnt(Register dst, Operand src); void PushReturnAddressFrom(Register src) { push(src); } void PopReturnAddressTo(Register dst) { pop(dst); } void PushReturnAddressFrom(XMMRegister src, Register scratch) { Push(src, scratch); } void PopReturnAddressTo(XMMRegister dst, Register scratch) { Pop(dst, scratch); } void Ret(); // Root register utility functions. void InitializeRootRegister(); Operand RootAsOperand(RootIndex index); void LoadRoot(Register destination, RootIndex index) final; // Indirect root-relative loads. void LoadFromConstantsTable(Register destination, int constant_index) final; void LoadRootRegisterOffset(Register destination, intptr_t offset) final; void LoadRootRelative(Register destination, int32_t offset) final; void PushPC(); enum class PushArrayOrder { kNormal, kReverse }; // `array` points to the first element (the lowest address). // `array` and `size` are not modified. void PushArray(Register array, Register size, Register scratch, PushArrayOrder order = PushArrayOrder::kNormal); // Operand pointing to an external reference. // May emit code to set up the scratch register. The operand is // only guaranteed to be correct as long as the scratch register // isn't changed. // If the operand is used more than once, use a scratch register // that is guaranteed not to be clobbered. Operand ExternalReferenceAsOperand(ExternalReference reference, Register scratch); Operand ExternalReferenceAddressAsOperand(ExternalReference reference); Operand HeapObjectAsOperand(Handle object); void LoadAddress(Register destination, ExternalReference source); void CompareRoot(Register with, RootIndex index); void CompareRoot(Register with, Register scratch, RootIndex index); // Return and drop arguments from stack, where the number of arguments // may be bigger than 2^16 - 1. Requires a scratch register. void Ret(int bytes_dropped, Register scratch); void PextrdPreSse41(Register dst, XMMRegister src, uint8_t imm8); void PinsrdPreSse41(XMMRegister dst, Register src, uint8_t imm8, uint32_t* load_pc_offset) { PinsrdPreSse41(dst, Operand(src), imm8, load_pc_offset); } void PinsrdPreSse41(XMMRegister dst, Operand src, uint8_t imm8, uint32_t* load_pc_offset); // Expression support // cvtsi2sd instruction only writes to the low 64-bit of dst register, which // hinders register renaming and makes dependence chains longer. So we use // xorps to clear the dst register before cvtsi2sd to solve this issue. void Cvtsi2ss(XMMRegister dst, Register src) { Cvtsi2ss(dst, Operand(src)); } void Cvtsi2ss(XMMRegister dst, Operand src); void Cvtsi2sd(XMMRegister dst, Register src) { Cvtsi2sd(dst, Operand(src)); } void Cvtsi2sd(XMMRegister dst, Operand src); void Cvtui2ss(XMMRegister dst, Register src, Register tmp) { Cvtui2ss(dst, Operand(src), tmp); } void Cvtui2ss(XMMRegister dst, Operand src, Register tmp); void Cvttss2ui(Register dst, XMMRegister src, XMMRegister tmp) { Cvttss2ui(dst, Operand(src), tmp); } void Cvttss2ui(Register dst, Operand src, XMMRegister tmp); void Cvtui2sd(XMMRegister dst, Register src, Register scratch) { Cvtui2sd(dst, Operand(src), scratch); } void Cvtui2sd(XMMRegister dst, Operand src, Register scratch); void Cvttsd2ui(Register dst, XMMRegister src, XMMRegister tmp) { Cvttsd2ui(dst, Operand(src), tmp); } void Cvttsd2ui(Register dst, Operand src, XMMRegister tmp); void Push(Register src) { push(src); } void Push(Operand src) { push(src); } void Push(Immediate value); void Push(Handle handle) { push(Immediate(handle)); } void Push(Smi smi) { Push(Immediate(smi)); } void Push(XMMRegister src, Register scratch) { movd(scratch, src); push(scratch); } void Pop(Register dst) { pop(dst); } void Pop(Operand dst) { pop(dst); } void Pop(XMMRegister dst, Register scratch) { pop(scratch); movd(dst, scratch); } void MaybeSaveRegisters(RegList registers); void MaybeRestoreRegisters(RegList registers); void CallEphemeronKeyBarrier(Register object, Register slot_address, SaveFPRegsMode fp_mode); void CallRecordWriteStubSaveRegisters( Register object, Register slot_address, SaveFPRegsMode fp_mode, StubCallMode mode = StubCallMode::kCallBuiltinPointer); void CallRecordWriteStub( Register object, Register slot_address, SaveFPRegsMode fp_mode, StubCallMode mode = StubCallMode::kCallBuiltinPointer); // Calculate how much stack space (in bytes) are required to store caller // registers excluding those specified in the arguments. int RequiredStackSizeForCallerSaved(SaveFPRegsMode fp_mode, Register exclusion = no_reg) const; // PushCallerSaved and PopCallerSaved do not arrange the registers in any // particular order so they are not useful for calls that can cause a GC. // The caller can exclude a register that does not need to be saved and // restored. // Push caller saved registers on the stack, and return the number of bytes // stack pointer is adjusted. int PushCallerSaved(SaveFPRegsMode fp_mode, Register exclusion = no_reg); // Restore caller saved registers from the stack, and return the number of // bytes stack pointer is adjusted. int PopCallerSaved(SaveFPRegsMode fp_mode, Register exclusion = no_reg); // Compute the start of the generated instruction stream from the current PC. // This is an alternative to embedding the {CodeObject} handle as a reference. void ComputeCodeStartAddress(Register dst); // Control-flow integrity: // Define a function entrypoint. This doesn't emit any code for this // architecture, as control-flow integrity is not supported for it. void CodeEntry() {} // Define an exception handler. void ExceptionHandler() {} // Define an exception handler and bind a label. void BindExceptionHandler(Label* label) { bind(label); } protected: // Drops arguments assuming that the return address was already popped. void DropArguments(Register count, ArgumentsCountType type = kCountIsInteger, ArgumentsCountMode mode = kCountExcludesReceiver); }; // MacroAssembler implements a collection of frequently used macros. class V8_EXPORT_PRIVATE MacroAssembler : public TurboAssembler { public: using TurboAssembler::TurboAssembler; void PushRoot(RootIndex index); // Compare the object in a register to a value and jump if they are equal. void JumpIfRoot(Register with, RootIndex index, Label* if_equal, Label::Distance if_equal_distance = Label::kFar) { CompareRoot(with, index); j(equal, if_equal, if_equal_distance); } // Compare the object in a register to a value and jump if they are not equal. void JumpIfNotRoot(Register with, RootIndex index, Label* if_not_equal, Label::Distance if_not_equal_distance = Label::kFar) { CompareRoot(with, index); j(not_equal, if_not_equal, if_not_equal_distance); } // Checks if value is in range [lower_limit, higher_limit] using a single // comparison. Flags CF=1 or ZF=1 indicate the value is in the range // (condition below_equal). It is valid, that |value| == |scratch| as far as // this function is concerned. void CompareRange(Register value, unsigned lower_limit, unsigned higher_limit, Register scratch); void JumpIfIsInRange(Register value, unsigned lower_limit, unsigned higher_limit, Register scratch, Label* on_in_range, Label::Distance near_jump = Label::kFar); // --------------------------------------------------------------------------- // GC Support // Notify the garbage collector that we wrote a pointer into an object. // |object| is the object being stored into, |value| is the object being // stored. value and scratch registers are clobbered by the operation. // The offset is the offset from the start of the object, not the offset from // the tagged HeapObject pointer. For use with FieldOperand(reg, off). void RecordWriteField(Register object, int offset, Register value, Register scratch, SaveFPRegsMode save_fp, SmiCheck smi_check = SmiCheck::kInline); // For page containing |object| mark region covering |address| // dirty. |object| is the object being stored into, |value| is the // object being stored. The address and value registers are clobbered by the // operation. RecordWrite filters out smis so it does not update the // write barrier if the value is a smi. void RecordWrite(Register object, Register address, Register value, SaveFPRegsMode save_fp, SmiCheck smi_check = SmiCheck::kInline); // Enter specific kind of exit frame. Expects the number of // arguments in register eax and sets up the number of arguments in // register edi and the pointer to the first argument in register // esi. void EnterExitFrame(int argc, bool save_doubles, StackFrame::Type frame_type); void EnterApiExitFrame(int argc, Register scratch); // Leave the current exit frame. Expects the return value in // register eax:edx (untouched) and the pointer to the first // argument in register esi (if pop_arguments == true). void LeaveExitFrame(bool save_doubles, bool pop_arguments = true); // Leave the current exit frame. Expects the return value in // register eax (untouched). void LeaveApiExitFrame(); // Load the global proxy from the current context. void LoadGlobalProxy(Register dst); // Load a value from the native context with a given index. void LoadNativeContextSlot(Register dst, int index); // --------------------------------------------------------------------------- // JavaScript invokes // Invoke the JavaScript function code by either calling or jumping. void InvokeFunctionCode(Register function, Register new_target, Register expected_parameter_count, Register actual_parameter_count, InvokeType type); // On function call, call into the debugger. // This may clobber ecx. void CallDebugOnFunctionCall(Register fun, Register new_target, Register expected_parameter_count, Register actual_parameter_count); // Invoke the JavaScript function in the given register. Changes the // current context to the context in the function before invoking. void InvokeFunction(Register function, Register new_target, Register actual_parameter_count, InvokeType type); // Compare object type for heap object. // Incoming register is heap_object and outgoing register is map. void CmpObjectType(Register heap_object, InstanceType type, Register map); // Compare instance type for map. void CmpInstanceType(Register map, InstanceType type); // Compare instance type ranges for a map (lower_limit and higher_limit // inclusive). // // Always use unsigned comparisons: below_equal for a positive // result. void CmpInstanceTypeRange(Register map, Register instance_type_out, Register scratch, InstanceType lower_limit, InstanceType higher_limit); // Smi tagging support. void SmiTag(Register reg) { static_assert(kSmiTag == 0); static_assert(kSmiTagSize == 1); add(reg, reg); } // Jump if register contain a non-smi. inline void JumpIfNotSmi(Register value, Label* not_smi_label, Label::Distance distance = Label::kFar) { test(value, Immediate(kSmiTagMask)); j(not_zero, not_smi_label, distance); } // Jump if the operand is not a smi. inline void JumpIfNotSmi(Operand value, Label* smi_label, Label::Distance distance = Label::kFar) { test(value, Immediate(kSmiTagMask)); j(not_zero, smi_label, distance); } template void DecodeField(Register reg) { static const int shift = Field::kShift; static const int mask = Field::kMask >> Field::kShift; if (shift != 0) { sar(reg, shift); } and_(reg, Immediate(mask)); } void TestCodeTIsMarkedForDeoptimization(Register codet, Register scratch); Immediate ClearedValue() const; // Tiering support. void AssertFeedbackVector(Register object, Register scratch) NOOP_UNLESS_DEBUG_CODE void ReplaceClosureCodeWithOptimizedCode(Register optimized_code, Register closure, Register scratch1, Register slot_address); void GenerateTailCallToReturnedCode(Runtime::FunctionId function_id); void LoadFeedbackVectorFlagsAndJumpIfNeedsProcessing( Register flags, XMMRegister saved_feedback_vector, CodeKind current_code_kind, Label* flags_need_processing); void OptimizeCodeOrTailCallOptimizedCodeSlot( Register flags, XMMRegister saved_feedback_vector); // Abort execution if argument is not a smi, enabled via --debug-code. void AssertSmi(Register object) NOOP_UNLESS_DEBUG_CODE // Abort execution if argument is a smi, enabled via --debug-code. void AssertNotSmi(Register object) NOOP_UNLESS_DEBUG_CODE // Abort execution if argument is not a JSFunction, enabled via --debug-code. void AssertFunction(Register object, Register scratch) NOOP_UNLESS_DEBUG_CODE // Abort execution if argument is not a callable JSFunction, enabled via // --debug-code. void AssertCallableFunction(Register object, Register scratch) NOOP_UNLESS_DEBUG_CODE // Abort execution if argument is not a Constructor, enabled via --debug-code. void AssertConstructor(Register object) NOOP_UNLESS_DEBUG_CODE // Abort execution if argument is not a JSBoundFunction, // enabled via --debug-code. void AssertBoundFunction(Register object) NOOP_UNLESS_DEBUG_CODE // Abort execution if argument is not a JSGeneratorObject (or subclass), // enabled via --debug-code. void AssertGeneratorObject(Register object) NOOP_UNLESS_DEBUG_CODE // Abort execution if argument is not undefined or an AllocationSite, enabled // via --debug-code. void AssertUndefinedOrAllocationSite(Register object, Register scratch) NOOP_UNLESS_DEBUG_CODE // --------------------------------------------------------------------------- // Exception handling // Push a new stack handler and link it into stack handler chain. void PushStackHandler(Register scratch); // Unlink the stack handler on top of the stack from the stack handler chain. void PopStackHandler(Register scratch); // --------------------------------------------------------------------------- // Runtime calls // Call a runtime routine. void CallRuntime(const Runtime::Function* f, int num_arguments, SaveFPRegsMode save_doubles = SaveFPRegsMode::kIgnore); // Convenience function: Same as above, but takes the fid instead. void CallRuntime(Runtime::FunctionId fid, SaveFPRegsMode save_doubles = SaveFPRegsMode::kIgnore) { const Runtime::Function* function = Runtime::FunctionForId(fid); CallRuntime(function, function->nargs, save_doubles); } // Convenience function: Same as above, but takes the fid instead. void CallRuntime(Runtime::FunctionId fid, int num_arguments, SaveFPRegsMode save_doubles = SaveFPRegsMode::kIgnore) { CallRuntime(Runtime::FunctionForId(fid), num_arguments, save_doubles); } // Convenience function: tail call a runtime routine (jump). void TailCallRuntime(Runtime::FunctionId fid); // Jump to a runtime routine. void JumpToExternalReference(const ExternalReference& ext, bool builtin_exit_frame = false); // Generates a trampoline to jump to the off-heap instruction stream. void JumpToOffHeapInstructionStream(Address entry); // --------------------------------------------------------------------------- // Utilities // Emit code to discard a non-negative number of pointer-sized elements // from the stack, clobbering only the esp register. void Drop(int element_count); // --------------------------------------------------------------------------- // In-place weak references. void LoadWeakValue(Register in_out, Label* target_if_cleared); // --------------------------------------------------------------------------- // StatsCounter support void IncrementCounter(StatsCounter* counter, int value, Register scratch) { if (!v8_flags.native_code_counters) return; EmitIncrementCounter(counter, value, scratch); } void EmitIncrementCounter(StatsCounter* counter, int value, Register scratch); void DecrementCounter(StatsCounter* counter, int value, Register scratch) { if (!v8_flags.native_code_counters) return; EmitDecrementCounter(counter, value, scratch); } void EmitDecrementCounter(StatsCounter* counter, int value, Register scratch); // --------------------------------------------------------------------------- // Stack limit utilities void CompareStackLimit(Register with, StackLimitKind kind); void StackOverflowCheck(Register num_args, Register scratch, Label* stack_overflow, bool include_receiver = false); private: // Helper functions for generating invokes. void InvokePrologue(Register expected_parameter_count, Register actual_parameter_count, Label* done, InvokeType type); void EnterExitFramePrologue(StackFrame::Type frame_type, Register scratch); void EnterExitFrameEpilogue(int argc, bool save_doubles); void LeaveExitFrameEpilogue(); DISALLOW_IMPLICIT_CONSTRUCTORS(MacroAssembler); }; // ----------------------------------------------------------------------------- // Static helper functions. // Generate an Operand for loading a field from an object. inline Operand FieldOperand(Register object, int offset) { return Operand(object, offset - kHeapObjectTag); } // Generate an Operand for loading an indexed field from an object. inline Operand FieldOperand(Register object, Register index, ScaleFactor scale, int offset) { return Operand(object, index, scale, offset - kHeapObjectTag); } struct MoveCycleState { // Whether a move in the cycle needs the double scratch register. bool pending_double_scratch_register_use = false; }; #define ACCESS_MASM(masm) masm-> } // namespace internal } // namespace v8 #endif // V8_CODEGEN_IA32_MACRO_ASSEMBLER_IA32_H_