From 8d4c1c38a872a2d5722929c727a6d81004ad00c6 Mon Sep 17 00:00:00 2001
From: Schrodinger ZHU Yifan <i@zhuyi.fan>
Date: Wed, 13 Nov 2024 22:31:29 -0500
Subject: [PATCH] static dispatch os APIs for apple

---
 src/snmalloc/pal/pal_apple.h | 117 ++++++++++++++++++-----------------
 1 file changed, 61 insertions(+), 56 deletions(-)

diff --git a/src/snmalloc/pal/pal_apple.h b/src/snmalloc/pal/pal_apple.h
index 9e883ba66..e4588b1f8 100644
--- a/src/snmalloc/pal/pal_apple.h
+++ b/src/snmalloc/pal/pal_apple.h
@@ -15,26 +15,38 @@
 #  include <sys/mman.h>
 #  include <unistd.h>
 
+#  if __has_include(<AvailabilityMacros.h>) && __has_include(<Availability.h>)
+#    include <Availability.h>
+#    include <AvailabilityMacros.h>
+#    if defined(__MAC_OS_X_VERSION_MIN_REQUIRED) && \
+      defined(MAC_OS_X_VERSION_14_4)
+#      if __MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_14_4
+#        define SNMALLOC_APPLE_HAS_OS_SYNC_WAIT_ON_ADDRESS
+#      endif
+#    endif
+#  endif
+
 namespace snmalloc
 {
+#  ifdef SNMALLOC_APPLE_HAS_OS_SYNC_WAIT_ON_ADDRESS
+  // For macos 14.4+, we use os_sync_wait_on_address and friends. It is
+  // available as a part of stable API, and the usage is more straightforward.
   extern "C" int os_sync_wait_on_address(
-    void* addr, uint64_t value, size_t size, uint32_t flags)
-    __attribute__((weak_import));
+    void* addr, uint64_t value, size_t size, uint32_t flags);
 
   extern "C" int
-  os_sync_wake_by_address_any(void* addr, size_t size, uint32_t flags)
-    __attribute__((weak_import));
+  os_sync_wake_by_address_any(void* addr, size_t size, uint32_t flags);
 
   extern "C" int
-  os_sync_wake_by_address_all(void* addr, size_t size, uint32_t flags)
-    __attribute__((weak_import));
-
+  os_sync_wake_by_address_all(void* addr, size_t size, uint32_t flags);
+#  else
+  // For platforms before macos 14.4, we use __ulock_wait and friends. It is
+  // available since macos 10.12.
   extern "C" int
-  __ulock_wait(uint32_t lock_type, void* addr, uint64_t value, uint32_t)
-    __attribute__((weak_import));
+  __ulock_wait(uint32_t lock_type, void* addr, uint64_t value, uint32_t);
 
-  extern "C" int __ulock_wake(uint32_t lock_type, void* addr, uint64_t)
-    __attribute__((weak_import));
+  extern "C" int __ulock_wake(uint32_t lock_type, void* addr, uint64_t);
+#  endif
 
   /**
    * PAL implementation for Apple systems (macOS, iOS, watchOS, tvOS...).
@@ -302,9 +314,11 @@ namespace snmalloc
     }
 
     using WaitingWord = uint32_t;
+#  ifndef SNMALLOC_APPLE_HAS_OS_SYNC_WAIT_ON_ADDRESS
     static constexpr uint32_t UL_COMPARE_AND_WAIT = 0x0000'0001;
     static constexpr uint32_t ULF_NO_ERRNO = 0x0100'0000;
     static constexpr uint32_t ULF_WAKE_ALL = 0x0000'0100;
+#  endif
 
     template<class T>
     static void wait_on_address(std::atomic<T>& addr, T expected)
@@ -312,70 +326,61 @@ namespace snmalloc
       int errno_backup = errno;
       while (addr.load(std::memory_order_relaxed) == expected)
       {
-        if (os_sync_wait_on_address)
+#  ifdef SNMALLOC_APPLE_HAS_OS_SYNC_WAIT_ON_ADDRESS
+        if (
+          os_sync_wait_on_address(
+            &addr, static_cast<uint64_t>(expected), sizeof(T), 0) != -1)
         {
-          if (
-            os_sync_wait_on_address(
-              &addr, static_cast<uint64_t>(expected), sizeof(T), 0) != -1)
-          {
-            errno = errno_backup;
-            return;
-          }
+          errno = errno_backup;
+          return;
         }
-        else if (__ulock_wait)
+#  else
+        if (
+          __ulock_wait(
+            UL_COMPARE_AND_WAIT | ULF_NO_ERRNO,
+            &addr,
+            static_cast<uint64_t>(expected),
+            0) != -1)
         {
-          if (
-            __ulock_wait(
-              UL_COMPARE_AND_WAIT | ULF_NO_ERRNO,
-              &addr,
-              static_cast<uint64_t>(expected),
-              0) != -1)
-          {
-            return;
-          }
+          return;
         }
+#  endif
       }
     }
 
     template<class T>
     static void notify_one_on_address(std::atomic<T>& addr)
     {
-      if (os_sync_wake_by_address_any)
+#  ifdef SNMALLOC_APPLE_HAS_OS_SYNC_WAIT_ON_ADDRESS
+      os_sync_wake_by_address_any(&addr, sizeof(T), 0);
+#  else
+      // __ulock_wake can get interrupted, so retry until either waking up a
+      // waiter or failing because there are no waiters (ENOENT).
+      for (;;)
       {
-        os_sync_wake_by_address_any(&addr, sizeof(T), 0);
-      }
-      else if (__ulock_wake)
-      {
-        // __ulock_wake can get interrupted, so retry until either waking up a
-        // waiter or failing because there are no waiters (ENOENT).
-        for (;;)
-        {
-          int ret = __ulock_wake(UL_COMPARE_AND_WAIT | ULF_NO_ERRNO, &addr, 0);
-          if (ret >= 0 || ret == -ENOENT)
-            return;
-        }
+        int ret = __ulock_wake(UL_COMPARE_AND_WAIT | ULF_NO_ERRNO, &addr, 0);
+        if (ret >= 0 || ret == -ENOENT)
+          return;
       }
+#  endif
     }
 
     template<class T>
     static void notify_all_on_address(std::atomic<T>& addr)
     {
-      if (os_sync_wake_by_address_all)
-      {
-        os_sync_wake_by_address_all(&addr, sizeof(T), 0);
-      }
-      else if (__ulock_wake)
+#  ifdef SNMALLOC_APPLE_HAS_OS_SYNC_WAIT_ON_ADDRESS
+      os_sync_wake_by_address_all(&addr, sizeof(T), 0);
+#  else
+      // __ulock_wake can get interrupted, so retry until either waking up a
+      // waiter or failing because there are no waiters (ENOENT).
+      for (;;)
       {
-        // __ulock_wake can get interrupted, so retry until either waking up a
-        // waiter or failing because there are no waiters (ENOENT).
-        for (;;)
-        {
-          int ret = __ulock_wake(
-            UL_COMPARE_AND_WAIT | ULF_NO_ERRNO | ULF_WAKE_ALL, &addr, 0);
-          if (ret >= 0 || ret == -ENOENT)
-            return;
-        }
+        int ret = __ulock_wake(
+          UL_COMPARE_AND_WAIT | ULF_NO_ERRNO | ULF_WAKE_ALL, &addr, 0);
+        if (ret >= 0 || ret == -ENOENT)
+          return;
       }
+#  endif
     }
   };
 } // namespace snmalloc