38#include <sys/kernel.h>
40#include <sys/sysctl.h>
41#include <sys/taskqueue.h>
45#include <sys/devicestat.h>
46#include <sys/eventhandler.h>
47#include <sys/malloc.h>
50#include <sys/reboot.h>
53#include <geom/geom_disk.h>
79#define NDA_FLAG_STRING \
90#define NDA_Q_BIT_STRING \
103#define ccb_state ccb_h.ppriv_field0
104#define ccb_bp ccb_h.ppriv_ptr1
105#define ccb_trim ccb_h.ppriv_ptr1
124#ifdef CAM_TEST_FAILURE
125 int force_read_error;
126 int force_write_error;
127 int periodic_read_error;
128 int periodic_read_count;
131 struct sysctl_ctx_list sysctl_stats_ctx;
132 struct sysctl_oid *sysctl_stats_tree;
140 struct nvme_dsm_range
dsm[NVME_MAX_DSM_TRIM / sizeof(struct nvme_dsm_range)];
144 "NVME_MAX_DSM_TRIM must be an integral number of ranges");
152static void ndaasync(
void *callback_arg, u_int32_t code,
161 union ccb *done_ccb);
163 u_int32_t sense_flags);
167#ifndef NDA_DEFAULT_SEND_ORDERED
168#define NDA_DEFAULT_SEND_ORDERED 1
170#ifndef NDA_DEFAULT_TIMEOUT
171#define NDA_DEFAULT_TIMEOUT 30
173#ifndef NDA_DEFAULT_RETRY
174#define NDA_DEFAULT_RETRY 4
176#ifndef NDA_MAX_TRIM_ENTRIES
177#define NDA_MAX_TRIM_ENTRIES (NVME_MAX_DSM_TRIM / sizeof(struct nvme_dsm_range))
180static SYSCTL_NODE(_kern_cam, OID_AUTO, nda, CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
181 "CAM Direct Access Disk driver");
191 "Maximum number of BIO_DELETE to send down as a DSM TRIM.");
192SYSCTL_INT(_kern_cam_nda, OID_AUTO, enable_biospeedup, CTLFLAG_RDTUN,
194SYSCTL_INT(_kern_cam_nda, OID_AUTO, nvd_compat, CTLFLAG_RDTUN,
206 TAILQ_HEAD_INITIALIZER(
ndadriver.units), 0
230 nvme_ns_flush_cmd(&nvmeio->
cmd, softc->
nsid);
235 void *payload, uint32_t num_ranges)
242 num_ranges *
sizeof(
struct nvme_dsm_range),
244 nvme_ns_trim_cmd(&nvmeio->
cmd, softc->
nsid, num_ranges);
249 void *payload, uint64_t lba, uint32_t len, uint32_t count)
258 nvme_ns_write_cmd(&nvmeio->
cmd, softc->
nsid, lba, count);
263 struct bio *bp, uint32_t rwcmd)
270 if (bp->bio_flags & BIO_UNMAPPED) {
274 payload = bp->bio_data;
277 lba = bp->bio_pblkno;
278 count = bp->bio_bcount / softc->
disk->d_sectorsize;
287 nvme_ns_rw_cmd(&nvmeio->
cmd, rwcmd, softc->
nsid, lba, count);
341 0,
softc->disk->d_devstat);
346 softc->flags &= ~NDA_FLAG_DIRTY;
351 softc->flags &= ~NDA_FLAG_OPEN;
353 while (
softc->refcount != 0)
355 KASSERT(
softc->outstanding_cmds == 0,
356 (
"nda %d outstanding commands",
softc->outstanding_cmds));
391 struct nvme_get_nsid *gnsid = (
struct nvme_get_nsid *)data;
396 sizeof(gnsid->cdev));
400 case NVME_PASSTHROUGH_CMD:
402 struct nvme_pt_command *pt;
405 u_int maxmap = dp->d_maxsize;
411 pt = (
struct nvme_pt_command *)data;
427 memset(&mapinfo, 0,
sizeof(mapinfo));
468 periph = (
struct cam_periph *)bp->bio_disk->d_drv1;
480 biofinish(bp, NULL, ENXIO);
484 if (bp->bio_cmd == BIO_DELETE)
502ndadump(
void *arg,
void *
virtual, vm_offset_t physical, off_t offset,
size_t length)
516 secsize = softc->
disk->d_sectorsize;
517 lba = offset / secsize;
518 count = length / secsize;
524 memset(&nvmeio, 0,
sizeof(nvmeio));
532 printf(
"Aborting dump due to I/O error %d.\n", error);
561 printf(
"nda: Failed to attach master async callback "
562 "due to status 0x%x!\n", status);
565 if ((EVENTHANDLER_REGISTER(power_suspend,
ndasuspend,
566 NULL, EVENTHANDLER_PRI_LAST)) == NULL)
567 printf(
"ndainit: power event registration failed!\n");
568 if ((EVENTHANDLER_REGISTER(shutdown_post_sync,
ndashutdown,
569 NULL, SHUTDOWN_PRI_DEFAULT)) == NULL)
570 printf(
"ndainit: shutdown event registration failed!\n");
600 softc->invalidations++;
610 disk_gone(softc->
disk);
629 if (sysctl_ctx_free(&softc->sysctl_stats_ctx) != 0)
631 "can't remove sysctl stats context\n");
635 "can't remove sysctl context\n");
638 disk_destroy(softc->
disk);
639 free(softc, M_DEVBUF);
676 printf(
"ndaasync: Unable to attach to new device "
677 "due to status 0x%x\n", status);
684 buftype = (uintptr_t)arg;
688 softc = periph->
softc;
689 disk_attr_changed(softc->
disk,
"GEOM::physpath",
706 char tmpstr[32], tmpstr2[16];
717 snprintf(tmpstr,
sizeof(tmpstr),
"CAM NDA unit %d", periph->
unit_number);
718 snprintf(tmpstr2,
sizeof(tmpstr2),
"%d", periph->
unit_number);
723 SYSCTL_STATIC_CHILDREN(_kern_cam_nda), OID_AUTO, tmpstr2,
724 CTLFLAG_RD | CTLFLAG_MPSAFE, 0, tmpstr,
"device_index");
726 printf(
"ndasysctlinit: unable to allocate sysctl tree\n");
732 OID_AUTO,
"unmapped_io", CTLFLAG_RD,
736 OID_AUTO,
"deletes", CTLFLAG_RD,
737 &softc->
deletes,
"Number of BIO_DELETE requests");
742 "Total number of unmap/dsm commands sent");
746 "Total number of ranges in unmap/dsm commands");
749 "trim_lbas", CTLFLAG_RD, &softc->
trim_lbas,
750 "Total lbas in the unmap/dsm commands sent");
757 OID_AUTO,
"flags", CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE,
762 softc->sysctl_stats_tree = SYSCTL_ADD_NODE(&softc->sysctl_stats_ctx,
763 SYSCTL_CHILDREN(softc->
sysctl_tree), OID_AUTO,
"stats",
764 CTLFLAG_RD | CTLFLAG_MPSAFE, 0,
"Statistics");
765 if (softc->sysctl_stats_tree == NULL) {
766 printf(
"ndasysctlinit: unable to allocate sysctl tree for stats\n");
770 SYSCTL_ADD_INT(&softc->sysctl_stats_ctx,
771 SYSCTL_CHILDREN(softc->sysctl_stats_tree),
772 OID_AUTO,
"timeouts", CTLFLAG_RD,
774 "Device timeouts reported by the SIM");
775 SYSCTL_ADD_INT(&softc->sysctl_stats_ctx,
776 SYSCTL_CHILDREN(softc->sysctl_stats_tree),
777 OID_AUTO,
"errors", CTLFLAG_RD,
779 "Transport errors reported by the SIM.");
780 SYSCTL_ADD_INT(&softc->sysctl_stats_ctx,
781 SYSCTL_CHILDREN(softc->sysctl_stats_tree),
782 OID_AUTO,
"pack_invalidations", CTLFLAG_RD,
783 &softc->invalidations, 0,
784 "Device pack invalidations.");
787#ifdef CAM_TEST_FAILURE
789 OID_AUTO,
"invalidate", CTLTYPE_U64 | CTLFLAG_RW | CTLFLAG_MPSAFE,
791 "Write 1 to invalidate the drive immediately");
807 sbuf_new_for_sysctl(&sbuf, NULL, 0, req);
808 if (softc->
flags != 0)
811 sbuf_printf(&sbuf,
"0");
812 error = sbuf_finish(&sbuf);
825 return (EJUSTRETURN);
827 periph = (
struct cam_periph *)bp->bio_disk->d_drv1;
829 ret =
xpt_getattr(bp->bio_data, bp->bio_length, bp->bio_attribute,
833 bp->bio_completed = bp->bio_length;
843 const struct nvme_namespace_data *nsd;
844 const struct nvme_controller_data *cd;
845 char announce_buf[80];
846 uint8_t flbas_fmt, lbads, vwc_present;
853 softc = (
struct nda_softc *)malloc(
sizeof(*softc), M_DEVBUF,
857 printf(
"ndaregister: Unable to probe new device. "
858 "Unable to allocate softc\n");
863 printf(
"ndaregister: Unable to probe new device. "
864 "Unable to allocate iosched memory\n");
865 free(softc, M_DEVBUF);
871 periph->
softc = softc;
886 snprintf(announce_buf,
sizeof(announce_buf),
889 TUNABLE_INT_FETCH(announce_buf, &
quirks);
893 disk->d_rotation_rate = DISK_RR_NON_ROTATING;
902 disk->d_name =
"nda";
903 disk->d_drv1 = periph;
908 else if (maxio > maxphys)
910 disk->d_maxsize = maxio;
911 flbas_fmt = (nsd->flbas >> NVME_NS_DATA_FLBAS_FORMAT_SHIFT) &
912 NVME_NS_DATA_FLBAS_FORMAT_MASK;
913 lbads = (nsd->lbaf[flbas_fmt] >> NVME_NS_DATA_LBAF_LBADS_SHIFT) &
914 NVME_NS_DATA_LBAF_LBADS_MASK;
915 disk->d_sectorsize = 1 << lbads;
916 disk->d_mediasize = (off_t)(
disk->d_sectorsize * nsd->nsze);
917 disk->d_delmaxsize =
disk->d_mediasize;
918 disk->d_flags = DISKFLAG_DIRECT_COMPLETION;
919 if (nvme_ctrlr_has_dataset_mgmt(cd))
920 disk->d_flags |= DISKFLAG_CANDELETE;
921 vwc_present = (cd->vwc >> NVME_CTRLR_DATA_VWC_PRESENT_SHIFT) &
922 NVME_CTRLR_DATA_VWC_PRESENT_MASK;
924 disk->d_flags |= DISKFLAG_CANFLUSHCACHE;
926 disk->d_flags |= DISKFLAG_UNMAPPED_BIO;
943 snprintf(
disk->d_attachment,
sizeof(
disk->d_attachment),
945 if (((nsd->nsfeat >> NVME_NS_DATA_NSFEAT_NPVALID_SHIFT) &
946 NVME_NS_DATA_NSFEAT_NPVALID_MASK) != 0 && nsd->npwg != 0)
947 disk->d_stripesize = ((nsd->npwg + 1) *
disk->d_sectorsize);
949 disk->d_stripesize = nsd->noiob *
disk->d_sectorsize;
950 disk->d_stripeoffset = 0;
953 DEVSTAT_ALL_SUPPORTED,
955 DEVSTAT_PRIORITY_DISK);
960 disk_add_alias(
disk,
"nvd");
969 "registration!\n", __func__);
973 disk_create(softc->
disk, DISK_VERSION);
977 snprintf(announce_buf,
sizeof(announce_buf),
978 "%juMB (%ju %u byte sectors)",
979 (uintmax_t)((uintmax_t)
disk->d_mediasize / (1024*1024)),
980 (uintmax_t)
disk->d_mediasize /
disk->d_sectorsize,
990 taskqueue_enqueue(taskqueue_thread, &softc->
sysctl_task);
1011 switch (softc->
state) {
1023 switch (bp->bio_cmd) {
1029#ifdef CAM_TEST_FAILURE
1041 if (bp->bio_cmd == BIO_READ) {
1042 if (softc->force_read_error) {
1043 softc->force_read_error--;
1046 if (softc->periodic_read_error > 0) {
1047 if (++softc->periodic_read_count >=
1048 softc->periodic_read_error) {
1049 softc->periodic_read_count = 0;
1054 if (softc->force_write_error) {
1055 softc->force_write_error--;
1060 biofinish(bp, NULL, EIO);
1066 KASSERT((bp->bio_flags & BIO_UNMAPPED) == 0 ||
1067 round_page(bp->bio_bcount + bp->bio_ma_offset) /
1068 PAGE_SIZE == bp->bio_ma_n,
1069 (
"Short bio %p", bp));
1071 NVME_OPC_READ : NVME_OPC_WRITE);
1076 struct nvme_dsm_range *dsm_range, *dsm_end;
1080 uint32_t totalcount = 0, ranges = 0;
1082 trim = malloc(
sizeof(*trim), M_NVMEDA, M_ZERO | M_NOWAIT);
1084 biofinish(bp, NULL, ENOMEM);
1089 TAILQ_INIT(&trim->bps);
1092 ents = max(ents, 1);
1093 dsm_range = trim->
dsm;
1094 dsm_end = dsm_range + ents;
1096 TAILQ_INSERT_TAIL(&trim->bps, bp1, bio_queue);
1098 htole32(bp1->bio_bcount / softc->
disk->d_sectorsize);
1099 dsm_range->starting_lba =
1100 htole64(bp1->bio_offset / softc->
disk->d_sectorsize);
1102 totalcount += dsm_range->length;
1104 if (dsm_range >= dsm_end)
1109 }
while (bp1 != NULL);
1110 start_ccb->ccb_trim = trim;
1112 dsm_range - trim->
dsm);
1129 biofinish(bp, NULL, EOPNOTSUPP);
1135 start_ccb->ccb_bp = bp;
1175 if (error == ERESTART) {
1188 panic(
"REQ_CMP with QFRZN");
1194 bp = (
struct bio *)done_ccb->ccb_bp;
1195 bp->bio_error = error;
1197 bp->bio_resid = bp->bio_bcount;
1198 bp->bio_flags |= BIO_ERROR;
1217 struct bio *bp1, *bp2;
1220 trim = nvmeio->ccb_trim;
1222 TAILQ_CONCAT(&queue, &trim->bps, bio_queue);
1223 free(trim, M_NVMEDA);
1236 bp1 = TAILQ_FIRST(&queue);
1242 while ((bp2 = TAILQ_FIRST(&queue)) != NULL) {
1243 TAILQ_REMOVE(&queue, bp2, bio_queue);
1244 bp2->bio_error = error;
1246 bp2->bio_flags |= BIO_ERROR;
1247 bp2->bio_resid = bp1->bio_bcount;
1318 if (SCHEDULER_STOPPED()) {
1345 softc->
disk->d_devstat);
void cam_strvis_flag(u_int8_t *dst, const u_int8_t *src, int srclen, int dstlen, uint32_t flags)
@ CAM_STRVIS_FLAG_NONASCII_SPC
#define CAM_PRIORITY_NORMAL
#define XPORT_DEVSTAT_TYPE(t)
#define CDAI_TYPE_PHYS_PATH
static __inline void cam_fill_nvmeio(struct ccb_nvmeio *nvmeio, u_int32_t retries, void(*cbfcnp)(struct cam_periph *, union ccb *), u_int32_t flags, u_int8_t *data_ptr, u_int32_t dxfer_len, u_int32_t timeout)
#define CAM_DEBUG(path, flag, printfargs)
struct bio * cam_iosched_next_trim(struct cam_iosched_softc *isc)
void cam_iosched_fini(struct cam_iosched_softc *isc)
void cam_iosched_flush(struct cam_iosched_softc *isc, struct devstat *stp, int err)
int cam_iosched_init(struct cam_iosched_softc **iscp, struct cam_periph *periph)
int cam_iosched_bio_complete(struct cam_iosched_softc *isc, struct bio *bp, union ccb *done_ccb)
void cam_iosched_sysctl_init(struct cam_iosched_softc *isc, struct sysctl_ctx_list *ctx, struct sysctl_oid *node)
void cam_iosched_schedule(struct cam_iosched_softc *isc, struct cam_periph *periph)
void cam_iosched_set_sort_queue(struct cam_iosched_softc *isc, int val)
struct bio * cam_iosched_next_bio(struct cam_iosched_softc *isc)
void cam_iosched_queue_work(struct cam_iosched_softc *isc, struct bio *bp)
u_int32_t cam_release_devq(struct cam_path *path, u_int32_t relsim_flags, u_int32_t openings, u_int32_t arg, int getcount_only)
void cam_periph_unmapmem(union ccb *ccb, struct cam_periph_map_info *mapinfo)
int cam_periph_acquire(struct cam_periph *periph)
void cam_periph_async(struct cam_periph *periph, u_int32_t code, struct cam_path *path, void *arg)
void cam_periph_release(struct cam_periph *periph)
void cam_periph_unhold(struct cam_periph *periph)
int cam_periph_hold(struct cam_periph *periph, int priority)
int cam_periph_runccb(union ccb *ccb, int(*error_routine)(union ccb *ccb, cam_flags camflags, u_int32_t sense_flags), cam_flags camflags, u_int32_t sense_flags, struct devstat *ds)
int cam_periph_invalidate_sysctl(SYSCTL_HANDLER_ARGS)
int cam_periph_error(union ccb *ccb, cam_flags camflags, u_int32_t sense_flags)
int cam_periph_mapmem(union ccb *ccb, struct cam_periph_map_info *mapinfo, u_int maxmap)
cam_status cam_periph_alloc(periph_ctor_t *periph_ctor, periph_oninv_t *periph_oninvalidate, periph_dtor_t *periph_dtor, periph_start_t *periph_start, char *name, cam_periph_type type, struct cam_path *path, ac_callback_t *ac_callback, ac_code code, void *arg)
cam_status periph_ctor_t(struct cam_periph *periph, void *arg)
#define CAM_PERIPH_INVALID
void periph_oninv_t(struct cam_periph *periph)
#define CAM_PERIPH_FOREACH(periph, driver)
#define cam_periph_lock(periph)
union ccb * cam_periph_getccb(struct cam_periph *periph, u_int32_t priority)
#define cam_periph_owned(periph)
#define cam_periph_unlock(periph)
void periph_dtor_t(struct cam_periph *periph)
void periph_start_t(struct cam_periph *periph, union ccb *start_ccb)
#define cam_periph_sleep(periph, chan, priority, wmesg, timo)
void() periph_init_t(void)
TAILQ_HEAD(ccb_hdr_tailq, ccb_hdr)
static __inline bool cam_sim_pollable(const struct cam_sim *sim)
union ccb * xpt_alloc_ccb(void)
int xpt_getattr(char *buf, size_t len, const char *attr, struct cam_path *path)
void xpt_print(struct cam_path *path, const char *fmt,...)
void xpt_announce_periph(struct cam_periph *periph, char *announce_string)
void xpt_setup_ccb(struct ccb_hdr *ccb_h, struct cam_path *path, u_int32_t priority)
void xpt_action(union ccb *start_ccb)
cam_status xpt_register_async(int event, ac_callback_t *cbfunc, void *cbarg, struct cam_path *path)
lun_id_t xpt_path_lun_id(struct cam_path *path)
struct cam_periph * xpt_path_periph(struct cam_path *path)
void xpt_release_ccb(union ccb *free_ccb)
void xpt_announce_quirks(struct cam_periph *periph, int quirks, char *bit_string)
static void xpt_path_inq(struct ccb_pathinq *cpi, struct cam_path *path)
const void * nvme_get_identify_cntrl(struct cam_periph *periph)
const void * nvme_get_identify_ns(struct cam_periph *periph)
static periph_start_t ndastart
static periph_init_t ndainit
static void ndasysctlinit(void *context, int pending)
static int ndagetattr(struct bio *bp)
static int ndaerror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
#define NDA_DEFAULT_TIMEOUT
static int nda_max_trim_entries
static void ndadiskgonecb(struct disk *dp)
static int nda_nvd_compat
static void ndaasync(void *callback_arg, u_int32_t code, struct cam_path *path, void *arg)
static int ndaclose(struct disk *dp)
static SYSCTL_NODE(_kern_cam, OID_AUTO, nda, CTLFLAG_RD|CTLFLAG_MPSAFE, 0, "CAM Direct Access Disk driver")
static void ndadone(struct cam_periph *periph, union ccb *done_ccb)
static void ndaflush(void)
static int ndaopen(struct disk *dp)
static int nda_default_timeout
static void nda_nvme_trim(struct nda_softc *softc, struct ccb_nvmeio *nvmeio, void *payload, uint32_t num_ranges)
static void nda_nvme_write(struct nda_softc *softc, struct ccb_nvmeio *nvmeio, void *payload, uint64_t lba, uint32_t len, uint32_t count)
#define NDA_MAX_TRIM_ENTRIES
#define NDA_DEFAULT_SEND_ORDERED
static int ndaflagssysctl(SYSCTL_HANDLER_ARGS)
static void ndashutdown(void *arg, int howto)
_Static_assert(NVME_MAX_DSM_TRIM % sizeof(struct nvme_dsm_range)==0, "NVME_MAX_DSM_TRIM must be an integral number of ranges")
PERIPHDRIVER_DECLARE(nda, ndadriver)
static periph_oninv_t ndaoninvalidate
static periph_ctor_t ndaregister
static periph_dtor_t ndacleanup
static void nda_nvme_rw_bio(struct nda_softc *softc, struct ccb_nvmeio *nvmeio, struct bio *bp, uint32_t rwcmd)
SYSCTL_INT(_kern_cam_nda, OID_AUTO, max_trim, CTLFLAG_RDTUN, &nda_max_trim_entries, NDA_MAX_TRIM_ENTRIES, "Maximum number of BIO_DELETE to send down as a DSM TRIM.")
static int nda_rotating_media
static disk_strategy_t ndastrategy
static disk_ioctl_t ndaioctl
static void ndasuspend(void *arg)
static int nda_enable_biospeedup
static MALLOC_DEFINE(M_NVMEDA, "nvme_da", "nvme_da buffers")
static void nda_nvme_flush(struct nda_softc *softc, struct ccb_nvmeio *nvmeio)
static void ndaschedule(struct cam_periph *periph)
static int nda_send_ordered
static struct periph_driver ndadriver
char dev_name[NVME_DEV_NAME_LEN]
union ccb_pathinq::@2 xport_specific
struct ccb_pathinq_settings_nvme nvme
struct sysctl_oid * sysctl_tree
struct sysctl_ctx_list sysctl_ctx
struct cam_iosched_softc * cam_iosched
struct nvme_dsm_range dsm[NVME_MAX_DSM_TRIM/sizeof(struct nvme_dsm_range)]