xfs: remove the unused xfs_bufhash structure
[linux-2.6-block.git] / fs / xfs / linux-2.6 / xfs_buf.h
CommitLineData
1da177e4 1/*
7b718769
NS
2 * Copyright (c) 2000-2005 Silicon Graphics, Inc.
3 * All Rights Reserved.
1da177e4 4 *
7b718769
NS
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
1da177e4
LT
7 * published by the Free Software Foundation.
8 *
7b718769
NS
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.
1da177e4 13 *
7b718769
NS
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
1da177e4 17 */
1da177e4
LT
18#ifndef __XFS_BUF_H__
19#define __XFS_BUF_H__
20
1da177e4
LT
21#include <linux/list.h>
22#include <linux/types.h>
23#include <linux/spinlock.h>
24#include <asm/system.h>
25#include <linux/mm.h>
26#include <linux/fs.h>
27#include <linux/buffer_head.h>
28#include <linux/uio.h>
29
30/*
31 * Base types
32 */
33
ce8e922c
NS
34#define XFS_BUF_DADDR_NULL ((xfs_daddr_t) (-1LL))
35
36#define xfs_buf_ctob(pp) ((pp) * PAGE_CACHE_SIZE)
37#define xfs_buf_btoc(dd) (((dd) + PAGE_CACHE_SIZE-1) >> PAGE_CACHE_SHIFT)
38#define xfs_buf_btoct(dd) ((dd) >> PAGE_CACHE_SHIFT)
39#define xfs_buf_poff(aa) ((aa) & ~PAGE_CACHE_MASK)
40
41typedef enum {
42 XBRW_READ = 1, /* transfer into target memory */
43 XBRW_WRITE = 2, /* transfer from target memory */
44 XBRW_ZERO = 3, /* Zero target memory */
45} xfs_buf_rw_t;
46
807cbbdb
CH
47#define XBF_READ (1 << 0) /* buffer intended for reading from device */
48#define XBF_WRITE (1 << 1) /* buffer intended for writing to device */
49#define XBF_MAPPED (1 << 2) /* buffer mapped (b_addr valid) */
50#define XBF_ASYNC (1 << 4) /* initiator will not wait for completion */
51#define XBF_DONE (1 << 5) /* all pages in the buffer uptodate */
52#define XBF_DELWRI (1 << 6) /* buffer has dirty pages */
53#define XBF_STALE (1 << 7) /* buffer has been staled, do not find it */
807cbbdb
CH
54#define XBF_ORDERED (1 << 11)/* use ordered writes */
55#define XBF_READ_AHEAD (1 << 12)/* asynchronous read-ahead */
56#define XBF_LOG_BUFFER (1 << 13)/* this is a buffer used for the log */
1da177e4 57
807cbbdb
CH
58/* flags used only as arguments to access routines */
59#define XBF_LOCK (1 << 14)/* lock requested */
60#define XBF_TRYLOCK (1 << 15)/* lock requested, but do not wait */
61#define XBF_DONT_BLOCK (1 << 16)/* do not block in current thread */
1da177e4 62
807cbbdb 63/* flags used only internally */
807cbbdb
CH
64#define _XBF_PAGES (1 << 18)/* backed by refcounted pages */
65#define _XBF_RUN_QUEUES (1 << 19)/* run block device task queue */
0e6e847f 66#define _XBF_KMEM (1 << 20)/* backed by heap memory */
807cbbdb 67#define _XBF_DELWRI_Q (1 << 21)/* buffer on delwri queue */
6ab455ee 68
807cbbdb 69typedef unsigned int xfs_buf_flags_t;
1da177e4 70
0b1b213f
CH
71#define XFS_BUF_FLAGS \
72 { XBF_READ, "READ" }, \
73 { XBF_WRITE, "WRITE" }, \
74 { XBF_MAPPED, "MAPPED" }, \
75 { XBF_ASYNC, "ASYNC" }, \
76 { XBF_DONE, "DONE" }, \
77 { XBF_DELWRI, "DELWRI" }, \
78 { XBF_STALE, "STALE" }, \
0b1b213f
CH
79 { XBF_ORDERED, "ORDERED" }, \
80 { XBF_READ_AHEAD, "READ_AHEAD" }, \
81 { XBF_LOCK, "LOCK" }, /* should never be set */\
82 { XBF_TRYLOCK, "TRYLOCK" }, /* ditto */\
83 { XBF_DONT_BLOCK, "DONT_BLOCK" }, /* ditto */\
0b1b213f
CH
84 { _XBF_PAGES, "PAGES" }, \
85 { _XBF_RUN_QUEUES, "RUN_QUEUES" }, \
0e6e847f
DC
86 { _XBF_KMEM, "KMEM" }, \
87 { _XBF_DELWRI_Q, "DELWRI_Q" }
0b1b213f 88
ce8e922c 89typedef enum {
5e6a07df
DC
90 XBT_FORCE_SLEEP = 0,
91 XBT_FORCE_FLUSH = 1,
ce8e922c 92} xfs_buftarg_flags_t;
1da177e4 93
1da177e4 94typedef struct xfs_buftarg {
ce8e922c
NS
95 dev_t bt_dev;
96 struct block_device *bt_bdev;
0e6e847f 97 struct backing_dev_info *bt_bdi;
ebad861b 98 struct xfs_mount *bt_mount;
ce8e922c
NS
99 unsigned int bt_bsize;
100 unsigned int bt_sshift;
101 size_t bt_smask;
102
a6867a68
DC
103 /* per device delwri queue */
104 struct task_struct *bt_task;
a6867a68
DC
105 struct list_head bt_delwrite_queue;
106 spinlock_t bt_delwrite_lock;
ce8e922c 107 unsigned long bt_flags;
ff57ab21
DC
108
109 /* LRU control structures */
110 struct shrinker bt_shrinker;
430cbeb8
DC
111 struct list_head bt_lru;
112 spinlock_t bt_lru_lock;
113 unsigned int bt_lru_nr;
1da177e4
LT
114} xfs_buftarg_t;
115
1da177e4 116struct xfs_buf;
ce8e922c 117typedef void (*xfs_buf_iodone_t)(struct xfs_buf *);
1da177e4 118
ce8e922c 119#define XB_PAGES 2
1da177e4
LT
120
121typedef struct xfs_buf {
50f59e8e
DC
122 /*
123 * first cacheline holds all the fields needed for an uncontended cache
124 * hit to be fully processed. The semaphore straddles the cacheline
125 * boundary, but the counter and lock sits on the first cacheline,
126 * which is the only bit that is touched if we hit the semaphore
127 * fast-path on locking.
128 */
129 struct rb_node b_rbnode; /* rbtree node */
130 xfs_off_t b_file_offset; /* offset in file */
131 size_t b_buffer_length;/* size of buffer in bytes */
132 atomic_t b_hold; /* reference count */
430cbeb8 133 atomic_t b_lru_ref; /* lru reclaim ref count */
50f59e8e 134 xfs_buf_flags_t b_flags; /* status flags */
ce8e922c 135 struct semaphore b_sema; /* semaphore for lockables */
50f59e8e 136
430cbeb8 137 struct list_head b_lru; /* lru list */
ce8e922c
NS
138 wait_queue_head_t b_waiters; /* unpin waiters */
139 struct list_head b_list;
74f75a0c 140 struct xfs_perag *b_pag; /* contains rbtree root */
ce8e922c 141 xfs_buftarg_t *b_target; /* buffer target (device) */
ce8e922c 142 xfs_daddr_t b_bn; /* block number for I/O */
ce8e922c
NS
143 size_t b_count_desired;/* desired transfer size */
144 void *b_addr; /* virtual address of buffer */
145 struct work_struct b_iodone_work;
ce8e922c 146 xfs_buf_iodone_t b_iodone; /* I/O completion function */
b4dd330b 147 struct completion b_iowait; /* queue for I/O waiters */
ce8e922c
NS
148 void *b_fspriv;
149 void *b_fspriv2;
ce8e922c
NS
150 struct page **b_pages; /* array of page pointers */
151 struct page *b_page_array[XB_PAGES]; /* inline pages */
50f59e8e
DC
152 unsigned long b_queuetime; /* time buffer was queued */
153 atomic_t b_pin_count; /* pin count */
154 atomic_t b_io_remaining; /* #outstanding I/O requests */
155 unsigned int b_page_count; /* size of page array */
156 unsigned int b_offset; /* page offset in first page */
157 unsigned short b_error; /* error code on I/O */
ce8e922c
NS
158#ifdef XFS_BUF_LOCK_TRACKING
159 int b_last_holder;
1da177e4
LT
160#endif
161} xfs_buf_t;
162
163
164/* Finding and Reading Buffers */
ce8e922c
NS
165extern xfs_buf_t *_xfs_buf_find(xfs_buftarg_t *, xfs_off_t, size_t,
166 xfs_buf_flags_t, xfs_buf_t *);
1da177e4 167#define xfs_incore(buftarg,blkno,len,lockit) \
ce8e922c 168 _xfs_buf_find(buftarg, blkno ,len, lockit, NULL)
1da177e4 169
6ad112bf 170extern xfs_buf_t *xfs_buf_get(xfs_buftarg_t *, xfs_off_t, size_t,
ce8e922c 171 xfs_buf_flags_t);
6ad112bf 172extern xfs_buf_t *xfs_buf_read(xfs_buftarg_t *, xfs_off_t, size_t,
ce8e922c 173 xfs_buf_flags_t);
1da177e4 174
ce8e922c 175extern xfs_buf_t *xfs_buf_get_empty(size_t, xfs_buftarg_t *);
44396476 176extern void xfs_buf_set_empty(struct xfs_buf *bp, size_t len);
686865f7 177extern xfs_buf_t *xfs_buf_get_uncached(struct xfs_buftarg *, size_t, int);
ce8e922c
NS
178extern int xfs_buf_associate_memory(xfs_buf_t *, void *, size_t);
179extern void xfs_buf_hold(xfs_buf_t *);
1a1a3e97 180extern void xfs_buf_readahead(xfs_buftarg_t *, xfs_off_t, size_t);
5adc94c2
DC
181struct xfs_buf *xfs_buf_read_uncached(struct xfs_mount *mp,
182 struct xfs_buftarg *target,
183 xfs_daddr_t daddr, size_t length, int flags);
1da177e4
LT
184
185/* Releasing Buffers */
ce8e922c
NS
186extern void xfs_buf_free(xfs_buf_t *);
187extern void xfs_buf_rele(xfs_buf_t *);
1da177e4
LT
188
189/* Locking and Unlocking Buffers */
ce8e922c
NS
190extern int xfs_buf_cond_lock(xfs_buf_t *);
191extern int xfs_buf_lock_value(xfs_buf_t *);
192extern void xfs_buf_lock(xfs_buf_t *);
193extern void xfs_buf_unlock(xfs_buf_t *);
1da177e4
LT
194
195/* Buffer Read and Write Routines */
64e0bc7d 196extern int xfs_bwrite(struct xfs_mount *mp, struct xfs_buf *bp);
5d765b97 197extern void xfs_bdwrite(void *mp, xfs_buf_t *bp);
4e23471a
CH
198
199extern void xfsbdstrat(struct xfs_mount *, struct xfs_buf *);
200extern int xfs_bdstrat_cb(struct xfs_buf *);
201
ce8e922c
NS
202extern void xfs_buf_ioend(xfs_buf_t *, int);
203extern void xfs_buf_ioerror(xfs_buf_t *, int);
ce8e922c
NS
204extern int xfs_buf_iorequest(xfs_buf_t *);
205extern int xfs_buf_iowait(xfs_buf_t *);
b9c48649 206extern void xfs_buf_iomove(xfs_buf_t *, size_t, size_t, void *,
ce8e922c 207 xfs_buf_rw_t);
1a1a3e97
CH
208#define xfs_buf_zero(bp, off, len) \
209 xfs_buf_iomove((bp), (off), (len), NULL, XBRW_ZERO)
ce8e922c 210
ce8e922c 211static inline int xfs_buf_geterror(xfs_buf_t *bp)
1da177e4 212{
ce8e922c 213 return bp ? bp->b_error : ENOMEM;
1da177e4
LT
214}
215
216/* Buffer Utility Routines */
ce8e922c 217extern xfs_caddr_t xfs_buf_offset(xfs_buf_t *, size_t);
1da177e4 218
1da177e4 219/* Delayed Write Buffer Routines */
ce8e922c 220extern void xfs_buf_delwri_dequeue(xfs_buf_t *);
d808f617 221extern void xfs_buf_delwri_promote(xfs_buf_t *);
1da177e4
LT
222
223/* Buffer Daemon Setup Routines */
ce8e922c
NS
224extern int xfs_buf_init(void);
225extern void xfs_buf_terminate(void);
1da177e4 226
ce8e922c
NS
227#define xfs_buf_target_name(target) \
228 ({ char __b[BDEVNAME_SIZE]; bdevname((target)->bt_bdev, __b); __b; })
1da177e4
LT
229
230
ce8e922c 231#define XFS_BUF_BFLAGS(bp) ((bp)->b_flags)
f5faad79
NS
232#define XFS_BUF_ZEROFLAGS(bp) ((bp)->b_flags &= \
233 ~(XBF_READ|XBF_WRITE|XBF_ASYNC|XBF_DELWRI|XBF_ORDERED))
ce8e922c 234
430cbeb8
DC
235void xfs_buf_stale(struct xfs_buf *bp);
236#define XFS_BUF_STALE(bp) xfs_buf_stale(bp);
0cadda1c
CH
237#define XFS_BUF_UNSTALE(bp) ((bp)->b_flags &= ~XBF_STALE)
238#define XFS_BUF_ISSTALE(bp) ((bp)->b_flags & XBF_STALE)
ce8e922c
NS
239#define XFS_BUF_SUPER_STALE(bp) do { \
240 XFS_BUF_STALE(bp); \
241 xfs_buf_delwri_dequeue(bp); \
242 XFS_BUF_DONE(bp); \
243 } while (0)
1da177e4 244
ce8e922c
NS
245#define XFS_BUF_DELAYWRITE(bp) ((bp)->b_flags |= XBF_DELWRI)
246#define XFS_BUF_UNDELAYWRITE(bp) xfs_buf_delwri_dequeue(bp)
247#define XFS_BUF_ISDELAYWRITE(bp) ((bp)->b_flags & XBF_DELWRI)
248
249#define XFS_BUF_ERROR(bp,no) xfs_buf_ioerror(bp,no)
250#define XFS_BUF_GETERROR(bp) xfs_buf_geterror(bp)
251#define XFS_BUF_ISERROR(bp) (xfs_buf_geterror(bp) ? 1 : 0)
252
253#define XFS_BUF_DONE(bp) ((bp)->b_flags |= XBF_DONE)
254#define XFS_BUF_UNDONE(bp) ((bp)->b_flags &= ~XBF_DONE)
255#define XFS_BUF_ISDONE(bp) ((bp)->b_flags & XBF_DONE)
256
257#define XFS_BUF_BUSY(bp) do { } while (0)
258#define XFS_BUF_UNBUSY(bp) do { } while (0)
259#define XFS_BUF_ISBUSY(bp) (1)
260
261#define XFS_BUF_ASYNC(bp) ((bp)->b_flags |= XBF_ASYNC)
262#define XFS_BUF_UNASYNC(bp) ((bp)->b_flags &= ~XBF_ASYNC)
263#define XFS_BUF_ISASYNC(bp) ((bp)->b_flags & XBF_ASYNC)
264
265#define XFS_BUF_ORDERED(bp) ((bp)->b_flags |= XBF_ORDERED)
266#define XFS_BUF_UNORDERED(bp) ((bp)->b_flags &= ~XBF_ORDERED)
267#define XFS_BUF_ISORDERED(bp) ((bp)->b_flags & XBF_ORDERED)
ce8e922c
NS
268
269#define XFS_BUF_HOLD(bp) xfs_buf_hold(bp)
270#define XFS_BUF_READ(bp) ((bp)->b_flags |= XBF_READ)
271#define XFS_BUF_UNREAD(bp) ((bp)->b_flags &= ~XBF_READ)
272#define XFS_BUF_ISREAD(bp) ((bp)->b_flags & XBF_READ)
273
274#define XFS_BUF_WRITE(bp) ((bp)->b_flags |= XBF_WRITE)
275#define XFS_BUF_UNWRITE(bp) ((bp)->b_flags &= ~XBF_WRITE)
276#define XFS_BUF_ISWRITE(bp) ((bp)->b_flags & XBF_WRITE)
277
ce8e922c
NS
278#define XFS_BUF_IODONE_FUNC(bp) ((bp)->b_iodone)
279#define XFS_BUF_SET_IODONE_FUNC(bp, func) ((bp)->b_iodone = (func))
280#define XFS_BUF_CLR_IODONE_FUNC(bp) ((bp)->b_iodone = NULL)
ce8e922c
NS
281
282#define XFS_BUF_FSPRIVATE(bp, type) ((type)(bp)->b_fspriv)
283#define XFS_BUF_SET_FSPRIVATE(bp, val) ((bp)->b_fspriv = (void*)(val))
284#define XFS_BUF_FSPRIVATE2(bp, type) ((type)(bp)->b_fspriv2)
285#define XFS_BUF_SET_FSPRIVATE2(bp, val) ((bp)->b_fspriv2 = (void*)(val))
ce8e922c 286#define XFS_BUF_SET_START(bp) do { } while (0)
ce8e922c
NS
287
288#define XFS_BUF_PTR(bp) (xfs_caddr_t)((bp)->b_addr)
289#define XFS_BUF_SET_PTR(bp, val, cnt) xfs_buf_associate_memory(bp, val, cnt)
290#define XFS_BUF_ADDR(bp) ((bp)->b_bn)
291#define XFS_BUF_SET_ADDR(bp, bno) ((bp)->b_bn = (xfs_daddr_t)(bno))
292#define XFS_BUF_OFFSET(bp) ((bp)->b_file_offset)
293#define XFS_BUF_SET_OFFSET(bp, off) ((bp)->b_file_offset = (off))
294#define XFS_BUF_COUNT(bp) ((bp)->b_count_desired)
295#define XFS_BUF_SET_COUNT(bp, cnt) ((bp)->b_count_desired = (cnt))
296#define XFS_BUF_SIZE(bp) ((bp)->b_buffer_length)
297#define XFS_BUF_SET_SIZE(bp, cnt) ((bp)->b_buffer_length = (cnt))
298
821eb21d
DC
299static inline void
300xfs_buf_set_ref(
301 struct xfs_buf *bp,
302 int lru_ref)
303{
304 atomic_set(&bp->b_lru_ref, lru_ref);
305}
306#define XFS_BUF_SET_VTYPE_REF(bp, type, ref) xfs_buf_set_ref(bp, ref)
ce8e922c 307#define XFS_BUF_SET_VTYPE(bp, type) do { } while (0)
ce8e922c 308
4d16e924 309#define XFS_BUF_ISPINNED(bp) atomic_read(&((bp)->b_pin_count))
ce8e922c
NS
310
311#define XFS_BUF_VALUSEMA(bp) xfs_buf_lock_value(bp)
312#define XFS_BUF_CPSEMA(bp) (xfs_buf_cond_lock(bp) == 0)
313#define XFS_BUF_VSEMA(bp) xfs_buf_unlock(bp)
314#define XFS_BUF_PSEMA(bp,x) xfs_buf_lock(bp)
b4dd330b 315#define XFS_BUF_FINISH_IOWAIT(bp) complete(&bp->b_iowait);
ce8e922c
NS
316
317#define XFS_BUF_SET_TARGET(bp, target) ((bp)->b_target = (target))
318#define XFS_BUF_TARGET(bp) ((bp)->b_target)
319#define XFS_BUFTARG_NAME(target) xfs_buf_target_name(target)
320
ce8e922c 321static inline void xfs_buf_relse(xfs_buf_t *bp)
1da177e4 322{
bfc60177 323 xfs_buf_unlock(bp);
ce8e922c 324 xfs_buf_rele(bp);
1da177e4
LT
325}
326
1da177e4
LT
327/*
328 * Handling of buftargs.
329 */
ebad861b
DC
330extern xfs_buftarg_t *xfs_alloc_buftarg(struct xfs_mount *,
331 struct block_device *, int, const char *);
c141b292 332extern void xfs_free_buftarg(struct xfs_mount *, struct xfs_buftarg *);
1da177e4
LT
333extern void xfs_wait_buftarg(xfs_buftarg_t *);
334extern int xfs_setsize_buftarg(xfs_buftarg_t *, unsigned int, unsigned int);
1da177e4 335extern int xfs_flush_buftarg(xfs_buftarg_t *, int);
d808f617 336
e6a0e9cd
TS
337#ifdef CONFIG_KDB_MODULES
338extern struct list_head *xfs_get_buftarg_list(void);
339#endif
1da177e4 340
ce8e922c
NS
341#define xfs_getsize_buftarg(buftarg) block_size((buftarg)->bt_bdev)
342#define xfs_readonly_buftarg(buftarg) bdev_read_only((buftarg)->bt_bdev)
343
344#define xfs_binval(buftarg) xfs_flush_buftarg(buftarg, 1)
345#define XFS_bflush(buftarg) xfs_flush_buftarg(buftarg, 1)
1da177e4
LT
346
347#endif /* __XFS_BUF_H__ */