man3/pthread_self.3

   1 .\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
   2 .\"     <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   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.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .TH PTHREAD_SELF 3 2021-03-22 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 pthread_self \- obtain ID of the calling thread
  29 .SH SYNOPSIS
  30 .nf
  31 .B #include <pthread.h>
  32 .PP
  33 .B pthread_t pthread_self(void);
  34 .PP
  35 Compile and link with \fI\-pthread\fP.
  36 .fi
  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.
  50 .SH ATTRIBUTES
  51 For an explanation of the terms used in this section, see
  52 .BR attributes (7).
  53 .ad l
  54 .nh
  55 .TS
  56 allbox;
  57 lbx lb lb
  58 l l l.
  59 Interface       Attribute       Value
  60 T{
  61 .BR pthread_self ()
  62 T}      Thread safety   MT-Safe
  63 .TE
  64 .hy
  65 .ad
  66 .sp 1
  67 .SH CONFORMING TO
  68 POSIX.1-2001, POSIX.1-2008.
  69 .SH NOTES
  70 POSIX.1 allows an implementation wide freedom in choosing
  71 the type used to represent a thread ID;
  72 for example, representation using either an arithmetic type or
  73 a structure is permitted.
  74 Therefore, variables of type
  75 .I pthread_t
  76 can't portably be compared using the C equality operator (\fB==\fP);
  77 use
  78 .BR pthread_equal (3)
  79 instead.
  80 .PP
  81 Thread identifiers should be considered opaque:
  82 any attempt to use a thread ID other than in pthreads calls
  83 is nonportable and can lead to unspecified results.
  84 .PP
  85 Thread IDs are guaranteed to be unique only within a process.
  86 A thread ID may be reused after a terminated thread has been joined,
  87 or a detached thread has terminated.
  88 .PP
  89 The thread ID returned by
  90 .BR pthread_self ()
  91 is not the same thing as the kernel thread ID returned by a call to
  92 .BR gettid (2).
  93 .SH SEE ALSO
  94 .BR pthread_create (3),
  95 .BR pthread_equal (3),
  96 .BR pthreads (7)