2 * QEMU Block driver for iSCSI images
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 uint8_t has_write_same;
59 struct scsi_inquiry_logical_block_provisioning lbp;
60 struct scsi_inquiry_block_limits bl;
61 unsigned char *zeroblock;
64 typedef struct IscsiTask {
69 struct scsi_task *task;
74 typedef struct IscsiAIOCB {
75 BlockDriverAIOCB common;
79 struct scsi_task *task;
91 #define NOP_INTERVAL 5000
92 #define MAX_NOP_FAILURES 3
93 #define ISCSI_CMD_RETRIES 5
100 qemu_bh_delete(acb->bh);
105 if (acb->canceled == 0) {
106 acb->common.cb(acb->common.opaque, acb->status);
109 if (acb->task != NULL) {
110 scsi_free_scsi_task(acb->task);
114 qemu_aio_release(acb);
118 iscsi_schedule_bh(IscsiAIOCB *acb)
123 acb->bh = qemu_bh_new(iscsi_bh_cb, acb);
124 qemu_bh_schedule(acb->bh);
127 static void iscsi_co_generic_bh_cb(void *opaque)
129 struct IscsiTask *iTask = opaque;
130 qemu_bh_delete(iTask->bh);
131 qemu_coroutine_enter(iTask->co, NULL);
135 iscsi_co_generic_cb(struct iscsi_context *iscsi, int status,
136 void *command_data, void *opaque)
138 struct IscsiTask *iTask = opaque;
139 struct scsi_task *task = command_data;
142 iTask->status = status;
146 if (iTask->retries-- > 0 && status == SCSI_STATUS_CHECK_CONDITION
147 && task->sense.key == SCSI_SENSE_UNIT_ATTENTION) {
148 error_report("iSCSI CheckCondition: %s", iscsi_get_error(iscsi));
153 if (status != SCSI_STATUS_GOOD) {
154 error_report("iSCSI Failure: %s", iscsi_get_error(iscsi));
159 iTask->bh = qemu_bh_new(iscsi_co_generic_bh_cb, iTask);
160 qemu_bh_schedule(iTask->bh);
164 static void iscsi_co_init_iscsitask(IscsiLun *iscsilun, struct IscsiTask *iTask)
166 *iTask = (struct IscsiTask) {
167 .co = qemu_coroutine_self(),
168 .retries = ISCSI_CMD_RETRIES,
173 iscsi_abort_task_cb(struct iscsi_context *iscsi, int status, void *command_data,
176 IscsiAIOCB *acb = private_data;
178 acb->status = -ECANCELED;
179 iscsi_schedule_bh(acb);
183 iscsi_aio_cancel(BlockDriverAIOCB *blockacb)
185 IscsiAIOCB *acb = (IscsiAIOCB *)blockacb;
186 IscsiLun *iscsilun = acb->iscsilun;
188 if (acb->status != -EINPROGRESS) {
194 /* send a task mgmt call to the target to cancel the task on the target */
195 iscsi_task_mgmt_abort_task_async(iscsilun->iscsi, acb->task,
196 iscsi_abort_task_cb, acb);
198 while (acb->status == -EINPROGRESS) {
203 static const AIOCBInfo iscsi_aiocb_info = {
204 .aiocb_size = sizeof(IscsiAIOCB),
205 .cancel = iscsi_aio_cancel,
209 static void iscsi_process_read(void *arg);
210 static void iscsi_process_write(void *arg);
213 iscsi_set_events(IscsiLun *iscsilun)
215 struct iscsi_context *iscsi = iscsilun->iscsi;
218 /* We always register a read handler. */
220 ev |= iscsi_which_events(iscsi);
221 if (ev != iscsilun->events) {
222 qemu_aio_set_fd_handler(iscsi_get_fd(iscsi),
224 (ev & POLLOUT) ? iscsi_process_write : NULL,
229 iscsilun->events = ev;
233 iscsi_process_read(void *arg)
235 IscsiLun *iscsilun = arg;
236 struct iscsi_context *iscsi = iscsilun->iscsi;
238 iscsi_service(iscsi, POLLIN);
239 iscsi_set_events(iscsilun);
243 iscsi_process_write(void *arg)
245 IscsiLun *iscsilun = arg;
246 struct iscsi_context *iscsi = iscsilun->iscsi;
248 iscsi_service(iscsi, POLLOUT);
249 iscsi_set_events(iscsilun);
252 static int64_t sector_lun2qemu(int64_t sector, IscsiLun *iscsilun)
254 return sector * iscsilun->block_size / BDRV_SECTOR_SIZE;
257 static int64_t sector_qemu2lun(int64_t sector, IscsiLun *iscsilun)
259 return sector * BDRV_SECTOR_SIZE / iscsilun->block_size;
262 static bool is_request_lun_aligned(int64_t sector_num, int nb_sectors,
265 if ((sector_num * BDRV_SECTOR_SIZE) % iscsilun->block_size ||
266 (nb_sectors * BDRV_SECTOR_SIZE) % iscsilun->block_size) {
267 error_report("iSCSI misaligned request: "
268 "iscsilun->block_size %u, sector_num %" PRIi64
270 iscsilun->block_size, sector_num, nb_sectors);
276 static int coroutine_fn iscsi_co_writev(BlockDriverState *bs,
277 int64_t sector_num, int nb_sectors,
280 IscsiLun *iscsilun = bs->opaque;
281 struct IscsiTask iTask;
283 uint32_t num_sectors;
284 uint8_t *data = NULL;
287 if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
291 lba = sector_qemu2lun(sector_num, iscsilun);
292 num_sectors = sector_qemu2lun(nb_sectors, iscsilun);
293 #if !defined(LIBISCSI_FEATURE_IOVECTOR)
294 /* if the iovec only contains one buffer we can pass it directly */
295 if (iov->niov == 1) {
296 data = iov->iov[0].iov_base;
298 size_t size = MIN(nb_sectors * BDRV_SECTOR_SIZE, iov->size);
299 buf = g_malloc(size);
300 qemu_iovec_to_buf(iov, 0, buf, size);
304 iscsi_co_init_iscsitask(iscsilun, &iTask);
306 iTask.task = iscsi_write16_task(iscsilun->iscsi, iscsilun->lun, lba,
307 data, num_sectors * iscsilun->block_size,
308 iscsilun->block_size, 0, 0, 0, 0, 0,
309 iscsi_co_generic_cb, &iTask);
310 if (iTask.task == NULL) {
314 #if defined(LIBISCSI_FEATURE_IOVECTOR)
315 scsi_task_set_iov_out(iTask.task, (struct scsi_iovec *) iov->iov,
318 while (!iTask.complete) {
319 iscsi_set_events(iscsilun);
320 qemu_coroutine_yield();
323 if (iTask.task != NULL) {
324 scsi_free_scsi_task(iTask.task);
328 if (iTask.do_retry) {
335 if (iTask.status != SCSI_STATUS_GOOD) {
342 static int coroutine_fn iscsi_co_readv(BlockDriverState *bs,
343 int64_t sector_num, int nb_sectors,
346 IscsiLun *iscsilun = bs->opaque;
347 struct IscsiTask iTask;
349 uint32_t num_sectors;
350 #if !defined(LIBISCSI_FEATURE_IOVECTOR)
354 if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
358 lba = sector_qemu2lun(sector_num, iscsilun);
359 num_sectors = sector_qemu2lun(nb_sectors, iscsilun);
361 iscsi_co_init_iscsitask(iscsilun, &iTask);
363 switch (iscsilun->type) {
365 iTask.task = iscsi_read16_task(iscsilun->iscsi, iscsilun->lun, lba,
366 num_sectors * iscsilun->block_size,
367 iscsilun->block_size, 0, 0, 0, 0, 0,
368 iscsi_co_generic_cb, &iTask);
371 iTask.task = iscsi_read10_task(iscsilun->iscsi, iscsilun->lun, lba,
372 num_sectors * iscsilun->block_size,
373 iscsilun->block_size,
374 #if !defined(CONFIG_LIBISCSI_1_4) /* API change from 1.4.0 to 1.5.0 */
377 iscsi_co_generic_cb, &iTask);
380 if (iTask.task == NULL) {
383 #if defined(LIBISCSI_FEATURE_IOVECTOR)
384 scsi_task_set_iov_in(iTask.task, (struct scsi_iovec *) iov->iov, iov->niov);
386 for (i = 0; i < iov->niov; i++) {
387 scsi_task_add_data_in_buffer(iTask.task,
389 iov->iov[i].iov_base);
393 while (!iTask.complete) {
394 iscsi_set_events(iscsilun);
395 qemu_coroutine_yield();
398 if (iTask.task != NULL) {
399 scsi_free_scsi_task(iTask.task);
403 if (iTask.do_retry) {
408 if (iTask.status != SCSI_STATUS_GOOD) {
415 static int coroutine_fn iscsi_co_flush(BlockDriverState *bs)
417 IscsiLun *iscsilun = bs->opaque;
418 struct IscsiTask iTask;
420 iscsi_co_init_iscsitask(iscsilun, &iTask);
423 if (iscsi_synchronizecache10_task(iscsilun->iscsi, iscsilun->lun, 0, 0, 0,
424 0, iscsi_co_generic_cb, &iTask) == NULL) {
428 while (!iTask.complete) {
429 iscsi_set_events(iscsilun);
430 qemu_coroutine_yield();
433 if (iTask.task != NULL) {
434 scsi_free_scsi_task(iTask.task);
438 if (iTask.do_retry) {
443 if (iTask.status != SCSI_STATUS_GOOD) {
452 iscsi_aio_ioctl_cb(struct iscsi_context *iscsi, int status,
453 void *command_data, void *opaque)
455 IscsiAIOCB *acb = opaque;
460 if (acb->canceled != 0) {
466 error_report("Failed to ioctl(SG_IO) to iSCSI lun. %s",
467 iscsi_get_error(iscsi));
471 acb->ioh->driver_status = 0;
472 acb->ioh->host_status = 0;
475 #define SG_ERR_DRIVER_SENSE 0x08
477 if (status == SCSI_STATUS_CHECK_CONDITION && acb->task->datain.size >= 2) {
480 acb->ioh->driver_status |= SG_ERR_DRIVER_SENSE;
482 acb->ioh->sb_len_wr = acb->task->datain.size - 2;
483 ss = (acb->ioh->mx_sb_len >= acb->ioh->sb_len_wr) ?
484 acb->ioh->mx_sb_len : acb->ioh->sb_len_wr;
485 memcpy(acb->ioh->sbp, &acb->task->datain.data[2], ss);
488 iscsi_schedule_bh(acb);
491 static BlockDriverAIOCB *iscsi_aio_ioctl(BlockDriverState *bs,
492 unsigned long int req, void *buf,
493 BlockDriverCompletionFunc *cb, void *opaque)
495 IscsiLun *iscsilun = bs->opaque;
496 struct iscsi_context *iscsi = iscsilun->iscsi;
497 struct iscsi_data data;
500 assert(req == SG_IO);
502 acb = qemu_aio_get(&iscsi_aiocb_info, bs, cb, opaque);
504 acb->iscsilun = iscsilun;
507 acb->status = -EINPROGRESS;
511 acb->task = malloc(sizeof(struct scsi_task));
512 if (acb->task == NULL) {
513 error_report("iSCSI: Failed to allocate task for scsi command. %s",
514 iscsi_get_error(iscsi));
515 qemu_aio_release(acb);
518 memset(acb->task, 0, sizeof(struct scsi_task));
520 switch (acb->ioh->dxfer_direction) {
521 case SG_DXFER_TO_DEV:
522 acb->task->xfer_dir = SCSI_XFER_WRITE;
524 case SG_DXFER_FROM_DEV:
525 acb->task->xfer_dir = SCSI_XFER_READ;
528 acb->task->xfer_dir = SCSI_XFER_NONE;
532 acb->task->cdb_size = acb->ioh->cmd_len;
533 memcpy(&acb->task->cdb[0], acb->ioh->cmdp, acb->ioh->cmd_len);
534 acb->task->expxferlen = acb->ioh->dxfer_len;
537 if (acb->task->xfer_dir == SCSI_XFER_WRITE) {
538 if (acb->ioh->iovec_count == 0) {
539 data.data = acb->ioh->dxferp;
540 data.size = acb->ioh->dxfer_len;
542 #if defined(LIBISCSI_FEATURE_IOVECTOR)
543 scsi_task_set_iov_out(acb->task,
544 (struct scsi_iovec *) acb->ioh->dxferp,
545 acb->ioh->iovec_count);
547 struct iovec *iov = (struct iovec *)acb->ioh->dxferp;
549 acb->buf = g_malloc(acb->ioh->dxfer_len);
550 data.data = acb->buf;
551 data.size = iov_to_buf(iov, acb->ioh->iovec_count, 0,
552 acb->buf, acb->ioh->dxfer_len);
557 if (iscsi_scsi_command_async(iscsi, iscsilun->lun, acb->task,
559 (data.size > 0) ? &data : NULL,
561 scsi_free_scsi_task(acb->task);
562 qemu_aio_release(acb);
566 /* tell libiscsi to read straight into the buffer we got from ioctl */
567 if (acb->task->xfer_dir == SCSI_XFER_READ) {
568 if (acb->ioh->iovec_count == 0) {
569 scsi_task_add_data_in_buffer(acb->task,
573 #if defined(LIBISCSI_FEATURE_IOVECTOR)
574 scsi_task_set_iov_in(acb->task,
575 (struct scsi_iovec *) acb->ioh->dxferp,
576 acb->ioh->iovec_count);
579 for (i = 0; i < acb->ioh->iovec_count; i++) {
580 struct iovec *iov = (struct iovec *)acb->ioh->dxferp;
582 scsi_task_add_data_in_buffer(acb->task,
590 iscsi_set_events(iscsilun);
596 static void ioctl_cb(void *opaque, int status)
598 int *p_status = opaque;
602 static int iscsi_ioctl(BlockDriverState *bs, unsigned long int req, void *buf)
604 IscsiLun *iscsilun = bs->opaque;
608 case SG_GET_VERSION_NUM:
612 ((struct sg_scsi_id *)buf)->scsi_type = iscsilun->type;
615 status = -EINPROGRESS;
616 iscsi_aio_ioctl(bs, req, buf, ioctl_cb, &status);
618 while (status == -EINPROGRESS) {
631 iscsi_getlength(BlockDriverState *bs)
633 IscsiLun *iscsilun = bs->opaque;
636 len = iscsilun->num_blocks;
637 len *= iscsilun->block_size;
642 #if defined(LIBISCSI_FEATURE_IOVECTOR)
644 static int64_t coroutine_fn iscsi_co_get_block_status(BlockDriverState *bs,
646 int nb_sectors, int *pnum)
648 IscsiLun *iscsilun = bs->opaque;
649 struct scsi_get_lba_status *lbas = NULL;
650 struct scsi_lba_status_descriptor *lbasd = NULL;
651 struct IscsiTask iTask;
654 iscsi_co_init_iscsitask(iscsilun, &iTask);
656 if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
661 /* default to all sectors allocated */
662 ret = BDRV_BLOCK_DATA;
663 ret |= (sector_num << BDRV_SECTOR_BITS) | BDRV_BLOCK_OFFSET_VALID;
666 /* LUN does not support logical block provisioning */
667 if (iscsilun->lbpme == 0) {
672 if (iscsi_get_lba_status_task(iscsilun->iscsi, iscsilun->lun,
673 sector_qemu2lun(sector_num, iscsilun),
674 8 + 16, iscsi_co_generic_cb,
680 while (!iTask.complete) {
681 iscsi_set_events(iscsilun);
682 qemu_coroutine_yield();
685 if (iTask.do_retry) {
686 if (iTask.task != NULL) {
687 scsi_free_scsi_task(iTask.task);
694 if (iTask.status != SCSI_STATUS_GOOD) {
695 /* in case the get_lba_status_callout fails (i.e.
696 * because the device is busy or the cmd is not
697 * supported) we pretend all blocks are allocated
698 * for backwards compatibility */
702 lbas = scsi_datain_unmarshall(iTask.task);
708 lbasd = &lbas->descriptors[0];
710 if (sector_qemu2lun(sector_num, iscsilun) != lbasd->lba) {
715 *pnum = sector_lun2qemu(lbasd->num_blocks, iscsilun);
716 if (*pnum > nb_sectors) {
720 if (lbasd->provisioning == SCSI_PROVISIONING_TYPE_DEALLOCATED ||
721 lbasd->provisioning == SCSI_PROVISIONING_TYPE_ANCHORED) {
722 ret &= ~BDRV_BLOCK_DATA;
723 if (iscsilun->lbprz) {
724 ret |= BDRV_BLOCK_ZERO;
729 if (iTask.task != NULL) {
730 scsi_free_scsi_task(iTask.task);
735 #endif /* LIBISCSI_FEATURE_IOVECTOR */
738 coroutine_fn iscsi_co_discard(BlockDriverState *bs, int64_t sector_num,
741 IscsiLun *iscsilun = bs->opaque;
742 struct IscsiTask iTask;
743 struct unmap_list list;
745 if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
749 if (!iscsilun->lbp.lbpu) {
750 /* UNMAP is not supported by the target */
754 list.lba = sector_qemu2lun(sector_num, iscsilun);
755 list.num = sector_qemu2lun(nb_sectors, iscsilun);
757 iscsi_co_init_iscsitask(iscsilun, &iTask);
759 if (iscsi_unmap_task(iscsilun->iscsi, iscsilun->lun, 0, 0, &list, 1,
760 iscsi_co_generic_cb, &iTask) == NULL) {
764 while (!iTask.complete) {
765 iscsi_set_events(iscsilun);
766 qemu_coroutine_yield();
769 if (iTask.task != NULL) {
770 scsi_free_scsi_task(iTask.task);
774 if (iTask.do_retry) {
779 if (iTask.status == SCSI_STATUS_CHECK_CONDITION) {
780 /* the target might fail with a check condition if it
781 is not happy with the alignment of the UNMAP request
782 we silently fail in this case */
786 if (iTask.status != SCSI_STATUS_GOOD) {
793 #if defined(SCSI_SENSE_ASCQ_CAPACITY_DATA_HAS_CHANGED)
796 coroutine_fn iscsi_co_write_zeroes(BlockDriverState *bs, int64_t sector_num,
797 int nb_sectors, BdrvRequestFlags flags)
799 IscsiLun *iscsilun = bs->opaque;
800 struct IscsiTask iTask;
804 if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
808 if (!(flags & BDRV_REQ_MAY_UNMAP) && !iscsilun->has_write_same) {
809 /* WRITE SAME without UNMAP is not supported by the target */
813 if ((flags & BDRV_REQ_MAY_UNMAP) && !iscsilun->lbp.lbpws) {
814 /* WRITE SAME with UNMAP is not supported by the target */
818 lba = sector_qemu2lun(sector_num, iscsilun);
819 nb_blocks = sector_qemu2lun(nb_sectors, iscsilun);
821 if (iscsilun->zeroblock == NULL) {
822 iscsilun->zeroblock = g_malloc0(iscsilun->block_size);
825 iscsi_co_init_iscsitask(iscsilun, &iTask);
827 if (iscsi_writesame16_task(iscsilun->iscsi, iscsilun->lun, lba,
828 iscsilun->zeroblock, iscsilun->block_size,
829 nb_blocks, 0, !!(flags & BDRV_REQ_MAY_UNMAP),
830 0, 0, iscsi_co_generic_cb, &iTask) == NULL) {
834 while (!iTask.complete) {
835 iscsi_set_events(iscsilun);
836 qemu_coroutine_yield();
839 if (iTask.status == SCSI_STATUS_CHECK_CONDITION &&
840 iTask.task->sense.key == SCSI_SENSE_ILLEGAL_REQUEST &&
841 iTask.task->sense.ascq == SCSI_SENSE_ASCQ_INVALID_OPERATION_CODE) {
842 /* WRITE SAME is not supported by the target */
843 iscsilun->has_write_same = false;
844 scsi_free_scsi_task(iTask.task);
848 if (iTask.task != NULL) {
849 scsi_free_scsi_task(iTask.task);
853 if (iTask.do_retry) {
858 if (iTask.status != SCSI_STATUS_GOOD) {
865 #endif /* SCSI_SENSE_ASCQ_CAPACITY_DATA_HAS_CHANGED */
867 static void parse_chap(struct iscsi_context *iscsi, const char *target,
872 const char *user = NULL;
873 const char *password = NULL;
875 list = qemu_find_opts("iscsi");
880 opts = qemu_opts_find(list, target);
882 opts = QTAILQ_FIRST(&list->head);
888 user = qemu_opt_get(opts, "user");
893 password = qemu_opt_get(opts, "password");
895 error_setg(errp, "CHAP username specified but no password was given");
899 if (iscsi_set_initiator_username_pwd(iscsi, user, password)) {
900 error_setg(errp, "Failed to set initiator username and password");
904 static void parse_header_digest(struct iscsi_context *iscsi, const char *target,
909 const char *digest = NULL;
911 list = qemu_find_opts("iscsi");
916 opts = qemu_opts_find(list, target);
918 opts = QTAILQ_FIRST(&list->head);
924 digest = qemu_opt_get(opts, "header-digest");
929 if (!strcmp(digest, "CRC32C")) {
930 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_CRC32C);
931 } else if (!strcmp(digest, "NONE")) {
932 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE);
933 } else if (!strcmp(digest, "CRC32C-NONE")) {
934 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_CRC32C_NONE);
935 } else if (!strcmp(digest, "NONE-CRC32C")) {
936 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE_CRC32C);
938 error_setg(errp, "Invalid header-digest setting : %s", digest);
942 static char *parse_initiator_name(const char *target)
950 list = qemu_find_opts("iscsi");
952 opts = qemu_opts_find(list, target);
954 opts = QTAILQ_FIRST(&list->head);
957 name = qemu_opt_get(opts, "initiator-name");
959 return g_strdup(name);
964 uuid_info = qmp_query_uuid(NULL);
965 if (strcmp(uuid_info->UUID, UUID_NONE) == 0) {
966 name = qemu_get_vm_name();
968 name = uuid_info->UUID;
970 iscsi_name = g_strdup_printf("iqn.2008-11.org.linux-kvm%s%s",
971 name ? ":" : "", name ? name : "");
972 qapi_free_UuidInfo(uuid_info);
976 #if defined(LIBISCSI_FEATURE_NOP_COUNTER)
977 static void iscsi_nop_timed_event(void *opaque)
979 IscsiLun *iscsilun = opaque;
981 if (iscsi_get_nops_in_flight(iscsilun->iscsi) > MAX_NOP_FAILURES) {
982 error_report("iSCSI: NOP timeout. Reconnecting...");
983 iscsi_reconnect(iscsilun->iscsi);
986 if (iscsi_nop_out_async(iscsilun->iscsi, NULL, NULL, 0, NULL) != 0) {
987 error_report("iSCSI: failed to sent NOP-Out. Disabling NOP messages.");
991 timer_mod(iscsilun->nop_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + NOP_INTERVAL);
992 iscsi_set_events(iscsilun);
996 static void iscsi_readcapacity_sync(IscsiLun *iscsilun, Error **errp)
998 struct scsi_task *task = NULL;
999 struct scsi_readcapacity10 *rc10 = NULL;
1000 struct scsi_readcapacity16 *rc16 = NULL;
1001 int retries = ISCSI_CMD_RETRIES;
1005 scsi_free_scsi_task(task);
1009 switch (iscsilun->type) {
1011 task = iscsi_readcapacity16_sync(iscsilun->iscsi, iscsilun->lun);
1012 if (task != NULL && task->status == SCSI_STATUS_GOOD) {
1013 rc16 = scsi_datain_unmarshall(task);
1015 error_setg(errp, "iSCSI: Failed to unmarshall readcapacity16 data.");
1017 iscsilun->block_size = rc16->block_length;
1018 iscsilun->num_blocks = rc16->returned_lba + 1;
1019 iscsilun->lbpme = rc16->lbpme;
1020 iscsilun->lbprz = rc16->lbprz;
1025 task = iscsi_readcapacity10_sync(iscsilun->iscsi, iscsilun->lun, 0, 0);
1026 if (task != NULL && task->status == SCSI_STATUS_GOOD) {
1027 rc10 = scsi_datain_unmarshall(task);
1029 error_setg(errp, "iSCSI: Failed to unmarshall readcapacity10 data.");
1031 iscsilun->block_size = rc10->block_size;
1032 if (rc10->lba == 0) {
1033 /* blank disk loaded */
1034 iscsilun->num_blocks = 0;
1036 iscsilun->num_blocks = rc10->lba + 1;
1044 } while (task != NULL && task->status == SCSI_STATUS_CHECK_CONDITION
1045 && task->sense.key == SCSI_SENSE_UNIT_ATTENTION
1048 if (task == NULL || task->status != SCSI_STATUS_GOOD) {
1049 error_setg(errp, "iSCSI: failed to send readcapacity10 command.");
1052 scsi_free_scsi_task(task);
1056 /* TODO Convert to fine grained options */
1057 static QemuOptsList runtime_opts = {
1059 .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
1063 .type = QEMU_OPT_STRING,
1064 .help = "URL to the iscsi image",
1066 { /* end of list */ }
1070 static struct scsi_task *iscsi_do_inquiry(struct iscsi_context *iscsi, int lun,
1071 int evpd, int pc, void **inq, Error **errp)
1074 struct scsi_task *task = NULL;
1075 task = iscsi_inquiry_sync(iscsi, lun, evpd, pc, 64);
1076 if (task == NULL || task->status != SCSI_STATUS_GOOD) {
1079 full_size = scsi_datain_getfullsize(task);
1080 if (full_size > task->datain.size) {
1081 scsi_free_scsi_task(task);
1083 /* we need more data for the full list */
1084 task = iscsi_inquiry_sync(iscsi, lun, evpd, pc, full_size);
1085 if (task == NULL || task->status != SCSI_STATUS_GOOD) {
1090 *inq = scsi_datain_unmarshall(task);
1092 error_setg(errp, "iSCSI: failed to unmarshall inquiry datain blob");
1099 error_setg(errp, "iSCSI: Inquiry command failed : %s",
1100 iscsi_get_error(iscsi));
1102 scsi_free_scsi_task(task);
1108 * We support iscsi url's on the form
1109 * iscsi://[<username>%<password>@]<host>[:<port>]/<targetname>/<lun>
1111 * Note: flags are currently not used by iscsi_open. If this function
1112 * is changed such that flags are used, please examine iscsi_reopen_prepare()
1113 * to see if needs to be changed as well.
1115 static int iscsi_open(BlockDriverState *bs, QDict *options, int flags,
1118 IscsiLun *iscsilun = bs->opaque;
1119 struct iscsi_context *iscsi = NULL;
1120 struct iscsi_url *iscsi_url = NULL;
1121 struct scsi_task *task = NULL;
1122 struct scsi_inquiry_standard *inq = NULL;
1123 struct scsi_inquiry_supported_pages *inq_vpd;
1124 char *initiator_name = NULL;
1126 Error *local_err = NULL;
1127 const char *filename;
1130 if ((BDRV_SECTOR_SIZE % 512) != 0) {
1131 error_setg(errp, "iSCSI: Invalid BDRV_SECTOR_SIZE. "
1132 "BDRV_SECTOR_SIZE(%lld) is not a multiple "
1133 "of 512", BDRV_SECTOR_SIZE);
1137 opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
1138 qemu_opts_absorb_qdict(opts, options, &local_err);
1140 error_propagate(errp, local_err);
1145 filename = qemu_opt_get(opts, "filename");
1147 iscsi_url = iscsi_parse_full_url(iscsi, filename);
1148 if (iscsi_url == NULL) {
1149 error_setg(errp, "Failed to parse URL : %s", filename);
1154 memset(iscsilun, 0, sizeof(IscsiLun));
1156 initiator_name = parse_initiator_name(iscsi_url->target);
1158 iscsi = iscsi_create_context(initiator_name);
1159 if (iscsi == NULL) {
1160 error_setg(errp, "iSCSI: Failed to create iSCSI context.");
1165 if (iscsi_set_targetname(iscsi, iscsi_url->target)) {
1166 error_setg(errp, "iSCSI: Failed to set target name.");
1171 if (iscsi_url->user != NULL) {
1172 ret = iscsi_set_initiator_username_pwd(iscsi, iscsi_url->user,
1175 error_setg(errp, "Failed to set initiator username and password");
1181 /* check if we got CHAP username/password via the options */
1182 parse_chap(iscsi, iscsi_url->target, &local_err);
1183 if (local_err != NULL) {
1184 error_propagate(errp, local_err);
1189 if (iscsi_set_session_type(iscsi, ISCSI_SESSION_NORMAL) != 0) {
1190 error_setg(errp, "iSCSI: Failed to set session type to normal.");
1195 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE_CRC32C);
1197 /* check if we got HEADER_DIGEST via the options */
1198 parse_header_digest(iscsi, iscsi_url->target, &local_err);
1199 if (local_err != NULL) {
1200 error_propagate(errp, local_err);
1205 if (iscsi_full_connect_sync(iscsi, iscsi_url->portal, iscsi_url->lun) != 0) {
1206 error_setg(errp, "iSCSI: Failed to connect to LUN : %s",
1207 iscsi_get_error(iscsi));
1212 iscsilun->iscsi = iscsi;
1213 iscsilun->lun = iscsi_url->lun;
1214 iscsilun->has_write_same = true;
1216 task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 0, 0,
1217 (void **) &inq, errp);
1222 iscsilun->type = inq->periperal_device_type;
1223 scsi_free_scsi_task(task);
1226 iscsi_readcapacity_sync(iscsilun, &local_err);
1227 if (local_err != NULL) {
1228 error_propagate(errp, local_err);
1231 bs->total_sectors = sector_lun2qemu(iscsilun->num_blocks, iscsilun);
1232 bs->request_alignment = iscsilun->block_size;
1234 /* We don't have any emulation for devices other than disks and CD-ROMs, so
1235 * this must be sg ioctl compatible. We force it to be sg, otherwise qemu
1236 * will try to read from the device to guess the image format.
1238 if (iscsilun->type != TYPE_DISK && iscsilun->type != TYPE_ROM) {
1242 task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
1243 SCSI_INQUIRY_PAGECODE_SUPPORTED_VPD_PAGES,
1244 (void **) &inq_vpd, errp);
1249 for (i = 0; i < inq_vpd->num_pages; i++) {
1250 struct scsi_task *inq_task;
1251 struct scsi_inquiry_logical_block_provisioning *inq_lbp;
1252 struct scsi_inquiry_block_limits *inq_bl;
1253 switch (inq_vpd->pages[i]) {
1254 case SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING:
1255 inq_task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
1256 SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING,
1257 (void **) &inq_lbp, errp);
1258 if (inq_task == NULL) {
1262 memcpy(&iscsilun->lbp, inq_lbp,
1263 sizeof(struct scsi_inquiry_logical_block_provisioning));
1264 scsi_free_scsi_task(inq_task);
1266 case SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS:
1267 inq_task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
1268 SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS,
1269 (void **) &inq_bl, errp);
1270 if (inq_task == NULL) {
1274 memcpy(&iscsilun->bl, inq_bl,
1275 sizeof(struct scsi_inquiry_block_limits));
1276 scsi_free_scsi_task(inq_task);
1282 scsi_free_scsi_task(task);
1285 #if defined(LIBISCSI_FEATURE_NOP_COUNTER)
1286 /* Set up a timer for sending out iSCSI NOPs */
1287 iscsilun->nop_timer = timer_new_ms(QEMU_CLOCK_REALTIME, iscsi_nop_timed_event, iscsilun);
1288 timer_mod(iscsilun->nop_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + NOP_INTERVAL);
1292 qemu_opts_del(opts);
1293 if (initiator_name != NULL) {
1294 g_free(initiator_name);
1296 if (iscsi_url != NULL) {
1297 iscsi_destroy_url(iscsi_url);
1300 scsi_free_scsi_task(task);
1304 if (iscsi != NULL) {
1305 iscsi_destroy_context(iscsi);
1307 memset(iscsilun, 0, sizeof(IscsiLun));
1312 static void iscsi_close(BlockDriverState *bs)
1314 IscsiLun *iscsilun = bs->opaque;
1315 struct iscsi_context *iscsi = iscsilun->iscsi;
1317 if (iscsilun->nop_timer) {
1318 timer_del(iscsilun->nop_timer);
1319 timer_free(iscsilun->nop_timer);
1321 qemu_aio_set_fd_handler(iscsi_get_fd(iscsi), NULL, NULL, NULL);
1322 iscsi_destroy_context(iscsi);
1323 g_free(iscsilun->zeroblock);
1324 memset(iscsilun, 0, sizeof(IscsiLun));
1327 static int iscsi_refresh_limits(BlockDriverState *bs)
1329 IscsiLun *iscsilun = bs->opaque;
1331 /* We don't actually refresh here, but just return data queried in
1332 * iscsi_open(): iscsi targets don't change their limits. */
1333 if (iscsilun->lbp.lbpu || iscsilun->lbp.lbpws) {
1334 if (iscsilun->bl.max_unmap < 0xffffffff) {
1335 bs->bl.max_discard = sector_lun2qemu(iscsilun->bl.max_unmap,
1338 bs->bl.discard_alignment = sector_lun2qemu(iscsilun->bl.opt_unmap_gran,
1341 if (iscsilun->bl.max_ws_len < 0xffffffff) {
1342 bs->bl.max_write_zeroes = sector_lun2qemu(iscsilun->bl.max_ws_len,
1345 bs->bl.write_zeroes_alignment = sector_lun2qemu(iscsilun->bl.opt_unmap_gran,
1348 bs->bl.opt_transfer_length = sector_lun2qemu(iscsilun->bl.opt_xfer_len,
1353 /* Since iscsi_open() ignores bdrv_flags, there is nothing to do here in
1354 * prepare. Note that this will not re-establish a connection with an iSCSI
1355 * target - it is effectively a NOP. */
1356 static int iscsi_reopen_prepare(BDRVReopenState *state,
1357 BlockReopenQueue *queue, Error **errp)
1363 static int iscsi_truncate(BlockDriverState *bs, int64_t offset)
1365 IscsiLun *iscsilun = bs->opaque;
1366 Error *local_err = NULL;
1368 if (iscsilun->type != TYPE_DISK) {
1372 iscsi_readcapacity_sync(iscsilun, &local_err);
1373 if (local_err != NULL) {
1374 error_free(local_err);
1378 if (offset > iscsi_getlength(bs)) {
1385 static int iscsi_create(const char *filename, QEMUOptionParameter *options,
1389 int64_t total_size = 0;
1390 BlockDriverState *bs;
1391 IscsiLun *iscsilun = NULL;
1396 /* Read out options */
1397 while (options && options->name) {
1398 if (!strcmp(options->name, "size")) {
1399 total_size = options->value.n / BDRV_SECTOR_SIZE;
1404 bs->opaque = g_malloc0(sizeof(struct IscsiLun));
1405 iscsilun = bs->opaque;
1407 bs_options = qdict_new();
1408 qdict_put(bs_options, "filename", qstring_from_str(filename));
1409 ret = iscsi_open(bs, bs_options, 0, NULL);
1410 QDECREF(bs_options);
1415 if (iscsilun->nop_timer) {
1416 timer_del(iscsilun->nop_timer);
1417 timer_free(iscsilun->nop_timer);
1419 if (iscsilun->type != TYPE_DISK) {
1423 if (bs->total_sectors < total_size) {
1430 if (iscsilun->iscsi != NULL) {
1431 iscsi_destroy_context(iscsilun->iscsi);
1439 static int iscsi_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
1441 IscsiLun *iscsilun = bs->opaque;
1442 bdi->unallocated_blocks_are_zero = !!iscsilun->lbprz;
1443 bdi->can_write_zeroes_with_unmap = iscsilun->lbprz && iscsilun->lbp.lbpws;
1444 /* Guess the internal cluster (page) size of the iscsi target by the means
1445 * of opt_unmap_gran. Transfer the unmap granularity only if it has a
1446 * reasonable size for bdi->cluster_size */
1447 if (iscsilun->bl.opt_unmap_gran * iscsilun->block_size >= 64 * 1024 &&
1448 iscsilun->bl.opt_unmap_gran * iscsilun->block_size <= 16 * 1024 * 1024) {
1449 bdi->cluster_size = iscsilun->bl.opt_unmap_gran * iscsilun->block_size;
1454 static QEMUOptionParameter iscsi_create_options[] = {
1456 .name = BLOCK_OPT_SIZE,
1458 .help = "Virtual disk size"
1463 static BlockDriver bdrv_iscsi = {
1464 .format_name = "iscsi",
1465 .protocol_name = "iscsi",
1467 .instance_size = sizeof(IscsiLun),
1468 .bdrv_needs_filename = true,
1469 .bdrv_file_open = iscsi_open,
1470 .bdrv_close = iscsi_close,
1471 .bdrv_create = iscsi_create,
1472 .create_options = iscsi_create_options,
1473 .bdrv_reopen_prepare = iscsi_reopen_prepare,
1475 .bdrv_getlength = iscsi_getlength,
1476 .bdrv_get_info = iscsi_get_info,
1477 .bdrv_truncate = iscsi_truncate,
1478 .bdrv_refresh_limits = iscsi_refresh_limits,
1480 #if defined(LIBISCSI_FEATURE_IOVECTOR)
1481 .bdrv_co_get_block_status = iscsi_co_get_block_status,
1483 .bdrv_co_discard = iscsi_co_discard,
1484 #if defined(SCSI_SENSE_ASCQ_CAPACITY_DATA_HAS_CHANGED)
1485 .bdrv_co_write_zeroes = iscsi_co_write_zeroes,
1487 .bdrv_co_readv = iscsi_co_readv,
1488 .bdrv_co_writev = iscsi_co_writev,
1489 .bdrv_co_flush_to_disk = iscsi_co_flush,
1492 .bdrv_ioctl = iscsi_ioctl,
1493 .bdrv_aio_ioctl = iscsi_aio_ioctl,
1497 static QemuOptsList qemu_iscsi_opts = {
1499 .head = QTAILQ_HEAD_INITIALIZER(qemu_iscsi_opts.head),
1503 .type = QEMU_OPT_STRING,
1504 .help = "username for CHAP authentication to target",
1507 .type = QEMU_OPT_STRING,
1508 .help = "password for CHAP authentication to target",
1510 .name = "header-digest",
1511 .type = QEMU_OPT_STRING,
1512 .help = "HeaderDigest setting. "
1513 "{CRC32C|CRC32C-NONE|NONE-CRC32C|NONE}",
1515 .name = "initiator-name",
1516 .type = QEMU_OPT_STRING,
1517 .help = "Initiator iqn name to use when connecting",
1519 { /* end of list */ }
1523 static void iscsi_block_init(void)
1525 bdrv_register(&bdrv_iscsi);
1526 qemu_add_opts(&qemu_iscsi_opts);
1529 block_init(iscsi_block_init);