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 aio_co_wake(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 aio_context_acquire(iscsilun
->aio_context
);
398 iscsi_service(iscsi
, POLLIN
);
399 iscsi_set_events(iscsilun
);
400 aio_context_release(iscsilun
->aio_context
);
404 iscsi_process_write(void *arg
)
406 IscsiLun
*iscsilun
= arg
;
407 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
409 aio_context_acquire(iscsilun
->aio_context
);
410 iscsi_service(iscsi
, POLLOUT
);
411 iscsi_set_events(iscsilun
);
412 aio_context_release(iscsilun
->aio_context
);
415 static int64_t sector_lun2qemu(int64_t sector
, IscsiLun
*iscsilun
)
417 return sector
* iscsilun
->block_size
/ BDRV_SECTOR_SIZE
;
420 static int64_t sector_qemu2lun(int64_t sector
, IscsiLun
*iscsilun
)
422 return sector
* BDRV_SECTOR_SIZE
/ iscsilun
->block_size
;
425 static bool is_byte_request_lun_aligned(int64_t offset
, int count
,
428 if (offset
% iscsilun
->block_size
|| count
% iscsilun
->block_size
) {
429 error_report("iSCSI misaligned request: "
430 "iscsilun->block_size %u, offset %" PRIi64
432 iscsilun
->block_size
, offset
, count
);
438 static bool is_sector_request_lun_aligned(int64_t sector_num
, int nb_sectors
,
441 assert(nb_sectors
<= BDRV_REQUEST_MAX_SECTORS
);
442 return is_byte_request_lun_aligned(sector_num
<< BDRV_SECTOR_BITS
,
443 nb_sectors
<< BDRV_SECTOR_BITS
,
447 static void iscsi_allocmap_free(IscsiLun
*iscsilun
)
449 g_free(iscsilun
->allocmap
);
450 g_free(iscsilun
->allocmap_valid
);
451 iscsilun
->allocmap
= NULL
;
452 iscsilun
->allocmap_valid
= NULL
;
456 static int iscsi_allocmap_init(IscsiLun
*iscsilun
, int open_flags
)
458 iscsi_allocmap_free(iscsilun
);
460 iscsilun
->allocmap_size
=
461 DIV_ROUND_UP(sector_lun2qemu(iscsilun
->num_blocks
, iscsilun
),
462 iscsilun
->cluster_sectors
);
464 iscsilun
->allocmap
= bitmap_try_new(iscsilun
->allocmap_size
);
465 if (!iscsilun
->allocmap
) {
469 if (open_flags
& BDRV_O_NOCACHE
) {
470 /* in case that cache.direct = on all allocmap entries are
471 * treated as invalid to force a relookup of the block
472 * status on every read request */
476 iscsilun
->allocmap_valid
= bitmap_try_new(iscsilun
->allocmap_size
);
477 if (!iscsilun
->allocmap_valid
) {
478 /* if we are under memory pressure free the allocmap as well */
479 iscsi_allocmap_free(iscsilun
);
487 iscsi_allocmap_update(IscsiLun
*iscsilun
, int64_t sector_num
,
488 int nb_sectors
, bool allocated
, bool valid
)
490 int64_t cl_num_expanded
, nb_cls_expanded
, cl_num_shrunk
, nb_cls_shrunk
;
492 if (iscsilun
->allocmap
== NULL
) {
495 /* expand to entirely contain all affected clusters */
496 cl_num_expanded
= sector_num
/ iscsilun
->cluster_sectors
;
497 nb_cls_expanded
= DIV_ROUND_UP(sector_num
+ nb_sectors
,
498 iscsilun
->cluster_sectors
) - cl_num_expanded
;
499 /* shrink to touch only completely contained clusters */
500 cl_num_shrunk
= DIV_ROUND_UP(sector_num
, iscsilun
->cluster_sectors
);
501 nb_cls_shrunk
= (sector_num
+ nb_sectors
) / iscsilun
->cluster_sectors
504 bitmap_set(iscsilun
->allocmap
, cl_num_expanded
, nb_cls_expanded
);
506 if (nb_cls_shrunk
> 0) {
507 bitmap_clear(iscsilun
->allocmap
, cl_num_shrunk
, nb_cls_shrunk
);
511 if (iscsilun
->allocmap_valid
== NULL
) {
515 if (nb_cls_shrunk
> 0) {
516 bitmap_set(iscsilun
->allocmap_valid
, cl_num_shrunk
, nb_cls_shrunk
);
519 bitmap_clear(iscsilun
->allocmap_valid
, cl_num_expanded
,
525 iscsi_allocmap_set_allocated(IscsiLun
*iscsilun
, int64_t sector_num
,
528 iscsi_allocmap_update(iscsilun
, sector_num
, nb_sectors
, true, true);
532 iscsi_allocmap_set_unallocated(IscsiLun
*iscsilun
, int64_t sector_num
,
535 /* Note: if cache.direct=on the fifth argument to iscsi_allocmap_update
536 * is ignored, so this will in effect be an iscsi_allocmap_set_invalid.
538 iscsi_allocmap_update(iscsilun
, sector_num
, nb_sectors
, false, true);
541 static void iscsi_allocmap_set_invalid(IscsiLun
*iscsilun
, int64_t sector_num
,
544 iscsi_allocmap_update(iscsilun
, sector_num
, nb_sectors
, false, false);
547 static void iscsi_allocmap_invalidate(IscsiLun
*iscsilun
)
549 if (iscsilun
->allocmap
) {
550 bitmap_zero(iscsilun
->allocmap
, iscsilun
->allocmap_size
);
552 if (iscsilun
->allocmap_valid
) {
553 bitmap_zero(iscsilun
->allocmap_valid
, iscsilun
->allocmap_size
);
558 iscsi_allocmap_is_allocated(IscsiLun
*iscsilun
, int64_t sector_num
,
562 if (iscsilun
->allocmap
== NULL
) {
565 size
= DIV_ROUND_UP(sector_num
+ nb_sectors
, iscsilun
->cluster_sectors
);
566 return !(find_next_bit(iscsilun
->allocmap
, size
,
567 sector_num
/ iscsilun
->cluster_sectors
) == size
);
570 static inline bool iscsi_allocmap_is_valid(IscsiLun
*iscsilun
,
571 int64_t sector_num
, int nb_sectors
)
574 if (iscsilun
->allocmap_valid
== NULL
) {
577 size
= DIV_ROUND_UP(sector_num
+ nb_sectors
, iscsilun
->cluster_sectors
);
578 return (find_next_zero_bit(iscsilun
->allocmap_valid
, size
,
579 sector_num
/ iscsilun
->cluster_sectors
) == size
);
582 static int coroutine_fn
583 iscsi_co_writev_flags(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
,
584 QEMUIOVector
*iov
, int flags
)
586 IscsiLun
*iscsilun
= bs
->opaque
;
587 struct IscsiTask iTask
;
589 uint32_t num_sectors
;
590 bool fua
= flags
& BDRV_REQ_FUA
;
593 assert(iscsilun
->dpofua
);
595 if (!is_sector_request_lun_aligned(sector_num
, nb_sectors
, iscsilun
)) {
599 if (bs
->bl
.max_transfer
) {
600 assert(nb_sectors
<< BDRV_SECTOR_BITS
<= bs
->bl
.max_transfer
);
603 lba
= sector_qemu2lun(sector_num
, iscsilun
);
604 num_sectors
= sector_qemu2lun(nb_sectors
, iscsilun
);
605 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
607 if (iscsilun
->use_16_for_rw
) {
608 #if LIBISCSI_API_VERSION >= (20160603)
609 iTask
.task
= iscsi_write16_iov_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
610 NULL
, num_sectors
* iscsilun
->block_size
,
611 iscsilun
->block_size
, 0, 0, fua
, 0, 0,
612 iscsi_co_generic_cb
, &iTask
,
613 (struct scsi_iovec
*)iov
->iov
, iov
->niov
);
615 iTask
.task
= iscsi_write10_iov_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
616 NULL
, num_sectors
* iscsilun
->block_size
,
617 iscsilun
->block_size
, 0, 0, fua
, 0, 0,
618 iscsi_co_generic_cb
, &iTask
,
619 (struct scsi_iovec
*)iov
->iov
, iov
->niov
);
622 iTask
.task
= iscsi_write16_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
623 NULL
, num_sectors
* iscsilun
->block_size
,
624 iscsilun
->block_size
, 0, 0, fua
, 0, 0,
625 iscsi_co_generic_cb
, &iTask
);
627 iTask
.task
= iscsi_write10_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
628 NULL
, num_sectors
* iscsilun
->block_size
,
629 iscsilun
->block_size
, 0, 0, fua
, 0, 0,
630 iscsi_co_generic_cb
, &iTask
);
633 if (iTask
.task
== NULL
) {
636 #if LIBISCSI_API_VERSION < (20160603)
637 scsi_task_set_iov_out(iTask
.task
, (struct scsi_iovec
*) iov
->iov
,
640 while (!iTask
.complete
) {
641 iscsi_set_events(iscsilun
);
642 qemu_coroutine_yield();
645 if (iTask
.task
!= NULL
) {
646 scsi_free_scsi_task(iTask
.task
);
650 if (iTask
.do_retry
) {
655 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
656 iscsi_allocmap_set_invalid(iscsilun
, sector_num
, nb_sectors
);
657 return iTask
.err_code
;
660 iscsi_allocmap_set_allocated(iscsilun
, sector_num
, nb_sectors
);
667 static int64_t coroutine_fn
iscsi_co_get_block_status(BlockDriverState
*bs
,
669 int nb_sectors
, int *pnum
,
670 BlockDriverState
**file
)
672 IscsiLun
*iscsilun
= bs
->opaque
;
673 struct scsi_get_lba_status
*lbas
= NULL
;
674 struct scsi_lba_status_descriptor
*lbasd
= NULL
;
675 struct IscsiTask iTask
;
678 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
680 if (!is_sector_request_lun_aligned(sector_num
, nb_sectors
, iscsilun
)) {
685 /* default to all sectors allocated */
686 ret
= BDRV_BLOCK_DATA
;
687 ret
|= (sector_num
<< BDRV_SECTOR_BITS
) | BDRV_BLOCK_OFFSET_VALID
;
690 /* LUN does not support logical block provisioning */
691 if (!iscsilun
->lbpme
) {
696 if (iscsi_get_lba_status_task(iscsilun
->iscsi
, iscsilun
->lun
,
697 sector_qemu2lun(sector_num
, iscsilun
),
698 8 + 16, iscsi_co_generic_cb
,
704 while (!iTask
.complete
) {
705 iscsi_set_events(iscsilun
);
706 qemu_coroutine_yield();
709 if (iTask
.do_retry
) {
710 if (iTask
.task
!= NULL
) {
711 scsi_free_scsi_task(iTask
.task
);
718 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
719 /* in case the get_lba_status_callout fails (i.e.
720 * because the device is busy or the cmd is not
721 * supported) we pretend all blocks are allocated
722 * for backwards compatibility */
726 lbas
= scsi_datain_unmarshall(iTask
.task
);
732 lbasd
= &lbas
->descriptors
[0];
734 if (sector_qemu2lun(sector_num
, iscsilun
) != lbasd
->lba
) {
739 *pnum
= sector_lun2qemu(lbasd
->num_blocks
, iscsilun
);
741 if (lbasd
->provisioning
== SCSI_PROVISIONING_TYPE_DEALLOCATED
||
742 lbasd
->provisioning
== SCSI_PROVISIONING_TYPE_ANCHORED
) {
743 ret
&= ~BDRV_BLOCK_DATA
;
744 if (iscsilun
->lbprz
) {
745 ret
|= BDRV_BLOCK_ZERO
;
749 if (ret
& BDRV_BLOCK_ZERO
) {
750 iscsi_allocmap_set_unallocated(iscsilun
, sector_num
, *pnum
);
752 iscsi_allocmap_set_allocated(iscsilun
, sector_num
, *pnum
);
755 if (*pnum
> nb_sectors
) {
759 if (iTask
.task
!= NULL
) {
760 scsi_free_scsi_task(iTask
.task
);
762 if (ret
> 0 && ret
& BDRV_BLOCK_OFFSET_VALID
) {
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
;
777 if (!is_sector_request_lun_aligned(sector_num
, nb_sectors
, iscsilun
)) {
781 if (bs
->bl
.max_transfer
) {
782 assert(nb_sectors
<< BDRV_SECTOR_BITS
<= bs
->bl
.max_transfer
);
785 /* if cache.direct is off and we have a valid entry in our allocation map
786 * we can skip checking the block status and directly return zeroes if
787 * the request falls within an unallocated area */
788 if (iscsi_allocmap_is_valid(iscsilun
, sector_num
, nb_sectors
) &&
789 !iscsi_allocmap_is_allocated(iscsilun
, sector_num
, nb_sectors
)) {
790 qemu_iovec_memset(iov
, 0, 0x00, iov
->size
);
794 if (nb_sectors
>= ISCSI_CHECKALLOC_THRES
&&
795 !iscsi_allocmap_is_valid(iscsilun
, sector_num
, nb_sectors
) &&
796 !iscsi_allocmap_is_allocated(iscsilun
, sector_num
, nb_sectors
)) {
798 BlockDriverState
*file
;
799 /* check the block status from the beginning of the cluster
800 * containing the start sector */
801 int64_t ret
= iscsi_co_get_block_status(bs
,
802 sector_num
- sector_num
% iscsilun
->cluster_sectors
,
803 BDRV_REQUEST_MAX_SECTORS
, &pnum
, &file
);
807 /* if the whole request falls into an unallocated area we can avoid
808 * to read and directly return zeroes instead */
809 if (ret
& BDRV_BLOCK_ZERO
&&
810 pnum
>= nb_sectors
+ sector_num
% iscsilun
->cluster_sectors
) {
811 qemu_iovec_memset(iov
, 0, 0x00, iov
->size
);
816 lba
= sector_qemu2lun(sector_num
, iscsilun
);
817 num_sectors
= sector_qemu2lun(nb_sectors
, iscsilun
);
819 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
821 if (iscsilun
->use_16_for_rw
) {
822 #if LIBISCSI_API_VERSION >= (20160603)
823 iTask
.task
= iscsi_read16_iov_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
824 num_sectors
* iscsilun
->block_size
,
825 iscsilun
->block_size
, 0, 0, 0, 0, 0,
826 iscsi_co_generic_cb
, &iTask
,
827 (struct scsi_iovec
*)iov
->iov
, iov
->niov
);
829 iTask
.task
= iscsi_read10_iov_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
830 num_sectors
* iscsilun
->block_size
,
831 iscsilun
->block_size
,
833 iscsi_co_generic_cb
, &iTask
,
834 (struct scsi_iovec
*)iov
->iov
, iov
->niov
);
837 iTask
.task
= iscsi_read16_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
838 num_sectors
* iscsilun
->block_size
,
839 iscsilun
->block_size
, 0, 0, 0, 0, 0,
840 iscsi_co_generic_cb
, &iTask
);
842 iTask
.task
= iscsi_read10_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
843 num_sectors
* iscsilun
->block_size
,
844 iscsilun
->block_size
,
846 iscsi_co_generic_cb
, &iTask
);
849 if (iTask
.task
== NULL
) {
852 #if LIBISCSI_API_VERSION < (20160603)
853 scsi_task_set_iov_in(iTask
.task
, (struct scsi_iovec
*) iov
->iov
, iov
->niov
);
855 while (!iTask
.complete
) {
856 iscsi_set_events(iscsilun
);
857 qemu_coroutine_yield();
860 if (iTask
.task
!= NULL
) {
861 scsi_free_scsi_task(iTask
.task
);
865 if (iTask
.do_retry
) {
870 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
871 return iTask
.err_code
;
877 static int coroutine_fn
iscsi_co_flush(BlockDriverState
*bs
)
879 IscsiLun
*iscsilun
= bs
->opaque
;
880 struct IscsiTask iTask
;
882 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
884 if (iscsi_synchronizecache10_task(iscsilun
->iscsi
, iscsilun
->lun
, 0, 0, 0,
885 0, iscsi_co_generic_cb
, &iTask
) == NULL
) {
889 while (!iTask
.complete
) {
890 iscsi_set_events(iscsilun
);
891 qemu_coroutine_yield();
894 if (iTask
.task
!= NULL
) {
895 scsi_free_scsi_task(iTask
.task
);
899 if (iTask
.do_retry
) {
904 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
905 return iTask
.err_code
;
913 iscsi_aio_ioctl_cb(struct iscsi_context
*iscsi
, int status
,
914 void *command_data
, void *opaque
)
916 IscsiAIOCB
*acb
= opaque
;
923 error_report("Failed to ioctl(SG_IO) to iSCSI lun. %s",
924 iscsi_get_error(iscsi
));
925 acb
->status
= iscsi_translate_sense(&acb
->task
->sense
);
928 acb
->ioh
->driver_status
= 0;
929 acb
->ioh
->host_status
= 0;
931 acb
->ioh
->status
= status
;
933 #define SG_ERR_DRIVER_SENSE 0x08
935 if (status
== SCSI_STATUS_CHECK_CONDITION
&& acb
->task
->datain
.size
>= 2) {
938 acb
->ioh
->driver_status
|= SG_ERR_DRIVER_SENSE
;
940 acb
->ioh
->sb_len_wr
= acb
->task
->datain
.size
- 2;
941 ss
= (acb
->ioh
->mx_sb_len
>= acb
->ioh
->sb_len_wr
) ?
942 acb
->ioh
->mx_sb_len
: acb
->ioh
->sb_len_wr
;
943 memcpy(acb
->ioh
->sbp
, &acb
->task
->datain
.data
[2], ss
);
946 iscsi_schedule_bh(acb
);
949 static void iscsi_ioctl_bh_completion(void *opaque
)
951 IscsiAIOCB
*acb
= opaque
;
953 qemu_bh_delete(acb
->bh
);
954 acb
->common
.cb(acb
->common
.opaque
, acb
->ret
);
958 static void iscsi_ioctl_handle_emulated(IscsiAIOCB
*acb
, int req
, void *buf
)
960 BlockDriverState
*bs
= acb
->common
.bs
;
961 IscsiLun
*iscsilun
= bs
->opaque
;
965 case SG_GET_VERSION_NUM
:
969 ((struct sg_scsi_id
*)buf
)->scsi_type
= iscsilun
->type
;
975 acb
->bh
= aio_bh_new(bdrv_get_aio_context(bs
),
976 iscsi_ioctl_bh_completion
, acb
);
978 qemu_bh_schedule(acb
->bh
);
981 static BlockAIOCB
*iscsi_aio_ioctl(BlockDriverState
*bs
,
982 unsigned long int req
, void *buf
,
983 BlockCompletionFunc
*cb
, void *opaque
)
985 IscsiLun
*iscsilun
= bs
->opaque
;
986 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
987 struct iscsi_data data
;
990 acb
= qemu_aio_get(&iscsi_aiocb_info
, bs
, cb
, opaque
);
992 acb
->iscsilun
= iscsilun
;
994 acb
->status
= -EINPROGRESS
;
999 iscsi_ioctl_handle_emulated(acb
, req
, buf
);
1000 return &acb
->common
;
1003 if (acb
->ioh
->cmd_len
> SCSI_CDB_MAX_SIZE
) {
1004 error_report("iSCSI: ioctl error CDB exceeds max size (%d > %d)",
1005 acb
->ioh
->cmd_len
, SCSI_CDB_MAX_SIZE
);
1006 qemu_aio_unref(acb
);
1010 acb
->task
= malloc(sizeof(struct scsi_task
));
1011 if (acb
->task
== NULL
) {
1012 error_report("iSCSI: Failed to allocate task for scsi command. %s",
1013 iscsi_get_error(iscsi
));
1014 qemu_aio_unref(acb
);
1017 memset(acb
->task
, 0, sizeof(struct scsi_task
));
1019 switch (acb
->ioh
->dxfer_direction
) {
1020 case SG_DXFER_TO_DEV
:
1021 acb
->task
->xfer_dir
= SCSI_XFER_WRITE
;
1023 case SG_DXFER_FROM_DEV
:
1024 acb
->task
->xfer_dir
= SCSI_XFER_READ
;
1027 acb
->task
->xfer_dir
= SCSI_XFER_NONE
;
1031 acb
->task
->cdb_size
= acb
->ioh
->cmd_len
;
1032 memcpy(&acb
->task
->cdb
[0], acb
->ioh
->cmdp
, acb
->ioh
->cmd_len
);
1033 acb
->task
->expxferlen
= acb
->ioh
->dxfer_len
;
1036 if (acb
->task
->xfer_dir
== SCSI_XFER_WRITE
) {
1037 if (acb
->ioh
->iovec_count
== 0) {
1038 data
.data
= acb
->ioh
->dxferp
;
1039 data
.size
= acb
->ioh
->dxfer_len
;
1041 scsi_task_set_iov_out(acb
->task
,
1042 (struct scsi_iovec
*) acb
->ioh
->dxferp
,
1043 acb
->ioh
->iovec_count
);
1047 if (iscsi_scsi_command_async(iscsi
, iscsilun
->lun
, acb
->task
,
1049 (data
.size
> 0) ? &data
: NULL
,
1051 scsi_free_scsi_task(acb
->task
);
1052 qemu_aio_unref(acb
);
1056 /* tell libiscsi to read straight into the buffer we got from ioctl */
1057 if (acb
->task
->xfer_dir
== SCSI_XFER_READ
) {
1058 if (acb
->ioh
->iovec_count
== 0) {
1059 scsi_task_add_data_in_buffer(acb
->task
,
1060 acb
->ioh
->dxfer_len
,
1063 scsi_task_set_iov_in(acb
->task
,
1064 (struct scsi_iovec
*) acb
->ioh
->dxferp
,
1065 acb
->ioh
->iovec_count
);
1069 iscsi_set_events(iscsilun
);
1071 return &acb
->common
;
1077 iscsi_getlength(BlockDriverState
*bs
)
1079 IscsiLun
*iscsilun
= bs
->opaque
;
1082 len
= iscsilun
->num_blocks
;
1083 len
*= iscsilun
->block_size
;
1089 coroutine_fn
iscsi_co_pdiscard(BlockDriverState
*bs
, int64_t offset
, int count
)
1091 IscsiLun
*iscsilun
= bs
->opaque
;
1092 struct IscsiTask iTask
;
1093 struct unmap_list list
;
1095 if (!is_byte_request_lun_aligned(offset
, count
, iscsilun
)) {
1099 if (!iscsilun
->lbp
.lbpu
) {
1100 /* UNMAP is not supported by the target */
1104 list
.lba
= offset
/ iscsilun
->block_size
;
1105 list
.num
= count
/ iscsilun
->block_size
;
1107 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
1109 if (iscsi_unmap_task(iscsilun
->iscsi
, iscsilun
->lun
, 0, 0, &list
, 1,
1110 iscsi_co_generic_cb
, &iTask
) == NULL
) {
1114 while (!iTask
.complete
) {
1115 iscsi_set_events(iscsilun
);
1116 qemu_coroutine_yield();
1119 if (iTask
.task
!= NULL
) {
1120 scsi_free_scsi_task(iTask
.task
);
1124 if (iTask
.do_retry
) {
1129 if (iTask
.status
== SCSI_STATUS_CHECK_CONDITION
) {
1130 /* the target might fail with a check condition if it
1131 is not happy with the alignment of the UNMAP request
1132 we silently fail in this case */
1136 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
1137 return iTask
.err_code
;
1140 iscsi_allocmap_set_invalid(iscsilun
, offset
>> BDRV_SECTOR_BITS
,
1141 count
>> BDRV_SECTOR_BITS
);
1147 coroutine_fn
iscsi_co_pwrite_zeroes(BlockDriverState
*bs
, int64_t offset
,
1148 int count
, BdrvRequestFlags flags
)
1150 IscsiLun
*iscsilun
= bs
->opaque
;
1151 struct IscsiTask iTask
;
1154 bool use_16_for_ws
= iscsilun
->use_16_for_rw
;
1156 if (!is_byte_request_lun_aligned(offset
, count
, iscsilun
)) {
1160 if (flags
& BDRV_REQ_MAY_UNMAP
) {
1161 if (!use_16_for_ws
&& !iscsilun
->lbp
.lbpws10
) {
1162 /* WRITESAME10 with UNMAP is unsupported try WRITESAME16 */
1163 use_16_for_ws
= true;
1165 if (use_16_for_ws
&& !iscsilun
->lbp
.lbpws
) {
1166 /* WRITESAME16 with UNMAP is not supported by the target,
1167 * fall back and try WRITESAME10/16 without UNMAP */
1168 flags
&= ~BDRV_REQ_MAY_UNMAP
;
1169 use_16_for_ws
= iscsilun
->use_16_for_rw
;
1173 if (!(flags
& BDRV_REQ_MAY_UNMAP
) && !iscsilun
->has_write_same
) {
1174 /* WRITESAME without UNMAP is not supported by the target */
1178 lba
= offset
/ iscsilun
->block_size
;
1179 nb_blocks
= count
/ iscsilun
->block_size
;
1181 if (iscsilun
->zeroblock
== NULL
) {
1182 iscsilun
->zeroblock
= g_try_malloc0(iscsilun
->block_size
);
1183 if (iscsilun
->zeroblock
== NULL
) {
1188 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
1190 if (use_16_for_ws
) {
1191 iTask
.task
= iscsi_writesame16_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
1192 iscsilun
->zeroblock
, iscsilun
->block_size
,
1193 nb_blocks
, 0, !!(flags
& BDRV_REQ_MAY_UNMAP
),
1194 0, 0, iscsi_co_generic_cb
, &iTask
);
1196 iTask
.task
= iscsi_writesame10_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
1197 iscsilun
->zeroblock
, iscsilun
->block_size
,
1198 nb_blocks
, 0, !!(flags
& BDRV_REQ_MAY_UNMAP
),
1199 0, 0, iscsi_co_generic_cb
, &iTask
);
1201 if (iTask
.task
== NULL
) {
1205 while (!iTask
.complete
) {
1206 iscsi_set_events(iscsilun
);
1207 qemu_coroutine_yield();
1210 if (iTask
.status
== SCSI_STATUS_CHECK_CONDITION
&&
1211 iTask
.task
->sense
.key
== SCSI_SENSE_ILLEGAL_REQUEST
&&
1212 (iTask
.task
->sense
.ascq
== SCSI_SENSE_ASCQ_INVALID_OPERATION_CODE
||
1213 iTask
.task
->sense
.ascq
== SCSI_SENSE_ASCQ_INVALID_FIELD_IN_CDB
)) {
1214 /* WRITE SAME is not supported by the target */
1215 iscsilun
->has_write_same
= false;
1216 scsi_free_scsi_task(iTask
.task
);
1220 if (iTask
.task
!= NULL
) {
1221 scsi_free_scsi_task(iTask
.task
);
1225 if (iTask
.do_retry
) {
1230 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
1231 iscsi_allocmap_set_invalid(iscsilun
, offset
>> BDRV_SECTOR_BITS
,
1232 count
>> BDRV_SECTOR_BITS
);
1233 return iTask
.err_code
;
1236 if (flags
& BDRV_REQ_MAY_UNMAP
) {
1237 iscsi_allocmap_set_invalid(iscsilun
, offset
>> BDRV_SECTOR_BITS
,
1238 count
>> BDRV_SECTOR_BITS
);
1240 iscsi_allocmap_set_allocated(iscsilun
, offset
>> BDRV_SECTOR_BITS
,
1241 count
>> BDRV_SECTOR_BITS
);
1247 static void parse_chap(struct iscsi_context
*iscsi
, const char *target
,
1252 const char *user
= NULL
;
1253 const char *password
= NULL
;
1254 const char *secretid
;
1255 char *secret
= NULL
;
1257 list
= qemu_find_opts("iscsi");
1262 opts
= qemu_opts_find(list
, target
);
1264 opts
= QTAILQ_FIRST(&list
->head
);
1270 user
= qemu_opt_get(opts
, "user");
1275 secretid
= qemu_opt_get(opts
, "password-secret");
1276 password
= qemu_opt_get(opts
, "password");
1277 if (secretid
&& password
) {
1278 error_setg(errp
, "'password' and 'password-secret' properties are "
1279 "mutually exclusive");
1283 secret
= qcrypto_secret_lookup_as_utf8(secretid
, errp
);
1288 } else if (!password
) {
1289 error_setg(errp
, "CHAP username specified but no password was given");
1293 if (iscsi_set_initiator_username_pwd(iscsi
, user
, password
)) {
1294 error_setg(errp
, "Failed to set initiator username and password");
1300 static void parse_header_digest(struct iscsi_context
*iscsi
, const char *target
,
1305 const char *digest
= NULL
;
1307 list
= qemu_find_opts("iscsi");
1312 opts
= qemu_opts_find(list
, target
);
1314 opts
= QTAILQ_FIRST(&list
->head
);
1320 digest
= qemu_opt_get(opts
, "header-digest");
1325 if (!strcmp(digest
, "CRC32C")) {
1326 iscsi_set_header_digest(iscsi
, ISCSI_HEADER_DIGEST_CRC32C
);
1327 } else if (!strcmp(digest
, "NONE")) {
1328 iscsi_set_header_digest(iscsi
, ISCSI_HEADER_DIGEST_NONE
);
1329 } else if (!strcmp(digest
, "CRC32C-NONE")) {
1330 iscsi_set_header_digest(iscsi
, ISCSI_HEADER_DIGEST_CRC32C_NONE
);
1331 } else if (!strcmp(digest
, "NONE-CRC32C")) {
1332 iscsi_set_header_digest(iscsi
, ISCSI_HEADER_DIGEST_NONE_CRC32C
);
1334 error_setg(errp
, "Invalid header-digest setting : %s", digest
);
1338 static char *parse_initiator_name(const char *target
)
1344 UuidInfo
*uuid_info
;
1346 list
= qemu_find_opts("iscsi");
1348 opts
= qemu_opts_find(list
, target
);
1350 opts
= QTAILQ_FIRST(&list
->head
);
1353 name
= qemu_opt_get(opts
, "initiator-name");
1355 return g_strdup(name
);
1360 uuid_info
= qmp_query_uuid(NULL
);
1361 if (strcmp(uuid_info
->UUID
, UUID_NONE
) == 0) {
1362 name
= qemu_get_vm_name();
1364 name
= uuid_info
->UUID
;
1366 iscsi_name
= g_strdup_printf("iqn.2008-11.org.linux-kvm%s%s",
1367 name
? ":" : "", name
? name
: "");
1368 qapi_free_UuidInfo(uuid_info
);
1372 static int parse_timeout(const char *target
)
1376 const char *timeout
;
1378 list
= qemu_find_opts("iscsi");
1380 opts
= qemu_opts_find(list
, target
);
1382 opts
= QTAILQ_FIRST(&list
->head
);
1385 timeout
= qemu_opt_get(opts
, "timeout");
1387 return atoi(timeout
);
1395 static void iscsi_nop_timed_event(void *opaque
)
1397 IscsiLun
*iscsilun
= opaque
;
1399 aio_context_acquire(iscsilun
->aio_context
);
1400 if (iscsi_get_nops_in_flight(iscsilun
->iscsi
) >= MAX_NOP_FAILURES
) {
1401 error_report("iSCSI: NOP timeout. Reconnecting...");
1402 iscsilun
->request_timed_out
= true;
1403 } else if (iscsi_nop_out_async(iscsilun
->iscsi
, NULL
, NULL
, 0, NULL
) != 0) {
1404 error_report("iSCSI: failed to sent NOP-Out. Disabling NOP messages.");
1408 timer_mod(iscsilun
->nop_timer
, qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) + NOP_INTERVAL
);
1409 iscsi_set_events(iscsilun
);
1412 aio_context_release(iscsilun
->aio_context
);
1415 static void iscsi_readcapacity_sync(IscsiLun
*iscsilun
, Error
**errp
)
1417 struct scsi_task
*task
= NULL
;
1418 struct scsi_readcapacity10
*rc10
= NULL
;
1419 struct scsi_readcapacity16
*rc16
= NULL
;
1420 int retries
= ISCSI_CMD_RETRIES
;
1424 scsi_free_scsi_task(task
);
1428 switch (iscsilun
->type
) {
1430 task
= iscsi_readcapacity16_sync(iscsilun
->iscsi
, iscsilun
->lun
);
1431 if (task
!= NULL
&& task
->status
== SCSI_STATUS_GOOD
) {
1432 rc16
= scsi_datain_unmarshall(task
);
1434 error_setg(errp
, "iSCSI: Failed to unmarshall readcapacity16 data.");
1436 iscsilun
->block_size
= rc16
->block_length
;
1437 iscsilun
->num_blocks
= rc16
->returned_lba
+ 1;
1438 iscsilun
->lbpme
= !!rc16
->lbpme
;
1439 iscsilun
->lbprz
= !!rc16
->lbprz
;
1440 iscsilun
->use_16_for_rw
= (rc16
->returned_lba
> 0xffffffff);
1444 if (task
!= NULL
&& task
->status
== SCSI_STATUS_CHECK_CONDITION
1445 && task
->sense
.key
== SCSI_SENSE_UNIT_ATTENTION
) {
1448 /* Fall through and try READ CAPACITY(10) instead. */
1450 task
= iscsi_readcapacity10_sync(iscsilun
->iscsi
, iscsilun
->lun
, 0, 0);
1451 if (task
!= NULL
&& task
->status
== SCSI_STATUS_GOOD
) {
1452 rc10
= scsi_datain_unmarshall(task
);
1454 error_setg(errp
, "iSCSI: Failed to unmarshall readcapacity10 data.");
1456 iscsilun
->block_size
= rc10
->block_size
;
1457 if (rc10
->lba
== 0) {
1458 /* blank disk loaded */
1459 iscsilun
->num_blocks
= 0;
1461 iscsilun
->num_blocks
= rc10
->lba
+ 1;
1469 } while (task
!= NULL
&& task
->status
== SCSI_STATUS_CHECK_CONDITION
1470 && task
->sense
.key
== SCSI_SENSE_UNIT_ATTENTION
1473 if (task
== NULL
|| task
->status
!= SCSI_STATUS_GOOD
) {
1474 error_setg(errp
, "iSCSI: failed to send readcapacity10/16 command");
1475 } else if (!iscsilun
->block_size
||
1476 iscsilun
->block_size
% BDRV_SECTOR_SIZE
) {
1477 error_setg(errp
, "iSCSI: the target returned an invalid "
1478 "block size of %d.", iscsilun
->block_size
);
1481 scsi_free_scsi_task(task
);
1485 /* TODO Convert to fine grained options */
1486 static QemuOptsList runtime_opts
= {
1488 .head
= QTAILQ_HEAD_INITIALIZER(runtime_opts
.head
),
1492 .type
= QEMU_OPT_STRING
,
1493 .help
= "URL to the iscsi image",
1495 { /* end of list */ }
1499 static struct scsi_task
*iscsi_do_inquiry(struct iscsi_context
*iscsi
, int lun
,
1500 int evpd
, int pc
, void **inq
, Error
**errp
)
1503 struct scsi_task
*task
= NULL
;
1504 task
= iscsi_inquiry_sync(iscsi
, lun
, evpd
, pc
, 64);
1505 if (task
== NULL
|| task
->status
!= SCSI_STATUS_GOOD
) {
1508 full_size
= scsi_datain_getfullsize(task
);
1509 if (full_size
> task
->datain
.size
) {
1510 scsi_free_scsi_task(task
);
1512 /* we need more data for the full list */
1513 task
= iscsi_inquiry_sync(iscsi
, lun
, evpd
, pc
, full_size
);
1514 if (task
== NULL
|| task
->status
!= SCSI_STATUS_GOOD
) {
1519 *inq
= scsi_datain_unmarshall(task
);
1521 error_setg(errp
, "iSCSI: failed to unmarshall inquiry datain blob");
1528 error_setg(errp
, "iSCSI: Inquiry command failed : %s",
1529 iscsi_get_error(iscsi
));
1532 scsi_free_scsi_task(task
);
1537 static void iscsi_detach_aio_context(BlockDriverState
*bs
)
1539 IscsiLun
*iscsilun
= bs
->opaque
;
1541 aio_set_fd_handler(iscsilun
->aio_context
, iscsi_get_fd(iscsilun
->iscsi
),
1542 false, NULL
, NULL
, NULL
, NULL
);
1543 iscsilun
->events
= 0;
1545 if (iscsilun
->nop_timer
) {
1546 timer_del(iscsilun
->nop_timer
);
1547 timer_free(iscsilun
->nop_timer
);
1548 iscsilun
->nop_timer
= NULL
;
1550 if (iscsilun
->event_timer
) {
1551 timer_del(iscsilun
->event_timer
);
1552 timer_free(iscsilun
->event_timer
);
1553 iscsilun
->event_timer
= NULL
;
1557 static void iscsi_attach_aio_context(BlockDriverState
*bs
,
1558 AioContext
*new_context
)
1560 IscsiLun
*iscsilun
= bs
->opaque
;
1562 iscsilun
->aio_context
= new_context
;
1563 iscsi_set_events(iscsilun
);
1565 /* Set up a timer for sending out iSCSI NOPs */
1566 iscsilun
->nop_timer
= aio_timer_new(iscsilun
->aio_context
,
1567 QEMU_CLOCK_REALTIME
, SCALE_MS
,
1568 iscsi_nop_timed_event
, iscsilun
);
1569 timer_mod(iscsilun
->nop_timer
,
1570 qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) + NOP_INTERVAL
);
1572 /* Set up a timer for periodic calls to iscsi_set_events and to
1573 * scan for command timeout */
1574 iscsilun
->event_timer
= aio_timer_new(iscsilun
->aio_context
,
1575 QEMU_CLOCK_REALTIME
, SCALE_MS
,
1576 iscsi_timed_check_events
, iscsilun
);
1577 timer_mod(iscsilun
->event_timer
,
1578 qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) + EVENT_INTERVAL
);
1581 static void iscsi_modesense_sync(IscsiLun
*iscsilun
)
1583 struct scsi_task
*task
;
1584 struct scsi_mode_sense
*ms
= NULL
;
1585 iscsilun
->write_protected
= false;
1586 iscsilun
->dpofua
= false;
1588 task
= iscsi_modesense6_sync(iscsilun
->iscsi
, iscsilun
->lun
,
1589 1, SCSI_MODESENSE_PC_CURRENT
,
1592 error_report("iSCSI: Failed to send MODE_SENSE(6) command: %s",
1593 iscsi_get_error(iscsilun
->iscsi
));
1597 if (task
->status
!= SCSI_STATUS_GOOD
) {
1598 error_report("iSCSI: Failed MODE_SENSE(6), LUN assumed writable");
1601 ms
= scsi_datain_unmarshall(task
);
1603 error_report("iSCSI: Failed to unmarshall MODE_SENSE(6) data: %s",
1604 iscsi_get_error(iscsilun
->iscsi
));
1607 iscsilun
->write_protected
= ms
->device_specific_parameter
& 0x80;
1608 iscsilun
->dpofua
= ms
->device_specific_parameter
& 0x10;
1612 scsi_free_scsi_task(task
);
1617 * We support iscsi url's on the form
1618 * iscsi://[<username>%<password>@]<host>[:<port>]/<targetname>/<lun>
1620 static int iscsi_open(BlockDriverState
*bs
, QDict
*options
, int flags
,
1623 IscsiLun
*iscsilun
= bs
->opaque
;
1624 struct iscsi_context
*iscsi
= NULL
;
1625 struct iscsi_url
*iscsi_url
= NULL
;
1626 struct scsi_task
*task
= NULL
;
1627 struct scsi_inquiry_standard
*inq
= NULL
;
1628 struct scsi_inquiry_supported_pages
*inq_vpd
;
1629 char *initiator_name
= NULL
;
1631 Error
*local_err
= NULL
;
1632 const char *filename
;
1633 int i
, ret
= 0, timeout
= 0;
1635 opts
= qemu_opts_create(&runtime_opts
, NULL
, 0, &error_abort
);
1636 qemu_opts_absorb_qdict(opts
, options
, &local_err
);
1638 error_propagate(errp
, local_err
);
1643 filename
= qemu_opt_get(opts
, "filename");
1645 iscsi_url
= iscsi_parse_full_url(iscsi
, filename
);
1646 if (iscsi_url
== NULL
) {
1647 error_setg(errp
, "Failed to parse URL : %s", filename
);
1652 memset(iscsilun
, 0, sizeof(IscsiLun
));
1654 initiator_name
= parse_initiator_name(iscsi_url
->target
);
1656 iscsi
= iscsi_create_context(initiator_name
);
1657 if (iscsi
== NULL
) {
1658 error_setg(errp
, "iSCSI: Failed to create iSCSI context.");
1662 #if LIBISCSI_API_VERSION >= (20160603)
1663 if (iscsi_init_transport(iscsi
, iscsi_url
->transport
)) {
1664 error_setg(errp
, ("Error initializing transport."));
1669 if (iscsi_set_targetname(iscsi
, iscsi_url
->target
)) {
1670 error_setg(errp
, "iSCSI: Failed to set target name.");
1675 if (iscsi_url
->user
[0] != '\0') {
1676 ret
= iscsi_set_initiator_username_pwd(iscsi
, iscsi_url
->user
,
1679 error_setg(errp
, "Failed to set initiator username and password");
1685 /* check if we got CHAP username/password via the options */
1686 parse_chap(iscsi
, iscsi_url
->target
, &local_err
);
1687 if (local_err
!= NULL
) {
1688 error_propagate(errp
, local_err
);
1693 if (iscsi_set_session_type(iscsi
, ISCSI_SESSION_NORMAL
) != 0) {
1694 error_setg(errp
, "iSCSI: Failed to set session type to normal.");
1699 iscsi_set_header_digest(iscsi
, ISCSI_HEADER_DIGEST_NONE_CRC32C
);
1701 /* check if we got HEADER_DIGEST via the options */
1702 parse_header_digest(iscsi
, iscsi_url
->target
, &local_err
);
1703 if (local_err
!= NULL
) {
1704 error_propagate(errp
, local_err
);
1709 /* timeout handling is broken in libiscsi before 1.15.0 */
1710 timeout
= parse_timeout(iscsi_url
->target
);
1711 #if LIBISCSI_API_VERSION >= 20150621
1712 iscsi_set_timeout(iscsi
, timeout
);
1715 error_report("iSCSI: ignoring timeout value for libiscsi <1.15.0");
1719 if (iscsi_full_connect_sync(iscsi
, iscsi_url
->portal
, iscsi_url
->lun
) != 0) {
1720 error_setg(errp
, "iSCSI: Failed to connect to LUN : %s",
1721 iscsi_get_error(iscsi
));
1726 iscsilun
->iscsi
= iscsi
;
1727 iscsilun
->aio_context
= bdrv_get_aio_context(bs
);
1728 iscsilun
->lun
= iscsi_url
->lun
;
1729 iscsilun
->has_write_same
= true;
1731 task
= iscsi_do_inquiry(iscsilun
->iscsi
, iscsilun
->lun
, 0, 0,
1732 (void **) &inq
, errp
);
1737 iscsilun
->type
= inq
->periperal_device_type
;
1738 scsi_free_scsi_task(task
);
1741 iscsi_modesense_sync(iscsilun
);
1742 if (iscsilun
->dpofua
) {
1743 bs
->supported_write_flags
= BDRV_REQ_FUA
;
1745 bs
->supported_zero_flags
= BDRV_REQ_MAY_UNMAP
;
1747 /* Check the write protect flag of the LUN if we want to write */
1748 if (iscsilun
->type
== TYPE_DISK
&& (flags
& BDRV_O_RDWR
) &&
1749 iscsilun
->write_protected
) {
1750 error_setg(errp
, "Cannot open a write protected LUN as read-write");
1755 iscsi_readcapacity_sync(iscsilun
, &local_err
);
1756 if (local_err
!= NULL
) {
1757 error_propagate(errp
, local_err
);
1761 bs
->total_sectors
= sector_lun2qemu(iscsilun
->num_blocks
, iscsilun
);
1763 /* We don't have any emulation for devices other than disks and CD-ROMs, so
1764 * this must be sg ioctl compatible. We force it to be sg, otherwise qemu
1765 * will try to read from the device to guess the image format.
1767 if (iscsilun
->type
!= TYPE_DISK
&& iscsilun
->type
!= TYPE_ROM
) {
1771 task
= iscsi_do_inquiry(iscsilun
->iscsi
, iscsilun
->lun
, 1,
1772 SCSI_INQUIRY_PAGECODE_SUPPORTED_VPD_PAGES
,
1773 (void **) &inq_vpd
, errp
);
1778 for (i
= 0; i
< inq_vpd
->num_pages
; i
++) {
1779 struct scsi_task
*inq_task
;
1780 struct scsi_inquiry_logical_block_provisioning
*inq_lbp
;
1781 struct scsi_inquiry_block_limits
*inq_bl
;
1782 switch (inq_vpd
->pages
[i
]) {
1783 case SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING
:
1784 inq_task
= iscsi_do_inquiry(iscsilun
->iscsi
, iscsilun
->lun
, 1,
1785 SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING
,
1786 (void **) &inq_lbp
, errp
);
1787 if (inq_task
== NULL
) {
1791 memcpy(&iscsilun
->lbp
, inq_lbp
,
1792 sizeof(struct scsi_inquiry_logical_block_provisioning
));
1793 scsi_free_scsi_task(inq_task
);
1795 case SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS
:
1796 inq_task
= iscsi_do_inquiry(iscsilun
->iscsi
, iscsilun
->lun
, 1,
1797 SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS
,
1798 (void **) &inq_bl
, errp
);
1799 if (inq_task
== NULL
) {
1803 memcpy(&iscsilun
->bl
, inq_bl
,
1804 sizeof(struct scsi_inquiry_block_limits
));
1805 scsi_free_scsi_task(inq_task
);
1811 scsi_free_scsi_task(task
);
1814 iscsi_attach_aio_context(bs
, iscsilun
->aio_context
);
1816 /* Guess the internal cluster (page) size of the iscsi target by the means
1817 * of opt_unmap_gran. Transfer the unmap granularity only if it has a
1818 * reasonable size */
1819 if (iscsilun
->bl
.opt_unmap_gran
* iscsilun
->block_size
>= 4 * 1024 &&
1820 iscsilun
->bl
.opt_unmap_gran
* iscsilun
->block_size
<= 16 * 1024 * 1024) {
1821 iscsilun
->cluster_sectors
= (iscsilun
->bl
.opt_unmap_gran
*
1822 iscsilun
->block_size
) >> BDRV_SECTOR_BITS
;
1823 if (iscsilun
->lbprz
) {
1824 ret
= iscsi_allocmap_init(iscsilun
, bs
->open_flags
);
1829 qemu_opts_del(opts
);
1830 g_free(initiator_name
);
1831 if (iscsi_url
!= NULL
) {
1832 iscsi_destroy_url(iscsi_url
);
1835 scsi_free_scsi_task(task
);
1839 if (iscsi
!= NULL
) {
1840 if (iscsi_is_logged_in(iscsi
)) {
1841 iscsi_logout_sync(iscsi
);
1843 iscsi_destroy_context(iscsi
);
1845 memset(iscsilun
, 0, sizeof(IscsiLun
));
1850 static void iscsi_close(BlockDriverState
*bs
)
1852 IscsiLun
*iscsilun
= bs
->opaque
;
1853 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
1855 iscsi_detach_aio_context(bs
);
1856 if (iscsi_is_logged_in(iscsi
)) {
1857 iscsi_logout_sync(iscsi
);
1859 iscsi_destroy_context(iscsi
);
1860 g_free(iscsilun
->zeroblock
);
1861 iscsi_allocmap_free(iscsilun
);
1862 memset(iscsilun
, 0, sizeof(IscsiLun
));
1865 static void iscsi_refresh_limits(BlockDriverState
*bs
, Error
**errp
)
1867 /* We don't actually refresh here, but just return data queried in
1868 * iscsi_open(): iscsi targets don't change their limits. */
1870 IscsiLun
*iscsilun
= bs
->opaque
;
1871 uint64_t max_xfer_len
= iscsilun
->use_16_for_rw
? 0xffffffff : 0xffff;
1872 unsigned int block_size
= MAX(BDRV_SECTOR_SIZE
, iscsilun
->block_size
);
1874 assert(iscsilun
->block_size
>= BDRV_SECTOR_SIZE
|| bs
->sg
);
1876 bs
->bl
.request_alignment
= block_size
;
1878 if (iscsilun
->bl
.max_xfer_len
) {
1879 max_xfer_len
= MIN(max_xfer_len
, iscsilun
->bl
.max_xfer_len
);
1882 if (max_xfer_len
* block_size
< INT_MAX
) {
1883 bs
->bl
.max_transfer
= max_xfer_len
* iscsilun
->block_size
;
1886 if (iscsilun
->lbp
.lbpu
) {
1887 if (iscsilun
->bl
.max_unmap
< 0xffffffff / block_size
) {
1888 bs
->bl
.max_pdiscard
=
1889 iscsilun
->bl
.max_unmap
* iscsilun
->block_size
;
1891 bs
->bl
.pdiscard_alignment
=
1892 iscsilun
->bl
.opt_unmap_gran
* iscsilun
->block_size
;
1894 bs
->bl
.pdiscard_alignment
= iscsilun
->block_size
;
1897 if (iscsilun
->bl
.max_ws_len
< 0xffffffff / block_size
) {
1898 bs
->bl
.max_pwrite_zeroes
=
1899 iscsilun
->bl
.max_ws_len
* iscsilun
->block_size
;
1901 if (iscsilun
->lbp
.lbpws
) {
1902 bs
->bl
.pwrite_zeroes_alignment
=
1903 iscsilun
->bl
.opt_unmap_gran
* iscsilun
->block_size
;
1905 bs
->bl
.pwrite_zeroes_alignment
= iscsilun
->block_size
;
1907 if (iscsilun
->bl
.opt_xfer_len
&&
1908 iscsilun
->bl
.opt_xfer_len
< INT_MAX
/ block_size
) {
1909 bs
->bl
.opt_transfer
= pow2floor(iscsilun
->bl
.opt_xfer_len
*
1910 iscsilun
->block_size
);
1914 /* Note that this will not re-establish a connection with an iSCSI target - it
1915 * is effectively a NOP. */
1916 static int iscsi_reopen_prepare(BDRVReopenState
*state
,
1917 BlockReopenQueue
*queue
, Error
**errp
)
1919 IscsiLun
*iscsilun
= state
->bs
->opaque
;
1921 if (state
->flags
& BDRV_O_RDWR
&& iscsilun
->write_protected
) {
1922 error_setg(errp
, "Cannot open a write protected LUN as read-write");
1928 static void iscsi_reopen_commit(BDRVReopenState
*reopen_state
)
1930 IscsiLun
*iscsilun
= reopen_state
->bs
->opaque
;
1932 /* the cache.direct status might have changed */
1933 if (iscsilun
->allocmap
!= NULL
) {
1934 iscsi_allocmap_init(iscsilun
, reopen_state
->flags
);
1938 static int iscsi_truncate(BlockDriverState
*bs
, int64_t offset
)
1940 IscsiLun
*iscsilun
= bs
->opaque
;
1941 Error
*local_err
= NULL
;
1943 if (iscsilun
->type
!= TYPE_DISK
) {
1947 iscsi_readcapacity_sync(iscsilun
, &local_err
);
1948 if (local_err
!= NULL
) {
1949 error_free(local_err
);
1953 if (offset
> iscsi_getlength(bs
)) {
1957 if (iscsilun
->allocmap
!= NULL
) {
1958 iscsi_allocmap_init(iscsilun
, bs
->open_flags
);
1964 static int iscsi_create(const char *filename
, QemuOpts
*opts
, Error
**errp
)
1967 int64_t total_size
= 0;
1968 BlockDriverState
*bs
;
1969 IscsiLun
*iscsilun
= NULL
;
1974 /* Read out options */
1975 total_size
= DIV_ROUND_UP(qemu_opt_get_size_del(opts
, BLOCK_OPT_SIZE
, 0),
1977 bs
->opaque
= g_new0(struct IscsiLun
, 1);
1978 iscsilun
= bs
->opaque
;
1980 bs_options
= qdict_new();
1981 qdict_put(bs_options
, "filename", qstring_from_str(filename
));
1982 ret
= iscsi_open(bs
, bs_options
, 0, NULL
);
1983 QDECREF(bs_options
);
1988 iscsi_detach_aio_context(bs
);
1989 if (iscsilun
->type
!= TYPE_DISK
) {
1993 if (bs
->total_sectors
< total_size
) {
2000 if (iscsilun
->iscsi
!= NULL
) {
2001 iscsi_destroy_context(iscsilun
->iscsi
);
2009 static int iscsi_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
)
2011 IscsiLun
*iscsilun
= bs
->opaque
;
2012 bdi
->unallocated_blocks_are_zero
= iscsilun
->lbprz
;
2013 bdi
->can_write_zeroes_with_unmap
= iscsilun
->lbprz
&& iscsilun
->lbp
.lbpws
;
2014 bdi
->cluster_size
= iscsilun
->cluster_sectors
* BDRV_SECTOR_SIZE
;
2018 static void iscsi_invalidate_cache(BlockDriverState
*bs
,
2021 IscsiLun
*iscsilun
= bs
->opaque
;
2022 iscsi_allocmap_invalidate(iscsilun
);
2025 static QemuOptsList iscsi_create_opts
= {
2026 .name
= "iscsi-create-opts",
2027 .head
= QTAILQ_HEAD_INITIALIZER(iscsi_create_opts
.head
),
2030 .name
= BLOCK_OPT_SIZE
,
2031 .type
= QEMU_OPT_SIZE
,
2032 .help
= "Virtual disk size"
2034 { /* end of list */ }
2038 static BlockDriver bdrv_iscsi
= {
2039 .format_name
= "iscsi",
2040 .protocol_name
= "iscsi",
2042 .instance_size
= sizeof(IscsiLun
),
2043 .bdrv_needs_filename
= true,
2044 .bdrv_file_open
= iscsi_open
,
2045 .bdrv_close
= iscsi_close
,
2046 .bdrv_create
= iscsi_create
,
2047 .create_opts
= &iscsi_create_opts
,
2048 .bdrv_reopen_prepare
= iscsi_reopen_prepare
,
2049 .bdrv_reopen_commit
= iscsi_reopen_commit
,
2050 .bdrv_invalidate_cache
= iscsi_invalidate_cache
,
2052 .bdrv_getlength
= iscsi_getlength
,
2053 .bdrv_get_info
= iscsi_get_info
,
2054 .bdrv_truncate
= iscsi_truncate
,
2055 .bdrv_refresh_limits
= iscsi_refresh_limits
,
2057 .bdrv_co_get_block_status
= iscsi_co_get_block_status
,
2058 .bdrv_co_pdiscard
= iscsi_co_pdiscard
,
2059 .bdrv_co_pwrite_zeroes
= iscsi_co_pwrite_zeroes
,
2060 .bdrv_co_readv
= iscsi_co_readv
,
2061 .bdrv_co_writev_flags
= iscsi_co_writev_flags
,
2062 .bdrv_co_flush_to_disk
= iscsi_co_flush
,
2065 .bdrv_aio_ioctl
= iscsi_aio_ioctl
,
2068 .bdrv_detach_aio_context
= iscsi_detach_aio_context
,
2069 .bdrv_attach_aio_context
= iscsi_attach_aio_context
,
2072 #if LIBISCSI_API_VERSION >= (20160603)
2073 static BlockDriver bdrv_iser
= {
2074 .format_name
= "iser",
2075 .protocol_name
= "iser",
2077 .instance_size
= sizeof(IscsiLun
),
2078 .bdrv_needs_filename
= true,
2079 .bdrv_file_open
= iscsi_open
,
2080 .bdrv_close
= iscsi_close
,
2081 .bdrv_create
= iscsi_create
,
2082 .create_opts
= &iscsi_create_opts
,
2083 .bdrv_reopen_prepare
= iscsi_reopen_prepare
,
2084 .bdrv_reopen_commit
= iscsi_reopen_commit
,
2085 .bdrv_invalidate_cache
= iscsi_invalidate_cache
,
2087 .bdrv_getlength
= iscsi_getlength
,
2088 .bdrv_get_info
= iscsi_get_info
,
2089 .bdrv_truncate
= iscsi_truncate
,
2090 .bdrv_refresh_limits
= iscsi_refresh_limits
,
2092 .bdrv_co_get_block_status
= iscsi_co_get_block_status
,
2093 .bdrv_co_pdiscard
= iscsi_co_pdiscard
,
2094 .bdrv_co_pwrite_zeroes
= iscsi_co_pwrite_zeroes
,
2095 .bdrv_co_readv
= iscsi_co_readv
,
2096 .bdrv_co_writev_flags
= iscsi_co_writev_flags
,
2097 .bdrv_co_flush_to_disk
= iscsi_co_flush
,
2100 .bdrv_aio_ioctl
= iscsi_aio_ioctl
,
2103 .bdrv_detach_aio_context
= iscsi_detach_aio_context
,
2104 .bdrv_attach_aio_context
= iscsi_attach_aio_context
,
2108 static void iscsi_block_init(void)
2110 bdrv_register(&bdrv_iscsi
);
2111 #if LIBISCSI_API_VERSION >= (20160603)
2112 bdrv_register(&bdrv_iser
);
2116 block_init(iscsi_block_init
);