trustformers-mobile 0.1.1

Mobile deployment support for TrustformeRS (iOS, Android)
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
//! JNI Integration for Android Applications
//!
//! This module provides Java Native Interface (JNI) bindings for integrating
//! TrustformeRS with Android applications written in Java/Kotlin.

use crate::MobileConfig;
use trustformers_core::{Tensor};
use trustformers_core::error::{CoreError, Result};

#[cfg(target_os = "android")]
use jni::{
    objects::{JByteArray, JClass, JObject, JString},
    sys::{jboolean, jbyteArray, jlong, jstring},
    JNIEnv, JavaVM,
};

use super::{engine::AndroidInferenceEngine, types::AndroidDeviceInfo};

/// JNI function to create Android inference engine
#[cfg(target_os = "android")]
#[no_mangle]
pub extern "system" fn Java_com_trustformers_TrustformersEngine_createEngine(
    env: JNIEnv,
    _class: JClass,
    config_json: JString,
) -> jlong {
    let config_str: String = match env.get_string(config_json) {
        Ok(s) => s.into(),
        Err(e) => {
            tracing::error!("Failed to get config string: {:?}", e);
            return 0;
        }
    };

    let config: MobileConfig = match serde_json::from_str(&config_str) {
        Ok(c) => c,
        Err(e) => {
            tracing::error!("Failed to parse config JSON: {:?}", e);
            return 0;
        }
    };

    match AndroidInferenceEngine::new(config) {
        Ok(mut engine) => {
            // Get JVM reference for later use
            if let Ok(jvm) = env.get_java_vm() {
                engine.init_jvm(jvm);
            }
            Box::into_raw(Box::new(engine)) as jlong
        }
        Err(e) => {
            tracing::error!("Failed to create inference engine: {:?}", e);
            0
        }
    }
}

/// JNI function to load model
#[cfg(target_os = "android")]
#[no_mangle]
pub extern "system" fn Java_com_trustformers_TrustformersEngine_loadModel(
    env: JNIEnv,
    _class: JClass,
    engine_ptr: jlong,
    model_path: JString,
) -> jboolean {
    if engine_ptr == 0 {
        tracing::error!("Engine pointer is null");
        return false as jboolean;
    }

    let engine = unsafe { &mut *(engine_ptr as *mut AndroidInferenceEngine) };
    let path_str: String = match env.get_string(model_path) {
        Ok(s) => s.into(),
        Err(e) => {
            tracing::error!("Failed to get model path string: {:?}", e);
            return false as jboolean;
        }
    };

    match engine.load_model(&path_str) {
        Ok(_) => {
            tracing::info!("Model loaded successfully: {}", path_str);
            true as jboolean
        }
        Err(e) => {
            tracing::error!("Failed to load model: {:?}", e);
            false as jboolean
        }
    }
}

/// JNI function to perform inference
#[cfg(target_os = "android")]
#[no_mangle]
pub extern "system" fn Java_com_trustformers_TrustformersEngine_inference(
    env: JNIEnv,
    _class: JClass,
    engine_ptr: jlong,
    input_data: jbyteArray,
) -> jbyteArray {
    if engine_ptr == 0 {
        tracing::error!("Engine pointer is null");
        return JObject::null().into_inner();
    }

    let engine = unsafe { &mut *(engine_ptr as *mut AndroidInferenceEngine) };

    // Convert JByteArray to Rust Vec<u8>
    let input_bytes = match env.convert_byte_array(input_data) {
        Ok(bytes) => bytes,
        Err(e) => {
            tracing::error!("Failed to convert input byte array: {:?}", e);
            return JObject::null().into_inner();
        }
    };

    // Convert bytes to tensor (assuming f32 data)
    let input_floats: Vec<f32> = input_bytes
        .chunks(4)
        .map(|chunk| {
            if chunk.len() == 4 {
                let bytes = [chunk[0], chunk[1], chunk[2], chunk[3]];
                f32::from_le_bytes(bytes)
            } else {
                0.0 // Handle incomplete chunks
            }
        })
        .collect();

    let input_tensor = match Tensor::from_vec(input_floats, &[input_bytes.len() / 4]) {
        Ok(t) => t,
        Err(e) => {
            tracing::error!("Failed to create input tensor: {:?}", e);
            return JObject::null().into_inner();
        }
    };

    // Perform inference
    let output_tensor = match engine.inference(&input_tensor) {
        Ok(t) => t,
        Err(e) => {
            tracing::error!("Inference failed: {:?}", e);
            return JObject::null().into_inner();
        }
    };

    // Convert output tensor back to bytes
    let output_data = match output_tensor.as_slice::<f32>() {
        Ok(data) => data,
        Err(e) => {
            tracing::error!("Failed to get output tensor data: {:?}", e);
            return JObject::null().into_inner();
        }
    };

    let output_bytes: Vec<u8> = output_data
        .iter()
        .flat_map(|&f| f.to_le_bytes().to_vec())
        .collect();

    match env.byte_array_from_slice(&output_bytes) {
        Ok(array) => array,
        Err(e) => {
            tracing::error!("Failed to create output byte array: {:?}", e);
            JObject::null().into_inner()
        }
    }
}

/// JNI function to get device information
#[cfg(target_os = "android")]
#[no_mangle]
pub extern "system" fn Java_com_trustformers_TrustformersEngine_getDeviceInfo(
    env: JNIEnv,
    _class: JClass,
) -> jstring {
    let device_info = AndroidDeviceInfo::detect();
    let json = match serde_json::to_string(&device_info) {
        Ok(j) => j,
        Err(e) => {
            tracing::error!("Failed to serialize device info: {:?}", e);
            return JObject::null().into_inner();
        }
    };

    match env.new_string(json) {
        Ok(jstr) => jstr.into_inner(),
        Err(e) => {
            tracing::error!("Failed to create Java string: {:?}", e);
            JObject::null().into_inner()
        }
    }
}

/// JNI function to get inference statistics
#[cfg(target_os = "android")]
#[no_mangle]
pub extern "system" fn Java_com_trustformers_TrustformersEngine_getStats(
    env: JNIEnv,
    _class: JClass,
    engine_ptr: jlong,
) -> jstring {
    if engine_ptr == 0 {
        tracing::error!("Engine pointer is null");
        return JObject::null().into_inner();
    }

    let engine = unsafe { &*(engine_ptr as *const AndroidInferenceEngine) };
    let stats = engine.get_stats();

    let json = match serde_json::to_string(stats) {
        Ok(j) => j,
        Err(e) => {
            tracing::error!("Failed to serialize stats: {:?}", e);
            return JObject::null().into_inner();
        }
    };

    match env.new_string(json) {
        Ok(jstr) => jstr.into_inner(),
        Err(e) => {
            tracing::error!("Failed to create Java string: {:?}", e);
            JObject::null().into_inner()
        }
    }
}

/// JNI function to check hardware capabilities
#[cfg(target_os = "android")]
#[no_mangle]
pub extern "system" fn Java_com_trustformers_TrustformersEngine_checkCapabilities(
    env: JNIEnv,
    _class: JClass,
) -> jstring {
    let device_info = AndroidDeviceInfo::detect();

    let capabilities = serde_json::json!({
        "nnapi_available": device_info.nnapi_info.is_some(),
        "vulkan_supported": device_info.gpu_info.vulkan_supported,
        "opengl_es_version": device_info.gpu_info.opengl_es_version,
        "total_memory_mb": device_info.total_memory_mb,
        "cpu_cores": device_info.cpu_cores,
        "performance_class": device_info.performance_class,
        "is_flagship": device_info.is_flagship_device(),
        "is_ml_capable": device_info.is_ml_capable(),
        "hardware_acceleration": AndroidInferenceEngine::has_hardware_acceleration(),
    });

    let json = match serde_json::to_string(&capabilities) {
        Ok(j) => j,
        Err(e) => {
            tracing::error!("Failed to serialize capabilities: {:?}", e);
            return JObject::null().into_inner();
        }
    };

    match env.new_string(json) {
        Ok(jstr) => jstr.into_inner(),
        Err(e) => {
            tracing::error!("Failed to create Java string: {:?}", e);
            JObject::null().into_inner()
        }
    }
}

/// JNI function to release engine resources
#[cfg(target_os = "android")]
#[no_mangle]
pub extern "system" fn Java_com_trustformers_TrustformersEngine_releaseEngine(
    _env: JNIEnv,
    _class: JClass,
    engine_ptr: jlong,
) {
    if engine_ptr != 0 {
        unsafe {
            let _engine = Box::from_raw(engine_ptr as *mut AndroidInferenceEngine);
            // Engine will be dropped automatically
        }
        tracing::info!("Engine resources released");
    }
}

/// Helper function to create Java exception
#[cfg(target_os = "android")]
fn throw_runtime_exception(env: &JNIEnv, message: &str) {
    if let Err(e) = env.throw_new("java/lang/RuntimeException", message) {
        tracing::error!("Failed to throw Java exception: {:?}", e);
    }
}

/// JNI function to set log level
#[cfg(target_os = "android")]
#[no_mangle]
pub extern "system" fn Java_com_trustformers_TrustformersEngine_setLogLevel(
    env: JNIEnv,
    _class: JClass,
    level: jlong,
) {
    let log_level = match level {
        0 => tracing::Level::ERROR,
        1 => tracing::Level::WARN,
        2 => tracing::Level::INFO,
        3 => tracing::Level::DEBUG,
        4 => tracing::Level::TRACE,
        _ => tracing::Level::INFO,
    };

    // In practice, would configure tracing subscriber
    tracing::info!("Log level set to: {:?}", log_level);
}

/// Utility functions for JNI integration
pub mod utils {
    use super::*;

    /// Convert Rust Result to JNI boolean result
    pub fn result_to_jboolean(result: Result<()>) -> jboolean {
        match result {
            Ok(_) => true as jboolean,
            Err(e) => {
                tracing::error!("Operation failed: {:?}", e);
                false as jboolean
            }
        }
    }

    /// Convert tensor to byte array for JNI
    pub fn tensor_to_bytes(tensor: &Tensor) -> Result<Vec<u8>> {
        let data = tensor.as_slice::<f32>()?;
        let bytes: Vec<u8> = data
            .iter()
            .flat_map(|&f| f.to_le_bytes().to_vec())
            .collect();
        Ok(bytes)
    }

    /// Convert byte array to tensor
    pub fn bytes_to_tensor(bytes: &[u8], shape: &[usize]) -> Result<Tensor> {
        let floats: Vec<f32> = bytes
            .chunks(4)
            .map(|chunk| {
                if chunk.len() == 4 {
                    let bytes = [chunk[0], chunk[1], chunk[2], chunk[3]];
                    f32::from_le_bytes(bytes)
                } else {
                    0.0
                }
            })
            .collect();

        Tensor::from_vec(floats, shape)
    }
}

// Provide stub implementations for non-Android platforms
#[cfg(not(target_os = "android"))]
pub mod stubs {
    use super::*;

    pub fn initialize_jni() -> Result<()> {
        Err(TrustformersError::runtime_error(
            "JNI is only available on Android".into(),
        ))
    }

    pub fn create_engine_from_java(_config_json: &str) -> Result<*mut AndroidInferenceEngine> {
        Err(TrustformersError::runtime_error(
            "JNI is only available on Android".into(),
        ))
    }
}

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

    #[test]
    fn test_tensor_conversion() {
        let original_data = vec![1.0f32, 2.0, 3.0, 4.0];
        let bytes = utils::tensor_to_bytes(&Tensor::from_vec(original_data.clone(), &[4]).expect("tensor operation failed")).expect("operation failed in test");
        let reconstructed = utils::bytes_to_tensor(&bytes, &[4]).expect("tensor operation failed");
        let reconstructed_data = reconstructed.as_slice::<f32>().expect("operation failed in test");

        assert_eq!(original_data, reconstructed_data);
    }

    #[test]
    fn test_result_conversion() {
        assert_eq!(utils::result_to_jboolean(Ok(())), true as jboolean);
        assert_eq!(
            utils::result_to_jboolean(Err(TrustformersError::runtime_error("test".into()).into())),
            false as jboolean
        );
    }

    #[cfg(not(target_os = "android"))]
    #[test]
    fn test_stubs() {
        assert!(stubs::initialize_jni().is_err().into());
        assert!(stubs::create_engine_from_java("{}").is_err());
    }
}