manual page distributed with 4.1BSD

SCCS-vsn: lib/libcompat/4.1/vtimes.3 4.1

diff --git a/usr/src/lib/libcompat/4.1/vtimes.3 b/usr/src/lib/libcompat/4.1/vtimes.3
new file mode 100644 (file)
index 0000000..e956b58
--- /dev/null
+++ b/usr/src/lib/libcompat/4.1/vtimes.3
@@ -0,0 +1,99 @@
+.\" Copyright (c) 1980 Regents of the University of California.
+.\" All rights reserved.  The Berkeley software License Agreement
+.\" specifies the terms and conditions for redistribution.
+.\"
+.\"    @(#)vtimes.3    4.1 (Berkeley) %G%
+.\"
+.TH VTIMES 2V
+.UC 4
+.SH NAME
+vtimes \- get information about resource utilization
+.SH SYNOPSIS
+.nf
+.B "vtimes(par_vm, ch_vm)"
+.B "struct vtimes *par_vm, *ch_vm;"
+.fi
+.SH DESCRIPTION
+.I Vtimes
+returns accounting information for the current process and for
+the terminated child processes of the current
+process.  Either
+.I par_vm
+or 
+.I ch_vm
+or both may be 0, in which case only the information for the pointers
+which are non-zero is returned.
+.PP
+After the call, each buffer contains information as defined by the
+contents of the include file
+.I /usr/include/sys/vtimes.h:
+.LP
+.nf
+struct vtimes {
+       int     vm_utime;               /* user time (*HZ) */
+       int     vm_stime;               /* system time (*HZ) */
+       /* divide next two by utime+stime to get averages */
+       unsigned vm_idsrss;             /* integral of d+s rss */
+       unsigned vm_ixrss;              /* integral of text rss */
+       int     vm_maxrss;              /* maximum rss */
+       int     vm_majflt;              /* major page faults */
+       int     vm_minflt;              /* minor page faults */
+       int     vm_nswap;               /* number of swaps */
+       int     vm_inblk;               /* block reads */
+       int     vm_oublk;               /* block writes */
+};
+.fi
+.PP
+The
+.I vm_utime
+and
+.I vm_stime
+fields give the user and system
+time respectively in 60ths of a second (or 50ths if that
+is the frequency of wall current in your locality.) The
+.I vm_idrss
+and
+.I vm_ixrss
+measure memory usage.  They are computed by integrating the number of
+memory pages in use each
+over cpu time.  They are reported as though computed
+discretely, adding the current memory usage (in 512 byte
+pages) each time the clock ticks.  If a process used 5 core
+pages over 1 cpu-second for its data and stack, then
+.I vm_idsrss
+would have the value 5*60, where
+.I vm_utime+vm_stime
+would be the 60.  
+.I Vm_idsrss
+integrates data and stack segment
+usage, while
+.I vm_ixrss
+integrates text segment usage.
+.I Vm_maxrss
+reports the maximum instantaneous sum of the
+text+data+stack core-resident page count.
+.PP
+The 
+.I vm_majflt
+field gives the number of page faults which
+resulted in disk activity; the
+.I vm_minflt
+field gives the
+number of page faults incurred in simulation of reference
+bits;
+.I vm_nswap
+is the number of swaps which occurred.  The
+number of file system input/output events are reported in
+.I vm_inblk
+and
+.I vm_oublk
+These numbers account only for real
+i/o; data supplied by the caching mechanism is charged only
+to the first process to read or write the data.
+.SH SEE ALSO
+time(2), wait3(2)
+.SH BUGS
+This call is peculiar to this version of UNIX.
+The options and specifications of this system call are subject to change.
+It may be extended to include additional information
+in future versions of the system.