sys/ufs/ufs/quota.h

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