xref: /freebsd/sys/geom/geom_io.c (revision 6780ab54325a71e7e70112b11657973edde8655e)
1 /*-
2  * Copyright (c) 2002 Poul-Henning Kamp
3  * Copyright (c) 2002 Networks Associates Technology, Inc.
4  * All rights reserved.
5  *
6  * This software was developed for the FreeBSD Project by Poul-Henning Kamp
7  * and NAI Labs, the Security Research Division of Network Associates, Inc.
8  * under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
9  * DARPA CHATS research program.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. The names of the authors may not be used to endorse or promote
20  *    products derived from this software without specific prior written
21  *    permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  *
35  * $FreeBSD$
36  */
37 
38 
39 #include <sys/param.h>
40 #include <sys/stdint.h>
41 #ifndef _KERNEL
42 #include <stdio.h>
43 #include <string.h>
44 #include <stdlib.h>
45 #include <signal.h>
46 #include <err.h>
47 #include <sched.h>
48 #else
49 #include <sys/systm.h>
50 #include <sys/kernel.h>
51 #include <sys/malloc.h>
52 #include <sys/bio.h>
53 #endif
54 
55 #include <sys/errno.h>
56 #include <geom/geom.h>
57 #include <geom/geom_int.h>
58 
59 static struct g_bioq g_bio_run_down;
60 static struct g_bioq g_bio_run_up;
61 static struct g_bioq g_bio_idle;
62 
63 static u_int pace;
64 
65 #include <machine/atomic.h>
66 
67 static void
68 g_bioq_lock(struct g_bioq *bq)
69 {
70 
71 	mtx_lock(&bq->bio_queue_lock);
72 }
73 
74 static void
75 g_bioq_unlock(struct g_bioq *bq)
76 {
77 
78 	mtx_unlock(&bq->bio_queue_lock);
79 }
80 
81 #if 0
82 static void
83 g_bioq_destroy(struct g_bioq *bq)
84 {
85 
86 	mtx_destroy(&bq->bio_queue_lock);
87 }
88 #endif
89 
90 static void
91 g_bioq_init(struct g_bioq *bq)
92 {
93 
94 	TAILQ_INIT(&bq->bio_queue);
95 	mtx_init(&bq->bio_queue_lock, "bio queue", NULL, MTX_DEF);
96 }
97 
98 static struct bio *
99 g_bioq_first(struct g_bioq *bq)
100 {
101 	struct bio *bp;
102 
103 	g_bioq_lock(bq);
104 	bp = TAILQ_FIRST(&bq->bio_queue);
105 	if (bp != NULL) {
106 		TAILQ_REMOVE(&bq->bio_queue, bp, bio_queue);
107 		bq->bio_queue_length--;
108 	}
109 	g_bioq_unlock(bq);
110 	return (bp);
111 }
112 
113 static void
114 g_bioq_enqueue_tail(struct bio *bp, struct g_bioq *rq)
115 {
116 
117 	g_bioq_lock(rq);
118 	TAILQ_INSERT_TAIL(&rq->bio_queue, bp, bio_queue);
119 	rq->bio_queue_length++;
120 	g_bioq_unlock(rq);
121 }
122 
123 struct bio *
124 g_new_bio(void)
125 {
126 	struct bio *bp;
127 
128 	bp = g_bioq_first(&g_bio_idle);
129 	if (bp == NULL)
130 		bp = g_malloc(sizeof *bp, M_NOWAIT | M_ZERO);
131 	/* g_trace(G_T_BIO, "g_new_bio() = %p", bp); */
132 	return (bp);
133 }
134 
135 void
136 g_destroy_bio(struct bio *bp)
137 {
138 
139 	/* g_trace(G_T_BIO, "g_destroy_bio(%p)", bp); */
140 	bzero(bp, sizeof *bp);
141 	g_bioq_enqueue_tail(bp, &g_bio_idle);
142 }
143 
144 struct bio *
145 g_clone_bio(struct bio *bp)
146 {
147 	struct bio *bp2;
148 
149 	bp2 = g_new_bio();
150 	if (bp2 != NULL) {
151 		bp2->bio_linkage = bp;
152 		bp2->bio_cmd = bp->bio_cmd;
153 		bp2->bio_length = bp->bio_length;
154 		bp2->bio_offset = bp->bio_offset;
155 		bp2->bio_data = bp->bio_data;
156 		bp2->bio_attribute = bp->bio_attribute;
157 		bp->bio_children++;	/* XXX: atomic ? */
158 	}
159 	/* g_trace(G_T_BIO, "g_clone_bio(%p) = %p", bp, bp2); */
160 	return(bp2);
161 }
162 
163 void
164 g_io_init()
165 {
166 
167 	g_bioq_init(&g_bio_run_down);
168 	g_bioq_init(&g_bio_run_up);
169 	g_bioq_init(&g_bio_idle);
170 }
171 
172 int
173 g_io_setattr(const char *attr, struct g_consumer *cp, int len, void *ptr)
174 {
175 	struct bio *bp;
176 	int error;
177 
178 	g_trace(G_T_BIO, "bio_setattr(%s)", attr);
179 	bp = g_new_bio();
180 	bp->bio_cmd = BIO_SETATTR;
181 	bp->bio_done = NULL;
182 	bp->bio_attribute = attr;
183 	bp->bio_length = len;
184 	bp->bio_data = ptr;
185 	g_io_request(bp, cp);
186 	error = biowait(bp, "gsetattr");
187 	g_destroy_bio(bp);
188 	return (error);
189 }
190 
191 
192 int
193 g_io_getattr(const char *attr, struct g_consumer *cp, int *len, void *ptr)
194 {
195 	struct bio *bp;
196 	int error;
197 
198 	g_trace(G_T_BIO, "bio_getattr(%s)", attr);
199 	bp = g_new_bio();
200 	bp->bio_cmd = BIO_GETATTR;
201 	bp->bio_done = NULL;
202 	bp->bio_attribute = attr;
203 	bp->bio_length = *len;
204 	bp->bio_data = ptr;
205 	g_io_request(bp, cp);
206 	error = biowait(bp, "ggetattr");
207 	*len = bp->bio_completed;
208 	g_destroy_bio(bp);
209 	return (error);
210 }
211 
212 static int
213 g_io_check(struct bio *bp)
214 {
215 	struct g_consumer *cp;
216 	struct g_provider *pp;
217 
218 	cp = bp->bio_from;
219 	pp = bp->bio_to;
220 
221 	/* Fail if access counters dont allow the operation */
222 	switch(bp->bio_cmd) {
223 	case BIO_READ:
224 	case BIO_GETATTR:
225 		if (cp->acr == 0)
226 			return (EPERM);
227 		break;
228 	case BIO_WRITE:
229 	case BIO_DELETE:
230 	case BIO_SETATTR:
231 		if (cp->acw == 0)
232 			return (EPERM);
233 		break;
234 	default:
235 		return (EPERM);
236 	}
237 	/* if provider is marked for error, don't disturb. */
238 	if (pp->error)
239 		return (pp->error);
240 
241 	switch(bp->bio_cmd) {
242 	case BIO_READ:
243 	case BIO_WRITE:
244 	case BIO_DELETE:
245 		/* Reject I/O not on sector boundary */
246 		if (bp->bio_offset % pp->sectorsize)
247 			return (EINVAL);
248 		/* Reject I/O not integral sector long */
249 		if (bp->bio_length % pp->sectorsize)
250 			return (EINVAL);
251 		/* Reject requests past the end of media. */
252 		if (bp->bio_offset > pp->mediasize)
253 			return (EIO);
254 		break;
255 	default:
256 		break;
257 	}
258 	return (0);
259 }
260 
261 void
262 g_io_request(struct bio *bp, struct g_consumer *cp)
263 {
264 
265 	KASSERT(cp != NULL, ("NULL cp in g_io_request"));
266 	KASSERT(bp != NULL, ("NULL bp in g_io_request"));
267 	KASSERT(bp->bio_data != NULL, ("NULL bp->data in g_io_request"));
268 	KASSERT(bp->bio_to == NULL, ("consumer not attached in g_io_request"));
269 	bp->bio_from = cp;
270 	bp->bio_to = cp->provider;
271 	bp->bio_error = 0;
272 	bp->bio_completed = 0;
273 
274 	/* begin_stats(&bp->stats); */
275 
276 	atomic_add_int(&cp->biocount, 1);
277 
278 	/* Pass it on down. */
279 	g_trace(G_T_BIO, "bio_request(%p) from %p(%s) to %p(%s) cmd %d",
280 	    bp, bp->bio_from, bp->bio_from->geom->name,
281 	    bp->bio_to, bp->bio_to->name, bp->bio_cmd);
282 	g_bioq_enqueue_tail(bp, &g_bio_run_down);
283 	wakeup(&g_wait_down);
284 }
285 
286 void
287 g_io_deliver(struct bio *bp, int error)
288 {
289 
290 	KASSERT(bp != NULL, ("NULL bp in g_io_deliver"));
291 	KASSERT(bp->bio_from != NULL, ("NULL bio_from in g_io_deliver"));
292 	KASSERT(bp->bio_from->geom != NULL,
293 	    ("NULL bio_from->geom in g_io_deliver"));
294 	KASSERT(bp->bio_to != NULL, ("NULL bio_to in g_io_deliver"));
295 
296 	g_trace(G_T_BIO,
297 "g_io_deliver(%p) from %p(%s) to %p(%s) cmd %d error %d off %jd len %jd",
298 	    bp, bp->bio_from, bp->bio_from->geom->name,
299 	    bp->bio_to, bp->bio_to->name, bp->bio_cmd, error,
300 	    (intmax_t)bp->bio_offset, (intmax_t)bp->bio_length);
301 	/* finish_stats(&bp->stats); */
302 
303 	if (error == ENOMEM) {
304 		printf("ENOMEM %p on %p(%s)\n",
305 			bp, bp->bio_to, bp->bio_to->name);
306 		g_io_request(bp, bp->bio_from);
307 		pace++;
308 		return;
309 	}
310 
311 	bp->bio_error = error;
312 
313 	g_bioq_enqueue_tail(bp, &g_bio_run_up);
314 
315 	wakeup(&g_wait_up);
316 }
317 
318 void
319 g_io_schedule_down(struct thread *tp __unused)
320 {
321 	struct bio *bp;
322 	off_t excess;
323 	int error;
324 
325 	for(;;) {
326 		bp = g_bioq_first(&g_bio_run_down);
327 		if (bp == NULL)
328 			break;
329 		error = g_io_check(bp);
330 		if (error) {
331 			g_io_deliver(bp, error);
332 			continue;
333 		}
334 		/* Truncate requests to the end of providers media. */
335 		excess = bp->bio_offset + bp->bio_length;
336 		if (excess > bp->bio_to->mediasize) {
337 			excess -= bp->bio_to->mediasize;
338 			bp->bio_length -= excess;
339 		}
340 		/* Deliver zero length transfers right here. */
341 		if (bp->bio_length == 0) {
342 			g_io_deliver(bp, 0);
343 			continue;
344 		}
345 		bp->bio_to->geom->start(bp);
346 		if (pace) {
347 			pace--;
348 			break;
349 		}
350 	}
351 }
352 
353 void
354 g_io_schedule_up(struct thread *tp __unused)
355 {
356 	struct bio *bp;
357 	struct g_consumer *cp;
358 
359 	for(;;) {
360 		bp = g_bioq_first(&g_bio_run_up);
361 		if (bp == NULL)
362 			break;
363 
364 		cp = bp->bio_from;
365 
366 		atomic_add_int(&cp->biocount, -1);
367 		biodone(bp);
368 	}
369 }
370 
371 void *
372 g_read_data(struct g_consumer *cp, off_t offset, off_t length, int *error)
373 {
374 	struct bio *bp;
375 	void *ptr;
376 	int errorc;
377 
378 	bp = g_new_bio();
379 	bp->bio_cmd = BIO_READ;
380 	bp->bio_done = NULL;
381 	bp->bio_offset = offset;
382 	bp->bio_length = length;
383 	ptr = g_malloc(length, 0);
384 	bp->bio_data = ptr;
385 	g_io_request(bp, cp);
386 	errorc = biowait(bp, "gread");
387 	if (error != NULL)
388 		*error = errorc;
389 	g_destroy_bio(bp);
390 	if (errorc) {
391 		g_free(ptr);
392 		ptr = NULL;
393 	}
394 	return (ptr);
395 }
396 
397 int
398 g_write_data(struct g_consumer *cp, off_t offset, void *ptr, off_t length)
399 {
400 	struct bio *bp;
401 	int error;
402 
403 	bp = g_new_bio();
404 	bp->bio_cmd = BIO_WRITE;
405 	bp->bio_done = NULL;
406 	bp->bio_offset = offset;
407 	bp->bio_length = length;
408 	bp->bio_data = ptr;
409 	g_io_request(bp, cp);
410 	error = biowait(bp, "gwrite");
411 	g_destroy_bio(bp);
412 	return (error);
413 }
414