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  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  *      @(#)resource.h  8.4 (Berkeley) 1/9/95
  34  * $FreeBSD: src/sys/sys/resource.h,v 1.12.2.2 2002/08/20 18:42:20 dillon Exp $
  35  */
  36
  37 #ifndef _SYS_RESOURCE_H_
  38 #define _SYS_RESOURCE_H_
  39
  40 #include <sys/cdefs.h>
  41 #ifndef _SYS_TYPES_H_
  42 #include <sys/types.h>
  43 #endif
  44 #include <sys/_timeval.h>
  45
  46 /*
  47  * Process priority specifications to get/setpriority.
  48  */
  49 #define PRIO_MIN        -20
  50 #define PRIO_MAX        20
  51
  52 #if __BSD_VISIBLE
  53 #define IOPRIO_MIN      1
  54 #define IOPRIO_MAX      10
  55 #endif
  56
  57 #define PRIO_PROCESS    0
  58 #define PRIO_PGRP       1
  59 #define PRIO_USER       2
  60
  61 /*
  62  * Resource utilization information.
  63  */
  64
  65 #define RUSAGE_SELF     0
  66 #define RUSAGE_CHILDREN -1
  67
  68 struct  rusage {
  69         struct timeval ru_utime;        /* user time used */
  70         struct timeval ru_stime;        /* system time used */
  71         long    ru_maxrss;              /* max resident set size */
  72 #define ru_first        ru_ixrss
  73         long    ru_ixrss;               /* integral shared memory size */
  74         long    ru_idrss;               /* integral unshared data " */
  75         long    ru_isrss;               /* integral unshared stack " */
  76         long    ru_minflt;              /* page reclaims */
  77         long    ru_majflt;              /* page faults */
  78         long    ru_nswap;               /* swaps */
  79         long    ru_inblock;             /* block input operations */
  80         long    ru_oublock;             /* block output operations */
  81         long    ru_msgsnd;              /* messages sent */
  82         long    ru_msgrcv;              /* messages received */
  83         long    ru_nsignals;            /* signals received */
  84         long    ru_nvcsw;               /* voluntary context switches */
  85         long    ru_nivcsw;              /* involuntary " */
  86 #define ru_last         ru_nivcsw
  87 };
  88
  89 /*
  90  * Resource limits
  91  */
  92 #define RLIMIT_CPU      0               /* cpu time in milliseconds */
  93 #define RLIMIT_FSIZE    1               /* maximum file size */
  94 #define RLIMIT_DATA     2               /* data size */
  95 #define RLIMIT_STACK    3               /* stack size */
  96 #define RLIMIT_CORE     4               /* core file size */
  97 #define RLIMIT_RSS      5               /* resident set size */
  98 #define RLIMIT_MEMLOCK  6               /* locked-in-memory address space */
  99 #define RLIMIT_NPROC    7               /* number of processes */
 100 #define RLIMIT_NOFILE   8               /* number of open files */
 101 #define RLIMIT_SBSIZE   9               /* maximum size of all socket buffers */
 102 #define RLIMIT_VMEM     10              /* virtual process size (inclusive of mmap) */
 103 #define RLIMIT_AS       RLIMIT_VMEM     /* standard name for address space size */
 104 #define RLIMIT_POSIXLOCKS 11            /* maximum number of POSIX locks per user */
 105
 106 #define RLIM_NLIMITS    12              /* number of resource limits */
 107
 108 #define RLIM_INFINITY   ((rlim_t)(((u_quad_t)1 << 63) - 1))     /* no limit */
 109 #define RLIM_SAVED_MAX  RLIM_INFINITY   /* unrepresentable hard limit */
 110 #define RLIM_SAVED_CUR  RLIM_INFINITY   /* unrepresentable soft limit */
 111
 112 /*
 113  * Resource limit string identifiers
 114  */
 115 #ifdef _RLIMIT_IDENT
 116 static char *rlimit_ident[] = {
 117         "cpu",
 118         "fsize",
 119         "data",
 120         "stack",
 121         "core",
 122         "rss",
 123         "memlock",
 124         "nproc",
 125         "nofile",
 126         "sbsize",
 127         "vmem",
 128         "posixlock",
 129 };
 130 #endif
 131
 132 struct rlimit {
 133         rlim_t  rlim_cur;               /* current (soft) limit */
 134         rlim_t  rlim_max;               /* maximum value for rlim_cur */
 135 };
 136
 137 #if __BSD_VISIBLE
 138 struct orlimit {
 139         int32_t rlim_cur;               /* current (soft) limit */
 140         int32_t rlim_max;               /* maximum value for rlim_cur */
 141 };
 142
 143 struct loadavg {
 144         fixpt_t ldavg[3];
 145         long    fscale;
 146 };
 147
 148 /*
 149  * CPU state fields as reported by the sysctl kern.cp_time
 150  */
 151 #define CP_USER         0
 152 #define CP_NICE         1
 153 #define CP_SYS          2
 154 #define CP_INTR         3
 155 #define CP_IDLE         4
 156 #define CPUSTATES       5
 157 #endif /* __BSD_VISIBLE */
 158
 159 #ifdef _KERNEL
 160 extern struct loadavg averunnable;
 161
 162 int     dosetrlimit(u_int which, struct rlimit *limp);
 163 #else
 164 __BEGIN_DECLS
 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 #if __BSD_VISIBLE
 171 int     ioprio_get(int, int);
 172 int     ioprio_set(int, int, int);
 173 #endif
 174 __END_DECLS
 175 #endif  /* _KERNEL */
 176
 177 #endif  /* !_SYS_RESOURCE_H_ */