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                    class_paths.push(JavaLangString::from_rust_string(jvm, path).await?);
120
121                    let path = JavaLangString::from_rust_string(jvm, &format!("file:{path}")).await?;
122                    let url = jvm.new_class("java/net/URL", "(Ljava/lang/String;)V", (path,)).await?;
123                    urls.push(url);
124                }
125
126                (class_paths, urls)
127            } else {
128                (Vec::new(), Vec::new())
129            };
130
131            let mut class_path_array = jvm.instantiate_array("Ljava/lang/String;", class_paths.len()).await?;
132            jvm.store_array(&mut class_path_array, 0, class_paths).await?;
133            let rustjar_class_loader = jvm
134                .new_class(
135                    "org/rustjava/lang/RustJarClassLoader",
136                    "([Ljava/lang/String;Ljava/lang/ClassLoader;)V",
137                    (class_path_array, None),
138                )
139                .await?;
140
141            let mut url_array = jvm.instantiate_array("Ljava/net/URL;", urls.len()).await?;
142            jvm.store_array(&mut url_array, 0, urls).await?;
143
144            let url_class_loader = jvm
145                .new_class(
146                    "java/net/URLClassLoader",
147                    "([Ljava/net/URL;Ljava/lang/ClassLoader;)V",
148                    (url_array, rustjar_class_loader),
149                )
150                .await?;
151
152            let class_loader_type: ClassInstanceRef<String> = jvm
153                .invoke_static(
154                    "java/lang/System",
155                    "getProperty",
156                    "(Ljava/lang/String;)Ljava/lang/String;",
157                    (JavaLangString::from_rust_string(jvm, "java.system.class.loader").await?,),
158                )
159                .await?;
160
161            let system_class_loader = if !class_loader_type.is_null() {
162                let class_loader_type_str = JavaLangString::to_rust_string(jvm, &class_loader_type).await?;
163                jvm.new_class(&class_loader_type_str, "(Ljava/lang/ClassLoader;)V", (url_class_loader,))
164                    .await?
165            } else {
166                url_class_loader
167            };
168
169            jvm.put_static_field(
170                "java/lang/ClassLoader",
171                "systemClassLoader",
172                "Ljava/lang/ClassLoader;",
173                system_class_loader.clone(),
174            )
175            .await?;
176
177            return Ok(system_class_loader.into());
178        }
179
180        Ok(system_class_loader)
181    }
182
183    async fn load_class(
184        jvm: &Jvm,
185        runtime: &mut RuntimeContext,
186        this: ClassInstanceRef<Self>,
187        name: ClassInstanceRef<String>,
188    ) -> Result<ClassInstanceRef<Class>> {
189        tracing::debug!("java.lang.ClassLoader::loadClass({this:?}, {name:?})");
190
191        let class: ClassInstanceRef<Class> = jvm
192            .invoke_virtual(
193                &this,
194                "java/lang/ClassLoader",
195                "findLoadedClass",
196                "(Ljava/lang/String;)Ljava/lang/Class;",
197                (name.clone(),),
198            )
199            .await?;
200
201        if !class.is_null() {
202            return Ok(class);
203        }
204
205        let name_str = JavaLangString::to_rust_string(jvm, &name).await?;
206        let internal_name = name_str.replace('.', "/");
207
208        if let Some(element_type_name) = internal_name.strip_prefix('[') {
209            let ultimate_element_type = name_str.trim_start_matches('[');
210            let defining_loader = if let Some(element_class_name) = ultimate_element_type.strip_prefix('L').and_then(|name| name.strip_suffix(';')) {
211                let element_class_name = JavaLangString::from_rust_string(jvm, element_class_name).await?;
212                let element_class: ClassInstanceRef<Class> = jvm
213                    .invoke_virtual(
214                        &this,
215                        "java/lang/ClassLoader",
216                        "loadClass",
217                        "(Ljava/lang/String;)Ljava/lang/Class;",
218                        (element_class_name,),
219                    )
220                    .await?;
221                jvm.get_field(&element_class, "java/lang/Class", "classLoader", "Ljava/lang/ClassLoader;")
222                    .await?
223            } else {
224                None
225            };
226
227            let class = runtime.define_array_class(jvm, element_type_name).await?;
228            let java_class = jvm.register_class(class, defining_loader).await?;
229
230            return Ok(java_class.into());
231        }
232
233        let parent: ClassInstanceRef<Self> = jvm.get_field(&this, "java/lang/ClassLoader", "parent", "Ljava/lang/ClassLoader;").await?;
234        let class: ClassInstanceRef<Class> = if !parent.is_null() {
235            jvm.invoke_virtual(
236                &parent,
237                "java/lang/ClassLoader",
238                "loadClass",
239                "(Ljava/lang/String;)Ljava/lang/Class;",
240                (name.clone(),),
241            )
242            .await?
243        } else {
244            jvm.load_bootstrap_class(&internal_name).await?.into()
245        };
246
247        if !class.is_null() {
248            return Ok(class);
249        }
250
251        let class = jvm
252            .invoke_virtual(
253                &this,
254                "java/lang/ClassLoader",
255                "findClass",
256                "(Ljava/lang/String;)Ljava/lang/Class;",
257                (name,),
258            )
259            .await?;
260
261        Ok(class)
262    }
263
264    async fn find_class(
265        jvm: &Jvm,
266        _: &mut RuntimeContext,
267        this: ClassInstanceRef<Self>,
268        name: ClassInstanceRef<String>,
269    ) -> Result<ClassInstanceRef<Class>> {
270        tracing::debug!("java.lang.ClassLoader::findClass({this:?}, {name:?})");
271
272        Err(jvm.exception("java/lang/ClassNotFoundException", "class not found").await)
273    }
274
275    async fn find_loaded_class(
276        jvm: &Jvm,
277        _: &mut RuntimeContext,
278        this: ClassInstanceRef<Self>,
279        name: ClassInstanceRef<String>,
280    ) -> Result<ClassInstanceRef<Class>> {
281        tracing::debug!("java.lang.ClassLoader::findLoadedClass({this:?}, {name:?})");
282
283        let internal_name = JavaLangString::to_rust_string(jvm, &name).await?.replace('.', "/");
284        if !jvm.has_class(&internal_name) {
285            return Ok(None.into());
286        }
287
288        let class = jvm.resolve_class(&internal_name).await?;
289
290        Ok(class.java_class().into())
291    }
292
293    async fn get_resource(
294        jvm: &Jvm,
295        _: &mut RuntimeContext,
296        this: ClassInstanceRef<Self>,
297        name: ClassInstanceRef<String>,
298    ) -> Result<ClassInstanceRef<URL>> {
299        tracing::debug!("java.lang.ClassLoader::getResource({this:?})");
300
301        let parent: ClassInstanceRef<Self> = jvm.get_field(&this, "java/lang/ClassLoader", "parent", "Ljava/lang/ClassLoader;").await?;
302
303        let result: ClassInstanceRef<URL> = if !parent.is_null() {
304            jvm.invoke_virtual(
305                &parent,
306                "java/lang/ClassLoader",
307                "getResource",
308                "(Ljava/lang/String;)Ljava/net/URL;",
309                (name.clone(),),
310            )
311            .await?
312        } else {
313            None.into()
314        };
315
316        if !result.is_null() {
317            return Ok(result);
318        }
319
320        let result = jvm
321            .invoke_virtual(
322                &this,
323                "java/lang/ClassLoader",
324                "findResource",
325                "(Ljava/lang/String;)Ljava/net/URL;",
326                (name,),
327            )
328            .await?;
329
330        Ok(result)
331    }
332
333    async fn get_resource_as_stream(
334        jvm: &Jvm,
335        _: &mut RuntimeContext,
336        this: ClassInstanceRef<Self>,
337        name: ClassInstanceRef<String>,
338    ) -> Result<ClassInstanceRef<URL>> {
339        tracing::debug!("java.lang.ClassLoader::getResourceAsStream({this:?})");
340
341        let resource_url: ClassInstanceRef<URL> = jvm
342            .invoke_virtual(
343                &this,
344                "java/lang/ClassLoader",
345                "getResource",
346                "(Ljava/lang/String;)Ljava/net/URL;",
347                (name.clone(),),
348            )
349            .await?;
350
351        if resource_url.is_null() {
352            return Ok(None.into());
353        }
354
355        let stream = jvm
356            .invoke_virtual(&resource_url, "java/net/URL", "openStream", "()Ljava/io/InputStream;", ())
357            .await?;
358
359        Ok(stream)
360    }
361
362    async fn find_resource(
363        _: &Jvm,
364        _: &mut RuntimeContext,
365        this: ClassInstanceRef<Self>,
366        _: ClassInstanceRef<String>,
367    ) -> Result<ClassInstanceRef<URL>> {
368        tracing::debug!("java.lang.ClassLoader::findResource({this:?})");
369
370        Ok(None.into())
371    }
372
373    async fn define_class(
374        jvm: &Jvm,
375        runtime: &mut RuntimeContext,
376        this: ClassInstanceRef<Self>,
377        name: ClassInstanceRef<String>,
378        bytes: ClassInstanceRef<Array<i8>>,
379        offset: i32,
380        length: i32,
381    ) -> Result<ClassInstanceRef<Class>> {
382        tracing::debug!("java.lang.ClassLoader::defineClass({this:?}, {name:?}, {bytes:?}, {offset:?}, {length:?})");
383
384        if bytes.is_null() {
385            return Err(jvm.exception("java/lang/NullPointerException", "class bytes").await);
386        }
387        let array_length = jvm.array_length(&bytes).await?;
388        if offset < 0 || length < 0 || (offset as usize).checked_add(length as usize).is_none_or(|end| end > array_length) {
389            return Err(jvm.exception("java/lang/IndexOutOfBoundsException", "invalid class byte range").await);
390        }
391
392        let mut data = vec![0; length as usize];
393        jvm.array_raw_buffer(&bytes).await?.read(offset as _, &mut data)?;
394
395        let class = runtime.define_class(jvm, &data).await?;
396        let java_class = jvm.register_class(class, Some(this.into())).await?;
397
398        Ok(java_class.into())
399    }
400}