Repository navigation
Expand file tree
/
Copy pathMethodFactory.java
More file actions
281 lines (262 loc) · 12.9 KB
/
Copy pathMethodFactory.java
File metadata and controls
281 lines (262 loc) · 12.9 KB
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
/***** BEGIN LICENSE BLOCK *****
* Version: EPL 1.0/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Eclipse Public
* License Version 1.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.eclipse.org/legal/epl-v10.html
*
* Software distributed under the License is distributed on an "AS
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
* implied. See the License for the specific language governing
* rights and limitations under the License.
*
* Copyright (C) 2008 The JRuby Community <www.jruby.org>
* Copyright (C) 2006 Ola Bini <ola@ologix.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the EPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the EPL, the GPL or the LGPL.
***** END LICENSE BLOCK *****/
package org.jruby.runtime;
import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.util.List;
import org.jruby.Ruby;
import org.jruby.RubyInstanceConfig;
import org.jruby.RubyModule;
import org.jruby.anno.JavaMethodDescriptor;
import org.jruby.internal.runtime.methods.CallConfiguration;
import org.jruby.internal.runtime.methods.DynamicMethod;
import org.jruby.internal.runtime.methods.ReflectionMethodFactory;
import org.jruby.internal.runtime.methods.InvocationMethodFactory;
import org.jruby.internal.runtime.methods.InvokeDynamicMethodFactory;
import org.jruby.lexer.yacc.ISourcePosition;
import org.jruby.parser.StaticScope;
import org.jruby.runtime.builtin.IRubyObject;
import org.jruby.util.ClassCache.OneShotClassLoader;
import org.jruby.util.cli.Options;
import org.jruby.util.log.Logger;
import org.jruby.util.log.LoggerFactory;
/**
* MethodFactory is used to generate "invokers" or "method handles" given a target
* class, method name, and other characteristics. In order to bind methods into
* Ruby's reified class hierarchy, we need a way to treat individual methods as
* objects. Implementers of this class provide that functionality.
*/
public abstract class MethodFactory {
private static final Logger LOG = LoggerFactory.getLogger("MethodFactory");
/**
* A Class[] representing the signature of compiled Ruby method.
*/
public final static Class[] COMPILED_METHOD_PARAMS = new Class[] {ThreadContext.class, IRubyObject.class, IRubyObject[].class, Block.class};
/**
* A test to see if we can load bytecode dynamically, so we know whether InvocationMethodFactory will work.
*/
public final static boolean CAN_LOAD_BYTECODE;
static {
// any exception or error will cause us to consider bytecode-loading impossible
boolean can = false;
try {
InputStream unloaderStream = Ruby.getClassLoader().getResourceAsStream("org/jruby/util/JDBCDriverUnloader.class");
ByteArrayOutputStream baos = new ByteArrayOutputStream();
byte[] buf = new byte[4096];
int bytesRead;
while ((bytesRead = unloaderStream.read(buf)) != -1) {
baos.write(buf, 0, bytesRead);
}
OneShotClassLoader oscl = new OneShotClassLoader(Ruby.getClassLoader());
Class unloaderClass = oscl.defineClass("org.jruby.util.JDBCDriverUnloader", baos.toByteArray());
unloaderClass.newInstance();
can = true;
} catch (Throwable t) {
LOG.debug("MethodFactory: failed to load bytecode at runtime, falling back on reflection", t);
}
CAN_LOAD_BYTECODE = can;
}
/**
* For batched method construction, the logic necessary to bind resulting
* method objects into a target module/class must be provided as a callback.
* This interface should be implemented by code calling any batched methods
* on this MethodFactory.
*/
@Deprecated
public interface MethodDefiningCallback {
public void define(RubyModule targetMetaClass, JavaMethodDescriptor desc, DynamicMethod dynamicMethod);
}
/**
* Based on optional properties, create a new MethodFactory. By default,
* this will create a code-generation-based InvocationMethodFactory. If
* security restricts code generation, ReflectionMethodFactory will be used.
* If we are dumping class definitions, DumpingInvocationMethodFactory will
* be used. See MethodFactory's static initializer for more details.
*
* @param classLoader The classloader to use for searching for and
* dynamically loading code.
* @return A new MethodFactory.
*/
public static MethodFactory createFactory(ClassLoader classLoader) {
// if reflection is forced or we've determined that we can't load bytecode, use reflection
if (reflection || !CAN_LOAD_BYTECODE) return new ReflectionMethodFactory();
// otherwise, generate invokers at runtime
if (Options.COMPILE_INVOKEDYNAMIC.load() && Options.INVOKEDYNAMIC_HANDLES.load()) {
return new InvokeDynamicMethodFactory(classLoader);
} else {
return new InvocationMethodFactory(classLoader);
}
}
/**
* Get a new method handle based on the target JRuby-compiled method.
* Because compiled Ruby methods have additional requirements and
* characteristics not typically found in Java-based methods, this is
* provided as a separate way to define such method handles.
*
* @param implementationClass The class to which the method will be bound.
* @param rubyName The Ruby method name to which the method will bind
* @param javaName The name of the method
* @param arity The Arity of the method
* @param visibility The method's visibility on the target type.
* @param scope The methods static scoping information.
* @param scriptObject An instace of the target compiled method class.
* @param callConfig The call configuration to use for this method.
* @param position The position to use when generating traceable handles.
* @return A new method handle for the target compiled method.
*/
public abstract DynamicMethod getCompiledMethod(
RubyModule implementationClass, String rubyName, String javaName,
Arity arity, Visibility visibility, StaticScope scope,
Object scriptObject, CallConfiguration callConfig,
ISourcePosition position, String parameterDesc);
/**
* Like getCompiledMethod, but produces the actual bytes for the compiled
* method handle rather than loading and constructing it. This can be used
* to generate all the handles ahead of time, as when doing a full system
* precompile.
*
* @param rubyName The Ruby method name to which the method will bind
* @param javaName The name of the method
* @param classPath The path-like (with / instead of .) name of the class
* @param invokerPath The path-line name of the invoker to generate
* @param arity The Arity of the method
* @param scope The methods static scoping information.
* @param callConfig The call configuration to use for this method.
* @param position The position to use when generating traceable handles.
* @return
*/
public byte[] getCompiledMethodOffline(
String rubyName, String javaName, String classPath, String invokerPath,
Arity arity, StaticScope scope,
CallConfiguration callConfig, String filename, int line) {
return null;
}
/**
* Like getCompiledMethod, but postpones any heavy lifting involved in
* creating the method until first invocation. This helps reduce the cost
* of starting up AOT-compiled code, by spreading out the heavy lifting
* across the run rather than causing all method handles to be immediately
* instantiated.
*
* @param implementationClass The class to which the method will be bound.
* @param rubyName The Ruby method name to which the method will bind
* @param javaName The name of the method
* @param arity The Arity of the method
* @param visibility The method's visibility on the target type.
* @param scope The methods static scoping information.
* @param scriptObject An instace of the target compiled method class.
* @param callConfig The call configuration to use for this method.
* @return A new method handle for the target compiled method.
*/
public abstract DynamicMethod getCompiledMethodLazily(
RubyModule implementationClass, String rubyName, String javaName,
Arity arity, Visibility visibility, StaticScope scope,
Object scriptObject, CallConfiguration callConfig,
ISourcePosition position, String parameterDesc);
/**
* Based on a list of annotated Java methods, generate a method handle using
* the annotation and the target signatures. The annotation and signatures
* will be used to dynamically generate the appropriate call logic for the
* handle. This differs from the single-method version in that it will dispatch
* multiple specific-arity paths to different target methods.
*
* @param implementationClass The target class or module on which the method
* will be bound.
* @param descs A list of JavaMethodDescriptors describing the target methods
* @return A method handle for the target object.
*/
public abstract DynamicMethod getAnnotatedMethod(RubyModule implementationClass, List<JavaMethodDescriptor> desc);
/**
* Based on an annotated Java method object, generate a method handle using
* the annotation and the target signature. The annotation and signature
* will be used to dynamically generate the appropriate call logic for the
* handle.
*
* @param implementationClass The target class or module on which the method
* will be bound.
* @param desc A JavaMethodDescriptor describing the target method
* @return A method handle for the target object.
*/
public abstract DynamicMethod getAnnotatedMethod(RubyModule implementationClass, JavaMethodDescriptor desc);
/**
* Get a CompiledBlockCallback for the specified block
*
* @param method The name of the method
* @param scriptObject The object in which the method can be found
* @return A new CompiledBlockCallback for the method
*/
public abstract CompiledBlockCallback getBlockCallback(String method, String file, int line, Object scriptObject);
/**
* Get a CompiledBlockCallback for the specified block
*
* @param method The name of the method
* @param scriptObject The object in which the method can be found
* @return A new CompiledBlockCallback for the method
*/
public abstract CompiledBlockCallback19 getBlockCallback19(String method, String file, int line, Object scriptObject);
/**
* Get a CompiledBlockCallback for the specified block, returning the bytes
* but not loading the class. This is used for offline generation of the
* callback class file.
*
* @param method The name of the method
* @param classPath The /-based name of the class containing the method
* @return The bytes of the class
*/
public byte[] getBlockCallbackOffline(String method, String file, int line, String classPath) {
return null;
}
/**
* Get a CompiledBlockCallback for the specified block, returning the bytes
* but not loading the class. This is used for offline generation of the
* callback class file. This version generates a 1.9-compatible callback.
*
* @param method The name of the method
* @param classPath The /-based name of the class containing the method
* @return The bytes of the class
*/
public byte[] getBlockCallback19Offline(String method, String file, int line, String classPath) {
return null;
}
/**
* Use the reflection-based factory.
*/
private static final boolean reflection;
static {
boolean reflection_ = false, dumping_ = false;
String dumpingPath_ = null;
// initialize the static settings to determine which factory to use
if (Ruby.isSecurityRestricted()) {
reflection_ = true;
} else {
reflection_ = RubyInstanceConfig.REFLECTED_HANDLES;
}
reflection = reflection_;
}
}