1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 1982, 1986, 1989, 1993 5 * The Regents of the University of California. All rights reserved. 6 * (c) UNIX System Laboratories, Inc. 7 * All or some portions of this file are derived from material licensed 8 * to the University of California by American Telephone and Telegraph 9 * Co. or Unix System Laboratories, Inc. and are reproduced herein with 10 * the permission of UNIX System Laboratories, Inc. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 3. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 * @(#)buf.h 8.9 (Berkeley) 3/30/95 37 * $FreeBSD$ 38 */ 39 40 #ifndef _SYS_BIO_H_ 41 #define _SYS_BIO_H_ 42 43 #include <sys/queue.h> 44 #include <sys/disk_zone.h> 45 46 /* bio_cmd */ 47 #define BIO_READ 0x01 /* Read I/O data */ 48 #define BIO_WRITE 0x02 /* Write I/O data */ 49 #define BIO_DELETE 0x03 /* TRIM or free blocks, i.e. mark as unused */ 50 #define BIO_GETATTR 0x04 /* Get GEOM attributes of object */ 51 #define BIO_FLUSH 0x05 /* Commit outstanding I/O now */ 52 #define BIO_CMD0 0x06 /* Available for local hacks */ 53 #define BIO_CMD1 0x07 /* Available for local hacks */ 54 #define BIO_CMD2 0x08 /* Available for local hacks */ 55 #define BIO_ZONE 0x09 /* Zone command */ 56 #define BIO_SPEEDUP 0x0a /* Upper layers face shortage */ 57 58 /* bio_flags */ 59 #define BIO_ERROR 0x01 /* An error occurred processing this bio. */ 60 #define BIO_DONE 0x02 /* This bio is finished. */ 61 #define BIO_ONQUEUE 0x04 /* This bio is in a queue & not yet taken. */ 62 /* 63 * This bio must be executed after all previous bios in the queue have been 64 * executed, and before any successive bios can be executed. 65 */ 66 #define BIO_ORDERED 0x08 67 #define BIO_UNMAPPED 0x10 68 #define BIO_TRANSIENT_MAPPING 0x20 69 #define BIO_VLIST 0x40 70 #define BIO_SWAP 0x200 /* Swap-related I/O */ 71 72 #define PRINT_BIO_FLAGS "\20\12swap\7vlist\6transient_mapping\5unmapped" \ 73 "\4ordered\3onqueue\2done\1error" 74 75 #define BIO_SPEEDUP_WRITE 0x4000 /* Resource shortage at upper layers */ 76 #define BIO_SPEEDUP_TRIM 0x8000 /* Resource shortage at upper layers */ 77 78 #ifdef _KERNEL 79 struct disk; 80 struct bio; 81 struct vm_map; 82 83 typedef void bio_task_t(void *); 84 85 /* 86 * The bio structure describes an I/O operation in the kernel. 87 */ 88 struct bio { 89 uint16_t bio_cmd; /* I/O operation. */ 90 uint16_t bio_flags; /* General flags. */ 91 uint16_t bio_cflags; /* Private use by the consumer. */ 92 uint16_t bio_pflags; /* Private use by the provider. */ 93 struct cdev *bio_dev; /* Device to do I/O on. */ 94 struct disk *bio_disk; /* Valid below geom_disk.c only */ 95 off_t bio_offset; /* Offset into file. */ 96 long bio_bcount; /* Valid bytes in buffer. */ 97 caddr_t bio_data; /* Memory, superblocks, indirect etc. */ 98 struct vm_page **bio_ma; /* Or unmapped. */ 99 int bio_ma_offset; /* Offset in the first page of bio_ma. */ 100 int bio_ma_n; /* Number of pages in bio_ma. */ 101 int bio_error; /* Errno for BIO_ERROR. */ 102 long bio_resid; /* Remaining I/O in bytes. */ 103 void (*bio_done)(struct bio *); 104 void *bio_driver1; /* Private use by the provider. */ 105 void *bio_driver2; /* Private use by the provider. */ 106 void *bio_caller1; /* Private use by the consumer. */ 107 void *bio_caller2; /* Private use by the consumer. */ 108 TAILQ_ENTRY(bio) bio_queue; /* Disksort queue. */ 109 const char *bio_attribute; /* Attribute for BIO_[GS]ETATTR */ 110 struct disk_zone_args bio_zone;/* Used for BIO_ZONE */ 111 struct g_consumer *bio_from; /* GEOM linkage */ 112 struct g_provider *bio_to; /* GEOM linkage */ 113 off_t bio_length; /* Like bio_bcount */ 114 off_t bio_completed; /* Inverse of bio_resid */ 115 u_int bio_children; /* Number of spawned bios */ 116 u_int bio_inbed; /* Children safely home by now */ 117 struct bio *bio_parent; /* Pointer to parent */ 118 struct bintime bio_t0; /* Time request started */ 119 120 bio_task_t *bio_task; /* Task_queue handler */ 121 void *bio_task_arg; /* Argument to above */ 122 123 void *bio_spare1; 124 void *bio_spare2; 125 126 #ifdef DIAGNOSTIC 127 void *_bio_caller1; 128 void *_bio_caller2; 129 uint8_t _bio_cflags; 130 #endif 131 #if defined(BUF_TRACKING) || defined(FULL_BUF_TRACKING) 132 struct buf *bio_track_bp; /* Parent buf for tracking */ 133 #endif 134 135 /* XXX: these go away when bio chaining is introduced */ 136 daddr_t bio_pblkno; /* physical block number */ 137 }; 138 139 struct uio; 140 struct devstat; 141 142 struct bio_queue_head { 143 TAILQ_HEAD(bio_queue, bio) queue; 144 off_t last_offset; 145 struct bio *insert_point; 146 int total; 147 int batched; 148 }; 149 150 extern struct vm_map *bio_transient_map; 151 extern int bio_transient_maxcnt; 152 153 void biodone(struct bio *bp); 154 void biofinish(struct bio *bp, struct devstat *stat, int error); 155 int biowait(struct bio *bp, const char *wchan); 156 157 #if defined(BUF_TRACKING) || defined(FULL_BUF_TRACKING) 158 void biotrack_buf(struct bio *bp, const char *location); 159 160 static __inline void 161 biotrack(struct bio *bp, const char *location) 162 { 163 164 if (bp->bio_track_bp != NULL) 165 biotrack_buf(bp, location); 166 } 167 #else 168 static __inline void 169 biotrack(struct bio *bp __unused, const char *location __unused) 170 { 171 } 172 #endif 173 174 void bioq_disksort(struct bio_queue_head *ap, struct bio *bp); 175 struct bio *bioq_first(struct bio_queue_head *head); 176 struct bio *bioq_takefirst(struct bio_queue_head *head); 177 void bioq_flush(struct bio_queue_head *head, struct devstat *stp, int error); 178 void bioq_init(struct bio_queue_head *head); 179 void bioq_insert_head(struct bio_queue_head *head, struct bio *bp); 180 void bioq_insert_tail(struct bio_queue_head *head, struct bio *bp); 181 void bioq_remove(struct bio_queue_head *head, struct bio *bp); 182 183 int physio(struct cdev *dev, struct uio *uio, int ioflag); 184 #define physread physio 185 #define physwrite physio 186 187 #endif /* _KERNEL */ 188 189 #endif /* !_SYS_BIO_H_ */ 190