iscsi.c 67.2 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-2016 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
 *
 * 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.
 */

P
Peter Maydell 已提交
26
#include "qemu/osdep.h"
R
Ronnie Sahlberg 已提交
27 28

#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"
F
Fam Zheng 已提交
39
#include "qemu/uuid.h"
40
#include "qmp-commands.h"
41
#include "qapi/qmp/qstring.h"
42
#include "crypto/secret.h"
R
Ronnie Sahlberg 已提交
43 44 45 46

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

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

typedef struct IscsiLun {
    struct iscsi_context *iscsi;
53
    AioContext *aio_context;
R
Ronnie Sahlberg 已提交
54
    int lun;
55
    enum scsi_inquiry_peripheral_device_type type;
R
Ronnie Sahlberg 已提交
56
    int block_size;
57
    uint64_t num_blocks;
58
    int events;
59
    QEMUTimer *nop_timer;
60
    QEMUTimer *event_timer;
61 62
    struct scsi_inquiry_logical_block_provisioning lbp;
    struct scsi_inquiry_block_limits bl;
P
Peter Lieven 已提交
63
    unsigned char *zeroblock;
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
    /* The allocmap tracks which clusters (pages) on the iSCSI target are
     * allocated and which are not. In case a target returns zeros for
     * unallocated pages (iscsilun->lprz) we can directly return zeros instead
     * of reading zeros over the wire if a read request falls within an
     * unallocated block. As there are 3 possible states we need 2 bitmaps to
     * track. allocmap_valid keeps track if QEMU's information about a page is
     * valid. allocmap tracks if a page is allocated or not. In case QEMU has no
     * valid information about a page the corresponding allocmap entry should be
     * switched to unallocated as well to force a new lookup of the allocation
     * status as lookups are generally skipped if a page is suspect to be
     * allocated. If a iSCSI target is opened with cache.direct = on the
     * allocmap_valid does not exist turning all cached information invalid so
     * that a fresh lookup is made for any page even if allocmap entry returns
     * it's unallocated. */
    unsigned long *allocmap;
    unsigned long *allocmap_valid;
    long allocmap_size;
81
    int cluster_sectors;
82
    bool use_16_for_rw;
83
    bool write_protected;
84 85
    bool lbpme;
    bool lbprz;
86
    bool dpofua;
87
    bool has_write_same;
88
    bool request_timed_out;
R
Ronnie Sahlberg 已提交
89 90
} IscsiLun;

P
Peter Lieven 已提交
91 92 93 94 95 96 97
typedef struct IscsiTask {
    int status;
    int complete;
    int retries;
    int do_retry;
    struct scsi_task *task;
    Coroutine *co;
98
    IscsiLun *iscsilun;
99
    QEMUTimer retry_timer;
100
    int err_code;
P
Peter Lieven 已提交
101 102
} IscsiTask;

R
Ronnie Sahlberg 已提交
103
typedef struct IscsiAIOCB {
104
    BlockAIOCB common;
R
Ronnie Sahlberg 已提交
105 106 107 108 109 110
    QEMUIOVector *qiov;
    QEMUBH *bh;
    IscsiLun *iscsilun;
    struct scsi_task *task;
    uint8_t *buf;
    int status;
111 112
    int64_t sector_num;
    int nb_sectors;
113
    int ret;
114 115 116
#ifdef __linux__
    sg_io_hdr_t *ioh;
#endif
R
Ronnie Sahlberg 已提交
117 118
} IscsiAIOCB;

119 120
/* libiscsi uses time_t so its enough to process events every second */
#define EVENT_INTERVAL 1000
121 122
#define NOP_INTERVAL 5000
#define MAX_NOP_FAILURES 3
123
#define ISCSI_CMD_RETRIES ARRAY_SIZE(iscsi_retry_times)
P
Peter Lieven 已提交
124
static const unsigned iscsi_retry_times[] = {8, 32, 128, 512, 2048, 8192, 32768};
125

S
Stefan Weil 已提交
126
/* this threshold is a trade-off knob to choose between
127 128 129 130 131 132 133
 * 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
134

135
static void
136
iscsi_bh_cb(void *p)
137 138 139 140 141
{
    IscsiAIOCB *acb = p;

    qemu_bh_delete(acb->bh);

142 143 144
    g_free(acb->buf);
    acb->buf = NULL;

145
    acb->common.cb(acb->common.opaque, acb->status);
146

147 148 149 150 151
    if (acb->task != NULL) {
        scsi_free_scsi_task(acb->task);
        acb->task = NULL;
    }

152
    qemu_aio_unref(acb);
153 154
}

155 156
static void
iscsi_schedule_bh(IscsiAIOCB *acb)
157
{
158 159 160
    if (acb->bh) {
        return;
    }
161
    acb->bh = aio_bh_new(acb->iscsilun->aio_context, iscsi_bh_cb, acb);
162 163 164
    qemu_bh_schedule(acb->bh);
}

165 166 167
static void iscsi_co_generic_bh_cb(void *opaque)
{
    struct IscsiTask *iTask = opaque;
168

169
    iTask->complete = 1;
170
    aio_co_wake(iTask->co);
171 172
}

173 174 175
static void iscsi_retry_timer_expired(void *opaque)
{
    struct IscsiTask *iTask = opaque;
176
    iTask->complete = 1;
177
    if (iTask->co) {
178
        aio_co_wake(iTask->co);
179 180 181 182 183 184 185 186
    }
}

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

187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
/* SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST was introduced in
 * libiscsi 1.10.0, together with other constants we need.  Use it as
 * a hint that we have to define them ourselves if needed, to keep the
 * minimum required libiscsi version at 1.9.0.  We use an ASCQ macro for
 * the test because SCSI_STATUS_* is an enum.
 *
 * To guard against future changes where SCSI_SENSE_ASCQ_* also becomes
 * an enum, check against the LIBISCSI_API_VERSION macro, which was
 * introduced in 1.11.0.  If it is present, there is no need to define
 * anything.
 */
#if !defined(SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST) && \
    !defined(LIBISCSI_API_VERSION)
#define SCSI_STATUS_TASK_SET_FULL                          0x28
#define SCSI_STATUS_TIMEOUT                                0x0f000002
#define SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST    0x2600
#define SCSI_SENSE_ASCQ_PARAMETER_LIST_LENGTH_ERROR        0x1a00
204 205
#endif

206 207 208 209
#ifndef LIBISCSI_API_VERSION
#define LIBISCSI_API_VERSION 20130701
#endif

210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
static int iscsi_translate_sense(struct scsi_sense *sense)
{
    int ret;

    switch (sense->key) {
    case SCSI_SENSE_NOT_READY:
        return -EBUSY;
    case SCSI_SENSE_DATA_PROTECTION:
        return -EACCES;
    case SCSI_SENSE_COMMAND_ABORTED:
        return -ECANCELED;
    case SCSI_SENSE_ILLEGAL_REQUEST:
        /* Parse ASCQ */
        break;
    default:
        return -EIO;
    }
    switch (sense->ascq) {
    case SCSI_SENSE_ASCQ_PARAMETER_LIST_LENGTH_ERROR:
    case SCSI_SENSE_ASCQ_INVALID_OPERATION_CODE:
    case SCSI_SENSE_ASCQ_INVALID_FIELD_IN_CDB:
    case SCSI_SENSE_ASCQ_INVALID_FIELD_IN_PARAMETER_LIST:
        ret = -EINVAL;
        break;
    case SCSI_SENSE_ASCQ_LBA_OUT_OF_RANGE:
        ret = -ENOSPC;
        break;
    case SCSI_SENSE_ASCQ_LOGICAL_UNIT_NOT_SUPPORTED:
        ret = -ENOTSUP;
        break;
    case SCSI_SENSE_ASCQ_MEDIUM_NOT_PRESENT:
    case SCSI_SENSE_ASCQ_MEDIUM_NOT_PRESENT_TRAY_CLOSED:
    case SCSI_SENSE_ASCQ_MEDIUM_NOT_PRESENT_TRAY_OPEN:
        ret = -ENOMEDIUM;
        break;
    case SCSI_SENSE_ASCQ_WRITE_PROTECTED:
        ret = -EACCES;
        break;
    default:
        ret = -EIO;
        break;
    }
    return ret;
}

P
Peter Lieven 已提交
255 256 257 258 259 260 261 262 263 264 265 266
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) {
267 268 269 270 271 272 273 274
        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;
            }
275
            if (status == SCSI_STATUS_BUSY ||
276 277
                status == SCSI_STATUS_TIMEOUT ||
                status == SCSI_STATUS_TASK_SET_FULL) {
278 279
                unsigned retry_time =
                    exp_random(iscsi_retry_times[iTask->retries - 1]);
280
                if (status == SCSI_STATUS_TIMEOUT) {
281 282 283 284 285 286 287
                    /* make sure the request is rescheduled AFTER the
                     * reconnect is initiated */
                    retry_time = EVENT_INTERVAL * 2;
                    iTask->iscsilun->request_timed_out = true;
                }
                error_report("iSCSI Busy/TaskSetFull/TimeOut"
                             " (retry #%u in %u ms): %s",
288 289 290 291 292 293 294 295 296 297 298
                             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;
            }
        }
299
        iTask->err_code = iscsi_translate_sense(&task->sense);
300
        error_report("iSCSI Failure: %s", iscsi_get_error(iscsi));
P
Peter Lieven 已提交
301 302 303 304
    }

out:
    if (iTask->co) {
P
Paolo Bonzini 已提交
305 306
        aio_bh_schedule_oneshot(iTask->iscsilun->aio_context,
                                 iscsi_co_generic_bh_cb, iTask);
307 308
    } else {
        iTask->complete = 1;
P
Peter Lieven 已提交
309 310 311 312 313 314
    }
}

static void iscsi_co_init_iscsitask(IscsiLun *iscsilun, struct IscsiTask *iTask)
{
    *iTask = (struct IscsiTask) {
315 316
        .co         = qemu_coroutine_self(),
        .iscsilun   = iscsilun,
P
Peter Lieven 已提交
317 318
    };
}
319

R
Ronnie Sahlberg 已提交
320 321 322 323
static void
iscsi_abort_task_cb(struct iscsi_context *iscsi, int status, void *command_data,
                    void *private_data)
{
324 325 326 327
    IscsiAIOCB *acb = private_data;

    acb->status = -ECANCELED;
    iscsi_schedule_bh(acb);
R
Ronnie Sahlberg 已提交
328 329 330
}

static void
331
iscsi_aio_cancel(BlockAIOCB *blockacb)
R
Ronnie Sahlberg 已提交
332 333 334 335
{
    IscsiAIOCB *acb = (IscsiAIOCB *)blockacb;
    IscsiLun *iscsilun = acb->iscsilun;

336 337 338 339
    if (acb->status != -EINPROGRESS) {
        return;
    }

340
    /* send a task mgmt call to the target to cancel the task on the target */
341
    iscsi_task_mgmt_abort_task_async(iscsilun->iscsi, acb->task,
342
                                     iscsi_abort_task_cb, acb);
343

R
Ronnie Sahlberg 已提交
344 345
}

S
Stefan Hajnoczi 已提交
346
static const AIOCBInfo iscsi_aiocb_info = {
R
Ronnie Sahlberg 已提交
347
    .aiocb_size         = sizeof(IscsiAIOCB),
348
    .cancel_async       = iscsi_aio_cancel,
R
Ronnie Sahlberg 已提交
349 350 351 352 353 354 355 356 357 358
};


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;
359
    int ev = iscsi_which_events(iscsi);
360 361

    if (ev != iscsilun->events) {
362 363
        aio_set_fd_handler(iscsilun->aio_context, iscsi_get_fd(iscsi),
                           false,
364
                           (ev & POLLIN) ? iscsi_process_read : NULL,
365
                           (ev & POLLOUT) ? iscsi_process_write : NULL,
366
                           NULL,
367
                           iscsilun);
368 369 370
        iscsilun->events = ev;
    }
}
371

372
static void iscsi_timed_check_events(void *opaque)
373 374
{
    IscsiLun *iscsilun = opaque;
375 376 377 378 379 380 381 382 383 384 385

    /* check for timed out requests */
    iscsi_service(iscsilun->iscsi, 0);

    if (iscsilun->request_timed_out) {
        iscsilun->request_timed_out = false;
        iscsi_reconnect(iscsilun->iscsi);
    }

    /* newer versions of libiscsi may return zero events. Ensure we are able
     * to return to service once this situation changes. */
386
    iscsi_set_events(iscsilun);
387 388 389

    timer_mod(iscsilun->event_timer,
              qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + EVENT_INTERVAL);
R
Ronnie Sahlberg 已提交
390 391 392 393 394 395 396 397
}

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

398
    aio_context_acquire(iscsilun->aio_context);
R
Ronnie Sahlberg 已提交
399 400
    iscsi_service(iscsi, POLLIN);
    iscsi_set_events(iscsilun);
401
    aio_context_release(iscsilun->aio_context);
R
Ronnie Sahlberg 已提交
402 403 404 405 406 407 408 409
}

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

410
    aio_context_acquire(iscsilun->aio_context);
R
Ronnie Sahlberg 已提交
411 412
    iscsi_service(iscsi, POLLOUT);
    iscsi_set_events(iscsilun);
413
    aio_context_release(iscsilun->aio_context);
R
Ronnie Sahlberg 已提交
414 415
}

416 417 418 419 420
static int64_t sector_lun2qemu(int64_t sector, IscsiLun *iscsilun)
{
    return sector * iscsilun->block_size / BDRV_SECTOR_SIZE;
}

R
Ronnie Sahlberg 已提交
421 422 423 424 425
static int64_t sector_qemu2lun(int64_t sector, IscsiLun *iscsilun)
{
    return sector * BDRV_SECTOR_SIZE / iscsilun->block_size;
}

426 427
static bool is_byte_request_lun_aligned(int64_t offset, int count,
                                        IscsiLun *iscsilun)
428
{
429 430 431 432 433 434 435 436 437 438 439 440 441
    if (offset % iscsilun->block_size || count % iscsilun->block_size) {
        error_report("iSCSI misaligned request: "
                     "iscsilun->block_size %u, offset %" PRIi64
                     ", count %d",
                     iscsilun->block_size, offset, count);
        return false;
    }
    return true;
}

static bool is_sector_request_lun_aligned(int64_t sector_num, int nb_sectors,
                                          IscsiLun *iscsilun)
{
442
    assert(nb_sectors <= BDRV_REQUEST_MAX_SECTORS);
443 444 445
    return is_byte_request_lun_aligned(sector_num << BDRV_SECTOR_BITS,
                                       nb_sectors << BDRV_SECTOR_BITS,
                                       iscsilun);
446 447
}

448
static void iscsi_allocmap_free(IscsiLun *iscsilun)
449
{
450 451 452 453
    g_free(iscsilun->allocmap);
    g_free(iscsilun->allocmap_valid);
    iscsilun->allocmap = NULL;
    iscsilun->allocmap_valid = NULL;
454 455
}

456 457

static int iscsi_allocmap_init(IscsiLun *iscsilun, int open_flags)
458
{
459 460 461 462 463 464 465 466 467
    iscsi_allocmap_free(iscsilun);

    iscsilun->allocmap_size =
        DIV_ROUND_UP(sector_lun2qemu(iscsilun->num_blocks, iscsilun),
                     iscsilun->cluster_sectors);

    iscsilun->allocmap = bitmap_try_new(iscsilun->allocmap_size);
    if (!iscsilun->allocmap) {
        return -ENOMEM;
468
    }
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484

    if (open_flags & BDRV_O_NOCACHE) {
        /* in case that cache.direct = on all allocmap entries are
         * treated as invalid to force a relookup of the block
         * status on every read request */
        return 0;
    }

    iscsilun->allocmap_valid = bitmap_try_new(iscsilun->allocmap_size);
    if (!iscsilun->allocmap_valid) {
        /* if we are under memory pressure free the allocmap as well */
        iscsi_allocmap_free(iscsilun);
        return -ENOMEM;
    }

    return 0;
485 486
}

487 488 489
static void
iscsi_allocmap_update(IscsiLun *iscsilun, int64_t sector_num,
                      int nb_sectors, bool allocated, bool valid)
490
{
491 492 493
    int64_t cl_num_expanded, nb_cls_expanded, cl_num_shrunk, nb_cls_shrunk;

    if (iscsilun->allocmap == NULL) {
494 495
        return;
    }
496 497 498 499 500 501 502 503 504 505 506
    /* expand to entirely contain all affected clusters */
    cl_num_expanded = sector_num / iscsilun->cluster_sectors;
    nb_cls_expanded = DIV_ROUND_UP(sector_num + nb_sectors,
                                   iscsilun->cluster_sectors) - cl_num_expanded;
    /* shrink to touch only completely contained clusters */
    cl_num_shrunk = DIV_ROUND_UP(sector_num, iscsilun->cluster_sectors);
    nb_cls_shrunk = (sector_num + nb_sectors) / iscsilun->cluster_sectors
                      - cl_num_shrunk;
    if (allocated) {
        bitmap_set(iscsilun->allocmap, cl_num_expanded, nb_cls_expanded);
    } else {
507 508 509
        if (nb_cls_shrunk > 0) {
            bitmap_clear(iscsilun->allocmap, cl_num_shrunk, nb_cls_shrunk);
        }
510 511 512 513 514 515
    }

    if (iscsilun->allocmap_valid == NULL) {
        return;
    }
    if (valid) {
516 517 518
        if (nb_cls_shrunk > 0) {
            bitmap_set(iscsilun->allocmap_valid, cl_num_shrunk, nb_cls_shrunk);
        }
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
    } else {
        bitmap_clear(iscsilun->allocmap_valid, cl_num_expanded,
                     nb_cls_expanded);
    }
}

static void
iscsi_allocmap_set_allocated(IscsiLun *iscsilun, int64_t sector_num,
                             int nb_sectors)
{
    iscsi_allocmap_update(iscsilun, sector_num, nb_sectors, true, true);
}

static void
iscsi_allocmap_set_unallocated(IscsiLun *iscsilun, int64_t sector_num,
                               int nb_sectors)
{
    /* Note: if cache.direct=on the fifth argument to iscsi_allocmap_update
     * is ignored, so this will in effect be an iscsi_allocmap_set_invalid.
     */
    iscsi_allocmap_update(iscsilun, sector_num, nb_sectors, false, true);
}

static void iscsi_allocmap_set_invalid(IscsiLun *iscsilun, int64_t sector_num,
                                       int nb_sectors)
{
    iscsi_allocmap_update(iscsilun, sector_num, nb_sectors, false, false);
}

static void iscsi_allocmap_invalidate(IscsiLun *iscsilun)
{
    if (iscsilun->allocmap) {
        bitmap_zero(iscsilun->allocmap, iscsilun->allocmap_size);
    }
    if (iscsilun->allocmap_valid) {
        bitmap_zero(iscsilun->allocmap_valid, iscsilun->allocmap_size);
    }
}

static inline bool
iscsi_allocmap_is_allocated(IscsiLun *iscsilun, int64_t sector_num,
                            int nb_sectors)
{
    unsigned long size;
    if (iscsilun->allocmap == NULL) {
        return true;
565
    }
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
    size = DIV_ROUND_UP(sector_num + nb_sectors, iscsilun->cluster_sectors);
    return !(find_next_bit(iscsilun->allocmap, size,
                           sector_num / iscsilun->cluster_sectors) == size);
}

static inline bool iscsi_allocmap_is_valid(IscsiLun *iscsilun,
                                           int64_t sector_num, int nb_sectors)
{
    unsigned long size;
    if (iscsilun->allocmap_valid == NULL) {
        return false;
    }
    size = DIV_ROUND_UP(sector_num + nb_sectors, iscsilun->cluster_sectors);
    return (find_next_zero_bit(iscsilun->allocmap_valid, size,
                               sector_num / iscsilun->cluster_sectors) == size);
581 582
}

K
Kevin Wolf 已提交
583 584 585
static int coroutine_fn
iscsi_co_writev_flags(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
                      QEMUIOVector *iov, int flags)
R
Ronnie Sahlberg 已提交
586
{
587 588
    IscsiLun *iscsilun = bs->opaque;
    struct IscsiTask iTask;
589
    uint64_t lba;
590
    uint32_t num_sectors;
591
    bool fua = flags & BDRV_REQ_FUA;
R
Ronnie Sahlberg 已提交
592

593 594 595
    if (fua) {
        assert(iscsilun->dpofua);
    }
596
    if (!is_sector_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
597 598
        return -EINVAL;
    }
P
Peter Lieven 已提交
599

600 601
    if (bs->bl.max_transfer) {
        assert(nb_sectors << BDRV_SECTOR_BITS <= bs->bl.max_transfer);
602 603
    }

604 605 606 607
    lba = sector_qemu2lun(sector_num, iscsilun);
    num_sectors = sector_qemu2lun(nb_sectors, iscsilun);
    iscsi_co_init_iscsitask(iscsilun, &iTask);
retry:
608
    if (iscsilun->use_16_for_rw) {
609 610 611 612 613 614 615 616 617 618 619 620 621 622
#if LIBISCSI_API_VERSION >= (20160603)
        iTask.task = iscsi_write16_iov_task(iscsilun->iscsi, iscsilun->lun, lba,
                                            NULL, num_sectors * iscsilun->block_size,
                                            iscsilun->block_size, 0, 0, fua, 0, 0,
                                            iscsi_co_generic_cb, &iTask,
                                            (struct scsi_iovec *)iov->iov, iov->niov);
    } else {
        iTask.task = iscsi_write10_iov_task(iscsilun->iscsi, iscsilun->lun, lba,
                                            NULL, num_sectors * iscsilun->block_size,
                                            iscsilun->block_size, 0, 0, fua, 0, 0,
                                            iscsi_co_generic_cb, &iTask,
                                            (struct scsi_iovec *)iov->iov, iov->niov);
    }
#else
623
        iTask.task = iscsi_write16_task(iscsilun->iscsi, iscsilun->lun, lba,
624
                                        NULL, num_sectors * iscsilun->block_size,
625
                                        iscsilun->block_size, 0, 0, fua, 0, 0,
626 627 628
                                        iscsi_co_generic_cb, &iTask);
    } else {
        iTask.task = iscsi_write10_task(iscsilun->iscsi, iscsilun->lun, lba,
629
                                        NULL, num_sectors * iscsilun->block_size,
630
                                        iscsilun->block_size, 0, 0, fua, 0, 0,
631 632
                                        iscsi_co_generic_cb, &iTask);
    }
633
#endif
634
    if (iTask.task == NULL) {
635
        return -ENOMEM;
636
    }
637
#if LIBISCSI_API_VERSION < (20160603)
638 639
    scsi_task_set_iov_out(iTask.task, (struct scsi_iovec *) iov->iov,
                          iov->niov);
640
#endif
641 642 643
    while (!iTask.complete) {
        iscsi_set_events(iscsilun);
        qemu_coroutine_yield();
R
Ronnie Sahlberg 已提交
644 645
    }

646 647 648
    if (iTask.task != NULL) {
        scsi_free_scsi_task(iTask.task);
        iTask.task = NULL;
649 650
    }

651
    if (iTask.do_retry) {
652
        iTask.complete = 0;
653
        goto retry;
654 655
    }

656
    if (iTask.status != SCSI_STATUS_GOOD) {
657
        iscsi_allocmap_set_invalid(iscsilun, sector_num, nb_sectors);
658
        return iTask.err_code;
R
Ronnie Sahlberg 已提交
659 660
    }

661
    iscsi_allocmap_set_allocated(iscsilun, sector_num, nb_sectors);
662

663
    return 0;
R
Ronnie Sahlberg 已提交
664 665
}

666 667 668 669


static int64_t coroutine_fn iscsi_co_get_block_status(BlockDriverState *bs,
                                                  int64_t sector_num,
670 671
                                                  int nb_sectors, int *pnum,
                                                  BlockDriverState **file)
672 673 674 675 676 677 678 679 680
{
    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);

681
    if (!is_sector_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
682 683 684 685 686 687 688 689 690 691
        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 */
692
    if (!iscsilun->lbpme) {
693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
        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) {
751
        iscsi_allocmap_set_unallocated(iscsilun, sector_num, *pnum);
752
    } else {
753
        iscsi_allocmap_set_allocated(iscsilun, sector_num, *pnum);
754 755 756 757 758 759 760 761 762
    }

    if (*pnum > nb_sectors) {
        *pnum = nb_sectors;
    }
out:
    if (iTask.task != NULL) {
        scsi_free_scsi_task(iTask.task);
    }
763 764 765
    if (ret > 0 && ret & BDRV_BLOCK_OFFSET_VALID) {
        *file = bs;
    }
766 767 768
    return ret;
}

769 770 771
static int coroutine_fn iscsi_co_readv(BlockDriverState *bs,
                                       int64_t sector_num, int nb_sectors,
                                       QEMUIOVector *iov)
R
Ronnie Sahlberg 已提交
772
{
773 774
    IscsiLun *iscsilun = bs->opaque;
    struct IscsiTask iTask;
775 776
    uint64_t lba;
    uint32_t num_sectors;
R
Ronnie Sahlberg 已提交
777

778
    if (!is_sector_request_lun_aligned(sector_num, nb_sectors, iscsilun)) {
779
        return -EINVAL;
780 781
    }

782 783
    if (bs->bl.max_transfer) {
        assert(nb_sectors << BDRV_SECTOR_BITS <= bs->bl.max_transfer);
784 785
    }

786 787 788 789 790 791 792 793 794 795 796 797
    /* if cache.direct is off and we have a valid entry in our allocation map
     * we can skip checking the block status and directly return zeroes if
     * the request falls within an unallocated area */
    if (iscsi_allocmap_is_valid(iscsilun, sector_num, nb_sectors) &&
        !iscsi_allocmap_is_allocated(iscsilun, sector_num, nb_sectors)) {
            qemu_iovec_memset(iov, 0, 0x00, iov->size);
            return 0;
    }

    if (nb_sectors >= ISCSI_CHECKALLOC_THRES &&
        !iscsi_allocmap_is_valid(iscsilun, sector_num, nb_sectors) &&
        !iscsi_allocmap_is_allocated(iscsilun, sector_num, nb_sectors)) {
798
        int pnum;
799
        BlockDriverState *file;
800 801 802 803 804
        /* check the block status from the beginning of the cluster
         * containing the start sector */
        int64_t ret = iscsi_co_get_block_status(bs,
                          sector_num - sector_num % iscsilun->cluster_sectors,
                          BDRV_REQUEST_MAX_SECTORS, &pnum, &file);
805 806 807
        if (ret < 0) {
            return ret;
        }
808 809 810 811
        /* if the whole request falls into an unallocated area we can avoid
         * to read and directly return zeroes instead */
        if (ret & BDRV_BLOCK_ZERO &&
            pnum >= nb_sectors + sector_num % iscsilun->cluster_sectors) {
812 813 814 815 816
            qemu_iovec_memset(iov, 0, 0x00, iov->size);
            return 0;
        }
    }

817 818
    lba = sector_qemu2lun(sector_num, iscsilun);
    num_sectors = sector_qemu2lun(nb_sectors, iscsilun);
819

820 821
    iscsi_co_init_iscsitask(iscsilun, &iTask);
retry:
822
    if (iscsilun->use_16_for_rw) {
823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
#if LIBISCSI_API_VERSION >= (20160603)
        iTask.task = iscsi_read16_iov_task(iscsilun->iscsi, iscsilun->lun, lba,
                                           num_sectors * iscsilun->block_size,
                                           iscsilun->block_size, 0, 0, 0, 0, 0,
                                           iscsi_co_generic_cb, &iTask,
                                           (struct scsi_iovec *)iov->iov, iov->niov);
    } else {
        iTask.task = iscsi_read10_iov_task(iscsilun->iscsi, iscsilun->lun, lba,
                                           num_sectors * iscsilun->block_size,
                                           iscsilun->block_size,
                                           0, 0, 0, 0, 0,
                                           iscsi_co_generic_cb, &iTask,
                                           (struct scsi_iovec *)iov->iov, iov->niov);
    }
#else
838 839 840 841
        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);
842
    } else {
843 844
        iTask.task = iscsi_read10_task(iscsilun->iscsi, iscsilun->lun, lba,
                                       num_sectors * iscsilun->block_size,
845 846
                                       iscsilun->block_size,
                                       0, 0, 0, 0, 0,
847
                                       iscsi_co_generic_cb, &iTask);
848
    }
849
#endif
850
    if (iTask.task == NULL) {
851
        return -ENOMEM;
R
Ronnie Sahlberg 已提交
852
    }
853
#if LIBISCSI_API_VERSION < (20160603)
854
    scsi_task_set_iov_in(iTask.task, (struct scsi_iovec *) iov->iov, iov->niov);
855
#endif
856 857 858
    while (!iTask.complete) {
        iscsi_set_events(iscsilun);
        qemu_coroutine_yield();
859
    }
R
Ronnie Sahlberg 已提交
860

861 862 863
    if (iTask.task != NULL) {
        scsi_free_scsi_task(iTask.task);
        iTask.task = NULL;
R
Ronnie Sahlberg 已提交
864 865
    }

866
    if (iTask.do_retry) {
867
        iTask.complete = 0;
868
        goto retry;
R
Ronnie Sahlberg 已提交
869 870
    }

871
    if (iTask.status != SCSI_STATUS_GOOD) {
872
        return iTask.err_code;
873 874 875 876 877
    }

    return 0;
}

878
static int coroutine_fn iscsi_co_flush(BlockDriverState *bs)
879 880
{
    IscsiLun *iscsilun = bs->opaque;
881
    struct IscsiTask iTask;
882

883
    iscsi_co_init_iscsitask(iscsilun, &iTask);
884 885 886
retry:
    if (iscsi_synchronizecache10_task(iscsilun->iscsi, iscsilun->lun, 0, 0, 0,
                                      0, iscsi_co_generic_cb, &iTask) == NULL) {
887
        return -ENOMEM;
888
    }
889

890 891 892 893
    while (!iTask.complete) {
        iscsi_set_events(iscsilun);
        qemu_coroutine_yield();
    }
894

895 896 897
    if (iTask.task != NULL) {
        scsi_free_scsi_task(iTask.task);
        iTask.task = NULL;
R
Ronnie Sahlberg 已提交
898 899
    }

900
    if (iTask.do_retry) {
901
        iTask.complete = 0;
902 903
        goto retry;
    }
R
Ronnie Sahlberg 已提交
904

905
    if (iTask.status != SCSI_STATUS_GOOD) {
906
        return iTask.err_code;
907 908 909
    }

    return 0;
R
Ronnie Sahlberg 已提交
910 911
}

912 913 914 915 916 917 918
#ifdef __linux__
static void
iscsi_aio_ioctl_cb(struct iscsi_context *iscsi, int status,
                     void *command_data, void *opaque)
{
    IscsiAIOCB *acb = opaque;

919 920 921
    g_free(acb->buf);
    acb->buf = NULL;

922 923 924 925
    acb->status = 0;
    if (status < 0) {
        error_report("Failed to ioctl(SG_IO) to iSCSI lun. %s",
                     iscsi_get_error(iscsi));
926
        acb->status = iscsi_translate_sense(&acb->task->sense);
927 928 929 930 931
    }

    acb->ioh->driver_status = 0;
    acb->ioh->host_status   = 0;
    acb->ioh->resid         = 0;
932
    acb->ioh->status        = status;
933 934 935 936 937 938 939 940 941 942 943 944 945 946

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

947
    iscsi_schedule_bh(acb);
948 949
}

950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981
static void iscsi_ioctl_bh_completion(void *opaque)
{
    IscsiAIOCB *acb = opaque;

    qemu_bh_delete(acb->bh);
    acb->common.cb(acb->common.opaque, acb->ret);
    qemu_aio_unref(acb);
}

static void iscsi_ioctl_handle_emulated(IscsiAIOCB *acb, int req, void *buf)
{
    BlockDriverState *bs = acb->common.bs;
    IscsiLun *iscsilun = bs->opaque;
    int ret = 0;

    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;
    default:
        ret = -EINVAL;
    }
    assert(!acb->bh);
    acb->bh = aio_bh_new(bdrv_get_aio_context(bs),
                         iscsi_ioctl_bh_completion, acb);
    acb->ret = ret;
    qemu_bh_schedule(acb->bh);
}

982
static BlockAIOCB *iscsi_aio_ioctl(BlockDriverState *bs,
983
        unsigned long int req, void *buf,
984
        BlockCompletionFunc *cb, void *opaque)
985 986 987 988 989 990
{
    IscsiLun *iscsilun = bs->opaque;
    struct iscsi_context *iscsi = iscsilun->iscsi;
    struct iscsi_data data;
    IscsiAIOCB *acb;

S
Stefan Hajnoczi 已提交
991
    acb = qemu_aio_get(&iscsi_aiocb_info, bs, cb, opaque);
992 993

    acb->iscsilun = iscsilun;
994 995
    acb->bh          = NULL;
    acb->status      = -EINPROGRESS;
996 997 998
    acb->buf         = NULL;
    acb->ioh         = buf;

999 1000 1001 1002 1003
    if (req != SG_IO) {
        iscsi_ioctl_handle_emulated(acb, req, buf);
        return &acb->common;
    }

1004 1005 1006 1007 1008 1009 1010
    if (acb->ioh->cmd_len > SCSI_CDB_MAX_SIZE) {
        error_report("iSCSI: ioctl error CDB exceeds max size (%d > %d)",
                     acb->ioh->cmd_len, SCSI_CDB_MAX_SIZE);
        qemu_aio_unref(acb);
        return NULL;
    }

1011 1012 1013 1014
    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));
1015
        qemu_aio_unref(acb);
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
        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;

1036
    data.size = 0;
1037
    if (acb->task->xfer_dir == SCSI_XFER_WRITE) {
1038 1039 1040 1041 1042 1043 1044 1045
        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);
        }
1046
    }
1047

1048 1049
    if (iscsi_scsi_command_async(iscsi, iscsilun->lun, acb->task,
                                 iscsi_aio_ioctl_cb,
1050
                                 (data.size > 0) ? &data : NULL,
1051 1052
                                 acb) != 0) {
        scsi_free_scsi_task(acb->task);
1053
        qemu_aio_unref(acb);
1054 1055 1056 1057 1058
        return NULL;
    }

    /* tell libiscsi to read straight into the buffer we got from ioctl */
    if (acb->task->xfer_dir == SCSI_XFER_READ) {
1059 1060 1061 1062 1063 1064 1065 1066 1067
        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);
        }
1068 1069 1070 1071 1072 1073 1074 1075 1076
    }

    iscsi_set_events(iscsilun);

    return &acb->common;
}

#endif

R
Ronnie Sahlberg 已提交
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
static int64_t
iscsi_getlength(BlockDriverState *bs)
{
    IscsiLun *iscsilun = bs->opaque;
    int64_t len;

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

    return len;
}

1089
static int
1090
coroutine_fn iscsi_co_pdiscard(BlockDriverState *bs, int64_t offset, int count)
1091 1092 1093 1094 1095
{
    IscsiLun *iscsilun = bs->opaque;
    struct IscsiTask iTask;
    struct unmap_list list;

1096 1097 1098
    if (!is_byte_request_lun_aligned(offset, count, iscsilun)) {
        return -ENOTSUP;
    }
1099 1100 1101 1102 1103 1104

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

1105 1106
    list.lba = offset / iscsilun->block_size;
    list.num = count / iscsilun->block_size;
1107

P
Peter Lieven 已提交
1108
    iscsi_co_init_iscsitask(iscsilun, &iTask);
1109
retry:
P
Peter Lieven 已提交
1110
    if (iscsi_unmap_task(iscsilun->iscsi, iscsilun->lun, 0, 0, &list, 1,
1111
                         iscsi_co_generic_cb, &iTask) == NULL) {
1112
        return -ENOMEM;
P
Peter Lieven 已提交
1113
    }
1114

P
Peter Lieven 已提交
1115 1116 1117 1118
    while (!iTask.complete) {
        iscsi_set_events(iscsilun);
        qemu_coroutine_yield();
    }
1119

P
Peter Lieven 已提交
1120 1121 1122 1123
    if (iTask.task != NULL) {
        scsi_free_scsi_task(iTask.task);
        iTask.task = NULL;
    }
1124

P
Peter Lieven 已提交
1125
    if (iTask.do_retry) {
1126
        iTask.complete = 0;
P
Peter Lieven 已提交
1127 1128
        goto retry;
    }
1129

P
Peter Lieven 已提交
1130 1131 1132 1133 1134 1135
    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;
    }
1136

P
Peter Lieven 已提交
1137
    if (iTask.status != SCSI_STATUS_GOOD) {
1138
        return iTask.err_code;
1139 1140
    }

1141 1142
    iscsi_allocmap_set_invalid(iscsilun, offset >> BDRV_SECTOR_BITS,
                               count >> BDRV_SECTOR_BITS);
1143

1144 1145 1146
    return 0;
}

P
Peter Lieven 已提交
1147
static int
1148 1149
coroutine_fn iscsi_co_pwrite_zeroes(BlockDriverState *bs, int64_t offset,
                                    int count, BdrvRequestFlags flags)
P
Peter Lieven 已提交
1150 1151 1152 1153 1154
{
    IscsiLun *iscsilun = bs->opaque;
    struct IscsiTask iTask;
    uint64_t lba;
    uint32_t nb_blocks;
1155
    bool use_16_for_ws = iscsilun->use_16_for_rw;
P
Peter Lieven 已提交
1156

1157 1158
    if (!is_byte_request_lun_aligned(offset, count, iscsilun)) {
        return -ENOTSUP;
P
Peter Lieven 已提交
1159 1160
    }

1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171
    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;
        }
1172 1173
    }

1174
    if (!(flags & BDRV_REQ_MAY_UNMAP) && !iscsilun->has_write_same) {
1175
        /* WRITESAME without UNMAP is not supported by the target */
P
Peter Lieven 已提交
1176 1177 1178
        return -ENOTSUP;
    }

1179 1180
    lba = offset / iscsilun->block_size;
    nb_blocks = count / iscsilun->block_size;
P
Peter Lieven 已提交
1181 1182

    if (iscsilun->zeroblock == NULL) {
1183 1184 1185 1186
        iscsilun->zeroblock = g_try_malloc0(iscsilun->block_size);
        if (iscsilun->zeroblock == NULL) {
            return -ENOMEM;
        }
P
Peter Lieven 已提交
1187 1188 1189 1190
    }

    iscsi_co_init_iscsitask(iscsilun, &iTask);
retry:
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
    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) {
1203
        return -ENOMEM;
P
Peter Lieven 已提交
1204 1205 1206 1207 1208 1209 1210
    }

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

1211 1212
    if (iTask.status == SCSI_STATUS_CHECK_CONDITION &&
        iTask.task->sense.key == SCSI_SENSE_ILLEGAL_REQUEST &&
1213 1214
        (iTask.task->sense.ascq == SCSI_SENSE_ASCQ_INVALID_OPERATION_CODE ||
         iTask.task->sense.ascq == SCSI_SENSE_ASCQ_INVALID_FIELD_IN_CDB)) {
1215 1216 1217 1218 1219 1220
        /* WRITE SAME is not supported by the target */
        iscsilun->has_write_same = false;
        scsi_free_scsi_task(iTask.task);
        return -ENOTSUP;
    }

P
Peter Lieven 已提交
1221 1222 1223 1224 1225 1226
    if (iTask.task != NULL) {
        scsi_free_scsi_task(iTask.task);
        iTask.task = NULL;
    }

    if (iTask.do_retry) {
1227
        iTask.complete = 0;
P
Peter Lieven 已提交
1228 1229 1230 1231
        goto retry;
    }

    if (iTask.status != SCSI_STATUS_GOOD) {
1232 1233
        iscsi_allocmap_set_invalid(iscsilun, offset >> BDRV_SECTOR_BITS,
                                   count >> BDRV_SECTOR_BITS);
1234
        return iTask.err_code;
P
Peter Lieven 已提交
1235 1236
    }

1237
    if (flags & BDRV_REQ_MAY_UNMAP) {
1238 1239
        iscsi_allocmap_set_invalid(iscsilun, offset >> BDRV_SECTOR_BITS,
                                   count >> BDRV_SECTOR_BITS);
1240
    } else {
1241 1242
        iscsi_allocmap_set_allocated(iscsilun, offset >> BDRV_SECTOR_BITS,
                                     count >> BDRV_SECTOR_BITS);
1243 1244
    }

P
Peter Lieven 已提交
1245 1246 1247
    return 0;
}

1248
static void apply_chap(struct iscsi_context *iscsi, QemuOpts *opts,
1249
                       Error **errp)
1250 1251 1252
{
    const char *user = NULL;
    const char *password = NULL;
1253 1254
    const char *secretid;
    char *secret = NULL;
1255 1256 1257

    user = qemu_opt_get(opts, "user");
    if (!user) {
1258
        return;
1259 1260
    }

1261
    secretid = qemu_opt_get(opts, "password-secret");
1262
    password = qemu_opt_get(opts, "password");
1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274
    if (secretid && password) {
        error_setg(errp, "'password' and 'password-secret' properties are "
                   "mutually exclusive");
        return;
    }
    if (secretid) {
        secret = qcrypto_secret_lookup_as_utf8(secretid, errp);
        if (!secret) {
            return;
        }
        password = secret;
    } else if (!password) {
1275 1276
        error_setg(errp, "CHAP username specified but no password was given");
        return;
1277 1278 1279
    }

    if (iscsi_set_initiator_username_pwd(iscsi, user, password)) {
1280
        error_setg(errp, "Failed to set initiator username and password");
1281
    }
1282 1283

    g_free(secret);
1284 1285
}

K
Kevin Wolf 已提交
1286
static void apply_header_digest(struct iscsi_context *iscsi, QemuOpts *opts,
1287
                                Error **errp)
1288 1289 1290 1291 1292
{
    const char *digest = NULL;

    digest = qemu_opt_get(opts, "header-digest");
    if (!digest) {
K
Kevin Wolf 已提交
1293
        iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE_CRC32C);
K
Kevin Wolf 已提交
1294
    } else if (!strcmp(digest, "crc32c")) {
1295
        iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_CRC32C);
K
Kevin Wolf 已提交
1296
    } else if (!strcmp(digest, "none")) {
1297
        iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE);
K
Kevin Wolf 已提交
1298
    } else if (!strcmp(digest, "crc32c-none")) {
1299
        iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_CRC32C_NONE);
K
Kevin Wolf 已提交
1300
    } else if (!strcmp(digest, "none-crc32c")) {
1301 1302
        iscsi_set_header_digest(iscsi, ISCSI_HEADER_DIGEST_NONE_CRC32C);
    } else {
1303
        error_setg(errp, "Invalid header-digest setting : %s", digest);
1304 1305 1306
    }
}

K
Kevin Wolf 已提交
1307
static char *get_initiator_name(QemuOpts *opts)
1308
{
1309 1310 1311
    const char *name;
    char *iscsi_name;
    UuidInfo *uuid_info;
1312

K
Kevin Wolf 已提交
1313 1314 1315
    name = qemu_opt_get(opts, "initiator-name");
    if (name) {
        return g_strdup(name);
1316 1317
    }

1318 1319 1320
    uuid_info = qmp_query_uuid(NULL);
    if (strcmp(uuid_info->UUID, UUID_NONE) == 0) {
        name = qemu_get_vm_name();
1321
    } else {
1322
        name = uuid_info->UUID;
1323
    }
1324 1325 1326 1327
    iscsi_name = g_strdup_printf("iqn.2008-11.org.linux-kvm%s%s",
                                 name ? ":" : "", name ? name : "");
    qapi_free_UuidInfo(uuid_info);
    return iscsi_name;
1328 1329
}

1330 1331 1332 1333
static void iscsi_nop_timed_event(void *opaque)
{
    IscsiLun *iscsilun = opaque;

1334
    aio_context_acquire(iscsilun->aio_context);
1335
    if (iscsi_get_nops_in_flight(iscsilun->iscsi) >= MAX_NOP_FAILURES) {
1336
        error_report("iSCSI: NOP timeout. Reconnecting...");
1337 1338
        iscsilun->request_timed_out = true;
    } else if (iscsi_nop_out_async(iscsilun->iscsi, NULL, NULL, 0, NULL) != 0) {
1339
        error_report("iSCSI: failed to sent NOP-Out. Disabling NOP messages.");
1340
        goto out;
1341 1342
    }

1343
    timer_mod(iscsilun->nop_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + NOP_INTERVAL);
1344
    iscsi_set_events(iscsilun);
1345 1346 1347

out:
    aio_context_release(iscsilun->aio_context);
1348 1349
}

1350
static void iscsi_readcapacity_sync(IscsiLun *iscsilun, Error **errp)
P
Peter Lieven 已提交
1351 1352 1353 1354 1355 1356
{
    struct scsi_task *task = NULL;
    struct scsi_readcapacity10 *rc10 = NULL;
    struct scsi_readcapacity16 *rc16 = NULL;
    int retries = ISCSI_CMD_RETRIES; 

1357 1358 1359 1360
    do {
        if (task != NULL) {
            scsi_free_scsi_task(task);
            task = NULL;
P
Peter Lieven 已提交
1361
        }
1362 1363 1364 1365 1366 1367 1368

        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) {
1369
                    error_setg(errp, "iSCSI: Failed to unmarshall readcapacity16 data.");
1370 1371 1372
                } else {
                    iscsilun->block_size = rc16->block_length;
                    iscsilun->num_blocks = rc16->returned_lba + 1;
1373 1374
                    iscsilun->lbpme = !!rc16->lbpme;
                    iscsilun->lbprz = !!rc16->lbprz;
1375
                    iscsilun->use_16_for_rw = (rc16->returned_lba > 0xffffffff);
1376
                }
1377
                break;
1378
            }
1379 1380 1381 1382 1383
            if (task != NULL && task->status == SCSI_STATUS_CHECK_CONDITION
                && task->sense.key == SCSI_SENSE_UNIT_ATTENTION) {
                break;
            }
            /* Fall through and try READ CAPACITY(10) instead.  */
1384 1385 1386 1387 1388
        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) {
1389
                    error_setg(errp, "iSCSI: Failed to unmarshall readcapacity10 data.");
1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
                } 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:
1402
            return;
P
Peter Lieven 已提交
1403
        }
1404 1405 1406
    } while (task != NULL && task->status == SCSI_STATUS_CHECK_CONDITION
             && task->sense.key == SCSI_SENSE_UNIT_ATTENTION
             && retries-- > 0);
P
Peter Lieven 已提交
1407

1408
    if (task == NULL || task->status != SCSI_STATUS_GOOD) {
1409
        error_setg(errp, "iSCSI: failed to send readcapacity10/16 command");
1410 1411 1412 1413
    } else if (!iscsilun->block_size ||
               iscsilun->block_size % BDRV_SECTOR_SIZE) {
        error_setg(errp, "iSCSI: the target returned an invalid "
                   "block size of %d.", iscsilun->block_size);
1414
    }
P
Peter Lieven 已提交
1415 1416 1417 1418 1419
    if (task) {
        scsi_free_scsi_task(task);
    }
}

P
Paolo Bonzini 已提交
1420
static struct scsi_task *iscsi_do_inquiry(struct iscsi_context *iscsi, int lun,
1421
                                          int evpd, int pc, void **inq, Error **errp)
P
Paolo Bonzini 已提交
1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434
{
    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);
1435 1436 1437
        if (task == NULL || task->status != SCSI_STATUS_GOOD) {
            goto fail;
        }
P
Paolo Bonzini 已提交
1438
    }
1439

1440 1441 1442
    *inq = scsi_datain_unmarshall(task);
    if (*inq == NULL) {
        error_setg(errp, "iSCSI: failed to unmarshall inquiry datain blob");
1443
        goto fail_with_err;
1444 1445
    }

P
Paolo Bonzini 已提交
1446
    return task;
1447 1448

fail:
1449 1450 1451
    error_setg(errp, "iSCSI: Inquiry command failed : %s",
               iscsi_get_error(iscsi));
fail_with_err:
1452
    if (task != NULL) {
P
Paolo Bonzini 已提交
1453 1454 1455
        scsi_free_scsi_task(task);
    }
    return NULL;
1456 1457
}

1458 1459 1460 1461
static void iscsi_detach_aio_context(BlockDriverState *bs)
{
    IscsiLun *iscsilun = bs->opaque;

1462
    aio_set_fd_handler(iscsilun->aio_context, iscsi_get_fd(iscsilun->iscsi),
1463
                       false, NULL, NULL, NULL, NULL);
1464 1465 1466 1467 1468 1469 1470
    iscsilun->events = 0;

    if (iscsilun->nop_timer) {
        timer_del(iscsilun->nop_timer);
        timer_free(iscsilun->nop_timer);
        iscsilun->nop_timer = NULL;
    }
1471 1472 1473 1474 1475
    if (iscsilun->event_timer) {
        timer_del(iscsilun->event_timer);
        timer_free(iscsilun->event_timer);
        iscsilun->event_timer = NULL;
    }
1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491
}

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

1493 1494
    /* Set up a timer for periodic calls to iscsi_set_events and to
     * scan for command timeout */
1495 1496
    iscsilun->event_timer = aio_timer_new(iscsilun->aio_context,
                                          QEMU_CLOCK_REALTIME, SCALE_MS,
1497 1498 1499
                                          iscsi_timed_check_events, iscsilun);
    timer_mod(iscsilun->event_timer,
              qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + EVENT_INTERVAL);
1500 1501
}

1502
static void iscsi_modesense_sync(IscsiLun *iscsilun)
1503 1504 1505
{
    struct scsi_task *task;
    struct scsi_mode_sense *ms = NULL;
1506
    iscsilun->write_protected = false;
1507
    iscsilun->dpofua = false;
1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527

    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;
    }
1528
    iscsilun->write_protected = ms->device_specific_parameter & 0x80;
1529
    iscsilun->dpofua          = ms->device_specific_parameter & 0x10;
1530 1531 1532 1533 1534 1535 1536

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

1537 1538 1539 1540
static void iscsi_parse_iscsi_option(const char *target, QDict *options)
{
    QemuOptsList *list;
    QemuOpts *opts;
K
Kevin Wolf 已提交
1541
    const char *user, *password, *password_secret, *initiator_name,
K
Kevin Wolf 已提交
1542
               *header_digest, *timeout;
1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570

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

    user = qemu_opt_get(opts, "user");
    if (user) {
        qdict_set_default_str(options, "user", user);
    }

    password = qemu_opt_get(opts, "password");
    if (password) {
        qdict_set_default_str(options, "password", password);
    }

    password_secret = qemu_opt_get(opts, "password-secret");
    if (password_secret) {
        qdict_set_default_str(options, "password-secret", password_secret);
    }
K
Kevin Wolf 已提交
1571 1572 1573 1574 1575

    initiator_name = qemu_opt_get(opts, "initiator-name");
    if (initiator_name) {
        qdict_set_default_str(options, "initiator-name", initiator_name);
    }
K
Kevin Wolf 已提交
1576 1577 1578

    header_digest = qemu_opt_get(opts, "header-digest");
    if (header_digest) {
K
Kevin Wolf 已提交
1579 1580 1581 1582 1583
        /* -iscsi takes upper case values, but QAPI only supports lower case
         * enum constant names, so we have to convert here. */
        char *qapi_value = g_ascii_strdown(header_digest, -1);
        qdict_set_default_str(options, "header-digest", qapi_value);
        g_free(qapi_value);
K
Kevin Wolf 已提交
1584
    }
K
Kevin Wolf 已提交
1585 1586 1587 1588 1589

    timeout = qemu_opt_get(opts, "timeout");
    if (timeout) {
        qdict_set_default_str(options, "timeout", timeout);
    }
1590 1591
}

R
Ronnie Sahlberg 已提交
1592 1593 1594 1595
/*
 * We support iscsi url's on the form
 * iscsi://[<username>%<password>@]<host>[:<port>]/<targetname>/<lun>
 */
1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633
static void iscsi_parse_filename(const char *filename, QDict *options,
                                 Error **errp)
{
    struct iscsi_url *iscsi_url;
    const char *transport_name;
    char *lun_str;

    iscsi_url = iscsi_parse_full_url(NULL, filename);
    if (iscsi_url == NULL) {
        error_setg(errp, "Failed to parse URL : %s", filename);
        return;
    }

#if LIBISCSI_API_VERSION >= (20160603)
    switch (iscsi_url->transport) {
    case TCP_TRANSPORT:
        transport_name = "tcp";
        break;
    case ISER_TRANSPORT:
        transport_name = "iser";
        break;
    default:
        error_setg(errp, "Unknown transport type (%d)",
                   iscsi_url->transport);
        return;
    }
#else
    transport_name = "tcp";
#endif

    qdict_set_default_str(options, "transport", transport_name);
    qdict_set_default_str(options, "portal", iscsi_url->portal);
    qdict_set_default_str(options, "target", iscsi_url->target);

    lun_str = g_strdup_printf("%d", iscsi_url->lun);
    qdict_set_default_str(options, "lun", lun_str);
    g_free(lun_str);

1634 1635 1636
    /* User/password from -iscsi take precedence over those from the URL */
    iscsi_parse_iscsi_option(iscsi_url->target, options);

1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668
    if (iscsi_url->user[0] != '\0') {
        qdict_set_default_str(options, "user", iscsi_url->user);
        qdict_set_default_str(options, "password", iscsi_url->passwd);
    }

    iscsi_destroy_url(iscsi_url);
}

static QemuOptsList runtime_opts = {
    .name = "iscsi",
    .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
    .desc = {
        {
            .name = "transport",
            .type = QEMU_OPT_STRING,
        },
        {
            .name = "portal",
            .type = QEMU_OPT_STRING,
        },
        {
            .name = "target",
            .type = QEMU_OPT_STRING,
        },
        {
            .name = "user",
            .type = QEMU_OPT_STRING,
        },
        {
            .name = "password",
            .type = QEMU_OPT_STRING,
        },
1669 1670 1671 1672
        {
            .name = "password-secret",
            .type = QEMU_OPT_STRING,
        },
1673 1674 1675 1676
        {
            .name = "lun",
            .type = QEMU_OPT_NUMBER,
        },
K
Kevin Wolf 已提交
1677 1678 1679 1680
        {
            .name = "initiator-name",
            .type = QEMU_OPT_STRING,
        },
K
Kevin Wolf 已提交
1681 1682 1683 1684
        {
            .name = "header-digest",
            .type = QEMU_OPT_STRING,
        },
K
Kevin Wolf 已提交
1685 1686 1687 1688
        {
            .name = "timeout",
            .type = QEMU_OPT_NUMBER,
        },
1689 1690 1691 1692
        { /* end of list */ }
    },
};

M
Max Reitz 已提交
1693 1694
static int iscsi_open(BlockDriverState *bs, QDict *options, int flags,
                      Error **errp)
R
Ronnie Sahlberg 已提交
1695 1696 1697
{
    IscsiLun *iscsilun = bs->opaque;
    struct iscsi_context *iscsi = NULL;
P
Peter Lieven 已提交
1698 1699
    struct scsi_task *task = NULL;
    struct scsi_inquiry_standard *inq = NULL;
1700
    struct scsi_inquiry_supported_pages *inq_vpd;
1701
    char *initiator_name = NULL;
1702 1703
    QemuOpts *opts;
    Error *local_err = NULL;
1704 1705 1706 1707 1708
    const char *transport_name, *portal, *target;
#if LIBISCSI_API_VERSION >= (20160603)
    enum iscsi_transport_type transport;
#endif
    int i, ret = 0, timeout = 0, lun;
R
Ronnie Sahlberg 已提交
1709

1710
    opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
1711
    qemu_opts_absorb_qdict(opts, options, &local_err);
1712
    if (local_err) {
1713
        error_propagate(errp, local_err);
1714 1715 1716 1717
        ret = -EINVAL;
        goto out;
    }

1718 1719 1720 1721
    transport_name = qemu_opt_get(opts, "transport");
    portal = qemu_opt_get(opts, "portal");
    target = qemu_opt_get(opts, "target");
    lun = qemu_opt_get_number(opts, "lun", 0);
1722

1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738
    if (!transport_name || !portal || !target) {
        error_setg(errp, "Need all of transport, portal and target options");
        ret = -EINVAL;
        goto out;
    }

    if (!strcmp(transport_name, "tcp")) {
#if LIBISCSI_API_VERSION >= (20160603)
        transport = TCP_TRANSPORT;
    } else if (!strcmp(transport_name, "iser")) {
        transport = ISER_TRANSPORT;
#else
        /* TCP is what older libiscsi versions always use */
#endif
    } else {
        error_setg(errp, "Unknown transport: %s", transport_name);
R
Ronnie Sahlberg 已提交
1739
        ret = -EINVAL;
1740
        goto out;
R
Ronnie Sahlberg 已提交
1741 1742
    }

1743 1744
    memset(iscsilun, 0, sizeof(IscsiLun));

K
Kevin Wolf 已提交
1745
    initiator_name = get_initiator_name(opts);
1746 1747 1748

    iscsi = iscsi_create_context(initiator_name);
    if (iscsi == NULL) {
1749
        error_setg(errp, "iSCSI: Failed to create iSCSI context.");
1750
        ret = -ENOMEM;
1751
        goto out;
1752
    }
1753
#if LIBISCSI_API_VERSION >= (20160603)
1754
    if (iscsi_init_transport(iscsi, transport)) {
1755 1756 1757 1758 1759
        error_setg(errp, ("Error initializing transport."));
        ret = -EINVAL;
        goto out;
    }
#endif
1760
    if (iscsi_set_targetname(iscsi, target)) {
1761
        error_setg(errp, "iSCSI: Failed to set target name.");
R
Ronnie Sahlberg 已提交
1762
        ret = -EINVAL;
1763
        goto out;
R
Ronnie Sahlberg 已提交
1764 1765
    }

1766
    /* check if we got CHAP username/password via the options */
1767
    apply_chap(iscsi, opts, &local_err);
1768 1769
    if (local_err != NULL) {
        error_propagate(errp, local_err);
1770
        ret = -EINVAL;
1771
        goto out;
1772 1773
    }

R
Ronnie Sahlberg 已提交
1774
    if (iscsi_set_session_type(iscsi, ISCSI_SESSION_NORMAL) != 0) {
1775
        error_setg(errp, "iSCSI: Failed to set session type to normal.");
R
Ronnie Sahlberg 已提交
1776
        ret = -EINVAL;
1777
        goto out;
R
Ronnie Sahlberg 已提交
1778 1779
    }

1780
    /* check if we got HEADER_DIGEST via the options */
K
Kevin Wolf 已提交
1781
    apply_header_digest(iscsi, opts, &local_err);
1782 1783 1784 1785 1786
    if (local_err != NULL) {
        error_propagate(errp, local_err);
        ret = -EINVAL;
        goto out;
    }
1787

1788
    /* timeout handling is broken in libiscsi before 1.15.0 */
K
Kevin Wolf 已提交
1789
    timeout = qemu_opt_get_number(opts, "timeout", 0);
1790
#if LIBISCSI_API_VERSION >= 20150621
1791 1792 1793 1794 1795 1796
    iscsi_set_timeout(iscsi, timeout);
#else
    if (timeout) {
        error_report("iSCSI: ignoring timeout value for libiscsi <1.15.0");
    }
#endif
1797

1798
    if (iscsi_full_connect_sync(iscsi, portal, lun) != 0) {
1799
        error_setg(errp, "iSCSI: Failed to connect to LUN : %s",
P
Peter Lieven 已提交
1800 1801 1802 1803
            iscsi_get_error(iscsi));
        ret = -EINVAL;
        goto out;
    }
R
Ronnie Sahlberg 已提交
1804 1805

    iscsilun->iscsi = iscsi;
1806
    iscsilun->aio_context = bdrv_get_aio_context(bs);
1807
    iscsilun->lun = lun;
1808
    iscsilun->has_write_same = true;
R
Ronnie Sahlberg 已提交
1809

1810 1811 1812
    task = iscsi_do_inquiry(iscsilun->iscsi, iscsilun->lun, 0, 0,
                            (void **) &inq, errp);
    if (task == NULL) {
R
Ronnie Sahlberg 已提交
1813
        ret = -EINVAL;
1814
        goto out;
R
Ronnie Sahlberg 已提交
1815
    }
P
Peter Lieven 已提交
1816
    iscsilun->type = inq->periperal_device_type;
1817 1818
    scsi_free_scsi_task(task);
    task = NULL;
P
Peter Lieven 已提交
1819

1820
    iscsi_modesense_sync(iscsilun);
1821 1822 1823
    if (iscsilun->dpofua) {
        bs->supported_write_flags = BDRV_REQ_FUA;
    }
1824
    bs->supported_zero_flags = BDRV_REQ_MAY_UNMAP;
1825

1826 1827
    /* Check the write protect flag of the LUN if we want to write */
    if (iscsilun->type == TYPE_DISK && (flags & BDRV_O_RDWR) &&
1828
        iscsilun->write_protected) {
1829 1830 1831 1832 1833
        error_setg(errp, "Cannot open a write protected LUN as read-write");
        ret = -EACCES;
        goto out;
    }

1834 1835 1836
    iscsi_readcapacity_sync(iscsilun, &local_err);
    if (local_err != NULL) {
        error_propagate(errp, local_err);
1837
        ret = -EINVAL;
P
Peter Lieven 已提交
1838
        goto out;
P
Peter Lieven 已提交
1839
    }
1840
    bs->total_sectors = sector_lun2qemu(iscsilun->num_blocks, iscsilun);
P
Peter Lieven 已提交
1841

1842 1843 1844
    /* 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.
1845
     */
1846
    if (iscsilun->type != TYPE_DISK && iscsilun->type != TYPE_ROM) {
1847
        bs->sg = true;
1848 1849
    }

1850 1851 1852 1853 1854 1855
    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;
1856
    }
1857 1858 1859
    for (i = 0; i < inq_vpd->num_pages; i++) {
        struct scsi_task *inq_task;
        struct scsi_inquiry_logical_block_provisioning *inq_lbp;
1860
        struct scsi_inquiry_block_limits *inq_bl;
1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887
        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;
1888 1889
        }
    }
1890 1891
    scsi_free_scsi_task(task);
    task = NULL;
1892

1893
    iscsi_attach_aio_context(bs, iscsilun->aio_context);
1894

1895 1896 1897
    /* 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 */
1898
    if (iscsilun->bl.opt_unmap_gran * iscsilun->block_size >= 4 * 1024 &&
1899 1900 1901
        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;
1902
        if (iscsilun->lbprz) {
1903
            ret = iscsi_allocmap_init(iscsilun, bs->open_flags);
1904 1905 1906
        }
    }

1907
out:
1908
    qemu_opts_del(opts);
1909
    g_free(initiator_name);
P
Peter Lieven 已提交
1910 1911 1912
    if (task != NULL) {
        scsi_free_scsi_task(task);
    }
1913 1914 1915

    if (ret) {
        if (iscsi != NULL) {
1916 1917 1918
            if (iscsi_is_logged_in(iscsi)) {
                iscsi_logout_sync(iscsi);
            }
1919 1920 1921
            iscsi_destroy_context(iscsi);
        }
        memset(iscsilun, 0, sizeof(IscsiLun));
R
Ronnie Sahlberg 已提交
1922 1923 1924 1925 1926 1927 1928 1929 1930
    }
    return ret;
}

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

1931
    iscsi_detach_aio_context(bs);
1932 1933 1934
    if (iscsi_is_logged_in(iscsi)) {
        iscsi_logout_sync(iscsi);
    }
R
Ronnie Sahlberg 已提交
1935
    iscsi_destroy_context(iscsi);
P
Peter Lieven 已提交
1936
    g_free(iscsilun->zeroblock);
1937
    iscsi_allocmap_free(iscsilun);
R
Ronnie Sahlberg 已提交
1938 1939 1940
    memset(iscsilun, 0, sizeof(IscsiLun));
}

1941 1942
static void iscsi_refresh_limits(BlockDriverState *bs, Error **errp)
{
1943 1944
    /* We don't actually refresh here, but just return data queried in
     * iscsi_open(): iscsi targets don't change their limits. */
1945 1946

    IscsiLun *iscsilun = bs->opaque;
1947
    uint64_t max_xfer_len = iscsilun->use_16_for_rw ? 0xffffffff : 0xffff;
1948
    unsigned int block_size = MAX(BDRV_SECTOR_SIZE, iscsilun->block_size);
1949

1950 1951 1952
    assert(iscsilun->block_size >= BDRV_SECTOR_SIZE || bs->sg);

    bs->bl.request_alignment = block_size;
1953

1954 1955 1956 1957
    if (iscsilun->bl.max_xfer_len) {
        max_xfer_len = MIN(max_xfer_len, iscsilun->bl.max_xfer_len);
    }

1958
    if (max_xfer_len * block_size < INT_MAX) {
1959 1960
        bs->bl.max_transfer = max_xfer_len * iscsilun->block_size;
    }
1961

1962
    if (iscsilun->lbp.lbpu) {
1963
        if (iscsilun->bl.max_unmap < 0xffffffff / block_size) {
1964 1965
            bs->bl.max_pdiscard =
                iscsilun->bl.max_unmap * iscsilun->block_size;
1966
        }
1967 1968
        bs->bl.pdiscard_alignment =
            iscsilun->bl.opt_unmap_gran * iscsilun->block_size;
1969
    } else {
1970
        bs->bl.pdiscard_alignment = iscsilun->block_size;
1971
    }
1972

1973
    if (iscsilun->bl.max_ws_len < 0xffffffff / block_size) {
1974 1975
        bs->bl.max_pwrite_zeroes =
            iscsilun->bl.max_ws_len * iscsilun->block_size;
1976 1977
    }
    if (iscsilun->lbp.lbpws) {
1978 1979
        bs->bl.pwrite_zeroes_alignment =
            iscsilun->bl.opt_unmap_gran * iscsilun->block_size;
1980
    } else {
1981
        bs->bl.pwrite_zeroes_alignment = iscsilun->block_size;
1982
    }
1983
    if (iscsilun->bl.opt_xfer_len &&
1984
        iscsilun->bl.opt_xfer_len < INT_MAX / block_size) {
1985 1986 1987
        bs->bl.opt_transfer = pow2floor(iscsilun->bl.opt_xfer_len *
                                        iscsilun->block_size);
    }
1988
}
1989

1990 1991
/* Note that this will not re-establish a connection with an iSCSI target - it
 * is effectively a NOP.  */
1992 1993 1994
static int iscsi_reopen_prepare(BDRVReopenState *state,
                                BlockReopenQueue *queue, Error **errp)
{
1995 1996 1997 1998 1999 2000
    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;
    }
2001 2002 2003
    return 0;
}

2004 2005 2006 2007 2008 2009 2010 2011 2012 2013
static void iscsi_reopen_commit(BDRVReopenState *reopen_state)
{
    IscsiLun *iscsilun = reopen_state->bs->opaque;

    /* the cache.direct status might have changed */
    if (iscsilun->allocmap != NULL) {
        iscsi_allocmap_init(iscsilun, reopen_state->flags);
    }
}

P
Peter Lieven 已提交
2014 2015 2016
static int iscsi_truncate(BlockDriverState *bs, int64_t offset)
{
    IscsiLun *iscsilun = bs->opaque;
2017
    Error *local_err = NULL;
P
Peter Lieven 已提交
2018 2019 2020 2021 2022

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

2023 2024 2025 2026
    iscsi_readcapacity_sync(iscsilun, &local_err);
    if (local_err != NULL) {
        error_free(local_err);
        return -EIO;
P
Peter Lieven 已提交
2027 2028 2029 2030 2031 2032
    }

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

2033 2034
    if (iscsilun->allocmap != NULL) {
        iscsi_allocmap_init(iscsilun, bs->open_flags);
2035 2036
    }

P
Peter Lieven 已提交
2037 2038 2039
    return 0;
}

2040
static int iscsi_create(const char *filename, QemuOpts *opts, Error **errp)
P
Peter Lieven 已提交
2041 2042 2043
{
    int ret = 0;
    int64_t total_size = 0;
2044
    BlockDriverState *bs;
P
Peter Lieven 已提交
2045
    IscsiLun *iscsilun = NULL;
2046
    QDict *bs_options;
P
Peter Lieven 已提交
2047

2048
    bs = bdrv_new();
P
Peter Lieven 已提交
2049 2050

    /* Read out options */
2051 2052
    total_size = DIV_ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0),
                              BDRV_SECTOR_SIZE);
2053
    bs->opaque = g_new0(struct IscsiLun, 1);
2054
    iscsilun = bs->opaque;
P
Peter Lieven 已提交
2055

2056 2057
    bs_options = qdict_new();
    qdict_put(bs_options, "filename", qstring_from_str(filename));
M
Max Reitz 已提交
2058
    ret = iscsi_open(bs, bs_options, 0, NULL);
2059 2060
    QDECREF(bs_options);

P
Peter Lieven 已提交
2061 2062 2063
    if (ret != 0) {
        goto out;
    }
2064
    iscsi_detach_aio_context(bs);
P
Peter Lieven 已提交
2065 2066 2067 2068
    if (iscsilun->type != TYPE_DISK) {
        ret = -ENODEV;
        goto out;
    }
2069
    if (bs->total_sectors < total_size) {
P
Peter Lieven 已提交
2070
        ret = -ENOSPC;
2071
        goto out;
P
Peter Lieven 已提交
2072 2073 2074 2075 2076 2077 2078
    }

    ret = 0;
out:
    if (iscsilun->iscsi != NULL) {
        iscsi_destroy_context(iscsilun->iscsi);
    }
2079 2080
    g_free(bs->opaque);
    bs->opaque = NULL;
F
Fam Zheng 已提交
2081
    bdrv_unref(bs);
P
Peter Lieven 已提交
2082 2083 2084
    return ret;
}

P
Peter Lieven 已提交
2085 2086 2087
static int iscsi_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
{
    IscsiLun *iscsilun = bs->opaque;
2088
    bdi->unallocated_blocks_are_zero = iscsilun->lbprz;
P
Peter Lieven 已提交
2089
    bdi->can_write_zeroes_with_unmap = iscsilun->lbprz && iscsilun->lbp.lbpws;
2090
    bdi->cluster_size = iscsilun->cluster_sectors * BDRV_SECTOR_SIZE;
P
Peter Lieven 已提交
2091 2092 2093
    return 0;
}

2094 2095 2096 2097 2098 2099 2100
static void iscsi_invalidate_cache(BlockDriverState *bs,
                                   Error **errp)
{
    IscsiLun *iscsilun = bs->opaque;
    iscsi_allocmap_invalidate(iscsilun);
}

2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111
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 已提交
2112 2113
};

R
Ronnie Sahlberg 已提交
2114 2115 2116 2117
static BlockDriver bdrv_iscsi = {
    .format_name     = "iscsi",
    .protocol_name   = "iscsi",

2118 2119 2120 2121 2122 2123 2124 2125 2126
    .instance_size          = sizeof(IscsiLun),
    .bdrv_parse_filename    = iscsi_parse_filename,
    .bdrv_file_open         = iscsi_open,
    .bdrv_close             = iscsi_close,
    .bdrv_create            = iscsi_create,
    .create_opts            = &iscsi_create_opts,
    .bdrv_reopen_prepare    = iscsi_reopen_prepare,
    .bdrv_reopen_commit     = iscsi_reopen_commit,
    .bdrv_invalidate_cache  = iscsi_invalidate_cache,
R
Ronnie Sahlberg 已提交
2127 2128

    .bdrv_getlength  = iscsi_getlength,
P
Peter Lieven 已提交
2129
    .bdrv_get_info   = iscsi_get_info,
P
Peter Lieven 已提交
2130
    .bdrv_truncate   = iscsi_truncate,
2131
    .bdrv_refresh_limits = iscsi_refresh_limits,
R
Ronnie Sahlberg 已提交
2132

P
Peter Lieven 已提交
2133
    .bdrv_co_get_block_status = iscsi_co_get_block_status,
2134
    .bdrv_co_pdiscard      = iscsi_co_pdiscard,
2135
    .bdrv_co_pwrite_zeroes = iscsi_co_pwrite_zeroes,
2136
    .bdrv_co_readv         = iscsi_co_readv,
K
Kevin Wolf 已提交
2137
    .bdrv_co_writev_flags  = iscsi_co_writev_flags,
2138
    .bdrv_co_flush_to_disk = iscsi_co_flush,
2139

2140 2141 2142
#ifdef __linux__
    .bdrv_aio_ioctl   = iscsi_aio_ioctl,
#endif
2143 2144 2145

    .bdrv_detach_aio_context = iscsi_detach_aio_context,
    .bdrv_attach_aio_context = iscsi_attach_aio_context,
R
Ronnie Sahlberg 已提交
2146 2147
};

2148 2149 2150 2151 2152
#if LIBISCSI_API_VERSION >= (20160603)
static BlockDriver bdrv_iser = {
    .format_name     = "iser",
    .protocol_name   = "iser",

2153 2154 2155 2156 2157 2158 2159 2160 2161
    .instance_size          = sizeof(IscsiLun),
    .bdrv_parse_filename    = iscsi_parse_filename,
    .bdrv_file_open         = iscsi_open,
    .bdrv_close             = iscsi_close,
    .bdrv_create            = iscsi_create,
    .create_opts            = &iscsi_create_opts,
    .bdrv_reopen_prepare    = iscsi_reopen_prepare,
    .bdrv_reopen_commit     = iscsi_reopen_commit,
    .bdrv_invalidate_cache  = iscsi_invalidate_cache,
2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183

    .bdrv_getlength  = iscsi_getlength,
    .bdrv_get_info   = iscsi_get_info,
    .bdrv_truncate   = iscsi_truncate,
    .bdrv_refresh_limits = iscsi_refresh_limits,

    .bdrv_co_get_block_status = iscsi_co_get_block_status,
    .bdrv_co_pdiscard      = iscsi_co_pdiscard,
    .bdrv_co_pwrite_zeroes = iscsi_co_pwrite_zeroes,
    .bdrv_co_readv         = iscsi_co_readv,
    .bdrv_co_writev_flags  = iscsi_co_writev_flags,
    .bdrv_co_flush_to_disk = iscsi_co_flush,

#ifdef __linux__
    .bdrv_aio_ioctl   = iscsi_aio_ioctl,
#endif

    .bdrv_detach_aio_context = iscsi_detach_aio_context,
    .bdrv_attach_aio_context = iscsi_attach_aio_context,
};
#endif

R
Ronnie Sahlberg 已提交
2184 2185 2186
static void iscsi_block_init(void)
{
    bdrv_register(&bdrv_iscsi);
2187 2188 2189
#if LIBISCSI_API_VERSION >= (20160603)
    bdrv_register(&bdrv_iser);
#endif
R
Ronnie Sahlberg 已提交
2190 2191 2192
}

block_init(iscsi_block_init);