1b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato/* 2b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * ProGuard -- shrinking, optimization, obfuscation, and preverification 3b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * of Java bytecode. 4b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * 52270795fbe0b277bfd49f40950ecaa78583175ccBrian Carlstrom * Copyright (c) 2002-2014 Eric Lafortune (eric@graphics.cornell.edu) 6b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * 7b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * This program is free software; you can redistribute it and/or modify it 8b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * under the terms of the GNU General Public License as published by the Free 9b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Software Foundation; either version 2 of the License, or (at your option) 10b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * any later version. 11b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * 12b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * This program is distributed in the hope that it will be useful, but WITHOUT 13b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 14b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 15b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * more details. 16b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * 17b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * You should have received a copy of the GNU General Public License along 18b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * with this program; if not, write to the Free Software Foundation, Inc., 19b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 20b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 21b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratopackage proguard; 22b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 23b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratoimport proguard.classfile.*; 24b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratoimport proguard.classfile.util.*; 25b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratoimport proguard.classfile.visitor.*; 26b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wangimport proguard.optimize.*; 27b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 28b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratoimport java.util.List; 29b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 30b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato/** 31b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * This class checks whether classes referenced by class members that are 32b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * marked to be kept are marked to be kept too. 33b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * 34b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * @author Eric Lafortune 35b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 36b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratopublic class DescriptorKeepChecker 37b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratoextends SimplifiedVisitor 38b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onoratoimplements MemberVisitor, 39b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato ClassVisitor 40b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato{ 41b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private final ClassPool programClassPool; 42b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private final ClassPool libraryClassPool; 43b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private final WarningPrinter notePrinter; 44b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 45b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato // Some fields acting as parameters for the class visitor. 46b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private Clazz referencingClass; 47b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private Member referencingMember; 48b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato private boolean isField; 49b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 50b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 51b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato /** 52b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Creates a new DescriptorKeepChecker. 53b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 54b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public DescriptorKeepChecker(ClassPool programClassPool, 55b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato ClassPool libraryClassPool, 56b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato WarningPrinter notePrinter) 57b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 58b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.programClassPool = programClassPool; 59b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.libraryClassPool = libraryClassPool; 60b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato this.notePrinter = notePrinter; 61b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 62b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 63b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 64b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato /** 65b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato * Checks the classes mentioned in the given keep specifications, printing 66b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang * notes if necessary. 67b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato */ 68b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public void checkClassSpecifications(List keepSpecifications) 69b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 70b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato // Clean up any old visitor info. 71b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato programClassPool.classesAccept(new ClassCleaner()); 72b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato libraryClassPool.classesAccept(new ClassCleaner()); 73b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 74b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato // Create a visitor for marking the seeds. 75b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato KeepMarker keepMarker = new KeepMarker(); 76b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato ClassPoolVisitor classPoolvisitor = 77b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato ClassSpecificationVisitorFactory.createClassPoolVisitor(keepSpecifications, 78b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato keepMarker, 79b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato keepMarker, 80b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato false, 81b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato true, 82b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato true); 83b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato // Mark the seeds. 84b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato programClassPool.accept(classPoolvisitor); 85b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato libraryClassPool.accept(classPoolvisitor); 86b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 87b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang // Print out notes about argument types that are not being kept in 88b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang // class members that are being kept. 89b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang programClassPool.classesAccept( 90b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang new AllMemberVisitor( 91b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang new KeptMemberFilter(this))); 92b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 93b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 94b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 95b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato // Implementations for MemberVisitor. 96b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 97b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public void visitProgramField(ProgramClass programClass, ProgramField programField) 98b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 99b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang //referencingClass = programClass; 100b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang //referencingMember = programField; 101b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang //isField = true; 102b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang // 103b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang // Don't check the type, because it is not required for introspection. 104b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang //programField.referencedClassesAccept(this); 105b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 106b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 107b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 108b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public void visitProgramMethod(ProgramClass programClass, ProgramMethod programMethod) 109b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 110b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang referencingClass = programClass; 111b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang referencingMember = programMethod; 112b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang isField = false; 113b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang 114b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang // Don't check the return type, because it is not required for 115b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang // introspection (e.g. the return type of the special Enum methods). 116b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang //programMethod.referencedClassesAccept(this); 117b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang 118b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang Clazz[] referencedClasses = programMethod.referencedClasses; 119b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang if (referencedClasses != null) 120b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 121b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang int count = referencedClasses.length; 122b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 123b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang // Adapt the count if the return type is a class type (not so 124b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang // pretty; assuming test just checks for final ';'). 125b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang if (ClassUtil.isInternalClassType(programMethod.getDescriptor(programClass))) 126b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang { 127b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang count--; 128b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang } 129b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 130b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang for (int index = 0; index < count; index++) 131b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 132b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang if (referencedClasses[index] != null) 133b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 134b9cc48a43ed984587c939d02fba5316bf5c0df6eYing Wang referencedClasses[index].accept(this); 135b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 136b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 137b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 138b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 139b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 140b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 141b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato // Implementations for ClassVisitor. 142b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 143b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public void visitProgramClass(ProgramClass programClass) 144b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 145b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato if (!KeepMarker.isKept(programClass)) 146b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato { 147b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato notePrinter.print(referencingClass.getName(), 148b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato programClass.getName(), 149b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato "Note: the configuration keeps the entry point '" + 150b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato ClassUtil.externalClassName(referencingClass.getName()) + 151b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato " { " + 152b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato (isField ? 153b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato ClassUtil.externalFullFieldDescription(0, 154b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato referencingMember.getName(referencingClass), 155b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato referencingMember.getDescriptor(referencingClass)) : 156b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato ClassUtil.externalFullMethodDescription(referencingClass.getName(), 157b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 0, 158b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato referencingMember.getName(referencingClass), 159b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato referencingMember.getDescriptor(referencingClass))) + 160b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato "; }', but not the descriptor class '" + 161b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato ClassUtil.externalClassName(programClass.getName()) + 162b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato "'"); 163b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 164b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato } 165b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 166b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato 167b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato public void visitLibraryClass(LibraryClass libraryClass) {} 168b72c5c2e5482cf10117b2b25f642f7616b2326c3Joe Onorato} 169