geom_slice.c revision 104064
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: head/sys/geom/geom_slice.c 104064 2002-09-27 21:37:11Z phk $
36 */
37
38
39#include <sys/param.h>
40#ifndef _KERNEL
41#include <stdio.h>
42#include <unistd.h>
43#include <stdlib.h>
44#include <signal.h>
45#include <string.h>
46#include <err.h>
47#else
48#include <sys/systm.h>
49#include <sys/kernel.h>
50#include <sys/malloc.h>
51#include <sys/bio.h>
52#include <sys/sysctl.h>
53#include <sys/proc.h>
54#include <sys/kthread.h>
55#include <sys/lock.h>
56#include <sys/mutex.h>
57#endif
58#include <sys/errno.h>
59#include <sys/sbuf.h>
60#include <geom/geom.h>
61#include <geom/geom_slice.h>
62#include <machine/stdarg.h>
63
64static g_orphan_t g_slice_orphan;
65static g_access_t g_slice_access;
66static g_start_t g_slice_start;
67
68static struct g_slicer *
69g_slice_init(unsigned nslice, unsigned scsize)
70{
71	struct g_slicer *gsp;
72
73	gsp = g_malloc(sizeof *gsp, M_WAITOK | M_ZERO);
74	gsp->softc = g_malloc(scsize, M_WAITOK | M_ZERO);
75	gsp->slices = g_malloc(nslice * sizeof(struct g_slice),
76	    M_WAITOK | M_ZERO);
77	gsp->nslice = nslice;
78	return (gsp);
79}
80
81static int
82g_slice_access(struct g_provider *pp, int dr, int dw, int de)
83{
84	int error, i;
85	struct g_geom *gp;
86	struct g_consumer *cp;
87	struct g_provider *pp2;
88	struct g_slicer *gsp;
89	struct g_slice *gsl, *gsl2;
90
91	gp = pp->geom;
92	cp = LIST_FIRST(&gp->consumer);
93	KASSERT (cp != NULL, ("g_slice_access but no consumer"));
94	gsp = gp->softc;
95	gsl = &gsp->slices[pp->index];
96	for (i = 0; i < gsp->nslice; i++) {
97		gsl2 = &gsp->slices[i];
98		if (gsl2->length == 0)
99			continue;
100		if (i == pp->index)
101			continue;
102		if (gsl->offset + gsl->length <= gsl2->offset)
103			continue;
104		if (gsl2->offset + gsl2->length <= gsl->offset)
105			continue;
106		/* overlap */
107		pp2 = gsl2->provider;
108		if ((pp->acw + dw) > 0 && pp2->ace > 0)
109			return (EPERM);
110		if ((pp->ace + de) > 0 && pp2->acw > 0)
111			return (EPERM);
112	}
113	/* On first open, grab an extra "exclusive" bit */
114	if (cp->acr == 0 && cp->acw == 0 && cp->ace == 0)
115		de++;
116	/* ... and let go of it on last close */
117	if ((cp->acr + dr) == 0 && (cp->acw + dw) == 0 && (cp->ace + de) == 1)
118		de--;
119	error = g_access_rel(cp, dr, dw, de);
120	pp->mediasize = gsp->slices[pp->index].length;
121	return (error);
122}
123
124static void
125g_slice_start(struct bio *bp)
126{
127	struct bio *bp2;
128	struct g_provider *pp;
129	struct g_geom *gp;
130	struct g_consumer *cp;
131	struct g_slicer *gsp;
132	struct g_slice *gsl;
133	int index;
134	off_t t;
135
136	pp = bp->bio_to;
137	gp = pp->geom;
138	gsp = gp->softc;
139	cp = LIST_FIRST(&gp->consumer);
140	index = pp->index;
141	gsl = &gsp->slices[index];
142	switch(bp->bio_cmd) {
143	case BIO_READ:
144	case BIO_WRITE:
145	case BIO_DELETE:
146		if (bp->bio_offset > gsl->length) {
147			bp->bio_error = EINVAL; /* XXX: EWHAT ? */
148			g_io_deliver(bp);
149			return;
150		}
151		bp2 = g_clone_bio(bp);
152		if (bp2 == NULL) {
153			g_io_fail(bp, ENOMEM);
154			return;
155		}
156		if (bp2->bio_offset + bp2->bio_length > gsl->length)
157			bp2->bio_length = gsl->length - bp2->bio_offset;
158		bp2->bio_done = g_std_done;
159		bp2->bio_offset += gsl->offset;
160		g_io_request(bp2, cp);
161		return;
162	case BIO_GETATTR:
163	case BIO_SETATTR:
164		/* Give the real method a chance to override */
165		if (gsp->start(bp))
166			return;
167		if (g_handleattr_off_t(bp, "GEOM::mediasize",
168		    gsp->slices[index].length))
169			return;
170		if (!strcmp("GEOM::frontstuff", bp->bio_attribute)) {
171			t = gsp->cfrontstuff;
172			if (gsp->frontstuff > t)
173				t = gsp->frontstuff;
174			t -= gsl->offset;
175			if (t < 0)
176				t = 0;
177			if (t > gsl->length)
178				t = gsl->length;
179			g_handleattr_off_t(bp, "GEOM::frontstuff", t);
180			return;
181		}
182#ifdef _KERNEL
183		if (!strcmp("GEOM::kerneldump", bp->bio_attribute)) {
184			struct g_kerneldump *gkd;
185
186			gkd = (struct g_kerneldump *)bp->bio_data;
187			gkd->offset += gsp->slices[index].offset;
188			if (gkd->length > gsp->slices[index].length)
189				gkd->length = gsp->slices[index].length;
190			/* now, pass it on downwards... */
191		}
192#endif
193		bp2 = g_clone_bio(bp);
194		bp2->bio_done = g_std_done;
195		g_io_request(bp2, cp);
196		break;
197	default:
198		bp->bio_error = EOPNOTSUPP;
199		g_io_deliver(bp);
200		return;
201	}
202}
203
204void
205g_slice_dumpconf(struct sbuf *sb, char *indent, struct g_geom *gp, struct g_consumer *cp __unused, struct g_provider *pp)
206{
207	struct g_mbr_softc *mp;
208	struct g_slicer *gsp;
209
210	gsp = gp->softc;
211	mp = gsp->softc;
212	if (gp != NULL && (pp == NULL && cp == NULL)) {
213		sbuf_printf(sb, "%s<frontstuff>%llu</frontstuff>\n",
214		    indent, (unsigned long long)gsp->frontstuff);
215	}
216	if (pp != NULL) {
217		sbuf_printf(sb, "%s<index>%u</index>\n", indent, pp->index);
218		sbuf_printf(sb, "%s<length>%llu</length>\n",
219		    indent, (unsigned long long)gsp->slices[pp->index].length);
220		sbuf_printf(sb, "%s<seclength>%llu</seclength>\n", indent,
221		    (unsigned long long)gsp->slices[pp->index].length / 512);
222		sbuf_printf(sb, "%s<offset>%llu</offset>\n", indent,
223		    (unsigned long long)gsp->slices[pp->index].offset);
224		sbuf_printf(sb, "%s<secoffset>%llu</secoffset>\n", indent,
225		    (unsigned long long)gsp->slices[pp->index].offset / 512);
226	}
227}
228
229int
230g_slice_config(struct g_geom *gp, int index, int how, off_t offset, off_t length, char *fmt, ...)
231{
232	struct g_provider *pp;
233	struct g_slicer *gsp;
234	struct g_slice *gsl;
235	va_list ap;
236	struct sbuf *sb;
237	int error, acc;
238
239	g_trace(G_T_TOPOLOGY, "g_slice_config()");
240	g_topology_assert();
241	gsp = gp->softc;
242	error = 0;
243	if (index >= gsp->nslice)
244		return(EINVAL);
245	gsl = &gsp->slices[index];
246	pp = gsl->provider;
247	if (pp != NULL)
248		acc = pp->acr + pp->acw + pp->ace;
249	else
250		acc = 0;
251	if (acc != 0 && how != G_SLICE_CONFIG_FORCE) {
252		if (length < gsl->length)
253			return(EBUSY);
254		if (offset != gsl->offset)
255			return(EBUSY);
256	}
257	/* XXX: check offset + length <= MEDIASIZE */
258	if (how == G_SLICE_CONFIG_CHECK)
259		return (0);
260	gsl->length = length;
261	gsl->offset = offset;
262	if (length != 0 && pp != NULL)
263		return (0);
264	if (length == 0 && pp == NULL)
265		return (0);
266	if (length == 0 && pp != NULL) {
267		g_orphan_provider(pp, ENXIO);
268		gsl->provider = NULL;
269		gsp->nprovider--;
270		return (0);
271	}
272	va_start(ap, fmt);
273	sb = sbuf_new(NULL, NULL, 0, SBUF_AUTOEXTEND);
274	sbuf_vprintf(sb, fmt, ap);
275	sbuf_finish(sb);
276	pp = g_new_providerf(gp, sbuf_data(sb));
277	pp->index = index;
278	gsl->provider = pp;
279	gsp->nprovider++;
280	g_error_provider(pp, 0);
281	sbuf_delete(sb);
282	return(0);
283}
284
285struct g_provider *
286g_slice_addslice(struct g_geom *gp, int index, off_t offset, off_t length, char *fmt, ...)
287{
288	struct g_provider *pp;
289	struct g_slicer *gsp;
290	va_list ap;
291	struct sbuf *sb;
292
293	g_trace(G_T_TOPOLOGY, "g_slice_addslice()");
294	g_topology_assert();
295	gsp = gp->softc;
296	va_start(ap, fmt);
297	sb = sbuf_new(NULL, NULL, 0, SBUF_AUTOEXTEND);
298	sbuf_vprintf(sb, fmt, ap);
299	sbuf_finish(sb);
300	pp = g_new_providerf(gp, sbuf_data(sb));
301
302	pp->index = index;
303	gsp->slices[index].length = length;
304	gsp->slices[index].offset = offset;
305	gsp->slices[index].provider = pp;
306	sbuf_delete(sb);
307	return(pp);
308}
309
310struct g_geom *
311g_slice_new(struct g_class *mp, int slices, struct g_provider *pp, struct g_consumer **cpp, void *extrap, int extra, g_slice_start_t *start)
312{
313	struct g_geom *gp;
314	struct g_slicer *gsp;
315	struct g_consumer *cp;
316	void **vp;
317	int error, i;
318
319	g_topology_assert();
320	vp = (void **)extrap;
321	gp = g_new_geomf(mp, "%s", pp->name);
322	gsp = g_slice_init(slices, extra);
323	gsp->start = start;
324	gp->access = g_slice_access;
325	gp->orphan = g_slice_orphan;
326	gp->softc = gsp;
327	gp->start = g_slice_start;
328	gp->spoiled = g_std_spoiled;
329	gp->dumpconf = g_slice_dumpconf;
330	cp = g_new_consumer(gp);
331	g_attach(cp, pp);
332	error = g_access_rel(cp, 1, 0, 0);
333	if (error) {
334		g_detach(cp);
335		g_destroy_consumer(cp);
336		g_free(gsp->slices);
337		g_free(gp->softc);
338		g_destroy_geom(gp);
339		return (NULL);
340	}
341	/* Find out if there are any magic bytes on the consumer */
342	i = sizeof gsp->cfrontstuff;
343	error = g_io_getattr("GEOM::frontstuff", cp, &i, &gsp->cfrontstuff);
344	if (error)
345		gsp->cfrontstuff = 0;
346	*vp = gsp->softc;
347	*cpp = cp;
348	return (gp);
349}
350
351static void
352g_slice_orphan(struct g_consumer *cp)
353{
354	struct g_geom *gp;
355	struct g_provider *pp;
356	int error;
357
358	g_trace(G_T_TOPOLOGY, "g_slice_orphan(%p/%s)", cp, cp->provider->name);
359	g_topology_assert();
360	KASSERT(cp->provider->error != 0,
361	    ("g_slice_orphan with error == 0"));
362
363	gp = cp->geom;
364	gp->flags |= G_GEOM_WITHER;
365	error = cp->provider->error;
366	LIST_FOREACH(pp, &gp->provider, provider)
367		g_orphan_provider(pp, error);
368	return;
369}
370