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 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273
// Copyright (c) 2016 The vulkano developers
// Licensed under the Apache License, Version 2.0
// <LICENSE-APACHE or
// https://www.apache.org/licenses/LICENSE-2.0> or the MIT
// license <LICENSE-MIT or https://opensource.org/licenses/MIT>,
// at your option. All files in the project carrying such
// notice may not be copied, modified, or distributed except
// according to those terms.
use super::{DedicatedAllocation, DedicatedTo, DeviceAlignment};
use crate::{
device::{Device, DeviceOwned},
instance::InstanceOwnedDebugWrapper,
macros::{impl_id_counter, vulkan_bitflags, vulkan_bitflags_enum},
memory::{is_aligned, MemoryPropertyFlags},
DeviceSize, Requires, RequiresAllOf, RequiresOneOf, Validated, ValidationError, Version,
VulkanError, VulkanObject,
};
use std::{
ffi::c_void,
fs::File,
mem::MaybeUninit,
num::NonZeroU64,
ops::Range,
ptr::{self, NonNull},
slice,
sync::{atomic::Ordering, Arc},
};
/// Represents memory that has been allocated from the device.
///
/// The destructor of `DeviceMemory` automatically frees the memory.
///
/// # Examples
///
/// ```
/// use vulkano::memory::{DeviceMemory, MemoryAllocateInfo};
///
/// # let device: std::sync::Arc<vulkano::device::Device> = return;
/// let memory_type_index = 0;
///
/// // Allocates 1KB of memory.
/// let memory = DeviceMemory::allocate(
/// device.clone(),
/// MemoryAllocateInfo {
/// allocation_size: 1024,
/// memory_type_index,
/// ..Default::default()
/// },
/// )
/// .unwrap();
/// ```
#[derive(Debug)]
pub struct DeviceMemory {
handle: ash::vk::DeviceMemory,
device: InstanceOwnedDebugWrapper<Arc<Device>>,
id: NonZeroU64,
allocation_size: DeviceSize,
memory_type_index: u32,
dedicated_to: Option<DedicatedTo>,
export_handle_types: ExternalMemoryHandleTypes,
imported_handle_type: Option<ExternalMemoryHandleType>,
flags: MemoryAllocateFlags,
mapping_state: Option<MappingState>,
atom_size: DeviceAlignment,
is_coherent: bool,
}
impl DeviceMemory {
/// Allocates a block of memory from the device.
///
/// Some platforms may have a limit on the maximum size of a single allocation. For example,
/// certain systems may fail to create allocations with a size greater than or equal to 4GB.
///
/// # Panics
///
/// - Panics if `allocate_info.dedicated_allocation` is `Some` and the contained buffer or
/// image does not belong to `device`.
#[inline]
pub fn allocate(
device: Arc<Device>,
mut allocate_info: MemoryAllocateInfo<'_>,
) -> Result<Self, Validated<VulkanError>> {
if !(device.api_version() >= Version::V1_1
|| device.enabled_extensions().khr_dedicated_allocation)
{
// Fall back instead of erroring out.
allocate_info.dedicated_allocation = None;
}
Self::validate_allocate(&device, &allocate_info, None)?;
unsafe { Ok(Self::allocate_unchecked(device, allocate_info, None)?) }
}
/// Imports a block of memory from an external source.
///
/// # Safety
///
/// - See the documentation of the variants of [`MemoryImportInfo`].
///
/// # Panics
///
/// - Panics if `allocate_info.dedicated_allocation` is `Some` and the contained buffer or
/// image does not belong to `device`.
#[inline]
pub unsafe fn import(
device: Arc<Device>,
mut allocate_info: MemoryAllocateInfo<'_>,
import_info: MemoryImportInfo,
) -> Result<Self, Validated<VulkanError>> {
if !(device.api_version() >= Version::V1_1
|| device.enabled_extensions().khr_dedicated_allocation)
{
// Fall back instead of erroring out.
allocate_info.dedicated_allocation = None;
}
Self::validate_allocate(&device, &allocate_info, Some(&import_info))?;
Ok(Self::allocate_unchecked(
device,
allocate_info,
Some(import_info),
)?)
}
#[inline(never)]
fn validate_allocate(
device: &Device,
allocate_info: &MemoryAllocateInfo<'_>,
import_info: Option<&MemoryImportInfo>,
) -> Result<(), Box<ValidationError>> {
allocate_info
.validate(device)
.map_err(|err| err.add_context("allocate_info"))?;
if let Some(import_info) = import_info {
import_info
.validate(device)
.map_err(|err| err.add_context("import_info"))?;
}
Ok(())
}
#[cfg_attr(not(feature = "document_unchecked"), doc(hidden))]
#[inline(never)]
pub unsafe fn allocate_unchecked(
device: Arc<Device>,
mut allocate_info: MemoryAllocateInfo<'_>,
import_info: Option<MemoryImportInfo>,
) -> Result<Self, VulkanError> {
if !(device.api_version() >= Version::V1_1
|| device.enabled_extensions().khr_dedicated_allocation)
{
// Fall back instead of erroring out
allocate_info.dedicated_allocation = None;
}
let MemoryAllocateInfo {
allocation_size,
memory_type_index,
dedicated_allocation,
export_handle_types,
flags,
_ne: _,
} = allocate_info;
let mut allocate_info_vk = ash::vk::MemoryAllocateInfo {
allocation_size,
memory_type_index,
..Default::default()
};
let mut dedicated_allocate_info_vk = None;
let mut export_allocate_info_vk = None;
let mut import_fd_info_vk = None;
let mut import_win32_handle_info_vk = None;
let mut flags_info_vk = None;
// VUID-VkMemoryDedicatedAllocateInfo-image-01432
if let Some(dedicated_allocation) = dedicated_allocation {
let next = dedicated_allocate_info_vk.insert(match dedicated_allocation {
DedicatedAllocation::Buffer(buffer) => ash::vk::MemoryDedicatedAllocateInfo {
buffer: buffer.handle(),
..Default::default()
},
DedicatedAllocation::Image(image) => ash::vk::MemoryDedicatedAllocateInfo {
image: image.handle(),
..Default::default()
},
});
next.p_next = allocate_info_vk.p_next;
allocate_info_vk.p_next = next as *const _ as *const _;
}
if !export_handle_types.is_empty() {
let next = export_allocate_info_vk.insert(ash::vk::ExportMemoryAllocateInfo {
handle_types: export_handle_types.into(),
..Default::default()
});
next.p_next = allocate_info_vk.p_next;
allocate_info_vk.p_next = next as *const _ as *const _;
}
let imported_handle_type = import_info.as_ref().map(|import_info| match import_info {
MemoryImportInfo::Fd { handle_type, .. } => *handle_type,
MemoryImportInfo::Win32 { handle_type, .. } => *handle_type,
});
if let Some(import_info) = import_info {
match import_info {
MemoryImportInfo::Fd { handle_type, file } => {
#[cfg(unix)]
let fd = {
use std::os::fd::IntoRawFd;
file.into_raw_fd()
};
#[cfg(not(unix))]
let fd = {
let _ = file;
-1
};
let next = import_fd_info_vk.insert(ash::vk::ImportMemoryFdInfoKHR {
handle_type: handle_type.into(),
fd,
..Default::default()
});
next.p_next = allocate_info_vk.p_next;
allocate_info_vk.p_next = next as *const _ as *const _;
}
MemoryImportInfo::Win32 {
handle_type,
handle,
} => {
let next = import_win32_handle_info_vk.insert(
ash::vk::ImportMemoryWin32HandleInfoKHR {
handle_type: handle_type.into(),
handle,
..Default::default()
},
);
next.p_next = allocate_info_vk.p_next;
allocate_info_vk.p_next = next as *const _ as *const _;
}
}
}
if !flags.is_empty() {
let next = flags_info_vk.insert(ash::vk::MemoryAllocateFlagsInfo {
flags: flags.into(),
..Default::default()
});
next.p_next = allocate_info_vk.p_next;
allocate_info_vk.p_next = next as *const _ as *const _;
}
// VUID-vkAllocateMemory-maxMemoryAllocationCount-04101
let max_allocations = device
.physical_device()
.properties()
.max_memory_allocation_count;
device
.allocation_count
.fetch_update(Ordering::Acquire, Ordering::Relaxed, move |count| {
(count < max_allocations).then_some(count + 1)
})
.map_err(|_| VulkanError::TooManyObjects)?;
let handle = {
let fns = device.fns();
let mut output = MaybeUninit::uninit();
(fns.v1_0.allocate_memory)(
device.handle(),
&allocate_info_vk,
ptr::null(),
output.as_mut_ptr(),
)
.result()
.map_err(|e| {
device.allocation_count.fetch_sub(1, Ordering::Release);
VulkanError::from(e)
})?;
output.assume_init()
};
let atom_size = device.physical_device().properties().non_coherent_atom_size;
let is_coherent = device.physical_device().memory_properties().memory_types
[memory_type_index as usize]
.property_flags
.intersects(MemoryPropertyFlags::HOST_COHERENT);
Ok(DeviceMemory {
handle,
device: InstanceOwnedDebugWrapper(device),
id: Self::next_id(),
allocation_size,
memory_type_index,
dedicated_to: dedicated_allocation.map(Into::into),
export_handle_types,
imported_handle_type,
flags,
mapping_state: None,
atom_size,
is_coherent,
})
}
/// Creates a new `DeviceMemory` from a raw object handle.
///
/// # Safety
///
/// - `handle` must be a valid Vulkan object handle created from `device`.
/// - `allocate_info` must match the info used to create the object.
#[inline]
pub unsafe fn from_handle(
device: Arc<Device>,
handle: ash::vk::DeviceMemory,
allocate_info: MemoryAllocateInfo<'_>,
) -> Self {
let MemoryAllocateInfo {
allocation_size,
memory_type_index,
dedicated_allocation,
export_handle_types,
flags,
_ne: _,
} = allocate_info;
let atom_size = device.physical_device().properties().non_coherent_atom_size;
let is_coherent = device.physical_device().memory_properties().memory_types
[memory_type_index as usize]
.property_flags
.intersects(MemoryPropertyFlags::HOST_COHERENT);
DeviceMemory {
handle,
device: InstanceOwnedDebugWrapper(device),
id: Self::next_id(),
allocation_size,
memory_type_index,
dedicated_to: dedicated_allocation.map(Into::into),
export_handle_types,
imported_handle_type: None,
flags,
mapping_state: None,
atom_size,
is_coherent,
}
}
/// Returns the index of the memory type that this memory was allocated from.
#[inline]
pub fn memory_type_index(&self) -> u32 {
self.memory_type_index
}
/// Returns the size in bytes of the memory allocation.
#[inline]
pub fn allocation_size(&self) -> DeviceSize {
self.allocation_size
}
/// Returns `true` if the memory is a [dedicated] to a resource.
///
/// [dedicated]: MemoryAllocateInfo#structfield.dedicated_allocation
#[inline]
pub fn is_dedicated(&self) -> bool {
self.dedicated_to.is_some()
}
pub(crate) fn dedicated_to(&self) -> Option<DedicatedTo> {
self.dedicated_to
}
/// Returns the handle types that can be exported from the memory allocation.
#[inline]
pub fn export_handle_types(&self) -> ExternalMemoryHandleTypes {
self.export_handle_types
}
/// Returns the handle type that the memory allocation was imported from, if any.
#[inline]
pub fn imported_handle_type(&self) -> Option<ExternalMemoryHandleType> {
self.imported_handle_type
}
/// Returns the flags the memory was allocated with.
#[inline]
pub fn flags(&self) -> MemoryAllocateFlags {
self.flags
}
/// Returns the current mapping state, or [`None`] if the memory is not currently host-mapped.
#[inline]
pub fn mapping_state(&self) -> Option<&MappingState> {
self.mapping_state.as_ref()
}
pub(crate) fn atom_size(&self) -> DeviceAlignment {
self.atom_size
}
pub(crate) fn is_coherent(&self) -> bool {
self.is_coherent
}
/// Maps a range of memory to be accessed by the host.
///
/// `self` must not be host-mapped already and must be allocated from host-visible memory.
#[inline]
pub fn map(&mut self, map_info: MemoryMapInfo) -> Result<(), Validated<VulkanError>> {
self.validate_map(&map_info)?;
unsafe { Ok(self.map_unchecked(map_info)?) }
}
fn validate_map(&self, map_info: &MemoryMapInfo) -> Result<(), Box<ValidationError>> {
if self.mapping_state.is_some() {
return Err(Box::new(ValidationError {
problem: "this device memory is already host-mapped".into(),
vuids: &["VUID-vkMapMemory-memory-00678"],
..Default::default()
}));
}
map_info
.validate(self)
.map_err(|err| err.add_context("map_info"))?;
let memory_type = &self
.device()
.physical_device()
.memory_properties()
.memory_types[self.memory_type_index() as usize];
if !memory_type
.property_flags
.intersects(MemoryPropertyFlags::HOST_VISIBLE)
{
return Err(Box::new(ValidationError {
problem: "`self.memory_type_index()` refers to a memory type whose \
`property_flags` does not contain `MemoryPropertyFlags::HOST_VISIBLE`"
.into(),
vuids: &["VUID-vkMapMemory-memory-00682"],
..Default::default()
}));
}
Ok(())
}
#[cfg_attr(not(feature = "document_unchecked"), doc(hidden))]
pub unsafe fn map_unchecked(&mut self, map_info: MemoryMapInfo) -> Result<(), VulkanError> {
let MemoryMapInfo {
offset,
size,
_ne: _,
} = map_info;
// Sanity check: this would lead to UB when calculating pointer offsets.
assert!(size <= isize::MAX.try_into().unwrap());
let device = self.device();
let ptr = {
let fns = device.fns();
let mut output = MaybeUninit::uninit();
if device.enabled_extensions().khr_map_memory2 {
let map_info_vk = ash::vk::MemoryMapInfoKHR {
flags: ash::vk::MemoryMapFlags::empty(),
memory: self.handle(),
offset,
size,
..Default::default()
};
(fns.khr_map_memory2.map_memory2_khr)(
device.handle(),
&map_info_vk,
output.as_mut_ptr(),
)
.result()
.map_err(VulkanError::from)?;
} else {
(fns.v1_0.map_memory)(
device.handle(),
self.handle,
offset,
size,
ash::vk::MemoryMapFlags::empty(),
output.as_mut_ptr(),
)
.result()
.map_err(VulkanError::from)?;
}
output.assume_init()
};
let ptr = NonNull::new(ptr).unwrap();
let range = offset..offset + size;
self.mapping_state = Some(MappingState { ptr, range });
Ok(())
}
/// Unmaps the memory. It will no longer be accessible from the host.
///
/// `self` must be currently host-mapped.
//
// NOTE(Marc): The `&mut` here is more than just because we need to mutate the struct.
// `vkMapMemory` and `vkUnmapMemory` must be externally synchronized, but more importantly, if
// we allowed unmapping through a shared reference, it would be possible to unmap a resource
// that's currently being read or written by the host elsewhere, requiring even more locking on
// each host access.
#[inline]
pub fn unmap(&mut self, unmap_info: MemoryUnmapInfo) -> Result<(), Validated<VulkanError>> {
self.validate_unmap(&unmap_info)?;
unsafe { self.unmap_unchecked(unmap_info) }?;
Ok(())
}
fn validate_unmap(&self, unmap_info: &MemoryUnmapInfo) -> Result<(), Box<ValidationError>> {
if self.mapping_state.is_none() {
return Err(Box::new(ValidationError {
problem: "this device memory is not currently host-mapped".into(),
vuids: &["VUID-vkUnmapMemory-memory-00689"],
..Default::default()
}));
}
unmap_info
.validate(self)
.map_err(|err| err.add_context("unmap_info"))?;
Ok(())
}
#[cfg_attr(not(feature = "document_unchecked"), doc(hidden))]
pub unsafe fn unmap_unchecked(
&mut self,
unmap_info: MemoryUnmapInfo,
) -> Result<(), VulkanError> {
let MemoryUnmapInfo { _ne: _ } = unmap_info;
let device = self.device();
let fns = device.fns();
if device.enabled_extensions().khr_map_memory2 {
let unmap_info_vk = ash::vk::MemoryUnmapInfoKHR {
flags: ash::vk::MemoryUnmapFlagsKHR::empty(),
memory: self.handle(),
..Default::default()
};
(fns.khr_map_memory2.unmap_memory2_khr)(device.handle(), &unmap_info_vk)
.result()
.map_err(VulkanError::from)?;
} else {
(fns.v1_0.unmap_memory)(device.handle(), self.handle);
}
self.mapping_state = None;
Ok(())
}
/// Invalidates the host cache for a range of mapped memory.
///
/// If the device memory is not [host-coherent], you must call this function before the memory
/// is read by the host, if the device previously wrote to the memory. It has no effect if the
/// memory is host-coherent.
///
/// # Safety
///
/// - If there are memory writes by the device that have not been propagated into the host
/// cache, then there must not be any references in Rust code to any portion of the specified
/// `memory_range`.
///
/// [host-coherent]: crate::memory::MemoryPropertyFlags::HOST_COHERENT
/// [`map`]: Self::map
/// [`non_coherent_atom_size`]: crate::device::Properties::non_coherent_atom_size
#[inline]
pub unsafe fn invalidate_range(
&self,
memory_range: MappedMemoryRange,
) -> Result<(), Validated<VulkanError>> {
self.validate_memory_range(&memory_range)?;
Ok(self.invalidate_range_unchecked(memory_range)?)
}
#[cfg_attr(not(feature = "document_unchecked"), doc(hidden))]
#[inline]
pub unsafe fn invalidate_range_unchecked(
&self,
memory_range: MappedMemoryRange,
) -> Result<(), VulkanError> {
if self.is_coherent {
return Ok(());
}
let MappedMemoryRange {
offset,
size,
_ne: _,
} = memory_range;
let memory_range_vk = ash::vk::MappedMemoryRange {
memory: self.handle(),
offset,
size,
..Default::default()
};
let fns = self.device().fns();
(fns.v1_0.invalidate_mapped_memory_ranges)(self.device().handle(), 1, &memory_range_vk)
.result()
.map_err(VulkanError::from)?;
Ok(())
}
/// Flushes the host cache for a range of mapped memory.
///
/// If the device memory is not [host-coherent], you must call this function after writing to
/// the memory, if the device is going to read the memory. It has no effect if the memory is
/// host-coherent.
///
/// # Safety
///
/// - There must be no operations pending or executing in a device queue, that access the
/// specified `memory_range`.
///
/// [host-coherent]: crate::memory::MemoryPropertyFlags::HOST_COHERENT
/// [`map`]: Self::map
/// [`non_coherent_atom_size`]: crate::device::Properties::non_coherent_atom_size
#[inline]
pub unsafe fn flush_range(
&self,
memory_range: MappedMemoryRange,
) -> Result<(), Validated<VulkanError>> {
self.validate_memory_range(&memory_range)?;
Ok(self.flush_range_unchecked(memory_range)?)
}
#[cfg_attr(not(feature = "document_unchecked"), doc(hidden))]
#[inline]
pub unsafe fn flush_range_unchecked(
&self,
memory_range: MappedMemoryRange,
) -> Result<(), VulkanError> {
if self.is_coherent {
return Ok(());
}
let MappedMemoryRange {
offset,
size,
_ne: _,
} = memory_range;
let memory_range_vk = ash::vk::MappedMemoryRange {
memory: self.handle(),
offset,
size,
..Default::default()
};
let fns = self.device().fns();
(fns.v1_0.flush_mapped_memory_ranges)(self.device().handle(), 1, &memory_range_vk)
.result()
.map_err(VulkanError::from)?;
Ok(())
}
// NOTE(Marc): We are validating the parameters regardless of whether the memory is
// non-coherent on purpose, to catch potential bugs arising because the code isn't tested on
// such hardware.
fn validate_memory_range(
&self,
memory_range: &MappedMemoryRange,
) -> Result<(), Box<ValidationError>> {
memory_range
.validate(self)
.map_err(|err| err.add_context("memory_range"))?;
Ok(())
}
/// Retrieves the amount of lazily-allocated memory that is currently commited to this
/// memory object.
///
/// The device may change this value at any time, and the returned value may be
/// already out-of-date.
///
/// `self` must have been allocated from a memory type that has the [`LAZILY_ALLOCATED`] flag
/// set.
///
/// [`LAZILY_ALLOCATED`]: crate::memory::MemoryPropertyFlags::LAZILY_ALLOCATED
#[inline]
pub fn commitment(&self) -> Result<DeviceSize, Box<ValidationError>> {
self.validate_commitment()?;
unsafe { Ok(self.commitment_unchecked()) }
}
fn validate_commitment(&self) -> Result<(), Box<ValidationError>> {
let memory_type = &self
.device
.physical_device()
.memory_properties()
.memory_types[self.memory_type_index as usize];
if !memory_type
.property_flags
.intersects(MemoryPropertyFlags::LAZILY_ALLOCATED)
{
return Err(Box::new(ValidationError {
problem: "the `property_flags` of the memory type does not contain the \
`MemoryPropertyFlags::LAZILY_ALLOCATED` flag"
.into(),
vuids: &["VUID-vkGetDeviceMemoryCommitment-memory-00690"],
..Default::default()
}));
}
Ok(())
}
#[cfg_attr(not(feature = "document_unchecked"), doc(hidden))]
#[inline]
pub unsafe fn commitment_unchecked(&self) -> DeviceSize {
let mut output: DeviceSize = 0;
let fns = self.device.fns();
(fns.v1_0.get_device_memory_commitment)(self.device.handle(), self.handle, &mut output);
output
}
/// Exports the device memory into a Unix file descriptor. The caller owns the returned `File`.
///
/// # Panics
///
/// - Panics if the user requests an invalid handle type for this device memory object.
#[inline]
pub fn export_fd(
&self,
handle_type: ExternalMemoryHandleType,
) -> Result<File, Validated<VulkanError>> {
self.validate_export_fd(handle_type)?;
unsafe { Ok(self.export_fd_unchecked(handle_type)?) }
}
fn validate_export_fd(
&self,
handle_type: ExternalMemoryHandleType,
) -> Result<(), Box<ValidationError>> {
handle_type.validate_device(&self.device).map_err(|err| {
err.add_context("handle_type")
.set_vuids(&["VUID-VkMemoryGetFdInfoKHR-handleType-parameter"])
})?;
if !matches!(
handle_type,
ExternalMemoryHandleType::OpaqueFd | ExternalMemoryHandleType::DmaBuf
) {
return Err(Box::new(ValidationError {
context: "handle_type".into(),
problem: "is not `ExternalMemoryHandleType::OpaqueFd` or \
`ExternalMemoryHandleType::DmaBuf`"
.into(),
vuids: &["VUID-VkMemoryGetFdInfoKHR-handleType-00672"],
..Default::default()
}));
}
if !self.export_handle_types.contains_enum(handle_type) {
return Err(Box::new(ValidationError {
context: "handle_type".into(),
problem: "is not contained in this memory's `export_handle_types`".into(),
vuids: &["VUID-VkMemoryGetFdInfoKHR-handleType-00671"],
..Default::default()
}));
}
Ok(())
}
#[cfg_attr(not(feature = "document_unchecked"), doc(hidden))]
pub unsafe fn export_fd_unchecked(
&self,
handle_type: ExternalMemoryHandleType,
) -> Result<File, VulkanError> {
let info_vk = ash::vk::MemoryGetFdInfoKHR {
memory: self.handle,
handle_type: handle_type.into(),
..Default::default()
};
let fns = self.device.fns();
let mut output = MaybeUninit::uninit();
(fns.khr_external_memory_fd.get_memory_fd_khr)(
self.device.handle(),
&info_vk,
output.as_mut_ptr(),
)
.result()
.map_err(VulkanError::from)?;
#[cfg(unix)]
{
use std::os::unix::io::FromRawFd;
Ok(File::from_raw_fd(output.assume_init()))
}
#[cfg(not(unix))]
{
let _ = output;
unreachable!("`khr_external_memory_fd` was somehow enabled on a non-Unix system");
}
}
}
impl Drop for DeviceMemory {
#[inline]
fn drop(&mut self) {
unsafe {
let fns = self.device.fns();
(fns.v1_0.free_memory)(self.device.handle(), self.handle, ptr::null());
self.device.allocation_count.fetch_sub(1, Ordering::Release);
}
}
}
unsafe impl VulkanObject for DeviceMemory {
type Handle = ash::vk::DeviceMemory;
#[inline]
fn handle(&self) -> Self::Handle {
self.handle
}
}
unsafe impl DeviceOwned for DeviceMemory {
#[inline]
fn device(&self) -> &Arc<Device> {
&self.device
}
}
impl_id_counter!(DeviceMemory);
/// Parameters to allocate a new `DeviceMemory`.
#[derive(Clone, Debug)]
pub struct MemoryAllocateInfo<'d> {
/// The number of bytes to allocate.
///
/// The default value is `0`, which must be overridden.
pub allocation_size: DeviceSize,
/// The index of the memory type that should be allocated.
///
/// The default value is [`u32::MAX`], which must be overridden.
pub memory_type_index: u32,
/// Allocates memory for a specific buffer or image.
///
/// This value is silently ignored (treated as `None`) if the device API version is less than
/// 1.1 and the
/// [`khr_dedicated_allocation`](crate::device::DeviceExtensions::khr_dedicated_allocation)
/// extension is not enabled on the device.
pub dedicated_allocation: Option<DedicatedAllocation<'d>>,
/// The handle types that can be exported from the allocated memory.
pub export_handle_types: ExternalMemoryHandleTypes,
/// Additional flags for the memory allocation.
///
/// If not empty, the device API version must be at least 1.1, or the
/// [`khr_device_group`](crate::device::DeviceExtensions::khr_device_group) extension must be
/// enabled on the device.
///
/// The default value is [`MemoryAllocateFlags::empty()`].
pub flags: MemoryAllocateFlags,
pub _ne: crate::NonExhaustive,
}
impl Default for MemoryAllocateInfo<'static> {
#[inline]
fn default() -> Self {
Self {
allocation_size: 0,
memory_type_index: u32::MAX,
dedicated_allocation: None,
export_handle_types: ExternalMemoryHandleTypes::empty(),
flags: MemoryAllocateFlags::empty(),
_ne: crate::NonExhaustive(()),
}
}
}
impl<'d> MemoryAllocateInfo<'d> {
/// Returns a `MemoryAllocateInfo` with the specified `dedicated_allocation`.
#[inline]
pub fn dedicated_allocation(dedicated_allocation: DedicatedAllocation<'d>) -> Self {
Self {
allocation_size: 0,
memory_type_index: u32::MAX,
dedicated_allocation: Some(dedicated_allocation),
export_handle_types: ExternalMemoryHandleTypes::empty(),
flags: MemoryAllocateFlags::empty(),
_ne: crate::NonExhaustive(()),
}
}
pub(crate) fn validate(&self, device: &Device) -> Result<(), Box<ValidationError>> {
let &Self {
allocation_size,
memory_type_index,
ref dedicated_allocation,
export_handle_types,
flags,
_ne: _,
} = self;
let memory_properties = device.physical_device().memory_properties();
let memory_type = memory_properties
.memory_types
.get(memory_type_index as usize)
.ok_or_else(|| {
Box::new(ValidationError {
context: "memory_type_index".into(),
problem: "is not less than the number of memory types in the device".into(),
vuids: &["VUID-vkAllocateMemory-pAllocateInfo-01714"],
..Default::default()
})
})?;
let memory_heap = &memory_properties.memory_heaps[memory_type.heap_index as usize];
if memory_type
.property_flags
.intersects(MemoryPropertyFlags::PROTECTED)
&& !device.enabled_features().protected_memory
{
return Err(Box::new(ValidationError {
context: "memory_type_index".into(),
problem: "refers to a memory type where `property_flags` contains \
`MemoryPropertyFlags::PROTECTED`"
.into(),
requires_one_of: RequiresOneOf(&[RequiresAllOf(&[Requires::Feature(
"protected_memory",
)])]),
vuids: &["VUID-VkMemoryAllocateInfo-memoryTypeIndex-01872"],
}));
}
if memory_type
.property_flags
.intersects(MemoryPropertyFlags::DEVICE_COHERENT)
&& !device.enabled_features().device_coherent_memory
{
return Err(Box::new(ValidationError {
context: "memory_type_index".into(),
problem: "refers to a memory type where `property_flags` contains \
`MemoryPropertyFlags::DEVICE_COHERENT`"
.into(),
requires_one_of: RequiresOneOf(&[RequiresAllOf(&[Requires::Feature(
"device_coherent_memory",
)])]),
vuids: &["VUID-vkAllocateMemory-deviceCoherentMemory-02790"],
}));
}
if allocation_size == 0 {
return Err(Box::new(ValidationError {
context: "allocation_size".into(),
problem: "is zero".into(),
vuids: &["VUID-VkMemoryAllocateInfo-pNext-01874"],
..Default::default()
}));
}
if memory_heap.size != 0 && allocation_size > memory_heap.size {
return Err(Box::new(ValidationError {
context: "allocation_size".into(),
problem: "is greater than the size of the memory heap".into(),
vuids: &["VUID-vkAllocateMemory-pAllocateInfo-01713"],
..Default::default()
}));
}
if let Some(dedicated_allocation) = dedicated_allocation {
match dedicated_allocation {
DedicatedAllocation::Buffer(buffer) => {
// VUID-VkMemoryDedicatedAllocateInfo-commonparent
assert_eq!(device, buffer.device().as_ref());
let required_size = buffer.memory_requirements().layout.size();
if allocation_size != required_size {
return Err(Box::new(ValidationError {
problem: "`allocation_size` does not equal the size required for the \
buffer specified in `dedicated_allocation`"
.into(),
vuids: &["VUID-VkMemoryDedicatedAllocateInfo-buffer-02965"],
..Default::default()
}));
}
}
DedicatedAllocation::Image(image) => {
// VUID-VkMemoryDedicatedAllocateInfo-commonparent
assert_eq!(device, image.device().as_ref());
let required_size = image.memory_requirements()[0].layout.size();
if allocation_size != required_size {
return Err(Box::new(ValidationError {
problem: "`allocation_size` does not equal the size required for the \
image specified in `dedicated_allocation`"
.into(),
vuids: &["VUID-VkMemoryDedicatedAllocateInfo-image-02964"],
..Default::default()
}));
}
}
}
}
if !export_handle_types.is_empty() {
if !(device.api_version() >= Version::V1_1
|| device.enabled_extensions().khr_external_memory)
{
return Err(Box::new(ValidationError {
context: "export_handle_types".into(),
problem: "is not empty".into(),
requires_one_of: RequiresOneOf(&[
RequiresAllOf(&[Requires::APIVersion(Version::V1_1)]),
RequiresAllOf(&[Requires::DeviceExtension("khr_external_memory")]),
]),
..Default::default()
}));
}
export_handle_types.validate_device(device).map_err(|err| {
err.add_context("export_handle_types")
.set_vuids(&["VUID-VkExportMemoryAllocateInfo-handleTypes-parameter"])
})?;
// VUID-VkMemoryAllocateInfo-pNext-00639
// VUID-VkExportMemoryAllocateInfo-handleTypes-00656
// Impossible to validate here, instead this is validated in `RawBuffer::bind_memory`
// and `RawImage::bind_memory`.
}
if !flags.is_empty() {
if !(device.physical_device().api_version() >= Version::V1_1
|| device.enabled_extensions().khr_device_group)
{
return Err(Box::new(ValidationError {
context: "flags".into(),
problem: "is not empty".into(),
requires_one_of: RequiresOneOf(&[
RequiresAllOf(&[Requires::APIVersion(Version::V1_1)]),
RequiresAllOf(&[Requires::DeviceExtension("khr_device_group")]),
]),
..Default::default()
}));
}
if flags.intersects(MemoryAllocateFlags::DEVICE_ADDRESS) {
if !((device.api_version() >= Version::V1_2
|| device.enabled_extensions().khr_buffer_device_address)
&& device.enabled_features().buffer_device_address)
{
return Err(Box::new(ValidationError {
context: "flags".into(),
problem: "contains `MemoryAllocateFlags::DEVICE_ADDRESS`".into(),
requires_one_of: RequiresOneOf(&[
RequiresAllOf(&[
Requires::APIVersion(Version::V1_2),
Requires::Feature("buffer_device_address"),
]),
RequiresAllOf(&[
Requires::DeviceExtension("khr_buffer_device_address"),
Requires::Feature("buffer_device_address"),
]),
]),
vuids: &["VUID-VkMemoryAllocateInfo-flags-03331"],
}));
}
}
}
Ok(())
}
}
/// Parameters to import memory from an external source.
#[derive(Debug)]
#[non_exhaustive]
pub enum MemoryImportInfo {
/// Import memory from a Unix file descriptor.
///
/// `handle_type` must be either [`ExternalMemoryHandleType::OpaqueFd`] or
/// [`ExternalMemoryHandleType::DmaBuf`].
///
/// # Safety
///
/// - `file` must be a valid Unix file descriptor.
/// - Vulkan will take ownership of `file`, and once the memory is imported, you must not
/// perform any operations on `file` nor on any of its clones/duplicates.
/// - If `file` was created by the Vulkan API, and `handle_type` is
/// [`ExternalMemoryHandleType::OpaqueFd`]:
/// - [`MemoryAllocateInfo::allocation_size`] and [`MemoryAllocateInfo::memory_type_index`]
/// must match those of the original memory allocation.
/// - If the original memory allocation used [`MemoryAllocateInfo::dedicated_allocation`],
/// the imported one must also use it, and the associated buffer or image must be defined
/// identically to the original.
/// - If `file` was not created by the Vulkan API, then
/// [`MemoryAllocateInfo::memory_type_index`] must be one of the memory types returned by
/// [`Device::memory_fd_properties`].
Fd {
handle_type: ExternalMemoryHandleType,
file: File,
},
/// Import memory from a Windows handle.
///
/// `handle_type` must be either [`ExternalMemoryHandleType::OpaqueWin32`] or
/// [`ExternalMemoryHandleType::OpaqueWin32Kmt`].
///
/// # Safety
///
/// - `handle` must be a valid Windows handle.
/// - Vulkan will not take ownership of `handle`.
/// - If `handle_type` is [`ExternalMemoryHandleType::OpaqueWin32`], it owns a reference
/// to the underlying resource and must eventually be closed by the caller.
/// - If `handle_type` is [`ExternalMemoryHandleType::OpaqueWin32Kmt`], it does not own a
/// reference to the underlying resource.
/// - `handle` must be created by the Vulkan API.
/// - [`MemoryAllocateInfo::allocation_size`] and [`MemoryAllocateInfo::memory_type_index`]
/// must match those of the original memory allocation.
/// - If the original memory allocation used [`MemoryAllocateInfo::dedicated_allocation`],
/// the imported one must also use it, and the associated buffer or image must be defined
/// identically to the original.
Win32 {
handle_type: ExternalMemoryHandleType,
handle: ash::vk::HANDLE,
},
}
impl MemoryImportInfo {
pub(crate) fn validate(&self, device: &Device) -> Result<(), Box<ValidationError>> {
match self {
MemoryImportInfo::Fd {
handle_type,
file: _,
} => {
if !device.enabled_extensions().khr_external_memory_fd {
return Err(Box::new(ValidationError {
problem: "is `MemoryImportInfo::Fd`".into(),
requires_one_of: RequiresOneOf(&[RequiresAllOf(&[
Requires::DeviceExtension("khr_external_memory_fd"),
])]),
..Default::default()
}));
}
handle_type.validate_device(device).map_err(|err| {
err.add_context("handle_type")
.set_vuids(&["VUID-VkImportMemoryFdInfoKHR-handleType-parameter"])
})?;
match handle_type {
ExternalMemoryHandleType::OpaqueFd => {
// VUID-VkMemoryAllocateInfo-allocationSize-01742
// Can't validate, must be ensured by user
// VUID-VkMemoryDedicatedAllocateInfo-buffer-01879
// Can't validate, must be ensured by user
// VUID-VkMemoryDedicatedAllocateInfo-image-01878
// Can't validate, must be ensured by user
}
ExternalMemoryHandleType::DmaBuf => {}
_ => {
return Err(Box::new(ValidationError {
context: "handle_type".into(),
problem: "is not `ExternalMemoryHandleType::OpaqueFd` or \
`ExternalMemoryHandleType::DmaBuf`"
.into(),
vuids: &["VUID-VkImportMemoryFdInfoKHR-handleType-00669"],
..Default::default()
}));
}
}
// VUID-VkMemoryAllocateInfo-memoryTypeIndex-00648
// Can't validate, must be ensured by user
}
MemoryImportInfo::Win32 {
handle_type,
handle: _,
} => {
if !device.enabled_extensions().khr_external_memory_win32 {
return Err(Box::new(ValidationError {
problem: "is `MemoryImportInfo::Win32`".into(),
requires_one_of: RequiresOneOf(&[RequiresAllOf(&[
Requires::DeviceExtension("khr_external_memory_win32"),
])]),
..Default::default()
}));
}
handle_type.validate_device(device).map_err(|err| {
err.add_context("handle_type")
.set_vuids(&["VUID-VkImportMemoryWin32HandleInfoKHR-handleType-parameter"])
})?;
match handle_type {
ExternalMemoryHandleType::OpaqueWin32
| ExternalMemoryHandleType::OpaqueWin32Kmt => {
// VUID-VkMemoryAllocateInfo-allocationSize-01742
// Can't validate, must be ensured by user
// VUID-VkMemoryDedicatedAllocateInfo-buffer-01879
// Can't validate, must be ensured by user
// VUID-VkMemoryDedicatedAllocateInfo-image-01878
// Can't validate, must be ensured by user
}
_ => {
return Err(Box::new(ValidationError {
context: "handle_type".into(),
problem: "is not `ExternalMemoryHandleType::OpaqueWin32` or \
`ExternalMemoryHandleType::OpaqueWin32Kmt`"
.into(),
vuids: &["VUID-VkImportMemoryWin32HandleInfoKHR-handleType-00660"],
..Default::default()
}));
}
}
// VUID-VkMemoryAllocateInfo-memoryTypeIndex-00645
// Can't validate, must be ensured by user
}
}
Ok(())
}
}
vulkan_bitflags_enum! {
#[non_exhaustive]
/// A set of [`ExternalMemoryHandleType`] values.
ExternalMemoryHandleTypes,
/// A handle type used to export or import memory to/from an external source.
ExternalMemoryHandleType,
= ExternalMemoryHandleTypeFlags(u32);
/// A POSIX file descriptor handle that is only usable with Vulkan and compatible APIs.
OPAQUE_FD, OpaqueFd = OPAQUE_FD,
/// A Windows NT handle that is only usable with Vulkan and compatible APIs.
OPAQUE_WIN32, OpaqueWin32 = OPAQUE_WIN32,
/// A Windows global share handle that is only usable with Vulkan and compatible APIs.
OPAQUE_WIN32_KMT, OpaqueWin32Kmt = OPAQUE_WIN32_KMT,
/// A Windows NT handle that refers to a Direct3D 10 or 11 texture resource.
D3D11_TEXTURE, D3D11Texture = D3D11_TEXTURE,
/// A Windows global share handle that refers to a Direct3D 10 or 11 texture resource.
D3D11_TEXTURE_KMT, D3D11TextureKmt = D3D11_TEXTURE_KMT,
/// A Windows NT handle that refers to a Direct3D 12 heap resource.
D3D12_HEAP, D3D12Heap = D3D12_HEAP,
/// A Windows NT handle that refers to a Direct3D 12 committed resource.
D3D12_RESOURCE, D3D12Resource = D3D12_RESOURCE,
/// A POSIX file descriptor handle that refers to a Linux dma-buf.
DMA_BUF, DmaBuf = DMA_BUF_EXT
RequiresOneOf([
RequiresAllOf([DeviceExtension(ext_external_memory_dma_buf)]),
]),
/// A handle for an Android `AHardwareBuffer` object.
ANDROID_HARDWARE_BUFFER, AndroidHardwareBuffer = ANDROID_HARDWARE_BUFFER_ANDROID
RequiresOneOf([
RequiresAllOf([DeviceExtension(android_external_memory_android_hardware_buffer)]),
]),
/// A pointer to memory that was allocated by the host.
HOST_ALLOCATION, HostAllocation = HOST_ALLOCATION_EXT
RequiresOneOf([
RequiresAllOf([DeviceExtension(ext_external_memory_host)]),
]),
/// A pointer to a memory mapping on the host that maps non-host memory.
HOST_MAPPED_FOREIGN_MEMORY, HostMappedForeignMemory = HOST_MAPPED_FOREIGN_MEMORY_EXT
RequiresOneOf([
RequiresAllOf([DeviceExtension(ext_external_memory_host)]),
]),
/// A Zircon handle to a virtual memory object.
ZIRCON_VMO, ZirconVmo = ZIRCON_VMO_FUCHSIA
RequiresOneOf([
RequiresAllOf([DeviceExtension(fuchsia_external_memory)]),
]),
/// A Remote Direct Memory Address handle to an allocation that is accessible by remote devices.
RDMA_ADDRESS, RdmaAddress = RDMA_ADDRESS_NV
RequiresOneOf([
RequiresAllOf([DeviceExtension(nv_external_memory_rdma)]),
]),
}
vulkan_bitflags! {
#[non_exhaustive]
/// Flags specifying additional properties of a device memory allocation.
MemoryAllocateFlags = MemoryAllocateFlags(u32);
/* TODO: enable
DEVICE_MASK = DEVICE_MASK,*/
/// Specifies that the allocated device memory can be bound to a buffer created with the
/// [`SHADER_DEVICE_ADDRESS`] usage. This requires that the [`buffer_device_address`] feature
/// is enabled on the device and the [`ext_buffer_device_address`] extension is not enabled on
/// the device.
///
/// [`SHADER_DEVICE_ADDRESS`]: crate::buffer::BufferUsage::SHADER_DEVICE_ADDRESS
/// [`buffer_device_address`]: crate::device::Features::buffer_device_address
/// [`ext_buffer_device_address`]: crate::device::DeviceExtensions::ext_buffer_device_address
DEVICE_ADDRESS = DEVICE_ADDRESS,
/* TODO: enable
DEVICE_ADDRESS_CAPTURE_REPLAY = DEVICE_ADDRESS_CAPTURE_REPLAY,*/
}
/// Parameters of a memory map operation.
#[derive(Debug)]
pub struct MemoryMapInfo {
/// The offset (in bytes) from the beginning of the `DeviceMemory`, where the mapping starts.
///
/// Must be less than the [`allocation_size`] of the device memory. If the the memory was not
/// allocated from [host-coherent] memory, then this must be a multiple of the
/// [`non_coherent_atom_size`] device property.
///
/// The default value is `0`.
///
/// [`allocation_size`]: DeviceMemory::allocation_size
/// [`non_coherent_atom_size`]: crate::device::Properties::non_coherent_atom_size
pub offset: DeviceSize,
/// The size (in bytes) of the mapping.
///
/// Must be less than or equal to the [`allocation_size`] of the device memory minus `offset`.
/// If the the memory was not allocated from [host-coherent] memory, then this must be a
/// multiple of the [`non_coherent_atom_size`] device property, or be equal to the allocation
/// size minus `offset`.
///
/// The default value is `0`, which must be overridden.
///
/// [`allocation_size`]: DeviceMemory::allocation_size
/// [`non_coherent_atom_size`]: crate::device::Properties::non_coherent_atom_size
pub size: DeviceSize,
pub _ne: crate::NonExhaustive,
}
impl MemoryMapInfo {
pub(crate) fn validate(&self, memory: &DeviceMemory) -> Result<(), Box<ValidationError>> {
let &Self {
offset,
size,
_ne: _,
} = self;
if !(offset < memory.allocation_size()) {
return Err(Box::new(ValidationError {
context: "offset".into(),
problem: "is not less than `self.allocation_size()`".into(),
vuids: &["VUID-vkMapMemory-offset-00679"],
..Default::default()
}));
}
if size == 0 {
return Err(Box::new(ValidationError {
context: "size".into(),
problem: "is zero".into(),
vuids: &["VUID-vkMapMemory-size-00680"],
..Default::default()
}));
}
if !(size <= memory.allocation_size() - offset) {
return Err(Box::new(ValidationError {
context: "size".into(),
problem: "is not less than or equal to `self.allocation_size()` minus `offset`"
.into(),
vuids: &["VUID-vkMapMemory-size-00681"],
..Default::default()
}));
}
let atom_size = memory.atom_size();
// Not required for merely mapping, but without this check the user can end up with
// parts of the mapped memory at the start and end that they're not able to
// invalidate/flush, which is probably unintended.
//
// NOTE(Marc): We also rely on this for soundness, because it is easier and more optimal to
// not have to worry about whether a range of mapped memory is still in bounds of the
// mapped memory after being aligned to the non-coherent atom size.
if !memory.is_coherent
&& (!is_aligned(offset, atom_size)
|| (!is_aligned(size, atom_size) && offset + size != memory.allocation_size()))
{
return Err(Box::new(ValidationError {
problem: "`self.memory_type_index()` refers to a memory type whose \
`property_flags` does not contain `MemoryPropertyFlags::HOST_COHERENT`, and \
`offset` and/or `size` are not aligned to the `non_coherent_atom_size` device \
property"
.into(),
..Default::default()
}));
}
Ok(())
}
}
impl Default for MemoryMapInfo {
#[inline]
fn default() -> Self {
MemoryMapInfo {
offset: 0,
size: 0,
_ne: crate::NonExhaustive(()),
}
}
}
/// Parameters of a memory unmap operation.
#[derive(Debug)]
pub struct MemoryUnmapInfo {
pub _ne: crate::NonExhaustive,
}
impl MemoryUnmapInfo {
pub(crate) fn validate(&self, _memory: &DeviceMemory) -> Result<(), Box<ValidationError>> {
let &Self { _ne: _ } = self;
Ok(())
}
}
impl Default for MemoryUnmapInfo {
#[inline]
fn default() -> Self {
MemoryUnmapInfo {
_ne: crate::NonExhaustive(()),
}
}
}
/// Represents the currently host-mapped region of a [`DeviceMemory`] block.
#[derive(Debug)]
pub struct MappingState {
ptr: NonNull<c_void>,
range: Range<DeviceSize>,
}
// It is safe to share `ptr` between threads because the user would have to use unsafe code
// themself to get UB in the first place.
unsafe impl Send for MappingState {}
unsafe impl Sync for MappingState {}
impl MappingState {
/// Returns the pointer to the start of the mapped memory. Meaning that the pointer is already
/// offset by the [`offset`].
///
/// [`offset`]: Self::offset
#[inline]
pub fn ptr(&self) -> NonNull<c_void> {
self.ptr
}
/// Returns the offset given to [`DeviceMemory::map`].
#[inline]
pub fn offset(&self) -> DeviceSize {
self.range.start
}
/// Returns the size given to [`DeviceMemory::map`].
#[inline]
pub fn size(&self) -> DeviceSize {
self.range.end - self.range.start
}
/// Returns a pointer to a slice of the mapped memory. Returns `None` if out of bounds.
///
/// `range` is specified in bytes relative to the start of the memory allocation, and must fall
/// within the range of the memory mapping given to [`DeviceMemory::map`].
///
/// This function is safe in the sense that the returned pointer is guaranteed to be within
/// bounds of the mapped memory, however dereferencing the pointer isn't:
///
/// - Normal Rust aliasing rules apply: if you create a mutable reference out of the pointer,
/// you must ensure that no other references exist in Rust to any portion of the same memory.
/// - While a reference created from the pointer exists, there must be no operations pending or
/// executing in any queue on the device, that write to any portion of the same memory.
/// - While a mutable reference created from the pointer exists, there must be no operations
/// pending or executing in any queue on the device, that read from any portion of the same
/// memory.
#[inline]
pub fn slice(&self, range: Range<DeviceSize>) -> Option<NonNull<[u8]>> {
if self.range.start <= range.start
&& range.start <= range.end
&& range.end <= self.range.end
{
// SAFETY: We checked that the range is within the currently mapped range.
Some(unsafe { self.slice_unchecked(range) })
} else {
None
}
}
/// # Safety
///
/// - `range` must be within the currently mapped range.
#[cfg_attr(not(feature = "document_unchecked"), doc(hidden))]
#[inline]
pub unsafe fn slice_unchecked(&self, range: Range<DeviceSize>) -> NonNull<[u8]> {
let ptr = self.ptr.as_ptr();
// SAFETY: The caller must guarantee that `range` is within the currently mapped range,
// which means that the offset pointer and length must denote a slice that's contained
// within the allocated (mapped) object.
let ptr = ptr.add((range.start - self.range.start) as usize);
let len = (range.end - range.start) as usize;
let ptr = ptr::slice_from_raw_parts_mut(<*mut c_void>::cast::<u8>(ptr), len);
// SAFETY: The original pointer was non-null, and the caller must guarantee that `range`
// is within the currently mapped range, which means that the offset couldn't have wrapped
// around the address space.
NonNull::new_unchecked(ptr)
}
}
/// Represents a range of host-mapped [`DeviceMemory`] to be invalidated or flushed.
///
/// Must be contained within the currently mapped range of the device memory.
#[derive(Debug)]
pub struct MappedMemoryRange {
/// The offset (in bytes) from the beginning of the allocation, where the range starts.
///
/// Must be a multiple of the [`non_coherent_atom_size`] device property.
///
/// The default value is `0`.
///
/// [`non_coherent_atom_size`]: crate::device::Properties::non_coherent_atom_size
pub offset: DeviceSize,
/// The size (in bytes) of the range.
///
/// Must be a multiple of the [`non_coherent_atom_size`] device property, or be equal to the
/// allocation size minus `offset`.
///
/// The default value is `0`.
///
/// [`non_coherent_atom_size`]: crate::device::Properties::non_coherent_atom_size
pub size: DeviceSize,
pub _ne: crate::NonExhaustive,
}
impl MappedMemoryRange {
pub(crate) fn validate(&self, memory: &DeviceMemory) -> Result<(), Box<ValidationError>> {
let &Self {
offset,
size,
_ne: _,
} = self;
if let Some(state) = &memory.mapping_state {
if !(state.range.start <= offset && size <= state.range.end - offset) {
return Err(Box::new(ValidationError {
problem: "is not contained within the mapped range of this device memory"
.into(),
vuids: &["VUID-VkMappedMemoryRange-size-00685"],
..Default::default()
}));
}
} else {
return Err(Box::new(ValidationError {
problem: "this device memory is not currently host-mapped".into(),
vuids: &["VUID-VkMappedMemoryRange-memory-00684"],
..Default::default()
}));
}
if !is_aligned(offset, memory.atom_size()) {
return Err(Box::new(ValidationError {
context: "offset".into(),
problem: "is not aligned to the `non_coherent_atom_size` device property".into(),
vuids: &["VUID-VkMappedMemoryRange-offset-00687"],
..Default::default()
}));
}
if !(is_aligned(size, memory.atom_size()) || size == memory.allocation_size() - offset) {
return Err(Box::new(ValidationError {
context: "size".into(),
problem: "is not aligned to the `non_coherent_atom_size` device property nor \
equal to `self.allocation_size()` minus `offset`"
.into(),
vuids: &["VUID-VkMappedMemoryRange-size-01390"],
..Default::default()
}));
}
Ok(())
}
}
impl Default for MappedMemoryRange {
#[inline]
fn default() -> Self {
MappedMemoryRange {
offset: 0,
size: 0,
_ne: crate::NonExhaustive(()),
}
}
}
/// Represents device memory that has been mapped in a CPU-accessible space.
///
/// In order to access the contents of the allocated memory, you can use the `read` and `write`
/// methods.
///
/// # Examples
///
/// ```
/// use vulkano::memory::{DeviceMemory, MappedDeviceMemory, MemoryAllocateInfo, MemoryPropertyFlags};
///
/// # let device: std::sync::Arc<vulkano::device::Device> = return;
/// // The memory type must be mappable.
/// let memory_type_index = device
/// .physical_device()
/// .memory_properties()
/// .memory_types
/// .iter()
/// .position(|t| t.property_flags.intersects(MemoryPropertyFlags::HOST_VISIBLE))
/// .map(|i| i as u32)
/// .unwrap(); // Vk specs guarantee that this can't fail
///
/// // Allocates 1KB of memory.
/// let memory = DeviceMemory::allocate(
/// device.clone(),
/// MemoryAllocateInfo {
/// allocation_size: 1024,
/// memory_type_index,
/// ..Default::default()
/// },
/// )
/// .unwrap();
/// let mapped_memory = MappedDeviceMemory::new(memory, 0..1024).unwrap();
///
/// // Get access to the content.
/// // Note that this is very unsafe because the access is unsynchronized.
/// unsafe {
/// let content = mapped_memory.write(0..1024).unwrap();
/// content[12] = 54;
/// }
/// ```
#[derive(Debug)]
#[deprecated(
since = "0.34.0",
note = "use the methods provided directly on `DeviceMemory` instead"
)]
pub struct MappedDeviceMemory {
memory: DeviceMemory,
pointer: *mut c_void, // points to `range.start`
range: Range<DeviceSize>,
atom_size: DeviceAlignment,
is_coherent: bool,
}
// Note that `MappedDeviceMemory` doesn't implement `Drop`, as we don't need to unmap memory before
// freeing it.
//
// Vulkan specs, documentation of `vkFreeMemory`:
// > If a memory object is mapped at the time it is freed, it is implicitly unmapped.
#[allow(deprecated)]
impl MappedDeviceMemory {
/// Maps a range of memory to be accessed by the CPU.
///
/// `memory` must be allocated from host-visible memory.
///
/// `range` is specified in bytes relative to the start of the memory allocation, and must fall
/// within the range of the allocation (`0..allocation_size`). If `memory` was not allocated
/// from host-coherent memory, then the start and end of `range` must be a multiple of the
/// [`non_coherent_atom_size`](crate::device::Properties::non_coherent_atom_size) device
/// property, but `range.end` can also the memory's `allocation_size`.
///
/// # Panics
///
/// - Panics if `range` is empty.
#[inline]
pub fn new(
memory: DeviceMemory,
range: Range<DeviceSize>,
) -> Result<Self, Validated<VulkanError>> {
Self::validate_new(&memory, range.clone())?;
unsafe { Ok(Self::new_unchecked(memory, range)?) }
}
fn validate_new(
memory: &DeviceMemory,
range: Range<DeviceSize>,
) -> Result<(), Box<ValidationError>> {
if range.is_empty() {
return Err(Box::new(ValidationError {
context: "range".into(),
problem: "is empty".into(),
vuids: &["VUID-vkMapMemory-size-00680"],
..Default::default()
}));
}
let device = memory.device();
let memory_type = &device.physical_device().memory_properties().memory_types
[memory.memory_type_index() as usize];
if !memory_type
.property_flags
.intersects(MemoryPropertyFlags::HOST_VISIBLE)
{
return Err(Box::new(ValidationError {
context: "memory".into(),
problem: "has a memory type whose `property_flags` does not contain \
`MemoryPropertyFlags::HOST_VISIBLE`"
.into(),
vuids: &["VUID-vkMapMemory-memory-00682"],
..Default::default()
}));
}
if memory.mapping_state().is_some() {
return Err(Box::new(ValidationError {
context: "memory".into(),
problem: "is already host-mapped".into(),
vuids: &["VUID-vkMapMemory-memory-00678"],
..Default::default()
}));
}
if range.end > memory.allocation_size {
return Err(Box::new(ValidationError {
problem: "`range.end` is greater than `memory.allocation_size()`".into(),
vuids: &[
"VUID-vkMapMemory-offset-00679",
"VUID-vkMapMemory-size-00681",
],
..Default::default()
}));
}
let is_coherent = memory_type
.property_flags
.intersects(MemoryPropertyFlags::HOST_COHERENT);
let atom_size = device.physical_device().properties().non_coherent_atom_size;
// Not required for merely mapping, but without this check the user can end up with
// parts of the mapped memory at the start and end that they're not able to
// invalidate/flush, which is probably unintended.
if !is_coherent
&& (!is_aligned(range.start, atom_size)
|| (!is_aligned(range.end, atom_size) && range.end != memory.allocation_size))
{
return Err(Box::new(ValidationError {
problem: "`memory` has a memory type whose `property_flags` does not contain \
`MemoryPropertyFlags::HOST_COHERENT`, and `range.start` and/or `range.end` \
are not aligned to the `non_coherent_atom_size` device property"
.into(),
..Default::default()
}));
}
Ok(())
}
#[cfg_attr(not(feature = "document_unchecked"), doc(hidden))]
pub unsafe fn new_unchecked(
memory: DeviceMemory,
range: Range<DeviceSize>,
) -> Result<Self, VulkanError> {
// Sanity check: this would lead to UB when calculating pointer offsets.
assert!(range.end - range.start <= isize::MAX.try_into().unwrap());
let device = memory.device();
let pointer = unsafe {
let fns = device.fns();
let mut output = MaybeUninit::uninit();
(fns.v1_0.map_memory)(
device.handle(),
memory.handle,
range.start,
range.end - range.start,
ash::vk::MemoryMapFlags::empty(),
output.as_mut_ptr(),
)
.result()
.map_err(VulkanError::from)?;
output.assume_init()
};
let atom_size = device.physical_device().properties().non_coherent_atom_size;
let memory_type = &device.physical_device().memory_properties().memory_types
[memory.memory_type_index() as usize];
let is_coherent = memory_type
.property_flags
.intersects(MemoryPropertyFlags::HOST_COHERENT);
Ok(MappedDeviceMemory {
memory,
pointer,
range,
atom_size,
is_coherent,
})
}
/// Unmaps the memory. It will no longer be accessible from the CPU.
#[inline]
pub fn unmap(self) -> DeviceMemory {
unsafe {
let device = self.memory.device();
let fns = device.fns();
(fns.v1_0.unmap_memory)(device.handle(), self.memory.handle);
}
self.memory
}
/// Invalidates the host (CPU) cache for a range of mapped memory.
///
/// If the mapped memory is not host-coherent, you must call this function before the memory is
/// read by the host, if the device previously wrote to the memory. It has no effect if the
/// mapped memory is host-coherent.
///
/// `range` is specified in bytes relative to the start of the memory allocation, and must fall
/// within the range of the memory mapping given to `new`. If the memory was not allocated
/// from host-coherent memory, then the start and end of `range` must be a multiple of the
/// [`non_coherent_atom_size`](crate::device::Properties::non_coherent_atom_size) device
/// property, but `range.end` can also equal the memory's `allocation_size`.
///
/// # Safety
///
/// - If there are memory writes by the GPU that have not been propagated into the CPU cache,
/// then there must not be any references in Rust code to the specified `range` of the memory.
///
/// # Panics
///
/// - Panics if `range` is empty.
#[inline]
pub unsafe fn invalidate_range(
&self,
range: Range<DeviceSize>,
) -> Result<(), Validated<VulkanError>> {
self.validate_range(range.clone())?;
Ok(self.invalidate_range_unchecked(range)?)
}
#[cfg_attr(not(feature = "document_unchecked"), doc(hidden))]
pub unsafe fn invalidate_range_unchecked(
&self,
range: Range<DeviceSize>,
) -> Result<(), VulkanError> {
if self.is_coherent {
return Ok(());
}
let range = ash::vk::MappedMemoryRange {
memory: self.memory.handle(),
offset: range.start,
size: range.end - range.start,
..Default::default()
};
let fns = self.memory.device().fns();
(fns.v1_0.invalidate_mapped_memory_ranges)(self.memory.device().handle(), 1, &range)
.result()
.map_err(VulkanError::from)?;
Ok(())
}
/// Flushes the host (CPU) cache for a range of mapped memory.
///
/// If the mapped memory is not host-coherent, you must call this function after writing to the
/// memory, if the device is going to read the memory. It has no effect if the
/// mapped memory is host-coherent.
///
/// `range` is specified in bytes relative to the start of the memory allocation, and must fall
/// within the range of the memory mapping given to `map`. If the memory was not allocated
/// from host-coherent memory, then the start and end of `range` must be a multiple of the
/// [`non_coherent_atom_size`](crate::device::Properties::non_coherent_atom_size) device
/// property, but `range.end` can also equal the memory's `allocation_size`.
///
/// # Safety
///
/// - There must be no operations pending or executing in a GPU queue, that access the specified
/// `range` of the memory.
///
/// # Panics
///
/// - Panics if `range` is empty.
#[inline]
pub unsafe fn flush_range(
&self,
range: Range<DeviceSize>,
) -> Result<(), Validated<VulkanError>> {
self.validate_range(range.clone())?;
Ok(self.flush_range_unchecked(range)?)
}
#[cfg_attr(not(feature = "document_unchecked"), doc(hidden))]
pub unsafe fn flush_range_unchecked(
&self,
range: Range<DeviceSize>,
) -> Result<(), VulkanError> {
if self.is_coherent {
return Ok(());
}
let range = ash::vk::MappedMemoryRange {
memory: self.memory.handle(),
offset: range.start,
size: range.end - range.start,
..Default::default()
};
let fns = self.device().fns();
(fns.v1_0.flush_mapped_memory_ranges)(self.memory.device().handle(), 1, &range)
.result()
.map_err(VulkanError::from)?;
Ok(())
}
/// Returns a reference to bytes in the mapped memory.
///
/// `range` is specified in bytes relative to the start of the memory allocation, and must fall
/// within the range of the memory mapping given to `map`. If the memory was not allocated
/// from host-coherent memory, then the start and end of `range` must be a multiple of the
/// [`non_coherent_atom_size`](crate::device::Properties::non_coherent_atom_size) device
/// property, but `range.end` can also equal the memory's `allocation_size`.
///
/// # Safety
///
/// - While the returned reference exists, there must not be any mutable references in Rust code
/// to the same memory.
/// - While the returned reference exists, there must be no operations pending or executing in
/// a GPU queue, that write to the same memory.
///
/// # Panics
///
/// - Panics if `range` is empty.
#[inline]
pub unsafe fn read(&self, range: Range<DeviceSize>) -> Result<&[u8], Box<ValidationError>> {
self.validate_range(range.clone())?;
Ok(self.read_unchecked(range))
}
#[cfg_attr(not(feature = "document_unchecked"), doc(hidden))]
#[inline]
pub unsafe fn read_unchecked(&self, range: Range<DeviceSize>) -> &[u8] {
slice::from_raw_parts(
self.pointer.add((range.start - self.range.start) as usize) as *const u8,
(range.end - range.start) as usize,
)
}
/// Returns a mutable reference to bytes in the mapped memory.
///
/// `range` is specified in bytes relative to the start of the memory allocation, and must fall
/// within the range of the memory mapping given to `map`. If the memory was not allocated
/// from host-coherent memory, then the start and end of `range` must be a multiple of the
/// [`non_coherent_atom_size`](crate::device::Properties::non_coherent_atom_size) device
/// property, but `range.end` can also equal the memory's `allocation_size`.
///
/// # Safety
///
/// - While the returned reference exists, there must not be any other references in Rust code
/// to the same memory.
/// - While the returned reference exists, there must be no operations pending or executing in
/// a GPU queue, that access the same memory.
///
/// # Panics
///
/// - Panics if `range` is empty.
#[inline]
pub unsafe fn write(
&self,
range: Range<DeviceSize>,
) -> Result<&mut [u8], Box<ValidationError>> {
self.validate_range(range.clone())?;
Ok(self.write_unchecked(range))
}
#[cfg_attr(not(feature = "document_unchecked"), doc(hidden))]
#[inline]
#[allow(clippy::mut_from_ref)]
pub unsafe fn write_unchecked(&self, range: Range<DeviceSize>) -> &mut [u8] {
slice::from_raw_parts_mut(
self.pointer.add((range.start - self.range.start) as usize) as *mut u8,
(range.end - range.start) as usize,
)
}
#[inline]
fn validate_range(&self, range: Range<DeviceSize>) -> Result<(), Box<ValidationError>> {
// VUID-VkMappedMemoryRange-memory-00684
// Guaranteed because `self` owns the memory and it's mapped during our lifetime.
if range.is_empty() {
return Err(Box::new(ValidationError {
context: "range".into(),
problem: "is empty".into(),
..Default::default()
}));
}
if range.start < self.range.start || range.end > self.range.end {
return Err(Box::new(ValidationError {
context: "range".into(),
problem: "is not within the mapped range of this mapped device memory".into(),
vuids: &["VUID-VkMappedMemoryRange-size-00685"],
..Default::default()
}));
}
if !self.is_coherent {
if !is_aligned(range.start, self.atom_size)
|| (!is_aligned(range.end, self.atom_size)
&& range.end != self.memory.allocation_size)
{
return Err(Box::new(ValidationError {
problem: "this mapped device memory has a memory type whose `property_flags` \
does not contain `MemoryPropertyFlags::HOST_COHERENT`, and \
`range.start` and/or `range.end` are not aligned to the \
`non_coherent_atom_size` device property"
.into(),
vuids: &[
"VUID-VkMappedMemoryRange-offset-00687",
"VUID-VkMappedMemoryRange-size-01390",
],
..Default::default()
}));
}
}
Ok(())
}
}
#[allow(deprecated)]
impl AsRef<DeviceMemory> for MappedDeviceMemory {
#[inline]
fn as_ref(&self) -> &DeviceMemory {
&self.memory
}
}
#[allow(deprecated)]
impl AsMut<DeviceMemory> for MappedDeviceMemory {
#[inline]
fn as_mut(&mut self) -> &mut DeviceMemory {
&mut self.memory
}
}
#[allow(deprecated)]
unsafe impl DeviceOwned for MappedDeviceMemory {
#[inline]
fn device(&self) -> &Arc<Device> {
self.memory.device()
}
}
#[allow(deprecated)]
unsafe impl Send for MappedDeviceMemory {}
#[allow(deprecated)]
unsafe impl Sync for MappedDeviceMemory {}
#[cfg(test)]
mod tests {
use super::MemoryAllocateInfo;
use crate::memory::{DeviceMemory, MemoryPropertyFlags};
#[test]
fn create() {
let (device, _) = gfx_dev_and_queue!();
let _ = DeviceMemory::allocate(
device,
MemoryAllocateInfo {
allocation_size: 256,
memory_type_index: 0,
..Default::default()
},
)
.unwrap();
}
#[test]
fn zero_size() {
let (device, _) = gfx_dev_and_queue!();
assert_should_panic!({
let _ = DeviceMemory::allocate(
device.clone(),
MemoryAllocateInfo {
allocation_size: 0,
memory_type_index: 0,
..Default::default()
},
)
.unwrap();
});
}
#[test]
#[cfg(target_pointer_width = "64")]
fn oom_single() {
let (device, _) = gfx_dev_and_queue!();
let memory_type_index = device
.physical_device()
.memory_properties()
.memory_types
.iter()
.enumerate()
.find_map(|(i, m)| {
(!m.property_flags
.intersects(MemoryPropertyFlags::LAZILY_ALLOCATED))
.then_some(i as u32)
})
.unwrap();
match DeviceMemory::allocate(
device,
MemoryAllocateInfo {
allocation_size: 0xffffffffffffffff,
memory_type_index,
..Default::default()
},
) {
Err(_) => (),
Ok(_) => panic!(),
}
}
#[test]
#[ignore] // TODO: test fails for now on Mesa+Intel
fn oom_multi() {
let (device, _) = gfx_dev_and_queue!();
let (memory_type_index, memory_type) = device
.physical_device()
.memory_properties()
.memory_types
.iter()
.enumerate()
.find_map(|(i, m)| {
(!m.property_flags
.intersects(MemoryPropertyFlags::LAZILY_ALLOCATED))
.then_some((i as u32, m))
})
.unwrap();
let heap_size = device.physical_device().memory_properties().memory_heaps
[memory_type.heap_index as usize]
.size;
let mut allocs = Vec::new();
for _ in 0..4 {
match DeviceMemory::allocate(
device.clone(),
MemoryAllocateInfo {
allocation_size: heap_size / 3,
memory_type_index,
..Default::default()
},
) {
Err(_) => return, // test succeeded
Ok(a) => allocs.push(a),
}
}
panic!()
}
#[test]
fn allocation_count() {
let (device, _) = gfx_dev_and_queue!();
assert_eq!(device.allocation_count(), 0);
let _mem1 = DeviceMemory::allocate(
device.clone(),
MemoryAllocateInfo {
allocation_size: 256,
memory_type_index: 0,
..Default::default()
},
)
.unwrap();
assert_eq!(device.allocation_count(), 1);
{
let _mem2 = DeviceMemory::allocate(
device.clone(),
MemoryAllocateInfo {
allocation_size: 256,
memory_type_index: 0,
..Default::default()
},
)
.unwrap();
assert_eq!(device.allocation_count(), 2);
}
assert_eq!(device.allocation_count(), 1);
}
}