Implement interfaces to set and get names of threads.
authorUlrich Drepper <drepper@redhat.com>
Fri, 9 Apr 2010 08:09:24 +0000 (9 01:09 -0700)
committerUlrich Drepper <drepper@redhat.com>
Fri, 9 Apr 2010 08:09:24 +0000 (9 01:09 -0700)
At least the Linux kernel provides field where the kernel originally
stores the command which is executed by the thread.  The value can
subsequently be overwritten.  The added functions allow to do that for
threads, providing and abstraction around the syscalls or /proc file
system accesses needed.

NEWS
nptl/ChangeLog
nptl/Makefile
nptl/Versions
nptl/sysdeps/pthread/pthread.h
nptl/sysdeps/unix/sysv/linux/pthread_getname.c [new file with mode: 0644]
nptl/sysdeps/unix/sysv/linux/pthread_setname.c [new file with mode: 0644]

diff --git a/NEWS b/NEWS
index 6438f0d..5824ede 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -1,4 +1,4 @@
-GNU C Library NEWS -- history of user-visible changes.  2010-4-8
+GNU C Library NEWS -- history of user-visible changes.  2010-4-9
 Copyright (C) 1992-2009, 2010 Free Software Foundation, Inc.
 See the end for copying conditions.
 
@@ -15,8 +15,11 @@ Version 2.12
   11120, 11125, 11126, 11127, 11134, 11141, 11149, 11183, 11184, 11185,
   11186, 11187, 11188, 11189, 11190, 11191, 11192, 11193, 11194, 11200,
   11230, 11235, 11242, 11254, 11258, 11271, 11272, 11276, 11279, 11287,
-  11292, 11319, 11332, 11333, 11387, 11389, 11394, 11397, 11410, 11438,
-  11449, 11470, 11471
+  11292, 11319, 11332, 11333, 11387, 11389, 11390, 11394, 11397, 11410,
+  11438, 11449, 11470, 11471
+
+
+* New interfaces: pthread_getname_np, pthread_setname_np
 
 * New Linux interface: recvmmsg
 
index 5b8b0e5..e69e44f 100644 (file)
@@ -1,3 +1,14 @@
+2010-04-09  Ulrich Drepper  <drepper@redhat.com>
+
+       [BZ #11390]
+       * sysdeps/unix/sysv/linux/pthread_getname.c: New file.
+       * sysdeps/unix/sysv/linux/pthread_setname.c: New file.
+       * nptl/sysdeps/pthread/pthread.h: Declare pthread_getname and
+       pthread_setname.
+       * Makefile (libpthread-routines): Add pthread_getname and
+       pthread_setname.
+       * Versions: Export pthread_getname and pthread_setname for GLIBC_2.12.
+
 2010-04-05  Thomas Schwinge  <thomas@schwinge.name>
 
        * sysdeps/pthread/unwind-resume.c: Moved to main tree sysdeps/gnu/.
index a7b53ed..982db8e 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (C) 2002-2008,2009 Free Software Foundation, Inc.
+# Copyright (C) 2002-2008,2009,2010 Free Software Foundation, Inc.
 # This file is part of the GNU C Library.
 
 # The GNU C Library is free software; you can redistribute it and/or
@@ -124,7 +124,9 @@ libpthread-routines = nptl-init vars events version \
                      pthread_mutexattr_setprotocol \
                      pthread_mutexattr_getprioceiling \
                      pthread_mutexattr_setprioceiling tpp \
-                     pthread_mutex_getprioceiling pthread_mutex_setprioceiling
+                     pthread_mutex_getprioceiling \
+                     pthread_mutex_setprioceiling \
+                     pthread_setname pthread_getname
 #                    pthread_setuid pthread_seteuid pthread_setreuid \
 #                    pthread_setresuid \
 #                    pthread_setgid pthread_setegid pthread_setregid \
index 1f2de79..f74941f 100644 (file)
@@ -247,6 +247,8 @@ libpthread {
   GLIBC_2.12 {
     pthread_mutex_consistent; pthread_mutexattr_getrobust;
     pthread_mutexattr_setrobust;
+
+    pthread_setname_np; pthread_getname_np;
   };
 
   GLIBC_PRIVATE {
index b84fd5c..44cf9f0 100644 (file)
@@ -425,6 +425,18 @@ extern int pthread_setschedprio (pthread_t __target_thread, int __prio)
      __THROW;
 
 
+#ifdef __USE_GNU
+/* Get thread name visible in the kernel and its interfaces.  */
+extern int pthread_getname_np (pthread_t __target_thread, char *__buf,
+                              size_t __buflen)
+     __THROW __nonnull ((2));
+
+/* Set thread name visible in the kernel and its interfaces.  */
+extern int pthread_setname_np (pthread_t __target_thread, __const char *__name)
+     __THROW __nonnull ((2));
+#endif
+
+
 #ifdef __USE_UNIX98
 /* Determine level of concurrency.  */
 extern int pthread_getconcurrency (void) __THROW;
diff --git a/nptl/sysdeps/unix/sysv/linux/pthread_getname.c b/nptl/sysdeps/unix/sysv/linux/pthread_getname.c
new file mode 100644 (file)
index 0000000..c6d78df
--- /dev/null
@@ -0,0 +1,64 @@
+/* pthread_getname_np -- Get  thread name.  Linux version
+   Copyright (C) 2010 Free Software Foundation, Inc.
+   This file is part of the GNU C Library.
+
+   The GNU C Library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Lesser General Public License as
+   published by the Free Software Foundation; either version 2.1 of the
+   License, or (at your option) any later version.
+
+   The GNU C Library 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
+   Lesser General Public License for more details.
+
+   You should have received a copy of the GNU Lesser General Public
+   License along with the GNU C Library; see the file COPYING.LIB.  If not,
+   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+   Boston, MA 02111-1307, USA.  */
+
+#include <errno.h>
+#include <fcntl.h>
+#include <pthreadP.h>
+#include <stdio.h>
+#include <string.h>
+#include <unistd.h>
+#include <sys/prctl.h>
+
+#include <not-cancel.h>
+
+
+int
+pthread_getname_np (th, buf, len)
+     pthread_t th;
+     char *buf;
+     size_t len;
+{
+  const struct pthread *pd = (const struct pthread *) th;
+
+  /* Unfortunately the kernel headers do not export the TASK_COMM_LEN
+     macro.  So we have to define it here.  */
+#define TASK_COMM_LEN 16
+  if (len < TASK_COMM_LEN)
+    return ERANGE;
+
+  if (th == THREAD_SELF)
+    return prctl (PR_SET_NAME, buf) ? errno : 0;
+
+#define FMT "/proc/self/task/%u/comm"
+  char fname[sizeof (FMT) + 8];
+  sprintf (fname, FMT, (unsigned int) pd->tid);
+
+  int fd = open_not_cancel_2 (fname, O_RDONLY);
+  if (fd == -1)
+    return errno;
+
+  int res = 0;
+  ssize_t n = TEMP_FAILURE_RETRY (read_not_cancel (fd, buf, len));
+  if (n < 0)
+    res = errno;
+
+  close_not_cancel_no_status (fd);
+
+  return res;
+}
diff --git a/nptl/sysdeps/unix/sysv/linux/pthread_setname.c b/nptl/sysdeps/unix/sysv/linux/pthread_setname.c
new file mode 100644 (file)
index 0000000..34c08d9
--- /dev/null
@@ -0,0 +1,66 @@
+/* pthread_setname_np -- Set  thread name.  Linux version
+   Copyright (C) 2010 Free Software Foundation, Inc.
+   This file is part of the GNU C Library.
+
+   The GNU C Library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Lesser General Public License as
+   published by the Free Software Foundation; either version 2.1 of the
+   License, or (at your option) any later version.
+
+   The GNU C Library 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
+   Lesser General Public License for more details.
+
+   You should have received a copy of the GNU Lesser General Public
+   License along with the GNU C Library; see the file COPYING.LIB.  If not,
+   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+   Boston, MA 02111-1307, USA.  */
+
+#include <errno.h>
+#include <fcntl.h>
+#include <pthreadP.h>
+#include <stdio.h>
+#include <string.h>
+#include <unistd.h>
+#include <sys/prctl.h>
+
+#include <not-cancel.h>
+
+
+int
+pthread_setname_np (th, name)
+     pthread_t th;
+     const char *name;
+{
+  const struct pthread *pd = (const struct pthread *) th;
+
+  /* Unfortunately the kernel headers do not export the TASK_COMM_LEN
+     macro.  So we have to define it here.  */
+#define TASK_COMM_LEN 16
+  size_t name_len = strlen (name);
+  if (name_len >= TASK_COMM_LEN)
+    return ERANGE;
+
+  if (pd == THREAD_SELF)
+    return prctl (PR_SET_NAME, name) ? errno : 0;
+
+#define FMT "/proc/self/task/%u/comm"
+  char fname[sizeof (FMT) + 8];
+  sprintf (fname, FMT, (unsigned int) pd->tid);
+
+  int fd = open_not_cancel_2 (fname, O_RDWR);
+  if (fd == -1)
+    return errno;
+
+  int res = 0;
+  ssize_t n = TEMP_FAILURE_RETRY (write_not_cancel (fd, name, name_len));
+  if (n < 0)
+    res = errno;
+  else if (n != name_len)
+    res = EIO;
+
+  close_not_cancel_no_status (fd);
+
+  return res;
+}