1 /*
2 * Copyright (c) 2000-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_H__
19 #define __XFS_BUF_H__
20
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
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
41 typedef 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
47 typedef enum {
48 XBF_READ = (1 << 0), /* buffer intended for reading from device */
49 XBF_WRITE = (1 << 1), /* buffer intended for writing to device */
50 XBF_MAPPED = (1 << 2), /* buffer mapped (b_addr valid) */
51 XBF_ASYNC = (1 << 4), /* initiator will not wait for completion */
52 XBF_DONE = (1 << 5), /* all pages in the buffer uptodate */
53 XBF_DELWRI = (1 << 6), /* buffer has dirty pages */
54 XBF_STALE = (1 << 7), /* buffer has been staled, do not find it */
55 XBF_FS_MANAGED = (1 << 8), /* filesystem controls freeing memory */
56 XBF_ORDERED = (1 << 11), /* use ordered writes */
57 XBF_READ_AHEAD = (1 << 12), /* asynchronous read-ahead */
58
59 /* flags used only as arguments to access routines */
60 XBF_LOCK = (1 << 14), /* lock requested */
61 XBF_TRYLOCK = (1 << 15), /* lock requested, but do not wait */
62 XBF_DONT_BLOCK = (1 << 16), /* do not block in current thread */
63
64 /* flags used only internally */
65 _XBF_PAGE_CACHE = (1 << 17),/* backed by pagecache */
66 _XBF_PAGES = (1 << 18), /* backed by refcounted pages */
67 _XBF_RUN_QUEUES = (1 << 19),/* run block device task queue */
68 _XBF_DELWRI_Q = (1 << 21), /* buffer on delwri queue */
69 } xfs_buf_flags_t;
70
71 typedef enum {
72 XBT_FORCE_SLEEP = 0,
73 XBT_FORCE_FLUSH = 1,
74 } xfs_buftarg_flags_t;
75
76 typedef struct xfs_bufhash {
77 struct list_head bh_list;
78 spinlock_t bh_lock;
79 } xfs_bufhash_t;
80
81 typedef struct xfs_buftarg {
82 dev_t bt_dev;
83 struct block_device *bt_bdev;
84 struct address_space *bt_mapping;
85 unsigned int bt_bsize;
86 unsigned int bt_sshift;
87 size_t bt_smask;
88
89 /* per device buffer hash table */
90 uint bt_hashmask;
91 uint bt_hashshift;
92 xfs_bufhash_t *bt_hash;
93
94 /* per device delwri queue */
95 struct task_struct *bt_task;
96 struct list_head bt_list;
97 struct list_head bt_delwrite_queue;
98 spinlock_t bt_delwrite_lock;
99 unsigned long bt_flags;
100 } xfs_buftarg_t;
101
102 /*
103 * xfs_buf_t: Buffer structure for pagecache-based buffers
104 *
105 * This buffer structure is used by the pagecache buffer management routines
106 * to refer to an assembly of pages forming a logical buffer.
107 *
108 * The buffer structure is used on a temporary basis only, and discarded when
109 * released. The real data storage is recorded in the pagecache. Buffers are
110 * hashed to the block device on which the file system resides.
111 */
112
113 struct xfs_buf;
114 typedef void (*xfs_buf_iodone_t)(struct xfs_buf *);
115 typedef void (*xfs_buf_relse_t)(struct xfs_buf *);
116 typedef int (*xfs_buf_bdstrat_t)(struct xfs_buf *);
117
118 #define XB_PAGES 2
119
120 typedef struct xfs_buf {
121 struct semaphore b_sema; /* semaphore for lockables */
122 unsigned long b_queuetime; /* time buffer was queued */
123 atomic_t b_pin_count; /* pin count */
124 wait_queue_head_t b_waiters; /* unpin waiters */
125 struct list_head b_list;
126 xfs_buf_flags_t b_flags; /* status flags */
127 struct list_head b_hash_list; /* hash table list */
128 xfs_bufhash_t *b_hash; /* hash table list start */
129 xfs_buftarg_t *b_target; /* buffer target (device) */
130 atomic_t b_hold; /* reference count */
131 xfs_daddr_t b_bn; /* block number for I/O */
132 xfs_off_t b_file_offset; /* offset in file */
133 size_t b_buffer_length;/* size of buffer in bytes */
134 size_t b_count_desired;/* desired transfer size */
135 void *b_addr; /* virtual address of buffer */
136 struct work_struct b_iodone_work;
137 atomic_t b_io_remaining; /* #outstanding I/O requests */
138 xfs_buf_iodone_t b_iodone; /* I/O completion function */
139 xfs_buf_relse_t b_relse; /* releasing function */
140 xfs_buf_bdstrat_t b_strat; /* pre-write function */
141 struct semaphore b_iodonesema; /* Semaphore for I/O waiters */
142 void *b_fspriv;
143 void *b_fspriv2;
144 void *b_fspriv3;
145 unsigned short b_error; /* error code on I/O */
146 unsigned int b_page_count; /* size of page array */
147 unsigned int b_offset; /* page offset in first page */
148 struct page **b_pages; /* array of page pointers */
149 struct page *b_page_array[XB_PAGES]; /* inline pages */
150 #ifdef XFS_BUF_LOCK_TRACKING
151 int b_last_holder;
152 #endif
153 } xfs_buf_t;
154
155
156 /* Finding and Reading Buffers */
157 extern xfs_buf_t *_xfs_buf_find(xfs_buftarg_t *, xfs_off_t, size_t,
158 xfs_buf_flags_t, xfs_buf_t *);
159 #define xfs_incore(buftarg,blkno,len,lockit) \
160 _xfs_buf_find(buftarg, blkno ,len, lockit, NULL)
161
162 extern xfs_buf_t *xfs_buf_get_flags(xfs_buftarg_t *, xfs_off_t, size_t,
163 xfs_buf_flags_t);
164 #define xfs_buf_get(target, blkno, len, flags) \
165 xfs_buf_get_flags((target), (blkno), (len), XBF_LOCK | XBF_MAPPED)
166
167 extern xfs_buf_t *xfs_buf_read_flags(xfs_buftarg_t *, xfs_off_t, size_t,
168 xfs_buf_flags_t);
169 #define xfs_buf_read(target, blkno, len, flags) \
170 xfs_buf_read_flags((target), (blkno), (len), XBF_LOCK | XBF_MAPPED)
171
172 extern xfs_buf_t *xfs_buf_get_empty(size_t, xfs_buftarg_t *);
173 extern xfs_buf_t *xfs_buf_get_noaddr(size_t, xfs_buftarg_t *);
174 extern int xfs_buf_associate_memory(xfs_buf_t *, void *, size_t);
175 extern void xfs_buf_hold(xfs_buf_t *);
176 extern void xfs_buf_readahead(xfs_buftarg_t *, xfs_off_t, size_t,
177 xfs_buf_flags_t);
178
179 /* Releasing Buffers */
180 extern void xfs_buf_free(xfs_buf_t *);
181 extern void xfs_buf_rele(xfs_buf_t *);
182
183 /* Locking and Unlocking Buffers */
184 extern int xfs_buf_cond_lock(xfs_buf_t *);
185 extern int xfs_buf_lock_value(xfs_buf_t *);
186 extern void xfs_buf_lock(xfs_buf_t *);
187 extern void xfs_buf_unlock(xfs_buf_t *);
188
189 /* Buffer Read and Write Routines */
190 extern void xfs_buf_ioend(xfs_buf_t *, int);
191 extern void xfs_buf_ioerror(xfs_buf_t *, int);
192 extern int xfs_buf_iostart(xfs_buf_t *, xfs_buf_flags_t);
193 extern int xfs_buf_iorequest(xfs_buf_t *);
194 extern int xfs_buf_iowait(xfs_buf_t *);
195 extern void xfs_buf_iomove(xfs_buf_t *, size_t, size_t, xfs_caddr_t,
196 xfs_buf_rw_t);
197
198 static inline int xfs_buf_iostrategy(xfs_buf_t *bp)
199 {
200 return bp->b_strat ? bp->b_strat(bp) : xfs_buf_iorequest(bp);
201 }
202
203 static inline int xfs_buf_geterror(xfs_buf_t *bp)
204 {
205 return bp ? bp->b_error : ENOMEM;
206 }
207
208 /* Buffer Utility Routines */
209 extern xfs_caddr_t xfs_buf_offset(xfs_buf_t *, size_t);
210
211 /* Pinning Buffer Storage in Memory */
212 extern void xfs_buf_pin(xfs_buf_t *);
213 extern void xfs_buf_unpin(xfs_buf_t *);
214 extern int xfs_buf_ispin(xfs_buf_t *);
215
216 /* Delayed Write Buffer Routines */
217 extern void xfs_buf_delwri_dequeue(xfs_buf_t *);
218
219 /* Buffer Daemon Setup Routines */
220 extern int xfs_buf_init(void);
221 extern void xfs_buf_terminate(void);
222
223 #ifdef XFS_BUF_TRACE
224 extern ktrace_t *xfs_buf_trace_buf;
225 extern void xfs_buf_trace(xfs_buf_t *, char *, void *, void *);
226 #else
227 #define xfs_buf_trace(bp,id,ptr,ra) do { } while (0)
228 #endif
229
230 #define xfs_buf_target_name(target) \
231 ({ char __b[BDEVNAME_SIZE]; bdevname((target)->bt_bdev, __b); __b; })
232
233
234 #define XFS_B_ASYNC XBF_ASYNC
235 #define XFS_B_DELWRI XBF_DELWRI
236 #define XFS_B_READ XBF_READ
237 #define XFS_B_WRITE XBF_WRITE
238 #define XFS_B_STALE XBF_STALE
239
240 #define XFS_BUF_TRYLOCK XBF_TRYLOCK
241 #define XFS_INCORE_TRYLOCK XBF_TRYLOCK
242 #define XFS_BUF_LOCK XBF_LOCK
243 #define XFS_BUF_MAPPED XBF_MAPPED
244
245 #define BUF_BUSY XBF_DONT_BLOCK
246
247 #define XFS_BUF_BFLAGS(bp) ((bp)->b_flags)
248 #define XFS_BUF_ZEROFLAGS(bp) ((bp)->b_flags &= \
249 ~(XBF_READ|XBF_WRITE|XBF_ASYNC|XBF_DELWRI|XBF_ORDERED))
250
251 #define XFS_BUF_STALE(bp) ((bp)->b_flags |= XFS_B_STALE)
252 #define XFS_BUF_UNSTALE(bp) ((bp)->b_flags &= ~XFS_B_STALE)
253 #define XFS_BUF_ISSTALE(bp) ((bp)->b_flags & XFS_B_STALE)
254 #define XFS_BUF_SUPER_STALE(bp) do { \
255 XFS_BUF_STALE(bp); \
256 xfs_buf_delwri_dequeue(bp); \
257 XFS_BUF_DONE(bp); \
258 } while (0)
259
260 #define XFS_BUF_MANAGE XBF_FS_MANAGED
261 #define XFS_BUF_UNMANAGE(bp) ((bp)->b_flags &= ~XBF_FS_MANAGED)
262
263 #define XFS_BUF_DELAYWRITE(bp) ((bp)->b_flags |= XBF_DELWRI)
264 #define XFS_BUF_UNDELAYWRITE(bp) xfs_buf_delwri_dequeue(bp)
265 #define XFS_BUF_ISDELAYWRITE(bp) ((bp)->b_flags & XBF_DELWRI)
266
267 #define XFS_BUF_ERROR(bp,no) xfs_buf_ioerror(bp,no)
268 #define XFS_BUF_GETERROR(bp) xfs_buf_geterror(bp)
269 #define XFS_BUF_ISERROR(bp) (xfs_buf_geterror(bp) ? 1 : 0)
270
271 #define XFS_BUF_DONE(bp) ((bp)->b_flags |= XBF_DONE)
272 #define XFS_BUF_UNDONE(bp) ((bp)->b_flags &= ~XBF_DONE)
273 #define XFS_BUF_ISDONE(bp) ((bp)->b_flags & XBF_DONE)
274
275 #define XFS_BUF_BUSY(bp) do { } while (0)
276 #define XFS_BUF_UNBUSY(bp) do { } while (0)
277 #define XFS_BUF_ISBUSY(bp) (1)
278
279 #define XFS_BUF_ASYNC(bp) ((bp)->b_flags |= XBF_ASYNC)
280 #define XFS_BUF_UNASYNC(bp) ((bp)->b_flags &= ~XBF_ASYNC)
281 #define XFS_BUF_ISASYNC(bp) ((bp)->b_flags & XBF_ASYNC)
282
283 #define XFS_BUF_ORDERED(bp) ((bp)->b_flags |= XBF_ORDERED)
284 #define XFS_BUF_UNORDERED(bp) ((bp)->b_flags &= ~XBF_ORDERED)
285 #define XFS_BUF_ISORDERED(bp) ((bp)->b_flags & XBF_ORDERED)
286
287 #define XFS_BUF_SHUT(bp) do { } while (0)
288 #define XFS_BUF_UNSHUT(bp) do { } while (0)
289 #define XFS_BUF_ISSHUT(bp) (0)
290
291 #define XFS_BUF_HOLD(bp) xfs_buf_hold(bp)
292 #define XFS_BUF_READ(bp) ((bp)->b_flags |= XBF_READ)
293 #define XFS_BUF_UNREAD(bp) ((bp)->b_flags &= ~XBF_READ)
294 #define XFS_BUF_ISREAD(bp) ((bp)->b_flags & XBF_READ)
295
296 #define XFS_BUF_WRITE(bp) ((bp)->b_flags |= XBF_WRITE)
297 #define XFS_BUF_UNWRITE(bp) ((bp)->b_flags &= ~XBF_WRITE)
298 #define XFS_BUF_ISWRITE(bp) ((bp)->b_flags & XBF_WRITE)
299
300 #define XFS_BUF_IODONE_FUNC(bp) ((bp)->b_iodone)
301 #define XFS_BUF_SET_IODONE_FUNC(bp, func) ((bp)->b_iodone = (func))
302 #define XFS_BUF_CLR_IODONE_FUNC(bp) ((bp)->b_iodone = NULL)
303 #define XFS_BUF_SET_BDSTRAT_FUNC(bp, func) ((bp)->b_strat = (func))
304 #define XFS_BUF_CLR_BDSTRAT_FUNC(bp) ((bp)->b_strat = NULL)
305
306 #define XFS_BUF_FSPRIVATE(bp, type) ((type)(bp)->b_fspriv)
307 #define XFS_BUF_SET_FSPRIVATE(bp, val) ((bp)->b_fspriv = (void*)(val))
308 #define XFS_BUF_FSPRIVATE2(bp, type) ((type)(bp)->b_fspriv2)
309 #define XFS_BUF_SET_FSPRIVATE2(bp, val) ((bp)->b_fspriv2 = (void*)(val))
310 #define XFS_BUF_FSPRIVATE3(bp, type) ((type)(bp)->b_fspriv3)
311 #define XFS_BUF_SET_FSPRIVATE3(bp, val) ((bp)->b_fspriv3 = (void*)(val))
312 #define XFS_BUF_SET_START(bp) do { } while (0)
313 #define XFS_BUF_SET_BRELSE_FUNC(bp, func) ((bp)->b_relse = (func))
314
315 #define XFS_BUF_PTR(bp) (xfs_caddr_t)((bp)->b_addr)
316 #define XFS_BUF_SET_PTR(bp, val, cnt) xfs_buf_associate_memory(bp, val, cnt)
317 #define XFS_BUF_ADDR(bp) ((bp)->b_bn)
318 #define XFS_BUF_SET_ADDR(bp, bno) ((bp)->b_bn = (xfs_daddr_t)(bno))
319 #define XFS_BUF_OFFSET(bp) ((bp)->b_file_offset)
320 #define XFS_BUF_SET_OFFSET(bp, off) ((bp)->b_file_offset = (off))
321 #define XFS_BUF_COUNT(bp) ((bp)->b_count_desired)
322 #define XFS_BUF_SET_COUNT(bp, cnt) ((bp)->b_count_desired = (cnt))
323 #define XFS_BUF_SIZE(bp) ((bp)->b_buffer_length)
324 #define XFS_BUF_SET_SIZE(bp, cnt) ((bp)->b_buffer_length = (cnt))
325
326 #define XFS_BUF_SET_VTYPE_REF(bp, type, ref) do { } while (0)
327 #define XFS_BUF_SET_VTYPE(bp, type) do { } while (0)
328 #define XFS_BUF_SET_REF(bp, ref) do { } while (0)
329
330 #define XFS_BUF_ISPINNED(bp) xfs_buf_ispin(bp)
331
332 #define XFS_BUF_VALUSEMA(bp) xfs_buf_lock_value(bp)
333 #define XFS_BUF_CPSEMA(bp) (xfs_buf_cond_lock(bp) == 0)
334 #define XFS_BUF_VSEMA(bp) xfs_buf_unlock(bp)
335 #define XFS_BUF_PSEMA(bp,x) xfs_buf_lock(bp)
336 #define XFS_BUF_V_IODONESEMA(bp) up(&bp->b_iodonesema);
337
338 #define XFS_BUF_SET_TARGET(bp, target) ((bp)->b_target = (target))
339 #define XFS_BUF_TARGET(bp) ((bp)->b_target)
340 #define XFS_BUFTARG_NAME(target) xfs_buf_target_name(target)
341
342 static inline int xfs_bawrite(void *mp, xfs_buf_t *bp)
343 {
344 bp->b_fspriv3 = mp;
345 bp->b_strat = xfs_bdstrat_cb;
346 xfs_buf_delwri_dequeue(bp);
347 return xfs_buf_iostart(bp, XBF_WRITE | XBF_ASYNC | _XBF_RUN_QUEUES);
348 }
349
350 static inline void xfs_buf_relse(xfs_buf_t *bp)
351 {
352 if (!bp->b_relse)
353 xfs_buf_unlock(bp);
354 xfs_buf_rele(bp);
355 }
356
357 #define xfs_bpin(bp) xfs_buf_pin(bp)
358 #define xfs_bunpin(bp) xfs_buf_unpin(bp)
359
360 #define xfs_buftrace(id, bp) \
361 xfs_buf_trace(bp, id, NULL, (void *)__builtin_return_address(0))
362
363 #define xfs_biodone(bp) xfs_buf_ioend(bp, 0)
364
365 #define xfs_biomove(bp, off, len, data, rw) \
366 xfs_buf_iomove((bp), (off), (len), (data), \
367 ((rw) == XFS_B_WRITE) ? XBRW_WRITE : XBRW_READ)
368
369 #define xfs_biozero(bp, off, len) \
370 xfs_buf_iomove((bp), (off), (len), NULL, XBRW_ZERO)
371
372
373 static inline int XFS_bwrite(xfs_buf_t *bp)
374 {
375 int iowait = (bp->b_flags & XBF_ASYNC) == 0;
376 int error = 0;
377
378 if (!iowait)
379 bp->b_flags |= _XBF_RUN_QUEUES;
380
381 xfs_buf_delwri_dequeue(bp);
382 xfs_buf_iostrategy(bp);
383 if (iowait) {
384 error = xfs_buf_iowait(bp);
385 xfs_buf_relse(bp);
386 }
387 return error;
388 }
389
390 static inline int xfs_bdwrite(void *mp, xfs_buf_t *bp)
391 {
392 bp->b_strat = xfs_bdstrat_cb;
393 bp->b_fspriv3 = mp;
394 return xfs_buf_iostart(bp, XBF_DELWRI | XBF_ASYNC);
395 }
396
397 #define XFS_bdstrat(bp) xfs_buf_iorequest(bp)
398
399 #define xfs_iowait(bp) xfs_buf_iowait(bp)
400
401 #define xfs_baread(target, rablkno, ralen) \
402 xfs_buf_readahead((target), (rablkno), (ralen), XBF_DONT_BLOCK)
403
404
405 /*
406 * Handling of buftargs.
407 */
408 extern xfs_buftarg_t *xfs_alloc_buftarg(struct block_device *, int);
409 extern void xfs_free_buftarg(xfs_buftarg_t *, int);
410 extern void xfs_wait_buftarg(xfs_buftarg_t *);
411 extern int xfs_setsize_buftarg(xfs_buftarg_t *, unsigned int, unsigned int);
412 extern int xfs_flush_buftarg(xfs_buftarg_t *, int);
413 #ifdef CONFIG_KDB_MODULES
414 extern struct list_head *xfs_get_buftarg_list(void);
415 #endif
416
417 #define xfs_getsize_buftarg(buftarg) block_size((buftarg)->bt_bdev)
418 #define xfs_readonly_buftarg(buftarg) bdev_read_only((buftarg)->bt_bdev)
419
420 #define xfs_binval(buftarg) xfs_flush_buftarg(buftarg, 1)
421 #define XFS_bflush(buftarg) xfs_flush_buftarg(buftarg, 1)
422
423 #endif /* __XFS_BUF_H__ */
424
|
This page was automatically generated by the
LXR engine.
|