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.Dd August 21, 2012 36.Dt CLOCK_GETCPUCLOCKID 3 37.Os 38.Sh NAME 39.Nm clock_getcpuclockid 40.Nd access a process CPU-time clock 41.Sh LIBRARY 42.Lb libc 43.Sh SYNOPSIS 44.In time.h 45.Ft int 46.Fn clock_getcpuclockid "pid_t pid" "clockid_t *clock_id" 47.Sh DESCRIPTION 48The 49.Fn clock_getcpuclockid 50returns the clock ID of the CPU-time clock of the process specified by 51.Fa pid . 52If the process described by 53.Fa pid 54exists and the calling process has permission, the clock ID of this 55clock will be returned in 56.Fa clock_id . 57.Pp 58If 59.Fa pid 60is zero, the 61.Fn clock_getcpuclockid 62function returns the clock ID of the CPU-time clock of the process 63making the call, in 64.Fa clock_id . 65.Sh RETURN VALUES 66Upon successful completion, 67.Fn clock_getcpuclockid 68returns zero; otherwise, an error number is returned to indicate the 69error. 70.Sh ERRORS 71The 72.Fn clock_getcpuclockid 73function will fail if: 74.Bl -tag -width Er 75.It Bq Er EPERM 76The requesting process does not have permission to access the CPU-time 77clock for the process. 78.It Bq Er ESRCH 79No process can be found corresponding to the process specified by 80.Fa pid . 81.El 82.Sh SEE ALSO 83.Xr clock_gettime 2 84.Sh STANDARDS 85The 86.Fn clock_getcpuclockid 87function conforms to 88.St -p1003.1-2001 . 89.Sh HISTORY 90The 91.Fn clock_getcpuclockid 92function first appeared in 93.Fx 10.0 . 94.Sh AUTHORS 95.An David Xu Aq Mt davidxu@FreeBSD.org 96