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