1579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson/* 2579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Copyright (C) 2007 The Android Open Source Project 3579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 4579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Licensed under the Apache License, Version 2.0 (the "License"); 5579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * you may not use this file except in compliance with the License. 6579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * You may obtain a copy of the License at 7579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 8579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * http://www.apache.org/licenses/LICENSE-2.0 9579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 10579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Unless required by applicable law or agreed to in writing, software 11579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * distributed under the License is distributed on an "AS IS" BASIS, 12579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * See the License for the specific language governing permissions and 14579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * limitations under the License. 15579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 16579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 17579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonpackage com.android.dx.dex.code; 18579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 19579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.rop.code.RegisterSpecList; 20579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.rop.code.SourcePosition; 21579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 22579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson/** 23579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Instruction which has a single branch target. 24579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 25579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonpublic final class TargetInsn extends FixedSizeInsn { 26579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@code non-null;} the branch target */ 27579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson private CodeAddress target; 28579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 29579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 30579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Constructs an instance. The output address of this instance is initially 31579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * unknown ({@code -1}), and the target is initially 32579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@code null}. 33579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 34579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param opcode the opcode; one of the constants from {@link Dops} 35579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param position {@code non-null;} source position 36579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param registers {@code non-null;} register list, including a 37579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * result register if appropriate (that is, registers may be either 38579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * ins or outs) 39579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param target {@code non-null;} the branch target 40579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 41579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public TargetInsn(Dop opcode, SourcePosition position, 42579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson RegisterSpecList registers, CodeAddress target) { 43579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson super(opcode, position, registers); 44579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 45579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (target == null) { 46579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throw new NullPointerException("target == null"); 47579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 48579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 49579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson this.target = target; 50579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 51579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 52579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 53579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 54579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public DalvInsn withOpcode(Dop opcode) { 55579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return new TargetInsn(opcode, getPosition(), getRegisters(), target); 56579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 57579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 58579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 59579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 60579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public DalvInsn withRegisters(RegisterSpecList registers) { 61579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return new TargetInsn(getOpcode(), getPosition(), registers, target); 62579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 63579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 64579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 65579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Returns an instance that is just like this one, except that its 66579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * opcode has the opposite sense (as a test; e.g. a 67579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@code lt} test becomes a {@code ge}), and its branch 68579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * target is replaced by the one given, and all set-once values 69579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * associated with the class (such as its address) are reset. 70579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 71579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param target {@code non-null;} the new branch target 72579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return {@code non-null;} an appropriately-constructed instance 73579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 74579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public TargetInsn withNewTargetAndReversed(CodeAddress target) { 75579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson Dop opcode = getOpcode().getOppositeTest(); 76579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 77579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return new TargetInsn(opcode, getPosition(), getRegisters(), target); 78579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 79579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 80579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 81579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Gets the unique branch target of this instruction. 82579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 83579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return {@code non-null;} the branch target 84579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 85579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public CodeAddress getTarget() { 86579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return target; 87579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 88579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 89579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 90579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Gets the target address of this instruction. This is only valid 91579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * to call if the target instruction has been assigned an address, 92579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * and it is merely a convenient shorthand for 93579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@code getTarget().getAddress()}. 94579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 95579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return {@code >= 0;} the target address 96579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 97579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public int getTargetAddress() { 98579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return target.getAddress(); 99579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 100579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 101579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 102579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Gets the branch offset of this instruction. This is only valid to 103579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * call if both this and the target instruction each has been assigned 104579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * an address, and it is merely a convenient shorthand for 105579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@code getTargetAddress() - getAddress()}. 106579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 107579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return the branch offset 108579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 109579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public int getTargetOffset() { 110579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return target.getAddress() - getAddress(); 111579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 112579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 113579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 114579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Returns whether the target offset is known. 115579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 116579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return {@code true} if the target offset is known or 117579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@code false} if not 118579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 119579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public boolean hasTargetOffset() { 120579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return hasAddress() && target.hasAddress(); 121579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 122579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 123579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 124579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 125579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson protected String argString() { 126579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (target == null) { 127579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return "????"; 128579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 129579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 130579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return target.identifierString(); 131579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 132579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson} 133