2 * Xen SCSI backend driver
4 * Copyright (c) 2008, FUJITSU Limited
6 * Based on the blkback driver code.
7 * Adaption to kernel taget core infrastructure taken from vhost/scsi.c
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License version 2
11 * as published by the Free Software Foundation; or, when distributed
12 * separately from the Linux kernel or incorporated into other
13 * software packages, subject to the following license:
15 * Permission is hereby granted, free of charge, to any person obtaining a copy
16 * of this source file (the "Software"), to deal in the Software without
17 * restriction, including without limitation the rights to use, copy, modify,
18 * merge, publish, distribute, sublicense, and/or sell copies of the Software,
19 * and to permit persons to whom the Software is furnished to do so, subject to
20 * the following conditions:
22 * The above copyright notice and this permission notice shall be included in
23 * all copies or substantial portions of the Software.
25 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
26 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
29 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
30 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
34 #define pr_fmt(fmt) "xen-pvscsi: " fmt
38 #include <linux/module.h>
39 #include <linux/utsname.h>
40 #include <linux/interrupt.h>
41 #include <linux/slab.h>
42 #include <linux/wait.h>
43 #include <linux/sched.h>
44 #include <linux/list.h>
45 #include <linux/gfp.h>
46 #include <linux/delay.h>
47 #include <linux/spinlock.h>
48 #include <linux/configfs.h>
50 #include <generated/utsrelease.h>
52 #include <scsi/scsi_host.h> /* SG_ALL */
54 #include <target/target_core_base.h>
55 #include <target/target_core_fabric.h>
57 #include <asm/hypervisor.h>
60 #include <xen/balloon.h>
61 #include <xen/events.h>
62 #include <xen/xenbus.h>
63 #include <xen/grant_table.h>
66 #include <xen/interface/grant_table.h>
67 #include <xen/interface/io/vscsiif.h>
69 #define VSCSI_VERSION "v0.1"
70 #define VSCSI_NAMELEN 32
73 unsigned int hst
; /* host */
74 unsigned int chn
; /* channel */
75 unsigned int tgt
; /* target */
76 unsigned int lun
; /* LUN */
80 struct ids_tuple v
; /* translate from */
81 struct scsiback_tpg
*tpg
; /* translate to */
88 struct xenbus_device
*dev
;
93 struct vscsiif_back_ring ring
;
97 atomic_t nr_unreplied_reqs
;
100 struct list_head v2p_entry_lists
;
102 wait_queue_head_t waiting_to_free
;
105 /* theoretical maximum of grants for one request */
106 #define VSCSI_MAX_GRANTS (SG_ALL + VSCSIIF_SG_TABLESIZE)
109 * VSCSI_GRANT_BATCH is the maximum number of grants to be processed in one
110 * call to map/unmap grants. Don't choose it too large, as there are arrays
111 * with VSCSI_GRANT_BATCH elements allocated on the stack.
113 #define VSCSI_GRANT_BATCH 16
115 struct vscsibk_pend
{
118 uint8_t cmnd
[VSCSIIF_MAX_COMMAND_SIZE
];
121 uint8_t sc_data_direction
;
122 uint16_t n_sg
; /* real length of SG list */
123 uint16_t n_grants
; /* SG pages and potentially SG list */
127 struct vscsibk_info
*info
;
128 struct v2p_entry
*v2p
;
129 struct scatterlist
*sgl
;
131 uint8_t sense_buffer
[VSCSIIF_SENSE_BUFFERSIZE
];
133 grant_handle_t grant_handles
[VSCSI_MAX_GRANTS
];
134 struct page
*pages
[VSCSI_MAX_GRANTS
];
136 struct se_cmd se_cmd
;
139 struct scsiback_tmr
{
140 atomic_t tmr_complete
;
141 wait_queue_head_t tmr_wait
;
144 #define VSCSI_DEFAULT_SESSION_TAGS 128
146 struct scsiback_nexus
{
147 /* Pointer to TCM session for I_T Nexus */
148 struct se_session
*tvn_se_sess
;
151 struct scsiback_tport
{
152 /* SCSI protocol the tport is providing */
154 /* Binary World Wide unique Port Name for pvscsi Target port */
156 /* ASCII formatted WWPN for pvscsi Target port */
157 char tport_name
[VSCSI_NAMELEN
];
158 /* Returned by scsiback_make_tport() */
159 struct se_wwn tport_wwn
;
162 struct scsiback_tpg
{
163 /* scsiback port target portal group tag for TCM */
165 /* track number of TPG Port/Lun Links wrt explicit I_T Nexus shutdown */
166 int tv_tpg_port_count
;
167 /* xen-pvscsi references to tpg_nexus, protected by tv_tpg_mutex */
169 /* list for scsiback_list */
170 struct list_head tv_tpg_list
;
171 /* Used to protect access for tpg_nexus */
172 struct mutex tv_tpg_mutex
;
173 /* Pointer to the TCM pvscsi I_T Nexus for this TPG endpoint */
174 struct scsiback_nexus
*tpg_nexus
;
175 /* Pointer back to scsiback_tport */
176 struct scsiback_tport
*tport
;
177 /* Returned by scsiback_make_tpg() */
178 struct se_portal_group se_tpg
;
179 /* alias used in xenstore */
180 char param_alias
[VSCSI_NAMELEN
];
181 /* list of info structures related to this target portal group */
182 struct list_head info_list
;
185 #define SCSIBACK_INVALID_HANDLE (~0)
187 static bool log_print_stat
;
188 module_param(log_print_stat
, bool, 0644);
190 static int scsiback_max_buffer_pages
= 1024;
191 module_param_named(max_buffer_pages
, scsiback_max_buffer_pages
, int, 0644);
192 MODULE_PARM_DESC(max_buffer_pages
,
193 "Maximum number of free pages to keep in backend buffer");
195 static DEFINE_SPINLOCK(free_pages_lock
);
196 static int free_pages_num
;
197 static LIST_HEAD(scsiback_free_pages
);
199 /* Global spinlock to protect scsiback TPG list */
200 static DEFINE_MUTEX(scsiback_mutex
);
201 static LIST_HEAD(scsiback_list
);
203 static void scsiback_get(struct vscsibk_info
*info
)
205 atomic_inc(&info
->nr_unreplied_reqs
);
208 static void scsiback_put(struct vscsibk_info
*info
)
210 if (atomic_dec_and_test(&info
->nr_unreplied_reqs
))
211 wake_up(&info
->waiting_to_free
);
214 static void put_free_pages(struct page
**page
, int num
)
217 int i
= free_pages_num
+ num
, n
= num
;
221 if (i
> scsiback_max_buffer_pages
) {
222 n
= min(num
, i
- scsiback_max_buffer_pages
);
223 gnttab_free_pages(n
, page
+ num
- n
);
226 spin_lock_irqsave(&free_pages_lock
, flags
);
227 for (i
= 0; i
< n
; i
++)
228 list_add(&page
[i
]->lru
, &scsiback_free_pages
);
230 spin_unlock_irqrestore(&free_pages_lock
, flags
);
233 static int get_free_page(struct page
**page
)
237 spin_lock_irqsave(&free_pages_lock
, flags
);
238 if (list_empty(&scsiback_free_pages
)) {
239 spin_unlock_irqrestore(&free_pages_lock
, flags
);
240 return gnttab_alloc_pages(1, page
);
242 page
[0] = list_first_entry(&scsiback_free_pages
, struct page
, lru
);
243 list_del(&page
[0]->lru
);
245 spin_unlock_irqrestore(&free_pages_lock
, flags
);
249 static unsigned long vaddr_page(struct page
*page
)
251 unsigned long pfn
= page_to_pfn(page
);
253 return (unsigned long)pfn_to_kaddr(pfn
);
256 static unsigned long vaddr(struct vscsibk_pend
*req
, int seg
)
258 return vaddr_page(req
->pages
[seg
]);
261 static void scsiback_print_status(char *sense_buffer
, int errors
,
262 struct vscsibk_pend
*pending_req
)
264 struct scsiback_tpg
*tpg
= pending_req
->v2p
->tpg
;
266 pr_err("[%s:%d] cmnd[0]=%02x -> st=%02x msg=%02x host=%02x drv=%02x\n",
267 tpg
->tport
->tport_name
, pending_req
->v2p
->lun
,
268 pending_req
->cmnd
[0], status_byte(errors
), msg_byte(errors
),
269 host_byte(errors
), driver_byte(errors
));
272 static void scsiback_fast_flush_area(struct vscsibk_pend
*req
)
274 struct gnttab_unmap_grant_ref unmap
[VSCSI_GRANT_BATCH
];
275 struct page
*pages
[VSCSI_GRANT_BATCH
];
276 unsigned int i
, invcount
= 0;
277 grant_handle_t handle
;
287 for (i
= 0; i
< req
->n_grants
; i
++) {
288 handle
= req
->grant_handles
[i
];
289 if (handle
== SCSIBACK_INVALID_HANDLE
)
291 gnttab_set_unmap_op(&unmap
[invcount
], vaddr(req
, i
),
292 GNTMAP_host_map
, handle
);
293 req
->grant_handles
[i
] = SCSIBACK_INVALID_HANDLE
;
294 pages
[invcount
] = req
->pages
[i
];
295 put_page(pages
[invcount
]);
297 if (invcount
< VSCSI_GRANT_BATCH
)
299 err
= gnttab_unmap_refs(unmap
, NULL
, pages
, invcount
);
305 err
= gnttab_unmap_refs(unmap
, NULL
, pages
, invcount
);
309 put_free_pages(req
->pages
, req
->n_grants
);
313 static void scsiback_free_translation_entry(struct kref
*kref
)
315 struct v2p_entry
*entry
= container_of(kref
, struct v2p_entry
, kref
);
316 struct scsiback_tpg
*tpg
= entry
->tpg
;
318 mutex_lock(&tpg
->tv_tpg_mutex
);
319 tpg
->tv_tpg_fe_count
--;
320 mutex_unlock(&tpg
->tv_tpg_mutex
);
325 static void scsiback_send_response(struct vscsibk_info
*info
,
326 char *sense_buffer
, int32_t result
, uint32_t resid
,
329 struct vscsiif_response
*ring_res
;
331 struct scsi_sense_hdr sshdr
;
335 spin_lock_irqsave(&info
->ring_lock
, flags
);
337 ring_res
= RING_GET_RESPONSE(&info
->ring
, info
->ring
.rsp_prod_pvt
);
338 info
->ring
.rsp_prod_pvt
++;
340 ring_res
->rslt
= result
;
341 ring_res
->rqid
= rqid
;
343 if (sense_buffer
!= NULL
&&
344 scsi_normalize_sense(sense_buffer
, VSCSIIF_SENSE_BUFFERSIZE
,
346 len
= min_t(unsigned, 8 + sense_buffer
[7],
347 VSCSIIF_SENSE_BUFFERSIZE
);
348 memcpy(ring_res
->sense_buffer
, sense_buffer
, len
);
349 ring_res
->sense_len
= len
;
351 ring_res
->sense_len
= 0;
354 ring_res
->residual_len
= resid
;
356 RING_PUSH_RESPONSES_AND_CHECK_NOTIFY(&info
->ring
, notify
);
357 spin_unlock_irqrestore(&info
->ring_lock
, flags
);
360 notify_remote_via_irq(info
->irq
);
363 static void scsiback_do_resp_with_sense(char *sense_buffer
, int32_t result
,
364 uint32_t resid
, struct vscsibk_pend
*pending_req
)
366 scsiback_send_response(pending_req
->info
, sense_buffer
, result
,
367 resid
, pending_req
->rqid
);
369 if (pending_req
->v2p
)
370 kref_put(&pending_req
->v2p
->kref
,
371 scsiback_free_translation_entry
);
374 static void scsiback_cmd_done(struct vscsibk_pend
*pending_req
)
376 struct vscsibk_info
*info
= pending_req
->info
;
377 unsigned char *sense_buffer
;
381 sense_buffer
= pending_req
->sense_buffer
;
382 resid
= pending_req
->se_cmd
.residual_count
;
383 errors
= pending_req
->result
;
385 if (errors
&& log_print_stat
)
386 scsiback_print_status(sense_buffer
, errors
, pending_req
);
388 scsiback_fast_flush_area(pending_req
);
389 scsiback_do_resp_with_sense(sense_buffer
, errors
, resid
, pending_req
);
393 static void scsiback_cmd_exec(struct vscsibk_pend
*pending_req
)
395 struct se_cmd
*se_cmd
= &pending_req
->se_cmd
;
396 struct se_session
*sess
= pending_req
->v2p
->tpg
->tpg_nexus
->tvn_se_sess
;
399 scsiback_get(pending_req
->info
);
400 se_cmd
->tag
= pending_req
->rqid
;
401 rc
= target_submit_cmd_map_sgls(se_cmd
, sess
, pending_req
->cmnd
,
402 pending_req
->sense_buffer
, pending_req
->v2p
->lun
,
403 pending_req
->data_len
, 0,
404 pending_req
->sc_data_direction
, 0,
405 pending_req
->sgl
, pending_req
->n_sg
,
408 transport_send_check_condition_and_sense(se_cmd
,
409 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
, 0);
410 transport_generic_free_cmd(se_cmd
, 0);
414 static int scsiback_gnttab_data_map_batch(struct gnttab_map_grant_ref
*map
,
415 struct page
**pg
, grant_handle_t
*grant
, int cnt
)
422 err
= gnttab_map_refs(map
, NULL
, pg
, cnt
);
424 for (i
= 0; i
< cnt
; i
++) {
425 if (unlikely(map
[i
].status
!= GNTST_okay
)) {
426 pr_err("invalid buffer -- could not remap it\n");
427 map
[i
].handle
= SCSIBACK_INVALID_HANDLE
;
432 grant
[i
] = map
[i
].handle
;
437 static int scsiback_gnttab_data_map_list(struct vscsibk_pend
*pending_req
,
438 struct scsiif_request_segment
*seg
, struct page
**pg
,
439 grant_handle_t
*grant
, int cnt
, u32 flags
)
441 int mapcount
= 0, i
, err
= 0;
442 struct gnttab_map_grant_ref map
[VSCSI_GRANT_BATCH
];
443 struct vscsibk_info
*info
= pending_req
->info
;
445 for (i
= 0; i
< cnt
; i
++) {
446 if (get_free_page(pg
+ mapcount
)) {
447 put_free_pages(pg
, mapcount
);
448 pr_err("no grant page\n");
451 gnttab_set_map_op(&map
[mapcount
], vaddr_page(pg
[mapcount
]),
452 flags
, seg
[i
].gref
, info
->domid
);
454 if (mapcount
< VSCSI_GRANT_BATCH
)
456 err
= scsiback_gnttab_data_map_batch(map
, pg
, grant
, mapcount
);
459 pending_req
->n_grants
+= mapcount
;
464 err
= scsiback_gnttab_data_map_batch(map
, pg
, grant
, mapcount
);
465 pending_req
->n_grants
+= mapcount
;
469 static int scsiback_gnttab_data_map(struct vscsiif_request
*ring_req
,
470 struct vscsibk_pend
*pending_req
)
473 int i
, err
, n_segs
, i_seg
= 0;
475 struct scsiif_request_segment
*seg
;
476 unsigned long end_seg
= 0;
477 unsigned int nr_segments
= (unsigned int)ring_req
->nr_segments
;
478 unsigned int nr_sgl
= 0;
479 struct scatterlist
*sg
;
480 grant_handle_t
*grant
;
482 pending_req
->n_sg
= 0;
483 pending_req
->n_grants
= 0;
484 pending_req
->data_len
= 0;
486 nr_segments
&= ~VSCSIIF_SG_GRANT
;
490 if (nr_segments
> VSCSIIF_SG_TABLESIZE
) {
491 pr_debug("invalid parameter nr_seg = %d\n",
492 ring_req
->nr_segments
);
496 if (ring_req
->nr_segments
& VSCSIIF_SG_GRANT
) {
497 err
= scsiback_gnttab_data_map_list(pending_req
, ring_req
->seg
,
498 pending_req
->pages
, pending_req
->grant_handles
,
499 nr_segments
, GNTMAP_host_map
| GNTMAP_readonly
);
502 nr_sgl
= nr_segments
;
504 for (i
= 0; i
< nr_sgl
; i
++) {
505 n_segs
= ring_req
->seg
[i
].length
/
506 sizeof(struct scsiif_request_segment
);
507 if ((unsigned)ring_req
->seg
[i
].offset
+
508 (unsigned)ring_req
->seg
[i
].length
> PAGE_SIZE
||
509 n_segs
* sizeof(struct scsiif_request_segment
) !=
510 ring_req
->seg
[i
].length
)
512 nr_segments
+= n_segs
;
514 if (nr_segments
> SG_ALL
) {
515 pr_debug("invalid nr_seg = %d\n", nr_segments
);
520 /* free of (sgl) in fast_flush_area() */
521 pending_req
->sgl
= kmalloc_array(nr_segments
,
522 sizeof(struct scatterlist
), GFP_KERNEL
);
523 if (!pending_req
->sgl
)
526 sg_init_table(pending_req
->sgl
, nr_segments
);
527 pending_req
->n_sg
= nr_segments
;
529 flags
= GNTMAP_host_map
;
530 if (pending_req
->sc_data_direction
== DMA_TO_DEVICE
)
531 flags
|= GNTMAP_readonly
;
533 pg
= pending_req
->pages
+ nr_sgl
;
534 grant
= pending_req
->grant_handles
+ nr_sgl
;
537 err
= scsiback_gnttab_data_map_list(pending_req
, seg
,
538 pg
, grant
, nr_segments
, flags
);
542 for (i
= 0; i
< nr_sgl
; i
++) {
543 seg
= (struct scsiif_request_segment
*)(
544 vaddr(pending_req
, i
) + ring_req
->seg
[i
].offset
);
545 n_segs
= ring_req
->seg
[i
].length
/
546 sizeof(struct scsiif_request_segment
);
547 err
= scsiback_gnttab_data_map_list(pending_req
, seg
,
548 pg
, grant
, n_segs
, flags
);
554 end_seg
= vaddr(pending_req
, 0) + ring_req
->seg
[0].offset
;
555 seg
= (struct scsiif_request_segment
*)end_seg
;
556 end_seg
+= ring_req
->seg
[0].length
;
557 pg
= pending_req
->pages
+ nr_sgl
;
560 for_each_sg(pending_req
->sgl
, sg
, nr_segments
, i
) {
561 sg_set_page(sg
, pg
[i
], seg
->length
, seg
->offset
);
562 pending_req
->data_len
+= seg
->length
;
564 if (nr_sgl
&& (unsigned long)seg
>= end_seg
) {
566 end_seg
= vaddr(pending_req
, i_seg
) +
567 ring_req
->seg
[i_seg
].offset
;
568 seg
= (struct scsiif_request_segment
*)end_seg
;
569 end_seg
+= ring_req
->seg
[i_seg
].length
;
571 if (sg
->offset
>= PAGE_SIZE
||
572 sg
->length
> PAGE_SIZE
||
573 sg
->offset
+ sg
->length
> PAGE_SIZE
)
580 static void scsiback_disconnect(struct vscsibk_info
*info
)
582 wait_event(info
->waiting_to_free
,
583 atomic_read(&info
->nr_unreplied_reqs
) == 0);
585 unbind_from_irqhandler(info
->irq
, info
);
587 xenbus_unmap_ring_vfree(info
->dev
, info
->ring
.sring
);
590 static void scsiback_device_action(struct vscsibk_pend
*pending_req
,
591 enum tcm_tmreq_table act
, int tag
)
593 int rc
, err
= FAILED
;
594 struct scsiback_tpg
*tpg
= pending_req
->v2p
->tpg
;
595 struct se_cmd
*se_cmd
= &pending_req
->se_cmd
;
596 struct scsiback_tmr
*tmr
;
598 tmr
= kzalloc(sizeof(struct scsiback_tmr
), GFP_KERNEL
);
602 init_waitqueue_head(&tmr
->tmr_wait
);
604 transport_init_se_cmd(se_cmd
, tpg
->se_tpg
.se_tpg_tfo
,
605 tpg
->tpg_nexus
->tvn_se_sess
, 0, DMA_NONE
, TCM_SIMPLE_TAG
,
606 &pending_req
->sense_buffer
[0]);
608 rc
= core_tmr_alloc_req(se_cmd
, tmr
, act
, GFP_KERNEL
);
612 se_cmd
->se_tmr_req
->ref_task_tag
= tag
;
614 if (transport_lookup_tmr_lun(se_cmd
, pending_req
->v2p
->lun
) < 0)
617 transport_generic_handle_tmr(se_cmd
);
618 wait_event(tmr
->tmr_wait
, atomic_read(&tmr
->tmr_complete
));
620 err
= (se_cmd
->se_tmr_req
->response
== TMR_FUNCTION_COMPLETE
) ?
623 scsiback_do_resp_with_sense(NULL
, err
, 0, pending_req
);
624 transport_generic_free_cmd(&pending_req
->se_cmd
, 1);
629 scsiback_do_resp_with_sense(NULL
, err
, 0, pending_req
);
633 Perform virtual to physical translation
635 static struct v2p_entry
*scsiback_do_translation(struct vscsibk_info
*info
,
638 struct v2p_entry
*entry
;
639 struct list_head
*head
= &(info
->v2p_entry_lists
);
642 spin_lock_irqsave(&info
->v2p_lock
, flags
);
643 list_for_each_entry(entry
, head
, l
) {
644 if ((entry
->v
.chn
== v
->chn
) &&
645 (entry
->v
.tgt
== v
->tgt
) &&
646 (entry
->v
.lun
== v
->lun
)) {
647 kref_get(&entry
->kref
);
654 spin_unlock_irqrestore(&info
->v2p_lock
, flags
);
658 static struct vscsibk_pend
*scsiback_get_pend_req(struct vscsiif_back_ring
*ring
,
659 struct v2p_entry
*v2p
)
661 struct scsiback_tpg
*tpg
= v2p
->tpg
;
662 struct scsiback_nexus
*nexus
= tpg
->tpg_nexus
;
663 struct se_session
*se_sess
= nexus
->tvn_se_sess
;
664 struct vscsibk_pend
*req
;
667 tag
= percpu_ida_alloc(&se_sess
->sess_tag_pool
, TASK_RUNNING
);
669 pr_err("Unable to obtain tag for vscsiif_request\n");
670 return ERR_PTR(-ENOMEM
);
673 req
= &((struct vscsibk_pend
*)se_sess
->sess_cmd_map
)[tag
];
674 memset(req
, 0, sizeof(*req
));
675 req
->se_cmd
.map_tag
= tag
;
677 for (i
= 0; i
< VSCSI_MAX_GRANTS
; i
++)
678 req
->grant_handles
[i
] = SCSIBACK_INVALID_HANDLE
;
683 static struct vscsibk_pend
*prepare_pending_reqs(struct vscsibk_info
*info
,
684 struct vscsiif_back_ring
*ring
,
685 struct vscsiif_request
*ring_req
)
687 struct vscsibk_pend
*pending_req
;
688 struct v2p_entry
*v2p
;
689 struct ids_tuple vir
;
691 /* request range check from frontend */
692 if ((ring_req
->sc_data_direction
!= DMA_BIDIRECTIONAL
) &&
693 (ring_req
->sc_data_direction
!= DMA_TO_DEVICE
) &&
694 (ring_req
->sc_data_direction
!= DMA_FROM_DEVICE
) &&
695 (ring_req
->sc_data_direction
!= DMA_NONE
)) {
696 pr_debug("invalid parameter data_dir = %d\n",
697 ring_req
->sc_data_direction
);
698 return ERR_PTR(-EINVAL
);
700 if (ring_req
->cmd_len
> VSCSIIF_MAX_COMMAND_SIZE
) {
701 pr_debug("invalid parameter cmd_len = %d\n",
703 return ERR_PTR(-EINVAL
);
706 vir
.chn
= ring_req
->channel
;
707 vir
.tgt
= ring_req
->id
;
708 vir
.lun
= ring_req
->lun
;
710 v2p
= scsiback_do_translation(info
, &vir
);
712 pr_debug("the v2p of (chn:%d, tgt:%d, lun:%d) doesn't exist.\n",
713 vir
.chn
, vir
.tgt
, vir
.lun
);
714 return ERR_PTR(-ENODEV
);
717 pending_req
= scsiback_get_pend_req(ring
, v2p
);
718 if (IS_ERR(pending_req
)) {
719 kref_put(&v2p
->kref
, scsiback_free_translation_entry
);
720 return ERR_PTR(-ENOMEM
);
722 pending_req
->rqid
= ring_req
->rqid
;
723 pending_req
->info
= info
;
724 pending_req
->v2p
= v2p
;
725 pending_req
->sc_data_direction
= ring_req
->sc_data_direction
;
726 pending_req
->cmd_len
= ring_req
->cmd_len
;
727 memcpy(pending_req
->cmnd
, ring_req
->cmnd
, pending_req
->cmd_len
);
732 static int scsiback_do_cmd_fn(struct vscsibk_info
*info
)
734 struct vscsiif_back_ring
*ring
= &info
->ring
;
735 struct vscsiif_request ring_req
;
736 struct vscsibk_pend
*pending_req
;
742 rp
= ring
->sring
->req_prod
;
743 rmb(); /* guest system is accessing ring, too */
745 if (RING_REQUEST_PROD_OVERFLOW(ring
, rp
)) {
746 rc
= ring
->rsp_prod_pvt
;
747 pr_warn("Dom%d provided bogus ring requests (%#x - %#x = %u). Halting ring processing\n",
748 info
->domid
, rp
, rc
, rp
- rc
);
749 info
->ring_error
= 1;
754 if (RING_REQUEST_CONS_OVERFLOW(ring
, rc
))
757 RING_COPY_REQUEST(ring
, rc
, &ring_req
);
758 ring
->req_cons
= ++rc
;
760 pending_req
= prepare_pending_reqs(info
, ring
, &ring_req
);
761 if (IS_ERR(pending_req
)) {
762 switch (PTR_ERR(pending_req
)) {
764 result
= DID_NO_CONNECT
;
767 result
= DRIVER_ERROR
;
770 scsiback_send_response(info
, NULL
, result
<< 24, 0,
775 switch (ring_req
.act
) {
776 case VSCSIIF_ACT_SCSI_CDB
:
777 if (scsiback_gnttab_data_map(&ring_req
, pending_req
)) {
778 scsiback_fast_flush_area(pending_req
);
779 scsiback_do_resp_with_sense(NULL
,
780 DRIVER_ERROR
<< 24, 0, pending_req
);
781 transport_generic_free_cmd(&pending_req
->se_cmd
, 0);
783 scsiback_cmd_exec(pending_req
);
786 case VSCSIIF_ACT_SCSI_ABORT
:
787 scsiback_device_action(pending_req
, TMR_ABORT_TASK
,
790 case VSCSIIF_ACT_SCSI_RESET
:
791 scsiback_device_action(pending_req
, TMR_LUN_RESET
, 0);
794 pr_err_ratelimited("invalid request\n");
795 scsiback_do_resp_with_sense(NULL
, DRIVER_ERROR
<< 24, 0,
797 transport_generic_free_cmd(&pending_req
->se_cmd
, 0);
801 /* Yield point for this unbounded loop. */
805 RING_FINAL_CHECK_FOR_REQUESTS(&info
->ring
, more_to_do
);
809 static irqreturn_t
scsiback_irq_fn(int irq
, void *dev_id
)
811 struct vscsibk_info
*info
= dev_id
;
813 if (info
->ring_error
)
816 while (scsiback_do_cmd_fn(info
))
822 static int scsiback_init_sring(struct vscsibk_info
*info
, grant_ref_t ring_ref
,
823 evtchn_port_t evtchn
)
826 struct vscsiif_sring
*sring
;
832 err
= xenbus_map_ring_valloc(info
->dev
, &ring_ref
, 1, &area
);
836 sring
= (struct vscsiif_sring
*)area
;
837 BACK_RING_INIT(&info
->ring
, sring
, PAGE_SIZE
);
839 err
= bind_interdomain_evtchn_to_irq(info
->domid
, evtchn
);
845 err
= request_threaded_irq(info
->irq
, NULL
, scsiback_irq_fn
,
846 IRQF_ONESHOT
, "vscsiif-backend", info
);
853 unbind_from_irqhandler(info
->irq
, info
);
856 xenbus_unmap_ring_vfree(info
->dev
, area
);
861 static int scsiback_map(struct vscsibk_info
*info
)
863 struct xenbus_device
*dev
= info
->dev
;
864 unsigned int ring_ref
, evtchn
;
867 err
= xenbus_gather(XBT_NIL
, dev
->otherend
,
868 "ring-ref", "%u", &ring_ref
,
869 "event-channel", "%u", &evtchn
, NULL
);
871 xenbus_dev_fatal(dev
, err
, "reading %s ring", dev
->otherend
);
875 return scsiback_init_sring(info
, ring_ref
, evtchn
);
879 Add a new translation entry
881 static int scsiback_add_translation_entry(struct vscsibk_info
*info
,
882 char *phy
, struct ids_tuple
*v
)
885 struct v2p_entry
*entry
;
886 struct v2p_entry
*new;
887 struct list_head
*head
= &(info
->v2p_entry_lists
);
890 unsigned long long unpacked_lun
;
891 struct se_lun
*se_lun
;
892 struct scsiback_tpg
*tpg_entry
, *tpg
= NULL
;
893 char *error
= "doesn't exist";
895 lunp
= strrchr(phy
, ':');
897 pr_err("illegal format of physical device %s\n", phy
);
902 err
= kstrtoull(lunp
, 10, &unpacked_lun
);
904 pr_err("lun number not valid: %s\n", lunp
);
908 mutex_lock(&scsiback_mutex
);
909 list_for_each_entry(tpg_entry
, &scsiback_list
, tv_tpg_list
) {
910 if (!strcmp(phy
, tpg_entry
->tport
->tport_name
) ||
911 !strcmp(phy
, tpg_entry
->param_alias
)) {
912 mutex_lock(&tpg_entry
->se_tpg
.tpg_lun_mutex
);
913 hlist_for_each_entry(se_lun
, &tpg_entry
->se_tpg
.tpg_lun_hlist
, link
) {
914 if (se_lun
->unpacked_lun
== unpacked_lun
) {
915 if (!tpg_entry
->tpg_nexus
)
916 error
= "nexus undefined";
922 mutex_unlock(&tpg_entry
->se_tpg
.tpg_lun_mutex
);
927 mutex_lock(&tpg
->tv_tpg_mutex
);
928 tpg
->tv_tpg_fe_count
++;
929 mutex_unlock(&tpg
->tv_tpg_mutex
);
931 mutex_unlock(&scsiback_mutex
);
934 pr_err("%s:%llu %s\n", phy
, unpacked_lun
, error
);
938 new = kmalloc(sizeof(struct v2p_entry
), GFP_KERNEL
);
944 spin_lock_irqsave(&info
->v2p_lock
, flags
);
946 /* Check double assignment to identical virtual ID */
947 list_for_each_entry(entry
, head
, l
) {
948 if ((entry
->v
.chn
== v
->chn
) &&
949 (entry
->v
.tgt
== v
->tgt
) &&
950 (entry
->v
.lun
== v
->lun
)) {
951 pr_warn("Virtual ID is already used. Assignment was not performed.\n");
958 /* Create a new translation entry and add to the list */
959 kref_init(&new->kref
);
962 new->lun
= unpacked_lun
;
963 list_add_tail(&new->l
, head
);
966 spin_unlock_irqrestore(&info
->v2p_lock
, flags
);
969 mutex_lock(&tpg
->tv_tpg_mutex
);
970 tpg
->tv_tpg_fe_count
--;
971 mutex_unlock(&tpg
->tv_tpg_mutex
);
979 static void __scsiback_del_translation_entry(struct v2p_entry
*entry
)
982 kref_put(&entry
->kref
, scsiback_free_translation_entry
);
986 Delete the translation entry specfied
988 static int scsiback_del_translation_entry(struct vscsibk_info
*info
,
991 struct v2p_entry
*entry
;
992 struct list_head
*head
= &(info
->v2p_entry_lists
);
995 spin_lock_irqsave(&info
->v2p_lock
, flags
);
996 /* Find out the translation entry specified */
997 list_for_each_entry(entry
, head
, l
) {
998 if ((entry
->v
.chn
== v
->chn
) &&
999 (entry
->v
.tgt
== v
->tgt
) &&
1000 (entry
->v
.lun
== v
->lun
)) {
1005 spin_unlock_irqrestore(&info
->v2p_lock
, flags
);
1009 /* Delete the translation entry specfied */
1010 __scsiback_del_translation_entry(entry
);
1012 spin_unlock_irqrestore(&info
->v2p_lock
, flags
);
1016 static void scsiback_do_add_lun(struct vscsibk_info
*info
, const char *state
,
1017 char *phy
, struct ids_tuple
*vir
, int try)
1019 if (!scsiback_add_translation_entry(info
, phy
, vir
)) {
1020 if (xenbus_printf(XBT_NIL
, info
->dev
->nodename
, state
,
1021 "%d", XenbusStateInitialised
)) {
1022 pr_err("xenbus_printf error %s\n", state
);
1023 scsiback_del_translation_entry(info
, vir
);
1026 xenbus_printf(XBT_NIL
, info
->dev
->nodename
, state
,
1027 "%d", XenbusStateClosed
);
1031 static void scsiback_do_del_lun(struct vscsibk_info
*info
, const char *state
,
1032 struct ids_tuple
*vir
)
1034 if (!scsiback_del_translation_entry(info
, vir
)) {
1035 if (xenbus_printf(XBT_NIL
, info
->dev
->nodename
, state
,
1036 "%d", XenbusStateClosed
))
1037 pr_err("xenbus_printf error %s\n", state
);
1041 #define VSCSIBACK_OP_ADD_OR_DEL_LUN 1
1042 #define VSCSIBACK_OP_UPDATEDEV_STATE 2
1044 static void scsiback_do_1lun_hotplug(struct vscsibk_info
*info
, int op
,
1048 struct ids_tuple vir
;
1051 char phy
[VSCSI_NAMELEN
];
1054 struct xenbus_device
*dev
= info
->dev
;
1057 snprintf(state
, sizeof(state
), "vscsi-devs/%s/state", ent
);
1058 err
= xenbus_scanf(XBT_NIL
, dev
->nodename
, state
, "%u", &device_state
);
1059 if (XENBUS_EXIST_ERR(err
))
1062 /* physical SCSI device */
1063 snprintf(str
, sizeof(str
), "vscsi-devs/%s/p-dev", ent
);
1064 val
= xenbus_read(XBT_NIL
, dev
->nodename
, str
, NULL
);
1066 xenbus_printf(XBT_NIL
, dev
->nodename
, state
,
1067 "%d", XenbusStateClosed
);
1070 strlcpy(phy
, val
, VSCSI_NAMELEN
);
1073 /* virtual SCSI device */
1074 snprintf(str
, sizeof(str
), "vscsi-devs/%s/v-dev", ent
);
1075 err
= xenbus_scanf(XBT_NIL
, dev
->nodename
, str
, "%u:%u:%u:%u",
1076 &vir
.hst
, &vir
.chn
, &vir
.tgt
, &vir
.lun
);
1077 if (XENBUS_EXIST_ERR(err
)) {
1078 xenbus_printf(XBT_NIL
, dev
->nodename
, state
,
1079 "%d", XenbusStateClosed
);
1084 case VSCSIBACK_OP_ADD_OR_DEL_LUN
:
1085 switch (device_state
) {
1086 case XenbusStateInitialising
:
1087 scsiback_do_add_lun(info
, state
, phy
, &vir
, 0);
1089 case XenbusStateConnected
:
1090 scsiback_do_add_lun(info
, state
, phy
, &vir
, 1);
1092 case XenbusStateClosing
:
1093 scsiback_do_del_lun(info
, state
, &vir
);
1100 case VSCSIBACK_OP_UPDATEDEV_STATE
:
1101 if (device_state
== XenbusStateInitialised
) {
1102 /* modify vscsi-devs/dev-x/state */
1103 if (xenbus_printf(XBT_NIL
, dev
->nodename
, state
,
1104 "%d", XenbusStateConnected
)) {
1105 pr_err("xenbus_printf error %s\n", str
);
1106 scsiback_del_translation_entry(info
, &vir
);
1107 xenbus_printf(XBT_NIL
, dev
->nodename
, state
,
1108 "%d", XenbusStateClosed
);
1112 /* When it is necessary, processing is added here. */
1118 static void scsiback_do_lun_hotplug(struct vscsibk_info
*info
, int op
)
1122 unsigned int ndir
= 0;
1124 dir
= xenbus_directory(XBT_NIL
, info
->dev
->nodename
, "vscsi-devs",
1129 for (i
= 0; i
< ndir
; i
++)
1130 scsiback_do_1lun_hotplug(info
, op
, dir
[i
]);
1135 static void scsiback_frontend_changed(struct xenbus_device
*dev
,
1136 enum xenbus_state frontend_state
)
1138 struct vscsibk_info
*info
= dev_get_drvdata(&dev
->dev
);
1140 switch (frontend_state
) {
1141 case XenbusStateInitialising
:
1144 case XenbusStateInitialised
:
1145 if (scsiback_map(info
))
1148 scsiback_do_lun_hotplug(info
, VSCSIBACK_OP_ADD_OR_DEL_LUN
);
1149 xenbus_switch_state(dev
, XenbusStateConnected
);
1152 case XenbusStateConnected
:
1153 scsiback_do_lun_hotplug(info
, VSCSIBACK_OP_UPDATEDEV_STATE
);
1155 if (dev
->state
== XenbusStateConnected
)
1158 xenbus_switch_state(dev
, XenbusStateConnected
);
1161 case XenbusStateClosing
:
1163 scsiback_disconnect(info
);
1165 xenbus_switch_state(dev
, XenbusStateClosing
);
1168 case XenbusStateClosed
:
1169 xenbus_switch_state(dev
, XenbusStateClosed
);
1170 if (xenbus_dev_is_online(dev
))
1172 /* fall through if not online */
1173 case XenbusStateUnknown
:
1174 device_unregister(&dev
->dev
);
1177 case XenbusStateReconfiguring
:
1178 scsiback_do_lun_hotplug(info
, VSCSIBACK_OP_ADD_OR_DEL_LUN
);
1179 xenbus_switch_state(dev
, XenbusStateReconfigured
);
1184 xenbus_dev_fatal(dev
, -EINVAL
, "saw state %d at frontend",
1191 Release the translation entry specfied
1193 static void scsiback_release_translation_entry(struct vscsibk_info
*info
)
1195 struct v2p_entry
*entry
, *tmp
;
1196 struct list_head
*head
= &(info
->v2p_entry_lists
);
1197 unsigned long flags
;
1199 spin_lock_irqsave(&info
->v2p_lock
, flags
);
1201 list_for_each_entry_safe(entry
, tmp
, head
, l
)
1202 __scsiback_del_translation_entry(entry
);
1204 spin_unlock_irqrestore(&info
->v2p_lock
, flags
);
1207 static int scsiback_remove(struct xenbus_device
*dev
)
1209 struct vscsibk_info
*info
= dev_get_drvdata(&dev
->dev
);
1212 scsiback_disconnect(info
);
1214 scsiback_release_translation_entry(info
);
1216 dev_set_drvdata(&dev
->dev
, NULL
);
1221 static int scsiback_probe(struct xenbus_device
*dev
,
1222 const struct xenbus_device_id
*id
)
1226 struct vscsibk_info
*info
= kzalloc(sizeof(struct vscsibk_info
),
1229 pr_debug("%s %p %d\n", __func__
, dev
, dev
->otherend_id
);
1232 xenbus_dev_fatal(dev
, -ENOMEM
, "allocating backend structure");
1236 dev_set_drvdata(&dev
->dev
, info
);
1238 info
->domid
= dev
->otherend_id
;
1239 spin_lock_init(&info
->ring_lock
);
1240 info
->ring_error
= 0;
1241 atomic_set(&info
->nr_unreplied_reqs
, 0);
1242 init_waitqueue_head(&info
->waiting_to_free
);
1245 INIT_LIST_HEAD(&info
->v2p_entry_lists
);
1246 spin_lock_init(&info
->v2p_lock
);
1248 err
= xenbus_printf(XBT_NIL
, dev
->nodename
, "feature-sg-grant", "%u",
1251 xenbus_dev_error(dev
, err
, "writing feature-sg-grant");
1253 err
= xenbus_switch_state(dev
, XenbusStateInitWait
);
1260 pr_warn("%s failed\n", __func__
);
1261 scsiback_remove(dev
);
1266 static char *scsiback_dump_proto_id(struct scsiback_tport
*tport
)
1268 switch (tport
->tport_proto_id
) {
1269 case SCSI_PROTOCOL_SAS
:
1271 case SCSI_PROTOCOL_FCP
:
1273 case SCSI_PROTOCOL_ISCSI
:
1282 static char *scsiback_get_fabric_wwn(struct se_portal_group
*se_tpg
)
1284 struct scsiback_tpg
*tpg
= container_of(se_tpg
,
1285 struct scsiback_tpg
, se_tpg
);
1286 struct scsiback_tport
*tport
= tpg
->tport
;
1288 return &tport
->tport_name
[0];
1291 static u16
scsiback_get_tag(struct se_portal_group
*se_tpg
)
1293 struct scsiback_tpg
*tpg
= container_of(se_tpg
,
1294 struct scsiback_tpg
, se_tpg
);
1295 return tpg
->tport_tpgt
;
1298 static struct se_wwn
*
1299 scsiback_make_tport(struct target_fabric_configfs
*tf
,
1300 struct config_group
*group
,
1303 struct scsiback_tport
*tport
;
1308 tport
= kzalloc(sizeof(struct scsiback_tport
), GFP_KERNEL
);
1310 return ERR_PTR(-ENOMEM
);
1312 tport
->tport_wwpn
= wwpn
;
1314 * Determine the emulated Protocol Identifier and Target Port Name
1315 * based on the incoming configfs directory name.
1317 ptr
= strstr(name
, "naa.");
1319 tport
->tport_proto_id
= SCSI_PROTOCOL_SAS
;
1322 ptr
= strstr(name
, "fc.");
1324 tport
->tport_proto_id
= SCSI_PROTOCOL_FCP
;
1325 off
= 3; /* Skip over "fc." */
1328 ptr
= strstr(name
, "iqn.");
1330 tport
->tport_proto_id
= SCSI_PROTOCOL_ISCSI
;
1334 pr_err("Unable to locate prefix for emulated Target Port: %s\n", name
);
1336 return ERR_PTR(-EINVAL
);
1339 if (strlen(name
) >= VSCSI_NAMELEN
) {
1340 pr_err("Emulated %s Address: %s, exceeds max: %d\n", name
,
1341 scsiback_dump_proto_id(tport
), VSCSI_NAMELEN
);
1343 return ERR_PTR(-EINVAL
);
1345 snprintf(&tport
->tport_name
[0], VSCSI_NAMELEN
, "%s", &name
[off
]);
1347 pr_debug("Allocated emulated Target %s Address: %s\n",
1348 scsiback_dump_proto_id(tport
), name
);
1350 return &tport
->tport_wwn
;
1353 static void scsiback_drop_tport(struct se_wwn
*wwn
)
1355 struct scsiback_tport
*tport
= container_of(wwn
,
1356 struct scsiback_tport
, tport_wwn
);
1358 pr_debug("Deallocating emulated Target %s Address: %s\n",
1359 scsiback_dump_proto_id(tport
), tport
->tport_name
);
1364 static u32
scsiback_tpg_get_inst_index(struct se_portal_group
*se_tpg
)
1369 static int scsiback_check_stop_free(struct se_cmd
*se_cmd
)
1372 * Do not release struct se_cmd's containing a valid TMR pointer.
1373 * These will be released directly in scsiback_device_action()
1374 * with transport_generic_free_cmd().
1376 if (se_cmd
->se_cmd_flags
& SCF_SCSI_TMR_CDB
)
1379 transport_generic_free_cmd(se_cmd
, 0);
1383 static void scsiback_release_cmd(struct se_cmd
*se_cmd
)
1385 struct se_session
*se_sess
= se_cmd
->se_sess
;
1387 percpu_ida_free(&se_sess
->sess_tag_pool
, se_cmd
->map_tag
);
1390 static int scsiback_shutdown_session(struct se_session
*se_sess
)
1395 static void scsiback_close_session(struct se_session
*se_sess
)
1399 static u32
scsiback_sess_get_index(struct se_session
*se_sess
)
1404 static int scsiback_write_pending(struct se_cmd
*se_cmd
)
1406 /* Go ahead and process the write immediately */
1407 target_execute_cmd(se_cmd
);
1412 static int scsiback_write_pending_status(struct se_cmd
*se_cmd
)
1417 static void scsiback_set_default_node_attrs(struct se_node_acl
*nacl
)
1421 static int scsiback_get_cmd_state(struct se_cmd
*se_cmd
)
1426 static int scsiback_queue_data_in(struct se_cmd
*se_cmd
)
1428 struct vscsibk_pend
*pending_req
= container_of(se_cmd
,
1429 struct vscsibk_pend
, se_cmd
);
1431 pending_req
->result
= SAM_STAT_GOOD
;
1432 scsiback_cmd_done(pending_req
);
1436 static int scsiback_queue_status(struct se_cmd
*se_cmd
)
1438 struct vscsibk_pend
*pending_req
= container_of(se_cmd
,
1439 struct vscsibk_pend
, se_cmd
);
1441 if (se_cmd
->sense_buffer
&&
1442 ((se_cmd
->se_cmd_flags
& SCF_TRANSPORT_TASK_SENSE
) ||
1443 (se_cmd
->se_cmd_flags
& SCF_EMULATED_TASK_SENSE
)))
1444 pending_req
->result
= (DRIVER_SENSE
<< 24) |
1445 SAM_STAT_CHECK_CONDITION
;
1447 pending_req
->result
= se_cmd
->scsi_status
;
1449 scsiback_cmd_done(pending_req
);
1453 static void scsiback_queue_tm_rsp(struct se_cmd
*se_cmd
)
1455 struct se_tmr_req
*se_tmr
= se_cmd
->se_tmr_req
;
1456 struct scsiback_tmr
*tmr
= se_tmr
->fabric_tmr_ptr
;
1458 atomic_set(&tmr
->tmr_complete
, 1);
1459 wake_up(&tmr
->tmr_wait
);
1462 static void scsiback_aborted_task(struct se_cmd
*se_cmd
)
1466 static ssize_t
scsiback_tpg_param_alias_show(struct config_item
*item
,
1469 struct se_portal_group
*se_tpg
= param_to_tpg(item
);
1470 struct scsiback_tpg
*tpg
= container_of(se_tpg
, struct scsiback_tpg
,
1474 mutex_lock(&tpg
->tv_tpg_mutex
);
1475 rb
= snprintf(page
, PAGE_SIZE
, "%s\n", tpg
->param_alias
);
1476 mutex_unlock(&tpg
->tv_tpg_mutex
);
1481 static ssize_t
scsiback_tpg_param_alias_store(struct config_item
*item
,
1482 const char *page
, size_t count
)
1484 struct se_portal_group
*se_tpg
= param_to_tpg(item
);
1485 struct scsiback_tpg
*tpg
= container_of(se_tpg
, struct scsiback_tpg
,
1489 if (strlen(page
) >= VSCSI_NAMELEN
) {
1490 pr_err("param alias: %s, exceeds max: %d\n", page
,
1495 mutex_lock(&tpg
->tv_tpg_mutex
);
1496 len
= snprintf(tpg
->param_alias
, VSCSI_NAMELEN
, "%s", page
);
1497 if (tpg
->param_alias
[len
- 1] == '\n')
1498 tpg
->param_alias
[len
- 1] = '\0';
1499 mutex_unlock(&tpg
->tv_tpg_mutex
);
1504 CONFIGFS_ATTR(scsiback_tpg_param_
, alias
);
1506 static struct configfs_attribute
*scsiback_param_attrs
[] = {
1507 &scsiback_tpg_param_attr_alias
,
1511 static int scsiback_alloc_sess_cb(struct se_portal_group
*se_tpg
,
1512 struct se_session
*se_sess
, void *p
)
1514 struct scsiback_tpg
*tpg
= container_of(se_tpg
,
1515 struct scsiback_tpg
, se_tpg
);
1521 static int scsiback_make_nexus(struct scsiback_tpg
*tpg
,
1524 struct scsiback_nexus
*tv_nexus
;
1527 mutex_lock(&tpg
->tv_tpg_mutex
);
1528 if (tpg
->tpg_nexus
) {
1529 pr_debug("tpg->tpg_nexus already exists\n");
1534 tv_nexus
= kzalloc(sizeof(struct scsiback_nexus
), GFP_KERNEL
);
1540 tv_nexus
->tvn_se_sess
= target_alloc_session(&tpg
->se_tpg
,
1541 VSCSI_DEFAULT_SESSION_TAGS
,
1542 sizeof(struct vscsibk_pend
),
1543 TARGET_PROT_NORMAL
, name
,
1544 tv_nexus
, scsiback_alloc_sess_cb
);
1545 if (IS_ERR(tv_nexus
->tvn_se_sess
)) {
1552 mutex_unlock(&tpg
->tv_tpg_mutex
);
1556 static int scsiback_drop_nexus(struct scsiback_tpg
*tpg
)
1558 struct se_session
*se_sess
;
1559 struct scsiback_nexus
*tv_nexus
;
1561 mutex_lock(&tpg
->tv_tpg_mutex
);
1562 tv_nexus
= tpg
->tpg_nexus
;
1564 mutex_unlock(&tpg
->tv_tpg_mutex
);
1568 se_sess
= tv_nexus
->tvn_se_sess
;
1570 mutex_unlock(&tpg
->tv_tpg_mutex
);
1574 if (tpg
->tv_tpg_port_count
!= 0) {
1575 mutex_unlock(&tpg
->tv_tpg_mutex
);
1576 pr_err("Unable to remove xen-pvscsi I_T Nexus with active TPG port count: %d\n",
1577 tpg
->tv_tpg_port_count
);
1581 if (tpg
->tv_tpg_fe_count
!= 0) {
1582 mutex_unlock(&tpg
->tv_tpg_mutex
);
1583 pr_err("Unable to remove xen-pvscsi I_T Nexus with active TPG frontend count: %d\n",
1584 tpg
->tv_tpg_fe_count
);
1588 pr_debug("Removing I_T Nexus to emulated %s Initiator Port: %s\n",
1589 scsiback_dump_proto_id(tpg
->tport
),
1590 tv_nexus
->tvn_se_sess
->se_node_acl
->initiatorname
);
1593 * Release the SCSI I_T Nexus to the emulated xen-pvscsi Target Port
1595 transport_deregister_session(tv_nexus
->tvn_se_sess
);
1596 tpg
->tpg_nexus
= NULL
;
1597 mutex_unlock(&tpg
->tv_tpg_mutex
);
1603 static ssize_t
scsiback_tpg_nexus_show(struct config_item
*item
, char *page
)
1605 struct se_portal_group
*se_tpg
= to_tpg(item
);
1606 struct scsiback_tpg
*tpg
= container_of(se_tpg
,
1607 struct scsiback_tpg
, se_tpg
);
1608 struct scsiback_nexus
*tv_nexus
;
1611 mutex_lock(&tpg
->tv_tpg_mutex
);
1612 tv_nexus
= tpg
->tpg_nexus
;
1614 mutex_unlock(&tpg
->tv_tpg_mutex
);
1617 ret
= snprintf(page
, PAGE_SIZE
, "%s\n",
1618 tv_nexus
->tvn_se_sess
->se_node_acl
->initiatorname
);
1619 mutex_unlock(&tpg
->tv_tpg_mutex
);
1624 static ssize_t
scsiback_tpg_nexus_store(struct config_item
*item
,
1625 const char *page
, size_t count
)
1627 struct se_portal_group
*se_tpg
= to_tpg(item
);
1628 struct scsiback_tpg
*tpg
= container_of(se_tpg
,
1629 struct scsiback_tpg
, se_tpg
);
1630 struct scsiback_tport
*tport_wwn
= tpg
->tport
;
1631 unsigned char i_port
[VSCSI_NAMELEN
], *ptr
, *port_ptr
;
1634 * Shutdown the active I_T nexus if 'NULL' is passed.
1636 if (!strncmp(page
, "NULL", 4)) {
1637 ret
= scsiback_drop_nexus(tpg
);
1638 return (!ret
) ? count
: ret
;
1641 * Otherwise make sure the passed virtual Initiator port WWN matches
1642 * the fabric protocol_id set in scsiback_make_tport(), and call
1643 * scsiback_make_nexus().
1645 if (strlen(page
) >= VSCSI_NAMELEN
) {
1646 pr_err("Emulated NAA Sas Address: %s, exceeds max: %d\n",
1647 page
, VSCSI_NAMELEN
);
1650 snprintf(&i_port
[0], VSCSI_NAMELEN
, "%s", page
);
1652 ptr
= strstr(i_port
, "naa.");
1654 if (tport_wwn
->tport_proto_id
!= SCSI_PROTOCOL_SAS
) {
1655 pr_err("Passed SAS Initiator Port %s does not match target port protoid: %s\n",
1656 i_port
, scsiback_dump_proto_id(tport_wwn
));
1659 port_ptr
= &i_port
[0];
1662 ptr
= strstr(i_port
, "fc.");
1664 if (tport_wwn
->tport_proto_id
!= SCSI_PROTOCOL_FCP
) {
1665 pr_err("Passed FCP Initiator Port %s does not match target port protoid: %s\n",
1666 i_port
, scsiback_dump_proto_id(tport_wwn
));
1669 port_ptr
= &i_port
[3]; /* Skip over "fc." */
1672 ptr
= strstr(i_port
, "iqn.");
1674 if (tport_wwn
->tport_proto_id
!= SCSI_PROTOCOL_ISCSI
) {
1675 pr_err("Passed iSCSI Initiator Port %s does not match target port protoid: %s\n",
1676 i_port
, scsiback_dump_proto_id(tport_wwn
));
1679 port_ptr
= &i_port
[0];
1682 pr_err("Unable to locate prefix for emulated Initiator Port: %s\n",
1686 * Clear any trailing newline for the NAA WWN
1689 if (i_port
[strlen(i_port
) - 1] == '\n')
1690 i_port
[strlen(i_port
) - 1] = '\0';
1692 ret
= scsiback_make_nexus(tpg
, port_ptr
);
1699 CONFIGFS_ATTR(scsiback_tpg_
, nexus
);
1701 static struct configfs_attribute
*scsiback_tpg_attrs
[] = {
1702 &scsiback_tpg_attr_nexus
,
1707 scsiback_wwn_version_show(struct config_item
*item
, char *page
)
1709 return sprintf(page
, "xen-pvscsi fabric module %s on %s/%s on "
1711 VSCSI_VERSION
, utsname()->sysname
, utsname()->machine
);
1714 CONFIGFS_ATTR_RO(scsiback_wwn_
, version
);
1716 static struct configfs_attribute
*scsiback_wwn_attrs
[] = {
1717 &scsiback_wwn_attr_version
,
1721 static char *scsiback_get_fabric_name(void)
1723 return "xen-pvscsi";
1726 static int scsiback_port_link(struct se_portal_group
*se_tpg
,
1729 struct scsiback_tpg
*tpg
= container_of(se_tpg
,
1730 struct scsiback_tpg
, se_tpg
);
1732 mutex_lock(&tpg
->tv_tpg_mutex
);
1733 tpg
->tv_tpg_port_count
++;
1734 mutex_unlock(&tpg
->tv_tpg_mutex
);
1739 static void scsiback_port_unlink(struct se_portal_group
*se_tpg
,
1742 struct scsiback_tpg
*tpg
= container_of(se_tpg
,
1743 struct scsiback_tpg
, se_tpg
);
1745 mutex_lock(&tpg
->tv_tpg_mutex
);
1746 tpg
->tv_tpg_port_count
--;
1747 mutex_unlock(&tpg
->tv_tpg_mutex
);
1750 static struct se_portal_group
*
1751 scsiback_make_tpg(struct se_wwn
*wwn
,
1752 struct config_group
*group
,
1755 struct scsiback_tport
*tport
= container_of(wwn
,
1756 struct scsiback_tport
, tport_wwn
);
1758 struct scsiback_tpg
*tpg
;
1762 if (strstr(name
, "tpgt_") != name
)
1763 return ERR_PTR(-EINVAL
);
1764 ret
= kstrtou16(name
+ 5, 10, &tpgt
);
1766 return ERR_PTR(ret
);
1768 tpg
= kzalloc(sizeof(struct scsiback_tpg
), GFP_KERNEL
);
1770 return ERR_PTR(-ENOMEM
);
1772 mutex_init(&tpg
->tv_tpg_mutex
);
1773 INIT_LIST_HEAD(&tpg
->tv_tpg_list
);
1774 INIT_LIST_HEAD(&tpg
->info_list
);
1776 tpg
->tport_tpgt
= tpgt
;
1778 ret
= core_tpg_register(wwn
, &tpg
->se_tpg
, tport
->tport_proto_id
);
1783 mutex_lock(&scsiback_mutex
);
1784 list_add_tail(&tpg
->tv_tpg_list
, &scsiback_list
);
1785 mutex_unlock(&scsiback_mutex
);
1787 return &tpg
->se_tpg
;
1790 static void scsiback_drop_tpg(struct se_portal_group
*se_tpg
)
1792 struct scsiback_tpg
*tpg
= container_of(se_tpg
,
1793 struct scsiback_tpg
, se_tpg
);
1795 mutex_lock(&scsiback_mutex
);
1796 list_del(&tpg
->tv_tpg_list
);
1797 mutex_unlock(&scsiback_mutex
);
1799 * Release the virtual I_T Nexus for this xen-pvscsi TPG
1801 scsiback_drop_nexus(tpg
);
1803 * Deregister the se_tpg from TCM.
1805 core_tpg_deregister(se_tpg
);
1809 static int scsiback_check_true(struct se_portal_group
*se_tpg
)
1814 static int scsiback_check_false(struct se_portal_group
*se_tpg
)
1819 static const struct target_core_fabric_ops scsiback_ops
= {
1820 .module
= THIS_MODULE
,
1821 .name
= "xen-pvscsi",
1822 .get_fabric_name
= scsiback_get_fabric_name
,
1823 .tpg_get_wwn
= scsiback_get_fabric_wwn
,
1824 .tpg_get_tag
= scsiback_get_tag
,
1825 .tpg_check_demo_mode
= scsiback_check_true
,
1826 .tpg_check_demo_mode_cache
= scsiback_check_true
,
1827 .tpg_check_demo_mode_write_protect
= scsiback_check_false
,
1828 .tpg_check_prod_mode_write_protect
= scsiback_check_false
,
1829 .tpg_get_inst_index
= scsiback_tpg_get_inst_index
,
1830 .check_stop_free
= scsiback_check_stop_free
,
1831 .release_cmd
= scsiback_release_cmd
,
1832 .shutdown_session
= scsiback_shutdown_session
,
1833 .close_session
= scsiback_close_session
,
1834 .sess_get_index
= scsiback_sess_get_index
,
1835 .sess_get_initiator_sid
= NULL
,
1836 .write_pending
= scsiback_write_pending
,
1837 .write_pending_status
= scsiback_write_pending_status
,
1838 .set_default_node_attributes
= scsiback_set_default_node_attrs
,
1839 .get_cmd_state
= scsiback_get_cmd_state
,
1840 .queue_data_in
= scsiback_queue_data_in
,
1841 .queue_status
= scsiback_queue_status
,
1842 .queue_tm_rsp
= scsiback_queue_tm_rsp
,
1843 .aborted_task
= scsiback_aborted_task
,
1845 * Setup callers for generic logic in target_core_fabric_configfs.c
1847 .fabric_make_wwn
= scsiback_make_tport
,
1848 .fabric_drop_wwn
= scsiback_drop_tport
,
1849 .fabric_make_tpg
= scsiback_make_tpg
,
1850 .fabric_drop_tpg
= scsiback_drop_tpg
,
1851 .fabric_post_link
= scsiback_port_link
,
1852 .fabric_pre_unlink
= scsiback_port_unlink
,
1854 .tfc_wwn_attrs
= scsiback_wwn_attrs
,
1855 .tfc_tpg_base_attrs
= scsiback_tpg_attrs
,
1856 .tfc_tpg_param_attrs
= scsiback_param_attrs
,
1859 static const struct xenbus_device_id scsiback_ids
[] = {
1864 static struct xenbus_driver scsiback_driver
= {
1865 .ids
= scsiback_ids
,
1866 .probe
= scsiback_probe
,
1867 .remove
= scsiback_remove
,
1868 .otherend_changed
= scsiback_frontend_changed
1871 static int __init
scsiback_init(void)
1878 pr_debug("xen-pvscsi: fabric module %s on %s/%s on "UTS_RELEASE
"\n",
1879 VSCSI_VERSION
, utsname()->sysname
, utsname()->machine
);
1881 ret
= xenbus_register_backend(&scsiback_driver
);
1885 ret
= target_register_template(&scsiback_ops
);
1887 goto out_unregister_xenbus
;
1891 out_unregister_xenbus
:
1892 xenbus_unregister_driver(&scsiback_driver
);
1894 pr_err("%s: error %d\n", __func__
, ret
);
1898 static void __exit
scsiback_exit(void)
1902 while (free_pages_num
) {
1903 if (get_free_page(&page
))
1905 gnttab_free_pages(1, &page
);
1907 target_unregister_template(&scsiback_ops
);
1908 xenbus_unregister_driver(&scsiback_driver
);
1911 module_init(scsiback_init
);
1912 module_exit(scsiback_exit
);
1914 MODULE_DESCRIPTION("Xen SCSI backend driver");
1915 MODULE_LICENSE("Dual BSD/GPL");
1916 MODULE_ALIAS("xen-backend:vscsi");
1917 MODULE_AUTHOR("Juergen Gross <jgross@suse.com>");