fs/xfs/xfs_quota.h

   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
  21 struct 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  */
  33 typedef __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  */
  40 typedef __uint64_t      xfs_qcnt_t;
  41 typedef __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  */
  49 typedef 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  */
  78 typedef 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_FREEING          0x0010          /* dquot is beeing torn down */
  91
  92 #define XFS_DQ_ALLTYPES         (XFS_DQ_USER|XFS_DQ_PROJ|XFS_DQ_GROUP)
  93
  94 #define XFS_DQ_FLAGS \
  95         { XFS_DQ_USER,          "USER" }, \
  96         { XFS_DQ_PROJ,          "PROJ" }, \
  97         { XFS_DQ_GROUP,         "GROUP" }, \
  98         { XFS_DQ_DIRTY,         "DIRTY" }, \
  99         { XFS_DQ_FREEING,       "FREEING" }
 100
 101 /*
 102  * In the worst case, when both user and group quotas are on,
 103  * we can have a max of three dquots changing in a single transaction.
 104  */
 105 #define XFS_DQUOT_LOGRES(mp)    (sizeof(xfs_disk_dquot_t) * 3)
 106
 107
 108 /*
 109  * These are the structures used to lay out dquots and quotaoff
 110  * records on the log. Quite similar to those of inodes.
 111  */
 112
 113 /*
 114  * log format struct for dquots.
 115  * The first two fields must be the type and size fitting into
 116  * 32 bits : log_recovery code assumes that.
 117  */
 118 typedef struct xfs_dq_logformat {
 119         __uint16_t              qlf_type;      /* dquot log item type */
 120         __uint16_t              qlf_size;      /* size of this item */
 121         xfs_dqid_t              qlf_id;        /* usr/grp/proj id : 32 bits */
 122         __int64_t               qlf_blkno;     /* blkno of dquot buffer */
 123         __int32_t               qlf_len;       /* len of dquot buffer */
 124         __uint32_t              qlf_boffset;   /* off of dquot in buffer */
 125 } xfs_dq_logformat_t;
 126
 127 /*
 128  * log format struct for QUOTAOFF records.
 129  * The first two fields must be the type and size fitting into
 130  * 32 bits : log_recovery code assumes that.
 131  * We write two LI_QUOTAOFF logitems per quotaoff, the last one keeps a pointer
 132  * to the first and ensures that the first logitem is taken out of the AIL
 133  * only when the last one is securely committed.
 134  */
 135 typedef struct xfs_qoff_logformat {
 136         unsigned short          qf_type;        /* quotaoff log item type */
 137         unsigned short          qf_size;        /* size of this item */
 138         unsigned int            qf_flags;       /* USR and/or GRP */
 139         char                    qf_pad[12];     /* padding for future */
 140 } xfs_qoff_logformat_t;
 141
 142
 143 /*
 144  * Disk quotas status in m_qflags, and also sb_qflags. 16 bits.
 145  */
 146 #define XFS_UQUOTA_ACCT 0x0001  /* user quota accounting ON */
 147 #define XFS_UQUOTA_ENFD 0x0002  /* user quota limits enforced */
 148 #define XFS_UQUOTA_CHKD 0x0004  /* quotacheck run on usr quotas */
 149 #define XFS_PQUOTA_ACCT 0x0008  /* project quota accounting ON */
 150 #define XFS_OQUOTA_ENFD 0x0010  /* other (grp/prj) quota limits enforced */
 151 #define XFS_OQUOTA_CHKD 0x0020  /* quotacheck run on other (grp/prj) quotas */
 152 #define XFS_GQUOTA_ACCT 0x0040  /* group quota accounting ON */
 153
 154 /*
 155  * Quota Accounting/Enforcement flags
 156  */
 157 #define XFS_ALL_QUOTA_ACCT      \
 158                 (XFS_UQUOTA_ACCT | XFS_GQUOTA_ACCT | XFS_PQUOTA_ACCT)
 159 #define XFS_ALL_QUOTA_ENFD      (XFS_UQUOTA_ENFD | XFS_OQUOTA_ENFD)
 160 #define XFS_ALL_QUOTA_CHKD      (XFS_UQUOTA_CHKD | XFS_OQUOTA_CHKD)
 161
 162 #define XFS_IS_QUOTA_RUNNING(mp)        ((mp)->m_qflags & XFS_ALL_QUOTA_ACCT)
 163 #define XFS_IS_UQUOTA_RUNNING(mp)       ((mp)->m_qflags & XFS_UQUOTA_ACCT)
 164 #define XFS_IS_PQUOTA_RUNNING(mp)       ((mp)->m_qflags & XFS_PQUOTA_ACCT)
 165 #define XFS_IS_GQUOTA_RUNNING(mp)       ((mp)->m_qflags & XFS_GQUOTA_ACCT)
 166 #define XFS_IS_UQUOTA_ENFORCED(mp)      ((mp)->m_qflags & XFS_UQUOTA_ENFD)
 167 #define XFS_IS_OQUOTA_ENFORCED(mp)      ((mp)->m_qflags & XFS_OQUOTA_ENFD)
 168
 169 /*
 170  * Incore only flags for quotaoff - these bits get cleared when quota(s)
 171  * are in the process of getting turned off. These flags are in m_qflags but
 172  * never in sb_qflags.
 173  */
 174 #define XFS_UQUOTA_ACTIVE       0x0100  /* uquotas are being turned off */
 175 #define XFS_PQUOTA_ACTIVE       0x0200  /* pquotas are being turned off */
 176 #define XFS_GQUOTA_ACTIVE       0x0400  /* gquotas are being turned off */
 177 #define XFS_ALL_QUOTA_ACTIVE    \
 178         (XFS_UQUOTA_ACTIVE | XFS_PQUOTA_ACTIVE | XFS_GQUOTA_ACTIVE)
 179
 180 /*
 181  * Checking XFS_IS_*QUOTA_ON() while holding any inode lock guarantees
 182  * quota will be not be switched off as long as that inode lock is held.
 183  */
 184 #define XFS_IS_QUOTA_ON(mp)     ((mp)->m_qflags & (XFS_UQUOTA_ACTIVE | \
 185                                                    XFS_GQUOTA_ACTIVE | \
 186                                                    XFS_PQUOTA_ACTIVE))
 187 #define XFS_IS_OQUOTA_ON(mp)    ((mp)->m_qflags & (XFS_GQUOTA_ACTIVE | \
 188                                                    XFS_PQUOTA_ACTIVE))
 189 #define XFS_IS_UQUOTA_ON(mp)    ((mp)->m_qflags & XFS_UQUOTA_ACTIVE)
 190 #define XFS_IS_GQUOTA_ON(mp)    ((mp)->m_qflags & XFS_GQUOTA_ACTIVE)
 191 #define XFS_IS_PQUOTA_ON(mp)    ((mp)->m_qflags & XFS_PQUOTA_ACTIVE)
 192
 193 /*
 194  * Flags to tell various functions what to do. Not all of these are meaningful
 195  * to a single function. None of these XFS_QMOPT_* flags are meant to have
 196  * persistent values (ie. their values can and will change between versions)
 197  */
 198 #define XFS_QMOPT_DQALLOC       0x0000002 /* alloc dquot ondisk if needed */
 199 #define XFS_QMOPT_UQUOTA        0x0000004 /* user dquot requested */
 200 #define XFS_QMOPT_PQUOTA        0x0000008 /* project dquot requested */
 201 #define XFS_QMOPT_FORCE_RES     0x0000010 /* ignore quota limits */
 202 #define XFS_QMOPT_SBVERSION     0x0000040 /* change superblock version num */
 203 #define XFS_QMOPT_DOWARN        0x0000400 /* increase warning cnt if needed */
 204 #define XFS_QMOPT_DQREPAIR      0x0001000 /* repair dquot if damaged */
 205 #define XFS_QMOPT_GQUOTA        0x0002000 /* group dquot requested */
 206 #define XFS_QMOPT_ENOSPC        0x0004000 /* enospc instead of edquot (prj) */
 207
 208 /*
 209  * flags to xfs_trans_mod_dquot to indicate which field needs to be
 210  * modified.
 211  */
 212 #define XFS_QMOPT_RES_REGBLKS   0x0010000
 213 #define XFS_QMOPT_RES_RTBLKS    0x0020000
 214 #define XFS_QMOPT_BCOUNT        0x0040000
 215 #define XFS_QMOPT_ICOUNT        0x0080000
 216 #define XFS_QMOPT_RTBCOUNT      0x0100000
 217 #define XFS_QMOPT_DELBCOUNT     0x0200000
 218 #define XFS_QMOPT_DELRTBCOUNT   0x0400000
 219 #define XFS_QMOPT_RES_INOS      0x0800000
 220
 221 /*
 222  * flags for dqalloc.
 223  */
 224 #define XFS_QMOPT_INHERIT       0x1000000
 225
 226 /*
 227  * flags to xfs_trans_mod_dquot.
 228  */
 229 #define XFS_TRANS_DQ_RES_BLKS   XFS_QMOPT_RES_REGBLKS
 230 #define XFS_TRANS_DQ_RES_RTBLKS XFS_QMOPT_RES_RTBLKS
 231 #define XFS_TRANS_DQ_RES_INOS   XFS_QMOPT_RES_INOS
 232 #define XFS_TRANS_DQ_BCOUNT     XFS_QMOPT_BCOUNT
 233 #define XFS_TRANS_DQ_DELBCOUNT  XFS_QMOPT_DELBCOUNT
 234 #define XFS_TRANS_DQ_ICOUNT     XFS_QMOPT_ICOUNT
 235 #define XFS_TRANS_DQ_RTBCOUNT   XFS_QMOPT_RTBCOUNT
 236 #define XFS_TRANS_DQ_DELRTBCOUNT XFS_QMOPT_DELRTBCOUNT
 237
 238
 239 #define XFS_QMOPT_QUOTALL       \
 240                 (XFS_QMOPT_UQUOTA | XFS_QMOPT_PQUOTA | XFS_QMOPT_GQUOTA)
 241 #define XFS_QMOPT_RESBLK_MASK   (XFS_QMOPT_RES_REGBLKS | XFS_QMOPT_RES_RTBLKS)
 242
 243 #ifdef __KERNEL__
 244 /*
 245  * This check is done typically without holding the inode lock;
 246  * that may seem racy, but it is harmless in the context that it is used.
 247  * The inode cannot go inactive as long a reference is kept, and
 248  * therefore if dquot(s) were attached, they'll stay consistent.
 249  * If, for example, the ownership of the inode changes while
 250  * we didn't have the inode locked, the appropriate dquot(s) will be
 251  * attached atomically.
 252  */
 253 #define XFS_NOT_DQATTACHED(mp, ip) ((XFS_IS_UQUOTA_ON(mp) &&\
 254                                      (ip)->i_udquot == NULL) || \
 255                                     (XFS_IS_OQUOTA_ON(mp) && \
 256                                      (ip)->i_gdquot == NULL))
 257
 258 #define XFS_QM_NEED_QUOTACHECK(mp) \
 259         ((XFS_IS_UQUOTA_ON(mp) && \
 260                 (mp->m_sb.sb_qflags & XFS_UQUOTA_CHKD) == 0) || \
 261          (XFS_IS_GQUOTA_ON(mp) && \
 262                 ((mp->m_sb.sb_qflags & XFS_OQUOTA_CHKD) == 0 || \
 263                  (mp->m_sb.sb_qflags & XFS_PQUOTA_ACCT))) || \
 264          (XFS_IS_PQUOTA_ON(mp) && \
 265                 ((mp->m_sb.sb_qflags & XFS_OQUOTA_CHKD) == 0 || \
 266                  (mp->m_sb.sb_qflags & XFS_GQUOTA_ACCT))))
 267
 268 #define XFS_MOUNT_QUOTA_SET1    (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\
 269                                  XFS_UQUOTA_CHKD|XFS_PQUOTA_ACCT|\
 270                                  XFS_OQUOTA_ENFD|XFS_OQUOTA_CHKD)
 271
 272 #define XFS_MOUNT_QUOTA_SET2    (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\
 273                                  XFS_UQUOTA_CHKD|XFS_GQUOTA_ACCT|\
 274                                  XFS_OQUOTA_ENFD|XFS_OQUOTA_CHKD)
 275
 276 #define XFS_MOUNT_QUOTA_ALL     (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\
 277                                  XFS_UQUOTA_CHKD|XFS_PQUOTA_ACCT|\
 278                                  XFS_OQUOTA_ENFD|XFS_OQUOTA_CHKD|\
 279                                  XFS_GQUOTA_ACCT)
 280
 281
 282 /*
 283  * The structure kept inside the xfs_trans_t keep track of dquot changes
 284  * within a transaction and apply them later.
 285  */
 286 typedef struct xfs_dqtrx {
 287         struct xfs_dquot *qt_dquot;       /* the dquot this refers to */
 288         ulong           qt_blk_res;       /* blks reserved on a dquot */
 289         ulong           qt_blk_res_used;  /* blks used from the reservation */
 290         ulong           qt_ino_res;       /* inode reserved on a dquot */
 291         ulong           qt_ino_res_used;  /* inodes used from the reservation */
 292         long            qt_bcount_delta;  /* dquot blk count changes */
 293         long            qt_delbcnt_delta; /* delayed dquot blk count changes */
 294         long            qt_icount_delta;  /* dquot inode count changes */
 295         ulong           qt_rtblk_res;     /* # blks reserved on a dquot */
 296         ulong           qt_rtblk_res_used;/* # blks used from reservation */
 297         long            qt_rtbcount_delta;/* dquot realtime blk changes */
 298         long            qt_delrtb_delta;  /* delayed RT blk count changes */
 299 } xfs_dqtrx_t;
 300
 301 #ifdef CONFIG_XFS_QUOTA
 302 extern void xfs_trans_dup_dqinfo(struct xfs_trans *, struct xfs_trans *);
 303 extern void xfs_trans_free_dqinfo(struct xfs_trans *);
 304 extern void xfs_trans_mod_dquot_byino(struct xfs_trans *, struct xfs_inode *,
 305                 uint, long);
 306 extern void xfs_trans_apply_dquot_deltas(struct xfs_trans *);
 307 extern void xfs_trans_unreserve_and_mod_dquots(struct xfs_trans *);
 308 extern int xfs_trans_reserve_quota_nblks(struct xfs_trans *,
 309                 struct xfs_inode *, long, long, uint);
 310 extern int xfs_trans_reserve_quota_bydquots(struct xfs_trans *,
 311                 struct xfs_mount *, struct xfs_dquot *,
 312                 struct xfs_dquot *, long, long, uint);
 313
 314 extern int xfs_qm_vop_dqalloc(struct xfs_inode *, uid_t, gid_t, prid_t, uint,
 315                 struct xfs_dquot **, struct xfs_dquot **);
 316 extern void xfs_qm_vop_create_dqattach(struct xfs_trans *, struct xfs_inode *,
 317                 struct xfs_dquot *, struct xfs_dquot *);
 318 extern int xfs_qm_vop_rename_dqattach(struct xfs_inode **);
 319 extern struct xfs_dquot *xfs_qm_vop_chown(struct xfs_trans *,
 320                 struct xfs_inode *, struct xfs_dquot **, struct xfs_dquot *);
 321 extern int xfs_qm_vop_chown_reserve(struct xfs_trans *, struct xfs_inode *,
 322                 struct xfs_dquot *, struct xfs_dquot *, uint);
 323 extern int xfs_qm_dqattach(struct xfs_inode *, uint);
 324 extern int xfs_qm_dqattach_locked(struct xfs_inode *, uint);
 325 extern void xfs_qm_dqdetach(struct xfs_inode *);
 326 extern void xfs_qm_dqrele(struct xfs_dquot *);
 327 extern void xfs_qm_statvfs(struct xfs_inode *, struct kstatfs *);
 328 extern int xfs_qm_newmount(struct xfs_mount *, uint *, uint *);
 329 extern void xfs_qm_mount_quotas(struct xfs_mount *);
 330 extern void xfs_qm_unmount(struct xfs_mount *);
 331 extern void xfs_qm_unmount_quotas(struct xfs_mount *);
 332
 333 #else
 334 static inline int
 335 xfs_qm_vop_dqalloc(struct xfs_inode *ip, uid_t uid, gid_t gid, prid_t prid,
 336                 uint flags, struct xfs_dquot **udqp, struct xfs_dquot **gdqp)
 337 {
 338         *udqp = NULL;
 339         *gdqp = NULL;
 340         return 0;
 341 }
 342 #define xfs_trans_dup_dqinfo(tp, tp2)
 343 #define xfs_trans_free_dqinfo(tp)
 344 #define xfs_trans_mod_dquot_byino(tp, ip, fields, delta)
 345 #define xfs_trans_apply_dquot_deltas(tp)
 346 #define xfs_trans_unreserve_and_mod_dquots(tp)
 347 static inline int xfs_trans_reserve_quota_nblks(struct xfs_trans *tp,
 348                 struct xfs_inode *ip, long nblks, long ninos, uint flags)
 349 {
 350         return 0;
 351 }
 352 static inline int xfs_trans_reserve_quota_bydquots(struct xfs_trans *tp,
 353                 struct xfs_mount *mp, struct xfs_dquot *udqp,
 354                 struct xfs_dquot *gdqp, long nblks, long nions, uint flags)
 355 {
 356         return 0;
 357 }
 358 #define xfs_qm_vop_create_dqattach(tp, ip, u, g)
 359 #define xfs_qm_vop_rename_dqattach(it)                                  (0)
 360 #define xfs_qm_vop_chown(tp, ip, old, new)                              (NULL)
 361 #define xfs_qm_vop_chown_reserve(tp, ip, u, g, fl)                      (0)
 362 #define xfs_qm_dqattach(ip, fl)                                         (0)
 363 #define xfs_qm_dqattach_locked(ip, fl)                                  (0)
 364 #define xfs_qm_dqdetach(ip)
 365 #define xfs_qm_dqrele(d)
 366 #define xfs_qm_statvfs(ip, s)
 367 #define xfs_qm_newmount(mp, a, b)                                       (0)
 368 #define xfs_qm_mount_quotas(mp)
 369 #define xfs_qm_unmount(mp)
 370 #define xfs_qm_unmount_quotas(mp)
 371 #endif /* CONFIG_XFS_QUOTA */
 372
 373 #define xfs_trans_unreserve_quota_nblks(tp, ip, nblks, ninos, flags) \
 374         xfs_trans_reserve_quota_nblks(tp, ip, -(nblks), -(ninos), flags)
 375 #define xfs_trans_reserve_quota(tp, mp, ud, gd, nb, ni, f) \
 376         xfs_trans_reserve_quota_bydquots(tp, mp, ud, gd, nb, ni, \
 377                                 f | XFS_QMOPT_RES_REGBLKS)
 378
 379 extern int xfs_qm_dqcheck(struct xfs_mount *, xfs_disk_dquot_t *,
 380                                 xfs_dqid_t, uint, uint, char *);
 381 extern int xfs_mount_reset_sbqflags(struct xfs_mount *);
 382
 383 #endif  /* __KERNEL__ */
 384 #endif  /* __XFS_QUOTA_H__ */