sys/sys/bio.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_BIO_H_
  43 #define _SYS_BIO_H_
  44
  45 #include <sys/queue.h>
  46
  47 struct disk;
  48 struct bio;
  49
  50 typedef void bio_task_t(struct bio *, void *);
  51
  52 /*
  53  * The bio structure describes an I/O operation in the kernel.
  54  */
  55 struct bio {
  56         u_int   bio_cmd;                /* I/O operation. */
  57         dev_t   bio_dev;                /* Device to do I/O on. */
  58         struct disk *bio_disk;          /* Valid below geom_disk.c only */
  59         daddr_t bio_blkno;              /* Underlying physical block number. */
  60         off_t   bio_offset;             /* Offset into file. */
  61         long    bio_bcount;             /* Valid bytes in buffer. */
  62         caddr_t bio_data;               /* Memory, superblocks, indirect etc. */
  63         u_int   bio_flags;              /* BIO_ flags. */
  64         int     bio_error;              /* Errno for BIO_ERROR. */
  65         long    bio_resid;              /* Remaining I/0 in bytes. */
  66         void    (*bio_done)(struct bio *);
  67         void    *bio_driver1;           /* Private use by the callee. */
  68         void    *bio_driver2;           /* Private use by the callee. */
  69         void    *bio_caller1;           /* Private use by the caller. */
  70         void    *bio_caller2;           /* Private use by the caller. */
  71         TAILQ_ENTRY(bio) bio_queue;     /* Disksort queue. */
  72         const char *bio_attribute;      /* Attribute for BIO_[GS]ETATTR */
  73         struct g_consumer *bio_from;    /* GEOM linkage */
  74         struct g_provider *bio_to;      /* GEOM linkage */
  75         off_t   bio_length;             /* Like bio_bcount */
  76         off_t   bio_completed;          /* Inverse of bio_resid */
  77         u_int   bio_children;           /* Number of spawned bios */
  78         u_int   bio_inbed;              /* Children safely home by now */
  79         struct bio *bio_parent;         /* Pointer to parent */
  80         struct bintime bio_t0;          /* Time request started */
  81
  82         bio_task_t *bio_task;           /* Task_queue handler */
  83         void    *bio_task_arg;          /* Argument to above */
  84
  85         /* XXX: these go away when bio chaining is introduced */
  86         daddr_t bio_pblkno;               /* physical block number */
  87 };
  88
  89 /* bio_cmd */
  90 #define BIO_READ        0x00000001
  91 #define BIO_WRITE       0x00000002
  92 #define BIO_DELETE      0x00000004
  93 #define BIO_GETATTR     0x00000008
  94 #define BIO_CMD1        0x40000000      /* Available for local hacks */
  95 #define BIO_CMD2        0x80000000      /* Available for local hacks */
  96
  97 /* bio_flags */
  98 #define BIO_ERROR       0x00000001
  99 #define BIO_DONE        0x00000004
 100 #define BIO_FLAG2       0x40000000      /* Available for local hacks */
 101 #define BIO_FLAG1       0x80000000      /* Available for local hacks */
 102
 103 #ifdef _KERNEL
 104
 105 struct uio;
 106 struct devstat;
 107
 108 struct bio_queue_head {
 109         TAILQ_HEAD(bio_queue, bio) queue;
 110         daddr_t last_pblkno;
 111         struct  bio *insert_point;
 112         struct  bio *switch_point;
 113 };
 114
 115 void biodone(struct bio *bp);
 116 void biofinish(struct bio *bp, struct devstat *stat, int error);
 117 int biowait(struct bio *bp, const char *wchan);
 118
 119 void bioq_disksort(struct bio_queue_head *ap, struct bio *bp);
 120 struct bio *bioq_first(struct bio_queue_head *head);
 121 void bioq_flush(struct bio_queue_head *head, struct devstat *stp, int error);
 122 void bioq_init(struct bio_queue_head *head);
 123 void bioq_insert_tail(struct bio_queue_head *head, struct bio *bp);
 124 void bioq_remove(struct bio_queue_head *head, struct bio *bp);
 125
 126 int     physio(dev_t dev, struct uio *uio, int ioflag);
 127 #define physread physio
 128 #define physwrite physio
 129
 130 #endif /* _KERNEL */
 131
 132 #endif /* !_SYS_BIO_H_ */