83 lines
2.5 KiB
Groff
83 lines
2.5 KiB
Groff
.\" $NetBSD: pthread_getcpuclockid.3,v 1.5 2017/03/05 18:42:51 njoly Exp $
|
|
.\"
|
|
.\" Copyright (c) 2016 The NetBSD Foundation, Inc.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" This code is derived from software contributed to The NetBSD Foundation
|
|
.\" by Christos Zoulas.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
|
|
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
|
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
|
|
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
.\" POSSIBILITY OF SUCH DAMAGE.
|
|
.\"
|
|
.Dd March 5, 2017
|
|
.Dt PTHREAD_GETCPUCLOCKID 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm pthread_getcpuclockid
|
|
.Nd retrieve the clockid of the given thread
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.In pthread.h
|
|
.Ft int
|
|
.Fn pthread_getcpuclockid "pthread_t thread" "clockid_t *clock_id"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn pthread_getcpuclockid
|
|
function retrieves the
|
|
.Fa clock_id
|
|
for the specified
|
|
.Fa thread .
|
|
.Pp
|
|
The
|
|
.Xr clock_gettime 2
|
|
function can be used with the returned
|
|
.Fa clock_id
|
|
to retrieve LWP times.
|
|
.Sh RETURN VALUES
|
|
On success the
|
|
.Fn pthread_getcpuclockid
|
|
function returns 0, placing the requested
|
|
.Fa clock_id
|
|
in the argument.
|
|
Otherwise an error number will be returned.
|
|
.Sh ERRORS
|
|
These functions fail if:
|
|
.Bl -tag -width Er
|
|
.It Bq Er EFAULT
|
|
.Fa clock_id
|
|
points outside the process's allocated address space.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr clock_getcpuclockid2 2 ,
|
|
.Xr clock_gettime 2
|
|
.Sh STANDARDS
|
|
The
|
|
.Fn pthread_getcpuclockid
|
|
function conforms to
|
|
.St -p1003.1-2001 .
|
|
extension.
|
|
.Sh HISTORY
|
|
The
|
|
.Fn pthread_getcpuclockid
|
|
function appeared in
|
|
.Nx 8 .
|