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 178 /* 179 * Checking XFS_IS_*QUOTA_ON() while holding any inode lock guarantees 180 * quota will be not be switched off as long as that inode lock is held. 181 */ 182 #define XFS_IS_QUOTA_ON(mp) ((mp)->m_qflags & (XFS_UQUOTA_ACTIVE | \ 183 XFS_GQUOTA_ACTIVE | \ 184 XFS_PQUOTA_ACTIVE)) 185 #define XFS_IS_OQUOTA_ON(mp) ((mp)->m_qflags & (XFS_GQUOTA_ACTIVE | \ 186 XFS_PQUOTA_ACTIVE)) 187 #define XFS_IS_UQUOTA_ON(mp) ((mp)->m_qflags & XFS_UQUOTA_ACTIVE) 188 #define XFS_IS_GQUOTA_ON(mp) ((mp)->m_qflags & XFS_GQUOTA_ACTIVE) 189 #define XFS_IS_PQUOTA_ON(mp) ((mp)->m_qflags & XFS_PQUOTA_ACTIVE) 190 191 /* 192 * Flags to tell various functions what to do. Not all of these are meaningful 193 * to a single function. None of these XFS_QMOPT_* flags are meant to have 194 * persistent values (ie. their values can and will change between versions) 195 */ 196 #define XFS_QMOPT_DQALLOC 0x0000002 /* alloc dquot ondisk if needed */ 197 #define XFS_QMOPT_UQUOTA 0x0000004 /* user dquot requested */ 198 #define XFS_QMOPT_PQUOTA 0x0000008 /* project dquot requested */ 199 #define XFS_QMOPT_FORCE_RES 0x0000010 /* ignore quota limits */ 200 #define XFS_QMOPT_SBVERSION 0x0000040 /* change superblock version num */ 201 #define XFS_QMOPT_DOWARN 0x0000400 /* increase warning cnt if needed */ 202 #define XFS_QMOPT_DQREPAIR 0x0001000 /* repair dquot if damaged */ 203 #define XFS_QMOPT_GQUOTA 0x0002000 /* group dquot requested */ 204 #define XFS_QMOPT_ENOSPC 0x0004000 /* enospc instead of edquot (prj) */ 205 206 /* 207 * flags to xfs_trans_mod_dquot to indicate which field needs to be 208 * modified. 209 */ 210 #define XFS_QMOPT_RES_REGBLKS 0x0010000 211 #define XFS_QMOPT_RES_RTBLKS 0x0020000 212 #define XFS_QMOPT_BCOUNT 0x0040000 213 #define XFS_QMOPT_ICOUNT 0x0080000 214 #define XFS_QMOPT_RTBCOUNT 0x0100000 215 #define XFS_QMOPT_DELBCOUNT 0x0200000 216 #define XFS_QMOPT_DELRTBCOUNT 0x0400000 217 #define XFS_QMOPT_RES_INOS 0x0800000 218 219 /* 220 * flags for dqalloc. 221 */ 222 #define XFS_QMOPT_INHERIT 0x1000000 223 224 /* 225 * flags to xfs_trans_mod_dquot. 226 */ 227 #define XFS_TRANS_DQ_RES_BLKS XFS_QMOPT_RES_REGBLKS 228 #define XFS_TRANS_DQ_RES_RTBLKS XFS_QMOPT_RES_RTBLKS 229 #define XFS_TRANS_DQ_RES_INOS XFS_QMOPT_RES_INOS 230 #define XFS_TRANS_DQ_BCOUNT XFS_QMOPT_BCOUNT 231 #define XFS_TRANS_DQ_DELBCOUNT XFS_QMOPT_DELBCOUNT 232 #define XFS_TRANS_DQ_ICOUNT XFS_QMOPT_ICOUNT 233 #define XFS_TRANS_DQ_RTBCOUNT XFS_QMOPT_RTBCOUNT 234 #define XFS_TRANS_DQ_DELRTBCOUNT XFS_QMOPT_DELRTBCOUNT 235 236 237 #define XFS_QMOPT_QUOTALL \ 238 (XFS_QMOPT_UQUOTA | XFS_QMOPT_PQUOTA | XFS_QMOPT_GQUOTA) 239 #define XFS_QMOPT_RESBLK_MASK (XFS_QMOPT_RES_REGBLKS | XFS_QMOPT_RES_RTBLKS) 240 241 #ifdef __KERNEL__ 242 /* 243 * This check is done typically without holding the inode lock; 244 * that may seem racy, but it is harmless in the context that it is used. 245 * The inode cannot go inactive as long a reference is kept, and 246 * therefore if dquot(s) were attached, they'll stay consistent. 247 * If, for example, the ownership of the inode changes while 248 * we didn't have the inode locked, the appropriate dquot(s) will be 249 * attached atomically. 250 */ 251 #define XFS_NOT_DQATTACHED(mp, ip) ((XFS_IS_UQUOTA_ON(mp) &&\ 252 (ip)->i_udquot == NULL) || \ 253 (XFS_IS_OQUOTA_ON(mp) && \ 254 (ip)->i_gdquot == NULL)) 255 256 #define XFS_QM_NEED_QUOTACHECK(mp) \ 257 ((XFS_IS_UQUOTA_ON(mp) && \ 258 (mp->m_sb.sb_qflags & XFS_UQUOTA_CHKD) == 0) || \ 259 (XFS_IS_GQUOTA_ON(mp) && \ 260 ((mp->m_sb.sb_qflags & XFS_OQUOTA_CHKD) == 0 || \ 261 (mp->m_sb.sb_qflags & XFS_PQUOTA_ACCT))) || \ 262 (XFS_IS_PQUOTA_ON(mp) && \ 263 ((mp->m_sb.sb_qflags & XFS_OQUOTA_CHKD) == 0 || \ 264 (mp->m_sb.sb_qflags & XFS_GQUOTA_ACCT)))) 265 266 #define XFS_MOUNT_QUOTA_SET1 (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\ 267 XFS_UQUOTA_CHKD|XFS_PQUOTA_ACCT|\ 268 XFS_OQUOTA_ENFD|XFS_OQUOTA_CHKD) 269 270 #define XFS_MOUNT_QUOTA_SET2 (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\ 271 XFS_UQUOTA_CHKD|XFS_GQUOTA_ACCT|\ 272 XFS_OQUOTA_ENFD|XFS_OQUOTA_CHKD) 273 274 #define XFS_MOUNT_QUOTA_ALL (XFS_UQUOTA_ACCT|XFS_UQUOTA_ENFD|\ 275 XFS_UQUOTA_CHKD|XFS_PQUOTA_ACCT|\ 276 XFS_OQUOTA_ENFD|XFS_OQUOTA_CHKD|\ 277 XFS_GQUOTA_ACCT) 278 279 280 /* 281 * The structure kept inside the xfs_trans_t keep track of dquot changes 282 * within a transaction and apply them later. 283 */ 284 typedef struct xfs_dqtrx { 285 struct xfs_dquot *qt_dquot; /* the dquot this refers to */ 286 ulong qt_blk_res; /* blks reserved on a dquot */ 287 ulong qt_blk_res_used; /* blks used from the reservation */ 288 ulong qt_ino_res; /* inode reserved on a dquot */ 289 ulong qt_ino_res_used; /* inodes used from the reservation */ 290 long qt_bcount_delta; /* dquot blk count changes */ 291 long qt_delbcnt_delta; /* delayed dquot blk count changes */ 292 long qt_icount_delta; /* dquot inode count changes */ 293 ulong qt_rtblk_res; /* # blks reserved on a dquot */ 294 ulong qt_rtblk_res_used;/* # blks used from reservation */ 295 long qt_rtbcount_delta;/* dquot realtime blk changes */ 296 long qt_delrtb_delta; /* delayed RT blk count changes */ 297 } xfs_dqtrx_t; 298 299 #ifdef CONFIG_XFS_QUOTA 300 extern void xfs_trans_dup_dqinfo(struct xfs_trans *, struct xfs_trans *); 301 extern void xfs_trans_free_dqinfo(struct xfs_trans *); 302 extern void xfs_trans_mod_dquot_byino(struct xfs_trans *, struct xfs_inode *, 303 uint, long); 304 extern void xfs_trans_apply_dquot_deltas(struct xfs_trans *); 305 extern void xfs_trans_unreserve_and_mod_dquots(struct xfs_trans *); 306 extern int xfs_trans_reserve_quota_nblks(struct xfs_trans *, 307 struct xfs_inode *, long, long, uint); 308 extern int xfs_trans_reserve_quota_bydquots(struct xfs_trans *, 309 struct xfs_mount *, struct xfs_dquot *, 310 struct xfs_dquot *, long, long, uint); 311 312 extern int xfs_qm_vop_dqalloc(struct xfs_inode *, uid_t, gid_t, prid_t, uint, 313 struct xfs_dquot **, struct xfs_dquot **); 314 extern void xfs_qm_vop_create_dqattach(struct xfs_trans *, struct xfs_inode *, 315 struct xfs_dquot *, struct xfs_dquot *); 316 extern int xfs_qm_vop_rename_dqattach(struct xfs_inode **); 317 extern struct xfs_dquot *xfs_qm_vop_chown(struct xfs_trans *, 318 struct xfs_inode *, struct xfs_dquot **, struct xfs_dquot *); 319 extern int xfs_qm_vop_chown_reserve(struct xfs_trans *, struct xfs_inode *, 320 struct xfs_dquot *, struct xfs_dquot *, uint); 321 extern int xfs_qm_dqattach(struct xfs_inode *, uint); 322 extern int xfs_qm_dqattach_locked(struct xfs_inode *, uint); 323 extern void xfs_qm_dqdetach(struct xfs_inode *); 324 extern void xfs_qm_dqrele(struct xfs_dquot *); 325 extern void xfs_qm_statvfs(struct xfs_inode *, struct kstatfs *); 326 extern int xfs_qm_newmount(struct xfs_mount *, uint *, uint *); 327 extern void xfs_qm_mount_quotas(struct xfs_mount *); 328 extern void xfs_qm_unmount(struct xfs_mount *); 329 extern void xfs_qm_unmount_quotas(struct xfs_mount *); 330 331 #else 332 static inline int 333 xfs_qm_vop_dqalloc(struct xfs_inode *ip, uid_t uid, gid_t gid, prid_t prid, 334 uint flags, struct xfs_dquot **udqp, struct xfs_dquot **gdqp) 335 { 336 *udqp = NULL; 337 *gdqp = NULL; 338 return 0; 339 } 340 #define xfs_trans_dup_dqinfo(tp, tp2) 341 #define xfs_trans_free_dqinfo(tp) 342 #define xfs_trans_mod_dquot_byino(tp, ip, fields, delta) 343 #define xfs_trans_apply_dquot_deltas(tp) 344 #define xfs_trans_unreserve_and_mod_dquots(tp) 345 static inline int xfs_trans_reserve_quota_nblks(struct xfs_trans *tp, 346 struct xfs_inode *ip, long nblks, long ninos, uint flags) 347 { 348 return 0; 349 } 350 static inline int xfs_trans_reserve_quota_bydquots(struct xfs_trans *tp, 351 struct xfs_mount *mp, struct xfs_dquot *udqp, 352 struct xfs_dquot *gdqp, long nblks, long nions, uint flags) 353 { 354 return 0; 355 } 356 #define xfs_qm_vop_create_dqattach(tp, ip, u, g) 357 #define xfs_qm_vop_rename_dqattach(it) (0) 358 #define xfs_qm_vop_chown(tp, ip, old, new) (NULL) 359 #define xfs_qm_vop_chown_reserve(tp, ip, u, g, fl) (0) 360 #define xfs_qm_dqattach(ip, fl) (0) 361 #define xfs_qm_dqattach_locked(ip, fl) (0) 362 #define xfs_qm_dqdetach(ip) 363 #define xfs_qm_dqrele(d) 364 #define xfs_qm_statvfs(ip, s) 365 #define xfs_qm_newmount(mp, a, b) (0) 366 #define xfs_qm_mount_quotas(mp) 367 #define xfs_qm_unmount(mp) 368 #define xfs_qm_unmount_quotas(mp) 369 #endif /* CONFIG_XFS_QUOTA */ 370 371 #define xfs_trans_unreserve_quota_nblks(tp, ip, nblks, ninos, flags) \ 372 xfs_trans_reserve_quota_nblks(tp, ip, -(nblks), -(ninos), flags) 373 #define xfs_trans_reserve_quota(tp, mp, ud, gd, nb, ni, f) \ 374 xfs_trans_reserve_quota_bydquots(tp, mp, ud, gd, nb, ni, \ 375 f | XFS_QMOPT_RES_REGBLKS) 376 377 extern int xfs_qm_dqcheck(struct xfs_mount *, xfs_disk_dquot_t *, 378 xfs_dqid_t, uint, uint, char *); 379 extern int xfs_mount_reset_sbqflags(struct xfs_mount *); 380 381 #endif /* __KERNEL__ */ 382 #endif /* __XFS_QUOTA_H__ */ 383