Skip to main content

rustjava_runtime/classes/java/lang/
class_loader.rs

1use alloc::{format, vec, vec::Vec};
2
3use jvm::{Array, ClassInstanceRef, Jvm, Result, runtime::JavaLangString};
4use jvm_class_proto::{JavaFieldProto, JavaMethodProto};
5use jvm_types::{ClassAccessFlags, FieldAccessFlags, MethodAccessFlags};
6
7use crate::{
8    RuntimeClassProto, RuntimeContext,
9    classes::java::{
10        lang::{Class, String},
11        net::URL,
12    },
13};
14
15// class java.lang.ClassLoader
16pub struct ClassLoader;
17
18impl ClassLoader {
19    pub fn as_proto() -> RuntimeClassProto {
20        RuntimeClassProto {
21            name: "java/lang/ClassLoader",
22            parent_class: Some("java/lang/Object"),
23            interfaces: vec![],
24            methods: vec![
25                JavaMethodProto::new("<init>", "(Ljava/lang/ClassLoader;)V", Self::init, MethodAccessFlags::PROTECTED),
26                JavaMethodProto::new(
27                    "loadClass",
28                    "(Ljava/lang/String;)Ljava/lang/Class;",
29                    Self::load_class,
30                    MethodAccessFlags::PUBLIC,
31                ),
32                JavaMethodProto::new(
33                    "findClass",
34                    "(Ljava/lang/String;)Ljava/lang/Class;",
35                    Self::find_class,
36                    MethodAccessFlags::PROTECTED,
37                ),
38                JavaMethodProto::new(
39                    "findLoadedClass",
40                    "(Ljava/lang/String;)Ljava/lang/Class;",
41                    Self::find_loaded_class,
42                    MethodAccessFlags::PROTECTED | MethodAccessFlags::FINAL,
43                ),
44                JavaMethodProto::new(
45                    "getSystemClassLoader",
46                    "()Ljava/lang/ClassLoader;",
47                    Self::get_system_class_loader,
48                    MethodAccessFlags::PUBLIC | MethodAccessFlags::STATIC,
49                ),
50                JavaMethodProto::new(
51                    "getResource",
52                    "(Ljava/lang/String;)Ljava/net/URL;",
53                    Self::get_resource,
54                    MethodAccessFlags::PUBLIC,
55                ),
56                JavaMethodProto::new(
57                    "getResourceAsStream",
58                    "(Ljava/lang/String;)Ljava/io/InputStream;",
59                    Self::get_resource_as_stream,
60                    MethodAccessFlags::PUBLIC,
61                ),
62                JavaMethodProto::new(
63                    "findResource",
64                    "(Ljava/lang/String;)Ljava/net/URL;",
65                    Self::find_resource,
66                    MethodAccessFlags::PROTECTED,
67                ),
68                JavaMethodProto::new(
69                    "defineClass",
70                    "(Ljava/lang/String;[BII)Ljava/lang/Class;",
71                    Self::define_class,
72                    MethodAccessFlags::PROTECTED | MethodAccessFlags::FINAL,
73                ),
74            ],
75            fields: vec![
76                JavaFieldProto::new("systemClassLoader", "Ljava/lang/ClassLoader;", FieldAccessFlags::STATIC),
77                JavaFieldProto::new("parent", "Ljava/lang/ClassLoader;", FieldAccessFlags::PRIVATE | FieldAccessFlags::FINAL),
78            ],
79            access_flags: ClassAccessFlags::PUBLIC | ClassAccessFlags::ABSTRACT,
80        }
81    }
82
83    async fn init(jvm: &Jvm, _: &mut RuntimeContext, mut this: ClassInstanceRef<Self>, parent: ClassInstanceRef<Self>) -> Result<()> {
84        tracing::debug!("java.lang.ClassLoader::<init>({this:?}, {parent:?})");
85
86        let _: () = jvm.invoke_special(&this, "java/lang/Object", "<init>", "()V", ()).await?;
87
88        jvm.put_field(&mut this, "java/lang/ClassLoader", "parent", "Ljava/lang/ClassLoader;", parent)
89            .await?;
90
91        Ok(())
92    }
93
94    async fn get_system_class_loader(jvm: &Jvm, _: &mut RuntimeContext) -> Result<ClassInstanceRef<Self>> {
95        tracing::debug!("java.lang.ClassLoader::getSystemClassLoader()");
96
97        let system_class_loader: ClassInstanceRef<Self> = jvm
98            .get_static_field("java/lang/ClassLoader", "systemClassLoader", "Ljava/lang/ClassLoader;")
99            .await?;
100
101        if system_class_loader.is_null() {
102            let class_path: ClassInstanceRef<String> = jvm
103                .invoke_static(
104                    "java/lang/System",
105                    "getProperty",
106                    "(Ljava/lang/String;)Ljava/lang/String;",
107                    (JavaLangString::from_rust_string(jvm, "java.class.path").await?,),
108                )
109                .await?;
110
111            let (class_paths, urls) = if !class_path.is_null() {
112                let class_path = JavaLangString::to_rust_string(jvm, &class_path).await?;
113                let path_separator: ClassInstanceRef<String> = jvm.get_static_field("java/io/File", "pathSeparator", "Ljava/lang/String;").await?;
114                let path_separator = JavaLangString::to_rust_string(jvm, &path_separator).await?;
115
116                let mut class_paths = Vec::new();
117                let mut urls = Vec::new();
118                for path in class_path.split(path_separator.as_str()) {
119                    let path = JavaLangString::from_rust_string(jvm, path).await?;
120                    class_paths.push(path.clone());
121                    let path = jvm
122                        .invoke_static("org/rustjava/net/URLPath", "encode", "(Ljava/lang/String;)Ljava/lang/String;", (path,))
123                        .await?;
124                    let path = JavaLangString::to_rust_string(jvm, &path).await?;
125                    let path = JavaLangString::from_rust_string(jvm, &format!("file:{path}")).await?;
126                    let url = jvm.new_class("java/net/URL", "(Ljava/lang/String;)V", (path,)).await?;
127                    urls.push(url);
128                }
129
130                (class_paths, urls)
131            } else {
132                (Vec::new(), Vec::new())
133            };
134
135            let mut class_path_array = jvm.instantiate_array("Ljava/lang/String;", class_paths.len()).await?;
136            jvm.store_array(&mut class_path_array, 0, class_paths).await?;
137            let rustjar_class_loader = jvm
138                .new_class(
139                    "org/rustjava/lang/RustJarClassLoader",
140                    "([Ljava/lang/String;Ljava/lang/ClassLoader;)V",
141                    (class_path_array, None),
142                )
143                .await?;
144
145            let mut url_array = jvm.instantiate_array("Ljava/net/URL;", urls.len()).await?;
146            jvm.store_array(&mut url_array, 0, urls).await?;
147
148            let url_class_loader = jvm
149                .new_class(
150                    "java/net/URLClassLoader",
151                    "([Ljava/net/URL;Ljava/lang/ClassLoader;)V",
152                    (url_array, rustjar_class_loader),
153                )
154                .await?;
155
156            let class_loader_type: ClassInstanceRef<String> = jvm
157                .invoke_static(
158                    "java/lang/System",
159                    "getProperty",
160                    "(Ljava/lang/String;)Ljava/lang/String;",
161                    (JavaLangString::from_rust_string(jvm, "java.system.class.loader").await?,),
162                )
163                .await?;
164
165            let system_class_loader = if !class_loader_type.is_null() {
166                let class_loader_type_str = JavaLangString::to_rust_string(jvm, &class_loader_type).await?;
167                jvm.new_class(&class_loader_type_str, "(Ljava/lang/ClassLoader;)V", (url_class_loader,))
168                    .await?
169            } else {
170                url_class_loader
171            };
172
173            jvm.put_static_field(
174                "java/lang/ClassLoader",
175                "systemClassLoader",
176                "Ljava/lang/ClassLoader;",
177                system_class_loader.clone(),
178            )
179            .await?;
180
181            return Ok(system_class_loader.into());
182        }
183
184        Ok(system_class_loader)
185    }
186
187    async fn load_class(
188        jvm: &Jvm,
189        runtime: &mut RuntimeContext,
190        this: ClassInstanceRef<Self>,
191        name: ClassInstanceRef<String>,
192    ) -> Result<ClassInstanceRef<Class>> {
193        tracing::debug!("java.lang.ClassLoader::loadClass({this:?}, {name:?})");
194
195        let class: ClassInstanceRef<Class> = jvm
196            .invoke_virtual(
197                &this,
198                "java/lang/ClassLoader",
199                "findLoadedClass",
200                "(Ljava/lang/String;)Ljava/lang/Class;",
201                (name.clone(),),
202            )
203            .await?;
204
205        if !class.is_null() {
206            return Ok(class);
207        }
208
209        let name_str = JavaLangString::to_rust_string(jvm, &name).await?;
210        let internal_name = name_str.replace('.', "/");
211
212        if let Some(element_type_name) = internal_name.strip_prefix('[') {
213            let ultimate_element_type = name_str.trim_start_matches('[');
214            let defining_loader = if let Some(element_class_name) = ultimate_element_type.strip_prefix('L').and_then(|name| name.strip_suffix(';')) {
215                let element_class_name = JavaLangString::from_rust_string(jvm, element_class_name).await?;
216                let element_class: ClassInstanceRef<Class> = jvm
217                    .invoke_virtual(
218                        &this,
219                        "java/lang/ClassLoader",
220                        "loadClass",
221                        "(Ljava/lang/String;)Ljava/lang/Class;",
222                        (element_class_name,),
223                    )
224                    .await?;
225                jvm.get_field(&element_class, "java/lang/Class", "classLoader", "Ljava/lang/ClassLoader;")
226                    .await?
227            } else {
228                None
229            };
230
231            let class = runtime.define_array_class(jvm, element_type_name).await?;
232            let java_class = jvm.register_class(class, defining_loader).await?;
233
234            return Ok(java_class.into());
235        }
236
237        let parent: ClassInstanceRef<Self> = jvm.get_field(&this, "java/lang/ClassLoader", "parent", "Ljava/lang/ClassLoader;").await?;
238        let class: ClassInstanceRef<Class> = if !parent.is_null() {
239            jvm.invoke_virtual(
240                &parent,
241                "java/lang/ClassLoader",
242                "loadClass",
243                "(Ljava/lang/String;)Ljava/lang/Class;",
244                (name.clone(),),
245            )
246            .await?
247        } else {
248            jvm.load_bootstrap_class(&internal_name).await?.into()
249        };
250
251        if !class.is_null() {
252            return Ok(class);
253        }
254
255        let class = jvm
256            .invoke_virtual(
257                &this,
258                "java/lang/ClassLoader",
259                "findClass",
260                "(Ljava/lang/String;)Ljava/lang/Class;",
261                (name,),
262            )
263            .await?;
264
265        Ok(class)
266    }
267
268    async fn find_class(
269        jvm: &Jvm,
270        _: &mut RuntimeContext,
271        this: ClassInstanceRef<Self>,
272        name: ClassInstanceRef<String>,
273    ) -> Result<ClassInstanceRef<Class>> {
274        tracing::debug!("java.lang.ClassLoader::findClass({this:?}, {name:?})");
275
276        Err(jvm.exception("java/lang/ClassNotFoundException", "class not found").await)
277    }
278
279    async fn find_loaded_class(
280        jvm: &Jvm,
281        _: &mut RuntimeContext,
282        this: ClassInstanceRef<Self>,
283        name: ClassInstanceRef<String>,
284    ) -> Result<ClassInstanceRef<Class>> {
285        tracing::debug!("java.lang.ClassLoader::findLoadedClass({this:?}, {name:?})");
286
287        let internal_name = JavaLangString::to_rust_string(jvm, &name).await?.replace('.', "/");
288        if !jvm.has_class(&internal_name) {
289            return Ok(None.into());
290        }
291
292        let class = jvm.resolve_class(&internal_name).await?;
293
294        Ok(class.java_class().into())
295    }
296
297    async fn get_resource(
298        jvm: &Jvm,
299        _: &mut RuntimeContext,
300        this: ClassInstanceRef<Self>,
301        name: ClassInstanceRef<String>,
302    ) -> Result<ClassInstanceRef<URL>> {
303        tracing::debug!("java.lang.ClassLoader::getResource({this:?})");
304
305        let parent: ClassInstanceRef<Self> = jvm.get_field(&this, "java/lang/ClassLoader", "parent", "Ljava/lang/ClassLoader;").await?;
306
307        let result: ClassInstanceRef<URL> = if !parent.is_null() {
308            jvm.invoke_virtual(
309                &parent,
310                "java/lang/ClassLoader",
311                "getResource",
312                "(Ljava/lang/String;)Ljava/net/URL;",
313                (name.clone(),),
314            )
315            .await?
316        } else {
317            None.into()
318        };
319
320        if !result.is_null() {
321            return Ok(result);
322        }
323
324        let result = jvm
325            .invoke_virtual(
326                &this,
327                "java/lang/ClassLoader",
328                "findResource",
329                "(Ljava/lang/String;)Ljava/net/URL;",
330                (name,),
331            )
332            .await?;
333
334        Ok(result)
335    }
336
337    async fn get_resource_as_stream(
338        jvm: &Jvm,
339        _: &mut RuntimeContext,
340        this: ClassInstanceRef<Self>,
341        name: ClassInstanceRef<String>,
342    ) -> Result<ClassInstanceRef<URL>> {
343        tracing::debug!("java.lang.ClassLoader::getResourceAsStream({this:?})");
344
345        let resource_url: ClassInstanceRef<URL> = jvm
346            .invoke_virtual(
347                &this,
348                "java/lang/ClassLoader",
349                "getResource",
350                "(Ljava/lang/String;)Ljava/net/URL;",
351                (name.clone(),),
352            )
353            .await?;
354
355        if resource_url.is_null() {
356            return Ok(None.into());
357        }
358
359        let stream = jvm
360            .invoke_virtual(&resource_url, "java/net/URL", "openStream", "()Ljava/io/InputStream;", ())
361            .await?;
362
363        Ok(stream)
364    }
365
366    async fn find_resource(
367        _: &Jvm,
368        _: &mut RuntimeContext,
369        this: ClassInstanceRef<Self>,
370        _: ClassInstanceRef<String>,
371    ) -> Result<ClassInstanceRef<URL>> {
372        tracing::debug!("java.lang.ClassLoader::findResource({this:?})");
373
374        Ok(None.into())
375    }
376
377    async fn define_class(
378        jvm: &Jvm,
379        runtime: &mut RuntimeContext,
380        this: ClassInstanceRef<Self>,
381        name: ClassInstanceRef<String>,
382        bytes: ClassInstanceRef<Array<i8>>,
383        offset: i32,
384        length: i32,
385    ) -> Result<ClassInstanceRef<Class>> {
386        tracing::debug!("java.lang.ClassLoader::defineClass({this:?}, {name:?}, {bytes:?}, {offset:?}, {length:?})");
387
388        if bytes.is_null() {
389            return Err(jvm.exception("java/lang/NullPointerException", "class bytes").await);
390        }
391        let array_length = jvm.array_length(&bytes).await?;
392        if offset < 0 || length < 0 || (offset as usize).checked_add(length as usize).is_none_or(|end| end > array_length) {
393            return Err(jvm.exception("java/lang/IndexOutOfBoundsException", "invalid class byte range").await);
394        }
395
396        let mut data = vec![0; length as usize];
397        jvm.array_raw_buffer(&bytes).await?.read(offset as _, &mut data)?;
398
399        let class = runtime.define_class(jvm, &data).await?;
400        let java_class = jvm.register_class(class, Some(this.into())).await?;
401
402        Ok(java_class.into())
403    }
404}