wine-devel

wine-devel@winehq.org

4 participants
84464 discussions

[PATCH 00/31] NT synchronization primitive driver
by Elizabeth Figura 15 Feb '24

15 Feb '24

This patch series introduces a new char misc driver, /dev/ntsync, which is used to implement Windows NT synchronization primitives. This was previously submitted as an RFC [1]. Since there were no major changes requested to the last RFC revision, I've stripped the RFC prefix. [1] https://lore.kernel.org/lkml/20240131021356.10322-1-zfigura@codeweavers.com/ == Background == The Wine project emulates the Windows API in user space. One particular part of that API, namely the NT synchronization primitives, have historically been implemented via RPC to a dedicated "kernel" process. However, more recent applications use these APIs more strenuously, and the overhead of RPC has become a bottleneck. The NT synchronization APIs are too complex to implement on top of existing primitives without sacrificing correctness. Certain operations, such as NtPulseEvent() or the "wait-for-all" mode of NtWaitForMultipleObjects(), require direct control over the underlying wait queue, and implementing a wait queue sufficiently robust for Wine in user space is not possible. This proposed driver, therefore, implements the problematic interfaces directly in the Linux kernel. This driver was presented at Linux Plumbers Conference 2023. For those further interested in the history of synchronization in Wine and past attempts to solve this problem in user space, a recording of the presentation can be viewed here: https://www.youtube.com/watch?v=NjU4nyWyhU8 == Performance == The gain in performance varies wildly depending on the application in question and the user's hardware. For some games NT synchronization is not a bottleneck and no change can be observed, but for others frame rate improvements of 50 to 150 percent are not atypical. The following table lists frame rate measurements from a variety of games on a variety of hardware, taken by users Dmitry Skvortsov, FuzzyQuils, OnMars, and myself: Game Upstream ntsync improvement =========================================================================== Anger Foot 69 99 43% Call of Juarez 99.8 224.1 125% Dirt 3 110.6 860.7 678% Forza Horizon 5 108 160 48% Lara Croft: Temple of Osiris 141 326 131% Metro 2033 164.4 199.2 21% Resident Evil 2 26 77 196% The Crew 26 51 96% Tiny Tina's Wonderlands 130 360 177% Total War Saga: Troy 109 146 34% =========================================================================== == Patches == The intended semantics of the patches are broadly intended to match those of the corresponding Windows functions. For those not already familiar with the Windows functions (or their undocumented behaviour), patch 31/31 provides a detailed specification, and individual patches also include a brief description of the API they are implementing. The patches making use of this driver in Wine can be retrieved or browsed here: https://repo.or.cz/wine/zf.git/shortlog/refs/heads/ntsync5 == Implementation == Some aspects of the implementation may deserve particular comment: * In the interest of performance, each object is governed only by a single spinlock. However, NTSYNC_IOC_WAIT_ALL requires that the state of multiple objects be changed as a single atomic operation. In order to achieve this, we first take a device-wide lock ("wait_all_lock") any time we are going to lock more than one object at a time. The maximum number of objects that can be used in a vectored wait, and therefore the maximum that can be locked simultaneously, is 64. This number is NT's own limit. The acquisition of multiple spinlocks will degrade performance. This is a conscious choice, however. Wait-for-all is known to be a very rare operation in practice, especially with counts that approach the maximum, and it is the intent of the ntsync driver to optimize wait-for-any at the expense of wait-for-all as much as possible. * NT mutexes are tied to their threads on an OS level, and the kernel includes builtin support for "robust" mutexes. In order to keep the ntsync driver self-contained and avoid touching more code than necessary, it does not hook into task exit nor use pids. Instead, the user space emulator is expected to manage thread IDs and pass them as an argument to any relevant functions; this is the "owner" field of ntsync_wait_args and ntsync_mutex_args. When the emulator detects that a thread dies, it should therefore call NTSYNC_IOC_MUTEX_KILL on any open mutexes. * ntsync is module-capable mostly because there was nothing preventing it, and because it aided development. It is not a hard requirement, though. == Previous versions == Changes from the last (v2) RFC: * Add a new wait flag NTSYNC_WAIT_REALTIME. I had originally missed a corner case in NtWaitForMultipleObjects() related to its interaction with system time adjustments. Essentially the function is sometimes supposed to respect system time adjustments and sometimes supposed to ignore them, so in order to achieve this I've added a function that controls which flag is being synchronized to. Thanks Piotr Caban for catching this. * Add tests for overflowing semaphore and mutex counters, and a test for exceeding NTSYNC_MAX_WAIT_COUNT, per Andi Kleen. * Add a more intense and realistic test involving multiple threads using the same mutex to access data, per Andi Kleen. * Use check_add_overflow() instead of writing out overflow checking manually [and thereby avoid relying on -fwrapv]. * Add some missing headers that were being implicitly included: atomic.h, hrtimer.h, ktime.h, sched.h, sched/signal.h, spinlock.h. * Link to RFC v2: https://lore.kernel.org/lkml/20240131021356.10322-1-zfigura@codeweavers.com/ * Link to RFC v1: https://lore.kernel.org/lkml/20240124004028.16826-1-zfigura@codeweavers.com/ Elizabeth Figura (31): ntsync: Introduce the ntsync driver and character device. ntsync: Introduce NTSYNC_IOC_CREATE_SEM. ntsync: Introduce NTSYNC_IOC_SEM_POST. ntsync: Introduce NTSYNC_IOC_WAIT_ANY. ntsync: Introduce NTSYNC_IOC_WAIT_ALL. ntsync: Introduce NTSYNC_IOC_CREATE_MUTEX. ntsync: Introduce NTSYNC_IOC_MUTEX_UNLOCK. ntsync: Introduce NTSYNC_IOC_MUTEX_KILL. ntsync: Introduce NTSYNC_IOC_CREATE_EVENT. ntsync: Introduce NTSYNC_IOC_EVENT_SET. ntsync: Introduce NTSYNC_IOC_EVENT_RESET. ntsync: Introduce NTSYNC_IOC_EVENT_PULSE. ntsync: Introduce NTSYNC_IOC_SEM_READ. ntsync: Introduce NTSYNC_IOC_MUTEX_READ. ntsync: Introduce NTSYNC_IOC_EVENT_READ. ntsync: Introduce alertable waits. ntsync: Allow waits to use the REALTIME clock. selftests: ntsync: Add some tests for semaphore state. selftests: ntsync: Add some tests for mutex state. selftests: ntsync: Add some tests for NTSYNC_IOC_WAIT_ANY. selftests: ntsync: Add some tests for NTSYNC_IOC_WAIT_ALL. selftests: ntsync: Add some tests for wakeup signaling with WINESYNC_IOC_WAIT_ANY. selftests: ntsync: Add some tests for wakeup signaling with WINESYNC_IOC_WAIT_ALL. selftests: ntsync: Add some tests for manual-reset event state. selftests: ntsync: Add some tests for auto-reset event state. selftests: ntsync: Add some tests for wakeup signaling with events. selftests: ntsync: Add tests for alertable waits. selftests: ntsync: Add some tests for wakeup signaling via alerts. selftests: ntsync: Add a stress test for contended waits. maintainers: Add an entry for ntsync. docs: ntsync: Add documentation for the ntsync uAPI. Documentation/userspace-api/index.rst | 1 + .../userspace-api/ioctl/ioctl-number.rst | 2 + Documentation/userspace-api/ntsync.rst | 399 +++++ MAINTAINERS | 9 + drivers/misc/Kconfig | 9 + drivers/misc/Makefile | 1 + drivers/misc/ntsync.c | 1146 ++++++++++++++ include/uapi/linux/ntsync.h | 62 + tools/testing/selftests/Makefile | 1 + .../testing/selftests/drivers/ntsync/Makefile | 8 + tools/testing/selftests/drivers/ntsync/config | 1 + .../testing/selftests/drivers/ntsync/ntsync.c | 1407 +++++++++++++++++ 12 files changed, 3046 insertions(+) create mode 100644 Documentation/userspace-api/ntsync.rst create mode 100644 drivers/misc/ntsync.c create mode 100644 include/uapi/linux/ntsync.h create mode 100644 tools/testing/selftests/drivers/ntsync/Makefile create mode 100644 tools/testing/selftests/drivers/ntsync/config create mode 100644 tools/testing/selftests/drivers/ntsync/ntsync.c base-commit: e21817acb23ece75d41a4fa7b40c85550f147389 -- 2.43.0

1 32

Wine staging 9.2 release
by Alistair Leslie-Hughes 11 Feb '24

11 Feb '24

Binary packages for various distributions will be available from: https://www.winehq.org/download Summary since last release * Rebased to current wine 9.2 (489 patches are applied to wine vanilla) Upstreamed (Either directly from staging or fixed with a similar patch). * d3dx9_36-D3DXDisassembleShader Added: * None Updated: * vkd3d-latest * ntdll-Junction_Points The patch count is down due to the upstreaming of the rawinput changes and due to conflicts, the wine-staging rawinput patches are disabled. Where can you help * Run Steam/Battle.net/GOG/UPlay/Epic * Test your favorite game. * Test your favorite applications. * Improve staging patches and get them accepted upstream. * Suggest patches to be included in staging. As always, if you find a bug, please report it via https://bugs.winehq.org Best Regards Alistair.

1 0

Wine staging 9.0 release
by Alistair Leslie-Hughes 10 Feb '24

10 Feb '24

Binary packages for various distributions will be available from: https://www.winehq.org/download Summary since last release * Rebased to current wine 9.0 (505 patches are applied to wine vanilla) Upstreamed (Either directly from staging or fixed with a similar patch). * None Added: * None Updated: * vkd3d-latest Where can you help * Run Steam/Battle.net/GOG/UPlay/Epic * Test your favorite game. * Test your favorite applications. * Improve staging patches and get them accepted upstream. * Suggest patches to be included in staging. As always, if you find a bug, please report it via https://bugs.winehq.org Best Regards Alistair.

4 5

Staging reparse point fix
by DodoGTA GT 09 Feb '24

09 Feb '24

Hello, I have made an updated version of the reparse points patchset fix that should reduce the patch noise quite a bit (I think the original version is better in terms of code duplication though)

2 1

kernelbase: adding support for callback in CopyFileEx, and implementing CopyFile2
by sendtokartavya＠gmail.com 08 Feb '24

08 Feb '24

context: https://bugs.winehq.org/show_bug.cgi?id=55897 While implementing CopyFile2, I noticed that CopyFileEx does not respect the progress callback and never calls it. The tests too assume that it will not be invoked other than in the case of a file having multiple streams, which is not something that Wine supports. There seem to have been multiple efforts to implement this functionality (in 2022 and 2013) but I can't tell find any reasoning for why they were not successful. Would implementing this be a desirable contribution? I don't know how to get assigned to an issue on Bugzilla. I read the Wine Developers Wiki but it doesn't seem to have the information, so I left a comment in the bug log itself.

4 3

Re: [RFC PATCH v2 19/29] selftests: ntsync: Add some tests for NTSYNC_IOC_WAIT_ANY.
by Elizabeth Figura 03 Feb '24

03 Feb '24

On Wednesday, 31 January 2024 02:52:11 CST Andi Kleen wrote: > Elizabeth Figura <zfigura(a)codeweavers.com> writes: > > > +TEST(test_wait_any) > > +{ > > + struct ntsync_mutex_args mutex_args = {0}; > > + struct ntsync_wait_args wait_args = {0}; > > + struct ntsync_sem_args sem_args = {0}; > > + __u32 owner, index, count; > > + struct timespec timeout; > > + int objs[2], fd, ret; > > + > > + clock_gettime(CLOCK_MONOTONIC, &timeout); > > + > > + fd = open("/dev/ntsync", O_CLOEXEC | O_RDONLY); > > + ASSERT_LE(0, fd); > > + > > + sem_args.count = 2; > > + sem_args.max = 3; > > + sem_args.sem = 0xdeadbeef; > > + ret = ioctl(fd, NTSYNC_IOC_CREATE_SEM, &sem_args); > > + EXPECT_EQ(0, ret); > > + EXPECT_NE(0xdeadbeef, sem_args.sem); > > + > > + mutex_args.owner = 0; > > + mutex_args.count = 0; > > + mutex_args.mutex = 0xdeadbeef; > > + ret = ioctl(fd, NTSYNC_IOC_CREATE_MUTEX, &mutex_args); > > + EXPECT_EQ(0, ret); > > + EXPECT_NE(0xdeadbeef, mutex_args.mutex); > > It seems your tests are missing test cases for exceeding any limits, > especially overflow/underflow cases. Since these are the most likely > for any security problems it would be good to have extra coverage here. > The fuzzers will hopefully hit it too. > > Also some stress testing with multiple threads would be useful. Thanks, I'll add these.

1 0

Upcoming vkd3d 1.11 release
by Henri Verbeet 01 Feb '24

01 Feb '24

Hi all, The tentative release date for vkd3d 1.11 is March 5. As usual, that means the development branch will become increasingly frozen as we're nearing release. In particular, the public API should be considered frozen after February 6, and we'll only accept targetted fixes after February 20. If you're an upstream vkd3d developer, please do the following: - Keep an eye on Bugzilla for any reported regressions. - Review any API changes since the previous release. - Verify all the vkd3d tests pass on your hardware, and please send fixes if they don't. - Review and improve the documentation. - Apply your best judgment about which patches are appropriate for the current stage of the release process. If you're a downstream user of vkd3d, please test your applications for regressions, and file bug reports if you find any. If you're the maintainer of a Wine module that (indirectly) depends on vkd3d, like e.g. d2d1, d3dx9, d3dcompiler, or any of the core Direct3D modules, that includes making sure the unit tests still pass with the new version. The planned release date for vkd3d 1.12 is currently May 28. Regards, Henri

1 0

[RFC PATCH v2 00/29] NT synchronization primitive driver
by Elizabeth Figura 31 Jan '24

31 Jan '24

This patch series introduces a new char misc driver, /dev/ntsync, which is used to implement Windows NT synchronization primitives. == Background == The Wine project emulates the Windows API in user space. One particular part of that API, namely the NT synchronization primitives, have historically been implemented via RPC to a dedicated "kernel" process. However, more recent applications use these APIs more strenuously, and the overhead of RPC has become a bottleneck. The NT synchronization APIs are too complex to implement on top of existing primitives without sacrificing correctness. Certain operations, such as NtPulseEvent() or the "wait-for-all" mode of NtWaitForMultipleObjects(), require direct control over the underlying wait queue, and implementing a wait queue sufficiently robust for Wine in user space is not possible. This proposed driver, therefore, implements the problematic interfaces directly in the Linux kernel. This driver was presented at Linux Plumbers Conference 2023. For those further interested in the history of synchronization in Wine and past attempts to solve this problem in user space, a recording of the presentation can be viewed here: https://www.youtube.com/watch?v=NjU4nyWyhU8 == Performance == The gain in performance varies wildly depending on the application in question and the user's hardware. For some games NT synchronization is not a bottleneck and no change can be observed, but for others frame rate improvements of 50 to 150 percent are not atypical. The following table lists frame rate measurements from a variety of games on a variety of hardware, taken by users Dmitry Skvortsov, FuzzyQuils, OnMars, and myself: Game Upstream ntsync improvement =========================================================================== Anger Foot 69 99 43% Call of Juarez 99.8 224.1 125% Dirt 3 110.6 860.7 678% Forza Horizon 5 108 160 48% Lara Croft: Temple of Osiris 141 326 131% Metro 2033 164.4 199.2 21% Resident Evil 2 26 77 196% The Crew 26 51 96% Tiny Tina's Wonderlands 130 360 177% Total War Saga: Troy 109 146 34% =========================================================================== == Patches == The intended semantics of the patches are broadly intended to match those of the corresponding Windows functions. For those not already familiar with the Windows functions (or their undocumented behaviour), patch 29/29 provides a detailed specification, and individual patches also include a brief description of the API they are implementing. The patches making use of this driver in Wine can be retrieved or browsed here: https://repo.or.cz/wine/zf.git/shortlog/refs/heads/ntsync5 == Implementation == Some aspects of the implementation may deserve particular comment: * In the interest of performance, each object is governed only by a single spinlock. However, NTSYNC_IOC_WAIT_ALL requires that the state of multiple objects be changed as a single atomic operation. In order to achieve this, we first take a device-wide lock ("wait_all_lock") any time we are going to lock more than one object at a time. The maximum number of objects that can be used in a vectored wait, and therefore the maximum that can be locked simultaneously, is 64. This number is NT's own limit. The acquisition of multiple spinlocks will degrade performance. This is a conscious choice, however. Wait-for-all is known to be a very rare operation in practice, especially with counts that approach the maximum, and it is the intent of the ntsync driver to optimize wait-for-any at the expense of wait-for-all as much as possible. * NT mutexes are tied to their threads on an OS level, and the kernel includes builtin support for "robust" mutexes. In order to keep the ntsync driver self-contained and avoid touching more code than necessary, it does not hook into task exit nor use pids. Instead, the user space emulator is expected to manage thread IDs and pass them as an argument to any relevant functions; this is the "owner" field of ntsync_wait_args and ntsync_mutex_args. When the emulator detects that a thread dies, it should therefore call NTSYNC_IOC_KILL_OWNER, which will mark mutexes owned by that thread (if any) as abandoned. * This implementation uses a misc device mostly because it seemed like the simplest and least obtrusive option. Besides simplicitly of implementation, the only particularly interesting advantage is the ability to create an arbitrary number of "contexts" (corresponding to Windows virtual machines) which are self-contained and shareable across multiple processes; this maps nicely to file descriptions (i.e. struct file). This is not impossible with syscalls of course but would require an extra argument. On the other hand, there is no reason to forbid using ntsync by default from user-mode processes, and (as far as I understand) to do so with a char device requires explicit configuration by e.g. udev or init. Since this is done with e.g. fuse, I assume this is the model to follow, but I may have chosen something deprecated. * ntsync is module-capable mostly because there was nothing preventing it, and because it aided development. It is not a hard requirement, though. == Previous versions == Changes in v2: * Send the whole series instead of just the first few patches. * Try to add more description to each patch, as a short documentation of the functions to be implemented. A more complete documentation of all aspects of the driver is provided in the contents of the last patch. * Objects are now files rather than indices into a table. This prevents a process from changing the state of an object which it should not have access to. Suggested by Andy Lutorminski. * Because the device no longer inherently has a table of all objects, marking a thread's owned mutexes as abandoned is now done through an ioctl on the mutex. * Change the names of a couple ioctls to be a bit less odd (PUT_SEM -> SEM_POST, PUT_MUTEX -> MUTEX_UNLOCK), and to reflect that they are ioctls on an object rather than on the device. * Pass the timeout for wait functions as a bare u64 (in ns), per Arnd Bergmann, with U64_MAX used to indicate no timeout. I originally indicated that I would change the timeout to be relative, but on reflection ended up keeping it as absolute, as this results in the least number of calls to get the current time (i.e. one). * Use compat_ptr_ioctl(), per Arnd Bergmann. * Remove the fixed minor number and module alias, per Greg Kroah-Hartman. * Allocate the fds array on stack in setup_wait(). This array takes up 260 bytes. * Link to v1: https://lore.kernel.org/lkml/20240124004028.16826-1-zfigura@codeweavers.com/ Elizabeth Figura (29): ntsync: Introduce the ntsync driver and character device. ntsync: Introduce NTSYNC_IOC_CREATE_SEM. ntsync: Introduce NTSYNC_IOC_SEM_POST. ntsync: Introduce NTSYNC_IOC_WAIT_ANY. ntsync: Introduce NTSYNC_IOC_WAIT_ALL. ntsync: Introduce NTSYNC_IOC_CREATE_MUTEX. ntsync: Introduce NTSYNC_IOC_MUTEX_UNLOCK. ntsync: Introduce NTSYNC_IOC_MUTEX_KILL. ntsync: Introduce NTSYNC_IOC_CREATE_EVENT. ntsync: Introduce NTSYNC_IOC_EVENT_SET. ntsync: Introduce NTSYNC_IOC_EVENT_RESET. ntsync: Introduce NTSYNC_IOC_EVENT_PULSE. ntsync: Introduce NTSYNC_IOC_SEM_READ. ntsync: Introduce NTSYNC_IOC_MUTEX_READ. ntsync: Introduce NTSYNC_IOC_EVENT_READ. ntsync: Introduce alertable waits. selftests: ntsync: Add some tests for semaphore state. selftests: ntsync: Add some tests for mutex state. selftests: ntsync: Add some tests for NTSYNC_IOC_WAIT_ANY. selftests: ntsync: Add some tests for NTSYNC_IOC_WAIT_ALL. selftests: ntsync: Add some tests for wakeup signaling with WINESYNC_IOC_WAIT_ANY. selftests: ntsync: Add some tests for wakeup signaling with WINESYNC_IOC_WAIT_ALL. selftests: ntsync: Add some tests for manual-reset event state. selftests: ntsync: Add some tests for auto-reset event state. selftests: ntsync: Add some tests for wakeup signaling with events. selftests: ntsync: Add tests for alertable waits. selftests: ntsync: Add some tests for wakeup signaling via alerts. maintainers: Add an entry for ntsync. docs: ntsync: Add documentation for the ntsync uAPI. Documentation/userspace-api/index.rst | 1 + .../userspace-api/ioctl/ioctl-number.rst | 2 + Documentation/userspace-api/ntsync.rst | 390 +++++ MAINTAINERS | 9 + drivers/misc/Kconfig | 9 + drivers/misc/Makefile | 1 + drivers/misc/ntsync.c | 1132 ++++++++++++++ include/uapi/linux/ntsync.h | 58 + tools/testing/selftests/Makefile | 1 + .../testing/selftests/drivers/ntsync/Makefile | 8 + tools/testing/selftests/drivers/ntsync/config | 1 + .../testing/selftests/drivers/ntsync/ntsync.c | 1300 +++++++++++++++++ 12 files changed, 2912 insertions(+) create mode 100644 Documentation/userspace-api/ntsync.rst create mode 100644 drivers/misc/ntsync.c create mode 100644 include/uapi/linux/ntsync.h create mode 100644 tools/testing/selftests/drivers/ntsync/Makefile create mode 100644 tools/testing/selftests/drivers/ntsync/config create mode 100644 tools/testing/selftests/drivers/ntsync/ntsync.c -- 2.43.0

1 29

The future of WineConf
by Alexandre Julliard 27 Jan '24

27 Jan '24

Folks, As you may have noticed, we haven't been making any plans for WineConf this year. Jeremy has been busy preparing his retirement, and I haven't been pushing it either, mostly because I'm not convinced that we want to continue the traditional WineConf model. Even though we skipped a few years because of the pandemic, attendance at last year's WineConf wasn't great. We also suggested meeting at FOSDEM in February, like we did in previous years, but essentially no one showed up. So I'm wondering whether there is still enough interest for a traditional WineConf, or whether we should try a different approach, to maybe capture some of the recent excitement around gaming and downstream uses of Wine in general. I'd like to hear your thoughts. Should we do a Proton conference, or join some kind of gaming-related event? Do people even want to travel to conferences anymore? What kind of event would you be interested in, particularly those of you who don't show up to the traditional WineConf? -- Alexandre Julliard julliard(a)winehq.org

14 19

Wine staging 9.1 release
by Alistair Leslie-Hughes 27 Jan '24

27 Jan '24

Binary packages for various distributions will be available from: https://www.winehq.org/download Summary since last release * Rebased to current wine 9.1 (508 patches are applied to wine vanilla) Upstreamed (Either directly from staging or fixed with a similar patch). * include: Add more D3D_FEATURE_LEVEL_ defines. * oleaut32: Do not reimplement OleLoadPicture in OleLoadPicturePath. * oleaut32: Factor out stream creation from OleLoadPicturePath. * oleaut32: Implement OleLoadPictureFile. (v2) * user32/tests: Add tests for clicking through layered window. * user32/tests: Add tests for window region of layered windows. Added: * [50148] msi: Process cabinet files only when one is supplied. * [51965] msxml3: IMXWrite::output to support DOMDocument. * [52128] scrrun: Implement IFileSystem3 MoveFolder. Updated: * vkd3d-latest * user32-Mouse_Message_Hwnd (Rebased and enabled) * wined3d-bindless-texture (Rebased and enabled) * ddraw-version-check (Rebased and enabled) * vcomp_for_dynamic_init_i8 Where can you help * Run Steam/Battle.net/GOG/UPlay/Epic * Test your favorite game. * Test your favorite applications. * Improve staging patches and get them accepted upstream. * Suggest patches to be included in staging. As always, if you find a bug, please report it via https://bugs.winehq.org Best Regards Alistair.

1 0

Jump to page:

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

2004

2003

2002

2001

wine-devel