]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/sys/buf.h
Major update to the way synchronization is done in the kernel. Highlights
[FreeBSD/FreeBSD.git] / sys / sys / buf.h
1 /*
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.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
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  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *      This product includes software developed by the University of
21  *      California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  *      @(#)buf.h       8.9 (Berkeley) 3/30/95
39  * $FreeBSD$
40  */
41
42 #ifndef _SYS_BUF_H_
43 #define _SYS_BUF_H_
44
45 #include <sys/queue.h>
46 #include <sys/lock.h>
47
48 struct bio;
49 struct buf;
50 struct mount;
51 struct vnode;
52
53 /*
54  * To avoid including <ufs/ffs/softdep.h> 
55  */   
56 LIST_HEAD(workhead, worklist);
57 /*
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
61  * to each buffer.
62  */
63 extern struct bio_ops {
64         void    (*io_start) __P((struct buf *));
65         void    (*io_complete) __P((struct buf *));
66         void    (*io_deallocate) __P((struct buf *));
67         void    (*io_movedeps) __P((struct buf *, struct buf *));
68         int     (*io_countdeps) __P((struct buf *, int));
69 } bioops;
70
71 /*
72  * The buffer header describes an I/O operation in the kernel.
73  *
74  * NOTES:
75  *      b_bufsize, b_bcount.  b_bufsize is the allocation size of the
76  *      buffer, either DEV_BSIZE or PAGE_SIZE aligned.  b_bcount is the
77  *      originally requested buffer size and can serve as a bounds check
78  *      against EOF.  For most, but not all uses, b_bcount == b_bufsize.
79  *
80  *      b_dirtyoff, b_dirtyend.  Buffers support piecemeal, unaligned
81  *      ranges of dirty data that need to be written to backing store.
82  *      The range is typically clipped at b_bcount ( not b_bufsize ).
83  *
84  *      b_resid.  Number of bytes remaining in I/O.  After an I/O operation
85  *      completes, b_resid is usually 0 indicating 100% success.
86  */
87 struct buf {
88         /* XXX: b_io must be the first element of struct buf for now /phk */
89         struct bio b_io;                /* "Builtin" I/O request. */
90 #define b_bcount        b_io.bio_bcount
91 #define b_blkno         b_io.bio_blkno
92 #define b_caller1       b_io.bio_caller1
93 #define b_data          b_io.bio_data
94 #define b_dev           b_io.bio_dev
95 #define b_driver1       b_io.bio_driver1
96 #define b_driver2       b_io.bio_driver2
97 #define b_error         b_io.bio_error
98 #define b_iocmd         b_io.bio_cmd
99 #define b_ioflags       b_io.bio_flags
100 #define b_pblkno        b_io.bio_pblkno
101 #define b_resid         b_io.bio_resid
102         void    (*b_iodone) __P((struct buf *));
103         off_t   b_offset;               /* Offset into file. */
104         LIST_ENTRY(buf) b_hash;         /* Hash chain. */
105         TAILQ_ENTRY(buf) b_vnbufs;      /* Buffer's associated vnode. */
106         TAILQ_ENTRY(buf) b_freelist;    /* Free list position if not active. */
107         TAILQ_ENTRY(buf) b_act;         /* Device driver queue when active. *new* */
108         long    b_flags;                /* B_* flags. */
109         unsigned short b_qindex;        /* buffer queue index */
110         unsigned char b_xflags;         /* extra flags */
111         struct lock b_lock;             /* Buffer lock */
112         long    b_bufsize;              /* Allocated buffer size. */
113         caddr_t b_kvabase;              /* base kva for buffer */
114         int     b_kvasize;              /* size of kva for buffer */
115         daddr_t b_lblkno;               /* Logical block number. */
116         struct  vnode *b_vp;            /* Device vnode. */
117         int     b_dirtyoff;             /* Offset in buffer of dirty region. */
118         int     b_dirtyend;             /* Offset of end of dirty region. */
119         struct  ucred *b_rcred;         /* Read credentials reference. */
120         struct  ucred *b_wcred;         /* Write credentials reference. */
121         void    *b_saveaddr;            /* Original b_addr for physio. */
122         union   pager_info {
123                 void    *pg_spc;
124                 int     pg_reqpage;
125         } b_pager;
126         union   cluster_info {
127                 TAILQ_HEAD(cluster_list_head, buf) cluster_head;
128                 TAILQ_ENTRY(buf) cluster_entry;
129         } b_cluster;
130         struct  vm_page *b_pages[btoc(MAXPHYS)];
131         int             b_npages;
132         struct  workhead b_dep;         /* List of filesystem dependencies. */
133 };
134
135 #define b_spc   b_pager.pg_spc
136
137 /*
138  * These flags are kept in b_flags.
139  *
140  * Notes:
141  *
142  *      B_ASYNC         VOP calls on bp's are usually async whether or not
143  *                      B_ASYNC is set, but some subsystems, such as NFS, like 
144  *                      to know what is best for the caller so they can
145  *                      optimize the I/O.
146  *
147  *      B_PAGING        Indicates that bp is being used by the paging system or
148  *                      some paging system and that the bp is not linked into
149  *                      the b_vp's clean/dirty linked lists or ref counts.
150  *                      Buffer vp reassignments are illegal in this case.
151  *
152  *      B_CACHE         This may only be set if the buffer is entirely valid.
153  *                      The situation where B_DELWRI is set and B_CACHE is
154  *                      clear MUST be committed to disk by getblk() so 
155  *                      B_DELWRI can also be cleared.  See the comments for
156  *                      getblk() in kern/vfs_bio.c.  If B_CACHE is clear,
157  *                      the caller is expected to clear BIO_ERROR and B_INVAL,
158  *                      set BIO_READ, and initiate an I/O.
159  *
160  *                      The 'entire buffer' is defined to be the range from
161  *                      0 through b_bcount.
162  *
163  *      B_MALLOC        Request that the buffer be allocated from the malloc
164  *                      pool, DEV_BSIZE aligned instead of PAGE_SIZE aligned.
165  *
166  *      B_CLUSTEROK     This flag is typically set for B_DELWRI buffers
167  *                      by filesystems that allow clustering when the buffer
168  *                      is fully dirty and indicates that it may be clustered
169  *                      with other adjacent dirty buffers.  Note the clustering
170  *                      may not be used with the stage 1 data write under NFS
171  *                      but may be used for the commit rpc portion.
172  *
173  *      B_VMIO          Indicates that the buffer is tied into an VM object.
174  *                      The buffer's data is always PAGE_SIZE aligned even
175  *                      if b_bufsize and b_bcount are not.  ( b_bufsize is 
176  *                      always at least DEV_BSIZE aligned, though ).
177  *      
178  */
179
180 #define B_AGE           0x00000001      /* Move to age queue when I/O done. */
181 #define B_NEEDCOMMIT    0x00000002      /* Append-write in progress. */
182 #define B_ASYNC         0x00000004      /* Start I/O, do not wait. */
183 #define B_UNUSED0       0x00000008      /* Old B_BAD */
184 #define B_DEFERRED      0x00000010      /* Skipped over for cleaning */
185 #define B_CACHE         0x00000020      /* Bread found us in the cache. */
186 #define B_VALIDSUSPWRT  0x00000040      /* Valid write during suspension. */
187 #define B_DELWRI        0x00000080      /* Delay I/O until buffer reused. */
188 #define B_DONE          0x00000200      /* I/O completed. */
189 #define B_EINTR         0x00000400      /* I/O was interrupted */
190 #define B_00000800      0x00000800      /* Available flag. */
191 #define B_SCANNED       0x00001000      /* VOP_FSYNC funcs mark written bufs */
192 #define B_INVAL         0x00002000      /* Does not contain valid info. */
193 #define B_LOCKED        0x00004000      /* Locked in core (not reusable). */
194 #define B_NOCACHE       0x00008000      /* Do not cache block after use. */
195 #define B_MALLOC        0x00010000      /* malloced b_data */
196 #define B_CLUSTEROK     0x00020000      /* Pagein op, so swap() can count it. */
197 #define B_PHYS          0x00040000      /* I/O to user memory. */
198 #define B_RAW           0x00080000      /* Set by physio for raw transfers. */
199 #define B_DIRTY         0x00200000      /* Needs writing later. */
200 #define B_RELBUF        0x00400000      /* Release VMIO buffer. */
201 #define B_WANT          0x00800000      /* Used by vm_pager.c */
202 #define B_WRITEINPROG   0x01000000      /* Write in progress. */
203 #define B_XXX           0x02000000      /* Debugging flag. */
204 #define B_PAGING        0x04000000      /* volatile paging I/O -- bypass VMIO */
205 #define B_08000000      0x08000000      /* Available flag. */
206 #define B_RAM           0x10000000      /* Read ahead mark (flag) */
207 #define B_VMIO          0x20000000      /* VMIO flag */
208 #define B_CLUSTER       0x40000000      /* pagein op, so swap() can count it */
209 #define B_80000000      0x80000000      /* Available flag. */
210
211 #define PRINT_BUF_FLAGS "\20\40autochain\37cluster\36vmio\35ram\34ordered" \
212         "\33paging\32xxx\31writeinprog\30want\27relbuf\26dirty" \
213         "\25read\24raw\23phys\22clusterok\21malloc\20nocache" \
214         "\17locked\16inval\15scanned\14error\13eintr\12done\11freebuf" \
215         "\10delwri\7call\6cache\4bad\3async\2needcommit\1age"
216
217 /*
218  * These flags are kept in b_xflags.
219  */
220 #define BX_VNDIRTY      0x00000001      /* On vnode dirty list */
221 #define BX_VNCLEAN      0x00000002      /* On vnode clean list */
222 #define BX_BKGRDWRITE   0x00000004      /* Do writes in background */
223 #define BX_BKGRDINPROG  0x00000008      /* Background write in progress */
224 #define BX_BKGRDWAIT    0x00000010      /* Background write waiting */
225
226 #define NOOFFSET        (-1LL)          /* No buffer offset calculated yet */
227
228 #ifdef _KERNEL
229 /*
230  * Buffer locking
231  */
232 extern struct simplelock buftimelock;   /* Interlock on setting prio and timo */
233 extern char *buf_wmesg;                 /* Default buffer lock message */
234 #define BUF_WMESG "bufwait"
235 #include <sys/proc.h>                   /* XXX for curproc */
236 /*
237  * Initialize a lock.
238  */
239 #define BUF_LOCKINIT(bp) \
240         lockinit(&(bp)->b_lock, PRIBIO + 4, buf_wmesg, 0, 0)
241 /*
242  *
243  * Get a lock sleeping non-interruptably until it becomes available.
244  */
245 static __inline int BUF_LOCK __P((struct buf *, int));
246 static __inline int
247 BUF_LOCK(struct buf *bp, int locktype)
248 {
249         int s, ret;
250
251         s = splbio();
252         simple_lock(&buftimelock);
253         locktype |= LK_INTERLOCK;
254         bp->b_lock.lk_wmesg = buf_wmesg;
255         bp->b_lock.lk_prio = PRIBIO + 4;
256         bp->b_lock.lk_timo = 0;
257         ret = lockmgr(&(bp)->b_lock, locktype, &buftimelock, curproc);
258         splx(s);
259         return ret;
260 }
261 /*
262  * Get a lock sleeping with specified interruptably and timeout.
263  */
264 static __inline int BUF_TIMELOCK __P((struct buf *, int, char *, int, int));
265 static __inline int
266 BUF_TIMELOCK(struct buf *bp, int locktype, char *wmesg, int catch, int timo)
267 {
268         int s, ret;
269
270         s = splbio();
271         simple_lock(&buftimelock);
272         locktype |= LK_INTERLOCK;
273         bp->b_lock.lk_wmesg = wmesg;
274         bp->b_lock.lk_prio = (PRIBIO + 4) | catch;
275         bp->b_lock.lk_timo = timo;
276         ret = lockmgr(&(bp)->b_lock, (locktype), &buftimelock, curproc);
277         splx(s);
278         return ret;
279 }
280 /*
281  * Release a lock. Only the acquiring process may free the lock unless
282  * it has been handed off to biodone.
283  */
284 static __inline void BUF_UNLOCK __P((struct buf *));
285 static __inline void
286 BUF_UNLOCK(struct buf *bp)
287 {
288         int s;
289
290         s = splbio();
291         lockmgr(&(bp)->b_lock, LK_RELEASE, NULL, curproc);
292         splx(s);
293 }
294
295 /*
296  * Free a buffer lock.
297  */
298 #define BUF_LOCKFREE(bp)                        \
299         if (BUF_REFCNT(bp) > 0)                 \
300                 panic("free locked buf")
301 /*
302  * When initiating asynchronous I/O, change ownership of the lock to the
303  * kernel. Once done, the lock may legally released by biodone. The
304  * original owning process can no longer acquire it recursively, but must
305  * wait until the I/O is completed and the lock has been freed by biodone.
306  */
307 static __inline void BUF_KERNPROC __P((struct buf *));
308 static __inline void
309 BUF_KERNPROC(struct buf *bp)
310 {
311         struct proc *p = curproc;
312
313         if (p != idleproc && bp->b_lock.lk_lockholder == p->p_pid)
314                 p->p_locks--;
315         bp->b_lock.lk_lockholder = LK_KERNPROC;
316 }
317 /*
318  * Find out the number of references to a lock.
319  */
320 static __inline int BUF_REFCNT __P((struct buf *));
321 static __inline int
322 BUF_REFCNT(struct buf *bp)
323 {
324         int s, ret;
325
326         s = splbio();
327         ret = lockcount(&(bp)->b_lock);
328         splx(s);
329         return ret;
330 }
331
332 #endif /* _KERNEL */
333
334 struct buf_queue_head {
335         TAILQ_HEAD(buf_queue, buf) queue;
336         daddr_t last_pblkno;
337         struct  buf *insert_point;
338         struct  buf *switch_point;
339 };
340
341 /*
342  * This structure describes a clustered I/O.  It is stored in the b_saveaddr
343  * field of the buffer on which I/O is done.  At I/O completion, cluster
344  * callback uses the structure to parcel I/O's to individual buffers, and
345  * then free's this structure.
346  */
347 struct cluster_save {
348         long    bs_bcount;              /* Saved b_bcount. */
349         long    bs_bufsize;             /* Saved b_bufsize. */
350         void    *bs_saveaddr;           /* Saved b_addr. */
351         int     bs_nchildren;           /* Number of associated buffers. */
352         struct buf **bs_children;       /* List of associated buffers. */
353 };
354
355 #ifdef _KERNEL
356 static __inline void bufq_init __P((struct buf_queue_head *head));
357 static __inline void bufq_insert_tail __P((struct buf_queue_head *head,
358                                            struct buf *bp));
359 static __inline void bufq_remove __P((struct buf_queue_head *head,
360                                       struct buf *bp));
361 static __inline struct buf *bufq_first __P((struct buf_queue_head *head));
362
363 static __inline void
364 bufq_init(struct buf_queue_head *head)
365 {
366         TAILQ_INIT(&head->queue);
367         head->last_pblkno = 0;
368         head->insert_point = NULL;
369         head->switch_point = NULL;
370 }
371
372 static __inline void
373 bufq_insert_tail(struct buf_queue_head *head, struct buf *bp)
374 {
375         if ((bp->b_ioflags & BIO_ORDERED) != 0) {
376                 head->insert_point = bp;
377                 head->switch_point = NULL;
378         }
379         TAILQ_INSERT_TAIL(&head->queue, bp, b_act);
380 }
381
382 static __inline void
383 bufq_remove(struct buf_queue_head *head, struct buf *bp)
384 {
385         if (bp == head->switch_point)
386                 head->switch_point = TAILQ_NEXT(bp, b_act);
387         if (bp == head->insert_point) {
388                 head->insert_point = TAILQ_PREV(bp, buf_queue, b_act);
389                 if (head->insert_point == NULL)
390                         head->last_pblkno = 0;
391         } else if (bp == TAILQ_FIRST(&head->queue))
392                 head->last_pblkno = bp->b_pblkno;
393         TAILQ_REMOVE(&head->queue, bp, b_act);
394         if (TAILQ_FIRST(&head->queue) == head->switch_point)
395                 head->switch_point = NULL;
396 }
397
398 static __inline struct buf *
399 bufq_first(struct buf_queue_head *head)
400 {
401         return (TAILQ_FIRST(&head->queue));
402 }
403
404 #define BUF_WRITE(bp)           VOP_BWRITE((bp)->b_vp, (bp))
405 #define BUF_STRATEGY(bp)        VOP_STRATEGY((bp)->b_vp, (bp))
406
407 static __inline void
408 buf_start(struct buf *bp)
409 {
410         if (bioops.io_start)
411                 (*bioops.io_start)(bp);
412 }
413
414 static __inline void
415 buf_complete(struct buf *bp)
416 {
417         if (bioops.io_complete)
418                 (*bioops.io_complete)(bp);
419 }
420
421 static __inline void
422 buf_deallocate(struct buf *bp)
423 {
424         if (bioops.io_deallocate)
425                 (*bioops.io_deallocate)(bp);
426 }
427
428 static __inline void
429 buf_movedeps(struct buf *bp, struct buf *bp2)
430 {
431         if (bioops.io_movedeps)
432                 (*bioops.io_movedeps)(bp, bp2);
433 }
434
435 static __inline int
436 buf_countdeps(struct buf *bp, int i)
437 {
438         if (bioops.io_countdeps)
439                 return ((*bioops.io_countdeps)(bp, i));
440         else
441                 return (0);
442 }
443
444 #endif /* _KERNEL */
445
446 /*
447  * Definitions for the buffer free lists.
448  */
449 #define BUFFER_QUEUES   6       /* number of free buffer queues */
450
451 #define QUEUE_NONE      0       /* on no queue */
452 #define QUEUE_LOCKED    1       /* locked buffers */
453 #define QUEUE_CLEAN     2       /* non-B_DELWRI buffers */
454 #define QUEUE_DIRTY     3       /* B_DELWRI buffers */
455 #define QUEUE_EMPTYKVA  4       /* empty buffer headers w/KVA assignment */
456 #define QUEUE_EMPTY     5       /* empty buffer headers */
457
458 /*
459  * Zero out the buffer's data area.
460  */
461 #define clrbuf(bp) {                                                    \
462         bzero((bp)->b_data, (u_int)(bp)->b_bcount);                     \
463         (bp)->b_resid = 0;                                              \
464 }
465
466 /* Flags to low-level allocation routines. */
467 #define B_CLRBUF        0x01    /* Request allocated buffer be cleared. */
468 #define B_SYNC          0x02    /* Do all allocations synchronously. */
469 #define B_METAONLY      0x04    /* Return indirect block buffer. */
470 #define B_NOWAIT        0x08    /* do not sleep to await lock */
471
472 #ifdef _KERNEL
473 extern int      nbuf;                   /* The number of buffer headers */
474 extern int      buf_maxio;              /* nominal maximum I/O for buffer */
475 extern struct   buf *buf;               /* The buffer headers. */
476 extern char     *buffers;               /* The buffer contents. */
477 extern int      bufpages;               /* Number of memory pages in the buffer pool. */
478 extern struct   buf *swbuf;             /* Swap I/O buffer headers. */
479 extern int      nswbuf;                 /* Number of swap I/O buffer headers. */
480 extern TAILQ_HEAD(swqueue, buf) bswlist;
481 extern TAILQ_HEAD(bqueues, buf) bufqueues[BUFFER_QUEUES];
482
483 struct uio;
484
485 caddr_t bufhashinit __P((caddr_t));
486 void    bufinit __P((void));
487 void    bwillwrite __P((void));
488 void    bremfree __P((struct buf *));
489 int     bread __P((struct vnode *, daddr_t, int,
490             struct ucred *, struct buf **));
491 int     breadn __P((struct vnode *, daddr_t, int, daddr_t *, int *, int,
492             struct ucred *, struct buf **));
493 int     bwrite __P((struct buf *));
494 void    bdwrite __P((struct buf *));
495 void    bawrite __P((struct buf *));
496 void    bdirty __P((struct buf *));
497 void    bundirty __P((struct buf *));
498 int     bowrite __P((struct buf *));
499 void    brelse __P((struct buf *));
500 void    bqrelse __P((struct buf *));
501 int     vfs_bio_awrite __P((struct buf *));
502 struct buf *     getpbuf __P((int *));
503 struct buf *incore __P((struct vnode *, daddr_t));
504 struct buf *gbincore __P((struct vnode *, daddr_t));
505 int     inmem __P((struct vnode *, daddr_t));
506 struct buf *getblk __P((struct vnode *, daddr_t, int, int, int));
507 struct buf *geteblk __P((int));
508 int     bufwait __P((struct buf *));
509 void    bufdone __P((struct buf *));
510 void    bufdonebio __P((struct bio *));
511
512 void    cluster_callback __P((struct buf *));
513 int     cluster_read __P((struct vnode *, u_quad_t, daddr_t, long,
514             struct ucred *, long, int, struct buf **));
515 int     cluster_wbuild __P((struct vnode *, long, daddr_t, int));
516 void    cluster_write __P((struct buf *, u_quad_t, int));
517 void    vfs_bio_set_validclean __P((struct buf *, int base, int size));
518 void    vfs_bio_clrbuf __P((struct buf *));
519 void    vfs_busy_pages __P((struct buf *, int clear_modify));
520 void    vfs_unbusy_pages __P((struct buf *));
521 void    vwakeup __P((struct buf *));
522 void    vmapbuf __P((struct buf *));
523 void    vunmapbuf __P((struct buf *));
524 void    relpbuf __P((struct buf *, int *));
525 void    brelvp __P((struct buf *));
526 void    bgetvp __P((struct vnode *, struct buf *));
527 void    pbgetvp __P((struct vnode *, struct buf *));
528 void    pbrelvp __P((struct buf *));
529 int     allocbuf __P((struct buf *bp, int size));
530 void    reassignbuf __P((struct buf *, struct vnode *));
531 void    pbreassignbuf __P((struct buf *, struct vnode *));
532 struct  buf *trypbuf __P((int *));
533
534 #endif /* _KERNEL */
535
536 #endif /* !_SYS_BUF_H_ */