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