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 int getExceptionTypes(MJIEnv env, MethodInfo mi) {
118 ThreadInfo ti = env.getThreadInfo();
119 String[] exceptionNames = mi.getThrownExceptionClassNames();
121 if (exceptionNames == null) {
122 exceptionNames = new String[0];
125 int[] ar = new int[exceptionNames.length];
127 for (int i = 0; i < exceptionNames.length; i++) {
128 ClassInfo ci = ClassLoaderInfo.getCurrentResolvedClassInfo(exceptionNames[i]);
129 if (!ci.isRegistered()) {
130 ci.registerClass(ti);
133 ar[i] = ci.getClassObjectRef();
136 int aRef = env.newObjectArray("Ljava/lang/Class;", exceptionNames.length);
137 for (int i = 0; i < exceptionNames.length; i++) {
138 env.setReferenceArrayElement(aRef, i, ar[i]);
145 public int getExceptionTypes_____3Ljava_lang_Class_2 (MJIEnv env, int objRef) {
146 return getExceptionTypes(env, getMethodInfo(env, objRef));
150 public int getDefaultValue____Ljava_lang_Object_2(MJIEnv env, int objRef) {
151 MethodInfo mi = getMethodInfo(env, objRef);
152 ClassInfo ci = mi.getClassInfo();
153 if(!ci.isInterface() || ci.getDirectInterfaceNames() == null || ci.getDirectInterfaceNames().length != 1 || !ci.getDirectInterfaceNames()[0].equals("java.lang.annotation.Annotation")) {
156 String annotationName = ci.getName();
157 AnnotationInfo ai = ci.getClassLoaderInfo().getResolvedAnnotationInfo(annotationName);
158 Object o = ai.getValue(mi.getName());
163 return env.liftNativeAnnotationValue(Types.getTypeName(mi.getReturnType()), o);
164 } catch(ClinitRequired e) {
165 env.handleClinitRequest(e.getRequiredClassInfo());
171 public int getReturnType____Ljava_lang_Class_2 (MJIEnv env, int objRef){
172 MethodInfo mi = getMethodInfo(env, objRef);
173 ThreadInfo ti = env.getThreadInfo();
175 ClassInfo ci = ClassLoaderInfo.getCurrentResolvedClassInfo(mi.getReturnTypeName());
176 if (!ci.isRegistered()) {
177 ci.registerClass(ti);
180 return ci.getClassObjectRef();
184 public int getDeclaringClass____Ljava_lang_Class_2 (MJIEnv env, int objRef){
185 MethodInfo mi = getMethodInfo(env, objRef);
186 ClassInfo ci = mi.getClassInfo();
187 // it's got to be registered, otherwise we wouldn't be able to acquire the Method object
188 return ci.getClassObjectRef();
191 static int createBoxedReturnValueObject (MJIEnv env, MethodInfo mi, DirectCallStackFrame frame) {
192 byte rt = mi.getReturnTypeCode();
193 int ret = MJIEnv.NULL;
197 if (rt == Types.T_DOUBLE) {
198 attr = frame.getLongResultAttr();
199 double v = frame.getDoubleResult();
200 ret = env.newObject(ClassLoaderInfo.getSystemResolvedClassInfo("java.lang.Double"));
201 rei = env.getModifiableElementInfo(ret);
202 rei.setDoubleField("value", v);
203 } else if (rt == Types.T_FLOAT) {
204 attr = frame.getResultAttr();
205 float v = frame.getFloatResult();
206 ret = env.newObject(ClassLoaderInfo.getSystemResolvedClassInfo("java.lang.Float"));
207 rei = env.getModifiableElementInfo(ret);
208 rei.setFloatField("value", v);
209 } else if (rt == Types.T_LONG) {
210 attr = frame.getLongResultAttr();
211 long v = frame.getLongResult();
212 ret = env.valueOfLong(v);
213 } else if (rt == Types.T_BYTE) {
214 attr = frame.getResultAttr();
215 int v = frame.getResult();
216 ret = env.valueOfByte((byte)v);
217 } else if (rt == Types.T_CHAR) {
218 attr = frame.getResultAttr();
219 int v = frame.getResult();
220 ret = env.valueOfCharacter((char)v);
221 } else if (rt == Types.T_SHORT) {
222 attr = frame.getResultAttr();
223 int v = frame.getResult();
224 ret = env.valueOfShort((short)v);
225 } else if (rt == Types.T_INT) {
226 attr = frame.getResultAttr();
227 int v = frame.getResult();
228 ret = env.valueOfInteger(v);
229 } else if (rt == Types.T_BOOLEAN) {
230 attr = frame.getResultAttr();
231 int v = frame.getResult();
232 ret = env.valueOfBoolean((v == 1)? true: false);
233 } else if (mi.isReferenceReturnType()){
234 attr = frame.getResultAttr();
235 ret = frame.getReferenceResult();
238 env.setReturnAttribute(attr);
242 static boolean pushUnboxedArguments (MJIEnv env, MethodInfo mi, DirectCallStackFrame frame, int argIdx, int argsRef) {
244 ClassInfo sourceClass;
245 String destTypeNames[];
246 int nArgs, passedCount, sourceRef;
247 byte sourceType, destTypes[];
249 destTypes = mi.getArgumentTypes();
250 destTypeNames = mi.getArgumentTypeNames();
251 nArgs = destTypeNames.length;
253 // according to the API docs, passing null instead of an empty array is allowed for no args
254 passedCount = (argsRef != MJIEnv.NULL) ? env.getArrayLength(argsRef) : 0;
256 if (nArgs != passedCount) {
257 env.throwException(IllegalArgumentException.class.getName(), "Wrong number of arguments passed. Actual = " + passedCount + ". Expected = " + nArgs);
261 for (int i = 0; i < nArgs; i++) {
262 sourceRef = env.getReferenceArrayElement(argsRef, i);
264 // we have to handle null references explicitly
265 if (sourceRef == MJIEnv.NULL) {
266 if ((destTypes[i] != Types.T_REFERENCE) && (destTypes[i] != Types.T_ARRAY)) {
267 env.throwException(IllegalArgumentException.class.getName(), "Wrong argument type at index " + i + ". Actual = (null). Expected = " + destTypeNames[i]);
271 frame.pushRef(MJIEnv.NULL);
275 source = env.getElementInfo(sourceRef);
276 sourceClass = source.getClassInfo();
277 sourceType = getSourceType( sourceClass, destTypes[i], destTypeNames[i]);
279 Object attr = env.getElementInfo(argsRef).getFields().getFieldAttr(i);
280 if ((argIdx = pushArg( argIdx, frame, source, sourceType, destTypes[i], attr)) < 0 ){
281 env.throwException(IllegalArgumentException.class.getName(), "Wrong argument type at index " + i + ". Source Class = " + sourceClass.getName() + ". Dest Class = " + destTypeNames[i]);
289 // this returns the primitive type in case we have to unbox, and otherwise checks reference type compatibility
290 private static byte getSourceType (ClassInfo ciArgVal, byte destType, String destTypeName){
293 case Types.T_BOOLEAN:
301 return Types.getUnboxedType(ciArgVal.getName());
304 case Types.T_REFERENCE: // check if the source type is assignment compatible with the destType
305 if (ciArgVal.isInstanceOf(destTypeName)){
313 // do the proper type conversion - Java is pretty forgiving here and does
314 // not throw exceptions upon value truncation
315 private static int pushArg( int argIdx, DirectCallStackFrame frame, ElementInfo eiArg, byte srcType, byte destType, Object attr){
319 double v = eiArg.getDoubleField("value");
320 if (destType == Types.T_DOUBLE){
321 return frame.setDoubleArgument( argIdx, v, attr);
325 case Types.T_FLOAT: // covers float, double
327 float v = eiArg.getFloatField("value");
330 return frame.setFloatArgument( argIdx, v, attr);
332 return frame.setDoubleArgument( argIdx, v, attr);
338 long v = eiArg.getLongField("value");
341 return frame.setLongArgument(argIdx, v, attr);
343 return frame.setFloatArgument(argIdx, v, attr);
345 return frame.setDoubleArgument( argIdx, v, attr);
351 int v = eiArg.getIntField("value");
354 return frame.setArgument( argIdx, v, attr);
356 return frame.setLongArgument( argIdx, v, attr);
358 return frame.setFloatArgument(argIdx, v, attr);
360 return frame.setDoubleArgument( argIdx, v, attr);
366 int v = eiArg.getShortField("value");
370 return frame.setArgument( argIdx, v, attr);
372 return frame.setLongArgument( argIdx, v, attr);
374 return frame.setFloatArgument(argIdx, v, attr);
376 return frame.setDoubleArgument( argIdx, v, attr);
382 byte v = eiArg.getByteField("value");
387 return frame.setArgument( argIdx, v, attr);
389 return frame.setLongArgument( argIdx, v, attr);
391 return frame.setFloatArgument(argIdx, v, attr);
393 return frame.setDoubleArgument( argIdx, v, attr);
399 char v = eiArg.getCharField("value");
403 return frame.setArgument( argIdx, v, attr);
405 return frame.setLongArgument( argIdx, v, attr);
407 return frame.setFloatArgument(argIdx, v, attr);
409 return frame.setDoubleArgument( argIdx, v, attr);
413 case Types.T_BOOLEAN:
415 boolean v = eiArg.getBooleanField("value");
416 if (destType == Types.T_BOOLEAN){
417 return frame.setArgument( argIdx, v ? 1 : 0, attr);
423 int ref = eiArg.getObjectRef();
424 if (destType == Types.T_ARRAY){
425 return frame.setReferenceArgument( argIdx, ref, attr);
429 case Types.T_REFERENCE:
431 int ref = eiArg.getObjectRef();
432 if (destType == Types.T_REFERENCE){
433 return frame.setReferenceArgument( argIdx, ref, attr);
444 public int invoke__Ljava_lang_Object_2_3Ljava_lang_Object_2__Ljava_lang_Object_2 (MJIEnv env, int mthRef, int objRef, int argsRef) {
445 ThreadInfo ti = env.getThreadInfo();
446 MethodInfo miCallee = getMethodInfo(env, mthRef);
447 ClassInfo calleeClass = miCallee.getClassInfo();
448 DirectCallStackFrame frame = ti.getReturnedDirectCall();
450 if (frame == null){ // first time
452 //--- check the instance we are calling on
453 if (!miCallee.isStatic()) {
454 if (objRef == MJIEnv.NULL){
455 env.throwException("java.lang.NullPointerException");
459 ElementInfo eiObj = ti.getElementInfo(objRef);
460 ClassInfo objClass = eiObj.getClassInfo();
462 if (!objClass.isInstanceOf(calleeClass)) {
463 env.throwException(IllegalArgumentException.class.getName(), "Object is not an instance of declaring class. Actual = " + objClass + ". Expected = " + calleeClass);
469 //--- check accessibility
470 ElementInfo eiMth = ti.getElementInfo(mthRef);
471 if (! (Boolean) eiMth.getFieldValueObject("isAccessible")) {
472 StackFrame caller = ti.getTopFrame().getPrevious();
473 ClassInfo callerClass = caller.getClassInfo();
475 if (callerClass != calleeClass) {
476 env.throwException(IllegalAccessException.class.getName(), "Class " + callerClass.getName() +
477 " can not access a member of class " + calleeClass.getName()
478 + " with modifiers \"" + Modifier.toString(miCallee.getModifiers()));
483 //--- push the direct call
484 frame = miCallee.createDirectCallStackFrame(ti, 0);
485 frame.setReflection();
488 if (!miCallee.isStatic()) {
489 frame.setReferenceArgument( argOffset++, objRef, null);
491 if (!pushUnboxedArguments( env, miCallee, frame, argOffset, argsRef)) {
492 // we've got a IllegalArgumentException
498 //--- check for and push required clinits
499 if (miCallee.isStatic()){
500 calleeClass.initializeClass(ti);
503 return MJIEnv.NULL; // reexecute
505 } else { // we have returned from the direct call
506 return createBoxedReturnValueObject( env, miCallee, frame);
511 // this one has to collect annotations upwards in the inheritance chain
512 static int getAnnotations (MJIEnv env, MethodInfo mi){
513 String mname = mi.getName();
514 String msig = mi.genericSignature;
515 ArrayList<AnnotationInfo> aiList = new ArrayList<AnnotationInfo>();
517 // our own annotations
518 ClassInfo ci = mi.getClassInfo();
519 for (AnnotationInfo ai : mi.getAnnotations()) {
523 // our superclass annotations
524 for (ci = ci.getSuperClass(); ci != null; ci = ci.getSuperClass()){
525 mi = ci.getMethod(mname, msig, false);
527 for (AnnotationInfo ai: mi.getAnnotations()){
534 return env.newAnnotationProxies(aiList.toArray(new AnnotationInfo[aiList.size()]));
535 } catch (ClinitRequired x){
536 env.handleClinitRequest(x.getRequiredClassInfo());
542 public int getAnnotations_____3Ljava_lang_annotation_Annotation_2 (MJIEnv env, int mthRef){
543 return getAnnotations( env, getMethodInfo(env,mthRef));
546 // the following ones consist of a package default implementation that is shared with
547 // the constructor peer, and a public model method
548 static int getAnnotation (MJIEnv env, MethodInfo mi, int annotationClsRef){
549 ClassInfo aci = env.getReferredClassInfo(annotationClsRef);
551 AnnotationInfo ai = mi.getAnnotation(aci.getName());
553 ClassInfo aciProxy = aci.getAnnotationProxy();
555 return env.newAnnotationProxy(aciProxy, ai);
556 } catch (ClinitRequired x){
557 env.handleClinitRequest(x.getRequiredClassInfo());
566 public int getAnnotation__Ljava_lang_Class_2__Ljava_lang_annotation_Annotation_2 (MJIEnv env, int mthRef, int annotationClsRef) {
567 return getAnnotation(env, getMethodInfo(env,mthRef), annotationClsRef);
570 static int getDeclaredAnnotations (MJIEnv env, MethodInfo mi){
571 AnnotationInfo[] ai = mi.getAnnotations();
574 return env.newAnnotationProxies(ai);
575 } catch (ClinitRequired x){
576 env.handleClinitRequest(x.getRequiredClassInfo());
582 public int getDeclaredAnnotations_____3Ljava_lang_annotation_Annotation_2 (MJIEnv env, int mthRef){
583 return getDeclaredAnnotations( env, getMethodInfo(env,mthRef));
586 static int getParameterAnnotations (MJIEnv env, MethodInfo mi){
587 AnnotationInfo[][] pa = mi.getParameterAnnotations();
588 // this should always return an array object, even if the method has no arguments
591 int paRef = env.newObjectArray("[Ljava/lang/annotation/Annotation;", pa.length);
593 for (int i=0; i<pa.length; i++){
594 int eRef = env.newAnnotationProxies(pa[i]);
595 env.setReferenceArrayElement(paRef, i, eRef);
600 } catch (ClinitRequired x){ // be prepared that we might have to initialize respective annotation classes
601 env.handleClinitRequest(x.getRequiredClassInfo());
607 public int getParameterAnnotations_____3_3Ljava_lang_annotation_Annotation_2 (MJIEnv env, int mthRef){
608 return getParameterAnnotations( env, getMethodInfo(env,mthRef));
612 public int toString____Ljava_lang_String_2 (MJIEnv env, int objRef){
613 StringBuilder sb = new StringBuilder();
615 MethodInfo mi = getMethodInfo(env, objRef);
617 sb.append(Modifier.toString(mi.getModifiers()));
620 sb.append(mi.getReturnTypeName());
623 sb.append(mi.getClassName());
626 sb.append(mi.getName());
630 String[] at = mi.getArgumentTypeNames();
631 for (int i=0; i<at.length; i++){
632 if (i>0) sb.append(',');
638 int sref = env.newString(sb.toString());
643 public boolean equals__Ljava_lang_Object_2__Z (MJIEnv env, int objRef, int mthRef){
644 ElementInfo ei = env.getElementInfo(mthRef);
645 ClassInfo ci = ClassLoaderInfo.getSystemResolvedClassInfo(JPF_java_lang_Class.METHOD_CLASSNAME);
647 if (ei.getClassInfo() == ci){
648 MethodInfo mi1 = getMethodInfo(env, objRef);
649 MethodInfo mi2 = getMethodInfo(env, mthRef);
650 if (mi1.getClassInfo() == mi2.getClassInfo()){
651 if (mi1.getName().equals(mi2.getName())){
652 if (mi1.getReturnType().equals(mi2.getReturnType())){
653 byte[] params1 = mi1.getArgumentTypes();
654 byte[] params2 = mi2.getArgumentTypes();
655 if (params1.length == params2.length){
656 for (int i = 0; i < params1.length; i++){
657 if (params1[i] != params2[i]){
671 public int hashCode____I (MJIEnv env, int objRef){
672 MethodInfo mi = getMethodInfo(env, objRef);
673 return mi.getClassName().hashCode() ^ mi.getName().hashCode();