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