xref: /freebsd/lib/libc/gen/clock.3 (revision 90aad5d3e44d137ce80d2ec257de07c7c1367bd3)
1.\" Copyright (c) 1990, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" the American National Standards Committee X3, on Information
6.\" Processing Systems.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)clock.3	8.1 (Berkeley) 6/4/93
33.\"
34.Dd June 4, 1993
35.Dt CLOCK 3
36.Os
37.Sh NAME
38.Nm clock
39.Nd determine processor time used
40.Sh LIBRARY
41.Lb libc
42.Sh SYNOPSIS
43.In time.h
44.Ft clock_t
45.Fn clock void
46.Sh DESCRIPTION
47The
48.Fn clock
49function
50determines the amount of processor time used since the invocation of the
51calling process, measured in
52.Dv CLOCKS_PER_SEC Ns s
53of a second.
54.Sh RETURN VALUES
55The
56.Fn clock
57function returns the amount of time used unless an error occurs, in which
58case the return value is \-1.
59.Sh SEE ALSO
60.Xr getrusage 2 ,
61.Xr clocks 7
62.Sh STANDARDS
63The
64.Fn clock
65function conforms to
66.St -isoC .
67However,
68.St -susv2
69requires
70.Dv CLOCKS_PER_SEC
71to be defined as one million.
72.Fx
73does not conform to this requirement;
74changing the value would introduce binary incompatibility
75and one million is still inadequate on modern processors.
76