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. 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: src/sys/sys/resource.h,v 1.12.2.2 2002/08/20 18:42:20 dillon Exp $
  31  */
  32
  33 #ifndef _SYS_RESOURCE_H_
  34 #define _SYS_RESOURCE_H_
  35
  36 #include <sys/cdefs.h>
  37 #include <machine/stdint.h>
  38 #include <sys/_timeval.h>
  39
  40 /* XXX not used by our {get,set}priority(), defined here for XSI conformance */
  41 #ifndef _ID_T_DECLARED
  42 #define _ID_T_DECLARED
  43 typedef __int64_t       id_t;   /* general id, can hold gid/pid/uid_t */
  44 #endif
  45
  46 #ifndef _RLIM_T_DECLARED
  47 #define _RLIM_T_DECLARED
  48 typedef __rlim_t        rlim_t; /* resource limit */
  49 #endif
  50
  51 /*
  52  * Process priority specifications to get/setpriority.
  53  */
  54 #define PRIO_MIN        -20
  55 #define PRIO_MAX        20
  56
  57 #if __BSD_VISIBLE
  58 #define IOPRIO_MIN      1
  59 #define IOPRIO_MAX      10
  60 #endif
  61
  62 #define PRIO_PROCESS    0
  63 #define PRIO_PGRP       1
  64 #define PRIO_USER       2
  65
  66 /*
  67  * Resource utilization information.
  68  */
  69 #define RUSAGE_SELF     0
  70 #define RUSAGE_CHILDREN -1
  71
  72 struct  rusage {
  73         struct timeval ru_utime;        /* user time used */
  74         struct timeval ru_stime;        /* system time used */
  75         long    ru_maxrss;              /* max resident set size */
  76 #define ru_first        ru_ixrss
  77         long    ru_ixrss;               /* integral shared memory size */
  78         long    ru_idrss;               /* integral unshared data " */
  79         long    ru_isrss;               /* integral unshared stack " */
  80         long    ru_minflt;              /* page reclaims */
  81         long    ru_majflt;              /* page faults */
  82         long    ru_nswap;               /* swaps */
  83         long    ru_inblock;             /* block input operations */
  84         long    ru_oublock;             /* block output operations */
  85         long    ru_msgsnd;              /* messages sent */
  86         long    ru_msgrcv;              /* messages received */
  87         long    ru_nsignals;            /* signals received */
  88         long    ru_nvcsw;               /* voluntary context switches */
  89         long    ru_nivcsw;              /* involuntary " */
  90 #define ru_last         ru_nivcsw
  91 };
  92
  93 #if __BSD_VISIBLE
  94 struct __wrusage {
  95         struct rusage   wru_self;
  96         struct rusage   wru_children;
  97 };
  98 #endif
  99
 100 /*
 101  * Resource limits
 102  */
 103 #define RLIMIT_CPU      0               /* cpu time in milliseconds */
 104 #define RLIMIT_FSIZE    1               /* maximum file size */
 105 #define RLIMIT_DATA     2               /* data size */
 106 #define RLIMIT_STACK    3               /* stack size */
 107 #define RLIMIT_CORE     4               /* core file size */
 108 #define RLIMIT_RSS      5               /* resident set size */
 109 #define RLIMIT_MEMLOCK  6               /* locked-in-memory address space */
 110 #define RLIMIT_NPROC    7               /* number of processes */
 111 #define RLIMIT_NOFILE   8               /* number of open files */
 112 #define RLIMIT_SBSIZE   9               /* maximum size of all socket buffers */
 113 #define RLIMIT_VMEM     10              /* virtual process size (inclusive of mmap) */
 114 #define RLIMIT_AS       RLIMIT_VMEM     /* standard name for address space size */
 115 #define RLIMIT_POSIXLOCKS 11            /* maximum number of POSIX locks per user */
 116
 117 #define RLIM_NLIMITS    12              /* number of resource limits */
 118
 119 #define RLIM_INFINITY   ((rlim_t)(((__uint64_t)1 << 63) - 1))   /* no limit */
 120 #define RLIM_SAVED_MAX  RLIM_INFINITY   /* unrepresentable hard limit */
 121 #define RLIM_SAVED_CUR  RLIM_INFINITY   /* unrepresentable soft limit */
 122
 123 /*
 124  * Resource limit string identifiers
 125  */
 126 #ifdef _RLIMIT_IDENT
 127 static char *rlimit_ident[] = {
 128         "cpu",
 129         "fsize",
 130         "data",
 131         "stack",
 132         "core",
 133         "rss",
 134         "memlock",
 135         "nproc",
 136         "nofile",
 137         "sbsize",
 138         "vmem",
 139         "posixlock",
 140 };
 141 #endif
 142
 143 struct rlimit {
 144         rlim_t  rlim_cur;               /* current (soft) limit */
 145         rlim_t  rlim_max;               /* maximum value for rlim_cur */
 146 };
 147
 148 #if __BSD_VISIBLE
 149 struct orlimit {
 150         __int32_t rlim_cur;             /* current (soft) limit */
 151         __int32_t rlim_max;             /* maximum value for rlim_cur */
 152 };
 153
 154 struct loadavg {
 155         __uint64_t ldavg[3];            /* 64-bits to avoid overflow */
 156         long    fscale;
 157 };
 158
 159 /*
 160  * CPU state fields as reported by the sysctl kern.cp_time
 161  */
 162 #define CP_USER         0
 163 #define CP_NICE         1
 164 #define CP_SYS          2
 165 #define CP_INTR         3
 166 #define CP_IDLE         4
 167 #define CPUSTATES       5
 168 #endif /* __BSD_VISIBLE */
 169
 170 #ifdef _KERNEL
 171 extern struct loadavg averunnable;
 172
 173 int     dosetrlimit(unsigned int which, struct rlimit *limp);
 174 #else
 175 __BEGIN_DECLS
 176 int     getpriority(int, int); /* XXX should take id_t as second arg */
 177 int     getrlimit(int, struct rlimit *);
 178 int     getrusage(int, struct rusage *);
 179 int     setpriority(int, int, int); /* XXX should take id_t as second arg */
 180 int     setrlimit(int, const struct rlimit *);
 181 #if __BSD_VISIBLE
 182 int     ioprio_get(int, int);
 183 int     ioprio_set(int, int, int);
 184 #endif
 185 __END_DECLS
 186 #endif  /* _KERNEL */
 187
 188 #endif  /* !_SYS_RESOURCE_H_ */