2 * NVM Express device driver
3 * Copyright (c) 2011-2014, Intel Corporation.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 #include <linux/blkdev.h>
16 #include <linux/blk-mq.h>
17 #include <linux/delay.h>
18 #include <linux/errno.h>
19 #include <linux/hdreg.h>
20 #include <linux/kernel.h>
21 #include <linux/module.h>
22 #include <linux/list_sort.h>
23 #include <linux/slab.h>
24 #include <linux/types.h>
26 #include <linux/ptrace.h>
27 #include <linux/nvme_ioctl.h>
28 #include <linux/t10-pi.h>
30 #include <asm/unaligned.h>
35 #define NVME_MINORS (1U << MINORBITS)
37 unsigned char admin_timeout = 60;
38 module_param(admin_timeout, byte, 0644);
39 MODULE_PARM_DESC(admin_timeout, "timeout in seconds for admin commands");
40 EXPORT_SYMBOL_GPL(admin_timeout);
42 unsigned char nvme_io_timeout = 30;
43 module_param_named(io_timeout, nvme_io_timeout, byte, 0644);
44 MODULE_PARM_DESC(io_timeout, "timeout in seconds for I/O");
45 EXPORT_SYMBOL_GPL(nvme_io_timeout);
47 unsigned char shutdown_timeout = 5;
48 module_param(shutdown_timeout, byte, 0644);
49 MODULE_PARM_DESC(shutdown_timeout, "timeout in seconds for controller shutdown");
51 unsigned int nvme_max_retries = 5;
52 module_param_named(max_retries, nvme_max_retries, uint, 0644);
53 MODULE_PARM_DESC(max_retries, "max number of retries a command may have");
54 EXPORT_SYMBOL_GPL(nvme_max_retries);
56 static int nvme_char_major;
57 module_param(nvme_char_major, int, 0);
59 static LIST_HEAD(nvme_ctrl_list);
60 static DEFINE_SPINLOCK(dev_list_lock);
62 static struct class *nvme_class;
64 void nvme_cancel_request(struct request *req, void *data, bool reserved)
68 if (!blk_mq_request_started(req))
71 dev_dbg_ratelimited(((struct nvme_ctrl *) data)->device,
72 "Cancelling I/O %d", req->tag);
74 status = NVME_SC_ABORT_REQ;
75 if (blk_queue_dying(req->q))
76 status |= NVME_SC_DNR;
77 blk_mq_complete_request(req, status);
79 EXPORT_SYMBOL_GPL(nvme_cancel_request);
81 bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
82 enum nvme_ctrl_state new_state)
84 enum nvme_ctrl_state old_state = ctrl->state;
87 spin_lock_irq(&ctrl->lock);
92 case NVME_CTRL_RESETTING:
93 case NVME_CTRL_RECONNECTING:
100 case NVME_CTRL_RESETTING:
104 case NVME_CTRL_RECONNECTING:
111 case NVME_CTRL_RECONNECTING:
120 case NVME_CTRL_DELETING:
123 case NVME_CTRL_RESETTING:
124 case NVME_CTRL_RECONNECTING:
133 case NVME_CTRL_DELETING:
143 spin_unlock_irq(&ctrl->lock);
146 ctrl->state = new_state;
150 EXPORT_SYMBOL_GPL(nvme_change_ctrl_state);
152 static void nvme_free_ns(struct kref *kref)
154 struct nvme_ns *ns = container_of(kref, struct nvme_ns, kref);
156 if (ns->type == NVME_NS_LIGHTNVM)
157 nvme_nvm_unregister(ns->queue, ns->disk->disk_name);
159 spin_lock(&dev_list_lock);
160 ns->disk->private_data = NULL;
161 spin_unlock(&dev_list_lock);
164 ida_simple_remove(&ns->ctrl->ns_ida, ns->instance);
165 nvme_put_ctrl(ns->ctrl);
169 static void nvme_put_ns(struct nvme_ns *ns)
171 kref_put(&ns->kref, nvme_free_ns);
174 static struct nvme_ns *nvme_get_ns_from_disk(struct gendisk *disk)
178 spin_lock(&dev_list_lock);
179 ns = disk->private_data;
181 if (!kref_get_unless_zero(&ns->kref))
183 if (!try_module_get(ns->ctrl->ops->module))
186 spin_unlock(&dev_list_lock);
191 kref_put(&ns->kref, nvme_free_ns);
193 spin_unlock(&dev_list_lock);
197 void nvme_requeue_req(struct request *req)
201 blk_mq_requeue_request(req);
202 spin_lock_irqsave(req->q->queue_lock, flags);
203 if (!blk_queue_stopped(req->q))
204 blk_mq_kick_requeue_list(req->q);
205 spin_unlock_irqrestore(req->q->queue_lock, flags);
207 EXPORT_SYMBOL_GPL(nvme_requeue_req);
209 struct request *nvme_alloc_request(struct request_queue *q,
210 struct nvme_command *cmd, unsigned int flags, int qid)
214 if (qid == NVME_QID_ANY) {
215 req = blk_mq_alloc_request(q, nvme_is_write(cmd), flags);
217 req = blk_mq_alloc_request_hctx(q, nvme_is_write(cmd), flags,
223 req->cmd_type = REQ_TYPE_DRV_PRIV;
224 req->cmd_flags |= REQ_FAILFAST_DRIVER;
225 req->cmd = (unsigned char *)cmd;
226 req->cmd_len = sizeof(struct nvme_command);
230 EXPORT_SYMBOL_GPL(nvme_alloc_request);
232 static inline void nvme_setup_flush(struct nvme_ns *ns,
233 struct nvme_command *cmnd)
235 memset(cmnd, 0, sizeof(*cmnd));
236 cmnd->common.opcode = nvme_cmd_flush;
237 cmnd->common.nsid = cpu_to_le32(ns->ns_id);
240 static inline int nvme_setup_discard(struct nvme_ns *ns, struct request *req,
241 struct nvme_command *cmnd)
243 struct nvme_dsm_range *range;
246 unsigned int nr_bytes = blk_rq_bytes(req);
248 range = kmalloc(sizeof(*range), GFP_ATOMIC);
250 return BLK_MQ_RQ_QUEUE_BUSY;
252 range->cattr = cpu_to_le32(0);
253 range->nlb = cpu_to_le32(nr_bytes >> ns->lba_shift);
254 range->slba = cpu_to_le64(nvme_block_nr(ns, blk_rq_pos(req)));
256 memset(cmnd, 0, sizeof(*cmnd));
257 cmnd->dsm.opcode = nvme_cmd_dsm;
258 cmnd->dsm.nsid = cpu_to_le32(ns->ns_id);
260 cmnd->dsm.attributes = cpu_to_le32(NVME_DSMGMT_AD);
262 req->completion_data = range;
263 page = virt_to_page(range);
264 offset = offset_in_page(range);
265 blk_add_request_payload(req, page, offset, sizeof(*range));
268 * we set __data_len back to the size of the area to be discarded
269 * on disk. This allows us to report completion on the full amount
270 * of blocks described by the request.
272 req->__data_len = nr_bytes;
277 static inline void nvme_setup_rw(struct nvme_ns *ns, struct request *req,
278 struct nvme_command *cmnd)
283 if (req->cmd_flags & REQ_FUA)
284 control |= NVME_RW_FUA;
285 if (req->cmd_flags & (REQ_FAILFAST_DEV | REQ_RAHEAD))
286 control |= NVME_RW_LR;
288 if (req->cmd_flags & REQ_RAHEAD)
289 dsmgmt |= NVME_RW_DSM_FREQ_PREFETCH;
291 memset(cmnd, 0, sizeof(*cmnd));
292 cmnd->rw.opcode = (rq_data_dir(req) ? nvme_cmd_write : nvme_cmd_read);
293 cmnd->rw.command_id = req->tag;
294 cmnd->rw.nsid = cpu_to_le32(ns->ns_id);
295 cmnd->rw.slba = cpu_to_le64(nvme_block_nr(ns, blk_rq_pos(req)));
296 cmnd->rw.length = cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);
299 switch (ns->pi_type) {
300 case NVME_NS_DPS_PI_TYPE3:
301 control |= NVME_RW_PRINFO_PRCHK_GUARD;
303 case NVME_NS_DPS_PI_TYPE1:
304 case NVME_NS_DPS_PI_TYPE2:
305 control |= NVME_RW_PRINFO_PRCHK_GUARD |
306 NVME_RW_PRINFO_PRCHK_REF;
307 cmnd->rw.reftag = cpu_to_le32(
308 nvme_block_nr(ns, blk_rq_pos(req)));
311 if (!blk_integrity_rq(req))
312 control |= NVME_RW_PRINFO_PRACT;
315 cmnd->rw.control = cpu_to_le16(control);
316 cmnd->rw.dsmgmt = cpu_to_le32(dsmgmt);
319 int nvme_setup_cmd(struct nvme_ns *ns, struct request *req,
320 struct nvme_command *cmd)
324 if (req->cmd_type == REQ_TYPE_DRV_PRIV)
325 memcpy(cmd, req->cmd, sizeof(*cmd));
326 else if (req_op(req) == REQ_OP_FLUSH)
327 nvme_setup_flush(ns, cmd);
328 else if (req_op(req) == REQ_OP_DISCARD)
329 ret = nvme_setup_discard(ns, req, cmd);
331 nvme_setup_rw(ns, req, cmd);
335 EXPORT_SYMBOL_GPL(nvme_setup_cmd);
338 * Returns 0 on success. If the result is negative, it's a Linux error code;
339 * if the result is positive, it's an NVM Express status code
341 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
342 struct nvme_completion *cqe, void *buffer, unsigned bufflen,
343 unsigned timeout, int qid, int at_head, int flags)
348 req = nvme_alloc_request(q, cmd, flags, qid);
352 req->timeout = timeout ? timeout : ADMIN_TIMEOUT;
355 if (buffer && bufflen) {
356 ret = blk_rq_map_kern(q, req, buffer, bufflen, GFP_KERNEL);
361 blk_execute_rq(req->q, NULL, req, at_head);
364 blk_mq_free_request(req);
367 EXPORT_SYMBOL_GPL(__nvme_submit_sync_cmd);
369 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
370 void *buffer, unsigned bufflen)
372 return __nvme_submit_sync_cmd(q, cmd, NULL, buffer, bufflen, 0,
375 EXPORT_SYMBOL_GPL(nvme_submit_sync_cmd);
377 int __nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
378 void __user *ubuffer, unsigned bufflen,
379 void __user *meta_buffer, unsigned meta_len, u32 meta_seed,
380 u32 *result, unsigned timeout)
382 bool write = nvme_is_write(cmd);
383 struct nvme_completion cqe;
384 struct nvme_ns *ns = q->queuedata;
385 struct gendisk *disk = ns ? ns->disk : NULL;
387 struct bio *bio = NULL;
391 req = nvme_alloc_request(q, cmd, 0, NVME_QID_ANY);
395 req->timeout = timeout ? timeout : ADMIN_TIMEOUT;
398 if (ubuffer && bufflen) {
399 ret = blk_rq_map_user(q, req, NULL, ubuffer, bufflen,
407 bio->bi_bdev = bdget_disk(disk, 0);
413 if (meta_buffer && meta_len) {
414 struct bio_integrity_payload *bip;
416 meta = kmalloc(meta_len, GFP_KERNEL);
423 if (copy_from_user(meta, meta_buffer,
430 bip = bio_integrity_alloc(bio, GFP_KERNEL, 1);
436 bip->bip_iter.bi_size = meta_len;
437 bip->bip_iter.bi_sector = meta_seed;
439 ret = bio_integrity_add_page(bio, virt_to_page(meta),
440 meta_len, offset_in_page(meta));
441 if (ret != meta_len) {
448 blk_execute_rq(req->q, disk, req, 0);
451 *result = le32_to_cpu(cqe.result);
452 if (meta && !ret && !write) {
453 if (copy_to_user(meta_buffer, meta, meta_len))
460 if (disk && bio->bi_bdev)
462 blk_rq_unmap_user(bio);
465 blk_mq_free_request(req);
469 int nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
470 void __user *ubuffer, unsigned bufflen, u32 *result,
473 return __nvme_submit_user_cmd(q, cmd, ubuffer, bufflen, NULL, 0, 0,
477 static void nvme_keep_alive_end_io(struct request *rq, int error)
479 struct nvme_ctrl *ctrl = rq->end_io_data;
481 blk_mq_free_request(rq);
484 dev_err(ctrl->device,
485 "failed nvme_keep_alive_end_io error=%d\n", error);
489 schedule_delayed_work(&ctrl->ka_work, ctrl->kato * HZ);
492 static int nvme_keep_alive(struct nvme_ctrl *ctrl)
494 struct nvme_command c;
497 memset(&c, 0, sizeof(c));
498 c.common.opcode = nvme_admin_keep_alive;
500 rq = nvme_alloc_request(ctrl->admin_q, &c, BLK_MQ_REQ_RESERVED,
505 rq->timeout = ctrl->kato * HZ;
506 rq->end_io_data = ctrl;
508 blk_execute_rq_nowait(rq->q, NULL, rq, 0, nvme_keep_alive_end_io);
513 static void nvme_keep_alive_work(struct work_struct *work)
515 struct nvme_ctrl *ctrl = container_of(to_delayed_work(work),
516 struct nvme_ctrl, ka_work);
518 if (nvme_keep_alive(ctrl)) {
519 /* allocation failure, reset the controller */
520 dev_err(ctrl->device, "keep-alive failed\n");
521 ctrl->ops->reset_ctrl(ctrl);
526 void nvme_start_keep_alive(struct nvme_ctrl *ctrl)
528 if (unlikely(ctrl->kato == 0))
531 INIT_DELAYED_WORK(&ctrl->ka_work, nvme_keep_alive_work);
532 schedule_delayed_work(&ctrl->ka_work, ctrl->kato * HZ);
534 EXPORT_SYMBOL_GPL(nvme_start_keep_alive);
536 void nvme_stop_keep_alive(struct nvme_ctrl *ctrl)
538 if (unlikely(ctrl->kato == 0))
541 cancel_delayed_work_sync(&ctrl->ka_work);
543 EXPORT_SYMBOL_GPL(nvme_stop_keep_alive);
545 int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id)
547 struct nvme_command c = { };
550 /* gcc-4.4.4 (at least) has issues with initializers and anon unions */
551 c.identify.opcode = nvme_admin_identify;
552 c.identify.cns = cpu_to_le32(1);
554 *id = kmalloc(sizeof(struct nvme_id_ctrl), GFP_KERNEL);
558 error = nvme_submit_sync_cmd(dev->admin_q, &c, *id,
559 sizeof(struct nvme_id_ctrl));
565 static int nvme_identify_ns_list(struct nvme_ctrl *dev, unsigned nsid, __le32 *ns_list)
567 struct nvme_command c = { };
569 c.identify.opcode = nvme_admin_identify;
570 c.identify.cns = cpu_to_le32(2);
571 c.identify.nsid = cpu_to_le32(nsid);
572 return nvme_submit_sync_cmd(dev->admin_q, &c, ns_list, 0x1000);
575 int nvme_identify_ns(struct nvme_ctrl *dev, unsigned nsid,
576 struct nvme_id_ns **id)
578 struct nvme_command c = { };
581 /* gcc-4.4.4 (at least) has issues with initializers and anon unions */
582 c.identify.opcode = nvme_admin_identify,
583 c.identify.nsid = cpu_to_le32(nsid),
585 *id = kmalloc(sizeof(struct nvme_id_ns), GFP_KERNEL);
589 error = nvme_submit_sync_cmd(dev->admin_q, &c, *id,
590 sizeof(struct nvme_id_ns));
596 int nvme_get_features(struct nvme_ctrl *dev, unsigned fid, unsigned nsid,
597 dma_addr_t dma_addr, u32 *result)
599 struct nvme_command c;
600 struct nvme_completion cqe;
603 memset(&c, 0, sizeof(c));
604 c.features.opcode = nvme_admin_get_features;
605 c.features.nsid = cpu_to_le32(nsid);
606 c.features.dptr.prp1 = cpu_to_le64(dma_addr);
607 c.features.fid = cpu_to_le32(fid);
609 ret = __nvme_submit_sync_cmd(dev->admin_q, &c, &cqe, NULL, 0, 0,
612 *result = le32_to_cpu(cqe.result);
616 int nvme_set_features(struct nvme_ctrl *dev, unsigned fid, unsigned dword11,
617 dma_addr_t dma_addr, u32 *result)
619 struct nvme_command c;
620 struct nvme_completion cqe;
623 memset(&c, 0, sizeof(c));
624 c.features.opcode = nvme_admin_set_features;
625 c.features.dptr.prp1 = cpu_to_le64(dma_addr);
626 c.features.fid = cpu_to_le32(fid);
627 c.features.dword11 = cpu_to_le32(dword11);
629 ret = __nvme_submit_sync_cmd(dev->admin_q, &c, &cqe, NULL, 0, 0,
632 *result = le32_to_cpu(cqe.result);
636 int nvme_get_log_page(struct nvme_ctrl *dev, struct nvme_smart_log **log)
638 struct nvme_command c = { };
641 c.common.opcode = nvme_admin_get_log_page,
642 c.common.nsid = cpu_to_le32(0xFFFFFFFF),
643 c.common.cdw10[0] = cpu_to_le32(
644 (((sizeof(struct nvme_smart_log) / 4) - 1) << 16) |
647 *log = kmalloc(sizeof(struct nvme_smart_log), GFP_KERNEL);
651 error = nvme_submit_sync_cmd(dev->admin_q, &c, *log,
652 sizeof(struct nvme_smart_log));
658 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count)
660 u32 q_count = (*count - 1) | ((*count - 1) << 16);
662 int status, nr_io_queues;
664 status = nvme_set_features(ctrl, NVME_FEAT_NUM_QUEUES, q_count, 0,
670 * Degraded controllers might return an error when setting the queue
671 * count. We still want to be able to bring them online and offer
672 * access to the admin queue, as that might be only way to fix them up.
675 dev_err(ctrl->dev, "Could not set queue count (%d)\n", status);
678 nr_io_queues = min(result & 0xffff, result >> 16) + 1;
679 *count = min(*count, nr_io_queues);
684 EXPORT_SYMBOL_GPL(nvme_set_queue_count);
686 static int nvme_submit_io(struct nvme_ns *ns, struct nvme_user_io __user *uio)
688 struct nvme_user_io io;
689 struct nvme_command c;
690 unsigned length, meta_len;
691 void __user *metadata;
693 if (copy_from_user(&io, uio, sizeof(io)))
701 case nvme_cmd_compare:
707 length = (io.nblocks + 1) << ns->lba_shift;
708 meta_len = (io.nblocks + 1) * ns->ms;
709 metadata = (void __user *)(uintptr_t)io.metadata;
714 } else if (meta_len) {
715 if ((io.metadata & 3) || !io.metadata)
719 memset(&c, 0, sizeof(c));
720 c.rw.opcode = io.opcode;
721 c.rw.flags = io.flags;
722 c.rw.nsid = cpu_to_le32(ns->ns_id);
723 c.rw.slba = cpu_to_le64(io.slba);
724 c.rw.length = cpu_to_le16(io.nblocks);
725 c.rw.control = cpu_to_le16(io.control);
726 c.rw.dsmgmt = cpu_to_le32(io.dsmgmt);
727 c.rw.reftag = cpu_to_le32(io.reftag);
728 c.rw.apptag = cpu_to_le16(io.apptag);
729 c.rw.appmask = cpu_to_le16(io.appmask);
731 return __nvme_submit_user_cmd(ns->queue, &c,
732 (void __user *)(uintptr_t)io.addr, length,
733 metadata, meta_len, io.slba, NULL, 0);
736 static int nvme_user_cmd(struct nvme_ctrl *ctrl, struct nvme_ns *ns,
737 struct nvme_passthru_cmd __user *ucmd)
739 struct nvme_passthru_cmd cmd;
740 struct nvme_command c;
741 unsigned timeout = 0;
744 if (!capable(CAP_SYS_ADMIN))
746 if (copy_from_user(&cmd, ucmd, sizeof(cmd)))
751 memset(&c, 0, sizeof(c));
752 c.common.opcode = cmd.opcode;
753 c.common.flags = cmd.flags;
754 c.common.nsid = cpu_to_le32(cmd.nsid);
755 c.common.cdw2[0] = cpu_to_le32(cmd.cdw2);
756 c.common.cdw2[1] = cpu_to_le32(cmd.cdw3);
757 c.common.cdw10[0] = cpu_to_le32(cmd.cdw10);
758 c.common.cdw10[1] = cpu_to_le32(cmd.cdw11);
759 c.common.cdw10[2] = cpu_to_le32(cmd.cdw12);
760 c.common.cdw10[3] = cpu_to_le32(cmd.cdw13);
761 c.common.cdw10[4] = cpu_to_le32(cmd.cdw14);
762 c.common.cdw10[5] = cpu_to_le32(cmd.cdw15);
765 timeout = msecs_to_jiffies(cmd.timeout_ms);
767 status = nvme_submit_user_cmd(ns ? ns->queue : ctrl->admin_q, &c,
768 (void __user *)(uintptr_t)cmd.addr, cmd.data_len,
769 &cmd.result, timeout);
771 if (put_user(cmd.result, &ucmd->result))
778 static int nvme_ioctl(struct block_device *bdev, fmode_t mode,
779 unsigned int cmd, unsigned long arg)
781 struct nvme_ns *ns = bdev->bd_disk->private_data;
785 force_successful_syscall_return();
787 case NVME_IOCTL_ADMIN_CMD:
788 return nvme_user_cmd(ns->ctrl, NULL, (void __user *)arg);
789 case NVME_IOCTL_IO_CMD:
790 return nvme_user_cmd(ns->ctrl, ns, (void __user *)arg);
791 case NVME_IOCTL_SUBMIT_IO:
792 return nvme_submit_io(ns, (void __user *)arg);
793 #ifdef CONFIG_BLK_DEV_NVME_SCSI
794 case SG_GET_VERSION_NUM:
795 return nvme_sg_get_version_num((void __user *)arg);
797 return nvme_sg_io(ns, (void __user *)arg);
805 static int nvme_compat_ioctl(struct block_device *bdev, fmode_t mode,
806 unsigned int cmd, unsigned long arg)
812 return nvme_ioctl(bdev, mode, cmd, arg);
815 #define nvme_compat_ioctl NULL
818 static int nvme_open(struct block_device *bdev, fmode_t mode)
820 return nvme_get_ns_from_disk(bdev->bd_disk) ? 0 : -ENXIO;
823 static void nvme_release(struct gendisk *disk, fmode_t mode)
825 struct nvme_ns *ns = disk->private_data;
827 module_put(ns->ctrl->ops->module);
831 static int nvme_getgeo(struct block_device *bdev, struct hd_geometry *geo)
833 /* some standard values */
835 geo->sectors = 1 << 5;
836 geo->cylinders = get_capacity(bdev->bd_disk) >> 11;
840 #ifdef CONFIG_BLK_DEV_INTEGRITY
841 static void nvme_init_integrity(struct nvme_ns *ns)
843 struct blk_integrity integrity;
845 switch (ns->pi_type) {
846 case NVME_NS_DPS_PI_TYPE3:
847 integrity.profile = &t10_pi_type3_crc;
848 integrity.tag_size = sizeof(u16) + sizeof(u32);
849 integrity.flags |= BLK_INTEGRITY_DEVICE_CAPABLE;
851 case NVME_NS_DPS_PI_TYPE1:
852 case NVME_NS_DPS_PI_TYPE2:
853 integrity.profile = &t10_pi_type1_crc;
854 integrity.tag_size = sizeof(u16);
855 integrity.flags |= BLK_INTEGRITY_DEVICE_CAPABLE;
858 integrity.profile = NULL;
861 integrity.tuple_size = ns->ms;
862 blk_integrity_register(ns->disk, &integrity);
863 blk_queue_max_integrity_segments(ns->queue, 1);
866 static void nvme_init_integrity(struct nvme_ns *ns)
869 #endif /* CONFIG_BLK_DEV_INTEGRITY */
871 static void nvme_config_discard(struct nvme_ns *ns)
873 struct nvme_ctrl *ctrl = ns->ctrl;
874 u32 logical_block_size = queue_logical_block_size(ns->queue);
876 if (ctrl->quirks & NVME_QUIRK_DISCARD_ZEROES)
877 ns->queue->limits.discard_zeroes_data = 1;
879 ns->queue->limits.discard_zeroes_data = 0;
881 ns->queue->limits.discard_alignment = logical_block_size;
882 ns->queue->limits.discard_granularity = logical_block_size;
883 blk_queue_max_discard_sectors(ns->queue, UINT_MAX);
884 queue_flag_set_unlocked(QUEUE_FLAG_DISCARD, ns->queue);
887 static int nvme_revalidate_disk(struct gendisk *disk)
889 struct nvme_ns *ns = disk->private_data;
890 struct nvme_id_ns *id;
895 if (test_bit(NVME_NS_DEAD, &ns->flags)) {
896 set_capacity(disk, 0);
899 if (nvme_identify_ns(ns->ctrl, ns->ns_id, &id)) {
900 dev_warn(disk_to_dev(ns->disk), "%s: Identify failure\n",
909 if (nvme_nvm_ns_supported(ns, id) && ns->type != NVME_NS_LIGHTNVM) {
910 if (nvme_nvm_register(ns->queue, disk->disk_name)) {
911 dev_warn(disk_to_dev(ns->disk),
912 "%s: LightNVM init failure\n", __func__);
916 ns->type = NVME_NS_LIGHTNVM;
919 if (ns->ctrl->vs >= NVME_VS(1, 1))
920 memcpy(ns->eui, id->eui64, sizeof(ns->eui));
921 if (ns->ctrl->vs >= NVME_VS(1, 2))
922 memcpy(ns->uuid, id->nguid, sizeof(ns->uuid));
925 lbaf = id->flbas & NVME_NS_FLBAS_LBA_MASK;
926 ns->lba_shift = id->lbaf[lbaf].ds;
927 ns->ms = le16_to_cpu(id->lbaf[lbaf].ms);
928 ns->ext = ns->ms && (id->flbas & NVME_NS_FLBAS_META_EXT);
931 * If identify namespace failed, use default 512 byte block size so
932 * block layer can use before failing read/write for 0 capacity.
934 if (ns->lba_shift == 0)
936 bs = 1 << ns->lba_shift;
937 /* XXX: PI implementation requires metadata equal t10 pi tuple size */
938 pi_type = ns->ms == sizeof(struct t10_pi_tuple) ?
939 id->dps & NVME_NS_DPS_PI_MASK : 0;
941 blk_mq_freeze_queue(disk->queue);
942 if (blk_get_integrity(disk) && (ns->pi_type != pi_type ||
944 bs != queue_logical_block_size(disk->queue) ||
945 (ns->ms && ns->ext)))
946 blk_integrity_unregister(disk);
948 ns->pi_type = pi_type;
949 blk_queue_logical_block_size(ns->queue, bs);
951 if (ns->ms && !blk_get_integrity(disk) && !ns->ext)
952 nvme_init_integrity(ns);
953 if (ns->ms && !(ns->ms == 8 && ns->pi_type) && !blk_get_integrity(disk))
954 set_capacity(disk, 0);
956 set_capacity(disk, le64_to_cpup(&id->nsze) << (ns->lba_shift - 9));
958 if (ns->ctrl->oncs & NVME_CTRL_ONCS_DSM)
959 nvme_config_discard(ns);
960 blk_mq_unfreeze_queue(disk->queue);
966 static char nvme_pr_type(enum pr_type type)
969 case PR_WRITE_EXCLUSIVE:
971 case PR_EXCLUSIVE_ACCESS:
973 case PR_WRITE_EXCLUSIVE_REG_ONLY:
975 case PR_EXCLUSIVE_ACCESS_REG_ONLY:
977 case PR_WRITE_EXCLUSIVE_ALL_REGS:
979 case PR_EXCLUSIVE_ACCESS_ALL_REGS:
986 static int nvme_pr_command(struct block_device *bdev, u32 cdw10,
987 u64 key, u64 sa_key, u8 op)
989 struct nvme_ns *ns = bdev->bd_disk->private_data;
990 struct nvme_command c;
991 u8 data[16] = { 0, };
993 put_unaligned_le64(key, &data[0]);
994 put_unaligned_le64(sa_key, &data[8]);
996 memset(&c, 0, sizeof(c));
997 c.common.opcode = op;
998 c.common.nsid = cpu_to_le32(ns->ns_id);
999 c.common.cdw10[0] = cpu_to_le32(cdw10);
1001 return nvme_submit_sync_cmd(ns->queue, &c, data, 16);
1004 static int nvme_pr_register(struct block_device *bdev, u64 old,
1005 u64 new, unsigned flags)
1009 if (flags & ~PR_FL_IGNORE_KEY)
1012 cdw10 = old ? 2 : 0;
1013 cdw10 |= (flags & PR_FL_IGNORE_KEY) ? 1 << 3 : 0;
1014 cdw10 |= (1 << 30) | (1 << 31); /* PTPL=1 */
1015 return nvme_pr_command(bdev, cdw10, old, new, nvme_cmd_resv_register);
1018 static int nvme_pr_reserve(struct block_device *bdev, u64 key,
1019 enum pr_type type, unsigned flags)
1023 if (flags & ~PR_FL_IGNORE_KEY)
1026 cdw10 = nvme_pr_type(type) << 8;
1027 cdw10 |= ((flags & PR_FL_IGNORE_KEY) ? 1 << 3 : 0);
1028 return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_acquire);
1031 static int nvme_pr_preempt(struct block_device *bdev, u64 old, u64 new,
1032 enum pr_type type, bool abort)
1034 u32 cdw10 = nvme_pr_type(type) << 8 | abort ? 2 : 1;
1035 return nvme_pr_command(bdev, cdw10, old, new, nvme_cmd_resv_acquire);
1038 static int nvme_pr_clear(struct block_device *bdev, u64 key)
1040 u32 cdw10 = 1 | (key ? 1 << 3 : 0);
1041 return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_register);
1044 static int nvme_pr_release(struct block_device *bdev, u64 key, enum pr_type type)
1046 u32 cdw10 = nvme_pr_type(type) << 8 | key ? 1 << 3 : 0;
1047 return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_release);
1050 static const struct pr_ops nvme_pr_ops = {
1051 .pr_register = nvme_pr_register,
1052 .pr_reserve = nvme_pr_reserve,
1053 .pr_release = nvme_pr_release,
1054 .pr_preempt = nvme_pr_preempt,
1055 .pr_clear = nvme_pr_clear,
1058 static const struct block_device_operations nvme_fops = {
1059 .owner = THIS_MODULE,
1060 .ioctl = nvme_ioctl,
1061 .compat_ioctl = nvme_compat_ioctl,
1063 .release = nvme_release,
1064 .getgeo = nvme_getgeo,
1065 .revalidate_disk= nvme_revalidate_disk,
1066 .pr_ops = &nvme_pr_ops,
1069 static int nvme_wait_ready(struct nvme_ctrl *ctrl, u64 cap, bool enabled)
1071 unsigned long timeout =
1072 ((NVME_CAP_TIMEOUT(cap) + 1) * HZ / 2) + jiffies;
1073 u32 csts, bit = enabled ? NVME_CSTS_RDY : 0;
1076 while ((ret = ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &csts)) == 0) {
1077 if ((csts & NVME_CSTS_RDY) == bit)
1081 if (fatal_signal_pending(current))
1083 if (time_after(jiffies, timeout)) {
1084 dev_err(ctrl->device,
1085 "Device not ready; aborting %s\n", enabled ?
1086 "initialisation" : "reset");
1095 * If the device has been passed off to us in an enabled state, just clear
1096 * the enabled bit. The spec says we should set the 'shutdown notification
1097 * bits', but doing so may cause the device to complete commands to the
1098 * admin queue ... and we don't know what memory that might be pointing at!
1100 int nvme_disable_ctrl(struct nvme_ctrl *ctrl, u64 cap)
1104 ctrl->ctrl_config &= ~NVME_CC_SHN_MASK;
1105 ctrl->ctrl_config &= ~NVME_CC_ENABLE;
1107 ret = ctrl->ops->reg_write32(ctrl, NVME_REG_CC, ctrl->ctrl_config);
1111 /* Checking for ctrl->tagset is a trick to avoid sleeping on module
1112 * load, since we only need the quirk on reset_controller. Notice
1113 * that the HGST device needs this delay only in firmware activation
1114 * procedure; unfortunately we have no (easy) way to verify this.
1116 if ((ctrl->quirks & NVME_QUIRK_DELAY_BEFORE_CHK_RDY) && ctrl->tagset)
1117 msleep(NVME_QUIRK_DELAY_AMOUNT);
1119 return nvme_wait_ready(ctrl, cap, false);
1121 EXPORT_SYMBOL_GPL(nvme_disable_ctrl);
1123 int nvme_enable_ctrl(struct nvme_ctrl *ctrl, u64 cap)
1126 * Default to a 4K page size, with the intention to update this
1127 * path in the future to accomodate architectures with differing
1128 * kernel and IO page sizes.
1130 unsigned dev_page_min = NVME_CAP_MPSMIN(cap) + 12, page_shift = 12;
1133 if (page_shift < dev_page_min) {
1134 dev_err(ctrl->device,
1135 "Minimum device page size %u too large for host (%u)\n",
1136 1 << dev_page_min, 1 << page_shift);
1140 ctrl->page_size = 1 << page_shift;
1142 ctrl->ctrl_config = NVME_CC_CSS_NVM;
1143 ctrl->ctrl_config |= (page_shift - 12) << NVME_CC_MPS_SHIFT;
1144 ctrl->ctrl_config |= NVME_CC_ARB_RR | NVME_CC_SHN_NONE;
1145 ctrl->ctrl_config |= NVME_CC_IOSQES | NVME_CC_IOCQES;
1146 ctrl->ctrl_config |= NVME_CC_ENABLE;
1148 ret = ctrl->ops->reg_write32(ctrl, NVME_REG_CC, ctrl->ctrl_config);
1151 return nvme_wait_ready(ctrl, cap, true);
1153 EXPORT_SYMBOL_GPL(nvme_enable_ctrl);
1155 int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl)
1157 unsigned long timeout = SHUTDOWN_TIMEOUT + jiffies;
1161 ctrl->ctrl_config &= ~NVME_CC_SHN_MASK;
1162 ctrl->ctrl_config |= NVME_CC_SHN_NORMAL;
1164 ret = ctrl->ops->reg_write32(ctrl, NVME_REG_CC, ctrl->ctrl_config);
1168 while ((ret = ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &csts)) == 0) {
1169 if ((csts & NVME_CSTS_SHST_MASK) == NVME_CSTS_SHST_CMPLT)
1173 if (fatal_signal_pending(current))
1175 if (time_after(jiffies, timeout)) {
1176 dev_err(ctrl->device,
1177 "Device shutdown incomplete; abort shutdown\n");
1184 EXPORT_SYMBOL_GPL(nvme_shutdown_ctrl);
1186 static void nvme_set_queue_limits(struct nvme_ctrl *ctrl,
1187 struct request_queue *q)
1191 if (ctrl->max_hw_sectors) {
1193 (ctrl->max_hw_sectors / (ctrl->page_size >> 9)) + 1;
1195 blk_queue_max_hw_sectors(q, ctrl->max_hw_sectors);
1196 blk_queue_max_segments(q, min_t(u32, max_segments, USHRT_MAX));
1198 if (ctrl->stripe_size)
1199 blk_queue_chunk_sectors(q, ctrl->stripe_size >> 9);
1200 blk_queue_virt_boundary(q, ctrl->page_size - 1);
1201 if (ctrl->vwc & NVME_CTRL_VWC_PRESENT)
1203 blk_queue_write_cache(q, vwc, vwc);
1207 * Initialize the cached copies of the Identify data and various controller
1208 * register in our nvme_ctrl structure. This should be called as soon as
1209 * the admin queue is fully up and running.
1211 int nvme_init_identify(struct nvme_ctrl *ctrl)
1213 struct nvme_id_ctrl *id;
1215 int ret, page_shift;
1218 ret = ctrl->ops->reg_read32(ctrl, NVME_REG_VS, &ctrl->vs);
1220 dev_err(ctrl->device, "Reading VS failed (%d)\n", ret);
1224 ret = ctrl->ops->reg_read64(ctrl, NVME_REG_CAP, &cap);
1226 dev_err(ctrl->device, "Reading CAP failed (%d)\n", ret);
1229 page_shift = NVME_CAP_MPSMIN(cap) + 12;
1231 if (ctrl->vs >= NVME_VS(1, 1))
1232 ctrl->subsystem = NVME_CAP_NSSRC(cap);
1234 ret = nvme_identify_ctrl(ctrl, &id);
1236 dev_err(ctrl->device, "Identify Controller failed (%d)\n", ret);
1240 ctrl->vid = le16_to_cpu(id->vid);
1241 ctrl->oncs = le16_to_cpup(&id->oncs);
1242 atomic_set(&ctrl->abort_limit, id->acl + 1);
1243 ctrl->vwc = id->vwc;
1244 ctrl->cntlid = le16_to_cpup(&id->cntlid);
1245 memcpy(ctrl->serial, id->sn, sizeof(id->sn));
1246 memcpy(ctrl->model, id->mn, sizeof(id->mn));
1247 memcpy(ctrl->firmware_rev, id->fr, sizeof(id->fr));
1249 max_hw_sectors = 1 << (id->mdts + page_shift - 9);
1251 max_hw_sectors = UINT_MAX;
1252 ctrl->max_hw_sectors =
1253 min_not_zero(ctrl->max_hw_sectors, max_hw_sectors);
1255 if ((ctrl->quirks & NVME_QUIRK_STRIPE_SIZE) && id->vs[3]) {
1256 unsigned int max_hw_sectors;
1258 ctrl->stripe_size = 1 << (id->vs[3] + page_shift);
1259 max_hw_sectors = ctrl->stripe_size >> (page_shift - 9);
1260 if (ctrl->max_hw_sectors) {
1261 ctrl->max_hw_sectors = min(max_hw_sectors,
1262 ctrl->max_hw_sectors);
1264 ctrl->max_hw_sectors = max_hw_sectors;
1268 nvme_set_queue_limits(ctrl, ctrl->admin_q);
1269 ctrl->sgls = le32_to_cpu(id->sgls);
1270 ctrl->kas = le16_to_cpu(id->kas);
1272 if (ctrl->ops->is_fabrics) {
1273 ctrl->icdoff = le16_to_cpu(id->icdoff);
1274 ctrl->ioccsz = le32_to_cpu(id->ioccsz);
1275 ctrl->iorcsz = le32_to_cpu(id->iorcsz);
1276 ctrl->maxcmd = le16_to_cpu(id->maxcmd);
1279 * In fabrics we need to verify the cntlid matches the
1282 if (ctrl->cntlid != le16_to_cpu(id->cntlid))
1285 if (!ctrl->opts->discovery_nqn && !ctrl->kas) {
1287 "keep-alive support is mandatory for fabrics\n");
1291 ctrl->cntlid = le16_to_cpu(id->cntlid);
1297 EXPORT_SYMBOL_GPL(nvme_init_identify);
1299 static int nvme_dev_open(struct inode *inode, struct file *file)
1301 struct nvme_ctrl *ctrl;
1302 int instance = iminor(inode);
1305 spin_lock(&dev_list_lock);
1306 list_for_each_entry(ctrl, &nvme_ctrl_list, node) {
1307 if (ctrl->instance != instance)
1310 if (!ctrl->admin_q) {
1314 if (!kref_get_unless_zero(&ctrl->kref))
1316 file->private_data = ctrl;
1320 spin_unlock(&dev_list_lock);
1325 static int nvme_dev_release(struct inode *inode, struct file *file)
1327 nvme_put_ctrl(file->private_data);
1331 static int nvme_dev_user_cmd(struct nvme_ctrl *ctrl, void __user *argp)
1336 mutex_lock(&ctrl->namespaces_mutex);
1337 if (list_empty(&ctrl->namespaces)) {
1342 ns = list_first_entry(&ctrl->namespaces, struct nvme_ns, list);
1343 if (ns != list_last_entry(&ctrl->namespaces, struct nvme_ns, list)) {
1344 dev_warn(ctrl->device,
1345 "NVME_IOCTL_IO_CMD not supported when multiple namespaces present!\n");
1350 dev_warn(ctrl->device,
1351 "using deprecated NVME_IOCTL_IO_CMD ioctl on the char device!\n");
1352 kref_get(&ns->kref);
1353 mutex_unlock(&ctrl->namespaces_mutex);
1355 ret = nvme_user_cmd(ctrl, ns, argp);
1360 mutex_unlock(&ctrl->namespaces_mutex);
1364 static long nvme_dev_ioctl(struct file *file, unsigned int cmd,
1367 struct nvme_ctrl *ctrl = file->private_data;
1368 void __user *argp = (void __user *)arg;
1371 case NVME_IOCTL_ADMIN_CMD:
1372 return nvme_user_cmd(ctrl, NULL, argp);
1373 case NVME_IOCTL_IO_CMD:
1374 return nvme_dev_user_cmd(ctrl, argp);
1375 case NVME_IOCTL_RESET:
1376 dev_warn(ctrl->device, "resetting controller\n");
1377 return ctrl->ops->reset_ctrl(ctrl);
1378 case NVME_IOCTL_SUBSYS_RESET:
1379 return nvme_reset_subsystem(ctrl);
1380 case NVME_IOCTL_RESCAN:
1381 nvme_queue_scan(ctrl);
1388 static const struct file_operations nvme_dev_fops = {
1389 .owner = THIS_MODULE,
1390 .open = nvme_dev_open,
1391 .release = nvme_dev_release,
1392 .unlocked_ioctl = nvme_dev_ioctl,
1393 .compat_ioctl = nvme_dev_ioctl,
1396 static ssize_t nvme_sysfs_reset(struct device *dev,
1397 struct device_attribute *attr, const char *buf,
1400 struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
1403 ret = ctrl->ops->reset_ctrl(ctrl);
1408 static DEVICE_ATTR(reset_controller, S_IWUSR, NULL, nvme_sysfs_reset);
1410 static ssize_t nvme_sysfs_rescan(struct device *dev,
1411 struct device_attribute *attr, const char *buf,
1414 struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
1416 nvme_queue_scan(ctrl);
1419 static DEVICE_ATTR(rescan_controller, S_IWUSR, NULL, nvme_sysfs_rescan);
1421 static ssize_t wwid_show(struct device *dev, struct device_attribute *attr,
1424 struct nvme_ns *ns = dev_to_disk(dev)->private_data;
1425 struct nvme_ctrl *ctrl = ns->ctrl;
1426 int serial_len = sizeof(ctrl->serial);
1427 int model_len = sizeof(ctrl->model);
1429 if (memchr_inv(ns->uuid, 0, sizeof(ns->uuid)))
1430 return sprintf(buf, "eui.%16phN\n", ns->uuid);
1432 if (memchr_inv(ns->eui, 0, sizeof(ns->eui)))
1433 return sprintf(buf, "eui.%8phN\n", ns->eui);
1435 while (ctrl->serial[serial_len - 1] == ' ')
1437 while (ctrl->model[model_len - 1] == ' ')
1440 return sprintf(buf, "nvme.%04x-%*phN-%*phN-%08x\n", ctrl->vid,
1441 serial_len, ctrl->serial, model_len, ctrl->model, ns->ns_id);
1443 static DEVICE_ATTR(wwid, S_IRUGO, wwid_show, NULL);
1445 static ssize_t uuid_show(struct device *dev, struct device_attribute *attr,
1448 struct nvme_ns *ns = dev_to_disk(dev)->private_data;
1449 return sprintf(buf, "%pU\n", ns->uuid);
1451 static DEVICE_ATTR(uuid, S_IRUGO, uuid_show, NULL);
1453 static ssize_t eui_show(struct device *dev, struct device_attribute *attr,
1456 struct nvme_ns *ns = dev_to_disk(dev)->private_data;
1457 return sprintf(buf, "%8phd\n", ns->eui);
1459 static DEVICE_ATTR(eui, S_IRUGO, eui_show, NULL);
1461 static ssize_t nsid_show(struct device *dev, struct device_attribute *attr,
1464 struct nvme_ns *ns = dev_to_disk(dev)->private_data;
1465 return sprintf(buf, "%d\n", ns->ns_id);
1467 static DEVICE_ATTR(nsid, S_IRUGO, nsid_show, NULL);
1469 static struct attribute *nvme_ns_attrs[] = {
1470 &dev_attr_wwid.attr,
1471 &dev_attr_uuid.attr,
1473 &dev_attr_nsid.attr,
1477 static umode_t nvme_ns_attrs_are_visible(struct kobject *kobj,
1478 struct attribute *a, int n)
1480 struct device *dev = container_of(kobj, struct device, kobj);
1481 struct nvme_ns *ns = dev_to_disk(dev)->private_data;
1483 if (a == &dev_attr_uuid.attr) {
1484 if (!memchr_inv(ns->uuid, 0, sizeof(ns->uuid)))
1487 if (a == &dev_attr_eui.attr) {
1488 if (!memchr_inv(ns->eui, 0, sizeof(ns->eui)))
1494 static const struct attribute_group nvme_ns_attr_group = {
1495 .attrs = nvme_ns_attrs,
1496 .is_visible = nvme_ns_attrs_are_visible,
1499 #define nvme_show_str_function(field) \
1500 static ssize_t field##_show(struct device *dev, \
1501 struct device_attribute *attr, char *buf) \
1503 struct nvme_ctrl *ctrl = dev_get_drvdata(dev); \
1504 return sprintf(buf, "%.*s\n", (int)sizeof(ctrl->field), ctrl->field); \
1506 static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL);
1508 #define nvme_show_int_function(field) \
1509 static ssize_t field##_show(struct device *dev, \
1510 struct device_attribute *attr, char *buf) \
1512 struct nvme_ctrl *ctrl = dev_get_drvdata(dev); \
1513 return sprintf(buf, "%d\n", ctrl->field); \
1515 static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL);
1517 nvme_show_str_function(model);
1518 nvme_show_str_function(serial);
1519 nvme_show_str_function(firmware_rev);
1520 nvme_show_int_function(cntlid);
1522 static ssize_t nvme_sysfs_delete(struct device *dev,
1523 struct device_attribute *attr, const char *buf,
1526 struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
1528 if (device_remove_file_self(dev, attr))
1529 ctrl->ops->delete_ctrl(ctrl);
1532 static DEVICE_ATTR(delete_controller, S_IWUSR, NULL, nvme_sysfs_delete);
1534 static ssize_t nvme_sysfs_show_transport(struct device *dev,
1535 struct device_attribute *attr,
1538 struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
1540 return snprintf(buf, PAGE_SIZE, "%s\n", ctrl->ops->name);
1542 static DEVICE_ATTR(transport, S_IRUGO, nvme_sysfs_show_transport, NULL);
1544 static ssize_t nvme_sysfs_show_subsysnqn(struct device *dev,
1545 struct device_attribute *attr,
1548 struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
1550 return snprintf(buf, PAGE_SIZE, "%s\n",
1551 ctrl->ops->get_subsysnqn(ctrl));
1553 static DEVICE_ATTR(subsysnqn, S_IRUGO, nvme_sysfs_show_subsysnqn, NULL);
1555 static ssize_t nvme_sysfs_show_address(struct device *dev,
1556 struct device_attribute *attr,
1559 struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
1561 return ctrl->ops->get_address(ctrl, buf, PAGE_SIZE);
1563 static DEVICE_ATTR(address, S_IRUGO, nvme_sysfs_show_address, NULL);
1565 static struct attribute *nvme_dev_attrs[] = {
1566 &dev_attr_reset_controller.attr,
1567 &dev_attr_rescan_controller.attr,
1568 &dev_attr_model.attr,
1569 &dev_attr_serial.attr,
1570 &dev_attr_firmware_rev.attr,
1571 &dev_attr_cntlid.attr,
1572 &dev_attr_delete_controller.attr,
1573 &dev_attr_transport.attr,
1574 &dev_attr_subsysnqn.attr,
1575 &dev_attr_address.attr,
1579 #define CHECK_ATTR(ctrl, a, name) \
1580 if ((a) == &dev_attr_##name.attr && \
1581 !(ctrl)->ops->get_##name) \
1584 static umode_t nvme_dev_attrs_are_visible(struct kobject *kobj,
1585 struct attribute *a, int n)
1587 struct device *dev = container_of(kobj, struct device, kobj);
1588 struct nvme_ctrl *ctrl = dev_get_drvdata(dev);
1590 if (a == &dev_attr_delete_controller.attr) {
1591 if (!ctrl->ops->delete_ctrl)
1595 CHECK_ATTR(ctrl, a, subsysnqn);
1596 CHECK_ATTR(ctrl, a, address);
1601 static struct attribute_group nvme_dev_attrs_group = {
1602 .attrs = nvme_dev_attrs,
1603 .is_visible = nvme_dev_attrs_are_visible,
1606 static const struct attribute_group *nvme_dev_attr_groups[] = {
1607 &nvme_dev_attrs_group,
1611 static int ns_cmp(void *priv, struct list_head *a, struct list_head *b)
1613 struct nvme_ns *nsa = container_of(a, struct nvme_ns, list);
1614 struct nvme_ns *nsb = container_of(b, struct nvme_ns, list);
1616 return nsa->ns_id - nsb->ns_id;
1619 static struct nvme_ns *nvme_find_ns(struct nvme_ctrl *ctrl, unsigned nsid)
1623 lockdep_assert_held(&ctrl->namespaces_mutex);
1625 list_for_each_entry(ns, &ctrl->namespaces, list) {
1626 if (ns->ns_id == nsid)
1628 if (ns->ns_id > nsid)
1634 static void nvme_alloc_ns(struct nvme_ctrl *ctrl, unsigned nsid)
1637 struct gendisk *disk;
1638 int node = dev_to_node(ctrl->dev);
1640 lockdep_assert_held(&ctrl->namespaces_mutex);
1642 ns = kzalloc_node(sizeof(*ns), GFP_KERNEL, node);
1646 ns->instance = ida_simple_get(&ctrl->ns_ida, 1, 0, GFP_KERNEL);
1647 if (ns->instance < 0)
1650 ns->queue = blk_mq_init_queue(ctrl->tagset);
1651 if (IS_ERR(ns->queue))
1652 goto out_release_instance;
1653 queue_flag_set_unlocked(QUEUE_FLAG_NONROT, ns->queue);
1654 ns->queue->queuedata = ns;
1657 disk = alloc_disk_node(0, node);
1659 goto out_free_queue;
1661 kref_init(&ns->kref);
1664 ns->lba_shift = 9; /* set to a default value for 512 until disk is validated */
1667 blk_queue_logical_block_size(ns->queue, 1 << ns->lba_shift);
1668 nvme_set_queue_limits(ctrl, ns->queue);
1670 disk->fops = &nvme_fops;
1671 disk->private_data = ns;
1672 disk->queue = ns->queue;
1673 disk->flags = GENHD_FL_EXT_DEVT;
1674 sprintf(disk->disk_name, "nvme%dn%d", ctrl->instance, ns->instance);
1676 if (nvme_revalidate_disk(ns->disk))
1679 list_add_tail_rcu(&ns->list, &ctrl->namespaces);
1680 kref_get(&ctrl->kref);
1681 if (ns->type == NVME_NS_LIGHTNVM)
1684 device_add_disk(ctrl->device, ns->disk);
1685 if (sysfs_create_group(&disk_to_dev(ns->disk)->kobj,
1686 &nvme_ns_attr_group))
1687 pr_warn("%s: failed to create sysfs group for identification\n",
1688 ns->disk->disk_name);
1693 blk_cleanup_queue(ns->queue);
1694 out_release_instance:
1695 ida_simple_remove(&ctrl->ns_ida, ns->instance);
1700 static void nvme_ns_remove(struct nvme_ns *ns)
1702 lockdep_assert_held(&ns->ctrl->namespaces_mutex);
1704 if (test_and_set_bit(NVME_NS_REMOVING, &ns->flags))
1707 if (ns->disk->flags & GENHD_FL_UP) {
1708 if (blk_get_integrity(ns->disk))
1709 blk_integrity_unregister(ns->disk);
1710 sysfs_remove_group(&disk_to_dev(ns->disk)->kobj,
1711 &nvme_ns_attr_group);
1712 del_gendisk(ns->disk);
1713 blk_mq_abort_requeue_list(ns->queue);
1714 blk_cleanup_queue(ns->queue);
1716 list_del_init(&ns->list);
1721 static void nvme_validate_ns(struct nvme_ctrl *ctrl, unsigned nsid)
1725 ns = nvme_find_ns(ctrl, nsid);
1727 if (revalidate_disk(ns->disk))
1730 nvme_alloc_ns(ctrl, nsid);
1733 static void nvme_remove_invalid_namespaces(struct nvme_ctrl *ctrl,
1736 struct nvme_ns *ns, *next;
1738 list_for_each_entry_safe(ns, next, &ctrl->namespaces, list) {
1739 if (ns->ns_id > nsid)
1744 static int nvme_scan_ns_list(struct nvme_ctrl *ctrl, unsigned nn)
1748 unsigned i, j, nsid, prev = 0, num_lists = DIV_ROUND_UP(nn, 1024);
1751 ns_list = kzalloc(0x1000, GFP_KERNEL);
1755 for (i = 0; i < num_lists; i++) {
1756 ret = nvme_identify_ns_list(ctrl, prev, ns_list);
1760 for (j = 0; j < min(nn, 1024U); j++) {
1761 nsid = le32_to_cpu(ns_list[j]);
1765 nvme_validate_ns(ctrl, nsid);
1767 while (++prev < nsid) {
1768 ns = nvme_find_ns(ctrl, prev);
1776 nvme_remove_invalid_namespaces(ctrl, prev);
1782 static void nvme_scan_ns_sequential(struct nvme_ctrl *ctrl, unsigned nn)
1786 lockdep_assert_held(&ctrl->namespaces_mutex);
1788 for (i = 1; i <= nn; i++)
1789 nvme_validate_ns(ctrl, i);
1791 nvme_remove_invalid_namespaces(ctrl, nn);
1794 static void nvme_scan_work(struct work_struct *work)
1796 struct nvme_ctrl *ctrl =
1797 container_of(work, struct nvme_ctrl, scan_work);
1798 struct nvme_id_ctrl *id;
1801 if (ctrl->state != NVME_CTRL_LIVE)
1804 if (nvme_identify_ctrl(ctrl, &id))
1807 mutex_lock(&ctrl->namespaces_mutex);
1808 nn = le32_to_cpu(id->nn);
1809 if (ctrl->vs >= NVME_VS(1, 1) &&
1810 !(ctrl->quirks & NVME_QUIRK_IDENTIFY_CNS)) {
1811 if (!nvme_scan_ns_list(ctrl, nn))
1814 nvme_scan_ns_sequential(ctrl, nn);
1816 list_sort(NULL, &ctrl->namespaces, ns_cmp);
1817 mutex_unlock(&ctrl->namespaces_mutex);
1820 if (ctrl->ops->post_scan)
1821 ctrl->ops->post_scan(ctrl);
1824 void nvme_queue_scan(struct nvme_ctrl *ctrl)
1827 * Do not queue new scan work when a controller is reset during
1830 if (ctrl->state == NVME_CTRL_LIVE)
1831 schedule_work(&ctrl->scan_work);
1833 EXPORT_SYMBOL_GPL(nvme_queue_scan);
1835 void nvme_remove_namespaces(struct nvme_ctrl *ctrl)
1837 struct nvme_ns *ns, *next;
1840 * The dead states indicates the controller was not gracefully
1841 * disconnected. In that case, we won't be able to flush any data while
1842 * removing the namespaces' disks; fail all the queues now to avoid
1843 * potentially having to clean up the failed sync later.
1845 if (ctrl->state == NVME_CTRL_DEAD)
1846 nvme_kill_queues(ctrl);
1848 mutex_lock(&ctrl->namespaces_mutex);
1849 list_for_each_entry_safe(ns, next, &ctrl->namespaces, list)
1851 mutex_unlock(&ctrl->namespaces_mutex);
1853 EXPORT_SYMBOL_GPL(nvme_remove_namespaces);
1855 static void nvme_async_event_work(struct work_struct *work)
1857 struct nvme_ctrl *ctrl =
1858 container_of(work, struct nvme_ctrl, async_event_work);
1860 spin_lock_irq(&ctrl->lock);
1861 while (ctrl->event_limit > 0) {
1862 int aer_idx = --ctrl->event_limit;
1864 spin_unlock_irq(&ctrl->lock);
1865 ctrl->ops->submit_async_event(ctrl, aer_idx);
1866 spin_lock_irq(&ctrl->lock);
1868 spin_unlock_irq(&ctrl->lock);
1871 void nvme_complete_async_event(struct nvme_ctrl *ctrl,
1872 struct nvme_completion *cqe)
1874 u16 status = le16_to_cpu(cqe->status) >> 1;
1875 u32 result = le32_to_cpu(cqe->result);
1877 if (status == NVME_SC_SUCCESS || status == NVME_SC_ABORT_REQ) {
1878 ++ctrl->event_limit;
1879 schedule_work(&ctrl->async_event_work);
1882 if (status != NVME_SC_SUCCESS)
1885 switch (result & 0xff07) {
1886 case NVME_AER_NOTICE_NS_CHANGED:
1887 dev_info(ctrl->device, "rescanning\n");
1888 nvme_queue_scan(ctrl);
1891 dev_warn(ctrl->device, "async event result %08x\n", result);
1894 EXPORT_SYMBOL_GPL(nvme_complete_async_event);
1896 void nvme_queue_async_events(struct nvme_ctrl *ctrl)
1898 ctrl->event_limit = NVME_NR_AERS;
1899 schedule_work(&ctrl->async_event_work);
1901 EXPORT_SYMBOL_GPL(nvme_queue_async_events);
1903 static DEFINE_IDA(nvme_instance_ida);
1905 static int nvme_set_instance(struct nvme_ctrl *ctrl)
1907 int instance, error;
1910 if (!ida_pre_get(&nvme_instance_ida, GFP_KERNEL))
1913 spin_lock(&dev_list_lock);
1914 error = ida_get_new(&nvme_instance_ida, &instance);
1915 spin_unlock(&dev_list_lock);
1916 } while (error == -EAGAIN);
1921 ctrl->instance = instance;
1925 static void nvme_release_instance(struct nvme_ctrl *ctrl)
1927 spin_lock(&dev_list_lock);
1928 ida_remove(&nvme_instance_ida, ctrl->instance);
1929 spin_unlock(&dev_list_lock);
1932 void nvme_uninit_ctrl(struct nvme_ctrl *ctrl)
1934 flush_work(&ctrl->async_event_work);
1935 flush_work(&ctrl->scan_work);
1936 nvme_remove_namespaces(ctrl);
1938 device_destroy(nvme_class, MKDEV(nvme_char_major, ctrl->instance));
1940 spin_lock(&dev_list_lock);
1941 list_del(&ctrl->node);
1942 spin_unlock(&dev_list_lock);
1944 EXPORT_SYMBOL_GPL(nvme_uninit_ctrl);
1946 static void nvme_free_ctrl(struct kref *kref)
1948 struct nvme_ctrl *ctrl = container_of(kref, struct nvme_ctrl, kref);
1950 put_device(ctrl->device);
1951 nvme_release_instance(ctrl);
1952 ida_destroy(&ctrl->ns_ida);
1954 ctrl->ops->free_ctrl(ctrl);
1957 void nvme_put_ctrl(struct nvme_ctrl *ctrl)
1959 kref_put(&ctrl->kref, nvme_free_ctrl);
1961 EXPORT_SYMBOL_GPL(nvme_put_ctrl);
1964 * Initialize a NVMe controller structures. This needs to be called during
1965 * earliest initialization so that we have the initialized structured around
1968 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
1969 const struct nvme_ctrl_ops *ops, unsigned long quirks)
1973 ctrl->state = NVME_CTRL_NEW;
1974 spin_lock_init(&ctrl->lock);
1975 INIT_LIST_HEAD(&ctrl->namespaces);
1976 mutex_init(&ctrl->namespaces_mutex);
1977 kref_init(&ctrl->kref);
1980 ctrl->quirks = quirks;
1981 INIT_WORK(&ctrl->scan_work, nvme_scan_work);
1982 INIT_WORK(&ctrl->async_event_work, nvme_async_event_work);
1984 ret = nvme_set_instance(ctrl);
1988 ctrl->device = device_create_with_groups(nvme_class, ctrl->dev,
1989 MKDEV(nvme_char_major, ctrl->instance),
1990 ctrl, nvme_dev_attr_groups,
1991 "nvme%d", ctrl->instance);
1992 if (IS_ERR(ctrl->device)) {
1993 ret = PTR_ERR(ctrl->device);
1994 goto out_release_instance;
1996 get_device(ctrl->device);
1997 ida_init(&ctrl->ns_ida);
1999 spin_lock(&dev_list_lock);
2000 list_add_tail(&ctrl->node, &nvme_ctrl_list);
2001 spin_unlock(&dev_list_lock);
2004 out_release_instance:
2005 nvme_release_instance(ctrl);
2009 EXPORT_SYMBOL_GPL(nvme_init_ctrl);
2012 * nvme_kill_queues(): Ends all namespace queues
2013 * @ctrl: the dead controller that needs to end
2015 * Call this function when the driver determines it is unable to get the
2016 * controller in a state capable of servicing IO.
2018 void nvme_kill_queues(struct nvme_ctrl *ctrl)
2023 list_for_each_entry_rcu(ns, &ctrl->namespaces, list) {
2024 if (!kref_get_unless_zero(&ns->kref))
2028 * Revalidating a dead namespace sets capacity to 0. This will
2029 * end buffered writers dirtying pages that can't be synced.
2031 if (!test_and_set_bit(NVME_NS_DEAD, &ns->flags))
2032 revalidate_disk(ns->disk);
2034 blk_set_queue_dying(ns->queue);
2035 blk_mq_abort_requeue_list(ns->queue);
2036 blk_mq_start_stopped_hw_queues(ns->queue, true);
2042 EXPORT_SYMBOL_GPL(nvme_kill_queues);
2044 void nvme_stop_queues(struct nvme_ctrl *ctrl)
2049 list_for_each_entry_rcu(ns, &ctrl->namespaces, list) {
2050 spin_lock_irq(ns->queue->queue_lock);
2051 queue_flag_set(QUEUE_FLAG_STOPPED, ns->queue);
2052 spin_unlock_irq(ns->queue->queue_lock);
2054 blk_mq_cancel_requeue_work(ns->queue);
2055 blk_mq_stop_hw_queues(ns->queue);
2059 EXPORT_SYMBOL_GPL(nvme_stop_queues);
2061 void nvme_start_queues(struct nvme_ctrl *ctrl)
2066 list_for_each_entry_rcu(ns, &ctrl->namespaces, list) {
2067 queue_flag_clear_unlocked(QUEUE_FLAG_STOPPED, ns->queue);
2068 blk_mq_start_stopped_hw_queues(ns->queue, true);
2069 blk_mq_kick_requeue_list(ns->queue);
2073 EXPORT_SYMBOL_GPL(nvme_start_queues);
2075 int __init nvme_core_init(void)
2079 result = __register_chrdev(nvme_char_major, 0, NVME_MINORS, "nvme",
2083 else if (result > 0)
2084 nvme_char_major = result;
2086 nvme_class = class_create(THIS_MODULE, "nvme");
2087 if (IS_ERR(nvme_class)) {
2088 result = PTR_ERR(nvme_class);
2089 goto unregister_chrdev;
2095 __unregister_chrdev(nvme_char_major, 0, NVME_MINORS, "nvme");
2099 void nvme_core_exit(void)
2101 class_destroy(nvme_class);
2102 __unregister_chrdev(nvme_char_major, 0, NVME_MINORS, "nvme");
2105 MODULE_LICENSE("GPL");
2106 MODULE_VERSION("1.0");
2107 module_init(nvme_core_init);
2108 module_exit(nvme_core_exit);