]> git.proxmox.com Git - mirror_qemu.git/blame - block/iscsi.c
kvmvapic: patch_instruction fix
[mirror_qemu.git] / block / iscsi.c
CommitLineData
c589b249
RS
1/*
2 * QEMU Block driver for iSCSI images
3 *
4 * Copyright (c) 2010-2011 Ronnie Sahlberg <ronniesahlberg@gmail.com>
ec209aca 5 * Copyright (c) 2012-2014 Peter Lieven <pl@kamp.de>
c589b249
RS
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 "config-host.h"
27
28#include <poll.h>
efc6de0d 29#include <math.h>
f4dfa67f 30#include <arpa/inet.h>
c589b249 31#include "qemu-common.h"
1de7afc9
PB
32#include "qemu/config-file.h"
33#include "qemu/error-report.h"
b03c3805
PL
34#include "qemu/bitops.h"
35#include "qemu/bitmap.h"
737e150e 36#include "block/block_int.h"
0d09e41a 37#include "block/scsi.h"
0a53f010 38#include "qemu/iov.h"
5accc840
PB
39#include "sysemu/sysemu.h"
40#include "qmp-commands.h"
c589b249
RS
41
42#include <iscsi/iscsi.h>
43#include <iscsi/scsi-lowlevel.h>
44
98392453
RS
45#ifdef __linux__
46#include <scsi/sg.h>
0d09e41a 47#include <block/scsi.h>
98392453 48#endif
c589b249
RS
49
50typedef struct IscsiLun {
51 struct iscsi_context *iscsi;
80cf6257 52 AioContext *aio_context;
c589b249 53 int lun;
dbfff6d7 54 enum scsi_inquiry_peripheral_device_type type;
c589b249 55 int block_size;
c7b4a952 56 uint64_t num_blocks;
c9b9f682 57 int events;
5b5d34ec 58 QEMUTimer *nop_timer;
f18a7cbb
PL
59 uint8_t lbpme;
60 uint8_t lbprz;
fa6252b0 61 uint8_t has_write_same;
f18a7cbb
PL
62 struct scsi_inquiry_logical_block_provisioning lbp;
63 struct scsi_inquiry_block_limits bl;
d4cd9615 64 unsigned char *zeroblock;
b03c3805
PL
65 unsigned long *allocationmap;
66 int cluster_sectors;
9281fe9e 67 bool use_16_for_rw;
c589b249
RS
68} IscsiLun;
69
54a5c1d5
PL
70typedef struct IscsiTask {
71 int status;
72 int complete;
73 int retries;
74 int do_retry;
75 struct scsi_task *task;
76 Coroutine *co;
8b9dfe90 77 QEMUBH *bh;
80cf6257 78 IscsiLun *iscsilun;
efc6de0d 79 QEMUTimer retry_timer;
54a5c1d5
PL
80} IscsiTask;
81
c589b249 82typedef struct IscsiAIOCB {
7c84b1b8 83 BlockAIOCB common;
c589b249
RS
84 QEMUIOVector *qiov;
85 QEMUBH *bh;
86 IscsiLun *iscsilun;
87 struct scsi_task *task;
88 uint8_t *buf;
89 int status;
1dde716e
PL
90 int64_t sector_num;
91 int nb_sectors;
98392453
RS
92#ifdef __linux__
93 sg_io_hdr_t *ioh;
94#endif
c589b249
RS
95} IscsiAIOCB;
96
5b5d34ec
PL
97#define NOP_INTERVAL 5000
98#define MAX_NOP_FAILURES 3
efc6de0d
PL
99#define ISCSI_CMD_RETRIES ARRAY_SIZE(iscsi_retry_times)
100static const unsigned iscsi_retry_times[] = {8, 32, 128, 512, 2048};
5b5d34ec 101
5d831be2 102/* this threshold is a trade-off knob to choose between
5917af81
PL
103 * the potential additional overhead of an extra GET_LBA_STATUS request
104 * vs. unnecessarily reading a lot of zero sectors over the wire.
105 * If a read request is greater or equal than ISCSI_CHECKALLOC_THRES
106 * sectors we check the allocation status of the area covered by the
107 * request first if the allocationmap indicates that the area might be
108 * unallocated. */
109#define ISCSI_CHECKALLOC_THRES 64
5b5d34ec 110
27cbd828 111static void
cfb3f506 112iscsi_bh_cb(void *p)
27cbd828
PB
113{
114 IscsiAIOCB *acb = p;
115
116 qemu_bh_delete(acb->bh);
117
4790b03d
PB
118 g_free(acb->buf);
119 acb->buf = NULL;
120
722d9333 121 acb->common.cb(acb->common.opaque, acb->status);
27cbd828 122
1bd075f2
PB
123 if (acb->task != NULL) {
124 scsi_free_scsi_task(acb->task);
125 acb->task = NULL;
126 }
127
8007429a 128 qemu_aio_unref(acb);
27cbd828
PB
129}
130
cfb3f506
PB
131static void
132iscsi_schedule_bh(IscsiAIOCB *acb)
27cbd828 133{
1bd075f2
PB
134 if (acb->bh) {
135 return;
136 }
80cf6257 137 acb->bh = aio_bh_new(acb->iscsilun->aio_context, iscsi_bh_cb, acb);
27cbd828 138 qemu_bh_schedule(acb->bh);
27cbd828
PB
139}
140
8b9dfe90
PL
141static void iscsi_co_generic_bh_cb(void *opaque)
142{
143 struct IscsiTask *iTask = opaque;
fcd470d8 144 iTask->complete = 1;
8b9dfe90
PL
145 qemu_bh_delete(iTask->bh);
146 qemu_coroutine_enter(iTask->co, NULL);
147}
148
efc6de0d
PL
149static void iscsi_retry_timer_expired(void *opaque)
150{
151 struct IscsiTask *iTask = opaque;
fcd470d8 152 iTask->complete = 1;
efc6de0d
PL
153 if (iTask->co) {
154 qemu_coroutine_enter(iTask->co, NULL);
155 }
156}
157
158static inline unsigned exp_random(double mean)
159{
160 return -mean * log((double)rand() / RAND_MAX);
161}
162
54a5c1d5
PL
163static void
164iscsi_co_generic_cb(struct iscsi_context *iscsi, int status,
165 void *command_data, void *opaque)
166{
167 struct IscsiTask *iTask = opaque;
168 struct scsi_task *task = command_data;
169
54a5c1d5
PL
170 iTask->status = status;
171 iTask->do_retry = 0;
172 iTask->task = task;
173
54a5c1d5 174 if (status != SCSI_STATUS_GOOD) {
efc6de0d
PL
175 if (iTask->retries++ < ISCSI_CMD_RETRIES) {
176 if (status == SCSI_STATUS_CHECK_CONDITION
177 && task->sense.key == SCSI_SENSE_UNIT_ATTENTION) {
178 error_report("iSCSI CheckCondition: %s",
179 iscsi_get_error(iscsi));
180 iTask->do_retry = 1;
181 goto out;
182 }
183 if (status == SCSI_STATUS_BUSY) {
184 unsigned retry_time =
185 exp_random(iscsi_retry_times[iTask->retries - 1]);
186 error_report("iSCSI Busy (retry #%u in %u ms): %s",
187 iTask->retries, retry_time,
188 iscsi_get_error(iscsi));
189 aio_timer_init(iTask->iscsilun->aio_context,
190 &iTask->retry_timer, QEMU_CLOCK_REALTIME,
191 SCALE_MS, iscsi_retry_timer_expired, iTask);
192 timer_mod(&iTask->retry_timer,
193 qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + retry_time);
194 iTask->do_retry = 1;
195 return;
196 }
197 }
837c3901 198 error_report("iSCSI Failure: %s", iscsi_get_error(iscsi));
54a5c1d5
PL
199 }
200
201out:
202 if (iTask->co) {
80cf6257
SH
203 iTask->bh = aio_bh_new(iTask->iscsilun->aio_context,
204 iscsi_co_generic_bh_cb, iTask);
8b9dfe90 205 qemu_bh_schedule(iTask->bh);
fcd470d8
PL
206 } else {
207 iTask->complete = 1;
54a5c1d5
PL
208 }
209}
210
211static void iscsi_co_init_iscsitask(IscsiLun *iscsilun, struct IscsiTask *iTask)
212{
213 *iTask = (struct IscsiTask) {
efc6de0d 214 .co = qemu_coroutine_self(),
efc6de0d 215 .iscsilun = iscsilun,
54a5c1d5
PL
216 };
217}
27cbd828 218
c589b249
RS
219static void
220iscsi_abort_task_cb(struct iscsi_context *iscsi, int status, void *command_data,
221 void *private_data)
222{
1bd075f2
PB
223 IscsiAIOCB *acb = private_data;
224
225 acb->status = -ECANCELED;
226 iscsi_schedule_bh(acb);
c589b249
RS
227}
228
229static void
7c84b1b8 230iscsi_aio_cancel(BlockAIOCB *blockacb)
c589b249
RS
231{
232 IscsiAIOCB *acb = (IscsiAIOCB *)blockacb;
233 IscsiLun *iscsilun = acb->iscsilun;
234
1bd075f2
PB
235 if (acb->status != -EINPROGRESS) {
236 return;
237 }
238
b2090919 239 /* send a task mgmt call to the target to cancel the task on the target */
64e69e80 240 iscsi_task_mgmt_abort_task_async(iscsilun->iscsi, acb->task,
1bd075f2 241 iscsi_abort_task_cb, acb);
b2090919 242
c589b249
RS
243}
244
d7331bed 245static const AIOCBInfo iscsi_aiocb_info = {
c589b249 246 .aiocb_size = sizeof(IscsiAIOCB),
722d9333 247 .cancel_async = iscsi_aio_cancel,
c589b249
RS
248};
249
250
251static void iscsi_process_read(void *arg);
252static void iscsi_process_write(void *arg);
253
c589b249
RS
254static void
255iscsi_set_events(IscsiLun *iscsilun)
256{
257 struct iscsi_context *iscsi = iscsilun->iscsi;
c9b9f682
RS
258 int ev;
259
260 /* We always register a read handler. */
261 ev = POLLIN;
262 ev |= iscsi_which_events(iscsi);
263 if (ev != iscsilun->events) {
80cf6257
SH
264 aio_set_fd_handler(iscsilun->aio_context,
265 iscsi_get_fd(iscsi),
266 iscsi_process_read,
267 (ev & POLLOUT) ? iscsi_process_write : NULL,
268 iscsilun);
c9b9f682
RS
269
270 }
271
c9b9f682 272 iscsilun->events = ev;
c589b249
RS
273}
274
275static void
276iscsi_process_read(void *arg)
277{
278 IscsiLun *iscsilun = arg;
279 struct iscsi_context *iscsi = iscsilun->iscsi;
280
281 iscsi_service(iscsi, POLLIN);
282 iscsi_set_events(iscsilun);
283}
284
285static void
286iscsi_process_write(void *arg)
287{
288 IscsiLun *iscsilun = arg;
289 struct iscsi_context *iscsi = iscsilun->iscsi;
290
291 iscsi_service(iscsi, POLLOUT);
292 iscsi_set_events(iscsilun);
293}
294
0777b5dd
PL
295static int64_t sector_lun2qemu(int64_t sector, IscsiLun *iscsilun)
296{
297 return sector * iscsilun->block_size / BDRV_SECTOR_SIZE;
298}
299
c589b249
RS
300static int64_t sector_qemu2lun(int64_t sector, IscsiLun *iscsilun)
301{
302 return sector * BDRV_SECTOR_SIZE / iscsilun->block_size;
303}
304
91bea4e2
PL
305static bool is_request_lun_aligned(int64_t sector_num, int nb_sectors,
306 IscsiLun *iscsilun)
307{
308 if ((sector_num * BDRV_SECTOR_SIZE) % iscsilun->block_size ||
309 (nb_sectors * BDRV_SECTOR_SIZE) % iscsilun->block_size) {
f5075224
RJ
310 error_report("iSCSI misaligned request: "
311 "iscsilun->block_size %u, sector_num %" PRIi64
312 ", nb_sectors %d",
91bea4e2
PL
313 iscsilun->block_size, sector_num, nb_sectors);
314 return 0;
315 }
316 return 1;
317}
318
a9fe4c95
PL
319static unsigned long *iscsi_allocationmap_init(IscsiLun *iscsilun)
320{
321 return bitmap_try_new(DIV_ROUND_UP(sector_lun2qemu(iscsilun->num_blocks,
322 iscsilun),
323 iscsilun->cluster_sectors));
324}
325
b03c3805
PL
326static void iscsi_allocationmap_set(IscsiLun *iscsilun, int64_t sector_num,
327 int nb_sectors)
328{
329 if (iscsilun->allocationmap == NULL) {
330 return;
331 }
332 bitmap_set(iscsilun->allocationmap,
333 sector_num / iscsilun->cluster_sectors,
334 DIV_ROUND_UP(nb_sectors, iscsilun->cluster_sectors));
335}
336
337static void iscsi_allocationmap_clear(IscsiLun *iscsilun, int64_t sector_num,
338 int nb_sectors)
339{
340 int64_t cluster_num, nb_clusters;
341 if (iscsilun->allocationmap == NULL) {
342 return;
343 }
344 cluster_num = DIV_ROUND_UP(sector_num, iscsilun->cluster_sectors);
345 nb_clusters = (sector_num + nb_sectors) / iscsilun->cluster_sectors
346 - cluster_num;
347 if (nb_clusters > 0) {
348 bitmap_clear(iscsilun->allocationmap, cluster_num, nb_clusters);
349 }
350}
351
063c3378
PL
352static int coroutine_fn iscsi_co_writev(BlockDriverState *bs,
353 int64_t sector_num, int nb_sectors,
354 QEMUIOVector *iov)
c589b249 355{
063c3378
PL
356 IscsiLun *iscsilun = bs->opaque;
357 struct IscsiTask iTask;
f4dfa67f 358 uint64_t lba;
063c3378 359 uint32_t num_sectors;
c589b249 360
063c3378
PL
361 if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
362 return -EINVAL;
363 }
7371d56f 364
063c3378
PL
365 lba = sector_qemu2lun(sector_num, iscsilun);
366 num_sectors = sector_qemu2lun(nb_sectors, iscsilun);
063c3378
PL
367 iscsi_co_init_iscsitask(iscsilun, &iTask);
368retry:
9281fe9e
PL
369 if (iscsilun->use_16_for_rw) {
370 iTask.task = iscsi_write16_task(iscsilun->iscsi, iscsilun->lun, lba,
8c215a9f 371 NULL, num_sectors * iscsilun->block_size,
9281fe9e
PL
372 iscsilun->block_size, 0, 0, 0, 0, 0,
373 iscsi_co_generic_cb, &iTask);
374 } else {
375 iTask.task = iscsi_write10_task(iscsilun->iscsi, iscsilun->lun, lba,
8c215a9f 376 NULL, num_sectors * iscsilun->block_size,
9281fe9e
PL
377 iscsilun->block_size, 0, 0, 0, 0, 0,
378 iscsi_co_generic_cb, &iTask);
379 }
063c3378 380 if (iTask.task == NULL) {
92397116 381 return -ENOMEM;
f4dfa67f 382 }
063c3378
PL
383 scsi_task_set_iov_out(iTask.task, (struct scsi_iovec *) iov->iov,
384 iov->niov);
063c3378
PL
385 while (!iTask.complete) {
386 iscsi_set_events(iscsilun);
387 qemu_coroutine_yield();
c589b249
RS
388 }
389
063c3378
PL
390 if (iTask.task != NULL) {
391 scsi_free_scsi_task(iTask.task);
392 iTask.task = NULL;
91bea4e2
PL
393 }
394
063c3378 395 if (iTask.do_retry) {
837c3901 396 iTask.complete = 0;
063c3378 397 goto retry;
1dde716e
PL
398 }
399
063c3378
PL
400 if (iTask.status != SCSI_STATUS_GOOD) {
401 return -EIO;
c589b249
RS
402 }
403
b03c3805
PL
404 iscsi_allocationmap_set(iscsilun, sector_num, nb_sectors);
405
063c3378 406 return 0;
c589b249
RS
407}
408
b03c3805
PL
409
410static bool iscsi_allocationmap_is_allocated(IscsiLun *iscsilun,
411 int64_t sector_num, int nb_sectors)
412{
413 unsigned long size;
414 if (iscsilun->allocationmap == NULL) {
415 return true;
416 }
417 size = DIV_ROUND_UP(sector_num + nb_sectors, iscsilun->cluster_sectors);
418 return !(find_next_bit(iscsilun->allocationmap, size,
419 sector_num / iscsilun->cluster_sectors) == size);
420}
421
b03c3805
PL
422static int64_t coroutine_fn iscsi_co_get_block_status(BlockDriverState *bs,
423 int64_t sector_num,
424 int nb_sectors, int *pnum)
425{
426 IscsiLun *iscsilun = bs->opaque;
427 struct scsi_get_lba_status *lbas = NULL;
428 struct scsi_lba_status_descriptor *lbasd = NULL;
429 struct IscsiTask iTask;
430 int64_t ret;
431
432 iscsi_co_init_iscsitask(iscsilun, &iTask);
433
434 if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
435 ret = -EINVAL;
436 goto out;
437 }
438
439 /* default to all sectors allocated */
440 ret = BDRV_BLOCK_DATA;
441 ret |= (sector_num << BDRV_SECTOR_BITS) | BDRV_BLOCK_OFFSET_VALID;
442 *pnum = nb_sectors;
443
444 /* LUN does not support logical block provisioning */
445 if (iscsilun->lbpme == 0) {
446 goto out;
447 }
448
449retry:
450 if (iscsi_get_lba_status_task(iscsilun->iscsi, iscsilun->lun,
451 sector_qemu2lun(sector_num, iscsilun),
452 8 + 16, iscsi_co_generic_cb,
453 &iTask) == NULL) {
454 ret = -ENOMEM;
455 goto out;
456 }
457
458 while (!iTask.complete) {
459 iscsi_set_events(iscsilun);
460 qemu_coroutine_yield();
461 }
462
463 if (iTask.do_retry) {
464 if (iTask.task != NULL) {
465 scsi_free_scsi_task(iTask.task);
466 iTask.task = NULL;
467 }
468 iTask.complete = 0;
469 goto retry;
470 }
471
472 if (iTask.status != SCSI_STATUS_GOOD) {
473 /* in case the get_lba_status_callout fails (i.e.
474 * because the device is busy or the cmd is not
475 * supported) we pretend all blocks are allocated
476 * for backwards compatibility */
477 goto out;
478 }
479
480 lbas = scsi_datain_unmarshall(iTask.task);
481 if (lbas == NULL) {
482 ret = -EIO;
483 goto out;
484 }
485
486 lbasd = &lbas->descriptors[0];
487
488 if (sector_qemu2lun(sector_num, iscsilun) != lbasd->lba) {
489 ret = -EIO;
490 goto out;
491 }
492
493 *pnum = sector_lun2qemu(lbasd->num_blocks, iscsilun);
494
495 if (lbasd->provisioning == SCSI_PROVISIONING_TYPE_DEALLOCATED ||
496 lbasd->provisioning == SCSI_PROVISIONING_TYPE_ANCHORED) {
497 ret &= ~BDRV_BLOCK_DATA;
498 if (iscsilun->lbprz) {
499 ret |= BDRV_BLOCK_ZERO;
500 }
501 }
502
503 if (ret & BDRV_BLOCK_ZERO) {
504 iscsi_allocationmap_clear(iscsilun, sector_num, *pnum);
505 } else {
506 iscsi_allocationmap_set(iscsilun, sector_num, *pnum);
507 }
508
509 if (*pnum > nb_sectors) {
510 *pnum = nb_sectors;
511 }
512out:
513 if (iTask.task != NULL) {
514 scsi_free_scsi_task(iTask.task);
515 }
516 return ret;
517}
518
063c3378
PL
519static int coroutine_fn iscsi_co_readv(BlockDriverState *bs,
520 int64_t sector_num, int nb_sectors,
521 QEMUIOVector *iov)
c589b249 522{
063c3378
PL
523 IscsiLun *iscsilun = bs->opaque;
524 struct IscsiTask iTask;
1dde716e
PL
525 uint64_t lba;
526 uint32_t num_sectors;
c589b249 527
063c3378
PL
528 if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
529 return -EINVAL;
f4dfa67f 530 }
f4dfa67f 531
5917af81 532 if (iscsilun->lbprz && nb_sectors >= ISCSI_CHECKALLOC_THRES &&
b03c3805
PL
533 !iscsi_allocationmap_is_allocated(iscsilun, sector_num, nb_sectors)) {
534 int64_t ret;
535 int pnum;
536 ret = iscsi_co_get_block_status(bs, sector_num, INT_MAX, &pnum);
537 if (ret < 0) {
538 return ret;
539 }
540 if (ret & BDRV_BLOCK_ZERO && pnum >= nb_sectors) {
541 qemu_iovec_memset(iov, 0, 0x00, iov->size);
542 return 0;
543 }
544 }
b03c3805 545
063c3378
PL
546 lba = sector_qemu2lun(sector_num, iscsilun);
547 num_sectors = sector_qemu2lun(nb_sectors, iscsilun);
f4dfa67f 548
063c3378
PL
549 iscsi_co_init_iscsitask(iscsilun, &iTask);
550retry:
9281fe9e 551 if (iscsilun->use_16_for_rw) {
063c3378
PL
552 iTask.task = iscsi_read16_task(iscsilun->iscsi, iscsilun->lun, lba,
553 num_sectors * iscsilun->block_size,
554 iscsilun->block_size, 0, 0, 0, 0, 0,
555 iscsi_co_generic_cb, &iTask);
9281fe9e 556 } else {
063c3378
PL
557 iTask.task = iscsi_read10_task(iscsilun->iscsi, iscsilun->lun, lba,
558 num_sectors * iscsilun->block_size,
219c2521 559 iscsilun->block_size,
219c2521 560 0, 0, 0, 0, 0,
063c3378 561 iscsi_co_generic_cb, &iTask);
f4dfa67f 562 }
063c3378 563 if (iTask.task == NULL) {
92397116 564 return -ENOMEM;
c589b249 565 }
063c3378 566 scsi_task_set_iov_in(iTask.task, (struct scsi_iovec *) iov->iov, iov->niov);
91bea4e2 567
063c3378
PL
568 while (!iTask.complete) {
569 iscsi_set_events(iscsilun);
570 qemu_coroutine_yield();
1dde716e 571 }
c589b249 572
063c3378
PL
573 if (iTask.task != NULL) {
574 scsi_free_scsi_task(iTask.task);
575 iTask.task = NULL;
c589b249
RS
576 }
577
063c3378 578 if (iTask.do_retry) {
837c3901 579 iTask.complete = 0;
063c3378 580 goto retry;
c589b249
RS
581 }
582
063c3378
PL
583 if (iTask.status != SCSI_STATUS_GOOD) {
584 return -EIO;
1dde716e
PL
585 }
586
587 return 0;
588}
589
063c3378 590static int coroutine_fn iscsi_co_flush(BlockDriverState *bs)
1dde716e
PL
591{
592 IscsiLun *iscsilun = bs->opaque;
063c3378 593 struct IscsiTask iTask;
1dde716e 594
b2f9c08a
PB
595 if (bs->sg) {
596 return 0;
597 }
598
063c3378 599 iscsi_co_init_iscsitask(iscsilun, &iTask);
1dde716e 600
063c3378
PL
601retry:
602 if (iscsi_synchronizecache10_task(iscsilun->iscsi, iscsilun->lun, 0, 0, 0,
603 0, iscsi_co_generic_cb, &iTask) == NULL) {
92397116 604 return -ENOMEM;
063c3378 605 }
1dde716e 606
063c3378
PL
607 while (!iTask.complete) {
608 iscsi_set_events(iscsilun);
609 qemu_coroutine_yield();
610 }
1dde716e 611
063c3378
PL
612 if (iTask.task != NULL) {
613 scsi_free_scsi_task(iTask.task);
614 iTask.task = NULL;
c589b249
RS
615 }
616
063c3378 617 if (iTask.do_retry) {
837c3901 618 iTask.complete = 0;
063c3378
PL
619 goto retry;
620 }
c589b249 621
063c3378
PL
622 if (iTask.status != SCSI_STATUS_GOOD) {
623 return -EIO;
624 }
625
626 return 0;
c589b249
RS
627}
628
98392453
RS
629#ifdef __linux__
630static void
631iscsi_aio_ioctl_cb(struct iscsi_context *iscsi, int status,
632 void *command_data, void *opaque)
633{
634 IscsiAIOCB *acb = opaque;
635
0a53f010
RS
636 g_free(acb->buf);
637 acb->buf = NULL;
638
98392453
RS
639 acb->status = 0;
640 if (status < 0) {
641 error_report("Failed to ioctl(SG_IO) to iSCSI lun. %s",
642 iscsi_get_error(iscsi));
643 acb->status = -EIO;
644 }
645
646 acb->ioh->driver_status = 0;
647 acb->ioh->host_status = 0;
648 acb->ioh->resid = 0;
649
650#define SG_ERR_DRIVER_SENSE 0x08
651
652 if (status == SCSI_STATUS_CHECK_CONDITION && acb->task->datain.size >= 2) {
653 int ss;
654
655 acb->ioh->driver_status |= SG_ERR_DRIVER_SENSE;
656
657 acb->ioh->sb_len_wr = acb->task->datain.size - 2;
658 ss = (acb->ioh->mx_sb_len >= acb->ioh->sb_len_wr) ?
659 acb->ioh->mx_sb_len : acb->ioh->sb_len_wr;
660 memcpy(acb->ioh->sbp, &acb->task->datain.data[2], ss);
661 }
662
cfb3f506 663 iscsi_schedule_bh(acb);
98392453
RS
664}
665
7c84b1b8 666static BlockAIOCB *iscsi_aio_ioctl(BlockDriverState *bs,
98392453 667 unsigned long int req, void *buf,
097310b5 668 BlockCompletionFunc *cb, void *opaque)
98392453
RS
669{
670 IscsiLun *iscsilun = bs->opaque;
671 struct iscsi_context *iscsi = iscsilun->iscsi;
672 struct iscsi_data data;
673 IscsiAIOCB *acb;
674
675 assert(req == SG_IO);
676
d7331bed 677 acb = qemu_aio_get(&iscsi_aiocb_info, bs, cb, opaque);
98392453
RS
678
679 acb->iscsilun = iscsilun;
1bd075f2
PB
680 acb->bh = NULL;
681 acb->status = -EINPROGRESS;
98392453
RS
682 acb->buf = NULL;
683 acb->ioh = buf;
684
685 acb->task = malloc(sizeof(struct scsi_task));
686 if (acb->task == NULL) {
687 error_report("iSCSI: Failed to allocate task for scsi command. %s",
688 iscsi_get_error(iscsi));
8007429a 689 qemu_aio_unref(acb);
98392453
RS
690 return NULL;
691 }
692 memset(acb->task, 0, sizeof(struct scsi_task));
693
694 switch (acb->ioh->dxfer_direction) {
695 case SG_DXFER_TO_DEV:
696 acb->task->xfer_dir = SCSI_XFER_WRITE;
697 break;
698 case SG_DXFER_FROM_DEV:
699 acb->task->xfer_dir = SCSI_XFER_READ;
700 break;
701 default:
702 acb->task->xfer_dir = SCSI_XFER_NONE;
703 break;
704 }
705
706 acb->task->cdb_size = acb->ioh->cmd_len;
707 memcpy(&acb->task->cdb[0], acb->ioh->cmdp, acb->ioh->cmd_len);
708 acb->task->expxferlen = acb->ioh->dxfer_len;
709
0a53f010 710 data.size = 0;
98392453 711 if (acb->task->xfer_dir == SCSI_XFER_WRITE) {
0a53f010
RS
712 if (acb->ioh->iovec_count == 0) {
713 data.data = acb->ioh->dxferp;
714 data.size = acb->ioh->dxfer_len;
715 } else {
0a53f010
RS
716 scsi_task_set_iov_out(acb->task,
717 (struct scsi_iovec *) acb->ioh->dxferp,
718 acb->ioh->iovec_count);
0a53f010 719 }
98392453 720 }
0a53f010 721
98392453
RS
722 if (iscsi_scsi_command_async(iscsi, iscsilun->lun, acb->task,
723 iscsi_aio_ioctl_cb,
0a53f010 724 (data.size > 0) ? &data : NULL,
98392453
RS
725 acb) != 0) {
726 scsi_free_scsi_task(acb->task);
8007429a 727 qemu_aio_unref(acb);
98392453
RS
728 return NULL;
729 }
730
731 /* tell libiscsi to read straight into the buffer we got from ioctl */
732 if (acb->task->xfer_dir == SCSI_XFER_READ) {
0a53f010
RS
733 if (acb->ioh->iovec_count == 0) {
734 scsi_task_add_data_in_buffer(acb->task,
735 acb->ioh->dxfer_len,
736 acb->ioh->dxferp);
737 } else {
0a53f010
RS
738 scsi_task_set_iov_in(acb->task,
739 (struct scsi_iovec *) acb->ioh->dxferp,
740 acb->ioh->iovec_count);
0a53f010 741 }
98392453
RS
742 }
743
744 iscsi_set_events(iscsilun);
745
746 return &acb->common;
747}
748
f1a12821
RS
749static void ioctl_cb(void *opaque, int status)
750{
751 int *p_status = opaque;
752 *p_status = status;
753}
754
98392453
RS
755static int iscsi_ioctl(BlockDriverState *bs, unsigned long int req, void *buf)
756{
757 IscsiLun *iscsilun = bs->opaque;
f1a12821 758 int status;
98392453
RS
759
760 switch (req) {
761 case SG_GET_VERSION_NUM:
762 *(int *)buf = 30000;
763 break;
764 case SG_GET_SCSI_ID:
765 ((struct sg_scsi_id *)buf)->scsi_type = iscsilun->type;
766 break;
f1a12821
RS
767 case SG_IO:
768 status = -EINPROGRESS;
769 iscsi_aio_ioctl(bs, req, buf, ioctl_cb, &status);
770
771 while (status == -EINPROGRESS) {
80cf6257 772 aio_poll(iscsilun->aio_context, true);
f1a12821
RS
773 }
774
775 return 0;
98392453
RS
776 default:
777 return -1;
778 }
779 return 0;
780}
781#endif
782
c589b249
RS
783static int64_t
784iscsi_getlength(BlockDriverState *bs)
785{
786 IscsiLun *iscsilun = bs->opaque;
787 int64_t len;
788
789 len = iscsilun->num_blocks;
790 len *= iscsilun->block_size;
791
792 return len;
793}
794
65f3e339
PL
795static int
796coroutine_fn iscsi_co_discard(BlockDriverState *bs, int64_t sector_num,
797 int nb_sectors)
798{
799 IscsiLun *iscsilun = bs->opaque;
800 struct IscsiTask iTask;
801 struct unmap_list list;
65f3e339
PL
802
803 if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
804 return -EINVAL;
805 }
806
807 if (!iscsilun->lbp.lbpu) {
808 /* UNMAP is not supported by the target */
809 return 0;
810 }
811
812 list.lba = sector_qemu2lun(sector_num, iscsilun);
01a6a238 813 list.num = sector_qemu2lun(nb_sectors, iscsilun);
65f3e339 814
01a6a238 815 iscsi_co_init_iscsitask(iscsilun, &iTask);
65f3e339 816retry:
01a6a238
PL
817 if (iscsi_unmap_task(iscsilun->iscsi, iscsilun->lun, 0, 0, &list, 1,
818 iscsi_co_generic_cb, &iTask) == NULL) {
92397116 819 return -ENOMEM;
01a6a238 820 }
65f3e339 821
01a6a238
PL
822 while (!iTask.complete) {
823 iscsi_set_events(iscsilun);
824 qemu_coroutine_yield();
825 }
65f3e339 826
01a6a238
PL
827 if (iTask.task != NULL) {
828 scsi_free_scsi_task(iTask.task);
829 iTask.task = NULL;
830 }
65f3e339 831
01a6a238 832 if (iTask.do_retry) {
837c3901 833 iTask.complete = 0;
01a6a238
PL
834 goto retry;
835 }
65f3e339 836
01a6a238
PL
837 if (iTask.status == SCSI_STATUS_CHECK_CONDITION) {
838 /* the target might fail with a check condition if it
839 is not happy with the alignment of the UNMAP request
840 we silently fail in this case */
841 return 0;
842 }
65f3e339 843
01a6a238
PL
844 if (iTask.status != SCSI_STATUS_GOOD) {
845 return -EIO;
65f3e339
PL
846 }
847
b03c3805
PL
848 iscsi_allocationmap_clear(iscsilun, sector_num, nb_sectors);
849
65f3e339
PL
850 return 0;
851}
852
d4cd9615
PL
853static int
854coroutine_fn iscsi_co_write_zeroes(BlockDriverState *bs, int64_t sector_num,
855 int nb_sectors, BdrvRequestFlags flags)
856{
857 IscsiLun *iscsilun = bs->opaque;
858 struct IscsiTask iTask;
859 uint64_t lba;
860 uint32_t nb_blocks;
9281fe9e 861 bool use_16_for_ws = iscsilun->use_16_for_rw;
d4cd9615
PL
862
863 if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
864 return -EINVAL;
865 }
866
9281fe9e
PL
867 if (flags & BDRV_REQ_MAY_UNMAP) {
868 if (!use_16_for_ws && !iscsilun->lbp.lbpws10) {
869 /* WRITESAME10 with UNMAP is unsupported try WRITESAME16 */
870 use_16_for_ws = true;
871 }
872 if (use_16_for_ws && !iscsilun->lbp.lbpws) {
873 /* WRITESAME16 with UNMAP is not supported by the target,
874 * fall back and try WRITESAME10/16 without UNMAP */
875 flags &= ~BDRV_REQ_MAY_UNMAP;
876 use_16_for_ws = iscsilun->use_16_for_rw;
877 }
fa6252b0
PB
878 }
879
dbe5c58f 880 if (!(flags & BDRV_REQ_MAY_UNMAP) && !iscsilun->has_write_same) {
9281fe9e 881 /* WRITESAME without UNMAP is not supported by the target */
d4cd9615
PL
882 return -ENOTSUP;
883 }
884
885 lba = sector_qemu2lun(sector_num, iscsilun);
886 nb_blocks = sector_qemu2lun(nb_sectors, iscsilun);
887
888 if (iscsilun->zeroblock == NULL) {
4d5a3f88
KW
889 iscsilun->zeroblock = g_try_malloc0(iscsilun->block_size);
890 if (iscsilun->zeroblock == NULL) {
891 return -ENOMEM;
892 }
d4cd9615
PL
893 }
894
895 iscsi_co_init_iscsitask(iscsilun, &iTask);
896retry:
9281fe9e
PL
897 if (use_16_for_ws) {
898 iTask.task = iscsi_writesame16_task(iscsilun->iscsi, iscsilun->lun, lba,
899 iscsilun->zeroblock, iscsilun->block_size,
900 nb_blocks, 0, !!(flags & BDRV_REQ_MAY_UNMAP),
901 0, 0, iscsi_co_generic_cb, &iTask);
902 } else {
903 iTask.task = iscsi_writesame10_task(iscsilun->iscsi, iscsilun->lun, lba,
904 iscsilun->zeroblock, iscsilun->block_size,
905 nb_blocks, 0, !!(flags & BDRV_REQ_MAY_UNMAP),
906 0, 0, iscsi_co_generic_cb, &iTask);
907 }
908 if (iTask.task == NULL) {
92397116 909 return -ENOMEM;
d4cd9615
PL
910 }
911
912 while (!iTask.complete) {
913 iscsi_set_events(iscsilun);
914 qemu_coroutine_yield();
915 }
916
d9738fd2
PL
917 if (iTask.status == SCSI_STATUS_CHECK_CONDITION &&
918 iTask.task->sense.key == SCSI_SENSE_ILLEGAL_REQUEST &&
27898a5d
PB
919 (iTask.task->sense.ascq == SCSI_SENSE_ASCQ_INVALID_OPERATION_CODE ||
920 iTask.task->sense.ascq == SCSI_SENSE_ASCQ_INVALID_FIELD_IN_CDB)) {
d9738fd2
PL
921 /* WRITE SAME is not supported by the target */
922 iscsilun->has_write_same = false;
923 scsi_free_scsi_task(iTask.task);
924 return -ENOTSUP;
925 }
926
d4cd9615
PL
927 if (iTask.task != NULL) {
928 scsi_free_scsi_task(iTask.task);
929 iTask.task = NULL;
930 }
931
932 if (iTask.do_retry) {
837c3901 933 iTask.complete = 0;
d4cd9615
PL
934 goto retry;
935 }
936
937 if (iTask.status != SCSI_STATUS_GOOD) {
938 return -EIO;
939 }
940
b03c3805
PL
941 if (flags & BDRV_REQ_MAY_UNMAP) {
942 iscsi_allocationmap_clear(iscsilun, sector_num, nb_sectors);
943 } else {
944 iscsi_allocationmap_set(iscsilun, sector_num, nb_sectors);
945 }
946
d4cd9615
PL
947 return 0;
948}
949
f2917853
PB
950static void parse_chap(struct iscsi_context *iscsi, const char *target,
951 Error **errp)
f9dadc98
RS
952{
953 QemuOptsList *list;
954 QemuOpts *opts;
955 const char *user = NULL;
956 const char *password = NULL;
957
958 list = qemu_find_opts("iscsi");
959 if (!list) {
f2917853 960 return;
f9dadc98
RS
961 }
962
963 opts = qemu_opts_find(list, target);
964 if (opts == NULL) {
965 opts = QTAILQ_FIRST(&list->head);
966 if (!opts) {
f2917853 967 return;
f9dadc98
RS
968 }
969 }
970
971 user = qemu_opt_get(opts, "user");
972 if (!user) {
f2917853 973 return;
f9dadc98
RS
974 }
975
976 password = qemu_opt_get(opts, "password");
977 if (!password) {
f2917853
PB
978 error_setg(errp, "CHAP username specified but no password was given");
979 return;
f9dadc98
RS
980 }
981
982 if (iscsi_set_initiator_username_pwd(iscsi, user, password)) {
f2917853 983 error_setg(errp, "Failed to set initiator username and password");
f9dadc98 984 }
f9dadc98
RS
985}
986
f2917853
PB
987static void parse_header_digest(struct iscsi_context *iscsi, const char *target,
988 Error **errp)
f9dadc98
RS
989{
990 QemuOptsList *list;
991 QemuOpts *opts;
992 const char *digest = NULL;
993
994 list = qemu_find_opts("iscsi");
995 if (!list) {
996 return;
997 }
998
999 opts = qemu_opts_find(list, target);
1000 if (opts == NULL) {
1001 opts = QTAILQ_FIRST(&list->head);
1002 if (!opts) {
1003 return;
1004 }
1005 }
1006
1007 digest = qemu_opt_get(opts, "header-digest");
1008 if (!digest) {
1009 return;
1010 }
1011
1012 if (!strcmp(digest, "CRC32C")) {
1013 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_CRC32C);
1014 } else if (!strcmp(digest, "NONE")) {
1015 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE);
1016 } else if (!strcmp(digest, "CRC32C-NONE")) {
1017 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_CRC32C_NONE);
1018 } else if (!strcmp(digest, "NONE-CRC32C")) {
1019 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE_CRC32C);
1020 } else {
f2917853 1021 error_setg(errp, "Invalid header-digest setting : %s", digest);
f9dadc98
RS
1022 }
1023}
1024
1025static char *parse_initiator_name(const char *target)
1026{
1027 QemuOptsList *list;
1028 QemuOpts *opts;
5accc840
PB
1029 const char *name;
1030 char *iscsi_name;
1031 UuidInfo *uuid_info;
f9dadc98
RS
1032
1033 list = qemu_find_opts("iscsi");
f2ef4a6d
PB
1034 if (list) {
1035 opts = qemu_opts_find(list, target);
f9dadc98 1036 if (!opts) {
f2ef4a6d
PB
1037 opts = QTAILQ_FIRST(&list->head);
1038 }
1039 if (opts) {
1040 name = qemu_opt_get(opts, "initiator-name");
5accc840
PB
1041 if (name) {
1042 return g_strdup(name);
1043 }
f9dadc98
RS
1044 }
1045 }
1046
5accc840
PB
1047 uuid_info = qmp_query_uuid(NULL);
1048 if (strcmp(uuid_info->UUID, UUID_NONE) == 0) {
1049 name = qemu_get_vm_name();
f2ef4a6d 1050 } else {
5accc840 1051 name = uuid_info->UUID;
f9dadc98 1052 }
5accc840
PB
1053 iscsi_name = g_strdup_printf("iqn.2008-11.org.linux-kvm%s%s",
1054 name ? ":" : "", name ? name : "");
1055 qapi_free_UuidInfo(uuid_info);
1056 return iscsi_name;
f9dadc98
RS
1057}
1058
5b5d34ec
PL
1059static void iscsi_nop_timed_event(void *opaque)
1060{
1061 IscsiLun *iscsilun = opaque;
1062
1063 if (iscsi_get_nops_in_flight(iscsilun->iscsi) > MAX_NOP_FAILURES) {
1064 error_report("iSCSI: NOP timeout. Reconnecting...");
1065 iscsi_reconnect(iscsilun->iscsi);
1066 }
1067
1068 if (iscsi_nop_out_async(iscsilun->iscsi, NULL, NULL, 0, NULL) != 0) {
1069 error_report("iSCSI: failed to sent NOP-Out. Disabling NOP messages.");
1070 return;
1071 }
1072
bc72ad67 1073 timer_mod(iscsilun->nop_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + NOP_INTERVAL);
5b5d34ec
PL
1074 iscsi_set_events(iscsilun);
1075}
5b5d34ec 1076
f2917853 1077static void iscsi_readcapacity_sync(IscsiLun *iscsilun, Error **errp)
cb1b83e7
PL
1078{
1079 struct scsi_task *task = NULL;
1080 struct scsi_readcapacity10 *rc10 = NULL;
1081 struct scsi_readcapacity16 *rc16 = NULL;
cb1b83e7
PL
1082 int retries = ISCSI_CMD_RETRIES;
1083
1288844e
PB
1084 do {
1085 if (task != NULL) {
1086 scsi_free_scsi_task(task);
1087 task = NULL;
cb1b83e7 1088 }
1288844e
PB
1089
1090 switch (iscsilun->type) {
1091 case TYPE_DISK:
1092 task = iscsi_readcapacity16_sync(iscsilun->iscsi, iscsilun->lun);
1093 if (task != NULL && task->status == SCSI_STATUS_GOOD) {
1094 rc16 = scsi_datain_unmarshall(task);
1095 if (rc16 == NULL) {
f2917853 1096 error_setg(errp, "iSCSI: Failed to unmarshall readcapacity16 data.");
1288844e
PB
1097 } else {
1098 iscsilun->block_size = rc16->block_length;
1099 iscsilun->num_blocks = rc16->returned_lba + 1;
f18a7cbb
PL
1100 iscsilun->lbpme = rc16->lbpme;
1101 iscsilun->lbprz = rc16->lbprz;
9281fe9e 1102 iscsilun->use_16_for_rw = (rc16->returned_lba > 0xffffffff);
1288844e
PB
1103 }
1104 }
1105 break;
1106 case TYPE_ROM:
1107 task = iscsi_readcapacity10_sync(iscsilun->iscsi, iscsilun->lun, 0, 0);
1108 if (task != NULL && task->status == SCSI_STATUS_GOOD) {
1109 rc10 = scsi_datain_unmarshall(task);
1110 if (rc10 == NULL) {
f2917853 1111 error_setg(errp, "iSCSI: Failed to unmarshall readcapacity10 data.");
1288844e
PB
1112 } else {
1113 iscsilun->block_size = rc10->block_size;
1114 if (rc10->lba == 0) {
1115 /* blank disk loaded */
1116 iscsilun->num_blocks = 0;
1117 } else {
1118 iscsilun->num_blocks = rc10->lba + 1;
1119 }
1120 }
1121 }
1122 break;
1123 default:
f2917853 1124 return;
cb1b83e7 1125 }
1288844e
PB
1126 } while (task != NULL && task->status == SCSI_STATUS_CHECK_CONDITION
1127 && task->sense.key == SCSI_SENSE_UNIT_ATTENTION
1128 && retries-- > 0);
cb1b83e7 1129
1288844e 1130 if (task == NULL || task->status != SCSI_STATUS_GOOD) {
f2917853 1131 error_setg(errp, "iSCSI: failed to send readcapacity10 command.");
1288844e 1132 }
cb1b83e7
PL
1133 if (task) {
1134 scsi_free_scsi_task(task);
1135 }
cb1b83e7
PL
1136}
1137
60beb341
KW
1138/* TODO Convert to fine grained options */
1139static QemuOptsList runtime_opts = {
1140 .name = "iscsi",
1141 .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
1142 .desc = {
1143 {
1144 .name = "filename",
1145 .type = QEMU_OPT_STRING,
1146 .help = "URL to the iscsi image",
1147 },
1148 { /* end of list */ }
1149 },
1150};
1151
35cb1748 1152static struct scsi_task *iscsi_do_inquiry(struct iscsi_context *iscsi, int lun,
24d3bd67 1153 int evpd, int pc, void **inq, Error **errp)
35cb1748
PB
1154{
1155 int full_size;
1156 struct scsi_task *task = NULL;
1157 task = iscsi_inquiry_sync(iscsi, lun, evpd, pc, 64);
1158 if (task == NULL || task->status != SCSI_STATUS_GOOD) {
1159 goto fail;
1160 }
1161 full_size = scsi_datain_getfullsize(task);
1162 if (full_size > task->datain.size) {
1163 scsi_free_scsi_task(task);
1164
1165 /* we need more data for the full list */
1166 task = iscsi_inquiry_sync(iscsi, lun, evpd, pc, full_size);
f18a7cbb
PL
1167 if (task == NULL || task->status != SCSI_STATUS_GOOD) {
1168 goto fail;
1169 }
35cb1748 1170 }
f18a7cbb 1171
24d3bd67
PL
1172 *inq = scsi_datain_unmarshall(task);
1173 if (*inq == NULL) {
1174 error_setg(errp, "iSCSI: failed to unmarshall inquiry datain blob");
172fc4dd 1175 goto fail_with_err;
24d3bd67
PL
1176 }
1177
35cb1748 1178 return task;
f18a7cbb
PL
1179
1180fail:
172fc4dd
MA
1181 error_setg(errp, "iSCSI: Inquiry command failed : %s",
1182 iscsi_get_error(iscsi));
1183fail_with_err:
24d3bd67 1184 if (task != NULL) {
35cb1748 1185 scsi_free_scsi_task(task);
35cb1748
PB
1186 }
1187 return NULL;
f18a7cbb
PL
1188}
1189
80cf6257
SH
1190static void iscsi_detach_aio_context(BlockDriverState *bs)
1191{
1192 IscsiLun *iscsilun = bs->opaque;
1193
1194 aio_set_fd_handler(iscsilun->aio_context,
1195 iscsi_get_fd(iscsilun->iscsi),
1196 NULL, NULL, NULL);
1197 iscsilun->events = 0;
1198
1199 if (iscsilun->nop_timer) {
1200 timer_del(iscsilun->nop_timer);
1201 timer_free(iscsilun->nop_timer);
1202 iscsilun->nop_timer = NULL;
1203 }
1204}
1205
1206static void iscsi_attach_aio_context(BlockDriverState *bs,
1207 AioContext *new_context)
1208{
1209 IscsiLun *iscsilun = bs->opaque;
1210
1211 iscsilun->aio_context = new_context;
1212 iscsi_set_events(iscsilun);
1213
80cf6257
SH
1214 /* Set up a timer for sending out iSCSI NOPs */
1215 iscsilun->nop_timer = aio_timer_new(iscsilun->aio_context,
1216 QEMU_CLOCK_REALTIME, SCALE_MS,
1217 iscsi_nop_timed_event, iscsilun);
1218 timer_mod(iscsilun->nop_timer,
1219 qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + NOP_INTERVAL);
80cf6257
SH
1220}
1221
c589b249
RS
1222/*
1223 * We support iscsi url's on the form
1224 * iscsi://[<username>%<password>@]<host>[:<port>]/<targetname>/<lun>
28f106af
JC
1225 *
1226 * Note: flags are currently not used by iscsi_open. If this function
1227 * is changed such that flags are used, please examine iscsi_reopen_prepare()
1228 * to see if needs to be changed as well.
c589b249 1229 */
015a1036
HR
1230static int iscsi_open(BlockDriverState *bs, QDict *options, int flags,
1231 Error **errp)
c589b249
RS
1232{
1233 IscsiLun *iscsilun = bs->opaque;
1234 struct iscsi_context *iscsi = NULL;
1235 struct iscsi_url *iscsi_url = NULL;
e829b0bb
PL
1236 struct scsi_task *task = NULL;
1237 struct scsi_inquiry_standard *inq = NULL;
24d3bd67 1238 struct scsi_inquiry_supported_pages *inq_vpd;
f9dadc98 1239 char *initiator_name = NULL;
60beb341
KW
1240 QemuOpts *opts;
1241 Error *local_err = NULL;
1242 const char *filename;
24d3bd67 1243 int i, ret;
c589b249
RS
1244
1245 if ((BDRV_SECTOR_SIZE % 512) != 0) {
f2917853
PB
1246 error_setg(errp, "iSCSI: Invalid BDRV_SECTOR_SIZE. "
1247 "BDRV_SECTOR_SIZE(%lld) is not a multiple "
1248 "of 512", BDRV_SECTOR_SIZE);
c589b249
RS
1249 return -EINVAL;
1250 }
1251
87ea75d5 1252 opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
60beb341 1253 qemu_opts_absorb_qdict(opts, options, &local_err);
84d18f06 1254 if (local_err) {
f2917853 1255 error_propagate(errp, local_err);
60beb341
KW
1256 ret = -EINVAL;
1257 goto out;
1258 }
1259
1260 filename = qemu_opt_get(opts, "filename");
1261
c589b249
RS
1262 iscsi_url = iscsi_parse_full_url(iscsi, filename);
1263 if (iscsi_url == NULL) {
f2917853 1264 error_setg(errp, "Failed to parse URL : %s", filename);
c589b249 1265 ret = -EINVAL;
b93c94f7 1266 goto out;
c589b249
RS
1267 }
1268
f9dadc98
RS
1269 memset(iscsilun, 0, sizeof(IscsiLun));
1270
1271 initiator_name = parse_initiator_name(iscsi_url->target);
1272
1273 iscsi = iscsi_create_context(initiator_name);
1274 if (iscsi == NULL) {
f2917853 1275 error_setg(errp, "iSCSI: Failed to create iSCSI context.");
f9dadc98 1276 ret = -ENOMEM;
b93c94f7 1277 goto out;
f9dadc98
RS
1278 }
1279
c589b249 1280 if (iscsi_set_targetname(iscsi, iscsi_url->target)) {
f2917853 1281 error_setg(errp, "iSCSI: Failed to set target name.");
c589b249 1282 ret = -EINVAL;
b93c94f7 1283 goto out;
c589b249
RS
1284 }
1285
1286 if (iscsi_url->user != NULL) {
1287 ret = iscsi_set_initiator_username_pwd(iscsi, iscsi_url->user,
1288 iscsi_url->passwd);
1289 if (ret != 0) {
f2917853 1290 error_setg(errp, "Failed to set initiator username and password");
c589b249 1291 ret = -EINVAL;
b93c94f7 1292 goto out;
c589b249
RS
1293 }
1294 }
f9dadc98
RS
1295
1296 /* check if we got CHAP username/password via the options */
f2917853
PB
1297 parse_chap(iscsi, iscsi_url->target, &local_err);
1298 if (local_err != NULL) {
1299 error_propagate(errp, local_err);
f9dadc98 1300 ret = -EINVAL;
b93c94f7 1301 goto out;
f9dadc98
RS
1302 }
1303
c589b249 1304 if (iscsi_set_session_type(iscsi, ISCSI_SESSION_NORMAL) != 0) {
f2917853 1305 error_setg(errp, "iSCSI: Failed to set session type to normal.");
c589b249 1306 ret = -EINVAL;
b93c94f7 1307 goto out;
c589b249
RS
1308 }
1309
1310 iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE_CRC32C);
1311
f9dadc98 1312 /* check if we got HEADER_DIGEST via the options */
f2917853
PB
1313 parse_header_digest(iscsi, iscsi_url->target, &local_err);
1314 if (local_err != NULL) {
1315 error_propagate(errp, local_err);
1316 ret = -EINVAL;
1317 goto out;
1318 }
f9dadc98 1319
e829b0bb 1320 if (iscsi_full_connect_sync(iscsi, iscsi_url->portal, iscsi_url->lun) != 0) {
f2917853 1321 error_setg(errp, "iSCSI: Failed to connect to LUN : %s",
e829b0bb
PL
1322 iscsi_get_error(iscsi));
1323 ret = -EINVAL;
1324 goto out;
1325 }
c589b249
RS
1326
1327 iscsilun->iscsi = iscsi;
80cf6257 1328 iscsilun->aio_context = bdrv_get_aio_context(bs);
c589b249 1329 iscsilun->lun = iscsi_url->lun;
24d3bd67 1330 iscsilun->has_write_same = true;
c589b249 1331
24d3bd67
PL
1332 task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 0, 0,
1333 (void **) &inq, errp);
1334 if (task == NULL) {
c589b249 1335 ret = -EINVAL;
b93c94f7 1336 goto out;
c589b249 1337 }
e829b0bb 1338 iscsilun->type = inq->periperal_device_type;
24d3bd67
PL
1339 scsi_free_scsi_task(task);
1340 task = NULL;
e829b0bb 1341
f2917853
PB
1342 iscsi_readcapacity_sync(iscsilun, &local_err);
1343 if (local_err != NULL) {
1344 error_propagate(errp, local_err);
cd82b6fb 1345 ret = -EINVAL;
cb1b83e7 1346 goto out;
e829b0bb 1347 }
0777b5dd 1348 bs->total_sectors = sector_lun2qemu(iscsilun->num_blocks, iscsilun);
2c9880c4 1349 bs->request_alignment = iscsilun->block_size;
e829b0bb 1350
f47c3f5a
KW
1351 /* We don't have any emulation for devices other than disks and CD-ROMs, so
1352 * this must be sg ioctl compatible. We force it to be sg, otherwise qemu
1353 * will try to read from the device to guess the image format.
622695a4 1354 */
f47c3f5a 1355 if (iscsilun->type != TYPE_DISK && iscsilun->type != TYPE_ROM) {
622695a4
RS
1356 bs->sg = 1;
1357 }
1358
24d3bd67
PL
1359 task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
1360 SCSI_INQUIRY_PAGECODE_SUPPORTED_VPD_PAGES,
1361 (void **) &inq_vpd, errp);
1362 if (task == NULL) {
1363 ret = -EINVAL;
1364 goto out;
f18a7cbb 1365 }
24d3bd67
PL
1366 for (i = 0; i < inq_vpd->num_pages; i++) {
1367 struct scsi_task *inq_task;
1368 struct scsi_inquiry_logical_block_provisioning *inq_lbp;
f18a7cbb 1369 struct scsi_inquiry_block_limits *inq_bl;
24d3bd67
PL
1370 switch (inq_vpd->pages[i]) {
1371 case SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING:
1372 inq_task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
1373 SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING,
1374 (void **) &inq_lbp, errp);
1375 if (inq_task == NULL) {
1376 ret = -EINVAL;
1377 goto out;
1378 }
1379 memcpy(&iscsilun->lbp, inq_lbp,
1380 sizeof(struct scsi_inquiry_logical_block_provisioning));
1381 scsi_free_scsi_task(inq_task);
1382 break;
1383 case SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS:
1384 inq_task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
1385 SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS,
1386 (void **) &inq_bl, errp);
1387 if (inq_task == NULL) {
1388 ret = -EINVAL;
1389 goto out;
1390 }
1391 memcpy(&iscsilun->bl, inq_bl,
1392 sizeof(struct scsi_inquiry_block_limits));
1393 scsi_free_scsi_task(inq_task);
1394 break;
1395 default:
1396 break;
f18a7cbb 1397 }
f18a7cbb 1398 }
24d3bd67
PL
1399 scsi_free_scsi_task(task);
1400 task = NULL;
f18a7cbb 1401
80cf6257 1402 iscsi_attach_aio_context(bs, iscsilun->aio_context);
5b5d34ec 1403
b03c3805
PL
1404 /* Guess the internal cluster (page) size of the iscsi target by the means
1405 * of opt_unmap_gran. Transfer the unmap granularity only if it has a
1406 * reasonable size */
3d2acaa3 1407 if (iscsilun->bl.opt_unmap_gran * iscsilun->block_size >= 4 * 1024 &&
b03c3805
PL
1408 iscsilun->bl.opt_unmap_gran * iscsilun->block_size <= 16 * 1024 * 1024) {
1409 iscsilun->cluster_sectors = (iscsilun->bl.opt_unmap_gran *
1410 iscsilun->block_size) >> BDRV_SECTOR_BITS;
b03c3805 1411 if (iscsilun->lbprz && !(bs->open_flags & BDRV_O_NOCACHE)) {
a9fe4c95
PL
1412 iscsilun->allocationmap = iscsi_allocationmap_init(iscsilun);
1413 if (iscsilun->allocationmap == NULL) {
1414 ret = -ENOMEM;
1415 }
b03c3805 1416 }
b03c3805
PL
1417 }
1418
b93c94f7 1419out:
60beb341 1420 qemu_opts_del(opts);
f7047c2d 1421 g_free(initiator_name);
c589b249
RS
1422 if (iscsi_url != NULL) {
1423 iscsi_destroy_url(iscsi_url);
1424 }
e829b0bb
PL
1425 if (task != NULL) {
1426 scsi_free_scsi_task(task);
1427 }
b93c94f7
PB
1428
1429 if (ret) {
1430 if (iscsi != NULL) {
1431 iscsi_destroy_context(iscsi);
1432 }
1433 memset(iscsilun, 0, sizeof(IscsiLun));
c589b249 1434 }
c589b249
RS
1435 return ret;
1436}
1437
1438static void iscsi_close(BlockDriverState *bs)
1439{
1440 IscsiLun *iscsilun = bs->opaque;
1441 struct iscsi_context *iscsi = iscsilun->iscsi;
1442
80cf6257 1443 iscsi_detach_aio_context(bs);
c589b249 1444 iscsi_destroy_context(iscsi);
d4cd9615 1445 g_free(iscsilun->zeroblock);
b03c3805 1446 g_free(iscsilun->allocationmap);
c589b249
RS
1447 memset(iscsilun, 0, sizeof(IscsiLun));
1448}
1449
3baca891 1450static void iscsi_refresh_limits(BlockDriverState *bs, Error **errp)
d34682cd
KW
1451{
1452 IscsiLun *iscsilun = bs->opaque;
1453
1454 /* We don't actually refresh here, but just return data queried in
1455 * iscsi_open(): iscsi targets don't change their limits. */
c97ca29d 1456 if (iscsilun->lbp.lbpu) {
d34682cd
KW
1457 if (iscsilun->bl.max_unmap < 0xffffffff) {
1458 bs->bl.max_discard = sector_lun2qemu(iscsilun->bl.max_unmap,
1459 iscsilun);
1460 }
1461 bs->bl.discard_alignment = sector_lun2qemu(iscsilun->bl.opt_unmap_gran,
1462 iscsilun);
c97ca29d 1463 }
d34682cd 1464
c97ca29d
PB
1465 if (iscsilun->bl.max_ws_len < 0xffffffff) {
1466 bs->bl.max_write_zeroes = sector_lun2qemu(iscsilun->bl.max_ws_len,
1467 iscsilun);
1468 }
1469 if (iscsilun->lbp.lbpws) {
d34682cd
KW
1470 bs->bl.write_zeroes_alignment = sector_lun2qemu(iscsilun->bl.opt_unmap_gran,
1471 iscsilun);
d34682cd 1472 }
5d259fc7
PL
1473 bs->bl.opt_transfer_length = sector_lun2qemu(iscsilun->bl.opt_xfer_len,
1474 iscsilun);
e9f526ab 1475}
d34682cd 1476
28f106af
JC
1477/* Since iscsi_open() ignores bdrv_flags, there is nothing to do here in
1478 * prepare. Note that this will not re-establish a connection with an iSCSI
1479 * target - it is effectively a NOP. */
dc6afb99
JC
1480static int iscsi_reopen_prepare(BDRVReopenState *state,
1481 BlockReopenQueue *queue, Error **errp)
1482{
28f106af 1483 /* NOP */
d34682cd
KW
1484 return 0;
1485}
1486
cb1b83e7
PL
1487static int iscsi_truncate(BlockDriverState *bs, int64_t offset)
1488{
1489 IscsiLun *iscsilun = bs->opaque;
f2917853 1490 Error *local_err = NULL;
cb1b83e7
PL
1491
1492 if (iscsilun->type != TYPE_DISK) {
1493 return -ENOTSUP;
1494 }
1495
f2917853
PB
1496 iscsi_readcapacity_sync(iscsilun, &local_err);
1497 if (local_err != NULL) {
1498 error_free(local_err);
1499 return -EIO;
cb1b83e7
PL
1500 }
1501
1502 if (offset > iscsi_getlength(bs)) {
1503 return -EINVAL;
1504 }
1505
b03c3805
PL
1506 if (iscsilun->allocationmap != NULL) {
1507 g_free(iscsilun->allocationmap);
a9fe4c95 1508 iscsilun->allocationmap = iscsi_allocationmap_init(iscsilun);
b03c3805
PL
1509 }
1510
cb1b83e7
PL
1511 return 0;
1512}
1513
a59479e3 1514static int iscsi_create(const char *filename, QemuOpts *opts, Error **errp)
de8864e5
PL
1515{
1516 int ret = 0;
1517 int64_t total_size = 0;
13c91cb7 1518 BlockDriverState *bs;
de8864e5 1519 IscsiLun *iscsilun = NULL;
60beb341 1520 QDict *bs_options;
de8864e5 1521
e4e9986b 1522 bs = bdrv_new();
de8864e5
PL
1523
1524 /* Read out options */
c2eb918e
HT
1525 total_size = DIV_ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
1526 BDRV_SECTOR_SIZE);
5839e53b 1527 bs->opaque = g_new0(struct IscsiLun, 1);
13c91cb7 1528 iscsilun = bs->opaque;
de8864e5 1529
60beb341
KW
1530 bs_options = qdict_new();
1531 qdict_put(bs_options, "filename", qstring_from_str(filename));
015a1036 1532 ret = iscsi_open(bs, bs_options, 0, NULL);
60beb341
KW
1533 QDECREF(bs_options);
1534
de8864e5
PL
1535 if (ret != 0) {
1536 goto out;
1537 }
80cf6257 1538 iscsi_detach_aio_context(bs);
de8864e5
PL
1539 if (iscsilun->type != TYPE_DISK) {
1540 ret = -ENODEV;
1541 goto out;
1542 }
13c91cb7 1543 if (bs->total_sectors < total_size) {
de8864e5 1544 ret = -ENOSPC;
d3bda7bc 1545 goto out;
de8864e5
PL
1546 }
1547
1548 ret = 0;
1549out:
1550 if (iscsilun->iscsi != NULL) {
1551 iscsi_destroy_context(iscsilun->iscsi);
1552 }
13c91cb7
FZ
1553 g_free(bs->opaque);
1554 bs->opaque = NULL;
4f6fd349 1555 bdrv_unref(bs);
de8864e5
PL
1556 return ret;
1557}
1558
186d4f2b
PL
1559static int iscsi_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
1560{
1561 IscsiLun *iscsilun = bs->opaque;
1562 bdi->unallocated_blocks_are_zero = !!iscsilun->lbprz;
1563 bdi->can_write_zeroes_with_unmap = iscsilun->lbprz && iscsilun->lbp.lbpws;
b03c3805 1564 bdi->cluster_size = iscsilun->cluster_sectors * BDRV_SECTOR_SIZE;
186d4f2b
PL
1565 return 0;
1566}
1567
a59479e3
CL
1568static QemuOptsList iscsi_create_opts = {
1569 .name = "iscsi-create-opts",
1570 .head = QTAILQ_HEAD_INITIALIZER(iscsi_create_opts.head),
1571 .desc = {
1572 {
1573 .name = BLOCK_OPT_SIZE,
1574 .type = QEMU_OPT_SIZE,
1575 .help = "Virtual disk size"
1576 },
1577 { /* end of list */ }
1578 }
de8864e5
PL
1579};
1580
c589b249
RS
1581static BlockDriver bdrv_iscsi = {
1582 .format_name = "iscsi",
1583 .protocol_name = "iscsi",
1584
1585 .instance_size = sizeof(IscsiLun),
030be321 1586 .bdrv_needs_filename = true,
c589b249
RS
1587 .bdrv_file_open = iscsi_open,
1588 .bdrv_close = iscsi_close,
c282e1fd 1589 .bdrv_create = iscsi_create,
a59479e3 1590 .create_opts = &iscsi_create_opts,
dc6afb99 1591 .bdrv_reopen_prepare = iscsi_reopen_prepare,
c589b249
RS
1592
1593 .bdrv_getlength = iscsi_getlength,
186d4f2b 1594 .bdrv_get_info = iscsi_get_info,
cb1b83e7 1595 .bdrv_truncate = iscsi_truncate,
d34682cd 1596 .bdrv_refresh_limits = iscsi_refresh_limits,
c589b249 1597
54a5c1d5 1598 .bdrv_co_get_block_status = iscsi_co_get_block_status,
65f3e339 1599 .bdrv_co_discard = iscsi_co_discard,
d4cd9615 1600 .bdrv_co_write_zeroes = iscsi_co_write_zeroes,
063c3378
PL
1601 .bdrv_co_readv = iscsi_co_readv,
1602 .bdrv_co_writev = iscsi_co_writev,
1603 .bdrv_co_flush_to_disk = iscsi_co_flush,
fa6acb0c 1604
98392453
RS
1605#ifdef __linux__
1606 .bdrv_ioctl = iscsi_ioctl,
1607 .bdrv_aio_ioctl = iscsi_aio_ioctl,
1608#endif
80cf6257
SH
1609
1610 .bdrv_detach_aio_context = iscsi_detach_aio_context,
1611 .bdrv_attach_aio_context = iscsi_attach_aio_context,
c589b249
RS
1612};
1613
4d454574
PB
1614static QemuOptsList qemu_iscsi_opts = {
1615 .name = "iscsi",
1616 .head = QTAILQ_HEAD_INITIALIZER(qemu_iscsi_opts.head),
1617 .desc = {
1618 {
1619 .name = "user",
1620 .type = QEMU_OPT_STRING,
1621 .help = "username for CHAP authentication to target",
1622 },{
1623 .name = "password",
1624 .type = QEMU_OPT_STRING,
1625 .help = "password for CHAP authentication to target",
1626 },{
1627 .name = "header-digest",
1628 .type = QEMU_OPT_STRING,
1629 .help = "HeaderDigest setting. "
1630 "{CRC32C|CRC32C-NONE|NONE-CRC32C|NONE}",
1631 },{
1632 .name = "initiator-name",
1633 .type = QEMU_OPT_STRING,
1634 .help = "Initiator iqn name to use when connecting",
1635 },
1636 { /* end of list */ }
1637 },
1638};
1639
c589b249
RS
1640static void iscsi_block_init(void)
1641{
1642 bdrv_register(&bdrv_iscsi);
4d454574 1643 qemu_add_opts(&qemu_iscsi_opts);
c589b249
RS
1644}
1645
1646block_init(iscsi_block_init);