1 # threadlib.m4 serial 28
2 dnl Copyright (C) 2005-2020 Free Software Foundation, Inc.
3 dnl This file is free software; the Free Software Foundation
4 dnl gives unlimited permission to copy and/or distribute it,
5 dnl with or without modifications, as long as this notice is preserved.
11 dnl The general structure of the multithreading modules in gnulib is that we
12 dnl have three set of modules:
15 dnl pthread, which combines
27 dnl threads, which combines
34 dnl * Gnulib API, with an implementation that can be chosen at configure
35 dnl time through the option --enable-threads=...
42 dnl They are independent, except for the fact that
43 dnl - the implementation of the ISO C API may use the POSIX (or some other
44 dnl platform dependent) API,
45 dnl - the implementation of the Gnulib API may use the POSIX or ISO C or
46 dnl some other platform dependent API, depending on the --enable-threads
49 dnl This file contains macros for all of these APIs!
51 dnl ============================================================================
52 dnl Macros for all thread APIs
54 AC_DEFUN([gl_ANYTHREADLIB_EARLY],
56 AC_REQUIRE([AC_CANONICAL_HOST])
57 if test -z "$gl_anythreadlib_early_done"; then
60 # On OSF/1, the compiler needs the flag -D_REENTRANT so that it
61 # groks <pthread.h>. cc also understands the flag -pthread, but
62 # we don't use it because 1. gcc-2.95 doesn't understand -pthread,
63 # 2. putting a flag into CPPFLAGS that has an effect on the linker
64 # causes the AC_LINK_IFELSE test below to succeed unexpectedly,
65 # leading to wrong values of LIBTHREAD and LTLIBTHREAD.
66 CPPFLAGS="$CPPFLAGS -D_REENTRANT"
69 # Some systems optimize for single-threaded programs by default, and
70 # need special flags to disable these optimizations. For example, the
71 # definition of 'errno' in <errno.h>.
73 aix* | freebsd*) CPPFLAGS="$CPPFLAGS -D_THREAD_SAFE" ;;
74 solaris*) CPPFLAGS="$CPPFLAGS -D_REENTRANT" ;;
76 gl_anythreadlib_early_done=done
80 dnl Checks whether the compiler and linker support weak declarations of symbols.
82 AC_DEFUN([gl_WEAK_SYMBOLS],
84 AC_REQUIRE([AC_CANONICAL_HOST])
85 AC_CACHE_CHECK([whether imported symbols can be declared weak],
88 dnl First, test whether the compiler accepts it syntactically.
91 [[extern void xyzzy ();
94 [gl_cv_have_weak=maybe])
95 if test $gl_cv_have_weak = maybe; then
96 dnl Second, test whether it actually works. On Cygwin 1.7.2, with
97 dnl gcc 4.3, symbols declared weak always evaluate to the address 0.
104 return (fputs == NULL);
106 [gl_cv_have_weak=yes],
107 [gl_cv_have_weak=no],
108 [dnl When cross-compiling, assume that only ELF platforms support
110 AC_EGREP_CPP([Extensible Linking Format],
112 Extensible Linking Format
115 [gl_cv_have_weak="guessing yes"],
116 [gl_cv_have_weak="guessing no"])
119 dnl But when linking statically, weak symbols don't work.
121 *" -static "*) gl_cv_have_weak=no ;;
123 dnl Test for a bug in FreeBSD 11: A link error occurs when using a weak
124 dnl symbol and linking against a shared library that has a dependency on
125 dnl the shared library that defines the symbol.
126 case "$gl_cv_have_weak" in
129 freebsd* | dragonfly*)
131 $CC $CPPFLAGS $CFLAGS $LDFLAGS -fPIC -shared -o libempty.so conftest1.c -lpthread >&AS_MESSAGE_LOG_FD 2>&1
132 cat <<EOF > conftest2.c
134 #pragma weak pthread_mutexattr_gettype
137 return (pthread_mutexattr_gettype != NULL);
140 $CC $CPPFLAGS $CFLAGS $LDFLAGS -o conftest conftest2.c libempty.so >&AS_MESSAGE_LOG_FD 2>&1 \
141 || gl_cv_have_weak=no
142 rm -f conftest1.c libempty.so conftest2.c conftest
148 case "$gl_cv_have_weak" in
150 AC_DEFINE([HAVE_WEAK_SYMBOLS], [1],
151 [Define to 1 if the compiler and linker support weak declarations of symbols.])
156 dnl ============================================================================
157 dnl Macros for the POSIX API
161 dnl Tests for the libraries needs for using the POSIX threads API.
162 dnl Sets the variable LIBPTHREAD to the linker options for use in a Makefile.
163 dnl Sets the variable LIBPMULTITHREAD, for programs that really need
164 dnl multithread functionality. The difference between LIBPTHREAD and
165 dnl LIBPMULTITHREAD is that on platforms supporting weak symbols, typically
166 dnl LIBPTHREAD is empty whereas LIBPMULTITHREAD is not.
167 dnl Sets the variable LIB_SCHED_YIELD to the linker options needed to use the
168 dnl sched_yield() function.
169 dnl Adds to CPPFLAGS the flag -D_REENTRANT or -D_THREAD_SAFE if needed for
170 dnl multithread-safe programs.
171 dnl Defines the C macro HAVE_PTHREAD_API if (at least parts of) the POSIX
172 dnl threads API is available.
174 dnl The guts of gl_PTHREADLIB. Needs to be expanded only once.
176 AC_DEFUN([gl_PTHREADLIB_BODY],
178 AC_REQUIRE([gl_ANYTHREADLIB_EARLY])
179 if test -z "$gl_pthreadlib_body_done"; then
183 # On OSF/1, the compiler needs the flag -pthread or -D_REENTRANT so that
184 # it groks <pthread.h>. It's added above, in gl_ANYTHREADLIB_EARLY.
185 AC_CHECK_HEADER([pthread.h],
186 [gl_have_pthread_h=yes], [gl_have_pthread_h=no])
187 if test "$gl_have_pthread_h" = yes; then
188 # Other possible tests:
189 # -lpthreads (FSU threads, PCthreads)
191 # Test whether both pthread_mutex_lock and pthread_mutexattr_init exist
192 # in libc. IRIX 6.5 has the first one in both libc and libpthread, but
193 # the second one only in libpthread, and lock.c needs it.
195 # If -pthread works, prefer it to -lpthread, since Ubuntu 14.04
196 # needs -pthread for some reason. See:
197 # https://lists.gnu.org/r/bug-gnulib/2014-09/msg00023.html
199 for gl_pthread in '' '-pthread'; do
200 LIBS="$LIBS $gl_pthread"
203 [[#include <pthread.h>
205 pthread_mutexattr_t ma;
207 [[pthread_mutex_lock (&m);
208 pthread_mutexattr_init (&ma);]])],
210 LIBPTHREAD=$gl_pthread
211 LIBPMULTITHREAD=$gl_pthread])
213 test $gl_pthread_api = yes && break
216 # Test for libpthread by looking for pthread_kill. (Not pthread_self,
217 # since it is defined as a macro on OSF/1.)
218 if test $gl_pthread_api = yes && test -z "$LIBPTHREAD"; then
219 # The program links fine without libpthread. But it may actually
220 # need to link with libpthread in order to create multiple threads.
221 AC_CHECK_LIB([pthread], [pthread_kill],
222 [LIBPMULTITHREAD=-lpthread
223 # On Solaris and HP-UX, most pthread functions exist also in libc.
224 # Therefore pthread_in_use() needs to actually try to create a
225 # thread: pthread_create from libc will fail, whereas
226 # pthread_create will actually create a thread.
227 # On Solaris 10 or newer, this test is no longer needed, because
228 # libc contains the fully functional pthread functions.
230 solaris | solaris2.[1-9] | solaris2.[1-9].* | hpux*)
231 AC_DEFINE([PTHREAD_IN_USE_DETECTION_HARD], [1],
232 [Define if the pthread_in_use() detection is hard.])
235 elif test $gl_pthread_api != yes; then
236 # Some library is needed. Try libpthread and libc_r.
237 AC_CHECK_LIB([pthread], [pthread_kill],
240 LIBPMULTITHREAD=-lpthread])
241 if test $gl_pthread_api != yes; then
243 AC_CHECK_LIB([c_r], [pthread_kill],
246 LIBPMULTITHREAD=-lc_r])
250 AC_MSG_CHECKING([whether POSIX threads API is available])
251 AC_MSG_RESULT([$gl_pthread_api])
252 AC_SUBST([LIBPTHREAD])
253 AC_SUBST([LIBPMULTITHREAD])
254 if test $gl_pthread_api = yes; then
255 AC_DEFINE([HAVE_PTHREAD_API], [1],
256 [Define if you have the <pthread.h> header and the POSIX threads API.])
259 dnl On some systems, sched_yield is in librt, rather than in libpthread.
262 [[#include <sched.h>]],
263 [[sched_yield ();]])],
266 [dnl Solaris 7...10 has sched_yield in librt, not in libpthread or libc.
267 AC_CHECK_LIB([rt], [sched_yield], [LIB_SCHED_YIELD=-lrt],
268 [dnl Solaris 2.5.1, 2.6 has sched_yield in libposix4, not librt.
269 AC_CHECK_LIB([posix4], [sched_yield], [LIB_SCHED_YIELD=-lposix4])])
271 AC_SUBST([LIB_SCHED_YIELD])
273 gl_pthreadlib_body_done=done
277 AC_DEFUN([gl_PTHREADLIB],
279 AC_REQUIRE([gl_ANYTHREADLIB_EARLY])
283 dnl ============================================================================
284 dnl Macros for the ISO C API
288 dnl Tests for the libraries needs for using the ISO C threads API.
289 dnl Sets the variable LIBSTDTHREAD to the linker options for use in a Makefile.
290 dnl Adds to CPPFLAGS the flag -D_REENTRANT or -D_THREAD_SAFE if needed for
291 dnl multithread-safe programs.
292 dnl Defines the C macro HAVE_THREADS_H if (at least parts of) the ISO C threads
293 dnl API is available.
295 dnl The guts of gl_STDTHREADLIB. Needs to be expanded only once.
297 AC_DEFUN([gl_STDTHREADLIB_BODY],
299 AC_REQUIRE([gl_ANYTHREADLIB_EARLY])
300 AC_REQUIRE([AC_CANONICAL_HOST])
301 if test -z "$gl_stdthreadlib_body_done"; then
302 AC_CHECK_HEADERS_ONCE([threads.h])
310 if test $ac_cv_header_threads_h = yes; then
311 dnl glibc >= 2.29 has thrd_create in libpthread.
312 dnl FreeBSD >= 10 has thrd_create in libstdthreads; this library depends
313 dnl on libpthread (for the symbol 'pthread_mutexattr_gettype').
314 dnl AIX >= 7.1 and Solaris >= 11.4 have thrd_create in libc.
315 AC_CHECK_FUNCS([thrd_create])
316 if test $ac_cv_func_thrd_create = yes; then
319 AC_CHECK_LIB([stdthreads], [thrd_create], [
320 LIBSTDTHREAD='-lstdthreads -lpthread'
322 dnl Guess that thrd_create is in libpthread.
323 LIBSTDTHREAD="$LIBPMULTITHREAD"
327 dnl Libraries needed by thrd.c, mtx.c, cnd.c, tss.c.
328 LIBSTDTHREAD="$LIBPMULTITHREAD $LIB_SCHED_YIELD"
332 AC_SUBST([LIBSTDTHREAD])
334 AC_MSG_CHECKING([whether ISO C threads API is available])
335 AC_MSG_RESULT([$ac_cv_header_threads_h])
336 gl_stdthreadlib_body_done=done
340 AC_DEFUN([gl_STDTHREADLIB],
342 AC_REQUIRE([gl_ANYTHREADLIB_EARLY])
346 dnl ============================================================================
347 dnl Macros for the Gnulib API
351 dnl Tests for a multithreading library to be used.
352 dnl If the configure.ac contains a definition of the gl_THREADLIB_DEFAULT_NO
353 dnl (it must be placed before the invocation of gl_THREADLIB_EARLY!), then the
354 dnl default is 'no', otherwise it is system dependent. In both cases, the user
355 dnl can change the choice through the options --enable-threads=choice or
356 dnl --disable-threads.
357 dnl Defines at most one of the macros USE_ISOC_THREADS, USE_POSIX_THREADS,
358 dnl USE_ISOC_AND_POSIX_THREADS, USE_WINDOWS_THREADS.
359 dnl The choice --enable-threads=isoc+posix is available only on platforms that
360 dnl have both the ISO C and the POSIX threads APIs. It has the effect of using
361 dnl the ISO C API for most things and the POSIX API only for creating and
362 dnl controlling threads (because there is no equivalent to pthread_atfork in
364 dnl Sets the variables LIBTHREAD and LTLIBTHREAD to the linker options for use
365 dnl in a Makefile (LIBTHREAD for use without libtool, LTLIBTHREAD for use with
367 dnl Sets the variables LIBMULTITHREAD and LTLIBMULTITHREAD similarly, for
368 dnl programs that really need multithread functionality. The difference
369 dnl between LIBTHREAD and LIBMULTITHREAD is that on platforms supporting weak
370 dnl symbols, typically LIBTHREAD is empty whereas LIBMULTITHREAD is not.
371 dnl Adds to CPPFLAGS the flag -D_REENTRANT or -D_THREAD_SAFE if needed for
372 dnl multithread-safe programs.
373 dnl Since support for GNU pth was removed, $LTLIBTHREAD and $LIBTHREAD have the
374 dnl same value, and similarly $LTLIBMULTITHREAD and $LIBMULTITHREAD have the
375 dnl same value. Only system libraries are needed.
377 AC_DEFUN([gl_THREADLIB_EARLY],
379 AC_REQUIRE([gl_THREADLIB_EARLY_BODY])
382 dnl The guts of gl_THREADLIB_EARLY. Needs to be expanded only once.
384 AC_DEFUN([gl_THREADLIB_EARLY_BODY],
386 dnl Ordering constraints: This macro modifies CPPFLAGS in a way that
387 dnl influences the result of the autoconf tests that test for *_unlocked
388 dnl declarations, on AIX 5 at least. Therefore it must come early.
389 AC_BEFORE([$0], [gl_FUNC_GLIBC_UNLOCKED_IO])dnl
390 AC_BEFORE([$0], [gl_ARGP])dnl
392 AC_REQUIRE([AC_CANONICAL_HOST])
393 dnl _GNU_SOURCE is needed for pthread_rwlock_t on glibc systems.
394 AC_REQUIRE([AC_USE_SYSTEM_EXTENSIONS])
395 dnl Check for multithreading.
396 m4_ifdef([gl_THREADLIB_DEFAULT_NO],
397 [m4_divert_text([DEFAULTS], [gl_use_threads_default=no])],
398 [m4_divert_text([DEFAULTS], [gl_use_threads_default=])])
399 m4_divert_text([DEFAULTS], [gl_use_winpthreads_default=])
400 AC_ARG_ENABLE([threads],
401 AS_HELP_STRING([--enable-threads={isoc|posix|isoc+posix|windows}], [specify multithreading API])m4_ifdef([gl_THREADLIB_DEFAULT_NO], [], [
402 AS_HELP_STRING([--disable-threads], [build without multithread safety])]),
403 [gl_use_threads=$enableval],
404 [if test -n "$gl_use_threads_default"; then
405 gl_use_threads="$gl_use_threads_default"
409 dnl Disable multithreading by default on OSF/1, because it interferes
410 dnl with fork()/exec(): When msgexec is linked with -lpthread, its
411 dnl child process gets an endless segmentation fault inside execvp().
412 osf*) gl_use_threads=no ;;
413 dnl Disable multithreading by default on Cygwin 1.5.x, because it has
414 dnl bugs that lead to endless loops or crashes. See
415 dnl <https://cygwin.com/ml/cygwin/2009-08/msg00283.html>.
418 1.[0-5].*) gl_use_threads=no ;;
419 *) gl_use_threads=yes ;;
422 dnl Obey gl_AVOID_WINPTHREAD on mingw.
424 case "$gl_use_winpthreads_default" in
425 yes) gl_use_threads=posix ;;
426 no) gl_use_threads=windows ;;
427 *) gl_use_threads=yes ;;
430 *) gl_use_threads=yes ;;
435 if test "$gl_use_threads" = yes \
436 || test "$gl_use_threads" = isoc \
437 || test "$gl_use_threads" = posix \
438 || test "$gl_use_threads" = isoc+posix; then
439 # For using <threads.h> or <pthread.h>:
440 gl_ANYTHREADLIB_EARLY
444 dnl The guts of gl_THREADLIB. Needs to be expanded only once.
446 AC_DEFUN([gl_THREADLIB_BODY],
448 AC_REQUIRE([gl_THREADLIB_EARLY_BODY])
454 if test "$gl_use_threads" != no; then
455 dnl Check whether the compiler and linker support weak declarations.
457 if case "$gl_cv_have_weak" in *yes) true;; *) false;; esac; then
458 dnl If we use weak symbols to implement pthread_in_use / pth_in_use /
459 dnl thread_in_use, we also need to test whether the ISO C 11 thrd_create
460 dnl facility is in use.
461 AC_CHECK_HEADERS_ONCE([threads.h])
464 if test "$gl_use_threads" = isoc || test "$gl_use_threads" = isoc+posix; then
465 AC_CHECK_HEADERS_ONCE([threads.h])
466 gl_have_isoc_threads="$ac_cv_header_threads_h"
468 if test "$gl_use_threads" = yes \
469 || test "$gl_use_threads" = posix \
470 || test "$gl_use_threads" = isoc+posix; then
472 LIBTHREAD=$LIBPTHREAD LTLIBTHREAD=$LIBPTHREAD
473 LIBMULTITHREAD=$LIBPMULTITHREAD LTLIBMULTITHREAD=$LIBPMULTITHREAD
474 if test $gl_pthread_api = yes; then
475 if test "$gl_use_threads" = isoc+posix && test "$gl_have_isoc_threads" = yes; then
476 gl_threads_api='isoc+posix'
477 AC_DEFINE([USE_ISOC_AND_POSIX_THREADS], [1],
478 [Define if the combination of the ISO C and POSIX multithreading APIs can be used.])
479 LIBTHREAD= LTLIBTHREAD=
482 AC_DEFINE([USE_POSIX_THREADS], [1],
483 [Define if the POSIX multithreading library can be used.])
484 if test -n "$LIBMULTITHREAD" || test -n "$LTLIBMULTITHREAD"; then
485 if case "$gl_cv_have_weak" in *yes) true;; *) false;; esac; then
486 AC_DEFINE([USE_POSIX_THREADS_WEAK], [1],
487 [Define if references to the POSIX multithreading library should be made weak.])
488 LIBTHREAD= LTLIBTHREAD=
494 if test $gl_threads_api = none; then
495 if test "$gl_use_threads" = isoc && test "$gl_have_isoc_threads" = yes; then
497 LIBTHREAD=$LIBSTDTHREAD LTLIBTHREAD=$LIBSTDTHREAD
498 LIBMULTITHREAD=$LIBSTDTHREAD LTLIBMULTITHREAD=$LIBSTDTHREAD
500 AC_DEFINE([USE_ISOC_THREADS], [1],
501 [Define if the ISO C multithreading library can be used.])
504 if test $gl_threads_api = none; then
505 case "$gl_use_threads" in
506 yes | windows | win32) # The 'win32' is for backward compatibility.
507 if { case "$host_os" in
512 gl_threads_api=windows
513 AC_DEFINE([USE_WINDOWS_THREADS], [1],
514 [Define if the native Windows multithreading API can be used.])
520 AC_MSG_CHECKING([for multithread API to use])
521 AC_MSG_RESULT([$gl_threads_api])
522 AC_SUBST([LIBTHREAD])
523 AC_SUBST([LTLIBTHREAD])
524 AC_SUBST([LIBMULTITHREAD])
525 AC_SUBST([LTLIBMULTITHREAD])
528 AC_DEFUN([gl_THREADLIB],
530 AC_REQUIRE([gl_THREADLIB_EARLY])
531 AC_REQUIRE([gl_THREADLIB_BODY])
535 dnl gl_DISABLE_THREADS
536 dnl ------------------
537 dnl Sets the gl_THREADLIB default so that threads are not used by default.
538 dnl The user can still override it at installation time, by using the
539 dnl configure option '--enable-threads'.
541 AC_DEFUN([gl_DISABLE_THREADS], [
542 m4_divert_text([INIT_PREPARE], [gl_use_threads_default=no])
546 dnl gl_AVOID_WINPTHREAD
547 dnl -------------------
548 dnl Sets the gl_THREADLIB default so that on mingw, a dependency to the
549 dnl libwinpthread DLL (mingw-w64 winpthreads library) is avoided.
550 dnl The user can still override it at installation time, by using the
551 dnl configure option '--enable-threads'.
553 AC_DEFUN([gl_AVOID_WINPTHREAD], [
554 m4_divert_text([INIT_PREPARE], [gl_use_winpthreads_default=no])
558 dnl ============================================================================
561 dnl Survey of platforms:
563 dnl Platform Available Compiler Supports test-lock
564 dnl flavours option weak result
565 dnl --------------- --------- --------- -------- ---------
566 dnl Linux 2.4/glibc posix -lpthread Y OK
568 dnl GNU Hurd/glibc posix
570 dnl Ubuntu 14.04 posix -pthread Y OK
572 dnl FreeBSD 5.3 posix -lc_r Y
574 dnl posix -lpthread ? Y
577 dnl FreeBSD 5.2 posix -lc_r Y
581 dnl FreeBSD 4.0,4.10 posix -lc_r Y OK
585 dnl OpenBSD 3.4 posix -lpthread Y OK
587 dnl Mac OS X 10.[123] posix -lpthread Y OK
589 dnl Solaris 7,8,9 posix -lpthread Y Sol 7,8: 0.0; Sol 9: OK
591 dnl HP-UX 11 posix -lpthread N (cc) OK
594 dnl IRIX 6.5 posix -lpthread Y 0.5
596 dnl AIX 4.3,5.1 posix -lpthread N AIX 4: 0.5; AIX 5: OK
598 dnl OSF/1 4.0,5.1 posix -pthread (cc) N OK
599 dnl -lpthread (gcc) Y
601 dnl Cygwin posix -lpthread Y OK
603 dnl Mingw windows N OK
607 dnl The test-lock result shows what happens if in test-lock.c EXPLICIT_YIELD is
609 dnl OK if all three tests terminate OK,
610 dnl 0.5 if the first test terminates OK but the second one loops endlessly,
611 dnl 0.0 if the first test already loops endlessly.