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