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 "qemu/osdep.h"
30 #include <arpa/inet.h>
31 #include "qemu/config-file.h"
32 #include "qemu/error-report.h"
33 #include "qemu/bitops.h"
34 #include "qemu/bitmap.h"
35 #include "block/block_int.h"
36 #include "block/qdict.h"
37 #include "scsi/constants.h"
39 #include "qemu/option.h"
40 #include "qemu/uuid.h"
41 #include "qapi/error.h"
42 #include "qapi/qapi-commands-misc.h"
43 #include "qapi/qmp/qdict.h"
44 #include "qapi/qmp/qstring.h"
45 #include "crypto/secret.h"
46 #include "scsi/utils.h"
48 /* Conflict between scsi/utils.h and libiscsi! :( */
49 #define SCSI_XFER_NONE ISCSI_XFER_NONE
50 #include <iscsi/iscsi.h>
51 #include <iscsi/scsi-lowlevel.h>
53 QEMU_BUILD_BUG_ON((int)SCSI_XFER_NONE != (int)ISCSI_XFER_NONE);
59 typedef struct IscsiLun {
60 struct iscsi_context *iscsi;
61 AioContext *aio_context;
63 enum scsi_inquiry_peripheral_device_type type;
68 QEMUTimer *event_timer;
70 struct scsi_inquiry_logical_block_provisioning lbp;
71 struct scsi_inquiry_block_limits bl;
72 struct scsi_inquiry_device_designator *dd;
73 unsigned char *zeroblock;
74 /* The allocmap tracks which clusters (pages) on the iSCSI target are
75 * allocated and which are not. In case a target returns zeros for
76 * unallocated pages (iscsilun->lprz) we can directly return zeros instead
77 * of reading zeros over the wire if a read request falls within an
78 * unallocated block. As there are 3 possible states we need 2 bitmaps to
79 * track. allocmap_valid keeps track if QEMU's information about a page is
80 * valid. allocmap tracks if a page is allocated or not. In case QEMU has no
81 * valid information about a page the corresponding allocmap entry should be
82 * switched to unallocated as well to force a new lookup of the allocation
83 * status as lookups are generally skipped if a page is suspect to be
84 * allocated. If a iSCSI target is opened with cache.direct = on the
85 * allocmap_valid does not exist turning all cached information invalid so
86 * that a fresh lookup is made for any page even if allocmap entry returns
87 * it's unallocated. */
88 unsigned long *allocmap;
89 unsigned long *allocmap_valid;
98 bool request_timed_out;
101 typedef struct IscsiTask {
106 struct scsi_task *task;
109 QEMUTimer retry_timer;
114 typedef struct IscsiAIOCB {
118 struct scsi_task *task;
129 /* libiscsi uses time_t so its enough to process events every second */
130 #define EVENT_INTERVAL 1000
131 #define NOP_INTERVAL 5000
132 #define MAX_NOP_FAILURES 3
133 #define ISCSI_CMD_RETRIES ARRAY_SIZE(iscsi_retry_times)
134 static const unsigned iscsi_retry_times[] = {8, 32, 128, 512, 2048, 8192, 32768};
136 /* this threshold is a trade-off knob to choose between
137 * the potential additional overhead of an extra GET_LBA_STATUS request
138 * vs. unnecessarily reading a lot of zero sectors over the wire.
139 * If a read request is greater or equal than ISCSI_CHECKALLOC_THRES
140 * sectors we check the allocation status of the area covered by the
141 * request first if the allocationmap indicates that the area might be
143 #define ISCSI_CHECKALLOC_THRES 64
150 qemu_bh_delete(acb->bh);
155 acb->common.cb(acb->common.opaque, acb->status);
157 if (acb->task != NULL) {
158 scsi_free_scsi_task(acb->task);
166 iscsi_schedule_bh(IscsiAIOCB *acb)
171 acb->bh = aio_bh_new(acb->iscsilun->aio_context, iscsi_bh_cb, acb);
172 qemu_bh_schedule(acb->bh);
175 static void iscsi_co_generic_bh_cb(void *opaque)
177 struct IscsiTask *iTask = opaque;
180 aio_co_wake(iTask->co);
183 static void iscsi_retry_timer_expired(void *opaque)
185 struct IscsiTask *iTask = opaque;
188 aio_co_wake(iTask->co);
192 static inline unsigned exp_random(double mean)
194 return -mean * log((double)rand() / RAND_MAX);
197 /* SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST was introduced in
198 * libiscsi 1.10.0, together with other constants we need. Use it as
199 * a hint that we have to define them ourselves if needed, to keep the
200 * minimum required libiscsi version at 1.9.0. We use an ASCQ macro for
201 * the test because SCSI_STATUS_* is an enum.
203 * To guard against future changes where SCSI_SENSE_ASCQ_* also becomes
204 * an enum, check against the LIBISCSI_API_VERSION macro, which was
205 * introduced in 1.11.0. If it is present, there is no need to define
208 #if !defined(SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST) && \
209 !defined(LIBISCSI_API_VERSION)
210 #define SCSI_STATUS_TASK_SET_FULL 0x28
211 #define SCSI_STATUS_TIMEOUT 0x0f000002
212 #define SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST 0x2600
213 #define SCSI_SENSE_ASCQ_PARAMETER_LIST_LENGTH_ERROR 0x1a00
216 #ifndef LIBISCSI_API_VERSION
217 #define LIBISCSI_API_VERSION 20130701
220 static int iscsi_translate_sense(struct scsi_sense *sense)
222 return - scsi_sense_to_errno(sense->key,
223 (sense->ascq & 0xFF00) >> 8,
227 /* Called (via iscsi_service) with QemuMutex held. */
229 iscsi_co_generic_cb(struct iscsi_context *iscsi, int status,
230 void *command_data, void *opaque)
232 struct IscsiTask *iTask = opaque;
233 struct scsi_task *task = command_data;
235 iTask->status = status;
239 if (status != SCSI_STATUS_GOOD) {
240 if (iTask->retries++ < ISCSI_CMD_RETRIES) {
241 if (status == SCSI_STATUS_CHECK_CONDITION
242 && task->sense.key == SCSI_SENSE_UNIT_ATTENTION) {
243 error_report("iSCSI CheckCondition: %s",
244 iscsi_get_error(iscsi));
248 if (status == SCSI_STATUS_BUSY ||
249 status == SCSI_STATUS_TIMEOUT ||
250 status == SCSI_STATUS_TASK_SET_FULL) {
251 unsigned retry_time =
252 exp_random(iscsi_retry_times[iTask->retries - 1]);
253 if (status == SCSI_STATUS_TIMEOUT) {
254 /* make sure the request is rescheduled AFTER the
255 * reconnect is initiated */
256 retry_time = EVENT_INTERVAL * 2;
257 iTask->iscsilun->request_timed_out = true;
259 error_report("iSCSI Busy/TaskSetFull/TimeOut"
260 " (retry #%u in %u ms): %s",
261 iTask->retries, retry_time,
262 iscsi_get_error(iscsi));
263 aio_timer_init(iTask->iscsilun->aio_context,
264 &iTask->retry_timer, QEMU_CLOCK_REALTIME,
265 SCALE_MS, iscsi_retry_timer_expired, iTask);
266 timer_mod(&iTask->retry_timer,
267 qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + retry_time);
272 iTask->err_code = iscsi_translate_sense(&task->sense);
273 iTask->err_str = g_strdup(iscsi_get_error(iscsi));
278 aio_bh_schedule_oneshot(iTask->iscsilun->aio_context,
279 iscsi_co_generic_bh_cb, iTask);
285 static void iscsi_co_init_iscsitask(IscsiLun *iscsilun, struct IscsiTask *iTask)
287 *iTask = (struct IscsiTask) {
288 .co = qemu_coroutine_self(),
289 .iscsilun = iscsilun,
294 iscsi_abort_task_cb(struct iscsi_context *iscsi, int status, void *command_data,
297 IscsiAIOCB *acb = private_data;
299 acb->status = -ECANCELED;
300 iscsi_schedule_bh(acb);
304 iscsi_aio_cancel(BlockAIOCB *blockacb)
306 IscsiAIOCB *acb = (IscsiAIOCB *)blockacb;
307 IscsiLun *iscsilun = acb->iscsilun;
309 if (acb->status != -EINPROGRESS) {
313 /* send a task mgmt call to the target to cancel the task on the target */
314 iscsi_task_mgmt_abort_task_async(iscsilun->iscsi, acb->task,
315 iscsi_abort_task_cb, acb);
319 static const AIOCBInfo iscsi_aiocb_info = {
320 .aiocb_size = sizeof(IscsiAIOCB),
321 .cancel_async = iscsi_aio_cancel,
325 static void iscsi_process_read(void *arg);
326 static void iscsi_process_write(void *arg);
328 /* Called with QemuMutex held. */
330 iscsi_set_events(IscsiLun *iscsilun)
332 struct iscsi_context *iscsi = iscsilun->iscsi;
333 int ev = iscsi_which_events(iscsi);
335 if (ev != iscsilun->events) {
336 aio_set_fd_handler(iscsilun->aio_context, iscsi_get_fd(iscsi),
338 (ev & POLLIN) ? iscsi_process_read : NULL,
339 (ev & POLLOUT) ? iscsi_process_write : NULL,
342 iscsilun->events = ev;
346 static void iscsi_timed_check_events(void *opaque)
348 IscsiLun *iscsilun = opaque;
350 /* check for timed out requests */
351 iscsi_service(iscsilun->iscsi, 0);
353 if (iscsilun->request_timed_out) {
354 iscsilun->request_timed_out = false;
355 iscsi_reconnect(iscsilun->iscsi);
358 /* newer versions of libiscsi may return zero events. Ensure we are able
359 * to return to service once this situation changes. */
360 iscsi_set_events(iscsilun);
362 timer_mod(iscsilun->event_timer,
363 qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + EVENT_INTERVAL);
367 iscsi_process_read(void *arg)
369 IscsiLun *iscsilun = arg;
370 struct iscsi_context *iscsi = iscsilun->iscsi;
372 qemu_mutex_lock(&iscsilun->mutex);
373 iscsi_service(iscsi, POLLIN);
374 iscsi_set_events(iscsilun);
375 qemu_mutex_unlock(&iscsilun->mutex);
379 iscsi_process_write(void *arg)
381 IscsiLun *iscsilun = arg;
382 struct iscsi_context *iscsi = iscsilun->iscsi;
384 qemu_mutex_lock(&iscsilun->mutex);
385 iscsi_service(iscsi, POLLOUT);
386 iscsi_set_events(iscsilun);
387 qemu_mutex_unlock(&iscsilun->mutex);
390 static int64_t sector_lun2qemu(int64_t sector, IscsiLun *iscsilun)
392 return sector * iscsilun->block_size / BDRV_SECTOR_SIZE;
395 static int64_t sector_qemu2lun(int64_t sector, IscsiLun *iscsilun)
397 return sector * BDRV_SECTOR_SIZE / iscsilun->block_size;
400 static bool is_byte_request_lun_aligned(int64_t offset, int count,
403 if (offset % iscsilun->block_size || count % iscsilun->block_size) {
404 error_report("iSCSI misaligned request: "
405 "iscsilun->block_size %u, offset %" PRIi64
407 iscsilun->block_size, offset, count);
413 static bool is_sector_request_lun_aligned(int64_t sector_num, int nb_sectors,
416 assert(nb_sectors <= BDRV_REQUEST_MAX_SECTORS);
417 return is_byte_request_lun_aligned(sector_num << BDRV_SECTOR_BITS,
418 nb_sectors << BDRV_SECTOR_BITS,
422 static void iscsi_allocmap_free(IscsiLun *iscsilun)
424 g_free(iscsilun->allocmap);
425 g_free(iscsilun->allocmap_valid);
426 iscsilun->allocmap = NULL;
427 iscsilun->allocmap_valid = NULL;
431 static int iscsi_allocmap_init(IscsiLun *iscsilun, int open_flags)
433 iscsi_allocmap_free(iscsilun);
435 assert(iscsilun->cluster_size);
436 iscsilun->allocmap_size =
437 DIV_ROUND_UP(iscsilun->num_blocks * iscsilun->block_size,
438 iscsilun->cluster_size);
440 iscsilun->allocmap = bitmap_try_new(iscsilun->allocmap_size);
441 if (!iscsilun->allocmap) {
445 if (open_flags & BDRV_O_NOCACHE) {
446 /* when cache.direct = on all allocmap entries are
447 * treated as invalid to force a relookup of the block
448 * status on every read request */
452 iscsilun->allocmap_valid = bitmap_try_new(iscsilun->allocmap_size);
453 if (!iscsilun->allocmap_valid) {
454 /* if we are under memory pressure free the allocmap as well */
455 iscsi_allocmap_free(iscsilun);
463 iscsi_allocmap_update(IscsiLun *iscsilun, int64_t offset,
464 int64_t bytes, bool allocated, bool valid)
466 int64_t cl_num_expanded, nb_cls_expanded, cl_num_shrunk, nb_cls_shrunk;
468 if (iscsilun->allocmap == NULL) {
471 /* expand to entirely contain all affected clusters */
472 assert(iscsilun->cluster_size);
473 cl_num_expanded = offset / iscsilun->cluster_size;
474 nb_cls_expanded = DIV_ROUND_UP(offset + bytes,
475 iscsilun->cluster_size) - cl_num_expanded;
476 /* shrink to touch only completely contained clusters */
477 cl_num_shrunk = DIV_ROUND_UP(offset, iscsilun->cluster_size);
478 nb_cls_shrunk = (offset + bytes) / iscsilun->cluster_size - cl_num_shrunk;
480 bitmap_set(iscsilun->allocmap, cl_num_expanded, nb_cls_expanded);
482 if (nb_cls_shrunk > 0) {
483 bitmap_clear(iscsilun->allocmap, cl_num_shrunk, nb_cls_shrunk);
487 if (iscsilun->allocmap_valid == NULL) {
491 if (nb_cls_shrunk > 0) {
492 bitmap_set(iscsilun->allocmap_valid, cl_num_shrunk, nb_cls_shrunk);
495 bitmap_clear(iscsilun->allocmap_valid, cl_num_expanded,
501 iscsi_allocmap_set_allocated(IscsiLun *iscsilun, int64_t offset,
504 iscsi_allocmap_update(iscsilun, offset, bytes, true, true);
508 iscsi_allocmap_set_unallocated(IscsiLun *iscsilun, int64_t offset,
511 /* Note: if cache.direct=on the fifth argument to iscsi_allocmap_update
512 * is ignored, so this will in effect be an iscsi_allocmap_set_invalid.
514 iscsi_allocmap_update(iscsilun, offset, bytes, false, true);
517 static void iscsi_allocmap_set_invalid(IscsiLun *iscsilun, int64_t offset,
520 iscsi_allocmap_update(iscsilun, offset, bytes, false, false);
523 static void iscsi_allocmap_invalidate(IscsiLun *iscsilun)
525 if (iscsilun->allocmap) {
526 bitmap_zero(iscsilun->allocmap, iscsilun->allocmap_size);
528 if (iscsilun->allocmap_valid) {
529 bitmap_zero(iscsilun->allocmap_valid, iscsilun->allocmap_size);
534 iscsi_allocmap_is_allocated(IscsiLun *iscsilun, int64_t offset,
538 if (iscsilun->allocmap == NULL) {
541 assert(iscsilun->cluster_size);
542 size = DIV_ROUND_UP(offset + bytes, iscsilun->cluster_size);
543 return !(find_next_bit(iscsilun->allocmap, size,
544 offset / iscsilun->cluster_size) == size);
547 static inline bool iscsi_allocmap_is_valid(IscsiLun *iscsilun,
548 int64_t offset, int64_t bytes)
551 if (iscsilun->allocmap_valid == NULL) {
554 assert(iscsilun->cluster_size);
555 size = DIV_ROUND_UP(offset + bytes, iscsilun->cluster_size);
556 return (find_next_zero_bit(iscsilun->allocmap_valid, size,
557 offset / iscsilun->cluster_size) == size);
560 static void coroutine_fn iscsi_co_wait_for_task(IscsiTask *iTask,
563 while (!iTask->complete) {
564 iscsi_set_events(iscsilun);
565 qemu_mutex_unlock(&iscsilun->mutex);
566 qemu_coroutine_yield();
567 qemu_mutex_lock(&iscsilun->mutex);
571 static int coroutine_fn
572 iscsi_co_writev(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
573 QEMUIOVector *iov, int flags)
575 IscsiLun *iscsilun = bs->opaque;
576 struct IscsiTask iTask;
578 uint32_t num_sectors;
579 bool fua = flags & BDRV_REQ_FUA;
583 assert(iscsilun->dpofua);
585 if (!is_sector_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
589 if (bs->bl.max_transfer) {
590 assert(nb_sectors << BDRV_SECTOR_BITS <= bs->bl.max_transfer);
593 lba = sector_qemu2lun(sector_num, iscsilun);
594 num_sectors = sector_qemu2lun(nb_sectors, iscsilun);
595 iscsi_co_init_iscsitask(iscsilun, &iTask);
596 qemu_mutex_lock(&iscsilun->mutex);
598 if (iscsilun->use_16_for_rw) {
599 #if LIBISCSI_API_VERSION >= (20160603)
600 iTask.task = iscsi_write16_iov_task(iscsilun->iscsi, iscsilun->lun, lba,
601 NULL, num_sectors * iscsilun->block_size,
602 iscsilun->block_size, 0, 0, fua, 0, 0,
603 iscsi_co_generic_cb, &iTask,
604 (struct scsi_iovec *)iov->iov, iov->niov);
606 iTask.task = iscsi_write10_iov_task(iscsilun->iscsi, iscsilun->lun, lba,
607 NULL, num_sectors * iscsilun->block_size,
608 iscsilun->block_size, 0, 0, fua, 0, 0,
609 iscsi_co_generic_cb, &iTask,
610 (struct scsi_iovec *)iov->iov, iov->niov);
613 iTask.task = iscsi_write16_task(iscsilun->iscsi, iscsilun->lun, lba,
614 NULL, num_sectors * iscsilun->block_size,
615 iscsilun->block_size, 0, 0, fua, 0, 0,
616 iscsi_co_generic_cb, &iTask);
618 iTask.task = iscsi_write10_task(iscsilun->iscsi, iscsilun->lun, lba,
619 NULL, num_sectors * iscsilun->block_size,
620 iscsilun->block_size, 0, 0, fua, 0, 0,
621 iscsi_co_generic_cb, &iTask);
624 if (iTask.task == NULL) {
625 qemu_mutex_unlock(&iscsilun->mutex);
628 #if LIBISCSI_API_VERSION < (20160603)
629 scsi_task_set_iov_out(iTask.task, (struct scsi_iovec *) iov->iov,
632 iscsi_co_wait_for_task(&iTask, iscsilun);
634 if (iTask.task != NULL) {
635 scsi_free_scsi_task(iTask.task);
639 if (iTask.do_retry) {
644 if (iTask.status != SCSI_STATUS_GOOD) {
645 iscsi_allocmap_set_invalid(iscsilun, sector_num * BDRV_SECTOR_SIZE,
646 nb_sectors * BDRV_SECTOR_SIZE);
647 error_report("iSCSI WRITE10/16 failed at lba %" PRIu64 ": %s", lba,
653 iscsi_allocmap_set_allocated(iscsilun, sector_num * BDRV_SECTOR_SIZE,
654 nb_sectors * BDRV_SECTOR_SIZE);
657 qemu_mutex_unlock(&iscsilun->mutex);
658 g_free(iTask.err_str);
664 static int coroutine_fn iscsi_co_block_status(BlockDriverState *bs,
665 bool want_zero, int64_t offset,
666 int64_t bytes, int64_t *pnum,
668 BlockDriverState **file)
670 IscsiLun *iscsilun = bs->opaque;
671 struct scsi_get_lba_status *lbas = NULL;
672 struct scsi_lba_status_descriptor *lbasd = NULL;
673 struct IscsiTask iTask;
677 iscsi_co_init_iscsitask(iscsilun, &iTask);
679 assert(QEMU_IS_ALIGNED(offset | bytes, iscsilun->block_size));
681 /* default to all sectors allocated */
682 ret = BDRV_BLOCK_DATA | BDRV_BLOCK_OFFSET_VALID;
688 /* LUN does not support logical block provisioning */
689 if (!iscsilun->lbpme) {
693 lba = offset / iscsilun->block_size;
695 qemu_mutex_lock(&iscsilun->mutex);
697 if (iscsi_get_lba_status_task(iscsilun->iscsi, iscsilun->lun,
698 lba, 8 + 16, iscsi_co_generic_cb,
703 iscsi_co_wait_for_task(&iTask, iscsilun);
705 if (iTask.do_retry) {
706 if (iTask.task != NULL) {
707 scsi_free_scsi_task(iTask.task);
714 if (iTask.status != SCSI_STATUS_GOOD) {
715 /* in case the get_lba_status_callout fails (i.e.
716 * because the device is busy or the cmd is not
717 * supported) we pretend all blocks are allocated
718 * for backwards compatibility */
719 error_report("iSCSI GET_LBA_STATUS failed at lba %" PRIu64 ": %s",
724 lbas = scsi_datain_unmarshall(iTask.task);
730 lbasd = &lbas->descriptors[0];
732 if (lba != lbasd->lba) {
737 *pnum = (int64_t) lbasd->num_blocks * iscsilun->block_size;
739 if (lbasd->provisioning == SCSI_PROVISIONING_TYPE_DEALLOCATED ||
740 lbasd->provisioning == SCSI_PROVISIONING_TYPE_ANCHORED) {
741 ret &= ~BDRV_BLOCK_DATA;
742 if (iscsilun->lbprz) {
743 ret |= BDRV_BLOCK_ZERO;
747 if (ret & BDRV_BLOCK_ZERO) {
748 iscsi_allocmap_set_unallocated(iscsilun, offset, *pnum);
750 iscsi_allocmap_set_allocated(iscsilun, offset, *pnum);
757 qemu_mutex_unlock(&iscsilun->mutex);
758 g_free(iTask.err_str);
760 if (iTask.task != NULL) {
761 scsi_free_scsi_task(iTask.task);
763 if (ret > 0 && ret & BDRV_BLOCK_OFFSET_VALID && file) {
769 static int coroutine_fn iscsi_co_readv(BlockDriverState *bs,
770 int64_t sector_num, int nb_sectors,
773 IscsiLun *iscsilun = bs->opaque;
774 struct IscsiTask iTask;
776 uint32_t num_sectors;
779 if (!is_sector_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
783 if (bs->bl.max_transfer) {
784 assert(nb_sectors << BDRV_SECTOR_BITS <= bs->bl.max_transfer);
787 /* if cache.direct is off and we have a valid entry in our allocation map
788 * we can skip checking the block status and directly return zeroes if
789 * the request falls within an unallocated area */
790 if (iscsi_allocmap_is_valid(iscsilun, sector_num * BDRV_SECTOR_SIZE,
791 nb_sectors * BDRV_SECTOR_SIZE) &&
792 !iscsi_allocmap_is_allocated(iscsilun, sector_num * BDRV_SECTOR_SIZE,
793 nb_sectors * BDRV_SECTOR_SIZE)) {
794 qemu_iovec_memset(iov, 0, 0x00, iov->size);
798 if (nb_sectors >= ISCSI_CHECKALLOC_THRES &&
799 !iscsi_allocmap_is_valid(iscsilun, sector_num * BDRV_SECTOR_SIZE,
800 nb_sectors * BDRV_SECTOR_SIZE) &&
801 !iscsi_allocmap_is_allocated(iscsilun, sector_num * BDRV_SECTOR_SIZE,
802 nb_sectors * BDRV_SECTOR_SIZE)) {
804 /* check the block status from the beginning of the cluster
805 * containing the start sector */
809 assert(iscsilun->cluster_size);
810 head = (sector_num * BDRV_SECTOR_SIZE) % iscsilun->cluster_size;
811 ret = iscsi_co_block_status(bs, true,
812 sector_num * BDRV_SECTOR_SIZE - head,
813 BDRV_REQUEST_MAX_BYTES, &pnum, NULL, NULL);
817 /* if the whole request falls into an unallocated area we can avoid
818 * reading and directly return zeroes instead */
819 if (ret & BDRV_BLOCK_ZERO &&
820 pnum >= nb_sectors * BDRV_SECTOR_SIZE + head) {
821 qemu_iovec_memset(iov, 0, 0x00, iov->size);
826 lba = sector_qemu2lun(sector_num, iscsilun);
827 num_sectors = sector_qemu2lun(nb_sectors, iscsilun);
829 iscsi_co_init_iscsitask(iscsilun, &iTask);
830 qemu_mutex_lock(&iscsilun->mutex);
832 if (iscsilun->use_16_for_rw) {
833 #if LIBISCSI_API_VERSION >= (20160603)
834 iTask.task = iscsi_read16_iov_task(iscsilun->iscsi, iscsilun->lun, lba,
835 num_sectors * iscsilun->block_size,
836 iscsilun->block_size, 0, 0, 0, 0, 0,
837 iscsi_co_generic_cb, &iTask,
838 (struct scsi_iovec *)iov->iov, iov->niov);
840 iTask.task = iscsi_read10_iov_task(iscsilun->iscsi, iscsilun->lun, lba,
841 num_sectors * iscsilun->block_size,
842 iscsilun->block_size,
844 iscsi_co_generic_cb, &iTask,
845 (struct scsi_iovec *)iov->iov, iov->niov);
848 iTask.task = iscsi_read16_task(iscsilun->iscsi, iscsilun->lun, lba,
849 num_sectors * iscsilun->block_size,
850 iscsilun->block_size, 0, 0, 0, 0, 0,
851 iscsi_co_generic_cb, &iTask);
853 iTask.task = iscsi_read10_task(iscsilun->iscsi, iscsilun->lun, lba,
854 num_sectors * iscsilun->block_size,
855 iscsilun->block_size,
857 iscsi_co_generic_cb, &iTask);
860 if (iTask.task == NULL) {
861 qemu_mutex_unlock(&iscsilun->mutex);
864 #if LIBISCSI_API_VERSION < (20160603)
865 scsi_task_set_iov_in(iTask.task, (struct scsi_iovec *) iov->iov, iov->niov);
868 iscsi_co_wait_for_task(&iTask, iscsilun);
869 if (iTask.task != NULL) {
870 scsi_free_scsi_task(iTask.task);
874 if (iTask.do_retry) {
879 if (iTask.status != SCSI_STATUS_GOOD) {
880 error_report("iSCSI READ10/16 failed at lba %" PRIu64 ": %s",
885 qemu_mutex_unlock(&iscsilun->mutex);
886 g_free(iTask.err_str);
890 static int coroutine_fn iscsi_co_flush(BlockDriverState *bs)
892 IscsiLun *iscsilun = bs->opaque;
893 struct IscsiTask iTask;
896 iscsi_co_init_iscsitask(iscsilun, &iTask);
897 qemu_mutex_lock(&iscsilun->mutex);
899 if (iscsi_synchronizecache10_task(iscsilun->iscsi, iscsilun->lun, 0, 0, 0,
900 0, iscsi_co_generic_cb, &iTask) == NULL) {
901 qemu_mutex_unlock(&iscsilun->mutex);
905 iscsi_co_wait_for_task(&iTask, iscsilun);
907 if (iTask.task != NULL) {
908 scsi_free_scsi_task(iTask.task);
912 if (iTask.do_retry) {
917 if (iTask.status != SCSI_STATUS_GOOD) {
918 error_report("iSCSI SYNCHRONIZECACHE10 failed: %s", iTask.err_str);
922 qemu_mutex_unlock(&iscsilun->mutex);
923 g_free(iTask.err_str);
928 /* Called (via iscsi_service) with QemuMutex held. */
930 iscsi_aio_ioctl_cb(struct iscsi_context *iscsi, int status,
931 void *command_data, void *opaque)
933 IscsiAIOCB *acb = opaque;
940 error_report("Failed to ioctl(SG_IO) to iSCSI lun. %s",
941 iscsi_get_error(iscsi));
942 acb->status = iscsi_translate_sense(&acb->task->sense);
945 acb->ioh->driver_status = 0;
946 acb->ioh->host_status = 0;
948 acb->ioh->status = status;
950 #define SG_ERR_DRIVER_SENSE 0x08
952 if (status == SCSI_STATUS_CHECK_CONDITION && acb->task->datain.size >= 2) {
955 acb->ioh->driver_status |= SG_ERR_DRIVER_SENSE;
957 acb->ioh->sb_len_wr = acb->task->datain.size - 2;
958 ss = (acb->ioh->mx_sb_len >= acb->ioh->sb_len_wr) ?
959 acb->ioh->mx_sb_len : acb->ioh->sb_len_wr;
960 memcpy(acb->ioh->sbp, &acb->task->datain.data[2], ss);
963 iscsi_schedule_bh(acb);
966 static void iscsi_ioctl_bh_completion(void *opaque)
968 IscsiAIOCB *acb = opaque;
970 qemu_bh_delete(acb->bh);
971 acb->common.cb(acb->common.opaque, acb->ret);
975 static void iscsi_ioctl_handle_emulated(IscsiAIOCB *acb, int req, void *buf)
977 BlockDriverState *bs = acb->common.bs;
978 IscsiLun *iscsilun = bs->opaque;
982 case SG_GET_VERSION_NUM:
986 ((struct sg_scsi_id *)buf)->scsi_type = iscsilun->type;
992 acb->bh = aio_bh_new(bdrv_get_aio_context(bs),
993 iscsi_ioctl_bh_completion, acb);
995 qemu_bh_schedule(acb->bh);
998 static BlockAIOCB *iscsi_aio_ioctl(BlockDriverState *bs,
999 unsigned long int req, void *buf,
1000 BlockCompletionFunc *cb, void *opaque)
1002 IscsiLun *iscsilun = bs->opaque;
1003 struct iscsi_context *iscsi = iscsilun->iscsi;
1004 struct iscsi_data data;
1007 acb = qemu_aio_get(&iscsi_aiocb_info, bs, cb, opaque);
1009 acb->iscsilun = iscsilun;
1011 acb->status = -EINPROGRESS;
1016 iscsi_ioctl_handle_emulated(acb, req, buf);
1017 return &acb->common;
1020 if (acb->ioh->cmd_len > SCSI_CDB_MAX_SIZE) {
1021 error_report("iSCSI: ioctl error CDB exceeds max size (%d > %d)",
1022 acb->ioh->cmd_len, SCSI_CDB_MAX_SIZE);
1023 qemu_aio_unref(acb);
1027 acb->task = malloc(sizeof(struct scsi_task));
1028 if (acb->task == NULL) {
1029 error_report("iSCSI: Failed to allocate task for scsi command. %s",
1030 iscsi_get_error(iscsi));
1031 qemu_aio_unref(acb);
1034 memset(acb->task, 0, sizeof(struct scsi_task));
1036 switch (acb->ioh->dxfer_direction) {
1037 case SG_DXFER_TO_DEV:
1038 acb->task->xfer_dir = SCSI_XFER_WRITE;
1040 case SG_DXFER_FROM_DEV:
1041 acb->task->xfer_dir = SCSI_XFER_READ;
1044 acb->task->xfer_dir = SCSI_XFER_NONE;
1048 acb->task->cdb_size = acb->ioh->cmd_len;
1049 memcpy(&acb->task->cdb[0], acb->ioh->cmdp, acb->ioh->cmd_len);
1050 acb->task->expxferlen = acb->ioh->dxfer_len;
1053 qemu_mutex_lock(&iscsilun->mutex);
1054 if (acb->task->xfer_dir == SCSI_XFER_WRITE) {
1055 if (acb->ioh->iovec_count == 0) {
1056 data.data = acb->ioh->dxferp;
1057 data.size = acb->ioh->dxfer_len;
1059 scsi_task_set_iov_out(acb->task,
1060 (struct scsi_iovec *) acb->ioh->dxferp,
1061 acb->ioh->iovec_count);
1065 if (iscsi_scsi_command_async(iscsi, iscsilun->lun, acb->task,
1067 (data.size > 0) ? &data : NULL,
1069 qemu_mutex_unlock(&iscsilun->mutex);
1070 scsi_free_scsi_task(acb->task);
1071 qemu_aio_unref(acb);
1075 /* tell libiscsi to read straight into the buffer we got from ioctl */
1076 if (acb->task->xfer_dir == SCSI_XFER_READ) {
1077 if (acb->ioh->iovec_count == 0) {
1078 scsi_task_add_data_in_buffer(acb->task,
1079 acb->ioh->dxfer_len,
1082 scsi_task_set_iov_in(acb->task,
1083 (struct scsi_iovec *) acb->ioh->dxferp,
1084 acb->ioh->iovec_count);
1088 iscsi_set_events(iscsilun);
1089 qemu_mutex_unlock(&iscsilun->mutex);
1091 return &acb->common;
1097 iscsi_getlength(BlockDriverState *bs)
1099 IscsiLun *iscsilun = bs->opaque;
1102 len = iscsilun->num_blocks;
1103 len *= iscsilun->block_size;
1109 coroutine_fn iscsi_co_pdiscard(BlockDriverState *bs, int64_t offset, int bytes)
1111 IscsiLun *iscsilun = bs->opaque;
1112 struct IscsiTask iTask;
1113 struct unmap_list list;
1116 if (!is_byte_request_lun_aligned(offset, bytes, iscsilun)) {
1120 if (!iscsilun->lbp.lbpu) {
1121 /* UNMAP is not supported by the target */
1125 list.lba = offset / iscsilun->block_size;
1126 list.num = bytes / iscsilun->block_size;
1128 iscsi_co_init_iscsitask(iscsilun, &iTask);
1129 qemu_mutex_lock(&iscsilun->mutex);
1131 if (iscsi_unmap_task(iscsilun->iscsi, iscsilun->lun, 0, 0, &list, 1,
1132 iscsi_co_generic_cb, &iTask) == NULL) {
1137 iscsi_co_wait_for_task(&iTask, iscsilun);
1139 if (iTask.task != NULL) {
1140 scsi_free_scsi_task(iTask.task);
1144 if (iTask.do_retry) {
1149 iscsi_allocmap_set_invalid(iscsilun, offset, bytes);
1151 if (iTask.status == SCSI_STATUS_CHECK_CONDITION) {
1152 /* the target might fail with a check condition if it
1153 is not happy with the alignment of the UNMAP request
1154 we silently fail in this case */
1158 if (iTask.status != SCSI_STATUS_GOOD) {
1159 error_report("iSCSI UNMAP failed at lba %" PRIu64 ": %s",
1160 list.lba, iTask.err_str);
1166 qemu_mutex_unlock(&iscsilun->mutex);
1167 g_free(iTask.err_str);
1172 coroutine_fn iscsi_co_pwrite_zeroes(BlockDriverState *bs, int64_t offset,
1173 int bytes, BdrvRequestFlags flags)
1175 IscsiLun *iscsilun = bs->opaque;
1176 struct IscsiTask iTask;
1179 bool use_16_for_ws = iscsilun->use_16_for_rw;
1182 if (!is_byte_request_lun_aligned(offset, bytes, iscsilun)) {
1186 if (flags & BDRV_REQ_MAY_UNMAP) {
1187 if (!use_16_for_ws && !iscsilun->lbp.lbpws10) {
1188 /* WRITESAME10 with UNMAP is unsupported try WRITESAME16 */
1189 use_16_for_ws = true;
1191 if (use_16_for_ws && !iscsilun->lbp.lbpws) {
1192 /* WRITESAME16 with UNMAP is not supported by the target,
1193 * fall back and try WRITESAME10/16 without UNMAP */
1194 flags &= ~BDRV_REQ_MAY_UNMAP;
1195 use_16_for_ws = iscsilun->use_16_for_rw;
1199 if (!(flags & BDRV_REQ_MAY_UNMAP) && !iscsilun->has_write_same) {
1200 /* WRITESAME without UNMAP is not supported by the target */
1204 lba = offset / iscsilun->block_size;
1205 nb_blocks = bytes / iscsilun->block_size;
1207 if (iscsilun->zeroblock == NULL) {
1208 iscsilun->zeroblock = g_try_malloc0(iscsilun->block_size);
1209 if (iscsilun->zeroblock == NULL) {
1214 qemu_mutex_lock(&iscsilun->mutex);
1215 iscsi_co_init_iscsitask(iscsilun, &iTask);
1217 if (use_16_for_ws) {
1218 iTask.task = iscsi_writesame16_task(iscsilun->iscsi, iscsilun->lun, lba,
1219 iscsilun->zeroblock, iscsilun->block_size,
1220 nb_blocks, 0, !!(flags & BDRV_REQ_MAY_UNMAP),
1221 0, 0, iscsi_co_generic_cb, &iTask);
1223 iTask.task = iscsi_writesame10_task(iscsilun->iscsi, iscsilun->lun, lba,
1224 iscsilun->zeroblock, iscsilun->block_size,
1225 nb_blocks, 0, !!(flags & BDRV_REQ_MAY_UNMAP),
1226 0, 0, iscsi_co_generic_cb, &iTask);
1228 if (iTask.task == NULL) {
1229 qemu_mutex_unlock(&iscsilun->mutex);
1233 iscsi_co_wait_for_task(&iTask, iscsilun);
1235 if (iTask.status == SCSI_STATUS_CHECK_CONDITION &&
1236 iTask.task->sense.key == SCSI_SENSE_ILLEGAL_REQUEST &&
1237 (iTask.task->sense.ascq == SCSI_SENSE_ASCQ_INVALID_OPERATION_CODE ||
1238 iTask.task->sense.ascq == SCSI_SENSE_ASCQ_INVALID_FIELD_IN_CDB)) {
1239 /* WRITE SAME is not supported by the target */
1240 iscsilun->has_write_same = false;
1241 scsi_free_scsi_task(iTask.task);
1246 if (iTask.task != NULL) {
1247 scsi_free_scsi_task(iTask.task);
1251 if (iTask.do_retry) {
1256 if (iTask.status != SCSI_STATUS_GOOD) {
1257 iscsi_allocmap_set_invalid(iscsilun, offset, bytes);
1258 error_report("iSCSI WRITESAME10/16 failed at lba %" PRIu64 ": %s",
1259 lba, iTask.err_str);
1264 if (flags & BDRV_REQ_MAY_UNMAP) {
1265 iscsi_allocmap_set_invalid(iscsilun, offset, bytes);
1267 iscsi_allocmap_set_allocated(iscsilun, offset, bytes);
1271 qemu_mutex_unlock(&iscsilun->mutex);
1272 g_free(iTask.err_str);
1276 static void apply_chap(struct iscsi_context *iscsi, QemuOpts *opts,
1279 const char *user = NULL;
1280 const char *password = NULL;
1281 const char *secretid;
1282 char *secret = NULL;
1284 user = qemu_opt_get(opts, "user");
1289 secretid = qemu_opt_get(opts, "password-secret");
1290 password = qemu_opt_get(opts, "password");
1291 if (secretid && password) {
1292 error_setg(errp, "'password' and 'password-secret' properties are "
1293 "mutually exclusive");
1297 secret = qcrypto_secret_lookup_as_utf8(secretid, errp);
1302 } else if (!password) {
1303 error_setg(errp, "CHAP username specified but no password was given");
1307 if (iscsi_set_initiator_username_pwd(iscsi, user, password)) {
1308 error_setg(errp, "Failed to set initiator username and password");
1314 static void apply_header_digest(struct iscsi_context *iscsi, QemuOpts *opts,
1317 const char *digest = NULL;
1319 digest = qemu_opt_get(opts, "header-digest");
1321 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE_CRC32C);
1322 } else if (!strcmp(digest, "crc32c")) {
1323 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_CRC32C);
1324 } else if (!strcmp(digest, "none")) {
1325 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE);
1326 } else if (!strcmp(digest, "crc32c-none")) {
1327 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_CRC32C_NONE);
1328 } else if (!strcmp(digest, "none-crc32c")) {
1329 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE_CRC32C);
1331 error_setg(errp, "Invalid header-digest setting : %s", digest);
1335 static char *get_initiator_name(QemuOpts *opts)
1339 UuidInfo *uuid_info;
1341 name = qemu_opt_get(opts, "initiator-name");
1343 return g_strdup(name);
1346 uuid_info = qmp_query_uuid(NULL);
1347 if (strcmp(uuid_info->UUID, UUID_NONE) == 0) {
1348 name = qemu_get_vm_name();
1350 name = uuid_info->UUID;
1352 iscsi_name = g_strdup_printf("iqn.2008-11.org.linux-kvm%s%s",
1353 name ? ":" : "", name ? name : "");
1354 qapi_free_UuidInfo(uuid_info);
1358 static void iscsi_nop_timed_event(void *opaque)
1360 IscsiLun *iscsilun = opaque;
1362 qemu_mutex_lock(&iscsilun->mutex);
1363 if (iscsi_get_nops_in_flight(iscsilun->iscsi) >= MAX_NOP_FAILURES) {
1364 error_report("iSCSI: NOP timeout. Reconnecting...");
1365 iscsilun->request_timed_out = true;
1366 } else if (iscsi_nop_out_async(iscsilun->iscsi, NULL, NULL, 0, NULL) != 0) {
1367 error_report("iSCSI: failed to sent NOP-Out. Disabling NOP messages.");
1371 timer_mod(iscsilun->nop_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + NOP_INTERVAL);
1372 iscsi_set_events(iscsilun);
1375 qemu_mutex_unlock(&iscsilun->mutex);
1378 static void iscsi_readcapacity_sync(IscsiLun *iscsilun, Error **errp)
1380 struct scsi_task *task = NULL;
1381 struct scsi_readcapacity10 *rc10 = NULL;
1382 struct scsi_readcapacity16 *rc16 = NULL;
1383 int retries = ISCSI_CMD_RETRIES;
1387 scsi_free_scsi_task(task);
1391 switch (iscsilun->type) {
1393 task = iscsi_readcapacity16_sync(iscsilun->iscsi, iscsilun->lun);
1394 if (task != NULL && task->status == SCSI_STATUS_GOOD) {
1395 rc16 = scsi_datain_unmarshall(task);
1397 error_setg(errp, "iSCSI: Failed to unmarshall readcapacity16 data.");
1399 iscsilun->block_size = rc16->block_length;
1400 iscsilun->num_blocks = rc16->returned_lba + 1;
1401 iscsilun->lbpme = !!rc16->lbpme;
1402 iscsilun->lbprz = !!rc16->lbprz;
1403 iscsilun->use_16_for_rw = (rc16->returned_lba > 0xffffffff);
1407 if (task != NULL && task->status == SCSI_STATUS_CHECK_CONDITION
1408 && task->sense.key == SCSI_SENSE_UNIT_ATTENTION) {
1411 /* Fall through and try READ CAPACITY(10) instead. */
1413 task = iscsi_readcapacity10_sync(iscsilun->iscsi, iscsilun->lun, 0, 0);
1414 if (task != NULL && task->status == SCSI_STATUS_GOOD) {
1415 rc10 = scsi_datain_unmarshall(task);
1417 error_setg(errp, "iSCSI: Failed to unmarshall readcapacity10 data.");
1419 iscsilun->block_size = rc10->block_size;
1420 if (rc10->lba == 0) {
1421 /* blank disk loaded */
1422 iscsilun->num_blocks = 0;
1424 iscsilun->num_blocks = rc10->lba + 1;
1432 } while (task != NULL && task->status == SCSI_STATUS_CHECK_CONDITION
1433 && task->sense.key == SCSI_SENSE_UNIT_ATTENTION
1436 if (task == NULL || task->status != SCSI_STATUS_GOOD) {
1437 error_setg(errp, "iSCSI: failed to send readcapacity10/16 command");
1438 } else if (!iscsilun->block_size ||
1439 iscsilun->block_size % BDRV_SECTOR_SIZE) {
1440 error_setg(errp, "iSCSI: the target returned an invalid "
1441 "block size of %d.", iscsilun->block_size);
1444 scsi_free_scsi_task(task);
1448 static struct scsi_task *iscsi_do_inquiry(struct iscsi_context *iscsi, int lun,
1449 int evpd, int pc, void **inq, Error **errp)
1452 struct scsi_task *task = NULL;
1453 task = iscsi_inquiry_sync(iscsi, lun, evpd, pc, 64);
1454 if (task == NULL || task->status != SCSI_STATUS_GOOD) {
1457 full_size = scsi_datain_getfullsize(task);
1458 if (full_size > task->datain.size) {
1459 scsi_free_scsi_task(task);
1461 /* we need more data for the full list */
1462 task = iscsi_inquiry_sync(iscsi, lun, evpd, pc, full_size);
1463 if (task == NULL || task->status != SCSI_STATUS_GOOD) {
1468 *inq = scsi_datain_unmarshall(task);
1470 error_setg(errp, "iSCSI: failed to unmarshall inquiry datain blob");
1477 error_setg(errp, "iSCSI: Inquiry command failed : %s",
1478 iscsi_get_error(iscsi));
1481 scsi_free_scsi_task(task);
1486 static void iscsi_detach_aio_context(BlockDriverState *bs)
1488 IscsiLun *iscsilun = bs->opaque;
1490 aio_set_fd_handler(iscsilun->aio_context, iscsi_get_fd(iscsilun->iscsi),
1491 false, NULL, NULL, NULL, NULL);
1492 iscsilun->events = 0;
1494 if (iscsilun->nop_timer) {
1495 timer_del(iscsilun->nop_timer);
1496 timer_free(iscsilun->nop_timer);
1497 iscsilun->nop_timer = NULL;
1499 if (iscsilun->event_timer) {
1500 timer_del(iscsilun->event_timer);
1501 timer_free(iscsilun->event_timer);
1502 iscsilun->event_timer = NULL;
1506 static void iscsi_attach_aio_context(BlockDriverState *bs,
1507 AioContext *new_context)
1509 IscsiLun *iscsilun = bs->opaque;
1511 iscsilun->aio_context = new_context;
1512 iscsi_set_events(iscsilun);
1514 /* Set up a timer for sending out iSCSI NOPs */
1515 iscsilun->nop_timer = aio_timer_new(iscsilun->aio_context,
1516 QEMU_CLOCK_REALTIME, SCALE_MS,
1517 iscsi_nop_timed_event, iscsilun);
1518 timer_mod(iscsilun->nop_timer,
1519 qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + NOP_INTERVAL);
1521 /* Set up a timer for periodic calls to iscsi_set_events and to
1522 * scan for command timeout */
1523 iscsilun->event_timer = aio_timer_new(iscsilun->aio_context,
1524 QEMU_CLOCK_REALTIME, SCALE_MS,
1525 iscsi_timed_check_events, iscsilun);
1526 timer_mod(iscsilun->event_timer,
1527 qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + EVENT_INTERVAL);
1530 static void iscsi_modesense_sync(IscsiLun *iscsilun)
1532 struct scsi_task *task;
1533 struct scsi_mode_sense *ms = NULL;
1534 iscsilun->write_protected = false;
1535 iscsilun->dpofua = false;
1537 task = iscsi_modesense6_sync(iscsilun->iscsi, iscsilun->lun,
1538 1, SCSI_MODESENSE_PC_CURRENT,
1541 error_report("iSCSI: Failed to send MODE_SENSE(6) command: %s",
1542 iscsi_get_error(iscsilun->iscsi));
1546 if (task->status != SCSI_STATUS_GOOD) {
1547 error_report("iSCSI: Failed MODE_SENSE(6), LUN assumed writable");
1550 ms = scsi_datain_unmarshall(task);
1552 error_report("iSCSI: Failed to unmarshall MODE_SENSE(6) data: %s",
1553 iscsi_get_error(iscsilun->iscsi));
1556 iscsilun->write_protected = ms->device_specific_parameter & 0x80;
1557 iscsilun->dpofua = ms->device_specific_parameter & 0x10;
1561 scsi_free_scsi_task(task);
1565 static void iscsi_parse_iscsi_option(const char *target, QDict *options)
1569 const char *user, *password, *password_secret, *initiator_name,
1570 *header_digest, *timeout;
1572 list = qemu_find_opts("iscsi");
1577 opts = qemu_opts_find(list, target);
1579 opts = QTAILQ_FIRST(&list->head);
1585 user = qemu_opt_get(opts, "user");
1587 qdict_set_default_str(options, "user", user);
1590 password = qemu_opt_get(opts, "password");
1592 qdict_set_default_str(options, "password", password);
1595 password_secret = qemu_opt_get(opts, "password-secret");
1596 if (password_secret) {
1597 qdict_set_default_str(options, "password-secret", password_secret);
1600 initiator_name = qemu_opt_get(opts, "initiator-name");
1601 if (initiator_name) {
1602 qdict_set_default_str(options, "initiator-name", initiator_name);
1605 header_digest = qemu_opt_get(opts, "header-digest");
1606 if (header_digest) {
1607 /* -iscsi takes upper case values, but QAPI only supports lower case
1608 * enum constant names, so we have to convert here. */
1609 char *qapi_value = g_ascii_strdown(header_digest, -1);
1610 qdict_set_default_str(options, "header-digest", qapi_value);
1614 timeout = qemu_opt_get(opts, "timeout");
1616 qdict_set_default_str(options, "timeout", timeout);
1621 * We support iscsi url's on the form
1622 * iscsi://[<username>%<password>@]<host>[:<port>]/<targetname>/<lun>
1624 static void iscsi_parse_filename(const char *filename, QDict *options,
1627 struct iscsi_url *iscsi_url;
1628 const char *transport_name;
1631 iscsi_url = iscsi_parse_full_url(NULL, filename);
1632 if (iscsi_url == NULL) {
1633 error_setg(errp, "Failed to parse URL : %s", filename);
1637 #if LIBISCSI_API_VERSION >= (20160603)
1638 switch (iscsi_url->transport) {
1640 transport_name = "tcp";
1642 case ISER_TRANSPORT:
1643 transport_name = "iser";
1646 error_setg(errp, "Unknown transport type (%d)",
1647 iscsi_url->transport);
1651 transport_name = "tcp";
1654 qdict_set_default_str(options, "transport", transport_name);
1655 qdict_set_default_str(options, "portal", iscsi_url->portal);
1656 qdict_set_default_str(options, "target", iscsi_url->target);
1658 lun_str = g_strdup_printf("%d", iscsi_url->lun);
1659 qdict_set_default_str(options, "lun", lun_str);
1662 /* User/password from -iscsi take precedence over those from the URL */
1663 iscsi_parse_iscsi_option(iscsi_url->target, options);
1665 if (iscsi_url->user[0] != '\0') {
1666 qdict_set_default_str(options, "user", iscsi_url->user);
1667 qdict_set_default_str(options, "password", iscsi_url->passwd);
1670 iscsi_destroy_url(iscsi_url);
1673 static QemuOptsList runtime_opts = {
1675 .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
1678 .name = "transport",
1679 .type = QEMU_OPT_STRING,
1683 .type = QEMU_OPT_STRING,
1687 .type = QEMU_OPT_STRING,
1691 .type = QEMU_OPT_STRING,
1695 .type = QEMU_OPT_STRING,
1698 .name = "password-secret",
1699 .type = QEMU_OPT_STRING,
1703 .type = QEMU_OPT_NUMBER,
1706 .name = "initiator-name",
1707 .type = QEMU_OPT_STRING,
1710 .name = "header-digest",
1711 .type = QEMU_OPT_STRING,
1715 .type = QEMU_OPT_NUMBER,
1717 { /* end of list */ }
1721 static void iscsi_save_designator(IscsiLun *lun,
1722 struct scsi_inquiry_device_identification *inq_di)
1724 struct scsi_inquiry_device_designator *desig, *copy = NULL;
1726 for (desig = inq_di->designators; desig; desig = desig->next) {
1727 if (desig->association ||
1728 desig->designator_type > SCSI_DESIGNATOR_TYPE_NAA) {
1731 /* NAA works better than T10 vendor ID based designator. */
1732 if (!copy || copy->designator_type < desig->designator_type) {
1737 lun->dd = g_new(struct scsi_inquiry_device_designator, 1);
1739 lun->dd->next = NULL;
1740 lun->dd->designator = g_malloc(copy->designator_length);
1741 memcpy(lun->dd->designator, copy->designator, copy->designator_length);
1745 static int iscsi_open(BlockDriverState *bs, QDict *options, int flags,
1748 IscsiLun *iscsilun = bs->opaque;
1749 struct iscsi_context *iscsi = NULL;
1750 struct scsi_task *task = NULL;
1751 struct scsi_inquiry_standard *inq = NULL;
1752 struct scsi_inquiry_supported_pages *inq_vpd;
1753 char *initiator_name = NULL;
1755 Error *local_err = NULL;
1756 const char *transport_name, *portal, *target;
1757 #if LIBISCSI_API_VERSION >= (20160603)
1758 enum iscsi_transport_type transport;
1760 int i, ret = 0, timeout = 0, lun;
1762 opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
1763 qemu_opts_absorb_qdict(opts, options, &local_err);
1765 error_propagate(errp, local_err);
1770 transport_name = qemu_opt_get(opts, "transport");
1771 portal = qemu_opt_get(opts, "portal");
1772 target = qemu_opt_get(opts, "target");
1773 lun = qemu_opt_get_number(opts, "lun", 0);
1775 if (!transport_name || !portal || !target) {
1776 error_setg(errp, "Need all of transport, portal and target options");
1781 if (!strcmp(transport_name, "tcp")) {
1782 #if LIBISCSI_API_VERSION >= (20160603)
1783 transport = TCP_TRANSPORT;
1784 } else if (!strcmp(transport_name, "iser")) {
1785 transport = ISER_TRANSPORT;
1787 /* TCP is what older libiscsi versions always use */
1790 error_setg(errp, "Unknown transport: %s", transport_name);
1795 memset(iscsilun, 0, sizeof(IscsiLun));
1797 initiator_name = get_initiator_name(opts);
1799 iscsi = iscsi_create_context(initiator_name);
1800 if (iscsi == NULL) {
1801 error_setg(errp, "iSCSI: Failed to create iSCSI context.");
1805 #if LIBISCSI_API_VERSION >= (20160603)
1806 if (iscsi_init_transport(iscsi, transport)) {
1807 error_setg(errp, ("Error initializing transport."));
1812 if (iscsi_set_targetname(iscsi, target)) {
1813 error_setg(errp, "iSCSI: Failed to set target name.");
1818 /* check if we got CHAP username/password via the options */
1819 apply_chap(iscsi, opts, &local_err);
1820 if (local_err != NULL) {
1821 error_propagate(errp, local_err);
1826 if (iscsi_set_session_type(iscsi, ISCSI_SESSION_NORMAL) != 0) {
1827 error_setg(errp, "iSCSI: Failed to set session type to normal.");
1832 /* check if we got HEADER_DIGEST via the options */
1833 apply_header_digest(iscsi, opts, &local_err);
1834 if (local_err != NULL) {
1835 error_propagate(errp, local_err);
1840 /* timeout handling is broken in libiscsi before 1.15.0 */
1841 timeout = qemu_opt_get_number(opts, "timeout", 0);
1842 #if LIBISCSI_API_VERSION >= 20150621
1843 iscsi_set_timeout(iscsi, timeout);
1846 error_report("iSCSI: ignoring timeout value for libiscsi <1.15.0");
1850 if (iscsi_full_connect_sync(iscsi, portal, lun) != 0) {
1851 error_setg(errp, "iSCSI: Failed to connect to LUN : %s",
1852 iscsi_get_error(iscsi));
1857 iscsilun->iscsi = iscsi;
1858 iscsilun->aio_context = bdrv_get_aio_context(bs);
1859 iscsilun->lun = lun;
1860 iscsilun->has_write_same = true;
1862 task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 0, 0,
1863 (void **) &inq, errp);
1868 iscsilun->type = inq->periperal_device_type;
1869 scsi_free_scsi_task(task);
1872 iscsi_modesense_sync(iscsilun);
1873 if (iscsilun->dpofua) {
1874 bs->supported_write_flags = BDRV_REQ_FUA;
1877 /* Check the write protect flag of the LUN if we want to write */
1878 if (iscsilun->type == TYPE_DISK && (flags & BDRV_O_RDWR) &&
1879 iscsilun->write_protected) {
1880 error_setg(errp, "Cannot open a write protected LUN as read-write");
1885 iscsi_readcapacity_sync(iscsilun, &local_err);
1886 if (local_err != NULL) {
1887 error_propagate(errp, local_err);
1891 bs->total_sectors = sector_lun2qemu(iscsilun->num_blocks, iscsilun);
1893 /* We don't have any emulation for devices other than disks and CD-ROMs, so
1894 * this must be sg ioctl compatible. We force it to be sg, otherwise qemu
1895 * will try to read from the device to guess the image format.
1897 if (iscsilun->type != TYPE_DISK && iscsilun->type != TYPE_ROM) {
1901 task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
1902 SCSI_INQUIRY_PAGECODE_SUPPORTED_VPD_PAGES,
1903 (void **) &inq_vpd, errp);
1908 for (i = 0; i < inq_vpd->num_pages; i++) {
1909 struct scsi_task *inq_task;
1910 struct scsi_inquiry_logical_block_provisioning *inq_lbp;
1911 struct scsi_inquiry_block_limits *inq_bl;
1912 struct scsi_inquiry_device_identification *inq_di;
1913 switch (inq_vpd->pages[i]) {
1914 case SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING:
1915 inq_task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
1916 SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING,
1917 (void **) &inq_lbp, errp);
1918 if (inq_task == NULL) {
1922 memcpy(&iscsilun->lbp, inq_lbp,
1923 sizeof(struct scsi_inquiry_logical_block_provisioning));
1924 scsi_free_scsi_task(inq_task);
1926 case SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS:
1927 inq_task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
1928 SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS,
1929 (void **) &inq_bl, errp);
1930 if (inq_task == NULL) {
1934 memcpy(&iscsilun->bl, inq_bl,
1935 sizeof(struct scsi_inquiry_block_limits));
1936 scsi_free_scsi_task(inq_task);
1938 case SCSI_INQUIRY_PAGECODE_DEVICE_IDENTIFICATION:
1939 inq_task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
1940 SCSI_INQUIRY_PAGECODE_DEVICE_IDENTIFICATION,
1941 (void **) &inq_di, errp);
1942 if (inq_task == NULL) {
1946 iscsi_save_designator(iscsilun, inq_di);
1947 scsi_free_scsi_task(inq_task);
1953 scsi_free_scsi_task(task);
1956 qemu_mutex_init(&iscsilun->mutex);
1957 iscsi_attach_aio_context(bs, iscsilun->aio_context);
1959 /* Guess the internal cluster (page) size of the iscsi target by the means
1960 * of opt_unmap_gran. Transfer the unmap granularity only if it has a
1961 * reasonable size */
1962 if (iscsilun->bl.opt_unmap_gran * iscsilun->block_size >= 4 * 1024 &&
1963 iscsilun->bl.opt_unmap_gran * iscsilun->block_size <= 16 * 1024 * 1024) {
1964 iscsilun->cluster_size = iscsilun->bl.opt_unmap_gran *
1965 iscsilun->block_size;
1966 if (iscsilun->lbprz) {
1967 ret = iscsi_allocmap_init(iscsilun, bs->open_flags);
1971 if (iscsilun->lbprz && iscsilun->lbp.lbpws) {
1972 bs->supported_zero_flags = BDRV_REQ_MAY_UNMAP;
1976 qemu_opts_del(opts);
1977 g_free(initiator_name);
1979 scsi_free_scsi_task(task);
1983 if (iscsi != NULL) {
1984 if (iscsi_is_logged_in(iscsi)) {
1985 iscsi_logout_sync(iscsi);
1987 iscsi_destroy_context(iscsi);
1989 memset(iscsilun, 0, sizeof(IscsiLun));
1995 static void iscsi_close(BlockDriverState *bs)
1997 IscsiLun *iscsilun = bs->opaque;
1998 struct iscsi_context *iscsi = iscsilun->iscsi;
2000 iscsi_detach_aio_context(bs);
2001 if (iscsi_is_logged_in(iscsi)) {
2002 iscsi_logout_sync(iscsi);
2004 iscsi_destroy_context(iscsi);
2006 g_free(iscsilun->dd->designator);
2007 g_free(iscsilun->dd);
2009 g_free(iscsilun->zeroblock);
2010 iscsi_allocmap_free(iscsilun);
2011 qemu_mutex_destroy(&iscsilun->mutex);
2012 memset(iscsilun, 0, sizeof(IscsiLun));
2015 static void iscsi_refresh_limits(BlockDriverState *bs, Error **errp)
2017 /* We don't actually refresh here, but just return data queried in
2018 * iscsi_open(): iscsi targets don't change their limits. */
2020 IscsiLun *iscsilun = bs->opaque;
2021 uint64_t max_xfer_len = iscsilun->use_16_for_rw ? 0xffffffff : 0xffff;
2022 unsigned int block_size = MAX(BDRV_SECTOR_SIZE, iscsilun->block_size);
2024 assert(iscsilun->block_size >= BDRV_SECTOR_SIZE || bs->sg);
2026 bs->bl.request_alignment = block_size;
2028 if (iscsilun->bl.max_xfer_len) {
2029 max_xfer_len = MIN(max_xfer_len, iscsilun->bl.max_xfer_len);
2032 if (max_xfer_len * block_size < INT_MAX) {
2033 bs->bl.max_transfer = max_xfer_len * iscsilun->block_size;
2036 if (iscsilun->lbp.lbpu) {
2037 if (iscsilun->bl.max_unmap < 0xffffffff / block_size) {
2038 bs->bl.max_pdiscard =
2039 iscsilun->bl.max_unmap * iscsilun->block_size;
2041 bs->bl.pdiscard_alignment =
2042 iscsilun->bl.opt_unmap_gran * iscsilun->block_size;
2044 bs->bl.pdiscard_alignment = iscsilun->block_size;
2047 if (iscsilun->bl.max_ws_len < 0xffffffff / block_size) {
2048 bs->bl.max_pwrite_zeroes =
2049 iscsilun->bl.max_ws_len * iscsilun->block_size;
2051 if (iscsilun->lbp.lbpws) {
2052 bs->bl.pwrite_zeroes_alignment =
2053 iscsilun->bl.opt_unmap_gran * iscsilun->block_size;
2055 bs->bl.pwrite_zeroes_alignment = iscsilun->block_size;
2057 if (iscsilun->bl.opt_xfer_len &&
2058 iscsilun->bl.opt_xfer_len < INT_MAX / block_size) {
2059 bs->bl.opt_transfer = pow2floor(iscsilun->bl.opt_xfer_len *
2060 iscsilun->block_size);
2064 /* Note that this will not re-establish a connection with an iSCSI target - it
2065 * is effectively a NOP. */
2066 static int iscsi_reopen_prepare(BDRVReopenState *state,
2067 BlockReopenQueue *queue, Error **errp)
2069 IscsiLun *iscsilun = state->bs->opaque;
2071 if (state->flags & BDRV_O_RDWR && iscsilun->write_protected) {
2072 error_setg(errp, "Cannot open a write protected LUN as read-write");
2078 static void iscsi_reopen_commit(BDRVReopenState *reopen_state)
2080 IscsiLun *iscsilun = reopen_state->bs->opaque;
2082 /* the cache.direct status might have changed */
2083 if (iscsilun->allocmap != NULL) {
2084 iscsi_allocmap_init(iscsilun, reopen_state->flags);
2088 static int coroutine_fn iscsi_co_truncate(BlockDriverState *bs, int64_t offset,
2089 PreallocMode prealloc, Error **errp)
2091 IscsiLun *iscsilun = bs->opaque;
2092 Error *local_err = NULL;
2094 if (prealloc != PREALLOC_MODE_OFF) {
2095 error_setg(errp, "Unsupported preallocation mode '%s'",
2096 PreallocMode_str(prealloc));
2100 if (iscsilun->type != TYPE_DISK) {
2101 error_setg(errp, "Cannot resize non-disk iSCSI devices");
2105 iscsi_readcapacity_sync(iscsilun, &local_err);
2106 if (local_err != NULL) {
2107 error_propagate(errp, local_err);
2111 if (offset > iscsi_getlength(bs)) {
2112 error_setg(errp, "Cannot grow iSCSI devices");
2116 if (iscsilun->allocmap != NULL) {
2117 iscsi_allocmap_init(iscsilun, bs->open_flags);
2123 static int coroutine_fn iscsi_co_create_opts(const char *filename, QemuOpts *opts,
2127 int64_t total_size = 0;
2128 BlockDriverState *bs;
2129 IscsiLun *iscsilun = NULL;
2131 Error *local_err = NULL;
2135 /* Read out options */
2136 total_size = DIV_ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
2138 bs->opaque = g_new0(struct IscsiLun, 1);
2139 iscsilun = bs->opaque;
2141 bs_options = qdict_new();
2142 iscsi_parse_filename(filename, bs_options, &local_err);
2144 error_propagate(errp, local_err);
2147 ret = iscsi_open(bs, bs_options, 0, NULL);
2149 qobject_unref(bs_options);
2154 iscsi_detach_aio_context(bs);
2155 if (iscsilun->type != TYPE_DISK) {
2159 if (bs->total_sectors < total_size) {
2166 if (iscsilun->iscsi != NULL) {
2167 iscsi_destroy_context(iscsilun->iscsi);
2175 static int iscsi_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
2177 IscsiLun *iscsilun = bs->opaque;
2178 bdi->unallocated_blocks_are_zero = iscsilun->lbprz;
2179 bdi->cluster_size = iscsilun->cluster_size;
2183 static void coroutine_fn iscsi_co_invalidate_cache(BlockDriverState *bs,
2186 IscsiLun *iscsilun = bs->opaque;
2187 iscsi_allocmap_invalidate(iscsilun);
2190 static int coroutine_fn iscsi_co_copy_range_from(BlockDriverState *bs,
2192 uint64_t src_offset,
2194 uint64_t dst_offset,
2196 BdrvRequestFlags read_flags,
2197 BdrvRequestFlags write_flags)
2199 return bdrv_co_copy_range_to(src, src_offset, dst, dst_offset, bytes,
2200 read_flags, write_flags);
2203 static struct scsi_task *iscsi_xcopy_task(int param_len)
2205 struct scsi_task *task;
2207 task = g_new0(struct scsi_task, 1);
2209 task->cdb[0] = EXTENDED_COPY;
2210 task->cdb[10] = (param_len >> 24) & 0xFF;
2211 task->cdb[11] = (param_len >> 16) & 0xFF;
2212 task->cdb[12] = (param_len >> 8) & 0xFF;
2213 task->cdb[13] = param_len & 0xFF;
2214 task->cdb_size = 16;
2215 task->xfer_dir = SCSI_XFER_WRITE;
2216 task->expxferlen = param_len;
2221 static void iscsi_populate_target_desc(unsigned char *desc, IscsiLun *lun)
2223 struct scsi_inquiry_device_designator *dd = lun->dd;
2225 memset(desc, 0, 32);
2226 desc[0] = 0xE4; /* IDENT_DESCR_TGT_DESCR */
2227 desc[4] = dd->code_set;
2228 desc[5] = (dd->designator_type & 0xF)
2229 | ((dd->association & 3) << 4);
2230 desc[7] = dd->designator_length;
2231 memcpy(desc + 8, dd->designator, MIN(dd->designator_length, 20));
2234 desc[29] = (lun->block_size >> 16) & 0xFF;
2235 desc[30] = (lun->block_size >> 8) & 0xFF;
2236 desc[31] = lun->block_size & 0xFF;
2239 static void iscsi_xcopy_desc_hdr(uint8_t *hdr, int dc, int cat, int src_index,
2242 hdr[0] = 0x02; /* BLK_TO_BLK_SEG_DESCR */
2243 hdr[1] = ((dc << 1) | cat) & 0xFF;
2244 hdr[2] = (XCOPY_BLK2BLK_SEG_DESC_SIZE >> 8) & 0xFF;
2245 /* don't account for the first 4 bytes in descriptor header*/
2246 hdr[3] = (XCOPY_BLK2BLK_SEG_DESC_SIZE - 4 /* SEG_DESC_SRC_INDEX_OFFSET */) & 0xFF;
2247 hdr[4] = (src_index >> 8) & 0xFF;
2248 hdr[5] = src_index & 0xFF;
2249 hdr[6] = (dst_index >> 8) & 0xFF;
2250 hdr[7] = dst_index & 0xFF;
2253 static void iscsi_xcopy_populate_desc(uint8_t *desc, int dc, int cat,
2254 int src_index, int dst_index, int num_blks,
2255 uint64_t src_lba, uint64_t dst_lba)
2257 iscsi_xcopy_desc_hdr(desc, dc, cat, src_index, dst_index);
2259 /* The caller should verify the request size */
2260 assert(num_blks < 65536);
2261 desc[10] = (num_blks >> 8) & 0xFF;
2262 desc[11] = num_blks & 0xFF;
2263 desc[12] = (src_lba >> 56) & 0xFF;
2264 desc[13] = (src_lba >> 48) & 0xFF;
2265 desc[14] = (src_lba >> 40) & 0xFF;
2266 desc[15] = (src_lba >> 32) & 0xFF;
2267 desc[16] = (src_lba >> 24) & 0xFF;
2268 desc[17] = (src_lba >> 16) & 0xFF;
2269 desc[18] = (src_lba >> 8) & 0xFF;
2270 desc[19] = src_lba & 0xFF;
2271 desc[20] = (dst_lba >> 56) & 0xFF;
2272 desc[21] = (dst_lba >> 48) & 0xFF;
2273 desc[22] = (dst_lba >> 40) & 0xFF;
2274 desc[23] = (dst_lba >> 32) & 0xFF;
2275 desc[24] = (dst_lba >> 24) & 0xFF;
2276 desc[25] = (dst_lba >> 16) & 0xFF;
2277 desc[26] = (dst_lba >> 8) & 0xFF;
2278 desc[27] = dst_lba & 0xFF;
2281 static void iscsi_xcopy_populate_header(unsigned char *buf, int list_id, int str,
2282 int list_id_usage, int prio,
2284 int seg_desc_len, int inline_data_len)
2287 buf[1] = ((str & 1) << 5) | ((list_id_usage & 3) << 3) | (prio & 7);
2288 buf[2] = (tgt_desc_len >> 8) & 0xFF;
2289 buf[3] = tgt_desc_len & 0xFF;
2290 buf[8] = (seg_desc_len >> 24) & 0xFF;
2291 buf[9] = (seg_desc_len >> 16) & 0xFF;
2292 buf[10] = (seg_desc_len >> 8) & 0xFF;
2293 buf[11] = seg_desc_len & 0xFF;
2294 buf[12] = (inline_data_len >> 24) & 0xFF;
2295 buf[13] = (inline_data_len >> 16) & 0xFF;
2296 buf[14] = (inline_data_len >> 8) & 0xFF;
2297 buf[15] = inline_data_len & 0xFF;
2300 static void iscsi_xcopy_data(struct iscsi_data *data,
2301 IscsiLun *src, int64_t src_lba,
2302 IscsiLun *dst, int64_t dst_lba,
2303 uint16_t num_blocks)
2306 const int src_offset = XCOPY_DESC_OFFSET;
2307 const int dst_offset = XCOPY_DESC_OFFSET + IDENT_DESCR_TGT_DESCR_SIZE;
2308 const int seg_offset = dst_offset + IDENT_DESCR_TGT_DESCR_SIZE;
2310 data->size = XCOPY_DESC_OFFSET +
2311 IDENT_DESCR_TGT_DESCR_SIZE * 2 +
2312 XCOPY_BLK2BLK_SEG_DESC_SIZE;
2313 data->data = g_malloc0(data->size);
2316 /* Initialise the parameter list header */
2317 iscsi_xcopy_populate_header(buf, 1, 0, 2 /* LIST_ID_USAGE_DISCARD */,
2318 0, 2 * IDENT_DESCR_TGT_DESCR_SIZE,
2319 XCOPY_BLK2BLK_SEG_DESC_SIZE,
2322 /* Initialise CSCD list with one src + one dst descriptor */
2323 iscsi_populate_target_desc(&buf[src_offset], src);
2324 iscsi_populate_target_desc(&buf[dst_offset], dst);
2326 /* Initialise one segment descriptor */
2327 iscsi_xcopy_populate_desc(&buf[seg_offset], 0, 0, 0, 1, num_blocks,
2331 static int coroutine_fn iscsi_co_copy_range_to(BlockDriverState *bs,
2333 uint64_t src_offset,
2335 uint64_t dst_offset,
2337 BdrvRequestFlags read_flags,
2338 BdrvRequestFlags write_flags)
2340 IscsiLun *dst_lun = dst->bs->opaque;
2342 struct IscsiTask iscsi_task;
2343 struct iscsi_data data;
2347 if (src->bs->drv->bdrv_co_copy_range_to != iscsi_co_copy_range_to) {
2350 src_lun = src->bs->opaque;
2352 if (!src_lun->dd || !dst_lun->dd) {
2355 if (!is_byte_request_lun_aligned(dst_offset, bytes, dst_lun)) {
2358 if (!is_byte_request_lun_aligned(src_offset, bytes, src_lun)) {
2361 if (dst_lun->block_size != src_lun->block_size ||
2362 !dst_lun->block_size) {
2366 block_size = dst_lun->block_size;
2367 if (bytes / block_size > 65535) {
2371 iscsi_xcopy_data(&data,
2372 src_lun, src_offset / block_size,
2373 dst_lun, dst_offset / block_size,
2374 bytes / block_size);
2376 iscsi_co_init_iscsitask(dst_lun, &iscsi_task);
2378 qemu_mutex_lock(&dst_lun->mutex);
2379 iscsi_task.task = iscsi_xcopy_task(data.size);
2381 if (iscsi_scsi_command_async(dst_lun->iscsi, dst_lun->lun,
2382 iscsi_task.task, iscsi_co_generic_cb,
2384 &iscsi_task) != 0) {
2389 iscsi_co_wait_for_task(&iscsi_task, dst_lun);
2391 if (iscsi_task.do_retry) {
2392 iscsi_task.complete = 0;
2396 if (iscsi_task.status != SCSI_STATUS_GOOD) {
2397 r = iscsi_task.err_code;
2402 g_free(iscsi_task.task);
2403 qemu_mutex_unlock(&dst_lun->mutex);
2404 g_free(iscsi_task.err_str);
2408 static QemuOptsList iscsi_create_opts = {
2409 .name = "iscsi-create-opts",
2410 .head = QTAILQ_HEAD_INITIALIZER(iscsi_create_opts.head),
2413 .name = BLOCK_OPT_SIZE,
2414 .type = QEMU_OPT_SIZE,
2415 .help = "Virtual disk size"
2417 { /* end of list */ }
2421 static BlockDriver bdrv_iscsi = {
2422 .format_name = "iscsi",
2423 .protocol_name = "iscsi",
2425 .instance_size = sizeof(IscsiLun),
2426 .bdrv_parse_filename = iscsi_parse_filename,
2427 .bdrv_file_open = iscsi_open,
2428 .bdrv_close = iscsi_close,
2429 .bdrv_co_create_opts = iscsi_co_create_opts,
2430 .create_opts = &iscsi_create_opts,
2431 .bdrv_reopen_prepare = iscsi_reopen_prepare,
2432 .bdrv_reopen_commit = iscsi_reopen_commit,
2433 .bdrv_co_invalidate_cache = iscsi_co_invalidate_cache,
2435 .bdrv_getlength = iscsi_getlength,
2436 .bdrv_get_info = iscsi_get_info,
2437 .bdrv_co_truncate = iscsi_co_truncate,
2438 .bdrv_refresh_limits = iscsi_refresh_limits,
2440 .bdrv_co_block_status = iscsi_co_block_status,
2441 .bdrv_co_pdiscard = iscsi_co_pdiscard,
2442 .bdrv_co_copy_range_from = iscsi_co_copy_range_from,
2443 .bdrv_co_copy_range_to = iscsi_co_copy_range_to,
2444 .bdrv_co_pwrite_zeroes = iscsi_co_pwrite_zeroes,
2445 .bdrv_co_readv = iscsi_co_readv,
2446 .bdrv_co_writev = iscsi_co_writev,
2447 .bdrv_co_flush_to_disk = iscsi_co_flush,
2450 .bdrv_aio_ioctl = iscsi_aio_ioctl,
2453 .bdrv_detach_aio_context = iscsi_detach_aio_context,
2454 .bdrv_attach_aio_context = iscsi_attach_aio_context,
2457 #if LIBISCSI_API_VERSION >= (20160603)
2458 static BlockDriver bdrv_iser = {
2459 .format_name = "iser",
2460 .protocol_name = "iser",
2462 .instance_size = sizeof(IscsiLun),
2463 .bdrv_parse_filename = iscsi_parse_filename,
2464 .bdrv_file_open = iscsi_open,
2465 .bdrv_close = iscsi_close,
2466 .bdrv_co_create_opts = iscsi_co_create_opts,
2467 .create_opts = &iscsi_create_opts,
2468 .bdrv_reopen_prepare = iscsi_reopen_prepare,
2469 .bdrv_reopen_commit = iscsi_reopen_commit,
2470 .bdrv_co_invalidate_cache = iscsi_co_invalidate_cache,
2472 .bdrv_getlength = iscsi_getlength,
2473 .bdrv_get_info = iscsi_get_info,
2474 .bdrv_co_truncate = iscsi_co_truncate,
2475 .bdrv_refresh_limits = iscsi_refresh_limits,
2477 .bdrv_co_block_status = iscsi_co_block_status,
2478 .bdrv_co_pdiscard = iscsi_co_pdiscard,
2479 .bdrv_co_copy_range_from = iscsi_co_copy_range_from,
2480 .bdrv_co_copy_range_to = iscsi_co_copy_range_to,
2481 .bdrv_co_pwrite_zeroes = iscsi_co_pwrite_zeroes,
2482 .bdrv_co_readv = iscsi_co_readv,
2483 .bdrv_co_writev = iscsi_co_writev,
2484 .bdrv_co_flush_to_disk = iscsi_co_flush,
2487 .bdrv_aio_ioctl = iscsi_aio_ioctl,
2490 .bdrv_detach_aio_context = iscsi_detach_aio_context,
2491 .bdrv_attach_aio_context = iscsi_attach_aio_context,
2495 static void iscsi_block_init(void)
2497 bdrv_register(&bdrv_iscsi);
2498 #if LIBISCSI_API_VERSION >= (20160603)
2499 bdrv_register(&bdrv_iser);
2503 block_init(iscsi_block_init);