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
//! An OpenCL kernel.
// pub use self::arg_type::{ArgType, BaseType, Cardinality};
pub use self::arg_type::ArgType;
use crate::core::error::Error as OclCoreErrorKind;
use crate::core::ffi::c_void;
use crate::core::{
self, util, ArgVal, AsMem, ClVersions, CommandQueue as CommandQueueCore, Kernel as KernelCore,
KernelArgInfo, KernelArgInfoResult, KernelInfo, KernelInfoResult, KernelWorkGroupInfo,
KernelWorkGroupInfoResult, Mem as MemCore, MemCmdAll, OclPrm,
};
use crate::error::{Error as OclError, Result as OclResult};
use crate::standard::{
Buffer, ClNullEventPtrEnum, ClWaitListPtrEnum, Device, Image, Program, Queue, Sampler,
SpatialDims, WorkDims,
};
use std;
use std::any::Any;
use std::any::TypeId;
use std::borrow::Borrow;
use std::borrow::Cow;
use std::cell::RefCell;
use std::collections::{BTreeMap, HashMap};
use std::marker::PhantomData;
use std::ops::Deref;
/// An error related to a `Kernel`, `KernelBuilder`, or `KernelCmd`.
#[derive(Debug, thiserror::Error)]
pub enum KernelError {
#[error("No queue specified.")]
CmdNoQueue,
#[error(
"Global Work Size cannot be left unspecified. Set a default for \
the kernel or specify one when enqueuing command."
)]
CmdNoGws,
#[error(
"Unable to resolve argument named: '{0}'. Ensure that an argument with \
that name has been declared before building kernel."
)]
NamedArgsInvalidArgName(String),
#[error(
"No named arguments have been declared. Declare named arguments \
when before building kernel."
)]
NamedArgsNone,
#[error("Kernel arg index out of range. (kernel: {0}, index: {1})")]
ArgIdxOor(String, u32),
#[error(
"Kernel argument type mismatch. The argument named: '{arg_name}' at index: [{idx}] \
should be a '{ty_name}' ({ty:?})."
)]
ArgTypeMismatch {
idx: u32,
arg_name: String,
ty_name: String,
ty: ArgType,
},
#[error("No program specified.")]
BuilderNoProgram,
#[error("No kernel name specified.")]
BuilderNoKernelName,
#[error("The wrong number of kernel arguments have been specified \
(required: {required}, specified: {specified}). Use named arguments with 'None' or zero values to \
declare arguments you plan to assign a value to at a later time.")]
BuilderWrongArgCount { required: u32, specified: u32 },
}
/// A kernel command builder used to enqueue a kernel with a mix of default
/// and optionally specified arguments.
#[must_use = "commands do nothing unless enqueued"]
pub struct KernelCmd<'k> {
kernel: &'k KernelCore,
queue: Option<&'k CommandQueueCore>,
gwo: SpatialDims,
gws: SpatialDims,
lws: SpatialDims,
wait_events: Option<ClWaitListPtrEnum<'k>>,
new_event: Option<ClNullEventPtrEnum<'k>>,
}
/// A kernel enqueue command.
impl<'k> KernelCmd<'k> {
/// Specifies a queue to use for this call only.
///
/// Overrides the kernel's default queue if one is set. If no default
/// queue is set, this method **must** be called before enqueuing the
/// kernel.
pub fn queue<'q, Q>(mut self, queue: &'q Q) -> KernelCmd<'k>
where
'q: 'k,
Q: 'k + AsRef<CommandQueueCore>,
{
self.queue = Some(queue.as_ref());
self
}
/// Specifies a global work offset for this call only.
#[deprecated(since = "0.18.0", note = "Use `::global_work_offset` instead.")]
pub fn gwo<D: Into<SpatialDims>>(mut self, gwo: D) -> KernelCmd<'k> {
self.gwo = gwo.into();
self
}
/// Specifies a global work size for this call only.
#[deprecated(since = "0.18.0", note = "Use `::global_work_size` instead.")]
pub fn gws<D: Into<SpatialDims>>(mut self, gws: D) -> KernelCmd<'k> {
self.gws = gws.into();
self
}
/// Specifies a local work size for this call only.
#[deprecated(since = "0.18.0", note = "Use `::local_work_size` instead.")]
pub fn lws<D: Into<SpatialDims>>(mut self, lws: D) -> KernelCmd<'k> {
self.lws = lws.into();
self
}
/// Specifies a global work offset for this call only.
pub fn global_work_offset<D: Into<SpatialDims>>(mut self, gwo: D) -> KernelCmd<'k> {
self.gwo = gwo.into();
self
}
/// Specifies a global work size for this call only.
pub fn global_work_size<D: Into<SpatialDims>>(mut self, gws: D) -> KernelCmd<'k> {
self.gws = gws.into();
self
}
/// Specifies a local work size for this call only.
pub fn local_work_size<D: Into<SpatialDims>>(mut self, lws: D) -> KernelCmd<'k> {
self.lws = lws.into();
self
}
/// Specifies an event or list of events to wait on before the command
/// will run.
///
/// When events generated using the `::enew` method of **other**,
/// previously enqueued commands are passed here (either individually or
/// as part of an [`EventList`]), this command will not execute until
/// those commands have completed.
///
/// Using events can compliment the use of queues to order commands by
/// creating temporal dependencies between them (where commands in one
/// queue must wait for the completion of commands in another). Events can
/// also supplant queues altogether when, for example, using out-of-order
/// queues.
///
/// # Example
///
/// ```rust,ignore
/// // Create an event list:
/// let mut event_list = EventList::new();
/// // Enqueue a kernel on `queue_1`, creating an event representing the kernel
/// // command in our list:
/// kernel.cmd().queue(&queue_1).enew(&mut event_list).enq()?;
/// // Read from a buffer using `queue_2`, ensuring the read does not begin until
/// // after the kernel command has completed:
/// buffer.read(rwvec.clone()).queue(&queue_2).ewait(&event_list).enq_async()?;
/// ```
///
/// [`EventList`]: struct.EventList.html
pub fn ewait<'e, Ewl>(mut self, ewait: Ewl) -> KernelCmd<'k>
where
'e: 'k,
Ewl: Into<ClWaitListPtrEnum<'e>>,
{
self.wait_events = Some(ewait.into());
self
}
/// Specifies the destination to store a new, optionally created event
/// associated with this command.
///
/// The destination can be a mutable reference to an empty event (created
/// using [`Event::empty`]) or a mutable reference to an event list.
///
/// After this command is enqueued, the event in the destination can be
/// passed to the `::ewait` method of another command. Doing so will cause
/// the other command to wait until this command has completed before
/// executing.
///
/// Using events can compliment the use of queues to order commands by
/// creating temporal dependencies between them (where commands in one
/// queue must wait for the completion of commands in another). Events can
/// also supplant queues altogether when, for example, using out-of-order
/// queues.
///
/// # Example
///
/// ```rust,ignore
/// // Create an event list:
/// let mut event = Event::empty();
/// // Enqueue a kernel on `queue_1`, creating an event representing the kernel
/// // command in our list:
/// kernel.cmd().queue(&queue_1).enew(&mut event).enq()?;
/// // Read from a buffer using `queue_2`, ensuring the read does not begin until
/// // after the kernel command has completed:
/// buffer.read(rwvec.clone()).queue(&queue_2).ewait(&event).enq_async()?;
/// ```
///
/// [`Event::empty`]: struct.Event.html#method.empty
pub fn enew<'e, En>(mut self, new_event_dest: En) -> KernelCmd<'k>
where
'e: 'k,
En: Into<ClNullEventPtrEnum<'e>>,
{
self.new_event = Some(new_event_dest.into());
self
}
/// Enqueues this kernel command.
///
/// # Safety
///
/// All kernel code must be considered untrusted. Therefore the act of
/// calling this function contains implied unsafety even though the API
/// itself is safe.
pub unsafe fn enq(self) -> OclResult<()> {
let queue = match self.queue {
Some(q) => q,
None => return Err(KernelError::CmdNoQueue.into()),
};
let dim_count = self.gws.dim_count();
let gws = match self.gws.to_work_size() {
Some(gws) => gws,
None => return Err(KernelError::CmdNoGws.into()),
};
core::enqueue_kernel(
queue,
&self.kernel,
dim_count,
self.gwo.to_work_offset(),
&gws,
self.lws.to_work_size(),
self.wait_events,
self.new_event,
)
.map_err(OclError::from)
}
}
/// Converts an argument index specifier to `u32`.
#[derive(Clone, Debug)]
pub enum ArgIdxSpecifier {
Uint(u32),
Str(Cow<'static, str>),
}
impl ArgIdxSpecifier {
// Resolves this specifier into an integer index using the specified
// argument map if necessary.
fn to_idx(&self, named_args: &NamedArgs) -> OclResult<u32> {
match self {
ArgIdxSpecifier::Uint(idx) => Ok(*idx),
ArgIdxSpecifier::Str(ref s) => named_args.resolve_idx(&s),
}
}
}
impl From<u32> for ArgIdxSpecifier {
fn from(idx: u32) -> ArgIdxSpecifier {
ArgIdxSpecifier::Uint(idx)
}
}
impl From<i32> for ArgIdxSpecifier {
fn from(idx: i32) -> ArgIdxSpecifier {
ArgIdxSpecifier::Uint(idx as u32)
}
}
impl From<usize> for ArgIdxSpecifier {
fn from(idx: usize) -> ArgIdxSpecifier {
ArgIdxSpecifier::Uint(idx as u32)
}
}
impl From<&'static str> for ArgIdxSpecifier {
fn from(s: &'static str) -> ArgIdxSpecifier {
ArgIdxSpecifier::Str(s.into())
}
}
impl From<String> for ArgIdxSpecifier {
fn from(s: String) -> ArgIdxSpecifier {
ArgIdxSpecifier::Str(s.into())
}
}
/// Contains owned or shared argument values.
#[derive(Debug, Clone)]
enum ArgValKeeper<'b> {
Shared(ArgVal<'b>),
OwnedPrm(Vec<u8>),
OwnedMem(MemCore),
}
impl<'b> ArgValKeeper<'b> {
fn owned_prm<T>(prm: T) -> ArgValKeeper<'b>
where
T: OclPrm,
{
unsafe { ArgValKeeper::OwnedPrm(util::into_bytes(prm)) }
}
fn owned_mem<T>(buf: MemCore) -> ArgValKeeper<'b>
where
T: OclPrm,
{
ArgValKeeper::OwnedMem(buf)
}
fn mem_null() -> ArgValKeeper<'b> {
ArgValKeeper::Shared(ArgVal::mem_null())
}
/// Returns the size (in bytes) and raw pointer to the contained kernel
/// argument value.
fn to_arg_val(&'b self) -> ArgVal<'b> {
match *self {
ArgValKeeper::Shared(ref av) => av.clone(),
ArgValKeeper::OwnedPrm(ref bytes) => unsafe {
ArgVal::from_raw(bytes.len(), bytes.as_ptr() as *const c_void, false)
},
ArgValKeeper::OwnedMem(ref mem) => ArgVal::mem(mem),
}
}
}
/// Wraps argument values of different types.
pub struct ArgValConverter<'b, T>
where
T: OclPrm,
{
val: ArgValKeeper<'b>,
type_id: Option<TypeId>,
mem: Option<MemCore>,
_ty: PhantomData<T>,
}
impl<'b, T> From<Option<&'b Buffer<T>>> for ArgValConverter<'b, T>
where
T: OclPrm,
{
/// Converts from an Option<`Buffer`>.
fn from(buf: Option<&'b Buffer<T>>) -> ArgValConverter<'b, T> {
let val = match buf {
Some(b) => ArgValKeeper::Shared(ArgVal::mem(b)),
None => ArgValKeeper::mem_null(),
};
ArgValConverter {
val,
type_id: Some(TypeId::of::<T>()),
mem: buf.map(|b| b.as_mem().clone()),
_ty: PhantomData,
}
}
}
impl<'b, T> From<&'b Buffer<T>> for ArgValConverter<'b, T>
where
T: OclPrm,
{
/// Converts from a `Buffer`.
fn from(buf: &'b Buffer<T>) -> ArgValConverter<'b, T> {
ArgValConverter {
val: ArgValKeeper::Shared(ArgVal::mem(buf)),
type_id: Some(TypeId::of::<T>()),
mem: Some(buf.as_mem().clone()),
_ty: PhantomData,
}
}
}
impl<'b, T> From<&'b mut Buffer<T>> for ArgValConverter<'b, T>
where
T: OclPrm,
{
fn from(buf: &'b mut Buffer<T>) -> ArgValConverter<'b, T> {
ArgValConverter::from(&*buf)
}
}
// impl<'b, T> From<&'b &'b Buffer<T>> for ArgValConverter<'b, T> where T: OclPrm {
// fn from(buf: &'b &'b Buffer<T>) -> ArgValConverter<'b, T> {
// ArgValConverter::from(&**buf)
// }
// }
impl<'b, T> From<Buffer<T>> for ArgValConverter<'b, T>
where
T: OclPrm,
{
/// Converts from an owned `Buffer`.
fn from(buf: Buffer<T>) -> ArgValConverter<'b, T> {
ArgValConverter {
val: ArgValKeeper::owned_mem::<T>(buf.as_mem().clone()),
type_id: Some(TypeId::of::<T>()),
mem: Some(buf.as_mem().clone()),
_ty: PhantomData,
}
}
}
impl<'b, T> From<Option<&'b Image<T>>> for ArgValConverter<'b, T>
where
T: OclPrm,
{
/// Converts from an Option<`Image`>.
fn from(img: Option<&'b Image<T>>) -> ArgValConverter<'b, T> {
let val = match img {
Some(i) => ArgValKeeper::Shared(ArgVal::mem(i)),
None => ArgValKeeper::mem_null(),
};
ArgValConverter {
val,
type_id: None,
mem: img.map(|i| i.as_mem().clone()),
_ty: PhantomData,
}
}
}
impl<'b, T> From<&'b Image<T>> for ArgValConverter<'b, T>
where
T: OclPrm,
{
/// Converts from an `Image`.
fn from(img: &'b Image<T>) -> ArgValConverter<'b, T> {
ArgValConverter {
val: ArgValKeeper::Shared(ArgVal::mem(img)),
type_id: None,
mem: Some(img.as_mem().clone()),
_ty: PhantomData,
}
}
}
impl<'b, T> From<&'b mut Image<T>> for ArgValConverter<'b, T>
where
T: OclPrm,
{
fn from(img: &'b mut Image<T>) -> ArgValConverter<'b, T> {
ArgValConverter::from(&*img)
}
}
// impl<'b, T> From<&'b &'b Image<T>> for ArgValConverter<'b, T> where T: OclPrm {
// fn from(img: &'b &'b Image<T>) -> ArgValConverter<'b, T> {
// ArgValConverter::from(&**img)
// }
// }
impl<'b, T> From<Image<T>> for ArgValConverter<'b, T>
where
T: OclPrm,
{
/// Converts from an owned `Image`.
fn from(img: Image<T>) -> ArgValConverter<'b, T> {
ArgValConverter {
val: ArgValKeeper::owned_mem::<T>(img.as_mem().clone()),
type_id: Some(TypeId::of::<T>()),
mem: Some(img.as_mem().clone()),
_ty: PhantomData,
}
}
}
impl<'b, T> From<&'b T> for ArgValConverter<'b, T>
where
T: OclPrm,
{
/// Converts from a scalar or vector value.
fn from(prm: &'b T) -> ArgValConverter<'b, T> {
ArgValConverter {
val: ArgValKeeper::Shared(ArgVal::scalar(prm)),
type_id: Some(TypeId::of::<T>()),
mem: None,
_ty: PhantomData,
}
}
}
impl<'b, T> From<T> for ArgValConverter<'b, T>
where
T: OclPrm,
{
/// Converts from a scalar or vector value.
fn from(prm: T) -> ArgValConverter<'b, T> {
ArgValConverter {
val: ArgValKeeper::owned_prm(prm),
type_id: Some(TypeId::of::<T>()),
mem: None,
_ty: PhantomData,
}
}
}
/// A map of argument names -> indexes.
#[derive(Clone, Debug)]
struct NamedArgs(Option<HashMap<Cow<'static, str>, u32>>);
impl NamedArgs {
/// Inserts a named argument into the map.
fn insert(&mut self, name: Cow<'static, str>, arg_idx: u32) {
if self.0.is_none() {
self.0 = Some(HashMap::with_capacity(8));
}
self.0.as_mut().unwrap().insert(name, arg_idx);
}
/// Resolves the index of a named argument with a friendly error message.
fn resolve_idx(&self, name: &str) -> OclResult<u32> {
match self.0 {
Some(ref map) => match map.get(name) {
Some(&ai) => Ok(ai),
None => Err(KernelError::NamedArgsInvalidArgName(name.into()).into()),
},
None => Err(KernelError::NamedArgsNone.into()),
}
}
}
/// Storage for `Mem` arguments.
//
// NOTE: `RefCell` is used to prevent `::set_arg*` methods from requiring a
// mutable reference (to `self`).
#[derive(Clone, Debug)]
struct MemArgs(Option<RefCell<BTreeMap<u32, MemCore>>>);
impl MemArgs {
/// Inserts a `Mem` argument for storage if possible.
fn insert(&self, idx: u32, mem: MemCore) {
if let Some(ref map) = self.0 {
map.borrow_mut().insert(idx, mem);
}
}
/// Removes a `Mem` argument.
fn remove(&self, idx: &u32) {
if let Some(ref map) = self.0 {
map.borrow_mut().remove(idx);
}
}
}
/// A kernel which represents a 'procedure'.
///
/// Corresponds to code which must have already been compiled into a program.
///
/// Set arguments using `::set_arg` or any of the `::set_arg...` methods.
///
/// `Kernel` includes features that a raw OpenCL kernel does not, including:
///
/// 1. Type-checked arguments (not just size-checked)
/// 2. Named arguments (with a `&'static str` name)
/// 3. Prevention of a potential (difficult to debug) segfault if a buffer or
/// image used by a kernel is dropped prematurely.
/// 4. Stored defaults for the:
/// - Queue
/// - Global Work Offset
/// - Global Work Size
/// - Local Work Size
///
/// ### `Clone` and `Send`
///
/// A `Kernel` may not be cloned but may be sent between threads. This ensures
/// that no two threads create a race condition by attempting to set an
/// argument and enqueue a kernel at the same time. Use the `KernelBuilder` to
/// create multiple identical kernels (`KernelBuilder` is clonable and
/// re-usable).
#[derive(Debug)]
pub struct Kernel {
obj_core: KernelCore,
named_args: NamedArgs,
mem_args: MemArgs,
queue: Option<Queue>,
gwo: SpatialDims,
gws: SpatialDims,
lws: SpatialDims,
arg_types: Option<Vec<ArgType>>,
}
impl Kernel {
/// Returns a new `KernelBuilder`.
pub fn builder<'p>() -> KernelBuilder<'p> {
KernelBuilder::new()
}
/// Verifies that a type matches the kernel arg info:
///
/// This function does nothing and always returns `Ok` if argument type
/// checking is disabled by the user or for any other reason.
///
/// Argument type checking will automatically be disabled if any of the
/// devices in use do not support OpenCL version 1.2 or higher or if
/// argument information is not available on the associated platform.
fn verify_arg_type<T: OclPrm + Any>(&self, arg_idx: u32) -> OclResult<()> {
if let Some(ref arg_types) = self.arg_types {
let arg_type = arg_types
.get(arg_idx as usize)
.ok_or(KernelError::ArgIdxOor(self.name()?, arg_idx))?;
if arg_type.is_match::<T>() {
Ok(())
} else {
let ty_name = arg_type_name(&self.obj_core, arg_idx)?;
let arg_name = arg_name(&self.obj_core, arg_idx)?;
Err(KernelError::ArgTypeMismatch {
idx: arg_idx,
arg_name,
ty_name,
ty: arg_type.clone(),
}
.into())
}
} else {
Ok(())
}
}
/// Returns the argument index of a named argument if it exists.
pub fn named_arg_idx(&self, name: &'static str) -> Option<u32> {
self.named_args.resolve_idx(name).ok()
}
/// Sets an argument by index without checks of any kind.
///
/// Setting buffer or image (`cl_mem`) arguments this way may cause
/// segfaults or errors if the buffer goes out of scope at any point
/// before this kernel is dropped.
///
/// This also bypasses the check to determine if the type of the value you
/// pass here matches the type defined in your kernel.
pub unsafe fn set_arg_unchecked(&self, arg_idx: u32, arg_val: ArgVal) -> OclResult<()> {
core::set_kernel_arg(&self.obj_core, arg_idx, arg_val).map_err(OclError::from)
}
/// Sets an argument by index.
fn _set_arg<T: OclPrm>(&self, arg_idx: u32, arg_val: ArgVal) -> OclResult<()> {
self.verify_arg_type::<T>(arg_idx)?;
core::set_kernel_arg(&self.obj_core, arg_idx, arg_val).map_err(OclError::from)
}
/// Sets a `Buffer`, `Image`, scalar, or vector argument by index or by
/// name.
///
/// ### Example
/// ```rust,ignore
/// // Create a kernel with arguments corresponding to those in the kernel.
/// // Just for fun, one argument will be 'named':
/// let kern = ocl_pq.kernel_builder("multiply_by_scalar")
/// .arg(&0)
/// .arg(None::<&Buffer<f32>>)
/// .arg_named("result", None::<&Buffer<f32>>)
/// .build()?;
///
/// // Set our named argument. The Option<_> wrapper is, well... optional:
/// kern.set_arg("result", &result_buffer)?;
/// // We can also set arguments (named or not) by index. Just for
/// // demonstration, we'll set one using an option:
/// kern.set_arg(0, &COEFF)?;
/// kern.set_arg(1, Some(&source_buffer))?;
/// kern.set_arg(2, &result_buffer)?;
/// ```
pub fn set_arg<'a, T, Ai, Av>(&self, idx: Ai, arg: Av) -> OclResult<()>
where
T: OclPrm,
Ai: Into<ArgIdxSpecifier>,
Av: Into<ArgValConverter<'a, T>>,
{
let arg_idx = idx.into().to_idx(&self.named_args)?;
self.verify_arg_type::<T>(arg_idx)?;
let arg: ArgValConverter<T> = arg.into();
// If the `KernelArg` is a `Mem` variant, clone the `MemCore` it
// refers to, store it in `self.mem_args`. This prevents a buffer
// which has gone out of scope from being erroneously referred to when
// this kernel is enqueued and causing either a misleading error
// message or a hard to debug segfault depending on the platform.
match arg.mem {
Some(mem) => self.mem_args.insert(arg_idx, mem),
None => self.mem_args.remove(&arg_idx),
};
let val = arg.val.to_arg_val();
self._set_arg::<T>(arg_idx, val)
}
/// Modifies the kernel argument named: `name`.
#[deprecated(since = "0.18.0", note = "Use `::set_arg` instead.")]
pub fn set_arg_buf_named<'a, T, M>(
&'a self,
name: &'static str,
buffer_opt: Option<M>,
) -> OclResult<()>
where
T: OclPrm,
M: AsMem<T> + MemCmdAll,
{
let arg_idx = self.named_args.resolve_idx(name)?;
match buffer_opt {
Some(buffer) => {
self.mem_args.insert(arg_idx, buffer.as_mem().clone());
self._set_arg::<T>(arg_idx, ArgVal::mem(buffer.as_mem()))
}
None => {
self.mem_args.remove(&arg_idx);
self._set_arg::<T>(arg_idx, ArgVal::mem_null())
}
}
}
/// Modifies the kernel argument named: `name`.
#[deprecated(since = "0.18.0", note = "Use `::set_arg` instead.")]
pub fn set_arg_img_named<'a, T, M>(
&'a self,
name: &'static str,
image_opt: Option<M>,
) -> OclResult<()>
where
T: OclPrm,
M: AsMem<T> + MemCmdAll,
{
let arg_idx = self.named_args.resolve_idx(name)?;
match image_opt {
Some(img) => {
self.mem_args.insert(arg_idx, img.as_mem().clone());
self._set_arg::<T>(arg_idx, ArgVal::mem(img.as_mem()))
}
None => {
self.mem_args.remove(&arg_idx);
self._set_arg::<T>(arg_idx, ArgVal::mem_null())
}
}
}
/// Sets the value of a named sampler argument.
#[deprecated(since = "0.18.0", note = "Use `::set_arg_sampler_named` instead.")]
pub fn set_arg_smp_named<'a>(
&'a self,
name: &'static str,
sampler_opt: Option<&Sampler>,
) -> OclResult<()> {
let arg_idx = self.named_args.resolve_idx(name)?;
match sampler_opt {
Some(sampler) => self._set_arg::<u64>(arg_idx, ArgVal::sampler(sampler)),
None => self._set_arg::<u64>(arg_idx, ArgVal::sampler_null()),
}
}
/// Modifies the kernel argument named: `name`.
#[deprecated(since = "0.18.0", note = "Use `::set_arg` instead.")]
pub fn set_arg_scl_named<'a, T, B>(&'a self, name: &'static str, scalar: B) -> OclResult<()>
where
T: OclPrm,
B: Borrow<T>,
{
let arg_idx = self.named_args.resolve_idx(name)?;
self._set_arg::<T>(arg_idx, ArgVal::scalar(scalar.borrow()))
}
/// Modifies the kernel argument named: `name`.
#[deprecated(since = "0.18.0", note = "Use `::set_arg` instead.")]
pub fn set_arg_vec_named<'a, T, B>(&'a self, name: &'static str, vector: B) -> OclResult<()>
where
T: OclPrm,
B: Borrow<T>,
{
let arg_idx = self.named_args.resolve_idx(name)?;
self._set_arg::<T>(arg_idx, ArgVal::vector(vector.borrow()))
}
/// Sets the value of a named sampler argument.
pub fn set_arg_sampler_named<'a, Ai>(
&'a self,
idx: Ai,
sampler_opt: Option<&Sampler>,
) -> OclResult<()>
where
Ai: Into<ArgIdxSpecifier>,
{
// let arg_idx = self.named_args.resolve_idx(name)?;
let arg_idx = idx.into().to_idx(&self.named_args)?;
match sampler_opt {
Some(sampler) => self._set_arg::<u64>(arg_idx, ArgVal::sampler(sampler)),
None => self._set_arg::<u64>(arg_idx, ArgVal::sampler_null()),
}
}
/// Returns a command builder which is used to chain parameters of an
/// 'enqueue' command together.
pub fn cmd(&self) -> KernelCmd {
KernelCmd {
kernel: &self.obj_core,
queue: self.queue.as_ref().map(|q| q.as_ref()),
gwo: self.gwo,
gws: self.gws,
lws: self.lws,
wait_events: None,
new_event: None,
}
}
/// Enqueues this kernel on the default queue using the default work sizes
/// and offsets.
///
/// Shorthand for `.cmd().enq()`
///
/// # Safety
///
/// All kernel code must be considered untrusted. Therefore the act of
/// calling this function contains implied unsafety even though the API
/// itself is safe.
pub unsafe fn enq(&self) -> OclResult<()> {
self.cmd().enq()
}
/// Changes the default queue.
///
/// Returns a ref for chaining i.e.:
///
/// `kernel.set_default_queue(queue).enqueue(....);`
///
/// Even when used as above, the queue is changed permanently,
/// not just for the one call. Changing the queue is cheap so feel free
/// to change as often as needed.
///
/// If you want to change the queue for only a single call, use:
/// `::cmd.queue(...)...enq()...`
///
/// The new queue must be associated with a device associated with the
/// kernel's program.
///
pub fn set_default_queue(&mut self, queue: Queue) -> &mut Kernel {
self.queue = Some(queue);
self
}
/// Returns the default global work offset.
#[deprecated(since = "0.18.0", note = "Use `::global_work_offset` instead.")]
pub fn get_gwo(&self) -> SpatialDims {
self.gwo
}
/// Returns the default global work size.
#[deprecated(since = "0.18.0", note = "Use `::global_work_size` instead.")]
pub fn get_gws(&self) -> SpatialDims {
self.gws
}
/// Returns the default local work size.
#[deprecated(since = "0.18.0", note = "Use `::local_work_size` instead.")]
pub fn get_lws(&self) -> SpatialDims {
self.lws
}
/// Sets the default global work offset.
pub fn set_default_global_work_offset(&mut self, gwo: SpatialDims) -> &mut Kernel {
self.gwo = gwo;
self
}
/// Sets the default global work size.
pub fn set_default_global_work_size(&mut self, gws: SpatialDims) -> &mut Kernel {
self.gws = gws;
self
}
/// Sets the default local work size.
pub fn set_default_local_work_size(&mut self, lws: SpatialDims) -> &mut Kernel {
self.lws = lws;
self
}
/// Returns the default queue for this kernel if one has been set.
pub fn default_queue(&self) -> Option<&Queue> {
self.queue.as_ref()
}
/// Returns the default global work offset.
pub fn default_global_work_offset(&self) -> SpatialDims {
self.gwo
}
/// Returns the default global work size.
pub fn default_global_work_size(&self) -> SpatialDims {
self.gws
}
/// Returns the default local work size.
pub fn default_local_work_size(&self) -> SpatialDims {
self.lws
}
/// Returns a reference to the core pointer wrapper, usable by functions in
/// the `core` module.
#[inline]
pub fn as_core(&self) -> &KernelCore {
self
}
/// Returns information about this kernel.
pub fn info(&self, info_kind: KernelInfo) -> OclResult<KernelInfoResult> {
core::get_kernel_info(&self.obj_core, info_kind).map_err(OclError::from)
}
/// Returns work group information for this kernel.
pub fn wg_info(
&self,
device: Device,
info_kind: KernelWorkGroupInfo,
) -> OclResult<KernelWorkGroupInfoResult> {
core::get_kernel_work_group_info(&self.obj_core, device, info_kind).map_err(OclError::from)
}
/// Returns argument information for this kernel.
pub fn arg_info(
&self,
arg_idx: u32,
info_kind: KernelArgInfo,
) -> OclResult<KernelArgInfoResult> {
arg_info(&*self.as_core(), arg_idx, info_kind)
}
/// Returns the name of this kernel.
pub fn name(&self) -> OclResult<String> {
core::get_kernel_info(&self.obj_core, KernelInfo::FunctionName)
.map(|r| r.into())
.map_err(OclError::from)
}
/// Returns the number of arguments this kernel has.
pub fn num_args(&self) -> OclResult<u32> {
match core::get_kernel_info(&self.obj_core, KernelInfo::NumArgs) {
Ok(KernelInfoResult::NumArgs(num)) => Ok(num),
Err(err) => Err(err.into()),
_ => unreachable!(),
}
}
fn fmt_info(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
f.debug_struct("Kernel")
.field("FunctionName", &self.info(KernelInfo::FunctionName))
.field("ReferenceCount", &self.info(KernelInfo::ReferenceCount))
.field("Context", &self.info(KernelInfo::Context))
.field("Program", &self.info(KernelInfo::Program))
.field("Attributes", &self.info(KernelInfo::Attributes))
.finish()
}
// fn fmt_arg_info(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
// f.debug_struct("Kernel")
// .field("FunctionName", &self.info(KernelInfo::FunctionName))
// .field("ReferenceCount", &self.info(KernelInfo::ReferenceCount))
// .field("Context", &self.info(KernelInfo::Context))
// .field("Program", &self.info(KernelInfo::Program))
// .field("Attributes", &self.info(KernelInfo::Attributes))
// .finish()
// }
fn fmt_wg_info<D>(&self, f: &mut std::fmt::Formatter, devices: Vec<D>) -> std::fmt::Result
where
D: Into<Device>,
{
for device in devices {
let device = device.into();
if !device.vendor().unwrap().contains("NVIDIA") {
f.debug_struct("WorkGroup")
.field(
"WorkGroupSize",
&self.wg_info(device, KernelWorkGroupInfo::WorkGroupSize),
)
.field(
"CompileWorkGroupSize",
&self.wg_info(device, KernelWorkGroupInfo::CompileWorkGroupSize),
)
.field(
"LocalMemSize",
&self.wg_info(device, KernelWorkGroupInfo::LocalMemSize),
)
.field(
"PreferredWorkGroupSizeMultiple",
&self.wg_info(device, KernelWorkGroupInfo::PreferredWorkGroupSizeMultiple),
)
.field(
"PrivateMemSize",
&self.wg_info(device, KernelWorkGroupInfo::PrivateMemSize),
)
// .field("GlobalWorkSize", &self.wg_info(device, KernelWorkGroupInfo::GlobalWorkSize))
.finish()?;
}
}
Ok(())
}
}
impl std::fmt::Display for Kernel {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.fmt_info(f)?;
write!(f, " ")?;
self.fmt_wg_info(f, self.obj_core.devices().unwrap())
}
}
impl Deref for Kernel {
type Target = KernelCore;
fn deref(&self) -> &KernelCore {
&self.obj_core
}
}
/// A kernel builder.
///
///
/// ### Examples
///
/// ```rust,ignore
/// // Create a kernel:
/// let kernel = Kernel::builder()
/// .program(&program)
/// .name("process")
/// .queue(queue.clone())
/// .global_work_size(&gws_patch_count)
/// .arg(&(patch_size as i32))
/// .arg(&source_buffer)
/// .arg(&destination_buffer)
/// .build()?;
/// ```
///
/// Re-use and clone:
///
/// ```rust,ignore
/// // Create a builder for re-use:
/// let builder = Kernel::builder()
/// .program(&program)
/// .name("process")
/// .queue(queue.clone())
/// .global_work_size([512, 64, 64])
/// .arg(&(patch_size as i32))
/// .arg(&source_buffer)
/// .arg_named("dest", &destination_buffer);
///
/// // Create multiple kernels using the same builder:
/// let kernel_0 = builder.build()?;
/// let kernel_1 = builder.build()?;
///
/// // Clone the builder:
/// let mut builder_clone = builder.clone();
///
/// // Modify a default parameter:
/// builder_clone.global_work_size([1024, 128, 128]);
///
/// // Create another kernel using the cloned builder:
/// let kernel_2 = builder_clone.build()?;
///
/// // Modify one of the arguments using the created kernel directly
/// // (arguments cannot be modified using the builder):
/// kernel_2.set_arg("dest", &alternate_destination_buffer)?;
///
/// // Arguments can also be referred to by index:
/// kernel_2.set_arg(1, &alternate_source_buffer)?;
/// ```
///
#[derive(Debug)]
pub struct KernelBuilder<'b> {
program: Option<&'b Program>,
name: Option<String>,
named_args: NamedArgs,
mem_args: MemArgs,
args: Vec<(ArgValKeeper<'b>, Option<TypeId>)>,
queue: Option<Queue>,
gwo: SpatialDims,
gws: SpatialDims,
lws: SpatialDims,
disable_arg_check: bool,
}
impl<'b> KernelBuilder<'b> {
/// Returns a new kernel builder.
pub fn new() -> KernelBuilder<'b> {
KernelBuilder {
program: None,
name: None,
named_args: NamedArgs(None),
args: Vec::with_capacity(16),
mem_args: MemArgs(Some(RefCell::new(BTreeMap::new()))),
queue: None,
gwo: SpatialDims::Unspecified,
gws: SpatialDims::Unspecified,
lws: SpatialDims::Unspecified,
disable_arg_check: false,
}
}
/// Specifies a program object with a successfully built executable.
pub fn program<'s>(&'s mut self, program: &'b Program) -> &'s mut KernelBuilder<'b> {
self.program = Some(program);
self
}
/// Specifies a function name in the program declared with the `__kernel`
/// qualifier (e.g. `__kernel void add_values(...`).
pub fn name<'s, S>(&'s mut self, name: S) -> &'s mut KernelBuilder<'b>
where
S: Into<String>,
{
self.name = Some(name.into());
self
}
/// Sets the default queue to be used by all subsequent enqueue commands
/// unless otherwise changed (with `::set_default_queue`) or overridden
/// (by `::cmd().queue(...)...`).
///
/// The queue must be associated with a device associated with the
/// kernel's program.
pub fn queue<'s>(&'s mut self, queue: Queue) -> &'s mut KernelBuilder<'b> {
self.queue = Some(queue);
self
}
/// Sets the default global work offset.
///
/// Used when enqueuing kernel commands. Superseded if specified while
/// building a queue command with `::cmd`.
#[deprecated(since = "0.18.0", note = "Use `::global_work_offset` instead.")]
pub fn gwo<'s, D: Into<SpatialDims>>(&'s mut self, gwo: D) -> &'s mut KernelBuilder<'b> {
self.gwo = gwo.into();
self
}
/// Sets the default global work size.
///
/// Used when enqueuing kernel commands. Superseded if specified while
/// building a queue command with `::cmd`.
#[deprecated(since = "0.18.0", note = "Use `::global_work_size` instead.")]
pub fn gws<'s, D: Into<SpatialDims>>(&'s mut self, gws: D) -> &'s mut KernelBuilder<'b> {
self.gws = gws.into();
self
}
/// Sets the default local work size.
///
/// Used when enqueuing kernel commands. Superseded if specified while
/// building a queue command with `::cmd`.
#[deprecated(since = "0.18.0", note = "Use `::local_work_size` instead.")]
pub fn lws<'s, D: Into<SpatialDims>>(&'s mut self, lws: D) -> &'s mut KernelBuilder<'b> {
self.lws = lws.into();
self
}
/// Sets the default global work offset.
///
/// Used when enqueuing kernel commands. Superseded if specified while
/// building a queue command with `::cmd`.
pub fn global_work_offset<'s, D: Into<SpatialDims>>(
&'s mut self,
gwo: D,
) -> &'s mut KernelBuilder<'b> {
self.gwo = gwo.into();
self
}
/// Sets the default global work size.
///
/// Used when enqueuing kernel commands. Superseded if specified while
/// building a queue command with `::cmd`.
pub fn global_work_size<'s, D: Into<SpatialDims>>(
&'s mut self,
gws: D,
) -> &'s mut KernelBuilder<'b> {
self.gws = gws.into();
self
}
/// Sets the default local work size.
///
/// Used when enqueuing kernel commands. Superseded if specified while
/// building a queue command with `::cmd`.
pub fn local_work_size<'s, D: Into<SpatialDims>>(
&'s mut self,
lws: D,
) -> &'s mut KernelBuilder<'b> {
self.lws = lws.into();
self
}
/// Adds a new argument to the kernel and returns the index.
fn new_arg(
&mut self,
arg_val: ArgValKeeper<'b>,
type_id: Option<TypeId>,
mem: Option<MemCore>,
) -> u32 {
let arg_idx = self.args.len() as u32;
// If the `KernelArg` is a `Mem` variant, clone the `MemCore` it
// refers to, store it in `self.mem_args`. This prevents a buffer
// which has gone out of scope from being erroneously referred to when
// this kernel is enqueued and causing either a misleading error
// message or a hard to debug segfault depending on the platform.
match mem {
Some(mem) => self.mem_args.insert(arg_idx, mem),
None => self.mem_args.remove(&arg_idx),
};
self.args.push((arg_val, type_id));
arg_idx
}
/// Non-builder-style version of `::arg_buf()`.
fn new_arg_buf<T, M>(&mut self, buffer_opt: Option<&'b M>) -> u32
where
T: OclPrm,
M: 'b + AsMem<T> + MemCmdAll,
{
match buffer_opt {
Some(buffer) => self.new_arg(
ArgValKeeper::Shared(ArgVal::mem(buffer.as_mem())),
Some(TypeId::of::<T>()),
Some(buffer.as_mem().clone()),
),
None => self.new_arg(ArgValKeeper::mem_null(), Some(TypeId::of::<T>()), None),
}
}
/// Non-builder-style version of `::arg_img()`.
fn new_arg_img<T, M>(&mut self, image_opt: Option<&'b M>) -> u32
where
T: OclPrm,
M: 'b + AsMem<T> + MemCmdAll,
{
match image_opt {
Some(image) => {
// Type is ignored:
self.new_arg(
ArgValKeeper::Shared(ArgVal::mem(image.as_mem())),
None,
Some(image.as_mem().clone()),
)
}
None => self.new_arg(ArgValKeeper::mem_null(), None, None),
}
}
/// Non-builder-style version of `::arg_img()`.
fn new_arg_smp(&mut self, sampler_opt: Option<&'b Sampler>) -> u32 {
match sampler_opt {
Some(sampler) => {
// Type is ignored:
self.new_arg(ArgValKeeper::Shared(ArgVal::sampler(sampler)), None, None)
}
None => self.new_arg(ArgValKeeper::Shared(ArgVal::sampler_null()), None, None),
}
}
/// Non-builder-style version of `::arg_scl()`.
fn new_arg_scl<T>(&mut self, scalar: T) -> u32
where
T: OclPrm,
{
self.new_arg(
ArgValKeeper::owned_prm(scalar),
Some(TypeId::of::<T>()),
None,
)
}
/// Non-builder-style version of `::arg_vec()`.
fn new_arg_vec<T>(&mut self, vector: T) -> u32
where
T: OclPrm,
{
self.new_arg(
ArgValKeeper::owned_prm(vector),
Some(TypeId::of::<T>()),
None,
)
}
/// Non-builder-style version of `::arg_loc()`.
fn new_arg_loc<T>(&mut self, length: usize) -> u32
where
T: OclPrm,
{
self.new_arg(
ArgValKeeper::Shared(ArgVal::local::<T>(&length)),
None,
None,
)
}
/// Adds a new `Buffer`, `Image`, scalar, or vector argument to the
/// kernel.
///
/// The argument is added to the bottom of the argument order.
///
/// ### Example
///
/// ```rust,ignore
/// let kern = ocl_pq.kernel_builder("multiply_by_scalar")
/// .arg(&100.0f32)
/// .arg(&source_buffer)
/// .arg(&result_buffer)
/// .build()?;
/// ```
pub fn arg<'s, T, A>(&'s mut self, arg: A) -> &'s mut KernelBuilder<'b>
where
T: OclPrm,
A: Into<ArgValConverter<'b, T>>,
{
let arg = arg.into();
self.new_arg(arg.val, arg.type_id, arg.mem);
self
}
/// Adds a new argument to the kernel specifying the buffer object represented
/// by 'buffer'.
///
/// The argument is added to the bottom of the argument order.
#[deprecated(since = "0.18.0", note = "Use ::arg instead.")]
pub fn arg_buf<'s, T, M>(&'s mut self, buffer: &'b M) -> &'s mut KernelBuilder<'b>
where
T: OclPrm,
M: 'b + AsMem<T> + MemCmdAll,
{
self.new_arg_buf::<T, _>(Some(buffer));
self
}
/// Adds a new argument to the kernel specifying the image object represented
/// by 'image'.
///
/// The argument is added to the bottom of the argument order.
#[deprecated(since = "0.18.0", note = "Use ::arg instead.")]
pub fn arg_img<'s, T, M>(&'s mut self, image: &'b M) -> &'s mut KernelBuilder<'b>
where
T: OclPrm,
M: 'b + AsMem<T> + MemCmdAll,
{
self.new_arg_img::<T, _>(Some(image));
self
}
/// Adds a new argument to the kernel specifying the sampler object represented
/// by 'sampler'. Argument is added to the bottom of the argument
/// order.
#[deprecated(since = "0.18.0", note = "Use ::arg_sampler instead.")]
pub fn arg_smp<'s>(&'s mut self, sampler: &'b Sampler) -> &'s mut KernelBuilder<'b> {
self.new_arg_smp(Some(sampler));
self
}
/// Adds a new argument specifying the value: `scalar`.
///
/// The argument is added to the bottom of the argument order.
#[deprecated(since = "0.18.0", note = "Use ::arg instead.")]
pub fn arg_scl<'s, T>(&'s mut self, scalar: T) -> &'s mut KernelBuilder<'b>
where
T: OclPrm,
{
self.new_arg_scl(scalar);
self
}
/// Adds a new argument specifying the value: `vector`.
///
/// The argument is added to the bottom of the argument order.
#[deprecated(since = "0.18.0", note = "Use ::arg instead.")]
pub fn arg_vec<'s, T>(&'s mut self, vector: T) -> &'s mut KernelBuilder<'b>
where
T: OclPrm,
{
self.new_arg_vec(vector);
self
}
/// Adds a new argument specifying the allocation of a local variable of size
/// `length * sizeof(T)` bytes (builder_style).
///
/// The argument is added to the bottom of the argument order.
///
/// Local variables are used to share data between work items in the same
/// workgroup.
#[deprecated(since = "0.18.0", note = "Use ::arg_local instead.")]
pub fn arg_loc<'s, T>(&'s mut self, length: usize) -> &'s mut KernelBuilder<'b>
where
T: OclPrm,
{
self.new_arg_loc::<T>(length);
self
}
/// Adds a new argument to the kernel specifying the sampler object represented
/// by 'sampler'. Argument is added to the bottom of the argument
/// order.
pub fn arg_sampler<'s>(&'s mut self, sampler: &'b Sampler) -> &'s mut KernelBuilder<'b> {
self.new_arg_smp(Some(sampler));
self
}
/// Adds a new argument specifying the allocation of a local variable of size
/// `length * sizeof(T)` bytes (builder_style).
///
/// The argument is added to the bottom of the argument order.
///
/// Local variables are used to share data between work items in the same
/// workgroup.
pub fn arg_local<'s, T>(&'s mut self, length: usize) -> &'s mut KernelBuilder<'b>
where
T: OclPrm,
{
self.new_arg_loc::<T>(length);
self
}
/// Adds a new *named* `Buffer`, `Image`, scalar, or vector argument to the
/// kernel.
///
/// The argument is added to the bottom of the argument order.
///
/// To set a `Buffer` or `Image` argument to `None` (null), you must use a
/// type annotation (e.g. `None::<&Buffer<f32>>`). Scalar and vector
/// arguments may not be null; use zero (e.g. `&0`) instead.
///
/// Named arguments can be modified later using `::set_arg()`.
///
/// ### Example
///
/// ```rust,ignore
/// // Create a kernel with arguments corresponding to those in the kernel.
/// // One argument will be 'named':
/// let kern = ocl_pq.kernel_builder("multiply_by_scalar")
/// .arg(&COEFF)
/// .arg(&source_buffer)
/// .arg_named("result", None::<&Buffer<f32>>)
/// .build()?;
///
/// // Set our named argument. The Option<_> wrapper is, well... optional:
/// kern.set_arg("result", &result_buffer)?;
/// // We can also set arguments (named or not) by index:
/// kern.set_arg(2, &result_buffer)?;
/// ```
pub fn arg_named<'s, T, S, A>(&'s mut self, name: S, arg: A) -> &'s mut KernelBuilder<'b>
where
S: Into<Cow<'static, str>>,
T: OclPrm,
A: Into<ArgValConverter<'b, T>>,
{
let arg = arg.into();
let arg_idx = self.new_arg(arg.val, arg.type_id, arg.mem);
self.named_args.insert(name.into(), arg_idx);
self
}
/// Adds a new *named* argument specifying the buffer object represented by
/// 'buffer'.
///
/// The argument is added to the bottom of the argument order.
///
/// Named arguments can be easily modified later using `::set_arg_buf_named()`.
#[deprecated(since = "0.18.0", note = "Use ::arg_named instead.")]
pub fn arg_buf_named<'s, T, S, M>(
&'s mut self,
name: S,
buffer_opt: Option<&'b M>,
) -> &'s mut KernelBuilder<'b>
where
S: Into<Cow<'static, str>>,
T: OclPrm,
M: 'b + AsMem<T> + MemCmdAll,
{
let arg_idx = self.new_arg_buf::<T, _>(buffer_opt);
self.named_args.insert(name.into(), arg_idx);
self
}
/// Adds a new *named* argument specifying the image object represented by
/// 'image'.
///
/// The argument is added to the bottom of the argument order.
///
/// Named arguments can be easily modified later using `::set_arg_img_named()`.
#[deprecated(since = "0.18.0", note = "Use ::arg_named instead.")]
pub fn arg_img_named<'s, T, S, M>(
&'s mut self,
name: S,
image_opt: Option<&'b M>,
) -> &'s mut KernelBuilder<'b>
where
S: Into<Cow<'static, str>>,
T: OclPrm,
M: 'b + AsMem<T> + MemCmdAll,
{
let arg_idx = self.new_arg_img::<T, _>(image_opt);
self.named_args.insert(name.into(), arg_idx);
self
}
/// Adds a new *named* argument specifying the sampler object represented by
/// 'sampler'.
///
/// The argument is added to the bottom of the argument order.
///
/// Named arguments can be easily modified later using `::set_arg_smp_named()`.
#[deprecated(since = "0.18.0", note = "Use ::arg_sampler_named instead.")]
pub fn arg_smp_named<'s, S>(
&'s mut self,
name: S,
sampler_opt: Option<&'b Sampler>,
) -> &'s mut KernelBuilder<'b>
where
S: Into<Cow<'static, str>>,
{
let arg_idx = self.new_arg_smp(sampler_opt);
self.named_args.insert(name.into(), arg_idx);
self
}
/// Adds a new *named* argument specifying the value: `scalar`.
///
/// The argument is added to the bottom of the argument order.
///
/// Scalar arguments may not be null, use zero (e.g. `&0`) instead.
///
/// Named arguments can be easily modified later using `::set_arg_scl_named()`.
#[deprecated(since = "0.18.0", note = "Use ::arg_named instead.")]
pub fn arg_scl_named<'s, T>(
&'s mut self,
name: &'static str,
scalar: T,
) -> &'s mut KernelBuilder<'b>
where
T: OclPrm,
{
let arg_idx = self.new_arg_scl(scalar);
self.named_args.insert(name.into(), arg_idx);
self
}
/// Adds a new *named* argument specifying the value: `vector`.
///
/// The argument is added to the bottom of the argument order.
///
/// Vector arguments may not be null, use zero (e.g. `&0`) instead.
///
/// Named arguments can be easily modified later using `::set_arg_vec_named()`.
#[deprecated(since = "0.18.0", note = "Use ::arg_named instead.")]
pub fn arg_vec_named<'s, T>(
&'s mut self,
name: &'static str,
vector: T,
) -> &'s mut KernelBuilder<'b>
where
T: OclPrm,
{
let arg_idx = self.new_arg_vec(vector);
self.named_args.insert(name.into(), arg_idx);
self
}
/// Adds a new *named* argument specifying the sampler object represented by
/// 'sampler'.
///
/// The argument is added to the bottom of the argument order.
///
/// Named arguments can be easily modified later using `::set_arg_smp_named()`.
pub fn arg_sampler_named<'s>(
&'s mut self,
name: &'static str,
sampler_opt: Option<&'b Sampler>,
) -> &'s mut KernelBuilder<'b> {
let arg_idx = self.new_arg_smp(sampler_opt);
self.named_args.insert(name.into(), arg_idx);
self
}
/// Specifies whether or not to store a copy of memory objects (`Buffer`
/// and `Image`).
///
/// ### Safety
///
/// Disabling memory object argument retention can lead to a misleading
/// error message or a difficult to debug segfault (depending on the
/// platform) *if* a memory object is dropped before a kernel referring to
/// it is enqueued. Only disable this if you are certain all of the memory
/// objects set as kernel arguments will outlive the `Kernel` itself.
pub unsafe fn disable_mem_arg_retention<'s>(&'s mut self) -> &'s mut KernelBuilder<'b> {
self.mem_args = MemArgs(None);
self
}
/// Disables argument type checking when setting arguments.
///
/// Because the performance cost of argument type checking is negligible,
/// disabling is not recommended.
///
/// Argument type checking will automatically be disabled if any of the
/// devices in use do not support OpenCL version 1.2 or higher or if
/// argument information is not available on the associated platform.
pub unsafe fn disable_arg_type_check<'s>(&'s mut self) -> &'s mut KernelBuilder<'b> {
self.disable_arg_check = true;
self
}
/// Builds and returns a new `Kernel`
pub fn build(&self) -> OclResult<Kernel> {
let program = self.program.ok_or(KernelError::BuilderNoProgram)?;
let name = self.name.as_ref().ok_or(KernelError::BuilderNoKernelName)?;
let obj_core = core::create_kernel(program, name)?;
let num_args = match core::get_kernel_info(&obj_core, KernelInfo::NumArgs) {
Ok(KernelInfoResult::NumArgs(num)) => num,
Err(err) => return Err(OclError::from(err)),
_ => unreachable!(),
};
if self.args.len() as u32 != num_args {
return Err(KernelError::BuilderWrongArgCount {
required: num_args,
specified: self.args.len() as u32,
}
.into());
}
let mut arg_types = Vec::with_capacity(num_args as usize);
let mut all_arg_types_unknown = true;
let mut disable_arg_check = self.disable_arg_check;
// Cache argument types for later use, bypassing if the OpenCL version
// is too low (v1.1).
for arg_idx in 0..num_args {
let arg_type = match ArgType::from_kern_and_idx(&obj_core, arg_idx) {
Ok(at) => {
if !at.is_unknown() {
all_arg_types_unknown = false;
}
at
}
Err(err) => {
if let OclError::OclCore(ref core_err) = err {
if let OclCoreErrorKind::VersionLow { .. } = core_err {
disable_arg_check = true;
break;
}
}
return Err(err);
}
};
arg_types.push(arg_type);
}
// Check argument types then set arguments.
for (arg_idx, &(ref arg, ref type_id_opt)) in self.args.iter().enumerate() {
if !disable_arg_check {
if let Some(type_id) = *type_id_opt {
if !arg_types[arg_idx].matches(type_id) {
let ty_name = arg_type_name(&obj_core, arg_idx as u32)?;
let arg_name = arg_name(&obj_core, arg_idx as u32)?;
return Err(KernelError::ArgTypeMismatch {
idx: arg_idx as u32,
arg_name,
ty_name,
ty: arg_types[arg_idx].clone(),
}
.into());
}
}
}
let val = arg.to_arg_val();
// Some platforms do not like having a `null` argument set for mem objects.
if !val.is_mem_null() {
core::set_kernel_arg(&obj_core, arg_idx as u32, val)?;
}
}
let arg_types = if all_arg_types_unknown || disable_arg_check {
None
} else {
Some(arg_types)
};
Ok(Kernel {
obj_core,
named_args: self.named_args.clone(),
mem_args: self.mem_args.clone(),
queue: self.queue.clone(),
gwo: self.gwo,
gws: self.gws,
lws: self.lws,
arg_types,
})
}
}
/// Returns argument information for a kernel.
pub fn arg_info(
core: &KernelCore,
arg_idx: u32,
info_kind: KernelArgInfo,
) -> OclResult<KernelArgInfoResult> {
let device_versions = match core.device_versions() {
Ok(vers) => vers,
Err(e) => return Err(e.into()),
};
core::get_kernel_arg_info(core, arg_idx, info_kind, Some(&device_versions))
.map_err(OclError::from)
}
/// Returns the type name for a kernel argument at the specified index.
pub fn arg_type_name(core: &KernelCore, arg_idx: u32) -> OclResult<String> {
match arg_info(core, arg_idx, KernelArgInfo::TypeName) {
Ok(KernelArgInfoResult::TypeName(type_name)) => Ok(type_name),
Err(err) => Err(err),
_ => unreachable!(),
}
}
/// Returns the type name for a kernel argument at the specified index.
pub fn arg_name(core: &KernelCore, arg_idx: u32) -> OclResult<String> {
match arg_info(core, arg_idx, KernelArgInfo::Name) {
Ok(KernelArgInfoResult::Name(name)) => Ok(name),
Err(err) => Err(err),
_ => unreachable!(),
}
}
pub mod arg_type {
#![allow(unused_imports)]
use super::{arg_info, arg_type_name};
use crate::core::{
Error as OclCoreError, Kernel as KernelCore, OclPrm, Result as OclCoreResult, Status,
};
use crate::error::{Error as OclError, Result as OclResult};
use crate::ffi::{
cl_bitfield, cl_bool, cl_char, cl_double, cl_float, cl_half, cl_int, cl_long, cl_short,
cl_uchar, cl_uint, cl_ulong, cl_ushort,
};
use crate::standard::Sampler;
use std::any::{Any, TypeId};
pub use crate::core::{
Char, Char16, Char2, Char3, Char4, Char8, Double, Double16, Double2, Double3, Double4,
Double8, Float, Float16, Float2, Float3, Float4, Float8, Int, Int16, Int2, Int3, Int4,
Int8, Long, Long16, Long2, Long3, Long4, Long8, Short, Short16, Short2, Short3, Short4,
Short8, Uchar, Uchar16, Uchar2, Uchar3, Uchar4, Uchar8, Uint, Uint16, Uint2, Uint3, Uint4,
Uint8, Ulong, Ulong16, Ulong2, Ulong3, Ulong4, Ulong8, Ushort, Ushort16, Ushort2, Ushort3,
Ushort4, Ushort8,
};
/// The base type of an OpenCL primitive.
#[derive(Clone, Debug, Copy, PartialEq, Eq)]
pub enum BaseType {
Char,
Uchar,
Short,
Ushort,
Int,
Uint,
Long,
Ulong,
Float,
Double,
Sampler,
Image,
Unknown,
}
/// The cardinality of an OpenCL primitive.
///
/// (ex. `float4`: 4)
#[derive(Clone, Debug, Copy, PartialEq, Eq)]
pub enum Cardinality {
One,
Two,
Three,
Four,
Eight,
Sixteen,
}
/// The type of a kernel argument derived from its string representation.
#[allow(dead_code)]
#[derive(Clone, Debug)]
pub struct ArgType {
base_type: BaseType,
cardinality: Cardinality,
is_ptr: bool,
}
impl ArgType {
/// Returns an `ArgType` that will always return `true` when calling
/// `::is_match`.
pub fn unknown() -> OclResult<ArgType> {
Ok(ArgType {
base_type: BaseType::Unknown,
cardinality: Cardinality::One,
is_ptr: false,
})
}
/// Ascertains a `KernelArgType` from the contents of a
/// `KernelArgInfoResult::TypeName`.
///
/// * TODO: Optimize or outsource this if possible. Is `::contains`
/// the fastest way to parse these in this situation? Should
/// `::starts_with` be used for base type names instead?
pub fn from_str(type_name: &str) -> OclResult<ArgType> {
let is_ptr = type_name.contains('*');
let card = if type_name.contains("16") {
Cardinality::Sixteen
} else if type_name.contains('8') {
Cardinality::Eight
} else if type_name.contains('4') {
Cardinality::Four
} else if type_name.contains('3') {
Cardinality::Three
} else if type_name.contains('2') {
Cardinality::Two
} else {
Cardinality::One
};
let base = if type_name.contains("uchar") {
BaseType::Uchar
} else if type_name.contains("char") {
BaseType::Char
} else if type_name.contains("ushort") {
BaseType::Ushort
} else if type_name.contains("short") {
BaseType::Short
} else if type_name.contains("uint") {
BaseType::Uint
} else if type_name.contains("int") {
BaseType::Int
} else if type_name.contains("ulong") {
BaseType::Ulong
} else if type_name.contains("long") {
BaseType::Long
} else if type_name.contains("float") {
BaseType::Float
} else if type_name.contains("double") {
BaseType::Double
} else if type_name.contains("sampler") {
BaseType::Sampler
} else if type_name.contains("image") {
BaseType::Image
} else {
BaseType::Unknown
};
Ok(ArgType {
base_type: base,
cardinality: card,
is_ptr,
})
}
/// Returns a new argument type specifier.
///
/// This function calls `core::get_kernel_arg_info`. Some platforms
/// (Apple, NVIDIA) either do not implement
/// `core::get_kernel_arg_info` or error in irregular ways. Known
/// irregular errors are checked for here. The result of a call to
/// `ArgType::unknown()` (which matches any argument type) is returned
/// if any are found.
pub fn from_kern_and_idx(core: &KernelCore, arg_idx: u32) -> OclResult<ArgType> {
use crate::core::EmptyInfoResultError;
use crate::core::Error as OclCoreErrorKind;
match arg_type_name(core, arg_idx) {
Ok(type_name) => ArgType::from_str(type_name.as_str()),
Err(err) => {
// Escape hatches for known, platform-specific errors.
if let OclError::OclCore(ref core_err) = err {
match *core_err {
OclCoreErrorKind::Api(ref api_err) => {
if api_err.status() == Status::CL_KERNEL_ARG_INFO_NOT_AVAILABLE {
return ArgType::unknown().map_err(OclError::from);
}
}
OclCoreErrorKind::EmptyInfoResult(EmptyInfoResultError::KernelArg) => {
return ArgType::unknown();
}
_ => (),
}
}
Err(err)
}
}
}
/// Returns true if `type_id` matches the base type of this `ArgType`.
pub fn matches(&self, type_id: TypeId) -> bool {
macro_rules! matches {
(
$primary:ty,
$struct:ty, $struct2:ty,
$struct3:ty, $struct4:ty,
$struct8:ty, $struct16:ty
) => {{
let card_match = match self.cardinality {
Cardinality::One => {
TypeId::of::<$primary>() == type_id
|| TypeId::of::<$struct>() == type_id
}
Cardinality::Two => TypeId::of::<$struct2>() == type_id,
Cardinality::Three => TypeId::of::<$struct3>() == type_id,
Cardinality::Four => TypeId::of::<$struct4>() == type_id,
Cardinality::Eight => TypeId::of::<$struct8>() == type_id,
Cardinality::Sixteen => TypeId::of::<$struct16>() == type_id,
};
if self.is_ptr {
card_match
|| TypeId::of::<$primary>() == type_id
|| TypeId::of::<$struct>() == type_id
} else {
card_match
}
}};
}
match self.base_type {
BaseType::Char => matches!(cl_char, Char, Char2, Char3, Char4, Char8, Char16),
BaseType::Uchar => {
matches!(cl_uchar, Uchar, Uchar2, Uchar3, Uchar4, Uchar8, Uchar16)
}
BaseType::Short => {
matches!(cl_short, Short, Short2, Short3, Short4, Short8, Short16)
}
BaseType::Ushort => {
matches!(cl_ushort, Ushort, Ushort2, Ushort3, Ushort4, Ushort8, Ushort16)
}
BaseType::Int => matches!(cl_int, Int, Int2, Int3, Int4, Int8, Int16),
BaseType::Uint => matches!(cl_uint, Uint, Uint2, Uint3, Uint4, Uint8, Uint16),
BaseType::Long => matches!(cl_long, Long, Long2, Long3, Long4, Long8, Long16),
BaseType::Ulong => {
matches!(cl_ulong, Ulong, Ulong2, Ulong3, Ulong4, Ulong8, Ulong16)
}
BaseType::Float => {
matches!(cl_float, Float, Float2, Float3, Float4, Float8, Float16)
}
BaseType::Double => {
matches!(cl_double, Double, Double2, Double3, Double4, Double8, Double16)
}
BaseType::Sampler => TypeId::of::<u64>() == type_id,
BaseType::Image => TypeId::of::<u64>() == type_id,
// Everything matches if type was undetermined (escape hatch):
BaseType::Unknown => true,
}
}
/// Returns true if the type of `T` matches the base type of this `ArgType`.
pub fn is_match<T: OclPrm + Any + 'static>(&self) -> bool {
self.matches(TypeId::of::<T>())
}
#[allow(dead_code)]
pub fn is_ptr(&self) -> bool {
self.is_ptr
}
pub fn is_unknown(&self) -> bool {
match self.base_type {
BaseType::Unknown => true,
_ => false,
}
}
}
impl<'a> From<&'a str> for ArgType {
/// Ascertains a `KernelArgType` from the contents of a
/// `KernelArgInfoResult::TypeName`.
///
/// Panics if the string is not valid.
fn from(type_name: &'a str) -> ArgType {
ArgType::from_str(type_name).unwrap()
}
}
}
#[cfg(test)]
mod tests {
use crate::ProQue;
#[test]
fn set_local_arg() -> crate::Result<()> {
let src = r#"
__kernel void local_args(__local double* localVec) {
}
"#;
let pro_que = ProQue::builder().src(src).build()?;
let kernel_diff = pro_que
.kernel_builder("local_args")
.global_work_size(1)
.arg_local::<f64>(64)
.build()?;
unsafe {
kernel_diff.enq()?;
}
Ok(())
}
}