ReactOS  0.4.14-dev-583-g2a1ba2c
jbd.h
Go to the documentation of this file.
1 /*
2  * linux/include/linux/jbd.h
3  *
4  * Written by Stephen C. Tweedie <sct@redhat.com>
5  *
6  * Copyright 1998-2000 Red Hat, Inc --- 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  * Definitions for transaction data structures for the buffer cache
13  * filesystem journaling support.
14  */
15 
16 #ifndef _LINUX_JBD_H
17 #define _LINUX_JBD_H
18 
19 /* Allow this file to be included directly into e2fsprogs */
20 #ifndef __KERNEL__
21 #include "jfs_compat.h"
22 #define JFS_DEBUG
23 #define jfs_debug jbd_debug
24 #else
25 
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>
34 
35 #include <asm/semaphore.h>
36 
37 #define journal_oom_retry 1
38 
39 /*
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.
45  */
46 #undef JBD_PARANOID_IOFAIL
47 
48 /*
49  * The default maximum commit age, in seconds.
50  */
51 #define JBD_DEFAULT_MAX_COMMIT_AGE 5
52 
53 #ifdef CONFIG_JBD_DEBUG
54 /*
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.
58  */
59 #define JBD_EXPENSIVE_CHECKING
60 extern u8 journal_enable_debug;
61 
62 #define jbd_debug(n, f, a...) \
63  do { \
64  if ((n) <= journal_enable_debug) { \
65  printk (KERN_DEBUG "(%s, %d): %s: ", \
66  __FILE__, __LINE__, __FUNCTION__); \
67  printk (f, ## a); \
68  } \
69  } while (0)
70 #else
71 #define jbd_debug
72 #endif
73 
74 static inline void *jbd_alloc(size_t size, gfp_t flags)
75 {
76  return kmalloc(size, flags);
77  /*__get_free_pages(flags, get_order(size));*/
78 }
79 
80 static inline void jbd_free(void *ptr, size_t size)
81 {
82  if (ptr) {
83  kfree(ptr);
84  }
85  /* free_pages((unsigned long)ptr, get_order(size)); */
86 };
87 
88 #define JFS_MIN_JOURNAL_BLOCKS 1024
89 
90 
108 typedef struct handle_s handle_t; /* Atomic operation type */
109 
110 
122 typedef struct journal_s journal_t; /* Journal control structure */
123 #endif
124 
125 /*
126  * Internal structures used by the logging mechanism:
127  */
128 
129 #define JFS_MAGIC_NUMBER 0xc03b3998U /* The first 4 bytes of /dev/random! */
130 
131 /*
132  * On-disk structures
133  */
134 
135 /*
136  * Descriptor block types:
137  */
138 
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
144 
145 /*
146  * Standard header for all descriptor blocks:
147  */
148 typedef struct journal_header_s
149 {
150  __be32 h_magic;
154 
155 
156 /*
157  * The block tag: used to describe a single buffer in the journal
158  */
159 typedef struct journal_block_tag_s
160 {
161  __be32 t_blocknr; /* The on-disk block number */
162  __be32 t_flags; /* See below */
164 
165 /*
166  * The revoke descriptor: used on disk to describe a series of blocks to
167  * be revoked from the log
168  */
169 typedef struct journal_revoke_header_s
170 {
172  __be32 r_count; /* Count of bytes used in the block */
174 
175 
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 */
181 
182 
183 /*
184  * The journal superblock. All fields are in big-endian byte order.
185  */
186 typedef struct journal_superblock_s
187 {
188 /* 0x0000 */
190 
191 /* 0x000C */
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 */
196 
197 /* 0x0018 */
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 */
201 
202 /* 0x0020 */
203  /* Error value, as set by journal_abort(). */
204  __be32 s_errno;
205 
206 /* 0x0024 */
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 */
211 /* 0x0030 */
212  __u8 s_uuid[16]; /* 128-bit uuid for journal */
213 
214 /* 0x0040 */
215  __be32 s_nr_users; /* Nr of filesystems sharing log */
216 
217  __be32 s_dynsuper; /* Blocknr of dynamic superblock copy*/
218 
219 /* 0x0048 */
220  __be32 s_max_transaction; /* Limit of journal blocks per trans.*/
221  __be32 s_max_trans_data; /* Limit of data blocks per trans. */
222 
223 /* 0x0050 */
224  __u32 s_padding[44];
225 
226 /* 0x0100 */
227  __u8 s_users[16*48]; /* ids of all fs'es sharing the log */
228 /* 0x0400 */
230 
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))))
240 
241 #define JFS_FEATURE_INCOMPAT_REVOKE 0x00000001
242 
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
247 
248 #ifdef __KERNEL__
249 
250 #include <linux/fs.h>
251 #include <linux/sched.h>
252 
253 #define J_ASSERT ASSERT
254 
255 #if defined(CONFIG_BUFFER_DEBUG)
256 void buffer_assertion_failure(struct buffer_head *bh);
257 #define J_ASSERT_BH(bh, expr) \
258  do { \
259  if (!(expr)) \
260  buffer_assertion_failure(bh); \
261  J_ASSERT(expr); \
262  } while (0)
263 #define J_ASSERT_JH(jh, expr) J_ASSERT_BH(jh2bh(jh), expr)
264 #else
265 #define J_ASSERT_BH(bh, expr) J_ASSERT(expr)
266 #define J_ASSERT_JH(jh, expr) J_ASSERT(expr)
267 #endif
268 
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)
273 #else
274 #if 0
275 #define __journal_expect(expr, why...) \
276  ({ \
277  int val = (expr); \
278  if (!val) { \
279  printk(KERN_ERR \
280  "EXT3-fs unexpected failure: %s;\n",# expr); \
281  printk(KERN_ERR why "\n"); \
282  } \
283  val; \
284  })
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)
288 #endif
289 #define __journal_expect
290 
291 #define J_EXPECT
292 #define J_EXPECT_BH
293 #define J_EXPECT_JH
294 
295 #endif
296 
297 enum jbd_state_bits {
298  BH_JBD /* Has an attached ext3 journal_head */
299  = BH_PrivateStart,
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 */
308 };
309 
310 BUFFER_FNS(JBD, jbd)
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)
319 
320 static inline struct buffer_head *jh2bh(struct journal_head *jh)
321 {
322  return jh->b_bh;
323 }
324 
325 static inline struct journal_head *bh2jh(struct buffer_head *bh)
326 {
327  return bh->b_private;
328 }
329 
330 static inline void jbd_lock_bh_state(struct buffer_head *bh)
331 {
332  bit_spin_lock(BH_State, &bh->b_state);
333 }
334 
335 static inline int jbd_trylock_bh_state(struct buffer_head *bh)
336 {
337  return bit_spin_trylock(BH_State, &bh->b_state);
338 }
339 
340 static inline int jbd_is_locked_bh_state(struct buffer_head *bh)
341 {
342  return bit_spin_is_locked(BH_State, &bh->b_state);
343 }
344 
345 static inline void jbd_unlock_bh_state(struct buffer_head *bh)
346 {
347  bit_spin_unlock(BH_State, &bh->b_state);
348 }
349 
350 static inline void jbd_lock_bh_journal_head(struct buffer_head *bh)
351 {
352  bit_spin_lock(BH_JournalHead, &bh->b_state);
353 }
354 
355 static inline void jbd_unlock_bh_journal_head(struct buffer_head *bh)
356 {
357  bit_spin_unlock(BH_JournalHead, &bh->b_state);
358 }
359 
360 struct jbd_revoke_table_s;
361 
375 /* Docbook can't yet cope with the bit fields, but will leave the documentation
376  * in so it can be fixed later.
377  */
378 
379 struct handle_s
380 {
381  /* Which compound transaction is this update a part of? */
382  transaction_t *h_transaction;
383 
384  /* Number of remaining buffers we are allowed to dirty: */
385  int h_buffer_credits;
386 
387  /* Reference count on this handle */
388  int h_ref;
389 
390  /* Field for caller's use to track errors through large fs */
391  /* operations */
392  int h_err;
393 
394  /* Flags [no locking] */
395  unsigned int h_sync: 1; /* sync-on-close */
396  unsigned int h_jdata: 1; /* force data journaling */
397  unsigned int h_aborted: 1; /* fatal error on handle */
398 
399 #ifdef CONFIG_DEBUG_LOCK_ALLOC
400  struct lockdep_map h_lockdep_map;
401 #endif
402 };
403 
404 
405 /* The transaction_t type is the guts of the journaling mechanism. It
406  * tracks a compound transaction through its various states:
407  *
408  * RUNNING: accepting new updates
409  * LOCKED: Updates still running but we don't accept new ones
410  * RUNDOWN: Updates are tidying up but have finished requesting
411  * new buffers to modify (state not used for now)
412  * FLUSH: All updates complete, but we are still writing to disk
413  * COMMIT: All data on disk, writing commit record
414  * FINISHED: We still have to keep the transaction for checkpointing.
415  *
416  * The transaction keeps track of all of the buffers modified by a
417  * running transaction, and all of the buffers committed but not yet
418  * flushed to home for finished transactions.
419  */
420 
421 /*
422  * Lock ranking:
423  *
424  * j_list_lock
425  * ->jbd_lock_bh_journal_head() (This is "innermost")
426  *
427  * j_state_lock
428  * ->jbd_lock_bh_state()
429  *
430  * jbd_lock_bh_state()
431  * ->j_list_lock
432  *
433  * j_state_lock
434  * ->t_handle_lock
435  *
436  * j_state_lock
437  * ->j_list_lock (journal_unmap_buffer)
438  *
439  */
440 
441 struct transaction_s
442 {
443  /* Pointer to the journal for this transaction. [no locking] */
444  journal_t *t_journal;
445 
446  /* Sequence number for this transaction [no locking] */
447  tid_t t_tid;
448 
449  /*
450  * Transaction's current state
451  * [no locking - only kjournald alters this]
452  * [j_list_lock] guards transition of a transaction into T_FINISHED
453  * state and subsequent call of __journal_drop_transaction()
454  * FIXME: needs barriers
455  * KLUDGE: [use j_state_lock]
456  */
457  enum {
458  T_RUNNING,
459  T_LOCKED,
460  T_RUNDOWN,
461  T_FLUSH,
462  T_COMMIT,
463  T_FINISHED
464  } t_state;
465 
466  /*
467  * Where in the log does this transaction's commit start? [no locking]
468  */
469  unsigned long t_log_start;
470 
471  /* Number of buffers on the t_buffers list [j_list_lock] */
472  int t_nr_buffers;
473 
474  /*
475  * Doubly-linked circular list of all buffers reserved but not yet
476  * modified by this transaction [j_list_lock]
477  */
478  struct journal_head *t_reserved_list;
479 
480  /*
481  * Doubly-linked circular list of all buffers under writeout during
482  * commit [j_list_lock]
483  */
484  struct journal_head *t_locked_list;
485 
486  /*
487  * Doubly-linked circular list of all metadata buffers owned by this
488  * transaction [j_list_lock]
489  */
490  struct journal_head *t_buffers;
491 
492  /*
493  * Doubly-linked circular list of all data buffers still to be
494  * flushed before this transaction can be committed [j_list_lock]
495  */
496  struct journal_head *t_sync_datalist;
497 
498  /*
499  * Doubly-linked circular list of all forget buffers (superseded
500  * buffers which we can un-checkpoint once this transaction commits)
501  * [j_list_lock]
502  */
503  struct journal_head *t_forget;
504 
505  /*
506  * Doubly-linked circular list of all buffers still to be flushed before
507  * this transaction can be checkpointed. [j_list_lock]
508  */
509  struct journal_head *t_checkpoint_list;
510 
511  /*
512  * Doubly-linked circular list of all buffers submitted for IO while
513  * checkpointing. [j_list_lock]
514  */
515  struct journal_head *t_checkpoint_io_list;
516 
517  /*
518  * Doubly-linked circular list of temporary buffers currently undergoing
519  * IO in the log [j_list_lock]
520  */
521  struct journal_head *t_iobuf_list;
522 
523  /*
524  * Doubly-linked circular list of metadata buffers being shadowed by log
525  * IO. The IO buffers on the iobuf list and the shadow buffers on this
526  * list match each other one for one at all times. [j_list_lock]
527  */
528  struct journal_head *t_shadow_list;
529 
530  /*
531  * Doubly-linked circular list of control buffers being written to the
532  * log. [j_list_lock]
533  */
534  struct journal_head *t_log_list;
535 
536  /*
537  * Protects info related to handles
538  */
539  spinlock_t t_handle_lock;
540 
541  /*
542  * Number of outstanding updates running on this transaction
543  * [t_handle_lock]
544  */
545  int t_updates;
546 
547  /*
548  * Number of buffers reserved for use by all handles in this transaction
549  * handle but not yet modified. [t_handle_lock]
550  */
551  int t_outstanding_credits;
552 
553  /*
554  * Forward and backward links for the circular list of all transactions
555  * awaiting checkpoint. [j_list_lock]
556  */
557  transaction_t *t_cpnext, *t_cpprev;
558 
559  /*
560  * When will the transaction expire (become due for commit), in jiffies?
561  * [no locking]
562  */
563  unsigned long t_expires;
564 
565  /*
566  * How many handles used this transaction? [t_handle_lock]
567  */
568  int t_handle_count;
569 
570 };
571 
636 struct journal_s
637 {
638  /* General journaling state flags [j_state_lock] */
639  unsigned long j_flags;
640 
641  /*
642  * Is there an outstanding uncleared error on the journal (from a prior
643  * abort)? [j_state_lock]
644  */
645  int j_errno;
646 
647  /* The superblock buffer */
648  struct buffer_head *j_sb_buffer;
649  journal_superblock_t *j_superblock;
650 
651  /* Version of the superblock format */
652  int j_format_version;
653 
654  /*
655  * Protect the various scalars in the journal
656  */
657  spinlock_t j_state_lock;
658 
659  /*
660  * Number of processes waiting to create a barrier lock [j_state_lock]
661  */
662  int j_barrier_count;
663 
664  /* The barrier lock itself */
665  struct mutex j_barrier;
666 
667  /*
668  * Transactions: The current running transaction...
669  * [j_state_lock] [caller holding open handle]
670  */
671  transaction_t *j_running_transaction;
672 
673  /*
674  * the transaction we are pushing to disk
675  * [j_state_lock] [caller holding open handle]
676  */
677  transaction_t *j_committing_transaction;
678 
679  /*
680  * ... and a linked circular list of all transactions waiting for
681  * checkpointing. [j_list_lock]
682  */
683  transaction_t *j_checkpoint_transactions;
684 
685  /*
686  * Wait queue for waiting for a locked transaction to start committing,
687  * or for a barrier lock to be released
688  */
689  wait_queue_head_t j_wait_transaction_locked;
690 
691  /* Wait queue for waiting for checkpointing to complete */
692  wait_queue_head_t j_wait_logspace;
693 
694  /* Wait queue for waiting for commit to complete */
695  wait_queue_head_t j_wait_done_commit;
696 
697  /* Wait queue to trigger checkpointing */
698  wait_queue_head_t j_wait_checkpoint;
699 
700  /* Wait queue to trigger commit */
701  wait_queue_head_t j_wait_commit;
702 
703  /* Wait queue to wait for updates to complete */
704  wait_queue_head_t j_wait_updates;
705 
706  /* Semaphore for locking against concurrent checkpoints */
707  struct mutex j_checkpoint_mutex;
708 
709  /*
710  * Journal head: identifies the first unused block in the journal.
711  * [j_state_lock]
712  */
713  unsigned long j_head;
714 
715  /*
716  * Journal tail: identifies the oldest still-used block in the journal.
717  * [j_state_lock]
718  */
719  unsigned long j_tail;
720 
721  /*
722  * Journal free: how many free blocks are there in the journal?
723  * [j_state_lock]
724  */
725  unsigned long j_free;
726 
727  /*
728  * Journal start and end: the block numbers of the first usable block
729  * and one beyond the last usable block in the journal. [j_state_lock]
730  */
731  unsigned long j_first;
732  unsigned long j_last;
733 
734  /*
735  * Device, blocksize and starting block offset for the location where we
736  * store the journal.
737  */
738  struct block_device *j_dev;
739  int j_blocksize;
740  unsigned long j_blk_offset;
741 
742  /*
743  * Device which holds the client fs. For internal journal this will be
744  * equal to j_dev.
745  */
746  struct block_device *j_fs_dev;
747 
748  /* Total maximum capacity of the journal region on disk. */
749  unsigned int j_maxlen;
750 
751  /*
752  * Protects the buffer lists and internal buffer state.
753  */
754  spinlock_t j_list_lock;
755 
756  /* Optional inode where we store the journal. If present, all */
757  /* journal block numbers are mapped into this inode via */
758  /* bmap(). */
759  struct inode *j_inode;
760 
761  /*
762  * Sequence number of the oldest transaction in the log [j_state_lock]
763  */
764  tid_t j_tail_sequence;
765 
766  /*
767  * Sequence number of the next transaction to grant [j_state_lock]
768  */
769  tid_t j_transaction_sequence;
770 
771  /*
772  * Sequence number of the most recently committed transaction
773  * [j_state_lock].
774  */
775  tid_t j_commit_sequence;
776 
777  /*
778  * Sequence number of the most recent transaction wanting commit
779  * [j_state_lock]
780  */
781  tid_t j_commit_request;
782 
783  /*
784  * Journal uuid: identifies the object (filesystem, LVM volume etc)
785  * backed by this journal. This will eventually be replaced by an array
786  * of uuids, allowing us to index multiple devices within a single
787  * journal and to perform atomic updates across them.
788  */
789  __u8 j_uuid[16];
790 
791  /* Pointer to the current commit thread for this journal */
792  struct task_struct *j_task;
793 
794  /*
795  * Maximum number of metadata buffers to allow in a single compound
796  * commit transaction
797  */
798  int j_max_transaction_buffers;
799 
800  /*
801  * What is the maximum transaction lifetime before we begin a commit?
802  */
803  unsigned long j_commit_interval;
804 
805  /* The timer used to wakeup the commit thread: */
806  struct timer_list j_commit_timer;
807 
808  /*
809  * The revoke table: maintains the list of revoked blocks in the
810  * current transaction. [j_revoke_lock]
811  */
812  spinlock_t j_revoke_lock;
813  struct jbd_revoke_table_s *j_revoke;
814  struct jbd_revoke_table_s *j_revoke_table[2];
815 
816  /*
817  * array of bhs for journal_commit_transaction
818  */
819  struct buffer_head **j_wbuf;
820  int j_wbufsize;
821 
822  pid_t j_last_sync_writer;
823 
824  /*
825  * An opaque pointer to fs-private information. ext3 puts its
826  * superblock pointer here
827  */
828  void *j_private;
829 };
830 
831 /*
832  * Journal flag definitions
833  */
834 #define JFS_UNMOUNT 0x001 /* Journal thread is being destroyed */
835 #define JFS_ABORT 0x002 /* Journaling has been aborted for errors. */
836 #define JFS_ACK_ERR 0x004 /* The errno in the sb has been acked */
837 #define JFS_FLUSHED 0x008 /* The journal superblock has been flushed */
838 #define JFS_LOADED 0x010 /* The journal superblock has been loaded */
839 #define JFS_BARRIER 0x020 /* Use IDE barriers */
840 
841 /*
842  * Function declarations for the journaling transaction and buffer
843  * management
844  */
845 
846 /* Filing buffers */
847 extern void journal_unfile_buffer(journal_t *, struct journal_head *);
848 extern void __journal_unfile_buffer(struct journal_head *);
849 extern void __journal_refile_buffer(struct journal_head *);
850 extern void journal_refile_buffer(journal_t *, struct journal_head *);
851 extern void __journal_file_buffer(struct journal_head *, transaction_t *, int);
852 extern void __journal_free_buffer(struct journal_head *bh);
853 extern void journal_file_buffer(struct journal_head *, transaction_t *, int);
854 extern void __journal_clean_data_list(transaction_t *transaction);
855 
856 /* Log buffer allocation */
857 extern struct journal_head * journal_get_descriptor_buffer(journal_t *);
858 int journal_next_log_block(journal_t *, unsigned long *);
859 
860 /* Commit management */
861 extern void journal_commit_transaction(journal_t *);
862 
863 /* Checkpoint list management */
864 int __journal_clean_checkpoint_list(journal_t *journal);
865 int __journal_remove_checkpoint(struct journal_head *);
866 void __journal_insert_checkpoint(struct journal_head *, transaction_t *);
867 
868 /* Buffer IO */
869 extern int
870 journal_write_metadata_buffer(transaction_t *transaction,
871  struct journal_head *jh_in,
872  struct journal_head **jh_out,
873  unsigned long blocknr);
874 
875 /* Transaction locking */
876 extern void __wait_on_journal (journal_t *);
877 
878 /*
879  * Journal locking.
880  *
881  * We need to lock the journal during transaction state changes so that nobody
882  * ever tries to take a handle on the running transaction while we are in the
883  * middle of moving it to the commit phase. j_state_lock does this.
884  *
885  * Note that the locking is completely interrupt unsafe. We never touch
886  * journal structures from interrupts.
887  */
888 
889 static inline handle_t *journal_current_handle(void)
890 {
891  return NULL;
892  /* return current->journal_info; */
893 #pragma message("WARNINGS: journal_current_handle NOT implemented")
894 }
895 
896 /* The journaling code user interface:
897  *
898  * Create and destroy handles
899  * Register buffer modifications against the current transaction.
900  */
901 
902 extern handle_t *journal_start(journal_t *, int nblocks);
903 extern int journal_restart (handle_t *, int nblocks);
904 extern int journal_extend (handle_t *, int nblocks);
905 extern int journal_get_write_access(handle_t *, struct buffer_head *);
906 extern int journal_get_create_access (handle_t *, struct buffer_head *);
907 extern int journal_get_undo_access(handle_t *, struct buffer_head *);
908 extern int journal_dirty_data (handle_t *, struct buffer_head *);
909 extern int journal_dirty_metadata (handle_t *, struct buffer_head *);
910 extern void journal_release_buffer (handle_t *, struct buffer_head *);
911 extern int journal_forget (handle_t *, struct buffer_head *);
912 extern void journal_sync_buffer (struct buffer_head *);
913 extern void journal_invalidatepage(journal_t *,
914  struct page *, unsigned long);
915 extern int journal_try_to_free_buffers(journal_t *, struct page *, gfp_t);
916 extern int journal_stop(handle_t *);
917 extern int journal_flush (journal_t *);
918 extern void journal_lock_updates (journal_t *);
919 extern void journal_unlock_updates (journal_t *);
920 
921 extern journal_t * journal_init_dev(struct block_device *bdev,
922  struct block_device *fs_dev,
923  int start, int len, int bsize);
924 extern journal_t * journal_init_inode (struct inode *);
925 extern int journal_update_format (journal_t *);
927  (journal_t *, unsigned long, unsigned long, unsigned long);
929  (journal_t *, unsigned long, unsigned long, unsigned long);
930 extern int journal_set_features
931  (journal_t *, unsigned long, unsigned long, unsigned long);
932 extern int journal_create (journal_t *);
933 extern int journal_load (journal_t *journal);
934 extern void journal_destroy (journal_t *);
935 extern int journal_recover (journal_t *journal);
936 extern int journal_wipe (journal_t *, int);
937 extern int journal_skip_recovery (journal_t *);
938 extern void journal_update_superblock (journal_t *, int);
939  void journal_abort (journal_t *, int);
940 extern int journal_errno (journal_t *);
941 extern void journal_ack_err (journal_t *);
942 extern int journal_clear_err (journal_t *);
943 extern int journal_bmap(journal_t *, unsigned long, unsigned long *);
944 extern int journal_force_commit(journal_t *);
945 
946 /* added by matt */
947 void journal_wipe_recovery(journal_t *journal);
948 
949 /*
950  * journal_head management
951  */
955 void journal_put_journal_head(struct journal_head *jh);
956 
957 /*
958  * handle management
959  */
960 extern struct kmem_cache *jbd_handle_cache;
961 
962 static inline handle_t *jbd_alloc_handle(gfp_t gfp_flags)
963 {
964  return (handle_t *)kmem_cache_alloc(jbd_handle_cache, gfp_flags);
965 }
966 
967 static inline void jbd_free_handle(handle_t *handle)
968 {
970 }
971 
972 /* Primary revoke support */
973 #define JOURNAL_REVOKE_DEFAULT_HASH 256
974 extern int journal_init_revoke(journal_t *, int);
975 extern void journal_destroy_revoke_caches(void);
976 extern int journal_init_revoke_caches(void);
977 
978 extern void journal_destroy_revoke(journal_t *);
979 extern int journal_revoke (handle_t *,
980  unsigned long, struct buffer_head *);
981 extern int journal_cancel_revoke(handle_t *, struct journal_head *);
982 extern void journal_write_revoke_records(journal_t *, transaction_t *);
983 
984 /* Recovery revoke support */
985 extern int journal_set_revoke(journal_t *, unsigned long, tid_t);
986 extern int journal_test_revoke(journal_t *, unsigned long, tid_t);
987 extern void journal_clear_revoke(journal_t *);
988 extern void journal_switch_revoke_table(journal_t *journal);
989 
990 /*
991  * The log thread user interface:
992  *
993  * Request space in the current transaction, and force transaction commit
994  * transitions on demand.
995  */
996 
997 int __log_space_left(journal_t *); /* Called with journal locked */
998 int log_start_commit(journal_t *journal, tid_t tid);
999 int __log_start_commit(journal_t *journal, tid_t tid);
1000 int journal_start_commit(journal_t *journal, tid_t *tid);
1001 int journal_force_commit_nested(journal_t *journal);
1002 int log_wait_commit(journal_t *journal, tid_t tid);
1003 int log_do_checkpoint(journal_t *journal);
1004 
1005 void __log_wait_for_space(journal_t *journal);
1006 extern void __journal_drop_transaction(journal_t *, transaction_t *);
1007 extern int cleanup_journal_tail(journal_t *);
1008 
1009 /* Debugging code only: */
1010 
1011 #define jbd_ENOSYS() \
1012 do { \
1013  printk (KERN_ERR "JBD unimplemented function %s\n", __FUNCTION__); \
1014  current->state = TASK_UNINTERRUPTIBLE; \
1015  schedule(); \
1016 } while (1)
1017 
1018 /*
1019  * is_journal_abort
1020  *
1021  * Simple test wrapper function to test the JFS_ABORT state flag. This
1022  * bit, when set, indicates that we have had a fatal error somewhere,
1023  * either inside the journaling layer or indicated to us by the client
1024  * (eg. ext3), and that we and should not commit any further
1025  * transactions.
1026  */
1027 
1028 static inline int is_journal_aborted(journal_t *journal)
1029 {
1030  return journal->j_flags & JFS_ABORT;
1031 }
1032 
1033 static inline int is_handle_aborted(handle_t *handle)
1034 {
1035  if (handle->h_aborted)
1036  return 1;
1037  return is_journal_aborted(handle->h_transaction->t_journal);
1038 }
1039 
1040 static inline void journal_abort_handle(handle_t *handle)
1041 {
1042  handle->h_aborted = 1;
1043 }
1044 
1045 #endif /* __KERNEL__ */
1046 
1047 /* Comparison functions for transaction IDs: perform comparisons using
1048  * modulo arithmetic so that they work over sequence number wraps. */
1049 
1050 static inline int tid_gt(tid_t x, tid_t y)
1051 {
1052  int difference = (x - y);
1053  return (difference > 0);
1054 }
1055 
1056 static inline int tid_geq(tid_t x, tid_t y)
1057 {
1058  int difference = (x - y);
1059  return (difference >= 0);
1060 }
1061 
1062 extern int journal_blocks_per_page(struct inode *inode);
1063 
1064 /*
1065  * Return the minimum number of blocks which must be free in the journal
1066  * before a new transaction may be started. Must be called under j_state_lock.
1067  */
1068 static inline int jbd_space_needed(journal_t *journal)
1069 {
1070  int nblocks = journal->j_max_transaction_buffers;
1071  if (journal->j_committing_transaction)
1072  nblocks += journal->j_committing_transaction->
1073  t_outstanding_credits;
1074  return nblocks;
1075 }
1076 
1077 /*
1078  * Definitions which augment the buffer_head layer
1079  */
1080 
1081 /* journaling buffer types */
1082 #define BJ_None 0 /* Not journaled */
1083 #define BJ_SyncData 1 /* Normal data: flush before commit */
1084 #define BJ_Metadata 2 /* Normal journaled metadata */
1085 #define BJ_Forget 3 /* Buffer superseded by this transaction */
1086 #define BJ_IO 4 /* Buffer is for temporary IO use */
1087 #define BJ_Shadow 5 /* Buffer contents being shadowed to the log */
1088 #define BJ_LogCtl 6 /* Buffer contains log descriptors */
1089 #define BJ_Reserved 7 /* Buffer is reserved for access by journal */
1090 #define BJ_Locked 8 /* Locked for I/O during commit */
1091 #define BJ_Types 9
1092 
1093 extern int jbd_blocks_per_page(struct inode *inode);
1094 
1095 #ifdef __KERNEL__
1096 
1097 #define buffer_trace_init(bh) do {} while (0)
1098 #define print_buffer_fields(bh) do {} while (0)
1099 #define print_buffer_trace(bh) do {} while (0)
1100 #define BUFFER_TRACE(bh, info) do {} while (0)
1101 #define BUFFER_TRACE2(bh, bh2, info) do {} while (0)
1102 #define JBUFFER_TRACE(jh, info) do {} while (0)
1103 
1104 #endif /* __KERNEL__ */
1105 
1106 #endif /* _LINUX_JBD_H */
journal_header_t r_header
Definition: jbd.h:201
unsigned __bitwise gfp_t
Definition: types.h:69
__be32 s_dynsuper
Definition: jbd.h:247
__be32 s_feature_incompat
Definition: jbd.h:239
unsigned char __u8
Definition: compat.h:88
void journal_remove_journal_head(struct buffer_head *bh)
Definition: replay.c:432
int __init journal_init_revoke_caches(void)
Definition: revoke.c:170
int journal_update_format(journal_t *journal)
Definition: replay.c:999
struct buffer_head * b_bh
Definition: journal-head.h:21
int journal_test_revoke(journal_t *journal, unsigned long blocknr, tid_t sequence)
Definition: revoke.c:670
void journal_release_buffer(handle_t *handle, struct buffer_head *bh)
Definition: replay.c:1425
__be32 s_errno
Definition: jbd.h:234
struct journal_header_s journal_header_t
void journal_update_superblock(journal_t *journal, int wait)
Definition: replay.c:1030
tid_t
Definition: ieframe.h:311
__be32 s_first
Definition: jbd.h:225
int journal_init_revoke(journal_t *journal, int hash_size)
Definition: revoke.c:201
__be32 h_sequence
Definition: jbd.h:182
void journal_destroy_revoke_caches(void)
Definition: revoke.c:191
__be32 h_blocktype
Definition: jbd.h:181
__be32 s_maxlen
Definition: jbd.h:224
int journal_load(journal_t *journal)
Definition: replay.c:1121
__be32 s_max_transaction
Definition: jbd.h:250
int journal_clear_err(journal_t *journal)
Definition: replay.c:179
static int tid_gt(tid_t x, tid_t y)
Definition: jbd.h:1050
struct journal_superblock_s journal_superblock_t
void * kmem_cache_alloc(kmem_cache_t *kc, int flags)
Definition: linux.c:92
DWORD pid_t
Definition: types.h:91
void * b_private
Definition: module.h:727
GLint GLint GLint GLint GLint x
Definition: gl.h:1548
static void bit_spin_unlock(int bitnum, unsigned long *addr)
Definition: bit_spinlock.h:51
int journal_check_available_features(journal_t *journal, unsigned long compat, unsigned long ro, unsigned long incompat)
Definition: replay.c:767
void journal_abort(journal_t *journal, int err)
Definition: replay.c:143
struct journal_revoke_header_s journal_revoke_header_t
void journal_clear_revoke(journal_t *journal)
Definition: revoke.c:689
Definition: fs.h:78
__be32 s_feature_ro_compat
Definition: jbd.h:240
struct journal_head * journal_get_descriptor_buffer(journal_t *journal)
Definition: replay.c:518
void __journal_unfile_buffer(struct journal_head *jh)
Definition: replay.c:1286
__be32 s_start
Definition: jbd.h:230
int journal_wipe(journal_t *journal, int write)
Definition: replay.c:964
static void bit_spin_lock(int bitnum, unsigned long *addr)
Definition: bit_spinlock.h:10
__be32 t_flags
Definition: jbd.h:192
__be32 h_magic
Definition: jbd.h:180
int jbd_blocks_per_page(struct inode *inode)
int journal_blocks_per_page(struct inode *inode)
Definition: replay.c:207
static PVOID ptr
Definition: dispmode.c:27
static int bit_spin_is_locked(int bitnum, unsigned long *addr)
Definition: bit_spinlock.h:83
smooth NULL
Definition: ftsmooth.c:416
unsigned long b_state
Definition: module.h:715
Definition: module.h:566
void journal_wipe_recovery(journal_t *journal)
Definition: replay.c:659
__be32 t_blocknr
Definition: jbd.h:191
journal_header_t s_header
Definition: jbd.h:219
__u8 s_uuid[16]
Definition: jbd.h:242
GLsizeiptr size
Definition: glext.h:5919
int journal_errno(journal_t *journal)
Definition: replay.c:159
static int tid_geq(tid_t x, tid_t y)
Definition: jbd.h:1056
int log_start_commit(journal_t *journal, tid_t tid)
Definition: replay.c:42
__be32 s_sequence
Definition: jbd.h:229
struct journal_head * journal_grab_journal_head(struct buffer_head *bh)
Definition: replay.c:368
#define BUFFER_FNS(bit, name)
Definition: module.h:742
int __log_start_commit(journal_t *journal, tid_t target)
Definition: replay.c:21
unsigned int __u32
Definition: compat.h:90
__u32 s_padding[44]
Definition: jbd.h:254
UCHAR u8
Definition: btrfs.h:12
int journal_forget(handle_t *handle, struct buffer_head *bh)
Definition: replay.c:1447
GLbitfield flags
Definition: glext.h:7161
int journal_recover(journal_t *journal)
Definition: recovery.c:225
int journal_next_log_block(journal_t *journal, unsigned long *retp)
Definition: replay.c:461
int journal_set_features(journal_t *journal, unsigned long compat, unsigned long ro, unsigned long incompat)
Definition: replay.c:804
void journal_destroy(journal_t *journal)
Definition: replay.c:678
void kmem_cache_free(kmem_cache_t *kc, void *p)
Definition: linux.c:103
struct journal_head * journal_add_journal_head(struct buffer_head *bh)
Definition: replay.c:325
GLenum GLsizei len
Definition: glext.h:6722
__be32 s_feature_compat
Definition: jbd.h:238
int journal_bmap(journal_t *journal, unsigned long blocknr, unsigned long *retp)
Definition: replay.c:484
journal_t * journal_init_inode(struct inode *inode)
Definition: replay.c:592
void journal_ack_err(journal_t *journal)
Definition: replay.c:199
void journal_unfile_buffer(journal_t *journal, struct journal_head *jh)
Definition: replay.c:1292
int journal_check_used_features(journal_t *journal, unsigned long compat, unsigned long ro, unsigned long incompat)
Definition: replay.c:736
__be32 s_blocksize
Definition: jbd.h:223
struct kmem_cache * jbd_handle_cache
Definition: replay.c:1583
void * kmalloc(size_t, int)
__be32 s_nr_users
Definition: jbd.h:245
static int bit_spin_trylock(int bitnum, unsigned long *addr)
Definition: bit_spinlock.h:35
GLuint start
Definition: gl.h:1545
__u32 __bitwise __be32
Definition: types.h:63
__u8 s_users[16 *48]
Definition: jbd.h:257
GLint GLint GLint GLint GLint GLint y
Definition: gl.h:1548
__be32 s_max_trans_data
Definition: jbd.h:251
int journal_skip_recovery(journal_t *journal)
Definition: recovery.c:282
struct transaction_s transaction_t
Definition: journal-head.h:14
struct journal_block_tag_s journal_block_tag_t
static int jbd_space_needed(journal_t *journal)
Definition: jbd.h:1068
void journal_put_journal_head(struct journal_head *jh)
Definition: replay.c:443
#define TAS_BUFFER_FNS(bit, name)
Definition: module.h:759
Definition: module.h:446
void journal_file_buffer(struct journal_head *jh, transaction_t *transaction, int jlist)
Definition: replay.c:1408
static TfClientId tid
void __journal_file_buffer(struct journal_head *jh, transaction_t *transaction, int jlist)
Definition: replay.c:1337
void journal_destroy_revoke(journal_t *journal)
Definition: revoke.c:271
int journal_set_revoke(journal_t *journal, unsigned long blocknr, tid_t sequence)
Definition: revoke.c:646
void kfree(const void *)