Preconditions.java revision 2a91d72a1534dd8171d8296ce8312de4bd603451
1e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver/* 2e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * Copyright 2012, Google Inc. 3e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * All rights reserved. 4e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * 5e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * Redistribution and use in source and binary forms, with or without 6e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * modification, are permitted provided that the following conditions are 7e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * met: 8e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * 9e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * * Redistributions of source code must retain the above copyright 10e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * notice, this list of conditions and the following disclaimer. 11e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * * Redistributions in binary form must reproduce the above 12e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * copyright notice, this list of conditions and the following disclaimer 13e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * in the documentation and/or other materials provided with the 14e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * distribution. 15e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * * Neither the name of Google Inc. nor the names of its 16e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * contributors may be used to endorse or promote products derived from 17e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * this software without specific prior written permission. 18e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * 19e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver */ 31e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver 32e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruverpackage org.jf.dexlib2.util; 33e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver 34e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruverimport org.jf.dexlib2.Format; 35e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruverimport org.jf.dexlib2.Opcode; 36e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver 37e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruverpublic class Preconditions { 38e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver public static void checkFormat(Opcode opcode, Format expectedFormat) { 39e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver if (opcode.format != expectedFormat) { 40e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver throw new IllegalArgumentException( 41e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver String.format("Invalid opcode %s for %s", opcode.name, expectedFormat.name())); 42e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 43e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 44e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver 45e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver public static int checkNibbleRegister(int register) { 46e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver if ((register & 0xFFFFFFF0) != 0) { 47e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver throw new IllegalArgumentException( 48e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver String.format("Invalid register: v%d. Must be between v0 and v15, inclusive.", register)); 49e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 50e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver return register; 51e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 52e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver 53e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver public static int checkByteRegister(int register) { 54e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver if ((register & 0xFFFFFF00) != 0) { 55e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver throw new IllegalArgumentException( 56e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver String.format("Invalid register: v%d. Must be between v0 and v255, inclusive.", register)); 57e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 58e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver return register; 59e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 60e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver 61e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver public static int checkShortRegister(int register) { 62e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver if ((register & 0xFFFF0000) != 0) { 63e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver throw new IllegalArgumentException( 64e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver String.format("Invalid register: v%d. Must be between v0 and v65535, inclusive.", register)); 65e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 66e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver return register; 67e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 68e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver 69e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver public static int checkNibbleLiteral(int literal) { 70f8a63e41aa4efd84eabc31fd7a715d1ea0949cc0Ben Gruver if (literal < -8 || literal > 7) { 71e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver throw new IllegalArgumentException( 72e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver String.format("Invalid literal value: %d. Must be between -8 and 7, inclusive.", literal)); 73e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 74e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver return literal; 75e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 76e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver 77e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver public static int checkByteLiteral(int literal) { 78f8a63e41aa4efd84eabc31fd7a715d1ea0949cc0Ben Gruver if (literal < -128 || literal > 127) { 79e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver throw new IllegalArgumentException( 80e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver String.format("Invalid literal value: %d. Must be between -128 and 127, inclusive.", literal)); 81e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 82e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver return literal; 83e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 84e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver 85e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver public static int checkShortLiteral(int literal) { 86f8a63e41aa4efd84eabc31fd7a715d1ea0949cc0Ben Gruver if (literal < -32768 || literal > 32767) { 87e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver throw new IllegalArgumentException( 88e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver String.format("Invalid literal value: %d. Must be between -32768 and 32767, inclusive.", literal)); 89e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 90e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver return literal; 91e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 92e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver 93e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver public static int checkIntegerHatLiteral(int literal) { 94e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver if ((literal & 0xFFFF) != 0) { 95e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver throw new IllegalArgumentException( 96e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver String.format("Invalid literal value: %d. Low 16 bits must be zeroed out.", literal)); 97e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 98e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver return literal; 99e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 100e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver 101e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver public static long checkLongHatLiteral(long literal) { 102e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver if ((literal & 0xFFFFFFFFFFFFL) != 0) { 103e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver throw new IllegalArgumentException( 104f8a63e41aa4efd84eabc31fd7a715d1ea0949cc0Ben Gruver String.format("Invalid literal value: %d. Low 48 bits must be zeroed out.", literal)); 105e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 106e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver return literal; 107e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 108e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver 109ccc4c13ae6cf774126749a5ad8f45de0c08edbeeBen Gruver public static int checkByteCodeOffset(int register) { 110f8a63e41aa4efd84eabc31fd7a715d1ea0949cc0Ben Gruver if (register < -128 || register > 127) { 111e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver throw new IllegalArgumentException( 112f8a63e41aa4efd84eabc31fd7a715d1ea0949cc0Ben Gruver String.format("Invalid code offset: %d. Must be between -128 and 127, inclusive.", register)); 113e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 114e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver return register; 115e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 116e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver 117ccc4c13ae6cf774126749a5ad8f45de0c08edbeeBen Gruver public static int checkShortCodeOffset(int register) { 118f8a63e41aa4efd84eabc31fd7a715d1ea0949cc0Ben Gruver if (register < -32768 || register > 32768) { 119e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver throw new IllegalArgumentException( 120e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver String.format("Invalid code offset: %d. Must be between -32768 and 32767, inclusive.", register)); 121e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 122e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver return register; 123e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 124e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver 125e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver public static int check35cRegisterCount(int registerCount) { 126e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver if (registerCount < 0 || registerCount > 5) { 127e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver throw new IllegalArgumentException( 128e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver String.format("Invalid register count: %d. Must be between 0 and 5, inclusive.", registerCount)); 129e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 130e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver return registerCount; 131e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 132e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver 133e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver public static int check3rcRegisterCount(int registerCount) { 134d62490d669fb436c14c3387b16ff4a416cc7ad3bBen Gruver if ((registerCount & 0xFFFFFF00) != 0) { 135e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver throw new IllegalArgumentException( 136e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver String.format("Invalid register count: %d. Must be between 0 and 255, inclusive.", registerCount)); 137e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 138e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver return registerCount; 139e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver } 1407c71ad420dbdfe2e36f205d335a261435181a25bBen Gruver 1417c71ad420dbdfe2e36f205d335a261435181a25bBen Gruver public static void checkValueArg(int valueArg, int maxValue) { 1420aeaeecb11019bf52ea1ad46085b694159e666e1Ben Gruver if (valueArg > maxValue) { 14322c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver if (maxValue == 0) { 14422c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver throw new IllegalArgumentException( 14522c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver String.format("Invalid value_arg value %d for an encoded_value. Expecting 0", 14622c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver valueArg)); 14722c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver } 1487c71ad420dbdfe2e36f205d335a261435181a25bBen Gruver throw new IllegalArgumentException( 1497c71ad420dbdfe2e36f205d335a261435181a25bBen Gruver String.format("Invalid value_arg value %d for an encoded_value. Expecting 0..%d, inclusive", 1507c71ad420dbdfe2e36f205d335a261435181a25bBen Gruver valueArg, maxValue)); 1517c71ad420dbdfe2e36f205d335a261435181a25bBen Gruver } 1527c71ad420dbdfe2e36f205d335a261435181a25bBen Gruver } 153e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver 154e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver public static int checkFieldOffset(int fieldOffset) { 155e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver if (fieldOffset < 0 || fieldOffset > 65535) { 156e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver throw new IllegalArgumentException( 157e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver String.format("Invalid field offset: 0x%x. Must be between 0x0000 and 0xFFFF inclusive", 158e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver fieldOffset)); 159e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver } 160e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver return fieldOffset; 161e88723c666db87d414e126ac6d94d683d86ad28dBen Gruver } 1628a151ae671f6d5c99d55779005580834b49187f0Ben Gruver 1638a151ae671f6d5c99d55779005580834b49187f0Ben Gruver public static int checkVtableIndex(int vtableIndex) { 1648a151ae671f6d5c99d55779005580834b49187f0Ben Gruver if (vtableIndex < 0 || vtableIndex > 65535) { 1658a151ae671f6d5c99d55779005580834b49187f0Ben Gruver throw new IllegalArgumentException( 1668a151ae671f6d5c99d55779005580834b49187f0Ben Gruver String.format("Invalid vtable index: %d. Must be between 0 and 65535, inclusive", vtableIndex)); 1678a151ae671f6d5c99d55779005580834b49187f0Ben Gruver } 1688a151ae671f6d5c99d55779005580834b49187f0Ben Gruver return vtableIndex; 1698a151ae671f6d5c99d55779005580834b49187f0Ben Gruver } 1702a91d72a1534dd8171d8296ce8312de4bd603451Ben Gruver 1712a91d72a1534dd8171d8296ce8312de4bd603451Ben Gruver public static int checkInlineIndex(int inlineIndex) { 1722a91d72a1534dd8171d8296ce8312de4bd603451Ben Gruver if (inlineIndex < 0 || inlineIndex > 65535) { 1732a91d72a1534dd8171d8296ce8312de4bd603451Ben Gruver throw new IllegalArgumentException( 1742a91d72a1534dd8171d8296ce8312de4bd603451Ben Gruver String.format("Invalid inline index: %d. Must be between 0 and 65535, inclusive", inlineIndex)); 1752a91d72a1534dd8171d8296ce8312de4bd603451Ben Gruver } 1762a91d72a1534dd8171d8296ce8312de4bd603451Ben Gruver return inlineIndex; 1772a91d72a1534dd8171d8296ce8312de4bd603451Ben Gruver } 178e2f00f0eba79723388f2152db7b68c64872d7eb3Ben Gruver} 179