2 * Copyright (c) 2017, 2018 The FreeBSD Foundation
4 * Copyright (c) 2018, 2019 Intel Corporation
6 * This software was developed by Konstantin Belousov <kib@FreeBSD.org>
7 * under sponsorship from the FreeBSD Foundation.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
37 #include <sys/param.h>
38 #include <sys/systm.h>
42 #include <sys/devicestat.h>
45 #include <sys/kernel.h>
46 #include <sys/kthread.h>
47 #include <sys/limits.h>
49 #include <sys/malloc.h>
50 #include <sys/module.h>
51 #include <sys/rwlock.h>
52 #include <sys/sglist.h>
55 #include <geom/geom.h>
56 #include <geom/geom_int.h>
57 #include <machine/vmparam.h>
59 #include <vm/vm_object.h>
60 #include <vm/vm_page.h>
61 #include <vm/vm_pager.h>
62 #include <contrib/dev/acpica/include/acpi.h>
63 #include <contrib/dev/acpica/include/accommon.h>
64 #include <contrib/dev/acpica/include/acuuid.h>
65 #include <dev/acpica/acpivar.h>
66 #include <dev/nvdimm/nvdimm_var.h>
68 #define UUID_INITIALIZER_VOLATILE_MEMORY \
69 {0x7305944f,0xfdda,0x44e3,0xb1,0x6c,{0x3f,0x22,0xd2,0x52,0xe5,0xd0}}
70 #define UUID_INITIALIZER_PERSISTENT_MEMORY \
71 {0x66f0d379,0xb4f3,0x4074,0xac,0x43,{0x0d,0x33,0x18,0xb7,0x8c,0xdb}}
72 #define UUID_INITIALIZER_CONTROL_REGION \
73 {0x92f701f6,0x13b4,0x405d,0x91,0x0b,{0x29,0x93,0x67,0xe8,0x23,0x4c}}
74 #define UUID_INITIALIZER_DATA_REGION \
75 {0x91af0530,0x5d86,0x470e,0xa6,0xb0,{0x0a,0x2d,0xb9,0x40,0x82,0x49}}
76 #define UUID_INITIALIZER_VOLATILE_VIRTUAL_DISK \
77 {0x77ab535a,0x45fc,0x624b,0x55,0x60,{0xf7,0xb2,0x81,0xd1,0xf9,0x6e}}
78 #define UUID_INITIALIZER_VOLATILE_VIRTUAL_CD \
79 {0x3d5abd30,0x4175,0x87ce,0x6d,0x64,{0xd2,0xad,0xe5,0x23,0xc4,0xbb}}
80 #define UUID_INITIALIZER_PERSISTENT_VIRTUAL_DISK \
81 {0x5cea02c9,0x4d07,0x69d3,0x26,0x9f,{0x44,0x96,0xfb,0xe0,0x96,0xf9}}
82 #define UUID_INITIALIZER_PERSISTENT_VIRTUAL_CD \
83 {0x08018188,0x42cd,0xbb48,0x10,0x0f,{0x53,0x87,0xd5,0x3d,0xed,0x3d}}
85 static struct nvdimm_SPA_uuid_list_elm {
89 } nvdimm_SPA_uuid_list[] = {
90 [SPA_TYPE_VOLATILE_MEMORY] = {
91 .u_name = "VOLA MEM ",
92 .u_id = UUID_INITIALIZER_VOLATILE_MEMORY,
95 [SPA_TYPE_PERSISTENT_MEMORY] = {
97 .u_id = UUID_INITIALIZER_PERSISTENT_MEMORY,
100 [SPA_TYPE_CONTROL_REGION] = {
101 .u_name = "CTRL RG ",
102 .u_id = UUID_INITIALIZER_CONTROL_REGION,
105 [SPA_TYPE_DATA_REGION] = {
106 .u_name = "DATA RG ",
107 .u_id = UUID_INITIALIZER_DATA_REGION,
110 [SPA_TYPE_VOLATILE_VIRTUAL_DISK] = {
111 .u_name = "VIRT DSK",
112 .u_id = UUID_INITIALIZER_VOLATILE_VIRTUAL_DISK,
115 [SPA_TYPE_VOLATILE_VIRTUAL_CD] = {
116 .u_name = "VIRT CD ",
117 .u_id = UUID_INITIALIZER_VOLATILE_VIRTUAL_CD,
120 [SPA_TYPE_PERSISTENT_VIRTUAL_DISK] = {
122 .u_id = UUID_INITIALIZER_PERSISTENT_VIRTUAL_DISK,
125 [SPA_TYPE_PERSISTENT_VIRTUAL_CD] = {
127 .u_id = UUID_INITIALIZER_PERSISTENT_VIRTUAL_CD,
132 enum SPA_mapping_type
133 nvdimm_spa_type_from_uuid(struct uuid *uuid)
137 for (j = 0; j < nitems(nvdimm_SPA_uuid_list); j++) {
138 if (uuidcmp(uuid, &nvdimm_SPA_uuid_list[j].u_id) != 0)
142 return (SPA_TYPE_UNKNOWN);
146 nvdimm_spa_memattr(struct nvdimm_spa_dev *dev)
150 if ((dev->spa_efi_mem_flags & EFI_MD_ATTR_WB) != 0)
151 mode = VM_MEMATTR_WRITE_BACK;
152 else if ((dev->spa_efi_mem_flags & EFI_MD_ATTR_WT) != 0)
153 mode = VM_MEMATTR_WRITE_THROUGH;
154 else if ((dev->spa_efi_mem_flags & EFI_MD_ATTR_WC) != 0)
155 mode = VM_MEMATTR_WRITE_COMBINING;
156 else if ((dev->spa_efi_mem_flags & EFI_MD_ATTR_WP) != 0)
157 mode = VM_MEMATTR_WRITE_PROTECTED;
158 else if ((dev->spa_efi_mem_flags & EFI_MD_ATTR_UC) != 0)
159 mode = VM_MEMATTR_UNCACHEABLE;
162 printf("SPA mapping attr %#lx unsupported\n",
163 dev->spa_efi_mem_flags);
164 mode = VM_MEMATTR_UNCACHEABLE;
170 nvdimm_spa_uio(struct nvdimm_spa_dev *dev, struct uio *uio)
172 struct vm_page m, *ma;
178 if (dev->spa_kva == NULL) {
179 mattr = nvdimm_spa_memattr(dev);
180 bzero(&m, sizeof(m));
181 vm_page_initfake(&m, 0, mattr);
183 while (uio->uio_resid > 0) {
184 if (uio->uio_offset >= dev->spa_len)
186 off = dev->spa_phys_base + uio->uio_offset;
187 vm_page_updatefake(&m, trunc_page(off), mattr);
189 if (n > uio->uio_resid)
191 error = uiomove_fromphys(&ma, off & PAGE_MASK, n, uio);
196 while (uio->uio_resid > 0) {
197 if (uio->uio_offset >= dev->spa_len)
200 if (n > uio->uio_resid)
202 if (uio->uio_offset + n > dev->spa_len)
203 n = dev->spa_len - uio->uio_offset;
204 error = uiomove((char *)dev->spa_kva + uio->uio_offset,
214 nvdimm_spa_rw(struct cdev *dev, struct uio *uio, int ioflag)
217 return (nvdimm_spa_uio(dev->si_drv1, uio));
221 nvdimm_spa_ioctl(struct cdev *cdev, u_long cmd, caddr_t data, int fflag,
224 struct nvdimm_spa_dev *dev;
230 case DIOCGSECTORSIZE:
231 *(u_int *)data = DEV_BSIZE;
234 *(off_t *)data = dev->spa_len;
244 nvdimm_spa_mmap_single(struct cdev *cdev, vm_ooffset_t *offset, vm_size_t size,
245 vm_object_t *objp, int nprot)
247 struct nvdimm_spa_dev *dev;
250 if (dev->spa_obj == NULL)
252 if (*offset >= dev->spa_len || *offset + size < *offset ||
253 *offset + size > dev->spa_len)
255 vm_object_reference(dev->spa_obj);
256 *objp = dev->spa_obj;
260 static struct cdevsw spa_cdevsw = {
261 .d_version = D_VERSION,
263 .d_name = "nvdimm_spa",
264 .d_read = nvdimm_spa_rw,
265 .d_write = nvdimm_spa_rw,
266 .d_ioctl = nvdimm_spa_ioctl,
267 .d_mmap_single = nvdimm_spa_mmap_single,
271 nvdimm_spa_g_all_unmapped(struct nvdimm_spa_dev *dev, struct bio *bp, int rw)
273 struct vm_page maa[bp->bio_ma_n];
274 vm_page_t ma[bp->bio_ma_n];
278 mattr = nvdimm_spa_memattr(dev);
279 for (i = 0; i < nitems(ma); i++) {
280 bzero(&maa[i], sizeof(maa[i]));
281 vm_page_initfake(&maa[i], dev->spa_phys_base +
282 trunc_page(bp->bio_offset) + PAGE_SIZE * i, mattr);
286 pmap_copy_pages(ma, bp->bio_offset & PAGE_MASK, bp->bio_ma,
287 bp->bio_ma_offset, bp->bio_length);
289 pmap_copy_pages(bp->bio_ma, bp->bio_ma_offset, ma,
290 bp->bio_offset & PAGE_MASK, bp->bio_length);
294 nvdimm_spa_g_thread(void *arg)
304 mtx_lock(&sc->spa_g_mtx);
306 bp = bioq_takefirst(&sc->spa_g_queue);
309 msleep(&sc->spa_g_queue, &sc->spa_g_mtx, PRIBIO,
311 if (!sc->spa_g_proc_run) {
312 sc->spa_g_proc_exiting = true;
313 wakeup(&sc->spa_g_queue);
314 mtx_unlock(&sc->spa_g_mtx);
319 mtx_unlock(&sc->spa_g_mtx);
320 if (bp->bio_cmd != BIO_READ && bp->bio_cmd != BIO_WRITE &&
321 bp->bio_cmd != BIO_FLUSH) {
327 if (bp->bio_cmd == BIO_FLUSH) {
328 if (sc->dev->spa_kva != NULL) {
329 pmap_large_map_wb(sc->dev->spa_kva,
332 pmap_flush_cache_phys_range(
333 (vm_paddr_t)sc->dev->spa_phys_base,
334 (vm_paddr_t)sc->dev->spa_phys_base +
336 nvdimm_spa_memattr(sc->dev));
344 if ((bp->bio_flags & BIO_UNMAPPED) != 0) {
345 if (sc->dev->spa_kva != NULL) {
346 aiovec.iov_base = (char *)sc->dev->spa_kva +
348 aiovec.iov_len = bp->bio_length;
349 auio.uio_iov = &aiovec;
351 auio.uio_resid = bp->bio_length;
352 auio.uio_offset = bp->bio_offset;
353 auio.uio_segflg = UIO_SYSSPACE;
354 auio.uio_rw = bp->bio_cmd == BIO_READ ?
355 UIO_WRITE : UIO_READ;
356 auio.uio_td = curthread;
357 error = uiomove_fromphys(bp->bio_ma,
358 bp->bio_ma_offset, bp->bio_length, &auio);
359 bp->bio_resid = auio.uio_resid;
361 nvdimm_spa_g_all_unmapped(sc->dev, bp,
363 bp->bio_resid = bp->bio_length;
367 aiovec.iov_base = bp->bio_data;
368 aiovec.iov_len = bp->bio_length;
369 auio.uio_iov = &aiovec;
371 auio.uio_resid = bp->bio_length;
372 auio.uio_offset = bp->bio_offset;
373 auio.uio_segflg = UIO_SYSSPACE;
374 auio.uio_rw = bp->bio_cmd == BIO_READ ? UIO_READ :
376 auio.uio_td = curthread;
377 error = nvdimm_spa_uio(sc->dev, &auio);
378 bp->bio_resid = auio.uio_resid;
380 bp->bio_bcount = bp->bio_length;
381 devstat_end_transaction_bio(sc->spa_g_devstat, bp);
383 bp->bio_completed = bp->bio_length;
384 g_io_deliver(bp, error);
389 nvdimm_spa_g_start(struct bio *bp)
393 sc = bp->bio_to->geom->softc;
394 if (bp->bio_cmd == BIO_READ || bp->bio_cmd == BIO_WRITE) {
395 mtx_lock(&sc->spa_g_stat_mtx);
396 devstat_start_transaction_bio(sc->spa_g_devstat, bp);
397 mtx_unlock(&sc->spa_g_stat_mtx);
399 mtx_lock(&sc->spa_g_mtx);
400 bioq_disksort(&sc->spa_g_queue, bp);
401 wakeup(&sc->spa_g_queue);
402 mtx_unlock(&sc->spa_g_mtx);
406 nvdimm_spa_g_access(struct g_provider *pp, int r, int w, int e)
412 static struct g_geom * nvdimm_spa_g_create(struct nvdimm_spa_dev *dev,
414 static g_ctl_destroy_geom_t nvdimm_spa_g_destroy_geom;
416 struct g_class nvdimm_spa_g_class = {
418 .version = G_VERSION,
419 .start = nvdimm_spa_g_start,
420 .access = nvdimm_spa_g_access,
421 .destroy_geom = nvdimm_spa_g_destroy_geom,
423 DECLARE_GEOM_CLASS(nvdimm_spa_g_class, g_spa);
426 nvdimm_spa_init(struct SPA_mapping *spa, ACPI_NFIT_SYSTEM_ADDRESS *nfitaddr,
427 enum SPA_mapping_type spa_type)
432 spa->spa_type = spa_type;
433 spa->spa_nfit_idx = nfitaddr->RangeIndex;
434 spa->dev.spa_domain =
435 ((nfitaddr->Flags & ACPI_NFIT_PROXIMITY_VALID) != 0) ?
436 nfitaddr->ProximityDomain : -1;
437 spa->dev.spa_phys_base = nfitaddr->Address;
438 spa->dev.spa_len = nfitaddr->Length;
439 spa->dev.spa_efi_mem_flags = nfitaddr->MemoryMapping;
441 printf("NVDIMM SPA%d base %#016jx len %#016jx %s fl %#jx\n",
443 (uintmax_t)spa->dev.spa_phys_base,
444 (uintmax_t)spa->dev.spa_len,
445 nvdimm_SPA_uuid_list[spa_type].u_name,
446 spa->dev.spa_efi_mem_flags);
448 if (!nvdimm_SPA_uuid_list[spa_type].u_usr_acc)
451 asprintf(&name, M_NVDIMM, "spa%d", spa->spa_nfit_idx);
452 error = nvdimm_spa_dev_init(&spa->dev, name);
453 free(name, M_NVDIMM);
458 nvdimm_spa_dev_init(struct nvdimm_spa_dev *dev, const char *name)
460 struct make_dev_args mda;
461 struct sglist *spa_sg;
465 error1 = pmap_large_map(dev->spa_phys_base, dev->spa_len,
466 &dev->spa_kva, nvdimm_spa_memattr(dev));
468 printf("NVDIMM %s cannot map into KVA, error %d\n", name,
473 spa_sg = sglist_alloc(1, M_WAITOK);
474 error = sglist_append_phys(spa_sg, dev->spa_phys_base,
477 dev->spa_obj = vm_pager_allocate(OBJT_SG, spa_sg, dev->spa_len,
478 VM_PROT_ALL, 0, NULL);
479 if (dev->spa_obj == NULL) {
480 printf("NVDIMM %s failed to alloc vm object", name);
484 printf("NVDIMM %s failed to init sglist, error %d", name,
489 make_dev_args_init(&mda);
490 mda.mda_flags = MAKEDEV_WAITOK | MAKEDEV_CHECKNAME;
491 mda.mda_devsw = &spa_cdevsw;
493 mda.mda_uid = UID_ROOT;
494 mda.mda_gid = GID_OPERATOR;
496 mda.mda_si_drv1 = dev;
497 asprintf(&devname, M_NVDIMM, "nvdimm_%s", name);
498 error = make_dev_s(&mda, &dev->spa_dev, "%s", devname);
499 free(devname, M_NVDIMM);
501 printf("NVDIMM %s cannot create devfs node, error %d\n", name,
506 dev->spa_g = nvdimm_spa_g_create(dev, name);
507 if (dev->spa_g == NULL && error1 == 0)
512 static struct g_geom *
513 nvdimm_spa_g_create(struct nvdimm_spa_dev *dev, const char *name)
520 sc = malloc(sizeof(struct g_spa), M_NVDIMM, M_WAITOK | M_ZERO);
522 bioq_init(&sc->spa_g_queue);
523 mtx_init(&sc->spa_g_mtx, "spag", NULL, MTX_DEF);
524 mtx_init(&sc->spa_g_stat_mtx, "spagst", NULL, MTX_DEF);
525 sc->spa_g_proc_run = true;
526 sc->spa_g_proc_exiting = false;
527 error = kproc_create(nvdimm_spa_g_thread, sc, &sc->spa_g_proc, 0, 0,
530 mtx_destroy(&sc->spa_g_mtx);
531 mtx_destroy(&sc->spa_g_stat_mtx);
533 printf("NVDIMM %s cannot create geom worker, error %d\n", name,
537 gp = g_new_geomf(&nvdimm_spa_g_class, "%s", name);
539 sc->spa_p = g_new_providerf(gp, "%s", name);
540 sc->spa_p->mediasize = dev->spa_len;
541 sc->spa_p->sectorsize = DEV_BSIZE;
542 sc->spa_p->flags |= G_PF_DIRECT_SEND | G_PF_DIRECT_RECEIVE |
543 G_PF_ACCEPT_UNMAPPED;
544 g_error_provider(sc->spa_p, 0);
545 sc->spa_g_devstat = devstat_new_entry("spa", -1, DEV_BSIZE,
546 DEVSTAT_ALL_SUPPORTED, DEVSTAT_TYPE_DIRECT,
547 DEVSTAT_PRIORITY_MAX);
554 nvdimm_spa_fini(struct SPA_mapping *spa)
557 nvdimm_spa_dev_fini(&spa->dev);
561 nvdimm_spa_dev_fini(struct nvdimm_spa_dev *dev)
564 if (dev->spa_g != NULL) {
566 nvdimm_spa_g_destroy_geom(NULL, dev->spa_g->class, dev->spa_g);
569 if (dev->spa_dev != NULL) {
570 destroy_dev(dev->spa_dev);
573 vm_object_deallocate(dev->spa_obj);
574 if (dev->spa_kva != NULL) {
575 pmap_large_unmap(dev->spa_kva, dev->spa_len);
581 nvdimm_spa_g_destroy_geom(struct gctl_req *req, struct g_class *cp,
587 mtx_lock(&sc->spa_g_mtx);
588 sc->spa_g_proc_run = false;
589 wakeup(&sc->spa_g_queue);
590 while (!sc->spa_g_proc_exiting)
591 msleep(&sc->spa_g_queue, &sc->spa_g_mtx, PRIBIO, "spa_e", 0);
592 mtx_unlock(&sc->spa_g_mtx);
594 g_wither_geom(gp, ENXIO);
596 if (sc->spa_g_devstat != NULL) {
597 devstat_remove_entry(sc->spa_g_devstat);
598 sc->spa_g_devstat = NULL;
600 mtx_destroy(&sc->spa_g_mtx);
601 mtx_destroy(&sc->spa_g_stat_mtx);