?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
block: Introduce bdrv_driver_pwritev()
[qemu/ar7.git] / block / iscsi.c
blob4f7520463e45d7b520dad33c17cc7853bea0e6fd
1 /*
2 * QEMU Block driver for iSCSI images
3 *
4 * Copyright (c) 2010-2011 Ronnie Sahlberg <ronniesahlberg@gmail.com>
5 * Copyright (c) 2012-2015 Peter Lieven <pl@kamp.de>
6 *
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:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
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
23 * THE SOFTWARE.
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
52 typedef 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
76 typedef 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
89 typedef 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 /* libiscsi uses time_t so its enough to process events every second */
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)
110 static const unsigned iscsi_retry_times[] = {8, 32, 128, 512, 2048, 8192, 32768};
111
112 /* this threshold is a trade-off knob to choose between
113 * the potential additional overhead of an extra GET_LBA_STATUS request
114 * vs. unnecessarily reading a lot of zero sectors over the wire.
115 * If a read request is greater or equal than ISCSI_CHECKALLOC_THRES
116 * sectors we check the allocation status of the area covered by the
117 * request first if the allocationmap indicates that the area might be
118 * unallocated. */
119 #define ISCSI_CHECKALLOC_THRES 64
120
121 static void
122 iscsi_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
141 static void
142 iscsi_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
151 static 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
159 static 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
168 static inline unsigned exp_random(double mean)
169 {
170 return -mean * log((double)rand() / RAND_MAX);
171 }
172
173 /* SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST was introduced in
174 * libiscsi 1.10.0, together with other constants we need. Use it as
175 * a hint that we have to define them ourselves if needed, to keep the
176 * minimum required libiscsi version at 1.9.0. We use an ASCQ macro for
177 * the test because SCSI_STATUS_* is an enum.
178 *
179 * To guard against future changes where SCSI_SENSE_ASCQ_* also becomes
180 * an enum, check against the LIBISCSI_API_VERSION macro, which was
181 * introduced in 1.11.0. If it is present, there is no need to define
182 * anything.
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
192 static 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 /* Parse ASCQ */
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
237 static void
238 iscsi_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 /* make sure the request is rescheduled AFTER the
264 * reconnect is initiated */
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
285 out:
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
295 static 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
303 static void
304 iscsi_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
313 static void
314 iscsi_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 /* send a task mgmt call to the target to cancel the task on the target */
324 iscsi_task_mgmt_abort_task_async(iscsilun->iscsi, acb->task,
325 iscsi_abort_task_cb, acb);
326
327 }
328
329 static const AIOCBInfo iscsi_aiocb_info = {
330 .aiocb_size = sizeof(IscsiAIOCB),
331 .cancel_async = iscsi_aio_cancel,
332 };
333
334
335 static void iscsi_process_read(void *arg);
336 static void iscsi_process_write(void *arg);
337
338 static void
339 iscsi_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
354 static void iscsi_timed_check_events(void *opaque)
355 {
356 IscsiLun *iscsilun = opaque;
357
358 /* check for timed out requests */
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 /* newer versions of libiscsi may return zero events. Ensure we are able
367 * to return to service once this situation changes. */
368 iscsi_set_events(iscsilun);
369
370 timer_mod(iscsilun->event_timer,
371 qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + EVENT_INTERVAL);
372 }
373
374 static void
375 iscsi_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
384 static void
385 iscsi_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
394 static int64_t sector_lun2qemu(int64_t sector, IscsiLun *iscsilun)
395 {
396 return sector * iscsilun->block_size / BDRV_SECTOR_SIZE;
397 }
398
399 static int64_t sector_qemu2lun(int64_t sector, IscsiLun *iscsilun)
400 {
401 return sector * BDRV_SECTOR_SIZE / iscsilun->block_size;
402 }
403
404 static 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
418 static 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
425 static void iscsi_allocationmap_set(IscsiLun *iscsilun, int64_t sector_num,
426 int nb_sectors)
427 {
428 if (iscsilun->allocationmap == NULL) {
429 return;
430 }
431 bitmap_set(iscsilun->allocationmap,
432 sector_num / iscsilun->cluster_sectors,
433 DIV_ROUND_UP(nb_sectors, iscsilun->cluster_sectors));
434 }
435
436 static void iscsi_allocationmap_clear(IscsiLun *iscsilun, int64_t sector_num,
437 int nb_sectors)
438 {
439 int64_t cluster_num, nb_clusters;
440 if (iscsilun->allocationmap == NULL) {
441 return;
442 }
443 cluster_num = DIV_ROUND_UP(sector_num, iscsilun->cluster_sectors);
444 nb_clusters = (sector_num + nb_sectors) / iscsilun->cluster_sectors
445 - cluster_num;
446 if (nb_clusters > 0) {
447 bitmap_clear(iscsilun->allocationmap, cluster_num, nb_clusters);
448 }
449 }
450
451 static int coroutine_fn
452 iscsi_co_writev_flags(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
453 QEMUIOVector *iov, int flags)
454 {
455 IscsiLun *iscsilun = bs->opaque;
456 struct IscsiTask iTask;
457 uint64_t lba;
458 uint32_t num_sectors;
459 bool fua;
460
461 if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
462 return -EINVAL;
463 }
464
465 if (bs->bl.max_transfer_length && nb_sectors > bs->bl.max_transfer_length) {
466 error_report("iSCSI Error: Write of %d sectors exceeds max_xfer_len "
467 "of %d sectors", nb_sectors, bs->bl.max_transfer_length);
468 return -EINVAL;
469 }
470
471 lba = sector_qemu2lun(sector_num, iscsilun);
472 num_sectors = sector_qemu2lun(nb_sectors, iscsilun);
473 iscsi_co_init_iscsitask(iscsilun, &iTask);
474 retry:
475 fua = iscsilun->dpofua && (flags & BDRV_REQ_FUA);
476 if (iscsilun->use_16_for_rw) {
477 iTask.task = iscsi_write16_task(iscsilun->iscsi, iscsilun->lun, lba,
478 NULL, num_sectors * iscsilun->block_size,
479 iscsilun->block_size, 0, 0, fua, 0, 0,
480 iscsi_co_generic_cb, &iTask);
481 } else {
482 iTask.task = iscsi_write10_task(iscsilun->iscsi, iscsilun->lun, lba,
483 NULL, num_sectors * iscsilun->block_size,
484 iscsilun->block_size, 0, 0, fua, 0, 0,
485 iscsi_co_generic_cb, &iTask);
486 }
487 if (iTask.task == NULL) {
488 return -ENOMEM;
489 }
490 scsi_task_set_iov_out(iTask.task, (struct scsi_iovec *) iov->iov,
491 iov->niov);
492 while (!iTask.complete) {
493 iscsi_set_events(iscsilun);
494 qemu_coroutine_yield();
495 }
496
497 if (iTask.task != NULL) {
498 scsi_free_scsi_task(iTask.task);
499 iTask.task = NULL;
500 }
501
502 if (iTask.do_retry) {
503 iTask.complete = 0;
504 goto retry;
505 }
506
507 if (iTask.status != SCSI_STATUS_GOOD) {
508 return iTask.err_code;
509 }
510
511 iscsi_allocationmap_set(iscsilun, sector_num, nb_sectors);
512
513 return 0;
514 }
515
516
517 static bool iscsi_allocationmap_is_allocated(IscsiLun *iscsilun,
518 int64_t sector_num, int nb_sectors)
519 {
520 unsigned long size;
521 if (iscsilun->allocationmap == NULL) {
522 return true;
523 }
524 size = DIV_ROUND_UP(sector_num + nb_sectors, iscsilun->cluster_sectors);
525 return !(find_next_bit(iscsilun->allocationmap, size,
526 sector_num / iscsilun->cluster_sectors) == size);
527 }
528
529 static int64_t coroutine_fn iscsi_co_get_block_status(BlockDriverState *bs,
530 int64_t sector_num,
531 int nb_sectors, int *pnum,
532 BlockDriverState **file)
533 {
534 IscsiLun *iscsilun = bs->opaque;
535 struct scsi_get_lba_status *lbas = NULL;
536 struct scsi_lba_status_descriptor *lbasd = NULL;
537 struct IscsiTask iTask;
538 int64_t ret;
539
540 iscsi_co_init_iscsitask(iscsilun, &iTask);
541
542 if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
543 ret = -EINVAL;
544 goto out;
545 }
546
547 /* default to all sectors allocated */
548 ret = BDRV_BLOCK_DATA;
549 ret |= (sector_num << BDRV_SECTOR_BITS) | BDRV_BLOCK_OFFSET_VALID;
550 *pnum = nb_sectors;
551
552 /* LUN does not support logical block provisioning */
553 if (!iscsilun->lbpme) {
554 goto out;
555 }
556
557 retry:
558 if (iscsi_get_lba_status_task(iscsilun->iscsi, iscsilun->lun,
559 sector_qemu2lun(sector_num, iscsilun),
560 8 + 16, iscsi_co_generic_cb,
561 &iTask) == NULL) {
562 ret = -ENOMEM;
563 goto out;
564 }
565
566 while (!iTask.complete) {
567 iscsi_set_events(iscsilun);
568 qemu_coroutine_yield();
569 }
570
571 if (iTask.do_retry) {
572 if (iTask.task != NULL) {
573 scsi_free_scsi_task(iTask.task);
574 iTask.task = NULL;
575 }
576 iTask.complete = 0;
577 goto retry;
578 }
579
580 if (iTask.status != SCSI_STATUS_GOOD) {
581 /* in case the get_lba_status_callout fails (i.e.
582 * because the device is busy or the cmd is not
583 * supported) we pretend all blocks are allocated
584 * for backwards compatibility */
585 goto out;
586 }
587
588 lbas = scsi_datain_unmarshall(iTask.task);
589 if (lbas == NULL) {
590 ret = -EIO;
591 goto out;
592 }
593
594 lbasd = &lbas->descriptors[0];
595
596 if (sector_qemu2lun(sector_num, iscsilun) != lbasd->lba) {
597 ret = -EIO;
598 goto out;
599 }
600
601 *pnum = sector_lun2qemu(lbasd->num_blocks, iscsilun);
602
603 if (lbasd->provisioning == SCSI_PROVISIONING_TYPE_DEALLOCATED ||
604 lbasd->provisioning == SCSI_PROVISIONING_TYPE_ANCHORED) {
605 ret &= ~BDRV_BLOCK_DATA;
606 if (iscsilun->lbprz) {
607 ret |= BDRV_BLOCK_ZERO;
608 }
609 }
610
611 if (ret & BDRV_BLOCK_ZERO) {
612 iscsi_allocationmap_clear(iscsilun, sector_num, *pnum);
613 } else {
614 iscsi_allocationmap_set(iscsilun, sector_num, *pnum);
615 }
616
617 if (*pnum > nb_sectors) {
618 *pnum = nb_sectors;
619 }
620 out:
621 if (iTask.task != NULL) {
622 scsi_free_scsi_task(iTask.task);
623 }
624 if (ret > 0 && ret & BDRV_BLOCK_OFFSET_VALID) {
625 *file = bs;
626 }
627 return ret;
628 }
629
630 static int coroutine_fn iscsi_co_readv(BlockDriverState *bs,
631 int64_t sector_num, int nb_sectors,
632 QEMUIOVector *iov)
633 {
634 IscsiLun *iscsilun = bs->opaque;
635 struct IscsiTask iTask;
636 uint64_t lba;
637 uint32_t num_sectors;
638
639 if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
640 return -EINVAL;
641 }
642
643 if (bs->bl.max_transfer_length && nb_sectors > bs->bl.max_transfer_length) {
644 error_report("iSCSI Error: Read of %d sectors exceeds max_xfer_len "
645 "of %d sectors", nb_sectors, bs->bl.max_transfer_length);
646 return -EINVAL;
647 }
648
649 if (iscsilun->lbprz && nb_sectors >= ISCSI_CHECKALLOC_THRES &&
650 !iscsi_allocationmap_is_allocated(iscsilun, sector_num, nb_sectors)) {
651 int64_t ret;
652 int pnum;
653 BlockDriverState *file;
654 ret = iscsi_co_get_block_status(bs, sector_num, INT_MAX, &pnum, &file);
655 if (ret < 0) {
656 return ret;
657 }
658 if (ret & BDRV_BLOCK_ZERO && pnum >= nb_sectors) {
659 qemu_iovec_memset(iov, 0, 0x00, iov->size);
660 return 0;
661 }
662 }
663
664 lba = sector_qemu2lun(sector_num, iscsilun);
665 num_sectors = sector_qemu2lun(nb_sectors, iscsilun);
666
667 iscsi_co_init_iscsitask(iscsilun, &iTask);
668 retry:
669 if (iscsilun->use_16_for_rw) {
670 iTask.task = iscsi_read16_task(iscsilun->iscsi, iscsilun->lun, lba,
671 num_sectors * iscsilun->block_size,
672 iscsilun->block_size, 0, 0, 0, 0, 0,
673 iscsi_co_generic_cb, &iTask);
674 } else {
675 iTask.task = iscsi_read10_task(iscsilun->iscsi, iscsilun->lun, lba,
676 num_sectors * iscsilun->block_size,
677 iscsilun->block_size,
678 0, 0, 0, 0, 0,
679 iscsi_co_generic_cb, &iTask);
680 }
681 if (iTask.task == NULL) {
682 return -ENOMEM;
683 }
684 scsi_task_set_iov_in(iTask.task, (struct scsi_iovec *) iov->iov, iov->niov);
685
686 while (!iTask.complete) {
687 iscsi_set_events(iscsilun);
688 qemu_coroutine_yield();
689 }
690
691 if (iTask.task != NULL) {
692 scsi_free_scsi_task(iTask.task);
693 iTask.task = NULL;
694 }
695
696 if (iTask.do_retry) {
697 iTask.complete = 0;
698 goto retry;
699 }
700
701 if (iTask.status != SCSI_STATUS_GOOD) {
702 return iTask.err_code;
703 }
704
705 return 0;
706 }
707
708 static int coroutine_fn iscsi_co_flush(BlockDriverState *bs)
709 {
710 IscsiLun *iscsilun = bs->opaque;
711 struct IscsiTask iTask;
712
713 iscsi_co_init_iscsitask(iscsilun, &iTask);
714 retry:
715 if (iscsi_synchronizecache10_task(iscsilun->iscsi, iscsilun->lun, 0, 0, 0,
716 0, iscsi_co_generic_cb, &iTask) == NULL) {
717 return -ENOMEM;
718 }
719
720 while (!iTask.complete) {
721 iscsi_set_events(iscsilun);
722 qemu_coroutine_yield();
723 }
724
725 if (iTask.task != NULL) {
726 scsi_free_scsi_task(iTask.task);
727 iTask.task = NULL;
728 }
729
730 if (iTask.do_retry) {
731 iTask.complete = 0;
732 goto retry;
733 }
734
735 if (iTask.status != SCSI_STATUS_GOOD) {
736 return iTask.err_code;
737 }
738
739 return 0;
740 }
741
742 #ifdef __linux__
743 static void
744 iscsi_aio_ioctl_cb(struct iscsi_context *iscsi, int status,
745 void *command_data, void *opaque)
746 {
747 IscsiAIOCB *acb = opaque;
748
749 g_free(acb->buf);
750 acb->buf = NULL;
751
752 acb->status = 0;
753 if (status < 0) {
754 error_report("Failed to ioctl(SG_IO) to iSCSI lun. %s",
755 iscsi_get_error(iscsi));
756 acb->status = iscsi_translate_sense(&acb->task->sense);
757 }
758
759 acb->ioh->driver_status = 0;
760 acb->ioh->host_status = 0;
761 acb->ioh->resid = 0;
762
763 #define SG_ERR_DRIVER_SENSE 0x08
764
765 if (status == SCSI_STATUS_CHECK_CONDITION && acb->task->datain.size >= 2) {
766 int ss;
767
768 acb->ioh->driver_status |= SG_ERR_DRIVER_SENSE;
769
770 acb->ioh->sb_len_wr = acb->task->datain.size - 2;
771 ss = (acb->ioh->mx_sb_len >= acb->ioh->sb_len_wr) ?
772 acb->ioh->mx_sb_len : acb->ioh->sb_len_wr;
773 memcpy(acb->ioh->sbp, &acb->task->datain.data[2], ss);
774 }
775
776 iscsi_schedule_bh(acb);
777 }
778
779 static void iscsi_ioctl_bh_completion(void *opaque)
780 {
781 IscsiAIOCB *acb = opaque;
782
783 qemu_bh_delete(acb->bh);
784 acb->common.cb(acb->common.opaque, acb->ret);
785 qemu_aio_unref(acb);
786 }
787
788 static void iscsi_ioctl_handle_emulated(IscsiAIOCB *acb, int req, void *buf)
789 {
790 BlockDriverState *bs = acb->common.bs;
791 IscsiLun *iscsilun = bs->opaque;
792 int ret = 0;
793
794 switch (req) {
795 case SG_GET_VERSION_NUM:
796 *(int *)buf = 30000;
797 break;
798 case SG_GET_SCSI_ID:
799 ((struct sg_scsi_id *)buf)->scsi_type = iscsilun->type;
800 break;
801 default:
802 ret = -EINVAL;
803 }
804 assert(!acb->bh);
805 acb->bh = aio_bh_new(bdrv_get_aio_context(bs),
806 iscsi_ioctl_bh_completion, acb);
807 acb->ret = ret;
808 qemu_bh_schedule(acb->bh);
809 }
810
811 static BlockAIOCB *iscsi_aio_ioctl(BlockDriverState *bs,
812 unsigned long int req, void *buf,
813 BlockCompletionFunc *cb, void *opaque)
814 {
815 IscsiLun *iscsilun = bs->opaque;
816 struct iscsi_context *iscsi = iscsilun->iscsi;
817 struct iscsi_data data;
818 IscsiAIOCB *acb;
819
820 acb = qemu_aio_get(&iscsi_aiocb_info, bs, cb, opaque);
821
822 acb->iscsilun = iscsilun;
823 acb->bh = NULL;
824 acb->status = -EINPROGRESS;
825 acb->buf = NULL;
826 acb->ioh = buf;
827
828 if (req != SG_IO) {
829 iscsi_ioctl_handle_emulated(acb, req, buf);
830 return &acb->common;
831 }
832
833 acb->task = malloc(sizeof(struct scsi_task));
834 if (acb->task == NULL) {
835 error_report("iSCSI: Failed to allocate task for scsi command. %s",
836 iscsi_get_error(iscsi));
837 qemu_aio_unref(acb);
838 return NULL;
839 }
840 memset(acb->task, 0, sizeof(struct scsi_task));
841
842 switch (acb->ioh->dxfer_direction) {
843 case SG_DXFER_TO_DEV:
844 acb->task->xfer_dir = SCSI_XFER_WRITE;
845 break;
846 case SG_DXFER_FROM_DEV:
847 acb->task->xfer_dir = SCSI_XFER_READ;
848 break;
849 default:
850 acb->task->xfer_dir = SCSI_XFER_NONE;
851 break;
852 }
853
854 acb->task->cdb_size = acb->ioh->cmd_len;
855 memcpy(&acb->task->cdb[0], acb->ioh->cmdp, acb->ioh->cmd_len);
856 acb->task->expxferlen = acb->ioh->dxfer_len;
857
858 data.size = 0;
859 if (acb->task->xfer_dir == SCSI_XFER_WRITE) {
860 if (acb->ioh->iovec_count == 0) {
861 data.data = acb->ioh->dxferp;
862 data.size = acb->ioh->dxfer_len;
863 } else {
864 scsi_task_set_iov_out(acb->task,
865 (struct scsi_iovec *) acb->ioh->dxferp,
866 acb->ioh->iovec_count);
867 }
868 }
869
870 if (iscsi_scsi_command_async(iscsi, iscsilun->lun, acb->task,
871 iscsi_aio_ioctl_cb,
872 (data.size > 0) ? &data : NULL,
873 acb) != 0) {
874 scsi_free_scsi_task(acb->task);
875 qemu_aio_unref(acb);
876 return NULL;
877 }
878
879 /* tell libiscsi to read straight into the buffer we got from ioctl */
880 if (acb->task->xfer_dir == SCSI_XFER_READ) {
881 if (acb->ioh->iovec_count == 0) {
882 scsi_task_add_data_in_buffer(acb->task,
883 acb->ioh->dxfer_len,
884 acb->ioh->dxferp);
885 } else {
886 scsi_task_set_iov_in(acb->task,
887 (struct scsi_iovec *) acb->ioh->dxferp,
888 acb->ioh->iovec_count);
889 }
890 }
891
892 iscsi_set_events(iscsilun);
893
894 return &acb->common;
895 }
896
897 #endif
898
899 static int64_t
900 iscsi_getlength(BlockDriverState *bs)
901 {
902 IscsiLun *iscsilun = bs->opaque;
903 int64_t len;
904
905 len = iscsilun->num_blocks;
906 len *= iscsilun->block_size;
907
908 return len;
909 }
910
911 static int
912 coroutine_fn iscsi_co_discard(BlockDriverState *bs, int64_t sector_num,
913 int nb_sectors)
914 {
915 IscsiLun *iscsilun = bs->opaque;
916 struct IscsiTask iTask;
917 struct unmap_list list;
918
919 if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
920 return -EINVAL;
921 }
922
923 if (!iscsilun->lbp.lbpu) {
924 /* UNMAP is not supported by the target */
925 return 0;
926 }
927
928 list.lba = sector_qemu2lun(sector_num, iscsilun);
929 list.num = sector_qemu2lun(nb_sectors, iscsilun);
930
931 iscsi_co_init_iscsitask(iscsilun, &iTask);
932 retry:
933 if (iscsi_unmap_task(iscsilun->iscsi, iscsilun->lun, 0, 0, &list, 1,
934 iscsi_co_generic_cb, &iTask) == NULL) {
935 return -ENOMEM;
936 }
937
938 while (!iTask.complete) {
939 iscsi_set_events(iscsilun);
940 qemu_coroutine_yield();
941 }
942
943 if (iTask.task != NULL) {
944 scsi_free_scsi_task(iTask.task);
945 iTask.task = NULL;
946 }
947
948 if (iTask.do_retry) {
949 iTask.complete = 0;
950 goto retry;
951 }
952
953 if (iTask.status == SCSI_STATUS_CHECK_CONDITION) {
954 /* the target might fail with a check condition if it
955 is not happy with the alignment of the UNMAP request
956 we silently fail in this case */
957 return 0;
958 }
959
960 if (iTask.status != SCSI_STATUS_GOOD) {
961 return iTask.err_code;
962 }
963
964 iscsi_allocationmap_clear(iscsilun, sector_num, nb_sectors);
965
966 return 0;
967 }
968
969 static int
970 coroutine_fn iscsi_co_write_zeroes(BlockDriverState *bs, int64_t sector_num,
971 int nb_sectors, BdrvRequestFlags flags)
972 {
973 IscsiLun *iscsilun = bs->opaque;
974 struct IscsiTask iTask;
975 uint64_t lba;
976 uint32_t nb_blocks;
977 bool use_16_for_ws = iscsilun->use_16_for_rw;
978
979 if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
980 return -EINVAL;
981 }
982
983 if (flags & BDRV_REQ_MAY_UNMAP) {
984 if (!use_16_for_ws && !iscsilun->lbp.lbpws10) {
985 /* WRITESAME10 with UNMAP is unsupported try WRITESAME16 */
986 use_16_for_ws = true;
987 }
988 if (use_16_for_ws && !iscsilun->lbp.lbpws) {
989 /* WRITESAME16 with UNMAP is not supported by the target,
990 * fall back and try WRITESAME10/16 without UNMAP */
991 flags &= ~BDRV_REQ_MAY_UNMAP;
992 use_16_for_ws = iscsilun->use_16_for_rw;
993 }
994 }
995
996 if (!(flags & BDRV_REQ_MAY_UNMAP) && !iscsilun->has_write_same) {
997 /* WRITESAME without UNMAP is not supported by the target */
998 return -ENOTSUP;
999 }
1000
1001 lba = sector_qemu2lun(sector_num, iscsilun);
1002 nb_blocks = sector_qemu2lun(nb_sectors, iscsilun);
1003
1004 if (iscsilun->zeroblock == NULL) {
1005 iscsilun->zeroblock = g_try_malloc0(iscsilun->block_size);
1006 if (iscsilun->zeroblock == NULL) {
1007 return -ENOMEM;
1008 }
1009 }
1010
1011 iscsi_co_init_iscsitask(iscsilun, &iTask);
1012 retry:
1013 if (use_16_for_ws) {
1014 iTask.task = iscsi_writesame16_task(iscsilun->iscsi, iscsilun->lun, lba,
1015 iscsilun->zeroblock, iscsilun->block_size,
1016 nb_blocks, 0, !!(flags & BDRV_REQ_MAY_UNMAP),
1017 0, 0, iscsi_co_generic_cb, &iTask);
1018 } else {
1019 iTask.task = iscsi_writesame10_task(iscsilun->iscsi, iscsilun->lun, lba,
1020 iscsilun->zeroblock, iscsilun->block_size,
1021 nb_blocks, 0, !!(flags & BDRV_REQ_MAY_UNMAP),
1022 0, 0, iscsi_co_generic_cb, &iTask);
1023 }
1024 if (iTask.task == NULL) {
1025 return -ENOMEM;
1026 }
1027
1028 while (!iTask.complete) {
1029 iscsi_set_events(iscsilun);
1030 qemu_coroutine_yield();
1031 }
1032
1033 if (iTask.status == SCSI_STATUS_CHECK_CONDITION &&
1034 iTask.task->sense.key == SCSI_SENSE_ILLEGAL_REQUEST &&
1035 (iTask.task->sense.ascq == SCSI_SENSE_ASCQ_INVALID_OPERATION_CODE ||
1036 iTask.task->sense.ascq == SCSI_SENSE_ASCQ_INVALID_FIELD_IN_CDB)) {
1037 /* WRITE SAME is not supported by the target */
1038 iscsilun->has_write_same = false;
1039 scsi_free_scsi_task(iTask.task);
1040 return -ENOTSUP;
1041 }
1042
1043 if (iTask.task != NULL) {
1044 scsi_free_scsi_task(iTask.task);
1045 iTask.task = NULL;
1046 }
1047
1048 if (iTask.do_retry) {
1049 iTask.complete = 0;
1050 goto retry;
1051 }
1052
1053 if (iTask.status != SCSI_STATUS_GOOD) {
1054 return iTask.err_code;
1055 }
1056
1057 if (flags & BDRV_REQ_MAY_UNMAP) {
1058 iscsi_allocationmap_clear(iscsilun, sector_num, nb_sectors);
1059 } else {
1060 iscsi_allocationmap_set(iscsilun, sector_num, nb_sectors);
1061 }
1062
1063 return 0;
1064 }
1065
1066 static void parse_chap(struct iscsi_context *iscsi, const char *target,
1067 Error **errp)
1068 {
1069 QemuOptsList *list;
1070 QemuOpts *opts;
1071 const char *user = NULL;
1072 const char *password = NULL;
1073 const char *secretid;
1074 char *secret = NULL;
1075
1076 list = qemu_find_opts("iscsi");
1077 if (!list) {
1078 return;
1079 }
1080
1081 opts = qemu_opts_find(list, target);
1082 if (opts == NULL) {
1083 opts = QTAILQ_FIRST(&list->head);
1084 if (!opts) {
1085 return;
1086 }
1087 }
1088
1089 user = qemu_opt_get(opts, "user");
1090 if (!user) {
1091 return;
1092 }
1093
1094 secretid = qemu_opt_get(opts, "password-secret");
1095 password = qemu_opt_get(opts, "password");
1096 if (secretid && password) {
1097 error_setg(errp, "'password' and 'password-secret' properties are "
1098 "mutually exclusive");
1099 return;
1100 }
1101 if (secretid) {
1102 secret = qcrypto_secret_lookup_as_utf8(secretid, errp);
1103 if (!secret) {
1104 return;
1105 }
1106 password = secret;
1107 } else if (!password) {
1108 error_setg(errp, "CHAP username specified but no password was given");
1109 return;
1110 }
1111
1112 if (iscsi_set_initiator_username_pwd(iscsi, user, password)) {
1113 error_setg(errp, "Failed to set initiator username and password");
1114 }
1115
1116 g_free(secret);
1117 }
1118
1119 static void parse_header_digest(struct iscsi_context *iscsi, const char *target,
1120 Error **errp)
1121 {
1122 QemuOptsList *list;
1123 QemuOpts *opts;
1124 const char *digest = NULL;
1125
1126 list = qemu_find_opts("iscsi");
1127 if (!list) {
1128 return;
1129 }
1130
1131 opts = qemu_opts_find(list, target);
1132 if (opts == NULL) {
1133 opts = QTAILQ_FIRST(&list->head);
1134 if (!opts) {
1135 return;
1136 }
1137 }
1138
1139 digest = qemu_opt_get(opts, "header-digest");
1140 if (!digest) {
1141 return;
1142 }
1143
1144 if (!strcmp(digest, "CRC32C")) {
1145 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_CRC32C);
1146 } else if (!strcmp(digest, "NONE")) {
1147 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE);
1148 } else if (!strcmp(digest, "CRC32C-NONE")) {
1149 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_CRC32C_NONE);
1150 } else if (!strcmp(digest, "NONE-CRC32C")) {
1151 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE_CRC32C);
1152 } else {
1153 error_setg(errp, "Invalid header-digest setting : %s", digest);
1154 }
1155 }
1156
1157 static char *parse_initiator_name(const char *target)
1158 {
1159 QemuOptsList *list;
1160 QemuOpts *opts;
1161 const char *name;
1162 char *iscsi_name;
1163 UuidInfo *uuid_info;
1164
1165 list = qemu_find_opts("iscsi");
1166 if (list) {
1167 opts = qemu_opts_find(list, target);
1168 if (!opts) {
1169 opts = QTAILQ_FIRST(&list->head);
1170 }
1171 if (opts) {
1172 name = qemu_opt_get(opts, "initiator-name");
1173 if (name) {
1174 return g_strdup(name);
1175 }
1176 }
1177 }
1178
1179 uuid_info = qmp_query_uuid(NULL);
1180 if (strcmp(uuid_info->UUID, UUID_NONE) == 0) {
1181 name = qemu_get_vm_name();
1182 } else {
1183 name = uuid_info->UUID;
1184 }
1185 iscsi_name = g_strdup_printf("iqn.2008-11.org.linux-kvm%s%s",
1186 name ? ":" : "", name ? name : "");
1187 qapi_free_UuidInfo(uuid_info);
1188 return iscsi_name;
1189 }
1190
1191 static int parse_timeout(const char *target)
1192 {
1193 QemuOptsList *list;
1194 QemuOpts *opts;
1195 const char *timeout;
1196
1197 list = qemu_find_opts("iscsi");
1198 if (list) {
1199 opts = qemu_opts_find(list, target);
1200 if (!opts) {
1201 opts = QTAILQ_FIRST(&list->head);
1202 }
1203 if (opts) {
1204 timeout = qemu_opt_get(opts, "timeout");
1205 if (timeout) {
1206 return atoi(timeout);
1207 }
1208 }
1209 }
1210
1211 return 0;
1212 }
1213
1214 static void iscsi_nop_timed_event(void *opaque)
1215 {
1216 IscsiLun *iscsilun = opaque;
1217
1218 if (iscsi_get_nops_in_flight(iscsilun->iscsi) >= MAX_NOP_FAILURES) {
1219 error_report("iSCSI: NOP timeout. Reconnecting...");
1220 iscsilun->request_timed_out = true;
1221 } else if (iscsi_nop_out_async(iscsilun->iscsi, NULL, NULL, 0, NULL) != 0) {
1222 error_report("iSCSI: failed to sent NOP-Out. Disabling NOP messages.");
1223 return;
1224 }
1225
1226 timer_mod(iscsilun->nop_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + NOP_INTERVAL);
1227 iscsi_set_events(iscsilun);
1228 }
1229
1230 static void iscsi_readcapacity_sync(IscsiLun *iscsilun, Error **errp)
1231 {
1232 struct scsi_task *task = NULL;
1233 struct scsi_readcapacity10 *rc10 = NULL;
1234 struct scsi_readcapacity16 *rc16 = NULL;
1235 int retries = ISCSI_CMD_RETRIES;
1236
1237 do {
1238 if (task != NULL) {
1239 scsi_free_scsi_task(task);
1240 task = NULL;
1241 }
1242
1243 switch (iscsilun->type) {
1244 case TYPE_DISK:
1245 task = iscsi_readcapacity16_sync(iscsilun->iscsi, iscsilun->lun);
1246 if (task != NULL && task->status == SCSI_STATUS_GOOD) {
1247 rc16 = scsi_datain_unmarshall(task);
1248 if (rc16 == NULL) {
1249 error_setg(errp, "iSCSI: Failed to unmarshall readcapacity16 data.");
1250 } else {
1251 iscsilun->block_size = rc16->block_length;
1252 iscsilun->num_blocks = rc16->returned_lba + 1;
1253 iscsilun->lbpme = !!rc16->lbpme;
1254 iscsilun->lbprz = !!rc16->lbprz;
1255 iscsilun->use_16_for_rw = (rc16->returned_lba > 0xffffffff);
1256 }
1257 break;
1258 }
1259 if (task != NULL && task->status == SCSI_STATUS_CHECK_CONDITION
1260 && task->sense.key == SCSI_SENSE_UNIT_ATTENTION) {
1261 break;
1262 }
1263 /* Fall through and try READ CAPACITY(10) instead. */
1264 case TYPE_ROM:
1265 task = iscsi_readcapacity10_sync(iscsilun->iscsi, iscsilun->lun, 0, 0);
1266 if (task != NULL && task->status == SCSI_STATUS_GOOD) {
1267 rc10 = scsi_datain_unmarshall(task);
1268 if (rc10 == NULL) {
1269 error_setg(errp, "iSCSI: Failed to unmarshall readcapacity10 data.");
1270 } else {
1271 iscsilun->block_size = rc10->block_size;
1272 if (rc10->lba == 0) {
1273 /* blank disk loaded */
1274 iscsilun->num_blocks = 0;
1275 } else {
1276 iscsilun->num_blocks = rc10->lba + 1;
1277 }
1278 }
1279 }
1280 break;
1281 default:
1282 return;
1283 }
1284 } while (task != NULL && task->status == SCSI_STATUS_CHECK_CONDITION
1285 && task->sense.key == SCSI_SENSE_UNIT_ATTENTION
1286 && retries-- > 0);
1287
1288 if (task == NULL || task->status != SCSI_STATUS_GOOD) {
1289 error_setg(errp, "iSCSI: failed to send readcapacity10/16 command");
1290 } else if (!iscsilun->block_size ||
1291 iscsilun->block_size % BDRV_SECTOR_SIZE) {
1292 error_setg(errp, "iSCSI: the target returned an invalid "
1293 "block size of %d.", iscsilun->block_size);
1294 }
1295 if (task) {
1296 scsi_free_scsi_task(task);
1297 }
1298 }
1299
1300 /* TODO Convert to fine grained options */
1301 static QemuOptsList runtime_opts = {
1302 .name = "iscsi",
1303 .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
1304 .desc = {
1305 {
1306 .name = "filename",
1307 .type = QEMU_OPT_STRING,
1308 .help = "URL to the iscsi image",
1309 },
1310 { /* end of list */ }
1311 },
1312 };
1313
1314 static struct scsi_task *iscsi_do_inquiry(struct iscsi_context *iscsi, int lun,
1315 int evpd, int pc, void **inq, Error **errp)
1316 {
1317 int full_size;
1318 struct scsi_task *task = NULL;
1319 task = iscsi_inquiry_sync(iscsi, lun, evpd, pc, 64);
1320 if (task == NULL || task->status != SCSI_STATUS_GOOD) {
1321 goto fail;
1322 }
1323 full_size = scsi_datain_getfullsize(task);
1324 if (full_size > task->datain.size) {
1325 scsi_free_scsi_task(task);
1326
1327 /* we need more data for the full list */
1328 task = iscsi_inquiry_sync(iscsi, lun, evpd, pc, full_size);
1329 if (task == NULL || task->status != SCSI_STATUS_GOOD) {
1330 goto fail;
1331 }
1332 }
1333
1334 *inq = scsi_datain_unmarshall(task);
1335 if (*inq == NULL) {
1336 error_setg(errp, "iSCSI: failed to unmarshall inquiry datain blob");
1337 goto fail_with_err;
1338 }
1339
1340 return task;
1341
1342 fail:
1343 error_setg(errp, "iSCSI: Inquiry command failed : %s",
1344 iscsi_get_error(iscsi));
1345 fail_with_err:
1346 if (task != NULL) {
1347 scsi_free_scsi_task(task);
1348 }
1349 return NULL;
1350 }
1351
1352 static void iscsi_detach_aio_context(BlockDriverState *bs)
1353 {
1354 IscsiLun *iscsilun = bs->opaque;
1355
1356 aio_set_fd_handler(iscsilun->aio_context, iscsi_get_fd(iscsilun->iscsi),
1357 false, NULL, NULL, NULL);
1358 iscsilun->events = 0;
1359
1360 if (iscsilun->nop_timer) {
1361 timer_del(iscsilun->nop_timer);
1362 timer_free(iscsilun->nop_timer);
1363 iscsilun->nop_timer = NULL;
1364 }
1365 if (iscsilun->event_timer) {
1366 timer_del(iscsilun->event_timer);
1367 timer_free(iscsilun->event_timer);
1368 iscsilun->event_timer = NULL;
1369 }
1370 }
1371
1372 static void iscsi_attach_aio_context(BlockDriverState *bs,
1373 AioContext *new_context)
1374 {
1375 IscsiLun *iscsilun = bs->opaque;
1376
1377 iscsilun->aio_context = new_context;
1378 iscsi_set_events(iscsilun);
1379
1380 /* Set up a timer for sending out iSCSI NOPs */
1381 iscsilun->nop_timer = aio_timer_new(iscsilun->aio_context,
1382 QEMU_CLOCK_REALTIME, SCALE_MS,
1383 iscsi_nop_timed_event, iscsilun);
1384 timer_mod(iscsilun->nop_timer,
1385 qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + NOP_INTERVAL);
1386
1387 /* Set up a timer for periodic calls to iscsi_set_events and to
1388 * scan for command timeout */
1389 iscsilun->event_timer = aio_timer_new(iscsilun->aio_context,
1390 QEMU_CLOCK_REALTIME, SCALE_MS,
1391 iscsi_timed_check_events, iscsilun);
1392 timer_mod(iscsilun->event_timer,
1393 qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + EVENT_INTERVAL);
1394 }
1395
1396 static void iscsi_modesense_sync(IscsiLun *iscsilun)
1397 {
1398 struct scsi_task *task;
1399 struct scsi_mode_sense *ms = NULL;
1400 iscsilun->write_protected = false;
1401 iscsilun->dpofua = false;
1402
1403 task = iscsi_modesense6_sync(iscsilun->iscsi, iscsilun->lun,
1404 1, SCSI_MODESENSE_PC_CURRENT,
1405 0x3F, 0, 255);
1406 if (task == NULL) {
1407 error_report("iSCSI: Failed to send MODE_SENSE(6) command: %s",
1408 iscsi_get_error(iscsilun->iscsi));
1409 goto out;
1410 }
1411
1412 if (task->status != SCSI_STATUS_GOOD) {
1413 error_report("iSCSI: Failed MODE_SENSE(6), LUN assumed writable");
1414 goto out;
1415 }
1416 ms = scsi_datain_unmarshall(task);
1417 if (!ms) {
1418 error_report("iSCSI: Failed to unmarshall MODE_SENSE(6) data: %s",
1419 iscsi_get_error(iscsilun->iscsi));
1420 goto out;
1421 }
1422 iscsilun->write_protected = ms->device_specific_parameter & 0x80;
1423 iscsilun->dpofua = ms->device_specific_parameter & 0x10;
1424
1425 out:
1426 if (task) {
1427 scsi_free_scsi_task(task);
1428 }
1429 }
1430
1431 /*
1432 * We support iscsi url's on the form
1433 * iscsi://[<username>%<password>@]<host>[:<port>]/<targetname>/<lun>
1434 */
1435 static int iscsi_open(BlockDriverState *bs, QDict *options, int flags,
1436 Error **errp)
1437 {
1438 IscsiLun *iscsilun = bs->opaque;
1439 struct iscsi_context *iscsi = NULL;
1440 struct iscsi_url *iscsi_url = NULL;
1441 struct scsi_task *task = NULL;
1442 struct scsi_inquiry_standard *inq = NULL;
1443 struct scsi_inquiry_supported_pages *inq_vpd;
1444 char *initiator_name = NULL;
1445 QemuOpts *opts;
1446 Error *local_err = NULL;
1447 const char *filename;
1448 int i, ret = 0, timeout = 0;
1449
1450 opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
1451 qemu_opts_absorb_qdict(opts, options, &local_err);
1452 if (local_err) {
1453 error_propagate(errp, local_err);
1454 ret = -EINVAL;
1455 goto out;
1456 }
1457
1458 filename = qemu_opt_get(opts, "filename");
1459
1460 iscsi_url = iscsi_parse_full_url(iscsi, filename);
1461 if (iscsi_url == NULL) {
1462 error_setg(errp, "Failed to parse URL : %s", filename);
1463 ret = -EINVAL;
1464 goto out;
1465 }
1466
1467 memset(iscsilun, 0, sizeof(IscsiLun));
1468
1469 initiator_name = parse_initiator_name(iscsi_url->target);
1470
1471 iscsi = iscsi_create_context(initiator_name);
1472 if (iscsi == NULL) {
1473 error_setg(errp, "iSCSI: Failed to create iSCSI context.");
1474 ret = -ENOMEM;
1475 goto out;
1476 }
1477
1478 if (iscsi_set_targetname(iscsi, iscsi_url->target)) {
1479 error_setg(errp, "iSCSI: Failed to set target name.");
1480 ret = -EINVAL;
1481 goto out;
1482 }
1483
1484 if (iscsi_url->user[0] != '\0') {
1485 ret = iscsi_set_initiator_username_pwd(iscsi, iscsi_url->user,
1486 iscsi_url->passwd);
1487 if (ret != 0) {
1488 error_setg(errp, "Failed to set initiator username and password");
1489 ret = -EINVAL;
1490 goto out;
1491 }
1492 }
1493
1494 /* check if we got CHAP username/password via the options */
1495 parse_chap(iscsi, iscsi_url->target, &local_err);
1496 if (local_err != NULL) {
1497 error_propagate(errp, local_err);
1498 ret = -EINVAL;
1499 goto out;
1500 }
1501
1502 if (iscsi_set_session_type(iscsi, ISCSI_SESSION_NORMAL) != 0) {
1503 error_setg(errp, "iSCSI: Failed to set session type to normal.");
1504 ret = -EINVAL;
1505 goto out;
1506 }
1507
1508 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE_CRC32C);
1509
1510 /* check if we got HEADER_DIGEST via the options */
1511 parse_header_digest(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 /* timeout handling is broken in libiscsi before 1.15.0 */
1519 timeout = parse_timeout(iscsi_url->target);
1520 #if defined(LIBISCSI_API_VERSION) && LIBISCSI_API_VERSION >= 20150621
1521 iscsi_set_timeout(iscsi, timeout);
1522 #else
1523 if (timeout) {
1524 error_report("iSCSI: ignoring timeout value for libiscsi <1.15.0");
1525 }
1526 #endif
1527
1528 if (iscsi_full_connect_sync(iscsi, iscsi_url->portal, iscsi_url->lun) != 0) {
1529 error_setg(errp, "iSCSI: Failed to connect to LUN : %s",
1530 iscsi_get_error(iscsi));
1531 ret = -EINVAL;
1532 goto out;
1533 }
1534
1535 iscsilun->iscsi = iscsi;
1536 iscsilun->aio_context = bdrv_get_aio_context(bs);
1537 iscsilun->lun = iscsi_url->lun;
1538 iscsilun->has_write_same = true;
1539
1540 task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 0, 0,
1541 (void **) &inq, errp);
1542 if (task == NULL) {
1543 ret = -EINVAL;
1544 goto out;
1545 }
1546 iscsilun->type = inq->periperal_device_type;
1547 scsi_free_scsi_task(task);
1548 task = NULL;
1549
1550 iscsi_modesense_sync(iscsilun);
1551
1552 /* Check the write protect flag of the LUN if we want to write */
1553 if (iscsilun->type == TYPE_DISK && (flags & BDRV_O_RDWR) &&
1554 iscsilun->write_protected) {
1555 error_setg(errp, "Cannot open a write protected LUN as read-write");
1556 ret = -EACCES;
1557 goto out;
1558 }
1559
1560 iscsi_readcapacity_sync(iscsilun, &local_err);
1561 if (local_err != NULL) {
1562 error_propagate(errp, local_err);
1563 ret = -EINVAL;
1564 goto out;
1565 }
1566 bs->total_sectors = sector_lun2qemu(iscsilun->num_blocks, iscsilun);
1567 bs->request_alignment = iscsilun->block_size;
1568
1569 /* We don't have any emulation for devices other than disks and CD-ROMs, so
1570 * this must be sg ioctl compatible. We force it to be sg, otherwise qemu
1571 * will try to read from the device to guess the image format.
1572 */
1573 if (iscsilun->type != TYPE_DISK && iscsilun->type != TYPE_ROM) {
1574 bs->sg = 1;
1575 }
1576
1577 task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
1578 SCSI_INQUIRY_PAGECODE_SUPPORTED_VPD_PAGES,
1579 (void **) &inq_vpd, errp);
1580 if (task == NULL) {
1581 ret = -EINVAL;
1582 goto out;
1583 }
1584 for (i = 0; i < inq_vpd->num_pages; i++) {
1585 struct scsi_task *inq_task;
1586 struct scsi_inquiry_logical_block_provisioning *inq_lbp;
1587 struct scsi_inquiry_block_limits *inq_bl;
1588 switch (inq_vpd->pages[i]) {
1589 case SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING:
1590 inq_task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
1591 SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING,
1592 (void **) &inq_lbp, errp);
1593 if (inq_task == NULL) {
1594 ret = -EINVAL;
1595 goto out;
1596 }
1597 memcpy(&iscsilun->lbp, inq_lbp,
1598 sizeof(struct scsi_inquiry_logical_block_provisioning));
1599 scsi_free_scsi_task(inq_task);
1600 break;
1601 case SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS:
1602 inq_task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
1603 SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS,
1604 (void **) &inq_bl, errp);
1605 if (inq_task == NULL) {
1606 ret = -EINVAL;
1607 goto out;
1608 }
1609 memcpy(&iscsilun->bl, inq_bl,
1610 sizeof(struct scsi_inquiry_block_limits));
1611 scsi_free_scsi_task(inq_task);
1612 break;
1613 default:
1614 break;
1615 }
1616 }
1617 scsi_free_scsi_task(task);
1618 task = NULL;
1619
1620 iscsi_attach_aio_context(bs, iscsilun->aio_context);
1621
1622 /* Guess the internal cluster (page) size of the iscsi target by the means
1623 * of opt_unmap_gran. Transfer the unmap granularity only if it has a
1624 * reasonable size */
1625 if (iscsilun->bl.opt_unmap_gran * iscsilun->block_size >= 4 * 1024 &&
1626 iscsilun->bl.opt_unmap_gran * iscsilun->block_size <= 16 * 1024 * 1024) {
1627 iscsilun->cluster_sectors = (iscsilun->bl.opt_unmap_gran *
1628 iscsilun->block_size) >> BDRV_SECTOR_BITS;
1629 if (iscsilun->lbprz) {
1630 iscsilun->allocationmap = iscsi_allocationmap_init(iscsilun);
1631 if (iscsilun->allocationmap == NULL) {
1632 ret = -ENOMEM;
1633 }
1634 }
1635 }
1636
1637 out:
1638 qemu_opts_del(opts);
1639 g_free(initiator_name);
1640 if (iscsi_url != NULL) {
1641 iscsi_destroy_url(iscsi_url);
1642 }
1643 if (task != NULL) {
1644 scsi_free_scsi_task(task);
1645 }
1646
1647 if (ret) {
1648 if (iscsi != NULL) {
1649 if (iscsi_is_logged_in(iscsi)) {
1650 iscsi_logout_sync(iscsi);
1651 }
1652 iscsi_destroy_context(iscsi);
1653 }
1654 memset(iscsilun, 0, sizeof(IscsiLun));
1655 }
1656 return ret;
1657 }
1658
1659 static void iscsi_close(BlockDriverState *bs)
1660 {
1661 IscsiLun *iscsilun = bs->opaque;
1662 struct iscsi_context *iscsi = iscsilun->iscsi;
1663
1664 iscsi_detach_aio_context(bs);
1665 if (iscsi_is_logged_in(iscsi)) {
1666 iscsi_logout_sync(iscsi);
1667 }
1668 iscsi_destroy_context(iscsi);
1669 g_free(iscsilun->zeroblock);
1670 g_free(iscsilun->allocationmap);
1671 memset(iscsilun, 0, sizeof(IscsiLun));
1672 }
1673
1674 static int sector_limits_lun2qemu(int64_t sector, IscsiLun *iscsilun)
1675 {
1676 return MIN(sector_lun2qemu(sector, iscsilun), INT_MAX / 2 + 1);
1677 }
1678
1679 static void iscsi_refresh_limits(BlockDriverState *bs, Error **errp)
1680 {
1681 /* We don't actually refresh here, but just return data queried in
1682 * iscsi_open(): iscsi targets don't change their limits. */
1683
1684 IscsiLun *iscsilun = bs->opaque;
1685 uint32_t max_xfer_len = iscsilun->use_16_for_rw ? 0xffffffff : 0xffff;
1686
1687 if (iscsilun->bl.max_xfer_len) {
1688 max_xfer_len = MIN(max_xfer_len, iscsilun->bl.max_xfer_len);
1689 }
1690
1691 bs->bl.max_transfer_length = sector_limits_lun2qemu(max_xfer_len, iscsilun);
1692
1693 if (iscsilun->lbp.lbpu) {
1694 if (iscsilun->bl.max_unmap < 0xffffffff) {
1695 bs->bl.max_discard =
1696 sector_limits_lun2qemu(iscsilun->bl.max_unmap, iscsilun);
1697 }
1698 bs->bl.discard_alignment =
1699 sector_limits_lun2qemu(iscsilun->bl.opt_unmap_gran, iscsilun);
1700 }
1701
1702 if (iscsilun->bl.max_ws_len < 0xffffffff) {
1703 bs->bl.max_write_zeroes =
1704 sector_limits_lun2qemu(iscsilun->bl.max_ws_len, iscsilun);
1705 }
1706 if (iscsilun->lbp.lbpws) {
1707 bs->bl.write_zeroes_alignment =
1708 sector_limits_lun2qemu(iscsilun->bl.opt_unmap_gran, iscsilun);
1709 }
1710 bs->bl.opt_transfer_length =
1711 sector_limits_lun2qemu(iscsilun->bl.opt_xfer_len, iscsilun);
1712 }
1713
1714 /* Note that this will not re-establish a connection with an iSCSI target - it
1715 * is effectively a NOP. */
1716 static int iscsi_reopen_prepare(BDRVReopenState *state,
1717 BlockReopenQueue *queue, Error **errp)
1718 {
1719 IscsiLun *iscsilun = state->bs->opaque;
1720
1721 if (state->flags & BDRV_O_RDWR && iscsilun->write_protected) {
1722 error_setg(errp, "Cannot open a write protected LUN as read-write");
1723 return -EACCES;
1724 }
1725 return 0;
1726 }
1727
1728 static int iscsi_truncate(BlockDriverState *bs, int64_t offset)
1729 {
1730 IscsiLun *iscsilun = bs->opaque;
1731 Error *local_err = NULL;
1732
1733 if (iscsilun->type != TYPE_DISK) {
1734 return -ENOTSUP;
1735 }
1736
1737 iscsi_readcapacity_sync(iscsilun, &local_err);
1738 if (local_err != NULL) {
1739 error_free(local_err);
1740 return -EIO;
1741 }
1742
1743 if (offset > iscsi_getlength(bs)) {
1744 return -EINVAL;
1745 }
1746
1747 if (iscsilun->allocationmap != NULL) {
1748 g_free(iscsilun->allocationmap);
1749 iscsilun->allocationmap = iscsi_allocationmap_init(iscsilun);
1750 }
1751
1752 return 0;
1753 }
1754
1755 static int iscsi_create(const char *filename, QemuOpts *opts, Error **errp)
1756 {
1757 int ret = 0;
1758 int64_t total_size = 0;
1759 BlockDriverState *bs;
1760 IscsiLun *iscsilun = NULL;
1761 QDict *bs_options;
1762
1763 bs = bdrv_new();
1764
1765 /* Read out options */
1766 total_size = DIV_ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
1767 BDRV_SECTOR_SIZE);
1768 bs->opaque = g_new0(struct IscsiLun, 1);
1769 iscsilun = bs->opaque;
1770
1771 bs_options = qdict_new();
1772 qdict_put(bs_options, "filename", qstring_from_str(filename));
1773 ret = iscsi_open(bs, bs_options, 0, NULL);
1774 QDECREF(bs_options);
1775
1776 if (ret != 0) {
1777 goto out;
1778 }
1779 iscsi_detach_aio_context(bs);
1780 if (iscsilun->type != TYPE_DISK) {
1781 ret = -ENODEV;
1782 goto out;
1783 }
1784 if (bs->total_sectors < total_size) {
1785 ret = -ENOSPC;
1786 goto out;
1787 }
1788
1789 ret = 0;
1790 out:
1791 if (iscsilun->iscsi != NULL) {
1792 iscsi_destroy_context(iscsilun->iscsi);
1793 }
1794 g_free(bs->opaque);
1795 bs->opaque = NULL;
1796 bdrv_unref(bs);
1797 return ret;
1798 }
1799
1800 static int iscsi_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
1801 {
1802 IscsiLun *iscsilun = bs->opaque;
1803 bdi->unallocated_blocks_are_zero = iscsilun->lbprz;
1804 bdi->can_write_zeroes_with_unmap = iscsilun->lbprz && iscsilun->lbp.lbpws;
1805 bdi->cluster_size = iscsilun->cluster_sectors * BDRV_SECTOR_SIZE;
1806 return 0;
1807 }
1808
1809 static QemuOptsList iscsi_create_opts = {
1810 .name = "iscsi-create-opts",
1811 .head = QTAILQ_HEAD_INITIALIZER(iscsi_create_opts.head),
1812 .desc = {
1813 {
1814 .name = BLOCK_OPT_SIZE,
1815 .type = QEMU_OPT_SIZE,
1816 .help = "Virtual disk size"
1817 },
1818 { /* end of list */ }
1819 }
1820 };
1821
1822 static BlockDriver bdrv_iscsi = {
1823 .format_name = "iscsi",
1824 .protocol_name = "iscsi",
1825
1826 .instance_size = sizeof(IscsiLun),
1827 .bdrv_needs_filename = true,
1828 .bdrv_file_open = iscsi_open,
1829 .bdrv_close = iscsi_close,
1830 .bdrv_create = iscsi_create,
1831 .create_opts = &iscsi_create_opts,
1832 .bdrv_reopen_prepare = iscsi_reopen_prepare,
1833
1834 .bdrv_getlength = iscsi_getlength,
1835 .bdrv_get_info = iscsi_get_info,
1836 .bdrv_truncate = iscsi_truncate,
1837 .bdrv_refresh_limits = iscsi_refresh_limits,
1838
1839 .bdrv_co_get_block_status = iscsi_co_get_block_status,
1840 .bdrv_co_discard = iscsi_co_discard,
1841 .bdrv_co_write_zeroes = iscsi_co_write_zeroes,
1842 .bdrv_co_readv = iscsi_co_readv,
1843 .bdrv_co_writev_flags = iscsi_co_writev_flags,
1844 .supported_write_flags = BDRV_REQ_FUA,
1845 .bdrv_co_flush_to_disk = iscsi_co_flush,
1846
1847 #ifdef __linux__
1848 .bdrv_aio_ioctl = iscsi_aio_ioctl,
1849 #endif
1850
1851 .bdrv_detach_aio_context = iscsi_detach_aio_context,
1852 .bdrv_attach_aio_context = iscsi_attach_aio_context,
1853 };
1854
1855 static QemuOptsList qemu_iscsi_opts = {
1856 .name = "iscsi",
1857 .head = QTAILQ_HEAD_INITIALIZER(qemu_iscsi_opts.head),
1858 .desc = {
1859 {
1860 .name = "user",
1861 .type = QEMU_OPT_STRING,
1862 .help = "username for CHAP authentication to target",
1863 },{
1864 .name = "password",
1865 .type = QEMU_OPT_STRING,
1866 .help = "password for CHAP authentication to target",
1867 },{
1868 .name = "password-secret",
1869 .type = QEMU_OPT_STRING,
1870 .help = "ID of the secret providing password for CHAP "
1871 "authentication to target",
1872 },{
1873 .name = "header-digest",
1874 .type = QEMU_OPT_STRING,
1875 .help = "HeaderDigest setting. "
1876 "{CRC32C|CRC32C-NONE|NONE-CRC32C|NONE}",
1877 },{
1878 .name = "initiator-name",
1879 .type = QEMU_OPT_STRING,
1880 .help = "Initiator iqn name to use when connecting",
1881 },{
1882 .name = "timeout",
1883 .type = QEMU_OPT_NUMBER,
1884 .help = "Request timeout in seconds (default 0 = no timeout)",
1885 },
1886 { /* end of list */ }
1887 },
1888 };
1889
1890 static void iscsi_block_init(void)
1891 {
1892 bdrv_register(&bdrv_iscsi);
1893 qemu_add_opts(&qemu_iscsi_opts);
1894 }
1895
1896 block_init(iscsi_block_init);
AR7 emulation for QEMU