2 * QEMU Block driver for iSCSI images
4 * Copyright (c) 2010-2011 Ronnie Sahlberg <ronniesahlberg@gmail.com>
5 * Copyright (c) 2012-2015 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 "sysemu/sysemu.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 unsigned long *allocationmap
;
72 bool request_timed_out
;
75 typedef struct IscsiTask
{
80 struct scsi_task
*task
;
84 QEMUTimer retry_timer
;
88 typedef struct IscsiAIOCB
{
93 struct scsi_task
*task
;
104 /* libiscsi uses time_t so its enough to process events every second */
105 #define EVENT_INTERVAL 1000
106 #define NOP_INTERVAL 5000
107 #define MAX_NOP_FAILURES 3
108 #define ISCSI_CMD_RETRIES ARRAY_SIZE(iscsi_retry_times)
109 static const unsigned iscsi_retry_times
[] = {8, 32, 128, 512, 2048, 8192, 32768};
111 /* this threshold is a trade-off knob to choose between
112 * the potential additional overhead of an extra GET_LBA_STATUS request
113 * vs. unnecessarily reading a lot of zero sectors over the wire.
114 * If a read request is greater or equal than ISCSI_CHECKALLOC_THRES
115 * sectors we check the allocation status of the area covered by the
116 * request first if the allocationmap indicates that the area might be
118 #define ISCSI_CHECKALLOC_THRES 64
125 qemu_bh_delete(acb
->bh
);
130 acb
->common
.cb(acb
->common
.opaque
, acb
->status
);
132 if (acb
->task
!= NULL
) {
133 scsi_free_scsi_task(acb
->task
);
141 iscsi_schedule_bh(IscsiAIOCB
*acb
)
146 acb
->bh
= aio_bh_new(acb
->iscsilun
->aio_context
, iscsi_bh_cb
, acb
);
147 qemu_bh_schedule(acb
->bh
);
150 static void iscsi_co_generic_bh_cb(void *opaque
)
152 struct IscsiTask
*iTask
= opaque
;
154 qemu_bh_delete(iTask
->bh
);
155 qemu_coroutine_enter(iTask
->co
);
158 static void iscsi_retry_timer_expired(void *opaque
)
160 struct IscsiTask
*iTask
= opaque
;
163 qemu_coroutine_enter(iTask
->co
);
167 static inline unsigned exp_random(double mean
)
169 return -mean
* log((double)rand() / RAND_MAX
);
172 /* SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST was introduced in
173 * libiscsi 1.10.0, together with other constants we need. Use it as
174 * a hint that we have to define them ourselves if needed, to keep the
175 * minimum required libiscsi version at 1.9.0. We use an ASCQ macro for
176 * the test because SCSI_STATUS_* is an enum.
178 * To guard against future changes where SCSI_SENSE_ASCQ_* also becomes
179 * an enum, check against the LIBISCSI_API_VERSION macro, which was
180 * introduced in 1.11.0. If it is present, there is no need to define
183 #if !defined(SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST) && \
184 !defined(LIBISCSI_API_VERSION)
185 #define SCSI_STATUS_TASK_SET_FULL 0x28
186 #define SCSI_STATUS_TIMEOUT 0x0f000002
187 #define SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST 0x2600
188 #define SCSI_SENSE_ASCQ_PARAMETER_LIST_LENGTH_ERROR 0x1a00
191 static int iscsi_translate_sense(struct scsi_sense
*sense
)
195 switch (sense
->key
) {
196 case SCSI_SENSE_NOT_READY
:
198 case SCSI_SENSE_DATA_PROTECTION
:
200 case SCSI_SENSE_COMMAND_ABORTED
:
202 case SCSI_SENSE_ILLEGAL_REQUEST
:
208 switch (sense
->ascq
) {
209 case SCSI_SENSE_ASCQ_PARAMETER_LIST_LENGTH_ERROR
:
210 case SCSI_SENSE_ASCQ_INVALID_OPERATION_CODE
:
211 case SCSI_SENSE_ASCQ_INVALID_FIELD_IN_CDB
:
212 case SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST
:
215 case SCSI_SENSE_ASCQ_LBA_OUT_OF_RANGE
:
218 case SCSI_SENSE_ASCQ_LOGICAL_UNIT_NOT_SUPPORTED
:
221 case SCSI_SENSE_ASCQ_MEDIUM_NOT_PRESENT
:
222 case SCSI_SENSE_ASCQ_MEDIUM_NOT_PRESENT_TRAY_CLOSED
:
223 case SCSI_SENSE_ASCQ_MEDIUM_NOT_PRESENT_TRAY_OPEN
:
226 case SCSI_SENSE_ASCQ_WRITE_PROTECTED
:
237 iscsi_co_generic_cb(struct iscsi_context
*iscsi
, int status
,
238 void *command_data
, void *opaque
)
240 struct IscsiTask
*iTask
= opaque
;
241 struct scsi_task
*task
= command_data
;
243 iTask
->status
= status
;
247 if (status
!= SCSI_STATUS_GOOD
) {
248 if (iTask
->retries
++ < ISCSI_CMD_RETRIES
) {
249 if (status
== SCSI_STATUS_CHECK_CONDITION
250 && task
->sense
.key
== SCSI_SENSE_UNIT_ATTENTION
) {
251 error_report("iSCSI CheckCondition: %s",
252 iscsi_get_error(iscsi
));
256 if (status
== SCSI_STATUS_BUSY
||
257 status
== SCSI_STATUS_TIMEOUT
||
258 status
== SCSI_STATUS_TASK_SET_FULL
) {
259 unsigned retry_time
=
260 exp_random(iscsi_retry_times
[iTask
->retries
- 1]);
261 if (status
== SCSI_STATUS_TIMEOUT
) {
262 /* make sure the request is rescheduled AFTER the
263 * reconnect is initiated */
264 retry_time
= EVENT_INTERVAL
* 2;
265 iTask
->iscsilun
->request_timed_out
= true;
267 error_report("iSCSI Busy/TaskSetFull/TimeOut"
268 " (retry #%u in %u ms): %s",
269 iTask
->retries
, retry_time
,
270 iscsi_get_error(iscsi
));
271 aio_timer_init(iTask
->iscsilun
->aio_context
,
272 &iTask
->retry_timer
, QEMU_CLOCK_REALTIME
,
273 SCALE_MS
, iscsi_retry_timer_expired
, iTask
);
274 timer_mod(&iTask
->retry_timer
,
275 qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) + retry_time
);
280 iTask
->err_code
= iscsi_translate_sense(&task
->sense
);
281 error_report("iSCSI Failure: %s", iscsi_get_error(iscsi
));
286 iTask
->bh
= aio_bh_new(iTask
->iscsilun
->aio_context
,
287 iscsi_co_generic_bh_cb
, iTask
);
288 qemu_bh_schedule(iTask
->bh
);
294 static void iscsi_co_init_iscsitask(IscsiLun
*iscsilun
, struct IscsiTask
*iTask
)
296 *iTask
= (struct IscsiTask
) {
297 .co
= qemu_coroutine_self(),
298 .iscsilun
= iscsilun
,
303 iscsi_abort_task_cb(struct iscsi_context
*iscsi
, int status
, void *command_data
,
306 IscsiAIOCB
*acb
= private_data
;
308 acb
->status
= -ECANCELED
;
309 iscsi_schedule_bh(acb
);
313 iscsi_aio_cancel(BlockAIOCB
*blockacb
)
315 IscsiAIOCB
*acb
= (IscsiAIOCB
*)blockacb
;
316 IscsiLun
*iscsilun
= acb
->iscsilun
;
318 if (acb
->status
!= -EINPROGRESS
) {
322 /* send a task mgmt call to the target to cancel the task on the target */
323 iscsi_task_mgmt_abort_task_async(iscsilun
->iscsi
, acb
->task
,
324 iscsi_abort_task_cb
, acb
);
328 static const AIOCBInfo iscsi_aiocb_info
= {
329 .aiocb_size
= sizeof(IscsiAIOCB
),
330 .cancel_async
= iscsi_aio_cancel
,
334 static void iscsi_process_read(void *arg
);
335 static void iscsi_process_write(void *arg
);
338 iscsi_set_events(IscsiLun
*iscsilun
)
340 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
341 int ev
= iscsi_which_events(iscsi
);
343 if (ev
!= iscsilun
->events
) {
344 aio_set_fd_handler(iscsilun
->aio_context
, iscsi_get_fd(iscsi
),
346 (ev
& POLLIN
) ? iscsi_process_read
: NULL
,
347 (ev
& POLLOUT
) ? iscsi_process_write
: NULL
,
349 iscsilun
->events
= ev
;
353 static void iscsi_timed_check_events(void *opaque
)
355 IscsiLun
*iscsilun
= opaque
;
357 /* check for timed out requests */
358 iscsi_service(iscsilun
->iscsi
, 0);
360 if (iscsilun
->request_timed_out
) {
361 iscsilun
->request_timed_out
= false;
362 iscsi_reconnect(iscsilun
->iscsi
);
365 /* newer versions of libiscsi may return zero events. Ensure we are able
366 * to return to service once this situation changes. */
367 iscsi_set_events(iscsilun
);
369 timer_mod(iscsilun
->event_timer
,
370 qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) + EVENT_INTERVAL
);
374 iscsi_process_read(void *arg
)
376 IscsiLun
*iscsilun
= arg
;
377 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
379 iscsi_service(iscsi
, POLLIN
);
380 iscsi_set_events(iscsilun
);
384 iscsi_process_write(void *arg
)
386 IscsiLun
*iscsilun
= arg
;
387 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
389 iscsi_service(iscsi
, POLLOUT
);
390 iscsi_set_events(iscsilun
);
393 static int64_t sector_lun2qemu(int64_t sector
, IscsiLun
*iscsilun
)
395 return sector
* iscsilun
->block_size
/ BDRV_SECTOR_SIZE
;
398 static int64_t sector_qemu2lun(int64_t sector
, IscsiLun
*iscsilun
)
400 return sector
* BDRV_SECTOR_SIZE
/ iscsilun
->block_size
;
403 static bool is_byte_request_lun_aligned(int64_t offset
, int count
,
406 if (offset
% iscsilun
->block_size
|| count
% iscsilun
->block_size
) {
407 error_report("iSCSI misaligned request: "
408 "iscsilun->block_size %u, offset %" PRIi64
410 iscsilun
->block_size
, offset
, count
);
416 static bool is_sector_request_lun_aligned(int64_t sector_num
, int nb_sectors
,
419 assert(nb_sectors
<= BDRV_REQUEST_MAX_SECTORS
);
420 return is_byte_request_lun_aligned(sector_num
<< BDRV_SECTOR_BITS
,
421 nb_sectors
<< BDRV_SECTOR_BITS
,
425 static unsigned long *iscsi_allocationmap_init(IscsiLun
*iscsilun
)
427 return bitmap_try_new(DIV_ROUND_UP(sector_lun2qemu(iscsilun
->num_blocks
,
429 iscsilun
->cluster_sectors
));
432 static void iscsi_allocationmap_set(IscsiLun
*iscsilun
, int64_t sector_num
,
435 if (iscsilun
->allocationmap
== NULL
) {
438 bitmap_set(iscsilun
->allocationmap
,
439 sector_num
/ iscsilun
->cluster_sectors
,
440 DIV_ROUND_UP(nb_sectors
, iscsilun
->cluster_sectors
));
443 static void iscsi_allocationmap_clear(IscsiLun
*iscsilun
, int64_t sector_num
,
446 int64_t cluster_num
, nb_clusters
;
447 if (iscsilun
->allocationmap
== NULL
) {
450 cluster_num
= DIV_ROUND_UP(sector_num
, iscsilun
->cluster_sectors
);
451 nb_clusters
= (sector_num
+ nb_sectors
) / iscsilun
->cluster_sectors
453 if (nb_clusters
> 0) {
454 bitmap_clear(iscsilun
->allocationmap
, cluster_num
, nb_clusters
);
458 static int coroutine_fn
459 iscsi_co_writev_flags(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
,
460 QEMUIOVector
*iov
, int flags
)
462 IscsiLun
*iscsilun
= bs
->opaque
;
463 struct IscsiTask iTask
;
465 uint32_t num_sectors
;
466 bool fua
= flags
& BDRV_REQ_FUA
;
469 assert(iscsilun
->dpofua
);
471 if (!is_sector_request_lun_aligned(sector_num
, nb_sectors
, iscsilun
)) {
475 if (bs
->bl
.max_transfer
&&
476 nb_sectors
<< BDRV_SECTOR_BITS
> bs
->bl
.max_transfer
) {
477 error_report("iSCSI Error: Write of %d sectors exceeds max_xfer_len "
478 "of %" PRIu32
" bytes", nb_sectors
, bs
->bl
.max_transfer
);
482 lba
= sector_qemu2lun(sector_num
, iscsilun
);
483 num_sectors
= sector_qemu2lun(nb_sectors
, iscsilun
);
484 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
486 if (iscsilun
->use_16_for_rw
) {
487 iTask
.task
= iscsi_write16_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
488 NULL
, num_sectors
* iscsilun
->block_size
,
489 iscsilun
->block_size
, 0, 0, fua
, 0, 0,
490 iscsi_co_generic_cb
, &iTask
);
492 iTask
.task
= iscsi_write10_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
493 NULL
, num_sectors
* iscsilun
->block_size
,
494 iscsilun
->block_size
, 0, 0, fua
, 0, 0,
495 iscsi_co_generic_cb
, &iTask
);
497 if (iTask
.task
== NULL
) {
500 scsi_task_set_iov_out(iTask
.task
, (struct scsi_iovec
*) iov
->iov
,
502 while (!iTask
.complete
) {
503 iscsi_set_events(iscsilun
);
504 qemu_coroutine_yield();
507 if (iTask
.task
!= NULL
) {
508 scsi_free_scsi_task(iTask
.task
);
512 if (iTask
.do_retry
) {
517 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
518 return iTask
.err_code
;
521 iscsi_allocationmap_set(iscsilun
, sector_num
, nb_sectors
);
527 static bool iscsi_allocationmap_is_allocated(IscsiLun
*iscsilun
,
528 int64_t sector_num
, int nb_sectors
)
531 if (iscsilun
->allocationmap
== NULL
) {
534 size
= DIV_ROUND_UP(sector_num
+ nb_sectors
, iscsilun
->cluster_sectors
);
535 return !(find_next_bit(iscsilun
->allocationmap
, size
,
536 sector_num
/ iscsilun
->cluster_sectors
) == size
);
539 static int64_t coroutine_fn
iscsi_co_get_block_status(BlockDriverState
*bs
,
541 int nb_sectors
, int *pnum
,
542 BlockDriverState
**file
)
544 IscsiLun
*iscsilun
= bs
->opaque
;
545 struct scsi_get_lba_status
*lbas
= NULL
;
546 struct scsi_lba_status_descriptor
*lbasd
= NULL
;
547 struct IscsiTask iTask
;
550 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
552 if (!is_sector_request_lun_aligned(sector_num
, nb_sectors
, iscsilun
)) {
557 /* default to all sectors allocated */
558 ret
= BDRV_BLOCK_DATA
;
559 ret
|= (sector_num
<< BDRV_SECTOR_BITS
) | BDRV_BLOCK_OFFSET_VALID
;
562 /* LUN does not support logical block provisioning */
563 if (!iscsilun
->lbpme
) {
568 if (iscsi_get_lba_status_task(iscsilun
->iscsi
, iscsilun
->lun
,
569 sector_qemu2lun(sector_num
, iscsilun
),
570 8 + 16, iscsi_co_generic_cb
,
576 while (!iTask
.complete
) {
577 iscsi_set_events(iscsilun
);
578 qemu_coroutine_yield();
581 if (iTask
.do_retry
) {
582 if (iTask
.task
!= NULL
) {
583 scsi_free_scsi_task(iTask
.task
);
590 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
591 /* in case the get_lba_status_callout fails (i.e.
592 * because the device is busy or the cmd is not
593 * supported) we pretend all blocks are allocated
594 * for backwards compatibility */
598 lbas
= scsi_datain_unmarshall(iTask
.task
);
604 lbasd
= &lbas
->descriptors
[0];
606 if (sector_qemu2lun(sector_num
, iscsilun
) != lbasd
->lba
) {
611 *pnum
= sector_lun2qemu(lbasd
->num_blocks
, iscsilun
);
613 if (lbasd
->provisioning
== SCSI_PROVISIONING_TYPE_DEALLOCATED
||
614 lbasd
->provisioning
== SCSI_PROVISIONING_TYPE_ANCHORED
) {
615 ret
&= ~BDRV_BLOCK_DATA
;
616 if (iscsilun
->lbprz
) {
617 ret
|= BDRV_BLOCK_ZERO
;
621 if (ret
& BDRV_BLOCK_ZERO
) {
622 iscsi_allocationmap_clear(iscsilun
, sector_num
, *pnum
);
624 iscsi_allocationmap_set(iscsilun
, sector_num
, *pnum
);
627 if (*pnum
> nb_sectors
) {
631 if (iTask
.task
!= NULL
) {
632 scsi_free_scsi_task(iTask
.task
);
634 if (ret
> 0 && ret
& BDRV_BLOCK_OFFSET_VALID
) {
640 static int coroutine_fn
iscsi_co_readv(BlockDriverState
*bs
,
641 int64_t sector_num
, int nb_sectors
,
644 IscsiLun
*iscsilun
= bs
->opaque
;
645 struct IscsiTask iTask
;
647 uint32_t num_sectors
;
649 if (!is_sector_request_lun_aligned(sector_num
, nb_sectors
, iscsilun
)) {
653 if (bs
->bl
.max_transfer
&&
654 nb_sectors
<< BDRV_SECTOR_BITS
> bs
->bl
.max_transfer
) {
655 error_report("iSCSI Error: Read of %d sectors exceeds max_xfer_len "
656 "of %" PRIu32
" bytes", nb_sectors
, bs
->bl
.max_transfer
);
660 if (iscsilun
->lbprz
&& nb_sectors
>= ISCSI_CHECKALLOC_THRES
&&
661 !iscsi_allocationmap_is_allocated(iscsilun
, sector_num
, nb_sectors
)) {
664 BlockDriverState
*file
;
665 ret
= iscsi_co_get_block_status(bs
, sector_num
,
666 BDRV_REQUEST_MAX_SECTORS
, &pnum
, &file
);
670 if (ret
& BDRV_BLOCK_ZERO
&& pnum
>= nb_sectors
) {
671 qemu_iovec_memset(iov
, 0, 0x00, iov
->size
);
676 lba
= sector_qemu2lun(sector_num
, iscsilun
);
677 num_sectors
= sector_qemu2lun(nb_sectors
, iscsilun
);
679 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
681 if (iscsilun
->use_16_for_rw
) {
682 iTask
.task
= iscsi_read16_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
683 num_sectors
* iscsilun
->block_size
,
684 iscsilun
->block_size
, 0, 0, 0, 0, 0,
685 iscsi_co_generic_cb
, &iTask
);
687 iTask
.task
= iscsi_read10_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
688 num_sectors
* iscsilun
->block_size
,
689 iscsilun
->block_size
,
691 iscsi_co_generic_cb
, &iTask
);
693 if (iTask
.task
== NULL
) {
696 scsi_task_set_iov_in(iTask
.task
, (struct scsi_iovec
*) iov
->iov
, iov
->niov
);
698 while (!iTask
.complete
) {
699 iscsi_set_events(iscsilun
);
700 qemu_coroutine_yield();
703 if (iTask
.task
!= NULL
) {
704 scsi_free_scsi_task(iTask
.task
);
708 if (iTask
.do_retry
) {
713 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
714 return iTask
.err_code
;
720 static int coroutine_fn
iscsi_co_flush(BlockDriverState
*bs
)
722 IscsiLun
*iscsilun
= bs
->opaque
;
723 struct IscsiTask iTask
;
725 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
727 if (iscsi_synchronizecache10_task(iscsilun
->iscsi
, iscsilun
->lun
, 0, 0, 0,
728 0, iscsi_co_generic_cb
, &iTask
) == NULL
) {
732 while (!iTask
.complete
) {
733 iscsi_set_events(iscsilun
);
734 qemu_coroutine_yield();
737 if (iTask
.task
!= NULL
) {
738 scsi_free_scsi_task(iTask
.task
);
742 if (iTask
.do_retry
) {
747 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
748 return iTask
.err_code
;
756 iscsi_aio_ioctl_cb(struct iscsi_context
*iscsi
, int status
,
757 void *command_data
, void *opaque
)
759 IscsiAIOCB
*acb
= opaque
;
766 error_report("Failed to ioctl(SG_IO) to iSCSI lun. %s",
767 iscsi_get_error(iscsi
));
768 acb
->status
= iscsi_translate_sense(&acb
->task
->sense
);
771 acb
->ioh
->driver_status
= 0;
772 acb
->ioh
->host_status
= 0;
774 acb
->ioh
->status
= status
;
776 #define SG_ERR_DRIVER_SENSE 0x08
778 if (status
== SCSI_STATUS_CHECK_CONDITION
&& acb
->task
->datain
.size
>= 2) {
781 acb
->ioh
->driver_status
|= SG_ERR_DRIVER_SENSE
;
783 acb
->ioh
->sb_len_wr
= acb
->task
->datain
.size
- 2;
784 ss
= (acb
->ioh
->mx_sb_len
>= acb
->ioh
->sb_len_wr
) ?
785 acb
->ioh
->mx_sb_len
: acb
->ioh
->sb_len_wr
;
786 memcpy(acb
->ioh
->sbp
, &acb
->task
->datain
.data
[2], ss
);
789 iscsi_schedule_bh(acb
);
792 static void iscsi_ioctl_bh_completion(void *opaque
)
794 IscsiAIOCB
*acb
= opaque
;
796 qemu_bh_delete(acb
->bh
);
797 acb
->common
.cb(acb
->common
.opaque
, acb
->ret
);
801 static void iscsi_ioctl_handle_emulated(IscsiAIOCB
*acb
, int req
, void *buf
)
803 BlockDriverState
*bs
= acb
->common
.bs
;
804 IscsiLun
*iscsilun
= bs
->opaque
;
808 case SG_GET_VERSION_NUM
:
812 ((struct sg_scsi_id
*)buf
)->scsi_type
= iscsilun
->type
;
818 acb
->bh
= aio_bh_new(bdrv_get_aio_context(bs
),
819 iscsi_ioctl_bh_completion
, acb
);
821 qemu_bh_schedule(acb
->bh
);
824 static BlockAIOCB
*iscsi_aio_ioctl(BlockDriverState
*bs
,
825 unsigned long int req
, void *buf
,
826 BlockCompletionFunc
*cb
, void *opaque
)
828 IscsiLun
*iscsilun
= bs
->opaque
;
829 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
830 struct iscsi_data data
;
833 acb
= qemu_aio_get(&iscsi_aiocb_info
, bs
, cb
, opaque
);
835 acb
->iscsilun
= iscsilun
;
837 acb
->status
= -EINPROGRESS
;
842 iscsi_ioctl_handle_emulated(acb
, req
, buf
);
846 if (acb
->ioh
->cmd_len
> SCSI_CDB_MAX_SIZE
) {
847 error_report("iSCSI: ioctl error CDB exceeds max size (%d > %d)",
848 acb
->ioh
->cmd_len
, SCSI_CDB_MAX_SIZE
);
853 acb
->task
= malloc(sizeof(struct scsi_task
));
854 if (acb
->task
== NULL
) {
855 error_report("iSCSI: Failed to allocate task for scsi command. %s",
856 iscsi_get_error(iscsi
));
860 memset(acb
->task
, 0, sizeof(struct scsi_task
));
862 switch (acb
->ioh
->dxfer_direction
) {
863 case SG_DXFER_TO_DEV
:
864 acb
->task
->xfer_dir
= SCSI_XFER_WRITE
;
866 case SG_DXFER_FROM_DEV
:
867 acb
->task
->xfer_dir
= SCSI_XFER_READ
;
870 acb
->task
->xfer_dir
= SCSI_XFER_NONE
;
874 acb
->task
->cdb_size
= acb
->ioh
->cmd_len
;
875 memcpy(&acb
->task
->cdb
[0], acb
->ioh
->cmdp
, acb
->ioh
->cmd_len
);
876 acb
->task
->expxferlen
= acb
->ioh
->dxfer_len
;
879 if (acb
->task
->xfer_dir
== SCSI_XFER_WRITE
) {
880 if (acb
->ioh
->iovec_count
== 0) {
881 data
.data
= acb
->ioh
->dxferp
;
882 data
.size
= acb
->ioh
->dxfer_len
;
884 scsi_task_set_iov_out(acb
->task
,
885 (struct scsi_iovec
*) acb
->ioh
->dxferp
,
886 acb
->ioh
->iovec_count
);
890 if (iscsi_scsi_command_async(iscsi
, iscsilun
->lun
, acb
->task
,
892 (data
.size
> 0) ? &data
: NULL
,
894 scsi_free_scsi_task(acb
->task
);
899 /* tell libiscsi to read straight into the buffer we got from ioctl */
900 if (acb
->task
->xfer_dir
== SCSI_XFER_READ
) {
901 if (acb
->ioh
->iovec_count
== 0) {
902 scsi_task_add_data_in_buffer(acb
->task
,
906 scsi_task_set_iov_in(acb
->task
,
907 (struct scsi_iovec
*) acb
->ioh
->dxferp
,
908 acb
->ioh
->iovec_count
);
912 iscsi_set_events(iscsilun
);
920 iscsi_getlength(BlockDriverState
*bs
)
922 IscsiLun
*iscsilun
= bs
->opaque
;
925 len
= iscsilun
->num_blocks
;
926 len
*= iscsilun
->block_size
;
932 coroutine_fn
iscsi_co_discard(BlockDriverState
*bs
, int64_t sector_num
,
935 IscsiLun
*iscsilun
= bs
->opaque
;
936 struct IscsiTask iTask
;
937 struct unmap_list list
;
939 if (!is_sector_request_lun_aligned(sector_num
, nb_sectors
, iscsilun
)) {
943 if (!iscsilun
->lbp
.lbpu
) {
944 /* UNMAP is not supported by the target */
948 list
.lba
= sector_qemu2lun(sector_num
, iscsilun
);
949 list
.num
= sector_qemu2lun(nb_sectors
, iscsilun
);
951 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
953 if (iscsi_unmap_task(iscsilun
->iscsi
, iscsilun
->lun
, 0, 0, &list
, 1,
954 iscsi_co_generic_cb
, &iTask
) == NULL
) {
958 while (!iTask
.complete
) {
959 iscsi_set_events(iscsilun
);
960 qemu_coroutine_yield();
963 if (iTask
.task
!= NULL
) {
964 scsi_free_scsi_task(iTask
.task
);
968 if (iTask
.do_retry
) {
973 if (iTask
.status
== SCSI_STATUS_CHECK_CONDITION
) {
974 /* the target might fail with a check condition if it
975 is not happy with the alignment of the UNMAP request
976 we silently fail in this case */
980 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
981 return iTask
.err_code
;
984 iscsi_allocationmap_clear(iscsilun
, sector_num
, nb_sectors
);
990 coroutine_fn
iscsi_co_pwrite_zeroes(BlockDriverState
*bs
, int64_t offset
,
991 int count
, BdrvRequestFlags flags
)
993 IscsiLun
*iscsilun
= bs
->opaque
;
994 struct IscsiTask iTask
;
997 bool use_16_for_ws
= iscsilun
->use_16_for_rw
;
999 if (!is_byte_request_lun_aligned(offset
, count
, iscsilun
)) {
1003 if (flags
& BDRV_REQ_MAY_UNMAP
) {
1004 if (!use_16_for_ws
&& !iscsilun
->lbp
.lbpws10
) {
1005 /* WRITESAME10 with UNMAP is unsupported try WRITESAME16 */
1006 use_16_for_ws
= true;
1008 if (use_16_for_ws
&& !iscsilun
->lbp
.lbpws
) {
1009 /* WRITESAME16 with UNMAP is not supported by the target,
1010 * fall back and try WRITESAME10/16 without UNMAP */
1011 flags
&= ~BDRV_REQ_MAY_UNMAP
;
1012 use_16_for_ws
= iscsilun
->use_16_for_rw
;
1016 if (!(flags
& BDRV_REQ_MAY_UNMAP
) && !iscsilun
->has_write_same
) {
1017 /* WRITESAME without UNMAP is not supported by the target */
1021 lba
= offset
/ iscsilun
->block_size
;
1022 nb_blocks
= count
/ iscsilun
->block_size
;
1024 if (iscsilun
->zeroblock
== NULL
) {
1025 iscsilun
->zeroblock
= g_try_malloc0(iscsilun
->block_size
);
1026 if (iscsilun
->zeroblock
== NULL
) {
1031 iscsi_co_init_iscsitask(iscsilun
, &iTask
);
1033 if (use_16_for_ws
) {
1034 iTask
.task
= iscsi_writesame16_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
1035 iscsilun
->zeroblock
, iscsilun
->block_size
,
1036 nb_blocks
, 0, !!(flags
& BDRV_REQ_MAY_UNMAP
),
1037 0, 0, iscsi_co_generic_cb
, &iTask
);
1039 iTask
.task
= iscsi_writesame10_task(iscsilun
->iscsi
, iscsilun
->lun
, lba
,
1040 iscsilun
->zeroblock
, iscsilun
->block_size
,
1041 nb_blocks
, 0, !!(flags
& BDRV_REQ_MAY_UNMAP
),
1042 0, 0, iscsi_co_generic_cb
, &iTask
);
1044 if (iTask
.task
== NULL
) {
1048 while (!iTask
.complete
) {
1049 iscsi_set_events(iscsilun
);
1050 qemu_coroutine_yield();
1053 if (iTask
.status
== SCSI_STATUS_CHECK_CONDITION
&&
1054 iTask
.task
->sense
.key
== SCSI_SENSE_ILLEGAL_REQUEST
&&
1055 (iTask
.task
->sense
.ascq
== SCSI_SENSE_ASCQ_INVALID_OPERATION_CODE
||
1056 iTask
.task
->sense
.ascq
== SCSI_SENSE_ASCQ_INVALID_FIELD_IN_CDB
)) {
1057 /* WRITE SAME is not supported by the target */
1058 iscsilun
->has_write_same
= false;
1059 scsi_free_scsi_task(iTask
.task
);
1063 if (iTask
.task
!= NULL
) {
1064 scsi_free_scsi_task(iTask
.task
);
1068 if (iTask
.do_retry
) {
1073 if (iTask
.status
!= SCSI_STATUS_GOOD
) {
1074 return iTask
.err_code
;
1077 if (flags
& BDRV_REQ_MAY_UNMAP
) {
1078 iscsi_allocationmap_clear(iscsilun
, offset
>> BDRV_SECTOR_BITS
,
1079 count
>> BDRV_SECTOR_BITS
);
1081 iscsi_allocationmap_set(iscsilun
, offset
>> BDRV_SECTOR_BITS
,
1082 count
>> BDRV_SECTOR_BITS
);
1088 static void parse_chap(struct iscsi_context
*iscsi
, const char *target
,
1093 const char *user
= NULL
;
1094 const char *password
= NULL
;
1095 const char *secretid
;
1096 char *secret
= NULL
;
1098 list
= qemu_find_opts("iscsi");
1103 opts
= qemu_opts_find(list
, target
);
1105 opts
= QTAILQ_FIRST(&list
->head
);
1111 user
= qemu_opt_get(opts
, "user");
1116 secretid
= qemu_opt_get(opts
, "password-secret");
1117 password
= qemu_opt_get(opts
, "password");
1118 if (secretid
&& password
) {
1119 error_setg(errp
, "'password' and 'password-secret' properties are "
1120 "mutually exclusive");
1124 secret
= qcrypto_secret_lookup_as_utf8(secretid
, errp
);
1129 } else if (!password
) {
1130 error_setg(errp
, "CHAP username specified but no password was given");
1134 if (iscsi_set_initiator_username_pwd(iscsi
, user
, password
)) {
1135 error_setg(errp
, "Failed to set initiator username and password");
1141 static void parse_header_digest(struct iscsi_context
*iscsi
, const char *target
,
1146 const char *digest
= NULL
;
1148 list
= qemu_find_opts("iscsi");
1153 opts
= qemu_opts_find(list
, target
);
1155 opts
= QTAILQ_FIRST(&list
->head
);
1161 digest
= qemu_opt_get(opts
, "header-digest");
1166 if (!strcmp(digest
, "CRC32C")) {
1167 iscsi_set_header_digest(iscsi
, ISCSI_HEADER_DIGEST_CRC32C
);
1168 } else if (!strcmp(digest
, "NONE")) {
1169 iscsi_set_header_digest(iscsi
, ISCSI_HEADER_DIGEST_NONE
);
1170 } else if (!strcmp(digest
, "CRC32C-NONE")) {
1171 iscsi_set_header_digest(iscsi
, ISCSI_HEADER_DIGEST_CRC32C_NONE
);
1172 } else if (!strcmp(digest
, "NONE-CRC32C")) {
1173 iscsi_set_header_digest(iscsi
, ISCSI_HEADER_DIGEST_NONE_CRC32C
);
1175 error_setg(errp
, "Invalid header-digest setting : %s", digest
);
1179 static char *parse_initiator_name(const char *target
)
1185 UuidInfo
*uuid_info
;
1187 list
= qemu_find_opts("iscsi");
1189 opts
= qemu_opts_find(list
, target
);
1191 opts
= QTAILQ_FIRST(&list
->head
);
1194 name
= qemu_opt_get(opts
, "initiator-name");
1196 return g_strdup(name
);
1201 uuid_info
= qmp_query_uuid(NULL
);
1202 if (strcmp(uuid_info
->UUID
, UUID_NONE
) == 0) {
1203 name
= qemu_get_vm_name();
1205 name
= uuid_info
->UUID
;
1207 iscsi_name
= g_strdup_printf("iqn.2008-11.org.linux-kvm%s%s",
1208 name
? ":" : "", name
? name
: "");
1209 qapi_free_UuidInfo(uuid_info
);
1213 static int parse_timeout(const char *target
)
1217 const char *timeout
;
1219 list
= qemu_find_opts("iscsi");
1221 opts
= qemu_opts_find(list
, target
);
1223 opts
= QTAILQ_FIRST(&list
->head
);
1226 timeout
= qemu_opt_get(opts
, "timeout");
1228 return atoi(timeout
);
1236 static void iscsi_nop_timed_event(void *opaque
)
1238 IscsiLun
*iscsilun
= opaque
;
1240 if (iscsi_get_nops_in_flight(iscsilun
->iscsi
) >= MAX_NOP_FAILURES
) {
1241 error_report("iSCSI: NOP timeout. Reconnecting...");
1242 iscsilun
->request_timed_out
= true;
1243 } else if (iscsi_nop_out_async(iscsilun
->iscsi
, NULL
, NULL
, 0, NULL
) != 0) {
1244 error_report("iSCSI: failed to sent NOP-Out. Disabling NOP messages.");
1248 timer_mod(iscsilun
->nop_timer
, qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) + NOP_INTERVAL
);
1249 iscsi_set_events(iscsilun
);
1252 static void iscsi_readcapacity_sync(IscsiLun
*iscsilun
, Error
**errp
)
1254 struct scsi_task
*task
= NULL
;
1255 struct scsi_readcapacity10
*rc10
= NULL
;
1256 struct scsi_readcapacity16
*rc16
= NULL
;
1257 int retries
= ISCSI_CMD_RETRIES
;
1261 scsi_free_scsi_task(task
);
1265 switch (iscsilun
->type
) {
1267 task
= iscsi_readcapacity16_sync(iscsilun
->iscsi
, iscsilun
->lun
);
1268 if (task
!= NULL
&& task
->status
== SCSI_STATUS_GOOD
) {
1269 rc16
= scsi_datain_unmarshall(task
);
1271 error_setg(errp
, "iSCSI: Failed to unmarshall readcapacity16 data.");
1273 iscsilun
->block_size
= rc16
->block_length
;
1274 iscsilun
->num_blocks
= rc16
->returned_lba
+ 1;
1275 iscsilun
->lbpme
= !!rc16
->lbpme
;
1276 iscsilun
->lbprz
= !!rc16
->lbprz
;
1277 iscsilun
->use_16_for_rw
= (rc16
->returned_lba
> 0xffffffff);
1281 if (task
!= NULL
&& task
->status
== SCSI_STATUS_CHECK_CONDITION
1282 && task
->sense
.key
== SCSI_SENSE_UNIT_ATTENTION
) {
1285 /* Fall through and try READ CAPACITY(10) instead. */
1287 task
= iscsi_readcapacity10_sync(iscsilun
->iscsi
, iscsilun
->lun
, 0, 0);
1288 if (task
!= NULL
&& task
->status
== SCSI_STATUS_GOOD
) {
1289 rc10
= scsi_datain_unmarshall(task
);
1291 error_setg(errp
, "iSCSI: Failed to unmarshall readcapacity10 data.");
1293 iscsilun
->block_size
= rc10
->block_size
;
1294 if (rc10
->lba
== 0) {
1295 /* blank disk loaded */
1296 iscsilun
->num_blocks
= 0;
1298 iscsilun
->num_blocks
= rc10
->lba
+ 1;
1306 } while (task
!= NULL
&& task
->status
== SCSI_STATUS_CHECK_CONDITION
1307 && task
->sense
.key
== SCSI_SENSE_UNIT_ATTENTION
1310 if (task
== NULL
|| task
->status
!= SCSI_STATUS_GOOD
) {
1311 error_setg(errp
, "iSCSI: failed to send readcapacity10/16 command");
1312 } else if (!iscsilun
->block_size
||
1313 iscsilun
->block_size
% BDRV_SECTOR_SIZE
) {
1314 error_setg(errp
, "iSCSI: the target returned an invalid "
1315 "block size of %d.", iscsilun
->block_size
);
1318 scsi_free_scsi_task(task
);
1322 /* TODO Convert to fine grained options */
1323 static QemuOptsList runtime_opts
= {
1325 .head
= QTAILQ_HEAD_INITIALIZER(runtime_opts
.head
),
1329 .type
= QEMU_OPT_STRING
,
1330 .help
= "URL to the iscsi image",
1332 { /* end of list */ }
1336 static struct scsi_task
*iscsi_do_inquiry(struct iscsi_context
*iscsi
, int lun
,
1337 int evpd
, int pc
, void **inq
, Error
**errp
)
1340 struct scsi_task
*task
= NULL
;
1341 task
= iscsi_inquiry_sync(iscsi
, lun
, evpd
, pc
, 64);
1342 if (task
== NULL
|| task
->status
!= SCSI_STATUS_GOOD
) {
1345 full_size
= scsi_datain_getfullsize(task
);
1346 if (full_size
> task
->datain
.size
) {
1347 scsi_free_scsi_task(task
);
1349 /* we need more data for the full list */
1350 task
= iscsi_inquiry_sync(iscsi
, lun
, evpd
, pc
, full_size
);
1351 if (task
== NULL
|| task
->status
!= SCSI_STATUS_GOOD
) {
1356 *inq
= scsi_datain_unmarshall(task
);
1358 error_setg(errp
, "iSCSI: failed to unmarshall inquiry datain blob");
1365 error_setg(errp
, "iSCSI: Inquiry command failed : %s",
1366 iscsi_get_error(iscsi
));
1369 scsi_free_scsi_task(task
);
1374 static void iscsi_detach_aio_context(BlockDriverState
*bs
)
1376 IscsiLun
*iscsilun
= bs
->opaque
;
1378 aio_set_fd_handler(iscsilun
->aio_context
, iscsi_get_fd(iscsilun
->iscsi
),
1379 false, NULL
, NULL
, NULL
);
1380 iscsilun
->events
= 0;
1382 if (iscsilun
->nop_timer
) {
1383 timer_del(iscsilun
->nop_timer
);
1384 timer_free(iscsilun
->nop_timer
);
1385 iscsilun
->nop_timer
= NULL
;
1387 if (iscsilun
->event_timer
) {
1388 timer_del(iscsilun
->event_timer
);
1389 timer_free(iscsilun
->event_timer
);
1390 iscsilun
->event_timer
= NULL
;
1394 static void iscsi_attach_aio_context(BlockDriverState
*bs
,
1395 AioContext
*new_context
)
1397 IscsiLun
*iscsilun
= bs
->opaque
;
1399 iscsilun
->aio_context
= new_context
;
1400 iscsi_set_events(iscsilun
);
1402 /* Set up a timer for sending out iSCSI NOPs */
1403 iscsilun
->nop_timer
= aio_timer_new(iscsilun
->aio_context
,
1404 QEMU_CLOCK_REALTIME
, SCALE_MS
,
1405 iscsi_nop_timed_event
, iscsilun
);
1406 timer_mod(iscsilun
->nop_timer
,
1407 qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) + NOP_INTERVAL
);
1409 /* Set up a timer for periodic calls to iscsi_set_events and to
1410 * scan for command timeout */
1411 iscsilun
->event_timer
= aio_timer_new(iscsilun
->aio_context
,
1412 QEMU_CLOCK_REALTIME
, SCALE_MS
,
1413 iscsi_timed_check_events
, iscsilun
);
1414 timer_mod(iscsilun
->event_timer
,
1415 qemu_clock_get_ms(QEMU_CLOCK_REALTIME
) + EVENT_INTERVAL
);
1418 static void iscsi_modesense_sync(IscsiLun
*iscsilun
)
1420 struct scsi_task
*task
;
1421 struct scsi_mode_sense
*ms
= NULL
;
1422 iscsilun
->write_protected
= false;
1423 iscsilun
->dpofua
= false;
1425 task
= iscsi_modesense6_sync(iscsilun
->iscsi
, iscsilun
->lun
,
1426 1, SCSI_MODESENSE_PC_CURRENT
,
1429 error_report("iSCSI: Failed to send MODE_SENSE(6) command: %s",
1430 iscsi_get_error(iscsilun
->iscsi
));
1434 if (task
->status
!= SCSI_STATUS_GOOD
) {
1435 error_report("iSCSI: Failed MODE_SENSE(6), LUN assumed writable");
1438 ms
= scsi_datain_unmarshall(task
);
1440 error_report("iSCSI: Failed to unmarshall MODE_SENSE(6) data: %s",
1441 iscsi_get_error(iscsilun
->iscsi
));
1444 iscsilun
->write_protected
= ms
->device_specific_parameter
& 0x80;
1445 iscsilun
->dpofua
= ms
->device_specific_parameter
& 0x10;
1449 scsi_free_scsi_task(task
);
1454 * We support iscsi url's on the form
1455 * iscsi://[<username>%<password>@]<host>[:<port>]/<targetname>/<lun>
1457 static int iscsi_open(BlockDriverState
*bs
, QDict
*options
, int flags
,
1460 IscsiLun
*iscsilun
= bs
->opaque
;
1461 struct iscsi_context
*iscsi
= NULL
;
1462 struct iscsi_url
*iscsi_url
= NULL
;
1463 struct scsi_task
*task
= NULL
;
1464 struct scsi_inquiry_standard
*inq
= NULL
;
1465 struct scsi_inquiry_supported_pages
*inq_vpd
;
1466 char *initiator_name
= NULL
;
1468 Error
*local_err
= NULL
;
1469 const char *filename
;
1470 int i
, ret
= 0, timeout
= 0;
1472 opts
= qemu_opts_create(&runtime_opts
, NULL
, 0, &error_abort
);
1473 qemu_opts_absorb_qdict(opts
, options
, &local_err
);
1475 error_propagate(errp
, local_err
);
1480 filename
= qemu_opt_get(opts
, "filename");
1482 iscsi_url
= iscsi_parse_full_url(iscsi
, filename
);
1483 if (iscsi_url
== NULL
) {
1484 error_setg(errp
, "Failed to parse URL : %s", filename
);
1489 memset(iscsilun
, 0, sizeof(IscsiLun
));
1491 initiator_name
= parse_initiator_name(iscsi_url
->target
);
1493 iscsi
= iscsi_create_context(initiator_name
);
1494 if (iscsi
== NULL
) {
1495 error_setg(errp
, "iSCSI: Failed to create iSCSI context.");
1500 if (iscsi_set_targetname(iscsi
, iscsi_url
->target
)) {
1501 error_setg(errp
, "iSCSI: Failed to set target name.");
1506 if (iscsi_url
->user
[0] != '\0') {
1507 ret
= iscsi_set_initiator_username_pwd(iscsi
, iscsi_url
->user
,
1510 error_setg(errp
, "Failed to set initiator username and password");
1516 /* check if we got CHAP username/password via the options */
1517 parse_chap(iscsi
, iscsi_url
->target
, &local_err
);
1518 if (local_err
!= NULL
) {
1519 error_propagate(errp
, local_err
);
1524 if (iscsi_set_session_type(iscsi
, ISCSI_SESSION_NORMAL
) != 0) {
1525 error_setg(errp
, "iSCSI: Failed to set session type to normal.");
1530 iscsi_set_header_digest(iscsi
, ISCSI_HEADER_DIGEST_NONE_CRC32C
);
1532 /* check if we got HEADER_DIGEST via the options */
1533 parse_header_digest(iscsi
, iscsi_url
->target
, &local_err
);
1534 if (local_err
!= NULL
) {
1535 error_propagate(errp
, local_err
);
1540 /* timeout handling is broken in libiscsi before 1.15.0 */
1541 timeout
= parse_timeout(iscsi_url
->target
);
1542 #if defined(LIBISCSI_API_VERSION) && LIBISCSI_API_VERSION >= 20150621
1543 iscsi_set_timeout(iscsi
, timeout
);
1546 error_report("iSCSI: ignoring timeout value for libiscsi <1.15.0");
1550 if (iscsi_full_connect_sync(iscsi
, iscsi_url
->portal
, iscsi_url
->lun
) != 0) {
1551 error_setg(errp
, "iSCSI: Failed to connect to LUN : %s",
1552 iscsi_get_error(iscsi
));
1557 iscsilun
->iscsi
= iscsi
;
1558 iscsilun
->aio_context
= bdrv_get_aio_context(bs
);
1559 iscsilun
->lun
= iscsi_url
->lun
;
1560 iscsilun
->has_write_same
= true;
1562 task
= iscsi_do_inquiry(iscsilun
->iscsi
, iscsilun
->lun
, 0, 0,
1563 (void **) &inq
, errp
);
1568 iscsilun
->type
= inq
->periperal_device_type
;
1569 scsi_free_scsi_task(task
);
1572 iscsi_modesense_sync(iscsilun
);
1573 if (iscsilun
->dpofua
) {
1574 bs
->supported_write_flags
= BDRV_REQ_FUA
;
1576 bs
->supported_zero_flags
= BDRV_REQ_MAY_UNMAP
;
1578 /* Check the write protect flag of the LUN if we want to write */
1579 if (iscsilun
->type
== TYPE_DISK
&& (flags
& BDRV_O_RDWR
) &&
1580 iscsilun
->write_protected
) {
1581 error_setg(errp
, "Cannot open a write protected LUN as read-write");
1586 iscsi_readcapacity_sync(iscsilun
, &local_err
);
1587 if (local_err
!= NULL
) {
1588 error_propagate(errp
, local_err
);
1592 bs
->total_sectors
= sector_lun2qemu(iscsilun
->num_blocks
, iscsilun
);
1594 /* We don't have any emulation for devices other than disks and CD-ROMs, so
1595 * this must be sg ioctl compatible. We force it to be sg, otherwise qemu
1596 * will try to read from the device to guess the image format.
1598 if (iscsilun
->type
!= TYPE_DISK
&& iscsilun
->type
!= TYPE_ROM
) {
1602 task
= iscsi_do_inquiry(iscsilun
->iscsi
, iscsilun
->lun
, 1,
1603 SCSI_INQUIRY_PAGECODE_SUPPORTED_VPD_PAGES
,
1604 (void **) &inq_vpd
, errp
);
1609 for (i
= 0; i
< inq_vpd
->num_pages
; i
++) {
1610 struct scsi_task
*inq_task
;
1611 struct scsi_inquiry_logical_block_provisioning
*inq_lbp
;
1612 struct scsi_inquiry_block_limits
*inq_bl
;
1613 switch (inq_vpd
->pages
[i
]) {
1614 case SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING
:
1615 inq_task
= iscsi_do_inquiry(iscsilun
->iscsi
, iscsilun
->lun
, 1,
1616 SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING
,
1617 (void **) &inq_lbp
, errp
);
1618 if (inq_task
== NULL
) {
1622 memcpy(&iscsilun
->lbp
, inq_lbp
,
1623 sizeof(struct scsi_inquiry_logical_block_provisioning
));
1624 scsi_free_scsi_task(inq_task
);
1626 case SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS
:
1627 inq_task
= iscsi_do_inquiry(iscsilun
->iscsi
, iscsilun
->lun
, 1,
1628 SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS
,
1629 (void **) &inq_bl
, errp
);
1630 if (inq_task
== NULL
) {
1634 memcpy(&iscsilun
->bl
, inq_bl
,
1635 sizeof(struct scsi_inquiry_block_limits
));
1636 scsi_free_scsi_task(inq_task
);
1642 scsi_free_scsi_task(task
);
1645 iscsi_attach_aio_context(bs
, iscsilun
->aio_context
);
1647 /* Guess the internal cluster (page) size of the iscsi target by the means
1648 * of opt_unmap_gran. Transfer the unmap granularity only if it has a
1649 * reasonable size */
1650 if (iscsilun
->bl
.opt_unmap_gran
* iscsilun
->block_size
>= 4 * 1024 &&
1651 iscsilun
->bl
.opt_unmap_gran
* iscsilun
->block_size
<= 16 * 1024 * 1024) {
1652 iscsilun
->cluster_sectors
= (iscsilun
->bl
.opt_unmap_gran
*
1653 iscsilun
->block_size
) >> BDRV_SECTOR_BITS
;
1654 if (iscsilun
->lbprz
) {
1655 iscsilun
->allocationmap
= iscsi_allocationmap_init(iscsilun
);
1656 if (iscsilun
->allocationmap
== NULL
) {
1663 qemu_opts_del(opts
);
1664 g_free(initiator_name
);
1665 if (iscsi_url
!= NULL
) {
1666 iscsi_destroy_url(iscsi_url
);
1669 scsi_free_scsi_task(task
);
1673 if (iscsi
!= NULL
) {
1674 if (iscsi_is_logged_in(iscsi
)) {
1675 iscsi_logout_sync(iscsi
);
1677 iscsi_destroy_context(iscsi
);
1679 memset(iscsilun
, 0, sizeof(IscsiLun
));
1684 static void iscsi_close(BlockDriverState
*bs
)
1686 IscsiLun
*iscsilun
= bs
->opaque
;
1687 struct iscsi_context
*iscsi
= iscsilun
->iscsi
;
1689 iscsi_detach_aio_context(bs
);
1690 if (iscsi_is_logged_in(iscsi
)) {
1691 iscsi_logout_sync(iscsi
);
1693 iscsi_destroy_context(iscsi
);
1694 g_free(iscsilun
->zeroblock
);
1695 g_free(iscsilun
->allocationmap
);
1696 memset(iscsilun
, 0, sizeof(IscsiLun
));
1699 static void iscsi_refresh_limits(BlockDriverState
*bs
, Error
**errp
)
1701 /* We don't actually refresh here, but just return data queried in
1702 * iscsi_open(): iscsi targets don't change their limits. */
1704 IscsiLun
*iscsilun
= bs
->opaque
;
1705 uint64_t max_xfer_len
= iscsilun
->use_16_for_rw
? 0xffffffff : 0xffff;
1707 bs
->bl
.request_alignment
= iscsilun
->block_size
;
1709 if (iscsilun
->bl
.max_xfer_len
) {
1710 max_xfer_len
= MIN(max_xfer_len
, iscsilun
->bl
.max_xfer_len
);
1713 if (max_xfer_len
* iscsilun
->block_size
< INT_MAX
) {
1714 bs
->bl
.max_transfer
= max_xfer_len
* iscsilun
->block_size
;
1717 if (iscsilun
->lbp
.lbpu
) {
1718 if (iscsilun
->bl
.max_unmap
< 0xffffffff / iscsilun
->block_size
) {
1719 bs
->bl
.max_pdiscard
=
1720 iscsilun
->bl
.max_unmap
* iscsilun
->block_size
;
1722 bs
->bl
.pdiscard_alignment
=
1723 iscsilun
->bl
.opt_unmap_gran
* iscsilun
->block_size
;
1725 bs
->bl
.pdiscard_alignment
= iscsilun
->block_size
;
1728 if (iscsilun
->bl
.max_ws_len
< 0xffffffff / iscsilun
->block_size
) {
1729 bs
->bl
.max_pwrite_zeroes
=
1730 iscsilun
->bl
.max_ws_len
* iscsilun
->block_size
;
1732 if (iscsilun
->lbp
.lbpws
) {
1733 bs
->bl
.pwrite_zeroes_alignment
=
1734 iscsilun
->bl
.opt_unmap_gran
* iscsilun
->block_size
;
1736 bs
->bl
.pwrite_zeroes_alignment
= iscsilun
->block_size
;
1738 if (iscsilun
->bl
.opt_xfer_len
&&
1739 iscsilun
->bl
.opt_xfer_len
< INT_MAX
/ iscsilun
->block_size
) {
1740 bs
->bl
.opt_transfer
= pow2floor(iscsilun
->bl
.opt_xfer_len
*
1741 iscsilun
->block_size
);
1745 /* Note that this will not re-establish a connection with an iSCSI target - it
1746 * is effectively a NOP. */
1747 static int iscsi_reopen_prepare(BDRVReopenState
*state
,
1748 BlockReopenQueue
*queue
, Error
**errp
)
1750 IscsiLun
*iscsilun
= state
->bs
->opaque
;
1752 if (state
->flags
& BDRV_O_RDWR
&& iscsilun
->write_protected
) {
1753 error_setg(errp
, "Cannot open a write protected LUN as read-write");
1759 static int iscsi_truncate(BlockDriverState
*bs
, int64_t offset
)
1761 IscsiLun
*iscsilun
= bs
->opaque
;
1762 Error
*local_err
= NULL
;
1764 if (iscsilun
->type
!= TYPE_DISK
) {
1768 iscsi_readcapacity_sync(iscsilun
, &local_err
);
1769 if (local_err
!= NULL
) {
1770 error_free(local_err
);
1774 if (offset
> iscsi_getlength(bs
)) {
1778 if (iscsilun
->allocationmap
!= NULL
) {
1779 g_free(iscsilun
->allocationmap
);
1780 iscsilun
->allocationmap
= iscsi_allocationmap_init(iscsilun
);
1786 static int iscsi_create(const char *filename
, QemuOpts
*opts
, Error
**errp
)
1789 int64_t total_size
= 0;
1790 BlockDriverState
*bs
;
1791 IscsiLun
*iscsilun
= NULL
;
1796 /* Read out options */
1797 total_size
= DIV_ROUND_UP(qemu_opt_get_size_del(opts
, BLOCK_OPT_SIZE
, 0),
1799 bs
->opaque
= g_new0(struct IscsiLun
, 1);
1800 iscsilun
= bs
->opaque
;
1802 bs_options
= qdict_new();
1803 qdict_put(bs_options
, "filename", qstring_from_str(filename
));
1804 ret
= iscsi_open(bs
, bs_options
, 0, NULL
);
1805 QDECREF(bs_options
);
1810 iscsi_detach_aio_context(bs
);
1811 if (iscsilun
->type
!= TYPE_DISK
) {
1815 if (bs
->total_sectors
< total_size
) {
1822 if (iscsilun
->iscsi
!= NULL
) {
1823 iscsi_destroy_context(iscsilun
->iscsi
);
1831 static int iscsi_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
)
1833 IscsiLun
*iscsilun
= bs
->opaque
;
1834 bdi
->unallocated_blocks_are_zero
= iscsilun
->lbprz
;
1835 bdi
->can_write_zeroes_with_unmap
= iscsilun
->lbprz
&& iscsilun
->lbp
.lbpws
;
1836 bdi
->cluster_size
= iscsilun
->cluster_sectors
* BDRV_SECTOR_SIZE
;
1840 static QemuOptsList iscsi_create_opts
= {
1841 .name
= "iscsi-create-opts",
1842 .head
= QTAILQ_HEAD_INITIALIZER(iscsi_create_opts
.head
),
1845 .name
= BLOCK_OPT_SIZE
,
1846 .type
= QEMU_OPT_SIZE
,
1847 .help
= "Virtual disk size"
1849 { /* end of list */ }
1853 static BlockDriver bdrv_iscsi
= {
1854 .format_name
= "iscsi",
1855 .protocol_name
= "iscsi",
1857 .instance_size
= sizeof(IscsiLun
),
1858 .bdrv_needs_filename
= true,
1859 .bdrv_file_open
= iscsi_open
,
1860 .bdrv_close
= iscsi_close
,
1861 .bdrv_create
= iscsi_create
,
1862 .create_opts
= &iscsi_create_opts
,
1863 .bdrv_reopen_prepare
= iscsi_reopen_prepare
,
1865 .bdrv_getlength
= iscsi_getlength
,
1866 .bdrv_get_info
= iscsi_get_info
,
1867 .bdrv_truncate
= iscsi_truncate
,
1868 .bdrv_refresh_limits
= iscsi_refresh_limits
,
1870 .bdrv_co_get_block_status
= iscsi_co_get_block_status
,
1871 .bdrv_co_discard
= iscsi_co_discard
,
1872 .bdrv_co_pwrite_zeroes
= iscsi_co_pwrite_zeroes
,
1873 .bdrv_co_readv
= iscsi_co_readv
,
1874 .bdrv_co_writev_flags
= iscsi_co_writev_flags
,
1875 .bdrv_co_flush_to_disk
= iscsi_co_flush
,
1878 .bdrv_aio_ioctl
= iscsi_aio_ioctl
,
1881 .bdrv_detach_aio_context
= iscsi_detach_aio_context
,
1882 .bdrv_attach_aio_context
= iscsi_attach_aio_context
,
1885 static QemuOptsList qemu_iscsi_opts
= {
1887 .head
= QTAILQ_HEAD_INITIALIZER(qemu_iscsi_opts
.head
),
1891 .type
= QEMU_OPT_STRING
,
1892 .help
= "username for CHAP authentication to target",
1895 .type
= QEMU_OPT_STRING
,
1896 .help
= "password for CHAP authentication to target",
1898 .name
= "password-secret",
1899 .type
= QEMU_OPT_STRING
,
1900 .help
= "ID of the secret providing password for CHAP "
1901 "authentication to target",
1903 .name
= "header-digest",
1904 .type
= QEMU_OPT_STRING
,
1905 .help
= "HeaderDigest setting. "
1906 "{CRC32C|CRC32C-NONE|NONE-CRC32C|NONE}",
1908 .name
= "initiator-name",
1909 .type
= QEMU_OPT_STRING
,
1910 .help
= "Initiator iqn name to use when connecting",
1913 .type
= QEMU_OPT_NUMBER
,
1914 .help
= "Request timeout in seconds (default 0 = no timeout)",
1916 { /* end of list */ }
1920 static void iscsi_block_init(void)
1922 bdrv_register(&bdrv_iscsi
);
1923 qemu_add_opts(&qemu_iscsi_opts
);
1926 block_init(iscsi_block_init
);