kernel: Move GPL'd kernel files to sys/gnu to have them all in one place.
[dragonfly.git] / sys / gnu / vfs / 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  */
39
40 #ifndef _VFS_GNU_EXT2FS_QUOTA_H_
41 #define _VFS_GNU_EXT2FS_QUOTA_H_
42
43 /*
44  * Definitions for disk quotas imposed on the average user
45  * (big brother finally hits UNIX).
46  *
47  * The following constants define the amount of time given a user before the
48  * soft limits are treated as hard limits (usually resulting in an allocation
49  * failure). The timer is started when the user crosses their soft limit, it
50  * is reset when they go below their soft limit.
51  */
52 #define MAX_IQ_TIME     (7*24*60*60)    /* seconds in 1 week */
53 #define MAX_DQ_TIME     (7*24*60*60)    /* seconds in 1 week */
54
55 /*
56  * The following constants define the usage of the quota file array in the
57  * ext2mount structure and dquot array in the inode structure.  The semantics
58  * of the elements of these arrays are defined in the routine getinoquota;
59  * the remainder of the quota code treats them generically and need not be
60  * inspected when changing the size of the array.
61  */
62 #define MAXQUOTAS       2
63 #define USRQUOTA        0       /* element used for user quotas */
64 #define GRPQUOTA        1       /* element used for group quotas */
65
66 /*
67  * Definitions for the default names of the quotas files.
68  */
69 #define INITQFNAMES { \
70         "user",         /* USRQUOTA */ \
71         "group",        /* GRPQUOTA */ \
72         "undefined", \
73 }
74 #define QUOTAFILENAME   "quota"
75 #define QUOTAGROUP      "operator"
76
77 /*
78  * Command definitions for the 'quotactl' system call.  The commands are
79  * broken into a main command defined below and a subcommand that is used
80  * to convey the type of quota that is being manipulated (see above).
81  */
82 #define SUBCMDMASK      0x00ff
83 #define SUBCMDSHIFT     8
84 #define QCMD(cmd, type) (((cmd) << SUBCMDSHIFT) | ((type) & SUBCMDMASK))
85
86 #define Q_QUOTAON       0x0100  /* enable quotas */
87 #define Q_QUOTAOFF      0x0200  /* disable quotas */
88 #define Q_GETQUOTA      0x0300  /* get limits and usage */
89 #define Q_SETQUOTA      0x0400  /* set limits and usage */
90 #define Q_SETUSE        0x0500  /* set usage */
91 #define Q_SYNC          0x0600  /* sync disk copy of a filesystems quotas */
92
93 /*
94  * The following structure defines the format of the disk quota file
95  * (as it appears on disk) - the file is an array of these structures
96  * indexed by user or group number.  The setquota system call establishes
97  * the vnode for each quota file (a pointer is retained in the ext2mount
98  * structure).
99  */
100 struct ext2_dqblk {
101         uint32_t dqb_bhardlimit;        /* absolute limit on disk blks alloc */
102         uint32_t dqb_bsoftlimit;        /* preferred limit on disk blks */
103         uint32_t dqb_curblocks; /* current block count */
104         uint32_t dqb_ihardlimit;        /* maximum # allocated inodes + 1 */
105         uint32_t dqb_isoftlimit;        /* preferred inode limit */
106         uint32_t dqb_curinodes; /* current # allocated inodes */
107         time_t    dqb_btime;            /* time limit for excessive disk use */
108         time_t    dqb_itime;            /* time limit for excessive files */
109 };
110
111 #ifdef _KERNEL
112
113 #include <sys/queue.h>
114
115 /*
116  * The following structure records disk usage for a user or group on a
117  * filesystem. There is one allocated for each quota that exists on any
118  * filesystem for the current user or group. A cache is kept of recently
119  * used entries.
120  */
121 struct ext2_dquot {
122         LIST_ENTRY(ext2_dquot) dq_hash; /* hash list */
123         TAILQ_ENTRY(ext2_dquot) dq_freelist;    /* free list */
124         uint16_t dq_flags;              /* flags, see below */
125         uint16_t dq_type;               /* quota type of this dquot */
126         uint32_t dq_cnt;                /* count of active references */
127         uint32_t dq_id;         /* identifier this applies to */
128         struct  ext2mount *dq_ump;      /* filesystem that this is taken from */
129         struct  ext2_dqblk dq_dqb;      /* actual usage & quotas */
130 };
131 /*
132  * Flag values.
133  */
134 #define DQ_LOCK         0x01            /* this quota locked (no MODS) */
135 #define DQ_WANT         0x02            /* wakeup on unlock */
136 #define DQ_MOD          0x04            /* this quota modified since read */
137 #define DQ_FAKE         0x08            /* no limits here, just usage */
138 #define DQ_BLKS         0x10            /* has been warned about blk limit */
139 #define DQ_INODS        0x20            /* has been warned about inode limit */
140 /*
141  * Shorthand notation.
142  */
143 #define dq_bhardlimit   dq_dqb.dqb_bhardlimit
144 #define dq_bsoftlimit   dq_dqb.dqb_bsoftlimit
145 #define dq_curblocks    dq_dqb.dqb_curblocks
146 #define dq_ihardlimit   dq_dqb.dqb_ihardlimit
147 #define dq_isoftlimit   dq_dqb.dqb_isoftlimit
148 #define dq_curinodes    dq_dqb.dqb_curinodes
149 #define dq_btime        dq_dqb.dqb_btime
150 #define dq_itime        dq_dqb.dqb_itime
151
152 /*
153  * If the system has never checked for a quota for this file, then it is
154  * set to NODQUOT.  Once a write attempt is made the inode pointer is set
155  * to reference a dquot structure.
156  */
157 #define NODQUOT         NULL
158
159 /*
160  * Flags to ext2_chkdq() and ext2_chkiq()
161  */
162 #define FORCE   0x01    /* force usage changes independent of limits */
163 #define CHOWN   0x02    /* (advisory) change initiated by chown */
164
165 /*
166  * Macros to avoid subroutine calls to trivial functions.
167  */
168 #ifdef DIAGNOSTIC
169 #define DQREF(dq)       ext2_dqref(dq)
170 #else
171 #define DQREF(dq)       (dq)->dq_cnt++
172 #endif
173
174 struct inode;
175 struct mount;
176 struct proc;
177 struct thread;
178 struct ucred;
179 struct vnode;
180
181 int     ext2_chkdq(struct inode *, long, struct ucred *, int);
182 int     ext2_chkiq(struct inode *, long, struct ucred *, int);
183 void    ext2_dqinit(void);
184 void    ext2_dqrele(struct vnode *, struct ext2_dquot *);
185 int     ext2_getinoquota(struct inode *);
186 int     ext2_getquota(struct mount *, u_long, int, caddr_t);
187 int     ext2_qsync(struct mount *mp);
188 int     ext2_quotaoff(struct mount *, int);
189 int     ext2_quotaon(struct ucred *, struct mount *, int, caddr_t);
190 int     ext2_setquota(struct mount *, u_long, int, caddr_t);
191 int     ext2_setuse(struct mount *, u_long, int, caddr_t);
192 int     ext2_quotactl(struct mount *, int, uid_t, caddr_t, struct ucred *);
193
194 #else /* !_KERNEL */
195
196 #include <sys/cdefs.h>
197
198 __BEGIN_DECLS
199 int     quotactl(const char *, int, int, void *);
200 __END_DECLS
201
202 #endif /* _KERNEL */
203
204 #endif /* !_VFS_GNU_EXT2FS_QUOTA_H_ */