1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Copyright (c) 2011-2014, Intel Corporation.
9 #include <linux/nvme.h>
10 #include <linux/cdev.h>
11 #include <linux/pci.h>
12 #include <linux/kref.h>
13 #include <linux/blk-mq.h>
14 #include <linux/lightnvm.h>
15 #include <linux/sed-opal.h>
16 #include <linux/fault-inject.h>
17 #include <linux/rcupdate.h>
19 #include <trace/events/block.h>
21 extern unsigned int nvme_io_timeout;
22 #define NVME_IO_TIMEOUT (nvme_io_timeout * HZ)
24 extern unsigned int admin_timeout;
25 #define ADMIN_TIMEOUT (admin_timeout * HZ)
27 #define NVME_DEFAULT_KATO 5
28 #define NVME_KATO_GRACE 10
30 extern struct workqueue_struct *nvme_wq;
31 extern struct workqueue_struct *nvme_reset_wq;
32 extern struct workqueue_struct *nvme_delete_wq;
40 * List of workarounds for devices that required behavior not specified in
45 * Prefers I/O aligned to a stripe size specified in a vendor
46 * specific Identify field.
48 NVME_QUIRK_STRIPE_SIZE = (1 << 0),
51 * The controller doesn't handle Identify value others than 0 or 1
54 NVME_QUIRK_IDENTIFY_CNS = (1 << 1),
57 * The controller deterministically returns O's on reads to
58 * logical blocks that deallocate was called on.
60 NVME_QUIRK_DEALLOCATE_ZEROES = (1 << 2),
63 * The controller needs a delay before starts checking the device
64 * readiness, which is done by reading the NVME_CSTS_RDY bit.
66 NVME_QUIRK_DELAY_BEFORE_CHK_RDY = (1 << 3),
69 * APST should not be used.
71 NVME_QUIRK_NO_APST = (1 << 4),
74 * The deepest sleep state should not be used.
76 NVME_QUIRK_NO_DEEPEST_PS = (1 << 5),
79 * Supports the LighNVM command set if indicated in vs[1].
81 NVME_QUIRK_LIGHTNVM = (1 << 6),
84 * Set MEDIUM priority on SQ creation
86 NVME_QUIRK_MEDIUM_PRIO_SQ = (1 << 7),
89 * Ignore device provided subnqn.
91 NVME_QUIRK_IGNORE_DEV_SUBNQN = (1 << 8),
94 * Broken Write Zeroes.
96 NVME_QUIRK_DISABLE_WRITE_ZEROES = (1 << 9),
99 * Force simple suspend/resume path.
101 NVME_QUIRK_SIMPLE_SUSPEND = (1 << 10),
104 * Use only one interrupt vector for all queues
106 NVME_QUIRK_SINGLE_VECTOR = (1 << 11),
109 * Use non-standard 128 bytes SQEs.
111 NVME_QUIRK_128_BYTES_SQES = (1 << 12),
114 * Prevent tag overlap between queues
116 NVME_QUIRK_SHARED_TAGS = (1 << 13),
120 * Common request structure for NVMe passthrough. All drivers must have
121 * this structure as the first member of their request-private data.
123 struct nvme_request {
124 struct nvme_command *cmd;
125 union nvme_result result;
129 struct nvme_ctrl *ctrl;
133 * Mark a bio as coming in through the mpath node.
135 #define REQ_NVME_MPATH REQ_DRV
138 NVME_REQ_CANCELLED = (1 << 0),
139 NVME_REQ_USERCMD = (1 << 1),
142 static inline struct nvme_request *nvme_req(struct request *req)
144 return blk_mq_rq_to_pdu(req);
147 static inline u16 nvme_req_qid(struct request *req)
151 return blk_mq_unique_tag_to_hwq(blk_mq_unique_tag(req)) + 1;
154 /* The below value is the specific amount of delay needed before checking
155 * readiness in case of the PCI_DEVICE(0x1c58, 0x0003), which needs the
156 * NVME_QUIRK_DELAY_BEFORE_CHK_RDY quirk enabled. The value (in ms) was
159 #define NVME_QUIRK_DELAY_AMOUNT 2300
161 enum nvme_ctrl_state {
165 NVME_CTRL_CONNECTING,
170 struct nvme_fault_inject {
171 #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS
172 struct fault_attr attr;
173 struct dentry *parent;
174 bool dont_retry; /* DNR, do not retry */
175 u16 status; /* status code */
181 enum nvme_ctrl_state state;
184 struct mutex scan_lock;
185 const struct nvme_ctrl_ops *ops;
186 struct request_queue *admin_q;
187 struct request_queue *connect_q;
188 struct request_queue *fabrics_q;
192 struct blk_mq_tag_set *tagset;
193 struct blk_mq_tag_set *admin_tagset;
194 struct list_head namespaces;
195 struct rw_semaphore namespaces_rwsem;
196 struct device ctrl_device;
197 struct device *device; /* char device */
199 struct work_struct reset_work;
200 struct work_struct delete_work;
202 struct nvme_subsystem *subsys;
203 struct list_head subsys_entry;
205 struct opal_dev *opal_dev;
225 atomic_t abort_limit;
235 unsigned int shutdown_timeout;
238 unsigned long quirks;
239 struct nvme_id_power_state psd[32];
240 struct nvme_effects_log *effects;
241 struct work_struct scan_work;
242 struct work_struct async_event_work;
243 struct delayed_work ka_work;
244 struct nvme_command ka_cmd;
245 struct work_struct fw_act_work;
246 unsigned long events;
248 #ifdef CONFIG_NVME_MULTIPATH
249 /* asymmetric namespace access: */
254 struct mutex ana_lock;
255 struct nvme_ana_rsp_hdr *ana_log_buf;
257 struct timer_list anatt_timer;
258 struct work_struct ana_work;
261 /* Power saving configuration */
262 u64 ps_max_latency_us;
277 struct nvmf_ctrl_options *opts;
279 struct page *discard_page;
280 unsigned long discard_page_busy;
282 struct nvme_fault_inject fault_inject;
290 struct nvme_subsystem {
294 * Because we unregister the device on the last put we need
295 * a separate refcount.
298 struct list_head entry;
300 struct list_head ctrls;
301 struct list_head nsheads;
302 char subnqn[NVMF_NQN_SIZE];
305 char firmware_rev[8];
308 u16 awupf; /* 0's based awupf value. */
310 #ifdef CONFIG_NVME_MULTIPATH
311 enum nvme_iopolicy iopolicy;
316 * Container structure for uniqueue namespace identifiers.
325 * Anchor structure for namespaces. There is one for each namespace in a
326 * NVMe subsystem that any of our controllers can see, and the namespace
327 * structure for each controller is chained of it. For private namespaces
328 * there is a 1:1 relation to our namespace structures, that is ->list
329 * only ever has a single entry for private namespaces.
331 struct nvme_ns_head {
332 struct list_head list;
333 struct srcu_struct srcu;
334 struct nvme_subsystem *subsys;
336 struct nvme_ns_ids ids;
337 struct list_head entry;
340 #ifdef CONFIG_NVME_MULTIPATH
341 struct gendisk *disk;
342 struct bio_list requeue_list;
343 spinlock_t requeue_lock;
344 struct work_struct requeue_work;
346 struct nvme_ns __rcu *current_path[];
351 struct list_head list;
353 struct nvme_ctrl *ctrl;
354 struct request_queue *queue;
355 struct gendisk *disk;
356 #ifdef CONFIG_NVME_MULTIPATH
357 enum nvme_ana_state ana_state;
360 struct list_head siblings;
361 struct nvm_dev *ndev;
363 struct nvme_ns_head *head;
372 #define NVME_NS_REMOVING 0
373 #define NVME_NS_DEAD 1
374 #define NVME_NS_ANA_PENDING 2
377 struct nvme_fault_inject fault_inject;
381 struct nvme_ctrl_ops {
383 struct module *module;
385 #define NVME_F_FABRICS (1 << 0)
386 #define NVME_F_METADATA_SUPPORTED (1 << 1)
387 #define NVME_F_PCI_P2PDMA (1 << 2)
388 int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
389 int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val);
390 int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val);
391 void (*free_ctrl)(struct nvme_ctrl *ctrl);
392 void (*submit_async_event)(struct nvme_ctrl *ctrl);
393 void (*delete_ctrl)(struct nvme_ctrl *ctrl);
394 int (*get_address)(struct nvme_ctrl *ctrl, char *buf, int size);
397 #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS
398 void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj,
399 const char *dev_name);
400 void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inject);
401 void nvme_should_fail(struct request *req);
403 static inline void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj,
404 const char *dev_name)
407 static inline void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inj)
410 static inline void nvme_should_fail(struct request *req) {}
413 static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl)
415 if (!ctrl->subsystem)
417 return ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65);
420 static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector)
422 return (sector >> (ns->lba_shift - 9));
425 static inline void nvme_end_request(struct request *req, __le16 status,
426 union nvme_result result)
428 struct nvme_request *rq = nvme_req(req);
430 rq->status = le16_to_cpu(status) >> 1;
432 /* inject error when permitted by fault injection framework */
433 nvme_should_fail(req);
434 blk_mq_complete_request(req);
437 static inline void nvme_get_ctrl(struct nvme_ctrl *ctrl)
439 get_device(ctrl->device);
442 static inline void nvme_put_ctrl(struct nvme_ctrl *ctrl)
444 put_device(ctrl->device);
447 void nvme_complete_rq(struct request *req);
448 bool nvme_cancel_request(struct request *req, void *data, bool reserved);
449 bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
450 enum nvme_ctrl_state new_state);
451 int nvme_disable_ctrl(struct nvme_ctrl *ctrl);
452 int nvme_enable_ctrl(struct nvme_ctrl *ctrl);
453 int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
454 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
455 const struct nvme_ctrl_ops *ops, unsigned long quirks);
456 void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
457 void nvme_start_ctrl(struct nvme_ctrl *ctrl);
458 void nvme_stop_ctrl(struct nvme_ctrl *ctrl);
459 void nvme_put_ctrl(struct nvme_ctrl *ctrl);
460 int nvme_init_identify(struct nvme_ctrl *ctrl);
462 void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
464 int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len,
467 void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
468 volatile union nvme_result *res);
470 void nvme_stop_queues(struct nvme_ctrl *ctrl);
471 void nvme_start_queues(struct nvme_ctrl *ctrl);
472 void nvme_kill_queues(struct nvme_ctrl *ctrl);
473 void nvme_sync_queues(struct nvme_ctrl *ctrl);
474 void nvme_unfreeze(struct nvme_ctrl *ctrl);
475 void nvme_wait_freeze(struct nvme_ctrl *ctrl);
476 void nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout);
477 void nvme_start_freeze(struct nvme_ctrl *ctrl);
479 #define NVME_QID_ANY -1
480 struct request *nvme_alloc_request(struct request_queue *q,
481 struct nvme_command *cmd, blk_mq_req_flags_t flags, int qid);
482 void nvme_cleanup_cmd(struct request *req);
483 blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req,
484 struct nvme_command *cmd);
485 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
486 void *buf, unsigned bufflen);
487 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
488 union nvme_result *result, void *buffer, unsigned bufflen,
489 unsigned timeout, int qid, int at_head,
490 blk_mq_req_flags_t flags, bool poll);
491 int nvme_set_features(struct nvme_ctrl *dev, unsigned int fid,
492 unsigned int dword11, void *buffer, size_t buflen,
494 int nvme_get_features(struct nvme_ctrl *dev, unsigned int fid,
495 unsigned int dword11, void *buffer, size_t buflen,
497 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);
498 void nvme_stop_keep_alive(struct nvme_ctrl *ctrl);
499 int nvme_reset_ctrl(struct nvme_ctrl *ctrl);
500 int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl);
501 int nvme_delete_ctrl(struct nvme_ctrl *ctrl);
503 int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp,
504 void *log, size_t size, u64 offset);
506 extern const struct attribute_group *nvme_ns_id_attr_groups[];
507 extern const struct block_device_operations nvme_ns_head_ops;
509 #ifdef CONFIG_NVME_MULTIPATH
510 static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl)
512 return ctrl->ana_log_buf != NULL;
515 void nvme_mpath_unfreeze(struct nvme_subsystem *subsys);
516 void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys);
517 void nvme_mpath_start_freeze(struct nvme_subsystem *subsys);
518 void nvme_set_disk_name(char *disk_name, struct nvme_ns *ns,
519 struct nvme_ctrl *ctrl, int *flags);
520 void nvme_failover_req(struct request *req);
521 void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl);
522 int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,struct nvme_ns_head *head);
523 void nvme_mpath_add_disk(struct nvme_ns *ns, struct nvme_id_ns *id);
524 void nvme_mpath_remove_disk(struct nvme_ns_head *head);
525 int nvme_mpath_init(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id);
526 void nvme_mpath_uninit(struct nvme_ctrl *ctrl);
527 void nvme_mpath_stop(struct nvme_ctrl *ctrl);
528 bool nvme_mpath_clear_current_path(struct nvme_ns *ns);
529 void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl);
530 struct nvme_ns *nvme_find_path(struct nvme_ns_head *head);
532 static inline void nvme_mpath_check_last_path(struct nvme_ns *ns)
534 struct nvme_ns_head *head = ns->head;
536 if (head->disk && list_empty(&head->list))
537 kblockd_schedule_work(&head->requeue_work);
540 static inline void nvme_trace_bio_complete(struct request *req,
543 struct nvme_ns *ns = req->q->queuedata;
545 if (req->cmd_flags & REQ_NVME_MPATH)
546 trace_block_bio_complete(ns->head->disk->queue,
550 extern struct device_attribute dev_attr_ana_grpid;
551 extern struct device_attribute dev_attr_ana_state;
552 extern struct device_attribute subsys_attr_iopolicy;
555 static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl)
560 * Without the multipath code enabled, multiple controller per subsystems are
561 * visible as devices and thus we cannot use the subsystem instance.
563 static inline void nvme_set_disk_name(char *disk_name, struct nvme_ns *ns,
564 struct nvme_ctrl *ctrl, int *flags)
566 sprintf(disk_name, "nvme%dn%d", ctrl->instance, ns->head->instance);
569 static inline void nvme_failover_req(struct request *req)
572 static inline void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl)
575 static inline int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,
576 struct nvme_ns_head *head)
580 static inline void nvme_mpath_add_disk(struct nvme_ns *ns,
581 struct nvme_id_ns *id)
584 static inline void nvme_mpath_remove_disk(struct nvme_ns_head *head)
587 static inline bool nvme_mpath_clear_current_path(struct nvme_ns *ns)
591 static inline void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl)
594 static inline void nvme_mpath_check_last_path(struct nvme_ns *ns)
597 static inline void nvme_trace_bio_complete(struct request *req,
601 static inline int nvme_mpath_init(struct nvme_ctrl *ctrl,
602 struct nvme_id_ctrl *id)
604 if (ctrl->subsys->cmic & (1 << 3))
605 dev_warn(ctrl->device,
606 "Please enable CONFIG_NVME_MULTIPATH for full support of multi-port devices.\n");
609 static inline void nvme_mpath_uninit(struct nvme_ctrl *ctrl)
612 static inline void nvme_mpath_stop(struct nvme_ctrl *ctrl)
615 static inline void nvme_mpath_unfreeze(struct nvme_subsystem *subsys)
618 static inline void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys)
621 static inline void nvme_mpath_start_freeze(struct nvme_subsystem *subsys)
624 #endif /* CONFIG_NVME_MULTIPATH */
627 int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, int node);
628 void nvme_nvm_unregister(struct nvme_ns *ns);
629 extern const struct attribute_group nvme_nvm_attr_group;
630 int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd, unsigned long arg);
632 static inline int nvme_nvm_register(struct nvme_ns *ns, char *disk_name,
638 static inline void nvme_nvm_unregister(struct nvme_ns *ns) {};
639 static inline int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd,
644 #endif /* CONFIG_NVM */
646 static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev)
648 return dev_to_disk(dev)->private_data;