[thirdparty/glibc.git] / sysdeps / unix / sysv / linux / mips / bits / resource.h

/* Bit values & structures for resource limits.  Linux/MIPS version.
   Copyright (C) 1994-2016 Free Software Foundation, Inc.
   This file is part of the GNU C Library.

   The GNU C Library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later version.

   The GNU C Library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with the GNU C Library.  If not, see
   <http://www.gnu.org/licenses/>.  */

#ifndef _SYS_RESOURCE_H
# error "Never use <bits/resource.h> directly; include <sys/resource.h> instead."
#endif

#include <bits/types.h>

/* Transmute defines to enumerations.  The macro re-definitions are
   necessary because some programs want to test for operating system
   features with #ifdef RUSAGE_SELF.  In ISO C the reflexive
   definition is a no-op.  */

/* Kinds of resource limit.  */
enum __rlimit_resource
{
  /* Per-process CPU limit, in seconds.  */
  RLIMIT_CPU = 0,
#define RLIMIT_CPU RLIMIT_CPU

  /* Largest file that can be created, in bytes.  */
  RLIMIT_FSIZE = 1,
#define	RLIMIT_FSIZE RLIMIT_FSIZE

  /* Maximum size of data segment, in bytes.  */
  RLIMIT_DATA = 2,
#define	RLIMIT_DATA RLIMIT_DATA

  /* Maximum size of stack segment, in bytes.  */
  RLIMIT_STACK = 3,
#define	RLIMIT_STACK RLIMIT_STACK

  /* Largest core file that can be created, in bytes.  */
  RLIMIT_CORE = 4,
#define	RLIMIT_CORE RLIMIT_CORE

  /* Largest resident set size, in bytes.
     This affects swapping; processes that are exceeding their
     resident set size will be more likely to have physical memory
     taken from them.  */
  __RLIMIT_RSS = 7,
#define	RLIMIT_RSS __RLIMIT_RSS

  /* Number of open files.  */
  RLIMIT_NOFILE = 5,
  __RLIMIT_OFILE = RLIMIT_NOFILE, /* BSD name for same.  */
#define RLIMIT_NOFILE RLIMIT_NOFILE
#define RLIMIT_OFILE __RLIMIT_OFILE

  /* Address space limit (?) */
  RLIMIT_AS = 6,
#define RLIMIT_AS RLIMIT_AS

  /* Number of processes.  */
  __RLIMIT_NPROC = 8,
#define RLIMIT_NPROC __RLIMIT_NPROC

  /* Locked-in-memory address space.  */
  __RLIMIT_MEMLOCK = 9,
#define RLIMIT_MEMLOCK __RLIMIT_MEMLOCK

  /* Maximum number of file locks.  */
  __RLIMIT_LOCKS = 10,
#define RLIMIT_LOCKS __RLIMIT_LOCKS

  /* Maximum number of pending signals.  */
  __RLIMIT_SIGPENDING = 11,
#define RLIMIT_SIGPENDING __RLIMIT_SIGPENDING

  /* Maximum bytes in POSIX message queues.  */
  __RLIMIT_MSGQUEUE = 12,
#define RLIMIT_MSGQUEUE __RLIMIT_MSGQUEUE

  /* Maximum nice priority allowed to raise to.
     Nice levels 19 .. -20 correspond to 0 .. 39
     values of this resource limit.  */
  __RLIMIT_NICE = 13,
#define RLIMIT_NICE __RLIMIT_NICE

  /* Maximum realtime priority allowed for non-priviledged
     processes.  */
  __RLIMIT_RTPRIO = 14,
#define RLIMIT_RTPRIO __RLIMIT_RTPRIO

  /* Maximum CPU time in µs that a process scheduled under a real-time
     scheduling policy may consume without making a blocking system
     call before being forcibly descheduled.  */
  __RLIMIT_RTTIME = 15,
#define RLIMIT_RTTIME __RLIMIT_RTTIME

  __RLIMIT_NLIMITS = 16,
  __RLIM_NLIMITS = __RLIMIT_NLIMITS
#define RLIMIT_NLIMITS __RLIMIT_NLIMITS
#define RLIM_NLIMITS __RLIM_NLIMITS
};

/* Value to indicate that there is no limit.  */
#if _MIPS_SIM == _ABI64
/* The N64 syscall uses this value.  */
# define RLIM_INFINITY 0xffffffffffffffffUL
# ifdef __USE_LARGEFILE64
#  define RLIM64_INFINITY 0xffffffffffffffffUL
# endif
#else
/* The O32 and N32 syscalls use 0x7fffffff.  */
# ifndef __USE_FILE_OFFSET64
#  define RLIM_INFINITY ((long int)(~0UL >> 1))
# else
#  define RLIM_INFINITY 0xffffffffffffffffULL
# endif
# ifdef __USE_LARGEFILE64
#  define RLIM64_INFINITY 0xffffffffffffffffULL
# endif
#endif

/* We can represent all limits.  */
#define RLIM_SAVED_MAX	RLIM_INFINITY
#define RLIM_SAVED_CUR	RLIM_INFINITY


/* Type for resource quantity measurement.  */
#ifndef __USE_FILE_OFFSET64
typedef __rlim_t rlim_t;
#else
typedef __rlim64_t rlim_t;
#endif
#ifdef __USE_LARGEFILE64
typedef __rlim64_t rlim64_t;
#endif

struct rlimit
  {
    /* The current (soft) limit.  */
    rlim_t rlim_cur;
    /* The hard limit.  */
    rlim_t rlim_max;
  };

#ifdef __USE_LARGEFILE64
struct rlimit64
  {
    /* The current (soft) limit.  */
    rlim64_t rlim_cur;
    /* The hard limit.  */
    rlim64_t rlim_max;
 };
#endif

/* Whose usage statistics do you want?  */
enum __rusage_who
{
  /* The calling process.  */
  RUSAGE_SELF = 0,
#define RUSAGE_SELF RUSAGE_SELF

  /* All of its terminated child processes.  */
  RUSAGE_CHILDREN = -1
#define RUSAGE_CHILDREN RUSAGE_CHILDREN

#ifdef __USE_GNU
  ,
  /* The calling thread.  */
  RUSAGE_THREAD = 1
# define RUSAGE_THREAD RUSAGE_THREAD
  /* Name for the same functionality on Solaris.  */
# define RUSAGE_LWP RUSAGE_THREAD
#endif
};

#define __need_timeval
#include <bits/time.h>		/* For `struct timeval'.  */

/* Structure which says how much of each resource has been used.  */
struct rusage
  {
    /* Total amount of user time used.  */
    struct timeval ru_utime;
    /* Total amount of system time used.  */
    struct timeval ru_stime;
    /* Maximum resident set size (in kilobytes).  */
    long int ru_maxrss;
    /* Amount of sharing of text segment memory
       with other processes (kilobyte-seconds).  */
    long int ru_ixrss;
    /* Amount of data segment memory used (kilobyte-seconds).  */
    long int ru_idrss;
    /* Amount of stack memory used (kilobyte-seconds).  */
    long int ru_isrss;
    /* Number of soft page faults (i.e. those serviced by reclaiming
       a page from the list of pages awaiting reallocation.  */
    long int ru_minflt;
    /* Number of hard page faults (i.e. those that required I/O).  */
    long int ru_majflt;
    /* Number of times a process was swapped out of physical memory.  */
    long int ru_nswap;
    /* Number of input operations via the file system.  Note: This
       and `ru_oublock' do not include operations with the cache.  */
    long int ru_inblock;
    /* Number of output operations via the file system.  */
    long int ru_oublock;
    /* Number of IPC messages sent.  */
    long int ru_msgsnd;
    /* Number of IPC messages received.  */
    long int ru_msgrcv;
    /* Number of signals delivered.  */
    long int ru_nsignals;
    /* Number of voluntary context switches, i.e. because the process
       gave up the process before it had to (usually to wait for some
       resource to be available).  */
    long int ru_nvcsw;
    /* Number of involuntary context switches, i.e. a higher priority process
       became runnable or the current process used up its time slice.  */
    long int ru_nivcsw;
  };

/* Priority limits.  */
#define PRIO_MIN	-20	/* Minimum priority a process can have.  */
#define PRIO_MAX	20	/* Maximum priority a process can have.  */

/* The type of the WHICH argument to `getpriority' and `setpriority',
   indicating what flavor of entity the WHO argument specifies.  */
enum __priority_which
{
  PRIO_PROCESS = 0,		/* WHO is a process ID.  */
#define PRIO_PROCESS PRIO_PROCESS
  PRIO_PGRP = 1,		/* WHO is a process group ID.  */
#define PRIO_PGRP PRIO_PGRP
  PRIO_USER = 2			/* WHO is a user ID.  */
#define PRIO_USER PRIO_USER
};


__BEGIN_DECLS

#ifdef __USE_GNU
/* Modify and return resource limits of a process atomically.  */
# ifndef __USE_FILE_OFFSET64
extern int prlimit (__pid_t __pid, enum __rlimit_resource __resource,
		    const struct rlimit *__new_limit,
		    struct rlimit *__old_limit) __THROW;
# else
#  ifdef __REDIRECT_NTH
extern int __REDIRECT_NTH (prlimit, (__pid_t __pid,
				     enum __rlimit_resource __resource,
				     const struct rlimit *__new_limit,
				     struct rlimit *__old_limit), prlimit64);
#  else
#   define prlimit prlimit64
#  endif
# endif
# ifdef __USE_LARGEFILE64
extern int prlimit64 (__pid_t __pid, enum __rlimit_resource __resource,
		      const struct rlimit64 *__new_limit,
		      struct rlimit64 *__old_limit) __THROW;
# endif
#endif

__END_DECLS
Commit	Line	Data
73b240fa	1	/* Bit values & structures for resource limits. Linux/MIPS version.
f7a9f785	2	Copyright (C) 1994-2016 Free Software Foundation, Inc.
b2b066ff UD	3	This file is part of the GNU C Library.
	4
	5	The GNU C Library is free software; you can redistribute it and/or
3214b89b AJ	6	modify it under the terms of the GNU Lesser General Public
	7	License as published by the Free Software Foundation; either
	8	version 2.1 of the License, or (at your option) any later version.
b2b066ff UD	9
	10	The GNU C Library is distributed in the hope that it will be useful,
	11	but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3214b89b	13	Lesser General Public License for more details.
b2b066ff	14
3214b89b	15	You should have received a copy of the GNU Lesser General Public
ab84e3ff PE	16	License along with the GNU C Library. If not, see
ab84e3ff PE	17	<http://www.gnu.org/licenses/>. */
b2b066ff UD	18
	19	#ifndef _SYS_RESOURCE_H
	20	# error "Never use <bits/resource.h> directly; include <sys/resource.h> instead."
	21	#endif
	22
b2b066ff UD	23	#include <bits/types.h>
	24
	25	/* Transmute defines to enumerations. The macro re-definitions are
	26	necessary because some programs want to test for operating system
	27	features with #ifdef RUSAGE_SELF. In ISO C the reflexive
	28	definition is a no-op. */
	29
	30	/* Kinds of resource limit. */
	31	enum __rlimit_resource
	32	{
	33	/* Per-process CPU limit, in seconds. */
	34	RLIMIT_CPU = 0,
	35	#define RLIMIT_CPU RLIMIT_CPU
	36
	37	/* Largest file that can be created, in bytes. */
	38	RLIMIT_FSIZE = 1,
	39	#define RLIMIT_FSIZE RLIMIT_FSIZE
	40
	41	/* Maximum size of data segment, in bytes. */
	42	RLIMIT_DATA = 2,
	43	#define RLIMIT_DATA RLIMIT_DATA
	44
	45	/* Maximum size of stack segment, in bytes. */
	46	RLIMIT_STACK = 3,
	47	#define RLIMIT_STACK RLIMIT_STACK
	48
	49	/* Largest core file that can be created, in bytes. */
	50	RLIMIT_CORE = 4,
	51	#define RLIMIT_CORE RLIMIT_CORE
	52
	53	/* Largest resident set size, in bytes.
	54	This affects swapping; processes that are exceeding their
	55	resident set size will be more likely to have physical memory
	56	taken from them. */
ea0b49e7 UD	57	__RLIMIT_RSS = 7,
ea0b49e7 UD	58	#define RLIMIT_RSS __RLIMIT_RSS
b2b066ff UD	59
	60	/* Number of open files. */
	61	RLIMIT_NOFILE = 5,
ea0b49e7	62	__RLIMIT_OFILE = RLIMIT_NOFILE, /* BSD name for same. */
b2b066ff	63	#define RLIMIT_NOFILE RLIMIT_NOFILE
ea0b49e7	64	#define RLIMIT_OFILE __RLIMIT_OFILE
b2b066ff UD	65
	66	/* Address space limit (?) */
	67	RLIMIT_AS = 6,
	68	#define RLIMIT_AS RLIMIT_AS
	69
	70	/* Number of processes. */
ea0b49e7 UD	71	__RLIMIT_NPROC = 8,
ea0b49e7 UD	72	#define RLIMIT_NPROC __RLIMIT_NPROC
b2b066ff UD	73
b2b066ff UD	74	/* Locked-in-memory address space. */
ea0b49e7 UD	75	__RLIMIT_MEMLOCK = 9,
ea0b49e7 UD	76	#define RLIMIT_MEMLOCK __RLIMIT_MEMLOCK
b2b066ff	77
73b240fa	78	/* Maximum number of file locks. */
ea0b49e7 UD	79	__RLIMIT_LOCKS = 10,
ea0b49e7 UD	80	#define RLIMIT_LOCKS __RLIMIT_LOCKS
73b240fa	81
4214993a UD	82	/* Maximum number of pending signals. */
	83	__RLIMIT_SIGPENDING = 11,
	84	#define RLIMIT_SIGPENDING __RLIMIT_SIGPENDING
	85
	86	/* Maximum bytes in POSIX message queues. */
	87	__RLIMIT_MSGQUEUE = 12,
	88	#define RLIMIT_MSGQUEUE __RLIMIT_MSGQUEUE
	89
5e742931 UD	90	/* Maximum nice priority allowed to raise to.
	91	Nice levels 19 .. -20 correspond to 0 .. 39
	92	values of this resource limit. */
	93	__RLIMIT_NICE = 13,
	94	#define RLIMIT_NICE __RLIMIT_NICE
	95
	96	/* Maximum realtime priority allowed for non-priviledged
	97	processes. */
	98	__RLIMIT_RTPRIO = 14,
b415b963	99	#define RLIMIT_RTPRIO __RLIMIT_RTPRIO
5e742931	100
8969f4df AJ	101	/* Maximum CPU time in µs that a process scheduled under a real-time
	102	scheduling policy may consume without making a blocking system
	103	call before being forcibly descheduled. */
	104	__RLIMIT_RTTIME = 15,
	105	#define RLIMIT_RTTIME __RLIMIT_RTTIME
	106
	107	__RLIMIT_NLIMITS = 16,
ea0b49e7 UD	108	__RLIM_NLIMITS = __RLIMIT_NLIMITS
	109	#define RLIMIT_NLIMITS __RLIMIT_NLIMITS
	110	#define RLIM_NLIMITS __RLIM_NLIMITS
b2b066ff UD	111	};
	112
	113	/* Value to indicate that there is no limit. */
bd345106 DJ	114	#if _MIPS_SIM == _ABI64
	115	/* The N64 syscall uses this value. */
	116	# define RLIM_INFINITY 0xffffffffffffffffUL
	117	# ifdef __USE_LARGEFILE64
	118	# define RLIM64_INFINITY 0xffffffffffffffffUL
	119	# endif
b2b066ff	120	#else
bd345106 DJ	121	/* The O32 and N32 syscalls use 0x7fffffff. */
	122	# ifndef __USE_FILE_OFFSET64
	123	# define RLIM_INFINITY ((long int)(~0UL >> 1))
	124	# else
24d8773d	125	# define RLIM_INFINITY 0xffffffffffffffffULL
bd345106 DJ	126	# endif
bd345106 DJ	127	# ifdef __USE_LARGEFILE64
24d8773d	128	# define RLIM64_INFINITY 0xffffffffffffffffULL
bd345106	129	# endif
b2b066ff UD	130	#endif
	131
	132	/* We can represent all limits. */
	133	#define RLIM_SAVED_MAX RLIM_INFINITY
	134	#define RLIM_SAVED_CUR RLIM_INFINITY
	135
	136
	137	/* Type for resource quantity measurement. */
	138	#ifndef __USE_FILE_OFFSET64
	139	typedef __rlim_t rlim_t;
	140	#else
	141	typedef __rlim64_t rlim_t;
	142	#endif
	143	#ifdef __USE_LARGEFILE64
	144	typedef __rlim64_t rlim64_t;
	145	#endif
	146
	147	struct rlimit
	148	{
	149	/* The current (soft) limit. */
	150	rlim_t rlim_cur;
	151	/* The hard limit. */
	152	rlim_t rlim_max;
	153	};
	154
	155	#ifdef __USE_LARGEFILE64
	156	struct rlimit64
	157	{
	158	/* The current (soft) limit. */
	159	rlim64_t rlim_cur;
	160	/* The hard limit. */
	161	rlim64_t rlim_max;
	162	};
	163	#endif
	164
	165	/* Whose usage statistics do you want? */
	166	enum __rusage_who
	167	{
	168	/* The calling process. */
	169	RUSAGE_SELF = 0,
	170	#define RUSAGE_SELF RUSAGE_SELF
	171
	172	/* All of its terminated child processes. */
e27433a8	173	RUSAGE_CHILDREN = -1
b2b066ff	174	#define RUSAGE_CHILDREN RUSAGE_CHILDREN
098cab74 DJ	175
098cab74 DJ	176	#ifdef __USE_GNU
e27433a8	177	,
098cab74 DJ	178	/* The calling thread. */
	179	RUSAGE_THREAD = 1
	180	# define RUSAGE_THREAD RUSAGE_THREAD
	181	/* Name for the same functionality on Solaris. */
	182	# define RUSAGE_LWP RUSAGE_THREAD
	183	#endif
b2b066ff UD	184	};
	185
	186	#define __need_timeval
	187	#include <bits/time.h> /* For `struct timeval'. */
	188
	189	/* Structure which says how much of each resource has been used. */
	190	struct rusage
	191	{
	192	/* Total amount of user time used. */
	193	struct timeval ru_utime;
	194	/* Total amount of system time used. */
	195	struct timeval ru_stime;
	196	/* Maximum resident set size (in kilobytes). */
	197	long int ru_maxrss;
	198	/* Amount of sharing of text segment memory
	199	with other processes (kilobyte-seconds). */
	200	long int ru_ixrss;
	201	/* Amount of data segment memory used (kilobyte-seconds). */
	202	long int ru_idrss;
	203	/* Amount of stack memory used (kilobyte-seconds). */
	204	long int ru_isrss;
	205	/* Number of soft page faults (i.e. those serviced by reclaiming
	206	a page from the list of pages awaiting reallocation. */
	207	long int ru_minflt;
	208	/* Number of hard page faults (i.e. those that required I/O). */
	209	long int ru_majflt;
	210	/* Number of times a process was swapped out of physical memory. */
	211	long int ru_nswap;
	212	/* Number of input operations via the file system. Note: This
	213	and `ru_oublock' do not include operations with the cache. */
	214	long int ru_inblock;
	215	/* Number of output operations via the file system. */
	216	long int ru_oublock;
	217	/* Number of IPC messages sent. */
	218	long int ru_msgsnd;
	219	/* Number of IPC messages received. */
	220	long int ru_msgrcv;
	221	/* Number of signals delivered. */
	222	long int ru_nsignals;
	223	/* Number of voluntary context switches, i.e. because the process
	224	gave up the process before it had to (usually to wait for some
	225	resource to be available). */
	226	long int ru_nvcsw;
	227	/* Number of involuntary context switches, i.e. a higher priority process
	228	became runnable or the current process used up its time slice. */
	229	long int ru_nivcsw;
	230	};
	231
	232	/* Priority limits. */
	233	#define PRIO_MIN -20 /* Minimum priority a process can have. */
	234	#define PRIO_MAX 20 /* Maximum priority a process can have. */
	235
	236	/* The type of the WHICH argument to `getpriority' and `setpriority',
	237	indicating what flavor of entity the WHO argument specifies. */
	238	enum __priority_which
	239	{
	240	PRIO_PROCESS = 0, /* WHO is a process ID. */
	241	#define PRIO_PROCESS PRIO_PROCESS
	242	PRIO_PGRP = 1, /* WHO is a process group ID. */
	243	#define PRIO_PGRP PRIO_PGRP
	244	PRIO_USER = 2 /* WHO is a user ID. */
	245	#define PRIO_USER PRIO_USER
	246	};
c16fd246 JM	247
	248
	249	__BEGIN_DECLS
	250
	251	#ifdef __USE_GNU
	252	/* Modify and return resource limits of a process atomically. */
	253	# ifndef __USE_FILE_OFFSET64
	254	extern int prlimit (__pid_t __pid, enum __rlimit_resource __resource,
7b966fcb	255	const struct rlimit *__new_limit,
c16fd246 JM	256	struct rlimit *__old_limit) __THROW;
	257	# else
	258	# ifdef __REDIRECT_NTH
	259	extern int __REDIRECT_NTH (prlimit, (__pid_t __pid,
	260	enum __rlimit_resource __resource,
7b966fcb	261	const struct rlimit *__new_limit,
c16fd246 JM	262	struct rlimit *__old_limit), prlimit64);
	263	# else
	264	# define prlimit prlimit64
	265	# endif
	266	# endif
	267	# ifdef __USE_LARGEFILE64
	268	extern int prlimit64 (__pid_t __pid, enum __rlimit_resource __resource,
7b966fcb	269	const struct rlimit64 *__new_limit,
c16fd246 JM	270	struct rlimit64 *__old_limit) __THROW;
	271	# endif
	272	#endif
	273
	274	__END_DECLS