lib/libc/sys/getrusage.2

   1 .\" Copyright (c) 1985, 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 .\"     @(#)getrusage.2 8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt GETRUSAGE 2
  37 .Os
  38 .Sh NAME
  39 .Nm getrusage
  40 .Nd get information about resource utilization
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In sys/types.h
  45 .In sys/time.h
  46 .In sys/resource.h
  47 .Fd "#define    RUSAGE_SELF      0"
  48 .Fd "#define    RUSAGE_CHILDREN -1"
  49 .Ft int
  50 .Fn getrusage "int who" "struct rusage *rusage"
  51 .Sh DESCRIPTION
  52 The
  53 .Fn getrusage
  54 system call
  55 returns information describing the resources utilized by the current
  56 process, or all its terminated child processes.
  57 The
  58 .Fa who
  59 argument is either
  60 .Dv RUSAGE_SELF
  61 or
  62 .Dv RUSAGE_CHILDREN .
  63 The buffer to which
  64 .Fa rusage
  65 points will be filled in with
  66 the following structure:
  67 .Bd -literal
  68 struct rusage {
  69         struct timeval ru_utime; /* user time used */
  70         struct timeval ru_stime; /* system time used */
  71         long ru_maxrss;          /* max resident set size */
  72         long ru_ixrss;           /* integral shared text memory size */
  73         long ru_idrss;           /* integral unshared data size */
  74         long ru_isrss;           /* integral unshared stack size */
  75         long ru_minflt;          /* page reclaims */
  76         long ru_majflt;          /* page faults */
  77         long ru_nswap;           /* swaps */
  78         long ru_inblock;         /* block input operations */
  79         long ru_oublock;         /* block output operations */
  80         long ru_msgsnd;          /* messages sent */
  81         long ru_msgrcv;          /* messages received */
  82         long ru_nsignals;        /* signals received */
  83         long ru_nvcsw;           /* voluntary context switches */
  84         long ru_nivcsw;          /* involuntary context switches */
  85 };
  86 .Ed
  87 .Pp
  88 The fields are interpreted as follows:
  89 .Bl -tag -width ru_minfltaa
  90 .It Fa ru_utime
  91 the total amount of time spent executing in user mode.
  92 .It Fa ru_stime
  93 the total amount of time spent in the system executing on behalf
  94 of the process(es).
  95 .It Fa ru_maxrss
  96 the maximum resident set size utilized (in kilobytes).
  97 .It Fa ru_ixrss
  98 an
  99 .Dq integral
 100 value indicating the amount of memory used
 101 by the text segment
 102 that was also shared among other processes.
 103 This value is expressed
 104 in units of kilobytes * ticks-of-execution.
 105 Ticks are statistics clock ticks.
 106 The statistics clock has a frequency of
 107 .Fn sysconf _SC_CLK_TCK
 108 ticks per second.
 109 .It Fa ru_idrss
 110 an integral value of the amount of unshared memory residing in the
 111 data segment of a process (expressed in units of
 112 kilobytes * ticks-of-execution).
 113 .It Fa ru_isrss
 114 an integral value of the amount of unshared memory residing in the
 115 stack segment of a process (expressed in units of
 116 kilobytes * ticks-of-execution).
 117 .It Fa ru_minflt
 118 the number of page faults serviced without any I/O activity; here
 119 I/O activity is avoided by
 120 .Dq reclaiming
 121 a page frame from
 122 the list of pages awaiting reallocation.
 123 .It Fa ru_majflt
 124 the number of page faults serviced that required I/O activity.
 125 .It Fa ru_nswap
 126 the number of times a process was
 127 .Dq swapped
 128 out of main
 129 memory.
 130 .It Fa ru_inblock
 131 the number of times the file system had to perform input.
 132 .It Fa ru_oublock
 133 the number of times the file system had to perform output.
 134 .It Fa ru_msgsnd
 135 the number of IPC messages sent.
 136 .It Fa ru_msgrcv
 137 the number of IPC messages received.
 138 .It Fa ru_nsignals
 139 the number of signals delivered.
 140 .It Fa ru_nvcsw
 141 the number of times a context switch resulted due to a process
 142 voluntarily giving up the processor before its time slice was
 143 completed (usually to await availability of a resource).
 144 .It Fa ru_nivcsw
 145 the number of times a context switch resulted due to a higher
 146 priority process becoming runnable or because the current process
 147 exceeded its time slice.
 148 .El
 149 .Sh NOTES
 150 The numbers
 151 .Fa ru_inblock
 152 and
 153 .Fa ru_oublock
 154 account only for real
 155 I/O; data supplied by the caching mechanism is charged only
 156 to the first process to read or write the data.
 157 .Sh RETURN VALUES
 158 .Rv -std getrusage
 159 .Sh ERRORS
 160 The
 161 .Fn getrusage
 162 system call will fail if:
 163 .Bl -tag -width Er
 164 .It Bq Er EINVAL
 165 The
 166 .Fa who
 167 argument is not a valid value.
 168 .It Bq Er EFAULT
 169 The address specified by the
 170 .Fa rusage
 171 argument is not in a valid part of the process address space.
 172 .El
 173 .Sh SEE ALSO
 174 .Xr gettimeofday 2 ,
 175 .Xr wait 2 ,
 176 .Xr clocks 7
 177 .Sh HISTORY
 178 The
 179 .Fn getrusage
 180 system call appeared in
 181 .Bx 4.2 .
 182 .Sh BUGS
 183 There is no way to obtain information about a child process
 184 that has not yet terminated.