FreeBSD/Linux Kernel Cross Reference
sys/ufs/ufs/quota.h
1 /* $NetBSD: quota.h,v 1.17 2003/08/07 16:34:44 agc Exp $ */
2
3 /*
4 * Copyright (c) 1982, 1986, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * This code is derived from software contributed to Berkeley by
8 * Robert Elz at The University of Melbourne.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 * @(#)quota.h 8.3 (Berkeley) 8/19/94
35 */
36
37 #ifndef _UFS_UFS_QUOTA_H_
38 #define _UFS_UFS_QUOTA_H_
39
40 /*
41 * Definitions for disk quotas imposed on the average user
42 * (big brother finally hits UNIX).
43 *
44 * The following constants define the amount of time given a user before the
45 * soft limits are treated as hard limits (usually resulting in an allocation
46 * failure). The timer is started when the user crosses their soft limit, it
47 * is reset when they go below their soft limit.
48 */
49 #define MAX_IQ_TIME (7*24*60*60) /* seconds in 1 week */
50 #define MAX_DQ_TIME (7*24*60*60) /* seconds in 1 week */
51
52 /*
53 * The following constants define the usage of the quota file array in the
54 * ufsmount structure and dquot array in the inode structure. The semantics
55 * of the elements of these arrays are defined in the routine getinoquota;
56 * the remainder of the quota code treats them generically and need not be
57 * inspected when changing the size of the array.
58 */
59 #define MAXQUOTAS 2
60 #define USRQUOTA 0 /* element used for user quotas */
61 #define GRPQUOTA 1 /* element used for group quotas */
62
63 /*
64 * Definitions for the default names of the quotas files.
65 */
66 #define INITQFNAMES { \
67 "user", /* USRQUOTA */ \
68 "group", /* GRPQUOTA */ \
69 "undefined", \
70 }
71 #define QUOTAFILENAME "quota"
72 #define QUOTAGROUP "operator"
73
74 /*
75 * Command definitions for the 'quotactl' system call. The commands are
76 * broken into a main command defined below and a subcommand that is used
77 * to convey the type of quota that is being manipulated (see above).
78 */
79 #define SUBCMDMASK 0x00ff
80 #define SUBCMDSHIFT 8
81 #define QCMD(cmd, type) (((cmd) << SUBCMDSHIFT) | ((type) & SUBCMDMASK))
82
83 #define Q_QUOTAON 0x0100 /* enable quotas */
84 #define Q_QUOTAOFF 0x0200 /* disable quotas */
85 #define Q_GETQUOTA 0x0300 /* get limits and usage */
86 #define Q_SETQUOTA 0x0400 /* set limits and usage */
87 #define Q_SETUSE 0x0500 /* set usage */
88 #define Q_SYNC 0x0600 /* sync disk copy of a filesystems quotas */
89
90 /*
91 * The following structure defines the format of the disk quota file
92 * (as it appears on disk) - the file is an array of these structures
93 * indexed by user or group number. The setquota system call establishes
94 * the vnode for each quota file (a pointer is retained in the ufsmount
95 * structure).
96 */
97 struct dqblk {
98 u_int32_t dqb_bhardlimit; /* absolute limit on disk blks alloc */
99 u_int32_t dqb_bsoftlimit; /* preferred limit on disk blks */
100 u_int32_t dqb_curblocks; /* current block count */
101 u_int32_t dqb_ihardlimit; /* maximum # allocated inodes + 1 */
102 u_int32_t dqb_isoftlimit; /* preferred inode limit */
103 u_int32_t dqb_curinodes; /* current # allocated inodes */
104 int32_t dqb_btime; /* time limit for excessive disk use */
105 int32_t dqb_itime; /* time limit for excessive files */
106 };
107
108 #ifdef _KERNEL
109 #include <sys/queue.h>
110
111 /*
112 * The following structure records disk usage for a user or group on a
113 * filesystem. There is one allocated for each quota that exists on any
114 * filesystem for the current user or group. A cache is kept of recently
115 * used entries.
116 */
117 struct dquot {
118 LIST_ENTRY(dquot) dq_hash; /* hash list */
119 TAILQ_ENTRY(dquot) dq_freelist; /* free list */
120 u_int16_t dq_flags; /* flags, see below */
121 u_int16_t dq_cnt; /* count of active references */
122 u_int16_t dq_spare; /* unused spare padding */
123 u_int16_t dq_type; /* quota type of this dquot */
124 u_int32_t dq_id; /* identifier this applies to */
125 struct ufsmount *dq_ump; /* filesystem that this is taken from */
126 struct dqblk dq_dqb; /* actual usage & quotas */
127 };
128 /*
129 * Flag values.
130 */
131 #define DQ_LOCK 0x01 /* this quota locked (no MODS) */
132 #define DQ_WANT 0x02 /* wakeup on unlock */
133 #define DQ_MOD 0x04 /* this quota modified since read */
134 #define DQ_FAKE 0x08 /* no limits here, just usage */
135 #define DQ_BLKS 0x10 /* has been warned about blk limit */
136 #define DQ_INODS 0x20 /* has been warned about inode limit */
137 /*
138 * Shorthand notation.
139 */
140 #define dq_bhardlimit dq_dqb.dqb_bhardlimit
141 #define dq_bsoftlimit dq_dqb.dqb_bsoftlimit
142 #define dq_curblocks dq_dqb.dqb_curblocks
143 #define dq_ihardlimit dq_dqb.dqb_ihardlimit
144 #define dq_isoftlimit dq_dqb.dqb_isoftlimit
145 #define dq_curinodes dq_dqb.dqb_curinodes
146 #define dq_btime dq_dqb.dqb_btime
147 #define dq_itime dq_dqb.dqb_itime
148
149 /*
150 * If the system has never checked for a quota for this file, then it is
151 * set to NODQUOT. Once a write attempt is made the inode pointer is set
152 * to reference a dquot structure.
153 */
154 #define NODQUOT NULL
155
156 /*
157 * Flags to chkdq() and chkiq()
158 */
159 #define FORCE 0x01 /* force usage changes independent of limits */
160 #define CHOWN 0x02 /* (advisory) change initiated by chown */
161
162 /*
163 * Macros to avoid subroutine calls to trivial functions.
164 */
165 #ifdef DIAGNOSTIC
166 #define DQREF(dq) dqref(dq)
167 #else
168 #define DQREF(dq) (dq)->dq_cnt++
169 #endif
170
171 #include <sys/cdefs.h>
172
173 struct dquot;
174 struct inode;
175 struct mount;
176 struct proc;
177 struct ucred;
178 struct ufsmount;
179 struct vnode;
180 __BEGIN_DECLS
181 int chkdq __P((struct inode *, int64_t, struct ucred *, int));
182 int chkdqchg __P((struct inode *, int64_t, struct ucred *, int));
183 int chkiq __P((struct inode *, int32_t, struct ucred *, int));
184 int chkiqchg __P((struct inode *, int32_t, struct ucred *, int));
185 void dqflush __P((struct vnode *));
186 int dqget __P((struct vnode *,
187 u_long, struct ufsmount *, int, struct dquot **));
188 void dqinit __P((void));
189 void dqreinit __P((void));
190 void dqdone __P((void));
191 void dqref __P((struct dquot *));
192 void dqrele __P((struct vnode *, struct dquot *));
193 int dqsync __P((struct vnode *, struct dquot *));
194 int getinoquota __P((struct inode *));
195 int getquota __P((struct mount *, u_long, int, caddr_t));
196 int qsync __P((struct mount *mp));
197 int quotaoff __P((struct proc *, struct mount *, int));
198 int quotaon __P((struct proc *, struct mount *, int, caddr_t));
199 int setquota __P((struct mount *, u_long, int, caddr_t));
200 int setuse __P((struct mount *, u_long, int, caddr_t));
201 int ufs_quotactl __P((struct mount *, int, uid_t, caddr_t, struct proc *));
202 __END_DECLS
203
204 #ifdef DIAGNOSTIC
205 __BEGIN_DECLS
206 void chkdquot __P((struct inode *));
207 __END_DECLS
208 #endif
209 #else
210 __BEGIN_DECLS
211 int quotactl __P((const char *, int , int, void *));
212 __END_DECLS
213 #endif /* _KERNEL */
214
215 #endif /* !_UFS_UFS_QUOTA_H_ */
Cache object: 34ebd292f65ae9e5b1a7fae69b6d863a
|