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_common.h>
41 #include <scsi/scsi_proto.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>
51 #include <linux/percpu_ida.h>
55 #define VHOST_SCSI_VERSION "v0.1"
56 #define VHOST_SCSI_NAMELEN 256
57 #define VHOST_SCSI_MAX_CDB_SIZE 32
58 #define VHOST_SCSI_DEFAULT_TAGS 256
59 #define VHOST_SCSI_PREALLOC_SGLS 2048
60 #define VHOST_SCSI_PREALLOC_UPAGES 2048
61 #define VHOST_SCSI_PREALLOC_PROT_SGLS 512
63 struct vhost_scsi_inflight {
64 /* Wait for the flush operation to finish */
65 struct completion comp;
66 /* Refcount for the inflight reqs */
70 struct vhost_scsi_cmd {
71 /* Descriptor from vhost_get_vq_desc() for virt_queue segment */
73 /* virtio-scsi initiator task attribute */
75 /* virtio-scsi response incoming iovecs */
77 /* virtio-scsi initiator data direction */
78 enum dma_data_direction tvc_data_direction;
79 /* Expected data transfer length from virtio-scsi header */
81 /* The Tag from include/linux/virtio_scsi.h:struct virtio_scsi_cmd_req */
83 /* The number of scatterlists associated with this cmd */
85 u32 tvc_prot_sgl_count;
86 /* Saved unpacked SCSI LUN for vhost_scsi_submission_work() */
88 /* Pointer to the SGL formatted memory from virtio-scsi */
89 struct scatterlist *tvc_sgl;
90 struct scatterlist *tvc_prot_sgl;
91 struct page **tvc_upages;
92 /* Pointer to response header iovec */
93 struct iovec *tvc_resp_iov;
94 /* Pointer to vhost_scsi for our device */
95 struct vhost_scsi *tvc_vhost;
96 /* Pointer to vhost_virtqueue for the cmd */
97 struct vhost_virtqueue *tvc_vq;
98 /* Pointer to vhost nexus memory */
99 struct vhost_scsi_nexus *tvc_nexus;
100 /* The TCM I/O descriptor that is accessed via container_of() */
101 struct se_cmd tvc_se_cmd;
102 /* work item used for cmwq dispatch to vhost_scsi_submission_work() */
103 struct work_struct work;
104 /* Copy of the incoming SCSI command descriptor block (CDB) */
105 unsigned char tvc_cdb[VHOST_SCSI_MAX_CDB_SIZE];
106 /* Sense buffer that will be mapped into outgoing status */
107 unsigned char tvc_sense_buf[TRANSPORT_SENSE_BUFFER];
108 /* Completed commands list, serviced from vhost worker thread */
109 struct llist_node tvc_completion_list;
110 /* Used to track inflight cmd */
111 struct vhost_scsi_inflight *inflight;
114 struct vhost_scsi_nexus {
115 /* Pointer to TCM session for I_T Nexus */
116 struct se_session *tvn_se_sess;
119 struct vhost_scsi_nacl {
120 /* Binary World Wide unique Port Name for Vhost Initiator port */
122 /* ASCII formatted WWPN for Sas Initiator port */
123 char iport_name[VHOST_SCSI_NAMELEN];
124 /* Returned by vhost_scsi_make_nodeacl() */
125 struct se_node_acl se_node_acl;
128 struct vhost_scsi_tpg {
129 /* Vhost port target portal group tag for TCM */
131 /* Used to track number of TPG Port/Lun Links wrt to explict I_T Nexus shutdown */
132 int tv_tpg_port_count;
133 /* Used for vhost_scsi device reference to tpg_nexus, protected by tv_tpg_mutex */
134 int tv_tpg_vhost_count;
135 /* Used for enabling T10-PI with legacy devices */
136 int tv_fabric_prot_type;
137 /* list for vhost_scsi_list */
138 struct list_head tv_tpg_list;
139 /* Used to protect access for tpg_nexus */
140 struct mutex tv_tpg_mutex;
141 /* Pointer to the TCM VHost I_T Nexus for this TPG endpoint */
142 struct vhost_scsi_nexus *tpg_nexus;
143 /* Pointer back to vhost_scsi_tport */
144 struct vhost_scsi_tport *tport;
145 /* Returned by vhost_scsi_make_tpg() */
146 struct se_portal_group se_tpg;
147 /* Pointer back to vhost_scsi, protected by tv_tpg_mutex */
148 struct vhost_scsi *vhost_scsi;
151 struct vhost_scsi_tport {
152 /* SCSI protocol the tport is providing */
154 /* Binary World Wide unique Port Name for Vhost Target port */
156 /* ASCII formatted WWPN for Vhost Target port */
157 char tport_name[VHOST_SCSI_NAMELEN];
158 /* Returned by vhost_scsi_make_tport() */
159 struct se_wwn tport_wwn;
162 struct vhost_scsi_evt {
163 /* event to be sent to guest */
164 struct virtio_scsi_event event;
165 /* event list, serviced from vhost worker thread */
166 struct llist_node list;
170 VHOST_SCSI_VQ_CTL = 0,
171 VHOST_SCSI_VQ_EVT = 1,
172 VHOST_SCSI_VQ_IO = 2,
175 /* Note: can't set VIRTIO_F_VERSION_1 yet, since that implies ANY_LAYOUT. */
177 VHOST_SCSI_FEATURES = VHOST_FEATURES | (1ULL << VIRTIO_SCSI_F_HOTPLUG) |
178 (1ULL << VIRTIO_SCSI_F_T10_PI) |
179 (1ULL << VIRTIO_F_ANY_LAYOUT) |
180 (1ULL << VIRTIO_F_VERSION_1)
183 #define VHOST_SCSI_MAX_TARGET 256
184 #define VHOST_SCSI_MAX_VQ 128
185 #define VHOST_SCSI_MAX_EVENT 128
187 struct vhost_scsi_virtqueue {
188 struct vhost_virtqueue vq;
190 * Reference counting for inflight reqs, used for flush operation. At
191 * each time, one reference tracks new commands submitted, while we
192 * wait for another one to reach 0.
194 struct vhost_scsi_inflight inflights[2];
196 * Indicate current inflight in use, protected by vq->mutex.
197 * Writers must also take dev mutex and flush under it.
203 /* Protected by vhost_scsi->dev.mutex */
204 struct vhost_scsi_tpg **vs_tpg;
205 char vs_vhost_wwpn[TRANSPORT_IQN_LEN];
207 struct vhost_dev dev;
208 struct vhost_scsi_virtqueue vqs[VHOST_SCSI_MAX_VQ];
210 struct vhost_work vs_completion_work; /* cmd completion work item */
211 struct llist_head vs_completion_list; /* cmd completion queue */
213 struct vhost_work vs_event_work; /* evt injection work item */
214 struct llist_head vs_event_list; /* evt injection queue */
216 bool vs_events_missed; /* any missed events, protected by vq->mutex */
217 int vs_events_nr; /* num of pending events, protected by vq->mutex */
220 static struct target_core_fabric_ops vhost_scsi_ops;
221 static struct workqueue_struct *vhost_scsi_workqueue;
223 /* Global spinlock to protect vhost_scsi TPG list for vhost IOCTL access */
224 static DEFINE_MUTEX(vhost_scsi_mutex);
225 static LIST_HEAD(vhost_scsi_list);
227 static int iov_num_pages(void __user *iov_base, size_t iov_len)
229 return (PAGE_ALIGN((unsigned long)iov_base + iov_len) -
230 ((unsigned long)iov_base & PAGE_MASK)) >> PAGE_SHIFT;
233 static void vhost_scsi_done_inflight(struct kref *kref)
235 struct vhost_scsi_inflight *inflight;
237 inflight = container_of(kref, struct vhost_scsi_inflight, kref);
238 complete(&inflight->comp);
241 static void vhost_scsi_init_inflight(struct vhost_scsi *vs,
242 struct vhost_scsi_inflight *old_inflight[])
244 struct vhost_scsi_inflight *new_inflight;
245 struct vhost_virtqueue *vq;
248 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
251 mutex_lock(&vq->mutex);
253 /* store old infight */
254 idx = vs->vqs[i].inflight_idx;
256 old_inflight[i] = &vs->vqs[i].inflights[idx];
258 /* setup new infight */
259 vs->vqs[i].inflight_idx = idx ^ 1;
260 new_inflight = &vs->vqs[i].inflights[idx ^ 1];
261 kref_init(&new_inflight->kref);
262 init_completion(&new_inflight->comp);
264 mutex_unlock(&vq->mutex);
268 static struct vhost_scsi_inflight *
269 vhost_scsi_get_inflight(struct vhost_virtqueue *vq)
271 struct vhost_scsi_inflight *inflight;
272 struct vhost_scsi_virtqueue *svq;
274 svq = container_of(vq, struct vhost_scsi_virtqueue, vq);
275 inflight = &svq->inflights[svq->inflight_idx];
276 kref_get(&inflight->kref);
281 static void vhost_scsi_put_inflight(struct vhost_scsi_inflight *inflight)
283 kref_put(&inflight->kref, vhost_scsi_done_inflight);
286 static int vhost_scsi_check_true(struct se_portal_group *se_tpg)
291 static int vhost_scsi_check_false(struct se_portal_group *se_tpg)
296 static char *vhost_scsi_get_fabric_name(void)
301 static u8 vhost_scsi_get_fabric_proto_ident(struct se_portal_group *se_tpg)
303 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
304 struct vhost_scsi_tpg, se_tpg);
305 struct vhost_scsi_tport *tport = tpg->tport;
307 switch (tport->tport_proto_id) {
308 case SCSI_PROTOCOL_SAS:
309 return sas_get_fabric_proto_ident(se_tpg);
310 case SCSI_PROTOCOL_FCP:
311 return fc_get_fabric_proto_ident(se_tpg);
312 case SCSI_PROTOCOL_ISCSI:
313 return iscsi_get_fabric_proto_ident(se_tpg);
315 pr_err("Unknown tport_proto_id: 0x%02x, using"
316 " SAS emulation\n", tport->tport_proto_id);
320 return sas_get_fabric_proto_ident(se_tpg);
323 static char *vhost_scsi_get_fabric_wwn(struct se_portal_group *se_tpg)
325 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
326 struct vhost_scsi_tpg, se_tpg);
327 struct vhost_scsi_tport *tport = tpg->tport;
329 return &tport->tport_name[0];
332 static u16 vhost_scsi_get_tpgt(struct se_portal_group *se_tpg)
334 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
335 struct vhost_scsi_tpg, se_tpg);
336 return tpg->tport_tpgt;
339 static u32 vhost_scsi_get_default_depth(struct se_portal_group *se_tpg)
345 vhost_scsi_get_pr_transport_id(struct se_portal_group *se_tpg,
346 struct se_node_acl *se_nacl,
347 struct t10_pr_registration *pr_reg,
351 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
352 struct vhost_scsi_tpg, se_tpg);
353 struct vhost_scsi_tport *tport = tpg->tport;
355 switch (tport->tport_proto_id) {
356 case SCSI_PROTOCOL_SAS:
357 return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
359 case SCSI_PROTOCOL_FCP:
360 return fc_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
362 case SCSI_PROTOCOL_ISCSI:
363 return iscsi_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
366 pr_err("Unknown tport_proto_id: 0x%02x, using"
367 " SAS emulation\n", tport->tport_proto_id);
371 return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
376 vhost_scsi_get_pr_transport_id_len(struct se_portal_group *se_tpg,
377 struct se_node_acl *se_nacl,
378 struct t10_pr_registration *pr_reg,
381 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
382 struct vhost_scsi_tpg, se_tpg);
383 struct vhost_scsi_tport *tport = tpg->tport;
385 switch (tport->tport_proto_id) {
386 case SCSI_PROTOCOL_SAS:
387 return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
389 case SCSI_PROTOCOL_FCP:
390 return fc_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
392 case SCSI_PROTOCOL_ISCSI:
393 return iscsi_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
396 pr_err("Unknown tport_proto_id: 0x%02x, using"
397 " SAS emulation\n", tport->tport_proto_id);
401 return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
406 vhost_scsi_parse_pr_out_transport_id(struct se_portal_group *se_tpg,
409 char **port_nexus_ptr)
411 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
412 struct vhost_scsi_tpg, se_tpg);
413 struct vhost_scsi_tport *tport = tpg->tport;
415 switch (tport->tport_proto_id) {
416 case SCSI_PROTOCOL_SAS:
417 return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
419 case SCSI_PROTOCOL_FCP:
420 return fc_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
422 case SCSI_PROTOCOL_ISCSI:
423 return iscsi_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
426 pr_err("Unknown tport_proto_id: 0x%02x, using"
427 " SAS emulation\n", tport->tport_proto_id);
431 return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
435 static int vhost_scsi_check_prot_fabric_only(struct se_portal_group *se_tpg)
437 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
438 struct vhost_scsi_tpg, se_tpg);
440 return tpg->tv_fabric_prot_type;
443 static struct se_node_acl *
444 vhost_scsi_alloc_fabric_acl(struct se_portal_group *se_tpg)
446 struct vhost_scsi_nacl *nacl;
448 nacl = kzalloc(sizeof(struct vhost_scsi_nacl), GFP_KERNEL);
450 pr_err("Unable to allocate struct vhost_scsi_nacl\n");
454 return &nacl->se_node_acl;
458 vhost_scsi_release_fabric_acl(struct se_portal_group *se_tpg,
459 struct se_node_acl *se_nacl)
461 struct vhost_scsi_nacl *nacl = container_of(se_nacl,
462 struct vhost_scsi_nacl, se_node_acl);
466 static u32 vhost_scsi_tpg_get_inst_index(struct se_portal_group *se_tpg)
471 static void vhost_scsi_release_cmd(struct se_cmd *se_cmd)
473 struct vhost_scsi_cmd *tv_cmd = container_of(se_cmd,
474 struct vhost_scsi_cmd, tvc_se_cmd);
475 struct se_session *se_sess = tv_cmd->tvc_nexus->tvn_se_sess;
478 if (tv_cmd->tvc_sgl_count) {
479 for (i = 0; i < tv_cmd->tvc_sgl_count; i++)
480 put_page(sg_page(&tv_cmd->tvc_sgl[i]));
482 if (tv_cmd->tvc_prot_sgl_count) {
483 for (i = 0; i < tv_cmd->tvc_prot_sgl_count; i++)
484 put_page(sg_page(&tv_cmd->tvc_prot_sgl[i]));
487 vhost_scsi_put_inflight(tv_cmd->inflight);
488 percpu_ida_free(&se_sess->sess_tag_pool, se_cmd->map_tag);
491 static int vhost_scsi_shutdown_session(struct se_session *se_sess)
496 static void vhost_scsi_close_session(struct se_session *se_sess)
501 static u32 vhost_scsi_sess_get_index(struct se_session *se_sess)
506 static int vhost_scsi_write_pending(struct se_cmd *se_cmd)
508 /* Go ahead and process the write immediately */
509 target_execute_cmd(se_cmd);
513 static int vhost_scsi_write_pending_status(struct se_cmd *se_cmd)
518 static void vhost_scsi_set_default_node_attrs(struct se_node_acl *nacl)
523 static u32 vhost_scsi_get_task_tag(struct se_cmd *se_cmd)
528 static int vhost_scsi_get_cmd_state(struct se_cmd *se_cmd)
533 static void vhost_scsi_complete_cmd(struct vhost_scsi_cmd *cmd)
535 struct vhost_scsi *vs = cmd->tvc_vhost;
537 llist_add(&cmd->tvc_completion_list, &vs->vs_completion_list);
539 vhost_work_queue(&vs->dev, &vs->vs_completion_work);
542 static int vhost_scsi_queue_data_in(struct se_cmd *se_cmd)
544 struct vhost_scsi_cmd *cmd = container_of(se_cmd,
545 struct vhost_scsi_cmd, tvc_se_cmd);
546 vhost_scsi_complete_cmd(cmd);
550 static int vhost_scsi_queue_status(struct se_cmd *se_cmd)
552 struct vhost_scsi_cmd *cmd = container_of(se_cmd,
553 struct vhost_scsi_cmd, tvc_se_cmd);
554 vhost_scsi_complete_cmd(cmd);
558 static void vhost_scsi_queue_tm_rsp(struct se_cmd *se_cmd)
563 static void vhost_scsi_aborted_task(struct se_cmd *se_cmd)
568 static void vhost_scsi_free_evt(struct vhost_scsi *vs, struct vhost_scsi_evt *evt)
574 static struct vhost_scsi_evt *
575 vhost_scsi_allocate_evt(struct vhost_scsi *vs,
576 u32 event, u32 reason)
578 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
579 struct vhost_scsi_evt *evt;
581 if (vs->vs_events_nr > VHOST_SCSI_MAX_EVENT) {
582 vs->vs_events_missed = true;
586 evt = kzalloc(sizeof(*evt), GFP_KERNEL);
588 vq_err(vq, "Failed to allocate vhost_scsi_evt\n");
589 vs->vs_events_missed = true;
593 evt->event.event = cpu_to_vhost32(vq, event);
594 evt->event.reason = cpu_to_vhost32(vq, reason);
600 static void vhost_scsi_free_cmd(struct vhost_scsi_cmd *cmd)
602 struct se_cmd *se_cmd = &cmd->tvc_se_cmd;
604 /* TODO locking against target/backend threads? */
605 transport_generic_free_cmd(se_cmd, 0);
609 static int vhost_scsi_check_stop_free(struct se_cmd *se_cmd)
611 return target_put_sess_cmd(se_cmd->se_sess, se_cmd);
615 vhost_scsi_do_evt_work(struct vhost_scsi *vs, struct vhost_scsi_evt *evt)
617 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
618 struct virtio_scsi_event *event = &evt->event;
619 struct virtio_scsi_event __user *eventp;
623 if (!vq->private_data) {
624 vs->vs_events_missed = true;
629 vhost_disable_notify(&vs->dev, vq);
630 head = vhost_get_vq_desc(vq, vq->iov,
631 ARRAY_SIZE(vq->iov), &out, &in,
634 vs->vs_events_missed = true;
637 if (head == vq->num) {
638 if (vhost_enable_notify(&vs->dev, vq))
640 vs->vs_events_missed = true;
644 if ((vq->iov[out].iov_len != sizeof(struct virtio_scsi_event))) {
645 vq_err(vq, "Expecting virtio_scsi_event, got %zu bytes\n",
646 vq->iov[out].iov_len);
647 vs->vs_events_missed = true;
651 if (vs->vs_events_missed) {
652 event->event |= cpu_to_vhost32(vq, VIRTIO_SCSI_T_EVENTS_MISSED);
653 vs->vs_events_missed = false;
656 eventp = vq->iov[out].iov_base;
657 ret = __copy_to_user(eventp, event, sizeof(*event));
659 vhost_add_used_and_signal(&vs->dev, vq, head, 0);
661 vq_err(vq, "Faulted on vhost_scsi_send_event\n");
664 static void vhost_scsi_evt_work(struct vhost_work *work)
666 struct vhost_scsi *vs = container_of(work, struct vhost_scsi,
668 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
669 struct vhost_scsi_evt *evt;
670 struct llist_node *llnode;
672 mutex_lock(&vq->mutex);
673 llnode = llist_del_all(&vs->vs_event_list);
675 evt = llist_entry(llnode, struct vhost_scsi_evt, list);
676 llnode = llist_next(llnode);
677 vhost_scsi_do_evt_work(vs, evt);
678 vhost_scsi_free_evt(vs, evt);
680 mutex_unlock(&vq->mutex);
683 /* Fill in status and signal that we are done processing this command
685 * This is scheduled in the vhost work queue so we are called with the owner
686 * process mm and can access the vring.
688 static void vhost_scsi_complete_cmd_work(struct vhost_work *work)
690 struct vhost_scsi *vs = container_of(work, struct vhost_scsi,
692 DECLARE_BITMAP(signal, VHOST_SCSI_MAX_VQ);
693 struct virtio_scsi_cmd_resp v_rsp;
694 struct vhost_scsi_cmd *cmd;
695 struct llist_node *llnode;
696 struct se_cmd *se_cmd;
697 struct iov_iter iov_iter;
700 bitmap_zero(signal, VHOST_SCSI_MAX_VQ);
701 llnode = llist_del_all(&vs->vs_completion_list);
703 cmd = llist_entry(llnode, struct vhost_scsi_cmd,
704 tvc_completion_list);
705 llnode = llist_next(llnode);
706 se_cmd = &cmd->tvc_se_cmd;
708 pr_debug("%s tv_cmd %p resid %u status %#02x\n", __func__,
709 cmd, se_cmd->residual_count, se_cmd->scsi_status);
711 memset(&v_rsp, 0, sizeof(v_rsp));
712 v_rsp.resid = cpu_to_vhost32(cmd->tvc_vq, se_cmd->residual_count);
713 /* TODO is status_qualifier field needed? */
714 v_rsp.status = se_cmd->scsi_status;
715 v_rsp.sense_len = cpu_to_vhost32(cmd->tvc_vq,
716 se_cmd->scsi_sense_length);
717 memcpy(v_rsp.sense, cmd->tvc_sense_buf,
718 se_cmd->scsi_sense_length);
720 iov_iter_init(&iov_iter, READ, cmd->tvc_resp_iov,
721 cmd->tvc_in_iovs, sizeof(v_rsp));
722 ret = copy_to_iter(&v_rsp, sizeof(v_rsp), &iov_iter);
723 if (likely(ret == sizeof(v_rsp))) {
724 struct vhost_scsi_virtqueue *q;
725 vhost_add_used(cmd->tvc_vq, cmd->tvc_vq_desc, 0);
726 q = container_of(cmd->tvc_vq, struct vhost_scsi_virtqueue, vq);
728 __set_bit(vq, signal);
730 pr_err("Faulted on virtio_scsi_cmd_resp\n");
732 vhost_scsi_free_cmd(cmd);
736 while ((vq = find_next_bit(signal, VHOST_SCSI_MAX_VQ, vq + 1))
738 vhost_signal(&vs->dev, &vs->vqs[vq].vq);
741 static struct vhost_scsi_cmd *
742 vhost_scsi_get_tag(struct vhost_virtqueue *vq, struct vhost_scsi_tpg *tpg,
743 unsigned char *cdb, u64 scsi_tag, u16 lun, u8 task_attr,
744 u32 exp_data_len, int data_direction)
746 struct vhost_scsi_cmd *cmd;
747 struct vhost_scsi_nexus *tv_nexus;
748 struct se_session *se_sess;
749 struct scatterlist *sg, *prot_sg;
753 tv_nexus = tpg->tpg_nexus;
755 pr_err("Unable to locate active struct vhost_scsi_nexus\n");
756 return ERR_PTR(-EIO);
758 se_sess = tv_nexus->tvn_se_sess;
760 tag = percpu_ida_alloc(&se_sess->sess_tag_pool, TASK_RUNNING);
762 pr_err("Unable to obtain tag for vhost_scsi_cmd\n");
763 return ERR_PTR(-ENOMEM);
766 cmd = &((struct vhost_scsi_cmd *)se_sess->sess_cmd_map)[tag];
768 prot_sg = cmd->tvc_prot_sgl;
769 pages = cmd->tvc_upages;
770 memset(cmd, 0, sizeof(struct vhost_scsi_cmd));
773 cmd->tvc_prot_sgl = prot_sg;
774 cmd->tvc_upages = pages;
775 cmd->tvc_se_cmd.map_tag = tag;
776 cmd->tvc_tag = scsi_tag;
778 cmd->tvc_task_attr = task_attr;
779 cmd->tvc_exp_data_len = exp_data_len;
780 cmd->tvc_data_direction = data_direction;
781 cmd->tvc_nexus = tv_nexus;
782 cmd->inflight = vhost_scsi_get_inflight(vq);
784 memcpy(cmd->tvc_cdb, cdb, VHOST_SCSI_MAX_CDB_SIZE);
790 * Map a user memory range into a scatterlist
792 * Returns the number of scatterlist entries used or -errno on error.
795 vhost_scsi_map_to_sgl(struct vhost_scsi_cmd *cmd,
798 struct scatterlist *sgl,
801 unsigned int npages = 0, offset, nbytes;
802 unsigned int pages_nr = iov_num_pages(ptr, len);
803 struct scatterlist *sg = sgl;
804 struct page **pages = cmd->tvc_upages;
807 if (pages_nr > VHOST_SCSI_PREALLOC_UPAGES) {
808 pr_err("vhost_scsi_map_to_sgl() pages_nr: %u greater than"
809 " preallocated VHOST_SCSI_PREALLOC_UPAGES: %u\n",
810 pages_nr, VHOST_SCSI_PREALLOC_UPAGES);
814 ret = get_user_pages_fast((unsigned long)ptr, pages_nr, write, pages);
815 /* No pages were pinned */
818 /* Less pages pinned than wanted */
819 if (ret != pages_nr) {
820 for (i = 0; i < ret; i++)
827 offset = (uintptr_t)ptr & ~PAGE_MASK;
828 nbytes = min_t(unsigned int, PAGE_SIZE - offset, len);
829 sg_set_page(sg, pages[npages], nbytes, offset);
841 vhost_scsi_calc_sgls(struct iov_iter *iter, size_t bytes, int max_sgls)
845 if (!iter || !iter->iov) {
846 pr_err("%s: iter->iov is NULL, but expected bytes: %zu"
847 " present\n", __func__, bytes);
851 sgl_count = iov_iter_npages(iter, 0xffff);
852 if (sgl_count > max_sgls) {
853 pr_err("%s: requested sgl_count: %d exceeds pre-allocated"
854 " max_sgls: %d\n", __func__, sgl_count, max_sgls);
861 vhost_scsi_iov_to_sgl(struct vhost_scsi_cmd *cmd, bool write,
862 struct iov_iter *iter,
863 struct scatterlist *sg, int sg_count)
865 size_t off = iter->iov_offset;
868 for (i = 0; i < iter->nr_segs; i++) {
869 void __user *base = iter->iov[i].iov_base + off;
870 size_t len = iter->iov[i].iov_len - off;
872 ret = vhost_scsi_map_to_sgl(cmd, base, len, sg, write);
874 for (i = 0; i < sg_count; i++) {
875 struct page *page = sg_page(&sg[i]);
888 vhost_scsi_mapal(struct vhost_scsi_cmd *cmd,
889 size_t prot_bytes, struct iov_iter *prot_iter,
890 size_t data_bytes, struct iov_iter *data_iter)
893 bool write = (cmd->tvc_data_direction == DMA_FROM_DEVICE);
896 sgl_count = vhost_scsi_calc_sgls(prot_iter, prot_bytes,
897 VHOST_SCSI_PREALLOC_PROT_SGLS);
901 sg_init_table(cmd->tvc_prot_sgl, sgl_count);
902 cmd->tvc_prot_sgl_count = sgl_count;
903 pr_debug("%s prot_sg %p prot_sgl_count %u\n", __func__,
904 cmd->tvc_prot_sgl, cmd->tvc_prot_sgl_count);
906 ret = vhost_scsi_iov_to_sgl(cmd, write, prot_iter,
908 cmd->tvc_prot_sgl_count);
910 cmd->tvc_prot_sgl_count = 0;
914 sgl_count = vhost_scsi_calc_sgls(data_iter, data_bytes,
915 VHOST_SCSI_PREALLOC_SGLS);
919 sg_init_table(cmd->tvc_sgl, sgl_count);
920 cmd->tvc_sgl_count = sgl_count;
921 pr_debug("%s data_sg %p data_sgl_count %u\n", __func__,
922 cmd->tvc_sgl, cmd->tvc_sgl_count);
924 ret = vhost_scsi_iov_to_sgl(cmd, write, data_iter,
925 cmd->tvc_sgl, cmd->tvc_sgl_count);
927 cmd->tvc_sgl_count = 0;
933 static int vhost_scsi_to_tcm_attr(int attr)
936 case VIRTIO_SCSI_S_SIMPLE:
937 return TCM_SIMPLE_TAG;
938 case VIRTIO_SCSI_S_ORDERED:
939 return TCM_ORDERED_TAG;
940 case VIRTIO_SCSI_S_HEAD:
942 case VIRTIO_SCSI_S_ACA:
947 return TCM_SIMPLE_TAG;
950 static void vhost_scsi_submission_work(struct work_struct *work)
952 struct vhost_scsi_cmd *cmd =
953 container_of(work, struct vhost_scsi_cmd, work);
954 struct vhost_scsi_nexus *tv_nexus;
955 struct se_cmd *se_cmd = &cmd->tvc_se_cmd;
956 struct scatterlist *sg_ptr, *sg_prot_ptr = NULL;
959 /* FIXME: BIDI operation */
960 if (cmd->tvc_sgl_count) {
961 sg_ptr = cmd->tvc_sgl;
963 if (cmd->tvc_prot_sgl_count)
964 sg_prot_ptr = cmd->tvc_prot_sgl;
966 se_cmd->prot_pto = true;
970 tv_nexus = cmd->tvc_nexus;
972 rc = target_submit_cmd_map_sgls(se_cmd, tv_nexus->tvn_se_sess,
973 cmd->tvc_cdb, &cmd->tvc_sense_buf[0],
974 cmd->tvc_lun, cmd->tvc_exp_data_len,
975 vhost_scsi_to_tcm_attr(cmd->tvc_task_attr),
976 cmd->tvc_data_direction, TARGET_SCF_ACK_KREF,
977 sg_ptr, cmd->tvc_sgl_count, NULL, 0, sg_prot_ptr,
978 cmd->tvc_prot_sgl_count);
980 transport_send_check_condition_and_sense(se_cmd,
981 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE, 0);
982 transport_generic_free_cmd(se_cmd, 0);
987 vhost_scsi_send_bad_target(struct vhost_scsi *vs,
988 struct vhost_virtqueue *vq,
989 int head, unsigned out)
991 struct virtio_scsi_cmd_resp __user *resp;
992 struct virtio_scsi_cmd_resp rsp;
995 memset(&rsp, 0, sizeof(rsp));
996 rsp.response = VIRTIO_SCSI_S_BAD_TARGET;
997 resp = vq->iov[out].iov_base;
998 ret = __copy_to_user(resp, &rsp, sizeof(rsp));
1000 vhost_add_used_and_signal(&vs->dev, vq, head, 0);
1002 pr_err("Faulted on virtio_scsi_cmd_resp\n");
1006 vhost_scsi_handle_vq(struct vhost_scsi *vs, struct vhost_virtqueue *vq)
1008 struct vhost_scsi_tpg **vs_tpg, *tpg;
1009 struct virtio_scsi_cmd_req v_req;
1010 struct virtio_scsi_cmd_req_pi v_req_pi;
1011 struct vhost_scsi_cmd *cmd;
1012 struct iov_iter out_iter, in_iter, prot_iter, data_iter;
1014 u32 exp_data_len, data_direction;
1016 int head, ret, prot_bytes;
1017 size_t req_size, rsp_size = sizeof(struct virtio_scsi_cmd_resp);
1018 size_t out_size, in_size;
1020 u8 *target, *lunp, task_attr;
1021 bool t10_pi = vhost_has_feature(vq, VIRTIO_SCSI_F_T10_PI);
1024 mutex_lock(&vq->mutex);
1026 * We can handle the vq only after the endpoint is setup by calling the
1027 * VHOST_SCSI_SET_ENDPOINT ioctl.
1029 vs_tpg = vq->private_data;
1033 vhost_disable_notify(&vs->dev, vq);
1036 head = vhost_get_vq_desc(vq, vq->iov,
1037 ARRAY_SIZE(vq->iov), &out, &in,
1039 pr_debug("vhost_get_vq_desc: head: %d, out: %u in: %u\n",
1041 /* On error, stop handling until the next kick. */
1042 if (unlikely(head < 0))
1044 /* Nothing new? Wait for eventfd to tell us they refilled. */
1045 if (head == vq->num) {
1046 if (unlikely(vhost_enable_notify(&vs->dev, vq))) {
1047 vhost_disable_notify(&vs->dev, vq);
1053 * Check for a sane response buffer so we can report early
1054 * errors back to the guest.
1056 if (unlikely(vq->iov[out].iov_len < rsp_size)) {
1057 vq_err(vq, "Expecting at least virtio_scsi_cmd_resp"
1058 " size, got %zu bytes\n", vq->iov[out].iov_len);
1062 * Setup pointers and values based upon different virtio-scsi
1063 * request header if T10_PI is enabled in KVM guest.
1067 req_size = sizeof(v_req_pi);
1068 lunp = &v_req_pi.lun[0];
1069 target = &v_req_pi.lun[1];
1072 req_size = sizeof(v_req);
1073 lunp = &v_req.lun[0];
1074 target = &v_req.lun[1];
1077 * FIXME: Not correct for BIDI operation
1079 out_size = iov_length(vq->iov, out);
1080 in_size = iov_length(&vq->iov[out], in);
1083 * Copy over the virtio-scsi request header, which for a
1084 * ANY_LAYOUT enabled guest may span multiple iovecs, or a
1085 * single iovec may contain both the header + outgoing
1088 * copy_from_iter() will advance out_iter, so that it will
1089 * point at the start of the outgoing WRITE payload, if
1090 * DMA_TO_DEVICE is set.
1092 iov_iter_init(&out_iter, WRITE, vq->iov, out, out_size);
1094 ret = copy_from_iter(req, req_size, &out_iter);
1095 if (unlikely(ret != req_size)) {
1096 vq_err(vq, "Faulted on copy_from_iter\n");
1097 vhost_scsi_send_bad_target(vs, vq, head, out);
1100 /* virtio-scsi spec requires byte 0 of the lun to be 1 */
1101 if (unlikely(*lunp != 1)) {
1102 vq_err(vq, "Illegal virtio-scsi lun: %u\n", *lunp);
1103 vhost_scsi_send_bad_target(vs, vq, head, out);
1107 tpg = ACCESS_ONCE(vs_tpg[*target]);
1108 if (unlikely(!tpg)) {
1109 /* Target does not exist, fail the request */
1110 vhost_scsi_send_bad_target(vs, vq, head, out);
1114 * Determine data_direction by calculating the total outgoing
1115 * iovec sizes + incoming iovec sizes vs. virtio-scsi request +
1116 * response headers respectively.
1118 * For DMA_TO_DEVICE this is out_iter, which is already pointing
1119 * to the right place.
1121 * For DMA_FROM_DEVICE, the iovec will be just past the end
1122 * of the virtio-scsi response header in either the same
1123 * or immediately following iovec.
1125 * Any associated T10_PI bytes for the outgoing / incoming
1126 * payloads are included in calculation of exp_data_len here.
1130 if (out_size > req_size) {
1131 data_direction = DMA_TO_DEVICE;
1132 exp_data_len = out_size - req_size;
1133 data_iter = out_iter;
1134 } else if (in_size > rsp_size) {
1135 data_direction = DMA_FROM_DEVICE;
1136 exp_data_len = in_size - rsp_size;
1138 iov_iter_init(&in_iter, READ, &vq->iov[out], in,
1139 rsp_size + exp_data_len);
1140 iov_iter_advance(&in_iter, rsp_size);
1141 data_iter = in_iter;
1143 data_direction = DMA_NONE;
1147 * If T10_PI header + payload is present, setup prot_iter values
1148 * and recalculate data_iter for vhost_scsi_mapal() mapping to
1149 * host scatterlists via get_user_pages_fast().
1152 if (v_req_pi.pi_bytesout) {
1153 if (data_direction != DMA_TO_DEVICE) {
1154 vq_err(vq, "Received non zero pi_bytesout,"
1155 " but wrong data_direction\n");
1156 vhost_scsi_send_bad_target(vs, vq, head, out);
1159 prot_bytes = vhost32_to_cpu(vq, v_req_pi.pi_bytesout);
1160 } else if (v_req_pi.pi_bytesin) {
1161 if (data_direction != DMA_FROM_DEVICE) {
1162 vq_err(vq, "Received non zero pi_bytesin,"
1163 " but wrong data_direction\n");
1164 vhost_scsi_send_bad_target(vs, vq, head, out);
1167 prot_bytes = vhost32_to_cpu(vq, v_req_pi.pi_bytesin);
1170 * Set prot_iter to data_iter, and advance past any
1171 * preceeding prot_bytes that may be present.
1173 * Also fix up the exp_data_len to reflect only the
1174 * actual data payload length.
1177 exp_data_len -= prot_bytes;
1178 prot_iter = data_iter;
1179 iov_iter_advance(&data_iter, prot_bytes);
1181 tag = vhost64_to_cpu(vq, v_req_pi.tag);
1182 task_attr = v_req_pi.task_attr;
1183 cdb = &v_req_pi.cdb[0];
1184 lun = ((v_req_pi.lun[2] << 8) | v_req_pi.lun[3]) & 0x3FFF;
1186 tag = vhost64_to_cpu(vq, v_req.tag);
1187 task_attr = v_req.task_attr;
1188 cdb = &v_req.cdb[0];
1189 lun = ((v_req.lun[2] << 8) | v_req.lun[3]) & 0x3FFF;
1192 * Check that the received CDB size does not exceeded our
1193 * hardcoded max for vhost-scsi, then get a pre-allocated
1194 * cmd descriptor for the new virtio-scsi tag.
1196 * TODO what if cdb was too small for varlen cdb header?
1198 if (unlikely(scsi_command_size(cdb) > VHOST_SCSI_MAX_CDB_SIZE)) {
1199 vq_err(vq, "Received SCSI CDB with command_size: %d that"
1200 " exceeds SCSI_MAX_VARLEN_CDB_SIZE: %d\n",
1201 scsi_command_size(cdb), VHOST_SCSI_MAX_CDB_SIZE);
1202 vhost_scsi_send_bad_target(vs, vq, head, out);
1205 cmd = vhost_scsi_get_tag(vq, tpg, cdb, tag, lun, task_attr,
1206 exp_data_len + prot_bytes,
1209 vq_err(vq, "vhost_scsi_get_tag failed %ld\n",
1211 vhost_scsi_send_bad_target(vs, vq, head, out);
1214 cmd->tvc_vhost = vs;
1216 cmd->tvc_resp_iov = &vq->iov[out];
1217 cmd->tvc_in_iovs = in;
1219 pr_debug("vhost_scsi got command opcode: %#02x, lun: %d\n",
1220 cmd->tvc_cdb[0], cmd->tvc_lun);
1221 pr_debug("cmd: %p exp_data_len: %d, prot_bytes: %d data_direction:"
1222 " %d\n", cmd, exp_data_len, prot_bytes, data_direction);
1224 if (data_direction != DMA_NONE) {
1225 ret = vhost_scsi_mapal(cmd,
1226 prot_bytes, &prot_iter,
1227 exp_data_len, &data_iter);
1228 if (unlikely(ret)) {
1229 vq_err(vq, "Failed to map iov to sgl\n");
1230 vhost_scsi_release_cmd(&cmd->tvc_se_cmd);
1231 vhost_scsi_send_bad_target(vs, vq, head, out);
1236 * Save the descriptor from vhost_get_vq_desc() to be used to
1237 * complete the virtio-scsi request in TCM callback context via
1238 * vhost_scsi_queue_data_in() and vhost_scsi_queue_status()
1240 cmd->tvc_vq_desc = head;
1242 * Dispatch cmd descriptor for cmwq execution in process
1243 * context provided by vhost_scsi_workqueue. This also ensures
1244 * cmd is executed on the same kworker CPU as this vhost
1245 * thread to gain positive L2 cache locality effects.
1247 INIT_WORK(&cmd->work, vhost_scsi_submission_work);
1248 queue_work(vhost_scsi_workqueue, &cmd->work);
1251 mutex_unlock(&vq->mutex);
1254 static void vhost_scsi_ctl_handle_kick(struct vhost_work *work)
1256 pr_debug("%s: The handling func for control queue.\n", __func__);
1260 vhost_scsi_send_evt(struct vhost_scsi *vs,
1261 struct vhost_scsi_tpg *tpg,
1266 struct vhost_scsi_evt *evt;
1268 evt = vhost_scsi_allocate_evt(vs, event, reason);
1273 /* TODO: share lun setup code with virtio-scsi.ko */
1275 * Note: evt->event is zeroed when we allocate it and
1276 * lun[4-7] need to be zero according to virtio-scsi spec.
1278 evt->event.lun[0] = 0x01;
1279 evt->event.lun[1] = tpg->tport_tpgt;
1280 if (lun->unpacked_lun >= 256)
1281 evt->event.lun[2] = lun->unpacked_lun >> 8 | 0x40 ;
1282 evt->event.lun[3] = lun->unpacked_lun & 0xFF;
1285 llist_add(&evt->list, &vs->vs_event_list);
1286 vhost_work_queue(&vs->dev, &vs->vs_event_work);
1289 static void vhost_scsi_evt_handle_kick(struct vhost_work *work)
1291 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1293 struct vhost_scsi *vs = container_of(vq->dev, struct vhost_scsi, dev);
1295 mutex_lock(&vq->mutex);
1296 if (!vq->private_data)
1299 if (vs->vs_events_missed)
1300 vhost_scsi_send_evt(vs, NULL, NULL, VIRTIO_SCSI_T_NO_EVENT, 0);
1302 mutex_unlock(&vq->mutex);
1305 static void vhost_scsi_handle_kick(struct vhost_work *work)
1307 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1309 struct vhost_scsi *vs = container_of(vq->dev, struct vhost_scsi, dev);
1311 vhost_scsi_handle_vq(vs, vq);
1314 static void vhost_scsi_flush_vq(struct vhost_scsi *vs, int index)
1316 vhost_poll_flush(&vs->vqs[index].vq.poll);
1319 /* Callers must hold dev mutex */
1320 static void vhost_scsi_flush(struct vhost_scsi *vs)
1322 struct vhost_scsi_inflight *old_inflight[VHOST_SCSI_MAX_VQ];
1325 /* Init new inflight and remember the old inflight */
1326 vhost_scsi_init_inflight(vs, old_inflight);
1329 * The inflight->kref was initialized to 1. We decrement it here to
1330 * indicate the start of the flush operation so that it will reach 0
1331 * when all the reqs are finished.
1333 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1334 kref_put(&old_inflight[i]->kref, vhost_scsi_done_inflight);
1336 /* Flush both the vhost poll and vhost work */
1337 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1338 vhost_scsi_flush_vq(vs, i);
1339 vhost_work_flush(&vs->dev, &vs->vs_completion_work);
1340 vhost_work_flush(&vs->dev, &vs->vs_event_work);
1342 /* Wait for all reqs issued before the flush to be finished */
1343 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1344 wait_for_completion(&old_inflight[i]->comp);
1348 * Called from vhost_scsi_ioctl() context to walk the list of available
1349 * vhost_scsi_tpg with an active struct vhost_scsi_nexus
1351 * The lock nesting rule is:
1352 * vhost_scsi_mutex -> vs->dev.mutex -> tpg->tv_tpg_mutex -> vq->mutex
1355 vhost_scsi_set_endpoint(struct vhost_scsi *vs,
1356 struct vhost_scsi_target *t)
1358 struct se_portal_group *se_tpg;
1359 struct vhost_scsi_tport *tv_tport;
1360 struct vhost_scsi_tpg *tpg;
1361 struct vhost_scsi_tpg **vs_tpg;
1362 struct vhost_virtqueue *vq;
1363 int index, ret, i, len;
1366 mutex_lock(&vhost_scsi_mutex);
1367 mutex_lock(&vs->dev.mutex);
1369 /* Verify that ring has been setup correctly. */
1370 for (index = 0; index < vs->dev.nvqs; ++index) {
1371 /* Verify that ring has been setup correctly. */
1372 if (!vhost_vq_access_ok(&vs->vqs[index].vq)) {
1378 len = sizeof(vs_tpg[0]) * VHOST_SCSI_MAX_TARGET;
1379 vs_tpg = kzalloc(len, GFP_KERNEL);
1385 memcpy(vs_tpg, vs->vs_tpg, len);
1387 list_for_each_entry(tpg, &vhost_scsi_list, tv_tpg_list) {
1388 mutex_lock(&tpg->tv_tpg_mutex);
1389 if (!tpg->tpg_nexus) {
1390 mutex_unlock(&tpg->tv_tpg_mutex);
1393 if (tpg->tv_tpg_vhost_count != 0) {
1394 mutex_unlock(&tpg->tv_tpg_mutex);
1397 tv_tport = tpg->tport;
1399 if (!strcmp(tv_tport->tport_name, t->vhost_wwpn)) {
1400 if (vs->vs_tpg && vs->vs_tpg[tpg->tport_tpgt]) {
1402 mutex_unlock(&tpg->tv_tpg_mutex);
1407 * In order to ensure individual vhost-scsi configfs
1408 * groups cannot be removed while in use by vhost ioctl,
1409 * go ahead and take an explicit se_tpg->tpg_group.cg_item
1412 se_tpg = &tpg->se_tpg;
1413 ret = configfs_depend_item(se_tpg->se_tpg_tfo->tf_subsys,
1414 &se_tpg->tpg_group.cg_item);
1416 pr_warn("configfs_depend_item() failed: %d\n", ret);
1418 mutex_unlock(&tpg->tv_tpg_mutex);
1421 tpg->tv_tpg_vhost_count++;
1422 tpg->vhost_scsi = vs;
1423 vs_tpg[tpg->tport_tpgt] = tpg;
1424 smp_mb__after_atomic();
1427 mutex_unlock(&tpg->tv_tpg_mutex);
1431 memcpy(vs->vs_vhost_wwpn, t->vhost_wwpn,
1432 sizeof(vs->vs_vhost_wwpn));
1433 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1434 vq = &vs->vqs[i].vq;
1435 mutex_lock(&vq->mutex);
1436 vq->private_data = vs_tpg;
1437 vhost_init_used(vq);
1438 mutex_unlock(&vq->mutex);
1446 * Act as synchronize_rcu to make sure access to
1447 * old vs->vs_tpg is finished.
1449 vhost_scsi_flush(vs);
1451 vs->vs_tpg = vs_tpg;
1454 mutex_unlock(&vs->dev.mutex);
1455 mutex_unlock(&vhost_scsi_mutex);
1460 vhost_scsi_clear_endpoint(struct vhost_scsi *vs,
1461 struct vhost_scsi_target *t)
1463 struct se_portal_group *se_tpg;
1464 struct vhost_scsi_tport *tv_tport;
1465 struct vhost_scsi_tpg *tpg;
1466 struct vhost_virtqueue *vq;
1471 mutex_lock(&vhost_scsi_mutex);
1472 mutex_lock(&vs->dev.mutex);
1473 /* Verify that ring has been setup correctly. */
1474 for (index = 0; index < vs->dev.nvqs; ++index) {
1475 if (!vhost_vq_access_ok(&vs->vqs[index].vq)) {
1486 for (i = 0; i < VHOST_SCSI_MAX_TARGET; i++) {
1488 tpg = vs->vs_tpg[target];
1492 mutex_lock(&tpg->tv_tpg_mutex);
1493 tv_tport = tpg->tport;
1499 if (strcmp(tv_tport->tport_name, t->vhost_wwpn)) {
1500 pr_warn("tv_tport->tport_name: %s, tpg->tport_tpgt: %hu"
1501 " does not match t->vhost_wwpn: %s, t->vhost_tpgt: %hu\n",
1502 tv_tport->tport_name, tpg->tport_tpgt,
1503 t->vhost_wwpn, t->vhost_tpgt);
1507 tpg->tv_tpg_vhost_count--;
1508 tpg->vhost_scsi = NULL;
1509 vs->vs_tpg[target] = NULL;
1511 mutex_unlock(&tpg->tv_tpg_mutex);
1513 * Release se_tpg->tpg_group.cg_item configfs dependency now
1514 * to allow vhost-scsi WWPN se_tpg->tpg_group shutdown to occur.
1516 se_tpg = &tpg->se_tpg;
1517 configfs_undepend_item(se_tpg->se_tpg_tfo->tf_subsys,
1518 &se_tpg->tpg_group.cg_item);
1521 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1522 vq = &vs->vqs[i].vq;
1523 mutex_lock(&vq->mutex);
1524 vq->private_data = NULL;
1525 mutex_unlock(&vq->mutex);
1529 * Act as synchronize_rcu to make sure access to
1530 * old vs->vs_tpg is finished.
1532 vhost_scsi_flush(vs);
1535 WARN_ON(vs->vs_events_nr);
1536 mutex_unlock(&vs->dev.mutex);
1537 mutex_unlock(&vhost_scsi_mutex);
1541 mutex_unlock(&tpg->tv_tpg_mutex);
1543 mutex_unlock(&vs->dev.mutex);
1544 mutex_unlock(&vhost_scsi_mutex);
1548 static int vhost_scsi_set_features(struct vhost_scsi *vs, u64 features)
1550 struct vhost_virtqueue *vq;
1553 if (features & ~VHOST_SCSI_FEATURES)
1556 mutex_lock(&vs->dev.mutex);
1557 if ((features & (1 << VHOST_F_LOG_ALL)) &&
1558 !vhost_log_access_ok(&vs->dev)) {
1559 mutex_unlock(&vs->dev.mutex);
1563 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1564 vq = &vs->vqs[i].vq;
1565 mutex_lock(&vq->mutex);
1566 vq->acked_features = features;
1567 mutex_unlock(&vq->mutex);
1569 mutex_unlock(&vs->dev.mutex);
1573 static int vhost_scsi_open(struct inode *inode, struct file *f)
1575 struct vhost_scsi *vs;
1576 struct vhost_virtqueue **vqs;
1579 vs = kzalloc(sizeof(*vs), GFP_KERNEL | __GFP_NOWARN | __GFP_REPEAT);
1581 vs = vzalloc(sizeof(*vs));
1586 vqs = kmalloc(VHOST_SCSI_MAX_VQ * sizeof(*vqs), GFP_KERNEL);
1590 vhost_work_init(&vs->vs_completion_work, vhost_scsi_complete_cmd_work);
1591 vhost_work_init(&vs->vs_event_work, vhost_scsi_evt_work);
1593 vs->vs_events_nr = 0;
1594 vs->vs_events_missed = false;
1596 vqs[VHOST_SCSI_VQ_CTL] = &vs->vqs[VHOST_SCSI_VQ_CTL].vq;
1597 vqs[VHOST_SCSI_VQ_EVT] = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1598 vs->vqs[VHOST_SCSI_VQ_CTL].vq.handle_kick = vhost_scsi_ctl_handle_kick;
1599 vs->vqs[VHOST_SCSI_VQ_EVT].vq.handle_kick = vhost_scsi_evt_handle_kick;
1600 for (i = VHOST_SCSI_VQ_IO; i < VHOST_SCSI_MAX_VQ; i++) {
1601 vqs[i] = &vs->vqs[i].vq;
1602 vs->vqs[i].vq.handle_kick = vhost_scsi_handle_kick;
1604 vhost_dev_init(&vs->dev, vqs, VHOST_SCSI_MAX_VQ);
1606 vhost_scsi_init_inflight(vs, NULL);
1608 f->private_data = vs;
1617 static int vhost_scsi_release(struct inode *inode, struct file *f)
1619 struct vhost_scsi *vs = f->private_data;
1620 struct vhost_scsi_target t;
1622 mutex_lock(&vs->dev.mutex);
1623 memcpy(t.vhost_wwpn, vs->vs_vhost_wwpn, sizeof(t.vhost_wwpn));
1624 mutex_unlock(&vs->dev.mutex);
1625 vhost_scsi_clear_endpoint(vs, &t);
1626 vhost_dev_stop(&vs->dev);
1627 vhost_dev_cleanup(&vs->dev, false);
1628 /* Jobs can re-queue themselves in evt kick handler. Do extra flush. */
1629 vhost_scsi_flush(vs);
1636 vhost_scsi_ioctl(struct file *f,
1640 struct vhost_scsi *vs = f->private_data;
1641 struct vhost_scsi_target backend;
1642 void __user *argp = (void __user *)arg;
1643 u64 __user *featurep = argp;
1644 u32 __user *eventsp = argp;
1647 int r, abi_version = VHOST_SCSI_ABI_VERSION;
1648 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1651 case VHOST_SCSI_SET_ENDPOINT:
1652 if (copy_from_user(&backend, argp, sizeof backend))
1654 if (backend.reserved != 0)
1657 return vhost_scsi_set_endpoint(vs, &backend);
1658 case VHOST_SCSI_CLEAR_ENDPOINT:
1659 if (copy_from_user(&backend, argp, sizeof backend))
1661 if (backend.reserved != 0)
1664 return vhost_scsi_clear_endpoint(vs, &backend);
1665 case VHOST_SCSI_GET_ABI_VERSION:
1666 if (copy_to_user(argp, &abi_version, sizeof abi_version))
1669 case VHOST_SCSI_SET_EVENTS_MISSED:
1670 if (get_user(events_missed, eventsp))
1672 mutex_lock(&vq->mutex);
1673 vs->vs_events_missed = events_missed;
1674 mutex_unlock(&vq->mutex);
1676 case VHOST_SCSI_GET_EVENTS_MISSED:
1677 mutex_lock(&vq->mutex);
1678 events_missed = vs->vs_events_missed;
1679 mutex_unlock(&vq->mutex);
1680 if (put_user(events_missed, eventsp))
1683 case VHOST_GET_FEATURES:
1684 features = VHOST_SCSI_FEATURES;
1685 if (copy_to_user(featurep, &features, sizeof features))
1688 case VHOST_SET_FEATURES:
1689 if (copy_from_user(&features, featurep, sizeof features))
1691 return vhost_scsi_set_features(vs, features);
1693 mutex_lock(&vs->dev.mutex);
1694 r = vhost_dev_ioctl(&vs->dev, ioctl, argp);
1695 /* TODO: flush backend after dev ioctl. */
1696 if (r == -ENOIOCTLCMD)
1697 r = vhost_vring_ioctl(&vs->dev, ioctl, argp);
1698 mutex_unlock(&vs->dev.mutex);
1703 #ifdef CONFIG_COMPAT
1704 static long vhost_scsi_compat_ioctl(struct file *f, unsigned int ioctl,
1707 return vhost_scsi_ioctl(f, ioctl, (unsigned long)compat_ptr(arg));
1711 static const struct file_operations vhost_scsi_fops = {
1712 .owner = THIS_MODULE,
1713 .release = vhost_scsi_release,
1714 .unlocked_ioctl = vhost_scsi_ioctl,
1715 #ifdef CONFIG_COMPAT
1716 .compat_ioctl = vhost_scsi_compat_ioctl,
1718 .open = vhost_scsi_open,
1719 .llseek = noop_llseek,
1722 static struct miscdevice vhost_scsi_misc = {
1728 static int __init vhost_scsi_register(void)
1730 return misc_register(&vhost_scsi_misc);
1733 static int vhost_scsi_deregister(void)
1735 return misc_deregister(&vhost_scsi_misc);
1738 static char *vhost_scsi_dump_proto_id(struct vhost_scsi_tport *tport)
1740 switch (tport->tport_proto_id) {
1741 case SCSI_PROTOCOL_SAS:
1743 case SCSI_PROTOCOL_FCP:
1745 case SCSI_PROTOCOL_ISCSI:
1755 vhost_scsi_do_plug(struct vhost_scsi_tpg *tpg,
1756 struct se_lun *lun, bool plug)
1759 struct vhost_scsi *vs = tpg->vhost_scsi;
1760 struct vhost_virtqueue *vq;
1766 mutex_lock(&vs->dev.mutex);
1769 reason = VIRTIO_SCSI_EVT_RESET_RESCAN;
1771 reason = VIRTIO_SCSI_EVT_RESET_REMOVED;
1773 vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1774 mutex_lock(&vq->mutex);
1775 if (vhost_has_feature(vq, VIRTIO_SCSI_F_HOTPLUG))
1776 vhost_scsi_send_evt(vs, tpg, lun,
1777 VIRTIO_SCSI_T_TRANSPORT_RESET, reason);
1778 mutex_unlock(&vq->mutex);
1779 mutex_unlock(&vs->dev.mutex);
1782 static void vhost_scsi_hotplug(struct vhost_scsi_tpg *tpg, struct se_lun *lun)
1784 vhost_scsi_do_plug(tpg, lun, true);
1787 static void vhost_scsi_hotunplug(struct vhost_scsi_tpg *tpg, struct se_lun *lun)
1789 vhost_scsi_do_plug(tpg, lun, false);
1792 static int vhost_scsi_port_link(struct se_portal_group *se_tpg,
1795 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1796 struct vhost_scsi_tpg, se_tpg);
1798 mutex_lock(&vhost_scsi_mutex);
1800 mutex_lock(&tpg->tv_tpg_mutex);
1801 tpg->tv_tpg_port_count++;
1802 mutex_unlock(&tpg->tv_tpg_mutex);
1804 vhost_scsi_hotplug(tpg, lun);
1806 mutex_unlock(&vhost_scsi_mutex);
1811 static void vhost_scsi_port_unlink(struct se_portal_group *se_tpg,
1814 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1815 struct vhost_scsi_tpg, se_tpg);
1817 mutex_lock(&vhost_scsi_mutex);
1819 mutex_lock(&tpg->tv_tpg_mutex);
1820 tpg->tv_tpg_port_count--;
1821 mutex_unlock(&tpg->tv_tpg_mutex);
1823 vhost_scsi_hotunplug(tpg, lun);
1825 mutex_unlock(&vhost_scsi_mutex);
1828 static struct se_node_acl *
1829 vhost_scsi_make_nodeacl(struct se_portal_group *se_tpg,
1830 struct config_group *group,
1833 struct se_node_acl *se_nacl, *se_nacl_new;
1834 struct vhost_scsi_nacl *nacl;
1838 /* vhost_scsi_parse_wwn(name, &wwpn, 1) < 0)
1839 return ERR_PTR(-EINVAL); */
1840 se_nacl_new = vhost_scsi_alloc_fabric_acl(se_tpg);
1842 return ERR_PTR(-ENOMEM);
1846 * se_nacl_new may be released by core_tpg_add_initiator_node_acl()
1847 * when converting a NodeACL from demo mode -> explict
1849 se_nacl = core_tpg_add_initiator_node_acl(se_tpg, se_nacl_new,
1851 if (IS_ERR(se_nacl)) {
1852 vhost_scsi_release_fabric_acl(se_tpg, se_nacl_new);
1856 * Locate our struct vhost_scsi_nacl and set the FC Nport WWPN
1858 nacl = container_of(se_nacl, struct vhost_scsi_nacl, se_node_acl);
1859 nacl->iport_wwpn = wwpn;
1864 static void vhost_scsi_drop_nodeacl(struct se_node_acl *se_acl)
1866 struct vhost_scsi_nacl *nacl = container_of(se_acl,
1867 struct vhost_scsi_nacl, se_node_acl);
1868 core_tpg_del_initiator_node_acl(se_acl->se_tpg, se_acl, 1);
1872 static void vhost_scsi_free_cmd_map_res(struct vhost_scsi_nexus *nexus,
1873 struct se_session *se_sess)
1875 struct vhost_scsi_cmd *tv_cmd;
1878 if (!se_sess->sess_cmd_map)
1881 for (i = 0; i < VHOST_SCSI_DEFAULT_TAGS; i++) {
1882 tv_cmd = &((struct vhost_scsi_cmd *)se_sess->sess_cmd_map)[i];
1884 kfree(tv_cmd->tvc_sgl);
1885 kfree(tv_cmd->tvc_prot_sgl);
1886 kfree(tv_cmd->tvc_upages);
1890 static ssize_t vhost_scsi_tpg_attrib_store_fabric_prot_type(
1891 struct se_portal_group *se_tpg,
1895 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1896 struct vhost_scsi_tpg, se_tpg);
1898 int ret = kstrtoul(page, 0, &val);
1901 pr_err("kstrtoul() returned %d for fabric_prot_type\n", ret);
1904 if (val != 0 && val != 1 && val != 3) {
1905 pr_err("Invalid vhost_scsi fabric_prot_type: %lu\n", val);
1908 tpg->tv_fabric_prot_type = val;
1913 static ssize_t vhost_scsi_tpg_attrib_show_fabric_prot_type(
1914 struct se_portal_group *se_tpg,
1917 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1918 struct vhost_scsi_tpg, se_tpg);
1920 return sprintf(page, "%d\n", tpg->tv_fabric_prot_type);
1922 TF_TPG_ATTRIB_ATTR(vhost_scsi, fabric_prot_type, S_IRUGO | S_IWUSR);
1924 static struct configfs_attribute *vhost_scsi_tpg_attrib_attrs[] = {
1925 &vhost_scsi_tpg_attrib_fabric_prot_type.attr,
1929 static int vhost_scsi_make_nexus(struct vhost_scsi_tpg *tpg,
1932 struct se_portal_group *se_tpg;
1933 struct se_session *se_sess;
1934 struct vhost_scsi_nexus *tv_nexus;
1935 struct vhost_scsi_cmd *tv_cmd;
1938 mutex_lock(&tpg->tv_tpg_mutex);
1939 if (tpg->tpg_nexus) {
1940 mutex_unlock(&tpg->tv_tpg_mutex);
1941 pr_debug("tpg->tpg_nexus already exists\n");
1944 se_tpg = &tpg->se_tpg;
1946 tv_nexus = kzalloc(sizeof(struct vhost_scsi_nexus), GFP_KERNEL);
1948 mutex_unlock(&tpg->tv_tpg_mutex);
1949 pr_err("Unable to allocate struct vhost_scsi_nexus\n");
1953 * Initialize the struct se_session pointer and setup tagpool
1954 * for struct vhost_scsi_cmd descriptors
1956 tv_nexus->tvn_se_sess = transport_init_session_tags(
1957 VHOST_SCSI_DEFAULT_TAGS,
1958 sizeof(struct vhost_scsi_cmd),
1959 TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS);
1960 if (IS_ERR(tv_nexus->tvn_se_sess)) {
1961 mutex_unlock(&tpg->tv_tpg_mutex);
1965 se_sess = tv_nexus->tvn_se_sess;
1966 for (i = 0; i < VHOST_SCSI_DEFAULT_TAGS; i++) {
1967 tv_cmd = &((struct vhost_scsi_cmd *)se_sess->sess_cmd_map)[i];
1969 tv_cmd->tvc_sgl = kzalloc(sizeof(struct scatterlist) *
1970 VHOST_SCSI_PREALLOC_SGLS, GFP_KERNEL);
1971 if (!tv_cmd->tvc_sgl) {
1972 mutex_unlock(&tpg->tv_tpg_mutex);
1973 pr_err("Unable to allocate tv_cmd->tvc_sgl\n");
1977 tv_cmd->tvc_upages = kzalloc(sizeof(struct page *) *
1978 VHOST_SCSI_PREALLOC_UPAGES, GFP_KERNEL);
1979 if (!tv_cmd->tvc_upages) {
1980 mutex_unlock(&tpg->tv_tpg_mutex);
1981 pr_err("Unable to allocate tv_cmd->tvc_upages\n");
1985 tv_cmd->tvc_prot_sgl = kzalloc(sizeof(struct scatterlist) *
1986 VHOST_SCSI_PREALLOC_PROT_SGLS, GFP_KERNEL);
1987 if (!tv_cmd->tvc_prot_sgl) {
1988 mutex_unlock(&tpg->tv_tpg_mutex);
1989 pr_err("Unable to allocate tv_cmd->tvc_prot_sgl\n");
1994 * Since we are running in 'demo mode' this call with generate a
1995 * struct se_node_acl for the vhost_scsi struct se_portal_group with
1996 * the SCSI Initiator port name of the passed configfs group 'name'.
1998 tv_nexus->tvn_se_sess->se_node_acl = core_tpg_check_initiator_node_acl(
1999 se_tpg, (unsigned char *)name);
2000 if (!tv_nexus->tvn_se_sess->se_node_acl) {
2001 mutex_unlock(&tpg->tv_tpg_mutex);
2002 pr_debug("core_tpg_check_initiator_node_acl() failed"
2007 * Now register the TCM vhost virtual I_T Nexus as active.
2009 transport_register_session(se_tpg, tv_nexus->tvn_se_sess->se_node_acl,
2010 tv_nexus->tvn_se_sess, tv_nexus);
2011 tpg->tpg_nexus = tv_nexus;
2013 mutex_unlock(&tpg->tv_tpg_mutex);
2017 vhost_scsi_free_cmd_map_res(tv_nexus, se_sess);
2018 transport_free_session(se_sess);
2023 static int vhost_scsi_drop_nexus(struct vhost_scsi_tpg *tpg)
2025 struct se_session *se_sess;
2026 struct vhost_scsi_nexus *tv_nexus;
2028 mutex_lock(&tpg->tv_tpg_mutex);
2029 tv_nexus = tpg->tpg_nexus;
2031 mutex_unlock(&tpg->tv_tpg_mutex);
2035 se_sess = tv_nexus->tvn_se_sess;
2037 mutex_unlock(&tpg->tv_tpg_mutex);
2041 if (tpg->tv_tpg_port_count != 0) {
2042 mutex_unlock(&tpg->tv_tpg_mutex);
2043 pr_err("Unable to remove TCM_vhost I_T Nexus with"
2044 " active TPG port count: %d\n",
2045 tpg->tv_tpg_port_count);
2049 if (tpg->tv_tpg_vhost_count != 0) {
2050 mutex_unlock(&tpg->tv_tpg_mutex);
2051 pr_err("Unable to remove TCM_vhost I_T Nexus with"
2052 " active TPG vhost count: %d\n",
2053 tpg->tv_tpg_vhost_count);
2057 pr_debug("TCM_vhost_ConfigFS: Removing I_T Nexus to emulated"
2058 " %s Initiator Port: %s\n", vhost_scsi_dump_proto_id(tpg->tport),
2059 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
2061 vhost_scsi_free_cmd_map_res(tv_nexus, se_sess);
2063 * Release the SCSI I_T Nexus to the emulated vhost Target Port
2065 transport_deregister_session(tv_nexus->tvn_se_sess);
2066 tpg->tpg_nexus = NULL;
2067 mutex_unlock(&tpg->tv_tpg_mutex);
2073 static ssize_t vhost_scsi_tpg_show_nexus(struct se_portal_group *se_tpg,
2076 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
2077 struct vhost_scsi_tpg, se_tpg);
2078 struct vhost_scsi_nexus *tv_nexus;
2081 mutex_lock(&tpg->tv_tpg_mutex);
2082 tv_nexus = tpg->tpg_nexus;
2084 mutex_unlock(&tpg->tv_tpg_mutex);
2087 ret = snprintf(page, PAGE_SIZE, "%s\n",
2088 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
2089 mutex_unlock(&tpg->tv_tpg_mutex);
2094 static ssize_t vhost_scsi_tpg_store_nexus(struct se_portal_group *se_tpg,
2098 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
2099 struct vhost_scsi_tpg, se_tpg);
2100 struct vhost_scsi_tport *tport_wwn = tpg->tport;
2101 unsigned char i_port[VHOST_SCSI_NAMELEN], *ptr, *port_ptr;
2104 * Shutdown the active I_T nexus if 'NULL' is passed..
2106 if (!strncmp(page, "NULL", 4)) {
2107 ret = vhost_scsi_drop_nexus(tpg);
2108 return (!ret) ? count : ret;
2111 * Otherwise make sure the passed virtual Initiator port WWN matches
2112 * the fabric protocol_id set in vhost_scsi_make_tport(), and call
2113 * vhost_scsi_make_nexus().
2115 if (strlen(page) >= VHOST_SCSI_NAMELEN) {
2116 pr_err("Emulated NAA Sas Address: %s, exceeds"
2117 " max: %d\n", page, VHOST_SCSI_NAMELEN);
2120 snprintf(&i_port[0], VHOST_SCSI_NAMELEN, "%s", page);
2122 ptr = strstr(i_port, "naa.");
2124 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_SAS) {
2125 pr_err("Passed SAS Initiator Port %s does not"
2126 " match target port protoid: %s\n", i_port,
2127 vhost_scsi_dump_proto_id(tport_wwn));
2130 port_ptr = &i_port[0];
2133 ptr = strstr(i_port, "fc.");
2135 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_FCP) {
2136 pr_err("Passed FCP Initiator Port %s does not"
2137 " match target port protoid: %s\n", i_port,
2138 vhost_scsi_dump_proto_id(tport_wwn));
2141 port_ptr = &i_port[3]; /* Skip over "fc." */
2144 ptr = strstr(i_port, "iqn.");
2146 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_ISCSI) {
2147 pr_err("Passed iSCSI Initiator Port %s does not"
2148 " match target port protoid: %s\n", i_port,
2149 vhost_scsi_dump_proto_id(tport_wwn));
2152 port_ptr = &i_port[0];
2155 pr_err("Unable to locate prefix for emulated Initiator Port:"
2159 * Clear any trailing newline for the NAA WWN
2162 if (i_port[strlen(i_port)-1] == '\n')
2163 i_port[strlen(i_port)-1] = '\0';
2165 ret = vhost_scsi_make_nexus(tpg, port_ptr);
2172 TF_TPG_BASE_ATTR(vhost_scsi, nexus, S_IRUGO | S_IWUSR);
2174 static struct configfs_attribute *vhost_scsi_tpg_attrs[] = {
2175 &vhost_scsi_tpg_nexus.attr,
2179 static struct se_portal_group *
2180 vhost_scsi_make_tpg(struct se_wwn *wwn,
2181 struct config_group *group,
2184 struct vhost_scsi_tport *tport = container_of(wwn,
2185 struct vhost_scsi_tport, tport_wwn);
2187 struct vhost_scsi_tpg *tpg;
2191 if (strstr(name, "tpgt_") != name)
2192 return ERR_PTR(-EINVAL);
2193 if (kstrtou16(name + 5, 10, &tpgt) || tpgt >= VHOST_SCSI_MAX_TARGET)
2194 return ERR_PTR(-EINVAL);
2196 tpg = kzalloc(sizeof(struct vhost_scsi_tpg), GFP_KERNEL);
2198 pr_err("Unable to allocate struct vhost_scsi_tpg");
2199 return ERR_PTR(-ENOMEM);
2201 mutex_init(&tpg->tv_tpg_mutex);
2202 INIT_LIST_HEAD(&tpg->tv_tpg_list);
2204 tpg->tport_tpgt = tpgt;
2206 ret = core_tpg_register(&vhost_scsi_ops, wwn,
2207 &tpg->se_tpg, tpg, TRANSPORT_TPG_TYPE_NORMAL);
2212 mutex_lock(&vhost_scsi_mutex);
2213 list_add_tail(&tpg->tv_tpg_list, &vhost_scsi_list);
2214 mutex_unlock(&vhost_scsi_mutex);
2216 return &tpg->se_tpg;
2219 static void vhost_scsi_drop_tpg(struct se_portal_group *se_tpg)
2221 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
2222 struct vhost_scsi_tpg, se_tpg);
2224 mutex_lock(&vhost_scsi_mutex);
2225 list_del(&tpg->tv_tpg_list);
2226 mutex_unlock(&vhost_scsi_mutex);
2228 * Release the virtual I_T Nexus for this vhost TPG
2230 vhost_scsi_drop_nexus(tpg);
2232 * Deregister the se_tpg from TCM..
2234 core_tpg_deregister(se_tpg);
2238 static struct se_wwn *
2239 vhost_scsi_make_tport(struct target_fabric_configfs *tf,
2240 struct config_group *group,
2243 struct vhost_scsi_tport *tport;
2248 /* if (vhost_scsi_parse_wwn(name, &wwpn, 1) < 0)
2249 return ERR_PTR(-EINVAL); */
2251 tport = kzalloc(sizeof(struct vhost_scsi_tport), GFP_KERNEL);
2253 pr_err("Unable to allocate struct vhost_scsi_tport");
2254 return ERR_PTR(-ENOMEM);
2256 tport->tport_wwpn = wwpn;
2258 * Determine the emulated Protocol Identifier and Target Port Name
2259 * based on the incoming configfs directory name.
2261 ptr = strstr(name, "naa.");
2263 tport->tport_proto_id = SCSI_PROTOCOL_SAS;
2266 ptr = strstr(name, "fc.");
2268 tport->tport_proto_id = SCSI_PROTOCOL_FCP;
2269 off = 3; /* Skip over "fc." */
2272 ptr = strstr(name, "iqn.");
2274 tport->tport_proto_id = SCSI_PROTOCOL_ISCSI;
2278 pr_err("Unable to locate prefix for emulated Target Port:"
2281 return ERR_PTR(-EINVAL);
2284 if (strlen(name) >= VHOST_SCSI_NAMELEN) {
2285 pr_err("Emulated %s Address: %s, exceeds"
2286 " max: %d\n", name, vhost_scsi_dump_proto_id(tport),
2287 VHOST_SCSI_NAMELEN);
2289 return ERR_PTR(-EINVAL);
2291 snprintf(&tport->tport_name[0], VHOST_SCSI_NAMELEN, "%s", &name[off]);
2293 pr_debug("TCM_VHost_ConfigFS: Allocated emulated Target"
2294 " %s Address: %s\n", vhost_scsi_dump_proto_id(tport), name);
2296 return &tport->tport_wwn;
2299 static void vhost_scsi_drop_tport(struct se_wwn *wwn)
2301 struct vhost_scsi_tport *tport = container_of(wwn,
2302 struct vhost_scsi_tport, tport_wwn);
2304 pr_debug("TCM_VHost_ConfigFS: Deallocating emulated Target"
2305 " %s Address: %s\n", vhost_scsi_dump_proto_id(tport),
2312 vhost_scsi_wwn_show_attr_version(struct target_fabric_configfs *tf,
2315 return sprintf(page, "TCM_VHOST fabric module %s on %s/%s"
2316 "on "UTS_RELEASE"\n", VHOST_SCSI_VERSION, utsname()->sysname,
2317 utsname()->machine);
2320 TF_WWN_ATTR_RO(vhost_scsi, version);
2322 static struct configfs_attribute *vhost_scsi_wwn_attrs[] = {
2323 &vhost_scsi_wwn_version.attr,
2327 static struct target_core_fabric_ops vhost_scsi_ops = {
2328 .module = THIS_MODULE,
2330 .get_fabric_name = vhost_scsi_get_fabric_name,
2331 .get_fabric_proto_ident = vhost_scsi_get_fabric_proto_ident,
2332 .tpg_get_wwn = vhost_scsi_get_fabric_wwn,
2333 .tpg_get_tag = vhost_scsi_get_tpgt,
2334 .tpg_get_default_depth = vhost_scsi_get_default_depth,
2335 .tpg_get_pr_transport_id = vhost_scsi_get_pr_transport_id,
2336 .tpg_get_pr_transport_id_len = vhost_scsi_get_pr_transport_id_len,
2337 .tpg_parse_pr_out_transport_id = vhost_scsi_parse_pr_out_transport_id,
2338 .tpg_check_demo_mode = vhost_scsi_check_true,
2339 .tpg_check_demo_mode_cache = vhost_scsi_check_true,
2340 .tpg_check_demo_mode_write_protect = vhost_scsi_check_false,
2341 .tpg_check_prod_mode_write_protect = vhost_scsi_check_false,
2342 .tpg_check_prot_fabric_only = vhost_scsi_check_prot_fabric_only,
2343 .tpg_alloc_fabric_acl = vhost_scsi_alloc_fabric_acl,
2344 .tpg_release_fabric_acl = vhost_scsi_release_fabric_acl,
2345 .tpg_get_inst_index = vhost_scsi_tpg_get_inst_index,
2346 .release_cmd = vhost_scsi_release_cmd,
2347 .check_stop_free = vhost_scsi_check_stop_free,
2348 .shutdown_session = vhost_scsi_shutdown_session,
2349 .close_session = vhost_scsi_close_session,
2350 .sess_get_index = vhost_scsi_sess_get_index,
2351 .sess_get_initiator_sid = NULL,
2352 .write_pending = vhost_scsi_write_pending,
2353 .write_pending_status = vhost_scsi_write_pending_status,
2354 .set_default_node_attributes = vhost_scsi_set_default_node_attrs,
2355 .get_task_tag = vhost_scsi_get_task_tag,
2356 .get_cmd_state = vhost_scsi_get_cmd_state,
2357 .queue_data_in = vhost_scsi_queue_data_in,
2358 .queue_status = vhost_scsi_queue_status,
2359 .queue_tm_rsp = vhost_scsi_queue_tm_rsp,
2360 .aborted_task = vhost_scsi_aborted_task,
2362 * Setup callers for generic logic in target_core_fabric_configfs.c
2364 .fabric_make_wwn = vhost_scsi_make_tport,
2365 .fabric_drop_wwn = vhost_scsi_drop_tport,
2366 .fabric_make_tpg = vhost_scsi_make_tpg,
2367 .fabric_drop_tpg = vhost_scsi_drop_tpg,
2368 .fabric_post_link = vhost_scsi_port_link,
2369 .fabric_pre_unlink = vhost_scsi_port_unlink,
2370 .fabric_make_np = NULL,
2371 .fabric_drop_np = NULL,
2372 .fabric_make_nodeacl = vhost_scsi_make_nodeacl,
2373 .fabric_drop_nodeacl = vhost_scsi_drop_nodeacl,
2375 .tfc_wwn_attrs = vhost_scsi_wwn_attrs,
2376 .tfc_tpg_base_attrs = vhost_scsi_tpg_attrs,
2377 .tfc_tpg_attrib_attrs = vhost_scsi_tpg_attrib_attrs,
2380 static int __init vhost_scsi_init(void)
2384 pr_debug("TCM_VHOST fabric module %s on %s/%s"
2385 " on "UTS_RELEASE"\n", VHOST_SCSI_VERSION, utsname()->sysname,
2386 utsname()->machine);
2389 * Use our own dedicated workqueue for submitting I/O into
2390 * target core to avoid contention within system_wq.
2392 vhost_scsi_workqueue = alloc_workqueue("vhost_scsi", 0, 0);
2393 if (!vhost_scsi_workqueue)
2396 ret = vhost_scsi_register();
2398 goto out_destroy_workqueue;
2400 ret = target_register_template(&vhost_scsi_ops);
2402 goto out_vhost_scsi_deregister;
2406 out_vhost_scsi_deregister:
2407 vhost_scsi_deregister();
2408 out_destroy_workqueue:
2409 destroy_workqueue(vhost_scsi_workqueue);
2414 static void vhost_scsi_exit(void)
2416 target_unregister_template(&vhost_scsi_ops);
2417 vhost_scsi_deregister();
2418 destroy_workqueue(vhost_scsi_workqueue);
2421 MODULE_DESCRIPTION("VHOST_SCSI series fabric driver");
2422 MODULE_ALIAS("tcm_vhost");
2423 MODULE_LICENSE("GPL");
2424 module_init(vhost_scsi_init);
2425 module_exit(vhost_scsi_exit);