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
  33 #ifndef _LINUX_QUOTA_
  34 #define _LINUX_QUOTA_
  35
  36 #include <linux/errno.h>
  37 #include <linux/types.h>
  38
  39 #define __DQUOT_VERSION__       "dquot_6.5.2"
  40
  41 #define MAXQUOTAS 2
  42 #define USRQUOTA  0             /* element used for user quotas */
  43 #define GRPQUOTA  1             /* element used for group quotas */
  44
  45 /*
  46  * Definitions for the default names of the quotas files.
  47  */
  48 #define INITQFNAMES { \
  49         "user",    /* USRQUOTA */ \
  50         "group",   /* GRPQUOTA */ \
  51         "undefined", \
  52 };
  53
  54 /*
  55  * Command definitions for the 'quotactl' system call.
  56  * The commands are broken into a main command defined below
  57  * and a subcommand that is used to convey the type of
  58  * quota that is being manipulated (see above).
  59  */
  60 #define SUBCMDMASK  0x00ff
  61 #define SUBCMDSHIFT 8
  62 #define QCMD(cmd, type)  (((cmd) << SUBCMDSHIFT) | ((type) & SUBCMDMASK))
  63
  64 #define Q_SYNC     0x800001     /* sync disk copy of a filesystems quotas */
  65 #define Q_QUOTAON  0x800002     /* turn quotas on */
  66 #define Q_QUOTAOFF 0x800003     /* turn quotas off */
  67 #define Q_GETFMT   0x800004     /* get quota format used on given filesystem */
  68 #define Q_GETINFO  0x800005     /* get information about quota files */
  69 #define Q_SETINFO  0x800006     /* set information about quota files */
  70 #define Q_GETQUOTA 0x800007     /* get user quota structure */
  71 #define Q_SETQUOTA 0x800008     /* set user quota structure */
  72
  73 /* Size of block in which space limits are passed through the quota
  74  * interface */
  75 #define QIF_DQBLKSIZE_BITS 10
  76 #define QIF_DQBLKSIZE (1 << QIF_DQBLKSIZE_BITS)
  77
  78 /*
  79  * Quota structure used for communication with userspace via quotactl
  80  * Following flags are used to specify which fields are valid
  81  */
  82 enum {
  83         QIF_BLIMITS_B = 0,
  84         QIF_SPACE_B,
  85         QIF_ILIMITS_B,
  86         QIF_INODES_B,
  87         QIF_BTIME_B,
  88         QIF_ITIME_B,
  89 };
  90
  91 #define QIF_BLIMITS     (1 << QIF_BLIMITS_B)
  92 #define QIF_SPACE       (1 << QIF_SPACE_B)
  93 #define QIF_ILIMITS     (1 << QIF_ILIMITS_B)
  94 #define QIF_INODES      (1 << QIF_INODES_B)
  95 #define QIF_BTIME       (1 << QIF_BTIME_B)
  96 #define QIF_ITIME       (1 << QIF_ITIME_B)
  97 #define QIF_LIMITS      (QIF_BLIMITS | QIF_ILIMITS)
  98 #define QIF_USAGE       (QIF_SPACE | QIF_INODES)
  99 #define QIF_TIMES       (QIF_BTIME | QIF_ITIME)
 100 #define QIF_ALL         (QIF_LIMITS | QIF_USAGE | QIF_TIMES)
 101
 102 struct if_dqblk {
 103         __u64 dqb_bhardlimit;
 104         __u64 dqb_bsoftlimit;
 105         __u64 dqb_curspace;
 106         __u64 dqb_ihardlimit;
 107         __u64 dqb_isoftlimit;
 108         __u64 dqb_curinodes;
 109         __u64 dqb_btime;
 110         __u64 dqb_itime;
 111         __u32 dqb_valid;
 112 };
 113
 114 /*
 115  * Structure used for setting quota information about file via quotactl
 116  * Following flags are used to specify which fields are valid
 117  */
 118 #define IIF_BGRACE      1
 119 #define IIF_IGRACE      2
 120 #define IIF_FLAGS       4
 121 #define IIF_ALL         (IIF_BGRACE | IIF_IGRACE | IIF_FLAGS)
 122
 123 struct if_dqinfo {
 124         __u64 dqi_bgrace;
 125         __u64 dqi_igrace;
 126         __u32 dqi_flags;
 127         __u32 dqi_valid;
 128 };
 129
 130 /*
 131  * Definitions for quota netlink interface
 132  */
 133 #define QUOTA_NL_NOWARN 0
 134 #define QUOTA_NL_IHARDWARN 1            /* Inode hardlimit reached */
 135 #define QUOTA_NL_ISOFTLONGWARN 2        /* Inode grace time expired */
 136 #define QUOTA_NL_ISOFTWARN 3            /* Inode softlimit reached */
 137 #define QUOTA_NL_BHARDWARN 4            /* Block hardlimit reached */
 138 #define QUOTA_NL_BSOFTLONGWARN 5        /* Block grace time expired */
 139 #define QUOTA_NL_BSOFTWARN 6            /* Block softlimit reached */
 140 #define QUOTA_NL_IHARDBELOW 7           /* Usage got below inode hardlimit */
 141 #define QUOTA_NL_ISOFTBELOW 8           /* Usage got below inode softlimit */
 142 #define QUOTA_NL_BHARDBELOW 9           /* Usage got below block hardlimit */
 143 #define QUOTA_NL_BSOFTBELOW 10          /* Usage got below block softlimit */
 144
 145 enum {
 146         QUOTA_NL_C_UNSPEC,
 147         QUOTA_NL_C_WARNING,
 148         __QUOTA_NL_C_MAX,
 149 };
 150 #define QUOTA_NL_C_MAX (__QUOTA_NL_C_MAX - 1)
 151
 152 enum {
 153         QUOTA_NL_A_UNSPEC,
 154         QUOTA_NL_A_QTYPE,
 155         QUOTA_NL_A_EXCESS_ID,
 156         QUOTA_NL_A_WARNING,
 157         QUOTA_NL_A_DEV_MAJOR,
 158         QUOTA_NL_A_DEV_MINOR,
 159         QUOTA_NL_A_CAUSED_ID,
 160         __QUOTA_NL_A_MAX,
 161 };
 162 #define QUOTA_NL_A_MAX (__QUOTA_NL_A_MAX - 1)
 163
 164
 165 #ifdef __KERNEL__
 166 #include <linux/list.h>
 167 #include <linux/mutex.h>
 168 #include <linux/rwsem.h>
 169 #include <linux/spinlock.h>
 170 #include <linux/wait.h>
 171
 172 #include <linux/dqblk_xfs.h>
 173 #include <linux/dqblk_v1.h>
 174 #include <linux/dqblk_v2.h>
 175
 176 #include <asm/atomic.h>
 177
 178 typedef __kernel_uid32_t qid_t; /* Type in which we store ids in memory */
 179 typedef long long qsize_t;      /* Type in which we store sizes */
 180
 181 extern spinlock_t dq_data_lock;
 182
 183 /* Maximal numbers of writes for quota operation (insert/delete/update)
 184  * (over VFS all formats) */
 185 #define DQUOT_INIT_ALLOC max(V1_INIT_ALLOC, V2_INIT_ALLOC)
 186 #define DQUOT_INIT_REWRITE max(V1_INIT_REWRITE, V2_INIT_REWRITE)
 187 #define DQUOT_DEL_ALLOC max(V1_DEL_ALLOC, V2_DEL_ALLOC)
 188 #define DQUOT_DEL_REWRITE max(V1_DEL_REWRITE, V2_DEL_REWRITE)
 189
 190 /*
 191  * Data for one user/group kept in memory
 192  */
 193 struct mem_dqblk {
 194         qsize_t dqb_bhardlimit; /* absolute limit on disk blks alloc */
 195         qsize_t dqb_bsoftlimit; /* preferred limit on disk blks */
 196         qsize_t dqb_curspace;   /* current used space */
 197         qsize_t dqb_ihardlimit; /* absolute limit on allocated inodes */
 198         qsize_t dqb_isoftlimit; /* preferred inode limit */
 199         qsize_t dqb_curinodes;  /* current # allocated inodes */
 200         time_t dqb_btime;       /* time limit for excessive disk use */
 201         time_t dqb_itime;       /* time limit for excessive inode use */
 202 };
 203
 204 /*
 205  * Data for one quotafile kept in memory
 206  */
 207 struct quota_format_type;
 208
 209 struct mem_dqinfo {
 210         struct quota_format_type *dqi_format;
 211         int dqi_fmt_id;         /* Id of the dqi_format - used when turning
 212                                  * quotas on after remount RW */
 213         struct list_head dqi_dirty_list;        /* List of dirty dquots */
 214         unsigned long dqi_flags;
 215         unsigned int dqi_bgrace;
 216         unsigned int dqi_igrace;
 217         qsize_t dqi_maxblimit;
 218         qsize_t dqi_maxilimit;
 219         void *dqi_priv;
 220 };
 221
 222 struct super_block;
 223
 224 #define DQF_MASK 0xffff         /* Mask for format specific flags */
 225 #define DQF_INFO_DIRTY_B 16
 226 #define DQF_INFO_DIRTY (1 << DQF_INFO_DIRTY_B)  /* Is info dirty? */
 227
 228 extern void mark_info_dirty(struct super_block *sb, int type);
 229 static inline int info_dirty(struct mem_dqinfo *info)
 230 {
 231         return test_bit(DQF_INFO_DIRTY_B, &info->dqi_flags);
 232 }
 233
 234 struct dqstats {
 235         int lookups;
 236         int drops;
 237         int reads;
 238         int writes;
 239         int cache_hits;
 240         int allocated_dquots;
 241         int free_dquots;
 242         int syncs;
 243 };
 244
 245 extern struct dqstats dqstats;
 246
 247 #define DQ_MOD_B        0       /* dquot modified since read */
 248 #define DQ_BLKS_B       1       /* uid/gid has been warned about blk limit */
 249 #define DQ_INODES_B     2       /* uid/gid has been warned about inode limit */
 250 #define DQ_FAKE_B       3       /* no limits only usage */
 251 #define DQ_READ_B       4       /* dquot was read into memory */
 252 #define DQ_ACTIVE_B     5       /* dquot is active (dquot_release not called) */
 253 #define DQ_LASTSET_B    6       /* Following 6 bits (see QIF_) are reserved\
 254                                  * for the mask of entries set via SETQUOTA\
 255                                  * quotactl. They are set under dq_data_lock\
 256                                  * and the quota format handling dquot can\
 257                                  * clear them when it sees fit. */
 258
 259 struct dquot {
 260         struct hlist_node dq_hash;      /* Hash list in memory */
 261         struct list_head dq_inuse;      /* List of all quotas */
 262         struct list_head dq_free;       /* Free list element */
 263         struct list_head dq_dirty;      /* List of dirty dquots */
 264         struct mutex dq_lock;           /* dquot IO lock */
 265         atomic_t dq_count;              /* Use count */
 266         wait_queue_head_t dq_wait_unused;       /* Wait queue for dquot to become unused */
 267         struct super_block *dq_sb;      /* superblock this applies to */
 268         unsigned int dq_id;             /* ID this applies to (uid, gid) */
 269         loff_t dq_off;                  /* Offset of dquot on disk */
 270         unsigned long dq_flags;         /* See DQ_* */
 271         short dq_type;                  /* Type of quota */
 272         struct mem_dqblk dq_dqb;        /* Diskquota usage */
 273 };
 274
 275 #define NODQUOT (struct dquot *)NULL
 276
 277 #define QUOTA_OK          0
 278 #define NO_QUOTA          1
 279
 280 /* Operations which must be implemented by each quota format */
 281 struct quota_format_ops {
 282         int (*check_quota_file)(struct super_block *sb, int type);      /* Detect whether file is in our format */
 283         int (*read_file_info)(struct super_block *sb, int type);        /* Read main info about file - called on quotaon() */
 284         int (*write_file_info)(struct super_block *sb, int type);       /* Write main info about file */
 285         int (*free_file_info)(struct super_block *sb, int type);        /* Called on quotaoff() */
 286         int (*read_dqblk)(struct dquot *dquot);         /* Read structure for one user */
 287         int (*commit_dqblk)(struct dquot *dquot);       /* Write structure for one user */
 288         int (*release_dqblk)(struct dquot *dquot);      /* Called when last reference to dquot is being dropped */
 289 };
 290
 291 /* Operations working with dquots */
 292 struct dquot_operations {
 293         int (*initialize) (struct inode *, int);
 294         int (*drop) (struct inode *);
 295         int (*alloc_space) (struct inode *, qsize_t, int);
 296         int (*alloc_inode) (const struct inode *, qsize_t);
 297         int (*free_space) (struct inode *, qsize_t);
 298         int (*free_inode) (const struct inode *, qsize_t);
 299         int (*transfer) (struct inode *, struct iattr *);
 300         int (*write_dquot) (struct dquot *);            /* Ordinary dquot write */
 301         struct dquot *(*alloc_dquot)(struct super_block *, int);        /* Allocate memory for new dquot */
 302         void (*destroy_dquot)(struct dquot *);          /* Free memory for dquot */
 303         int (*acquire_dquot) (struct dquot *);          /* Quota is going to be created on disk */
 304         int (*release_dquot) (struct dquot *);          /* Quota is going to be deleted from disk */
 305         int (*mark_dirty) (struct dquot *);             /* Dquot is marked dirty */
 306         int (*write_info) (struct super_block *, int);  /* Write of quota "superblock" */
 307 };
 308
 309 /* Operations handling requests from userspace */
 310 struct quotactl_ops {
 311         int (*quota_on)(struct super_block *, int, int, char *, int);
 312         int (*quota_off)(struct super_block *, int, int);
 313         int (*quota_sync)(struct super_block *, int);
 314         int (*get_info)(struct super_block *, int, struct if_dqinfo *);
 315         int (*set_info)(struct super_block *, int, struct if_dqinfo *);
 316         int (*get_dqblk)(struct super_block *, int, qid_t, struct if_dqblk *);
 317         int (*set_dqblk)(struct super_block *, int, qid_t, struct if_dqblk *);
 318         int (*get_xstate)(struct super_block *, struct fs_quota_stat *);
 319         int (*set_xstate)(struct super_block *, unsigned int, int);
 320         int (*get_xquota)(struct super_block *, int, qid_t, struct fs_disk_quota *);
 321         int (*set_xquota)(struct super_block *, int, qid_t, struct fs_disk_quota *);
 322 };
 323
 324 struct quota_format_type {
 325         int qf_fmt_id;  /* Quota format id */
 326         struct quota_format_ops *qf_ops;        /* Operations of format */
 327         struct module *qf_owner;                /* Module implementing quota format */
 328         struct quota_format_type *qf_next;
 329 };
 330
 331 /* Quota state flags - they actually come in two flavors - for users and groups */
 332 enum {
 333         _DQUOT_USAGE_ENABLED = 0,               /* Track disk usage for users */
 334         _DQUOT_LIMITS_ENABLED,                  /* Enforce quota limits for users */
 335         _DQUOT_SUSPENDED,                       /* User diskquotas are off, but
 336                                                  * we have necessary info in
 337                                                  * memory to turn them on */
 338         _DQUOT_STATE_FLAGS
 339 };
 340 #define DQUOT_USAGE_ENABLED     (1 << _DQUOT_USAGE_ENABLED)
 341 #define DQUOT_LIMITS_ENABLED    (1 << _DQUOT_LIMITS_ENABLED)
 342 #define DQUOT_SUSPENDED         (1 << _DQUOT_SUSPENDED)
 343 #define DQUOT_STATE_FLAGS       (DQUOT_USAGE_ENABLED | DQUOT_LIMITS_ENABLED | \
 344                                  DQUOT_SUSPENDED)
 345 /* Other quota flags */
 346 #define DQUOT_QUOTA_SYS_FILE    (1 << 6)        /* Quota file is a special
 347                                                  * system file and user cannot
 348                                                  * touch it. Filesystem is
 349                                                  * responsible for setting
 350                                                  * S_NOQUOTA, S_NOATIME flags
 351                                                  */
 352 #define DQUOT_NEGATIVE_USAGE    (1 << 7)        /* Allow negative quota usage */
 353
 354 static inline unsigned int dquot_state_flag(unsigned int flags, int type)
 355 {
 356         if (type == USRQUOTA)
 357                 return flags;
 358         return flags << _DQUOT_STATE_FLAGS;
 359 }
 360
 361 static inline unsigned int dquot_generic_flag(unsigned int flags, int type)
 362 {
 363         if (type == USRQUOTA)
 364                 return flags;
 365         return flags >> _DQUOT_STATE_FLAGS;
 366 }
 367
 368 struct quota_info {
 369         unsigned int flags;                     /* Flags for diskquotas on this device */
 370         struct mutex dqio_mutex;                /* lock device while I/O in progress */
 371         struct mutex dqonoff_mutex;             /* Serialize quotaon & quotaoff */
 372         struct rw_semaphore dqptr_sem;          /* serialize ops using quota_info struct, pointers from inode to dquots */
 373         struct inode *files[MAXQUOTAS];         /* inodes of quotafiles */
 374         struct mem_dqinfo info[MAXQUOTAS];      /* Information for each quota type */
 375         struct quota_format_ops *ops[MAXQUOTAS];        /* Operations for each type */
 376 };
 377
 378 int register_quota_format(struct quota_format_type *fmt);
 379 void unregister_quota_format(struct quota_format_type *fmt);
 380
 381 struct quota_module_name {
 382         int qm_fmt_id;
 383         char *qm_mod_name;
 384 };
 385
 386 #define INIT_QUOTA_MODULE_NAMES {\
 387         {QFMT_VFS_OLD, "quota_v1"},\
 388         {QFMT_VFS_V0, "quota_v2"},\
 389         {0, NULL}}
 390
 391 #else
 392
 393 # /* nodep */ include <sys/cdefs.h>
 394
 395 __BEGIN_DECLS
 396 long quotactl __P ((unsigned int, const char *, int, caddr_t));
 397 __END_DECLS
 398
 399 #endif /* __KERNEL__ */
 400 #endif /* _QUOTA_ */