2 * QEMU Block driver for iSCSI images
4 * Copyright (c) 2010-2011 Ronnie Sahlberg <ronniesahlberg@gmail.com>
5 * Copyright (c) 2012-2016 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-common.h"
32 #include "qemu/config-file.h"
33 #include "qemu/error-report.h"
34 #include "qemu/bitops.h"
35 #include "qemu/bitmap.h"
36 #include "block/block_int.h"
37 #include "block/scsi.h"
39 #include "qemu/uuid.h"
40 #include "qmp-commands.h"
41 #include "qapi/qmp/qstring.h"
42 #include "crypto/secret.h"
44 #include <iscsi/iscsi.h>
45 #include <iscsi/scsi-lowlevel.h>
51 typedef struct IscsiLun
{
52 struct iscsi_context
*iscsi
;
53 AioContext
*aio_context
;
55 enum scsi_inquiry_peripheral_device_type type
;
60 QEMUTimer
*event_timer
;
61 struct scsi_inquiry_logical_block_provisioning lbp
;
62 struct scsi_inquiry_block_limits bl
;
63 unsigned char *zeroblock
;
64 /* The allocmap tracks which clusters (pages) on the iSCSI target are
65 * allocated and which are not. In case a target returns zeros for
66 * unallocated pages (iscsilun->lprz) we can directly return zeros instead
67 * of reading zeros over the wire if a read request falls within an
68 * unallocated block. As there are 3 possible states we need 2 bitmaps to
69 * track. allocmap_valid keeps track if QEMU's information about a page is
70 * valid. allocmap tracks if a page is allocated or not. In case QEMU has no
71 * valid information about a page the corresponding allocmap entry should be
72 * switched to unallocated as well to force a new lookup of the allocation
73 * status as lookups are generally skipped if a page is suspect to be
74 * allocated. If a iSCSI target is opened with cache.direct = on the
75 * allocmap_valid does not exist turning all cached information invalid so
76 * that a fresh lookup is made for any page even if allocmap entry returns
77 * it's unallocated. */
78 unsigned long *allocmap
;
79 unsigned long *allocmap_valid
;
88 bool request_timed_out
;
91 typedef struct IscsiTask
{
96 struct scsi_task
*task
;
99 QEMUTimer retry_timer
;
103 typedef struct IscsiAIOCB
{
108 struct scsi_task
*task
;
119 /* libiscsi uses time_t so its enough to process events every second */
120 #define EVENT_INTERVAL 1000
121 #define NOP_INTERVAL 5000
122 #define MAX_NOP_FAILURES 3
123 #define ISCSI_CMD_RETRIES ARRAY_SIZE(iscsi_retry_times)
124 static const unsigned iscsi_retry_times
[] = {8, 32, 128, 512, 2048, 8192, 32768};
126 /* this threshold is a trade-off knob to choose between
127 * the potential additional overhead of an extra GET_LBA_STATUS request
128 * vs. unnecessarily reading a lot of zero sectors over the wire.
129 * If a read request is greater or equal than ISCSI_CHECKALLOC_THRES
130 * sectors we check the allocation status of the area covered by the
131 * request first if the allocationmap indicates that the area might be
133 #define ISCSI_CHECKALLOC_THRES 64
140 qemu_bh_delete(acb
->bh
);
145 acb
->common
.cb(acb
->common
.opaque
, acb
->status
);
147 if (acb
->task
!= NULL
) {
148 scsi_free_scsi_task(acb
->task
);
156 iscsi_schedule_bh(IscsiAIOCB
*acb
)
161 acb
->bh
= aio_bh_new(acb
->iscsilun
->aio_context
, iscsi_bh_cb
, acb
);
162 qemu_bh_schedule(acb
->bh
);
165 static void iscsi_co_generic_bh_cb(void *opaque
)
167 struct IscsiTask
*iTask
= opaque
;
169 qemu_coroutine_enter(iTask
->co
);
172 static void iscsi_retry_timer_expired(void *opaque
)
174 struct IscsiTask
*iTask
= opaque
;
177 qemu_coroutine_enter(iTask
->co
);
181 static inline unsigned exp_random(double mean
)
183 return -mean
* log((double)rand() / RAND_MAX
);
186 /* SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST was introduced in
187 * libiscsi 1.10.0, together with other constants we need. Use it as
188 * a hint that we have to define them ourselves if needed, to keep the
189 * minimum required libiscsi version at 1.9.0. We use an ASCQ macro for
190 * the test because SCSI_STATUS_* is an enum.
192 * To guard against future changes where SCSI_SENSE_ASCQ_* also becomes
193 * an enum, check against the LIBISCSI_API_VERSION macro, which was
194 * introduced in 1.11.0. If it is present, there is no need to define
197 #if !defined(SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST) && \
198 !defined(LIBISCSI_API_VERSION)
199 #define SCSI_STATUS_TASK_SET_FULL 0x28
200 #define SCSI_STATUS_TIMEOUT 0x0f000002
201 #define SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST 0x2600
202 #define SCSI_SENSE_ASCQ_PARAMETER_LIST_LENGTH_ERROR 0x1a00
205 #ifndef LIBISCSI_API_VERSION
206 #define LIBISCSI_API_VERSION 20130701
209 static int iscsi_translate_sense(struct scsi_sense
*sense
)
213 switch (sense
->key
) {
214 case SCSI_SENSE_NOT_READY
:
216 case SCSI_SENSE_DATA_PROTECTION
:
218 case SCSI_SENSE_COMMAND_ABORTED
:
220 case SCSI_SENSE_ILLEGAL_REQUEST
:
226 switch (sense
->ascq
) {
227 case SCSI_SENSE_ASCQ_PARAMETER_LIST_LENGTH_ERROR
:
228 case SCSI_SENSE_ASCQ_INVALID_OPERATION_CODE
:
229 case SCSI_SENSE_ASCQ_INVALID_FIELD_IN_CDB
:
230 case SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST
:
233 case SCSI_SENSE_ASCQ_LBA_OUT_OF_RANGE
:
236 case SCSI_SENSE_ASCQ_LOGICAL_UNIT_NOT_SUPPORTED
:
239 case SCSI_SENSE_ASCQ_MEDIUM_NOT_PRESENT
:
240 case SCSI_SENSE_ASCQ_MEDIUM_NOT_PRESENT_TRAY_CLOSED
:
241 case SCSI_SENSE_ASCQ_MEDIUM_NOT_PRESENT_TRAY_OPEN
:
244 case SCSI_SENSE_ASCQ_WRITE_PROTECTED
:
255 iscsi_co_generic_cb(struct iscsi_context
*iscsi
, int status
,
256 void *command_data
, void *opaque
)
258 struct IscsiTask
*iTask
= opaque
;
259 struct scsi_task
*task
= command_data
;
261 iTask
->status
= status
;
265 if (status
!= SCSI_STATUS_GOOD
) {
266 if (iTask
->retries
++ < ISCSI_CMD_RETRIES
) {
267 if (status
== SCSI_STATUS_CHECK_CONDITION
268 && task
->sense
.key
== SCSI_SENSE_UNIT_ATTENTION
) {
269 error_report("iSCSI CheckCondition: %s",
270 iscsi_get_error(iscsi
));
274 if (status
== SCSI_STATUS_BUSY
||
275 status
== SCSI_STATUS_TIMEOUT
||
276 status
== SCSI_STATUS_TASK_SET_FULL
) {
277 unsigned retry_time
=
278 exp_random(iscsi_retry_times
[iTask
->retries
- 1]);
279 if (status
== SCSI_STATUS_TIMEOUT
) {
280 /* make sure the request is rescheduled AFTER the
281 * reconnect is initiated */
282 retry_time
= EVENT_INTERVAL
* 2;
283 iTask
->iscsilun
->request_timed_out
= true;
285 error_report("iSCSI Busy/TaskSetFull/TimeOut"
286 " (retry #%u in %u ms): %s",
287 iTask
->retries
, retry_time
,
288 iscsi_get_error(iscsi
));
289 aio_timer_init(iTask
->iscsilun
->aio_context
,
290 &iTask
->retry_timer
, QEMU_CLOCK_REALTIME
,
291 SCALE_MS
, iscsi_retry_timer_expired
, iTask
);
292 timer_mod(&iTask
->retry_timer
,
293 qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) + retry_time
);
298 iTask
->err_code
= iscsi_translate_sense(&task
->sense
);
299 error_report("iSCSI Failure: %s", iscsi_get_error(iscsi
));
304 aio_bh_schedule_oneshot(iTask
->iscsilun
->aio_context
,
305 iscsi_co_generic_bh_cb
, iTask
);
311 static void iscsi_co_init_iscsitask(IscsiLun
*iscsilun
, struct IscsiTask
*iTask
)
313 *iTask
= (struct IscsiTask
) {
314 .co
= qemu_coroutine_self(),
315 .iscsilun
= iscsilun
,
320 iscsi_abort_task_cb(struct iscsi_context
*iscsi
, int status
, void *command_data
,
323 IscsiAIOCB
*acb
= private_data
;
325 acb
->status
= -ECANCELED
;
326 iscsi_schedule_bh(acb
);
330 iscsi_aio_cancel(BlockAIOCB
*blockacb
)
332 IscsiAIOCB
*acb
= (IscsiAIOCB
*)blockacb
;
333 IscsiLun
*iscsilun
= acb
->iscsilun
;
335 if (acb
->status
!= -EINPROGRESS
) {
339 /* send a task mgmt call to the target to cancel the task on the target */
340 iscsi_task_mgmt_abort_task_async(iscsilun
->iscsi
, acb
->task
,
341 iscsi_abort_task_cb
, acb
);
345 static const AIOCBInfo iscsi_aiocb_info
= {
346 .aiocb_size
= sizeof(IscsiAIOCB
),
347 .cancel_async
= iscsi_aio_cancel
,
351 static void iscsi_process_read(void *arg
);
352 static void iscsi_process_write(void *arg
);
355 iscsi_set_events(IscsiLun
*iscsilun
)
357 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
358 int ev
= iscsi_which_events(iscsi
);
360 if (ev
!= iscsilun
->events
) {
361 aio_set_fd_handler(iscsilun
->aio_context
, iscsi_get_fd(iscsi
),
363 (ev
& POLLIN
) ? iscsi_process_read
: NULL
,
364 (ev
& POLLOUT
) ? iscsi_process_write
: NULL
,
367 iscsilun
->events
= ev
;
371 static void iscsi_timed_check_events(void *opaque
)
373 IscsiLun
*iscsilun
= opaque
;
375 /* check for timed out requests */
376 iscsi_service(iscsilun
->iscsi
, 0);
378 if (iscsilun
->request_timed_out
) {
379 iscsilun
->request_timed_out
= false;
380 iscsi_reconnect(iscsilun
->iscsi
);
383 /* newer versions of libiscsi may return zero events. Ensure we are able
384 * to return to service once this situation changes. */
385 iscsi_set_events(iscsilun
);
387 timer_mod(iscsilun
->event_timer
,
388 qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) + EVENT_INTERVAL
);
392 iscsi_process_read(void *arg
)
394 IscsiLun
*iscsilun
= arg
;
395 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
397 iscsi_service(iscsi
, POLLIN
);
398 iscsi_set_events(iscsilun
);
402 iscsi_process_write(void *arg
)
404 IscsiLun
*iscsilun
= arg
;
405 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
407 iscsi_service(iscsi
, POLLOUT
);
408 iscsi_set_events(iscsilun
);
411 static int64_t sector_lun2qemu(int64_t sector
, IscsiLun
*iscsilun
)
413 return sector
* iscsilun
->block_size
/ BDRV_SECTOR_SIZE
;
416 static int64_t sector_qemu2lun(int64_t sector
, IscsiLun
*iscsilun
)
418 return sector
* BDRV_SECTOR_SIZE
/ iscsilun
->block_size
;
421 static bool is_byte_request_lun_aligned(int64_t offset
, int count
,
424 if (offset
% iscsilun
->block_size
|| count
% iscsilun
->block_size
) {
425 error_report("iSCSI misaligned request: "
426 "iscsilun->block_size %u, offset %" PRIi64
428 iscsilun
->block_size
, offset
, count
);
434 static bool is_sector_request_lun_aligned(int64_t sector_num
, int nb_sectors
,
437 assert(nb_sectors
<= BDRV_REQUEST_MAX_SECTORS
);
438 return is_byte_request_lun_aligned(sector_num
<< BDRV_SECTOR_BITS
,
439 nb_sectors
<< BDRV_SECTOR_BITS
,
443 static void iscsi_allocmap_free(IscsiLun
*iscsilun
)
445 g_free(iscsilun
->allocmap
);
446 g_free(iscsilun
->allocmap_valid
);
447 iscsilun
->allocmap
= NULL
;
448 iscsilun
->allocmap_valid
= NULL
;
452 static int iscsi_allocmap_init(IscsiLun
*iscsilun
, int open_flags
)
454 iscsi_allocmap_free(iscsilun
);
456 iscsilun
->allocmap_size
=
457 DIV_ROUND_UP(sector_lun2qemu(iscsilun
->num_blocks
, iscsilun
),
458 iscsilun
->cluster_sectors
);
460 iscsilun
->allocmap
= bitmap_try_new(iscsilun
->allocmap_size
);
461 if (!iscsilun
->allocmap
) {
465 if (open_flags
& BDRV_O_NOCACHE
) {
466 /* in case that cache.direct = on all allocmap entries are
467 * treated as invalid to force a relookup of the block
468 * status on every read request */
472 iscsilun
->allocmap_valid
= bitmap_try_new(iscsilun
->allocmap_size
);
473 if (!iscsilun
->allocmap_valid
) {
474 /* if we are under memory pressure free the allocmap as well */
475 iscsi_allocmap_free(iscsilun
);
483 iscsi_allocmap_update(IscsiLun
*iscsilun
, int64_t sector_num
,
484 int nb_sectors
, bool allocated
, bool valid
)
486 int64_t cl_num_expanded
, nb_cls_expanded
, cl_num_shrunk
, nb_cls_shrunk
;
488 if (iscsilun
->allocmap
== NULL
) {
491 /* expand to entirely contain all affected clusters */
492 cl_num_expanded
= sector_num
/ iscsilun
->cluster_sectors
;
493 nb_cls_expanded
= DIV_ROUND_UP(sector_num
+ nb_sectors
,
494 iscsilun
->cluster_sectors
) - cl_num_expanded
;
495 /* shrink to touch only completely contained clusters */
496 cl_num_shrunk
= DIV_ROUND_UP(sector_num
, iscsilun
->cluster_sectors
);
497 nb_cls_shrunk
= (sector_num
+ nb_sectors
) / iscsilun
->cluster_sectors
500 bitmap_set(iscsilun
->allocmap
, cl_num_expanded
, nb_cls_expanded
);
502 if (nb_cls_shrunk
> 0) {
503 bitmap_clear(iscsilun
->allocmap
, cl_num_shrunk
, nb_cls_shrunk
);
507 if (iscsilun
->allocmap_valid
== NULL
) {
511 if (nb_cls_shrunk
> 0) {
512 bitmap_set(iscsilun
->allocmap_valid
, cl_num_shrunk
, nb_cls_shrunk
);
515 bitmap_clear(iscsilun
->allocmap_valid
, cl_num_expanded
,
521 iscsi_allocmap_set_allocated(IscsiLun
*iscsilun
, int64_t sector_num
,
524 iscsi_allocmap_update(iscsilun
, sector_num
, nb_sectors
, true, true);
528 iscsi_allocmap_set_unallocated(IscsiLun
*iscsilun
, int64_t sector_num
,
531 /* Note: if cache.direct=on the fifth argument to iscsi_allocmap_update
532 * is ignored, so this will in effect be an iscsi_allocmap_set_invalid.
534 iscsi_allocmap_update(iscsilun
, sector_num
, nb_sectors
, false, true);
537 static void iscsi_allocmap_set_invalid(IscsiLun
*iscsilun
, int64_t sector_num
,
540 iscsi_allocmap_update(iscsilun
, sector_num
, nb_sectors
, false, false);
543 static void iscsi_allocmap_invalidate(IscsiLun
*iscsilun
)
545 if (iscsilun
->allocmap
) {
546 bitmap_zero(iscsilun
->allocmap
, iscsilun
->allocmap_size
);
548 if (iscsilun
->allocmap_valid
) {
549 bitmap_zero(iscsilun
->allocmap_valid
, iscsilun
->allocmap_size
);
554 iscsi_allocmap_is_allocated(IscsiLun
*iscsilun
, int64_t sector_num
,
558 if (iscsilun
->allocmap
== NULL
) {
561 size
= DIV_ROUND_UP(sector_num
+ nb_sectors
, iscsilun
->cluster_sectors
);
562 return !(find_next_bit(iscsilun
->allocmap
, size
,
563 sector_num
/ iscsilun
->cluster_sectors
) == size
);
566 static inline bool iscsi_allocmap_is_valid(IscsiLun
*iscsilun
,
567 int64_t sector_num
, int nb_sectors
)
570 if (iscsilun
->allocmap_valid
== NULL
) {
573 size
= DIV_ROUND_UP(sector_num
+ nb_sectors
, iscsilun
->cluster_sectors
);
574 return (find_next_zero_bit(iscsilun
->allocmap_valid
, size
,
575 sector_num
/ iscsilun
->cluster_sectors
) == size
);
578 static int coroutine_fn
579 iscsi_co_writev_flags(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
,
580 QEMUIOVector
*iov
, int flags
)
582 IscsiLun
*iscsilun
= bs
->opaque
;
583 struct IscsiTask iTask
;
585 uint32_t num_sectors
;
586 bool fua
= flags
& BDRV_REQ_FUA
;
589 assert(iscsilun
->dpofua
);
591 if (!is_sector_request_lun_aligned(sector_num
, nb_sectors
, iscsilun
)) {
595 if (bs
->bl
.max_transfer
) {
596 assert(nb_sectors
<< BDRV_SECTOR_BITS
<= bs
->bl
.max_transfer
);
599 lba
= sector_qemu2lun(sector_num
, iscsilun
);
600 num_sectors
= sector_qemu2lun(nb_sectors
, iscsilun
);
601 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
603 if (iscsilun
->use_16_for_rw
) {
604 #if LIBISCSI_API_VERSION >= (20160603)
605 iTask
.task
= iscsi_write16_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
);
611 iTask
.task
= iscsi_write10_iov_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
612 NULL
, num_sectors
* iscsilun
->block_size
,
613 iscsilun
->block_size
, 0, 0, fua
, 0, 0,
614 iscsi_co_generic_cb
, &iTask
,
615 (struct scsi_iovec
*)iov
->iov
, iov
->niov
);
618 iTask
.task
= iscsi_write16_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
);
623 iTask
.task
= iscsi_write10_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
624 NULL
, num_sectors
* iscsilun
->block_size
,
625 iscsilun
->block_size
, 0, 0, fua
, 0, 0,
626 iscsi_co_generic_cb
, &iTask
);
629 if (iTask
.task
== NULL
) {
632 #if LIBISCSI_API_VERSION < (20160603)
633 scsi_task_set_iov_out(iTask
.task
, (struct scsi_iovec
*) iov
->iov
,
636 while (!iTask
.complete
) {
637 iscsi_set_events(iscsilun
);
638 qemu_coroutine_yield();
641 if (iTask
.task
!= NULL
) {
642 scsi_free_scsi_task(iTask
.task
);
646 if (iTask
.do_retry
) {
651 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
652 iscsi_allocmap_set_invalid(iscsilun
, sector_num
, nb_sectors
);
653 return iTask
.err_code
;
656 iscsi_allocmap_set_allocated(iscsilun
, sector_num
, nb_sectors
);
663 static int64_t coroutine_fn
iscsi_co_get_block_status(BlockDriverState
*bs
,
665 int nb_sectors
, int *pnum
,
666 BlockDriverState
**file
)
668 IscsiLun
*iscsilun
= bs
->opaque
;
669 struct scsi_get_lba_status
*lbas
= NULL
;
670 struct scsi_lba_status_descriptor
*lbasd
= NULL
;
671 struct IscsiTask iTask
;
674 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
676 if (!is_sector_request_lun_aligned(sector_num
, nb_sectors
, iscsilun
)) {
681 /* default to all sectors allocated */
682 ret
= BDRV_BLOCK_DATA
;
683 ret
|= (sector_num
<< BDRV_SECTOR_BITS
) | BDRV_BLOCK_OFFSET_VALID
;
686 /* LUN does not support logical block provisioning */
687 if (!iscsilun
->lbpme
) {
692 if (iscsi_get_lba_status_task(iscsilun
->iscsi
, iscsilun
->lun
,
693 sector_qemu2lun(sector_num
, iscsilun
),
694 8 + 16, iscsi_co_generic_cb
,
700 while (!iTask
.complete
) {
701 iscsi_set_events(iscsilun
);
702 qemu_coroutine_yield();
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 */
722 lbas
= scsi_datain_unmarshall(iTask
.task
);
728 lbasd
= &lbas
->descriptors
[0];
730 if (sector_qemu2lun(sector_num
, iscsilun
) != lbasd
->lba
) {
735 *pnum
= sector_lun2qemu(lbasd
->num_blocks
, iscsilun
);
737 if (lbasd
->provisioning
== SCSI_PROVISIONING_TYPE_DEALLOCATED
||
738 lbasd
->provisioning
== SCSI_PROVISIONING_TYPE_ANCHORED
) {
739 ret
&= ~BDRV_BLOCK_DATA
;
740 if (iscsilun
->lbprz
) {
741 ret
|= BDRV_BLOCK_ZERO
;
745 if (ret
& BDRV_BLOCK_ZERO
) {
746 iscsi_allocmap_set_unallocated(iscsilun
, sector_num
, *pnum
);
748 iscsi_allocmap_set_allocated(iscsilun
, sector_num
, *pnum
);
751 if (*pnum
> nb_sectors
) {
755 if (iTask
.task
!= NULL
) {
756 scsi_free_scsi_task(iTask
.task
);
758 if (ret
> 0 && ret
& BDRV_BLOCK_OFFSET_VALID
) {
764 static int coroutine_fn
iscsi_co_readv(BlockDriverState
*bs
,
765 int64_t sector_num
, int nb_sectors
,
768 IscsiLun
*iscsilun
= bs
->opaque
;
769 struct IscsiTask iTask
;
771 uint32_t num_sectors
;
773 if (!is_sector_request_lun_aligned(sector_num
, nb_sectors
, iscsilun
)) {
777 if (bs
->bl
.max_transfer
) {
778 assert(nb_sectors
<< BDRV_SECTOR_BITS
<= bs
->bl
.max_transfer
);
781 /* if cache.direct is off and we have a valid entry in our allocation map
782 * we can skip checking the block status and directly return zeroes if
783 * the request falls within an unallocated area */
784 if (iscsi_allocmap_is_valid(iscsilun
, sector_num
, nb_sectors
) &&
785 !iscsi_allocmap_is_allocated(iscsilun
, sector_num
, nb_sectors
)) {
786 qemu_iovec_memset(iov
, 0, 0x00, iov
->size
);
790 if (nb_sectors
>= ISCSI_CHECKALLOC_THRES
&&
791 !iscsi_allocmap_is_valid(iscsilun
, sector_num
, nb_sectors
) &&
792 !iscsi_allocmap_is_allocated(iscsilun
, sector_num
, nb_sectors
)) {
794 BlockDriverState
*file
;
795 /* check the block status from the beginning of the cluster
796 * containing the start sector */
797 int64_t ret
= iscsi_co_get_block_status(bs
,
798 sector_num
- sector_num
% iscsilun
->cluster_sectors
,
799 BDRV_REQUEST_MAX_SECTORS
, &pnum
, &file
);
803 /* if the whole request falls into an unallocated area we can avoid
804 * to read and directly return zeroes instead */
805 if (ret
& BDRV_BLOCK_ZERO
&&
806 pnum
>= nb_sectors
+ sector_num
% iscsilun
->cluster_sectors
) {
807 qemu_iovec_memset(iov
, 0, 0x00, iov
->size
);
812 lba
= sector_qemu2lun(sector_num
, iscsilun
);
813 num_sectors
= sector_qemu2lun(nb_sectors
, iscsilun
);
815 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
817 if (iscsilun
->use_16_for_rw
) {
818 #if LIBISCSI_API_VERSION >= (20160603)
819 iTask
.task
= iscsi_read16_iov_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
820 num_sectors
* iscsilun
->block_size
,
821 iscsilun
->block_size
, 0, 0, 0, 0, 0,
822 iscsi_co_generic_cb
, &iTask
,
823 (struct scsi_iovec
*)iov
->iov
, iov
->niov
);
825 iTask
.task
= iscsi_read10_iov_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
826 num_sectors
* iscsilun
->block_size
,
827 iscsilun
->block_size
,
829 iscsi_co_generic_cb
, &iTask
,
830 (struct scsi_iovec
*)iov
->iov
, iov
->niov
);
833 iTask
.task
= iscsi_read16_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
);
838 iTask
.task
= iscsi_read10_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
839 num_sectors
* iscsilun
->block_size
,
840 iscsilun
->block_size
,
842 iscsi_co_generic_cb
, &iTask
);
845 if (iTask
.task
== NULL
) {
848 #if LIBISCSI_API_VERSION < (20160603)
849 scsi_task_set_iov_in(iTask
.task
, (struct scsi_iovec
*) iov
->iov
, iov
->niov
);
851 while (!iTask
.complete
) {
852 iscsi_set_events(iscsilun
);
853 qemu_coroutine_yield();
856 if (iTask
.task
!= NULL
) {
857 scsi_free_scsi_task(iTask
.task
);
861 if (iTask
.do_retry
) {
866 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
867 return iTask
.err_code
;
873 static int coroutine_fn
iscsi_co_flush(BlockDriverState
*bs
)
875 IscsiLun
*iscsilun
= bs
->opaque
;
876 struct IscsiTask iTask
;
878 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
880 if (iscsi_synchronizecache10_task(iscsilun
->iscsi
, iscsilun
->lun
, 0, 0, 0,
881 0, iscsi_co_generic_cb
, &iTask
) == NULL
) {
885 while (!iTask
.complete
) {
886 iscsi_set_events(iscsilun
);
887 qemu_coroutine_yield();
890 if (iTask
.task
!= NULL
) {
891 scsi_free_scsi_task(iTask
.task
);
895 if (iTask
.do_retry
) {
900 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
901 return iTask
.err_code
;
909 iscsi_aio_ioctl_cb(struct iscsi_context
*iscsi
, int status
,
910 void *command_data
, void *opaque
)
912 IscsiAIOCB
*acb
= opaque
;
919 error_report("Failed to ioctl(SG_IO) to iSCSI lun. %s",
920 iscsi_get_error(iscsi
));
921 acb
->status
= iscsi_translate_sense(&acb
->task
->sense
);
924 acb
->ioh
->driver_status
= 0;
925 acb
->ioh
->host_status
= 0;
927 acb
->ioh
->status
= status
;
929 #define SG_ERR_DRIVER_SENSE 0x08
931 if (status
== SCSI_STATUS_CHECK_CONDITION
&& acb
->task
->datain
.size
>= 2) {
934 acb
->ioh
->driver_status
|= SG_ERR_DRIVER_SENSE
;
936 acb
->ioh
->sb_len_wr
= acb
->task
->datain
.size
- 2;
937 ss
= (acb
->ioh
->mx_sb_len
>= acb
->ioh
->sb_len_wr
) ?
938 acb
->ioh
->mx_sb_len
: acb
->ioh
->sb_len_wr
;
939 memcpy(acb
->ioh
->sbp
, &acb
->task
->datain
.data
[2], ss
);
942 iscsi_schedule_bh(acb
);
945 static void iscsi_ioctl_bh_completion(void *opaque
)
947 IscsiAIOCB
*acb
= opaque
;
949 qemu_bh_delete(acb
->bh
);
950 acb
->common
.cb(acb
->common
.opaque
, acb
->ret
);
954 static void iscsi_ioctl_handle_emulated(IscsiAIOCB
*acb
, int req
, void *buf
)
956 BlockDriverState
*bs
= acb
->common
.bs
;
957 IscsiLun
*iscsilun
= bs
->opaque
;
961 case SG_GET_VERSION_NUM
:
965 ((struct sg_scsi_id
*)buf
)->scsi_type
= iscsilun
->type
;
971 acb
->bh
= aio_bh_new(bdrv_get_aio_context(bs
),
972 iscsi_ioctl_bh_completion
, acb
);
974 qemu_bh_schedule(acb
->bh
);
977 static BlockAIOCB
*iscsi_aio_ioctl(BlockDriverState
*bs
,
978 unsigned long int req
, void *buf
,
979 BlockCompletionFunc
*cb
, void *opaque
)
981 IscsiLun
*iscsilun
= bs
->opaque
;
982 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
983 struct iscsi_data data
;
986 acb
= qemu_aio_get(&iscsi_aiocb_info
, bs
, cb
, opaque
);
988 acb
->iscsilun
= iscsilun
;
990 acb
->status
= -EINPROGRESS
;
995 iscsi_ioctl_handle_emulated(acb
, req
, buf
);
999 if (acb
->ioh
->cmd_len
> SCSI_CDB_MAX_SIZE
) {
1000 error_report("iSCSI: ioctl error CDB exceeds max size (%d > %d)",
1001 acb
->ioh
->cmd_len
, SCSI_CDB_MAX_SIZE
);
1002 qemu_aio_unref(acb
);
1006 acb
->task
= malloc(sizeof(struct scsi_task
));
1007 if (acb
->task
== NULL
) {
1008 error_report("iSCSI: Failed to allocate task for scsi command. %s",
1009 iscsi_get_error(iscsi
));
1010 qemu_aio_unref(acb
);
1013 memset(acb
->task
, 0, sizeof(struct scsi_task
));
1015 switch (acb
->ioh
->dxfer_direction
) {
1016 case SG_DXFER_TO_DEV
:
1017 acb
->task
->xfer_dir
= SCSI_XFER_WRITE
;
1019 case SG_DXFER_FROM_DEV
:
1020 acb
->task
->xfer_dir
= SCSI_XFER_READ
;
1023 acb
->task
->xfer_dir
= SCSI_XFER_NONE
;
1027 acb
->task
->cdb_size
= acb
->ioh
->cmd_len
;
1028 memcpy(&acb
->task
->cdb
[0], acb
->ioh
->cmdp
, acb
->ioh
->cmd_len
);
1029 acb
->task
->expxferlen
= acb
->ioh
->dxfer_len
;
1032 if (acb
->task
->xfer_dir
== SCSI_XFER_WRITE
) {
1033 if (acb
->ioh
->iovec_count
== 0) {
1034 data
.data
= acb
->ioh
->dxferp
;
1035 data
.size
= acb
->ioh
->dxfer_len
;
1037 scsi_task_set_iov_out(acb
->task
,
1038 (struct scsi_iovec
*) acb
->ioh
->dxferp
,
1039 acb
->ioh
->iovec_count
);
1043 if (iscsi_scsi_command_async(iscsi
, iscsilun
->lun
, acb
->task
,
1045 (data
.size
> 0) ? &data
: NULL
,
1047 scsi_free_scsi_task(acb
->task
);
1048 qemu_aio_unref(acb
);
1052 /* tell libiscsi to read straight into the buffer we got from ioctl */
1053 if (acb
->task
->xfer_dir
== SCSI_XFER_READ
) {
1054 if (acb
->ioh
->iovec_count
== 0) {
1055 scsi_task_add_data_in_buffer(acb
->task
,
1056 acb
->ioh
->dxfer_len
,
1059 scsi_task_set_iov_in(acb
->task
,
1060 (struct scsi_iovec
*) acb
->ioh
->dxferp
,
1061 acb
->ioh
->iovec_count
);
1065 iscsi_set_events(iscsilun
);
1067 return &acb
->common
;
1073 iscsi_getlength(BlockDriverState
*bs
)
1075 IscsiLun
*iscsilun
= bs
->opaque
;
1078 len
= iscsilun
->num_blocks
;
1079 len
*= iscsilun
->block_size
;
1085 coroutine_fn
iscsi_co_pdiscard(BlockDriverState
*bs
, int64_t offset
, int count
)
1087 IscsiLun
*iscsilun
= bs
->opaque
;
1088 struct IscsiTask iTask
;
1089 struct unmap_list list
;
1091 if (!is_byte_request_lun_aligned(offset
, count
, iscsilun
)) {
1095 if (!iscsilun
->lbp
.lbpu
) {
1096 /* UNMAP is not supported by the target */
1100 list
.lba
= offset
/ iscsilun
->block_size
;
1101 list
.num
= count
/ iscsilun
->block_size
;
1103 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
1105 if (iscsi_unmap_task(iscsilun
->iscsi
, iscsilun
->lun
, 0, 0, &list
, 1,
1106 iscsi_co_generic_cb
, &iTask
) == NULL
) {
1110 while (!iTask
.complete
) {
1111 iscsi_set_events(iscsilun
);
1112 qemu_coroutine_yield();
1115 if (iTask
.task
!= NULL
) {
1116 scsi_free_scsi_task(iTask
.task
);
1120 if (iTask
.do_retry
) {
1125 if (iTask
.status
== SCSI_STATUS_CHECK_CONDITION
) {
1126 /* the target might fail with a check condition if it
1127 is not happy with the alignment of the UNMAP request
1128 we silently fail in this case */
1132 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
1133 return iTask
.err_code
;
1136 iscsi_allocmap_set_invalid(iscsilun
, offset
>> BDRV_SECTOR_BITS
,
1137 count
>> BDRV_SECTOR_BITS
);
1143 coroutine_fn
iscsi_co_pwrite_zeroes(BlockDriverState
*bs
, int64_t offset
,
1144 int count
, BdrvRequestFlags flags
)
1146 IscsiLun
*iscsilun
= bs
->opaque
;
1147 struct IscsiTask iTask
;
1150 bool use_16_for_ws
= iscsilun
->use_16_for_rw
;
1152 if (!is_byte_request_lun_aligned(offset
, count
, iscsilun
)) {
1156 if (flags
& BDRV_REQ_MAY_UNMAP
) {
1157 if (!use_16_for_ws
&& !iscsilun
->lbp
.lbpws10
) {
1158 /* WRITESAME10 with UNMAP is unsupported try WRITESAME16 */
1159 use_16_for_ws
= true;
1161 if (use_16_for_ws
&& !iscsilun
->lbp
.lbpws
) {
1162 /* WRITESAME16 with UNMAP is not supported by the target,
1163 * fall back and try WRITESAME10/16 without UNMAP */
1164 flags
&= ~BDRV_REQ_MAY_UNMAP
;
1165 use_16_for_ws
= iscsilun
->use_16_for_rw
;
1169 if (!(flags
& BDRV_REQ_MAY_UNMAP
) && !iscsilun
->has_write_same
) {
1170 /* WRITESAME without UNMAP is not supported by the target */
1174 lba
= offset
/ iscsilun
->block_size
;
1175 nb_blocks
= count
/ iscsilun
->block_size
;
1177 if (iscsilun
->zeroblock
== NULL
) {
1178 iscsilun
->zeroblock
= g_try_malloc0(iscsilun
->block_size
);
1179 if (iscsilun
->zeroblock
== NULL
) {
1184 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
1186 if (use_16_for_ws
) {
1187 iTask
.task
= iscsi_writesame16_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
1188 iscsilun
->zeroblock
, iscsilun
->block_size
,
1189 nb_blocks
, 0, !!(flags
& BDRV_REQ_MAY_UNMAP
),
1190 0, 0, iscsi_co_generic_cb
, &iTask
);
1192 iTask
.task
= iscsi_writesame10_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
1193 iscsilun
->zeroblock
, iscsilun
->block_size
,
1194 nb_blocks
, 0, !!(flags
& BDRV_REQ_MAY_UNMAP
),
1195 0, 0, iscsi_co_generic_cb
, &iTask
);
1197 if (iTask
.task
== NULL
) {
1201 while (!iTask
.complete
) {
1202 iscsi_set_events(iscsilun
);
1203 qemu_coroutine_yield();
1206 if (iTask
.status
== SCSI_STATUS_CHECK_CONDITION
&&
1207 iTask
.task
->sense
.key
== SCSI_SENSE_ILLEGAL_REQUEST
&&
1208 (iTask
.task
->sense
.ascq
== SCSI_SENSE_ASCQ_INVALID_OPERATION_CODE
||
1209 iTask
.task
->sense
.ascq
== SCSI_SENSE_ASCQ_INVALID_FIELD_IN_CDB
)) {
1210 /* WRITE SAME is not supported by the target */
1211 iscsilun
->has_write_same
= false;
1212 scsi_free_scsi_task(iTask
.task
);
1216 if (iTask
.task
!= NULL
) {
1217 scsi_free_scsi_task(iTask
.task
);
1221 if (iTask
.do_retry
) {
1226 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
1227 iscsi_allocmap_set_invalid(iscsilun
, offset
>> BDRV_SECTOR_BITS
,
1228 count
>> BDRV_SECTOR_BITS
);
1229 return iTask
.err_code
;
1232 if (flags
& BDRV_REQ_MAY_UNMAP
) {
1233 iscsi_allocmap_set_invalid(iscsilun
, offset
>> BDRV_SECTOR_BITS
,
1234 count
>> BDRV_SECTOR_BITS
);
1236 iscsi_allocmap_set_allocated(iscsilun
, offset
>> BDRV_SECTOR_BITS
,
1237 count
>> BDRV_SECTOR_BITS
);
1243 static void parse_chap(struct iscsi_context
*iscsi
, const char *target
,
1248 const char *user
= NULL
;
1249 const char *password
= NULL
;
1250 const char *secretid
;
1251 char *secret
= NULL
;
1253 list
= qemu_find_opts("iscsi");
1258 opts
= qemu_opts_find(list
, target
);
1260 opts
= QTAILQ_FIRST(&list
->head
);
1266 user
= qemu_opt_get(opts
, "user");
1271 secretid
= qemu_opt_get(opts
, "password-secret");
1272 password
= qemu_opt_get(opts
, "password");
1273 if (secretid
&& password
) {
1274 error_setg(errp
, "'password' and 'password-secret' properties are "
1275 "mutually exclusive");
1279 secret
= qcrypto_secret_lookup_as_utf8(secretid
, errp
);
1284 } else if (!password
) {
1285 error_setg(errp
, "CHAP username specified but no password was given");
1289 if (iscsi_set_initiator_username_pwd(iscsi
, user
, password
)) {
1290 error_setg(errp
, "Failed to set initiator username and password");
1296 static void parse_header_digest(struct iscsi_context
*iscsi
, const char *target
,
1301 const char *digest
= NULL
;
1303 list
= qemu_find_opts("iscsi");
1308 opts
= qemu_opts_find(list
, target
);
1310 opts
= QTAILQ_FIRST(&list
->head
);
1316 digest
= qemu_opt_get(opts
, "header-digest");
1321 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 *parse_initiator_name(const char *target
)
1340 UuidInfo
*uuid_info
;
1342 list
= qemu_find_opts("iscsi");
1344 opts
= qemu_opts_find(list
, target
);
1346 opts
= QTAILQ_FIRST(&list
->head
);
1349 name
= qemu_opt_get(opts
, "initiator-name");
1351 return g_strdup(name
);
1356 uuid_info
= qmp_query_uuid(NULL
);
1357 if (strcmp(uuid_info
->UUID
, UUID_NONE
) == 0) {
1358 name
= qemu_get_vm_name();
1360 name
= uuid_info
->UUID
;
1362 iscsi_name
= g_strdup_printf("iqn.2008-11.org.linux-kvm%s%s",
1363 name
? ":" : "", name
? name
: "");
1364 qapi_free_UuidInfo(uuid_info
);
1368 static int parse_timeout(const char *target
)
1372 const char *timeout
;
1374 list
= qemu_find_opts("iscsi");
1376 opts
= qemu_opts_find(list
, target
);
1378 opts
= QTAILQ_FIRST(&list
->head
);
1381 timeout
= qemu_opt_get(opts
, "timeout");
1383 return atoi(timeout
);
1391 static void iscsi_nop_timed_event(void *opaque
)
1393 IscsiLun
*iscsilun
= opaque
;
1395 if (iscsi_get_nops_in_flight(iscsilun
->iscsi
) >= MAX_NOP_FAILURES
) {
1396 error_report("iSCSI: NOP timeout. Reconnecting...");
1397 iscsilun
->request_timed_out
= true;
1398 } else if (iscsi_nop_out_async(iscsilun
->iscsi
, NULL
, NULL
, 0, NULL
) != 0) {
1399 error_report("iSCSI: failed to sent NOP-Out. Disabling NOP messages.");
1403 timer_mod(iscsilun
->nop_timer
, qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) + NOP_INTERVAL
);
1404 iscsi_set_events(iscsilun
);
1407 static void iscsi_readcapacity_sync(IscsiLun
*iscsilun
, Error
**errp
)
1409 struct scsi_task
*task
= NULL
;
1410 struct scsi_readcapacity10
*rc10
= NULL
;
1411 struct scsi_readcapacity16
*rc16
= NULL
;
1412 int retries
= ISCSI_CMD_RETRIES
;
1416 scsi_free_scsi_task(task
);
1420 switch (iscsilun
->type
) {
1422 task
= iscsi_readcapacity16_sync(iscsilun
->iscsi
, iscsilun
->lun
);
1423 if (task
!= NULL
&& task
->status
== SCSI_STATUS_GOOD
) {
1424 rc16
= scsi_datain_unmarshall(task
);
1426 error_setg(errp
, "iSCSI: Failed to unmarshall readcapacity16 data.");
1428 iscsilun
->block_size
= rc16
->block_length
;
1429 iscsilun
->num_blocks
= rc16
->returned_lba
+ 1;
1430 iscsilun
->lbpme
= !!rc16
->lbpme
;
1431 iscsilun
->lbprz
= !!rc16
->lbprz
;
1432 iscsilun
->use_16_for_rw
= (rc16
->returned_lba
> 0xffffffff);
1436 if (task
!= NULL
&& task
->status
== SCSI_STATUS_CHECK_CONDITION
1437 && task
->sense
.key
== SCSI_SENSE_UNIT_ATTENTION
) {
1440 /* Fall through and try READ CAPACITY(10) instead. */
1442 task
= iscsi_readcapacity10_sync(iscsilun
->iscsi
, iscsilun
->lun
, 0, 0);
1443 if (task
!= NULL
&& task
->status
== SCSI_STATUS_GOOD
) {
1444 rc10
= scsi_datain_unmarshall(task
);
1446 error_setg(errp
, "iSCSI: Failed to unmarshall readcapacity10 data.");
1448 iscsilun
->block_size
= rc10
->block_size
;
1449 if (rc10
->lba
== 0) {
1450 /* blank disk loaded */
1451 iscsilun
->num_blocks
= 0;
1453 iscsilun
->num_blocks
= rc10
->lba
+ 1;
1461 } while (task
!= NULL
&& task
->status
== SCSI_STATUS_CHECK_CONDITION
1462 && task
->sense
.key
== SCSI_SENSE_UNIT_ATTENTION
1465 if (task
== NULL
|| task
->status
!= SCSI_STATUS_GOOD
) {
1466 error_setg(errp
, "iSCSI: failed to send readcapacity10/16 command");
1467 } else if (!iscsilun
->block_size
||
1468 iscsilun
->block_size
% BDRV_SECTOR_SIZE
) {
1469 error_setg(errp
, "iSCSI: the target returned an invalid "
1470 "block size of %d.", iscsilun
->block_size
);
1473 scsi_free_scsi_task(task
);
1477 /* TODO Convert to fine grained options */
1478 static QemuOptsList runtime_opts
= {
1480 .head
= QTAILQ_HEAD_INITIALIZER(runtime_opts
.head
),
1484 .type
= QEMU_OPT_STRING
,
1485 .help
= "URL to the iscsi image",
1487 { /* end of list */ }
1491 static struct scsi_task
*iscsi_do_inquiry(struct iscsi_context
*iscsi
, int lun
,
1492 int evpd
, int pc
, void **inq
, Error
**errp
)
1495 struct scsi_task
*task
= NULL
;
1496 task
= iscsi_inquiry_sync(iscsi
, lun
, evpd
, pc
, 64);
1497 if (task
== NULL
|| task
->status
!= SCSI_STATUS_GOOD
) {
1500 full_size
= scsi_datain_getfullsize(task
);
1501 if (full_size
> task
->datain
.size
) {
1502 scsi_free_scsi_task(task
);
1504 /* we need more data for the full list */
1505 task
= iscsi_inquiry_sync(iscsi
, lun
, evpd
, pc
, full_size
);
1506 if (task
== NULL
|| task
->status
!= SCSI_STATUS_GOOD
) {
1511 *inq
= scsi_datain_unmarshall(task
);
1513 error_setg(errp
, "iSCSI: failed to unmarshall inquiry datain blob");
1520 error_setg(errp
, "iSCSI: Inquiry command failed : %s",
1521 iscsi_get_error(iscsi
));
1524 scsi_free_scsi_task(task
);
1529 static void iscsi_detach_aio_context(BlockDriverState
*bs
)
1531 IscsiLun
*iscsilun
= bs
->opaque
;
1533 aio_set_fd_handler(iscsilun
->aio_context
, iscsi_get_fd(iscsilun
->iscsi
),
1534 false, NULL
, NULL
, NULL
, NULL
);
1535 iscsilun
->events
= 0;
1537 if (iscsilun
->nop_timer
) {
1538 timer_del(iscsilun
->nop_timer
);
1539 timer_free(iscsilun
->nop_timer
);
1540 iscsilun
->nop_timer
= NULL
;
1542 if (iscsilun
->event_timer
) {
1543 timer_del(iscsilun
->event_timer
);
1544 timer_free(iscsilun
->event_timer
);
1545 iscsilun
->event_timer
= NULL
;
1549 static void iscsi_attach_aio_context(BlockDriverState
*bs
,
1550 AioContext
*new_context
)
1552 IscsiLun
*iscsilun
= bs
->opaque
;
1554 iscsilun
->aio_context
= new_context
;
1555 iscsi_set_events(iscsilun
);
1557 /* Set up a timer for sending out iSCSI NOPs */
1558 iscsilun
->nop_timer
= aio_timer_new(iscsilun
->aio_context
,
1559 QEMU_CLOCK_REALTIME
, SCALE_MS
,
1560 iscsi_nop_timed_event
, iscsilun
);
1561 timer_mod(iscsilun
->nop_timer
,
1562 qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) + NOP_INTERVAL
);
1564 /* Set up a timer for periodic calls to iscsi_set_events and to
1565 * scan for command timeout */
1566 iscsilun
->event_timer
= aio_timer_new(iscsilun
->aio_context
,
1567 QEMU_CLOCK_REALTIME
, SCALE_MS
,
1568 iscsi_timed_check_events
, iscsilun
);
1569 timer_mod(iscsilun
->event_timer
,
1570 qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) + EVENT_INTERVAL
);
1573 static void iscsi_modesense_sync(IscsiLun
*iscsilun
)
1575 struct scsi_task
*task
;
1576 struct scsi_mode_sense
*ms
= NULL
;
1577 iscsilun
->write_protected
= false;
1578 iscsilun
->dpofua
= false;
1580 task
= iscsi_modesense6_sync(iscsilun
->iscsi
, iscsilun
->lun
,
1581 1, SCSI_MODESENSE_PC_CURRENT
,
1584 error_report("iSCSI: Failed to send MODE_SENSE(6) command: %s",
1585 iscsi_get_error(iscsilun
->iscsi
));
1589 if (task
->status
!= SCSI_STATUS_GOOD
) {
1590 error_report("iSCSI: Failed MODE_SENSE(6), LUN assumed writable");
1593 ms
= scsi_datain_unmarshall(task
);
1595 error_report("iSCSI: Failed to unmarshall MODE_SENSE(6) data: %s",
1596 iscsi_get_error(iscsilun
->iscsi
));
1599 iscsilun
->write_protected
= ms
->device_specific_parameter
& 0x80;
1600 iscsilun
->dpofua
= ms
->device_specific_parameter
& 0x10;
1604 scsi_free_scsi_task(task
);
1609 * We support iscsi url's on the form
1610 * iscsi://[<username>%<password>@]<host>[:<port>]/<targetname>/<lun>
1612 static int iscsi_open(BlockDriverState
*bs
, QDict
*options
, int flags
,
1615 IscsiLun
*iscsilun
= bs
->opaque
;
1616 struct iscsi_context
*iscsi
= NULL
;
1617 struct iscsi_url
*iscsi_url
= NULL
;
1618 struct scsi_task
*task
= NULL
;
1619 struct scsi_inquiry_standard
*inq
= NULL
;
1620 struct scsi_inquiry_supported_pages
*inq_vpd
;
1621 char *initiator_name
= NULL
;
1623 Error
*local_err
= NULL
;
1624 const char *filename
;
1625 int i
, ret
= 0, timeout
= 0;
1627 opts
= qemu_opts_create(&runtime_opts
, NULL
, 0, &error_abort
);
1628 qemu_opts_absorb_qdict(opts
, options
, &local_err
);
1630 error_propagate(errp
, local_err
);
1635 filename
= qemu_opt_get(opts
, "filename");
1637 iscsi_url
= iscsi_parse_full_url(iscsi
, filename
);
1638 if (iscsi_url
== NULL
) {
1639 error_setg(errp
, "Failed to parse URL : %s", filename
);
1644 memset(iscsilun
, 0, sizeof(IscsiLun
));
1646 initiator_name
= parse_initiator_name(iscsi_url
->target
);
1648 iscsi
= iscsi_create_context(initiator_name
);
1649 if (iscsi
== NULL
) {
1650 error_setg(errp
, "iSCSI: Failed to create iSCSI context.");
1654 #if LIBISCSI_API_VERSION >= (20160603)
1655 if (iscsi_init_transport(iscsi
, iscsi_url
->transport
)) {
1656 error_setg(errp
, ("Error initializing transport."));
1661 if (iscsi_set_targetname(iscsi
, iscsi_url
->target
)) {
1662 error_setg(errp
, "iSCSI: Failed to set target name.");
1667 if (iscsi_url
->user
[0] != '\0') {
1668 ret
= iscsi_set_initiator_username_pwd(iscsi
, iscsi_url
->user
,
1671 error_setg(errp
, "Failed to set initiator username and password");
1677 /* check if we got CHAP username/password via the options */
1678 parse_chap(iscsi
, iscsi_url
->target
, &local_err
);
1679 if (local_err
!= NULL
) {
1680 error_propagate(errp
, local_err
);
1685 if (iscsi_set_session_type(iscsi
, ISCSI_SESSION_NORMAL
) != 0) {
1686 error_setg(errp
, "iSCSI: Failed to set session type to normal.");
1691 iscsi_set_header_digest(iscsi
, ISCSI_HEADER_DIGEST_NONE_CRC32C
);
1693 /* check if we got HEADER_DIGEST via the options */
1694 parse_header_digest(iscsi
, iscsi_url
->target
, &local_err
);
1695 if (local_err
!= NULL
) {
1696 error_propagate(errp
, local_err
);
1701 /* timeout handling is broken in libiscsi before 1.15.0 */
1702 timeout
= parse_timeout(iscsi_url
->target
);
1703 #if LIBISCSI_API_VERSION >= 20150621
1704 iscsi_set_timeout(iscsi
, timeout
);
1707 error_report("iSCSI: ignoring timeout value for libiscsi <1.15.0");
1711 if (iscsi_full_connect_sync(iscsi
, iscsi_url
->portal
, iscsi_url
->lun
) != 0) {
1712 error_setg(errp
, "iSCSI: Failed to connect to LUN : %s",
1713 iscsi_get_error(iscsi
));
1718 iscsilun
->iscsi
= iscsi
;
1719 iscsilun
->aio_context
= bdrv_get_aio_context(bs
);
1720 iscsilun
->lun
= iscsi_url
->lun
;
1721 iscsilun
->has_write_same
= true;
1723 task
= iscsi_do_inquiry(iscsilun
->iscsi
, iscsilun
->lun
, 0, 0,
1724 (void **) &inq
, errp
);
1729 iscsilun
->type
= inq
->periperal_device_type
;
1730 scsi_free_scsi_task(task
);
1733 iscsi_modesense_sync(iscsilun
);
1734 if (iscsilun
->dpofua
) {
1735 bs
->supported_write_flags
= BDRV_REQ_FUA
;
1737 bs
->supported_zero_flags
= BDRV_REQ_MAY_UNMAP
;
1739 /* Check the write protect flag of the LUN if we want to write */
1740 if (iscsilun
->type
== TYPE_DISK
&& (flags
& BDRV_O_RDWR
) &&
1741 iscsilun
->write_protected
) {
1742 error_setg(errp
, "Cannot open a write protected LUN as read-write");
1747 iscsi_readcapacity_sync(iscsilun
, &local_err
);
1748 if (local_err
!= NULL
) {
1749 error_propagate(errp
, local_err
);
1753 bs
->total_sectors
= sector_lun2qemu(iscsilun
->num_blocks
, iscsilun
);
1755 /* We don't have any emulation for devices other than disks and CD-ROMs, so
1756 * this must be sg ioctl compatible. We force it to be sg, otherwise qemu
1757 * will try to read from the device to guess the image format.
1759 if (iscsilun
->type
!= TYPE_DISK
&& iscsilun
->type
!= TYPE_ROM
) {
1763 task
= iscsi_do_inquiry(iscsilun
->iscsi
, iscsilun
->lun
, 1,
1764 SCSI_INQUIRY_PAGECODE_SUPPORTED_VPD_PAGES
,
1765 (void **) &inq_vpd
, errp
);
1770 for (i
= 0; i
< inq_vpd
->num_pages
; i
++) {
1771 struct scsi_task
*inq_task
;
1772 struct scsi_inquiry_logical_block_provisioning
*inq_lbp
;
1773 struct scsi_inquiry_block_limits
*inq_bl
;
1774 switch (inq_vpd
->pages
[i
]) {
1775 case SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING
:
1776 inq_task
= iscsi_do_inquiry(iscsilun
->iscsi
, iscsilun
->lun
, 1,
1777 SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING
,
1778 (void **) &inq_lbp
, errp
);
1779 if (inq_task
== NULL
) {
1783 memcpy(&iscsilun
->lbp
, inq_lbp
,
1784 sizeof(struct scsi_inquiry_logical_block_provisioning
));
1785 scsi_free_scsi_task(inq_task
);
1787 case SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS
:
1788 inq_task
= iscsi_do_inquiry(iscsilun
->iscsi
, iscsilun
->lun
, 1,
1789 SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS
,
1790 (void **) &inq_bl
, errp
);
1791 if (inq_task
== NULL
) {
1795 memcpy(&iscsilun
->bl
, inq_bl
,
1796 sizeof(struct scsi_inquiry_block_limits
));
1797 scsi_free_scsi_task(inq_task
);
1803 scsi_free_scsi_task(task
);
1806 iscsi_attach_aio_context(bs
, iscsilun
->aio_context
);
1808 /* Guess the internal cluster (page) size of the iscsi target by the means
1809 * of opt_unmap_gran. Transfer the unmap granularity only if it has a
1810 * reasonable size */
1811 if (iscsilun
->bl
.opt_unmap_gran
* iscsilun
->block_size
>= 4 * 1024 &&
1812 iscsilun
->bl
.opt_unmap_gran
* iscsilun
->block_size
<= 16 * 1024 * 1024) {
1813 iscsilun
->cluster_sectors
= (iscsilun
->bl
.opt_unmap_gran
*
1814 iscsilun
->block_size
) >> BDRV_SECTOR_BITS
;
1815 if (iscsilun
->lbprz
) {
1816 ret
= iscsi_allocmap_init(iscsilun
, bs
->open_flags
);
1821 qemu_opts_del(opts
);
1822 g_free(initiator_name
);
1823 if (iscsi_url
!= NULL
) {
1824 iscsi_destroy_url(iscsi_url
);
1827 scsi_free_scsi_task(task
);
1831 if (iscsi
!= NULL
) {
1832 if (iscsi_is_logged_in(iscsi
)) {
1833 iscsi_logout_sync(iscsi
);
1835 iscsi_destroy_context(iscsi
);
1837 memset(iscsilun
, 0, sizeof(IscsiLun
));
1842 static void iscsi_close(BlockDriverState
*bs
)
1844 IscsiLun
*iscsilun
= bs
->opaque
;
1845 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
1847 iscsi_detach_aio_context(bs
);
1848 if (iscsi_is_logged_in(iscsi
)) {
1849 iscsi_logout_sync(iscsi
);
1851 iscsi_destroy_context(iscsi
);
1852 g_free(iscsilun
->zeroblock
);
1853 iscsi_allocmap_free(iscsilun
);
1854 memset(iscsilun
, 0, sizeof(IscsiLun
));
1857 static void iscsi_refresh_limits(BlockDriverState
*bs
, Error
**errp
)
1859 /* We don't actually refresh here, but just return data queried in
1860 * iscsi_open(): iscsi targets don't change their limits. */
1862 IscsiLun
*iscsilun
= bs
->opaque
;
1863 uint64_t max_xfer_len
= iscsilun
->use_16_for_rw
? 0xffffffff : 0xffff;
1864 unsigned int block_size
= MAX(BDRV_SECTOR_SIZE
, iscsilun
->block_size
);
1866 assert(iscsilun
->block_size
>= BDRV_SECTOR_SIZE
|| bs
->sg
);
1868 bs
->bl
.request_alignment
= block_size
;
1870 if (iscsilun
->bl
.max_xfer_len
) {
1871 max_xfer_len
= MIN(max_xfer_len
, iscsilun
->bl
.max_xfer_len
);
1874 if (max_xfer_len
* block_size
< INT_MAX
) {
1875 bs
->bl
.max_transfer
= max_xfer_len
* iscsilun
->block_size
;
1878 if (iscsilun
->lbp
.lbpu
) {
1879 if (iscsilun
->bl
.max_unmap
< 0xffffffff / block_size
) {
1880 bs
->bl
.max_pdiscard
=
1881 iscsilun
->bl
.max_unmap
* iscsilun
->block_size
;
1883 bs
->bl
.pdiscard_alignment
=
1884 iscsilun
->bl
.opt_unmap_gran
* iscsilun
->block_size
;
1886 bs
->bl
.pdiscard_alignment
= iscsilun
->block_size
;
1889 if (iscsilun
->bl
.max_ws_len
< 0xffffffff / block_size
) {
1890 bs
->bl
.max_pwrite_zeroes
=
1891 iscsilun
->bl
.max_ws_len
* iscsilun
->block_size
;
1893 if (iscsilun
->lbp
.lbpws
) {
1894 bs
->bl
.pwrite_zeroes_alignment
=
1895 iscsilun
->bl
.opt_unmap_gran
* iscsilun
->block_size
;
1897 bs
->bl
.pwrite_zeroes_alignment
= iscsilun
->block_size
;
1899 if (iscsilun
->bl
.opt_xfer_len
&&
1900 iscsilun
->bl
.opt_xfer_len
< INT_MAX
/ block_size
) {
1901 bs
->bl
.opt_transfer
= pow2floor(iscsilun
->bl
.opt_xfer_len
*
1902 iscsilun
->block_size
);
1906 /* Note that this will not re-establish a connection with an iSCSI target - it
1907 * is effectively a NOP. */
1908 static int iscsi_reopen_prepare(BDRVReopenState
*state
,
1909 BlockReopenQueue
*queue
, Error
**errp
)
1911 IscsiLun
*iscsilun
= state
->bs
->opaque
;
1913 if (state
->flags
& BDRV_O_RDWR
&& iscsilun
->write_protected
) {
1914 error_setg(errp
, "Cannot open a write protected LUN as read-write");
1920 static void iscsi_reopen_commit(BDRVReopenState
*reopen_state
)
1922 IscsiLun
*iscsilun
= reopen_state
->bs
->opaque
;
1924 /* the cache.direct status might have changed */
1925 if (iscsilun
->allocmap
!= NULL
) {
1926 iscsi_allocmap_init(iscsilun
, reopen_state
->flags
);
1930 static int iscsi_truncate(BlockDriverState
*bs
, int64_t offset
)
1932 IscsiLun
*iscsilun
= bs
->opaque
;
1933 Error
*local_err
= NULL
;
1935 if (iscsilun
->type
!= TYPE_DISK
) {
1939 iscsi_readcapacity_sync(iscsilun
, &local_err
);
1940 if (local_err
!= NULL
) {
1941 error_free(local_err
);
1945 if (offset
> iscsi_getlength(bs
)) {
1949 if (iscsilun
->allocmap
!= NULL
) {
1950 iscsi_allocmap_init(iscsilun
, bs
->open_flags
);
1956 static int iscsi_create(const char *filename
, QemuOpts
*opts
, Error
**errp
)
1959 int64_t total_size
= 0;
1960 BlockDriverState
*bs
;
1961 IscsiLun
*iscsilun
= NULL
;
1966 /* Read out options */
1967 total_size
= DIV_ROUND_UP(qemu_opt_get_size_del(opts
, BLOCK_OPT_SIZE
, 0),
1969 bs
->opaque
= g_new0(struct IscsiLun
, 1);
1970 iscsilun
= bs
->opaque
;
1972 bs_options
= qdict_new();
1973 qdict_put(bs_options
, "filename", qstring_from_str(filename
));
1974 ret
= iscsi_open(bs
, bs_options
, 0, NULL
);
1975 QDECREF(bs_options
);
1980 iscsi_detach_aio_context(bs
);
1981 if (iscsilun
->type
!= TYPE_DISK
) {
1985 if (bs
->total_sectors
< total_size
) {
1992 if (iscsilun
->iscsi
!= NULL
) {
1993 iscsi_destroy_context(iscsilun
->iscsi
);
2001 static int iscsi_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
)
2003 IscsiLun
*iscsilun
= bs
->opaque
;
2004 bdi
->unallocated_blocks_are_zero
= iscsilun
->lbprz
;
2005 bdi
->can_write_zeroes_with_unmap
= iscsilun
->lbprz
&& iscsilun
->lbp
.lbpws
;
2006 bdi
->cluster_size
= iscsilun
->cluster_sectors
* BDRV_SECTOR_SIZE
;
2010 static void iscsi_invalidate_cache(BlockDriverState
*bs
,
2013 IscsiLun
*iscsilun
= bs
->opaque
;
2014 iscsi_allocmap_invalidate(iscsilun
);
2017 static QemuOptsList iscsi_create_opts
= {
2018 .name
= "iscsi-create-opts",
2019 .head
= QTAILQ_HEAD_INITIALIZER(iscsi_create_opts
.head
),
2022 .name
= BLOCK_OPT_SIZE
,
2023 .type
= QEMU_OPT_SIZE
,
2024 .help
= "Virtual disk size"
2026 { /* end of list */ }
2030 static BlockDriver bdrv_iscsi
= {
2031 .format_name
= "iscsi",
2032 .protocol_name
= "iscsi",
2034 .instance_size
= sizeof(IscsiLun
),
2035 .bdrv_needs_filename
= true,
2036 .bdrv_file_open
= iscsi_open
,
2037 .bdrv_close
= iscsi_close
,
2038 .bdrv_create
= iscsi_create
,
2039 .create_opts
= &iscsi_create_opts
,
2040 .bdrv_reopen_prepare
= iscsi_reopen_prepare
,
2041 .bdrv_reopen_commit
= iscsi_reopen_commit
,
2042 .bdrv_invalidate_cache
= iscsi_invalidate_cache
,
2044 .bdrv_getlength
= iscsi_getlength
,
2045 .bdrv_get_info
= iscsi_get_info
,
2046 .bdrv_truncate
= iscsi_truncate
,
2047 .bdrv_refresh_limits
= iscsi_refresh_limits
,
2049 .bdrv_co_get_block_status
= iscsi_co_get_block_status
,
2050 .bdrv_co_pdiscard
= iscsi_co_pdiscard
,
2051 .bdrv_co_pwrite_zeroes
= iscsi_co_pwrite_zeroes
,
2052 .bdrv_co_readv
= iscsi_co_readv
,
2053 .bdrv_co_writev_flags
= iscsi_co_writev_flags
,
2054 .bdrv_co_flush_to_disk
= iscsi_co_flush
,
2057 .bdrv_aio_ioctl
= iscsi_aio_ioctl
,
2060 .bdrv_detach_aio_context
= iscsi_detach_aio_context
,
2061 .bdrv_attach_aio_context
= iscsi_attach_aio_context
,
2064 #if LIBISCSI_API_VERSION >= (20160603)
2065 static BlockDriver bdrv_iser
= {
2066 .format_name
= "iser",
2067 .protocol_name
= "iser",
2069 .instance_size
= sizeof(IscsiLun
),
2070 .bdrv_needs_filename
= true,
2071 .bdrv_file_open
= iscsi_open
,
2072 .bdrv_close
= iscsi_close
,
2073 .bdrv_create
= iscsi_create
,
2074 .create_opts
= &iscsi_create_opts
,
2075 .bdrv_reopen_prepare
= iscsi_reopen_prepare
,
2076 .bdrv_reopen_commit
= iscsi_reopen_commit
,
2077 .bdrv_invalidate_cache
= iscsi_invalidate_cache
,
2079 .bdrv_getlength
= iscsi_getlength
,
2080 .bdrv_get_info
= iscsi_get_info
,
2081 .bdrv_truncate
= iscsi_truncate
,
2082 .bdrv_refresh_limits
= iscsi_refresh_limits
,
2084 .bdrv_co_get_block_status
= iscsi_co_get_block_status
,
2085 .bdrv_co_pdiscard
= iscsi_co_pdiscard
,
2086 .bdrv_co_pwrite_zeroes
= iscsi_co_pwrite_zeroes
,
2087 .bdrv_co_readv
= iscsi_co_readv
,
2088 .bdrv_co_writev_flags
= iscsi_co_writev_flags
,
2089 .bdrv_co_flush_to_disk
= iscsi_co_flush
,
2092 .bdrv_aio_ioctl
= iscsi_aio_ioctl
,
2095 .bdrv_detach_aio_context
= iscsi_detach_aio_context
,
2096 .bdrv_attach_aio_context
= iscsi_attach_aio_context
,
2100 static void iscsi_block_init(void)
2102 bdrv_register(&bdrv_iscsi
);
2103 #if LIBISCSI_API_VERSION >= (20160603)
2104 bdrv_register(&bdrv_iser
);
2108 block_init(iscsi_block_init
);