sys/sys/resource.h

   1 /*-
   2  * Copyright (c) 1982, 1986, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 4. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  *      @(#)resource.h  8.4 (Berkeley) 1/9/95
  30  * $FreeBSD$
  31  */
  32
  33 #ifndef _SYS_RESOURCE_H_
  34 #define _SYS_RESOURCE_H_
  35
  36 #include <sys/cdefs.h>
  37 #include <sys/_timeval.h>
  38 #include <sys/_types.h>
  39
  40 /*
  41  * Process priority specifications to get/setpriority.
  42  */
  43 #define PRIO_MIN        -20
  44 #define PRIO_MAX        20
  45
  46 #define PRIO_PROCESS    0
  47 #define PRIO_PGRP       1
  48 #define PRIO_USER       2
  49
  50 /*
  51  * Resource utilization information.
  52  *
  53  * Locking key:
  54  *      c - locked by proc mtx
  55  *      j - locked by sched_lock mtx
  56  *      n - not locked, lazy
  57  */
  58
  59 #define RUSAGE_SELF     0
  60 #define RUSAGE_CHILDREN -1
  61
  62 struct rusage {
  63         struct timeval ru_utime;        /* (n) user time used */
  64         struct timeval ru_stime;        /* (n) system time used */
  65         long    ru_maxrss;              /* (j) max resident set size */
  66 #define ru_first        ru_ixrss
  67         long    ru_ixrss;               /* (j) integral shared memory size */
  68         long    ru_idrss;               /* (j) integral unshared data " */
  69         long    ru_isrss;               /* (j) integral unshared stack " */
  70         long    ru_minflt;              /* (c) page reclaims */
  71         long    ru_majflt;              /* (c) page faults */
  72         long    ru_nswap;               /* (c + j) swaps */
  73         long    ru_inblock;             /* (n) block input operations */
  74         long    ru_oublock;             /* (n) block output operations */
  75         long    ru_msgsnd;              /* (n) messages sent */
  76         long    ru_msgrcv;              /* (n) messages received */
  77         long    ru_nsignals;            /* (c) signals received */
  78         long    ru_nvcsw;               /* (j) voluntary context switches */
  79         long    ru_nivcsw;              /* (j) involuntary " */
  80 #define ru_last         ru_nivcsw
  81 };
  82
  83 /*
  84  * Resource limits
  85  */
  86 #define RLIMIT_CPU      0               /* maximum cpu time in seconds */
  87 #define RLIMIT_FSIZE    1               /* maximum file size */
  88 #define RLIMIT_DATA     2               /* data size */
  89 #define RLIMIT_STACK    3               /* stack size */
  90 #define RLIMIT_CORE     4               /* core file size */
  91 #define RLIMIT_RSS      5               /* resident set size */
  92 #define RLIMIT_MEMLOCK  6               /* locked-in-memory address space */
  93 #define RLIMIT_NPROC    7               /* number of processes */
  94 #define RLIMIT_NOFILE   8               /* number of open files */
  95 #define RLIMIT_SBSIZE   9               /* maximum size of all socket buffers */
  96 #define RLIMIT_VMEM     10              /* virtual process size (inclusive of mmap) */
  97 #define RLIMIT_AS       RLIMIT_VMEM     /* standard name for RLIMIT_VMEM */
  98
  99 #define RLIM_NLIMITS    11              /* number of resource limits */
 100
 101 #define RLIM_INFINITY   ((rlim_t)(((uint64_t)1 << 63) - 1))
 102 /* XXX Missing: RLIM_SAVED_MAX, RLIM_SAVED_CUR */
 103
 104
 105 /*
 106  * Resource limit string identifiers
 107  */
 108
 109 #ifdef _RLIMIT_IDENT
 110 static char *rlimit_ident[] = {
 111         "cpu",
 112         "fsize",
 113         "data",
 114         "stack",
 115         "core",
 116         "rss",
 117         "memlock",
 118         "nproc",
 119         "nofile",
 120         "sbsize",
 121         "vmem",
 122 };
 123 #endif
 124
 125 #ifndef _RLIM_T_DECLARED
 126 typedef __rlim_t        rlim_t;
 127 #define _RLIM_T_DECLARED
 128 #endif
 129
 130 struct rlimit {
 131         rlim_t  rlim_cur;               /* current (soft) limit */
 132         rlim_t  rlim_max;               /* maximum value for rlim_cur */
 133 };
 134
 135 #if __BSD_VISIBLE
 136
 137 struct orlimit {
 138         __int32_t       rlim_cur;       /* current (soft) limit */
 139         __int32_t       rlim_max;       /* maximum value for rlim_cur */
 140 };
 141
 142 struct loadavg {
 143         __fixpt_t       ldavg[3];
 144         long            fscale;
 145 };
 146
 147 #define CP_USER         0
 148 #define CP_NICE         1
 149 #define CP_SYS          2
 150 #define CP_INTR         3
 151 #define CP_IDLE         4
 152 #define CPUSTATES       5
 153
 154 #endif  /* __BSD_VISIBLE */
 155
 156 #ifdef _KERNEL
 157
 158 extern struct loadavg averunnable;
 159 extern long cp_time[CPUSTATES];
 160
 161 #else
 162
 163 __BEGIN_DECLS
 164 /* XXX 2nd arg to [gs]etpriority() should be an id_t */
 165 int     getpriority(int, int);
 166 int     getrlimit(int, struct rlimit *);
 167 int     getrusage(int, struct rusage *);
 168 int     setpriority(int, int, int);
 169 int     setrlimit(int, const struct rlimit *);
 170 __END_DECLS
 171
 172 #endif  /* _KERNEL */
 173 #endif  /* !_SYS_RESOURCE_H_ */