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