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
|
// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "third_party/blink/renderer/platform/graphics/canvas_resource_provider.h"
#include <inttypes.h>
#include <string>
#include "base/feature_list.h"
#include "base/functional/bind.h"
#include "base/memory/scoped_refptr.h"
#include "base/metrics/field_trial_params.h"
#include "base/metrics/histogram_functions.h"
#include "base/metrics/histogram_macros.h"
#include "base/observer_list.h"
#include "base/strings/stringprintf.h"
#include "base/task/bind_post_task.h"
#include "base/task/sequenced_task_runner.h"
#include "base/time/time.h"
#include "base/trace_event/memory_allocator_dump.h"
#include "base/trace_event/memory_dump_manager.h"
#include "base/trace_event/process_memory_dump.h"
#include "build/build_config.h"
#include "cc/paint/decode_stashing_image_provider.h"
#include "cc/paint/display_item_list.h"
#include "cc/tiles/software_image_decode_cache.h"
#include "components/viz/common/gpu/context_lost_observer.h"
#include "components/viz/common/gpu/raster_context_provider.h"
#include "components/viz/common/resources/shared_image_format_utils.h"
#include "gpu/GLES2/gl2extchromium.h"
#include "gpu/command_buffer/client/context_support.h"
#include "gpu/command_buffer/client/raster_interface.h"
#include "gpu/command_buffer/common/capabilities.h"
#include "gpu/command_buffer/common/gpu_memory_buffer_support.h"
#include "gpu/command_buffer/common/shared_image_capabilities.h"
#include "gpu/command_buffer/common/shared_image_trace_utils.h"
#include "gpu/command_buffer/common/shared_image_usage.h"
#include "gpu/config/gpu_driver_bug_workaround_type.h"
#include "gpu/config/gpu_feature_info.h"
#include "gpu/config/gpu_feature_type.h"
#include "skia/buildflags.h"
#include "skia/ext/legacy_display_globals.h"
#include "third_party/blink/public/common/features.h"
#include "third_party/blink/public/platform/platform.h"
#include "third_party/blink/public/platform/web_graphics_shared_image_interface_provider.h"
#include "third_party/blink/renderer/platform/graphics/accelerated_static_bitmap_image.h"
#include "third_party/blink/renderer/platform/graphics/canvas_deferred_paint_record.h"
#include "third_party/blink/renderer/platform/graphics/gpu/shared_gpu_context.h"
#include "third_party/blink/renderer/platform/graphics/memory_managed_paint_canvas.h"
#include "third_party/blink/renderer/platform/graphics/memory_managed_paint_recorder.h"
#include "third_party/blink/renderer/platform/graphics/skia/skia_utils.h"
#include "third_party/blink/renderer/platform/graphics/unaccelerated_static_bitmap_image.h"
#include "third_party/blink/renderer/platform/instrumentation/canvas_memory_dump_provider.h"
#include "third_party/blink/renderer/platform/scheduler/public/thread_scheduler.h"
#include "third_party/skia/include/core/SkImageInfo.h"
#include "third_party/skia/include/core/SkSurface.h"
#include "third_party/skia/include/gpu/GpuTypes.h"
#include "third_party/skia/include/gpu/ganesh/GrBackendSurface.h"
#include "third_party/skia/include/gpu/ganesh/GrDirectContext.h"
#include "third_party/skia/include/gpu/ganesh/GrTypes.h"
#include "third_party/skia/include/gpu/ganesh/SkSurfaceGanesh.h"
#include "third_party/skia/include/gpu/ganesh/gl/GrGLBackendSurface.h"
#include "third_party/skia/include/gpu/ganesh/gl/GrGLTypes.h"
namespace blink {
class FlushForImageListener {
// With deferred rendering it's possible for a drawImage operation on a canvas
// to trigger a copy-on-write if another canvas has a read reference to it.
// This can cause serious regressions due to extra allocations:
// crbug.com/1030108. FlushForImageListener keeps a list of all active 2d
// contexts on a thread and notifies them when one is attempting copy-on
// write. If the notified context has a read reference to the canvas
// attempting a copy-on-write it then flushes so as to make the copy-on-write
// unnecessary.
public:
static FlushForImageListener* GetFlushForImageListener();
void AddObserver(CanvasResourceProvider* observer) {
observers_.AddObserver(observer);
}
void RemoveObserver(CanvasResourceProvider* observer) {
observers_.RemoveObserver(observer);
}
void NotifyFlushForImage(cc::PaintImage::ContentId content_id) {
for (CanvasResourceProvider& obs : observers_)
obs.OnFlushForImage(content_id);
}
private:
friend class WTF::ThreadSpecific<FlushForImageListener>;
base::ObserverList<CanvasResourceProvider> observers_;
};
static FlushForImageListener* GetFlushForImageListener() {
DEFINE_THREAD_SAFE_STATIC_LOCAL(ThreadSpecific<FlushForImageListener>,
flush_for_image_listener, ());
return flush_for_image_listener;
}
namespace {
bool IsGMBAllowed(gfx::Size size,
viz::SharedImageFormat format,
const gpu::Capabilities& caps) {
const gfx::BufferFormat buffer_format =
viz::SinglePlaneSharedImageFormatToBufferFormat(format);
return gpu::IsImageSizeValidForGpuMemoryBufferFormat(size, buffer_format) &&
gpu::IsImageFromGpuMemoryBufferFormatSupported(buffer_format, caps);
}
} // namespace
class CanvasResourceProvider::CanvasImageProvider : public cc::ImageProvider {
public:
CanvasImageProvider(cc::ImageDecodeCache* cache_n32,
cc::ImageDecodeCache* cache_f16,
const gfx::ColorSpace& target_color_space,
viz::SharedImageFormat canvas_format,
cc::PlaybackImageProvider::RasterMode raster_mode);
CanvasImageProvider(const CanvasImageProvider&) = delete;
CanvasImageProvider& operator=(const CanvasImageProvider&) = delete;
~CanvasImageProvider() override = default;
// cc::ImageProvider implementation.
cc::ImageProvider::ScopedResult GetRasterContent(
const cc::DrawImage&) override;
void ReleaseLockedImages() { locked_images_.clear(); }
private:
void CanUnlockImage(ScopedResult);
void CleanupLockedImages();
bool IsHardwareDecodeCache() const;
cc::PlaybackImageProvider::RasterMode raster_mode_;
bool cleanup_task_pending_ = false;
Vector<ScopedResult> locked_images_;
std::optional<cc::PlaybackImageProvider> playback_image_provider_n32_;
std::optional<cc::PlaybackImageProvider> playback_image_provider_f16_;
base::WeakPtrFactory<CanvasImageProvider> weak_factory_{this};
};
// * Renders to a Skia RAM-backed bitmap.
// * Mailboxing is not supported : cannot be directly composited.
class CanvasResourceProviderBitmap : public CanvasResourceProvider {
public:
CanvasResourceProviderBitmap(gfx::Size size,
viz::SharedImageFormat format,
SkAlphaType alpha_type,
const gfx::ColorSpace& color_space,
CanvasResourceHost* resource_host)
: CanvasResourceProvider(kBitmap,
size,
format,
alpha_type,
color_space,
/*context_provider_wrapper=*/nullptr,
resource_host) {}
~CanvasResourceProviderBitmap() override = default;
bool IsValid() const override { return GetSkSurface(); }
bool IsAccelerated() const final { return false; }
bool SupportsDirectCompositing() const override { return false; }
bool IsSingleBuffered() const override { return false; }
private:
scoped_refptr<CanvasResource> ProduceCanvasResource(FlushReason) override {
return nullptr; // Does not support direct compositing
}
scoped_refptr<StaticBitmapImage> Snapshot(
FlushReason reason,
ImageOrientation orientation) override {
TRACE_EVENT0("blink", "CanvasResourceProviderBitmap::Snapshot");
return SnapshotInternal(orientation, reason);
}
sk_sp<SkSurface> CreateSkSurface() const override {
TRACE_EVENT0("blink", "CanvasResourceProviderBitmap::CreateSkSurface");
const auto info = GetSkImageInfo().makeAlphaType(kPremul_SkAlphaType);
const auto props = GetSkSurfaceProps();
return SkSurfaces::Raster(info, &props);
}
};
// * Renders to a SharedImage, which manages memory internally.
// * Layers may be overlay candidates.
class CanvasResourceProviderSharedImage : public CanvasResourceProvider,
public viz::ContextLostObserver,
public BitmapGpuChannelLostObserver {
public:
CanvasResourceProviderSharedImage(
gfx::Size size,
viz::SharedImageFormat format,
SkAlphaType alpha_type,
const gfx::ColorSpace& color_space,
WebGraphicsSharedImageInterfaceProvider* shared_image_interface_provider,
CanvasResourceHost* resource_host)
: CanvasResourceProvider(kSharedImage,
size,
format,
alpha_type,
color_space,
/*context_provider_wrapper=*/nullptr,
resource_host),
shared_image_interface_provider_(
shared_image_interface_provider
? shared_image_interface_provider->GetWeakPtr()
: nullptr),
is_accelerated_(false),
shared_image_usage_flags_(gpu::SHARED_IMAGE_USAGE_CPU_WRITE_ONLY),
use_oop_rasterization_(false),
is_software_(true) {
if (shared_image_interface_provider_) {
shared_image_interface_provider_->AddGpuChannelLostObserver(this);
}
}
CanvasResourceProviderSharedImage(
gfx::Size size,
viz::SharedImageFormat format,
SkAlphaType alpha_type,
const gfx::ColorSpace& color_space,
base::WeakPtr<WebGraphicsContext3DProviderWrapper>
context_provider_wrapper,
bool is_accelerated,
gpu::SharedImageUsageSet shared_image_usage_flags,
CanvasResourceHost* resource_host)
: CanvasResourceProvider(kSharedImage,
size,
format,
alpha_type,
color_space,
std::move(context_provider_wrapper),
resource_host),
raster_context_provider_(
base::WrapRefCounted(ContextProviderWrapper()
->ContextProvider()
.RasterContextProvider())),
is_accelerated_(is_accelerated),
shared_image_usage_flags_(shared_image_usage_flags),
use_oop_rasterization_(is_accelerated && ContextProviderWrapper()
->ContextProvider()
.GetCapabilities()
.gpu_rasterization) {
if (raster_context_provider_) {
raster_context_provider_->AddObserver(this);
}
resource_ = NewOrRecycledResource();
GetFlushForImageListener()->AddObserver(this);
if (resource_)
EnsureWriteAccess();
}
~CanvasResourceProviderSharedImage() override {
UMA_HISTOGRAM_EXACT_LINEAR("Blink.Canvas.MaximumInflightResources",
max_inflight_resources_, 20);
if (is_software_) {
if (shared_image_interface_provider_) {
shared_image_interface_provider_->RemoveGpuChannelLostObserver(this);
}
return;
}
if (raster_context_provider_) {
raster_context_provider_->RemoveObserver(this);
}
GetFlushForImageListener()->RemoveObserver(this);
// Issue any skia work using this resource before destroying any buffer
// that may have a reference in skia.
if (is_accelerated_ && !use_oop_rasterization_)
FlushGrContext();
}
bool IsSoftwareSharedImageGpuChannelLost() const override {
if (!is_software_) {
return false;
}
return !shared_image_interface_provider_ ||
!shared_image_interface_provider_->SharedImageInterface();
}
bool IsAccelerated() const final { return is_accelerated_; }
bool SupportsDirectCompositing() const override { return true; }
bool IsValid() const final {
if (is_software_) {
return !IsSoftwareSharedImageGpuChannelLost() && GetSkSurface();
}
if (!use_oop_rasterization_)
return GetSkSurface() && !IsGpuContextLost();
else
return !IsGpuContextLost();
}
bool IsSingleBuffered() const override {
return shared_image_usage_flags_.Has(
gpu::SHARED_IMAGE_USAGE_CONCURRENT_READ_WRITE);
}
bool HasUnusedResourcesForTesting() const override {
if (IsSingleBuffered()) {
return false;
}
return !unused_resources_.empty();
}
bool unused_resources_reclaim_timer_is_running_for_testing() const override {
return unused_resources_reclaim_timer_.IsRunning();
}
int NumInflightResourcesForTesting() const override {
return num_inflight_resources_;
}
scoped_refptr<gpu::ClientSharedImage>
GetBackingClientSharedImageForExternalWrite(
gpu::SyncToken* internal_access_sync_token,
gpu::SharedImageUsageSet required_shared_image_usages,
bool* was_copy_performed) override {
// This may cause the current resource and all cached resources to become
// unusable. WillDrawInternal() will detect this case, drop all cached
// resources, and copy the current resource to a newly-created resource
// which will by definition be usable.
shared_image_usage_flags_.PutAll(required_shared_image_usages);
DCHECK(is_accelerated_);
if (IsGpuContextLost())
return nullptr;
// End the internal write access before calling WillDrawInternal(), which
// has a precondition that there should be no current write access on the
// resource.
EndWriteAccess();
const CanvasResource* const original_resource = resource_.get();
WillDrawInternal(false);
if (was_copy_performed != nullptr) {
*was_copy_performed = resource_.get() != original_resource;
}
// NOTE: The above invocation of WillDrawInternal() ensures that this
// invocation of GetSyncToken() will generate a new sync token.
if (internal_access_sync_token) {
*internal_access_sync_token = resource_->GetSyncToken();
}
return resource_->GetClientSharedImage();
}
void EndExternalWrite(
const gpu::SyncToken& external_write_sync_token) override {
resource()->EndExternalWrite(external_write_sync_token);
}
gpu::SharedImageUsageSet GetSharedImageUsageFlags() const override {
return shared_image_usage_flags_;
}
bool WritePixels(const SkImageInfo& orig_info,
const void* pixels,
size_t row_bytes,
int x,
int y) override {
if (!use_oop_rasterization_) {
return CanvasResourceProvider::WritePixels(orig_info, pixels, row_bytes,
x, y);
}
TRACE_EVENT0("blink", "CanvasResourceProviderSharedImage::WritePixels");
if (IsGpuContextLost())
return false;
// TODO(crbug.com/352263194): This code calls WillDrawInternal(true)
// followed immediately by GetBackingClientSharedImageForOverwrite(), which
// calls WillDrawInternal(false). The former calls EnsureWriteAccess() and
// then the latter immediately calls EndWriteAccess(). Figure out what is
// actually intended here and either don't call the former (preserving
// current behavior) or call resource()->GetClientSharedImage() rather than
// the latter (if the current behavior is a bug).
WillDrawInternal(true);
// End the internal write access before calling WillDrawInternal(), which
// has a precondition that there should be no current write access on the
// resource.
EndWriteAccess();
WillDrawInternal(false);
auto client_si = resource()->GetClientSharedImage();
RasterInterface()->WritePixels(client_si->mailbox(), x, y,
client_si->GetTextureTarget(),
SkPixmap(orig_info, pixels, row_bytes));
// If the overdraw optimization kicked in, we need to indicate that the
// pixels do not need to be cleared, otherwise the subsequent
// rasterizations will clobber canvas contents.
if (x <= 0 && y <= 0 && orig_info.width() >= Size().width() &&
orig_info.height() >= Size().height())
is_cleared_ = true;
return true;
}
scoped_refptr<CanvasResourceSharedImage> CreateResource() {
TRACE_EVENT0("blink", "CanvasResourceProviderSharedImage::CreateResource");
if (is_software_) {
return CanvasResourceSharedImage::CreateSoftware(
Size(), viz::SinglePlaneFormat::kBGRA_8888, GetAlphaType(),
GetColorSpace(), CreateWeakPtr(), shared_image_interface_provider_);
}
if (IsGpuContextLost())
return nullptr;
return CanvasResourceSharedImage::Create(
Size(), GetSharedImageFormat(), GetAlphaType(), GetColorSpace(),
ContextProviderWrapper(), CreateWeakPtr(), is_accelerated_,
shared_image_usage_flags_);
}
bool UseOopRasterization() final { return use_oop_rasterization_; }
void NotifyTexParamsModified(const CanvasResource* resource) override {
if (!is_accelerated_ || use_oop_rasterization_)
return;
if (resource_.get() == resource) {
DCHECK(!current_resource_has_write_access_);
// Note that the call below is guarenteed to not issue any GPU work for
// the backend texture since we ensure that all skia work on the resource
// is issued before releasing write access.
auto tex = SkSurfaces::GetBackendTexture(
surface_.get(), SkSurfaces::BackendHandleAccess::kFlushRead);
GrBackendTextures::GLTextureParametersModified(&tex);
}
}
bool OverwriteImage(const scoped_refptr<gpu::ClientSharedImage>& shared_image,
const gfx::Rect& copy_rect,
const gpu::SyncToken& ready_sync_token,
gpu::SyncToken& completion_sync_token) override {
gpu::raster::RasterInterface* raster = RasterInterface();
if (!raster) {
return false;
}
if (IsGpuContextLost()) {
return false;
}
EndWriteAccess();
WillDrawInternal(false);
auto dst_client_si = resource()->GetClientSharedImage();
if (!dst_client_si) {
return false;
}
std::unique_ptr<gpu::RasterScopedAccess> ri_access =
shared_image->BeginRasterAccess(raster, ready_sync_token,
/*readonly=*/true);
raster->CopySharedImage(shared_image->mailbox(), dst_client_si->mailbox(),
/*xoffset=*/0,
/*yoffset=*/0, copy_rect.x(), copy_rect.y(),
copy_rect.width(), copy_rect.height());
completion_sync_token =
gpu::RasterScopedAccess::EndAccess(std::move(ri_access));
return true;
}
protected:
scoped_refptr<CanvasResource> ProduceCanvasResource(
FlushReason reason) override {
TRACE_EVENT0("blink",
"CanvasResourceProviderSharedImage::ProduceCanvasResource");
if (is_software_) {
DCHECK(GetSkSurface());
scoped_refptr<CanvasResource> output_resource = NewOrRecycledResource();
if (!output_resource) {
return nullptr;
}
FlushCanvas(reason);
// Note that the resource *must* be a CanvasResourceSharedImage as this
// class creates CanvasResourceSharedImage instances exclusively.
static_cast<CanvasResourceSharedImage*>(output_resource.get())
->UploadSoftwareRenderingResults(GetSkSurface());
return output_resource;
}
if (IsGpuContextLost())
return nullptr;
FlushCanvas(reason);
// Its important to end read access and ref the resource before the WillDraw
// call below. Since it relies on resource ref-count to trigger
// copy-on-write and asserts that we only have write access when the
// provider has the only ref to the resource, to ensure there are no other
// readers.
EndWriteAccess();
if (!resource_) {
return nullptr;
}
scoped_refptr<CanvasResource> resource = resource_;
if (ContextProviderWrapper()
->ContextProvider()
.GetCapabilities()
.disable_2d_canvas_copy_on_write) {
// A readback operation may alter the texture parameters, which may affect
// the compositor's behavior. Therefore, we must trigger copy-on-write
// even though we are not technically writing to the texture, only to its
// parameters. This issue is Android-WebView specific: crbug.com/585250.
WillDraw();
}
return resource;
}
scoped_refptr<StaticBitmapImage> Snapshot(
FlushReason reason,
ImageOrientation orientation) override {
TRACE_EVENT0("blink", "CanvasResourceProviderSharedImage::Snapshot");
if (!IsValid())
return nullptr;
// We don't need to EndWriteAccess here since that's required to make the
// rendering results visible on the GpuMemoryBuffer while we return cpu
// memory, rendererd to by skia, here.
if (!is_accelerated_)
return SnapshotInternal(orientation, reason);
if (!cached_snapshot_) {
FlushCanvas(reason);
EndWriteAccess();
cached_snapshot_ = resource_->Bitmap();
// We'll record its content_id to be used by the FlushForImageListener.
// This will be needed in WillDrawInternal, but we are doing it now, as we
// don't know if later on we will be in the same thread the
// cached_snapshot_ was created and we wouldn't be able to
// PaintImageForCurrentFrame in AcceleratedStaticBitmapImage just to check
// the content_id. ShouldReplaceTargetBuffer needs this ID in order to let
// other contexts know to flush to avoid unnecessary copy-on-writes.
if (cached_snapshot_) {
cached_content_id_ =
cached_snapshot_->PaintImageForCurrentFrame().GetContentIdForFrame(
0u);
}
}
DCHECK(cached_snapshot_);
DCHECK(!current_resource_has_write_access_);
return cached_snapshot_;
}
void WillDrawIfNeeded() final {
if (cached_snapshot_) {
WillDraw();
}
}
void WillDrawInternal(bool write_to_local_texture) {
DCHECK(resource_);
if (IsGpuContextLost())
return;
// Since the resource will be updated, the cached snapshot is no longer
// valid. Note that it is important to release this reference here to not
// trigger copy-on-write below from the resource ref in the snapshot.
// Note that this is valid for single buffered mode also, since while the
// resource/mailbox remains the same, the snapshot needs an updated sync
// token for these writes.
cached_snapshot_.reset();
// Determine if a copy is needed for accelerated resources. This could be
// for one of two reasons: (1) copy-on-write is required, or (2) the
// SharedImage usages with which this provider should create resources has
// changed since this resource was created (this can occur, for example,
// when a client requests the backing ClientSharedImage with a specific
// required set of usages for an external write). Note that for
// unaccelerated resources, neither of these apply: writes to the
// SharedImage are deferred to ProduceCanvasResource and hence
// copy-on-write is never needed here, and the set of SharedImage usages
// doesn't change over the lifetime of the provider.
if (is_accelerated_ && (ShouldReplaceTargetBuffer(cached_content_id_) ||
!IsResourceUsable(resource_.get()))) {
cached_content_id_ = PaintImage::kInvalidContentId;
DCHECK(!current_resource_has_write_access_)
<< "Write access must be released before sharing the resource";
auto old_resource = std::move(resource_);
auto* old_resource_shared_image =
static_cast<CanvasResourceSharedImage*>(old_resource.get());
if (!IsResourceUsable(old_resource.get())) {
// If this resource has become unusable, all cached resources have also
// become unusable. Drop them to ensure that a new usable resource gets
// created in the below call to NewOrRecycledResource().
ClearUnusedResources();
}
resource_ = NewOrRecycledResource();
DCHECK(IsResourceUsable(resource_.get()));
if (!use_oop_rasterization_) {
TearDownSkSurface();
}
if (mode_ == SkSurface::kRetain_ContentChangeMode) {
auto old_mailbox =
old_resource_shared_image->GetClientSharedImage()->mailbox();
auto mailbox = resource()->GetClientSharedImage()->mailbox();
RasterInterface()->CopySharedImage(old_mailbox, mailbox, 0, 0, 0, 0,
Size().width(), Size().height());
} else if (use_oop_rasterization_) {
// If we're not copying over the previous contents, we need to ensure
// that the image is cleared on the next BeginRasterCHROMIUM.
is_cleared_ = false;
}
// In non-OOPR mode we need to update the client side SkSurface with the
// copied texture. Recreating SkSurface here matches the GPU process
// behaviour that will happen in OOPR mode.
if (!use_oop_rasterization_) {
EnsureWriteAccess();
GetSkSurface();
}
UMA_HISTOGRAM_BOOLEAN("Blink.Canvas.ContentChangeMode",
mode_ == SkSurface::kRetain_ContentChangeMode);
mode_ = SkSurface::kRetain_ContentChangeMode;
}
if (write_to_local_texture)
EnsureWriteAccess();
else
EndWriteAccess();
if (resource()) {
resource()->WillDraw();
}
}
void WillDraw() override {
if (is_software_) {
return;
}
WillDrawInternal(true);
}
void RasterRecord(cc::PaintRecord last_recording) override {
if (!use_oop_rasterization_) {
CanvasResourceProvider::RasterRecord(std::move(last_recording));
return;
}
WillDrawInternal(true);
const bool needs_clear = !is_cleared_;
is_cleared_ = true;
RasterRecordOOP(std::move(last_recording), needs_clear,
resource()->GetClientSharedImage()->mailbox());
}
bool ShouldReplaceTargetBuffer(
PaintImage::ContentId content_id = PaintImage::kInvalidContentId) {
// If the canvas is single buffered, concurrent read/writes to the resource
// are allowed. Note that we ignore the resource lost case as well since
// that only indicates that we did not get a sync token for read/write
// synchronization which is not a requirement for single buffered canvas.
if (IsSingleBuffered())
return false;
// If the resource was lost, we can not use it for writes again.
if (resource()->IsLost())
return true;
// We have the only ref to the resource which implies there are no active
// readers.
if (resource_->HasOneRef())
return false;
// Its possible to have deferred work in skia which uses this resource. Try
// flushing once to see if that releases the read refs. We can avoid a copy
// by queuing this work before writing to this resource.
if (is_accelerated_) {
// Another context may have a read reference to this resource. Flush the
// deferred queue in that context so that we don't need to copy.
GetFlushForImageListener()->NotifyFlushForImage(content_id);
if (!use_oop_rasterization_) {
skgpu::ganesh::FlushAndSubmit(surface_);
}
}
return !resource_->HasOneRef();
}
sk_sp<SkSurface> CreateSkSurface() const override {
TRACE_EVENT0("blink", "CanvasResourceProviderSharedImage::CreateSkSurface");
if (is_software_) {
const auto props = GetSkSurfaceProps();
return SkSurfaces::Raster(GetSkImageInfo(), &props);
}
if (IsGpuContextLost() || !resource_) {
return nullptr;
}
const auto props = GetSkSurfaceProps();
if (is_accelerated_) {
return SkSurfaces::WrapBackendTexture(
GetGrContext(), CreateGrTextureForResource(),
kTopLeft_GrSurfaceOrigin, 0 /* msaa_sample_count */,
GetSkImageInfo().colorType(), GetSkImageInfo().refColorSpace(),
&props);
}
// For software raster path, we render into cpu memory managed internally
// by SkSurface and copy the rendered results to the GMB before dispatching
// it to the display compositor.
return SkSurfaces::Raster(resource_->CreateSkImageInfo(), &props);
}
GrBackendTexture CreateGrTextureForResource() const {
DCHECK(is_accelerated_);
return resource()->CreateGrTexture();
}
void FlushGrContext() {
DCHECK(is_accelerated_);
// The resource may have been imported and used in skia. Make sure any
// operations using this resource are flushed to the underlying context.
// Note that its not sufficient to flush the SkSurface here since it will
// only perform a GrContext flush if that SkSurface has any pending ops. And
// this resource may be written to or read from skia without using the
// SkSurface here.
if (IsGpuContextLost())
return;
GetGrContext()->flushAndSubmit();
}
void EnsureWriteAccess() {
DCHECK(resource_);
// In software mode, we don't need write access to the resource during
// drawing since it is executed on cpu memory managed by skia. We ensure
// exclusive access to the resource when the results are copied onto the
// GMB in EndWriteAccess.
DCHECK(resource_->HasOneRef() || IsSingleBuffered() || !is_accelerated_)
<< "Write access requires exclusive access to the resource";
DCHECK(!resource()->is_cross_thread())
<< "Write access is only allowed on the owning thread";
if (current_resource_has_write_access_ || IsGpuContextLost())
return;
if (is_accelerated_ && !use_oop_rasterization_) {
resource()->BeginWriteAccess();
}
// For the non-accelerated path, we don't need a texture for writes since
// its on the CPU, but we set this bit to know whether the GMB needs to be
// updated.
current_resource_has_write_access_ = true;
}
void EndWriteAccess() {
DCHECK(!resource()->is_cross_thread());
if (!current_resource_has_write_access_ || IsGpuContextLost())
return;
if (is_accelerated_) {
// We reset |mode_| here since the draw commands which overwrite the
// complete canvas must have been flushed at this point without triggering
// copy-on-write.
mode_ = SkSurface::kRetain_ContentChangeMode;
if (!use_oop_rasterization_) {
// Issue any skia work using this resource before releasing write
// access.
FlushGrContext();
resource()->EndWriteAccess();
}
} else {
// Currently we never use OOP raster when the resource is not accelerated
// so we check that assumption here.
DCHECK(!use_oop_rasterization_);
if (ShouldReplaceTargetBuffer())
resource_ = NewOrRecycledResource();
if (!resource() || !GetSkSurface()) {
return;
}
resource()->UploadSoftwareRenderingResults(GetSkSurface());
}
current_resource_has_write_access_ = false;
}
CanvasResourceSharedImage* resource() {
return static_cast<CanvasResourceSharedImage*>(resource_.get());
}
const CanvasResourceSharedImage* resource() const {
return static_cast<const CanvasResourceSharedImage*>(resource_.get());
}
void OnDestroyResource() override { --num_inflight_resources_; }
// For WebGpu RecyclableCanvasResource.
void OnAcquireRecyclableCanvasResource() override { EnsureWriteAccess(); }
void OnDestroyRecyclableCanvasResource(
const gpu::SyncToken& sync_token) override {
// RecyclableCanvasResource should be the only one that holds onto
// |resource_|.
DCHECK(resource_->HasOneRef());
resource_->WaitSyncToken(sync_token);
}
void OnFlushForImage(cc::PaintImage::ContentId content_id) override {
CanvasResourceProvider::OnFlushForImage(content_id);
if (cached_snapshot_ &&
cached_snapshot_->PaintImageForCurrentFrame().GetContentIdForFrame(0) ==
content_id) {
// This handles the case where the cached snapshot is referenced by an
// ImageBitmap that is being transferred to a worker.
cached_snapshot_.reset();
}
}
private:
// `viz::ContextLostObserver` implementation.
void OnContextLost() override {
if (notify_context_lost_in_new_task_) {
std::move(notify_context_lost_in_new_task_).Run();
}
}
// BitmapGpuChannelLostObserver implementation.
void OnGpuChannelLost() override {
if (notify_context_lost_in_new_task_) {
std::move(notify_context_lost_in_new_task_).Run();
}
}
void OnResourceRefReturned(
scoped_refptr<CanvasResourceSharedImage>&& resource) override {
if (!resource->IsLost() && resource->HasOneRef()) {
RecycleResource(std::move(resource));
}
}
void SetResourceRecyclingEnabled(bool value) override {
resource_recycling_enabled_ = value;
if (!resource_recycling_enabled_) {
ClearUnusedResources();
}
}
void RecycleResource(scoped_refptr<CanvasResourceSharedImage>&& resource) {
// We don't want to keep an arbitrary large number of canvases.
if (unused_resources_.size() >
static_cast<unsigned int>(kMaxRecycledCanvasResources)) {
return;
}
// Need to check HasOneRef() because if there are outstanding references to
// the resource, it cannot be safely recycled. In addition, we must check
// whether the state of the resource provider has changed such that the
// resource has become unusable in the interim.
if (resource->HasOneRef() && resource_recycling_enabled_ &&
!IsSingleBuffered() && IsResourceUsable(resource.get())) {
RegisterUnusedResource(std::move(resource));
MaybePostUnusedResourcesReclaimTask();
}
}
void ClearUnusedResources() override { unused_resources_.clear(); }
void RegisterUnusedResource(
scoped_refptr<CanvasResourceSharedImage>&& resource) {
CHECK(IsResourceUsable(resource.get()));
unused_resources_.emplace_back(base::TimeTicks::Now(), std::move(resource));
}
void MaybePostUnusedResourcesReclaimTask() {
if (!base::FeatureList::IsEnabled(kCanvas2DReclaimUnusedResources)) {
return;
}
if (resource_recycling_enabled_ && !IsSingleBuffered() &&
!unused_resources_reclaim_timer_.IsRunning() &&
!unused_resources_.empty()) {
unused_resources_reclaim_timer_.Start(
FROM_HERE, kUnusedResourceExpirationTime,
base::BindOnce(
&CanvasResourceProviderSharedImage::ClearOldUnusedResources,
base::Unretained(this)));
}
}
void ClearOldUnusedResources() {
WTF::EraseIf(unused_resources_, [](const UnusedResource& resource) {
return base::TimeTicks::Now() - resource.last_use >=
kUnusedResourceExpirationTime;
});
// May have destroyed resources above that contains shared images.
// ClientSharedImage destructor calls DestroySharedImage which in turn
// ensures that the deferred destroy request from above is flushed. Thus,
// SharedImageInterface::Flush in not needed here explicitly.
MaybePostUnusedResourcesReclaimTask();
}
scoped_refptr<CanvasResourceSharedImage> NewOrRecycledResource() {
if (IsSingleBuffered()) {
CHECK(unused_resources_.empty());
num_inflight_resources_ = max_inflight_resources_ = 1;
return CreateResource();
}
if (unused_resources_.empty()) {
scoped_refptr<CanvasResourceSharedImage> resource = CreateResource();
if (!resource) {
return nullptr;
}
RegisterUnusedResource(std::move(resource));
++num_inflight_resources_;
if (num_inflight_resources_ > max_inflight_resources_) {
max_inflight_resources_ = num_inflight_resources_;
}
}
scoped_refptr<CanvasResourceSharedImage> resource =
std::move(unused_resources_.back().resource);
unused_resources_.pop_back();
DCHECK(resource->HasOneRef());
return resource;
}
bool IsResourceUsable(CanvasResourceSharedImage* resource) {
return resource->GetClientSharedImage()->usage().HasAll(
shared_image_usage_flags_);
}
void OnMemoryDump(base::trace_event::ProcessMemoryDump* pmd) override {
if (is_software_) {
// This class creates software SharedImages only on demand and might not
// have one here - invoke the base class implementation of this method
// instead.
CanvasResourceProvider::OnMemoryDump(pmd);
return;
}
std::string path = base::StringPrintf("canvas/ResourceProvider_0x%" PRIXPTR,
reinterpret_cast<uintptr_t>(this));
resource()->OnMemoryDump(pmd, path);
std::string cached_path = path + "/cached";
for (const auto& unused_resource : unused_resources_) {
auto* resource_pointer = static_cast<CanvasResourceSharedImage*>(
unused_resource.resource.get());
resource_pointer->OnMemoryDump(pmd, cached_path);
}
}
// The maximum number of in-flight resources waiting to be used for
// recycling.
static constexpr int kMaxRecycledCanvasResources = 3;
struct UnusedResource {
UnusedResource(base::TimeTicks last_use,
scoped_refptr<CanvasResourceSharedImage> resource)
: last_use(last_use), resource(std::move(resource)) {}
base::TimeTicks last_use;
scoped_refptr<CanvasResourceSharedImage> resource;
};
// If this instance is single-buffered or |resource_recycling_enabled_| is
// false, |unused_resources_| will be empty.
WTF::Vector<UnusedResource> unused_resources_;
int num_inflight_resources_ = 0;
int max_inflight_resources_ = 0;
base::OneShotTimer unused_resources_reclaim_timer_;
bool resource_recycling_enabled_ = true;
// `raster_context_provider_` holds a reference on the shared
// `RasterContextProvider`, to keep it alive until it notifies us after the
// GPU context is lost. Without this, no `CanvasResourceProvider` would get
// notified after the shared `WebGraphicsContext3DProviderWrapper` instance is
// recreated.
scoped_refptr<viz::RasterContextProvider> raster_context_provider_;
base::WeakPtr<WebGraphicsSharedImageInterfaceProvider>
shared_image_interface_provider_;
const bool is_accelerated_;
gpu::SharedImageUsageSet shared_image_usage_flags_;
bool current_resource_has_write_access_ = false;
const bool use_oop_rasterization_;
bool is_software_ = false;
bool is_cleared_ = false;
// The resource that is currently being used by this provider.
scoped_refptr<CanvasResourceSharedImage> resource_;
scoped_refptr<StaticBitmapImage> cached_snapshot_;
PaintImage::ContentId cached_content_id_ = PaintImage::kInvalidContentId;
// Callback that notifies owners of this resource provider that the GPU
// context was lost. The call is done in a separate task, so that owners could
// delete this resource provider if needed.
base::OnceClosure notify_context_lost_in_new_task_ = base::BindPostTask(
base::SequencedTaskRunner::GetCurrentDefault(),
base::BindOnce(&NotifyGpuContextLostTask, CreateWeakPtr()));
};
// This ResourceProvider is meant to be used with an imported external
// CanvasResource, and all drawing and lifetime logic must be kept at a higher
// level.
class CanvasResourceProviderPassThrough final : public CanvasResourceProvider {
public:
CanvasResourceProviderPassThrough(
gfx::Size size,
viz::SharedImageFormat format,
SkAlphaType alpha_type,
const gfx::ColorSpace& color_space,
base::WeakPtr<WebGraphicsContext3DProviderWrapper>
context_provider_wrapper,
CanvasResourceHost* resource_host)
: CanvasResourceProvider(kPassThrough,
size,
format,
alpha_type,
color_space,
std::move(context_provider_wrapper),
resource_host) {}
~CanvasResourceProviderPassThrough() override = default;
bool IsValid() const final { return true; }
bool IsAccelerated() const final { return true; }
bool SupportsDirectCompositing() const override { return true; }
bool IsSingleBuffered() const override { return true; }
private:
void ImportResource(
scoped_refptr<ExternalCanvasResource>&& resource) override {
resource_ = resource;
}
scoped_refptr<CanvasResource> ProduceCanvasResource(FlushReason) final {
return resource_;
}
sk_sp<SkSurface> CreateSkSurface() const override { NOTREACHED(); }
scoped_refptr<StaticBitmapImage> Snapshot(FlushReason,
ImageOrientation) override {
if (IsGpuContextLost() || !resource_) {
return nullptr;
}
return resource_->Bitmap();
}
private:
scoped_refptr<ExternalCanvasResource> resource_;
};
// * Renders to back buffer of a shared image swap chain.
// * Presents swap chain and exports front buffer mailbox to compositor to
// support low latency mode.
// * Layers are overlay candidates.
class CanvasResourceProviderSwapChain final : public CanvasResourceProvider {
public:
CanvasResourceProviderSwapChain(
gfx::Size size,
viz::SharedImageFormat format,
SkAlphaType alpha_type,
const gfx::ColorSpace& color_space,
base::WeakPtr<WebGraphicsContext3DProviderWrapper>
context_provider_wrapper,
CanvasResourceHost* resource_host)
: CanvasResourceProvider(kSwapChain,
size,
format,
alpha_type,
color_space,
std::move(context_provider_wrapper),
resource_host),
use_oop_rasterization_(ContextProviderWrapper()
->ContextProvider()
.GetCapabilities()
.gpu_rasterization) {
CHECK(ContextProviderWrapper());
resource_ = CanvasResourceSwapChain::Create(
size, format, alpha_type, color_space, ContextProviderWrapper(),
CreateWeakPtr());
CHECK(resource_);
}
~CanvasResourceProviderSwapChain() override = default;
bool IsValid() const final {
if (!use_oop_rasterization_)
return GetSkSurface() && !IsGpuContextLost();
else
return !IsGpuContextLost();
}
bool IsAccelerated() const final { return true; }
bool SupportsDirectCompositing() const override { return true; }
bool IsSingleBuffered() const override { return true; }
private:
void WillDraw() override {
needs_present_ = true;
needs_flush_ = true;
}
scoped_refptr<CanvasResource> ProduceCanvasResource(
FlushReason reason) override {
TRACE_EVENT0("blink",
"CanvasResourceProviderSwapChain::ProduceCanvasResource");
if (!IsValid())
return nullptr;
FlushIfNeeded(reason);
if (needs_present_) {
resource_->PresentSwapChain();
needs_present_ = false;
}
return resource_;
}
scoped_refptr<StaticBitmapImage> Snapshot(FlushReason reason,
ImageOrientation) override {
TRACE_EVENT0("blink", "CanvasResourceProviderSwapChain::Snapshot");
if (!IsValid())
return nullptr;
FlushIfNeeded(reason);
return resource_->Bitmap();
}
sk_sp<SkSurface> CreateSkSurface() const override {
TRACE_EVENT0("blink", "CanvasResourceProviderSwapChain::CreateSkSurface");
if (IsGpuContextLost() || !resource_)
return nullptr;
GrGLTextureInfo texture_info = {};
texture_info.fID = resource_->GetBackBufferTextureId();
texture_info.fTarget =
resource_->GetBackBufferClientSharedImage()->GetTextureTarget();
texture_info.fFormat =
ContextProviderWrapper()->ContextProvider().GetGrGLTextureFormat(
GetSharedImageFormat());
auto backend_texture = GrBackendTextures::MakeGL(
Size().width(), Size().height(), skgpu::Mipmapped::kNo, texture_info);
const auto props = GetSkSurfaceProps();
return SkSurfaces::WrapBackendTexture(
GetGrContext(), backend_texture, kTopLeft_GrSurfaceOrigin,
0 /* msaa_sample_count */, GetSkImageInfo().colorType(),
GetSkImageInfo().refColorSpace(), &props);
}
void RasterRecord(cc::PaintRecord last_recording) override {
TRACE_EVENT0("blink", "CanvasResourceProviderSwapChain::RasterRecord");
if (!use_oop_rasterization_) {
CanvasResourceProvider::RasterRecord(std::move(last_recording));
return;
}
WillDraw();
RasterRecordOOP(last_recording, initial_needs_clear_,
resource_->GetBackBufferClientSharedImage()->mailbox());
initial_needs_clear_ = false;
}
bool UseOopRasterization() final { return use_oop_rasterization_; }
bool WritePixels(const SkImageInfo& orig_info,
const void* pixels,
size_t row_bytes,
int x,
int y) override {
if (!use_oop_rasterization_) {
return CanvasResourceProvider::WritePixels(orig_info, pixels, row_bytes,
x, y);
}
TRACE_EVENT0("blink", "CanvasResourceProviderSwapChain::WritePixels");
if (IsGpuContextLost())
return false;
WillDraw();
RasterInterface()->WritePixels(
resource_->GetBackBufferClientSharedImage()->mailbox(), x, y,
resource_->GetBackBufferClientSharedImage()->GetTextureTarget(),
SkPixmap(orig_info, pixels, row_bytes));
return true;
}
void FlushIfNeeded(FlushReason reason) {
if (needs_flush_) {
// This only flushes recorded draw ops.
FlushCanvas(reason);
// Call flushAndSubmit() explicitly so that any non-draw-op rendering by
// Skia is flushed to GL. This is needed specifically for WritePixels().
if (!use_oop_rasterization_)
GetGrContext()->flushAndSubmit();
needs_flush_ = false;
}
}
bool needs_present_ = false;
bool needs_flush_ = false;
const bool use_oop_rasterization_;
// This only matters for the initial backbuffer mailbox, since the frontbuffer
// will always have the back texture copied to it prior to any new commands.
bool initial_needs_clear_ = true;
scoped_refptr<CanvasResourceSwapChain> resource_;
};
std::unique_ptr<CanvasResourceProvider>
CanvasResourceProvider::CreateBitmapProvider(
gfx::Size size,
viz::SharedImageFormat format,
SkAlphaType alpha_type,
const gfx::ColorSpace& color_space,
ShouldInitialize should_initialize,
CanvasResourceHost* resource_host) {
auto provider = std::make_unique<CanvasResourceProviderBitmap>(
size, format, alpha_type, color_space, resource_host);
if (provider->IsValid()) {
if (should_initialize ==
CanvasResourceProvider::ShouldInitialize::kCallClear)
provider->Clear();
return provider;
}
return nullptr;
}
std::unique_ptr<CanvasResourceProvider>
CanvasResourceProvider::CreateSharedImageProviderForSoftwareCompositor(
gfx::Size size,
viz::SharedImageFormat format,
SkAlphaType alpha_type,
const gfx::ColorSpace& color_space,
ShouldInitialize should_initialize,
WebGraphicsSharedImageInterfaceProvider* shared_image_interface_provider,
CanvasResourceHost* resource_host) {
// CanvasResourceProviderSoftwareSharedImage works only with the software
// compositor.
if (SharedGpuContext::IsGpuCompositingEnabled()) {
return nullptr;
}
CHECK(format == viz::SharedImageFormat::N32Format() ||
format == viz::SinglePlaneFormat::kRGBA_F16);
auto provider = std::make_unique<CanvasResourceProviderSharedImage>(
size, format, alpha_type, color_space, shared_image_interface_provider,
resource_host);
if (provider->IsValid()) {
if (should_initialize ==
CanvasResourceProvider::ShouldInitialize::kCallClear)
provider->Clear();
return provider;
}
return nullptr;
}
std::unique_ptr<CanvasResourceProvider>
CanvasResourceProvider::CreateSharedImageProvider(
gfx::Size size,
viz::SharedImageFormat format,
SkAlphaType alpha_type,
const gfx::ColorSpace& color_space,
ShouldInitialize should_initialize,
base::WeakPtr<WebGraphicsContext3DProviderWrapper> context_provider_wrapper,
RasterMode raster_mode,
gpu::SharedImageUsageSet shared_image_usage_flags,
CanvasResourceHost* resource_host) {
// IsGpuCompositingEnabled can re-create the context if it has been lost, do
// this up front so that we can fail early and not expose ourselves to
// use after free bugs (crbug.com/1126424)
const bool is_gpu_compositing_enabled =
SharedGpuContext::IsGpuCompositingEnabled();
// If the context is lost we don't want to re-create it here, the resulting
// resource provider would be invalid anyway
if (!context_provider_wrapper ||
context_provider_wrapper->ContextProvider().IsContextLost()) {
return nullptr;
}
const auto& capabilities =
context_provider_wrapper->ContextProvider().GetCapabilities();
if ((size.width() < 1 || size.height() < 1 ||
size.width() > capabilities.max_texture_size ||
size.height() > capabilities.max_texture_size)) {
return nullptr;
}
const bool is_accelerated = raster_mode == RasterMode::kGPU;
// TODO(https://crbug.com/1210946): Pass in info as is for all cases.
// Overriding the info to use RGBA instead of N32 is needed because code
// elsewhere assumes RGBA. OTOH the software path seems to be assuming N32
// somewhere in the later pipeline but for offscreen canvas only.
if (!shared_image_usage_flags.HasAny(gpu::SHARED_IMAGE_USAGE_WEBGPU_READ |
gpu::SHARED_IMAGE_USAGE_WEBGPU_WRITE)) {
if (is_accelerated && format != viz::SinglePlaneFormat::kRGBA_F16) {
format = viz::SinglePlaneFormat::kRGBA_8888;
}
}
// TODO(crbug.com/404887530) : Remove or Rename IsGMBAllowed() since
// CanvasResourceProvider no longer uses GMBs.
const bool is_gpu_memory_buffer_image_allowed =
is_gpu_compositing_enabled && IsGMBAllowed(size, format, capabilities);
if (raster_mode == RasterMode::kCPU && !is_gpu_memory_buffer_image_allowed)
return nullptr;
// If we cannot use overlay, we have to remove the scanout flag and the
// concurrent read write flag.
const auto& shared_image_caps = context_provider_wrapper->ContextProvider()
.SharedImageInterface()
->GetCapabilities();
if (!is_gpu_memory_buffer_image_allowed ||
(is_accelerated && !shared_image_caps.supports_scanout_shared_images)) {
shared_image_usage_flags.RemoveAll(
gpu::SHARED_IMAGE_USAGE_CONCURRENT_READ_WRITE |
gpu::SHARED_IMAGE_USAGE_SCANOUT);
}
if (resource_host && resource_host->TransferToGPUTextureWasInvoked()) {
shared_image_usage_flags.PutAll(gpu::SHARED_IMAGE_USAGE_WEBGPU_READ |
gpu::SHARED_IMAGE_USAGE_WEBGPU_WRITE);
}
#if BUILDFLAG(IS_MAC)
if (shared_image_usage_flags.Has(gpu::SHARED_IMAGE_USAGE_SCANOUT) &&
is_accelerated && format == viz::SinglePlaneFormat::kRGBA_8888) {
// GPU-accelerated scannout usage on Mac uses IOSurface. Must switch from
// RGBA_8888 to BGRA_8888 in that case.
format = viz::SinglePlaneFormat::kBGRA_8888;
}
#endif
auto provider = std::make_unique<CanvasResourceProviderSharedImage>(
size, format, alpha_type, color_space, context_provider_wrapper,
is_accelerated, shared_image_usage_flags, resource_host);
if (provider->IsValid()) {
if (should_initialize ==
CanvasResourceProvider::ShouldInitialize::kCallClear)
provider->Clear();
return provider;
}
return nullptr;
}
std::unique_ptr<CanvasResourceProvider>
CanvasResourceProvider::CreateWebGPUImageProvider(
gfx::Size size,
viz::SharedImageFormat format,
SkAlphaType alpha_type,
const gfx::ColorSpace& color_space,
gpu::SharedImageUsageSet shared_image_usage_flags,
CanvasResourceHost* resource_host) {
auto context_provider_wrapper = SharedGpuContext::ContextProviderWrapper();
// The SharedImages created by this provider serve as a means of import/export
// between VideoFrames/canvas and WebGPU, e.g.:
// * Import from VideoFrames into WebGPU via CreateExternalTexture() (the
// WebGPU textures will then be read by clients)
// * Export from WebGPU into canvas via
// GpuCanvasContext::CopyTextureToResourceProvider() (the export happens via
// the WebGPU interface)
// Hence, both WEBGPU_READ and WEBGPU_WRITE usage are needed here.
return CreateSharedImageProvider(
size, format, alpha_type, color_space,
CanvasResourceProvider::ShouldInitialize::kNo,
std::move(context_provider_wrapper), RasterMode::kGPU,
shared_image_usage_flags | gpu::SHARED_IMAGE_USAGE_WEBGPU_READ |
gpu::SHARED_IMAGE_USAGE_WEBGPU_WRITE,
resource_host);
}
std::unique_ptr<CanvasResourceProvider>
CanvasResourceProvider::CreatePassThroughProvider(
gfx::Size size,
viz::SharedImageFormat format,
SkAlphaType alpha_type,
const gfx::ColorSpace& color_space,
base::WeakPtr<WebGraphicsContext3DProviderWrapper> context_provider_wrapper,
CanvasResourceHost* resource_host) {
// SharedGpuContext::IsGpuCompositingEnabled can potentially replace the
// context_provider_wrapper, so it's important to call that first as it can
// invalidate the weak pointer.
if (!SharedGpuContext::IsGpuCompositingEnabled() || !context_provider_wrapper)
return nullptr;
const auto& capabilities =
context_provider_wrapper->ContextProvider().GetCapabilities();
if (size.width() > capabilities.max_texture_size ||
size.height() > capabilities.max_texture_size) {
return nullptr;
}
const auto& shared_image_capabilities =
context_provider_wrapper->ContextProvider()
.SharedImageInterface()
->GetCapabilities();
// Either swap_chain or gpu memory buffer should be enabled for this be used.
// TODO(crbug.com/404887530) : Remove or Rename IsGMBAllowed() since
// CanvasResourceProvider no longer uses GMBs.
if (!shared_image_capabilities.shared_image_swap_chain &&
!IsGMBAllowed(size, format, capabilities)) {
return nullptr;
}
// Note: Unlike other CanvasResourceProvider subclasses, a
// CanvasResourceProviderPassThrough instance is always valid and does not
// require clearing as part of initialization (both of these being due to the
// fact that it simply delegates the internal parts of the resource to other
// classes).
auto provider = std::make_unique<CanvasResourceProviderPassThrough>(
size, format, alpha_type, color_space, context_provider_wrapper,
resource_host);
CHECK(provider->IsValid());
return provider;
}
std::unique_ptr<CanvasResourceProvider>
CanvasResourceProvider::CreateSwapChainProvider(
gfx::Size size,
viz::SharedImageFormat format,
SkAlphaType alpha_type,
const gfx::ColorSpace& color_space,
ShouldInitialize should_initialize,
base::WeakPtr<WebGraphicsContext3DProviderWrapper> context_provider_wrapper,
CanvasResourceHost* resource_host) {
// SharedGpuContext::IsGpuCompositingEnabled can potentially replace the
// context_provider_wrapper, so it's important to call that first as it can
// invalidate the weak pointer.
if (!SharedGpuContext::IsGpuCompositingEnabled() || !context_provider_wrapper)
return nullptr;
const auto& capabilities =
context_provider_wrapper->ContextProvider().GetCapabilities();
const auto& shared_image_capabilities =
context_provider_wrapper->ContextProvider()
.SharedImageInterface()
->GetCapabilities();
if (size.width() > capabilities.max_texture_size ||
size.height() > capabilities.max_texture_size ||
!shared_image_capabilities.shared_image_swap_chain) {
return nullptr;
}
auto provider = std::make_unique<CanvasResourceProviderSwapChain>(
size, format, alpha_type, color_space, context_provider_wrapper,
resource_host);
if (provider->IsValid()) {
if (should_initialize ==
CanvasResourceProvider::ShouldInitialize::kCallClear)
provider->Clear();
return provider;
}
return nullptr;
}
CanvasResourceProvider::CanvasImageProvider::CanvasImageProvider(
cc::ImageDecodeCache* cache_n32,
cc::ImageDecodeCache* cache_f16,
const gfx::ColorSpace& target_color_space,
viz::SharedImageFormat canvas_format,
cc::PlaybackImageProvider::RasterMode raster_mode)
: raster_mode_(raster_mode) {
std::optional<cc::PlaybackImageProvider::Settings> settings =
cc::PlaybackImageProvider::Settings();
settings->raster_mode = raster_mode_;
cc::TargetColorParams target_color_params;
target_color_params.color_space = target_color_space;
playback_image_provider_n32_.emplace(cache_n32, target_color_params,
std::move(settings));
// If the image provider may require to decode to half float instead of
// uint8, create a f16 PlaybackImageProvider with the passed cache.
if (canvas_format == viz::SinglePlaneFormat::kRGBA_F16) {
DCHECK(cache_f16);
settings = cc::PlaybackImageProvider::Settings();
settings->raster_mode = raster_mode_;
playback_image_provider_f16_.emplace(cache_f16, target_color_params,
std::move(settings));
}
}
cc::ImageProvider::ScopedResult
CanvasResourceProvider::CanvasImageProvider::GetRasterContent(
const cc::DrawImage& draw_image) {
cc::PaintImage paint_image = draw_image.paint_image();
if (paint_image.IsDeferredPaintRecord()) {
CHECK(!paint_image.IsPaintWorklet());
scoped_refptr<CanvasDeferredPaintRecord> canvas_deferred_paint_record(
static_cast<CanvasDeferredPaintRecord*>(
paint_image.deferred_paint_record().get()));
return cc::ImageProvider::ScopedResult(
canvas_deferred_paint_record->GetPaintRecord());
}
// TODO(xidachen): Ensure this function works for paint worklet generated
// images.
// If we like to decode high bit depth image source to half float backed
// image, we need to sniff the image bit depth here to avoid double decoding.
ImageProvider::ScopedResult scoped_decoded_image;
if (playback_image_provider_f16_ &&
draw_image.paint_image().is_high_bit_depth()) {
DCHECK(playback_image_provider_f16_);
scoped_decoded_image =
playback_image_provider_f16_->GetRasterContent(draw_image);
} else {
scoped_decoded_image =
playback_image_provider_n32_->GetRasterContent(draw_image);
}
// Holding onto locked images here is a performance optimization for the
// gpu image decode cache. For that cache, it is expensive to lock and
// unlock gpu discardable, and so it is worth it to hold the lock on
// these images across multiple potential decodes. In the software case,
// locking in this manner makes it easy to run out of discardable memory
// (backed by shared memory sometimes) because each per-colorspace image
// decode cache has its own limit. In the software case, just unlock
// immediately and let the discardable system manage the cache logic
// behind the scenes.
if (!scoped_decoded_image.needs_unlock() || !IsHardwareDecodeCache()) {
return scoped_decoded_image;
}
constexpr int kMaxLockedImagesCount = 500;
if (!scoped_decoded_image.decoded_image().is_budgeted() ||
locked_images_.size() > kMaxLockedImagesCount) {
// If we have exceeded the budget, ReleaseLockedImages any locked decodes.
ReleaseLockedImages();
}
auto decoded_draw_image = scoped_decoded_image.decoded_image();
return ScopedResult(decoded_draw_image,
base::BindOnce(&CanvasImageProvider::CanUnlockImage,
weak_factory_.GetWeakPtr(),
std::move(scoped_decoded_image)));
}
void CanvasResourceProvider::CanvasImageProvider::CanUnlockImage(
ScopedResult image) {
// We should early out and avoid calling this function for software decodes.
DCHECK(IsHardwareDecodeCache());
// Because these image decodes are being done in javascript calling into
// canvas code, there's no obvious time to do the cleanup. To handle this,
// post a cleanup task to run after javascript is done running.
if (!cleanup_task_pending_) {
cleanup_task_pending_ = true;
ThreadScheduler::Current()->CleanupTaskRunner()->PostTask(
FROM_HERE, base::BindOnce(&CanvasImageProvider::CleanupLockedImages,
weak_factory_.GetWeakPtr()));
}
locked_images_.push_back(std::move(image));
}
void CanvasResourceProvider::CanvasImageProvider::CleanupLockedImages() {
cleanup_task_pending_ = false;
ReleaseLockedImages();
}
bool CanvasResourceProvider::CanvasImageProvider::IsHardwareDecodeCache()
const {
return raster_mode_ != cc::PlaybackImageProvider::RasterMode::kSoftware;
}
BASE_FEATURE(kCanvas2DAutoFlushParams,
"Canvas2DAutoFlushParams",
base::FEATURE_DISABLED_BY_DEFAULT);
// When enabled, unused resources (ready to be recycled) are reclaimed after a
// delay.
BASE_FEATURE(kCanvas2DReclaimUnusedResources,
"Canvas2DReclaimUnusedResources",
base::FEATURE_DISABLED_BY_DEFAULT);
// The following parameters attempt to reach a compromise between not flushing
// too often, and not accumulating an unreasonable backlog. Flushing too
// often will hurt performance due to overhead costs. Accumulating large
// backlogs, in the case of OOPR-Canvas, results in poor parellelism and
// janky UI. With OOPR-Canvas disabled, it is still desirable to flush
// periodically to guard against run-away memory consumption caused by
// PaintOpBuffers that grow indefinitely. The OOPR-related jank is caused by
// long-running RasterCHROMIUM calls that monopolize the main thread
// of the GPU process. By flushing periodically, we allow the rasterization
// of canvas contents to be interleaved with other compositing and UI work.
//
// The default values for these parameters were initially determined
// empirically. They were selected to maximize the MotionMark score on
// desktop computers. Field trials may be used to tune these parameters
// further by using metrics data from the field.
const base::FeatureParam<int> kMaxRecordedOpKB(&kCanvas2DAutoFlushParams,
"max_recorded_op_kb",
2 * 1024);
const base::FeatureParam<int> kMaxPinnedImageKB(&kCanvas2DAutoFlushParams,
"max_pinned_image_kb",
32 * 1024);
// Graphite can generally handle more ops, increase the size accordingly.
const base::FeatureParam<int> kMaxRecordedOpGraphiteKB(
&kCanvas2DAutoFlushParams,
"max_recorded_op_graphite_kb",
6 * 1024);
CanvasResourceProvider::CanvasResourceProvider(
const ResourceProviderType& type,
gfx::Size size,
viz::SharedImageFormat format,
SkAlphaType alpha_type,
const gfx::ColorSpace& color_space,
base::WeakPtr<WebGraphicsContext3DProviderWrapper> context_provider_wrapper,
CanvasResourceHost* resource_host)
: type_(type),
context_provider_wrapper_(std::move(context_provider_wrapper)),
info_(SkImageInfo::Make(size.width(),
size.height(),
viz::ToClosestSkColorType(format),
alpha_type,
color_space.ToSkColorSpace())),
size_(size),
format_(format),
alpha_type_(alpha_type),
color_space_(color_space),
resource_host_(resource_host),
recorder_(std::make_unique<MemoryManagedPaintRecorder>(Size(), this)),
snapshot_paint_image_id_(cc::PaintImage::GetNextId()) {
max_recorded_op_bytes_ = static_cast<size_t>(kMaxRecordedOpKB.Get()) * 1024;
max_pinned_image_bytes_ = static_cast<size_t>(kMaxPinnedImageKB.Get()) * 1024;
if (context_provider_wrapper_) {
context_provider_wrapper_->AddObserver(this);
const auto& caps =
context_provider_wrapper_->ContextProvider().GetCapabilities();
oopr_uses_dmsaa_ = !caps.msaa_is_slow && !caps.avoid_stencil_buffers;
// Graphite can handle a large buffer size.
if (context_provider_wrapper_->ContextProvider()
.GetGpuFeatureInfo()
.status_values[gpu::GPU_FEATURE_TYPE_SKIA_GRAPHITE] ==
gpu::kGpuFeatureStatusEnabled) {
max_recorded_op_bytes_ =
static_cast<size_t>(kMaxRecordedOpGraphiteKB.Get()) * 1024;
recorder_->DisableLineDrawingAsPaths();
}
}
CanvasMemoryDumpProvider::Instance()->RegisterClient(this);
}
CanvasResourceProvider::~CanvasResourceProvider() {
if (context_provider_wrapper_)
context_provider_wrapper_->RemoveObserver(this);
CanvasMemoryDumpProvider::Instance()->UnregisterClient(this);
// Last chance for outstanding GPU timers to record metrics.
if (RasterInterface()) {
CheckGpuTimers(RasterInterface());
}
}
std::unique_ptr<MemoryManagedPaintRecorder>
CanvasResourceProvider::ReleaseRecorder() {
// When releasing the recorder, we swap it with a new, valid one. This way,
// the `recorder_` member is guarantied to be always valid.
auto recorder = std::make_unique<MemoryManagedPaintRecorder>(Size(), this);
recorder_->SetClient(nullptr);
recorder_.swap(recorder);
DisableLineDrawingAsPathsIfNecessary();
return recorder;
}
void CanvasResourceProvider::SetRecorder(
std::unique_ptr<MemoryManagedPaintRecorder> recorder) {
recorder->SetClient(this);
recorder_ = std::move(recorder);
DisableLineDrawingAsPathsIfNecessary();
}
void CanvasResourceProvider::FlushIfRecordingLimitExceeded() {
// When printing we avoid flushing if it is still possible to print in
// vector mode.
if (IsPrinting() && clear_frame_) {
return;
}
if (recorder_->ReleasableOpBytesUsed() > max_recorded_op_bytes_ ||
recorder_->ReleasableImageBytesUsed() > max_pinned_image_bytes_)
[[unlikely]] {
FlushCanvas(FlushReason::kRecordingLimitExceeded);
}
}
SkSurface* CanvasResourceProvider::GetSkSurface() const {
if (!surface_)
surface_ = CreateSkSurface();
return surface_.get();
}
void CanvasResourceProvider::NotifyWillTransfer(
cc::PaintImage::ContentId content_id) {
// This is called when an ImageBitmap is about to be transferred. All
// references to such a bitmap on the current thread must be released, which
// means that DisplayItemLists that reference it must be flushed.
GetFlushForImageListener()->NotifyFlushForImage(content_id);
}
void CanvasResourceProvider::EnsureSkiaCanvas() {
WillDraw();
if (skia_canvas_)
return;
cc::SkiaPaintCanvas::ContextFlushes context_flushes;
if (IsAccelerated() && ContextProviderWrapper() &&
!ContextProviderWrapper()
->ContextProvider()
.GetGpuFeatureInfo()
.IsWorkaroundEnabled(gpu::DISABLE_2D_CANVAS_AUTO_FLUSH)) {
context_flushes.enable = true;
context_flushes.max_draws_before_flush = kMaxDrawsBeforeContextFlush;
}
skia_canvas_ = std::make_unique<cc::SkiaPaintCanvas>(
GetSkSurface()->getCanvas(), GetOrCreateCanvasImageProvider(),
context_flushes);
}
CanvasResourceProvider::CanvasImageProvider*
CanvasResourceProvider::GetOrCreateCanvasImageProvider() {
if (!canvas_image_provider_) {
// Create an ImageDecodeCache for half float images only if the canvas is
// using half float back storage.
cc::ImageDecodeCache* cache_f16 = nullptr;
if (GetSharedImageFormat() == viz::SinglePlaneFormat::kRGBA_F16) {
cache_f16 = ImageDecodeCacheF16();
}
auto raster_mode = cc::PlaybackImageProvider::RasterMode::kSoftware;
if (UseHardwareDecodeCache()) {
raster_mode = UseOopRasterization()
? cc::PlaybackImageProvider::RasterMode::kOop
: cc::PlaybackImageProvider::RasterMode::kGpu;
}
canvas_image_provider_ = std::make_unique<CanvasImageProvider>(
ImageDecodeCacheRGBA8(), cache_f16, GetColorSpace(),
GetSharedImageFormat(), raster_mode);
}
return canvas_image_provider_.get();
}
void CanvasResourceProvider::InitializeForRecording(
cc::PaintCanvas* canvas) const {
if (resource_host_) {
resource_host_->InitializeForRecording(canvas);
}
}
void CanvasResourceProvider::RecordingCleared() {
// Since the recording has been cleared, it contains no draw commands and it
// is now safe to update `mode_` to discard the old copy of canvas content.
mode_ = SkSurface::kDiscard_ContentChangeMode;
clear_frame_ = true;
last_flush_reason_ = FlushReason::kNone;
printing_fallback_reason_ = FlushReason::kNone;
}
MemoryManagedPaintCanvas& CanvasResourceProvider::Canvas(bool needs_will_draw) {
// TODO(https://crbug.com/1211912): Video frames don't work without
// WillDrawIfNeeded(), but we are getting memory leak on CreatePattern
// with it. There should be a better way to solve this.
if (needs_will_draw)
WillDrawIfNeeded();
return recorder_->getRecordingCanvas();
}
void CanvasResourceProvider::OnContextDestroyed() {
if (skia_canvas_)
skia_canvas_->reset_image_provider();
canvas_image_provider_.reset();
}
void CanvasResourceProvider::OnFlushForImage(PaintImage::ContentId content_id) {
if (Canvas().IsCachingImage(content_id)) {
FlushCanvas(FlushReason::kSourceImageWillChange);
}
}
void CanvasResourceProvider::ReleaseLockedImages() {
if (canvas_image_provider_)
canvas_image_provider_->ReleaseLockedImages();
}
scoped_refptr<StaticBitmapImage> CanvasResourceProvider::SnapshotInternal(
ImageOrientation orientation,
FlushReason reason) {
if (!IsValid())
return nullptr;
auto paint_image = MakeImageSnapshot(reason);
DCHECK(!paint_image.IsTextureBacked());
return UnacceleratedStaticBitmapImage::Create(std::move(paint_image),
orientation);
}
cc::PaintImage CanvasResourceProvider::MakeImageSnapshot(FlushReason reason) {
FlushCanvas(reason);
auto sk_image = GetSkSurface()->makeImageSnapshot();
if (!sk_image)
return cc::PaintImage();
auto last_snapshot_sk_image_id = snapshot_sk_image_id_;
snapshot_sk_image_id_ = sk_image->uniqueID();
// Ensure that a new PaintImage::ContentId is used only when the underlying
// SkImage changes. This is necessary to ensure that the same image results
// in a cache hit in cc's ImageDecodeCache.
if (snapshot_paint_image_content_id_ == PaintImage::kInvalidContentId ||
last_snapshot_sk_image_id != snapshot_sk_image_id_) {
snapshot_paint_image_content_id_ = PaintImage::GetNextContentId();
}
return PaintImageBuilder::WithDefault()
.set_id(snapshot_paint_image_id_)
.set_image(std::move(sk_image), snapshot_paint_image_content_id_)
.TakePaintImage();
}
gpu::gles2::GLES2Interface* CanvasResourceProvider::ContextGL() const {
if (!context_provider_wrapper_)
return nullptr;
return context_provider_wrapper_->ContextProvider().ContextGL();
}
gpu::raster::RasterInterface* CanvasResourceProvider::RasterInterface() const {
if (!context_provider_wrapper_)
return nullptr;
return context_provider_wrapper_->ContextProvider().RasterInterface();
}
GrDirectContext* CanvasResourceProvider::GetGrContext() const {
if (!context_provider_wrapper_)
return nullptr;
return context_provider_wrapper_->ContextProvider().GetGrContext();
}
SkSurfaceProps CanvasResourceProvider::GetSkSurfaceProps() const {
const bool can_use_lcd_text = GetAlphaType() == kOpaque_SkAlphaType;
return skia::LegacyDisplayGlobals::ComputeSurfaceProps(can_use_lcd_text);
}
std::optional<cc::PaintRecord> CanvasResourceProvider::FlushCanvas(
FlushReason reason) {
if (!recorder_->HasReleasableDrawOps()) {
return std::nullopt;
}
ScopedRasterTimer timer(IsAccelerated() ? RasterInterface() : nullptr, *this,
always_enable_raster_timers_for_testing_);
DCHECK(reason != FlushReason::kNone);
bool want_to_print = (IsPrinting() && reason != FlushReason::kClear) ||
reason == FlushReason::kPrinting ||
reason == FlushReason::kCanvasPushFrameWhilePrinting;
bool preserve_recording = want_to_print && clear_frame_;
// If a previous flush rasterized some paint ops, we lost part of the
// recording and must fallback to raster printing instead of vectorial
// printing. Record the reason why this happened.
if (want_to_print && !clear_frame_) {
printing_fallback_reason_ = last_flush_reason_;
}
last_flush_reason_ = reason;
clear_frame_ = false;
if (reason == FlushReason::kClear) {
clear_frame_ = true;
printing_fallback_reason_ = FlushReason::kNone;
}
cc::PaintRecord recording;
recording = recorder_->ReleaseMainRecording();
RasterRecord(recording);
// Images are locked for the duration of the rasterization, in case they get
// used multiple times. We can unlock them once the rasterization is complete.
ReleaseLockedImages();
last_recording_ =
preserve_recording ? std::optional(recording) : std::nullopt;
return recording;
}
void CanvasResourceProvider::RasterRecord(cc::PaintRecord last_recording) {
EnsureSkiaCanvas();
skia_canvas_->drawPicture(std::move(last_recording));
skgpu::ganesh::FlushAndSubmit(GetSkSurface());
}
void CanvasResourceProvider::RasterRecordOOP(cc::PaintRecord last_recording,
bool needs_clear,
gpu::Mailbox mailbox) {
if (IsGpuContextLost())
return;
gpu::raster::RasterInterface* ri = RasterInterface();
SkColor4f background_color = GetAlphaType() == kOpaque_SkAlphaType
? SkColors::kBlack
: SkColors::kTransparent;
auto list = base::MakeRefCounted<cc::DisplayItemList>();
list->StartPaint();
list->push<cc::DrawRecordOp>(std::move(last_recording));
list->EndPaintOfUnpaired(gfx::Rect(Size().width(), Size().height()));
list->Finalize();
gfx::Size size(Size().width(), Size().height());
size_t max_op_size_hint = gpu::raster::RasterInterface::kDefaultMaxOpSizeHint;
gfx::Rect full_raster_rect(Size().width(), Size().height());
gfx::Rect playback_rect(Size().width(), Size().height());
gfx::Vector2dF post_translate(0.f, 0.f);
gfx::Vector2dF post_scale(1.f, 1.f);
const bool can_use_lcd_text = GetAlphaType() == kOpaque_SkAlphaType;
ri->BeginRasterCHROMIUM(background_color, needs_clear,
/*msaa_sample_count=*/oopr_uses_dmsaa_ ? 1 : 0,
oopr_uses_dmsaa_ ? gpu::raster::MsaaMode::kDMSAA
: gpu::raster::MsaaMode::kNoMSAA,
can_use_lcd_text, /*visible=*/true, GetColorSpace(),
/*hdr_headroom=*/1.f, mailbox.name);
ri->RasterCHROMIUM(
list.get(), GetOrCreateCanvasImageProvider(), size, full_raster_rect,
playback_rect, post_translate, post_scale, /*requires_clear=*/false,
/*raster_inducing_scroll_offsets=*/nullptr, &max_op_size_hint);
ri->EndRasterCHROMIUM();
}
bool CanvasResourceProvider::IsGpuContextLost() const {
auto* raster_interface = RasterInterface();
return !raster_interface ||
raster_interface->GetGraphicsResetStatusKHR() != GL_NO_ERROR;
}
bool CanvasResourceProvider::IsSoftwareSharedImageGpuChannelLost() const {
return false;
}
void CanvasResourceProvider::NotifyGpuContextLostTask(
base::WeakPtr<CanvasResourceProvider> provider) {
if (provider && provider->resource_host()) {
// Move `provider` as hint that it shouldn't be reused after this point.
// The `resource_host` owns the provider and can delete it in
// `NotifyGpuContextLost()`.
std::move(provider)->resource_host()->NotifyGpuContextLost();
}
}
bool CanvasResourceProvider::WritePixels(const SkImageInfo& orig_info,
const void* pixels,
size_t row_bytes,
int x,
int y) {
TRACE_EVENT0("blink", "CanvasResourceProvider::WritePixels");
DCHECK(IsValid());
DCHECK(!recorder_->HasRecordedDrawOps());
EnsureSkiaCanvas();
bool wrote_pixels = GetSkSurface()->getCanvas()->writePixels(
orig_info, pixels, row_bytes, x, y);
if (wrote_pixels) {
// WritePixels content is not saved in recording. Calling WritePixels
// therefore invalidates `last_recording_` because it's now missing that
// information.
last_recording_ = std::nullopt;
}
return wrote_pixels;
}
void CanvasResourceProvider::Clear() {
// Clear the background transparent or opaque, as required. This should only
// be called when a new resource provider is created to ensure that we're
// not leaking data or displaying bad pixels (in the case of kOpaque
// canvases). Instead of adding these commands to our deferred queue, we'll
// send them directly through to Skia so that they're not replayed for
// printing operations. See crbug.com/1003114
DCHECK(IsValid());
if (info_.alphaType() == kOpaque_SkAlphaType)
Canvas().clear(SkColors::kBlack);
else
Canvas().clear(SkColors::kTransparent);
FlushCanvas(FlushReason::kClear);
}
uint32_t CanvasResourceProvider::ContentUniqueID() const {
return GetSkSurface()->generationID();
}
cc::ImageDecodeCache* CanvasResourceProvider::ImageDecodeCacheRGBA8() {
if (UseHardwareDecodeCache()) {
return context_provider_wrapper_->ContextProvider().ImageDecodeCache(
kN32_SkColorType);
}
return &Image::SharedCCDecodeCache(kN32_SkColorType);
}
cc::ImageDecodeCache* CanvasResourceProvider::ImageDecodeCacheF16() {
if (UseHardwareDecodeCache()) {
return context_provider_wrapper_->ContextProvider().ImageDecodeCache(
kRGBA_F16_SkColorType);
}
return &Image::SharedCCDecodeCache(kRGBA_F16_SkColorType);
}
void CanvasResourceProvider::RestoreBackBuffer(const cc::PaintImage& image) {
DCHECK_EQ(image.height(), Size().height());
DCHECK_EQ(image.width(), Size().width());
auto sk_image = image.GetSwSkImage();
DCHECK(sk_image);
SkPixmap map;
// We know this SkImage is software backed because it's guaranteed by
// PaintImage::GetSwSkImage above
sk_image->peekPixels(&map);
WritePixels(map.info(), map.addr(), map.rowBytes(), /*x=*/0, /*y=*/0);
}
void CanvasResourceProvider::TearDownSkSurface() {
skia_canvas_ = nullptr;
surface_ = nullptr;
}
size_t CanvasResourceProvider::ComputeSurfaceSize() const {
if (!surface_)
return 0;
SkImageInfo info = surface_->imageInfo();
return info.computeByteSize(info.minRowBytes());
}
void CanvasResourceProvider::OnMemoryDump(
base::trace_event::ProcessMemoryDump* pmd) {
if (!surface_)
return;
std::string dump_name =
base::StringPrintf("canvas/ResourceProvider/SkSurface/0x%" PRIXPTR,
reinterpret_cast<uintptr_t>(surface_.get()));
auto* dump = pmd->CreateAllocatorDump(dump_name);
dump->AddScalar(base::trace_event::MemoryAllocatorDump::kNameSize,
base::trace_event::MemoryAllocatorDump::kUnitsBytes,
ComputeSurfaceSize());
dump->AddScalar(base::trace_event::MemoryAllocatorDump::kNameObjectCount,
base::trace_event::MemoryAllocatorDump::kUnitsObjects, 1);
// SkiaMemoryDumpProvider reports only sk_glyph_cache and sk_resource_cache.
// So the SkSurface is suballocation of malloc, not SkiaDumpProvider.
if (const char* system_allocator_name =
base::trace_event::MemoryDumpManager::GetInstance()
->system_allocator_pool_name()) {
pmd->AddSuballocation(dump->guid(), system_allocator_name);
}
}
size_t CanvasResourceProvider::GetSize() const {
return ComputeSurfaceSize();
}
void CanvasResourceProvider::DisableLineDrawingAsPathsIfNecessary() {
if (context_provider_wrapper_ &&
context_provider_wrapper_->ContextProvider()
.GetGpuFeatureInfo()
.status_values[gpu::GPU_FEATURE_TYPE_SKIA_GRAPHITE] ==
gpu::kGpuFeatureStatusEnabled) {
recorder_->DisableLineDrawingAsPaths();
}
}
} // namespace blink
|