2 * QEMU Block driver for iSCSI images
4 * Copyright (c) 2010-2011 Ronnie Sahlberg <ronniesahlberg@gmail.com>
5 * Copyright (c) 2012-2017 Peter Lieven <pl@kamp.de>
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
26 #include "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 "scsi/constants.h"
38 #include "qemu/option.h"
39 #include "qemu/uuid.h"
40 #include "qapi/error.h"
41 #include "qapi/qapi-commands-misc.h"
42 #include "qapi/qmp/qdict.h"
43 #include "qapi/qmp/qstring.h"
44 #include "crypto/secret.h"
45 #include "scsi/utils.h"
47 /* Conflict between scsi/utils.h and libiscsi! :( */
48 #define SCSI_XFER_NONE ISCSI_XFER_NONE
49 #include <iscsi/iscsi.h>
50 #include <iscsi/scsi-lowlevel.h>
52 QEMU_BUILD_BUG_ON((int)SCSI_XFER_NONE
!= (int)ISCSI_XFER_NONE
);
58 typedef struct IscsiLun
{
59 struct iscsi_context
*iscsi
;
60 AioContext
*aio_context
;
62 enum scsi_inquiry_peripheral_device_type type
;
67 QEMUTimer
*event_timer
;
69 struct scsi_inquiry_logical_block_provisioning lbp
;
70 struct scsi_inquiry_block_limits bl
;
71 struct scsi_inquiry_device_designator
*dd
;
72 unsigned char *zeroblock
;
73 /* The allocmap tracks which clusters (pages) on the iSCSI target are
74 * allocated and which are not. In case a target returns zeros for
75 * unallocated pages (iscsilun->lprz) we can directly return zeros instead
76 * of reading zeros over the wire if a read request falls within an
77 * unallocated block. As there are 3 possible states we need 2 bitmaps to
78 * track. allocmap_valid keeps track if QEMU's information about a page is
79 * valid. allocmap tracks if a page is allocated or not. In case QEMU has no
80 * valid information about a page the corresponding allocmap entry should be
81 * switched to unallocated as well to force a new lookup of the allocation
82 * status as lookups are generally skipped if a page is suspect to be
83 * allocated. If a iSCSI target is opened with cache.direct = on the
84 * allocmap_valid does not exist turning all cached information invalid so
85 * that a fresh lookup is made for any page even if allocmap entry returns
86 * it's unallocated. */
87 unsigned long *allocmap
;
88 unsigned long *allocmap_valid
;
97 bool request_timed_out
;
100 typedef struct IscsiTask
{
105 struct scsi_task
*task
;
108 QEMUTimer retry_timer
;
113 typedef struct IscsiAIOCB
{
117 struct scsi_task
*task
;
128 /* libiscsi uses time_t so its enough to process events every second */
129 #define EVENT_INTERVAL 1000
130 #define NOP_INTERVAL 5000
131 #define MAX_NOP_FAILURES 3
132 #define ISCSI_CMD_RETRIES ARRAY_SIZE(iscsi_retry_times)
133 static const unsigned iscsi_retry_times
[] = {8, 32, 128, 512, 2048, 8192, 32768};
135 /* this threshold is a trade-off knob to choose between
136 * the potential additional overhead of an extra GET_LBA_STATUS request
137 * vs. unnecessarily reading a lot of zero sectors over the wire.
138 * If a read request is greater or equal than ISCSI_CHECKALLOC_THRES
139 * sectors we check the allocation status of the area covered by the
140 * request first if the allocationmap indicates that the area might be
142 #define ISCSI_CHECKALLOC_THRES 64
149 qemu_bh_delete(acb
->bh
);
154 acb
->common
.cb(acb
->common
.opaque
, acb
->status
);
156 if (acb
->task
!= NULL
) {
157 scsi_free_scsi_task(acb
->task
);
165 iscsi_schedule_bh(IscsiAIOCB
*acb
)
170 acb
->bh
= aio_bh_new(acb
->iscsilun
->aio_context
, iscsi_bh_cb
, acb
);
171 qemu_bh_schedule(acb
->bh
);
174 static void iscsi_co_generic_bh_cb(void *opaque
)
176 struct IscsiTask
*iTask
= opaque
;
179 aio_co_wake(iTask
->co
);
182 static void iscsi_retry_timer_expired(void *opaque
)
184 struct IscsiTask
*iTask
= opaque
;
187 aio_co_wake(iTask
->co
);
191 static inline unsigned exp_random(double mean
)
193 return -mean
* log((double)rand() / RAND_MAX
);
196 /* SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST was introduced in
197 * libiscsi 1.10.0, together with other constants we need. Use it as
198 * a hint that we have to define them ourselves if needed, to keep the
199 * minimum required libiscsi version at 1.9.0. We use an ASCQ macro for
200 * the test because SCSI_STATUS_* is an enum.
202 * To guard against future changes where SCSI_SENSE_ASCQ_* also becomes
203 * an enum, check against the LIBISCSI_API_VERSION macro, which was
204 * introduced in 1.11.0. If it is present, there is no need to define
207 #if !defined(SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST) && \
208 !defined(LIBISCSI_API_VERSION)
209 #define SCSI_STATUS_TASK_SET_FULL 0x28
210 #define SCSI_STATUS_TIMEOUT 0x0f000002
211 #define SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST 0x2600
212 #define SCSI_SENSE_ASCQ_PARAMETER_LIST_LENGTH_ERROR 0x1a00
215 #ifndef LIBISCSI_API_VERSION
216 #define LIBISCSI_API_VERSION 20130701
219 static int iscsi_translate_sense(struct scsi_sense
*sense
)
221 return - scsi_sense_to_errno(sense
->key
,
222 (sense
->ascq
& 0xFF00) >> 8,
226 /* Called (via iscsi_service) with QemuMutex held. */
228 iscsi_co_generic_cb(struct iscsi_context
*iscsi
, int status
,
229 void *command_data
, void *opaque
)
231 struct IscsiTask
*iTask
= opaque
;
232 struct scsi_task
*task
= command_data
;
234 iTask
->status
= status
;
238 if (status
!= SCSI_STATUS_GOOD
) {
239 if (iTask
->retries
++ < ISCSI_CMD_RETRIES
) {
240 if (status
== SCSI_STATUS_CHECK_CONDITION
241 && task
->sense
.key
== SCSI_SENSE_UNIT_ATTENTION
) {
242 error_report("iSCSI CheckCondition: %s",
243 iscsi_get_error(iscsi
));
247 if (status
== SCSI_STATUS_BUSY
||
248 status
== SCSI_STATUS_TIMEOUT
||
249 status
== SCSI_STATUS_TASK_SET_FULL
) {
250 unsigned retry_time
=
251 exp_random(iscsi_retry_times
[iTask
->retries
- 1]);
252 if (status
== SCSI_STATUS_TIMEOUT
) {
253 /* make sure the request is rescheduled AFTER the
254 * reconnect is initiated */
255 retry_time
= EVENT_INTERVAL
* 2;
256 iTask
->iscsilun
->request_timed_out
= true;
258 error_report("iSCSI Busy/TaskSetFull/TimeOut"
259 " (retry #%u in %u ms): %s",
260 iTask
->retries
, retry_time
,
261 iscsi_get_error(iscsi
));
262 aio_timer_init(iTask
->iscsilun
->aio_context
,
263 &iTask
->retry_timer
, QEMU_CLOCK_REALTIME
,
264 SCALE_MS
, iscsi_retry_timer_expired
, iTask
);
265 timer_mod(&iTask
->retry_timer
,
266 qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) + retry_time
);
271 iTask
->err_code
= iscsi_translate_sense(&task
->sense
);
272 iTask
->err_str
= g_strdup(iscsi_get_error(iscsi
));
277 aio_bh_schedule_oneshot(iTask
->iscsilun
->aio_context
,
278 iscsi_co_generic_bh_cb
, iTask
);
284 static void iscsi_co_init_iscsitask(IscsiLun
*iscsilun
, struct IscsiTask
*iTask
)
286 *iTask
= (struct IscsiTask
) {
287 .co
= qemu_coroutine_self(),
288 .iscsilun
= iscsilun
,
293 iscsi_abort_task_cb(struct iscsi_context
*iscsi
, int status
, void *command_data
,
296 IscsiAIOCB
*acb
= private_data
;
298 acb
->status
= -ECANCELED
;
299 iscsi_schedule_bh(acb
);
303 iscsi_aio_cancel(BlockAIOCB
*blockacb
)
305 IscsiAIOCB
*acb
= (IscsiAIOCB
*)blockacb
;
306 IscsiLun
*iscsilun
= acb
->iscsilun
;
308 if (acb
->status
!= -EINPROGRESS
) {
312 /* send a task mgmt call to the target to cancel the task on the target */
313 iscsi_task_mgmt_abort_task_async(iscsilun
->iscsi
, acb
->task
,
314 iscsi_abort_task_cb
, acb
);
318 static const AIOCBInfo iscsi_aiocb_info
= {
319 .aiocb_size
= sizeof(IscsiAIOCB
),
320 .cancel_async
= iscsi_aio_cancel
,
324 static void iscsi_process_read(void *arg
);
325 static void iscsi_process_write(void *arg
);
327 /* Called with QemuMutex held. */
329 iscsi_set_events(IscsiLun
*iscsilun
)
331 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
332 int ev
= iscsi_which_events(iscsi
);
334 if (ev
!= iscsilun
->events
) {
335 aio_set_fd_handler(iscsilun
->aio_context
, iscsi_get_fd(iscsi
),
337 (ev
& POLLIN
) ? iscsi_process_read
: NULL
,
338 (ev
& POLLOUT
) ? iscsi_process_write
: NULL
,
341 iscsilun
->events
= ev
;
345 static void iscsi_timed_check_events(void *opaque
)
347 IscsiLun
*iscsilun
= opaque
;
349 /* check for timed out requests */
350 iscsi_service(iscsilun
->iscsi
, 0);
352 if (iscsilun
->request_timed_out
) {
353 iscsilun
->request_timed_out
= false;
354 iscsi_reconnect(iscsilun
->iscsi
);
357 /* newer versions of libiscsi may return zero events. Ensure we are able
358 * to return to service once this situation changes. */
359 iscsi_set_events(iscsilun
);
361 timer_mod(iscsilun
->event_timer
,
362 qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) + EVENT_INTERVAL
);
366 iscsi_process_read(void *arg
)
368 IscsiLun
*iscsilun
= arg
;
369 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
371 qemu_mutex_lock(&iscsilun
->mutex
);
372 iscsi_service(iscsi
, POLLIN
);
373 iscsi_set_events(iscsilun
);
374 qemu_mutex_unlock(&iscsilun
->mutex
);
378 iscsi_process_write(void *arg
)
380 IscsiLun
*iscsilun
= arg
;
381 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
383 qemu_mutex_lock(&iscsilun
->mutex
);
384 iscsi_service(iscsi
, POLLOUT
);
385 iscsi_set_events(iscsilun
);
386 qemu_mutex_unlock(&iscsilun
->mutex
);
389 static int64_t sector_lun2qemu(int64_t sector
, IscsiLun
*iscsilun
)
391 return sector
* iscsilun
->block_size
/ BDRV_SECTOR_SIZE
;
394 static int64_t sector_qemu2lun(int64_t sector
, IscsiLun
*iscsilun
)
396 return sector
* BDRV_SECTOR_SIZE
/ iscsilun
->block_size
;
399 static bool is_byte_request_lun_aligned(int64_t offset
, int count
,
402 if (offset
% iscsilun
->block_size
|| count
% iscsilun
->block_size
) {
403 error_report("iSCSI misaligned request: "
404 "iscsilun->block_size %u, offset %" PRIi64
406 iscsilun
->block_size
, offset
, count
);
412 static bool is_sector_request_lun_aligned(int64_t sector_num
, int nb_sectors
,
415 assert(nb_sectors
<= BDRV_REQUEST_MAX_SECTORS
);
416 return is_byte_request_lun_aligned(sector_num
<< BDRV_SECTOR_BITS
,
417 nb_sectors
<< BDRV_SECTOR_BITS
,
421 static void iscsi_allocmap_free(IscsiLun
*iscsilun
)
423 g_free(iscsilun
->allocmap
);
424 g_free(iscsilun
->allocmap_valid
);
425 iscsilun
->allocmap
= NULL
;
426 iscsilun
->allocmap_valid
= NULL
;
430 static int iscsi_allocmap_init(IscsiLun
*iscsilun
, int open_flags
)
432 iscsi_allocmap_free(iscsilun
);
434 assert(iscsilun
->cluster_size
);
435 iscsilun
->allocmap_size
=
436 DIV_ROUND_UP(iscsilun
->num_blocks
* iscsilun
->block_size
,
437 iscsilun
->cluster_size
);
439 iscsilun
->allocmap
= bitmap_try_new(iscsilun
->allocmap_size
);
440 if (!iscsilun
->allocmap
) {
444 if (open_flags
& BDRV_O_NOCACHE
) {
445 /* when cache.direct = on all allocmap entries are
446 * treated as invalid to force a relookup of the block
447 * status on every read request */
451 iscsilun
->allocmap_valid
= bitmap_try_new(iscsilun
->allocmap_size
);
452 if (!iscsilun
->allocmap_valid
) {
453 /* if we are under memory pressure free the allocmap as well */
454 iscsi_allocmap_free(iscsilun
);
462 iscsi_allocmap_update(IscsiLun
*iscsilun
, int64_t offset
,
463 int64_t bytes
, bool allocated
, bool valid
)
465 int64_t cl_num_expanded
, nb_cls_expanded
, cl_num_shrunk
, nb_cls_shrunk
;
467 if (iscsilun
->allocmap
== NULL
) {
470 /* expand to entirely contain all affected clusters */
471 assert(iscsilun
->cluster_size
);
472 cl_num_expanded
= offset
/ iscsilun
->cluster_size
;
473 nb_cls_expanded
= DIV_ROUND_UP(offset
+ bytes
,
474 iscsilun
->cluster_size
) - cl_num_expanded
;
475 /* shrink to touch only completely contained clusters */
476 cl_num_shrunk
= DIV_ROUND_UP(offset
, iscsilun
->cluster_size
);
477 nb_cls_shrunk
= (offset
+ bytes
) / iscsilun
->cluster_size
- cl_num_shrunk
;
479 bitmap_set(iscsilun
->allocmap
, cl_num_expanded
, nb_cls_expanded
);
481 if (nb_cls_shrunk
> 0) {
482 bitmap_clear(iscsilun
->allocmap
, cl_num_shrunk
, nb_cls_shrunk
);
486 if (iscsilun
->allocmap_valid
== NULL
) {
490 if (nb_cls_shrunk
> 0) {
491 bitmap_set(iscsilun
->allocmap_valid
, cl_num_shrunk
, nb_cls_shrunk
);
494 bitmap_clear(iscsilun
->allocmap_valid
, cl_num_expanded
,
500 iscsi_allocmap_set_allocated(IscsiLun
*iscsilun
, int64_t offset
,
503 iscsi_allocmap_update(iscsilun
, offset
, bytes
, true, true);
507 iscsi_allocmap_set_unallocated(IscsiLun
*iscsilun
, int64_t offset
,
510 /* Note: if cache.direct=on the fifth argument to iscsi_allocmap_update
511 * is ignored, so this will in effect be an iscsi_allocmap_set_invalid.
513 iscsi_allocmap_update(iscsilun
, offset
, bytes
, false, true);
516 static void iscsi_allocmap_set_invalid(IscsiLun
*iscsilun
, int64_t offset
,
519 iscsi_allocmap_update(iscsilun
, offset
, bytes
, false, false);
522 static void iscsi_allocmap_invalidate(IscsiLun
*iscsilun
)
524 if (iscsilun
->allocmap
) {
525 bitmap_zero(iscsilun
->allocmap
, iscsilun
->allocmap_size
);
527 if (iscsilun
->allocmap_valid
) {
528 bitmap_zero(iscsilun
->allocmap_valid
, iscsilun
->allocmap_size
);
533 iscsi_allocmap_is_allocated(IscsiLun
*iscsilun
, int64_t offset
,
537 if (iscsilun
->allocmap
== NULL
) {
540 assert(iscsilun
->cluster_size
);
541 size
= DIV_ROUND_UP(offset
+ bytes
, iscsilun
->cluster_size
);
542 return !(find_next_bit(iscsilun
->allocmap
, size
,
543 offset
/ iscsilun
->cluster_size
) == size
);
546 static inline bool iscsi_allocmap_is_valid(IscsiLun
*iscsilun
,
547 int64_t offset
, int64_t bytes
)
550 if (iscsilun
->allocmap_valid
== NULL
) {
553 assert(iscsilun
->cluster_size
);
554 size
= DIV_ROUND_UP(offset
+ bytes
, iscsilun
->cluster_size
);
555 return (find_next_zero_bit(iscsilun
->allocmap_valid
, size
,
556 offset
/ iscsilun
->cluster_size
) == size
);
559 static void coroutine_fn
iscsi_co_wait_for_task(IscsiTask
*iTask
,
562 while (!iTask
->complete
) {
563 iscsi_set_events(iscsilun
);
564 qemu_mutex_unlock(&iscsilun
->mutex
);
565 qemu_coroutine_yield();
566 qemu_mutex_lock(&iscsilun
->mutex
);
570 static int coroutine_fn
571 iscsi_co_writev(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
,
572 QEMUIOVector
*iov
, int flags
)
574 IscsiLun
*iscsilun
= bs
->opaque
;
575 struct IscsiTask iTask
;
577 uint32_t num_sectors
;
578 bool fua
= flags
& BDRV_REQ_FUA
;
582 assert(iscsilun
->dpofua
);
584 if (!is_sector_request_lun_aligned(sector_num
, nb_sectors
, iscsilun
)) {
588 if (bs
->bl
.max_transfer
) {
589 assert(nb_sectors
<< BDRV_SECTOR_BITS
<= bs
->bl
.max_transfer
);
592 lba
= sector_qemu2lun(sector_num
, iscsilun
);
593 num_sectors
= sector_qemu2lun(nb_sectors
, iscsilun
);
594 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
595 qemu_mutex_lock(&iscsilun
->mutex
);
597 if (iscsilun
->use_16_for_rw
) {
598 #if LIBISCSI_API_VERSION >= (20160603)
599 iTask
.task
= iscsi_write16_iov_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
600 NULL
, num_sectors
* iscsilun
->block_size
,
601 iscsilun
->block_size
, 0, 0, fua
, 0, 0,
602 iscsi_co_generic_cb
, &iTask
,
603 (struct scsi_iovec
*)iov
->iov
, iov
->niov
);
605 iTask
.task
= iscsi_write10_iov_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
606 NULL
, num_sectors
* iscsilun
->block_size
,
607 iscsilun
->block_size
, 0, 0, fua
, 0, 0,
608 iscsi_co_generic_cb
, &iTask
,
609 (struct scsi_iovec
*)iov
->iov
, iov
->niov
);
612 iTask
.task
= iscsi_write16_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
613 NULL
, num_sectors
* iscsilun
->block_size
,
614 iscsilun
->block_size
, 0, 0, fua
, 0, 0,
615 iscsi_co_generic_cb
, &iTask
);
617 iTask
.task
= iscsi_write10_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
618 NULL
, num_sectors
* iscsilun
->block_size
,
619 iscsilun
->block_size
, 0, 0, fua
, 0, 0,
620 iscsi_co_generic_cb
, &iTask
);
623 if (iTask
.task
== NULL
) {
624 qemu_mutex_unlock(&iscsilun
->mutex
);
627 #if LIBISCSI_API_VERSION < (20160603)
628 scsi_task_set_iov_out(iTask
.task
, (struct scsi_iovec
*) iov
->iov
,
631 iscsi_co_wait_for_task(&iTask
, iscsilun
);
633 if (iTask
.task
!= NULL
) {
634 scsi_free_scsi_task(iTask
.task
);
638 if (iTask
.do_retry
) {
643 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
644 iscsi_allocmap_set_invalid(iscsilun
, sector_num
* BDRV_SECTOR_SIZE
,
645 nb_sectors
* BDRV_SECTOR_SIZE
);
646 error_report("iSCSI WRITE10/16 failed at lba %" PRIu64
": %s", lba
,
652 iscsi_allocmap_set_allocated(iscsilun
, sector_num
* BDRV_SECTOR_SIZE
,
653 nb_sectors
* BDRV_SECTOR_SIZE
);
656 qemu_mutex_unlock(&iscsilun
->mutex
);
657 g_free(iTask
.err_str
);
663 static int coroutine_fn
iscsi_co_block_status(BlockDriverState
*bs
,
664 bool want_zero
, int64_t offset
,
665 int64_t bytes
, int64_t *pnum
,
667 BlockDriverState
**file
)
669 IscsiLun
*iscsilun
= bs
->opaque
;
670 struct scsi_get_lba_status
*lbas
= NULL
;
671 struct scsi_lba_status_descriptor
*lbasd
= NULL
;
672 struct IscsiTask iTask
;
676 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
678 assert(QEMU_IS_ALIGNED(offset
| bytes
, iscsilun
->block_size
));
680 /* default to all sectors allocated */
681 ret
= BDRV_BLOCK_DATA
| BDRV_BLOCK_OFFSET_VALID
;
687 /* LUN does not support logical block provisioning */
688 if (!iscsilun
->lbpme
) {
692 lba
= offset
/ iscsilun
->block_size
;
694 qemu_mutex_lock(&iscsilun
->mutex
);
696 if (iscsi_get_lba_status_task(iscsilun
->iscsi
, iscsilun
->lun
,
697 lba
, 8 + 16, iscsi_co_generic_cb
,
702 iscsi_co_wait_for_task(&iTask
, iscsilun
);
704 if (iTask
.do_retry
) {
705 if (iTask
.task
!= NULL
) {
706 scsi_free_scsi_task(iTask
.task
);
713 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
714 /* in case the get_lba_status_callout fails (i.e.
715 * because the device is busy or the cmd is not
716 * supported) we pretend all blocks are allocated
717 * for backwards compatibility */
718 error_report("iSCSI GET_LBA_STATUS failed at lba %" PRIu64
": %s",
723 lbas
= scsi_datain_unmarshall(iTask
.task
);
729 lbasd
= &lbas
->descriptors
[0];
731 if (lba
!= lbasd
->lba
) {
736 *pnum
= lbasd
->num_blocks
* iscsilun
->block_size
;
738 if (lbasd
->provisioning
== SCSI_PROVISIONING_TYPE_DEALLOCATED
||
739 lbasd
->provisioning
== SCSI_PROVISIONING_TYPE_ANCHORED
) {
740 ret
&= ~BDRV_BLOCK_DATA
;
741 if (iscsilun
->lbprz
) {
742 ret
|= BDRV_BLOCK_ZERO
;
746 if (ret
& BDRV_BLOCK_ZERO
) {
747 iscsi_allocmap_set_unallocated(iscsilun
, offset
, *pnum
);
749 iscsi_allocmap_set_allocated(iscsilun
, offset
, *pnum
);
756 qemu_mutex_unlock(&iscsilun
->mutex
);
757 g_free(iTask
.err_str
);
759 if (iTask
.task
!= NULL
) {
760 scsi_free_scsi_task(iTask
.task
);
762 if (ret
> 0 && ret
& BDRV_BLOCK_OFFSET_VALID
&& file
) {
768 static int coroutine_fn
iscsi_co_readv(BlockDriverState
*bs
,
769 int64_t sector_num
, int nb_sectors
,
772 IscsiLun
*iscsilun
= bs
->opaque
;
773 struct IscsiTask iTask
;
775 uint32_t num_sectors
;
778 if (!is_sector_request_lun_aligned(sector_num
, nb_sectors
, iscsilun
)) {
782 if (bs
->bl
.max_transfer
) {
783 assert(nb_sectors
<< BDRV_SECTOR_BITS
<= bs
->bl
.max_transfer
);
786 /* if cache.direct is off and we have a valid entry in our allocation map
787 * we can skip checking the block status and directly return zeroes if
788 * the request falls within an unallocated area */
789 if (iscsi_allocmap_is_valid(iscsilun
, sector_num
* BDRV_SECTOR_SIZE
,
790 nb_sectors
* BDRV_SECTOR_SIZE
) &&
791 !iscsi_allocmap_is_allocated(iscsilun
, sector_num
* BDRV_SECTOR_SIZE
,
792 nb_sectors
* BDRV_SECTOR_SIZE
)) {
793 qemu_iovec_memset(iov
, 0, 0x00, iov
->size
);
797 if (nb_sectors
>= ISCSI_CHECKALLOC_THRES
&&
798 !iscsi_allocmap_is_valid(iscsilun
, sector_num
* BDRV_SECTOR_SIZE
,
799 nb_sectors
* BDRV_SECTOR_SIZE
) &&
800 !iscsi_allocmap_is_allocated(iscsilun
, sector_num
* BDRV_SECTOR_SIZE
,
801 nb_sectors
* BDRV_SECTOR_SIZE
)) {
803 /* check the block status from the beginning of the cluster
804 * containing the start sector */
808 assert(iscsilun
->cluster_size
);
809 head
= (sector_num
* BDRV_SECTOR_SIZE
) % iscsilun
->cluster_size
;
810 ret
= iscsi_co_block_status(bs
, true,
811 sector_num
* BDRV_SECTOR_SIZE
- head
,
812 BDRV_REQUEST_MAX_BYTES
, &pnum
, NULL
, NULL
);
816 /* if the whole request falls into an unallocated area we can avoid
817 * reading and directly return zeroes instead */
818 if (ret
& BDRV_BLOCK_ZERO
&&
819 pnum
>= nb_sectors
* BDRV_SECTOR_SIZE
+ head
) {
820 qemu_iovec_memset(iov
, 0, 0x00, iov
->size
);
825 lba
= sector_qemu2lun(sector_num
, iscsilun
);
826 num_sectors
= sector_qemu2lun(nb_sectors
, iscsilun
);
828 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
829 qemu_mutex_lock(&iscsilun
->mutex
);
831 if (iscsilun
->use_16_for_rw
) {
832 #if LIBISCSI_API_VERSION >= (20160603)
833 iTask
.task
= iscsi_read16_iov_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
834 num_sectors
* iscsilun
->block_size
,
835 iscsilun
->block_size
, 0, 0, 0, 0, 0,
836 iscsi_co_generic_cb
, &iTask
,
837 (struct scsi_iovec
*)iov
->iov
, iov
->niov
);
839 iTask
.task
= iscsi_read10_iov_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
840 num_sectors
* iscsilun
->block_size
,
841 iscsilun
->block_size
,
843 iscsi_co_generic_cb
, &iTask
,
844 (struct scsi_iovec
*)iov
->iov
, iov
->niov
);
847 iTask
.task
= iscsi_read16_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
848 num_sectors
* iscsilun
->block_size
,
849 iscsilun
->block_size
, 0, 0, 0, 0, 0,
850 iscsi_co_generic_cb
, &iTask
);
852 iTask
.task
= iscsi_read10_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
853 num_sectors
* iscsilun
->block_size
,
854 iscsilun
->block_size
,
856 iscsi_co_generic_cb
, &iTask
);
859 if (iTask
.task
== NULL
) {
860 qemu_mutex_unlock(&iscsilun
->mutex
);
863 #if LIBISCSI_API_VERSION < (20160603)
864 scsi_task_set_iov_in(iTask
.task
, (struct scsi_iovec
*) iov
->iov
, iov
->niov
);
867 iscsi_co_wait_for_task(&iTask
, iscsilun
);
868 if (iTask
.task
!= NULL
) {
869 scsi_free_scsi_task(iTask
.task
);
873 if (iTask
.do_retry
) {
878 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
879 error_report("iSCSI READ10/16 failed at lba %" PRIu64
": %s",
884 qemu_mutex_unlock(&iscsilun
->mutex
);
885 g_free(iTask
.err_str
);
889 static int coroutine_fn
iscsi_co_flush(BlockDriverState
*bs
)
891 IscsiLun
*iscsilun
= bs
->opaque
;
892 struct IscsiTask iTask
;
895 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
896 qemu_mutex_lock(&iscsilun
->mutex
);
898 if (iscsi_synchronizecache10_task(iscsilun
->iscsi
, iscsilun
->lun
, 0, 0, 0,
899 0, iscsi_co_generic_cb
, &iTask
) == NULL
) {
900 qemu_mutex_unlock(&iscsilun
->mutex
);
904 iscsi_co_wait_for_task(&iTask
, iscsilun
);
906 if (iTask
.task
!= NULL
) {
907 scsi_free_scsi_task(iTask
.task
);
911 if (iTask
.do_retry
) {
916 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
917 error_report("iSCSI SYNCHRONIZECACHE10 failed: %s", iTask
.err_str
);
921 qemu_mutex_unlock(&iscsilun
->mutex
);
922 g_free(iTask
.err_str
);
927 /* Called (via iscsi_service) with QemuMutex held. */
929 iscsi_aio_ioctl_cb(struct iscsi_context
*iscsi
, int status
,
930 void *command_data
, void *opaque
)
932 IscsiAIOCB
*acb
= opaque
;
939 error_report("Failed to ioctl(SG_IO) to iSCSI lun. %s",
940 iscsi_get_error(iscsi
));
941 acb
->status
= iscsi_translate_sense(&acb
->task
->sense
);
944 acb
->ioh
->driver_status
= 0;
945 acb
->ioh
->host_status
= 0;
947 acb
->ioh
->status
= status
;
949 #define SG_ERR_DRIVER_SENSE 0x08
951 if (status
== SCSI_STATUS_CHECK_CONDITION
&& acb
->task
->datain
.size
>= 2) {
954 acb
->ioh
->driver_status
|= SG_ERR_DRIVER_SENSE
;
956 acb
->ioh
->sb_len_wr
= acb
->task
->datain
.size
- 2;
957 ss
= (acb
->ioh
->mx_sb_len
>= acb
->ioh
->sb_len_wr
) ?
958 acb
->ioh
->mx_sb_len
: acb
->ioh
->sb_len_wr
;
959 memcpy(acb
->ioh
->sbp
, &acb
->task
->datain
.data
[2], ss
);
962 iscsi_schedule_bh(acb
);
965 static void iscsi_ioctl_bh_completion(void *opaque
)
967 IscsiAIOCB
*acb
= opaque
;
969 qemu_bh_delete(acb
->bh
);
970 acb
->common
.cb(acb
->common
.opaque
, acb
->ret
);
974 static void iscsi_ioctl_handle_emulated(IscsiAIOCB
*acb
, int req
, void *buf
)
976 BlockDriverState
*bs
= acb
->common
.bs
;
977 IscsiLun
*iscsilun
= bs
->opaque
;
981 case SG_GET_VERSION_NUM
:
985 ((struct sg_scsi_id
*)buf
)->scsi_type
= iscsilun
->type
;
991 acb
->bh
= aio_bh_new(bdrv_get_aio_context(bs
),
992 iscsi_ioctl_bh_completion
, acb
);
994 qemu_bh_schedule(acb
->bh
);
997 static BlockAIOCB
*iscsi_aio_ioctl(BlockDriverState
*bs
,
998 unsigned long int req
, void *buf
,
999 BlockCompletionFunc
*cb
, void *opaque
)
1001 IscsiLun
*iscsilun
= bs
->opaque
;
1002 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
1003 struct iscsi_data data
;
1006 acb
= qemu_aio_get(&iscsi_aiocb_info
, bs
, cb
, opaque
);
1008 acb
->iscsilun
= iscsilun
;
1010 acb
->status
= -EINPROGRESS
;
1015 iscsi_ioctl_handle_emulated(acb
, req
, buf
);
1016 return &acb
->common
;
1019 if (acb
->ioh
->cmd_len
> SCSI_CDB_MAX_SIZE
) {
1020 error_report("iSCSI: ioctl error CDB exceeds max size (%d > %d)",
1021 acb
->ioh
->cmd_len
, SCSI_CDB_MAX_SIZE
);
1022 qemu_aio_unref(acb
);
1026 acb
->task
= malloc(sizeof(struct scsi_task
));
1027 if (acb
->task
== NULL
) {
1028 error_report("iSCSI: Failed to allocate task for scsi command. %s",
1029 iscsi_get_error(iscsi
));
1030 qemu_aio_unref(acb
);
1033 memset(acb
->task
, 0, sizeof(struct scsi_task
));
1035 switch (acb
->ioh
->dxfer_direction
) {
1036 case SG_DXFER_TO_DEV
:
1037 acb
->task
->xfer_dir
= SCSI_XFER_WRITE
;
1039 case SG_DXFER_FROM_DEV
:
1040 acb
->task
->xfer_dir
= SCSI_XFER_READ
;
1043 acb
->task
->xfer_dir
= SCSI_XFER_NONE
;
1047 acb
->task
->cdb_size
= acb
->ioh
->cmd_len
;
1048 memcpy(&acb
->task
->cdb
[0], acb
->ioh
->cmdp
, acb
->ioh
->cmd_len
);
1049 acb
->task
->expxferlen
= acb
->ioh
->dxfer_len
;
1052 qemu_mutex_lock(&iscsilun
->mutex
);
1053 if (acb
->task
->xfer_dir
== SCSI_XFER_WRITE
) {
1054 if (acb
->ioh
->iovec_count
== 0) {
1055 data
.data
= acb
->ioh
->dxferp
;
1056 data
.size
= acb
->ioh
->dxfer_len
;
1058 scsi_task_set_iov_out(acb
->task
,
1059 (struct scsi_iovec
*) acb
->ioh
->dxferp
,
1060 acb
->ioh
->iovec_count
);
1064 if (iscsi_scsi_command_async(iscsi
, iscsilun
->lun
, acb
->task
,
1066 (data
.size
> 0) ? &data
: NULL
,
1068 qemu_mutex_unlock(&iscsilun
->mutex
);
1069 scsi_free_scsi_task(acb
->task
);
1070 qemu_aio_unref(acb
);
1074 /* tell libiscsi to read straight into the buffer we got from ioctl */
1075 if (acb
->task
->xfer_dir
== SCSI_XFER_READ
) {
1076 if (acb
->ioh
->iovec_count
== 0) {
1077 scsi_task_add_data_in_buffer(acb
->task
,
1078 acb
->ioh
->dxfer_len
,
1081 scsi_task_set_iov_in(acb
->task
,
1082 (struct scsi_iovec
*) acb
->ioh
->dxferp
,
1083 acb
->ioh
->iovec_count
);
1087 iscsi_set_events(iscsilun
);
1088 qemu_mutex_unlock(&iscsilun
->mutex
);
1090 return &acb
->common
;
1096 iscsi_getlength(BlockDriverState
*bs
)
1098 IscsiLun
*iscsilun
= bs
->opaque
;
1101 len
= iscsilun
->num_blocks
;
1102 len
*= iscsilun
->block_size
;
1108 coroutine_fn
iscsi_co_pdiscard(BlockDriverState
*bs
, int64_t offset
, int bytes
)
1110 IscsiLun
*iscsilun
= bs
->opaque
;
1111 struct IscsiTask iTask
;
1112 struct unmap_list list
;
1115 if (!is_byte_request_lun_aligned(offset
, bytes
, iscsilun
)) {
1119 if (!iscsilun
->lbp
.lbpu
) {
1120 /* UNMAP is not supported by the target */
1124 list
.lba
= offset
/ iscsilun
->block_size
;
1125 list
.num
= bytes
/ iscsilun
->block_size
;
1127 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
1128 qemu_mutex_lock(&iscsilun
->mutex
);
1130 if (iscsi_unmap_task(iscsilun
->iscsi
, iscsilun
->lun
, 0, 0, &list
, 1,
1131 iscsi_co_generic_cb
, &iTask
) == NULL
) {
1136 iscsi_co_wait_for_task(&iTask
, iscsilun
);
1138 if (iTask
.task
!= NULL
) {
1139 scsi_free_scsi_task(iTask
.task
);
1143 if (iTask
.do_retry
) {
1148 iscsi_allocmap_set_invalid(iscsilun
, offset
, bytes
);
1150 if (iTask
.status
== SCSI_STATUS_CHECK_CONDITION
) {
1151 /* the target might fail with a check condition if it
1152 is not happy with the alignment of the UNMAP request
1153 we silently fail in this case */
1157 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
1158 error_report("iSCSI UNMAP failed at lba %" PRIu64
": %s",
1159 list
.lba
, iTask
.err_str
);
1165 qemu_mutex_unlock(&iscsilun
->mutex
);
1166 g_free(iTask
.err_str
);
1171 coroutine_fn
iscsi_co_pwrite_zeroes(BlockDriverState
*bs
, int64_t offset
,
1172 int bytes
, BdrvRequestFlags flags
)
1174 IscsiLun
*iscsilun
= bs
->opaque
;
1175 struct IscsiTask iTask
;
1178 bool use_16_for_ws
= iscsilun
->use_16_for_rw
;
1181 if (!is_byte_request_lun_aligned(offset
, bytes
, iscsilun
)) {
1185 if (flags
& BDRV_REQ_MAY_UNMAP
) {
1186 if (!use_16_for_ws
&& !iscsilun
->lbp
.lbpws10
) {
1187 /* WRITESAME10 with UNMAP is unsupported try WRITESAME16 */
1188 use_16_for_ws
= true;
1190 if (use_16_for_ws
&& !iscsilun
->lbp
.lbpws
) {
1191 /* WRITESAME16 with UNMAP is not supported by the target,
1192 * fall back and try WRITESAME10/16 without UNMAP */
1193 flags
&= ~BDRV_REQ_MAY_UNMAP
;
1194 use_16_for_ws
= iscsilun
->use_16_for_rw
;
1198 if (!(flags
& BDRV_REQ_MAY_UNMAP
) && !iscsilun
->has_write_same
) {
1199 /* WRITESAME without UNMAP is not supported by the target */
1203 lba
= offset
/ iscsilun
->block_size
;
1204 nb_blocks
= bytes
/ iscsilun
->block_size
;
1206 if (iscsilun
->zeroblock
== NULL
) {
1207 iscsilun
->zeroblock
= g_try_malloc0(iscsilun
->block_size
);
1208 if (iscsilun
->zeroblock
== NULL
) {
1213 qemu_mutex_lock(&iscsilun
->mutex
);
1214 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
1216 if (use_16_for_ws
) {
1217 iTask
.task
= iscsi_writesame16_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
1218 iscsilun
->zeroblock
, iscsilun
->block_size
,
1219 nb_blocks
, 0, !!(flags
& BDRV_REQ_MAY_UNMAP
),
1220 0, 0, iscsi_co_generic_cb
, &iTask
);
1222 iTask
.task
= iscsi_writesame10_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
1223 iscsilun
->zeroblock
, iscsilun
->block_size
,
1224 nb_blocks
, 0, !!(flags
& BDRV_REQ_MAY_UNMAP
),
1225 0, 0, iscsi_co_generic_cb
, &iTask
);
1227 if (iTask
.task
== NULL
) {
1228 qemu_mutex_unlock(&iscsilun
->mutex
);
1232 iscsi_co_wait_for_task(&iTask
, iscsilun
);
1234 if (iTask
.status
== SCSI_STATUS_CHECK_CONDITION
&&
1235 iTask
.task
->sense
.key
== SCSI_SENSE_ILLEGAL_REQUEST
&&
1236 (iTask
.task
->sense
.ascq
== SCSI_SENSE_ASCQ_INVALID_OPERATION_CODE
||
1237 iTask
.task
->sense
.ascq
== SCSI_SENSE_ASCQ_INVALID_FIELD_IN_CDB
)) {
1238 /* WRITE SAME is not supported by the target */
1239 iscsilun
->has_write_same
= false;
1240 scsi_free_scsi_task(iTask
.task
);
1245 if (iTask
.task
!= NULL
) {
1246 scsi_free_scsi_task(iTask
.task
);
1250 if (iTask
.do_retry
) {
1255 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
1256 iscsi_allocmap_set_invalid(iscsilun
, offset
, bytes
);
1257 error_report("iSCSI WRITESAME10/16 failed at lba %" PRIu64
": %s",
1258 lba
, iTask
.err_str
);
1263 if (flags
& BDRV_REQ_MAY_UNMAP
) {
1264 iscsi_allocmap_set_invalid(iscsilun
, offset
, bytes
);
1266 iscsi_allocmap_set_allocated(iscsilun
, offset
, bytes
);
1270 qemu_mutex_unlock(&iscsilun
->mutex
);
1271 g_free(iTask
.err_str
);
1275 static void apply_chap(struct iscsi_context
*iscsi
, QemuOpts
*opts
,
1278 const char *user
= NULL
;
1279 const char *password
= NULL
;
1280 const char *secretid
;
1281 char *secret
= NULL
;
1283 user
= qemu_opt_get(opts
, "user");
1288 secretid
= qemu_opt_get(opts
, "password-secret");
1289 password
= qemu_opt_get(opts
, "password");
1290 if (secretid
&& password
) {
1291 error_setg(errp
, "'password' and 'password-secret' properties are "
1292 "mutually exclusive");
1296 secret
= qcrypto_secret_lookup_as_utf8(secretid
, errp
);
1301 } else if (!password
) {
1302 error_setg(errp
, "CHAP username specified but no password was given");
1306 if (iscsi_set_initiator_username_pwd(iscsi
, user
, password
)) {
1307 error_setg(errp
, "Failed to set initiator username and password");
1313 static void apply_header_digest(struct iscsi_context
*iscsi
, QemuOpts
*opts
,
1316 const char *digest
= NULL
;
1318 digest
= qemu_opt_get(opts
, "header-digest");
1320 iscsi_set_header_digest(iscsi
, ISCSI_HEADER_DIGEST_NONE_CRC32C
);
1321 } else if (!strcmp(digest
, "crc32c")) {
1322 iscsi_set_header_digest(iscsi
, ISCSI_HEADER_DIGEST_CRC32C
);
1323 } else if (!strcmp(digest
, "none")) {
1324 iscsi_set_header_digest(iscsi
, ISCSI_HEADER_DIGEST_NONE
);
1325 } else if (!strcmp(digest
, "crc32c-none")) {
1326 iscsi_set_header_digest(iscsi
, ISCSI_HEADER_DIGEST_CRC32C_NONE
);
1327 } else if (!strcmp(digest
, "none-crc32c")) {
1328 iscsi_set_header_digest(iscsi
, ISCSI_HEADER_DIGEST_NONE_CRC32C
);
1330 error_setg(errp
, "Invalid header-digest setting : %s", digest
);
1334 static char *get_initiator_name(QemuOpts
*opts
)
1338 UuidInfo
*uuid_info
;
1340 name
= qemu_opt_get(opts
, "initiator-name");
1342 return g_strdup(name
);
1345 uuid_info
= qmp_query_uuid(NULL
);
1346 if (strcmp(uuid_info
->UUID
, UUID_NONE
) == 0) {
1347 name
= qemu_get_vm_name();
1349 name
= uuid_info
->UUID
;
1351 iscsi_name
= g_strdup_printf("iqn.2008-11.org.linux-kvm%s%s",
1352 name
? ":" : "", name
? name
: "");
1353 qapi_free_UuidInfo(uuid_info
);
1357 static void iscsi_nop_timed_event(void *opaque
)
1359 IscsiLun
*iscsilun
= opaque
;
1361 qemu_mutex_lock(&iscsilun
->mutex
);
1362 if (iscsi_get_nops_in_flight(iscsilun
->iscsi
) >= MAX_NOP_FAILURES
) {
1363 error_report("iSCSI: NOP timeout. Reconnecting...");
1364 iscsilun
->request_timed_out
= true;
1365 } else if (iscsi_nop_out_async(iscsilun
->iscsi
, NULL
, NULL
, 0, NULL
) != 0) {
1366 error_report("iSCSI: failed to sent NOP-Out. Disabling NOP messages.");
1370 timer_mod(iscsilun
->nop_timer
, qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) + NOP_INTERVAL
);
1371 iscsi_set_events(iscsilun
);
1374 qemu_mutex_unlock(&iscsilun
->mutex
);
1377 static void iscsi_readcapacity_sync(IscsiLun
*iscsilun
, Error
**errp
)
1379 struct scsi_task
*task
= NULL
;
1380 struct scsi_readcapacity10
*rc10
= NULL
;
1381 struct scsi_readcapacity16
*rc16
= NULL
;
1382 int retries
= ISCSI_CMD_RETRIES
;
1386 scsi_free_scsi_task(task
);
1390 switch (iscsilun
->type
) {
1392 task
= iscsi_readcapacity16_sync(iscsilun
->iscsi
, iscsilun
->lun
);
1393 if (task
!= NULL
&& task
->status
== SCSI_STATUS_GOOD
) {
1394 rc16
= scsi_datain_unmarshall(task
);
1396 error_setg(errp
, "iSCSI: Failed to unmarshall readcapacity16 data.");
1398 iscsilun
->block_size
= rc16
->block_length
;
1399 iscsilun
->num_blocks
= rc16
->returned_lba
+ 1;
1400 iscsilun
->lbpme
= !!rc16
->lbpme
;
1401 iscsilun
->lbprz
= !!rc16
->lbprz
;
1402 iscsilun
->use_16_for_rw
= (rc16
->returned_lba
> 0xffffffff);
1406 if (task
!= NULL
&& task
->status
== SCSI_STATUS_CHECK_CONDITION
1407 && task
->sense
.key
== SCSI_SENSE_UNIT_ATTENTION
) {
1410 /* Fall through and try READ CAPACITY(10) instead. */
1412 task
= iscsi_readcapacity10_sync(iscsilun
->iscsi
, iscsilun
->lun
, 0, 0);
1413 if (task
!= NULL
&& task
->status
== SCSI_STATUS_GOOD
) {
1414 rc10
= scsi_datain_unmarshall(task
);
1416 error_setg(errp
, "iSCSI: Failed to unmarshall readcapacity10 data.");
1418 iscsilun
->block_size
= rc10
->block_size
;
1419 if (rc10
->lba
== 0) {
1420 /* blank disk loaded */
1421 iscsilun
->num_blocks
= 0;
1423 iscsilun
->num_blocks
= rc10
->lba
+ 1;
1431 } while (task
!= NULL
&& task
->status
== SCSI_STATUS_CHECK_CONDITION
1432 && task
->sense
.key
== SCSI_SENSE_UNIT_ATTENTION
1435 if (task
== NULL
|| task
->status
!= SCSI_STATUS_GOOD
) {
1436 error_setg(errp
, "iSCSI: failed to send readcapacity10/16 command");
1437 } else if (!iscsilun
->block_size
||
1438 iscsilun
->block_size
% BDRV_SECTOR_SIZE
) {
1439 error_setg(errp
, "iSCSI: the target returned an invalid "
1440 "block size of %d.", iscsilun
->block_size
);
1443 scsi_free_scsi_task(task
);
1447 static struct scsi_task
*iscsi_do_inquiry(struct iscsi_context
*iscsi
, int lun
,
1448 int evpd
, int pc
, void **inq
, Error
**errp
)
1451 struct scsi_task
*task
= NULL
;
1452 task
= iscsi_inquiry_sync(iscsi
, lun
, evpd
, pc
, 64);
1453 if (task
== NULL
|| task
->status
!= SCSI_STATUS_GOOD
) {
1456 full_size
= scsi_datain_getfullsize(task
);
1457 if (full_size
> task
->datain
.size
) {
1458 scsi_free_scsi_task(task
);
1460 /* we need more data for the full list */
1461 task
= iscsi_inquiry_sync(iscsi
, lun
, evpd
, pc
, full_size
);
1462 if (task
== NULL
|| task
->status
!= SCSI_STATUS_GOOD
) {
1467 *inq
= scsi_datain_unmarshall(task
);
1469 error_setg(errp
, "iSCSI: failed to unmarshall inquiry datain blob");
1476 error_setg(errp
, "iSCSI: Inquiry command failed : %s",
1477 iscsi_get_error(iscsi
));
1480 scsi_free_scsi_task(task
);
1485 static void iscsi_detach_aio_context(BlockDriverState
*bs
)
1487 IscsiLun
*iscsilun
= bs
->opaque
;
1489 aio_set_fd_handler(iscsilun
->aio_context
, iscsi_get_fd(iscsilun
->iscsi
),
1490 false, NULL
, NULL
, NULL
, NULL
);
1491 iscsilun
->events
= 0;
1493 if (iscsilun
->nop_timer
) {
1494 timer_del(iscsilun
->nop_timer
);
1495 timer_free(iscsilun
->nop_timer
);
1496 iscsilun
->nop_timer
= NULL
;
1498 if (iscsilun
->event_timer
) {
1499 timer_del(iscsilun
->event_timer
);
1500 timer_free(iscsilun
->event_timer
);
1501 iscsilun
->event_timer
= NULL
;
1505 static void iscsi_attach_aio_context(BlockDriverState
*bs
,
1506 AioContext
*new_context
)
1508 IscsiLun
*iscsilun
= bs
->opaque
;
1510 iscsilun
->aio_context
= new_context
;
1511 iscsi_set_events(iscsilun
);
1513 /* Set up a timer for sending out iSCSI NOPs */
1514 iscsilun
->nop_timer
= aio_timer_new(iscsilun
->aio_context
,
1515 QEMU_CLOCK_REALTIME
, SCALE_MS
,
1516 iscsi_nop_timed_event
, iscsilun
);
1517 timer_mod(iscsilun
->nop_timer
,
1518 qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) + NOP_INTERVAL
);
1520 /* Set up a timer for periodic calls to iscsi_set_events and to
1521 * scan for command timeout */
1522 iscsilun
->event_timer
= aio_timer_new(iscsilun
->aio_context
,
1523 QEMU_CLOCK_REALTIME
, SCALE_MS
,
1524 iscsi_timed_check_events
, iscsilun
);
1525 timer_mod(iscsilun
->event_timer
,
1526 qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) + EVENT_INTERVAL
);
1529 static void iscsi_modesense_sync(IscsiLun
*iscsilun
)
1531 struct scsi_task
*task
;
1532 struct scsi_mode_sense
*ms
= NULL
;
1533 iscsilun
->write_protected
= false;
1534 iscsilun
->dpofua
= false;
1536 task
= iscsi_modesense6_sync(iscsilun
->iscsi
, iscsilun
->lun
,
1537 1, SCSI_MODESENSE_PC_CURRENT
,
1540 error_report("iSCSI: Failed to send MODE_SENSE(6) command: %s",
1541 iscsi_get_error(iscsilun
->iscsi
));
1545 if (task
->status
!= SCSI_STATUS_GOOD
) {
1546 error_report("iSCSI: Failed MODE_SENSE(6), LUN assumed writable");
1549 ms
= scsi_datain_unmarshall(task
);
1551 error_report("iSCSI: Failed to unmarshall MODE_SENSE(6) data: %s",
1552 iscsi_get_error(iscsilun
->iscsi
));
1555 iscsilun
->write_protected
= ms
->device_specific_parameter
& 0x80;
1556 iscsilun
->dpofua
= ms
->device_specific_parameter
& 0x10;
1560 scsi_free_scsi_task(task
);
1564 static void iscsi_parse_iscsi_option(const char *target
, QDict
*options
)
1568 const char *user
, *password
, *password_secret
, *initiator_name
,
1569 *header_digest
, *timeout
;
1571 list
= qemu_find_opts("iscsi");
1576 opts
= qemu_opts_find(list
, target
);
1578 opts
= QTAILQ_FIRST(&list
->head
);
1584 user
= qemu_opt_get(opts
, "user");
1586 qdict_set_default_str(options
, "user", user
);
1589 password
= qemu_opt_get(opts
, "password");
1591 qdict_set_default_str(options
, "password", password
);
1594 password_secret
= qemu_opt_get(opts
, "password-secret");
1595 if (password_secret
) {
1596 qdict_set_default_str(options
, "password-secret", password_secret
);
1599 initiator_name
= qemu_opt_get(opts
, "initiator-name");
1600 if (initiator_name
) {
1601 qdict_set_default_str(options
, "initiator-name", initiator_name
);
1604 header_digest
= qemu_opt_get(opts
, "header-digest");
1605 if (header_digest
) {
1606 /* -iscsi takes upper case values, but QAPI only supports lower case
1607 * enum constant names, so we have to convert here. */
1608 char *qapi_value
= g_ascii_strdown(header_digest
, -1);
1609 qdict_set_default_str(options
, "header-digest", qapi_value
);
1613 timeout
= qemu_opt_get(opts
, "timeout");
1615 qdict_set_default_str(options
, "timeout", timeout
);
1620 * We support iscsi url's on the form
1621 * iscsi://[<username>%<password>@]<host>[:<port>]/<targetname>/<lun>
1623 static void iscsi_parse_filename(const char *filename
, QDict
*options
,
1626 struct iscsi_url
*iscsi_url
;
1627 const char *transport_name
;
1630 iscsi_url
= iscsi_parse_full_url(NULL
, filename
);
1631 if (iscsi_url
== NULL
) {
1632 error_setg(errp
, "Failed to parse URL : %s", filename
);
1636 #if LIBISCSI_API_VERSION >= (20160603)
1637 switch (iscsi_url
->transport
) {
1639 transport_name
= "tcp";
1641 case ISER_TRANSPORT
:
1642 transport_name
= "iser";
1645 error_setg(errp
, "Unknown transport type (%d)",
1646 iscsi_url
->transport
);
1650 transport_name
= "tcp";
1653 qdict_set_default_str(options
, "transport", transport_name
);
1654 qdict_set_default_str(options
, "portal", iscsi_url
->portal
);
1655 qdict_set_default_str(options
, "target", iscsi_url
->target
);
1657 lun_str
= g_strdup_printf("%d", iscsi_url
->lun
);
1658 qdict_set_default_str(options
, "lun", lun_str
);
1661 /* User/password from -iscsi take precedence over those from the URL */
1662 iscsi_parse_iscsi_option(iscsi_url
->target
, options
);
1664 if (iscsi_url
->user
[0] != '\0') {
1665 qdict_set_default_str(options
, "user", iscsi_url
->user
);
1666 qdict_set_default_str(options
, "password", iscsi_url
->passwd
);
1669 iscsi_destroy_url(iscsi_url
);
1672 static QemuOptsList runtime_opts
= {
1674 .head
= QTAILQ_HEAD_INITIALIZER(runtime_opts
.head
),
1677 .name
= "transport",
1678 .type
= QEMU_OPT_STRING
,
1682 .type
= QEMU_OPT_STRING
,
1686 .type
= QEMU_OPT_STRING
,
1690 .type
= QEMU_OPT_STRING
,
1694 .type
= QEMU_OPT_STRING
,
1697 .name
= "password-secret",
1698 .type
= QEMU_OPT_STRING
,
1702 .type
= QEMU_OPT_NUMBER
,
1705 .name
= "initiator-name",
1706 .type
= QEMU_OPT_STRING
,
1709 .name
= "header-digest",
1710 .type
= QEMU_OPT_STRING
,
1714 .type
= QEMU_OPT_NUMBER
,
1718 .type
= QEMU_OPT_STRING
,
1720 { /* end of list */ }
1724 static void iscsi_save_designator(IscsiLun
*lun
,
1725 struct scsi_inquiry_device_identification
*inq_di
)
1727 struct scsi_inquiry_device_designator
*desig
, *copy
= NULL
;
1729 for (desig
= inq_di
->designators
; desig
; desig
= desig
->next
) {
1730 if (desig
->association
||
1731 desig
->designator_type
> SCSI_DESIGNATOR_TYPE_NAA
) {
1734 /* NAA works better than T10 vendor ID based designator. */
1735 if (!copy
|| copy
->designator_type
< desig
->designator_type
) {
1740 lun
->dd
= g_new(struct scsi_inquiry_device_designator
, 1);
1742 lun
->dd
->next
= NULL
;
1743 lun
->dd
->designator
= g_malloc(copy
->designator_length
);
1744 memcpy(lun
->dd
->designator
, copy
->designator
, copy
->designator_length
);
1748 static int iscsi_open(BlockDriverState
*bs
, QDict
*options
, int flags
,
1751 IscsiLun
*iscsilun
= bs
->opaque
;
1752 struct iscsi_context
*iscsi
= NULL
;
1753 struct scsi_task
*task
= NULL
;
1754 struct scsi_inquiry_standard
*inq
= NULL
;
1755 struct scsi_inquiry_supported_pages
*inq_vpd
;
1756 char *initiator_name
= NULL
;
1758 Error
*local_err
= NULL
;
1759 const char *transport_name
, *portal
, *target
, *filename
;
1760 #if LIBISCSI_API_VERSION >= (20160603)
1761 enum iscsi_transport_type transport
;
1763 int i
, ret
= 0, timeout
= 0, lun
;
1765 /* If we are given a filename, parse the filename, with precedence given to
1766 * filename encoded options */
1767 filename
= qdict_get_try_str(options
, "filename");
1769 warn_report("'filename' option specified. "
1770 "This is an unsupported option, and may be deprecated "
1772 iscsi_parse_filename(filename
, options
, &local_err
);
1775 error_propagate(errp
, local_err
);
1780 opts
= qemu_opts_create(&runtime_opts
, NULL
, 0, &error_abort
);
1781 qemu_opts_absorb_qdict(opts
, options
, &local_err
);
1783 error_propagate(errp
, local_err
);
1788 transport_name
= qemu_opt_get(opts
, "transport");
1789 portal
= qemu_opt_get(opts
, "portal");
1790 target
= qemu_opt_get(opts
, "target");
1791 lun
= qemu_opt_get_number(opts
, "lun", 0);
1793 if (!transport_name
|| !portal
|| !target
) {
1794 error_setg(errp
, "Need all of transport, portal and target options");
1799 if (!strcmp(transport_name
, "tcp")) {
1800 #if LIBISCSI_API_VERSION >= (20160603)
1801 transport
= TCP_TRANSPORT
;
1802 } else if (!strcmp(transport_name
, "iser")) {
1803 transport
= ISER_TRANSPORT
;
1805 /* TCP is what older libiscsi versions always use */
1808 error_setg(errp
, "Unknown transport: %s", transport_name
);
1813 memset(iscsilun
, 0, sizeof(IscsiLun
));
1815 initiator_name
= get_initiator_name(opts
);
1817 iscsi
= iscsi_create_context(initiator_name
);
1818 if (iscsi
== NULL
) {
1819 error_setg(errp
, "iSCSI: Failed to create iSCSI context.");
1823 #if LIBISCSI_API_VERSION >= (20160603)
1824 if (iscsi_init_transport(iscsi
, transport
)) {
1825 error_setg(errp
, ("Error initializing transport."));
1830 if (iscsi_set_targetname(iscsi
, target
)) {
1831 error_setg(errp
, "iSCSI: Failed to set target name.");
1836 /* check if we got CHAP username/password via the options */
1837 apply_chap(iscsi
, opts
, &local_err
);
1838 if (local_err
!= NULL
) {
1839 error_propagate(errp
, local_err
);
1844 if (iscsi_set_session_type(iscsi
, ISCSI_SESSION_NORMAL
) != 0) {
1845 error_setg(errp
, "iSCSI: Failed to set session type to normal.");
1850 /* check if we got HEADER_DIGEST via the options */
1851 apply_header_digest(iscsi
, opts
, &local_err
);
1852 if (local_err
!= NULL
) {
1853 error_propagate(errp
, local_err
);
1858 /* timeout handling is broken in libiscsi before 1.15.0 */
1859 timeout
= qemu_opt_get_number(opts
, "timeout", 0);
1860 #if LIBISCSI_API_VERSION >= 20150621
1861 iscsi_set_timeout(iscsi
, timeout
);
1864 error_report("iSCSI: ignoring timeout value for libiscsi <1.15.0");
1868 if (iscsi_full_connect_sync(iscsi
, portal
, lun
) != 0) {
1869 error_setg(errp
, "iSCSI: Failed to connect to LUN : %s",
1870 iscsi_get_error(iscsi
));
1875 iscsilun
->iscsi
= iscsi
;
1876 iscsilun
->aio_context
= bdrv_get_aio_context(bs
);
1877 iscsilun
->lun
= lun
;
1878 iscsilun
->has_write_same
= true;
1880 task
= iscsi_do_inquiry(iscsilun
->iscsi
, iscsilun
->lun
, 0, 0,
1881 (void **) &inq
, errp
);
1886 iscsilun
->type
= inq
->periperal_device_type
;
1887 scsi_free_scsi_task(task
);
1890 iscsi_modesense_sync(iscsilun
);
1891 if (iscsilun
->dpofua
) {
1892 bs
->supported_write_flags
= BDRV_REQ_FUA
;
1895 /* Check the write protect flag of the LUN if we want to write */
1896 if (iscsilun
->type
== TYPE_DISK
&& (flags
& BDRV_O_RDWR
) &&
1897 iscsilun
->write_protected
) {
1898 error_setg(errp
, "Cannot open a write protected LUN as read-write");
1903 iscsi_readcapacity_sync(iscsilun
, &local_err
);
1904 if (local_err
!= NULL
) {
1905 error_propagate(errp
, local_err
);
1909 bs
->total_sectors
= sector_lun2qemu(iscsilun
->num_blocks
, iscsilun
);
1911 /* We don't have any emulation for devices other than disks and CD-ROMs, so
1912 * this must be sg ioctl compatible. We force it to be sg, otherwise qemu
1913 * will try to read from the device to guess the image format.
1915 if (iscsilun
->type
!= TYPE_DISK
&& iscsilun
->type
!= TYPE_ROM
) {
1919 task
= iscsi_do_inquiry(iscsilun
->iscsi
, iscsilun
->lun
, 1,
1920 SCSI_INQUIRY_PAGECODE_SUPPORTED_VPD_PAGES
,
1921 (void **) &inq_vpd
, errp
);
1926 for (i
= 0; i
< inq_vpd
->num_pages
; i
++) {
1927 struct scsi_task
*inq_task
;
1928 struct scsi_inquiry_logical_block_provisioning
*inq_lbp
;
1929 struct scsi_inquiry_block_limits
*inq_bl
;
1930 struct scsi_inquiry_device_identification
*inq_di
;
1931 switch (inq_vpd
->pages
[i
]) {
1932 case SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING
:
1933 inq_task
= iscsi_do_inquiry(iscsilun
->iscsi
, iscsilun
->lun
, 1,
1934 SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING
,
1935 (void **) &inq_lbp
, errp
);
1936 if (inq_task
== NULL
) {
1940 memcpy(&iscsilun
->lbp
, inq_lbp
,
1941 sizeof(struct scsi_inquiry_logical_block_provisioning
));
1942 scsi_free_scsi_task(inq_task
);
1944 case SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS
:
1945 inq_task
= iscsi_do_inquiry(iscsilun
->iscsi
, iscsilun
->lun
, 1,
1946 SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS
,
1947 (void **) &inq_bl
, errp
);
1948 if (inq_task
== NULL
) {
1952 memcpy(&iscsilun
->bl
, inq_bl
,
1953 sizeof(struct scsi_inquiry_block_limits
));
1954 scsi_free_scsi_task(inq_task
);
1956 case SCSI_INQUIRY_PAGECODE_DEVICE_IDENTIFICATION
:
1957 inq_task
= iscsi_do_inquiry(iscsilun
->iscsi
, iscsilun
->lun
, 1,
1958 SCSI_INQUIRY_PAGECODE_DEVICE_IDENTIFICATION
,
1959 (void **) &inq_di
, errp
);
1960 if (inq_task
== NULL
) {
1964 iscsi_save_designator(iscsilun
, inq_di
);
1965 scsi_free_scsi_task(inq_task
);
1971 scsi_free_scsi_task(task
);
1974 qemu_mutex_init(&iscsilun
->mutex
);
1975 iscsi_attach_aio_context(bs
, iscsilun
->aio_context
);
1977 /* Guess the internal cluster (page) size of the iscsi target by the means
1978 * of opt_unmap_gran. Transfer the unmap granularity only if it has a
1979 * reasonable size */
1980 if (iscsilun
->bl
.opt_unmap_gran
* iscsilun
->block_size
>= 4 * 1024 &&
1981 iscsilun
->bl
.opt_unmap_gran
* iscsilun
->block_size
<= 16 * 1024 * 1024) {
1982 iscsilun
->cluster_size
= iscsilun
->bl
.opt_unmap_gran
*
1983 iscsilun
->block_size
;
1984 if (iscsilun
->lbprz
) {
1985 ret
= iscsi_allocmap_init(iscsilun
, bs
->open_flags
);
1989 if (iscsilun
->lbprz
&& iscsilun
->lbp
.lbpws
) {
1990 bs
->supported_zero_flags
= BDRV_REQ_MAY_UNMAP
;
1994 qemu_opts_del(opts
);
1995 g_free(initiator_name
);
1997 scsi_free_scsi_task(task
);
2001 if (iscsi
!= NULL
) {
2002 if (iscsi_is_logged_in(iscsi
)) {
2003 iscsi_logout_sync(iscsi
);
2005 iscsi_destroy_context(iscsi
);
2007 memset(iscsilun
, 0, sizeof(IscsiLun
));
2013 static void iscsi_close(BlockDriverState
*bs
)
2015 IscsiLun
*iscsilun
= bs
->opaque
;
2016 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
2018 iscsi_detach_aio_context(bs
);
2019 if (iscsi_is_logged_in(iscsi
)) {
2020 iscsi_logout_sync(iscsi
);
2022 iscsi_destroy_context(iscsi
);
2024 g_free(iscsilun
->dd
->designator
);
2025 g_free(iscsilun
->dd
);
2027 g_free(iscsilun
->zeroblock
);
2028 iscsi_allocmap_free(iscsilun
);
2029 qemu_mutex_destroy(&iscsilun
->mutex
);
2030 memset(iscsilun
, 0, sizeof(IscsiLun
));
2033 static void iscsi_refresh_limits(BlockDriverState
*bs
, Error
**errp
)
2035 /* We don't actually refresh here, but just return data queried in
2036 * iscsi_open(): iscsi targets don't change their limits. */
2038 IscsiLun
*iscsilun
= bs
->opaque
;
2039 uint64_t max_xfer_len
= iscsilun
->use_16_for_rw
? 0xffffffff : 0xffff;
2040 unsigned int block_size
= MAX(BDRV_SECTOR_SIZE
, iscsilun
->block_size
);
2042 assert(iscsilun
->block_size
>= BDRV_SECTOR_SIZE
|| bs
->sg
);
2044 bs
->bl
.request_alignment
= block_size
;
2046 if (iscsilun
->bl
.max_xfer_len
) {
2047 max_xfer_len
= MIN(max_xfer_len
, iscsilun
->bl
.max_xfer_len
);
2050 if (max_xfer_len
* block_size
< INT_MAX
) {
2051 bs
->bl
.max_transfer
= max_xfer_len
* iscsilun
->block_size
;
2054 if (iscsilun
->lbp
.lbpu
) {
2055 if (iscsilun
->bl
.max_unmap
< 0xffffffff / block_size
) {
2056 bs
->bl
.max_pdiscard
=
2057 iscsilun
->bl
.max_unmap
* iscsilun
->block_size
;
2059 bs
->bl
.pdiscard_alignment
=
2060 iscsilun
->bl
.opt_unmap_gran
* iscsilun
->block_size
;
2062 bs
->bl
.pdiscard_alignment
= iscsilun
->block_size
;
2065 if (iscsilun
->bl
.max_ws_len
< 0xffffffff / block_size
) {
2066 bs
->bl
.max_pwrite_zeroes
=
2067 iscsilun
->bl
.max_ws_len
* iscsilun
->block_size
;
2069 if (iscsilun
->lbp
.lbpws
) {
2070 bs
->bl
.pwrite_zeroes_alignment
=
2071 iscsilun
->bl
.opt_unmap_gran
* iscsilun
->block_size
;
2073 bs
->bl
.pwrite_zeroes_alignment
= iscsilun
->block_size
;
2075 if (iscsilun
->bl
.opt_xfer_len
&&
2076 iscsilun
->bl
.opt_xfer_len
< INT_MAX
/ block_size
) {
2077 bs
->bl
.opt_transfer
= pow2floor(iscsilun
->bl
.opt_xfer_len
*
2078 iscsilun
->block_size
);
2082 /* Note that this will not re-establish a connection with an iSCSI target - it
2083 * is effectively a NOP. */
2084 static int iscsi_reopen_prepare(BDRVReopenState
*state
,
2085 BlockReopenQueue
*queue
, Error
**errp
)
2087 IscsiLun
*iscsilun
= state
->bs
->opaque
;
2089 if (state
->flags
& BDRV_O_RDWR
&& iscsilun
->write_protected
) {
2090 error_setg(errp
, "Cannot open a write protected LUN as read-write");
2096 static void iscsi_reopen_commit(BDRVReopenState
*reopen_state
)
2098 IscsiLun
*iscsilun
= reopen_state
->bs
->opaque
;
2100 /* the cache.direct status might have changed */
2101 if (iscsilun
->allocmap
!= NULL
) {
2102 iscsi_allocmap_init(iscsilun
, reopen_state
->flags
);
2106 static int iscsi_truncate(BlockDriverState
*bs
, int64_t offset
,
2107 PreallocMode prealloc
, Error
**errp
)
2109 IscsiLun
*iscsilun
= bs
->opaque
;
2110 Error
*local_err
= NULL
;
2112 if (prealloc
!= PREALLOC_MODE_OFF
) {
2113 error_setg(errp
, "Unsupported preallocation mode '%s'",
2114 PreallocMode_str(prealloc
));
2118 if (iscsilun
->type
!= TYPE_DISK
) {
2119 error_setg(errp
, "Cannot resize non-disk iSCSI devices");
2123 iscsi_readcapacity_sync(iscsilun
, &local_err
);
2124 if (local_err
!= NULL
) {
2125 error_propagate(errp
, local_err
);
2129 if (offset
> iscsi_getlength(bs
)) {
2130 error_setg(errp
, "Cannot grow iSCSI devices");
2134 if (iscsilun
->allocmap
!= NULL
) {
2135 iscsi_allocmap_init(iscsilun
, bs
->open_flags
);
2141 static int coroutine_fn
iscsi_co_create_opts(const char *filename
, QemuOpts
*opts
,
2145 int64_t total_size
= 0;
2146 BlockDriverState
*bs
;
2147 IscsiLun
*iscsilun
= NULL
;
2149 Error
*local_err
= NULL
;
2153 /* Read out options */
2154 total_size
= DIV_ROUND_UP(qemu_opt_get_size_del(opts
, BLOCK_OPT_SIZE
, 0),
2156 bs
->opaque
= g_new0(struct IscsiLun
, 1);
2157 iscsilun
= bs
->opaque
;
2159 bs_options
= qdict_new();
2160 iscsi_parse_filename(filename
, bs_options
, &local_err
);
2162 error_propagate(errp
, local_err
);
2165 ret
= iscsi_open(bs
, bs_options
, 0, NULL
);
2167 qobject_unref(bs_options
);
2172 iscsi_detach_aio_context(bs
);
2173 if (iscsilun
->type
!= TYPE_DISK
) {
2177 if (bs
->total_sectors
< total_size
) {
2184 if (iscsilun
->iscsi
!= NULL
) {
2185 iscsi_destroy_context(iscsilun
->iscsi
);
2193 static int iscsi_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
)
2195 IscsiLun
*iscsilun
= bs
->opaque
;
2196 bdi
->unallocated_blocks_are_zero
= iscsilun
->lbprz
;
2197 bdi
->cluster_size
= iscsilun
->cluster_size
;
2201 static void coroutine_fn
iscsi_co_invalidate_cache(BlockDriverState
*bs
,
2204 IscsiLun
*iscsilun
= bs
->opaque
;
2205 iscsi_allocmap_invalidate(iscsilun
);
2208 static int coroutine_fn
iscsi_co_copy_range_from(BlockDriverState
*bs
,
2210 uint64_t src_offset
,
2212 uint64_t dst_offset
,
2214 BdrvRequestFlags flags
)
2216 return bdrv_co_copy_range_to(src
, src_offset
, dst
, dst_offset
, bytes
, flags
);
2219 static struct scsi_task
*iscsi_xcopy_task(int param_len
)
2221 struct scsi_task
*task
;
2223 task
= g_new0(struct scsi_task
, 1);
2225 task
->cdb
[0] = EXTENDED_COPY
;
2226 task
->cdb
[10] = (param_len
>> 24) & 0xFF;
2227 task
->cdb
[11] = (param_len
>> 16) & 0xFF;
2228 task
->cdb
[12] = (param_len
>> 8) & 0xFF;
2229 task
->cdb
[13] = param_len
& 0xFF;
2230 task
->cdb_size
= 16;
2231 task
->xfer_dir
= SCSI_XFER_WRITE
;
2232 task
->expxferlen
= param_len
;
2237 static void iscsi_populate_target_desc(unsigned char *desc
, IscsiLun
*lun
)
2239 struct scsi_inquiry_device_designator
*dd
= lun
->dd
;
2241 memset(desc
, 0, 32);
2242 desc
[0] = 0xE4; /* IDENT_DESCR_TGT_DESCR */
2243 desc
[4] = dd
->code_set
;
2244 desc
[5] = (dd
->designator_type
& 0xF)
2245 | ((dd
->association
& 3) << 4);
2246 desc
[7] = dd
->designator_length
;
2247 memcpy(desc
+ 8, dd
->designator
, dd
->designator_length
);
2250 desc
[29] = (lun
->block_size
>> 16) & 0xFF;
2251 desc
[30] = (lun
->block_size
>> 8) & 0xFF;
2252 desc
[31] = lun
->block_size
& 0xFF;
2255 static void iscsi_xcopy_desc_hdr(uint8_t *hdr
, int dc
, int cat
, int src_index
,
2258 hdr
[0] = 0x02; /* BLK_TO_BLK_SEG_DESCR */
2259 hdr
[1] = ((dc
<< 1) | cat
) & 0xFF;
2260 hdr
[2] = (XCOPY_BLK2BLK_SEG_DESC_SIZE
>> 8) & 0xFF;
2261 /* don't account for the first 4 bytes in descriptor header*/
2262 hdr
[3] = (XCOPY_BLK2BLK_SEG_DESC_SIZE
- 4 /* SEG_DESC_SRC_INDEX_OFFSET */) & 0xFF;
2263 hdr
[4] = (src_index
>> 8) & 0xFF;
2264 hdr
[5] = src_index
& 0xFF;
2265 hdr
[6] = (dst_index
>> 8) & 0xFF;
2266 hdr
[7] = dst_index
& 0xFF;
2269 static void iscsi_xcopy_populate_desc(uint8_t *desc
, int dc
, int cat
,
2270 int src_index
, int dst_index
, int num_blks
,
2271 uint64_t src_lba
, uint64_t dst_lba
)
2273 iscsi_xcopy_desc_hdr(desc
, dc
, cat
, src_index
, dst_index
);
2275 /* The caller should verify the request size */
2276 assert(num_blks
< 65536);
2277 desc
[10] = (num_blks
>> 8) & 0xFF;
2278 desc
[11] = num_blks
& 0xFF;
2279 desc
[12] = (src_lba
>> 56) & 0xFF;
2280 desc
[13] = (src_lba
>> 48) & 0xFF;
2281 desc
[14] = (src_lba
>> 40) & 0xFF;
2282 desc
[15] = (src_lba
>> 32) & 0xFF;
2283 desc
[16] = (src_lba
>> 24) & 0xFF;
2284 desc
[17] = (src_lba
>> 16) & 0xFF;
2285 desc
[18] = (src_lba
>> 8) & 0xFF;
2286 desc
[19] = src_lba
& 0xFF;
2287 desc
[20] = (dst_lba
>> 56) & 0xFF;
2288 desc
[21] = (dst_lba
>> 48) & 0xFF;
2289 desc
[22] = (dst_lba
>> 40) & 0xFF;
2290 desc
[23] = (dst_lba
>> 32) & 0xFF;
2291 desc
[24] = (dst_lba
>> 24) & 0xFF;
2292 desc
[25] = (dst_lba
>> 16) & 0xFF;
2293 desc
[26] = (dst_lba
>> 8) & 0xFF;
2294 desc
[27] = dst_lba
& 0xFF;
2297 static void iscsi_xcopy_populate_header(unsigned char *buf
, int list_id
, int str
,
2298 int list_id_usage
, int prio
,
2300 int seg_desc_len
, int inline_data_len
)
2303 buf
[1] = ((str
& 1) << 5) | ((list_id_usage
& 3) << 3) | (prio
& 7);
2304 buf
[2] = (tgt_desc_len
>> 8) & 0xFF;
2305 buf
[3] = tgt_desc_len
& 0xFF;
2306 buf
[8] = (seg_desc_len
>> 24) & 0xFF;
2307 buf
[9] = (seg_desc_len
>> 16) & 0xFF;
2308 buf
[10] = (seg_desc_len
>> 8) & 0xFF;
2309 buf
[11] = seg_desc_len
& 0xFF;
2310 buf
[12] = (inline_data_len
>> 24) & 0xFF;
2311 buf
[13] = (inline_data_len
>> 16) & 0xFF;
2312 buf
[14] = (inline_data_len
>> 8) & 0xFF;
2313 buf
[15] = inline_data_len
& 0xFF;
2316 static void iscsi_xcopy_data(struct iscsi_data
*data
,
2317 IscsiLun
*src
, int64_t src_lba
,
2318 IscsiLun
*dst
, int64_t dst_lba
,
2319 uint16_t num_blocks
)
2322 const int src_offset
= XCOPY_DESC_OFFSET
;
2323 const int dst_offset
= XCOPY_DESC_OFFSET
+ IDENT_DESCR_TGT_DESCR_SIZE
;
2324 const int seg_offset
= dst_offset
+ IDENT_DESCR_TGT_DESCR_SIZE
;
2326 data
->size
= XCOPY_DESC_OFFSET
+
2327 IDENT_DESCR_TGT_DESCR_SIZE
* 2 +
2328 XCOPY_BLK2BLK_SEG_DESC_SIZE
;
2329 data
->data
= g_malloc0(data
->size
);
2332 /* Initialise the parameter list header */
2333 iscsi_xcopy_populate_header(buf
, 1, 0, 2 /* LIST_ID_USAGE_DISCARD */,
2334 0, 2 * IDENT_DESCR_TGT_DESCR_SIZE
,
2335 XCOPY_BLK2BLK_SEG_DESC_SIZE
,
2338 /* Initialise CSCD list with one src + one dst descriptor */
2339 iscsi_populate_target_desc(&buf
[src_offset
], src
);
2340 iscsi_populate_target_desc(&buf
[dst_offset
], dst
);
2342 /* Initialise one segment descriptor */
2343 iscsi_xcopy_populate_desc(&buf
[seg_offset
], 0, 0, 0, 1, num_blocks
,
2347 static int coroutine_fn
iscsi_co_copy_range_to(BlockDriverState
*bs
,
2349 uint64_t src_offset
,
2351 uint64_t dst_offset
,
2353 BdrvRequestFlags flags
)
2355 IscsiLun
*dst_lun
= dst
->bs
->opaque
;
2357 struct IscsiTask iscsi_task
;
2358 struct iscsi_data data
;
2362 if (src
->bs
->drv
->bdrv_co_copy_range_to
!= iscsi_co_copy_range_to
) {
2365 src_lun
= src
->bs
->opaque
;
2367 if (!src_lun
->dd
|| !dst_lun
->dd
) {
2370 if (!is_byte_request_lun_aligned(dst_offset
, bytes
, dst_lun
)) {
2373 if (!is_byte_request_lun_aligned(src_offset
, bytes
, src_lun
)) {
2376 if (dst_lun
->block_size
!= src_lun
->block_size
||
2377 !dst_lun
->block_size
) {
2381 block_size
= dst_lun
->block_size
;
2382 if (bytes
/ block_size
> 65535) {
2386 iscsi_xcopy_data(&data
,
2387 src_lun
, src_offset
/ block_size
,
2388 dst_lun
, dst_offset
/ block_size
,
2389 bytes
/ block_size
);
2391 iscsi_co_init_iscsitask(dst_lun
, &iscsi_task
);
2393 qemu_mutex_lock(&dst_lun
->mutex
);
2394 iscsi_task
.task
= iscsi_xcopy_task(data
.size
);
2396 if (iscsi_scsi_command_async(dst_lun
->iscsi
, dst_lun
->lun
,
2397 iscsi_task
.task
, iscsi_co_generic_cb
,
2399 &iscsi_task
) != 0) {
2404 iscsi_co_wait_for_task(&iscsi_task
, dst_lun
);
2406 if (iscsi_task
.do_retry
) {
2407 iscsi_task
.complete
= 0;
2411 if (iscsi_task
.status
!= SCSI_STATUS_GOOD
) {
2412 r
= iscsi_task
.err_code
;
2417 g_free(iscsi_task
.task
);
2418 qemu_mutex_unlock(&dst_lun
->mutex
);
2419 g_free(iscsi_task
.err_str
);
2423 static QemuOptsList iscsi_create_opts
= {
2424 .name
= "iscsi-create-opts",
2425 .head
= QTAILQ_HEAD_INITIALIZER(iscsi_create_opts
.head
),
2428 .name
= BLOCK_OPT_SIZE
,
2429 .type
= QEMU_OPT_SIZE
,
2430 .help
= "Virtual disk size"
2432 { /* end of list */ }
2436 static BlockDriver bdrv_iscsi
= {
2437 .format_name
= "iscsi",
2438 .protocol_name
= "iscsi",
2440 .instance_size
= sizeof(IscsiLun
),
2441 .bdrv_parse_filename
= iscsi_parse_filename
,
2442 .bdrv_file_open
= iscsi_open
,
2443 .bdrv_close
= iscsi_close
,
2444 .bdrv_co_create_opts
= iscsi_co_create_opts
,
2445 .create_opts
= &iscsi_create_opts
,
2446 .bdrv_reopen_prepare
= iscsi_reopen_prepare
,
2447 .bdrv_reopen_commit
= iscsi_reopen_commit
,
2448 .bdrv_co_invalidate_cache
= iscsi_co_invalidate_cache
,
2450 .bdrv_getlength
= iscsi_getlength
,
2451 .bdrv_get_info
= iscsi_get_info
,
2452 .bdrv_truncate
= iscsi_truncate
,
2453 .bdrv_refresh_limits
= iscsi_refresh_limits
,
2455 .bdrv_co_block_status
= iscsi_co_block_status
,
2456 .bdrv_co_pdiscard
= iscsi_co_pdiscard
,
2457 .bdrv_co_copy_range_from
= iscsi_co_copy_range_from
,
2458 .bdrv_co_copy_range_to
= iscsi_co_copy_range_to
,
2459 .bdrv_co_pwrite_zeroes
= iscsi_co_pwrite_zeroes
,
2460 .bdrv_co_readv
= iscsi_co_readv
,
2461 .bdrv_co_writev
= iscsi_co_writev
,
2462 .bdrv_co_flush_to_disk
= iscsi_co_flush
,
2465 .bdrv_aio_ioctl
= iscsi_aio_ioctl
,
2468 .bdrv_detach_aio_context
= iscsi_detach_aio_context
,
2469 .bdrv_attach_aio_context
= iscsi_attach_aio_context
,
2472 #if LIBISCSI_API_VERSION >= (20160603)
2473 static BlockDriver bdrv_iser
= {
2474 .format_name
= "iser",
2475 .protocol_name
= "iser",
2477 .instance_size
= sizeof(IscsiLun
),
2478 .bdrv_parse_filename
= iscsi_parse_filename
,
2479 .bdrv_file_open
= iscsi_open
,
2480 .bdrv_close
= iscsi_close
,
2481 .bdrv_co_create_opts
= iscsi_co_create_opts
,
2482 .create_opts
= &iscsi_create_opts
,
2483 .bdrv_reopen_prepare
= iscsi_reopen_prepare
,
2484 .bdrv_reopen_commit
= iscsi_reopen_commit
,
2485 .bdrv_co_invalidate_cache
= iscsi_co_invalidate_cache
,
2487 .bdrv_getlength
= iscsi_getlength
,
2488 .bdrv_get_info
= iscsi_get_info
,
2489 .bdrv_truncate
= iscsi_truncate
,
2490 .bdrv_refresh_limits
= iscsi_refresh_limits
,
2492 .bdrv_co_block_status
= iscsi_co_block_status
,
2493 .bdrv_co_pdiscard
= iscsi_co_pdiscard
,
2494 .bdrv_co_copy_range_from
= iscsi_co_copy_range_from
,
2495 .bdrv_co_copy_range_to
= iscsi_co_copy_range_to
,
2496 .bdrv_co_pwrite_zeroes
= iscsi_co_pwrite_zeroes
,
2497 .bdrv_co_readv
= iscsi_co_readv
,
2498 .bdrv_co_writev
= iscsi_co_writev
,
2499 .bdrv_co_flush_to_disk
= iscsi_co_flush
,
2502 .bdrv_aio_ioctl
= iscsi_aio_ioctl
,
2505 .bdrv_detach_aio_context
= iscsi_detach_aio_context
,
2506 .bdrv_attach_aio_context
= iscsi_attach_aio_context
,
2510 static void iscsi_block_init(void)
2512 bdrv_register(&bdrv_iscsi
);
2513 #if LIBISCSI_API_VERSION >= (20160603)
2514 bdrv_register(&bdrv_iser
);
2518 block_init(iscsi_block_init
);