xfs_quota.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370
  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. * The ondisk form of a dquot structure.
  22. */
  23. #define XFS_DQUOT_MAGIC 0x4451 /* 'DQ' */
  24. #define XFS_DQUOT_VERSION (u_int8_t)0x01 /* latest version number */
  25. /*
  26. * uid_t and gid_t are hard-coded to 32 bits in the inode.
  27. * Hence, an 'id' in a dquot is 32 bits..
  28. */
  29. typedef __uint32_t xfs_dqid_t;
  30. /*
  31. * Even though users may not have quota limits occupying all 64-bits,
  32. * they may need 64-bit accounting. Hence, 64-bit quota-counters,
  33. * and quota-limits. This is a waste in the common case, but hey ...
  34. */
  35. typedef __uint64_t xfs_qcnt_t;
  36. typedef __uint16_t xfs_qwarncnt_t;
  37. /*
  38. * This is the main portion of the on-disk representation of quota
  39. * information for a user. This is the q_core of the xfs_dquot_t that
  40. * is kept in kernel memory. We pad this with some more expansion room
  41. * to construct the on disk structure.
  42. */
  43. typedef struct xfs_disk_dquot {
  44. __be16 d_magic; /* dquot magic = XFS_DQUOT_MAGIC */
  45. __u8 d_version; /* dquot version */
  46. __u8 d_flags; /* XFS_DQ_USER/PROJ/GROUP */
  47. __be32 d_id; /* user,project,group id */
  48. __be64 d_blk_hardlimit;/* absolute limit on disk blks */
  49. __be64 d_blk_softlimit;/* preferred limit on disk blks */
  50. __be64 d_ino_hardlimit;/* maximum # allocated inodes */
  51. __be64 d_ino_softlimit;/* preferred inode limit */
  52. __be64 d_bcount; /* disk blocks owned by the user */
  53. __be64 d_icount; /* inodes owned by the user */
  54. __be32 d_itimer; /* zero if within inode limits if not,
  55. this is when we refuse service */
  56. __be32 d_btimer; /* similar to above; for disk blocks */
  57. __be16 d_iwarns; /* warnings issued wrt num inodes */
  58. __be16 d_bwarns; /* warnings issued wrt disk blocks */
  59. __be32 d_pad0; /* 64 bit align */
  60. __be64 d_rtb_hardlimit;/* absolute limit on realtime blks */
  61. __be64 d_rtb_softlimit;/* preferred limit on RT disk blks */
  62. __be64 d_rtbcount; /* realtime blocks owned */
  63. __be32 d_rtbtimer; /* similar to above; for RT disk blocks */
  64. __be16 d_rtbwarns; /* warnings issued wrt RT disk blocks */
  65. __be16 d_pad;
  66. } xfs_disk_dquot_t;
  67. /*
  68. * This is what goes on disk. This is separated from the xfs_disk_dquot because
  69. * carrying the unnecessary padding would be a waste of memory.
  70. */
  71. typedef struct xfs_dqblk {
  72. xfs_disk_dquot_t dd_diskdq; /* portion that lives incore as well */
  73. char dd_fill[32]; /* filling for posterity */
  74. } xfs_dqblk_t;
  75. /*
  76. * flags for q_flags field in the dquot.
  77. */
  78. #define XFS_DQ_USER 0x0001 /* a user quota */
  79. #define XFS_DQ_PROJ 0x0002 /* project quota */
  80. #define XFS_DQ_GROUP 0x0004 /* a group quota */
  81. #define XFS_DQ_FLOCKED 0x0008 /* flush lock taken */
  82. #define XFS_DQ_DIRTY 0x0010 /* dquot is dirty */
  83. #define XFS_DQ_WANT 0x0020 /* for lookup/reclaim race */
  84. #define XFS_DQ_INACTIVE 0x0040 /* dq off mplist & hashlist */
  85. #define XFS_DQ_MARKER 0x0080 /* sentinel */
  86. #define XFS_DQ_ALLTYPES (XFS_DQ_USER|XFS_DQ_PROJ|XFS_DQ_GROUP)
  87. /*
  88. * In the worst case, when both user and group quotas are on,
  89. * we can have a max of three dquots changing in a single transaction.
  90. */
  91. #define XFS_DQUOT_LOGRES(mp) (sizeof(xfs_disk_dquot_t) * 3)
  92. /*
  93. * These are the structures used to lay out dquots and quotaoff
  94. * records on the log. Quite similar to those of inodes.
  95. */
  96. /*
  97. * log format struct for dquots.
  98. * The first two fields must be the type and size fitting into
  99. * 32 bits : log_recovery code assumes that.
  100. */
  101. typedef struct xfs_dq_logformat {
  102. __uint16_t qlf_type; /* dquot log item type */
  103. __uint16_t qlf_size; /* size of this item */
  104. xfs_dqid_t qlf_id; /* usr/grp/proj id : 32 bits */
  105. __int64_t qlf_blkno; /* blkno of dquot buffer */
  106. __int32_t qlf_len; /* len of dquot buffer */
  107. __uint32_t qlf_boffset; /* off of dquot in buffer */
  108. } xfs_dq_logformat_t;
  109. /*
  110. * log format struct for QUOTAOFF records.
  111. * The first two fields must be the type and size fitting into
  112. * 32 bits : log_recovery code assumes that.
  113. * We write two LI_QUOTAOFF logitems per quotaoff, the last one keeps a pointer
  114. * to the first and ensures that the first logitem is taken out of the AIL
  115. * only when the last one is securely committed.
  116. */
  117. typedef struct xfs_qoff_logformat {
  118. unsigned short qf_type; /* quotaoff log item type */
  119. unsigned short qf_size; /* size of this item */
  120. unsigned int qf_flags; /* USR and/or GRP */
  121. char qf_pad[12]; /* padding for future */
  122. } xfs_qoff_logformat_t;
  123. /*
  124. * Disk quotas status in m_qflags, and also sb_qflags. 16 bits.
  125. */
  126. #define XFS_UQUOTA_ACCT 0x0001 /* user quota accounting ON */
  127. #define XFS_UQUOTA_ENFD 0x0002 /* user quota limits enforced */
  128. #define XFS_UQUOTA_CHKD 0x0004 /* quotacheck run on usr quotas */
  129. #define XFS_PQUOTA_ACCT 0x0008 /* project quota accounting ON */
  130. #define XFS_OQUOTA_ENFD 0x0010 /* other (grp/prj) quota limits enforced */
  131. #define XFS_OQUOTA_CHKD 0x0020 /* quotacheck run on other (grp/prj) quotas */
  132. #define XFS_GQUOTA_ACCT 0x0040 /* group quota accounting ON */
  133. /*
  134. * Quota Accounting/Enforcement flags
  135. */
  136. #define XFS_ALL_QUOTA_ACCT \
  137. (XFS_UQUOTA_ACCT | XFS_GQUOTA_ACCT | XFS_PQUOTA_ACCT)
  138. #define XFS_ALL_QUOTA_ENFD (XFS_UQUOTA_ENFD | XFS_OQUOTA_ENFD)
  139. #define XFS_ALL_QUOTA_CHKD (XFS_UQUOTA_CHKD | XFS_OQUOTA_CHKD)
  140. #define XFS_IS_QUOTA_RUNNING(mp) ((mp)->m_qflags & XFS_ALL_QUOTA_ACCT)
  141. #define XFS_IS_QUOTA_ENFORCED(mp) ((mp)->m_qflags & XFS_ALL_QUOTA_ENFD)
  142. #define XFS_IS_UQUOTA_RUNNING(mp) ((mp)->m_qflags & XFS_UQUOTA_ACCT)
  143. #define XFS_IS_PQUOTA_RUNNING(mp) ((mp)->m_qflags & XFS_PQUOTA_ACCT)
  144. #define XFS_IS_GQUOTA_RUNNING(mp) ((mp)->m_qflags & XFS_GQUOTA_ACCT)
  145. /*
  146. * Incore only flags for quotaoff - these bits get cleared when quota(s)
  147. * are in the process of getting turned off. These flags are in m_qflags but
  148. * never in sb_qflags.
  149. */
  150. #define XFS_UQUOTA_ACTIVE 0x0100 /* uquotas are being turned off */
  151. #define XFS_PQUOTA_ACTIVE 0x0200 /* pquotas are being turned off */
  152. #define XFS_GQUOTA_ACTIVE 0x0400 /* gquotas are being turned off */
  153. /*
  154. * Checking XFS_IS_*QUOTA_ON() while holding any inode lock guarantees
  155. * quota will be not be switched off as long as that inode lock is held.
  156. */
  157. #define XFS_IS_QUOTA_ON(mp) ((mp)->m_qflags & (XFS_UQUOTA_ACTIVE | \
  158. XFS_GQUOTA_ACTIVE | \
  159. XFS_PQUOTA_ACTIVE))
  160. #define XFS_IS_OQUOTA_ON(mp) ((mp)->m_qflags & (XFS_GQUOTA_ACTIVE | \
  161. XFS_PQUOTA_ACTIVE))
  162. #define XFS_IS_UQUOTA_ON(mp) ((mp)->m_qflags & XFS_UQUOTA_ACTIVE)
  163. #define XFS_IS_GQUOTA_ON(mp) ((mp)->m_qflags & XFS_GQUOTA_ACTIVE)
  164. #define XFS_IS_PQUOTA_ON(mp) ((mp)->m_qflags & XFS_PQUOTA_ACTIVE)
  165. /*
  166. * Flags to tell various functions what to do. Not all of these are meaningful
  167. * to a single function. None of these XFS_QMOPT_* flags are meant to have
  168. * persistent values (ie. their values can and will change between versions)
  169. */
  170. #define XFS_QMOPT_DQLOCK 0x0000001 /* dqlock */
  171. #define XFS_QMOPT_DQALLOC 0x0000002 /* alloc dquot ondisk if needed */
  172. #define XFS_QMOPT_UQUOTA 0x0000004 /* user dquot requested */
  173. #define XFS_QMOPT_PQUOTA 0x0000008 /* project dquot requested */
  174. #define XFS_QMOPT_FORCE_RES 0x0000010 /* ignore quota limits */
  175. #define XFS_QMOPT_DQSUSER 0x0000020 /* don't cache super users dquot */
  176. #define XFS_QMOPT_SBVERSION 0x0000040 /* change superblock version num */
  177. #define XFS_QMOPT_QUOTAOFF 0x0000080 /* quotas are being turned off */
  178. #define XFS_QMOPT_UMOUNTING 0x0000100 /* filesys is being unmounted */
  179. #define XFS_QMOPT_DOLOG 0x0000200 /* log buf changes (in quotacheck) */
  180. #define XFS_QMOPT_DOWARN 0x0000400 /* increase warning cnt if needed */
  181. #define XFS_QMOPT_ILOCKED 0x0000800 /* inode is already locked (excl) */
  182. #define XFS_QMOPT_DQREPAIR 0x0001000 /* repair dquot if damaged */
  183. #define XFS_QMOPT_GQUOTA 0x0002000 /* group dquot requested */
  184. #define XFS_QMOPT_ENOSPC 0x0004000 /* enospc instead of edquot (prj) */
  185. /*
  186. * flags to xfs_trans_mod_dquot to indicate which field needs to be
  187. * modified.
  188. */
  189. #define XFS_QMOPT_RES_REGBLKS 0x0010000
  190. #define XFS_QMOPT_RES_RTBLKS 0x0020000
  191. #define XFS_QMOPT_BCOUNT 0x0040000
  192. #define XFS_QMOPT_ICOUNT 0x0080000
  193. #define XFS_QMOPT_RTBCOUNT 0x0100000
  194. #define XFS_QMOPT_DELBCOUNT 0x0200000
  195. #define XFS_QMOPT_DELRTBCOUNT 0x0400000
  196. #define XFS_QMOPT_RES_INOS 0x0800000
  197. /*
  198. * flags for dqflush and dqflush_all.
  199. */
  200. #define XFS_QMOPT_SYNC 0x1000000
  201. #define XFS_QMOPT_ASYNC 0x2000000
  202. #define XFS_QMOPT_DELWRI 0x4000000
  203. /*
  204. * flags for dqalloc.
  205. */
  206. #define XFS_QMOPT_INHERIT 0x8000000
  207. /*
  208. * flags to xfs_trans_mod_dquot.
  209. */
  210. #define XFS_TRANS_DQ_RES_BLKS XFS_QMOPT_RES_REGBLKS
  211. #define XFS_TRANS_DQ_RES_RTBLKS XFS_QMOPT_RES_RTBLKS
  212. #define XFS_TRANS_DQ_RES_INOS XFS_QMOPT_RES_INOS
  213. #define XFS_TRANS_DQ_BCOUNT XFS_QMOPT_BCOUNT
  214. #define XFS_TRANS_DQ_DELBCOUNT XFS_QMOPT_DELBCOUNT
  215. #define XFS_TRANS_DQ_ICOUNT XFS_QMOPT_ICOUNT
  216. #define XFS_TRANS_DQ_RTBCOUNT XFS_QMOPT_RTBCOUNT
  217. #define XFS_TRANS_DQ_DELRTBCOUNT XFS_QMOPT_DELRTBCOUNT
  218. #define XFS_QMOPT_QUOTALL \
  219. (XFS_QMOPT_UQUOTA | XFS_QMOPT_PQUOTA | XFS_QMOPT_GQUOTA)
  220. #define XFS_QMOPT_RESBLK_MASK (XFS_QMOPT_RES_REGBLKS | XFS_QMOPT_RES_RTBLKS)
  221. #ifdef __KERNEL__
  222. /*
  223. * This check is done typically without holding the inode lock;
  224. * that may seem racy, but it is harmless in the context that it is used.
  225. * The inode cannot go inactive as long a reference is kept, and
  226. * therefore if dquot(s) were attached, they'll stay consistent.
  227. * If, for example, the ownership of the inode changes while
  228. * we didn't have the inode locked, the appropriate dquot(s) will be
  229. * attached atomically.
  230. */
  231. #define XFS_NOT_DQATTACHED(mp, ip) ((XFS_IS_UQUOTA_ON(mp) &&\
  232. (ip)->i_udquot == NULL) || \
  233. (XFS_IS_OQUOTA_ON(mp) && \
  234. (ip)->i_gdquot == NULL))
  235. #define XFS_QM_NEED_QUOTACHECK(mp) \
  236. ((XFS_IS_UQUOTA_ON(mp) && \
  237. (mp->m_sb.sb_qflags & XFS_UQUOTA_CHKD) == 0) || \
  238. (XFS_IS_GQUOTA_ON(mp) && \
  239. ((mp->m_sb.sb_qflags & XFS_OQUOTA_CHKD) == 0 || \
  240. (mp->m_sb.sb_qflags & XFS_PQUOTA_ACCT))) || \
  241. (XFS_IS_PQUOTA_ON(mp) && \
  242. ((mp->m_sb.sb_qflags & XFS_OQUOTA_CHKD) == 0 || \
  243. (mp->m_sb.sb_qflags & XFS_GQUOTA_ACCT))))
  244. #define XFS_MOUNT_QUOTA_SET1 (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\
  245. XFS_UQUOTA_CHKD|XFS_PQUOTA_ACCT|\
  246. XFS_OQUOTA_ENFD|XFS_OQUOTA_CHKD)
  247. #define XFS_MOUNT_QUOTA_SET2 (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\
  248. XFS_UQUOTA_CHKD|XFS_GQUOTA_ACCT|\
  249. XFS_OQUOTA_ENFD|XFS_OQUOTA_CHKD)
  250. #define XFS_MOUNT_QUOTA_ALL (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\
  251. XFS_UQUOTA_CHKD|XFS_PQUOTA_ACCT|\
  252. XFS_OQUOTA_ENFD|XFS_OQUOTA_CHKD|\
  253. XFS_GQUOTA_ACCT)
  254. /*
  255. * The structure kept inside the xfs_trans_t keep track of dquot changes
  256. * within a transaction and apply them later.
  257. */
  258. typedef struct xfs_dqtrx {
  259. struct xfs_dquot *qt_dquot; /* the dquot this refers to */
  260. ulong qt_blk_res; /* blks reserved on a dquot */
  261. ulong qt_blk_res_used; /* blks used from the reservation */
  262. ulong qt_ino_res; /* inode reserved on a dquot */
  263. ulong qt_ino_res_used; /* inodes used from the reservation */
  264. long qt_bcount_delta; /* dquot blk count changes */
  265. long qt_delbcnt_delta; /* delayed dquot blk count changes */
  266. long qt_icount_delta; /* dquot inode count changes */
  267. ulong qt_rtblk_res; /* # blks reserved on a dquot */
  268. ulong qt_rtblk_res_used;/* # blks used from reservation */
  269. long qt_rtbcount_delta;/* dquot realtime blk changes */
  270. long qt_delrtb_delta; /* delayed RT blk count changes */
  271. } xfs_dqtrx_t;
  272. /*
  273. * Dquot transaction functions, used if quota is enabled.
  274. */
  275. typedef void (*qo_dup_dqinfo_t)(struct xfs_trans *, struct xfs_trans *);
  276. typedef void (*qo_mod_dquot_byino_t)(struct xfs_trans *,
  277. struct xfs_inode *, uint, long);
  278. typedef void (*qo_free_dqinfo_t)(struct xfs_trans *);
  279. typedef void (*qo_apply_dquot_deltas_t)(struct xfs_trans *);
  280. typedef void (*qo_unreserve_and_mod_dquots_t)(struct xfs_trans *);
  281. typedef int (*qo_reserve_quota_nblks_t)(
  282. struct xfs_trans *, struct xfs_mount *,
  283. struct xfs_inode *, long, long, uint);
  284. typedef int (*qo_reserve_quota_bydquots_t)(
  285. struct xfs_trans *, struct xfs_mount *,
  286. struct xfs_dquot *, struct xfs_dquot *,
  287. long, long, uint);
  288. typedef struct xfs_dqtrxops {
  289. qo_dup_dqinfo_t qo_dup_dqinfo;
  290. qo_free_dqinfo_t qo_free_dqinfo;
  291. qo_mod_dquot_byino_t qo_mod_dquot_byino;
  292. qo_apply_dquot_deltas_t qo_apply_dquot_deltas;
  293. qo_reserve_quota_nblks_t qo_reserve_quota_nblks;
  294. qo_reserve_quota_bydquots_t qo_reserve_quota_bydquots;
  295. qo_unreserve_and_mod_dquots_t qo_unreserve_and_mod_dquots;
  296. } xfs_dqtrxops_t;
  297. #define XFS_DQTRXOP(mp, tp, op, args...) \
  298. ((mp)->m_qm_ops.xfs_dqtrxops ? \
  299. ((mp)->m_qm_ops.xfs_dqtrxops->op)(tp, ## args) : 0)
  300. #define XFS_DQTRXOP_VOID(mp, tp, op, args...) \
  301. ((mp)->m_qm_ops.xfs_dqtrxops ? \
  302. ((mp)->m_qm_ops.xfs_dqtrxops->op)(tp, ## args) : (void)0)
  303. #define XFS_TRANS_DUP_DQINFO(mp, otp, ntp) \
  304. XFS_DQTRXOP_VOID(mp, otp, qo_dup_dqinfo, ntp)
  305. #define XFS_TRANS_FREE_DQINFO(mp, tp) \
  306. XFS_DQTRXOP_VOID(mp, tp, qo_free_dqinfo)
  307. #define XFS_TRANS_MOD_DQUOT_BYINO(mp, tp, ip, field, delta) \
  308. XFS_DQTRXOP_VOID(mp, tp, qo_mod_dquot_byino, ip, field, delta)
  309. #define XFS_TRANS_APPLY_DQUOT_DELTAS(mp, tp) \
  310. XFS_DQTRXOP_VOID(mp, tp, qo_apply_dquot_deltas)
  311. #define XFS_TRANS_RESERVE_QUOTA_NBLKS(mp, tp, ip, nblks, ninos, fl) \
  312. XFS_DQTRXOP(mp, tp, qo_reserve_quota_nblks, mp, ip, nblks, ninos, fl)
  313. #define XFS_TRANS_RESERVE_QUOTA_BYDQUOTS(mp, tp, ud, gd, nb, ni, fl) \
  314. XFS_DQTRXOP(mp, tp, qo_reserve_quota_bydquots, mp, ud, gd, nb, ni, fl)
  315. #define XFS_TRANS_UNRESERVE_AND_MOD_DQUOTS(mp, tp) \
  316. XFS_DQTRXOP_VOID(mp, tp, qo_unreserve_and_mod_dquots)
  317. #define XFS_TRANS_UNRESERVE_QUOTA_NBLKS(mp, tp, ip, nblks, ninos, flags) \
  318. XFS_TRANS_RESERVE_QUOTA_NBLKS(mp, tp, ip, -(nblks), -(ninos), flags)
  319. #define XFS_TRANS_RESERVE_QUOTA(mp, tp, ud, gd, nb, ni, f) \
  320. XFS_TRANS_RESERVE_QUOTA_BYDQUOTS(mp, tp, ud, gd, nb, ni, \
  321. f | XFS_QMOPT_RES_REGBLKS)
  322. #define XFS_TRANS_UNRESERVE_QUOTA(mp, tp, ud, gd, nb, ni, f) \
  323. XFS_TRANS_RESERVE_QUOTA_BYDQUOTS(mp, tp, ud, gd, -(nb), -(ni), \
  324. f | XFS_QMOPT_RES_REGBLKS)
  325. extern int xfs_qm_dqcheck(xfs_disk_dquot_t *, xfs_dqid_t, uint, uint, char *);
  326. extern int xfs_mount_reset_sbqflags(struct xfs_mount *);
  327. extern struct bhv_module_vfsops xfs_qmops;
  328. #endif /* __KERNEL__ */
  329. #endif /* __XFS_QUOTA_H__ */