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 getReturnType____Ljava_lang_Class_2 (MJIEnv env, int objRef){
151 MethodInfo mi = getMethodInfo(env, objRef);
152 ThreadInfo ti = env.getThreadInfo();
154 ClassInfo ci = ClassLoaderInfo.getCurrentResolvedClassInfo(mi.getReturnTypeName());
155 if (!ci.isRegistered()) {
156 ci.registerClass(ti);
159 return ci.getClassObjectRef();
163 public int getDeclaringClass____Ljava_lang_Class_2 (MJIEnv env, int objRef){
164 MethodInfo mi = getMethodInfo(env, objRef);
165 ClassInfo ci = mi.getClassInfo();
166 // it's got to be registered, otherwise we wouldn't be able to acquire the Method object
167 return ci.getClassObjectRef();
170 static int createBoxedReturnValueObject (MJIEnv env, MethodInfo mi, DirectCallStackFrame frame) {
171 byte rt = mi.getReturnTypeCode();
172 int ret = MJIEnv.NULL;
176 if (rt == Types.T_DOUBLE) {
177 attr = frame.getLongResultAttr();
178 double v = frame.getDoubleResult();
179 ret = env.newObject(ClassLoaderInfo.getSystemResolvedClassInfo("java.lang.Double"));
180 rei = env.getModifiableElementInfo(ret);
181 rei.setDoubleField("value", v);
182 } else if (rt == Types.T_FLOAT) {
183 attr = frame.getResultAttr();
184 float v = frame.getFloatResult();
185 ret = env.newObject(ClassLoaderInfo.getSystemResolvedClassInfo("java.lang.Float"));
186 rei = env.getModifiableElementInfo(ret);
187 rei.setFloatField("value", v);
188 } else if (rt == Types.T_LONG) {
189 attr = frame.getLongResultAttr();
190 long v = frame.getLongResult();
191 ret = env.valueOfLong(v);
192 } else if (rt == Types.T_BYTE) {
193 attr = frame.getResultAttr();
194 int v = frame.getResult();
195 ret = env.valueOfByte((byte)v);
196 } else if (rt == Types.T_CHAR) {
197 attr = frame.getResultAttr();
198 int v = frame.getResult();
199 ret = env.valueOfCharacter((char)v);
200 } else if (rt == Types.T_SHORT) {
201 attr = frame.getResultAttr();
202 int v = frame.getResult();
203 ret = env.valueOfShort((short)v);
204 } else if (rt == Types.T_INT) {
205 attr = frame.getResultAttr();
206 int v = frame.getResult();
207 ret = env.valueOfInteger(v);
208 } else if (rt == Types.T_BOOLEAN) {
209 attr = frame.getResultAttr();
210 int v = frame.getResult();
211 ret = env.valueOfBoolean((v == 1)? true: false);
212 } else if (mi.isReferenceReturnType()){
213 attr = frame.getResultAttr();
214 ret = frame.getReferenceResult();
217 env.setReturnAttribute(attr);
221 static boolean pushUnboxedArguments (MJIEnv env, MethodInfo mi, DirectCallStackFrame frame, int argIdx, int argsRef) {
223 ClassInfo sourceClass;
224 String destTypeNames[];
225 int nArgs, passedCount, sourceRef;
226 byte sourceType, destTypes[];
228 destTypes = mi.getArgumentTypes();
229 destTypeNames = mi.getArgumentTypeNames();
230 nArgs = destTypeNames.length;
232 // according to the API docs, passing null instead of an empty array is allowed for no args
233 passedCount = (argsRef != MJIEnv.NULL) ? env.getArrayLength(argsRef) : 0;
235 if (nArgs != passedCount) {
236 env.throwException(IllegalArgumentException.class.getName(), "Wrong number of arguments passed. Actual = " + passedCount + ". Expected = " + nArgs);
240 for (int i = 0; i < nArgs; i++) {
241 sourceRef = env.getReferenceArrayElement(argsRef, i);
243 // we have to handle null references explicitly
244 if (sourceRef == MJIEnv.NULL) {
245 if ((destTypes[i] != Types.T_REFERENCE) && (destTypes[i] != Types.T_ARRAY)) {
246 env.throwException(IllegalArgumentException.class.getName(), "Wrong argument type at index " + i + ". Actual = (null). Expected = " + destTypeNames[i]);
250 frame.pushRef(MJIEnv.NULL);
254 source = env.getElementInfo(sourceRef);
255 sourceClass = source.getClassInfo();
256 sourceType = getSourceType( sourceClass, destTypes[i], destTypeNames[i]);
258 Object attr = env.getElementInfo(argsRef).getFields().getFieldAttr(i);
259 if ((argIdx = pushArg( argIdx, frame, source, sourceType, destTypes[i], attr)) < 0 ){
260 env.throwException(IllegalArgumentException.class.getName(), "Wrong argument type at index " + i + ". Source Class = " + sourceClass.getName() + ". Dest Class = " + destTypeNames[i]);
268 // this returns the primitive type in case we have to unbox, and otherwise checks reference type compatibility
269 private static byte getSourceType (ClassInfo ciArgVal, byte destType, String destTypeName){
272 case Types.T_BOOLEAN:
280 return Types.getUnboxedType(ciArgVal.getName());
283 case Types.T_REFERENCE: // check if the source type is assignment compatible with the destType
284 if (ciArgVal.isInstanceOf(destTypeName)){
292 // do the proper type conversion - Java is pretty forgiving here and does
293 // not throw exceptions upon value truncation
294 private static int pushArg( int argIdx, DirectCallStackFrame frame, ElementInfo eiArg, byte srcType, byte destType, Object attr){
298 double v = eiArg.getDoubleField("value");
299 if (destType == Types.T_DOUBLE){
300 return frame.setDoubleArgument( argIdx, v, attr);
304 case Types.T_FLOAT: // covers float, double
306 float v = eiArg.getFloatField("value");
309 return frame.setFloatArgument( argIdx, v, attr);
311 return frame.setDoubleArgument( argIdx, v, attr);
317 long v = eiArg.getLongField("value");
320 return frame.setLongArgument(argIdx, v, attr);
322 return frame.setFloatArgument(argIdx, v, attr);
324 return frame.setDoubleArgument( argIdx, v, attr);
330 int v = eiArg.getIntField("value");
333 return frame.setArgument( argIdx, v, attr);
335 return frame.setLongArgument( argIdx, v, attr);
337 return frame.setFloatArgument(argIdx, v, attr);
339 return frame.setDoubleArgument( argIdx, v, attr);
345 int v = eiArg.getShortField("value");
349 return frame.setArgument( argIdx, v, attr);
351 return frame.setLongArgument( argIdx, v, attr);
353 return frame.setFloatArgument(argIdx, v, attr);
355 return frame.setDoubleArgument( argIdx, v, attr);
361 byte v = eiArg.getByteField("value");
366 return frame.setArgument( argIdx, v, attr);
368 return frame.setLongArgument( argIdx, v, attr);
370 return frame.setFloatArgument(argIdx, v, attr);
372 return frame.setDoubleArgument( argIdx, v, attr);
378 char v = eiArg.getCharField("value");
382 return frame.setArgument( argIdx, v, attr);
384 return frame.setLongArgument( argIdx, v, attr);
386 return frame.setFloatArgument(argIdx, v, attr);
388 return frame.setDoubleArgument( argIdx, v, attr);
392 case Types.T_BOOLEAN:
394 boolean v = eiArg.getBooleanField("value");
395 if (destType == Types.T_BOOLEAN){
396 return frame.setArgument( argIdx, v ? 1 : 0, attr);
402 int ref = eiArg.getObjectRef();
403 if (destType == Types.T_ARRAY){
404 return frame.setReferenceArgument( argIdx, ref, attr);
408 case Types.T_REFERENCE:
410 int ref = eiArg.getObjectRef();
411 if (destType == Types.T_REFERENCE){
412 return frame.setReferenceArgument( argIdx, ref, attr);
423 public int invoke__Ljava_lang_Object_2_3Ljava_lang_Object_2__Ljava_lang_Object_2 (MJIEnv env, int mthRef, int objRef, int argsRef) {
424 ThreadInfo ti = env.getThreadInfo();
425 MethodInfo miCallee = getMethodInfo(env, mthRef);
426 ClassInfo calleeClass = miCallee.getClassInfo();
427 DirectCallStackFrame frame = ti.getReturnedDirectCall();
429 if (frame == null){ // first time
431 //--- check the instance we are calling on
432 if (!miCallee.isStatic()) {
433 if (objRef == MJIEnv.NULL){
434 env.throwException("java.lang.NullPointerException");
438 ElementInfo eiObj = ti.getElementInfo(objRef);
439 ClassInfo objClass = eiObj.getClassInfo();
441 if (!objClass.isInstanceOf(calleeClass)) {
442 env.throwException(IllegalArgumentException.class.getName(), "Object is not an instance of declaring class. Actual = " + objClass + ". Expected = " + calleeClass);
448 //--- check accessibility
449 ElementInfo eiMth = ti.getElementInfo(mthRef);
450 if (! (Boolean) eiMth.getFieldValueObject("isAccessible")) {
451 StackFrame caller = ti.getTopFrame().getPrevious();
452 ClassInfo callerClass = caller.getClassInfo();
454 if (callerClass != calleeClass) {
455 env.throwException(IllegalAccessException.class.getName(), "Class " + callerClass.getName() +
456 " can not access a member of class " + calleeClass.getName()
457 + " with modifiers \"" + Modifier.toString(miCallee.getModifiers()));
462 //--- push the direct call
463 frame = miCallee.createDirectCallStackFrame(ti, 0);
464 frame.setReflection();
467 if (!miCallee.isStatic()) {
468 frame.setReferenceArgument( argOffset++, objRef, null);
470 if (!pushUnboxedArguments( env, miCallee, frame, argOffset, argsRef)) {
471 // we've got a IllegalArgumentException
477 //--- check for and push required clinits
478 if (miCallee.isStatic()){
479 calleeClass.initializeClass(ti);
482 return MJIEnv.NULL; // reexecute
484 } else { // we have returned from the direct call
485 return createBoxedReturnValueObject( env, miCallee, frame);
490 // this one has to collect annotations upwards in the inheritance chain
491 static int getAnnotations (MJIEnv env, MethodInfo mi){
492 String mname = mi.getName();
493 String msig = mi.genericSignature;
494 ArrayList<AnnotationInfo> aiList = new ArrayList<AnnotationInfo>();
496 // our own annotations
497 ClassInfo ci = mi.getClassInfo();
498 for (AnnotationInfo ai : mi.getAnnotations()) {
502 // our superclass annotations
503 for (ci = ci.getSuperClass(); ci != null; ci = ci.getSuperClass()){
504 mi = ci.getMethod(mname, msig, false);
506 for (AnnotationInfo ai: mi.getAnnotations()){
513 return env.newAnnotationProxies(aiList.toArray(new AnnotationInfo[aiList.size()]));
514 } catch (ClinitRequired x){
515 env.handleClinitRequest(x.getRequiredClassInfo());
521 public int getAnnotations_____3Ljava_lang_annotation_Annotation_2 (MJIEnv env, int mthRef){
522 return getAnnotations( env, getMethodInfo(env,mthRef));
525 // the following ones consist of a package default implementation that is shared with
526 // the constructor peer, and a public model method
527 static int getAnnotation (MJIEnv env, MethodInfo mi, int annotationClsRef){
528 ClassInfo aci = env.getReferredClassInfo(annotationClsRef);
530 AnnotationInfo ai = mi.getAnnotation(aci.getName());
532 ClassInfo aciProxy = aci.getAnnotationProxy();
534 return env.newAnnotationProxy(aciProxy, ai);
535 } catch (ClinitRequired x){
536 env.handleClinitRequest(x.getRequiredClassInfo());
545 public int getAnnotation__Ljava_lang_Class_2__Ljava_lang_annotation_Annotation_2 (MJIEnv env, int mthRef, int annotationClsRef) {
546 return getAnnotation(env, getMethodInfo(env,mthRef), annotationClsRef);
549 static int getDeclaredAnnotations (MJIEnv env, MethodInfo mi){
550 AnnotationInfo[] ai = mi.getAnnotations();
553 return env.newAnnotationProxies(ai);
554 } catch (ClinitRequired x){
555 env.handleClinitRequest(x.getRequiredClassInfo());
561 public int getDeclaredAnnotations_____3Ljava_lang_annotation_Annotation_2 (MJIEnv env, int mthRef){
562 return getDeclaredAnnotations( env, getMethodInfo(env,mthRef));
565 static int getParameterAnnotations (MJIEnv env, MethodInfo mi){
566 AnnotationInfo[][] pa = mi.getParameterAnnotations();
567 // this should always return an array object, even if the method has no arguments
570 int paRef = env.newObjectArray("[Ljava/lang/annotation/Annotation;", pa.length);
572 for (int i=0; i<pa.length; i++){
573 int eRef = env.newAnnotationProxies(pa[i]);
574 env.setReferenceArrayElement(paRef, i, eRef);
579 } catch (ClinitRequired x){ // be prepared that we might have to initialize respective annotation classes
580 env.handleClinitRequest(x.getRequiredClassInfo());
586 public int getParameterAnnotations_____3_3Ljava_lang_annotation_Annotation_2 (MJIEnv env, int mthRef){
587 return getParameterAnnotations( env, getMethodInfo(env,mthRef));
591 public int toString____Ljava_lang_String_2 (MJIEnv env, int objRef){
592 StringBuilder sb = new StringBuilder();
594 MethodInfo mi = getMethodInfo(env, objRef);
596 sb.append(Modifier.toString(mi.getModifiers()));
599 sb.append(mi.getReturnTypeName());
602 sb.append(mi.getClassName());
605 sb.append(mi.getName());
609 String[] at = mi.getArgumentTypeNames();
610 for (int i=0; i<at.length; i++){
611 if (i>0) sb.append(',');
617 int sref = env.newString(sb.toString());
622 public boolean equals__Ljava_lang_Object_2__Z (MJIEnv env, int objRef, int mthRef){
623 ElementInfo ei = env.getElementInfo(mthRef);
624 ClassInfo ci = ClassLoaderInfo.getSystemResolvedClassInfo(JPF_java_lang_Class.METHOD_CLASSNAME);
626 if (ei.getClassInfo() == ci){
627 MethodInfo mi1 = getMethodInfo(env, objRef);
628 MethodInfo mi2 = getMethodInfo(env, mthRef);
629 if (mi1.getClassInfo() == mi2.getClassInfo()){
630 if (mi1.getName().equals(mi2.getName())){
631 if (mi1.getReturnType().equals(mi2.getReturnType())){
632 byte[] params1 = mi1.getArgumentTypes();
633 byte[] params2 = mi2.getArgumentTypes();
634 if (params1.length == params2.length){
635 for (int i = 0; i < params1.length; i++){
636 if (params1[i] != params2[i]){
650 public int hashCode____I (MJIEnv env, int objRef){
651 MethodInfo mi = getMethodInfo(env, objRef);
652 return mi.getClassName().hashCode() ^ mi.getName().hashCode();