gen/FreeBSD/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. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. 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 .\"     @(#)times.3     8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/gen/times.3,v 1.10 2001/10/01 16:08:51 ru Exp $
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt TIMES 3
  37 .Os
  38 .Sh NAME
  39 .Nm times
  40 .Nd process times
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In sys/times.h
  45 .Ft clock_t
  46 .Fn times "struct tms *tp"
  47 .Sh DESCRIPTION
  48 .Bf -symbolic
  49 This interface is obsoleted by
  50 .Xr getrusage 2
  51 and
  52 .Xr gettimeofday 2 .
  53 .Ef
  54 .Pp
  55 The
  56 .Fn times
  57 function returns the value of time in
  58 .Dv CLK_TCK Ns 's
  59 of a second since
  60 0 hours, 0 minutes, 0 seconds, January 1, 1970, Coordinated Universal
  61 Time.
  62 .Pp
  63 It also fills in the structure pointed to by
  64 .Fa tp
  65 with time-accounting information.
  66 .Pp
  67 The
  68 .Vt tms
  69 structure is defined as follows:
  70 .Bd -literal -offset indent
  71 struct tms {
  72         clock_t tms_utime;
  73         clock_t tms_stime;
  74         clock_t tms_cutime;
  75         clock_t tms_cstime;
  76 };
  77 .Ed
  78 .Pp
  79 The elements of this structure are defined as follows:
  80 .Bl -tag -width ".Va tms_cutime"
  81 .It Va tms_utime
  82 The
  83 .Tn CPU
  84 time charged for the execution of user instructions.
  85 .It Va tms_stime
  86 The
  87 .Tn CPU
  88 time charged for execution by the system on behalf of
  89 the process.
  90 .It Va tms_cutime
  91 The sum of the
  92 .Va tms_utime Ns s
  93 and
  94 .Va tms_cutime Ns s
  95 of the child processes.
  96 .It Va tms_cstime
  97 The sum of the
  98 .Fa tms_stime Ns s
  99 and
 100 .Fa tms_cstime Ns s
 101 of the child processes.
 102 .El
 103 .Pp
 104 All times are in
 105 .Dv CLK_TCK Ns 's
 106 of a second.
 107 .Pp
 108 The times of a terminated child process are included in the
 109 .Va tms_cutime
 110 and
 111 .Va tms_cstime
 112 elements of the parent when one of the
 113 .Xr wait 2
 114 functions returns the process ID of the terminated child to the parent.
 115 If an error occurs,
 116 .Fn times
 117 returns the value
 118 .Pq Po Vt clock_t Pc Ns \-1 ,
 119 and sets
 120 .Va errno
 121 to indicate the error.
 122 .Sh ERRORS
 123 The
 124 .Fn times
 125 function
 126 may fail and set the global variable
 127 .Va errno
 128 for any of the errors specified for the library
 129 routines
 130 .Xr getrusage 2
 131 and
 132 .Xr gettimeofday 2 .
 133 .Sh SEE ALSO
 134 .Xr time 1 ,
 135 .Xr getrusage 2 ,
 136 .Xr gettimeofday 2 ,
 137 .Xr wait 2 ,
 138 .Xr clocks 7
 139 .Sh STANDARDS
 140 The
 141 .Fn times
 142 function
 143 conforms to
 144 .St -p1003.1-88 .