sys/ufs/ufs/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  * 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$
  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_GETQUOTA      0x0300  /* get limits and usage */
  85 #define Q_SETQUOTA      0x0400  /* set limits and usage */
  86 #define Q_SETUSE        0x0500  /* set usage */
  87 #define Q_SYNC          0x0600  /* sync disk copy of a filesystems quotas */
  88
  89 /*
  90  * The following structure defines the format of the disk quota file
  91  * (as it appears on disk) - the file is an array of these structures
  92  * indexed by user or group number.  The setquota system call establishes
  93  * the vnode for each quota file (a pointer is retained in the ufsmount
  94  * structure).
  95  */
  96 struct dqblk {
  97         u_int32_t dqb_bhardlimit;       /* absolute limit on disk blks alloc */
  98         u_int32_t dqb_bsoftlimit;       /* preferred limit on disk blks */
  99         u_int32_t dqb_curblocks;        /* current block count */
 100         u_int32_t dqb_ihardlimit;       /* maximum # allocated inodes + 1 */
 101         u_int32_t dqb_isoftlimit;       /* preferred inode limit */
 102         u_int32_t dqb_curinodes;        /* current # allocated inodes */
 103         int32_t   dqb_btime;            /* time limit for excessive disk use */
 104         int32_t   dqb_itime;            /* time limit for excessive files */
 105 };
 106
 107 #ifdef _KERNEL
 108
 109 #include <sys/queue.h>
 110
 111 /*
 112  * The following structure records disk usage for a user or group on a
 113  * filesystem. There is one allocated for each quota that exists on any
 114  * filesystem for the current user or group. A cache is kept of recently
 115  * used entries.
 116  * (h) protected by dqhlock
 117  */
 118 struct dquot {
 119         LIST_ENTRY(dquot) dq_hash;      /* (h) hash list */
 120         TAILQ_ENTRY(dquot) dq_freelist; /* (h) free list */
 121         struct mtx dq_lock;             /* lock for concurrency */
 122         u_int16_t dq_flags;             /* flags, see below */
 123         u_int16_t dq_type;              /* quota type of this dquot */
 124         u_int32_t dq_cnt;               /* (h) count of active references */
 125         u_int32_t dq_id;                /* identifier this applies to */
 126         struct ufsmount *dq_ump;        /* (h) filesystem that this is
 127                                            taken from */
 128         struct 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 chkdq() and 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)       dqref(dq)
 169 #else
 170 #define DQREF(dq)       (dq)->dq_cnt++
 171 #endif
 172
 173 #define DQI_LOCK(dq)    mtx_lock(&(dq)->dq_lock)
 174 #define DQI_UNLOCK(dq)  mtx_unlock(&(dq)->dq_lock)
 175
 176 #define DQI_WAIT(dq, prio, msg) do {            \
 177         while ((dq)->dq_flags & DQ_LOCK) {      \
 178                 (dq)->dq_flags |= DQ_WANT;      \
 179                 (void) msleep((dq),             \
 180                     &(dq)->dq_lock, (prio), (msg), 0); \
 181         }                                       \
 182 } while (0)
 183
 184 #define DQI_WAKEUP(dq) do {                     \
 185         if ((dq)->dq_flags & DQ_WANT)           \
 186                 wakeup((dq));                   \
 187         (dq)->dq_flags &= ~(DQ_WANT|DQ_LOCK);   \
 188 } while (0)
 189
 190 struct inode;
 191 struct mount;
 192 struct thread;
 193 struct ucred;
 194 struct vnode;
 195
 196 int     chkdq(struct inode *, int64_t, struct ucred *, int);
 197 int     chkiq(struct inode *, int, struct ucred *, int);
 198 void    dqinit(void);
 199 void    dqrele(struct vnode *, struct dquot *);
 200 void    dquninit(void);
 201 int     getinoquota(struct inode *);
 202 int     getquota(struct thread *, struct mount *, u_long, int, void *);
 203 int     qsync(struct mount *mp);
 204 int     quotaoff(struct thread *td, struct mount *, int);
 205 int     quotaon(struct thread *td, struct mount *, int, void *);
 206 int     setquota(struct thread *, struct mount *, u_long, int, void *);
 207 int     setuse(struct thread *, struct mount *, u_long, int, void *);
 208 vfs_quotactl_t ufs_quotactl;
 209
 210 #else /* !_KERNEL */
 211
 212 #include <sys/cdefs.h>
 213
 214 __BEGIN_DECLS
 215 int     quotactl(const char *, int, int, void *);
 216 __END_DECLS
 217
 218 #endif /* _KERNEL */
 219
 220 #endif /* !_UFS_UFS_QUOTA_H_ */