cosmopolitan/third_party/nsync
Justine Tunney 85f64f3851
Make futexes 100x better on x86 MacOS
Thanks to @autumnjolitz (in #876) the Cosmopolitan codebase is now
acquainted with Apple's outstanding ulock system calls which offer
something much closer to futexes than Grand Central Dispatch which
wasn't quite as good, since its wait function can't be interrupted
by signals (therefore necessitating a busy loop) and it also needs
semaphore objects to be created and freed. Even though ulock is an
internal Apple API, strictly speaking, the benefits of futexes are
so great that it's worth the risk for now especially since we have
the GCD implementation still as a quick escape hatch if it changes

Here's why this change is important for x86 XNU users. Cosmo has a
suboptimal polyfill when the operating system doesn't offer an API
that let's us implement futexes properly. Sadly we had to use that
on X86 XNU until now. The polyfill works using clock_nanosleep, to
poll the futex in a busy loop with exponential backoff. On XNU x86
clock_nanosleep suffers from us not being able to use a fast clock
gettime implementation, which had a compounding effect that's made
the polyfill function even more poorly. On X86 XNU we also need to
polyfill sched_yield() using select(), which made things even more
troublesome. Now that we have futexes we don't have any busy loops
anymore for both condition variables and thread joining so optimal
performance is attained. To demonstrate, consider these benchmarks

Before:

    $ ./lockscale_test.com -b
    consumed 38.8377   seconds real time and
              0.087131 seconds cpu time

After:

    $ ./lockscale_test.com -b
    consumed 0.007955 seconds real time and
             0.011515 seconds cpu time

Fixes #876
2023-10-03 15:15:43 -07:00
..
mem Make improvements 2023-09-18 21:04:47 -07:00
testing Make improvements 2023-09-18 21:04:47 -07:00
array.internal.h Clean up some sleep code 2022-10-08 03:00:48 -07:00
atomic.h Validate privileged code relationships 2023-06-08 04:38:06 -07:00
atomic.internal.h Add shared memory apis to redbean 2022-10-06 04:55:26 -07:00
common.c Get rid of kmalloc() 2023-09-11 21:56:00 -07:00
common.internal.h Get rid of kmalloc() 2023-09-11 21:56:00 -07:00
compat.S Make improvements 2023-06-15 14:50:53 -07:00
counter.h Clean up more code 2023-07-06 08:03:24 -07:00
cv.h Clean up more code 2023-07-06 08:03:24 -07:00
debug.h Use *NSYNC for POSIX threads locking APIs 2022-09-11 11:04:50 -07:00
futex.c Make futexes 100x better on x86 MacOS 2023-10-03 15:15:43 -07:00
futex.internal.h Fix warnings 2023-09-01 20:50:18 -07:00
heap.internal.h Clean up some sleep code 2022-10-08 03:00:48 -07:00
LICENSE.txt Use *NSYNC for POSIX threads locking APIs 2022-09-11 11:04:50 -07:00
mu.c Get rid of kmalloc() 2023-09-11 21:56:00 -07:00
mu.h Clean up more code 2023-07-06 08:03:24 -07:00
mu_semaphore.c Make futexes 100x better on x86 MacOS 2023-10-03 15:15:43 -07:00
mu_semaphore.h Get rid of kmalloc() 2023-09-11 21:56:00 -07:00
mu_semaphore.internal.h Get rid of kmalloc() 2023-09-11 21:56:00 -07:00
mu_semaphore_futex.c Make improvements 2023-09-18 21:04:47 -07:00
mu_semaphore_gcd.c Fix semaphore deadlock on Apple Silicon 2023-10-03 09:26:46 -07:00
mu_semaphore_sem.c Make improvements 2023-09-18 21:04:47 -07:00
mu_wait.h Use *NSYNC for POSIX threads locking APIs 2022-09-11 11:04:50 -07:00
note.h Use *NSYNC for POSIX threads locking APIs 2022-09-11 11:04:50 -07:00
nsync.mk Make improvements 2023-09-18 21:04:47 -07:00
once.h Use *NSYNC for POSIX threads locking APIs 2022-09-11 11:04:50 -07:00
panic.c Remove some dead code 2023-07-03 02:48:29 -07:00
races.internal.h Add *NSYNC mu_test 2022-09-11 18:56:29 -07:00
README.cosmo Make futexes 100x better on x86 MacOS 2023-10-03 15:15:43 -07:00
README.md Add *NSYNC to libc/isystem 2022-09-13 01:47:12 -07:00
time.h Improve cancellations, randomness, and time 2022-11-05 23:45:32 -07:00
wait_s.internal.h Clean up more code 2023-07-06 08:03:24 -07:00
waiter.h Use *NSYNC for POSIX threads locking APIs 2022-09-11 11:04:50 -07:00
yield.c Make improvements 2023-09-18 21:04:47 -07:00

*NSYNC

*NSYNC is a library providing scalable synchronization primitives. The following packages are provided:

  • THIRD_PARTY_NSYNC has nsync_mu which doesn't depend on malloc().
  • THIRD_PARTY_NSYNC_MEM has the rest of *NSYNC, e.g. nsync_cv.

The origin of this code is here:

git@github.com:google/nsync
ac5489682760393fe21bd2a8e038b528442412a7 (1.25.0)
Author: Mike Burrows <m3b@google.com>
Date:   Wed Jun 1 16:47:52 2022 -0700

NSYNC uses the Apache 2.0 license. We made the following local changes:

  • Write custom nsync_malloc_() so malloc() can use *NSYNC.

  • Rewrite futex() wrapper to support old Linux kernels and OpenBSD.

  • Normalize sources to Cosmopolitan style conventions; *NSYNC upstream supports dozens of compilers and operating systems, at compile-time. Since Cosmo solves portability at runtime instead, most of the build config toil has been removed, in order to help the NSYNC source code be more readable and hackable.