1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 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 35 #ifndef _UFS_UFS_QUOTA_H_ 36 #define _UFS_UFS_QUOTA_H_ 37 38 /* 39 * Definitions for disk quotas imposed on the average user 40 * (big brother finally hits UNIX). 41 * 42 * The following constants define the amount of time given a user before the 43 * soft limits are treated as hard limits (usually resulting in an allocation 44 * failure). The timer is started when the user crosses their soft limit, it 45 * is reset when they go below their soft limit. 46 */ 47 #define MAX_IQ_TIME (7*24*60*60) /* seconds in 1 week */ 48 #define MAX_DQ_TIME (7*24*60*60) /* seconds in 1 week */ 49 50 /* 51 * The following constants define the usage of the quota file array in the 52 * ufsmount structure and dquot array in the inode structure. The semantics 53 * of the elements of these arrays are defined in the routine getinoquota; 54 * the remainder of the quota code treats them generically and need not be 55 * inspected when changing the size of the array. 56 */ 57 #define MAXQUOTAS 2 58 #define USRQUOTA 0 /* element used for user quotas */ 59 #define GRPQUOTA 1 /* element used for group quotas */ 60 61 /* 62 * Definitions for the default names of the quotas files. 63 */ 64 #define INITQFNAMES { \ 65 "user", /* USRQUOTA */ \ 66 "group", /* GRPQUOTA */ \ 67 "undefined", \ 68 } 69 #define QUOTAFILENAME "quota" 70 #define QUOTAGROUP "operator" 71 72 /* 73 * Command definitions for the 'quotactl' system call. The commands are 74 * broken into a main command defined below and a subcommand that is used 75 * to convey the type of quota that is being manipulated (see above). 76 */ 77 #define SUBCMDMASK 0x00ff 78 #define SUBCMDSHIFT 8 79 #define QCMD(cmd, type) (((cmd) << SUBCMDSHIFT) | ((type) & SUBCMDMASK)) 80 81 #define Q_QUOTAON 0x0100 /* enable quotas */ 82 #define Q_QUOTAOFF 0x0200 /* disable quotas */ 83 #define Q_GETQUOTA32 0x0300 /* get limits and usage (32-bit version) */ 84 #define Q_SETQUOTA32 0x0400 /* set limits and usage (32-bit version) */ 85 #define Q_SETUSE32 0x0500 /* set usage (32-bit version) */ 86 #define Q_SYNC 0x0600 /* sync disk copy of a filesystems quotas */ 87 #define Q_GETQUOTA 0x0700 /* get limits and usage (64-bit version) */ 88 #define Q_SETQUOTA 0x0800 /* set limits and usage (64-bit version) */ 89 #define Q_SETUSE 0x0900 /* set usage (64-bit version) */ 90 #define Q_GETQUOTASIZE 0x0A00 /* get bit-size of quota file fields */ 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 dqblk32 { 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 int32_t dqb_btime; /* time limit for excessive disk use */ 107 int32_t dqb_itime; /* time limit for excessive files */ 108 }; 109 110 struct dqblk64 { 111 uint64_t dqb_bhardlimit; /* absolute limit on disk blks alloc */ 112 uint64_t dqb_bsoftlimit; /* preferred limit on disk blks */ 113 uint64_t dqb_curblocks; /* current block count */ 114 uint64_t dqb_ihardlimit; /* maximum # allocated inodes + 1 */ 115 uint64_t dqb_isoftlimit; /* preferred inode limit */ 116 uint64_t dqb_curinodes; /* current # allocated inodes */ 117 int64_t dqb_btime; /* time limit for excessive disk use */ 118 int64_t dqb_itime; /* time limit for excessive files */ 119 }; 120 121 #define dqblk dqblk64 122 123 #define Q_DQHDR64_MAGIC "QUOTA64" 124 #define Q_DQHDR64_VERSION 0x20081104 125 126 struct dqhdr64 { 127 char dqh_magic[8]; /* Q_DQHDR64_MAGIC */ 128 uint32_t dqh_version; /* Q_DQHDR64_VERSION */ 129 uint32_t dqh_hdrlen; /* header length */ 130 uint32_t dqh_reclen; /* record length */ 131 char dqh_unused[44]; /* reserved for future extension */ 132 }; 133 134 #ifdef _KERNEL 135 136 #include <sys/queue.h> 137 138 /* 139 * The following structure records disk usage for a user or group on a 140 * filesystem. There is one allocated for each quota that exists on any 141 * filesystem for the current user or group. A cache is kept of recently 142 * used entries. 143 * (h) protected by dqhlock 144 */ 145 struct dquot { 146 LIST_ENTRY(dquot) dq_hash; /* (h) hash list */ 147 TAILQ_ENTRY(dquot) dq_freelist; /* (h) free list */ 148 struct mtx dq_lock; /* lock for concurrency */ 149 uint16_t dq_flags; /* flags, see below */ 150 uint16_t dq_type; /* quota type of this dquot */ 151 uint32_t dq_cnt; /* (h) count of active references */ 152 uint32_t dq_id; /* identifier this applies to */ 153 struct ufsmount *dq_ump; /* (h) filesystem that this is 154 taken from */ 155 struct dqblk64 dq_dqb; /* actual usage & quotas */ 156 }; 157 /* 158 * Flag values. 159 */ 160 #define DQ_LOCK 0x01 /* this quota locked (no MODS) */ 161 #define DQ_WANT 0x02 /* wakeup on unlock */ 162 #define DQ_MOD 0x04 /* this quota modified since read */ 163 #define DQ_FAKE 0x08 /* no limits here, just usage */ 164 #define DQ_BLKS 0x10 /* has been warned about blk limit */ 165 #define DQ_INODS 0x20 /* has been warned about inode limit */ 166 /* 167 * Shorthand notation. 168 */ 169 #define dq_bhardlimit dq_dqb.dqb_bhardlimit 170 #define dq_bsoftlimit dq_dqb.dqb_bsoftlimit 171 #define dq_curblocks dq_dqb.dqb_curblocks 172 #define dq_ihardlimit dq_dqb.dqb_ihardlimit 173 #define dq_isoftlimit dq_dqb.dqb_isoftlimit 174 #define dq_curinodes dq_dqb.dqb_curinodes 175 #define dq_btime dq_dqb.dqb_btime 176 #define dq_itime dq_dqb.dqb_itime 177 178 /* 179 * If the system has never checked for a quota for this file, then it is 180 * set to NODQUOT. Once a write attempt is made the inode pointer is set 181 * to reference a dquot structure. 182 */ 183 #define NODQUOT NULL 184 185 /* 186 * Flags to chkdq() and chkiq() 187 */ 188 #define FORCE 0x01 /* force usage changes independent of limits */ 189 #define CHOWN 0x02 /* (advisory) change initiated by chown */ 190 191 /* 192 * Macros to avoid subroutine calls to trivial functions. 193 */ 194 #ifdef DIAGNOSTIC 195 #define DQREF(dq) dqref(dq) 196 #else 197 #define DQREF(dq) (dq)->dq_cnt++ 198 #endif 199 200 #define DQI_LOCK(dq) mtx_lock(&(dq)->dq_lock) 201 #define DQI_UNLOCK(dq) mtx_unlock(&(dq)->dq_lock) 202 203 #define DQI_WAIT(dq, prio, msg) do { \ 204 while ((dq)->dq_flags & DQ_LOCK) { \ 205 (dq)->dq_flags |= DQ_WANT; \ 206 (void) msleep((dq), \ 207 &(dq)->dq_lock, (prio), (msg), 0); \ 208 } \ 209 } while (0) 210 211 #define DQI_WAKEUP(dq) do { \ 212 if ((dq)->dq_flags & DQ_WANT) \ 213 wakeup((dq)); \ 214 (dq)->dq_flags &= ~(DQ_WANT|DQ_LOCK); \ 215 } while (0) 216 217 struct inode; 218 struct mount; 219 struct thread; 220 struct ucred; 221 struct vnode; 222 223 int chkdq(struct inode *, int64_t, struct ucred *, int); 224 int chkiq(struct inode *, int, struct ucred *, int); 225 void dqinit(void); 226 void dqrele(struct vnode *, struct dquot *); 227 void dquninit(void); 228 int getinoquota(struct inode *); 229 int qsync(struct mount *); 230 int qsyncvp(struct vnode *); 231 int quotaoff(struct thread *, struct mount *, int); 232 int quotaon(struct thread *, struct mount *, int, void *, bool *); 233 int getquota32(struct thread *, struct mount *, uint64_t, int, void *); 234 int setquota32(struct thread *, struct mount *, uint64_t, int, void *); 235 int setuse32(struct thread *, struct mount *, uint64_t, int, void *); 236 int getquota(struct thread *, struct mount *, uint64_t, int, void *); 237 int setquota(struct thread *, struct mount *, uint64_t, int, void *); 238 int setuse(struct thread *, struct mount *, uint64_t, int, void *); 239 int getquotasize(struct thread *, struct mount *, uint64_t, int, void *); 240 vfs_quotactl_t ufs_quotactl; 241 242 #ifdef SOFTUPDATES 243 int quotaref(struct vnode *, struct dquot **); 244 void quotarele(struct dquot **); 245 void quotaadj(struct dquot **, struct ufsmount *, int64_t); 246 #endif /* SOFTUPDATES */ 247 248 #else /* !_KERNEL */ 249 250 #include <sys/cdefs.h> 251 252 __BEGIN_DECLS 253 int quotactl(const char *, int, int, void *); 254 __END_DECLS 255 256 #endif /* _KERNEL */ 257 258 #endif /* !_UFS_UFS_QUOTA_H_ */ 259