- rediff patch

[packages/ocaml.git] / ocaml-10266.patch

From 632563b19ca72ec0ae10c7ed767a025c342d3155 Mon Sep 17 00:00:00 2001
From: Xavier Leroy <xavier.leroy@college-de-france.fr>
Date: Tue, 2 Mar 2021 19:06:56 +0100
Subject: [PATCH 1/3] Dynamically allocate the alternate signal stack

In Glibc 2.34 and later, SIGSTKSZ may not be a compile-time constant.
It is no longer possible to statically allocate the alternate signal
stack for the main thread, as we've been doing for the last 25 years.

This commit implements dynamic allocation of the alternate signal stack
even for the main thread.  It reuses the code already in place to allocate
the alternate signal stack for other threads.

Fixes: #10250.
---
 runtime/caml/signals.h |  2 +-
 runtime/signals_byt.c  |  2 +-
 runtime/signals_nat.c  | 25 ++++++++++++++-----------
 3 files changed, 16 insertions(+), 13 deletions(-)

diff -urNp -x '*.orig' ocaml-4.12.0.org/Changes ocaml-4.12.0/Changes
--- ocaml-4.12.0.org/Changes	2021-02-24 14:49:29.000000000 +0100
+++ ocaml-4.12.0/Changes	2021-11-21 10:33:11.184661387 +0100
@@ -276,6 +276,11 @@ OCaml 4.12.0 (24 February 2021)
 - #10062: set ARCH_INT64_PRINTF_FORMAT correctly for both modes of mingw-w64
   (David Allsopp, review by Xavier Leroy)
 
+- #10250, #10266: Dynamically allocate alternate signal stacks to
+   accommodate changes in Glibc 2.34.
+  (Xavier Leroy, reports by Tomasz Kłoczko and R.W.M. Jones, review by Anil
+   Madhavapeddy, Stephen Dolan, and Florian Angeletti)
+
 ### Code generation and optimizations:
 
 - #9551: ocamlc no longer loads DLLs at link time to check that
diff -urNp -x '*.orig' ocaml-4.12.0.org/runtime/caml/signals.h ocaml-4.12.0/runtime/caml/signals.h
--- ocaml-4.12.0.org/runtime/caml/signals.h	2021-02-24 14:49:29.000000000 +0100
+++ ocaml-4.12.0/runtime/caml/signals.h	2021-11-21 10:33:11.184661387 +0100
@@ -87,7 +87,7 @@ value caml_do_pending_actions_exn (void)
 value caml_process_pending_actions_with_root (value extra_root); // raises
 value caml_process_pending_actions_with_root_exn (value extra_root);
 int caml_set_signal_action(int signo, int action);
-CAMLextern void caml_setup_stack_overflow_detection(void);
+CAMLextern int caml_setup_stack_overflow_detection(void);
 
 CAMLextern void (*caml_enter_blocking_section_hook)(void);
 CAMLextern void (*caml_leave_blocking_section_hook)(void);
diff -urNp -x '*.orig' ocaml-4.12.0.org/runtime/signals_byt.c ocaml-4.12.0/runtime/signals_byt.c
--- ocaml-4.12.0.org/runtime/signals_byt.c	2021-02-24 14:49:29.000000000 +0100
+++ ocaml-4.12.0/runtime/signals_byt.c	2021-11-21 10:33:11.184661387 +0100
@@ -81,4 +81,4 @@ int caml_set_signal_action(int signo, in
     return 0;
 }
 
-CAMLexport void caml_setup_stack_overflow_detection(void) {}
+CAMLexport int caml_setup_stack_overflow_detection(void) { return 0; }
diff -urNp -x '*.orig' ocaml-4.12.0.org/runtime/signals_nat.c ocaml-4.12.0/runtime/signals_nat.c
--- ocaml-4.12.0.org/runtime/signals_nat.c	2021-02-24 14:49:29.000000000 +0100
+++ ocaml-4.12.0/runtime/signals_nat.c	2021-11-21 10:33:11.184661387 +0100
@@ -181,8 +181,6 @@ DECLARE_SIGNAL_HANDLER(trap_handler)
 #error "CONTEXT_SP is required if HAS_STACK_OVERFLOW_DETECTION is defined"
 #endif
 
-static char sig_alt_stack[SIGSTKSZ];
-
 /* Code compiled with ocamlopt never accesses more than
    EXTRA_STACK bytes below the stack pointer. */
 #define EXTRA_STACK 256
@@ -276,28 +274,33 @@ void caml_init_signals(void)
 #endif
 
 #ifdef HAS_STACK_OVERFLOW_DETECTION
-  {
-    stack_t stk;
+  if (caml_setup_stack_overflow_detection() != -1) {
     struct sigaction act;
-    stk.ss_sp = sig_alt_stack;
-    stk.ss_size = SIGSTKSZ;
-    stk.ss_flags = 0;
     SET_SIGACT(act, segv_handler);
     act.sa_flags |= SA_ONSTACK | SA_NODEFER;
     sigemptyset(&act.sa_mask);
-    if (sigaltstack(&stk, NULL) == 0) { sigaction(SIGSEGV, &act, NULL); }
+    sigaction(SIGSEGV, &act, NULL);
   }
 #endif
 }
 
-CAMLexport void caml_setup_stack_overflow_detection(void)
+/* Allocate and select an alternate stack for handling signals,
+   especially SIGSEGV signals.
+   Each thread needs its own alternate stack.
+   The alternate stack used to be statically-allocated for the main thread,
+   but this is incompatible with Glibc 2.34 and newer, where SIGSTKSZ
+   may not be a compile-time constant (issue #10250). */
+
+CAMLexport int caml_setup_stack_overflow_detection(void)
 {
 #ifdef HAS_STACK_OVERFLOW_DETECTION
   stack_t stk;
   stk.ss_sp = malloc(SIGSTKSZ);
+  if (stk.ss_sp == NULL) return -1;
   stk.ss_size = SIGSTKSZ;
   stk.ss_flags = 0;
-  if (stk.ss_sp)
-    sigaltstack(&stk, NULL);
+  return sigaltstack(&stk, NULL);
+#else
+  return 0;
 #endif
 }