2 * linux/include/linux/jbd.h
4 * Written by Stephen C. Tweedie <sct@redhat.com>
6 * Copyright 1998-2000 Red Hat, Inc --- All Rights Reserved
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.
12 * Definitions for transaction data structures for the buffer cache
13 * filesystem journaling support.
19 /* Allow this file to be included directly into e2fsprogs */
21 #include "jfs_compat.h"
23 #define jfs_debug jbd_debug
26 #include <linux/module.h>
27 #include <linux/buffer_head.h>
28 #include <linux/journal-head.h>
29 #include <linux/stddef.h>
30 #include <linux/bit_spinlock.h>
31 #include <linux/mutex.h>
32 #include <linux/timer.h>
33 #include <linux/lockdep.h>
35 #include <asm/semaphore.h>
37 #define journal_oom_retry 1
40 * Define JBD_PARANIOD_IOFAIL to cause a kernel BUG() if ext3 finds
41 * certain classes of error which can occur due to failed IOs. Under
42 * normal use we want ext3 to continue after such errors, because
43 * hardware _can_ fail, but for debugging purposes when running tests on
44 * known-good hardware we may want to trap these errors.
46 #undef JBD_PARANOID_IOFAIL
49 * The default maximum commit age, in seconds.
51 #define JBD_DEFAULT_MAX_COMMIT_AGE 5
53 #ifdef CONFIG_JBD_DEBUG
55 * Define JBD_EXPENSIVE_CHECKING to enable more expensive internal
56 * consistency checks. By default we don't do this unless
57 * CONFIG_JBD_DEBUG is on.
59 #define JBD_EXPENSIVE_CHECKING
60 extern u8 journal_enable_debug
;
62 #define jbd_debug(n, f, a...) \
64 if ((n) <= journal_enable_debug) { \
65 printk (KERN_DEBUG "(%s, %d): %s: ", \
66 __FILE__, __LINE__, __FUNCTION__); \
74 static inline void *jbd_alloc(size_t size
, gfp_t flags
)
76 return kmalloc(size
, flags
);
77 /*__get_free_pages(flags, get_order(size));*/
80 static inline void jbd_free(void *ptr
, size_t size
)
85 /* free_pages((unsigned long)ptr, get_order(size)); */
88 #define JFS_MIN_JOURNAL_BLOCKS 1024
92 * typedef handle_t - The handle_t type represents a single atomic update being performed by some process.
94 * All filesystem modifications made by the process go
95 * through this handle. Recursive operations (such as quota operations)
96 * are gathered into a single update.
98 * The buffer credits field is used to account for journaled buffers
99 * being modified by the running process. To ensure that there is
100 * enough log space for all outstanding operations, we need to limit the
101 * number of outstanding buffers possible at any time. When the
102 * operation completes, any buffer credits not used are credited back to
103 * the transaction, so that at all times we know how many buffers the
104 * outstanding updates on a transaction might possibly touch.
106 * This is an opaque datatype.
108 typedef struct handle_s handle_t
; /* Atomic operation type */
112 * typedef journal_t - The journal_t maintains all of the journaling state information for a single filesystem.
114 * journal_t is linked to from the fs superblock structure.
116 * We use the journal_t to keep track of all outstanding transaction
117 * activity on the filesystem, and to manage the state of the log
120 * This is an opaque datatype.
122 typedef struct journal_s journal_t
; /* Journal control structure */
126 * Internal structures used by the logging mechanism:
129 #define JFS_MAGIC_NUMBER 0xc03b3998U /* The first 4 bytes of /dev/random! */
136 * Descriptor block types:
139 #define JFS_DESCRIPTOR_BLOCK 1
140 #define JFS_COMMIT_BLOCK 2
141 #define JFS_SUPERBLOCK_V1 3
142 #define JFS_SUPERBLOCK_V2 4
143 #define JFS_REVOKE_BLOCK 5
146 * Standard header for all descriptor blocks:
148 typedef struct journal_header_s
157 * The block tag: used to describe a single buffer in the journal
159 typedef struct journal_block_tag_s
161 __be32 t_blocknr
; /* The on-disk block number */
162 __be32 t_flags
; /* See below */
163 } journal_block_tag_t
;
166 * The revoke descriptor: used on disk to describe a series of blocks to
167 * be revoked from the log
169 typedef struct journal_revoke_header_s
171 journal_header_t r_header
;
172 __be32 r_count
; /* Count of bytes used in the block */
173 } journal_revoke_header_t
;
176 /* Definitions for the journal tag flags word: */
177 #define JFS_FLAG_ESCAPE 1 /* on-disk block is escaped */
178 #define JFS_FLAG_SAME_UUID 2 /* block has same uuid as previous */
179 #define JFS_FLAG_DELETED 4 /* block deleted by this transaction */
180 #define JFS_FLAG_LAST_TAG 8 /* last tag in this descriptor block */
184 * The journal superblock. All fields are in big-endian byte order.
186 typedef struct journal_superblock_s
189 journal_header_t s_header
;
192 /* Static information describing the journal */
193 __be32 s_blocksize
; /* journal device blocksize */
194 __be32 s_maxlen
; /* total blocks in journal file */
195 __be32 s_first
; /* first block of log information */
198 /* Dynamic information describing the current state of the log */
199 __be32 s_sequence
; /* first commit ID expected in log */
200 __be32 s_start
; /* blocknr of start of log */
203 /* Error value, as set by journal_abort(). */
207 /* Remaining fields are only valid in a version-2 superblock */
208 __be32 s_feature_compat
; /* compatible feature set */
209 __be32 s_feature_incompat
; /* incompatible feature set */
210 __be32 s_feature_ro_compat
; /* readonly-compatible feature set */
212 __u8 s_uuid
[16]; /* 128-bit uuid for journal */
215 __be32 s_nr_users
; /* Nr of filesystems sharing log */
217 __be32 s_dynsuper
; /* Blocknr of dynamic superblock copy*/
220 __be32 s_max_transaction
; /* Limit of journal blocks per trans.*/
221 __be32 s_max_trans_data
; /* Limit of data blocks per trans. */
227 __u8 s_users
[16*48]; /* ids of all fs'es sharing the log */
229 } journal_superblock_t
;
231 #define JFS_HAS_COMPAT_FEATURE(j,mask) \
232 ((j)->j_format_version >= 2 && \
233 ((j)->j_superblock->s_feature_compat & cpu_to_be32((mask))))
234 #define JFS_HAS_RO_COMPAT_FEATURE(j,mask) \
235 ((j)->j_format_version >= 2 && \
236 ((j)->j_superblock->s_feature_ro_compat & cpu_to_be32((mask))))
237 #define JFS_HAS_INCOMPAT_FEATURE(j,mask) \
238 ((j)->j_format_version >= 2 && \
239 ((j)->j_superblock->s_feature_incompat & cpu_to_be32((mask))))
241 #define JFS_FEATURE_INCOMPAT_REVOKE 0x00000001
243 /* Features known to this kernel version: */
244 #define JFS_KNOWN_COMPAT_FEATURES 0
245 #define JFS_KNOWN_ROCOMPAT_FEATURES 0
246 #define JFS_KNOWN_INCOMPAT_FEATURES JFS_FEATURE_INCOMPAT_REVOKE
250 #include <linux/fs.h>
251 #include <linux/sched.h>
253 #define J_ASSERT ASSERT
255 #if defined(CONFIG_BUFFER_DEBUG)
256 void buffer_assertion_failure(struct buffer_head
*bh
);
257 #define J_ASSERT_BH(bh, expr) \
260 buffer_assertion_failure(bh); \
263 #define J_ASSERT_JH(jh, expr) J_ASSERT_BH(jh2bh(jh), expr)
265 #define J_ASSERT_BH(bh, expr) J_ASSERT(expr)
266 #define J_ASSERT_JH(jh, expr) J_ASSERT(expr)
269 #if defined(JBD_PARANOID_IOFAIL)
270 #define J_EXPECT(expr, why...) J_ASSERT(expr)
271 #define J_EXPECT_BH(bh, expr, why...) J_ASSERT_BH(bh, expr)
272 #define J_EXPECT_JH(jh, expr, why...) J_ASSERT_JH(jh, expr)
275 #define __journal_expect(expr, why...) \
280 "EXT3-fs unexpected failure: %s;\n",# expr); \
281 printk(KERN_ERR why "\n"); \
285 #define J_EXPECT(expr, why...) __journal_expect(expr, ## why)
286 #define J_EXPECT_BH(bh, expr, why...) __journal_expect(expr, ## why)
287 #define J_EXPECT_JH(jh, expr, why...) __journal_expect(expr, ## why)
289 #define __journal_expect
297 enum jbd_state_bits
{
298 BH_JBD
/* Has an attached ext3 journal_head */
300 BH_JWrite
, /* Being written to log (@@@ DEBUGGING) */
301 BH_Freed
, /* Has been freed (truncated) */
302 BH_Revoked
, /* Has been revoked from the log */
303 BH_RevokeValid
, /* Revoked flag is valid */
304 BH_JBDDirty
, /* Is dirty but journaled */
305 BH_State
, /* Pins most journal_head state */
306 BH_JournalHead
, /* Pins bh->b_private and jh->b_bh */
307 BH_Unshadow
, /* Dummy bit, for BJ_Shadow wakeup filtering */
311 BUFFER_FNS(JWrite
, jwrite
)
312 BUFFER_FNS(JBDDirty
, jbddirty
)
313 TAS_BUFFER_FNS(JBDDirty
, jbddirty
)
314 BUFFER_FNS(Revoked
, revoked
)
315 TAS_BUFFER_FNS(Revoked
, revoked
)
316 BUFFER_FNS(RevokeValid
, revokevalid
)
317 TAS_BUFFER_FNS(RevokeValid
, revokevalid
)
318 BUFFER_FNS(Freed
, freed
)
320 static inline struct buffer_head
*jh2bh(struct journal_head
*jh
)
325 static inline struct journal_head
*bh2jh(struct buffer_head
*bh
)
327 return bh
->b_private
;
330 static inline void jbd_lock_bh_state(struct buffer_head
*bh
)
332 bit_spin_lock(BH_State
, &bh
->b_state
);
335 static inline int jbd_trylock_bh_state(struct buffer_head
*bh
)
337 return bit_spin_trylock(BH_State
, &bh
->b_state
);
340 static inline int jbd_is_locked_bh_state(struct buffer_head
*bh
)
342 return bit_spin_is_locked(BH_State
, &bh
->b_state
);
345 static inline void jbd_unlock_bh_state(struct buffer_head
*bh
)
347 bit_spin_unlock(BH_State
, &bh
->b_state
);
350 static inline void jbd_lock_bh_journal_head(struct buffer_head
*bh
)
352 bit_spin_lock(BH_JournalHead
, &bh
->b_state
);
355 static inline void jbd_unlock_bh_journal_head(struct buffer_head
*bh
)
357 bit_spin_unlock(BH_JournalHead
, &bh
->b_state
);
360 struct jbd_revoke_table_s
;
363 * struct handle_s - The handle_s type is the concrete type associated with
365 * @h_transaction: Which compound transaction is this update a part of?
366 * @h_buffer_credits: Number of remaining buffers we are allowed to dirty.
367 * @h_ref: Reference count on this handle
368 * @h_err: Field for caller's use to track errors through large fs operations
369 * @h_sync: flag for sync-on-close
370 * @h_jdata: flag to force data journaling
371 * @h_aborted: flag indicating fatal error on handle
372 * @h_lockdep_map: lockdep info for debugging lock problems
375 /* Docbook can't yet cope with the bit fields, but will leave the documentation
376 * in so it can be fixed later.
381 /* Which compound transaction is this update a part of? */
382 transaction_t
*h_transaction
;
384 /* Number of remaining buffers we are allowed to dirty: */
385 int h_buffer_credits
;
387 /* Reference count on this handle */
390 /* Field for caller's use to track errors through large fs */
394 /* Flags [no locking] */
396 1; /* sync-on-close */
397 unsigned int h_jdata
:
398 1; /* force data journaling */
399 unsigned int h_aborted
:
400 1; /* fatal error on handle */
402 #ifdef CONFIG_DEBUG_LOCK_ALLOC
403 struct lockdep_map h_lockdep_map
;
408 /* The transaction_t type is the guts of the journaling mechanism. It
409 * tracks a compound transaction through its various states:
411 * RUNNING: accepting new updates
412 * LOCKED: Updates still running but we don't accept new ones
413 * RUNDOWN: Updates are tidying up but have finished requesting
414 * new buffers to modify (state not used for now)
415 * FLUSH: All updates complete, but we are still writing to disk
416 * COMMIT: All data on disk, writing commit record
417 * FINISHED: We still have to keep the transaction for checkpointing.
419 * The transaction keeps track of all of the buffers modified by a
420 * running transaction, and all of the buffers committed but not yet
421 * flushed to home for finished transactions.
428 * ->jbd_lock_bh_journal_head() (This is "innermost")
431 * ->jbd_lock_bh_state()
433 * jbd_lock_bh_state()
440 * ->j_list_lock (journal_unmap_buffer)
446 /* Pointer to the journal for this transaction. [no locking] */
447 journal_t
*t_journal
;
449 /* Sequence number for this transaction [no locking] */
453 * Transaction's current state
454 * [no locking - only kjournald alters this]
455 * [j_list_lock] guards transition of a transaction into T_FINISHED
456 * state and subsequent call of __journal_drop_transaction()
457 * FIXME: needs barriers
458 * KLUDGE: [use j_state_lock]
470 * Where in the log does this transaction's commit start? [no locking]
472 unsigned long t_log_start
;
474 /* Number of buffers on the t_buffers list [j_list_lock] */
478 * Doubly-linked circular list of all buffers reserved but not yet
479 * modified by this transaction [j_list_lock]
481 struct journal_head
*t_reserved_list
;
484 * Doubly-linked circular list of all buffers under writeout during
485 * commit [j_list_lock]
487 struct journal_head
*t_locked_list
;
490 * Doubly-linked circular list of all metadata buffers owned by this
491 * transaction [j_list_lock]
493 struct journal_head
*t_buffers
;
496 * Doubly-linked circular list of all data buffers still to be
497 * flushed before this transaction can be committed [j_list_lock]
499 struct journal_head
*t_sync_datalist
;
502 * Doubly-linked circular list of all forget buffers (superseded
503 * buffers which we can un-checkpoint once this transaction commits)
506 struct journal_head
*t_forget
;
509 * Doubly-linked circular list of all buffers still to be flushed before
510 * this transaction can be checkpointed. [j_list_lock]
512 struct journal_head
*t_checkpoint_list
;
515 * Doubly-linked circular list of all buffers submitted for IO while
516 * checkpointing. [j_list_lock]
518 struct journal_head
*t_checkpoint_io_list
;
521 * Doubly-linked circular list of temporary buffers currently undergoing
522 * IO in the log [j_list_lock]
524 struct journal_head
*t_iobuf_list
;
527 * Doubly-linked circular list of metadata buffers being shadowed by log
528 * IO. The IO buffers on the iobuf list and the shadow buffers on this
529 * list match each other one for one at all times. [j_list_lock]
531 struct journal_head
*t_shadow_list
;
534 * Doubly-linked circular list of control buffers being written to the
537 struct journal_head
*t_log_list
;
540 * Protects info related to handles
542 spinlock_t t_handle_lock
;
545 * Number of outstanding updates running on this transaction
551 * Number of buffers reserved for use by all handles in this transaction
552 * handle but not yet modified. [t_handle_lock]
554 int t_outstanding_credits
;
557 * Forward and backward links for the circular list of all transactions
558 * awaiting checkpoint. [j_list_lock]
560 transaction_t
*t_cpnext
, *t_cpprev
;
563 * When will the transaction expire (become due for commit), in jiffies?
566 unsigned long t_expires
;
569 * How many handles used this transaction? [t_handle_lock]
576 * struct journal_s - The journal_s type is the concrete type associated with
578 * @j_flags: General journaling state flags
579 * @j_errno: Is there an outstanding uncleared error on the journal (from a
581 * @j_sb_buffer: First part of superblock buffer
582 * @j_superblock: Second part of superblock buffer
583 * @j_format_version: Version of the superblock format
584 * @j_state_lock: Protect the various scalars in the journal
585 * @j_barrier_count: Number of processes waiting to create a barrier lock
586 * @j_barrier: The barrier lock itself
587 * @j_running_transaction: The current running transaction..
588 * @j_committing_transaction: the transaction we are pushing to disk
589 * @j_checkpoint_transactions: a linked circular list of all transactions
590 * waiting for checkpointing
591 * @j_wait_transaction_locked: Wait queue for waiting for a locked transaction
592 * to start committing, or for a barrier lock to be released
593 * @j_wait_logspace: Wait queue for waiting for checkpointing to complete
594 * @j_wait_done_commit: Wait queue for waiting for commit to complete
595 * @j_wait_checkpoint: Wait queue to trigger checkpointing
596 * @j_wait_commit: Wait queue to trigger commit
597 * @j_wait_updates: Wait queue to wait for updates to complete
598 * @j_checkpoint_mutex: Mutex for locking against concurrent checkpoints
599 * @j_head: Journal head - identifies the first unused block in the journal
600 * @j_tail: Journal tail - identifies the oldest still-used block in the
602 * @j_free: Journal free - how many free blocks are there in the journal?
603 * @j_first: The block number of the first usable block
604 * @j_last: The block number one beyond the last usable block
605 * @j_dev: Device where we store the journal
606 * @j_blocksize: blocksize for the location where we store the journal.
607 * @j_blk_offset: starting block offset for into the device where we store the
609 * @j_fs_dev: Device which holds the client fs. For internal journal this will
611 * @j_maxlen: Total maximum capacity of the journal region on disk.
612 * @j_list_lock: Protects the buffer lists and internal buffer state.
613 * @j_inode: Optional inode where we store the journal. If present, all journal
614 * block numbers are mapped into this inode via bmap().
615 * @j_tail_sequence: Sequence number of the oldest transaction in the log
616 * @j_transaction_sequence: Sequence number of the next transaction to grant
617 * @j_commit_sequence: Sequence number of the most recently committed
619 * @j_commit_request: Sequence number of the most recent transaction wanting
621 * @j_uuid: Uuid of client object.
622 * @j_task: Pointer to the current commit thread for this journal
623 * @j_max_transaction_buffers: Maximum number of metadata buffers to allow in a
624 * single compound commit transaction
625 * @j_commit_interval: What is the maximum transaction lifetime before we begin
627 * @j_commit_timer: The timer used to wakeup the commit thread
628 * @j_revoke_lock: Protect the revoke table
629 * @j_revoke: The revoke table - maintains the list of revoked blocks in the
630 * current transaction.
631 * @j_revoke_table: alternate revoke tables for j_revoke
632 * @j_wbuf: array of buffer_heads for journal_commit_transaction
633 * @j_wbufsize: maximum number of buffer_heads allowed in j_wbuf, the
634 * number that will fit in j_blocksize
635 * @j_last_sync_writer: most recent pid which did a synchronous write
636 * @j_private: An opaque pointer to fs-private information.
641 /* General journaling state flags [j_state_lock] */
642 unsigned long j_flags
;
645 * Is there an outstanding uncleared error on the journal (from a prior
646 * abort)? [j_state_lock]
650 /* The superblock buffer */
651 struct buffer_head
*j_sb_buffer
;
652 journal_superblock_t
*j_superblock
;
654 /* Version of the superblock format */
655 int j_format_version
;
658 * Protect the various scalars in the journal
660 spinlock_t j_state_lock
;
663 * Number of processes waiting to create a barrier lock [j_state_lock]
667 /* The barrier lock itself */
668 struct mutex j_barrier
;
671 * Transactions: The current running transaction...
672 * [j_state_lock] [caller holding open handle]
674 transaction_t
*j_running_transaction
;
677 * the transaction we are pushing to disk
678 * [j_state_lock] [caller holding open handle]
680 transaction_t
*j_committing_transaction
;
683 * ... and a linked circular list of all transactions waiting for
684 * checkpointing. [j_list_lock]
686 transaction_t
*j_checkpoint_transactions
;
689 * Wait queue for waiting for a locked transaction to start committing,
690 * or for a barrier lock to be released
692 wait_queue_head_t j_wait_transaction_locked
;
694 /* Wait queue for waiting for checkpointing to complete */
695 wait_queue_head_t j_wait_logspace
;
697 /* Wait queue for waiting for commit to complete */
698 wait_queue_head_t j_wait_done_commit
;
700 /* Wait queue to trigger checkpointing */
701 wait_queue_head_t j_wait_checkpoint
;
703 /* Wait queue to trigger commit */
704 wait_queue_head_t j_wait_commit
;
706 /* Wait queue to wait for updates to complete */
707 wait_queue_head_t j_wait_updates
;
709 /* Semaphore for locking against concurrent checkpoints */
710 struct mutex j_checkpoint_mutex
;
713 * Journal head: identifies the first unused block in the journal.
716 unsigned long j_head
;
719 * Journal tail: identifies the oldest still-used block in the journal.
722 unsigned long j_tail
;
725 * Journal free: how many free blocks are there in the journal?
728 unsigned long j_free
;
731 * Journal start and end: the block numbers of the first usable block
732 * and one beyond the last usable block in the journal. [j_state_lock]
734 unsigned long j_first
;
735 unsigned long j_last
;
738 * Device, blocksize and starting block offset for the location where we
741 struct block_device
*j_dev
;
743 unsigned long j_blk_offset
;
746 * Device which holds the client fs. For internal journal this will be
749 struct block_device
*j_fs_dev
;
751 /* Total maximum capacity of the journal region on disk. */
752 unsigned int j_maxlen
;
755 * Protects the buffer lists and internal buffer state.
757 spinlock_t j_list_lock
;
759 /* Optional inode where we store the journal. If present, all */
760 /* journal block numbers are mapped into this inode via */
762 struct inode
*j_inode
;
765 * Sequence number of the oldest transaction in the log [j_state_lock]
767 tid_t j_tail_sequence
;
770 * Sequence number of the next transaction to grant [j_state_lock]
772 tid_t j_transaction_sequence
;
775 * Sequence number of the most recently committed transaction
778 tid_t j_commit_sequence
;
781 * Sequence number of the most recent transaction wanting commit
784 tid_t j_commit_request
;
787 * Journal uuid: identifies the object (filesystem, LVM volume etc)
788 * backed by this journal. This will eventually be replaced by an array
789 * of uuids, allowing us to index multiple devices within a single
790 * journal and to perform atomic updates across them.
794 /* Pointer to the current commit thread for this journal */
795 struct task_struct
*j_task
;
798 * Maximum number of metadata buffers to allow in a single compound
801 int j_max_transaction_buffers
;
804 * What is the maximum transaction lifetime before we begin a commit?
806 unsigned long j_commit_interval
;
808 /* The timer used to wakeup the commit thread: */
809 struct timer_list j_commit_timer
;
812 * The revoke table: maintains the list of revoked blocks in the
813 * current transaction. [j_revoke_lock]
815 spinlock_t j_revoke_lock
;
816 struct jbd_revoke_table_s
*j_revoke
;
817 struct jbd_revoke_table_s
*j_revoke_table
[2];
820 * array of bhs for journal_commit_transaction
822 struct buffer_head
**j_wbuf
;
825 pid_t j_last_sync_writer
;
828 * An opaque pointer to fs-private information. ext3 puts its
829 * superblock pointer here
835 * Journal flag definitions
837 #define JFS_UNMOUNT 0x001 /* Journal thread is being destroyed */
838 #define JFS_ABORT 0x002 /* Journaling has been aborted for errors. */
839 #define JFS_ACK_ERR 0x004 /* The errno in the sb has been acked */
840 #define JFS_FLUSHED 0x008 /* The journal superblock has been flushed */
841 #define JFS_LOADED 0x010 /* The journal superblock has been loaded */
842 #define JFS_BARRIER 0x020 /* Use IDE barriers */
845 * Function declarations for the journaling transaction and buffer
850 extern void journal_unfile_buffer(journal_t
*, struct journal_head
*);
851 extern void __journal_unfile_buffer(struct journal_head
*);
852 extern void __journal_refile_buffer(struct journal_head
*);
853 extern void journal_refile_buffer(journal_t
*, struct journal_head
*);
854 extern void __journal_file_buffer(struct journal_head
*, transaction_t
*, int);
855 extern void __journal_free_buffer(struct journal_head
*bh
);
856 extern void journal_file_buffer(struct journal_head
*, transaction_t
*, int);
857 extern void __journal_clean_data_list(transaction_t
*transaction
);
859 /* Log buffer allocation */
860 extern struct journal_head
* journal_get_descriptor_buffer(journal_t
*);
861 int journal_next_log_block(journal_t
*, unsigned long *);
863 /* Commit management */
864 extern void journal_commit_transaction(journal_t
*);
866 /* Checkpoint list management */
867 int __journal_clean_checkpoint_list(journal_t
*journal
);
868 int __journal_remove_checkpoint(struct journal_head
*);
869 void __journal_insert_checkpoint(struct journal_head
*, transaction_t
*);
873 journal_write_metadata_buffer(transaction_t
*transaction
,
874 struct journal_head
*jh_in
,
875 struct journal_head
**jh_out
,
876 unsigned long blocknr
);
878 /* Transaction locking */
879 extern void __wait_on_journal (journal_t
*);
884 * We need to lock the journal during transaction state changes so that nobody
885 * ever tries to take a handle on the running transaction while we are in the
886 * middle of moving it to the commit phase. j_state_lock does this.
888 * Note that the locking is completely interrupt unsafe. We never touch
889 * journal structures from interrupts.
892 static inline handle_t
*journal_current_handle(void)
895 /* return current->journal_info; */
897 #pragma message("WARNINGS: journal_current_handle NOT implemented")
901 /* The journaling code user interface:
903 * Create and destroy handles
904 * Register buffer modifications against the current transaction.
907 extern handle_t
*journal_start(journal_t
*, int nblocks
);
908 extern int journal_restart (handle_t
*, int nblocks
);
909 extern int journal_extend (handle_t
*, int nblocks
);
910 extern int journal_get_write_access(handle_t
*, struct buffer_head
*);
911 extern int journal_get_create_access (handle_t
*, struct buffer_head
*);
912 extern int journal_get_undo_access(handle_t
*, struct buffer_head
*);
913 extern int journal_dirty_data (handle_t
*, struct buffer_head
*);
914 extern int journal_dirty_metadata (handle_t
*, struct buffer_head
*);
915 extern void journal_release_buffer (handle_t
*, struct buffer_head
*);
916 extern int journal_forget (handle_t
*, struct buffer_head
*);
917 extern void journal_sync_buffer (struct buffer_head
*);
918 extern void journal_invalidatepage(journal_t
*,
919 struct page
*, unsigned long);
920 extern int journal_try_to_free_buffers(journal_t
*, struct page
*, gfp_t
);
921 extern int journal_stop(handle_t
*);
922 extern int journal_flush (journal_t
*);
923 extern void journal_lock_updates (journal_t
*);
924 extern void journal_unlock_updates (journal_t
*);
926 extern journal_t
* journal_init_dev(struct block_device
*bdev
,
927 struct block_device
*fs_dev
,
928 int start
, int len
, int bsize
);
929 extern journal_t
* journal_init_inode (struct inode
*);
930 extern int journal_update_format (journal_t
*);
931 extern int journal_check_used_features
932 (journal_t
*, unsigned long, unsigned long, unsigned long);
933 extern int journal_check_available_features
934 (journal_t
*, unsigned long, unsigned long, unsigned long);
935 extern int journal_set_features
936 (journal_t
*, unsigned long, unsigned long, unsigned long);
937 extern int journal_create (journal_t
*);
938 extern int journal_load (journal_t
*journal
);
939 extern void journal_destroy (journal_t
*);
940 extern int journal_recover (journal_t
*journal
);
941 extern int journal_wipe (journal_t
*, int);
942 extern int journal_skip_recovery (journal_t
*);
943 extern void journal_update_superblock (journal_t
*, int);
944 void journal_abort (journal_t
*, int);
945 extern int journal_errno (journal_t
*);
946 extern void journal_ack_err (journal_t
*);
947 extern int journal_clear_err (journal_t
*);
948 extern int journal_bmap(journal_t
*, unsigned long, unsigned long *);
949 extern int journal_force_commit(journal_t
*);
952 void journal_wipe_recovery(journal_t
*journal
);
955 * journal_head management
957 struct journal_head
*journal_add_journal_head(struct buffer_head
*bh
);
958 struct journal_head
*journal_grab_journal_head(struct buffer_head
*bh
);
959 void journal_remove_journal_head(struct buffer_head
*bh
);
960 void journal_put_journal_head(struct journal_head
*jh
);
965 extern struct kmem_cache
*jbd_handle_cache
;
967 static inline handle_t
*jbd_alloc_handle(gfp_t gfp_flags
)
969 return (handle_t
*)kmem_cache_alloc(jbd_handle_cache
, gfp_flags
);
972 static inline void jbd_free_handle(handle_t
*handle
)
974 kmem_cache_free(jbd_handle_cache
, handle
);
977 /* Primary revoke support */
978 #define JOURNAL_REVOKE_DEFAULT_HASH 256
979 extern int journal_init_revoke(journal_t
*, int);
980 extern void journal_destroy_revoke_caches(void);
981 extern int journal_init_revoke_caches(void);
983 extern void journal_destroy_revoke(journal_t
*);
984 extern int journal_revoke (handle_t
*,
985 unsigned long, struct buffer_head
*);
986 extern int journal_cancel_revoke(handle_t
*, struct journal_head
*);
987 extern void journal_write_revoke_records(journal_t
*, transaction_t
*);
989 /* Recovery revoke support */
990 extern int journal_set_revoke(journal_t
*, unsigned long, tid_t
);
991 extern int journal_test_revoke(journal_t
*, unsigned long, tid_t
);
992 extern void journal_clear_revoke(journal_t
*);
993 extern void journal_switch_revoke_table(journal_t
*journal
);
996 * The log thread user interface:
998 * Request space in the current transaction, and force transaction commit
999 * transitions on demand.
1002 int __log_space_left(journal_t
*); /* Called with journal locked */
1003 int log_start_commit(journal_t
*journal
, tid_t tid
);
1004 int __log_start_commit(journal_t
*journal
, tid_t tid
);
1005 int journal_start_commit(journal_t
*journal
, tid_t
*tid
);
1006 int journal_force_commit_nested(journal_t
*journal
);
1007 int log_wait_commit(journal_t
*journal
, tid_t tid
);
1008 int log_do_checkpoint(journal_t
*journal
);
1010 void __log_wait_for_space(journal_t
*journal
);
1011 extern void __journal_drop_transaction(journal_t
*, transaction_t
*);
1012 extern int cleanup_journal_tail(journal_t
*);
1014 /* Debugging code only: */
1016 #define jbd_ENOSYS() \
1018 printk (KERN_ERR "JBD unimplemented function %s\n", __FUNCTION__); \
1019 current->state = TASK_UNINTERRUPTIBLE; \
1026 * Simple test wrapper function to test the JFS_ABORT state flag. This
1027 * bit, when set, indicates that we have had a fatal error somewhere,
1028 * either inside the journaling layer or indicated to us by the client
1029 * (eg. ext3), and that we and should not commit any further
1033 static inline int is_journal_aborted(journal_t
*journal
)
1035 return journal
->j_flags
& JFS_ABORT
;
1038 static inline int is_handle_aborted(handle_t
*handle
)
1040 if (handle
->h_aborted
)
1042 return is_journal_aborted(handle
->h_transaction
->t_journal
);
1045 static inline void journal_abort_handle(handle_t
*handle
)
1047 handle
->h_aborted
= 1;
1050 #endif /* __KERNEL__ */
1052 /* Comparison functions for transaction IDs: perform comparisons using
1053 * modulo arithmetic so that they work over sequence number wraps. */
1055 static inline int tid_gt(tid_t x
, tid_t y
)
1057 int difference
= (x
- y
);
1058 return (difference
> 0);
1061 static inline int tid_geq(tid_t x
, tid_t y
)
1063 int difference
= (x
- y
);
1064 return (difference
>= 0);
1067 extern int journal_blocks_per_page(struct inode
*inode
);
1070 * Return the minimum number of blocks which must be free in the journal
1071 * before a new transaction may be started. Must be called under j_state_lock.
1073 static inline int jbd_space_needed(journal_t
*journal
)
1075 int nblocks
= journal
->j_max_transaction_buffers
;
1076 if (journal
->j_committing_transaction
)
1077 nblocks
+= journal
->j_committing_transaction
->
1078 t_outstanding_credits
;
1083 * Definitions which augment the buffer_head layer
1086 /* journaling buffer types */
1087 #define BJ_None 0 /* Not journaled */
1088 #define BJ_SyncData 1 /* Normal data: flush before commit */
1089 #define BJ_Metadata 2 /* Normal journaled metadata */
1090 #define BJ_Forget 3 /* Buffer superseded by this transaction */
1091 #define BJ_IO 4 /* Buffer is for temporary IO use */
1092 #define BJ_Shadow 5 /* Buffer contents being shadowed to the log */
1093 #define BJ_LogCtl 6 /* Buffer contains log descriptors */
1094 #define BJ_Reserved 7 /* Buffer is reserved for access by journal */
1095 #define BJ_Locked 8 /* Locked for I/O during commit */
1098 extern int jbd_blocks_per_page(struct inode
*inode
);
1102 #define buffer_trace_init(bh) do {} while (0)
1103 #define print_buffer_fields(bh) do {} while (0)
1104 #define print_buffer_trace(bh) do {} while (0)
1105 #define BUFFER_TRACE(bh, info) do {} while (0)
1106 #define BUFFER_TRACE2(bh, bh2, info) do {} while (0)
1107 #define JBUFFER_TRACE(jh, info) do {} while (0)
1109 #endif /* __KERNEL__ */
1111 #endif /* _LINUX_JBD_H */