lib/libc/gen/times.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)times.3     8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD: src/lib/libc/gen/times.3,v 1.12 2008/12/01 15:27:00 keramida Exp $
  30 .\" $DragonFly: src/lib/libc/gen/times.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
  31 .\"
  32 .Dd December 1, 2008
  33 .Dt TIMES 3
  34 .Os
  35 .Sh NAME
  36 .Nm times
  37 .Nd process times
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In sys/times.h
  42 .Ft clock_t
  43 .Fn times "struct tms *tp"
  44 .Sh DESCRIPTION
  45 .Bf -symbolic
  46 This interface is obsoleted by
  47 .Xr getrusage 2
  48 and
  49 .Xr gettimeofday 2 .
  50 .Ef
  51 .Pp
  52 The
  53 .Fn times
  54 function returns the value of time in
  55 .Dv CLK_TCK Ns 's
  56 of a second since the system startup time.
  57 The current value of
  58 .Dv CLK_TCK ,
  59 the frequency of the statistics clock in ticks per second, may be
  60 obtained through the
  61 .Xr sysconf 3
  62 interface.
  63 .Pp
  64 It also fills in the structure pointed to by
  65 .Fa tp
  66 with time-accounting information.
  67 .Pp
  68 The
  69 .Vt tms
  70 structure is defined as follows:
  71 .Bd -literal -offset indent
  72 struct tms {
  73         clock_t tms_utime;
  74         clock_t tms_stime;
  75         clock_t tms_cutime;
  76         clock_t tms_cstime;
  77 };
  78 .Ed
  79 .Pp
  80 The elements of this structure are defined as follows:
  81 .Bl -tag -width ".Va tms_cutime"
  82 .It Va tms_utime
  83 The
  84 .Tn CPU
  85 time charged for the execution of user instructions.
  86 .It Va tms_stime
  87 The
  88 .Tn CPU
  89 time charged for execution by the system on behalf of
  90 the process.
  91 .It Va tms_cutime
  92 The sum of the
  93 .Va tms_utime Ns s
  94 and
  95 .Va tms_cutime Ns s
  96 of the child processes.
  97 .It Va tms_cstime
  98 The sum of the
  99 .Fa tms_stime Ns s
 100 and
 101 .Fa tms_cstime Ns s
 102 of the child processes.
 103 .El
 104 .Pp
 105 All times are in
 106 .Dv CLK_TCK Ns 's
 107 of a second.
 108 .Pp
 109 The times of a terminated child process are included in the
 110 .Va tms_cutime
 111 and
 112 .Va tms_cstime
 113 elements of the parent when one of the
 114 .Xr wait 2
 115 functions returns the process ID of the terminated child to the parent.
 116 If an error occurs,
 117 .Fn times
 118 returns the value
 119 .Pq Po Vt clock_t Pc Ns \-1 ,
 120 and sets
 121 .Va errno
 122 to indicate the error.
 123 .Sh ERRORS
 124 The
 125 .Fn times
 126 function
 127 may fail and set the global variable
 128 .Va errno
 129 for any of the errors specified for the library
 130 routines
 131 .Xr getrusage 2
 132 and
 133 .Xr gettimeofday 2 .
 134 .Sh SEE ALSO
 135 .Xr time 1 ,
 136 .Xr getrusage 2 ,
 137 .Xr gettimeofday 2 ,
 138 .Xr wait 2 ,
 139 .Xr sysconf 3 ,
 140 .Xr clocks 7
 141 .Sh STANDARDS
 142 The
 143 .Fn times
 144 function
 145 conforms to
 146 .St -p1003.1-88 .