man-pages/man2/gettid.2

66 lines
2.2 KiB
Groff
Raw Normal View History

2004-11-03 13:51:07 +00:00
.\" Hey Emacs! This file is -*- nroff -*- source.
.\"
.\" Copyright 2003 Abhijit Menon-Sen <ams@wiw.org>
.\" and Copyright (C) 2008 Michael Kerrisk <mtk.manpages@gmail.com>
.\"
2004-11-03 13:51:07 +00:00
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
2004-11-03 13:51:07 +00:00
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
2004-11-03 13:51:07 +00:00
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.TH GETTID 2 2008-01-12 "Linux" "Linux Programmer's Manual"
2004-11-03 13:51:07 +00:00
.SH NAME
gettid \- get thread identification
.SH SYNOPSIS
.nf
2004-11-03 13:51:07 +00:00
.B #include <sys/types.h>
.sp
.B pid_t gettid(void);
.fi
2004-11-03 13:51:07 +00:00
.SH DESCRIPTION
.BR gettid ()
returns the caller's thread ID (TID).
In a single-threaded process, the thread ID
is equal to the process ID (PID, as returned by
.BR getpid (2)).
In a multithreaded process, all threads
2004-11-03 13:51:07 +00:00
have the same PID, but each one has a unique TID.
For further details, see the discussion of
.BR CLONE_THREAD
in
.BR clone (2).
2004-11-03 13:51:07 +00:00
.SH "RETURN VALUE"
2007-12-27 16:06:35 +00:00
On success, returns the thread ID of the calling process.
2004-11-03 13:51:07 +00:00
.SH ERRORS
This call is always successful.
.SH "CONFORMING TO"
.BR gettid ()
2007-12-25 21:28:09 +00:00
is Linux-specific and should not be used in programs that
2004-11-03 13:51:07 +00:00
are intended to be portable.
.SH NOTES
Glibc does not provide a wrapper for this system call; call it using
.BR syscall (2).
The thread ID returned by this call is not the same thing as a
POSIX thread ID (i.e., the opaque value returned by
.BR pthread_self (3)).
2004-11-03 13:51:07 +00:00
.SH "SEE ALSO"
.BR clone (2),
.BR fork (2),
.BR getpid (2)