/* * * * Apache License * Version 2.0, January 2004 * http://www.apache.org/licenses/ * * TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION * * 1. Definitions. * * "License" shall mean the terms and conditions for use, reproduction, * and distribution as defined by Sections 1 through 9 of this document. * * "Licensor" shall mean the copyright owner or entity authorized by * the copyright owner that is granting the License. * * "Legal Entity" shall mean the union of the acting entity and all * other entities that control, are controlled by, or are under common * control with that entity. For the purposes of this definition, * "control" means (i) the power, direct or indirect, to cause the * direction or management of such entity, whether by contract or * otherwise, or (ii) ownership of fifty percent (50%) or more of the * outstanding shares, or (iii) beneficial ownership of such entity. * * "You" (or "Your") shall mean an individual or Legal Entity * exercising permissions granted by this License. * * "Source" form shall mean the preferred form for making modifications, * including but not limited to software source code, documentation * source, and configuration files. * * "Object" form shall mean any form resulting from mechanical * transformation or translation of a Source form, including but * not limited to compiled object code, generated documentation, * and conversions to other media types. * * "Work" shall mean the work of authorship, whether in Source or * Object form, made available under the License, as indicated by a * copyright notice that is included in or attached to the work * (an example is provided in the Appendix below). * * "Derivative Works" shall mean any work, whether in Source or Object * form, that is based on (or derived from) the Work and for which the * editorial revisions, annotations, elaborations, or other modifications * represent, as a whole, an original work of authorship. For the purposes * of this License, Derivative Works shall not include works that remain * separable from, or merely link (or bind by name) to the interfaces of, * the Work and Derivative Works thereof. * * "Contribution" shall mean any work of authorship, including * the original version of the Work and any modifications or additions * to that Work or Derivative Works thereof, that is intentionally * submitted to Licensor for inclusion in the Work by the copyright owner * or by an individual or Legal Entity authorized to submit on behalf of * the copyright owner. For the purposes of this definition, "submitted" * means any form of electronic, verbal, or written communication sent * to the Licensor or its representatives, including but not limited to * communication on electronic mailing lists, source code control systems, * and issue tracking systems that are managed by, or on behalf of, the * Licensor for the purpose of discussing and improving the Work, but * excluding communication that is conspicuously marked or otherwise * designated in writing by the copyright owner as "Not a Contribution." * * "Contributor" shall mean Licensor and any individual or Legal Entity * on behalf of whom a Contribution has been received by Licensor and * subsequently incorporated within the Work. * * 2. Grant of Copyright License. Subject to the terms and conditions of * this License, each Contributor hereby grants to You a perpetual, * worldwide, non-exclusive, no-charge, royalty-free, irrevocable * copyright license to reproduce, prepare Derivative Works of, * publicly display, publicly perform, sublicense, and distribute the * Work and such Derivative Works in Source or Object form. * * 3. Grant of Patent License. Subject to the terms and conditions of * this License, each Contributor hereby grants to You a perpetual, * worldwide, non-exclusive, no-charge, royalty-free, irrevocable * (except as stated in this section) patent license to make, have made, * use, offer to sell, sell, import, and otherwise transfer the Work, * where such license applies only to those patent claims licensable * by such Contributor that are necessarily infringed by their * Contribution(s) alone or by combination of their Contribution(s) * with the Work to which such Contribution(s) was submitted. If You * institute patent litigation against any entity (including a * cross-claim or counterclaim in a lawsuit) alleging that the Work * or a Contribution incorporated within the Work constitutes direct * or contributory patent infringement, then any patent licenses * granted to You under this License for that Work shall terminate * as of the date such litigation is filed. * * 4. Redistribution. You may reproduce and distribute copies of the * Work or Derivative Works thereof in any medium, with or without * modifications, and in Source or Object form, provided that You * meet the following conditions: * * (a) You must give any other recipients of the Work or * Derivative Works a copy of this License; and * * (b) You must cause any modified files to carry prominent notices * stating that You changed the files; and * * (c) You must retain, in the Source form of any Derivative Works * that You distribute, all copyright, patent, trademark, and * attribution notices from the Source form of the Work, * excluding those notices that do not pertain to any part of * the Derivative Works; and * * (d) If the Work includes a "NOTICE" text file as part of its * distribution, then any Derivative Works that You distribute must * include a readable copy of the attribution notices contained * within such NOTICE file, excluding those notices that do not * pertain to any part of the Derivative Works, in at least one * of the following places: within a NOTICE text file distributed * as part of the Derivative Works; within the Source form or * documentation, if provided along with the Derivative Works; or, * within a display generated by the Derivative Works, if and * wherever such third-party notices normally appear. The contents * of the NOTICE file are for informational purposes only and * do not modify the License. You may add Your own attribution * notices within Derivative Works that You distribute, alongside * or as an addendum to the NOTICE text from the Work, provided * that such additional attribution notices cannot be construed * as modifying the License. * * You may add Your own copyright statement to Your modifications and * may provide additional or different license terms and conditions * for use, reproduction, or distribution of Your modifications, or * for any such Derivative Works as a whole, provided Your use, * reproduction, and distribution of the Work otherwise complies with * the conditions stated in this License. * * 5. Submission of Contributions. Unless You explicitly state otherwise, * any Contribution intentionally submitted for inclusion in the Work * by You to the Licensor shall be under the terms and conditions of * this License, without any additional terms or conditions. * Notwithstanding the above, nothing herein shall supersede or modify * the terms of any separate license agreement you may have executed * with Licensor regarding such Contributions. * * 6. Trademarks. This License does not grant permission to use the trade * names, trademarks, service marks, or product names of the Licensor, * except as required for reasonable and customary use in describing the * origin of the Work and reproducing the content of the NOTICE file. * * 7. Disclaimer of Warranty. Unless required by applicable law or * agreed to in writing, Licensor provides the Work (and each * Contributor provides its Contributions) on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or * implied, including, without limitation, any warranties or conditions * of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A * PARTICULAR PURPOSE. You are solely responsible for determining the * appropriateness of using or redistributing the Work and assume any * risks associated with Your exercise of permissions under this License. * * 8. Limitation of Liability. In no event and under no legal theory, * whether in tort (including negligence), contract, or otherwise, * unless required by applicable law (such as deliberate and grossly * negligent acts) or agreed to in writing, shall any Contributor be * liable to You for damages, including any direct, indirect, special, * incidental, or consequential damages of any character arising as a * result of this License or out of the use or inability to use the * Work (including but not limited to damages for loss of goodwill, * work stoppage, computer failure or malfunction, or any and all * other commercial damages or losses), even if such Contributor * has been advised of the possibility of such damages. * * 9. Accepting Warranty or Additional Liability. While redistributing * the Work or Derivative Works thereof, You may choose to offer, * and charge a fee for, acceptance of support, warranty, indemnity, * or other liability obligations and/or rights consistent with this * License. However, in accepting such obligations, You may act only * on Your own behalf and on Your sole responsibility, not on behalf * of any other Contributor, and only if You agree to indemnify, * defend, and hold each Contributor harmless for any liability * incurred by, or claims asserted against, such Contributor by reason * of your accepting any such warranty or additional liability. * * END OF TERMS AND CONDITIONS * * APPENDIX: How to apply the Apache License to your work. * * To apply the Apache License to your work, attach the following * boilerplate notice, with the fields enclosed by brackets "[]" * replaced with your own identifying information. (Don't include * the brackets!) The text should be enclosed in the appropriate * comment syntax for the file format. We also recommend that a * file or class name and description of purpose be included on the * same "printed page" as the copyright notice for easier * identification within third-party archives. * * Copyright 2016 Alibaba Group * * 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. * * */ package com.taobao.common.dexpatcher.algorithms.diff; import com.taobao.common.dexpatcher.struct.PatchOperation; import com.taobao.dex.Dex; import com.taobao.dex.SizeOf; import com.taobao.dex.TableOfContents; import com.taobao.dex.io.DexDataBuffer; import com.taobao.dex.util.CompareUtils; import com.taobao.dx.util.IndexMap; import java.util.*; public abstract class DexSectionDiffAlgorithm<T extends Comparable<T>> { private static final AbstractMap.SimpleEntry[] EMPTY_ENTRY_ARRAY = new AbstractMap.SimpleEntry[0]; protected final Dex oldDex; protected final Dex newDex; /** * IndexMap for mapping items between old dex and new dex. * e.g. item.oldIndex => item.newIndex */ private final IndexMap oldToNewIndexMap; /** * IndexMap for mapping items between old dex and patched dex. * e.g. item.oldIndex => item.patchedIndex */ private final IndexMap oldToPatchedIndexMap; /** * IndexMap for mapping items between new dex and patched dex. * e.g. item.newIndex => item.newIndexInPatchedDex */ private final IndexMap newToPatchedIndexMap; /** * IndexMap for mapping items in new dex when skip items. */ private final IndexMap selfIndexMapForSkip; private final List<PatchOperation<T>> patchOperationList; private final Map<Integer, PatchOperation<T>> indexToDelOperationMap = new HashMap<Integer, PatchOperation<T>>(); private final Map<Integer, PatchOperation<T>> indexToAddOperationMap = new HashMap<Integer, PatchOperation<T>>(); private final Map<Integer, PatchOperation<T>> indexToReplaceOperationMap = new HashMap<Integer, PatchOperation<T>>(); private final Map<Integer, Integer> oldIndexToNewIndexMap = new HashMap<Integer, Integer>(); private final Map<Integer, Integer> oldOffsetToNewOffsetMap = new HashMap<Integer, Integer>(); private int patchedSectionSize; private Comparator<AbstractMap.SimpleEntry<Integer, T>> comparatorForItemDiff = new Comparator<AbstractMap.SimpleEntry<Integer, T>>() { @Override public int compare(AbstractMap.SimpleEntry<Integer, T> o1, AbstractMap.SimpleEntry<Integer, T> o2) { return o1.getValue().compareTo(o2.getValue()); } }; private Comparator<PatchOperation<T>> comparatorForPatchOperationOpt = new Comparator<PatchOperation<T>>() { @Override public int compare(PatchOperation<T> o1, PatchOperation<T> o2) { if (o1.index != o2.index) { return CompareUtils.sCompare(o1.index, o2.index); } int o1OrderId; switch (o1.op) { case PatchOperation.OP_DEL: o1OrderId = 0; break; case PatchOperation.OP_ADD: o1OrderId = 1; break; case PatchOperation.OP_REPLACE: o1OrderId = 2; break; default: throw new IllegalStateException("unexpected patch operation code: " + o1.op); } int o2OrderId; switch (o2.op) { case PatchOperation.OP_DEL: o2OrderId = 0; break; case PatchOperation.OP_ADD: o2OrderId = 1; break; case PatchOperation.OP_REPLACE: o2OrderId = 2; break; default: throw new IllegalStateException("unexpected patch operation code: " + o2.op); } return CompareUtils.sCompare(o1OrderId, o2OrderId); } }; private AbstractMap.SimpleEntry<Integer, T>[] adjustedOldIndexedItemsWithOrigOrder = null; private int oldItemCount = 0; private int newItemCount = 0; public DexSectionDiffAlgorithm( Dex oldDex, Dex newDex, IndexMap oldToNewIndexMap, IndexMap oldToPatchedIndexMap, IndexMap newToPatchedIndexMap, IndexMap selfIndexMapForSkip ) { this.oldDex = oldDex; this.newDex = newDex; this.oldToNewIndexMap = oldToNewIndexMap; this.oldToPatchedIndexMap = oldToPatchedIndexMap; this.newToPatchedIndexMap = newToPatchedIndexMap; this.selfIndexMapForSkip = selfIndexMapForSkip; this.patchOperationList = new ArrayList<PatchOperation<T>>(); this.patchedSectionSize = 0; } public List<PatchOperation<T>> getPatchOperationList() { return this.patchOperationList; } public int getPatchedSectionSize() { return this.patchedSectionSize; } /** * Get {@code Section} in {@code TableOfContents}. */ protected abstract TableOfContents.Section getTocSection(Dex dex); /** * Get next item in {@code section}. */ protected abstract T nextItem(DexDataBuffer section); /** * Get item size. */ protected abstract int getItemSize(T item); /** * Adjust {@code item} using specific {@code indexMap} */ protected T adjustItem(IndexMap indexMap, T item) { return item; } /** * Indicate if {@code item} should be skipped in new dex. */ protected boolean shouldSkipInNewDex(T newItem) { return false; } /** * Update index or offset mapping in {@code indexMap}. */ protected void updateIndexOrOffset(IndexMap indexMap, int oldIndex, int oldOffset, int newIndex, int newOffset) { // Should override by subclass if needed. } /** * Mark deleted index or offset in {@code indexMap}. * * Here we mark deleted item for such a case like this: * Item in DebugInfo section reference a string in StringData section * by index X, while in patched dex, the referenced string is removed. * * The {@code indexMap} must be aware of this case and return -1 * instead of the original value X. * * Further more, the special value -1 is not chosen by our inspiration but * the definition of NO_INDEX in document of dex file format. */ protected void markDeletedIndexOrOffset(IndexMap indexMap, int deletedIndex, int deletedOffset) { // Should override by subclass if needed. } /** * Adapter method for item's offset fetching, if an item is not * inherited from {@code Item} (which means it is a simple item in dex section * that doesn't need multiple members to describe), this method * return {@code index} instead. */ private int getItemOffsetOrIndex(int index, T item) { if (item instanceof TableOfContents.Section.Item) { return ((TableOfContents.Section.Item<?>) item).off; } else { return index; } } @SuppressWarnings("unchecked,NewApi") private AbstractMap.SimpleEntry<Integer, T>[] collectSectionItems(Dex dex, boolean isOldDex) { TableOfContents.Section tocSec = getTocSection(dex); if (!tocSec.exists()) { return EMPTY_ENTRY_ARRAY; } Dex.Section dexSec = dex.openSection(tocSec); int itemCount = tocSec.size; List<AbstractMap.SimpleEntry<Integer, T>> result = new ArrayList<AbstractMap.SimpleEntry<Integer, T>>(itemCount); if (isOldDex) { for (int i = 0; i < itemCount; ++i) { T nextItem = nextItem(dexSec); T adjustedItem = adjustItem(oldToPatchedIndexMap, nextItem); result.add(new AbstractMap.SimpleEntry<Integer, T>(i, adjustedItem)); } } else { int i = 0; while (i < itemCount) { T nextItem = nextItem(dexSec); int indexBeforeSkip = i; int offsetBeforeSkip = getItemOffsetOrIndex(indexBeforeSkip, nextItem); int indexAfterSkip = indexBeforeSkip; while (indexAfterSkip < itemCount && shouldSkipInNewDex(nextItem)) { if (indexAfterSkip + 1 >= itemCount) { // after skipping last item, nextItem will be null. nextItem = null; } else { nextItem = nextItem(dexSec); } ++indexAfterSkip; } if (nextItem != null) { int offsetAfterSkip = getItemOffsetOrIndex(indexAfterSkip, nextItem); T adjustedItem = adjustItem(newToPatchedIndexMap, adjustItem(selfIndexMapForSkip, nextItem)); int currentOutIndex = result.size(); result.add(new AbstractMap.SimpleEntry<Integer, T>(currentOutIndex, adjustedItem)); updateIndexOrOffset(selfIndexMapForSkip, indexBeforeSkip, offsetBeforeSkip, indexAfterSkip, offsetAfterSkip); } i = indexAfterSkip; ++i; } } return result.toArray(new AbstractMap.SimpleEntry[0]); } public void execute() { this.patchOperationList.clear(); this.adjustedOldIndexedItemsWithOrigOrder = collectSectionItems(this.oldDex, true); this.oldItemCount = this.adjustedOldIndexedItemsWithOrigOrder.length; AbstractMap.SimpleEntry<Integer, T>[] adjustedOldIndexedItems = new AbstractMap.SimpleEntry[this.oldItemCount]; System.arraycopy(this.adjustedOldIndexedItemsWithOrigOrder, 0, adjustedOldIndexedItems, 0, this.oldItemCount); Arrays.sort(adjustedOldIndexedItems, this.comparatorForItemDiff); AbstractMap.SimpleEntry<Integer, T>[] adjustedNewIndexedItems = collectSectionItems(this.newDex, false); this.newItemCount = adjustedNewIndexedItems.length; Arrays.sort(adjustedNewIndexedItems, this.comparatorForItemDiff); int oldCursor = 0; int newCursor = 0; while (oldCursor < this.oldItemCount || newCursor < this.newItemCount) { if (oldCursor >= this.oldItemCount) { // rest item are all newItem. while (newCursor < this.newItemCount) { AbstractMap.SimpleEntry<Integer, T> newIndexedItem = adjustedNewIndexedItems[newCursor++]; this.patchOperationList.add(new PatchOperation<T>(PatchOperation.OP_ADD, newIndexedItem.getKey(), newIndexedItem.getValue())); } } else if (newCursor >= newItemCount) { // rest item are all oldItem. while (oldCursor < oldItemCount) { AbstractMap.SimpleEntry<Integer, T> oldIndexedItem = adjustedOldIndexedItems[oldCursor++]; int deletedIndex = oldIndexedItem.getKey(); int deletedOffset = getItemOffsetOrIndex(deletedIndex, oldIndexedItem.getValue()); this.patchOperationList.add(new PatchOperation<T>(PatchOperation.OP_DEL, deletedIndex)); markDeletedIndexOrOffset(this.oldToPatchedIndexMap, deletedIndex, deletedOffset); } } else { AbstractMap.SimpleEntry<Integer, T> oldIndexedItem = adjustedOldIndexedItems[oldCursor]; AbstractMap.SimpleEntry<Integer, T> newIndexedItem = adjustedNewIndexedItems[newCursor]; int cmpRes = oldIndexedItem.getValue().compareTo(newIndexedItem.getValue()); if (cmpRes < 0) { int deletedIndex = oldIndexedItem.getKey(); int deletedOffset = getItemOffsetOrIndex(deletedIndex, oldIndexedItem.getValue()); this.patchOperationList.add(new PatchOperation<T>(PatchOperation.OP_DEL, deletedIndex)); markDeletedIndexOrOffset(this.oldToPatchedIndexMap, deletedIndex, deletedOffset); ++oldCursor; } else if (cmpRes > 0) { this.patchOperationList.add(new PatchOperation<T>(PatchOperation.OP_ADD, newIndexedItem.getKey(), newIndexedItem.getValue())); ++newCursor; } else { int oldIndex = oldIndexedItem.getKey(); int newIndex = newIndexedItem.getKey(); int oldOffset = getItemOffsetOrIndex(oldIndexedItem.getKey(), oldIndexedItem.getValue()); int newOffset = getItemOffsetOrIndex(newIndexedItem.getKey(), newIndexedItem.getValue()); if (oldIndex != newIndex) { this.oldIndexToNewIndexMap.put(oldIndex, newIndex); } if (oldOffset != newOffset) { this.oldOffsetToNewOffsetMap.put(oldOffset, newOffset); } ++oldCursor; ++newCursor; } } } // So far all diff works are done. Then we perform some optimize works. // detail: {OP_DEL idx} followed by {OP_ADD the_same_idx newItem} // will be replaced by {OP_REPLACE idx newItem} Collections.sort(this.patchOperationList, comparatorForPatchOperationOpt); Iterator<PatchOperation<T>> patchOperationIt = this.patchOperationList.iterator(); PatchOperation<T> prevPatchOperation = null; while (patchOperationIt.hasNext()) { PatchOperation<T> patchOperation = patchOperationIt.next(); if (prevPatchOperation != null && prevPatchOperation.op == PatchOperation.OP_DEL && patchOperation.op == PatchOperation.OP_ADD ) { if (prevPatchOperation.index == patchOperation.index) { prevPatchOperation.op = PatchOperation.OP_REPLACE; prevPatchOperation.newItem = patchOperation.newItem; patchOperationIt.remove(); prevPatchOperation = null; } else { prevPatchOperation = patchOperation; } } else { prevPatchOperation = patchOperation; } } // Finally we record some information for the final calculations. patchOperationIt = this.patchOperationList.iterator(); while (patchOperationIt.hasNext()) { PatchOperation<T> patchOperation = patchOperationIt.next(); switch (patchOperation.op) { case PatchOperation.OP_DEL: { indexToDelOperationMap.put(patchOperation.index, patchOperation); break; } case PatchOperation.OP_ADD: { indexToAddOperationMap.put(patchOperation.index, patchOperation); break; } case PatchOperation.OP_REPLACE: { indexToReplaceOperationMap.put(patchOperation.index, patchOperation); break; } } } } public void simulatePatchOperation(int baseOffset) { boolean isNeedToMakeAlign = getTocSection(this.oldDex).isElementFourByteAligned; int oldIndex = 0; int patchedIndex = 0; int patchedOffset = baseOffset; while (oldIndex < this.oldItemCount || patchedIndex < this.newItemCount) { if (this.indexToAddOperationMap.containsKey(patchedIndex)) { PatchOperation<T> patchOperation = this.indexToAddOperationMap.get(patchedIndex); if (isNeedToMakeAlign) { patchedOffset = SizeOf.roundToTimesOfFour(patchedOffset); } T newItem = patchOperation.newItem; int itemSize = getItemSize(newItem); updateIndexOrOffset( this.newToPatchedIndexMap, 0, getItemOffsetOrIndex(patchOperation.index, newItem), 0, patchedOffset ); ++patchedIndex; patchedOffset += itemSize; } else if (this.indexToReplaceOperationMap.containsKey(patchedIndex)) { PatchOperation<T> patchOperation = this.indexToReplaceOperationMap.get(patchedIndex); if (isNeedToMakeAlign) { patchedOffset = SizeOf.roundToTimesOfFour(patchedOffset); } T newItem = patchOperation.newItem; int itemSize = getItemSize(newItem); updateIndexOrOffset( this.newToPatchedIndexMap, 0, getItemOffsetOrIndex(patchOperation.index, newItem), 0, patchedOffset ); ++patchedIndex; patchedOffset += itemSize; } else if (this.indexToDelOperationMap.containsKey(oldIndex)) { ++oldIndex; } else if (this.indexToReplaceOperationMap.containsKey(oldIndex)) { ++oldIndex; } else if (oldIndex < this.oldItemCount) { if (isNeedToMakeAlign) { patchedOffset = SizeOf.roundToTimesOfFour(patchedOffset); } T oldItem = this.adjustedOldIndexedItemsWithOrigOrder[oldIndex].getValue(); int itemSize = getItemSize(oldItem); int oldOffset = getItemOffsetOrIndex(oldIndex, oldItem); updateIndexOrOffset( this.oldToPatchedIndexMap, oldIndex, oldOffset, patchedIndex, patchedOffset ); int newIndex = oldIndex; if (this.oldIndexToNewIndexMap.containsKey(oldIndex)) { newIndex = this.oldIndexToNewIndexMap.get(oldIndex); } int newOffset = oldOffset; if (this.oldOffsetToNewOffsetMap.containsKey(oldOffset)) { newOffset = this.oldOffsetToNewOffsetMap.get(oldOffset); } updateIndexOrOffset( this.newToPatchedIndexMap, newIndex, newOffset, patchedIndex, patchedOffset ); ++oldIndex; ++patchedIndex; patchedOffset += itemSize; } } this.patchedSectionSize = SizeOf.roundToTimesOfFour(patchedOffset - baseOffset); } }