nvd.c revision 293663 
1/*-
2 * Copyright (C) 2012-2013 Intel Corporation
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27#include <sys/cdefs.h>
28__FBSDID("$FreeBSD: stable/10/sys/dev/nvd/nvd.c 293663 2016-01-11 17:20:30Z jimharris $");
29
30#include <sys/param.h>
31#include <sys/bio.h>
32#include <sys/kernel.h>
33#include <sys/malloc.h>
34#include <sys/module.h>
35#include <sys/systm.h>
36#include <sys/taskqueue.h>
37
38#include <geom/geom.h>
39#include <geom/geom_disk.h>
40
41#include <dev/nvme/nvme.h>
42
43#define NVD_STR		"nvd"
44
45struct nvd_disk;
46
47static disk_ioctl_t nvd_ioctl;
48static disk_strategy_t nvd_strategy;
49
50static void *nvd_new_disk(struct nvme_namespace *ns, void *ctrlr);
51static void destroy_geom_disk(struct nvd_disk *ndisk);
52
53static void *nvd_new_controller(struct nvme_controller *ctrlr);
54static void nvd_controller_fail(void *ctrlr);
55
56static int nvd_load(void);
57static void nvd_unload(void);
58
59MALLOC_DEFINE(M_NVD, "nvd", "nvd(4) allocations");
60
61struct nvme_consumer *consumer_handle;
62
63struct nvd_disk {
64
65	struct bio_queue_head	bioq;
66	struct task		bioqtask;
67	struct mtx		bioqlock;
68
69	struct disk		*disk;
70	struct taskqueue	*tq;
71	struct nvme_namespace	*ns;
72
73	uint32_t		cur_depth;
74
75	TAILQ_ENTRY(nvd_disk)	global_tailq;
76	TAILQ_ENTRY(nvd_disk)	ctrlr_tailq;
77};
78
79struct nvd_controller {
80
81	TAILQ_ENTRY(nvd_controller)	tailq;
82	TAILQ_HEAD(, nvd_disk)		disk_head;
83};
84
85static TAILQ_HEAD(, nvd_controller)	ctrlr_head;
86static TAILQ_HEAD(disk_list, nvd_disk)	disk_head;
87
88static int nvd_modevent(module_t mod, int type, void *arg)
89{
90	int error = 0;
91
92	switch (type) {
93	case MOD_LOAD:
94		error = nvd_load();
95		break;
96	case MOD_UNLOAD:
97		nvd_unload();
98		break;
99	default:
100		break;
101	}
102
103	return (error);
104}
105
106moduledata_t nvd_mod = {
107	NVD_STR,
108	(modeventhand_t)nvd_modevent,
109	0
110};
111
112DECLARE_MODULE(nvd, nvd_mod, SI_SUB_DRIVERS, SI_ORDER_ANY);
113MODULE_VERSION(nvd, 1);
114MODULE_DEPEND(nvd, nvme, 1, 1, 1);
115
116static int
117nvd_load()
118{
119
120	TAILQ_INIT(&ctrlr_head);
121	TAILQ_INIT(&disk_head);
122
123	consumer_handle = nvme_register_consumer(nvd_new_disk,
124	    nvd_new_controller, NULL, nvd_controller_fail);
125
126	return (consumer_handle != NULL ? 0 : -1);
127}
128
129static void
130nvd_unload()
131{
132	struct nvd_controller	*ctrlr;
133	struct nvd_disk		*disk;
134
135	while (!TAILQ_EMPTY(&ctrlr_head)) {
136		ctrlr = TAILQ_FIRST(&ctrlr_head);
137		TAILQ_REMOVE(&ctrlr_head, ctrlr, tailq);
138		free(ctrlr, M_NVD);
139	}
140
141	while (!TAILQ_EMPTY(&disk_head)) {
142		disk = TAILQ_FIRST(&disk_head);
143		TAILQ_REMOVE(&disk_head, disk, global_tailq);
144		destroy_geom_disk(disk);
145		free(disk, M_NVD);
146	}
147
148	nvme_unregister_consumer(consumer_handle);
149}
150
151static void
152nvd_strategy(struct bio *bp)
153{
154	struct nvd_disk *ndisk;
155
156	ndisk = (struct nvd_disk *)bp->bio_disk->d_drv1;
157
158	mtx_lock(&ndisk->bioqlock);
159	bioq_insert_tail(&ndisk->bioq, bp);
160	mtx_unlock(&ndisk->bioqlock);
161	taskqueue_enqueue(ndisk->tq, &ndisk->bioqtask);
162}
163
164static int
165nvd_ioctl(struct disk *ndisk, u_long cmd, void *data, int fflag,
166    struct thread *td)
167{
168	int ret = 0;
169
170	switch (cmd) {
171	default:
172		ret = EIO;
173	}
174
175	return (ret);
176}
177
178static void
179nvd_done(void *arg, const struct nvme_completion *cpl)
180{
181	struct bio *bp;
182	struct nvd_disk *ndisk;
183
184	bp = (struct bio *)arg;
185
186	ndisk = bp->bio_disk->d_drv1;
187
188	atomic_add_int(&ndisk->cur_depth, -1);
189
190	biodone(bp);
191}
192
193static void
194nvd_bioq_process(void *arg, int pending)
195{
196	struct nvd_disk *ndisk = arg;
197	struct bio *bp;
198	int err;
199
200	for (;;) {
201		mtx_lock(&ndisk->bioqlock);
202		bp = bioq_takefirst(&ndisk->bioq);
203		mtx_unlock(&ndisk->bioqlock);
204		if (bp == NULL)
205			break;
206
207		bp->bio_driver1 = NULL;
208		atomic_add_int(&ndisk->cur_depth, 1);
209
210		err = nvme_ns_bio_process(ndisk->ns, bp, nvd_done);
211
212		if (err) {
213			atomic_add_int(&ndisk->cur_depth, -1);
214			bp->bio_error = err;
215			bp->bio_flags |= BIO_ERROR;
216			bp->bio_resid = bp->bio_bcount;
217			biodone(bp);
218		}
219
220#ifdef BIO_ORDERED
221		/*
222		 * BIO_ORDERED flag dictates that the bio with BIO_ORDERED
223		 *  flag set must be completed before proceeding with
224		 *  additional bios.
225		 */
226		if (bp->bio_flags & BIO_ORDERED) {
227			while (ndisk->cur_depth > 0) {
228				pause("nvd flush", 1);
229			}
230		}
231#endif
232	}
233}
234
235static void *
236nvd_new_controller(struct nvme_controller *ctrlr)
237{
238	struct nvd_controller	*nvd_ctrlr;
239
240	nvd_ctrlr = malloc(sizeof(struct nvd_controller), M_NVD,
241	    M_ZERO | M_WAITOK);
242
243	TAILQ_INIT(&nvd_ctrlr->disk_head);
244	TAILQ_INSERT_TAIL(&ctrlr_head, nvd_ctrlr, tailq);
245
246	return (nvd_ctrlr);
247}
248
249static void *
250nvd_new_disk(struct nvme_namespace *ns, void *ctrlr_arg)
251{
252	uint8_t			descr[NVME_MODEL_NUMBER_LENGTH+1];
253	struct nvd_disk		*ndisk;
254	struct disk		*disk;
255	struct nvd_controller	*ctrlr = ctrlr_arg;
256
257	ndisk = malloc(sizeof(struct nvd_disk), M_NVD, M_ZERO | M_WAITOK);
258
259	disk = disk_alloc();
260	disk->d_strategy = nvd_strategy;
261	disk->d_ioctl = nvd_ioctl;
262	disk->d_name = NVD_STR;
263	disk->d_drv1 = ndisk;
264
265	disk->d_maxsize = nvme_ns_get_max_io_xfer_size(ns);
266	disk->d_sectorsize = nvme_ns_get_sector_size(ns);
267	disk->d_mediasize = (off_t)nvme_ns_get_size(ns);
268	disk->d_delmaxsize = (off_t)nvme_ns_get_size(ns);
269	disk->d_stripesize = nvme_ns_get_stripesize(ns);
270
271	if (TAILQ_EMPTY(&disk_head))
272		disk->d_unit = 0;
273	else
274		disk->d_unit =
275		    TAILQ_LAST(&disk_head, disk_list)->disk->d_unit + 1;
276
277	disk->d_flags = DISKFLAG_DIRECT_COMPLETION;
278
279	if (nvme_ns_get_flags(ns) & NVME_NS_DEALLOCATE_SUPPORTED)
280		disk->d_flags |= DISKFLAG_CANDELETE;
281
282	if (nvme_ns_get_flags(ns) & NVME_NS_FLUSH_SUPPORTED)
283		disk->d_flags |= DISKFLAG_CANFLUSHCACHE;
284
285/* ifdef used here to ease porting to stable branches at a later point. */
286#ifdef DISKFLAG_UNMAPPED_BIO
287	disk->d_flags |= DISKFLAG_UNMAPPED_BIO;
288#endif
289
290	/*
291	 * d_ident and d_descr are both far bigger than the length of either
292	 *  the serial or model number strings.
293	 */
294	nvme_strvis(disk->d_ident, nvme_ns_get_serial_number(ns),
295	    sizeof(disk->d_ident), NVME_SERIAL_NUMBER_LENGTH);
296
297	nvme_strvis(descr, nvme_ns_get_model_number(ns), sizeof(descr),
298	    NVME_MODEL_NUMBER_LENGTH);
299
300#if __FreeBSD_version >= 900034
301	strlcpy(disk->d_descr, descr, sizeof(descr));
302#endif
303
304	ndisk->ns = ns;
305	ndisk->disk = disk;
306	ndisk->cur_depth = 0;
307
308	mtx_init(&ndisk->bioqlock, "NVD bioq lock", NULL, MTX_DEF);
309	bioq_init(&ndisk->bioq);
310
311	TASK_INIT(&ndisk->bioqtask, 0, nvd_bioq_process, ndisk);
312	ndisk->tq = taskqueue_create("nvd_taskq", M_WAITOK,
313	    taskqueue_thread_enqueue, &ndisk->tq);
314	taskqueue_start_threads(&ndisk->tq, 1, PI_DISK, "nvd taskq");
315
316	TAILQ_INSERT_TAIL(&disk_head, ndisk, global_tailq);
317	TAILQ_INSERT_TAIL(&ctrlr->disk_head, ndisk, ctrlr_tailq);
318
319	disk_create(disk, DISK_VERSION);
320
321	printf(NVD_STR"%u: <%s> NVMe namespace\n", disk->d_unit, descr);
322	printf(NVD_STR"%u: %juMB (%ju %u byte sectors)\n", disk->d_unit,
323		(uintmax_t)disk->d_mediasize / (1024*1024),
324		(uintmax_t)disk->d_mediasize / disk->d_sectorsize,
325		disk->d_sectorsize);
326
327	return (NULL);
328}
329
330static void
331destroy_geom_disk(struct nvd_disk *ndisk)
332{
333	struct bio	*bp;
334	struct disk	*disk;
335	uint32_t	unit;
336	int		cnt = 0;
337
338	disk = ndisk->disk;
339	unit = disk->d_unit;
340	taskqueue_free(ndisk->tq);
341
342	disk_destroy(ndisk->disk);
343
344	mtx_lock(&ndisk->bioqlock);
345	for (;;) {
346		bp = bioq_takefirst(&ndisk->bioq);
347		if (bp == NULL)
348			break;
349		bp->bio_error = EIO;
350		bp->bio_flags |= BIO_ERROR;
351		bp->bio_resid = bp->bio_bcount;
352		cnt++;
353		biodone(bp);
354	}
355
356	printf(NVD_STR"%u: lost device - %d outstanding\n", unit, cnt);
357	printf(NVD_STR"%u: removing device entry\n", unit);
358
359	mtx_unlock(&ndisk->bioqlock);
360
361	mtx_destroy(&ndisk->bioqlock);
362}
363
364static void
365nvd_controller_fail(void *ctrlr_arg)
366{
367	struct nvd_controller	*ctrlr = ctrlr_arg;
368	struct nvd_disk		*disk;
369
370	while (!TAILQ_EMPTY(&ctrlr->disk_head)) {
371		disk = TAILQ_FIRST(&ctrlr->disk_head);
372		TAILQ_REMOVE(&disk_head, disk, global_tailq);
373		TAILQ_REMOVE(&ctrlr->disk_head, disk, ctrlr_tailq);
374		destroy_geom_disk(disk);
375		free(disk, M_NVD);
376	}
377
378	TAILQ_REMOVE(&ctrlr_head, ctrlr, tailq);
379	free(ctrlr, M_NVD);
380}
381
382