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