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