nixl-sys 1.0.1

Low-level bindings to the nixl library
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
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
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
// SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Raw FFI bindings to the NIXL library
//!
//! This crate provides low-level bindings to the NIXL C++ library.
//! It is not meant to be used directly, but rather through the higher-level
//! `nixl` crate.

use nixl_sys::*;
use std::env;
use std::collections::HashMap;
// Helper function to create an agent with error handling
fn create_test_agent(name: &str) -> Result<Agent, NixlError> {
    Agent::new(name)
}

fn setup_agent_with_backend(agent: &Agent) -> Result<OptArgs, NixlError> {
    let plugins = agent.get_available_plugins().expect("Failed to get available plugins");
    let plugin_name = find_plugin(&plugins, "UCX").expect("Failed to find plugin");
    let (_mems, params) = agent.get_plugin_params(&plugin_name).expect("Failed to get plugin params");
    agent.create_backend(&plugin_name, &params).expect("Failed to create backend");

    let mut opt_args = OptArgs::new().expect("Failed to create opt args");
    let _ = opt_args.add_backend(&agent.get_backend("UCX").unwrap());

    Ok(opt_args)
}

fn create_agent_with_backend(name: &str) -> Result<(Agent, OptArgs), NixlError> {
    let agent = Agent::new(name).expect("Failed to create agent");
    let plugins = agent.get_available_plugins().expect("Failed to get available plugins");
    let plugin_name = find_plugin(&plugins, "UCX").expect("Failed to find plugin");
    let (_mems, params) = agent.get_plugin_params(&plugin_name).expect("Failed to get plugin params");
    agent.create_backend(&plugin_name, &params).expect("Failed to create backend");

    let mut opt_args = OptArgs::new().expect("Failed to create opt args");
    let _ = opt_args.add_backend(&agent.get_backend("UCX").unwrap());

    Ok((agent, opt_args))
}

// Trait for testing common descriptor list operations
trait DescListTestTrait: PartialEq + std::fmt::Debug {
    fn new(mem_type: MemType) -> Result<Self, NixlError> where Self: Sized;
    fn add_desc(&mut self, addr: usize, len: usize, dev_id: u64);
    #[allow(dead_code)]
    fn len(&self) -> Result<usize, NixlError>;
}

impl<'a> DescListTestTrait for RegDescList<'a> {
    fn new(mem_type: MemType) -> Result<Self, NixlError> {
        RegDescList::new(mem_type)
    }

    fn add_desc(&mut self, addr: usize, len: usize, dev_id: u64) {
        RegDescList::add_desc(self, addr, len, dev_id)
    }

    fn len(&self) -> Result<usize, NixlError> {
        RegDescList::len(self)
    }
}

impl<'a> DescListTestTrait for XferDescList<'a> {
    fn new(mem_type: MemType) -> Result<Self, NixlError> {
        XferDescList::new(mem_type)
    }

    fn add_desc(&mut self, addr: usize, len: usize, dev_id: u64) {
        XferDescList::add_desc(self, addr, len, dev_id)
    }

    fn len(&self) -> Result<usize, NixlError> {
        XferDescList::len(self)
    }
}

fn create_storage_list(agent: &Agent, opt_args: &OptArgs, size: usize) -> Vec<SystemStorage> {
    let mut storage_list = Vec::new();
    for _ in 0..size {
        let mut storage = SystemStorage::new(1024).unwrap();
        storage.register(agent, Some(opt_args)).expect("Failed to register storage memory");
        storage.memset(0);
        agent.register_memory(&storage, Some(opt_args)).expect("Failed to register storage memory");
        storage_list.push(storage);
    }
    storage_list
}

fn create_dlist<'a>(storage_list: &'a mut Vec<SystemStorage>) -> Result<XferDescList<'a>, NixlError> {
    let mut dlist = XferDescList::new(MemType::Dram).expect("Failed to create XferDescList");
    for storage in storage_list.iter_mut() {
        dlist.add_storage_desc(storage).expect(&format!("Failed to add storage descriptor for storage"));
    }
    Ok(dlist)
}

fn exchange_metadata(agent1: &Agent, agent2: &Agent) -> Result<(), NixlError> {
    let metadata1 = agent1.get_local_md().expect("Failed to get local metadata");
    let metadata2 = agent2.get_local_md().expect("Failed to get local metadata");
    agent1.load_remote_md(&metadata2).expect("Failed to load remote metadata");
    agent2.load_remote_md(&metadata1).expect("Failed to load remote metadata");
    Ok(())
}

// Helper function to find a plugin by name
fn find_plugin(plugins: &StringList, name: &str) -> Result<String, NixlError> {
    plugins
        .iter()
        .filter_map(Result::ok)
        .find(|&plugin| plugin == name)
        .map(ToString::to_string)
        .or_else(|| plugins.get(0).ok().map(ToString::to_string))
        .ok_or(NixlError::InvalidParam)
}

/// Helper function to create and initialize a POSIX backend with optional arguments
/// Returns (backend, opt_args) if POSIX is available, or None if not available
fn create_posix_backend(agent: &Agent) -> Option<(Backend, OptArgs)> {
    // Get available plugins - check if POSIX is available
    let plugins = agent
        .get_available_plugins()
        .expect("Failed to get plugins");

    if !plugins
        .iter()
        .any(|p| p.as_ref().map(|s| *s == "POSIX").unwrap_or(false))
    {
        println!("POSIX plugin not available, skipping test");
        return None;
    }

    // Get plugin parameters and create POSIX backend
    let (_mems, params) = agent
        .get_plugin_params("POSIX")
        .expect("Failed to get POSIX plugin params");

    let backend = agent
        .create_backend("POSIX", &params)
        .expect("Failed to create POSIX backend");

    // Create optional arguments with the backend
    let mut opt_args = OptArgs::new().expect("Failed to create opt args");
    opt_args
        .add_backend(&backend)
        .expect("Failed to add backend");

    Some((backend, opt_args))
}

#[test]
fn create_agent_with_custom_config() {
    // Ensure we can construct with non-default config
    let cfg = AgentConfig {
        enable_listen_thread: true,
        listen_port: 0,
        capture_telemetry: false,
        ..Default::default()
    };

    let agent = Agent::new_configured("cfg_agent", &cfg)
        .expect("Failed to create configured agent");

    // basic sanity: can query available plugins
    let _plugins = agent.get_available_plugins().expect("Failed to get plugins");
}

#[test]
fn test_agent_creation() {
    let agent = Agent::new("test_agent").expect("Failed to create agent");
    drop(agent);
}

#[test]
fn test_agent_invalid_name() {
    let result = Agent::new("test\0agent");
    assert!(matches!(result, Err(NixlError::StringConversionError(_))));
}

#[test]
fn test_get_available_plugins() {
    let agent = Agent::new("test_agent").expect("Failed to create agent");
    let plugins = agent
        .get_available_plugins()
        .expect("Failed to get plugins");

    // Print available plugins
    for plugin in plugins.iter() {
        println!("Found plugin: {}", plugin.unwrap());
    }
}

#[test]
fn test_get_plugin_params() {
    let agent = Agent::new("test_agent").expect("Failed to create agent");
    let (_mems, _params) = agent
        .get_plugin_params("UCX")
        .expect("Failed to get plugin params");
    // MemList and Params will be automatically dropped here
}

#[test]
fn test_backend_creation() {
    let agent = Agent::new("test_agent").expect("Failed to create agent");
    let (_mems, params) = agent
        .get_plugin_params("UCX")
        .expect("Failed to get plugin params");
    let backend = agent
        .create_backend("UCX", &params)
        .expect("Failed to create backend");

    let mut opt_args = OptArgs::new().expect("Failed to create opt args");
    opt_args
        .add_backend(&backend)
        .expect("Failed to add backend");
}

#[test]
fn test_params_iteration() {
    let agent = Agent::new("test_agent").expect("Failed to create agent");
    let (mems, params) = agent
        .get_plugin_params("UCX")
        .expect("Failed to get plugin params");

    println!("Parameters:");
    if !params.is_empty().unwrap() {
        for result in params.iter().unwrap() {
            let (key, value) = result.unwrap();
            println!("  {} = {}", key, value);
        }
    } else {
        println!("  (empty)");
    }

    println!("Memory types:");
    if !mems.is_empty().unwrap() {
        for mem_type in mems.iter() {
            println!("  {}", mem_type.unwrap());
        }
    } else {
        println!("  (empty)");
    }
}

#[test]
fn test_params_from_iter() {
    use std::collections::HashMap;

    let map = HashMap::from([
        ("key1", "value1"),
        ("key2", "value2"),
        ("key3", "value3"),
    ]);

    let params = Params::from(&map).expect("Failed to create params from iterator");

    assert!(!params.is_empty().unwrap(), "Params should not be empty");

    let mut found_keys = HashMap::new();
    for result in params.iter().unwrap() {
        let (key, value) = result.unwrap();
        found_keys.insert(key.to_string(), value.to_string());
    }

    assert_eq!(found_keys.len(), 3, "Should have 3 key-value pairs");
    assert_eq!(found_keys.get("key1"), Some(&"value1".to_string()));
    assert_eq!(found_keys.get("key2"), Some(&"value2".to_string()));
    assert_eq!(found_keys.get("key3"), Some(&"value3".to_string()));
}

#[test]
fn test_params_clone() {
    let agent = Agent::new("test_agent").expect("Failed to create agent");
    let (_mems, original_params) = agent
        .get_plugin_params("UCX")
        .expect("Failed to get plugin params");

    let copied_params = original_params.clone()
        .expect("Failed to copy params");

    assert_eq!(
        original_params.is_empty().unwrap(),
        copied_params.is_empty().unwrap(),
        "Copied params should have same empty state"
    );

    let mut original_map = std::collections::HashMap::new();
    for result in original_params.iter().unwrap() {
        let (key, value) = result.unwrap();
        original_map.insert(key.to_string(), value.to_string());
    }

    let copied_map = HashMap::from(copied_params.iter().unwrap());
    assert_eq!(original_map, copied_map, "Copied params should match original");
}

// #[test]
// fn test_get_backend_params() {
//     let agent = Agent::new("test_agent").unwrap();
//     let plugins = agent.get_available_plugins().unwrap();
//     assert!(!plugins.is_empty().unwrap_or(false));

//     let plugin_name = plugins.get(0).unwrap();
//     let (_mems, params) = agent.get_plugin_params(plugin_name).unwrap();
//     let backend = agent.create_backend(plugin_name, &params).unwrap();

//     // Get backend params after initialization
//     let (backend_mems, backend_params) = agent.get_backend_params(&backend).unwrap();

//     // Verify we can access the parameters
//     let param_iter = backend_params.iter().unwrap();
//     for param in param_iter {
//         let param = param.unwrap();
//         println!("Backend param: {} = {}", param.key, param.value);
//     }

//     // Verify we can access the memory types
//     for mem_type in backend_mems.iter() {
//         println!("Backend memory type: {:?}", mem_type.unwrap());
//     }
// }

#[test]
fn test_get_backend_params() -> Result<(), NixlError> {
    let agent = create_test_agent("test_agent")?;
    let plugins = agent.get_available_plugins()?;

    // Ensure we have at least one plugin
    assert!(!plugins.is_empty()?);

    // Try UCX plugin first since it doesn't require GPU
    let plugin_name = find_plugin(&plugins, "UCX")?;
    let (_mems, params) = agent.get_plugin_params(&plugin_name)?;
    let backend = agent.create_backend(&plugin_name, &params)?;

    // Get backend params after initialization
    let (backend_mems, backend_params) = agent.get_backend_params(&backend)?;

    // Print parameters using iterator
    let param_iter = backend_params.iter()?;
    for (key, value) in param_iter.flatten() {
        println!("Backend param: {} = {}", key, value);
    }

    // Print memory types
    for mem_type in backend_mems.iter().flatten() {
        println!("Backend memory type: {:?}", mem_type);
    }

    Ok(())
}

#[test]
fn test_xfer_dlist() {
    let mut dlist = XferDescList::new(MemType::Dram).unwrap();

    // Add some descriptors
    dlist.add_desc(0x1000, 0x100, 0);
    dlist.add_desc(0x2000, 0x200, 1);

    // Check length
    assert_eq!(dlist.len().unwrap(), 2);

    // Clear list
    dlist.clear();
    assert_eq!(dlist.len().unwrap(), 0);

    // Resize list
    dlist.resize(5);
}

#[test]
fn test_reg_dlist() {
    let mut dlist = RegDescList::new(MemType::Dram).unwrap();

    // Add some descriptors
    dlist.add_desc(0x1000, 0x100, 0);
    dlist.add_desc(0x2000, 0x200, 1);

    // Check length
    assert_eq!(dlist.len().unwrap(), 2);

    // Clear list
    dlist.clear();
    assert_eq!(dlist.len().unwrap(), 0);

    // Resize list
    dlist.resize(5);
}

#[test]
fn test_storage_descriptor_lifetime() {
    // Create storage that outlives the descriptor list
    let storage = SystemStorage::new(1024).unwrap();

    {
        // Create a descriptor list with shorter lifetime
        let mut dlist = XferDescList::new(MemType::Dram).unwrap();
        dlist.add_storage_desc(&storage).unwrap();
        assert_eq!(dlist.len().unwrap(), 1);
        // dlist is dropped here, but storage is still valid
    }

    // MemoryRegion is still valid here
    assert_eq!(<SystemStorage as MemoryRegion>::size(&storage), 1024);
}

#[test]
fn test_multiple_storage_descriptors() {
    let storage1 = SystemStorage::new(1024).unwrap();
    let storage2 = SystemStorage::new(2048).unwrap();

    let mut dlist = XferDescList::new(MemType::Dram).unwrap();

    // Add multiple descriptors
    dlist.add_storage_desc(&storage1).unwrap();
    dlist.add_storage_desc(&storage2).unwrap();

    assert_eq!(dlist.len().unwrap(), 2);
}

#[test]
fn test_memory_registration() {
    let agent = Agent::new("test_agent").unwrap();
    let mut storage = SystemStorage::new(1024).unwrap();

    // Register memory
    storage.register(&agent, None).unwrap();

    // Verify we can still access the memory
    storage.memset(0xAA);
    assert!(storage.as_slice().iter().all(|&x| x == 0xAA));
}

#[test]
fn test_registration_handle_drop() {
    let agent = Agent::new("test_agent").unwrap();
    let mut storage = SystemStorage::new(1024).unwrap();

    // Register memory
    storage.register(&agent, None).unwrap();

    // Drop the storage, which should trigger deregistration
    drop(storage);

    // Create new storage to verify we can register again
    let mut new_storage = SystemStorage::new(1024).unwrap();
    new_storage.register(&agent, None).unwrap();
}

#[test]
fn test_multiple_registrations() {
    let agent = Agent::new("test_agent").unwrap();
    let mut storage1 = SystemStorage::new(1024).unwrap();
    let mut storage2 = SystemStorage::new(2048).unwrap();

    // Register both storages
    storage1.register(&agent, None).unwrap();
    storage2.register(&agent, None).unwrap();

    // Verify we can still access both memories
    storage1.memset(0xAA);
    storage2.memset(0xBB);
    assert!(storage1.as_slice().iter().all(|&x| x == 0xAA));
    assert!(storage2.as_slice().iter().all(|&x| x == 0xBB));
}

#[test]
fn test_make_connection_success() {
    let agent = Agent::new("test_agent").expect("Failed to create agent");
    let remote_agent = Agent::new("remote_agent").expect("Failed to create remote agent");
    let opt_args = setup_agent_with_backend(&agent).expect("Failed to setup agent");
    let _opt_args_remote = setup_agent_with_backend(&remote_agent).expect("Failed to setup agent");

    exchange_metadata(&agent, &remote_agent).expect("Failed to exchange metadata");

    // This should succeed if the agent is valid and the backend is set up
    let result = agent.make_connection(&remote_agent.name(), Some(&opt_args));

    assert!(
        result.is_ok(),
        "Expected Ok got: {:?}",
        result
    );
}

#[test]
fn test_make_connection_invalid_param() {
    let agent = Agent::new("test_agent").expect("Failed to create agent");
    // Null bytes in the name should trigger InvalidParam or StringConversionError
    let result = agent.make_connection("remote\0agent", None);
    assert!(
        matches!(result, Err(NixlError::StringConversionError(_))) ||
        matches!(result, Err(NixlError::InvalidParam)),
        "Expected StringConversionError or InvalidParam, got: {:?}",
        result
    );
}

#[test]
fn test_get_local_md() {
    let agent = Agent::new("test_agent").unwrap();

    // Get available plugins and print their names
    let plugins = agent.get_available_plugins().unwrap();
    for plugin in plugins.iter() {
        println!("Found plugin: {}", plugin.unwrap());
    }

    // Get plugin parameters for both agents
    let (_mem_list, params) = agent.get_plugin_params("UCX").unwrap();

    // Create backends for both agents
    let backend1 = agent.create_backend("UCX", &params).unwrap();

    let md = agent.get_local_md().unwrap();

    // Measure the size
    let initial_size = md.len();
    println!("Local metadata size: {}", initial_size);

    let mut opt_args = OptArgs::new().unwrap();
    opt_args.add_backend(&backend1).unwrap();

    let mut storages = Vec::new();

    for _i in 0..10 {
        // Register some memory regions
        let mut storage = SystemStorage::new(1024).unwrap();
        storage.register(&agent, Some(&opt_args)).unwrap();
        storages.push(storage);
    }

    let md = agent.get_local_md().unwrap();

    // Measure the size again
    let final_size = md.len();
    println!("Local metadata size: {}", final_size);

    // Check if the size has increased
    assert!(final_size > initial_size);
}

#[test]
fn test_metadata_exchange() {
    // Create two agents
    let agent2 = Agent::new("agent2").unwrap();
    let agent1 = Agent::new("agent1").unwrap();

    // Get plugin parameters for both agents
    let (_mem_list, params) = agent1.get_plugin_params("UCX").unwrap();

    // Create backends for both agents
    let _backend1 = agent1.create_backend("UCX", &params).unwrap();
    let _backend2 = agent2.create_backend("UCX", &params).unwrap();

    // Get metadata from agent1
    let md = agent1.get_local_md().unwrap();

    // Load metadata into agent2
    let remote_name = agent2.load_remote_md(&md).unwrap();
    assert_eq!(remote_name, "agent1");
}

#[test]
fn test_basic_agent_lifecycle() {
    // Create two agents
    let agent2 = Agent::new("A2").unwrap();
    let agent1 = Agent::new("A1").unwrap();

    // Get available plugins and print their names
    let plugins = agent1.get_available_plugins().unwrap();
    for plugin in plugins.iter() {
        println!("Found plugin: {}", plugin.unwrap());
    }

    // Get plugin parameters for both agents
    let (_mem_list1, _params) = agent1.get_plugin_params("UCX").unwrap();
    let (_mem_list2, params) = agent2.get_plugin_params("UCX").unwrap();

    // Create backends for both agents
    let backend1 = agent1.create_backend("UCX", &params).unwrap();
    let backend2 = agent2.create_backend("UCX", &params).unwrap();

    // Create optional arguments and add backends
    let mut opt_args = OptArgs::new().unwrap();
    opt_args.add_backend(&backend1).unwrap();
    opt_args.add_backend(&backend2).unwrap();

    // Allocate and initialize memory regions
    let mut storage1 = SystemStorage::new(256).unwrap();
    let mut storage2 = SystemStorage::new(256).unwrap();

    // Initialize memory patterns
    storage1.memset(0xbb);
    storage2.memset(0x00);

    // Verify memory patterns
    assert!(storage1.as_slice().iter().all(|&x| x == 0xbb));
    assert!(storage2.as_slice().iter().all(|&x| x == 0x00));

    // Create registration descriptor lists
    storage1.register(&agent1, None).unwrap();
    storage2.register(&agent2, None).unwrap();

    // Mimic transferring metadata from agent2 to agent1
    let metadata = agent2.get_local_md().unwrap();
    let remote_name = agent1.load_remote_md(&metadata).unwrap();
    assert_eq!(remote_name, "A2");

    let mut local_xfer_dlist = XferDescList::new(MemType::Dram).unwrap();
    local_xfer_dlist.add_storage_desc(&storage1).unwrap();

    let mut remote_xfer_dlist = XferDescList::new(MemType::Dram).unwrap();
    remote_xfer_dlist.add_storage_desc(&storage2).unwrap();

    let mut xfer_args = OptArgs::new().unwrap();
    xfer_args.set_has_notification(true).unwrap();
    xfer_args.set_notification_message(b"notification").unwrap();

    let xfer_req = agent1
        .create_xfer_req(
            XferOp::Write,
            &local_xfer_dlist,
            &remote_xfer_dlist,
            &remote_name,
            Some(&xfer_args),
        )
        .unwrap();

    let _status = agent1.post_xfer_req(&xfer_req, None).unwrap();

    println!("Waiting for local completions");

    loop {
        let status = agent1.get_xfer_status(&xfer_req).unwrap();

        if status.is_success() {
            println!("Xfer req completed");
            break;
        } else {
            println!("Xfer req not completed");
        }
        std::thread::sleep(std::time::Duration::from_millis(100));
    }

    let mut notifs = NotificationMap::new().unwrap();
    let notify_map;
    println!("Waiting for notifications");
    std::thread::sleep(std::time::Duration::from_millis(100));

    loop {
        agent2.get_notifications(&mut notifs, None).unwrap();
        if !notifs.is_empty().unwrap() {
            notify_map = notifs.take_notifs().unwrap();
            assert_eq!(notify_map.len(), 1);
            assert!(notifs.is_empty().unwrap());
            break;
        }
        std::thread::sleep(std::time::Duration::from_millis(100));
    }

    println!("Got notifications");

    // Get first notification from first agent
    let vals = notify_map.get("A1").unwrap();
    assert_eq!(vals.len(), 1);
    assert_eq!(vals[0], "notification");

    // Verify memory patterns
    assert!(storage1.as_slice().iter().all(|&x| x == 0xbb));
    assert!(storage2.as_slice().iter().all(|&x| x == 0xbb));
}

#[test]
fn test_etcd_metadata_exchange() -> Result<(), NixlError> {
    // Check if NIXL_ETCD_ENDPOINTS env var is set to skip test if not
    if env::var("NIXL_ETCD_ENDPOINTS").is_err() {
        println!("Skipping etcd test - NIXL_ETCD_ENDPOINTS not set");
        return Ok(());
    }

    // Create two agents for metadata exchange
    let agent1 = Agent::new("EtcdAgent1")?;
    let agent2 = Agent::new("EtcdAgent2")?;

    // Get UCX backend to add to optional arguments
    let plugins = agent1.get_available_plugins()?;
    let plugin_name = find_plugin(&plugins, "UCX")?;
    let (_mems, params) = agent1.get_plugin_params(&plugin_name)?;
    let backend = agent1.create_backend(&plugin_name, &params)?;

    // Create OptArgs with backend
    let mut opt_args = OptArgs::new()?;
    opt_args.add_backend(&backend)?;

    // Send agent1's metadata to etcd
    agent1.send_local_md(Some(&opt_args))?;
    println!("Successfully sent agent1 metadata to etcd");

    // Fetch agent1's metadata from etcd with agent2
    agent2.fetch_remote_md("EtcdAgent1", Some(&opt_args))?;
    println!("Successfully fetched agent1 metadata from etcd");

    // Invalidate agent1's metadata in etcd
    agent1.invalidate_local_md(Some(&opt_args))?;
    println!("Successfully invalidated agent1 metadata in etcd");

    Ok(())
}

#[test]
fn test_send_notification() -> Result<(), NixlError> {
    // Create two agents for notification exchange
    let agent1 = Agent::new("NotifSender")?;
    let agent2 = Agent::new("NotifReceiver")?;

    // Set up backends for both agents
    let (_mem_list, params) = agent1.get_plugin_params("UCX")?;
    let backend1 = agent1.create_backend("UCX", &params)?;
    let backend2 = agent2.create_backend("UCX", &params)?;

    // Exchange metadata
    let metadata = agent2.get_local_md()?;
    agent1.load_remote_md(&metadata)?;

    // Create notification message
    let message = b"Test notification message";

    // Send notification with no backend specified
    agent1.send_notification("NotifReceiver", message, None)?;

    // Send notification with specific backend
    agent1.send_notification("NotifReceiver", message, Some(&backend1))?;

    // Create a notification map to receive notifications
    let mut notifs = NotificationMap::new()?;

    // Receive notifications without backend
    agent2.get_notifications(&mut notifs, None)?;

    // Receive notifications with specific backend
    let mut opt_args = OptArgs::new()?;
    opt_args.add_backend(&backend2)?;
    agent2.get_notifications(&mut notifs, Some(&opt_args))?;

    // Verify notification map contents
    if !notifs.is_empty()? {
        let mut agents = notifs.agents();

        // Should have notifications from NotifSender
        if let Some(Ok(agent_name)) = agents.next() {
            assert_eq!(agent_name, "NotifSender");

            // Verify notification content
            let notifications = notifs.get_notifications(agent_name)?;
            let notif_count = notifs.get_notifications_size(agent_name)?;

            // May have 1 or 2 notifications depending on whether both were processed
            assert!(notif_count > 0, "Should have at least one notification");

            // Check content of notification
            for notification in notifications {
                assert_eq!(notification?, message);
            }
        }
    }

    Ok(())
}

#[test]
fn test_check_remote_metadata() {
    // Create two agents
    let agent1 = Agent::new("agent1").expect("Failed to create agent1");
    let agent2 = Agent::new("agent2").expect("Failed to create agent2");

    // Set up backends for both agents (required before metadata operations)
    let (_mem_list, params) = agent1
        .get_plugin_params("UCX")
        .expect("Failed to get plugin params");
    let _backend1 = agent1
        .create_backend("UCX", &params)
        .expect("Failed to create backend for agent1");
    let _backend2 = agent2
        .create_backend("UCX", &params)
        .expect("Failed to create backend for agent2");

    // Initially, agent1 should not have metadata for agent2
    assert!(!agent1.check_remote_metadata("agent2", None));

    // Get and share metadata
    let metadata = agent2.get_local_md().expect("Failed to get local metadata");
    agent1
        .load_remote_md(&metadata)
        .expect("Failed to load remote metadata");

    // Now agent1 should have metadata for agent2
    assert!(agent1.check_remote_metadata("agent2", None));

    // Test with a descriptor list
    let mut storage = SystemStorage::new(1024).expect("Failed to create storage");
    let opt_args = OptArgs::new().expect("Failed to create opt args");
    storage
        .register(&agent2, Some(&opt_args))
        .expect("Failed to register memory");

    // Create descriptor list with memory that exists in agent2
    let mem_type = MemType::Dram;
    let mut xfer_desc_list =
        XferDescList::new(mem_type).expect("Failed to create xfer desc list");
    xfer_desc_list
        .add_desc(
            unsafe { storage.as_ptr() } as usize,
            storage.size(),
            storage.device_id(),
        );

    // Update metadata after registration
    let metadata = agent2
        .get_local_md()
        .expect("Failed to get updated local metadata");
    agent1
        .load_remote_md(&metadata)
        .expect("Failed to reload remote metadata");

    // Check with descriptor list - should return true for valid descriptors
    assert!(agent1.check_remote_metadata("agent2", Some(&xfer_desc_list)));

    // Create a descriptor list with invalid memory address
    let mut invalid_desc_list =
        XferDescList::new(mem_type).expect("Failed to create invalid desc list");
    invalid_desc_list
        .add_desc(0xdeadbeef, 1024, 0);

    // Check with invalid descriptor list - should return false
    assert!(!agent1.check_remote_metadata("agent2", Some(&invalid_desc_list)));

    // Check with non-existent agent name
    assert!(!agent1.check_remote_metadata("non_existent_agent", None));

    // Check with invalid agent name (contains null byte)
    // The function should return false rather than panic
    let invalid_name = "invalid\0agent";
    assert!(!agent1.check_remote_metadata(invalid_name, None));
}

#[test]
fn test_xfer_desc_list_new() {
    let dlist = XferDescList::new(MemType::Dram).unwrap();
    assert!(dlist.is_empty().unwrap());
}

#[test]
fn test_xfer_desc_list_get_type() {
    let dlist = XferDescList::new(MemType::Vram).unwrap();
    assert_eq!(dlist.get_type().unwrap(), MemType::Vram);
}

#[test]
fn test_xfer_desc_list_get_type_after_add() {
    let mut dlist = XferDescList::new(MemType::Block).unwrap();
    dlist.add_desc(0x1000, 0x100, 0);
    assert_eq!(dlist.get_type().unwrap(), MemType::Block);
}

#[test]
fn test_xfer_desc_list_desc_count_basic() {
    let mut dlist = XferDescList::new(MemType::Dram).unwrap();
    assert_eq!(dlist.desc_count().unwrap(), 0);
    dlist.add_desc(0x1000, 0x100, 0);
    assert_eq!(dlist.desc_count().unwrap(), 1);
}

#[test]
fn test_xfer_desc_list_desc_count_after_clear() {
    let mut dlist = XferDescList::new(MemType::Dram).unwrap();
    dlist.add_desc(0x1000, 0x100, 0);
    dlist.clear();
    assert_eq!(dlist.desc_count().unwrap(), 0);
}

#[test]
fn test_xfer_desc_list_is_empty_true() {
    let dlist = XferDescList::new(MemType::Dram).unwrap();
    assert!(dlist.is_empty().unwrap());
}

#[test]
fn test_xfer_desc_list_is_empty_false() {
    let mut dlist = XferDescList::new(MemType::Dram).unwrap();
    dlist.add_desc(0x1000, 0x100, 0);
    assert!(!dlist.is_empty().unwrap());
}

#[test]
fn test_xfer_desc_list_trim_basic() {
    let mut dlist = XferDescList::new(MemType::Dram).unwrap();
    dlist.add_desc(0x1000, 0x100, 0);
    dlist.trim();
    assert!(dlist.desc_count().unwrap() <= 1);
}

#[test]
fn test_xfer_desc_list_trim_empty() {
    let mut dlist = XferDescList::new(MemType::Dram).unwrap();
    dlist.trim();
    assert!(dlist.is_empty().unwrap());
}

#[test]
fn test_xfer_desc_list_rem_desc_basic() {
    let mut dlist = XferDescList::new(MemType::Dram).unwrap();
    dlist.add_desc(0x1000, 0x100, 0);
    assert!(dlist.rem_desc(0).is_ok());
    assert!(dlist.is_empty().unwrap());
}

#[test]
fn test_xfer_desc_list_rem_desc_out_of_bounds() {
    let mut dlist = XferDescList::new(MemType::Dram).unwrap();
    assert!(dlist.rem_desc(0).is_err());
}

#[test]
fn test_xfer_desc_list_clear_basic() {
    let mut dlist = XferDescList::new(MemType::Dram).unwrap();
    dlist.add_desc(0x1000, 0x100, 0);
    dlist.clear();
    assert!(dlist.is_empty().unwrap());
}

#[test]
fn test_xfer_desc_list_clear_empty() {
    let mut dlist = XferDescList::new(MemType::Dram).unwrap();
    dlist.clear();
    assert!(dlist.is_empty().unwrap());
}

#[test]
fn test_xfer_desc_list_print_basic() {
    let dlist = XferDescList::new(MemType::Dram).unwrap();
    assert!(dlist.print().is_ok());
}

#[test]
fn test_xfer_desc_list_print_after_add() {
    let mut dlist = XferDescList::new(MemType::Dram).unwrap();
    dlist.add_desc(0x1000, 0x100, 0);
    assert!(dlist.print().is_ok());
}

// ----------- RegDescList API TESTS -----------

#[test]
fn test_reg_desc_list_new() {
    let dlist = RegDescList::new(MemType::Dram).unwrap();
    assert!(dlist.is_empty().unwrap());
}

#[test]
fn test_reg_desc_list_get_type() {
    let dlist = RegDescList::new(MemType::Vram).unwrap();
    assert_eq!(dlist.get_type().unwrap(), MemType::Vram);
}

#[test]
fn test_reg_desc_list_get_type_after_add() {
    let mut dlist = RegDescList::new(MemType::Block).unwrap();
    dlist.add_desc(0x1000, 0x100, 0);
    assert_eq!(dlist.get_type().unwrap(), MemType::Block);
}

#[test]
fn test_reg_desc_list_desc_count_basic() {
    let mut dlist = RegDescList::new(MemType::Dram).unwrap();
    assert_eq!(dlist.desc_count().unwrap(), 0);
    dlist.add_desc(0x1000, 0x100, 0);
    assert_eq!(dlist.desc_count().unwrap(), 1);
}

#[test]
fn test_reg_desc_list_desc_count_after_clear() {
    let mut dlist = RegDescList::new(MemType::Dram).unwrap();
    dlist.add_desc(0x1000, 0x100, 0);
    dlist.clear();
    assert_eq!(dlist.desc_count().unwrap(), 0);
}

#[test]
fn test_reg_desc_list_is_empty_true() {
    let dlist = RegDescList::new(MemType::Dram).unwrap();
    assert!(dlist.is_empty().unwrap());
}

#[test]
fn test_reg_desc_list_is_empty_false() {
    let mut dlist = RegDescList::new(MemType::Dram).unwrap();
    dlist.add_desc(0x1000, 0x100, 0);
    assert!(!dlist.is_empty().unwrap());
}

#[test]
fn test_reg_desc_list_trim_basic() {
    let mut dlist = RegDescList::new(MemType::Dram).unwrap();
    dlist.add_desc(0x1000, 0x100, 0);
    dlist.trim();
    assert!(dlist.desc_count().unwrap() <= 1);
}

#[test]
fn test_reg_desc_list_trim_empty() {
    let mut dlist = RegDescList::new(MemType::Dram).unwrap();
    dlist.trim();
    assert!(dlist.is_empty().unwrap());
}

#[test]
fn test_reg_desc_list_rem_desc_basic() {
    let mut dlist = RegDescList::new(MemType::Dram).unwrap();
    dlist.add_desc(0x1000, 0x100, 0);
    assert!(dlist.rem_desc(0).is_ok());
    assert!(dlist.is_empty().unwrap());
}

#[test]
fn test_reg_desc_list_rem_desc_out_of_bounds() {
    let mut dlist = RegDescList::new(MemType::Dram).unwrap();
    assert!(dlist.rem_desc(0).is_err());
}

#[test]
fn test_reg_desc_list_clear_basic() {
    let mut dlist = RegDescList::new(MemType::Dram).unwrap();
    dlist.add_desc(0x1000, 0x100, 0);
    dlist.clear();
    assert!(dlist.is_empty().unwrap());
}

#[test]
fn test_reg_desc_list_clear_empty() {
    let mut dlist = RegDescList::new(MemType::Dram).unwrap();
    dlist.clear();
    assert!(dlist.is_empty().unwrap());
}

#[test]
fn test_reg_desc_list_print_basic() {
    let dlist = RegDescList::new(MemType::Dram).unwrap();
    assert!(dlist.print().is_ok());
}

#[test]
fn test_reg_desc_list_print_after_add() {
    let mut dlist = RegDescList::new(MemType::Dram).unwrap();
    dlist.add_desc(0x1000, 0x100, 0);
    assert!(dlist.print().is_ok());
}

#[test]
fn test_query_mem_with_files() {
    use std::fs::File;
    use std::io::Write;

    // Constants
    const DESCRIPTOR_ADDR: usize = 0;
    const DESCRIPTOR_SIZE: usize = 1024;
    const DESCRIPTOR_DEV_ID: u64 = 0;
    const NUM_FILES_TO_CREATE: usize = 2;
    const EXPECTED_NUM_RESPONSES: usize = 3;

    // Create a unique temporary directory for this test
    let temp_dir = tempfile::tempdir().expect("Failed to create temporary directory");
    let temp_dir_path = temp_dir.path();

    // Define test files
    let test_files = vec![
        ("test_query_mem_rust_1.txt", "Test content for file 1"),
        ("test_query_mem_rust_2.txt", "Test content for file 2"),
        ("non_existent_file_rust.txt", ""), // This file won't be created
    ];

    // Create temporary test files
    let mut file_paths: Vec<_> = test_files
        .iter()
        .take(NUM_FILES_TO_CREATE) // Only create the first two files
        .map(|(filename, content)| {
            let file_path = temp_dir_path.join(filename);
            let mut file =
                File::create(&file_path).expect(&format!("Failed to create {}", filename));
            writeln!(file, "{}", content).expect(&format!("Failed to write to {}", filename));
            file_path
        })
        .collect();

    // Add the non-existent file path
    file_paths.push(temp_dir_path.join(test_files[2].0));

    // Create agent
    let agent = Agent::new("test_agent").expect("Failed to create agent");

    // Create POSIX backend
    let (_backend, opt_args) = match create_posix_backend(&agent) {
        Some(result) => result,
        None => return,
    };

    // Create descriptor list with existing and non-existing files
    let mut descs =
        RegDescList::new(MemType::File).expect("Failed to create descriptor list");

    // Add blob descriptors with filenames as metadata
    for file_path in &file_paths {
        descs.add_desc_with_meta(
            DESCRIPTOR_ADDR,
            DESCRIPTOR_SIZE,
            DESCRIPTOR_DEV_ID,
            file_path.to_string_lossy().as_bytes(),
        );
    }

    // Query memory
    let resp = agent
        .query_mem(&descs, Some(&opt_args))
        .expect("Failed to query mem");

    // Verify results
    assert_eq!(
        resp.len().unwrap(),
        EXPECTED_NUM_RESPONSES,
        "Expected 3 responses"
    );

    // Check responses - current order: existing file, existing file, non-existent file
    let responses: Vec<_> = resp.iter().unwrap().collect();

    assert!(responses[0].has_value().unwrap(), "First file should exist");
    assert!(
        responses[1].has_value().unwrap(),
        "Second file should exist"
    );
    assert!(
        !responses[2].has_value().unwrap(),
        "Third file should not exist"
    );

    // Print parameters for existing files
    for (i, response) in responses.iter().enumerate() {
        if response.has_value().unwrap() {
            if let Some(params) = response.get_params().unwrap() {
                println!("Parameters for response {}:", i);
                for result in params.iter().unwrap() {
                    let (key, value) = result.unwrap();
                    println!("  {} = {}", key, value);
                    // POSIX backend returns mtime and mode parameters
                    if key == "mtime" || key == "mode" {
                        assert!(
                            !value.is_empty(),
                            "Parameter value should not be empty"
                        );
                    }
                }
            }
        }
    }
}

#[test]
fn test_query_mem_empty_list() {
    // Constants
    const EXPECTED_EMPTY_RESPONSES: usize = 0;

    // Create agent
    let agent = Agent::new("test_agent").expect("Failed to create agent");

    // Create POSIX backend
    let (_backend, opt_args) = match create_posix_backend(&agent) {
        Some(result) => result,
        None => return,
    };

    // Create empty descriptor list
    let descs = RegDescList::new(MemType::File).expect("Failed to create descriptor list");

    // Query memory with empty list
    let resp = agent
        .query_mem(&descs, Some(&opt_args))
        .expect("Failed to query mem");

    // Verify results
    let num_responses = resp.len().expect("Failed to get response count");
    assert_eq!(
        num_responses, EXPECTED_EMPTY_RESPONSES,
        "Expected 0 responses for empty descriptor list"
    );
}

// Tests for prep_xfer_dlist API
#[test]
fn test_prep_xfer_dlist_success() {
    const DLIST_SIZE: usize = 10;

    // 1. Create agents and backends
    let (local_agent, opt_args) = create_agent_with_backend("local_agent").expect("Failed to create agent");
    let (remote_agent, _opt_args_remote) = create_agent_with_backend("remote_agent").expect("Failed to create agent");

    // 2. Create memory regions and register them
    let mut storage_list = create_storage_list(&local_agent, &opt_args, DLIST_SIZE);

    {
        // 3. Create transfer descriptor list
        let dlist = create_dlist(&mut storage_list).expect("Failed to create XferDescList");

        // 4. Exchange metadata
        exchange_metadata(&local_agent, &remote_agent).expect("Failed to exchange metadata");

        // 5. Prepare transfer descriptor list
        let result = local_agent.prepare_xfer_dlist("", &dlist, None);
        assert!(result.is_ok(), "prepare_xfer_dlist failed with error: {:?}", result.err());
    }
}

#[test]
fn test_prep_xfer_dlist_invalid_agent() {
    const DLIST_SIZE: usize = 10;

    let agent = Agent::new("test_agent").expect("Failed to create agent");
    let opt_args = setup_agent_with_backend(&agent).expect("Failed to setup agent");
    let mut storage_list = create_storage_list(&agent, &opt_args, DLIST_SIZE);
    {
        let dlist = create_dlist(&mut storage_list).expect("Failed to create XferDescList");

        // Try with invalid agent name
        let result = agent.prepare_xfer_dlist("invalid_agent", &dlist, None);

        assert!(
            result.is_err_and(|e| matches!(e, NixlError::BackendError)),
            "Expected InvalidParam for invalid agent name"
        );
    }
}

// Tests for make_xfer_req API
#[test]
fn test_make_xfer_req_success() {
    const DLIST_SIZE: usize = 10;

    let (local_agent, opt_args) = create_agent_with_backend("local_agent").expect("Failed to create agent");
    let (remote_agent, opt_args_remote) = create_agent_with_backend("remote_agent").expect("Failed to create agent");

    // 2. Create memory regions and register them
    let mut storage_list = create_storage_list(&local_agent, &opt_args, DLIST_SIZE);
    let mut remote_storage_list = create_storage_list(&remote_agent, &opt_args_remote, DLIST_SIZE);

    {
        let dlist = create_dlist(&mut storage_list).expect("Failed to create XferDescList");
        let remote_dlist = create_dlist(&mut remote_storage_list).expect("Failed to create XferDescList");

        // 4. Exchange metadata
        exchange_metadata(&local_agent, &remote_agent).expect("Failed to exchange metadata");

        // Prepare descriptor list handles
        let local_handle: XferDlistHandle = local_agent.prepare_xfer_dlist("", &dlist, Some(&opt_args))
            .expect("Failed to prepare local descriptor list");

        let remote_handle: XferDlistHandle = local_agent.prepare_xfer_dlist(remote_agent.name().as_str(), &remote_dlist, Some(&opt_args))
            .expect("Failed to prepare local descriptor list");

        // Create transfer request using prepared handles with indices
        let local_indices = (0..DLIST_SIZE).step_by(2).map(|i| i as i32).collect::<Vec<i32>>();
        let remote_indices = (1..DLIST_SIZE).step_by(2).map(|i| i as i32).collect::<Vec<i32>>();
        let result = local_agent.make_xfer_req(
            XferOp::Write,
            &local_handle,
            &local_indices,
            &remote_handle,
            &remote_indices,
            Some(&opt_args)
        );

        assert!(
            result.is_ok(),
            "make_xfer_req failed with error: {:?}", result.err()
        );
    }
}

#[test]
fn test_make_xfer_req_invalid_indices() {
    const DLIST_SIZE: usize = 10;
    let (agent1, opt_args) = create_agent_with_backend("agent1").expect("Failed to create agent");
    let (agent2, opt_args_remote) = create_agent_with_backend("agent2").expect("Failed to create agent");

    let mut storage_list = create_storage_list(&agent1, &opt_args, DLIST_SIZE);
    let mut remote_storage_list = create_storage_list(&agent2, &opt_args_remote, DLIST_SIZE);

    {
        let local_dlist = create_dlist(&mut storage_list).expect("Failed to create descriptor list");
        let remote_dlist = create_dlist(&mut remote_storage_list).expect("Failed to create descriptor list");

        exchange_metadata(&agent1, &agent2).expect("Failed to exchange metadata");

        // Prepare descriptor list handles
        let local_handle = agent1.prepare_xfer_dlist("", &local_dlist, Some(&opt_args))
            .expect("Failed to prepare local descriptor list");
        let remote_handle = agent1.prepare_xfer_dlist(agent2.name().as_str(), &remote_dlist, Some(&opt_args))
            .expect("Failed to prepare remote descriptor list");

        // Test with out-of-bounds indices (should fail)
        let invalid_indices = [999i32];  // Index 999 doesn't exist
        let result = agent1.make_xfer_req(
            XferOp::Write,
            &local_handle,
            &invalid_indices,    // Out-of-bounds local index
            &remote_handle,
            &invalid_indices,    // Out-of-bounds remote index
            None
        );
        assert!(result.is_err_and(|e| matches!(e, NixlError::BackendError)), "Expected InvalidParam for out-of-bounds indices");
    }
}

// Tests for get_local_partial_md API
#[test]
fn test_get_local_partial_md_success() {
    let (agent, opt_args) = create_agent_with_backend("test_agent")
        .expect("Failed to setup agent with backend");
    let _storage_list = create_storage_list(&agent, &opt_args, 10);
    // Create a registration descriptor list
    let mut reg_descs = RegDescList::new(MemType::Dram)
        .expect("Failed to create registration descriptor list");
    reg_descs.add_desc(0x1000, 0x100, 0);
    // Get local partial metadata
    let result = agent.get_local_partial_md(&reg_descs, Some(&opt_args));
    // Should succeed and return metadata
    match result {
        Ok(metadata) => {
            assert!(!metadata.is_empty(), "Metadata should not be empty");
            println!("Partial metadata size: {}", metadata.len());
        }
        Err(e) => {
            // May fail if no partial metadata exists yet, which is acceptable
            assert!(
                matches!(e, NixlError::BackendError) || matches!(e, NixlError::InvalidParam),
                "Expected BackendError or InvalidParam, got: {:?}", e
            );
        }
    }
}

#[test]
fn test_get_local_partial_md_empty_descs() {
    let (agent, _) = create_agent_with_backend("test_agent")
        .expect("Failed to setup agent with backend");
    // Create empty registration descriptor list
    let reg_descs = RegDescList::new(MemType::Dram)
        .expect("Failed to create registration descriptor list");
    // Try with empty descriptor list should succeed and return all available backends
    let result = agent.get_local_partial_md(&reg_descs, None);
    assert!(
        result.is_ok(),
        "get_local_partial_md should succeed with empty descriptor list"
    );
}

// Tests for send_local_partial_md API
#[test]
fn test_send_local_partial_md_success() {
    let (agent, opt_args) = create_agent_with_backend("test_agent")
        .expect("Failed to setup agent with backend");
    let (agent2, opt_args2) = create_agent_with_backend("test_agent2")
        .expect("Failed to setup agent with backend");
    let _storage_list = create_storage_list(&agent, &opt_args, 10);
    let _remote_storage_list = create_storage_list(&agent2, &opt_args2, 10);

    // Create a registration descriptor list
    let mut reg_descs = RegDescList::new(MemType::Dram)
        .expect("Failed to create registration descriptor list");
    reg_descs.add_storage_desc(&_storage_list[0]).expect("Failed to add storage descriptor");

    // Send local partial metadata
    let mut opt_args_temp = OptArgs::new().expect("Failed to create opt args");
    opt_args_temp.set_ip_addr("127.0.0.1").expect("Failed to set ip address");
    let result = agent.send_local_partial_md(&reg_descs, Some(&opt_args_temp));

    assert!(
        result.is_ok(),
        "send_local_partial_md should succeed"
    );
}

// Tests for query_xfer_backend API
#[test]
fn test_query_xfer_backend_success() {
    let (agent1, opt_args) = create_agent_with_backend("agent1").expect("Failed to create agent");
    let (agent2, opt_args_remote) = create_agent_with_backend("agent2").expect("Failed to create agent");
    // Create descriptor lists
    let mut storage_list = create_storage_list(&agent1, &opt_args, 1);
    let mut remote_storage_list = create_storage_list(&agent2, &opt_args_remote, 1);
    {
        let local_dlist = create_dlist(&mut storage_list).expect("Failed to create descriptor list");
        let remote_dlist = create_dlist(&mut remote_storage_list).expect("Failed to create descriptor list");
        exchange_metadata(&agent1, &agent2).expect("Failed to exchange metadata");
        // Create transfer request
        let xfer_req = agent1.create_xfer_req(
            XferOp::Write,
            &local_dlist,
            &remote_dlist,
            "agent2",
            None
        ).expect("Failed to create transfer request");
        // Query which backend will be used for this transfer
        let result: Result<Backend, NixlError> = agent1.query_xfer_backend(&xfer_req);
        assert!(result.is_ok(), "query_xfer_backend failed with error: {:?}", result.err());
        let backend = result.unwrap();
        println!("Transfer will use backend: {:?}", backend);
   }
}
#[test]
fn test_query_xfer_backend_invalid_request() {
    let (agent1, opt_args) = create_agent_with_backend("agent1").expect("Failed to create agent");
    let (agent2, opt_args_remote) = create_agent_with_backend("agent2").expect("Failed to create agent");
    // Create descriptor lists
    let mut storage_list = create_storage_list(&agent1, &opt_args, 1);
    let mut remote_storage_list = create_storage_list(&agent2, &opt_args_remote, 1);
    {
        let local_dlist = create_dlist(&mut storage_list).expect("Failed to create descriptor list");
        let remote_dlist = create_dlist(&mut remote_storage_list).expect("Failed to create descriptor list");
        // Create transfer request with non-existent remote agent (should fail or succeed)
        let xfer_req_result = agent1.create_xfer_req(
            XferOp::Write,
            &local_dlist,
            &remote_dlist,
            "non_existent_agent",
            None
        );
        assert!(xfer_req_result.is_err(), "Transfer request creation should fail for non-existent agent");
 }
}

// Tests for get_xfer_telemetry API
#[test]
fn test_get_xfer_telemetry_success() {
    env::set_var("NIXL_TELEMETRY_ENABLE", "1");

    let (agent1, opt_args) = create_agent_with_backend("agent1").expect("Failed to create agent");
    let (agent2, opt_args_remote) = create_agent_with_backend("agent2").expect("Failed to create agent");

    let mut storage_list = create_storage_list(&agent1, &opt_args, 1);
    let mut remote_storage_list = create_storage_list(&agent2, &opt_args_remote, 1);

    {
        let local_dlist = create_dlist(&mut storage_list).expect("Failed to create descriptor list");
        let remote_dlist = create_dlist(&mut remote_storage_list).expect("Failed to create descriptor list");

        exchange_metadata(&agent1, &agent2).expect("Failed to exchange metadata");

        let xfer_req = agent1.create_xfer_req(
            XferOp::Write,
            &local_dlist,
            &remote_dlist,
            "agent2",
            None
        ).expect("Failed to create transfer request");

        let result = agent1.post_xfer_req(&xfer_req, Some(&opt_args));
        assert!(result.is_ok(), "post_xfer_req failed with error: {:?}", result.err());

        // Wait for transfer to complete
        loop {
            match agent1.get_xfer_status(&xfer_req) {
                Ok(XferStatus::Success) => break,
                Ok(XferStatus::InProgress) => {
                    std::thread::sleep(std::time::Duration::from_millis(10));
                    continue;
                }
                Err(e) => panic!("Failed to get transfer status: {:?}", e),
            }
        }

        let telemetry_result = xfer_req.get_telemetry();
        assert!(telemetry_result.is_ok(), "get_xfer_telemetry failed with error: {:?}", telemetry_result.err());

        let telemetry = telemetry_result.unwrap();
        assert!(telemetry.start_time_us > 0, "Start time should be greater than 0");
        assert!(telemetry.total_bytes > 0, "Total bytes should be greater than 0");
        assert!(telemetry.desc_count > 0, "Descriptor count should be greater than 0");

        // Test convenience methods
        let start_time = telemetry.start_time();
        assert!(start_time.as_micros() == telemetry.start_time_us as u128);

        let post_duration = telemetry.post_duration();
        assert!(post_duration.as_micros() == telemetry.post_duration_us as u128);

        let xfer_duration = telemetry.xfer_duration();
        assert!(xfer_duration.as_micros() == telemetry.xfer_duration_us as u128);

        let total_duration = telemetry.total_duration();
        assert!(total_duration.as_micros() == (telemetry.post_duration_us + telemetry.xfer_duration_us) as u128);

        // Test transfer rate calculation
        let rate = telemetry.transfer_rate_bps();
        if telemetry.xfer_duration_us > 0 {
            assert!(rate > 0.0, "Transfer rate should be positive when transfer duration > 0");
        }

        println!("Telemetry data: {:?}", telemetry);
        println!("Transfer rate: {:.2} MB/s", rate / 1_000_000.0);
    }
}

#[test]
fn test_get_xfer_telemetry_from_request() {
    env::set_var("NIXL_TELEMETRY_ENABLE", "1");

    let (agent1, opt_args) = create_agent_with_backend("agent1").expect("Failed to create agent");
    let (agent2, opt_args_remote) = create_agent_with_backend("agent2").expect("Failed to create agent");

    let mut storage_list = create_storage_list(&agent1, &opt_args, 1);
    let mut remote_storage_list = create_storage_list(&agent2, &opt_args_remote, 1);

    {
        let local_dlist = create_dlist(&mut storage_list).expect("Failed to create descriptor list");
        let remote_dlist = create_dlist(&mut remote_storage_list).expect("Failed to create descriptor list");

        exchange_metadata(&agent1, &agent2).expect("Failed to exchange metadata");

        let xfer_req = agent1.create_xfer_req(
            XferOp::Write,
            &local_dlist,
            &remote_dlist,
            "agent2",
            None
        ).expect("Failed to create transfer request");

        let result = agent1.post_xfer_req(&xfer_req, Some(&opt_args));
        assert!(result.is_ok(), "post_xfer_req failed with error: {:?}", result.err());

        // Wait for transfer to complete
        loop {
            match agent1.get_xfer_status(&xfer_req) {
                Ok(XferStatus::Success) => break,
                Ok(XferStatus::InProgress) => {
                    std::thread::sleep(std::time::Duration::from_millis(10));
                    continue;
                }
                Err(e) => panic!("Failed to get transfer status: {:?}", e),
            }
        }

        let telemetry_result = xfer_req.get_telemetry();
        assert!(telemetry_result.is_ok(), "get_telemetry from request failed with error: {:?}", telemetry_result.err());

        let telemetry = telemetry_result.unwrap();
        assert!(telemetry.start_time_us > 0, "Start time should be greater than 0");
        assert!(telemetry.total_bytes > 0, "Total bytes should be greater than 0");
        assert!(telemetry.desc_count > 0, "Descriptor count should be greater than 0");

        println!("Telemetry data from request: {:?}", telemetry);
    }
}

#[test]
fn test_get_xfer_telemetry_without_telemetry_enabled() {
    env::remove_var("NIXL_TELEMETRY_ENABLE");

    let (agent1, opt_args) = create_agent_with_backend("agent1").expect("Failed to create agent");
    let (agent2, opt_args_remote) = create_agent_with_backend("agent2").expect("Failed to create agent");

    // Create descriptor lists
    let mut storage_list = create_storage_list(&agent1, &opt_args, 1);
    let mut remote_storage_list = create_storage_list(&agent2, &opt_args_remote, 1);

    {
        let local_dlist = create_dlist(&mut storage_list).expect("Failed to create descriptor list");
        let remote_dlist = create_dlist(&mut remote_storage_list).expect("Failed to create descriptor list");

        exchange_metadata(&agent1, &agent2).expect("Failed to exchange metadata");

        let xfer_req = agent1.create_xfer_req(
            XferOp::Write,
            &local_dlist,
            &remote_dlist,
            "agent2",
            None
        ).expect("Failed to create transfer request");

        let result = agent1.post_xfer_req(&xfer_req, Some(&opt_args));
        assert!(result.is_ok(), "post_xfer_req failed with error: {:?}", result.err());

        // Wait for transfer to complete
        loop {
            match agent1.get_xfer_status(&xfer_req) {
                Ok(XferStatus::Success) => break,
                Ok(XferStatus::InProgress) => {
                    std::thread::sleep(std::time::Duration::from_millis(10));
                    continue;
                }
                Err(e) => panic!("Failed to get transfer status: {:?}", e),
            }
        }

        // Try to get telemetry data - should fail with NoTelemetry
        let telemetry_result = xfer_req.get_telemetry();
        assert!(telemetry_result.is_err(), "get_xfer_telemetry should fail when telemetry is disabled");

        match telemetry_result.err().unwrap() {
            NixlError::NoTelemetry => {
                println!("Correctly received NoTelemetry error");
            }
            other => panic!("Expected NoTelemetry error, got: {:?}", other),
        }
    }
}

#[test]
fn test_get_xfer_telemetry_before_posting() {
    env::set_var("NIXL_TELEMETRY_ENABLE", "1");

    let (agent1, opt_args) = create_agent_with_backend("agent1").expect("Failed to create agent");
    let (agent2, opt_args_remote) = create_agent_with_backend("agent2").expect("Failed to create agent");

    // Create descriptor lists
    let mut storage_list = create_storage_list(&agent1, &opt_args, 1);
    let mut remote_storage_list = create_storage_list(&agent2, &opt_args_remote, 1);

    {
        let local_dlist = create_dlist(&mut storage_list).expect("Failed to create descriptor list");
        let remote_dlist = create_dlist(&mut remote_storage_list).expect("Failed to create descriptor list");

        exchange_metadata(&agent1, &agent2).expect("Failed to exchange metadata");

        // Create transfer request
        let xfer_req = agent1.create_xfer_req(
            XferOp::Write,
            &local_dlist,
            &remote_dlist,
            "agent2",
            None
        ).expect("Failed to create transfer request");

        // Try to get telemetry before posting the request - should fail
        let telemetry_result = xfer_req.get_telemetry();
        assert!(telemetry_result.is_err(), "get_xfer_telemetry should fail before transfer is posted");
        let error = telemetry_result.err().unwrap();
        match error {
            NixlError::NoTelemetry | NixlError::BackendError => {
                println!("Got expected error before posting: {:?}", error);
            }
            other => panic!("Expected NoTelemetry or BackendError, got: {:?}", other),
        }

        println!("Successfully tested telemetry before posting - got expected error");
    }
}

// Tests for equality operators on RegDescList and XferDescList

#[test]
fn test_desc_list_equality_empty() {
    fn test_impl<T: DescListTestTrait>() {
        let list1 = T::new(MemType::Dram).unwrap();
        let list2 = T::new(MemType::Dram).unwrap();
        assert_eq!(list1, list2);
        assert!(!(list1 != list2));
    }

    test_impl::<RegDescList>();
    test_impl::<XferDescList>();
}

#[test]
fn test_desc_list_equality_memory_types() {
    fn test_impl<T: DescListTestTrait>() {
        let list_dram = T::new(MemType::Dram).unwrap();
        let list_vram = T::new(MemType::Vram).unwrap();
        assert_ne!(list_dram, list_vram);
        assert!(!(list_dram == list_vram));
    }

    test_impl::<RegDescList>();
    test_impl::<XferDescList>();
}

#[test]
fn test_desc_list_equality_same_descriptors() {
    fn test_impl<T: DescListTestTrait>() {
        let mut list1 = T::new(MemType::Dram).unwrap();
        let mut list2 = T::new(MemType::Dram).unwrap();

        list1.add_desc(0x1000, 0x100, 0);
        list1.add_desc(0x2000, 0x200, 1);

        list2.add_desc(0x1000, 0x100, 0);
        list2.add_desc(0x2000, 0x200, 1);

        assert_eq!(list1, list2);
        assert!(!(list1 != list2));
    }

    test_impl::<RegDescList>();
    test_impl::<XferDescList>();
}

#[test]
fn test_desc_list_equality_different_descriptors() {
    fn test_impl<T: DescListTestTrait>() {
        let mut list1 = T::new(MemType::Dram).unwrap();
        let mut list2 = T::new(MemType::Dram).unwrap();

        list1.add_desc(0x1000, 0x100, 0);
        list2.add_desc(0x2000, 0x200, 1);

        assert_ne!(list1, list2);
        assert!(!(list1 == list2));
    }

    test_impl::<RegDescList>();
    test_impl::<XferDescList>();
}

#[test]
fn test_desc_list_equality_different_lengths() {
    fn test_impl<T: DescListTestTrait>() {
        let mut list1 = T::new(MemType::Dram).unwrap();
        let list2 = T::new(MemType::Dram).unwrap();

        list1.add_desc(0x1000, 0x100, 0);

        assert_ne!(list1, list2);
        assert!(!(list1 == list2));
    }

    test_impl::<RegDescList>();
    test_impl::<XferDescList>();
}

#[test]
fn test_desc_list_equality_order_matters() {
    fn test_impl<T: DescListTestTrait>() {
        let mut list1 = T::new(MemType::Dram).unwrap();
        let mut list2 = T::new(MemType::Dram).unwrap();

        list1.add_desc(0x1000, 0x100, 0);
        list1.add_desc(0x2000, 0x200, 1);

        list2.add_desc(0x2000, 0x200, 1);
        list2.add_desc(0x1000, 0x100, 0);

        assert_ne!(list1, list2);
        assert!(!(list1 == list2));
    }

    test_impl::<RegDescList>();
    test_impl::<XferDescList>();
}

// RegDescList-specific test: metadata affects equality
#[test]
fn test_reg_desc_list_equality_metadata() {
    let mut list1 = RegDescList::new(MemType::Dram).unwrap();
    let mut list2 = RegDescList::new(MemType::Dram).unwrap();

    list1.add_desc_with_meta(0x1000, 0x100, 0, b"metadata1");
    list2.add_desc_with_meta(0x1000, 0x100, 0, b"metadata2");

    assert_ne!(list1, list2);
    assert!(!(list1 == list2));
}

// Tests for Index trait (immutable indexing)
#[test]
fn test_desc_list_immutable_index_access() {
    macro_rules! test_impl {
        ($list_type:ty, $mem_type:expr) => {{
            let mut list = <$list_type>::new($mem_type).unwrap();
            list.add_desc(0x1000, 0x100, 0);
            list.add_desc(0x2000, 0x200, 1);

            // Test indexing - direct field access
            assert_eq!(list[0].addr, 0x1000);
            assert_eq!(list[0].len, 0x100);
            assert_eq!(list[0].dev_id, 0);

            assert_eq!(list[1].addr, 0x2000);
            assert_eq!(list[1].len, 0x200);
            assert_eq!(list[1].dev_id, 1);
        }};
    }

    test_impl!(RegDescList, MemType::Dram);
    test_impl!(XferDescList, MemType::Vram);
}

// Test for IndexMut trait (mutable indexing)
#[test]
fn test_desc_list_mutable_index_modification() {
    macro_rules! test_impl {
        ($list_type:ty, $mem_type:expr, $new_addr:expr, $new_len:expr, $new_dev_id:expr) => {{
            let mut list = <$list_type>::new($mem_type).unwrap();
            list.add_desc(0x1000, 0x100, 0);
            list.add_desc(0x2000, 0x200, 1);

            // Mutate via index - direct field access
            list[0].addr = $new_addr;
            list[0].len = $new_len;
            list[1].dev_id = $new_dev_id;

            // Verify changes
            assert_eq!(list[0].addr, $new_addr);
            assert_eq!(list[0].len, $new_len);
            assert_eq!(list[1].dev_id, $new_dev_id);

            // Verify the list still has 2 elements
            assert_eq!(list.len().unwrap(), 2);
        }};
    }

    test_impl!(RegDescList, MemType::Dram, 0x3000, 0x300, 42);
    test_impl!(XferDescList, MemType::Vram, 0x4000, 0x400, 99);
}

// Test out-of-bounds indexing panics (expected behavior)
#[test]
#[should_panic]
fn test_desc_list_immutable_index_panics_on_out_of_bounds() {
    let list = RegDescList::new(MemType::Dram).unwrap();
    let _ = &list[0]; // Should panic - empty list
}

#[test]
#[should_panic]
fn test_desc_list_mutable_index_panics_on_out_of_bounds() {
    let mut list = XferDescList::new(MemType::Dram).unwrap();
    list.add_desc(0x1000, 0x100, 0);
    list[5].addr = 0x9999; // Should panic - index 5 doesn't exist
}

// Tests for safe get() method
#[test]
fn test_desc_list_safe_get_method() {
    // Test RegDescList
    let mut reg_list = RegDescList::new(MemType::Dram).unwrap();
    reg_list.add_desc(0x1000, 0x100, 0);
    reg_list.add_desc(0x2000, 0x200, 1);

    // Valid access
    let desc = reg_list.get(0).unwrap();
    assert_eq!(desc.addr, 0x1000);
    assert_eq!(desc.len, 0x100);

    // Out of bounds should return error
    assert!(reg_list.get(10).is_err());

    // Test XferDescList
    let mut xfer_list = XferDescList::new(MemType::Vram).unwrap();
    xfer_list.add_desc(0x3000, 0x300, 2);

    let desc = xfer_list.get(0).unwrap();
    assert_eq!(desc.addr, 0x3000);
    assert_eq!(desc.len, 0x300);

    assert!(xfer_list.get(5).is_err());
}

// Tests for safe get_mut() method
#[test]
fn test_desc_list_safe_get_mut_method() {
    // Test RegDescList
    let mut reg_list = RegDescList::new(MemType::Dram).unwrap();
    reg_list.add_desc(0x1000, 0x100, 0);

    // Valid mutable access
    {
        let desc = reg_list.get_mut(0).unwrap();
        desc.addr = 0x5000;
        desc.len = 0x500;
    }

    assert_eq!(reg_list[0].addr, 0x5000);
    assert_eq!(reg_list[0].len, 0x500);

    // Out of bounds should return error
    assert!(reg_list.get_mut(10).is_err());

    // Test XferDescList
    let mut xfer_list = XferDescList::new(MemType::Vram).unwrap();
    xfer_list.add_desc(0x2000, 0x200, 1);

    {
        let desc = xfer_list.get_mut(0).unwrap();
        desc.dev_id = 99;
    }

    assert_eq!(xfer_list[0].dev_id, 99);
    assert!(xfer_list.get_mut(5).is_err());
}

// Test: Empty list serialization
#[test]
fn test_desc_list_serialize_empty() {
    macro_rules! test_empty {
        ($list_type:ty) => {{
            let empty_list = <$list_type>::new(MemType::Dram).unwrap();
            let serialized = empty_list.serialize().unwrap();
            assert!(
                !serialized.is_empty(),
                "Serialized empty {} should contain metadata",
                std::any::type_name::<$list_type>()
            );
            println!(
                "Empty {} serialized to {} bytes",
                std::any::type_name::<$list_type>(),
                serialized.len()
            );
        }};
    }

    test_empty!(RegDescList);
    test_empty!(XferDescList);
}

// Test: List with descriptors serializes to larger size than empty list
#[test]
fn test_desc_list_serialize_with_data() {
    macro_rules! test_with_data {
        ($list_type:ty) => {{
            let empty_list = <$list_type>::new(MemType::Dram).unwrap();
            let serialized_empty = empty_list.serialize().unwrap();

            let mut list = <$list_type>::new(MemType::Vram).unwrap();
            list.add_desc(0x1000, 0x100, 0);
            list.add_desc(0x2000, 0x200, 1);
            let serialized = list.serialize().unwrap();

            assert!(
                serialized.len() > serialized_empty.len(),
                "{} with descriptors should serialize to larger size: {} > {}",
                std::any::type_name::<$list_type>(),
                serialized.len(),
                serialized_empty.len()
            );
            println!(
                "{} with 2 descriptors serialized to {} bytes",
                std::any::type_name::<$list_type>(),
                serialized.len()
            );
        }};
    }

    test_with_data!(RegDescList);
    test_with_data!(XferDescList);
}

// Test: Different memory types produce different serializations
#[test]
fn test_desc_list_serialize_memory_types() {
    macro_rules! test_memory_types {
        ($list_type:ty) => {{
            let mut list1 = <$list_type>::new(MemType::Vram).unwrap();
            list1.add_desc(0x1000, 0x100, 0);
            let serialized1 = list1.serialize().unwrap();

            let mut list2 = <$list_type>::new(MemType::Dram).unwrap();
            list2.add_desc(0x1000, 0x100, 0);
            let serialized2 = list2.serialize().unwrap();

            assert_ne!(
                serialized1,
                serialized2,
                "{}: different memory types should serialize differently",
                std::any::type_name::<$list_type>()
            );
        }};
    }

    test_memory_types!(RegDescList);
    test_memory_types!(XferDescList);
}

// Test: Deterministic serialization (same descriptors produce same bytes)
#[test]
fn test_desc_list_serialize_deterministic() {
    macro_rules! test_deterministic {
        ($list_type:ty) => {{
            let mut list1 = <$list_type>::new(MemType::Vram).unwrap();
            list1.add_desc(0x1000, 0x100, 0);
            list1.add_desc(0x2000, 0x200, 1);
            let serialized1 = list1.serialize().unwrap();

            let mut list2 = <$list_type>::new(MemType::Vram).unwrap();
            list2.add_desc(0x1000, 0x100, 0);
            list2.add_desc(0x2000, 0x200, 1);
            let serialized2 = list2.serialize().unwrap();

            assert_eq!(
                serialized1,
                serialized2,
                "{}: same descriptors should serialize identically",
                std::any::type_name::<$list_type>()
            );
        }};
    }

    test_deterministic!(RegDescList);
    test_deterministic!(XferDescList);
}

// Test: Round-trip serialization (serialize then deserialize)
#[test]
fn test_desc_list_serialize_round_trip() {
    macro_rules! test_round_trip {
        ($list_type:ty) => {{
            let mut list = <$list_type>::new(MemType::Vram).unwrap();
            list.add_desc(0x1000, 0x100, 0);
            list.add_desc(0x2000, 0x200, 1);
            let serialized = list.serialize().unwrap();

            let deserialized = <$list_type>::deserialize(&serialized).unwrap();
            assert_eq!(
                list,
                deserialized,
                "{}: round-trip should produce equivalent lists",
                std::any::type_name::<$list_type>()
            );
            assert_eq!(deserialized.get_type().unwrap(), MemType::Vram);
            assert_eq!(deserialized.len().unwrap(), 2);
            println!("{} round-trip successful", std::any::type_name::<$list_type>());
        }};
    }

    test_round_trip!(RegDescList);
    test_round_trip!(XferDescList);
}

// Test: Empty list round-trip
#[test]
fn test_desc_list_serialize_empty_round_trip() {
    macro_rules! test_empty_round_trip {
        ($list_type:ty) => {{
            let empty_list = <$list_type>::new(MemType::Dram).unwrap();
            let serialized = empty_list.serialize().unwrap();
            let deserialized = <$list_type>::deserialize(&serialized).unwrap();
            assert_eq!(
                empty_list,
                deserialized,
                "{}: empty list round-trip should work",
                std::any::type_name::<$list_type>()
            );
        }};
    }

    test_empty_round_trip!(RegDescList);
    test_empty_round_trip!(XferDescList);
}

// Test: Deserialization error cases
#[test]
fn test_desc_list_deserialize_errors() {
    macro_rules! test_deserialize_errors {
        ($list_type:ty) => {{
            let invalid_data = vec![0xFF, 0xFF, 0xFF];
            assert!(
                <$list_type>::deserialize(&invalid_data).is_err(),
                "{}: invalid data should return error",
                std::any::type_name::<$list_type>()
            );

            let empty_data = vec![];
            assert!(
                <$list_type>::deserialize(&empty_data).is_err(),
                "{}: empty data should return error",
                std::any::type_name::<$list_type>()
            );
        }};
    }

    test_deserialize_errors!(RegDescList);
    test_deserialize_errors!(XferDescList);
}

// Test: Order sensitivity (descriptor order matters in serialization)
#[test]
fn test_desc_list_serialize_order_sensitivity() {
    macro_rules! test_order_sensitivity {
        ($list_type:ty) => {{
            let mut list1 = <$list_type>::new(MemType::Vram).unwrap();
            list1.add_desc(0x1000, 0x100, 0);
            list1.add_desc(0x2000, 0x200, 1);
            let serialized1 = list1.serialize().unwrap();

            let mut list2 = <$list_type>::new(MemType::Vram).unwrap();
            list2.add_desc(0x2000, 0x200, 1);  // Different order
            list2.add_desc(0x1000, 0x100, 0);
            let serialized2 = list2.serialize().unwrap();

            assert_ne!(
                serialized1,
                serialized2,
                "{}: different order should serialize differently",
                std::any::type_name::<$list_type>()
            );
        }};
    }

    test_order_sensitivity!(RegDescList);
    test_order_sensitivity!(XferDescList);
}

// Test: RegDescList-specific metadata serialization
#[test]
fn test_reg_desc_list_serialize_metadata() {
    // Metadata in serialization
    let mut reg_list_meta = RegDescList::new(MemType::Block).unwrap();
    reg_list_meta.add_desc_with_meta(0x3000, 0x300, 2, b"test_metadata");
    let serialized_meta = reg_list_meta.serialize().unwrap();
    assert!(!serialized_meta.is_empty(), "List with metadata should serialize");
    println!("RegDescList with metadata serialized to {} bytes", serialized_meta.len());

    // Different metadata produces different serialization
    let mut reg_list_meta2 = RegDescList::new(MemType::Block).unwrap();
    reg_list_meta2.add_desc_with_meta(0x3000, 0x300, 2, b"different_metadata");
    let serialized_meta2 = reg_list_meta2.serialize().unwrap();
    assert_ne!(serialized_meta, serialized_meta2, "Different metadata should serialize differently");

    // Metadata round-trip
    let deserialized_meta = RegDescList::deserialize(&serialized_meta).unwrap();
    assert_eq!(reg_list_meta, deserialized_meta, "Metadata round-trip should work");
}

// Test: Serialization with real storage using create_storage_list
#[test]
fn test_desc_list_serialize_with_real_storage() {
    const STORAGE_COUNT: usize = 5;
    const SERIALIZATION_ITERATIONS: usize = 3;

    // Create agent and backend
    let (agent, opt_args) =
        create_agent_with_backend("test_agent").expect("Failed to create agent with backend");

    // Create real storage using helper function
    let storage_list = create_storage_list(&agent, &opt_args, STORAGE_COUNT);

    // Macro to test serialization/deserialization with multiple iterations
    macro_rules! test_serialization {
        ($list_type:ty, $storage_iter:expr) => {{
            let mut original_list =
                <$list_type>::new(MemType::Dram).expect("Failed to create descriptor list");
            for storage in $storage_iter {
                original_list
                    .add_storage_desc(storage)
                    .expect("Failed to add storage descriptor");
            }

            // Initial serialization
            let mut current_serialized = original_list
                .serialize()
                .expect(&format!("Failed to serialize {}", std::any::type_name::<$list_type>()));
            println!(
                "{} with {} storage objects serialized to {} bytes",
                std::any::type_name::<$list_type>(),
                STORAGE_COUNT,
                current_serialized.len()
            );

            let mut current_list = original_list;
            let initial_serialized = current_serialized.clone();

            // Perform multiple serialization/deserialization iterations
            for iteration in 0..SERIALIZATION_ITERATIONS {
                // Deserialize
                let deserialized = <$list_type>::deserialize(&current_serialized).expect(
                    &format!(
                        "Failed to deserialize {} at iteration {}",
                        std::any::type_name::<$list_type>(),
                        iteration
                    ),
                );

                // Verify deserialized list equals current list
                assert_eq!(
                    current_list,
                    deserialized,
                    "{}: Iteration {}: Deserialized list should equal current list",
                    std::any::type_name::<$list_type>(),
                    iteration
                );

                // Verify properties on first iteration
                if iteration == 0 {
                    assert_eq!(deserialized.len().unwrap(), STORAGE_COUNT);
                    assert_eq!(deserialized.get_type().unwrap(), MemType::Dram);
                }

                // Serialize again
                let reserialized = deserialized
                    .serialize()
                    .expect(&format!("Failed to reserialize at iteration {}", iteration));

                // Verify deterministic serialization (same bytes across iterations)
                assert_eq!(
                    initial_serialized,
                    reserialized,
                    "{}: Iteration {}: Serialization should produce identical bytes",
                    std::any::type_name::<$list_type>(),
                    iteration
                );

                current_list = deserialized;
                current_serialized = reserialized;
            }

            println!(
                "{} passed {} serialization iterations",
                std::any::type_name::<$list_type>(),
                SERIALIZATION_ITERATIONS
            );
        }};
    }

    test_serialization!(XferDescList, storage_list.iter());
    test_serialization!(RegDescList, storage_list.iter());
}