pthread_setname_np

Section: C Library Functions (3)
Updated: 2026-02-08
Index JM Home Page roff page
 

名前

pthread_setname_np, pthread_getname_np - スレッド名の設定/取得を行う  

ライブラリ

POSIX スレッドライブラリ (libpthread,~-lpthread)  

書式

#define _GNU_SOURCE             /* See feature_test_macros(7) */
#include <pthread.h>

int pthread_setname_np(pthread_t thread, const char *name);
int pthread_getname_np(size_t size;
                       pthread_t thread, char name[size], size_t size);
 

説明

By default, all the threads created using pthread_create() inherit the program name. The pthread_setname_np() function can be used to set a unique name for a thread, which can be useful for debugging multithreaded applications. The thread name is a meaningful C language string, whose length is restricted to 16 characters, including the terminating null byte ('\0'). The thread argument specifies the thread whose name is to be changed; name specifies the new name.

The pthread_getname_np() function can be used to retrieve the name of the thread. The thread argument specifies the thread whose name is to be retrieved. The buffer name is used to return the thread name; size specifies the number of bytes available in name. The buffer specified by name should be at least 16 characters in length. The returned thread name in the output buffer will be null terminated.  

返り値

成功すると、これらの関数は 0 を返す。 エラーの場合、0 以外のエラー番号を返す。  

エラー

pthread_setname_np() は以下のエラーで失敗する場合がある。
ERANGE
name で指定された文字列の長さが、許可されている上限を超えている。

pthread_getname_np() は以下のエラーで失敗する場合がある。

ERANGE
The buffer specified by name and size is too small to hold the thread name.

If either of these functions fails to open /proc/self/task/tid/comm, then the call may fail with one of the errors described in open(2).  

属性

この節で使用されている用語の説明については、 attributes(7) を参照。
インターフェース属性値
pthread_setname_np(), pthread_getname_np() Thread safetyMT-Safe
 

標準規格

GNU; そのため、名前に "_np" (nonportable; 移植性がない) という接尾辞が付いている。  

歴史

glibc 2.12.  

注意

pthread_setname_np() internally writes to the thread-specific comm file under the /proc filesystem: /proc/self/task/tid/comm. pthread_getname_np() retrieves it from the same location.  

例

以下のプログラムは、 pthread_setname_np() と pthread_getname_np() の使用例を示している。

以下のシェルセッションは、このプログラムの実行例である。

$ ./a.out;
Created a thread.  Default name is: a.out
The thread name after setting it is THREADFOO.
^Z                           # Suspend the program
[1]+  Stopped           ./a.out
$ ps H -C a.out -o 'pid tid cmd comm'
  PID   TID CMD                         COMMAND
 5990  5990 ./a.out                     a.out
 5990  5991 ./a.out                     THREADFOO
$ cat /proc/5990/task/5990/comm
a.out
$ cat /proc/5990/task/5991/comm
THREADFOO
 

プログラムのソース

#define _GNU_SOURCE
#include <err.h>
#include <errno.h>
#include <pthread.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

#define NAMELEN 16

static void *
threadfunc(void *parm)
{
    sleep(5);          // allow main program to set the thread name
    return NULL;
}

int
main(int argc, char *argv[])
{
    pthread_t thread;
    int rc;
    char thread_name[NAMELEN];

    rc = pthread_create(&thread, NULL, threadfunc, NULL);
    if (rc != 0)
        errc(EXIT_FAILURE, rc, "pthread_create");

    rc = pthread_getname_np(thread, thread_name, NAMELEN);
    if (rc != 0)
        errc(EXIT_FAILURE, rc, "pthread_getname_np");

    printf("Created a thread.  Default name is: %s\n", thread_name);
    rc = pthread_setname_np(thread, (argc > 1) ? argv[1] : "THREADFOO");
    if (rc != 0)
        errc(EXIT_FAILURE, rc, "pthread_setname_np");

    sleep(2);

    rc = pthread_getname_np(thread, thread_name, NAMELEN);
    if (rc != 0)
        errc(EXIT_FAILURE, rc, "pthread_getname_np");
    printf("The thread name after setting it is %s.\n", thread_name);

    rc = pthread_join(thread, NULL);
    if (rc != 0)
        errc(EXIT_FAILURE, rc, "pthread_join");

    printf("Done\n");
    exit(EXIT_SUCCESS);
}
 

関連項目

prctl(2), pthread_create(3), pthreads(7)


 

Index

名前
ライブラリ
書式
説明
返り値
エラー
属性
標準規格
歴史
注意
例
プログラムのソース
関連項目

This document was created by man2html, using the manual pages.