xref: /freebsd/share/man/man3/pthread_getcpuclockid.3 (revision 87c1627502a5dde91e5284118eec8682b60f27a2)
1.\" Copyright (c) 2012 David Xu <davidxu@FreeBSD.org>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" Portions of this text are reprinted and reproduced in electronic form
26.\" from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology --
27.\" Portable Operating System Interface (POSIX), The Open Group Base
28.\" Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of
29.\" Electrical and Electronics Engineers, Inc and The Open Group.  In the
30.\" event of any discrepancy between this version and the original IEEE and
31.\" The Open Group Standard, the original IEEE and The Open Group Standard is
32.\" the referee document.  The original Standard can be obtained online at
33.\"	http://www.opengroup.org/unix/online.html.
34.\"
35.\" $FreeBSD$
36.\"
37.Dd August 21, 2012
38.Dt PTHREAD_GETCPUCLOCKID 3
39.Os
40.Sh NAME
41.Nm pthread_getcpuclockid
42.Nd access a thread CPU-time clock
43.Sh LIBRARY
44.Lb libpthread
45.Sh SYNOPSIS
46.In pthread.h
47.In time.h
48.Ft int
49.Fn pthread_getcpuclockid "pthread_t thread_id" "clockid_t *clock_id"
50.Sh DESCRIPTION
51The
52.Fn pthread_getcpuclockid
53returns the clock ID of the CPU-time clock of the thread specified by
54.Fa thread_id .
55If the thread described by
56.Fa thread_id
57exists.
58.Sh RETURN VALUES
59Upon successful completion,
60.Fn pthread_getcpuclockid
61returns zero; otherwise, an error number is returned to indicate the
62error.
63.Sh ERRORS
64The pthread_getcpuclockid() function will fail if:
65.Bl -tag -width Er
66.It Bq Er ESRCH
67The value specified by
68.Fa thread_id
69does not refer to an existing thread.
70.El
71.Sh SEE ALSO
72.Xr clock_gettime 2
73.Sh STANDARDS
74The
75.Fn pthread_getcpuclockid
76function conforms to
77.St -p1003.1-2004 .
78.Sh HISTORY
79The
80.Fn pthread_getcpuclockid
81function first appeared in
82.Fx 10.0 .
83.Sh AUTHORS
84.An David Xu Aq davidxu@FreeBSD.org
85