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
24 #define NVMET_DEFAULT_VS NVME_VS(1, 3, 0)
25
26 #define NVMET_ASYNC_EVENTS 4
27 #define NVMET_ERROR_LOG_SLOTS 128
28 #define NVMET_NO_ERROR_LOC ((u16)-1)
29 #define NVMET_DEFAULT_CTRL_MODEL "Linux"
30 #define NVMET_MN_MAX_SIZE 40
31 #define NVMET_SN_MAX_SIZE 20
32
33 /*
34 * Supported optional AENs:
35 */
36 #define NVMET_AEN_CFG_OPTIONAL \
37 (NVME_AEN_CFG_NS_ATTR | NVME_AEN_CFG_ANA_CHANGE)
38 #define NVMET_DISC_AEN_CFG_OPTIONAL \
39 (NVME_AEN_CFG_DISC_CHANGE)
40
41 /*
42 * Plus mandatory SMART AENs (we'll never send them, but allow enabling them):
43 */
44 #define NVMET_AEN_CFG_ALL \
45 (NVME_SMART_CRIT_SPARE | NVME_SMART_CRIT_TEMPERATURE | \
46 NVME_SMART_CRIT_RELIABILITY | NVME_SMART_CRIT_MEDIA | \
47 NVME_SMART_CRIT_VOLATILE_MEMORY | NVMET_AEN_CFG_OPTIONAL)
48
49 /* Helper Macros when NVMe error is NVME_SC_CONNECT_INVALID_PARAM
50 * The 16 bit shift is to set IATTR bit to 1, which means offending
51 * offset starts in the data section of connect()
52 */
53 #define IPO_IATTR_CONNECT_DATA(x) \
54 (cpu_to_le32((1 << 16) | (offsetof(struct nvmf_connect_data, x))))
55 #define IPO_IATTR_CONNECT_SQE(x) \
56 (cpu_to_le32(offsetof(struct nvmf_connect_command, x)))
57
58 struct nvmet_ns {
59 struct percpu_ref ref;
60 struct block_device *bdev;
61 struct file *file;
62 bool readonly;
63 u32 nsid;
64 u32 blksize_shift;
65 loff_t size;
66 u8 nguid[16];
67 uuid_t uuid;
68 u32 anagrpid;
69
70 bool buffered_io;
71 bool enabled;
72 struct nvmet_subsys *subsys;
73 const char *device_path;
74
75 struct config_group device_group;
76 struct config_group group;
77
78 struct completion disable_done;
79 mempool_t *bvec_pool;
80
81 int use_p2pmem;
82 struct pci_dev *p2p_dev;
83 int pi_type;
84 int metadata_size;
85 u8 csi;
86 };
87
to_nvmet_ns(struct config_item * item)88 static inline struct nvmet_ns *to_nvmet_ns(struct config_item *item)
89 {
90 return container_of(to_config_group(item), struct nvmet_ns, group);
91 }
92
nvmet_ns_dev(struct nvmet_ns * ns)93 static inline struct device *nvmet_ns_dev(struct nvmet_ns *ns)
94 {
95 return ns->bdev ? disk_to_dev(ns->bdev->bd_disk) : NULL;
96 }
97
98 struct nvmet_cq {
99 u16 qid;
100 u16 size;
101 };
102
103 struct nvmet_sq {
104 struct nvmet_ctrl *ctrl;
105 struct percpu_ref ref;
106 u16 qid;
107 u16 size;
108 u32 sqhd;
109 bool sqhd_disabled;
110 struct completion free_done;
111 struct completion confirm_done;
112 };
113
114 struct nvmet_ana_group {
115 struct config_group group;
116 struct nvmet_port *port;
117 u32 grpid;
118 };
119
to_ana_group(struct config_item * item)120 static inline struct nvmet_ana_group *to_ana_group(struct config_item *item)
121 {
122 return container_of(to_config_group(item), struct nvmet_ana_group,
123 group);
124 }
125
126 /**
127 * struct nvmet_port - Common structure to keep port
128 * information for the target.
129 * @entry: Entry into referrals or transport list.
130 * @disc_addr: Address information is stored in a format defined
131 * for a discovery log page entry.
132 * @group: ConfigFS group for this element's folder.
133 * @priv: Private data for the transport.
134 */
135 struct nvmet_port {
136 struct list_head entry;
137 struct nvmf_disc_rsp_page_entry disc_addr;
138 struct config_group group;
139 struct config_group subsys_group;
140 struct list_head subsystems;
141 struct config_group referrals_group;
142 struct list_head referrals;
143 struct list_head global_entry;
144 struct config_group ana_groups_group;
145 struct nvmet_ana_group ana_default_group;
146 enum nvme_ana_state *ana_state;
147 void *priv;
148 bool enabled;
149 int inline_data_size;
150 const struct nvmet_fabrics_ops *tr_ops;
151 bool pi_enable;
152 };
153
to_nvmet_port(struct config_item * item)154 static inline struct nvmet_port *to_nvmet_port(struct config_item *item)
155 {
156 return container_of(to_config_group(item), struct nvmet_port,
157 group);
158 }
159
ana_groups_to_port(struct config_item * item)160 static inline struct nvmet_port *ana_groups_to_port(
161 struct config_item *item)
162 {
163 return container_of(to_config_group(item), struct nvmet_port,
164 ana_groups_group);
165 }
166
167 struct nvmet_ctrl {
168 struct nvmet_subsys *subsys;
169 struct nvmet_sq **sqs;
170
171 bool reset_tbkas;
172
173 struct mutex lock;
174 u64 cap;
175 u32 cc;
176 u32 csts;
177
178 uuid_t hostid;
179 u16 cntlid;
180 u32 kato;
181
182 struct nvmet_port *port;
183
184 u32 aen_enabled;
185 unsigned long aen_masked;
186 struct nvmet_req *async_event_cmds[NVMET_ASYNC_EVENTS];
187 unsigned int nr_async_event_cmds;
188 struct list_head async_events;
189 struct work_struct async_event_work;
190
191 struct list_head subsys_entry;
192 struct kref ref;
193 struct delayed_work ka_work;
194 struct work_struct fatal_err_work;
195
196 const struct nvmet_fabrics_ops *ops;
197
198 __le32 *changed_ns_list;
199 u32 nr_changed_ns;
200
201 char subsysnqn[NVMF_NQN_FIELD_LEN];
202 char hostnqn[NVMF_NQN_FIELD_LEN];
203
204 struct device *p2p_client;
205 struct radix_tree_root p2p_ns_map;
206
207 spinlock_t error_lock;
208 u64 err_counter;
209 struct nvme_error_slot slots[NVMET_ERROR_LOG_SLOTS];
210 bool pi_support;
211 };
212
213 struct nvmet_subsys {
214 enum nvme_subsys_type type;
215
216 struct mutex lock;
217 struct kref ref;
218
219 struct xarray namespaces;
220 unsigned int nr_namespaces;
221 u32 max_nsid;
222 u16 cntlid_min;
223 u16 cntlid_max;
224
225 struct list_head ctrls;
226
227 struct list_head hosts;
228 bool allow_any_host;
229
230 u16 max_qid;
231
232 u64 ver;
233 char serial[NVMET_SN_MAX_SIZE];
234 bool subsys_discovered;
235 char *subsysnqn;
236 bool pi_support;
237
238 struct config_group group;
239
240 struct config_group namespaces_group;
241 struct config_group allowed_hosts_group;
242
243 char *model_number;
244
245 #ifdef CONFIG_NVME_TARGET_PASSTHRU
246 struct nvme_ctrl *passthru_ctrl;
247 char *passthru_ctrl_path;
248 struct config_group passthru_group;
249 unsigned int admin_timeout;
250 unsigned int io_timeout;
251 #endif /* CONFIG_NVME_TARGET_PASSTHRU */
252
253 #ifdef CONFIG_BLK_DEV_ZONED
254 u8 zasl;
255 #endif /* CONFIG_BLK_DEV_ZONED */
256 };
257
to_subsys(struct config_item * item)258 static inline struct nvmet_subsys *to_subsys(struct config_item *item)
259 {
260 return container_of(to_config_group(item), struct nvmet_subsys, group);
261 }
262
namespaces_to_subsys(struct config_item * item)263 static inline struct nvmet_subsys *namespaces_to_subsys(
264 struct config_item *item)
265 {
266 return container_of(to_config_group(item), struct nvmet_subsys,
267 namespaces_group);
268 }
269
270 struct nvmet_host {
271 struct config_group group;
272 };
273
to_host(struct config_item * item)274 static inline struct nvmet_host *to_host(struct config_item *item)
275 {
276 return container_of(to_config_group(item), struct nvmet_host, group);
277 }
278
nvmet_host_name(struct nvmet_host * host)279 static inline char *nvmet_host_name(struct nvmet_host *host)
280 {
281 return config_item_name(&host->group.cg_item);
282 }
283
284 struct nvmet_host_link {
285 struct list_head entry;
286 struct nvmet_host *host;
287 };
288
289 struct nvmet_subsys_link {
290 struct list_head entry;
291 struct nvmet_subsys *subsys;
292 };
293
294 struct nvmet_req;
295 struct nvmet_fabrics_ops {
296 struct module *owner;
297 unsigned int type;
298 unsigned int msdbd;
299 unsigned int flags;
300 #define NVMF_KEYED_SGLS (1 << 0)
301 #define NVMF_METADATA_SUPPORTED (1 << 1)
302 void (*queue_response)(struct nvmet_req *req);
303 int (*add_port)(struct nvmet_port *port);
304 void (*remove_port)(struct nvmet_port *port);
305 void (*delete_ctrl)(struct nvmet_ctrl *ctrl);
306 void (*disc_traddr)(struct nvmet_req *req,
307 struct nvmet_port *port, char *traddr);
308 u16 (*install_queue)(struct nvmet_sq *nvme_sq);
309 void (*discovery_chg)(struct nvmet_port *port);
310 u8 (*get_mdts)(const struct nvmet_ctrl *ctrl);
311 };
312
313 #define NVMET_MAX_INLINE_BIOVEC 8
314 #define NVMET_MAX_INLINE_DATA_LEN NVMET_MAX_INLINE_BIOVEC * PAGE_SIZE
315
316 struct nvmet_req {
317 struct nvme_command *cmd;
318 struct nvme_completion *cqe;
319 struct nvmet_sq *sq;
320 struct nvmet_cq *cq;
321 struct nvmet_ns *ns;
322 struct scatterlist *sg;
323 struct scatterlist *metadata_sg;
324 struct bio_vec inline_bvec[NVMET_MAX_INLINE_BIOVEC];
325 union {
326 struct {
327 struct bio inline_bio;
328 } b;
329 struct {
330 bool mpool_alloc;
331 struct kiocb iocb;
332 struct bio_vec *bvec;
333 struct work_struct work;
334 } f;
335 struct {
336 struct bio inline_bio;
337 struct request *rq;
338 struct work_struct work;
339 bool use_workqueue;
340 } p;
341 #ifdef CONFIG_BLK_DEV_ZONED
342 struct {
343 struct bio inline_bio;
344 struct work_struct zmgmt_work;
345 } z;
346 #endif /* CONFIG_BLK_DEV_ZONED */
347 };
348 int sg_cnt;
349 int metadata_sg_cnt;
350 /* data length as parsed from the SGL descriptor: */
351 size_t transfer_len;
352 size_t metadata_len;
353
354 struct nvmet_port *port;
355
356 void (*execute)(struct nvmet_req *req);
357 const struct nvmet_fabrics_ops *ops;
358
359 struct pci_dev *p2p_dev;
360 struct device *p2p_client;
361 u16 error_loc;
362 u64 error_slba;
363 };
364
365 #define NVMET_MAX_MPOOL_BVEC 16
366 extern struct kmem_cache *nvmet_bvec_cache;
367 extern struct workqueue_struct *buffered_io_wq;
368 extern struct workqueue_struct *zbd_wq;
369 extern struct workqueue_struct *nvmet_wq;
370
nvmet_set_result(struct nvmet_req * req,u32 result)371 static inline void nvmet_set_result(struct nvmet_req *req, u32 result)
372 {
373 req->cqe->result.u32 = cpu_to_le32(result);
374 }
375
376 /*
377 * NVMe command writes actually are DMA reads for us on the target side.
378 */
379 static inline enum dma_data_direction
nvmet_data_dir(struct nvmet_req * req)380 nvmet_data_dir(struct nvmet_req *req)
381 {
382 return nvme_is_write(req->cmd) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
383 }
384
385 struct nvmet_async_event {
386 struct list_head entry;
387 u8 event_type;
388 u8 event_info;
389 u8 log_page;
390 };
391
nvmet_clear_aen_bit(struct nvmet_req * req,u32 bn)392 static inline void nvmet_clear_aen_bit(struct nvmet_req *req, u32 bn)
393 {
394 int rae = le32_to_cpu(req->cmd->common.cdw10) & 1 << 15;
395
396 if (!rae)
397 clear_bit(bn, &req->sq->ctrl->aen_masked);
398 }
399
nvmet_aen_bit_disabled(struct nvmet_ctrl * ctrl,u32 bn)400 static inline bool nvmet_aen_bit_disabled(struct nvmet_ctrl *ctrl, u32 bn)
401 {
402 if (!(READ_ONCE(ctrl->aen_enabled) & (1 << bn)))
403 return true;
404 return test_and_set_bit(bn, &ctrl->aen_masked);
405 }
406
407 void nvmet_get_feat_kato(struct nvmet_req *req);
408 void nvmet_get_feat_async_event(struct nvmet_req *req);
409 u16 nvmet_set_feat_kato(struct nvmet_req *req);
410 u16 nvmet_set_feat_async_event(struct nvmet_req *req, u32 mask);
411 void nvmet_execute_async_event(struct nvmet_req *req);
412 void nvmet_start_keep_alive_timer(struct nvmet_ctrl *ctrl);
413 void nvmet_stop_keep_alive_timer(struct nvmet_ctrl *ctrl);
414
415 u16 nvmet_parse_connect_cmd(struct nvmet_req *req);
416 void nvmet_bdev_set_limits(struct block_device *bdev, struct nvme_id_ns *id);
417 u16 nvmet_bdev_parse_io_cmd(struct nvmet_req *req);
418 u16 nvmet_file_parse_io_cmd(struct nvmet_req *req);
419 u16 nvmet_bdev_zns_parse_io_cmd(struct nvmet_req *req);
420 u16 nvmet_parse_admin_cmd(struct nvmet_req *req);
421 u16 nvmet_parse_discovery_cmd(struct nvmet_req *req);
422 u16 nvmet_parse_fabrics_cmd(struct nvmet_req *req);
423
424 bool nvmet_req_init(struct nvmet_req *req, struct nvmet_cq *cq,
425 struct nvmet_sq *sq, const struct nvmet_fabrics_ops *ops);
426 void nvmet_req_uninit(struct nvmet_req *req);
427 bool nvmet_check_transfer_len(struct nvmet_req *req, size_t len);
428 bool nvmet_check_data_len_lte(struct nvmet_req *req, size_t data_len);
429 void nvmet_req_complete(struct nvmet_req *req, u16 status);
430 int nvmet_req_alloc_sgls(struct nvmet_req *req);
431 void nvmet_req_free_sgls(struct nvmet_req *req);
432
433 void nvmet_execute_set_features(struct nvmet_req *req);
434 void nvmet_execute_get_features(struct nvmet_req *req);
435 void nvmet_execute_keep_alive(struct nvmet_req *req);
436
437 void nvmet_cq_setup(struct nvmet_ctrl *ctrl, struct nvmet_cq *cq, u16 qid,
438 u16 size);
439 void nvmet_sq_setup(struct nvmet_ctrl *ctrl, struct nvmet_sq *sq, u16 qid,
440 u16 size);
441 void nvmet_sq_destroy(struct nvmet_sq *sq);
442 int nvmet_sq_init(struct nvmet_sq *sq);
443
444 void nvmet_ctrl_fatal_error(struct nvmet_ctrl *ctrl);
445
446 void nvmet_update_cc(struct nvmet_ctrl *ctrl, u32 new);
447 u16 nvmet_alloc_ctrl(const char *subsysnqn, const char *hostnqn,
448 struct nvmet_req *req, u32 kato, struct nvmet_ctrl **ctrlp);
449 struct nvmet_ctrl *nvmet_ctrl_find_get(const char *subsysnqn,
450 const char *hostnqn, u16 cntlid,
451 struct nvmet_req *req);
452 void nvmet_ctrl_put(struct nvmet_ctrl *ctrl);
453 u16 nvmet_check_ctrl_status(struct nvmet_req *req);
454
455 struct nvmet_subsys *nvmet_subsys_alloc(const char *subsysnqn,
456 enum nvme_subsys_type type);
457 void nvmet_subsys_put(struct nvmet_subsys *subsys);
458 void nvmet_subsys_del_ctrls(struct nvmet_subsys *subsys);
459
460 u16 nvmet_req_find_ns(struct nvmet_req *req);
461 void nvmet_put_namespace(struct nvmet_ns *ns);
462 int nvmet_ns_enable(struct nvmet_ns *ns);
463 void nvmet_ns_disable(struct nvmet_ns *ns);
464 struct nvmet_ns *nvmet_ns_alloc(struct nvmet_subsys *subsys, u32 nsid);
465 void nvmet_ns_free(struct nvmet_ns *ns);
466
467 void nvmet_send_ana_event(struct nvmet_subsys *subsys,
468 struct nvmet_port *port);
469 void nvmet_port_send_ana_event(struct nvmet_port *port);
470
471 int nvmet_register_transport(const struct nvmet_fabrics_ops *ops);
472 void nvmet_unregister_transport(const struct nvmet_fabrics_ops *ops);
473
474 void nvmet_port_del_ctrls(struct nvmet_port *port,
475 struct nvmet_subsys *subsys);
476
477 int nvmet_enable_port(struct nvmet_port *port);
478 void nvmet_disable_port(struct nvmet_port *port);
479
480 void nvmet_referral_enable(struct nvmet_port *parent, struct nvmet_port *port);
481 void nvmet_referral_disable(struct nvmet_port *parent, struct nvmet_port *port);
482
483 u16 nvmet_copy_to_sgl(struct nvmet_req *req, off_t off, const void *buf,
484 size_t len);
485 u16 nvmet_copy_from_sgl(struct nvmet_req *req, off_t off, void *buf,
486 size_t len);
487 u16 nvmet_zero_sgl(struct nvmet_req *req, off_t off, size_t len);
488
489 u32 nvmet_get_log_page_len(struct nvme_command *cmd);
490 u64 nvmet_get_log_page_offset(struct nvme_command *cmd);
491
492 extern struct list_head *nvmet_ports;
493 void nvmet_port_disc_changed(struct nvmet_port *port,
494 struct nvmet_subsys *subsys);
495 void nvmet_subsys_disc_changed(struct nvmet_subsys *subsys,
496 struct nvmet_host *host);
497 void nvmet_add_async_event(struct nvmet_ctrl *ctrl, u8 event_type,
498 u8 event_info, u8 log_page);
499
500 #define NVMET_QUEUE_SIZE 1024
501 #define NVMET_NR_QUEUES 128
502 #define NVMET_MAX_CMD NVMET_QUEUE_SIZE
503
504 /*
505 * Nice round number that makes a list of nsids fit into a page.
506 * Should become tunable at some point in the future.
507 */
508 #define NVMET_MAX_NAMESPACES 1024
509
510 /*
511 * 0 is not a valid ANA group ID, so we start numbering at 1.
512 *
513 * ANA Group 1 exists without manual intervention, has namespaces assigned to it
514 * by default, and is available in an optimized state through all ports.
515 */
516 #define NVMET_MAX_ANAGRPS 128
517 #define NVMET_DEFAULT_ANA_GRPID 1
518
519 #define NVMET_KAS 10
520 #define NVMET_DISC_KATO_MS 120000
521
522 int __init nvmet_init_configfs(void);
523 void __exit nvmet_exit_configfs(void);
524
525 int __init nvmet_init_discovery(void);
526 void nvmet_exit_discovery(void);
527
528 extern struct nvmet_subsys *nvmet_disc_subsys;
529 extern struct rw_semaphore nvmet_config_sem;
530
531 extern u32 nvmet_ana_group_enabled[NVMET_MAX_ANAGRPS + 1];
532 extern u64 nvmet_ana_chgcnt;
533 extern struct rw_semaphore nvmet_ana_sem;
534
535 bool nvmet_host_allowed(struct nvmet_subsys *subsys, const char *hostnqn);
536
537 int nvmet_bdev_ns_enable(struct nvmet_ns *ns);
538 int nvmet_file_ns_enable(struct nvmet_ns *ns);
539 void nvmet_bdev_ns_disable(struct nvmet_ns *ns);
540 void nvmet_file_ns_disable(struct nvmet_ns *ns);
541 u16 nvmet_bdev_flush(struct nvmet_req *req);
542 u16 nvmet_file_flush(struct nvmet_req *req);
543 void nvmet_ns_changed(struct nvmet_subsys *subsys, u32 nsid);
544 void nvmet_bdev_ns_revalidate(struct nvmet_ns *ns);
545 void nvmet_file_ns_revalidate(struct nvmet_ns *ns);
546 bool nvmet_ns_revalidate(struct nvmet_ns *ns);
547 u16 blk_to_nvme_status(struct nvmet_req *req, blk_status_t blk_sts);
548
549 bool nvmet_bdev_zns_enable(struct nvmet_ns *ns);
550 void nvmet_execute_identify_ctrl_zns(struct nvmet_req *req);
551 void nvmet_execute_identify_cns_cs_ns(struct nvmet_req *req);
552 void nvmet_bdev_execute_zone_mgmt_recv(struct nvmet_req *req);
553 void nvmet_bdev_execute_zone_mgmt_send(struct nvmet_req *req);
554 void nvmet_bdev_execute_zone_append(struct nvmet_req *req);
555
nvmet_rw_data_len(struct nvmet_req * req)556 static inline u32 nvmet_rw_data_len(struct nvmet_req *req)
557 {
558 return ((u32)le16_to_cpu(req->cmd->rw.length) + 1) <<
559 req->ns->blksize_shift;
560 }
561
nvmet_rw_metadata_len(struct nvmet_req * req)562 static inline u32 nvmet_rw_metadata_len(struct nvmet_req *req)
563 {
564 if (!IS_ENABLED(CONFIG_BLK_DEV_INTEGRITY))
565 return 0;
566 return ((u32)le16_to_cpu(req->cmd->rw.length) + 1) *
567 req->ns->metadata_size;
568 }
569
nvmet_dsm_len(struct nvmet_req * req)570 static inline u32 nvmet_dsm_len(struct nvmet_req *req)
571 {
572 return (le32_to_cpu(req->cmd->dsm.nr) + 1) *
573 sizeof(struct nvme_dsm_range);
574 }
575
nvmet_req_subsys(struct nvmet_req * req)576 static inline struct nvmet_subsys *nvmet_req_subsys(struct nvmet_req *req)
577 {
578 return req->sq->ctrl->subsys;
579 }
580
581 #ifdef CONFIG_NVME_TARGET_PASSTHRU
582 void nvmet_passthru_subsys_free(struct nvmet_subsys *subsys);
583 int nvmet_passthru_ctrl_enable(struct nvmet_subsys *subsys);
584 void nvmet_passthru_ctrl_disable(struct nvmet_subsys *subsys);
585 u16 nvmet_parse_passthru_admin_cmd(struct nvmet_req *req);
586 u16 nvmet_parse_passthru_io_cmd(struct nvmet_req *req);
nvmet_is_passthru_subsys(struct nvmet_subsys * subsys)587 static inline bool nvmet_is_passthru_subsys(struct nvmet_subsys *subsys)
588 {
589 return subsys->passthru_ctrl;
590 }
591 #else /* CONFIG_NVME_TARGET_PASSTHRU */
nvmet_passthru_subsys_free(struct nvmet_subsys * subsys)592 static inline void nvmet_passthru_subsys_free(struct nvmet_subsys *subsys)
593 {
594 }
nvmet_passthru_ctrl_disable(struct nvmet_subsys * subsys)595 static inline void nvmet_passthru_ctrl_disable(struct nvmet_subsys *subsys)
596 {
597 }
nvmet_parse_passthru_admin_cmd(struct nvmet_req * req)598 static inline u16 nvmet_parse_passthru_admin_cmd(struct nvmet_req *req)
599 {
600 return 0;
601 }
nvmet_parse_passthru_io_cmd(struct nvmet_req * req)602 static inline u16 nvmet_parse_passthru_io_cmd(struct nvmet_req *req)
603 {
604 return 0;
605 }
nvmet_is_passthru_subsys(struct nvmet_subsys * subsys)606 static inline bool nvmet_is_passthru_subsys(struct nvmet_subsys *subsys)
607 {
608 return NULL;
609 }
610 #endif /* CONFIG_NVME_TARGET_PASSTHRU */
611
nvmet_is_passthru_req(struct nvmet_req * req)612 static inline bool nvmet_is_passthru_req(struct nvmet_req *req)
613 {
614 return nvmet_is_passthru_subsys(nvmet_req_subsys(req));
615 }
616
617 void nvmet_passthrough_override_cap(struct nvmet_ctrl *ctrl);
618
619 u16 errno_to_nvme_status(struct nvmet_req *req, int errno);
620 u16 nvmet_report_invalid_opcode(struct nvmet_req *req);
621
622 /* Convert a 32-bit number to a 16-bit 0's based number */
to0based(u32 a)623 static inline __le16 to0based(u32 a)
624 {
625 return cpu_to_le16(max(1U, min(1U << 16, a)) - 1);
626 }
627
nvmet_ns_has_pi(struct nvmet_ns * ns)628 static inline bool nvmet_ns_has_pi(struct nvmet_ns *ns)
629 {
630 if (!IS_ENABLED(CONFIG_BLK_DEV_INTEGRITY))
631 return false;
632 return ns->pi_type && ns->metadata_size == sizeof(struct t10_pi_tuple);
633 }
634
nvmet_sect_to_lba(struct nvmet_ns * ns,sector_t sect)635 static inline __le64 nvmet_sect_to_lba(struct nvmet_ns *ns, sector_t sect)
636 {
637 return cpu_to_le64(sect >> (ns->blksize_shift - SECTOR_SHIFT));
638 }
639
nvmet_lba_to_sect(struct nvmet_ns * ns,__le64 lba)640 static inline sector_t nvmet_lba_to_sect(struct nvmet_ns *ns, __le64 lba)
641 {
642 return le64_to_cpu(lba) << (ns->blksize_shift - SECTOR_SHIFT);
643 }
644
nvmet_use_inline_bvec(struct nvmet_req * req)645 static inline bool nvmet_use_inline_bvec(struct nvmet_req *req)
646 {
647 return req->transfer_len <= NVMET_MAX_INLINE_DATA_LEN &&
648 req->sg_cnt <= NVMET_MAX_INLINE_BIOVEC;
649 }
650
nvmet_req_cns_error_complete(struct nvmet_req * req)651 static inline void nvmet_req_cns_error_complete(struct nvmet_req *req)
652 {
653 pr_debug("unhandled identify cns %d on qid %d\n",
654 req->cmd->identify.cns, req->sq->qid);
655 req->error_loc = offsetof(struct nvme_identify, cns);
656 nvmet_req_complete(req, NVME_SC_INVALID_FIELD | NVME_SC_DNR);
657 }
658
nvmet_req_bio_put(struct nvmet_req * req,struct bio * bio)659 static inline void nvmet_req_bio_put(struct nvmet_req *req, struct bio *bio)
660 {
661 if (bio != &req->b.inline_bio)
662 bio_put(bio);
663 }
664
665 #endif /* _NVMET_H */
666