libxfs/xfs_quota_defs.h

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright (c) 2000-2005 Silicon Graphics, Inc.
   4  * All Rights Reserved.
   5  */
   6 #ifndef __XFS_QUOTA_DEFS_H__
   7 #define __XFS_QUOTA_DEFS_H__
   8
   9 /*
  10  * Quota definitions shared between user and kernel source trees.
  11  */
  12
  13 /*
  14  * Even though users may not have quota limits occupying all 64-bits,
  15  * they may need 64-bit accounting. Hence, 64-bit quota-counters,
  16  * and quota-limits. This is a waste in the common case, but hey ...
  17  */
  18 typedef uint64_t        xfs_qcnt_t;
  19 typedef uint16_t        xfs_qwarncnt_t;
  20
  21 #define XFS_DQUOT_CLUSTER_SIZE_FSB (xfs_filblks_t)1
  22
  23 /*
  24  * flags for q_flags field in the dquot.
  25  */
  26 #define XFS_DQ_USER             0x0001          /* a user quota */
  27 #define XFS_DQ_PROJ             0x0002          /* project quota */
  28 #define XFS_DQ_GROUP            0x0004          /* a group quota */
  29 #define XFS_DQ_DIRTY            0x0008          /* dquot is dirty */
  30 #define XFS_DQ_FREEING          0x0010          /* dquot is being torn down */
  31
  32 #define XFS_DQ_ALLTYPES         (XFS_DQ_USER|XFS_DQ_PROJ|XFS_DQ_GROUP)
  33
  34 #define XFS_DQ_FLAGS \
  35         { XFS_DQ_USER,          "USER" }, \
  36         { XFS_DQ_PROJ,          "PROJ" }, \
  37         { XFS_DQ_GROUP,         "GROUP" }, \
  38         { XFS_DQ_DIRTY,         "DIRTY" }, \
  39         { XFS_DQ_FREEING,       "FREEING" }
  40
  41 /*
  42  * We have the possibility of all three quota types being active at once, and
  43  * hence free space modification requires modification of all three current
  44  * dquots in a single transaction. For this case we need to have a reservation
  45  * of at least 3 dquots.
  46  *
  47  * However, a chmod operation can change both UID and GID in a single
  48  * transaction, resulting in requiring {old, new} x {uid, gid} dquots to be
  49  * modified. Hence for this case we need to reserve space for at least 4 dquots.
  50  *
  51  * And in the worst case, there's a rename operation that can be modifying up to
  52  * 4 inodes with dquots attached to them. In reality, the only inodes that can
  53  * have their dquots modified are the source and destination directory inodes
  54  * due to directory name creation and removal. That can require space allocation
  55  * and/or freeing on both directory inodes, and hence all three dquots on each
  56  * inode can be modified. And if the directories are world writeable, all the
  57  * dquots can be unique and so 6 dquots can be modified....
  58  *
  59  * And, of course, we also need to take into account the dquot log format item
  60  * used to describe each dquot.
  61  */
  62 #define XFS_DQUOT_LOGRES(mp)    \
  63         ((sizeof(struct xfs_dq_logformat) + sizeof(struct xfs_disk_dquot)) * 6)
  64
  65 #define XFS_IS_QUOTA_RUNNING(mp)        ((mp)->m_qflags & XFS_ALL_QUOTA_ACCT)
  66 #define XFS_IS_UQUOTA_RUNNING(mp)       ((mp)->m_qflags & XFS_UQUOTA_ACCT)
  67 #define XFS_IS_PQUOTA_RUNNING(mp)       ((mp)->m_qflags & XFS_PQUOTA_ACCT)
  68 #define XFS_IS_GQUOTA_RUNNING(mp)       ((mp)->m_qflags & XFS_GQUOTA_ACCT)
  69 #define XFS_IS_UQUOTA_ENFORCED(mp)      ((mp)->m_qflags & XFS_UQUOTA_ENFD)
  70 #define XFS_IS_GQUOTA_ENFORCED(mp)      ((mp)->m_qflags & XFS_GQUOTA_ENFD)
  71 #define XFS_IS_PQUOTA_ENFORCED(mp)      ((mp)->m_qflags & XFS_PQUOTA_ENFD)
  72
  73 /*
  74  * Incore only flags for quotaoff - these bits get cleared when quota(s)
  75  * are in the process of getting turned off. These flags are in m_qflags but
  76  * never in sb_qflags.
  77  */
  78 #define XFS_UQUOTA_ACTIVE       0x1000  /* uquotas are being turned off */
  79 #define XFS_GQUOTA_ACTIVE       0x2000  /* gquotas are being turned off */
  80 #define XFS_PQUOTA_ACTIVE       0x4000  /* pquotas are being turned off */
  81 #define XFS_ALL_QUOTA_ACTIVE    \
  82         (XFS_UQUOTA_ACTIVE | XFS_GQUOTA_ACTIVE | XFS_PQUOTA_ACTIVE)
  83
  84 /*
  85  * Checking XFS_IS_*QUOTA_ON() while holding any inode lock guarantees
  86  * quota will be not be switched off as long as that inode lock is held.
  87  */
  88 #define XFS_IS_QUOTA_ON(mp)     ((mp)->m_qflags & (XFS_UQUOTA_ACTIVE | \
  89                                                    XFS_GQUOTA_ACTIVE | \
  90                                                    XFS_PQUOTA_ACTIVE))
  91 #define XFS_IS_UQUOTA_ON(mp)    ((mp)->m_qflags & XFS_UQUOTA_ACTIVE)
  92 #define XFS_IS_GQUOTA_ON(mp)    ((mp)->m_qflags & XFS_GQUOTA_ACTIVE)
  93 #define XFS_IS_PQUOTA_ON(mp)    ((mp)->m_qflags & XFS_PQUOTA_ACTIVE)
  94
  95 /*
  96  * Flags to tell various functions what to do. Not all of these are meaningful
  97  * to a single function. None of these XFS_QMOPT_* flags are meant to have
  98  * persistent values (ie. their values can and will change between versions)
  99  */
 100 #define XFS_QMOPT_UQUOTA        0x0000004 /* user dquot requested */
 101 #define XFS_QMOPT_PQUOTA        0x0000008 /* project dquot requested */
 102 #define XFS_QMOPT_FORCE_RES     0x0000010 /* ignore quota limits */
 103 #define XFS_QMOPT_SBVERSION     0x0000040 /* change superblock version num */
 104 #define XFS_QMOPT_GQUOTA        0x0002000 /* group dquot requested */
 105 #define XFS_QMOPT_ENOSPC        0x0004000 /* enospc instead of edquot (prj) */
 106
 107 /*
 108  * flags to xfs_trans_mod_dquot to indicate which field needs to be
 109  * modified.
 110  */
 111 #define XFS_QMOPT_RES_REGBLKS   0x0010000
 112 #define XFS_QMOPT_RES_RTBLKS    0x0020000
 113 #define XFS_QMOPT_BCOUNT        0x0040000
 114 #define XFS_QMOPT_ICOUNT        0x0080000
 115 #define XFS_QMOPT_RTBCOUNT      0x0100000
 116 #define XFS_QMOPT_DELBCOUNT     0x0200000
 117 #define XFS_QMOPT_DELRTBCOUNT   0x0400000
 118 #define XFS_QMOPT_RES_INOS      0x0800000
 119
 120 /*
 121  * flags for dqalloc.
 122  */
 123 #define XFS_QMOPT_INHERIT       0x1000000
 124
 125 /*
 126  * flags to xfs_trans_mod_dquot.
 127  */
 128 #define XFS_TRANS_DQ_RES_BLKS   XFS_QMOPT_RES_REGBLKS
 129 #define XFS_TRANS_DQ_RES_RTBLKS XFS_QMOPT_RES_RTBLKS
 130 #define XFS_TRANS_DQ_RES_INOS   XFS_QMOPT_RES_INOS
 131 #define XFS_TRANS_DQ_BCOUNT     XFS_QMOPT_BCOUNT
 132 #define XFS_TRANS_DQ_DELBCOUNT  XFS_QMOPT_DELBCOUNT
 133 #define XFS_TRANS_DQ_ICOUNT     XFS_QMOPT_ICOUNT
 134 #define XFS_TRANS_DQ_RTBCOUNT   XFS_QMOPT_RTBCOUNT
 135 #define XFS_TRANS_DQ_DELRTBCOUNT XFS_QMOPT_DELRTBCOUNT
 136
 137
 138 #define XFS_QMOPT_QUOTALL       \
 139                 (XFS_QMOPT_UQUOTA | XFS_QMOPT_PQUOTA | XFS_QMOPT_GQUOTA)
 140 #define XFS_QMOPT_RESBLK_MASK   (XFS_QMOPT_RES_REGBLKS | XFS_QMOPT_RES_RTBLKS)
 141
 142 extern xfs_failaddr_t xfs_dquot_verify(struct xfs_mount *mp,
 143                 struct xfs_disk_dquot *ddq, xfs_dqid_t id, uint type);
 144 extern xfs_failaddr_t xfs_dqblk_verify(struct xfs_mount *mp,
 145                 struct xfs_dqblk *dqb, xfs_dqid_t id, uint type);
 146 extern int xfs_calc_dquots_per_chunk(unsigned int nbblks);
 147 extern int xfs_dqblk_repair(struct xfs_mount *mp, struct xfs_dqblk *dqb,
 148                 xfs_dqid_t id, uint type);
 149
 150 #endif  /* __XFS_QUOTA_H__ */