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
;
87 spin_lock_irq(&ctrl
->lock
);
89 old_state
= ctrl
->state
;
94 case NVME_CTRL_RESETTING
:
95 case NVME_CTRL_RECONNECTING
:
102 case NVME_CTRL_RESETTING
:
106 case NVME_CTRL_RECONNECTING
:
113 case NVME_CTRL_RECONNECTING
:
122 case NVME_CTRL_DELETING
:
125 case NVME_CTRL_RESETTING
:
126 case NVME_CTRL_RECONNECTING
:
135 case NVME_CTRL_DELETING
:
147 ctrl
->state
= new_state
;
149 spin_unlock_irq(&ctrl
->lock
);
153 EXPORT_SYMBOL_GPL(nvme_change_ctrl_state
);
155 static void nvme_free_ns(struct kref
*kref
)
157 struct nvme_ns
*ns
= container_of(kref
, struct nvme_ns
, kref
);
160 nvme_nvm_unregister(ns
);
163 spin_lock(&dev_list_lock
);
164 ns
->disk
->private_data
= NULL
;
165 spin_unlock(&dev_list_lock
);
169 ida_simple_remove(&ns
->ctrl
->ns_ida
, ns
->instance
);
170 nvme_put_ctrl(ns
->ctrl
);
174 static void nvme_put_ns(struct nvme_ns
*ns
)
176 kref_put(&ns
->kref
, nvme_free_ns
);
179 static struct nvme_ns
*nvme_get_ns_from_disk(struct gendisk
*disk
)
183 spin_lock(&dev_list_lock
);
184 ns
= disk
->private_data
;
186 if (!kref_get_unless_zero(&ns
->kref
))
188 if (!try_module_get(ns
->ctrl
->ops
->module
))
191 spin_unlock(&dev_list_lock
);
196 kref_put(&ns
->kref
, nvme_free_ns
);
198 spin_unlock(&dev_list_lock
);
202 void nvme_requeue_req(struct request
*req
)
206 blk_mq_requeue_request(req
);
207 spin_lock_irqsave(req
->q
->queue_lock
, flags
);
208 if (!blk_queue_stopped(req
->q
))
209 blk_mq_kick_requeue_list(req
->q
);
210 spin_unlock_irqrestore(req
->q
->queue_lock
, flags
);
212 EXPORT_SYMBOL_GPL(nvme_requeue_req
);
214 struct request
*nvme_alloc_request(struct request_queue
*q
,
215 struct nvme_command
*cmd
, unsigned int flags
, int qid
)
219 if (qid
== NVME_QID_ANY
) {
220 req
= blk_mq_alloc_request(q
, nvme_is_write(cmd
), flags
);
222 req
= blk_mq_alloc_request_hctx(q
, nvme_is_write(cmd
), flags
,
228 req
->cmd_type
= REQ_TYPE_DRV_PRIV
;
229 req
->cmd_flags
|= REQ_FAILFAST_DRIVER
;
230 req
->cmd
= (unsigned char *)cmd
;
231 req
->cmd_len
= sizeof(struct nvme_command
);
235 EXPORT_SYMBOL_GPL(nvme_alloc_request
);
237 static inline void nvme_setup_flush(struct nvme_ns
*ns
,
238 struct nvme_command
*cmnd
)
240 memset(cmnd
, 0, sizeof(*cmnd
));
241 cmnd
->common
.opcode
= nvme_cmd_flush
;
242 cmnd
->common
.nsid
= cpu_to_le32(ns
->ns_id
);
245 static inline int nvme_setup_discard(struct nvme_ns
*ns
, struct request
*req
,
246 struct nvme_command
*cmnd
)
248 struct nvme_dsm_range
*range
;
251 unsigned int nr_bytes
= blk_rq_bytes(req
);
253 range
= kmalloc(sizeof(*range
), GFP_ATOMIC
);
255 return BLK_MQ_RQ_QUEUE_BUSY
;
257 range
->cattr
= cpu_to_le32(0);
258 range
->nlb
= cpu_to_le32(nr_bytes
>> ns
->lba_shift
);
259 range
->slba
= cpu_to_le64(nvme_block_nr(ns
, blk_rq_pos(req
)));
261 memset(cmnd
, 0, sizeof(*cmnd
));
262 cmnd
->dsm
.opcode
= nvme_cmd_dsm
;
263 cmnd
->dsm
.nsid
= cpu_to_le32(ns
->ns_id
);
265 cmnd
->dsm
.attributes
= cpu_to_le32(NVME_DSMGMT_AD
);
267 req
->completion_data
= range
;
268 page
= virt_to_page(range
);
269 offset
= offset_in_page(range
);
270 blk_add_request_payload(req
, page
, offset
, sizeof(*range
));
273 * we set __data_len back to the size of the area to be discarded
274 * on disk. This allows us to report completion on the full amount
275 * of blocks described by the request.
277 req
->__data_len
= nr_bytes
;
282 static inline void nvme_setup_rw(struct nvme_ns
*ns
, struct request
*req
,
283 struct nvme_command
*cmnd
)
288 if (req
->cmd_flags
& REQ_FUA
)
289 control
|= NVME_RW_FUA
;
290 if (req
->cmd_flags
& (REQ_FAILFAST_DEV
| REQ_RAHEAD
))
291 control
|= NVME_RW_LR
;
293 if (req
->cmd_flags
& REQ_RAHEAD
)
294 dsmgmt
|= NVME_RW_DSM_FREQ_PREFETCH
;
296 memset(cmnd
, 0, sizeof(*cmnd
));
297 cmnd
->rw
.opcode
= (rq_data_dir(req
) ? nvme_cmd_write
: nvme_cmd_read
);
298 cmnd
->rw
.command_id
= req
->tag
;
299 cmnd
->rw
.nsid
= cpu_to_le32(ns
->ns_id
);
300 cmnd
->rw
.slba
= cpu_to_le64(nvme_block_nr(ns
, blk_rq_pos(req
)));
301 cmnd
->rw
.length
= cpu_to_le16((blk_rq_bytes(req
) >> ns
->lba_shift
) - 1);
304 switch (ns
->pi_type
) {
305 case NVME_NS_DPS_PI_TYPE3
:
306 control
|= NVME_RW_PRINFO_PRCHK_GUARD
;
308 case NVME_NS_DPS_PI_TYPE1
:
309 case NVME_NS_DPS_PI_TYPE2
:
310 control
|= NVME_RW_PRINFO_PRCHK_GUARD
|
311 NVME_RW_PRINFO_PRCHK_REF
;
312 cmnd
->rw
.reftag
= cpu_to_le32(
313 nvme_block_nr(ns
, blk_rq_pos(req
)));
316 if (!blk_integrity_rq(req
))
317 control
|= NVME_RW_PRINFO_PRACT
;
320 cmnd
->rw
.control
= cpu_to_le16(control
);
321 cmnd
->rw
.dsmgmt
= cpu_to_le32(dsmgmt
);
324 int nvme_setup_cmd(struct nvme_ns
*ns
, struct request
*req
,
325 struct nvme_command
*cmd
)
329 if (req
->cmd_type
== REQ_TYPE_DRV_PRIV
)
330 memcpy(cmd
, req
->cmd
, sizeof(*cmd
));
331 else if (req_op(req
) == REQ_OP_FLUSH
)
332 nvme_setup_flush(ns
, cmd
);
333 else if (req_op(req
) == REQ_OP_DISCARD
)
334 ret
= nvme_setup_discard(ns
, req
, cmd
);
336 nvme_setup_rw(ns
, req
, cmd
);
340 EXPORT_SYMBOL_GPL(nvme_setup_cmd
);
343 * Returns 0 on success. If the result is negative, it's a Linux error code;
344 * if the result is positive, it's an NVM Express status code
346 int __nvme_submit_sync_cmd(struct request_queue
*q
, struct nvme_command
*cmd
,
347 struct nvme_completion
*cqe
, void *buffer
, unsigned bufflen
,
348 unsigned timeout
, int qid
, int at_head
, int flags
)
353 req
= nvme_alloc_request(q
, cmd
, flags
, qid
);
357 req
->timeout
= timeout
? timeout
: ADMIN_TIMEOUT
;
360 if (buffer
&& bufflen
) {
361 ret
= blk_rq_map_kern(q
, req
, buffer
, bufflen
, GFP_KERNEL
);
366 blk_execute_rq(req
->q
, NULL
, req
, at_head
);
369 blk_mq_free_request(req
);
372 EXPORT_SYMBOL_GPL(__nvme_submit_sync_cmd
);
374 int nvme_submit_sync_cmd(struct request_queue
*q
, struct nvme_command
*cmd
,
375 void *buffer
, unsigned bufflen
)
377 return __nvme_submit_sync_cmd(q
, cmd
, NULL
, buffer
, bufflen
, 0,
380 EXPORT_SYMBOL_GPL(nvme_submit_sync_cmd
);
382 int __nvme_submit_user_cmd(struct request_queue
*q
, struct nvme_command
*cmd
,
383 void __user
*ubuffer
, unsigned bufflen
,
384 void __user
*meta_buffer
, unsigned meta_len
, u32 meta_seed
,
385 u32
*result
, unsigned timeout
)
387 bool write
= nvme_is_write(cmd
);
388 struct nvme_completion cqe
;
389 struct nvme_ns
*ns
= q
->queuedata
;
390 struct gendisk
*disk
= ns
? ns
->disk
: NULL
;
392 struct bio
*bio
= NULL
;
396 req
= nvme_alloc_request(q
, cmd
, 0, NVME_QID_ANY
);
400 req
->timeout
= timeout
? timeout
: ADMIN_TIMEOUT
;
403 if (ubuffer
&& bufflen
) {
404 ret
= blk_rq_map_user(q
, req
, NULL
, ubuffer
, bufflen
,
412 bio
->bi_bdev
= bdget_disk(disk
, 0);
418 if (meta_buffer
&& meta_len
) {
419 struct bio_integrity_payload
*bip
;
421 meta
= kmalloc(meta_len
, GFP_KERNEL
);
428 if (copy_from_user(meta
, meta_buffer
,
435 bip
= bio_integrity_alloc(bio
, GFP_KERNEL
, 1);
441 bip
->bip_iter
.bi_size
= meta_len
;
442 bip
->bip_iter
.bi_sector
= meta_seed
;
444 ret
= bio_integrity_add_page(bio
, virt_to_page(meta
),
445 meta_len
, offset_in_page(meta
));
446 if (ret
!= meta_len
) {
453 blk_execute_rq(req
->q
, disk
, req
, 0);
456 *result
= le32_to_cpu(cqe
.result
);
457 if (meta
&& !ret
&& !write
) {
458 if (copy_to_user(meta_buffer
, meta
, meta_len
))
465 if (disk
&& bio
->bi_bdev
)
467 blk_rq_unmap_user(bio
);
470 blk_mq_free_request(req
);
474 int nvme_submit_user_cmd(struct request_queue
*q
, struct nvme_command
*cmd
,
475 void __user
*ubuffer
, unsigned bufflen
, u32
*result
,
478 return __nvme_submit_user_cmd(q
, cmd
, ubuffer
, bufflen
, NULL
, 0, 0,
482 static void nvme_keep_alive_end_io(struct request
*rq
, int error
)
484 struct nvme_ctrl
*ctrl
= rq
->end_io_data
;
486 blk_mq_free_request(rq
);
489 dev_err(ctrl
->device
,
490 "failed nvme_keep_alive_end_io error=%d\n", error
);
494 schedule_delayed_work(&ctrl
->ka_work
, ctrl
->kato
* HZ
);
497 static int nvme_keep_alive(struct nvme_ctrl
*ctrl
)
499 struct nvme_command c
;
502 memset(&c
, 0, sizeof(c
));
503 c
.common
.opcode
= nvme_admin_keep_alive
;
505 rq
= nvme_alloc_request(ctrl
->admin_q
, &c
, BLK_MQ_REQ_RESERVED
,
510 rq
->timeout
= ctrl
->kato
* HZ
;
511 rq
->end_io_data
= ctrl
;
513 blk_execute_rq_nowait(rq
->q
, NULL
, rq
, 0, nvme_keep_alive_end_io
);
518 static void nvme_keep_alive_work(struct work_struct
*work
)
520 struct nvme_ctrl
*ctrl
= container_of(to_delayed_work(work
),
521 struct nvme_ctrl
, ka_work
);
523 if (nvme_keep_alive(ctrl
)) {
524 /* allocation failure, reset the controller */
525 dev_err(ctrl
->device
, "keep-alive failed\n");
526 ctrl
->ops
->reset_ctrl(ctrl
);
531 void nvme_start_keep_alive(struct nvme_ctrl
*ctrl
)
533 if (unlikely(ctrl
->kato
== 0))
536 INIT_DELAYED_WORK(&ctrl
->ka_work
, nvme_keep_alive_work
);
537 schedule_delayed_work(&ctrl
->ka_work
, ctrl
->kato
* HZ
);
539 EXPORT_SYMBOL_GPL(nvme_start_keep_alive
);
541 void nvme_stop_keep_alive(struct nvme_ctrl
*ctrl
)
543 if (unlikely(ctrl
->kato
== 0))
546 cancel_delayed_work_sync(&ctrl
->ka_work
);
548 EXPORT_SYMBOL_GPL(nvme_stop_keep_alive
);
550 int nvme_identify_ctrl(struct nvme_ctrl
*dev
, struct nvme_id_ctrl
**id
)
552 struct nvme_command c
= { };
555 /* gcc-4.4.4 (at least) has issues with initializers and anon unions */
556 c
.identify
.opcode
= nvme_admin_identify
;
557 c
.identify
.cns
= cpu_to_le32(1);
559 *id
= kmalloc(sizeof(struct nvme_id_ctrl
), GFP_KERNEL
);
563 error
= nvme_submit_sync_cmd(dev
->admin_q
, &c
, *id
,
564 sizeof(struct nvme_id_ctrl
));
570 static int nvme_identify_ns_list(struct nvme_ctrl
*dev
, unsigned nsid
, __le32
*ns_list
)
572 struct nvme_command c
= { };
574 c
.identify
.opcode
= nvme_admin_identify
;
575 c
.identify
.cns
= cpu_to_le32(2);
576 c
.identify
.nsid
= cpu_to_le32(nsid
);
577 return nvme_submit_sync_cmd(dev
->admin_q
, &c
, ns_list
, 0x1000);
580 int nvme_identify_ns(struct nvme_ctrl
*dev
, unsigned nsid
,
581 struct nvme_id_ns
**id
)
583 struct nvme_command c
= { };
586 /* gcc-4.4.4 (at least) has issues with initializers and anon unions */
587 c
.identify
.opcode
= nvme_admin_identify
,
588 c
.identify
.nsid
= cpu_to_le32(nsid
),
590 *id
= kmalloc(sizeof(struct nvme_id_ns
), GFP_KERNEL
);
594 error
= nvme_submit_sync_cmd(dev
->admin_q
, &c
, *id
,
595 sizeof(struct nvme_id_ns
));
601 int nvme_get_features(struct nvme_ctrl
*dev
, unsigned fid
, unsigned nsid
,
602 dma_addr_t dma_addr
, u32
*result
)
604 struct nvme_command c
;
605 struct nvme_completion cqe
;
608 memset(&c
, 0, sizeof(c
));
609 c
.features
.opcode
= nvme_admin_get_features
;
610 c
.features
.nsid
= cpu_to_le32(nsid
);
611 c
.features
.dptr
.prp1
= cpu_to_le64(dma_addr
);
612 c
.features
.fid
= cpu_to_le32(fid
);
614 ret
= __nvme_submit_sync_cmd(dev
->admin_q
, &c
, &cqe
, NULL
, 0, 0,
616 if (ret
>= 0 && result
)
617 *result
= le32_to_cpu(cqe
.result
);
621 int nvme_set_features(struct nvme_ctrl
*dev
, unsigned fid
, unsigned dword11
,
622 dma_addr_t dma_addr
, u32
*result
)
624 struct nvme_command c
;
625 struct nvme_completion cqe
;
628 memset(&c
, 0, sizeof(c
));
629 c
.features
.opcode
= nvme_admin_set_features
;
630 c
.features
.dptr
.prp1
= cpu_to_le64(dma_addr
);
631 c
.features
.fid
= cpu_to_le32(fid
);
632 c
.features
.dword11
= cpu_to_le32(dword11
);
634 ret
= __nvme_submit_sync_cmd(dev
->admin_q
, &c
, &cqe
, NULL
, 0, 0,
636 if (ret
>= 0 && result
)
637 *result
= le32_to_cpu(cqe
.result
);
641 int nvme_get_log_page(struct nvme_ctrl
*dev
, struct nvme_smart_log
**log
)
643 struct nvme_command c
= { };
646 c
.common
.opcode
= nvme_admin_get_log_page
,
647 c
.common
.nsid
= cpu_to_le32(0xFFFFFFFF),
648 c
.common
.cdw10
[0] = cpu_to_le32(
649 (((sizeof(struct nvme_smart_log
) / 4) - 1) << 16) |
652 *log
= kmalloc(sizeof(struct nvme_smart_log
), GFP_KERNEL
);
656 error
= nvme_submit_sync_cmd(dev
->admin_q
, &c
, *log
,
657 sizeof(struct nvme_smart_log
));
663 int nvme_set_queue_count(struct nvme_ctrl
*ctrl
, int *count
)
665 u32 q_count
= (*count
- 1) | ((*count
- 1) << 16);
667 int status
, nr_io_queues
;
669 status
= nvme_set_features(ctrl
, NVME_FEAT_NUM_QUEUES
, q_count
, 0,
675 * Degraded controllers might return an error when setting the queue
676 * count. We still want to be able to bring them online and offer
677 * access to the admin queue, as that might be only way to fix them up.
680 dev_err(ctrl
->dev
, "Could not set queue count (%d)\n", status
);
683 nr_io_queues
= min(result
& 0xffff, result
>> 16) + 1;
684 *count
= min(*count
, nr_io_queues
);
689 EXPORT_SYMBOL_GPL(nvme_set_queue_count
);
691 static int nvme_submit_io(struct nvme_ns
*ns
, struct nvme_user_io __user
*uio
)
693 struct nvme_user_io io
;
694 struct nvme_command c
;
695 unsigned length
, meta_len
;
696 void __user
*metadata
;
698 if (copy_from_user(&io
, uio
, sizeof(io
)))
706 case nvme_cmd_compare
:
712 length
= (io
.nblocks
+ 1) << ns
->lba_shift
;
713 meta_len
= (io
.nblocks
+ 1) * ns
->ms
;
714 metadata
= (void __user
*)(uintptr_t)io
.metadata
;
719 } else if (meta_len
) {
720 if ((io
.metadata
& 3) || !io
.metadata
)
724 memset(&c
, 0, sizeof(c
));
725 c
.rw
.opcode
= io
.opcode
;
726 c
.rw
.flags
= io
.flags
;
727 c
.rw
.nsid
= cpu_to_le32(ns
->ns_id
);
728 c
.rw
.slba
= cpu_to_le64(io
.slba
);
729 c
.rw
.length
= cpu_to_le16(io
.nblocks
);
730 c
.rw
.control
= cpu_to_le16(io
.control
);
731 c
.rw
.dsmgmt
= cpu_to_le32(io
.dsmgmt
);
732 c
.rw
.reftag
= cpu_to_le32(io
.reftag
);
733 c
.rw
.apptag
= cpu_to_le16(io
.apptag
);
734 c
.rw
.appmask
= cpu_to_le16(io
.appmask
);
736 return __nvme_submit_user_cmd(ns
->queue
, &c
,
737 (void __user
*)(uintptr_t)io
.addr
, length
,
738 metadata
, meta_len
, io
.slba
, NULL
, 0);
741 static int nvme_user_cmd(struct nvme_ctrl
*ctrl
, struct nvme_ns
*ns
,
742 struct nvme_passthru_cmd __user
*ucmd
)
744 struct nvme_passthru_cmd cmd
;
745 struct nvme_command c
;
746 unsigned timeout
= 0;
749 if (!capable(CAP_SYS_ADMIN
))
751 if (copy_from_user(&cmd
, ucmd
, sizeof(cmd
)))
756 memset(&c
, 0, sizeof(c
));
757 c
.common
.opcode
= cmd
.opcode
;
758 c
.common
.flags
= cmd
.flags
;
759 c
.common
.nsid
= cpu_to_le32(cmd
.nsid
);
760 c
.common
.cdw2
[0] = cpu_to_le32(cmd
.cdw2
);
761 c
.common
.cdw2
[1] = cpu_to_le32(cmd
.cdw3
);
762 c
.common
.cdw10
[0] = cpu_to_le32(cmd
.cdw10
);
763 c
.common
.cdw10
[1] = cpu_to_le32(cmd
.cdw11
);
764 c
.common
.cdw10
[2] = cpu_to_le32(cmd
.cdw12
);
765 c
.common
.cdw10
[3] = cpu_to_le32(cmd
.cdw13
);
766 c
.common
.cdw10
[4] = cpu_to_le32(cmd
.cdw14
);
767 c
.common
.cdw10
[5] = cpu_to_le32(cmd
.cdw15
);
770 timeout
= msecs_to_jiffies(cmd
.timeout_ms
);
772 status
= nvme_submit_user_cmd(ns
? ns
->queue
: ctrl
->admin_q
, &c
,
773 (void __user
*)(uintptr_t)cmd
.addr
, cmd
.data_len
,
774 &cmd
.result
, timeout
);
776 if (put_user(cmd
.result
, &ucmd
->result
))
783 static int nvme_ioctl(struct block_device
*bdev
, fmode_t mode
,
784 unsigned int cmd
, unsigned long arg
)
786 struct nvme_ns
*ns
= bdev
->bd_disk
->private_data
;
790 force_successful_syscall_return();
792 case NVME_IOCTL_ADMIN_CMD
:
793 return nvme_user_cmd(ns
->ctrl
, NULL
, (void __user
*)arg
);
794 case NVME_IOCTL_IO_CMD
:
795 return nvme_user_cmd(ns
->ctrl
, ns
, (void __user
*)arg
);
796 case NVME_IOCTL_SUBMIT_IO
:
797 return nvme_submit_io(ns
, (void __user
*)arg
);
798 #ifdef CONFIG_BLK_DEV_NVME_SCSI
799 case SG_GET_VERSION_NUM
:
800 return nvme_sg_get_version_num((void __user
*)arg
);
802 return nvme_sg_io(ns
, (void __user
*)arg
);
810 static int nvme_compat_ioctl(struct block_device
*bdev
, fmode_t mode
,
811 unsigned int cmd
, unsigned long arg
)
817 return nvme_ioctl(bdev
, mode
, cmd
, arg
);
820 #define nvme_compat_ioctl NULL
823 static int nvme_open(struct block_device
*bdev
, fmode_t mode
)
825 return nvme_get_ns_from_disk(bdev
->bd_disk
) ? 0 : -ENXIO
;
828 static void nvme_release(struct gendisk
*disk
, fmode_t mode
)
830 struct nvme_ns
*ns
= disk
->private_data
;
832 module_put(ns
->ctrl
->ops
->module
);
836 static int nvme_getgeo(struct block_device
*bdev
, struct hd_geometry
*geo
)
838 /* some standard values */
840 geo
->sectors
= 1 << 5;
841 geo
->cylinders
= get_capacity(bdev
->bd_disk
) >> 11;
845 #ifdef CONFIG_BLK_DEV_INTEGRITY
846 static void nvme_init_integrity(struct nvme_ns
*ns
)
848 struct blk_integrity integrity
;
850 memset(&integrity
, 0, sizeof(integrity
));
851 switch (ns
->pi_type
) {
852 case NVME_NS_DPS_PI_TYPE3
:
853 integrity
.profile
= &t10_pi_type3_crc
;
854 integrity
.tag_size
= sizeof(u16
) + sizeof(u32
);
855 integrity
.flags
|= BLK_INTEGRITY_DEVICE_CAPABLE
;
857 case NVME_NS_DPS_PI_TYPE1
:
858 case NVME_NS_DPS_PI_TYPE2
:
859 integrity
.profile
= &t10_pi_type1_crc
;
860 integrity
.tag_size
= sizeof(u16
);
861 integrity
.flags
|= BLK_INTEGRITY_DEVICE_CAPABLE
;
864 integrity
.profile
= NULL
;
867 integrity
.tuple_size
= ns
->ms
;
868 blk_integrity_register(ns
->disk
, &integrity
);
869 blk_queue_max_integrity_segments(ns
->queue
, 1);
872 static void nvme_init_integrity(struct nvme_ns
*ns
)
875 #endif /* CONFIG_BLK_DEV_INTEGRITY */
877 static void nvme_config_discard(struct nvme_ns
*ns
)
879 struct nvme_ctrl
*ctrl
= ns
->ctrl
;
880 u32 logical_block_size
= queue_logical_block_size(ns
->queue
);
882 if (ctrl
->quirks
& NVME_QUIRK_DISCARD_ZEROES
)
883 ns
->queue
->limits
.discard_zeroes_data
= 1;
885 ns
->queue
->limits
.discard_zeroes_data
= 0;
887 ns
->queue
->limits
.discard_alignment
= logical_block_size
;
888 ns
->queue
->limits
.discard_granularity
= logical_block_size
;
889 blk_queue_max_discard_sectors(ns
->queue
, UINT_MAX
);
890 queue_flag_set_unlocked(QUEUE_FLAG_DISCARD
, ns
->queue
);
893 static int nvme_revalidate_ns(struct nvme_ns
*ns
, struct nvme_id_ns
**id
)
895 if (nvme_identify_ns(ns
->ctrl
, ns
->ns_id
, id
)) {
896 dev_warn(ns
->ctrl
->dev
, "%s: Identify failure\n", __func__
);
900 if ((*id
)->ncap
== 0) {
905 if (ns
->ctrl
->vs
>= NVME_VS(1, 1))
906 memcpy(ns
->eui
, (*id
)->eui64
, sizeof(ns
->eui
));
907 if (ns
->ctrl
->vs
>= NVME_VS(1, 2))
908 memcpy(ns
->uuid
, (*id
)->nguid
, sizeof(ns
->uuid
));
913 static void __nvme_revalidate_disk(struct gendisk
*disk
, struct nvme_id_ns
*id
)
915 struct nvme_ns
*ns
= disk
->private_data
;
921 lbaf
= id
->flbas
& NVME_NS_FLBAS_LBA_MASK
;
922 ns
->lba_shift
= id
->lbaf
[lbaf
].ds
;
923 ns
->ms
= le16_to_cpu(id
->lbaf
[lbaf
].ms
);
924 ns
->ext
= ns
->ms
&& (id
->flbas
& NVME_NS_FLBAS_META_EXT
);
927 * If identify namespace failed, use default 512 byte block size so
928 * block layer can use before failing read/write for 0 capacity.
930 if (ns
->lba_shift
== 0)
932 bs
= 1 << ns
->lba_shift
;
933 /* XXX: PI implementation requires metadata equal t10 pi tuple size */
934 pi_type
= ns
->ms
== sizeof(struct t10_pi_tuple
) ?
935 id
->dps
& NVME_NS_DPS_PI_MASK
: 0;
937 blk_mq_freeze_queue(disk
->queue
);
938 if (blk_get_integrity(disk
) && (ns
->pi_type
!= pi_type
||
940 bs
!= queue_logical_block_size(disk
->queue
) ||
941 (ns
->ms
&& ns
->ext
)))
942 blk_integrity_unregister(disk
);
944 ns
->pi_type
= pi_type
;
945 blk_queue_logical_block_size(ns
->queue
, bs
);
947 if (ns
->ms
&& !blk_get_integrity(disk
) && !ns
->ext
)
948 nvme_init_integrity(ns
);
949 if (ns
->ms
&& !(ns
->ms
== 8 && ns
->pi_type
) && !blk_get_integrity(disk
))
950 set_capacity(disk
, 0);
952 set_capacity(disk
, le64_to_cpup(&id
->nsze
) << (ns
->lba_shift
- 9));
954 if (ns
->ctrl
->oncs
& NVME_CTRL_ONCS_DSM
)
955 nvme_config_discard(ns
);
956 blk_mq_unfreeze_queue(disk
->queue
);
959 static int nvme_revalidate_disk(struct gendisk
*disk
)
961 struct nvme_ns
*ns
= disk
->private_data
;
962 struct nvme_id_ns
*id
= NULL
;
965 if (test_bit(NVME_NS_DEAD
, &ns
->flags
)) {
966 set_capacity(disk
, 0);
970 ret
= nvme_revalidate_ns(ns
, &id
);
974 __nvme_revalidate_disk(disk
, id
);
980 static char nvme_pr_type(enum pr_type type
)
983 case PR_WRITE_EXCLUSIVE
:
985 case PR_EXCLUSIVE_ACCESS
:
987 case PR_WRITE_EXCLUSIVE_REG_ONLY
:
989 case PR_EXCLUSIVE_ACCESS_REG_ONLY
:
991 case PR_WRITE_EXCLUSIVE_ALL_REGS
:
993 case PR_EXCLUSIVE_ACCESS_ALL_REGS
:
1000 static int nvme_pr_command(struct block_device
*bdev
, u32 cdw10
,
1001 u64 key
, u64 sa_key
, u8 op
)
1003 struct nvme_ns
*ns
= bdev
->bd_disk
->private_data
;
1004 struct nvme_command c
;
1005 u8 data
[16] = { 0, };
1007 put_unaligned_le64(key
, &data
[0]);
1008 put_unaligned_le64(sa_key
, &data
[8]);
1010 memset(&c
, 0, sizeof(c
));
1011 c
.common
.opcode
= op
;
1012 c
.common
.nsid
= cpu_to_le32(ns
->ns_id
);
1013 c
.common
.cdw10
[0] = cpu_to_le32(cdw10
);
1015 return nvme_submit_sync_cmd(ns
->queue
, &c
, data
, 16);
1018 static int nvme_pr_register(struct block_device
*bdev
, u64 old
,
1019 u64
new, unsigned flags
)
1023 if (flags
& ~PR_FL_IGNORE_KEY
)
1026 cdw10
= old
? 2 : 0;
1027 cdw10
|= (flags
& PR_FL_IGNORE_KEY
) ? 1 << 3 : 0;
1028 cdw10
|= (1 << 30) | (1 << 31); /* PTPL=1 */
1029 return nvme_pr_command(bdev
, cdw10
, old
, new, nvme_cmd_resv_register
);
1032 static int nvme_pr_reserve(struct block_device
*bdev
, u64 key
,
1033 enum pr_type type
, unsigned flags
)
1037 if (flags
& ~PR_FL_IGNORE_KEY
)
1040 cdw10
= nvme_pr_type(type
) << 8;
1041 cdw10
|= ((flags
& PR_FL_IGNORE_KEY
) ? 1 << 3 : 0);
1042 return nvme_pr_command(bdev
, cdw10
, key
, 0, nvme_cmd_resv_acquire
);
1045 static int nvme_pr_preempt(struct block_device
*bdev
, u64 old
, u64
new,
1046 enum pr_type type
, bool abort
)
1048 u32 cdw10
= nvme_pr_type(type
) << 8 | abort
? 2 : 1;
1049 return nvme_pr_command(bdev
, cdw10
, old
, new, nvme_cmd_resv_acquire
);
1052 static int nvme_pr_clear(struct block_device
*bdev
, u64 key
)
1054 u32 cdw10
= 1 | (key
? 1 << 3 : 0);
1055 return nvme_pr_command(bdev
, cdw10
, key
, 0, nvme_cmd_resv_register
);
1058 static int nvme_pr_release(struct block_device
*bdev
, u64 key
, enum pr_type type
)
1060 u32 cdw10
= nvme_pr_type(type
) << 8 | key
? 1 << 3 : 0;
1061 return nvme_pr_command(bdev
, cdw10
, key
, 0, nvme_cmd_resv_release
);
1064 static const struct pr_ops nvme_pr_ops
= {
1065 .pr_register
= nvme_pr_register
,
1066 .pr_reserve
= nvme_pr_reserve
,
1067 .pr_release
= nvme_pr_release
,
1068 .pr_preempt
= nvme_pr_preempt
,
1069 .pr_clear
= nvme_pr_clear
,
1072 static const struct block_device_operations nvme_fops
= {
1073 .owner
= THIS_MODULE
,
1074 .ioctl
= nvme_ioctl
,
1075 .compat_ioctl
= nvme_compat_ioctl
,
1077 .release
= nvme_release
,
1078 .getgeo
= nvme_getgeo
,
1079 .revalidate_disk
= nvme_revalidate_disk
,
1080 .pr_ops
= &nvme_pr_ops
,
1083 static int nvme_wait_ready(struct nvme_ctrl
*ctrl
, u64 cap
, bool enabled
)
1085 unsigned long timeout
=
1086 ((NVME_CAP_TIMEOUT(cap
) + 1) * HZ
/ 2) + jiffies
;
1087 u32 csts
, bit
= enabled
? NVME_CSTS_RDY
: 0;
1090 while ((ret
= ctrl
->ops
->reg_read32(ctrl
, NVME_REG_CSTS
, &csts
)) == 0) {
1091 if ((csts
& NVME_CSTS_RDY
) == bit
)
1095 if (fatal_signal_pending(current
))
1097 if (time_after(jiffies
, timeout
)) {
1098 dev_err(ctrl
->device
,
1099 "Device not ready; aborting %s\n", enabled
?
1100 "initialisation" : "reset");
1109 * If the device has been passed off to us in an enabled state, just clear
1110 * the enabled bit. The spec says we should set the 'shutdown notification
1111 * bits', but doing so may cause the device to complete commands to the
1112 * admin queue ... and we don't know what memory that might be pointing at!
1114 int nvme_disable_ctrl(struct nvme_ctrl
*ctrl
, u64 cap
)
1118 ctrl
->ctrl_config
&= ~NVME_CC_SHN_MASK
;
1119 ctrl
->ctrl_config
&= ~NVME_CC_ENABLE
;
1121 ret
= ctrl
->ops
->reg_write32(ctrl
, NVME_REG_CC
, ctrl
->ctrl_config
);
1125 /* Checking for ctrl->tagset is a trick to avoid sleeping on module
1126 * load, since we only need the quirk on reset_controller. Notice
1127 * that the HGST device needs this delay only in firmware activation
1128 * procedure; unfortunately we have no (easy) way to verify this.
1130 if ((ctrl
->quirks
& NVME_QUIRK_DELAY_BEFORE_CHK_RDY
) && ctrl
->tagset
)
1131 msleep(NVME_QUIRK_DELAY_AMOUNT
);
1133 return nvme_wait_ready(ctrl
, cap
, false);
1135 EXPORT_SYMBOL_GPL(nvme_disable_ctrl
);
1137 int nvme_enable_ctrl(struct nvme_ctrl
*ctrl
, u64 cap
)
1140 * Default to a 4K page size, with the intention to update this
1141 * path in the future to accomodate architectures with differing
1142 * kernel and IO page sizes.
1144 unsigned dev_page_min
= NVME_CAP_MPSMIN(cap
) + 12, page_shift
= 12;
1147 if (page_shift
< dev_page_min
) {
1148 dev_err(ctrl
->device
,
1149 "Minimum device page size %u too large for host (%u)\n",
1150 1 << dev_page_min
, 1 << page_shift
);
1154 ctrl
->page_size
= 1 << page_shift
;
1156 ctrl
->ctrl_config
= NVME_CC_CSS_NVM
;
1157 ctrl
->ctrl_config
|= (page_shift
- 12) << NVME_CC_MPS_SHIFT
;
1158 ctrl
->ctrl_config
|= NVME_CC_ARB_RR
| NVME_CC_SHN_NONE
;
1159 ctrl
->ctrl_config
|= NVME_CC_IOSQES
| NVME_CC_IOCQES
;
1160 ctrl
->ctrl_config
|= NVME_CC_ENABLE
;
1162 ret
= ctrl
->ops
->reg_write32(ctrl
, NVME_REG_CC
, ctrl
->ctrl_config
);
1165 return nvme_wait_ready(ctrl
, cap
, true);
1167 EXPORT_SYMBOL_GPL(nvme_enable_ctrl
);
1169 int nvme_shutdown_ctrl(struct nvme_ctrl
*ctrl
)
1171 unsigned long timeout
= SHUTDOWN_TIMEOUT
+ jiffies
;
1175 ctrl
->ctrl_config
&= ~NVME_CC_SHN_MASK
;
1176 ctrl
->ctrl_config
|= NVME_CC_SHN_NORMAL
;
1178 ret
= ctrl
->ops
->reg_write32(ctrl
, NVME_REG_CC
, ctrl
->ctrl_config
);
1182 while ((ret
= ctrl
->ops
->reg_read32(ctrl
, NVME_REG_CSTS
, &csts
)) == 0) {
1183 if ((csts
& NVME_CSTS_SHST_MASK
) == NVME_CSTS_SHST_CMPLT
)
1187 if (fatal_signal_pending(current
))
1189 if (time_after(jiffies
, timeout
)) {
1190 dev_err(ctrl
->device
,
1191 "Device shutdown incomplete; abort shutdown\n");
1198 EXPORT_SYMBOL_GPL(nvme_shutdown_ctrl
);
1200 static void nvme_set_queue_limits(struct nvme_ctrl
*ctrl
,
1201 struct request_queue
*q
)
1205 if (ctrl
->max_hw_sectors
) {
1207 (ctrl
->max_hw_sectors
/ (ctrl
->page_size
>> 9)) + 1;
1209 blk_queue_max_hw_sectors(q
, ctrl
->max_hw_sectors
);
1210 blk_queue_max_segments(q
, min_t(u32
, max_segments
, USHRT_MAX
));
1212 if (ctrl
->stripe_size
)
1213 blk_queue_chunk_sectors(q
, ctrl
->stripe_size
>> 9);
1214 blk_queue_virt_boundary(q
, ctrl
->page_size
- 1);
1215 if (ctrl
->vwc
& NVME_CTRL_VWC_PRESENT
)
1217 blk_queue_write_cache(q
, vwc
, vwc
);
1221 * Initialize the cached copies of the Identify data and various controller
1222 * register in our nvme_ctrl structure. This should be called as soon as
1223 * the admin queue is fully up and running.
1225 int nvme_init_identify(struct nvme_ctrl
*ctrl
)
1227 struct nvme_id_ctrl
*id
;
1229 int ret
, page_shift
;
1232 ret
= ctrl
->ops
->reg_read32(ctrl
, NVME_REG_VS
, &ctrl
->vs
);
1234 dev_err(ctrl
->device
, "Reading VS failed (%d)\n", ret
);
1238 ret
= ctrl
->ops
->reg_read64(ctrl
, NVME_REG_CAP
, &cap
);
1240 dev_err(ctrl
->device
, "Reading CAP failed (%d)\n", ret
);
1243 page_shift
= NVME_CAP_MPSMIN(cap
) + 12;
1245 if (ctrl
->vs
>= NVME_VS(1, 1))
1246 ctrl
->subsystem
= NVME_CAP_NSSRC(cap
);
1248 ret
= nvme_identify_ctrl(ctrl
, &id
);
1250 dev_err(ctrl
->device
, "Identify Controller failed (%d)\n", ret
);
1254 ctrl
->vid
= le16_to_cpu(id
->vid
);
1255 ctrl
->oncs
= le16_to_cpup(&id
->oncs
);
1256 atomic_set(&ctrl
->abort_limit
, id
->acl
+ 1);
1257 ctrl
->vwc
= id
->vwc
;
1258 ctrl
->cntlid
= le16_to_cpup(&id
->cntlid
);
1259 memcpy(ctrl
->serial
, id
->sn
, sizeof(id
->sn
));
1260 memcpy(ctrl
->model
, id
->mn
, sizeof(id
->mn
));
1261 memcpy(ctrl
->firmware_rev
, id
->fr
, sizeof(id
->fr
));
1263 max_hw_sectors
= 1 << (id
->mdts
+ page_shift
- 9);
1265 max_hw_sectors
= UINT_MAX
;
1266 ctrl
->max_hw_sectors
=
1267 min_not_zero(ctrl
->max_hw_sectors
, max_hw_sectors
);
1269 if ((ctrl
->quirks
& NVME_QUIRK_STRIPE_SIZE
) && id
->vs
[3]) {
1270 unsigned int max_hw_sectors
;
1272 ctrl
->stripe_size
= 1 << (id
->vs
[3] + page_shift
);
1273 max_hw_sectors
= ctrl
->stripe_size
>> (page_shift
- 9);
1274 if (ctrl
->max_hw_sectors
) {
1275 ctrl
->max_hw_sectors
= min(max_hw_sectors
,
1276 ctrl
->max_hw_sectors
);
1278 ctrl
->max_hw_sectors
= max_hw_sectors
;
1282 nvme_set_queue_limits(ctrl
, ctrl
->admin_q
);
1283 ctrl
->sgls
= le32_to_cpu(id
->sgls
);
1284 ctrl
->kas
= le16_to_cpu(id
->kas
);
1286 if (ctrl
->ops
->is_fabrics
) {
1287 ctrl
->icdoff
= le16_to_cpu(id
->icdoff
);
1288 ctrl
->ioccsz
= le32_to_cpu(id
->ioccsz
);
1289 ctrl
->iorcsz
= le32_to_cpu(id
->iorcsz
);
1290 ctrl
->maxcmd
= le16_to_cpu(id
->maxcmd
);
1293 * In fabrics we need to verify the cntlid matches the
1296 if (ctrl
->cntlid
!= le16_to_cpu(id
->cntlid
))
1299 if (!ctrl
->opts
->discovery_nqn
&& !ctrl
->kas
) {
1301 "keep-alive support is mandatory for fabrics\n");
1305 ctrl
->cntlid
= le16_to_cpu(id
->cntlid
);
1311 EXPORT_SYMBOL_GPL(nvme_init_identify
);
1313 static int nvme_dev_open(struct inode
*inode
, struct file
*file
)
1315 struct nvme_ctrl
*ctrl
;
1316 int instance
= iminor(inode
);
1319 spin_lock(&dev_list_lock
);
1320 list_for_each_entry(ctrl
, &nvme_ctrl_list
, node
) {
1321 if (ctrl
->instance
!= instance
)
1324 if (!ctrl
->admin_q
) {
1328 if (!kref_get_unless_zero(&ctrl
->kref
))
1330 file
->private_data
= ctrl
;
1334 spin_unlock(&dev_list_lock
);
1339 static int nvme_dev_release(struct inode
*inode
, struct file
*file
)
1341 nvme_put_ctrl(file
->private_data
);
1345 static int nvme_dev_user_cmd(struct nvme_ctrl
*ctrl
, void __user
*argp
)
1350 mutex_lock(&ctrl
->namespaces_mutex
);
1351 if (list_empty(&ctrl
->namespaces
)) {
1356 ns
= list_first_entry(&ctrl
->namespaces
, struct nvme_ns
, list
);
1357 if (ns
!= list_last_entry(&ctrl
->namespaces
, struct nvme_ns
, list
)) {
1358 dev_warn(ctrl
->device
,
1359 "NVME_IOCTL_IO_CMD not supported when multiple namespaces present!\n");
1364 dev_warn(ctrl
->device
,
1365 "using deprecated NVME_IOCTL_IO_CMD ioctl on the char device!\n");
1366 kref_get(&ns
->kref
);
1367 mutex_unlock(&ctrl
->namespaces_mutex
);
1369 ret
= nvme_user_cmd(ctrl
, ns
, argp
);
1374 mutex_unlock(&ctrl
->namespaces_mutex
);
1378 static long nvme_dev_ioctl(struct file
*file
, unsigned int cmd
,
1381 struct nvme_ctrl
*ctrl
= file
->private_data
;
1382 void __user
*argp
= (void __user
*)arg
;
1385 case NVME_IOCTL_ADMIN_CMD
:
1386 return nvme_user_cmd(ctrl
, NULL
, argp
);
1387 case NVME_IOCTL_IO_CMD
:
1388 return nvme_dev_user_cmd(ctrl
, argp
);
1389 case NVME_IOCTL_RESET
:
1390 dev_warn(ctrl
->device
, "resetting controller\n");
1391 return ctrl
->ops
->reset_ctrl(ctrl
);
1392 case NVME_IOCTL_SUBSYS_RESET
:
1393 return nvme_reset_subsystem(ctrl
);
1394 case NVME_IOCTL_RESCAN
:
1395 nvme_queue_scan(ctrl
);
1402 static const struct file_operations nvme_dev_fops
= {
1403 .owner
= THIS_MODULE
,
1404 .open
= nvme_dev_open
,
1405 .release
= nvme_dev_release
,
1406 .unlocked_ioctl
= nvme_dev_ioctl
,
1407 .compat_ioctl
= nvme_dev_ioctl
,
1410 static ssize_t
nvme_sysfs_reset(struct device
*dev
,
1411 struct device_attribute
*attr
, const char *buf
,
1414 struct nvme_ctrl
*ctrl
= dev_get_drvdata(dev
);
1417 ret
= ctrl
->ops
->reset_ctrl(ctrl
);
1422 static DEVICE_ATTR(reset_controller
, S_IWUSR
, NULL
, nvme_sysfs_reset
);
1424 static ssize_t
nvme_sysfs_rescan(struct device
*dev
,
1425 struct device_attribute
*attr
, const char *buf
,
1428 struct nvme_ctrl
*ctrl
= dev_get_drvdata(dev
);
1430 nvme_queue_scan(ctrl
);
1433 static DEVICE_ATTR(rescan_controller
, S_IWUSR
, NULL
, nvme_sysfs_rescan
);
1435 static ssize_t
wwid_show(struct device
*dev
, struct device_attribute
*attr
,
1438 struct nvme_ns
*ns
= nvme_get_ns_from_dev(dev
);
1439 struct nvme_ctrl
*ctrl
= ns
->ctrl
;
1440 int serial_len
= sizeof(ctrl
->serial
);
1441 int model_len
= sizeof(ctrl
->model
);
1443 if (memchr_inv(ns
->uuid
, 0, sizeof(ns
->uuid
)))
1444 return sprintf(buf
, "eui.%16phN\n", ns
->uuid
);
1446 if (memchr_inv(ns
->eui
, 0, sizeof(ns
->eui
)))
1447 return sprintf(buf
, "eui.%8phN\n", ns
->eui
);
1449 while (ctrl
->serial
[serial_len
- 1] == ' ')
1451 while (ctrl
->model
[model_len
- 1] == ' ')
1454 return sprintf(buf
, "nvme.%04x-%*phN-%*phN-%08x\n", ctrl
->vid
,
1455 serial_len
, ctrl
->serial
, model_len
, ctrl
->model
, ns
->ns_id
);
1457 static DEVICE_ATTR(wwid
, S_IRUGO
, wwid_show
, NULL
);
1459 static ssize_t
uuid_show(struct device
*dev
, struct device_attribute
*attr
,
1462 struct nvme_ns
*ns
= nvme_get_ns_from_dev(dev
);
1463 return sprintf(buf
, "%pU\n", ns
->uuid
);
1465 static DEVICE_ATTR(uuid
, S_IRUGO
, uuid_show
, NULL
);
1467 static ssize_t
eui_show(struct device
*dev
, struct device_attribute
*attr
,
1470 struct nvme_ns
*ns
= nvme_get_ns_from_dev(dev
);
1471 return sprintf(buf
, "%8phd\n", ns
->eui
);
1473 static DEVICE_ATTR(eui
, S_IRUGO
, eui_show
, NULL
);
1475 static ssize_t
nsid_show(struct device
*dev
, struct device_attribute
*attr
,
1478 struct nvme_ns
*ns
= nvme_get_ns_from_dev(dev
);
1479 return sprintf(buf
, "%d\n", ns
->ns_id
);
1481 static DEVICE_ATTR(nsid
, S_IRUGO
, nsid_show
, NULL
);
1483 static struct attribute
*nvme_ns_attrs
[] = {
1484 &dev_attr_wwid
.attr
,
1485 &dev_attr_uuid
.attr
,
1487 &dev_attr_nsid
.attr
,
1491 static umode_t
nvme_ns_attrs_are_visible(struct kobject
*kobj
,
1492 struct attribute
*a
, int n
)
1494 struct device
*dev
= container_of(kobj
, struct device
, kobj
);
1495 struct nvme_ns
*ns
= nvme_get_ns_from_dev(dev
);
1497 if (a
== &dev_attr_uuid
.attr
) {
1498 if (!memchr_inv(ns
->uuid
, 0, sizeof(ns
->uuid
)))
1501 if (a
== &dev_attr_eui
.attr
) {
1502 if (!memchr_inv(ns
->eui
, 0, sizeof(ns
->eui
)))
1508 static const struct attribute_group nvme_ns_attr_group
= {
1509 .attrs
= nvme_ns_attrs
,
1510 .is_visible
= nvme_ns_attrs_are_visible
,
1513 #define nvme_show_str_function(field) \
1514 static ssize_t field##_show(struct device *dev, \
1515 struct device_attribute *attr, char *buf) \
1517 struct nvme_ctrl *ctrl = dev_get_drvdata(dev); \
1518 return sprintf(buf, "%.*s\n", (int)sizeof(ctrl->field), ctrl->field); \
1520 static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL);
1522 #define nvme_show_int_function(field) \
1523 static ssize_t field##_show(struct device *dev, \
1524 struct device_attribute *attr, char *buf) \
1526 struct nvme_ctrl *ctrl = dev_get_drvdata(dev); \
1527 return sprintf(buf, "%d\n", ctrl->field); \
1529 static DEVICE_ATTR(field, S_IRUGO, field##_show, NULL);
1531 nvme_show_str_function(model
);
1532 nvme_show_str_function(serial
);
1533 nvme_show_str_function(firmware_rev
);
1534 nvme_show_int_function(cntlid
);
1536 static ssize_t
nvme_sysfs_delete(struct device
*dev
,
1537 struct device_attribute
*attr
, const char *buf
,
1540 struct nvme_ctrl
*ctrl
= dev_get_drvdata(dev
);
1542 if (device_remove_file_self(dev
, attr
))
1543 ctrl
->ops
->delete_ctrl(ctrl
);
1546 static DEVICE_ATTR(delete_controller
, S_IWUSR
, NULL
, nvme_sysfs_delete
);
1548 static ssize_t
nvme_sysfs_show_transport(struct device
*dev
,
1549 struct device_attribute
*attr
,
1552 struct nvme_ctrl
*ctrl
= dev_get_drvdata(dev
);
1554 return snprintf(buf
, PAGE_SIZE
, "%s\n", ctrl
->ops
->name
);
1556 static DEVICE_ATTR(transport
, S_IRUGO
, nvme_sysfs_show_transport
, NULL
);
1558 static ssize_t
nvme_sysfs_show_subsysnqn(struct device
*dev
,
1559 struct device_attribute
*attr
,
1562 struct nvme_ctrl
*ctrl
= dev_get_drvdata(dev
);
1564 return snprintf(buf
, PAGE_SIZE
, "%s\n",
1565 ctrl
->ops
->get_subsysnqn(ctrl
));
1567 static DEVICE_ATTR(subsysnqn
, S_IRUGO
, nvme_sysfs_show_subsysnqn
, NULL
);
1569 static ssize_t
nvme_sysfs_show_address(struct device
*dev
,
1570 struct device_attribute
*attr
,
1573 struct nvme_ctrl
*ctrl
= dev_get_drvdata(dev
);
1575 return ctrl
->ops
->get_address(ctrl
, buf
, PAGE_SIZE
);
1577 static DEVICE_ATTR(address
, S_IRUGO
, nvme_sysfs_show_address
, NULL
);
1579 static struct attribute
*nvme_dev_attrs
[] = {
1580 &dev_attr_reset_controller
.attr
,
1581 &dev_attr_rescan_controller
.attr
,
1582 &dev_attr_model
.attr
,
1583 &dev_attr_serial
.attr
,
1584 &dev_attr_firmware_rev
.attr
,
1585 &dev_attr_cntlid
.attr
,
1586 &dev_attr_delete_controller
.attr
,
1587 &dev_attr_transport
.attr
,
1588 &dev_attr_subsysnqn
.attr
,
1589 &dev_attr_address
.attr
,
1593 #define CHECK_ATTR(ctrl, a, name) \
1594 if ((a) == &dev_attr_##name.attr && \
1595 !(ctrl)->ops->get_##name) \
1598 static umode_t
nvme_dev_attrs_are_visible(struct kobject
*kobj
,
1599 struct attribute
*a
, int n
)
1601 struct device
*dev
= container_of(kobj
, struct device
, kobj
);
1602 struct nvme_ctrl
*ctrl
= dev_get_drvdata(dev
);
1604 if (a
== &dev_attr_delete_controller
.attr
) {
1605 if (!ctrl
->ops
->delete_ctrl
)
1609 CHECK_ATTR(ctrl
, a
, subsysnqn
);
1610 CHECK_ATTR(ctrl
, a
, address
);
1615 static struct attribute_group nvme_dev_attrs_group
= {
1616 .attrs
= nvme_dev_attrs
,
1617 .is_visible
= nvme_dev_attrs_are_visible
,
1620 static const struct attribute_group
*nvme_dev_attr_groups
[] = {
1621 &nvme_dev_attrs_group
,
1625 static int ns_cmp(void *priv
, struct list_head
*a
, struct list_head
*b
)
1627 struct nvme_ns
*nsa
= container_of(a
, struct nvme_ns
, list
);
1628 struct nvme_ns
*nsb
= container_of(b
, struct nvme_ns
, list
);
1630 return nsa
->ns_id
- nsb
->ns_id
;
1633 static struct nvme_ns
*nvme_find_get_ns(struct nvme_ctrl
*ctrl
, unsigned nsid
)
1635 struct nvme_ns
*ns
, *ret
= NULL
;
1637 mutex_lock(&ctrl
->namespaces_mutex
);
1638 list_for_each_entry(ns
, &ctrl
->namespaces
, list
) {
1639 if (ns
->ns_id
== nsid
) {
1640 kref_get(&ns
->kref
);
1644 if (ns
->ns_id
> nsid
)
1647 mutex_unlock(&ctrl
->namespaces_mutex
);
1651 static void nvme_alloc_ns(struct nvme_ctrl
*ctrl
, unsigned nsid
)
1654 struct gendisk
*disk
;
1655 struct nvme_id_ns
*id
;
1656 char disk_name
[DISK_NAME_LEN
];
1657 int node
= dev_to_node(ctrl
->dev
);
1659 ns
= kzalloc_node(sizeof(*ns
), GFP_KERNEL
, node
);
1663 ns
->instance
= ida_simple_get(&ctrl
->ns_ida
, 1, 0, GFP_KERNEL
);
1664 if (ns
->instance
< 0)
1667 ns
->queue
= blk_mq_init_queue(ctrl
->tagset
);
1668 if (IS_ERR(ns
->queue
))
1669 goto out_release_instance
;
1670 queue_flag_set_unlocked(QUEUE_FLAG_NONROT
, ns
->queue
);
1671 ns
->queue
->queuedata
= ns
;
1674 kref_init(&ns
->kref
);
1676 ns
->lba_shift
= 9; /* set to a default value for 512 until disk is validated */
1678 blk_queue_logical_block_size(ns
->queue
, 1 << ns
->lba_shift
);
1679 nvme_set_queue_limits(ctrl
, ns
->queue
);
1681 sprintf(disk_name
, "nvme%dn%d", ctrl
->instance
, ns
->instance
);
1683 if (nvme_revalidate_ns(ns
, &id
))
1684 goto out_free_queue
;
1686 if (nvme_nvm_ns_supported(ns
, id
)) {
1687 if (nvme_nvm_register(ns
, disk_name
, node
,
1688 &nvme_ns_attr_group
)) {
1689 dev_warn(ctrl
->dev
, "%s: LightNVM init failure\n",
1694 disk
= alloc_disk_node(0, node
);
1698 disk
->fops
= &nvme_fops
;
1699 disk
->private_data
= ns
;
1700 disk
->queue
= ns
->queue
;
1701 disk
->flags
= GENHD_FL_EXT_DEVT
;
1702 memcpy(disk
->disk_name
, disk_name
, DISK_NAME_LEN
);
1705 __nvme_revalidate_disk(disk
, id
);
1708 mutex_lock(&ctrl
->namespaces_mutex
);
1709 list_add_tail(&ns
->list
, &ctrl
->namespaces
);
1710 mutex_unlock(&ctrl
->namespaces_mutex
);
1712 kref_get(&ctrl
->kref
);
1719 device_add_disk(ctrl
->device
, ns
->disk
);
1720 if (sysfs_create_group(&disk_to_dev(ns
->disk
)->kobj
,
1721 &nvme_ns_attr_group
))
1722 pr_warn("%s: failed to create sysfs group for identification\n",
1723 ns
->disk
->disk_name
);
1728 blk_cleanup_queue(ns
->queue
);
1729 out_release_instance
:
1730 ida_simple_remove(&ctrl
->ns_ida
, ns
->instance
);
1735 static void nvme_ns_remove(struct nvme_ns
*ns
)
1737 if (test_and_set_bit(NVME_NS_REMOVING
, &ns
->flags
))
1740 if (ns
->disk
&& ns
->disk
->flags
& GENHD_FL_UP
) {
1741 if (blk_get_integrity(ns
->disk
))
1742 blk_integrity_unregister(ns
->disk
);
1743 sysfs_remove_group(&disk_to_dev(ns
->disk
)->kobj
,
1744 &nvme_ns_attr_group
);
1745 del_gendisk(ns
->disk
);
1746 blk_mq_abort_requeue_list(ns
->queue
);
1747 blk_cleanup_queue(ns
->queue
);
1750 mutex_lock(&ns
->ctrl
->namespaces_mutex
);
1751 list_del_init(&ns
->list
);
1752 mutex_unlock(&ns
->ctrl
->namespaces_mutex
);
1757 static void nvme_validate_ns(struct nvme_ctrl
*ctrl
, unsigned nsid
)
1761 ns
= nvme_find_get_ns(ctrl
, nsid
);
1763 if (ns
->disk
&& revalidate_disk(ns
->disk
))
1767 nvme_alloc_ns(ctrl
, nsid
);
1770 static void nvme_remove_invalid_namespaces(struct nvme_ctrl
*ctrl
,
1773 struct nvme_ns
*ns
, *next
;
1775 list_for_each_entry_safe(ns
, next
, &ctrl
->namespaces
, list
) {
1776 if (ns
->ns_id
> nsid
)
1781 static int nvme_scan_ns_list(struct nvme_ctrl
*ctrl
, unsigned nn
)
1785 unsigned i
, j
, nsid
, prev
= 0, num_lists
= DIV_ROUND_UP(nn
, 1024);
1788 ns_list
= kzalloc(0x1000, GFP_KERNEL
);
1792 for (i
= 0; i
< num_lists
; i
++) {
1793 ret
= nvme_identify_ns_list(ctrl
, prev
, ns_list
);
1797 for (j
= 0; j
< min(nn
, 1024U); j
++) {
1798 nsid
= le32_to_cpu(ns_list
[j
]);
1802 nvme_validate_ns(ctrl
, nsid
);
1804 while (++prev
< nsid
) {
1805 ns
= nvme_find_get_ns(ctrl
, prev
);
1815 nvme_remove_invalid_namespaces(ctrl
, prev
);
1821 static void nvme_scan_ns_sequential(struct nvme_ctrl
*ctrl
, unsigned nn
)
1825 for (i
= 1; i
<= nn
; i
++)
1826 nvme_validate_ns(ctrl
, i
);
1828 nvme_remove_invalid_namespaces(ctrl
, nn
);
1831 static void nvme_scan_work(struct work_struct
*work
)
1833 struct nvme_ctrl
*ctrl
=
1834 container_of(work
, struct nvme_ctrl
, scan_work
);
1835 struct nvme_id_ctrl
*id
;
1838 if (ctrl
->state
!= NVME_CTRL_LIVE
)
1841 if (nvme_identify_ctrl(ctrl
, &id
))
1844 nn
= le32_to_cpu(id
->nn
);
1845 if (ctrl
->vs
>= NVME_VS(1, 1) &&
1846 !(ctrl
->quirks
& NVME_QUIRK_IDENTIFY_CNS
)) {
1847 if (!nvme_scan_ns_list(ctrl
, nn
))
1850 nvme_scan_ns_sequential(ctrl
, nn
);
1852 mutex_lock(&ctrl
->namespaces_mutex
);
1853 list_sort(NULL
, &ctrl
->namespaces
, ns_cmp
);
1854 mutex_unlock(&ctrl
->namespaces_mutex
);
1857 if (ctrl
->ops
->post_scan
)
1858 ctrl
->ops
->post_scan(ctrl
);
1861 void nvme_queue_scan(struct nvme_ctrl
*ctrl
)
1864 * Do not queue new scan work when a controller is reset during
1867 if (ctrl
->state
== NVME_CTRL_LIVE
)
1868 schedule_work(&ctrl
->scan_work
);
1870 EXPORT_SYMBOL_GPL(nvme_queue_scan
);
1873 * This function iterates the namespace list unlocked to allow recovery from
1874 * controller failure. It is up to the caller to ensure the namespace list is
1875 * not modified by scan work while this function is executing.
1877 void nvme_remove_namespaces(struct nvme_ctrl
*ctrl
)
1879 struct nvme_ns
*ns
, *next
;
1882 * The dead states indicates the controller was not gracefully
1883 * disconnected. In that case, we won't be able to flush any data while
1884 * removing the namespaces' disks; fail all the queues now to avoid
1885 * potentially having to clean up the failed sync later.
1887 if (ctrl
->state
== NVME_CTRL_DEAD
)
1888 nvme_kill_queues(ctrl
);
1890 list_for_each_entry_safe(ns
, next
, &ctrl
->namespaces
, list
)
1893 EXPORT_SYMBOL_GPL(nvme_remove_namespaces
);
1895 static void nvme_async_event_work(struct work_struct
*work
)
1897 struct nvme_ctrl
*ctrl
=
1898 container_of(work
, struct nvme_ctrl
, async_event_work
);
1900 spin_lock_irq(&ctrl
->lock
);
1901 while (ctrl
->event_limit
> 0) {
1902 int aer_idx
= --ctrl
->event_limit
;
1904 spin_unlock_irq(&ctrl
->lock
);
1905 ctrl
->ops
->submit_async_event(ctrl
, aer_idx
);
1906 spin_lock_irq(&ctrl
->lock
);
1908 spin_unlock_irq(&ctrl
->lock
);
1911 void nvme_complete_async_event(struct nvme_ctrl
*ctrl
,
1912 struct nvme_completion
*cqe
)
1914 u16 status
= le16_to_cpu(cqe
->status
) >> 1;
1915 u32 result
= le32_to_cpu(cqe
->result
);
1917 if (status
== NVME_SC_SUCCESS
|| status
== NVME_SC_ABORT_REQ
) {
1918 ++ctrl
->event_limit
;
1919 schedule_work(&ctrl
->async_event_work
);
1922 if (status
!= NVME_SC_SUCCESS
)
1925 switch (result
& 0xff07) {
1926 case NVME_AER_NOTICE_NS_CHANGED
:
1927 dev_info(ctrl
->device
, "rescanning\n");
1928 nvme_queue_scan(ctrl
);
1931 dev_warn(ctrl
->device
, "async event result %08x\n", result
);
1934 EXPORT_SYMBOL_GPL(nvme_complete_async_event
);
1936 void nvme_queue_async_events(struct nvme_ctrl
*ctrl
)
1938 ctrl
->event_limit
= NVME_NR_AERS
;
1939 schedule_work(&ctrl
->async_event_work
);
1941 EXPORT_SYMBOL_GPL(nvme_queue_async_events
);
1943 static DEFINE_IDA(nvme_instance_ida
);
1945 static int nvme_set_instance(struct nvme_ctrl
*ctrl
)
1947 int instance
, error
;
1950 if (!ida_pre_get(&nvme_instance_ida
, GFP_KERNEL
))
1953 spin_lock(&dev_list_lock
);
1954 error
= ida_get_new(&nvme_instance_ida
, &instance
);
1955 spin_unlock(&dev_list_lock
);
1956 } while (error
== -EAGAIN
);
1961 ctrl
->instance
= instance
;
1965 static void nvme_release_instance(struct nvme_ctrl
*ctrl
)
1967 spin_lock(&dev_list_lock
);
1968 ida_remove(&nvme_instance_ida
, ctrl
->instance
);
1969 spin_unlock(&dev_list_lock
);
1972 void nvme_uninit_ctrl(struct nvme_ctrl
*ctrl
)
1974 flush_work(&ctrl
->async_event_work
);
1975 flush_work(&ctrl
->scan_work
);
1976 nvme_remove_namespaces(ctrl
);
1978 device_destroy(nvme_class
, MKDEV(nvme_char_major
, ctrl
->instance
));
1980 spin_lock(&dev_list_lock
);
1981 list_del(&ctrl
->node
);
1982 spin_unlock(&dev_list_lock
);
1984 EXPORT_SYMBOL_GPL(nvme_uninit_ctrl
);
1986 static void nvme_free_ctrl(struct kref
*kref
)
1988 struct nvme_ctrl
*ctrl
= container_of(kref
, struct nvme_ctrl
, kref
);
1990 put_device(ctrl
->device
);
1991 nvme_release_instance(ctrl
);
1992 ida_destroy(&ctrl
->ns_ida
);
1994 ctrl
->ops
->free_ctrl(ctrl
);
1997 void nvme_put_ctrl(struct nvme_ctrl
*ctrl
)
1999 kref_put(&ctrl
->kref
, nvme_free_ctrl
);
2001 EXPORT_SYMBOL_GPL(nvme_put_ctrl
);
2004 * Initialize a NVMe controller structures. This needs to be called during
2005 * earliest initialization so that we have the initialized structured around
2008 int nvme_init_ctrl(struct nvme_ctrl
*ctrl
, struct device
*dev
,
2009 const struct nvme_ctrl_ops
*ops
, unsigned long quirks
)
2013 ctrl
->state
= NVME_CTRL_NEW
;
2014 spin_lock_init(&ctrl
->lock
);
2015 INIT_LIST_HEAD(&ctrl
->namespaces
);
2016 mutex_init(&ctrl
->namespaces_mutex
);
2017 kref_init(&ctrl
->kref
);
2020 ctrl
->quirks
= quirks
;
2021 INIT_WORK(&ctrl
->scan_work
, nvme_scan_work
);
2022 INIT_WORK(&ctrl
->async_event_work
, nvme_async_event_work
);
2024 ret
= nvme_set_instance(ctrl
);
2028 ctrl
->device
= device_create_with_groups(nvme_class
, ctrl
->dev
,
2029 MKDEV(nvme_char_major
, ctrl
->instance
),
2030 ctrl
, nvme_dev_attr_groups
,
2031 "nvme%d", ctrl
->instance
);
2032 if (IS_ERR(ctrl
->device
)) {
2033 ret
= PTR_ERR(ctrl
->device
);
2034 goto out_release_instance
;
2036 get_device(ctrl
->device
);
2037 ida_init(&ctrl
->ns_ida
);
2039 spin_lock(&dev_list_lock
);
2040 list_add_tail(&ctrl
->node
, &nvme_ctrl_list
);
2041 spin_unlock(&dev_list_lock
);
2044 out_release_instance
:
2045 nvme_release_instance(ctrl
);
2049 EXPORT_SYMBOL_GPL(nvme_init_ctrl
);
2052 * nvme_kill_queues(): Ends all namespace queues
2053 * @ctrl: the dead controller that needs to end
2055 * Call this function when the driver determines it is unable to get the
2056 * controller in a state capable of servicing IO.
2058 void nvme_kill_queues(struct nvme_ctrl
*ctrl
)
2062 mutex_lock(&ctrl
->namespaces_mutex
);
2063 list_for_each_entry(ns
, &ctrl
->namespaces
, list
) {
2065 * Revalidating a dead namespace sets capacity to 0. This will
2066 * end buffered writers dirtying pages that can't be synced.
2068 if (ns
->disk
&& !test_and_set_bit(NVME_NS_DEAD
, &ns
->flags
))
2069 revalidate_disk(ns
->disk
);
2071 blk_set_queue_dying(ns
->queue
);
2072 blk_mq_abort_requeue_list(ns
->queue
);
2073 blk_mq_start_stopped_hw_queues(ns
->queue
, true);
2075 mutex_unlock(&ctrl
->namespaces_mutex
);
2077 EXPORT_SYMBOL_GPL(nvme_kill_queues
);
2079 void nvme_stop_queues(struct nvme_ctrl
*ctrl
)
2083 mutex_lock(&ctrl
->namespaces_mutex
);
2084 list_for_each_entry(ns
, &ctrl
->namespaces
, list
) {
2085 spin_lock_irq(ns
->queue
->queue_lock
);
2086 queue_flag_set(QUEUE_FLAG_STOPPED
, ns
->queue
);
2087 spin_unlock_irq(ns
->queue
->queue_lock
);
2089 blk_mq_cancel_requeue_work(ns
->queue
);
2090 blk_mq_stop_hw_queues(ns
->queue
);
2092 mutex_unlock(&ctrl
->namespaces_mutex
);
2094 EXPORT_SYMBOL_GPL(nvme_stop_queues
);
2096 void nvme_start_queues(struct nvme_ctrl
*ctrl
)
2100 mutex_lock(&ctrl
->namespaces_mutex
);
2101 list_for_each_entry(ns
, &ctrl
->namespaces
, list
) {
2102 queue_flag_clear_unlocked(QUEUE_FLAG_STOPPED
, ns
->queue
);
2103 blk_mq_start_stopped_hw_queues(ns
->queue
, true);
2104 blk_mq_kick_requeue_list(ns
->queue
);
2106 mutex_unlock(&ctrl
->namespaces_mutex
);
2108 EXPORT_SYMBOL_GPL(nvme_start_queues
);
2110 int __init
nvme_core_init(void)
2114 result
= __register_chrdev(nvme_char_major
, 0, NVME_MINORS
, "nvme",
2118 else if (result
> 0)
2119 nvme_char_major
= result
;
2121 nvme_class
= class_create(THIS_MODULE
, "nvme");
2122 if (IS_ERR(nvme_class
)) {
2123 result
= PTR_ERR(nvme_class
);
2124 goto unregister_chrdev
;
2130 __unregister_chrdev(nvme_char_major
, 0, NVME_MINORS
, "nvme");
2134 void nvme_core_exit(void)
2136 class_destroy(nvme_class
);
2137 __unregister_chrdev(nvme_char_major
, 0, NVME_MINORS
, "nvme");
2140 MODULE_LICENSE("GPL");
2141 MODULE_VERSION("1.0");
2142 module_init(nvme_core_init
);
2143 module_exit(nvme_core_exit
);