1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * Copyright (c) 2015-2016 HGST, a Western Digital Company.
4 */
5
6 #ifndef _NVMET_H
7 #define _NVMET_H
8
9 #include <linux/dma-mapping.h>
10 #include <linux/types.h>
11 #include <linux/device.h>
12 #include <linux/kref.h>
13 #include <linux/percpu-refcount.h>
14 #include <linux/list.h>
15 #include <linux/mutex.h>
16 #include <linux/uuid.h>
17 #include <linux/nvme.h>
18 #include <linux/configfs.h>
19 #include <linux/rcupdate.h>
20 #include <linux/blkdev.h>
21 #include <linux/radix-tree.h>
22 #include <linux/t10-pi.h>
23 #include <linux/kfifo.h>
24
25 #define NVMET_DEFAULT_VS NVME_VS(2, 1, 0)
26
27 #define NVMET_NS_ENABLED XA_MARK_1
28 #define NVMET_ASYNC_EVENTS 4
29 #define NVMET_ERROR_LOG_SLOTS 128
30 #define NVMET_NO_ERROR_LOC ((u16)-1)
31 #define NVMET_DEFAULT_CTRL_MODEL "Linux"
32 #define NVMET_MN_MAX_SIZE 40
33 #define NVMET_SN_MAX_SIZE 20
34 #define NVMET_FR_MAX_SIZE 8
35 #define NVMET_PR_LOG_QUEUE_SIZE 64
36
37 #define nvmet_for_each_ns(xa, index, entry) \
38 xa_for_each(xa, index, entry)
39
40 #define nvmet_for_each_enabled_ns(xa, index, entry) \
41 xa_for_each_marked(xa, index, entry, NVMET_NS_ENABLED)
42
43 /*
44 * Supported optional AENs:
45 */
46 #define NVMET_AEN_CFG_OPTIONAL \
47 (NVME_AEN_CFG_NS_ATTR | NVME_AEN_CFG_ANA_CHANGE)
48 #define NVMET_DISC_AEN_CFG_OPTIONAL \
49 (NVME_AEN_CFG_DISC_CHANGE)
50
51 /*
52 * Plus mandatory SMART AENs (we'll never send them, but allow enabling them):
53 */
54 #define NVMET_AEN_CFG_ALL \
55 (NVME_SMART_CRIT_SPARE | NVME_SMART_CRIT_TEMPERATURE | \
56 NVME_SMART_CRIT_RELIABILITY | NVME_SMART_CRIT_MEDIA | \
57 NVME_SMART_CRIT_VOLATILE_MEMORY | NVMET_AEN_CFG_OPTIONAL)
58
59 /* Helper Macros when NVMe error is NVME_SC_CONNECT_INVALID_PARAM
60 * The 16 bit shift is to set IATTR bit to 1, which means offending
61 * offset starts in the data section of connect()
62 */
63 #define IPO_IATTR_CONNECT_DATA(x) \
64 (cpu_to_le32((1 << 16) | (offsetof(struct nvmf_connect_data, x))))
65 #define IPO_IATTR_CONNECT_SQE(x) \
66 (cpu_to_le32(offsetof(struct nvmf_connect_command, x)))
67
68 struct nvmet_pr_registrant {
69 u64 rkey;
70 uuid_t hostid;
71 enum nvme_pr_type rtype;
72 struct list_head entry;
73 struct rcu_head rcu;
74 };
75
76 struct nvmet_pr {
77 bool enable;
78 unsigned long notify_mask;
79 atomic_t generation;
80 struct nvmet_pr_registrant __rcu *holder;
81 /*
82 * During the execution of the reservation command, mutual
83 * exclusion is required throughout the process. However,
84 * while waiting asynchronously for the 'per controller
85 * percpu_ref' to complete before the 'preempt and abort'
86 * command finishes, a semaphore is needed to ensure mutual
87 * exclusion instead of a mutex.
88 */
89 struct semaphore pr_sem;
90 struct list_head registrant_list;
91 };
92
93 struct nvmet_pr_per_ctrl_ref {
94 struct percpu_ref ref;
95 struct completion free_done;
96 struct completion confirm_done;
97 uuid_t hostid;
98 };
99
100 struct nvmet_ns {
101 struct percpu_ref ref;
102 struct file *bdev_file;
103 struct block_device *bdev;
104 struct file *file;
105 bool readonly;
106 u32 nsid;
107 u32 blksize_shift;
108 loff_t size;
109 u8 nguid[16];
110 uuid_t uuid;
111 u32 anagrpid;
112
113 bool buffered_io;
114 bool enabled;
115 struct nvmet_subsys *subsys;
116 const char *device_path;
117
118 struct config_group device_group;
119 struct config_group group;
120
121 struct completion disable_done;
122 mempool_t *bvec_pool;
123
124 struct pci_dev *p2p_dev;
125 int use_p2pmem;
126 int pi_type;
127 int metadata_size;
128 u8 csi;
129 struct nvmet_pr pr;
130 struct xarray pr_per_ctrl_refs;
131 #ifdef CONFIG_NVME_TARGET_DEBUGFS
132 struct dentry *debugfs_dir;
133 #endif
134 };
135
to_nvmet_ns(struct config_item * item)136 static inline struct nvmet_ns *to_nvmet_ns(struct config_item *item)
137 {
138 return container_of(to_config_group(item), struct nvmet_ns, group);
139 }
140
nvmet_ns_dev(struct nvmet_ns * ns)141 static inline struct device *nvmet_ns_dev(struct nvmet_ns *ns)
142 {
143 return ns->bdev ? disk_to_dev(ns->bdev->bd_disk) : NULL;
144 }
145
146 struct nvmet_cq {
147 struct nvmet_ctrl *ctrl;
148 u16 qid;
149 u16 size;
150 refcount_t ref;
151 };
152
153 struct nvmet_sq {
154 struct nvmet_ctrl *ctrl;
155 struct percpu_ref ref;
156 struct nvmet_cq *cq;
157 u16 qid;
158 u16 size;
159 u32 sqhd;
160 bool sqhd_disabled;
161 #ifdef CONFIG_NVME_TARGET_AUTH
162 bool authenticated;
163 struct delayed_work auth_expired_work;
164 u16 dhchap_tid;
165 u8 sc_c;
166 u8 dhchap_status;
167 u8 dhchap_step;
168 u8 *dhchap_c1;
169 u8 *dhchap_c2;
170 u32 dhchap_s1;
171 u32 dhchap_s2;
172 u8 *dhchap_skey;
173 int dhchap_skey_len;
174 #endif
175 #ifdef CONFIG_NVME_TARGET_TCP_TLS
176 struct key *tls_key;
177 #endif
178 struct completion free_done;
179 struct completion confirm_done;
180 };
181
182 struct nvmet_ana_group {
183 struct config_group group;
184 struct nvmet_port *port;
185 u32 grpid;
186 };
187
to_ana_group(struct config_item * item)188 static inline struct nvmet_ana_group *to_ana_group(struct config_item *item)
189 {
190 return container_of(to_config_group(item), struct nvmet_ana_group,
191 group);
192 }
193
194 /**
195 * struct nvmet_port - Common structure to keep port
196 * information for the target.
197 * @entry: Entry into referrals or transport list.
198 * @disc_addr: Address information is stored in a format defined
199 * for a discovery log page entry.
200 * @group: ConfigFS group for this element's folder.
201 * @priv: Private data for the transport.
202 */
203 struct nvmet_port {
204 struct list_head entry;
205 struct nvmf_disc_rsp_page_entry disc_addr;
206 struct config_group group;
207 struct config_group subsys_group;
208 struct list_head subsystems;
209 struct config_group referrals_group;
210 struct list_head referrals;
211 struct list_head global_entry;
212 struct config_group ana_groups_group;
213 struct nvmet_ana_group ana_default_group;
214 struct key *keyring;
215 void *priv;
216 bool enabled;
217 int inline_data_size;
218 int max_queue_size;
219 int mdts;
220 const struct nvmet_fabrics_ops *tr_ops;
221 bool pi_enable;
222 enum nvme_ana_state ana_state[];
223 };
224
to_nvmet_port(struct config_item * item)225 static inline struct nvmet_port *to_nvmet_port(struct config_item *item)
226 {
227 return container_of(to_config_group(item), struct nvmet_port,
228 group);
229 }
230
ana_groups_to_port(struct config_item * item)231 static inline struct nvmet_port *ana_groups_to_port(
232 struct config_item *item)
233 {
234 return container_of(to_config_group(item), struct nvmet_port,
235 ana_groups_group);
236 }
237
nvmet_port_disc_addr_treq_secure_channel(struct nvmet_port * port)238 static inline u8 nvmet_port_disc_addr_treq_secure_channel(struct nvmet_port *port)
239 {
240 return (port->disc_addr.treq & NVME_TREQ_SECURE_CHANNEL_MASK);
241 }
242
nvmet_port_secure_channel_required(struct nvmet_port * port)243 static inline bool nvmet_port_secure_channel_required(struct nvmet_port *port)
244 {
245 return nvmet_port_disc_addr_treq_secure_channel(port) == NVMF_TREQ_REQUIRED;
246 }
247
248 struct nvmet_pr_log_mgr {
249 struct mutex lock;
250 u64 lost_count;
251 u64 counter;
252 DECLARE_KFIFO(log_queue, struct nvme_pr_log, NVMET_PR_LOG_QUEUE_SIZE);
253 };
254
255 struct nvmet_ctrl {
256 struct nvmet_subsys *subsys;
257 struct nvmet_sq **sqs;
258 struct nvmet_cq **cqs;
259
260 void *drvdata;
261
262 bool reset_tbkas;
263
264 struct mutex lock;
265 u64 cap;
266 u32 cc;
267 u32 csts;
268
269 uuid_t hostid;
270 u16 cntlid;
271 u16 max_qid;
272 u32 kato;
273
274 struct nvmet_port *port;
275
276 u32 aen_enabled;
277 unsigned long aen_masked;
278 struct nvmet_req *async_event_cmds[NVMET_ASYNC_EVENTS];
279 unsigned int nr_async_event_cmds;
280 struct list_head async_events;
281 struct work_struct async_event_work;
282
283 struct list_head subsys_entry;
284 struct kref ref;
285 struct delayed_work ka_work;
286 struct work_struct fatal_err_work;
287
288 const struct nvmet_fabrics_ops *ops;
289
290 __le32 *changed_ns_list;
291 u32 nr_changed_ns;
292
293 char hostnqn[NVMF_NQN_FIELD_LEN];
294
295 struct device *p2p_client;
296 struct radix_tree_root p2p_ns_map;
297 #ifdef CONFIG_NVME_TARGET_DEBUGFS
298 struct dentry *debugfs_dir;
299 #endif
300 spinlock_t error_lock;
301 u64 err_counter;
302 struct nvme_error_slot slots[NVMET_ERROR_LOG_SLOTS];
303 bool pi_support;
304 bool concat;
305 #ifdef CONFIG_NVME_TARGET_AUTH
306 struct nvme_dhchap_key *host_key;
307 struct nvme_dhchap_key *ctrl_key;
308 u8 shash_id;
309 struct crypto_kpp *dh_tfm;
310 u8 dh_gid;
311 u8 *dh_key;
312 size_t dh_keysize;
313 #endif
314 #ifdef CONFIG_NVME_TARGET_TCP_TLS
315 struct key *tls_key;
316 #endif
317 struct nvmet_pr_log_mgr pr_log_mgr;
318 };
319
320 struct nvmet_subsys {
321 enum nvme_subsys_type type;
322
323 struct mutex lock;
324 struct kref ref;
325
326 struct xarray namespaces;
327 unsigned int nr_namespaces;
328 u32 max_nsid;
329 u16 cntlid_min;
330 u16 cntlid_max;
331
332 struct list_head ctrls;
333
334 struct list_head hosts;
335 bool allow_any_host;
336 #ifdef CONFIG_NVME_TARGET_DEBUGFS
337 struct dentry *debugfs_dir;
338 #endif
339 u16 max_qid;
340
341 u64 ver;
342 char serial[NVMET_SN_MAX_SIZE];
343 bool subsys_discovered;
344 char *subsysnqn;
345 bool pi_support;
346
347 struct config_group group;
348
349 struct config_group namespaces_group;
350 struct config_group allowed_hosts_group;
351
352 u16 vendor_id;
353 u16 subsys_vendor_id;
354 char *model_number;
355 u32 ieee_oui;
356 char *firmware_rev;
357
358 #ifdef CONFIG_NVME_TARGET_PASSTHRU
359 struct nvme_ctrl *passthru_ctrl;
360 char *passthru_ctrl_path;
361 struct config_group passthru_group;
362 unsigned int admin_timeout;
363 unsigned int io_timeout;
364 unsigned int clear_ids;
365 #endif /* CONFIG_NVME_TARGET_PASSTHRU */
366
367 #ifdef CONFIG_BLK_DEV_ZONED
368 u8 zasl;
369 #endif /* CONFIG_BLK_DEV_ZONED */
370 };
371
to_subsys(struct config_item * item)372 static inline struct nvmet_subsys *to_subsys(struct config_item *item)
373 {
374 return container_of(to_config_group(item), struct nvmet_subsys, group);
375 }
376
namespaces_to_subsys(struct config_item * item)377 static inline struct nvmet_subsys *namespaces_to_subsys(
378 struct config_item *item)
379 {
380 return container_of(to_config_group(item), struct nvmet_subsys,
381 namespaces_group);
382 }
383
384 struct nvmet_host {
385 struct config_group group;
386 u8 *dhchap_secret;
387 u8 *dhchap_ctrl_secret;
388 u8 dhchap_key_hash;
389 u8 dhchap_ctrl_key_hash;
390 u8 dhchap_hash_id;
391 u8 dhchap_dhgroup_id;
392 };
393
to_host(struct config_item * item)394 static inline struct nvmet_host *to_host(struct config_item *item)
395 {
396 return container_of(to_config_group(item), struct nvmet_host, group);
397 }
398
nvmet_host_name(struct nvmet_host * host)399 static inline char *nvmet_host_name(struct nvmet_host *host)
400 {
401 return config_item_name(&host->group.cg_item);
402 }
403
404 struct nvmet_host_link {
405 struct list_head entry;
406 struct nvmet_host *host;
407 };
408
409 struct nvmet_subsys_link {
410 struct list_head entry;
411 struct nvmet_subsys *subsys;
412 };
413
414 struct nvmet_req;
415 struct nvmet_fabrics_ops {
416 struct module *owner;
417 unsigned int type;
418 unsigned int msdbd;
419 unsigned int flags;
420 #define NVMF_KEYED_SGLS (1 << 0)
421 #define NVMF_METADATA_SUPPORTED (1 << 1)
422 void (*queue_response)(struct nvmet_req *req);
423 int (*add_port)(struct nvmet_port *port);
424 void (*remove_port)(struct nvmet_port *port);
425 void (*delete_ctrl)(struct nvmet_ctrl *ctrl);
426 void (*disc_traddr)(struct nvmet_req *req,
427 struct nvmet_port *port, char *traddr);
428 ssize_t (*host_traddr)(struct nvmet_ctrl *ctrl,
429 char *traddr, size_t traddr_len);
430 u16 (*install_queue)(struct nvmet_sq *nvme_sq);
431 void (*discovery_chg)(struct nvmet_port *port);
432 u8 (*get_mdts)(const struct nvmet_ctrl *ctrl);
433 u16 (*get_max_queue_size)(const struct nvmet_ctrl *ctrl);
434
435 /* Operations mandatory for PCI target controllers */
436 u16 (*create_sq)(struct nvmet_ctrl *ctrl, u16 sqid, u16 cqid, u16 flags,
437 u16 qsize, u64 prp1);
438 u16 (*delete_sq)(struct nvmet_ctrl *ctrl, u16 sqid);
439 u16 (*create_cq)(struct nvmet_ctrl *ctrl, u16 cqid, u16 flags,
440 u16 qsize, u64 prp1, u16 irq_vector);
441 u16 (*delete_cq)(struct nvmet_ctrl *ctrl, u16 cqid);
442 u16 (*set_feature)(const struct nvmet_ctrl *ctrl, u8 feat,
443 void *feat_data);
444 u16 (*get_feature)(const struct nvmet_ctrl *ctrl, u8 feat,
445 void *feat_data);
446 };
447
448 #define NVMET_MAX_INLINE_BIOVEC 8
449 #define NVMET_MAX_INLINE_DATA_LEN NVMET_MAX_INLINE_BIOVEC * PAGE_SIZE
450
451 struct nvmet_req {
452 struct nvme_command *cmd;
453 struct nvme_completion *cqe;
454 struct nvmet_sq *sq;
455 struct nvmet_cq *cq;
456 struct nvmet_ns *ns;
457 struct scatterlist *sg;
458 struct scatterlist *metadata_sg;
459 struct bio_vec inline_bvec[NVMET_MAX_INLINE_BIOVEC];
460 union {
461 struct {
462 struct bio inline_bio;
463 } b;
464 struct {
465 bool mpool_alloc;
466 struct kiocb iocb;
467 struct bio_vec *bvec;
468 struct work_struct work;
469 } f;
470 struct {
471 struct bio inline_bio;
472 struct request *rq;
473 struct work_struct work;
474 bool use_workqueue;
475 } p;
476 #ifdef CONFIG_BLK_DEV_ZONED
477 struct {
478 struct bio inline_bio;
479 struct work_struct zmgmt_work;
480 } z;
481 #endif /* CONFIG_BLK_DEV_ZONED */
482 struct {
483 struct work_struct abort_work;
484 } r;
485 };
486 int sg_cnt;
487 int metadata_sg_cnt;
488 /* data length as parsed from the SGL descriptor: */
489 size_t transfer_len;
490 size_t metadata_len;
491
492 struct nvmet_port *port;
493
494 void (*execute)(struct nvmet_req *req);
495 const struct nvmet_fabrics_ops *ops;
496
497 struct pci_dev *p2p_dev;
498 struct device *p2p_client;
499 u16 error_loc;
500 u64 error_slba;
501 struct nvmet_pr_per_ctrl_ref *pc_ref;
502 };
503
504 #define NVMET_MAX_MPOOL_BVEC 16
505 extern struct kmem_cache *nvmet_bvec_cache;
506 extern struct workqueue_struct *buffered_io_wq;
507 extern struct workqueue_struct *zbd_wq;
508 extern struct workqueue_struct *nvmet_wq;
509 extern struct workqueue_struct *nvmet_aen_wq;
510
nvmet_set_result(struct nvmet_req * req,u32 result)511 static inline void nvmet_set_result(struct nvmet_req *req, u32 result)
512 {
513 req->cqe->result.u32 = cpu_to_le32(result);
514 }
515
516 /*
517 * NVMe command writes actually are DMA reads for us on the target side.
518 */
519 static inline enum dma_data_direction
nvmet_data_dir(struct nvmet_req * req)520 nvmet_data_dir(struct nvmet_req *req)
521 {
522 return nvme_is_write(req->cmd) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
523 }
524
525 struct nvmet_async_event {
526 struct list_head entry;
527 u8 event_type;
528 u8 event_info;
529 u8 log_page;
530 };
531
nvmet_clear_aen_bit(struct nvmet_req * req,u32 bn)532 static inline void nvmet_clear_aen_bit(struct nvmet_req *req, u32 bn)
533 {
534 int rae = le32_to_cpu(req->cmd->common.cdw10) & 1 << 15;
535
536 if (!rae)
537 clear_bit(bn, &req->sq->ctrl->aen_masked);
538 }
539
nvmet_aen_bit_disabled(struct nvmet_ctrl * ctrl,u32 bn)540 static inline bool nvmet_aen_bit_disabled(struct nvmet_ctrl *ctrl, u32 bn)
541 {
542 if (!(READ_ONCE(ctrl->aen_enabled) & (1 << bn)))
543 return true;
544 return test_and_set_bit(bn, &ctrl->aen_masked);
545 }
546
547 void nvmet_get_feat_kato(struct nvmet_req *req);
548 void nvmet_get_feat_async_event(struct nvmet_req *req);
549 u16 nvmet_set_feat_kato(struct nvmet_req *req);
550 u16 nvmet_set_feat_async_event(struct nvmet_req *req, u32 mask);
551 void nvmet_execute_async_event(struct nvmet_req *req);
552 void nvmet_start_keep_alive_timer(struct nvmet_ctrl *ctrl);
553 void nvmet_stop_keep_alive_timer(struct nvmet_ctrl *ctrl);
554
555 u16 nvmet_parse_connect_cmd(struct nvmet_req *req);
556 u32 nvmet_connect_cmd_data_len(struct nvmet_req *req);
557 void nvmet_bdev_set_limits(struct block_device *bdev, struct nvme_id_ns *id);
558 void nvmet_bdev_set_nvm_limits(struct block_device *bdev,
559 struct nvme_id_ns_nvm *id);
560 u16 nvmet_bdev_parse_io_cmd(struct nvmet_req *req);
561 u16 nvmet_file_parse_io_cmd(struct nvmet_req *req);
562 u16 nvmet_bdev_zns_parse_io_cmd(struct nvmet_req *req);
563 u32 nvmet_admin_cmd_data_len(struct nvmet_req *req);
564 u16 nvmet_parse_admin_cmd(struct nvmet_req *req);
565 u32 nvmet_discovery_cmd_data_len(struct nvmet_req *req);
566 u16 nvmet_parse_discovery_cmd(struct nvmet_req *req);
567 u16 nvmet_parse_fabrics_admin_cmd(struct nvmet_req *req);
568 u32 nvmet_fabrics_admin_cmd_data_len(struct nvmet_req *req);
569 u16 nvmet_parse_fabrics_io_cmd(struct nvmet_req *req);
570 u32 nvmet_fabrics_io_cmd_data_len(struct nvmet_req *req);
571
572 bool nvmet_req_init(struct nvmet_req *req, struct nvmet_sq *sq,
573 const struct nvmet_fabrics_ops *ops);
574 void nvmet_req_uninit(struct nvmet_req *req);
575 size_t nvmet_req_transfer_len(struct nvmet_req *req);
576 bool nvmet_check_transfer_len(struct nvmet_req *req, size_t len);
577 bool nvmet_check_data_len_lte(struct nvmet_req *req, size_t data_len);
578 void nvmet_req_complete(struct nvmet_req *req, u16 status);
579 int nvmet_req_alloc_sgls(struct nvmet_req *req);
580 void nvmet_req_free_sgls(struct nvmet_req *req);
581
582 void nvmet_execute_set_features(struct nvmet_req *req);
583 void nvmet_execute_get_features(struct nvmet_req *req);
584 void nvmet_execute_keep_alive(struct nvmet_req *req);
585
586 u16 nvmet_check_cqid(struct nvmet_ctrl *ctrl, u16 cqid, bool create);
587 u16 nvmet_check_io_cqid(struct nvmet_ctrl *ctrl, u16 cqid, bool create);
588 void nvmet_cq_init(struct nvmet_cq *cq);
589 void nvmet_cq_setup(struct nvmet_ctrl *ctrl, struct nvmet_cq *cq, u16 qid,
590 u16 size);
591 u16 nvmet_cq_create(struct nvmet_ctrl *ctrl, struct nvmet_cq *cq, u16 qid,
592 u16 size);
593 void nvmet_cq_destroy(struct nvmet_cq *cq);
594 bool nvmet_cq_get(struct nvmet_cq *cq);
595 void nvmet_cq_put(struct nvmet_cq *cq);
596 bool nvmet_cq_in_use(struct nvmet_cq *cq);
597 u16 nvmet_check_sqid(struct nvmet_ctrl *ctrl, u16 sqid, bool create);
598 void nvmet_sq_setup(struct nvmet_ctrl *ctrl, struct nvmet_sq *sq, u16 qid,
599 u16 size);
600 u16 nvmet_sq_create(struct nvmet_ctrl *ctrl, struct nvmet_sq *sq,
601 struct nvmet_cq *cq, u16 qid, u16 size);
602 void nvmet_sq_destroy(struct nvmet_sq *sq);
603 int nvmet_sq_init(struct nvmet_sq *sq, struct nvmet_cq *cq);
604
605 void nvmet_ctrl_fatal_error(struct nvmet_ctrl *ctrl);
606
607 void nvmet_update_cc(struct nvmet_ctrl *ctrl, u32 new);
608
609 struct nvmet_alloc_ctrl_args {
610 struct nvmet_port *port;
611 struct nvmet_sq *sq;
612 char *subsysnqn;
613 char *hostnqn;
614 uuid_t *hostid;
615 const struct nvmet_fabrics_ops *ops;
616 struct device *p2p_client;
617 u32 kato;
618 __le32 result;
619 u16 error_loc;
620 u16 status;
621 };
622
623 struct nvmet_ctrl *nvmet_alloc_ctrl(struct nvmet_alloc_ctrl_args *args);
624 struct nvmet_ctrl *nvmet_ctrl_find_get(const char *subsysnqn,
625 const char *hostnqn, u16 cntlid,
626 struct nvmet_req *req);
627 void nvmet_ctrl_put(struct nvmet_ctrl *ctrl);
628 u16 nvmet_check_ctrl_status(struct nvmet_req *req);
629 ssize_t nvmet_ctrl_host_traddr(struct nvmet_ctrl *ctrl,
630 char *traddr, size_t traddr_len);
631
632 struct nvmet_subsys *nvmet_subsys_alloc(const char *subsysnqn,
633 enum nvme_subsys_type type);
634 void nvmet_subsys_put(struct nvmet_subsys *subsys);
635 void nvmet_subsys_del_ctrls(struct nvmet_subsys *subsys);
636
637 u16 nvmet_req_find_ns(struct nvmet_req *req);
638 void nvmet_put_namespace(struct nvmet_ns *ns);
639 int nvmet_ns_enable(struct nvmet_ns *ns);
640 void nvmet_ns_disable(struct nvmet_ns *ns);
641 struct nvmet_ns *nvmet_ns_alloc(struct nvmet_subsys *subsys, u32 nsid);
642 void nvmet_ns_free(struct nvmet_ns *ns);
643
644 void nvmet_send_ana_event(struct nvmet_subsys *subsys,
645 struct nvmet_port *port);
646 void nvmet_port_send_ana_event(struct nvmet_port *port);
647
648 int nvmet_register_transport(const struct nvmet_fabrics_ops *ops);
649 void nvmet_unregister_transport(const struct nvmet_fabrics_ops *ops);
650
651 void nvmet_port_del_ctrls(struct nvmet_port *port,
652 struct nvmet_subsys *subsys);
653
654 int nvmet_enable_port(struct nvmet_port *port);
655 void nvmet_disable_port(struct nvmet_port *port);
656
657 void nvmet_referral_enable(struct nvmet_port *parent, struct nvmet_port *port);
658 void nvmet_referral_disable(struct nvmet_port *parent, struct nvmet_port *port);
659
660 u16 nvmet_copy_to_sgl(struct nvmet_req *req, off_t off, const void *buf,
661 size_t len);
662 u16 nvmet_copy_from_sgl(struct nvmet_req *req, off_t off, void *buf,
663 size_t len);
664 u16 nvmet_zero_sgl(struct nvmet_req *req, off_t off, size_t len);
665
666 u32 nvmet_get_log_page_len(struct nvme_command *cmd);
667 u64 nvmet_get_log_page_offset(struct nvme_command *cmd);
668
669 extern struct list_head *nvmet_ports;
670 void nvmet_port_disc_changed(struct nvmet_port *port,
671 struct nvmet_subsys *subsys);
672 void nvmet_subsys_disc_changed(struct nvmet_subsys *subsys,
673 struct nvmet_host *host);
674 void nvmet_add_async_event(struct nvmet_ctrl *ctrl, u8 event_type,
675 u8 event_info, u8 log_page);
676
677 #define NVMET_MIN_QUEUE_SIZE 16
678 #define NVMET_MAX_QUEUE_SIZE 1024
679 #define NVMET_NR_QUEUES 128
680 #define NVMET_MAX_CMD(ctrl) (NVME_CAP_MQES(ctrl->cap) + 1)
681 #define NVMET_MAX_MDTS 255
682
683 /*
684 * Nice round number that makes a list of nsids fit into a page.
685 * Should become tunable at some point in the future.
686 */
687 #define NVMET_MAX_NAMESPACES 1024
688
689 /*
690 * 0 is not a valid ANA group ID, so we start numbering at 1.
691 *
692 * ANA Group 1 exists without manual intervention, has namespaces assigned to it
693 * by default, and is available in an optimized state through all ports.
694 */
695 #define NVMET_MAX_ANAGRPS 128
696 #define NVMET_DEFAULT_ANA_GRPID 1
697
698 #define NVMET_KAS 10
699 #define NVMET_DISC_KATO_MS 120000
700
701 int __init nvmet_init_configfs(void);
702 void __exit nvmet_exit_configfs(void);
703
704 int __init nvmet_init_discovery(void);
705 void nvmet_exit_discovery(void);
706
707 extern struct nvmet_subsys *nvmet_disc_subsys;
708 extern struct rw_semaphore nvmet_config_sem;
709
710 extern u32 nvmet_ana_group_enabled[NVMET_MAX_ANAGRPS + 1];
711 extern u64 nvmet_ana_chgcnt;
712 extern struct rw_semaphore nvmet_ana_sem;
713
714 bool nvmet_host_allowed(struct nvmet_subsys *subsys, const char *hostnqn);
715
716 int nvmet_bdev_ns_enable(struct nvmet_ns *ns);
717 int nvmet_file_ns_enable(struct nvmet_ns *ns);
718 void nvmet_bdev_ns_disable(struct nvmet_ns *ns);
719 void nvmet_file_ns_disable(struct nvmet_ns *ns);
720 u16 nvmet_bdev_flush(struct nvmet_req *req);
721 u16 nvmet_file_flush(struct nvmet_req *req);
722 void nvmet_ns_changed(struct nvmet_subsys *subsys, u32 nsid);
723 void nvmet_bdev_ns_revalidate(struct nvmet_ns *ns);
724 void nvmet_file_ns_revalidate(struct nvmet_ns *ns);
725 bool nvmet_ns_revalidate(struct nvmet_ns *ns);
726 u16 blk_to_nvme_status(struct nvmet_req *req, blk_status_t blk_sts);
727
728 bool nvmet_bdev_zns_enable(struct nvmet_ns *ns);
729 void nvmet_execute_identify_ctrl_zns(struct nvmet_req *req);
730 void nvmet_execute_identify_ns_zns(struct nvmet_req *req);
731 void nvmet_bdev_execute_zone_mgmt_recv(struct nvmet_req *req);
732 void nvmet_bdev_execute_zone_mgmt_send(struct nvmet_req *req);
733 void nvmet_bdev_execute_zone_append(struct nvmet_req *req);
734
nvmet_rw_data_len(struct nvmet_req * req)735 static inline u32 nvmet_rw_data_len(struct nvmet_req *req)
736 {
737 return ((u32)le16_to_cpu(req->cmd->rw.length) + 1) <<
738 req->ns->blksize_shift;
739 }
740
nvmet_rw_metadata_len(struct nvmet_req * req)741 static inline u32 nvmet_rw_metadata_len(struct nvmet_req *req)
742 {
743 if (!IS_ENABLED(CONFIG_BLK_DEV_INTEGRITY))
744 return 0;
745 return ((u32)le16_to_cpu(req->cmd->rw.length) + 1) *
746 req->ns->metadata_size;
747 }
748
nvmet_dsm_len(struct nvmet_req * req)749 static inline u32 nvmet_dsm_len(struct nvmet_req *req)
750 {
751 return (le32_to_cpu(req->cmd->dsm.nr) + 1) *
752 sizeof(struct nvme_dsm_range);
753 }
754
nvmet_req_subsys(struct nvmet_req * req)755 static inline struct nvmet_subsys *nvmet_req_subsys(struct nvmet_req *req)
756 {
757 return req->sq->ctrl->subsys;
758 }
759
nvmet_req_ctrl(struct nvmet_req * req)760 static inline struct nvmet_ctrl *nvmet_req_ctrl(struct nvmet_req *req)
761 {
762 return req->sq->ctrl;
763 }
764
nvmet_is_disc_subsys(struct nvmet_subsys * subsys)765 static inline bool nvmet_is_disc_subsys(struct nvmet_subsys *subsys)
766 {
767 return subsys->type != NVME_NQN_NVME;
768 }
769
nvmet_is_pci_ctrl(struct nvmet_ctrl * ctrl)770 static inline bool nvmet_is_pci_ctrl(struct nvmet_ctrl *ctrl)
771 {
772 return ctrl->port->disc_addr.trtype == NVMF_TRTYPE_PCI;
773 }
774
775 /* Limit MDTS according to port config or transport capability */
nvmet_ctrl_mdts(struct nvmet_req * req)776 static inline u8 nvmet_ctrl_mdts(struct nvmet_req *req)
777 {
778 struct nvmet_ctrl *ctrl = req->sq->ctrl;
779 u8 mdts = req->port->mdts;
780
781 if (!ctrl->ops->get_mdts)
782 return mdts;
783 return min_not_zero(ctrl->ops->get_mdts(ctrl), mdts);
784 }
785
786 #ifdef CONFIG_NVME_TARGET_PASSTHRU
787 void nvmet_passthru_subsys_free(struct nvmet_subsys *subsys);
788 int nvmet_passthru_ctrl_enable(struct nvmet_subsys *subsys);
789 void nvmet_passthru_ctrl_disable(struct nvmet_subsys *subsys);
790 u16 nvmet_parse_passthru_admin_cmd(struct nvmet_req *req);
791 u16 nvmet_parse_passthru_io_cmd(struct nvmet_req *req);
nvmet_is_passthru_subsys(struct nvmet_subsys * subsys)792 static inline bool nvmet_is_passthru_subsys(struct nvmet_subsys *subsys)
793 {
794 return subsys->passthru_ctrl;
795 }
796 #else /* CONFIG_NVME_TARGET_PASSTHRU */
nvmet_passthru_subsys_free(struct nvmet_subsys * subsys)797 static inline void nvmet_passthru_subsys_free(struct nvmet_subsys *subsys)
798 {
799 }
nvmet_passthru_ctrl_disable(struct nvmet_subsys * subsys)800 static inline void nvmet_passthru_ctrl_disable(struct nvmet_subsys *subsys)
801 {
802 }
nvmet_parse_passthru_admin_cmd(struct nvmet_req * req)803 static inline u16 nvmet_parse_passthru_admin_cmd(struct nvmet_req *req)
804 {
805 return 0;
806 }
nvmet_parse_passthru_io_cmd(struct nvmet_req * req)807 static inline u16 nvmet_parse_passthru_io_cmd(struct nvmet_req *req)
808 {
809 return 0;
810 }
nvmet_is_passthru_subsys(struct nvmet_subsys * subsys)811 static inline bool nvmet_is_passthru_subsys(struct nvmet_subsys *subsys)
812 {
813 return NULL;
814 }
815 #endif /* CONFIG_NVME_TARGET_PASSTHRU */
816
nvmet_is_passthru_req(struct nvmet_req * req)817 static inline bool nvmet_is_passthru_req(struct nvmet_req *req)
818 {
819 return nvmet_is_passthru_subsys(nvmet_req_subsys(req));
820 }
821
822 void nvmet_passthrough_override_cap(struct nvmet_ctrl *ctrl);
823
824 u16 errno_to_nvme_status(struct nvmet_req *req, int errno);
825 u16 nvmet_report_invalid_opcode(struct nvmet_req *req);
826
nvmet_cc_en(u32 cc)827 static inline bool nvmet_cc_en(u32 cc)
828 {
829 return (cc & NVME_CC_ENABLE) >> NVME_CC_EN_SHIFT;
830 }
831
nvmet_cc_css(u32 cc)832 static inline u8 nvmet_cc_css(u32 cc)
833 {
834 return (cc & NVME_CC_CSS_MASK) >> NVME_CC_CSS_SHIFT;
835 }
836
nvmet_cc_mps(u32 cc)837 static inline u8 nvmet_cc_mps(u32 cc)
838 {
839 return (cc & NVME_CC_MPS_MASK) >> NVME_CC_MPS_SHIFT;
840 }
841
nvmet_cc_ams(u32 cc)842 static inline u8 nvmet_cc_ams(u32 cc)
843 {
844 return (cc & NVME_CC_AMS_MASK) >> NVME_CC_AMS_SHIFT;
845 }
846
nvmet_cc_shn(u32 cc)847 static inline u8 nvmet_cc_shn(u32 cc)
848 {
849 return (cc & NVME_CC_SHN_MASK) >> NVME_CC_SHN_SHIFT;
850 }
851
nvmet_cc_iosqes(u32 cc)852 static inline u8 nvmet_cc_iosqes(u32 cc)
853 {
854 return (cc & NVME_CC_IOSQES_MASK) >> NVME_CC_IOSQES_SHIFT;
855 }
856
nvmet_cc_iocqes(u32 cc)857 static inline u8 nvmet_cc_iocqes(u32 cc)
858 {
859 return (cc & NVME_CC_IOCQES_MASK) >> NVME_CC_IOCQES_SHIFT;
860 }
861
862 /* Convert a 32-bit number to a 16-bit 0's based number */
to0based(u32 a)863 static inline __le16 to0based(u32 a)
864 {
865 return cpu_to_le16(clamp(a, 1U, 1U << 16) - 1);
866 }
867
nvmet_ns_has_pi(struct nvmet_ns * ns)868 static inline bool nvmet_ns_has_pi(struct nvmet_ns *ns)
869 {
870 if (!IS_ENABLED(CONFIG_BLK_DEV_INTEGRITY))
871 return false;
872 return ns->pi_type && ns->metadata_size == sizeof(struct t10_pi_tuple);
873 }
874
nvmet_sect_to_lba(struct nvmet_ns * ns,sector_t sect)875 static inline __le64 nvmet_sect_to_lba(struct nvmet_ns *ns, sector_t sect)
876 {
877 return cpu_to_le64(sect >> (ns->blksize_shift - SECTOR_SHIFT));
878 }
879
nvmet_lba_to_sect(struct nvmet_ns * ns,__le64 lba)880 static inline sector_t nvmet_lba_to_sect(struct nvmet_ns *ns, __le64 lba)
881 {
882 return le64_to_cpu(lba) << (ns->blksize_shift - SECTOR_SHIFT);
883 }
884
nvmet_use_inline_bvec(struct nvmet_req * req)885 static inline bool nvmet_use_inline_bvec(struct nvmet_req *req)
886 {
887 return req->transfer_len <= NVMET_MAX_INLINE_DATA_LEN &&
888 req->sg_cnt <= NVMET_MAX_INLINE_BIOVEC;
889 }
890
nvmet_req_bio_put(struct nvmet_req * req,struct bio * bio)891 static inline void nvmet_req_bio_put(struct nvmet_req *req, struct bio *bio)
892 {
893 if (bio != &req->b.inline_bio)
894 bio_put(bio);
895 else
896 bio_uninit(bio);
897 }
898
899 #ifdef CONFIG_NVME_TARGET_TCP_TLS
nvmet_queue_tls_keyid(struct nvmet_sq * sq)900 static inline key_serial_t nvmet_queue_tls_keyid(struct nvmet_sq *sq)
901 {
902 return sq->tls_key ? key_serial(sq->tls_key) : 0;
903 }
nvmet_sq_put_tls_key(struct nvmet_sq * sq)904 static inline void nvmet_sq_put_tls_key(struct nvmet_sq *sq)
905 {
906 if (sq->tls_key) {
907 key_put(sq->tls_key);
908 sq->tls_key = NULL;
909 }
910 }
911 #else
nvmet_queue_tls_keyid(struct nvmet_sq * sq)912 static inline key_serial_t nvmet_queue_tls_keyid(struct nvmet_sq *sq) { return 0; }
nvmet_sq_put_tls_key(struct nvmet_sq * sq)913 static inline void nvmet_sq_put_tls_key(struct nvmet_sq *sq) {}
914 #endif
915 #ifdef CONFIG_NVME_TARGET_AUTH
916 u32 nvmet_auth_send_data_len(struct nvmet_req *req);
917 void nvmet_execute_auth_send(struct nvmet_req *req);
918 u32 nvmet_auth_receive_data_len(struct nvmet_req *req);
919 void nvmet_execute_auth_receive(struct nvmet_req *req);
920 int nvmet_auth_set_key(struct nvmet_host *host, const char *secret,
921 bool set_ctrl);
922 int nvmet_auth_set_host_hash(struct nvmet_host *host, const char *hash);
923 u8 nvmet_setup_auth(struct nvmet_ctrl *ctrl, struct nvmet_sq *sq, bool reset);
924 void nvmet_auth_sq_init(struct nvmet_sq *sq);
925 void nvmet_destroy_auth(struct nvmet_ctrl *ctrl);
926 void nvmet_auth_sq_free(struct nvmet_sq *sq);
927 int nvmet_setup_dhgroup(struct nvmet_ctrl *ctrl, u8 dhgroup_id);
928 bool nvmet_check_auth_status(struct nvmet_req *req);
929 int nvmet_auth_host_hash(struct nvmet_req *req, u8 *response,
930 unsigned int hash_len);
931 int nvmet_auth_ctrl_hash(struct nvmet_req *req, u8 *response,
932 unsigned int hash_len);
nvmet_has_auth(struct nvmet_ctrl * ctrl,struct nvmet_sq * sq)933 static inline bool nvmet_has_auth(struct nvmet_ctrl *ctrl, struct nvmet_sq *sq)
934 {
935 return ctrl->host_key != NULL && !nvmet_queue_tls_keyid(sq);
936 }
937 int nvmet_auth_ctrl_exponential(struct nvmet_req *req,
938 u8 *buf, int buf_size);
939 int nvmet_auth_ctrl_sesskey(struct nvmet_req *req,
940 const u8 *pkey, int pkey_size);
941 void nvmet_auth_insert_psk(struct nvmet_sq *sq);
942 #else
nvmet_setup_auth(struct nvmet_ctrl * ctrl,struct nvmet_sq * sq,bool reset)943 static inline u8 nvmet_setup_auth(struct nvmet_ctrl *ctrl,
944 struct nvmet_sq *sq, bool reset)
945 {
946 return 0;
947 }
nvmet_auth_sq_init(struct nvmet_sq * sq)948 static inline void nvmet_auth_sq_init(struct nvmet_sq *sq)
949 {
950 }
nvmet_destroy_auth(struct nvmet_ctrl * ctrl)951 static inline void nvmet_destroy_auth(struct nvmet_ctrl *ctrl) {};
nvmet_auth_sq_free(struct nvmet_sq * sq)952 static inline void nvmet_auth_sq_free(struct nvmet_sq *sq) {};
nvmet_check_auth_status(struct nvmet_req * req)953 static inline bool nvmet_check_auth_status(struct nvmet_req *req)
954 {
955 return true;
956 }
nvmet_has_auth(struct nvmet_ctrl * ctrl,struct nvmet_sq * sq)957 static inline bool nvmet_has_auth(struct nvmet_ctrl *ctrl,
958 struct nvmet_sq *sq)
959 {
960 return false;
961 }
nvmet_dhchap_dhgroup_name(u8 dhgid)962 static inline const char *nvmet_dhchap_dhgroup_name(u8 dhgid) { return NULL; }
nvmet_auth_insert_psk(struct nvmet_sq * sq)963 static inline void nvmet_auth_insert_psk(struct nvmet_sq *sq) {};
964 #endif
965
966 int nvmet_pr_init_ns(struct nvmet_ns *ns);
967 u16 nvmet_parse_pr_cmd(struct nvmet_req *req);
968 u16 nvmet_pr_check_cmd_access(struct nvmet_req *req);
969 int nvmet_ctrl_init_pr(struct nvmet_ctrl *ctrl);
970 void nvmet_ctrl_destroy_pr(struct nvmet_ctrl *ctrl);
971 void nvmet_pr_exit_ns(struct nvmet_ns *ns);
972 void nvmet_execute_get_log_page_resv(struct nvmet_req *req);
973 u16 nvmet_set_feat_resv_notif_mask(struct nvmet_req *req, u32 mask);
974 u16 nvmet_get_feat_resv_notif_mask(struct nvmet_req *req);
975 u16 nvmet_pr_get_ns_pc_ref(struct nvmet_req *req);
nvmet_pr_put_ns_pc_ref(struct nvmet_pr_per_ctrl_ref * pc_ref)976 static inline void nvmet_pr_put_ns_pc_ref(struct nvmet_pr_per_ctrl_ref *pc_ref)
977 {
978 percpu_ref_put(&pc_ref->ref);
979 }
980
981 /*
982 * Data for the get_feature() and set_feature() operations of PCI target
983 * controllers.
984 */
985 struct nvmet_feat_irq_coalesce {
986 u8 thr;
987 u8 time;
988 };
989
990 struct nvmet_feat_irq_config {
991 u16 iv;
992 bool cd;
993 };
994
995 struct nvmet_feat_arbitration {
996 u8 hpw;
997 u8 mpw;
998 u8 lpw;
999 u8 ab;
1000 };
1001
1002 #endif /* _NVMET_H */
1003