src/jdk.jfr/share/classes/jdk/jfr/internal/instrument/JIInliner.java
author egahlin
Tue, 15 May 2018 20:24:34 +0200
changeset 50113 caf115bb98ad
child 52515 746df0ae4fe1
permissions -rw-r--r--
8199712: Flight Recorder Reviewed-by: coleenp, ihse, erikj, dsamersoff, mseledtsov, egahlin, mgronlun Contributed-by: erik.gahlin@oracle.com, markus.gronlund@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
50113
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     1
/*
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     2
 * Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights reserved.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     4
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    10
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    15
 * accompanied this code).
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    16
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    20
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    23
 * questions.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    24
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    25
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    26
package jdk.jfr.internal.instrument;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    27
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    28
import java.lang.reflect.Method;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    29
import java.lang.reflect.Modifier;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    30
import java.util.List;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    31
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    32
import jdk.internal.org.objectweb.asm.ClassReader;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    33
import jdk.internal.org.objectweb.asm.ClassVisitor;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    34
import jdk.internal.org.objectweb.asm.MethodVisitor;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    35
import jdk.internal.org.objectweb.asm.Opcodes;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    36
import jdk.internal.org.objectweb.asm.Type;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    37
import jdk.internal.org.objectweb.asm.tree.ClassNode;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    38
import jdk.internal.org.objectweb.asm.tree.MethodNode;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    39
import jdk.jfr.internal.LogLevel;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    40
import jdk.jfr.internal.LogTag;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    41
import jdk.jfr.internal.Logger;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    42
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    43
@Deprecated
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    44
final class JIInliner extends ClassVisitor {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    45
    private final String targetClassName;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    46
    private final String instrumentationClassName;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    47
    private final ClassNode targetClassNode;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    48
    private final List<Method> instrumentationMethods;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    49
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    50
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    51
     * A ClassVisitor which will check all methods of the class it visits against the instrumentationMethods
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    52
     * list. If a method is on that list, the method will be further processed for inlining into that
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    53
     * method.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    54
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    55
    JIInliner(int api, ClassVisitor cv, String targetClassName, String instrumentationClassName,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    56
            ClassReader targetClassReader,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    57
            List<Method> instrumentationMethods) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    58
        super(api, cv);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    59
        this.targetClassName = targetClassName;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    60
        this.instrumentationClassName = instrumentationClassName;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    61
        this.instrumentationMethods = instrumentationMethods;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    62
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    63
        ClassNode cn = new ClassNode(Opcodes.ASM5);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    64
        targetClassReader.accept(cn, ClassReader.EXPAND_FRAMES);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    65
        this.targetClassNode = cn;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    66
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    67
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    68
    @Override
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    69
    public MethodVisitor visitMethod(int access, String name, String desc, String signature, String[] exceptions) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    70
        MethodVisitor mv = super.visitMethod(access, name, desc, signature, exceptions);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    71
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    72
        if (isInstrumentationMethod(name, desc)) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    73
            MethodNode methodToInline = findTargetMethodNode(name, desc);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    74
            if (methodToInline == null) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    75
                throw new IllegalArgumentException("Could not find the method to instrument in the target class");
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    76
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    77
            if (Modifier.isNative(methodToInline.access)) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    78
                throw new IllegalArgumentException("Cannot instrument native methods: " + targetClassNode.name + "." + methodToInline.name + methodToInline.desc);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    79
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    80
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    81
            Logger.log(LogTag.JFR_SYSTEM_BYTECODE, LogLevel.DEBUG, "Inliner processing method " + name + desc);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    82
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    83
            JIMethodCallInliner mci = new JIMethodCallInliner(access,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    84
                    desc,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    85
                    mv,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    86
                    methodToInline,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    87
                    targetClassName,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    88
                    instrumentationClassName);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    89
            return mci;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    90
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    91
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    92
        return mv;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    93
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    94
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    95
    private boolean isInstrumentationMethod(String name, String desc) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    96
        for(Method m : instrumentationMethods) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    97
            if (m.getName().equals(name) && Type.getMethodDescriptor(m).equals(desc)) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    98
                return true;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    99
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   100
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   101
        return false;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   102
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   103
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   104
    private MethodNode findTargetMethodNode(String name, String desc) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   105
        for (MethodNode mn : targetClassNode.methods) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   106
            if (mn.desc.equals(desc) && mn.name.equals(name)) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   107
                return mn;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   108
            }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   109
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   110
        throw new IllegalArgumentException("could not find MethodNode for "
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   111
                + name + desc);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   112
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   113
}