1 /*******************************************************************************
2 * Vhost kernel TCM fabric driver for virtio SCSI initiators
4 * (C) Copyright 2010-2013 Datera, Inc.
5 * (C) Copyright 2010-2012 IBM Corp.
7 * Licensed to the Linux Foundation under the General Public License (GPL) version 2.
9 * Authors: Nicholas A. Bellinger <nab@daterainc.com>
10 * Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 ****************************************************************************/
24 #include <linux/module.h>
25 #include <linux/moduleparam.h>
26 #include <generated/utsrelease.h>
27 #include <linux/utsname.h>
28 #include <linux/init.h>
29 #include <linux/slab.h>
30 #include <linux/kthread.h>
31 #include <linux/types.h>
32 #include <linux/string.h>
33 #include <linux/configfs.h>
34 #include <linux/ctype.h>
35 #include <linux/compat.h>
36 #include <linux/eventfd.h>
38 #include <linux/miscdevice.h>
39 #include <asm/unaligned.h>
40 #include <scsi/scsi.h>
41 #include <target/target_core_base.h>
42 #include <target/target_core_fabric.h>
43 #include <target/target_core_fabric_configfs.h>
44 #include <target/target_core_configfs.h>
45 #include <target/configfs_macros.h>
46 #include <linux/vhost.h>
47 #include <linux/virtio_scsi.h>
48 #include <linux/llist.h>
49 #include <linux/bitmap.h>
50 #include <linux/percpu_ida.h>
54 #define VHOST_SCSI_VERSION "v0.1"
55 #define VHOST_SCSI_NAMELEN 256
56 #define VHOST_SCSI_MAX_CDB_SIZE 32
57 #define VHOST_SCSI_DEFAULT_TAGS 256
58 #define VHOST_SCSI_PREALLOC_SGLS 2048
59 #define VHOST_SCSI_PREALLOC_UPAGES 2048
60 #define VHOST_SCSI_PREALLOC_PROT_SGLS 512
62 struct vhost_scsi_inflight
{
63 /* Wait for the flush operation to finish */
64 struct completion comp
;
65 /* Refcount for the inflight reqs */
69 struct vhost_scsi_cmd
{
70 /* Descriptor from vhost_get_vq_desc() for virt_queue segment */
72 /* virtio-scsi initiator task attribute */
74 /* virtio-scsi response incoming iovecs */
76 /* virtio-scsi initiator data direction */
77 enum dma_data_direction tvc_data_direction
;
78 /* Expected data transfer length from virtio-scsi header */
80 /* The Tag from include/linux/virtio_scsi.h:struct virtio_scsi_cmd_req */
82 /* The number of scatterlists associated with this cmd */
84 u32 tvc_prot_sgl_count
;
85 /* Saved unpacked SCSI LUN for vhost_scsi_submission_work() */
87 /* Pointer to the SGL formatted memory from virtio-scsi */
88 struct scatterlist
*tvc_sgl
;
89 struct scatterlist
*tvc_prot_sgl
;
90 struct page
**tvc_upages
;
91 /* Pointer to response header iovec */
92 struct iovec
*tvc_resp_iov
;
93 /* Pointer to vhost_scsi for our device */
94 struct vhost_scsi
*tvc_vhost
;
95 /* Pointer to vhost_virtqueue for the cmd */
96 struct vhost_virtqueue
*tvc_vq
;
97 /* Pointer to vhost nexus memory */
98 struct vhost_scsi_nexus
*tvc_nexus
;
99 /* The TCM I/O descriptor that is accessed via container_of() */
100 struct se_cmd tvc_se_cmd
;
101 /* work item used for cmwq dispatch to vhost_scsi_submission_work() */
102 struct work_struct work
;
103 /* Copy of the incoming SCSI command descriptor block (CDB) */
104 unsigned char tvc_cdb
[VHOST_SCSI_MAX_CDB_SIZE
];
105 /* Sense buffer that will be mapped into outgoing status */
106 unsigned char tvc_sense_buf
[TRANSPORT_SENSE_BUFFER
];
107 /* Completed commands list, serviced from vhost worker thread */
108 struct llist_node tvc_completion_list
;
109 /* Used to track inflight cmd */
110 struct vhost_scsi_inflight
*inflight
;
113 struct vhost_scsi_nexus
{
114 /* Pointer to TCM session for I_T Nexus */
115 struct se_session
*tvn_se_sess
;
118 struct vhost_scsi_nacl
{
119 /* Binary World Wide unique Port Name for Vhost Initiator port */
121 /* ASCII formatted WWPN for Sas Initiator port */
122 char iport_name
[VHOST_SCSI_NAMELEN
];
123 /* Returned by vhost_scsi_make_nodeacl() */
124 struct se_node_acl se_node_acl
;
127 struct vhost_scsi_tpg
{
128 /* Vhost port target portal group tag for TCM */
130 /* Used to track number of TPG Port/Lun Links wrt to explict I_T Nexus shutdown */
131 int tv_tpg_port_count
;
132 /* Used for vhost_scsi device reference to tpg_nexus, protected by tv_tpg_mutex */
133 int tv_tpg_vhost_count
;
134 /* Used for enabling T10-PI with legacy devices */
135 int tv_fabric_prot_type
;
136 /* list for vhost_scsi_list */
137 struct list_head tv_tpg_list
;
138 /* Used to protect access for tpg_nexus */
139 struct mutex tv_tpg_mutex
;
140 /* Pointer to the TCM VHost I_T Nexus for this TPG endpoint */
141 struct vhost_scsi_nexus
*tpg_nexus
;
142 /* Pointer back to vhost_scsi_tport */
143 struct vhost_scsi_tport
*tport
;
144 /* Returned by vhost_scsi_make_tpg() */
145 struct se_portal_group se_tpg
;
146 /* Pointer back to vhost_scsi, protected by tv_tpg_mutex */
147 struct vhost_scsi
*vhost_scsi
;
150 struct vhost_scsi_tport
{
151 /* SCSI protocol the tport is providing */
153 /* Binary World Wide unique Port Name for Vhost Target port */
155 /* ASCII formatted WWPN for Vhost Target port */
156 char tport_name
[VHOST_SCSI_NAMELEN
];
157 /* Returned by vhost_scsi_make_tport() */
158 struct se_wwn tport_wwn
;
161 struct vhost_scsi_evt
{
162 /* event to be sent to guest */
163 struct virtio_scsi_event event
;
164 /* event list, serviced from vhost worker thread */
165 struct llist_node list
;
169 VHOST_SCSI_VQ_CTL
= 0,
170 VHOST_SCSI_VQ_EVT
= 1,
171 VHOST_SCSI_VQ_IO
= 2,
174 /* Note: can't set VIRTIO_F_VERSION_1 yet, since that implies ANY_LAYOUT. */
176 VHOST_SCSI_FEATURES
= VHOST_FEATURES
| (1ULL << VIRTIO_SCSI_F_HOTPLUG
) |
177 (1ULL << VIRTIO_SCSI_F_T10_PI
) |
178 (1ULL << VIRTIO_F_ANY_LAYOUT
) |
179 (1ULL << VIRTIO_F_VERSION_1
)
182 #define VHOST_SCSI_MAX_TARGET 256
183 #define VHOST_SCSI_MAX_VQ 128
184 #define VHOST_SCSI_MAX_EVENT 128
186 struct vhost_scsi_virtqueue
{
187 struct vhost_virtqueue vq
;
189 * Reference counting for inflight reqs, used for flush operation. At
190 * each time, one reference tracks new commands submitted, while we
191 * wait for another one to reach 0.
193 struct vhost_scsi_inflight inflights
[2];
195 * Indicate current inflight in use, protected by vq->mutex.
196 * Writers must also take dev mutex and flush under it.
202 /* Protected by vhost_scsi->dev.mutex */
203 struct vhost_scsi_tpg
**vs_tpg
;
204 char vs_vhost_wwpn
[TRANSPORT_IQN_LEN
];
206 struct vhost_dev dev
;
207 struct vhost_scsi_virtqueue vqs
[VHOST_SCSI_MAX_VQ
];
209 struct vhost_work vs_completion_work
; /* cmd completion work item */
210 struct llist_head vs_completion_list
; /* cmd completion queue */
212 struct vhost_work vs_event_work
; /* evt injection work item */
213 struct llist_head vs_event_list
; /* evt injection queue */
215 bool vs_events_missed
; /* any missed events, protected by vq->mutex */
216 int vs_events_nr
; /* num of pending events, protected by vq->mutex */
219 static struct target_core_fabric_ops vhost_scsi_ops
;
220 static struct workqueue_struct
*vhost_scsi_workqueue
;
222 /* Global spinlock to protect vhost_scsi TPG list for vhost IOCTL access */
223 static DEFINE_MUTEX(vhost_scsi_mutex
);
224 static LIST_HEAD(vhost_scsi_list
);
226 static int iov_num_pages(void __user
*iov_base
, size_t iov_len
)
228 return (PAGE_ALIGN((unsigned long)iov_base
+ iov_len
) -
229 ((unsigned long)iov_base
& PAGE_MASK
)) >> PAGE_SHIFT
;
232 static void vhost_scsi_done_inflight(struct kref
*kref
)
234 struct vhost_scsi_inflight
*inflight
;
236 inflight
= container_of(kref
, struct vhost_scsi_inflight
, kref
);
237 complete(&inflight
->comp
);
240 static void vhost_scsi_init_inflight(struct vhost_scsi
*vs
,
241 struct vhost_scsi_inflight
*old_inflight
[])
243 struct vhost_scsi_inflight
*new_inflight
;
244 struct vhost_virtqueue
*vq
;
247 for (i
= 0; i
< VHOST_SCSI_MAX_VQ
; i
++) {
250 mutex_lock(&vq
->mutex
);
252 /* store old infight */
253 idx
= vs
->vqs
[i
].inflight_idx
;
255 old_inflight
[i
] = &vs
->vqs
[i
].inflights
[idx
];
257 /* setup new infight */
258 vs
->vqs
[i
].inflight_idx
= idx
^ 1;
259 new_inflight
= &vs
->vqs
[i
].inflights
[idx
^ 1];
260 kref_init(&new_inflight
->kref
);
261 init_completion(&new_inflight
->comp
);
263 mutex_unlock(&vq
->mutex
);
267 static struct vhost_scsi_inflight
*
268 vhost_scsi_get_inflight(struct vhost_virtqueue
*vq
)
270 struct vhost_scsi_inflight
*inflight
;
271 struct vhost_scsi_virtqueue
*svq
;
273 svq
= container_of(vq
, struct vhost_scsi_virtqueue
, vq
);
274 inflight
= &svq
->inflights
[svq
->inflight_idx
];
275 kref_get(&inflight
->kref
);
280 static void vhost_scsi_put_inflight(struct vhost_scsi_inflight
*inflight
)
282 kref_put(&inflight
->kref
, vhost_scsi_done_inflight
);
285 static int vhost_scsi_check_true(struct se_portal_group
*se_tpg
)
290 static int vhost_scsi_check_false(struct se_portal_group
*se_tpg
)
295 static char *vhost_scsi_get_fabric_name(void)
300 static u8
vhost_scsi_get_fabric_proto_ident(struct se_portal_group
*se_tpg
)
302 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
303 struct vhost_scsi_tpg
, se_tpg
);
304 struct vhost_scsi_tport
*tport
= tpg
->tport
;
306 switch (tport
->tport_proto_id
) {
307 case SCSI_PROTOCOL_SAS
:
308 return sas_get_fabric_proto_ident(se_tpg
);
309 case SCSI_PROTOCOL_FCP
:
310 return fc_get_fabric_proto_ident(se_tpg
);
311 case SCSI_PROTOCOL_ISCSI
:
312 return iscsi_get_fabric_proto_ident(se_tpg
);
314 pr_err("Unknown tport_proto_id: 0x%02x, using"
315 " SAS emulation\n", tport
->tport_proto_id
);
319 return sas_get_fabric_proto_ident(se_tpg
);
322 static char *vhost_scsi_get_fabric_wwn(struct se_portal_group
*se_tpg
)
324 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
325 struct vhost_scsi_tpg
, se_tpg
);
326 struct vhost_scsi_tport
*tport
= tpg
->tport
;
328 return &tport
->tport_name
[0];
331 static u16
vhost_scsi_get_tpgt(struct se_portal_group
*se_tpg
)
333 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
334 struct vhost_scsi_tpg
, se_tpg
);
335 return tpg
->tport_tpgt
;
338 static u32
vhost_scsi_get_default_depth(struct se_portal_group
*se_tpg
)
344 vhost_scsi_get_pr_transport_id(struct se_portal_group
*se_tpg
,
345 struct se_node_acl
*se_nacl
,
346 struct t10_pr_registration
*pr_reg
,
350 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
351 struct vhost_scsi_tpg
, se_tpg
);
352 struct vhost_scsi_tport
*tport
= tpg
->tport
;
354 switch (tport
->tport_proto_id
) {
355 case SCSI_PROTOCOL_SAS
:
356 return sas_get_pr_transport_id(se_tpg
, se_nacl
, pr_reg
,
358 case SCSI_PROTOCOL_FCP
:
359 return fc_get_pr_transport_id(se_tpg
, se_nacl
, pr_reg
,
361 case SCSI_PROTOCOL_ISCSI
:
362 return iscsi_get_pr_transport_id(se_tpg
, se_nacl
, pr_reg
,
365 pr_err("Unknown tport_proto_id: 0x%02x, using"
366 " SAS emulation\n", tport
->tport_proto_id
);
370 return sas_get_pr_transport_id(se_tpg
, se_nacl
, pr_reg
,
375 vhost_scsi_get_pr_transport_id_len(struct se_portal_group
*se_tpg
,
376 struct se_node_acl
*se_nacl
,
377 struct t10_pr_registration
*pr_reg
,
380 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
381 struct vhost_scsi_tpg
, se_tpg
);
382 struct vhost_scsi_tport
*tport
= tpg
->tport
;
384 switch (tport
->tport_proto_id
) {
385 case SCSI_PROTOCOL_SAS
:
386 return sas_get_pr_transport_id_len(se_tpg
, se_nacl
, pr_reg
,
388 case SCSI_PROTOCOL_FCP
:
389 return fc_get_pr_transport_id_len(se_tpg
, se_nacl
, pr_reg
,
391 case SCSI_PROTOCOL_ISCSI
:
392 return iscsi_get_pr_transport_id_len(se_tpg
, se_nacl
, pr_reg
,
395 pr_err("Unknown tport_proto_id: 0x%02x, using"
396 " SAS emulation\n", tport
->tport_proto_id
);
400 return sas_get_pr_transport_id_len(se_tpg
, se_nacl
, pr_reg
,
405 vhost_scsi_parse_pr_out_transport_id(struct se_portal_group
*se_tpg
,
408 char **port_nexus_ptr
)
410 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
411 struct vhost_scsi_tpg
, se_tpg
);
412 struct vhost_scsi_tport
*tport
= tpg
->tport
;
414 switch (tport
->tport_proto_id
) {
415 case SCSI_PROTOCOL_SAS
:
416 return sas_parse_pr_out_transport_id(se_tpg
, buf
, out_tid_len
,
418 case SCSI_PROTOCOL_FCP
:
419 return fc_parse_pr_out_transport_id(se_tpg
, buf
, out_tid_len
,
421 case SCSI_PROTOCOL_ISCSI
:
422 return iscsi_parse_pr_out_transport_id(se_tpg
, buf
, out_tid_len
,
425 pr_err("Unknown tport_proto_id: 0x%02x, using"
426 " SAS emulation\n", tport
->tport_proto_id
);
430 return sas_parse_pr_out_transport_id(se_tpg
, buf
, out_tid_len
,
434 static int vhost_scsi_check_prot_fabric_only(struct se_portal_group
*se_tpg
)
436 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
437 struct vhost_scsi_tpg
, se_tpg
);
439 return tpg
->tv_fabric_prot_type
;
442 static struct se_node_acl
*
443 vhost_scsi_alloc_fabric_acl(struct se_portal_group
*se_tpg
)
445 struct vhost_scsi_nacl
*nacl
;
447 nacl
= kzalloc(sizeof(struct vhost_scsi_nacl
), GFP_KERNEL
);
449 pr_err("Unable to allocate struct vhost_scsi_nacl\n");
453 return &nacl
->se_node_acl
;
457 vhost_scsi_release_fabric_acl(struct se_portal_group
*se_tpg
,
458 struct se_node_acl
*se_nacl
)
460 struct vhost_scsi_nacl
*nacl
= container_of(se_nacl
,
461 struct vhost_scsi_nacl
, se_node_acl
);
465 static u32
vhost_scsi_tpg_get_inst_index(struct se_portal_group
*se_tpg
)
470 static void vhost_scsi_release_cmd(struct se_cmd
*se_cmd
)
472 struct vhost_scsi_cmd
*tv_cmd
= container_of(se_cmd
,
473 struct vhost_scsi_cmd
, tvc_se_cmd
);
474 struct se_session
*se_sess
= tv_cmd
->tvc_nexus
->tvn_se_sess
;
477 if (tv_cmd
->tvc_sgl_count
) {
478 for (i
= 0; i
< tv_cmd
->tvc_sgl_count
; i
++)
479 put_page(sg_page(&tv_cmd
->tvc_sgl
[i
]));
481 if (tv_cmd
->tvc_prot_sgl_count
) {
482 for (i
= 0; i
< tv_cmd
->tvc_prot_sgl_count
; i
++)
483 put_page(sg_page(&tv_cmd
->tvc_prot_sgl
[i
]));
486 vhost_scsi_put_inflight(tv_cmd
->inflight
);
487 percpu_ida_free(&se_sess
->sess_tag_pool
, se_cmd
->map_tag
);
490 static int vhost_scsi_shutdown_session(struct se_session
*se_sess
)
495 static void vhost_scsi_close_session(struct se_session
*se_sess
)
500 static u32
vhost_scsi_sess_get_index(struct se_session
*se_sess
)
505 static int vhost_scsi_write_pending(struct se_cmd
*se_cmd
)
507 /* Go ahead and process the write immediately */
508 target_execute_cmd(se_cmd
);
512 static int vhost_scsi_write_pending_status(struct se_cmd
*se_cmd
)
517 static void vhost_scsi_set_default_node_attrs(struct se_node_acl
*nacl
)
522 static u32
vhost_scsi_get_task_tag(struct se_cmd
*se_cmd
)
527 static int vhost_scsi_get_cmd_state(struct se_cmd
*se_cmd
)
532 static void vhost_scsi_complete_cmd(struct vhost_scsi_cmd
*cmd
)
534 struct vhost_scsi
*vs
= cmd
->tvc_vhost
;
536 llist_add(&cmd
->tvc_completion_list
, &vs
->vs_completion_list
);
538 vhost_work_queue(&vs
->dev
, &vs
->vs_completion_work
);
541 static int vhost_scsi_queue_data_in(struct se_cmd
*se_cmd
)
543 struct vhost_scsi_cmd
*cmd
= container_of(se_cmd
,
544 struct vhost_scsi_cmd
, tvc_se_cmd
);
545 vhost_scsi_complete_cmd(cmd
);
549 static int vhost_scsi_queue_status(struct se_cmd
*se_cmd
)
551 struct vhost_scsi_cmd
*cmd
= container_of(se_cmd
,
552 struct vhost_scsi_cmd
, tvc_se_cmd
);
553 vhost_scsi_complete_cmd(cmd
);
557 static void vhost_scsi_queue_tm_rsp(struct se_cmd
*se_cmd
)
562 static void vhost_scsi_aborted_task(struct se_cmd
*se_cmd
)
567 static void vhost_scsi_free_evt(struct vhost_scsi
*vs
, struct vhost_scsi_evt
*evt
)
573 static struct vhost_scsi_evt
*
574 vhost_scsi_allocate_evt(struct vhost_scsi
*vs
,
575 u32 event
, u32 reason
)
577 struct vhost_virtqueue
*vq
= &vs
->vqs
[VHOST_SCSI_VQ_EVT
].vq
;
578 struct vhost_scsi_evt
*evt
;
580 if (vs
->vs_events_nr
> VHOST_SCSI_MAX_EVENT
) {
581 vs
->vs_events_missed
= true;
585 evt
= kzalloc(sizeof(*evt
), GFP_KERNEL
);
587 vq_err(vq
, "Failed to allocate vhost_scsi_evt\n");
588 vs
->vs_events_missed
= true;
592 evt
->event
.event
= cpu_to_vhost32(vq
, event
);
593 evt
->event
.reason
= cpu_to_vhost32(vq
, reason
);
599 static void vhost_scsi_free_cmd(struct vhost_scsi_cmd
*cmd
)
601 struct se_cmd
*se_cmd
= &cmd
->tvc_se_cmd
;
603 /* TODO locking against target/backend threads? */
604 transport_generic_free_cmd(se_cmd
, 0);
608 static int vhost_scsi_check_stop_free(struct se_cmd
*se_cmd
)
610 return target_put_sess_cmd(se_cmd
->se_sess
, se_cmd
);
614 vhost_scsi_do_evt_work(struct vhost_scsi
*vs
, struct vhost_scsi_evt
*evt
)
616 struct vhost_virtqueue
*vq
= &vs
->vqs
[VHOST_SCSI_VQ_EVT
].vq
;
617 struct virtio_scsi_event
*event
= &evt
->event
;
618 struct virtio_scsi_event __user
*eventp
;
622 if (!vq
->private_data
) {
623 vs
->vs_events_missed
= true;
628 vhost_disable_notify(&vs
->dev
, vq
);
629 head
= vhost_get_vq_desc(vq
, vq
->iov
,
630 ARRAY_SIZE(vq
->iov
), &out
, &in
,
633 vs
->vs_events_missed
= true;
636 if (head
== vq
->num
) {
637 if (vhost_enable_notify(&vs
->dev
, vq
))
639 vs
->vs_events_missed
= true;
643 if ((vq
->iov
[out
].iov_len
!= sizeof(struct virtio_scsi_event
))) {
644 vq_err(vq
, "Expecting virtio_scsi_event, got %zu bytes\n",
645 vq
->iov
[out
].iov_len
);
646 vs
->vs_events_missed
= true;
650 if (vs
->vs_events_missed
) {
651 event
->event
|= cpu_to_vhost32(vq
, VIRTIO_SCSI_T_EVENTS_MISSED
);
652 vs
->vs_events_missed
= false;
655 eventp
= vq
->iov
[out
].iov_base
;
656 ret
= __copy_to_user(eventp
, event
, sizeof(*event
));
658 vhost_add_used_and_signal(&vs
->dev
, vq
, head
, 0);
660 vq_err(vq
, "Faulted on vhost_scsi_send_event\n");
663 static void vhost_scsi_evt_work(struct vhost_work
*work
)
665 struct vhost_scsi
*vs
= container_of(work
, struct vhost_scsi
,
667 struct vhost_virtqueue
*vq
= &vs
->vqs
[VHOST_SCSI_VQ_EVT
].vq
;
668 struct vhost_scsi_evt
*evt
;
669 struct llist_node
*llnode
;
671 mutex_lock(&vq
->mutex
);
672 llnode
= llist_del_all(&vs
->vs_event_list
);
674 evt
= llist_entry(llnode
, struct vhost_scsi_evt
, list
);
675 llnode
= llist_next(llnode
);
676 vhost_scsi_do_evt_work(vs
, evt
);
677 vhost_scsi_free_evt(vs
, evt
);
679 mutex_unlock(&vq
->mutex
);
682 /* Fill in status and signal that we are done processing this command
684 * This is scheduled in the vhost work queue so we are called with the owner
685 * process mm and can access the vring.
687 static void vhost_scsi_complete_cmd_work(struct vhost_work
*work
)
689 struct vhost_scsi
*vs
= container_of(work
, struct vhost_scsi
,
691 DECLARE_BITMAP(signal
, VHOST_SCSI_MAX_VQ
);
692 struct virtio_scsi_cmd_resp v_rsp
;
693 struct vhost_scsi_cmd
*cmd
;
694 struct llist_node
*llnode
;
695 struct se_cmd
*se_cmd
;
696 struct iov_iter iov_iter
;
699 bitmap_zero(signal
, VHOST_SCSI_MAX_VQ
);
700 llnode
= llist_del_all(&vs
->vs_completion_list
);
702 cmd
= llist_entry(llnode
, struct vhost_scsi_cmd
,
703 tvc_completion_list
);
704 llnode
= llist_next(llnode
);
705 se_cmd
= &cmd
->tvc_se_cmd
;
707 pr_debug("%s tv_cmd %p resid %u status %#02x\n", __func__
,
708 cmd
, se_cmd
->residual_count
, se_cmd
->scsi_status
);
710 memset(&v_rsp
, 0, sizeof(v_rsp
));
711 v_rsp
.resid
= cpu_to_vhost32(cmd
->tvc_vq
, se_cmd
->residual_count
);
712 /* TODO is status_qualifier field needed? */
713 v_rsp
.status
= se_cmd
->scsi_status
;
714 v_rsp
.sense_len
= cpu_to_vhost32(cmd
->tvc_vq
,
715 se_cmd
->scsi_sense_length
);
716 memcpy(v_rsp
.sense
, cmd
->tvc_sense_buf
,
717 se_cmd
->scsi_sense_length
);
719 iov_iter_init(&iov_iter
, READ
, cmd
->tvc_resp_iov
,
720 cmd
->tvc_in_iovs
, sizeof(v_rsp
));
721 ret
= copy_to_iter(&v_rsp
, sizeof(v_rsp
), &iov_iter
);
722 if (likely(ret
== sizeof(v_rsp
))) {
723 struct vhost_scsi_virtqueue
*q
;
724 vhost_add_used(cmd
->tvc_vq
, cmd
->tvc_vq_desc
, 0);
725 q
= container_of(cmd
->tvc_vq
, struct vhost_scsi_virtqueue
, vq
);
727 __set_bit(vq
, signal
);
729 pr_err("Faulted on virtio_scsi_cmd_resp\n");
731 vhost_scsi_free_cmd(cmd
);
735 while ((vq
= find_next_bit(signal
, VHOST_SCSI_MAX_VQ
, vq
+ 1))
737 vhost_signal(&vs
->dev
, &vs
->vqs
[vq
].vq
);
740 static struct vhost_scsi_cmd
*
741 vhost_scsi_get_tag(struct vhost_virtqueue
*vq
, struct vhost_scsi_tpg
*tpg
,
742 unsigned char *cdb
, u64 scsi_tag
, u16 lun
, u8 task_attr
,
743 u32 exp_data_len
, int data_direction
)
745 struct vhost_scsi_cmd
*cmd
;
746 struct vhost_scsi_nexus
*tv_nexus
;
747 struct se_session
*se_sess
;
748 struct scatterlist
*sg
, *prot_sg
;
752 tv_nexus
= tpg
->tpg_nexus
;
754 pr_err("Unable to locate active struct vhost_scsi_nexus\n");
755 return ERR_PTR(-EIO
);
757 se_sess
= tv_nexus
->tvn_se_sess
;
759 tag
= percpu_ida_alloc(&se_sess
->sess_tag_pool
, TASK_RUNNING
);
761 pr_err("Unable to obtain tag for vhost_scsi_cmd\n");
762 return ERR_PTR(-ENOMEM
);
765 cmd
= &((struct vhost_scsi_cmd
*)se_sess
->sess_cmd_map
)[tag
];
767 prot_sg
= cmd
->tvc_prot_sgl
;
768 pages
= cmd
->tvc_upages
;
769 memset(cmd
, 0, sizeof(struct vhost_scsi_cmd
));
772 cmd
->tvc_prot_sgl
= prot_sg
;
773 cmd
->tvc_upages
= pages
;
774 cmd
->tvc_se_cmd
.map_tag
= tag
;
775 cmd
->tvc_tag
= scsi_tag
;
777 cmd
->tvc_task_attr
= task_attr
;
778 cmd
->tvc_exp_data_len
= exp_data_len
;
779 cmd
->tvc_data_direction
= data_direction
;
780 cmd
->tvc_nexus
= tv_nexus
;
781 cmd
->inflight
= vhost_scsi_get_inflight(vq
);
783 memcpy(cmd
->tvc_cdb
, cdb
, VHOST_SCSI_MAX_CDB_SIZE
);
789 * Map a user memory range into a scatterlist
791 * Returns the number of scatterlist entries used or -errno on error.
794 vhost_scsi_map_to_sgl(struct vhost_scsi_cmd
*cmd
,
797 struct scatterlist
*sgl
,
800 unsigned int npages
= 0, offset
, nbytes
;
801 unsigned int pages_nr
= iov_num_pages(ptr
, len
);
802 struct scatterlist
*sg
= sgl
;
803 struct page
**pages
= cmd
->tvc_upages
;
806 if (pages_nr
> VHOST_SCSI_PREALLOC_UPAGES
) {
807 pr_err("vhost_scsi_map_to_sgl() pages_nr: %u greater than"
808 " preallocated VHOST_SCSI_PREALLOC_UPAGES: %u\n",
809 pages_nr
, VHOST_SCSI_PREALLOC_UPAGES
);
813 ret
= get_user_pages_fast((unsigned long)ptr
, pages_nr
, write
, pages
);
814 /* No pages were pinned */
817 /* Less pages pinned than wanted */
818 if (ret
!= pages_nr
) {
819 for (i
= 0; i
< ret
; i
++)
826 offset
= (uintptr_t)ptr
& ~PAGE_MASK
;
827 nbytes
= min_t(unsigned int, PAGE_SIZE
- offset
, len
);
828 sg_set_page(sg
, pages
[npages
], nbytes
, offset
);
840 vhost_scsi_calc_sgls(struct iov_iter
*iter
, size_t bytes
, int max_sgls
)
844 if (!iter
|| !iter
->iov
) {
845 pr_err("%s: iter->iov is NULL, but expected bytes: %zu"
846 " present\n", __func__
, bytes
);
850 sgl_count
= iov_iter_npages(iter
, 0xffff);
851 if (sgl_count
> max_sgls
) {
852 pr_err("%s: requested sgl_count: %d exceeds pre-allocated"
853 " max_sgls: %d\n", __func__
, sgl_count
, max_sgls
);
860 vhost_scsi_iov_to_sgl(struct vhost_scsi_cmd
*cmd
, bool write
,
861 struct iov_iter
*iter
,
862 struct scatterlist
*sg
, int sg_count
)
864 size_t off
= iter
->iov_offset
;
867 for (i
= 0; i
< iter
->nr_segs
; i
++) {
868 void __user
*base
= iter
->iov
[i
].iov_base
+ off
;
869 size_t len
= iter
->iov
[i
].iov_len
- off
;
871 ret
= vhost_scsi_map_to_sgl(cmd
, base
, len
, sg
, write
);
873 for (i
= 0; i
< sg_count
; i
++) {
874 struct page
*page
= sg_page(&sg
[i
]);
887 vhost_scsi_mapal(struct vhost_scsi_cmd
*cmd
,
888 size_t prot_bytes
, struct iov_iter
*prot_iter
,
889 size_t data_bytes
, struct iov_iter
*data_iter
)
892 bool write
= (cmd
->tvc_data_direction
== DMA_FROM_DEVICE
);
895 sgl_count
= vhost_scsi_calc_sgls(prot_iter
, prot_bytes
,
896 VHOST_SCSI_PREALLOC_PROT_SGLS
);
900 sg_init_table(cmd
->tvc_prot_sgl
, sgl_count
);
901 cmd
->tvc_prot_sgl_count
= sgl_count
;
902 pr_debug("%s prot_sg %p prot_sgl_count %u\n", __func__
,
903 cmd
->tvc_prot_sgl
, cmd
->tvc_prot_sgl_count
);
905 ret
= vhost_scsi_iov_to_sgl(cmd
, write
, prot_iter
,
907 cmd
->tvc_prot_sgl_count
);
909 cmd
->tvc_prot_sgl_count
= 0;
913 sgl_count
= vhost_scsi_calc_sgls(data_iter
, data_bytes
,
914 VHOST_SCSI_PREALLOC_SGLS
);
918 sg_init_table(cmd
->tvc_sgl
, sgl_count
);
919 cmd
->tvc_sgl_count
= sgl_count
;
920 pr_debug("%s data_sg %p data_sgl_count %u\n", __func__
,
921 cmd
->tvc_sgl
, cmd
->tvc_sgl_count
);
923 ret
= vhost_scsi_iov_to_sgl(cmd
, write
, data_iter
,
924 cmd
->tvc_sgl
, cmd
->tvc_sgl_count
);
926 cmd
->tvc_sgl_count
= 0;
932 static int vhost_scsi_to_tcm_attr(int attr
)
935 case VIRTIO_SCSI_S_SIMPLE
:
936 return TCM_SIMPLE_TAG
;
937 case VIRTIO_SCSI_S_ORDERED
:
938 return TCM_ORDERED_TAG
;
939 case VIRTIO_SCSI_S_HEAD
:
941 case VIRTIO_SCSI_S_ACA
:
946 return TCM_SIMPLE_TAG
;
949 static void vhost_scsi_submission_work(struct work_struct
*work
)
951 struct vhost_scsi_cmd
*cmd
=
952 container_of(work
, struct vhost_scsi_cmd
, work
);
953 struct vhost_scsi_nexus
*tv_nexus
;
954 struct se_cmd
*se_cmd
= &cmd
->tvc_se_cmd
;
955 struct scatterlist
*sg_ptr
, *sg_prot_ptr
= NULL
;
958 /* FIXME: BIDI operation */
959 if (cmd
->tvc_sgl_count
) {
960 sg_ptr
= cmd
->tvc_sgl
;
962 if (cmd
->tvc_prot_sgl_count
)
963 sg_prot_ptr
= cmd
->tvc_prot_sgl
;
965 se_cmd
->prot_pto
= true;
969 tv_nexus
= cmd
->tvc_nexus
;
971 rc
= target_submit_cmd_map_sgls(se_cmd
, tv_nexus
->tvn_se_sess
,
972 cmd
->tvc_cdb
, &cmd
->tvc_sense_buf
[0],
973 cmd
->tvc_lun
, cmd
->tvc_exp_data_len
,
974 vhost_scsi_to_tcm_attr(cmd
->tvc_task_attr
),
975 cmd
->tvc_data_direction
, TARGET_SCF_ACK_KREF
,
976 sg_ptr
, cmd
->tvc_sgl_count
, NULL
, 0, sg_prot_ptr
,
977 cmd
->tvc_prot_sgl_count
);
979 transport_send_check_condition_and_sense(se_cmd
,
980 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
, 0);
981 transport_generic_free_cmd(se_cmd
, 0);
986 vhost_scsi_send_bad_target(struct vhost_scsi
*vs
,
987 struct vhost_virtqueue
*vq
,
988 int head
, unsigned out
)
990 struct virtio_scsi_cmd_resp __user
*resp
;
991 struct virtio_scsi_cmd_resp rsp
;
994 memset(&rsp
, 0, sizeof(rsp
));
995 rsp
.response
= VIRTIO_SCSI_S_BAD_TARGET
;
996 resp
= vq
->iov
[out
].iov_base
;
997 ret
= __copy_to_user(resp
, &rsp
, sizeof(rsp
));
999 vhost_add_used_and_signal(&vs
->dev
, vq
, head
, 0);
1001 pr_err("Faulted on virtio_scsi_cmd_resp\n");
1005 vhost_scsi_handle_vq(struct vhost_scsi
*vs
, struct vhost_virtqueue
*vq
)
1007 struct vhost_scsi_tpg
**vs_tpg
, *tpg
;
1008 struct virtio_scsi_cmd_req v_req
;
1009 struct virtio_scsi_cmd_req_pi v_req_pi
;
1010 struct vhost_scsi_cmd
*cmd
;
1011 struct iov_iter out_iter
, in_iter
, prot_iter
, data_iter
;
1013 u32 exp_data_len
, data_direction
;
1015 int head
, ret
, prot_bytes
;
1016 size_t req_size
, rsp_size
= sizeof(struct virtio_scsi_cmd_resp
);
1017 size_t out_size
, in_size
;
1019 u8
*target
, *lunp
, task_attr
;
1020 bool t10_pi
= vhost_has_feature(vq
, VIRTIO_SCSI_F_T10_PI
);
1023 mutex_lock(&vq
->mutex
);
1025 * We can handle the vq only after the endpoint is setup by calling the
1026 * VHOST_SCSI_SET_ENDPOINT ioctl.
1028 vs_tpg
= vq
->private_data
;
1032 vhost_disable_notify(&vs
->dev
, vq
);
1035 head
= vhost_get_vq_desc(vq
, vq
->iov
,
1036 ARRAY_SIZE(vq
->iov
), &out
, &in
,
1038 pr_debug("vhost_get_vq_desc: head: %d, out: %u in: %u\n",
1040 /* On error, stop handling until the next kick. */
1041 if (unlikely(head
< 0))
1043 /* Nothing new? Wait for eventfd to tell us they refilled. */
1044 if (head
== vq
->num
) {
1045 if (unlikely(vhost_enable_notify(&vs
->dev
, vq
))) {
1046 vhost_disable_notify(&vs
->dev
, vq
);
1052 * Check for a sane response buffer so we can report early
1053 * errors back to the guest.
1055 if (unlikely(vq
->iov
[out
].iov_len
< rsp_size
)) {
1056 vq_err(vq
, "Expecting at least virtio_scsi_cmd_resp"
1057 " size, got %zu bytes\n", vq
->iov
[out
].iov_len
);
1061 * Setup pointers and values based upon different virtio-scsi
1062 * request header if T10_PI is enabled in KVM guest.
1066 req_size
= sizeof(v_req_pi
);
1067 lunp
= &v_req_pi
.lun
[0];
1068 target
= &v_req_pi
.lun
[1];
1071 req_size
= sizeof(v_req
);
1072 lunp
= &v_req
.lun
[0];
1073 target
= &v_req
.lun
[1];
1076 * FIXME: Not correct for BIDI operation
1078 out_size
= iov_length(vq
->iov
, out
);
1079 in_size
= iov_length(&vq
->iov
[out
], in
);
1082 * Copy over the virtio-scsi request header, which for a
1083 * ANY_LAYOUT enabled guest may span multiple iovecs, or a
1084 * single iovec may contain both the header + outgoing
1087 * copy_from_iter() will advance out_iter, so that it will
1088 * point at the start of the outgoing WRITE payload, if
1089 * DMA_TO_DEVICE is set.
1091 iov_iter_init(&out_iter
, WRITE
, vq
->iov
, out
, out_size
);
1093 ret
= copy_from_iter(req
, req_size
, &out_iter
);
1094 if (unlikely(ret
!= req_size
)) {
1095 vq_err(vq
, "Faulted on copy_from_iter\n");
1096 vhost_scsi_send_bad_target(vs
, vq
, head
, out
);
1099 /* virtio-scsi spec requires byte 0 of the lun to be 1 */
1100 if (unlikely(*lunp
!= 1)) {
1101 vq_err(vq
, "Illegal virtio-scsi lun: %u\n", *lunp
);
1102 vhost_scsi_send_bad_target(vs
, vq
, head
, out
);
1106 tpg
= ACCESS_ONCE(vs_tpg
[*target
]);
1107 if (unlikely(!tpg
)) {
1108 /* Target does not exist, fail the request */
1109 vhost_scsi_send_bad_target(vs
, vq
, head
, out
);
1113 * Determine data_direction by calculating the total outgoing
1114 * iovec sizes + incoming iovec sizes vs. virtio-scsi request +
1115 * response headers respectively.
1117 * For DMA_TO_DEVICE this is out_iter, which is already pointing
1118 * to the right place.
1120 * For DMA_FROM_DEVICE, the iovec will be just past the end
1121 * of the virtio-scsi response header in either the same
1122 * or immediately following iovec.
1124 * Any associated T10_PI bytes for the outgoing / incoming
1125 * payloads are included in calculation of exp_data_len here.
1129 if (out_size
> req_size
) {
1130 data_direction
= DMA_TO_DEVICE
;
1131 exp_data_len
= out_size
- req_size
;
1132 data_iter
= out_iter
;
1133 } else if (in_size
> rsp_size
) {
1134 data_direction
= DMA_FROM_DEVICE
;
1135 exp_data_len
= in_size
- rsp_size
;
1137 iov_iter_init(&in_iter
, READ
, &vq
->iov
[out
], in
,
1138 rsp_size
+ exp_data_len
);
1139 iov_iter_advance(&in_iter
, rsp_size
);
1140 data_iter
= in_iter
;
1142 data_direction
= DMA_NONE
;
1146 * If T10_PI header + payload is present, setup prot_iter values
1147 * and recalculate data_iter for vhost_scsi_mapal() mapping to
1148 * host scatterlists via get_user_pages_fast().
1151 if (v_req_pi
.pi_bytesout
) {
1152 if (data_direction
!= DMA_TO_DEVICE
) {
1153 vq_err(vq
, "Received non zero pi_bytesout,"
1154 " but wrong data_direction\n");
1155 vhost_scsi_send_bad_target(vs
, vq
, head
, out
);
1158 prot_bytes
= vhost32_to_cpu(vq
, v_req_pi
.pi_bytesout
);
1159 } else if (v_req_pi
.pi_bytesin
) {
1160 if (data_direction
!= DMA_FROM_DEVICE
) {
1161 vq_err(vq
, "Received non zero pi_bytesin,"
1162 " but wrong data_direction\n");
1163 vhost_scsi_send_bad_target(vs
, vq
, head
, out
);
1166 prot_bytes
= vhost32_to_cpu(vq
, v_req_pi
.pi_bytesin
);
1169 * Set prot_iter to data_iter, and advance past any
1170 * preceeding prot_bytes that may be present.
1172 * Also fix up the exp_data_len to reflect only the
1173 * actual data payload length.
1176 exp_data_len
-= prot_bytes
;
1177 prot_iter
= data_iter
;
1178 iov_iter_advance(&data_iter
, prot_bytes
);
1180 tag
= vhost64_to_cpu(vq
, v_req_pi
.tag
);
1181 task_attr
= v_req_pi
.task_attr
;
1182 cdb
= &v_req_pi
.cdb
[0];
1183 lun
= ((v_req_pi
.lun
[2] << 8) | v_req_pi
.lun
[3]) & 0x3FFF;
1185 tag
= vhost64_to_cpu(vq
, v_req
.tag
);
1186 task_attr
= v_req
.task_attr
;
1187 cdb
= &v_req
.cdb
[0];
1188 lun
= ((v_req
.lun
[2] << 8) | v_req
.lun
[3]) & 0x3FFF;
1191 * Check that the received CDB size does not exceeded our
1192 * hardcoded max for vhost-scsi, then get a pre-allocated
1193 * cmd descriptor for the new virtio-scsi tag.
1195 * TODO what if cdb was too small for varlen cdb header?
1197 if (unlikely(scsi_command_size(cdb
) > VHOST_SCSI_MAX_CDB_SIZE
)) {
1198 vq_err(vq
, "Received SCSI CDB with command_size: %d that"
1199 " exceeds SCSI_MAX_VARLEN_CDB_SIZE: %d\n",
1200 scsi_command_size(cdb
), VHOST_SCSI_MAX_CDB_SIZE
);
1201 vhost_scsi_send_bad_target(vs
, vq
, head
, out
);
1204 cmd
= vhost_scsi_get_tag(vq
, tpg
, cdb
, tag
, lun
, task_attr
,
1205 exp_data_len
+ prot_bytes
,
1208 vq_err(vq
, "vhost_scsi_get_tag failed %ld\n",
1210 vhost_scsi_send_bad_target(vs
, vq
, head
, out
);
1213 cmd
->tvc_vhost
= vs
;
1215 cmd
->tvc_resp_iov
= &vq
->iov
[out
];
1216 cmd
->tvc_in_iovs
= in
;
1218 pr_debug("vhost_scsi got command opcode: %#02x, lun: %d\n",
1219 cmd
->tvc_cdb
[0], cmd
->tvc_lun
);
1220 pr_debug("cmd: %p exp_data_len: %d, prot_bytes: %d data_direction:"
1221 " %d\n", cmd
, exp_data_len
, prot_bytes
, data_direction
);
1223 if (data_direction
!= DMA_NONE
) {
1224 ret
= vhost_scsi_mapal(cmd
,
1225 prot_bytes
, &prot_iter
,
1226 exp_data_len
, &data_iter
);
1227 if (unlikely(ret
)) {
1228 vq_err(vq
, "Failed to map iov to sgl\n");
1229 vhost_scsi_release_cmd(&cmd
->tvc_se_cmd
);
1230 vhost_scsi_send_bad_target(vs
, vq
, head
, out
);
1235 * Save the descriptor from vhost_get_vq_desc() to be used to
1236 * complete the virtio-scsi request in TCM callback context via
1237 * vhost_scsi_queue_data_in() and vhost_scsi_queue_status()
1239 cmd
->tvc_vq_desc
= head
;
1241 * Dispatch cmd descriptor for cmwq execution in process
1242 * context provided by vhost_scsi_workqueue. This also ensures
1243 * cmd is executed on the same kworker CPU as this vhost
1244 * thread to gain positive L2 cache locality effects.
1246 INIT_WORK(&cmd
->work
, vhost_scsi_submission_work
);
1247 queue_work(vhost_scsi_workqueue
, &cmd
->work
);
1250 mutex_unlock(&vq
->mutex
);
1253 static void vhost_scsi_ctl_handle_kick(struct vhost_work
*work
)
1255 pr_debug("%s: The handling func for control queue.\n", __func__
);
1259 vhost_scsi_send_evt(struct vhost_scsi
*vs
,
1260 struct vhost_scsi_tpg
*tpg
,
1265 struct vhost_scsi_evt
*evt
;
1267 evt
= vhost_scsi_allocate_evt(vs
, event
, reason
);
1272 /* TODO: share lun setup code with virtio-scsi.ko */
1274 * Note: evt->event is zeroed when we allocate it and
1275 * lun[4-7] need to be zero according to virtio-scsi spec.
1277 evt
->event
.lun
[0] = 0x01;
1278 evt
->event
.lun
[1] = tpg
->tport_tpgt
;
1279 if (lun
->unpacked_lun
>= 256)
1280 evt
->event
.lun
[2] = lun
->unpacked_lun
>> 8 | 0x40 ;
1281 evt
->event
.lun
[3] = lun
->unpacked_lun
& 0xFF;
1284 llist_add(&evt
->list
, &vs
->vs_event_list
);
1285 vhost_work_queue(&vs
->dev
, &vs
->vs_event_work
);
1288 static void vhost_scsi_evt_handle_kick(struct vhost_work
*work
)
1290 struct vhost_virtqueue
*vq
= container_of(work
, struct vhost_virtqueue
,
1292 struct vhost_scsi
*vs
= container_of(vq
->dev
, struct vhost_scsi
, dev
);
1294 mutex_lock(&vq
->mutex
);
1295 if (!vq
->private_data
)
1298 if (vs
->vs_events_missed
)
1299 vhost_scsi_send_evt(vs
, NULL
, NULL
, VIRTIO_SCSI_T_NO_EVENT
, 0);
1301 mutex_unlock(&vq
->mutex
);
1304 static void vhost_scsi_handle_kick(struct vhost_work
*work
)
1306 struct vhost_virtqueue
*vq
= container_of(work
, struct vhost_virtqueue
,
1308 struct vhost_scsi
*vs
= container_of(vq
->dev
, struct vhost_scsi
, dev
);
1310 vhost_scsi_handle_vq(vs
, vq
);
1313 static void vhost_scsi_flush_vq(struct vhost_scsi
*vs
, int index
)
1315 vhost_poll_flush(&vs
->vqs
[index
].vq
.poll
);
1318 /* Callers must hold dev mutex */
1319 static void vhost_scsi_flush(struct vhost_scsi
*vs
)
1321 struct vhost_scsi_inflight
*old_inflight
[VHOST_SCSI_MAX_VQ
];
1324 /* Init new inflight and remember the old inflight */
1325 vhost_scsi_init_inflight(vs
, old_inflight
);
1328 * The inflight->kref was initialized to 1. We decrement it here to
1329 * indicate the start of the flush operation so that it will reach 0
1330 * when all the reqs are finished.
1332 for (i
= 0; i
< VHOST_SCSI_MAX_VQ
; i
++)
1333 kref_put(&old_inflight
[i
]->kref
, vhost_scsi_done_inflight
);
1335 /* Flush both the vhost poll and vhost work */
1336 for (i
= 0; i
< VHOST_SCSI_MAX_VQ
; i
++)
1337 vhost_scsi_flush_vq(vs
, i
);
1338 vhost_work_flush(&vs
->dev
, &vs
->vs_completion_work
);
1339 vhost_work_flush(&vs
->dev
, &vs
->vs_event_work
);
1341 /* Wait for all reqs issued before the flush to be finished */
1342 for (i
= 0; i
< VHOST_SCSI_MAX_VQ
; i
++)
1343 wait_for_completion(&old_inflight
[i
]->comp
);
1347 * Called from vhost_scsi_ioctl() context to walk the list of available
1348 * vhost_scsi_tpg with an active struct vhost_scsi_nexus
1350 * The lock nesting rule is:
1351 * vhost_scsi_mutex -> vs->dev.mutex -> tpg->tv_tpg_mutex -> vq->mutex
1354 vhost_scsi_set_endpoint(struct vhost_scsi
*vs
,
1355 struct vhost_scsi_target
*t
)
1357 struct se_portal_group
*se_tpg
;
1358 struct vhost_scsi_tport
*tv_tport
;
1359 struct vhost_scsi_tpg
*tpg
;
1360 struct vhost_scsi_tpg
**vs_tpg
;
1361 struct vhost_virtqueue
*vq
;
1362 int index
, ret
, i
, len
;
1365 mutex_lock(&vhost_scsi_mutex
);
1366 mutex_lock(&vs
->dev
.mutex
);
1368 /* Verify that ring has been setup correctly. */
1369 for (index
= 0; index
< vs
->dev
.nvqs
; ++index
) {
1370 /* Verify that ring has been setup correctly. */
1371 if (!vhost_vq_access_ok(&vs
->vqs
[index
].vq
)) {
1377 len
= sizeof(vs_tpg
[0]) * VHOST_SCSI_MAX_TARGET
;
1378 vs_tpg
= kzalloc(len
, GFP_KERNEL
);
1384 memcpy(vs_tpg
, vs
->vs_tpg
, len
);
1386 list_for_each_entry(tpg
, &vhost_scsi_list
, tv_tpg_list
) {
1387 mutex_lock(&tpg
->tv_tpg_mutex
);
1388 if (!tpg
->tpg_nexus
) {
1389 mutex_unlock(&tpg
->tv_tpg_mutex
);
1392 if (tpg
->tv_tpg_vhost_count
!= 0) {
1393 mutex_unlock(&tpg
->tv_tpg_mutex
);
1396 tv_tport
= tpg
->tport
;
1398 if (!strcmp(tv_tport
->tport_name
, t
->vhost_wwpn
)) {
1399 if (vs
->vs_tpg
&& vs
->vs_tpg
[tpg
->tport_tpgt
]) {
1401 mutex_unlock(&tpg
->tv_tpg_mutex
);
1406 * In order to ensure individual vhost-scsi configfs
1407 * groups cannot be removed while in use by vhost ioctl,
1408 * go ahead and take an explicit se_tpg->tpg_group.cg_item
1411 se_tpg
= &tpg
->se_tpg
;
1412 ret
= target_depend_item(&se_tpg
->tpg_group
.cg_item
);
1414 pr_warn("configfs_depend_item() failed: %d\n", ret
);
1416 mutex_unlock(&tpg
->tv_tpg_mutex
);
1419 tpg
->tv_tpg_vhost_count
++;
1420 tpg
->vhost_scsi
= vs
;
1421 vs_tpg
[tpg
->tport_tpgt
] = tpg
;
1422 smp_mb__after_atomic();
1425 mutex_unlock(&tpg
->tv_tpg_mutex
);
1429 memcpy(vs
->vs_vhost_wwpn
, t
->vhost_wwpn
,
1430 sizeof(vs
->vs_vhost_wwpn
));
1431 for (i
= 0; i
< VHOST_SCSI_MAX_VQ
; i
++) {
1432 vq
= &vs
->vqs
[i
].vq
;
1433 mutex_lock(&vq
->mutex
);
1434 vq
->private_data
= vs_tpg
;
1435 vhost_init_used(vq
);
1436 mutex_unlock(&vq
->mutex
);
1444 * Act as synchronize_rcu to make sure access to
1445 * old vs->vs_tpg is finished.
1447 vhost_scsi_flush(vs
);
1449 vs
->vs_tpg
= vs_tpg
;
1452 mutex_unlock(&vs
->dev
.mutex
);
1453 mutex_unlock(&vhost_scsi_mutex
);
1458 vhost_scsi_clear_endpoint(struct vhost_scsi
*vs
,
1459 struct vhost_scsi_target
*t
)
1461 struct se_portal_group
*se_tpg
;
1462 struct vhost_scsi_tport
*tv_tport
;
1463 struct vhost_scsi_tpg
*tpg
;
1464 struct vhost_virtqueue
*vq
;
1469 mutex_lock(&vhost_scsi_mutex
);
1470 mutex_lock(&vs
->dev
.mutex
);
1471 /* Verify that ring has been setup correctly. */
1472 for (index
= 0; index
< vs
->dev
.nvqs
; ++index
) {
1473 if (!vhost_vq_access_ok(&vs
->vqs
[index
].vq
)) {
1484 for (i
= 0; i
< VHOST_SCSI_MAX_TARGET
; i
++) {
1486 tpg
= vs
->vs_tpg
[target
];
1490 mutex_lock(&tpg
->tv_tpg_mutex
);
1491 tv_tport
= tpg
->tport
;
1497 if (strcmp(tv_tport
->tport_name
, t
->vhost_wwpn
)) {
1498 pr_warn("tv_tport->tport_name: %s, tpg->tport_tpgt: %hu"
1499 " does not match t->vhost_wwpn: %s, t->vhost_tpgt: %hu\n",
1500 tv_tport
->tport_name
, tpg
->tport_tpgt
,
1501 t
->vhost_wwpn
, t
->vhost_tpgt
);
1505 tpg
->tv_tpg_vhost_count
--;
1506 tpg
->vhost_scsi
= NULL
;
1507 vs
->vs_tpg
[target
] = NULL
;
1509 mutex_unlock(&tpg
->tv_tpg_mutex
);
1511 * Release se_tpg->tpg_group.cg_item configfs dependency now
1512 * to allow vhost-scsi WWPN se_tpg->tpg_group shutdown to occur.
1514 se_tpg
= &tpg
->se_tpg
;
1515 target_undepend_item(&se_tpg
->tpg_group
.cg_item
);
1518 for (i
= 0; i
< VHOST_SCSI_MAX_VQ
; i
++) {
1519 vq
= &vs
->vqs
[i
].vq
;
1520 mutex_lock(&vq
->mutex
);
1521 vq
->private_data
= NULL
;
1522 mutex_unlock(&vq
->mutex
);
1526 * Act as synchronize_rcu to make sure access to
1527 * old vs->vs_tpg is finished.
1529 vhost_scsi_flush(vs
);
1532 WARN_ON(vs
->vs_events_nr
);
1533 mutex_unlock(&vs
->dev
.mutex
);
1534 mutex_unlock(&vhost_scsi_mutex
);
1538 mutex_unlock(&tpg
->tv_tpg_mutex
);
1540 mutex_unlock(&vs
->dev
.mutex
);
1541 mutex_unlock(&vhost_scsi_mutex
);
1545 static int vhost_scsi_set_features(struct vhost_scsi
*vs
, u64 features
)
1547 struct vhost_virtqueue
*vq
;
1550 if (features
& ~VHOST_SCSI_FEATURES
)
1553 mutex_lock(&vs
->dev
.mutex
);
1554 if ((features
& (1 << VHOST_F_LOG_ALL
)) &&
1555 !vhost_log_access_ok(&vs
->dev
)) {
1556 mutex_unlock(&vs
->dev
.mutex
);
1560 for (i
= 0; i
< VHOST_SCSI_MAX_VQ
; i
++) {
1561 vq
= &vs
->vqs
[i
].vq
;
1562 mutex_lock(&vq
->mutex
);
1563 vq
->acked_features
= features
;
1564 mutex_unlock(&vq
->mutex
);
1566 mutex_unlock(&vs
->dev
.mutex
);
1570 static int vhost_scsi_open(struct inode
*inode
, struct file
*f
)
1572 struct vhost_scsi
*vs
;
1573 struct vhost_virtqueue
**vqs
;
1576 vs
= kzalloc(sizeof(*vs
), GFP_KERNEL
| __GFP_NOWARN
| __GFP_REPEAT
);
1578 vs
= vzalloc(sizeof(*vs
));
1583 vqs
= kmalloc(VHOST_SCSI_MAX_VQ
* sizeof(*vqs
), GFP_KERNEL
);
1587 vhost_work_init(&vs
->vs_completion_work
, vhost_scsi_complete_cmd_work
);
1588 vhost_work_init(&vs
->vs_event_work
, vhost_scsi_evt_work
);
1590 vs
->vs_events_nr
= 0;
1591 vs
->vs_events_missed
= false;
1593 vqs
[VHOST_SCSI_VQ_CTL
] = &vs
->vqs
[VHOST_SCSI_VQ_CTL
].vq
;
1594 vqs
[VHOST_SCSI_VQ_EVT
] = &vs
->vqs
[VHOST_SCSI_VQ_EVT
].vq
;
1595 vs
->vqs
[VHOST_SCSI_VQ_CTL
].vq
.handle_kick
= vhost_scsi_ctl_handle_kick
;
1596 vs
->vqs
[VHOST_SCSI_VQ_EVT
].vq
.handle_kick
= vhost_scsi_evt_handle_kick
;
1597 for (i
= VHOST_SCSI_VQ_IO
; i
< VHOST_SCSI_MAX_VQ
; i
++) {
1598 vqs
[i
] = &vs
->vqs
[i
].vq
;
1599 vs
->vqs
[i
].vq
.handle_kick
= vhost_scsi_handle_kick
;
1601 vhost_dev_init(&vs
->dev
, vqs
, VHOST_SCSI_MAX_VQ
);
1603 vhost_scsi_init_inflight(vs
, NULL
);
1605 f
->private_data
= vs
;
1614 static int vhost_scsi_release(struct inode
*inode
, struct file
*f
)
1616 struct vhost_scsi
*vs
= f
->private_data
;
1617 struct vhost_scsi_target t
;
1619 mutex_lock(&vs
->dev
.mutex
);
1620 memcpy(t
.vhost_wwpn
, vs
->vs_vhost_wwpn
, sizeof(t
.vhost_wwpn
));
1621 mutex_unlock(&vs
->dev
.mutex
);
1622 vhost_scsi_clear_endpoint(vs
, &t
);
1623 vhost_dev_stop(&vs
->dev
);
1624 vhost_dev_cleanup(&vs
->dev
, false);
1625 /* Jobs can re-queue themselves in evt kick handler. Do extra flush. */
1626 vhost_scsi_flush(vs
);
1633 vhost_scsi_ioctl(struct file
*f
,
1637 struct vhost_scsi
*vs
= f
->private_data
;
1638 struct vhost_scsi_target backend
;
1639 void __user
*argp
= (void __user
*)arg
;
1640 u64 __user
*featurep
= argp
;
1641 u32 __user
*eventsp
= argp
;
1644 int r
, abi_version
= VHOST_SCSI_ABI_VERSION
;
1645 struct vhost_virtqueue
*vq
= &vs
->vqs
[VHOST_SCSI_VQ_EVT
].vq
;
1648 case VHOST_SCSI_SET_ENDPOINT
:
1649 if (copy_from_user(&backend
, argp
, sizeof backend
))
1651 if (backend
.reserved
!= 0)
1654 return vhost_scsi_set_endpoint(vs
, &backend
);
1655 case VHOST_SCSI_CLEAR_ENDPOINT
:
1656 if (copy_from_user(&backend
, argp
, sizeof backend
))
1658 if (backend
.reserved
!= 0)
1661 return vhost_scsi_clear_endpoint(vs
, &backend
);
1662 case VHOST_SCSI_GET_ABI_VERSION
:
1663 if (copy_to_user(argp
, &abi_version
, sizeof abi_version
))
1666 case VHOST_SCSI_SET_EVENTS_MISSED
:
1667 if (get_user(events_missed
, eventsp
))
1669 mutex_lock(&vq
->mutex
);
1670 vs
->vs_events_missed
= events_missed
;
1671 mutex_unlock(&vq
->mutex
);
1673 case VHOST_SCSI_GET_EVENTS_MISSED
:
1674 mutex_lock(&vq
->mutex
);
1675 events_missed
= vs
->vs_events_missed
;
1676 mutex_unlock(&vq
->mutex
);
1677 if (put_user(events_missed
, eventsp
))
1680 case VHOST_GET_FEATURES
:
1681 features
= VHOST_SCSI_FEATURES
;
1682 if (copy_to_user(featurep
, &features
, sizeof features
))
1685 case VHOST_SET_FEATURES
:
1686 if (copy_from_user(&features
, featurep
, sizeof features
))
1688 return vhost_scsi_set_features(vs
, features
);
1690 mutex_lock(&vs
->dev
.mutex
);
1691 r
= vhost_dev_ioctl(&vs
->dev
, ioctl
, argp
);
1692 /* TODO: flush backend after dev ioctl. */
1693 if (r
== -ENOIOCTLCMD
)
1694 r
= vhost_vring_ioctl(&vs
->dev
, ioctl
, argp
);
1695 mutex_unlock(&vs
->dev
.mutex
);
1700 #ifdef CONFIG_COMPAT
1701 static long vhost_scsi_compat_ioctl(struct file
*f
, unsigned int ioctl
,
1704 return vhost_scsi_ioctl(f
, ioctl
, (unsigned long)compat_ptr(arg
));
1708 static const struct file_operations vhost_scsi_fops
= {
1709 .owner
= THIS_MODULE
,
1710 .release
= vhost_scsi_release
,
1711 .unlocked_ioctl
= vhost_scsi_ioctl
,
1712 #ifdef CONFIG_COMPAT
1713 .compat_ioctl
= vhost_scsi_compat_ioctl
,
1715 .open
= vhost_scsi_open
,
1716 .llseek
= noop_llseek
,
1719 static struct miscdevice vhost_scsi_misc
= {
1725 static int __init
vhost_scsi_register(void)
1727 return misc_register(&vhost_scsi_misc
);
1730 static int vhost_scsi_deregister(void)
1732 return misc_deregister(&vhost_scsi_misc
);
1735 static char *vhost_scsi_dump_proto_id(struct vhost_scsi_tport
*tport
)
1737 switch (tport
->tport_proto_id
) {
1738 case SCSI_PROTOCOL_SAS
:
1740 case SCSI_PROTOCOL_FCP
:
1742 case SCSI_PROTOCOL_ISCSI
:
1752 vhost_scsi_do_plug(struct vhost_scsi_tpg
*tpg
,
1753 struct se_lun
*lun
, bool plug
)
1756 struct vhost_scsi
*vs
= tpg
->vhost_scsi
;
1757 struct vhost_virtqueue
*vq
;
1763 mutex_lock(&vs
->dev
.mutex
);
1766 reason
= VIRTIO_SCSI_EVT_RESET_RESCAN
;
1768 reason
= VIRTIO_SCSI_EVT_RESET_REMOVED
;
1770 vq
= &vs
->vqs
[VHOST_SCSI_VQ_EVT
].vq
;
1771 mutex_lock(&vq
->mutex
);
1772 if (vhost_has_feature(vq
, VIRTIO_SCSI_F_HOTPLUG
))
1773 vhost_scsi_send_evt(vs
, tpg
, lun
,
1774 VIRTIO_SCSI_T_TRANSPORT_RESET
, reason
);
1775 mutex_unlock(&vq
->mutex
);
1776 mutex_unlock(&vs
->dev
.mutex
);
1779 static void vhost_scsi_hotplug(struct vhost_scsi_tpg
*tpg
, struct se_lun
*lun
)
1781 vhost_scsi_do_plug(tpg
, lun
, true);
1784 static void vhost_scsi_hotunplug(struct vhost_scsi_tpg
*tpg
, struct se_lun
*lun
)
1786 vhost_scsi_do_plug(tpg
, lun
, false);
1789 static int vhost_scsi_port_link(struct se_portal_group
*se_tpg
,
1792 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
1793 struct vhost_scsi_tpg
, se_tpg
);
1795 mutex_lock(&vhost_scsi_mutex
);
1797 mutex_lock(&tpg
->tv_tpg_mutex
);
1798 tpg
->tv_tpg_port_count
++;
1799 mutex_unlock(&tpg
->tv_tpg_mutex
);
1801 vhost_scsi_hotplug(tpg
, lun
);
1803 mutex_unlock(&vhost_scsi_mutex
);
1808 static void vhost_scsi_port_unlink(struct se_portal_group
*se_tpg
,
1811 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
1812 struct vhost_scsi_tpg
, se_tpg
);
1814 mutex_lock(&vhost_scsi_mutex
);
1816 mutex_lock(&tpg
->tv_tpg_mutex
);
1817 tpg
->tv_tpg_port_count
--;
1818 mutex_unlock(&tpg
->tv_tpg_mutex
);
1820 vhost_scsi_hotunplug(tpg
, lun
);
1822 mutex_unlock(&vhost_scsi_mutex
);
1825 static struct se_node_acl
*
1826 vhost_scsi_make_nodeacl(struct se_portal_group
*se_tpg
,
1827 struct config_group
*group
,
1830 struct se_node_acl
*se_nacl
, *se_nacl_new
;
1831 struct vhost_scsi_nacl
*nacl
;
1835 /* vhost_scsi_parse_wwn(name, &wwpn, 1) < 0)
1836 return ERR_PTR(-EINVAL); */
1837 se_nacl_new
= vhost_scsi_alloc_fabric_acl(se_tpg
);
1839 return ERR_PTR(-ENOMEM
);
1843 * se_nacl_new may be released by core_tpg_add_initiator_node_acl()
1844 * when converting a NodeACL from demo mode -> explict
1846 se_nacl
= core_tpg_add_initiator_node_acl(se_tpg
, se_nacl_new
,
1848 if (IS_ERR(se_nacl
)) {
1849 vhost_scsi_release_fabric_acl(se_tpg
, se_nacl_new
);
1853 * Locate our struct vhost_scsi_nacl and set the FC Nport WWPN
1855 nacl
= container_of(se_nacl
, struct vhost_scsi_nacl
, se_node_acl
);
1856 nacl
->iport_wwpn
= wwpn
;
1861 static void vhost_scsi_drop_nodeacl(struct se_node_acl
*se_acl
)
1863 struct vhost_scsi_nacl
*nacl
= container_of(se_acl
,
1864 struct vhost_scsi_nacl
, se_node_acl
);
1865 core_tpg_del_initiator_node_acl(se_acl
->se_tpg
, se_acl
, 1);
1869 static void vhost_scsi_free_cmd_map_res(struct vhost_scsi_nexus
*nexus
,
1870 struct se_session
*se_sess
)
1872 struct vhost_scsi_cmd
*tv_cmd
;
1875 if (!se_sess
->sess_cmd_map
)
1878 for (i
= 0; i
< VHOST_SCSI_DEFAULT_TAGS
; i
++) {
1879 tv_cmd
= &((struct vhost_scsi_cmd
*)se_sess
->sess_cmd_map
)[i
];
1881 kfree(tv_cmd
->tvc_sgl
);
1882 kfree(tv_cmd
->tvc_prot_sgl
);
1883 kfree(tv_cmd
->tvc_upages
);
1887 static ssize_t
vhost_scsi_tpg_attrib_store_fabric_prot_type(
1888 struct se_portal_group
*se_tpg
,
1892 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
1893 struct vhost_scsi_tpg
, se_tpg
);
1895 int ret
= kstrtoul(page
, 0, &val
);
1898 pr_err("kstrtoul() returned %d for fabric_prot_type\n", ret
);
1901 if (val
!= 0 && val
!= 1 && val
!= 3) {
1902 pr_err("Invalid vhost_scsi fabric_prot_type: %lu\n", val
);
1905 tpg
->tv_fabric_prot_type
= val
;
1910 static ssize_t
vhost_scsi_tpg_attrib_show_fabric_prot_type(
1911 struct se_portal_group
*se_tpg
,
1914 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
1915 struct vhost_scsi_tpg
, se_tpg
);
1917 return sprintf(page
, "%d\n", tpg
->tv_fabric_prot_type
);
1919 TF_TPG_ATTRIB_ATTR(vhost_scsi
, fabric_prot_type
, S_IRUGO
| S_IWUSR
);
1921 static struct configfs_attribute
*vhost_scsi_tpg_attrib_attrs
[] = {
1922 &vhost_scsi_tpg_attrib_fabric_prot_type
.attr
,
1926 static int vhost_scsi_make_nexus(struct vhost_scsi_tpg
*tpg
,
1929 struct se_portal_group
*se_tpg
;
1930 struct se_session
*se_sess
;
1931 struct vhost_scsi_nexus
*tv_nexus
;
1932 struct vhost_scsi_cmd
*tv_cmd
;
1935 mutex_lock(&tpg
->tv_tpg_mutex
);
1936 if (tpg
->tpg_nexus
) {
1937 mutex_unlock(&tpg
->tv_tpg_mutex
);
1938 pr_debug("tpg->tpg_nexus already exists\n");
1941 se_tpg
= &tpg
->se_tpg
;
1943 tv_nexus
= kzalloc(sizeof(struct vhost_scsi_nexus
), GFP_KERNEL
);
1945 mutex_unlock(&tpg
->tv_tpg_mutex
);
1946 pr_err("Unable to allocate struct vhost_scsi_nexus\n");
1950 * Initialize the struct se_session pointer and setup tagpool
1951 * for struct vhost_scsi_cmd descriptors
1953 tv_nexus
->tvn_se_sess
= transport_init_session_tags(
1954 VHOST_SCSI_DEFAULT_TAGS
,
1955 sizeof(struct vhost_scsi_cmd
),
1956 TARGET_PROT_DIN_PASS
| TARGET_PROT_DOUT_PASS
);
1957 if (IS_ERR(tv_nexus
->tvn_se_sess
)) {
1958 mutex_unlock(&tpg
->tv_tpg_mutex
);
1962 se_sess
= tv_nexus
->tvn_se_sess
;
1963 for (i
= 0; i
< VHOST_SCSI_DEFAULT_TAGS
; i
++) {
1964 tv_cmd
= &((struct vhost_scsi_cmd
*)se_sess
->sess_cmd_map
)[i
];
1966 tv_cmd
->tvc_sgl
= kzalloc(sizeof(struct scatterlist
) *
1967 VHOST_SCSI_PREALLOC_SGLS
, GFP_KERNEL
);
1968 if (!tv_cmd
->tvc_sgl
) {
1969 mutex_unlock(&tpg
->tv_tpg_mutex
);
1970 pr_err("Unable to allocate tv_cmd->tvc_sgl\n");
1974 tv_cmd
->tvc_upages
= kzalloc(sizeof(struct page
*) *
1975 VHOST_SCSI_PREALLOC_UPAGES
, GFP_KERNEL
);
1976 if (!tv_cmd
->tvc_upages
) {
1977 mutex_unlock(&tpg
->tv_tpg_mutex
);
1978 pr_err("Unable to allocate tv_cmd->tvc_upages\n");
1982 tv_cmd
->tvc_prot_sgl
= kzalloc(sizeof(struct scatterlist
) *
1983 VHOST_SCSI_PREALLOC_PROT_SGLS
, GFP_KERNEL
);
1984 if (!tv_cmd
->tvc_prot_sgl
) {
1985 mutex_unlock(&tpg
->tv_tpg_mutex
);
1986 pr_err("Unable to allocate tv_cmd->tvc_prot_sgl\n");
1991 * Since we are running in 'demo mode' this call with generate a
1992 * struct se_node_acl for the vhost_scsi struct se_portal_group with
1993 * the SCSI Initiator port name of the passed configfs group 'name'.
1995 tv_nexus
->tvn_se_sess
->se_node_acl
= core_tpg_check_initiator_node_acl(
1996 se_tpg
, (unsigned char *)name
);
1997 if (!tv_nexus
->tvn_se_sess
->se_node_acl
) {
1998 mutex_unlock(&tpg
->tv_tpg_mutex
);
1999 pr_debug("core_tpg_check_initiator_node_acl() failed"
2004 * Now register the TCM vhost virtual I_T Nexus as active.
2006 transport_register_session(se_tpg
, tv_nexus
->tvn_se_sess
->se_node_acl
,
2007 tv_nexus
->tvn_se_sess
, tv_nexus
);
2008 tpg
->tpg_nexus
= tv_nexus
;
2010 mutex_unlock(&tpg
->tv_tpg_mutex
);
2014 vhost_scsi_free_cmd_map_res(tv_nexus
, se_sess
);
2015 transport_free_session(se_sess
);
2020 static int vhost_scsi_drop_nexus(struct vhost_scsi_tpg
*tpg
)
2022 struct se_session
*se_sess
;
2023 struct vhost_scsi_nexus
*tv_nexus
;
2025 mutex_lock(&tpg
->tv_tpg_mutex
);
2026 tv_nexus
= tpg
->tpg_nexus
;
2028 mutex_unlock(&tpg
->tv_tpg_mutex
);
2032 se_sess
= tv_nexus
->tvn_se_sess
;
2034 mutex_unlock(&tpg
->tv_tpg_mutex
);
2038 if (tpg
->tv_tpg_port_count
!= 0) {
2039 mutex_unlock(&tpg
->tv_tpg_mutex
);
2040 pr_err("Unable to remove TCM_vhost I_T Nexus with"
2041 " active TPG port count: %d\n",
2042 tpg
->tv_tpg_port_count
);
2046 if (tpg
->tv_tpg_vhost_count
!= 0) {
2047 mutex_unlock(&tpg
->tv_tpg_mutex
);
2048 pr_err("Unable to remove TCM_vhost I_T Nexus with"
2049 " active TPG vhost count: %d\n",
2050 tpg
->tv_tpg_vhost_count
);
2054 pr_debug("TCM_vhost_ConfigFS: Removing I_T Nexus to emulated"
2055 " %s Initiator Port: %s\n", vhost_scsi_dump_proto_id(tpg
->tport
),
2056 tv_nexus
->tvn_se_sess
->se_node_acl
->initiatorname
);
2058 vhost_scsi_free_cmd_map_res(tv_nexus
, se_sess
);
2060 * Release the SCSI I_T Nexus to the emulated vhost Target Port
2062 transport_deregister_session(tv_nexus
->tvn_se_sess
);
2063 tpg
->tpg_nexus
= NULL
;
2064 mutex_unlock(&tpg
->tv_tpg_mutex
);
2070 static ssize_t
vhost_scsi_tpg_show_nexus(struct se_portal_group
*se_tpg
,
2073 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
2074 struct vhost_scsi_tpg
, se_tpg
);
2075 struct vhost_scsi_nexus
*tv_nexus
;
2078 mutex_lock(&tpg
->tv_tpg_mutex
);
2079 tv_nexus
= tpg
->tpg_nexus
;
2081 mutex_unlock(&tpg
->tv_tpg_mutex
);
2084 ret
= snprintf(page
, PAGE_SIZE
, "%s\n",
2085 tv_nexus
->tvn_se_sess
->se_node_acl
->initiatorname
);
2086 mutex_unlock(&tpg
->tv_tpg_mutex
);
2091 static ssize_t
vhost_scsi_tpg_store_nexus(struct se_portal_group
*se_tpg
,
2095 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
2096 struct vhost_scsi_tpg
, se_tpg
);
2097 struct vhost_scsi_tport
*tport_wwn
= tpg
->tport
;
2098 unsigned char i_port
[VHOST_SCSI_NAMELEN
], *ptr
, *port_ptr
;
2101 * Shutdown the active I_T nexus if 'NULL' is passed..
2103 if (!strncmp(page
, "NULL", 4)) {
2104 ret
= vhost_scsi_drop_nexus(tpg
);
2105 return (!ret
) ? count
: ret
;
2108 * Otherwise make sure the passed virtual Initiator port WWN matches
2109 * the fabric protocol_id set in vhost_scsi_make_tport(), and call
2110 * vhost_scsi_make_nexus().
2112 if (strlen(page
) >= VHOST_SCSI_NAMELEN
) {
2113 pr_err("Emulated NAA Sas Address: %s, exceeds"
2114 " max: %d\n", page
, VHOST_SCSI_NAMELEN
);
2117 snprintf(&i_port
[0], VHOST_SCSI_NAMELEN
, "%s", page
);
2119 ptr
= strstr(i_port
, "naa.");
2121 if (tport_wwn
->tport_proto_id
!= SCSI_PROTOCOL_SAS
) {
2122 pr_err("Passed SAS Initiator Port %s does not"
2123 " match target port protoid: %s\n", i_port
,
2124 vhost_scsi_dump_proto_id(tport_wwn
));
2127 port_ptr
= &i_port
[0];
2130 ptr
= strstr(i_port
, "fc.");
2132 if (tport_wwn
->tport_proto_id
!= SCSI_PROTOCOL_FCP
) {
2133 pr_err("Passed FCP Initiator Port %s does not"
2134 " match target port protoid: %s\n", i_port
,
2135 vhost_scsi_dump_proto_id(tport_wwn
));
2138 port_ptr
= &i_port
[3]; /* Skip over "fc." */
2141 ptr
= strstr(i_port
, "iqn.");
2143 if (tport_wwn
->tport_proto_id
!= SCSI_PROTOCOL_ISCSI
) {
2144 pr_err("Passed iSCSI Initiator Port %s does not"
2145 " match target port protoid: %s\n", i_port
,
2146 vhost_scsi_dump_proto_id(tport_wwn
));
2149 port_ptr
= &i_port
[0];
2152 pr_err("Unable to locate prefix for emulated Initiator Port:"
2156 * Clear any trailing newline for the NAA WWN
2159 if (i_port
[strlen(i_port
)-1] == '\n')
2160 i_port
[strlen(i_port
)-1] = '\0';
2162 ret
= vhost_scsi_make_nexus(tpg
, port_ptr
);
2169 TF_TPG_BASE_ATTR(vhost_scsi
, nexus
, S_IRUGO
| S_IWUSR
);
2171 static struct configfs_attribute
*vhost_scsi_tpg_attrs
[] = {
2172 &vhost_scsi_tpg_nexus
.attr
,
2176 static struct se_portal_group
*
2177 vhost_scsi_make_tpg(struct se_wwn
*wwn
,
2178 struct config_group
*group
,
2181 struct vhost_scsi_tport
*tport
= container_of(wwn
,
2182 struct vhost_scsi_tport
, tport_wwn
);
2184 struct vhost_scsi_tpg
*tpg
;
2188 if (strstr(name
, "tpgt_") != name
)
2189 return ERR_PTR(-EINVAL
);
2190 if (kstrtou16(name
+ 5, 10, &tpgt
) || tpgt
>= VHOST_SCSI_MAX_TARGET
)
2191 return ERR_PTR(-EINVAL
);
2193 tpg
= kzalloc(sizeof(struct vhost_scsi_tpg
), GFP_KERNEL
);
2195 pr_err("Unable to allocate struct vhost_scsi_tpg");
2196 return ERR_PTR(-ENOMEM
);
2198 mutex_init(&tpg
->tv_tpg_mutex
);
2199 INIT_LIST_HEAD(&tpg
->tv_tpg_list
);
2201 tpg
->tport_tpgt
= tpgt
;
2203 ret
= core_tpg_register(&vhost_scsi_ops
, wwn
,
2204 &tpg
->se_tpg
, tpg
, TRANSPORT_TPG_TYPE_NORMAL
);
2209 mutex_lock(&vhost_scsi_mutex
);
2210 list_add_tail(&tpg
->tv_tpg_list
, &vhost_scsi_list
);
2211 mutex_unlock(&vhost_scsi_mutex
);
2213 return &tpg
->se_tpg
;
2216 static void vhost_scsi_drop_tpg(struct se_portal_group
*se_tpg
)
2218 struct vhost_scsi_tpg
*tpg
= container_of(se_tpg
,
2219 struct vhost_scsi_tpg
, se_tpg
);
2221 mutex_lock(&vhost_scsi_mutex
);
2222 list_del(&tpg
->tv_tpg_list
);
2223 mutex_unlock(&vhost_scsi_mutex
);
2225 * Release the virtual I_T Nexus for this vhost TPG
2227 vhost_scsi_drop_nexus(tpg
);
2229 * Deregister the se_tpg from TCM..
2231 core_tpg_deregister(se_tpg
);
2235 static struct se_wwn
*
2236 vhost_scsi_make_tport(struct target_fabric_configfs
*tf
,
2237 struct config_group
*group
,
2240 struct vhost_scsi_tport
*tport
;
2245 /* if (vhost_scsi_parse_wwn(name, &wwpn, 1) < 0)
2246 return ERR_PTR(-EINVAL); */
2248 tport
= kzalloc(sizeof(struct vhost_scsi_tport
), GFP_KERNEL
);
2250 pr_err("Unable to allocate struct vhost_scsi_tport");
2251 return ERR_PTR(-ENOMEM
);
2253 tport
->tport_wwpn
= wwpn
;
2255 * Determine the emulated Protocol Identifier and Target Port Name
2256 * based on the incoming configfs directory name.
2258 ptr
= strstr(name
, "naa.");
2260 tport
->tport_proto_id
= SCSI_PROTOCOL_SAS
;
2263 ptr
= strstr(name
, "fc.");
2265 tport
->tport_proto_id
= SCSI_PROTOCOL_FCP
;
2266 off
= 3; /* Skip over "fc." */
2269 ptr
= strstr(name
, "iqn.");
2271 tport
->tport_proto_id
= SCSI_PROTOCOL_ISCSI
;
2275 pr_err("Unable to locate prefix for emulated Target Port:"
2278 return ERR_PTR(-EINVAL
);
2281 if (strlen(name
) >= VHOST_SCSI_NAMELEN
) {
2282 pr_err("Emulated %s Address: %s, exceeds"
2283 " max: %d\n", name
, vhost_scsi_dump_proto_id(tport
),
2284 VHOST_SCSI_NAMELEN
);
2286 return ERR_PTR(-EINVAL
);
2288 snprintf(&tport
->tport_name
[0], VHOST_SCSI_NAMELEN
, "%s", &name
[off
]);
2290 pr_debug("TCM_VHost_ConfigFS: Allocated emulated Target"
2291 " %s Address: %s\n", vhost_scsi_dump_proto_id(tport
), name
);
2293 return &tport
->tport_wwn
;
2296 static void vhost_scsi_drop_tport(struct se_wwn
*wwn
)
2298 struct vhost_scsi_tport
*tport
= container_of(wwn
,
2299 struct vhost_scsi_tport
, tport_wwn
);
2301 pr_debug("TCM_VHost_ConfigFS: Deallocating emulated Target"
2302 " %s Address: %s\n", vhost_scsi_dump_proto_id(tport
),
2309 vhost_scsi_wwn_show_attr_version(struct target_fabric_configfs
*tf
,
2312 return sprintf(page
, "TCM_VHOST fabric module %s on %s/%s"
2313 "on "UTS_RELEASE
"\n", VHOST_SCSI_VERSION
, utsname()->sysname
,
2314 utsname()->machine
);
2317 TF_WWN_ATTR_RO(vhost_scsi
, version
);
2319 static struct configfs_attribute
*vhost_scsi_wwn_attrs
[] = {
2320 &vhost_scsi_wwn_version
.attr
,
2324 static struct target_core_fabric_ops vhost_scsi_ops
= {
2325 .module
= THIS_MODULE
,
2327 .get_fabric_name
= vhost_scsi_get_fabric_name
,
2328 .get_fabric_proto_ident
= vhost_scsi_get_fabric_proto_ident
,
2329 .tpg_get_wwn
= vhost_scsi_get_fabric_wwn
,
2330 .tpg_get_tag
= vhost_scsi_get_tpgt
,
2331 .tpg_get_default_depth
= vhost_scsi_get_default_depth
,
2332 .tpg_get_pr_transport_id
= vhost_scsi_get_pr_transport_id
,
2333 .tpg_get_pr_transport_id_len
= vhost_scsi_get_pr_transport_id_len
,
2334 .tpg_parse_pr_out_transport_id
= vhost_scsi_parse_pr_out_transport_id
,
2335 .tpg_check_demo_mode
= vhost_scsi_check_true
,
2336 .tpg_check_demo_mode_cache
= vhost_scsi_check_true
,
2337 .tpg_check_demo_mode_write_protect
= vhost_scsi_check_false
,
2338 .tpg_check_prod_mode_write_protect
= vhost_scsi_check_false
,
2339 .tpg_check_prot_fabric_only
= vhost_scsi_check_prot_fabric_only
,
2340 .tpg_alloc_fabric_acl
= vhost_scsi_alloc_fabric_acl
,
2341 .tpg_release_fabric_acl
= vhost_scsi_release_fabric_acl
,
2342 .tpg_get_inst_index
= vhost_scsi_tpg_get_inst_index
,
2343 .release_cmd
= vhost_scsi_release_cmd
,
2344 .check_stop_free
= vhost_scsi_check_stop_free
,
2345 .shutdown_session
= vhost_scsi_shutdown_session
,
2346 .close_session
= vhost_scsi_close_session
,
2347 .sess_get_index
= vhost_scsi_sess_get_index
,
2348 .sess_get_initiator_sid
= NULL
,
2349 .write_pending
= vhost_scsi_write_pending
,
2350 .write_pending_status
= vhost_scsi_write_pending_status
,
2351 .set_default_node_attributes
= vhost_scsi_set_default_node_attrs
,
2352 .get_task_tag
= vhost_scsi_get_task_tag
,
2353 .get_cmd_state
= vhost_scsi_get_cmd_state
,
2354 .queue_data_in
= vhost_scsi_queue_data_in
,
2355 .queue_status
= vhost_scsi_queue_status
,
2356 .queue_tm_rsp
= vhost_scsi_queue_tm_rsp
,
2357 .aborted_task
= vhost_scsi_aborted_task
,
2359 * Setup callers for generic logic in target_core_fabric_configfs.c
2361 .fabric_make_wwn
= vhost_scsi_make_tport
,
2362 .fabric_drop_wwn
= vhost_scsi_drop_tport
,
2363 .fabric_make_tpg
= vhost_scsi_make_tpg
,
2364 .fabric_drop_tpg
= vhost_scsi_drop_tpg
,
2365 .fabric_post_link
= vhost_scsi_port_link
,
2366 .fabric_pre_unlink
= vhost_scsi_port_unlink
,
2367 .fabric_make_np
= NULL
,
2368 .fabric_drop_np
= NULL
,
2369 .fabric_make_nodeacl
= vhost_scsi_make_nodeacl
,
2370 .fabric_drop_nodeacl
= vhost_scsi_drop_nodeacl
,
2372 .tfc_wwn_attrs
= vhost_scsi_wwn_attrs
,
2373 .tfc_tpg_base_attrs
= vhost_scsi_tpg_attrs
,
2374 .tfc_tpg_attrib_attrs
= vhost_scsi_tpg_attrib_attrs
,
2377 static int __init
vhost_scsi_init(void)
2381 pr_debug("TCM_VHOST fabric module %s on %s/%s"
2382 " on "UTS_RELEASE
"\n", VHOST_SCSI_VERSION
, utsname()->sysname
,
2383 utsname()->machine
);
2386 * Use our own dedicated workqueue for submitting I/O into
2387 * target core to avoid contention within system_wq.
2389 vhost_scsi_workqueue
= alloc_workqueue("vhost_scsi", 0, 0);
2390 if (!vhost_scsi_workqueue
)
2393 ret
= vhost_scsi_register();
2395 goto out_destroy_workqueue
;
2397 ret
= target_register_template(&vhost_scsi_ops
);
2399 goto out_vhost_scsi_deregister
;
2403 out_vhost_scsi_deregister
:
2404 vhost_scsi_deregister();
2405 out_destroy_workqueue
:
2406 destroy_workqueue(vhost_scsi_workqueue
);
2411 static void vhost_scsi_exit(void)
2413 target_unregister_template(&vhost_scsi_ops
);
2414 vhost_scsi_deregister();
2415 destroy_workqueue(vhost_scsi_workqueue
);
2418 MODULE_DESCRIPTION("VHOST_SCSI series fabric driver");
2419 MODULE_ALIAS("tcm_vhost");
2420 MODULE_LICENSE("GPL");
2421 module_init(vhost_scsi_init
);
2422 module_exit(vhost_scsi_exit
);