Merge commit 'alsa/master' into for-linus
[linux-2.6] / fs / jbd / revoke.c
1 /*
2  * linux/fs/jbd/revoke.c
3  *
4  * Written by Stephen C. Tweedie <sct@redhat.com>, 2000
5  *
6  * Copyright 2000 Red Hat corp --- All Rights Reserved
7  *
8  * This file is part of the Linux kernel and is made available under
9  * the terms of the GNU General Public License, version 2, or at your
10  * option, any later version, incorporated herein by reference.
11  *
12  * Journal revoke routines for the generic filesystem journaling code;
13  * part of the ext2fs journaling system.
14  *
15  * Revoke is the mechanism used to prevent old log records for deleted
16  * metadata from being replayed on top of newer data using the same
17  * blocks.  The revoke mechanism is used in two separate places:
18  *
19  * + Commit: during commit we write the entire list of the current
20  *   transaction's revoked blocks to the journal
21  *
22  * + Recovery: during recovery we record the transaction ID of all
23  *   revoked blocks.  If there are multiple revoke records in the log
24  *   for a single block, only the last one counts, and if there is a log
25  *   entry for a block beyond the last revoke, then that log entry still
26  *   gets replayed.
27  *
28  * We can get interactions between revokes and new log data within a
29  * single transaction:
30  *
31  * Block is revoked and then journaled:
32  *   The desired end result is the journaling of the new block, so we
33  *   cancel the revoke before the transaction commits.
34  *
35  * Block is journaled and then revoked:
36  *   The revoke must take precedence over the write of the block, so we
37  *   need either to cancel the journal entry or to write the revoke
38  *   later in the log than the log block.  In this case, we choose the
39  *   latter: journaling a block cancels any revoke record for that block
40  *   in the current transaction, so any revoke for that block in the
41  *   transaction must have happened after the block was journaled and so
42  *   the revoke must take precedence.
43  *
44  * Block is revoked and then written as data:
45  *   The data write is allowed to succeed, but the revoke is _not_
46  *   cancelled.  We still need to prevent old log records from
47  *   overwriting the new data.  We don't even need to clear the revoke
48  *   bit here.
49  *
50  * Revoke information on buffers is a tri-state value:
51  *
52  * RevokeValid clear:   no cached revoke status, need to look it up
53  * RevokeValid set, Revoked clear:
54  *                      buffer has not been revoked, and cancel_revoke
55  *                      need do nothing.
56  * RevokeValid set, Revoked set:
57  *                      buffer has been revoked.
58  *
59  * Locking rules:
60  * We keep two hash tables of revoke records. One hashtable belongs to the
61  * running transaction (is pointed to by journal->j_revoke), the other one
62  * belongs to the committing transaction. Accesses to the second hash table
63  * happen only from the kjournald and no other thread touches this table.  Also
64  * journal_switch_revoke_table() which switches which hashtable belongs to the
65  * running and which to the committing transaction is called only from
66  * kjournald. Therefore we need no locks when accessing the hashtable belonging
67  * to the committing transaction.
68  *
69  * All users operating on the hash table belonging to the running transaction
70  * have a handle to the transaction. Therefore they are safe from kjournald
71  * switching hash tables under them. For operations on the lists of entries in
72  * the hash table j_revoke_lock is used.
73  *
74  * Finally, also replay code uses the hash tables but at this moment noone else
75  * can touch them (filesystem isn't mounted yet) and hence no locking is
76  * needed.
77  */
78
79 #ifndef __KERNEL__
80 #include "jfs_user.h"
81 #else
82 #include <linux/time.h>
83 #include <linux/fs.h>
84 #include <linux/jbd.h>
85 #include <linux/errno.h>
86 #include <linux/slab.h>
87 #include <linux/list.h>
88 #include <linux/init.h>
89 #endif
90 #include <linux/log2.h>
91
92 static struct kmem_cache *revoke_record_cache;
93 static struct kmem_cache *revoke_table_cache;
94
95 /* Each revoke record represents one single revoked block.  During
96    journal replay, this involves recording the transaction ID of the
97    last transaction to revoke this block. */
98
99 struct jbd_revoke_record_s
100 {
101         struct list_head  hash;
102         tid_t             sequence;     /* Used for recovery only */
103         unsigned long     blocknr;
104 };
105
106
107 /* The revoke table is just a simple hash table of revoke records. */
108 struct jbd_revoke_table_s
109 {
110         /* It is conceivable that we might want a larger hash table
111          * for recovery.  Must be a power of two. */
112         int               hash_size;
113         int               hash_shift;
114         struct list_head *hash_table;
115 };
116
117
118 #ifdef __KERNEL__
119 static void write_one_revoke_record(journal_t *, transaction_t *,
120                                     struct journal_head **, int *,
121                                     struct jbd_revoke_record_s *);
122 static void flush_descriptor(journal_t *, struct journal_head *, int);
123 #endif
124
125 /* Utility functions to maintain the revoke table */
126
127 /* Borrowed from buffer.c: this is a tried and tested block hash function */
128 static inline int hash(journal_t *journal, unsigned long block)
129 {
130         struct jbd_revoke_table_s *table = journal->j_revoke;
131         int hash_shift = table->hash_shift;
132
133         return ((block << (hash_shift - 6)) ^
134                 (block >> 13) ^
135                 (block << (hash_shift - 12))) & (table->hash_size - 1);
136 }
137
138 static int insert_revoke_hash(journal_t *journal, unsigned long blocknr,
139                               tid_t seq)
140 {
141         struct list_head *hash_list;
142         struct jbd_revoke_record_s *record;
143
144 repeat:
145         record = kmem_cache_alloc(revoke_record_cache, GFP_NOFS);
146         if (!record)
147                 goto oom;
148
149         record->sequence = seq;
150         record->blocknr = blocknr;
151         hash_list = &journal->j_revoke->hash_table[hash(journal, blocknr)];
152         spin_lock(&journal->j_revoke_lock);
153         list_add(&record->hash, hash_list);
154         spin_unlock(&journal->j_revoke_lock);
155         return 0;
156
157 oom:
158         if (!journal_oom_retry)
159                 return -ENOMEM;
160         jbd_debug(1, "ENOMEM in %s, retrying\n", __func__);
161         yield();
162         goto repeat;
163 }
164
165 /* Find a revoke record in the journal's hash table. */
166
167 static struct jbd_revoke_record_s *find_revoke_record(journal_t *journal,
168                                                       unsigned long blocknr)
169 {
170         struct list_head *hash_list;
171         struct jbd_revoke_record_s *record;
172
173         hash_list = &journal->j_revoke->hash_table[hash(journal, blocknr)];
174
175         spin_lock(&journal->j_revoke_lock);
176         record = (struct jbd_revoke_record_s *) hash_list->next;
177         while (&(record->hash) != hash_list) {
178                 if (record->blocknr == blocknr) {
179                         spin_unlock(&journal->j_revoke_lock);
180                         return record;
181                 }
182                 record = (struct jbd_revoke_record_s *) record->hash.next;
183         }
184         spin_unlock(&journal->j_revoke_lock);
185         return NULL;
186 }
187
188 void journal_destroy_revoke_caches(void)
189 {
190         if (revoke_record_cache) {
191                 kmem_cache_destroy(revoke_record_cache);
192                 revoke_record_cache = NULL;
193         }
194         if (revoke_table_cache) {
195                 kmem_cache_destroy(revoke_table_cache);
196                 revoke_table_cache = NULL;
197         }
198 }
199
200 int __init journal_init_revoke_caches(void)
201 {
202         J_ASSERT(!revoke_record_cache);
203         J_ASSERT(!revoke_table_cache);
204
205         revoke_record_cache = kmem_cache_create("revoke_record",
206                                            sizeof(struct jbd_revoke_record_s),
207                                            0,
208                                            SLAB_HWCACHE_ALIGN|SLAB_TEMPORARY,
209                                            NULL);
210         if (!revoke_record_cache)
211                 goto record_cache_failure;
212
213         revoke_table_cache = kmem_cache_create("revoke_table",
214                                            sizeof(struct jbd_revoke_table_s),
215                                            0, SLAB_TEMPORARY, NULL);
216         if (!revoke_table_cache)
217                 goto table_cache_failure;
218
219         return 0;
220
221 table_cache_failure:
222         journal_destroy_revoke_caches();
223 record_cache_failure:
224         return -ENOMEM;
225 }
226
227 static struct jbd_revoke_table_s *journal_init_revoke_table(int hash_size)
228 {
229         int shift = 0;
230         int tmp = hash_size;
231         struct jbd_revoke_table_s *table;
232
233         table = kmem_cache_alloc(revoke_table_cache, GFP_KERNEL);
234         if (!table)
235                 goto out;
236
237         while((tmp >>= 1UL) != 0UL)
238                 shift++;
239
240         table->hash_size = hash_size;
241         table->hash_shift = shift;
242         table->hash_table =
243                 kmalloc(hash_size * sizeof(struct list_head), GFP_KERNEL);
244         if (!table->hash_table) {
245                 kmem_cache_free(revoke_table_cache, table);
246                 table = NULL;
247                 goto out;
248         }
249
250         for (tmp = 0; tmp < hash_size; tmp++)
251                 INIT_LIST_HEAD(&table->hash_table[tmp]);
252
253 out:
254         return table;
255 }
256
257 static void journal_destroy_revoke_table(struct jbd_revoke_table_s *table)
258 {
259         int i;
260         struct list_head *hash_list;
261
262         for (i = 0; i < table->hash_size; i++) {
263                 hash_list = &table->hash_table[i];
264                 J_ASSERT(list_empty(hash_list));
265         }
266
267         kfree(table->hash_table);
268         kmem_cache_free(revoke_table_cache, table);
269 }
270
271 /* Initialise the revoke table for a given journal to a given size. */
272 int journal_init_revoke(journal_t *journal, int hash_size)
273 {
274         J_ASSERT(journal->j_revoke_table[0] == NULL);
275         J_ASSERT(is_power_of_2(hash_size));
276
277         journal->j_revoke_table[0] = journal_init_revoke_table(hash_size);
278         if (!journal->j_revoke_table[0])
279                 goto fail0;
280
281         journal->j_revoke_table[1] = journal_init_revoke_table(hash_size);
282         if (!journal->j_revoke_table[1])
283                 goto fail1;
284
285         journal->j_revoke = journal->j_revoke_table[1];
286
287         spin_lock_init(&journal->j_revoke_lock);
288
289         return 0;
290
291 fail1:
292         journal_destroy_revoke_table(journal->j_revoke_table[0]);
293 fail0:
294         return -ENOMEM;
295 }
296
297 /* Destroy a journal's revoke table.  The table must already be empty! */
298 void journal_destroy_revoke(journal_t *journal)
299 {
300         journal->j_revoke = NULL;
301         if (journal->j_revoke_table[0])
302                 journal_destroy_revoke_table(journal->j_revoke_table[0]);
303         if (journal->j_revoke_table[1])
304                 journal_destroy_revoke_table(journal->j_revoke_table[1]);
305 }
306
307
308 #ifdef __KERNEL__
309
310 /*
311  * journal_revoke: revoke a given buffer_head from the journal.  This
312  * prevents the block from being replayed during recovery if we take a
313  * crash after this current transaction commits.  Any subsequent
314  * metadata writes of the buffer in this transaction cancel the
315  * revoke.
316  *
317  * Note that this call may block --- it is up to the caller to make
318  * sure that there are no further calls to journal_write_metadata
319  * before the revoke is complete.  In ext3, this implies calling the
320  * revoke before clearing the block bitmap when we are deleting
321  * metadata.
322  *
323  * Revoke performs a journal_forget on any buffer_head passed in as a
324  * parameter, but does _not_ forget the buffer_head if the bh was only
325  * found implicitly.
326  *
327  * bh_in may not be a journalled buffer - it may have come off
328  * the hash tables without an attached journal_head.
329  *
330  * If bh_in is non-zero, journal_revoke() will decrement its b_count
331  * by one.
332  */
333
334 int journal_revoke(handle_t *handle, unsigned long blocknr,
335                    struct buffer_head *bh_in)
336 {
337         struct buffer_head *bh = NULL;
338         journal_t *journal;
339         struct block_device *bdev;
340         int err;
341
342         might_sleep();
343         if (bh_in)
344                 BUFFER_TRACE(bh_in, "enter");
345
346         journal = handle->h_transaction->t_journal;
347         if (!journal_set_features(journal, 0, 0, JFS_FEATURE_INCOMPAT_REVOKE)){
348                 J_ASSERT (!"Cannot set revoke feature!");
349                 return -EINVAL;
350         }
351
352         bdev = journal->j_fs_dev;
353         bh = bh_in;
354
355         if (!bh) {
356                 bh = __find_get_block(bdev, blocknr, journal->j_blocksize);
357                 if (bh)
358                         BUFFER_TRACE(bh, "found on hash");
359         }
360 #ifdef JBD_EXPENSIVE_CHECKING
361         else {
362                 struct buffer_head *bh2;
363
364                 /* If there is a different buffer_head lying around in
365                  * memory anywhere... */
366                 bh2 = __find_get_block(bdev, blocknr, journal->j_blocksize);
367                 if (bh2) {
368                         /* ... and it has RevokeValid status... */
369                         if (bh2 != bh && buffer_revokevalid(bh2))
370                                 /* ...then it better be revoked too,
371                                  * since it's illegal to create a revoke
372                                  * record against a buffer_head which is
373                                  * not marked revoked --- that would
374                                  * risk missing a subsequent revoke
375                                  * cancel. */
376                                 J_ASSERT_BH(bh2, buffer_revoked(bh2));
377                         put_bh(bh2);
378                 }
379         }
380 #endif
381
382         /* We really ought not ever to revoke twice in a row without
383            first having the revoke cancelled: it's illegal to free a
384            block twice without allocating it in between! */
385         if (bh) {
386                 if (!J_EXPECT_BH(bh, !buffer_revoked(bh),
387                                  "inconsistent data on disk")) {
388                         if (!bh_in)
389                                 brelse(bh);
390                         return -EIO;
391                 }
392                 set_buffer_revoked(bh);
393                 set_buffer_revokevalid(bh);
394                 if (bh_in) {
395                         BUFFER_TRACE(bh_in, "call journal_forget");
396                         journal_forget(handle, bh_in);
397                 } else {
398                         BUFFER_TRACE(bh, "call brelse");
399                         __brelse(bh);
400                 }
401         }
402
403         jbd_debug(2, "insert revoke for block %lu, bh_in=%p\n", blocknr, bh_in);
404         err = insert_revoke_hash(journal, blocknr,
405                                 handle->h_transaction->t_tid);
406         BUFFER_TRACE(bh_in, "exit");
407         return err;
408 }
409
410 /*
411  * Cancel an outstanding revoke.  For use only internally by the
412  * journaling code (called from journal_get_write_access).
413  *
414  * We trust buffer_revoked() on the buffer if the buffer is already
415  * being journaled: if there is no revoke pending on the buffer, then we
416  * don't do anything here.
417  *
418  * This would break if it were possible for a buffer to be revoked and
419  * discarded, and then reallocated within the same transaction.  In such
420  * a case we would have lost the revoked bit, but when we arrived here
421  * the second time we would still have a pending revoke to cancel.  So,
422  * do not trust the Revoked bit on buffers unless RevokeValid is also
423  * set.
424  */
425 int journal_cancel_revoke(handle_t *handle, struct journal_head *jh)
426 {
427         struct jbd_revoke_record_s *record;
428         journal_t *journal = handle->h_transaction->t_journal;
429         int need_cancel;
430         int did_revoke = 0;     /* akpm: debug */
431         struct buffer_head *bh = jh2bh(jh);
432
433         jbd_debug(4, "journal_head %p, cancelling revoke\n", jh);
434
435         /* Is the existing Revoke bit valid?  If so, we trust it, and
436          * only perform the full cancel if the revoke bit is set.  If
437          * not, we can't trust the revoke bit, and we need to do the
438          * full search for a revoke record. */
439         if (test_set_buffer_revokevalid(bh)) {
440                 need_cancel = test_clear_buffer_revoked(bh);
441         } else {
442                 need_cancel = 1;
443                 clear_buffer_revoked(bh);
444         }
445
446         if (need_cancel) {
447                 record = find_revoke_record(journal, bh->b_blocknr);
448                 if (record) {
449                         jbd_debug(4, "cancelled existing revoke on "
450                                   "blocknr %llu\n", (unsigned long long)bh->b_blocknr);
451                         spin_lock(&journal->j_revoke_lock);
452                         list_del(&record->hash);
453                         spin_unlock(&journal->j_revoke_lock);
454                         kmem_cache_free(revoke_record_cache, record);
455                         did_revoke = 1;
456                 }
457         }
458
459 #ifdef JBD_EXPENSIVE_CHECKING
460         /* There better not be one left behind by now! */
461         record = find_revoke_record(journal, bh->b_blocknr);
462         J_ASSERT_JH(jh, record == NULL);
463 #endif
464
465         /* Finally, have we just cleared revoke on an unhashed
466          * buffer_head?  If so, we'd better make sure we clear the
467          * revoked status on any hashed alias too, otherwise the revoke
468          * state machine will get very upset later on. */
469         if (need_cancel) {
470                 struct buffer_head *bh2;
471                 bh2 = __find_get_block(bh->b_bdev, bh->b_blocknr, bh->b_size);
472                 if (bh2) {
473                         if (bh2 != bh)
474                                 clear_buffer_revoked(bh2);
475                         __brelse(bh2);
476                 }
477         }
478         return did_revoke;
479 }
480
481 /* journal_switch_revoke table select j_revoke for next transaction
482  * we do not want to suspend any processing until all revokes are
483  * written -bzzz
484  */
485 void journal_switch_revoke_table(journal_t *journal)
486 {
487         int i;
488
489         if (journal->j_revoke == journal->j_revoke_table[0])
490                 journal->j_revoke = journal->j_revoke_table[1];
491         else
492                 journal->j_revoke = journal->j_revoke_table[0];
493
494         for (i = 0; i < journal->j_revoke->hash_size; i++)
495                 INIT_LIST_HEAD(&journal->j_revoke->hash_table[i]);
496 }
497
498 /*
499  * Write revoke records to the journal for all entries in the current
500  * revoke hash, deleting the entries as we go.
501  */
502 void journal_write_revoke_records(journal_t *journal,
503                                   transaction_t *transaction)
504 {
505         struct journal_head *descriptor;
506         struct jbd_revoke_record_s *record;
507         struct jbd_revoke_table_s *revoke;
508         struct list_head *hash_list;
509         int i, offset, count;
510
511         descriptor = NULL;
512         offset = 0;
513         count = 0;
514
515         /* select revoke table for committing transaction */
516         revoke = journal->j_revoke == journal->j_revoke_table[0] ?
517                 journal->j_revoke_table[1] : journal->j_revoke_table[0];
518
519         for (i = 0; i < revoke->hash_size; i++) {
520                 hash_list = &revoke->hash_table[i];
521
522                 while (!list_empty(hash_list)) {
523                         record = (struct jbd_revoke_record_s *)
524                                 hash_list->next;
525                         write_one_revoke_record(journal, transaction,
526                                                 &descriptor, &offset,
527                                                 record);
528                         count++;
529                         list_del(&record->hash);
530                         kmem_cache_free(revoke_record_cache, record);
531                 }
532         }
533         if (descriptor)
534                 flush_descriptor(journal, descriptor, offset);
535         jbd_debug(1, "Wrote %d revoke records\n", count);
536 }
537
538 /*
539  * Write out one revoke record.  We need to create a new descriptor
540  * block if the old one is full or if we have not already created one.
541  */
542
543 static void write_one_revoke_record(journal_t *journal,
544                                     transaction_t *transaction,
545                                     struct journal_head **descriptorp,
546                                     int *offsetp,
547                                     struct jbd_revoke_record_s *record)
548 {
549         struct journal_head *descriptor;
550         int offset;
551         journal_header_t *header;
552
553         /* If we are already aborting, this all becomes a noop.  We
554            still need to go round the loop in
555            journal_write_revoke_records in order to free all of the
556            revoke records: only the IO to the journal is omitted. */
557         if (is_journal_aborted(journal))
558                 return;
559
560         descriptor = *descriptorp;
561         offset = *offsetp;
562
563         /* Make sure we have a descriptor with space left for the record */
564         if (descriptor) {
565                 if (offset == journal->j_blocksize) {
566                         flush_descriptor(journal, descriptor, offset);
567                         descriptor = NULL;
568                 }
569         }
570
571         if (!descriptor) {
572                 descriptor = journal_get_descriptor_buffer(journal);
573                 if (!descriptor)
574                         return;
575                 header = (journal_header_t *) &jh2bh(descriptor)->b_data[0];
576                 header->h_magic     = cpu_to_be32(JFS_MAGIC_NUMBER);
577                 header->h_blocktype = cpu_to_be32(JFS_REVOKE_BLOCK);
578                 header->h_sequence  = cpu_to_be32(transaction->t_tid);
579
580                 /* Record it so that we can wait for IO completion later */
581                 JBUFFER_TRACE(descriptor, "file as BJ_LogCtl");
582                 journal_file_buffer(descriptor, transaction, BJ_LogCtl);
583
584                 offset = sizeof(journal_revoke_header_t);
585                 *descriptorp = descriptor;
586         }
587
588         * ((__be32 *)(&jh2bh(descriptor)->b_data[offset])) =
589                 cpu_to_be32(record->blocknr);
590         offset += 4;
591         *offsetp = offset;
592 }
593
594 /*
595  * Flush a revoke descriptor out to the journal.  If we are aborting,
596  * this is a noop; otherwise we are generating a buffer which needs to
597  * be waited for during commit, so it has to go onto the appropriate
598  * journal buffer list.
599  */
600
601 static void flush_descriptor(journal_t *journal,
602                              struct journal_head *descriptor,
603                              int offset)
604 {
605         journal_revoke_header_t *header;
606         struct buffer_head *bh = jh2bh(descriptor);
607
608         if (is_journal_aborted(journal)) {
609                 put_bh(bh);
610                 return;
611         }
612
613         header = (journal_revoke_header_t *) jh2bh(descriptor)->b_data;
614         header->r_count = cpu_to_be32(offset);
615         set_buffer_jwrite(bh);
616         BUFFER_TRACE(bh, "write");
617         set_buffer_dirty(bh);
618         ll_rw_block(SWRITE, 1, &bh);
619 }
620 #endif
621
622 /*
623  * Revoke support for recovery.
624  *
625  * Recovery needs to be able to:
626  *
627  *  record all revoke records, including the tid of the latest instance
628  *  of each revoke in the journal
629  *
630  *  check whether a given block in a given transaction should be replayed
631  *  (ie. has not been revoked by a revoke record in that or a subsequent
632  *  transaction)
633  *
634  *  empty the revoke table after recovery.
635  */
636
637 /*
638  * First, setting revoke records.  We create a new revoke record for
639  * every block ever revoked in the log as we scan it for recovery, and
640  * we update the existing records if we find multiple revokes for a
641  * single block.
642  */
643
644 int journal_set_revoke(journal_t *journal,
645                        unsigned long blocknr,
646                        tid_t sequence)
647 {
648         struct jbd_revoke_record_s *record;
649
650         record = find_revoke_record(journal, blocknr);
651         if (record) {
652                 /* If we have multiple occurrences, only record the
653                  * latest sequence number in the hashed record */
654                 if (tid_gt(sequence, record->sequence))
655                         record->sequence = sequence;
656                 return 0;
657         }
658         return insert_revoke_hash(journal, blocknr, sequence);
659 }
660
661 /*
662  * Test revoke records.  For a given block referenced in the log, has
663  * that block been revoked?  A revoke record with a given transaction
664  * sequence number revokes all blocks in that transaction and earlier
665  * ones, but later transactions still need replayed.
666  */
667
668 int journal_test_revoke(journal_t *journal,
669                         unsigned long blocknr,
670                         tid_t sequence)
671 {
672         struct jbd_revoke_record_s *record;
673
674         record = find_revoke_record(journal, blocknr);
675         if (!record)
676                 return 0;
677         if (tid_gt(sequence, record->sequence))
678                 return 0;
679         return 1;
680 }
681
682 /*
683  * Finally, once recovery is over, we need to clear the revoke table so
684  * that it can be reused by the running filesystem.
685  */
686
687 void journal_clear_revoke(journal_t *journal)
688 {
689         int i;
690         struct list_head *hash_list;
691         struct jbd_revoke_record_s *record;
692         struct jbd_revoke_table_s *revoke;
693
694         revoke = journal->j_revoke;
695
696         for (i = 0; i < revoke->hash_size; i++) {
697                 hash_list = &revoke->hash_table[i];
698                 while (!list_empty(hash_list)) {
699                         record = (struct jbd_revoke_record_s*) hash_list->next;
700                         list_del(&record->hash);
701                         kmem_cache_free(revoke_record_cache, record);
702                 }
703         }
704 }