include/linux/quota.h

   1 /*
   2  * Copyright (c) 1982, 1986 Regents of the University of California.
   3  * 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  * Version: $Id: quota.h,v 2.0 1996/11/17 16:48:14 mvw Exp mvw $
  33  */
  34
  35 #ifndef _LINUX_QUOTA_
  36 #define _LINUX_QUOTA_
  37
  38 #include <linux/errno.h>
  39 #include <linux/types.h>
  40 #include <linux/spinlock.h>
  41
  42 #define __DQUOT_VERSION__       "dquot_6.5.1"
  43 #define __DQUOT_NUM_VERSION__   6*10000+5*100+1
  44
  45 typedef __kernel_uid32_t qid_t; /* Type in which we store ids in memory */
  46 typedef __u64 qsize_t;          /* Type in which we store sizes */
  47
  48 extern spinlock_t dq_list_lock;
  49 extern spinlock_t dq_data_lock;
  50
  51 /* Size of blocks in which are counted size limits */
  52 #define QUOTABLOCK_BITS 10
  53 #define QUOTABLOCK_SIZE (1 << QUOTABLOCK_BITS)
  54
  55 /* Conversion routines from and to quota blocks */
  56 #define qb2kb(x) ((x) << (QUOTABLOCK_BITS-10))
  57 #define kb2qb(x) ((x) >> (QUOTABLOCK_BITS-10))
  58 #define toqb(x) (((x) + QUOTABLOCK_SIZE - 1) >> QUOTABLOCK_BITS)
  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
  73 /*
  74  * Command definitions for the 'quotactl' system call.
  75  * The commands are broken into a main command defined below
  76  * and a subcommand that is used to convey the type of
  77  * quota that is being manipulated (see above).
  78  */
  79 #define SUBCMDMASK  0x00ff
  80 #define SUBCMDSHIFT 8
  81 #define QCMD(cmd, type)  (((cmd) << SUBCMDSHIFT) | ((type) & SUBCMDMASK))
  82
  83 #define Q_SYNC     0x800001     /* sync disk copy of a filesystems quotas */
  84 #define Q_QUOTAON  0x800002     /* turn quotas on */
  85 #define Q_QUOTAOFF 0x800003     /* turn quotas off */
  86 #define Q_GETFMT   0x800004     /* get quota format used on given filesystem */
  87 #define Q_GETINFO  0x800005     /* get information about quota files */
  88 #define Q_SETINFO  0x800006     /* set information about quota files */
  89 #define Q_GETQUOTA 0x800007     /* get user quota structure */
  90 #define Q_SETQUOTA 0x800008     /* set user quota structure */
  91
  92 /*
  93  * Quota structure used for communication with userspace via quotactl
  94  * Following flags are used to specify which fields are valid
  95  */
  96 #define QIF_BLIMITS     1
  97 #define QIF_SPACE       2
  98 #define QIF_ILIMITS     4
  99 #define QIF_INODES      8
 100 #define QIF_BTIME       16
 101 #define QIF_ITIME       32
 102 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
 103 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
 104 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
 105 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
 106
 107 struct if_dqblk {
 108         __u64 dqb_bhardlimit;
 109         __u64 dqb_bsoftlimit;
 110         __u64 dqb_curspace;
 111         __u64 dqb_ihardlimit;
 112         __u64 dqb_isoftlimit;
 113         __u64 dqb_curinodes;
 114         __u64 dqb_btime;
 115         __u64 dqb_itime;
 116         __u32 dqb_valid;
 117 };
 118
 119 /*
 120  * Structure used for setting quota information about file via quotactl
 121  * Following flags are used to specify which fields are valid
 122  */
 123 #define IIF_BGRACE      1
 124 #define IIF_IGRACE      2
 125 #define IIF_FLAGS       4
 126 #define IIF_ALL         (IIF_BGRACE | IIF_IGRACE | IIF_FLAGS)
 127
 128 struct if_dqinfo {
 129         __u64 dqi_bgrace;
 130         __u64 dqi_igrace;
 131         __u32 dqi_flags;
 132         __u32 dqi_valid;
 133 };
 134
 135 #ifdef __KERNEL__
 136
 137 #include <linux/dqblk_xfs.h>
 138 #include <linux/dqblk_v1.h>
 139 #include <linux/dqblk_v2.h>
 140
 141 /* Maximal numbers of writes for quota operation (insert/delete/update)
 142  * (over all formats) - info block, 4 pointer blocks, data block */
 143 #define DQUOT_MAX_WRITES        6
 144
 145 /*
 146  * Data for one user/group kept in memory
 147  */
 148 struct mem_dqblk {
 149         __u32 dqb_bhardlimit;   /* absolute limit on disk blks alloc */
 150         __u32 dqb_bsoftlimit;   /* preferred limit on disk blks */
 151         qsize_t dqb_curspace;   /* current used space */
 152         __u32 dqb_ihardlimit;   /* absolute limit on allocated inodes */
 153         __u32 dqb_isoftlimit;   /* preferred inode limit */
 154         __u32 dqb_curinodes;    /* current # allocated inodes */
 155         time_t dqb_btime;       /* time limit for excessive disk use */
 156         time_t dqb_itime;       /* time limit for excessive inode use */
 157 };
 158
 159 /*
 160  * Data for one quotafile kept in memory
 161  */
 162 struct quota_format_type;
 163
 164 struct mem_dqinfo {
 165         struct quota_format_type *dqi_format;
 166         struct list_head dqi_dirty_list;        /* List of dirty dquots */
 167         unsigned long dqi_flags;
 168         unsigned int dqi_bgrace;
 169         unsigned int dqi_igrace;
 170         union {
 171                 struct v1_mem_dqinfo v1_i;
 172                 struct v2_mem_dqinfo v2_i;
 173         } u;
 174 };
 175
 176 struct super_block;
 177
 178 #define DQF_MASK 0xffff         /* Mask for format specific flags */
 179 #define DQF_INFO_DIRTY_B 16
 180 #define DQF_INFO_DIRTY (1 << DQF_INFO_DIRTY_B)  /* Is info dirty? */
 181
 182 extern void mark_info_dirty(struct super_block *sb, int type);
 183 #define info_dirty(info) test_bit(DQF_INFO_DIRTY_B, &(info)->dqi_flags)
 184 #define info_any_dquot_dirty(info) (!list_empty(&(info)->dqi_dirty_list))
 185 #define info_any_dirty(info) (info_dirty(info) || info_any_dquot_dirty(info))
 186
 187 #define sb_dqopt(sb) (&(sb)->s_dquot)
 188 #define sb_dqinfo(sb, type) (sb_dqopt(sb)->info+(type))
 189
 190 struct dqstats {
 191         int lookups;
 192         int drops;
 193         int reads;
 194         int writes;
 195         int cache_hits;
 196         int allocated_dquots;
 197         int free_dquots;
 198         int syncs;
 199 };
 200
 201 extern struct dqstats dqstats;
 202
 203 #define DQ_MOD_B        0       /* dquot modified since read */
 204 #define DQ_BLKS_B       1       /* uid/gid has been warned about blk limit */
 205 #define DQ_INODES_B     2       /* uid/gid has been warned about inode limit */
 206 #define DQ_FAKE_B       3       /* no limits only usage */
 207 #define DQ_READ_B       4       /* dquot was read into memory */
 208 #define DQ_ACTIVE_B     5       /* dquot is active (dquot_release not called) */
 209 #define DQ_WAITFREE_B   6       /* dquot being waited (by invalidate_dquots) */
 210
 211 struct dquot {
 212         struct hlist_node dq_hash;      /* Hash list in memory */
 213         struct list_head dq_inuse;      /* List of all quotas */
 214         struct list_head dq_free;       /* Free list element */
 215         struct list_head dq_dirty;      /* List of dirty dquots */
 216         struct semaphore dq_lock;       /* dquot IO lock */
 217         atomic_t dq_count;              /* Use count */
 218         wait_queue_head_t dq_wait_unused;       /* Wait queue for dquot to become unused */
 219         struct super_block *dq_sb;      /* superblock this applies to */
 220         unsigned int dq_id;             /* ID this applies to (uid, gid) */
 221         loff_t dq_off;                  /* Offset of dquot on disk */
 222         unsigned long dq_flags;         /* See DQ_* */
 223         short dq_type;                  /* Type of quota */
 224         struct mem_dqblk dq_dqb;        /* Diskquota usage */
 225 };
 226
 227 #define NODQUOT (struct dquot *)NULL
 228
 229 #define QUOTA_OK          0
 230 #define NO_QUOTA          1
 231
 232 /* Operations which must be implemented by each quota format */
 233 struct quota_format_ops {
 234         int (*check_quota_file)(struct super_block *sb, int type);      /* Detect whether file is in our format */
 235         int (*read_file_info)(struct super_block *sb, int type);        /* Read main info about file - called on quotaon() */
 236         int (*write_file_info)(struct super_block *sb, int type);       /* Write main info about file */
 237         int (*free_file_info)(struct super_block *sb, int type);        /* Called on quotaoff() */
 238         int (*read_dqblk)(struct dquot *dquot);         /* Read structure for one user */
 239         int (*commit_dqblk)(struct dquot *dquot);       /* Write structure for one user */
 240         int (*release_dqblk)(struct dquot *dquot);      /* Called when last reference to dquot is being dropped */
 241 };
 242
 243 /* Operations working with dquots */
 244 struct dquot_operations {
 245         int (*initialize) (struct inode *, int);
 246         int (*drop) (struct inode *);
 247         int (*alloc_space) (struct inode *, qsize_t, int);
 248         int (*alloc_inode) (const struct inode *, unsigned long);
 249         int (*free_space) (struct inode *, qsize_t);
 250         int (*free_inode) (const struct inode *, unsigned long);
 251         int (*transfer) (struct inode *, struct iattr *);
 252         int (*write_dquot) (struct dquot *);            /* Ordinary dquot write */
 253         int (*acquire_dquot) (struct dquot *);          /* Quota is going to be created on disk */
 254         int (*release_dquot) (struct dquot *);          /* Quota is going to be deleted from disk */
 255         int (*mark_dirty) (struct dquot *);             /* Dquot is marked dirty */
 256         int (*write_info) (struct super_block *, int);  /* Write of quota "superblock" */
 257 };
 258
 259 /* Operations handling requests from userspace */
 260 struct quotactl_ops {
 261         int (*quota_on)(struct super_block *, int, int, char *);
 262         int (*quota_off)(struct super_block *, int);
 263         int (*quota_sync)(struct super_block *, int);
 264         int (*get_info)(struct super_block *, int, struct if_dqinfo *);
 265         int (*set_info)(struct super_block *, int, struct if_dqinfo *);
 266         int (*get_dqblk)(struct super_block *, int, qid_t, struct if_dqblk *);
 267         int (*set_dqblk)(struct super_block *, int, qid_t, struct if_dqblk *);
 268         int (*get_xstate)(struct super_block *, struct fs_quota_stat *);
 269         int (*set_xstate)(struct super_block *, unsigned int, int);
 270         int (*get_xquota)(struct super_block *, int, qid_t, struct fs_disk_quota *);
 271         int (*set_xquota)(struct super_block *, int, qid_t, struct fs_disk_quota *);
 272 };
 273
 274 struct quota_format_type {
 275         int qf_fmt_id;  /* Quota format id */
 276         struct quota_format_ops *qf_ops;        /* Operations of format */
 277         struct module *qf_owner;                /* Module implementing quota format */
 278         struct quota_format_type *qf_next;
 279 };
 280
 281 #define DQUOT_USR_ENABLED       0x01            /* User diskquotas enabled */
 282 #define DQUOT_GRP_ENABLED       0x02            /* Group diskquotas enabled */
 283
 284 struct quota_info {
 285         unsigned int flags;                     /* Flags for diskquotas on this device */
 286         struct semaphore dqio_sem;              /* lock device while I/O in progress */
 287         struct semaphore dqonoff_sem;           /* Serialize quotaon & quotaoff */
 288         struct rw_semaphore dqptr_sem;          /* serialize ops using quota_info struct, pointers from inode to dquots */
 289         struct file *files[MAXQUOTAS];          /* fp's to quotafiles */
 290         struct mem_dqinfo info[MAXQUOTAS];      /* Information for each quota type */
 291         struct quota_format_ops *ops[MAXQUOTAS];        /* Operations for each type */
 292 };
 293
 294 /* Inline would be better but we need to dereference super_block which is not defined yet */
 295 int mark_dquot_dirty(struct dquot *dquot);
 296
 297 #define dquot_dirty(dquot) test_bit(DQ_MOD_B, &(dquot)->dq_flags)
 298
 299 #define sb_has_quota_enabled(sb, type) ((type)==USRQUOTA ? \
 300         (sb_dqopt(sb)->flags & DQUOT_USR_ENABLED) : (sb_dqopt(sb)->flags & DQUOT_GRP_ENABLED))
 301
 302 #define sb_any_quota_enabled(sb) (sb_has_quota_enabled(sb, USRQUOTA) | \
 303                                   sb_has_quota_enabled(sb, GRPQUOTA))
 304
 305 int register_quota_format(struct quota_format_type *fmt);
 306 void unregister_quota_format(struct quota_format_type *fmt);
 307
 308 struct quota_module_name {
 309         int qm_fmt_id;
 310         char *qm_mod_name;
 311 };
 312
 313 #define INIT_QUOTA_MODULE_NAMES {\
 314         {QFMT_VFS_OLD, "quota_v1"},\
 315         {QFMT_VFS_V0, "quota_v2"},\
 316         {0, NULL}}
 317
 318 #else
 319
 320 # /* nodep */ include <sys/cdefs.h>
 321
 322 __BEGIN_DECLS
 323 long quotactl __P ((unsigned int, const char *, int, caddr_t));
 324 __END_DECLS
 325
 326 #endif /* __KERNEL__ */
 327 #endif /* _QUOTA_ */