reactos/lib/drivers/oskittcp/include/freebsd/src/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.7 (Berkeley) 1/21/94
  39  */
  40
  41 #ifndef _SYS_BUF_H_
  42 #define _SYS_BUF_H_
  43 #include <sys/queue.h>
  44
  45 #define NOLIST ((struct buf *)0x87654321)
  46
  47 struct buf;
  48
  49 struct iodone_chain {
  50         long    ic_prev_flags;
  51         void    (*ic_prev_iodone) __P((struct buf *));
  52         void    *ic_prev_iodone_chain;
  53         struct {
  54                 long    ia_long;
  55                 void    *ia_ptr;
  56         }       ic_args[5];
  57 };
  58
  59 /*
  60  * The buffer header describes an I/O operation in the kernel.
  61  */
  62 struct buf {
  63         LIST_ENTRY(buf) b_hash;         /* Hash chain. */
  64         LIST_ENTRY(buf) b_vnbufs;       /* Buffer's associated vnode. */
  65         TAILQ_ENTRY(buf) b_freelist;    /* Free list position if not active. */
  66         struct  buf *b_actf, **b_actb;  /* Device driver queue when active. */
  67         struct  proc *b_proc;           /* Associated proc; NULL if kernel. */
  68         volatile long   b_flags;        /* B_* flags. */
  69         int     b_qindex;               /* buffer queue index */
  70         int     b_error;                /* Errno value. */
  71         long    b_bufsize;              /* Allocated buffer size. */
  72         long    b_bcount;               /* Valid bytes in buffer. */
  73         long    b_resid;                /* Remaining I/O. */
  74         dev_t   b_dev;                  /* Device associated with buffer. */
  75         struct {
  76                 caddr_t b_addr;         /* Memory, superblocks, indirect etc. */
  77         } b_un;
  78         void    *b_saveaddr;            /* Original b_addr for physio. */
  79         daddr_t b_lblkno;               /* Logical block number. */
  80         daddr_t b_blkno;                /* Underlying physical block number. */
  81                                         /* Function to call upon completion. */
  82         void    (*b_iodone) __P((struct buf *));
  83                                         /* For nested b_iodone's. */
  84         struct  iodone_chain *b_iodone_chain;
  85         struct  vnode *b_vp;            /* Device vnode. */
  86         int     b_pfcent;               /* Center page when swapping cluster. */
  87         int     b_dirtyoff;             /* Offset in buffer of dirty region. */
  88         int     b_dirtyend;             /* Offset of end of dirty region. */
  89         struct  ucred *b_rcred;         /* Read credentials reference. */
  90         struct  ucred *b_wcred;         /* Write credentials reference. */
  91         int     b_validoff;             /* Offset in buffer of valid region. */
  92         int     b_validend;             /* Offset of end of valid region. */
  93         daddr_t b_pblkno;               /* physical block number */
  94         caddr_t b_savekva;              /* saved kva for transfer while bouncing */
  95         void    *b_driver1;             /* for private use by the driver */
  96         void    *b_driver2;             /* for private use by the driver */
  97         void    *b_spc;
  98         struct  vm_page *b_pages[(MAXPHYS + PAGE_SIZE - 1)/PAGE_SIZE];
  99         int             b_npages;
 100 };
 101
 102 /* Device driver compatibility definitions. */
 103 #define b_active b_bcount               /* Driver queue head: drive active. */
 104 #define b_data   b_un.b_addr            /* b_un.b_addr is not changeable. */
 105 #define b_errcnt b_resid                /* Retry count while I/O in progress. */
 106 #define iodone   biodone                /* Old name for biodone. */
 107 #define iowait   biowait                /* Old name for biowait. */
 108
 109 /*
 110  * These flags are kept in b_flags.
 111  */
 112 #define B_AGE           0x00000001      /* Move to age queue when I/O done. */
 113 #define B_APPENDWRITE   0x00000002      /* Append-write in progress. */
 114 #define B_ASYNC         0x00000004      /* Start I/O, do not wait. */
 115 #define B_BAD           0x00000008      /* Bad block revectoring in progress. */
 116 #define B_BUSY          0x00000010      /* I/O in progress. */
 117 #define B_CACHE         0x00000020      /* Bread found us in the cache. */
 118 #define B_CALL          0x00000040      /* Call b_iodone from biodone. */
 119 #define B_DELWRI        0x00000080      /* Delay I/O until buffer reused. */
 120 #define B_DIRTY         0x00000100      /* Dirty page to be pushed out async. */
 121 #define B_DONE          0x00000200      /* I/O completed. */
 122 #define B_EINTR         0x00000400      /* I/O was interrupted */
 123 #define B_ERROR         0x00000800      /* I/O error occurred. */
 124 #define B_GATHERED      0x00001000      /* LFS: already in a segment. */
 125 #define B_INVAL         0x00002000      /* Does not contain valid info. */
 126 #define B_LOCKED        0x00004000      /* Locked in core (not reusable). */
 127 #define B_NOCACHE       0x00008000      /* Do not cache block after use. */
 128 #define B_MALLOC        0x00010000      /* malloced b_data */
 129 #define B_CLUSTEROK             0x00020000      /* Pagein op, so swap() can count it. */
 130 #define B_PHYS          0x00040000      /* I/O to user memory. */
 131 #define B_RAW           0x00080000      /* Set by physio for raw transfers. */
 132 #define B_READ          0x00100000      /* Read buffer. */
 133 #define B_TAPE          0x00200000      /* Magnetic tape I/O. */
 134 #define B_RELBUF        0x00400000      /* Release VMIO buffer. */
 135 #define B_WANTED        0x00800000      /* Process wants this buffer. */
 136 #define B_WRITE         0x00000000      /* Write buffer (pseudo flag). */
 137 #define B_WRITEINPROG   0x01000000      /* Write in progress. */
 138 #define B_XXX           0x02000000      /* Debugging flag. */
 139 #define B_PAGING        0x04000000      /* volatile paging I/O -- bypass VMIO */
 140 #define B_VMIO          0x20000000      /* VMIO flag */
 141 #define B_CLUSTER       0x40000000      /* pagein op, so swap() can count it */
 142 #define B_BOUNCE        0x80000000      /* bounce buffer flag */
 143
 144 /*
 145  * This structure describes a clustered I/O.  It is stored in the b_saveaddr
 146  * field of the buffer on which I/O is done.  At I/O completion, cluster
 147  * callback uses the structure to parcel I/O's to individual buffers, and
 148  * then free's this structure.
 149  */
 150 struct cluster_save {
 151         long    bs_bcount;              /* Saved b_bcount. */
 152         long    bs_bufsize;             /* Saved b_bufsize. */
 153         void    *bs_saveaddr;           /* Saved b_addr. */
 154         int     bs_nchildren;           /* Number of associated buffers. */
 155         struct buf **bs_children;       /* List of associated buffers. */
 156 };
 157
 158 /*
 159  * number of buffer hash entries
 160  */
 161 #define BUFHSZ 512
 162
 163 /*
 164  * buffer hash table calculation, originally by David Greenman
 165  */
 166 #define BUFHASH(vnp, bn)        \
 167         (&bufhashtbl[(((unsigned long)(vnp) >> 7)+(int)(bn)) % BUFHSZ])
 168
 169 /*
 170  * Definitions for the buffer free lists.
 171  */
 172 #define BUFFER_QUEUES   6       /* number of free buffer queues */
 173
 174 LIST_HEAD(bufhashhdr, buf) bufhashtbl[BUFHSZ], invalhash;
 175 TAILQ_HEAD(bqueues, buf) bufqueues[BUFFER_QUEUES];
 176
 177 #define QUEUE_NONE      0       /* on no queue */
 178 #define QUEUE_LOCKED    1       /* locked buffers */
 179 #define QUEUE_LRU       2       /* useful buffers */
 180 #define QUEUE_VMIO      3       /* VMIO buffers */
 181 #define QUEUE_AGE       4       /* not-useful buffers */
 182 #define QUEUE_EMPTY     5       /* empty buffer headers*/
 183
 184 /*
 185  * Zero out the buffer's data area.
 186  */
 187 #define clrbuf(bp) {                                                    \
 188         blkclr((bp)->b_data, (u_int)(bp)->b_bcount);                    \
 189         (bp)->b_resid = 0;                                              \
 190 }
 191
 192 /* Flags to low-level allocation routines. */
 193 #define B_CLRBUF        0x01    /* Request allocated buffer be cleared. */
 194 #define B_SYNC          0x02    /* Do all allocations synchronously. */
 195
 196 #ifdef KERNEL
 197 extern int      nbuf;                   /* The number of buffer headers */
 198 extern struct   buf *buf;               /* The buffer headers. */
 199 extern char     *buffers;               /* The buffer contents. */
 200 extern int      bufpages;               /* Number of memory pages in the buffer pool. */
 201 extern struct   buf *swbuf;             /* Swap I/O buffer headers. */
 202 extern int      nswbuf;                 /* Number of swap I/O buffer headers. */
 203 extern TAILQ_HEAD(swqueue, buf) bswlist;
 204
 205 __BEGIN_DECLS
 206 void    bufinit __P((void));
 207 void    bremfree __P((struct buf *));
 208 int     bread __P((struct vnode *, daddr_t, int,
 209             struct ucred *, struct buf **));
 210 int     breadn __P((struct vnode *, daddr_t, int, daddr_t *, int *, int,
 211             struct ucred *, struct buf **));
 212 int     bwrite __P((struct buf *));
 213 void    bdwrite __P((struct buf *));
 214 void    bawrite __P((struct buf *));
 215 void    brelse __P((struct buf *));
 216 void    vfs_bio_awrite __P((struct buf *));
 217 struct buf *     getpbuf __P((void));
 218 struct buf *incore __P((struct vnode *, daddr_t));
 219 int     inmem __P((struct vnode *, daddr_t));
 220 struct buf *getblk __P((struct vnode *, daddr_t, int, int, int));
 221 struct buf *geteblk __P((int));
 222 int allocbuf __P((struct buf *, int));
 223 int     biowait __P((struct buf *));
 224 void    biodone __P((struct buf *));
 225
 226 void    cluster_callback __P((struct buf *));
 227 int     cluster_read __P((struct vnode *, u_quad_t, daddr_t, long,
 228             struct ucred *, struct buf **));
 229 void    cluster_wbuild __P((struct vnode *, struct buf *, long, daddr_t, int,
 230             daddr_t));
 231 void    cluster_write __P((struct buf *, u_quad_t));
 232 int     physio __P((void (*)(), struct buf *, dev_t, int, u_int (*)(),
 233             struct uio *));
 234 u_int   minphys __P((struct buf *));
 235 void    vfs_bio_clrbuf __P((struct buf *));
 236 void    vfs_busy_pages __P((struct buf *, int clear_modify));
 237 void    vfs_unbusy_pages(struct buf *);
 238 void    vwakeup __P((struct buf *));
 239 void    vmapbuf __P((struct buf *));
 240 void    vunmapbuf __P((struct buf *));
 241 void    relpbuf __P((struct buf *));
 242 void    brelvp __P((struct buf *));
 243 void    bgetvp __P((struct vnode *, struct buf *));
 244 void    pbgetvp __P((struct vnode *, struct buf *));
 245 void    pbrelvp __P((struct buf *));
 246 void    reassignbuf __P((struct buf *, struct vnode *));
 247 struct  buf *trypbuf __P((void));
 248 void    vm_bounce_alloc __P((struct buf *));
 249 void    vm_bounce_free __P((struct buf *));
 250 vm_offset_t     vm_bounce_kva_alloc __P((int));
 251 void    vm_bounce_kva_alloc_free __P((vm_offset_t, int));
 252 __END_DECLS
 253 #endif
 254 #endif /* !_SYS_BUF_H_ */