2 * Copyright (C) 2014 The Android Open Source Project
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #ifndef ART_RUNTIME_DEX_INSTRUCTION_UTILS_H_
18 #define ART_RUNTIME_DEX_INSTRUCTION_UTILS_H_
20 #include "dex_instruction.h"
24 // Dex invoke type corresponds to the ordering of INVOKE instructions;
25 // this order is the same for range and non-range invokes.
26 enum DexInvokeType : uint8_t {
27 kDexInvokeVirtual = 0, // invoke-virtual, invoke-virtual-range
28 kDexInvokeSuper, // invoke-super, invoke-super-range
29 kDexInvokeDirect, // invoke-direct, invoke-direct-range
30 kDexInvokeStatic, // invoke-static, invoke-static-range
31 kDexInvokeInterface, // invoke-interface, invoke-interface-range
35 // Dex instruction memory access types correspond to the ordering of GET/PUT instructions;
36 // this order is the same for IGET, IPUT, SGET, SPUT, AGET and APUT.
37 enum DexMemAccessType : uint8_t {
38 kDexMemAccessWord = 0, // op 0; int or float, the actual type is not encoded.
39 kDexMemAccessWide, // op_WIDE 1; long or double, the actual type is not encoded.
40 kDexMemAccessObject, // op_OBJECT 2; the actual reference type is not encoded.
41 kDexMemAccessBoolean, // op_BOOLEAN 3
42 kDexMemAccessByte, // op_BYTE 4
43 kDexMemAccessChar, // op_CHAR 5
44 kDexMemAccessShort, // op_SHORT 6
45 kDexMemAccessTypeCount
48 std::ostream& operator<<(std::ostream& os, const DexMemAccessType& type);
50 // NOTE: The following functions disregard quickened instructions.
52 // By "direct" const we mean to exclude const-string and const-class
53 // which load data from somewhere else, i.e. indirectly.
54 constexpr bool IsInstructionDirectConst(Instruction::Code opcode) {
55 return Instruction::CONST_4 <= opcode && opcode <= Instruction::CONST_WIDE_HIGH16;
58 constexpr bool IsInstructionConstWide(Instruction::Code opcode) {
59 return Instruction::CONST_WIDE_16 <= opcode && opcode <= Instruction::CONST_WIDE_HIGH16;
62 constexpr bool IsInstructionReturn(Instruction::Code opcode) {
63 return Instruction::RETURN_VOID <= opcode && opcode <= Instruction::RETURN_OBJECT;
66 constexpr bool IsInstructionInvoke(Instruction::Code opcode) {
67 return Instruction::INVOKE_VIRTUAL <= opcode && opcode <= Instruction::INVOKE_INTERFACE_RANGE &&
68 opcode != Instruction::RETURN_VOID_NO_BARRIER;
71 constexpr bool IsInstructionQuickInvoke(Instruction::Code opcode) {
72 return opcode == Instruction::INVOKE_VIRTUAL_QUICK ||
73 opcode == Instruction::INVOKE_VIRTUAL_RANGE_QUICK;
76 constexpr bool IsInstructionInvokeStatic(Instruction::Code opcode) {
77 return opcode == Instruction::INVOKE_STATIC || opcode == Instruction::INVOKE_STATIC_RANGE;
80 constexpr bool IsInstructionGoto(Instruction::Code opcode) {
81 return Instruction::GOTO <= opcode && opcode <= Instruction::GOTO_32;
84 constexpr bool IsInstructionIfCc(Instruction::Code opcode) {
85 return Instruction::IF_EQ <= opcode && opcode <= Instruction::IF_LE;
88 constexpr bool IsInstructionIfCcZ(Instruction::Code opcode) {
89 return Instruction::IF_EQZ <= opcode && opcode <= Instruction::IF_LEZ;
92 constexpr bool IsInstructionIGet(Instruction::Code code) {
93 return Instruction::IGET <= code && code <= Instruction::IGET_SHORT;
96 constexpr bool IsInstructionIPut(Instruction::Code code) {
97 return Instruction::IPUT <= code && code <= Instruction::IPUT_SHORT;
100 constexpr bool IsInstructionSGet(Instruction::Code code) {
101 return Instruction::SGET <= code && code <= Instruction::SGET_SHORT;
104 constexpr bool IsInstructionSPut(Instruction::Code code) {
105 return Instruction::SPUT <= code && code <= Instruction::SPUT_SHORT;
108 constexpr bool IsInstructionAGet(Instruction::Code code) {
109 return Instruction::AGET <= code && code <= Instruction::AGET_SHORT;
112 constexpr bool IsInstructionAPut(Instruction::Code code) {
113 return Instruction::APUT <= code && code <= Instruction::APUT_SHORT;
116 constexpr bool IsInstructionIGetOrIPut(Instruction::Code code) {
117 return Instruction::IGET <= code && code <= Instruction::IPUT_SHORT;
120 constexpr bool IsInstructionIGetQuickOrIPutQuick(Instruction::Code code) {
121 return (code >= Instruction::IGET_QUICK && code <= Instruction::IPUT_OBJECT_QUICK) ||
122 (code >= Instruction::IPUT_BOOLEAN_QUICK && code <= Instruction::IGET_SHORT_QUICK);
125 constexpr bool IsInstructionSGetOrSPut(Instruction::Code code) {
126 return Instruction::SGET <= code && code <= Instruction::SPUT_SHORT;
129 constexpr bool IsInstructionAGetOrAPut(Instruction::Code code) {
130 return Instruction::AGET <= code && code <= Instruction::APUT_SHORT;
133 constexpr bool IsInstructionBinOp2Addr(Instruction::Code code) {
134 return Instruction::ADD_INT_2ADDR <= code && code <= Instruction::REM_DOUBLE_2ADDR;
137 constexpr bool IsInvokeInstructionRange(Instruction::Code opcode) {
138 DCHECK(IsInstructionInvoke(opcode));
139 return opcode >= Instruction::INVOKE_VIRTUAL_RANGE;
142 constexpr DexInvokeType InvokeInstructionType(Instruction::Code opcode) {
143 DCHECK(IsInstructionInvoke(opcode));
144 return static_cast<DexInvokeType>(IsInvokeInstructionRange(opcode)
145 ? (opcode - Instruction::INVOKE_VIRTUAL_RANGE)
146 : (opcode - Instruction::INVOKE_VIRTUAL));
149 constexpr DexMemAccessType IGetMemAccessType(Instruction::Code code) {
150 DCHECK(IsInstructionIGet(code));
151 return static_cast<DexMemAccessType>(code - Instruction::IGET);
154 constexpr DexMemAccessType IPutMemAccessType(Instruction::Code code) {
155 DCHECK(IsInstructionIPut(code));
156 return static_cast<DexMemAccessType>(code - Instruction::IPUT);
159 constexpr DexMemAccessType SGetMemAccessType(Instruction::Code code) {
160 DCHECK(IsInstructionSGet(code));
161 return static_cast<DexMemAccessType>(code - Instruction::SGET);
164 constexpr DexMemAccessType SPutMemAccessType(Instruction::Code code) {
165 DCHECK(IsInstructionSPut(code));
166 return static_cast<DexMemAccessType>(code - Instruction::SPUT);
169 constexpr DexMemAccessType AGetMemAccessType(Instruction::Code code) {
170 DCHECK(IsInstructionAGet(code));
171 return static_cast<DexMemAccessType>(code - Instruction::AGET);
174 constexpr DexMemAccessType APutMemAccessType(Instruction::Code code) {
175 DCHECK(IsInstructionAPut(code));
176 return static_cast<DexMemAccessType>(code - Instruction::APUT);
179 constexpr DexMemAccessType IGetOrIPutMemAccessType(Instruction::Code code) {
180 DCHECK(IsInstructionIGetOrIPut(code));
181 return (code >= Instruction::IPUT) ? IPutMemAccessType(code) : IGetMemAccessType(code);
184 inline DexMemAccessType IGetQuickOrIPutQuickMemAccessType(Instruction::Code code) {
185 DCHECK(IsInstructionIGetQuickOrIPutQuick(code));
187 case Instruction::IGET_QUICK: case Instruction::IPUT_QUICK:
188 return kDexMemAccessWord;
189 case Instruction::IGET_WIDE_QUICK: case Instruction::IPUT_WIDE_QUICK:
190 return kDexMemAccessWide;
191 case Instruction::IGET_OBJECT_QUICK: case Instruction::IPUT_OBJECT_QUICK:
192 return kDexMemAccessObject;
193 case Instruction::IGET_BOOLEAN_QUICK: case Instruction::IPUT_BOOLEAN_QUICK:
194 return kDexMemAccessBoolean;
195 case Instruction::IGET_BYTE_QUICK: case Instruction::IPUT_BYTE_QUICK:
196 return kDexMemAccessByte;
197 case Instruction::IGET_CHAR_QUICK: case Instruction::IPUT_CHAR_QUICK:
198 return kDexMemAccessChar;
199 case Instruction::IGET_SHORT_QUICK: case Instruction::IPUT_SHORT_QUICK:
200 return kDexMemAccessShort;
207 constexpr DexMemAccessType SGetOrSPutMemAccessType(Instruction::Code code) {
208 DCHECK(IsInstructionSGetOrSPut(code));
209 return (code >= Instruction::SPUT) ? SPutMemAccessType(code) : SGetMemAccessType(code);
212 constexpr DexMemAccessType AGetOrAPutMemAccessType(Instruction::Code code) {
213 DCHECK(IsInstructionAGetOrAPut(code));
214 return (code >= Instruction::APUT) ? APutMemAccessType(code) : AGetMemAccessType(code);
219 #endif // ART_RUNTIME_DEX_INSTRUCTION_UTILS_H_