iscsi.c 49.9 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 <math.h>
30
#include <arpa/inet.h>
R
Ronnie Sahlberg 已提交
31
#include "qemu-common.h"
32 33
#include "qemu/config-file.h"
#include "qemu/error-report.h"
34 35
#include "qemu/bitops.h"
#include "qemu/bitmap.h"
36
#include "block/block_int.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

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

P
Peter Lieven 已提交
71 72 73 74 75 76 77
typedef struct IscsiTask {
    int status;
    int complete;
    int retries;
    int do_retry;
    struct scsi_task *task;
    Coroutine *co;
78
    QEMUBH *bh;
79
    IscsiLun *iscsilun;
80
    QEMUTimer retry_timer;
P
Peter Lieven 已提交
81 82
} IscsiTask;

R
Ronnie Sahlberg 已提交
83
typedef struct IscsiAIOCB {
84
    BlockAIOCB common;
R
Ronnie Sahlberg 已提交
85 86 87 88 89 90
    QEMUIOVector *qiov;
    QEMUBH *bh;
    IscsiLun *iscsilun;
    struct scsi_task *task;
    uint8_t *buf;
    int status;
91 92
    int64_t sector_num;
    int nb_sectors;
93 94 95
#ifdef __linux__
    sg_io_hdr_t *ioh;
#endif
R
Ronnie Sahlberg 已提交
96 97
} IscsiAIOCB;

98 99
#define NOP_INTERVAL 5000
#define MAX_NOP_FAILURES 3
100 101
#define ISCSI_CMD_RETRIES ARRAY_SIZE(iscsi_retry_times)
static const unsigned iscsi_retry_times[] = {8, 32, 128, 512, 2048};
102

S
Stefan Weil 已提交
103
/* this threshold is a trade-off knob to choose between
104 105 106 107 108 109 110
 * 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
111

112
static void
113
iscsi_bh_cb(void *p)
114 115 116 117 118
{
    IscsiAIOCB *acb = p;

    qemu_bh_delete(acb->bh);

119 120 121
    g_free(acb->buf);
    acb->buf = NULL;

122
    acb->common.cb(acb->common.opaque, acb->status);
123

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

129
    qemu_aio_unref(acb);
130 131
}

132 133
static void
iscsi_schedule_bh(IscsiAIOCB *acb)
134
{
135 136 137
    if (acb->bh) {
        return;
    }
138
    acb->bh = aio_bh_new(acb->iscsilun->aio_context, iscsi_bh_cb, acb);
139 140 141
    qemu_bh_schedule(acb->bh);
}

142 143 144
static void iscsi_co_generic_bh_cb(void *opaque)
{
    struct IscsiTask *iTask = opaque;
145
    iTask->complete = 1;
146 147 148 149
    qemu_bh_delete(iTask->bh);
    qemu_coroutine_enter(iTask->co, NULL);
}

150 151 152
static void iscsi_retry_timer_expired(void *opaque)
{
    struct IscsiTask *iTask = opaque;
153
    iTask->complete = 1;
154 155 156 157 158 159 160 161 162 163
    if (iTask->co) {
        qemu_coroutine_enter(iTask->co, NULL);
    }
}

static inline unsigned exp_random(double mean)
{
    return -mean * log((double)rand() / RAND_MAX);
}

P
Peter Lieven 已提交
164 165 166 167 168 169 170 171 172 173 174 175
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->status = status;
    iTask->do_retry = 0;
    iTask->task = task;

    if (status != SCSI_STATUS_GOOD) {
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
        if (iTask->retries++ < ISCSI_CMD_RETRIES) {
            if (status == SCSI_STATUS_CHECK_CONDITION
                && task->sense.key == SCSI_SENSE_UNIT_ATTENTION) {
                error_report("iSCSI CheckCondition: %s",
                             iscsi_get_error(iscsi));
                iTask->do_retry = 1;
                goto out;
            }
            if (status == SCSI_STATUS_BUSY) {
                unsigned retry_time =
                    exp_random(iscsi_retry_times[iTask->retries - 1]);
                error_report("iSCSI Busy (retry #%u in %u ms): %s",
                             iTask->retries, retry_time,
                             iscsi_get_error(iscsi));
                aio_timer_init(iTask->iscsilun->aio_context,
                               &iTask->retry_timer, QEMU_CLOCK_REALTIME,
                               SCALE_MS, iscsi_retry_timer_expired, iTask);
                timer_mod(&iTask->retry_timer,
                          qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + retry_time);
                iTask->do_retry = 1;
                return;
            }
        }
199
        error_report("iSCSI Failure: %s", iscsi_get_error(iscsi));
P
Peter Lieven 已提交
200 201 202 203
    }

out:
    if (iTask->co) {
204 205
        iTask->bh = aio_bh_new(iTask->iscsilun->aio_context,
                               iscsi_co_generic_bh_cb, iTask);
206
        qemu_bh_schedule(iTask->bh);
207 208
    } else {
        iTask->complete = 1;
P
Peter Lieven 已提交
209 210 211 212 213 214
    }
}

static void iscsi_co_init_iscsitask(IscsiLun *iscsilun, struct IscsiTask *iTask)
{
    *iTask = (struct IscsiTask) {
215 216
        .co         = qemu_coroutine_self(),
        .iscsilun   = iscsilun,
P
Peter Lieven 已提交
217 218
    };
}
219

R
Ronnie Sahlberg 已提交
220 221 222 223
static void
iscsi_abort_task_cb(struct iscsi_context *iscsi, int status, void *command_data,
                    void *private_data)
{
224 225 226 227
    IscsiAIOCB *acb = private_data;

    acb->status = -ECANCELED;
    iscsi_schedule_bh(acb);
R
Ronnie Sahlberg 已提交
228 229 230
}

static void
231
iscsi_aio_cancel(BlockAIOCB *blockacb)
R
Ronnie Sahlberg 已提交
232 233 234 235
{
    IscsiAIOCB *acb = (IscsiAIOCB *)blockacb;
    IscsiLun *iscsilun = acb->iscsilun;

236 237 238 239
    if (acb->status != -EINPROGRESS) {
        return;
    }

240
    /* send a task mgmt call to the target to cancel the task on the target */
241
    iscsi_task_mgmt_abort_task_async(iscsilun->iscsi, acb->task,
242
                                     iscsi_abort_task_cb, acb);
243

R
Ronnie Sahlberg 已提交
244 245
}

S
Stefan Hajnoczi 已提交
246
static const AIOCBInfo iscsi_aiocb_info = {
R
Ronnie Sahlberg 已提交
247
    .aiocb_size         = sizeof(IscsiAIOCB),
248
    .cancel_async       = iscsi_aio_cancel,
R
Ronnie Sahlberg 已提交
249 250 251 252 253 254 255 256 257 258
};


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;
259 260 261 262 263 264
    int ev;

    /* We always register a read handler.  */
    ev = POLLIN;
    ev |= iscsi_which_events(iscsi);
    if (ev != iscsilun->events) {
265 266 267 268 269
        aio_set_fd_handler(iscsilun->aio_context,
                           iscsi_get_fd(iscsi),
                           iscsi_process_read,
                           (ev & POLLOUT) ? iscsi_process_write : NULL,
                           iscsilun);
270 271 272 273

    }

    iscsilun->events = ev;
R
Ronnie Sahlberg 已提交
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
}

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);
}

296 297 298 299 300
static int64_t sector_lun2qemu(int64_t sector, IscsiLun *iscsilun)
{
    return sector * iscsilun->block_size / BDRV_SECTOR_SIZE;
}

R
Ronnie Sahlberg 已提交
301 302 303 304 305
static int64_t sector_qemu2lun(int64_t sector, IscsiLun *iscsilun)
{
    return sector * BDRV_SECTOR_SIZE / iscsilun->block_size;
}

306 307 308 309 310
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) {
311 312 313
            error_report("iSCSI misaligned request: "
                         "iscsilun->block_size %u, sector_num %" PRIi64
                         ", nb_sectors %d",
314 315 316 317 318 319
                         iscsilun->block_size, sector_num, nb_sectors);
            return 0;
    }
    return 1;
}

320 321 322 323 324 325 326
static unsigned long *iscsi_allocationmap_init(IscsiLun *iscsilun)
{
    return bitmap_try_new(DIV_ROUND_UP(sector_lun2qemu(iscsilun->num_blocks,
                                                       iscsilun),
                                       iscsilun->cluster_sectors));
}

327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
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);
    }
}

353 354 355
static int coroutine_fn iscsi_co_writev(BlockDriverState *bs,
                                        int64_t sector_num, int nb_sectors,
                                        QEMUIOVector *iov)
R
Ronnie Sahlberg 已提交
356
{
357 358
    IscsiLun *iscsilun = bs->opaque;
    struct IscsiTask iTask;
359
    uint64_t lba;
360
    uint32_t num_sectors;
R
Ronnie Sahlberg 已提交
361

362 363 364
    if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
        return -EINVAL;
    }
P
Peter Lieven 已提交
365

366 367 368 369 370 371
    if (bs->bl.max_transfer_length && nb_sectors > bs->bl.max_transfer_length) {
        error_report("iSCSI Error: Write of %d sectors exceeds max_xfer_len "
                     "of %d sectors", nb_sectors, bs->bl.max_transfer_length);
        return -EINVAL;
    }

372 373 374 375
    lba = sector_qemu2lun(sector_num, iscsilun);
    num_sectors = sector_qemu2lun(nb_sectors, iscsilun);
    iscsi_co_init_iscsitask(iscsilun, &iTask);
retry:
376 377
    if (iscsilun->use_16_for_rw) {
        iTask.task = iscsi_write16_task(iscsilun->iscsi, iscsilun->lun, lba,
378
                                        NULL, num_sectors * iscsilun->block_size,
379 380 381 382
                                        iscsilun->block_size, 0, 0, 0, 0, 0,
                                        iscsi_co_generic_cb, &iTask);
    } else {
        iTask.task = iscsi_write10_task(iscsilun->iscsi, iscsilun->lun, lba,
383
                                        NULL, num_sectors * iscsilun->block_size,
384 385 386
                                        iscsilun->block_size, 0, 0, 0, 0, 0,
                                        iscsi_co_generic_cb, &iTask);
    }
387
    if (iTask.task == NULL) {
388
        return -ENOMEM;
389
    }
390 391 392 393 394
    scsi_task_set_iov_out(iTask.task, (struct scsi_iovec *) iov->iov,
                          iov->niov);
    while (!iTask.complete) {
        iscsi_set_events(iscsilun);
        qemu_coroutine_yield();
R
Ronnie Sahlberg 已提交
395 396
    }

397 398 399
    if (iTask.task != NULL) {
        scsi_free_scsi_task(iTask.task);
        iTask.task = NULL;
400 401
    }

402
    if (iTask.do_retry) {
403
        iTask.complete = 0;
404
        goto retry;
405 406
    }

407 408
    if (iTask.status != SCSI_STATUS_GOOD) {
        return -EIO;
R
Ronnie Sahlberg 已提交
409 410
    }

411 412
    iscsi_allocationmap_set(iscsilun, sector_num, nb_sectors);

413
    return 0;
R
Ronnie Sahlberg 已提交
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 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525

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);
}

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;
}

526 527 528
static int coroutine_fn iscsi_co_readv(BlockDriverState *bs,
                                       int64_t sector_num, int nb_sectors,
                                       QEMUIOVector *iov)
R
Ronnie Sahlberg 已提交
529
{
530 531
    IscsiLun *iscsilun = bs->opaque;
    struct IscsiTask iTask;
532 533
    uint64_t lba;
    uint32_t num_sectors;
R
Ronnie Sahlberg 已提交
534

535 536
    if (!is_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
        return -EINVAL;
537 538
    }

539 540 541 542 543 544
    if (bs->bl.max_transfer_length && nb_sectors > bs->bl.max_transfer_length) {
        error_report("iSCSI Error: Read of %d sectors exceeds max_xfer_len "
                     "of %d sectors", nb_sectors, bs->bl.max_transfer_length);
        return -EINVAL;
    }

545
    if (iscsilun->lbprz && nb_sectors >= ISCSI_CHECKALLOC_THRES &&
546 547 548 549 550 551 552 553 554 555 556 557 558
        !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;
        }
    }

559 560
    lba = sector_qemu2lun(sector_num, iscsilun);
    num_sectors = sector_qemu2lun(nb_sectors, iscsilun);
561

562 563
    iscsi_co_init_iscsitask(iscsilun, &iTask);
retry:
564
    if (iscsilun->use_16_for_rw) {
565 566 567 568
        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);
569
    } else {
570 571
        iTask.task = iscsi_read10_task(iscsilun->iscsi, iscsilun->lun, lba,
                                       num_sectors * iscsilun->block_size,
572 573
                                       iscsilun->block_size,
                                       0, 0, 0, 0, 0,
574
                                       iscsi_co_generic_cb, &iTask);
575
    }
576
    if (iTask.task == NULL) {
577
        return -ENOMEM;
R
Ronnie Sahlberg 已提交
578
    }
579
    scsi_task_set_iov_in(iTask.task, (struct scsi_iovec *) iov->iov, iov->niov);
580

581 582 583
    while (!iTask.complete) {
        iscsi_set_events(iscsilun);
        qemu_coroutine_yield();
584
    }
R
Ronnie Sahlberg 已提交
585

586 587 588
    if (iTask.task != NULL) {
        scsi_free_scsi_task(iTask.task);
        iTask.task = NULL;
R
Ronnie Sahlberg 已提交
589 590
    }

591
    if (iTask.do_retry) {
592
        iTask.complete = 0;
593
        goto retry;
R
Ronnie Sahlberg 已提交
594 595
    }

596 597
    if (iTask.status != SCSI_STATUS_GOOD) {
        return -EIO;
598 599 600 601 602
    }

    return 0;
}

603
static int coroutine_fn iscsi_co_flush(BlockDriverState *bs)
604 605
{
    IscsiLun *iscsilun = bs->opaque;
606
    struct IscsiTask iTask;
607

608 609 610 611
    if (bs->sg) {
        return 0;
    }

612
    iscsi_co_init_iscsitask(iscsilun, &iTask);
613

614 615 616
retry:
    if (iscsi_synchronizecache10_task(iscsilun->iscsi, iscsilun->lun, 0, 0, 0,
                                      0, iscsi_co_generic_cb, &iTask) == NULL) {
617
        return -ENOMEM;
618
    }
619

620 621 622 623
    while (!iTask.complete) {
        iscsi_set_events(iscsilun);
        qemu_coroutine_yield();
    }
624

625 626 627
    if (iTask.task != NULL) {
        scsi_free_scsi_task(iTask.task);
        iTask.task = NULL;
R
Ronnie Sahlberg 已提交
628 629
    }

630
    if (iTask.do_retry) {
631
        iTask.complete = 0;
632 633
        goto retry;
    }
R
Ronnie Sahlberg 已提交
634

635 636 637 638 639
    if (iTask.status != SCSI_STATUS_GOOD) {
        return -EIO;
    }

    return 0;
R
Ronnie Sahlberg 已提交
640 641
}

642 643 644 645 646 647 648
#ifdef __linux__
static void
iscsi_aio_ioctl_cb(struct iscsi_context *iscsi, int status,
                     void *command_data, void *opaque)
{
    IscsiAIOCB *acb = opaque;

649 650 651
    g_free(acb->buf);
    acb->buf = NULL;

652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
    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);
    }

676
    iscsi_schedule_bh(acb);
677 678
}

679
static BlockAIOCB *iscsi_aio_ioctl(BlockDriverState *bs,
680
        unsigned long int req, void *buf,
681
        BlockCompletionFunc *cb, void *opaque)
682 683 684 685 686 687 688 689
{
    IscsiLun *iscsilun = bs->opaque;
    struct iscsi_context *iscsi = iscsilun->iscsi;
    struct iscsi_data data;
    IscsiAIOCB *acb;

    assert(req == SG_IO);

S
Stefan Hajnoczi 已提交
690
    acb = qemu_aio_get(&iscsi_aiocb_info, bs, cb, opaque);
691 692

    acb->iscsilun = iscsilun;
693 694
    acb->bh          = NULL;
    acb->status      = -EINPROGRESS;
695 696 697 698 699 700 701
    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));
702
        qemu_aio_unref(acb);
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
        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;

723
    data.size = 0;
724
    if (acb->task->xfer_dir == SCSI_XFER_WRITE) {
725 726 727 728 729 730 731 732
        if (acb->ioh->iovec_count == 0) {
            data.data = acb->ioh->dxferp;
            data.size = acb->ioh->dxfer_len;
        } else {
            scsi_task_set_iov_out(acb->task,
                                 (struct scsi_iovec *) acb->ioh->dxferp,
                                 acb->ioh->iovec_count);
        }
733
    }
734

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

    /* tell libiscsi to read straight into the buffer we got from ioctl */
    if (acb->task->xfer_dir == SCSI_XFER_READ) {
746 747 748 749 750 751 752 753 754
        if (acb->ioh->iovec_count == 0) {
            scsi_task_add_data_in_buffer(acb->task,
                                         acb->ioh->dxfer_len,
                                         acb->ioh->dxferp);
        } else {
            scsi_task_set_iov_in(acb->task,
                                 (struct scsi_iovec *) acb->ioh->dxferp,
                                 acb->ioh->iovec_count);
        }
755 756 757 758 759 760 761
    }

    iscsi_set_events(iscsilun);

    return &acb->common;
}

762 763 764 765 766 767
static void ioctl_cb(void *opaque, int status)
{
    int *p_status = opaque;
    *p_status = status;
}

768 769 770
static int iscsi_ioctl(BlockDriverState *bs, unsigned long int req, void *buf)
{
    IscsiLun *iscsilun = bs->opaque;
771
    int status;
772 773 774 775 776 777 778 779

    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;
780 781 782 783 784
    case SG_IO:
        status = -EINPROGRESS;
        iscsi_aio_ioctl(bs, req, buf, ioctl_cb, &status);

        while (status == -EINPROGRESS) {
785
            aio_poll(iscsilun->aio_context, true);
786 787 788
        }

        return 0;
789 790 791 792 793 794 795
    default:
        return -1;
    }
    return 0;
}
#endif

R
Ronnie Sahlberg 已提交
796 797 798 799 800 801 802 803 804 805 806 807
static int64_t
iscsi_getlength(BlockDriverState *bs)
{
    IscsiLun *iscsilun = bs->opaque;
    int64_t len;

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

    return len;
}

808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
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 已提交
826
    list.num = sector_qemu2lun(nb_sectors, iscsilun);
827

P
Peter Lieven 已提交
828
    iscsi_co_init_iscsitask(iscsilun, &iTask);
829
retry:
P
Peter Lieven 已提交
830 831
    if (iscsi_unmap_task(iscsilun->iscsi, iscsilun->lun, 0, 0, &list, 1,
                     iscsi_co_generic_cb, &iTask) == NULL) {
832
        return -ENOMEM;
P
Peter Lieven 已提交
833
    }
834

P
Peter Lieven 已提交
835 836 837 838
    while (!iTask.complete) {
        iscsi_set_events(iscsilun);
        qemu_coroutine_yield();
    }
839

P
Peter Lieven 已提交
840 841 842 843
    if (iTask.task != NULL) {
        scsi_free_scsi_task(iTask.task);
        iTask.task = NULL;
    }
844

P
Peter Lieven 已提交
845
    if (iTask.do_retry) {
846
        iTask.complete = 0;
P
Peter Lieven 已提交
847 848
        goto retry;
    }
849

P
Peter Lieven 已提交
850 851 852 853 854 855
    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;
    }
856

P
Peter Lieven 已提交
857 858
    if (iTask.status != SCSI_STATUS_GOOD) {
        return -EIO;
859 860
    }

861 862
    iscsi_allocationmap_clear(iscsilun, sector_num, nb_sectors);

863 864 865
    return 0;
}

P
Peter Lieven 已提交
866 867 868 869 870 871 872 873
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;
874
    bool use_16_for_ws = iscsilun->use_16_for_rw;
P
Peter Lieven 已提交
875 876 877 878 879

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

880 881 882 883 884 885 886 887 888 889 890
    if (flags & BDRV_REQ_MAY_UNMAP) {
        if (!use_16_for_ws && !iscsilun->lbp.lbpws10) {
            /* WRITESAME10 with UNMAP is unsupported try WRITESAME16 */
            use_16_for_ws = true;
        }
        if (use_16_for_ws && !iscsilun->lbp.lbpws) {
            /* WRITESAME16 with UNMAP is not supported by the target,
             * fall back and try WRITESAME10/16 without UNMAP */
            flags &= ~BDRV_REQ_MAY_UNMAP;
            use_16_for_ws = iscsilun->use_16_for_rw;
        }
891 892
    }

893
    if (!(flags & BDRV_REQ_MAY_UNMAP) && !iscsilun->has_write_same) {
894
        /* WRITESAME without UNMAP is not supported by the target */
P
Peter Lieven 已提交
895 896 897 898 899 900 901
        return -ENOTSUP;
    }

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

    if (iscsilun->zeroblock == NULL) {
902 903 904 905
        iscsilun->zeroblock = g_try_malloc0(iscsilun->block_size);
        if (iscsilun->zeroblock == NULL) {
            return -ENOMEM;
        }
P
Peter Lieven 已提交
906 907 908 909
    }

    iscsi_co_init_iscsitask(iscsilun, &iTask);
retry:
910 911 912 913 914 915 916 917 918 919 920 921
    if (use_16_for_ws) {
        iTask.task = 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);
    } else {
        iTask.task = iscsi_writesame10_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);
    }
    if (iTask.task == NULL) {
922
        return -ENOMEM;
P
Peter Lieven 已提交
923 924 925 926 927 928 929
    }

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

930 931
    if (iTask.status == SCSI_STATUS_CHECK_CONDITION &&
        iTask.task->sense.key == SCSI_SENSE_ILLEGAL_REQUEST &&
932 933
        (iTask.task->sense.ascq == SCSI_SENSE_ASCQ_INVALID_OPERATION_CODE ||
         iTask.task->sense.ascq == SCSI_SENSE_ASCQ_INVALID_FIELD_IN_CDB)) {
934 935 936 937 938 939
        /* WRITE SAME is not supported by the target */
        iscsilun->has_write_same = false;
        scsi_free_scsi_task(iTask.task);
        return -ENOTSUP;
    }

P
Peter Lieven 已提交
940 941 942 943 944 945
    if (iTask.task != NULL) {
        scsi_free_scsi_task(iTask.task);
        iTask.task = NULL;
    }

    if (iTask.do_retry) {
946
        iTask.complete = 0;
P
Peter Lieven 已提交
947 948 949 950 951 952 953
        goto retry;
    }

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

954 955 956 957 958 959
    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 已提交
960 961 962
    return 0;
}

963 964
static void parse_chap(struct iscsi_context *iscsi, const char *target,
                       Error **errp)
965 966 967 968 969 970 971 972
{
    QemuOptsList *list;
    QemuOpts *opts;
    const char *user = NULL;
    const char *password = NULL;

    list = qemu_find_opts("iscsi");
    if (!list) {
973
        return;
974 975 976 977 978 979
    }

    opts = qemu_opts_find(list, target);
    if (opts == NULL) {
        opts = QTAILQ_FIRST(&list->head);
        if (!opts) {
980
            return;
981 982 983 984 985
        }
    }

    user = qemu_opt_get(opts, "user");
    if (!user) {
986
        return;
987 988 989 990
    }

    password = qemu_opt_get(opts, "password");
    if (!password) {
991 992
        error_setg(errp, "CHAP username specified but no password was given");
        return;
993 994 995
    }

    if (iscsi_set_initiator_username_pwd(iscsi, user, password)) {
996
        error_setg(errp, "Failed to set initiator username and password");
997 998 999
    }
}

1000 1001
static void parse_header_digest(struct iscsi_context *iscsi, const char *target,
                                Error **errp)
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 1030 1031 1032 1033
{
    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 {
1034
        error_setg(errp, "Invalid header-digest setting : %s", digest);
1035 1036 1037 1038 1039 1040 1041
    }
}

static char *parse_initiator_name(const char *target)
{
    QemuOptsList *list;
    QemuOpts *opts;
1042 1043 1044
    const char *name;
    char *iscsi_name;
    UuidInfo *uuid_info;
1045 1046

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

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

1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085
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;
    }

1086
    timer_mod(iscsilun->nop_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + NOP_INTERVAL);
1087 1088 1089
    iscsi_set_events(iscsilun);
}

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

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

        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) {
1109
                    error_setg(errp, "iSCSI: Failed to unmarshall readcapacity16 data.");
1110 1111 1112
                } else {
                    iscsilun->block_size = rc16->block_length;
                    iscsilun->num_blocks = rc16->returned_lba + 1;
1113 1114
                    iscsilun->lbpme = rc16->lbpme;
                    iscsilun->lbprz = rc16->lbprz;
1115
                    iscsilun->use_16_for_rw = (rc16->returned_lba > 0xffffffff);
1116 1117 1118 1119 1120 1121 1122 1123
                }
            }
            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) {
1124
                    error_setg(errp, "iSCSI: Failed to unmarshall readcapacity10 data.");
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
                } 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:
1137
            return;
P
Peter Lieven 已提交
1138
        }
1139 1140 1141
    } while (task != NULL && task->status == SCSI_STATUS_CHECK_CONDITION
             && task->sense.key == SCSI_SENSE_UNIT_ATTENTION
             && retries-- > 0);
P
Peter Lieven 已提交
1142

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

1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
/* 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 已提交
1165
static struct scsi_task *iscsi_do_inquiry(struct iscsi_context *iscsi, int lun,
1166
                                          int evpd, int pc, void **inq, Error **errp)
P
Paolo Bonzini 已提交
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179
{
    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);
1180 1181 1182
        if (task == NULL || task->status != SCSI_STATUS_GOOD) {
            goto fail;
        }
P
Paolo Bonzini 已提交
1183
    }
1184

1185 1186 1187
    *inq = scsi_datain_unmarshall(task);
    if (*inq == NULL) {
        error_setg(errp, "iSCSI: failed to unmarshall inquiry datain blob");
1188
        goto fail_with_err;
1189 1190
    }

P
Paolo Bonzini 已提交
1191
    return task;
1192 1193

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

1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
static void iscsi_detach_aio_context(BlockDriverState *bs)
{
    IscsiLun *iscsilun = bs->opaque;

    aio_set_fd_handler(iscsilun->aio_context,
                       iscsi_get_fd(iscsilun->iscsi),
                       NULL, NULL, NULL);
    iscsilun->events = 0;

    if (iscsilun->nop_timer) {
        timer_del(iscsilun->nop_timer);
        timer_free(iscsilun->nop_timer);
        iscsilun->nop_timer = NULL;
    }
}

static void iscsi_attach_aio_context(BlockDriverState *bs,
                                     AioContext *new_context)
{
    IscsiLun *iscsilun = bs->opaque;

    iscsilun->aio_context = new_context;
    iscsi_set_events(iscsilun);

    /* Set up a timer for sending out iSCSI NOPs */
    iscsilun->nop_timer = aio_timer_new(iscsilun->aio_context,
                                        QEMU_CLOCK_REALTIME, SCALE_MS,
                                        iscsi_nop_timed_event, iscsilun);
    timer_mod(iscsilun->nop_timer,
              qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + NOP_INTERVAL);
}

1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
static bool iscsi_is_write_protected(IscsiLun *iscsilun)
{
    struct scsi_task *task;
    struct scsi_mode_sense *ms = NULL;
    bool wrprotected = false;

    task = iscsi_modesense6_sync(iscsilun->iscsi, iscsilun->lun,
                                 1, SCSI_MODESENSE_PC_CURRENT,
                                 0x3F, 0, 255);
    if (task == NULL) {
        error_report("iSCSI: Failed to send MODE_SENSE(6) command: %s",
                     iscsi_get_error(iscsilun->iscsi));
        goto out;
    }

    if (task->status != SCSI_STATUS_GOOD) {
        error_report("iSCSI: Failed MODE_SENSE(6), LUN assumed writable");
        goto out;
    }
    ms = scsi_datain_unmarshall(task);
    if (!ms) {
        error_report("iSCSI: Failed to unmarshall MODE_SENSE(6) data: %s",
                     iscsi_get_error(iscsilun->iscsi));
        goto out;
    }
    wrprotected = ms->device_specific_parameter & 0x80;

out:
    if (task) {
        scsi_free_scsi_task(task);
    }
    return wrprotected;
}

R
Ronnie Sahlberg 已提交
1269 1270 1271 1272
/*
 * We support iscsi url's on the form
 * iscsi://[<username>%<password>@]<host>[:<port>]/<targetname>/<lun>
 */
M
Max Reitz 已提交
1273 1274
static int iscsi_open(BlockDriverState *bs, QDict *options, int flags,
                      Error **errp)
R
Ronnie Sahlberg 已提交
1275 1276 1277 1278
{
    IscsiLun *iscsilun = bs->opaque;
    struct iscsi_context *iscsi = NULL;
    struct iscsi_url *iscsi_url = NULL;
P
Peter Lieven 已提交
1279 1280
    struct scsi_task *task = NULL;
    struct scsi_inquiry_standard *inq = NULL;
1281
    struct scsi_inquiry_supported_pages *inq_vpd;
1282
    char *initiator_name = NULL;
1283 1284 1285
    QemuOpts *opts;
    Error *local_err = NULL;
    const char *filename;
1286
    int i, ret = 0;
R
Ronnie Sahlberg 已提交
1287 1288

    if ((BDRV_SECTOR_SIZE % 512) != 0) {
1289 1290 1291
        error_setg(errp, "iSCSI: Invalid BDRV_SECTOR_SIZE. "
                   "BDRV_SECTOR_SIZE(%lld) is not a multiple "
                   "of 512", BDRV_SECTOR_SIZE);
R
Ronnie Sahlberg 已提交
1292 1293 1294
        return -EINVAL;
    }

1295
    opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
1296
    qemu_opts_absorb_qdict(opts, options, &local_err);
1297
    if (local_err) {
1298
        error_propagate(errp, local_err);
1299 1300 1301 1302 1303 1304
        ret = -EINVAL;
        goto out;
    }

    filename = qemu_opt_get(opts, "filename");

R
Ronnie Sahlberg 已提交
1305 1306
    iscsi_url = iscsi_parse_full_url(iscsi, filename);
    if (iscsi_url == NULL) {
1307
        error_setg(errp, "Failed to parse URL : %s", filename);
R
Ronnie Sahlberg 已提交
1308
        ret = -EINVAL;
1309
        goto out;
R
Ronnie Sahlberg 已提交
1310 1311
    }

1312 1313 1314 1315 1316 1317
    memset(iscsilun, 0, sizeof(IscsiLun));

    initiator_name = parse_initiator_name(iscsi_url->target);

    iscsi = iscsi_create_context(initiator_name);
    if (iscsi == NULL) {
1318
        error_setg(errp, "iSCSI: Failed to create iSCSI context.");
1319
        ret = -ENOMEM;
1320
        goto out;
1321 1322
    }

R
Ronnie Sahlberg 已提交
1323
    if (iscsi_set_targetname(iscsi, iscsi_url->target)) {
1324
        error_setg(errp, "iSCSI: Failed to set target name.");
R
Ronnie Sahlberg 已提交
1325
        ret = -EINVAL;
1326
        goto out;
R
Ronnie Sahlberg 已提交
1327 1328 1329 1330 1331 1332
    }

    if (iscsi_url->user != NULL) {
        ret = iscsi_set_initiator_username_pwd(iscsi, iscsi_url->user,
                                              iscsi_url->passwd);
        if (ret != 0) {
1333
            error_setg(errp, "Failed to set initiator username and password");
R
Ronnie Sahlberg 已提交
1334
            ret = -EINVAL;
1335
            goto out;
R
Ronnie Sahlberg 已提交
1336 1337
        }
    }
1338 1339

    /* check if we got CHAP username/password via the options */
1340 1341 1342
    parse_chap(iscsi, iscsi_url->target, &local_err);
    if (local_err != NULL) {
        error_propagate(errp, local_err);
1343
        ret = -EINVAL;
1344
        goto out;
1345 1346
    }

R
Ronnie Sahlberg 已提交
1347
    if (iscsi_set_session_type(iscsi, ISCSI_SESSION_NORMAL) != 0) {
1348
        error_setg(errp, "iSCSI: Failed to set session type to normal.");
R
Ronnie Sahlberg 已提交
1349
        ret = -EINVAL;
1350
        goto out;
R
Ronnie Sahlberg 已提交
1351 1352 1353 1354
    }

    iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE_CRC32C);

1355
    /* check if we got HEADER_DIGEST via the options */
1356 1357 1358 1359 1360 1361
    parse_header_digest(iscsi, iscsi_url->target, &local_err);
    if (local_err != NULL) {
        error_propagate(errp, local_err);
        ret = -EINVAL;
        goto out;
    }
1362

P
Peter Lieven 已提交
1363
    if (iscsi_full_connect_sync(iscsi, iscsi_url->portal, iscsi_url->lun) != 0) {
1364
        error_setg(errp, "iSCSI: Failed to connect to LUN : %s",
P
Peter Lieven 已提交
1365 1366 1367 1368
            iscsi_get_error(iscsi));
        ret = -EINVAL;
        goto out;
    }
R
Ronnie Sahlberg 已提交
1369 1370

    iscsilun->iscsi = iscsi;
1371
    iscsilun->aio_context = bdrv_get_aio_context(bs);
R
Ronnie Sahlberg 已提交
1372
    iscsilun->lun   = iscsi_url->lun;
1373
    iscsilun->has_write_same = true;
R
Ronnie Sahlberg 已提交
1374

1375 1376 1377
    task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 0, 0,
                            (void **) &inq, errp);
    if (task == NULL) {
R
Ronnie Sahlberg 已提交
1378
        ret = -EINVAL;
1379
        goto out;
R
Ronnie Sahlberg 已提交
1380
    }
P
Peter Lieven 已提交
1381
    iscsilun->type = inq->periperal_device_type;
1382 1383
    scsi_free_scsi_task(task);
    task = NULL;
P
Peter Lieven 已提交
1384

1385
    iscsilun->write_protected = iscsi_is_write_protected(iscsilun);
1386 1387
    /* Check the write protect flag of the LUN if we want to write */
    if (iscsilun->type == TYPE_DISK && (flags & BDRV_O_RDWR) &&
1388
        iscsilun->write_protected) {
1389 1390 1391 1392 1393
        error_setg(errp, "Cannot open a write protected LUN as read-write");
        ret = -EACCES;
        goto out;
    }

1394 1395 1396
    iscsi_readcapacity_sync(iscsilun, &local_err);
    if (local_err != NULL) {
        error_propagate(errp, local_err);
1397
        ret = -EINVAL;
P
Peter Lieven 已提交
1398
        goto out;
P
Peter Lieven 已提交
1399
    }
1400
    bs->total_sectors = sector_lun2qemu(iscsilun->num_blocks, iscsilun);
P
Paolo Bonzini 已提交
1401
    bs->request_alignment = iscsilun->block_size;
P
Peter Lieven 已提交
1402

1403 1404 1405
    /* 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.
1406
     */
1407
    if (iscsilun->type != TYPE_DISK && iscsilun->type != TYPE_ROM) {
1408 1409 1410
        bs->sg = 1;
    }

1411 1412 1413 1414 1415 1416
    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;
1417
    }
1418 1419 1420
    for (i = 0; i < inq_vpd->num_pages; i++) {
        struct scsi_task *inq_task;
        struct scsi_inquiry_logical_block_provisioning *inq_lbp;
1421
        struct scsi_inquiry_block_limits *inq_bl;
1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448
        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;
1449 1450
        }
    }
1451 1452
    scsi_free_scsi_task(task);
    task = NULL;
1453

1454
    iscsi_attach_aio_context(bs, iscsilun->aio_context);
1455

1456 1457 1458
    /* 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 */
1459
    if (iscsilun->bl.opt_unmap_gran * iscsilun->block_size >= 4 * 1024 &&
1460 1461 1462 1463
        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 (iscsilun->lbprz && !(bs->open_flags & BDRV_O_NOCACHE)) {
1464 1465 1466 1467
            iscsilun->allocationmap = iscsi_allocationmap_init(iscsilun);
            if (iscsilun->allocationmap == NULL) {
                ret = -ENOMEM;
            }
1468 1469 1470
        }
    }

1471
out:
1472
    qemu_opts_del(opts);
1473
    g_free(initiator_name);
R
Ronnie Sahlberg 已提交
1474 1475 1476
    if (iscsi_url != NULL) {
        iscsi_destroy_url(iscsi_url);
    }
P
Peter Lieven 已提交
1477 1478 1479
    if (task != NULL) {
        scsi_free_scsi_task(task);
    }
1480 1481 1482 1483 1484 1485

    if (ret) {
        if (iscsi != NULL) {
            iscsi_destroy_context(iscsi);
        }
        memset(iscsilun, 0, sizeof(IscsiLun));
R
Ronnie Sahlberg 已提交
1486 1487 1488 1489 1490 1491 1492 1493 1494
    }
    return ret;
}

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

1495
    iscsi_detach_aio_context(bs);
R
Ronnie Sahlberg 已提交
1496
    iscsi_destroy_context(iscsi);
P
Peter Lieven 已提交
1497
    g_free(iscsilun->zeroblock);
1498
    g_free(iscsilun->allocationmap);
R
Ronnie Sahlberg 已提交
1499 1500 1501
    memset(iscsilun, 0, sizeof(IscsiLun));
}

1502
static int sector_limits_lun2qemu(int64_t sector, IscsiLun *iscsilun)
1503
{
1504 1505
    return MIN(sector_lun2qemu(sector, iscsilun), INT_MAX / 2 + 1);
}
1506

1507 1508
static void iscsi_refresh_limits(BlockDriverState *bs, Error **errp)
{
1509 1510
    /* We don't actually refresh here, but just return data queried in
     * iscsi_open(): iscsi targets don't change their limits. */
1511 1512 1513 1514 1515 1516 1517 1518 1519 1520

    IscsiLun *iscsilun = bs->opaque;
    uint32_t max_xfer_len = iscsilun->use_16_for_rw ? 0xffffffff : 0xffff;

    if (iscsilun->bl.max_xfer_len) {
        max_xfer_len = MIN(max_xfer_len, iscsilun->bl.max_xfer_len);
    }

    bs->bl.max_transfer_length = sector_limits_lun2qemu(max_xfer_len, iscsilun);

1521
    if (iscsilun->lbp.lbpu) {
1522
        if (iscsilun->bl.max_unmap < 0xffffffff) {
1523 1524
            bs->bl.max_discard =
                sector_limits_lun2qemu(iscsilun->bl.max_unmap, iscsilun);
1525
        }
1526 1527
        bs->bl.discard_alignment =
            sector_limits_lun2qemu(iscsilun->bl.opt_unmap_gran, iscsilun);
1528
    }
1529

1530
    if (iscsilun->bl.max_ws_len < 0xffffffff) {
1531 1532
        bs->bl.max_write_zeroes =
            sector_limits_lun2qemu(iscsilun->bl.max_ws_len, iscsilun);
1533 1534
    }
    if (iscsilun->lbp.lbpws) {
1535 1536
        bs->bl.write_zeroes_alignment =
            sector_limits_lun2qemu(iscsilun->bl.opt_unmap_gran, iscsilun);
1537
    }
1538 1539
    bs->bl.opt_transfer_length =
        sector_limits_lun2qemu(iscsilun->bl.opt_xfer_len, iscsilun);
1540
}
1541

1542 1543
/* Note that this will not re-establish a connection with an iSCSI target - it
 * is effectively a NOP.  */
1544 1545 1546
static int iscsi_reopen_prepare(BDRVReopenState *state,
                                BlockReopenQueue *queue, Error **errp)
{
1547 1548 1549 1550 1551 1552
    IscsiLun *iscsilun = state->bs->opaque;

    if (state->flags & BDRV_O_RDWR && iscsilun->write_protected) {
        error_setg(errp, "Cannot open a write protected LUN as read-write");
        return -EACCES;
    }
1553 1554 1555
    return 0;
}

P
Peter Lieven 已提交
1556 1557 1558
static int iscsi_truncate(BlockDriverState *bs, int64_t offset)
{
    IscsiLun *iscsilun = bs->opaque;
1559
    Error *local_err = NULL;
P
Peter Lieven 已提交
1560 1561 1562 1563 1564

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

1565 1566 1567 1568
    iscsi_readcapacity_sync(iscsilun, &local_err);
    if (local_err != NULL) {
        error_free(local_err);
        return -EIO;
P
Peter Lieven 已提交
1569 1570 1571 1572 1573 1574
    }

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

1575 1576
    if (iscsilun->allocationmap != NULL) {
        g_free(iscsilun->allocationmap);
1577
        iscsilun->allocationmap = iscsi_allocationmap_init(iscsilun);
1578 1579
    }

P
Peter Lieven 已提交
1580 1581 1582
    return 0;
}

1583
static int iscsi_create(const char *filename, QemuOpts *opts, Error **errp)
P
Peter Lieven 已提交
1584 1585 1586
{
    int ret = 0;
    int64_t total_size = 0;
1587
    BlockDriverState *bs;
P
Peter Lieven 已提交
1588
    IscsiLun *iscsilun = NULL;
1589
    QDict *bs_options;
P
Peter Lieven 已提交
1590

1591
    bs = bdrv_new();
P
Peter Lieven 已提交
1592 1593

    /* Read out options */
1594 1595
    total_size = DIV_ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
                              BDRV_SECTOR_SIZE);
1596
    bs->opaque = g_new0(struct IscsiLun, 1);
1597
    iscsilun = bs->opaque;
P
Peter Lieven 已提交
1598

1599 1600
    bs_options = qdict_new();
    qdict_put(bs_options, "filename", qstring_from_str(filename));
M
Max Reitz 已提交
1601
    ret = iscsi_open(bs, bs_options, 0, NULL);
1602 1603
    QDECREF(bs_options);

P
Peter Lieven 已提交
1604 1605 1606
    if (ret != 0) {
        goto out;
    }
1607
    iscsi_detach_aio_context(bs);
P
Peter Lieven 已提交
1608 1609 1610 1611
    if (iscsilun->type != TYPE_DISK) {
        ret = -ENODEV;
        goto out;
    }
1612
    if (bs->total_sectors < total_size) {
P
Peter Lieven 已提交
1613
        ret = -ENOSPC;
1614
        goto out;
P
Peter Lieven 已提交
1615 1616 1617 1618 1619 1620 1621
    }

    ret = 0;
out:
    if (iscsilun->iscsi != NULL) {
        iscsi_destroy_context(iscsilun->iscsi);
    }
1622 1623
    g_free(bs->opaque);
    bs->opaque = NULL;
F
Fam Zheng 已提交
1624
    bdrv_unref(bs);
P
Peter Lieven 已提交
1625 1626 1627
    return ret;
}

P
Peter Lieven 已提交
1628 1629 1630 1631 1632
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;
1633
    bdi->cluster_size = iscsilun->cluster_sectors * BDRV_SECTOR_SIZE;
P
Peter Lieven 已提交
1634 1635 1636
    return 0;
}

1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647
static QemuOptsList iscsi_create_opts = {
    .name = "iscsi-create-opts",
    .head = QTAILQ_HEAD_INITIALIZER(iscsi_create_opts.head),
    .desc = {
        {
            .name = BLOCK_OPT_SIZE,
            .type = QEMU_OPT_SIZE,
            .help = "Virtual disk size"
        },
        { /* end of list */ }
    }
P
Peter Lieven 已提交
1648 1649
};

R
Ronnie Sahlberg 已提交
1650 1651 1652 1653 1654
static BlockDriver bdrv_iscsi = {
    .format_name     = "iscsi",
    .protocol_name   = "iscsi",

    .instance_size   = sizeof(IscsiLun),
1655
    .bdrv_needs_filename = true,
R
Ronnie Sahlberg 已提交
1656 1657
    .bdrv_file_open  = iscsi_open,
    .bdrv_close      = iscsi_close,
C
Chunyan Liu 已提交
1658
    .bdrv_create     = iscsi_create,
1659
    .create_opts     = &iscsi_create_opts,
1660
    .bdrv_reopen_prepare  = iscsi_reopen_prepare,
R
Ronnie Sahlberg 已提交
1661 1662

    .bdrv_getlength  = iscsi_getlength,
P
Peter Lieven 已提交
1663
    .bdrv_get_info   = iscsi_get_info,
P
Peter Lieven 已提交
1664
    .bdrv_truncate   = iscsi_truncate,
1665
    .bdrv_refresh_limits = iscsi_refresh_limits,
R
Ronnie Sahlberg 已提交
1666

P
Peter Lieven 已提交
1667
    .bdrv_co_get_block_status = iscsi_co_get_block_status,
1668
    .bdrv_co_discard      = iscsi_co_discard,
P
Peter Lieven 已提交
1669
    .bdrv_co_write_zeroes = iscsi_co_write_zeroes,
1670 1671 1672
    .bdrv_co_readv         = iscsi_co_readv,
    .bdrv_co_writev        = iscsi_co_writev,
    .bdrv_co_flush_to_disk = iscsi_co_flush,
1673

1674 1675 1676 1677
#ifdef __linux__
    .bdrv_ioctl       = iscsi_ioctl,
    .bdrv_aio_ioctl   = iscsi_aio_ioctl,
#endif
1678 1679 1680

    .bdrv_detach_aio_context = iscsi_detach_aio_context,
    .bdrv_attach_aio_context = iscsi_attach_aio_context,
R
Ronnie Sahlberg 已提交
1681 1682
};

1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708
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 已提交
1709 1710 1711
static void iscsi_block_init(void)
{
    bdrv_register(&bdrv_iscsi);
1712
    qemu_add_opts(&qemu_iscsi_opts);
R
Ronnie Sahlberg 已提交
1713 1714 1715
}

block_init(iscsi_block_init);