Index for Section 2

Alphabetical listing for G

Bottom of page

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

SYNOPSIS
  #include <sys/resource.h>

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

  [Tru64 UNIX]	 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 develped 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.

  [Tru64 UNIX]	 The following function declaration does not conform to
  current standards and is supported only for backward compatibility through
  the Berkeley Compatibility Library (libbsd):

  #include <sys/vtimes.h>

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

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

  getrusage(): XSH4.2, XSH5.0

  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 terminated and
		  waited for child processes of the current process.

  r_usage Points to a buffer that will be filled in as described in
	  <sys/resource.h>.

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

  If the child process is never waited for, for example if the parent has set
  SA_NOCLDWAIT or has set SIGCHLD to SIG_IGN, the resource information for
  that child process is discarded.

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.

  [Tru64 UNIX]	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]
	  [Tru64 UNIX]	The address specified for r_usage is not valid.

SEE ALSO
  Functions: gettimer(3), time(3), times(3), wait(2)

  Standards: standards(5)

Index for Section 2

Alphabetical listing for G

Top of page