How can I find all the methods that call a given method in Java?

Question

I need to get a list of all caller methods for a method of interest for me in Java. Is there a tool that can help me with this?

Edit: I forgot to mention that I need to do this from a program. I'm usig Java Pathfinder and I want to run it an all the methods that call my method of interest.

Answer 1

For analyzing bytecode, I would recommend ASM. Given a list of Classes to analyze, a visitor can be made which finds the method calls you're interested in. One implementation which analyses classes in a jar file is below.

Note that ASM uses internalNames with '/' instead of '.' as a separator. Specify the target method as a standard declaration without modifiers.

For example, to list methods that could be calling System.out.println("foo") in the java runtime jar:

java -cp "classes;asm-3.1.jar;asm-commons-3.1.jar" App \     c:/java/jdk/jre/lib/rt.jar \     java/io/PrintStream  "void println(String)" 

Edit: source and line numbers added: Note that this only indicates the last target method invocation per calling method - the original q only wanted to know which methods. I leave it as an exercise for the reader to show line numbers of the calling method declaration, or the line numbers of every target invocation, depending on what you're actually after. :)

results in:

LogSupport.java:44 com/sun/activation/registries/LogSupport log (Ljava/lang/String;)V LogSupport.java:50 com/sun/activation/registries/LogSupport log (Ljava/lang/String;Ljava/lang/Throwable;)V ... Throwable.java:498 java/lang/Throwable printStackTraceAsCause (Ljava/io/PrintStream;[Ljava/lang/StackTraceElement;)V -- 885 methods invoke java/io/PrintStream println (Ljava/lang/String;)V 

source:

public class App {     private String targetClass;     private Method targetMethod;      private AppClassVisitor cv;      private ArrayList<Callee> callees = new ArrayList<Callee>();      private static class Callee {         String className;         String methodName;         String methodDesc;         String source;         int line;          public Callee(String cName, String mName, String mDesc, String src, int ln) {             className = cName; methodName = mName; methodDesc = mDesc; source = src; line = ln;         }     }      private class AppMethodVisitor extends MethodAdapter {          boolean callsTarget;         int line;          public AppMethodVisitor() { super(new EmptyVisitor()); }          public void visitMethodInsn(int opcode, String owner, String name, String desc) {             if (owner.equals(targetClass)                     && name.equals(targetMethod.getName())                     && desc.equals(targetMethod.getDescriptor())) {                 callsTarget = true;             }         }          public void visitCode() {             callsTarget = false;         }          public void visitLineNumber(int line, Label start) {             this.line = line;         }          public void visitEnd() {             if (callsTarget)                 callees.add(new Callee(cv.className, cv.methodName, cv.methodDesc,                          cv.source, line));         }     }      private class AppClassVisitor extends ClassAdapter {          private AppMethodVisitor mv = new AppMethodVisitor();          public String source;         public String className;         public String methodName;         public String methodDesc;          public AppClassVisitor() { super(new EmptyVisitor()); }          public void visit(int version, int access, String name,                           String signature, String superName, String[] interfaces) {             className = name;         }          public void visitSource(String source, String debug) {             this.source = source;         }          public MethodVisitor visitMethod(int access, String name,                                           String desc, String signature,                                          String[] exceptions) {             methodName = name;             methodDesc = desc;              return mv;         }     }       public void findCallingMethodsInJar(String jarPath, String targetClass,                                         String targetMethodDeclaration) throws Exception {          this.targetClass = targetClass;         this.targetMethod = Method.getMethod(targetMethodDeclaration);          this.cv = new AppClassVisitor();          JarFile jarFile = new JarFile(jarPath);         Enumeration<JarEntry> entries = jarFile.entries();          while (entries.hasMoreElements()) {             JarEntry entry = entries.nextElement();              if (entry.getName().endsWith(".class")) {                 InputStream stream = new BufferedInputStream(jarFile.getInputStream(entry), 1024);                 ClassReader reader = new ClassReader(stream);                  reader.accept(cv, 0);                  stream.close();             }         }     }       public static void main( String[] args ) {         try {             App app = new App();              app.findCallingMethodsInJar(args[0], args[1], args[2]);              for (Callee c : app.callees) {                 System.out.println(c.source+":"+c.line+" "+c.className+" "+c.methodName+" "+c.methodDesc);             }              System.out.println("--\n"+app.callees.size()+" methods invoke "+                     app.targetClass+" "+                     app.targetMethod.getName()+" "+app.targetMethod.getDescriptor());         } catch(Exception x) {             x.printStackTrace();         }     }  }