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
118 // TODO: We have been able to only register the generic class and not yet the parameterized types
119 static int getGenericParameterTypes( MJIEnv env, MethodInfo mi) {
120 ThreadInfo ti = env.getThreadInfo();
121 String[] argTypeNames = mi.getArgumentGenericTypeNames();
122 int[] ar = new int[argTypeNames.length];
124 for (int i = 0; i < argTypeNames.length; i++) {
125 // Change this into just the generic class type if it is a generic class
126 String genericTypeName = argTypeNames[i];
127 int startOfGenericParameter = argTypeNames[i].indexOf('<');
128 if (startOfGenericParameter != -1) {
129 genericTypeName = argTypeNames[i].substring(0, startOfGenericParameter);
131 ClassInfo ci = ClassLoaderInfo.getCurrentResolvedClassInfo(genericTypeName);
132 if (!ci.isRegistered()) {
133 ci.registerClass(ti);
136 ar[i] = ci.getClassObjectRef();
139 int aRef = env.newObjectArray("Ljava/lang/reflect/Type;", argTypeNames.length);
140 for (int i = 0; i < argTypeNames.length; i++) {
141 env.setReferenceArrayElement(aRef, i, ar[i]);
148 public int getGenericParameterTypes_____3Ljava_lang_reflect_Type_2 (MJIEnv env, int objRef){
149 return getGenericParameterTypes(env, getMethodInfo(env, objRef));
153 public int getGenericReturnType____Ljava_lang_reflect_Type_2 (MJIEnv env, int objRef){
154 MethodInfo mi = getMethodInfo(env, objRef);
155 ThreadInfo ti = env.getThreadInfo();
157 ClassInfo ci = ClassLoaderInfo.getCurrentResolvedClassInfo(mi.getReturnTypeName());
158 if (!ci.isRegistered()) {
159 ci.registerClass(ti);
162 return ci.getClassObjectRef();
164 // TODO: Fix for Groovy's model-checking
165 // TODO: We have been able to only register the generic class and not yet the parameterized types
167 int getExceptionTypes(MJIEnv env, MethodInfo mi) {
168 ThreadInfo ti = env.getThreadInfo();
169 String[] exceptionNames = mi.getThrownExceptionClassNames();
171 if (exceptionNames == null) {
172 exceptionNames = new String[0];
175 int[] ar = new int[exceptionNames.length];
177 for (int i = 0; i < exceptionNames.length; i++) {
178 ClassInfo ci = ClassLoaderInfo.getCurrentResolvedClassInfo(exceptionNames[i]);
179 if (!ci.isRegistered()) {
180 ci.registerClass(ti);
183 ar[i] = ci.getClassObjectRef();
186 int aRef = env.newObjectArray("Ljava/lang/Class;", exceptionNames.length);
187 for (int i = 0; i < exceptionNames.length; i++) {
188 env.setReferenceArrayElement(aRef, i, ar[i]);
195 public int getExceptionTypes_____3Ljava_lang_Class_2 (MJIEnv env, int objRef) {
196 return getExceptionTypes(env, getMethodInfo(env, objRef));
200 public int getDefaultValue____Ljava_lang_Object_2(MJIEnv env, int objRef) {
201 MethodInfo mi = getMethodInfo(env, objRef);
202 ClassInfo ci = mi.getClassInfo();
203 if(!ci.isInterface() || ci.getDirectInterfaceNames() == null || ci.getDirectInterfaceNames().length != 1 || !ci.getDirectInterfaceNames()[0].equals("java.lang.annotation.Annotation")) {
206 String annotationName = ci.getName();
207 AnnotationInfo ai = ci.getClassLoaderInfo().getResolvedAnnotationInfo(annotationName);
208 Object o = ai.getValue(mi.getName());
213 return env.liftNativeAnnotationValue(Types.getTypeName(mi.getReturnType()), o);
214 } catch(ClinitRequired e) {
215 env.handleClinitRequest(e.getRequiredClassInfo());
221 public int getReturnType____Ljava_lang_Class_2 (MJIEnv env, int objRef){
222 MethodInfo mi = getMethodInfo(env, objRef);
223 ThreadInfo ti = env.getThreadInfo();
225 ClassInfo ci = ClassLoaderInfo.getCurrentResolvedClassInfo(mi.getReturnTypeName());
226 if (!ci.isRegistered()) {
227 ci.registerClass(ti);
230 return ci.getClassObjectRef();
234 public int getDeclaringClass____Ljava_lang_Class_2 (MJIEnv env, int objRef){
235 MethodInfo mi = getMethodInfo(env, objRef);
236 ClassInfo ci = mi.getClassInfo();
237 // it's got to be registered, otherwise we wouldn't be able to acquire the Method object
238 return ci.getClassObjectRef();
241 static int createBoxedReturnValueObject (MJIEnv env, MethodInfo mi, DirectCallStackFrame frame) {
242 byte rt = mi.getReturnTypeCode();
243 int ret = MJIEnv.NULL;
247 if (rt == Types.T_DOUBLE) {
248 attr = frame.getLongResultAttr();
249 double v = frame.getDoubleResult();
250 ret = env.newObject(ClassLoaderInfo.getSystemResolvedClassInfo("java.lang.Double"));
251 rei = env.getModifiableElementInfo(ret);
252 rei.setDoubleField("value", v);
253 } else if (rt == Types.T_FLOAT) {
254 attr = frame.getResultAttr();
255 float v = frame.getFloatResult();
256 ret = env.newObject(ClassLoaderInfo.getSystemResolvedClassInfo("java.lang.Float"));
257 rei = env.getModifiableElementInfo(ret);
258 rei.setFloatField("value", v);
259 } else if (rt == Types.T_LONG) {
260 attr = frame.getLongResultAttr();
261 long v = frame.getLongResult();
262 ret = env.valueOfLong(v);
263 } else if (rt == Types.T_BYTE) {
264 attr = frame.getResultAttr();
265 int v = frame.getResult();
266 ret = env.valueOfByte((byte)v);
267 } else if (rt == Types.T_CHAR) {
268 attr = frame.getResultAttr();
269 int v = frame.getResult();
270 ret = env.valueOfCharacter((char)v);
271 } else if (rt == Types.T_SHORT) {
272 attr = frame.getResultAttr();
273 int v = frame.getResult();
274 ret = env.valueOfShort((short)v);
275 } else if (rt == Types.T_INT) {
276 attr = frame.getResultAttr();
277 int v = frame.getResult();
278 ret = env.valueOfInteger(v);
279 } else if (rt == Types.T_BOOLEAN) {
280 attr = frame.getResultAttr();
281 int v = frame.getResult();
282 ret = env.valueOfBoolean((v == 1)? true: false);
283 } else if (mi.isReferenceReturnType()){
284 attr = frame.getResultAttr();
285 ret = frame.getReferenceResult();
288 env.setReturnAttribute(attr);
292 static boolean pushUnboxedArguments (MJIEnv env, MethodInfo mi, DirectCallStackFrame frame, int argIdx, int argsRef) {
294 ClassInfo sourceClass;
295 String destTypeNames[];
296 int nArgs, passedCount, sourceRef;
297 byte sourceType, destTypes[];
299 destTypes = mi.getArgumentTypes();
300 destTypeNames = mi.getArgumentTypeNames();
301 nArgs = destTypeNames.length;
303 // according to the API docs, passing null instead of an empty array is allowed for no args
304 passedCount = (argsRef != MJIEnv.NULL) ? env.getArrayLength(argsRef) : 0;
306 if (nArgs != passedCount) {
307 env.throwException(IllegalArgumentException.class.getName(), "Wrong number of arguments passed. Actual = " + passedCount + ". Expected = " + nArgs);
311 for (int i = 0; i < nArgs; i++) {
312 sourceRef = env.getReferenceArrayElement(argsRef, i);
314 // we have to handle null references explicitly
315 if (sourceRef == MJIEnv.NULL) {
316 if ((destTypes[i] != Types.T_REFERENCE) && (destTypes[i] != Types.T_ARRAY)) {
317 env.throwException(IllegalArgumentException.class.getName(), "Wrong argument type at index " + i + ". Actual = (null). Expected = " + destTypeNames[i]);
321 frame.pushRef(MJIEnv.NULL);
325 source = env.getElementInfo(sourceRef);
326 sourceClass = source.getClassInfo();
327 sourceType = getSourceType( sourceClass, destTypes[i], destTypeNames[i]);
329 Object attr = env.getElementInfo(argsRef).getFields().getFieldAttr(i);
330 if ((argIdx = pushArg( argIdx, frame, source, sourceType, destTypes[i], attr)) < 0 ){
331 env.throwException(IllegalArgumentException.class.getName(), "Wrong argument type at index " + i + ". Source Class = " + sourceClass.getName() + ". Dest Class = " + destTypeNames[i]);
339 // this returns the primitive type in case we have to unbox, and otherwise checks reference type compatibility
340 private static byte getSourceType (ClassInfo ciArgVal, byte destType, String destTypeName){
343 case Types.T_BOOLEAN:
351 return Types.getUnboxedType(ciArgVal.getName());
354 case Types.T_REFERENCE: // check if the source type is assignment compatible with the destType
355 if (ciArgVal.isInstanceOf(destTypeName)){
363 // do the proper type conversion - Java is pretty forgiving here and does
364 // not throw exceptions upon value truncation
365 private static int pushArg( int argIdx, DirectCallStackFrame frame, ElementInfo eiArg, byte srcType, byte destType, Object attr){
369 double v = eiArg.getDoubleField("value");
370 if (destType == Types.T_DOUBLE){
371 return frame.setDoubleArgument( argIdx, v, attr);
375 case Types.T_FLOAT: // covers float, double
377 float v = eiArg.getFloatField("value");
380 return frame.setFloatArgument( argIdx, v, attr);
382 return frame.setDoubleArgument( argIdx, v, attr);
388 long v = eiArg.getLongField("value");
391 return frame.setLongArgument(argIdx, v, attr);
393 return frame.setFloatArgument(argIdx, v, attr);
395 return frame.setDoubleArgument( argIdx, v, attr);
401 int v = eiArg.getIntField("value");
404 return frame.setArgument( argIdx, v, attr);
406 return frame.setLongArgument( argIdx, v, attr);
408 return frame.setFloatArgument(argIdx, v, attr);
410 return frame.setDoubleArgument( argIdx, v, attr);
416 int v = eiArg.getShortField("value");
420 return frame.setArgument( argIdx, v, attr);
422 return frame.setLongArgument( argIdx, v, attr);
424 return frame.setFloatArgument(argIdx, v, attr);
426 return frame.setDoubleArgument( argIdx, v, attr);
432 byte v = eiArg.getByteField("value");
437 return frame.setArgument( argIdx, v, attr);
439 return frame.setLongArgument( argIdx, v, attr);
441 return frame.setFloatArgument(argIdx, v, attr);
443 return frame.setDoubleArgument( argIdx, v, attr);
449 char v = eiArg.getCharField("value");
453 return frame.setArgument( argIdx, v, attr);
455 return frame.setLongArgument( argIdx, v, attr);
457 return frame.setFloatArgument(argIdx, v, attr);
459 return frame.setDoubleArgument( argIdx, v, attr);
463 case Types.T_BOOLEAN:
465 boolean v = eiArg.getBooleanField("value");
466 if (destType == Types.T_BOOLEAN){
467 return frame.setArgument( argIdx, v ? 1 : 0, attr);
473 int ref = eiArg.getObjectRef();
474 if (destType == Types.T_ARRAY){
475 return frame.setReferenceArgument( argIdx, ref, attr);
479 case Types.T_REFERENCE:
481 int ref = eiArg.getObjectRef();
482 if (destType == Types.T_REFERENCE){
483 return frame.setReferenceArgument( argIdx, ref, attr);
494 public int invoke__Ljava_lang_Object_2_3Ljava_lang_Object_2__Ljava_lang_Object_2 (MJIEnv env, int mthRef, int objRef, int argsRef) {
495 ThreadInfo ti = env.getThreadInfo();
496 MethodInfo miCallee = getMethodInfo(env, mthRef);
497 ClassInfo calleeClass = miCallee.getClassInfo();
498 DirectCallStackFrame frame = ti.getReturnedDirectCall();
500 if (frame == null){ // first time
502 //--- check the instance we are calling on
503 if (!miCallee.isStatic()) {
504 if (objRef == MJIEnv.NULL){
505 env.throwException("java.lang.NullPointerException");
509 ElementInfo eiObj = ti.getElementInfo(objRef);
510 ClassInfo objClass = eiObj.getClassInfo();
512 if (!objClass.isInstanceOf(calleeClass)) {
513 env.throwException(IllegalArgumentException.class.getName(), "Object is not an instance of declaring class. Actual = " + objClass + ". Expected = " + calleeClass);
519 //--- check accessibility
520 ElementInfo eiMth = ti.getElementInfo(mthRef);
521 if (! (Boolean) eiMth.getFieldValueObject("isAccessible")) {
522 StackFrame caller = ti.getTopFrame().getPrevious();
523 ClassInfo callerClass = caller.getClassInfo();
525 if (callerClass != calleeClass) {
526 env.throwException(IllegalAccessException.class.getName(), "Class " + callerClass.getName() +
527 " can not access a member of class " + calleeClass.getName()
528 + " with modifiers \"" + Modifier.toString(miCallee.getModifiers()));
533 //--- push the direct call
534 frame = miCallee.createDirectCallStackFrame(ti, 0);
535 frame.setReflection();
538 if (!miCallee.isStatic()) {
539 frame.setReferenceArgument( argOffset++, objRef, null);
541 if (!pushUnboxedArguments( env, miCallee, frame, argOffset, argsRef)) {
542 // we've got a IllegalArgumentException
548 //--- check for and push required clinits
549 if (miCallee.isStatic()){
550 calleeClass.initializeClass(ti);
553 return MJIEnv.NULL; // reexecute
555 } else { // we have returned from the direct call
556 return createBoxedReturnValueObject( env, miCallee, frame);
561 // this one has to collect annotations upwards in the inheritance chain
562 static int getAnnotations (MJIEnv env, MethodInfo mi){
563 String mname = mi.getName();
564 String msig = mi.genericSignature;
565 ArrayList<AnnotationInfo> aiList = new ArrayList<AnnotationInfo>();
567 // our own annotations
568 ClassInfo ci = mi.getClassInfo();
569 for (AnnotationInfo ai : mi.getAnnotations()) {
573 // our superclass annotations
574 for (ci = ci.getSuperClass(); ci != null; ci = ci.getSuperClass()){
575 mi = ci.getMethod(mname, msig, false);
577 for (AnnotationInfo ai: mi.getAnnotations()){
584 return env.newAnnotationProxies(aiList.toArray(new AnnotationInfo[aiList.size()]));
585 } catch (ClinitRequired x){
586 env.handleClinitRequest(x.getRequiredClassInfo());
592 public int getAnnotations_____3Ljava_lang_annotation_Annotation_2 (MJIEnv env, int mthRef){
593 return getAnnotations( env, getMethodInfo(env,mthRef));
596 // the following ones consist of a package default implementation that is shared with
597 // the constructor peer, and a public model method
598 static int getAnnotation (MJIEnv env, MethodInfo mi, int annotationClsRef){
599 ClassInfo aci = env.getReferredClassInfo(annotationClsRef);
601 AnnotationInfo ai = mi.getAnnotation(aci.getName());
603 ClassInfo aciProxy = aci.getAnnotationProxy();
605 return env.newAnnotationProxy(aciProxy, ai);
606 } catch (ClinitRequired x){
607 env.handleClinitRequest(x.getRequiredClassInfo());
616 public int getAnnotation__Ljava_lang_Class_2__Ljava_lang_annotation_Annotation_2 (MJIEnv env, int mthRef, int annotationClsRef) {
617 return getAnnotation(env, getMethodInfo(env,mthRef), annotationClsRef);
620 static int getDeclaredAnnotations (MJIEnv env, MethodInfo mi){
621 AnnotationInfo[] ai = mi.getAnnotations();
624 return env.newAnnotationProxies(ai);
625 } catch (ClinitRequired x){
626 env.handleClinitRequest(x.getRequiredClassInfo());
632 public int getDeclaredAnnotations_____3Ljava_lang_annotation_Annotation_2 (MJIEnv env, int mthRef){
633 return getDeclaredAnnotations( env, getMethodInfo(env,mthRef));
636 static int getParameterAnnotations (MJIEnv env, MethodInfo mi){
637 AnnotationInfo[][] pa = mi.getParameterAnnotations();
638 // this should always return an array object, even if the method has no arguments
641 int paRef = env.newObjectArray("[Ljava/lang/annotation/Annotation;", pa.length);
643 for (int i=0; i<pa.length; i++){
644 int eRef = env.newAnnotationProxies(pa[i]);
645 env.setReferenceArrayElement(paRef, i, eRef);
650 } catch (ClinitRequired x){ // be prepared that we might have to initialize respective annotation classes
651 env.handleClinitRequest(x.getRequiredClassInfo());
657 public int getParameterAnnotations_____3_3Ljava_lang_annotation_Annotation_2 (MJIEnv env, int mthRef){
658 return getParameterAnnotations( env, getMethodInfo(env,mthRef));
662 public int toString____Ljava_lang_String_2 (MJIEnv env, int objRef){
663 StringBuilder sb = new StringBuilder();
665 MethodInfo mi = getMethodInfo(env, objRef);
667 sb.append(Modifier.toString(mi.getModifiers()));
670 sb.append(mi.getReturnTypeName());
673 sb.append(mi.getClassName());
676 sb.append(mi.getName());
680 String[] at = mi.getArgumentTypeNames();
681 for (int i=0; i<at.length; i++){
682 if (i>0) sb.append(',');
688 int sref = env.newString(sb.toString());
693 public boolean equals__Ljava_lang_Object_2__Z (MJIEnv env, int objRef, int mthRef){
694 ElementInfo ei = env.getElementInfo(mthRef);
695 ClassInfo ci = ClassLoaderInfo.getSystemResolvedClassInfo(JPF_java_lang_Class.METHOD_CLASSNAME);
697 if (ei.getClassInfo() == ci){
698 MethodInfo mi1 = getMethodInfo(env, objRef);
699 MethodInfo mi2 = getMethodInfo(env, mthRef);
700 if (mi1.getClassInfo() == mi2.getClassInfo()){
701 if (mi1.getName().equals(mi2.getName())){
702 if (mi1.getReturnType().equals(mi2.getReturnType())){
703 byte[] params1 = mi1.getArgumentTypes();
704 byte[] params2 = mi2.getArgumentTypes();
705 if (params1.length == params2.length){
706 for (int i = 0; i < params1.length; i++){
707 if (params1[i] != params2[i]){
721 public int hashCode____I (MJIEnv env, int objRef){
722 MethodInfo mi = getMethodInfo(env, objRef);
723 return mi.getClassName().hashCode() ^ mi.getName().hashCode();