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;
22 import gov.nasa.jpf.annotation.MJI;
23 import gov.nasa.jpf.vm.ClassPath;
24 import gov.nasa.jpf.vm.ClassInfo;
25 import gov.nasa.jpf.vm.ClassLoaderInfo;
26 import gov.nasa.jpf.vm.ClassInfoException;
27 import gov.nasa.jpf.vm.ClinitRequired;
28 import gov.nasa.jpf.vm.ElementInfo;
29 import gov.nasa.jpf.vm.Heap;
30 import gov.nasa.jpf.vm.MJIEnv;
31 import gov.nasa.jpf.vm.NativePeer;
32 import gov.nasa.jpf.vm.ThreadInfo;
35 * @author Nastaran Shafiei <nastaran.shafiei@gmail.com>
37 * Native peer for java.lang.ClassLoader
39 public class JPF_java_lang_ClassLoader extends NativePeer {
42 public void $init____V (MJIEnv env, int objRef) {
43 ClassLoaderInfo systemCl = ClassLoaderInfo.getCurrentSystemClassLoader();
44 $init__Ljava_lang_ClassLoader_2__V (env, objRef, systemCl.getClassLoaderObjectRef());
48 public void $init__Ljava_lang_ClassLoader_2__V (MJIEnv env, int objRef, int parentRef) {
49 Heap heap = env.getHeap();
51 //--- Retrieve the parent ClassLoaderInfo
52 ClassLoaderInfo parent = env.getClassLoaderInfo(parentRef);
54 //--- create the internal representation of the classloader
55 ClassLoaderInfo cl = new ClassLoaderInfo(env.getVM(), objRef, new ClassPath(), parent);
57 //--- initialize the java.lang.ClassLoader object
58 ElementInfo ei = heap.getModifiable(objRef);
59 ei.setIntField( ClassLoaderInfo.ID_FIELD, cl.getId());
61 // we should use the following block if we ever decide to make systemClassLoader
62 // unavailable if(parent.isSystemClassLoader) {
63 // // we don't want to make the systemCLassLoader available through SUT
64 // parentRef = MJIEnv.NULL;
67 ei.setReferenceField("parent", parentRef);
71 public int getSystemClassLoader____Ljava_lang_ClassLoader_2 (MJIEnv env, int clsObjRef) {
72 return ClassLoaderInfo.getCurrentSystemClassLoader().getClassLoaderObjectRef();
76 public int getResource0__Ljava_lang_String_2__Ljava_lang_String_2 (MJIEnv env, int objRef, int resRef){
77 String rname = env.getStringObject(resRef);
79 ClassLoaderInfo cl = env.getClassLoaderInfo(objRef);
81 String resourcePath = cl.findResource(rname);
83 return env.newString(resourcePath);
87 public int getResources0__Ljava_lang_String_2___3Ljava_lang_String_2 (MJIEnv env, int objRef, int resRef) {
88 String rname = env.getStringObject(resRef);
90 ClassLoaderInfo cl = env.getClassLoaderInfo(objRef);
92 String[] resources = cl.findResources(rname);
94 return env.newStringArray(resources);
98 public int findLoadedClass__Ljava_lang_String_2__Ljava_lang_Class_2 (MJIEnv env, int objRef, int nameRef) {
99 String cname = env.getStringObject(nameRef);
101 ClassLoaderInfo cl = env.getClassLoaderInfo(objRef);
103 ClassInfo ci = cl.getAlreadyResolvedClassInfo(cname);
105 return ci.getClassObjectRef();
112 public int findSystemClass__Ljava_lang_String_2__Ljava_lang_Class_2 (MJIEnv env, int objRef, int nameRef) {
113 String cname = env.getStringObject(nameRef);
115 checkForIllegalName(env, cname);
116 if(env.hasException()) {
120 ClassLoaderInfo cl = ClassLoaderInfo.getCurrentSystemClassLoader();
122 ClassInfo ci = cl.getResolvedClassInfo(cname);
124 if(!ci.isRegistered()) {
125 ci.registerClass(env.getThreadInfo());
128 return ci.getClassObjectRef();
131 // TODO: Fix for Groovy's model-checking
132 // TODO: Load the SystemClassLoader if this ClassLoader fails, but just get it if it is already defined!
133 // TODO: This is needed for sun.reflect.GroovyMagic and some other classes
135 public int defineClass0__Ljava_lang_String_2_3BII__Ljava_lang_Class_2
136 (MJIEnv env, int objRef, int nameRef, int bufferRef, int offset, int length) {
137 String cname = env.getStringObject(nameRef);
138 ClassLoaderInfo cl = env.getClassLoaderInfo(objRef);
140 // determine whether that the corresponding class is already defined by this
141 // classloader, if so, just return the already defined class!
142 if (cl.getDefinedClassInfo(cname) != null) { // attempt to define twice
143 return cl.getDefinedClassInfo(cname).getClassObjectRef();
146 byte[] buffer = env.getByteArrayObject(bufferRef);
149 ClassInfo ci = cl.getResolvedClassInfo( cname, buffer, offset, length);
151 // Note: if the representation is not of a supported major or minor version, loading
152 // throws an UnsupportedClassVersionError. But for now, we do not check for this here
153 // since we don't do much with minor and major versions
155 ThreadInfo ti = env.getThreadInfo();
156 ci.registerClass(ti);
158 return ci.getClassObjectRef();
160 } catch (LoadOnJPFRequired rre) {
161 return searchThroughSystemClassLoader(env, objRef, nameRef, bufferRef, offset, length);
163 } catch (ClassInfoException cix){
164 if (cix.getExceptionClass().equals("java.lang.ClassNotFoundException")) {
165 return searchThroughSystemClassLoader(env, objRef, nameRef, bufferRef, offset, length);
167 env.throwException("java.lang.ClassFormatError");
173 private int searchThroughSystemClassLoader
174 (MJIEnv env, int objRef, int nameRef, int bufferRef, int offset, int length) {
176 int sysObjRef = env.getSystemClassLoaderInfo().getClassLoaderObjectRef();
177 if (objRef != sysObjRef) {
178 return defineClass0__Ljava_lang_String_2_3BII__Ljava_lang_Class_2
179 (env, sysObjRef, nameRef, bufferRef, offset, length);
181 env.throwException("java.lang.ClassNotFoundException");
186 protected static boolean check(MJIEnv env, String cname, byte[] buffer, int offset, int length) {
187 // throw SecurityExcpetion if the package prefix is java
188 checkForProhibitedPkg(env, cname);
190 // throw NoClassDefFoundError if the given class does name might
191 // not be a valid binary name
192 checkForIllegalName(env, cname);
194 // throw IndexOutOfBoundsException if buffer length is not consistent
196 checkData(env, buffer, offset, length);
198 return !env.hasException();
201 protected static void checkForProhibitedPkg(MJIEnv env, String name) {
202 if(name != null && name.startsWith("java.")) {
203 env.throwException("java.lang.SecurityException", "Prohibited package name: " + name);
207 protected static void checkForIllegalName(MJIEnv env, String name) {
208 if((name == null) || (name.length() == 0)) {
212 if((name.indexOf('/') != -1) || (name.charAt(0) == '[')) {
213 env.throwException("java.lang.NoClassDefFoundError", "IllegalName: " + name);
217 protected static void checkData(MJIEnv env, byte[] buffer, int offset, int length) {
218 if(offset<0 || length<0 || offset+length > buffer.length) {
219 env.throwException("java.lang.IndexOutOfBoundsException");
223 static String pkg_class_name = "java.lang.Package";
226 public int getPackages_____3Ljava_lang_Package_2 (MJIEnv env, int objRef) {
227 ClassLoaderInfo sysLoader = ClassLoaderInfo.getCurrentSystemClassLoader();
228 ClassInfo pkgClass = null;
230 pkgClass = sysLoader.getInitializedClassInfo(pkg_class_name, env.getThreadInfo());
231 } catch (ClinitRequired x){
232 env.handleClinitRequest(x.getRequiredClassInfo());
236 ClassLoaderInfo cl = env.getClassLoaderInfo(objRef);
237 // Returns all of the Packages defined by this class loader and its ancestors
238 Map<String, ClassLoaderInfo> pkgs = cl.getPackages();
239 int size = pkgs.size();
240 // create an array of type java.lang.Package
241 int pkgArr = env.newObjectArray(pkg_class_name, size);
244 for(String name: cl.getPackages().keySet()) {
245 int pkgRef = createPackageObject(env, pkgClass, name, cl);
246 // place the object into the array
247 env.setReferenceArrayElement(pkgArr, i++, pkgRef);
254 public int getPackage__Ljava_lang_String_2__Ljava_lang_Package_2 (MJIEnv env, int objRef, int nameRef) {
255 ClassLoaderInfo sysLoader = ClassLoaderInfo.getCurrentSystemClassLoader();
257 ClassInfo pkgClass = null;
259 pkgClass = sysLoader.getInitializedClassInfo(pkg_class_name, env.getThreadInfo());
260 } catch (ClinitRequired x){
261 env.handleClinitRequest(x.getRequiredClassInfo());
265 ClassLoaderInfo cl = env.getClassLoaderInfo(objRef);
266 String pkgName = env.getStringObject(nameRef);
267 if(cl.getPackages().get(pkgName)!=null) {
268 return createPackageObject(env, pkgClass, pkgName, cl);
274 public static int createPackageObject(MJIEnv env, ClassInfo pkgClass, String pkgName, ClassLoaderInfo cl) {
275 int pkgRef = env.newObject(pkgClass);
276 ElementInfo ei = env.getModifiableElementInfo(pkgRef);
278 ei.setReferenceField("pkgName", env.newString(pkgName));
279 ei.setReferenceField("loader", cl.getClassLoaderObjectRef());
280 // the rest of the fields set to some dummy value
281 ei.setReferenceField("specTitle", env.newString("spectitle"));
282 ei.setReferenceField("specVersion", env.newString("specversion"));
283 ei.setReferenceField("specVendor", env.newString("specvendor"));
284 ei.setReferenceField("implTitle", env.newString("impltitle"));
285 ei.setReferenceField("implVersion", env.newString("implversion"));
286 ei.setReferenceField("sealBase", MJIEnv.NULL);
292 public void setDefaultAssertionStatus__Z__V (MJIEnv env, int objRef, boolean enabled) {
293 ClassLoaderInfo cl = env.getClassLoaderInfo(objRef);
294 cl.setDefaultAssertionStatus(enabled);
298 public void setPackageAssertionStatus__Ljava_lang_String_2Z__V (MJIEnv env, int objRef, int strRef, boolean enabled) {
299 ClassLoaderInfo cl = env.getClassLoaderInfo(objRef);
300 String pkgName = env.getStringObject(strRef);
301 cl.setPackageAssertionStatus(pkgName, enabled);
305 public void setClassAssertionStatus__Ljava_lang_String_2Z__V (MJIEnv env, int objRef, int strRef, boolean enabled) {
306 ClassLoaderInfo cl = env.getClassLoaderInfo(objRef);
307 String clsName = env.getStringObject(strRef);
308 cl.setClassAssertionStatus(clsName, enabled);
312 public void clearAssertionStatus____V (MJIEnv env, int objRef) {
313 ClassLoaderInfo cl = env.getClassLoaderInfo(objRef);
314 cl.clearAssertionStatus();