LXR linux/fs/xfs/xfs_buf

   1/*
   2 * Copyright (c) 2000-2001,2005 Silicon Graphics, Inc.
   3 * All Rights Reserved.
   4 *
   5 * This program is free software; you can redistribute it and/or
   6 * modify it under the terms of the GNU General Public License as
   7 * published by the Free Software Foundation.
   8 *
   9 * This program is distributed in the hope that it would be useful,
  10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 * GNU General Public License for more details.
  13 *
  14 * You should have received a copy of the GNU General Public License
  15 * along with this program; if not, write the Free Software Foundation,
  16 * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17 */
  18#ifndef __XFS_BUF_ITEM_H__
  19#define __XFS_BUF_ITEM_H__
  20
  21extern kmem_zone_t      *xfs_buf_item_zone;
  22
  23/*
  24 * This is the structure used to lay out a buf log item in the
  25 * log.  The data map describes which 128 byte chunks of the buffer
  26 * have been logged.
  27 * For 6.2 and beyond, this is XFS_LI_BUF.  We use this to log everything.
  28 */
  29typedef struct xfs_buf_log_format_t {
  30        unsigned short  blf_type;       /* buf log item type indicator */
  31        unsigned short  blf_size;       /* size of this item */
  32        ushort          blf_flags;      /* misc state */
  33        ushort          blf_len;        /* number of blocks in this buf */
  34        __int64_t       blf_blkno;      /* starting blkno of this buf */
  35        unsigned int    blf_map_size;   /* size of data bitmap in words */
  36        unsigned int    blf_data_map[1];/* variable size bitmap of */
  37                                        /*   regions of buffer in this item */
  38} xfs_buf_log_format_t;
  39
  40/*
  41 * This flag indicates that the buffer contains on disk inodes
  42 * and requires special recovery handling.
  43 */
  44#define XFS_BLI_INODE_BUF       0x1
  45/*
  46 * This flag indicates that the buffer should not be replayed
  47 * during recovery because its blocks are being freed.
  48 */
  49#define XFS_BLI_CANCEL          0x2
  50/*
  51 * This flag indicates that the buffer contains on disk
  52 * user or group dquots and may require special recovery handling.
  53 */
  54#define XFS_BLI_UDQUOT_BUF      0x4
  55#define XFS_BLI_PDQUOT_BUF      0x8
  56#define XFS_BLI_GDQUOT_BUF      0x10
  57
  58#define XFS_BLI_CHUNK           128
  59#define XFS_BLI_SHIFT           7
  60#define BIT_TO_WORD_SHIFT       5
  61#define NBWORD                  (NBBY * sizeof(unsigned int))
  62
  63/*
  64 * buf log item flags
  65 */
  66#define XFS_BLI_HOLD            0x01
  67#define XFS_BLI_DIRTY           0x02
  68#define XFS_BLI_STALE           0x04
  69#define XFS_BLI_LOGGED          0x08
  70#define XFS_BLI_INODE_ALLOC_BUF 0x10
  71#define XFS_BLI_STALE_INODE     0x20
  72
  73
  74#ifdef __KERNEL__
  75
  76struct xfs_buf;
  77struct ktrace;
  78struct xfs_mount;
  79struct xfs_buf_log_item;
  80
  81#if defined(XFS_BLI_TRACE)
  82#define XFS_BLI_TRACE_SIZE      32
  83
  84void    xfs_buf_item_trace(char *, struct xfs_buf_log_item *);
  85#else
  86#define xfs_buf_item_trace(id, bip)
  87#endif
  88
  89/*
  90 * This is the in core log item structure used to track information
  91 * needed to log buffers.  It tracks how many times the lock has been
  92 * locked, and which 128 byte chunks of the buffer are dirty.
  93 */
  94typedef struct xfs_buf_log_item {
  95        xfs_log_item_t          bli_item;       /* common item structure */
  96        struct xfs_buf          *bli_buf;       /* real buffer pointer */
  97        unsigned int            bli_flags;      /* misc flags */
  98        unsigned int            bli_recur;      /* lock recursion count */
  99        atomic_t                bli_refcount;   /* cnt of tp refs */
 100#ifdef XFS_BLI_TRACE
 101        struct ktrace           *bli_trace;     /* event trace buf */
 102#endif
 103#ifdef XFS_TRANS_DEBUG
 104        char                    *bli_orig;      /* original buffer copy */
 105        char                    *bli_logged;    /* bytes logged (bitmap) */
 106#endif
 107        xfs_buf_log_format_t    bli_format;     /* in-log header */
 108} xfs_buf_log_item_t;
 109
 110/*
 111 * This structure is used during recovery to record the buf log
 112 * items which have been canceled and should not be replayed.
 113 */
 114typedef struct xfs_buf_cancel {
 115        xfs_daddr_t             bc_blkno;
 116        uint                    bc_len;
 117        int                     bc_refcount;
 118        struct xfs_buf_cancel   *bc_next;
 119} xfs_buf_cancel_t;
 120
 121void    xfs_buf_item_init(struct xfs_buf *, struct xfs_mount *);
 122void    xfs_buf_item_relse(struct xfs_buf *);
 123void    xfs_buf_item_log(xfs_buf_log_item_t *, uint, uint);
 124uint    xfs_buf_item_dirty(xfs_buf_log_item_t *);
 125void    xfs_buf_attach_iodone(struct xfs_buf *,
 126                              void(*)(struct xfs_buf *, xfs_log_item_t *),
 127                              xfs_log_item_t *);
 128void    xfs_buf_iodone_callbacks(struct xfs_buf *);
 129void    xfs_buf_iodone(struct xfs_buf *, xfs_buf_log_item_t *);
 130
 131#ifdef XFS_TRANS_DEBUG
 132void
 133xfs_buf_item_flush_log_debug(
 134        struct xfs_buf *bp,
 135        uint    first,
 136        uint    last);
 137#else
 138#define xfs_buf_item_flush_log_debug(bp, first, last)
 139#endif
 140
 141#endif  /* __KERNEL__ */
 142
 143#endif  /* __XFS_BUF_ITEM_H__ */
 144