fs/xfs/xfs_buf.h

   1 /*
   2  * Copyright (c) 2000-2003 Silicon Graphics, Inc.  All Rights Reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of version 2 of the GNU General Public License as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it would be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  11  *
  12  * Further, this software is distributed without any warranty that it is
  13  * free of the rightful claim of any third person regarding infringement
  14  * or the like.  Any license provided herein, whether implied or
  15  * otherwise, applies only to this software file.  Patent licenses, if
  16  * any, provided herein do not apply to combinations of this program with
  17  * other software, or any other product whatsoever.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write the Free Software Foundation, Inc., 59
  21  * Temple Place - Suite 330, Boston MA 02111-1307, USA.
  22  *
  23  * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
  24  * Mountain View, CA  94043, or:
  25  *
  26  * http://www.sgi.com
  27  *
  28  * For further information regarding this notice, see:
  29  *
  30  * http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
  31  */
  32 #ifndef __XFS_BUF_H__
  33 #define __XFS_BUF_H__
  34
  35 /* These are just for xfs_syncsub... it sets an internal variable
  36  * then passes it to VOP_FLUSH_PAGES or adds the flags to a newly gotten buf_t
  37  */
  38 #define XFS_B_ASYNC             PBF_ASYNC
  39 #define XFS_B_DELWRI            PBF_DELWRI
  40 #define XFS_B_READ              PBF_READ
  41 #define XFS_B_WRITE             PBF_WRITE
  42 #define XFS_B_STALE             PBF_STALE
  43
  44 #define XFS_BUF_TRYLOCK         PBF_TRYLOCK
  45 #define XFS_INCORE_TRYLOCK      PBF_TRYLOCK
  46 #define XFS_BUF_LOCK            PBF_LOCK
  47 #define XFS_BUF_MAPPED          PBF_MAPPED
  48
  49 #define BUF_BUSY                PBF_DONT_BLOCK
  50
  51 #define XFS_BUF_BFLAGS(x)       ((x)->pb_flags)
  52 #define XFS_BUF_ZEROFLAGS(x)    \
  53         ((x)->pb_flags &= ~(PBF_READ|PBF_WRITE|PBF_ASYNC|PBF_SYNC|PBF_DELWRI))
  54
  55 #define XFS_BUF_STALE(x)        ((x)->pb_flags |= XFS_B_STALE)
  56 #define XFS_BUF_UNSTALE(x)      ((x)->pb_flags &= ~XFS_B_STALE)
  57 #define XFS_BUF_ISSTALE(x)      ((x)->pb_flags & XFS_B_STALE)
  58 #define XFS_BUF_SUPER_STALE(x)  do {                            \
  59                                         XFS_BUF_STALE(x);       \
  60                                         xfs_buf_undelay(x);     \
  61                                         XFS_BUF_DONE(x);        \
  62                                 } while (0)
  63
  64 #define XFS_BUF_MANAGE          PBF_FS_MANAGED
  65 #define XFS_BUF_UNMANAGE(x)     ((x)->pb_flags &= ~PBF_FS_MANAGED)
  66
  67 static inline void xfs_buf_undelay(page_buf_t *pb)
  68 {
  69         if (pb->pb_flags & PBF_DELWRI) {
  70                 if (pb->pb_list.next != &pb->pb_list) {
  71                         pagebuf_delwri_dequeue(pb);
  72                         pagebuf_rele(pb);
  73                 } else {
  74                         pb->pb_flags &= ~PBF_DELWRI;
  75                 }
  76         }
  77 }
  78
  79 #define XFS_BUF_DELAYWRITE(x)    ((x)->pb_flags |= PBF_DELWRI)
  80 #define XFS_BUF_UNDELAYWRITE(x)  xfs_buf_undelay(x)
  81 #define XFS_BUF_ISDELAYWRITE(x)  ((x)->pb_flags & PBF_DELWRI)
  82
  83 #define XFS_BUF_ERROR(x,no)      pagebuf_ioerror(x,no)
  84 #define XFS_BUF_GETERROR(x)      pagebuf_geterror(x)
  85 #define XFS_BUF_ISERROR(x)       (pagebuf_geterror(x)?1:0)
  86
  87 #define XFS_BUF_DONE(x)          ((x)->pb_flags &= ~(PBF_PARTIAL|PBF_NONE))
  88 #define XFS_BUF_UNDONE(x)        ((x)->pb_flags |= PBF_PARTIAL|PBF_NONE)
  89 #define XFS_BUF_ISDONE(x)        (!(PBF_NOT_DONE(x)))
  90
  91 #define XFS_BUF_BUSY(x)          ((x)->pb_flags |= PBF_FORCEIO)
  92 #define XFS_BUF_UNBUSY(x)        ((x)->pb_flags &= ~PBF_FORCEIO)
  93 #define XFS_BUF_ISBUSY(x)        (1)
  94
  95 #define XFS_BUF_ASYNC(x)         ((x)->pb_flags |= PBF_ASYNC)
  96 #define XFS_BUF_UNASYNC(x)       ((x)->pb_flags &= ~PBF_ASYNC)
  97 #define XFS_BUF_ISASYNC(x)       ((x)->pb_flags & PBF_ASYNC)
  98
  99 #define XFS_BUF_FLUSH(x)         ((x)->pb_flags |= PBF_FLUSH)
 100 #define XFS_BUF_UNFLUSH(x)       ((x)->pb_flags &= ~PBF_FLUSH)
 101 #define XFS_BUF_ISFLUSH(x)       ((x)->pb_flags & PBF_FLUSH)
 102
 103 #define XFS_BUF_SHUT(x)          printk("XFS_BUF_SHUT not implemented yet\n")
 104 #define XFS_BUF_UNSHUT(x)        printk("XFS_BUF_UNSHUT not implemented yet\n")
 105 #define XFS_BUF_ISSHUT(x)        (0)
 106
 107 #define XFS_BUF_HOLD(x)         pagebuf_hold(x)
 108 #define XFS_BUF_READ(x)         ((x)->pb_flags |= PBF_READ)
 109 #define XFS_BUF_UNREAD(x)       ((x)->pb_flags &= ~PBF_READ)
 110 #define XFS_BUF_ISREAD(x)       ((x)->pb_flags & PBF_READ)
 111
 112 #define XFS_BUF_WRITE(x)        ((x)->pb_flags |= PBF_WRITE)
 113 #define XFS_BUF_UNWRITE(x)      ((x)->pb_flags &= ~PBF_WRITE)
 114 #define XFS_BUF_ISWRITE(x)      ((x)->pb_flags & PBF_WRITE)
 115
 116 #define XFS_BUF_ISUNINITIAL(x)   (0)
 117 #define XFS_BUF_UNUNINITIAL(x)   (0)
 118
 119 #define XFS_BUF_BP_ISMAPPED(bp)  1
 120
 121 typedef struct page_buf_s xfs_buf_t;
 122 #define xfs_buf page_buf_s
 123
 124 typedef struct pb_target xfs_buftarg_t;
 125 #define xfs_buftarg pb_target
 126
 127 #define XFS_BUF_DATAIO(x)       ((x)->pb_flags |= PBF_FS_DATAIOD)
 128 #define XFS_BUF_UNDATAIO(x)     ((x)->pb_flags &= ~PBF_FS_DATAIOD)
 129
 130 #define XFS_BUF_IODONE_FUNC(buf)        (buf)->pb_iodone
 131 #define XFS_BUF_SET_IODONE_FUNC(buf, func)      \
 132                         (buf)->pb_iodone = (func)
 133 #define XFS_BUF_CLR_IODONE_FUNC(buf)            \
 134                         (buf)->pb_iodone = NULL
 135 #define XFS_BUF_SET_BDSTRAT_FUNC(buf, func)     \
 136                         (buf)->pb_strat = (func)
 137 #define XFS_BUF_CLR_BDSTRAT_FUNC(buf)           \
 138                         (buf)->pb_strat = NULL
 139
 140 #define XFS_BUF_FSPRIVATE(buf, type)            \
 141                         ((type)(buf)->pb_fspriv)
 142 #define XFS_BUF_SET_FSPRIVATE(buf, value)       \
 143                         (buf)->pb_fspriv = (void *)(value)
 144 #define XFS_BUF_FSPRIVATE2(buf, type)           \
 145                         ((type)(buf)->pb_fspriv2)
 146 #define XFS_BUF_SET_FSPRIVATE2(buf, value)      \
 147                         (buf)->pb_fspriv2 = (void *)(value)
 148 #define XFS_BUF_FSPRIVATE3(buf, type)           \
 149                         ((type)(buf)->pb_fspriv3)
 150 #define XFS_BUF_SET_FSPRIVATE3(buf, value)      \
 151                         (buf)->pb_fspriv3  = (void *)(value)
 152 #define XFS_BUF_SET_START(buf)
 153
 154 #define XFS_BUF_SET_BRELSE_FUNC(buf, value) \
 155                         (buf)->pb_relse = (value)
 156
 157 #define XFS_BUF_PTR(bp)         (xfs_caddr_t)((bp)->pb_addr)
 158
 159 extern inline xfs_caddr_t xfs_buf_offset(page_buf_t *bp, size_t offset)
 160 {
 161         if (bp->pb_flags & PBF_MAPPED)
 162                 return XFS_BUF_PTR(bp) + offset;
 163         return (xfs_caddr_t) pagebuf_offset(bp, offset);
 164 }
 165
 166 #define XFS_BUF_SET_PTR(bp, val, count)         \
 167                                 pagebuf_associate_memory(bp, val, count)
 168 #define XFS_BUF_ADDR(bp)        ((bp)->pb_bn)
 169 #define XFS_BUF_SET_ADDR(bp, blk)               \
 170                         ((bp)->pb_bn = (page_buf_daddr_t)(blk))
 171 #define XFS_BUF_OFFSET(bp)      ((bp)->pb_file_offset)
 172 #define XFS_BUF_SET_OFFSET(bp, off)             \
 173                         ((bp)->pb_file_offset = (off))
 174 #define XFS_BUF_COUNT(bp)       ((bp)->pb_count_desired)
 175 #define XFS_BUF_SET_COUNT(bp, cnt)              \
 176                         ((bp)->pb_count_desired = (cnt))
 177 #define XFS_BUF_SIZE(bp)        ((bp)->pb_buffer_length)
 178 #define XFS_BUF_SET_SIZE(bp, cnt)               \
 179                         ((bp)->pb_buffer_length = (cnt))
 180 #define XFS_BUF_SET_VTYPE_REF(bp, type, ref)
 181 #define XFS_BUF_SET_VTYPE(bp, type)
 182 #define XFS_BUF_SET_REF(bp, ref)
 183
 184 #define XFS_BUF_ISPINNED(bp)   pagebuf_ispin(bp)
 185
 186 #define XFS_BUF_VALUSEMA(bp)    pagebuf_lock_value(bp)
 187 #define XFS_BUF_CPSEMA(bp)      (pagebuf_cond_lock(bp) == 0)
 188 #define XFS_BUF_VSEMA(bp)       pagebuf_unlock(bp)
 189 #define XFS_BUF_PSEMA(bp,x)     pagebuf_lock(bp)
 190 #define XFS_BUF_V_IODONESEMA(bp) up(&bp->pb_iodonesema);
 191
 192 /* setup the buffer target from a buftarg structure */
 193 #define XFS_BUF_SET_TARGET(bp, target)  \
 194         (bp)->pb_target = (target)
 195
 196 #define XFS_BUF_TARGET(bp)      ((bp)->pb_target)
 197 #define XFS_BUF_TARGET_DEV(bp)  ((bp)->pb_target->pbr_dev)
 198 #define XFS_BUF_SET_VTYPE_REF(bp, type, ref)
 199 #define XFS_BUF_SET_VTYPE(bp, type)
 200 #define XFS_BUF_SET_REF(bp, ref)
 201
 202 #define xfs_buf_read(target, blkno, len, flags) \
 203                 pagebuf_get((target), (blkno), (len), \
 204                         PBF_LOCK | PBF_READ | PBF_MAPPED | PBF_MAPPABLE)
 205 #define xfs_buf_get(target, blkno, len, flags) \
 206                 pagebuf_get((target), (blkno), (len), \
 207                         PBF_LOCK | PBF_MAPPED | PBF_MAPPABLE)
 208
 209 #define xfs_buf_read_flags(target, blkno, len, flags) \
 210                 pagebuf_get((target), (blkno), (len), \
 211                         PBF_READ | PBF_MAPPABLE | flags)
 212 #define xfs_buf_get_flags(target, blkno, len, flags) \
 213                 pagebuf_get((target), (blkno), (len), \
 214                         PBF_MAPPABLE | flags)
 215
 216 static inline int       xfs_bawrite(void *mp, page_buf_t *bp)
 217 {
 218         int ret;
 219
 220         bp->pb_fspriv3 = mp;
 221         bp->pb_strat = xfs_bdstrat_cb;
 222         xfs_buf_undelay(bp);
 223         if ((ret = pagebuf_iostart(bp, PBF_WRITE | PBF_ASYNC)) == 0)
 224                 pagebuf_run_queues(bp);
 225         return ret;
 226 }
 227
 228 static inline void      xfs_buf_relse(page_buf_t *bp)
 229 {
 230         if ((bp->pb_flags & _PBF_LOCKABLE) && !bp->pb_relse)
 231                 pagebuf_unlock(bp);
 232
 233         pagebuf_rele(bp);
 234 }
 235
 236
 237 #define xfs_bpin(bp)            pagebuf_pin(bp)
 238 #define xfs_bunpin(bp)          pagebuf_unpin(bp)
 239
 240 #ifdef PAGEBUF_TRACE
 241 # define PB_DEFINE_TRACES
 242 # include <pagebuf/page_buf_trace.h>
 243 # define xfs_buftrace(id, bp)   PB_TRACE(bp, PB_TRACE_REC(external), (void *)id)
 244 #else
 245 # define xfs_buftrace(id, bp)   do { } while (0)
 246 #endif
 247
 248
 249 #define xfs_biodone(pb)             \
 250             pagebuf_iodone(pb, (pb->pb_flags & PBF_FS_DATAIOD), 0)
 251
 252 #define xfs_incore(buftarg,blkno,len,lockit) \
 253             pagebuf_find(buftarg, blkno ,len, lockit)
 254
 255
 256 #define xfs_biomove(pb, off, len, data, rw) \
 257             pagebuf_iomove((pb), (off), (len), (data), \
 258                 ((rw) == XFS_B_WRITE) ? PBRW_WRITE : PBRW_READ)
 259
 260 #define xfs_biozero(pb, off, len) \
 261             pagebuf_iomove((pb), (off), (len), NULL, PBRW_ZERO)
 262
 263
 264 static inline int       XFS_bwrite(page_buf_t *pb)
 265 {
 266         int     sync = (pb->pb_flags & PBF_ASYNC) == 0;
 267         int     error;
 268
 269         pb->pb_flags |= PBF_SYNC;
 270
 271         xfs_buf_undelay(pb);
 272
 273         __pagebuf_iorequest(pb);
 274
 275         if (sync) {
 276                 error = pagebuf_iowait(pb);
 277                 xfs_buf_relse(pb);
 278         } else {
 279                 pagebuf_run_queues(pb);
 280                 error = 0;
 281         }
 282
 283         return error;
 284 }
 285
 286 #define XFS_bdwrite(pb)              \
 287             pagebuf_iostart(pb, PBF_DELWRI | PBF_ASYNC)
 288
 289 static inline int xfs_bdwrite(void *mp, page_buf_t *bp)
 290 {
 291         bp->pb_strat = xfs_bdstrat_cb;
 292         bp->pb_fspriv3 = mp;
 293
 294         return pagebuf_iostart(bp, PBF_DELWRI | PBF_ASYNC);
 295 }
 296
 297 #define XFS_bdstrat(bp) pagebuf_iorequest(bp)
 298
 299 #define xfs_iowait(pb)  pagebuf_iowait(pb)
 300
 301
 302 /*
 303  * Go through all incore buffers, and release buffers
 304  * if they belong to the given device. This is used in
 305  * filesystem error handling to preserve the consistency
 306  * of its metadata.
 307  */
 308
 309 #define xfs_binval(buftarg)     xfs_flush_buftarg(buftarg)
 310
 311 #define XFS_bflush(buftarg)     xfs_flush_buftarg(buftarg)
 312
 313 #define xfs_incore_relse(buftarg,delwri_only,wait)      \
 314         xfs_relse_buftarg(buftarg)
 315
 316 #define xfs_baread(target, rablkno, ralen)  \
 317         pagebuf_readahead((target), (rablkno), (ralen), PBF_DONT_BLOCK)
 318
 319 #define XFS_getrbuf(sleep,mp)   \
 320         pagebuf_get_empty((mp)->m_ddev_targp)
 321 #define XFS_ngetrbuf(len,mp)    \
 322         pagebuf_get_no_daddr(len,(mp)->m_ddev_targp)
 323 #define XFS_freerbuf(bp)        pagebuf_free(bp)
 324 #define XFS_nfreerbuf(bp)       pagebuf_free(bp)
 325
 326 #endif