man3/clock.3

   1 .\" Copyright (c) 1993 by Thomas Koenig (ig25@rz.uni-karlsruhe.de)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" Modified Sat Jul 24 21:27:01 1993 by Rik Faith (faith@cs.unc.edu)
  26 .\" Modified 14 Jun 2002, Michael Kerrisk <mtk.manpages@gmail.com>
  27 .\"     Added notes on differences from other UNIX systems with respect to
  28 .\"     waited-for children.
  29 .TH CLOCK 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  30 .SH NAME
  31 clock \- determine processor time
  32 .SH SYNOPSIS
  33 .nf
  34 .B #include <time.h>
  35 .PP
  36 .B clock_t clock(void);
  37 .fi
  38 .SH DESCRIPTION
  39 The
  40 .BR clock ()
  41 function returns an approximation of processor time used by the program.
  42 .SH RETURN VALUE
  43 The value returned is the CPU time used so far as a
  44 .IR clock_t ;
  45 to get the number of seconds used, divide by
  46 .BR CLOCKS_PER_SEC .
  47 If the processor time used is not available or its value cannot
  48 be represented, the function returns the value
  49 .IR (clock_t)\ \-1 .
  50 .SH ATTRIBUTES
  51 For an explanation of the terms used in this section, see
  52 .BR attributes (7).
  53 .ad l
  54 .nh
  55 .TS
  56 allbox;
  57 lbx lb lb
  58 l l l.
  59 Interface       Attribute       Value
  60 T{
  61 .BR clock ()
  62 T}      Thread safety   MT-Safe
  63 .TE
  64 .hy
  65 .ad
  66 .sp 1
  67 .SH CONFORMING TO
  68 POSIX.1-2001, POSIX.1-2008, C89, C99.
  69 XSI requires that
  70 .B CLOCKS_PER_SEC
  71 equals 1000000 independent
  72 of the actual resolution.
  73 .SH NOTES
  74 The C standard allows for arbitrary values at the start of the program;
  75 subtract the value returned from a call to
  76 .BR clock ()
  77 at the start of the program to get maximum portability.
  78 .PP
  79 Note that the time can wrap around.
  80 On a 32-bit system where
  81 .B CLOCKS_PER_SEC
  82 equals 1000000 this function will return the same
  83 value approximately every 72 minutes.
  84 .PP
  85 On several other implementations,
  86 the value returned by
  87 .BR clock ()
  88 also includes the times of any children whose status has been
  89 collected via
  90 .BR wait (2)
  91 (or another wait-type call).
  92 Linux does not include the times of waited-for children in the
  93 value returned by
  94 .BR clock ().
  95 .\" I have seen this behavior on Irix 6.3, and the OSF/1, HP/UX, and
  96 .\" Solaris manual pages say that clock() also does this on those systems.
  97 .\" POSIX.1-2001 doesn't explicitly allow this, nor is there an
  98 .\" explicit prohibition. -- MTK
  99 The
 100 .BR times (2)
 101 function, which explicitly returns (separate) information about the
 102 caller and its children, may be preferable.
 103 .PP
 104 In glibc 2.17 and earlier,
 105 .BR clock ()
 106 was implemented on top of
 107 .BR times (2).
 108 For improved accuracy,
 109 since glibc 2.18, it is implemented on top of
 110 .BR clock_gettime (2)
 111 (using the
 112 .BR CLOCK_PROCESS_CPUTIME_ID
 113 clock).
 114 .SH SEE ALSO
 115 .BR clock_gettime (2),
 116 .BR getrusage (2),
 117 .BR times (2)