1 /*******************************************************************************
2 * Vhost kernel TCM fabric driver for virtio SCSI initiators
4 * (C) Copyright 2010-2013 Datera, Inc.
5 * (C) Copyright 2010-2012 IBM Corp.
7 * Licensed to the Linux Foundation under the General Public License (GPL) version 2.
9 * Authors: Nicholas A. Bellinger <nab@daterainc.com>
10 * Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 ****************************************************************************/
24 #include <linux/module.h>
25 #include <linux/moduleparam.h>
26 #include <generated/utsrelease.h>
27 #include <linux/utsname.h>
28 #include <linux/init.h>
29 #include <linux/slab.h>
30 #include <linux/kthread.h>
31 #include <linux/types.h>
32 #include <linux/string.h>
33 #include <linux/configfs.h>
34 #include <linux/ctype.h>
35 #include <linux/compat.h>
36 #include <linux/eventfd.h>
38 #include <linux/miscdevice.h>
39 #include <asm/unaligned.h>
40 #include <scsi/scsi.h>
41 #include <target/target_core_base.h>
42 #include <target/target_core_fabric.h>
43 #include <target/target_core_fabric_configfs.h>
44 #include <target/target_core_configfs.h>
45 #include <target/configfs_macros.h>
46 #include <linux/vhost.h>
47 #include <linux/virtio_scsi.h>
48 #include <linux/llist.h>
49 #include <linux/bitmap.h>
50 #include <linux/percpu_ida.h>
54 #define VHOST_SCSI_VERSION "v0.1"
55 #define VHOST_SCSI_NAMELEN 256
56 #define VHOST_SCSI_MAX_CDB_SIZE 32
57 #define VHOST_SCSI_DEFAULT_TAGS 256
58 #define VHOST_SCSI_PREALLOC_SGLS 2048
59 #define VHOST_SCSI_PREALLOC_UPAGES 2048
60 #define VHOST_SCSI_PREALLOC_PROT_SGLS 512
62 struct vhost_scsi_inflight {
63 /* Wait for the flush operation to finish */
64 struct completion comp;
65 /* Refcount for the inflight reqs */
69 struct vhost_scsi_cmd {
70 /* Descriptor from vhost_get_vq_desc() for virt_queue segment */
72 /* virtio-scsi initiator task attribute */
74 /* virtio-scsi response incoming iovecs */
76 /* virtio-scsi initiator data direction */
77 enum dma_data_direction tvc_data_direction;
78 /* Expected data transfer length from virtio-scsi header */
80 /* The Tag from include/linux/virtio_scsi.h:struct virtio_scsi_cmd_req */
82 /* The number of scatterlists associated with this cmd */
84 u32 tvc_prot_sgl_count;
85 /* Saved unpacked SCSI LUN for vhost_scsi_submission_work() */
87 /* Pointer to the SGL formatted memory from virtio-scsi */
88 struct scatterlist *tvc_sgl;
89 struct scatterlist *tvc_prot_sgl;
90 struct page **tvc_upages;
91 /* Pointer to response header iovec */
92 struct iovec *tvc_resp_iov;
93 /* Pointer to vhost_scsi for our device */
94 struct vhost_scsi *tvc_vhost;
95 /* Pointer to vhost_virtqueue for the cmd */
96 struct vhost_virtqueue *tvc_vq;
97 /* Pointer to vhost nexus memory */
98 struct vhost_scsi_nexus *tvc_nexus;
99 /* The TCM I/O descriptor that is accessed via container_of() */
100 struct se_cmd tvc_se_cmd;
101 /* work item used for cmwq dispatch to vhost_scsi_submission_work() */
102 struct work_struct work;
103 /* Copy of the incoming SCSI command descriptor block (CDB) */
104 unsigned char tvc_cdb[VHOST_SCSI_MAX_CDB_SIZE];
105 /* Sense buffer that will be mapped into outgoing status */
106 unsigned char tvc_sense_buf[TRANSPORT_SENSE_BUFFER];
107 /* Completed commands list, serviced from vhost worker thread */
108 struct llist_node tvc_completion_list;
109 /* Used to track inflight cmd */
110 struct vhost_scsi_inflight *inflight;
113 struct vhost_scsi_nexus {
114 /* Pointer to TCM session for I_T Nexus */
115 struct se_session *tvn_se_sess;
118 struct vhost_scsi_tpg {
119 /* Vhost port target portal group tag for TCM */
121 /* Used to track number of TPG Port/Lun Links wrt to explict I_T Nexus shutdown */
122 int tv_tpg_port_count;
123 /* Used for vhost_scsi device reference to tpg_nexus, protected by tv_tpg_mutex */
124 int tv_tpg_vhost_count;
125 /* Used for enabling T10-PI with legacy devices */
126 int tv_fabric_prot_type;
127 /* list for vhost_scsi_list */
128 struct list_head tv_tpg_list;
129 /* Used to protect access for tpg_nexus */
130 struct mutex tv_tpg_mutex;
131 /* Pointer to the TCM VHost I_T Nexus for this TPG endpoint */
132 struct vhost_scsi_nexus *tpg_nexus;
133 /* Pointer back to vhost_scsi_tport */
134 struct vhost_scsi_tport *tport;
135 /* Returned by vhost_scsi_make_tpg() */
136 struct se_portal_group se_tpg;
137 /* Pointer back to vhost_scsi, protected by tv_tpg_mutex */
138 struct vhost_scsi *vhost_scsi;
141 struct vhost_scsi_tport {
142 /* SCSI protocol the tport is providing */
144 /* Binary World Wide unique Port Name for Vhost Target port */
146 /* ASCII formatted WWPN for Vhost Target port */
147 char tport_name[VHOST_SCSI_NAMELEN];
148 /* Returned by vhost_scsi_make_tport() */
149 struct se_wwn tport_wwn;
152 struct vhost_scsi_evt {
153 /* event to be sent to guest */
154 struct virtio_scsi_event event;
155 /* event list, serviced from vhost worker thread */
156 struct llist_node list;
160 VHOST_SCSI_VQ_CTL = 0,
161 VHOST_SCSI_VQ_EVT = 1,
162 VHOST_SCSI_VQ_IO = 2,
165 /* Note: can't set VIRTIO_F_VERSION_1 yet, since that implies ANY_LAYOUT. */
167 VHOST_SCSI_FEATURES = VHOST_FEATURES | (1ULL << VIRTIO_SCSI_F_HOTPLUG) |
168 (1ULL << VIRTIO_SCSI_F_T10_PI) |
169 (1ULL << VIRTIO_F_ANY_LAYOUT) |
170 (1ULL << VIRTIO_F_VERSION_1)
173 #define VHOST_SCSI_MAX_TARGET 256
174 #define VHOST_SCSI_MAX_VQ 128
175 #define VHOST_SCSI_MAX_EVENT 128
177 struct vhost_scsi_virtqueue {
178 struct vhost_virtqueue vq;
180 * Reference counting for inflight reqs, used for flush operation. At
181 * each time, one reference tracks new commands submitted, while we
182 * wait for another one to reach 0.
184 struct vhost_scsi_inflight inflights[2];
186 * Indicate current inflight in use, protected by vq->mutex.
187 * Writers must also take dev mutex and flush under it.
193 /* Protected by vhost_scsi->dev.mutex */
194 struct vhost_scsi_tpg **vs_tpg;
195 char vs_vhost_wwpn[TRANSPORT_IQN_LEN];
197 struct vhost_dev dev;
198 struct vhost_scsi_virtqueue vqs[VHOST_SCSI_MAX_VQ];
200 struct vhost_work vs_completion_work; /* cmd completion work item */
201 struct llist_head vs_completion_list; /* cmd completion queue */
203 struct vhost_work vs_event_work; /* evt injection work item */
204 struct llist_head vs_event_list; /* evt injection queue */
206 bool vs_events_missed; /* any missed events, protected by vq->mutex */
207 int vs_events_nr; /* num of pending events, protected by vq->mutex */
210 static struct target_core_fabric_ops vhost_scsi_ops;
211 static struct workqueue_struct *vhost_scsi_workqueue;
213 /* Global spinlock to protect vhost_scsi TPG list for vhost IOCTL access */
214 static DEFINE_MUTEX(vhost_scsi_mutex);
215 static LIST_HEAD(vhost_scsi_list);
217 static int iov_num_pages(void __user *iov_base, size_t iov_len)
219 return (PAGE_ALIGN((unsigned long)iov_base + iov_len) -
220 ((unsigned long)iov_base & PAGE_MASK)) >> PAGE_SHIFT;
223 static void vhost_scsi_done_inflight(struct kref *kref)
225 struct vhost_scsi_inflight *inflight;
227 inflight = container_of(kref, struct vhost_scsi_inflight, kref);
228 complete(&inflight->comp);
231 static void vhost_scsi_init_inflight(struct vhost_scsi *vs,
232 struct vhost_scsi_inflight *old_inflight[])
234 struct vhost_scsi_inflight *new_inflight;
235 struct vhost_virtqueue *vq;
238 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
241 mutex_lock(&vq->mutex);
243 /* store old infight */
244 idx = vs->vqs[i].inflight_idx;
246 old_inflight[i] = &vs->vqs[i].inflights[idx];
248 /* setup new infight */
249 vs->vqs[i].inflight_idx = idx ^ 1;
250 new_inflight = &vs->vqs[i].inflights[idx ^ 1];
251 kref_init(&new_inflight->kref);
252 init_completion(&new_inflight->comp);
254 mutex_unlock(&vq->mutex);
258 static struct vhost_scsi_inflight *
259 vhost_scsi_get_inflight(struct vhost_virtqueue *vq)
261 struct vhost_scsi_inflight *inflight;
262 struct vhost_scsi_virtqueue *svq;
264 svq = container_of(vq, struct vhost_scsi_virtqueue, vq);
265 inflight = &svq->inflights[svq->inflight_idx];
266 kref_get(&inflight->kref);
271 static void vhost_scsi_put_inflight(struct vhost_scsi_inflight *inflight)
273 kref_put(&inflight->kref, vhost_scsi_done_inflight);
276 static int vhost_scsi_check_true(struct se_portal_group *se_tpg)
281 static int vhost_scsi_check_false(struct se_portal_group *se_tpg)
286 static char *vhost_scsi_get_fabric_name(void)
291 static char *vhost_scsi_get_fabric_wwn(struct se_portal_group *se_tpg)
293 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
294 struct vhost_scsi_tpg, se_tpg);
295 struct vhost_scsi_tport *tport = tpg->tport;
297 return &tport->tport_name[0];
300 static u16 vhost_scsi_get_tpgt(struct se_portal_group *se_tpg)
302 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
303 struct vhost_scsi_tpg, se_tpg);
304 return tpg->tport_tpgt;
308 vhost_scsi_get_pr_transport_id(struct se_portal_group *se_tpg,
309 struct se_node_acl *se_nacl,
310 struct t10_pr_registration *pr_reg,
314 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
315 struct vhost_scsi_tpg, se_tpg);
316 struct vhost_scsi_tport *tport = tpg->tport;
318 switch (tport->tport_proto_id) {
319 case SCSI_PROTOCOL_SAS:
320 return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
322 case SCSI_PROTOCOL_FCP:
323 return fc_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
325 case SCSI_PROTOCOL_ISCSI:
326 return iscsi_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
329 pr_err("Unknown tport_proto_id: 0x%02x, using"
330 " SAS emulation\n", tport->tport_proto_id);
334 return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
339 vhost_scsi_get_pr_transport_id_len(struct se_portal_group *se_tpg,
340 struct se_node_acl *se_nacl,
341 struct t10_pr_registration *pr_reg,
344 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
345 struct vhost_scsi_tpg, se_tpg);
346 struct vhost_scsi_tport *tport = tpg->tport;
348 switch (tport->tport_proto_id) {
349 case SCSI_PROTOCOL_SAS:
350 return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
352 case SCSI_PROTOCOL_FCP:
353 return fc_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
355 case SCSI_PROTOCOL_ISCSI:
356 return iscsi_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
359 pr_err("Unknown tport_proto_id: 0x%02x, using"
360 " SAS emulation\n", tport->tport_proto_id);
364 return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
369 vhost_scsi_parse_pr_out_transport_id(struct se_portal_group *se_tpg,
372 char **port_nexus_ptr)
374 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
375 struct vhost_scsi_tpg, se_tpg);
376 struct vhost_scsi_tport *tport = tpg->tport;
378 switch (tport->tport_proto_id) {
379 case SCSI_PROTOCOL_SAS:
380 return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
382 case SCSI_PROTOCOL_FCP:
383 return fc_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
385 case SCSI_PROTOCOL_ISCSI:
386 return iscsi_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
389 pr_err("Unknown tport_proto_id: 0x%02x, using"
390 " SAS emulation\n", tport->tport_proto_id);
394 return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
398 static int vhost_scsi_check_prot_fabric_only(struct se_portal_group *se_tpg)
400 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
401 struct vhost_scsi_tpg, se_tpg);
403 return tpg->tv_fabric_prot_type;
406 static u32 vhost_scsi_tpg_get_inst_index(struct se_portal_group *se_tpg)
411 static void vhost_scsi_release_cmd(struct se_cmd *se_cmd)
413 struct vhost_scsi_cmd *tv_cmd = container_of(se_cmd,
414 struct vhost_scsi_cmd, tvc_se_cmd);
415 struct se_session *se_sess = tv_cmd->tvc_nexus->tvn_se_sess;
418 if (tv_cmd->tvc_sgl_count) {
419 for (i = 0; i < tv_cmd->tvc_sgl_count; i++)
420 put_page(sg_page(&tv_cmd->tvc_sgl[i]));
422 if (tv_cmd->tvc_prot_sgl_count) {
423 for (i = 0; i < tv_cmd->tvc_prot_sgl_count; i++)
424 put_page(sg_page(&tv_cmd->tvc_prot_sgl[i]));
427 vhost_scsi_put_inflight(tv_cmd->inflight);
428 percpu_ida_free(&se_sess->sess_tag_pool, se_cmd->map_tag);
431 static int vhost_scsi_shutdown_session(struct se_session *se_sess)
436 static void vhost_scsi_close_session(struct se_session *se_sess)
441 static u32 vhost_scsi_sess_get_index(struct se_session *se_sess)
446 static int vhost_scsi_write_pending(struct se_cmd *se_cmd)
448 /* Go ahead and process the write immediately */
449 target_execute_cmd(se_cmd);
453 static int vhost_scsi_write_pending_status(struct se_cmd *se_cmd)
458 static void vhost_scsi_set_default_node_attrs(struct se_node_acl *nacl)
463 static u32 vhost_scsi_get_task_tag(struct se_cmd *se_cmd)
468 static int vhost_scsi_get_cmd_state(struct se_cmd *se_cmd)
473 static void vhost_scsi_complete_cmd(struct vhost_scsi_cmd *cmd)
475 struct vhost_scsi *vs = cmd->tvc_vhost;
477 llist_add(&cmd->tvc_completion_list, &vs->vs_completion_list);
479 vhost_work_queue(&vs->dev, &vs->vs_completion_work);
482 static int vhost_scsi_queue_data_in(struct se_cmd *se_cmd)
484 struct vhost_scsi_cmd *cmd = container_of(se_cmd,
485 struct vhost_scsi_cmd, tvc_se_cmd);
486 vhost_scsi_complete_cmd(cmd);
490 static int vhost_scsi_queue_status(struct se_cmd *se_cmd)
492 struct vhost_scsi_cmd *cmd = container_of(se_cmd,
493 struct vhost_scsi_cmd, tvc_se_cmd);
494 vhost_scsi_complete_cmd(cmd);
498 static void vhost_scsi_queue_tm_rsp(struct se_cmd *se_cmd)
503 static void vhost_scsi_aborted_task(struct se_cmd *se_cmd)
508 static void vhost_scsi_free_evt(struct vhost_scsi *vs, struct vhost_scsi_evt *evt)
514 static struct vhost_scsi_evt *
515 vhost_scsi_allocate_evt(struct vhost_scsi *vs,
516 u32 event, u32 reason)
518 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
519 struct vhost_scsi_evt *evt;
521 if (vs->vs_events_nr > VHOST_SCSI_MAX_EVENT) {
522 vs->vs_events_missed = true;
526 evt = kzalloc(sizeof(*evt), GFP_KERNEL);
528 vq_err(vq, "Failed to allocate vhost_scsi_evt\n");
529 vs->vs_events_missed = true;
533 evt->event.event = cpu_to_vhost32(vq, event);
534 evt->event.reason = cpu_to_vhost32(vq, reason);
540 static void vhost_scsi_free_cmd(struct vhost_scsi_cmd *cmd)
542 struct se_cmd *se_cmd = &cmd->tvc_se_cmd;
544 /* TODO locking against target/backend threads? */
545 transport_generic_free_cmd(se_cmd, 0);
549 static int vhost_scsi_check_stop_free(struct se_cmd *se_cmd)
551 return target_put_sess_cmd(se_cmd);
555 vhost_scsi_do_evt_work(struct vhost_scsi *vs, struct vhost_scsi_evt *evt)
557 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
558 struct virtio_scsi_event *event = &evt->event;
559 struct virtio_scsi_event __user *eventp;
563 if (!vq->private_data) {
564 vs->vs_events_missed = true;
569 vhost_disable_notify(&vs->dev, vq);
570 head = vhost_get_vq_desc(vq, vq->iov,
571 ARRAY_SIZE(vq->iov), &out, &in,
574 vs->vs_events_missed = true;
577 if (head == vq->num) {
578 if (vhost_enable_notify(&vs->dev, vq))
580 vs->vs_events_missed = true;
584 if ((vq->iov[out].iov_len != sizeof(struct virtio_scsi_event))) {
585 vq_err(vq, "Expecting virtio_scsi_event, got %zu bytes\n",
586 vq->iov[out].iov_len);
587 vs->vs_events_missed = true;
591 if (vs->vs_events_missed) {
592 event->event |= cpu_to_vhost32(vq, VIRTIO_SCSI_T_EVENTS_MISSED);
593 vs->vs_events_missed = false;
596 eventp = vq->iov[out].iov_base;
597 ret = __copy_to_user(eventp, event, sizeof(*event));
599 vhost_add_used_and_signal(&vs->dev, vq, head, 0);
601 vq_err(vq, "Faulted on vhost_scsi_send_event\n");
604 static void vhost_scsi_evt_work(struct vhost_work *work)
606 struct vhost_scsi *vs = container_of(work, struct vhost_scsi,
608 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
609 struct vhost_scsi_evt *evt;
610 struct llist_node *llnode;
612 mutex_lock(&vq->mutex);
613 llnode = llist_del_all(&vs->vs_event_list);
615 evt = llist_entry(llnode, struct vhost_scsi_evt, list);
616 llnode = llist_next(llnode);
617 vhost_scsi_do_evt_work(vs, evt);
618 vhost_scsi_free_evt(vs, evt);
620 mutex_unlock(&vq->mutex);
623 /* Fill in status and signal that we are done processing this command
625 * This is scheduled in the vhost work queue so we are called with the owner
626 * process mm and can access the vring.
628 static void vhost_scsi_complete_cmd_work(struct vhost_work *work)
630 struct vhost_scsi *vs = container_of(work, struct vhost_scsi,
632 DECLARE_BITMAP(signal, VHOST_SCSI_MAX_VQ);
633 struct virtio_scsi_cmd_resp v_rsp;
634 struct vhost_scsi_cmd *cmd;
635 struct llist_node *llnode;
636 struct se_cmd *se_cmd;
637 struct iov_iter iov_iter;
640 bitmap_zero(signal, VHOST_SCSI_MAX_VQ);
641 llnode = llist_del_all(&vs->vs_completion_list);
643 cmd = llist_entry(llnode, struct vhost_scsi_cmd,
644 tvc_completion_list);
645 llnode = llist_next(llnode);
646 se_cmd = &cmd->tvc_se_cmd;
648 pr_debug("%s tv_cmd %p resid %u status %#02x\n", __func__,
649 cmd, se_cmd->residual_count, se_cmd->scsi_status);
651 memset(&v_rsp, 0, sizeof(v_rsp));
652 v_rsp.resid = cpu_to_vhost32(cmd->tvc_vq, se_cmd->residual_count);
653 /* TODO is status_qualifier field needed? */
654 v_rsp.status = se_cmd->scsi_status;
655 v_rsp.sense_len = cpu_to_vhost32(cmd->tvc_vq,
656 se_cmd->scsi_sense_length);
657 memcpy(v_rsp.sense, cmd->tvc_sense_buf,
658 se_cmd->scsi_sense_length);
660 iov_iter_init(&iov_iter, READ, cmd->tvc_resp_iov,
661 cmd->tvc_in_iovs, sizeof(v_rsp));
662 ret = copy_to_iter(&v_rsp, sizeof(v_rsp), &iov_iter);
663 if (likely(ret == sizeof(v_rsp))) {
664 struct vhost_scsi_virtqueue *q;
665 vhost_add_used(cmd->tvc_vq, cmd->tvc_vq_desc, 0);
666 q = container_of(cmd->tvc_vq, struct vhost_scsi_virtqueue, vq);
668 __set_bit(vq, signal);
670 pr_err("Faulted on virtio_scsi_cmd_resp\n");
672 vhost_scsi_free_cmd(cmd);
676 while ((vq = find_next_bit(signal, VHOST_SCSI_MAX_VQ, vq + 1))
678 vhost_signal(&vs->dev, &vs->vqs[vq].vq);
681 static struct vhost_scsi_cmd *
682 vhost_scsi_get_tag(struct vhost_virtqueue *vq, struct vhost_scsi_tpg *tpg,
683 unsigned char *cdb, u64 scsi_tag, u16 lun, u8 task_attr,
684 u32 exp_data_len, int data_direction)
686 struct vhost_scsi_cmd *cmd;
687 struct vhost_scsi_nexus *tv_nexus;
688 struct se_session *se_sess;
689 struct scatterlist *sg, *prot_sg;
693 tv_nexus = tpg->tpg_nexus;
695 pr_err("Unable to locate active struct vhost_scsi_nexus\n");
696 return ERR_PTR(-EIO);
698 se_sess = tv_nexus->tvn_se_sess;
700 tag = percpu_ida_alloc(&se_sess->sess_tag_pool, TASK_RUNNING);
702 pr_err("Unable to obtain tag for vhost_scsi_cmd\n");
703 return ERR_PTR(-ENOMEM);
706 cmd = &((struct vhost_scsi_cmd *)se_sess->sess_cmd_map)[tag];
708 prot_sg = cmd->tvc_prot_sgl;
709 pages = cmd->tvc_upages;
710 memset(cmd, 0, sizeof(struct vhost_scsi_cmd));
713 cmd->tvc_prot_sgl = prot_sg;
714 cmd->tvc_upages = pages;
715 cmd->tvc_se_cmd.map_tag = tag;
716 cmd->tvc_tag = scsi_tag;
718 cmd->tvc_task_attr = task_attr;
719 cmd->tvc_exp_data_len = exp_data_len;
720 cmd->tvc_data_direction = data_direction;
721 cmd->tvc_nexus = tv_nexus;
722 cmd->inflight = vhost_scsi_get_inflight(vq);
724 memcpy(cmd->tvc_cdb, cdb, VHOST_SCSI_MAX_CDB_SIZE);
730 * Map a user memory range into a scatterlist
732 * Returns the number of scatterlist entries used or -errno on error.
735 vhost_scsi_map_to_sgl(struct vhost_scsi_cmd *cmd,
738 struct scatterlist *sgl,
741 unsigned int npages = 0, offset, nbytes;
742 unsigned int pages_nr = iov_num_pages(ptr, len);
743 struct scatterlist *sg = sgl;
744 struct page **pages = cmd->tvc_upages;
747 if (pages_nr > VHOST_SCSI_PREALLOC_UPAGES) {
748 pr_err("vhost_scsi_map_to_sgl() pages_nr: %u greater than"
749 " preallocated VHOST_SCSI_PREALLOC_UPAGES: %u\n",
750 pages_nr, VHOST_SCSI_PREALLOC_UPAGES);
754 ret = get_user_pages_fast((unsigned long)ptr, pages_nr, write, pages);
755 /* No pages were pinned */
758 /* Less pages pinned than wanted */
759 if (ret != pages_nr) {
760 for (i = 0; i < ret; i++)
767 offset = (uintptr_t)ptr & ~PAGE_MASK;
768 nbytes = min_t(unsigned int, PAGE_SIZE - offset, len);
769 sg_set_page(sg, pages[npages], nbytes, offset);
781 vhost_scsi_calc_sgls(struct iov_iter *iter, size_t bytes, int max_sgls)
785 if (!iter || !iter->iov) {
786 pr_err("%s: iter->iov is NULL, but expected bytes: %zu"
787 " present\n", __func__, bytes);
791 sgl_count = iov_iter_npages(iter, 0xffff);
792 if (sgl_count > max_sgls) {
793 pr_err("%s: requested sgl_count: %d exceeds pre-allocated"
794 " max_sgls: %d\n", __func__, sgl_count, max_sgls);
801 vhost_scsi_iov_to_sgl(struct vhost_scsi_cmd *cmd, bool write,
802 struct iov_iter *iter,
803 struct scatterlist *sg, int sg_count)
805 size_t off = iter->iov_offset;
808 for (i = 0; i < iter->nr_segs; i++) {
809 void __user *base = iter->iov[i].iov_base + off;
810 size_t len = iter->iov[i].iov_len - off;
812 ret = vhost_scsi_map_to_sgl(cmd, base, len, sg, write);
814 for (i = 0; i < sg_count; i++) {
815 struct page *page = sg_page(&sg[i]);
828 vhost_scsi_mapal(struct vhost_scsi_cmd *cmd,
829 size_t prot_bytes, struct iov_iter *prot_iter,
830 size_t data_bytes, struct iov_iter *data_iter)
833 bool write = (cmd->tvc_data_direction == DMA_FROM_DEVICE);
836 sgl_count = vhost_scsi_calc_sgls(prot_iter, prot_bytes,
837 VHOST_SCSI_PREALLOC_PROT_SGLS);
841 sg_init_table(cmd->tvc_prot_sgl, sgl_count);
842 cmd->tvc_prot_sgl_count = sgl_count;
843 pr_debug("%s prot_sg %p prot_sgl_count %u\n", __func__,
844 cmd->tvc_prot_sgl, cmd->tvc_prot_sgl_count);
846 ret = vhost_scsi_iov_to_sgl(cmd, write, prot_iter,
848 cmd->tvc_prot_sgl_count);
850 cmd->tvc_prot_sgl_count = 0;
854 sgl_count = vhost_scsi_calc_sgls(data_iter, data_bytes,
855 VHOST_SCSI_PREALLOC_SGLS);
859 sg_init_table(cmd->tvc_sgl, sgl_count);
860 cmd->tvc_sgl_count = sgl_count;
861 pr_debug("%s data_sg %p data_sgl_count %u\n", __func__,
862 cmd->tvc_sgl, cmd->tvc_sgl_count);
864 ret = vhost_scsi_iov_to_sgl(cmd, write, data_iter,
865 cmd->tvc_sgl, cmd->tvc_sgl_count);
867 cmd->tvc_sgl_count = 0;
873 static int vhost_scsi_to_tcm_attr(int attr)
876 case VIRTIO_SCSI_S_SIMPLE:
877 return TCM_SIMPLE_TAG;
878 case VIRTIO_SCSI_S_ORDERED:
879 return TCM_ORDERED_TAG;
880 case VIRTIO_SCSI_S_HEAD:
882 case VIRTIO_SCSI_S_ACA:
887 return TCM_SIMPLE_TAG;
890 static void vhost_scsi_submission_work(struct work_struct *work)
892 struct vhost_scsi_cmd *cmd =
893 container_of(work, struct vhost_scsi_cmd, work);
894 struct vhost_scsi_nexus *tv_nexus;
895 struct se_cmd *se_cmd = &cmd->tvc_se_cmd;
896 struct scatterlist *sg_ptr, *sg_prot_ptr = NULL;
899 /* FIXME: BIDI operation */
900 if (cmd->tvc_sgl_count) {
901 sg_ptr = cmd->tvc_sgl;
903 if (cmd->tvc_prot_sgl_count)
904 sg_prot_ptr = cmd->tvc_prot_sgl;
906 se_cmd->prot_pto = true;
910 tv_nexus = cmd->tvc_nexus;
912 rc = target_submit_cmd_map_sgls(se_cmd, tv_nexus->tvn_se_sess,
913 cmd->tvc_cdb, &cmd->tvc_sense_buf[0],
914 cmd->tvc_lun, cmd->tvc_exp_data_len,
915 vhost_scsi_to_tcm_attr(cmd->tvc_task_attr),
916 cmd->tvc_data_direction, TARGET_SCF_ACK_KREF,
917 sg_ptr, cmd->tvc_sgl_count, NULL, 0, sg_prot_ptr,
918 cmd->tvc_prot_sgl_count);
920 transport_send_check_condition_and_sense(se_cmd,
921 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE, 0);
922 transport_generic_free_cmd(se_cmd, 0);
927 vhost_scsi_send_bad_target(struct vhost_scsi *vs,
928 struct vhost_virtqueue *vq,
929 int head, unsigned out)
931 struct virtio_scsi_cmd_resp __user *resp;
932 struct virtio_scsi_cmd_resp rsp;
935 memset(&rsp, 0, sizeof(rsp));
936 rsp.response = VIRTIO_SCSI_S_BAD_TARGET;
937 resp = vq->iov[out].iov_base;
938 ret = __copy_to_user(resp, &rsp, sizeof(rsp));
940 vhost_add_used_and_signal(&vs->dev, vq, head, 0);
942 pr_err("Faulted on virtio_scsi_cmd_resp\n");
946 vhost_scsi_handle_vq(struct vhost_scsi *vs, struct vhost_virtqueue *vq)
948 struct vhost_scsi_tpg **vs_tpg, *tpg;
949 struct virtio_scsi_cmd_req v_req;
950 struct virtio_scsi_cmd_req_pi v_req_pi;
951 struct vhost_scsi_cmd *cmd;
952 struct iov_iter out_iter, in_iter, prot_iter, data_iter;
954 u32 exp_data_len, data_direction;
956 int head, ret, prot_bytes;
957 size_t req_size, rsp_size = sizeof(struct virtio_scsi_cmd_resp);
958 size_t out_size, in_size;
960 u8 *target, *lunp, task_attr;
961 bool t10_pi = vhost_has_feature(vq, VIRTIO_SCSI_F_T10_PI);
964 mutex_lock(&vq->mutex);
966 * We can handle the vq only after the endpoint is setup by calling the
967 * VHOST_SCSI_SET_ENDPOINT ioctl.
969 vs_tpg = vq->private_data;
973 vhost_disable_notify(&vs->dev, vq);
976 head = vhost_get_vq_desc(vq, vq->iov,
977 ARRAY_SIZE(vq->iov), &out, &in,
979 pr_debug("vhost_get_vq_desc: head: %d, out: %u in: %u\n",
981 /* On error, stop handling until the next kick. */
982 if (unlikely(head < 0))
984 /* Nothing new? Wait for eventfd to tell us they refilled. */
985 if (head == vq->num) {
986 if (unlikely(vhost_enable_notify(&vs->dev, vq))) {
987 vhost_disable_notify(&vs->dev, vq);
993 * Check for a sane response buffer so we can report early
994 * errors back to the guest.
996 if (unlikely(vq->iov[out].iov_len < rsp_size)) {
997 vq_err(vq, "Expecting at least virtio_scsi_cmd_resp"
998 " size, got %zu bytes\n", vq->iov[out].iov_len);
1002 * Setup pointers and values based upon different virtio-scsi
1003 * request header if T10_PI is enabled in KVM guest.
1007 req_size = sizeof(v_req_pi);
1008 lunp = &v_req_pi.lun[0];
1009 target = &v_req_pi.lun[1];
1012 req_size = sizeof(v_req);
1013 lunp = &v_req.lun[0];
1014 target = &v_req.lun[1];
1017 * FIXME: Not correct for BIDI operation
1019 out_size = iov_length(vq->iov, out);
1020 in_size = iov_length(&vq->iov[out], in);
1023 * Copy over the virtio-scsi request header, which for a
1024 * ANY_LAYOUT enabled guest may span multiple iovecs, or a
1025 * single iovec may contain both the header + outgoing
1028 * copy_from_iter() will advance out_iter, so that it will
1029 * point at the start of the outgoing WRITE payload, if
1030 * DMA_TO_DEVICE is set.
1032 iov_iter_init(&out_iter, WRITE, vq->iov, out, out_size);
1034 ret = copy_from_iter(req, req_size, &out_iter);
1035 if (unlikely(ret != req_size)) {
1036 vq_err(vq, "Faulted on copy_from_iter\n");
1037 vhost_scsi_send_bad_target(vs, vq, head, out);
1040 /* virtio-scsi spec requires byte 0 of the lun to be 1 */
1041 if (unlikely(*lunp != 1)) {
1042 vq_err(vq, "Illegal virtio-scsi lun: %u\n", *lunp);
1043 vhost_scsi_send_bad_target(vs, vq, head, out);
1047 tpg = ACCESS_ONCE(vs_tpg[*target]);
1048 if (unlikely(!tpg)) {
1049 /* Target does not exist, fail the request */
1050 vhost_scsi_send_bad_target(vs, vq, head, out);
1054 * Determine data_direction by calculating the total outgoing
1055 * iovec sizes + incoming iovec sizes vs. virtio-scsi request +
1056 * response headers respectively.
1058 * For DMA_TO_DEVICE this is out_iter, which is already pointing
1059 * to the right place.
1061 * For DMA_FROM_DEVICE, the iovec will be just past the end
1062 * of the virtio-scsi response header in either the same
1063 * or immediately following iovec.
1065 * Any associated T10_PI bytes for the outgoing / incoming
1066 * payloads are included in calculation of exp_data_len here.
1070 if (out_size > req_size) {
1071 data_direction = DMA_TO_DEVICE;
1072 exp_data_len = out_size - req_size;
1073 data_iter = out_iter;
1074 } else if (in_size > rsp_size) {
1075 data_direction = DMA_FROM_DEVICE;
1076 exp_data_len = in_size - rsp_size;
1078 iov_iter_init(&in_iter, READ, &vq->iov[out], in,
1079 rsp_size + exp_data_len);
1080 iov_iter_advance(&in_iter, rsp_size);
1081 data_iter = in_iter;
1083 data_direction = DMA_NONE;
1087 * If T10_PI header + payload is present, setup prot_iter values
1088 * and recalculate data_iter for vhost_scsi_mapal() mapping to
1089 * host scatterlists via get_user_pages_fast().
1092 if (v_req_pi.pi_bytesout) {
1093 if (data_direction != DMA_TO_DEVICE) {
1094 vq_err(vq, "Received non zero pi_bytesout,"
1095 " but wrong data_direction\n");
1096 vhost_scsi_send_bad_target(vs, vq, head, out);
1099 prot_bytes = vhost32_to_cpu(vq, v_req_pi.pi_bytesout);
1100 } else if (v_req_pi.pi_bytesin) {
1101 if (data_direction != DMA_FROM_DEVICE) {
1102 vq_err(vq, "Received non zero pi_bytesin,"
1103 " but wrong data_direction\n");
1104 vhost_scsi_send_bad_target(vs, vq, head, out);
1107 prot_bytes = vhost32_to_cpu(vq, v_req_pi.pi_bytesin);
1110 * Set prot_iter to data_iter, and advance past any
1111 * preceeding prot_bytes that may be present.
1113 * Also fix up the exp_data_len to reflect only the
1114 * actual data payload length.
1117 exp_data_len -= prot_bytes;
1118 prot_iter = data_iter;
1119 iov_iter_advance(&data_iter, prot_bytes);
1121 tag = vhost64_to_cpu(vq, v_req_pi.tag);
1122 task_attr = v_req_pi.task_attr;
1123 cdb = &v_req_pi.cdb[0];
1124 lun = ((v_req_pi.lun[2] << 8) | v_req_pi.lun[3]) & 0x3FFF;
1126 tag = vhost64_to_cpu(vq, v_req.tag);
1127 task_attr = v_req.task_attr;
1128 cdb = &v_req.cdb[0];
1129 lun = ((v_req.lun[2] << 8) | v_req.lun[3]) & 0x3FFF;
1132 * Check that the received CDB size does not exceeded our
1133 * hardcoded max for vhost-scsi, then get a pre-allocated
1134 * cmd descriptor for the new virtio-scsi tag.
1136 * TODO what if cdb was too small for varlen cdb header?
1138 if (unlikely(scsi_command_size(cdb) > VHOST_SCSI_MAX_CDB_SIZE)) {
1139 vq_err(vq, "Received SCSI CDB with command_size: %d that"
1140 " exceeds SCSI_MAX_VARLEN_CDB_SIZE: %d\n",
1141 scsi_command_size(cdb), VHOST_SCSI_MAX_CDB_SIZE);
1142 vhost_scsi_send_bad_target(vs, vq, head, out);
1145 cmd = vhost_scsi_get_tag(vq, tpg, cdb, tag, lun, task_attr,
1146 exp_data_len + prot_bytes,
1149 vq_err(vq, "vhost_scsi_get_tag failed %ld\n",
1151 vhost_scsi_send_bad_target(vs, vq, head, out);
1154 cmd->tvc_vhost = vs;
1156 cmd->tvc_resp_iov = &vq->iov[out];
1157 cmd->tvc_in_iovs = in;
1159 pr_debug("vhost_scsi got command opcode: %#02x, lun: %d\n",
1160 cmd->tvc_cdb[0], cmd->tvc_lun);
1161 pr_debug("cmd: %p exp_data_len: %d, prot_bytes: %d data_direction:"
1162 " %d\n", cmd, exp_data_len, prot_bytes, data_direction);
1164 if (data_direction != DMA_NONE) {
1165 ret = vhost_scsi_mapal(cmd,
1166 prot_bytes, &prot_iter,
1167 exp_data_len, &data_iter);
1168 if (unlikely(ret)) {
1169 vq_err(vq, "Failed to map iov to sgl\n");
1170 vhost_scsi_release_cmd(&cmd->tvc_se_cmd);
1171 vhost_scsi_send_bad_target(vs, vq, head, out);
1176 * Save the descriptor from vhost_get_vq_desc() to be used to
1177 * complete the virtio-scsi request in TCM callback context via
1178 * vhost_scsi_queue_data_in() and vhost_scsi_queue_status()
1180 cmd->tvc_vq_desc = head;
1182 * Dispatch cmd descriptor for cmwq execution in process
1183 * context provided by vhost_scsi_workqueue. This also ensures
1184 * cmd is executed on the same kworker CPU as this vhost
1185 * thread to gain positive L2 cache locality effects.
1187 INIT_WORK(&cmd->work, vhost_scsi_submission_work);
1188 queue_work(vhost_scsi_workqueue, &cmd->work);
1191 mutex_unlock(&vq->mutex);
1194 static void vhost_scsi_ctl_handle_kick(struct vhost_work *work)
1196 pr_debug("%s: The handling func for control queue.\n", __func__);
1200 vhost_scsi_send_evt(struct vhost_scsi *vs,
1201 struct vhost_scsi_tpg *tpg,
1206 struct vhost_scsi_evt *evt;
1208 evt = vhost_scsi_allocate_evt(vs, event, reason);
1213 /* TODO: share lun setup code with virtio-scsi.ko */
1215 * Note: evt->event is zeroed when we allocate it and
1216 * lun[4-7] need to be zero according to virtio-scsi spec.
1218 evt->event.lun[0] = 0x01;
1219 evt->event.lun[1] = tpg->tport_tpgt;
1220 if (lun->unpacked_lun >= 256)
1221 evt->event.lun[2] = lun->unpacked_lun >> 8 | 0x40 ;
1222 evt->event.lun[3] = lun->unpacked_lun & 0xFF;
1225 llist_add(&evt->list, &vs->vs_event_list);
1226 vhost_work_queue(&vs->dev, &vs->vs_event_work);
1229 static void vhost_scsi_evt_handle_kick(struct vhost_work *work)
1231 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1233 struct vhost_scsi *vs = container_of(vq->dev, struct vhost_scsi, dev);
1235 mutex_lock(&vq->mutex);
1236 if (!vq->private_data)
1239 if (vs->vs_events_missed)
1240 vhost_scsi_send_evt(vs, NULL, NULL, VIRTIO_SCSI_T_NO_EVENT, 0);
1242 mutex_unlock(&vq->mutex);
1245 static void vhost_scsi_handle_kick(struct vhost_work *work)
1247 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1249 struct vhost_scsi *vs = container_of(vq->dev, struct vhost_scsi, dev);
1251 vhost_scsi_handle_vq(vs, vq);
1254 static void vhost_scsi_flush_vq(struct vhost_scsi *vs, int index)
1256 vhost_poll_flush(&vs->vqs[index].vq.poll);
1259 /* Callers must hold dev mutex */
1260 static void vhost_scsi_flush(struct vhost_scsi *vs)
1262 struct vhost_scsi_inflight *old_inflight[VHOST_SCSI_MAX_VQ];
1265 /* Init new inflight and remember the old inflight */
1266 vhost_scsi_init_inflight(vs, old_inflight);
1269 * The inflight->kref was initialized to 1. We decrement it here to
1270 * indicate the start of the flush operation so that it will reach 0
1271 * when all the reqs are finished.
1273 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1274 kref_put(&old_inflight[i]->kref, vhost_scsi_done_inflight);
1276 /* Flush both the vhost poll and vhost work */
1277 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1278 vhost_scsi_flush_vq(vs, i);
1279 vhost_work_flush(&vs->dev, &vs->vs_completion_work);
1280 vhost_work_flush(&vs->dev, &vs->vs_event_work);
1282 /* Wait for all reqs issued before the flush to be finished */
1283 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1284 wait_for_completion(&old_inflight[i]->comp);
1288 * Called from vhost_scsi_ioctl() context to walk the list of available
1289 * vhost_scsi_tpg with an active struct vhost_scsi_nexus
1291 * The lock nesting rule is:
1292 * vhost_scsi_mutex -> vs->dev.mutex -> tpg->tv_tpg_mutex -> vq->mutex
1295 vhost_scsi_set_endpoint(struct vhost_scsi *vs,
1296 struct vhost_scsi_target *t)
1298 struct se_portal_group *se_tpg;
1299 struct vhost_scsi_tport *tv_tport;
1300 struct vhost_scsi_tpg *tpg;
1301 struct vhost_scsi_tpg **vs_tpg;
1302 struct vhost_virtqueue *vq;
1303 int index, ret, i, len;
1306 mutex_lock(&vhost_scsi_mutex);
1307 mutex_lock(&vs->dev.mutex);
1309 /* Verify that ring has been setup correctly. */
1310 for (index = 0; index < vs->dev.nvqs; ++index) {
1311 /* Verify that ring has been setup correctly. */
1312 if (!vhost_vq_access_ok(&vs->vqs[index].vq)) {
1318 len = sizeof(vs_tpg[0]) * VHOST_SCSI_MAX_TARGET;
1319 vs_tpg = kzalloc(len, GFP_KERNEL);
1325 memcpy(vs_tpg, vs->vs_tpg, len);
1327 list_for_each_entry(tpg, &vhost_scsi_list, tv_tpg_list) {
1328 mutex_lock(&tpg->tv_tpg_mutex);
1329 if (!tpg->tpg_nexus) {
1330 mutex_unlock(&tpg->tv_tpg_mutex);
1333 if (tpg->tv_tpg_vhost_count != 0) {
1334 mutex_unlock(&tpg->tv_tpg_mutex);
1337 tv_tport = tpg->tport;
1339 if (!strcmp(tv_tport->tport_name, t->vhost_wwpn)) {
1340 if (vs->vs_tpg && vs->vs_tpg[tpg->tport_tpgt]) {
1342 mutex_unlock(&tpg->tv_tpg_mutex);
1347 * In order to ensure individual vhost-scsi configfs
1348 * groups cannot be removed while in use by vhost ioctl,
1349 * go ahead and take an explicit se_tpg->tpg_group.cg_item
1352 se_tpg = &tpg->se_tpg;
1353 ret = target_depend_item(&se_tpg->tpg_group.cg_item);
1355 pr_warn("configfs_depend_item() failed: %d\n", ret);
1357 mutex_unlock(&tpg->tv_tpg_mutex);
1360 tpg->tv_tpg_vhost_count++;
1361 tpg->vhost_scsi = vs;
1362 vs_tpg[tpg->tport_tpgt] = tpg;
1363 smp_mb__after_atomic();
1366 mutex_unlock(&tpg->tv_tpg_mutex);
1370 memcpy(vs->vs_vhost_wwpn, t->vhost_wwpn,
1371 sizeof(vs->vs_vhost_wwpn));
1372 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1373 vq = &vs->vqs[i].vq;
1374 mutex_lock(&vq->mutex);
1375 vq->private_data = vs_tpg;
1376 vhost_init_used(vq);
1377 mutex_unlock(&vq->mutex);
1385 * Act as synchronize_rcu to make sure access to
1386 * old vs->vs_tpg is finished.
1388 vhost_scsi_flush(vs);
1390 vs->vs_tpg = vs_tpg;
1393 mutex_unlock(&vs->dev.mutex);
1394 mutex_unlock(&vhost_scsi_mutex);
1399 vhost_scsi_clear_endpoint(struct vhost_scsi *vs,
1400 struct vhost_scsi_target *t)
1402 struct se_portal_group *se_tpg;
1403 struct vhost_scsi_tport *tv_tport;
1404 struct vhost_scsi_tpg *tpg;
1405 struct vhost_virtqueue *vq;
1410 mutex_lock(&vhost_scsi_mutex);
1411 mutex_lock(&vs->dev.mutex);
1412 /* Verify that ring has been setup correctly. */
1413 for (index = 0; index < vs->dev.nvqs; ++index) {
1414 if (!vhost_vq_access_ok(&vs->vqs[index].vq)) {
1425 for (i = 0; i < VHOST_SCSI_MAX_TARGET; i++) {
1427 tpg = vs->vs_tpg[target];
1431 mutex_lock(&tpg->tv_tpg_mutex);
1432 tv_tport = tpg->tport;
1438 if (strcmp(tv_tport->tport_name, t->vhost_wwpn)) {
1439 pr_warn("tv_tport->tport_name: %s, tpg->tport_tpgt: %hu"
1440 " does not match t->vhost_wwpn: %s, t->vhost_tpgt: %hu\n",
1441 tv_tport->tport_name, tpg->tport_tpgt,
1442 t->vhost_wwpn, t->vhost_tpgt);
1446 tpg->tv_tpg_vhost_count--;
1447 tpg->vhost_scsi = NULL;
1448 vs->vs_tpg[target] = NULL;
1450 mutex_unlock(&tpg->tv_tpg_mutex);
1452 * Release se_tpg->tpg_group.cg_item configfs dependency now
1453 * to allow vhost-scsi WWPN se_tpg->tpg_group shutdown to occur.
1455 se_tpg = &tpg->se_tpg;
1456 target_undepend_item(&se_tpg->tpg_group.cg_item);
1459 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1460 vq = &vs->vqs[i].vq;
1461 mutex_lock(&vq->mutex);
1462 vq->private_data = NULL;
1463 mutex_unlock(&vq->mutex);
1467 * Act as synchronize_rcu to make sure access to
1468 * old vs->vs_tpg is finished.
1470 vhost_scsi_flush(vs);
1473 WARN_ON(vs->vs_events_nr);
1474 mutex_unlock(&vs->dev.mutex);
1475 mutex_unlock(&vhost_scsi_mutex);
1479 mutex_unlock(&tpg->tv_tpg_mutex);
1481 mutex_unlock(&vs->dev.mutex);
1482 mutex_unlock(&vhost_scsi_mutex);
1486 static int vhost_scsi_set_features(struct vhost_scsi *vs, u64 features)
1488 struct vhost_virtqueue *vq;
1491 if (features & ~VHOST_SCSI_FEATURES)
1494 mutex_lock(&vs->dev.mutex);
1495 if ((features & (1 << VHOST_F_LOG_ALL)) &&
1496 !vhost_log_access_ok(&vs->dev)) {
1497 mutex_unlock(&vs->dev.mutex);
1501 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1502 vq = &vs->vqs[i].vq;
1503 mutex_lock(&vq->mutex);
1504 vq->acked_features = features;
1505 mutex_unlock(&vq->mutex);
1507 mutex_unlock(&vs->dev.mutex);
1511 static int vhost_scsi_open(struct inode *inode, struct file *f)
1513 struct vhost_scsi *vs;
1514 struct vhost_virtqueue **vqs;
1517 vs = kzalloc(sizeof(*vs), GFP_KERNEL | __GFP_NOWARN | __GFP_REPEAT);
1519 vs = vzalloc(sizeof(*vs));
1524 vqs = kmalloc(VHOST_SCSI_MAX_VQ * sizeof(*vqs), GFP_KERNEL);
1528 vhost_work_init(&vs->vs_completion_work, vhost_scsi_complete_cmd_work);
1529 vhost_work_init(&vs->vs_event_work, vhost_scsi_evt_work);
1531 vs->vs_events_nr = 0;
1532 vs->vs_events_missed = false;
1534 vqs[VHOST_SCSI_VQ_CTL] = &vs->vqs[VHOST_SCSI_VQ_CTL].vq;
1535 vqs[VHOST_SCSI_VQ_EVT] = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1536 vs->vqs[VHOST_SCSI_VQ_CTL].vq.handle_kick = vhost_scsi_ctl_handle_kick;
1537 vs->vqs[VHOST_SCSI_VQ_EVT].vq.handle_kick = vhost_scsi_evt_handle_kick;
1538 for (i = VHOST_SCSI_VQ_IO; i < VHOST_SCSI_MAX_VQ; i++) {
1539 vqs[i] = &vs->vqs[i].vq;
1540 vs->vqs[i].vq.handle_kick = vhost_scsi_handle_kick;
1542 vhost_dev_init(&vs->dev, vqs, VHOST_SCSI_MAX_VQ);
1544 vhost_scsi_init_inflight(vs, NULL);
1546 f->private_data = vs;
1555 static int vhost_scsi_release(struct inode *inode, struct file *f)
1557 struct vhost_scsi *vs = f->private_data;
1558 struct vhost_scsi_target t;
1560 mutex_lock(&vs->dev.mutex);
1561 memcpy(t.vhost_wwpn, vs->vs_vhost_wwpn, sizeof(t.vhost_wwpn));
1562 mutex_unlock(&vs->dev.mutex);
1563 vhost_scsi_clear_endpoint(vs, &t);
1564 vhost_dev_stop(&vs->dev);
1565 vhost_dev_cleanup(&vs->dev, false);
1566 /* Jobs can re-queue themselves in evt kick handler. Do extra flush. */
1567 vhost_scsi_flush(vs);
1574 vhost_scsi_ioctl(struct file *f,
1578 struct vhost_scsi *vs = f->private_data;
1579 struct vhost_scsi_target backend;
1580 void __user *argp = (void __user *)arg;
1581 u64 __user *featurep = argp;
1582 u32 __user *eventsp = argp;
1585 int r, abi_version = VHOST_SCSI_ABI_VERSION;
1586 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1589 case VHOST_SCSI_SET_ENDPOINT:
1590 if (copy_from_user(&backend, argp, sizeof backend))
1592 if (backend.reserved != 0)
1595 return vhost_scsi_set_endpoint(vs, &backend);
1596 case VHOST_SCSI_CLEAR_ENDPOINT:
1597 if (copy_from_user(&backend, argp, sizeof backend))
1599 if (backend.reserved != 0)
1602 return vhost_scsi_clear_endpoint(vs, &backend);
1603 case VHOST_SCSI_GET_ABI_VERSION:
1604 if (copy_to_user(argp, &abi_version, sizeof abi_version))
1607 case VHOST_SCSI_SET_EVENTS_MISSED:
1608 if (get_user(events_missed, eventsp))
1610 mutex_lock(&vq->mutex);
1611 vs->vs_events_missed = events_missed;
1612 mutex_unlock(&vq->mutex);
1614 case VHOST_SCSI_GET_EVENTS_MISSED:
1615 mutex_lock(&vq->mutex);
1616 events_missed = vs->vs_events_missed;
1617 mutex_unlock(&vq->mutex);
1618 if (put_user(events_missed, eventsp))
1621 case VHOST_GET_FEATURES:
1622 features = VHOST_SCSI_FEATURES;
1623 if (copy_to_user(featurep, &features, sizeof features))
1626 case VHOST_SET_FEATURES:
1627 if (copy_from_user(&features, featurep, sizeof features))
1629 return vhost_scsi_set_features(vs, features);
1631 mutex_lock(&vs->dev.mutex);
1632 r = vhost_dev_ioctl(&vs->dev, ioctl, argp);
1633 /* TODO: flush backend after dev ioctl. */
1634 if (r == -ENOIOCTLCMD)
1635 r = vhost_vring_ioctl(&vs->dev, ioctl, argp);
1636 mutex_unlock(&vs->dev.mutex);
1641 #ifdef CONFIG_COMPAT
1642 static long vhost_scsi_compat_ioctl(struct file *f, unsigned int ioctl,
1645 return vhost_scsi_ioctl(f, ioctl, (unsigned long)compat_ptr(arg));
1649 static const struct file_operations vhost_scsi_fops = {
1650 .owner = THIS_MODULE,
1651 .release = vhost_scsi_release,
1652 .unlocked_ioctl = vhost_scsi_ioctl,
1653 #ifdef CONFIG_COMPAT
1654 .compat_ioctl = vhost_scsi_compat_ioctl,
1656 .open = vhost_scsi_open,
1657 .llseek = noop_llseek,
1660 static struct miscdevice vhost_scsi_misc = {
1666 static int __init vhost_scsi_register(void)
1668 return misc_register(&vhost_scsi_misc);
1671 static int vhost_scsi_deregister(void)
1673 return misc_deregister(&vhost_scsi_misc);
1676 static char *vhost_scsi_dump_proto_id(struct vhost_scsi_tport *tport)
1678 switch (tport->tport_proto_id) {
1679 case SCSI_PROTOCOL_SAS:
1681 case SCSI_PROTOCOL_FCP:
1683 case SCSI_PROTOCOL_ISCSI:
1693 vhost_scsi_do_plug(struct vhost_scsi_tpg *tpg,
1694 struct se_lun *lun, bool plug)
1697 struct vhost_scsi *vs = tpg->vhost_scsi;
1698 struct vhost_virtqueue *vq;
1704 mutex_lock(&vs->dev.mutex);
1707 reason = VIRTIO_SCSI_EVT_RESET_RESCAN;
1709 reason = VIRTIO_SCSI_EVT_RESET_REMOVED;
1711 vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1712 mutex_lock(&vq->mutex);
1713 if (vhost_has_feature(vq, VIRTIO_SCSI_F_HOTPLUG))
1714 vhost_scsi_send_evt(vs, tpg, lun,
1715 VIRTIO_SCSI_T_TRANSPORT_RESET, reason);
1716 mutex_unlock(&vq->mutex);
1717 mutex_unlock(&vs->dev.mutex);
1720 static void vhost_scsi_hotplug(struct vhost_scsi_tpg *tpg, struct se_lun *lun)
1722 vhost_scsi_do_plug(tpg, lun, true);
1725 static void vhost_scsi_hotunplug(struct vhost_scsi_tpg *tpg, struct se_lun *lun)
1727 vhost_scsi_do_plug(tpg, lun, false);
1730 static int vhost_scsi_port_link(struct se_portal_group *se_tpg,
1733 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1734 struct vhost_scsi_tpg, se_tpg);
1736 mutex_lock(&vhost_scsi_mutex);
1738 mutex_lock(&tpg->tv_tpg_mutex);
1739 tpg->tv_tpg_port_count++;
1740 mutex_unlock(&tpg->tv_tpg_mutex);
1742 vhost_scsi_hotplug(tpg, lun);
1744 mutex_unlock(&vhost_scsi_mutex);
1749 static void vhost_scsi_port_unlink(struct se_portal_group *se_tpg,
1752 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1753 struct vhost_scsi_tpg, se_tpg);
1755 mutex_lock(&vhost_scsi_mutex);
1757 mutex_lock(&tpg->tv_tpg_mutex);
1758 tpg->tv_tpg_port_count--;
1759 mutex_unlock(&tpg->tv_tpg_mutex);
1761 vhost_scsi_hotunplug(tpg, lun);
1763 mutex_unlock(&vhost_scsi_mutex);
1766 static void vhost_scsi_free_cmd_map_res(struct vhost_scsi_nexus *nexus,
1767 struct se_session *se_sess)
1769 struct vhost_scsi_cmd *tv_cmd;
1772 if (!se_sess->sess_cmd_map)
1775 for (i = 0; i < VHOST_SCSI_DEFAULT_TAGS; i++) {
1776 tv_cmd = &((struct vhost_scsi_cmd *)se_sess->sess_cmd_map)[i];
1778 kfree(tv_cmd->tvc_sgl);
1779 kfree(tv_cmd->tvc_prot_sgl);
1780 kfree(tv_cmd->tvc_upages);
1784 static ssize_t vhost_scsi_tpg_attrib_store_fabric_prot_type(
1785 struct se_portal_group *se_tpg,
1789 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1790 struct vhost_scsi_tpg, se_tpg);
1792 int ret = kstrtoul(page, 0, &val);
1795 pr_err("kstrtoul() returned %d for fabric_prot_type\n", ret);
1798 if (val != 0 && val != 1 && val != 3) {
1799 pr_err("Invalid vhost_scsi fabric_prot_type: %lu\n", val);
1802 tpg->tv_fabric_prot_type = val;
1807 static ssize_t vhost_scsi_tpg_attrib_show_fabric_prot_type(
1808 struct se_portal_group *se_tpg,
1811 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1812 struct vhost_scsi_tpg, se_tpg);
1814 return sprintf(page, "%d\n", tpg->tv_fabric_prot_type);
1816 TF_TPG_ATTRIB_ATTR(vhost_scsi, fabric_prot_type, S_IRUGO | S_IWUSR);
1818 static struct configfs_attribute *vhost_scsi_tpg_attrib_attrs[] = {
1819 &vhost_scsi_tpg_attrib_fabric_prot_type.attr,
1823 static int vhost_scsi_make_nexus(struct vhost_scsi_tpg *tpg,
1826 struct se_portal_group *se_tpg;
1827 struct se_session *se_sess;
1828 struct vhost_scsi_nexus *tv_nexus;
1829 struct vhost_scsi_cmd *tv_cmd;
1832 mutex_lock(&tpg->tv_tpg_mutex);
1833 if (tpg->tpg_nexus) {
1834 mutex_unlock(&tpg->tv_tpg_mutex);
1835 pr_debug("tpg->tpg_nexus already exists\n");
1838 se_tpg = &tpg->se_tpg;
1840 tv_nexus = kzalloc(sizeof(struct vhost_scsi_nexus), GFP_KERNEL);
1842 mutex_unlock(&tpg->tv_tpg_mutex);
1843 pr_err("Unable to allocate struct vhost_scsi_nexus\n");
1847 * Initialize the struct se_session pointer and setup tagpool
1848 * for struct vhost_scsi_cmd descriptors
1850 tv_nexus->tvn_se_sess = transport_init_session_tags(
1851 VHOST_SCSI_DEFAULT_TAGS,
1852 sizeof(struct vhost_scsi_cmd),
1853 TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS);
1854 if (IS_ERR(tv_nexus->tvn_se_sess)) {
1855 mutex_unlock(&tpg->tv_tpg_mutex);
1859 se_sess = tv_nexus->tvn_se_sess;
1860 for (i = 0; i < VHOST_SCSI_DEFAULT_TAGS; i++) {
1861 tv_cmd = &((struct vhost_scsi_cmd *)se_sess->sess_cmd_map)[i];
1863 tv_cmd->tvc_sgl = kzalloc(sizeof(struct scatterlist) *
1864 VHOST_SCSI_PREALLOC_SGLS, GFP_KERNEL);
1865 if (!tv_cmd->tvc_sgl) {
1866 mutex_unlock(&tpg->tv_tpg_mutex);
1867 pr_err("Unable to allocate tv_cmd->tvc_sgl\n");
1871 tv_cmd->tvc_upages = kzalloc(sizeof(struct page *) *
1872 VHOST_SCSI_PREALLOC_UPAGES, GFP_KERNEL);
1873 if (!tv_cmd->tvc_upages) {
1874 mutex_unlock(&tpg->tv_tpg_mutex);
1875 pr_err("Unable to allocate tv_cmd->tvc_upages\n");
1879 tv_cmd->tvc_prot_sgl = kzalloc(sizeof(struct scatterlist) *
1880 VHOST_SCSI_PREALLOC_PROT_SGLS, GFP_KERNEL);
1881 if (!tv_cmd->tvc_prot_sgl) {
1882 mutex_unlock(&tpg->tv_tpg_mutex);
1883 pr_err("Unable to allocate tv_cmd->tvc_prot_sgl\n");
1888 * Since we are running in 'demo mode' this call with generate a
1889 * struct se_node_acl for the vhost_scsi struct se_portal_group with
1890 * the SCSI Initiator port name of the passed configfs group 'name'.
1892 tv_nexus->tvn_se_sess->se_node_acl = core_tpg_check_initiator_node_acl(
1893 se_tpg, (unsigned char *)name);
1894 if (!tv_nexus->tvn_se_sess->se_node_acl) {
1895 mutex_unlock(&tpg->tv_tpg_mutex);
1896 pr_debug("core_tpg_check_initiator_node_acl() failed"
1901 * Now register the TCM vhost virtual I_T Nexus as active.
1903 transport_register_session(se_tpg, tv_nexus->tvn_se_sess->se_node_acl,
1904 tv_nexus->tvn_se_sess, tv_nexus);
1905 tpg->tpg_nexus = tv_nexus;
1907 mutex_unlock(&tpg->tv_tpg_mutex);
1911 vhost_scsi_free_cmd_map_res(tv_nexus, se_sess);
1912 transport_free_session(se_sess);
1917 static int vhost_scsi_drop_nexus(struct vhost_scsi_tpg *tpg)
1919 struct se_session *se_sess;
1920 struct vhost_scsi_nexus *tv_nexus;
1922 mutex_lock(&tpg->tv_tpg_mutex);
1923 tv_nexus = tpg->tpg_nexus;
1925 mutex_unlock(&tpg->tv_tpg_mutex);
1929 se_sess = tv_nexus->tvn_se_sess;
1931 mutex_unlock(&tpg->tv_tpg_mutex);
1935 if (tpg->tv_tpg_port_count != 0) {
1936 mutex_unlock(&tpg->tv_tpg_mutex);
1937 pr_err("Unable to remove TCM_vhost I_T Nexus with"
1938 " active TPG port count: %d\n",
1939 tpg->tv_tpg_port_count);
1943 if (tpg->tv_tpg_vhost_count != 0) {
1944 mutex_unlock(&tpg->tv_tpg_mutex);
1945 pr_err("Unable to remove TCM_vhost I_T Nexus with"
1946 " active TPG vhost count: %d\n",
1947 tpg->tv_tpg_vhost_count);
1951 pr_debug("TCM_vhost_ConfigFS: Removing I_T Nexus to emulated"
1952 " %s Initiator Port: %s\n", vhost_scsi_dump_proto_id(tpg->tport),
1953 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1955 vhost_scsi_free_cmd_map_res(tv_nexus, se_sess);
1957 * Release the SCSI I_T Nexus to the emulated vhost Target Port
1959 transport_deregister_session(tv_nexus->tvn_se_sess);
1960 tpg->tpg_nexus = NULL;
1961 mutex_unlock(&tpg->tv_tpg_mutex);
1967 static ssize_t vhost_scsi_tpg_show_nexus(struct se_portal_group *se_tpg,
1970 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1971 struct vhost_scsi_tpg, se_tpg);
1972 struct vhost_scsi_nexus *tv_nexus;
1975 mutex_lock(&tpg->tv_tpg_mutex);
1976 tv_nexus = tpg->tpg_nexus;
1978 mutex_unlock(&tpg->tv_tpg_mutex);
1981 ret = snprintf(page, PAGE_SIZE, "%s\n",
1982 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1983 mutex_unlock(&tpg->tv_tpg_mutex);
1988 static ssize_t vhost_scsi_tpg_store_nexus(struct se_portal_group *se_tpg,
1992 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1993 struct vhost_scsi_tpg, se_tpg);
1994 struct vhost_scsi_tport *tport_wwn = tpg->tport;
1995 unsigned char i_port[VHOST_SCSI_NAMELEN], *ptr, *port_ptr;
1998 * Shutdown the active I_T nexus if 'NULL' is passed..
2000 if (!strncmp(page, "NULL", 4)) {
2001 ret = vhost_scsi_drop_nexus(tpg);
2002 return (!ret) ? count : ret;
2005 * Otherwise make sure the passed virtual Initiator port WWN matches
2006 * the fabric protocol_id set in vhost_scsi_make_tport(), and call
2007 * vhost_scsi_make_nexus().
2009 if (strlen(page) >= VHOST_SCSI_NAMELEN) {
2010 pr_err("Emulated NAA Sas Address: %s, exceeds"
2011 " max: %d\n", page, VHOST_SCSI_NAMELEN);
2014 snprintf(&i_port[0], VHOST_SCSI_NAMELEN, "%s", page);
2016 ptr = strstr(i_port, "naa.");
2018 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_SAS) {
2019 pr_err("Passed SAS Initiator Port %s does not"
2020 " match target port protoid: %s\n", i_port,
2021 vhost_scsi_dump_proto_id(tport_wwn));
2024 port_ptr = &i_port[0];
2027 ptr = strstr(i_port, "fc.");
2029 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_FCP) {
2030 pr_err("Passed FCP Initiator Port %s does not"
2031 " match target port protoid: %s\n", i_port,
2032 vhost_scsi_dump_proto_id(tport_wwn));
2035 port_ptr = &i_port[3]; /* Skip over "fc." */
2038 ptr = strstr(i_port, "iqn.");
2040 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_ISCSI) {
2041 pr_err("Passed iSCSI Initiator Port %s does not"
2042 " match target port protoid: %s\n", i_port,
2043 vhost_scsi_dump_proto_id(tport_wwn));
2046 port_ptr = &i_port[0];
2049 pr_err("Unable to locate prefix for emulated Initiator Port:"
2053 * Clear any trailing newline for the NAA WWN
2056 if (i_port[strlen(i_port)-1] == '\n')
2057 i_port[strlen(i_port)-1] = '\0';
2059 ret = vhost_scsi_make_nexus(tpg, port_ptr);
2066 TF_TPG_BASE_ATTR(vhost_scsi, nexus, S_IRUGO | S_IWUSR);
2068 static struct configfs_attribute *vhost_scsi_tpg_attrs[] = {
2069 &vhost_scsi_tpg_nexus.attr,
2073 static struct se_portal_group *
2074 vhost_scsi_make_tpg(struct se_wwn *wwn,
2075 struct config_group *group,
2078 struct vhost_scsi_tport *tport = container_of(wwn,
2079 struct vhost_scsi_tport, tport_wwn);
2081 struct vhost_scsi_tpg *tpg;
2085 if (strstr(name, "tpgt_") != name)
2086 return ERR_PTR(-EINVAL);
2087 if (kstrtou16(name + 5, 10, &tpgt) || tpgt >= VHOST_SCSI_MAX_TARGET)
2088 return ERR_PTR(-EINVAL);
2090 tpg = kzalloc(sizeof(struct vhost_scsi_tpg), GFP_KERNEL);
2092 pr_err("Unable to allocate struct vhost_scsi_tpg");
2093 return ERR_PTR(-ENOMEM);
2095 mutex_init(&tpg->tv_tpg_mutex);
2096 INIT_LIST_HEAD(&tpg->tv_tpg_list);
2098 tpg->tport_tpgt = tpgt;
2100 ret = core_tpg_register(&vhost_scsi_ops, wwn, &tpg->se_tpg,
2101 tport->tport_proto_id);
2106 mutex_lock(&vhost_scsi_mutex);
2107 list_add_tail(&tpg->tv_tpg_list, &vhost_scsi_list);
2108 mutex_unlock(&vhost_scsi_mutex);
2110 return &tpg->se_tpg;
2113 static void vhost_scsi_drop_tpg(struct se_portal_group *se_tpg)
2115 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
2116 struct vhost_scsi_tpg, se_tpg);
2118 mutex_lock(&vhost_scsi_mutex);
2119 list_del(&tpg->tv_tpg_list);
2120 mutex_unlock(&vhost_scsi_mutex);
2122 * Release the virtual I_T Nexus for this vhost TPG
2124 vhost_scsi_drop_nexus(tpg);
2126 * Deregister the se_tpg from TCM..
2128 core_tpg_deregister(se_tpg);
2132 static struct se_wwn *
2133 vhost_scsi_make_tport(struct target_fabric_configfs *tf,
2134 struct config_group *group,
2137 struct vhost_scsi_tport *tport;
2142 /* if (vhost_scsi_parse_wwn(name, &wwpn, 1) < 0)
2143 return ERR_PTR(-EINVAL); */
2145 tport = kzalloc(sizeof(struct vhost_scsi_tport), GFP_KERNEL);
2147 pr_err("Unable to allocate struct vhost_scsi_tport");
2148 return ERR_PTR(-ENOMEM);
2150 tport->tport_wwpn = wwpn;
2152 * Determine the emulated Protocol Identifier and Target Port Name
2153 * based on the incoming configfs directory name.
2155 ptr = strstr(name, "naa.");
2157 tport->tport_proto_id = SCSI_PROTOCOL_SAS;
2160 ptr = strstr(name, "fc.");
2162 tport->tport_proto_id = SCSI_PROTOCOL_FCP;
2163 off = 3; /* Skip over "fc." */
2166 ptr = strstr(name, "iqn.");
2168 tport->tport_proto_id = SCSI_PROTOCOL_ISCSI;
2172 pr_err("Unable to locate prefix for emulated Target Port:"
2175 return ERR_PTR(-EINVAL);
2178 if (strlen(name) >= VHOST_SCSI_NAMELEN) {
2179 pr_err("Emulated %s Address: %s, exceeds"
2180 " max: %d\n", name, vhost_scsi_dump_proto_id(tport),
2181 VHOST_SCSI_NAMELEN);
2183 return ERR_PTR(-EINVAL);
2185 snprintf(&tport->tport_name[0], VHOST_SCSI_NAMELEN, "%s", &name[off]);
2187 pr_debug("TCM_VHost_ConfigFS: Allocated emulated Target"
2188 " %s Address: %s\n", vhost_scsi_dump_proto_id(tport), name);
2190 return &tport->tport_wwn;
2193 static void vhost_scsi_drop_tport(struct se_wwn *wwn)
2195 struct vhost_scsi_tport *tport = container_of(wwn,
2196 struct vhost_scsi_tport, tport_wwn);
2198 pr_debug("TCM_VHost_ConfigFS: Deallocating emulated Target"
2199 " %s Address: %s\n", vhost_scsi_dump_proto_id(tport),
2206 vhost_scsi_wwn_show_attr_version(struct target_fabric_configfs *tf,
2209 return sprintf(page, "TCM_VHOST fabric module %s on %s/%s"
2210 "on "UTS_RELEASE"\n", VHOST_SCSI_VERSION, utsname()->sysname,
2211 utsname()->machine);
2214 TF_WWN_ATTR_RO(vhost_scsi, version);
2216 static struct configfs_attribute *vhost_scsi_wwn_attrs[] = {
2217 &vhost_scsi_wwn_version.attr,
2221 static struct target_core_fabric_ops vhost_scsi_ops = {
2222 .module = THIS_MODULE,
2224 .get_fabric_name = vhost_scsi_get_fabric_name,
2225 .tpg_get_wwn = vhost_scsi_get_fabric_wwn,
2226 .tpg_get_tag = vhost_scsi_get_tpgt,
2227 .tpg_get_pr_transport_id = vhost_scsi_get_pr_transport_id,
2228 .tpg_get_pr_transport_id_len = vhost_scsi_get_pr_transport_id_len,
2229 .tpg_parse_pr_out_transport_id = vhost_scsi_parse_pr_out_transport_id,
2230 .tpg_check_demo_mode = vhost_scsi_check_true,
2231 .tpg_check_demo_mode_cache = vhost_scsi_check_true,
2232 .tpg_check_demo_mode_write_protect = vhost_scsi_check_false,
2233 .tpg_check_prod_mode_write_protect = vhost_scsi_check_false,
2234 .tpg_check_prot_fabric_only = vhost_scsi_check_prot_fabric_only,
2235 .tpg_get_inst_index = vhost_scsi_tpg_get_inst_index,
2236 .release_cmd = vhost_scsi_release_cmd,
2237 .check_stop_free = vhost_scsi_check_stop_free,
2238 .shutdown_session = vhost_scsi_shutdown_session,
2239 .close_session = vhost_scsi_close_session,
2240 .sess_get_index = vhost_scsi_sess_get_index,
2241 .sess_get_initiator_sid = NULL,
2242 .write_pending = vhost_scsi_write_pending,
2243 .write_pending_status = vhost_scsi_write_pending_status,
2244 .set_default_node_attributes = vhost_scsi_set_default_node_attrs,
2245 .get_task_tag = vhost_scsi_get_task_tag,
2246 .get_cmd_state = vhost_scsi_get_cmd_state,
2247 .queue_data_in = vhost_scsi_queue_data_in,
2248 .queue_status = vhost_scsi_queue_status,
2249 .queue_tm_rsp = vhost_scsi_queue_tm_rsp,
2250 .aborted_task = vhost_scsi_aborted_task,
2252 * Setup callers for generic logic in target_core_fabric_configfs.c
2254 .fabric_make_wwn = vhost_scsi_make_tport,
2255 .fabric_drop_wwn = vhost_scsi_drop_tport,
2256 .fabric_make_tpg = vhost_scsi_make_tpg,
2257 .fabric_drop_tpg = vhost_scsi_drop_tpg,
2258 .fabric_post_link = vhost_scsi_port_link,
2259 .fabric_pre_unlink = vhost_scsi_port_unlink,
2261 .tfc_wwn_attrs = vhost_scsi_wwn_attrs,
2262 .tfc_tpg_base_attrs = vhost_scsi_tpg_attrs,
2263 .tfc_tpg_attrib_attrs = vhost_scsi_tpg_attrib_attrs,
2266 static int __init vhost_scsi_init(void)
2270 pr_debug("TCM_VHOST fabric module %s on %s/%s"
2271 " on "UTS_RELEASE"\n", VHOST_SCSI_VERSION, utsname()->sysname,
2272 utsname()->machine);
2275 * Use our own dedicated workqueue for submitting I/O into
2276 * target core to avoid contention within system_wq.
2278 vhost_scsi_workqueue = alloc_workqueue("vhost_scsi", 0, 0);
2279 if (!vhost_scsi_workqueue)
2282 ret = vhost_scsi_register();
2284 goto out_destroy_workqueue;
2286 ret = target_register_template(&vhost_scsi_ops);
2288 goto out_vhost_scsi_deregister;
2292 out_vhost_scsi_deregister:
2293 vhost_scsi_deregister();
2294 out_destroy_workqueue:
2295 destroy_workqueue(vhost_scsi_workqueue);
2300 static void vhost_scsi_exit(void)
2302 target_unregister_template(&vhost_scsi_ops);
2303 vhost_scsi_deregister();
2304 destroy_workqueue(vhost_scsi_workqueue);
2307 MODULE_DESCRIPTION("VHOST_SCSI series fabric driver");
2308 MODULE_ALIAS("tcm_vhost");
2309 MODULE_LICENSE("GPL");
2310 module_init(vhost_scsi_init);
2311 module_exit(vhost_scsi_exit);