xref: /dragonfly/sys/sys/resource.h (revision eb57f7fd4890145149fb763066cd07d9d4fc6931)
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 #if __BSD_VISIBLE
52 /*
53  * Process priority specifications to get/setpriority.
54  */
55 #define   PRIO_MIN  -20
56 #define   PRIO_MAX  20
57 
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 #if __BSD_VISIBLE
109 #define   RLIMIT_RSS          5                   /* resident set size */
110 #define   RLIMIT_MEMLOCK      6                   /* locked-in-memory address space */
111 #define   RLIMIT_NPROC        7                   /* number of processes */
112 #endif
113 #define   RLIMIT_NOFILE       8                   /* number of open files */
114 #if __BSD_VISIBLE
115 #define   RLIMIT_SBSIZE       9                   /* maximum size of all socket buffers */
116 #endif
117 #define   RLIMIT_AS 10                  /* standard name for address space size */
118 #if __BSD_VISIBLE
119 #define   RLIMIT_VMEM         RLIMIT_AS /* virtual process size (inclusive of mmap) */
120 #define   RLIMIT_POSIXLOCKS 11                    /* maximum number of POSIX locks per user */
121 
122 #define   RLIM_NLIMITS        12                  /* number of resource limits */
123 #endif
124 
125 #define   RLIM_INFINITY       ((rlim_t)(((__uint64_t)1 << 63) - 1))   /* no limit */
126 #define   RLIM_SAVED_MAX      RLIM_INFINITY       /* unrepresentable hard limit */
127 #define   RLIM_SAVED_CUR      RLIM_INFINITY       /* unrepresentable soft limit */
128 
129 /*
130  * Resource limit string identifiers
131  */
132 #ifdef _RLIMIT_IDENT
133 static char *rlimit_ident[] = {
134           "cpu",
135           "fsize",
136           "data",
137           "stack",
138           "core",
139           "rss",
140           "memlock",
141           "nproc",
142           "nofile",
143           "sbsize",
144           "vmem",
145           "posixlock",
146 };
147 #endif
148 
149 struct rlimit {
150           rlim_t    rlim_cur;           /* current (soft) limit */
151           rlim_t    rlim_max;           /* maximum value for rlim_cur */
152 };
153 
154 #if __BSD_VISIBLE
155 struct loadavg {
156           __uint64_t ldavg[3];                    /* 64-bits to avoid overflow */
157           long      fscale;
158 };
159 
160 /*
161  * CPU state fields as reported by the sysctl kern.cp_time
162  */
163 #define   CP_USER         0
164 #define   CP_NICE         1
165 #define   CP_SYS          2
166 #define   CP_INTR         3
167 #define   CP_IDLE         4
168 #define   CPUSTATES       5
169 #endif /* __BSD_VISIBLE */
170 
171 #ifdef _KERNEL
172 extern struct loadavg averunnable;
173 
174 int       dosetrlimit(unsigned int which, struct rlimit *limp);
175 #else
176 __BEGIN_DECLS
177 int       getpriority(int, int); /* XXX should take id_t as second arg */
178 int       getrlimit(int, struct rlimit *);
179 int       getrusage(int, struct rusage *);
180 int       setpriority(int, int, int); /* XXX should take id_t as second arg */
181 int       setrlimit(int, const struct rlimit *);
182 #if __BSD_VISIBLE
183 int       ioprio_get(int, int);
184 int       ioprio_set(int, int, int);
185 #endif
186 __END_DECLS
187 #endif    /* _KERNEL */
188 
189 #endif    /* !_SYS_RESOURCE_H_ */
190