xnu-2050.9.2.tar.gz

[apple/xnu.git] / bsd / vfs / vfs_journal.h

diff --git a/bsd/vfs/vfs_journal.h b/bsd/vfs/vfs_journal.h
index e6461cc1a768814eecb4ea1990a32af8a820f6e4..7b7f4f319117e6e65a77a7cfcfb75b7aa6eb269c 100644 (file)
--- a/bsd/vfs/vfs_journal.h
+++ b/bsd/vfs/vfs_journal.h
@@ -1,6 +1,6 @@
 
 /*
 
 /*

- * Copyright (c) 2000-2007 Apple Inc. All rights reserved.
+ * Copyright (c) 2000-2011 Apple Inc. All rights reserved.

  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 


@@ -42,16 +42,24 @@
 
 #include <sys/types.h>
 #include <kern/locks.h>
 
 #include <sys/types.h>
 #include <kern/locks.h>

+#include <sys/disk.h>
+
+
+typedef struct _blk_info {
+    int32_t    bsize;
+    union {
+       int32_t    cksum;
+       uint32_t   sequence_num;
+    } b;
+} _blk_info;

 
 typedef struct block_info {
     off_t       bnum;                // block # on the file system device
 
 typedef struct block_info {
     off_t       bnum;                // block # on the file system device

-    size_t      bsize;               // in bytes

     union {
     union {

-       int32_t     cksum;
-       uint32_t    sequence_num;    // only used in block_list_header->binfo[0]
+       _blk_info   bi;

        struct buf *bp;
        struct buf *bp;

-    } b;
-} block_info;
+    } u;
+} __attribute__((__packed__)) block_info;

 
 typedef struct block_list_header {
     u_int16_t   max_blocks;          // max number of blocks in this chunk
 
 typedef struct block_list_header {
     u_int16_t   max_blocks;          // max number of blocks in this chunk


@@ -68,6 +76,14 @@ typedef struct block_list_header {
 
 struct journal;
 
 
 struct journal;
 

+struct jnl_trim_list {
+       uint32_t        allocated_count;
+       uint32_t        extent_count;
+       dk_extent_t *extents;
+};
+
+typedef void (*jnl_trim_callback_t)(void *arg, uint32_t extent_count, const dk_extent_t *extents);
+

 typedef struct transaction {
     int                 tbuffer_size;  // in bytes
     char               *tbuffer;       // memory copy of the transaction
 typedef struct transaction {
     int                 tbuffer_size;  // in bytes
     char               *tbuffer;       // memory copy of the transaction


@@ -81,6 +97,8 @@ typedef struct transaction {
     struct journal     *jnl;           // ptr back to the journal structure
     struct transaction *next;          // list of tr's (either completed or to be free'd)
     uint32_t            sequence_num;
     struct journal     *jnl;           // ptr back to the journal structure
     struct transaction *next;          // list of tr's (either completed or to be free'd)
     uint32_t            sequence_num;

+       struct jnl_trim_list trim;
+    boolean_t          delayed_header_write;

 } transaction;
 
 
 } transaction;
 
 


@@ -119,6 +137,9 @@ typedef struct journal_header {
  */
 typedef struct journal {
     lck_mtx_t           jlock;             // protects the struct journal data
  */
 typedef struct journal {
     lck_mtx_t           jlock;             // protects the struct journal data

+    lck_mtx_t          flock;             // serializes flushing of journal
+       lck_rw_t            trim_lock;         // protects the async_trim field, below
+

 
     struct vnode       *jdev;              // vnode of the device where the journal lives
     off_t               jdev_offset;       // byte offset to the start of the journal
 
     struct vnode       *jdev;              // vnode of the device where the journal lives
     off_t               jdev_offset;       // byte offset to the start of the journal


@@ -131,10 +152,23 @@ typedef struct journal {
 
     int32_t             flags;
     int32_t             tbuffer_size;      // default transaction buffer size
 
     int32_t             flags;
     int32_t             tbuffer_size;      // default transaction buffer size

-
+    boolean_t          flush_aborted;
+    boolean_t          flushing;
+    boolean_t          asyncIO;
+    boolean_t          writing_header;
+    boolean_t          write_header_failed;
+       
+    struct jnl_trim_list *async_trim;      // extents to be trimmed by transaction being asynchronously flushed
+    jnl_trim_callback_t        trim_callback;
+    void                               *trim_callback_arg;
+    

     char               *header_buf;        // in-memory copy of the journal header
     char               *header_buf;        // in-memory copy of the journal header

+    int32_t             header_buf_size;

     journal_header     *jhdr;              // points to the first byte of header_buf
 
     journal_header     *jhdr;              // points to the first byte of header_buf
 

+       uint32_t                saved_sequence_num;
+       uint32_t                sequence_num;
+

     off_t               max_read_size;
     off_t               max_write_size;
 
     off_t               max_read_size;
     off_t               max_write_size;
 


@@ -159,6 +193,8 @@ typedef struct journal {
 #define JOURNAL_FLUSHCACHE_ERR    0x00040000   // means we already printed this err
 #define JOURNAL_NEED_SWAP         0x00080000   // swap any data read from disk
 #define JOURNAL_DO_FUA_WRITES     0x00100000   // do force-unit-access writes
 #define JOURNAL_FLUSHCACHE_ERR    0x00040000   // means we already printed this err
 #define JOURNAL_NEED_SWAP         0x00080000   // swap any data read from disk
 #define JOURNAL_DO_FUA_WRITES     0x00100000   // do force-unit-access writes

+#define JOURNAL_USE_UNMAP         0x00200000   // device supports UNMAP (TRIM)
+

 
 /* journal_open/create options are always in the low-16 bits */
 #define JOURNAL_OPTION_FLAGS_MASK 0x0000ffff
 
 /* journal_open/create options are always in the low-16 bits */
 #define JOURNAL_OPTION_FLAGS_MASK 0x0000ffff


@@ -276,16 +312,26 @@ void      journal_close(journal *journalp);
  * then call journal_kill_block().  This will mark it so
  * that the journal does not play it back (effectively
  * dropping it).
  * then call journal_kill_block().  This will mark it so
  * that the journal does not play it back (effectively
  * dropping it).

+ *
+ * journal_trim_add_extent() marks a range of bytes on the device which should
+ * be trimmed (invalidated, unmapped).  journal_trim_remove_extent() marks a
+ * range of bytes which should no longer be trimmed.  Accumulated extents
+ * will be trimmed when the transaction is flushed to the on-disk journal.

  */
 int   journal_start_transaction(journal *jnl);
 int   journal_modify_block_start(journal *jnl, struct buf *bp);
 int   journal_modify_block_abort(journal *jnl, struct buf *bp);
 int   journal_modify_block_end(journal *jnl, struct buf *bp, void (*func)(struct buf *bp, void *arg), void *arg);
 int   journal_kill_block(journal *jnl, struct buf *bp);
  */
 int   journal_start_transaction(journal *jnl);
 int   journal_modify_block_start(journal *jnl, struct buf *bp);
 int   journal_modify_block_abort(journal *jnl, struct buf *bp);
 int   journal_modify_block_end(journal *jnl, struct buf *bp, void (*func)(struct buf *bp, void *arg), void *arg);
 int   journal_kill_block(journal *jnl, struct buf *bp);

+#ifdef BSD_KERNEL_PRIVATE
+int   journal_trim_add_extent(journal *jnl, uint64_t offset, uint64_t length);
+int   journal_trim_remove_extent(journal *jnl, uint64_t offset, uint64_t length);
+void  journal_trim_set_callback(journal *jnl, jnl_trim_callback_t callback, void *arg);
+#endif

 int   journal_end_transaction(journal *jnl);
 
 int   journal_active(journal *jnl);
 int   journal_end_transaction(journal *jnl);
 
 int   journal_active(journal *jnl);

-int   journal_flush(journal *jnl);
+int   journal_flush(journal *jnl, boolean_t wait_for_IO);

 void *journal_owner(journal *jnl);    // compare against current_thread()
 int   journal_uses_fua(journal *jnl);
 
 void *journal_owner(journal *jnl);    // compare against current_thread()
 int   journal_uses_fua(journal *jnl);