xref: /illumos-gate/usr/src/man/man3head/resource.h.3head (revision 8a2b682e57a046b828f37bcde1776f131ef4629f)

Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.

This notice shall appear on any product containing this material.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.

RESOURCE.H 3HEAD "Sep 10, 2004"
NAME
resource.h, resource - definitions for resource operations
SYNOPSIS

#include <sys/resource.h>
DESCRIPTION

The <sys/resource.h> header defines the symbolic constants listed below as possible values of the which argument of getpriority() and setpriority(). See getpriority(3C). PRIO_PROCESS

identifies the who argument as a process ID

PRIO_PGRP

identifies the who argument as a process group ID

PRIO_USER

identifies the who argument as a user ID

The following type is defined through typedef: rlim_t

unsigned integer type used for limit values

The following symbolic constants are defined: RLIM_INFINITY

a value of rlim_t indicating no limit

RLIM_SAVED_MAX

a value of type rlim_t indicating an unrepresentable saved hard limit

RLIM_SAVED_CUR

a value of type rlim_t indicating an unrepresentable saved soft limit

The symbolic constants listed below are defined as possible values of the who parameter of getrusage(). See getrusage(3C). RUSAGE_SELF

returns information about the current process

RUSAGE_CHILDREN

returns information about children of the current process

The <sys/resource.h> header defines the rlimit structure, which includes the following members:

rlim_t rlim_cur /* the current (soft) limit */
rlim_t rlim_max /* the hard limit */

The <sys/resource.h> header defines the rusage structure, which includes the following members:

struct timeval ru_utime /* user time used */
struct timeval ru_stime /* system time used */

The timeval structure is defined as described in <sys/time.h>.

The symbolic constants listed below are defined as possible values for the resource argument of getrlimit() and setrlimit(). See getrlimit(2). RLIMIT_CORE

limit on size of core dump file

RLIMIT_CPU

limit on CPU time per process

RLIMIT_DATA

limit on data segment size

RLIMIT_FSIZE

limit on file size

RLIMIT_NOFILE

limit on number of open files

RLIMIT_STACK

limit on stack size

RLIMIT_AS

limit on address space size

The id_t type is defined through typedef as described in <sys/types.h>. See types.h(3HEAD).

Inclusion of the <sys/resource.h> header can also make visible all symbols from <sys/time.h>. See time.h(3HEAD).

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
SEE ALSO

getrlimit(2), getpriority(3C), time.h(3HEAD), types.h(3HEAD), attributes(5), standards(5)