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