iscsi.c 46.4 KB
Newer Older
R
Ronnie Sahlberg 已提交
1 2 3 4
/*
 * QEMU Block driver for iSCSI images
 *
 * Copyright (c) 2010-2011 Ronnie Sahlberg <ronniesahlberg@gmail.com>
5
 * Copyright (c) 2012-2014 Peter Lieven <pl@kamp.de>
R
Ronnie Sahlberg 已提交
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#include "config-host.h"

#include <poll.h>
29
#include <arpa/inet.h>
R
Ronnie Sahlberg 已提交
30
#include "qemu-common.h"
31 32
#include "qemu/config-file.h"
#include "qemu/error-report.h"
33 34
#include "qemu/bitops.h"
#include "qemu/bitmap.h"
35
#include "block/block_int.h"
R
Ronnie Sahlberg 已提交
36
#include "trace.h"
P
Paolo Bonzini 已提交
37
#include "block/scsi.h"
38
#include "qemu/iov.h"
39 40
#include "sysemu/sysemu.h"
#include "qmp-commands.h"
R
Ronnie Sahlberg 已提交
41 42 43 44

#include <iscsi/iscsi.h>
#include <iscsi/scsi-lowlevel.h>

45 46
#ifdef __linux__
#include <scsi/sg.h>
P
Paolo Bonzini 已提交
47
#include <block/scsi.h>
48
#endif
R
Ronnie Sahlberg 已提交
49 50 51 52

typedef struct IscsiLun {
    struct iscsi_context *iscsi;
    int lun;
53
    enum scsi_inquiry_peripheral_device_type type;
R
Ronnie Sahlberg 已提交
54
    int block_size;
55
    uint64_t num_blocks;
56
    int events;
57
    QEMUTimer *nop_timer;
58 59
    uint8_t lbpme;
    uint8_t lbprz;
60
    uint8_t has_write_same;
61 62
    struct scsi_inquiry_logical_block_provisioning lbp;
    struct scsi_inquiry_block_limits bl;
P
Peter Lieven 已提交
63
    unsigned char *zeroblock;
64 65
    unsigned long *allocationmap;
    int cluster_sectors;
R
Ronnie Sahlberg 已提交
66 67
} IscsiLun;

P
Peter Lieven 已提交
68 69 70 71 72 73 74
typedef struct IscsiTask {
    int status;
    int complete;
    int retries;
    int do_retry;
    struct scsi_task *task;
    Coroutine *co;
75
    QEMUBH *bh;
P
Peter Lieven 已提交
76 77
} IscsiTask;

R
Ronnie Sahlberg 已提交
78 79 80 81 82 83 84 85 86
typedef struct IscsiAIOCB {
    BlockDriverAIOCB common;
    QEMUIOVector *qiov;
    QEMUBH *bh;
    IscsiLun *iscsilun;
    struct scsi_task *task;
    uint8_t *buf;
    int status;
    int canceled;
87 88 89
    int retries;
    int64_t sector_num;
    int nb_sectors;
90 91 92
#ifdef __linux__
    sg_io_hdr_t *ioh;
#endif
R
Ronnie Sahlberg 已提交
93 94
} IscsiAIOCB;

95 96
#define NOP_INTERVAL 5000
#define MAX_NOP_FAILURES 3
97
#define ISCSI_CMD_RETRIES 5
98 99 100 101 102 103 104 105 106

/* this threshhold is a trade-off knob to choose between
 * the potential additional overhead of an extra GET_LBA_STATUS request
 * vs. unnecessarily reading a lot of zero sectors over the wire.
 * If a read request is greater or equal than ISCSI_CHECKALLOC_THRES
 * sectors we check the allocation status of the area covered by the
 * request first if the allocationmap indicates that the area might be
 * unallocated. */
#define ISCSI_CHECKALLOC_THRES 64
107

108
static void
109
iscsi_bh_cb(void *p)
110 111 112 113 114
{
    IscsiAIOCB *acb = p;

    qemu_bh_delete(acb->bh);

115 116 117
    g_free(acb->buf);
    acb->buf = NULL;

118 119 120 121
    if (acb->canceled == 0) {
        acb->common.cb(acb->common.opaque, acb->status);
    }

122 123 124 125 126
    if (acb->task != NULL) {
        scsi_free_scsi_task(acb->task);
        acb->task = NULL;
    }

127 128 129
    qemu_aio_release(acb);
}

130 131
static void
iscsi_schedule_bh(IscsiAIOCB *acb)
132
{
133 134 135
    if (acb->bh) {
        return;
    }
136
    acb->bh = qemu_bh_new(iscsi_bh_cb, acb);
137 138 139
    qemu_bh_schedule(acb->bh);
}

140 141 142 143 144 145 146
static void iscsi_co_generic_bh_cb(void *opaque)
{
    struct IscsiTask *iTask = opaque;
    qemu_bh_delete(iTask->bh);
    qemu_coroutine_enter(iTask->co, NULL);
}

P
Peter Lieven 已提交
147 148 149 150 151 152 153 154 155 156 157 158 159 160
static void
iscsi_co_generic_cb(struct iscsi_context *iscsi, int status,
                        void *command_data, void *opaque)
{
    struct IscsiTask *iTask = opaque;
    struct scsi_task *task = command_data;

    iTask->complete = 1;
    iTask->status = status;
    iTask->do_retry = 0;
    iTask->task = task;

    if (iTask->retries-- > 0 && status == SCSI_STATUS_CHECK_CONDITION
        && task->sense.key == SCSI_SENSE_UNIT_ATTENTION) {
161
        error_report("iSCSI CheckCondition: %s", iscsi_get_error(iscsi));
P
Peter Lieven 已提交
162 163 164 165 166
        iTask->do_retry = 1;
        goto out;
    }

    if (status != SCSI_STATUS_GOOD) {
167
        error_report("iSCSI Failure: %s", iscsi_get_error(iscsi));
P
Peter Lieven 已提交
168 169 170 171
    }

out:
    if (iTask->co) {
172 173
        iTask->bh = qemu_bh_new(iscsi_co_generic_bh_cb, iTask);
        qemu_bh_schedule(iTask->bh);
P
Peter Lieven 已提交
174 175 176 177 178 179 180 181 182 183
    }
}

static void iscsi_co_init_iscsitask(IscsiLun *iscsilun, struct IscsiTask *iTask)
{
    *iTask = (struct IscsiTask) {
        .co         = qemu_coroutine_self(),
        .retries    = ISCSI_CMD_RETRIES,
    };
}
184

R
Ronnie Sahlberg 已提交
185 186 187 188
static void
iscsi_abort_task_cb(struct iscsi_context *iscsi, int status, void *command_data,
                    void *private_data)
{
189 190 191 192
    IscsiAIOCB *acb = private_data;

    acb->status = -ECANCELED;
    iscsi_schedule_bh(acb);
R
Ronnie Sahlberg 已提交
193 194 195 196 197 198 199 200
}

static void
iscsi_aio_cancel(BlockDriverAIOCB *blockacb)
{
    IscsiAIOCB *acb = (IscsiAIOCB *)blockacb;
    IscsiLun *iscsilun = acb->iscsilun;

201 202 203 204
    if (acb->status != -EINPROGRESS) {
        return;
    }

205
    acb->canceled = 1;
R
Ronnie Sahlberg 已提交
206

207
    /* send a task mgmt call to the target to cancel the task on the target */
208
    iscsi_task_mgmt_abort_task_async(iscsilun->iscsi, acb->task,
209
                                     iscsi_abort_task_cb, acb);
210

211 212 213
    while (acb->status == -EINPROGRESS) {
        qemu_aio_wait();
    }
R
Ronnie Sahlberg 已提交
214 215
}

S
Stefan Hajnoczi 已提交
216
static const AIOCBInfo iscsi_aiocb_info = {
R
Ronnie Sahlberg 已提交
217 218 219 220 221 222 223 224 225 226 227 228
    .aiocb_size         = sizeof(IscsiAIOCB),
    .cancel             = iscsi_aio_cancel,
};


static void iscsi_process_read(void *arg);
static void iscsi_process_write(void *arg);

static void
iscsi_set_events(IscsiLun *iscsilun)
{
    struct iscsi_context *iscsi = iscsilun->iscsi;
229 230 231 232 233 234 235 236 237 238 239 240 241 242
    int ev;

    /* We always register a read handler.  */
    ev = POLLIN;
    ev |= iscsi_which_events(iscsi);
    if (ev != iscsilun->events) {
        qemu_aio_set_fd_handler(iscsi_get_fd(iscsi),
                      iscsi_process_read,
                      (ev & POLLOUT) ? iscsi_process_write : NULL,
                      iscsilun);

    }

    iscsilun->events = ev;
R
Ronnie Sahlberg 已提交
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
}

static void
iscsi_process_read(void *arg)
{
    IscsiLun *iscsilun = arg;
    struct iscsi_context *iscsi = iscsilun->iscsi;

    iscsi_service(iscsi, POLLIN);
    iscsi_set_events(iscsilun);
}

static void
iscsi_process_write(void *arg)
{
    IscsiLun *iscsilun = arg;
    struct iscsi_context *iscsi = iscsilun->iscsi;

    iscsi_service(iscsi, POLLOUT);
    iscsi_set_events(iscsilun);
}

265 266 267 268 269
static int64_t sector_lun2qemu(int64_t sector, IscsiLun *iscsilun)
{
    return sector * iscsilun->block_size / BDRV_SECTOR_SIZE;
}

R
Ronnie Sahlberg 已提交
270 271 272 273 274
static int64_t sector_qemu2lun(int64_t sector, IscsiLun *iscsilun)
{
    return sector * BDRV_SECTOR_SIZE / iscsilun->block_size;
}

275 276 277 278 279
static bool is_request_lun_aligned(int64_t sector_num, int nb_sectors,
                                      IscsiLun *iscsilun)
{
    if ((sector_num * BDRV_SECTOR_SIZE) % iscsilun->block_size ||
        (nb_sectors * BDRV_SECTOR_SIZE) % iscsilun->block_size) {
280 281 282
            error_report("iSCSI misaligned request: "
                         "iscsilun->block_size %u, sector_num %" PRIi64
                         ", nb_sectors %d",
283 284 285 286 287 288
                         iscsilun->block_size, sector_num, nb_sectors);
            return 0;
    }
    return 1;
}

289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
static void iscsi_allocationmap_set(IscsiLun *iscsilun, int64_t sector_num,
                                    int nb_sectors)
{
    if (iscsilun->allocationmap == NULL) {
        return;
    }
    bitmap_set(iscsilun->allocationmap,
               sector_num / iscsilun->cluster_sectors,
               DIV_ROUND_UP(nb_sectors, iscsilun->cluster_sectors));
}

static void iscsi_allocationmap_clear(IscsiLun *iscsilun, int64_t sector_num,
                                      int nb_sectors)
{
    int64_t cluster_num, nb_clusters;
    if (iscsilun->allocationmap == NULL) {
        return;
    }
    cluster_num = DIV_ROUND_UP(sector_num, iscsilun->cluster_sectors);
    nb_clusters = (sector_num + nb_sectors) / iscsilun->cluster_sectors
                  - cluster_num;
    if (nb_clusters > 0) {
        bitmap_clear(iscsilun->allocationmap, cluster_num, nb_clusters);
    }
}

315 316 317
static int coroutine_fn iscsi_co_writev(BlockDriverState *bs,
                                        int64_t sector_num, int nb_sectors,
                                        QEMUIOVector *iov)
R
Ronnie Sahlberg 已提交
318
{
319 320
    IscsiLun *iscsilun = bs->opaque;
    struct IscsiTask iTask;
321
    uint64_t lba;
322 323 324
    uint32_t num_sectors;
    uint8_t *data = NULL;
    uint8_t *buf = NULL;
R
Ronnie Sahlberg 已提交
325

326 327 328
    if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
        return -EINVAL;
    }
P
Peter Lieven 已提交
329

330 331
    lba = sector_qemu2lun(sector_num, iscsilun);
    num_sectors = sector_qemu2lun(nb_sectors, iscsilun);
P
Peter Lieven 已提交
332
#if !defined(LIBISCSI_FEATURE_IOVECTOR)
333
    /* if the iovec only contains one buffer we can pass it directly */
334 335
    if (iov->niov == 1) {
        data = iov->iov[0].iov_base;
336
    } else {
337 338 339 340
        size_t size = MIN(nb_sectors * BDRV_SECTOR_SIZE, iov->size);
        buf = g_malloc(size);
        qemu_iovec_to_buf(iov, 0, buf, size);
        data = buf;
341
    }
P
Peter Lieven 已提交
342
#endif
343 344 345 346 347 348 349 350
    iscsi_co_init_iscsitask(iscsilun, &iTask);
retry:
    iTask.task = iscsi_write16_task(iscsilun->iscsi, iscsilun->lun, lba,
                                    data, num_sectors * iscsilun->block_size,
                                    iscsilun->block_size, 0, 0, 0, 0, 0,
                                    iscsi_co_generic_cb, &iTask);
    if (iTask.task == NULL) {
        g_free(buf);
351
        return -ENOMEM;
352
    }
P
Peter Lieven 已提交
353
#if defined(LIBISCSI_FEATURE_IOVECTOR)
354 355
    scsi_task_set_iov_out(iTask.task, (struct scsi_iovec *) iov->iov,
                          iov->niov);
P
Peter Lieven 已提交
356
#endif
357 358 359
    while (!iTask.complete) {
        iscsi_set_events(iscsilun);
        qemu_coroutine_yield();
R
Ronnie Sahlberg 已提交
360 361
    }

362 363 364
    if (iTask.task != NULL) {
        scsi_free_scsi_task(iTask.task);
        iTask.task = NULL;
365 366
    }

367
    if (iTask.do_retry) {
368
        iTask.complete = 0;
369
        goto retry;
370 371
    }

372
    g_free(buf);
R
Ronnie Sahlberg 已提交
373

374 375
    if (iTask.status != SCSI_STATUS_GOOD) {
        return -EIO;
R
Ronnie Sahlberg 已提交
376 377
    }

378 379
    iscsi_allocationmap_set(iscsilun, sector_num, nb_sectors);

380
    return 0;
R
Ronnie Sahlberg 已提交
381 382
}

383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498

static bool iscsi_allocationmap_is_allocated(IscsiLun *iscsilun,
                                             int64_t sector_num, int nb_sectors)
{
    unsigned long size;
    if (iscsilun->allocationmap == NULL) {
        return true;
    }
    size = DIV_ROUND_UP(sector_num + nb_sectors, iscsilun->cluster_sectors);
    return !(find_next_bit(iscsilun->allocationmap, size,
                           sector_num / iscsilun->cluster_sectors) == size);
}


#if defined(LIBISCSI_FEATURE_IOVECTOR)

static int64_t coroutine_fn iscsi_co_get_block_status(BlockDriverState *bs,
                                                  int64_t sector_num,
                                                  int nb_sectors, int *pnum)
{
    IscsiLun *iscsilun = bs->opaque;
    struct scsi_get_lba_status *lbas = NULL;
    struct scsi_lba_status_descriptor *lbasd = NULL;
    struct IscsiTask iTask;
    int64_t ret;

    iscsi_co_init_iscsitask(iscsilun, &iTask);

    if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
        ret = -EINVAL;
        goto out;
    }

    /* default to all sectors allocated */
    ret = BDRV_BLOCK_DATA;
    ret |= (sector_num << BDRV_SECTOR_BITS) | BDRV_BLOCK_OFFSET_VALID;
    *pnum = nb_sectors;

    /* LUN does not support logical block provisioning */
    if (iscsilun->lbpme == 0) {
        goto out;
    }

retry:
    if (iscsi_get_lba_status_task(iscsilun->iscsi, iscsilun->lun,
                                  sector_qemu2lun(sector_num, iscsilun),
                                  8 + 16, iscsi_co_generic_cb,
                                  &iTask) == NULL) {
        ret = -ENOMEM;
        goto out;
    }

    while (!iTask.complete) {
        iscsi_set_events(iscsilun);
        qemu_coroutine_yield();
    }

    if (iTask.do_retry) {
        if (iTask.task != NULL) {
            scsi_free_scsi_task(iTask.task);
            iTask.task = NULL;
        }
        iTask.complete = 0;
        goto retry;
    }

    if (iTask.status != SCSI_STATUS_GOOD) {
        /* in case the get_lba_status_callout fails (i.e.
         * because the device is busy or the cmd is not
         * supported) we pretend all blocks are allocated
         * for backwards compatibility */
        goto out;
    }

    lbas = scsi_datain_unmarshall(iTask.task);
    if (lbas == NULL) {
        ret = -EIO;
        goto out;
    }

    lbasd = &lbas->descriptors[0];

    if (sector_qemu2lun(sector_num, iscsilun) != lbasd->lba) {
        ret = -EIO;
        goto out;
    }

    *pnum = sector_lun2qemu(lbasd->num_blocks, iscsilun);

    if (lbasd->provisioning == SCSI_PROVISIONING_TYPE_DEALLOCATED ||
        lbasd->provisioning == SCSI_PROVISIONING_TYPE_ANCHORED) {
        ret &= ~BDRV_BLOCK_DATA;
        if (iscsilun->lbprz) {
            ret |= BDRV_BLOCK_ZERO;
        }
    }

    if (ret & BDRV_BLOCK_ZERO) {
        iscsi_allocationmap_clear(iscsilun, sector_num, *pnum);
    } else {
        iscsi_allocationmap_set(iscsilun, sector_num, *pnum);
    }

    if (*pnum > nb_sectors) {
        *pnum = nb_sectors;
    }
out:
    if (iTask.task != NULL) {
        scsi_free_scsi_task(iTask.task);
    }
    return ret;
}

#endif /* LIBISCSI_FEATURE_IOVECTOR */


499 500 501
static int coroutine_fn iscsi_co_readv(BlockDriverState *bs,
                                       int64_t sector_num, int nb_sectors,
                                       QEMUIOVector *iov)
R
Ronnie Sahlberg 已提交
502
{
503 504
    IscsiLun *iscsilun = bs->opaque;
    struct IscsiTask iTask;
505 506
    uint64_t lba;
    uint32_t num_sectors;
P
Peter Lieven 已提交
507
#if !defined(LIBISCSI_FEATURE_IOVECTOR)
R
Ronnie Sahlberg 已提交
508
    int i;
P
Peter Lieven 已提交
509
#endif
R
Ronnie Sahlberg 已提交
510

511 512
    if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
        return -EINVAL;
513 514
    }

515
#if defined(LIBISCSI_FEATURE_IOVECTOR)
516
    if (iscsilun->lbprz && nb_sectors >= ISCSI_CHECKALLOC_THRES &&
517 518 519 520 521 522 523 524 525 526 527 528 529 530
        !iscsi_allocationmap_is_allocated(iscsilun, sector_num, nb_sectors)) {
        int64_t ret;
        int pnum;
        ret = iscsi_co_get_block_status(bs, sector_num, INT_MAX, &pnum);
        if (ret < 0) {
            return ret;
        }
        if (ret & BDRV_BLOCK_ZERO && pnum >= nb_sectors) {
            qemu_iovec_memset(iov, 0, 0x00, iov->size);
            return 0;
        }
    }
#endif

531 532
    lba = sector_qemu2lun(sector_num, iscsilun);
    num_sectors = sector_qemu2lun(nb_sectors, iscsilun);
533

534 535 536
    iscsi_co_init_iscsitask(iscsilun, &iTask);
retry:
    switch (iscsilun->type) {
537
    case TYPE_DISK:
538 539 540 541
        iTask.task = iscsi_read16_task(iscsilun->iscsi, iscsilun->lun, lba,
                                       num_sectors * iscsilun->block_size,
                                       iscsilun->block_size, 0, 0, 0, 0, 0,
                                       iscsi_co_generic_cb, &iTask);
542 543
        break;
    default:
544 545
        iTask.task = iscsi_read10_task(iscsilun->iscsi, iscsilun->lun, lba,
                                       num_sectors * iscsilun->block_size,
546 547 548 549
                                       iscsilun->block_size,
#if !defined(CONFIG_LIBISCSI_1_4) /* API change from 1.4.0 to 1.5.0 */
                                       0, 0, 0, 0, 0,
#endif
550
                                       iscsi_co_generic_cb, &iTask);
551 552
        break;
    }
553
    if (iTask.task == NULL) {
554
        return -ENOMEM;
R
Ronnie Sahlberg 已提交
555
    }
P
Peter Lieven 已提交
556
#if defined(LIBISCSI_FEATURE_IOVECTOR)
557
    scsi_task_set_iov_in(iTask.task, (struct scsi_iovec *) iov->iov, iov->niov);
P
Peter Lieven 已提交
558
#else
559 560 561 562
    for (i = 0; i < iov->niov; i++) {
        scsi_task_add_data_in_buffer(iTask.task,
                                     iov->iov[i].iov_len,
                                     iov->iov[i].iov_base);
R
Ronnie Sahlberg 已提交
563
    }
P
Peter Lieven 已提交
564
#endif
565

566 567 568
    while (!iTask.complete) {
        iscsi_set_events(iscsilun);
        qemu_coroutine_yield();
569
    }
R
Ronnie Sahlberg 已提交
570

571 572 573
    if (iTask.task != NULL) {
        scsi_free_scsi_task(iTask.task);
        iTask.task = NULL;
R
Ronnie Sahlberg 已提交
574 575
    }

576
    if (iTask.do_retry) {
577
        iTask.complete = 0;
578
        goto retry;
R
Ronnie Sahlberg 已提交
579 580
    }

581 582
    if (iTask.status != SCSI_STATUS_GOOD) {
        return -EIO;
583 584 585 586 587
    }

    return 0;
}

588
static int coroutine_fn iscsi_co_flush(BlockDriverState *bs)
589 590
{
    IscsiLun *iscsilun = bs->opaque;
591
    struct IscsiTask iTask;
592

593 594 595 596
    if (bs->sg) {
        return 0;
    }

597
    iscsi_co_init_iscsitask(iscsilun, &iTask);
598

599 600 601
retry:
    if (iscsi_synchronizecache10_task(iscsilun->iscsi, iscsilun->lun, 0, 0, 0,
                                      0, iscsi_co_generic_cb, &iTask) == NULL) {
602
        return -ENOMEM;
603
    }
604

605 606 607 608
    while (!iTask.complete) {
        iscsi_set_events(iscsilun);
        qemu_coroutine_yield();
    }
609

610 611 612
    if (iTask.task != NULL) {
        scsi_free_scsi_task(iTask.task);
        iTask.task = NULL;
R
Ronnie Sahlberg 已提交
613 614
    }

615
    if (iTask.do_retry) {
616
        iTask.complete = 0;
617 618
        goto retry;
    }
R
Ronnie Sahlberg 已提交
619

620 621 622 623 624
    if (iTask.status != SCSI_STATUS_GOOD) {
        return -EIO;
    }

    return 0;
R
Ronnie Sahlberg 已提交
625 626
}

627 628 629 630 631 632 633
#ifdef __linux__
static void
iscsi_aio_ioctl_cb(struct iscsi_context *iscsi, int status,
                     void *command_data, void *opaque)
{
    IscsiAIOCB *acb = opaque;

634 635 636
    g_free(acb->buf);
    acb->buf = NULL;

637
    if (acb->canceled != 0) {
638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
        return;
    }

    acb->status = 0;
    if (status < 0) {
        error_report("Failed to ioctl(SG_IO) to iSCSI lun. %s",
                     iscsi_get_error(iscsi));
        acb->status = -EIO;
    }

    acb->ioh->driver_status = 0;
    acb->ioh->host_status   = 0;
    acb->ioh->resid         = 0;

#define SG_ERR_DRIVER_SENSE    0x08

    if (status == SCSI_STATUS_CHECK_CONDITION && acb->task->datain.size >= 2) {
        int ss;

        acb->ioh->driver_status |= SG_ERR_DRIVER_SENSE;

        acb->ioh->sb_len_wr = acb->task->datain.size - 2;
        ss = (acb->ioh->mx_sb_len >= acb->ioh->sb_len_wr) ?
             acb->ioh->mx_sb_len : acb->ioh->sb_len_wr;
        memcpy(acb->ioh->sbp, &acb->task->datain.data[2], ss);
    }

665
    iscsi_schedule_bh(acb);
666 667 668 669 670 671 672 673 674 675 676 677 678
}

static BlockDriverAIOCB *iscsi_aio_ioctl(BlockDriverState *bs,
        unsigned long int req, void *buf,
        BlockDriverCompletionFunc *cb, void *opaque)
{
    IscsiLun *iscsilun = bs->opaque;
    struct iscsi_context *iscsi = iscsilun->iscsi;
    struct iscsi_data data;
    IscsiAIOCB *acb;

    assert(req == SG_IO);

S
Stefan Hajnoczi 已提交
679
    acb = qemu_aio_get(&iscsi_aiocb_info, bs, cb, opaque);
680 681 682

    acb->iscsilun = iscsilun;
    acb->canceled    = 0;
683 684
    acb->bh          = NULL;
    acb->status      = -EINPROGRESS;
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
    acb->buf         = NULL;
    acb->ioh         = buf;

    acb->task = malloc(sizeof(struct scsi_task));
    if (acb->task == NULL) {
        error_report("iSCSI: Failed to allocate task for scsi command. %s",
                     iscsi_get_error(iscsi));
        qemu_aio_release(acb);
        return NULL;
    }
    memset(acb->task, 0, sizeof(struct scsi_task));

    switch (acb->ioh->dxfer_direction) {
    case SG_DXFER_TO_DEV:
        acb->task->xfer_dir = SCSI_XFER_WRITE;
        break;
    case SG_DXFER_FROM_DEV:
        acb->task->xfer_dir = SCSI_XFER_READ;
        break;
    default:
        acb->task->xfer_dir = SCSI_XFER_NONE;
        break;
    }

    acb->task->cdb_size = acb->ioh->cmd_len;
    memcpy(&acb->task->cdb[0], acb->ioh->cmdp, acb->ioh->cmd_len);
    acb->task->expxferlen = acb->ioh->dxfer_len;

713
    data.size = 0;
714
    if (acb->task->xfer_dir == SCSI_XFER_WRITE) {
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
        if (acb->ioh->iovec_count == 0) {
            data.data = acb->ioh->dxferp;
            data.size = acb->ioh->dxfer_len;
        } else {
#if defined(LIBISCSI_FEATURE_IOVECTOR)
            scsi_task_set_iov_out(acb->task,
                                 (struct scsi_iovec *) acb->ioh->dxferp,
                                 acb->ioh->iovec_count);
#else
            struct iovec *iov = (struct iovec *)acb->ioh->dxferp;

            acb->buf = g_malloc(acb->ioh->dxfer_len);
            data.data = acb->buf;
            data.size = iov_to_buf(iov, acb->ioh->iovec_count, 0,
                                   acb->buf, acb->ioh->dxfer_len);
#endif
        }
732
    }
733

734 735
    if (iscsi_scsi_command_async(iscsi, iscsilun->lun, acb->task,
                                 iscsi_aio_ioctl_cb,
736
                                 (data.size > 0) ? &data : NULL,
737 738 739 740 741 742 743 744
                                 acb) != 0) {
        scsi_free_scsi_task(acb->task);
        qemu_aio_release(acb);
        return NULL;
    }

    /* tell libiscsi to read straight into the buffer we got from ioctl */
    if (acb->task->xfer_dir == SCSI_XFER_READ) {
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764
        if (acb->ioh->iovec_count == 0) {
            scsi_task_add_data_in_buffer(acb->task,
                                         acb->ioh->dxfer_len,
                                         acb->ioh->dxferp);
        } else {
#if defined(LIBISCSI_FEATURE_IOVECTOR)
            scsi_task_set_iov_in(acb->task,
                                 (struct scsi_iovec *) acb->ioh->dxferp,
                                 acb->ioh->iovec_count);
#else
            int i;
            for (i = 0; i < acb->ioh->iovec_count; i++) {
                struct iovec *iov = (struct iovec *)acb->ioh->dxferp;

                scsi_task_add_data_in_buffer(acb->task,
                    iov[i].iov_len,
                    iov[i].iov_base);
            }
#endif
        }
765 766 767 768 769 770 771
    }

    iscsi_set_events(iscsilun);

    return &acb->common;
}

772 773 774 775 776 777 778

static void ioctl_cb(void *opaque, int status)
{
    int *p_status = opaque;
    *p_status = status;
}

779 780 781
static int iscsi_ioctl(BlockDriverState *bs, unsigned long int req, void *buf)
{
    IscsiLun *iscsilun = bs->opaque;
782
    int status;
783 784 785 786 787 788 789 790

    switch (req) {
    case SG_GET_VERSION_NUM:
        *(int *)buf = 30000;
        break;
    case SG_GET_SCSI_ID:
        ((struct sg_scsi_id *)buf)->scsi_type = iscsilun->type;
        break;
791 792 793 794 795 796 797 798 799
    case SG_IO:
        status = -EINPROGRESS;
        iscsi_aio_ioctl(bs, req, buf, ioctl_cb, &status);

        while (status == -EINPROGRESS) {
            qemu_aio_wait();
        }

        return 0;
800 801 802 803 804 805 806
    default:
        return -1;
    }
    return 0;
}
#endif

R
Ronnie Sahlberg 已提交
807 808 809 810 811 812 813 814 815 816 817 818
static int64_t
iscsi_getlength(BlockDriverState *bs)
{
    IscsiLun *iscsilun = bs->opaque;
    int64_t len;

    len  = iscsilun->num_blocks;
    len *= iscsilun->block_size;

    return len;
}

819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836
static int
coroutine_fn iscsi_co_discard(BlockDriverState *bs, int64_t sector_num,
                                   int nb_sectors)
{
    IscsiLun *iscsilun = bs->opaque;
    struct IscsiTask iTask;
    struct unmap_list list;

    if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
        return -EINVAL;
    }

    if (!iscsilun->lbp.lbpu) {
        /* UNMAP is not supported by the target */
        return 0;
    }

    list.lba = sector_qemu2lun(sector_num, iscsilun);
P
Peter Lieven 已提交
837
    list.num = sector_qemu2lun(nb_sectors, iscsilun);
838

P
Peter Lieven 已提交
839
    iscsi_co_init_iscsitask(iscsilun, &iTask);
840
retry:
P
Peter Lieven 已提交
841 842
    if (iscsi_unmap_task(iscsilun->iscsi, iscsilun->lun, 0, 0, &list, 1,
                     iscsi_co_generic_cb, &iTask) == NULL) {
843
        return -ENOMEM;
P
Peter Lieven 已提交
844
    }
845

P
Peter Lieven 已提交
846 847 848 849
    while (!iTask.complete) {
        iscsi_set_events(iscsilun);
        qemu_coroutine_yield();
    }
850

P
Peter Lieven 已提交
851 852 853 854
    if (iTask.task != NULL) {
        scsi_free_scsi_task(iTask.task);
        iTask.task = NULL;
    }
855

P
Peter Lieven 已提交
856
    if (iTask.do_retry) {
857
        iTask.complete = 0;
P
Peter Lieven 已提交
858 859
        goto retry;
    }
860

P
Peter Lieven 已提交
861 862 863 864 865 866
    if (iTask.status == SCSI_STATUS_CHECK_CONDITION) {
        /* the target might fail with a check condition if it
           is not happy with the alignment of the UNMAP request
           we silently fail in this case */
        return 0;
    }
867

P
Peter Lieven 已提交
868 869
    if (iTask.status != SCSI_STATUS_GOOD) {
        return -EIO;
870 871
    }

872 873
    iscsi_allocationmap_clear(iscsilun, sector_num, nb_sectors);

874 875 876
    return 0;
}

P
Peter Lieven 已提交
877 878 879 880 881 882 883 884 885 886 887 888 889 890 891
#if defined(SCSI_SENSE_ASCQ_CAPACITY_DATA_HAS_CHANGED)

static int
coroutine_fn iscsi_co_write_zeroes(BlockDriverState *bs, int64_t sector_num,
                                   int nb_sectors, BdrvRequestFlags flags)
{
    IscsiLun *iscsilun = bs->opaque;
    struct IscsiTask iTask;
    uint64_t lba;
    uint32_t nb_blocks;

    if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
        return -EINVAL;
    }

892 893 894 895
    if ((flags & BDRV_REQ_MAY_UNMAP) && !iscsilun->lbp.lbpws) {
        /* WRITE SAME with UNMAP is not supported by the target,
         * fall back and try WRITE SAME without UNMAP */
        flags &= ~BDRV_REQ_MAY_UNMAP;
896 897
    }

898 899
    if (!(flags & BDRV_REQ_MAY_UNMAP) && !iscsilun->has_write_same) {
        /* WRITE SAME without UNMAP is not supported by the target */
P
Peter Lieven 已提交
900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
        return -ENOTSUP;
    }

    lba = sector_qemu2lun(sector_num, iscsilun);
    nb_blocks = sector_qemu2lun(nb_sectors, iscsilun);

    if (iscsilun->zeroblock == NULL) {
        iscsilun->zeroblock = g_malloc0(iscsilun->block_size);
    }

    iscsi_co_init_iscsitask(iscsilun, &iTask);
retry:
    if (iscsi_writesame16_task(iscsilun->iscsi, iscsilun->lun, lba,
                               iscsilun->zeroblock, iscsilun->block_size,
                               nb_blocks, 0, !!(flags & BDRV_REQ_MAY_UNMAP),
                               0, 0, iscsi_co_generic_cb, &iTask) == NULL) {
916
        return -ENOMEM;
P
Peter Lieven 已提交
917 918 919 920 921 922 923
    }

    while (!iTask.complete) {
        iscsi_set_events(iscsilun);
        qemu_coroutine_yield();
    }

924 925
    if (iTask.status == SCSI_STATUS_CHECK_CONDITION &&
        iTask.task->sense.key == SCSI_SENSE_ILLEGAL_REQUEST &&
926 927
        (iTask.task->sense.ascq == SCSI_SENSE_ASCQ_INVALID_OPERATION_CODE ||
         iTask.task->sense.ascq == SCSI_SENSE_ASCQ_INVALID_FIELD_IN_CDB)) {
928 929 930 931 932 933
        /* WRITE SAME is not supported by the target */
        iscsilun->has_write_same = false;
        scsi_free_scsi_task(iTask.task);
        return -ENOTSUP;
    }

P
Peter Lieven 已提交
934 935 936 937 938 939
    if (iTask.task != NULL) {
        scsi_free_scsi_task(iTask.task);
        iTask.task = NULL;
    }

    if (iTask.do_retry) {
940
        iTask.complete = 0;
P
Peter Lieven 已提交
941 942 943 944 945 946 947
        goto retry;
    }

    if (iTask.status != SCSI_STATUS_GOOD) {
        return -EIO;
    }

948 949 950 951 952 953
    if (flags & BDRV_REQ_MAY_UNMAP) {
        iscsi_allocationmap_clear(iscsilun, sector_num, nb_sectors);
    } else {
        iscsi_allocationmap_set(iscsilun, sector_num, nb_sectors);
    }

P
Peter Lieven 已提交
954 955 956 957 958
    return 0;
}

#endif /* SCSI_SENSE_ASCQ_CAPACITY_DATA_HAS_CHANGED */

959 960
static void parse_chap(struct iscsi_context *iscsi, const char *target,
                       Error **errp)
961 962 963 964 965 966 967 968
{
    QemuOptsList *list;
    QemuOpts *opts;
    const char *user = NULL;
    const char *password = NULL;

    list = qemu_find_opts("iscsi");
    if (!list) {
969
        return;
970 971 972 973 974 975
    }

    opts = qemu_opts_find(list, target);
    if (opts == NULL) {
        opts = QTAILQ_FIRST(&list->head);
        if (!opts) {
976
            return;
977 978 979 980 981
        }
    }

    user = qemu_opt_get(opts, "user");
    if (!user) {
982
        return;
983 984 985 986
    }

    password = qemu_opt_get(opts, "password");
    if (!password) {
987 988
        error_setg(errp, "CHAP username specified but no password was given");
        return;
989 990 991
    }

    if (iscsi_set_initiator_username_pwd(iscsi, user, password)) {
992
        error_setg(errp, "Failed to set initiator username and password");
993 994 995
    }
}

996 997
static void parse_header_digest(struct iscsi_context *iscsi, const char *target,
                                Error **errp)
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
{
    QemuOptsList *list;
    QemuOpts *opts;
    const char *digest = NULL;

    list = qemu_find_opts("iscsi");
    if (!list) {
        return;
    }

    opts = qemu_opts_find(list, target);
    if (opts == NULL) {
        opts = QTAILQ_FIRST(&list->head);
        if (!opts) {
            return;
        }
    }

    digest = qemu_opt_get(opts, "header-digest");
    if (!digest) {
        return;
    }

    if (!strcmp(digest, "CRC32C")) {
        iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_CRC32C);
    } else if (!strcmp(digest, "NONE")) {
        iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE);
    } else if (!strcmp(digest, "CRC32C-NONE")) {
        iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_CRC32C_NONE);
    } else if (!strcmp(digest, "NONE-CRC32C")) {
        iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE_CRC32C);
    } else {
1030
        error_setg(errp, "Invalid header-digest setting : %s", digest);
1031 1032 1033 1034 1035 1036 1037
    }
}

static char *parse_initiator_name(const char *target)
{
    QemuOptsList *list;
    QemuOpts *opts;
1038 1039 1040
    const char *name;
    char *iscsi_name;
    UuidInfo *uuid_info;
1041 1042

    list = qemu_find_opts("iscsi");
1043 1044
    if (list) {
        opts = qemu_opts_find(list, target);
1045
        if (!opts) {
1046 1047 1048 1049
            opts = QTAILQ_FIRST(&list->head);
        }
        if (opts) {
            name = qemu_opt_get(opts, "initiator-name");
1050 1051 1052
            if (name) {
                return g_strdup(name);
            }
1053 1054 1055
        }
    }

1056 1057 1058
    uuid_info = qmp_query_uuid(NULL);
    if (strcmp(uuid_info->UUID, UUID_NONE) == 0) {
        name = qemu_get_vm_name();
1059
    } else {
1060
        name = uuid_info->UUID;
1061
    }
1062 1063 1064 1065
    iscsi_name = g_strdup_printf("iqn.2008-11.org.linux-kvm%s%s",
                                 name ? ":" : "", name ? name : "");
    qapi_free_UuidInfo(uuid_info);
    return iscsi_name;
1066 1067
}

1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
#if defined(LIBISCSI_FEATURE_NOP_COUNTER)
static void iscsi_nop_timed_event(void *opaque)
{
    IscsiLun *iscsilun = opaque;

    if (iscsi_get_nops_in_flight(iscsilun->iscsi) > MAX_NOP_FAILURES) {
        error_report("iSCSI: NOP timeout. Reconnecting...");
        iscsi_reconnect(iscsilun->iscsi);
    }

    if (iscsi_nop_out_async(iscsilun->iscsi, NULL, NULL, 0, NULL) != 0) {
        error_report("iSCSI: failed to sent NOP-Out. Disabling NOP messages.");
        return;
    }

1083
    timer_mod(iscsilun->nop_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + NOP_INTERVAL);
1084 1085 1086 1087
    iscsi_set_events(iscsilun);
}
#endif

1088
static void iscsi_readcapacity_sync(IscsiLun *iscsilun, Error **errp)
P
Peter Lieven 已提交
1089 1090 1091 1092 1093 1094
{
    struct scsi_task *task = NULL;
    struct scsi_readcapacity10 *rc10 = NULL;
    struct scsi_readcapacity16 *rc16 = NULL;
    int retries = ISCSI_CMD_RETRIES; 

1095 1096 1097 1098
    do {
        if (task != NULL) {
            scsi_free_scsi_task(task);
            task = NULL;
P
Peter Lieven 已提交
1099
        }
1100 1101 1102 1103 1104 1105 1106

        switch (iscsilun->type) {
        case TYPE_DISK:
            task = iscsi_readcapacity16_sync(iscsilun->iscsi, iscsilun->lun);
            if (task != NULL && task->status == SCSI_STATUS_GOOD) {
                rc16 = scsi_datain_unmarshall(task);
                if (rc16 == NULL) {
1107
                    error_setg(errp, "iSCSI: Failed to unmarshall readcapacity16 data.");
1108 1109 1110
                } else {
                    iscsilun->block_size = rc16->block_length;
                    iscsilun->num_blocks = rc16->returned_lba + 1;
1111 1112
                    iscsilun->lbpme = rc16->lbpme;
                    iscsilun->lbprz = rc16->lbprz;
1113 1114 1115 1116 1117 1118 1119 1120
                }
            }
            break;
        case TYPE_ROM:
            task = iscsi_readcapacity10_sync(iscsilun->iscsi, iscsilun->lun, 0, 0);
            if (task != NULL && task->status == SCSI_STATUS_GOOD) {
                rc10 = scsi_datain_unmarshall(task);
                if (rc10 == NULL) {
1121
                    error_setg(errp, "iSCSI: Failed to unmarshall readcapacity10 data.");
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
                } else {
                    iscsilun->block_size = rc10->block_size;
                    if (rc10->lba == 0) {
                        /* blank disk loaded */
                        iscsilun->num_blocks = 0;
                    } else {
                        iscsilun->num_blocks = rc10->lba + 1;
                    }
                }
            }
            break;
        default:
1134
            return;
P
Peter Lieven 已提交
1135
        }
1136 1137 1138
    } while (task != NULL && task->status == SCSI_STATUS_CHECK_CONDITION
             && task->sense.key == SCSI_SENSE_UNIT_ATTENTION
             && retries-- > 0);
P
Peter Lieven 已提交
1139

1140
    if (task == NULL || task->status != SCSI_STATUS_GOOD) {
1141
        error_setg(errp, "iSCSI: failed to send readcapacity10 command.");
1142
    }
P
Peter Lieven 已提交
1143 1144 1145 1146 1147
    if (task) {
        scsi_free_scsi_task(task);
    }
}

1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
/* TODO Convert to fine grained options */
static QemuOptsList runtime_opts = {
    .name = "iscsi",
    .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
    .desc = {
        {
            .name = "filename",
            .type = QEMU_OPT_STRING,
            .help = "URL to the iscsi image",
        },
        { /* end of list */ }
    },
};

P
Paolo Bonzini 已提交
1162
static struct scsi_task *iscsi_do_inquiry(struct iscsi_context *iscsi, int lun,
1163
                                          int evpd, int pc, void **inq, Error **errp)
P
Paolo Bonzini 已提交
1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176
{
    int full_size;
    struct scsi_task *task = NULL;
    task = iscsi_inquiry_sync(iscsi, lun, evpd, pc, 64);
    if (task == NULL || task->status != SCSI_STATUS_GOOD) {
        goto fail;
    }
    full_size = scsi_datain_getfullsize(task);
    if (full_size > task->datain.size) {
        scsi_free_scsi_task(task);

        /* we need more data for the full list */
        task = iscsi_inquiry_sync(iscsi, lun, evpd, pc, full_size);
1177 1178 1179
        if (task == NULL || task->status != SCSI_STATUS_GOOD) {
            goto fail;
        }
P
Paolo Bonzini 已提交
1180
    }
1181

1182 1183 1184 1185 1186 1187
    *inq = scsi_datain_unmarshall(task);
    if (*inq == NULL) {
        error_setg(errp, "iSCSI: failed to unmarshall inquiry datain blob");
        goto fail;
    }

P
Paolo Bonzini 已提交
1188
    return task;
1189 1190

fail:
1191 1192 1193 1194
    if (!error_is_set(errp)) {
        error_setg(errp, "iSCSI: Inquiry command failed : %s",
                   iscsi_get_error(iscsi));
    }
1195
    if (task != NULL) {
P
Paolo Bonzini 已提交
1196 1197 1198
        scsi_free_scsi_task(task);
    }
    return NULL;
1199 1200
}

R
Ronnie Sahlberg 已提交
1201 1202 1203
/*
 * We support iscsi url's on the form
 * iscsi://[<username>%<password>@]<host>[:<port>]/<targetname>/<lun>
1204 1205 1206 1207
 *
 * Note: flags are currently not used by iscsi_open.  If this function
 * is changed such that flags are used, please examine iscsi_reopen_prepare()
 * to see if needs to be changed as well.
R
Ronnie Sahlberg 已提交
1208
 */
M
Max Reitz 已提交
1209 1210
static int iscsi_open(BlockDriverState *bs, QDict *options, int flags,
                      Error **errp)
R
Ronnie Sahlberg 已提交
1211 1212 1213 1214
{
    IscsiLun *iscsilun = bs->opaque;
    struct iscsi_context *iscsi = NULL;
    struct iscsi_url *iscsi_url = NULL;
P
Peter Lieven 已提交
1215 1216
    struct scsi_task *task = NULL;
    struct scsi_inquiry_standard *inq = NULL;
1217
    struct scsi_inquiry_supported_pages *inq_vpd;
1218
    char *initiator_name = NULL;
1219 1220 1221
    QemuOpts *opts;
    Error *local_err = NULL;
    const char *filename;
1222
    int i, ret;
R
Ronnie Sahlberg 已提交
1223 1224

    if ((BDRV_SECTOR_SIZE % 512) != 0) {
1225 1226 1227
        error_setg(errp, "iSCSI: Invalid BDRV_SECTOR_SIZE. "
                   "BDRV_SECTOR_SIZE(%lld) is not a multiple "
                   "of 512", BDRV_SECTOR_SIZE);
R
Ronnie Sahlberg 已提交
1228 1229 1230
        return -EINVAL;
    }

1231
    opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
1232
    qemu_opts_absorb_qdict(opts, options, &local_err);
1233
    if (local_err) {
1234
        error_propagate(errp, local_err);
1235 1236 1237 1238 1239 1240
        ret = -EINVAL;
        goto out;
    }

    filename = qemu_opt_get(opts, "filename");

R
Ronnie Sahlberg 已提交
1241 1242
    iscsi_url = iscsi_parse_full_url(iscsi, filename);
    if (iscsi_url == NULL) {
1243
        error_setg(errp, "Failed to parse URL : %s", filename);
R
Ronnie Sahlberg 已提交
1244
        ret = -EINVAL;
1245
        goto out;
R
Ronnie Sahlberg 已提交
1246 1247
    }

1248 1249 1250 1251 1252 1253
    memset(iscsilun, 0, sizeof(IscsiLun));

    initiator_name = parse_initiator_name(iscsi_url->target);

    iscsi = iscsi_create_context(initiator_name);
    if (iscsi == NULL) {
1254
        error_setg(errp, "iSCSI: Failed to create iSCSI context.");
1255
        ret = -ENOMEM;
1256
        goto out;
1257 1258
    }

R
Ronnie Sahlberg 已提交
1259
    if (iscsi_set_targetname(iscsi, iscsi_url->target)) {
1260
        error_setg(errp, "iSCSI: Failed to set target name.");
R
Ronnie Sahlberg 已提交
1261
        ret = -EINVAL;
1262
        goto out;
R
Ronnie Sahlberg 已提交
1263 1264 1265 1266 1267 1268
    }

    if (iscsi_url->user != NULL) {
        ret = iscsi_set_initiator_username_pwd(iscsi, iscsi_url->user,
                                              iscsi_url->passwd);
        if (ret != 0) {
1269
            error_setg(errp, "Failed to set initiator username and password");
R
Ronnie Sahlberg 已提交
1270
            ret = -EINVAL;
1271
            goto out;
R
Ronnie Sahlberg 已提交
1272 1273
        }
    }
1274 1275

    /* check if we got CHAP username/password via the options */
1276 1277 1278
    parse_chap(iscsi, iscsi_url->target, &local_err);
    if (local_err != NULL) {
        error_propagate(errp, local_err);
1279
        ret = -EINVAL;
1280
        goto out;
1281 1282
    }

R
Ronnie Sahlberg 已提交
1283
    if (iscsi_set_session_type(iscsi, ISCSI_SESSION_NORMAL) != 0) {
1284
        error_setg(errp, "iSCSI: Failed to set session type to normal.");
R
Ronnie Sahlberg 已提交
1285
        ret = -EINVAL;
1286
        goto out;
R
Ronnie Sahlberg 已提交
1287 1288 1289 1290
    }

    iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE_CRC32C);

1291
    /* check if we got HEADER_DIGEST via the options */
1292 1293 1294 1295 1296 1297
    parse_header_digest(iscsi, iscsi_url->target, &local_err);
    if (local_err != NULL) {
        error_propagate(errp, local_err);
        ret = -EINVAL;
        goto out;
    }
1298

P
Peter Lieven 已提交
1299
    if (iscsi_full_connect_sync(iscsi, iscsi_url->portal, iscsi_url->lun) != 0) {
1300
        error_setg(errp, "iSCSI: Failed to connect to LUN : %s",
P
Peter Lieven 已提交
1301 1302 1303 1304
            iscsi_get_error(iscsi));
        ret = -EINVAL;
        goto out;
    }
R
Ronnie Sahlberg 已提交
1305 1306 1307

    iscsilun->iscsi = iscsi;
    iscsilun->lun   = iscsi_url->lun;
1308
    iscsilun->has_write_same = true;
R
Ronnie Sahlberg 已提交
1309

1310 1311 1312
    task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 0, 0,
                            (void **) &inq, errp);
    if (task == NULL) {
R
Ronnie Sahlberg 已提交
1313
        ret = -EINVAL;
1314
        goto out;
R
Ronnie Sahlberg 已提交
1315
    }
P
Peter Lieven 已提交
1316
    iscsilun->type = inq->periperal_device_type;
1317 1318
    scsi_free_scsi_task(task);
    task = NULL;
P
Peter Lieven 已提交
1319

1320 1321 1322
    iscsi_readcapacity_sync(iscsilun, &local_err);
    if (local_err != NULL) {
        error_propagate(errp, local_err);
1323
        ret = -EINVAL;
P
Peter Lieven 已提交
1324
        goto out;
P
Peter Lieven 已提交
1325
    }
1326
    bs->total_sectors = sector_lun2qemu(iscsilun->num_blocks, iscsilun);
P
Paolo Bonzini 已提交
1327
    bs->request_alignment = iscsilun->block_size;
P
Peter Lieven 已提交
1328

1329 1330 1331
    /* We don't have any emulation for devices other than disks and CD-ROMs, so
     * this must be sg ioctl compatible. We force it to be sg, otherwise qemu
     * will try to read from the device to guess the image format.
1332
     */
1333
    if (iscsilun->type != TYPE_DISK && iscsilun->type != TYPE_ROM) {
1334 1335 1336
        bs->sg = 1;
    }

1337 1338 1339 1340 1341 1342
    task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
                            SCSI_INQUIRY_PAGECODE_SUPPORTED_VPD_PAGES,
                            (void **) &inq_vpd, errp);
    if (task == NULL) {
        ret = -EINVAL;
        goto out;
1343
    }
1344 1345 1346
    for (i = 0; i < inq_vpd->num_pages; i++) {
        struct scsi_task *inq_task;
        struct scsi_inquiry_logical_block_provisioning *inq_lbp;
1347
        struct scsi_inquiry_block_limits *inq_bl;
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374
        switch (inq_vpd->pages[i]) {
        case SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING:
            inq_task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
                                        SCSI_INQUIRY_PAGECODE_LOGICAL_BLOCK_PROVISIONING,
                                        (void **) &inq_lbp, errp);
            if (inq_task == NULL) {
                ret = -EINVAL;
                goto out;
            }
            memcpy(&iscsilun->lbp, inq_lbp,
                   sizeof(struct scsi_inquiry_logical_block_provisioning));
            scsi_free_scsi_task(inq_task);
            break;
        case SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS:
            inq_task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 1,
                                    SCSI_INQUIRY_PAGECODE_BLOCK_LIMITS,
                                    (void **) &inq_bl, errp);
            if (inq_task == NULL) {
                ret = -EINVAL;
                goto out;
            }
            memcpy(&iscsilun->bl, inq_bl,
                   sizeof(struct scsi_inquiry_block_limits));
            scsi_free_scsi_task(inq_task);
            break;
        default:
            break;
1375 1376
        }
    }
1377 1378
    scsi_free_scsi_task(task);
    task = NULL;
1379

1380 1381
#if defined(LIBISCSI_FEATURE_NOP_COUNTER)
    /* Set up a timer for sending out iSCSI NOPs */
1382 1383
    iscsilun->nop_timer = timer_new_ms(QEMU_CLOCK_REALTIME, iscsi_nop_timed_event, iscsilun);
    timer_mod(iscsilun->nop_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + NOP_INTERVAL);
1384 1385
#endif

1386 1387 1388
    /* Guess the internal cluster (page) size of the iscsi target by the means
     * of opt_unmap_gran. Transfer the unmap granularity only if it has a
     * reasonable size */
1389
    if (iscsilun->bl.opt_unmap_gran * iscsilun->block_size >= 4 * 1024 &&
1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
        iscsilun->bl.opt_unmap_gran * iscsilun->block_size <= 16 * 1024 * 1024) {
        iscsilun->cluster_sectors = (iscsilun->bl.opt_unmap_gran *
                                     iscsilun->block_size) >> BDRV_SECTOR_BITS;
#if defined(LIBISCSI_FEATURE_IOVECTOR)
        if (iscsilun->lbprz && !(bs->open_flags & BDRV_O_NOCACHE)) {
            iscsilun->allocationmap =
                bitmap_new(DIV_ROUND_UP(bs->total_sectors,
                                        iscsilun->cluster_sectors));
        }
#endif
    }

1402
out:
1403
    qemu_opts_del(opts);
1404 1405 1406
    if (initiator_name != NULL) {
        g_free(initiator_name);
    }
R
Ronnie Sahlberg 已提交
1407 1408 1409
    if (iscsi_url != NULL) {
        iscsi_destroy_url(iscsi_url);
    }
P
Peter Lieven 已提交
1410 1411 1412
    if (task != NULL) {
        scsi_free_scsi_task(task);
    }
1413 1414 1415 1416 1417 1418

    if (ret) {
        if (iscsi != NULL) {
            iscsi_destroy_context(iscsi);
        }
        memset(iscsilun, 0, sizeof(IscsiLun));
R
Ronnie Sahlberg 已提交
1419 1420 1421 1422 1423 1424 1425 1426 1427
    }
    return ret;
}

static void iscsi_close(BlockDriverState *bs)
{
    IscsiLun *iscsilun = bs->opaque;
    struct iscsi_context *iscsi = iscsilun->iscsi;

1428
    if (iscsilun->nop_timer) {
1429 1430
        timer_del(iscsilun->nop_timer);
        timer_free(iscsilun->nop_timer);
1431
    }
S
Stefan Hajnoczi 已提交
1432
    qemu_aio_set_fd_handler(iscsi_get_fd(iscsi), NULL, NULL, NULL);
R
Ronnie Sahlberg 已提交
1433
    iscsi_destroy_context(iscsi);
P
Peter Lieven 已提交
1434
    g_free(iscsilun->zeroblock);
1435
    g_free(iscsilun->allocationmap);
R
Ronnie Sahlberg 已提交
1436 1437 1438
    memset(iscsilun, 0, sizeof(IscsiLun));
}

1439 1440 1441 1442 1443 1444
static int iscsi_refresh_limits(BlockDriverState *bs)
{
    IscsiLun *iscsilun = bs->opaque;

    /* We don't actually refresh here, but just return data queried in
     * iscsi_open(): iscsi targets don't change their limits. */
1445
    if (iscsilun->lbp.lbpu) {
1446 1447 1448 1449 1450 1451
        if (iscsilun->bl.max_unmap < 0xffffffff) {
            bs->bl.max_discard = sector_lun2qemu(iscsilun->bl.max_unmap,
                                                 iscsilun);
        }
        bs->bl.discard_alignment = sector_lun2qemu(iscsilun->bl.opt_unmap_gran,
                                                   iscsilun);
1452
    }
1453

1454 1455 1456 1457 1458
    if (iscsilun->bl.max_ws_len < 0xffffffff) {
        bs->bl.max_write_zeroes = sector_lun2qemu(iscsilun->bl.max_ws_len,
                                                  iscsilun);
    }
    if (iscsilun->lbp.lbpws) {
1459 1460 1461
        bs->bl.write_zeroes_alignment = sector_lun2qemu(iscsilun->bl.opt_unmap_gran,
                                                        iscsilun);
    }
1462 1463
    bs->bl.opt_transfer_length = sector_lun2qemu(iscsilun->bl.opt_xfer_len,
                                                 iscsilun);
1464 1465
    return 0;
}
1466

1467 1468 1469
/* Since iscsi_open() ignores bdrv_flags, there is nothing to do here in
 * prepare.  Note that this will not re-establish a connection with an iSCSI
 * target - it is effectively a NOP.  */
1470 1471 1472
static int iscsi_reopen_prepare(BDRVReopenState *state,
                                BlockReopenQueue *queue, Error **errp)
{
1473
    /* NOP */
1474 1475 1476
    return 0;
}

P
Peter Lieven 已提交
1477 1478 1479
static int iscsi_truncate(BlockDriverState *bs, int64_t offset)
{
    IscsiLun *iscsilun = bs->opaque;
1480
    Error *local_err = NULL;
P
Peter Lieven 已提交
1481 1482 1483 1484 1485

    if (iscsilun->type != TYPE_DISK) {
        return -ENOTSUP;
    }

1486 1487 1488 1489
    iscsi_readcapacity_sync(iscsilun, &local_err);
    if (local_err != NULL) {
        error_free(local_err);
        return -EIO;
P
Peter Lieven 已提交
1490 1491 1492 1493 1494 1495
    }

    if (offset > iscsi_getlength(bs)) {
        return -EINVAL;
    }

1496 1497 1498 1499 1500 1501 1502
    if (iscsilun->allocationmap != NULL) {
        g_free(iscsilun->allocationmap);
        iscsilun->allocationmap =
            bitmap_new(DIV_ROUND_UP(bs->total_sectors,
                                    iscsilun->cluster_sectors));
    }

P
Peter Lieven 已提交
1503 1504 1505
    return 0;
}

1506 1507
static int iscsi_create(const char *filename, QEMUOptionParameter *options,
                        Error **errp)
P
Peter Lieven 已提交
1508 1509 1510
{
    int ret = 0;
    int64_t total_size = 0;
1511
    BlockDriverState *bs;
P
Peter Lieven 已提交
1512
    IscsiLun *iscsilun = NULL;
1513
    QDict *bs_options;
P
Peter Lieven 已提交
1514

K
Kevin Wolf 已提交
1515
    bs = bdrv_new("", &error_abort);
P
Peter Lieven 已提交
1516 1517 1518 1519 1520 1521 1522 1523 1524

    /* Read out options */
    while (options && options->name) {
        if (!strcmp(options->name, "size")) {
            total_size = options->value.n / BDRV_SECTOR_SIZE;
        }
        options++;
    }

1525 1526
    bs->opaque = g_malloc0(sizeof(struct IscsiLun));
    iscsilun = bs->opaque;
P
Peter Lieven 已提交
1527

1528 1529
    bs_options = qdict_new();
    qdict_put(bs_options, "filename", qstring_from_str(filename));
M
Max Reitz 已提交
1530
    ret = iscsi_open(bs, bs_options, 0, NULL);
1531 1532
    QDECREF(bs_options);

P
Peter Lieven 已提交
1533 1534 1535
    if (ret != 0) {
        goto out;
    }
1536
    if (iscsilun->nop_timer) {
1537 1538
        timer_del(iscsilun->nop_timer);
        timer_free(iscsilun->nop_timer);
1539
    }
P
Peter Lieven 已提交
1540 1541 1542 1543
    if (iscsilun->type != TYPE_DISK) {
        ret = -ENODEV;
        goto out;
    }
1544
    if (bs->total_sectors < total_size) {
P
Peter Lieven 已提交
1545
        ret = -ENOSPC;
1546
        goto out;
P
Peter Lieven 已提交
1547 1548 1549 1550 1551 1552 1553
    }

    ret = 0;
out:
    if (iscsilun->iscsi != NULL) {
        iscsi_destroy_context(iscsilun->iscsi);
    }
1554 1555
    g_free(bs->opaque);
    bs->opaque = NULL;
F
Fam Zheng 已提交
1556
    bdrv_unref(bs);
P
Peter Lieven 已提交
1557 1558 1559
    return ret;
}

P
Peter Lieven 已提交
1560 1561 1562 1563 1564
static int iscsi_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
{
    IscsiLun *iscsilun = bs->opaque;
    bdi->unallocated_blocks_are_zero = !!iscsilun->lbprz;
    bdi->can_write_zeroes_with_unmap = iscsilun->lbprz && iscsilun->lbp.lbpws;
1565
    bdi->cluster_size = iscsilun->cluster_sectors * BDRV_SECTOR_SIZE;
P
Peter Lieven 已提交
1566 1567 1568
    return 0;
}

P
Peter Lieven 已提交
1569 1570 1571 1572 1573 1574 1575 1576 1577
static QEMUOptionParameter iscsi_create_options[] = {
    {
        .name = BLOCK_OPT_SIZE,
        .type = OPT_SIZE,
        .help = "Virtual disk size"
    },
    { NULL }
};

R
Ronnie Sahlberg 已提交
1578 1579 1580 1581 1582
static BlockDriver bdrv_iscsi = {
    .format_name     = "iscsi",
    .protocol_name   = "iscsi",

    .instance_size   = sizeof(IscsiLun),
1583
    .bdrv_needs_filename = true,
R
Ronnie Sahlberg 已提交
1584 1585
    .bdrv_file_open  = iscsi_open,
    .bdrv_close      = iscsi_close,
P
Peter Lieven 已提交
1586 1587
    .bdrv_create     = iscsi_create,
    .create_options  = iscsi_create_options,
1588
    .bdrv_reopen_prepare  = iscsi_reopen_prepare,
R
Ronnie Sahlberg 已提交
1589 1590

    .bdrv_getlength  = iscsi_getlength,
P
Peter Lieven 已提交
1591
    .bdrv_get_info   = iscsi_get_info,
P
Peter Lieven 已提交
1592
    .bdrv_truncate   = iscsi_truncate,
1593
    .bdrv_refresh_limits = iscsi_refresh_limits,
R
Ronnie Sahlberg 已提交
1594

1595
#if defined(LIBISCSI_FEATURE_IOVECTOR)
P
Peter Lieven 已提交
1596
    .bdrv_co_get_block_status = iscsi_co_get_block_status,
1597
#endif
1598
    .bdrv_co_discard      = iscsi_co_discard,
P
Peter Lieven 已提交
1599 1600 1601
#if defined(SCSI_SENSE_ASCQ_CAPACITY_DATA_HAS_CHANGED)
    .bdrv_co_write_zeroes = iscsi_co_write_zeroes,
#endif
1602 1603 1604
    .bdrv_co_readv         = iscsi_co_readv,
    .bdrv_co_writev        = iscsi_co_writev,
    .bdrv_co_flush_to_disk = iscsi_co_flush,
1605

1606 1607 1608 1609
#ifdef __linux__
    .bdrv_ioctl       = iscsi_ioctl,
    .bdrv_aio_ioctl   = iscsi_aio_ioctl,
#endif
R
Ronnie Sahlberg 已提交
1610 1611
};

1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637
static QemuOptsList qemu_iscsi_opts = {
    .name = "iscsi",
    .head = QTAILQ_HEAD_INITIALIZER(qemu_iscsi_opts.head),
    .desc = {
        {
            .name = "user",
            .type = QEMU_OPT_STRING,
            .help = "username for CHAP authentication to target",
        },{
            .name = "password",
            .type = QEMU_OPT_STRING,
            .help = "password for CHAP authentication to target",
        },{
            .name = "header-digest",
            .type = QEMU_OPT_STRING,
            .help = "HeaderDigest setting. "
                    "{CRC32C|CRC32C-NONE|NONE-CRC32C|NONE}",
        },{
            .name = "initiator-name",
            .type = QEMU_OPT_STRING,
            .help = "Initiator iqn name to use when connecting",
        },
        { /* end of list */ }
    },
};

R
Ronnie Sahlberg 已提交
1638 1639 1640
static void iscsi_block_init(void)
{
    bdrv_register(&bdrv_iscsi);
1641
    qemu_add_opts(&qemu_iscsi_opts);
R
Ronnie Sahlberg 已提交
1642 1643 1644
}

block_init(iscsi_block_init);