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