xref: /linux/drivers/nvme/host/nvme.h (revision d0fc310b4dfd334023b90d2423818044190c0f68)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Copyright (c) 2011-2014, Intel Corporation.
4  */
5 
6 #ifndef _NVME_H
7 #define _NVME_H
8 
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/sed-opal.h>
15 #include <linux/fault-inject.h>
16 #include <linux/rcupdate.h>
17 #include <linux/wait.h>
18 #include <linux/t10-pi.h>
19 #include <linux/ratelimit_types.h>
20 
21 #include <trace/events/block.h>
22 
23 extern const struct pr_ops nvme_pr_ops;
24 
25 extern unsigned int nvme_io_timeout;
26 #define NVME_IO_TIMEOUT	(nvme_io_timeout * HZ)
27 
28 extern unsigned int admin_timeout;
29 #define NVME_ADMIN_TIMEOUT	(admin_timeout * HZ)
30 
31 #define NVME_DEFAULT_KATO	5
32 
33 #ifdef CONFIG_ARCH_NO_SG_CHAIN
34 #define  NVME_INLINE_SG_CNT  0
35 #define  NVME_INLINE_METADATA_SG_CNT  0
36 #else
37 #define  NVME_INLINE_SG_CNT  2
38 #define  NVME_INLINE_METADATA_SG_CNT  1
39 #endif
40 
41 /*
42  * Default to a 4K page size, with the intention to update this
43  * path in the future to accommodate architectures with differing
44  * kernel and IO page sizes.
45  */
46 #define NVME_CTRL_PAGE_SHIFT	12
47 #define NVME_CTRL_PAGE_SIZE	(1 << NVME_CTRL_PAGE_SHIFT)
48 
49 extern struct workqueue_struct *nvme_wq;
50 extern struct workqueue_struct *nvme_reset_wq;
51 extern struct workqueue_struct *nvme_delete_wq;
52 extern struct mutex nvme_subsystems_lock;
53 
54 /*
55  * List of workarounds for devices that required behavior not specified in
56  * the standard.
57  */
58 enum nvme_quirks {
59 	/*
60 	 * Prefers I/O aligned to a stripe size specified in a vendor
61 	 * specific Identify field.
62 	 */
63 	NVME_QUIRK_STRIPE_SIZE			= (1 << 0),
64 
65 	/*
66 	 * The controller doesn't handle Identify value others than 0 or 1
67 	 * correctly.
68 	 */
69 	NVME_QUIRK_IDENTIFY_CNS			= (1 << 1),
70 
71 	/*
72 	 * The controller deterministically returns 0's on reads to
73 	 * logical blocks that deallocate was called on.
74 	 */
75 	NVME_QUIRK_DEALLOCATE_ZEROES		= (1 << 2),
76 
77 	/*
78 	 * The controller needs a delay before starts checking the device
79 	 * readiness, which is done by reading the NVME_CSTS_RDY bit.
80 	 */
81 	NVME_QUIRK_DELAY_BEFORE_CHK_RDY		= (1 << 3),
82 
83 	/*
84 	 * APST should not be used.
85 	 */
86 	NVME_QUIRK_NO_APST			= (1 << 4),
87 
88 	/*
89 	 * The deepest sleep state should not be used.
90 	 */
91 	NVME_QUIRK_NO_DEEPEST_PS		= (1 << 5),
92 
93 	/*
94 	 *  Problems seen with concurrent commands
95 	 */
96 	NVME_QUIRK_QDEPTH_ONE			= (1 << 6),
97 
98 	/*
99 	 * Set MEDIUM priority on SQ creation
100 	 */
101 	NVME_QUIRK_MEDIUM_PRIO_SQ		= (1 << 7),
102 
103 	/*
104 	 * Ignore device provided subnqn.
105 	 */
106 	NVME_QUIRK_IGNORE_DEV_SUBNQN		= (1 << 8),
107 
108 	/*
109 	 * Broken Write Zeroes.
110 	 */
111 	NVME_QUIRK_DISABLE_WRITE_ZEROES		= (1 << 9),
112 
113 	/*
114 	 * Force simple suspend/resume path.
115 	 */
116 	NVME_QUIRK_SIMPLE_SUSPEND		= (1 << 10),
117 
118 	/*
119 	 * Use only one interrupt vector for all queues
120 	 */
121 	NVME_QUIRK_SINGLE_VECTOR		= (1 << 11),
122 
123 	/*
124 	 * Use non-standard 128 bytes SQEs.
125 	 */
126 	NVME_QUIRK_128_BYTES_SQES		= (1 << 12),
127 
128 	/*
129 	 * Prevent tag overlap between queues
130 	 */
131 	NVME_QUIRK_SHARED_TAGS                  = (1 << 13),
132 
133 	/*
134 	 * Don't change the value of the temperature threshold feature
135 	 */
136 	NVME_QUIRK_NO_TEMP_THRESH_CHANGE	= (1 << 14),
137 
138 	/*
139 	 * The controller doesn't handle the Identify Namespace
140 	 * Identification Descriptor list subcommand despite claiming
141 	 * NVMe 1.3 compliance.
142 	 */
143 	NVME_QUIRK_NO_NS_DESC_LIST		= (1 << 15),
144 
145 	/*
146 	 * The controller does not properly handle DMA addresses over
147 	 * 48 bits.
148 	 */
149 	NVME_QUIRK_DMA_ADDRESS_BITS_48		= (1 << 16),
150 
151 	/*
152 	 * The controller requires the command_id value be limited, so skip
153 	 * encoding the generation sequence number.
154 	 */
155 	NVME_QUIRK_SKIP_CID_GEN			= (1 << 17),
156 
157 	/*
158 	 * Reports garbage in the namespace identifiers (eui64, nguid, uuid).
159 	 */
160 	NVME_QUIRK_BOGUS_NID			= (1 << 18),
161 
162 	/*
163 	 * No temperature thresholds for channels other than 0 (Composite).
164 	 */
165 	NVME_QUIRK_NO_SECONDARY_TEMP_THRESH	= (1 << 19),
166 
167 	/*
168 	 * Disables simple suspend/resume path.
169 	 */
170 	NVME_QUIRK_FORCE_NO_SIMPLE_SUSPEND	= (1 << 20),
171 
172 	/*
173 	 * MSI (but not MSI-X) interrupts are broken and never fire.
174 	 */
175 	NVME_QUIRK_BROKEN_MSI			= (1 << 21),
176 
177 	/*
178 	 * Align dma pool segment size to 512 bytes
179 	 */
180 	NVME_QUIRK_DMAPOOL_ALIGN_512		= (1 << 22),
181 
182 	/*
183 	 * Admin queue DMA buffers must be page aligned
184 	 */
185 	NVME_QUIRK_ADMIN_PAGE_ALIGN		= (1 << 23),
186 };
187 
nvme_quirk_name(enum nvme_quirks q)188 static inline char *nvme_quirk_name(enum nvme_quirks q)
189 {
190 	switch (q) {
191 	case NVME_QUIRK_STRIPE_SIZE:
192 		return "stripe_size";
193 	case NVME_QUIRK_IDENTIFY_CNS:
194 		return "identify_cns";
195 	case NVME_QUIRK_DEALLOCATE_ZEROES:
196 		return "deallocate_zeroes";
197 	case NVME_QUIRK_DELAY_BEFORE_CHK_RDY:
198 		return "delay_before_chk_rdy";
199 	case NVME_QUIRK_NO_APST:
200 		return "no_apst";
201 	case NVME_QUIRK_NO_DEEPEST_PS:
202 		return "no_deepest_ps";
203 	case NVME_QUIRK_QDEPTH_ONE:
204 		return "qdepth_one";
205 	case NVME_QUIRK_MEDIUM_PRIO_SQ:
206 		return "medium_prio_sq";
207 	case NVME_QUIRK_IGNORE_DEV_SUBNQN:
208 		return "ignore_dev_subnqn";
209 	case NVME_QUIRK_DISABLE_WRITE_ZEROES:
210 		return "disable_write_zeroes";
211 	case NVME_QUIRK_SIMPLE_SUSPEND:
212 		return "simple_suspend";
213 	case NVME_QUIRK_SINGLE_VECTOR:
214 		return "single_vector";
215 	case NVME_QUIRK_128_BYTES_SQES:
216 		return "128_bytes_sqes";
217 	case NVME_QUIRK_SHARED_TAGS:
218 		return "shared_tags";
219 	case NVME_QUIRK_NO_TEMP_THRESH_CHANGE:
220 		return "no_temp_thresh_change";
221 	case NVME_QUIRK_NO_NS_DESC_LIST:
222 		return "no_ns_desc_list";
223 	case NVME_QUIRK_DMA_ADDRESS_BITS_48:
224 		return "dma_address_bits_48";
225 	case NVME_QUIRK_SKIP_CID_GEN:
226 		return "skip_cid_gen";
227 	case NVME_QUIRK_BOGUS_NID:
228 		return "bogus_nid";
229 	case NVME_QUIRK_NO_SECONDARY_TEMP_THRESH:
230 		return "no_secondary_temp_thresh";
231 	case NVME_QUIRK_FORCE_NO_SIMPLE_SUSPEND:
232 		return "force_no_simple_suspend";
233 	case NVME_QUIRK_BROKEN_MSI:
234 		return "broken_msi";
235 	case NVME_QUIRK_DMAPOOL_ALIGN_512:
236 		return "dmapool_align_512";
237 	case NVME_QUIRK_ADMIN_PAGE_ALIGN:
238 		return "admin_page_align";
239 	}
240 
241 	return "unknown";
242 }
243 
244 /*
245  * Common request structure for NVMe passthrough.  All drivers must have
246  * this structure as the first member of their request-private data.
247  */
248 struct nvme_request {
249 	struct nvme_command	*cmd;
250 	union nvme_result	result;
251 	u8			genctr;
252 	u8			retries;
253 	u8			flags;
254 	u16			status;
255 #ifdef CONFIG_NVME_MULTIPATH
256 	unsigned long		start_time;
257 #endif
258 	struct nvme_ctrl	*ctrl;
259 };
260 
261 /*
262  * Mark a bio as coming in through the mpath node.
263  */
264 #define REQ_NVME_MPATH		REQ_DRV
265 
266 enum {
267 	NVME_REQ_CANCELLED		= (1 << 0),
268 	NVME_REQ_USERCMD		= (1 << 1),
269 	NVME_MPATH_IO_STATS		= (1 << 2),
270 	NVME_MPATH_CNT_ACTIVE		= (1 << 3),
271 };
272 
nvme_req(struct request * req)273 static inline struct nvme_request *nvme_req(struct request *req)
274 {
275 	return blk_mq_rq_to_pdu(req);
276 }
277 
nvme_req_qid(struct request * req)278 static inline u16 nvme_req_qid(struct request *req)
279 {
280 	if (!req->q->queuedata)
281 		return 0;
282 
283 	return req->mq_hctx->queue_num + 1;
284 }
285 
286 /* The below value is the specific amount of delay needed before checking
287  * readiness in case of the PCI_DEVICE(0x1c58, 0x0003), which needs the
288  * NVME_QUIRK_DELAY_BEFORE_CHK_RDY quirk enabled. The value (in ms) was
289  * found empirically.
290  */
291 #define NVME_QUIRK_DELAY_AMOUNT		2300
292 
293 /*
294  * enum nvme_ctrl_state: Controller state
295  *
296  * @NVME_CTRL_NEW:		New controller just allocated, initial state
297  * @NVME_CTRL_LIVE:		Controller is connected and I/O capable
298  * @NVME_CTRL_RESETTING:	Controller is resetting (or scheduled reset)
299  * @NVME_CTRL_CONNECTING:	Controller is disconnected, now connecting the
300  *				transport
301  * @NVME_CTRL_DELETING:		Controller is deleting (or scheduled deletion)
302  * @NVME_CTRL_DELETING_NOIO:	Controller is deleting and I/O is not
303  *				disabled/failed immediately. This state comes
304  * 				after all async event processing took place and
305  * 				before ns removal and the controller deletion
306  * 				progress
307  * @NVME_CTRL_DEAD:		Controller is non-present/unresponsive during
308  *				shutdown or removal. In this case we forcibly
309  *				kill all inflight I/O as they have no chance to
310  *				complete
311  */
312 enum nvme_ctrl_state {
313 	NVME_CTRL_NEW,
314 	NVME_CTRL_LIVE,
315 	NVME_CTRL_RESETTING,
316 	NVME_CTRL_CONNECTING,
317 	NVME_CTRL_DELETING,
318 	NVME_CTRL_DELETING_NOIO,
319 	NVME_CTRL_DEAD,
320 };
321 
322 struct nvme_fault_inject {
323 #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS
324 	struct fault_attr attr;
325 	struct dentry *parent;
326 	u16 opcode;
327 	bool dont_retry;	/* DNR, do not retry */
328 	u16 status;		/* status code */
329 #endif
330 };
331 
332 enum nvme_ctrl_flags {
333 	NVME_CTRL_FAILFAST_EXPIRED	= 0,
334 	NVME_CTRL_ADMIN_Q_STOPPED	= 1,
335 	NVME_CTRL_STARTED_ONCE		= 2,
336 	NVME_CTRL_STOPPED		= 3,
337 	NVME_CTRL_SKIP_ID_CNS_CS	= 4,
338 	NVME_CTRL_DIRTY_CAPABILITY	= 5,
339 	NVME_CTRL_FROZEN		= 6,
340 };
341 
342 struct nvme_ctrl {
343 	bool comp_seen;
344 	bool identified;
345 	bool passthru_err_log_enabled;
346 	enum nvme_ctrl_state state;
347 	spinlock_t lock;
348 	struct mutex scan_lock;
349 	const struct nvme_ctrl_ops *ops;
350 	struct request_queue *admin_q;
351 	struct request_queue *connect_q;
352 	struct request_queue *fabrics_q;
353 	struct device *dev;
354 	int instance;
355 	int numa_node;
356 	struct blk_mq_tag_set *tagset;
357 	struct blk_mq_tag_set *admin_tagset;
358 	struct list_head namespaces;
359 	struct mutex namespaces_lock;
360 	struct srcu_struct srcu;
361 	struct device ctrl_device;
362 	struct device *device;	/* char device */
363 #ifdef CONFIG_NVME_HWMON
364 	struct device *hwmon_device;
365 #endif
366 	struct cdev cdev;
367 	struct work_struct reset_work;
368 	struct work_struct delete_work;
369 	wait_queue_head_t state_wq;
370 
371 	struct nvme_subsystem *subsys;
372 	struct list_head subsys_entry
373 		__guarded_by(&nvme_subsystems_lock);
374 
375 	struct opal_dev *opal_dev;
376 
377 	u16 cntlid;
378 
379 	u16 mtfa;
380 	u32 ctrl_config;
381 	u32 queue_count;
382 	u32 admin_timeout;
383 	u32 io_timeout;
384 
385 	u64 cap;
386 	u32 max_hw_sectors;
387 	u32 max_segments;
388 	u32 max_integrity_segments;
389 	u32 max_zeroes_sectors;
390 #ifdef CONFIG_BLK_DEV_ZONED
391 	u32 max_zone_append;
392 #endif
393 	u16 crdt[3];
394 	u16 oncs;
395 	u8 dmrl;
396 	u32 dmrsl;
397 	u16 oacs;
398 	u16 sqsize;
399 	u32 max_namespaces;
400 	atomic_t abort_limit;
401 	u8 vwc;
402 	u32 vs;
403 	u32 sgls;
404 	u16 kas;
405 	u8 npss;
406 	u8 apsta;
407 	u16 wctemp;
408 	u16 cctemp;
409 	u32 oaes;
410 	u32 aen_result;
411 	u32 ctratt;
412 	unsigned int shutdown_timeout;
413 	unsigned int kato;
414 	bool subsystem;
415 	unsigned long quirks;
416 	struct nvme_id_power_state psd[32];
417 	struct nvme_effects_log *effects;
418 	struct xarray cels;
419 	struct work_struct scan_work;
420 	struct work_struct async_event_work;
421 	struct delayed_work ka_work;
422 	struct delayed_work failfast_work;
423 	struct nvme_command ka_cmd;
424 	unsigned long ka_last_check_time;
425 	struct work_struct fw_act_work;
426 	unsigned long events;
427 	atomic_long_t errors;
428 	atomic_long_t nr_reset;
429 
430 #ifdef CONFIG_NVME_MULTIPATH
431 	/* asymmetric namespace access: */
432 	u8 anacap;
433 	u8 anatt;
434 	u32 anagrpmax;
435 	u32 nanagrpid;
436 	struct mutex ana_lock;
437 	struct nvme_ana_rsp_hdr *ana_log_buf;
438 	size_t ana_log_size;
439 	struct timer_list anatt_timer;
440 	struct work_struct ana_work;
441 	atomic_t nr_active;
442 #endif
443 
444 #ifdef CONFIG_NVME_HOST_AUTH
445 	struct work_struct dhchap_auth_work;
446 	struct mutex dhchap_auth_mutex;
447 	struct nvme_dhchap_queue_context *dhchap_ctxs;
448 	struct nvme_dhchap_key *host_key;
449 	struct nvme_dhchap_key *ctrl_key;
450 	u16 transaction;
451 #endif
452 	key_serial_t tls_pskid;
453 
454 	/* Power saving configuration */
455 	u64 ps_max_latency_us;
456 	bool apst_enabled;
457 
458 	/* PCIe only: */
459 	u16 hmmaxd;
460 	u32 hmpre;
461 	u32 hmmin;
462 	u32 hmminds;
463 
464 	/* Fabrics only */
465 	u32 ioccsz;
466 	u32 iorcsz;
467 	u16 icdoff;
468 	u16 maxcmd;
469 	int nr_reconnects;
470 	/* accumulate reconenct attempts, as nr_reconnects can reset to zero */
471 	atomic_long_t acc_reconnects;
472 	unsigned long flags;
473 	struct nvmf_ctrl_options *opts;
474 
475 	struct page *discard_page;
476 	unsigned long discard_page_busy;
477 
478 	struct nvme_fault_inject fault_inject;
479 
480 	enum nvme_ctrl_type cntrltype;
481 	enum nvme_dctype dctype;
482 
483 	u16			awupf; /* 0's based value. */
484 };
485 
nvme_ctrl_state(struct nvme_ctrl * ctrl)486 static inline enum nvme_ctrl_state nvme_ctrl_state(struct nvme_ctrl *ctrl)
487 {
488 	return READ_ONCE(ctrl->state);
489 }
490 
491 enum nvme_iopolicy {
492 	NVME_IOPOLICY_NUMA,
493 	NVME_IOPOLICY_RR,
494 	NVME_IOPOLICY_QD,
495 };
496 
497 struct nvme_subsystem {
498 	int			instance;
499 	struct device		dev;
500 	/*
501 	 * Because we unregister the device on the last put we need
502 	 * a separate refcount.
503 	 */
504 	struct kref		ref;
505 	struct list_head	entry
506 		__guarded_by(&nvme_subsystems_lock);
507 	struct mutex		lock;
508 	struct list_head	ctrls
509 		__guarded_by(&nvme_subsystems_lock);
510 	struct list_head	nsheads
511 		__guarded_by(&lock);
512 	char			subnqn[NVMF_NQN_SIZE];
513 	char			serial[20];
514 	char			model[40];
515 	char			firmware_rev[8];
516 	u8			cmic;
517 	enum nvme_subsys_type	subtype;
518 	u16			vendor_id;
519 	struct ida		ns_ida;
520 #ifdef CONFIG_NVME_MULTIPATH
521 	enum nvme_iopolicy	iopolicy;
522 #endif
523 };
524 
525 /*
526  * Container structure for uniqueue namespace identifiers.
527  */
528 struct nvme_ns_ids {
529 	u8	eui64[8];
530 	u8	nguid[16];
531 	uuid_t	uuid;
532 	u8	csi;
533 };
534 
535 /*
536  * Anchor structure for namespaces.  There is one for each namespace in a
537  * NVMe subsystem that any of our controllers can see, and the namespace
538  * structure for each controller is chained of it.  For private namespaces
539  * there is a 1:1 relation to our namespace structures, that is ->list
540  * only ever has a single entry for private namespaces.
541  */
542 struct nvme_ns_head {
543 	struct list_head	list;
544 	struct srcu_struct      srcu;
545 	struct nvme_subsystem	*subsys;
546 	struct nvme_ns_ids	ids;
547 	u8			lba_shift;
548 	u16			ms;
549 	u16			pi_size;
550 	u8			pi_type;
551 	u8			guard_type;
552 	struct list_head	entry;
553 	struct kref		ref;
554 	bool			shared;
555 	bool			rotational;
556 	bool			passthru_err_log_enabled;
557 	struct nvme_effects_log *effects;
558 	u64			nuse;
559 	unsigned		ns_id;
560 	int			instance;
561 #ifdef CONFIG_BLK_DEV_ZONED
562 	u64			zsze;
563 #endif
564 	unsigned long		features;
565 
566 	struct ratelimit_state	rs_nuse;
567 
568 	struct cdev		cdev;
569 	struct device		cdev_device;
570 
571 	struct gendisk		*disk;
572 
573 	u16			nr_plids;
574 	u16			*plids;
575 	u32			write_stream_granularity;
576 #ifdef CONFIG_NVME_MULTIPATH
577 	struct bio_list		requeue_list
578 		__guarded_by(&requeue_lock);
579 	spinlock_t		requeue_lock;
580 	struct work_struct	requeue_work;
581 	struct work_struct	partition_scan_work;
582 	struct mutex		lock;
583 	unsigned long		flags;
584 	struct delayed_work	remove_work;
585 	unsigned int		delayed_removal_secs
586 		__guarded_by(&subsys->lock);
587 	atomic_long_t		io_requeue_no_usable_path_count;
588 	atomic_long_t		io_fail_no_available_path_count;
589 #define NVME_NSHEAD_DISK_LIVE		0
590 #define NVME_NSHEAD_QUEUE_IF_NO_PATH	1
591 #define NVME_NSHEAD_CDEV_LIVE		2
592 	struct nvme_ns __rcu_guarded	*current_path[];
593 #endif
594 };
595 
nvme_ns_head_multipath(struct nvme_ns_head * head)596 static inline bool nvme_ns_head_multipath(struct nvme_ns_head *head)
597 {
598 	return IS_ENABLED(CONFIG_NVME_MULTIPATH) && head->disk;
599 }
600 
601 enum nvme_ns_features {
602 	NVME_NS_EXT_LBAS = 1 << 0, /* support extended LBA format */
603 	NVME_NS_METADATA_SUPPORTED = 1 << 1, /* support getting generated md */
604 	NVME_NS_DEAC = 1 << 2,		/* DEAC bit in Write Zeroes supported */
605 };
606 
607 struct nvme_ns {
608 	struct list_head list;
609 
610 	struct nvme_ctrl *ctrl;
611 	struct request_queue *queue;
612 	struct gendisk *disk;
613 #ifdef CONFIG_NVME_MULTIPATH
614 	enum nvme_ana_state ana_state;
615 	u32 ana_grpid;
616 	atomic_long_t failover;
617 #endif
618 	atomic_long_t retries;
619 	atomic_long_t errors;
620 	struct list_head siblings;
621 	struct kref kref;
622 	struct nvme_ns_head *head;
623 
624 	unsigned long flags;
625 #define NVME_NS_REMOVING		0
626 #define NVME_NS_ANA_PENDING		2
627 #define NVME_NS_FORCE_RO		3
628 #define NVME_NS_READY			4
629 #define NVME_NS_SYSFS_ATTR_LINK	5
630 #define NVME_NS_CDEV_LIVE		6
631 
632 	struct cdev		cdev;
633 	struct device		cdev_device;
634 
635 	struct nvme_fault_inject fault_inject;
636 };
637 
638 /* NVMe ns supports metadata actions by the controller (generate/strip) */
nvme_ns_has_pi(struct nvme_ns_head * head)639 static inline bool nvme_ns_has_pi(struct nvme_ns_head *head)
640 {
641 	return head->pi_type && head->ms == head->pi_size;
642 }
643 
nvme_get_virt_boundary(struct nvme_ctrl * ctrl,bool is_admin)644 static inline unsigned long nvme_get_virt_boundary(struct nvme_ctrl *ctrl,
645 						   bool is_admin)
646 {
647 	return NVME_CTRL_PAGE_SIZE - 1;
648 }
649 
650 struct nvme_ctrl_ops {
651 	const char *name;
652 	struct module *module;
653 	unsigned int flags;
654 #define NVME_F_FABRICS			(1 << 0)
655 #define NVME_F_METADATA_SUPPORTED	(1 << 1)
656 #define NVME_F_BLOCKING			(1 << 2)
657 
658 	const struct attribute_group **dev_attr_groups;
659 	int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
660 	int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val);
661 	int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val);
662 	void (*free_ctrl)(struct nvme_ctrl *ctrl);
663 	void (*submit_async_event)(struct nvme_ctrl *ctrl);
664 	int (*subsystem_reset)(struct nvme_ctrl *ctrl);
665 	void (*delete_ctrl)(struct nvme_ctrl *ctrl);
666 	void (*stop_ctrl)(struct nvme_ctrl *ctrl);
667 	int (*get_address)(struct nvme_ctrl *ctrl, char *buf, int size);
668 	void (*print_device_info)(struct nvme_ctrl *ctrl);
669 	bool (*supports_pci_p2pdma)(struct nvme_ctrl *ctrl);
670 	unsigned long (*get_virt_boundary)(struct nvme_ctrl *ctrl, bool is_admin);
671 };
672 
673 /*
674  * nvme command_id is constructed as such:
675  * | xxxx | xxxxxxxxxxxx |
676  *   gen    request tag
677  */
678 #define nvme_genctr_mask(gen)			(gen & 0xf)
679 #define nvme_cid_install_genctr(gen)		(nvme_genctr_mask(gen) << 12)
680 #define nvme_genctr_from_cid(cid)		((cid & 0xf000) >> 12)
681 #define nvme_tag_from_cid(cid)			(cid & 0xfff)
682 
nvme_cid(struct request * rq)683 static inline u16 nvme_cid(struct request *rq)
684 {
685 	return nvme_cid_install_genctr(nvme_req(rq)->genctr) | rq->tag;
686 }
687 
nvme_find_rq(struct blk_mq_tags * tags,u16 command_id)688 static inline struct request *nvme_find_rq(struct blk_mq_tags *tags,
689 		u16 command_id)
690 {
691 	u8 genctr = nvme_genctr_from_cid(command_id);
692 	u16 tag = nvme_tag_from_cid(command_id);
693 	struct request *rq;
694 
695 	rq = blk_mq_tag_to_rq(tags, tag);
696 	if (unlikely(!rq)) {
697 		pr_err_ratelimited("could not locate request for tag %#x\n",
698 				   tag);
699 		return NULL;
700 	}
701 	if (unlikely(nvme_genctr_mask(nvme_req(rq)->genctr) != genctr)) {
702 		dev_err_ratelimited(nvme_req(rq)->ctrl->device,
703 			"request %#x genctr mismatch (got %#x expected %#x)\n",
704 			tag, genctr, nvme_genctr_mask(nvme_req(rq)->genctr));
705 		return NULL;
706 	}
707 	return rq;
708 }
709 
nvme_cid_to_rq(struct blk_mq_tags * tags,u16 command_id)710 static inline struct request *nvme_cid_to_rq(struct blk_mq_tags *tags,
711                 u16 command_id)
712 {
713 	return blk_mq_tag_to_rq(tags, nvme_tag_from_cid(command_id));
714 }
715 
716 /*
717  * Return the length of the string without the space padding
718  */
nvme_strlen(char * s,int len)719 static inline int nvme_strlen(char *s, int len)
720 {
721 	while (s[len - 1] == ' ')
722 		len--;
723 	return len;
724 }
725 
nvme_print_device_info(struct nvme_ctrl * ctrl)726 static inline void nvme_print_device_info(struct nvme_ctrl *ctrl)
727 {
728 	struct nvme_subsystem *subsys = ctrl->subsys;
729 
730 	if (ctrl->ops->print_device_info) {
731 		ctrl->ops->print_device_info(ctrl);
732 		return;
733 	}
734 
735 	dev_err(ctrl->device,
736 		"VID:%04x model:%.*s firmware:%.*s\n", subsys->vendor_id,
737 		nvme_strlen(subsys->model, sizeof(subsys->model)),
738 		subsys->model, nvme_strlen(subsys->firmware_rev,
739 					   sizeof(subsys->firmware_rev)),
740 		subsys->firmware_rev);
741 }
742 
743 #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS
744 void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj,
745 			    const char *dev_name);
746 void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inject);
747 void nvme_should_fail(struct request *req);
748 #else
nvme_fault_inject_init(struct nvme_fault_inject * fault_inj,const char * dev_name)749 static inline void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj,
750 					  const char *dev_name)
751 {
752 }
nvme_fault_inject_fini(struct nvme_fault_inject * fault_inj)753 static inline void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inj)
754 {
755 }
nvme_should_fail(struct request * req)756 static inline void nvme_should_fail(struct request *req) {}
757 #endif
758 
759 bool nvme_wait_reset(struct nvme_ctrl *ctrl);
760 int nvme_try_sched_reset(struct nvme_ctrl *ctrl);
761 
nvme_reset_subsystem(struct nvme_ctrl * ctrl)762 static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl)
763 {
764 	if (!ctrl->subsystem || !ctrl->ops->subsystem_reset)
765 		return -ENOTTY;
766 	return ctrl->ops->subsystem_reset(ctrl);
767 }
768 
769 /*
770  * Convert a 512B sector number to a device logical block number.
771  */
nvme_sect_to_lba(struct nvme_ns_head * head,sector_t sector)772 static inline u64 nvme_sect_to_lba(struct nvme_ns_head *head, sector_t sector)
773 {
774 	return sector >> (head->lba_shift - SECTOR_SHIFT);
775 }
776 
777 /*
778  * Convert a device logical block number to a 512B sector number.
779  */
nvme_lba_to_sect(struct nvme_ns_head * head,u64 lba)780 static inline sector_t nvme_lba_to_sect(struct nvme_ns_head *head, u64 lba)
781 {
782 	return lba << (head->lba_shift - SECTOR_SHIFT);
783 }
784 
785 /*
786  * Convert byte length to nvme's 0-based num dwords
787  */
nvme_bytes_to_numd(size_t len)788 static inline u32 nvme_bytes_to_numd(size_t len)
789 {
790 	return (len >> 2) - 1;
791 }
792 
793 /* Decode a 2-byte "0's based"/"0-based" field */
from0based(__le16 value)794 static inline u32 from0based(__le16 value)
795 {
796 	return (u32)le16_to_cpu(value) + 1;
797 }
798 
nvme_is_ana_error(u16 status)799 static inline bool nvme_is_ana_error(u16 status)
800 {
801 	switch (status & NVME_SCT_SC_MASK) {
802 	case NVME_SC_ANA_TRANSITION:
803 	case NVME_SC_ANA_INACCESSIBLE:
804 	case NVME_SC_ANA_PERSISTENT_LOSS:
805 		return true;
806 	default:
807 		return false;
808 	}
809 }
810 
nvme_is_path_error(u16 status)811 static inline bool nvme_is_path_error(u16 status)
812 {
813 	/* check for a status code type of 'path related status' */
814 	return (status & NVME_SCT_MASK) == NVME_SCT_PATH;
815 }
816 
817 /*
818  * Fill in the status and result information from the CQE, and then figure out
819  * if blk-mq will need to use IPI magic to complete the request, and if yes do
820  * so.  If not let the caller complete the request without an indirect function
821  * call.
822  */
nvme_try_complete_req(struct request * req,__le16 status,union nvme_result result)823 static inline bool nvme_try_complete_req(struct request *req, __le16 status,
824 		union nvme_result result)
825 {
826 	struct nvme_request *rq = nvme_req(req);
827 	struct nvme_ctrl *ctrl = rq->ctrl;
828 
829 	if (!(ctrl->quirks & NVME_QUIRK_SKIP_CID_GEN))
830 		rq->genctr++;
831 
832 	rq->status = le16_to_cpu(status) >> 1;
833 	rq->result = result;
834 	/* inject error when permitted by fault injection framework */
835 	nvme_should_fail(req);
836 	if (unlikely(blk_should_fake_timeout(req->q)))
837 		return true;
838 	return blk_mq_complete_request_remote(req);
839 }
840 
nvme_get_ctrl(struct nvme_ctrl * ctrl)841 static inline void nvme_get_ctrl(struct nvme_ctrl *ctrl)
842 {
843 	get_device(ctrl->device);
844 }
845 
nvme_put_ctrl(struct nvme_ctrl * ctrl)846 static inline void nvme_put_ctrl(struct nvme_ctrl *ctrl)
847 {
848 	put_device(ctrl->device);
849 }
850 
nvme_is_aen_req(u16 qid,__u16 command_id)851 static inline bool nvme_is_aen_req(u16 qid, __u16 command_id)
852 {
853 	return !qid &&
854 		nvme_tag_from_cid(command_id) >= NVME_AQ_BLK_MQ_DEPTH;
855 }
856 
857 /*
858  * Returns true for sink states that can't ever transition back to live.
859  */
nvme_state_terminal(struct nvme_ctrl * ctrl)860 static inline bool nvme_state_terminal(struct nvme_ctrl *ctrl)
861 {
862 	switch (nvme_ctrl_state(ctrl)) {
863 	case NVME_CTRL_NEW:
864 	case NVME_CTRL_LIVE:
865 	case NVME_CTRL_RESETTING:
866 	case NVME_CTRL_CONNECTING:
867 		return false;
868 	case NVME_CTRL_DELETING:
869 	case NVME_CTRL_DELETING_NOIO:
870 	case NVME_CTRL_DEAD:
871 		return true;
872 	default:
873 		WARN_ONCE(1, "Unhandled ctrl state:%d", ctrl->state);
874 		return true;
875 	}
876 }
877 
878 void nvme_end_req(struct request *req);
879 void nvme_complete_rq(struct request *req);
880 void nvme_complete_batch_req(struct request *req);
881 
nvme_complete_batch(struct io_comp_batch * iob,void (* fn)(struct request * rq))882 static __always_inline void nvme_complete_batch(struct io_comp_batch *iob,
883 						void (*fn)(struct request *rq))
884 {
885 	struct request *req;
886 
887 	rq_list_for_each(&iob->req_list, req) {
888 		fn(req);
889 		nvme_complete_batch_req(req);
890 	}
891 	blk_mq_end_request_batch(iob);
892 }
893 
894 blk_status_t nvme_host_path_error(struct request *req);
895 bool nvme_cancel_request(struct request *req, void *data);
896 void nvme_cancel_tagset(struct nvme_ctrl *ctrl);
897 void nvme_cancel_admin_tagset(struct nvme_ctrl *ctrl);
898 bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
899 		enum nvme_ctrl_state new_state);
900 int nvme_disable_ctrl(struct nvme_ctrl *ctrl, bool shutdown);
901 int nvme_enable_ctrl(struct nvme_ctrl *ctrl);
902 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
903 		const struct nvme_ctrl_ops *ops, unsigned long quirks);
904 int nvme_add_ctrl(struct nvme_ctrl *ctrl);
905 void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
906 void nvme_start_ctrl(struct nvme_ctrl *ctrl);
907 void nvme_stop_ctrl(struct nvme_ctrl *ctrl);
908 int nvme_init_ctrl_finish(struct nvme_ctrl *ctrl, bool was_suspended);
909 int nvme_alloc_admin_tag_set(struct nvme_ctrl *ctrl, struct blk_mq_tag_set *set,
910 		const struct blk_mq_ops *ops, unsigned int cmd_size);
911 void nvme_remove_admin_tag_set(struct nvme_ctrl *ctrl);
912 int nvme_alloc_io_tag_set(struct nvme_ctrl *ctrl, struct blk_mq_tag_set *set,
913 		const struct blk_mq_ops *ops, unsigned int nr_maps,
914 		unsigned int cmd_size);
915 void nvme_remove_io_tag_set(struct nvme_ctrl *ctrl);
916 
917 void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
918 
919 void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
920 		volatile union nvme_result *res);
921 
922 void nvme_quiesce_io_queues(struct nvme_ctrl *ctrl);
923 void nvme_unquiesce_io_queues(struct nvme_ctrl *ctrl);
924 void nvme_quiesce_admin_queue(struct nvme_ctrl *ctrl);
925 void nvme_unquiesce_admin_queue(struct nvme_ctrl *ctrl);
926 void nvme_mark_namespaces_dead(struct nvme_ctrl *ctrl);
927 void nvme_sync_queues(struct nvme_ctrl *ctrl);
928 void nvme_sync_io_queues(struct nvme_ctrl *ctrl);
929 void nvme_unfreeze(struct nvme_ctrl *ctrl);
930 void nvme_wait_freeze(struct nvme_ctrl *ctrl);
931 int nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl);
932 void nvme_start_freeze(struct nvme_ctrl *ctrl);
933 
nvme_req_op(struct nvme_command * cmd)934 static inline enum req_op nvme_req_op(struct nvme_command *cmd)
935 {
936 	return nvme_is_write(cmd) ? REQ_OP_DRV_OUT : REQ_OP_DRV_IN;
937 }
938 
939 #define NVME_QID_ANY -1
940 void nvme_init_request(struct request *req, struct nvme_command *cmd);
941 void nvme_cleanup_cmd(struct request *req);
942 blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req);
943 blk_status_t nvme_fail_nonready_command(struct nvme_ctrl *ctrl,
944 		struct request *req);
945 bool __nvme_check_ready(struct nvme_ctrl *ctrl, struct request *rq,
946 		bool queue_live, enum nvme_ctrl_state state);
947 
nvme_check_ready(struct nvme_ctrl * ctrl,struct request * rq,bool queue_live)948 static inline bool nvme_check_ready(struct nvme_ctrl *ctrl, struct request *rq,
949 		bool queue_live)
950 {
951 	enum nvme_ctrl_state state = nvme_ctrl_state(ctrl);
952 
953 	if (likely(state == NVME_CTRL_LIVE))
954 		return true;
955 	if (ctrl->ops->flags & NVME_F_FABRICS && state == NVME_CTRL_DELETING)
956 		return queue_live;
957 	return __nvme_check_ready(ctrl, rq, queue_live, state);
958 }
959 
960 /*
961  * NSID shall be unique for all shared namespaces, or if at least one of the
962  * following conditions is met:
963  *   1. Namespace Management is supported by the controller
964  *   2. ANA is supported by the controller
965  *   3. NVM Set are supported by the controller
966  *
967  * In other case, private namespace are not required to report a unique NSID.
968  */
nvme_is_unique_nsid(struct nvme_ctrl * ctrl,struct nvme_ns_head * head)969 static inline bool nvme_is_unique_nsid(struct nvme_ctrl *ctrl,
970 		struct nvme_ns_head *head)
971 {
972 	return head->shared ||
973 		(ctrl->oacs & NVME_CTRL_OACS_NS_MNGT_SUPP) ||
974 		(ctrl->subsys->cmic & NVME_CTRL_CMIC_ANA) ||
975 		(ctrl->ctratt & NVME_CTRL_CTRATT_NVM_SETS);
976 }
977 
978 /*
979  * Flags for __nvme_submit_sync_cmd()
980  */
981 typedef __u32 __bitwise nvme_submit_flags_t;
982 
983 enum {
984 	/* Insert request at the head of the queue */
985 	NVME_SUBMIT_AT_HEAD  = (__force nvme_submit_flags_t)(1 << 0),
986 	/* Set BLK_MQ_REQ_NOWAIT when allocating request */
987 	NVME_SUBMIT_NOWAIT = (__force nvme_submit_flags_t)(1 << 1),
988 	/* Set BLK_MQ_REQ_RESERVED when allocating request */
989 	NVME_SUBMIT_RESERVED = (__force nvme_submit_flags_t)(1 << 2),
990 	/* Retry command when NVME_STATUS_DNR is not set in the result */
991 	NVME_SUBMIT_RETRY = (__force nvme_submit_flags_t)(1 << 3),
992 };
993 
994 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
995 		void *buf, unsigned bufflen);
996 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
997 		union nvme_result *result, void *buffer, unsigned bufflen,
998 		int qid, nvme_submit_flags_t flags);
999 int nvme_set_features(struct nvme_ctrl *dev, unsigned int fid,
1000 		      unsigned int dword11, void *buffer, size_t buflen,
1001 		      void *result);
1002 int nvme_get_features(struct nvme_ctrl *dev, unsigned int fid,
1003 		      unsigned int dword11, void *buffer, size_t buflen,
1004 		      void *result);
1005 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);
1006 void nvme_stop_keep_alive(struct nvme_ctrl *ctrl);
1007 int nvme_reset_ctrl(struct nvme_ctrl *ctrl);
1008 int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl);
1009 int nvme_delete_ctrl(struct nvme_ctrl *ctrl);
1010 void nvme_queue_scan(struct nvme_ctrl *ctrl);
1011 int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp, u8 csi,
1012 		void *log, size_t size, u64 offset);
1013 void nvme_get_ns_head(struct nvme_ns_head *head);
1014 bool nvme_tryget_ns_head(struct nvme_ns_head *head);
1015 void nvme_put_ns_head(struct nvme_ns_head *head);
1016 int nvme_cdev_add(const char *name, struct cdev *cdev,
1017 		struct device *cdev_device,
1018 		const struct file_operations *fops, struct module *owner);
1019 void nvme_cdev_del(struct cdev *cdev, struct device *cdev_device);
1020 int nvme_ioctl(struct block_device *bdev, blk_mode_t mode,
1021 		unsigned int cmd, unsigned long arg);
1022 long nvme_ns_chr_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
1023 int nvme_ns_head_ioctl(struct block_device *bdev, blk_mode_t mode,
1024 		unsigned int cmd, unsigned long arg);
1025 long nvme_ns_head_chr_ioctl(struct file *file, unsigned int cmd,
1026 		unsigned long arg);
1027 long nvme_dev_ioctl(struct file *file, unsigned int cmd,
1028 		unsigned long arg);
1029 int nvme_ns_chr_uring_cmd_iopoll(struct io_uring_cmd *ioucmd,
1030 		struct io_comp_batch *iob, unsigned int poll_flags);
1031 int nvme_ns_chr_uring_cmd(struct io_uring_cmd *ioucmd,
1032 		unsigned int issue_flags);
1033 int nvme_ns_head_chr_uring_cmd(struct io_uring_cmd *ioucmd,
1034 		unsigned int issue_flags);
1035 int nvme_identify_ns(struct nvme_ctrl *ctrl, unsigned nsid,
1036 		struct nvme_id_ns **id);
1037 int nvme_getgeo(struct gendisk *disk, struct hd_geometry *geo);
1038 int nvme_dev_uring_cmd(struct io_uring_cmd *ioucmd, unsigned int issue_flags);
1039 
1040 extern const struct attribute_group *nvme_ns_attr_groups[];
1041 extern const struct attribute_group nvme_ns_mpath_attr_group;
1042 extern const struct pr_ops nvme_pr_ops;
1043 extern const struct block_device_operations nvme_ns_head_ops;
1044 extern const struct attribute_group nvme_dev_attrs_group;
1045 extern const struct attribute_group nvme_dev_diag_attrs_group;
1046 extern const struct attribute_group *nvme_subsys_attrs_groups[];
1047 extern const struct attribute_group *nvme_dev_attr_groups[];
1048 extern const struct block_device_operations nvme_bdev_ops;
1049 
1050 void nvme_delete_ctrl_sync(struct nvme_ctrl *ctrl);
1051 struct nvme_ns *nvme_find_path(struct nvme_ns_head *head)
1052 	__must_hold_shared(&head->srcu);
1053 #ifdef CONFIG_NVME_MULTIPATH
nvme_ctrl_use_ana(struct nvme_ctrl * ctrl)1054 static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl)
1055 {
1056 	return ctrl->ana_log_buf != NULL;
1057 }
1058 
1059 void nvme_mpath_unfreeze(struct nvme_subsystem *subsys)
1060 	__must_hold(&subsys->lock);
1061 void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys)
1062 	__must_hold(&subsys->lock);
1063 void nvme_mpath_start_freeze(struct nvme_subsystem *subsys)
1064 	__must_hold(&subsys->lock);
1065 void nvme_mpath_default_iopolicy(struct nvme_subsystem *subsys);
1066 void nvme_failover_req(struct request *req);
1067 void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl);
1068 int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,struct nvme_ns_head *head);
1069 void nvme_mpath_add_sysfs_link(struct nvme_ns_head *ns);
1070 void nvme_mpath_remove_sysfs_link(struct nvme_ns *ns);
1071 void nvme_mpath_add_disk(struct nvme_ns *ns, __le32 anagrpid);
1072 void nvme_mpath_put_disk(struct nvme_ns_head *head);
1073 int nvme_mpath_init_identify(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id);
1074 void nvme_mpath_init_ctrl(struct nvme_ctrl *ctrl);
1075 void nvme_mpath_update(struct nvme_ctrl *ctrl);
1076 void nvme_mpath_uninit(struct nvme_ctrl *ctrl);
1077 void nvme_mpath_stop(struct nvme_ctrl *ctrl);
1078 bool nvme_mpath_clear_current_path(struct nvme_ns *ns);
1079 void nvme_mpath_revalidate_paths(struct nvme_ns_head *head);
1080 void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl);
1081 void nvme_mpath_remove_disk(struct nvme_ns_head *head);
1082 void nvme_mpath_start_request(struct request *rq);
1083 void nvme_mpath_end_request(struct request *rq);
1084 
nvme_trace_bio_complete(struct request * req)1085 static inline void nvme_trace_bio_complete(struct request *req)
1086 {
1087 	struct nvme_ns *ns = req->q->queuedata;
1088 
1089 	if ((req->cmd_flags & REQ_NVME_MPATH) && req->bio)
1090 		trace_block_bio_complete(ns->head->disk->queue, req->bio);
1091 }
1092 
1093 extern bool multipath;
1094 extern struct device_attribute dev_attr_ana_grpid;
1095 extern struct device_attribute dev_attr_ana_state;
1096 extern struct device_attribute dev_attr_queue_depth;
1097 extern struct device_attribute dev_attr_numa_nodes;
1098 extern struct device_attribute dev_attr_delayed_removal_secs;
1099 extern struct device_attribute dev_attr_multipath_failover_count;
1100 extern struct device_attribute dev_attr_io_requeue_no_usable_path_count;
1101 extern struct device_attribute dev_attr_io_fail_no_available_path_count;
1102 extern struct device_attribute subsys_attr_iopolicy;
1103 
nvme_disk_is_ns_head(struct gendisk * disk)1104 static inline bool nvme_disk_is_ns_head(struct gendisk *disk)
1105 {
1106 	return disk->fops == &nvme_ns_head_ops;
1107 }
nvme_mpath_queue_if_no_path(struct nvme_ns_head * head)1108 static inline bool nvme_mpath_queue_if_no_path(struct nvme_ns_head *head)
1109 {
1110 	if (test_bit(NVME_NSHEAD_QUEUE_IF_NO_PATH, &head->flags))
1111 		return true;
1112 	return false;
1113 }
1114 #else
1115 #define multipath false
nvme_ctrl_use_ana(struct nvme_ctrl * ctrl)1116 static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl)
1117 {
1118 	return false;
1119 }
nvme_failover_req(struct request * req)1120 static inline void nvme_failover_req(struct request *req)
1121 {
1122 }
nvme_kick_requeue_lists(struct nvme_ctrl * ctrl)1123 static inline void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl)
1124 {
1125 }
nvme_mpath_alloc_disk(struct nvme_ctrl * ctrl,struct nvme_ns_head * head)1126 static inline int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,
1127 		struct nvme_ns_head *head)
1128 {
1129 	return 0;
1130 }
nvme_mpath_add_disk(struct nvme_ns * ns,__le32 anagrpid)1131 static inline void nvme_mpath_add_disk(struct nvme_ns *ns, __le32 anagrpid)
1132 {
1133 }
nvme_mpath_put_disk(struct nvme_ns_head * head)1134 static inline void nvme_mpath_put_disk(struct nvme_ns_head *head)
1135 {
1136 }
nvme_mpath_add_sysfs_link(struct nvme_ns * ns)1137 static inline void nvme_mpath_add_sysfs_link(struct nvme_ns *ns)
1138 {
1139 }
nvme_mpath_remove_sysfs_link(struct nvme_ns * ns)1140 static inline void nvme_mpath_remove_sysfs_link(struct nvme_ns *ns)
1141 {
1142 }
nvme_mpath_clear_current_path(struct nvme_ns * ns)1143 static inline bool nvme_mpath_clear_current_path(struct nvme_ns *ns)
1144 {
1145 	return false;
1146 }
nvme_mpath_revalidate_paths(struct nvme_ns_head * head)1147 static inline void nvme_mpath_revalidate_paths(struct nvme_ns_head *head)
1148 {
1149 }
nvme_mpath_clear_ctrl_paths(struct nvme_ctrl * ctrl)1150 static inline void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl)
1151 {
1152 }
nvme_mpath_remove_disk(struct nvme_ns_head * head)1153 static inline void nvme_mpath_remove_disk(struct nvme_ns_head *head)
1154 {
1155 }
nvme_trace_bio_complete(struct request * req)1156 static inline void nvme_trace_bio_complete(struct request *req)
1157 {
1158 }
nvme_mpath_init_ctrl(struct nvme_ctrl * ctrl)1159 static inline void nvme_mpath_init_ctrl(struct nvme_ctrl *ctrl)
1160 {
1161 }
nvme_mpath_init_identify(struct nvme_ctrl * ctrl,struct nvme_id_ctrl * id)1162 static inline int nvme_mpath_init_identify(struct nvme_ctrl *ctrl,
1163 		struct nvme_id_ctrl *id)
1164 {
1165 	if (ctrl->subsys->cmic & NVME_CTRL_CMIC_ANA)
1166 		dev_warn(ctrl->device,
1167 "Please enable CONFIG_NVME_MULTIPATH for full support of multi-port devices.\n");
1168 	return 0;
1169 }
nvme_mpath_update(struct nvme_ctrl * ctrl)1170 static inline void nvme_mpath_update(struct nvme_ctrl *ctrl)
1171 {
1172 }
nvme_mpath_uninit(struct nvme_ctrl * ctrl)1173 static inline void nvme_mpath_uninit(struct nvme_ctrl *ctrl)
1174 {
1175 }
nvme_mpath_stop(struct nvme_ctrl * ctrl)1176 static inline void nvme_mpath_stop(struct nvme_ctrl *ctrl)
1177 {
1178 }
nvme_mpath_unfreeze(struct nvme_subsystem * subsys)1179 static inline void nvme_mpath_unfreeze(struct nvme_subsystem *subsys)
1180 {
1181 }
nvme_mpath_wait_freeze(struct nvme_subsystem * subsys)1182 static inline void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys)
1183 {
1184 }
nvme_mpath_start_freeze(struct nvme_subsystem * subsys)1185 static inline void nvme_mpath_start_freeze(struct nvme_subsystem *subsys)
1186 {
1187 }
nvme_mpath_default_iopolicy(struct nvme_subsystem * subsys)1188 static inline void nvme_mpath_default_iopolicy(struct nvme_subsystem *subsys)
1189 {
1190 }
nvme_mpath_start_request(struct request * rq)1191 static inline void nvme_mpath_start_request(struct request *rq)
1192 {
1193 }
nvme_mpath_end_request(struct request * rq)1194 static inline void nvme_mpath_end_request(struct request *rq)
1195 {
1196 }
nvme_disk_is_ns_head(struct gendisk * disk)1197 static inline bool nvme_disk_is_ns_head(struct gendisk *disk)
1198 {
1199 	return false;
1200 }
nvme_mpath_queue_if_no_path(struct nvme_ns_head * head)1201 static inline bool nvme_mpath_queue_if_no_path(struct nvme_ns_head *head)
1202 {
1203 	return false;
1204 }
1205 #endif /* CONFIG_NVME_MULTIPATH */
1206 
1207 #if defined(CONFIG_NVME_MULTIPATH) && defined(CONFIG_BLK_DEV_ZONED)
1208 int nvme_mpath_revalidate_zones(struct nvme_ns_head *head);
1209 #else
nvme_mpath_revalidate_zones(struct nvme_ns_head * head)1210 static inline int nvme_mpath_revalidate_zones(struct nvme_ns_head *head)
1211 {
1212 	return 0;
1213 }
1214 #endif
1215 
1216 int nvme_ns_get_unique_id(struct nvme_ns *ns, u8 id[16],
1217 		enum blk_unique_id type);
1218 
1219 struct nvme_zone_info {
1220 	u64 zone_size;
1221 	unsigned int max_open_zones;
1222 	unsigned int max_active_zones;
1223 };
1224 
1225 int nvme_ns_report_zones(struct nvme_ns *ns, sector_t sector,
1226 		unsigned int nr_zones, struct blk_report_zones_args *args);
1227 int nvme_query_zone_info(struct nvme_ns *ns, unsigned lbaf,
1228 		struct nvme_zone_info *zi);
1229 void nvme_update_zone_info(struct nvme_ns *ns, struct queue_limits *lim,
1230 		struct nvme_zone_info *zi);
1231 #ifdef CONFIG_BLK_DEV_ZONED
1232 blk_status_t nvme_setup_zone_mgmt_send(struct nvme_ns *ns, struct request *req,
1233 				       struct nvme_command *cmnd,
1234 				       enum nvme_zone_mgmt_action action);
1235 #else
nvme_setup_zone_mgmt_send(struct nvme_ns * ns,struct request * req,struct nvme_command * cmnd,enum nvme_zone_mgmt_action action)1236 static inline blk_status_t nvme_setup_zone_mgmt_send(struct nvme_ns *ns,
1237 		struct request *req, struct nvme_command *cmnd,
1238 		enum nvme_zone_mgmt_action action)
1239 {
1240 	return BLK_STS_NOTSUPP;
1241 }
1242 #endif
1243 
nvme_get_ns_from_dev(struct device * dev)1244 static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev)
1245 {
1246 	struct gendisk *disk = dev_to_disk(dev);
1247 
1248 	WARN_ON(nvme_disk_is_ns_head(disk));
1249 	return disk->private_data;
1250 }
1251 
1252 #ifdef CONFIG_NVME_HWMON
1253 int nvme_hwmon_init(struct nvme_ctrl *ctrl);
1254 void nvme_hwmon_exit(struct nvme_ctrl *ctrl);
1255 #else
nvme_hwmon_init(struct nvme_ctrl * ctrl)1256 static inline int nvme_hwmon_init(struct nvme_ctrl *ctrl)
1257 {
1258 	return 0;
1259 }
1260 
nvme_hwmon_exit(struct nvme_ctrl * ctrl)1261 static inline void nvme_hwmon_exit(struct nvme_ctrl *ctrl)
1262 {
1263 }
1264 #endif
1265 
nvme_start_request(struct request * rq)1266 static inline void nvme_start_request(struct request *rq)
1267 {
1268 	if (rq->cmd_flags & REQ_NVME_MPATH)
1269 		nvme_mpath_start_request(rq);
1270 	blk_mq_start_request(rq);
1271 }
1272 
nvme_ctrl_sgl_supported(struct nvme_ctrl * ctrl)1273 static inline bool nvme_ctrl_sgl_supported(struct nvme_ctrl *ctrl)
1274 {
1275 	return ctrl->sgls & (NVME_CTRL_SGLS_BYTE_ALIGNED |
1276 			     NVME_CTRL_SGLS_DWORD_ALIGNED);
1277 }
1278 
nvme_ctrl_meta_sgl_supported(struct nvme_ctrl * ctrl)1279 static inline bool nvme_ctrl_meta_sgl_supported(struct nvme_ctrl *ctrl)
1280 {
1281 	if (ctrl->ops->flags & NVME_F_FABRICS)
1282 		return true;
1283 	return ctrl->sgls & NVME_CTRL_SGLS_MSDS;
1284 }
1285 
1286 #ifdef CONFIG_NVME_HOST_AUTH
1287 int __init nvme_init_auth(void);
1288 void __exit nvme_exit_auth(void);
1289 int nvme_auth_init_ctrl(struct nvme_ctrl *ctrl);
1290 void nvme_auth_stop(struct nvme_ctrl *ctrl);
1291 int nvme_auth_negotiate(struct nvme_ctrl *ctrl, int qid);
1292 int nvme_auth_wait(struct nvme_ctrl *ctrl, int qid);
1293 void nvme_auth_free(struct nvme_ctrl *ctrl);
1294 void nvme_auth_revoke_tls_key(struct nvme_ctrl *ctrl);
1295 #else
nvme_auth_init_ctrl(struct nvme_ctrl * ctrl)1296 static inline int nvme_auth_init_ctrl(struct nvme_ctrl *ctrl)
1297 {
1298 	return 0;
1299 }
nvme_init_auth(void)1300 static inline int __init nvme_init_auth(void)
1301 {
1302 	return 0;
1303 }
nvme_exit_auth(void)1304 static inline void __exit nvme_exit_auth(void)
1305 {
1306 }
nvme_auth_stop(struct nvme_ctrl * ctrl)1307 static inline void nvme_auth_stop(struct nvme_ctrl *ctrl) {};
nvme_auth_negotiate(struct nvme_ctrl * ctrl,int qid)1308 static inline int nvme_auth_negotiate(struct nvme_ctrl *ctrl, int qid)
1309 {
1310 	return -EPROTONOSUPPORT;
1311 }
nvme_auth_wait(struct nvme_ctrl * ctrl,int qid)1312 static inline int nvme_auth_wait(struct nvme_ctrl *ctrl, int qid)
1313 {
1314 	return -EPROTONOSUPPORT;
1315 }
nvme_auth_free(struct nvme_ctrl * ctrl)1316 static inline void nvme_auth_free(struct nvme_ctrl *ctrl) {};
nvme_auth_revoke_tls_key(struct nvme_ctrl * ctrl)1317 static inline void nvme_auth_revoke_tls_key(struct nvme_ctrl *ctrl) {};
1318 #endif
1319 
1320 u32 nvme_command_effects(struct nvme_ctrl *ctrl, struct nvme_ns *ns,
1321 			 u8 opcode);
1322 u32 nvme_passthru_start(struct nvme_ctrl *ctrl, struct nvme_ns *ns, u8 opcode)
1323 	__cond_acquires(nonzero, &ctrl->subsys->lock)
1324 	__cond_acquires(nonzero, &ctrl->scan_lock);
1325 
1326 int nvme_execute_rq(struct request *rq, bool at_head);
1327 u32 nvme_passthru_end(struct nvme_ctrl *ctrl, struct nvme_ns *ns, u32 effects,
1328 		       struct nvme_command *cmd, int status)
1329 		       __cond_releases(nonzero, &ctrl->scan_lock)
1330 		       __cond_releases(nonzero, &ctrl->subsys->lock);
1331 
1332 struct nvme_ctrl *nvme_ctrl_from_file(struct file *file);
1333 struct nvme_ns *nvme_find_get_ns(struct nvme_ctrl *ctrl, unsigned nsid);
1334 bool nvme_get_ns(struct nvme_ns *ns);
1335 void nvme_put_ns(struct nvme_ns *ns);
1336 
nvme_multi_css(struct nvme_ctrl * ctrl)1337 static inline bool nvme_multi_css(struct nvme_ctrl *ctrl)
1338 {
1339 	return (ctrl->ctrl_config & NVME_CC_CSS_MASK) == NVME_CC_CSS_CSI;
1340 }
1341 
1342 #endif /* _NVME_H */
1343