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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
use std::sync::Arc;
use std::sync::atomic::{AtomicI32, AtomicU32, AtomicU64, Ordering};
use parking_lot::Mutex;
use crate::error::{ADError, ADResult};
use crate::ndarray::{NDArray, NDDataBuffer, NDDataType, NDDimension};
use crate::ndarray_handle::{NDArrayHandle, pooled_array};
use crate::timestamp::EpicsTimestamp;
/// If a free-list buffer is more than this ratio larger than needed, discard
/// it and allocate fresh to avoid wasting memory.
const THRESHOLD_SIZE_RATIO: f64 = 1.5;
/// Process-wide source of pool identities. Each `NDArrayPool` gets a unique
/// non-zero id so `release` can verify an array belongs to it (C++
/// NDArrayPool.cpp:352 checks `pArray->pNDArrayPool == this`).
static NEXT_POOL_ID: AtomicU64 = AtomicU64::new(1);
/// NDArray factory with free-list reuse and memory tracking.
///
/// Mimics C++ ADCore's NDArrayPool: on alloc, checks the free list for a
/// buffer with sufficient capacity. On release, returns the buffer to the
/// free list for future reuse. The free list is sorted by capacity (descending)
/// and excess entries are dropped when max_memory is exceeded.
pub struct NDArrayPool {
/// Unique identity of this pool, stamped onto every array it allocates.
id: u64,
max_memory: usize,
allocated_bytes: AtomicU64,
next_unique_id: AtomicI32,
free_list: Mutex<Vec<NDArray>>,
num_alloc_buffers: AtomicU32,
num_free_buffers: AtomicU32,
}
impl NDArrayPool {
pub fn new(max_memory: usize) -> Self {
Self {
id: NEXT_POOL_ID.fetch_add(1, Ordering::Relaxed),
max_memory,
allocated_bytes: AtomicU64::new(0),
next_unique_id: AtomicI32::new(1),
free_list: Mutex::new(Vec::new()),
num_alloc_buffers: AtomicU32::new(0),
num_free_buffers: AtomicU32::new(0),
}
}
/// Identity of this pool (the value stamped onto `NDArray::pool_id`).
pub fn id(&self) -> u64 {
self.id
}
/// Allocate an NDArray. Tries to reuse a free-list entry with sufficient capacity.
///
/// Memory accounting tracks the exact requested byte count (`data_size`,
/// equivalent to C++ `dataSize`), NOT the allocator-rounded `Vec::capacity`.
/// `allocated_bytes` is the sum of the `data_size` of every live + free array,
/// so it matches what C++ `getMemorySize()` reports and the `max_memory`
/// limit is enforced exactly.
pub fn alloc(&self, dims: Vec<NDDimension>, data_type: NDDataType) -> ADResult<NDArray> {
let num_elements: usize = dims.iter().map(|d| d.size).product();
let needed_bytes = num_elements * data_type.element_size();
// Try to find a reusable buffer in the free list. Selection is by Vec
// capacity (a buffer big enough to hold the data without reallocating),
// but accounting always uses the exact `data_size`.
let reused = {
let mut free = self.free_list.lock();
let mut best_idx = None;
let mut best_cap = usize::MAX;
for (i, arr) in free.iter().enumerate() {
let cap = arr.data.capacity_bytes();
if cap >= needed_bytes && cap < best_cap {
best_cap = cap;
best_idx = Some(i);
}
}
if let Some(idx) = best_idx {
if best_cap as f64 > needed_bytes as f64 * THRESHOLD_SIZE_RATIO {
// Oversized: discard it, subtract its tracked data_size.
let dropped = free.swap_remove(idx);
self.num_free_buffers.fetch_sub(1, Ordering::Relaxed);
self.allocated_bytes
.fetch_sub(dropped.data_size as u64, Ordering::Relaxed);
self.num_alloc_buffers.fetch_sub(1, Ordering::Relaxed);
None
} else {
let arr = free.swap_remove(idx);
self.num_free_buffers.fetch_sub(1, Ordering::Relaxed);
Some(arr)
}
} else {
None
}
};
let mut arr = if let Some(mut reused) = reused {
// Reuse: C parity (NDArrayPool.cpp `alloc`) keeps the buffer's
// tracked `dataSize` and `memorySize_` unchanged when the existing
// buffer is already large enough — only a grow (realloc) adjusts
// accounting. Reusing a 1000-byte buffer for an 800-byte request
// therefore leaves `allocated_bytes` at 1000.
let old_size = reused.data_size;
if reused.data.data_type() != data_type {
reused.data = NDDataBuffer::zeros(data_type, num_elements);
} else {
reused.data.resize(num_elements);
}
let effective_size = if needed_bytes > old_size {
let diff = (needed_bytes - old_size) as u64;
// CAS loop: the limit check and the increment must be atomic so
// two threads on the reuse-grow path cannot both pass the check
// and over-commit past `max_memory`. Mirrors the fresh-allocation
// path; C++ `NDArrayPool::alloc` is fully mutex-serialized.
if self.max_memory > 0 {
loop {
let current = self.allocated_bytes.load(Ordering::Relaxed);
if current + diff > self.max_memory as u64 {
// Put the array back; the reuse path does not consume
// a slot.
let mut free = self.free_list.lock();
free.push(reused);
self.num_free_buffers.fetch_add(1, Ordering::Relaxed);
return Err(ADError::PoolExhausted(needed_bytes, self.max_memory));
}
if self
.allocated_bytes
.compare_exchange_weak(
current,
current + diff,
Ordering::Relaxed,
Ordering::Relaxed,
)
.is_ok()
{
break;
}
}
} else {
self.allocated_bytes.fetch_add(diff, Ordering::Relaxed);
}
needed_bytes
} else {
// Buffer already big enough: keep the larger tracked size so
// accounting matches the byte count added when it was created.
old_size
};
reused.data_size = effective_size;
reused.dims = dims;
reused.attributes.clear();
reused.codec = None;
reused
} else {
// Fresh allocation with CAS loop to avoid TOCTOU race. The reserved
// amount is exactly `needed_bytes`; no capacity slack is ever added.
if self.max_memory > 0 {
loop {
let current = self.allocated_bytes.load(Ordering::Relaxed);
if current + needed_bytes as u64 > self.max_memory as u64 {
let mut freed_enough = false;
{
let mut free = self.free_list.lock();
free.sort_by(|a, b| {
b.data.capacity_bytes().cmp(&a.data.capacity_bytes())
});
let mut reclaimed = 0u64;
let over = (current + needed_bytes as u64)
.saturating_sub(self.max_memory as u64);
while !free.is_empty() && reclaimed < over {
let dropped = free.remove(0);
let dropped_size = dropped.data_size as u64;
self.allocated_bytes
.fetch_sub(dropped_size, Ordering::Relaxed);
self.num_free_buffers.fetch_sub(1, Ordering::Relaxed);
self.num_alloc_buffers.fetch_sub(1, Ordering::Relaxed);
reclaimed += dropped_size;
}
if reclaimed >= over {
freed_enough = true;
}
}
if !freed_enough {
return Err(ADError::PoolExhausted(needed_bytes, self.max_memory));
}
continue;
}
if self
.allocated_bytes
.compare_exchange_weak(
current,
current + needed_bytes as u64,
Ordering::Relaxed,
Ordering::Relaxed,
)
.is_ok()
{
break;
}
}
} else {
self.allocated_bytes
.fetch_add(needed_bytes as u64, Ordering::Relaxed);
}
self.num_alloc_buffers.fetch_add(1, Ordering::Relaxed);
NDArray::new(dims, data_type)
};
arr.unique_id = self.next_unique_id.fetch_add(1, Ordering::Relaxed);
arr.timestamp = EpicsTimestamp::now();
arr.pool_id = self.id;
// `data_size` is already correct: a fresh `NDArray::new` sets it to
// `needed_bytes`; the reuse branch keeps the buffer's larger size.
Ok(arr)
}
/// Allocate a copy of an existing NDArray (new unique_id, data cloned).
/// Tries the free list first (via alloc()), then copies data from source.
pub fn alloc_copy(&self, source: &NDArray) -> ADResult<NDArray> {
let dims = source.dims.clone();
let data_type = source.data.data_type();
let mut copy = self.alloc(dims, data_type)?;
copy.data = source.data.clone();
copy.time_stamp = source.time_stamp;
copy.attributes = source.attributes.clone();
copy.codec = source.codec.clone();
Ok(copy)
}
/// Return an array to the free list for future reuse.
///
/// The array must have been allocated from this pool. C++
/// (NDArrayPool.cpp:352) verifies `pArray->pNDArrayPool == this` and refuses
/// otherwise; the Rust port checks `pool_id` and drops a foreign array
/// without touching this pool's free list or accounting.
pub fn release(&self, array: NDArray) {
if array.pool_id != self.id {
// Foreign (or non-pool) array — never touch this pool's accounting.
// Dropping `array` here frees its memory; it was never part of
// `allocated_bytes`, so no adjustment is made.
return;
}
let mut free = self.free_list.lock();
free.push(array);
self.num_free_buffers.fetch_add(1, Ordering::Relaxed);
// If total allocated exceeds max_memory, drop largest free entries.
// Accounting and the loop counter both use the exact `data_size` so the
// `usize` `excess` can never underflow (max_memory == 0 means unlimited).
let total = self.allocated_bytes.load(Ordering::Relaxed) as usize;
if self.max_memory > 0 && total > self.max_memory && !free.is_empty() {
free.sort_by(|a, b| b.data_size.cmp(&a.data_size));
let mut excess = total - self.max_memory;
while excess > 0 && !free.is_empty() {
let dropped = free.remove(0);
let dropped_size = dropped.data_size;
self.allocated_bytes
.fetch_sub(dropped_size as u64, Ordering::Relaxed);
self.num_free_buffers.fetch_sub(1, Ordering::Relaxed);
self.num_alloc_buffers.fetch_sub(1, Ordering::Relaxed);
if dropped_size >= excess {
break;
}
excess -= dropped_size;
}
}
}
/// Clear all entries from the free list.
pub fn empty_free_list(&self) {
let mut free = self.free_list.lock();
let count = free.len() as u32;
for arr in free.drain(..) {
self.allocated_bytes
.fetch_sub(arr.data_size as u64, Ordering::Relaxed);
self.num_alloc_buffers.fetch_sub(1, Ordering::Relaxed);
}
self.num_free_buffers.fetch_sub(count, Ordering::Relaxed);
}
pub fn allocated_bytes(&self) -> u64 {
self.allocated_bytes.load(Ordering::Relaxed)
}
pub fn num_alloc_buffers(&self) -> u32 {
self.num_alloc_buffers.load(Ordering::Relaxed)
}
pub fn num_free_buffers(&self) -> u32 {
self.num_free_buffers.load(Ordering::Relaxed)
}
pub fn max_memory(&self) -> usize {
self.max_memory
}
/// Allocate an NDArray wrapped in a pool-aware handle.
/// On final drop, the array is returned to this pool's free list.
pub fn alloc_handle(
pool: &Arc<Self>,
dims: Vec<NDDimension>,
data_type: NDDataType,
) -> ADResult<NDArrayHandle> {
let array = pool.alloc(dims, data_type)?;
Ok(pooled_array(array, pool))
}
/// Copy `src` into a (possibly existing) output array.
///
/// Mirrors C++ `NDArrayPool::copy(pIn, pOut, copyData, copyDimensions,
/// copyDataType)`:
/// - `out` is `None`: a fresh array is allocated through this pool with the
/// source dimensions/type.
/// - `copy_dimensions`: copy `dims` from source.
/// - `copy_data_type`: the output buffer takes the source data type.
/// - `copy_data`: copy the pixel/codec bytes.
///
/// Attributes are always cleared on the output then copied from the source.
pub fn copy(
&self,
src: &NDArray,
out: Option<NDArray>,
copy_data: bool,
copy_dimensions: bool,
copy_data_type: bool,
) -> ADResult<NDArray> {
let mut out = match out {
Some(o) => o,
None => self.alloc(src.dims.clone(), src.data.data_type())?,
};
out.unique_id = src.unique_id;
out.time_stamp = src.time_stamp;
out.timestamp = src.timestamp;
if copy_dimensions {
out.dims = src.dims.clone();
}
out.codec = src.codec.clone();
if copy_data {
if copy_data_type && out.data.data_type() != src.data.data_type() {
// Output adopts the source type: clone the buffer wholesale.
out.data = src.data.clone();
} else if out.data.data_type() == src.data.data_type() {
out.data = src.data.clone();
} else {
// Output keeps its own type: convert pixel values.
out.data = crate::color::convert_data_type(src, out.data.data_type())?.data;
}
} else if copy_data_type && out.data.data_type() != src.data.data_type() {
out.data = NDDataBuffer::zeros(src.data.data_type(), out.data.len());
}
out.attributes.clear();
out.attributes.copy_from(&src.attributes);
Ok(out)
}
/// Allocate `count` copies of `template_array`, then immediately release
/// them back to the free list (C++ `asynNDArrayDriver::preAllocateBuffers`).
///
/// The net effect is that the pool's free list is warmed with `count`
/// reusable buffers sized for the template array.
pub fn pre_allocate_buffers(&self, template_array: &NDArray, count: usize) -> ADResult<()> {
let mut buffers = Vec::with_capacity(count);
for _ in 0..count {
buffers.push(self.copy(template_array, None, true, true, true)?);
}
for arr in buffers {
self.release(arr);
}
Ok(())
}
/// Convert data type only (no dimension changes).
/// Allocates the output through the pool, converts data, copies metadata.
pub fn convert_type(&self, src: &NDArray, target_type: NDDataType) -> ADResult<NDArray> {
// C parity (NDArrayPool.cpp:620-625): cannot convert compressed data.
if src.codec.is_some() {
return Err(ADError::UnsupportedConversion(
"convert_type: cannot convert compressed (codec) data".into(),
));
}
if src.data.data_type() == target_type {
return self.alloc_copy(src);
}
// Allocate the output through the pool so it counts against
// allocated_bytes / num_alloc_buffers.
let mut out = self.alloc(src.dims.clone(), target_type)?;
let converted = crate::color::convert_data_type(src, target_type)?;
out.data = converted.data;
out.time_stamp = src.time_stamp;
out.timestamp = src.timestamp;
out.attributes.copy_from(&src.attributes);
Ok(out)
}
/// Full convert with dimension changes: extract sub-region, bin, reverse.
/// `dims_out` specifies offset/size/binning/reverse for each dimension.
/// Allocates from pool with output dimensions.
///
/// Matches the C++ `NDArrayPool::convert()` semantics:
/// - Output size for each dim = `dims_out[i].size / dims_out[i].binning`
/// - Source pixels are summed (not averaged) across each binning window
/// - Reverse flips the output along that dimension
/// - Cumulative offset: `out.dims[i].offset = src.dims[i].offset + dims_out[i].offset`
/// - Cumulative binning: `out.dims[i].binning = src.dims[i].binning * dims_out[i].binning`
pub fn convert(
&self,
src: &NDArray,
dims_out: &[NDDimension],
target_type: NDDataType,
) -> ADResult<NDArray> {
// C parity (NDArrayPool.cpp:620-625): cannot convert compressed data.
if src.codec.is_some() {
return Err(ADError::UnsupportedConversion(
"convert: cannot convert compressed (codec) data".into(),
));
}
let ndims = src.dims.len();
if dims_out.len() != ndims {
return Err(ADError::InvalidDimensions(format!(
"convert: dims_out length {} != source ndims {}",
dims_out.len(),
ndims,
)));
}
// Compute output sizes and validate
let mut out_sizes = Vec::with_capacity(ndims);
for (i, d) in dims_out.iter().enumerate() {
let bin = d.binning.max(1);
if d.size == 0 {
return Err(ADError::InvalidDimensions(format!(
"convert: dims_out[{}].size is 0",
i,
)));
}
let out_size = d.size / bin;
if out_size == 0 {
return Err(ADError::InvalidDimensions(format!(
"convert: dims_out[{}] size {} / binning {} = 0",
i, d.size, bin,
)));
}
// Validate that offset + size fits within source dimension
if d.offset + d.size > src.dims[i].size {
return Err(ADError::InvalidDimensions(format!(
"convert: dims_out[{}] offset {} + size {} > src dim size {}",
i, d.offset, d.size, src.dims[i].size,
)));
}
out_sizes.push(out_size);
}
let src_type = src.data.data_type();
// Build output dimension metadata.
// C++ NDArrayPool.cpp:719-724 makes `reverse` cumulative:
// if (pIn->dims[i].reverse) pOut->dims[i].reverse = !pOut->dims[i].reverse;
// i.e. out.reverse = dims_out[i].reverse XOR src.dims[i].reverse.
let mut out_dims = Vec::with_capacity(ndims);
for i in 0..ndims {
let bin = dims_out[i].binning.max(1);
out_dims.push(NDDimension {
size: out_sizes[i],
offset: src.dims[i].offset + dims_out[i].offset,
binning: src.dims[i].binning * bin,
reverse: dims_out[i].reverse ^ src.dims[i].reverse,
});
}
let total_out: usize = out_sizes.iter().product();
// Precompute source strides (row-major: dim[0] varies fastest)
let mut src_strides = vec![1usize; ndims];
for i in 1..ndims {
src_strides[i] = src_strides[i - 1] * src.dims[i - 1].size;
}
// Precompute output strides
let mut out_strides = vec![1usize; ndims];
for i in 1..ndims {
out_strides[i] = out_strides[i - 1] * out_sizes[i - 1];
}
// Macro to handle binning/offset/reverse for a specific typed buffer
macro_rules! convert_buf {
($src_vec:expr, $T:ty, $zero:expr, $variant:ident) => {{
let mut out = vec![$zero; total_out];
// Iterate over all output pixels
for out_idx in 0..total_out {
// Decompose flat output index into per-dim coordinates
let mut remaining = out_idx;
let mut out_coords = [0usize; 10]; // up to 10 dims
for i in (0..ndims).rev() {
out_coords[i] = remaining / out_strides[i];
remaining %= out_strides[i];
}
// Apply reverse: flip coordinate in output space
let mut eff_coords = [0usize; 10];
for i in 0..ndims {
eff_coords[i] = if dims_out[i].reverse {
out_sizes[i] - 1 - out_coords[i]
} else {
out_coords[i]
};
}
// Sum over binning window
let mut sum = 0.0f64;
let bin_total: usize = dims_out.iter().map(|d| d.binning.max(1)).product();
// Iterate over all bin offsets
for bin_flat in 0..bin_total {
let mut br = bin_flat;
let mut src_flat = 0usize;
let mut valid = true;
for i in (0..ndims).rev() {
let bin = dims_out[i].binning.max(1);
let bin_off = br % bin;
br /= bin;
let src_coord = dims_out[i].offset + eff_coords[i] * bin + bin_off;
if src_coord >= src.dims[i].size {
valid = false;
break;
}
src_flat += src_coord * src_strides[i];
}
if valid {
sum += $src_vec[src_flat] as f64;
}
}
out[out_idx] = sum as $T;
}
NDDataBuffer::$variant(out)
}};
}
let out_data = match &src.data {
NDDataBuffer::I8(v) => convert_buf!(v, i8, 0i8, I8),
NDDataBuffer::U8(v) => convert_buf!(v, u8, 0u8, U8),
NDDataBuffer::I16(v) => convert_buf!(v, i16, 0i16, I16),
NDDataBuffer::U16(v) => convert_buf!(v, u16, 0u16, U16),
NDDataBuffer::I32(v) => convert_buf!(v, i32, 0i32, I32),
NDDataBuffer::U32(v) => convert_buf!(v, u32, 0u32, U32),
NDDataBuffer::I64(v) => convert_buf!(v, i64, 0i64, I64),
NDDataBuffer::U64(v) => convert_buf!(v, u64, 0u64, U64),
NDDataBuffer::F32(v) => convert_buf!(v, f32, 0.0f32, F32),
NDDataBuffer::F64(v) => convert_buf!(v, f64, 0.0f64, F64),
};
// Allocate the output array THROUGH the pool so it counts against
// allocated_bytes / num_alloc_buffers and can be reused via the free
// list (C parity: C++ convert calls alloc() for its output).
let mut arr = self.alloc(out_dims, target_type)?;
arr.timestamp = src.timestamp;
arr.time_stamp = src.time_stamp;
arr.attributes.copy_from(&src.attributes);
// `out_data` holds the binned result in the SOURCE type. If the target
// type differs, convert; otherwise install it directly.
if target_type != src_type {
let staging = NDArray::new(arr.dims.clone(), src_type);
let mut staging = staging;
staging.data = out_data;
let converted = crate::color::convert_data_type(&staging, target_type)?;
arr.data = converted.data;
} else {
arr.data = out_data;
}
Ok(arr)
}
/// Produce a diagnostic text dump (matching C++ `NDArrayPool::report`).
///
/// `details > 5` additionally lists the free-list entries.
pub fn report(&self, details: i32) -> String {
let mut out = String::new();
out.push('\n');
out.push_str("NDArrayPool:\n");
out.push_str(&format!(
" numBuffers={}, numFree={}\n",
self.num_alloc_buffers(),
self.num_free_buffers()
));
out.push_str(&format!(
" memorySize={}, maxMemory={}\n",
self.allocated_bytes(),
self.max_memory
));
if details > 5 {
let free = self.free_list.lock();
out.push_str(" freeList: (index, dataSize, capacity)\n");
for (i, arr) in free.iter().enumerate() {
out.push_str(&format!(
" {} {} {}\n",
i,
arr.data_size,
arr.data.capacity_bytes()
));
}
if details > 10 {
for arr in free.iter() {
out.push_str(&arr.report(details));
}
}
}
out
}
}
// Compile-time check: NDArrayPool is Send + Sync
const _: fn() = || {
fn assert_send_sync<T: Send + Sync>() {}
assert_send_sync::<NDArrayPool>();
};
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_alloc_auto_id() {
let pool = NDArrayPool::new(1_000_000);
let a1 = pool
.alloc(vec![NDDimension::new(10)], NDDataType::UInt8)
.unwrap();
let a2 = pool
.alloc(vec![NDDimension::new(10)], NDDataType::UInt8)
.unwrap();
assert_eq!(a1.unique_id, 1);
assert_eq!(a2.unique_id, 2);
}
#[test]
fn test_alloc_tracks_bytes() {
let pool = NDArrayPool::new(1_000_000);
let _ = pool
.alloc(vec![NDDimension::new(100)], NDDataType::Float64)
.unwrap();
assert!(pool.allocated_bytes() >= 800);
}
#[test]
fn test_alloc_exceeds_max() {
let pool = NDArrayPool::new(100);
let result = pool.alloc(vec![NDDimension::new(200)], NDDataType::UInt8);
assert!(result.is_err());
}
#[test]
fn test_alloc_copy_preserves_data() {
let pool = NDArrayPool::new(1_000_000);
let mut source = pool
.alloc(vec![NDDimension::new(4)], NDDataType::UInt8)
.unwrap();
if let NDDataBuffer::U8(ref mut v) = source.data {
v[0] = 1;
v[1] = 2;
v[2] = 3;
v[3] = 4;
}
let copy = pool.alloc_copy(&source).unwrap();
assert_ne!(copy.unique_id, source.unique_id);
assert_eq!(copy.dims.len(), source.dims.len());
if let NDDataBuffer::U8(ref v) = copy.data {
assert_eq!(v, &[1, 2, 3, 4]);
} else {
panic!("wrong type");
}
}
#[test]
fn test_alloc_copy_tracks_bytes() {
let pool = NDArrayPool::new(1_000_000);
let source = pool
.alloc(vec![NDDimension::new(10)], NDDataType::UInt16)
.unwrap();
assert_eq!(pool.allocated_bytes(), 20);
let _ = pool.alloc_copy(&source).unwrap();
assert!(pool.allocated_bytes() >= 40);
}
#[test]
fn test_alloc_copy_exceeds_max() {
let pool = NDArrayPool::new(60);
let source = pool
.alloc(vec![NDDimension::new(50)], NDDataType::UInt8)
.unwrap();
assert!(pool.alloc_copy(&source).is_err());
}
// --- Free-list reuse tests ---
#[test]
fn test_release_and_reuse() {
let pool = NDArrayPool::new(1_000_000);
let arr = pool
.alloc(vec![NDDimension::new(100)], NDDataType::UInt8)
.unwrap();
let _alloc_bytes_after_first = pool.allocated_bytes();
assert_eq!(pool.num_alloc_buffers(), 1);
// Release back to free list
pool.release(arr);
assert_eq!(pool.num_free_buffers(), 1);
// Alloc again — reuse within 1.5x ratio
let arr2 = pool
.alloc(vec![NDDimension::new(80)], NDDataType::UInt8)
.unwrap();
assert_eq!(arr2.data.len(), 80);
}
#[test]
fn test_free_list_prefers_smallest_sufficient() {
let pool = NDArrayPool::new(10_000_000);
let small = pool
.alloc(vec![NDDimension::new(100)], NDDataType::UInt8)
.unwrap();
let large = pool
.alloc(vec![NDDimension::new(10000)], NDDataType::UInt8)
.unwrap();
let medium = pool
.alloc(vec![NDDimension::new(1000)], NDDataType::UInt8)
.unwrap();
pool.release(large);
pool.release(medium);
pool.release(small);
assert_eq!(pool.num_free_buffers(), 3);
// Request 900 bytes — medium (1000 cap) is within 1.5x ratio
let reused = pool
.alloc(vec![NDDimension::new(900)], NDDataType::UInt8)
.unwrap();
assert!(reused.data.capacity_bytes() >= 900);
}
#[test]
fn test_empty_free_list() {
let pool = NDArrayPool::new(1_000_000);
let a1 = pool
.alloc(vec![NDDimension::new(100)], NDDataType::UInt8)
.unwrap();
let a2 = pool
.alloc(vec![NDDimension::new(200)], NDDataType::UInt8)
.unwrap();
pool.release(a1);
pool.release(a2);
assert_eq!(pool.num_free_buffers(), 2);
pool.empty_free_list();
assert_eq!(pool.num_free_buffers(), 0);
assert_eq!(pool.num_alloc_buffers(), 0);
}
#[test]
fn test_num_free_buffers_tracking() {
let pool = NDArrayPool::new(1_000_000);
assert_eq!(pool.num_free_buffers(), 0);
let a = pool
.alloc(vec![NDDimension::new(10)], NDDataType::UInt8)
.unwrap();
assert_eq!(pool.num_free_buffers(), 0);
pool.release(a);
assert_eq!(pool.num_free_buffers(), 1);
let _ = pool
.alloc(vec![NDDimension::new(10)], NDDataType::UInt8)
.unwrap();
assert_eq!(pool.num_free_buffers(), 0);
}
#[test]
fn test_concurrent_alloc_release() {
use std::sync::Arc;
use std::thread;
let pool = Arc::new(NDArrayPool::new(10_000_000));
let mut handles = Vec::new();
for _ in 0..4 {
let pool = pool.clone();
handles.push(thread::spawn(move || {
for _ in 0..100 {
let arr = pool
.alloc(vec![NDDimension::new(100)], NDDataType::UInt8)
.unwrap();
pool.release(arr);
}
}));
}
for h in handles {
h.join().unwrap();
}
// All should be released back
assert!(pool.num_free_buffers() > 0);
}
#[test]
fn test_max_memory() {
let pool = NDArrayPool::new(42);
assert_eq!(pool.max_memory(), 42);
}
// --- convert_type tests ---
#[test]
fn test_convert_type_same_type() {
let pool = NDArrayPool::new(1_000_000);
let mut src = NDArray::new(vec![NDDimension::new(4)], NDDataType::UInt8);
if let NDDataBuffer::U8(ref mut v) = src.data {
v[0] = 10;
v[1] = 20;
v[2] = 30;
v[3] = 40;
}
let out = pool.convert_type(&src, NDDataType::UInt8).unwrap();
assert_eq!(out.data.data_type(), NDDataType::UInt8);
if let NDDataBuffer::U8(ref v) = out.data {
assert_eq!(v, &[10, 20, 30, 40]);
} else {
panic!("wrong type");
}
}
#[test]
fn test_convert_type_u8_to_f32() {
let pool = NDArrayPool::new(1_000_000);
let mut src = NDArray::new(vec![NDDimension::new(3)], NDDataType::UInt8);
if let NDDataBuffer::U8(ref mut v) = src.data {
v[0] = 0;
v[1] = 128;
v[2] = 255;
}
let out = pool.convert_type(&src, NDDataType::Float32).unwrap();
assert_eq!(out.data.data_type(), NDDataType::Float32);
if let NDDataBuffer::F32(ref v) = out.data {
assert_eq!(v[0], 0.0);
assert_eq!(v[1], 128.0);
assert_eq!(v[2], 255.0);
} else {
panic!("wrong type");
}
}
#[test]
fn test_convert_type_u16_to_u8() {
let pool = NDArrayPool::new(1_000_000);
let mut src = NDArray::new(vec![NDDimension::new(2)], NDDataType::UInt16);
if let NDDataBuffer::U16(ref mut v) = src.data {
v[0] = 100;
v[1] = 300; // clamps to 255
}
let out = pool.convert_type(&src, NDDataType::UInt8).unwrap();
if let NDDataBuffer::U8(ref v) = out.data {
assert_eq!(v[0], 100);
assert_eq!(v[1], 255); // clamped
} else {
panic!("wrong type");
}
}
// --- convert tests ---
/// Helper: create a 4x4 UInt8 array with values 0..15.
fn make_4x4_u8() -> NDArray {
let mut arr = NDArray::new(
vec![NDDimension::new(4), NDDimension::new(4)],
NDDataType::UInt8,
);
if let NDDataBuffer::U8(ref mut v) = arr.data {
for i in 0..16 {
v[i] = i as u8;
}
}
arr
}
#[test]
fn test_convert_identity() {
// Identity conversion: no offset, no binning, no reverse
let pool = NDArrayPool::new(1_000_000);
let src = make_4x4_u8();
let dims_out = vec![
NDDimension {
size: 4,
offset: 0,
binning: 1,
reverse: false,
},
NDDimension {
size: 4,
offset: 0,
binning: 1,
reverse: false,
},
];
let out = pool.convert(&src, &dims_out, NDDataType::UInt8).unwrap();
assert_eq!(out.dims[0].size, 4);
assert_eq!(out.dims[1].size, 4);
if let NDDataBuffer::U8(ref v) = out.data {
for i in 0..16 {
assert_eq!(v[i], i as u8);
}
} else {
panic!("wrong type");
}
}
#[test]
fn test_convert_offset_extraction() {
// Extract 2x2 sub-region starting at offset (1, 1)
let pool = NDArrayPool::new(1_000_000);
let src = make_4x4_u8();
let dims_out = vec![
NDDimension {
size: 2,
offset: 1,
binning: 1,
reverse: false,
},
NDDimension {
size: 2,
offset: 1,
binning: 1,
reverse: false,
},
];
let out = pool.convert(&src, &dims_out, NDDataType::UInt8).unwrap();
assert_eq!(out.dims[0].size, 2);
assert_eq!(out.dims[1].size, 2);
// Source layout (row-major, dim0=x fastest):
// row0: [0,1,2,3], row1: [4,5,6,7], row2: [8,9,10,11], row3: [12,13,14,15]
// offset (1,1) -> src[1+1*4]=5, src[2+1*4]=6, src[1+2*4]=9, src[2+2*4]=10
if let NDDataBuffer::U8(ref v) = out.data {
assert_eq!(v[0], 5);
assert_eq!(v[1], 6);
assert_eq!(v[2], 9);
assert_eq!(v[3], 10);
} else {
panic!("wrong type");
}
// Verify cumulative offset tracking
assert_eq!(out.dims[0].offset, 1); // src offset 0 + dims_out offset 1
assert_eq!(out.dims[1].offset, 1);
}
#[test]
fn test_convert_binning_2x2() {
// 4x4 -> 2x2 with 2x2 binning (sum)
let pool = NDArrayPool::new(1_000_000);
let src = make_4x4_u8();
let dims_out = vec![
NDDimension {
size: 4,
offset: 0,
binning: 2,
reverse: false,
},
NDDimension {
size: 4,
offset: 0,
binning: 2,
reverse: false,
},
];
let out = pool.convert(&src, &dims_out, NDDataType::UInt8).unwrap();
assert_eq!(out.dims[0].size, 2);
assert_eq!(out.dims[1].size, 2);
// top-left 2x2: sum = 0+1+4+5 = 10
// top-right 2x2: sum = 2+3+6+7 = 18
// bottom-left 2x2: sum = 8+9+12+13 = 42
// bottom-right 2x2: sum = 10+11+14+15 = 50
if let NDDataBuffer::U8(ref v) = out.data {
assert_eq!(v[0], 10);
assert_eq!(v[1], 18);
assert_eq!(v[2], 42);
assert_eq!(v[3], 50);
} else {
panic!("wrong type");
}
// Verify cumulative binning
assert_eq!(out.dims[0].binning, 2); // src binning 1 * dims_out binning 2
assert_eq!(out.dims[1].binning, 2);
}
#[test]
fn test_convert_reverse_x() {
// 4x1 with X-reverse
let pool = NDArrayPool::new(1_000_000);
let mut src = NDArray::new(
vec![NDDimension::new(4), NDDimension::new(1)],
NDDataType::UInt8,
);
if let NDDataBuffer::U8(ref mut v) = src.data {
v[0] = 10;
v[1] = 20;
v[2] = 30;
v[3] = 40;
}
let dims_out = vec![
NDDimension {
size: 4,
offset: 0,
binning: 1,
reverse: true,
},
NDDimension {
size: 1,
offset: 0,
binning: 1,
reverse: false,
},
];
let out = pool.convert(&src, &dims_out, NDDataType::UInt8).unwrap();
if let NDDataBuffer::U8(ref v) = out.data {
assert_eq!(v[0], 40);
assert_eq!(v[1], 30);
assert_eq!(v[2], 20);
assert_eq!(v[3], 10);
} else {
panic!("wrong type");
}
}
#[test]
fn test_convert_reverse_y() {
// 2x2 with Y-reverse
let pool = NDArrayPool::new(1_000_000);
let mut src = NDArray::new(
vec![NDDimension::new(2), NDDimension::new(2)],
NDDataType::UInt16,
);
if let NDDataBuffer::U16(ref mut v) = src.data {
// row0: [1, 2], row1: [3, 4]
v[0] = 1;
v[1] = 2;
v[2] = 3;
v[3] = 4;
}
let dims_out = vec![
NDDimension {
size: 2,
offset: 0,
binning: 1,
reverse: false,
},
NDDimension {
size: 2,
offset: 0,
binning: 1,
reverse: true,
},
];
let out = pool.convert(&src, &dims_out, NDDataType::UInt16).unwrap();
if let NDDataBuffer::U16(ref v) = out.data {
// Y reversed: row0 now has row1 data, row1 has row0 data
assert_eq!(v[0], 3);
assert_eq!(v[1], 4);
assert_eq!(v[2], 1);
assert_eq!(v[3], 2);
} else {
panic!("wrong type");
}
}
#[test]
fn test_convert_with_type_change() {
// Convert 4x4 UInt8 -> Float32, with 2x2 binning
let pool = NDArrayPool::new(1_000_000);
let src = make_4x4_u8();
let dims_out = vec![
NDDimension {
size: 4,
offset: 0,
binning: 2,
reverse: false,
},
NDDimension {
size: 4,
offset: 0,
binning: 2,
reverse: false,
},
];
let out = pool.convert(&src, &dims_out, NDDataType::Float32).unwrap();
assert_eq!(out.data.data_type(), NDDataType::Float32);
assert_eq!(out.dims[0].size, 2);
assert_eq!(out.dims[1].size, 2);
if let NDDataBuffer::F32(ref v) = out.data {
assert_eq!(v[0], 10.0); // 0+1+4+5
assert_eq!(v[1], 18.0); // 2+3+6+7
} else {
panic!("wrong type");
}
}
#[test]
fn test_convert_cumulative_offset_and_binning() {
// Source with existing offset=10, binning=2
let pool = NDArrayPool::new(1_000_000);
let mut src = NDArray::new(
vec![NDDimension::new(4), NDDimension::new(4)],
NDDataType::UInt8,
);
src.dims[0].offset = 10;
src.dims[0].binning = 2;
src.dims[1].offset = 20;
src.dims[1].binning = 3;
if let NDDataBuffer::U8(ref mut v) = src.data {
for i in 0..16 {
v[i] = i as u8;
}
}
let dims_out = vec![
NDDimension {
size: 2,
offset: 1,
binning: 2,
reverse: false,
},
NDDimension {
size: 2,
offset: 1,
binning: 2,
reverse: false,
},
];
let out = pool.convert(&src, &dims_out, NDDataType::UInt8).unwrap();
// Cumulative offset: src.offset + dims_out.offset
assert_eq!(out.dims[0].offset, 10 + 1);
assert_eq!(out.dims[1].offset, 20 + 1);
// Cumulative binning: src.binning * dims_out.binning
assert_eq!(out.dims[0].binning, 2 * 2);
assert_eq!(out.dims[1].binning, 3 * 2);
}
#[test]
fn test_convert_1d() {
// 1D: 8 elements, offset=2, size=4, binning=2 -> 2 output elements
let pool = NDArrayPool::new(1_000_000);
let mut src = NDArray::new(vec![NDDimension::new(8)], NDDataType::UInt16);
if let NDDataBuffer::U16(ref mut v) = src.data {
for i in 0..8 {
v[i] = (i * 10) as u16;
}
// [0, 10, 20, 30, 40, 50, 60, 70]
}
let dims_out = vec![NDDimension {
size: 4,
offset: 2,
binning: 2,
reverse: false,
}];
let out = pool.convert(&src, &dims_out, NDDataType::UInt16).unwrap();
assert_eq!(out.dims.len(), 1);
assert_eq!(out.dims[0].size, 2);
if let NDDataBuffer::U16(ref v) = out.data {
// offset=2: src[2]=20, src[3]=30 -> sum=50
// next: src[4]=40, src[5]=50 -> sum=90
assert_eq!(v[0], 50);
assert_eq!(v[1], 90);
} else {
panic!("wrong type");
}
}
#[test]
fn test_convert_3d() {
// 3D: 2x2x2 with identity dims -> should copy exactly
let pool = NDArrayPool::new(1_000_000);
let mut src = NDArray::new(
vec![
NDDimension::new(2),
NDDimension::new(2),
NDDimension::new(2),
],
NDDataType::UInt8,
);
if let NDDataBuffer::U8(ref mut v) = src.data {
for i in 0..8 {
v[i] = (i + 1) as u8;
}
}
let dims_out = vec![
NDDimension {
size: 2,
offset: 0,
binning: 1,
reverse: false,
},
NDDimension {
size: 2,
offset: 0,
binning: 1,
reverse: false,
},
NDDimension {
size: 2,
offset: 0,
binning: 1,
reverse: false,
},
];
let out = pool.convert(&src, &dims_out, NDDataType::UInt8).unwrap();
if let NDDataBuffer::U8(ref v) = out.data {
for i in 0..8 {
assert_eq!(v[i], (i + 1) as u8);
}
} else {
panic!("wrong type");
}
}
#[test]
fn test_convert_dim_mismatch_error() {
let pool = NDArrayPool::new(1_000_000);
let src = make_4x4_u8();
// Wrong number of dims_out
let dims_out = vec![NDDimension {
size: 4,
offset: 0,
binning: 1,
reverse: false,
}];
let result = pool.convert(&src, &dims_out, NDDataType::UInt8);
assert!(result.is_err());
}
#[test]
fn test_convert_offset_out_of_bounds_error() {
let pool = NDArrayPool::new(1_000_000);
let src = make_4x4_u8();
let dims_out = vec![
NDDimension {
size: 4,
offset: 2,
binning: 1,
reverse: false,
}, // 2+4 > 4
NDDimension {
size: 4,
offset: 0,
binning: 1,
reverse: false,
},
];
let result = pool.convert(&src, &dims_out, NDDataType::UInt8);
assert!(result.is_err());
}
#[test]
fn test_convert_preserves_metadata() {
let pool = NDArrayPool::new(1_000_000);
let mut src = make_4x4_u8();
src.time_stamp = 12345.678;
let dims_out = vec![
NDDimension {
size: 4,
offset: 0,
binning: 1,
reverse: false,
},
NDDimension {
size: 4,
offset: 0,
binning: 1,
reverse: false,
},
];
let out = pool.convert(&src, &dims_out, NDDataType::UInt8).unwrap();
assert_eq!(out.time_stamp, 12345.678);
}
#[test]
fn test_convert_binning_and_reverse_combined() {
// 4x1, binning=2, reverse=true
let pool = NDArrayPool::new(1_000_000);
let mut src = NDArray::new(vec![NDDimension::new(4)], NDDataType::UInt16);
if let NDDataBuffer::U16(ref mut v) = src.data {
v[0] = 1;
v[1] = 2;
v[2] = 3;
v[3] = 4;
}
let dims_out = vec![NDDimension {
size: 4,
offset: 0,
binning: 2,
reverse: true,
}];
let out = pool.convert(&src, &dims_out, NDDataType::UInt16).unwrap();
assert_eq!(out.dims[0].size, 2);
if let NDDataBuffer::U16(ref v) = out.data {
// Without reverse: [1+2, 3+4] = [3, 7]
// With reverse: output[0] reads from high end, output[1] from low end
// eff_coords[0] for out_coord=0 with reverse => size-1-0 = 1 -> src[2..3] = 3+4 = 7
// eff_coords[0] for out_coord=1 with reverse => size-1-1 = 0 -> src[0..1] = 1+2 = 3
assert_eq!(v[0], 7);
assert_eq!(v[1], 3);
} else {
panic!("wrong type");
}
}
// --- Regression tests for review fixes ---
/// B1: output `reverse` must be cumulative — `dims_out.reverse XOR src.reverse`.
#[test]
fn test_convert_reverse_flag_cumulative() {
let pool = NDArrayPool::new(1_000_000);
let mut src = NDArray::new(vec![NDDimension::new(4)], NDDataType::UInt8);
src.dims[0].reverse = true; // source already reversed
// dims_out also requests reverse: true XOR true = false.
let dims_out = vec![NDDimension {
size: 4,
offset: 0,
binning: 1,
reverse: true,
}];
let out = pool.convert(&src, &dims_out, NDDataType::UInt8).unwrap();
assert!(!out.dims[0].reverse, "true XOR true must be false");
// dims_out reverse false: false XOR true = true.
let dims_out2 = vec![NDDimension {
size: 4,
offset: 0,
binning: 1,
reverse: false,
}];
let out2 = pool.convert(&src, &dims_out2, NDDataType::UInt8).unwrap();
assert!(out2.dims[0].reverse, "false XOR true must be true");
}
/// B3: pool accounting tracks the EXACT requested byte count, not Vec capacity.
#[test]
fn test_alloc_tracks_exact_data_size() {
let pool = NDArrayPool::new(0); // unlimited
let a = pool
.alloc(vec![NDDimension::new(333)], NDDataType::UInt16)
.unwrap();
// 333 * 2 = 666 — exact, no allocator capacity slack.
assert_eq!(a.data_size, 666);
assert_eq!(pool.allocated_bytes(), 666);
}
/// B3: a single allocation cannot push `allocated_bytes` past `max_memory`.
#[test]
fn test_alloc_strict_max_memory_enforcement() {
let pool = NDArrayPool::new(1000);
// 600 bytes — fits.
let _a = pool
.alloc(vec![NDDimension::new(600)], NDDataType::UInt8)
.unwrap();
assert_eq!(pool.allocated_bytes(), 600);
// 500 more would total 1100 > 1000 — must be rejected.
let r = pool.alloc(vec![NDDimension::new(500)], NDDataType::UInt8);
assert!(r.is_err());
assert!(pool.allocated_bytes() <= 1000);
}
/// B6/B7: `convert` output is pool-tracked; releasing it accounts consistently.
#[test]
fn test_convert_output_is_pool_tracked() {
let pool = NDArrayPool::new(1_000_000);
let src = make_4x4_u8();
let before_alloc = pool.num_alloc_buffers();
let dims_out = vec![
NDDimension {
size: 4,
offset: 0,
binning: 1,
reverse: false,
},
NDDimension {
size: 4,
offset: 0,
binning: 1,
reverse: false,
},
];
let out = pool.convert(&src, &dims_out, NDDataType::UInt8).unwrap();
assert_eq!(out.pool_id, pool.id());
assert_eq!(out.data_size, 16);
// convert allocated a fresh buffer through the pool.
assert_eq!(pool.num_alloc_buffers(), before_alloc + 1);
let bytes_with_out = pool.allocated_bytes();
assert_eq!(bytes_with_out, 16);
// Releasing it returns the exact data_size to the free list — no drift.
pool.release(out);
assert_eq!(pool.num_free_buffers(), 1);
assert_eq!(pool.allocated_bytes(), 16);
}
/// B8: `convert` / `convert_type` reject compressed input.
#[test]
fn test_convert_rejects_compressed_input() {
let pool = NDArrayPool::new(1_000_000);
let mut src = make_4x4_u8();
src.codec = Some(crate::codec::Codec {
name: crate::codec::CodecName::LZ4,
compressed_size: 4,
level: 0,
shuffle: 0,
compressor: 0,
});
let dims_out = vec![
NDDimension {
size: 4,
offset: 0,
binning: 1,
reverse: false,
},
NDDimension {
size: 4,
offset: 0,
binning: 1,
reverse: false,
},
];
assert!(pool.convert(&src, &dims_out, NDDataType::UInt8).is_err());
assert!(pool.convert_type(&src, NDDataType::UInt16).is_err());
}
/// G1: `release` of a foreign array must not corrupt this pool's accounting.
#[test]
fn test_release_foreign_array_rejected() {
let pool_a = NDArrayPool::new(1_000_000);
let pool_b = NDArrayPool::new(1_000_000);
let arr = pool_a
.alloc(vec![NDDimension::new(100)], NDDataType::UInt8)
.unwrap();
let bytes_b_before = pool_b.allocated_bytes();
let free_b_before = pool_b.num_free_buffers();
// Release pool A's array into pool B — must be rejected.
pool_b.release(arr);
assert_eq!(pool_b.allocated_bytes(), bytes_b_before);
assert_eq!(pool_b.num_free_buffers(), free_b_before);
}
/// G1: a non-pool array (pool_id == 0) is also rejected by `release`.
#[test]
fn test_release_non_pool_array_rejected() {
let pool = NDArrayPool::new(1_000_000);
let arr = NDArray::new(vec![NDDimension::new(10)], NDDataType::UInt8);
assert_eq!(arr.pool_id, 0);
pool.release(arr);
assert_eq!(pool.num_free_buffers(), 0);
assert_eq!(pool.allocated_bytes(), 0);
}
/// G2: `copy` into a fresh array copies data, dims, type.
#[test]
fn test_copy_allocates_and_copies() {
let pool = NDArrayPool::new(1_000_000);
let mut src = NDArray::new(vec![NDDimension::new(4)], NDDataType::UInt8);
if let NDDataBuffer::U8(ref mut v) = src.data {
v.copy_from_slice(&[9, 8, 7, 6]);
}
let out = pool.copy(&src, None, true, true, true).unwrap();
assert_eq!(out.pool_id, pool.id());
assert_eq!(out.dims.len(), 1);
if let NDDataBuffer::U8(ref v) = out.data {
assert_eq!(v, &[9, 8, 7, 6]);
} else {
panic!("wrong type");
}
}
/// G2: `pre_allocate_buffers` warms the free list with reusable buffers.
#[test]
fn test_pre_allocate_buffers_warms_free_list() {
let pool = NDArrayPool::new(10_000_000);
let template = pool
.alloc(vec![NDDimension::new(256)], NDDataType::UInt16)
.unwrap();
pool.pre_allocate_buffers(&template, 3).unwrap();
assert_eq!(pool.num_free_buffers(), 3);
}
/// BUG 1 regression: concurrent reuse-grow must not overshoot
/// `max_memory`.
///
/// Many threads each take a small free-list buffer and grow it (a
/// reuse-grow). The non-atomic load+fetch_add this test guards against
/// let two threads both pass the limit check on the same `current`
/// reading and both increment, pushing `allocated_bytes` past
/// `max_memory`. With the CAS loop, the invariant
/// `allocated_bytes <= max_memory` must hold after every successful
/// alloc.
#[test]
fn test_concurrent_reuse_grow_does_not_overshoot_max_memory() {
use std::sync::Arc;
use std::sync::atomic::AtomicBool;
use std::thread;
const N: usize = 16;
// Repeat to exercise the race window.
for _ in 0..50 {
// N free buffers, each tracked at data_size = 100 bytes:
// allocated_bytes = 1600. max_memory = 2000 leaves only 400 bytes
// of headroom. Each reuse-grow from 100 -> 200 bytes adds 100, so
// at most 4 of the N grows may succeed; the rest must be rejected.
// With a non-atomic load+fetch_add, more than 4 succeed and
// allocated_bytes overshoots 2000.
let pool = Arc::new(NDArrayPool::new(2000));
// Build N genuine reuse-grow candidates: each buffer is allocated
// and tracked at 100 bytes (data_size = 100) but its backing Vec is
// reserved to >= 200 bytes of capacity. A later 200-byte request
// then selects it (capacity 200 >= 200, within the 1.5x threshold)
// and takes the reuse-GROW branch (200 > old data_size 100). This
// makes the reuse-grow path deterministic regardless of allocator
// slack.
let mut warm = Vec::with_capacity(N);
for _ in 0..N {
let mut a = pool
.alloc(vec![NDDimension::new(100)], NDDataType::UInt8)
.unwrap();
// data_size stays 100 (pool accounting); only the Vec capacity
// grows. swap the buffer for one with len 100 but capacity 200.
if let NDDataBuffer::U8(ref mut v) = a.data {
let mut big = Vec::with_capacity(200);
big.resize(100, 0u8);
*v = big;
}
assert_eq!(a.data_size, 100);
assert!(a.data.capacity_bytes() >= 200);
warm.push(a);
}
for a in warm {
pool.release(a);
}
assert_eq!(pool.allocated_bytes(), 1600);
assert_eq!(pool.num_free_buffers(), N as u32);
let overshoot = Arc::new(AtomicBool::new(false));
let mut handles = Vec::new();
for _ in 0..N {
let pool = pool.clone();
let overshoot = overshoot.clone();
handles.push(thread::spawn(move || {
// Reuse a 100-byte free buffer, grow it to 200 bytes.
let res = pool.alloc(vec![NDDimension::new(200)], NDDataType::UInt8);
if res.is_ok() && pool.allocated_bytes() > pool.max_memory() as u64 {
overshoot.store(true, Ordering::Relaxed);
}
}));
}
for h in handles {
h.join().unwrap();
}
assert!(
!overshoot.load(Ordering::Relaxed),
"allocated_bytes overshot max_memory during concurrent reuse-grow"
);
assert!(
pool.allocated_bytes() <= pool.max_memory() as u64,
"final allocated_bytes {} > max_memory {}",
pool.allocated_bytes(),
pool.max_memory()
);
}
}
/// G11: `report` produces a non-empty diagnostic dump.
#[test]
fn test_pool_report_nonempty() {
let pool = NDArrayPool::new(1_000_000);
let _ = pool
.alloc(vec![NDDimension::new(10)], NDDataType::UInt8)
.unwrap();
let r = pool.report(10);
assert!(r.contains("NDArrayPool"));
assert!(r.contains("numBuffers"));
}
}