2 * Copyright (C) 2014, United States Government, as represented by the
3 * Administrator of the National Aeronautics and Space Administration.
6 * The Java Pathfinder core (jpf-core) platform is licensed under the
7 * Apache License, Version 2.0 (the "License"); you may not use this file except
8 * in compliance with the License. You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0.
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
18 package gov.nasa.jpf.vm;
20 import gov.nasa.jpf.Config;
21 import gov.nasa.jpf.annotation.MJI;
22 import gov.nasa.jpf.util.MethodInfoRegistry;
23 import gov.nasa.jpf.util.RunListener;
24 import gov.nasa.jpf.util.RunRegistry;
26 import java.lang.reflect.Modifier;
27 import java.util.ArrayList;
29 public class JPF_java_lang_reflect_Method extends NativePeer {
31 static MethodInfoRegistry registry;
33 // class init - this is called automatically from the NativePeer ctor
34 public static boolean init (Config conf) {
35 // this is an example of how to handle cross-initialization between
36 // native peers - this might also get explicitly called by the java.lang.Class
37 // peer, since it creates Method objects. Here we have to make sure
38 // we only reset between JPF runs
40 if (registry == null){
41 registry = new MethodInfoRegistry();
43 RunRegistry.getDefaultRegistry().addListener( new RunListener() {
45 public void reset (RunRegistry reg){
53 static int createMethodObject (MJIEnv env, ClassInfo ciMth, MethodInfo mi){
54 // note - it is the callers responsibility to ensure Method is properly initialized
55 int regIdx = registry.registerMethodInfo(mi);
56 int eidx = env.newObject( ciMth);
57 ElementInfo ei = env.getModifiableElementInfo(eidx);
59 ei.setIntField("regIdx", regIdx);
60 ei.setBooleanField("isAccessible", mi.isPublic());
65 // this is NOT an MJI method, but it is used outside this package, so
66 // we have to add 'final'
67 public static final MethodInfo getMethodInfo (MJIEnv env, int objRef){
68 return registry.getMethodInfo(env,objRef, "regIdx");
72 public int getName____Ljava_lang_String_2 (MJIEnv env, int objRef) {
73 MethodInfo mi = getMethodInfo(env, objRef);
75 int nameRef = env.getReferenceField( objRef, "name");
76 if (nameRef == MJIEnv.NULL) {
77 nameRef = env.newString(mi.getName());
78 env.setReferenceField(objRef, "name", nameRef);
85 public int getModifiers____I (MJIEnv env, int objRef){
86 MethodInfo mi = getMethodInfo(env, objRef);
87 return mi.getModifiers();
90 static int getParameterTypes( MJIEnv env, MethodInfo mi) {
91 ThreadInfo ti = env.getThreadInfo();
92 String[] argTypeNames = mi.getArgumentTypeNames();
93 int[] ar = new int[argTypeNames.length];
95 for (int i = 0; i < argTypeNames.length; i++) {
96 ClassInfo ci = ClassLoaderInfo.getCurrentResolvedClassInfo(argTypeNames[i]);
97 if (!ci.isRegistered()) {
101 ar[i] = ci.getClassObjectRef();
104 int aRef = env.newObjectArray("Ljava/lang/Class;", argTypeNames.length);
105 for (int i = 0; i < argTypeNames.length; i++) {
106 env.setReferenceArrayElement(aRef, i, ar[i]);
113 public int getParameterTypes_____3Ljava_lang_Class_2 (MJIEnv env, int objRef){
114 return getParameterTypes(env, getMethodInfo(env, objRef));
117 // TODO: Fix for Groovy's model-checking
119 public int getGenericParameterTypes_____3Ljava_lang_reflect_Type_2 (MJIEnv env, int objRef){
120 //return getGenericParameterTypes(env, getMethodInfo(env, objRef));
121 return getParameterTypes_____3Ljava_lang_Class_2 (env, objRef);
125 public int getGenericReturnType____Ljava_lang_reflect_Type_2 (MJIEnv env, int objRef){
126 return getReturnType____Ljava_lang_Class_2(env, objRef);
128 // TODO: Fix for Groovy's model-checking
130 int getExceptionTypes(MJIEnv env, MethodInfo mi) {
131 ThreadInfo ti = env.getThreadInfo();
132 String[] exceptionNames = mi.getThrownExceptionClassNames();
134 if (exceptionNames == null) {
135 exceptionNames = new String[0];
138 int[] ar = new int[exceptionNames.length];
140 for (int i = 0; i < exceptionNames.length; i++) {
141 ClassInfo ci = ClassLoaderInfo.getCurrentResolvedClassInfo(exceptionNames[i]);
142 if (!ci.isRegistered()) {
143 ci.registerClass(ti);
146 ar[i] = ci.getClassObjectRef();
149 int aRef = env.newObjectArray("Ljava/lang/Class;", exceptionNames.length);
150 for (int i = 0; i < exceptionNames.length; i++) {
151 env.setReferenceArrayElement(aRef, i, ar[i]);
158 public int getExceptionTypes_____3Ljava_lang_Class_2 (MJIEnv env, int objRef) {
159 return getExceptionTypes(env, getMethodInfo(env, objRef));
163 public int getDefaultValue____Ljava_lang_Object_2(MJIEnv env, int objRef) {
164 MethodInfo mi = getMethodInfo(env, objRef);
165 ClassInfo ci = mi.getClassInfo();
166 if(!ci.isInterface() || ci.getDirectInterfaceNames() == null || ci.getDirectInterfaceNames().length != 1 || !ci.getDirectInterfaceNames()[0].equals("java.lang.annotation.Annotation")) {
169 String annotationName = ci.getName();
170 AnnotationInfo ai = ci.getClassLoaderInfo().getResolvedAnnotationInfo(annotationName);
171 Object o = ai.getValue(mi.getName());
176 return env.liftNativeAnnotationValue(Types.getTypeName(mi.getReturnType()), o);
177 } catch(ClinitRequired e) {
178 env.handleClinitRequest(e.getRequiredClassInfo());
184 public int getReturnType____Ljava_lang_Class_2 (MJIEnv env, int objRef){
185 MethodInfo mi = getMethodInfo(env, objRef);
186 ThreadInfo ti = env.getThreadInfo();
188 ClassInfo ci = ClassLoaderInfo.getCurrentResolvedClassInfo(mi.getReturnTypeName());
189 if (!ci.isRegistered()) {
190 ci.registerClass(ti);
193 return ci.getClassObjectRef();
197 public int getDeclaringClass____Ljava_lang_Class_2 (MJIEnv env, int objRef){
198 MethodInfo mi = getMethodInfo(env, objRef);
199 ClassInfo ci = mi.getClassInfo();
200 // it's got to be registered, otherwise we wouldn't be able to acquire the Method object
201 return ci.getClassObjectRef();
204 static int createBoxedReturnValueObject (MJIEnv env, MethodInfo mi, DirectCallStackFrame frame) {
205 byte rt = mi.getReturnTypeCode();
206 int ret = MJIEnv.NULL;
210 if (rt == Types.T_DOUBLE) {
211 attr = frame.getLongResultAttr();
212 double v = frame.getDoubleResult();
213 ret = env.newObject(ClassLoaderInfo.getSystemResolvedClassInfo("java.lang.Double"));
214 rei = env.getModifiableElementInfo(ret);
215 rei.setDoubleField("value", v);
216 } else if (rt == Types.T_FLOAT) {
217 attr = frame.getResultAttr();
218 float v = frame.getFloatResult();
219 ret = env.newObject(ClassLoaderInfo.getSystemResolvedClassInfo("java.lang.Float"));
220 rei = env.getModifiableElementInfo(ret);
221 rei.setFloatField("value", v);
222 } else if (rt == Types.T_LONG) {
223 attr = frame.getLongResultAttr();
224 long v = frame.getLongResult();
225 ret = env.valueOfLong(v);
226 } else if (rt == Types.T_BYTE) {
227 attr = frame.getResultAttr();
228 int v = frame.getResult();
229 ret = env.valueOfByte((byte)v);
230 } else if (rt == Types.T_CHAR) {
231 attr = frame.getResultAttr();
232 int v = frame.getResult();
233 ret = env.valueOfCharacter((char)v);
234 } else if (rt == Types.T_SHORT) {
235 attr = frame.getResultAttr();
236 int v = frame.getResult();
237 ret = env.valueOfShort((short)v);
238 } else if (rt == Types.T_INT) {
239 attr = frame.getResultAttr();
240 int v = frame.getResult();
241 ret = env.valueOfInteger(v);
242 } else if (rt == Types.T_BOOLEAN) {
243 attr = frame.getResultAttr();
244 int v = frame.getResult();
245 ret = env.valueOfBoolean((v == 1)? true: false);
246 } else if (mi.isReferenceReturnType()){
247 attr = frame.getResultAttr();
248 ret = frame.getReferenceResult();
251 env.setReturnAttribute(attr);
255 static boolean pushUnboxedArguments (MJIEnv env, MethodInfo mi, DirectCallStackFrame frame, int argIdx, int argsRef) {
257 ClassInfo sourceClass;
258 String destTypeNames[];
259 int nArgs, passedCount, sourceRef;
260 byte sourceType, destTypes[];
262 destTypes = mi.getArgumentTypes();
263 destTypeNames = mi.getArgumentTypeNames();
264 nArgs = destTypeNames.length;
266 // according to the API docs, passing null instead of an empty array is allowed for no args
267 passedCount = (argsRef != MJIEnv.NULL) ? env.getArrayLength(argsRef) : 0;
269 if (nArgs != passedCount) {
270 env.throwException(IllegalArgumentException.class.getName(), "Wrong number of arguments passed. Actual = " + passedCount + ". Expected = " + nArgs);
274 for (int i = 0; i < nArgs; i++) {
275 sourceRef = env.getReferenceArrayElement(argsRef, i);
277 // we have to handle null references explicitly
278 if (sourceRef == MJIEnv.NULL) {
279 if ((destTypes[i] != Types.T_REFERENCE) && (destTypes[i] != Types.T_ARRAY)) {
280 env.throwException(IllegalArgumentException.class.getName(), "Wrong argument type at index " + i + ". Actual = (null). Expected = " + destTypeNames[i]);
284 frame.pushRef(MJIEnv.NULL);
288 source = env.getElementInfo(sourceRef);
289 sourceClass = source.getClassInfo();
290 sourceType = getSourceType( sourceClass, destTypes[i], destTypeNames[i]);
292 Object attr = env.getElementInfo(argsRef).getFields().getFieldAttr(i);
293 if ((argIdx = pushArg( argIdx, frame, source, sourceType, destTypes[i], attr)) < 0 ){
294 env.throwException(IllegalArgumentException.class.getName(), "Wrong argument type at index " + i + ". Source Class = " + sourceClass.getName() + ". Dest Class = " + destTypeNames[i]);
302 // this returns the primitive type in case we have to unbox, and otherwise checks reference type compatibility
303 private static byte getSourceType (ClassInfo ciArgVal, byte destType, String destTypeName){
306 case Types.T_BOOLEAN:
314 return Types.getUnboxedType(ciArgVal.getName());
317 case Types.T_REFERENCE: // check if the source type is assignment compatible with the destType
318 if (ciArgVal.isInstanceOf(destTypeName)){
326 // do the proper type conversion - Java is pretty forgiving here and does
327 // not throw exceptions upon value truncation
328 private static int pushArg( int argIdx, DirectCallStackFrame frame, ElementInfo eiArg, byte srcType, byte destType, Object attr){
332 double v = eiArg.getDoubleField("value");
333 if (destType == Types.T_DOUBLE){
334 return frame.setDoubleArgument( argIdx, v, attr);
338 case Types.T_FLOAT: // covers float, double
340 float v = eiArg.getFloatField("value");
343 return frame.setFloatArgument( argIdx, v, attr);
345 return frame.setDoubleArgument( argIdx, v, attr);
351 long v = eiArg.getLongField("value");
354 return frame.setLongArgument(argIdx, v, attr);
356 return frame.setFloatArgument(argIdx, v, attr);
358 return frame.setDoubleArgument( argIdx, v, attr);
364 int v = eiArg.getIntField("value");
367 return frame.setArgument( argIdx, v, attr);
369 return frame.setLongArgument( argIdx, v, attr);
371 return frame.setFloatArgument(argIdx, v, attr);
373 return frame.setDoubleArgument( argIdx, v, attr);
379 int v = eiArg.getShortField("value");
383 return frame.setArgument( argIdx, v, attr);
385 return frame.setLongArgument( argIdx, v, attr);
387 return frame.setFloatArgument(argIdx, v, attr);
389 return frame.setDoubleArgument( argIdx, v, attr);
395 byte v = eiArg.getByteField("value");
400 return frame.setArgument( argIdx, v, attr);
402 return frame.setLongArgument( argIdx, v, attr);
404 return frame.setFloatArgument(argIdx, v, attr);
406 return frame.setDoubleArgument( argIdx, v, attr);
412 char v = eiArg.getCharField("value");
416 return frame.setArgument( argIdx, v, attr);
418 return frame.setLongArgument( argIdx, v, attr);
420 return frame.setFloatArgument(argIdx, v, attr);
422 return frame.setDoubleArgument( argIdx, v, attr);
426 case Types.T_BOOLEAN:
428 boolean v = eiArg.getBooleanField("value");
429 if (destType == Types.T_BOOLEAN){
430 return frame.setArgument( argIdx, v ? 1 : 0, attr);
436 int ref = eiArg.getObjectRef();
437 if (destType == Types.T_ARRAY){
438 return frame.setReferenceArgument( argIdx, ref, attr);
442 case Types.T_REFERENCE:
444 int ref = eiArg.getObjectRef();
445 if (destType == Types.T_REFERENCE){
446 return frame.setReferenceArgument( argIdx, ref, attr);
457 public int invoke__Ljava_lang_Object_2_3Ljava_lang_Object_2__Ljava_lang_Object_2 (MJIEnv env, int mthRef, int objRef, int argsRef) {
458 ThreadInfo ti = env.getThreadInfo();
459 MethodInfo miCallee = getMethodInfo(env, mthRef);
460 ClassInfo calleeClass = miCallee.getClassInfo();
461 DirectCallStackFrame frame = ti.getReturnedDirectCall();
463 if (frame == null){ // first time
465 //--- check the instance we are calling on
466 if (!miCallee.isStatic()) {
467 if (objRef == MJIEnv.NULL){
468 env.throwException("java.lang.NullPointerException");
472 ElementInfo eiObj = ti.getElementInfo(objRef);
473 ClassInfo objClass = eiObj.getClassInfo();
475 if (!objClass.isInstanceOf(calleeClass)) {
476 env.throwException(IllegalArgumentException.class.getName(), "Object is not an instance of declaring class. Actual = " + objClass + ". Expected = " + calleeClass);
482 //--- check accessibility
483 ElementInfo eiMth = ti.getElementInfo(mthRef);
484 if (! (Boolean) eiMth.getFieldValueObject("isAccessible")) {
485 StackFrame caller = ti.getTopFrame().getPrevious();
486 ClassInfo callerClass = caller.getClassInfo();
488 if (callerClass != calleeClass) {
489 env.throwException(IllegalAccessException.class.getName(), "Class " + callerClass.getName() +
490 " can not access a member of class " + calleeClass.getName()
491 + " with modifiers \"" + Modifier.toString(miCallee.getModifiers()));
496 //--- push the direct call
497 frame = miCallee.createDirectCallStackFrame(ti, 0);
498 frame.setReflection();
501 if (!miCallee.isStatic()) {
502 frame.setReferenceArgument( argOffset++, objRef, null);
504 if (!pushUnboxedArguments( env, miCallee, frame, argOffset, argsRef)) {
505 // we've got a IllegalArgumentException
511 //--- check for and push required clinits
512 if (miCallee.isStatic()){
513 calleeClass.initializeClass(ti);
516 return MJIEnv.NULL; // reexecute
518 } else { // we have returned from the direct call
519 return createBoxedReturnValueObject( env, miCallee, frame);
524 // this one has to collect annotations upwards in the inheritance chain
525 static int getAnnotations (MJIEnv env, MethodInfo mi){
526 String mname = mi.getName();
527 String msig = mi.genericSignature;
528 ArrayList<AnnotationInfo> aiList = new ArrayList<AnnotationInfo>();
530 // our own annotations
531 ClassInfo ci = mi.getClassInfo();
532 for (AnnotationInfo ai : mi.getAnnotations()) {
536 // our superclass annotations
537 for (ci = ci.getSuperClass(); ci != null; ci = ci.getSuperClass()){
538 mi = ci.getMethod(mname, msig, false);
540 for (AnnotationInfo ai: mi.getAnnotations()){
547 return env.newAnnotationProxies(aiList.toArray(new AnnotationInfo[aiList.size()]));
548 } catch (ClinitRequired x){
549 env.handleClinitRequest(x.getRequiredClassInfo());
555 public int getAnnotations_____3Ljava_lang_annotation_Annotation_2 (MJIEnv env, int mthRef){
556 return getAnnotations( env, getMethodInfo(env,mthRef));
559 // the following ones consist of a package default implementation that is shared with
560 // the constructor peer, and a public model method
561 static int getAnnotation (MJIEnv env, MethodInfo mi, int annotationClsRef){
562 ClassInfo aci = env.getReferredClassInfo(annotationClsRef);
564 AnnotationInfo ai = mi.getAnnotation(aci.getName());
566 ClassInfo aciProxy = aci.getAnnotationProxy();
568 return env.newAnnotationProxy(aciProxy, ai);
569 } catch (ClinitRequired x){
570 env.handleClinitRequest(x.getRequiredClassInfo());
579 public int getAnnotation__Ljava_lang_Class_2__Ljava_lang_annotation_Annotation_2 (MJIEnv env, int mthRef, int annotationClsRef) {
580 return getAnnotation(env, getMethodInfo(env,mthRef), annotationClsRef);
583 static int getDeclaredAnnotations (MJIEnv env, MethodInfo mi){
584 AnnotationInfo[] ai = mi.getAnnotations();
587 return env.newAnnotationProxies(ai);
588 } catch (ClinitRequired x){
589 env.handleClinitRequest(x.getRequiredClassInfo());
595 public int getDeclaredAnnotations_____3Ljava_lang_annotation_Annotation_2 (MJIEnv env, int mthRef){
596 return getDeclaredAnnotations( env, getMethodInfo(env,mthRef));
599 static int getParameterAnnotations (MJIEnv env, MethodInfo mi){
600 AnnotationInfo[][] pa = mi.getParameterAnnotations();
601 // this should always return an array object, even if the method has no arguments
604 int paRef = env.newObjectArray("[Ljava/lang/annotation/Annotation;", pa.length);
606 for (int i=0; i<pa.length; i++){
607 int eRef = env.newAnnotationProxies(pa[i]);
608 env.setReferenceArrayElement(paRef, i, eRef);
613 } catch (ClinitRequired x){ // be prepared that we might have to initialize respective annotation classes
614 env.handleClinitRequest(x.getRequiredClassInfo());
620 public int getParameterAnnotations_____3_3Ljava_lang_annotation_Annotation_2 (MJIEnv env, int mthRef){
621 return getParameterAnnotations( env, getMethodInfo(env,mthRef));
625 public int toString____Ljava_lang_String_2 (MJIEnv env, int objRef){
626 StringBuilder sb = new StringBuilder();
628 MethodInfo mi = getMethodInfo(env, objRef);
630 sb.append(Modifier.toString(mi.getModifiers()));
633 sb.append(mi.getReturnTypeName());
636 sb.append(mi.getClassName());
639 sb.append(mi.getName());
643 String[] at = mi.getArgumentTypeNames();
644 for (int i=0; i<at.length; i++){
645 if (i>0) sb.append(',');
651 int sref = env.newString(sb.toString());
656 public boolean equals__Ljava_lang_Object_2__Z (MJIEnv env, int objRef, int mthRef){
657 ElementInfo ei = env.getElementInfo(mthRef);
658 ClassInfo ci = ClassLoaderInfo.getSystemResolvedClassInfo(JPF_java_lang_Class.METHOD_CLASSNAME);
660 if (ei.getClassInfo() == ci){
661 MethodInfo mi1 = getMethodInfo(env, objRef);
662 MethodInfo mi2 = getMethodInfo(env, mthRef);
663 if (mi1.getClassInfo() == mi2.getClassInfo()){
664 if (mi1.getName().equals(mi2.getName())){
665 if (mi1.getReturnType().equals(mi2.getReturnType())){
666 byte[] params1 = mi1.getArgumentTypes();
667 byte[] params2 = mi2.getArgumentTypes();
668 if (params1.length == params2.length){
669 for (int i = 0; i < params1.length; i++){
670 if (params1[i] != params2[i]){
684 public int hashCode____I (MJIEnv env, int objRef){
685 MethodInfo mi = getMethodInfo(env, objRef);
686 return mi.getClassName().hashCode() ^ mi.getName().hashCode();