RFR: 8297923: java.awt.ScrollPane broken after multiple scroll up/down

Alexey Ivanov aivanov at openjdk.org
Tue Jun 6 16:16:06 UTC 2023


**Problem description**

If you grab the thumb of the scroll bar of `ScrollPane` and drag it slowly and continuously up and down, you'll notice the UI stops rendering correctly: the child component of the scroll pane will render on the left of the frame itself, the inside of the scroll pane will be filled with the background color of its child component.

**Root cause**

AWT calls the [`::SetScrollInfo`](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-setscrollinfo) function on EDT when AWT processes scroll bar tracking events. This Windows API is not thread-safe, calling this function on an incorrect thread leads to leaking GDI objects.

When the process reaches the limit on the number of GDI objects, it cannot create new GDI objects, which results in rendering issues.

**Fix**

To resolve the problem, I modified the code so that `::SetScrollInfo` and [`::GetScrollInfo`](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-getscrollinfo) are always called on the toolkit thread, all AWT components are created on the toolkit thread.

An automatic test is provided. The test scrolls the vertical scroll bar up and down. Then the test takes a screenshot. When the bug is reproduced, the robot cannot create new GDI objects to capture the screenshot and it throws `OutOfMemoryError`.

-------------

Commit messages:
 - 8297923: Automatic test for leaked GDI objects in ScrollPane
 - 8297923: Invoke SetScrollInfo and GetScrollInfo on toolkit thread

Changes: https://git.openjdk.org/jdk/pull/14338/files
 Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=14338&range=00
  Issue: https://bugs.openjdk.org/browse/JDK-8297923
  Stats: 193 lines in 2 files changed: 189 ins; 0 del; 4 mod
  Patch: https://git.openjdk.org/jdk/pull/14338.diff
  Fetch: git fetch https://git.openjdk.org/jdk.git pull/14338/head:pull/14338

PR: https://git.openjdk.org/jdk/pull/14338



More information about the client-libs-dev mailing list