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 #ifndef _LINUX_QUOTA_
  33 #define _LINUX_QUOTA_
  34
  35 #include <linux/list.h>
  36 #include <linux/mutex.h>
  37 #include <linux/rwsem.h>
  38 #include <linux/spinlock.h>
  39 #include <linux/wait.h>
  40 #include <linux/percpu_counter.h>
  41
  42 #include <linux/dqblk_xfs.h>
  43 #include <linux/dqblk_v1.h>
  44 #include <linux/dqblk_v2.h>
  45
  46 #include <linux/atomic.h>
  47 #include <linux/uidgid.h>
  48 #include <linux/projid.h>
  49 #include <uapi/linux/quota.h>
  50
  51 #undef USRQUOTA
  52 #undef GRPQUOTA
  53 enum quota_type {
  54         USRQUOTA = 0,           /* element used for user quotas */
  55         GRPQUOTA = 1,           /* element used for group quotas */
  56         PRJQUOTA = 2,           /* element used for project quotas */
  57 };
  58
  59 /* Masks for quota types when used as a bitmask */
  60 #define QTYPE_MASK_USR (1 << USRQUOTA)
  61 #define QTYPE_MASK_GRP (1 << GRPQUOTA)
  62 #define QTYPE_MASK_PRJ (1 << PRJQUOTA)
  63
  64 typedef __kernel_uid32_t qid_t; /* Type in which we store ids in memory */
  65 typedef long long qsize_t;      /* Type in which we store sizes */
  66
  67 struct kqid {                   /* Type in which we store the quota identifier */
  68         union {
  69                 kuid_t uid;
  70                 kgid_t gid;
  71                 kprojid_t projid;
  72         };
  73         enum quota_type type;  /* USRQUOTA (uid) or GRPQUOTA (gid) or PRJQUOTA (projid) */
  74 };
  75
  76 extern bool qid_eq(struct kqid left, struct kqid right);
  77 extern bool qid_lt(struct kqid left, struct kqid right);
  78 extern qid_t from_kqid(struct user_namespace *to, struct kqid qid);
  79 extern qid_t from_kqid_munged(struct user_namespace *to, struct kqid qid);
  80 extern bool qid_valid(struct kqid qid);
  81
  82 /**
  83  *      make_kqid - Map a user-namespace, type, qid tuple into a kqid.
  84  *      @from: User namespace that the qid is in
  85  *      @type: The type of quota
  86  *      @qid: Quota identifier
  87  *
  88  *      Maps a user-namespace, type qid tuple into a kernel internal
  89  *      kqid, and returns that kqid.
  90  *
  91  *      When there is no mapping defined for the user-namespace, type,
  92  *      qid tuple an invalid kqid is returned.  Callers are expected to
  93  *      test for and handle handle invalid kqids being returned.
  94  *      Invalid kqids may be tested for using qid_valid().
  95  */
  96 static inline struct kqid make_kqid(struct user_namespace *from,
  97                                     enum quota_type type, qid_t qid)
  98 {
  99         struct kqid kqid;
 100
 101         kqid.type = type;
 102         switch (type) {
 103         case USRQUOTA:
 104                 kqid.uid = make_kuid(from, qid);
 105                 break;
 106         case GRPQUOTA:
 107                 kqid.gid = make_kgid(from, qid);
 108                 break;
 109         case PRJQUOTA:
 110                 kqid.projid = make_kprojid(from, qid);
 111                 break;
 112         default:
 113                 BUG();
 114         }
 115         return kqid;
 116 }
 117
 118 /**
 119  *      make_kqid_invalid - Explicitly make an invalid kqid
 120  *      @type: The type of quota identifier
 121  *
 122  *      Returns an invalid kqid with the specified type.
 123  */
 124 static inline struct kqid make_kqid_invalid(enum quota_type type)
 125 {
 126         struct kqid kqid;
 127
 128         kqid.type = type;
 129         switch (type) {
 130         case USRQUOTA:
 131                 kqid.uid = INVALID_UID;
 132                 break;
 133         case GRPQUOTA:
 134                 kqid.gid = INVALID_GID;
 135                 break;
 136         case PRJQUOTA:
 137                 kqid.projid = INVALID_PROJID;
 138                 break;
 139         default:
 140                 BUG();
 141         }
 142         return kqid;
 143 }
 144
 145 /**
 146  *      make_kqid_uid - Make a kqid from a kuid
 147  *      @uid: The kuid to make the quota identifier from
 148  */
 149 static inline struct kqid make_kqid_uid(kuid_t uid)
 150 {
 151         struct kqid kqid;
 152         kqid.type = USRQUOTA;
 153         kqid.uid = uid;
 154         return kqid;
 155 }
 156
 157 /**
 158  *      make_kqid_gid - Make a kqid from a kgid
 159  *      @gid: The kgid to make the quota identifier from
 160  */
 161 static inline struct kqid make_kqid_gid(kgid_t gid)
 162 {
 163         struct kqid kqid;
 164         kqid.type = GRPQUOTA;
 165         kqid.gid = gid;
 166         return kqid;
 167 }
 168
 169 /**
 170  *      make_kqid_projid - Make a kqid from a projid
 171  *      @projid: The kprojid to make the quota identifier from
 172  */
 173 static inline struct kqid make_kqid_projid(kprojid_t projid)
 174 {
 175         struct kqid kqid;
 176         kqid.type = PRJQUOTA;
 177         kqid.projid = projid;
 178         return kqid;
 179 }
 180
 181
 182 extern spinlock_t dq_data_lock;
 183
 184 /* Maximal numbers of writes for quota operation (insert/delete/update)
 185  * (over VFS all formats) */
 186 #define DQUOT_INIT_ALLOC max(V1_INIT_ALLOC, V2_INIT_ALLOC)
 187 #define DQUOT_INIT_REWRITE max(V1_INIT_REWRITE, V2_INIT_REWRITE)
 188 #define DQUOT_DEL_ALLOC max(V1_DEL_ALLOC, V2_DEL_ALLOC)
 189 #define DQUOT_DEL_REWRITE max(V1_DEL_REWRITE, V2_DEL_REWRITE)
 190
 191 /*
 192  * Data for one user/group kept in memory
 193  */
 194 struct mem_dqblk {
 195         qsize_t dqb_bhardlimit; /* absolute limit on disk blks alloc */
 196         qsize_t dqb_bsoftlimit; /* preferred limit on disk blks */
 197         qsize_t dqb_curspace;   /* current used space */
 198         qsize_t dqb_rsvspace;   /* current reserved space for delalloc*/
 199         qsize_t dqb_ihardlimit; /* absolute limit on allocated inodes */
 200         qsize_t dqb_isoftlimit; /* preferred inode limit */
 201         qsize_t dqb_curinodes;  /* current # allocated inodes */
 202         time_t dqb_btime;       /* time limit for excessive disk use */
 203         time_t dqb_itime;       /* time limit for excessive inode use */
 204 };
 205
 206 /*
 207  * Data for one quotafile kept in memory
 208  */
 209 struct quota_format_type;
 210
 211 struct mem_dqinfo {
 212         struct quota_format_type *dqi_format;
 213         int dqi_fmt_id;         /* Id of the dqi_format - used when turning
 214                                  * quotas on after remount RW */
 215         struct list_head dqi_dirty_list;        /* List of dirty dquots */
 216         unsigned long dqi_flags;
 217         unsigned int dqi_bgrace;
 218         unsigned int dqi_igrace;
 219         qsize_t dqi_max_spc_limit;
 220         qsize_t dqi_max_ino_limit;
 221         void *dqi_priv;
 222 };
 223
 224 struct super_block;
 225
 226 /* Mask for flags passed to userspace */
 227 #define DQF_GETINFO_MASK (DQF_ROOT_SQUASH | DQF_SYS_FILE)
 228 /* Mask for flags modifiable from userspace */
 229 #define DQF_SETINFO_MASK DQF_ROOT_SQUASH
 230
 231 enum {
 232         DQF_INFO_DIRTY_B = DQF_PRIVATE,
 233 };
 234 #define DQF_INFO_DIRTY (1 << DQF_INFO_DIRTY_B)  /* Is info dirty? */
 235
 236 extern void mark_info_dirty(struct super_block *sb, int type);
 237 static inline int info_dirty(struct mem_dqinfo *info)
 238 {
 239         return test_bit(DQF_INFO_DIRTY_B, &info->dqi_flags);
 240 }
 241
 242 enum {
 243         DQST_LOOKUPS,
 244         DQST_DROPS,
 245         DQST_READS,
 246         DQST_WRITES,
 247         DQST_CACHE_HITS,
 248         DQST_ALLOC_DQUOTS,
 249         DQST_FREE_DQUOTS,
 250         DQST_SYNCS,
 251         _DQST_DQSTAT_LAST
 252 };
 253
 254 struct dqstats {
 255         int stat[_DQST_DQSTAT_LAST];
 256         struct percpu_counter counter[_DQST_DQSTAT_LAST];
 257 };
 258
 259 extern struct dqstats *dqstats_pcpu;
 260 extern struct dqstats dqstats;
 261
 262 static inline void dqstats_inc(unsigned int type)
 263 {
 264         percpu_counter_inc(&dqstats.counter[type]);
 265 }
 266
 267 static inline void dqstats_dec(unsigned int type)
 268 {
 269         percpu_counter_dec(&dqstats.counter[type]);
 270 }
 271
 272 #define DQ_MOD_B        0       /* dquot modified since read */
 273 #define DQ_BLKS_B       1       /* uid/gid has been warned about blk limit */
 274 #define DQ_INODES_B     2       /* uid/gid has been warned about inode limit */
 275 #define DQ_FAKE_B       3       /* no limits only usage */
 276 #define DQ_READ_B       4       /* dquot was read into memory */
 277 #define DQ_ACTIVE_B     5       /* dquot is active (dquot_release not called) */
 278 #define DQ_LASTSET_B    6       /* Following 6 bits (see QIF_) are reserved\
 279                                  * for the mask of entries set via SETQUOTA\
 280                                  * quotactl. They are set under dq_data_lock\
 281                                  * and the quota format handling dquot can\
 282                                  * clear them when it sees fit. */
 283
 284 struct dquot {
 285         struct hlist_node dq_hash;      /* Hash list in memory */
 286         struct list_head dq_inuse;      /* List of all quotas */
 287         struct list_head dq_free;       /* Free list element */
 288         struct list_head dq_dirty;      /* List of dirty dquots */
 289         struct mutex dq_lock;           /* dquot IO lock */
 290         atomic_t dq_count;              /* Use count */
 291         wait_queue_head_t dq_wait_unused;       /* Wait queue for dquot to become unused */
 292         struct super_block *dq_sb;      /* superblock this applies to */
 293         struct kqid dq_id;              /* ID this applies to (uid, gid, projid) */
 294         loff_t dq_off;                  /* Offset of dquot on disk */
 295         unsigned long dq_flags;         /* See DQ_* */
 296         struct mem_dqblk dq_dqb;        /* Diskquota usage */
 297 };
 298
 299 /* Operations which must be implemented by each quota format */
 300 struct quota_format_ops {
 301         int (*check_quota_file)(struct super_block *sb, int type);      /* Detect whether file is in our format */
 302         int (*read_file_info)(struct super_block *sb, int type);        /* Read main info about file - called on quotaon() */
 303         int (*write_file_info)(struct super_block *sb, int type);       /* Write main info about file */
 304         int (*free_file_info)(struct super_block *sb, int type);        /* Called on quotaoff() */
 305         int (*read_dqblk)(struct dquot *dquot);         /* Read structure for one user */
 306         int (*commit_dqblk)(struct dquot *dquot);       /* Write structure for one user */
 307         int (*release_dqblk)(struct dquot *dquot);      /* Called when last reference to dquot is being dropped */
 308 };
 309
 310 /* Operations working with dquots */
 311 struct dquot_operations {
 312         int (*write_dquot) (struct dquot *);            /* Ordinary dquot write */
 313         struct dquot *(*alloc_dquot)(struct super_block *, int);        /* Allocate memory for new dquot */
 314         void (*destroy_dquot)(struct dquot *);          /* Free memory for dquot */
 315         int (*acquire_dquot) (struct dquot *);          /* Quota is going to be created on disk */
 316         int (*release_dquot) (struct dquot *);          /* Quota is going to be deleted from disk */
 317         int (*mark_dirty) (struct dquot *);             /* Dquot is marked dirty */
 318         int (*write_info) (struct super_block *, int);  /* Write of quota "superblock" */
 319         /* get reserved quota for delayed alloc, value returned is managed by
 320          * quota code only */
 321         qsize_t *(*get_reserved_space) (struct inode *);
 322 };
 323
 324 struct path;
 325
 326 /* Structure for communicating via ->get_dqblk() & ->set_dqblk() */
 327 struct qc_dqblk {
 328         int d_fieldmask;        /* mask of fields to change in ->set_dqblk() */
 329         u64 d_spc_hardlimit;    /* absolute limit on used space */
 330         u64 d_spc_softlimit;    /* preferred limit on used space */
 331         u64 d_ino_hardlimit;    /* maximum # allocated inodes */
 332         u64 d_ino_softlimit;    /* preferred inode limit */
 333         u64 d_space;            /* Space owned by the user */
 334         u64 d_ino_count;        /* # inodes owned by the user */
 335         s64 d_ino_timer;        /* zero if within inode limits */
 336                                 /* if not, we refuse service */
 337         s64 d_spc_timer;        /* similar to above; for space */
 338         int d_ino_warns;        /* # warnings issued wrt num inodes */
 339         int d_spc_warns;        /* # warnings issued wrt used space */
 340         u64 d_rt_spc_hardlimit; /* absolute limit on realtime space */
 341         u64 d_rt_spc_softlimit; /* preferred limit on RT space */
 342         u64 d_rt_space;         /* realtime space owned */
 343         s64 d_rt_spc_timer;     /* similar to above; for RT space */
 344         int d_rt_spc_warns;     /* # warnings issued wrt RT space */
 345 };
 346
 347 /* Field specifiers for ->set_dqblk() in struct qc_dqblk */
 348 #define QC_INO_SOFT     (1<<0)
 349 #define QC_INO_HARD     (1<<1)
 350 #define QC_SPC_SOFT     (1<<2)
 351 #define QC_SPC_HARD     (1<<3)
 352 #define QC_RT_SPC_SOFT  (1<<4)
 353 #define QC_RT_SPC_HARD  (1<<5)
 354 #define QC_LIMIT_MASK (QC_INO_SOFT | QC_INO_HARD | QC_SPC_SOFT | QC_SPC_HARD | \
 355                        QC_RT_SPC_SOFT | QC_RT_SPC_HARD)
 356 #define QC_SPC_TIMER    (1<<6)
 357 #define QC_INO_TIMER    (1<<7)
 358 #define QC_RT_SPC_TIMER (1<<8)
 359 #define QC_TIMER_MASK (QC_SPC_TIMER | QC_INO_TIMER | QC_RT_SPC_TIMER)
 360 #define QC_SPC_WARNS    (1<<9)
 361 #define QC_INO_WARNS    (1<<10)
 362 #define QC_RT_SPC_WARNS (1<<11)
 363 #define QC_WARNS_MASK (QC_SPC_WARNS | QC_INO_WARNS | QC_RT_SPC_WARNS)
 364 #define QC_SPACE        (1<<12)
 365 #define QC_INO_COUNT    (1<<13)
 366 #define QC_RT_SPACE     (1<<14)
 367 #define QC_ACCT_MASK (QC_SPACE | QC_INO_COUNT | QC_RT_SPACE)
 368
 369 #define QCI_SYSFILE             (1 << 0)        /* Quota file is hidden from userspace */
 370 #define QCI_ROOT_SQUASH         (1 << 1)        /* Root squash turned on */
 371 #define QCI_ACCT_ENABLED        (1 << 2)        /* Quota accounting enabled */
 372 #define QCI_LIMITS_ENFORCED     (1 << 3)        /* Quota limits enforced */
 373
 374 /* Structures for communicating via ->get_state */
 375 struct qc_type_state {
 376         unsigned int flags;             /* Flags QCI_* */
 377         unsigned int spc_timelimit;     /* Time after which space softlimit is
 378                                          * enforced */
 379         unsigned int ino_timelimit;     /* Ditto for inode softlimit */
 380         unsigned int rt_spc_timelimit;  /* Ditto for real-time space */
 381         unsigned int spc_warnlimit;     /* Limit for number of space warnings */
 382         unsigned int ino_warnlimit;     /* Ditto for inodes */
 383         unsigned int rt_spc_warnlimit;  /* Ditto for real-time space */
 384         unsigned long long ino;         /* Inode number of quota file */
 385         blkcnt_t blocks;                /* Number of 512-byte blocks in the file */
 386         blkcnt_t nextents;              /* Number of extents in the file */
 387 };
 388
 389 struct qc_state {
 390         unsigned int s_incoredqs;       /* Number of dquots in core */
 391         /*
 392          * Per quota type information. The array should really have
 393          * max(MAXQUOTAS, XQM_MAXQUOTAS) entries. BUILD_BUG_ON in
 394          * quota_getinfo() makes sure XQM_MAXQUOTAS is large enough.  Once VFS
 395          * supports project quotas, this can be changed to MAXQUOTAS
 396          */
 397         struct qc_type_state s_state[XQM_MAXQUOTAS];
 398 };
 399
 400 /* Operations handling requests from userspace */
 401 struct quotactl_ops {
 402         int (*quota_on)(struct super_block *, int, int, struct path *);
 403         int (*quota_off)(struct super_block *, int);
 404         int (*quota_enable)(struct super_block *, unsigned int);
 405         int (*quota_disable)(struct super_block *, unsigned int);
 406         int (*quota_sync)(struct super_block *, int);
 407         int (*set_info)(struct super_block *, int, struct if_dqinfo *);
 408         int (*get_dqblk)(struct super_block *, struct kqid, struct qc_dqblk *);
 409         int (*set_dqblk)(struct super_block *, struct kqid, struct qc_dqblk *);
 410         int (*get_state)(struct super_block *, struct qc_state *);
 411         int (*rm_xquota)(struct super_block *, unsigned int);
 412 };
 413
 414 struct quota_format_type {
 415         int qf_fmt_id;  /* Quota format id */
 416         const struct quota_format_ops *qf_ops;  /* Operations of format */
 417         struct module *qf_owner;                /* Module implementing quota format */
 418         struct quota_format_type *qf_next;
 419 };
 420
 421 /* Quota state flags - they actually come in two flavors - for users and groups */
 422 enum {
 423         _DQUOT_USAGE_ENABLED = 0,               /* Track disk usage for users */
 424         _DQUOT_LIMITS_ENABLED,                  /* Enforce quota limits for users */
 425         _DQUOT_SUSPENDED,                       /* User diskquotas are off, but
 426                                                  * we have necessary info in
 427                                                  * memory to turn them on */
 428         _DQUOT_STATE_FLAGS
 429 };
 430 #define DQUOT_USAGE_ENABLED     (1 << _DQUOT_USAGE_ENABLED)
 431 #define DQUOT_LIMITS_ENABLED    (1 << _DQUOT_LIMITS_ENABLED)
 432 #define DQUOT_SUSPENDED         (1 << _DQUOT_SUSPENDED)
 433 #define DQUOT_STATE_FLAGS       (DQUOT_USAGE_ENABLED | DQUOT_LIMITS_ENABLED | \
 434                                  DQUOT_SUSPENDED)
 435 /* Other quota flags */
 436 #define DQUOT_STATE_LAST        (_DQUOT_STATE_FLAGS * MAXQUOTAS)
 437 #define DQUOT_QUOTA_SYS_FILE    (1 << DQUOT_STATE_LAST)
 438                                                 /* Quota file is a special
 439                                                  * system file and user cannot
 440                                                  * touch it. Filesystem is
 441                                                  * responsible for setting
 442                                                  * S_NOQUOTA, S_NOATIME flags
 443                                                  */
 444 #define DQUOT_NEGATIVE_USAGE    (1 << (DQUOT_STATE_LAST + 1))
 445                                                /* Allow negative quota usage */
 446
 447 static inline unsigned int dquot_state_flag(unsigned int flags, int type)
 448 {
 449         return flags << _DQUOT_STATE_FLAGS * type;
 450 }
 451
 452 static inline unsigned int dquot_generic_flag(unsigned int flags, int type)
 453 {
 454         return (flags >> _DQUOT_STATE_FLAGS * type) & DQUOT_STATE_FLAGS;
 455 }
 456
 457 #ifdef CONFIG_QUOTA_NETLINK_INTERFACE
 458 extern void quota_send_warning(struct kqid qid, dev_t dev,
 459                                const char warntype);
 460 #else
 461 static inline void quota_send_warning(struct kqid qid, dev_t dev,
 462                                       const char warntype)
 463 {
 464         return;
 465 }
 466 #endif /* CONFIG_QUOTA_NETLINK_INTERFACE */
 467
 468 struct quota_info {
 469         unsigned int flags;                     /* Flags for diskquotas on this device */
 470         struct mutex dqio_mutex;                /* lock device while I/O in progress */
 471         struct mutex dqonoff_mutex;             /* Serialize quotaon & quotaoff */
 472         struct inode *files[MAXQUOTAS];         /* inodes of quotafiles */
 473         struct mem_dqinfo info[MAXQUOTAS];      /* Information for each quota type */
 474         const struct quota_format_ops *ops[MAXQUOTAS];  /* Operations for each type */
 475 };
 476
 477 int register_quota_format(struct quota_format_type *fmt);
 478 void unregister_quota_format(struct quota_format_type *fmt);
 479
 480 struct quota_module_name {
 481         int qm_fmt_id;
 482         char *qm_mod_name;
 483 };
 484
 485 #define INIT_QUOTA_MODULE_NAMES {\
 486         {QFMT_VFS_OLD, "quota_v1"},\
 487         {QFMT_VFS_V0, "quota_v2"},\
 488         {QFMT_VFS_V1, "quota_v2"},\
 489         {0, NULL}}
 490
 491 #endif /* _QUOTA_ */