1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26#include "qemu/osdep.h"
27
28#include <poll.h>
29#include <math.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"
38#include "qemu/iov.h"
39#include "sysemu/sysemu.h"
40#include "qmp-commands.h"
41#include "qapi/qmp/qstring.h"
42#include "crypto/secret.h"
43
44#include <iscsi/iscsi.h>
45#include <iscsi/scsi-lowlevel.h>
46
47#ifdef __linux__
48#include <scsi/sg.h>
49#include <block/scsi.h>
50#endif
51
52typedef struct IscsiLun {
53 struct iscsi_context *iscsi;
54 AioContext *aio_context;
55 int lun;
56 enum scsi_inquiry_peripheral_device_type type;
57 int block_size;
58 uint64_t num_blocks;
59 int events;
60 QEMUTimer *nop_timer;
61 QEMUTimer *event_timer;
62 struct scsi_inquiry_logical_block_provisioning lbp;
63 struct scsi_inquiry_block_limits bl;
64 unsigned char *zeroblock;
65 unsigned long *allocationmap;
66 int cluster_sectors;
67 bool use_16_for_rw;
68 bool write_protected;
69 bool lbpme;
70 bool lbprz;
71 bool dpofua;
72 bool has_write_same;
73 bool request_timed_out;
74} IscsiLun;
75
76typedef struct IscsiTask {
77 int status;
78 int complete;
79 int retries;
80 int do_retry;
81 struct scsi_task *task;
82 Coroutine *co;
83 QEMUBH *bh;
84 IscsiLun *iscsilun;
85 QEMUTimer retry_timer;
86 int err_code;
87} IscsiTask;
88
89typedef struct IscsiAIOCB {
90 BlockAIOCB common;
91 QEMUIOVector *qiov;
92 QEMUBH *bh;
93 IscsiLun *iscsilun;
94 struct scsi_task *task;
95 uint8_t *buf;
96 int status;
97 int64_t sector_num;
98 int nb_sectors;
99 int ret;
100#ifdef __linux__
101 sg_io_hdr_t *ioh;
102#endif
103} IscsiAIOCB;
104
105
106#define EVENT_INTERVAL 1000
107#define NOP_INTERVAL 5000
108#define MAX_NOP_FAILURES 3
109#define ISCSI_CMD_RETRIES ARRAY_SIZE(iscsi_retry_times)
110static const unsigned iscsi_retry_times[] = {8, 32, 128, 512, 2048, 8192, 32768};
111
112
113
114
115
116
117
118
119#define ISCSI_CHECKALLOC_THRES 64
120
121static void
122iscsi_bh_cb(void *p)
123{
124 IscsiAIOCB *acb = p;
125
126 qemu_bh_delete(acb->bh);
127
128 g_free(acb->buf);
129 acb->buf = NULL;
130
131 acb->common.cb(acb->common.opaque, acb->status);
132
133 if (acb->task != NULL) {
134 scsi_free_scsi_task(acb->task);
135 acb->task = NULL;
136 }
137
138 qemu_aio_unref(acb);
139}
140
141static void
142iscsi_schedule_bh(IscsiAIOCB *acb)
143{
144 if (acb->bh) {
145 return;
146 }
147 acb->bh = aio_bh_new(acb->iscsilun->aio_context, iscsi_bh_cb, acb);
148 qemu_bh_schedule(acb->bh);
149}
150
151static void iscsi_co_generic_bh_cb(void *opaque)
152{
153 struct IscsiTask *iTask = opaque;
154 iTask->complete = 1;
155 qemu_bh_delete(iTask->bh);
156 qemu_coroutine_enter(iTask->co, NULL);
157}
158
159static void iscsi_retry_timer_expired(void *opaque)
160{
161 struct IscsiTask *iTask = opaque;
162 iTask->complete = 1;
163 if (iTask->co) {
164 qemu_coroutine_enter(iTask->co, NULL);
165 }
166}
167
168static inline unsigned exp_random(double mean)
169{
170 return -mean * log((double)rand() / RAND_MAX);
171}
172
173
174
175
176
177
178
179
180
181
182
183
184#if !defined(SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST) && \
185 !defined(LIBISCSI_API_VERSION)
186#define SCSI_STATUS_TASK_SET_FULL 0x28
187#define SCSI_STATUS_TIMEOUT 0x0f000002
188#define SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST 0x2600
189#define SCSI_SENSE_ASCQ_PARAMETER_LIST_LENGTH_ERROR 0x1a00
190#endif
191
192static int iscsi_translate_sense(struct scsi_sense *sense)
193{
194 int ret;
195
196 switch (sense->key) {
197 case SCSI_SENSE_NOT_READY:
198 return -EBUSY;
199 case SCSI_SENSE_DATA_PROTECTION:
200 return -EACCES;
201 case SCSI_SENSE_COMMAND_ABORTED:
202 return -ECANCELED;
203 case SCSI_SENSE_ILLEGAL_REQUEST:
204
205 break;
206 default:
207 return -EIO;
208 }
209 switch (sense->ascq) {
210 case SCSI_SENSE_ASCQ_PARAMETER_LIST_LENGTH_ERROR:
211 case SCSI_SENSE_ASCQ_INVALID_OPERATION_CODE:
212 case SCSI_SENSE_ASCQ_INVALID_FIELD_IN_CDB:
213 case SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST:
214 ret = -EINVAL;
215 break;
216 case SCSI_SENSE_ASCQ_LBA_OUT_OF_RANGE:
217 ret = -ENOSPC;
218 break;
219 case SCSI_SENSE_ASCQ_LOGICAL_UNIT_NOT_SUPPORTED:
220 ret = -ENOTSUP;
221 break;
222 case SCSI_SENSE_ASCQ_MEDIUM_NOT_PRESENT:
223 case SCSI_SENSE_ASCQ_MEDIUM_NOT_PRESENT_TRAY_CLOSED:
224 case SCSI_SENSE_ASCQ_MEDIUM_NOT_PRESENT_TRAY_OPEN:
225 ret = -ENOMEDIUM;
226 break;
227 case SCSI_SENSE_ASCQ_WRITE_PROTECTED:
228 ret = -EACCES;
229 break;
230 default:
231 ret = -EIO;
232 break;
233 }
234 return ret;
235}
236
237static void
238iscsi_co_generic_cb(struct iscsi_context *iscsi, int status,
239 void *command_data, void *opaque)
240{
241 struct IscsiTask *iTask = opaque;
242 struct scsi_task *task = command_data;
243
244 iTask->status = status;
245 iTask->do_retry = 0;
246 iTask->task = task;
247
248 if (status != SCSI_STATUS_GOOD) {
249 if (iTask->retries++ < ISCSI_CMD_RETRIES) {
250 if (status == SCSI_STATUS_CHECK_CONDITION
251 && task->sense.key == SCSI_SENSE_UNIT_ATTENTION) {
252 error_report("iSCSI CheckCondition: %s",
253 iscsi_get_error(iscsi));
254 iTask->do_retry = 1;
255 goto out;
256 }
257 if (status == SCSI_STATUS_BUSY ||
258 status == SCSI_STATUS_TIMEOUT ||
259 status == SCSI_STATUS_TASK_SET_FULL) {
260 unsigned retry_time =
261 exp_random(iscsi_retry_times[iTask->retries - 1]);
262 if (status == SCSI_STATUS_TIMEOUT) {
263
264
265 retry_time = EVENT_INTERVAL * 2;
266 iTask->iscsilun->request_timed_out = true;
267 }
268 error_report("iSCSI Busy/TaskSetFull/TimeOut"
269 " (retry #%u in %u ms): %s",
270 iTask->retries, retry_time,
271 iscsi_get_error(iscsi));
272 aio_timer_init(iTask->iscsilun->aio_context,
273 &iTask->retry_timer, QEMU_CLOCK_REALTIME,
274 SCALE_MS, iscsi_retry_timer_expired, iTask);
275 timer_mod(&iTask->retry_timer,
276 qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + retry_time);
277 iTask->do_retry = 1;
278 return;
279 }
280 }
281 iTask->err_code = iscsi_translate_sense(&task->sense);
282 error_report("iSCSI Failure: %s", iscsi_get_error(iscsi));
283 }
284
285out:
286 if (iTask->co) {
287 iTask->bh = aio_bh_new(iTask->iscsilun->aio_context,
288 iscsi_co_generic_bh_cb, iTask);
289 qemu_bh_schedule(iTask->bh);
290 } else {
291 iTask->complete = 1;
292 }
293}
294
295static void iscsi_co_init_iscsitask(IscsiLun *iscsilun, struct IscsiTask *iTask)
296{
297 *iTask = (struct IscsiTask) {
298 .co = qemu_coroutine_self(),
299 .iscsilun = iscsilun,
300 };
301}
302
303static void
304iscsi_abort_task_cb(struct iscsi_context *iscsi, int status, void *command_data,
305 void *private_data)
306{
307 IscsiAIOCB *acb = private_data;
308
309 acb->status = -ECANCELED;
310 iscsi_schedule_bh(acb);
311}
312
313static void
314iscsi_aio_cancel(BlockAIOCB *blockacb)
315{
316 IscsiAIOCB *acb = (IscsiAIOCB *)blockacb;
317 IscsiLun *iscsilun = acb->iscsilun;
318
319 if (acb->status != -EINPROGRESS) {
320 return;
321 }
322
323
324 iscsi_task_mgmt_abort_task_async(iscsilun->iscsi, acb->task,
325 iscsi_abort_task_cb, acb);
326
327}
328
329static const AIOCBInfo iscsi_aiocb_info = {
330 .aiocb_size = sizeof(IscsiAIOCB),
331 .cancel_async = iscsi_aio_cancel,
332};
333
334
335static void iscsi_process_read(void *arg);
336static void iscsi_process_write(void *arg);
337
338static void
339iscsi_set_events(IscsiLun *iscsilun)
340{
341 struct iscsi_context *iscsi = iscsilun->iscsi;
342 int ev = iscsi_which_events(iscsi);
343
344 if (ev != iscsilun->events) {
345 aio_set_fd_handler(iscsilun->aio_context, iscsi_get_fd(iscsi),
346 false,
347 (ev & POLLIN) ? iscsi_process_read : NULL,
348 (ev & POLLOUT) ? iscsi_process_write : NULL,
349 iscsilun);
350 iscsilun->events = ev;
351 }
352}
353
354static void iscsi_timed_check_events(void *opaque)
355{
356 IscsiLun *iscsilun = opaque;
357
358
359 iscsi_service(iscsilun->iscsi, 0);
360
361 if (iscsilun->request_timed_out) {
362 iscsilun->request_timed_out = false;
363 iscsi_reconnect(iscsilun->iscsi);
364 }
365
366
367
368 iscsi_set_events(iscsilun);
369
370 timer_mod(iscsilun->event_timer,
371 qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + EVENT_INTERVAL);
372}
373
374static void
375iscsi_process_read(void *arg)
376{
377 IscsiLun *iscsilun = arg;
378 struct iscsi_context *iscsi = iscsilun->iscsi;
379
380 iscsi_service(iscsi, POLLIN);
381 iscsi_set_events(iscsilun);
382}
383
384static void
385iscsi_process_write(void *arg)
386{
387 IscsiLun *iscsilun = arg;
388 struct iscsi_context *iscsi = iscsilun->iscsi;
389
390 iscsi_service(iscsi, POLLOUT);
391 iscsi_set_events(iscsilun);
392}
393
394static int64_t sector_lun2qemu(int64_t sector, IscsiLun *iscsilun)
395{
396 return sector * iscsilun->block_size / BDRV_SECTOR_SIZE;
397}
398
399static int64_t sector_qemu2lun(int64_t sector, IscsiLun *iscsilun)
400{
401 return sector * BDRV_SECTOR_SIZE / iscsilun->block_size;
402}
403
404static bool is_request_lun_aligned(int64_t sector_num, int nb_sectors,
405 IscsiLun *iscsilun)
406{
407 if ((sector_num * BDRV_SECTOR_SIZE) % iscsilun->block_size ||
408 (nb_sectors * BDRV_SECTOR_SIZE) % iscsilun->block_size) {
409 error_report("iSCSI misaligned request: "
410 "iscsilun->block_size %u, sector_num %" PRIi64
411 ", nb_sectors %d",
412 iscsilun->block_size, sector_num, nb_sectors);
413 return 0;
414 }
415 return 1;
416}
417
418static unsigned long *iscsi_allocationmap_init(IscsiLun *iscsilun)
419{
420 return bitmap_try_new(DIV_ROUND_UP(sector_lun2qemu(iscsilun->num_blocks,
421 iscsilun),
422 iscsilun->cluster_sectors));
423}
424
425static void iscsi_allocationmap_set(IscsiLun *iscsilun, int64_t sector_num,
426 int nb_sectors)
427{
428 int64_t cluster_num, nb_clusters;
429 if (iscsilun->allocationmap == NULL) {
430 return;
431 }
432 cluster_num = sector_num / iscsilun->cluster_sectors;
433 nb_clusters = DIV_ROUND_UP(sector_num + nb_sectors,
434 iscsilun->cluster_sectors) - cluster_num;
435 bitmap_set(iscsilun->allocationmap, cluster_num, nb_clusters);
436}
437
438static void iscsi_allocationmap_clear(IscsiLun *iscsilun, int64_t sector_num,
439 int nb_sectors)
440{
441 int64_t cluster_num, nb_clusters;
442 if (iscsilun->allocationmap == NULL) {
443 return;
444 }
445 cluster_num = DIV_ROUND_UP(sector_num, iscsilun->cluster_sectors);
446 nb_clusters = (sector_num + nb_sectors) / iscsilun->cluster_sectors
447 - cluster_num;
448 if (nb_clusters > 0) {
449 bitmap_clear(iscsilun->allocationmap, cluster_num, nb_clusters);
450 }
451}
452
453static int coroutine_fn
454iscsi_co_writev_flags(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
455 QEMUIOVector *iov, int flags)
456{
457 IscsiLun *iscsilun = bs->opaque;
458 struct IscsiTask iTask;
459 uint64_t lba;
460 uint32_t num_sectors;
461 bool fua;
462
463 if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
464 return -EINVAL;
465 }
466
467 if (bs->bl.max_transfer_length && nb_sectors > bs->bl.max_transfer_length) {
468 error_report("iSCSI Error: Write of %d sectors exceeds max_xfer_len "
469 "of %d sectors", nb_sectors, bs->bl.max_transfer_length);
470 return -EINVAL;
471 }
472
473 lba = sector_qemu2lun(sector_num, iscsilun);
474 num_sectors = sector_qemu2lun(nb_sectors, iscsilun);
475 iscsi_co_init_iscsitask(iscsilun, &iTask);
476retry:
477 fua = iscsilun->dpofua && (flags & BDRV_REQ_FUA);
478 if (iscsilun->use_16_for_rw) {
479 iTask.task = iscsi_write16_task(iscsilun->iscsi, iscsilun->lun, lba,
480 NULL, num_sectors * iscsilun->block_size,
481 iscsilun->block_size, 0, 0, fua, 0, 0,
482 iscsi_co_generic_cb, &iTask);
483 } else {
484 iTask.task = iscsi_write10_task(iscsilun->iscsi, iscsilun->lun, lba,
485 NULL, num_sectors * iscsilun->block_size,
486 iscsilun->block_size, 0, 0, fua, 0, 0,
487 iscsi_co_generic_cb, &iTask);
488 }
489 if (iTask.task == NULL) {
490 return -ENOMEM;
491 }
492 scsi_task_set_iov_out(iTask.task, (struct scsi_iovec *) iov->iov,
493 iov->niov);
494 while (!iTask.complete) {
495 iscsi_set_events(iscsilun);
496 qemu_coroutine_yield();
497 }
498
499 if (iTask.task != NULL) {
500 scsi_free_scsi_task(iTask.task);
501 iTask.task = NULL;
502 }
503
504 if (iTask.do_retry) {
505 iTask.complete = 0;
506 goto retry;
507 }
508
509 if (iTask.status != SCSI_STATUS_GOOD) {
510 return iTask.err_code;
511 }
512
513 iscsi_allocationmap_set(iscsilun, sector_num, nb_sectors);
514
515 return 0;
516}
517
518static int coroutine_fn
519iscsi_co_writev(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
520 QEMUIOVector *iov)
521{
522 return iscsi_co_writev_flags(bs, sector_num, nb_sectors, iov, 0);
523}
524
525
526static bool iscsi_allocationmap_is_allocated(IscsiLun *iscsilun,
527 int64_t sector_num, int nb_sectors)
528{
529 unsigned long size;
530 if (iscsilun->allocationmap == NULL) {
531 return true;
532 }
533 size = DIV_ROUND_UP(sector_num + nb_sectors, iscsilun->cluster_sectors);
534 return !(find_next_bit(iscsilun->allocationmap, size,
535 sector_num / iscsilun->cluster_sectors) == size);
536}
537
538static int64_t coroutine_fn iscsi_co_get_block_status(BlockDriverState *bs,
539 int64_t sector_num,
540 int nb_sectors, int *pnum,
541 BlockDriverState **file)
542{
543 IscsiLun *iscsilun = bs->opaque;
544 struct scsi_get_lba_status *lbas = NULL;
545 struct scsi_lba_status_descriptor *lbasd = NULL;
546 struct IscsiTask iTask;
547 int64_t ret;
548
549 iscsi_co_init_iscsitask(iscsilun, &iTask);
550
551 if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
552 ret = -EINVAL;
553 goto out;
554 }
555
556
557 ret = BDRV_BLOCK_DATA;
558 ret |= (sector_num << BDRV_SECTOR_BITS) | BDRV_BLOCK_OFFSET_VALID;
559 *pnum = nb_sectors;
560
561
562 if (!iscsilun->lbpme) {
563 goto out;
564 }
565
566retry:
567 if (iscsi_get_lba_status_task(iscsilun->iscsi, iscsilun->lun,
568 sector_qemu2lun(sector_num, iscsilun),
569 8 + 16, iscsi_co_generic_cb,
570 &iTask) == NULL) {
571 ret = -ENOMEM;
572 goto out;
573 }
574
575 while (!iTask.complete) {
576 iscsi_set_events(iscsilun);
577 qemu_coroutine_yield();
578 }
579
580 if (iTask.do_retry) {
581 if (iTask.task != NULL) {
582 scsi_free_scsi_task(iTask.task);
583 iTask.task = NULL;
584 }
585 iTask.complete = 0;
586 goto retry;
587 }
588
589 if (iTask.status != SCSI_STATUS_GOOD) {
590
591
592
593
594 goto out;
595 }
596
597 lbas = scsi_datain_unmarshall(iTask.task);
598 if (lbas == NULL) {
599 ret = -EIO;
600 goto out;
601 }
602
603 lbasd = &lbas->descriptors[0];
604
605 if (sector_qemu2lun(sector_num, iscsilun) != lbasd->lba) {
606 ret = -EIO;
607 goto out;
608 }
609
610 *pnum = sector_lun2qemu(lbasd->num_blocks, iscsilun);
611
612 if (lbasd->provisioning == SCSI_PROVISIONING_TYPE_DEALLOCATED ||
613 lbasd->provisioning == SCSI_PROVISIONING_TYPE_ANCHORED) {
614 ret &= ~BDRV_BLOCK_DATA;
615 if (iscsilun->lbprz) {
616 ret |= BDRV_BLOCK_ZERO;
617 }
618 }
619
620 if (ret & BDRV_BLOCK_ZERO) {
621 iscsi_allocationmap_clear(iscsilun, sector_num, *pnum);
622 } else {
623 iscsi_allocationmap_set(iscsilun, sector_num, *pnum);
624 }
625
626 if (*pnum > nb_sectors) {
627 *pnum = nb_sectors;
628 }
629out:
630 if (iTask.task != NULL) {
631 scsi_free_scsi_task(iTask.task);
632 }
633 if (ret > 0 && ret & BDRV_BLOCK_OFFSET_VALID) {
634 *file = bs;
635 }
636 return ret;
637}
638
639static int coroutine_fn iscsi_co_readv(BlockDriverState *bs,
640 int64_t sector_num, int nb_sectors,
641 QEMUIOVector *iov)
642{
643 IscsiLun *iscsilun = bs->opaque;
644 struct IscsiTask iTask;
645 uint64_t lba;
646 uint32_t num_sectors;
647
648 if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
649 return -EINVAL;
650 }
651
652 if (bs->bl.max_transfer_length && nb_sectors > bs->bl.max_transfer_length) {
653 error_report("iSCSI Error: Read of %d sectors exceeds max_xfer_len "
654 "of %d sectors", nb_sectors, bs->bl.max_transfer_length);
655 return -EINVAL;
656 }
657
658 if (iscsilun->lbprz && nb_sectors >= ISCSI_CHECKALLOC_THRES &&
659 !iscsi_allocationmap_is_allocated(iscsilun, sector_num, nb_sectors)) {
660 int64_t ret;
661 int pnum;
662 BlockDriverState *file;
663 ret = iscsi_co_get_block_status(bs, sector_num, INT_MAX, &pnum, &file);
664 if (ret < 0) {
665 return ret;
666 }
667 if (ret & BDRV_BLOCK_ZERO && pnum >= nb_sectors) {
668 qemu_iovec_memset(iov, 0, 0x00, iov->size);
669 return 0;
670 }
671 }
672
673 lba = sector_qemu2lun(sector_num, iscsilun);
674 num_sectors = sector_qemu2lun(nb_sectors, iscsilun);
675
676 iscsi_co_init_iscsitask(iscsilun, &iTask);
677retry:
678 if (iscsilun->use_16_for_rw) {
679 iTask.task = iscsi_read16_task(iscsilun->iscsi, iscsilun->lun, lba,
680 num_sectors * iscsilun->block_size,
681 iscsilun->block_size, 0, 0, 0, 0, 0,
682 iscsi_co_generic_cb, &iTask);
683 } else {
684 iTask.task = iscsi_read10_task(iscsilun->iscsi, iscsilun->lun, lba,
685 num_sectors * iscsilun->block_size,
686 iscsilun->block_size,
687 0, 0, 0, 0, 0,
688 iscsi_co_generic_cb, &iTask);
689 }
690 if (iTask.task == NULL) {
691 return -ENOMEM;
692 }
693 scsi_task_set_iov_in(iTask.task, (struct scsi_iovec *) iov->iov, iov->niov);
694
695 while (!iTask.complete) {
696 iscsi_set_events(iscsilun);
697 qemu_coroutine_yield();
698 }
699
700 if (iTask.task != NULL) {
701 scsi_free_scsi_task(iTask.task);
702 iTask.task = NULL;
703 }
704
705 if (iTask.do_retry) {
706 iTask.complete = 0;
707 goto retry;
708 }
709
710 if (iTask.status != SCSI_STATUS_GOOD) {
711 return iTask.err_code;
712 }
713
714 return 0;
715}
716
717static int coroutine_fn iscsi_co_flush(BlockDriverState *bs)
718{
719 IscsiLun *iscsilun = bs->opaque;
720 struct IscsiTask iTask;
721
722 iscsi_co_init_iscsitask(iscsilun, &iTask);
723retry:
724 if (iscsi_synchronizecache10_task(iscsilun->iscsi, iscsilun->lun, 0, 0, 0,
725 0, iscsi_co_generic_cb, &iTask) == NULL) {
726 return -ENOMEM;
727 }
728
729 while (!iTask.complete) {
730 iscsi_set_events(iscsilun);
731 qemu_coroutine_yield();
732 }
733
734 if (iTask.task != NULL) {
735 scsi_free_scsi_task(iTask.task);
736 iTask.task = NULL;
737 }
738
739 if (iTask.do_retry) {
740 iTask.complete = 0;
741 goto retry;
742 }
743
744 if (iTask.status != SCSI_STATUS_GOOD) {
745 return iTask.err_code;
746 }
747
748 return 0;
749}
750
751#ifdef __linux__
752static void
753iscsi_aio_ioctl_cb(struct iscsi_context *iscsi, int status,
754 void *command_data, void *opaque)
755{
756 IscsiAIOCB *acb = opaque;
757
758 g_free(acb->buf);
759 acb->buf = NULL;
760
761 acb->status = 0;
762 if (status < 0) {
763 error_report("Failed to ioctl(SG_IO) to iSCSI lun. %s",
764 iscsi_get_error(iscsi));
765 acb->status = iscsi_translate_sense(&acb->task->sense);
766 }
767
768 acb->ioh->driver_status = 0;
769 acb->ioh->host_status = 0;
770 acb->ioh->resid = 0;
771
772#define SG_ERR_DRIVER_SENSE 0x08
773
774 if (status == SCSI_STATUS_CHECK_CONDITION && acb->task->datain.size >= 2) {
775 int ss;
776
777 acb->ioh->driver_status |= SG_ERR_DRIVER_SENSE;
778
779 acb->ioh->sb_len_wr = acb->task->datain.size - 2;
780 ss = (acb->ioh->mx_sb_len >= acb->ioh->sb_len_wr) ?
781 acb->ioh->mx_sb_len : acb->ioh->sb_len_wr;
782 memcpy(acb->ioh->sbp, &acb->task->datain.data[2], ss);
783 }
784
785 iscsi_schedule_bh(acb);
786}
787
788static void iscsi_ioctl_bh_completion(void *opaque)
789{
790 IscsiAIOCB *acb = opaque;
791
792 qemu_bh_delete(acb->bh);
793 acb->common.cb(acb->common.opaque, acb->ret);
794 qemu_aio_unref(acb);
795}
796
797static void iscsi_ioctl_handle_emulated(IscsiAIOCB *acb, int req, void *buf)
798{
799 BlockDriverState *bs = acb->common.bs;
800 IscsiLun *iscsilun = bs->opaque;
801 int ret = 0;
802
803 switch (req) {
804 case SG_GET_VERSION_NUM:
805 *(int *)buf = 30000;
806 break;
807 case SG_GET_SCSI_ID:
808 ((struct sg_scsi_id *)buf)->scsi_type = iscsilun->type;
809 break;
810 default:
811 ret = -EINVAL;
812 }
813 assert(!acb->bh);
814 acb->bh = aio_bh_new(bdrv_get_aio_context(bs),
815 iscsi_ioctl_bh_completion, acb);
816 acb->ret = ret;
817 qemu_bh_schedule(acb->bh);
818}
819
820static BlockAIOCB *iscsi_aio_ioctl(BlockDriverState *bs,
821 unsigned long int req, void *buf,
822 BlockCompletionFunc *cb, void *opaque)
823{
824 IscsiLun *iscsilun = bs->opaque;
825 struct iscsi_context *iscsi = iscsilun->iscsi;
826 struct iscsi_data data;
827 IscsiAIOCB *acb;
828
829 acb = qemu_aio_get(&iscsi_aiocb_info, bs, cb, opaque);
830
831 acb->iscsilun = iscsilun;
832 acb->bh = NULL;
833 acb->status = -EINPROGRESS;
834 acb->buf = NULL;
835 acb->ioh = buf;
836
837 if (req != SG_IO) {
838 iscsi_ioctl_handle_emulated(acb, req, buf);
839 return &acb->common;
840 }
841
842 if (acb->ioh->cmd_len > SCSI_CDB_MAX_SIZE) {
843 error_report("iSCSI: ioctl error CDB exceeds max size (%d > %d)",
844 acb->ioh->cmd_len, SCSI_CDB_MAX_SIZE);
845 qemu_aio_unref(acb);
846 return NULL;
847 }
848
849 acb->task = malloc(sizeof(struct scsi_task));
850 if (acb->task == NULL) {
851 error_report("iSCSI: Failed to allocate task for scsi command. %s",
852 iscsi_get_error(iscsi));
853 qemu_aio_unref(acb);
854 return NULL;
855 }
856 memset(acb->task, 0, sizeof(struct scsi_task));
857
858 switch (acb->ioh->dxfer_direction) {
859 case SG_DXFER_TO_DEV:
860 acb->task->xfer_dir = SCSI_XFER_WRITE;
861 break;
862 case SG_DXFER_FROM_DEV:
863 acb->task->xfer_dir = SCSI_XFER_READ;
864 break;
865 default:
866 acb->task->xfer_dir = SCSI_XFER_NONE;
867 break;
868 }
869
870 acb->task->cdb_size = acb->ioh->cmd_len;
871 memcpy(&acb->task->cdb[0], acb->ioh->cmdp, acb->ioh->cmd_len);
872 acb->task->expxferlen = acb->ioh->dxfer_len;
873
874 data.size = 0;
875 if (acb->task->xfer_dir == SCSI_XFER_WRITE) {
876 if (acb->ioh->iovec_count == 0) {
877 data.data = acb->ioh->dxferp;
878 data.size = acb->ioh->dxfer_len;
879 } else {
880 scsi_task_set_iov_out(acb->task,
881 (struct scsi_iovec *) acb->ioh->dxferp,
882 acb->ioh->iovec_count);
883 }
884 }
885
886 if (iscsi_scsi_command_async(iscsi, iscsilun->lun, acb->task,
887 iscsi_aio_ioctl_cb,
888 (data.size > 0) ? &data : NULL,
889 acb) != 0) {
890 scsi_free_scsi_task(acb->task);
891 qemu_aio_unref(acb);
892 return NULL;
893 }
894
895
896 if (acb->task->xfer_dir == SCSI_XFER_READ) {
897 if (acb->ioh->iovec_count == 0) {
898 scsi_task_add_data_in_buffer(acb->task,
899 acb->ioh->dxfer_len,
900 acb->ioh->dxferp);
901 } else {
902 scsi_task_set_iov_in(acb->task,
903 (struct scsi_iovec *) acb->ioh->dxferp,
904 acb->ioh->iovec_count);
905 }
906 }
907
908 iscsi_set_events(iscsilun);
909
910 return &acb->common;
911}
912
913#endif
914
915static int64_t
916iscsi_getlength(BlockDriverState *bs)
917{
918 IscsiLun *iscsilun = bs->opaque;
919 int64_t len;
920
921 len = iscsilun->num_blocks;
922 len *= iscsilun->block_size;
923
924 return len;
925}
926
927static int
928coroutine_fn iscsi_co_discard(BlockDriverState *bs, int64_t sector_num,
929 int nb_sectors)
930{
931 IscsiLun *iscsilun = bs->opaque;
932 struct IscsiTask iTask;
933 struct unmap_list list;
934
935 if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
936 return -EINVAL;
937 }
938
939 if (!iscsilun->lbp.lbpu) {
940
941 return 0;
942 }
943
944 list.lba = sector_qemu2lun(sector_num, iscsilun);
945 list.num = sector_qemu2lun(nb_sectors, iscsilun);
946
947 iscsi_co_init_iscsitask(iscsilun, &iTask);
948retry:
949 if (iscsi_unmap_task(iscsilun->iscsi, iscsilun->lun, 0, 0, &list, 1,
950 iscsi_co_generic_cb, &iTask) == NULL) {
951 return -ENOMEM;
952 }
953
954 while (!iTask.complete) {
955 iscsi_set_events(iscsilun);
956 qemu_coroutine_yield();
957 }
958
959 if (iTask.task != NULL) {
960 scsi_free_scsi_task(iTask.task);
961 iTask.task = NULL;
962 }
963
964 if (iTask.do_retry) {
965 iTask.complete = 0;
966 goto retry;
967 }
968
969 if (iTask.status == SCSI_STATUS_CHECK_CONDITION) {
970
971
972
973 return 0;
974 }
975
976 if (iTask.status != SCSI_STATUS_GOOD) {
977 return iTask.err_code;
978 }
979
980 iscsi_allocationmap_clear(iscsilun, sector_num, nb_sectors);
981
982 return 0;
983}
984
985static int
986coroutine_fn iscsi_co_write_zeroes(BlockDriverState *bs, int64_t sector_num,
987 int nb_sectors, BdrvRequestFlags flags)
988{
989 IscsiLun *iscsilun = bs->opaque;
990 struct IscsiTask iTask;
991 uint64_t lba;
992 uint32_t nb_blocks;
993 bool use_16_for_ws = iscsilun->use_16_for_rw;
994
995 if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
996 return -EINVAL;
997 }
998
999 if (flags & BDRV_REQ_MAY_UNMAP) {
1000 if (!use_16_for_ws && !iscsilun->lbp.lbpws10) {
1001
1002 use_16_for_ws = true;
1003 }
1004 if (use_16_for_ws && !iscsilun->lbp.lbpws) {
1005
1006
1007 flags &= ~BDRV_REQ_MAY_UNMAP;
1008 use_16_for_ws = iscsilun->use_16_for_rw;
1009 }
1010 }
1011
1012 if (!(flags & BDRV_REQ_MAY_UNMAP) && !iscsilun->has_write_same) {
1013
1014 return -ENOTSUP;
1015 }
1016
1017 lba = sector_qemu2lun(sector_num, iscsilun);
1018 nb_blocks = sector_qemu2lun(nb_sectors, iscsilun);
1019
1020 if (iscsilun->zeroblock == NULL) {
1021 iscsilun->zeroblock = g_try_malloc0(iscsilun->block_size);
1022 if (iscsilun->zeroblock == NULL) {
1023 return -ENOMEM;
1024 }
1025 }
1026
1027 iscsi_co_init_iscsitask(iscsilun, &iTask);
1028retry:
1029 if (use_16_for_ws) {
1030 iTask.task = iscsi_writesame16_task(iscsilun->iscsi, iscsilun->lun, lba,
1031 iscsilun->zeroblock, iscsilun->block_size,
1032 nb_blocks, 0, !!(flags & BDRV_REQ_MAY_UNMAP),
1033 0, 0, iscsi_co_generic_cb, &iTask);
1034 } else {
1035 iTask.task = iscsi_writesame10_task(iscsilun->iscsi, iscsilun->lun, lba,
1036 iscsilun->zeroblock, iscsilun->block_size,
1037 nb_blocks, 0, !!(flags & BDRV_REQ_MAY_UNMAP),
1038 0, 0, iscsi_co_generic_cb, &iTask);
1039 }
1040 if (iTask.task == NULL) {
1041 return -ENOMEM;
1042 }
1043
1044 while (!iTask.complete) {
1045 iscsi_set_events(iscsilun);
1046 qemu_coroutine_yield();
1047 }
1048
1049 if (iTask.status == SCSI_STATUS_CHECK_CONDITION &&
1050 iTask.task->sense.key == SCSI_SENSE_ILLEGAL_REQUEST &&
1051 (iTask.task->sense.ascq == SCSI_SENSE_ASCQ_INVALID_OPERATION_CODE ||
1052 iTask.task->sense.ascq == SCSI_SENSE_ASCQ_INVALID_FIELD_IN_CDB)) {
1053
1054 iscsilun->has_write_same = false;
1055 scsi_free_scsi_task(iTask.task);
1056 return -ENOTSUP;
1057 }
1058
1059 if (iTask.task != NULL) {
1060 scsi_free_scsi_task(iTask.task);
1061 iTask.task = NULL;
1062 }
1063
1064 if (iTask.do_retry) {
1065 iTask.complete = 0;
1066 goto retry;
1067 }
1068
1069 if (iTask.status != SCSI_STATUS_GOOD) {
1070 return iTask.err_code;
1071 }
1072
1073 if (flags & BDRV_REQ_MAY_UNMAP) {
1074 iscsi_allocationmap_clear(iscsilun, sector_num, nb_sectors);
1075 } else {
1076 iscsi_allocationmap_set(iscsilun, sector_num, nb_sectors);
1077 }
1078
1079 return 0;
1080}
1081
1082static void parse_chap(struct iscsi_context *iscsi, const char *target,
1083 Error **errp)
1084{
1085 QemuOptsList *list;
1086 QemuOpts *opts;
1087 const char *user = NULL;
1088 const char *password = NULL;
1089 const char *secretid;
1090 char *secret = NULL;
1091
1092 list = qemu_find_opts("iscsi");
1093 if (!list) {
1094 return;
1095 }
1096
1097 opts = qemu_opts_find(list, target);
1098 if (opts == NULL) {
1099 opts = QTAILQ_FIRST(&list->head);
1100 if (!opts) {
1101 return;
1102 }
1103 }
1104
1105 user = qemu_opt_get(opts, "user");
1106 if (!user) {
1107 return;
1108 }
1109
1110 secretid = qemu_opt_get(opts, "password-secret");
1111 password = qemu_opt_get(opts, "password");
1112 if (secretid && password) {
1113 error_setg(errp, "'password' and 'password-secret' properties are "
1114 "mutually exclusive");
1115 return;
1116 }
1117 if (secretid) {
1118 secret = qcrypto_secret_lookup_as_utf8(secretid, errp);
1119 if (!secret) {
1120 return;
1121 }
1122 password = secret;
1123 } else if (!password) {
1124 error_setg(errp, "CHAP username specified but no password was given");
1125 return;
1126 }
1127
1128 if (iscsi_set_initiator_username_pwd(iscsi, user, password)) {
1129 error_setg(errp, "Failed to set initiator username and password");
1130 }
1131
1132 g_free(secret);
1133}
1134
1135static void parse_header_digest(struct iscsi_context *iscsi, const char *target,
1136 Error **errp)
1137{
1138 QemuOptsList *list;
1139 QemuOpts *opts;
1140 const char *digest = NULL;
1141
1142 list = qemu_find_opts("iscsi");
1143 if (!list) {
1144 return;
1145 }
1146
1147 opts = qemu_opts_find(list, target);
1148 if (opts == NULL) {
1149 opts = QTAILQ_FIRST(&list->head);
1150 if (!opts) {
1151 return;
1152 }
1153 }
1154
1155 digest = qemu_opt_get(opts, "header-digest");
1156 if (!digest) {
1157 return;
1158 }
1159
1160 if (!strcmp(digest, "CRC32C")) {
1161 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_CRC32C);
1162 } else if (!strcmp(digest, "NONE")) {
1163 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE);
1164 } else if (!strcmp(digest, "CRC32C-NONE")) {
1165 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_CRC32C_NONE);
1166 } else if (!strcmp(digest, "NONE-CRC32C")) {
1167 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE_CRC32C);
1168 } else {
1169 error_setg(errp, "Invalid header-digest setting : %s", digest);
1170 }
1171}
1172
1173static char *parse_initiator_name(const char *target)
1174{
1175 QemuOptsList *list;
1176 QemuOpts *opts;
1177 const char *name;
1178 char *iscsi_name;
1179 UuidInfo *uuid_info;
1180
1181 list = qemu_find_opts("iscsi");
1182 if (list) {
1183 opts = qemu_opts_find(list, target);
1184 if (!opts) {
1185 opts = QTAILQ_FIRST(&list->head);
1186 }
1187 if (opts) {
1188 name = qemu_opt_get(opts, "initiator-name");
1189 if (name) {
1190 return g_strdup(name);
1191 }
1192 }
1193 }
1194
1195 uuid_info = qmp_query_uuid(NULL);
1196 if (strcmp(uuid_info->UUID, UUID_NONE) == 0) {
1197 name = qemu_get_vm_name();
1198 } else {
1199 name = uuid_info->UUID;
1200 }
1201 iscsi_name = g_strdup_printf("iqn.2008-11.org.linux-kvm%s%s",
1202 name ? ":" : "", name ? name : "");
1203 qapi_free_UuidInfo(uuid_info);
1204 return iscsi_name;
1205}
1206
1207static int parse_timeout(const char *target)
1208{
1209 QemuOptsList *list;
1210 QemuOpts *opts;
1211 const char *timeout;
1212
1213 list = qemu_find_opts("iscsi");
1214 if (list) {
1215 opts = qemu_opts_find(list, target);
1216 if (!opts) {
1217 opts = QTAILQ_FIRST(&list->head);
1218 }
1219 if (opts) {
1220 timeout = qemu_opt_get(opts, "timeout");
1221 if (timeout) {
1222 return atoi(timeout);
1223 }
1224 }
1225 }
1226
1227 return 0;
1228}
1229
1230static void iscsi_nop_timed_event(void *opaque)
1231{
1232 IscsiLun *iscsilun = opaque;
1233
1234 if (iscsi_get_nops_in_flight(iscsilun->iscsi) >= MAX_NOP_FAILURES) {
1235 error_report("iSCSI: NOP timeout. Reconnecting...");
1236 iscsilun->request_timed_out = true;
1237 } else if (iscsi_nop_out_async(iscsilun->iscsi, NULL, NULL, 0, NULL) != 0) {
1238 error_report("iSCSI: failed to sent NOP-Out. Disabling NOP messages.");
1239 return;
1240 }
1241
1242 timer_mod(iscsilun->nop_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + NOP_INTERVAL);
1243 iscsi_set_events(iscsilun);
1244}
1245
1246static void iscsi_readcapacity_sync(IscsiLun *iscsilun, Error **errp)
1247{
1248 struct scsi_task *task = NULL;
1249 struct scsi_readcapacity10 *rc10 = NULL;
1250 struct scsi_readcapacity16 *rc16 = NULL;
1251 int retries = ISCSI_CMD_RETRIES;
1252
1253 do {
1254 if (task != NULL) {
1255 scsi_free_scsi_task(task);
1256 task = NULL;
1257 }
1258
1259 switch (iscsilun->type) {
1260 case TYPE_DISK:
1261 task = iscsi_readcapacity16_sync(iscsilun->iscsi, iscsilun->lun);
1262 if (task != NULL && task->status == SCSI_STATUS_GOOD) {
1263 rc16 = scsi_datain_unmarshall(task);
1264 if (rc16 == NULL) {
1265 error_setg(errp, "iSCSI: Failed to unmarshall readcapacity16 data.");
1266 } else {
1267 iscsilun->block_size = rc16->block_length;
1268 iscsilun->num_blocks = rc16->returned_lba + 1;
1269 iscsilun->lbpme = !!rc16->lbpme;
1270 iscsilun->lbprz = !!rc16->lbprz;
1271 iscsilun->use_16_for_rw = (rc16->returned_lba > 0xffffffff);
1272 }
1273 break;
1274 }
1275 if (task != NULL && task->status == SCSI_STATUS_CHECK_CONDITION
1276 && task->sense.key == SCSI_SENSE_UNIT_ATTENTION) {
1277 break;
1278 }
1279
1280 case TYPE_ROM:
1281 task = iscsi_readcapacity10_sync(iscsilun->iscsi, iscsilun->lun, 0, 0);
1282 if (task != NULL && task->status == SCSI_STATUS_GOOD) {
1283 rc10 = scsi_datain_unmarshall(task);
1284 if (rc10 == NULL) {
1285 error_setg(errp, "iSCSI: Failed to unmarshall readcapacity10 data.");
1286 } else {
1287 iscsilun->block_size = rc10->block_size;
1288 if (rc10->lba == 0) {
1289
1290 iscsilun->num_blocks = 0;
1291 } else {
1292 iscsilun->num_blocks = rc10->lba + 1;
1293 }
1294 }
1295 }
1296 break;
1297 default:
1298 return;
1299 }
1300 } while (task != NULL && task->status == SCSI_STATUS_CHECK_CONDITION
1301 && task->sense.key == SCSI_SENSE_UNIT_ATTENTION
1302 && retries-- > 0);
1303
1304 if (task == NULL || task->status != SCSI_STATUS_GOOD) {
1305 error_setg(errp, "iSCSI: failed to send readcapacity10/16 command");
1306 } else if (!iscsilun->block_size ||
1307 iscsilun->block_size % BDRV_SECTOR_SIZE) {
1308 error_setg(errp, "iSCSI: the target returned an invalid "
1309 "block size of %d.", iscsilun->block_size);
1310 }
1311 if (task) {
1312 scsi_free_scsi_task(task);
1313 }
1314}
1315
1316
1317static QemuOptsList runtime_opts = {
1318 .name = "iscsi",
1319 .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
1320 .desc = {
1321 {
1322 .name = "filename",
1323 .type = QEMU_OPT_STRING,
1324 .help = "URL to the iscsi image",
1325 },
1326 { }
1327 },
1328};
1329
1330static struct scsi_task *iscsi_do_inquiry(struct iscsi_context *iscsi, int lun,
1331 int evpd, int pc, void **inq, Error **errp)
1332{
1333 int full_size;
1334 struct scsi_task *task = NULL;
1335 task = iscsi_inquiry_sync(iscsi, lun, evpd, pc, 64);
1336 if (task == NULL || task->status != SCSI_STATUS_GOOD) {
1337 goto fail;
1338 }
1339 full_size = scsi_datain_getfullsize(task);
1340 if (full_size > task->datain.size) {
1341 scsi_free_scsi_task(task);
1342
1343
1344 task = iscsi_inquiry_sync(iscsi, lun, evpd, pc, full_size);
1345 if (task == NULL || task->status != SCSI_STATUS_GOOD) {
1346 goto fail;
1347 }
1348 }
1349
1350 *inq = scsi_datain_unmarshall(task);
1351 if (*inq == NULL) {
1352 error_setg(errp, "iSCSI: failed to unmarshall inquiry datain blob");
1353 goto fail_with_err;
1354 }
1355
1356 return task;
1357
1358fail:
1359 error_setg(errp, "iSCSI: Inquiry command failed : %s",
1360 iscsi_get_error(iscsi));
1361fail_with_err:
1362 if (task != NULL) {
1363 scsi_free_scsi_task(task);
1364 }
1365 return NULL;
1366}
1367
1368static void iscsi_detach_aio_context(BlockDriverState *bs)
1369{
1370 IscsiLun *iscsilun = bs->opaque;
1371
1372 aio_set_fd_handler(iscsilun->aio_context, iscsi_get_fd(iscsilun->iscsi),
1373 false, NULL, NULL, NULL);
1374 iscsilun->events = 0;
1375
1376 if (iscsilun->nop_timer) {
1377 timer_del(iscsilun->nop_timer);
1378 timer_free(iscsilun->nop_timer);
1379 iscsilun->nop_timer = NULL;
1380 }
1381 if (iscsilun->event_timer) {
1382 timer_del(iscsilun->event_timer);
1383 timer_free(iscsilun->event_timer);
1384 iscsilun->event_timer = NULL;
1385 }
1386}
1387
1388static void iscsi_attach_aio_context(BlockDriverState *bs,
1389 AioContext *new_context)
1390{
1391 IscsiLun *iscsilun = bs->opaque;
1392
1393 iscsilun->aio_context = new_context;
1394 iscsi_set_events(iscsilun);
1395
1396
1397 iscsilun->nop_timer = aio_timer_new(iscsilun->aio_context,
1398 QEMU_CLOCK_REALTIME, SCALE_MS,
1399 iscsi_nop_timed_event, iscsilun);
1400 timer_mod(iscsilun->nop_timer,
1401 qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + NOP_INTERVAL);
1402
1403
1404
1405 iscsilun->event_timer = aio_timer_new(iscsilun->aio_context,
1406 QEMU_CLOCK_REALTIME, SCALE_MS,
1407 iscsi_timed_check_events, iscsilun);
1408 timer_mod(iscsilun->event_timer,
1409 qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + EVENT_INTERVAL);
1410}
1411
1412static void iscsi_modesense_sync(IscsiLun *iscsilun)
1413{
1414 struct scsi_task *task;
1415 struct scsi_mode_sense *ms = NULL;
1416 iscsilun->write_protected = false;
1417 iscsilun->dpofua = false;
1418
1419 task = iscsi_modesense6_sync(iscsilun->iscsi, iscsilun->lun,
1420 1, SCSI_MODESENSE_PC_CURRENT,
1421 0x3F, 0, 255);
1422 if (task == NULL) {
1423 error_report("iSCSI: Failed to send MODE_SENSE(6) command: %s",
1424 iscsi_get_error(iscsilun->iscsi));
1425 goto out;
1426 }
1427
1428 if (task->status != SCSI_STATUS_GOOD) {
1429 error_report("iSCSI: Failed MODE_SENSE(6), LUN assumed writable");
1430 goto out;
1431 }
1432 ms = scsi_datain_unmarshall(task);
1433 if (!ms) {
1434 error_report("iSCSI: Failed to unmarshall MODE_SENSE(6) data: %s",
1435 iscsi_get_error(iscsilun->iscsi));
1436 goto out;
1437 }
1438 iscsilun->write_protected = ms->device_specific_parameter & 0x80;
1439 iscsilun->dpofua = ms->device_specific_parameter & 0x10;
1440
1441out:
1442 if (task) {
1443 scsi_free_scsi_task(task);
1444 }
1445}
1446
1447
1448
1449
1450
1451static int iscsi_open(BlockDriverState *bs, QDict *options, int flags,
1452 Error **errp)
1453{
1454 IscsiLun *iscsilun = bs->opaque;
1455 struct iscsi_context *iscsi = NULL;
1456 struct iscsi_url *iscsi_url = NULL;
1457 struct scsi_task *task = NULL;
1458 struct scsi_inquiry_standard *inq = NULL;
1459 struct scsi_inquiry_supported_pages *inq_vpd;
1460 char *initiator_name = NULL;
1461 QemuOpts *opts;
1462 Error *local_err = NULL;
1463 const char *filename;
1464 int i, ret = 0, timeout = 0;
1465
1466 opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
1467 qemu_opts_absorb_qdict(opts, options, &local_err);
1468 if (local_err) {
1469 error_propagate(errp, local_err);
1470 ret = -EINVAL;
1471 goto out;
1472 }
1473
1474 filename = qemu_opt_get(opts, "filename");
1475
1476 iscsi_url = iscsi_parse_full_url(iscsi, filename);
1477 if (iscsi_url == NULL) {
1478 error_setg(errp, "Failed to parse URL : %s", filename);
1479 ret = -EINVAL;
1480 goto out;
1481 }
1482
1483 memset(iscsilun, 0, sizeof(IscsiLun));
1484
1485 initiator_name = parse_initiator_name(iscsi_url->target);
1486
1487 iscsi = iscsi_create_context(initiator_name);
1488 if (iscsi == NULL) {
1489 error_setg(errp, "iSCSI: Failed to create iSCSI context.");
1490 ret = -ENOMEM;
1491 goto out;
1492 }
1493
1494 if (iscsi_set_targetname(iscsi, iscsi_url->target)) {
1495 error_setg(errp, "iSCSI: Failed to set target name.");
1496 ret = -EINVAL;
1497 goto out;
1498 }
1499
1500 if (iscsi_url->user[0] != '\0') {
1501 ret = iscsi_set_initiator_username_pwd(iscsi, iscsi_url->user,
1502 iscsi_url->passwd);
1503 if (ret != 0) {
1504 error_setg(errp, "Failed to set initiator username and password");
1505 ret = -EINVAL;
1506 goto out;
1507 }
1508 }
1509
1510
1511 parse_chap(iscsi, iscsi_url->target, &local_err);
1512 if (local_err != NULL) {
1513 error_propagate(errp, local_err);
1514 ret = -EINVAL;
1515 goto out;
1516 }
1517
1518 if (iscsi_set_session_type(iscsi, ISCSI_SESSION_NORMAL) != 0) {
1519 error_setg(errp, "iSCSI: Failed to set session type to normal.");
1520 ret = -EINVAL;
1521 goto out;
1522 }
1523
1524 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE_CRC32C);
1525
1526
1527 parse_header_digest(iscsi, iscsi_url->target, &local_err);
1528 if (local_err != NULL) {
1529 error_propagate(errp, local_err);
1530 ret = -EINVAL;
1531 goto out;
1532 }
1533
1534
1535 timeout = parse_timeout(iscsi_url->target);
1536#if defined(LIBISCSI_API_VERSION) && LIBISCSI_API_VERSION >= 20150621
1537 iscsi_set_timeout(iscsi, timeout);
1538#else
1539 if (timeout) {
1540 error_report("iSCSI: ignoring timeout value for libiscsi <1.15.0");
1541 }
1542#endif
1543
1544 if (iscsi_full_connect_sync(iscsi, iscsi_url->portal, iscsi_url->lun) != 0) {
1545 error_setg(errp, "iSCSI: Failed to connect to LUN : %s",
1546 iscsi_get_error(iscsi));
1547 ret = -EINVAL;
1548 goto out;
1549 }
1550
1551 iscsilun->iscsi = iscsi;
1552 iscsilun->aio_context = bdrv_get_aio_context(bs);
1553 iscsilun->lun = iscsi_url->lun;
1554 iscsilun->has_write_same = true;
1555
1556 task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 0, 0,
1557 (void **) &inq, errp);
1558 if (task == NULL) {
1559 ret = -EINVAL;
1560 goto out;
1561 }
1562 iscsilun->type = inq->periperal_device_type;
1563 scsi_free_scsi_task(task);
1564 task = NULL;
1565
1566 iscsi_modesense_sync(iscsilun);
1567
1568
1569 if (iscsilun->type == TYPE_DISK && (flags & BDRV_O_RDWR) &&
1570 iscsilun->write_protected) {
1571 error_setg(errp, "Cannot open a write protected LUN as read-write");
1572 ret = -EACCES;
1573 goto out;
1574 }
1575
1576 iscsi_readcapacity_sync(iscsilun, &local_err);
1577 if (local_err != NULL) {
1578 error_propagate(errp, local_err);
1579 ret = -EINVAL;
1580 goto out;
1581 }
1582 bs->total_sectors = sector_lun2qemu(iscsilun->num_blocks, iscsilun);
1583 bs->request_alignment = iscsilun->block_size;
1584
1585
1586
1587
1588
1589 if (iscsilun->type != TYPE_DISK && iscsilun->type != TYPE_ROM) {
1590 bs->sg = 1;
1591 }
1592
1593 task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
1594 SCSI_INQUIRY_PAGECODE_SUPPORTED_VPD_PAGES,
1595 (void **) &inq_vpd, errp);
1596 if (task == NULL) {
1597 ret = -EINVAL;
1598 goto out;
1599 }
1600 for (i = 0; i < inq_vpd->num_pages; i++) {
1601 struct scsi_task *inq_task;
1602 struct scsi_inquiry_logical_block_provisioning *inq_lbp;
1603 struct scsi_inquiry_block_limits *inq_bl;
1604 switch (inq_vpd->pages[i]) {
1605 case SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING:
1606 inq_task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
1607 SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING,
1608 (void **) &inq_lbp, errp);
1609 if (inq_task == NULL) {
1610 ret = -EINVAL;
1611 goto out;
1612 }
1613 memcpy(&iscsilun->lbp, inq_lbp,
1614 sizeof(struct scsi_inquiry_logical_block_provisioning));
1615 scsi_free_scsi_task(inq_task);
1616 break;
1617 case SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS:
1618 inq_task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
1619 SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS,
1620 (void **) &inq_bl, errp);
1621 if (inq_task == NULL) {
1622 ret = -EINVAL;
1623 goto out;
1624 }
1625 memcpy(&iscsilun->bl, inq_bl,
1626 sizeof(struct scsi_inquiry_block_limits));
1627 scsi_free_scsi_task(inq_task);
1628 break;
1629 default:
1630 break;
1631 }
1632 }
1633 scsi_free_scsi_task(task);
1634 task = NULL;
1635
1636 iscsi_attach_aio_context(bs, iscsilun->aio_context);
1637
1638
1639
1640
1641 if (iscsilun->bl.opt_unmap_gran * iscsilun->block_size >= 4 * 1024 &&
1642 iscsilun->bl.opt_unmap_gran * iscsilun->block_size <= 16 * 1024 * 1024) {
1643 iscsilun->cluster_sectors = (iscsilun->bl.opt_unmap_gran *
1644 iscsilun->block_size) >> BDRV_SECTOR_BITS;
1645 if (iscsilun->lbprz) {
1646 iscsilun->allocationmap = iscsi_allocationmap_init(iscsilun);
1647 if (iscsilun->allocationmap == NULL) {
1648 ret = -ENOMEM;
1649 }
1650 }
1651 }
1652
1653out:
1654 qemu_opts_del(opts);
1655 g_free(initiator_name);
1656 if (iscsi_url != NULL) {
1657 iscsi_destroy_url(iscsi_url);
1658 }
1659 if (task != NULL) {
1660 scsi_free_scsi_task(task);
1661 }
1662
1663 if (ret) {
1664 if (iscsi != NULL) {
1665 if (iscsi_is_logged_in(iscsi)) {
1666 iscsi_logout_sync(iscsi);
1667 }
1668 iscsi_destroy_context(iscsi);
1669 }
1670 memset(iscsilun, 0, sizeof(IscsiLun));
1671 }
1672 return ret;
1673}
1674
1675static void iscsi_close(BlockDriverState *bs)
1676{
1677 IscsiLun *iscsilun = bs->opaque;
1678 struct iscsi_context *iscsi = iscsilun->iscsi;
1679
1680 iscsi_detach_aio_context(bs);
1681 if (iscsi_is_logged_in(iscsi)) {
1682 iscsi_logout_sync(iscsi);
1683 }
1684 iscsi_destroy_context(iscsi);
1685 g_free(iscsilun->zeroblock);
1686 g_free(iscsilun->allocationmap);
1687 memset(iscsilun, 0, sizeof(IscsiLun));
1688}
1689
1690static int sector_limits_lun2qemu(int64_t sector, IscsiLun *iscsilun)
1691{
1692 return MIN(sector_lun2qemu(sector, iscsilun), INT_MAX / 2 + 1);
1693}
1694
1695static void iscsi_refresh_limits(BlockDriverState *bs, Error **errp)
1696{
1697
1698
1699
1700 IscsiLun *iscsilun = bs->opaque;
1701 uint32_t max_xfer_len = iscsilun->use_16_for_rw ? 0xffffffff : 0xffff;
1702
1703 if (iscsilun->bl.max_xfer_len) {
1704 max_xfer_len = MIN(max_xfer_len, iscsilun->bl.max_xfer_len);
1705 }
1706
1707 bs->bl.max_transfer_length = sector_limits_lun2qemu(max_xfer_len, iscsilun);
1708
1709 if (iscsilun->lbp.lbpu) {
1710 if (iscsilun->bl.max_unmap < 0xffffffff) {
1711 bs->bl.max_discard =
1712 sector_limits_lun2qemu(iscsilun->bl.max_unmap, iscsilun);
1713 }
1714 bs->bl.discard_alignment =
1715 sector_limits_lun2qemu(iscsilun->bl.opt_unmap_gran, iscsilun);
1716 }
1717
1718 if (iscsilun->bl.max_ws_len < 0xffffffff) {
1719 bs->bl.max_write_zeroes =
1720 sector_limits_lun2qemu(iscsilun->bl.max_ws_len, iscsilun);
1721 }
1722 if (iscsilun->lbp.lbpws) {
1723 bs->bl.write_zeroes_alignment =
1724 sector_limits_lun2qemu(iscsilun->bl.opt_unmap_gran, iscsilun);
1725 }
1726 bs->bl.opt_transfer_length =
1727 sector_limits_lun2qemu(iscsilun->bl.opt_xfer_len, iscsilun);
1728}
1729
1730
1731
1732static int iscsi_reopen_prepare(BDRVReopenState *state,
1733 BlockReopenQueue *queue, Error **errp)
1734{
1735 IscsiLun *iscsilun = state->bs->opaque;
1736
1737 if (state->flags & BDRV_O_RDWR && iscsilun->write_protected) {
1738 error_setg(errp, "Cannot open a write protected LUN as read-write");
1739 return -EACCES;
1740 }
1741 return 0;
1742}
1743
1744static int iscsi_truncate(BlockDriverState *bs, int64_t offset)
1745{
1746 IscsiLun *iscsilun = bs->opaque;
1747 Error *local_err = NULL;
1748
1749 if (iscsilun->type != TYPE_DISK) {
1750 return -ENOTSUP;
1751 }
1752
1753 iscsi_readcapacity_sync(iscsilun, &local_err);
1754 if (local_err != NULL) {
1755 error_free(local_err);
1756 return -EIO;
1757 }
1758
1759 if (offset > iscsi_getlength(bs)) {
1760 return -EINVAL;
1761 }
1762
1763 if (iscsilun->allocationmap != NULL) {
1764 g_free(iscsilun->allocationmap);
1765 iscsilun->allocationmap = iscsi_allocationmap_init(iscsilun);
1766 }
1767
1768 return 0;
1769}
1770
1771static int iscsi_create(const char *filename, QemuOpts *opts, Error **errp)
1772{
1773 int ret = 0;
1774 int64_t total_size = 0;
1775 BlockDriverState *bs;
1776 IscsiLun *iscsilun = NULL;
1777 QDict *bs_options;
1778
1779 bs = bdrv_new();
1780
1781
1782 total_size = DIV_ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
1783 BDRV_SECTOR_SIZE);
1784 bs->opaque = g_new0(struct IscsiLun, 1);
1785 iscsilun = bs->opaque;
1786
1787 bs_options = qdict_new();
1788 qdict_put(bs_options, "filename", qstring_from_str(filename));
1789 ret = iscsi_open(bs, bs_options, 0, NULL);
1790 QDECREF(bs_options);
1791
1792 if (ret != 0) {
1793 goto out;
1794 }
1795 iscsi_detach_aio_context(bs);
1796 if (iscsilun->type != TYPE_DISK) {
1797 ret = -ENODEV;
1798 goto out;
1799 }
1800 if (bs->total_sectors < total_size) {
1801 ret = -ENOSPC;
1802 goto out;
1803 }
1804
1805 ret = 0;
1806out:
1807 if (iscsilun->iscsi != NULL) {
1808 iscsi_destroy_context(iscsilun->iscsi);
1809 }
1810 g_free(bs->opaque);
1811 bs->opaque = NULL;
1812 bdrv_unref(bs);
1813 return ret;
1814}
1815
1816static int iscsi_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
1817{
1818 IscsiLun *iscsilun = bs->opaque;
1819 bdi->unallocated_blocks_are_zero = iscsilun->lbprz;
1820 bdi->can_write_zeroes_with_unmap = iscsilun->lbprz && iscsilun->lbp.lbpws;
1821 bdi->cluster_size = iscsilun->cluster_sectors * BDRV_SECTOR_SIZE;
1822 return 0;
1823}
1824
1825static QemuOptsList iscsi_create_opts = {
1826 .name = "iscsi-create-opts",
1827 .head = QTAILQ_HEAD_INITIALIZER(iscsi_create_opts.head),
1828 .desc = {
1829 {
1830 .name = BLOCK_OPT_SIZE,
1831 .type = QEMU_OPT_SIZE,
1832 .help = "Virtual disk size"
1833 },
1834 { }
1835 }
1836};
1837
1838static BlockDriver bdrv_iscsi = {
1839 .format_name = "iscsi",
1840 .protocol_name = "iscsi",
1841
1842 .instance_size = sizeof(IscsiLun),
1843 .bdrv_needs_filename = true,
1844 .bdrv_file_open = iscsi_open,
1845 .bdrv_close = iscsi_close,
1846 .bdrv_create = iscsi_create,
1847 .create_opts = &iscsi_create_opts,
1848 .bdrv_reopen_prepare = iscsi_reopen_prepare,
1849
1850 .bdrv_getlength = iscsi_getlength,
1851 .bdrv_get_info = iscsi_get_info,
1852 .bdrv_truncate = iscsi_truncate,
1853 .bdrv_refresh_limits = iscsi_refresh_limits,
1854
1855 .bdrv_co_get_block_status = iscsi_co_get_block_status,
1856 .bdrv_co_discard = iscsi_co_discard,
1857 .bdrv_co_write_zeroes = iscsi_co_write_zeroes,
1858 .bdrv_co_readv = iscsi_co_readv,
1859 .bdrv_co_writev = iscsi_co_writev,
1860 .bdrv_co_writev_flags = iscsi_co_writev_flags,
1861 .supported_write_flags = BDRV_REQ_FUA,
1862 .bdrv_co_flush_to_disk = iscsi_co_flush,
1863
1864#ifdef __linux__
1865 .bdrv_aio_ioctl = iscsi_aio_ioctl,
1866#endif
1867
1868 .bdrv_detach_aio_context = iscsi_detach_aio_context,
1869 .bdrv_attach_aio_context = iscsi_attach_aio_context,
1870};
1871
1872static QemuOptsList qemu_iscsi_opts = {
1873 .name = "iscsi",
1874 .head = QTAILQ_HEAD_INITIALIZER(qemu_iscsi_opts.head),
1875 .desc = {
1876 {
1877 .name = "user",
1878 .type = QEMU_OPT_STRING,
1879 .help = "username for CHAP authentication to target",
1880 },{
1881 .name = "password",
1882 .type = QEMU_OPT_STRING,
1883 .help = "password for CHAP authentication to target",
1884 },{
1885 .name = "password-secret",
1886 .type = QEMU_OPT_STRING,
1887 .help = "ID of the secret providing password for CHAP "
1888 "authentication to target",
1889 },{
1890 .name = "header-digest",
1891 .type = QEMU_OPT_STRING,
1892 .help = "HeaderDigest setting. "
1893 "{CRC32C|CRC32C-NONE|NONE-CRC32C|NONE}",
1894 },{
1895 .name = "initiator-name",
1896 .type = QEMU_OPT_STRING,
1897 .help = "Initiator iqn name to use when connecting",
1898 },{
1899 .name = "timeout",
1900 .type = QEMU_OPT_NUMBER,
1901 .help = "Request timeout in seconds (default 0 = no timeout)",
1902 },
1903 { }
1904 },
1905};
1906
1907static void iscsi_block_init(void)
1908{
1909 bdrv_register(&bdrv_iscsi);
1910 qemu_add_opts(&qemu_iscsi_opts);
1911}
1912
1913block_init(iscsi_block_init);
1914
