src/jdk.jfr/share/classes/jdk/jfr/internal/instrument/JIClassInstrumentation.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.io.ByteArrayOutputStream;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    29
import java.io.IOException;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    30
import java.io.InputStream;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    31
import java.lang.reflect.Method;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    32
import java.util.ArrayList;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    33
import java.util.List;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    34
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    35
import jdk.internal.org.objectweb.asm.ClassReader;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    36
import jdk.internal.org.objectweb.asm.ClassVisitor;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    37
import jdk.internal.org.objectweb.asm.ClassWriter;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    38
import jdk.internal.org.objectweb.asm.Opcodes;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    39
import jdk.internal.org.objectweb.asm.tree.ClassNode;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    40
import jdk.jfr.internal.SecuritySupport;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    41
import jdk.jfr.internal.Utils;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    42
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    43
/**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    44
 * This class will perform byte code instrumentation given an "instrumentor" class.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    45
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    46
 * @see JITracer
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    47
 *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    48
 * @author Staffan Larsen
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    49
 */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    50
@Deprecated
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    51
final class JIClassInstrumentation {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    52
    private final Class<?> instrumentor;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    53
    private final String targetName;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    54
    private final String instrumentorName;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    55
    private final byte[] newBytes;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    56
    private final ClassReader targetClassReader;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    57
    private final ClassReader instrClassReader;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    58
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    59
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    60
     * Creates an instance and performs the instrumentation.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    61
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    62
     * @param instrumentor instrumentor class
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    63
     * @param target target class
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    64
     * @param old_target_bytes bytes in target
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    65
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    66
     * @throws ClassNotFoundException
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    67
     * @throws IOException
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    68
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    69
    JIClassInstrumentation(Class<?> instrumentor, Class<?> target, byte[] old_target_bytes) throws ClassNotFoundException, IOException {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    70
        instrumentorName = instrumentor.getName();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    71
        this.targetName = target.getName();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    72
        this.instrumentor = instrumentor;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    73
        this.targetClassReader = new ClassReader(old_target_bytes);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    74
        this.instrClassReader = new ClassReader(getOriginalClassBytes(instrumentor));
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    75
        this.newBytes = makeBytecode();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    76
        Utils.writeGeneratedASM(target.getName(), newBytes);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    77
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    78
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    79
    private static byte[] getOriginalClassBytes(Class<?> clazz) throws IOException {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    80
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    81
        String name = "/" + clazz.getName().replace(".", "/") + ".class";
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    82
        InputStream is = SecuritySupport.getResourceAsStream(name);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    83
        int bytesRead;
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    84
        byte[] buffer = new byte[16384];
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    85
        while ((bytesRead = is.read(buffer, 0, buffer.length)) != -1) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    86
            baos.write(buffer, 0, bytesRead);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    87
        }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    88
        baos.flush();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    89
        is.close();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    90
        return baos.toByteArray();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    91
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    92
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    93
    private byte[] makeBytecode() throws IOException, ClassNotFoundException {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    94
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    95
        // Find the methods to instrument and inline
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    96
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    97
        final List<Method> instrumentationMethods = new ArrayList<>();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    98
        for (final Method m : instrumentor.getDeclaredMethods()) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
    99
            JIInstrumentationMethod im = m.getAnnotation(JIInstrumentationMethod.class);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   100
            if (im != null) {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   101
                instrumentationMethods.add(m);
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
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   105
        // We begin by inlining the target's methods into the instrumentor
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   106
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   107
        ClassNode temporary = new ClassNode();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   108
        ClassVisitor inliner = new JIInliner(
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   109
                Opcodes.ASM5,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   110
                temporary,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   111
                targetName,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   112
                instrumentorName,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   113
                targetClassReader,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   114
                instrumentationMethods);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   115
        instrClassReader.accept(inliner, ClassReader.EXPAND_FRAMES);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   116
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   117
        // Now we have the target's methods inlined into the instrumentation code (in 'temporary').
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   118
        // We now need to replace the target's method with the code in the
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   119
        // instrumentation method.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   120
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   121
        ClassWriter cw = new ClassWriter(ClassWriter.COMPUTE_FRAMES);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   122
        JIMethodMergeAdapter ma = new JIMethodMergeAdapter(
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   123
                cw,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   124
                temporary,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   125
                instrumentationMethods,
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   126
                instrumentor.getAnnotationsByType(JITypeMapping.class));
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   127
        targetClassReader.accept(ma, ClassReader.EXPAND_FRAMES);
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   128
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   129
       return cw.toByteArray();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   130
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   131
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   132
    /**
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   133
     * Get the instrumented byte codes that can be used to retransform the class.
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   134
     *
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   135
     * @return bytes
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   136
     */
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   137
    public byte[] getNewBytes() {
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   138
        return newBytes.clone();
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   139
    }
caf115bb98ad 8199712: Flight Recorder
egahlin
parents:
diff changeset
   140
}