1 /* Test pthread_setname_np and pthread_getname_np.
2 Copyright (C) 2013-2014 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public License as
7 published by the Free Software Foundation; either version 2.1 of the
8 License, or (at your option) any later version.
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; see the file COPYING.LIB. If
17 not, see <http://www.gnu.org/licenses/>. */
22 #include <sys/syscall.h>
26 #include <kernel-features.h>
28 /* New name of process. */
29 #define NEW_NAME "setname"
31 /* Name of process which is one byte too big
32 e.g. 17 bytes including null-terminator */
33 #define BIG_NAME "....V....X....XV"
35 /* Longest name of a process
36 e.g. 16 bytes including null-terminator. */
37 #define LONGEST_NAME "....V....X....X"
39 /* One less than longest name with unique
40 characters to detect modification. */
41 #define CANARY_NAME "abcdefghijklmn"
43 /* On Linux the maximum length of the name of a task *including* the null
45 #define TASK_COMM_LEN 16
50 return syscall(__NR_gettid
);
53 /* On Linux we can read this task's name from /proc. */
55 get_self_comm (long tid
, char *buf
, size_t len
)
58 #define FMT "/proc/self/task/%lu/comm"
59 char fname
[sizeof (FMT
) + 8];
60 sprintf (fname
, FMT
, (unsigned long) tid
);
62 int fd
= open (fname
, O_RDONLY
);
66 ssize_t n
= read (fd
, (void *) buf
, len
);
71 if (buf
[n
- 1] == '\n')
84 do_test (int argc
, char **argv
)
89 char name
[TASK_COMM_LEN
];
90 char name_check
[TASK_COMM_LEN
];
92 memset (name
, '\0', TASK_COMM_LEN
);
93 memset (name_check
, '\0', TASK_COMM_LEN
);
95 /* Test 1: Get the name of the task via pthread_getname_np and /proc
96 and verify that they both match. */
97 self
= pthread_self ();
98 res
= pthread_getname_np (self
, name
, TASK_COMM_LEN
);
102 res
= get_self_comm (gettid (), name_check
, TASK_COMM_LEN
);
104 #if !__ASSUME_PROC_PID_TASK_COMM
105 /* On this first test we look for ENOENT to be returned from
106 get_self_comm to indicate that the kernel is older than
107 2.6.33 and doesn't contain comm within the proc structure.
108 In that case we skip the entire test. */
111 printf ("SKIP: The kernel does not have /proc/self/task/%%lu/comm.\n");
118 if (strncmp (name
, name_check
, strlen (BIG_NAME
)) == 0)
119 printf ("PASS: Test 1 - pthread_getname_np and /proc agree.\n");
122 printf ("FAIL: Test 1 - pthread_getname_np and /proc differ"
123 " i.e. %s != %s\n", name
, name_check
);
129 printf ("FAIL: Test 1 - unable read task name via proc.\n");
135 printf ("FAIL: Test 1 - pthread_getname_np failed with error %d\n", res
);
139 /* Test 2: Test setting the name and then independently verify it
141 res
= pthread_setname_np (self
, NEW_NAME
);
145 res
= get_self_comm (gettid (), name_check
, TASK_COMM_LEN
);
148 if (strncmp (NEW_NAME
, name_check
, strlen (BIG_NAME
)) == 0)
149 printf ("PASS: Test 2 - Value used in pthread_setname_np and"
153 printf ("FAIL: Test 2 - Value used in pthread_setname_np"
154 " and /proc differ i.e. %s != %s\n",
155 NEW_NAME
, name_check
);
161 printf ("FAIL: Test 2 - unable to read task name via proc.\n");
167 printf ("FAIL: Test 2 - pthread_setname_np failed with error %d\n", res
);
171 /* Test 3: Test setting a name that is one-byte too big. */
172 res
= pthread_getname_np (self
, name
, TASK_COMM_LEN
);
176 res
= pthread_setname_np (self
, BIG_NAME
);
181 printf ("PASS: Test 3 - pthread_setname_np returned ERANGE"
182 " for a process name that was too long.\n");
184 /* Verify the old name didn't change. */
185 res
= get_self_comm (gettid (), name_check
, TASK_COMM_LEN
);
188 if (strncmp (name
, name_check
, strlen (BIG_NAME
)) == 0)
189 printf ("PASS: Test 3 - Original name unchanged after"
190 " pthread_setname_np returned ERANGE.\n");
193 printf ("FAIL: Test 3 - Original name changed after"
194 " pthread_setname_np returned ERANGE"
202 printf ("FAIL: Test 3 - unable to read task name.\n");
208 printf ("FAIL: Test 3 - Wrong error returned"
209 " i.e. ERANGE != %d\n", res
);
215 printf ("FAIL: Test 3 - Too-long name accepted by"
216 " pthread_setname_np.\n");
222 printf ("FAIL: Test 3 - Unable to get original name.\n");
226 /* Test 4: Verify that setting the longest name works. */
227 res
= pthread_setname_np (self
, LONGEST_NAME
);
231 res
= get_self_comm (gettid (), name_check
, TASK_COMM_LEN
);
234 if (strncmp (LONGEST_NAME
, name_check
, strlen (BIG_NAME
)) == 0)
235 printf ("PASS: Test 4 - Longest name set via pthread_setname_np"
236 " agrees with /proc.\n");
239 printf ("FAIL: Test 4 - Value used in pthread_setname_np and /proc"
240 " differ i.e. %s != %s\n", LONGEST_NAME
, name_check
);
246 printf ("FAIL: Test 4 - unable to read task name via proc.\n");
252 printf ("FAIL: Test 4 - pthread_setname_np failed with error %d\n", res
);
256 /* Test 5: Verify that getting a long name into a small buffer fails. */
257 strncpy (name
, CANARY_NAME
, strlen (CANARY_NAME
) + 1);
259 /* Claim the buffer length is strlen (LONGEST_NAME). This is one character
260 too small to hold LONGEST_NAME *and* the null terminator. We should get
261 back ERANGE and name should be unmodified. */
262 res
= pthread_getname_np (self
, name
, strlen (LONGEST_NAME
));
268 if (strncmp (CANARY_NAME
, name
, strlen (BIG_NAME
)) == 0)
270 printf ("PASS: Test 5 - ERANGE and buffer unmodified.\n");
274 printf ("FAIL: Test 5 - Original buffer modified.\n");
280 printf ("FAIL: Test 5 - Did not return ERANGE for small buffer.\n");
286 printf ("FAIL: Test 5 - Returned name longer than buffer.\n");
290 /* Test 6: Lastly make sure we can read back the longest name. */
291 res
= pthread_getname_np (self
, name
, strlen (LONGEST_NAME
) + 1);
295 if (strncmp (LONGEST_NAME
, name
, strlen (BIG_NAME
)) == 0)
297 printf ("PASS: Test 6 - Read back longest name correctly.\n");
301 printf ("FAIL: Test 6 - Read \"%s\" instead of longest name.\n",
308 printf ("FAIL: Test 6 - pthread_getname_np failed with error %d\n", res
);
315 #include <test-skeleton.c>