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