Effort/Make VCL Thread-Transparent
Type: Effort State: 85% Owner: Kay Ramme
VCL (Visual Components Library) provides the OOo base widget set and windowing abstraction. It manages the event loop and dispatches the events. It also owns the display connection and manages various resources, e.g. fonts.
The goal of this effort is, to make VCL thread-transparent.
Contents
Problem
VCL hampers Thread-Transparency
VCL hampers thread-transparency in the following ways:
- On Win32:
- VCL is thread-affine under Windows - basically letting shine through the Win32 thread-affinity regarding window messages, window construction and window destruction.
- VCL provides access to the main-thread, which basically is the thread which initializes VCL and which is expected to eventually enter the event-loop, on Win32.
- VCL initializes the initiating threads apartment as STA on Win32. See gsl/vcl/source/app/svmain.cxx
- VCL provides the Solar Mutex, which needs to be acquired before VCL can be called.
- VCL completely releases the Solar Mutex in some situations, without any hints at the API.
VCLs internals are not protected against concurrent access, except by the Solar Mutex, which needs to be locked from the outside. VCLs API only provides blocking or polling functions for accessing the event loop, which is especially bad as it does not offer a way, to avoid long acquired MutExes, while waiting for events, except by actively polling.
Solution
Make VCL Thread-Transparent
To make VCL thread-transparent, we plan to
- remove the Solar Mutex completely and to declare VCL to be thread-unsafe, therefor going to run in the
"c++:unsafe"Uno Purpose Environment, and to - encapsulate calls to the thread-affine Win32 API, in a way, that this thread-affinity is not visible from the outside (thread-transparency). The goal being that VCL behaves as an ordinary library, not showing any threading behavior at all.
Support short MutEx Acquisition Times
To ensure short MutEx acquisition times, we plan to
- add a system handle providing API, so that we can poll/select on the handle in an outer loop, and only need to enter VCL in case of pending events. Unfortunately, this seems to depend on the removal of the internal VCL event loop, so we may go with an interim solution.
Fix Side Effects
- Some Win32 based OOo components (e.g. DDE) rely on their initializing thread to eventually enter the VCL event loop, to dispatch messages for objects created during this initialization. These implementations need to be adapted, to either delegate Win32 thread-affine calls into VCLs new internal thread, or to create a thread for dispatching purposes by their own.
- With the removal of the Solar Mutex, VCL can not release a protecting MutEx anymore, which it currently does when
executinga dialog. That means, that a protecting MutEx will stay acquired during presence of the dialog, basically disallowing other threads to enter VCL. This is going to be be addressed by making the office dialogs asynchronous and deprecating / removing theexecutemethod.
Time Frame
At least the Effort/Encapsulate the Win32 thread affinity depends on Uno/Effort/Binary/Extend Threading-Model, therefor VCL thread-transparency will earliest be available after the bunoexttm CWS.
Tasks
| Title | State | CWS |
| Effort/Make Dialogs Asynchronous | 75% | asyncdialogs asyncdialogs2 |
| Effort/Encapsulate the Win32 thread affinity | 75% | vclthreadtransparency1 |
| Fix DDE to not rely on main thread | open | vclthreadtransparency1 |
| Simplify Drag&Drop and Clipboard by using Binary Unos extended threading model | open | vclthreadtransparency1 |
| Create a Handle API or Interim Solution | 75% | vclthreadtransparency1 |
| Remove Solar Mutex and Main thread Access (e.g. main thread executor) | open | vclthreadtransparency2 |
