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/vmalloc.h>
39 #include <linux/miscdevice.h>
40 #include <asm/unaligned.h>
41 #include <scsi/scsi_common.h>
42 #include <scsi/scsi_proto.h>
43 #include <target/target_core_base.h>
44 #include <target/target_core_fabric.h>
45 #include <target/target_core_fabric_configfs.h>
46 #include <target/target_core_configfs.h>
47 #include <target/configfs_macros.h>
48 #include <linux/vhost.h>
49 #include <linux/virtio_scsi.h>
50 #include <linux/llist.h>
51 #include <linux/bitmap.h>
52 #include <linux/percpu_ida.h>
56 #define VHOST_SCSI_VERSION "v0.1"
57 #define VHOST_SCSI_NAMELEN 256
58 #define VHOST_SCSI_MAX_CDB_SIZE 32
59 #define VHOST_SCSI_DEFAULT_TAGS 256
60 #define VHOST_SCSI_PREALLOC_SGLS 2048
61 #define VHOST_SCSI_PREALLOC_UPAGES 2048
62 #define VHOST_SCSI_PREALLOC_PROT_SGLS 512
64 struct vhost_scsi_inflight {
65 /* Wait for the flush operation to finish */
66 struct completion comp;
67 /* Refcount for the inflight reqs */
71 struct vhost_scsi_cmd {
72 /* Descriptor from vhost_get_vq_desc() for virt_queue segment */
74 /* virtio-scsi initiator task attribute */
76 /* virtio-scsi response incoming iovecs */
78 /* virtio-scsi initiator data direction */
79 enum dma_data_direction tvc_data_direction;
80 /* Expected data transfer length from virtio-scsi header */
82 /* The Tag from include/linux/virtio_scsi.h:struct virtio_scsi_cmd_req */
84 /* The number of scatterlists associated with this cmd */
86 u32 tvc_prot_sgl_count;
87 /* Saved unpacked SCSI LUN for vhost_scsi_submission_work() */
89 /* Pointer to the SGL formatted memory from virtio-scsi */
90 struct scatterlist *tvc_sgl;
91 struct scatterlist *tvc_prot_sgl;
92 struct page **tvc_upages;
93 /* Pointer to response header iovec */
94 struct iovec *tvc_resp_iov;
95 /* Pointer to vhost_scsi for our device */
96 struct vhost_scsi *tvc_vhost;
97 /* Pointer to vhost_virtqueue for the cmd */
98 struct vhost_virtqueue *tvc_vq;
99 /* Pointer to vhost nexus memory */
100 struct vhost_scsi_nexus *tvc_nexus;
101 /* The TCM I/O descriptor that is accessed via container_of() */
102 struct se_cmd tvc_se_cmd;
103 /* work item used for cmwq dispatch to vhost_scsi_submission_work() */
104 struct work_struct work;
105 /* Copy of the incoming SCSI command descriptor block (CDB) */
106 unsigned char tvc_cdb[VHOST_SCSI_MAX_CDB_SIZE];
107 /* Sense buffer that will be mapped into outgoing status */
108 unsigned char tvc_sense_buf[TRANSPORT_SENSE_BUFFER];
109 /* Completed commands list, serviced from vhost worker thread */
110 struct llist_node tvc_completion_list;
111 /* Used to track inflight cmd */
112 struct vhost_scsi_inflight *inflight;
115 struct vhost_scsi_nexus {
116 /* Pointer to TCM session for I_T Nexus */
117 struct se_session *tvn_se_sess;
120 struct vhost_scsi_nacl {
121 /* Binary World Wide unique Port Name for Vhost Initiator port */
123 /* ASCII formatted WWPN for Sas Initiator port */
124 char iport_name[VHOST_SCSI_NAMELEN];
125 /* Returned by vhost_scsi_make_nodeacl() */
126 struct se_node_acl se_node_acl;
129 struct vhost_scsi_tpg {
130 /* Vhost port target portal group tag for TCM */
132 /* Used to track number of TPG Port/Lun Links wrt to explict I_T Nexus shutdown */
133 int tv_tpg_port_count;
134 /* Used for vhost_scsi device reference to tpg_nexus, protected by tv_tpg_mutex */
135 int tv_tpg_vhost_count;
136 /* Used for enabling T10-PI with legacy devices */
137 int tv_fabric_prot_type;
138 /* list for vhost_scsi_list */
139 struct list_head tv_tpg_list;
140 /* Used to protect access for tpg_nexus */
141 struct mutex tv_tpg_mutex;
142 /* Pointer to the TCM VHost I_T Nexus for this TPG endpoint */
143 struct vhost_scsi_nexus *tpg_nexus;
144 /* Pointer back to vhost_scsi_tport */
145 struct vhost_scsi_tport *tport;
146 /* Returned by vhost_scsi_make_tpg() */
147 struct se_portal_group se_tpg;
148 /* Pointer back to vhost_scsi, protected by tv_tpg_mutex */
149 struct vhost_scsi *vhost_scsi;
152 struct vhost_scsi_tport {
153 /* SCSI protocol the tport is providing */
155 /* Binary World Wide unique Port Name for Vhost Target port */
157 /* ASCII formatted WWPN for Vhost Target port */
158 char tport_name[VHOST_SCSI_NAMELEN];
159 /* Returned by vhost_scsi_make_tport() */
160 struct se_wwn tport_wwn;
163 struct vhost_scsi_evt {
164 /* event to be sent to guest */
165 struct virtio_scsi_event event;
166 /* event list, serviced from vhost worker thread */
167 struct llist_node list;
171 VHOST_SCSI_VQ_CTL = 0,
172 VHOST_SCSI_VQ_EVT = 1,
173 VHOST_SCSI_VQ_IO = 2,
176 /* Note: can't set VIRTIO_F_VERSION_1 yet, since that implies ANY_LAYOUT. */
178 VHOST_SCSI_FEATURES = VHOST_FEATURES | (1ULL << VIRTIO_SCSI_F_HOTPLUG) |
179 (1ULL << VIRTIO_SCSI_F_T10_PI) |
180 (1ULL << VIRTIO_F_ANY_LAYOUT) |
181 (1ULL << VIRTIO_F_VERSION_1)
184 #define VHOST_SCSI_MAX_TARGET 256
185 #define VHOST_SCSI_MAX_VQ 128
186 #define VHOST_SCSI_MAX_EVENT 128
188 struct vhost_scsi_virtqueue {
189 struct vhost_virtqueue vq;
191 * Reference counting for inflight reqs, used for flush operation. At
192 * each time, one reference tracks new commands submitted, while we
193 * wait for another one to reach 0.
195 struct vhost_scsi_inflight inflights[2];
197 * Indicate current inflight in use, protected by vq->mutex.
198 * Writers must also take dev mutex and flush under it.
204 /* Protected by vhost_scsi->dev.mutex */
205 struct vhost_scsi_tpg **vs_tpg;
206 char vs_vhost_wwpn[TRANSPORT_IQN_LEN];
208 struct vhost_dev dev;
209 struct vhost_scsi_virtqueue vqs[VHOST_SCSI_MAX_VQ];
211 struct vhost_work vs_completion_work; /* cmd completion work item */
212 struct llist_head vs_completion_list; /* cmd completion queue */
214 struct vhost_work vs_event_work; /* evt injection work item */
215 struct llist_head vs_event_list; /* evt injection queue */
217 bool vs_events_missed; /* any missed events, protected by vq->mutex */
218 int vs_events_nr; /* num of pending events, protected by vq->mutex */
221 static struct target_core_fabric_ops vhost_scsi_ops;
222 static struct workqueue_struct *vhost_scsi_workqueue;
224 /* Global spinlock to protect vhost_scsi TPG list for vhost IOCTL access */
225 static DEFINE_MUTEX(vhost_scsi_mutex);
226 static LIST_HEAD(vhost_scsi_list);
228 static int iov_num_pages(void __user *iov_base, size_t iov_len)
230 return (PAGE_ALIGN((unsigned long)iov_base + iov_len) -
231 ((unsigned long)iov_base & PAGE_MASK)) >> PAGE_SHIFT;
234 static void vhost_scsi_done_inflight(struct kref *kref)
236 struct vhost_scsi_inflight *inflight;
238 inflight = container_of(kref, struct vhost_scsi_inflight, kref);
239 complete(&inflight->comp);
242 static void vhost_scsi_init_inflight(struct vhost_scsi *vs,
243 struct vhost_scsi_inflight *old_inflight[])
245 struct vhost_scsi_inflight *new_inflight;
246 struct vhost_virtqueue *vq;
249 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
252 mutex_lock(&vq->mutex);
254 /* store old infight */
255 idx = vs->vqs[i].inflight_idx;
257 old_inflight[i] = &vs->vqs[i].inflights[idx];
259 /* setup new infight */
260 vs->vqs[i].inflight_idx = idx ^ 1;
261 new_inflight = &vs->vqs[i].inflights[idx ^ 1];
262 kref_init(&new_inflight->kref);
263 init_completion(&new_inflight->comp);
265 mutex_unlock(&vq->mutex);
269 static struct vhost_scsi_inflight *
270 vhost_scsi_get_inflight(struct vhost_virtqueue *vq)
272 struct vhost_scsi_inflight *inflight;
273 struct vhost_scsi_virtqueue *svq;
275 svq = container_of(vq, struct vhost_scsi_virtqueue, vq);
276 inflight = &svq->inflights[svq->inflight_idx];
277 kref_get(&inflight->kref);
282 static void vhost_scsi_put_inflight(struct vhost_scsi_inflight *inflight)
284 kref_put(&inflight->kref, vhost_scsi_done_inflight);
287 static int vhost_scsi_check_true(struct se_portal_group *se_tpg)
292 static int vhost_scsi_check_false(struct se_portal_group *se_tpg)
297 static char *vhost_scsi_get_fabric_name(void)
302 static u8 vhost_scsi_get_fabric_proto_ident(struct se_portal_group *se_tpg)
304 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
305 struct vhost_scsi_tpg, se_tpg);
306 struct vhost_scsi_tport *tport = tpg->tport;
308 switch (tport->tport_proto_id) {
309 case SCSI_PROTOCOL_SAS:
310 return sas_get_fabric_proto_ident(se_tpg);
311 case SCSI_PROTOCOL_FCP:
312 return fc_get_fabric_proto_ident(se_tpg);
313 case SCSI_PROTOCOL_ISCSI:
314 return iscsi_get_fabric_proto_ident(se_tpg);
316 pr_err("Unknown tport_proto_id: 0x%02x, using"
317 " SAS emulation\n", tport->tport_proto_id);
321 return sas_get_fabric_proto_ident(se_tpg);
324 static char *vhost_scsi_get_fabric_wwn(struct se_portal_group *se_tpg)
326 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
327 struct vhost_scsi_tpg, se_tpg);
328 struct vhost_scsi_tport *tport = tpg->tport;
330 return &tport->tport_name[0];
333 static u16 vhost_scsi_get_tpgt(struct se_portal_group *se_tpg)
335 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
336 struct vhost_scsi_tpg, se_tpg);
337 return tpg->tport_tpgt;
340 static u32 vhost_scsi_get_default_depth(struct se_portal_group *se_tpg)
346 vhost_scsi_get_pr_transport_id(struct se_portal_group *se_tpg,
347 struct se_node_acl *se_nacl,
348 struct t10_pr_registration *pr_reg,
352 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
353 struct vhost_scsi_tpg, se_tpg);
354 struct vhost_scsi_tport *tport = tpg->tport;
356 switch (tport->tport_proto_id) {
357 case SCSI_PROTOCOL_SAS:
358 return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
360 case SCSI_PROTOCOL_FCP:
361 return fc_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
363 case SCSI_PROTOCOL_ISCSI:
364 return iscsi_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
367 pr_err("Unknown tport_proto_id: 0x%02x, using"
368 " SAS emulation\n", tport->tport_proto_id);
372 return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
377 vhost_scsi_get_pr_transport_id_len(struct se_portal_group *se_tpg,
378 struct se_node_acl *se_nacl,
379 struct t10_pr_registration *pr_reg,
382 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
383 struct vhost_scsi_tpg, se_tpg);
384 struct vhost_scsi_tport *tport = tpg->tport;
386 switch (tport->tport_proto_id) {
387 case SCSI_PROTOCOL_SAS:
388 return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
390 case SCSI_PROTOCOL_FCP:
391 return fc_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
393 case SCSI_PROTOCOL_ISCSI:
394 return iscsi_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
397 pr_err("Unknown tport_proto_id: 0x%02x, using"
398 " SAS emulation\n", tport->tport_proto_id);
402 return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
407 vhost_scsi_parse_pr_out_transport_id(struct se_portal_group *se_tpg,
410 char **port_nexus_ptr)
412 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
413 struct vhost_scsi_tpg, se_tpg);
414 struct vhost_scsi_tport *tport = tpg->tport;
416 switch (tport->tport_proto_id) {
417 case SCSI_PROTOCOL_SAS:
418 return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
420 case SCSI_PROTOCOL_FCP:
421 return fc_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
423 case SCSI_PROTOCOL_ISCSI:
424 return iscsi_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
427 pr_err("Unknown tport_proto_id: 0x%02x, using"
428 " SAS emulation\n", tport->tport_proto_id);
432 return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
436 static int vhost_scsi_check_prot_fabric_only(struct se_portal_group *se_tpg)
438 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
439 struct vhost_scsi_tpg, se_tpg);
441 return tpg->tv_fabric_prot_type;
444 static struct se_node_acl *
445 vhost_scsi_alloc_fabric_acl(struct se_portal_group *se_tpg)
447 struct vhost_scsi_nacl *nacl;
449 nacl = kzalloc(sizeof(struct vhost_scsi_nacl), GFP_KERNEL);
451 pr_err("Unable to allocate struct vhost_scsi_nacl\n");
455 return &nacl->se_node_acl;
459 vhost_scsi_release_fabric_acl(struct se_portal_group *se_tpg,
460 struct se_node_acl *se_nacl)
462 struct vhost_scsi_nacl *nacl = container_of(se_nacl,
463 struct vhost_scsi_nacl, se_node_acl);
467 static u32 vhost_scsi_tpg_get_inst_index(struct se_portal_group *se_tpg)
472 static void vhost_scsi_release_cmd(struct se_cmd *se_cmd)
474 struct vhost_scsi_cmd *tv_cmd = container_of(se_cmd,
475 struct vhost_scsi_cmd, tvc_se_cmd);
476 struct se_session *se_sess = tv_cmd->tvc_nexus->tvn_se_sess;
479 if (tv_cmd->tvc_sgl_count) {
480 for (i = 0; i < tv_cmd->tvc_sgl_count; i++)
481 put_page(sg_page(&tv_cmd->tvc_sgl[i]));
483 if (tv_cmd->tvc_prot_sgl_count) {
484 for (i = 0; i < tv_cmd->tvc_prot_sgl_count; i++)
485 put_page(sg_page(&tv_cmd->tvc_prot_sgl[i]));
488 vhost_scsi_put_inflight(tv_cmd->inflight);
489 percpu_ida_free(&se_sess->sess_tag_pool, se_cmd->map_tag);
492 static int vhost_scsi_shutdown_session(struct se_session *se_sess)
497 static void vhost_scsi_close_session(struct se_session *se_sess)
502 static u32 vhost_scsi_sess_get_index(struct se_session *se_sess)
507 static int vhost_scsi_write_pending(struct se_cmd *se_cmd)
509 /* Go ahead and process the write immediately */
510 target_execute_cmd(se_cmd);
514 static int vhost_scsi_write_pending_status(struct se_cmd *se_cmd)
519 static void vhost_scsi_set_default_node_attrs(struct se_node_acl *nacl)
524 static u32 vhost_scsi_get_task_tag(struct se_cmd *se_cmd)
529 static int vhost_scsi_get_cmd_state(struct se_cmd *se_cmd)
534 static void vhost_scsi_complete_cmd(struct vhost_scsi_cmd *cmd)
536 struct vhost_scsi *vs = cmd->tvc_vhost;
538 llist_add(&cmd->tvc_completion_list, &vs->vs_completion_list);
540 vhost_work_queue(&vs->dev, &vs->vs_completion_work);
543 static int vhost_scsi_queue_data_in(struct se_cmd *se_cmd)
545 struct vhost_scsi_cmd *cmd = container_of(se_cmd,
546 struct vhost_scsi_cmd, tvc_se_cmd);
547 vhost_scsi_complete_cmd(cmd);
551 static int vhost_scsi_queue_status(struct se_cmd *se_cmd)
553 struct vhost_scsi_cmd *cmd = container_of(se_cmd,
554 struct vhost_scsi_cmd, tvc_se_cmd);
555 vhost_scsi_complete_cmd(cmd);
559 static void vhost_scsi_queue_tm_rsp(struct se_cmd *se_cmd)
564 static void vhost_scsi_aborted_task(struct se_cmd *se_cmd)
569 static void vhost_scsi_free_evt(struct vhost_scsi *vs, struct vhost_scsi_evt *evt)
575 static struct vhost_scsi_evt *
576 vhost_scsi_allocate_evt(struct vhost_scsi *vs,
577 u32 event, u32 reason)
579 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
580 struct vhost_scsi_evt *evt;
582 if (vs->vs_events_nr > VHOST_SCSI_MAX_EVENT) {
583 vs->vs_events_missed = true;
587 evt = kzalloc(sizeof(*evt), GFP_KERNEL);
589 vq_err(vq, "Failed to allocate vhost_scsi_evt\n");
590 vs->vs_events_missed = true;
594 evt->event.event = cpu_to_vhost32(vq, event);
595 evt->event.reason = cpu_to_vhost32(vq, reason);
601 static void vhost_scsi_free_cmd(struct vhost_scsi_cmd *cmd)
603 struct se_cmd *se_cmd = &cmd->tvc_se_cmd;
605 /* TODO locking against target/backend threads? */
606 transport_generic_free_cmd(se_cmd, 0);
610 static int vhost_scsi_check_stop_free(struct se_cmd *se_cmd)
612 return target_put_sess_cmd(se_cmd->se_sess, se_cmd);
616 vhost_scsi_do_evt_work(struct vhost_scsi *vs, struct vhost_scsi_evt *evt)
618 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
619 struct virtio_scsi_event *event = &evt->event;
620 struct virtio_scsi_event __user *eventp;
624 if (!vq->private_data) {
625 vs->vs_events_missed = true;
630 vhost_disable_notify(&vs->dev, vq);
631 head = vhost_get_vq_desc(vq, vq->iov,
632 ARRAY_SIZE(vq->iov), &out, &in,
635 vs->vs_events_missed = true;
638 if (head == vq->num) {
639 if (vhost_enable_notify(&vs->dev, vq))
641 vs->vs_events_missed = true;
645 if ((vq->iov[out].iov_len != sizeof(struct virtio_scsi_event))) {
646 vq_err(vq, "Expecting virtio_scsi_event, got %zu bytes\n",
647 vq->iov[out].iov_len);
648 vs->vs_events_missed = true;
652 if (vs->vs_events_missed) {
653 event->event |= cpu_to_vhost32(vq, VIRTIO_SCSI_T_EVENTS_MISSED);
654 vs->vs_events_missed = false;
657 eventp = vq->iov[out].iov_base;
658 ret = __copy_to_user(eventp, event, sizeof(*event));
660 vhost_add_used_and_signal(&vs->dev, vq, head, 0);
662 vq_err(vq, "Faulted on vhost_scsi_send_event\n");
665 static void vhost_scsi_evt_work(struct vhost_work *work)
667 struct vhost_scsi *vs = container_of(work, struct vhost_scsi,
669 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
670 struct vhost_scsi_evt *evt;
671 struct llist_node *llnode;
673 mutex_lock(&vq->mutex);
674 llnode = llist_del_all(&vs->vs_event_list);
676 evt = llist_entry(llnode, struct vhost_scsi_evt, list);
677 llnode = llist_next(llnode);
678 vhost_scsi_do_evt_work(vs, evt);
679 vhost_scsi_free_evt(vs, evt);
681 mutex_unlock(&vq->mutex);
684 /* Fill in status and signal that we are done processing this command
686 * This is scheduled in the vhost work queue so we are called with the owner
687 * process mm and can access the vring.
689 static void vhost_scsi_complete_cmd_work(struct vhost_work *work)
691 struct vhost_scsi *vs = container_of(work, struct vhost_scsi,
693 DECLARE_BITMAP(signal, VHOST_SCSI_MAX_VQ);
694 struct virtio_scsi_cmd_resp v_rsp;
695 struct vhost_scsi_cmd *cmd;
696 struct llist_node *llnode;
697 struct se_cmd *se_cmd;
698 struct iov_iter iov_iter;
701 bitmap_zero(signal, VHOST_SCSI_MAX_VQ);
702 llnode = llist_del_all(&vs->vs_completion_list);
704 cmd = llist_entry(llnode, struct vhost_scsi_cmd,
705 tvc_completion_list);
706 llnode = llist_next(llnode);
707 se_cmd = &cmd->tvc_se_cmd;
709 pr_debug("%s tv_cmd %p resid %u status %#02x\n", __func__,
710 cmd, se_cmd->residual_count, se_cmd->scsi_status);
712 memset(&v_rsp, 0, sizeof(v_rsp));
713 v_rsp.resid = cpu_to_vhost32(cmd->tvc_vq, se_cmd->residual_count);
714 /* TODO is status_qualifier field needed? */
715 v_rsp.status = se_cmd->scsi_status;
716 v_rsp.sense_len = cpu_to_vhost32(cmd->tvc_vq,
717 se_cmd->scsi_sense_length);
718 memcpy(v_rsp.sense, cmd->tvc_sense_buf,
719 se_cmd->scsi_sense_length);
721 iov_iter_init(&iov_iter, READ, cmd->tvc_resp_iov,
722 cmd->tvc_in_iovs, sizeof(v_rsp));
723 ret = copy_to_iter(&v_rsp, sizeof(v_rsp), &iov_iter);
724 if (likely(ret == sizeof(v_rsp))) {
725 struct vhost_scsi_virtqueue *q;
726 vhost_add_used(cmd->tvc_vq, cmd->tvc_vq_desc, 0);
727 q = container_of(cmd->tvc_vq, struct vhost_scsi_virtqueue, vq);
729 __set_bit(vq, signal);
731 pr_err("Faulted on virtio_scsi_cmd_resp\n");
733 vhost_scsi_free_cmd(cmd);
737 while ((vq = find_next_bit(signal, VHOST_SCSI_MAX_VQ, vq + 1))
739 vhost_signal(&vs->dev, &vs->vqs[vq].vq);
742 static struct vhost_scsi_cmd *
743 vhost_scsi_get_tag(struct vhost_virtqueue *vq, struct vhost_scsi_tpg *tpg,
744 unsigned char *cdb, u64 scsi_tag, u16 lun, u8 task_attr,
745 u32 exp_data_len, int data_direction)
747 struct vhost_scsi_cmd *cmd;
748 struct vhost_scsi_nexus *tv_nexus;
749 struct se_session *se_sess;
750 struct scatterlist *sg, *prot_sg;
754 tv_nexus = tpg->tpg_nexus;
756 pr_err("Unable to locate active struct vhost_scsi_nexus\n");
757 return ERR_PTR(-EIO);
759 se_sess = tv_nexus->tvn_se_sess;
761 tag = percpu_ida_alloc(&se_sess->sess_tag_pool, TASK_RUNNING);
763 pr_err("Unable to obtain tag for vhost_scsi_cmd\n");
764 return ERR_PTR(-ENOMEM);
767 cmd = &((struct vhost_scsi_cmd *)se_sess->sess_cmd_map)[tag];
769 prot_sg = cmd->tvc_prot_sgl;
770 pages = cmd->tvc_upages;
771 memset(cmd, 0, sizeof(struct vhost_scsi_cmd));
774 cmd->tvc_prot_sgl = prot_sg;
775 cmd->tvc_upages = pages;
776 cmd->tvc_se_cmd.map_tag = tag;
777 cmd->tvc_tag = scsi_tag;
779 cmd->tvc_task_attr = task_attr;
780 cmd->tvc_exp_data_len = exp_data_len;
781 cmd->tvc_data_direction = data_direction;
782 cmd->tvc_nexus = tv_nexus;
783 cmd->inflight = vhost_scsi_get_inflight(vq);
785 memcpy(cmd->tvc_cdb, cdb, VHOST_SCSI_MAX_CDB_SIZE);
791 * Map a user memory range into a scatterlist
793 * Returns the number of scatterlist entries used or -errno on error.
796 vhost_scsi_map_to_sgl(struct vhost_scsi_cmd *cmd,
799 struct scatterlist *sgl,
802 unsigned int npages = 0, offset, nbytes;
803 unsigned int pages_nr = iov_num_pages(ptr, len);
804 struct scatterlist *sg = sgl;
805 struct page **pages = cmd->tvc_upages;
808 if (pages_nr > VHOST_SCSI_PREALLOC_UPAGES) {
809 pr_err("vhost_scsi_map_to_sgl() pages_nr: %u greater than"
810 " preallocated VHOST_SCSI_PREALLOC_UPAGES: %u\n",
811 pages_nr, VHOST_SCSI_PREALLOC_UPAGES);
815 ret = get_user_pages_fast((unsigned long)ptr, pages_nr, write, pages);
816 /* No pages were pinned */
819 /* Less pages pinned than wanted */
820 if (ret != pages_nr) {
821 for (i = 0; i < ret; i++)
828 offset = (uintptr_t)ptr & ~PAGE_MASK;
829 nbytes = min_t(unsigned int, PAGE_SIZE - offset, len);
830 sg_set_page(sg, pages[npages], nbytes, offset);
842 vhost_scsi_calc_sgls(struct iov_iter *iter, size_t bytes, int max_sgls)
846 if (!iter || !iter->iov) {
847 pr_err("%s: iter->iov is NULL, but expected bytes: %zu"
848 " present\n", __func__, bytes);
852 sgl_count = iov_iter_npages(iter, 0xffff);
853 if (sgl_count > max_sgls) {
854 pr_err("%s: requested sgl_count: %d exceeds pre-allocated"
855 " max_sgls: %d\n", __func__, sgl_count, max_sgls);
862 vhost_scsi_iov_to_sgl(struct vhost_scsi_cmd *cmd, bool write,
863 struct iov_iter *iter,
864 struct scatterlist *sg, int sg_count)
866 size_t off = iter->iov_offset;
869 for (i = 0; i < iter->nr_segs; i++) {
870 void __user *base = iter->iov[i].iov_base + off;
871 size_t len = iter->iov[i].iov_len - off;
873 ret = vhost_scsi_map_to_sgl(cmd, base, len, sg, write);
875 for (i = 0; i < sg_count; i++) {
876 struct page *page = sg_page(&sg[i]);
889 vhost_scsi_mapal(struct vhost_scsi_cmd *cmd,
890 size_t prot_bytes, struct iov_iter *prot_iter,
891 size_t data_bytes, struct iov_iter *data_iter)
894 bool write = (cmd->tvc_data_direction == DMA_FROM_DEVICE);
897 sgl_count = vhost_scsi_calc_sgls(prot_iter, prot_bytes,
898 VHOST_SCSI_PREALLOC_PROT_SGLS);
902 sg_init_table(cmd->tvc_prot_sgl, sgl_count);
903 cmd->tvc_prot_sgl_count = sgl_count;
904 pr_debug("%s prot_sg %p prot_sgl_count %u\n", __func__,
905 cmd->tvc_prot_sgl, cmd->tvc_prot_sgl_count);
907 ret = vhost_scsi_iov_to_sgl(cmd, write, prot_iter,
909 cmd->tvc_prot_sgl_count);
911 cmd->tvc_prot_sgl_count = 0;
915 sgl_count = vhost_scsi_calc_sgls(data_iter, data_bytes,
916 VHOST_SCSI_PREALLOC_SGLS);
920 sg_init_table(cmd->tvc_sgl, sgl_count);
921 cmd->tvc_sgl_count = sgl_count;
922 pr_debug("%s data_sg %p data_sgl_count %u\n", __func__,
923 cmd->tvc_sgl, cmd->tvc_sgl_count);
925 ret = vhost_scsi_iov_to_sgl(cmd, write, data_iter,
926 cmd->tvc_sgl, cmd->tvc_sgl_count);
928 cmd->tvc_sgl_count = 0;
934 static int vhost_scsi_to_tcm_attr(int attr)
937 case VIRTIO_SCSI_S_SIMPLE:
938 return TCM_SIMPLE_TAG;
939 case VIRTIO_SCSI_S_ORDERED:
940 return TCM_ORDERED_TAG;
941 case VIRTIO_SCSI_S_HEAD:
943 case VIRTIO_SCSI_S_ACA:
948 return TCM_SIMPLE_TAG;
951 static void vhost_scsi_submission_work(struct work_struct *work)
953 struct vhost_scsi_cmd *cmd =
954 container_of(work, struct vhost_scsi_cmd, work);
955 struct vhost_scsi_nexus *tv_nexus;
956 struct se_cmd *se_cmd = &cmd->tvc_se_cmd;
957 struct scatterlist *sg_ptr, *sg_prot_ptr = NULL;
960 /* FIXME: BIDI operation */
961 if (cmd->tvc_sgl_count) {
962 sg_ptr = cmd->tvc_sgl;
964 if (cmd->tvc_prot_sgl_count)
965 sg_prot_ptr = cmd->tvc_prot_sgl;
967 se_cmd->prot_pto = true;
971 tv_nexus = cmd->tvc_nexus;
973 rc = target_submit_cmd_map_sgls(se_cmd, tv_nexus->tvn_se_sess,
974 cmd->tvc_cdb, &cmd->tvc_sense_buf[0],
975 cmd->tvc_lun, cmd->tvc_exp_data_len,
976 vhost_scsi_to_tcm_attr(cmd->tvc_task_attr),
977 cmd->tvc_data_direction, TARGET_SCF_ACK_KREF,
978 sg_ptr, cmd->tvc_sgl_count, NULL, 0, sg_prot_ptr,
979 cmd->tvc_prot_sgl_count);
981 transport_send_check_condition_and_sense(se_cmd,
982 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE, 0);
983 transport_generic_free_cmd(se_cmd, 0);
988 vhost_scsi_send_bad_target(struct vhost_scsi *vs,
989 struct vhost_virtqueue *vq,
990 int head, unsigned out)
992 struct virtio_scsi_cmd_resp __user *resp;
993 struct virtio_scsi_cmd_resp rsp;
996 memset(&rsp, 0, sizeof(rsp));
997 rsp.response = VIRTIO_SCSI_S_BAD_TARGET;
998 resp = vq->iov[out].iov_base;
999 ret = __copy_to_user(resp, &rsp, sizeof(rsp));
1001 vhost_add_used_and_signal(&vs->dev, vq, head, 0);
1003 pr_err("Faulted on virtio_scsi_cmd_resp\n");
1007 vhost_scsi_handle_vq(struct vhost_scsi *vs, struct vhost_virtqueue *vq)
1009 struct vhost_scsi_tpg **vs_tpg, *tpg;
1010 struct virtio_scsi_cmd_req v_req;
1011 struct virtio_scsi_cmd_req_pi v_req_pi;
1012 struct vhost_scsi_cmd *cmd;
1013 struct iov_iter out_iter, in_iter, prot_iter, data_iter;
1015 u32 exp_data_len, data_direction;
1017 int head, ret, prot_bytes;
1018 size_t req_size, rsp_size = sizeof(struct virtio_scsi_cmd_resp);
1019 size_t out_size, in_size;
1021 u8 *target, *lunp, task_attr;
1022 bool t10_pi = vhost_has_feature(vq, VIRTIO_SCSI_F_T10_PI);
1025 mutex_lock(&vq->mutex);
1027 * We can handle the vq only after the endpoint is setup by calling the
1028 * VHOST_SCSI_SET_ENDPOINT ioctl.
1030 vs_tpg = vq->private_data;
1034 vhost_disable_notify(&vs->dev, vq);
1037 head = vhost_get_vq_desc(vq, vq->iov,
1038 ARRAY_SIZE(vq->iov), &out, &in,
1040 pr_debug("vhost_get_vq_desc: head: %d, out: %u in: %u\n",
1042 /* On error, stop handling until the next kick. */
1043 if (unlikely(head < 0))
1045 /* Nothing new? Wait for eventfd to tell us they refilled. */
1046 if (head == vq->num) {
1047 if (unlikely(vhost_enable_notify(&vs->dev, vq))) {
1048 vhost_disable_notify(&vs->dev, vq);
1054 * Check for a sane response buffer so we can report early
1055 * errors back to the guest.
1057 if (unlikely(vq->iov[out].iov_len < rsp_size)) {
1058 vq_err(vq, "Expecting at least virtio_scsi_cmd_resp"
1059 " size, got %zu bytes\n", vq->iov[out].iov_len);
1063 * Setup pointers and values based upon different virtio-scsi
1064 * request header if T10_PI is enabled in KVM guest.
1068 req_size = sizeof(v_req_pi);
1069 lunp = &v_req_pi.lun[0];
1070 target = &v_req_pi.lun[1];
1073 req_size = sizeof(v_req);
1074 lunp = &v_req.lun[0];
1075 target = &v_req.lun[1];
1078 * FIXME: Not correct for BIDI operation
1080 out_size = iov_length(vq->iov, out);
1081 in_size = iov_length(&vq->iov[out], in);
1084 * Copy over the virtio-scsi request header, which for a
1085 * ANY_LAYOUT enabled guest may span multiple iovecs, or a
1086 * single iovec may contain both the header + outgoing
1089 * copy_from_iter() will advance out_iter, so that it will
1090 * point at the start of the outgoing WRITE payload, if
1091 * DMA_TO_DEVICE is set.
1093 iov_iter_init(&out_iter, WRITE, vq->iov, out, out_size);
1095 ret = copy_from_iter(req, req_size, &out_iter);
1096 if (unlikely(ret != req_size)) {
1097 vq_err(vq, "Faulted on copy_from_iter\n");
1098 vhost_scsi_send_bad_target(vs, vq, head, out);
1101 /* virtio-scsi spec requires byte 0 of the lun to be 1 */
1102 if (unlikely(*lunp != 1)) {
1103 vq_err(vq, "Illegal virtio-scsi lun: %u\n", *lunp);
1104 vhost_scsi_send_bad_target(vs, vq, head, out);
1108 tpg = ACCESS_ONCE(vs_tpg[*target]);
1109 if (unlikely(!tpg)) {
1110 /* Target does not exist, fail the request */
1111 vhost_scsi_send_bad_target(vs, vq, head, out);
1115 * Determine data_direction by calculating the total outgoing
1116 * iovec sizes + incoming iovec sizes vs. virtio-scsi request +
1117 * response headers respectively.
1119 * For DMA_TO_DEVICE this is out_iter, which is already pointing
1120 * to the right place.
1122 * For DMA_FROM_DEVICE, the iovec will be just past the end
1123 * of the virtio-scsi response header in either the same
1124 * or immediately following iovec.
1126 * Any associated T10_PI bytes for the outgoing / incoming
1127 * payloads are included in calculation of exp_data_len here.
1131 if (out_size > req_size) {
1132 data_direction = DMA_TO_DEVICE;
1133 exp_data_len = out_size - req_size;
1134 data_iter = out_iter;
1135 } else if (in_size > rsp_size) {
1136 data_direction = DMA_FROM_DEVICE;
1137 exp_data_len = in_size - rsp_size;
1139 iov_iter_init(&in_iter, READ, &vq->iov[out], in,
1140 rsp_size + exp_data_len);
1141 iov_iter_advance(&in_iter, rsp_size);
1142 data_iter = in_iter;
1144 data_direction = DMA_NONE;
1148 * If T10_PI header + payload is present, setup prot_iter values
1149 * and recalculate data_iter for vhost_scsi_mapal() mapping to
1150 * host scatterlists via get_user_pages_fast().
1153 if (v_req_pi.pi_bytesout) {
1154 if (data_direction != DMA_TO_DEVICE) {
1155 vq_err(vq, "Received non zero pi_bytesout,"
1156 " but wrong data_direction\n");
1157 vhost_scsi_send_bad_target(vs, vq, head, out);
1160 prot_bytes = vhost32_to_cpu(vq, v_req_pi.pi_bytesout);
1161 } else if (v_req_pi.pi_bytesin) {
1162 if (data_direction != DMA_FROM_DEVICE) {
1163 vq_err(vq, "Received non zero pi_bytesin,"
1164 " but wrong data_direction\n");
1165 vhost_scsi_send_bad_target(vs, vq, head, out);
1168 prot_bytes = vhost32_to_cpu(vq, v_req_pi.pi_bytesin);
1171 * Set prot_iter to data_iter, and advance past any
1172 * preceeding prot_bytes that may be present.
1174 * Also fix up the exp_data_len to reflect only the
1175 * actual data payload length.
1178 exp_data_len -= prot_bytes;
1179 prot_iter = data_iter;
1180 iov_iter_advance(&data_iter, prot_bytes);
1182 tag = vhost64_to_cpu(vq, v_req_pi.tag);
1183 task_attr = v_req_pi.task_attr;
1184 cdb = &v_req_pi.cdb[0];
1185 lun = ((v_req_pi.lun[2] << 8) | v_req_pi.lun[3]) & 0x3FFF;
1187 tag = vhost64_to_cpu(vq, v_req.tag);
1188 task_attr = v_req.task_attr;
1189 cdb = &v_req.cdb[0];
1190 lun = ((v_req.lun[2] << 8) | v_req.lun[3]) & 0x3FFF;
1193 * Check that the received CDB size does not exceeded our
1194 * hardcoded max for vhost-scsi, then get a pre-allocated
1195 * cmd descriptor for the new virtio-scsi tag.
1197 * TODO what if cdb was too small for varlen cdb header?
1199 if (unlikely(scsi_command_size(cdb) > VHOST_SCSI_MAX_CDB_SIZE)) {
1200 vq_err(vq, "Received SCSI CDB with command_size: %d that"
1201 " exceeds SCSI_MAX_VARLEN_CDB_SIZE: %d\n",
1202 scsi_command_size(cdb), VHOST_SCSI_MAX_CDB_SIZE);
1203 vhost_scsi_send_bad_target(vs, vq, head, out);
1206 cmd = vhost_scsi_get_tag(vq, tpg, cdb, tag, lun, task_attr,
1207 exp_data_len + prot_bytes,
1210 vq_err(vq, "vhost_scsi_get_tag failed %ld\n",
1212 vhost_scsi_send_bad_target(vs, vq, head, out);
1215 cmd->tvc_vhost = vs;
1217 cmd->tvc_resp_iov = &vq->iov[out];
1218 cmd->tvc_in_iovs = in;
1220 pr_debug("vhost_scsi got command opcode: %#02x, lun: %d\n",
1221 cmd->tvc_cdb[0], cmd->tvc_lun);
1222 pr_debug("cmd: %p exp_data_len: %d, prot_bytes: %d data_direction:"
1223 " %d\n", cmd, exp_data_len, prot_bytes, data_direction);
1225 if (data_direction != DMA_NONE) {
1226 ret = vhost_scsi_mapal(cmd,
1227 prot_bytes, &prot_iter,
1228 exp_data_len, &data_iter);
1229 if (unlikely(ret)) {
1230 vq_err(vq, "Failed to map iov to sgl\n");
1231 vhost_scsi_release_cmd(&cmd->tvc_se_cmd);
1232 vhost_scsi_send_bad_target(vs, vq, head, out);
1237 * Save the descriptor from vhost_get_vq_desc() to be used to
1238 * complete the virtio-scsi request in TCM callback context via
1239 * vhost_scsi_queue_data_in() and vhost_scsi_queue_status()
1241 cmd->tvc_vq_desc = head;
1243 * Dispatch cmd descriptor for cmwq execution in process
1244 * context provided by vhost_scsi_workqueue. This also ensures
1245 * cmd is executed on the same kworker CPU as this vhost
1246 * thread to gain positive L2 cache locality effects.
1248 INIT_WORK(&cmd->work, vhost_scsi_submission_work);
1249 queue_work(vhost_scsi_workqueue, &cmd->work);
1252 mutex_unlock(&vq->mutex);
1255 static void vhost_scsi_ctl_handle_kick(struct vhost_work *work)
1257 pr_debug("%s: The handling func for control queue.\n", __func__);
1261 vhost_scsi_send_evt(struct vhost_scsi *vs,
1262 struct vhost_scsi_tpg *tpg,
1267 struct vhost_scsi_evt *evt;
1269 evt = vhost_scsi_allocate_evt(vs, event, reason);
1274 /* TODO: share lun setup code with virtio-scsi.ko */
1276 * Note: evt->event is zeroed when we allocate it and
1277 * lun[4-7] need to be zero according to virtio-scsi spec.
1279 evt->event.lun[0] = 0x01;
1280 evt->event.lun[1] = tpg->tport_tpgt;
1281 if (lun->unpacked_lun >= 256)
1282 evt->event.lun[2] = lun->unpacked_lun >> 8 | 0x40 ;
1283 evt->event.lun[3] = lun->unpacked_lun & 0xFF;
1286 llist_add(&evt->list, &vs->vs_event_list);
1287 vhost_work_queue(&vs->dev, &vs->vs_event_work);
1290 static void vhost_scsi_evt_handle_kick(struct vhost_work *work)
1292 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1294 struct vhost_scsi *vs = container_of(vq->dev, struct vhost_scsi, dev);
1296 mutex_lock(&vq->mutex);
1297 if (!vq->private_data)
1300 if (vs->vs_events_missed)
1301 vhost_scsi_send_evt(vs, NULL, NULL, VIRTIO_SCSI_T_NO_EVENT, 0);
1303 mutex_unlock(&vq->mutex);
1306 static void vhost_scsi_handle_kick(struct vhost_work *work)
1308 struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1310 struct vhost_scsi *vs = container_of(vq->dev, struct vhost_scsi, dev);
1312 vhost_scsi_handle_vq(vs, vq);
1315 static void vhost_scsi_flush_vq(struct vhost_scsi *vs, int index)
1317 vhost_poll_flush(&vs->vqs[index].vq.poll);
1320 /* Callers must hold dev mutex */
1321 static void vhost_scsi_flush(struct vhost_scsi *vs)
1323 struct vhost_scsi_inflight *old_inflight[VHOST_SCSI_MAX_VQ];
1326 /* Init new inflight and remember the old inflight */
1327 vhost_scsi_init_inflight(vs, old_inflight);
1330 * The inflight->kref was initialized to 1. We decrement it here to
1331 * indicate the start of the flush operation so that it will reach 0
1332 * when all the reqs are finished.
1334 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1335 kref_put(&old_inflight[i]->kref, vhost_scsi_done_inflight);
1337 /* Flush both the vhost poll and vhost work */
1338 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1339 vhost_scsi_flush_vq(vs, i);
1340 vhost_work_flush(&vs->dev, &vs->vs_completion_work);
1341 vhost_work_flush(&vs->dev, &vs->vs_event_work);
1343 /* Wait for all reqs issued before the flush to be finished */
1344 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1345 wait_for_completion(&old_inflight[i]->comp);
1349 * Called from vhost_scsi_ioctl() context to walk the list of available
1350 * vhost_scsi_tpg with an active struct vhost_scsi_nexus
1352 * The lock nesting rule is:
1353 * vhost_scsi_mutex -> vs->dev.mutex -> tpg->tv_tpg_mutex -> vq->mutex
1356 vhost_scsi_set_endpoint(struct vhost_scsi *vs,
1357 struct vhost_scsi_target *t)
1359 struct se_portal_group *se_tpg;
1360 struct vhost_scsi_tport *tv_tport;
1361 struct vhost_scsi_tpg *tpg;
1362 struct vhost_scsi_tpg **vs_tpg;
1363 struct vhost_virtqueue *vq;
1364 int index, ret, i, len;
1367 mutex_lock(&vhost_scsi_mutex);
1368 mutex_lock(&vs->dev.mutex);
1370 /* Verify that ring has been setup correctly. */
1371 for (index = 0; index < vs->dev.nvqs; ++index) {
1372 /* Verify that ring has been setup correctly. */
1373 if (!vhost_vq_access_ok(&vs->vqs[index].vq)) {
1379 len = sizeof(vs_tpg[0]) * VHOST_SCSI_MAX_TARGET;
1380 vs_tpg = kzalloc(len, GFP_KERNEL);
1386 memcpy(vs_tpg, vs->vs_tpg, len);
1388 list_for_each_entry(tpg, &vhost_scsi_list, tv_tpg_list) {
1389 mutex_lock(&tpg->tv_tpg_mutex);
1390 if (!tpg->tpg_nexus) {
1391 mutex_unlock(&tpg->tv_tpg_mutex);
1394 if (tpg->tv_tpg_vhost_count != 0) {
1395 mutex_unlock(&tpg->tv_tpg_mutex);
1398 tv_tport = tpg->tport;
1400 if (!strcmp(tv_tport->tport_name, t->vhost_wwpn)) {
1401 if (vs->vs_tpg && vs->vs_tpg[tpg->tport_tpgt]) {
1403 mutex_unlock(&tpg->tv_tpg_mutex);
1408 * In order to ensure individual vhost-scsi configfs
1409 * groups cannot be removed while in use by vhost ioctl,
1410 * go ahead and take an explicit se_tpg->tpg_group.cg_item
1413 se_tpg = &tpg->se_tpg;
1414 ret = target_depend_item(&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 target_undepend_item(&se_tpg->tpg_group.cg_item);
1520 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1521 vq = &vs->vqs[i].vq;
1522 mutex_lock(&vq->mutex);
1523 vq->private_data = NULL;
1524 mutex_unlock(&vq->mutex);
1528 * Act as synchronize_rcu to make sure access to
1529 * old vs->vs_tpg is finished.
1531 vhost_scsi_flush(vs);
1534 WARN_ON(vs->vs_events_nr);
1535 mutex_unlock(&vs->dev.mutex);
1536 mutex_unlock(&vhost_scsi_mutex);
1540 mutex_unlock(&tpg->tv_tpg_mutex);
1542 mutex_unlock(&vs->dev.mutex);
1543 mutex_unlock(&vhost_scsi_mutex);
1547 static int vhost_scsi_set_features(struct vhost_scsi *vs, u64 features)
1549 struct vhost_virtqueue *vq;
1552 if (features & ~VHOST_SCSI_FEATURES)
1555 mutex_lock(&vs->dev.mutex);
1556 if ((features & (1 << VHOST_F_LOG_ALL)) &&
1557 !vhost_log_access_ok(&vs->dev)) {
1558 mutex_unlock(&vs->dev.mutex);
1562 for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1563 vq = &vs->vqs[i].vq;
1564 mutex_lock(&vq->mutex);
1565 vq->acked_features = features;
1566 mutex_unlock(&vq->mutex);
1568 mutex_unlock(&vs->dev.mutex);
1572 static int vhost_scsi_open(struct inode *inode, struct file *f)
1574 struct vhost_scsi *vs;
1575 struct vhost_virtqueue **vqs;
1578 vs = kzalloc(sizeof(*vs), GFP_KERNEL | __GFP_NOWARN | __GFP_REPEAT);
1580 vs = vzalloc(sizeof(*vs));
1585 vqs = kmalloc(VHOST_SCSI_MAX_VQ * sizeof(*vqs), GFP_KERNEL);
1589 vhost_work_init(&vs->vs_completion_work, vhost_scsi_complete_cmd_work);
1590 vhost_work_init(&vs->vs_event_work, vhost_scsi_evt_work);
1592 vs->vs_events_nr = 0;
1593 vs->vs_events_missed = false;
1595 vqs[VHOST_SCSI_VQ_CTL] = &vs->vqs[VHOST_SCSI_VQ_CTL].vq;
1596 vqs[VHOST_SCSI_VQ_EVT] = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1597 vs->vqs[VHOST_SCSI_VQ_CTL].vq.handle_kick = vhost_scsi_ctl_handle_kick;
1598 vs->vqs[VHOST_SCSI_VQ_EVT].vq.handle_kick = vhost_scsi_evt_handle_kick;
1599 for (i = VHOST_SCSI_VQ_IO; i < VHOST_SCSI_MAX_VQ; i++) {
1600 vqs[i] = &vs->vqs[i].vq;
1601 vs->vqs[i].vq.handle_kick = vhost_scsi_handle_kick;
1603 vhost_dev_init(&vs->dev, vqs, VHOST_SCSI_MAX_VQ);
1605 vhost_scsi_init_inflight(vs, NULL);
1607 f->private_data = vs;
1616 static int vhost_scsi_release(struct inode *inode, struct file *f)
1618 struct vhost_scsi *vs = f->private_data;
1619 struct vhost_scsi_target t;
1621 mutex_lock(&vs->dev.mutex);
1622 memcpy(t.vhost_wwpn, vs->vs_vhost_wwpn, sizeof(t.vhost_wwpn));
1623 mutex_unlock(&vs->dev.mutex);
1624 vhost_scsi_clear_endpoint(vs, &t);
1625 vhost_dev_stop(&vs->dev);
1626 vhost_dev_cleanup(&vs->dev, false);
1627 /* Jobs can re-queue themselves in evt kick handler. Do extra flush. */
1628 vhost_scsi_flush(vs);
1635 vhost_scsi_ioctl(struct file *f,
1639 struct vhost_scsi *vs = f->private_data;
1640 struct vhost_scsi_target backend;
1641 void __user *argp = (void __user *)arg;
1642 u64 __user *featurep = argp;
1643 u32 __user *eventsp = argp;
1646 int r, abi_version = VHOST_SCSI_ABI_VERSION;
1647 struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1650 case VHOST_SCSI_SET_ENDPOINT:
1651 if (copy_from_user(&backend, argp, sizeof backend))
1653 if (backend.reserved != 0)
1656 return vhost_scsi_set_endpoint(vs, &backend);
1657 case VHOST_SCSI_CLEAR_ENDPOINT:
1658 if (copy_from_user(&backend, argp, sizeof backend))
1660 if (backend.reserved != 0)
1663 return vhost_scsi_clear_endpoint(vs, &backend);
1664 case VHOST_SCSI_GET_ABI_VERSION:
1665 if (copy_to_user(argp, &abi_version, sizeof abi_version))
1668 case VHOST_SCSI_SET_EVENTS_MISSED:
1669 if (get_user(events_missed, eventsp))
1671 mutex_lock(&vq->mutex);
1672 vs->vs_events_missed = events_missed;
1673 mutex_unlock(&vq->mutex);
1675 case VHOST_SCSI_GET_EVENTS_MISSED:
1676 mutex_lock(&vq->mutex);
1677 events_missed = vs->vs_events_missed;
1678 mutex_unlock(&vq->mutex);
1679 if (put_user(events_missed, eventsp))
1682 case VHOST_GET_FEATURES:
1683 features = VHOST_SCSI_FEATURES;
1684 if (copy_to_user(featurep, &features, sizeof features))
1687 case VHOST_SET_FEATURES:
1688 if (copy_from_user(&features, featurep, sizeof features))
1690 return vhost_scsi_set_features(vs, features);
1692 mutex_lock(&vs->dev.mutex);
1693 r = vhost_dev_ioctl(&vs->dev, ioctl, argp);
1694 /* TODO: flush backend after dev ioctl. */
1695 if (r == -ENOIOCTLCMD)
1696 r = vhost_vring_ioctl(&vs->dev, ioctl, argp);
1697 mutex_unlock(&vs->dev.mutex);
1702 #ifdef CONFIG_COMPAT
1703 static long vhost_scsi_compat_ioctl(struct file *f, unsigned int ioctl,
1706 return vhost_scsi_ioctl(f, ioctl, (unsigned long)compat_ptr(arg));
1710 static const struct file_operations vhost_scsi_fops = {
1711 .owner = THIS_MODULE,
1712 .release = vhost_scsi_release,
1713 .unlocked_ioctl = vhost_scsi_ioctl,
1714 #ifdef CONFIG_COMPAT
1715 .compat_ioctl = vhost_scsi_compat_ioctl,
1717 .open = vhost_scsi_open,
1718 .llseek = noop_llseek,
1721 static struct miscdevice vhost_scsi_misc = {
1727 static int __init vhost_scsi_register(void)
1729 return misc_register(&vhost_scsi_misc);
1732 static int vhost_scsi_deregister(void)
1734 return misc_deregister(&vhost_scsi_misc);
1737 static char *vhost_scsi_dump_proto_id(struct vhost_scsi_tport *tport)
1739 switch (tport->tport_proto_id) {
1740 case SCSI_PROTOCOL_SAS:
1742 case SCSI_PROTOCOL_FCP:
1744 case SCSI_PROTOCOL_ISCSI:
1754 vhost_scsi_do_plug(struct vhost_scsi_tpg *tpg,
1755 struct se_lun *lun, bool plug)
1758 struct vhost_scsi *vs = tpg->vhost_scsi;
1759 struct vhost_virtqueue *vq;
1765 mutex_lock(&vs->dev.mutex);
1768 reason = VIRTIO_SCSI_EVT_RESET_RESCAN;
1770 reason = VIRTIO_SCSI_EVT_RESET_REMOVED;
1772 vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1773 mutex_lock(&vq->mutex);
1774 if (vhost_has_feature(vq, VIRTIO_SCSI_F_HOTPLUG))
1775 vhost_scsi_send_evt(vs, tpg, lun,
1776 VIRTIO_SCSI_T_TRANSPORT_RESET, reason);
1777 mutex_unlock(&vq->mutex);
1778 mutex_unlock(&vs->dev.mutex);
1781 static void vhost_scsi_hotplug(struct vhost_scsi_tpg *tpg, struct se_lun *lun)
1783 vhost_scsi_do_plug(tpg, lun, true);
1786 static void vhost_scsi_hotunplug(struct vhost_scsi_tpg *tpg, struct se_lun *lun)
1788 vhost_scsi_do_plug(tpg, lun, false);
1791 static int vhost_scsi_port_link(struct se_portal_group *se_tpg,
1794 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1795 struct vhost_scsi_tpg, se_tpg);
1797 mutex_lock(&vhost_scsi_mutex);
1799 mutex_lock(&tpg->tv_tpg_mutex);
1800 tpg->tv_tpg_port_count++;
1801 mutex_unlock(&tpg->tv_tpg_mutex);
1803 vhost_scsi_hotplug(tpg, lun);
1805 mutex_unlock(&vhost_scsi_mutex);
1810 static void vhost_scsi_port_unlink(struct se_portal_group *se_tpg,
1813 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1814 struct vhost_scsi_tpg, se_tpg);
1816 mutex_lock(&vhost_scsi_mutex);
1818 mutex_lock(&tpg->tv_tpg_mutex);
1819 tpg->tv_tpg_port_count--;
1820 mutex_unlock(&tpg->tv_tpg_mutex);
1822 vhost_scsi_hotunplug(tpg, lun);
1824 mutex_unlock(&vhost_scsi_mutex);
1827 static struct se_node_acl *
1828 vhost_scsi_make_nodeacl(struct se_portal_group *se_tpg,
1829 struct config_group *group,
1832 struct se_node_acl *se_nacl, *se_nacl_new;
1833 struct vhost_scsi_nacl *nacl;
1837 /* vhost_scsi_parse_wwn(name, &wwpn, 1) < 0)
1838 return ERR_PTR(-EINVAL); */
1839 se_nacl_new = vhost_scsi_alloc_fabric_acl(se_tpg);
1841 return ERR_PTR(-ENOMEM);
1845 * se_nacl_new may be released by core_tpg_add_initiator_node_acl()
1846 * when converting a NodeACL from demo mode -> explict
1848 se_nacl = core_tpg_add_initiator_node_acl(se_tpg, se_nacl_new,
1850 if (IS_ERR(se_nacl)) {
1851 vhost_scsi_release_fabric_acl(se_tpg, se_nacl_new);
1855 * Locate our struct vhost_scsi_nacl and set the FC Nport WWPN
1857 nacl = container_of(se_nacl, struct vhost_scsi_nacl, se_node_acl);
1858 nacl->iport_wwpn = wwpn;
1863 static void vhost_scsi_drop_nodeacl(struct se_node_acl *se_acl)
1865 struct vhost_scsi_nacl *nacl = container_of(se_acl,
1866 struct vhost_scsi_nacl, se_node_acl);
1867 core_tpg_del_initiator_node_acl(se_acl->se_tpg, se_acl, 1);
1871 static void vhost_scsi_free_cmd_map_res(struct vhost_scsi_nexus *nexus,
1872 struct se_session *se_sess)
1874 struct vhost_scsi_cmd *tv_cmd;
1877 if (!se_sess->sess_cmd_map)
1880 for (i = 0; i < VHOST_SCSI_DEFAULT_TAGS; i++) {
1881 tv_cmd = &((struct vhost_scsi_cmd *)se_sess->sess_cmd_map)[i];
1883 kfree(tv_cmd->tvc_sgl);
1884 kfree(tv_cmd->tvc_prot_sgl);
1885 kfree(tv_cmd->tvc_upages);
1889 static ssize_t vhost_scsi_tpg_attrib_store_fabric_prot_type(
1890 struct se_portal_group *se_tpg,
1894 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1895 struct vhost_scsi_tpg, se_tpg);
1897 int ret = kstrtoul(page, 0, &val);
1900 pr_err("kstrtoul() returned %d for fabric_prot_type\n", ret);
1903 if (val != 0 && val != 1 && val != 3) {
1904 pr_err("Invalid vhost_scsi fabric_prot_type: %lu\n", val);
1907 tpg->tv_fabric_prot_type = val;
1912 static ssize_t vhost_scsi_tpg_attrib_show_fabric_prot_type(
1913 struct se_portal_group *se_tpg,
1916 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
1917 struct vhost_scsi_tpg, se_tpg);
1919 return sprintf(page, "%d\n", tpg->tv_fabric_prot_type);
1921 TF_TPG_ATTRIB_ATTR(vhost_scsi, fabric_prot_type, S_IRUGO | S_IWUSR);
1923 static struct configfs_attribute *vhost_scsi_tpg_attrib_attrs[] = {
1924 &vhost_scsi_tpg_attrib_fabric_prot_type.attr,
1928 static int vhost_scsi_make_nexus(struct vhost_scsi_tpg *tpg,
1931 struct se_portal_group *se_tpg;
1932 struct se_session *se_sess;
1933 struct vhost_scsi_nexus *tv_nexus;
1934 struct vhost_scsi_cmd *tv_cmd;
1937 mutex_lock(&tpg->tv_tpg_mutex);
1938 if (tpg->tpg_nexus) {
1939 mutex_unlock(&tpg->tv_tpg_mutex);
1940 pr_debug("tpg->tpg_nexus already exists\n");
1943 se_tpg = &tpg->se_tpg;
1945 tv_nexus = kzalloc(sizeof(struct vhost_scsi_nexus), GFP_KERNEL);
1947 mutex_unlock(&tpg->tv_tpg_mutex);
1948 pr_err("Unable to allocate struct vhost_scsi_nexus\n");
1952 * Initialize the struct se_session pointer and setup tagpool
1953 * for struct vhost_scsi_cmd descriptors
1955 tv_nexus->tvn_se_sess = transport_init_session_tags(
1956 VHOST_SCSI_DEFAULT_TAGS,
1957 sizeof(struct vhost_scsi_cmd),
1958 TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS);
1959 if (IS_ERR(tv_nexus->tvn_se_sess)) {
1960 mutex_unlock(&tpg->tv_tpg_mutex);
1964 se_sess = tv_nexus->tvn_se_sess;
1965 for (i = 0; i < VHOST_SCSI_DEFAULT_TAGS; i++) {
1966 tv_cmd = &((struct vhost_scsi_cmd *)se_sess->sess_cmd_map)[i];
1968 tv_cmd->tvc_sgl = kzalloc(sizeof(struct scatterlist) *
1969 VHOST_SCSI_PREALLOC_SGLS, GFP_KERNEL);
1970 if (!tv_cmd->tvc_sgl) {
1971 mutex_unlock(&tpg->tv_tpg_mutex);
1972 pr_err("Unable to allocate tv_cmd->tvc_sgl\n");
1976 tv_cmd->tvc_upages = kzalloc(sizeof(struct page *) *
1977 VHOST_SCSI_PREALLOC_UPAGES, GFP_KERNEL);
1978 if (!tv_cmd->tvc_upages) {
1979 mutex_unlock(&tpg->tv_tpg_mutex);
1980 pr_err("Unable to allocate tv_cmd->tvc_upages\n");
1984 tv_cmd->tvc_prot_sgl = kzalloc(sizeof(struct scatterlist) *
1985 VHOST_SCSI_PREALLOC_PROT_SGLS, GFP_KERNEL);
1986 if (!tv_cmd->tvc_prot_sgl) {
1987 mutex_unlock(&tpg->tv_tpg_mutex);
1988 pr_err("Unable to allocate tv_cmd->tvc_prot_sgl\n");
1993 * Since we are running in 'demo mode' this call with generate a
1994 * struct se_node_acl for the vhost_scsi struct se_portal_group with
1995 * the SCSI Initiator port name of the passed configfs group 'name'.
1997 tv_nexus->tvn_se_sess->se_node_acl = core_tpg_check_initiator_node_acl(
1998 se_tpg, (unsigned char *)name);
1999 if (!tv_nexus->tvn_se_sess->se_node_acl) {
2000 mutex_unlock(&tpg->tv_tpg_mutex);
2001 pr_debug("core_tpg_check_initiator_node_acl() failed"
2006 * Now register the TCM vhost virtual I_T Nexus as active.
2008 transport_register_session(se_tpg, tv_nexus->tvn_se_sess->se_node_acl,
2009 tv_nexus->tvn_se_sess, tv_nexus);
2010 tpg->tpg_nexus = tv_nexus;
2012 mutex_unlock(&tpg->tv_tpg_mutex);
2016 vhost_scsi_free_cmd_map_res(tv_nexus, se_sess);
2017 transport_free_session(se_sess);
2022 static int vhost_scsi_drop_nexus(struct vhost_scsi_tpg *tpg)
2024 struct se_session *se_sess;
2025 struct vhost_scsi_nexus *tv_nexus;
2027 mutex_lock(&tpg->tv_tpg_mutex);
2028 tv_nexus = tpg->tpg_nexus;
2030 mutex_unlock(&tpg->tv_tpg_mutex);
2034 se_sess = tv_nexus->tvn_se_sess;
2036 mutex_unlock(&tpg->tv_tpg_mutex);
2040 if (tpg->tv_tpg_port_count != 0) {
2041 mutex_unlock(&tpg->tv_tpg_mutex);
2042 pr_err("Unable to remove TCM_vhost I_T Nexus with"
2043 " active TPG port count: %d\n",
2044 tpg->tv_tpg_port_count);
2048 if (tpg->tv_tpg_vhost_count != 0) {
2049 mutex_unlock(&tpg->tv_tpg_mutex);
2050 pr_err("Unable to remove TCM_vhost I_T Nexus with"
2051 " active TPG vhost count: %d\n",
2052 tpg->tv_tpg_vhost_count);
2056 pr_debug("TCM_vhost_ConfigFS: Removing I_T Nexus to emulated"
2057 " %s Initiator Port: %s\n", vhost_scsi_dump_proto_id(tpg->tport),
2058 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
2060 vhost_scsi_free_cmd_map_res(tv_nexus, se_sess);
2062 * Release the SCSI I_T Nexus to the emulated vhost Target Port
2064 transport_deregister_session(tv_nexus->tvn_se_sess);
2065 tpg->tpg_nexus = NULL;
2066 mutex_unlock(&tpg->tv_tpg_mutex);
2072 static ssize_t vhost_scsi_tpg_show_nexus(struct se_portal_group *se_tpg,
2075 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
2076 struct vhost_scsi_tpg, se_tpg);
2077 struct vhost_scsi_nexus *tv_nexus;
2080 mutex_lock(&tpg->tv_tpg_mutex);
2081 tv_nexus = tpg->tpg_nexus;
2083 mutex_unlock(&tpg->tv_tpg_mutex);
2086 ret = snprintf(page, PAGE_SIZE, "%s\n",
2087 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
2088 mutex_unlock(&tpg->tv_tpg_mutex);
2093 static ssize_t vhost_scsi_tpg_store_nexus(struct se_portal_group *se_tpg,
2097 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
2098 struct vhost_scsi_tpg, se_tpg);
2099 struct vhost_scsi_tport *tport_wwn = tpg->tport;
2100 unsigned char i_port[VHOST_SCSI_NAMELEN], *ptr, *port_ptr;
2103 * Shutdown the active I_T nexus if 'NULL' is passed..
2105 if (!strncmp(page, "NULL", 4)) {
2106 ret = vhost_scsi_drop_nexus(tpg);
2107 return (!ret) ? count : ret;
2110 * Otherwise make sure the passed virtual Initiator port WWN matches
2111 * the fabric protocol_id set in vhost_scsi_make_tport(), and call
2112 * vhost_scsi_make_nexus().
2114 if (strlen(page) >= VHOST_SCSI_NAMELEN) {
2115 pr_err("Emulated NAA Sas Address: %s, exceeds"
2116 " max: %d\n", page, VHOST_SCSI_NAMELEN);
2119 snprintf(&i_port[0], VHOST_SCSI_NAMELEN, "%s", page);
2121 ptr = strstr(i_port, "naa.");
2123 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_SAS) {
2124 pr_err("Passed SAS Initiator Port %s does not"
2125 " match target port protoid: %s\n", i_port,
2126 vhost_scsi_dump_proto_id(tport_wwn));
2129 port_ptr = &i_port[0];
2132 ptr = strstr(i_port, "fc.");
2134 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_FCP) {
2135 pr_err("Passed FCP Initiator Port %s does not"
2136 " match target port protoid: %s\n", i_port,
2137 vhost_scsi_dump_proto_id(tport_wwn));
2140 port_ptr = &i_port[3]; /* Skip over "fc." */
2143 ptr = strstr(i_port, "iqn.");
2145 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_ISCSI) {
2146 pr_err("Passed iSCSI Initiator Port %s does not"
2147 " match target port protoid: %s\n", i_port,
2148 vhost_scsi_dump_proto_id(tport_wwn));
2151 port_ptr = &i_port[0];
2154 pr_err("Unable to locate prefix for emulated Initiator Port:"
2158 * Clear any trailing newline for the NAA WWN
2161 if (i_port[strlen(i_port)-1] == '\n')
2162 i_port[strlen(i_port)-1] = '\0';
2164 ret = vhost_scsi_make_nexus(tpg, port_ptr);
2171 TF_TPG_BASE_ATTR(vhost_scsi, nexus, S_IRUGO | S_IWUSR);
2173 static struct configfs_attribute *vhost_scsi_tpg_attrs[] = {
2174 &vhost_scsi_tpg_nexus.attr,
2178 static struct se_portal_group *
2179 vhost_scsi_make_tpg(struct se_wwn *wwn,
2180 struct config_group *group,
2183 struct vhost_scsi_tport *tport = container_of(wwn,
2184 struct vhost_scsi_tport, tport_wwn);
2186 struct vhost_scsi_tpg *tpg;
2190 if (strstr(name, "tpgt_") != name)
2191 return ERR_PTR(-EINVAL);
2192 if (kstrtou16(name + 5, 10, &tpgt) || tpgt >= VHOST_SCSI_MAX_TARGET)
2193 return ERR_PTR(-EINVAL);
2195 tpg = kzalloc(sizeof(struct vhost_scsi_tpg), GFP_KERNEL);
2197 pr_err("Unable to allocate struct vhost_scsi_tpg");
2198 return ERR_PTR(-ENOMEM);
2200 mutex_init(&tpg->tv_tpg_mutex);
2201 INIT_LIST_HEAD(&tpg->tv_tpg_list);
2203 tpg->tport_tpgt = tpgt;
2205 ret = core_tpg_register(&vhost_scsi_ops, wwn,
2206 &tpg->se_tpg, tpg, TRANSPORT_TPG_TYPE_NORMAL);
2211 mutex_lock(&vhost_scsi_mutex);
2212 list_add_tail(&tpg->tv_tpg_list, &vhost_scsi_list);
2213 mutex_unlock(&vhost_scsi_mutex);
2215 return &tpg->se_tpg;
2218 static void vhost_scsi_drop_tpg(struct se_portal_group *se_tpg)
2220 struct vhost_scsi_tpg *tpg = container_of(se_tpg,
2221 struct vhost_scsi_tpg, se_tpg);
2223 mutex_lock(&vhost_scsi_mutex);
2224 list_del(&tpg->tv_tpg_list);
2225 mutex_unlock(&vhost_scsi_mutex);
2227 * Release the virtual I_T Nexus for this vhost TPG
2229 vhost_scsi_drop_nexus(tpg);
2231 * Deregister the se_tpg from TCM..
2233 core_tpg_deregister(se_tpg);
2237 static struct se_wwn *
2238 vhost_scsi_make_tport(struct target_fabric_configfs *tf,
2239 struct config_group *group,
2242 struct vhost_scsi_tport *tport;
2247 /* if (vhost_scsi_parse_wwn(name, &wwpn, 1) < 0)
2248 return ERR_PTR(-EINVAL); */
2250 tport = kzalloc(sizeof(struct vhost_scsi_tport), GFP_KERNEL);
2252 pr_err("Unable to allocate struct vhost_scsi_tport");
2253 return ERR_PTR(-ENOMEM);
2255 tport->tport_wwpn = wwpn;
2257 * Determine the emulated Protocol Identifier and Target Port Name
2258 * based on the incoming configfs directory name.
2260 ptr = strstr(name, "naa.");
2262 tport->tport_proto_id = SCSI_PROTOCOL_SAS;
2265 ptr = strstr(name, "fc.");
2267 tport->tport_proto_id = SCSI_PROTOCOL_FCP;
2268 off = 3; /* Skip over "fc." */
2271 ptr = strstr(name, "iqn.");
2273 tport->tport_proto_id = SCSI_PROTOCOL_ISCSI;
2277 pr_err("Unable to locate prefix for emulated Target Port:"
2280 return ERR_PTR(-EINVAL);
2283 if (strlen(name) >= VHOST_SCSI_NAMELEN) {
2284 pr_err("Emulated %s Address: %s, exceeds"
2285 " max: %d\n", name, vhost_scsi_dump_proto_id(tport),
2286 VHOST_SCSI_NAMELEN);
2288 return ERR_PTR(-EINVAL);
2290 snprintf(&tport->tport_name[0], VHOST_SCSI_NAMELEN, "%s", &name[off]);
2292 pr_debug("TCM_VHost_ConfigFS: Allocated emulated Target"
2293 " %s Address: %s\n", vhost_scsi_dump_proto_id(tport), name);
2295 return &tport->tport_wwn;
2298 static void vhost_scsi_drop_tport(struct se_wwn *wwn)
2300 struct vhost_scsi_tport *tport = container_of(wwn,
2301 struct vhost_scsi_tport, tport_wwn);
2303 pr_debug("TCM_VHost_ConfigFS: Deallocating emulated Target"
2304 " %s Address: %s\n", vhost_scsi_dump_proto_id(tport),
2311 vhost_scsi_wwn_show_attr_version(struct target_fabric_configfs *tf,
2314 return sprintf(page, "TCM_VHOST fabric module %s on %s/%s"
2315 "on "UTS_RELEASE"\n", VHOST_SCSI_VERSION, utsname()->sysname,
2316 utsname()->machine);
2319 TF_WWN_ATTR_RO(vhost_scsi, version);
2321 static struct configfs_attribute *vhost_scsi_wwn_attrs[] = {
2322 &vhost_scsi_wwn_version.attr,
2326 static struct target_core_fabric_ops vhost_scsi_ops = {
2327 .module = THIS_MODULE,
2329 .get_fabric_name = vhost_scsi_get_fabric_name,
2330 .get_fabric_proto_ident = vhost_scsi_get_fabric_proto_ident,
2331 .tpg_get_wwn = vhost_scsi_get_fabric_wwn,
2332 .tpg_get_tag = vhost_scsi_get_tpgt,
2333 .tpg_get_default_depth = vhost_scsi_get_default_depth,
2334 .tpg_get_pr_transport_id = vhost_scsi_get_pr_transport_id,
2335 .tpg_get_pr_transport_id_len = vhost_scsi_get_pr_transport_id_len,
2336 .tpg_parse_pr_out_transport_id = vhost_scsi_parse_pr_out_transport_id,
2337 .tpg_check_demo_mode = vhost_scsi_check_true,
2338 .tpg_check_demo_mode_cache = vhost_scsi_check_true,
2339 .tpg_check_demo_mode_write_protect = vhost_scsi_check_false,
2340 .tpg_check_prod_mode_write_protect = vhost_scsi_check_false,
2341 .tpg_check_prot_fabric_only = vhost_scsi_check_prot_fabric_only,
2342 .tpg_alloc_fabric_acl = vhost_scsi_alloc_fabric_acl,
2343 .tpg_release_fabric_acl = vhost_scsi_release_fabric_acl,
2344 .tpg_get_inst_index = vhost_scsi_tpg_get_inst_index,
2345 .release_cmd = vhost_scsi_release_cmd,
2346 .check_stop_free = vhost_scsi_check_stop_free,
2347 .shutdown_session = vhost_scsi_shutdown_session,
2348 .close_session = vhost_scsi_close_session,
2349 .sess_get_index = vhost_scsi_sess_get_index,
2350 .sess_get_initiator_sid = NULL,
2351 .write_pending = vhost_scsi_write_pending,
2352 .write_pending_status = vhost_scsi_write_pending_status,
2353 .set_default_node_attributes = vhost_scsi_set_default_node_attrs,
2354 .get_task_tag = vhost_scsi_get_task_tag,
2355 .get_cmd_state = vhost_scsi_get_cmd_state,
2356 .queue_data_in = vhost_scsi_queue_data_in,
2357 .queue_status = vhost_scsi_queue_status,
2358 .queue_tm_rsp = vhost_scsi_queue_tm_rsp,
2359 .aborted_task = vhost_scsi_aborted_task,
2361 * Setup callers for generic logic in target_core_fabric_configfs.c
2363 .fabric_make_wwn = vhost_scsi_make_tport,
2364 .fabric_drop_wwn = vhost_scsi_drop_tport,
2365 .fabric_make_tpg = vhost_scsi_make_tpg,
2366 .fabric_drop_tpg = vhost_scsi_drop_tpg,
2367 .fabric_post_link = vhost_scsi_port_link,
2368 .fabric_pre_unlink = vhost_scsi_port_unlink,
2369 .fabric_make_np = NULL,
2370 .fabric_drop_np = NULL,
2371 .fabric_make_nodeacl = vhost_scsi_make_nodeacl,
2372 .fabric_drop_nodeacl = vhost_scsi_drop_nodeacl,
2374 .tfc_wwn_attrs = vhost_scsi_wwn_attrs,
2375 .tfc_tpg_base_attrs = vhost_scsi_tpg_attrs,
2376 .tfc_tpg_attrib_attrs = vhost_scsi_tpg_attrib_attrs,
2379 static int __init vhost_scsi_init(void)
2383 pr_debug("TCM_VHOST fabric module %s on %s/%s"
2384 " on "UTS_RELEASE"\n", VHOST_SCSI_VERSION, utsname()->sysname,
2385 utsname()->machine);
2388 * Use our own dedicated workqueue for submitting I/O into
2389 * target core to avoid contention within system_wq.
2391 vhost_scsi_workqueue = alloc_workqueue("vhost_scsi", 0, 0);
2392 if (!vhost_scsi_workqueue)
2395 ret = vhost_scsi_register();
2397 goto out_destroy_workqueue;
2399 ret = target_register_template(&vhost_scsi_ops);
2401 goto out_vhost_scsi_deregister;
2405 out_vhost_scsi_deregister:
2406 vhost_scsi_deregister();
2407 out_destroy_workqueue:
2408 destroy_workqueue(vhost_scsi_workqueue);
2413 static void vhost_scsi_exit(void)
2415 target_unregister_template(&vhost_scsi_ops);
2416 vhost_scsi_deregister();
2417 destroy_workqueue(vhost_scsi_workqueue);
2420 MODULE_DESCRIPTION("VHOST_SCSI series fabric driver");
2421 MODULE_ALIAS("tcm_vhost");
2422 MODULE_LICENSE("GPL");
2423 module_init(vhost_scsi_init);
2424 module_exit(vhost_scsi_exit);