HAMMER 61B/Many: Stabilization
[dragonfly.git] / sys / vfs / hammer / hammer_flusher.c
1 /*
2  * Copyright (c) 2008 The DragonFly Project.  All rights reserved.
3  * 
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@backplane.com>
6  * 
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  * 
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  * 
34  * $DragonFly: src/sys/vfs/hammer/hammer_flusher.c,v 1.35 2008/07/11 01:22:29 dillon Exp $
35  */
36 /*
37  * HAMMER dependancy flusher thread
38  *
39  * Meta data updates create buffer dependancies which are arranged as a
40  * hierarchy of lists.
41  */
42
43 #include "hammer.h"
44
45 static void hammer_flusher_master_thread(void *arg);
46 static void hammer_flusher_slave_thread(void *arg);
47 static void hammer_flusher_flush(hammer_mount_t hmp);
48 static void hammer_flusher_flush_inode(hammer_inode_t ip,
49                                         hammer_transaction_t trans);
50
51 /*
52  * Support structures for the flusher threads.
53  */
54 struct hammer_flusher_info {
55         struct hammer_mount *hmp;
56         thread_t        td;
57         int             startit;
58         hammer_inode_t  work_array[HAMMER_FLUSH_GROUP_SIZE];
59 };
60
61 typedef struct hammer_flusher_info *hammer_flusher_info_t;
62
63 /*
64  * Sync all inodes pending on the flusher.  This routine may have to be
65  * called twice to get them all as some may be queued to a later flush group.
66  */
67 void
68 hammer_flusher_sync(hammer_mount_t hmp)
69 {
70         int seq;
71
72         if (hmp->flusher.td) {
73                 seq = hmp->flusher.next;
74                 if (hmp->flusher.signal++ == 0)
75                         wakeup(&hmp->flusher.signal);
76                 while ((int)(seq - hmp->flusher.done) > 0)
77                         tsleep(&hmp->flusher.done, 0, "hmrfls", 0);
78         }
79 }
80
81 /*
82  * Sync all inodes pending on the flusher - return immediately.
83  */
84 void
85 hammer_flusher_async(hammer_mount_t hmp)
86 {
87         if (hmp->flusher.td) {
88                 if (hmp->flusher.signal++ == 0)
89                         wakeup(&hmp->flusher.signal);
90         }
91 }
92
93 void
94 hammer_flusher_create(hammer_mount_t hmp)
95 {
96         hammer_flusher_info_t info;
97         int i;
98
99         hmp->flusher.signal = 0;
100         hmp->flusher.act = 0;
101         hmp->flusher.done = 0;
102         hmp->flusher.next = 1;
103         hmp->flusher.count = 0;
104         hammer_ref(&hmp->flusher.finalize_lock);
105
106         lwkt_create(hammer_flusher_master_thread, hmp,
107                     &hmp->flusher.td, NULL, 0, -1, "hammer-M");
108         for (i = 0; i < HAMMER_MAX_FLUSHERS; ++i) {
109                 info = kmalloc(sizeof(*info), M_HAMMER, M_WAITOK|M_ZERO);
110                 info->hmp = hmp;
111                 ++hmp->flusher.count;
112                 hmp->flusher.info[i] = info;
113                 lwkt_create(hammer_flusher_slave_thread, info,
114                             &info->td, NULL, 0, -1, "hammer-S%d", i);
115         }
116 }
117
118 void
119 hammer_flusher_destroy(hammer_mount_t hmp)
120 {
121         hammer_flusher_info_t info;
122         int i;
123
124         /*
125          * Kill the master
126          */
127         hmp->flusher.exiting = 1;
128         while (hmp->flusher.td) {
129                 ++hmp->flusher.signal;
130                 wakeup(&hmp->flusher.signal);
131                 tsleep(&hmp->flusher.exiting, 0, "hmrwex", hz);
132         }
133
134         /*
135          * Kill the slaves
136          */
137         for (i = 0; i < HAMMER_MAX_FLUSHERS; ++i) {
138                 if ((info = hmp->flusher.info[i]) != NULL) {
139                         KKASSERT(info->startit == 0);
140                         info->startit = -1;
141                         wakeup(&info->startit);
142                         while (info->td) {
143                                 tsleep(&info->td, 0, "hmrwwc", 0);
144                         }
145                         hmp->flusher.info[i] = NULL;
146                         kfree(info, M_HAMMER);
147                         --hmp->flusher.count;
148                 }
149         }
150         KKASSERT(hmp->flusher.count == 0);
151 }
152
153 /*
154  * The master flusher thread manages the flusher sequence id and
155  * synchronization with the slave work threads.
156  */
157 static void
158 hammer_flusher_master_thread(void *arg)
159 {
160         hammer_mount_t hmp = arg;
161
162         for (;;) {
163                 while (hmp->flusher.group_lock)
164                         tsleep(&hmp->flusher.group_lock, 0, "hmrhld", 0);
165                 hmp->flusher.act = hmp->flusher.next;
166                 ++hmp->flusher.next;
167                 hammer_flusher_clean_loose_ios(hmp);
168                 hammer_flusher_flush(hmp);
169                 hmp->flusher.done = hmp->flusher.act;
170                 wakeup(&hmp->flusher.done);
171
172                 /*
173                  * Wait for activity.
174                  */
175                 if (hmp->flusher.exiting && TAILQ_EMPTY(&hmp->flush_list))
176                         break;
177
178                 /*
179                  * This is a hack until we can dispose of frontend buffer
180                  * cache buffers on the frontend.
181                  */
182                 while (hmp->flusher.signal == 0)
183                         tsleep(&hmp->flusher.signal, 0, "hmrwwa", 0);
184                 hmp->flusher.signal = 0;
185         }
186
187         /*
188          * And we are done.
189          */
190         hmp->flusher.td = NULL;
191         wakeup(&hmp->flusher.exiting);
192         lwkt_exit();
193 }
194
195 /*
196  * The slave flusher thread pulls work off the master flush_list until no
197  * work is left.
198  */
199 static void
200 hammer_flusher_slave_thread(void *arg)
201 {
202         hammer_flusher_info_t info;
203         hammer_mount_t hmp;
204         hammer_inode_t ip;
205         int c;
206         int i;
207         int n;
208
209         info = arg;
210         hmp = info->hmp;
211
212         for (;;) {
213                 while (info->startit == 0)
214                         tsleep(&info->startit, 0, "hmrssw", 0);
215                 if (info->startit < 0)
216                         break;
217                 info->startit = 0;
218
219                 /*
220                  * Try to pull out around ~64 inodes at a time to flush.
221                  * The idea is to try to avoid deadlocks between the slaves.
222                  */
223                 n = c = 0;
224                 while ((ip = TAILQ_FIRST(&hmp->flush_list)) != NULL) {
225                         if (ip->flush_group != hmp->flusher.act)
226                                 break;
227                         TAILQ_REMOVE(&hmp->flush_list, ip, flush_entry);
228                         info->work_array[n++] = ip;
229                         c += ip->rsv_recs;
230                         if (n < HAMMER_FLUSH_GROUP_SIZE &&
231                             c < HAMMER_FLUSH_GROUP_SIZE * 8) {
232                                 continue;
233                         }
234                         for (i = 0; i < n; ++i){
235                                 hammer_flusher_flush_inode(info->work_array[i],
236                                                         &hmp->flusher.trans);
237                         }
238                         n = c = 0;
239                 }
240                 for (i = 0; i < n; ++i) {
241                         hammer_flusher_flush_inode(info->work_array[i],
242                                                    &hmp->flusher.trans);
243                 }
244                 if (--hmp->flusher.running == 0)
245                         wakeup(&hmp->flusher.running);
246         }
247         info->td = NULL;
248         wakeup(&info->td);
249         lwkt_exit();
250 }
251
252 void
253 hammer_flusher_clean_loose_ios(hammer_mount_t hmp)
254 {
255         hammer_buffer_t buffer;
256         hammer_io_t io;
257
258         /*
259          * loose ends - buffers without bp's aren't tracked by the kernel
260          * and can build up, so clean them out.  This can occur when an
261          * IO completes on a buffer with no references left.
262          */
263         if ((io = TAILQ_FIRST(&hmp->lose_list)) != NULL) {
264                 crit_enter();   /* biodone() race */
265                 while ((io = TAILQ_FIRST(&hmp->lose_list)) != NULL) {
266                         KKASSERT(io->mod_list == &hmp->lose_list);
267                         TAILQ_REMOVE(&hmp->lose_list, io, mod_entry);
268                         io->mod_list = NULL;
269                         if (io->lock.refs == 0)
270                                 ++hammer_count_refedbufs;
271                         hammer_ref(&io->lock);
272                         buffer = (void *)io;
273                         hammer_rel_buffer(buffer, 0);
274                 }
275                 crit_exit();
276         }
277 }
278
279 /*
280  * Flush all inodes in the current flush group.
281  */
282 static void
283 hammer_flusher_flush(hammer_mount_t hmp)
284 {
285         hammer_flusher_info_t info;
286         hammer_reserve_t resv;
287         int i;
288         int n;
289
290         hammer_start_transaction_fls(&hmp->flusher.trans, hmp);
291
292         /*
293          * If the previous flush cycle just about exhausted our UNDO space
294          * we may have to do a dummy cycle to move the first_offset up
295          * before actually digging into a new cycle, or the new cycle will
296          * not have sufficient undo space.
297          */
298         if (hammer_flusher_undo_exhausted(&hmp->flusher.trans, 3))
299                 hammer_flusher_finalize(&hmp->flusher.trans, 0);
300
301         /*
302          * Start work threads.
303          */
304         i = 0;
305         n = hmp->count_iqueued / HAMMER_FLUSH_GROUP_SIZE;
306         if (TAILQ_FIRST(&hmp->flush_list)) {
307                 for (i = 0; i <= n; ++i) {
308                         if (i == HAMMER_MAX_FLUSHERS ||
309                             hmp->flusher.info[i] == NULL) {
310                                 break;
311                         }
312                         info = hmp->flusher.info[i];
313                         if (info->startit == 0) {
314                                 ++hmp->flusher.running;
315                                 info->startit = 1;
316                                 wakeup(&info->startit);
317                         }
318                 }
319         }
320         while (hmp->flusher.running)
321                 tsleep(&hmp->flusher.running, 0, "hmrfcc", 0);
322
323         hammer_flusher_finalize(&hmp->flusher.trans, 1);
324         hmp->flusher.tid = hmp->flusher.trans.tid;
325
326         /*
327          * Clean up any freed big-blocks (typically zone-2). 
328          * resv->flush_group is typically set several flush groups ahead
329          * of the free to ensure that the freed block is not reused until
330          * it can no longer be reused.
331          */
332         while ((resv = TAILQ_FIRST(&hmp->delay_list)) != NULL) {
333                 if (resv->flush_group != hmp->flusher.act)
334                         break;
335                 hammer_reserve_clrdelay(hmp, resv);
336         }
337         hammer_done_transaction(&hmp->flusher.trans);
338 }
339
340 /*
341  * Flush a single inode that is part of a flush group.
342  *
343  * NOTE!  The sync code can return EWOULDBLOCK if the flush operation
344  * would otherwise blow out the buffer cache.  hammer_flush_inode_done()
345  * will re-queue the inode for the next flush sequence and force the
346  * flusher to run again if this occurs.
347  */
348 static
349 void
350 hammer_flusher_flush_inode(hammer_inode_t ip, hammer_transaction_t trans)
351 {
352         hammer_mount_t hmp = ip->hmp;
353         int error;
354
355         hammer_flusher_clean_loose_ios(hmp);
356         error = hammer_sync_inode(ip);
357         if (error != EWOULDBLOCK)
358                 ip->error = error;
359         hammer_flush_inode_done(ip);
360         while (hmp->flusher.finalize_want)
361                 tsleep(&hmp->flusher.finalize_want, 0, "hmrsxx", 0);
362         if (hammer_flusher_undo_exhausted(trans, 1)) {
363                 kprintf("HAMMER: Warning: UNDO area too small!\n");
364                 hammer_flusher_finalize(trans, 1);
365         } else if (hammer_flusher_meta_limit(trans->hmp)) {
366                 hammer_flusher_finalize(trans, 0);
367         }
368 }
369
370 /*
371  * Return non-zero if the UNDO area has less then (QUARTER / 4) of its
372  * space left.
373  *
374  * 1/4 - Emergency free undo space level.  Below this point the flusher
375  *       will finalize even if directory dependancies have not been resolved.
376  *
377  * 2/4 - Used by the pruning and reblocking code.  These functions may be
378  *       running in parallel with a flush and cannot be allowed to drop
379  *       available undo space to emergency levels.
380  *
381  * 3/4 - Used at the beginning of a flush to force-sync the volume header
382  *       to give the flush plenty of runway to work in.
383  */
384 int
385 hammer_flusher_undo_exhausted(hammer_transaction_t trans, int quarter)
386 {
387         if (hammer_undo_space(trans) <
388             hammer_undo_max(trans->hmp) * quarter / 4) {
389                 return(1);
390         } else {
391                 return(0);
392         }
393 }
394
395 /*
396  * Flush all pending UNDOs, wait for write completion, update the volume
397  * header with the new UNDO end position, and flush it.  Then
398  * asynchronously flush the meta-data.
399  *
400  * If this is the last finalization in a flush group we also synchronize
401  * our cached blockmap and set hmp->flusher_undo_start and our cached undo
402  * fifo first_offset so the next flush resets the FIFO pointers.
403  *
404  * If this is not final it is being called because too many dirty meta-data
405  * buffers have built up and must be flushed with UNDO synchronization to
406  * avoid a buffer cache deadlock.
407  */
408 void
409 hammer_flusher_finalize(hammer_transaction_t trans, int final)
410 {
411         hammer_volume_t root_volume;
412         hammer_blockmap_t cundomap, dundomap;
413         hammer_mount_t hmp;
414         hammer_io_t io;
415         int count;
416         int i;
417
418         hmp = trans->hmp;
419         root_volume = trans->rootvol;
420
421         /*
422          * Exclusively lock the flusher.  This guarantees that all dirty
423          * buffers will be idled (have a mod-count of 0).
424          */
425         ++hmp->flusher.finalize_want;
426         hammer_lock_ex(&hmp->flusher.finalize_lock);
427
428         /*
429          * If this isn't the final sync several threads may have hit the
430          * meta-limit at the same time and raced.  Only sync if we really
431          * have to, after acquiring the lock.
432          */
433         if (final == 0 && !hammer_flusher_meta_limit(hmp))
434                 goto done;
435
436         /*
437          * Flush data buffers.  This can occur asynchronously and at any
438          * time.  We must interlock against the frontend direct-data write
439          * but do not have to acquire the sync-lock yet.
440          */
441         count = 0;
442         while ((io = TAILQ_FIRST(&hmp->data_list)) != NULL) {
443                 if (io->lock.refs == 0)
444                         ++hammer_count_refedbufs;
445                 hammer_ref(&io->lock);
446                 hammer_io_write_interlock(io);
447                 KKASSERT(io->type != HAMMER_STRUCTURE_VOLUME);
448                 hammer_io_flush(io);
449                 hammer_io_done_interlock(io);
450                 hammer_rel_buffer((hammer_buffer_t)io, 0);
451                 ++count;
452         }
453
454         /*
455          * The sync-lock is required for the remaining sequence.  This lock
456          * prevents meta-data from being modified.
457          */
458         hammer_sync_lock_ex(trans);
459
460         /*
461          * If we have been asked to finalize the volume header sync the
462          * cached blockmap to the on-disk blockmap.  Generate an UNDO
463          * record for the update.
464          */
465         if (final) {
466                 cundomap = &hmp->blockmap[0];
467                 dundomap = &root_volume->ondisk->vol0_blockmap[0];
468                 if (root_volume->io.modified) {
469                         hammer_modify_volume(trans, root_volume,
470                                              dundomap, sizeof(hmp->blockmap));
471                         for (i = 0; i < HAMMER_MAX_ZONES; ++i)
472                                 hammer_crc_set_blockmap(&cundomap[i]);
473                         bcopy(cundomap, dundomap, sizeof(hmp->blockmap));
474                         hammer_modify_volume_done(root_volume);
475                 }
476         }
477
478         /*
479          * Flush UNDOs
480          */
481         count = 0;
482         while ((io = TAILQ_FIRST(&hmp->undo_list)) != NULL) {
483                 KKASSERT(io->modify_refs == 0);
484                 if (io->lock.refs == 0)
485                         ++hammer_count_refedbufs;
486                 hammer_ref(&io->lock);
487                 KKASSERT(io->type != HAMMER_STRUCTURE_VOLUME);
488                 hammer_io_flush(io);
489                 hammer_rel_buffer((hammer_buffer_t)io, 0);
490                 ++count;
491         }
492
493         /*
494          * Wait for I/Os to complete
495          */
496         hammer_flusher_clean_loose_ios(hmp);
497         hammer_io_wait_all(hmp, "hmrfl1");
498
499         /*
500          * Update the on-disk volume header with new UNDO FIFO end position
501          * (do not generate new UNDO records for this change).  We have to
502          * do this for the UNDO FIFO whether (final) is set or not.
503          *
504          * Also update the on-disk next_tid field.  This does not require
505          * an UNDO.  However, because our TID is generated before we get
506          * the sync lock another sync may have beat us to the punch.
507          *
508          * This also has the side effect of updating first_offset based on
509          * a prior finalization when the first finalization of the next flush
510          * cycle occurs, removing any undo info from the prior finalization
511          * from consideration.
512          *
513          * The volume header will be flushed out synchronously.
514          */
515         dundomap = &root_volume->ondisk->vol0_blockmap[HAMMER_ZONE_UNDO_INDEX];
516         cundomap = &hmp->blockmap[HAMMER_ZONE_UNDO_INDEX];
517
518         if (dundomap->first_offset != cundomap->first_offset ||
519             dundomap->next_offset != cundomap->next_offset) {
520                 hammer_modify_volume(NULL, root_volume, NULL, 0);
521                 dundomap->first_offset = cundomap->first_offset;
522                 dundomap->next_offset = cundomap->next_offset;
523                 hammer_crc_set_blockmap(dundomap);
524                 hammer_modify_volume_done(root_volume);
525         }
526
527         if (root_volume->io.modified) {
528                 hammer_modify_volume(NULL, root_volume, NULL, 0);
529                 if (root_volume->ondisk->vol0_next_tid < trans->tid)
530                         root_volume->ondisk->vol0_next_tid = trans->tid;
531                 hammer_crc_set_volume(root_volume->ondisk);
532                 hammer_modify_volume_done(root_volume);
533                 hammer_io_flush(&root_volume->io);
534         }
535
536         /*
537          * Wait for I/Os to complete
538          */
539         hammer_flusher_clean_loose_ios(hmp);
540         hammer_io_wait_all(hmp, "hmrfl2");
541
542         /*
543          * Flush meta-data.  The meta-data will be undone if we crash
544          * so we can safely flush it asynchronously.
545          *
546          * Repeated catchups will wind up flushing this update's meta-data
547          * and the UNDO buffers for the next update simultaniously.  This
548          * is ok.
549          */
550         count = 0;
551         while ((io = TAILQ_FIRST(&hmp->meta_list)) != NULL) {
552                 KKASSERT(io->modify_refs == 0);
553                 if (io->lock.refs == 0)
554                         ++hammer_count_refedbufs;
555                 hammer_ref(&io->lock);
556                 KKASSERT(io->type != HAMMER_STRUCTURE_VOLUME);
557                 hammer_io_flush(io);
558                 hammer_rel_buffer((hammer_buffer_t)io, 0);
559                 ++count;
560         }
561
562         /*
563          * If this is the final finalization for the flush group set
564          * up for the next sequence by setting a new first_offset in
565          * our cached blockmap and clearing the undo history.
566          *
567          * Even though we have updated our cached first_offset, the on-disk
568          * first_offset still governs available-undo-space calculations.
569          */
570         if (final) {
571                 cundomap = &hmp->blockmap[HAMMER_ZONE_UNDO_INDEX];
572                 cundomap->first_offset = cundomap->next_offset;
573                 hammer_clear_undo_history(hmp);
574         }
575
576         hammer_sync_unlock(trans);
577
578 done:
579         hammer_unlock(&hmp->flusher.finalize_lock);
580         if (--hmp->flusher.finalize_want == 0)
581                 wakeup(&hmp->flusher.finalize_want);
582 }
583
584 /*
585  * Return non-zero if too many dirty meta-data buffers have built up.
586  *
587  * Since we cannot allow such buffers to flush until we have dealt with
588  * the UNDOs, we risk deadlocking the kernel's buffer cache.
589  */
590 int
591 hammer_flusher_meta_limit(hammer_mount_t hmp)
592 {
593         if (hmp->locked_dirty_space + hmp->io_running_space >
594             hammer_limit_dirtybufspace) {
595                 return(1);
596         }
597         return(0);
598 }
599