2008-07-08 14:32:54 +00:00
|
|
|
.\" Copyright (c) 1993 by Thomas Koenig (ig25@rz.uni-karlsruhe.de)
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\" License.
|
|
|
|
.\" Modified Sat Jul 24 21:27:01 1993 by Rik Faith (faith@cs.unc.edu)
|
2007-09-20 06:52:22 +00:00
|
|
|
.\" Modified 14 Jun 2002, Michael Kerrisk <mtk.manpages@gmail.com>
|
2006-12-17 01:04:18 +00:00
|
|
|
.\" Added notes on differences from other Unix systems with respect to
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" waited-for children.
|
2008-08-28 11:13:21 +00:00
|
|
|
.TH CLOCK 3 2008-08-28 "GNU" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
|
|
|
clock \- Determine processor time
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <time.h>
|
|
|
|
.sp
|
|
|
|
.B clock_t clock(void);
|
|
|
|
.fi
|
|
|
|
.SH DESCRIPTION
|
|
|
|
The
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clock ()
|
2004-11-03 13:51:07 +00:00
|
|
|
function returns an approximation of processor time used by the program.
|
|
|
|
.SH "RETURN VALUE"
|
|
|
|
The value returned is the CPU time used so far as a
|
2007-06-23 07:19:07 +00:00
|
|
|
.IR clock_t ;
|
2004-11-03 13:51:07 +00:00
|
|
|
to get the number of seconds used, divide by
|
|
|
|
.BR CLOCKS_PER_SEC .
|
|
|
|
If the processor time used is not available or its value cannot
|
2007-06-23 07:19:07 +00:00
|
|
|
be represented, the function returns the value
|
2007-12-22 16:26:51 +00:00
|
|
|
.IR (clock_t)\ \-1 .
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "CONFORMING TO"
|
2006-08-03 13:57:30 +00:00
|
|
|
C89, C99, POSIX.1-2001.
|
2007-07-09 20:25:04 +00:00
|
|
|
POSIX requires that
|
|
|
|
.B CLOCKS_PER_SEC
|
|
|
|
equals 1000000 independent
|
2004-11-03 13:51:07 +00:00
|
|
|
of the actual resolution.
|
|
|
|
.SH NOTES
|
|
|
|
The C standard allows for arbitrary values at the start of the program;
|
|
|
|
subtract the value returned from a call to
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clock ()
|
2004-11-03 13:51:07 +00:00
|
|
|
at the start of the program to get maximum portability.
|
|
|
|
.PP
|
2007-04-12 22:42:49 +00:00
|
|
|
Note that the time can wrap around.
|
2007-06-25 09:55:58 +00:00
|
|
|
On a 32-bit system where
|
2007-07-09 20:25:04 +00:00
|
|
|
.B CLOCKS_PER_SEC
|
|
|
|
equals 1000000 this function will return the same
|
2004-11-03 13:51:07 +00:00
|
|
|
value approximately every 72 minutes.
|
|
|
|
.PP
|
|
|
|
On several other implementations,
|
2007-04-12 22:42:49 +00:00
|
|
|
the value returned by
|
2004-11-03 13:51:07 +00:00
|
|
|
.BR clock ()
|
|
|
|
also includes the times of any children whose status has been
|
|
|
|
collected via
|
2007-05-12 00:30:29 +00:00
|
|
|
.BR wait (2)
|
2004-11-03 13:51:07 +00:00
|
|
|
(or another wait-type call).
|
|
|
|
Linux does not include the times of waited-for children in the
|
|
|
|
value returned by
|
|
|
|
.BR clock ().
|
2007-06-08 09:56:56 +00:00
|
|
|
.\" I have seen this behavior on Irix 6.3, and the OSF/1, HP/UX, and
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Solaris manual pages say that clock() also does this on those systems.
|
2006-08-03 13:57:30 +00:00
|
|
|
.\" POSIX.1-2001 doesn't explicitly allow this, nor is there an
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" explicit prohibition. -- MTK
|
|
|
|
The
|
2007-05-12 00:30:29 +00:00
|
|
|
.BR times (2)
|
2007-04-12 22:42:49 +00:00
|
|
|
function, which explicitly returns (separate) information about the
|
2004-11-03 13:51:07 +00:00
|
|
|
caller and its children, may be preferable.
|
|
|
|
.SH "SEE ALSO"
|
clock_nanosleep.2, getrusage.2, timerfd_create.2, clock.3, clock_getcpuclockid.3, ftime.3, pthread_create.3, pthread_getcpuclockid.3, pthread_tryjoin_np.3, sem_wait.3, time.7: Global fix: Fix xrefs to clock_*.? pages to reflect move to section 2
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2009-02-07 21:10:39 +00:00
|
|
|
.BR clock_gettime (2),
|
2004-11-03 13:51:07 +00:00
|
|
|
.BR getrusage (2),
|
clock_nanosleep.2, getrusage.2, timerfd_create.2, clock.3, clock_getcpuclockid.3, ftime.3, pthread_create.3, pthread_getcpuclockid.3, pthread_tryjoin_np.3, sem_wait.3, time.7: Global fix: Fix xrefs to clock_*.? pages to reflect move to section 2
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2009-02-07 21:10:39 +00:00
|
|
|
.BR times (2)
|