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