2 * QEMU Block driver for iSCSI images
4 * Copyright (c) 2010-2011 Ronnie Sahlberg <ronniesahlberg@gmail.com>
5 * Copyright (c) 2012-2013 Peter Lieven <pl@kamp.de>
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
26 #include "config-host.h"
29 #include <arpa/inet.h>
30 #include "qemu-common.h"
31 #include "qemu/config-file.h"
32 #include "qemu/error-report.h"
33 #include "block/block_int.h"
35 #include "block/scsi.h"
37 #include "sysemu/sysemu.h"
38 #include "qmp-commands.h"
40 #include <iscsi/iscsi.h>
41 #include <iscsi/scsi-lowlevel.h>
45 #include <block/scsi.h>
48 typedef struct IscsiLun
{
49 struct iscsi_context
*iscsi
;
51 enum scsi_inquiry_peripheral_device_type type
;
58 struct scsi_inquiry_logical_block_provisioning lbp
;
59 struct scsi_inquiry_block_limits bl
;
60 unsigned char *zeroblock
;
63 typedef struct IscsiTask
{
68 struct scsi_task
*task
;
72 typedef struct IscsiAIOCB
{
73 BlockDriverAIOCB common
;
77 struct scsi_task
*task
;
89 #define NOP_INTERVAL 5000
90 #define MAX_NOP_FAILURES 3
91 #define ISCSI_CMD_RETRIES 5
98 qemu_bh_delete(acb
->bh
);
103 if (acb
->canceled
== 0) {
104 acb
->common
.cb(acb
->common
.opaque
, acb
->status
);
107 if (acb
->task
!= NULL
) {
108 scsi_free_scsi_task(acb
->task
);
112 qemu_aio_release(acb
);
116 iscsi_schedule_bh(IscsiAIOCB
*acb
)
121 acb
->bh
= qemu_bh_new(iscsi_bh_cb
, acb
);
122 qemu_bh_schedule(acb
->bh
);
126 iscsi_co_generic_cb(struct iscsi_context
*iscsi
, int status
,
127 void *command_data
, void *opaque
)
129 struct IscsiTask
*iTask
= opaque
;
130 struct scsi_task
*task
= command_data
;
133 iTask
->status
= status
;
137 if (iTask
->retries
-- > 0 && status
== SCSI_STATUS_CHECK_CONDITION
138 && task
->sense
.key
== SCSI_SENSE_UNIT_ATTENTION
) {
143 if (status
!= SCSI_STATUS_GOOD
) {
144 error_report("iSCSI: Failure. %s", iscsi_get_error(iscsi
));
149 qemu_coroutine_enter(iTask
->co
, NULL
);
153 static void iscsi_co_init_iscsitask(IscsiLun
*iscsilun
, struct IscsiTask
*iTask
)
155 *iTask
= (struct IscsiTask
) {
156 .co
= qemu_coroutine_self(),
157 .retries
= ISCSI_CMD_RETRIES
,
162 iscsi_abort_task_cb(struct iscsi_context
*iscsi
, int status
, void *command_data
,
165 IscsiAIOCB
*acb
= private_data
;
167 acb
->status
= -ECANCELED
;
168 iscsi_schedule_bh(acb
);
172 iscsi_aio_cancel(BlockDriverAIOCB
*blockacb
)
174 IscsiAIOCB
*acb
= (IscsiAIOCB
*)blockacb
;
175 IscsiLun
*iscsilun
= acb
->iscsilun
;
177 if (acb
->status
!= -EINPROGRESS
) {
183 /* send a task mgmt call to the target to cancel the task on the target */
184 iscsi_task_mgmt_abort_task_async(iscsilun
->iscsi
, acb
->task
,
185 iscsi_abort_task_cb
, acb
);
187 while (acb
->status
== -EINPROGRESS
) {
192 static const AIOCBInfo iscsi_aiocb_info
= {
193 .aiocb_size
= sizeof(IscsiAIOCB
),
194 .cancel
= iscsi_aio_cancel
,
198 static void iscsi_process_read(void *arg
);
199 static void iscsi_process_write(void *arg
);
202 iscsi_set_events(IscsiLun
*iscsilun
)
204 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
207 /* We always register a read handler. */
209 ev
|= iscsi_which_events(iscsi
);
210 if (ev
!= iscsilun
->events
) {
211 qemu_aio_set_fd_handler(iscsi_get_fd(iscsi
),
213 (ev
& POLLOUT
) ? iscsi_process_write
: NULL
,
218 iscsilun
->events
= ev
;
222 iscsi_process_read(void *arg
)
224 IscsiLun
*iscsilun
= arg
;
225 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
227 iscsi_service(iscsi
, POLLIN
);
228 iscsi_set_events(iscsilun
);
232 iscsi_process_write(void *arg
)
234 IscsiLun
*iscsilun
= arg
;
235 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
237 iscsi_service(iscsi
, POLLOUT
);
238 iscsi_set_events(iscsilun
);
242 iscsi_aio_writev_acb(IscsiAIOCB
*acb
);
245 iscsi_aio_write16_cb(struct iscsi_context
*iscsi
, int status
,
246 void *command_data
, void *opaque
)
248 IscsiAIOCB
*acb
= opaque
;
250 trace_iscsi_aio_write16_cb(iscsi
, status
, acb
, acb
->canceled
);
255 if (acb
->canceled
!= 0) {
261 if (status
== SCSI_STATUS_CHECK_CONDITION
262 && acb
->task
->sense
.key
== SCSI_SENSE_UNIT_ATTENTION
263 && acb
->retries
-- > 0) {
264 scsi_free_scsi_task(acb
->task
);
266 if (iscsi_aio_writev_acb(acb
) == 0) {
267 iscsi_set_events(acb
->iscsilun
);
271 error_report("Failed to write16 data to iSCSI lun. %s",
272 iscsi_get_error(iscsi
));
276 iscsi_schedule_bh(acb
);
279 static int64_t sector_lun2qemu(int64_t sector
, IscsiLun
*iscsilun
)
281 return sector
* iscsilun
->block_size
/ BDRV_SECTOR_SIZE
;
284 static int64_t sector_qemu2lun(int64_t sector
, IscsiLun
*iscsilun
)
286 return sector
* BDRV_SECTOR_SIZE
/ iscsilun
->block_size
;
289 static bool is_request_lun_aligned(int64_t sector_num
, int nb_sectors
,
292 if ((sector_num
* BDRV_SECTOR_SIZE
) % iscsilun
->block_size
||
293 (nb_sectors
* BDRV_SECTOR_SIZE
) % iscsilun
->block_size
) {
294 error_report("iSCSI misaligned request: "
295 "iscsilun->block_size %u, sector_num %" PRIi64
297 iscsilun
->block_size
, sector_num
, nb_sectors
);
304 iscsi_aio_writev_acb(IscsiAIOCB
*acb
)
306 struct iscsi_context
*iscsi
= acb
->iscsilun
->iscsi
;
308 uint32_t num_sectors
;
310 #if !defined(LIBISCSI_FEATURE_IOVECTOR)
311 struct iscsi_data data
;
317 acb
->status
= -EINPROGRESS
;
320 /* this will allow us to get rid of 'buf' completely */
321 size
= acb
->nb_sectors
* BDRV_SECTOR_SIZE
;
323 #if !defined(LIBISCSI_FEATURE_IOVECTOR)
324 data
.size
= MIN(size
, acb
->qiov
->size
);
326 /* if the iovec only contains one buffer we can pass it directly */
327 if (acb
->qiov
->niov
== 1) {
328 data
.data
= acb
->qiov
->iov
[0].iov_base
;
330 acb
->buf
= g_malloc(data
.size
);
331 qemu_iovec_to_buf(acb
->qiov
, 0, acb
->buf
, data
.size
);
332 data
.data
= acb
->buf
;
336 acb
->task
= malloc(sizeof(struct scsi_task
));
337 if (acb
->task
== NULL
) {
338 error_report("iSCSI: Failed to allocate task for scsi WRITE16 "
339 "command. %s", iscsi_get_error(iscsi
));
342 memset(acb
->task
, 0, sizeof(struct scsi_task
));
344 acb
->task
->xfer_dir
= SCSI_XFER_WRITE
;
345 acb
->task
->cdb_size
= 16;
346 acb
->task
->cdb
[0] = 0x8a;
347 lba
= sector_qemu2lun(acb
->sector_num
, acb
->iscsilun
);
348 *(uint32_t *)&acb
->task
->cdb
[2] = htonl(lba
>> 32);
349 *(uint32_t *)&acb
->task
->cdb
[6] = htonl(lba
& 0xffffffff);
350 num_sectors
= sector_qemu2lun(acb
->nb_sectors
, acb
->iscsilun
);
351 *(uint32_t *)&acb
->task
->cdb
[10] = htonl(num_sectors
);
352 acb
->task
->expxferlen
= size
;
354 #if defined(LIBISCSI_FEATURE_IOVECTOR)
355 ret
= iscsi_scsi_command_async(iscsi
, acb
->iscsilun
->lun
, acb
->task
,
356 iscsi_aio_write16_cb
,
360 ret
= iscsi_scsi_command_async(iscsi
, acb
->iscsilun
->lun
, acb
->task
,
361 iscsi_aio_write16_cb
,
366 scsi_free_scsi_task(acb
->task
);
371 #if defined(LIBISCSI_FEATURE_IOVECTOR)
372 scsi_task_set_iov_out(acb
->task
, (struct scsi_iovec
*) acb
->qiov
->iov
, acb
->qiov
->niov
);
378 static BlockDriverAIOCB
*
379 iscsi_aio_writev(BlockDriverState
*bs
, int64_t sector_num
,
380 QEMUIOVector
*qiov
, int nb_sectors
,
381 BlockDriverCompletionFunc
*cb
,
384 IscsiLun
*iscsilun
= bs
->opaque
;
387 if (!is_request_lun_aligned(sector_num
, nb_sectors
, iscsilun
)) {
391 acb
= qemu_aio_get(&iscsi_aiocb_info
, bs
, cb
, opaque
);
392 trace_iscsi_aio_writev(iscsilun
->iscsi
, sector_num
, nb_sectors
, opaque
, acb
);
394 acb
->iscsilun
= iscsilun
;
396 acb
->nb_sectors
= nb_sectors
;
397 acb
->sector_num
= sector_num
;
398 acb
->retries
= ISCSI_CMD_RETRIES
;
400 if (iscsi_aio_writev_acb(acb
) != 0) {
401 qemu_aio_release(acb
);
405 iscsi_set_events(iscsilun
);
410 iscsi_aio_readv_acb(IscsiAIOCB
*acb
);
413 iscsi_aio_read16_cb(struct iscsi_context
*iscsi
, int status
,
414 void *command_data
, void *opaque
)
416 IscsiAIOCB
*acb
= opaque
;
418 trace_iscsi_aio_read16_cb(iscsi
, status
, acb
, acb
->canceled
);
420 if (acb
->canceled
!= 0) {
426 if (status
== SCSI_STATUS_CHECK_CONDITION
427 && acb
->task
->sense
.key
== SCSI_SENSE_UNIT_ATTENTION
428 && acb
->retries
-- > 0) {
429 scsi_free_scsi_task(acb
->task
);
431 if (iscsi_aio_readv_acb(acb
) == 0) {
432 iscsi_set_events(acb
->iscsilun
);
436 error_report("Failed to read16 data from iSCSI lun. %s",
437 iscsi_get_error(iscsi
));
441 iscsi_schedule_bh(acb
);
445 iscsi_aio_readv_acb(IscsiAIOCB
*acb
)
447 struct iscsi_context
*iscsi
= acb
->iscsilun
->iscsi
;
450 uint32_t num_sectors
;
452 #if !defined(LIBISCSI_FEATURE_IOVECTOR)
458 acb
->status
= -EINPROGRESS
;
461 size
= acb
->nb_sectors
* BDRV_SECTOR_SIZE
;
463 acb
->task
= malloc(sizeof(struct scsi_task
));
464 if (acb
->task
== NULL
) {
465 error_report("iSCSI: Failed to allocate task for scsi READ16 "
466 "command. %s", iscsi_get_error(iscsi
));
469 memset(acb
->task
, 0, sizeof(struct scsi_task
));
471 acb
->task
->xfer_dir
= SCSI_XFER_READ
;
472 acb
->task
->expxferlen
= size
;
473 lba
= sector_qemu2lun(acb
->sector_num
, acb
->iscsilun
);
474 num_sectors
= sector_qemu2lun(acb
->nb_sectors
, acb
->iscsilun
);
476 switch (acb
->iscsilun
->type
) {
478 acb
->task
->cdb_size
= 16;
479 acb
->task
->cdb
[0] = 0x88;
480 *(uint32_t *)&acb
->task
->cdb
[2] = htonl(lba
>> 32);
481 *(uint32_t *)&acb
->task
->cdb
[6] = htonl(lba
& 0xffffffff);
482 *(uint32_t *)&acb
->task
->cdb
[10] = htonl(num_sectors
);
485 acb
->task
->cdb_size
= 10;
486 acb
->task
->cdb
[0] = 0x28;
487 *(uint32_t *)&acb
->task
->cdb
[2] = htonl(lba
);
488 *(uint16_t *)&acb
->task
->cdb
[7] = htons(num_sectors
);
492 ret
= iscsi_scsi_command_async(iscsi
, acb
->iscsilun
->lun
, acb
->task
,
497 scsi_free_scsi_task(acb
->task
);
501 #if defined(LIBISCSI_FEATURE_IOVECTOR)
502 scsi_task_set_iov_in(acb
->task
, (struct scsi_iovec
*) acb
->qiov
->iov
, acb
->qiov
->niov
);
504 for (i
= 0; i
< acb
->qiov
->niov
; i
++) {
505 scsi_task_add_data_in_buffer(acb
->task
,
506 acb
->qiov
->iov
[i
].iov_len
,
507 acb
->qiov
->iov
[i
].iov_base
);
513 static BlockDriverAIOCB
*
514 iscsi_aio_readv(BlockDriverState
*bs
, int64_t sector_num
,
515 QEMUIOVector
*qiov
, int nb_sectors
,
516 BlockDriverCompletionFunc
*cb
,
519 IscsiLun
*iscsilun
= bs
->opaque
;
522 if (!is_request_lun_aligned(sector_num
, nb_sectors
, iscsilun
)) {
526 acb
= qemu_aio_get(&iscsi_aiocb_info
, bs
, cb
, opaque
);
527 trace_iscsi_aio_readv(iscsilun
->iscsi
, sector_num
, nb_sectors
, opaque
, acb
);
529 acb
->nb_sectors
= nb_sectors
;
530 acb
->sector_num
= sector_num
;
531 acb
->iscsilun
= iscsilun
;
533 acb
->retries
= ISCSI_CMD_RETRIES
;
535 if (iscsi_aio_readv_acb(acb
) != 0) {
536 qemu_aio_release(acb
);
540 iscsi_set_events(iscsilun
);
545 iscsi_aio_flush_acb(IscsiAIOCB
*acb
);
548 iscsi_synccache10_cb(struct iscsi_context
*iscsi
, int status
,
549 void *command_data
, void *opaque
)
551 IscsiAIOCB
*acb
= opaque
;
553 if (acb
->canceled
!= 0) {
559 if (status
== SCSI_STATUS_CHECK_CONDITION
560 && acb
->task
->sense
.key
== SCSI_SENSE_UNIT_ATTENTION
561 && acb
->retries
-- > 0) {
562 scsi_free_scsi_task(acb
->task
);
564 if (iscsi_aio_flush_acb(acb
) == 0) {
565 iscsi_set_events(acb
->iscsilun
);
569 error_report("Failed to sync10 data on iSCSI lun. %s",
570 iscsi_get_error(iscsi
));
574 iscsi_schedule_bh(acb
);
578 iscsi_aio_flush_acb(IscsiAIOCB
*acb
)
580 struct iscsi_context
*iscsi
= acb
->iscsilun
->iscsi
;
584 acb
->status
= -EINPROGRESS
;
587 acb
->task
= iscsi_synchronizecache10_task(iscsi
, acb
->iscsilun
->lun
,
589 iscsi_synccache10_cb
,
591 if (acb
->task
== NULL
) {
592 error_report("iSCSI: Failed to send synchronizecache10 command. %s",
593 iscsi_get_error(iscsi
));
600 static BlockDriverAIOCB
*
601 iscsi_aio_flush(BlockDriverState
*bs
,
602 BlockDriverCompletionFunc
*cb
, void *opaque
)
604 IscsiLun
*iscsilun
= bs
->opaque
;
608 acb
= qemu_aio_get(&iscsi_aiocb_info
, bs
, cb
, opaque
);
610 acb
->iscsilun
= iscsilun
;
611 acb
->retries
= ISCSI_CMD_RETRIES
;
613 if (iscsi_aio_flush_acb(acb
) != 0) {
614 qemu_aio_release(acb
);
618 iscsi_set_events(iscsilun
);
625 iscsi_aio_ioctl_cb(struct iscsi_context
*iscsi
, int status
,
626 void *command_data
, void *opaque
)
628 IscsiAIOCB
*acb
= opaque
;
633 if (acb
->canceled
!= 0) {
639 error_report("Failed to ioctl(SG_IO) to iSCSI lun. %s",
640 iscsi_get_error(iscsi
));
644 acb
->ioh
->driver_status
= 0;
645 acb
->ioh
->host_status
= 0;
648 #define SG_ERR_DRIVER_SENSE 0x08
650 if (status
== SCSI_STATUS_CHECK_CONDITION
&& acb
->task
->datain
.size
>= 2) {
653 acb
->ioh
->driver_status
|= SG_ERR_DRIVER_SENSE
;
655 acb
->ioh
->sb_len_wr
= acb
->task
->datain
.size
- 2;
656 ss
= (acb
->ioh
->mx_sb_len
>= acb
->ioh
->sb_len_wr
) ?
657 acb
->ioh
->mx_sb_len
: acb
->ioh
->sb_len_wr
;
658 memcpy(acb
->ioh
->sbp
, &acb
->task
->datain
.data
[2], ss
);
661 iscsi_schedule_bh(acb
);
664 static BlockDriverAIOCB
*iscsi_aio_ioctl(BlockDriverState
*bs
,
665 unsigned long int req
, void *buf
,
666 BlockDriverCompletionFunc
*cb
, void *opaque
)
668 IscsiLun
*iscsilun
= bs
->opaque
;
669 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
670 struct iscsi_data data
;
673 assert(req
== SG_IO
);
675 acb
= qemu_aio_get(&iscsi_aiocb_info
, bs
, cb
, opaque
);
677 acb
->iscsilun
= iscsilun
;
680 acb
->status
= -EINPROGRESS
;
684 acb
->task
= malloc(sizeof(struct scsi_task
));
685 if (acb
->task
== NULL
) {
686 error_report("iSCSI: Failed to allocate task for scsi command. %s",
687 iscsi_get_error(iscsi
));
688 qemu_aio_release(acb
);
691 memset(acb
->task
, 0, sizeof(struct scsi_task
));
693 switch (acb
->ioh
->dxfer_direction
) {
694 case SG_DXFER_TO_DEV
:
695 acb
->task
->xfer_dir
= SCSI_XFER_WRITE
;
697 case SG_DXFER_FROM_DEV
:
698 acb
->task
->xfer_dir
= SCSI_XFER_READ
;
701 acb
->task
->xfer_dir
= SCSI_XFER_NONE
;
705 acb
->task
->cdb_size
= acb
->ioh
->cmd_len
;
706 memcpy(&acb
->task
->cdb
[0], acb
->ioh
->cmdp
, acb
->ioh
->cmd_len
);
707 acb
->task
->expxferlen
= acb
->ioh
->dxfer_len
;
710 if (acb
->task
->xfer_dir
== SCSI_XFER_WRITE
) {
711 if (acb
->ioh
->iovec_count
== 0) {
712 data
.data
= acb
->ioh
->dxferp
;
713 data
.size
= acb
->ioh
->dxfer_len
;
715 #if defined(LIBISCSI_FEATURE_IOVECTOR)
716 scsi_task_set_iov_out(acb
->task
,
717 (struct scsi_iovec
*) acb
->ioh
->dxferp
,
718 acb
->ioh
->iovec_count
);
720 struct iovec
*iov
= (struct iovec
*)acb
->ioh
->dxferp
;
722 acb
->buf
= g_malloc(acb
->ioh
->dxfer_len
);
723 data
.data
= acb
->buf
;
724 data
.size
= iov_to_buf(iov
, acb
->ioh
->iovec_count
, 0,
725 acb
->buf
, acb
->ioh
->dxfer_len
);
730 if (iscsi_scsi_command_async(iscsi
, iscsilun
->lun
, acb
->task
,
732 (data
.size
> 0) ? &data
: NULL
,
734 scsi_free_scsi_task(acb
->task
);
735 qemu_aio_release(acb
);
739 /* tell libiscsi to read straight into the buffer we got from ioctl */
740 if (acb
->task
->xfer_dir
== SCSI_XFER_READ
) {
741 if (acb
->ioh
->iovec_count
== 0) {
742 scsi_task_add_data_in_buffer(acb
->task
,
746 #if defined(LIBISCSI_FEATURE_IOVECTOR)
747 scsi_task_set_iov_in(acb
->task
,
748 (struct scsi_iovec
*) acb
->ioh
->dxferp
,
749 acb
->ioh
->iovec_count
);
752 for (i
= 0; i
< acb
->ioh
->iovec_count
; i
++) {
753 struct iovec
*iov
= (struct iovec
*)acb
->ioh
->dxferp
;
755 scsi_task_add_data_in_buffer(acb
->task
,
763 iscsi_set_events(iscsilun
);
769 static void ioctl_cb(void *opaque
, int status
)
771 int *p_status
= opaque
;
775 static int iscsi_ioctl(BlockDriverState
*bs
, unsigned long int req
, void *buf
)
777 IscsiLun
*iscsilun
= bs
->opaque
;
781 case SG_GET_VERSION_NUM
:
785 ((struct sg_scsi_id
*)buf
)->scsi_type
= iscsilun
->type
;
788 status
= -EINPROGRESS
;
789 iscsi_aio_ioctl(bs
, req
, buf
, ioctl_cb
, &status
);
791 while (status
== -EINPROGRESS
) {
804 iscsi_getlength(BlockDriverState
*bs
)
806 IscsiLun
*iscsilun
= bs
->opaque
;
809 len
= iscsilun
->num_blocks
;
810 len
*= iscsilun
->block_size
;
815 #if defined(LIBISCSI_FEATURE_IOVECTOR)
817 static int64_t coroutine_fn
iscsi_co_get_block_status(BlockDriverState
*bs
,
819 int nb_sectors
, int *pnum
)
821 IscsiLun
*iscsilun
= bs
->opaque
;
822 struct scsi_get_lba_status
*lbas
= NULL
;
823 struct scsi_lba_status_descriptor
*lbasd
= NULL
;
824 struct IscsiTask iTask
;
827 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
829 if (!is_request_lun_aligned(sector_num
, nb_sectors
, iscsilun
)) {
834 /* default to all sectors allocated */
835 ret
= BDRV_BLOCK_DATA
;
836 ret
|= (sector_num
<< BDRV_SECTOR_BITS
) | BDRV_BLOCK_OFFSET_VALID
;
839 /* LUN does not support logical block provisioning */
840 if (iscsilun
->lbpme
== 0) {
845 if (iscsi_get_lba_status_task(iscsilun
->iscsi
, iscsilun
->lun
,
846 sector_qemu2lun(sector_num
, iscsilun
),
847 8 + 16, iscsi_co_generic_cb
,
853 while (!iTask
.complete
) {
854 iscsi_set_events(iscsilun
);
855 qemu_coroutine_yield();
858 if (iTask
.do_retry
) {
859 if (iTask
.task
!= NULL
) {
860 scsi_free_scsi_task(iTask
.task
);
866 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
867 /* in case the get_lba_status_callout fails (i.e.
868 * because the device is busy or the cmd is not
869 * supported) we pretend all blocks are allocated
870 * for backwards compatibility */
874 lbas
= scsi_datain_unmarshall(iTask
.task
);
880 lbasd
= &lbas
->descriptors
[0];
882 if (sector_qemu2lun(sector_num
, iscsilun
) != lbasd
->lba
) {
887 *pnum
= sector_lun2qemu(lbasd
->num_blocks
, iscsilun
);
888 if (*pnum
> nb_sectors
) {
892 if (lbasd
->provisioning
== SCSI_PROVISIONING_TYPE_DEALLOCATED
||
893 lbasd
->provisioning
== SCSI_PROVISIONING_TYPE_ANCHORED
) {
894 ret
&= ~BDRV_BLOCK_DATA
;
895 if (iscsilun
->lbprz
) {
896 ret
|= BDRV_BLOCK_ZERO
;
901 if (iTask
.task
!= NULL
) {
902 scsi_free_scsi_task(iTask
.task
);
907 #endif /* LIBISCSI_FEATURE_IOVECTOR */
910 coroutine_fn
iscsi_co_discard(BlockDriverState
*bs
, int64_t sector_num
,
913 IscsiLun
*iscsilun
= bs
->opaque
;
914 struct IscsiTask iTask
;
915 struct unmap_list list
;
917 if (!is_request_lun_aligned(sector_num
, nb_sectors
, iscsilun
)) {
921 if (!iscsilun
->lbp
.lbpu
) {
922 /* UNMAP is not supported by the target */
926 list
.lba
= sector_qemu2lun(sector_num
, iscsilun
);
927 list
.num
= sector_qemu2lun(nb_sectors
, iscsilun
);
929 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
931 if (iscsi_unmap_task(iscsilun
->iscsi
, iscsilun
->lun
, 0, 0, &list
, 1,
932 iscsi_co_generic_cb
, &iTask
) == NULL
) {
936 while (!iTask
.complete
) {
937 iscsi_set_events(iscsilun
);
938 qemu_coroutine_yield();
941 if (iTask
.task
!= NULL
) {
942 scsi_free_scsi_task(iTask
.task
);
946 if (iTask
.do_retry
) {
950 if (iTask
.status
== SCSI_STATUS_CHECK_CONDITION
) {
951 /* the target might fail with a check condition if it
952 is not happy with the alignment of the UNMAP request
953 we silently fail in this case */
957 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
964 #if defined(SCSI_SENSE_ASCQ_CAPACITY_DATA_HAS_CHANGED)
967 coroutine_fn
iscsi_co_write_zeroes(BlockDriverState
*bs
, int64_t sector_num
,
968 int nb_sectors
, BdrvRequestFlags flags
)
970 IscsiLun
*iscsilun
= bs
->opaque
;
971 struct IscsiTask iTask
;
975 if (!is_request_lun_aligned(sector_num
, nb_sectors
, iscsilun
)) {
979 if (!iscsilun
->lbp
.lbpws
) {
980 /* WRITE SAME is not supported by the target */
984 lba
= sector_qemu2lun(sector_num
, iscsilun
);
985 nb_blocks
= sector_qemu2lun(nb_sectors
, iscsilun
);
987 if (iscsilun
->zeroblock
== NULL
) {
988 iscsilun
->zeroblock
= g_malloc0(iscsilun
->block_size
);
991 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
993 if (iscsi_writesame16_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
994 iscsilun
->zeroblock
, iscsilun
->block_size
,
995 nb_blocks
, 0, !!(flags
& BDRV_REQ_MAY_UNMAP
),
996 0, 0, iscsi_co_generic_cb
, &iTask
) == NULL
) {
1000 while (!iTask
.complete
) {
1001 iscsi_set_events(iscsilun
);
1002 qemu_coroutine_yield();
1005 if (iTask
.task
!= NULL
) {
1006 scsi_free_scsi_task(iTask
.task
);
1010 if (iTask
.do_retry
) {
1014 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
1021 #endif /* SCSI_SENSE_ASCQ_CAPACITY_DATA_HAS_CHANGED */
1023 static int parse_chap(struct iscsi_context
*iscsi
, const char *target
)
1027 const char *user
= NULL
;
1028 const char *password
= NULL
;
1030 list
= qemu_find_opts("iscsi");
1035 opts
= qemu_opts_find(list
, target
);
1037 opts
= QTAILQ_FIRST(&list
->head
);
1043 user
= qemu_opt_get(opts
, "user");
1048 password
= qemu_opt_get(opts
, "password");
1050 error_report("CHAP username specified but no password was given");
1054 if (iscsi_set_initiator_username_pwd(iscsi
, user
, password
)) {
1055 error_report("Failed to set initiator username and password");
1062 static void parse_header_digest(struct iscsi_context
*iscsi
, const char *target
)
1066 const char *digest
= NULL
;
1068 list
= qemu_find_opts("iscsi");
1073 opts
= qemu_opts_find(list
, target
);
1075 opts
= QTAILQ_FIRST(&list
->head
);
1081 digest
= qemu_opt_get(opts
, "header-digest");
1086 if (!strcmp(digest
, "CRC32C")) {
1087 iscsi_set_header_digest(iscsi
, ISCSI_HEADER_DIGEST_CRC32C
);
1088 } else if (!strcmp(digest
, "NONE")) {
1089 iscsi_set_header_digest(iscsi
, ISCSI_HEADER_DIGEST_NONE
);
1090 } else if (!strcmp(digest
, "CRC32C-NONE")) {
1091 iscsi_set_header_digest(iscsi
, ISCSI_HEADER_DIGEST_CRC32C_NONE
);
1092 } else if (!strcmp(digest
, "NONE-CRC32C")) {
1093 iscsi_set_header_digest(iscsi
, ISCSI_HEADER_DIGEST_NONE_CRC32C
);
1095 error_report("Invalid header-digest setting : %s", digest
);
1099 static char *parse_initiator_name(const char *target
)
1105 UuidInfo
*uuid_info
;
1107 list
= qemu_find_opts("iscsi");
1109 opts
= qemu_opts_find(list
, target
);
1111 opts
= QTAILQ_FIRST(&list
->head
);
1114 name
= qemu_opt_get(opts
, "initiator-name");
1116 return g_strdup(name
);
1121 uuid_info
= qmp_query_uuid(NULL
);
1122 if (strcmp(uuid_info
->UUID
, UUID_NONE
) == 0) {
1123 name
= qemu_get_vm_name();
1125 name
= uuid_info
->UUID
;
1127 iscsi_name
= g_strdup_printf("iqn.2008-11.org.linux-kvm%s%s",
1128 name
? ":" : "", name
? name
: "");
1129 qapi_free_UuidInfo(uuid_info
);
1133 #if defined(LIBISCSI_FEATURE_NOP_COUNTER)
1134 static void iscsi_nop_timed_event(void *opaque
)
1136 IscsiLun
*iscsilun
= opaque
;
1138 if (iscsi_get_nops_in_flight(iscsilun
->iscsi
) > MAX_NOP_FAILURES
) {
1139 error_report("iSCSI: NOP timeout. Reconnecting...");
1140 iscsi_reconnect(iscsilun
->iscsi
);
1143 if (iscsi_nop_out_async(iscsilun
->iscsi
, NULL
, NULL
, 0, NULL
) != 0) {
1144 error_report("iSCSI: failed to sent NOP-Out. Disabling NOP messages.");
1148 timer_mod(iscsilun
->nop_timer
, qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) + NOP_INTERVAL
);
1149 iscsi_set_events(iscsilun
);
1153 static int iscsi_readcapacity_sync(IscsiLun
*iscsilun
)
1155 struct scsi_task
*task
= NULL
;
1156 struct scsi_readcapacity10
*rc10
= NULL
;
1157 struct scsi_readcapacity16
*rc16
= NULL
;
1159 int retries
= ISCSI_CMD_RETRIES
;
1163 scsi_free_scsi_task(task
);
1167 switch (iscsilun
->type
) {
1169 task
= iscsi_readcapacity16_sync(iscsilun
->iscsi
, iscsilun
->lun
);
1170 if (task
!= NULL
&& task
->status
== SCSI_STATUS_GOOD
) {
1171 rc16
= scsi_datain_unmarshall(task
);
1173 error_report("iSCSI: Failed to unmarshall readcapacity16 data.");
1176 iscsilun
->block_size
= rc16
->block_length
;
1177 iscsilun
->num_blocks
= rc16
->returned_lba
+ 1;
1178 iscsilun
->lbpme
= rc16
->lbpme
;
1179 iscsilun
->lbprz
= rc16
->lbprz
;
1184 task
= iscsi_readcapacity10_sync(iscsilun
->iscsi
, iscsilun
->lun
, 0, 0);
1185 if (task
!= NULL
&& task
->status
== SCSI_STATUS_GOOD
) {
1186 rc10
= scsi_datain_unmarshall(task
);
1188 error_report("iSCSI: Failed to unmarshall readcapacity10 data.");
1191 iscsilun
->block_size
= rc10
->block_size
;
1192 if (rc10
->lba
== 0) {
1193 /* blank disk loaded */
1194 iscsilun
->num_blocks
= 0;
1196 iscsilun
->num_blocks
= rc10
->lba
+ 1;
1204 } while (task
!= NULL
&& task
->status
== SCSI_STATUS_CHECK_CONDITION
1205 && task
->sense
.key
== SCSI_SENSE_UNIT_ATTENTION
1208 if (task
== NULL
|| task
->status
!= SCSI_STATUS_GOOD
) {
1209 error_report("iSCSI: failed to send readcapacity10 command.");
1213 scsi_free_scsi_task(task
);
1218 /* TODO Convert to fine grained options */
1219 static QemuOptsList runtime_opts
= {
1221 .head
= QTAILQ_HEAD_INITIALIZER(runtime_opts
.head
),
1225 .type
= QEMU_OPT_STRING
,
1226 .help
= "URL to the iscsi image",
1228 { /* end of list */ }
1232 static struct scsi_task
*iscsi_do_inquiry(struct iscsi_context
*iscsi
,
1233 int lun
, int evpd
, int pc
) {
1235 struct scsi_task
*task
= NULL
;
1236 task
= iscsi_inquiry_sync(iscsi
, lun
, evpd
, pc
, 64);
1237 if (task
== NULL
|| task
->status
!= SCSI_STATUS_GOOD
) {
1240 full_size
= scsi_datain_getfullsize(task
);
1241 if (full_size
> task
->datain
.size
) {
1242 scsi_free_scsi_task(task
);
1244 /* we need more data for the full list */
1245 task
= iscsi_inquiry_sync(iscsi
, lun
, evpd
, pc
, full_size
);
1246 if (task
== NULL
|| task
->status
!= SCSI_STATUS_GOOD
) {
1254 error_report("iSCSI: Inquiry command failed : %s",
1255 iscsi_get_error(iscsi
));
1257 scsi_free_scsi_task(task
);
1264 * We support iscsi url's on the form
1265 * iscsi://[<username>%<password>@]<host>[:<port>]/<targetname>/<lun>
1267 static int iscsi_open(BlockDriverState
*bs
, QDict
*options
, int flags
,
1270 IscsiLun
*iscsilun
= bs
->opaque
;
1271 struct iscsi_context
*iscsi
= NULL
;
1272 struct iscsi_url
*iscsi_url
= NULL
;
1273 struct scsi_task
*task
= NULL
;
1274 struct scsi_inquiry_standard
*inq
= NULL
;
1275 char *initiator_name
= NULL
;
1277 Error
*local_err
= NULL
;
1278 const char *filename
;
1281 if ((BDRV_SECTOR_SIZE
% 512) != 0) {
1282 error_report("iSCSI: Invalid BDRV_SECTOR_SIZE. "
1283 "BDRV_SECTOR_SIZE(%lld) is not a multiple "
1284 "of 512", BDRV_SECTOR_SIZE
);
1288 opts
= qemu_opts_create_nofail(&runtime_opts
);
1289 qemu_opts_absorb_qdict(opts
, options
, &local_err
);
1290 if (error_is_set(&local_err
)) {
1291 qerror_report_err(local_err
);
1292 error_free(local_err
);
1297 filename
= qemu_opt_get(opts
, "filename");
1300 iscsi_url
= iscsi_parse_full_url(iscsi
, filename
);
1301 if (iscsi_url
== NULL
) {
1302 error_report("Failed to parse URL : %s", filename
);
1307 memset(iscsilun
, 0, sizeof(IscsiLun
));
1309 initiator_name
= parse_initiator_name(iscsi_url
->target
);
1311 iscsi
= iscsi_create_context(initiator_name
);
1312 if (iscsi
== NULL
) {
1313 error_report("iSCSI: Failed to create iSCSI context.");
1318 if (iscsi_set_targetname(iscsi
, iscsi_url
->target
)) {
1319 error_report("iSCSI: Failed to set target name.");
1324 if (iscsi_url
->user
!= NULL
) {
1325 ret
= iscsi_set_initiator_username_pwd(iscsi
, iscsi_url
->user
,
1328 error_report("Failed to set initiator username and password");
1334 /* check if we got CHAP username/password via the options */
1335 if (parse_chap(iscsi
, iscsi_url
->target
) != 0) {
1336 error_report("iSCSI: Failed to set CHAP user/password");
1341 if (iscsi_set_session_type(iscsi
, ISCSI_SESSION_NORMAL
) != 0) {
1342 error_report("iSCSI: Failed to set session type to normal.");
1347 iscsi_set_header_digest(iscsi
, ISCSI_HEADER_DIGEST_NONE_CRC32C
);
1349 /* check if we got HEADER_DIGEST via the options */
1350 parse_header_digest(iscsi
, iscsi_url
->target
);
1352 if (iscsi_full_connect_sync(iscsi
, iscsi_url
->portal
, iscsi_url
->lun
) != 0) {
1353 error_report("iSCSI: Failed to connect to LUN : %s",
1354 iscsi_get_error(iscsi
));
1359 iscsilun
->iscsi
= iscsi
;
1360 iscsilun
->lun
= iscsi_url
->lun
;
1362 task
= iscsi_inquiry_sync(iscsi
, iscsilun
->lun
, 0, 0, 36);
1364 if (task
== NULL
|| task
->status
!= SCSI_STATUS_GOOD
) {
1365 error_report("iSCSI: failed to send inquiry command.");
1370 inq
= scsi_datain_unmarshall(task
);
1372 error_report("iSCSI: Failed to unmarshall inquiry data.");
1377 iscsilun
->type
= inq
->periperal_device_type
;
1379 if ((ret
= iscsi_readcapacity_sync(iscsilun
)) != 0) {
1382 bs
->total_sectors
= sector_lun2qemu(iscsilun
->num_blocks
, iscsilun
);
1384 /* Medium changer or tape. We dont have any emulation for this so this must
1385 * be sg ioctl compatible. We force it to be sg, otherwise qemu will try
1386 * to read from the device to guess the image format.
1388 if (iscsilun
->type
== TYPE_MEDIUM_CHANGER
||
1389 iscsilun
->type
== TYPE_TAPE
) {
1393 if (iscsilun
->lbpme
) {
1394 struct scsi_inquiry_logical_block_provisioning
*inq_lbp
;
1395 task
= iscsi_do_inquiry(iscsilun
->iscsi
, iscsilun
->lun
, 1,
1396 SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING
);
1401 inq_lbp
= scsi_datain_unmarshall(task
);
1402 if (inq_lbp
== NULL
) {
1403 error_report("iSCSI: failed to unmarshall inquiry datain blob");
1407 memcpy(&iscsilun
->lbp
, inq_lbp
,
1408 sizeof(struct scsi_inquiry_logical_block_provisioning
));
1409 scsi_free_scsi_task(task
);
1413 if (iscsilun
->lbp
.lbpu
|| iscsilun
->lbp
.lbpws
) {
1414 struct scsi_inquiry_block_limits
*inq_bl
;
1415 task
= iscsi_do_inquiry(iscsilun
->iscsi
, iscsilun
->lun
, 1,
1416 SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS
);
1421 inq_bl
= scsi_datain_unmarshall(task
);
1422 if (inq_bl
== NULL
) {
1423 error_report("iSCSI: failed to unmarshall inquiry datain blob");
1427 memcpy(&iscsilun
->bl
, inq_bl
,
1428 sizeof(struct scsi_inquiry_block_limits
));
1429 scsi_free_scsi_task(task
);
1432 if (iscsilun
->bl
.max_unmap
< 0xffffffff) {
1433 bs
->bl
.max_discard
= sector_lun2qemu(iscsilun
->bl
.max_unmap
,
1436 bs
->bl
.discard_alignment
= sector_lun2qemu(iscsilun
->bl
.opt_unmap_gran
,
1439 if (iscsilun
->bl
.max_ws_len
< 0xffffffff) {
1440 bs
->bl
.max_write_zeroes
= sector_lun2qemu(iscsilun
->bl
.max_ws_len
,
1443 bs
->bl
.write_zeroes_alignment
= sector_lun2qemu(iscsilun
->bl
.opt_unmap_gran
,
1447 #if defined(LIBISCSI_FEATURE_NOP_COUNTER)
1448 /* Set up a timer for sending out iSCSI NOPs */
1449 iscsilun
->nop_timer
= timer_new_ms(QEMU_CLOCK_REALTIME
, iscsi_nop_timed_event
, iscsilun
);
1450 timer_mod(iscsilun
->nop_timer
, qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) + NOP_INTERVAL
);
1454 qemu_opts_del(opts
);
1455 if (initiator_name
!= NULL
) {
1456 g_free(initiator_name
);
1458 if (iscsi_url
!= NULL
) {
1459 iscsi_destroy_url(iscsi_url
);
1462 scsi_free_scsi_task(task
);
1466 if (iscsi
!= NULL
) {
1467 iscsi_destroy_context(iscsi
);
1469 memset(iscsilun
, 0, sizeof(IscsiLun
));
1474 static void iscsi_close(BlockDriverState
*bs
)
1476 IscsiLun
*iscsilun
= bs
->opaque
;
1477 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
1479 if (iscsilun
->nop_timer
) {
1480 timer_del(iscsilun
->nop_timer
);
1481 timer_free(iscsilun
->nop_timer
);
1483 qemu_aio_set_fd_handler(iscsi_get_fd(iscsi
), NULL
, NULL
, NULL
);
1484 iscsi_destroy_context(iscsi
);
1485 g_free(iscsilun
->zeroblock
);
1486 memset(iscsilun
, 0, sizeof(IscsiLun
));
1489 static int iscsi_truncate(BlockDriverState
*bs
, int64_t offset
)
1491 IscsiLun
*iscsilun
= bs
->opaque
;
1494 if (iscsilun
->type
!= TYPE_DISK
) {
1498 if ((ret
= iscsi_readcapacity_sync(iscsilun
)) != 0) {
1502 if (offset
> iscsi_getlength(bs
)) {
1509 static int iscsi_create(const char *filename
, QEMUOptionParameter
*options
,
1513 int64_t total_size
= 0;
1514 BlockDriverState
*bs
;
1515 IscsiLun
*iscsilun
= NULL
;
1520 /* Read out options */
1521 while (options
&& options
->name
) {
1522 if (!strcmp(options
->name
, "size")) {
1523 total_size
= options
->value
.n
/ BDRV_SECTOR_SIZE
;
1528 bs
->opaque
= g_malloc0(sizeof(struct IscsiLun
));
1529 iscsilun
= bs
->opaque
;
1531 bs_options
= qdict_new();
1532 qdict_put(bs_options
, "filename", qstring_from_str(filename
));
1533 ret
= iscsi_open(bs
, bs_options
, 0, NULL
);
1534 QDECREF(bs_options
);
1539 if (iscsilun
->nop_timer
) {
1540 timer_del(iscsilun
->nop_timer
);
1541 timer_free(iscsilun
->nop_timer
);
1543 if (iscsilun
->type
!= TYPE_DISK
) {
1547 if (bs
->total_sectors
< total_size
) {
1554 if (iscsilun
->iscsi
!= NULL
) {
1555 iscsi_destroy_context(iscsilun
->iscsi
);
1563 static int iscsi_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
)
1565 IscsiLun
*iscsilun
= bs
->opaque
;
1566 bdi
->unallocated_blocks_are_zero
= !!iscsilun
->lbprz
;
1567 bdi
->can_write_zeroes_with_unmap
= iscsilun
->lbprz
&& iscsilun
->lbp
.lbpws
;
1571 static QEMUOptionParameter iscsi_create_options
[] = {
1573 .name
= BLOCK_OPT_SIZE
,
1575 .help
= "Virtual disk size"
1580 static BlockDriver bdrv_iscsi
= {
1581 .format_name
= "iscsi",
1582 .protocol_name
= "iscsi",
1584 .instance_size
= sizeof(IscsiLun
),
1585 .bdrv_needs_filename
= true,
1586 .bdrv_file_open
= iscsi_open
,
1587 .bdrv_close
= iscsi_close
,
1588 .bdrv_create
= iscsi_create
,
1589 .create_options
= iscsi_create_options
,
1591 .bdrv_getlength
= iscsi_getlength
,
1592 .bdrv_get_info
= iscsi_get_info
,
1593 .bdrv_truncate
= iscsi_truncate
,
1595 #if defined(LIBISCSI_FEATURE_IOVECTOR)
1596 .bdrv_co_get_block_status
= iscsi_co_get_block_status
,
1598 .bdrv_co_discard
= iscsi_co_discard
,
1599 #if defined(SCSI_SENSE_ASCQ_CAPACITY_DATA_HAS_CHANGED)
1600 .bdrv_co_write_zeroes
= iscsi_co_write_zeroes
,
1603 .bdrv_aio_readv
= iscsi_aio_readv
,
1604 .bdrv_aio_writev
= iscsi_aio_writev
,
1605 .bdrv_aio_flush
= iscsi_aio_flush
,
1608 .bdrv_ioctl
= iscsi_ioctl
,
1609 .bdrv_aio_ioctl
= iscsi_aio_ioctl
,
1613 static QemuOptsList qemu_iscsi_opts
= {
1615 .head
= QTAILQ_HEAD_INITIALIZER(qemu_iscsi_opts
.head
),
1619 .type
= QEMU_OPT_STRING
,
1620 .help
= "username for CHAP authentication to target",
1623 .type
= QEMU_OPT_STRING
,
1624 .help
= "password for CHAP authentication to target",
1626 .name
= "header-digest",
1627 .type
= QEMU_OPT_STRING
,
1628 .help
= "HeaderDigest setting. "
1629 "{CRC32C|CRC32C-NONE|NONE-CRC32C|NONE}",
1631 .name
= "initiator-name",
1632 .type
= QEMU_OPT_STRING
,
1633 .help
= "Initiator iqn name to use when connecting",
1635 { /* end of list */ }
1639 static void iscsi_block_init(void)
1641 bdrv_register(&bdrv_iscsi
);
1642 qemu_add_opts(&qemu_iscsi_opts
);
1645 block_init(iscsi_block_init
);