| /* |
| * Copyright (C) 2019 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| #include "arch/instruction_set.h" |
| #include "art_method-inl.h" |
| #include "dex/code_item_accessors.h" |
| #include "entrypoints/quick/callee_save_frame.h" |
| #include "interpreter/mterp/nterp.h" |
| #include "nterp_helpers.h" |
| #include "oat/oat_quick_method_header.h" |
| #include "quick/quick_method_frame_info.h" |
| |
| namespace art HIDDEN { |
| |
| /** |
| * An nterp frame follows the optimizing compiler's ABI conventions, with |
| * int/long/reference parameters being passed in core registers / stack and |
| * float/double parameters being passed in floating point registers / stack. |
| * |
| * There are no ManagedStack transitions between compiler and nterp frames. |
| * |
| * On entry, nterp will copy its parameters to a dex register array allocated on |
| * the stack. There is a fast path when calling from nterp to nterp to not |
| * follow the ABI but just copy the parameters from the caller's dex registers |
| * to the callee's dex registers. |
| * |
| * The stack layout of an nterp frame is: |
| * ---------------- |
| * | | All callee save registers of the platform |
| * | callee-save | (core and floating point). |
| * | registers | On x86 and x64 this includes the return address, |
| * | | already spilled on entry. |
| * ---------------- |
| * | x86 args | x86 only: registers used for argument passing. |
| * ---------------- |
| * | alignment | Stack aligment of kStackAlignment. |
| * ---------------- |
| * | | Contains `registers_size` entries (of size 4) from |
| * | dex | the code item information of the method. |
| * | registers | |
| * | | |
| * ---------------- |
| * | | A copy of the dex registers above, but only |
| * | reference | containing references, used for GC. |
| * | registers | |
| * | | |
| * ---------------- |
| * | caller fp | Frame pointer of caller. Stored below the reference |
| * ---------------- registers array for easy access from nterp when returning. |
| * | dex_pc_ptr | Pointer to the dex instruction being executed. |
| * ---------------- Stored whenever nterp goes into the runtime. |
| * | alignment | Pointer aligment for dex_pc_ptr and caller_fp. |
| * ---------------- |
| * | | In case nterp calls compiled code, we reserve space |
| * | out | for out registers. This space will be used for |
| * | registers | arguments passed on stack. |
| * | | |
| * ---------------- |
| * | ArtMethod* | The method being currently executed. |
| * ---------------- |
| * |
| * Exception handling: |
| * Nterp follows the same convention than the compiler, |
| * with the addition of: |
| * - All catch handlers have the same landing pad. |
| * - Before doing the longjmp for exception delivery, the register containing the |
| * dex PC pointer must be updated. |
| * |
| * Stack walking: |
| * An nterp frame is walked like a compiled code frame. We add an |
| * OatQuickMethodHeader prefix to the nterp entry point, which contains: |
| * - vmap_table_offset=0 (nterp doesn't need one). |
| * - code_size=NterpEnd-NterpStart |
| */ |
| |
| static constexpr size_t kPointerSize = static_cast<size_t>(kRuntimePointerSize); |
| |
| static constexpr size_t NterpGetFrameEntrySize(InstructionSet isa) { |
| uint32_t core_spills = 0; |
| uint32_t fp_spills = 0; |
| // Note: the return address is considered part of the callee saves. |
| switch (isa) { |
| case InstructionSet::kX86: |
| core_spills = x86::X86CalleeSaveFrame::GetCoreSpills(CalleeSaveType::kSaveAllCalleeSaves); |
| fp_spills = x86::X86CalleeSaveFrame::GetFpSpills(CalleeSaveType::kSaveAllCalleeSaves); |
| // x86 also saves registers used for argument passing. |
| core_spills |= x86::kX86CalleeSaveEverythingSpills; |
| break; |
| case InstructionSet::kX86_64: |
| core_spills = |
| x86_64::X86_64CalleeSaveFrame::GetCoreSpills(CalleeSaveType::kSaveAllCalleeSaves); |
| fp_spills = x86_64::X86_64CalleeSaveFrame::GetFpSpills(CalleeSaveType::kSaveAllCalleeSaves); |
| break; |
| case InstructionSet::kArm: |
| case InstructionSet::kThumb2: |
| core_spills = arm::ArmCalleeSaveFrame::GetCoreSpills(CalleeSaveType::kSaveAllCalleeSaves); |
| fp_spills = arm::ArmCalleeSaveFrame::GetFpSpills(CalleeSaveType::kSaveAllCalleeSaves); |
| break; |
| case InstructionSet::kArm64: |
| core_spills = arm64::Arm64CalleeSaveFrame::GetCoreSpills(CalleeSaveType::kSaveAllCalleeSaves); |
| fp_spills = arm64::Arm64CalleeSaveFrame::GetFpSpills(CalleeSaveType::kSaveAllCalleeSaves); |
| break; |
| case InstructionSet::kRiscv64: |
| core_spills = |
| riscv64::Riscv64CalleeSaveFrame::GetCoreSpills(CalleeSaveType::kSaveAllCalleeSaves); |
| fp_spills = riscv64::Riscv64CalleeSaveFrame::GetFpSpills(CalleeSaveType::kSaveAllCalleeSaves); |
| break; |
| default: |
| InstructionSetAbort(isa); |
| } |
| // Note: the return address is considered part of the callee saves. |
| return (POPCOUNT(core_spills) + POPCOUNT(fp_spills)) * |
| static_cast<size_t>(InstructionSetPointerSize(isa)); |
| } |
| |
| static uint16_t GetNumberOfOutRegs(const CodeItemDataAccessor& accessor, InstructionSet isa) { |
| uint16_t out_regs = accessor.OutsSize(); |
| switch (isa) { |
| case InstructionSet::kX86: { |
| // On x86, we use three slots for temporaries. |
| out_regs = std::max(out_regs, static_cast<uint16_t>(3u)); |
| break; |
| } |
| default: |
| break; |
| } |
| return out_regs; |
| } |
| |
| static uint16_t GetNumberOfOutRegs(ArtMethod* method, InstructionSet isa) |
| REQUIRES_SHARED(Locks::mutator_lock_) { |
| CodeItemDataAccessor accessor(method->DexInstructionData()); |
| return GetNumberOfOutRegs(accessor, isa); |
| } |
| |
| // Note: There may be two pieces of alignment but there is no need to align |
| // out args to `kPointerSize` separately before aligning to kStackAlignment. |
| // This allows using the size without padding for the maximum frame size check |
| // in `CanMethodUseNterp()`. |
| static size_t NterpGetFrameSizeWithoutPadding(ArtMethod* method, InstructionSet isa) |
| REQUIRES_SHARED(Locks::mutator_lock_) { |
| CodeItemDataAccessor accessor(method->DexInstructionData()); |
| const uint16_t num_regs = accessor.RegistersSize(); |
| const uint16_t out_regs = GetNumberOfOutRegs(accessor, isa); |
| size_t pointer_size = static_cast<size_t>(InstructionSetPointerSize(isa)); |
| |
| DCHECK(IsAlignedParam(kStackAlignment, pointer_size)); |
| DCHECK(IsAlignedParam(NterpGetFrameEntrySize(isa), pointer_size)); |
| DCHECK(IsAlignedParam(kVRegSize * 2, pointer_size)); |
| size_t frame_size = |
| NterpGetFrameEntrySize(isa) + |
| (num_regs * kVRegSize) * 2 + // dex registers and reference registers |
| pointer_size + // previous frame |
| pointer_size + // saved dex pc |
| (out_regs * kVRegSize) + // out arguments |
| pointer_size; // method |
| return frame_size; |
| } |
| |
| // The frame size nterp will use for the given method. |
| static inline size_t NterpGetFrameSize(ArtMethod* method, InstructionSet isa) |
| REQUIRES_SHARED(Locks::mutator_lock_) { |
| return RoundUp(NterpGetFrameSizeWithoutPadding(method, isa), kStackAlignment); |
| } |
| |
| QuickMethodFrameInfo NterpFrameInfo(ArtMethod** frame) { |
| uint32_t core_spills = |
| RuntimeCalleeSaveFrame::GetCoreSpills(CalleeSaveType::kSaveAllCalleeSaves); |
| uint32_t fp_spills = |
| RuntimeCalleeSaveFrame::GetFpSpills(CalleeSaveType::kSaveAllCalleeSaves); |
| return QuickMethodFrameInfo(NterpGetFrameSize(*frame, kRuntimeISA), core_spills, fp_spills); |
| } |
| |
| uintptr_t NterpGetRegistersArray(ArtMethod** frame) { |
| CodeItemDataAccessor accessor((*frame)->DexInstructionData()); |
| const uint16_t num_regs = accessor.RegistersSize(); |
| // The registers array is just above the reference array. |
| return NterpGetReferenceArray(frame) + (num_regs * kVRegSize); |
| } |
| |
| uintptr_t NterpGetReferenceArray(ArtMethod** frame) { |
| const uint16_t out_regs = GetNumberOfOutRegs(*frame, kRuntimeISA); |
| // The references array is just above the saved frame pointer. |
| return reinterpret_cast<uintptr_t>(frame) + |
| kPointerSize + // method |
| RoundUp(out_regs * kVRegSize, kPointerSize) + // out arguments and pointer alignment |
| kPointerSize + // saved dex pc |
| kPointerSize; // previous frame. |
| } |
| |
| uint32_t NterpGetDexPC(ArtMethod** frame) { |
| const uint16_t out_regs = GetNumberOfOutRegs(*frame, kRuntimeISA); |
| uintptr_t dex_pc_ptr = reinterpret_cast<uintptr_t>(frame) + |
| kPointerSize + // method |
| RoundUp(out_regs * kVRegSize, kPointerSize); // out arguments and pointer alignment |
| CodeItemInstructionAccessor instructions((*frame)->DexInstructions()); |
| return *reinterpret_cast<const uint16_t**>(dex_pc_ptr) - instructions.Insns(); |
| } |
| |
| uint32_t NterpGetVReg(ArtMethod** frame, uint16_t vreg) { |
| return reinterpret_cast<uint32_t*>(NterpGetRegistersArray(frame))[vreg]; |
| } |
| |
| uint32_t NterpGetVRegReference(ArtMethod** frame, uint16_t vreg) { |
| return reinterpret_cast<uint32_t*>(NterpGetReferenceArray(frame))[vreg]; |
| } |
| |
| uintptr_t NterpGetCatchHandler() { |
| // Nterp uses the same landing pad for all exceptions. The dex_pc_ptr set before |
| // longjmp will actually be used to jmp to the catch handler. |
| return reinterpret_cast<uintptr_t>(artNterpAsmInstructionEnd); |
| } |
| |
| bool CanMethodUseNterp(ArtMethod* method, InstructionSet isa) { |
| uint32_t access_flags = method->GetAccessFlags(); |
| if (ArtMethod::IsNative(access_flags) || |
| !ArtMethod::IsInvokable(access_flags) || |
| ArtMethod::MustCountLocks(access_flags) || |
| // Proxy methods do not go through the JIT like other methods, so we don't |
| // run them with nterp. |
| method->IsProxyMethod()) { |
| return false; |
| } |
| if (isa == InstructionSet::kRiscv64) { |
| if (method->GetDexFile()->IsCompactDexFile()) { |
| return false; // Riscv64 nterp does not support compact dex yet. |
| } |
| if (method->DexInstructionData().TriesSize() != 0u) { |
| return false; // Riscv64 nterp does not support exception handling yet. |
| } |
| for (DexInstructionPcPair pair : method->DexInstructions()) { |
| // TODO(riscv64): Add support for more instructions. |
| // Remove the check when all instructions are supported. |
| // Cases are listed in opcode order (DEX_INSTRUCTION_LIST). |
| switch (pair->Opcode()) { |
| case Instruction::NOP: |
| case Instruction::MOVE: |
| case Instruction::MOVE_FROM16: |
| case Instruction::MOVE_16: |
| case Instruction::MOVE_WIDE: |
| case Instruction::MOVE_WIDE_FROM16: |
| case Instruction::MOVE_WIDE_16: |
| case Instruction::MOVE_OBJECT: |
| case Instruction::MOVE_OBJECT_FROM16: |
| case Instruction::MOVE_OBJECT_16: |
| case Instruction::MOVE_RESULT: |
| case Instruction::MOVE_RESULT_WIDE: |
| case Instruction::MOVE_RESULT_OBJECT: |
| case Instruction::MOVE_EXCEPTION: |
| case Instruction::RETURN_VOID: |
| case Instruction::RETURN: |
| case Instruction::RETURN_WIDE: |
| case Instruction::RETURN_OBJECT: |
| case Instruction::CONST_4: |
| case Instruction::CONST_16: |
| case Instruction::CONST: |
| case Instruction::CONST_HIGH16: |
| case Instruction::CONST_WIDE_16: |
| case Instruction::CONST_WIDE_32: |
| case Instruction::CONST_WIDE: |
| case Instruction::CONST_WIDE_HIGH16: |
| case Instruction::CONST_STRING: |
| case Instruction::CONST_STRING_JUMBO: |
| case Instruction::CONST_CLASS: |
| case Instruction::MONITOR_ENTER: |
| case Instruction::MONITOR_EXIT: |
| case Instruction::ARRAY_LENGTH: |
| case Instruction::FILLED_NEW_ARRAY: |
| case Instruction::FILLED_NEW_ARRAY_RANGE: |
| case Instruction::FILL_ARRAY_DATA: |
| case Instruction::THROW: |
| case Instruction::AGET: |
| case Instruction::AGET_WIDE: |
| case Instruction::AGET_OBJECT: |
| case Instruction::AGET_BOOLEAN: |
| case Instruction::AGET_BYTE: |
| case Instruction::AGET_CHAR: |
| case Instruction::AGET_SHORT: |
| case Instruction::APUT: |
| case Instruction::APUT_WIDE: |
| case Instruction::APUT_OBJECT: |
| case Instruction::APUT_BOOLEAN: |
| case Instruction::APUT_BYTE: |
| case Instruction::APUT_CHAR: |
| case Instruction::APUT_SHORT: |
| case Instruction::IGET: |
| case Instruction::IGET_WIDE: |
| case Instruction::IGET_OBJECT: |
| case Instruction::IGET_BOOLEAN: |
| case Instruction::IGET_BYTE: |
| case Instruction::IGET_CHAR: |
| case Instruction::IGET_SHORT: |
| case Instruction::IPUT: |
| case Instruction::IPUT_WIDE: |
| case Instruction::IPUT_OBJECT: |
| case Instruction::IPUT_BOOLEAN: |
| case Instruction::IPUT_BYTE: |
| case Instruction::IPUT_CHAR: |
| case Instruction::IPUT_SHORT: |
| case Instruction::SGET: |
| case Instruction::SGET_WIDE: |
| case Instruction::SGET_OBJECT: |
| case Instruction::SGET_BOOLEAN: |
| case Instruction::SGET_BYTE: |
| case Instruction::SGET_CHAR: |
| case Instruction::SGET_SHORT: |
| case Instruction::SPUT: |
| case Instruction::SPUT_WIDE: |
| case Instruction::SPUT_OBJECT: |
| case Instruction::SPUT_BOOLEAN: |
| case Instruction::SPUT_BYTE: |
| case Instruction::SPUT_CHAR: |
| case Instruction::SPUT_SHORT: |
| case Instruction::INVOKE_VIRTUAL: |
| case Instruction::INVOKE_SUPER: |
| case Instruction::INVOKE_DIRECT: |
| case Instruction::INVOKE_STATIC: |
| case Instruction::INVOKE_INTERFACE: |
| case Instruction::INVOKE_VIRTUAL_RANGE: |
| case Instruction::INVOKE_SUPER_RANGE: |
| case Instruction::INVOKE_DIRECT_RANGE: |
| case Instruction::INVOKE_STATIC_RANGE: |
| case Instruction::INVOKE_INTERFACE_RANGE: |
| case Instruction::NEG_INT: |
| case Instruction::NOT_INT: |
| case Instruction::NEG_LONG: |
| case Instruction::NOT_LONG: |
| case Instruction::NEG_FLOAT: |
| case Instruction::NEG_DOUBLE: |
| case Instruction::INT_TO_LONG: |
| case Instruction::INT_TO_FLOAT: |
| case Instruction::INT_TO_DOUBLE: |
| case Instruction::LONG_TO_INT: |
| case Instruction::LONG_TO_FLOAT: |
| case Instruction::LONG_TO_DOUBLE: |
| case Instruction::FLOAT_TO_INT: |
| case Instruction::FLOAT_TO_LONG: |
| case Instruction::FLOAT_TO_DOUBLE: |
| case Instruction::DOUBLE_TO_INT: |
| case Instruction::DOUBLE_TO_LONG: |
| case Instruction::DOUBLE_TO_FLOAT: |
| case Instruction::INT_TO_BYTE: |
| case Instruction::INT_TO_CHAR: |
| case Instruction::INT_TO_SHORT: |
| case Instruction::ADD_INT: |
| case Instruction::SUB_INT: |
| case Instruction::MUL_INT: |
| case Instruction::DIV_INT: |
| case Instruction::REM_INT: |
| case Instruction::AND_INT: |
| case Instruction::OR_INT: |
| case Instruction::XOR_INT: |
| case Instruction::SHL_INT: |
| case Instruction::SHR_INT: |
| case Instruction::USHR_INT: |
| case Instruction::ADD_LONG: |
| case Instruction::SUB_LONG: |
| case Instruction::MUL_LONG: |
| case Instruction::DIV_LONG: |
| case Instruction::REM_LONG: |
| case Instruction::AND_LONG: |
| case Instruction::OR_LONG: |
| case Instruction::XOR_LONG: |
| case Instruction::SHL_LONG: |
| case Instruction::SHR_LONG: |
| case Instruction::USHR_LONG: |
| case Instruction::ADD_FLOAT: |
| case Instruction::SUB_FLOAT: |
| case Instruction::MUL_FLOAT: |
| case Instruction::DIV_FLOAT: |
| case Instruction::REM_FLOAT: |
| case Instruction::ADD_DOUBLE: |
| case Instruction::SUB_DOUBLE: |
| case Instruction::MUL_DOUBLE: |
| case Instruction::DIV_DOUBLE: |
| case Instruction::REM_DOUBLE: |
| case Instruction::ADD_INT_2ADDR: |
| case Instruction::SUB_INT_2ADDR: |
| case Instruction::MUL_INT_2ADDR: |
| case Instruction::DIV_INT_2ADDR: |
| case Instruction::REM_INT_2ADDR: |
| case Instruction::AND_INT_2ADDR: |
| case Instruction::OR_INT_2ADDR: |
| case Instruction::XOR_INT_2ADDR: |
| case Instruction::SHL_INT_2ADDR: |
| case Instruction::SHR_INT_2ADDR: |
| case Instruction::USHR_INT_2ADDR: |
| case Instruction::ADD_LONG_2ADDR: |
| case Instruction::SUB_LONG_2ADDR: |
| case Instruction::MUL_LONG_2ADDR: |
| case Instruction::DIV_LONG_2ADDR: |
| case Instruction::REM_LONG_2ADDR: |
| case Instruction::AND_LONG_2ADDR: |
| case Instruction::OR_LONG_2ADDR: |
| case Instruction::XOR_LONG_2ADDR: |
| case Instruction::SHL_LONG_2ADDR: |
| case Instruction::SHR_LONG_2ADDR: |
| case Instruction::USHR_LONG_2ADDR: |
| case Instruction::ADD_FLOAT_2ADDR: |
| case Instruction::SUB_FLOAT_2ADDR: |
| case Instruction::MUL_FLOAT_2ADDR: |
| case Instruction::DIV_FLOAT_2ADDR: |
| case Instruction::REM_FLOAT_2ADDR: |
| case Instruction::ADD_DOUBLE_2ADDR: |
| case Instruction::SUB_DOUBLE_2ADDR: |
| case Instruction::MUL_DOUBLE_2ADDR: |
| case Instruction::DIV_DOUBLE_2ADDR: |
| case Instruction::REM_DOUBLE_2ADDR: |
| case Instruction::ADD_INT_LIT16: |
| case Instruction::RSUB_INT: |
| case Instruction::MUL_INT_LIT16: |
| case Instruction::DIV_INT_LIT16: |
| case Instruction::REM_INT_LIT16: |
| case Instruction::AND_INT_LIT16: |
| case Instruction::OR_INT_LIT16: |
| case Instruction::XOR_INT_LIT16: |
| case Instruction::ADD_INT_LIT8: |
| case Instruction::RSUB_INT_LIT8: |
| case Instruction::MUL_INT_LIT8: |
| case Instruction::DIV_INT_LIT8: |
| case Instruction::REM_INT_LIT8: |
| case Instruction::AND_INT_LIT8: |
| case Instruction::OR_INT_LIT8: |
| case Instruction::XOR_INT_LIT8: |
| case Instruction::SHL_INT_LIT8: |
| case Instruction::SHR_INT_LIT8: |
| case Instruction::USHR_INT_LIT8: |
| case Instruction::INVOKE_POLYMORPHIC: |
| case Instruction::INVOKE_POLYMORPHIC_RANGE: |
| case Instruction::INVOKE_CUSTOM: |
| case Instruction::INVOKE_CUSTOM_RANGE: |
| case Instruction::CONST_METHOD_HANDLE: |
| case Instruction::CONST_METHOD_TYPE: |
| continue; |
| default: |
| return false; |
| } |
| } |
| } |
| // There is no need to add the alignment padding size for comparison with aligned limit. |
| size_t frame_size_without_padding = NterpGetFrameSizeWithoutPadding(method, isa); |
| DCHECK_EQ(NterpGetFrameSize(method, isa), RoundUp(frame_size_without_padding, kStackAlignment)); |
| static_assert(IsAligned<kStackAlignment>(interpreter::kNterpMaxFrame)); |
| return frame_size_without_padding <= interpreter::kNterpMaxFrame; |
| } |
| |
| } // namespace art |