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