1 /*******************************************************************************
2 * Vhost kernel TCM fabric driver for virtio SCSI initiators
4 * (C) Copyright 2010-2012 RisingTide Systems LLC.
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@risingtidesystems.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 <scsi/scsi_tcq.h>
42 #include <target/target_core_base.h>
43 #include <target/target_core_fabric.h>
44 #include <target/target_core_fabric_configfs.h>
45 #include <target/target_core_configfs.h>
46 #include <target/configfs_macros.h>
47 #include <linux/vhost.h>
48 #include <linux/virtio_scsi.h>
49 #include <linux/llist.h>
50 #include <linux/bitmap.h>
54 #define TCM_VHOST_VERSION "v0.1"
55 #define TCM_VHOST_NAMELEN 256
56 #define TCM_VHOST_MAX_CDB_SIZE 32
58 struct vhost_scsi_inflight {
59 /* Wait for the flush operation to finish */
60 struct completion comp;
61 /* Refcount for the inflight reqs */
65 struct tcm_vhost_cmd {
66 /* Descriptor from vhost_get_vq_desc() for virt_queue segment */
68 /* virtio-scsi initiator task attribute */
70 /* virtio-scsi initiator data direction */
71 enum dma_data_direction tvc_data_direction;
72 /* Expected data transfer length from virtio-scsi header */
74 /* The Tag from include/linux/virtio_scsi.h:struct virtio_scsi_cmd_req */
76 /* The number of scatterlists associated with this cmd */
78 /* Saved unpacked SCSI LUN for tcm_vhost_submission_work() */
80 /* Pointer to the SGL formatted memory from virtio-scsi */
81 struct scatterlist *tvc_sgl;
82 /* Pointer to response */
83 struct virtio_scsi_cmd_resp __user *tvc_resp;
84 /* Pointer to vhost_scsi for our device */
85 struct vhost_scsi *tvc_vhost;
86 /* Pointer to vhost_virtqueue for the cmd */
87 struct vhost_virtqueue *tvc_vq;
88 /* Pointer to vhost nexus memory */
89 struct tcm_vhost_nexus *tvc_nexus;
90 /* The TCM I/O descriptor that is accessed via container_of() */
91 struct se_cmd tvc_se_cmd;
92 /* work item used for cmwq dispatch to tcm_vhost_submission_work() */
93 struct work_struct work;
94 /* Copy of the incoming SCSI command descriptor block (CDB) */
95 unsigned char tvc_cdb[TCM_VHOST_MAX_CDB_SIZE];
96 /* Sense buffer that will be mapped into outgoing status */
97 unsigned char tvc_sense_buf[TRANSPORT_SENSE_BUFFER];
98 /* Completed commands list, serviced from vhost worker thread */
99 struct llist_node tvc_completion_list;
100 /* Used to track inflight cmd */
101 struct vhost_scsi_inflight *inflight;
104 struct tcm_vhost_nexus {
105 /* Pointer to TCM session for I_T Nexus */
106 struct se_session *tvn_se_sess;
109 struct tcm_vhost_nacl {
110 /* Binary World Wide unique Port Name for Vhost Initiator port */
112 /* ASCII formatted WWPN for Sas Initiator port */
113 char iport_name[TCM_VHOST_NAMELEN];
114 /* Returned by tcm_vhost_make_nodeacl() */
115 struct se_node_acl se_node_acl;
118 struct tcm_vhost_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 /* list for tcm_vhost_list */
126 struct list_head tv_tpg_list;
127 /* Used to protect access for tpg_nexus */
128 struct mutex tv_tpg_mutex;
129 /* Pointer to the TCM VHost I_T Nexus for this TPG endpoint */
130 struct tcm_vhost_nexus *tpg_nexus;
131 /* Pointer back to tcm_vhost_tport */
132 struct tcm_vhost_tport *tport;
133 /* Returned by tcm_vhost_make_tpg() */
134 struct se_portal_group se_tpg;
135 /* Pointer back to vhost_scsi, protected by tv_tpg_mutex */
136 struct vhost_scsi *vhost_scsi;
139 struct tcm_vhost_tport {
140 /* SCSI protocol the tport is providing */
142 /* Binary World Wide unique Port Name for Vhost Target port */
144 /* ASCII formatted WWPN for Vhost Target port */
145 char tport_name[TCM_VHOST_NAMELEN];
146 /* Returned by tcm_vhost_make_tport() */
147 struct se_wwn tport_wwn;
150 struct tcm_vhost_evt {
151 /* event to be sent to guest */
152 struct virtio_scsi_event event;
153 /* event list, serviced from vhost worker thread */
154 struct llist_node list;
158 VHOST_SCSI_VQ_CTL = 0,
159 VHOST_SCSI_VQ_EVT = 1,
160 VHOST_SCSI_VQ_IO = 2,
164 VHOST_SCSI_FEATURES = VHOST_FEATURES | (1ULL << VIRTIO_SCSI_F_HOTPLUG)
167 #define VHOST_SCSI_MAX_TARGET 256
168 #define VHOST_SCSI_MAX_VQ 128
169 #define VHOST_SCSI_MAX_EVENT 128
171 struct vhost_scsi_virtqueue {
172 struct vhost_virtqueue vq;
174 * Reference counting for inflight reqs, used for flush operation. At
175 * each time, one reference tracks new commands submitted, while we
176 * wait for another one to reach 0.
178 struct vhost_scsi_inflight inflights[2];
180 * Indicate current inflight in use, protected by vq->mutex.
181 * Writers must also take dev mutex and flush under it.
187 /* Protected by vhost_scsi->dev.mutex */
188 struct tcm_vhost_tpg **vs_tpg;
189 char vs_vhost_wwpn[TRANSPORT_IQN_LEN];
191 struct vhost_dev dev;
192 struct vhost_scsi_virtqueue vqs[VHOST_SCSI_MAX_VQ];
194 struct vhost_work vs_completion_work; /* cmd completion work item */
195 struct llist_head vs_completion_list; /* cmd completion queue */
197 struct vhost_work vs_event_work; /* evt injection work item */
198 struct llist_head vs_event_list; /* evt injection queue */
200 bool vs_events_missed; /* any missed events, protected by vq->mutex */
201 int vs_events_nr; /* num of pending events, protected by vq->mutex */
204 /* Local pointer to allocated TCM configfs fabric module */
205 static struct target_fabric_configfs *tcm_vhost_fabric_configfs;
207 static struct workqueue_struct *tcm_vhost_workqueue;
209 /* Global spinlock to protect tcm_vhost TPG list for vhost IOCTL access */
210 static DEFINE_MUTEX(tcm_vhost_mutex);
211 static LIST_HEAD(tcm_vhost_list);
213 static int iov_num_pages(struct iovec *iov)
215 return (PAGE_ALIGN((unsigned long)iov->iov_base + iov->iov_len) -
216 ((unsigned long)iov->iov_base & PAGE_MASK)) >> PAGE_SHIFT;
219 static void tcm_vhost_done_inflight(struct kref *kref)
221 struct vhost_scsi_inflight *inflight;
223 inflight = container_of(kref, struct vhost_scsi_inflight, kref);
224 complete(&inflight->comp);
227 static void tcm_vhost_init_inflight(struct vhost_scsi *vs,
228 struct vhost_scsi_inflight *old_inflight[])
230 struct vhost_scsi_inflight *new_inflight;
231 struct vhost_virtqueue *vq;
234 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
237 mutex_lock(&vq->mutex);
239 /* store old infight */
240 idx = vs->vqs[i].inflight_idx;
242 old_inflight[i] = &vs->vqs[i].inflights[idx];
244 /* setup new infight */
245 vs->vqs[i].inflight_idx = idx ^ 1;
246 new_inflight = &vs->vqs[i].inflights[idx ^ 1];
247 kref_init(&new_inflight->kref);
248 init_completion(&new_inflight->comp);
250 mutex_unlock(&vq->mutex);
254 static struct vhost_scsi_inflight *
255 tcm_vhost_get_inflight(struct vhost_virtqueue *vq)
257 struct vhost_scsi_inflight *inflight;
258 struct vhost_scsi_virtqueue *svq;
260 svq = container_of(vq, struct vhost_scsi_virtqueue, vq);
261 inflight = &svq->inflights[svq->inflight_idx];
262 kref_get(&inflight->kref);
267 static void tcm_vhost_put_inflight(struct vhost_scsi_inflight *inflight)
269 kref_put(&inflight->kref, tcm_vhost_done_inflight);
272 static int tcm_vhost_check_true(struct se_portal_group *se_tpg)
277 static int tcm_vhost_check_false(struct se_portal_group *se_tpg)
282 static char *tcm_vhost_get_fabric_name(void)
287 static u8 tcm_vhost_get_fabric_proto_ident(struct se_portal_group *se_tpg)
289 struct tcm_vhost_tpg *tpg = container_of(se_tpg,
290 struct tcm_vhost_tpg, se_tpg);
291 struct tcm_vhost_tport *tport = tpg->tport;
293 switch (tport->tport_proto_id) {
294 case SCSI_PROTOCOL_SAS:
295 return sas_get_fabric_proto_ident(se_tpg);
296 case SCSI_PROTOCOL_FCP:
297 return fc_get_fabric_proto_ident(se_tpg);
298 case SCSI_PROTOCOL_ISCSI:
299 return iscsi_get_fabric_proto_ident(se_tpg);
301 pr_err("Unknown tport_proto_id: 0x%02x, using"
302 " SAS emulation\n", tport->tport_proto_id);
306 return sas_get_fabric_proto_ident(se_tpg);
309 static char *tcm_vhost_get_fabric_wwn(struct se_portal_group *se_tpg)
311 struct tcm_vhost_tpg *tpg = container_of(se_tpg,
312 struct tcm_vhost_tpg, se_tpg);
313 struct tcm_vhost_tport *tport = tpg->tport;
315 return &tport->tport_name[0];
318 static u16 tcm_vhost_get_tag(struct se_portal_group *se_tpg)
320 struct tcm_vhost_tpg *tpg = container_of(se_tpg,
321 struct tcm_vhost_tpg, se_tpg);
322 return tpg->tport_tpgt;
325 static u32 tcm_vhost_get_default_depth(struct se_portal_group *se_tpg)
331 tcm_vhost_get_pr_transport_id(struct se_portal_group *se_tpg,
332 struct se_node_acl *se_nacl,
333 struct t10_pr_registration *pr_reg,
337 struct tcm_vhost_tpg *tpg = container_of(se_tpg,
338 struct tcm_vhost_tpg, se_tpg);
339 struct tcm_vhost_tport *tport = tpg->tport;
341 switch (tport->tport_proto_id) {
342 case SCSI_PROTOCOL_SAS:
343 return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
345 case SCSI_PROTOCOL_FCP:
346 return fc_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
348 case SCSI_PROTOCOL_ISCSI:
349 return iscsi_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
352 pr_err("Unknown tport_proto_id: 0x%02x, using"
353 " SAS emulation\n", tport->tport_proto_id);
357 return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
362 tcm_vhost_get_pr_transport_id_len(struct se_portal_group *se_tpg,
363 struct se_node_acl *se_nacl,
364 struct t10_pr_registration *pr_reg,
367 struct tcm_vhost_tpg *tpg = container_of(se_tpg,
368 struct tcm_vhost_tpg, se_tpg);
369 struct tcm_vhost_tport *tport = tpg->tport;
371 switch (tport->tport_proto_id) {
372 case SCSI_PROTOCOL_SAS:
373 return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
375 case SCSI_PROTOCOL_FCP:
376 return fc_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
378 case SCSI_PROTOCOL_ISCSI:
379 return iscsi_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
382 pr_err("Unknown tport_proto_id: 0x%02x, using"
383 " SAS emulation\n", tport->tport_proto_id);
387 return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
392 tcm_vhost_parse_pr_out_transport_id(struct se_portal_group *se_tpg,
395 char **port_nexus_ptr)
397 struct tcm_vhost_tpg *tpg = container_of(se_tpg,
398 struct tcm_vhost_tpg, se_tpg);
399 struct tcm_vhost_tport *tport = tpg->tport;
401 switch (tport->tport_proto_id) {
402 case SCSI_PROTOCOL_SAS:
403 return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
405 case SCSI_PROTOCOL_FCP:
406 return fc_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
408 case SCSI_PROTOCOL_ISCSI:
409 return iscsi_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
412 pr_err("Unknown tport_proto_id: 0x%02x, using"
413 " SAS emulation\n", tport->tport_proto_id);
417 return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
421 static struct se_node_acl *
422 tcm_vhost_alloc_fabric_acl(struct se_portal_group *se_tpg)
424 struct tcm_vhost_nacl *nacl;
426 nacl = kzalloc(sizeof(struct tcm_vhost_nacl), GFP_KERNEL);
428 pr_err("Unable to allocate struct tcm_vhost_nacl\n");
432 return &nacl->se_node_acl;
436 tcm_vhost_release_fabric_acl(struct se_portal_group *se_tpg,
437 struct se_node_acl *se_nacl)
439 struct tcm_vhost_nacl *nacl = container_of(se_nacl,
440 struct tcm_vhost_nacl, se_node_acl);
444 static u32 tcm_vhost_tpg_get_inst_index(struct se_portal_group *se_tpg)
449 static void tcm_vhost_release_cmd(struct se_cmd *se_cmd)
451 struct tcm_vhost_cmd *tv_cmd = container_of(se_cmd,
452 struct tcm_vhost_cmd, tvc_se_cmd);
454 if (tv_cmd->tvc_sgl_count) {
456 for (i = 0; i < tv_cmd->tvc_sgl_count; i++)
457 put_page(sg_page(&tv_cmd->tvc_sgl[i]));
459 kfree(tv_cmd->tvc_sgl);
462 tcm_vhost_put_inflight(tv_cmd->inflight);
466 static int tcm_vhost_shutdown_session(struct se_session *se_sess)
471 static void tcm_vhost_close_session(struct se_session *se_sess)
476 static u32 tcm_vhost_sess_get_index(struct se_session *se_sess)
481 static int tcm_vhost_write_pending(struct se_cmd *se_cmd)
483 /* Go ahead and process the write immediately */
484 target_execute_cmd(se_cmd);
488 static int tcm_vhost_write_pending_status(struct se_cmd *se_cmd)
493 static void tcm_vhost_set_default_node_attrs(struct se_node_acl *nacl)
498 static u32 tcm_vhost_get_task_tag(struct se_cmd *se_cmd)
503 static int tcm_vhost_get_cmd_state(struct se_cmd *se_cmd)
508 static void vhost_scsi_complete_cmd(struct tcm_vhost_cmd *cmd)
510 struct vhost_scsi *vs = cmd->tvc_vhost;
512 llist_add(&cmd->tvc_completion_list, &vs->vs_completion_list);
514 vhost_work_queue(&vs->dev, &vs->vs_completion_work);
517 static int tcm_vhost_queue_data_in(struct se_cmd *se_cmd)
519 struct tcm_vhost_cmd *cmd = container_of(se_cmd,
520 struct tcm_vhost_cmd, tvc_se_cmd);
521 vhost_scsi_complete_cmd(cmd);
525 static int tcm_vhost_queue_status(struct se_cmd *se_cmd)
527 struct tcm_vhost_cmd *cmd = container_of(se_cmd,
528 struct tcm_vhost_cmd, tvc_se_cmd);
529 vhost_scsi_complete_cmd(cmd);
533 static void tcm_vhost_queue_tm_rsp(struct se_cmd *se_cmd)
538 static void tcm_vhost_free_evt(struct vhost_scsi *vs, struct tcm_vhost_evt *evt)
544 static struct tcm_vhost_evt *
545 tcm_vhost_allocate_evt(struct vhost_scsi *vs,
546 u32 event, u32 reason)
548 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
549 struct tcm_vhost_evt *evt;
551 if (vs->vs_events_nr > VHOST_SCSI_MAX_EVENT) {
552 vs->vs_events_missed = true;
556 evt = kzalloc(sizeof(*evt), GFP_KERNEL);
558 vq_err(vq, "Failed to allocate tcm_vhost_evt\n");
559 vs->vs_events_missed = true;
563 evt->event.event = event;
564 evt->event.reason = reason;
570 static void vhost_scsi_free_cmd(struct tcm_vhost_cmd *cmd)
572 struct se_cmd *se_cmd = &cmd->tvc_se_cmd;
574 /* TODO locking against target/backend threads? */
575 transport_generic_free_cmd(se_cmd, 0);
579 static int vhost_scsi_check_stop_free(struct se_cmd *se_cmd)
581 return target_put_sess_cmd(se_cmd->se_sess, se_cmd);
585 tcm_vhost_do_evt_work(struct vhost_scsi *vs, struct tcm_vhost_evt *evt)
587 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
588 struct virtio_scsi_event *event = &evt->event;
589 struct virtio_scsi_event __user *eventp;
593 if (!vq->private_data) {
594 vs->vs_events_missed = true;
599 vhost_disable_notify(&vs->dev, vq);
600 head = vhost_get_vq_desc(&vs->dev, vq, vq->iov,
601 ARRAY_SIZE(vq->iov), &out, &in,
604 vs->vs_events_missed = true;
607 if (head == vq->num) {
608 if (vhost_enable_notify(&vs->dev, vq))
610 vs->vs_events_missed = true;
614 if ((vq->iov[out].iov_len != sizeof(struct virtio_scsi_event))) {
615 vq_err(vq, "Expecting virtio_scsi_event, got %zu bytes\n",
616 vq->iov[out].iov_len);
617 vs->vs_events_missed = true;
621 if (vs->vs_events_missed) {
622 event->event |= VIRTIO_SCSI_T_EVENTS_MISSED;
623 vs->vs_events_missed = false;
626 eventp = vq->iov[out].iov_base;
627 ret = __copy_to_user(eventp, event, sizeof(*event));
629 vhost_add_used_and_signal(&vs->dev, vq, head, 0);
631 vq_err(vq, "Faulted on tcm_vhost_send_event\n");
634 static void tcm_vhost_evt_work(struct vhost_work *work)
636 struct vhost_scsi *vs = container_of(work, struct vhost_scsi,
638 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
639 struct tcm_vhost_evt *evt;
640 struct llist_node *llnode;
642 mutex_lock(&vq->mutex);
643 llnode = llist_del_all(&vs->vs_event_list);
645 evt = llist_entry(llnode, struct tcm_vhost_evt, list);
646 llnode = llist_next(llnode);
647 tcm_vhost_do_evt_work(vs, evt);
648 tcm_vhost_free_evt(vs, evt);
650 mutex_unlock(&vq->mutex);
653 /* Fill in status and signal that we are done processing this command
655 * This is scheduled in the vhost work queue so we are called with the owner
656 * process mm and can access the vring.
658 static void vhost_scsi_complete_cmd_work(struct vhost_work *work)
660 struct vhost_scsi *vs = container_of(work, struct vhost_scsi,
662 DECLARE_BITMAP(signal, VHOST_SCSI_MAX_VQ);
663 struct virtio_scsi_cmd_resp v_rsp;
664 struct tcm_vhost_cmd *cmd;
665 struct llist_node *llnode;
666 struct se_cmd *se_cmd;
669 bitmap_zero(signal, VHOST_SCSI_MAX_VQ);
670 llnode = llist_del_all(&vs->vs_completion_list);
672 cmd = llist_entry(llnode, struct tcm_vhost_cmd,
673 tvc_completion_list);
674 llnode = llist_next(llnode);
675 se_cmd = &cmd->tvc_se_cmd;
677 pr_debug("%s tv_cmd %p resid %u status %#02x\n", __func__,
678 cmd, se_cmd->residual_count, se_cmd->scsi_status);
680 memset(&v_rsp, 0, sizeof(v_rsp));
681 v_rsp.resid = se_cmd->residual_count;
682 /* TODO is status_qualifier field needed? */
683 v_rsp.status = se_cmd->scsi_status;
684 v_rsp.sense_len = se_cmd->scsi_sense_length;
685 memcpy(v_rsp.sense, cmd->tvc_sense_buf,
687 ret = copy_to_user(cmd->tvc_resp, &v_rsp, sizeof(v_rsp));
688 if (likely(ret == 0)) {
689 struct vhost_scsi_virtqueue *q;
690 vhost_add_used(cmd->tvc_vq, cmd->tvc_vq_desc, 0);
691 q = container_of(cmd->tvc_vq, struct vhost_scsi_virtqueue, vq);
693 __set_bit(vq, signal);
695 pr_err("Faulted on virtio_scsi_cmd_resp\n");
697 vhost_scsi_free_cmd(cmd);
701 while ((vq = find_next_bit(signal, VHOST_SCSI_MAX_VQ, vq + 1))
703 vhost_signal(&vs->dev, &vs->vqs[vq].vq);
706 static struct tcm_vhost_cmd *
707 vhost_scsi_allocate_cmd(struct vhost_virtqueue *vq,
708 struct tcm_vhost_tpg *tpg,
709 struct virtio_scsi_cmd_req *v_req,
713 struct tcm_vhost_cmd *cmd;
714 struct tcm_vhost_nexus *tv_nexus;
716 tv_nexus = tpg->tpg_nexus;
718 pr_err("Unable to locate active struct tcm_vhost_nexus\n");
719 return ERR_PTR(-EIO);
722 cmd = kzalloc(sizeof(struct tcm_vhost_cmd), GFP_ATOMIC);
724 pr_err("Unable to allocate struct tcm_vhost_cmd\n");
725 return ERR_PTR(-ENOMEM);
727 cmd->tvc_tag = v_req->tag;
728 cmd->tvc_task_attr = v_req->task_attr;
729 cmd->tvc_exp_data_len = exp_data_len;
730 cmd->tvc_data_direction = data_direction;
731 cmd->tvc_nexus = tv_nexus;
732 cmd->inflight = tcm_vhost_get_inflight(vq);
738 * Map a user memory range into a scatterlist
740 * Returns the number of scatterlist entries used or -errno on error.
743 vhost_scsi_map_to_sgl(struct scatterlist *sgl,
744 unsigned int sgl_count,
748 unsigned int npages = 0, pages_nr, offset, nbytes;
749 struct scatterlist *sg = sgl;
750 void __user *ptr = iov->iov_base;
751 size_t len = iov->iov_len;
755 pages_nr = iov_num_pages(iov);
756 if (pages_nr > sgl_count)
759 pages = kmalloc(pages_nr * sizeof(struct page *), GFP_KERNEL);
763 ret = get_user_pages_fast((unsigned long)ptr, pages_nr, write, pages);
764 /* No pages were pinned */
767 /* Less pages pinned than wanted */
768 if (ret != pages_nr) {
769 for (i = 0; i < ret; i++)
776 offset = (uintptr_t)ptr & ~PAGE_MASK;
777 nbytes = min_t(unsigned int, PAGE_SIZE - offset, len);
778 sg_set_page(sg, pages[npages], nbytes, offset);
791 vhost_scsi_map_iov_to_sgl(struct tcm_vhost_cmd *cmd,
799 struct scatterlist *sg;
802 * Find out how long sglist needs to be
805 for (i = 0; i < niov; i++)
806 sgl_count += iov_num_pages(&iov[i]);
808 /* TODO overflow checking */
810 sg = kmalloc(sizeof(cmd->tvc_sgl[0]) * sgl_count, GFP_ATOMIC);
813 pr_debug("%s sg %p sgl_count %u is_err %d\n", __func__,
815 sg_init_table(sg, sgl_count);
818 cmd->tvc_sgl_count = sgl_count;
820 pr_debug("Mapping %u iovecs for %u pages\n", niov, sgl_count);
821 for (i = 0; i < niov; i++) {
822 ret = vhost_scsi_map_to_sgl(sg, sgl_count, &iov[i], write);
824 for (i = 0; i < cmd->tvc_sgl_count; i++)
825 put_page(sg_page(&cmd->tvc_sgl[i]));
828 cmd->tvc_sgl_count = 0;
838 static void tcm_vhost_submission_work(struct work_struct *work)
840 struct tcm_vhost_cmd *cmd =
841 container_of(work, struct tcm_vhost_cmd, work);
842 struct tcm_vhost_nexus *tv_nexus;
843 struct se_cmd *se_cmd = &cmd->tvc_se_cmd;
844 struct scatterlist *sg_ptr, *sg_bidi_ptr = NULL;
845 int rc, sg_no_bidi = 0;
847 if (cmd->tvc_sgl_count) {
848 sg_ptr = cmd->tvc_sgl;
849 /* FIXME: Fix BIDI operation in tcm_vhost_submission_work() */
851 if (se_cmd->se_cmd_flags & SCF_BIDI) {
859 tv_nexus = cmd->tvc_nexus;
861 rc = target_submit_cmd_map_sgls(se_cmd, tv_nexus->tvn_se_sess,
862 cmd->tvc_cdb, &cmd->tvc_sense_buf[0],
863 cmd->tvc_lun, cmd->tvc_exp_data_len,
864 cmd->tvc_task_attr, cmd->tvc_data_direction,
865 TARGET_SCF_ACK_KREF, sg_ptr, cmd->tvc_sgl_count,
866 sg_bidi_ptr, sg_no_bidi);
868 transport_send_check_condition_and_sense(se_cmd,
869 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE, 0);
870 transport_generic_free_cmd(se_cmd, 0);
875 vhost_scsi_send_bad_target(struct vhost_scsi *vs,
876 struct vhost_virtqueue *vq,
877 int head, unsigned out)
879 struct virtio_scsi_cmd_resp __user *resp;
880 struct virtio_scsi_cmd_resp rsp;
883 memset(&rsp, 0, sizeof(rsp));
884 rsp.response = VIRTIO_SCSI_S_BAD_TARGET;
885 resp = vq->iov[out].iov_base;
886 ret = __copy_to_user(resp, &rsp, sizeof(rsp));
888 vhost_add_used_and_signal(&vs->dev, vq, head, 0);
890 pr_err("Faulted on virtio_scsi_cmd_resp\n");
894 vhost_scsi_handle_vq(struct vhost_scsi *vs, struct vhost_virtqueue *vq)
896 struct tcm_vhost_tpg **vs_tpg;
897 struct virtio_scsi_cmd_req v_req;
898 struct tcm_vhost_tpg *tpg;
899 struct tcm_vhost_cmd *cmd;
900 u32 exp_data_len, data_first, data_num, data_direction;
906 * We can handle the vq only after the endpoint is setup by calling the
907 * VHOST_SCSI_SET_ENDPOINT ioctl.
909 * TODO: Check that we are running from vhost_worker which acts
910 * as read-side critical section for vhost kind of RCU.
911 * See the comments in struct vhost_virtqueue in drivers/vhost/vhost.h
913 vs_tpg = rcu_dereference_check(vq->private_data, 1);
917 mutex_lock(&vq->mutex);
918 vhost_disable_notify(&vs->dev, vq);
921 head = vhost_get_vq_desc(&vs->dev, vq, vq->iov,
922 ARRAY_SIZE(vq->iov), &out, &in,
924 pr_debug("vhost_get_vq_desc: head: %d, out: %u in: %u\n",
926 /* On error, stop handling until the next kick. */
927 if (unlikely(head < 0))
929 /* Nothing new? Wait for eventfd to tell us they refilled. */
930 if (head == vq->num) {
931 if (unlikely(vhost_enable_notify(&vs->dev, vq))) {
932 vhost_disable_notify(&vs->dev, vq);
938 /* FIXME: BIDI operation */
939 if (out == 1 && in == 1) {
940 data_direction = DMA_NONE;
943 } else if (out == 1 && in > 1) {
944 data_direction = DMA_FROM_DEVICE;
945 data_first = out + 1;
947 } else if (out > 1 && in == 1) {
948 data_direction = DMA_TO_DEVICE;
952 vq_err(vq, "Invalid buffer layout out: %u in: %u\n",
958 * Check for a sane resp buffer so we can report errors to
961 if (unlikely(vq->iov[out].iov_len !=
962 sizeof(struct virtio_scsi_cmd_resp))) {
963 vq_err(vq, "Expecting virtio_scsi_cmd_resp, got %zu"
964 " bytes\n", vq->iov[out].iov_len);
968 if (unlikely(vq->iov[0].iov_len != sizeof(v_req))) {
969 vq_err(vq, "Expecting virtio_scsi_cmd_req, got %zu"
970 " bytes\n", vq->iov[0].iov_len);
973 pr_debug("Calling __copy_from_user: vq->iov[0].iov_base: %p,"
974 " len: %zu\n", vq->iov[0].iov_base, sizeof(v_req));
975 ret = __copy_from_user(&v_req, vq->iov[0].iov_base,
978 vq_err(vq, "Faulted on virtio_scsi_cmd_req\n");
982 /* Extract the tpgt */
983 target = v_req.lun[1];
984 tpg = ACCESS_ONCE(vs_tpg[target]);
986 /* Target does not exist, fail the request */
987 if (unlikely(!tpg)) {
988 vhost_scsi_send_bad_target(vs, vq, head, out);
993 for (i = 0; i < data_num; i++)
994 exp_data_len += vq->iov[data_first + i].iov_len;
996 cmd = vhost_scsi_allocate_cmd(vq, tpg, &v_req,
997 exp_data_len, data_direction);
999 vq_err(vq, "vhost_scsi_allocate_cmd failed %ld\n",
1003 pr_debug("Allocated tv_cmd: %p exp_data_len: %d, data_direction"
1004 ": %d\n", cmd, exp_data_len, data_direction);
1006 cmd->tvc_vhost = vs;
1008 cmd->tvc_resp = vq->iov[out].iov_base;
1011 * Copy in the recieved CDB descriptor into cmd->tvc_cdb
1012 * that will be used by tcm_vhost_new_cmd_map() and down into
1013 * target_setup_cmd_from_cdb()
1015 memcpy(cmd->tvc_cdb, v_req.cdb, TCM_VHOST_MAX_CDB_SIZE);
1017 * Check that the recieved CDB size does not exceeded our
1018 * hardcoded max for tcm_vhost
1020 /* TODO what if cdb was too small for varlen cdb header? */
1021 if (unlikely(scsi_command_size(cmd->tvc_cdb) >
1022 TCM_VHOST_MAX_CDB_SIZE)) {
1023 vq_err(vq, "Received SCSI CDB with command_size: %d that"
1024 " exceeds SCSI_MAX_VARLEN_CDB_SIZE: %d\n",
1025 scsi_command_size(cmd->tvc_cdb),
1026 TCM_VHOST_MAX_CDB_SIZE);
1029 cmd->tvc_lun = ((v_req.lun[2] << 8) | v_req.lun[3]) & 0x3FFF;
1031 pr_debug("vhost_scsi got command opcode: %#02x, lun: %d\n",
1032 cmd->tvc_cdb[0], cmd->tvc_lun);
1034 if (data_direction != DMA_NONE) {
1035 ret = vhost_scsi_map_iov_to_sgl(cmd,
1036 &vq->iov[data_first], data_num,
1037 data_direction == DMA_TO_DEVICE);
1038 if (unlikely(ret)) {
1039 vq_err(vq, "Failed to map iov to sgl\n");
1045 * Save the descriptor from vhost_get_vq_desc() to be used to
1046 * complete the virtio-scsi request in TCM callback context via
1047 * tcm_vhost_queue_data_in() and tcm_vhost_queue_status()
1049 cmd->tvc_vq_desc = head;
1051 * Dispatch tv_cmd descriptor for cmwq execution in process
1052 * context provided by tcm_vhost_workqueue. This also ensures
1053 * tv_cmd is executed on the same kworker CPU as this vhost
1054 * thread to gain positive L2 cache locality effects..
1056 INIT_WORK(&cmd->work, tcm_vhost_submission_work);
1057 queue_work(tcm_vhost_workqueue, &cmd->work);
1060 mutex_unlock(&vq->mutex);
1064 vhost_scsi_free_cmd(cmd);
1066 vhost_scsi_send_bad_target(vs, vq, head, out);
1067 mutex_unlock(&vq->mutex);
1070 static void vhost_scsi_ctl_handle_kick(struct vhost_work *work)
1072 pr_debug("%s: The handling func for control queue.\n", __func__);
1076 tcm_vhost_send_evt(struct vhost_scsi *vs,
1077 struct tcm_vhost_tpg *tpg,
1082 struct tcm_vhost_evt *evt;
1084 evt = tcm_vhost_allocate_evt(vs, event, reason);
1089 /* TODO: share lun setup code with virtio-scsi.ko */
1091 * Note: evt->event is zeroed when we allocate it and
1092 * lun[4-7] need to be zero according to virtio-scsi spec.
1094 evt->event.lun[0] = 0x01;
1095 evt->event.lun[1] = tpg->tport_tpgt & 0xFF;
1096 if (lun->unpacked_lun >= 256)
1097 evt->event.lun[2] = lun->unpacked_lun >> 8 | 0x40 ;
1098 evt->event.lun[3] = lun->unpacked_lun & 0xFF;
1101 llist_add(&evt->list, &vs->vs_event_list);
1102 vhost_work_queue(&vs->dev, &vs->vs_event_work);
1105 static void vhost_scsi_evt_handle_kick(struct vhost_work *work)
1107 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1109 struct vhost_scsi *vs = container_of(vq->dev, struct vhost_scsi, dev);
1111 mutex_lock(&vq->mutex);
1112 if (!vq->private_data)
1115 if (vs->vs_events_missed)
1116 tcm_vhost_send_evt(vs, NULL, NULL, VIRTIO_SCSI_T_NO_EVENT, 0);
1118 mutex_unlock(&vq->mutex);
1121 static void vhost_scsi_handle_kick(struct vhost_work *work)
1123 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1125 struct vhost_scsi *vs = container_of(vq->dev, struct vhost_scsi, dev);
1127 vhost_scsi_handle_vq(vs, vq);
1130 static void vhost_scsi_flush_vq(struct vhost_scsi *vs, int index)
1132 vhost_poll_flush(&vs->vqs[index].vq.poll);
1135 /* Callers must hold dev mutex */
1136 static void vhost_scsi_flush(struct vhost_scsi *vs)
1138 struct vhost_scsi_inflight *old_inflight[VHOST_SCSI_MAX_VQ];
1141 /* Init new inflight and remember the old inflight */
1142 tcm_vhost_init_inflight(vs, old_inflight);
1145 * The inflight->kref was initialized to 1. We decrement it here to
1146 * indicate the start of the flush operation so that it will reach 0
1147 * when all the reqs are finished.
1149 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1150 kref_put(&old_inflight[i]->kref, tcm_vhost_done_inflight);
1152 /* Flush both the vhost poll and vhost work */
1153 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1154 vhost_scsi_flush_vq(vs, i);
1155 vhost_work_flush(&vs->dev, &vs->vs_completion_work);
1156 vhost_work_flush(&vs->dev, &vs->vs_event_work);
1158 /* Wait for all reqs issued before the flush to be finished */
1159 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1160 wait_for_completion(&old_inflight[i]->comp);
1164 * Called from vhost_scsi_ioctl() context to walk the list of available
1165 * tcm_vhost_tpg with an active struct tcm_vhost_nexus
1167 * The lock nesting rule is:
1168 * tcm_vhost_mutex -> vs->dev.mutex -> tpg->tv_tpg_mutex -> vq->mutex
1171 vhost_scsi_set_endpoint(struct vhost_scsi *vs,
1172 struct vhost_scsi_target *t)
1174 struct tcm_vhost_tport *tv_tport;
1175 struct tcm_vhost_tpg *tpg;
1176 struct tcm_vhost_tpg **vs_tpg;
1177 struct vhost_virtqueue *vq;
1178 int index, ret, i, len;
1181 mutex_lock(&tcm_vhost_mutex);
1182 mutex_lock(&vs->dev.mutex);
1184 /* Verify that ring has been setup correctly. */
1185 for (index = 0; index < vs->dev.nvqs; ++index) {
1186 /* Verify that ring has been setup correctly. */
1187 if (!vhost_vq_access_ok(&vs->vqs[index].vq)) {
1193 len = sizeof(vs_tpg[0]) * VHOST_SCSI_MAX_TARGET;
1194 vs_tpg = kzalloc(len, GFP_KERNEL);
1200 memcpy(vs_tpg, vs->vs_tpg, len);
1202 list_for_each_entry(tpg, &tcm_vhost_list, tv_tpg_list) {
1203 mutex_lock(&tpg->tv_tpg_mutex);
1204 if (!tpg->tpg_nexus) {
1205 mutex_unlock(&tpg->tv_tpg_mutex);
1208 if (tpg->tv_tpg_vhost_count != 0) {
1209 mutex_unlock(&tpg->tv_tpg_mutex);
1212 tv_tport = tpg->tport;
1214 if (!strcmp(tv_tport->tport_name, t->vhost_wwpn)) {
1215 if (vs->vs_tpg && vs->vs_tpg[tpg->tport_tpgt]) {
1217 mutex_unlock(&tpg->tv_tpg_mutex);
1221 tpg->tv_tpg_vhost_count++;
1222 tpg->vhost_scsi = vs;
1223 vs_tpg[tpg->tport_tpgt] = tpg;
1224 smp_mb__after_atomic_inc();
1227 mutex_unlock(&tpg->tv_tpg_mutex);
1231 memcpy(vs->vs_vhost_wwpn, t->vhost_wwpn,
1232 sizeof(vs->vs_vhost_wwpn));
1233 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1234 vq = &vs->vqs[i].vq;
1235 /* Flushing the vhost_work acts as synchronize_rcu */
1236 mutex_lock(&vq->mutex);
1237 rcu_assign_pointer(vq->private_data, vs_tpg);
1238 vhost_init_used(vq);
1239 mutex_unlock(&vq->mutex);
1247 * Act as synchronize_rcu to make sure access to
1248 * old vs->vs_tpg is finished.
1250 vhost_scsi_flush(vs);
1252 vs->vs_tpg = vs_tpg;
1255 mutex_unlock(&vs->dev.mutex);
1256 mutex_unlock(&tcm_vhost_mutex);
1261 vhost_scsi_clear_endpoint(struct vhost_scsi *vs,
1262 struct vhost_scsi_target *t)
1264 struct tcm_vhost_tport *tv_tport;
1265 struct tcm_vhost_tpg *tpg;
1266 struct vhost_virtqueue *vq;
1271 mutex_lock(&tcm_vhost_mutex);
1272 mutex_lock(&vs->dev.mutex);
1273 /* Verify that ring has been setup correctly. */
1274 for (index = 0; index < vs->dev.nvqs; ++index) {
1275 if (!vhost_vq_access_ok(&vs->vqs[index].vq)) {
1286 for (i = 0; i < VHOST_SCSI_MAX_TARGET; i++) {
1288 tpg = vs->vs_tpg[target];
1292 mutex_lock(&tpg->tv_tpg_mutex);
1293 tv_tport = tpg->tport;
1299 if (strcmp(tv_tport->tport_name, t->vhost_wwpn)) {
1300 pr_warn("tv_tport->tport_name: %s, tpg->tport_tpgt: %hu"
1301 " does not match t->vhost_wwpn: %s, t->vhost_tpgt: %hu\n",
1302 tv_tport->tport_name, tpg->tport_tpgt,
1303 t->vhost_wwpn, t->vhost_tpgt);
1307 tpg->tv_tpg_vhost_count--;
1308 tpg->vhost_scsi = NULL;
1309 vs->vs_tpg[target] = NULL;
1311 mutex_unlock(&tpg->tv_tpg_mutex);
1314 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1315 vq = &vs->vqs[i].vq;
1316 /* Flushing the vhost_work acts as synchronize_rcu */
1317 mutex_lock(&vq->mutex);
1318 rcu_assign_pointer(vq->private_data, NULL);
1319 mutex_unlock(&vq->mutex);
1323 * Act as synchronize_rcu to make sure access to
1324 * old vs->vs_tpg is finished.
1326 vhost_scsi_flush(vs);
1329 WARN_ON(vs->vs_events_nr);
1330 mutex_unlock(&vs->dev.mutex);
1331 mutex_unlock(&tcm_vhost_mutex);
1335 mutex_unlock(&tpg->tv_tpg_mutex);
1337 mutex_unlock(&vs->dev.mutex);
1338 mutex_unlock(&tcm_vhost_mutex);
1342 static int vhost_scsi_set_features(struct vhost_scsi *vs, u64 features)
1344 if (features & ~VHOST_SCSI_FEATURES)
1347 mutex_lock(&vs->dev.mutex);
1348 if ((features & (1 << VHOST_F_LOG_ALL)) &&
1349 !vhost_log_access_ok(&vs->dev)) {
1350 mutex_unlock(&vs->dev.mutex);
1353 vs->dev.acked_features = features;
1355 vhost_scsi_flush(vs);
1356 mutex_unlock(&vs->dev.mutex);
1360 static int vhost_scsi_open(struct inode *inode, struct file *f)
1362 struct vhost_scsi *vs;
1363 struct vhost_virtqueue **vqs;
1366 vs = kzalloc(sizeof(*vs), GFP_KERNEL);
1370 vqs = kmalloc(VHOST_SCSI_MAX_VQ * sizeof(*vqs), GFP_KERNEL);
1376 vhost_work_init(&vs->vs_completion_work, vhost_scsi_complete_cmd_work);
1377 vhost_work_init(&vs->vs_event_work, tcm_vhost_evt_work);
1379 vs->vs_events_nr = 0;
1380 vs->vs_events_missed = false;
1382 vqs[VHOST_SCSI_VQ_CTL] = &vs->vqs[VHOST_SCSI_VQ_CTL].vq;
1383 vqs[VHOST_SCSI_VQ_EVT] = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1384 vs->vqs[VHOST_SCSI_VQ_CTL].vq.handle_kick = vhost_scsi_ctl_handle_kick;
1385 vs->vqs[VHOST_SCSI_VQ_EVT].vq.handle_kick = vhost_scsi_evt_handle_kick;
1386 for (i = VHOST_SCSI_VQ_IO; i < VHOST_SCSI_MAX_VQ; i++) {
1387 vqs[i] = &vs->vqs[i].vq;
1388 vs->vqs[i].vq.handle_kick = vhost_scsi_handle_kick;
1390 r = vhost_dev_init(&vs->dev, vqs, VHOST_SCSI_MAX_VQ);
1392 tcm_vhost_init_inflight(vs, NULL);
1400 f->private_data = vs;
1404 static int vhost_scsi_release(struct inode *inode, struct file *f)
1406 struct vhost_scsi *vs = f->private_data;
1407 struct vhost_scsi_target t;
1409 mutex_lock(&vs->dev.mutex);
1410 memcpy(t.vhost_wwpn, vs->vs_vhost_wwpn, sizeof(t.vhost_wwpn));
1411 mutex_unlock(&vs->dev.mutex);
1412 vhost_scsi_clear_endpoint(vs, &t);
1413 vhost_dev_stop(&vs->dev);
1414 vhost_dev_cleanup(&vs->dev, false);
1415 /* Jobs can re-queue themselves in evt kick handler. Do extra flush. */
1416 vhost_scsi_flush(vs);
1423 vhost_scsi_ioctl(struct file *f,
1427 struct vhost_scsi *vs = f->private_data;
1428 struct vhost_scsi_target backend;
1429 void __user *argp = (void __user *)arg;
1430 u64 __user *featurep = argp;
1431 u32 __user *eventsp = argp;
1434 int r, abi_version = VHOST_SCSI_ABI_VERSION;
1435 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1438 case VHOST_SCSI_SET_ENDPOINT:
1439 if (copy_from_user(&backend, argp, sizeof backend))
1441 if (backend.reserved != 0)
1444 return vhost_scsi_set_endpoint(vs, &backend);
1445 case VHOST_SCSI_CLEAR_ENDPOINT:
1446 if (copy_from_user(&backend, argp, sizeof backend))
1448 if (backend.reserved != 0)
1451 return vhost_scsi_clear_endpoint(vs, &backend);
1452 case VHOST_SCSI_GET_ABI_VERSION:
1453 if (copy_to_user(argp, &abi_version, sizeof abi_version))
1456 case VHOST_SCSI_SET_EVENTS_MISSED:
1457 if (get_user(events_missed, eventsp))
1459 mutex_lock(&vq->mutex);
1460 vs->vs_events_missed = events_missed;
1461 mutex_unlock(&vq->mutex);
1463 case VHOST_SCSI_GET_EVENTS_MISSED:
1464 mutex_lock(&vq->mutex);
1465 events_missed = vs->vs_events_missed;
1466 mutex_unlock(&vq->mutex);
1467 if (put_user(events_missed, eventsp))
1470 case VHOST_GET_FEATURES:
1471 features = VHOST_SCSI_FEATURES;
1472 if (copy_to_user(featurep, &features, sizeof features))
1475 case VHOST_SET_FEATURES:
1476 if (copy_from_user(&features, featurep, sizeof features))
1478 return vhost_scsi_set_features(vs, features);
1480 mutex_lock(&vs->dev.mutex);
1481 r = vhost_dev_ioctl(&vs->dev, ioctl, argp);
1482 /* TODO: flush backend after dev ioctl. */
1483 if (r == -ENOIOCTLCMD)
1484 r = vhost_vring_ioctl(&vs->dev, ioctl, argp);
1485 mutex_unlock(&vs->dev.mutex);
1490 #ifdef CONFIG_COMPAT
1491 static long vhost_scsi_compat_ioctl(struct file *f, unsigned int ioctl,
1494 return vhost_scsi_ioctl(f, ioctl, (unsigned long)compat_ptr(arg));
1498 static const struct file_operations vhost_scsi_fops = {
1499 .owner = THIS_MODULE,
1500 .release = vhost_scsi_release,
1501 .unlocked_ioctl = vhost_scsi_ioctl,
1502 #ifdef CONFIG_COMPAT
1503 .compat_ioctl = vhost_scsi_compat_ioctl,
1505 .open = vhost_scsi_open,
1506 .llseek = noop_llseek,
1509 static struct miscdevice vhost_scsi_misc = {
1515 static int __init vhost_scsi_register(void)
1517 return misc_register(&vhost_scsi_misc);
1520 static int vhost_scsi_deregister(void)
1522 return misc_deregister(&vhost_scsi_misc);
1525 static char *tcm_vhost_dump_proto_id(struct tcm_vhost_tport *tport)
1527 switch (tport->tport_proto_id) {
1528 case SCSI_PROTOCOL_SAS:
1530 case SCSI_PROTOCOL_FCP:
1532 case SCSI_PROTOCOL_ISCSI:
1542 tcm_vhost_do_plug(struct tcm_vhost_tpg *tpg,
1543 struct se_lun *lun, bool plug)
1546 struct vhost_scsi *vs = tpg->vhost_scsi;
1547 struct vhost_virtqueue *vq;
1553 mutex_lock(&vs->dev.mutex);
1554 if (!vhost_has_feature(&vs->dev, VIRTIO_SCSI_F_HOTPLUG)) {
1555 mutex_unlock(&vs->dev.mutex);
1560 reason = VIRTIO_SCSI_EVT_RESET_RESCAN;
1562 reason = VIRTIO_SCSI_EVT_RESET_REMOVED;
1564 vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1565 mutex_lock(&vq->mutex);
1566 tcm_vhost_send_evt(vs, tpg, lun,
1567 VIRTIO_SCSI_T_TRANSPORT_RESET, reason);
1568 mutex_unlock(&vq->mutex);
1569 mutex_unlock(&vs->dev.mutex);
1572 static void tcm_vhost_hotplug(struct tcm_vhost_tpg *tpg, struct se_lun *lun)
1574 tcm_vhost_do_plug(tpg, lun, true);
1577 static void tcm_vhost_hotunplug(struct tcm_vhost_tpg *tpg, struct se_lun *lun)
1579 tcm_vhost_do_plug(tpg, lun, false);
1582 static int tcm_vhost_port_link(struct se_portal_group *se_tpg,
1585 struct tcm_vhost_tpg *tpg = container_of(se_tpg,
1586 struct tcm_vhost_tpg, se_tpg);
1588 mutex_lock(&tcm_vhost_mutex);
1590 mutex_lock(&tpg->tv_tpg_mutex);
1591 tpg->tv_tpg_port_count++;
1592 mutex_unlock(&tpg->tv_tpg_mutex);
1594 tcm_vhost_hotplug(tpg, lun);
1596 mutex_unlock(&tcm_vhost_mutex);
1601 static void tcm_vhost_port_unlink(struct se_portal_group *se_tpg,
1604 struct tcm_vhost_tpg *tpg = container_of(se_tpg,
1605 struct tcm_vhost_tpg, se_tpg);
1607 mutex_lock(&tcm_vhost_mutex);
1609 mutex_lock(&tpg->tv_tpg_mutex);
1610 tpg->tv_tpg_port_count--;
1611 mutex_unlock(&tpg->tv_tpg_mutex);
1613 tcm_vhost_hotunplug(tpg, lun);
1615 mutex_unlock(&tcm_vhost_mutex);
1618 static struct se_node_acl *
1619 tcm_vhost_make_nodeacl(struct se_portal_group *se_tpg,
1620 struct config_group *group,
1623 struct se_node_acl *se_nacl, *se_nacl_new;
1624 struct tcm_vhost_nacl *nacl;
1628 /* tcm_vhost_parse_wwn(name, &wwpn, 1) < 0)
1629 return ERR_PTR(-EINVAL); */
1630 se_nacl_new = tcm_vhost_alloc_fabric_acl(se_tpg);
1632 return ERR_PTR(-ENOMEM);
1636 * se_nacl_new may be released by core_tpg_add_initiator_node_acl()
1637 * when converting a NodeACL from demo mode -> explict
1639 se_nacl = core_tpg_add_initiator_node_acl(se_tpg, se_nacl_new,
1641 if (IS_ERR(se_nacl)) {
1642 tcm_vhost_release_fabric_acl(se_tpg, se_nacl_new);
1646 * Locate our struct tcm_vhost_nacl and set the FC Nport WWPN
1648 nacl = container_of(se_nacl, struct tcm_vhost_nacl, se_node_acl);
1649 nacl->iport_wwpn = wwpn;
1654 static void tcm_vhost_drop_nodeacl(struct se_node_acl *se_acl)
1656 struct tcm_vhost_nacl *nacl = container_of(se_acl,
1657 struct tcm_vhost_nacl, se_node_acl);
1658 core_tpg_del_initiator_node_acl(se_acl->se_tpg, se_acl, 1);
1662 static int tcm_vhost_make_nexus(struct tcm_vhost_tpg *tpg,
1665 struct se_portal_group *se_tpg;
1666 struct tcm_vhost_nexus *tv_nexus;
1668 mutex_lock(&tpg->tv_tpg_mutex);
1669 if (tpg->tpg_nexus) {
1670 mutex_unlock(&tpg->tv_tpg_mutex);
1671 pr_debug("tpg->tpg_nexus already exists\n");
1674 se_tpg = &tpg->se_tpg;
1676 tv_nexus = kzalloc(sizeof(struct tcm_vhost_nexus), GFP_KERNEL);
1678 mutex_unlock(&tpg->tv_tpg_mutex);
1679 pr_err("Unable to allocate struct tcm_vhost_nexus\n");
1683 * Initialize the struct se_session pointer
1685 tv_nexus->tvn_se_sess = transport_init_session();
1686 if (IS_ERR(tv_nexus->tvn_se_sess)) {
1687 mutex_unlock(&tpg->tv_tpg_mutex);
1692 * Since we are running in 'demo mode' this call with generate a
1693 * struct se_node_acl for the tcm_vhost struct se_portal_group with
1694 * the SCSI Initiator port name of the passed configfs group 'name'.
1696 tv_nexus->tvn_se_sess->se_node_acl = core_tpg_check_initiator_node_acl(
1697 se_tpg, (unsigned char *)name);
1698 if (!tv_nexus->tvn_se_sess->se_node_acl) {
1699 mutex_unlock(&tpg->tv_tpg_mutex);
1700 pr_debug("core_tpg_check_initiator_node_acl() failed"
1702 transport_free_session(tv_nexus->tvn_se_sess);
1707 * Now register the TCM vhost virtual I_T Nexus as active with the
1708 * call to __transport_register_session()
1710 __transport_register_session(se_tpg, tv_nexus->tvn_se_sess->se_node_acl,
1711 tv_nexus->tvn_se_sess, tv_nexus);
1712 tpg->tpg_nexus = tv_nexus;
1714 mutex_unlock(&tpg->tv_tpg_mutex);
1718 static int tcm_vhost_drop_nexus(struct tcm_vhost_tpg *tpg)
1720 struct se_session *se_sess;
1721 struct tcm_vhost_nexus *tv_nexus;
1723 mutex_lock(&tpg->tv_tpg_mutex);
1724 tv_nexus = tpg->tpg_nexus;
1726 mutex_unlock(&tpg->tv_tpg_mutex);
1730 se_sess = tv_nexus->tvn_se_sess;
1732 mutex_unlock(&tpg->tv_tpg_mutex);
1736 if (tpg->tv_tpg_port_count != 0) {
1737 mutex_unlock(&tpg->tv_tpg_mutex);
1738 pr_err("Unable to remove TCM_vhost I_T Nexus with"
1739 " active TPG port count: %d\n",
1740 tpg->tv_tpg_port_count);
1744 if (tpg->tv_tpg_vhost_count != 0) {
1745 mutex_unlock(&tpg->tv_tpg_mutex);
1746 pr_err("Unable to remove TCM_vhost I_T Nexus with"
1747 " active TPG vhost count: %d\n",
1748 tpg->tv_tpg_vhost_count);
1752 pr_debug("TCM_vhost_ConfigFS: Removing I_T Nexus to emulated"
1753 " %s Initiator Port: %s\n", tcm_vhost_dump_proto_id(tpg->tport),
1754 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1756 * Release the SCSI I_T Nexus to the emulated vhost Target Port
1758 transport_deregister_session(tv_nexus->tvn_se_sess);
1759 tpg->tpg_nexus = NULL;
1760 mutex_unlock(&tpg->tv_tpg_mutex);
1766 static ssize_t tcm_vhost_tpg_show_nexus(struct se_portal_group *se_tpg,
1769 struct tcm_vhost_tpg *tpg = container_of(se_tpg,
1770 struct tcm_vhost_tpg, se_tpg);
1771 struct tcm_vhost_nexus *tv_nexus;
1774 mutex_lock(&tpg->tv_tpg_mutex);
1775 tv_nexus = tpg->tpg_nexus;
1777 mutex_unlock(&tpg->tv_tpg_mutex);
1780 ret = snprintf(page, PAGE_SIZE, "%s\n",
1781 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1782 mutex_unlock(&tpg->tv_tpg_mutex);
1787 static ssize_t tcm_vhost_tpg_store_nexus(struct se_portal_group *se_tpg,
1791 struct tcm_vhost_tpg *tpg = container_of(se_tpg,
1792 struct tcm_vhost_tpg, se_tpg);
1793 struct tcm_vhost_tport *tport_wwn = tpg->tport;
1794 unsigned char i_port[TCM_VHOST_NAMELEN], *ptr, *port_ptr;
1797 * Shutdown the active I_T nexus if 'NULL' is passed..
1799 if (!strncmp(page, "NULL", 4)) {
1800 ret = tcm_vhost_drop_nexus(tpg);
1801 return (!ret) ? count : ret;
1804 * Otherwise make sure the passed virtual Initiator port WWN matches
1805 * the fabric protocol_id set in tcm_vhost_make_tport(), and call
1806 * tcm_vhost_make_nexus().
1808 if (strlen(page) >= TCM_VHOST_NAMELEN) {
1809 pr_err("Emulated NAA Sas Address: %s, exceeds"
1810 " max: %d\n", page, TCM_VHOST_NAMELEN);
1813 snprintf(&i_port[0], TCM_VHOST_NAMELEN, "%s", page);
1815 ptr = strstr(i_port, "naa.");
1817 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_SAS) {
1818 pr_err("Passed SAS Initiator Port %s does not"
1819 " match target port protoid: %s\n", i_port,
1820 tcm_vhost_dump_proto_id(tport_wwn));
1823 port_ptr = &i_port[0];
1826 ptr = strstr(i_port, "fc.");
1828 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_FCP) {
1829 pr_err("Passed FCP Initiator Port %s does not"
1830 " match target port protoid: %s\n", i_port,
1831 tcm_vhost_dump_proto_id(tport_wwn));
1834 port_ptr = &i_port[3]; /* Skip over "fc." */
1837 ptr = strstr(i_port, "iqn.");
1839 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_ISCSI) {
1840 pr_err("Passed iSCSI Initiator Port %s does not"
1841 " match target port protoid: %s\n", i_port,
1842 tcm_vhost_dump_proto_id(tport_wwn));
1845 port_ptr = &i_port[0];
1848 pr_err("Unable to locate prefix for emulated Initiator Port:"
1852 * Clear any trailing newline for the NAA WWN
1855 if (i_port[strlen(i_port)-1] == '\n')
1856 i_port[strlen(i_port)-1] = '\0';
1858 ret = tcm_vhost_make_nexus(tpg, port_ptr);
1865 TF_TPG_BASE_ATTR(tcm_vhost, nexus, S_IRUGO | S_IWUSR);
1867 static struct configfs_attribute *tcm_vhost_tpg_attrs[] = {
1868 &tcm_vhost_tpg_nexus.attr,
1872 static struct se_portal_group *
1873 tcm_vhost_make_tpg(struct se_wwn *wwn,
1874 struct config_group *group,
1877 struct tcm_vhost_tport *tport = container_of(wwn,
1878 struct tcm_vhost_tport, tport_wwn);
1880 struct tcm_vhost_tpg *tpg;
1884 if (strstr(name, "tpgt_") != name)
1885 return ERR_PTR(-EINVAL);
1886 if (kstrtoul(name + 5, 10, &tpgt) || tpgt > UINT_MAX)
1887 return ERR_PTR(-EINVAL);
1889 tpg = kzalloc(sizeof(struct tcm_vhost_tpg), GFP_KERNEL);
1891 pr_err("Unable to allocate struct tcm_vhost_tpg");
1892 return ERR_PTR(-ENOMEM);
1894 mutex_init(&tpg->tv_tpg_mutex);
1895 INIT_LIST_HEAD(&tpg->tv_tpg_list);
1897 tpg->tport_tpgt = tpgt;
1899 ret = core_tpg_register(&tcm_vhost_fabric_configfs->tf_ops, wwn,
1900 &tpg->se_tpg, tpg, TRANSPORT_TPG_TYPE_NORMAL);
1905 mutex_lock(&tcm_vhost_mutex);
1906 list_add_tail(&tpg->tv_tpg_list, &tcm_vhost_list);
1907 mutex_unlock(&tcm_vhost_mutex);
1909 return &tpg->se_tpg;
1912 static void tcm_vhost_drop_tpg(struct se_portal_group *se_tpg)
1914 struct tcm_vhost_tpg *tpg = container_of(se_tpg,
1915 struct tcm_vhost_tpg, se_tpg);
1917 mutex_lock(&tcm_vhost_mutex);
1918 list_del(&tpg->tv_tpg_list);
1919 mutex_unlock(&tcm_vhost_mutex);
1921 * Release the virtual I_T Nexus for this vhost TPG
1923 tcm_vhost_drop_nexus(tpg);
1925 * Deregister the se_tpg from TCM..
1927 core_tpg_deregister(se_tpg);
1931 static struct se_wwn *
1932 tcm_vhost_make_tport(struct target_fabric_configfs *tf,
1933 struct config_group *group,
1936 struct tcm_vhost_tport *tport;
1941 /* if (tcm_vhost_parse_wwn(name, &wwpn, 1) < 0)
1942 return ERR_PTR(-EINVAL); */
1944 tport = kzalloc(sizeof(struct tcm_vhost_tport), GFP_KERNEL);
1946 pr_err("Unable to allocate struct tcm_vhost_tport");
1947 return ERR_PTR(-ENOMEM);
1949 tport->tport_wwpn = wwpn;
1951 * Determine the emulated Protocol Identifier and Target Port Name
1952 * based on the incoming configfs directory name.
1954 ptr = strstr(name, "naa.");
1956 tport->tport_proto_id = SCSI_PROTOCOL_SAS;
1959 ptr = strstr(name, "fc.");
1961 tport->tport_proto_id = SCSI_PROTOCOL_FCP;
1962 off = 3; /* Skip over "fc." */
1965 ptr = strstr(name, "iqn.");
1967 tport->tport_proto_id = SCSI_PROTOCOL_ISCSI;
1971 pr_err("Unable to locate prefix for emulated Target Port:"
1974 return ERR_PTR(-EINVAL);
1977 if (strlen(name) >= TCM_VHOST_NAMELEN) {
1978 pr_err("Emulated %s Address: %s, exceeds"
1979 " max: %d\n", name, tcm_vhost_dump_proto_id(tport),
1982 return ERR_PTR(-EINVAL);
1984 snprintf(&tport->tport_name[0], TCM_VHOST_NAMELEN, "%s", &name[off]);
1986 pr_debug("TCM_VHost_ConfigFS: Allocated emulated Target"
1987 " %s Address: %s\n", tcm_vhost_dump_proto_id(tport), name);
1989 return &tport->tport_wwn;
1992 static void tcm_vhost_drop_tport(struct se_wwn *wwn)
1994 struct tcm_vhost_tport *tport = container_of(wwn,
1995 struct tcm_vhost_tport, tport_wwn);
1997 pr_debug("TCM_VHost_ConfigFS: Deallocating emulated Target"
1998 " %s Address: %s\n", tcm_vhost_dump_proto_id(tport),
2005 tcm_vhost_wwn_show_attr_version(struct target_fabric_configfs *tf,
2008 return sprintf(page, "TCM_VHOST fabric module %s on %s/%s"
2009 "on "UTS_RELEASE"\n", TCM_VHOST_VERSION, utsname()->sysname,
2010 utsname()->machine);
2013 TF_WWN_ATTR_RO(tcm_vhost, version);
2015 static struct configfs_attribute *tcm_vhost_wwn_attrs[] = {
2016 &tcm_vhost_wwn_version.attr,
2020 static struct target_core_fabric_ops tcm_vhost_ops = {
2021 .get_fabric_name = tcm_vhost_get_fabric_name,
2022 .get_fabric_proto_ident = tcm_vhost_get_fabric_proto_ident,
2023 .tpg_get_wwn = tcm_vhost_get_fabric_wwn,
2024 .tpg_get_tag = tcm_vhost_get_tag,
2025 .tpg_get_default_depth = tcm_vhost_get_default_depth,
2026 .tpg_get_pr_transport_id = tcm_vhost_get_pr_transport_id,
2027 .tpg_get_pr_transport_id_len = tcm_vhost_get_pr_transport_id_len,
2028 .tpg_parse_pr_out_transport_id = tcm_vhost_parse_pr_out_transport_id,
2029 .tpg_check_demo_mode = tcm_vhost_check_true,
2030 .tpg_check_demo_mode_cache = tcm_vhost_check_true,
2031 .tpg_check_demo_mode_write_protect = tcm_vhost_check_false,
2032 .tpg_check_prod_mode_write_protect = tcm_vhost_check_false,
2033 .tpg_alloc_fabric_acl = tcm_vhost_alloc_fabric_acl,
2034 .tpg_release_fabric_acl = tcm_vhost_release_fabric_acl,
2035 .tpg_get_inst_index = tcm_vhost_tpg_get_inst_index,
2036 .release_cmd = tcm_vhost_release_cmd,
2037 .check_stop_free = vhost_scsi_check_stop_free,
2038 .shutdown_session = tcm_vhost_shutdown_session,
2039 .close_session = tcm_vhost_close_session,
2040 .sess_get_index = tcm_vhost_sess_get_index,
2041 .sess_get_initiator_sid = NULL,
2042 .write_pending = tcm_vhost_write_pending,
2043 .write_pending_status = tcm_vhost_write_pending_status,
2044 .set_default_node_attributes = tcm_vhost_set_default_node_attrs,
2045 .get_task_tag = tcm_vhost_get_task_tag,
2046 .get_cmd_state = tcm_vhost_get_cmd_state,
2047 .queue_data_in = tcm_vhost_queue_data_in,
2048 .queue_status = tcm_vhost_queue_status,
2049 .queue_tm_rsp = tcm_vhost_queue_tm_rsp,
2051 * Setup callers for generic logic in target_core_fabric_configfs.c
2053 .fabric_make_wwn = tcm_vhost_make_tport,
2054 .fabric_drop_wwn = tcm_vhost_drop_tport,
2055 .fabric_make_tpg = tcm_vhost_make_tpg,
2056 .fabric_drop_tpg = tcm_vhost_drop_tpg,
2057 .fabric_post_link = tcm_vhost_port_link,
2058 .fabric_pre_unlink = tcm_vhost_port_unlink,
2059 .fabric_make_np = NULL,
2060 .fabric_drop_np = NULL,
2061 .fabric_make_nodeacl = tcm_vhost_make_nodeacl,
2062 .fabric_drop_nodeacl = tcm_vhost_drop_nodeacl,
2065 static int tcm_vhost_register_configfs(void)
2067 struct target_fabric_configfs *fabric;
2070 pr_debug("TCM_VHOST fabric module %s on %s/%s"
2071 " on "UTS_RELEASE"\n", TCM_VHOST_VERSION, utsname()->sysname,
2072 utsname()->machine);
2074 * Register the top level struct config_item_type with TCM core
2076 fabric = target_fabric_configfs_init(THIS_MODULE, "vhost");
2077 if (IS_ERR(fabric)) {
2078 pr_err("target_fabric_configfs_init() failed\n");
2079 return PTR_ERR(fabric);
2082 * Setup fabric->tf_ops from our local tcm_vhost_ops
2084 fabric->tf_ops = tcm_vhost_ops;
2086 * Setup default attribute lists for various fabric->tf_cit_tmpl
2088 TF_CIT_TMPL(fabric)->tfc_wwn_cit.ct_attrs = tcm_vhost_wwn_attrs;
2089 TF_CIT_TMPL(fabric)->tfc_tpg_base_cit.ct_attrs = tcm_vhost_tpg_attrs;
2090 TF_CIT_TMPL(fabric)->tfc_tpg_attrib_cit.ct_attrs = NULL;
2091 TF_CIT_TMPL(fabric)->tfc_tpg_param_cit.ct_attrs = NULL;
2092 TF_CIT_TMPL(fabric)->tfc_tpg_np_base_cit.ct_attrs = NULL;
2093 TF_CIT_TMPL(fabric)->tfc_tpg_nacl_base_cit.ct_attrs = NULL;
2094 TF_CIT_TMPL(fabric)->tfc_tpg_nacl_attrib_cit.ct_attrs = NULL;
2095 TF_CIT_TMPL(fabric)->tfc_tpg_nacl_auth_cit.ct_attrs = NULL;
2096 TF_CIT_TMPL(fabric)->tfc_tpg_nacl_param_cit.ct_attrs = NULL;
2098 * Register the fabric for use within TCM
2100 ret = target_fabric_configfs_register(fabric);
2102 pr_err("target_fabric_configfs_register() failed"
2103 " for TCM_VHOST\n");
2107 * Setup our local pointer to *fabric
2109 tcm_vhost_fabric_configfs = fabric;
2110 pr_debug("TCM_VHOST[0] - Set fabric -> tcm_vhost_fabric_configfs\n");
2114 static void tcm_vhost_deregister_configfs(void)
2116 if (!tcm_vhost_fabric_configfs)
2119 target_fabric_configfs_deregister(tcm_vhost_fabric_configfs);
2120 tcm_vhost_fabric_configfs = NULL;
2121 pr_debug("TCM_VHOST[0] - Cleared tcm_vhost_fabric_configfs\n");
2124 static int __init tcm_vhost_init(void)
2128 * Use our own dedicated workqueue for submitting I/O into
2129 * target core to avoid contention within system_wq.
2131 tcm_vhost_workqueue = alloc_workqueue("tcm_vhost", 0, 0);
2132 if (!tcm_vhost_workqueue)
2135 ret = vhost_scsi_register();
2137 goto out_destroy_workqueue;
2139 ret = tcm_vhost_register_configfs();
2141 goto out_vhost_scsi_deregister;
2145 out_vhost_scsi_deregister:
2146 vhost_scsi_deregister();
2147 out_destroy_workqueue:
2148 destroy_workqueue(tcm_vhost_workqueue);
2153 static void tcm_vhost_exit(void)
2155 tcm_vhost_deregister_configfs();
2156 vhost_scsi_deregister();
2157 destroy_workqueue(tcm_vhost_workqueue);
2160 MODULE_DESCRIPTION("VHOST_SCSI series fabric driver");
2161 MODULE_ALIAS("tcm_vhost");
2162 MODULE_LICENSE("GPL");
2163 module_init(tcm_vhost_init);
2164 module_exit(tcm_vhost_exit);