Implement sigsetjmp and siglongjmp for darwin/aarch64
#139555
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@llvm/pr-subscribers-libc Author: Aly ElAshram (AlyElashram) ChangesFull diff: https://github.com/llvm/llvm-project/pull/139555.diff 7 Files Affected:
diff --git a/libc/config/darwin/arm/entrypoints.txt b/libc/config/darwin/arm/entrypoints.txt
index 308fc49d681d7..07199db6d1ae6 100644
--- a/libc/config/darwin/arm/entrypoints.txt
+++ b/libc/config/darwin/arm/entrypoints.txt
@@ -20,6 +20,10 @@ set(TARGET_LIBC_ENTRYPOINTS
# errno.h entrypoints
libc.src.errno.errno
+ # setjmp.h entrypoints
+ libc.src.setjmp
+
+
# string.h entrypoints
libc.src.string.memccpy
libc.src.string.memchr
diff --git a/libc/config/darwin/arm/headers.txt b/libc/config/darwin/arm/headers.txt
index 86e7145972324..8f3d6029c9b6a 100644
--- a/libc/config/darwin/arm/headers.txt
+++ b/libc/config/darwin/arm/headers.txt
@@ -7,6 +7,7 @@ set(TARGET_PUBLIC_HEADERS
libc.include.inttypes
libc.include.limits
libc.include.math
+ libc.include.setjmp
libc.include.stdlib
libc.include.string
libc.include.strings
diff --git a/libc/src/setjmp/darwin/aarch64/CMakeLists.txt b/libc/src/setjmp/darwin/aarch64/CMakeLists.txt
new file mode 100644
index 0000000000000..37058e9fb905e
--- /dev/null
+++ b/libc/src/setjmp/darwin/aarch64/CMakeLists.txt
@@ -0,0 +1,51 @@
+if(setjmp_config_options)
+ list(PREPEND setjmp_config_options "COMPILE_OPTIONS")
+endif()
+
+add_entrypoint_object(
+ setjmp
+ SRCS
+ setjmp.cpp
+ HDRS
+ ../../setjmp_impl.h
+ DEPENDS
+ libc.hdr.types.jmp_buf
+ ${setjmp_config_options}
+)
+
+add_entrypoint_object(
+ longjmp
+ SRCS
+ longjmp.cpp
+ HDRS
+ ../../longjmp.h
+ DEPENDS
+ libc.hdr.types.jmp_buf
+ ${setjmp_config_options}
+)
+
+add_entrypoint_object(
+ sigsetjmp
+ SRCS
+ sigsetjmp.cpp
+ HDRS
+ ../../sigsetjmp.h
+ DEPENDS
+ libc.hdr.types.jmp_buf
+ libc.hdr.types.sigset_t
+ libc.hdr.offsetof_macros
+ libc.src.setjmp.sigsetjmp_epilogue
+ libc.src.setjmp.setjmp
+)
+add_object_library(
+ sigsetjmp_epilogue
+ HDRS
+ ../../sigsetjmp_epilogue.h
+ SRCS
+ sigsetjmp_epilogue.cpp
+ DEPENDS
+ libc.src.__support.common
+ libc.src.__support.OSUtil.osutil
+ libc.hdr.types.jmp_buf
+ libc.hdr.types.sigset_t
+)
\ No newline at end of file
diff --git a/libc/src/setjmp/darwin/aarch64/longjmp.cpp b/libc/src/setjmp/darwin/aarch64/longjmp.cpp
new file mode 100644
index 0000000000000..eca4303f58034
--- /dev/null
+++ b/libc/src/setjmp/darwin/aarch64/longjmp.cpp
@@ -0,0 +1,87 @@
+//===-- Implementation of longjmp for AArch64 -----------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "src/setjmp/longjmp.h"
+#include "src/__support/common.h"
+#include "src/__support/macros/config.h"
+
+namespace LIBC_NAMESPACE_DECL {
+
+// TODO: if MTE stack tagging is in use (-fsanitize=memtag-stack), we need to
+// iterate over the region between the old and new values of sp, using STG or
+// ST2G instructions to clear the memory tags on the invalidated region of the
+// stack. But this requires a means of finding out that we're in that mode, and
+// as far as I can see there isn't currently a predefined macro for that.
+//
+// (__ARM_FEATURE_MEMORY_TAGGING only indicates whether the target architecture
+// supports the MTE instructions, not whether the compiler is configured to use
+// them.)
+
+[[gnu::naked]] LLVM_LIBC_FUNCTION(void, longjmp,
+ ([[maybe_unused]] jmp_buf buf,
+ [[maybe_unused]] int val)) {
+ // If BTI branch protection is in use, the compiler will automatically insert
+ // a BTI here, so we don't need to make any extra effort to do so.
+
+ // If PAC branch protection is in use, there's no need to sign the return
+ // address at the start of longjmp, because we're not going to use it anyway!
+
+ asm(
+ // Reload the callee-saved GPRs, including fp and lr.
+ R"(
+ ldp x19, x20, [x0, #0*16]
+ ldp x21, x22, [x0, #1*16]
+ ldp x23, x24, [x0, #2*16]
+ ldp x25, x26, [x0, #3*16]
+ ldp x27, x28, [x0, #4*16]
+ ldp x29, x30, [x0, #5*16]
+ )"
+ // We would usually reload the platform register x18 here
+ // but due to the apple ABI we are not allowed to use the x18 register
+ // so we reload the stack pointer only.
+ // https://developer.apple.com/documentation/xcode/writing-arm64-code-for-apple-platforms#Respect-the-purpose-of-specific-CPU-registers
+ R"(
+ ldr x2, [x0, #6*16]
+ mov sp, x2
+ )"
+
+#if __ARM_FP
+ // Reload the callee-saved FP registers.
+ R"(
+ ldp d8, d9, [x0, #7*16]
+ ldp d10, d11, [x0, #8*16]
+ ldp d12, d13, [x0, #9*16]
+ ldp d14, d15, [x0, #10*16]
+ )"
+#endif
+
+ // Calculate the return value.
+ R"(
+ cmp w1, #0
+ cinc w0, w1, eq
+ )"
+
+#if (__ARM_FEATURE_PAC_DEFAULT & 7) == 5
+ // Authenticate the return address using the PAC A key, since the
+ // compilation options ask for PAC protection even on leaf functions.
+ R"(
+ autiasp
+ )"
+#elif (__ARM_FEATURE_PAC_DEFAULT & 7) == 6
+ // Same, but using the PAC B key.
+ R"(
+ autibsp
+ )"
+#endif
+
+ R"(
+ ret
+ )");
+}
+
+} // namespace LIBC_NAMESPACE_DECL
diff --git a/libc/src/setjmp/darwin/aarch64/setjmp.cpp b/libc/src/setjmp/darwin/aarch64/setjmp.cpp
new file mode 100644
index 0000000000000..2842590850217
--- /dev/null
+++ b/libc/src/setjmp/darwin/aarch64/setjmp.cpp
@@ -0,0 +1,87 @@
+//===-- Implementation of setjmp for darwin AArch64 -----------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "src/__support/common.h"
+#include "src/__support/macros/config.h"
+#include "src/setjmp/setjmp_impl.h"
+
+namespace LIBC_NAMESPACE_DECL {
+
+[[gnu::naked]] LLVM_LIBC_FUNCTION(int, setjmp, ([[maybe_unused]] jmp_buf buf)) {
+ // If BTI branch protection is in use, the compiler will automatically insert
+ // a BTI here, so we don't need to make any extra effort to do so.
+
+ asm(
+#if __ARM_FEATURE_PAC_DEFAULT & 1
+ // Sign the return address using the PAC A key.
+ R"(
+ paciasp
+ )"
+#elif __ARM_FEATURE_PAC_DEFAULT & 2
+ // Sign the return address using the PAC B key.
+ R"(
+ pacibsp
+ )"
+#endif
+
+ // Store all the callee-saved GPRs, including fp (x29) and also lr (x30).
+ // Of course lr isn't normally callee-saved (the call instruction itself
+ // can't help clobbering it), but we certainly need to save it for this
+ // purpose.
+ R"(
+ stp x19, x20, [x0, #0*16]
+ stp x21, x22, [x0, #1*16]
+ stp x23, x24, [x0, #2*16]
+ stp x25, x26, [x0, #3*16]
+ stp x27, x28, [x0, #4*16]
+ stp x29, x30, [x0, #5*16]
+ )"
+
+ // While we usually store the platform register x18
+ // the darwin ABI inhibts usage of it
+ // Store just the stack pointer.
+ R"(
+ add x1, sp, #0
+ str x1, [x0, #6*16]
+ )"
+
+#if __ARM_FP
+ // Store the callee-saved FP registers. AAPCS64 only requires the low 64
+ // bits of v8-v15 to be preserved, i.e. each of d8,...,d15.
+ R"(
+ stp d8, d9, [x0, #7*16]
+ stp d10, d11, [x0, #8*16]
+ stp d12, d13, [x0, #9*16]
+ stp d14, d15, [x0, #10*16]
+ )"
+#endif
+
+ // Set up return value of zero.
+ R"(
+ mov x0, #0
+ )"
+
+#if (__ARM_FEATURE_PAC_DEFAULT & 7) == 5
+ // Authenticate the return address using the PAC A key, since the
+ // compilation options ask for PAC protection even on leaf functions.
+ R"(
+ autiasp
+ )"
+#elif (__ARM_FEATURE_PAC_DEFAULT & 7) == 6
+ // Same, but using the PAC B key.
+ R"(
+ autibsp
+ )"
+#endif
+
+ R"(
+ ret
+ )");
+}
+
+} // namespace LIBC_NAMESPACE_DECL
diff --git a/libc/src/setjmp/darwin/aarch64/sigsetjmp.cpp b/libc/src/setjmp/darwin/aarch64/sigsetjmp.cpp
new file mode 100644
index 0000000000000..88b5a28e1105d
--- /dev/null
+++ b/libc/src/setjmp/darwin/aarch64/sigsetjmp.cpp
@@ -0,0 +1,40 @@
+//===-- Implementation of darwin/aarch64 sigsetjmp ------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "src/setjmp/sigsetjmp.h"
+#include "hdr/offsetof_macros.h"
+#include "src/__support/common.h"
+#include "src/__support/macros/config.h"
+#include "src/setjmp/setjmp_impl.h"
+#include "src/setjmp/sigsetjmp_epilogue.h"
+
+namespace LIBC_NAMESPACE_DECL {
+[[gnu::naked]]
+LLVM_LIBC_FUNCTION(int, sigsetjmp, (sigjmp_buf, int)) {
+
+ // The difference between sigsetjmp and setjmp is storing the signal mask of
+ // the calling thread
+
+ asm(R"(
+ cbz w1, %c[setjmp]
+
+ str x30, [x0, %c[retaddr]]
+ str x19, [x0, %c[extra]]
+ mov x19, x0
+ bl %c[setjmp]
+
+ mov w1, w0
+ mov x0, x19
+ ldr x30, [x0, %c[retaddr]]
+ ldr x19, [x0, %c[extra]]
+ b %c[epilogue])" ::[retaddr] "i"(offsetof(__jmp_buf, sig_retaddr)),
+ [extra] "i"(offsetof(__jmp_buf, sig_extra)), [setjmp] "i"(setjmp),
+ [epilogue] "i"(sigsetjmp_epilogue)
+ : "x0", "x1", "x19", "x30");
+}
+} // namespace LIBC_NAMESPACE_DECL
diff --git a/libc/src/setjmp/darwin/aarch64/sigsetjmp_epilogue.cpp b/libc/src/setjmp/darwin/aarch64/sigsetjmp_epilogue.cpp
new file mode 100644
index 0000000000000..b2ca4d99ed82b
--- /dev/null
+++ b/libc/src/setjmp/darwin/aarch64/sigsetjmp_epilogue.cpp
@@ -0,0 +1,21 @@
+//===-- Implementation of sigsetjmp_epilogue ------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "src/setjmp/sigsetjmp_epilogue.h"
+#include "src/__support/OSUtil/syscall.h"
+#include "src/__support/common.h"
+#include "src/signal/sigprocmask.h"
+
+namespace LIBC_NAMESPACE_DECL {
+[[gnu::returns_twice]] int sigsetjmp_epilogue(jmp_buf buffer, int retval) {
+ syscall_impl<long>(sigprocmask, SIG_SETMASK,
+ /* set= */ retval ? &buffer->sigmask : nullptr,
+ /* old_set= */ retval ? nullptr : &buffer->sigmask);
+ return retval;
+}
+} // namespace LIBC_NAMESPACE_DECL
|
| @@ -0,0 +1,51 @@ | |||
| if(setjmp_config_options) | |||
There was a problem hiding this comment.
for this cmake file to be evaluated, you need to add add_subdirectory calls to the cmake files above it. You also might be able to reuse the setjmp and longjmp implementations that already exist in setjmp/aarch64, and only have darwin specific code in setjmp/darwin.
There was a problem hiding this comment.
That makes sense , I'm just unsure how I could remove parts of the inline assembly. My first thought was to define some flag or header for example is_darwin and then surround the code that should not be executed for darwin with that flag , and since it's only a single line of assembly I don't think that would be super hard no ?
Any thoughts on how to do that?
There was a problem hiding this comment.
The only part we would need to remove from the setjmp is storing the platform register.
https://github.com/llvm/llvm-project/blob/main/libc/src/setjmp/aarch64/setjmp.cpp#L45-L57
If i can somehow enforce that this flag (LIBC_COPT_SETJMP_AARCH64_RESTORE_PLATFORM_REGISTER) is false , we can totally reuse the implementation.
And my assumption is that this could be done by adding a new cmake file and removing these lines from the cmake (these exist in the aarch64 directory)
if(LIBC_CONF_SETJMP_AARCH64_RESTORE_PLATFORM_REGISTER)
list(APPEND setjmp_config_options "-DLIBC_COPT_SETJMP_AARCH64_RESTORE_PLATFORM_REGISTER")
endif()
There was a problem hiding this comment.
It looks like that's a flag controlled by the platform config, the top level config is here: https://github.com/llvm/llvm-project/blob/main/libc/config/config.json#L111
You can add a config.json to config/darwin with just that flag and it'll control that flag for just darwin, here's the one for baremetal as an example: https://github.com/llvm/llvm-project/blob/main/libc/config/baremetal/config.json
That way you don't have to modify the cmake to set this particular copt
|
I dont think any assembly code is needed in this patch. macOS does not require specialized asm. Th epilogue is the only different part for macOS |
libc/config/darwin/arm/config.json
Outdated
| "doc": "Avoid setjmp saving the value of x18, and longjmp restoring it. The Apple AArch64 ABI specifies that this register is reserved and should not be used" | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Please add trailing new line
libc/src/setjmp/CMakeLists.txt
Outdated
| @@ -12,6 +12,7 @@ if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${LIBC_TARGET_ARCHITECTURE}) | |||
| add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/${LIBC_TARGET_ARCHITECTURE}) | |||
| endif() | |||
|
|
|||
|
|
|||
There was a problem hiding this comment.
Undo this extra change.
AlyElashram
commented
May 23, 2025
| @@ -20,6 +20,13 @@ set(TARGET_LIBC_ENTRYPOINTS | |||
| # errno.h entrypoints | |||
| libc.src.errno.errno | |||
|
|
|||
| # setjmp.h entrypoints | |||
There was a problem hiding this comment.
One thing to note here , that the default target triple in the pipeline for MacOS has the architecture set to arm and not aarch64 , this will call the long/setjmp for arm and fail to find the sigsetjmp and siglongjmp fron my understanding.
There was a problem hiding this comment.
Yeah, that sounds like a historical issue.... I suggest we should switch everything to aarch64. Not sure how much work is required
AlyElashram
force-pushed
the
darwin-sigsetjmp-siglongjmp
branch
3 times, most recently
from
dd0aecd to
ad98ffb
Compare
…a new config.json
AlyElashram
force-pushed
the
darwin-sigsetjmp-siglongjmp
branch
from
ad98ffb to
7a02945
Compare
There was a problem hiding this comment.
Can you move
llvm-project/libc/test/src/CMakeLists.txt
Line 95 in bbe5ceb
before the full build guard?
michaelrj-google
approved these changes
Jun 11, 2025
libc/src/setjmp/CMakeLists.txt
Outdated
| @@ -43,4 +45,4 @@ if (TARGET libc.src.setjmp.sigsetjmp_epilogue) | |||
| DEPENDS | |||
| .${LIBC_TARGET_ARCHITECTURE}.sigsetjmp | |||
| ) | |||
| endif() | |||
| endif() | |||
There was a problem hiding this comment.
nit: fix missing newline
SchrodingerZhu
approved these changes
Jun 19, 2025
|
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/196/builds/9202 Here is the relevant piece of the build log for the reference |
|
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/171/builds/24251 Here is the relevant piece of the build log for the reference |
|
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/179/builds/24262 Here is the relevant piece of the build log for the reference |
|
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/131/builds/24343 Here is the relevant piece of the build log for the reference |
|
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/183/builds/14899 Here is the relevant piece of the build log for the reference |
SchrodingerZhu
pushed a commit
that referenced
this pull request
Jun 19, 2025
Fix build order issue from #139555.
llvm-sync bot
pushed a commit
to arm/arm-toolchain
that referenced
this pull request
Jun 19, 2025
Fix build order issue from llvm/llvm-project#139555.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.