LXR linux/fs/xfs/xfs

   1/*
   2 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
   3 * All Rights Reserved.
   4 *
   5 * This program is free software; you can redistribute it and/or
   6 * modify it under the terms of the GNU General Public License as
   7 * published by the Free Software Foundation.
   8 *
   9 * This program is distributed in the hope that it would be useful,
  10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 * GNU General Public License for more details.
  13 *
  14 * You should have received a copy of the GNU General Public License
  15 * along with this program; if not, write the Free Software Foundation,
  16 * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17 */
  18#ifndef __XFS_QUOTA_H__
  19#define __XFS_QUOTA_H__
  20
  21struct xfs_trans;
  22
  23/*
  24 * The ondisk form of a dquot structure.
  25 */
  26#define XFS_DQUOT_MAGIC         0x4451          /* 'DQ' */
  27#define XFS_DQUOT_VERSION       (u_int8_t)0x01  /* latest version number */
  28
  29/*
  30 * uid_t and gid_t are hard-coded to 32 bits in the inode.
  31 * Hence, an 'id' in a dquot is 32 bits..
  32 */
  33typedef __uint32_t      xfs_dqid_t;
  34
  35/*
  36 * Even though users may not have quota limits occupying all 64-bits,
  37 * they may need 64-bit accounting. Hence, 64-bit quota-counters,
  38 * and quota-limits. This is a waste in the common case, but hey ...
  39 */
  40typedef __uint64_t      xfs_qcnt_t;
  41typedef __uint16_t      xfs_qwarncnt_t;
  42
  43/*
  44 * This is the main portion of the on-disk representation of quota
  45 * information for a user. This is the q_core of the xfs_dquot_t that
  46 * is kept in kernel memory. We pad this with some more expansion room
  47 * to construct the on disk structure.
  48 */
  49typedef struct  xfs_disk_dquot {
  50        __be16          d_magic;        /* dquot magic = XFS_DQUOT_MAGIC */
  51        __u8            d_version;      /* dquot version */
  52        __u8            d_flags;        /* XFS_DQ_USER/PROJ/GROUP */
  53        __be32          d_id;           /* user,project,group id */
  54        __be64          d_blk_hardlimit;/* absolute limit on disk blks */
  55        __be64          d_blk_softlimit;/* preferred limit on disk blks */
  56        __be64          d_ino_hardlimit;/* maximum # allocated inodes */
  57        __be64          d_ino_softlimit;/* preferred inode limit */
  58        __be64          d_bcount;       /* disk blocks owned by the user */
  59        __be64          d_icount;       /* inodes owned by the user */
  60        __be32          d_itimer;       /* zero if within inode limits if not,
  61                                           this is when we refuse service */
  62        __be32          d_btimer;       /* similar to above; for disk blocks */
  63        __be16          d_iwarns;       /* warnings issued wrt num inodes */
  64        __be16          d_bwarns;       /* warnings issued wrt disk blocks */
  65        __be32          d_pad0;         /* 64 bit align */
  66        __be64          d_rtb_hardlimit;/* absolute limit on realtime blks */
  67        __be64          d_rtb_softlimit;/* preferred limit on RT disk blks */
  68        __be64          d_rtbcount;     /* realtime blocks owned */
  69        __be32          d_rtbtimer;     /* similar to above; for RT disk blocks */
  70        __be16          d_rtbwarns;     /* warnings issued wrt RT disk blocks */
  71        __be16          d_pad;
  72} xfs_disk_dquot_t;
  73
  74/*
  75 * This is what goes on disk. This is separated from the xfs_disk_dquot because
  76 * carrying the unnecessary padding would be a waste of memory.
  77 */
  78typedef struct xfs_dqblk {
  79        xfs_disk_dquot_t  dd_diskdq;    /* portion that lives incore as well */
  80        char              dd_fill[32];  /* filling for posterity */
  81} xfs_dqblk_t;
  82
  83/*
  84 * flags for q_flags field in the dquot.
  85 */
  86#define XFS_DQ_USER             0x0001          /* a user quota */
  87#define XFS_DQ_PROJ             0x0002          /* project quota */
  88#define XFS_DQ_GROUP            0x0004          /* a group quota */
  89#define XFS_DQ_DIRTY            0x0008          /* dquot is dirty */
  90#define XFS_DQ_WANT             0x0010          /* for lookup/reclaim race */
  91#define XFS_DQ_INACTIVE         0x0020          /* dq off mplist & hashlist */
  92
  93#define XFS_DQ_ALLTYPES         (XFS_DQ_USER|XFS_DQ_PROJ|XFS_DQ_GROUP)
  94
  95/*
  96 * In the worst case, when both user and group quotas are on,
  97 * we can have a max of three dquots changing in a single transaction.
  98 */
  99#define XFS_DQUOT_LOGRES(mp)    (sizeof(xfs_disk_dquot_t) * 3)
 100
 101
 102/*
 103 * These are the structures used to lay out dquots and quotaoff
 104 * records on the log. Quite similar to those of inodes.
 105 */
 106
 107/*
 108 * log format struct for dquots.
 109 * The first two fields must be the type and size fitting into
 110 * 32 bits : log_recovery code assumes that.
 111 */
 112typedef struct xfs_dq_logformat {
 113        __uint16_t              qlf_type;      /* dquot log item type */
 114        __uint16_t              qlf_size;      /* size of this item */
 115        xfs_dqid_t              qlf_id;        /* usr/grp/proj id : 32 bits */
 116        __int64_t               qlf_blkno;     /* blkno of dquot buffer */
 117        __int32_t               qlf_len;       /* len of dquot buffer */
 118        __uint32_t              qlf_boffset;   /* off of dquot in buffer */
 119} xfs_dq_logformat_t;
 120
 121/*
 122 * log format struct for QUOTAOFF records.
 123 * The first two fields must be the type and size fitting into
 124 * 32 bits : log_recovery code assumes that.
 125 * We write two LI_QUOTAOFF logitems per quotaoff, the last one keeps a pointer
 126 * to the first and ensures that the first logitem is taken out of the AIL
 127 * only when the last one is securely committed.
 128 */
 129typedef struct xfs_qoff_logformat {
 130        unsigned short          qf_type;        /* quotaoff log item type */
 131        unsigned short          qf_size;        /* size of this item */
 132        unsigned int            qf_flags;       /* USR and/or GRP */
 133        char                    qf_pad[12];     /* padding for future */
 134} xfs_qoff_logformat_t;
 135
 136
 137/*
 138 * Disk quotas status in m_qflags, and also sb_qflags. 16 bits.
 139 */
 140#define XFS_UQUOTA_ACCT 0x0001  /* user quota accounting ON */
 141#define XFS_UQUOTA_ENFD 0x0002  /* user quota limits enforced */
 142#define XFS_UQUOTA_CHKD 0x0004  /* quotacheck run on usr quotas */
 143#define XFS_PQUOTA_ACCT 0x0008  /* project quota accounting ON */
 144#define XFS_OQUOTA_ENFD 0x0010  /* other (grp/prj) quota limits enforced */
 145#define XFS_OQUOTA_CHKD 0x0020  /* quotacheck run on other (grp/prj) quotas */
 146#define XFS_GQUOTA_ACCT 0x0040  /* group quota accounting ON */
 147
 148/*
 149 * Quota Accounting/Enforcement flags
 150 */
 151#define XFS_ALL_QUOTA_ACCT      \
 152                (XFS_UQUOTA_ACCT | XFS_GQUOTA_ACCT | XFS_PQUOTA_ACCT)
 153#define XFS_ALL_QUOTA_ENFD      (XFS_UQUOTA_ENFD | XFS_OQUOTA_ENFD)
 154#define XFS_ALL_QUOTA_CHKD      (XFS_UQUOTA_CHKD | XFS_OQUOTA_CHKD)
 155
 156#define XFS_IS_QUOTA_RUNNING(mp)        ((mp)->m_qflags & XFS_ALL_QUOTA_ACCT)
 157#define XFS_IS_UQUOTA_RUNNING(mp)       ((mp)->m_qflags & XFS_UQUOTA_ACCT)
 158#define XFS_IS_PQUOTA_RUNNING(mp)       ((mp)->m_qflags & XFS_PQUOTA_ACCT)
 159#define XFS_IS_GQUOTA_RUNNING(mp)       ((mp)->m_qflags & XFS_GQUOTA_ACCT)
 160#define XFS_IS_UQUOTA_ENFORCED(mp)      ((mp)->m_qflags & XFS_UQUOTA_ENFD)
 161#define XFS_IS_OQUOTA_ENFORCED(mp)      ((mp)->m_qflags & XFS_OQUOTA_ENFD)
 162
 163/*
 164 * Incore only flags for quotaoff - these bits get cleared when quota(s)
 165 * are in the process of getting turned off. These flags are in m_qflags but
 166 * never in sb_qflags.
 167 */
 168#define XFS_UQUOTA_ACTIVE       0x0100  /* uquotas are being turned off */
 169#define XFS_PQUOTA_ACTIVE       0x0200  /* pquotas are being turned off */
 170#define XFS_GQUOTA_ACTIVE       0x0400  /* gquotas are being turned off */
 171
 172/*
 173 * Checking XFS_IS_*QUOTA_ON() while holding any inode lock guarantees
 174 * quota will be not be switched off as long as that inode lock is held.
 175 */
 176#define XFS_IS_QUOTA_ON(mp)     ((mp)->m_qflags & (XFS_UQUOTA_ACTIVE | \
 177                                                   XFS_GQUOTA_ACTIVE | \
 178                                                   XFS_PQUOTA_ACTIVE))
 179#define XFS_IS_OQUOTA_ON(mp)    ((mp)->m_qflags & (XFS_GQUOTA_ACTIVE | \
 180                                                   XFS_PQUOTA_ACTIVE))
 181#define XFS_IS_UQUOTA_ON(mp)    ((mp)->m_qflags & XFS_UQUOTA_ACTIVE)
 182#define XFS_IS_GQUOTA_ON(mp)    ((mp)->m_qflags & XFS_GQUOTA_ACTIVE)
 183#define XFS_IS_PQUOTA_ON(mp)    ((mp)->m_qflags & XFS_PQUOTA_ACTIVE)
 184
 185/*
 186 * Flags to tell various functions what to do. Not all of these are meaningful
 187 * to a single function. None of these XFS_QMOPT_* flags are meant to have
 188 * persistent values (ie. their values can and will change between versions)
 189 */
 190#define XFS_QMOPT_DQALLOC       0x0000002 /* alloc dquot ondisk if needed */
 191#define XFS_QMOPT_UQUOTA        0x0000004 /* user dquot requested */
 192#define XFS_QMOPT_PQUOTA        0x0000008 /* project dquot requested */
 193#define XFS_QMOPT_FORCE_RES     0x0000010 /* ignore quota limits */
 194#define XFS_QMOPT_DQSUSER       0x0000020 /* don't cache super users dquot */
 195#define XFS_QMOPT_SBVERSION     0x0000040 /* change superblock version num */
 196#define XFS_QMOPT_QUOTAOFF      0x0000080 /* quotas are being turned off */
 197#define XFS_QMOPT_UMOUNTING     0x0000100 /* filesys is being unmounted */
 198#define XFS_QMOPT_DOLOG         0x0000200 /* log buf changes (in quotacheck) */
 199#define XFS_QMOPT_DOWARN        0x0000400 /* increase warning cnt if needed */
 200#define XFS_QMOPT_DQREPAIR      0x0001000 /* repair dquot if damaged */
 201#define XFS_QMOPT_GQUOTA        0x0002000 /* group dquot requested */
 202#define XFS_QMOPT_ENOSPC        0x0004000 /* enospc instead of edquot (prj) */
 203
 204/*
 205 * flags to xfs_trans_mod_dquot to indicate which field needs to be
 206 * modified.
 207 */
 208#define XFS_QMOPT_RES_REGBLKS   0x0010000
 209#define XFS_QMOPT_RES_RTBLKS    0x0020000
 210#define XFS_QMOPT_BCOUNT        0x0040000
 211#define XFS_QMOPT_ICOUNT        0x0080000
 212#define XFS_QMOPT_RTBCOUNT      0x0100000
 213#define XFS_QMOPT_DELBCOUNT     0x0200000
 214#define XFS_QMOPT_DELRTBCOUNT   0x0400000
 215#define XFS_QMOPT_RES_INOS      0x0800000
 216
 217/*
 218 * flags for dqflush and dqflush_all.
 219 */
 220#define XFS_QMOPT_SYNC          0x1000000
 221#define XFS_QMOPT_ASYNC         0x2000000
 222#define XFS_QMOPT_DELWRI        0x4000000
 223
 224/*
 225 * flags for dqalloc.
 226 */
 227#define XFS_QMOPT_INHERIT       0x8000000
 228
 229/*
 230 * flags to xfs_trans_mod_dquot.
 231 */
 232#define XFS_TRANS_DQ_RES_BLKS   XFS_QMOPT_RES_REGBLKS
 233#define XFS_TRANS_DQ_RES_RTBLKS XFS_QMOPT_RES_RTBLKS
 234#define XFS_TRANS_DQ_RES_INOS   XFS_QMOPT_RES_INOS
 235#define XFS_TRANS_DQ_BCOUNT     XFS_QMOPT_BCOUNT
 236#define XFS_TRANS_DQ_DELBCOUNT  XFS_QMOPT_DELBCOUNT
 237#define XFS_TRANS_DQ_ICOUNT     XFS_QMOPT_ICOUNT
 238#define XFS_TRANS_DQ_RTBCOUNT   XFS_QMOPT_RTBCOUNT
 239#define XFS_TRANS_DQ_DELRTBCOUNT XFS_QMOPT_DELRTBCOUNT
 240
 241
 242#define XFS_QMOPT_QUOTALL       \
 243                (XFS_QMOPT_UQUOTA | XFS_QMOPT_PQUOTA | XFS_QMOPT_GQUOTA)
 244#define XFS_QMOPT_RESBLK_MASK   (XFS_QMOPT_RES_REGBLKS | XFS_QMOPT_RES_RTBLKS)
 245
 246#ifdef __KERNEL__
 247/*
 248 * This check is done typically without holding the inode lock;
 249 * that may seem racy, but it is harmless in the context that it is used.
 250 * The inode cannot go inactive as long a reference is kept, and
 251 * therefore if dquot(s) were attached, they'll stay consistent.
 252 * If, for example, the ownership of the inode changes while
 253 * we didn't have the inode locked, the appropriate dquot(s) will be
 254 * attached atomically.
 255 */
 256#define XFS_NOT_DQATTACHED(mp, ip) ((XFS_IS_UQUOTA_ON(mp) &&\
 257                                     (ip)->i_udquot == NULL) || \
 258                                    (XFS_IS_OQUOTA_ON(mp) && \
 259                                     (ip)->i_gdquot == NULL))
 260
 261#define XFS_QM_NEED_QUOTACHECK(mp) \
 262        ((XFS_IS_UQUOTA_ON(mp) && \
 263                (mp->m_sb.sb_qflags & XFS_UQUOTA_CHKD) == 0) || \
 264         (XFS_IS_GQUOTA_ON(mp) && \
 265                ((mp->m_sb.sb_qflags & XFS_OQUOTA_CHKD) == 0 || \
 266                 (mp->m_sb.sb_qflags & XFS_PQUOTA_ACCT))) || \
 267         (XFS_IS_PQUOTA_ON(mp) && \
 268                ((mp->m_sb.sb_qflags & XFS_OQUOTA_CHKD) == 0 || \
 269                 (mp->m_sb.sb_qflags & XFS_GQUOTA_ACCT))))
 270
 271#define XFS_MOUNT_QUOTA_SET1    (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\
 272                                 XFS_UQUOTA_CHKD|XFS_PQUOTA_ACCT|\
 273                                 XFS_OQUOTA_ENFD|XFS_OQUOTA_CHKD)
 274
 275#define XFS_MOUNT_QUOTA_SET2    (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\
 276                                 XFS_UQUOTA_CHKD|XFS_GQUOTA_ACCT|\
 277                                 XFS_OQUOTA_ENFD|XFS_OQUOTA_CHKD)
 278
 279#define XFS_MOUNT_QUOTA_ALL     (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\
 280                                 XFS_UQUOTA_CHKD|XFS_PQUOTA_ACCT|\
 281                                 XFS_OQUOTA_ENFD|XFS_OQUOTA_CHKD|\
 282                                 XFS_GQUOTA_ACCT)
 283
 284
 285/*
 286 * The structure kept inside the xfs_trans_t keep track of dquot changes
 287 * within a transaction and apply them later.
 288 */
 289typedef struct xfs_dqtrx {
 290        struct xfs_dquot *qt_dquot;       /* the dquot this refers to */
 291        ulong           qt_blk_res;       /* blks reserved on a dquot */
 292        ulong           qt_blk_res_used;  /* blks used from the reservation */
 293        ulong           qt_ino_res;       /* inode reserved on a dquot */
 294        ulong           qt_ino_res_used;  /* inodes used from the reservation */
 295        long            qt_bcount_delta;  /* dquot blk count changes */
 296        long            qt_delbcnt_delta; /* delayed dquot blk count changes */
 297        long            qt_icount_delta;  /* dquot inode count changes */
 298        ulong           qt_rtblk_res;     /* # blks reserved on a dquot */
 299        ulong           qt_rtblk_res_used;/* # blks used from reservation */
 300        long            qt_rtbcount_delta;/* dquot realtime blk changes */
 301        long            qt_delrtb_delta;  /* delayed RT blk count changes */
 302} xfs_dqtrx_t;
 303
 304#ifdef CONFIG_XFS_QUOTA
 305extern void xfs_trans_dup_dqinfo(struct xfs_trans *, struct xfs_trans *);
 306extern void xfs_trans_free_dqinfo(struct xfs_trans *);
 307extern void xfs_trans_mod_dquot_byino(struct xfs_trans *, struct xfs_inode *,
 308                uint, long);
 309extern void xfs_trans_apply_dquot_deltas(struct xfs_trans *);
 310extern void xfs_trans_unreserve_and_mod_dquots(struct xfs_trans *);
 311extern int xfs_trans_reserve_quota_nblks(struct xfs_trans *,
 312                struct xfs_inode *, long, long, uint);
 313extern int xfs_trans_reserve_quota_bydquots(struct xfs_trans *,
 314                struct xfs_mount *, struct xfs_dquot *,
 315                struct xfs_dquot *, long, long, uint);
 316
 317extern int xfs_qm_vop_dqalloc(struct xfs_inode *, uid_t, gid_t, prid_t, uint,
 318                struct xfs_dquot **, struct xfs_dquot **);
 319extern void xfs_qm_vop_create_dqattach(struct xfs_trans *, struct xfs_inode *,
 320                struct xfs_dquot *, struct xfs_dquot *);
 321extern int xfs_qm_vop_rename_dqattach(struct xfs_inode **);
 322extern struct xfs_dquot *xfs_qm_vop_chown(struct xfs_trans *,
 323                struct xfs_inode *, struct xfs_dquot **, struct xfs_dquot *);
 324extern int xfs_qm_vop_chown_reserve(struct xfs_trans *, struct xfs_inode *,
 325                struct xfs_dquot *, struct xfs_dquot *, uint);
 326extern int xfs_qm_dqattach(struct xfs_inode *, uint);
 327extern int xfs_qm_dqattach_locked(struct xfs_inode *, uint);
 328extern void xfs_qm_dqdetach(struct xfs_inode *);
 329extern void xfs_qm_dqrele(struct xfs_dquot *);
 330extern void xfs_qm_statvfs(struct xfs_inode *, struct kstatfs *);
 331extern int xfs_qm_sync(struct xfs_mount *, int);
 332extern int xfs_qm_newmount(struct xfs_mount *, uint *, uint *);
 333extern void xfs_qm_mount_quotas(struct xfs_mount *);
 334extern void xfs_qm_unmount(struct xfs_mount *);
 335extern void xfs_qm_unmount_quotas(struct xfs_mount *);
 336
 337#else
 338static inline int
 339xfs_qm_vop_dqalloc(struct xfs_inode *ip, uid_t uid, gid_t gid, prid_t prid,
 340                uint flags, struct xfs_dquot **udqp, struct xfs_dquot **gdqp)
 341{
 342        *udqp = NULL;
 343        *gdqp = NULL;
 344        return 0;
 345}
 346#define xfs_trans_dup_dqinfo(tp, tp2)
 347#define xfs_trans_free_dqinfo(tp)
 348#define xfs_trans_mod_dquot_byino(tp, ip, fields, delta)
 349#define xfs_trans_apply_dquot_deltas(tp)
 350#define xfs_trans_unreserve_and_mod_dquots(tp)
 351#define xfs_trans_reserve_quota_nblks(tp, ip, nblks, ninos, flags)      (0)
 352#define xfs_trans_reserve_quota_bydquots(tp, mp, u, g, nb, ni, fl)      (0)
 353#define xfs_qm_vop_create_dqattach(tp, ip, u, g)
 354#define xfs_qm_vop_rename_dqattach(it)                                  (0)
 355#define xfs_qm_vop_chown(tp, ip, old, new)                              (NULL)
 356#define xfs_qm_vop_chown_reserve(tp, ip, u, g, fl)                      (0)
 357#define xfs_qm_dqattach(ip, fl)                                         (0)
 358#define xfs_qm_dqattach_locked(ip, fl)                                  (0)
 359#define xfs_qm_dqdetach(ip)
 360#define xfs_qm_dqrele(d)
 361#define xfs_qm_statvfs(ip, s)
 362#define xfs_qm_sync(mp, fl)                                             (0)
 363#define xfs_qm_newmount(mp, a, b)                                       (0)
 364#define xfs_qm_mount_quotas(mp)
 365#define xfs_qm_unmount(mp)
 366#define xfs_qm_unmount_quotas(mp)                                       (0)
 367#endif /* CONFIG_XFS_QUOTA */
 368
 369#define xfs_trans_unreserve_quota_nblks(tp, ip, nblks, ninos, flags) \
 370        xfs_trans_reserve_quota_nblks(tp, ip, -(nblks), -(ninos), flags)
 371#define xfs_trans_reserve_quota(tp, mp, ud, gd, nb, ni, f) \
 372        xfs_trans_reserve_quota_bydquots(tp, mp, ud, gd, nb, ni, \
 373                                f | XFS_QMOPT_RES_REGBLKS)
 374
 375extern int xfs_qm_dqcheck(xfs_disk_dquot_t *, xfs_dqid_t, uint, uint, char *);
 376extern int xfs_mount_reset_sbqflags(struct xfs_mount *);
 377
 378#endif  /* __KERNEL__ */
 379#endif  /* __XFS_QUOTA_H__ */
 380