]>
Commit | Line | Data |
---|---|---|
8dffe2c4 MK |
1 | .\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk |
2 | .\" <mtk.manpages@gmail.com> | |
3 | .\" | |
93015253 | 4 | .\" %%%LICENSE_START(VERBATIM) |
8dffe2c4 MK |
5 | .\" Permission is granted to make and distribute verbatim copies of this |
6 | .\" manual provided the copyright notice and this permission notice are | |
7 | .\" preserved on all copies. | |
8 | .\" | |
9 | .\" Permission is granted to copy and distribute modified versions of this | |
10 | .\" manual under the conditions for verbatim copying, provided that the | |
11 | .\" entire resulting derived work is distributed under the terms of a | |
12 | .\" permission notice identical to this one. | |
13 | .\" | |
14 | .\" Since the Linux kernel and libraries are constantly changing, this | |
15 | .\" manual page may be incorrect or out-of-date. The author(s) assume no | |
16 | .\" responsibility for errors or omissions, or for damages resulting from | |
17 | .\" the use of the information contained herein. The author(s) may not | |
18 | .\" have taken the same level of care in the production of this manual, | |
19 | .\" which is licensed free of charge, as they might when working | |
20 | .\" professionally. | |
21 | .\" | |
22 | .\" Formatted or processed versions of this manual, if unaccompanied by | |
23 | .\" the source, must acknowledge the copyright and authors of this work. | |
4b72fb64 | 24 | .\" %%%LICENSE_END |
8dffe2c4 | 25 | .\" |
460495ca | 26 | .TH PTHREAD_SELF 3 2015-08-08 "Linux" "Linux Programmer's Manual" |
8dffe2c4 MK |
27 | .SH NAME |
28 | pthread_self \- obtain ID of the calling thread | |
29 | .SH SYNOPSIS | |
30 | .nf | |
31 | .B #include <pthread.h> | |
dbfe9c70 | 32 | .PP |
8dffe2c4 | 33 | .B pthread_t pthread_self(void); |
68e4db0a | 34 | .PP |
8dffe2c4 | 35 | Compile and link with \fI\-pthread\fP. |
6030f2d8 | 36 | .fi |
8dffe2c4 MK |
37 | .SH DESCRIPTION |
38 | The | |
39 | .BR pthread_self () | |
40 | function returns the ID of the calling thread. | |
41 | This is the same value that is returned in | |
42 | .IR *thread | |
43 | in the | |
44 | .BR pthread_create (3) | |
45 | call that created this thread. | |
46 | .SH RETURN VALUE | |
47 | This function always succeeds, returning the calling thread's ID. | |
48 | .SH ERRORS | |
49 | This function always succeeds. | |
f9371cc4 | 50 | .SH ATTRIBUTES |
faec2dfa PH |
51 | For an explanation of the terms used in this section, see |
52 | .BR attributes (7). | |
53 | .TS | |
54 | allbox; | |
55 | lb lb lb | |
56 | l l l. | |
57 | Interface Attribute Value | |
58 | T{ | |
f9371cc4 | 59 | .BR pthread_self () |
faec2dfa PH |
60 | T} Thread safety MT-Safe |
61 | .TE | |
8dffe2c4 | 62 | .SH CONFORMING TO |
39ce910f | 63 | POSIX.1-2001, POSIX.1-2008. |
8dffe2c4 MK |
64 | .SH NOTES |
65 | POSIX.1 allows an implementation wide freedom in choosing | |
66 | the type used to represent a thread ID; | |
67 | for example, representation using either an arithmetic type or | |
68 | a structure is permitted. | |
69 | Therefore, variables of type | |
70 | .I pthread_t | |
71 | can't portably be compared using the C equality operator (\fB==\fP); | |
72 | use | |
73 | .BR pthread_equal (3) | |
74 | instead. | |
847e0d88 | 75 | .PP |
8dffe2c4 MK |
76 | Thread identifiers should be considered opaque: |
77 | any attempt to use a thread ID other than in pthreads calls | |
d603cc27 | 78 | is nonportable and can lead to unspecified results. |
847e0d88 | 79 | .PP |
33a0ccb2 | 80 | Thread IDs are guaranteed to be unique only within a process. |
8dffe2c4 MK |
81 | A thread ID may be reused after a terminated thread has been joined, |
82 | or a detached thread has terminated. | |
847e0d88 | 83 | .PP |
8dffe2c4 MK |
84 | The thread ID returned by |
85 | .BR pthread_self () | |
86 | is not the same thing as the kernel thread ID returned by a call to | |
87 | .BR gettid (2). | |
88 | .SH SEE ALSO | |
89 | .BR pthread_create (3), | |
90 | .BR pthread_equal (3), | |
91 | .BR pthreads (7) |