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. 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. 21 * 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 32 * SUCH DAMAGE. 33 * 34 * @(#)buf.h 8.9 (Berkeley) 3/30/95 35 * $FreeBSD$ 36 */ 37 38 #ifndef _SYS_BIO_H_ 39 #define _SYS_BIO_H_ 40 41 #include <sys/queue.h> 42 #include <sys/disk_zone.h> 43 44 /* bio_cmd */ 45 #define BIO_READ 0x01 /* Read I/O data */ 46 #define BIO_WRITE 0x02 /* Write I/O data */ 47 #define BIO_DELETE 0x03 /* TRIM or free blocks, i.e. mark as unused */ 48 #define BIO_GETATTR 0x04 /* Get GEOM attributes of object */ 49 #define BIO_FLUSH 0x05 /* Commit outstanding I/O now */ 50 #define BIO_CMD0 0x06 /* Available for local hacks */ 51 #define BIO_CMD1 0x07 /* Available for local hacks */ 52 #define BIO_CMD2 0x08 /* Available for local hacks */ 53 #define BIO_ZONE 0x09 /* Zone command */ 54 55 /* bio_flags */ 56 #define BIO_ERROR 0x01 /* An error occurred processing this bio. */ 57 #define BIO_DONE 0x02 /* This bio is finished. */ 58 #define BIO_ONQUEUE 0x04 /* This bio is in a queue & not yet taken. */ 59 /* 60 * This bio must be executed after all previous bios in the queue have been 61 * executed, and before any successive bios can be executed. 62 */ 63 #define BIO_ORDERED 0x08 64 #define BIO_UNMAPPED 0x10 65 #define BIO_TRANSIENT_MAPPING 0x20 66 #define BIO_VLIST 0x40 67 68 #ifdef _KERNEL 69 struct disk; 70 struct bio; 71 struct vm_map; 72 73 /* Empty classifier tag, to prevent further classification. */ 74 #define BIO_NOTCLASSIFIED (void *)(~0UL) 75 76 typedef void bio_task_t(void *); 77 78 /* 79 * The bio structure describes an I/O operation in the kernel. 80 */ 81 struct bio { 82 uint16_t bio_cmd; /* I/O operation. */ 83 uint16_t bio_flags; /* General flags. */ 84 uint16_t bio_cflags; /* Private use by the consumer. */ 85 uint16_t bio_pflags; /* Private use by the provider. */ 86 struct cdev *bio_dev; /* Device to do I/O on. */ 87 struct disk *bio_disk; /* Valid below geom_disk.c only */ 88 off_t bio_offset; /* Offset into file. */ 89 long bio_bcount; /* Valid bytes in buffer. */ 90 caddr_t bio_data; /* Memory, superblocks, indirect etc. */ 91 struct vm_page **bio_ma; /* Or unmapped. */ 92 int bio_ma_offset; /* Offset in the first page of bio_ma. */ 93 int bio_ma_n; /* Number of pages in bio_ma. */ 94 int bio_error; /* Errno for BIO_ERROR. */ 95 long bio_resid; /* Remaining I/O in bytes. */ 96 void (*bio_done)(struct bio *); 97 void *bio_driver1; /* Private use by the provider. */ 98 void *bio_driver2; /* Private use by the provider. */ 99 void *bio_caller1; /* Private use by the consumer. */ 100 void *bio_caller2; /* Private use by the consumer. */ 101 TAILQ_ENTRY(bio) bio_queue; /* Disksort queue. */ 102 const char *bio_attribute; /* Attribute for BIO_[GS]ETATTR */ 103 struct disk_zone_args bio_zone;/* Used for BIO_ZONE */ 104 struct g_consumer *bio_from; /* GEOM linkage */ 105 struct g_provider *bio_to; /* GEOM linkage */ 106 off_t bio_length; /* Like bio_bcount */ 107 off_t bio_completed; /* Inverse of bio_resid */ 108 u_int bio_children; /* Number of spawned bios */ 109 u_int bio_inbed; /* Children safely home by now */ 110 struct bio *bio_parent; /* Pointer to parent */ 111 struct bintime bio_t0; /* Time request started */ 112 113 bio_task_t *bio_task; /* Task_queue handler */ 114 void *bio_task_arg; /* Argument to above */ 115 116 void *bio_classifier1; /* Classifier tag. */ 117 void *bio_classifier2; /* Classifier tag. */ 118 119 #ifdef DIAGNOSTIC 120 void *_bio_caller1; 121 void *_bio_caller2; 122 uint8_t _bio_cflags; 123 #endif 124 #if defined(BUF_TRACKING) || defined(FULL_BUF_TRACKING) 125 struct buf *bio_track_bp; /* Parent buf for tracking */ 126 #endif 127 128 /* XXX: these go away when bio chaining is introduced */ 129 daddr_t bio_pblkno; /* physical block number */ 130 }; 131 132 struct uio; 133 struct devstat; 134 135 struct bio_queue_head { 136 TAILQ_HEAD(bio_queue, bio) queue; 137 off_t last_offset; 138 struct bio *insert_point; 139 }; 140 141 extern struct vm_map *bio_transient_map; 142 extern int bio_transient_maxcnt; 143 144 void biodone(struct bio *bp); 145 void biofinish(struct bio *bp, struct devstat *stat, int error); 146 int biowait(struct bio *bp, const char *wchan); 147 148 #if defined(BUF_TRACKING) || defined(FULL_BUF_TRACKING) 149 void biotrack_buf(struct bio *bp, const char *location); 150 151 static __inline void 152 biotrack(struct bio *bp, const char *location) 153 { 154 155 if (bp->bio_track_bp != NULL) 156 biotrack_buf(bp, location); 157 } 158 #else 159 static __inline void 160 biotrack(struct bio *bp __unused, const char *location __unused) 161 { 162 } 163 #endif 164 165 void bioq_disksort(struct bio_queue_head *ap, struct bio *bp); 166 struct bio *bioq_first(struct bio_queue_head *head); 167 struct bio *bioq_takefirst(struct bio_queue_head *head); 168 void bioq_flush(struct bio_queue_head *head, struct devstat *stp, int error); 169 void bioq_init(struct bio_queue_head *head); 170 void bioq_insert_head(struct bio_queue_head *head, struct bio *bp); 171 void bioq_insert_tail(struct bio_queue_head *head, struct bio *bp); 172 void bioq_remove(struct bio_queue_head *head, struct bio *bp); 173 174 int physio(struct cdev *dev, struct uio *uio, int ioflag); 175 #define physread physio 176 #define physwrite physio 177 178 #endif /* _KERNEL */ 179 180 #endif /* !_SYS_BIO_H_ */ 181