1579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson/* 2579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Copyright (C) 2011 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; 18579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 19579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson/** 20579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Constants that show up in and are otherwise related to {@code .dex} 21579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * files, and helper methods for same. 22579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 23579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonpublic final class DexFormat { 24579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson private DexFormat() {} 25579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 26579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 27579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * API level to target in order to produce the most modern file 28579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * format 29579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 30579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public static final int API_CURRENT = 14; 31579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 32579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** API level to target in order to suppress extended opcode usage */ 33579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public static final int API_NO_EXTENDED_OPCODES = 13; 34579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 35579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 36579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * file name of the primary {@code .dex} file inside an 37579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * application or library {@code .jar} file 38579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 39579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public static final String DEX_IN_JAR_NAME = "classes.dex"; 40579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 41579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** common prefix for all dex file "magic numbers" */ 42579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public static final String MAGIC_PREFIX = "dex\n"; 43579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 44579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** common suffix for all dex file "magic numbers" */ 45579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public static final String MAGIC_SUFFIX = "\0"; 46579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 47579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** dex file version number for the current format variant */ 48579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public static final String VERSION_CURRENT = "036"; 49579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 50579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** dex file version number for API level 13 and earlier */ 51579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public static final String VERSION_FOR_API_13 = "035"; 52579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 53579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 54579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * value used to indicate endianness of file contents 55579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 56579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public static final int ENDIAN_TAG = 0x12345678; 57579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 58579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 59579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Returns the API level corresponding to the given magic number, 60579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * or {@code -1} if the given array is not a well-formed dex file 61579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * magic number. 62579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 63579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public static int magicToApi(byte[] magic) { 64579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (magic.length != 8) { 65579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return -1; 66579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 67579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 68579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if ((magic[0] != 'd') || (magic[1] != 'e') || (magic[2] != 'x') || (magic[3] != '\n') || 69579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson (magic[7] != '\0')) { 70579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return -1; 71579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 72579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 73579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson String version = "" + ((char) magic[4]) + ((char) magic[5]) +((char) magic[6]); 74579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 75579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (version.equals(VERSION_CURRENT)) { 76579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return API_CURRENT; 77579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } else if (version.equals(VERSION_FOR_API_13)) { 78579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return 13; 79579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 80579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 81579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return -1; 82579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 83579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 84579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 85579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Returns the magic number corresponding to the given target API level. 86579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 87579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public static String apiToMagic(int targetApiLevel) { 88579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson String version; 89579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 90579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (targetApiLevel >= API_CURRENT) { 91579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson version = VERSION_CURRENT; 92579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } else { 93579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson version = VERSION_FOR_API_13; 94579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 95579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 96579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return MAGIC_PREFIX + version + MAGIC_SUFFIX; 97579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 98579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson} 99