-
Notifications
You must be signed in to change notification settings - Fork 3
/
lib.rs
1281 lines (1102 loc) · 51.2 KB
/
lib.rs
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
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//! Author Benyamin Izadpanah
//! Copyright: Benyamin Izadpanah
//! Start Date: 2022-11-5 (year-month-day)
//! Last Date Modified: 2022-11-26
//! Last Version Used: Rust 1.65
//! Github Repository: <a href="https://github.com/ben-izd/">Repository Link</a>
//!
//! Summary:
//! This library was written to used as a shared library from different interfaces in different languages.
//! The goal is the ability to share data between interfaces through memory.
//!
//! # Testing
//! Because of the nature of the program, testing should be done on a single thread (rust default is multi-threaded)
//! Use "cargo test -- --test-threads=1" to run all test in a single thread
#[cfg(test)]
mod test {
use std::ffi::{CString};
use std::os::raw::{c_ulonglong, c_longlong, c_int, c_char};
use crate::general::*;
use std::env;
use std::path::PathBuf;
// Scenario 1|2 include:
// setting a path
// sharing an array
// retrieving array's flatten length, rank, dimension
// comparing the shared memory_data with the original data
// scenario 3 is like the 1|2 but include some repetition to discover hiccups
// This scenario should be run first to set the path for the future uses.
#[test]
fn scenario_1_length_3_with_setup() {
let mut temp_dir = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
temp_dir.push("data");
internal_set_shared_memory_path(temp_dir.to_str().unwrap().to_string());
complete_test_scenario::<1, 3, f32>(&[11., 22., 33.], &[3]);
complete_test_scenario::<1, 3, f64>(&[11., 22., 33.], &[3]);
complete_test_scenario::<1, 3, u8>(&[11, 22, 33], &[3]);
complete_test_scenario::<1, 3, u16>(&[11, 22, 33], &[3]);
complete_test_scenario::<1, 3, u32>(&[11, 22, 33], &[3]);
complete_test_scenario::<1, 3, u64>(&[11, 22, 33], &[3]);
complete_test_scenario::<1, 3, i8>(&[11, 22, 33], &[3]);
complete_test_scenario::<1, 3, i16>(&[11, 22, 33], &[3]);
complete_test_scenario::<1, 3, i32>(&[11, 22, 33], &[3]);
complete_test_scenario::<1, 3, i64>(&[11, 22, 33], &[3]);
}
#[test]
fn scenario_2_length_11() {
complete_test_scenario::<1, 11, f32>(&[11., 22., 33., 44., 55., 66., 77., 88., 99., 100., 110.], &[11]);
complete_test_scenario::<1, 11, f64>(&[11., 22., 33., 44., 55., 66., 77., 88., 99., 100., 110.], &[11]);
complete_test_scenario::<1, 11, u8>(&[11, 22, 33, 44, 55, 66, 77, 88, 99, 100, 110], &[11]);
complete_test_scenario::<1, 11, u16>(&[11, 22, 33, 44, 55, 66, 77, 88, 99, 100, 110], &[11]);
complete_test_scenario::<1, 11, u32>(&[11, 22, 33, 44, 55, 66, 77, 88, 99, 100, 110], &[11]);
complete_test_scenario::<1, 11, u64>(&[11, 22, 33, 44, 55, 66, 77, 88, 99, 100, 110], &[11]);
complete_test_scenario::<1, 11, i8>(&[11, 22, 33, 44, 55, 66, 77, 88, 99, 100, 110], &[11]);
complete_test_scenario::<1, 11, i16>(&[11, 22, 33, 44, 55, 66, 77, 88, 99, 100, 110], &[11]);
complete_test_scenario::<1, 11, i32>(&[11, 22, 33, 44, 55, 66, 77, 88, 99, 100, 110], &[11]);
complete_test_scenario::<1, 11, i64>(&[11, 22, 33, 44, 55, 66, 77, 88, 99, 100, 110], &[11]);
}
#[test]
fn scenario_3_empty() {
complete_test_scenario::<1, 0, f32>(&[], &[0]);
complete_test_scenario::<1, 0, f64>(&[], &[0]);
complete_test_scenario::<1, 0, u8>(&[], &[0]);
complete_test_scenario::<1, 0, u16>(&[], &[0]);
complete_test_scenario::<1, 0, u32>(&[], &[0]);
complete_test_scenario::<1, 0, u64>(&[], &[0]);
complete_test_scenario::<1, 0, i8>(&[], &[0]);
complete_test_scenario::<1, 0, i16>(&[], &[0]);
complete_test_scenario::<1, 0, i32>(&[], &[0]);
complete_test_scenario::<1, 0, i64>(&[], &[0]);
}
#[test]
fn scenario_3_length_4_repeated() {
const DATA: [f64; 6] = [11., 22., 33., 44., 55., 66.];
const DATA_LENGTH: usize = DATA.len();
const DIMS: [u64; 2] = [2, 3];
let error_code1_1 = set_shared_memory_data_float64(DATA.as_ptr(), DIMS.as_ptr(), 2);
let error_code1_2 = set_shared_memory_data_float64(DATA.as_ptr(), DIMS.as_ptr(), 2);
let error_code1_3 = set_shared_memory_data_float64(DATA.as_ptr(), DIMS.as_ptr(), 2);
if error_code1_1 == 0 && error_code1_2 == 0 && error_code1_3 == 0 {
assert_eq!(get_shared_memory_rank(), 2);
assert_eq!(get_shared_memory_rank(), 2);
assert_eq!(get_shared_memory_rank(), 2);
assert_eq!(get_shared_memory_flatten_length(), 6);
assert_eq!(get_shared_memory_flatten_length(), 6);
assert_eq!(get_shared_memory_flatten_length(), 6);
{
let temp_dim = [0; 2];
get_shared_memory_dimensions(temp_dim.as_ptr() as *mut u64);
assert_eq!(temp_dim, DIMS);
}
{
let temp_dim = [0; 2];
get_shared_memory_dimensions(temp_dim.as_ptr() as *mut u64);
assert_eq!(temp_dim, DIMS);
}
{
let temp_dim = [0; 2];
get_shared_memory_dimensions(temp_dim.as_ptr() as *mut u64);
assert_eq!(temp_dim, DIMS);
}
{// change dimension
let new_dim = [3, 2];
let error_code3 = set_shared_memory_dimensions(new_dim.as_ptr());
if error_code3 != 0 {
panic!("ERROR in changin dimensions");
}
}
{
let temp_dim: [u64; 2] = [0; 2];
get_shared_memory_dimensions(temp_dim.as_ptr() as *mut u64);
assert_eq!(temp_dim, [3u64, 2u64]);
}
assert_eq!(get_shared_memory_rank(), 2);
assert_eq!(get_shared_memory_flatten_length(), 6);
let mut temp = [0.0; DATA_LENGTH];
let error_code2_1 = get_shared_memory_flatten_data_float64(temp.as_mut_ptr());
let error_code2_2 = get_shared_memory_flatten_data_float64(temp.as_mut_ptr());
let error_code2_3 = get_shared_memory_flatten_data_float64(temp.as_mut_ptr());
if error_code2_1 == 0 && error_code2_2 == 0 && error_code2_3 == 0 {
assert_eq!(temp, DATA);
} else {
panic!("ERROR in retrieving the data, {:?} ", (error_code2_1, error_code2_2, error_code2_3));
}
} else {
panic!("ERROR in sharing data, {:?}", (error_code1_1, error_code1_2, error_code1_3));
}
}
#[test]
fn test_string() {
let my_string = CString::new("This is a sample text").unwrap();
set_shared_memory_string(my_string.as_ptr());
assert_eq!(get_shared_memory_flatten_length(), 21);
// assert_eq!(get_shared_memory_string_utf16_length(),21);
assert_eq!(get_shared_memory_rank(), 1);
assert_eq!(get_shared_memory_data_type(), 12);
let temp_dim: [u64; 1] = [0; 1];
get_shared_memory_dimensions(temp_dim.as_ptr() as *mut u64);
assert_eq!(temp_dim, [21]);
let mut output_string: [i8; 21] = [0; 21];
get_shared_memory_string(output_string.as_ptr() as *mut c_char);
let output_string_u8 = unsafe { std::slice::from_raw_parts(output_string.as_ptr() as *const u8, output_string.len()) };
assert_eq!(output_string_u8, my_string.as_bytes());
// match internal_read_shared_memory_string(){
// Ok(v)=> { assert_eq!(v.1,my_string.to_str().unwrap()) },
// Err(e) => {panic!("Error {}",e)}
// };
}
#[test]
fn final_scenario() {
delete_shared_memory();
}
fn complete_test_scenario<const RANK: usize, const FLATTEN_LENGTH: usize, T>(data: &[T], dims: &[c_ulonglong])
where T: Default + std::marker::Copy + std::cmp::PartialEq + std::fmt::Debug {
let error_code_1 = set_shared_memory_data(data.as_ptr(), [FLATTEN_LENGTH.try_into().unwrap()].as_ptr(), RANK as c_ulonglong, 9);
if error_code_1 == 0 {
assert_eq!(get_shared_memory_rank(), RANK as c_int);
assert_eq!(get_shared_memory_flatten_length(), FLATTEN_LENGTH as c_longlong);
let temp_dim = [0; RANK];
get_shared_memory_dimensions(temp_dim.as_ptr() as *mut u64);
assert_eq!(temp_dim, dims);
let mut temp = [T::default(); FLATTEN_LENGTH];
let error_code_2 = get_shared_memory_flatten_data(temp.as_mut_ptr());
if error_code_2 == 0 {
assert_eq!(temp, data);
} else {
panic!("ERROR in retrieving the data, {} ", error_code_2);
}
} else {
panic!("ERROR in sharing data, {}", error_code_1);
}
}
}
/// This module is the core of the library and is used by Java, Julia, Matlab and Python <br>
/// Error codes are universal, any change in the following code should be reflected in all the interfaces
mod general {
use std::ffi::{CStr};
use std::os::raw::*;
use shared_memory::*;
use std::ptr::copy_nonoverlapping;
use retry::retry;
use retry::delay::Fixed;
// Possible errors - all are negative
const EMPTY_LIBRARY_PATH_ERROR_CODE: c_int = -1;
const ACCESS_ERROR_CODE: c_int = -2;
const PARSING_PATH_STRING_ERROR: c_int = -3;
const CAN_NOT_CREATE_SHARED_MEMORY_ERROR: c_int = -4;
const NEW_RANK_DOES_NOT_MATCH_PREVIOUS_RANK_ERROR: c_int = -5;
pub const INVALID_DATA_TYPE: c_int = -6;
const INVALID_UTF8_STRING: c_int = -7;
const NUMBER_OF_ITEMS_WITHOUT_RANK: usize = 9;
/// A GLOBAL VARIABLE, used to store the shared memory path
static mut SHARED_MEMORY_FILE_PATH: Option<String> = None;
/// Specified the general layout of shared memory <br>
/// First is type, then rank, then dimension array, then data
pub enum AddressesOffset {
Type = 0,
Rank = 1,
Dimensions = 9,
}
/// #### All the supported types.
/// The exact same numbers used in the interfaces. Any change should be reflected there. <br>
/// Negative values are used for return error. Do not used negative values.
#[derive(PartialEq, Clone)]
pub enum SharedMemoryType {
Unsigned8 = 0,
Unsigned16 = 1,
Unsigned32 = 2,
Unsigned64 = 3,
Signed8 = 4,
Signed16 = 5,
Signed32 = 6,
Signed64 = 7,
Float32 = 8,
Float64 = 9,
ComplexFloat32 = 10,
ComplexFloat64 = 11,
UTF8String = 12,
}
impl From<u8> for SharedMemoryType {
fn from(id: u8) -> Self {
match id {
0 => SharedMemoryType::Unsigned8,
1 => SharedMemoryType::Unsigned16,
2 => SharedMemoryType::Unsigned32,
3 => SharedMemoryType::Unsigned64,
4 => SharedMemoryType::Signed8,
5 => SharedMemoryType::Signed16,
6 => SharedMemoryType::Signed32,
7 => SharedMemoryType::Signed64,
8 => SharedMemoryType::Float32,
9 => SharedMemoryType::Float64,
10 => SharedMemoryType::ComplexFloat32,
11 => SharedMemoryType::ComplexFloat64,
12 => SharedMemoryType::UTF8String,
_ => panic!("Invalid type id to convert to SharedMemoryType."),
}
}
}
/// Return global SHARED_MEMORY_FILE_PATH. <br>
/// Will return `Err(EMPTY_LIBRARY_PATH_ERROR_CODE)` if its None
pub fn internal_get_shared_memory_path<'a>() -> Result<&'a String, c_int> {
match unsafe { &SHARED_MEMORY_FILE_PATH } {
Some(ref v) => {
Ok(v)
}
None => Err(EMPTY_LIBRARY_PATH_ERROR_CODE)
}
}
/// ### Implementation Note
/// It's not supported to add method to existing type not define in this package. <br>
/// trait is used to add extra functionality to Shmem type.
pub trait SharedMemoryInterface {
/// Return shared memory data dimensions
fn get_dimensions(&self) -> &[u64];
/// Return shared memory data type
fn get_data_type(&self) -> SharedMemoryType;
/// Return shared memory data rank
fn get_rank(&self) -> usize;
/// ## Internal Use
/// Return the start address of shared memory data type
fn internal_get_data_type_ptr(&self) -> *const u8;
/// ## Internal Use
/// Return the start address of shared memory data rank
fn internal_get_rank_ptr(&self) -> *const u8;
/// ## Internal Use
/// Return the start address of shared memory data dimensions
fn internal_get_dimensions_ptr(&self) -> *const u8;
/// ## Internal Use
/// Return the start address of shared memory data
fn internal_get_data_ptr(&self) -> *const u8;
/// Return the product of shared memory data dimensions
fn get_flatten_length(&self) -> usize;
/// Unload shared memory from data
fn delete_shared_memory(self);
/// Return shared memory data as CStr
fn get_data_as_cstr(&self) -> &CStr;
/// Return shared memory data as Str. <br>
/// Return Err if data is not valid. <br>
/// Return Ok if data is a valid UTF-8 string, Err(INVALID_UTF8_STRING) if not
fn get_data_as_str(&self) -> Result<&str, c_int>;
/// Change shared memory data dimensions. New dimension should match previous rank because
/// of the shared memory layout. <br>
/// Return 0 if ranks matched, NEW_RANK_DOES_NOT_MATCH_PREVIOUS_RANK_ERROR if not
fn set_dimensions(&self, new_dimensions: &[u64]) -> c_int;
/// Create new shared memory given the address of data, its dimension (dims_raw), rank and type (type_id) <br>
/// Return 0 if successful, CAN_NOT_CREATE_SHARED_MEMORY_ERROR if shared memory can not be created. <br>
/// See SharedMemoryType enum for supported types and their ID.
fn new<T>(data: *const T, dims_raw: *const u64, rank: u64, type_id: u8) -> c_int;
/// Copy shared memory data to array_source
/// Return 0
fn get_flatten_data<T>(&self, array_source: *mut T) -> c_int;
}
impl SharedMemoryInterface for Shmem {
fn get_dimensions(&self) -> &[u64] {
unsafe { std::slice::from_raw_parts(self.internal_get_dimensions_ptr() as *const u64, self.get_rank()) }
}
fn get_data_type(&self) -> SharedMemoryType {
SharedMemoryType::from(unsafe { *(self.internal_get_data_type_ptr() as *const u8) })
}
fn get_rank(&self) -> usize {
unsafe { *(self.internal_get_rank_ptr() as *const usize) }
}
fn internal_get_data_type_ptr(&self) -> *const u8 {
unsafe { self.as_ptr().offset(AddressesOffset::Type as isize) }
}
fn internal_get_rank_ptr(&self) -> *const u8 {
unsafe { self.as_ptr().offset(AddressesOffset::Rank as isize) }
}
fn internal_get_dimensions_ptr(&self) -> *const u8 {
unsafe { self.as_ptr().offset(AddressesOffset::Dimensions as isize) }
}
fn internal_get_data_ptr(&self) -> *const u8 {
unsafe { self.as_ptr().offset(AddressesOffset::Dimensions as isize + self.get_rank() as isize * 8) }
}
fn get_flatten_length(&self) -> usize {
self.get_dimensions().iter().product::<u64>() as usize
}
fn delete_shared_memory(mut self) {
self.set_owner(true);
}
fn get_data_as_cstr(&self) -> &CStr {
unsafe { CStr::from_ptr(self.internal_get_data_ptr() as *const c_char) }
}
fn get_data_as_str(&self) -> Result<&str, c_int> {
let temp_slice = unsafe { std::slice::from_raw_parts(self.internal_get_data_ptr(), self.get_flatten_length() - 1) };
match std::str::from_utf8(temp_slice) {
Ok(v) => Ok(v),
Err(_) => Err(INVALID_UTF8_STRING)
}
}
fn set_dimensions(&self, new_dimensions: &[u64]) -> c_int {
let current_rank = self.get_rank();
if current_rank != new_dimensions.len() || new_dimensions.iter().product::<u64>() != self.get_flatten_length() as u64 {
NEW_RANK_DOES_NOT_MATCH_PREVIOUS_RANK_ERROR
} else {
unsafe { copy_nonoverlapping(new_dimensions.as_ptr(), self.internal_get_dimensions_ptr() as *mut u64, current_rank) };
0
}
}
fn new<T>(data: *const T, dims_raw: *const u64, rank: u64, type_id: u8) -> c_int {
let path = match internal_get_shared_memory_path() {
Ok(v) => v,
Err(e) => { return e; }
};
let rank_usize = rank as usize;
let data_type = SharedMemoryType::from(type_id);
let dims = unsafe { std::slice::from_raw_parts(dims_raw, rank_usize) };
let data_flatten_length = dims.iter().product::<u64>() as usize * if data_type == SharedMemoryType::ComplexFloat32 || data_type == SharedMemoryType::ComplexFloat64 { 2 } else { 1 };
let mut shared_memory = match ShmemConf::new().size((data_flatten_length + rank_usize) * 8 + NUMBER_OF_ITEMS_WITHOUT_RANK + if data_type == SharedMemoryType::UTF8String { 1 } else { 0 }).flink(path).create() {
Ok(m) => m,
Err(_) => {
return CAN_NOT_CREATE_SHARED_MEMORY_ERROR;
}
};
unsafe {
// Type
*(shared_memory.internal_get_data_type_ptr() as *mut u8) = type_id;
// Rank
*(shared_memory.internal_get_rank_ptr() as *mut u64) = rank as u64;
// Dimensions
copy_nonoverlapping::<u64>(dims_raw, shared_memory.internal_get_dimensions_ptr() as *mut u64, rank_usize);
// Data
copy_nonoverlapping::<T>(data, shared_memory.internal_get_data_ptr() as *mut T, data_flatten_length);
}
// Prevent data from cleaning at the end of the code block
shared_memory.set_owner(false);
0
}
fn get_flatten_data<T>(&self, array_source: *mut T) -> c_int {
let dims = self.get_dimensions();
let data_type = self.get_data_type();
let data_flatten_length = dims.iter().product::<u64>() as usize * if data_type == SharedMemoryType::ComplexFloat32 || data_type == SharedMemoryType::ComplexFloat64 { 2 } else { 1 };
if data_flatten_length > 0 {
unsafe { copy_nonoverlapping::<T>(self.internal_get_data_ptr() as *const T, array_source, data_flatten_length); }
}
0
}
}
/// ## Internal Use
/// Try to access the shared memory. Will retry 5 times with 1 millisecond as delay between
/// each try. <br>
/// Will Return Err(ACCESS_ERROR_CODE) if can not access the shared memory.
pub fn internal_open_shared_memory() -> Result<Shmem, c_int> {
let path = internal_get_shared_memory_path()?;
// ShmemConf::new().flink(path).open().map_err(|_| ACCESS_ERROR_CODE)
retry(Fixed::from_millis(1).take(5), || {
ShmemConf::new().flink(path).open()
}).map_err(|_| ACCESS_ERROR_CODE)
}
/// ## Internal Use
/// Set the shared memory path so other functions can work seamlessly.
pub fn internal_set_shared_memory_path(path: String) {
unsafe { SHARED_MEMORY_FILE_PATH = Some(path) }
}
/// ## Exposed
/// Return data type id (all non-negative values), negative value in case of any error.
#[no_mangle]
pub extern "C" fn get_shared_memory_data_type() -> c_int {
match internal_open_shared_memory() {
Ok(v) => v.get_data_type() as c_int,
Err(e) => e
}
}
/// ## Exposed
/// Change shared memory dimension. <br>
/// New dimension should match with previous rank. <br>
/// Return 0 of successful, negative values in case of any error.
#[no_mangle]
pub extern "C" fn set_shared_memory_dimensions(new_dimensions_raw: *const c_ulonglong) -> c_int {
match internal_open_shared_memory() {
Ok(shared_memory) => {
let current_rank = shared_memory.get_rank();
let new_dimensions = unsafe { std::slice::from_raw_parts(new_dimensions_raw, current_rank) };
shared_memory.set_dimensions(new_dimensions);
0
}
Err(e) => e
}
}
/// ## Exposed
/// Return shared memory rank. <br>
/// Return >= 0 if successful, negative values if not.
#[no_mangle]
pub extern "C" fn get_shared_memory_rank() -> c_int {
match internal_open_shared_memory() {
Ok(v) => v.get_rank() as c_int,
Err(e) => e
}
}
/// ## Exposed
/// Copy shared memory dimension to array address. <br>
/// Return 0 if successful, Negative values if not. <br>
/// Passing the address of shared memory dimension as input result in undefined behaviour.
#[no_mangle]
pub extern "C" fn get_shared_memory_dimensions(array: *mut c_ulonglong) -> c_int {
match internal_open_shared_memory() {
Ok(v) => {
let dims = v.get_dimensions();
unsafe { copy_nonoverlapping::<u64>(dims.as_ptr() as *const u64, array, dims.len()) };
0
}
Err(e) => e
}
}
/// ## Exposed
/// Set shared memory path used to access the shared memory. <br>
/// If path was a valid UTF-8 string, a copy will be saved. <br>
/// Return 0 if successful, Negative values if not.
/// See internal_set_shared_memory_path()
#[no_mangle]
pub extern "C" fn set_shared_memory_path(path: *const c_char) -> c_int {
match unsafe { CStr::from_ptr(path).to_str() } {
Ok(v) => {
internal_set_shared_memory_path(v.to_string());
0
}
Err(_) => {
PARSING_PATH_STRING_ERROR
}
}
}
/// ## Exposed
/// Return product of shared memory dimension. <br>
/// Note: Complex types consist of 2 numbers but counted as 1 element. <br>
/// Return >= 0 if successful, Negative values if not.
/// See SharedMemoryInterface::get_flatten_length()
#[no_mangle]
pub extern "C" fn get_shared_memory_flatten_length() -> c_longlong {
match internal_open_shared_memory() {
Ok(v) => v.get_flatten_length() as c_longlong,
Err(e) => {
e as c_longlong
}
}
}
/// ## Exposed
/// Unload shared memory data. If it can not access it, the file used to access it will be deleted. <br>
/// Return 0 if successful, Negative values if not. <br>
/// See SharedMemoryInterface::delete_shared_memory()
#[no_mangle]
pub extern "C" fn delete_shared_memory() -> c_int {
let path = match internal_get_shared_memory_path() {
Ok(v) => v,
Err(e) => { return e; }
};
match internal_open_shared_memory() {
Ok(v) => {
v.delete_shared_memory();
}
Err(_) => {
// Tries to remove the file shared memory used
let _ = std::fs::remove_file(path);
}
};
0
}
/// ## Exposed
/// string is a null-terminated string. <br>
/// length of the string without null character will be saved but the shared memory data contain
/// null character. <br>
/// Return 0 if successful, CAN_NOT_CREATE_SHARED_MEMORY_ERROR if shared memory can not be created.
#[no_mangle]
pub extern "C" fn set_shared_memory_string(string: *const c_char) -> c_int {
let data = unsafe { CStr::from_ptr(string) };
set_shared_memory_data(data.as_ptr() as *const u8, [data.to_bytes().len() as u64].as_ptr(), 1, 12)
}
/// ## Exposed
/// Copy data to string address. Null-character is not included. <br>
/// Return 0 if successful, Negative values if not.
#[no_mangle]
pub extern "C" fn get_shared_memory_string(string: *mut c_char) -> c_int {
get_shared_memory_flatten_data(string)
}
/// A generic function, copy data to array source. Length of copy is dependant of type and flatten_length. <br>
/// Return 0 if successful, Negative values if not. <br>
/// See SharedMemoryInterface::get_flatten_data()
pub fn get_shared_memory_flatten_data<T>(array_source: *mut T) -> c_int {
match internal_open_shared_memory() {
Ok(shared_memory) => {
shared_memory.get_flatten_data(array_source)
}
Err(e) => e
}
}
/// ## Exposed
/// Copy u8 data to array_source <br>
/// Return 0 if successful, Negative values if not. <br>
/// See SharedMemoryInterface::get_shared_memory_flatten_data()
#[no_mangle]
pub extern "C" fn get_shared_memory_flatten_data_unsigned_8(array_source: *mut c_uchar) -> c_int {
get_shared_memory_flatten_data(array_source)
}
/// ## Exposed
/// Copy u16 data to array_source <br>
/// Return 0 if successful, Negative values if not. <br>
/// See SharedMemoryInterface::get_shared_memory_flatten_data()
#[no_mangle]
pub extern "C" fn get_shared_memory_flatten_data_unsigned_16(array_source: *mut c_ushort) -> c_int {
get_shared_memory_flatten_data(array_source)
}
/// ## Exposed
/// Copy u32 data to array_source <br>
/// Return 0 if successful, Negative values if not. <br>
/// See SharedMemoryInterface::get_shared_memory_flatten_data()
#[no_mangle]
pub extern "C" fn get_shared_memory_flatten_data_unsigned_32(array_source: *mut c_ulong) -> c_int {
get_shared_memory_flatten_data(array_source)
}
/// ## Exposed
/// Copy u64 data to array_source <br>
/// Return 0 if successful, Negative values if not. <br>
/// See SharedMemoryInterface::get_shared_memory_flatten_data()
#[no_mangle]
pub extern "C" fn get_shared_memory_flatten_data_unsigned_64(array_source: *mut c_ulonglong) -> c_int {
get_shared_memory_flatten_data(array_source)
}
/// ## Exposed
/// Copy i8 data to array_source <br>
/// Return 0 if successful, Negative values if not. <br>
/// See SharedMemoryInterface::get_shared_memory_flatten_data()
#[no_mangle]
pub extern "C" fn get_shared_memory_flatten_data_signed_8(array_source: *mut c_char) -> c_int {
get_shared_memory_flatten_data(array_source)
}
/// ## Exposed
/// Copy i16 data to array_source <br>
/// Return 0 if successful, Negative values if not. <br>
/// See SharedMemoryInterface::get_shared_memory_flatten_data()
#[no_mangle]
pub extern "C" fn get_shared_memory_flatten_data_signed_16(array_source: *mut c_short) -> c_int {
get_shared_memory_flatten_data(array_source)
}
/// ## Exposed
/// Copy i32 data to array_source <br>
/// Return 0 if successful, Negative values if not. <br>
/// See SharedMemoryInterface::get_shared_memory_flatten_data()
#[no_mangle]
pub extern "C" fn get_shared_memory_flatten_data_signed_32(array_source: *mut c_long) -> c_int {
get_shared_memory_flatten_data(array_source)
}
/// ## Exposed
/// Copy i64 data to array_source <br>
/// Return 0 if successful, Negative values if not. <br>
/// See SharedMemoryInterface::get_shared_memory_flatten_data()
#[no_mangle]
pub extern "C" fn get_shared_memory_flatten_data_signed_64(array_source: *mut c_longlong) -> c_int {
get_shared_memory_flatten_data(array_source)
}
/// ## Exposed
/// Copy f32 data to array_source <br>
/// Return 0 if successful, Negative values if not. <br>
/// See SharedMemoryInterface::get_shared_memory_flatten_data()
#[no_mangle]
pub extern "C" fn get_shared_memory_flatten_data_float32(array_source: *mut c_float) -> c_int {
get_shared_memory_flatten_data(array_source)
}
/// ## Exposed
/// Copying f64 data to array_source <br>
/// Return 0 if successful, Negative values if not. <br>
/// See SharedMemoryInterface::get_shared_memory_flatten_data()
#[no_mangle]
pub extern "C" fn get_shared_memory_flatten_data_float64(array_source: *mut c_double) -> c_int {
get_shared_memory_flatten_data(array_source)
}
/// A generic function, set shared memory data. If a file exist, it tries to unload it first then create a new one. <br>
/// Return 0 if successful, CAN_NOT_CREATE_SHARED_MEMORY_ERROR if shared memory can not be created. <br>
/// See SharedMemoryInterface::new()
pub fn set_shared_memory_data<T>(data: *const T, dims_raw: *const u64, rank: u64, type_id: u8) -> c_int {
match internal_open_shared_memory() {
Ok(v) => {
v.delete_shared_memory()
}
Err(_) => {}
}
Shmem::new(data, dims_raw, rank, type_id)
}
/// ## Exposed
/// Copy u8 data with dims_raw dimension and specified rank to shared memory <br>
/// Return 0 if successful, CAN_NOT_CREATE_SHARED_MEMORY_ERROR if shared memory can not be created. <br>
/// See set_shared_memory_data()
#[no_mangle]
pub extern "C" fn set_shared_memory_data_unsigned_8(
data: *const c_uchar,
dims_raw: *const c_ulonglong,
rank: c_ulonglong,
) -> c_int {
set_shared_memory_data(data, dims_raw, rank, 0)
}
/// ## Exposed
/// Copy u16 data with dims_raw dimension and specified rank to shared memory <br>
/// Return 0 if successful, CAN_NOT_CREATE_SHARED_MEMORY_ERROR if shared memory can not be created. <br>
/// See set_shared_memory_data()
#[no_mangle]
pub extern "C" fn set_shared_memory_data_unsigned_16(
data: *const c_ushort,
dims_raw: *const c_ulonglong,
rank: c_ulonglong,
) -> c_int {
set_shared_memory_data(data, dims_raw, rank, 1)
}
/// ## Exposed
/// Copy u32 data with dims_raw dimension and specified rank to shared memory <br>
/// Return 0 if successful, CAN_NOT_CREATE_SHARED_MEMORY_ERROR if shared memory can not be created. <br>
/// See set_shared_memory_data()
#[no_mangle]
pub extern "C" fn set_shared_memory_data_unsigned_32(
data: *const c_ulong,
dims_raw: *const c_ulonglong,
rank: c_ulonglong,
) -> c_int {
set_shared_memory_data(data, dims_raw, rank, 2)
}
/// ## Exposed
/// Copy u64 data with dims_raw dimension and specified rank to shared memory <br>
/// Return 0 if successful, CAN_NOT_CREATE_SHARED_MEMORY_ERROR if shared memory can not be created. <br>
/// See set_shared_memory_data()
#[no_mangle]
pub extern "C" fn set_shared_memory_data_unsigned_64(
data: *const c_ulonglong,
dims_raw: *const c_ulonglong,
rank: c_ulonglong,
) -> c_int {
set_shared_memory_data(data, dims_raw, rank, 3)
}
/// ## Exposed
/// Copy i8 data with dims_raw dimension and specified rank to shared memory <br>
/// Return 0 if successful, CAN_NOT_CREATE_SHARED_MEMORY_ERROR if shared memory can not be created. <br>
/// See set_shared_memory_data()
#[no_mangle]
pub extern "C" fn set_shared_memory_data_signed_8(
data: *const c_char,
dims_raw: *const c_ulonglong,
rank: c_ulonglong,
) -> c_int {
set_shared_memory_data(data, dims_raw, rank, 4)
}
/// ## Exposed
/// Copy i16 data with dims_raw dimension and specified rank to shared memory <br>
/// Return 0 if successful, CAN_NOT_CREATE_SHARED_MEMORY_ERROR if shared memory can not be created. <br>
/// See set_shared_memory_data()
#[no_mangle]
pub extern "C" fn set_shared_memory_data_signed_16(
data: *const c_short,
dims_raw: *const c_ulonglong,
rank: c_ulonglong,
) -> c_int {
set_shared_memory_data(data, dims_raw, rank, 5)
}
/// ## Exposed
/// Copy i32 data with dims_raw dimension and specified rank to shared memory <br>
/// Return 0 if successful, CAN_NOT_CREATE_SHARED_MEMORY_ERROR if shared memory can not be created. <br>
/// See set_shared_memory_data()
#[no_mangle]
pub extern "C" fn set_shared_memory_data_signed_32(
data: *const c_long,
dims_raw: *const c_ulonglong,
rank: c_ulonglong,
) -> c_int {
set_shared_memory_data(data, dims_raw, rank, 6)
}
/// ## Exposed
/// Copy i64 data with dims_raw dimension and specified rank to shared memory <br>
/// Return 0 if successful, CAN_NOT_CREATE_SHARED_MEMORY_ERROR if shared memory can not be created. <br>
/// See set_shared_memory_data()
#[no_mangle]
pub extern "C" fn set_shared_memory_data_signed_64(
data: *const c_longlong,
dims_raw: *const c_ulonglong,
rank: c_ulonglong,
) -> c_int {
set_shared_memory_data(data, dims_raw, rank, 7)
}
/// ## Exposed
/// Copy f32 data with dims_raw dimension and specified rank to shared memory <br>
/// Return 0 if successful, CAN_NOT_CREATE_SHARED_MEMORY_ERROR if shared memory can not be created. <br>
/// See set_shared_memory_data()
#[no_mangle]
pub extern "C" fn set_shared_memory_data_float32(
data: *const c_float,
dims_raw: *const c_ulonglong,
rank: c_ulonglong,
) -> c_int {
set_shared_memory_data(data, dims_raw, rank, 8)
}
/// ## Exposed
/// Copy f64 data with dims_raw dimension and specified rank to shared memory <br>
/// Return 0 if successful, CAN_NOT_CREATE_SHARED_MEMORY_ERROR if shared memory can not be created. <br>
/// See set_shared_memory_data()
#[no_mangle]
pub extern "C" fn set_shared_memory_data_float64(
data: *const c_double,
dims_raw: *const c_ulonglong,
rank: c_ulonglong,
) -> c_int {
set_shared_memory_data(data, dims_raw, rank, 9)
}
/// ## Exposed
/// Copy f32 data with dims_raw dimension and specified rank to shared memory <br>
/// Because its a complex array, each two element is counted as one.
/// Return 0 if successful, CAN_NOT_CREATE_SHARED_MEMORY_ERROR if shared memory can not be created. <br>
/// See set_shared_memory_data()
#[no_mangle]
pub extern "C" fn set_shared_memory_data_complex_float32(
data: *const c_float,
dims_raw: *const c_ulonglong,
rank: c_ulonglong,
) -> c_int {
set_shared_memory_data(data, dims_raw, rank, 10)
}
/// ## Exposed
/// Copy f64 data with dims_raw dimension and specified rank to shared memory <br>
/// Because its a complex array, each two element is counted as one.
/// Return 0 if successful, CAN_NOT_CREATE_SHARED_MEMORY_ERROR if shared memory can not be created. <br>
/// See set_shared_memory_data()
#[no_mangle]
pub extern "C" fn set_shared_memory_data_complex_float64(
data: *const c_double,
dims_raw: *const c_ulonglong,
rank: c_ulonglong,
) -> c_int {
set_shared_memory_data(data, dims_raw, rank, 11)
}
}
/// This module provide special interface for Wolfram Language (Mathematica) <br>
/// If you don't have or won't use it, comment this section + it's dependency in Cargo.toml (wolfram-library-link)
mod mathematica {
use wolfram_library_link::sys::{WolframLibraryData, mint, MArgument, MType_Real, MTensor, MType_Integer, MNumericArray};
use crate::general::*;
use std::os::raw::{c_char, c_int, c_ulonglong};
use std::ptr::copy_nonoverlapping;
use shared_memory::{Shmem};
use wolfram_library_link as wll;
/// translate SharedMemoryType to Mathematica Type ID
impl SharedMemoryType {
pub fn to_library_link(self) -> u8 {
match self {
SharedMemoryType::Unsigned8 => 2,
SharedMemoryType::Unsigned16 => 4,
SharedMemoryType::Unsigned32 => 6,
SharedMemoryType::Unsigned64 => 8,
SharedMemoryType::Signed8 => 1,
SharedMemoryType::Signed16 => 3,
SharedMemoryType::Signed32 => 5,
SharedMemoryType::Signed64 => 7,
SharedMemoryType::Float32 => 9,
SharedMemoryType::Float64 => 10,
SharedMemoryType::ComplexFloat32 => 11,
SharedMemoryType::ComplexFloat64 => 12,
_ => unreachable!()
}
}
}
/// ## Wolfram Exposed
/// Set shared memory path used to access the shared memory
/// See internal_set_shared_memory_path()
#[wll::export]
fn set_shared_memory_path_mathematica(new_path: String) {
internal_set_shared_memory_path(new_path)
}
/// ## Wolfram Exposed
/// Return shared memory data rank
/// Return >= 0 if successful, negative values if not.
#[wll::export]
fn get_shared_memory_rank_mathematica() -> i64 {
get_shared_memory_rank() as i64
}
/// ## Wolfram Exposed
/// Return shared memory data rank
/// Return data type id (all non-negative values), negative value in case of any error.
#[wll::export]
fn get_shared_memory_data_type_mathematica() -> i64 {
get_shared_memory_data_type() as i64
}
/// ## Exposed
/// Set output the flatten length of shared memory data
/// Return 0 of successful, negative values if not
#[no_mangle]
pub unsafe extern "C" fn get_shared_memory_flatten_length_mathematica(
_lib_data: WolframLibraryData,
_arg_count: mint,
_args: *mut MArgument,
res: MArgument,
) -> c_int {
match internal_open_shared_memory() {
Ok(v) => {
*res.integer = v.get_flatten_length() as mint;
0
}
Err(e) => e
}
}
/// ## Exposed
/// Set output the dimension of shared memory data
/// Return 0 of successful, negative values if not
#[no_mangle]
pub unsafe extern "C" fn get_shared_memory_dimensions_mathematica(
lib_data: WolframLibraryData,
_arg_count: mint,
_args: *mut MArgument,
res: MArgument,
) -> c_int {
let mut output: MTensor = std::ptr::null_mut();
match internal_open_shared_memory() {
Ok(v) => {
let dims = v.get_dimensions();
let error_code = ((*lib_data).MTensor_new.unwrap())(MType_Integer.into(), 1, [dims.len()].as_ptr() as *const mint, &mut output as *mut MTensor);
if error_code == 0 {
copy_nonoverlapping::<i64>(dims.as_ptr() as *const i64, ((*lib_data).MTensor_getIntegerData.unwrap())(output), dims.len());
*res.tensor = output
}
error_code
}
Err(e) => e
}
}
/// ## Exposed
/// Set output the flatten shared memory data with f64 type
/// Return 0 of successful, negative values if not
#[no_mangle]
pub unsafe extern "C" fn get_shared_memory_flatten_data_float64_mathematica(
lib_data: WolframLibraryData,
_arg_count: mint,
_args: *mut MArgument,
res: MArgument,
) -> c_int {
let mut output: MTensor = std::ptr::null_mut();
{
let data_flatten_length = match internal_open_shared_memory() {
Ok(v) => v.get_flatten_length(),