xref: /freebsd/sys/dev/mfi/mfi_disk.c (revision 031beb4e239bfce798af17f5fe8dba8bcaf13d99)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2006 IronPort Systems
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
30 #include "opt_mfi.h"
31 
32 #include <sys/param.h>
33 #include <sys/bio.h>
34 #include <sys/bus.h>
35 #include <sys/conf.h>
36 #include <sys/disk.h>
37 #include <sys/kernel.h>
38 #include <sys/lock.h>
39 #include <sys/malloc.h>
40 #include <sys/module.h>
41 #include <sys/mutex.h>
42 #include <sys/selinfo.h>
43 #include <sys/sysctl.h>
44 #include <sys/systm.h>
45 #include <sys/uio.h>
46 
47 #include <geom/geom_disk.h>
48 
49 #include <vm/vm.h>
50 #include <vm/pmap.h>
51 
52 #include <machine/md_var.h>
53 #include <machine/bus.h>
54 #include <sys/rman.h>
55 
56 #include <dev/mfi/mfireg.h>
57 #include <dev/mfi/mfi_ioctl.h>
58 #include <dev/mfi/mfivar.h>
59 
60 static int	mfi_disk_probe(device_t dev);
61 static int	mfi_disk_attach(device_t dev);
62 static int	mfi_disk_detach(device_t dev);
63 
64 static disk_open_t	mfi_disk_open;
65 static disk_close_t	mfi_disk_close;
66 static disk_strategy_t	mfi_disk_strategy;
67 static dumper_t		mfi_disk_dump;
68 
69 static device_method_t mfi_disk_methods[] = {
70 	DEVMETHOD(device_probe,		mfi_disk_probe),
71 	DEVMETHOD(device_attach,	mfi_disk_attach),
72 	DEVMETHOD(device_detach,	mfi_disk_detach),
73 	{ 0, 0 }
74 };
75 
76 static driver_t mfi_disk_driver = {
77 	"mfid",
78 	mfi_disk_methods,
79 	sizeof(struct mfi_disk)
80 };
81 
82 DRIVER_MODULE(mfid, mfi, mfi_disk_driver, 0, 0);
83 
84 static int
85 mfi_disk_probe(device_t dev)
86 {
87 
88 	return (0);
89 }
90 
91 static int
92 mfi_disk_attach(device_t dev)
93 {
94 	struct mfi_disk *sc;
95 	struct mfi_ld_info *ld_info;
96 	struct mfi_disk_pending *ld_pend;
97 	uint64_t sectors;
98 	uint32_t secsize;
99 	char *state;
100 
101 	sc = device_get_softc(dev);
102 	ld_info = device_get_ivars(dev);
103 
104 	sc->ld_dev = dev;
105 	sc->ld_id = ld_info->ld_config.properties.ld.v.target_id;
106 	sc->ld_unit = device_get_unit(dev);
107 	sc->ld_info = ld_info;
108 	sc->ld_controller = device_get_softc(device_get_parent(dev));
109 	sc->ld_flags = 0;
110 
111 	sectors = ld_info->size;
112 	secsize = MFI_SECTOR_LEN;
113 	mtx_lock(&sc->ld_controller->mfi_io_lock);
114 	TAILQ_INSERT_TAIL(&sc->ld_controller->mfi_ld_tqh, sc, ld_link);
115 	TAILQ_FOREACH(ld_pend, &sc->ld_controller->mfi_ld_pend_tqh,
116 	    ld_link) {
117 		TAILQ_REMOVE(&sc->ld_controller->mfi_ld_pend_tqh,
118 		    ld_pend, ld_link);
119 		free(ld_pend, M_MFIBUF);
120 		break;
121 	}
122 	mtx_unlock(&sc->ld_controller->mfi_io_lock);
123 
124 	switch (ld_info->ld_config.params.state) {
125 	case MFI_LD_STATE_OFFLINE:
126 		state = "offline";
127 		break;
128 	case MFI_LD_STATE_PARTIALLY_DEGRADED:
129 		state = "partially degraded";
130 		break;
131 	case MFI_LD_STATE_DEGRADED:
132 		state = "degraded";
133 		break;
134 	case MFI_LD_STATE_OPTIMAL:
135 		state = "optimal";
136 		break;
137 	default:
138 		state = "unknown";
139 		break;
140 	}
141 
142 	if ( strlen(ld_info->ld_config.properties.name) == 0 ) {
143 		device_printf(dev,
144 		      "%juMB (%ju sectors) RAID volume (no label) is %s\n",
145 		       sectors / (1024 * 1024 / secsize), sectors, state);
146 	} else {
147 		device_printf(dev,
148 		      "%juMB (%ju sectors) RAID volume '%s' is %s\n",
149 		      sectors / (1024 * 1024 / secsize), sectors,
150 		      ld_info->ld_config.properties.name, state);
151 	}
152 
153 	sc->ld_disk = disk_alloc();
154 	sc->ld_disk->d_drv1 = sc;
155 	sc->ld_disk->d_maxsize = min(sc->ld_controller->mfi_max_io * secsize,
156 	    (sc->ld_controller->mfi_max_sge - 1) * PAGE_SIZE);
157 	sc->ld_disk->d_name = "mfid";
158 	sc->ld_disk->d_open = mfi_disk_open;
159 	sc->ld_disk->d_close = mfi_disk_close;
160 	sc->ld_disk->d_strategy = mfi_disk_strategy;
161 	sc->ld_disk->d_dump = mfi_disk_dump;
162 	sc->ld_disk->d_unit = sc->ld_unit;
163 	sc->ld_disk->d_sectorsize = secsize;
164 	sc->ld_disk->d_mediasize = sectors * secsize;
165 	if (sc->ld_disk->d_mediasize >= (1 * 1024 * 1024)) {
166 		sc->ld_disk->d_fwheads = 255;
167 		sc->ld_disk->d_fwsectors = 63;
168 	} else {
169 		sc->ld_disk->d_fwheads = 64;
170 		sc->ld_disk->d_fwsectors = 32;
171 	}
172 	sc->ld_disk->d_flags = DISKFLAG_UNMAPPED_BIO;
173 	disk_create(sc->ld_disk, DISK_VERSION);
174 
175 	return (0);
176 }
177 
178 static int
179 mfi_disk_detach(device_t dev)
180 {
181 	struct mfi_disk *sc;
182 
183 	sc = device_get_softc(dev);
184 
185 	mtx_lock(&sc->ld_controller->mfi_io_lock);
186 	if (((sc->ld_disk->d_flags & DISKFLAG_OPEN) ||
187 	    (sc->ld_flags & MFI_DISK_FLAGS_OPEN)) &&
188 	    (sc->ld_controller->mfi_keep_deleted_volumes ||
189 	    sc->ld_controller->mfi_detaching)) {
190 		mtx_unlock(&sc->ld_controller->mfi_io_lock);
191 		return (EBUSY);
192 	}
193 	mtx_unlock(&sc->ld_controller->mfi_io_lock);
194 
195 	disk_destroy(sc->ld_disk);
196 	mtx_lock(&sc->ld_controller->mfi_io_lock);
197 	TAILQ_REMOVE(&sc->ld_controller->mfi_ld_tqh, sc, ld_link);
198 	mtx_unlock(&sc->ld_controller->mfi_io_lock);
199 	free(sc->ld_info, M_MFIBUF);
200 	return (0);
201 }
202 
203 static int
204 mfi_disk_open(struct disk *dp)
205 {
206 	struct mfi_disk *sc;
207 	int error;
208 
209 	sc = dp->d_drv1;
210 	mtx_lock(&sc->ld_controller->mfi_io_lock);
211 	if (sc->ld_flags & MFI_DISK_FLAGS_DISABLED)
212 		error = ENXIO;
213 	else {
214 		sc->ld_flags |= MFI_DISK_FLAGS_OPEN;
215 		error = 0;
216 	}
217 	mtx_unlock(&sc->ld_controller->mfi_io_lock);
218 
219 	return (error);
220 }
221 
222 static int
223 mfi_disk_close(struct disk *dp)
224 {
225 	struct mfi_disk *sc;
226 
227 	sc = dp->d_drv1;
228 	mtx_lock(&sc->ld_controller->mfi_io_lock);
229 	sc->ld_flags &= ~MFI_DISK_FLAGS_OPEN;
230 	mtx_unlock(&sc->ld_controller->mfi_io_lock);
231 
232 	return (0);
233 }
234 
235 int
236 mfi_disk_disable(struct mfi_disk *sc)
237 {
238 
239 	mtx_assert(&sc->ld_controller->mfi_io_lock, MA_OWNED);
240 	if (sc->ld_flags & MFI_DISK_FLAGS_OPEN) {
241 		if (sc->ld_controller->mfi_delete_busy_volumes)
242 			return (0);
243 		device_printf(sc->ld_dev, "Unable to delete busy ld device\n");
244 		return (EBUSY);
245 	}
246 	sc->ld_flags |= MFI_DISK_FLAGS_DISABLED;
247 	return (0);
248 }
249 
250 void
251 mfi_disk_enable(struct mfi_disk *sc)
252 {
253 
254 	mtx_assert(&sc->ld_controller->mfi_io_lock, MA_OWNED);
255 	sc->ld_flags &= ~MFI_DISK_FLAGS_DISABLED;
256 }
257 
258 static void
259 mfi_disk_strategy(struct bio *bio)
260 {
261 	struct mfi_disk *sc;
262 	struct mfi_softc *controller;
263 
264 	sc = bio->bio_disk->d_drv1;
265 
266 	if (sc == NULL) {
267 		bio->bio_error = EINVAL;
268 		bio->bio_flags |= BIO_ERROR;
269 		bio->bio_resid = bio->bio_bcount;
270 		biodone(bio);
271 		return;
272 	}
273 
274 	controller = sc->ld_controller;
275 	if (controller->adpreset) {
276 		bio->bio_error = EBUSY;
277 		return;
278 	}
279 
280 	if (controller->hw_crit_error) {
281 		bio->bio_error = EBUSY;
282 		return;
283 	}
284 
285 	if (controller->issuepend_done == 0) {
286 		bio->bio_error = EBUSY;
287 		return;
288 	}
289 
290 	bio->bio_driver1 = (void *)(uintptr_t)sc->ld_id;
291 	/* Mark it as LD IO */
292 	bio->bio_driver2 = (void *)MFI_LD_IO;
293 	mtx_lock(&controller->mfi_io_lock);
294 	mfi_enqueue_bio(controller, bio);
295 	mfi_startio(controller);
296 	mtx_unlock(&controller->mfi_io_lock);
297 	return;
298 }
299 
300 void
301 mfi_disk_complete(struct bio *bio)
302 {
303 
304 	if (bio->bio_flags & BIO_ERROR) {
305 		bio->bio_resid = bio->bio_bcount;
306 		if (bio->bio_error == 0)
307 			bio->bio_error = EIO;
308 		disk_err(bio, "hard error", -1, 1);
309 	} else {
310 		bio->bio_resid = 0;
311 	}
312 	biodone(bio);
313 }
314 
315 static int
316 mfi_disk_dump(void *arg, void *virt, off_t offset, size_t len)
317 {
318 	struct mfi_disk *sc;
319 	struct mfi_softc *parent_sc;
320 	struct disk *dp;
321 	int error;
322 
323 	dp = arg;
324 	sc = dp->d_drv1;
325 	parent_sc = sc->ld_controller;
326 
327 	if (len > 0) {
328 		if ((error = mfi_dump_blocks(parent_sc, sc->ld_id, offset /
329 		    MFI_SECTOR_LEN, virt, len)) != 0)
330 			return (error);
331 	} else {
332 		/* mfi_sync_cache(parent_sc, sc->ld_id); */
333 	}
334 
335 	return (0);
336 }
337