xfs: fix multi-AG deadlock in xfs_bunmapi
[sfrench/cifs-2.6.git] / fs / xfs / xfs_log_cil.c
1 /*
2  * Copyright (c) 2010 Red Hat, Inc. All Rights Reserved.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it would be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write the Free Software Foundation,
15  * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
16  */
17
18 #include "xfs.h"
19 #include "xfs_fs.h"
20 #include "xfs_format.h"
21 #include "xfs_log_format.h"
22 #include "xfs_shared.h"
23 #include "xfs_trans_resv.h"
24 #include "xfs_mount.h"
25 #include "xfs_error.h"
26 #include "xfs_alloc.h"
27 #include "xfs_extent_busy.h"
28 #include "xfs_discard.h"
29 #include "xfs_trans.h"
30 #include "xfs_trans_priv.h"
31 #include "xfs_log.h"
32 #include "xfs_log_priv.h"
33 #include "xfs_trace.h"
34
35 struct workqueue_struct *xfs_discard_wq;
36
37 /*
38  * Allocate a new ticket. Failing to get a new ticket makes it really hard to
39  * recover, so we don't allow failure here. Also, we allocate in a context that
40  * we don't want to be issuing transactions from, so we need to tell the
41  * allocation code this as well.
42  *
43  * We don't reserve any space for the ticket - we are going to steal whatever
44  * space we require from transactions as they commit. To ensure we reserve all
45  * the space required, we need to set the current reservation of the ticket to
46  * zero so that we know to steal the initial transaction overhead from the
47  * first transaction commit.
48  */
49 static struct xlog_ticket *
50 xlog_cil_ticket_alloc(
51         struct xlog     *log)
52 {
53         struct xlog_ticket *tic;
54
55         tic = xlog_ticket_alloc(log, 0, 1, XFS_TRANSACTION, 0,
56                                 KM_SLEEP|KM_NOFS);
57
58         /*
59          * set the current reservation to zero so we know to steal the basic
60          * transaction overhead reservation from the first transaction commit.
61          */
62         tic->t_curr_res = 0;
63         return tic;
64 }
65
66 /*
67  * After the first stage of log recovery is done, we know where the head and
68  * tail of the log are. We need this log initialisation done before we can
69  * initialise the first CIL checkpoint context.
70  *
71  * Here we allocate a log ticket to track space usage during a CIL push.  This
72  * ticket is passed to xlog_write() directly so that we don't slowly leak log
73  * space by failing to account for space used by log headers and additional
74  * region headers for split regions.
75  */
76 void
77 xlog_cil_init_post_recovery(
78         struct xlog     *log)
79 {
80         log->l_cilp->xc_ctx->ticket = xlog_cil_ticket_alloc(log);
81         log->l_cilp->xc_ctx->sequence = 1;
82 }
83
84 static inline int
85 xlog_cil_iovec_space(
86         uint    niovecs)
87 {
88         return round_up((sizeof(struct xfs_log_vec) +
89                                         niovecs * sizeof(struct xfs_log_iovec)),
90                         sizeof(uint64_t));
91 }
92
93 /*
94  * Allocate or pin log vector buffers for CIL insertion.
95  *
96  * The CIL currently uses disposable buffers for copying a snapshot of the
97  * modified items into the log during a push. The biggest problem with this is
98  * the requirement to allocate the disposable buffer during the commit if:
99  *      a) does not exist; or
100  *      b) it is too small
101  *
102  * If we do this allocation within xlog_cil_insert_format_items(), it is done
103  * under the xc_ctx_lock, which means that a CIL push cannot occur during
104  * the memory allocation. This means that we have a potential deadlock situation
105  * under low memory conditions when we have lots of dirty metadata pinned in
106  * the CIL and we need a CIL commit to occur to free memory.
107  *
108  * To avoid this, we need to move the memory allocation outside the
109  * xc_ctx_lock, but because the log vector buffers are disposable, that opens
110  * up a TOCTOU race condition w.r.t. the CIL committing and removing the log
111  * vector buffers between the check and the formatting of the item into the
112  * log vector buffer within the xc_ctx_lock.
113  *
114  * Because the log vector buffer needs to be unchanged during the CIL push
115  * process, we cannot share the buffer between the transaction commit (which
116  * modifies the buffer) and the CIL push context that is writing the changes
117  * into the log. This means skipping preallocation of buffer space is
118  * unreliable, but we most definitely do not want to be allocating and freeing
119  * buffers unnecessarily during commits when overwrites can be done safely.
120  *
121  * The simplest solution to this problem is to allocate a shadow buffer when a
122  * log item is committed for the second time, and then to only use this buffer
123  * if necessary. The buffer can remain attached to the log item until such time
124  * it is needed, and this is the buffer that is reallocated to match the size of
125  * the incoming modification. Then during the formatting of the item we can swap
126  * the active buffer with the new one if we can't reuse the existing buffer. We
127  * don't free the old buffer as it may be reused on the next modification if
128  * it's size is right, otherwise we'll free and reallocate it at that point.
129  *
130  * This function builds a vector for the changes in each log item in the
131  * transaction. It then works out the length of the buffer needed for each log
132  * item, allocates them and attaches the vector to the log item in preparation
133  * for the formatting step which occurs under the xc_ctx_lock.
134  *
135  * While this means the memory footprint goes up, it avoids the repeated
136  * alloc/free pattern that repeated modifications of an item would otherwise
137  * cause, and hence minimises the CPU overhead of such behaviour.
138  */
139 static void
140 xlog_cil_alloc_shadow_bufs(
141         struct xlog             *log,
142         struct xfs_trans        *tp)
143 {
144         struct xfs_log_item_desc *lidp;
145
146         list_for_each_entry(lidp, &tp->t_items, lid_trans) {
147                 struct xfs_log_item *lip = lidp->lid_item;
148                 struct xfs_log_vec *lv;
149                 int     niovecs = 0;
150                 int     nbytes = 0;
151                 int     buf_size;
152                 bool    ordered = false;
153
154                 /* Skip items which aren't dirty in this transaction. */
155                 if (!(lidp->lid_flags & XFS_LID_DIRTY))
156                         continue;
157
158                 /* get number of vecs and size of data to be stored */
159                 lip->li_ops->iop_size(lip, &niovecs, &nbytes);
160
161                 /*
162                  * Ordered items need to be tracked but we do not wish to write
163                  * them. We need a logvec to track the object, but we do not
164                  * need an iovec or buffer to be allocated for copying data.
165                  */
166                 if (niovecs == XFS_LOG_VEC_ORDERED) {
167                         ordered = true;
168                         niovecs = 0;
169                         nbytes = 0;
170                 }
171
172                 /*
173                  * We 64-bit align the length of each iovec so that the start
174                  * of the next one is naturally aligned.  We'll need to
175                  * account for that slack space here. Then round nbytes up
176                  * to 64-bit alignment so that the initial buffer alignment is
177                  * easy to calculate and verify.
178                  */
179                 nbytes += niovecs * sizeof(uint64_t);
180                 nbytes = round_up(nbytes, sizeof(uint64_t));
181
182                 /*
183                  * The data buffer needs to start 64-bit aligned, so round up
184                  * that space to ensure we can align it appropriately and not
185                  * overrun the buffer.
186                  */
187                 buf_size = nbytes + xlog_cil_iovec_space(niovecs);
188
189                 /*
190                  * if we have no shadow buffer, or it is too small, we need to
191                  * reallocate it.
192                  */
193                 if (!lip->li_lv_shadow ||
194                     buf_size > lip->li_lv_shadow->lv_size) {
195
196                         /*
197                          * We free and allocate here as a realloc would copy
198                          * unecessary data. We don't use kmem_zalloc() for the
199                          * same reason - we don't need to zero the data area in
200                          * the buffer, only the log vector header and the iovec
201                          * storage.
202                          */
203                         kmem_free(lip->li_lv_shadow);
204
205                         lv = kmem_alloc(buf_size, KM_SLEEP|KM_NOFS);
206                         memset(lv, 0, xlog_cil_iovec_space(niovecs));
207
208                         lv->lv_item = lip;
209                         lv->lv_size = buf_size;
210                         if (ordered)
211                                 lv->lv_buf_len = XFS_LOG_VEC_ORDERED;
212                         else
213                                 lv->lv_iovecp = (struct xfs_log_iovec *)&lv[1];
214                         lip->li_lv_shadow = lv;
215                 } else {
216                         /* same or smaller, optimise common overwrite case */
217                         lv = lip->li_lv_shadow;
218                         if (ordered)
219                                 lv->lv_buf_len = XFS_LOG_VEC_ORDERED;
220                         else
221                                 lv->lv_buf_len = 0;
222                         lv->lv_bytes = 0;
223                         lv->lv_next = NULL;
224                 }
225
226                 /* Ensure the lv is set up according to ->iop_size */
227                 lv->lv_niovecs = niovecs;
228
229                 /* The allocated data region lies beyond the iovec region */
230                 lv->lv_buf = (char *)lv + xlog_cil_iovec_space(niovecs);
231         }
232
233 }
234
235 /*
236  * Prepare the log item for insertion into the CIL. Calculate the difference in
237  * log space and vectors it will consume, and if it is a new item pin it as
238  * well.
239  */
240 STATIC void
241 xfs_cil_prepare_item(
242         struct xlog             *log,
243         struct xfs_log_vec      *lv,
244         struct xfs_log_vec      *old_lv,
245         int                     *diff_len,
246         int                     *diff_iovecs)
247 {
248         /* Account for the new LV being passed in */
249         if (lv->lv_buf_len != XFS_LOG_VEC_ORDERED) {
250                 *diff_len += lv->lv_bytes;
251                 *diff_iovecs += lv->lv_niovecs;
252         }
253
254         /*
255          * If there is no old LV, this is the first time we've seen the item in
256          * this CIL context and so we need to pin it. If we are replacing the
257          * old_lv, then remove the space it accounts for and make it the shadow
258          * buffer for later freeing. In both cases we are now switching to the
259          * shadow buffer, so update the the pointer to it appropriately.
260          */
261         if (!old_lv) {
262                 lv->lv_item->li_ops->iop_pin(lv->lv_item);
263                 lv->lv_item->li_lv_shadow = NULL;
264         } else if (old_lv != lv) {
265                 ASSERT(lv->lv_buf_len != XFS_LOG_VEC_ORDERED);
266
267                 *diff_len -= old_lv->lv_bytes;
268                 *diff_iovecs -= old_lv->lv_niovecs;
269                 lv->lv_item->li_lv_shadow = old_lv;
270         }
271
272         /* attach new log vector to log item */
273         lv->lv_item->li_lv = lv;
274
275         /*
276          * If this is the first time the item is being committed to the
277          * CIL, store the sequence number on the log item so we can
278          * tell in future commits whether this is the first checkpoint
279          * the item is being committed into.
280          */
281         if (!lv->lv_item->li_seq)
282                 lv->lv_item->li_seq = log->l_cilp->xc_ctx->sequence;
283 }
284
285 /*
286  * Format log item into a flat buffers
287  *
288  * For delayed logging, we need to hold a formatted buffer containing all the
289  * changes on the log item. This enables us to relog the item in memory and
290  * write it out asynchronously without needing to relock the object that was
291  * modified at the time it gets written into the iclog.
292  *
293  * This function takes the prepared log vectors attached to each log item, and
294  * formats the changes into the log vector buffer. The buffer it uses is
295  * dependent on the current state of the vector in the CIL - the shadow lv is
296  * guaranteed to be large enough for the current modification, but we will only
297  * use that if we can't reuse the existing lv. If we can't reuse the existing
298  * lv, then simple swap it out for the shadow lv. We don't free it - that is
299  * done lazily either by th enext modification or the freeing of the log item.
300  *
301  * We don't set up region headers during this process; we simply copy the
302  * regions into the flat buffer. We can do this because we still have to do a
303  * formatting step to write the regions into the iclog buffer.  Writing the
304  * ophdrs during the iclog write means that we can support splitting large
305  * regions across iclog boundares without needing a change in the format of the
306  * item/region encapsulation.
307  *
308  * Hence what we need to do now is change the rewrite the vector array to point
309  * to the copied region inside the buffer we just allocated. This allows us to
310  * format the regions into the iclog as though they are being formatted
311  * directly out of the objects themselves.
312  */
313 static void
314 xlog_cil_insert_format_items(
315         struct xlog             *log,
316         struct xfs_trans        *tp,
317         int                     *diff_len,
318         int                     *diff_iovecs)
319 {
320         struct xfs_log_item_desc *lidp;
321
322
323         /* Bail out if we didn't find a log item.  */
324         if (list_empty(&tp->t_items)) {
325                 ASSERT(0);
326                 return;
327         }
328
329         list_for_each_entry(lidp, &tp->t_items, lid_trans) {
330                 struct xfs_log_item *lip = lidp->lid_item;
331                 struct xfs_log_vec *lv;
332                 struct xfs_log_vec *old_lv = NULL;
333                 struct xfs_log_vec *shadow;
334                 bool    ordered = false;
335
336                 /* Skip items which aren't dirty in this transaction. */
337                 if (!(lidp->lid_flags & XFS_LID_DIRTY))
338                         continue;
339
340                 /*
341                  * The formatting size information is already attached to
342                  * the shadow lv on the log item.
343                  */
344                 shadow = lip->li_lv_shadow;
345                 if (shadow->lv_buf_len == XFS_LOG_VEC_ORDERED)
346                         ordered = true;
347
348                 /* Skip items that do not have any vectors for writing */
349                 if (!shadow->lv_niovecs && !ordered)
350                         continue;
351
352                 /* compare to existing item size */
353                 old_lv = lip->li_lv;
354                 if (lip->li_lv && shadow->lv_size <= lip->li_lv->lv_size) {
355                         /* same or smaller, optimise common overwrite case */
356                         lv = lip->li_lv;
357                         lv->lv_next = NULL;
358
359                         if (ordered)
360                                 goto insert;
361
362                         /*
363                          * set the item up as though it is a new insertion so
364                          * that the space reservation accounting is correct.
365                          */
366                         *diff_iovecs -= lv->lv_niovecs;
367                         *diff_len -= lv->lv_bytes;
368
369                         /* Ensure the lv is set up according to ->iop_size */
370                         lv->lv_niovecs = shadow->lv_niovecs;
371
372                         /* reset the lv buffer information for new formatting */
373                         lv->lv_buf_len = 0;
374                         lv->lv_bytes = 0;
375                         lv->lv_buf = (char *)lv +
376                                         xlog_cil_iovec_space(lv->lv_niovecs);
377                 } else {
378                         /* switch to shadow buffer! */
379                         lv = shadow;
380                         lv->lv_item = lip;
381                         if (ordered) {
382                                 /* track as an ordered logvec */
383                                 ASSERT(lip->li_lv == NULL);
384                                 goto insert;
385                         }
386                 }
387
388                 ASSERT(IS_ALIGNED((unsigned long)lv->lv_buf, sizeof(uint64_t)));
389                 lip->li_ops->iop_format(lip, lv);
390 insert:
391                 xfs_cil_prepare_item(log, lv, old_lv, diff_len, diff_iovecs);
392         }
393 }
394
395 /*
396  * Insert the log items into the CIL and calculate the difference in space
397  * consumed by the item. Add the space to the checkpoint ticket and calculate
398  * if the change requires additional log metadata. If it does, take that space
399  * as well. Remove the amount of space we added to the checkpoint ticket from
400  * the current transaction ticket so that the accounting works out correctly.
401  */
402 static void
403 xlog_cil_insert_items(
404         struct xlog             *log,
405         struct xfs_trans        *tp)
406 {
407         struct xfs_cil          *cil = log->l_cilp;
408         struct xfs_cil_ctx      *ctx = cil->xc_ctx;
409         struct xfs_log_item_desc *lidp;
410         int                     len = 0;
411         int                     diff_iovecs = 0;
412         int                     iclog_space;
413         int                     iovhdr_res = 0, split_res = 0, ctx_res = 0;
414
415         ASSERT(tp);
416
417         /*
418          * We can do this safely because the context can't checkpoint until we
419          * are done so it doesn't matter exactly how we update the CIL.
420          */
421         xlog_cil_insert_format_items(log, tp, &len, &diff_iovecs);
422
423         spin_lock(&cil->xc_cil_lock);
424
425         /* account for space used by new iovec headers  */
426         iovhdr_res = diff_iovecs * sizeof(xlog_op_header_t);
427         len += iovhdr_res;
428         ctx->nvecs += diff_iovecs;
429
430         /* attach the transaction to the CIL if it has any busy extents */
431         if (!list_empty(&tp->t_busy))
432                 list_splice_init(&tp->t_busy, &ctx->busy_extents);
433
434         /*
435          * Now transfer enough transaction reservation to the context ticket
436          * for the checkpoint. The context ticket is special - the unit
437          * reservation has to grow as well as the current reservation as we
438          * steal from tickets so we can correctly determine the space used
439          * during the transaction commit.
440          */
441         if (ctx->ticket->t_curr_res == 0) {
442                 ctx_res = ctx->ticket->t_unit_res;
443                 ctx->ticket->t_curr_res = ctx_res;
444                 tp->t_ticket->t_curr_res -= ctx_res;
445         }
446
447         /* do we need space for more log record headers? */
448         iclog_space = log->l_iclog_size - log->l_iclog_hsize;
449         if (len > 0 && (ctx->space_used / iclog_space !=
450                                 (ctx->space_used + len) / iclog_space)) {
451                 split_res = (len + iclog_space - 1) / iclog_space;
452                 /* need to take into account split region headers, too */
453                 split_res *= log->l_iclog_hsize + sizeof(struct xlog_op_header);
454                 ctx->ticket->t_unit_res += split_res;
455                 ctx->ticket->t_curr_res += split_res;
456                 tp->t_ticket->t_curr_res -= split_res;
457                 ASSERT(tp->t_ticket->t_curr_res >= len);
458         }
459         tp->t_ticket->t_curr_res -= len;
460         ctx->space_used += len;
461
462         /*
463          * If we've overrun the reservation, dump the tx details before we move
464          * the log items. Shutdown is imminent...
465          */
466         if (WARN_ON(tp->t_ticket->t_curr_res < 0)) {
467                 xfs_warn(log->l_mp, "Transaction log reservation overrun:");
468                 xfs_warn(log->l_mp,
469                          "  log items: %d bytes (iov hdrs: %d bytes)",
470                          len, iovhdr_res);
471                 xfs_warn(log->l_mp, "  split region headers: %d bytes",
472                          split_res);
473                 xfs_warn(log->l_mp, "  ctx ticket: %d bytes", ctx_res);
474                 xlog_print_trans(tp);
475         }
476
477         /*
478          * Now (re-)position everything modified at the tail of the CIL.
479          * We do this here so we only need to take the CIL lock once during
480          * the transaction commit.
481          */
482         list_for_each_entry(lidp, &tp->t_items, lid_trans) {
483                 struct xfs_log_item     *lip = lidp->lid_item;
484
485                 /* Skip items which aren't dirty in this transaction. */
486                 if (!(lidp->lid_flags & XFS_LID_DIRTY))
487                         continue;
488
489                 /*
490                  * Only move the item if it isn't already at the tail. This is
491                  * to prevent a transient list_empty() state when reinserting
492                  * an item that is already the only item in the CIL.
493                  */
494                 if (!list_is_last(&lip->li_cil, &cil->xc_cil))
495                         list_move_tail(&lip->li_cil, &cil->xc_cil);
496         }
497
498         spin_unlock(&cil->xc_cil_lock);
499
500         if (tp->t_ticket->t_curr_res < 0)
501                 xfs_force_shutdown(log->l_mp, SHUTDOWN_LOG_IO_ERROR);
502 }
503
504 static void
505 xlog_cil_free_logvec(
506         struct xfs_log_vec      *log_vector)
507 {
508         struct xfs_log_vec      *lv;
509
510         for (lv = log_vector; lv; ) {
511                 struct xfs_log_vec *next = lv->lv_next;
512                 kmem_free(lv);
513                 lv = next;
514         }
515 }
516
517 static void
518 xlog_discard_endio_work(
519         struct work_struct      *work)
520 {
521         struct xfs_cil_ctx      *ctx =
522                 container_of(work, struct xfs_cil_ctx, discard_endio_work);
523         struct xfs_mount        *mp = ctx->cil->xc_log->l_mp;
524
525         xfs_extent_busy_clear(mp, &ctx->busy_extents, false);
526         kmem_free(ctx);
527 }
528
529 /*
530  * Queue up the actual completion to a thread to avoid IRQ-safe locking for
531  * pagb_lock.  Note that we need a unbounded workqueue, otherwise we might
532  * get the execution delayed up to 30 seconds for weird reasons.
533  */
534 static void
535 xlog_discard_endio(
536         struct bio              *bio)
537 {
538         struct xfs_cil_ctx      *ctx = bio->bi_private;
539
540         INIT_WORK(&ctx->discard_endio_work, xlog_discard_endio_work);
541         queue_work(xfs_discard_wq, &ctx->discard_endio_work);
542 }
543
544 static void
545 xlog_discard_busy_extents(
546         struct xfs_mount        *mp,
547         struct xfs_cil_ctx      *ctx)
548 {
549         struct list_head        *list = &ctx->busy_extents;
550         struct xfs_extent_busy  *busyp;
551         struct bio              *bio = NULL;
552         struct blk_plug         plug;
553         int                     error = 0;
554
555         ASSERT(mp->m_flags & XFS_MOUNT_DISCARD);
556
557         blk_start_plug(&plug);
558         list_for_each_entry(busyp, list, list) {
559                 trace_xfs_discard_extent(mp, busyp->agno, busyp->bno,
560                                          busyp->length);
561
562                 error = __blkdev_issue_discard(mp->m_ddev_targp->bt_bdev,
563                                 XFS_AGB_TO_DADDR(mp, busyp->agno, busyp->bno),
564                                 XFS_FSB_TO_BB(mp, busyp->length),
565                                 GFP_NOFS, 0, &bio);
566                 if (error && error != -EOPNOTSUPP) {
567                         xfs_info(mp,
568          "discard failed for extent [0x%llx,%u], error %d",
569                                  (unsigned long long)busyp->bno,
570                                  busyp->length,
571                                  error);
572                         break;
573                 }
574         }
575
576         if (bio) {
577                 bio->bi_private = ctx;
578                 bio->bi_end_io = xlog_discard_endio;
579                 submit_bio(bio);
580         } else {
581                 xlog_discard_endio_work(&ctx->discard_endio_work);
582         }
583         blk_finish_plug(&plug);
584 }
585
586 /*
587  * Mark all items committed and clear busy extents. We free the log vector
588  * chains in a separate pass so that we unpin the log items as quickly as
589  * possible.
590  */
591 static void
592 xlog_cil_committed(
593         void    *args,
594         int     abort)
595 {
596         struct xfs_cil_ctx      *ctx = args;
597         struct xfs_mount        *mp = ctx->cil->xc_log->l_mp;
598
599         xfs_trans_committed_bulk(ctx->cil->xc_log->l_ailp, ctx->lv_chain,
600                                         ctx->start_lsn, abort);
601
602         xfs_extent_busy_sort(&ctx->busy_extents);
603         xfs_extent_busy_clear(mp, &ctx->busy_extents,
604                              (mp->m_flags & XFS_MOUNT_DISCARD) && !abort);
605
606         /*
607          * If we are aborting the commit, wake up anyone waiting on the
608          * committing list.  If we don't, then a shutdown we can leave processes
609          * waiting in xlog_cil_force_lsn() waiting on a sequence commit that
610          * will never happen because we aborted it.
611          */
612         spin_lock(&ctx->cil->xc_push_lock);
613         if (abort)
614                 wake_up_all(&ctx->cil->xc_commit_wait);
615         list_del(&ctx->committing);
616         spin_unlock(&ctx->cil->xc_push_lock);
617
618         xlog_cil_free_logvec(ctx->lv_chain);
619
620         if (!list_empty(&ctx->busy_extents))
621                 xlog_discard_busy_extents(mp, ctx);
622         else
623                 kmem_free(ctx);
624 }
625
626 /*
627  * Push the Committed Item List to the log. If @push_seq flag is zero, then it
628  * is a background flush and so we can chose to ignore it. Otherwise, if the
629  * current sequence is the same as @push_seq we need to do a flush. If
630  * @push_seq is less than the current sequence, then it has already been
631  * flushed and we don't need to do anything - the caller will wait for it to
632  * complete if necessary.
633  *
634  * @push_seq is a value rather than a flag because that allows us to do an
635  * unlocked check of the sequence number for a match. Hence we can allows log
636  * forces to run racily and not issue pushes for the same sequence twice. If we
637  * get a race between multiple pushes for the same sequence they will block on
638  * the first one and then abort, hence avoiding needless pushes.
639  */
640 STATIC int
641 xlog_cil_push(
642         struct xlog             *log)
643 {
644         struct xfs_cil          *cil = log->l_cilp;
645         struct xfs_log_vec      *lv;
646         struct xfs_cil_ctx      *ctx;
647         struct xfs_cil_ctx      *new_ctx;
648         struct xlog_in_core     *commit_iclog;
649         struct xlog_ticket      *tic;
650         int                     num_iovecs;
651         int                     error = 0;
652         struct xfs_trans_header thdr;
653         struct xfs_log_iovec    lhdr;
654         struct xfs_log_vec      lvhdr = { NULL };
655         xfs_lsn_t               commit_lsn;
656         xfs_lsn_t               push_seq;
657
658         if (!cil)
659                 return 0;
660
661         new_ctx = kmem_zalloc(sizeof(*new_ctx), KM_SLEEP|KM_NOFS);
662         new_ctx->ticket = xlog_cil_ticket_alloc(log);
663
664         down_write(&cil->xc_ctx_lock);
665         ctx = cil->xc_ctx;
666
667         spin_lock(&cil->xc_push_lock);
668         push_seq = cil->xc_push_seq;
669         ASSERT(push_seq <= ctx->sequence);
670
671         /*
672          * Check if we've anything to push. If there is nothing, then we don't
673          * move on to a new sequence number and so we have to be able to push
674          * this sequence again later.
675          */
676         if (list_empty(&cil->xc_cil)) {
677                 cil->xc_push_seq = 0;
678                 spin_unlock(&cil->xc_push_lock);
679                 goto out_skip;
680         }
681
682
683         /* check for a previously pushed seqeunce */
684         if (push_seq < cil->xc_ctx->sequence) {
685                 spin_unlock(&cil->xc_push_lock);
686                 goto out_skip;
687         }
688
689         /*
690          * We are now going to push this context, so add it to the committing
691          * list before we do anything else. This ensures that anyone waiting on
692          * this push can easily detect the difference between a "push in
693          * progress" and "CIL is empty, nothing to do".
694          *
695          * IOWs, a wait loop can now check for:
696          *      the current sequence not being found on the committing list;
697          *      an empty CIL; and
698          *      an unchanged sequence number
699          * to detect a push that had nothing to do and therefore does not need
700          * waiting on. If the CIL is not empty, we get put on the committing
701          * list before emptying the CIL and bumping the sequence number. Hence
702          * an empty CIL and an unchanged sequence number means we jumped out
703          * above after doing nothing.
704          *
705          * Hence the waiter will either find the commit sequence on the
706          * committing list or the sequence number will be unchanged and the CIL
707          * still dirty. In that latter case, the push has not yet started, and
708          * so the waiter will have to continue trying to check the CIL
709          * committing list until it is found. In extreme cases of delay, the
710          * sequence may fully commit between the attempts the wait makes to wait
711          * on the commit sequence.
712          */
713         list_add(&ctx->committing, &cil->xc_committing);
714         spin_unlock(&cil->xc_push_lock);
715
716         /*
717          * pull all the log vectors off the items in the CIL, and
718          * remove the items from the CIL. We don't need the CIL lock
719          * here because it's only needed on the transaction commit
720          * side which is currently locked out by the flush lock.
721          */
722         lv = NULL;
723         num_iovecs = 0;
724         while (!list_empty(&cil->xc_cil)) {
725                 struct xfs_log_item     *item;
726
727                 item = list_first_entry(&cil->xc_cil,
728                                         struct xfs_log_item, li_cil);
729                 list_del_init(&item->li_cil);
730                 if (!ctx->lv_chain)
731                         ctx->lv_chain = item->li_lv;
732                 else
733                         lv->lv_next = item->li_lv;
734                 lv = item->li_lv;
735                 item->li_lv = NULL;
736                 num_iovecs += lv->lv_niovecs;
737         }
738
739         /*
740          * initialise the new context and attach it to the CIL. Then attach
741          * the current context to the CIL committing lsit so it can be found
742          * during log forces to extract the commit lsn of the sequence that
743          * needs to be forced.
744          */
745         INIT_LIST_HEAD(&new_ctx->committing);
746         INIT_LIST_HEAD(&new_ctx->busy_extents);
747         new_ctx->sequence = ctx->sequence + 1;
748         new_ctx->cil = cil;
749         cil->xc_ctx = new_ctx;
750
751         /*
752          * The switch is now done, so we can drop the context lock and move out
753          * of a shared context. We can't just go straight to the commit record,
754          * though - we need to synchronise with previous and future commits so
755          * that the commit records are correctly ordered in the log to ensure
756          * that we process items during log IO completion in the correct order.
757          *
758          * For example, if we get an EFI in one checkpoint and the EFD in the
759          * next (e.g. due to log forces), we do not want the checkpoint with
760          * the EFD to be committed before the checkpoint with the EFI.  Hence
761          * we must strictly order the commit records of the checkpoints so
762          * that: a) the checkpoint callbacks are attached to the iclogs in the
763          * correct order; and b) the checkpoints are replayed in correct order
764          * in log recovery.
765          *
766          * Hence we need to add this context to the committing context list so
767          * that higher sequences will wait for us to write out a commit record
768          * before they do.
769          *
770          * xfs_log_force_lsn requires us to mirror the new sequence into the cil
771          * structure atomically with the addition of this sequence to the
772          * committing list. This also ensures that we can do unlocked checks
773          * against the current sequence in log forces without risking
774          * deferencing a freed context pointer.
775          */
776         spin_lock(&cil->xc_push_lock);
777         cil->xc_current_sequence = new_ctx->sequence;
778         spin_unlock(&cil->xc_push_lock);
779         up_write(&cil->xc_ctx_lock);
780
781         /*
782          * Build a checkpoint transaction header and write it to the log to
783          * begin the transaction. We need to account for the space used by the
784          * transaction header here as it is not accounted for in xlog_write().
785          *
786          * The LSN we need to pass to the log items on transaction commit is
787          * the LSN reported by the first log vector write. If we use the commit
788          * record lsn then we can move the tail beyond the grant write head.
789          */
790         tic = ctx->ticket;
791         thdr.th_magic = XFS_TRANS_HEADER_MAGIC;
792         thdr.th_type = XFS_TRANS_CHECKPOINT;
793         thdr.th_tid = tic->t_tid;
794         thdr.th_num_items = num_iovecs;
795         lhdr.i_addr = &thdr;
796         lhdr.i_len = sizeof(xfs_trans_header_t);
797         lhdr.i_type = XLOG_REG_TYPE_TRANSHDR;
798         tic->t_curr_res -= lhdr.i_len + sizeof(xlog_op_header_t);
799
800         lvhdr.lv_niovecs = 1;
801         lvhdr.lv_iovecp = &lhdr;
802         lvhdr.lv_next = ctx->lv_chain;
803
804         error = xlog_write(log, &lvhdr, tic, &ctx->start_lsn, NULL, 0);
805         if (error)
806                 goto out_abort_free_ticket;
807
808         /*
809          * now that we've written the checkpoint into the log, strictly
810          * order the commit records so replay will get them in the right order.
811          */
812 restart:
813         spin_lock(&cil->xc_push_lock);
814         list_for_each_entry(new_ctx, &cil->xc_committing, committing) {
815                 /*
816                  * Avoid getting stuck in this loop because we were woken by the
817                  * shutdown, but then went back to sleep once already in the
818                  * shutdown state.
819                  */
820                 if (XLOG_FORCED_SHUTDOWN(log)) {
821                         spin_unlock(&cil->xc_push_lock);
822                         goto out_abort_free_ticket;
823                 }
824
825                 /*
826                  * Higher sequences will wait for this one so skip them.
827                  * Don't wait for our own sequence, either.
828                  */
829                 if (new_ctx->sequence >= ctx->sequence)
830                         continue;
831                 if (!new_ctx->commit_lsn) {
832                         /*
833                          * It is still being pushed! Wait for the push to
834                          * complete, then start again from the beginning.
835                          */
836                         xlog_wait(&cil->xc_commit_wait, &cil->xc_push_lock);
837                         goto restart;
838                 }
839         }
840         spin_unlock(&cil->xc_push_lock);
841
842         /* xfs_log_done always frees the ticket on error. */
843         commit_lsn = xfs_log_done(log->l_mp, tic, &commit_iclog, false);
844         if (commit_lsn == -1)
845                 goto out_abort;
846
847         /* attach all the transactions w/ busy extents to iclog */
848         ctx->log_cb.cb_func = xlog_cil_committed;
849         ctx->log_cb.cb_arg = ctx;
850         error = xfs_log_notify(log->l_mp, commit_iclog, &ctx->log_cb);
851         if (error)
852                 goto out_abort;
853
854         /*
855          * now the checkpoint commit is complete and we've attached the
856          * callbacks to the iclog we can assign the commit LSN to the context
857          * and wake up anyone who is waiting for the commit to complete.
858          */
859         spin_lock(&cil->xc_push_lock);
860         ctx->commit_lsn = commit_lsn;
861         wake_up_all(&cil->xc_commit_wait);
862         spin_unlock(&cil->xc_push_lock);
863
864         /* release the hounds! */
865         return xfs_log_release_iclog(log->l_mp, commit_iclog);
866
867 out_skip:
868         up_write(&cil->xc_ctx_lock);
869         xfs_log_ticket_put(new_ctx->ticket);
870         kmem_free(new_ctx);
871         return 0;
872
873 out_abort_free_ticket:
874         xfs_log_ticket_put(tic);
875 out_abort:
876         xlog_cil_committed(ctx, XFS_LI_ABORTED);
877         return -EIO;
878 }
879
880 static void
881 xlog_cil_push_work(
882         struct work_struct      *work)
883 {
884         struct xfs_cil          *cil = container_of(work, struct xfs_cil,
885                                                         xc_push_work);
886         xlog_cil_push(cil->xc_log);
887 }
888
889 /*
890  * We need to push CIL every so often so we don't cache more than we can fit in
891  * the log. The limit really is that a checkpoint can't be more than half the
892  * log (the current checkpoint is not allowed to overwrite the previous
893  * checkpoint), but commit latency and memory usage limit this to a smaller
894  * size.
895  */
896 static void
897 xlog_cil_push_background(
898         struct xlog     *log)
899 {
900         struct xfs_cil  *cil = log->l_cilp;
901
902         /*
903          * The cil won't be empty because we are called while holding the
904          * context lock so whatever we added to the CIL will still be there
905          */
906         ASSERT(!list_empty(&cil->xc_cil));
907
908         /*
909          * don't do a background push if we haven't used up all the
910          * space available yet.
911          */
912         if (cil->xc_ctx->space_used < XLOG_CIL_SPACE_LIMIT(log))
913                 return;
914
915         spin_lock(&cil->xc_push_lock);
916         if (cil->xc_push_seq < cil->xc_current_sequence) {
917                 cil->xc_push_seq = cil->xc_current_sequence;
918                 queue_work(log->l_mp->m_cil_workqueue, &cil->xc_push_work);
919         }
920         spin_unlock(&cil->xc_push_lock);
921
922 }
923
924 /*
925  * xlog_cil_push_now() is used to trigger an immediate CIL push to the sequence
926  * number that is passed. When it returns, the work will be queued for
927  * @push_seq, but it won't be completed. The caller is expected to do any
928  * waiting for push_seq to complete if it is required.
929  */
930 static void
931 xlog_cil_push_now(
932         struct xlog     *log,
933         xfs_lsn_t       push_seq)
934 {
935         struct xfs_cil  *cil = log->l_cilp;
936
937         if (!cil)
938                 return;
939
940         ASSERT(push_seq && push_seq <= cil->xc_current_sequence);
941
942         /* start on any pending background push to minimise wait time on it */
943         flush_work(&cil->xc_push_work);
944
945         /*
946          * If the CIL is empty or we've already pushed the sequence then
947          * there's no work we need to do.
948          */
949         spin_lock(&cil->xc_push_lock);
950         if (list_empty(&cil->xc_cil) || push_seq <= cil->xc_push_seq) {
951                 spin_unlock(&cil->xc_push_lock);
952                 return;
953         }
954
955         cil->xc_push_seq = push_seq;
956         queue_work(log->l_mp->m_cil_workqueue, &cil->xc_push_work);
957         spin_unlock(&cil->xc_push_lock);
958 }
959
960 bool
961 xlog_cil_empty(
962         struct xlog     *log)
963 {
964         struct xfs_cil  *cil = log->l_cilp;
965         bool            empty = false;
966
967         spin_lock(&cil->xc_push_lock);
968         if (list_empty(&cil->xc_cil))
969                 empty = true;
970         spin_unlock(&cil->xc_push_lock);
971         return empty;
972 }
973
974 /*
975  * Commit a transaction with the given vector to the Committed Item List.
976  *
977  * To do this, we need to format the item, pin it in memory if required and
978  * account for the space used by the transaction. Once we have done that we
979  * need to release the unused reservation for the transaction, attach the
980  * transaction to the checkpoint context so we carry the busy extents through
981  * to checkpoint completion, and then unlock all the items in the transaction.
982  *
983  * Called with the context lock already held in read mode to lock out
984  * background commit, returns without it held once background commits are
985  * allowed again.
986  */
987 void
988 xfs_log_commit_cil(
989         struct xfs_mount        *mp,
990         struct xfs_trans        *tp,
991         xfs_lsn_t               *commit_lsn,
992         bool                    regrant)
993 {
994         struct xlog             *log = mp->m_log;
995         struct xfs_cil          *cil = log->l_cilp;
996         xfs_lsn_t               xc_commit_lsn;
997
998         /*
999          * Do all necessary memory allocation before we lock the CIL.
1000          * This ensures the allocation does not deadlock with a CIL
1001          * push in memory reclaim (e.g. from kswapd).
1002          */
1003         xlog_cil_alloc_shadow_bufs(log, tp);
1004
1005         /* lock out background commit */
1006         down_read(&cil->xc_ctx_lock);
1007
1008         xlog_cil_insert_items(log, tp);
1009
1010         xc_commit_lsn = cil->xc_ctx->sequence;
1011         if (commit_lsn)
1012                 *commit_lsn = xc_commit_lsn;
1013
1014         xfs_log_done(mp, tp->t_ticket, NULL, regrant);
1015         xfs_trans_unreserve_and_mod_sb(tp);
1016
1017         /*
1018          * Once all the items of the transaction have been copied to the CIL,
1019          * the items can be unlocked and freed.
1020          *
1021          * This needs to be done before we drop the CIL context lock because we
1022          * have to update state in the log items and unlock them before they go
1023          * to disk. If we don't, then the CIL checkpoint can race with us and
1024          * we can run checkpoint completion before we've updated and unlocked
1025          * the log items. This affects (at least) processing of stale buffers,
1026          * inodes and EFIs.
1027          */
1028         xfs_trans_free_items(tp, xc_commit_lsn, false);
1029
1030         xlog_cil_push_background(log);
1031
1032         up_read(&cil->xc_ctx_lock);
1033 }
1034
1035 /*
1036  * Conditionally push the CIL based on the sequence passed in.
1037  *
1038  * We only need to push if we haven't already pushed the sequence
1039  * number given. Hence the only time we will trigger a push here is
1040  * if the push sequence is the same as the current context.
1041  *
1042  * We return the current commit lsn to allow the callers to determine if a
1043  * iclog flush is necessary following this call.
1044  */
1045 xfs_lsn_t
1046 xlog_cil_force_lsn(
1047         struct xlog     *log,
1048         xfs_lsn_t       sequence)
1049 {
1050         struct xfs_cil          *cil = log->l_cilp;
1051         struct xfs_cil_ctx      *ctx;
1052         xfs_lsn_t               commit_lsn = NULLCOMMITLSN;
1053
1054         ASSERT(sequence <= cil->xc_current_sequence);
1055
1056         /*
1057          * check to see if we need to force out the current context.
1058          * xlog_cil_push() handles racing pushes for the same sequence,
1059          * so no need to deal with it here.
1060          */
1061 restart:
1062         xlog_cil_push_now(log, sequence);
1063
1064         /*
1065          * See if we can find a previous sequence still committing.
1066          * We need to wait for all previous sequence commits to complete
1067          * before allowing the force of push_seq to go ahead. Hence block
1068          * on commits for those as well.
1069          */
1070         spin_lock(&cil->xc_push_lock);
1071         list_for_each_entry(ctx, &cil->xc_committing, committing) {
1072                 /*
1073                  * Avoid getting stuck in this loop because we were woken by the
1074                  * shutdown, but then went back to sleep once already in the
1075                  * shutdown state.
1076                  */
1077                 if (XLOG_FORCED_SHUTDOWN(log))
1078                         goto out_shutdown;
1079                 if (ctx->sequence > sequence)
1080                         continue;
1081                 if (!ctx->commit_lsn) {
1082                         /*
1083                          * It is still being pushed! Wait for the push to
1084                          * complete, then start again from the beginning.
1085                          */
1086                         xlog_wait(&cil->xc_commit_wait, &cil->xc_push_lock);
1087                         goto restart;
1088                 }
1089                 if (ctx->sequence != sequence)
1090                         continue;
1091                 /* found it! */
1092                 commit_lsn = ctx->commit_lsn;
1093         }
1094
1095         /*
1096          * The call to xlog_cil_push_now() executes the push in the background.
1097          * Hence by the time we have got here it our sequence may not have been
1098          * pushed yet. This is true if the current sequence still matches the
1099          * push sequence after the above wait loop and the CIL still contains
1100          * dirty objects. This is guaranteed by the push code first adding the
1101          * context to the committing list before emptying the CIL.
1102          *
1103          * Hence if we don't find the context in the committing list and the
1104          * current sequence number is unchanged then the CIL contents are
1105          * significant.  If the CIL is empty, if means there was nothing to push
1106          * and that means there is nothing to wait for. If the CIL is not empty,
1107          * it means we haven't yet started the push, because if it had started
1108          * we would have found the context on the committing list.
1109          */
1110         if (sequence == cil->xc_current_sequence &&
1111             !list_empty(&cil->xc_cil)) {
1112                 spin_unlock(&cil->xc_push_lock);
1113                 goto restart;
1114         }
1115
1116         spin_unlock(&cil->xc_push_lock);
1117         return commit_lsn;
1118
1119         /*
1120          * We detected a shutdown in progress. We need to trigger the log force
1121          * to pass through it's iclog state machine error handling, even though
1122          * we are already in a shutdown state. Hence we can't return
1123          * NULLCOMMITLSN here as that has special meaning to log forces (i.e.
1124          * LSN is already stable), so we return a zero LSN instead.
1125          */
1126 out_shutdown:
1127         spin_unlock(&cil->xc_push_lock);
1128         return 0;
1129 }
1130
1131 /*
1132  * Check if the current log item was first committed in this sequence.
1133  * We can't rely on just the log item being in the CIL, we have to check
1134  * the recorded commit sequence number.
1135  *
1136  * Note: for this to be used in a non-racy manner, it has to be called with
1137  * CIL flushing locked out. As a result, it should only be used during the
1138  * transaction commit process when deciding what to format into the item.
1139  */
1140 bool
1141 xfs_log_item_in_current_chkpt(
1142         struct xfs_log_item *lip)
1143 {
1144         struct xfs_cil_ctx *ctx;
1145
1146         if (list_empty(&lip->li_cil))
1147                 return false;
1148
1149         ctx = lip->li_mountp->m_log->l_cilp->xc_ctx;
1150
1151         /*
1152          * li_seq is written on the first commit of a log item to record the
1153          * first checkpoint it is written to. Hence if it is different to the
1154          * current sequence, we're in a new checkpoint.
1155          */
1156         if (XFS_LSN_CMP(lip->li_seq, ctx->sequence) != 0)
1157                 return false;
1158         return true;
1159 }
1160
1161 /*
1162  * Perform initial CIL structure initialisation.
1163  */
1164 int
1165 xlog_cil_init(
1166         struct xlog     *log)
1167 {
1168         struct xfs_cil  *cil;
1169         struct xfs_cil_ctx *ctx;
1170
1171         cil = kmem_zalloc(sizeof(*cil), KM_SLEEP|KM_MAYFAIL);
1172         if (!cil)
1173                 return -ENOMEM;
1174
1175         ctx = kmem_zalloc(sizeof(*ctx), KM_SLEEP|KM_MAYFAIL);
1176         if (!ctx) {
1177                 kmem_free(cil);
1178                 return -ENOMEM;
1179         }
1180
1181         INIT_WORK(&cil->xc_push_work, xlog_cil_push_work);
1182         INIT_LIST_HEAD(&cil->xc_cil);
1183         INIT_LIST_HEAD(&cil->xc_committing);
1184         spin_lock_init(&cil->xc_cil_lock);
1185         spin_lock_init(&cil->xc_push_lock);
1186         init_rwsem(&cil->xc_ctx_lock);
1187         init_waitqueue_head(&cil->xc_commit_wait);
1188
1189         INIT_LIST_HEAD(&ctx->committing);
1190         INIT_LIST_HEAD(&ctx->busy_extents);
1191         ctx->sequence = 1;
1192         ctx->cil = cil;
1193         cil->xc_ctx = ctx;
1194         cil->xc_current_sequence = ctx->sequence;
1195
1196         cil->xc_log = log;
1197         log->l_cilp = cil;
1198         return 0;
1199 }
1200
1201 void
1202 xlog_cil_destroy(
1203         struct xlog     *log)
1204 {
1205         if (log->l_cilp->xc_ctx) {
1206                 if (log->l_cilp->xc_ctx->ticket)
1207                         xfs_log_ticket_put(log->l_cilp->xc_ctx->ticket);
1208                 kmem_free(log->l_cilp->xc_ctx);
1209         }
1210
1211         ASSERT(list_empty(&log->l_cilp->xc_cil));
1212         kmem_free(log->l_cilp);
1213 }
1214