sysdeps/generic/bits/resource.h

   1 /* Bit values & structures for resource limits.  4.4 BSD/generic GNU version.
   2    Copyright (C) 1994, 1996, 1997, 1998 Free Software Foundation, Inc.
   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
   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.
   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
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, write to the Free
  17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18    02111-1307 USA.  */
  19
  20 #ifndef _SYS_RESOURCE_H
  21 # error "Never use <bits/resource.h> directly; include <sys/resource.h> instead."
  22 #endif
  23
  24 #include <bits/types.h>
  25
  26 /* These are the values for 4.4 BSD and GNU.  Earlier BSD systems have a
  27    subset of these kinds of resource limit.  In systems where `getrlimit'
  28    and `setrlimit' are not system calls, these are the values used by the C
  29    library to emulate them.  */
  30
  31 /* Kinds of resource limit.  */
  32 enum __rlimit_resource
  33   {
  34     /* Per-process CPU limit, in seconds.  */
  35     RLIMIT_CPU,
  36 #define RLIMIT_CPU      RLIMIT_CPU
  37     /* Largest file that can be created, in bytes.  */
  38     RLIMIT_FSIZE,
  39 #define RLIMIT_FSIZE    RLIMIT_FSIZE
  40     /* Maximum size of data segment, in bytes.  */
  41     RLIMIT_DATA,
  42 #define RLIMIT_DATA     RLIMIT_DATA
  43     /* Maximum size of stack segment, in bytes.  */
  44     RLIMIT_STACK,
  45 #define RLIMIT_STACK    RLIMIT_STACK
  46     /* Largest core file that can be created, in bytes.  */
  47     RLIMIT_CORE,
  48 #define RLIMIT_CORE     RLIMIT_CORE
  49     /* Largest resident set size, in bytes.
  50        This affects swapping; processes that are exceeding their
  51        resident set size will be more likely to have physical memory
  52        taken from them.  */
  53     RLIMIT_RSS,
  54 #define RLIMIT_RSS      RLIMIT_RSS
  55     /* Locked-in-memory address space.  */
  56     RLIMIT_MEMLOCK,
  57 #define RLIMIT_MEMLOCK  RLIMIT_MEMLOCK
  58     /* Number of processes.  */
  59     RLIMIT_NPROC,
  60 #define RLIMIT_NPROC    RLIMIT_NPROC
  61     /* Number of open files.  */
  62     RLIMIT_OFILE,
  63     RLIMIT_NOFILE = RLIMIT_OFILE, /* Another name for the same thing.  */
  64 #define RLIMIT_OFILE    RLIMIT_OFILE
  65 #define RLIMIT_NOFILE   RLIMIT_NOFILE
  66
  67     RLIMIT_NLIMITS,             /* Number of limit flavors.  */
  68     RLIM_NLIMITS = RLIMIT_NLIMITS /* Traditional name for same.  */
  69   };
  70
  71 /* Value to indicate that there is no limit.  */
  72 #ifndef __USE_FILE_OFFSET64
  73 # define RLIM_INFINITY 0x7fffffff
  74 #else
  75 # define RLIM_INFINITY 0x7fffffffffffffffLL
  76 #endif
  77
  78 #ifdef __USE_LARGEFILE64
  79 # define RLIM64_INFINITY 0x7fffffffffffffffLL
  80 #endif
  81
  82
  83 /* Type for resource quantity measurement.  */
  84 #ifndef __USE_FILE_OFFSET64
  85 typedef __rlim_t rlim_t;
  86 #else
  87 typedef __rlim64_t rlim_t;
  88 #endif
  89 #ifdef __USE_LARGEFILE64
  90 typedef __rlim64_t rlim64_t;
  91 #endif
  92
  93 struct rlimit
  94   {
  95     /* The current (soft) limit.  */
  96     rlim_t rlim_cur;
  97     /* The hard limit.  */
  98     rlim_t rlim_max;
  99   };
 100
 101 #ifdef __USE_LARGEFILE64
 102 struct rlimit64
 103   {
 104     /* The current (soft) limit.  */
 105     rlim64_t rlim_cur;
 106     /* The hard limit.  */
 107     rlim64_t rlim_max;
 108  };
 109 #endif
 110
 111 /* Whose usage statistics do you want?  */
 112 enum __rusage_who
 113 /* The macro definitions are necessary because some programs want
 114    to test for operating system features with #ifdef RUSAGE_SELF.
 115    In ISO C the reflexive definition is a no-op.  */
 116   {
 117     /* The calling process.  */
 118     RUSAGE_SELF = 0,
 119 #define RUSAGE_SELF     RUSAGE_SELF
 120     /* All of its terminated child processes.  */
 121     RUSAGE_CHILDREN = -1
 122 #define RUSAGE_CHILDREN RUSAGE_CHILDREN
 123   };
 124
 125 #define __need_timeval
 126 #include <bits/time.h>           /* For `struct timeval'.  */
 127
 128 /* Structure which says how much of each resource has been used.  */
 129 struct rusage
 130   {
 131     /* Total amount of user time used.  */
 132     struct timeval ru_utime;
 133     /* Total amount of system time used.  */
 134     struct timeval ru_stime;
 135     /* Maximum resident set size (in kilobytes).  */
 136     long int ru_maxrss;
 137     /* Amount of sharing of text segment memory
 138        with other processes (kilobyte-seconds).  */
 139     long int ru_ixrss;
 140     /* Amount of data segment memory used (kilobyte-seconds).  */
 141     long int ru_idrss;
 142     /* Amount of stack memory used (kilobyte-seconds).  */
 143     long int ru_isrss;
 144     /* Number of soft page faults (i.e. those serviced by reclaiming
 145        a page from the list of pages awaiting reallocation.  */
 146     long int ru_minflt;
 147     /* Number of hard page faults (i.e. those that required I/O).  */
 148     long int ru_majflt;
 149     /* Number of times a process was swapped out of physical memory.  */
 150     long int ru_nswap;
 151     /* Number of input operations via the file system.  Note: This
 152        and `ru_oublock' do not include operations with the cache.  */
 153     long int ru_inblock;
 154     /* Number of output operations via the file system.  */
 155     long int ru_oublock;
 156     /* Number of IPC messages sent.  */
 157     long int ru_msgsnd;
 158     /* Number of IPC messages received.  */
 159     long int ru_msgrcv;
 160     /* Number of signals delivered.  */
 161     long int ru_nsignals;
 162     /* Number of voluntary context switches, i.e. because the process
 163        gave up the process before it had to (usually to wait for some
 164        resource to be available).  */
 165     long int ru_nvcsw;
 166     /* Number of involuntary context switches, i.e. a higher priority process
 167        became runnable or the current process used up its time slice.  */
 168     long int ru_nivcsw;
 169   };
 170
 171 /* Priority limits.  */
 172 #define PRIO_MIN        -20     /* Minimum priority a process can have.  */
 173 #define PRIO_MAX        20      /* Maximum priority a process can have.  */
 174
 175 /* The type of the WHICH argument to `getpriority' and `setpriority',
 176    indicating what flavor of entity the WHO argument specifies.  */
 177 enum __priority_which
 178   {
 179     PRIO_PROCESS = 0,           /* WHO is a process ID.  */
 180     PRIO_PGRP = 1,              /* WHO is a process group ID.  */
 181     PRIO_USER = 2               /* WHO is a user ID.  */
 182   };