Index for Section 2

Alphabetical listing for G

getrusage(2)
NAME
  getrusage, vtimes - Gets information about resource utilization

LIBRARY
  Berkeley  Compatibility  Library  (libbsd.a):	 vtimes() only

SYNOPSIS
  #include <sys/resource.h>

  int getrusage(
	  int who,
	  struct rusage *r_usage);

  [Digital]  The following function declaration does not conform to current
  standards and is supported only for backward compatibility:

  #include <sys/vtimes.h>

  vtimes(
	  struct vtimes *par_vm,
	  struct vtimes ch_vm);

  [Digital]  Application developers using the getrusage() function may want
  to specify an #include statement for <sys/time.h> before the one for
  <sys/resource.h> if programs are being developed for multiple platforms.
  The additional #include statement is not required on Tru64 UNIX systems or
  by ISO or X/Open standards, but may be required on other vendors' systems
  that conform to these standards.

STANDARDS
  Interfaces documented on this reference page conform to industry standards
  as follows:

  getrusage():	XPG4-UNIX

  Refer to the standards(5) reference page for more information about
  industry standards and associated tags.

PARAMETERS
  who	    Specifies one of the following:

	    RUSAGE_SELF
		      Retrieve information about resources used by the
		      current process.

	    RUSAGE_CHILDREN
		      Retrieve information about resources used by child
		      processes of the current process.

  r_usage   Points to a buffer that will be filled in as described in the
	    sys/resource.h header file.



DESCRIPTION
  The getrusage() function returns information describing the resources used
  by the current process or its terminated child processes.

NOTES
  The numbers the ru_inblock and ru_outblock fields of the rusage structure
  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.

  [Digital]  The vtimes() function returns accounting information for the
  current process and for the terminated child processes of the current
  process.  Either par_vm or ch_vm or both may be zero, in which case only
  the information for the pointers which are nonzero are returned.  After the
  call, each buffer contains information as defined by the contents of the
  sys/vtimes.h include file.

RETURN VALUES
  Upon successful completion, the getrusage(), function returns 0 (zero).
  Otherwise, the function returns -1 and sets errno to indicate the error.

ERRORS
  The getrusage() function sets errno to the specified values for the
  following conditions:

  [EINVAL]  The who parameter is not a valid value.

  [EFAULT]  [Digital]  The address specified for r_usage is not valid.

RELATED INFORMATION
  Functions: wait(2)

  Routines: gettimer(3), time(3), times(3)

  Standards: standards(5)