ristretto_vm 0.20.0

Java Virtual Machine
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
use crate::Error::InternalError;
use crate::{Result, VM};
use ristretto_classfile::{Version, mutf8};
use ristretto_classloader::{Class, ConcurrentVec, Object, Reference, Value};
use std::sync::Arc;

const JAVA_8: Version = Version::Java8 { minor: 0 };
const JAVA_17: Version = Version::Java17 { minor: 0 };

/// Trait for converting a Rust value to a Java object.  Converts to objects of the primitive
/// wrapper, classes, and strings.
pub trait JavaObject {
    #[expect(async_fn_in_trait)]
    async fn to_object(&self, vm: &VM) -> Result<Value>;
}

impl JavaObject for bool {
    async fn to_object(&self, vm: &VM) -> Result<Value> {
        let value = Value::from(*self);
        let result = vm
            .try_invoke(
                "java.lang.Boolean",
                "valueOf",
                "(Z)Ljava/lang/Boolean;",
                vec![value],
            )
            .await?;
        Ok(result)
    }
}

impl JavaObject for char {
    async fn to_object(&self, vm: &VM) -> Result<Value> {
        let value = Value::from(*self);
        let result = vm
            .try_invoke(
                "java.lang.Character",
                "valueOf",
                "(C)Ljava/lang/Character;",
                vec![value],
            )
            .await?;
        Ok(result)
    }
}

impl JavaObject for i8 {
    async fn to_object(&self, vm: &VM) -> Result<Value> {
        let value = Value::from(*self);
        let result = vm
            .try_invoke(
                "java.lang.Byte",
                "valueOf",
                "(B)Ljava/lang/Byte;",
                vec![value],
            )
            .await?;
        Ok(result)
    }
}

impl JavaObject for u8 {
    async fn to_object(&self, vm: &VM) -> Result<Value> {
        #[expect(clippy::cast_possible_wrap)]
        let value = *self as i8;
        value.to_object(vm).await
    }
}

impl JavaObject for i16 {
    async fn to_object(&self, vm: &VM) -> Result<Value> {
        let value = Value::from(*self);
        let result = vm
            .try_invoke(
                "java.lang.Short",
                "valueOf",
                "(S)Ljava/lang/Short;",
                vec![value],
            )
            .await?;
        Ok(result)
    }
}

impl JavaObject for u16 {
    async fn to_object(&self, vm: &VM) -> Result<Value> {
        #[expect(clippy::cast_possible_wrap)]
        let value = *self as i16;
        value.to_object(vm).await
    }
}

impl JavaObject for i32 {
    async fn to_object(&self, vm: &VM) -> Result<Value> {
        let value = Value::from(*self);
        let result = vm
            .try_invoke(
                "java.lang.Integer",
                "valueOf",
                "(I)Ljava/lang/Integer;",
                vec![value],
            )
            .await?;
        Ok(result)
    }
}

impl JavaObject for u32 {
    async fn to_object(&self, vm: &VM) -> Result<Value> {
        #[expect(clippy::cast_possible_wrap)]
        let value = *self as i32;
        value.to_object(vm).await
    }
}

impl JavaObject for i64 {
    async fn to_object(&self, vm: &VM) -> Result<Value> {
        let value = Value::from(*self);
        let result = vm
            .try_invoke(
                "java.lang.Long",
                "valueOf",
                "(J)Ljava/lang/Long;",
                vec![value],
            )
            .await?;
        Ok(result)
    }
}

impl JavaObject for u64 {
    async fn to_object(&self, vm: &VM) -> Result<Value> {
        #[expect(clippy::cast_possible_wrap)]
        let value = *self as i64;
        value.to_object(vm).await
    }
}

impl JavaObject for isize {
    async fn to_object(&self, vm: &VM) -> Result<Value> {
        let value = *self as i64;
        value.to_object(vm).await
    }
}

impl JavaObject for usize {
    async fn to_object(&self, vm: &VM) -> Result<Value> {
        let value = *self as u64;
        value.to_object(vm).await
    }
}

impl JavaObject for f32 {
    async fn to_object(&self, vm: &VM) -> Result<Value> {
        let value = Value::from(*self);
        let result = vm
            .try_invoke(
                "java.lang.Float",
                "valueOf",
                "(F)Ljava/lang/Float;",
                vec![value],
            )
            .await?;
        Ok(result)
    }
}

impl JavaObject for f64 {
    async fn to_object(&self, vm: &VM) -> Result<Value> {
        let value = Value::from(*self);
        let result = vm
            .try_invoke(
                "java.lang.Double",
                "valueOf",
                "(D)Ljava/lang/Double;",
                vec![value],
            )
            .await?;
        Ok(result)
    }
}

impl JavaObject for &str {
    async fn to_object(&self, vm: &VM) -> Result<Value> {
        let class = vm.class("java.lang.String").await?;
        let object = Object::new(class)?;

        // The String implementation changed in Java 9.
        // In Java 8 and earlier, the value field is a char array.
        // In Java 9 and later, the value field is a byte array.
        let java_class_file_version = vm.java_class_file_version();
        let array = if java_class_file_version <= &JAVA_8 {
            let chars = self.encode_utf16().collect::<Vec<u16>>();
            Reference::CharArray(ConcurrentVec::from(chars))
        } else {
            if java_class_file_version >= &JAVA_17 {
                object.set_value("hashIsZero", Value::Int(0))?;
            }
            object.set_value("coder", Value::Int(0))?; // LATIN1

            let bytes = mutf8::to_bytes(self)?;
            Reference::from(bytes)
        };

        object.set_value("value", Value::Object(Some(array)))?;
        object.set_value("hash", Value::Int(0))?;

        let value = Value::from(object);
        Ok(value)
    }
}

impl JavaObject for String {
    async fn to_object(&self, vm: &VM) -> Result<Value> {
        let value = self.as_str();
        value.to_object(vm).await
    }
}

async fn to_class_object(vm: &VM, class: &Arc<Class>) -> Result<Value> {
    if let Some(object) = class.object()? {
        return Ok(Value::from(object));
    }

    let java_lang_class = vm.class("java.lang.Class").await?;
    let object = Object::new(java_lang_class)?;
    let class_name = class.name().replace('/', ".");
    let name = class_name.to_object(vm).await?;
    object.set_value("name", name)?;
    // TODO: a "null" class loader indicates a system class loader; this should be re-evaluated
    // to support custom class loaders
    let class_loader_field = object.field("classLoader")?;
    class_loader_field.unsafe_set_value(Value::Object(None))?;
    class.set_object(Some(object.clone()))?;
    let value = Value::from(object);
    Ok(value)
}

impl JavaObject for Arc<Class> {
    async fn to_object(&self, vm: &VM) -> Result<Value> {
        let class_object = to_class_object(vm, self).await?;
        let Value::Object(Some(Reference::Object(ref object))) = class_object else {
            return Err(InternalError("Expected class object".to_string()));
        };

        if *vm.java_class_file_version() > JAVA_8 && self.is_array() {
            let Some(component_type) = self.component_type() else {
                return Err(InternalError(
                    "array class missing component type".to_string(),
                ));
            };
            let component_type_class = vm.class(component_type).await?;
            let component_type_object = to_class_object(vm, &component_type_class).await?;
            object.set_value("componentType", component_type_object)?;
        }

        Ok(class_object)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[tokio::test]
    async fn test_bool_to_object() -> Result<()> {
        let vm = VM::default().await?;
        let original_value = true;
        let value: Value = original_value.to_object(&vm).await?;
        let value: bool = value.try_into()?;
        assert_eq!(original_value, value);
        Ok(())
    }

    #[tokio::test]
    async fn test_char_to_object() -> Result<()> {
        let vm = VM::default().await?;
        let original_value = '*';
        let value: Value = original_value.to_object(&vm).await?;
        let value: char = value.try_into()?;
        assert_eq!(original_value, value);
        Ok(())
    }

    #[tokio::test]
    async fn test_i8_to_object() -> Result<()> {
        let vm = VM::default().await?;
        let original_value = 42i8;
        let value: Value = original_value.to_object(&vm).await?;
        let value: i8 = value.try_into()?;
        assert_eq!(original_value, value);
        Ok(())
    }

    #[tokio::test]
    async fn test_u8_to_object() -> Result<()> {
        let vm = VM::default().await?;
        let original_value = 42u8;
        let value: Value = original_value.to_object(&vm).await?;
        let value: u8 = value.try_into()?;
        assert_eq!(original_value, value);
        Ok(())
    }

    #[tokio::test]
    async fn test_i16_to_object() -> Result<()> {
        let vm = VM::default().await?;
        let original_value = 42i16;
        let value: Value = original_value.to_object(&vm).await?;
        let value: i16 = value.try_into()?;
        assert_eq!(original_value, value);
        Ok(())
    }

    #[tokio::test]
    async fn test_u16_to_object() -> Result<()> {
        let vm = VM::default().await?;
        let original_value = 42u16;
        let value: Value = original_value.to_object(&vm).await?;
        let value: u16 = value.try_into()?;
        assert_eq!(original_value, value);
        Ok(())
    }

    #[tokio::test]
    async fn test_i32_to_object() -> Result<()> {
        let vm = VM::default().await?;
        let original_value = 42i32;
        let value: Value = original_value.to_object(&vm).await?;
        let value: i32 = value.try_into()?;
        assert_eq!(original_value, value);
        Ok(())
    }

    #[tokio::test]
    async fn test_u32_to_object() -> Result<()> {
        let vm = VM::default().await?;
        let original_value = 42u32;
        let value: Value = original_value.to_object(&vm).await?;
        let value: u32 = value.try_into()?;
        assert_eq!(original_value, value);
        Ok(())
    }

    #[tokio::test]
    async fn test_i64_to_object() -> Result<()> {
        let vm = VM::default().await?;
        let original_value = 42i64;
        let value: Value = original_value.to_object(&vm).await?;
        let value: i64 = value.try_into()?;
        assert_eq!(original_value, value);
        Ok(())
    }

    #[tokio::test]
    async fn test_u64_to_object() -> Result<()> {
        let vm = VM::default().await?;
        let original_value = 42u64;
        let value: Value = original_value.to_object(&vm).await?;
        let value: u64 = value.try_into()?;
        assert_eq!(original_value, value);
        Ok(())
    }

    #[tokio::test]
    async fn test_isize_to_object() -> Result<()> {
        let vm = VM::default().await?;
        let original_value = 42isize;
        let value: Value = original_value.to_object(&vm).await?;
        let value: isize = value.try_into()?;
        assert_eq!(original_value, value);
        Ok(())
    }

    #[tokio::test]
    async fn test_usize_to_object() -> Result<()> {
        let vm = VM::default().await?;
        let original_value = 42usize;
        let value: Value = original_value.to_object(&vm).await?;
        let value: usize = value.try_into()?;
        assert_eq!(original_value, value);
        Ok(())
    }

    #[tokio::test]
    async fn test_f32_to_object() -> Result<()> {
        let vm = VM::default().await?;
        let original_value = 42.1f32;
        let value: Value = original_value.to_object(&vm).await?;
        let value: f32 = value.try_into()?;
        let value = value - original_value;
        assert!(value.abs() < 0.1f32);
        Ok(())
    }

    #[tokio::test]
    async fn test_f64_to_object() -> Result<()> {
        let vm = VM::default().await?;
        let original_value = 42.1f64;
        let value: Value = original_value.to_object(&vm).await?;
        let value: f64 = value.try_into()?;
        let value = value - original_value;
        assert!(value.abs() < 0.1f64);
        Ok(())
    }

    #[tokio::test]
    async fn test_str_to_object() -> Result<()> {
        let vm = VM::default().await?;
        let original_value = "foo";
        let value: Value = original_value.to_object(&vm).await?;
        let value: String = value.try_into()?;
        assert_eq!(original_value, value);
        Ok(())
    }

    #[tokio::test]
    async fn test_string_to_object() -> Result<()> {
        let vm = VM::default().await?;
        let original_value = "foo".to_string();
        let value: Value = original_value.to_object(&vm).await?;
        let value: String = value.try_into()?;
        assert_eq!(original_value, value);
        Ok(())
    }

    #[tokio::test]
    async fn test_class_to_object() -> Result<()> {
        let vm = VM::default().await?;
        let original_value = Class::new_named("[I")?;
        let value: Value = original_value.to_object(&vm).await?;
        let value: Arc<Class> = value.try_into()?;
        assert_eq!("java/lang/Class", value.name());
        Ok(())
    }
}