aoqi@0: /*
mchung@2538:  * Copyright (c) 2013, 2014, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: package com.sun.tools.jdeps;
aoqi@0: 
aoqi@0: import java.util.HashMap;
mchung@2538: import java.util.HashSet;
aoqi@0: import java.util.List;
aoqi@0: import java.util.Map;
aoqi@0: import java.util.Objects;
aoqi@0: import java.util.Set;
aoqi@0: import java.util.SortedMap;
aoqi@0: import java.util.SortedSet;
aoqi@0: import java.util.TreeMap;
aoqi@0: import java.util.TreeSet;
aoqi@0: 
mchung@2538: import com.sun.tools.classfile.Dependency.Location;
mchung@2538: import com.sun.tools.jdeps.PlatformClassPath.JDKArchive;
mchung@2538: 
aoqi@0: /**
aoqi@0:  * Dependency Analyzer.
aoqi@0:  */
aoqi@0: public class Analyzer {
aoqi@0:     /**
aoqi@0:      * Type of the dependency analysis.  Appropriate level of data
aoqi@0:      * will be stored.
aoqi@0:      */
aoqi@0:     public enum Type {
aoqi@0:         SUMMARY,
aoqi@0:         PACKAGE,
aoqi@0:         CLASS,
aoqi@0:         VERBOSE
aoqi@0:     };
aoqi@0: 
mchung@2538:     /**
mchung@2538:      * Filter to be applied when analyzing the dependencies from the given archives.
mchung@2538:      * Only the accepted dependencies are recorded.
mchung@2538:      */
mchung@2538:     interface Filter {
mchung@2538:         boolean accepts(Location origin, Archive originArchive, Location target, Archive targetArchive);
mchung@2538:     }
mchung@2538: 
aoqi@0:     private final Type type;
mchung@2538:     private final Filter filter;
aoqi@0:     private final Map<Archive, ArchiveDeps> results = new HashMap<>();
aoqi@0:     private final Map<Location, Archive> map = new HashMap<>();
aoqi@0:     private final Archive NOT_FOUND
aoqi@0:         = new Archive(JdepsTask.getMessage("artifact.not.found"));
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Constructs an Analyzer instance.
aoqi@0:      *
aoqi@0:      * @param type Type of the dependency analysis
mchung@2538:      * @param filter
aoqi@0:      */
mchung@2538:     public Analyzer(Type type, Filter filter) {
aoqi@0:         this.type = type;
mchung@2538:         this.filter = filter;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Performs the dependency analysis on the given archives.
aoqi@0:      */
aoqi@0:     public void run(List<Archive> archives) {
aoqi@0:         // build a map from Location to Archive
mchung@2538:         buildLocationArchiveMap(archives);
mchung@2538: 
mchung@2538:         // traverse and analyze all dependencies
mchung@2538:         for (Archive archive : archives) {
mchung@2538:             ArchiveDeps deps = new ArchiveDeps(archive, type);
mchung@2538:             archive.visitDependences(deps);
mchung@2538:             results.put(archive, deps);
mchung@2538:         }
mchung@2538:     }
mchung@2538: 
mchung@2538:     private void buildLocationArchiveMap(List<Archive> archives) {
mchung@2538:         // build a map from Location to Archive
aoqi@0:         for (Archive archive: archives) {
aoqi@0:             for (Location l: archive.getClasses()) {
aoqi@0:                 if (!map.containsKey(l)) {
aoqi@0:                     map.put(l, archive);
aoqi@0:                 } else {
aoqi@0:                     // duplicated class warning?
aoqi@0:                 }
aoqi@0:             }
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     public boolean hasDependences(Archive archive) {
aoqi@0:         if (results.containsKey(archive)) {
mchung@2538:             return results.get(archive).dependencies().size() > 0;
aoqi@0:         }
aoqi@0:         return false;
aoqi@0:     }
aoqi@0: 
mchung@2539:     public Set<String> dependences(Archive source) {
mchung@2539:         ArchiveDeps result = results.get(source);
mchung@2539:         return result.targetDependences();
mchung@2539:     }
mchung@2539: 
aoqi@0:     public interface Visitor {
aoqi@0:         /**
aoqi@0:          * Visits a recorded dependency from origin to target which can be
mchung@2538:          * a fully-qualified classname, a package name, a module or
aoqi@0:          * archive name depending on the Analyzer's type.
aoqi@0:          */
mchung@2538:         public void visitDependence(String origin, Archive originArchive,
mchung@2538:                                     String target, Archive targetArchive);
aoqi@0:     }
aoqi@0: 
mchung@2538:     /**
mchung@2538:      * Visit the dependencies of the given source.
mchung@2538:      * If the requested level is SUMMARY, it will visit the required archives list.
mchung@2538:      */
mchung@2538:     public void visitDependences(Archive source, Visitor v, Type level) {
mchung@2538:         if (level == Type.SUMMARY) {
mchung@2538:             final ArchiveDeps result = results.get(source);
mchung@2538:             SortedMap<String, Archive> sorted = new TreeMap<>();
mchung@2538:             for (Archive a : result.requires()) {
mchung@2538:                 sorted.put(a.getName(), a);
mchung@2538:             }
mchung@2538:             for (Archive archive : sorted.values()) {
mchung@2538:                 Profile profile = result.getTargetProfile(archive);
mchung@2538:                 v.visitDependence(source.getName(), source,
mchung@2538:                                   profile != null ? profile.profileName() : archive.getName(), archive);
mchung@2538:             }
mchung@2538:         } else {
mchung@2538:             ArchiveDeps result = results.get(source);
mchung@2538:             if (level != type) {
mchung@2538:                 // requesting different level of analysis
mchung@2538:                 result = new ArchiveDeps(source, level);
mchung@2538:                 source.visitDependences(result);
mchung@2538:             }
mchung@2538:             SortedSet<Dep> sorted = new TreeSet<>(result.dependencies());
mchung@2538:             for (Dep d : sorted) {
mchung@2538:                 v.visitDependence(d.origin(), d.originArchive(), d.target(), d.targetArchive());
mchung@2538:             }
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     public void visitDependences(Archive source, Visitor v) {
mchung@2538:         visitDependences(source, v, type);
mchung@2538:     }
mchung@2538: 
mchung@2538:     /**
mchung@2538:      * ArchiveDeps contains the dependencies for an Archive that can have one or
mchung@2538:      * more classes.
mchung@2538:      */
mchung@2538:     class ArchiveDeps implements Archive.Visitor {
mchung@2538:         protected final Archive archive;
mchung@2538:         protected final Set<Archive> requires;
mchung@2538:         protected final Set<Dep> deps;
mchung@2538:         protected final Type level;
mchung@2538:         private Profile profile;
mchung@2538:         ArchiveDeps(Archive archive, Type level) {
mchung@2538:             this.archive = archive;
mchung@2538:             this.deps = new HashSet<>();
mchung@2538:             this.requires = new HashSet<>();
mchung@2538:             this.level = level;
mchung@2538:         }
mchung@2538: 
mchung@2538:         Set<Dep> dependencies() {
mchung@2538:             return deps;
mchung@2538:         }
mchung@2538: 
mchung@2539:         Set<String> targetDependences() {
mchung@2539:             Set<String> targets = new HashSet<>();
mchung@2539:             for (Dep d : deps) {
mchung@2539:                 targets.add(d.target());
mchung@2539:             }
mchung@2539:             return targets;
mchung@2539:         }
mchung@2539: 
mchung@2538:         Set<Archive> requires() {
mchung@2538:             return requires;
mchung@2538:         }
mchung@2538: 
mchung@2538:         Profile getTargetProfile(Archive target) {
mchung@2538:             return JDKArchive.isProfileArchive(target) ? profile : null;
mchung@2538:         }
mchung@2538: 
mchung@2538:         Archive findArchive(Location t) {
mchung@2538:             Archive target = archive.getClasses().contains(t) ? archive : map.get(t);
mchung@2538:             if (target == null) {
mchung@2538:                 map.put(t, target = NOT_FOUND);
mchung@2538:             }
mchung@2538:             return target;
mchung@2538:         }
mchung@2538: 
mchung@2538:         // return classname or package name depedning on the level
mchung@2538:         private String getLocationName(Location o) {
mchung@2538:             if (level == Type.CLASS || level == Type.VERBOSE) {
mchung@2538:                 return o.getClassName();
mchung@2538:             } else {
mchung@2538:                 String pkg = o.getPackageName();
mchung@2538:                 return pkg.isEmpty() ? "<unnamed>" : pkg;
mchung@2538:             }
mchung@2538:         }
mchung@2538: 
mchung@2538:         @Override
mchung@2538:         public void visit(Location o, Location t) {
mchung@2538:             Archive targetArchive = findArchive(t);
mchung@2538:             if (filter.accepts(o, archive, t, targetArchive)) {
mchung@2538:                 addDep(o, t);
mchung@2802:                 if (archive != targetArchive && !requires.contains(targetArchive)) {
mchung@2538:                     requires.add(targetArchive);
mchung@2538:                 }
mchung@2538:             }
mchung@2538:             if (targetArchive instanceof JDKArchive) {
mchung@2538:                 Profile p = Profile.getProfile(t.getPackageName());
mchung@2538:                 if (profile == null || (p != null && p.compareTo(profile) > 0)) {
mchung@2538:                     profile = p;
aoqi@0:                 }
aoqi@0:             }
aoqi@0:         }
aoqi@0: 
mchung@2538:         private Dep curDep;
mchung@2538:         protected Dep addDep(Location o, Location t) {
mchung@2538:             String origin = getLocationName(o);
mchung@2538:             String target = getLocationName(t);
mchung@2538:             Archive targetArchive = findArchive(t);
mchung@2538:             if (curDep != null &&
mchung@2538:                     curDep.origin().equals(origin) &&
mchung@2538:                     curDep.originArchive() == archive &&
mchung@2538:                     curDep.target().equals(target) &&
mchung@2538:                     curDep.targetArchive() == targetArchive) {
mchung@2538:                 return curDep;
mchung@2538:             }
aoqi@0: 
mchung@2538:             Dep e = new Dep(origin, archive, target, targetArchive);
mchung@2538:             if (deps.contains(e)) {
mchung@2538:                 for (Dep e1 : deps) {
mchung@2538:                     if (e.equals(e1)) {
mchung@2538:                         curDep = e1;
aoqi@0:                     }
aoqi@0:                 }
mchung@2538:             } else {
mchung@2538:                 deps.add(e);
mchung@2538:                 curDep = e;
aoqi@0:             }
mchung@2538:             return curDep;
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
mchung@2538:     /*
mchung@2538:      * Class-level or package-level dependency
mchung@2538:      */
mchung@2538:     class Dep implements Comparable<Dep> {
mchung@2538:         final String origin;
mchung@2538:         final Archive originArchive;
mchung@2538:         final String target;
mchung@2538:         final Archive targetArchive;
mchung@2538: 
mchung@2538:         Dep(String origin, Archive originArchive, String target, Archive targetArchive) {
mchung@2538:             this.origin = origin;
mchung@2538:             this.originArchive = originArchive;
mchung@2538:             this.target = target;
mchung@2538:             this.targetArchive = targetArchive;
aoqi@0:         }
mchung@2538: 
mchung@2538:         String origin() {
mchung@2538:             return origin;
mchung@2538:         }
mchung@2538: 
mchung@2538:         Archive originArchive() {
mchung@2538:             return originArchive;
mchung@2538:         }
mchung@2538: 
mchung@2538:         String target() {
mchung@2538:             return target;
mchung@2538:         }
mchung@2538: 
mchung@2538:         Archive targetArchive() {
mchung@2538:             return targetArchive;
mchung@2538:         }
mchung@2538: 
aoqi@0:         @Override
mchung@2538:         @SuppressWarnings("unchecked")
mchung@2538:         public boolean equals(Object o) {
mchung@2538:             if (o instanceof Dep) {
mchung@2538:                 Dep d = (Dep) o;
mchung@2538:                 return this.origin.equals(d.origin) &&
mchung@2538:                         this.originArchive == d.originArchive &&
mchung@2538:                         this.target.equals(d.target) &&
mchung@2538:                         this.targetArchive == d.targetArchive;
aoqi@0:             }
mchung@2538:             return false;
mchung@2538:         }
aoqi@0: 
mchung@2538:         @Override
mchung@2538:         public int hashCode() {
mchung@2538:             int hash = 7;
mchung@2538:             hash = 67*hash + Objects.hashCode(this.origin)
mchung@2538:                            + Objects.hashCode(this.originArchive)
mchung@2538:                            + Objects.hashCode(this.target)
mchung@2538:                            + Objects.hashCode(this.targetArchive);
mchung@2538:             return hash;
aoqi@0:         }
mchung@2538: 
mchung@2538:         @Override
mchung@2538:         public int compareTo(Dep o) {
mchung@2538:             if (this.origin.equals(o.origin)) {
mchung@2538:                 if (this.target.equals(o.target)) {
mchung@2538:                     if (this.originArchive == o.originArchive &&
mchung@2538:                             this.targetArchive == o.targetArchive) {
mchung@2538:                         return 0;
mchung@2538:                     } else if (this.originArchive == o.originArchive) {
mchung@2538:                         return this.targetArchive.getPathName().compareTo(o.targetArchive.getPathName());
mchung@2538:                     } else {
mchung@2538:                         return this.originArchive.getPathName().compareTo(o.originArchive.getPathName());
mchung@2538:                     }
mchung@2538:                 } else {
mchung@2538:                     return this.target.compareTo(o.target);
mchung@2538:                 }
mchung@2538:             }
mchung@2538:             return this.origin.compareTo(o.origin);
aoqi@0:         }
aoqi@0:     }
aoqi@0: }