xref: /freebsd/sys/geom/geom_disk.c (revision a3e8fd0b7f663db7eafff527d5c3ca3bcfa8a537)
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 #include "opt_geom.h"
39 #ifndef NO_GEOM
40 
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/kernel.h>
44 #include <sys/sysctl.h>
45 #include <sys/bio.h>
46 #include <sys/conf.h>
47 #include <sys/disk.h>
48 #include <sys/diskslice.h>
49 #include <sys/disklabel.h>
50 #include <sys/malloc.h>
51 #include <sys/sysctl.h>
52 #include <sys/stdint.h>
53 #include <machine/md_var.h>
54 
55 
56 #include <sys/lock.h>
57 #include <sys/mutex.h>
58 #include <geom/geom.h>
59 
60 static g_access_t g_disk_access;
61 
62 struct g_class g_disk_class = {
63 	"DISK",
64 	NULL,
65 	NULL,
66 	G_CLASS_INITIALIZER
67 };
68 
69 DECLARE_GEOM_CLASS(g_disk_class, g_disk);
70 
71 static int
72 g_disk_access(struct g_provider *pp, int r, int w, int e)
73 {
74 	struct disk *dp;
75 	dev_t dev;
76 	int error;
77 
78 	g_trace(G_T_ACCESS, "g_disk_access(%s, %d, %d, %d)",
79 	    pp->name, r, w, e);
80 	g_topology_assert();
81 	r += pp->acr;
82 	w += pp->acw;
83 	e += pp->ace;
84 	dp = pp->geom->softc;
85 	dev = dp->d_dev;
86 	if ((pp->acr + pp->acw + pp->ace) == 0 && (r + w + e) > 0) {
87 		mtx_lock(&Giant);
88 		error = devsw(dev)->d_open(dev, 3, 0, NULL);
89 		if (error != 0)
90 			printf("Opened disk %s -> %d\n", pp->name, error);
91 		mtx_unlock(&Giant);
92 		pp->mediasize = dp->d_mediasize;
93 		pp->sectorsize = dp->d_sectorsize;
94 	} else if ((pp->acr + pp->acw + pp->ace) > 0 && (r + w + e) == 0) {
95 		mtx_lock(&Giant);
96 		error = devsw(dev)->d_close(dev, 3, 0, NULL);
97 		if (error != 0)
98 			printf("Closed disk %s -> %d\n", pp->name, error);
99 		mtx_unlock(&Giant);
100 	} else {
101 		error = 0;
102 	}
103 	return (error);
104 }
105 
106 static void
107 g_disk_kerneldump(struct bio *bp, struct disk *dp)
108 {
109 	int error;
110 	struct g_kerneldump *gkd;
111 	struct dumperinfo di;
112 	struct g_geom *gp;
113 
114 	gkd = (struct g_kerneldump*)bp->bio_data;
115 	gp = bp->bio_to->geom;
116 	g_trace(G_T_TOPOLOGY, "g_disk_kernedump(%s, %jd, %jd)",
117 		gp->name, (intmax_t)gkd->offset, (intmax_t)gkd->length);
118 	di.dumper = (dumper_t *)dp->d_devsw->d_dump;
119 	di.priv = dp->d_dev;
120 	di.blocksize = dp->d_sectorsize;
121 	di.mediaoffset = gkd->offset;
122 	di.mediasize = gkd->length;
123 	error = set_dumper(&di);
124 	g_io_deliver(bp, error);
125 }
126 
127 static void
128 g_disk_done(struct bio *bp)
129 {
130 
131 	mtx_unlock(&Giant);
132 	bp->bio_completed = bp->bio_length - bp->bio_resid;
133 	g_std_done(bp);
134 	mtx_lock(&Giant);
135 }
136 
137 static void
138 g_disk_start(struct bio *bp)
139 {
140 	struct bio *bp2;
141 	dev_t dev;
142 	struct disk *dp;
143 	struct g_ioctl *gio;
144 	int error;
145 
146 	dp = bp->bio_to->geom->softc;
147 	dev = dp->d_dev;
148 	error = EJUSTRETURN;
149 	switch(bp->bio_cmd) {
150 	case BIO_DELETE:
151 		if (!(devsw(dev)->d_flags & D_CANFREE)) {
152 			error = 0;
153 			break;
154 		}
155 		/* fall-through */
156 	case BIO_READ:
157 	case BIO_WRITE:
158 		bp2 = g_clone_bio(bp);
159 		bp2->bio_done = g_disk_done;
160 		bp2->bio_blkno = bp2->bio_offset >> DEV_BSHIFT;
161 		bp2->bio_pblkno = bp2->bio_offset / dp->d_sectorsize;
162 		bp2->bio_bcount = bp2->bio_length;
163 		bp2->bio_dev = dev;
164 		mtx_lock(&Giant);
165 		devsw(dev)->d_strategy(bp2);
166 		mtx_unlock(&Giant);
167 		break;
168 	case BIO_GETATTR:
169 		if (g_handleattr_int(bp, "GEOM::fwsectors", dp->d_fwsectors))
170 			break;
171 		else if (g_handleattr_int(bp, "GEOM::fwheads", dp->d_fwheads))
172 			break;
173 		else if (g_handleattr_off_t(bp, "GEOM::frontstuff", 0))
174 			break;
175 		else if (!strcmp(bp->bio_attribute, "GEOM::kerneldump"))
176 			g_disk_kerneldump(bp, dp);
177 		else if (!strcmp(bp->bio_attribute, "GEOM::ioctl") &&
178 		    bp->bio_length == sizeof *gio) {
179 			gio = (struct g_ioctl *)bp->bio_data;
180 			gio->func = devsw(dp->d_dev)->d_ioctl;
181 			gio->dev =  dp->d_dev;
182 			error = EDIRIOCTL;
183 		} else
184 			error = ENOIOCTL;
185 		break;
186 	case BIO_SETATTR:
187 		if (!strcmp(bp->bio_attribute, "GEOM::ioctl") &&
188 		    bp->bio_length == sizeof *gio) {
189 			gio = (struct g_ioctl *)bp->bio_data;
190 			gio->func = devsw(dp->d_dev)->d_ioctl;
191 			gio->dev =  dp->d_dev;
192 			error = EDIRIOCTL;
193 		} else
194 			error = ENOIOCTL;
195 		break;
196 	default:
197 		error = EOPNOTSUPP;
198 		break;
199 	}
200 	if (error != EJUSTRETURN)
201 		g_io_deliver(bp, error);
202 	return;
203 }
204 
205 static void
206 g_disk_dumpconf(struct sbuf *sb, char *indent, struct g_geom *gp, struct g_consumer *cp, struct g_provider *pp)
207 {
208 	struct disk *dp;
209 
210 	dp = gp->softc;
211 	if (pp != NULL) {
212 		sbuf_printf(sb, "%s<fwheads>%u</fwheads>\n",
213 		    indent, dp->d_fwheads);
214 		sbuf_printf(sb, "%s<fwsectors>%u</fwsectors>\n",
215 		    indent, dp->d_fwsectors);
216 	}
217 }
218 
219 static void
220 g_disk_create(void *arg)
221 {
222 	struct g_geom *gp;
223 	struct g_provider *pp;
224 	dev_t dev;
225 
226 	g_topology_assert();
227 	dev = arg;
228 	gp = g_new_geomf(&g_disk_class, dev->si_name);
229 	gp->start = g_disk_start;
230 	gp->access = g_disk_access;
231 	gp->softc = dev->si_disk;
232 	gp->dumpconf = g_disk_dumpconf;
233 	dev->si_disk->d_softc = gp;
234 	pp = g_new_providerf(gp, "%s", gp->name);
235 	pp->mediasize = dev->si_disk->d_mediasize;
236 	pp->sectorsize = dev->si_disk->d_sectorsize;
237 	g_error_provider(pp, 0);
238 }
239 
240 
241 
242 dev_t
243 disk_create(int unit, struct disk *dp, int flags, struct cdevsw *cdevsw, struct cdevsw *proto)
244 {
245 	dev_t dev;
246 
247 	dev = g_malloc(sizeof *dev, M_WAITOK | M_ZERO);
248 	dp->d_dev = dev;
249 	dp->d_devsw = cdevsw;
250 	dev->si_devsw = cdevsw;
251 	dev->si_disk = dp;
252 	dev->si_udev = dkmakeminor(unit, WHOLE_DISK_SLICE, RAW_PART);
253 	sprintf(dev->si_name, "%s%d", cdevsw->d_name, unit);
254 	g_call_me(g_disk_create, dev);
255 	return (dev);
256 }
257 
258 void disk_dev_synth(dev_t dev);
259 
260 void
261 disk_dev_synth(dev_t dev)
262 {
263 
264 	return;
265 }
266 
267 void
268 disk_destroy(dev_t dev)
269 {
270 	struct disk *dp;
271 	struct g_geom *gp;
272 
273 	dp = dev->si_disk;
274 	gp = dp->d_softc;
275 	g_free(dev);
276 	gp->flags |= G_GEOM_WITHER;
277 	g_orphan_provider(LIST_FIRST(&gp->provider), ENXIO);
278 }
279 
280 void
281 disk_invalidate (struct disk *disk)
282 {
283 }
284 
285 static void
286 g_kern_disks(void *p)
287 {
288 	struct sbuf *sb;
289 	struct g_geom *gp;
290 	char *sp;
291 
292 	sb = p;
293 	sp = "";
294 	g_topology_assert();
295 	LIST_FOREACH(gp, &g_disk_class.geom, geom) {
296 		sbuf_printf(sb, "%s%s", sp, gp->name);
297 		sp = " ";
298 	}
299 	sbuf_finish(sb);
300 	wakeup(sb);
301 }
302 
303 static int
304 sysctl_disks(SYSCTL_HANDLER_ARGS)
305 {
306 	int error;
307 	struct sbuf *sb;
308 
309 	sb = sbuf_new(NULL, NULL, 0, SBUF_AUTOEXTEND);
310 	sbuf_clear(sb);
311 	g_call_me(g_kern_disks, sb);
312 	do {
313 		tsleep(sb, PZERO, "kern.disks", hz);
314 	} while(!sbuf_done(sb));
315 	error = SYSCTL_OUT(req, sbuf_data(sb), sbuf_len(sb) + 1);
316 	sbuf_delete(sb);
317 	return error;
318 }
319 
320 SYSCTL_PROC(_kern, OID_AUTO, disks, CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_NOLOCK, 0, 0,
321     sysctl_disks, "A", "names of available disks");
322 
323 #endif
324