Skip to content

Enable CoreCLR/tvOS build #111804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
janvorli merged 4 commits into from
Apr 29, 2025
Merged

Enable CoreCLR/tvOS build #111804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c31b58c
Enable CoreCLR/tvOS build
filipnavara Jan 24, 2025
6e6c67b
#import -> #include
filipnavara Jan 24, 2025
efadc55
Fix Linux build
filipnavara Jan 24, 2025
ab19b7a
Fix merge
filipnavara Apr 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/workflow/building/coreclr/ios.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Cross Compilation for iOS Simulator on macOS
# Cross Compilation for iOS/tvOS Simulator on macOS

## Requirements

Expand All @@ -9,7 +9,7 @@ Build requirements are the same as for building native CoreCLR on macOS. iPhone
Build the runtime pack and tools with

```
./build.sh clr+clr.runtime+libs+packs -os [iossimulator/maccatalyst] -arch [x64/arm64] -cross -c Release
./build.sh clr+clr.runtime+libs+packs -os [iossimulator/tvossimulator/maccatalyst] -arch [x64/arm64] -cross -c Release
```

## Running the sample iOS app
Expand Down
55 changes: 25 additions & 30 deletions src/coreclr/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,8 @@ if(CLR_CMAKE_HOST_UNIX)
add_linker_flag(-Wl,-z,notext)
endif()

if(NOT CLR_CMAKE_HOST_TVOS)
add_subdirectory(pal)
endif()
add_subdirectory(pal)

if(NOT CLR_CMAKE_HOST_MACCATALYST AND NOT CLR_CMAKE_HOST_IOS AND NOT CLR_CMAKE_HOST_TVOS)
add_subdirectory(hosts)
endif()
Expand Down Expand Up @@ -135,9 +134,7 @@ add_subdirectory(${CLR_SRC_NATIVE_DIR}/containers containers)
add_subdirectory(${CLR_SRC_NATIVE_DIR}/eventpipe eventpipe)
add_subdirectory(${CLR_SRC_NATIVE_DIR}/minipal shared_minipal)

if(NOT CLR_CMAKE_HOST_TVOS)
add_subdirectory(debug/debug-pal)
endif()
add_subdirectory(debug/debug-pal)

add_subdirectory(minipal)

Expand Down Expand Up @@ -273,36 +270,34 @@ if(CLR_CMAKE_HOST_UNIX)
add_subdirectory(nativeresources)
endif(CLR_CMAKE_HOST_UNIX)

if(NOT CLR_CMAKE_HOST_TVOS)
add_subdirectory(utilcode)
add_subdirectory(inc)
add_subdirectory(utilcode)
add_subdirectory(inc)

if (CLR_CMAKE_BUILD_TOOLS)
add_subdirectory(ilasm)
add_subdirectory(ildasm)
endif(CLR_CMAKE_BUILD_TOOLS)
add_subdirectory(gcinfo)
if (CLR_CMAKE_BUILD_TOOLS)
add_subdirectory(ilasm)
add_subdirectory(ildasm)
endif(CLR_CMAKE_BUILD_TOOLS)
add_subdirectory(gcinfo)

if (NOT CLR_CMAKE_TARGET_ARCH_WASM)
add_subdirectory(jit)
endif()
if (NOT CLR_CMAKE_TARGET_ARCH_WASM)
add_subdirectory(jit)
endif()

add_subdirectory(vm)
add_subdirectory(md)
add_subdirectory(vm)
add_subdirectory(md)

if (NOT CLR_CMAKE_TARGET_ARCH_WASM)
add_subdirectory(debug)
endif()
if (NOT CLR_CMAKE_TARGET_ARCH_WASM)
add_subdirectory(debug)
endif()

add_subdirectory(binder)
add_subdirectory(classlibnative)
add_subdirectory(dlls)
add_subdirectory(binder)
add_subdirectory(classlibnative)
add_subdirectory(dlls)

if (NOT CLR_CMAKE_TARGET_ARCH_WASM)
add_subdirectory(unwinder)
add_subdirectory(interop)
endif()
endif(NOT CLR_CMAKE_HOST_TVOS)
if (NOT CLR_CMAKE_TARGET_ARCH_WASM)
add_subdirectory(unwinder)
add_subdirectory(interop)
endif()

if(NOT CLR_CMAKE_HOST_MACCATALYST AND NOT CLR_CMAKE_HOST_IOS AND NOT CLR_CMAKE_HOST_TVOS)
add_subdirectory(tools)
Expand Down
2 changes: 1 addition & 1 deletion src/coreclr/dlls/mscoree/coreclr/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ endif(CLR_CMAKE_TARGET_WIN32)

# add the install targets
install_clr(TARGETS coreclr DESTINATIONS . sharedFramework COMPONENT runtime)
if(CLR_CMAKE_HOST_MACCATALYST OR CLR_CMAKE_HOST_IOS)
if(CLR_CMAKE_HOST_MACCATALYST OR CLR_CMAKE_HOST_IOS OR CLR_CMAKE_HOST_TVOS)
install_clr(TARGETS coreclr_static DESTINATIONS . sharedFramework COMPONENT runtime)
endif()

Expand Down
1 change: 1 addition & 0 deletions src/coreclr/pal/src/config.h.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
#cmakedefine01 HAVE__LWP_SELF
#cmakedefine01 HAVE_MACH_THREADS
#cmakedefine01 HAVE_MACH_EXCEPTIONS
#cmakedefine01 HAVE_SIGALTSTACK
#cmakedefine01 HAVE_VM_ALLOCATE
#cmakedefine01 HAVE_VM_READ
#cmakedefine01 HAVE_DIRECTIO
Expand Down
15 changes: 14 additions & 1 deletion src/coreclr/pal/src/configure.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,20 @@ check_function_exists(statvfs HAVE_STATVFS)
check_function_exists(thread_self HAVE_THREAD_SELF)
check_function_exists(_lwp_self HAVE__LWP_SELF)
check_function_exists(pthread_mach_thread_np HAVE_MACH_THREADS)
check_function_exists(thread_set_exception_ports HAVE_MACH_EXCEPTIONS)
check_cxx_source_compiles("
#include <mach/mach.h>
int main(int argc, char **argv) {
static mach_port_name_t port;
thread_set_exception_ports(mach_thread_self(), EXC_MASK_BAD_ACCESS, port, EXCEPTION_DEFAULT, MACHINE_THREAD_STATE);
return 0;
}" HAVE_MACH_EXCEPTIONS)
check_cxx_source_compiles("
#include <signal.h>
#include <stdlib.h>
int main(int argc, char **argv) {
sigaltstack(NULL, NULL);
return 0;
}" HAVE_SIGALTSTACK)
check_function_exists(vm_allocate HAVE_VM_ALLOCATE)
check_function_exists(vm_read HAVE_VM_READ)
check_function_exists(directio HAVE_DIRECTIO)
Expand Down
2 changes: 1 addition & 1 deletion src/coreclr/pal/src/debug/debug.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ const BOOL DBG_DETACH = FALSE;
#endif
static const char PAL_OUTPUTDEBUGSTRING[] = "PAL_OUTPUTDEBUGSTRING";

#ifdef _DEBUG
#if defined(_DEBUG) && !defined(TARGET_IOS) && !defined(TARGET_TVOS)
#define ENABLE_RUN_ON_DEBUG_BREAK 1
#endif // _DEBUG

Expand Down
6 changes: 3 additions & 3 deletions src/coreclr/pal/src/exception/seh.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,9 +304,9 @@ PAL_ERROR SEHEnable(CPalThread *pthrCurrent)
{
#if HAVE_MACH_EXCEPTIONS
return pthrCurrent->EnableMachExceptions();
#elif defined(__linux__) || defined(__FreeBSD__) || defined(__NetBSD__) || defined(__sun) || defined(__HAIKU__) || defined(__wasm__)
#elif defined(__linux__) || defined(__FreeBSD__) || defined(__NetBSD__) || defined(__sun) || defined(__HAIKU__) || defined(__APPLE__) || defined(__wasm__)
return NO_ERROR;
#else// HAVE_MACH_EXCEPTIONS
#else // HAVE_MACH_EXCEPTIONS
#error not yet implemented
#endif // HAVE_MACH_EXCEPTIONS
}
Expand All @@ -329,7 +329,7 @@ PAL_ERROR SEHDisable(CPalThread *pthrCurrent)
{
#if HAVE_MACH_EXCEPTIONS
return pthrCurrent->DisableMachExceptions();
#elif defined(__linux__) || defined(__FreeBSD__) || defined(__NetBSD__) || defined(__sun) || defined(__HAIKU__) || defined(__wasm__)
#elif defined(__linux__) || defined(__FreeBSD__) || defined(__NetBSD__) || defined(__sun) || defined(__HAIKU__) || defined(__APPLE__) || defined(__wasm__)
return NO_ERROR;
#else // HAVE_MACH_EXCEPTIONS
#error not yet implemented
Expand Down
11 changes: 10 additions & 1 deletion src/coreclr/pal/src/exception/signal.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ BOOL SEHInitializeSignals(CorUnix::CPalThread *pthrCurrent, DWORD flags)
handle_signal(SIGINT, sigint_handler, &g_previous_sigint, 0 /* additionalFlags */, true /* skipIgnored */);
handle_signal(SIGQUIT, sigquit_handler, &g_previous_sigquit, 0 /* additionalFlags */, true /* skipIgnored */);

#if HAVE_MACH_EXCEPTIONS
#if HAVE_MACH_EXCEPTIONS || !HAVE_SIGALTSTACK
handle_signal(SIGSEGV, sigsegv_handler, &g_previous_sigsegv);
#else
handle_signal(SIGTRAP, sigtrap_handler, &g_previous_sigtrap);
Expand Down Expand Up @@ -569,6 +569,7 @@ extern "C" void signal_handler_worker(int code, siginfo_t *siginfo, void *contex
RtlRestoreContext(&returnPoint->context, NULL);
}

#if HAVE_SIGALTSTACK
/*++
Function :
SwitchStackAndExecuteHandler
Expand Down Expand Up @@ -609,6 +610,7 @@ static bool SwitchStackAndExecuteHandler(int code, siginfo_t *siginfo, void *con

return pReturnPoint->returnFromHandler;
}
#endif

#endif // !HAVE_MACH_EXCEPTIONS

Expand Down Expand Up @@ -644,6 +646,10 @@ static void sigsegv_handler(int code, siginfo_t *siginfo, void *context)
{
if (GetCurrentPalThread())
{
#if defined(TARGET_TVOS)
(void)!write(STDERR_FILENO, StackOverflowMessage, sizeof(StackOverflowMessage) - 1);
PROCAbort(SIGSEGV, siginfo);
Comment on lines +650 to +651
Copy link
Member Author

@filipnavara filipnavara Jan 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This likely needs to be resolved in a different way.

Copy link
Member Author

@filipnavara filipnavara Apr 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like tvOS just cannot handle stack overflow gracefully. We probably would not even get this far.

Copy link
Member

@janvorli janvorli Apr 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think tvOS could hit this path. I assume it uses the exception port mechanism instead of signals like macOS, or am I mistaken?

Copy link
Member Author

@filipnavara filipnavara Apr 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tvOS doesn't expose Mach exceptions and neither does it expose sigaltstack. The PR basically enables the code paths for POSIX signals there without the alternative stack. Mono is using the same configuration.

Copy link
Member

@janvorli janvorli Apr 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, that's surprising, ok.

#else // TARGET_TVOS
size_t handlerStackTop = __sync_val_compare_and_swap((size_t*)&g_stackOverflowHandlerStack, (size_t)g_stackOverflowHandlerStack, 0);
if (handlerStackTop == 0)
{
Expand Down Expand Up @@ -672,6 +678,7 @@ static void sigsegv_handler(int code, siginfo_t *siginfo, void *context)
PROCAbort(SIGSEGV, siginfo);
}
(void)!write(STDERR_FILENO, StackOverflowHandlerReturnedMessage, sizeof(StackOverflowHandlerReturnedMessage) - 1);
#endif // TARGET_TVOS
}
else
{
Expand All @@ -686,6 +693,7 @@ static void sigsegv_handler(int code, siginfo_t *siginfo, void *context)
// Now that we know the SIGSEGV didn't happen due to a stack overflow, execute the common
// hardware signal handler on the original stack.

#if HAVE_SIGALTSTACK
if (GetCurrentPalThread() && IsRunningOnAlternateStack(context))
{
if (SwitchStackAndExecuteHandler(code, siginfo, context, 0 /* sp */)) // sp == 0 indicates execution on the original stack
Expand All @@ -694,6 +702,7 @@ static void sigsegv_handler(int code, siginfo_t *siginfo, void *context)
}
}
else
#endif
{
// The code flow gets here when the signal handler is not running on an alternate stack or when it wasn't created
// by coreclr. In both cases, we execute the common_signal_handler directly.
Expand Down
2 changes: 1 addition & 1 deletion src/coreclr/pal/src/include/pal/thread.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -572,7 +572,7 @@ namespace CorUnix
m_pNext = pNext;
};

#if !HAVE_MACH_EXCEPTIONS
#if !HAVE_MACH_EXCEPTIONS && HAVE_SIGALTSTACK
BOOL
EnsureSignalAlternateStack(
void
Expand Down
2 changes: 1 addition & 1 deletion src/coreclr/pal/src/init/sxs.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ AllocatePalThread(CPalThread **ppThread)
goto exit;
}

#if !HAVE_MACH_EXCEPTIONS
#if !HAVE_MACH_EXCEPTIONS && HAVE_SIGALTSTACK
// Ensure alternate stack for SIGSEGV handling. Our SIGSEGV handler is set to
// run on an alternate stack and the stack needs to be allocated per thread.
if (!pThread->EnsureSignalAlternateStack())
Expand Down
8 changes: 6 additions & 2 deletions src/coreclr/pal/src/thread/process.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -513,6 +513,9 @@ CorUnix::InternalCreateProcess(
LPPROCESS_INFORMATION lpProcessInformation
)
{
#ifdef TARGET_TVOS
return ERROR_NOT_SUPPORTED;
#else
PAL_ERROR palError = NO_ERROR;
IPalObject *pobjProcess = NULL;
IPalObject *pobjProcessRegistered = NULL;
Expand Down Expand Up @@ -1049,6 +1052,7 @@ CorUnix::InternalCreateProcess(
}

return palError;
#endif // !TARGET_TVOS
}


Expand Down Expand Up @@ -2180,7 +2184,7 @@ PROCCreateCrashDump(
INT cbErrorMessageBuffer,
bool serialize)
{
#if defined(TARGET_IOS)
#if defined(TARGET_IOS) || defined(TARGET_TVOS)
return FALSE;
#else
_ASSERTE(argv.size() > 0);
Expand Down Expand Up @@ -2310,7 +2314,7 @@ PROCCreateCrashDump(
}
}
return true;
#endif // !TARGET_IOS
#endif // !TARGET_IOS && !TARGET_TVOS
}

/*++
Expand Down
6 changes: 3 additions & 3 deletions src/coreclr/pal/src/thread/thread.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ static void InternalEndCurrentThreadWrapper(void *arg)
will lock its own critical section */
LOADCallDllMain(DLL_THREAD_DETACH, NULL);

#if !HAVE_MACH_EXCEPTIONS
#if !HAVE_MACH_EXCEPTIONS && HAVE_SIGALTSTACK
pThread->FreeSignalAlternateStack();
#endif // !HAVE_MACH_EXCEPTIONS

Expand Down Expand Up @@ -1552,7 +1552,7 @@ CPalThread::ThreadEntry(
}
#endif // HAVE_SCHED_GETAFFINITY && HAVE_SCHED_SETAFFINITY

#if !HAVE_MACH_EXCEPTIONS
#if !HAVE_MACH_EXCEPTIONS && HAVE_SIGALTSTACK
if (!pThread->EnsureSignalAlternateStack())
{
ASSERT("Cannot allocate alternate stack for SIGSEGV!\n");
Expand Down Expand Up @@ -2275,7 +2275,7 @@ CPalThread::WaitForStartStatus(
return m_fStartStatus;
}

#if !HAVE_MACH_EXCEPTIONS
#if !HAVE_MACH_EXCEPTIONS && HAVE_SIGALTSTACK
/*++
Function :
EnsureSignalAlternateStack
Expand Down