2 * Copyright (c) 1982, 1986, 1989, 1993
3 * The Regents of the University of California. All rights reserved.
4 * (c) UNIX System Laboratories, Inc.
5 * All or some portions of this file are derived from material licensed
6 * to the University of California by American Telephone and Telegraph
7 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8 * the permission of UNIX System Laboratories, Inc.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 4. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * @(#)buf.h 8.9 (Berkeley) 3/30/95
41 #include <sys/bufobj.h>
42 #include <sys/queue.h>
44 #include <sys/lockmgr.h>
54 * To avoid including <ufs/ffs/softdep.h>
56 LIST_HEAD(workhead, worklist);
58 * These are currently used only by the soft dependency code, hence
59 * are stored once in a global variable. If other subsystems wanted
60 * to use these hooks, a pointer to a set of bio_ops could be added
63 extern struct bio_ops {
64 void (*io_start)(struct buf *);
65 void (*io_complete)(struct buf *);
66 void (*io_deallocate)(struct buf *);
67 int (*io_countdeps)(struct buf *, int);
72 typedef unsigned char b_xflags_t;
75 * The buffer header describes an I/O operation in the kernel.
78 * b_bufsize, b_bcount. b_bufsize is the allocation size of the
79 * buffer, either DEV_BSIZE or PAGE_SIZE aligned. b_bcount is the
80 * originally requested buffer size and can serve as a bounds check
81 * against EOF. For most, but not all uses, b_bcount == b_bufsize.
83 * b_dirtyoff, b_dirtyend. Buffers support piecemeal, unaligned
84 * ranges of dirty data that need to be written to backing store.
85 * The range is typically clipped at b_bcount ( not b_bufsize ).
87 * b_resid. Number of bytes remaining in I/O. After an I/O operation
88 * completes, b_resid is usually 0 indicating 100% success.
90 * All fields are protected by the buffer lock except those marked:
91 * V - Protected by owning bufobj lock
92 * Q - Protected by the buf queue lock
93 * D - Protected by an dependency implementation specific lock
96 struct bufobj *b_bufobj;
105 void (*b_iodone)(struct buf *);
106 daddr_t b_blkno; /* Underlying physical block number. */
107 off_t b_offset; /* Offset into file. */
108 TAILQ_ENTRY(buf) b_bobufs; /* (V) Buffer's associated vnode. */
109 uint32_t b_vflags; /* (V) BV_* flags */
110 unsigned short b_qindex; /* (Q) buffer queue index */
111 uint32_t b_flags; /* B_* flags. */
112 b_xflags_t b_xflags; /* extra flags */
113 struct lock b_lock; /* Buffer lock */
114 long b_bufsize; /* Allocated buffer size. */
115 long b_runningbufspace; /* when I/O is running, pipelining */
116 caddr_t b_kvabase; /* base kva for buffer */
117 caddr_t b_kvaalloc; /* allocated kva for B_KVAALLOC */
118 int b_kvasize; /* size of kva for buffer */
119 daddr_t b_lblkno; /* Logical block number. */
120 struct vnode *b_vp; /* Device vnode. */
121 int b_dirtyoff; /* Offset in buffer of dirty region. */
122 int b_dirtyend; /* Offset of end of dirty region. */
123 struct ucred *b_rcred; /* Read credentials reference. */
124 struct ucred *b_wcred; /* Write credentials reference. */
125 void *b_saveaddr; /* Original b_addr for physio. */
127 TAILQ_ENTRY(buf) bu_freelist; /* (Q) */
129 void (*pg_iodone)(void *, vm_page_t *, int, int);
133 #define b_freelist b_union.bu_freelist
134 #define b_pager b_union.bu_pager
136 TAILQ_HEAD(cluster_list_head, buf) cluster_head;
137 TAILQ_ENTRY(buf) cluster_entry;
139 struct vm_page *b_pages[btoc(MAXPHYS)];
141 struct workhead b_dep; /* (D) List of filesystem dependencies. */
148 #define b_object b_bufobj->bo_object
151 * These flags are kept in b_flags.
155 * B_ASYNC VOP calls on bp's are usually async whether or not
156 * B_ASYNC is set, but some subsystems, such as NFS, like
157 * to know what is best for the caller so they can
160 * B_PAGING Indicates that bp is being used by the paging system or
161 * some paging system and that the bp is not linked into
162 * the b_vp's clean/dirty linked lists or ref counts.
163 * Buffer vp reassignments are illegal in this case.
165 * B_CACHE This may only be set if the buffer is entirely valid.
166 * The situation where B_DELWRI is set and B_CACHE is
167 * clear MUST be committed to disk by getblk() so
168 * B_DELWRI can also be cleared. See the comments for
169 * getblk() in kern/vfs_bio.c. If B_CACHE is clear,
170 * the caller is expected to clear BIO_ERROR and B_INVAL,
171 * set BIO_READ, and initiate an I/O.
173 * The 'entire buffer' is defined to be the range from
174 * 0 through b_bcount.
176 * B_MALLOC Request that the buffer be allocated from the malloc
177 * pool, DEV_BSIZE aligned instead of PAGE_SIZE aligned.
179 * B_CLUSTEROK This flag is typically set for B_DELWRI buffers
180 * by filesystems that allow clustering when the buffer
181 * is fully dirty and indicates that it may be clustered
182 * with other adjacent dirty buffers. Note the clustering
183 * may not be used with the stage 1 data write under NFS
184 * but may be used for the commit rpc portion.
186 * B_VMIO Indicates that the buffer is tied into an VM object.
187 * The buffer's data is always PAGE_SIZE aligned even
188 * if b_bufsize and b_bcount are not. ( b_bufsize is
189 * always at least DEV_BSIZE aligned, though ).
191 * B_DIRECT Hint that we should attempt to completely free
192 * the pages underlying the buffer. B_DIRECT is
193 * sticky until the buffer is released and typically
194 * only has an effect when B_RELBUF is also set.
198 #define B_AGE 0x00000001 /* Move to age queue when I/O done. */
199 #define B_NEEDCOMMIT 0x00000002 /* Append-write in progress. */
200 #define B_ASYNC 0x00000004 /* Start I/O, do not wait. */
201 #define B_DIRECT 0x00000008 /* direct I/O flag (pls free vmio) */
202 #define B_DEFERRED 0x00000010 /* Skipped over for cleaning */
203 #define B_CACHE 0x00000020 /* Bread found us in the cache. */
204 #define B_VALIDSUSPWRT 0x00000040 /* Valid write during suspension. */
205 #define B_DELWRI 0x00000080 /* Delay I/O until buffer reused. */
206 #define B_PERSISTENT 0x00000100 /* Perm. ref'ed while EXT2FS mounted. */
207 #define B_DONE 0x00000200 /* I/O completed. */
208 #define B_EINTR 0x00000400 /* I/O was interrupted */
209 #define B_UNMAPPED 0x00000800 /* KVA is not mapped. */
210 #define B_KVAALLOC 0x00001000 /* But allocated. */
211 #define B_INVAL 0x00002000 /* Does not contain valid info. */
212 #define B_BARRIER 0x00004000 /* Write this and all preceeding first. */
213 #define B_NOCACHE 0x00008000 /* Do not cache block after use. */
214 #define B_MALLOC 0x00010000 /* malloced b_data */
215 #define B_CLUSTEROK 0x00020000 /* Pagein op, so swap() can count it. */
216 #define B_000400000 0x00040000 /* Available flag. */
217 #define B_000800000 0x00080000 /* Available flag. */
218 #define B_001000000 0x00100000 /* Available flag. */
219 #define B_DIRTY 0x00200000 /* Needs writing later (in EXT2FS). */
220 #define B_RELBUF 0x00400000 /* Release VMIO buffer. */
221 #define B_FS_FLAG1 0x00800000 /* Available flag for FS use. */
222 #define B_NOCOPY 0x01000000 /* Don't copy-on-write this buf. */
223 #define B_INFREECNT 0x02000000 /* buf is counted in numfreebufs */
224 #define B_PAGING 0x04000000 /* volatile paging I/O -- bypass VMIO */
225 #define B_MANAGED 0x08000000 /* Managed by FS. */
226 #define B_RAM 0x10000000 /* Read ahead mark (flag) */
227 #define B_VMIO 0x20000000 /* VMIO flag */
228 #define B_CLUSTER 0x40000000 /* pagein op, so swap() can count it */
229 #define B_REMFREE 0x80000000 /* Delayed bremfree */
231 #define PRINT_BUF_FLAGS "\20\40remfree\37cluster\36vmio\35ram\34managed" \
232 "\33paging\32infreecnt\31nocopy\30b23\27relbuf\26dirty\25b20" \
233 "\24b19\23b18\22clusterok\21malloc\20nocache\17b14\16inval" \
234 "\15b12\14b11\13eintr\12done\11persist\10delwri\7validsuspwrt" \
235 "\6cache\5deferred\4direct\3async\2needcommit\1age"
238 * These flags are kept in b_xflags.
240 #define BX_VNDIRTY 0x00000001 /* On vnode dirty list */
241 #define BX_VNCLEAN 0x00000002 /* On vnode clean list */
242 #define BX_BKGRDWRITE 0x00000010 /* Do writes in background */
243 #define BX_BKGRDMARKER 0x00000020 /* Mark buffer for splay tree */
244 #define BX_ALTDATA 0x00000040 /* Holds extended data */
246 #define PRINT_BUF_XFLAGS "\20\7altdata\6bkgrdmarker\5bkgrdwrite\2clean\1dirty"
248 #define NOOFFSET (-1LL) /* No buffer offset calculated yet */
251 * These flags are kept in b_vflags.
253 #define BV_SCANNED 0x00000001 /* VOP_FSYNC funcs mark written bufs */
254 #define BV_BKGRDINPROG 0x00000002 /* Background write in progress */
255 #define BV_BKGRDWAIT 0x00000004 /* Background write waiting */
257 #define PRINT_BUF_VFLAGS "\20\3bkgrdwait\2bkgrdinprog\1scanned"
263 extern const char *buf_wmesg; /* Default buffer lock message */
264 #define BUF_WMESG "bufwait"
265 #include <sys/proc.h> /* XXX for curthread */
266 #include <sys/mutex.h>
271 #define BUF_LOCKINIT(bp) \
272 lockinit(&(bp)->b_lock, PRIBIO + 4, buf_wmesg, 0, 0)
275 * Get a lock sleeping non-interruptably until it becomes available.
277 #define BUF_LOCK(bp, locktype, interlock) \
278 _lockmgr_args_rw(&(bp)->b_lock, (locktype), (interlock), \
279 LK_WMESG_DEFAULT, LK_PRIO_DEFAULT, LK_TIMO_DEFAULT, \
280 LOCK_FILE, LOCK_LINE)
283 * Get a lock sleeping with specified interruptably and timeout.
285 #define BUF_TIMELOCK(bp, locktype, interlock, wmesg, catch, timo) \
286 _lockmgr_args_rw(&(bp)->b_lock, (locktype) | LK_TIMELOCK, \
287 (interlock), (wmesg), (PRIBIO + 4) | (catch), (timo), \
288 LOCK_FILE, LOCK_LINE)
291 * Release a lock. Only the acquiring process may free the lock unless
292 * it has been handed off to biodone.
294 #define BUF_UNLOCK(bp) do { \
295 KASSERT(((bp)->b_flags & B_REMFREE) == 0, \
296 ("BUF_UNLOCK %p while B_REMFREE is still set.", (bp))); \
298 (void)_lockmgr_args(&(bp)->b_lock, LK_RELEASE, NULL, \
299 LK_WMESG_DEFAULT, LK_PRIO_DEFAULT, LK_TIMO_DEFAULT, \
300 LOCK_FILE, LOCK_LINE); \
304 * Check if a buffer lock is recursed.
306 #define BUF_LOCKRECURSED(bp) \
307 lockmgr_recursed(&(bp)->b_lock)
310 * Check if a buffer lock is currently held.
312 #define BUF_ISLOCKED(bp) \
313 lockstatus(&(bp)->b_lock)
315 * Free a buffer lock.
317 #define BUF_LOCKFREE(bp) \
318 lockdestroy(&(bp)->b_lock)
321 * Print informations on a buffer lock.
323 #define BUF_LOCKPRINTINFO(bp) \
324 lockmgr_printinfo(&(bp)->b_lock)
327 * Buffer lock assertions.
329 #if defined(INVARIANTS) && defined(INVARIANT_SUPPORT)
330 #define BUF_ASSERT_LOCKED(bp) \
331 _lockmgr_assert(&(bp)->b_lock, KA_LOCKED, LOCK_FILE, LOCK_LINE)
332 #define BUF_ASSERT_SLOCKED(bp) \
333 _lockmgr_assert(&(bp)->b_lock, KA_SLOCKED, LOCK_FILE, LOCK_LINE)
334 #define BUF_ASSERT_XLOCKED(bp) \
335 _lockmgr_assert(&(bp)->b_lock, KA_XLOCKED, LOCK_FILE, LOCK_LINE)
336 #define BUF_ASSERT_UNLOCKED(bp) \
337 _lockmgr_assert(&(bp)->b_lock, KA_UNLOCKED, LOCK_FILE, LOCK_LINE)
338 #define BUF_ASSERT_HELD(bp)
339 #define BUF_ASSERT_UNHELD(bp)
341 #define BUF_ASSERT_LOCKED(bp)
342 #define BUF_ASSERT_SLOCKED(bp)
343 #define BUF_ASSERT_XLOCKED(bp)
344 #define BUF_ASSERT_UNLOCKED(bp)
345 #define BUF_ASSERT_HELD(bp)
346 #define BUF_ASSERT_UNHELD(bp)
349 #ifdef _SYS_PROC_H_ /* Avoid #include <sys/proc.h> pollution */
351 * When initiating asynchronous I/O, change ownership of the lock to the
352 * kernel. Once done, the lock may legally released by biodone. The
353 * original owning process can no longer acquire it recursively, but must
354 * wait until the I/O is completed and the lock has been freed by biodone.
356 #define BUF_KERNPROC(bp) \
357 _lockmgr_disown(&(bp)->b_lock, LOCK_FILE, LOCK_LINE)
361 * Find out if the lock has waiters or not.
363 #define BUF_LOCKWAITERS(bp) \
364 lockmgr_waiters(&(bp)->b_lock)
368 struct buf_queue_head {
369 TAILQ_HEAD(buf_queue, buf) queue;
371 struct buf *insert_point;
372 struct buf *switch_point;
376 * This structure describes a clustered I/O. It is stored in the b_saveaddr
377 * field of the buffer on which I/O is done. At I/O completion, cluster
378 * callback uses the structure to parcel I/O's to individual buffers, and
379 * then free's this structure.
381 struct cluster_save {
382 long bs_bcount; /* Saved b_bcount. */
383 long bs_bufsize; /* Saved b_bufsize. */
384 void *bs_saveaddr; /* Saved b_addr. */
385 int bs_nchildren; /* Number of associated buffers. */
386 struct buf **bs_children; /* List of associated buffers. */
392 bwrite(struct buf *bp)
395 KASSERT(bp->b_bufobj != NULL, ("bwrite: no bufobj bp=%p", bp));
396 KASSERT(bp->b_bufobj->bo_ops != NULL, ("bwrite: no bo_ops bp=%p", bp));
397 KASSERT(bp->b_bufobj->bo_ops->bop_write != NULL,
398 ("bwrite: no bop_write bp=%p", bp));
399 return (BO_WRITE(bp->b_bufobj, bp));
403 bstrategy(struct buf *bp)
406 KASSERT(bp->b_bufobj != NULL, ("bstrategy: no bufobj bp=%p", bp));
407 KASSERT(bp->b_bufobj->bo_ops != NULL,
408 ("bstrategy: no bo_ops bp=%p", bp));
409 KASSERT(bp->b_bufobj->bo_ops->bop_strategy != NULL,
410 ("bstrategy: no bop_strategy bp=%p", bp));
411 BO_STRATEGY(bp->b_bufobj, bp);
415 buf_start(struct buf *bp)
418 (*bioops.io_start)(bp);
422 buf_complete(struct buf *bp)
424 if (bioops.io_complete)
425 (*bioops.io_complete)(bp);
429 buf_deallocate(struct buf *bp)
431 if (bioops.io_deallocate)
432 (*bioops.io_deallocate)(bp);
436 buf_countdeps(struct buf *bp, int i)
438 if (bioops.io_countdeps)
439 return ((*bioops.io_countdeps)(bp, i));
447 * Zero out the buffer's data area.
449 #define clrbuf(bp) { \
450 bzero((bp)->b_data, (u_int)(bp)->b_bcount); \
455 * Flags for getblk's last parameter.
457 #define GB_LOCK_NOWAIT 0x0001 /* Fail if we block on a buf lock. */
458 #define GB_NOCREAT 0x0002 /* Don't create a buf if not found. */
459 #define GB_NOWAIT_BD 0x0004 /* Do not wait for bufdaemon. */
460 #define GB_UNMAPPED 0x0008 /* Do not mmap buffer pages. */
461 #define GB_KVAALLOC 0x0010 /* But allocate KVA. */
464 extern int nbuf; /* The number of buffer headers */
465 extern long maxswzone; /* Max KVA for swap structures */
466 extern long maxbcache; /* Max KVA for buffer cache */
467 extern long runningbufspace;
468 extern long hibufspace;
469 extern int dirtybufthresh;
470 extern int bdwriteskip;
471 extern int dirtybufferflushes;
472 extern int altbufferflushes;
473 extern struct buf *buf; /* The buffer headers. */
474 extern struct buf *swbuf; /* Swap I/O buffer headers. */
475 extern int nswbuf; /* Number of swap I/O buffer headers. */
476 extern int cluster_pbuf_freecnt; /* Number of pbufs for clusters */
477 extern int vnode_pbuf_freecnt; /* Number of pbufs for vnode pager */
478 extern int vnode_async_pbuf_freecnt; /* Number of pbufs for vnode pager,
479 asynchronous reads */
480 extern caddr_t unmapped_buf;
482 void runningbufwakeup(struct buf *);
483 void waitrunningbufspace(void);
484 caddr_t kern_vfs_bio_buffer_alloc(caddr_t v, long physmem_est);
486 void bdata2bio(struct buf *bp, struct bio *bip);
487 void bwillwrite(void);
488 int buf_dirty_count_severe(void);
489 void bremfree(struct buf *);
490 void bremfreef(struct buf *); /* XXX Force bremfree, only for nfs. */
491 #define bread(vp, blkno, size, cred, bpp) \
492 breadn_flags(vp, blkno, size, NULL, NULL, 0, cred, 0, bpp)
493 #define bread_gb(vp, blkno, size, cred, gbflags, bpp) \
494 breadn_flags(vp, blkno, size, NULL, NULL, 0, cred, \
496 #define breadn(vp, blkno, size, rablkno, rabsize, cnt, cred, bpp) \
497 breadn_flags(vp, blkno, size, rablkno, rabsize, cnt, cred, 0, bpp)
498 int breadn_flags(struct vnode *, daddr_t, int, daddr_t *, int *, int,
499 struct ucred *, int, struct buf **);
500 void breada(struct vnode *, daddr_t *, int *, int, struct ucred *);
501 void bdwrite(struct buf *);
502 void bawrite(struct buf *);
503 void babarrierwrite(struct buf *);
504 int bbarrierwrite(struct buf *);
505 void bdirty(struct buf *);
506 void bundirty(struct buf *);
507 void bufstrategy(struct bufobj *, struct buf *);
508 void brelse(struct buf *);
509 void bqrelse(struct buf *);
510 int vfs_bio_awrite(struct buf *);
511 void vfs_drain_busy_pages(struct buf *bp);
512 struct buf * getpbuf(int *);
513 struct buf *incore(struct bufobj *, daddr_t);
514 struct buf *gbincore(struct bufobj *, daddr_t);
515 struct buf *getblk(struct vnode *, daddr_t, int, int, int, int);
516 struct buf *geteblk(int, int);
517 int bufwait(struct buf *);
518 int bufwrite(struct buf *);
519 void bufdone(struct buf *);
520 void bufdone_finish(struct buf *);
521 void bd_speedup(void);
523 int cluster_read(struct vnode *, u_quad_t, daddr_t, long,
524 struct ucred *, long, int, int, struct buf **);
525 int cluster_wbuild(struct vnode *, long, daddr_t, int, int);
526 void cluster_write(struct vnode *, struct buf *, u_quad_t, int, int);
527 void vfs_bio_bzero_buf(struct buf *bp, int base, int size);
528 void vfs_bio_set_valid(struct buf *, int base, int size);
529 void vfs_bio_clrbuf(struct buf *);
530 void vfs_busy_pages(struct buf *, int clear_modify);
531 void vfs_unbusy_pages(struct buf *);
532 int vmapbuf(struct buf *, int);
533 void vunmapbuf(struct buf *);
534 void relpbuf(struct buf *, int *);
535 void brelvp(struct buf *);
536 void bgetvp(struct vnode *, struct buf *);
537 void pbgetbo(struct bufobj *bo, struct buf *bp);
538 void pbgetvp(struct vnode *, struct buf *);
539 void pbrelbo(struct buf *);
540 void pbrelvp(struct buf *);
541 int allocbuf(struct buf *bp, int size);
542 void reassignbuf(struct buf *);
543 struct buf *trypbuf(int *);
544 void bwait(struct buf *, u_char, const char *);
545 void bdone(struct buf *);
546 void bpin(struct buf *);
547 void bunpin(struct buf *);
548 void bunpin_wait(struct buf *);
552 #endif /* !_SYS_BUF_H_ */