Skip to content

Commit be9de87

Browse files
ambvambv
authored
bpo-34602: Quadruple stack size on macOS when compiling with UBSAN (GH-27309)
1 parent b4b6342 commit be9de87

File tree

5 files changed

+146
-113
lines changed

5 files changed

+146
-113
lines changed

‎Misc/NEWS.d/next/macOS/2021-08-27-16-55-10.bpo-34602.ZjHsYJ.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
When building CPython on macOS with ``./configure
2+
--with-undefined-behavior-sanitizer --with-pydebug``, the stack size is now
3+
quadrupled to allow for the entire test suite to pass.

‎Python/thread_pthread.h‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,18 +32,17 @@
3232
#define THREAD_STACK_SIZE 0 /* use default stack size */
3333
#endif
3434

35-
/* The default stack size for new threads on OSX and BSD is small enough that
35+
/* The default stack size for new threads on BSD is small enough that
3636
* we'll get hard crashes instead of 'maximum recursion depth exceeded'
3737
* exceptions.
3838
*
39-
* The default stack sizes below are the empirically determined minimal stack
39+
* The default stack size below is the empirically determined minimal stack
4040
* sizes where a simple recursive function doesn't cause a hard crash.
41+
*
42+
* For macOS the value of THREAD_STACK_SIZE is determined in configure.ac
43+
* as it also depends on the other configure options like chosen sanitizer
44+
* runtimes.
4145
*/
42-
#if defined(__APPLE__) && defined(THREAD_STACK_SIZE) && THREAD_STACK_SIZE == 0
43-
#undef THREAD_STACK_SIZE
44-
/* Note: This matches the value of -Wl,-stack_size in configure.ac */
45-
#define THREAD_STACK_SIZE 0x1000000
46-
#endif
4746
#if defined(__FreeBSD__) && defined(THREAD_STACK_SIZE) && THREAD_STACK_SIZE == 0
4847
#undef THREAD_STACK_SIZE
4948
#define THREAD_STACK_SIZE 0x400000

‎configure‎

Lines changed: 81 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -827,11 +827,11 @@ with_trace_refs
827827
with_assertions
828828
enable_optimizations
829829
with_lto
830-
with_hash_algorithm
831-
with_tzpath
832830
with_address_sanitizer
833831
with_memory_sanitizer
834832
with_undefined_behavior_sanitizer
833+
with_hash_algorithm
834+
with_tzpath
835835
with_libs
836836
with_system_expat
837837
with_system_ffi
@@ -1548,12 +1548,6 @@ Optional Packages:
15481548
--with-lto=[full|thin|no|yes]
15491549
enable Link-Time-Optimization in any build (default
15501550
is no)
1551-
--with-hash-algorithm=[fnv|siphash24]
1552-
select hash algorithm for use in Python/pyhash.c
1553-
(default is SipHash24)
1554-
--with-tzpath=<list of absolute paths separated by pathsep>
1555-
Select the default time zone search path for zoneinfo.TZPATH
1556-
15571551
--with-address-sanitizer
15581552
enable AddressSanitizer memory error detector,
15591553
'asan' (default is no)
@@ -1562,6 +1556,12 @@ Optional Packages:
15621556
--with-undefined-behavior-sanitizer
15631557
enable UndefinedBehaviorSanitizer undefined
15641558
behaviour detector, 'ubsan' (default is no)
1559+
--with-hash-algorithm=[fnv|siphash24]
1560+
select hash algorithm for use in Python/pyhash.c
1561+
(default is SipHash24)
1562+
--with-tzpath=<list of absolute paths separated by pathsep>
1563+
Select the default time zone search path for zoneinfo.TZPATH
1564+
15651565
--with-libs='lib1 ...' link against additional libs (default is no)
15661566
--with-system-expat build pyexpat module using an installed expat
15671567
library, see Doc/library/pyexpat.rst (default is no)
@@ -9602,6 +9602,65 @@ $as_echo "no" >&6; }
96029602
;;
96039603
esac
96049604

9605+
{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for --with-address-sanitizer" >&5
9606+
$as_echo_n "checking for --with-address-sanitizer... " >&6; }
9607+
9608+
# Check whether --with-address_sanitizer was given.
9609+
if test "${with_address_sanitizer+set}" = set; then :
9610+
withval=$with_address_sanitizer;
9611+
{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $withval" >&5
9612+
$as_echo "$withval" >&6; }
9613+
BASECFLAGS="-fsanitize=address -fno-omit-frame-pointer $BASECFLAGS"
9614+
LDFLAGS="-fsanitize=address $LDFLAGS"
9615+
# ASan works by controlling memory allocation, our own malloc interferes.
9616+
with_pymalloc="no"
9617+
9618+
else
9619+
{ $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5
9620+
$as_echo "no" >&6; }
9621+
fi
9622+
9623+
9624+
{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for --with-memory-sanitizer" >&5
9625+
$as_echo_n "checking for --with-memory-sanitizer... " >&6; }
9626+
9627+
# Check whether --with-memory_sanitizer was given.
9628+
if test "${with_memory_sanitizer+set}" = set; then :
9629+
withval=$with_memory_sanitizer;
9630+
{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $withval" >&5
9631+
$as_echo "$withval" >&6; }
9632+
BASECFLAGS="-fsanitize=memory -fsanitize-memory-track-origins=2 -fno-omit-frame-pointer $BASECFLAGS"
9633+
LDFLAGS="-fsanitize=memory -fsanitize-memory-track-origins=2 $LDFLAGS"
9634+
# MSan works by controlling memory allocation, our own malloc interferes.
9635+
with_pymalloc="no"
9636+
9637+
else
9638+
{ $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5
9639+
$as_echo "no" >&6; }
9640+
fi
9641+
9642+
9643+
{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for --with-undefined-behavior-sanitizer" >&5
9644+
$as_echo_n "checking for --with-undefined-behavior-sanitizer... " >&6; }
9645+
9646+
# Check whether --with-undefined_behavior_sanitizer was given.
9647+
if test "${with_undefined_behavior_sanitizer+set}" = set; then :
9648+
withval=$with_undefined_behavior_sanitizer;
9649+
{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $withval" >&5
9650+
$as_echo "$withval" >&6; }
9651+
BASECFLAGS="-fsanitize=undefined $BASECFLAGS"
9652+
LDFLAGS="-fsanitize=undefined $LDFLAGS"
9653+
with_ubsan="yes"
9654+
9655+
else
9656+
9657+
{ $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5
9658+
$as_echo "no" >&6; }
9659+
with_ubsan="no"
9660+
9661+
fi
9662+
9663+
96059664
# Set info about shared libraries.
96069665

96079666

@@ -9812,9 +9871,20 @@ then
98129871
# Issue #18075: the default maximum stack size (8MBytes) is too
98139872
# small for the default recursion limit. Increase the stack size
98149873
# to ensure that tests don't crash
9815-
# Note: This matches the value of THREAD_STACK_SIZE in
9816-
# thread_pthread.h
9817-
LINKFORSHARED="-Wl,-stack_size,1000000 $LINKFORSHARED"
9874+
stack_size="1000000" # 16 MB
9875+
if test "$with_ubsan" == "yes"
9876+
then
9877+
# Undefined behavior sanitizer requires an even deeper stack
9878+
stack_size="4000000" # 64 MB
9879+
fi
9880+
9881+
LINKFORSHARED="-Wl,-stack_size,$stack_size $LINKFORSHARED"
9882+
9883+
9884+
cat >>confdefs.h <<_ACEOF
9885+
#define THREAD_STACK_SIZE 0x$stack_size
9886+
_ACEOF
9887+
98189888

98199889
if test "$enable_framework"
98209890
then
@@ -10410,61 +10480,6 @@ fi
1041010480

1041110481

1041210482

10413-
{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for --with-address-sanitizer" >&5
10414-
$as_echo_n "checking for --with-address-sanitizer... " >&6; }
10415-
10416-
# Check whether --with-address_sanitizer was given.
10417-
if test "${with_address_sanitizer+set}" = set; then :
10418-
withval=$with_address_sanitizer;
10419-
{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $withval" >&5
10420-
$as_echo "$withval" >&6; }
10421-
BASECFLAGS="-fsanitize=address -fno-omit-frame-pointer $BASECFLAGS"
10422-
LDFLAGS="-fsanitize=address $LDFLAGS"
10423-
# ASan works by controlling memory allocation, our own malloc interferes.
10424-
with_pymalloc="no"
10425-
10426-
else
10427-
{ $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5
10428-
$as_echo "no" >&6; }
10429-
fi
10430-
10431-
10432-
{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for --with-memory-sanitizer" >&5
10433-
$as_echo_n "checking for --with-memory-sanitizer... " >&6; }
10434-
10435-
# Check whether --with-memory_sanitizer was given.
10436-
if test "${with_memory_sanitizer+set}" = set; then :
10437-
withval=$with_memory_sanitizer;
10438-
{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $withval" >&5
10439-
$as_echo "$withval" >&6; }
10440-
BASECFLAGS="-fsanitize=memory -fsanitize-memory-track-origins=2 -fno-omit-frame-pointer $BASECFLAGS"
10441-
LDFLAGS="-fsanitize=memory -fsanitize-memory-track-origins=2 $LDFLAGS"
10442-
# MSan works by controlling memory allocation, our own malloc interferes.
10443-
with_pymalloc="no"
10444-
10445-
else
10446-
{ $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5
10447-
$as_echo "no" >&6; }
10448-
fi
10449-
10450-
10451-
{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for --with-undefined-behavior-sanitizer" >&5
10452-
$as_echo_n "checking for --with-undefined-behavior-sanitizer... " >&6; }
10453-
10454-
# Check whether --with-undefined_behavior_sanitizer was given.
10455-
if test "${with_undefined_behavior_sanitizer+set}" = set; then :
10456-
withval=$with_undefined_behavior_sanitizer;
10457-
{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $withval" >&5
10458-
$as_echo "$withval" >&6; }
10459-
BASECFLAGS="-fsanitize=undefined $BASECFLAGS"
10460-
LDFLAGS="-fsanitize=undefined $LDFLAGS"
10461-
10462-
else
10463-
{ $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5
10464-
$as_echo "no" >&6; }
10465-
fi
10466-
10467-
1046810483
# Most SVR4 platforms (e.g. Solaris) need -lsocket and -lnsl.
1046910484
{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for t_open in -lnsl" >&5
1047010485
$as_echo_n "checking for t_open in -lnsl... " >&6; }

‎configure.ac‎

Lines changed: 53 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -2595,6 +2595,47 @@ case $ac_sys_system/$ac_sys_release in
25952595
;;
25962596
esac
25972597

2598+
AC_MSG_CHECKING(for --with-address-sanitizer)
2599+
AC_ARG_WITH(address_sanitizer,
2600+
AS_HELP_STRING([--with-address-sanitizer],
2601+
[enable AddressSanitizer memory error detector, 'asan' (default is no)]),
2602+
[
2603+
AC_MSG_RESULT($withval)
2604+
BASECFLAGS="-fsanitize=address -fno-omit-frame-pointer $BASECFLAGS"
2605+
LDFLAGS="-fsanitize=address $LDFLAGS"
2606+
# ASan works by controlling memory allocation, our own malloc interferes.
2607+
with_pymalloc="no"
2608+
],
2609+
[AC_MSG_RESULT(no)])
2610+
2611+
AC_MSG_CHECKING(for --with-memory-sanitizer)
2612+
AC_ARG_WITH(memory_sanitizer,
2613+
AS_HELP_STRING([--with-memory-sanitizer],
2614+
[enable MemorySanitizer allocation error detector, 'msan' (default is no)]),
2615+
[
2616+
AC_MSG_RESULT($withval)
2617+
BASECFLAGS="-fsanitize=memory -fsanitize-memory-track-origins=2 -fno-omit-frame-pointer $BASECFLAGS"
2618+
LDFLAGS="-fsanitize=memory -fsanitize-memory-track-origins=2 $LDFLAGS"
2619+
# MSan works by controlling memory allocation, our own malloc interferes.
2620+
with_pymalloc="no"
2621+
],
2622+
[AC_MSG_RESULT(no)])
2623+
2624+
AC_MSG_CHECKING(for --with-undefined-behavior-sanitizer)
2625+
AC_ARG_WITH(undefined_behavior_sanitizer,
2626+
AS_HELP_STRING([--with-undefined-behavior-sanitizer],
2627+
[enable UndefinedBehaviorSanitizer undefined behaviour detector, 'ubsan' (default is no)]),
2628+
[
2629+
AC_MSG_RESULT($withval)
2630+
BASECFLAGS="-fsanitize=undefined $BASECFLAGS"
2631+
LDFLAGS="-fsanitize=undefined $LDFLAGS"
2632+
with_ubsan="yes"
2633+
],
2634+
[
2635+
AC_MSG_RESULT(no)
2636+
with_ubsan="no"
2637+
])
2638+
25982639
# Set info about shared libraries.
25992640
AC_SUBST(SHLIB_SUFFIX)
26002641
AC_SUBST(LDSHARED)
@@ -2798,9 +2839,18 @@ then
27982839
# Issue #18075: the default maximum stack size (8MBytes) is too
27992840
# small for the default recursion limit. Increase the stack size
28002841
# to ensure that tests don't crash
2801-
# Note: This matches the value of THREAD_STACK_SIZE in
2802-
# thread_pthread.h
2803-
LINKFORSHARED="-Wl,-stack_size,1000000 $LINKFORSHARED"
2842+
stack_size="1000000" # 16 MB
2843+
if test "$with_ubsan" == "yes"
2844+
then
2845+
# Undefined behavior sanitizer requires an even deeper stack
2846+
stack_size="4000000" # 64 MB
2847+
fi
2848+
2849+
LINKFORSHARED="-Wl,-stack_size,$stack_size $LINKFORSHARED"
2850+
2851+
AC_DEFINE_UNQUOTED(THREAD_STACK_SIZE,
2852+
0x$stack_size,
2853+
[Custom thread stack size depending on chosen sanitizer runtimes.])
28042854

28052855
if test "$enable_framework"
28062856
then
@@ -3044,43 +3094,6 @@ esac
30443094
AC_MSG_RESULT("$TZPATH")])
30453095
AC_SUBST(TZPATH)
30463096

3047-
AC_MSG_CHECKING(for --with-address-sanitizer)
3048-
AC_ARG_WITH(address_sanitizer,
3049-
AS_HELP_STRING([--with-address-sanitizer],
3050-
[enable AddressSanitizer memory error detector, 'asan' (default is no)]),
3051-
[
3052-
AC_MSG_RESULT($withval)
3053-
BASECFLAGS="-fsanitize=address -fno-omit-frame-pointer $BASECFLAGS"
3054-
LDFLAGS="-fsanitize=address $LDFLAGS"
3055-
# ASan works by controlling memory allocation, our own malloc interferes.
3056-
with_pymalloc="no"
3057-
],
3058-
[AC_MSG_RESULT(no)])
3059-
3060-
AC_MSG_CHECKING(for --with-memory-sanitizer)
3061-
AC_ARG_WITH(memory_sanitizer,
3062-
AS_HELP_STRING([--with-memory-sanitizer],
3063-
[enable MemorySanitizer allocation error detector, 'msan' (default is no)]),
3064-
[
3065-
AC_MSG_RESULT($withval)
3066-
BASECFLAGS="-fsanitize=memory -fsanitize-memory-track-origins=2 -fno-omit-frame-pointer $BASECFLAGS"
3067-
LDFLAGS="-fsanitize=memory -fsanitize-memory-track-origins=2 $LDFLAGS"
3068-
# MSan works by controlling memory allocation, our own malloc interferes.
3069-
with_pymalloc="no"
3070-
],
3071-
[AC_MSG_RESULT(no)])
3072-
3073-
AC_MSG_CHECKING(for --with-undefined-behavior-sanitizer)
3074-
AC_ARG_WITH(undefined_behavior_sanitizer,
3075-
AS_HELP_STRING([--with-undefined-behavior-sanitizer],
3076-
[enable UndefinedBehaviorSanitizer undefined behaviour detector, 'ubsan' (default is no)]),
3077-
[
3078-
AC_MSG_RESULT($withval)
3079-
BASECFLAGS="-fsanitize=undefined $BASECFLAGS"
3080-
LDFLAGS="-fsanitize=undefined $LDFLAGS"
3081-
],
3082-
[AC_MSG_RESULT(no)])
3083-
30843097
# Most SVR4 platforms (e.g. Solaris) need -lsocket and -lnsl.
30853098
AC_CHECK_LIB(nsl, t_open, [LIBS="-lnsl $LIBS"]) # SVR4
30863099
AC_CHECK_LIB(socket, socket, [LIBS="-lsocket $LIBS"], [], $LIBS) # SVR4 sockets

‎pyconfig.h.in‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1509,6 +1509,9 @@
15091509
(which you can't on SCO ODT 3.0). */
15101510
#undef SYS_SELECT_WITH_SYS_TIME
15111511

1512+
/* Custom thread stack size depending on chosen sanitizer runtimes. */
1513+
#undef THREAD_STACK_SIZE
1514+
15121515
/* Library needed by timemodule.c: librt may be needed for clock_gettime() */
15131516
#undef TIMEMODULE_LIB
15141517

0 commit comments

Comments
 (0)