xfs_quota.h 15 KB

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