1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
/*******************************************************************************
* Copyright (c) 2009, 2012 Mountainminds GmbH & Co. KG and Contributors
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Marc R. Hoffmann - initial API and implementation
*
*******************************************************************************/
package org.jacoco.core.runtime;
import static java.lang.String.format;
import java.lang.instrument.ClassFileTransformer;
import java.lang.instrument.IllegalClassFormatException;
import java.lang.instrument.Instrumentation;
import java.lang.reflect.Field;
import java.security.ProtectionDomain;
import org.objectweb.asm.ClassAdapter;
import org.objectweb.asm.ClassReader;
import org.objectweb.asm.ClassVisitor;
import org.objectweb.asm.ClassWriter;
import org.objectweb.asm.MethodVisitor;
import org.objectweb.asm.Opcodes;
/**
* This {@link IRuntime} implementation works with a modified system class. A
* new static method is added to a bootstrap class that will be used by
* instrumented classes. As the system class itself needs to be instrumented
* this runtime requires a Java agent.
*/
public class ModifiedSystemClassRuntime extends AbstractRuntime {
private static final String ACCESS_FIELD_TYPE = "Ljava/lang/Object;";
private final Class<?> systemClass;
private final String systemClassName;
private final String accessFieldName;
/**
* Creates a new runtime based on the given class and members.
*
* @param systemClass
* system class that contains the execution data
* @param accessFieldName
* name of the public static runtime access field
*
*/
public ModifiedSystemClassRuntime(final Class<?> systemClass,
final String accessFieldName) {
super();
this.systemClass = systemClass;
this.systemClassName = systemClass.getName().replace('.', '/');
this.accessFieldName = accessFieldName;
}
public void startup() throws Exception {
setStartTimeStamp();
final Field field = systemClass.getField(accessFieldName);
field.set(null, new ExecutionDataAccess(store));
}
public void shutdown() {
// nothing to do
}
public int generateDataAccessor(final long classid, final String classname,
final int probecount, final MethodVisitor mv) {
mv.visitFieldInsn(Opcodes.GETSTATIC, systemClassName, accessFieldName,
ACCESS_FIELD_TYPE);
ExecutionDataAccess.generateAccessCall(classid, classname, probecount,
mv);
return 6;
}
/**
* Creates a new {@link ModifiedSystemClassRuntime} using the given class as
* the data container. Members are creates with internal default names. The
* given class must not have been loaded before by the agent.
*
* @param inst
* instrumentation interface
* @param className
* VM name of the class to use
* @return new runtime instance
*
* @throws ClassNotFoundException
* id the given class can not be found
*/
public static IRuntime createFor(final Instrumentation inst,
final String className) throws ClassNotFoundException {
return createFor(inst, className, "$jacocoAccess");
}
/**
* Creates a new {@link ModifiedSystemClassRuntime} using the given class as
* the data container. The given class must not have been loaded before by
* the agent.
*
* @param inst
* instrumentation interface
* @param className
* VM name of the class to use
* @param accessFieldName
* name of the added runtime access field
* @return new runtime instance
*
* @throws ClassNotFoundException
* id the given class can not be found
*/
public static IRuntime createFor(final Instrumentation inst,
final String className, final String accessFieldName)
throws ClassNotFoundException {
final ClassFileTransformer transformer = new ClassFileTransformer() {
public byte[] transform(final ClassLoader loader,
final String name, final Class<?> classBeingRedefined,
final ProtectionDomain protectionDomain, final byte[] source)
throws IllegalClassFormatException {
if (name.equals(className)) {
return instrument(source, accessFieldName);
}
return null;
}
};
inst.addTransformer(transformer);
final Class<?> clazz = Class.forName(className.replace('/', '.'));
inst.removeTransformer(transformer);
try {
clazz.getField(accessFieldName);
} catch (final NoSuchFieldException e) {
throw new RuntimeException(format(
"Class %s could not be instrumented.", className), e);
}
return new ModifiedSystemClassRuntime(clazz, accessFieldName);
}
/**
* Adds the static access method and data field to the given class
* definition.
*
* @param source
* class definition source
* @param accessFieldName
* name of the runtime access field
* @return instrumented version with added members
*/
public static byte[] instrument(final byte[] source,
final String accessFieldName) {
final ClassReader reader = new ClassReader(source);
final ClassWriter writer = new ClassWriter(reader, 0);
reader.accept(new ClassAdapter(writer) {
@Override
public void visitEnd() {
createDataField(cv, accessFieldName);
super.visitEnd();
}
}, ClassReader.EXPAND_FRAMES);
return writer.toByteArray();
}
private static void createDataField(final ClassVisitor visitor,
final String dataField) {
visitor.visitField(Opcodes.ACC_PUBLIC | Opcodes.ACC_STATIC
| Opcodes.ACC_SYNTHETIC | Opcodes.ACC_TRANSIENT, dataField,
ACCESS_FIELD_TYPE, null, null);
}
}
|
