xfs: separate dquot on disk format definitions out of xfs_quota.h
[firefly-linux-kernel-4.4.55.git] / fs / xfs / xfs_dquot_item.c
1 /*
2  * Copyright (c) 2000-2003 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 #include "xfs.h"
19 #include "xfs_fs.h"
20 #include "xfs_format.h"
21 #include "xfs_log.h"
22 #include "xfs_trans.h"
23 #include "xfs_sb.h"
24 #include "xfs_ag.h"
25 #include "xfs_alloc.h"
26 #include "xfs_quota.h"
27 #include "xfs_mount.h"
28 #include "xfs_bmap_btree.h"
29 #include "xfs_inode.h"
30 #include "xfs_bmap.h"
31 #include "xfs_rtalloc.h"
32 #include "xfs_error.h"
33 #include "xfs_itable.h"
34 #include "xfs_attr.h"
35 #include "xfs_buf_item.h"
36 #include "xfs_trans_priv.h"
37 #include "xfs_qm.h"
38
39 static inline struct xfs_dq_logitem *DQUOT_ITEM(struct xfs_log_item *lip)
40 {
41         return container_of(lip, struct xfs_dq_logitem, qli_item);
42 }
43
44 /*
45  * returns the number of iovecs needed to log the given dquot item.
46  */
47 STATIC uint
48 xfs_qm_dquot_logitem_size(
49         struct xfs_log_item     *lip)
50 {
51         /*
52          * we need only two iovecs, one for the format, one for the real thing
53          */
54         return 2;
55 }
56
57 /*
58  * fills in the vector of log iovecs for the given dquot log item.
59  */
60 STATIC void
61 xfs_qm_dquot_logitem_format(
62         struct xfs_log_item     *lip,
63         struct xfs_log_iovec    *logvec)
64 {
65         struct xfs_dq_logitem   *qlip = DQUOT_ITEM(lip);
66
67         logvec->i_addr = &qlip->qli_format;
68         logvec->i_len  = sizeof(xfs_dq_logformat_t);
69         logvec->i_type = XLOG_REG_TYPE_QFORMAT;
70         logvec++;
71         logvec->i_addr = &qlip->qli_dquot->q_core;
72         logvec->i_len  = sizeof(xfs_disk_dquot_t);
73         logvec->i_type = XLOG_REG_TYPE_DQUOT;
74
75         qlip->qli_format.qlf_size = 2;
76
77 }
78
79 /*
80  * Increment the pin count of the given dquot.
81  */
82 STATIC void
83 xfs_qm_dquot_logitem_pin(
84         struct xfs_log_item     *lip)
85 {
86         struct xfs_dquot        *dqp = DQUOT_ITEM(lip)->qli_dquot;
87
88         ASSERT(XFS_DQ_IS_LOCKED(dqp));
89         atomic_inc(&dqp->q_pincount);
90 }
91
92 /*
93  * Decrement the pin count of the given dquot, and wake up
94  * anyone in xfs_dqwait_unpin() if the count goes to 0.  The
95  * dquot must have been previously pinned with a call to
96  * xfs_qm_dquot_logitem_pin().
97  */
98 STATIC void
99 xfs_qm_dquot_logitem_unpin(
100         struct xfs_log_item     *lip,
101         int                     remove)
102 {
103         struct xfs_dquot        *dqp = DQUOT_ITEM(lip)->qli_dquot;
104
105         ASSERT(atomic_read(&dqp->q_pincount) > 0);
106         if (atomic_dec_and_test(&dqp->q_pincount))
107                 wake_up(&dqp->q_pinwait);
108 }
109
110 STATIC xfs_lsn_t
111 xfs_qm_dquot_logitem_committed(
112         struct xfs_log_item     *lip,
113         xfs_lsn_t               lsn)
114 {
115         /*
116          * We always re-log the entire dquot when it becomes dirty,
117          * so, the latest copy _is_ the only one that matters.
118          */
119         return lsn;
120 }
121
122 /*
123  * This is called to wait for the given dquot to be unpinned.
124  * Most of these pin/unpin routines are plagiarized from inode code.
125  */
126 void
127 xfs_qm_dqunpin_wait(
128         struct xfs_dquot        *dqp)
129 {
130         ASSERT(XFS_DQ_IS_LOCKED(dqp));
131         if (atomic_read(&dqp->q_pincount) == 0)
132                 return;
133
134         /*
135          * Give the log a push so we don't wait here too long.
136          */
137         xfs_log_force(dqp->q_mount, 0);
138         wait_event(dqp->q_pinwait, (atomic_read(&dqp->q_pincount) == 0));
139 }
140
141 STATIC uint
142 xfs_qm_dquot_logitem_push(
143         struct xfs_log_item     *lip,
144         struct list_head        *buffer_list)
145 {
146         struct xfs_dquot        *dqp = DQUOT_ITEM(lip)->qli_dquot;
147         struct xfs_buf          *bp = NULL;
148         uint                    rval = XFS_ITEM_SUCCESS;
149         int                     error;
150
151         if (atomic_read(&dqp->q_pincount) > 0)
152                 return XFS_ITEM_PINNED;
153
154         if (!xfs_dqlock_nowait(dqp))
155                 return XFS_ITEM_LOCKED;
156
157         /*
158          * Re-check the pincount now that we stabilized the value by
159          * taking the quota lock.
160          */
161         if (atomic_read(&dqp->q_pincount) > 0) {
162                 rval = XFS_ITEM_PINNED;
163                 goto out_unlock;
164         }
165
166         /*
167          * Someone else is already flushing the dquot.  Nothing we can do
168          * here but wait for the flush to finish and remove the item from
169          * the AIL.
170          */
171         if (!xfs_dqflock_nowait(dqp)) {
172                 rval = XFS_ITEM_FLUSHING;
173                 goto out_unlock;
174         }
175
176         spin_unlock(&lip->li_ailp->xa_lock);
177
178         error = xfs_qm_dqflush(dqp, &bp);
179         if (error) {
180                 xfs_warn(dqp->q_mount, "%s: push error %d on dqp %p",
181                         __func__, error, dqp);
182         } else {
183                 if (!xfs_buf_delwri_queue(bp, buffer_list))
184                         rval = XFS_ITEM_FLUSHING;
185                 xfs_buf_relse(bp);
186         }
187
188         spin_lock(&lip->li_ailp->xa_lock);
189 out_unlock:
190         xfs_dqunlock(dqp);
191         return rval;
192 }
193
194 /*
195  * Unlock the dquot associated with the log item.
196  * Clear the fields of the dquot and dquot log item that
197  * are specific to the current transaction.  If the
198  * hold flags is set, do not unlock the dquot.
199  */
200 STATIC void
201 xfs_qm_dquot_logitem_unlock(
202         struct xfs_log_item     *lip)
203 {
204         struct xfs_dquot        *dqp = DQUOT_ITEM(lip)->qli_dquot;
205
206         ASSERT(XFS_DQ_IS_LOCKED(dqp));
207
208         /*
209          * Clear the transaction pointer in the dquot
210          */
211         dqp->q_transp = NULL;
212
213         /*
214          * dquots are never 'held' from getting unlocked at the end of
215          * a transaction.  Their locking and unlocking is hidden inside the
216          * transaction layer, within trans_commit. Hence, no LI_HOLD flag
217          * for the logitem.
218          */
219         xfs_dqunlock(dqp);
220 }
221
222 /*
223  * this needs to stamp an lsn into the dquot, I think.
224  * rpc's that look at user dquot's would then have to
225  * push on the dependency recorded in the dquot
226  */
227 STATIC void
228 xfs_qm_dquot_logitem_committing(
229         struct xfs_log_item     *lip,
230         xfs_lsn_t               lsn)
231 {
232 }
233
234 /*
235  * This is the ops vector for dquots
236  */
237 static const struct xfs_item_ops xfs_dquot_item_ops = {
238         .iop_size       = xfs_qm_dquot_logitem_size,
239         .iop_format     = xfs_qm_dquot_logitem_format,
240         .iop_pin        = xfs_qm_dquot_logitem_pin,
241         .iop_unpin      = xfs_qm_dquot_logitem_unpin,
242         .iop_unlock     = xfs_qm_dquot_logitem_unlock,
243         .iop_committed  = xfs_qm_dquot_logitem_committed,
244         .iop_push       = xfs_qm_dquot_logitem_push,
245         .iop_committing = xfs_qm_dquot_logitem_committing
246 };
247
248 /*
249  * Initialize the dquot log item for a newly allocated dquot.
250  * The dquot isn't locked at this point, but it isn't on any of the lists
251  * either, so we don't care.
252  */
253 void
254 xfs_qm_dquot_logitem_init(
255         struct xfs_dquot        *dqp)
256 {
257         struct xfs_dq_logitem   *lp = &dqp->q_logitem;
258
259         xfs_log_item_init(dqp->q_mount, &lp->qli_item, XFS_LI_DQUOT,
260                                         &xfs_dquot_item_ops);
261         lp->qli_dquot = dqp;
262         lp->qli_format.qlf_type = XFS_LI_DQUOT;
263         lp->qli_format.qlf_id = be32_to_cpu(dqp->q_core.d_id);
264         lp->qli_format.qlf_blkno = dqp->q_blkno;
265         lp->qli_format.qlf_len = 1;
266         /*
267          * This is just the offset of this dquot within its buffer
268          * (which is currently 1 FSB and probably won't change).
269          * Hence 32 bits for this offset should be just fine.
270          * Alternatively, we can store (bufoffset / sizeof(xfs_dqblk_t))
271          * here, and recompute it at recovery time.
272          */
273         lp->qli_format.qlf_boffset = (__uint32_t)dqp->q_bufoffset;
274 }
275
276 /*------------------  QUOTAOFF LOG ITEMS  -------------------*/
277
278 static inline struct xfs_qoff_logitem *QOFF_ITEM(struct xfs_log_item *lip)
279 {
280         return container_of(lip, struct xfs_qoff_logitem, qql_item);
281 }
282
283
284 /*
285  * This returns the number of iovecs needed to log the given quotaoff item.
286  * We only need 1 iovec for an quotaoff item.  It just logs the
287  * quotaoff_log_format structure.
288  */
289 STATIC uint
290 xfs_qm_qoff_logitem_size(
291         struct xfs_log_item     *lip)
292 {
293         return 1;
294 }
295
296 /*
297  * This is called to fill in the vector of log iovecs for the
298  * given quotaoff log item. We use only 1 iovec, and we point that
299  * at the quotaoff_log_format structure embedded in the quotaoff item.
300  * It is at this point that we assert that all of the extent
301  * slots in the quotaoff item have been filled.
302  */
303 STATIC void
304 xfs_qm_qoff_logitem_format(
305         struct xfs_log_item     *lip,
306         struct xfs_log_iovec    *log_vector)
307 {
308         struct xfs_qoff_logitem *qflip = QOFF_ITEM(lip);
309
310         ASSERT(qflip->qql_format.qf_type == XFS_LI_QUOTAOFF);
311
312         log_vector->i_addr = &qflip->qql_format;
313         log_vector->i_len = sizeof(xfs_qoff_logitem_t);
314         log_vector->i_type = XLOG_REG_TYPE_QUOTAOFF;
315         qflip->qql_format.qf_size = 1;
316 }
317
318 /*
319  * Pinning has no meaning for an quotaoff item, so just return.
320  */
321 STATIC void
322 xfs_qm_qoff_logitem_pin(
323         struct xfs_log_item     *lip)
324 {
325 }
326
327 /*
328  * Since pinning has no meaning for an quotaoff item, unpinning does
329  * not either.
330  */
331 STATIC void
332 xfs_qm_qoff_logitem_unpin(
333         struct xfs_log_item     *lip,
334         int                     remove)
335 {
336 }
337
338 /*
339  * There isn't much you can do to push a quotaoff item.  It is simply
340  * stuck waiting for the log to be flushed to disk.
341  */
342 STATIC uint
343 xfs_qm_qoff_logitem_push(
344         struct xfs_log_item     *lip,
345         struct list_head        *buffer_list)
346 {
347         return XFS_ITEM_LOCKED;
348 }
349
350 /*
351  * Quotaoff items have no locking or pushing, so return failure
352  * so that the caller doesn't bother with us.
353  */
354 STATIC void
355 xfs_qm_qoff_logitem_unlock(
356         struct xfs_log_item     *lip)
357 {
358 }
359
360 /*
361  * The quotaoff-start-item is logged only once and cannot be moved in the log,
362  * so simply return the lsn at which it's been logged.
363  */
364 STATIC xfs_lsn_t
365 xfs_qm_qoff_logitem_committed(
366         struct xfs_log_item     *lip,
367         xfs_lsn_t               lsn)
368 {
369         return lsn;
370 }
371
372 STATIC xfs_lsn_t
373 xfs_qm_qoffend_logitem_committed(
374         struct xfs_log_item     *lip,
375         xfs_lsn_t               lsn)
376 {
377         struct xfs_qoff_logitem *qfe = QOFF_ITEM(lip);
378         struct xfs_qoff_logitem *qfs = qfe->qql_start_lip;
379         struct xfs_ail          *ailp = qfs->qql_item.li_ailp;
380
381         /*
382          * Delete the qoff-start logitem from the AIL.
383          * xfs_trans_ail_delete() drops the AIL lock.
384          */
385         spin_lock(&ailp->xa_lock);
386         xfs_trans_ail_delete(ailp, &qfs->qql_item, SHUTDOWN_LOG_IO_ERROR);
387
388         kmem_free(qfs);
389         kmem_free(qfe);
390         return (xfs_lsn_t)-1;
391 }
392
393 /*
394  * XXX rcc - don't know quite what to do with this.  I think we can
395  * just ignore it.  The only time that isn't the case is if we allow
396  * the client to somehow see that quotas have been turned off in which
397  * we can't allow that to get back until the quotaoff hits the disk.
398  * So how would that happen?  Also, do we need different routines for
399  * quotaoff start and quotaoff end?  I suspect the answer is yes but
400  * to be sure, I need to look at the recovery code and see how quota off
401  * recovery is handled (do we roll forward or back or do something else).
402  * If we roll forwards or backwards, then we need two separate routines,
403  * one that does nothing and one that stamps in the lsn that matters
404  * (truly makes the quotaoff irrevocable).  If we do something else,
405  * then maybe we don't need two.
406  */
407 STATIC void
408 xfs_qm_qoff_logitem_committing(
409         struct xfs_log_item     *lip,
410         xfs_lsn_t               commit_lsn)
411 {
412 }
413
414 static const struct xfs_item_ops xfs_qm_qoffend_logitem_ops = {
415         .iop_size       = xfs_qm_qoff_logitem_size,
416         .iop_format     = xfs_qm_qoff_logitem_format,
417         .iop_pin        = xfs_qm_qoff_logitem_pin,
418         .iop_unpin      = xfs_qm_qoff_logitem_unpin,
419         .iop_unlock     = xfs_qm_qoff_logitem_unlock,
420         .iop_committed  = xfs_qm_qoffend_logitem_committed,
421         .iop_push       = xfs_qm_qoff_logitem_push,
422         .iop_committing = xfs_qm_qoff_logitem_committing
423 };
424
425 /*
426  * This is the ops vector shared by all quotaoff-start log items.
427  */
428 static const struct xfs_item_ops xfs_qm_qoff_logitem_ops = {
429         .iop_size       = xfs_qm_qoff_logitem_size,
430         .iop_format     = xfs_qm_qoff_logitem_format,
431         .iop_pin        = xfs_qm_qoff_logitem_pin,
432         .iop_unpin      = xfs_qm_qoff_logitem_unpin,
433         .iop_unlock     = xfs_qm_qoff_logitem_unlock,
434         .iop_committed  = xfs_qm_qoff_logitem_committed,
435         .iop_push       = xfs_qm_qoff_logitem_push,
436         .iop_committing = xfs_qm_qoff_logitem_committing
437 };
438
439 /*
440  * Allocate and initialize an quotaoff item of the correct quota type(s).
441  */
442 struct xfs_qoff_logitem *
443 xfs_qm_qoff_logitem_init(
444         struct xfs_mount        *mp,
445         struct xfs_qoff_logitem *start,
446         uint                    flags)
447 {
448         struct xfs_qoff_logitem *qf;
449
450         qf = kmem_zalloc(sizeof(struct xfs_qoff_logitem), KM_SLEEP);
451
452         xfs_log_item_init(mp, &qf->qql_item, XFS_LI_QUOTAOFF, start ?
453                         &xfs_qm_qoffend_logitem_ops : &xfs_qm_qoff_logitem_ops);
454         qf->qql_item.li_mountp = mp;
455         qf->qql_format.qf_type = XFS_LI_QUOTAOFF;
456         qf->qql_format.qf_flags = flags;
457         qf->qql_start_lip = start;
458         return qf;
459 }