Fix: different pthread_getname_np signature() on macOS causes build failure

macOS likes to be special so it has pthread_setname_np() without a
thread id parameter, but a pthread_getname_np() with it. Split the
detection macro in two and modifiy the compat layer to handle it.

Change-Id: I8034c54057d68eef59546960c75afe8fbe07f5ad
Signed-off-by: Michael Jeanson <mjeanson@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

diff --git a/configure.ac b/configure.ac
index 66dd016931aeabb5aefdddc7ecf5983d03fff0de..cbb3ee596d00b3d4ec0a5f7b33918f37d5253781 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -237,8 +237,9 @@ AC_CHECK_FUNCS([ \
        sched_getcpu sysconf sync_file_range
 ])
 
        sched_getcpu sysconf sync_file_range
 ])
 

-# Check for pthread_setname_np and its signature
+# Check for pthread_setname_np and pthread_getname_np

 LTTNG_PTHREAD_SETNAME_NP
 LTTNG_PTHREAD_SETNAME_NP

+LTTNG_PTHREAD_GETNAME_NP

 
 # Check if clock_gettime, timer_create, timer_settime, and timer_delete are available in lib rt, and if so,
 # add -lrt to LIBS
 
 # Check if clock_gettime, timer_create, timer_settime, and timer_delete are available in lib rt, and if so,
 # add -lrt to LIBS

diff --git a/m4/lttng_pthread_getname_np.m4 b/m4/lttng_pthread_getname_np.m4
new file mode 100644 (file)
index 0000000..7ddecf9
--- /dev/null
+++ b/m4/lttng_pthread_getname_np.m4
@@ -0,0 +1,95 @@
+# SYNOPSIS
+#
+#   LTTNG_PTHREAD_GETNAME_NP
+#
+# LICENSE
+#
+#   Copyright (c) 2020 Michael Jeanson <mjeanson@efficios.com>
+#
+#   This program is free software; you can redistribute it and/or modify it
+#   under the terms of the GNU General Public License as published by the
+#   Free Software Foundation; either version 2 of the License, or (at your
+#   option) any later version.
+#
+#   This program is distributed in the hope that it will be useful, but
+#   WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
+#   Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License along
+#   with this program. If not, see <https://www.gnu.org/licenses/>.
+#
+#   As a special exception, the respective Autoconf Macro's copyright owner
+#   gives unlimited permission to copy, distribute and modify the configure
+#   scripts that are the output of Autoconf when processing the Macro. You
+#   need not follow the terms of the GNU General Public License when using
+#   or distributing such scripts, even though portions of the text of the
+#   Macro appear in them. The GNU General Public License (GPL) does govern
+#   all other use of the material that constitutes the Autoconf Macro.
+#
+#   This special exception to the GPL applies to versions of the Autoconf
+#   Macro released by the Autoconf Archive. When you make and distribute a
+#   modified version of the Autoconf Macro, you may extend this special
+#   exception to the GPL to apply to your modified version as well.
+
+AC_DEFUN([LTTNG_PTHREAD_GETNAME_NP], [
+AC_REQUIRE([AX_PTHREAD])
+AC_LANG_PUSH([C])
+
+lttng_pthread_getname_np_save_LDFLAGS="$LDFLAGS"
+lttng_pthread_getname_np_save_LIBS="$LIBS"
+LDFLAGS="$LDFLAGS $PTHREAD_CFLAGS"
+LIBS="$LIBS $PTHREAD_LIBS"
+
+# GLIBC >= 2.12, Solaris >= 11.3, FreeBSD >= 12.2, MacOS X >= 10.6, iOS >= 3.2
+AC_MSG_CHECKING(for pthread_getname_np(pthread_t, char*, size_t))
+AC_LINK_IFELSE(
+    [AC_LANG_PROGRAM(
+        [[#include <pthread.h>
+         #ifdef __FreeBSD__
+         #include <pthread_np.h>
+         #endif
+         #define LTTNG_PTHREAD_NAMELEN 16
+         char lttng_pthread_name[LTTNG_PTHREAD_NAMELEN];]],
+        [pthread_getname_np(pthread_self(), lttng_pthread_name, LTTNG_PTHREAD_NAMELEN)])],
+    [AC_MSG_RESULT(yes)
+     AC_DEFINE(HAVE_PTHREAD_GETNAME_NP_WITH_TID,1,
+        [Have function pthread_getname_np(pthread_t, char*, size_t)])],
+    [AC_MSG_RESULT(no)])
+
+AC_MSG_CHECKING(for pthread_getname_np(char*, size_t))
+AC_LINK_IFELSE(
+    [AC_LANG_PROGRAM(
+        [[#include <pthread.h>
+         #ifdef __FreeBSD__
+         #include <pthread_np.h>
+         #endif
+         #define LTTNG_PTHREAD_NAMELEN 16
+         char lttng_pthread_name[LTTNG_PTHREAD_NAMELEN];]],
+        [pthread_getname_np(lttng_pthread_name, LTTNG_PTHREAD_NAMELEN)])],
+    [AC_MSG_RESULT(yes)
+     AC_DEFINE(HAVE_PTHREAD_GETNAME_NP_WITHOUT_TID,1,
+        [Have function pthread_getname_np(char*, size_t)])],
+    [AC_MSG_RESULT(no)])
+
+# FreeBSD
+AC_MSG_CHECKING(for pthread_get_name_np(pthread_t, char*, size_t))
+AC_LINK_IFELSE(
+    [AC_LANG_PROGRAM(
+        [[#include <pthread.h>
+         #ifdef __FreeBSD__
+         #include <pthread_np.h>
+         #endif
+         #define LTTNG_PTHREAD_NAMELEN 16
+         char lttng_pthread_name[LTTNG_PTHREAD_NAMELEN];]],
+        [pthread_get_name_np(pthread_self(), lttng_pthread_name, LTTNG_PTHREAD_NAMELEN)])],
+    [AC_MSG_RESULT(yes)
+     AC_DEFINE(HAVE_PTHREAD_GET_NAME_NP_WITH_TID,1,
+        [Have function pthread_get_name_np(pthread_t, char*, size_t)])],
+    [AC_MSG_RESULT(no)])
+
+LDFLAGS=$lttng_pthread_getname_np_save_LDFLAGS
+LIBS=$lttng_pthread_getname_np_save_LIBS
+
+AC_LANG_POP
+])dnl LTTNG_PTHREAD_GETNAME_NP

diff --git a/m4/lttng_pthread_setname_np.m4 b/m4/lttng_pthread_setname_np.m4
index 6eff705baa3b7a6d00f4c480d19f3c02f7d2b5b1..99fcc8d1e69d79d348f77d058e817619994227f6 100644 (file)
--- a/m4/lttng_pthread_setname_np.m4
+++ b/m4/lttng_pthread_setname_np.m4
@@ -41,11 +41,14 @@ lttng_pthread_setname_np_save_LIBS="$LIBS"
 LDFLAGS="$LDFLAGS $PTHREAD_CFLAGS"
 LIBS="$LIBS $PTHREAD_LIBS"
 
 LDFLAGS="$LDFLAGS $PTHREAD_CFLAGS"
 LIBS="$LIBS $PTHREAD_LIBS"
 

-# GLIBC >= 2.12, Solaris >= 11.3
+# GLIBC >= 2.12, Solaris >= 11.3, FreeBSD >= 12.2

 AC_MSG_CHECKING(for pthread_setname_np(pthread_t, const char*))
 AC_LINK_IFELSE(
     [AC_LANG_PROGRAM(
 AC_MSG_CHECKING(for pthread_setname_np(pthread_t, const char*))
 AC_LINK_IFELSE(
     [AC_LANG_PROGRAM(

-        [#include <pthread.h>],
+        [[#include <pthread.h>
+         #ifdef __FreeBSD__
+         #include <pthread_np.h>
+         #endif]],

         [pthread_setname_np(pthread_self(), "example")])],
     [AC_MSG_RESULT(yes)
      AC_DEFINE(HAVE_PTHREAD_SETNAME_NP_WITH_TID,1,
         [pthread_setname_np(pthread_self(), "example")])],
     [AC_MSG_RESULT(yes)
      AC_DEFINE(HAVE_PTHREAD_SETNAME_NP_WITH_TID,1,


@@ -56,7 +59,10 @@ AC_LINK_IFELSE(
 AC_MSG_CHECKING(for pthread_setname_np(const char*))
 AC_LINK_IFELSE(
     [AC_LANG_PROGRAM(
 AC_MSG_CHECKING(for pthread_setname_np(const char*))
 AC_LINK_IFELSE(
     [AC_LANG_PROGRAM(

-        [#include <pthread.h>],
+        [[#include <pthread.h>
+         #ifdef __FreeBSD__
+         #include <pthread_np.h>
+         #endif]],

         [pthread_setname_np("example")])],
     [AC_MSG_RESULT(yes)
      AC_DEFINE(HAVE_PTHREAD_SETNAME_NP_WITHOUT_TID,1,
         [pthread_setname_np("example")])],
     [AC_MSG_RESULT(yes)
      AC_DEFINE(HAVE_PTHREAD_SETNAME_NP_WITHOUT_TID,1,


@@ -67,8 +73,10 @@ AC_LINK_IFELSE(
 AC_MSG_CHECKING(for pthread_set_name_np(pthread_t, const char*))
 AC_LINK_IFELSE(
     [AC_LANG_PROGRAM(
 AC_MSG_CHECKING(for pthread_set_name_np(pthread_t, const char*))
 AC_LINK_IFELSE(
     [AC_LANG_PROGRAM(

-        [#include <pthread.h>
-        #include <pthread_np.h>],
+        [[#include <pthread.h>
+         #ifdef __FreeBSD__
+         #include <pthread_np.h>
+         #endif]],

         [pthread_set_name_np(pthread_self(), "example")])],
     [AC_MSG_RESULT(yes)
      AC_DEFINE(HAVE_PTHREAD_SET_NAME_NP_WITH_TID,1,
         [pthread_set_name_np(pthread_self(), "example")])],
     [AC_MSG_RESULT(yes)
      AC_DEFINE(HAVE_PTHREAD_SET_NAME_NP_WITH_TID,1,

diff --git a/src/common/compat/pthread.h b/src/common/compat/pthread.h
index 511ab089b3ed975c00cbb84e229b9c17c2bb2e22..bedfd91ff5387e26ef5f71da6afc19ba8614be02 100644 (file)
--- a/src/common/compat/pthread.h
+++ b/src/common/compat/pthread.h
@@ -12,6 +12,10 @@
 #include <common/compat/errno.h>
 #include <string.h>
 
 #include <common/compat/errno.h>
 #include <string.h>
 

+#ifdef __FreeBSD__
+#include <pthread_np.h>
+#endif
+

 #define LTTNG_PTHREAD_NAMELEN 16
 
 #if defined(HAVE_PTHREAD_SETNAME_NP_WITH_TID)
 #define LTTNG_PTHREAD_NAMELEN 16
 
 #if defined(HAVE_PTHREAD_SETNAME_NP_WITH_TID)


@@ -28,27 +32,14 @@ int lttng_pthread_setname_np(const char *name)
 
        return pthread_setname_np(pthread_self(), name);
 }
 
        return pthread_setname_np(pthread_self(), name);
 }

-
-static inline
-int lttng_pthread_getname_np(char *name, size_t len)
-{
-       return pthread_getname_np(pthread_self(), name, len);
-}

 #elif defined(HAVE_PTHREAD_SETNAME_NP_WITHOUT_TID)
 static inline
 int lttng_pthread_setname_np(const char *name)
 {
        return pthread_setname_np(name);
 }
 #elif defined(HAVE_PTHREAD_SETNAME_NP_WITHOUT_TID)
 static inline
 int lttng_pthread_setname_np(const char *name)
 {
        return pthread_setname_np(name);
 }

-
-static inline
-int lttng_pthread_getname_np(char *name, size_t len)
-{
-       return pthread_getname_np(name, len);
-}

 #elif defined(HAVE_PTHREAD_SET_NAME_NP_WITH_TID)
 
 #elif defined(HAVE_PTHREAD_SET_NAME_NP_WITH_TID)
 

-#include <pthread_np.h>

 static inline
 int lttng_pthread_setname_np(const char *name)
 {
 static inline
 int lttng_pthread_setname_np(const char *name)
 {


@@ -60,13 +51,6 @@ int lttng_pthread_setname_np(const char *name)
        pthread_set_name_np(pthread_self(), name);
        return 0;
 }
        pthread_set_name_np(pthread_self(), name);
        return 0;
 }

-
-static inline
-int lttng_pthread_getname_np(char *name, size_t len)
-{
-       pthread_get_name_np(pthread_self(), name, len);
-       return 0;
-}

 #elif defined(__linux__)
 
 /* Fallback on prtctl on Linux */
 #elif defined(__linux__)
 
 /* Fallback on prtctl on Linux */


@@ -81,12 +65,6 @@ int lttng_pthread_setname_np(const char *name)
        }
        return prctl(PR_SET_NAME, name, 0, 0, 0);
 }
        }
        return prctl(PR_SET_NAME, name, 0, 0, 0);
 }

-
-static inline
-int lttng_pthread_getname_np(char *name, size_t len)
-{
-       return prctl(PR_GET_NAME, name, 0, 0, 0);
-}

 #else
 /*
  * For platforms without thread name support, do nothing.
 #else
 /*
  * For platforms without thread name support, do nothing.


@@ -96,7 +74,42 @@ int lttng_pthread_setname_np(const char *name)
 {
        return -ENOSYS;
 }
 {
        return -ENOSYS;
 }

+#endif
+

 
 

+#if defined(HAVE_PTHREAD_GETNAME_NP_WITH_TID)
+static inline
+int lttng_pthread_getname_np(char *name, size_t len)
+{
+       return pthread_getname_np(pthread_self(), name, len);
+}
+#elif defined(HAVE_PTHREAD_GETNAME_NP_WITHOUT_TID)
+static inline
+int lttng_pthread_getname_np(char *name, size_t len)
+{
+       return pthread_getname_np(name, len);
+}
+#elif defined(HAVE_PTHREAD_GET_NAME_NP_WITH_TID)
+static inline
+int lttng_pthread_getname_np(char *name, size_t len)
+{
+       pthread_get_name_np(pthread_self(), name, len);
+       return 0;
+}
+#elif defined(__linux__)
+
+/* Fallback on prtctl on Linux */
+#include <sys/prctl.h>
+
+static inline
+int lttng_pthread_getname_np(char *name, size_t len)
+{
+       return prctl(PR_GET_NAME, name, 0, 0, 0);
+}
+#else
+/*
+ * For platforms without thread name support, do nothing.
+ */

 static inline
 int lttng_pthread_getname_np(char *name, size_t len)
 {
 static inline
 int lttng_pthread_getname_np(char *name, size_t len)
 {