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