• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*******************************************************************************
2  * Vhost kernel TCM fabric driver for virtio SCSI initiators
3  *
4  * (C) Copyright 2010-2013 Datera, Inc.
5  * (C) Copyright 2010-2012 IBM Corp.
6  *
7  * Licensed to the Linux Foundation under the General Public License (GPL) version 2.
8  *
9  * Authors: Nicholas A. Bellinger <nab@daterainc.com>
10  *          Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
11  *
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.
16  *
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.
21  *
22  ****************************************************************************/
23 
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>
37 #include <linux/fs.h>
38 #include <linux/miscdevice.h>
39 #include <asm/unaligned.h>
40 #include <scsi/scsi.h>
41 #include <scsi/scsi_tcq.h>
42 #include <target/target_core_base.h>
43 #include <target/target_core_fabric.h>
44 #include <target/target_core_fabric_configfs.h>
45 #include <target/target_core_configfs.h>
46 #include <target/configfs_macros.h>
47 #include <linux/vhost.h>
48 #include <linux/virtio_scsi.h>
49 #include <linux/llist.h>
50 #include <linux/bitmap.h>
51 #include <linux/percpu_ida.h>
52 
53 #include "vhost.h"
54 
55 #define TCM_VHOST_VERSION  "v0.1"
56 #define TCM_VHOST_NAMELEN 256
57 #define TCM_VHOST_MAX_CDB_SIZE 32
58 #define TCM_VHOST_DEFAULT_TAGS 256
59 #define TCM_VHOST_PREALLOC_SGLS 2048
60 #define TCM_VHOST_PREALLOC_UPAGES 2048
61 #define TCM_VHOST_PREALLOC_PROT_SGLS 512
62 
63 struct vhost_scsi_inflight {
64 	/* Wait for the flush operation to finish */
65 	struct completion comp;
66 	/* Refcount for the inflight reqs */
67 	struct kref kref;
68 };
69 
70 struct tcm_vhost_cmd {
71 	/* Descriptor from vhost_get_vq_desc() for virt_queue segment */
72 	int tvc_vq_desc;
73 	/* virtio-scsi initiator task attribute */
74 	int tvc_task_attr;
75 	/* virtio-scsi initiator data direction */
76 	enum dma_data_direction tvc_data_direction;
77 	/* Expected data transfer length from virtio-scsi header */
78 	u32 tvc_exp_data_len;
79 	/* The Tag from include/linux/virtio_scsi.h:struct virtio_scsi_cmd_req */
80 	u64 tvc_tag;
81 	/* The number of scatterlists associated with this cmd */
82 	u32 tvc_sgl_count;
83 	u32 tvc_prot_sgl_count;
84 	/* Saved unpacked SCSI LUN for tcm_vhost_submission_work() */
85 	u32 tvc_lun;
86 	/* Pointer to the SGL formatted memory from virtio-scsi */
87 	struct scatterlist *tvc_sgl;
88 	struct scatterlist *tvc_prot_sgl;
89 	struct page **tvc_upages;
90 	/* Pointer to response */
91 	struct virtio_scsi_cmd_resp __user *tvc_resp;
92 	/* Pointer to vhost_scsi for our device */
93 	struct vhost_scsi *tvc_vhost;
94 	/* Pointer to vhost_virtqueue for the cmd */
95 	struct vhost_virtqueue *tvc_vq;
96 	/* Pointer to vhost nexus memory */
97 	struct tcm_vhost_nexus *tvc_nexus;
98 	/* The TCM I/O descriptor that is accessed via container_of() */
99 	struct se_cmd tvc_se_cmd;
100 	/* work item used for cmwq dispatch to tcm_vhost_submission_work() */
101 	struct work_struct work;
102 	/* Copy of the incoming SCSI command descriptor block (CDB) */
103 	unsigned char tvc_cdb[TCM_VHOST_MAX_CDB_SIZE];
104 	/* Sense buffer that will be mapped into outgoing status */
105 	unsigned char tvc_sense_buf[TRANSPORT_SENSE_BUFFER];
106 	/* Completed commands list, serviced from vhost worker thread */
107 	struct llist_node tvc_completion_list;
108 	/* Used to track inflight cmd */
109 	struct vhost_scsi_inflight *inflight;
110 };
111 
112 struct tcm_vhost_nexus {
113 	/* Pointer to TCM session for I_T Nexus */
114 	struct se_session *tvn_se_sess;
115 };
116 
117 struct tcm_vhost_nacl {
118 	/* Binary World Wide unique Port Name for Vhost Initiator port */
119 	u64 iport_wwpn;
120 	/* ASCII formatted WWPN for Sas Initiator port */
121 	char iport_name[TCM_VHOST_NAMELEN];
122 	/* Returned by tcm_vhost_make_nodeacl() */
123 	struct se_node_acl se_node_acl;
124 };
125 
126 struct tcm_vhost_tpg {
127 	/* Vhost port target portal group tag for TCM */
128 	u16 tport_tpgt;
129 	/* Used to track number of TPG Port/Lun Links wrt to explict I_T Nexus shutdown */
130 	int tv_tpg_port_count;
131 	/* Used for vhost_scsi device reference to tpg_nexus, protected by tv_tpg_mutex */
132 	int tv_tpg_vhost_count;
133 	/* list for tcm_vhost_list */
134 	struct list_head tv_tpg_list;
135 	/* Used to protect access for tpg_nexus */
136 	struct mutex tv_tpg_mutex;
137 	/* Pointer to the TCM VHost I_T Nexus for this TPG endpoint */
138 	struct tcm_vhost_nexus *tpg_nexus;
139 	/* Pointer back to tcm_vhost_tport */
140 	struct tcm_vhost_tport *tport;
141 	/* Returned by tcm_vhost_make_tpg() */
142 	struct se_portal_group se_tpg;
143 	/* Pointer back to vhost_scsi, protected by tv_tpg_mutex */
144 	struct vhost_scsi *vhost_scsi;
145 };
146 
147 struct tcm_vhost_tport {
148 	/* SCSI protocol the tport is providing */
149 	u8 tport_proto_id;
150 	/* Binary World Wide unique Port Name for Vhost Target port */
151 	u64 tport_wwpn;
152 	/* ASCII formatted WWPN for Vhost Target port */
153 	char tport_name[TCM_VHOST_NAMELEN];
154 	/* Returned by tcm_vhost_make_tport() */
155 	struct se_wwn tport_wwn;
156 };
157 
158 struct tcm_vhost_evt {
159 	/* event to be sent to guest */
160 	struct virtio_scsi_event event;
161 	/* event list, serviced from vhost worker thread */
162 	struct llist_node list;
163 };
164 
165 enum {
166 	VHOST_SCSI_VQ_CTL = 0,
167 	VHOST_SCSI_VQ_EVT = 1,
168 	VHOST_SCSI_VQ_IO = 2,
169 };
170 
171 enum {
172 	VHOST_SCSI_FEATURES = VHOST_FEATURES | (1ULL << VIRTIO_SCSI_F_HOTPLUG) |
173 					       (1ULL << VIRTIO_SCSI_F_T10_PI)
174 };
175 
176 #define VHOST_SCSI_MAX_TARGET	256
177 #define VHOST_SCSI_MAX_VQ	128
178 #define VHOST_SCSI_MAX_EVENT	128
179 
180 struct vhost_scsi_virtqueue {
181 	struct vhost_virtqueue vq;
182 	/*
183 	 * Reference counting for inflight reqs, used for flush operation. At
184 	 * each time, one reference tracks new commands submitted, while we
185 	 * wait for another one to reach 0.
186 	 */
187 	struct vhost_scsi_inflight inflights[2];
188 	/*
189 	 * Indicate current inflight in use, protected by vq->mutex.
190 	 * Writers must also take dev mutex and flush under it.
191 	 */
192 	int inflight_idx;
193 };
194 
195 struct vhost_scsi {
196 	/* Protected by vhost_scsi->dev.mutex */
197 	struct tcm_vhost_tpg **vs_tpg;
198 	char vs_vhost_wwpn[TRANSPORT_IQN_LEN];
199 
200 	struct vhost_dev dev;
201 	struct vhost_scsi_virtqueue vqs[VHOST_SCSI_MAX_VQ];
202 
203 	struct vhost_work vs_completion_work; /* cmd completion work item */
204 	struct llist_head vs_completion_list; /* cmd completion queue */
205 
206 	struct vhost_work vs_event_work; /* evt injection work item */
207 	struct llist_head vs_event_list; /* evt injection queue */
208 
209 	bool vs_events_missed; /* any missed events, protected by vq->mutex */
210 	int vs_events_nr; /* num of pending events, protected by vq->mutex */
211 };
212 
213 /* Local pointer to allocated TCM configfs fabric module */
214 static struct target_fabric_configfs *tcm_vhost_fabric_configfs;
215 
216 static struct workqueue_struct *tcm_vhost_workqueue;
217 
218 /* Global spinlock to protect tcm_vhost TPG list for vhost IOCTL access */
219 static DEFINE_MUTEX(tcm_vhost_mutex);
220 static LIST_HEAD(tcm_vhost_list);
221 
iov_num_pages(struct iovec * iov)222 static int iov_num_pages(struct iovec *iov)
223 {
224 	return (PAGE_ALIGN((unsigned long)iov->iov_base + iov->iov_len) -
225 	       ((unsigned long)iov->iov_base & PAGE_MASK)) >> PAGE_SHIFT;
226 }
227 
tcm_vhost_done_inflight(struct kref * kref)228 static void tcm_vhost_done_inflight(struct kref *kref)
229 {
230 	struct vhost_scsi_inflight *inflight;
231 
232 	inflight = container_of(kref, struct vhost_scsi_inflight, kref);
233 	complete(&inflight->comp);
234 }
235 
tcm_vhost_init_inflight(struct vhost_scsi * vs,struct vhost_scsi_inflight * old_inflight[])236 static void tcm_vhost_init_inflight(struct vhost_scsi *vs,
237 				    struct vhost_scsi_inflight *old_inflight[])
238 {
239 	struct vhost_scsi_inflight *new_inflight;
240 	struct vhost_virtqueue *vq;
241 	int idx, i;
242 
243 	for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
244 		vq = &vs->vqs[i].vq;
245 
246 		mutex_lock(&vq->mutex);
247 
248 		/* store old infight */
249 		idx = vs->vqs[i].inflight_idx;
250 		if (old_inflight)
251 			old_inflight[i] = &vs->vqs[i].inflights[idx];
252 
253 		/* setup new infight */
254 		vs->vqs[i].inflight_idx = idx ^ 1;
255 		new_inflight = &vs->vqs[i].inflights[idx ^ 1];
256 		kref_init(&new_inflight->kref);
257 		init_completion(&new_inflight->comp);
258 
259 		mutex_unlock(&vq->mutex);
260 	}
261 }
262 
263 static struct vhost_scsi_inflight *
tcm_vhost_get_inflight(struct vhost_virtqueue * vq)264 tcm_vhost_get_inflight(struct vhost_virtqueue *vq)
265 {
266 	struct vhost_scsi_inflight *inflight;
267 	struct vhost_scsi_virtqueue *svq;
268 
269 	svq = container_of(vq, struct vhost_scsi_virtqueue, vq);
270 	inflight = &svq->inflights[svq->inflight_idx];
271 	kref_get(&inflight->kref);
272 
273 	return inflight;
274 }
275 
tcm_vhost_put_inflight(struct vhost_scsi_inflight * inflight)276 static void tcm_vhost_put_inflight(struct vhost_scsi_inflight *inflight)
277 {
278 	kref_put(&inflight->kref, tcm_vhost_done_inflight);
279 }
280 
tcm_vhost_check_true(struct se_portal_group * se_tpg)281 static int tcm_vhost_check_true(struct se_portal_group *se_tpg)
282 {
283 	return 1;
284 }
285 
tcm_vhost_check_false(struct se_portal_group * se_tpg)286 static int tcm_vhost_check_false(struct se_portal_group *se_tpg)
287 {
288 	return 0;
289 }
290 
tcm_vhost_get_fabric_name(void)291 static char *tcm_vhost_get_fabric_name(void)
292 {
293 	return "vhost";
294 }
295 
tcm_vhost_get_fabric_proto_ident(struct se_portal_group * se_tpg)296 static u8 tcm_vhost_get_fabric_proto_ident(struct se_portal_group *se_tpg)
297 {
298 	struct tcm_vhost_tpg *tpg = container_of(se_tpg,
299 				struct tcm_vhost_tpg, se_tpg);
300 	struct tcm_vhost_tport *tport = tpg->tport;
301 
302 	switch (tport->tport_proto_id) {
303 	case SCSI_PROTOCOL_SAS:
304 		return sas_get_fabric_proto_ident(se_tpg);
305 	case SCSI_PROTOCOL_FCP:
306 		return fc_get_fabric_proto_ident(se_tpg);
307 	case SCSI_PROTOCOL_ISCSI:
308 		return iscsi_get_fabric_proto_ident(se_tpg);
309 	default:
310 		pr_err("Unknown tport_proto_id: 0x%02x, using"
311 			" SAS emulation\n", tport->tport_proto_id);
312 		break;
313 	}
314 
315 	return sas_get_fabric_proto_ident(se_tpg);
316 }
317 
tcm_vhost_get_fabric_wwn(struct se_portal_group * se_tpg)318 static char *tcm_vhost_get_fabric_wwn(struct se_portal_group *se_tpg)
319 {
320 	struct tcm_vhost_tpg *tpg = container_of(se_tpg,
321 				struct tcm_vhost_tpg, se_tpg);
322 	struct tcm_vhost_tport *tport = tpg->tport;
323 
324 	return &tport->tport_name[0];
325 }
326 
tcm_vhost_get_tag(struct se_portal_group * se_tpg)327 static u16 tcm_vhost_get_tag(struct se_portal_group *se_tpg)
328 {
329 	struct tcm_vhost_tpg *tpg = container_of(se_tpg,
330 				struct tcm_vhost_tpg, se_tpg);
331 	return tpg->tport_tpgt;
332 }
333 
tcm_vhost_get_default_depth(struct se_portal_group * se_tpg)334 static u32 tcm_vhost_get_default_depth(struct se_portal_group *se_tpg)
335 {
336 	return 1;
337 }
338 
339 static u32
tcm_vhost_get_pr_transport_id(struct se_portal_group * se_tpg,struct se_node_acl * se_nacl,struct t10_pr_registration * pr_reg,int * format_code,unsigned char * buf)340 tcm_vhost_get_pr_transport_id(struct se_portal_group *se_tpg,
341 			      struct se_node_acl *se_nacl,
342 			      struct t10_pr_registration *pr_reg,
343 			      int *format_code,
344 			      unsigned char *buf)
345 {
346 	struct tcm_vhost_tpg *tpg = container_of(se_tpg,
347 				struct tcm_vhost_tpg, se_tpg);
348 	struct tcm_vhost_tport *tport = tpg->tport;
349 
350 	switch (tport->tport_proto_id) {
351 	case SCSI_PROTOCOL_SAS:
352 		return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
353 					format_code, buf);
354 	case SCSI_PROTOCOL_FCP:
355 		return fc_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
356 					format_code, buf);
357 	case SCSI_PROTOCOL_ISCSI:
358 		return iscsi_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
359 					format_code, buf);
360 	default:
361 		pr_err("Unknown tport_proto_id: 0x%02x, using"
362 			" SAS emulation\n", tport->tport_proto_id);
363 		break;
364 	}
365 
366 	return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
367 			format_code, buf);
368 }
369 
370 static u32
tcm_vhost_get_pr_transport_id_len(struct se_portal_group * se_tpg,struct se_node_acl * se_nacl,struct t10_pr_registration * pr_reg,int * format_code)371 tcm_vhost_get_pr_transport_id_len(struct se_portal_group *se_tpg,
372 				  struct se_node_acl *se_nacl,
373 				  struct t10_pr_registration *pr_reg,
374 				  int *format_code)
375 {
376 	struct tcm_vhost_tpg *tpg = container_of(se_tpg,
377 				struct tcm_vhost_tpg, se_tpg);
378 	struct tcm_vhost_tport *tport = tpg->tport;
379 
380 	switch (tport->tport_proto_id) {
381 	case SCSI_PROTOCOL_SAS:
382 		return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
383 					format_code);
384 	case SCSI_PROTOCOL_FCP:
385 		return fc_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
386 					format_code);
387 	case SCSI_PROTOCOL_ISCSI:
388 		return iscsi_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
389 					format_code);
390 	default:
391 		pr_err("Unknown tport_proto_id: 0x%02x, using"
392 			" SAS emulation\n", tport->tport_proto_id);
393 		break;
394 	}
395 
396 	return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
397 			format_code);
398 }
399 
400 static char *
tcm_vhost_parse_pr_out_transport_id(struct se_portal_group * se_tpg,const char * buf,u32 * out_tid_len,char ** port_nexus_ptr)401 tcm_vhost_parse_pr_out_transport_id(struct se_portal_group *se_tpg,
402 				    const char *buf,
403 				    u32 *out_tid_len,
404 				    char **port_nexus_ptr)
405 {
406 	struct tcm_vhost_tpg *tpg = container_of(se_tpg,
407 				struct tcm_vhost_tpg, se_tpg);
408 	struct tcm_vhost_tport *tport = tpg->tport;
409 
410 	switch (tport->tport_proto_id) {
411 	case SCSI_PROTOCOL_SAS:
412 		return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
413 					port_nexus_ptr);
414 	case SCSI_PROTOCOL_FCP:
415 		return fc_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
416 					port_nexus_ptr);
417 	case SCSI_PROTOCOL_ISCSI:
418 		return iscsi_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
419 					port_nexus_ptr);
420 	default:
421 		pr_err("Unknown tport_proto_id: 0x%02x, using"
422 			" SAS emulation\n", tport->tport_proto_id);
423 		break;
424 	}
425 
426 	return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
427 			port_nexus_ptr);
428 }
429 
430 static struct se_node_acl *
tcm_vhost_alloc_fabric_acl(struct se_portal_group * se_tpg)431 tcm_vhost_alloc_fabric_acl(struct se_portal_group *se_tpg)
432 {
433 	struct tcm_vhost_nacl *nacl;
434 
435 	nacl = kzalloc(sizeof(struct tcm_vhost_nacl), GFP_KERNEL);
436 	if (!nacl) {
437 		pr_err("Unable to allocate struct tcm_vhost_nacl\n");
438 		return NULL;
439 	}
440 
441 	return &nacl->se_node_acl;
442 }
443 
444 static void
tcm_vhost_release_fabric_acl(struct se_portal_group * se_tpg,struct se_node_acl * se_nacl)445 tcm_vhost_release_fabric_acl(struct se_portal_group *se_tpg,
446 			     struct se_node_acl *se_nacl)
447 {
448 	struct tcm_vhost_nacl *nacl = container_of(se_nacl,
449 			struct tcm_vhost_nacl, se_node_acl);
450 	kfree(nacl);
451 }
452 
tcm_vhost_tpg_get_inst_index(struct se_portal_group * se_tpg)453 static u32 tcm_vhost_tpg_get_inst_index(struct se_portal_group *se_tpg)
454 {
455 	return 1;
456 }
457 
tcm_vhost_release_cmd(struct se_cmd * se_cmd)458 static void tcm_vhost_release_cmd(struct se_cmd *se_cmd)
459 {
460 	struct tcm_vhost_cmd *tv_cmd = container_of(se_cmd,
461 				struct tcm_vhost_cmd, tvc_se_cmd);
462 	struct se_session *se_sess = se_cmd->se_sess;
463 	int i;
464 
465 	if (tv_cmd->tvc_sgl_count) {
466 		for (i = 0; i < tv_cmd->tvc_sgl_count; i++)
467 			put_page(sg_page(&tv_cmd->tvc_sgl[i]));
468 	}
469 	if (tv_cmd->tvc_prot_sgl_count) {
470 		for (i = 0; i < tv_cmd->tvc_prot_sgl_count; i++)
471 			put_page(sg_page(&tv_cmd->tvc_prot_sgl[i]));
472 	}
473 
474 	tcm_vhost_put_inflight(tv_cmd->inflight);
475 	percpu_ida_free(&se_sess->sess_tag_pool, se_cmd->map_tag);
476 }
477 
tcm_vhost_shutdown_session(struct se_session * se_sess)478 static int tcm_vhost_shutdown_session(struct se_session *se_sess)
479 {
480 	return 0;
481 }
482 
tcm_vhost_close_session(struct se_session * se_sess)483 static void tcm_vhost_close_session(struct se_session *se_sess)
484 {
485 	return;
486 }
487 
tcm_vhost_sess_get_index(struct se_session * se_sess)488 static u32 tcm_vhost_sess_get_index(struct se_session *se_sess)
489 {
490 	return 0;
491 }
492 
tcm_vhost_write_pending(struct se_cmd * se_cmd)493 static int tcm_vhost_write_pending(struct se_cmd *se_cmd)
494 {
495 	/* Go ahead and process the write immediately */
496 	target_execute_cmd(se_cmd);
497 	return 0;
498 }
499 
tcm_vhost_write_pending_status(struct se_cmd * se_cmd)500 static int tcm_vhost_write_pending_status(struct se_cmd *se_cmd)
501 {
502 	return 0;
503 }
504 
tcm_vhost_set_default_node_attrs(struct se_node_acl * nacl)505 static void tcm_vhost_set_default_node_attrs(struct se_node_acl *nacl)
506 {
507 	return;
508 }
509 
tcm_vhost_get_task_tag(struct se_cmd * se_cmd)510 static u32 tcm_vhost_get_task_tag(struct se_cmd *se_cmd)
511 {
512 	return 0;
513 }
514 
tcm_vhost_get_cmd_state(struct se_cmd * se_cmd)515 static int tcm_vhost_get_cmd_state(struct se_cmd *se_cmd)
516 {
517 	return 0;
518 }
519 
vhost_scsi_complete_cmd(struct tcm_vhost_cmd * cmd)520 static void vhost_scsi_complete_cmd(struct tcm_vhost_cmd *cmd)
521 {
522 	struct vhost_scsi *vs = cmd->tvc_vhost;
523 
524 	llist_add(&cmd->tvc_completion_list, &vs->vs_completion_list);
525 
526 	vhost_work_queue(&vs->dev, &vs->vs_completion_work);
527 }
528 
tcm_vhost_queue_data_in(struct se_cmd * se_cmd)529 static int tcm_vhost_queue_data_in(struct se_cmd *se_cmd)
530 {
531 	struct tcm_vhost_cmd *cmd = container_of(se_cmd,
532 				struct tcm_vhost_cmd, tvc_se_cmd);
533 	vhost_scsi_complete_cmd(cmd);
534 	return 0;
535 }
536 
tcm_vhost_queue_status(struct se_cmd * se_cmd)537 static int tcm_vhost_queue_status(struct se_cmd *se_cmd)
538 {
539 	struct tcm_vhost_cmd *cmd = container_of(se_cmd,
540 				struct tcm_vhost_cmd, tvc_se_cmd);
541 	vhost_scsi_complete_cmd(cmd);
542 	return 0;
543 }
544 
tcm_vhost_queue_tm_rsp(struct se_cmd * se_cmd)545 static void tcm_vhost_queue_tm_rsp(struct se_cmd *se_cmd)
546 {
547 	return;
548 }
549 
tcm_vhost_aborted_task(struct se_cmd * se_cmd)550 static void tcm_vhost_aborted_task(struct se_cmd *se_cmd)
551 {
552 	return;
553 }
554 
tcm_vhost_free_evt(struct vhost_scsi * vs,struct tcm_vhost_evt * evt)555 static void tcm_vhost_free_evt(struct vhost_scsi *vs, struct tcm_vhost_evt *evt)
556 {
557 	vs->vs_events_nr--;
558 	kfree(evt);
559 }
560 
561 static struct tcm_vhost_evt *
tcm_vhost_allocate_evt(struct vhost_scsi * vs,u32 event,u32 reason)562 tcm_vhost_allocate_evt(struct vhost_scsi *vs,
563 		       u32 event, u32 reason)
564 {
565 	struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
566 	struct tcm_vhost_evt *evt;
567 
568 	if (vs->vs_events_nr > VHOST_SCSI_MAX_EVENT) {
569 		vs->vs_events_missed = true;
570 		return NULL;
571 	}
572 
573 	evt = kzalloc(sizeof(*evt), GFP_KERNEL);
574 	if (!evt) {
575 		vq_err(vq, "Failed to allocate tcm_vhost_evt\n");
576 		vs->vs_events_missed = true;
577 		return NULL;
578 	}
579 
580 	evt->event.event = event;
581 	evt->event.reason = reason;
582 	vs->vs_events_nr++;
583 
584 	return evt;
585 }
586 
vhost_scsi_free_cmd(struct tcm_vhost_cmd * cmd)587 static void vhost_scsi_free_cmd(struct tcm_vhost_cmd *cmd)
588 {
589 	struct se_cmd *se_cmd = &cmd->tvc_se_cmd;
590 
591 	/* TODO locking against target/backend threads? */
592 	transport_generic_free_cmd(se_cmd, 0);
593 
594 }
595 
vhost_scsi_check_stop_free(struct se_cmd * se_cmd)596 static int vhost_scsi_check_stop_free(struct se_cmd *se_cmd)
597 {
598 	return target_put_sess_cmd(se_cmd);
599 }
600 
601 static void
tcm_vhost_do_evt_work(struct vhost_scsi * vs,struct tcm_vhost_evt * evt)602 tcm_vhost_do_evt_work(struct vhost_scsi *vs, struct tcm_vhost_evt *evt)
603 {
604 	struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
605 	struct virtio_scsi_event *event = &evt->event;
606 	struct virtio_scsi_event __user *eventp;
607 	unsigned out, in;
608 	int head, ret;
609 
610 	if (!vq->private_data) {
611 		vs->vs_events_missed = true;
612 		return;
613 	}
614 
615 again:
616 	vhost_disable_notify(&vs->dev, vq);
617 	head = vhost_get_vq_desc(vq, vq->iov,
618 			ARRAY_SIZE(vq->iov), &out, &in,
619 			NULL, NULL);
620 	if (head < 0) {
621 		vs->vs_events_missed = true;
622 		return;
623 	}
624 	if (head == vq->num) {
625 		if (vhost_enable_notify(&vs->dev, vq))
626 			goto again;
627 		vs->vs_events_missed = true;
628 		return;
629 	}
630 
631 	if ((vq->iov[out].iov_len != sizeof(struct virtio_scsi_event))) {
632 		vq_err(vq, "Expecting virtio_scsi_event, got %zu bytes\n",
633 				vq->iov[out].iov_len);
634 		vs->vs_events_missed = true;
635 		return;
636 	}
637 
638 	if (vs->vs_events_missed) {
639 		event->event |= VIRTIO_SCSI_T_EVENTS_MISSED;
640 		vs->vs_events_missed = false;
641 	}
642 
643 	eventp = vq->iov[out].iov_base;
644 	ret = __copy_to_user(eventp, event, sizeof(*event));
645 	if (!ret)
646 		vhost_add_used_and_signal(&vs->dev, vq, head, 0);
647 	else
648 		vq_err(vq, "Faulted on tcm_vhost_send_event\n");
649 }
650 
tcm_vhost_evt_work(struct vhost_work * work)651 static void tcm_vhost_evt_work(struct vhost_work *work)
652 {
653 	struct vhost_scsi *vs = container_of(work, struct vhost_scsi,
654 					vs_event_work);
655 	struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
656 	struct tcm_vhost_evt *evt;
657 	struct llist_node *llnode;
658 
659 	mutex_lock(&vq->mutex);
660 	llnode = llist_del_all(&vs->vs_event_list);
661 	while (llnode) {
662 		evt = llist_entry(llnode, struct tcm_vhost_evt, list);
663 		llnode = llist_next(llnode);
664 		tcm_vhost_do_evt_work(vs, evt);
665 		tcm_vhost_free_evt(vs, evt);
666 	}
667 	mutex_unlock(&vq->mutex);
668 }
669 
670 /* Fill in status and signal that we are done processing this command
671  *
672  * This is scheduled in the vhost work queue so we are called with the owner
673  * process mm and can access the vring.
674  */
vhost_scsi_complete_cmd_work(struct vhost_work * work)675 static void vhost_scsi_complete_cmd_work(struct vhost_work *work)
676 {
677 	struct vhost_scsi *vs = container_of(work, struct vhost_scsi,
678 					vs_completion_work);
679 	DECLARE_BITMAP(signal, VHOST_SCSI_MAX_VQ);
680 	struct virtio_scsi_cmd_resp v_rsp;
681 	struct tcm_vhost_cmd *cmd;
682 	struct llist_node *llnode;
683 	struct se_cmd *se_cmd;
684 	int ret, vq;
685 
686 	bitmap_zero(signal, VHOST_SCSI_MAX_VQ);
687 	llnode = llist_del_all(&vs->vs_completion_list);
688 	while (llnode) {
689 		cmd = llist_entry(llnode, struct tcm_vhost_cmd,
690 				     tvc_completion_list);
691 		llnode = llist_next(llnode);
692 		se_cmd = &cmd->tvc_se_cmd;
693 
694 		pr_debug("%s tv_cmd %p resid %u status %#02x\n", __func__,
695 			cmd, se_cmd->residual_count, se_cmd->scsi_status);
696 
697 		memset(&v_rsp, 0, sizeof(v_rsp));
698 		v_rsp.resid = se_cmd->residual_count;
699 		/* TODO is status_qualifier field needed? */
700 		v_rsp.status = se_cmd->scsi_status;
701 		v_rsp.sense_len = se_cmd->scsi_sense_length;
702 		memcpy(v_rsp.sense, cmd->tvc_sense_buf,
703 		       v_rsp.sense_len);
704 		ret = copy_to_user(cmd->tvc_resp, &v_rsp, sizeof(v_rsp));
705 		if (likely(ret == 0)) {
706 			struct vhost_scsi_virtqueue *q;
707 			vhost_add_used(cmd->tvc_vq, cmd->tvc_vq_desc, 0);
708 			q = container_of(cmd->tvc_vq, struct vhost_scsi_virtqueue, vq);
709 			vq = q - vs->vqs;
710 			__set_bit(vq, signal);
711 		} else
712 			pr_err("Faulted on virtio_scsi_cmd_resp\n");
713 
714 		vhost_scsi_free_cmd(cmd);
715 	}
716 
717 	vq = -1;
718 	while ((vq = find_next_bit(signal, VHOST_SCSI_MAX_VQ, vq + 1))
719 		< VHOST_SCSI_MAX_VQ)
720 		vhost_signal(&vs->dev, &vs->vqs[vq].vq);
721 }
722 
723 static struct tcm_vhost_cmd *
vhost_scsi_get_tag(struct vhost_virtqueue * vq,struct tcm_vhost_tpg * tpg,unsigned char * cdb,u64 scsi_tag,u16 lun,u8 task_attr,u32 exp_data_len,int data_direction)724 vhost_scsi_get_tag(struct vhost_virtqueue *vq, struct tcm_vhost_tpg *tpg,
725 		   unsigned char *cdb, u64 scsi_tag, u16 lun, u8 task_attr,
726 		   u32 exp_data_len, int data_direction)
727 {
728 	struct tcm_vhost_cmd *cmd;
729 	struct tcm_vhost_nexus *tv_nexus;
730 	struct se_session *se_sess;
731 	struct scatterlist *sg, *prot_sg;
732 	struct page **pages;
733 	int tag;
734 
735 	tv_nexus = tpg->tpg_nexus;
736 	if (!tv_nexus) {
737 		pr_err("Unable to locate active struct tcm_vhost_nexus\n");
738 		return ERR_PTR(-EIO);
739 	}
740 	se_sess = tv_nexus->tvn_se_sess;
741 
742 	tag = percpu_ida_alloc(&se_sess->sess_tag_pool, TASK_RUNNING);
743 	if (tag < 0) {
744 		pr_err("Unable to obtain tag for tcm_vhost_cmd\n");
745 		return ERR_PTR(-ENOMEM);
746 	}
747 
748 	cmd = &((struct tcm_vhost_cmd *)se_sess->sess_cmd_map)[tag];
749 	sg = cmd->tvc_sgl;
750 	prot_sg = cmd->tvc_prot_sgl;
751 	pages = cmd->tvc_upages;
752 	memset(cmd, 0, sizeof(struct tcm_vhost_cmd));
753 
754 	cmd->tvc_sgl = sg;
755 	cmd->tvc_prot_sgl = prot_sg;
756 	cmd->tvc_upages = pages;
757 	cmd->tvc_se_cmd.map_tag = tag;
758 	cmd->tvc_tag = scsi_tag;
759 	cmd->tvc_lun = lun;
760 	cmd->tvc_task_attr = task_attr;
761 	cmd->tvc_exp_data_len = exp_data_len;
762 	cmd->tvc_data_direction = data_direction;
763 	cmd->tvc_nexus = tv_nexus;
764 	cmd->inflight = tcm_vhost_get_inflight(vq);
765 
766 	memcpy(cmd->tvc_cdb, cdb, TCM_VHOST_MAX_CDB_SIZE);
767 
768 	return cmd;
769 }
770 
771 /*
772  * Map a user memory range into a scatterlist
773  *
774  * Returns the number of scatterlist entries used or -errno on error.
775  */
776 static int
vhost_scsi_map_to_sgl(struct tcm_vhost_cmd * tv_cmd,struct scatterlist * sgl,unsigned int sgl_count,struct iovec * iov,struct page ** pages,bool write)777 vhost_scsi_map_to_sgl(struct tcm_vhost_cmd *tv_cmd,
778 		      struct scatterlist *sgl,
779 		      unsigned int sgl_count,
780 		      struct iovec *iov,
781 		      struct page **pages,
782 		      bool write)
783 {
784 	unsigned int npages = 0, pages_nr, offset, nbytes;
785 	struct scatterlist *sg = sgl;
786 	void __user *ptr = iov->iov_base;
787 	size_t len = iov->iov_len;
788 	int ret, i;
789 
790 	pages_nr = iov_num_pages(iov);
791 	if (pages_nr > sgl_count) {
792 		pr_err("vhost_scsi_map_to_sgl() pages_nr: %u greater than"
793 		       " sgl_count: %u\n", pages_nr, sgl_count);
794 		return -ENOBUFS;
795 	}
796 	if (pages_nr > TCM_VHOST_PREALLOC_UPAGES) {
797 		pr_err("vhost_scsi_map_to_sgl() pages_nr: %u greater than"
798 		       " preallocated TCM_VHOST_PREALLOC_UPAGES: %u\n",
799 			pages_nr, TCM_VHOST_PREALLOC_UPAGES);
800 		return -ENOBUFS;
801 	}
802 
803 	ret = get_user_pages_fast((unsigned long)ptr, pages_nr, write, pages);
804 	/* No pages were pinned */
805 	if (ret < 0)
806 		goto out;
807 	/* Less pages pinned than wanted */
808 	if (ret != pages_nr) {
809 		for (i = 0; i < ret; i++)
810 			put_page(pages[i]);
811 		ret = -EFAULT;
812 		goto out;
813 	}
814 
815 	while (len > 0) {
816 		offset = (uintptr_t)ptr & ~PAGE_MASK;
817 		nbytes = min_t(unsigned int, PAGE_SIZE - offset, len);
818 		sg_set_page(sg, pages[npages], nbytes, offset);
819 		ptr += nbytes;
820 		len -= nbytes;
821 		sg++;
822 		npages++;
823 	}
824 
825 out:
826 	return ret;
827 }
828 
829 static int
vhost_scsi_map_iov_to_sgl(struct tcm_vhost_cmd * cmd,struct iovec * iov,int niov,bool write)830 vhost_scsi_map_iov_to_sgl(struct tcm_vhost_cmd *cmd,
831 			  struct iovec *iov,
832 			  int niov,
833 			  bool write)
834 {
835 	struct scatterlist *sg = cmd->tvc_sgl;
836 	unsigned int sgl_count = 0;
837 	int ret, i;
838 
839 	for (i = 0; i < niov; i++)
840 		sgl_count += iov_num_pages(&iov[i]);
841 
842 	if (sgl_count > TCM_VHOST_PREALLOC_SGLS) {
843 		pr_err("vhost_scsi_map_iov_to_sgl() sgl_count: %u greater than"
844 			" preallocated TCM_VHOST_PREALLOC_SGLS: %u\n",
845 			sgl_count, TCM_VHOST_PREALLOC_SGLS);
846 		return -ENOBUFS;
847 	}
848 
849 	pr_debug("%s sg %p sgl_count %u\n", __func__, sg, sgl_count);
850 	sg_init_table(sg, sgl_count);
851 	cmd->tvc_sgl_count = sgl_count;
852 
853 	pr_debug("Mapping iovec %p for %u pages\n", &iov[0], sgl_count);
854 
855 	for (i = 0; i < niov; i++) {
856 		ret = vhost_scsi_map_to_sgl(cmd, sg, sgl_count, &iov[i],
857 					    cmd->tvc_upages, write);
858 		if (ret < 0) {
859 			for (i = 0; i < cmd->tvc_sgl_count; i++)
860 				put_page(sg_page(&cmd->tvc_sgl[i]));
861 
862 			cmd->tvc_sgl_count = 0;
863 			return ret;
864 		}
865 		sg += ret;
866 		sgl_count -= ret;
867 	}
868 	return 0;
869 }
870 
871 static int
vhost_scsi_map_iov_to_prot(struct tcm_vhost_cmd * cmd,struct iovec * iov,int niov,bool write)872 vhost_scsi_map_iov_to_prot(struct tcm_vhost_cmd *cmd,
873 			   struct iovec *iov,
874 			   int niov,
875 			   bool write)
876 {
877 	struct scatterlist *prot_sg = cmd->tvc_prot_sgl;
878 	unsigned int prot_sgl_count = 0;
879 	int ret, i;
880 
881 	for (i = 0; i < niov; i++)
882 		prot_sgl_count += iov_num_pages(&iov[i]);
883 
884 	if (prot_sgl_count > TCM_VHOST_PREALLOC_PROT_SGLS) {
885 		pr_err("vhost_scsi_map_iov_to_prot() sgl_count: %u greater than"
886 			" preallocated TCM_VHOST_PREALLOC_PROT_SGLS: %u\n",
887 			prot_sgl_count, TCM_VHOST_PREALLOC_PROT_SGLS);
888 		return -ENOBUFS;
889 	}
890 
891 	pr_debug("%s prot_sg %p prot_sgl_count %u\n", __func__,
892 		 prot_sg, prot_sgl_count);
893 	sg_init_table(prot_sg, prot_sgl_count);
894 	cmd->tvc_prot_sgl_count = prot_sgl_count;
895 
896 	for (i = 0; i < niov; i++) {
897 		ret = vhost_scsi_map_to_sgl(cmd, prot_sg, prot_sgl_count, &iov[i],
898 					    cmd->tvc_upages, write);
899 		if (ret < 0) {
900 			for (i = 0; i < cmd->tvc_prot_sgl_count; i++)
901 				put_page(sg_page(&cmd->tvc_prot_sgl[i]));
902 
903 			cmd->tvc_prot_sgl_count = 0;
904 			return ret;
905 		}
906 		prot_sg += ret;
907 		prot_sgl_count -= ret;
908 	}
909 	return 0;
910 }
911 
vhost_scsi_to_tcm_attr(int attr)912 static int vhost_scsi_to_tcm_attr(int attr)
913 {
914 	switch (attr) {
915 	case VIRTIO_SCSI_S_SIMPLE:
916 		return MSG_SIMPLE_TAG;
917 	case VIRTIO_SCSI_S_ORDERED:
918 		return MSG_ORDERED_TAG;
919 	case VIRTIO_SCSI_S_HEAD:
920 		return MSG_HEAD_TAG;
921 	case VIRTIO_SCSI_S_ACA:
922 		return MSG_ACA_TAG;
923 	default:
924 		break;
925 	}
926 	return MSG_SIMPLE_TAG;
927 }
928 
tcm_vhost_submission_work(struct work_struct * work)929 static void tcm_vhost_submission_work(struct work_struct *work)
930 {
931 	struct tcm_vhost_cmd *cmd =
932 		container_of(work, struct tcm_vhost_cmd, work);
933 	struct tcm_vhost_nexus *tv_nexus;
934 	struct se_cmd *se_cmd = &cmd->tvc_se_cmd;
935 	struct scatterlist *sg_ptr, *sg_prot_ptr = NULL;
936 	int rc;
937 
938 	/* FIXME: BIDI operation */
939 	if (cmd->tvc_sgl_count) {
940 		sg_ptr = cmd->tvc_sgl;
941 
942 		if (cmd->tvc_prot_sgl_count)
943 			sg_prot_ptr = cmd->tvc_prot_sgl;
944 		else
945 			se_cmd->prot_pto = true;
946 	} else {
947 		sg_ptr = NULL;
948 	}
949 	tv_nexus = cmd->tvc_nexus;
950 
951 	rc = target_submit_cmd_map_sgls(se_cmd, tv_nexus->tvn_se_sess,
952 			cmd->tvc_cdb, &cmd->tvc_sense_buf[0],
953 			cmd->tvc_lun, cmd->tvc_exp_data_len,
954 			vhost_scsi_to_tcm_attr(cmd->tvc_task_attr),
955 			cmd->tvc_data_direction, TARGET_SCF_ACK_KREF,
956 			sg_ptr, cmd->tvc_sgl_count, NULL, 0,
957 			sg_prot_ptr, cmd->tvc_prot_sgl_count);
958 	if (rc < 0) {
959 		transport_send_check_condition_and_sense(se_cmd,
960 				TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE, 0);
961 		transport_generic_free_cmd(se_cmd, 0);
962 	}
963 }
964 
965 static void
vhost_scsi_send_bad_target(struct vhost_scsi * vs,struct vhost_virtqueue * vq,int head,unsigned out)966 vhost_scsi_send_bad_target(struct vhost_scsi *vs,
967 			   struct vhost_virtqueue *vq,
968 			   int head, unsigned out)
969 {
970 	struct virtio_scsi_cmd_resp __user *resp;
971 	struct virtio_scsi_cmd_resp rsp;
972 	int ret;
973 
974 	memset(&rsp, 0, sizeof(rsp));
975 	rsp.response = VIRTIO_SCSI_S_BAD_TARGET;
976 	resp = vq->iov[out].iov_base;
977 	ret = __copy_to_user(resp, &rsp, sizeof(rsp));
978 	if (!ret)
979 		vhost_add_used_and_signal(&vs->dev, vq, head, 0);
980 	else
981 		pr_err("Faulted on virtio_scsi_cmd_resp\n");
982 }
983 
984 static void
vhost_scsi_handle_vq(struct vhost_scsi * vs,struct vhost_virtqueue * vq)985 vhost_scsi_handle_vq(struct vhost_scsi *vs, struct vhost_virtqueue *vq)
986 {
987 	struct tcm_vhost_tpg **vs_tpg;
988 	struct virtio_scsi_cmd_req v_req;
989 	struct virtio_scsi_cmd_req_pi v_req_pi;
990 	struct tcm_vhost_tpg *tpg;
991 	struct tcm_vhost_cmd *cmd;
992 	u64 tag;
993 	u32 exp_data_len, data_first, data_num, data_direction, prot_first;
994 	unsigned out, in, i;
995 	int head, ret, data_niov, prot_niov, prot_bytes;
996 	size_t req_size;
997 	u16 lun;
998 	u8 *target, *lunp, task_attr;
999 	bool hdr_pi;
1000 	void *req, *cdb;
1001 
1002 	mutex_lock(&vq->mutex);
1003 	/*
1004 	 * We can handle the vq only after the endpoint is setup by calling the
1005 	 * VHOST_SCSI_SET_ENDPOINT ioctl.
1006 	 */
1007 	vs_tpg = vq->private_data;
1008 	if (!vs_tpg)
1009 		goto out;
1010 
1011 	vhost_disable_notify(&vs->dev, vq);
1012 
1013 	for (;;) {
1014 		head = vhost_get_vq_desc(vq, vq->iov,
1015 					ARRAY_SIZE(vq->iov), &out, &in,
1016 					NULL, NULL);
1017 		pr_debug("vhost_get_vq_desc: head: %d, out: %u in: %u\n",
1018 					head, out, in);
1019 		/* On error, stop handling until the next kick. */
1020 		if (unlikely(head < 0))
1021 			break;
1022 		/* Nothing new?  Wait for eventfd to tell us they refilled. */
1023 		if (head == vq->num) {
1024 			if (unlikely(vhost_enable_notify(&vs->dev, vq))) {
1025 				vhost_disable_notify(&vs->dev, vq);
1026 				continue;
1027 			}
1028 			break;
1029 		}
1030 
1031 		/* FIXME: BIDI operation */
1032 		if (out == 1 && in == 1) {
1033 			data_direction = DMA_NONE;
1034 			data_first = 0;
1035 			data_num = 0;
1036 		} else if (out == 1 && in > 1) {
1037 			data_direction = DMA_FROM_DEVICE;
1038 			data_first = out + 1;
1039 			data_num = in - 1;
1040 		} else if (out > 1 && in == 1) {
1041 			data_direction = DMA_TO_DEVICE;
1042 			data_first = 1;
1043 			data_num = out - 1;
1044 		} else {
1045 			vq_err(vq, "Invalid buffer layout out: %u in: %u\n",
1046 					out, in);
1047 			break;
1048 		}
1049 
1050 		/*
1051 		 * Check for a sane resp buffer so we can report errors to
1052 		 * the guest.
1053 		 */
1054 		if (unlikely(vq->iov[out].iov_len !=
1055 					sizeof(struct virtio_scsi_cmd_resp))) {
1056 			vq_err(vq, "Expecting virtio_scsi_cmd_resp, got %zu"
1057 				" bytes\n", vq->iov[out].iov_len);
1058 			break;
1059 		}
1060 
1061 		if (vhost_has_feature(vq, VIRTIO_SCSI_F_T10_PI)) {
1062 			req = &v_req_pi;
1063 			lunp = &v_req_pi.lun[0];
1064 			target = &v_req_pi.lun[1];
1065 			req_size = sizeof(v_req_pi);
1066 			hdr_pi = true;
1067 		} else {
1068 			req = &v_req;
1069 			lunp = &v_req.lun[0];
1070 			target = &v_req.lun[1];
1071 			req_size = sizeof(v_req);
1072 			hdr_pi = false;
1073 		}
1074 
1075 		if (unlikely(vq->iov[0].iov_len < req_size)) {
1076 			pr_err("Expecting virtio-scsi header: %zu, got %zu\n",
1077 			       req_size, vq->iov[0].iov_len);
1078 			break;
1079 		}
1080 		ret = memcpy_fromiovecend(req, &vq->iov[0], 0, req_size);
1081 		if (unlikely(ret)) {
1082 			vq_err(vq, "Faulted on virtio_scsi_cmd_req\n");
1083 			break;
1084 		}
1085 
1086 		/* virtio-scsi spec requires byte 0 of the lun to be 1 */
1087 		if (unlikely(*lunp != 1)) {
1088 			vhost_scsi_send_bad_target(vs, vq, head, out);
1089 			continue;
1090 		}
1091 
1092 		tpg = ACCESS_ONCE(vs_tpg[*target]);
1093 
1094 		/* Target does not exist, fail the request */
1095 		if (unlikely(!tpg)) {
1096 			vhost_scsi_send_bad_target(vs, vq, head, out);
1097 			continue;
1098 		}
1099 
1100 		data_niov = data_num;
1101 		prot_niov = prot_first = prot_bytes = 0;
1102 		/*
1103 		 * Determine if any protection information iovecs are preceeding
1104 		 * the actual data payload, and adjust data_first + data_niov
1105 		 * values accordingly for vhost_scsi_map_iov_to_sgl() below.
1106 		 *
1107 		 * Also extract virtio_scsi header bits for vhost_scsi_get_tag()
1108 		 */
1109 		if (hdr_pi) {
1110 			if (v_req_pi.pi_bytesout) {
1111 				if (data_direction != DMA_TO_DEVICE) {
1112 					vq_err(vq, "Received non zero do_pi_niov"
1113 						", but wrong data_direction\n");
1114 					goto err_cmd;
1115 				}
1116 				prot_bytes = v_req_pi.pi_bytesout;
1117 			} else if (v_req_pi.pi_bytesin) {
1118 				if (data_direction != DMA_FROM_DEVICE) {
1119 					vq_err(vq, "Received non zero di_pi_niov"
1120 						", but wrong data_direction\n");
1121 					goto err_cmd;
1122 				}
1123 				prot_bytes = v_req_pi.pi_bytesin;
1124 			}
1125 			if (prot_bytes) {
1126 				int tmp = 0;
1127 
1128 				for (i = 0; i < data_num; i++) {
1129 					tmp += vq->iov[data_first + i].iov_len;
1130 					prot_niov++;
1131 					if (tmp >= prot_bytes)
1132 						break;
1133 				}
1134 				prot_first = data_first;
1135 				data_first += prot_niov;
1136 				data_niov = data_num - prot_niov;
1137 			}
1138 			tag = v_req_pi.tag;
1139 			task_attr = v_req_pi.task_attr;
1140 			cdb = &v_req_pi.cdb[0];
1141 			lun = ((v_req_pi.lun[2] << 8) | v_req_pi.lun[3]) & 0x3FFF;
1142 		} else {
1143 			tag = v_req.tag;
1144 			task_attr = v_req.task_attr;
1145 			cdb = &v_req.cdb[0];
1146 			lun = ((v_req.lun[2] << 8) | v_req.lun[3]) & 0x3FFF;
1147 		}
1148 		exp_data_len = 0;
1149 		for (i = 0; i < data_niov; i++)
1150 			exp_data_len += vq->iov[data_first + i].iov_len;
1151 		/*
1152 		 * Check that the recieved CDB size does not exceeded our
1153 		 * hardcoded max for vhost-scsi
1154 		 *
1155 		 * TODO what if cdb was too small for varlen cdb header?
1156 		 */
1157 		if (unlikely(scsi_command_size(cdb) > TCM_VHOST_MAX_CDB_SIZE)) {
1158 			vq_err(vq, "Received SCSI CDB with command_size: %d that"
1159 				" exceeds SCSI_MAX_VARLEN_CDB_SIZE: %d\n",
1160 				scsi_command_size(cdb), TCM_VHOST_MAX_CDB_SIZE);
1161 			goto err_cmd;
1162 		}
1163 
1164 		cmd = vhost_scsi_get_tag(vq, tpg, cdb, tag, lun, task_attr,
1165 					 exp_data_len + prot_bytes,
1166 					 data_direction);
1167 		if (IS_ERR(cmd)) {
1168 			vq_err(vq, "vhost_scsi_get_tag failed %ld\n",
1169 					PTR_ERR(cmd));
1170 			goto err_cmd;
1171 		}
1172 
1173 		pr_debug("Allocated tv_cmd: %p exp_data_len: %d, data_direction"
1174 			": %d\n", cmd, exp_data_len, data_direction);
1175 
1176 		cmd->tvc_vhost = vs;
1177 		cmd->tvc_vq = vq;
1178 		cmd->tvc_resp = vq->iov[out].iov_base;
1179 
1180 		pr_debug("vhost_scsi got command opcode: %#02x, lun: %d\n",
1181 			cmd->tvc_cdb[0], cmd->tvc_lun);
1182 
1183 		if (prot_niov) {
1184 			ret = vhost_scsi_map_iov_to_prot(cmd,
1185 					&vq->iov[prot_first], prot_niov,
1186 					data_direction == DMA_FROM_DEVICE);
1187 			if (unlikely(ret)) {
1188 				vq_err(vq, "Failed to map iov to"
1189 					" prot_sgl\n");
1190 				goto err_free;
1191 			}
1192 		}
1193 		if (data_direction != DMA_NONE) {
1194 			ret = vhost_scsi_map_iov_to_sgl(cmd,
1195 					&vq->iov[data_first], data_niov,
1196 					data_direction == DMA_FROM_DEVICE);
1197 			if (unlikely(ret)) {
1198 				vq_err(vq, "Failed to map iov to sgl\n");
1199 				goto err_free;
1200 			}
1201 		}
1202 		/*
1203 		 * Save the descriptor from vhost_get_vq_desc() to be used to
1204 		 * complete the virtio-scsi request in TCM callback context via
1205 		 * tcm_vhost_queue_data_in() and tcm_vhost_queue_status()
1206 		 */
1207 		cmd->tvc_vq_desc = head;
1208 		/*
1209 		 * Dispatch tv_cmd descriptor for cmwq execution in process
1210 		 * context provided by tcm_vhost_workqueue.  This also ensures
1211 		 * tv_cmd is executed on the same kworker CPU as this vhost
1212 		 * thread to gain positive L2 cache locality effects..
1213 		 */
1214 		INIT_WORK(&cmd->work, tcm_vhost_submission_work);
1215 		queue_work(tcm_vhost_workqueue, &cmd->work);
1216 	}
1217 
1218 	mutex_unlock(&vq->mutex);
1219 	return;
1220 
1221 err_free:
1222 	vhost_scsi_free_cmd(cmd);
1223 err_cmd:
1224 	vhost_scsi_send_bad_target(vs, vq, head, out);
1225 out:
1226 	mutex_unlock(&vq->mutex);
1227 }
1228 
vhost_scsi_ctl_handle_kick(struct vhost_work * work)1229 static void vhost_scsi_ctl_handle_kick(struct vhost_work *work)
1230 {
1231 	pr_debug("%s: The handling func for control queue.\n", __func__);
1232 }
1233 
1234 static void
tcm_vhost_send_evt(struct vhost_scsi * vs,struct tcm_vhost_tpg * tpg,struct se_lun * lun,u32 event,u32 reason)1235 tcm_vhost_send_evt(struct vhost_scsi *vs,
1236 		   struct tcm_vhost_tpg *tpg,
1237 		   struct se_lun *lun,
1238 		   u32 event,
1239 		   u32 reason)
1240 {
1241 	struct tcm_vhost_evt *evt;
1242 
1243 	evt = tcm_vhost_allocate_evt(vs, event, reason);
1244 	if (!evt)
1245 		return;
1246 
1247 	if (tpg && lun) {
1248 		/* TODO: share lun setup code with virtio-scsi.ko */
1249 		/*
1250 		 * Note: evt->event is zeroed when we allocate it and
1251 		 * lun[4-7] need to be zero according to virtio-scsi spec.
1252 		 */
1253 		evt->event.lun[0] = 0x01;
1254 		evt->event.lun[1] = tpg->tport_tpgt;
1255 		if (lun->unpacked_lun >= 256)
1256 			evt->event.lun[2] = lun->unpacked_lun >> 8 | 0x40 ;
1257 		evt->event.lun[3] = lun->unpacked_lun & 0xFF;
1258 	}
1259 
1260 	llist_add(&evt->list, &vs->vs_event_list);
1261 	vhost_work_queue(&vs->dev, &vs->vs_event_work);
1262 }
1263 
vhost_scsi_evt_handle_kick(struct vhost_work * work)1264 static void vhost_scsi_evt_handle_kick(struct vhost_work *work)
1265 {
1266 	struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1267 						poll.work);
1268 	struct vhost_scsi *vs = container_of(vq->dev, struct vhost_scsi, dev);
1269 
1270 	mutex_lock(&vq->mutex);
1271 	if (!vq->private_data)
1272 		goto out;
1273 
1274 	if (vs->vs_events_missed)
1275 		tcm_vhost_send_evt(vs, NULL, NULL, VIRTIO_SCSI_T_NO_EVENT, 0);
1276 out:
1277 	mutex_unlock(&vq->mutex);
1278 }
1279 
vhost_scsi_handle_kick(struct vhost_work * work)1280 static void vhost_scsi_handle_kick(struct vhost_work *work)
1281 {
1282 	struct vhost_virtqueue *vq = container_of(work, struct vhost_virtqueue,
1283 						poll.work);
1284 	struct vhost_scsi *vs = container_of(vq->dev, struct vhost_scsi, dev);
1285 
1286 	vhost_scsi_handle_vq(vs, vq);
1287 }
1288 
vhost_scsi_flush_vq(struct vhost_scsi * vs,int index)1289 static void vhost_scsi_flush_vq(struct vhost_scsi *vs, int index)
1290 {
1291 	vhost_poll_flush(&vs->vqs[index].vq.poll);
1292 }
1293 
1294 /* Callers must hold dev mutex */
vhost_scsi_flush(struct vhost_scsi * vs)1295 static void vhost_scsi_flush(struct vhost_scsi *vs)
1296 {
1297 	struct vhost_scsi_inflight *old_inflight[VHOST_SCSI_MAX_VQ];
1298 	int i;
1299 
1300 	/* Init new inflight and remember the old inflight */
1301 	tcm_vhost_init_inflight(vs, old_inflight);
1302 
1303 	/*
1304 	 * The inflight->kref was initialized to 1. We decrement it here to
1305 	 * indicate the start of the flush operation so that it will reach 0
1306 	 * when all the reqs are finished.
1307 	 */
1308 	for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1309 		kref_put(&old_inflight[i]->kref, tcm_vhost_done_inflight);
1310 
1311 	/* Flush both the vhost poll and vhost work */
1312 	for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1313 		vhost_scsi_flush_vq(vs, i);
1314 	vhost_work_flush(&vs->dev, &vs->vs_completion_work);
1315 	vhost_work_flush(&vs->dev, &vs->vs_event_work);
1316 
1317 	/* Wait for all reqs issued before the flush to be finished */
1318 	for (i = 0; i < VHOST_SCSI_MAX_VQ; i++)
1319 		wait_for_completion(&old_inflight[i]->comp);
1320 }
1321 
1322 /*
1323  * Called from vhost_scsi_ioctl() context to walk the list of available
1324  * tcm_vhost_tpg with an active struct tcm_vhost_nexus
1325  *
1326  *  The lock nesting rule is:
1327  *    tcm_vhost_mutex -> vs->dev.mutex -> tpg->tv_tpg_mutex -> vq->mutex
1328  */
1329 static int
vhost_scsi_set_endpoint(struct vhost_scsi * vs,struct vhost_scsi_target * t)1330 vhost_scsi_set_endpoint(struct vhost_scsi *vs,
1331 			struct vhost_scsi_target *t)
1332 {
1333 	struct se_portal_group *se_tpg;
1334 	struct tcm_vhost_tport *tv_tport;
1335 	struct tcm_vhost_tpg *tpg;
1336 	struct tcm_vhost_tpg **vs_tpg;
1337 	struct vhost_virtqueue *vq;
1338 	int index, ret, i, len;
1339 	bool match = false;
1340 
1341 	mutex_lock(&tcm_vhost_mutex);
1342 	mutex_lock(&vs->dev.mutex);
1343 
1344 	/* Verify that ring has been setup correctly. */
1345 	for (index = 0; index < vs->dev.nvqs; ++index) {
1346 		/* Verify that ring has been setup correctly. */
1347 		if (!vhost_vq_access_ok(&vs->vqs[index].vq)) {
1348 			ret = -EFAULT;
1349 			goto out;
1350 		}
1351 	}
1352 
1353 	len = sizeof(vs_tpg[0]) * VHOST_SCSI_MAX_TARGET;
1354 	vs_tpg = kzalloc(len, GFP_KERNEL);
1355 	if (!vs_tpg) {
1356 		ret = -ENOMEM;
1357 		goto out;
1358 	}
1359 	if (vs->vs_tpg)
1360 		memcpy(vs_tpg, vs->vs_tpg, len);
1361 
1362 	list_for_each_entry(tpg, &tcm_vhost_list, tv_tpg_list) {
1363 		mutex_lock(&tpg->tv_tpg_mutex);
1364 		if (!tpg->tpg_nexus) {
1365 			mutex_unlock(&tpg->tv_tpg_mutex);
1366 			continue;
1367 		}
1368 		if (tpg->tv_tpg_vhost_count != 0) {
1369 			mutex_unlock(&tpg->tv_tpg_mutex);
1370 			continue;
1371 		}
1372 		tv_tport = tpg->tport;
1373 
1374 		if (!strcmp(tv_tport->tport_name, t->vhost_wwpn)) {
1375 			if (vs->vs_tpg && vs->vs_tpg[tpg->tport_tpgt]) {
1376 				kfree(vs_tpg);
1377 				mutex_unlock(&tpg->tv_tpg_mutex);
1378 				ret = -EEXIST;
1379 				goto out;
1380 			}
1381 			/*
1382 			 * In order to ensure individual vhost-scsi configfs
1383 			 * groups cannot be removed while in use by vhost ioctl,
1384 			 * go ahead and take an explicit se_tpg->tpg_group.cg_item
1385 			 * dependency now.
1386 			 */
1387 			se_tpg = &tpg->se_tpg;
1388 			ret = configfs_depend_item(se_tpg->se_tpg_tfo->tf_subsys,
1389 						   &se_tpg->tpg_group.cg_item);
1390 			if (ret) {
1391 				pr_warn("configfs_depend_item() failed: %d\n", ret);
1392 				kfree(vs_tpg);
1393 				mutex_unlock(&tpg->tv_tpg_mutex);
1394 				goto out;
1395 			}
1396 			tpg->tv_tpg_vhost_count++;
1397 			tpg->vhost_scsi = vs;
1398 			vs_tpg[tpg->tport_tpgt] = tpg;
1399 			smp_mb__after_atomic();
1400 			match = true;
1401 		}
1402 		mutex_unlock(&tpg->tv_tpg_mutex);
1403 	}
1404 
1405 	if (match) {
1406 		memcpy(vs->vs_vhost_wwpn, t->vhost_wwpn,
1407 		       sizeof(vs->vs_vhost_wwpn));
1408 		for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1409 			vq = &vs->vqs[i].vq;
1410 			mutex_lock(&vq->mutex);
1411 			vq->private_data = vs_tpg;
1412 			vhost_init_used(vq);
1413 			mutex_unlock(&vq->mutex);
1414 		}
1415 		ret = 0;
1416 	} else {
1417 		ret = -EEXIST;
1418 	}
1419 
1420 	/*
1421 	 * Act as synchronize_rcu to make sure access to
1422 	 * old vs->vs_tpg is finished.
1423 	 */
1424 	vhost_scsi_flush(vs);
1425 	kfree(vs->vs_tpg);
1426 	vs->vs_tpg = vs_tpg;
1427 
1428 out:
1429 	mutex_unlock(&vs->dev.mutex);
1430 	mutex_unlock(&tcm_vhost_mutex);
1431 	return ret;
1432 }
1433 
1434 static int
vhost_scsi_clear_endpoint(struct vhost_scsi * vs,struct vhost_scsi_target * t)1435 vhost_scsi_clear_endpoint(struct vhost_scsi *vs,
1436 			  struct vhost_scsi_target *t)
1437 {
1438 	struct se_portal_group *se_tpg;
1439 	struct tcm_vhost_tport *tv_tport;
1440 	struct tcm_vhost_tpg *tpg;
1441 	struct vhost_virtqueue *vq;
1442 	bool match = false;
1443 	int index, ret, i;
1444 	u8 target;
1445 
1446 	mutex_lock(&tcm_vhost_mutex);
1447 	mutex_lock(&vs->dev.mutex);
1448 	/* Verify that ring has been setup correctly. */
1449 	for (index = 0; index < vs->dev.nvqs; ++index) {
1450 		if (!vhost_vq_access_ok(&vs->vqs[index].vq)) {
1451 			ret = -EFAULT;
1452 			goto err_dev;
1453 		}
1454 	}
1455 
1456 	if (!vs->vs_tpg) {
1457 		ret = 0;
1458 		goto err_dev;
1459 	}
1460 
1461 	for (i = 0; i < VHOST_SCSI_MAX_TARGET; i++) {
1462 		target = i;
1463 		tpg = vs->vs_tpg[target];
1464 		if (!tpg)
1465 			continue;
1466 
1467 		mutex_lock(&tpg->tv_tpg_mutex);
1468 		tv_tport = tpg->tport;
1469 		if (!tv_tport) {
1470 			ret = -ENODEV;
1471 			goto err_tpg;
1472 		}
1473 
1474 		if (strcmp(tv_tport->tport_name, t->vhost_wwpn)) {
1475 			pr_warn("tv_tport->tport_name: %s, tpg->tport_tpgt: %hu"
1476 				" does not match t->vhost_wwpn: %s, t->vhost_tpgt: %hu\n",
1477 				tv_tport->tport_name, tpg->tport_tpgt,
1478 				t->vhost_wwpn, t->vhost_tpgt);
1479 			ret = -EINVAL;
1480 			goto err_tpg;
1481 		}
1482 		tpg->tv_tpg_vhost_count--;
1483 		tpg->vhost_scsi = NULL;
1484 		vs->vs_tpg[target] = NULL;
1485 		match = true;
1486 		mutex_unlock(&tpg->tv_tpg_mutex);
1487 		/*
1488 		 * Release se_tpg->tpg_group.cg_item configfs dependency now
1489 		 * to allow vhost-scsi WWPN se_tpg->tpg_group shutdown to occur.
1490 		 */
1491 		se_tpg = &tpg->se_tpg;
1492 		configfs_undepend_item(se_tpg->se_tpg_tfo->tf_subsys,
1493 				       &se_tpg->tpg_group.cg_item);
1494 	}
1495 	if (match) {
1496 		for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1497 			vq = &vs->vqs[i].vq;
1498 			mutex_lock(&vq->mutex);
1499 			vq->private_data = NULL;
1500 			mutex_unlock(&vq->mutex);
1501 		}
1502 	}
1503 	/*
1504 	 * Act as synchronize_rcu to make sure access to
1505 	 * old vs->vs_tpg is finished.
1506 	 */
1507 	vhost_scsi_flush(vs);
1508 	kfree(vs->vs_tpg);
1509 	vs->vs_tpg = NULL;
1510 	WARN_ON(vs->vs_events_nr);
1511 	mutex_unlock(&vs->dev.mutex);
1512 	mutex_unlock(&tcm_vhost_mutex);
1513 	return 0;
1514 
1515 err_tpg:
1516 	mutex_unlock(&tpg->tv_tpg_mutex);
1517 err_dev:
1518 	mutex_unlock(&vs->dev.mutex);
1519 	mutex_unlock(&tcm_vhost_mutex);
1520 	return ret;
1521 }
1522 
vhost_scsi_set_features(struct vhost_scsi * vs,u64 features)1523 static int vhost_scsi_set_features(struct vhost_scsi *vs, u64 features)
1524 {
1525 	struct vhost_virtqueue *vq;
1526 	int i;
1527 
1528 	if (features & ~VHOST_SCSI_FEATURES)
1529 		return -EOPNOTSUPP;
1530 
1531 	mutex_lock(&vs->dev.mutex);
1532 	if ((features & (1 << VHOST_F_LOG_ALL)) &&
1533 	    !vhost_log_access_ok(&vs->dev)) {
1534 		mutex_unlock(&vs->dev.mutex);
1535 		return -EFAULT;
1536 	}
1537 
1538 	for (i = 0; i < VHOST_SCSI_MAX_VQ; i++) {
1539 		vq = &vs->vqs[i].vq;
1540 		mutex_lock(&vq->mutex);
1541 		vq->acked_features = features;
1542 		mutex_unlock(&vq->mutex);
1543 	}
1544 	mutex_unlock(&vs->dev.mutex);
1545 	return 0;
1546 }
1547 
vhost_scsi_open(struct inode * inode,struct file * f)1548 static int vhost_scsi_open(struct inode *inode, struct file *f)
1549 {
1550 	struct vhost_scsi *vs;
1551 	struct vhost_virtqueue **vqs;
1552 	int r = -ENOMEM, i;
1553 
1554 	vs = kzalloc(sizeof(*vs), GFP_KERNEL | __GFP_NOWARN | __GFP_REPEAT);
1555 	if (!vs) {
1556 		vs = vzalloc(sizeof(*vs));
1557 		if (!vs)
1558 			goto err_vs;
1559 	}
1560 
1561 	vqs = kmalloc(VHOST_SCSI_MAX_VQ * sizeof(*vqs), GFP_KERNEL);
1562 	if (!vqs)
1563 		goto err_vqs;
1564 
1565 	vhost_work_init(&vs->vs_completion_work, vhost_scsi_complete_cmd_work);
1566 	vhost_work_init(&vs->vs_event_work, tcm_vhost_evt_work);
1567 
1568 	vs->vs_events_nr = 0;
1569 	vs->vs_events_missed = false;
1570 
1571 	vqs[VHOST_SCSI_VQ_CTL] = &vs->vqs[VHOST_SCSI_VQ_CTL].vq;
1572 	vqs[VHOST_SCSI_VQ_EVT] = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1573 	vs->vqs[VHOST_SCSI_VQ_CTL].vq.handle_kick = vhost_scsi_ctl_handle_kick;
1574 	vs->vqs[VHOST_SCSI_VQ_EVT].vq.handle_kick = vhost_scsi_evt_handle_kick;
1575 	for (i = VHOST_SCSI_VQ_IO; i < VHOST_SCSI_MAX_VQ; i++) {
1576 		vqs[i] = &vs->vqs[i].vq;
1577 		vs->vqs[i].vq.handle_kick = vhost_scsi_handle_kick;
1578 	}
1579 	vhost_dev_init(&vs->dev, vqs, VHOST_SCSI_MAX_VQ);
1580 
1581 	tcm_vhost_init_inflight(vs, NULL);
1582 
1583 	f->private_data = vs;
1584 	return 0;
1585 
1586 err_vqs:
1587 	kvfree(vs);
1588 err_vs:
1589 	return r;
1590 }
1591 
vhost_scsi_release(struct inode * inode,struct file * f)1592 static int vhost_scsi_release(struct inode *inode, struct file *f)
1593 {
1594 	struct vhost_scsi *vs = f->private_data;
1595 	struct vhost_scsi_target t;
1596 
1597 	mutex_lock(&vs->dev.mutex);
1598 	memcpy(t.vhost_wwpn, vs->vs_vhost_wwpn, sizeof(t.vhost_wwpn));
1599 	mutex_unlock(&vs->dev.mutex);
1600 	vhost_scsi_clear_endpoint(vs, &t);
1601 	vhost_dev_stop(&vs->dev);
1602 	vhost_dev_cleanup(&vs->dev, false);
1603 	/* Jobs can re-queue themselves in evt kick handler. Do extra flush. */
1604 	vhost_scsi_flush(vs);
1605 	kfree(vs->dev.vqs);
1606 	kvfree(vs);
1607 	return 0;
1608 }
1609 
1610 static long
vhost_scsi_ioctl(struct file * f,unsigned int ioctl,unsigned long arg)1611 vhost_scsi_ioctl(struct file *f,
1612 		 unsigned int ioctl,
1613 		 unsigned long arg)
1614 {
1615 	struct vhost_scsi *vs = f->private_data;
1616 	struct vhost_scsi_target backend;
1617 	void __user *argp = (void __user *)arg;
1618 	u64 __user *featurep = argp;
1619 	u32 __user *eventsp = argp;
1620 	u32 events_missed;
1621 	u64 features;
1622 	int r, abi_version = VHOST_SCSI_ABI_VERSION;
1623 	struct vhost_virtqueue *vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1624 
1625 	switch (ioctl) {
1626 	case VHOST_SCSI_SET_ENDPOINT:
1627 		if (copy_from_user(&backend, argp, sizeof backend))
1628 			return -EFAULT;
1629 		if (backend.reserved != 0)
1630 			return -EOPNOTSUPP;
1631 
1632 		return vhost_scsi_set_endpoint(vs, &backend);
1633 	case VHOST_SCSI_CLEAR_ENDPOINT:
1634 		if (copy_from_user(&backend, argp, sizeof backend))
1635 			return -EFAULT;
1636 		if (backend.reserved != 0)
1637 			return -EOPNOTSUPP;
1638 
1639 		return vhost_scsi_clear_endpoint(vs, &backend);
1640 	case VHOST_SCSI_GET_ABI_VERSION:
1641 		if (copy_to_user(argp, &abi_version, sizeof abi_version))
1642 			return -EFAULT;
1643 		return 0;
1644 	case VHOST_SCSI_SET_EVENTS_MISSED:
1645 		if (get_user(events_missed, eventsp))
1646 			return -EFAULT;
1647 		mutex_lock(&vq->mutex);
1648 		vs->vs_events_missed = events_missed;
1649 		mutex_unlock(&vq->mutex);
1650 		return 0;
1651 	case VHOST_SCSI_GET_EVENTS_MISSED:
1652 		mutex_lock(&vq->mutex);
1653 		events_missed = vs->vs_events_missed;
1654 		mutex_unlock(&vq->mutex);
1655 		if (put_user(events_missed, eventsp))
1656 			return -EFAULT;
1657 		return 0;
1658 	case VHOST_GET_FEATURES:
1659 		features = VHOST_SCSI_FEATURES;
1660 		if (copy_to_user(featurep, &features, sizeof features))
1661 			return -EFAULT;
1662 		return 0;
1663 	case VHOST_SET_FEATURES:
1664 		if (copy_from_user(&features, featurep, sizeof features))
1665 			return -EFAULT;
1666 		return vhost_scsi_set_features(vs, features);
1667 	default:
1668 		mutex_lock(&vs->dev.mutex);
1669 		r = vhost_dev_ioctl(&vs->dev, ioctl, argp);
1670 		/* TODO: flush backend after dev ioctl. */
1671 		if (r == -ENOIOCTLCMD)
1672 			r = vhost_vring_ioctl(&vs->dev, ioctl, argp);
1673 		mutex_unlock(&vs->dev.mutex);
1674 		return r;
1675 	}
1676 }
1677 
1678 #ifdef CONFIG_COMPAT
vhost_scsi_compat_ioctl(struct file * f,unsigned int ioctl,unsigned long arg)1679 static long vhost_scsi_compat_ioctl(struct file *f, unsigned int ioctl,
1680 				unsigned long arg)
1681 {
1682 	return vhost_scsi_ioctl(f, ioctl, (unsigned long)compat_ptr(arg));
1683 }
1684 #endif
1685 
1686 static const struct file_operations vhost_scsi_fops = {
1687 	.owner          = THIS_MODULE,
1688 	.release        = vhost_scsi_release,
1689 	.unlocked_ioctl = vhost_scsi_ioctl,
1690 #ifdef CONFIG_COMPAT
1691 	.compat_ioctl	= vhost_scsi_compat_ioctl,
1692 #endif
1693 	.open           = vhost_scsi_open,
1694 	.llseek		= noop_llseek,
1695 };
1696 
1697 static struct miscdevice vhost_scsi_misc = {
1698 	MISC_DYNAMIC_MINOR,
1699 	"vhost-scsi",
1700 	&vhost_scsi_fops,
1701 };
1702 
vhost_scsi_register(void)1703 static int __init vhost_scsi_register(void)
1704 {
1705 	return misc_register(&vhost_scsi_misc);
1706 }
1707 
vhost_scsi_deregister(void)1708 static int vhost_scsi_deregister(void)
1709 {
1710 	return misc_deregister(&vhost_scsi_misc);
1711 }
1712 
tcm_vhost_dump_proto_id(struct tcm_vhost_tport * tport)1713 static char *tcm_vhost_dump_proto_id(struct tcm_vhost_tport *tport)
1714 {
1715 	switch (tport->tport_proto_id) {
1716 	case SCSI_PROTOCOL_SAS:
1717 		return "SAS";
1718 	case SCSI_PROTOCOL_FCP:
1719 		return "FCP";
1720 	case SCSI_PROTOCOL_ISCSI:
1721 		return "iSCSI";
1722 	default:
1723 		break;
1724 	}
1725 
1726 	return "Unknown";
1727 }
1728 
1729 static void
tcm_vhost_do_plug(struct tcm_vhost_tpg * tpg,struct se_lun * lun,bool plug)1730 tcm_vhost_do_plug(struct tcm_vhost_tpg *tpg,
1731 		  struct se_lun *lun, bool plug)
1732 {
1733 
1734 	struct vhost_scsi *vs = tpg->vhost_scsi;
1735 	struct vhost_virtqueue *vq;
1736 	u32 reason;
1737 
1738 	if (!vs)
1739 		return;
1740 
1741 	mutex_lock(&vs->dev.mutex);
1742 
1743 	if (plug)
1744 		reason = VIRTIO_SCSI_EVT_RESET_RESCAN;
1745 	else
1746 		reason = VIRTIO_SCSI_EVT_RESET_REMOVED;
1747 
1748 	vq = &vs->vqs[VHOST_SCSI_VQ_EVT].vq;
1749 	mutex_lock(&vq->mutex);
1750 	if (vhost_has_feature(vq, VIRTIO_SCSI_F_HOTPLUG))
1751 		tcm_vhost_send_evt(vs, tpg, lun,
1752 				   VIRTIO_SCSI_T_TRANSPORT_RESET, reason);
1753 	mutex_unlock(&vq->mutex);
1754 	mutex_unlock(&vs->dev.mutex);
1755 }
1756 
tcm_vhost_hotplug(struct tcm_vhost_tpg * tpg,struct se_lun * lun)1757 static void tcm_vhost_hotplug(struct tcm_vhost_tpg *tpg, struct se_lun *lun)
1758 {
1759 	tcm_vhost_do_plug(tpg, lun, true);
1760 }
1761 
tcm_vhost_hotunplug(struct tcm_vhost_tpg * tpg,struct se_lun * lun)1762 static void tcm_vhost_hotunplug(struct tcm_vhost_tpg *tpg, struct se_lun *lun)
1763 {
1764 	tcm_vhost_do_plug(tpg, lun, false);
1765 }
1766 
tcm_vhost_port_link(struct se_portal_group * se_tpg,struct se_lun * lun)1767 static int tcm_vhost_port_link(struct se_portal_group *se_tpg,
1768 			       struct se_lun *lun)
1769 {
1770 	struct tcm_vhost_tpg *tpg = container_of(se_tpg,
1771 				struct tcm_vhost_tpg, se_tpg);
1772 
1773 	mutex_lock(&tcm_vhost_mutex);
1774 
1775 	mutex_lock(&tpg->tv_tpg_mutex);
1776 	tpg->tv_tpg_port_count++;
1777 	mutex_unlock(&tpg->tv_tpg_mutex);
1778 
1779 	tcm_vhost_hotplug(tpg, lun);
1780 
1781 	mutex_unlock(&tcm_vhost_mutex);
1782 
1783 	return 0;
1784 }
1785 
tcm_vhost_port_unlink(struct se_portal_group * se_tpg,struct se_lun * lun)1786 static void tcm_vhost_port_unlink(struct se_portal_group *se_tpg,
1787 				  struct se_lun *lun)
1788 {
1789 	struct tcm_vhost_tpg *tpg = container_of(se_tpg,
1790 				struct tcm_vhost_tpg, se_tpg);
1791 
1792 	mutex_lock(&tcm_vhost_mutex);
1793 
1794 	mutex_lock(&tpg->tv_tpg_mutex);
1795 	tpg->tv_tpg_port_count--;
1796 	mutex_unlock(&tpg->tv_tpg_mutex);
1797 
1798 	tcm_vhost_hotunplug(tpg, lun);
1799 
1800 	mutex_unlock(&tcm_vhost_mutex);
1801 }
1802 
1803 static struct se_node_acl *
tcm_vhost_make_nodeacl(struct se_portal_group * se_tpg,struct config_group * group,const char * name)1804 tcm_vhost_make_nodeacl(struct se_portal_group *se_tpg,
1805 		       struct config_group *group,
1806 		       const char *name)
1807 {
1808 	struct se_node_acl *se_nacl, *se_nacl_new;
1809 	struct tcm_vhost_nacl *nacl;
1810 	u64 wwpn = 0;
1811 	u32 nexus_depth;
1812 
1813 	/* tcm_vhost_parse_wwn(name, &wwpn, 1) < 0)
1814 		return ERR_PTR(-EINVAL); */
1815 	se_nacl_new = tcm_vhost_alloc_fabric_acl(se_tpg);
1816 	if (!se_nacl_new)
1817 		return ERR_PTR(-ENOMEM);
1818 
1819 	nexus_depth = 1;
1820 	/*
1821 	 * se_nacl_new may be released by core_tpg_add_initiator_node_acl()
1822 	 * when converting a NodeACL from demo mode -> explict
1823 	 */
1824 	se_nacl = core_tpg_add_initiator_node_acl(se_tpg, se_nacl_new,
1825 				name, nexus_depth);
1826 	if (IS_ERR(se_nacl)) {
1827 		tcm_vhost_release_fabric_acl(se_tpg, se_nacl_new);
1828 		return se_nacl;
1829 	}
1830 	/*
1831 	 * Locate our struct tcm_vhost_nacl and set the FC Nport WWPN
1832 	 */
1833 	nacl = container_of(se_nacl, struct tcm_vhost_nacl, se_node_acl);
1834 	nacl->iport_wwpn = wwpn;
1835 
1836 	return se_nacl;
1837 }
1838 
tcm_vhost_drop_nodeacl(struct se_node_acl * se_acl)1839 static void tcm_vhost_drop_nodeacl(struct se_node_acl *se_acl)
1840 {
1841 	struct tcm_vhost_nacl *nacl = container_of(se_acl,
1842 				struct tcm_vhost_nacl, se_node_acl);
1843 	core_tpg_del_initiator_node_acl(se_acl->se_tpg, se_acl, 1);
1844 	kfree(nacl);
1845 }
1846 
tcm_vhost_free_cmd_map_res(struct tcm_vhost_nexus * nexus,struct se_session * se_sess)1847 static void tcm_vhost_free_cmd_map_res(struct tcm_vhost_nexus *nexus,
1848 				       struct se_session *se_sess)
1849 {
1850 	struct tcm_vhost_cmd *tv_cmd;
1851 	unsigned int i;
1852 
1853 	if (!se_sess->sess_cmd_map)
1854 		return;
1855 
1856 	for (i = 0; i < TCM_VHOST_DEFAULT_TAGS; i++) {
1857 		tv_cmd = &((struct tcm_vhost_cmd *)se_sess->sess_cmd_map)[i];
1858 
1859 		kfree(tv_cmd->tvc_sgl);
1860 		kfree(tv_cmd->tvc_prot_sgl);
1861 		kfree(tv_cmd->tvc_upages);
1862 	}
1863 }
1864 
tcm_vhost_make_nexus(struct tcm_vhost_tpg * tpg,const char * name)1865 static int tcm_vhost_make_nexus(struct tcm_vhost_tpg *tpg,
1866 				const char *name)
1867 {
1868 	struct se_portal_group *se_tpg;
1869 	struct se_session *se_sess;
1870 	struct tcm_vhost_nexus *tv_nexus;
1871 	struct tcm_vhost_cmd *tv_cmd;
1872 	unsigned int i;
1873 
1874 	mutex_lock(&tpg->tv_tpg_mutex);
1875 	if (tpg->tpg_nexus) {
1876 		mutex_unlock(&tpg->tv_tpg_mutex);
1877 		pr_debug("tpg->tpg_nexus already exists\n");
1878 		return -EEXIST;
1879 	}
1880 	se_tpg = &tpg->se_tpg;
1881 
1882 	tv_nexus = kzalloc(sizeof(struct tcm_vhost_nexus), GFP_KERNEL);
1883 	if (!tv_nexus) {
1884 		mutex_unlock(&tpg->tv_tpg_mutex);
1885 		pr_err("Unable to allocate struct tcm_vhost_nexus\n");
1886 		return -ENOMEM;
1887 	}
1888 	/*
1889 	 *  Initialize the struct se_session pointer and setup tagpool
1890 	 *  for struct tcm_vhost_cmd descriptors
1891 	 */
1892 	tv_nexus->tvn_se_sess = transport_init_session_tags(
1893 					TCM_VHOST_DEFAULT_TAGS,
1894 					sizeof(struct tcm_vhost_cmd),
1895 					TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS);
1896 	if (IS_ERR(tv_nexus->tvn_se_sess)) {
1897 		mutex_unlock(&tpg->tv_tpg_mutex);
1898 		kfree(tv_nexus);
1899 		return -ENOMEM;
1900 	}
1901 	se_sess = tv_nexus->tvn_se_sess;
1902 	for (i = 0; i < TCM_VHOST_DEFAULT_TAGS; i++) {
1903 		tv_cmd = &((struct tcm_vhost_cmd *)se_sess->sess_cmd_map)[i];
1904 
1905 		tv_cmd->tvc_sgl = kzalloc(sizeof(struct scatterlist) *
1906 					TCM_VHOST_PREALLOC_SGLS, GFP_KERNEL);
1907 		if (!tv_cmd->tvc_sgl) {
1908 			mutex_unlock(&tpg->tv_tpg_mutex);
1909 			pr_err("Unable to allocate tv_cmd->tvc_sgl\n");
1910 			goto out;
1911 		}
1912 
1913 		tv_cmd->tvc_upages = kzalloc(sizeof(struct page *) *
1914 					TCM_VHOST_PREALLOC_UPAGES, GFP_KERNEL);
1915 		if (!tv_cmd->tvc_upages) {
1916 			mutex_unlock(&tpg->tv_tpg_mutex);
1917 			pr_err("Unable to allocate tv_cmd->tvc_upages\n");
1918 			goto out;
1919 		}
1920 
1921 		tv_cmd->tvc_prot_sgl = kzalloc(sizeof(struct scatterlist) *
1922 					TCM_VHOST_PREALLOC_PROT_SGLS, GFP_KERNEL);
1923 		if (!tv_cmd->tvc_prot_sgl) {
1924 			mutex_unlock(&tpg->tv_tpg_mutex);
1925 			pr_err("Unable to allocate tv_cmd->tvc_prot_sgl\n");
1926 			goto out;
1927 		}
1928 	}
1929 	/*
1930 	 * Since we are running in 'demo mode' this call with generate a
1931 	 * struct se_node_acl for the tcm_vhost struct se_portal_group with
1932 	 * the SCSI Initiator port name of the passed configfs group 'name'.
1933 	 */
1934 	tv_nexus->tvn_se_sess->se_node_acl = core_tpg_check_initiator_node_acl(
1935 				se_tpg, (unsigned char *)name);
1936 	if (!tv_nexus->tvn_se_sess->se_node_acl) {
1937 		mutex_unlock(&tpg->tv_tpg_mutex);
1938 		pr_debug("core_tpg_check_initiator_node_acl() failed"
1939 				" for %s\n", name);
1940 		goto out;
1941 	}
1942 	/*
1943 	 * Now register the TCM vhost virtual I_T Nexus as active with the
1944 	 * call to __transport_register_session()
1945 	 */
1946 	__transport_register_session(se_tpg, tv_nexus->tvn_se_sess->se_node_acl,
1947 			tv_nexus->tvn_se_sess, tv_nexus);
1948 	tpg->tpg_nexus = tv_nexus;
1949 
1950 	mutex_unlock(&tpg->tv_tpg_mutex);
1951 	return 0;
1952 
1953 out:
1954 	tcm_vhost_free_cmd_map_res(tv_nexus, se_sess);
1955 	transport_free_session(se_sess);
1956 	kfree(tv_nexus);
1957 	return -ENOMEM;
1958 }
1959 
tcm_vhost_drop_nexus(struct tcm_vhost_tpg * tpg)1960 static int tcm_vhost_drop_nexus(struct tcm_vhost_tpg *tpg)
1961 {
1962 	struct se_session *se_sess;
1963 	struct tcm_vhost_nexus *tv_nexus;
1964 
1965 	mutex_lock(&tpg->tv_tpg_mutex);
1966 	tv_nexus = tpg->tpg_nexus;
1967 	if (!tv_nexus) {
1968 		mutex_unlock(&tpg->tv_tpg_mutex);
1969 		return -ENODEV;
1970 	}
1971 
1972 	se_sess = tv_nexus->tvn_se_sess;
1973 	if (!se_sess) {
1974 		mutex_unlock(&tpg->tv_tpg_mutex);
1975 		return -ENODEV;
1976 	}
1977 
1978 	if (tpg->tv_tpg_port_count != 0) {
1979 		mutex_unlock(&tpg->tv_tpg_mutex);
1980 		pr_err("Unable to remove TCM_vhost I_T Nexus with"
1981 			" active TPG port count: %d\n",
1982 			tpg->tv_tpg_port_count);
1983 		return -EBUSY;
1984 	}
1985 
1986 	if (tpg->tv_tpg_vhost_count != 0) {
1987 		mutex_unlock(&tpg->tv_tpg_mutex);
1988 		pr_err("Unable to remove TCM_vhost I_T Nexus with"
1989 			" active TPG vhost count: %d\n",
1990 			tpg->tv_tpg_vhost_count);
1991 		return -EBUSY;
1992 	}
1993 
1994 	pr_debug("TCM_vhost_ConfigFS: Removing I_T Nexus to emulated"
1995 		" %s Initiator Port: %s\n", tcm_vhost_dump_proto_id(tpg->tport),
1996 		tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1997 
1998 	tcm_vhost_free_cmd_map_res(tv_nexus, se_sess);
1999 	/*
2000 	 * Release the SCSI I_T Nexus to the emulated vhost Target Port
2001 	 */
2002 	transport_deregister_session(tv_nexus->tvn_se_sess);
2003 	tpg->tpg_nexus = NULL;
2004 	mutex_unlock(&tpg->tv_tpg_mutex);
2005 
2006 	kfree(tv_nexus);
2007 	return 0;
2008 }
2009 
tcm_vhost_tpg_show_nexus(struct se_portal_group * se_tpg,char * page)2010 static ssize_t tcm_vhost_tpg_show_nexus(struct se_portal_group *se_tpg,
2011 					char *page)
2012 {
2013 	struct tcm_vhost_tpg *tpg = container_of(se_tpg,
2014 				struct tcm_vhost_tpg, se_tpg);
2015 	struct tcm_vhost_nexus *tv_nexus;
2016 	ssize_t ret;
2017 
2018 	mutex_lock(&tpg->tv_tpg_mutex);
2019 	tv_nexus = tpg->tpg_nexus;
2020 	if (!tv_nexus) {
2021 		mutex_unlock(&tpg->tv_tpg_mutex);
2022 		return -ENODEV;
2023 	}
2024 	ret = snprintf(page, PAGE_SIZE, "%s\n",
2025 			tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
2026 	mutex_unlock(&tpg->tv_tpg_mutex);
2027 
2028 	return ret;
2029 }
2030 
tcm_vhost_tpg_store_nexus(struct se_portal_group * se_tpg,const char * page,size_t count)2031 static ssize_t tcm_vhost_tpg_store_nexus(struct se_portal_group *se_tpg,
2032 					 const char *page,
2033 					 size_t count)
2034 {
2035 	struct tcm_vhost_tpg *tpg = container_of(se_tpg,
2036 				struct tcm_vhost_tpg, se_tpg);
2037 	struct tcm_vhost_tport *tport_wwn = tpg->tport;
2038 	unsigned char i_port[TCM_VHOST_NAMELEN], *ptr, *port_ptr;
2039 	int ret;
2040 	/*
2041 	 * Shutdown the active I_T nexus if 'NULL' is passed..
2042 	 */
2043 	if (!strncmp(page, "NULL", 4)) {
2044 		ret = tcm_vhost_drop_nexus(tpg);
2045 		return (!ret) ? count : ret;
2046 	}
2047 	/*
2048 	 * Otherwise make sure the passed virtual Initiator port WWN matches
2049 	 * the fabric protocol_id set in tcm_vhost_make_tport(), and call
2050 	 * tcm_vhost_make_nexus().
2051 	 */
2052 	if (strlen(page) >= TCM_VHOST_NAMELEN) {
2053 		pr_err("Emulated NAA Sas Address: %s, exceeds"
2054 				" max: %d\n", page, TCM_VHOST_NAMELEN);
2055 		return -EINVAL;
2056 	}
2057 	snprintf(&i_port[0], TCM_VHOST_NAMELEN, "%s", page);
2058 
2059 	ptr = strstr(i_port, "naa.");
2060 	if (ptr) {
2061 		if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_SAS) {
2062 			pr_err("Passed SAS Initiator Port %s does not"
2063 				" match target port protoid: %s\n", i_port,
2064 				tcm_vhost_dump_proto_id(tport_wwn));
2065 			return -EINVAL;
2066 		}
2067 		port_ptr = &i_port[0];
2068 		goto check_newline;
2069 	}
2070 	ptr = strstr(i_port, "fc.");
2071 	if (ptr) {
2072 		if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_FCP) {
2073 			pr_err("Passed FCP Initiator Port %s does not"
2074 				" match target port protoid: %s\n", i_port,
2075 				tcm_vhost_dump_proto_id(tport_wwn));
2076 			return -EINVAL;
2077 		}
2078 		port_ptr = &i_port[3]; /* Skip over "fc." */
2079 		goto check_newline;
2080 	}
2081 	ptr = strstr(i_port, "iqn.");
2082 	if (ptr) {
2083 		if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_ISCSI) {
2084 			pr_err("Passed iSCSI Initiator Port %s does not"
2085 				" match target port protoid: %s\n", i_port,
2086 				tcm_vhost_dump_proto_id(tport_wwn));
2087 			return -EINVAL;
2088 		}
2089 		port_ptr = &i_port[0];
2090 		goto check_newline;
2091 	}
2092 	pr_err("Unable to locate prefix for emulated Initiator Port:"
2093 			" %s\n", i_port);
2094 	return -EINVAL;
2095 	/*
2096 	 * Clear any trailing newline for the NAA WWN
2097 	 */
2098 check_newline:
2099 	if (i_port[strlen(i_port)-1] == '\n')
2100 		i_port[strlen(i_port)-1] = '\0';
2101 
2102 	ret = tcm_vhost_make_nexus(tpg, port_ptr);
2103 	if (ret < 0)
2104 		return ret;
2105 
2106 	return count;
2107 }
2108 
2109 TF_TPG_BASE_ATTR(tcm_vhost, nexus, S_IRUGO | S_IWUSR);
2110 
2111 static struct configfs_attribute *tcm_vhost_tpg_attrs[] = {
2112 	&tcm_vhost_tpg_nexus.attr,
2113 	NULL,
2114 };
2115 
2116 static struct se_portal_group *
tcm_vhost_make_tpg(struct se_wwn * wwn,struct config_group * group,const char * name)2117 tcm_vhost_make_tpg(struct se_wwn *wwn,
2118 		   struct config_group *group,
2119 		   const char *name)
2120 {
2121 	struct tcm_vhost_tport *tport = container_of(wwn,
2122 			struct tcm_vhost_tport, tport_wwn);
2123 
2124 	struct tcm_vhost_tpg *tpg;
2125 	u16 tpgt;
2126 	int ret;
2127 
2128 	if (strstr(name, "tpgt_") != name)
2129 		return ERR_PTR(-EINVAL);
2130 	if (kstrtou16(name + 5, 10, &tpgt) || tpgt >= VHOST_SCSI_MAX_TARGET)
2131 		return ERR_PTR(-EINVAL);
2132 
2133 	tpg = kzalloc(sizeof(struct tcm_vhost_tpg), GFP_KERNEL);
2134 	if (!tpg) {
2135 		pr_err("Unable to allocate struct tcm_vhost_tpg");
2136 		return ERR_PTR(-ENOMEM);
2137 	}
2138 	mutex_init(&tpg->tv_tpg_mutex);
2139 	INIT_LIST_HEAD(&tpg->tv_tpg_list);
2140 	tpg->tport = tport;
2141 	tpg->tport_tpgt = tpgt;
2142 
2143 	ret = core_tpg_register(&tcm_vhost_fabric_configfs->tf_ops, wwn,
2144 				&tpg->se_tpg, tpg, TRANSPORT_TPG_TYPE_NORMAL);
2145 	if (ret < 0) {
2146 		kfree(tpg);
2147 		return NULL;
2148 	}
2149 	mutex_lock(&tcm_vhost_mutex);
2150 	list_add_tail(&tpg->tv_tpg_list, &tcm_vhost_list);
2151 	mutex_unlock(&tcm_vhost_mutex);
2152 
2153 	return &tpg->se_tpg;
2154 }
2155 
tcm_vhost_drop_tpg(struct se_portal_group * se_tpg)2156 static void tcm_vhost_drop_tpg(struct se_portal_group *se_tpg)
2157 {
2158 	struct tcm_vhost_tpg *tpg = container_of(se_tpg,
2159 				struct tcm_vhost_tpg, se_tpg);
2160 
2161 	mutex_lock(&tcm_vhost_mutex);
2162 	list_del(&tpg->tv_tpg_list);
2163 	mutex_unlock(&tcm_vhost_mutex);
2164 	/*
2165 	 * Release the virtual I_T Nexus for this vhost TPG
2166 	 */
2167 	tcm_vhost_drop_nexus(tpg);
2168 	/*
2169 	 * Deregister the se_tpg from TCM..
2170 	 */
2171 	core_tpg_deregister(se_tpg);
2172 	kfree(tpg);
2173 }
2174 
2175 static struct se_wwn *
tcm_vhost_make_tport(struct target_fabric_configfs * tf,struct config_group * group,const char * name)2176 tcm_vhost_make_tport(struct target_fabric_configfs *tf,
2177 		     struct config_group *group,
2178 		     const char *name)
2179 {
2180 	struct tcm_vhost_tport *tport;
2181 	char *ptr;
2182 	u64 wwpn = 0;
2183 	int off = 0;
2184 
2185 	/* if (tcm_vhost_parse_wwn(name, &wwpn, 1) < 0)
2186 		return ERR_PTR(-EINVAL); */
2187 
2188 	tport = kzalloc(sizeof(struct tcm_vhost_tport), GFP_KERNEL);
2189 	if (!tport) {
2190 		pr_err("Unable to allocate struct tcm_vhost_tport");
2191 		return ERR_PTR(-ENOMEM);
2192 	}
2193 	tport->tport_wwpn = wwpn;
2194 	/*
2195 	 * Determine the emulated Protocol Identifier and Target Port Name
2196 	 * based on the incoming configfs directory name.
2197 	 */
2198 	ptr = strstr(name, "naa.");
2199 	if (ptr) {
2200 		tport->tport_proto_id = SCSI_PROTOCOL_SAS;
2201 		goto check_len;
2202 	}
2203 	ptr = strstr(name, "fc.");
2204 	if (ptr) {
2205 		tport->tport_proto_id = SCSI_PROTOCOL_FCP;
2206 		off = 3; /* Skip over "fc." */
2207 		goto check_len;
2208 	}
2209 	ptr = strstr(name, "iqn.");
2210 	if (ptr) {
2211 		tport->tport_proto_id = SCSI_PROTOCOL_ISCSI;
2212 		goto check_len;
2213 	}
2214 
2215 	pr_err("Unable to locate prefix for emulated Target Port:"
2216 			" %s\n", name);
2217 	kfree(tport);
2218 	return ERR_PTR(-EINVAL);
2219 
2220 check_len:
2221 	if (strlen(name) >= TCM_VHOST_NAMELEN) {
2222 		pr_err("Emulated %s Address: %s, exceeds"
2223 			" max: %d\n", name, tcm_vhost_dump_proto_id(tport),
2224 			TCM_VHOST_NAMELEN);
2225 		kfree(tport);
2226 		return ERR_PTR(-EINVAL);
2227 	}
2228 	snprintf(&tport->tport_name[0], TCM_VHOST_NAMELEN, "%s", &name[off]);
2229 
2230 	pr_debug("TCM_VHost_ConfigFS: Allocated emulated Target"
2231 		" %s Address: %s\n", tcm_vhost_dump_proto_id(tport), name);
2232 
2233 	return &tport->tport_wwn;
2234 }
2235 
tcm_vhost_drop_tport(struct se_wwn * wwn)2236 static void tcm_vhost_drop_tport(struct se_wwn *wwn)
2237 {
2238 	struct tcm_vhost_tport *tport = container_of(wwn,
2239 				struct tcm_vhost_tport, tport_wwn);
2240 
2241 	pr_debug("TCM_VHost_ConfigFS: Deallocating emulated Target"
2242 		" %s Address: %s\n", tcm_vhost_dump_proto_id(tport),
2243 		tport->tport_name);
2244 
2245 	kfree(tport);
2246 }
2247 
2248 static ssize_t
tcm_vhost_wwn_show_attr_version(struct target_fabric_configfs * tf,char * page)2249 tcm_vhost_wwn_show_attr_version(struct target_fabric_configfs *tf,
2250 				char *page)
2251 {
2252 	return sprintf(page, "TCM_VHOST fabric module %s on %s/%s"
2253 		"on "UTS_RELEASE"\n", TCM_VHOST_VERSION, utsname()->sysname,
2254 		utsname()->machine);
2255 }
2256 
2257 TF_WWN_ATTR_RO(tcm_vhost, version);
2258 
2259 static struct configfs_attribute *tcm_vhost_wwn_attrs[] = {
2260 	&tcm_vhost_wwn_version.attr,
2261 	NULL,
2262 };
2263 
2264 static struct target_core_fabric_ops tcm_vhost_ops = {
2265 	.get_fabric_name		= tcm_vhost_get_fabric_name,
2266 	.get_fabric_proto_ident		= tcm_vhost_get_fabric_proto_ident,
2267 	.tpg_get_wwn			= tcm_vhost_get_fabric_wwn,
2268 	.tpg_get_tag			= tcm_vhost_get_tag,
2269 	.tpg_get_default_depth		= tcm_vhost_get_default_depth,
2270 	.tpg_get_pr_transport_id	= tcm_vhost_get_pr_transport_id,
2271 	.tpg_get_pr_transport_id_len	= tcm_vhost_get_pr_transport_id_len,
2272 	.tpg_parse_pr_out_transport_id	= tcm_vhost_parse_pr_out_transport_id,
2273 	.tpg_check_demo_mode		= tcm_vhost_check_true,
2274 	.tpg_check_demo_mode_cache	= tcm_vhost_check_true,
2275 	.tpg_check_demo_mode_write_protect = tcm_vhost_check_false,
2276 	.tpg_check_prod_mode_write_protect = tcm_vhost_check_false,
2277 	.tpg_alloc_fabric_acl		= tcm_vhost_alloc_fabric_acl,
2278 	.tpg_release_fabric_acl		= tcm_vhost_release_fabric_acl,
2279 	.tpg_get_inst_index		= tcm_vhost_tpg_get_inst_index,
2280 	.release_cmd			= tcm_vhost_release_cmd,
2281 	.check_stop_free		= vhost_scsi_check_stop_free,
2282 	.shutdown_session		= tcm_vhost_shutdown_session,
2283 	.close_session			= tcm_vhost_close_session,
2284 	.sess_get_index			= tcm_vhost_sess_get_index,
2285 	.sess_get_initiator_sid		= NULL,
2286 	.write_pending			= tcm_vhost_write_pending,
2287 	.write_pending_status		= tcm_vhost_write_pending_status,
2288 	.set_default_node_attributes	= tcm_vhost_set_default_node_attrs,
2289 	.get_task_tag			= tcm_vhost_get_task_tag,
2290 	.get_cmd_state			= tcm_vhost_get_cmd_state,
2291 	.queue_data_in			= tcm_vhost_queue_data_in,
2292 	.queue_status			= tcm_vhost_queue_status,
2293 	.queue_tm_rsp			= tcm_vhost_queue_tm_rsp,
2294 	.aborted_task			= tcm_vhost_aborted_task,
2295 	/*
2296 	 * Setup callers for generic logic in target_core_fabric_configfs.c
2297 	 */
2298 	.fabric_make_wwn		= tcm_vhost_make_tport,
2299 	.fabric_drop_wwn		= tcm_vhost_drop_tport,
2300 	.fabric_make_tpg		= tcm_vhost_make_tpg,
2301 	.fabric_drop_tpg		= tcm_vhost_drop_tpg,
2302 	.fabric_post_link		= tcm_vhost_port_link,
2303 	.fabric_pre_unlink		= tcm_vhost_port_unlink,
2304 	.fabric_make_np			= NULL,
2305 	.fabric_drop_np			= NULL,
2306 	.fabric_make_nodeacl		= tcm_vhost_make_nodeacl,
2307 	.fabric_drop_nodeacl		= tcm_vhost_drop_nodeacl,
2308 };
2309 
tcm_vhost_register_configfs(void)2310 static int tcm_vhost_register_configfs(void)
2311 {
2312 	struct target_fabric_configfs *fabric;
2313 	int ret;
2314 
2315 	pr_debug("TCM_VHOST fabric module %s on %s/%s"
2316 		" on "UTS_RELEASE"\n", TCM_VHOST_VERSION, utsname()->sysname,
2317 		utsname()->machine);
2318 	/*
2319 	 * Register the top level struct config_item_type with TCM core
2320 	 */
2321 	fabric = target_fabric_configfs_init(THIS_MODULE, "vhost");
2322 	if (IS_ERR(fabric)) {
2323 		pr_err("target_fabric_configfs_init() failed\n");
2324 		return PTR_ERR(fabric);
2325 	}
2326 	/*
2327 	 * Setup fabric->tf_ops from our local tcm_vhost_ops
2328 	 */
2329 	fabric->tf_ops = tcm_vhost_ops;
2330 	/*
2331 	 * Setup default attribute lists for various fabric->tf_cit_tmpl
2332 	 */
2333 	fabric->tf_cit_tmpl.tfc_wwn_cit.ct_attrs = tcm_vhost_wwn_attrs;
2334 	fabric->tf_cit_tmpl.tfc_tpg_base_cit.ct_attrs = tcm_vhost_tpg_attrs;
2335 	fabric->tf_cit_tmpl.tfc_tpg_attrib_cit.ct_attrs = NULL;
2336 	fabric->tf_cit_tmpl.tfc_tpg_param_cit.ct_attrs = NULL;
2337 	fabric->tf_cit_tmpl.tfc_tpg_np_base_cit.ct_attrs = NULL;
2338 	fabric->tf_cit_tmpl.tfc_tpg_nacl_base_cit.ct_attrs = NULL;
2339 	fabric->tf_cit_tmpl.tfc_tpg_nacl_attrib_cit.ct_attrs = NULL;
2340 	fabric->tf_cit_tmpl.tfc_tpg_nacl_auth_cit.ct_attrs = NULL;
2341 	fabric->tf_cit_tmpl.tfc_tpg_nacl_param_cit.ct_attrs = NULL;
2342 	/*
2343 	 * Register the fabric for use within TCM
2344 	 */
2345 	ret = target_fabric_configfs_register(fabric);
2346 	if (ret < 0) {
2347 		pr_err("target_fabric_configfs_register() failed"
2348 				" for TCM_VHOST\n");
2349 		return ret;
2350 	}
2351 	/*
2352 	 * Setup our local pointer to *fabric
2353 	 */
2354 	tcm_vhost_fabric_configfs = fabric;
2355 	pr_debug("TCM_VHOST[0] - Set fabric -> tcm_vhost_fabric_configfs\n");
2356 	return 0;
2357 };
2358 
tcm_vhost_deregister_configfs(void)2359 static void tcm_vhost_deregister_configfs(void)
2360 {
2361 	if (!tcm_vhost_fabric_configfs)
2362 		return;
2363 
2364 	target_fabric_configfs_deregister(tcm_vhost_fabric_configfs);
2365 	tcm_vhost_fabric_configfs = NULL;
2366 	pr_debug("TCM_VHOST[0] - Cleared tcm_vhost_fabric_configfs\n");
2367 };
2368 
tcm_vhost_init(void)2369 static int __init tcm_vhost_init(void)
2370 {
2371 	int ret = -ENOMEM;
2372 	/*
2373 	 * Use our own dedicated workqueue for submitting I/O into
2374 	 * target core to avoid contention within system_wq.
2375 	 */
2376 	tcm_vhost_workqueue = alloc_workqueue("tcm_vhost", 0, 0);
2377 	if (!tcm_vhost_workqueue)
2378 		goto out;
2379 
2380 	ret = vhost_scsi_register();
2381 	if (ret < 0)
2382 		goto out_destroy_workqueue;
2383 
2384 	ret = tcm_vhost_register_configfs();
2385 	if (ret < 0)
2386 		goto out_vhost_scsi_deregister;
2387 
2388 	return 0;
2389 
2390 out_vhost_scsi_deregister:
2391 	vhost_scsi_deregister();
2392 out_destroy_workqueue:
2393 	destroy_workqueue(tcm_vhost_workqueue);
2394 out:
2395 	return ret;
2396 };
2397 
tcm_vhost_exit(void)2398 static void tcm_vhost_exit(void)
2399 {
2400 	tcm_vhost_deregister_configfs();
2401 	vhost_scsi_deregister();
2402 	destroy_workqueue(tcm_vhost_workqueue);
2403 };
2404 
2405 MODULE_DESCRIPTION("VHOST_SCSI series fabric driver");
2406 MODULE_ALIAS("tcm_vhost");
2407 MODULE_LICENSE("GPL");
2408 module_init(tcm_vhost_init);
2409 module_exit(tcm_vhost_exit);
2410