nbd/server.c

   1 /*
   2  *  Copyright (C) 2016-2018 Red Hat, Inc.
   3  *  Copyright (C) 2005  Anthony Liguori <[email protected]>
   4  *
   5  *  Network Block Device Server Side
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License as published by
   9  *  the Free Software Foundation; under version 2 of the License.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include "qemu/osdep.h"
  21
  22 #include "block/export.h"
  23 #include "qapi/error.h"
  24 #include "qemu/queue.h"
  25 #include "trace.h"
  26 #include "nbd-internal.h"
  27 #include "qemu/units.h"
  28
  29 #define NBD_META_ID_BASE_ALLOCATION 0
  30 #define NBD_META_ID_DIRTY_BITMAP 1
  31
  32 /*
  33  * NBD_MAX_BLOCK_STATUS_EXTENTS: 1 MiB of extents data. An empirical
  34  * constant. If an increase is needed, note that the NBD protocol
  35  * recommends no larger than 32 mb, so that the client won't consider
  36  * the reply as a denial of service attack.
  37  */
  38 #define NBD_MAX_BLOCK_STATUS_EXTENTS (1 * MiB / 8)
  39
  40 static int system_errno_to_nbd_errno(int err)
  41 {
  42     switch (err) {
  43     case 0:
  44         return NBD_SUCCESS;
  45     case EPERM:
  46     case EROFS:
  47         return NBD_EPERM;
  48     case EIO:
  49         return NBD_EIO;
  50     case ENOMEM:
  51         return NBD_ENOMEM;
  52 #ifdef EDQUOT
  53     case EDQUOT:
  54 #endif
  55     case EFBIG:
  56     case ENOSPC:
  57         return NBD_ENOSPC;
  58     case EOVERFLOW:
  59         return NBD_EOVERFLOW;
  60     case ENOTSUP:
  61 #if ENOTSUP != EOPNOTSUPP
  62     case EOPNOTSUPP:
  63 #endif
  64         return NBD_ENOTSUP;
  65     case ESHUTDOWN:
  66         return NBD_ESHUTDOWN;
  67     case EINVAL:
  68     default:
  69         return NBD_EINVAL;
  70     }
  71 }
  72
  73 /* Definitions for opaque data types */
  74
  75 typedef struct NBDRequestData NBDRequestData;
  76
  77 struct NBDRequestData {
  78     QSIMPLEQ_ENTRY(NBDRequestData) entry;
  79     NBDClient *client;
  80     uint8_t *data;
  81     bool complete;
  82 };
  83
  84 struct NBDExport {
  85     BlockExport common;
  86     int refcount;
  87     void (*close)(NBDExport *exp);
  88
  89     BlockBackend *blk;
  90     char *name;
  91     char *description;
  92     uint64_t dev_offset;
  93     uint64_t size;
  94     uint16_t nbdflags;
  95     QTAILQ_HEAD(, NBDClient) clients;
  96     QTAILQ_ENTRY(NBDExport) next;
  97
  98     AioContext *ctx;
  99
 100     BlockBackend *eject_notifier_blk;
 101     Notifier eject_notifier;
 102
 103     BdrvDirtyBitmap *export_bitmap;
 104     char *export_bitmap_context;
 105 };
 106
 107 static QTAILQ_HEAD(, NBDExport) exports = QTAILQ_HEAD_INITIALIZER(exports);
 108 static QTAILQ_HEAD(, NBDExport) closed_exports =
 109         QTAILQ_HEAD_INITIALIZER(closed_exports);
 110
 111 /* NBDExportMetaContexts represents a list of contexts to be exported,
 112  * as selected by NBD_OPT_SET_META_CONTEXT. Also used for
 113  * NBD_OPT_LIST_META_CONTEXT. */
 114 typedef struct NBDExportMetaContexts {
 115     NBDExport *exp;
 116     bool valid; /* means that negotiation of the option finished without
 117                    errors */
 118     bool base_allocation; /* export base:allocation context (block status) */
 119     bool bitmap; /* export qemu:dirty-bitmap:<export bitmap name> */
 120 } NBDExportMetaContexts;
 121
 122 struct NBDClient {
 123     int refcount;
 124     void (*close_fn)(NBDClient *client, bool negotiated);
 125
 126     NBDExport *exp;
 127     QCryptoTLSCreds *tlscreds;
 128     char *tlsauthz;
 129     QIOChannelSocket *sioc; /* The underlying data channel */
 130     QIOChannel *ioc; /* The current I/O channel which may differ (eg TLS) */
 131
 132     Coroutine *recv_coroutine;
 133
 134     CoMutex send_lock;
 135     Coroutine *send_coroutine;
 136
 137     QTAILQ_ENTRY(NBDClient) next;
 138     int nb_requests;
 139     bool closing;
 140
 141     uint32_t check_align; /* If non-zero, check for aligned client requests */
 142
 143     bool structured_reply;
 144     NBDExportMetaContexts export_meta;
 145
 146     uint32_t opt; /* Current option being negotiated */
 147     uint32_t optlen; /* remaining length of data in ioc for the option being
 148                         negotiated now */
 149 };
 150
 151 static void nbd_client_receive_next_request(NBDClient *client);
 152
 153 /* Basic flow for negotiation
 154
 155    Server         Client
 156    Negotiate
 157
 158    or
 159
 160    Server         Client
 161    Negotiate #1
 162                   Option
 163    Negotiate #2
 164
 165    ----
 166
 167    followed by
 168
 169    Server         Client
 170                   Request
 171    Response
 172                   Request
 173    Response
 174                   ...
 175    ...
 176                   Request (type == 2)
 177
 178 */
 179
 180 static inline void set_be_option_rep(NBDOptionReply *rep, uint32_t option,
 181                                      uint32_t type, uint32_t length)
 182 {
 183     stq_be_p(&rep->magic, NBD_REP_MAGIC);
 184     stl_be_p(&rep->option, option);
 185     stl_be_p(&rep->type, type);
 186     stl_be_p(&rep->length, length);
 187 }
 188
 189 /* Send a reply header, including length, but no payload.
 190  * Return -errno on error, 0 on success. */
 191 static int nbd_negotiate_send_rep_len(NBDClient *client, uint32_t type,
 192                                       uint32_t len, Error **errp)
 193 {
 194     NBDOptionReply rep;
 195
 196     trace_nbd_negotiate_send_rep_len(client->opt, nbd_opt_lookup(client->opt),
 197                                      type, nbd_rep_lookup(type), len);
 198
 199     assert(len < NBD_MAX_BUFFER_SIZE);
 200
 201     set_be_option_rep(&rep, client->opt, type, len);
 202     return nbd_write(client->ioc, &rep, sizeof(rep), errp);
 203 }
 204
 205 /* Send a reply header with default 0 length.
 206  * Return -errno on error, 0 on success. */
 207 static int nbd_negotiate_send_rep(NBDClient *client, uint32_t type,
 208                                   Error **errp)
 209 {
 210     return nbd_negotiate_send_rep_len(client, type, 0, errp);
 211 }
 212
 213 /* Send an error reply.
 214  * Return -errno on error, 0 on success. */
 215 static int GCC_FMT_ATTR(4, 0)
 216 nbd_negotiate_send_rep_verr(NBDClient *client, uint32_t type,
 217                             Error **errp, const char *fmt, va_list va)
 218 {
 219     ERRP_GUARD();
 220     g_autofree char *msg = NULL;
 221     int ret;
 222     size_t len;
 223
 224     msg = g_strdup_vprintf(fmt, va);
 225     len = strlen(msg);
 226     assert(len < NBD_MAX_STRING_SIZE);
 227     trace_nbd_negotiate_send_rep_err(msg);
 228     ret = nbd_negotiate_send_rep_len(client, type, len, errp);
 229     if (ret < 0) {
 230         return ret;
 231     }
 232     if (nbd_write(client->ioc, msg, len, errp) < 0) {
 233         error_prepend(errp, "write failed (error message): ");
 234         return -EIO;
 235     }
 236
 237     return 0;
 238 }
 239
 240 /*
 241  * Return a malloc'd copy of @name suitable for use in an error reply.
 242  */
 243 static char *
 244 nbd_sanitize_name(const char *name)
 245 {
 246     if (strnlen(name, 80) < 80) {
 247         return g_strdup(name);
 248     }
 249     /* XXX Should we also try to sanitize any control characters? */
 250     return g_strdup_printf("%.80s...", name);
 251 }
 252
 253 /* Send an error reply.
 254  * Return -errno on error, 0 on success. */
 255 static int GCC_FMT_ATTR(4, 5)
 256 nbd_negotiate_send_rep_err(NBDClient *client, uint32_t type,
 257                            Error **errp, const char *fmt, ...)
 258 {
 259     va_list va;
 260     int ret;
 261
 262     va_start(va, fmt);
 263     ret = nbd_negotiate_send_rep_verr(client, type, errp, fmt, va);
 264     va_end(va);
 265     return ret;
 266 }
 267
 268 /* Drop remainder of the current option, and send a reply with the
 269  * given error type and message. Return -errno on read or write
 270  * failure; or 0 if connection is still live. */
 271 static int GCC_FMT_ATTR(4, 0)
 272 nbd_opt_vdrop(NBDClient *client, uint32_t type, Error **errp,
 273               const char *fmt, va_list va)
 274 {
 275     int ret = nbd_drop(client->ioc, client->optlen, errp);
 276
 277     client->optlen = 0;
 278     if (!ret) {
 279         ret = nbd_negotiate_send_rep_verr(client, type, errp, fmt, va);
 280     }
 281     return ret;
 282 }
 283
 284 static int GCC_FMT_ATTR(4, 5)
 285 nbd_opt_drop(NBDClient *client, uint32_t type, Error **errp,
 286              const char *fmt, ...)
 287 {
 288     int ret;
 289     va_list va;
 290
 291     va_start(va, fmt);
 292     ret = nbd_opt_vdrop(client, type, errp, fmt, va);
 293     va_end(va);
 294
 295     return ret;
 296 }
 297
 298 static int GCC_FMT_ATTR(3, 4)
 299 nbd_opt_invalid(NBDClient *client, Error **errp, const char *fmt, ...)
 300 {
 301     int ret;
 302     va_list va;
 303
 304     va_start(va, fmt);
 305     ret = nbd_opt_vdrop(client, NBD_REP_ERR_INVALID, errp, fmt, va);
 306     va_end(va);
 307
 308     return ret;
 309 }
 310
 311 /* Read size bytes from the unparsed payload of the current option.
 312  * Return -errno on I/O error, 0 if option was completely handled by
 313  * sending a reply about inconsistent lengths, or 1 on success. */
 314 static int nbd_opt_read(NBDClient *client, void *buffer, size_t size,
 315                         Error **errp)
 316 {
 317     if (size > client->optlen) {
 318         return nbd_opt_invalid(client, errp,
 319                                "Inconsistent lengths in option %s",
 320                                nbd_opt_lookup(client->opt));
 321     }
 322     client->optlen -= size;
 323     return qio_channel_read_all(client->ioc, buffer, size, errp) < 0 ? -EIO : 1;
 324 }
 325
 326 /* Drop size bytes from the unparsed payload of the current option.
 327  * Return -errno on I/O error, 0 if option was completely handled by
 328  * sending a reply about inconsistent lengths, or 1 on success. */
 329 static int nbd_opt_skip(NBDClient *client, size_t size, Error **errp)
 330 {
 331     if (size > client->optlen) {
 332         return nbd_opt_invalid(client, errp,
 333                                "Inconsistent lengths in option %s",
 334                                nbd_opt_lookup(client->opt));
 335     }
 336     client->optlen -= size;
 337     return nbd_drop(client->ioc, size, errp) < 0 ? -EIO : 1;
 338 }
 339
 340 /* nbd_opt_read_name
 341  *
 342  * Read a string with the format:
 343  *   uint32_t len     (<= NBD_MAX_STRING_SIZE)
 344  *   len bytes string (not 0-terminated)
 345  *
 346  * On success, @name will be allocated.
 347  * If @length is non-null, it will be set to the actual string length.
 348  *
 349  * Return -errno on I/O error, 0 if option was completely handled by
 350  * sending a reply about inconsistent lengths, or 1 on success.
 351  */
 352 static int nbd_opt_read_name(NBDClient *client, char **name, uint32_t *length,
 353                              Error **errp)
 354 {
 355     int ret;
 356     uint32_t len;
 357     g_autofree char *local_name = NULL;
 358
 359     *name = NULL;
 360     ret = nbd_opt_read(client, &len, sizeof(len), errp);
 361     if (ret <= 0) {
 362         return ret;
 363     }
 364     len = cpu_to_be32(len);
 365
 366     if (len > NBD_MAX_STRING_SIZE) {
 367         return nbd_opt_invalid(client, errp,
 368                                "Invalid name length: %" PRIu32, len);
 369     }
 370
 371     local_name = g_malloc(len + 1);
 372     ret = nbd_opt_read(client, local_name, len, errp);
 373     if (ret <= 0) {
 374         return ret;
 375     }
 376     local_name[len] = '\0';
 377
 378     if (length) {
 379         *length = len;
 380     }
 381     *name = g_steal_pointer(&local_name);
 382
 383     return 1;
 384 }
 385
 386 /* Send a single NBD_REP_SERVER reply to NBD_OPT_LIST, including payload.
 387  * Return -errno on error, 0 on success. */
 388 static int nbd_negotiate_send_rep_list(NBDClient *client, NBDExport *exp,
 389                                        Error **errp)
 390 {
 391     ERRP_GUARD();
 392     size_t name_len, desc_len;
 393     uint32_t len;
 394     const char *name = exp->name ? exp->name : "";
 395     const char *desc = exp->description ? exp->description : "";
 396     QIOChannel *ioc = client->ioc;
 397     int ret;
 398
 399     trace_nbd_negotiate_send_rep_list(name, desc);
 400     name_len = strlen(name);
 401     desc_len = strlen(desc);
 402     assert(name_len <= NBD_MAX_STRING_SIZE && desc_len <= NBD_MAX_STRING_SIZE);
 403     len = name_len + desc_len + sizeof(len);
 404     ret = nbd_negotiate_send_rep_len(client, NBD_REP_SERVER, len, errp);
 405     if (ret < 0) {
 406         return ret;
 407     }
 408
 409     len = cpu_to_be32(name_len);
 410     if (nbd_write(ioc, &len, sizeof(len), errp) < 0) {
 411         error_prepend(errp, "write failed (name length): ");
 412         return -EINVAL;
 413     }
 414
 415     if (nbd_write(ioc, name, name_len, errp) < 0) {
 416         error_prepend(errp, "write failed (name buffer): ");
 417         return -EINVAL;
 418     }
 419
 420     if (nbd_write(ioc, desc, desc_len, errp) < 0) {
 421         error_prepend(errp, "write failed (description buffer): ");
 422         return -EINVAL;
 423     }
 424
 425     return 0;
 426 }
 427
 428 /* Process the NBD_OPT_LIST command, with a potential series of replies.
 429  * Return -errno on error, 0 on success. */
 430 static int nbd_negotiate_handle_list(NBDClient *client, Error **errp)
 431 {
 432     NBDExport *exp;
 433     assert(client->opt == NBD_OPT_LIST);
 434
 435     /* For each export, send a NBD_REP_SERVER reply. */
 436     QTAILQ_FOREACH(exp, &exports, next) {
 437         if (nbd_negotiate_send_rep_list(client, exp, errp)) {
 438             return -EINVAL;
 439         }
 440     }
 441     /* Finish with a NBD_REP_ACK. */
 442     return nbd_negotiate_send_rep(client, NBD_REP_ACK, errp);
 443 }
 444
 445 static void nbd_check_meta_export(NBDClient *client)
 446 {
 447     client->export_meta.valid &= client->exp == client->export_meta.exp;
 448 }
 449
 450 /* Send a reply to NBD_OPT_EXPORT_NAME.
 451  * Return -errno on error, 0 on success. */
 452 static int nbd_negotiate_handle_export_name(NBDClient *client, bool no_zeroes,
 453                                             Error **errp)
 454 {
 455     ERRP_GUARD();
 456     g_autofree char *name = NULL;
 457     char buf[NBD_REPLY_EXPORT_NAME_SIZE] = "";
 458     size_t len;
 459     int ret;
 460     uint16_t myflags;
 461
 462     /* Client sends:
 463         [20 ..  xx]   export name (length bytes)
 464        Server replies:
 465         [ 0 ..   7]   size
 466         [ 8 ..   9]   export flags
 467         [10 .. 133]   reserved     (0) [unless no_zeroes]
 468      */
 469     trace_nbd_negotiate_handle_export_name();
 470     if (client->optlen > NBD_MAX_STRING_SIZE) {
 471         error_setg(errp, "Bad length received");
 472         return -EINVAL;
 473     }
 474     name = g_malloc(client->optlen + 1);
 475     if (nbd_read(client->ioc, name, client->optlen, "export name", errp) < 0) {
 476         return -EIO;
 477     }
 478     name[client->optlen] = '\0';
 479     client->optlen = 0;
 480
 481     trace_nbd_negotiate_handle_export_name_request(name);
 482
 483     client->exp = nbd_export_find(name);
 484     if (!client->exp) {
 485         error_setg(errp, "export not found");
 486         return -EINVAL;
 487     }
 488
 489     myflags = client->exp->nbdflags;
 490     if (client->structured_reply) {
 491         myflags |= NBD_FLAG_SEND_DF;
 492     }
 493     trace_nbd_negotiate_new_style_size_flags(client->exp->size, myflags);
 494     stq_be_p(buf, client->exp->size);
 495     stw_be_p(buf + 8, myflags);
 496     len = no_zeroes ? 10 : sizeof(buf);
 497     ret = nbd_write(client->ioc, buf, len, errp);
 498     if (ret < 0) {
 499         error_prepend(errp, "write failed: ");
 500         return ret;
 501     }
 502
 503     QTAILQ_INSERT_TAIL(&client->exp->clients, client, next);
 504     nbd_export_get(client->exp);
 505     nbd_check_meta_export(client);
 506
 507     return 0;
 508 }
 509
 510 /* Send a single NBD_REP_INFO, with a buffer @buf of @length bytes.
 511  * The buffer does NOT include the info type prefix.
 512  * Return -errno on error, 0 if ready to send more. */
 513 static int nbd_negotiate_send_info(NBDClient *client,
 514                                    uint16_t info, uint32_t length, void *buf,
 515                                    Error **errp)
 516 {
 517     int rc;
 518
 519     trace_nbd_negotiate_send_info(info, nbd_info_lookup(info), length);
 520     rc = nbd_negotiate_send_rep_len(client, NBD_REP_INFO,
 521                                     sizeof(info) + length, errp);
 522     if (rc < 0) {
 523         return rc;
 524     }
 525     info = cpu_to_be16(info);
 526     if (nbd_write(client->ioc, &info, sizeof(info), errp) < 0) {
 527         return -EIO;
 528     }
 529     if (nbd_write(client->ioc, buf, length, errp) < 0) {
 530         return -EIO;
 531     }
 532     return 0;
 533 }
 534
 535 /* nbd_reject_length: Handle any unexpected payload.
 536  * @fatal requests that we quit talking to the client, even if we are able
 537  * to successfully send an error reply.
 538  * Return:
 539  * -errno  transmission error occurred or @fatal was requested, errp is set
 540  * 0       error message successfully sent to client, errp is not set
 541  */
 542 static int nbd_reject_length(NBDClient *client, bool fatal, Error **errp)
 543 {
 544     int ret;
 545
 546     assert(client->optlen);
 547     ret = nbd_opt_invalid(client, errp, "option '%s' has unexpected length",
 548                           nbd_opt_lookup(client->opt));
 549     if (fatal && !ret) {
 550         error_setg(errp, "option '%s' has unexpected length",
 551                    nbd_opt_lookup(client->opt));
 552         return -EINVAL;
 553     }
 554     return ret;
 555 }
 556
 557 /* Handle NBD_OPT_INFO and NBD_OPT_GO.
 558  * Return -errno on error, 0 if ready for next option, and 1 to move
 559  * into transmission phase.  */
 560 static int nbd_negotiate_handle_info(NBDClient *client, Error **errp)
 561 {
 562     int rc;
 563     g_autofree char *name = NULL;
 564     NBDExport *exp;
 565     uint16_t requests;
 566     uint16_t request;
 567     uint32_t namelen;
 568     bool sendname = false;
 569     bool blocksize = false;
 570     uint32_t sizes[3];
 571     char buf[sizeof(uint64_t) + sizeof(uint16_t)];
 572     uint32_t check_align = 0;
 573     uint16_t myflags;
 574
 575     /* Client sends:
 576         4 bytes: L, name length (can be 0)
 577         L bytes: export name
 578         2 bytes: N, number of requests (can be 0)
 579         N * 2 bytes: N requests
 580     */
 581     rc = nbd_opt_read_name(client, &name, &namelen, errp);
 582     if (rc <= 0) {
 583         return rc;
 584     }
 585     trace_nbd_negotiate_handle_export_name_request(name);
 586
 587     rc = nbd_opt_read(client, &requests, sizeof(requests), errp);
 588     if (rc <= 0) {
 589         return rc;
 590     }
 591     requests = be16_to_cpu(requests);
 592     trace_nbd_negotiate_handle_info_requests(requests);
 593     while (requests--) {
 594         rc = nbd_opt_read(client, &request, sizeof(request), errp);
 595         if (rc <= 0) {
 596             return rc;
 597         }
 598         request = be16_to_cpu(request);
 599         trace_nbd_negotiate_handle_info_request(request,
 600                                                 nbd_info_lookup(request));
 601         /* We care about NBD_INFO_NAME and NBD_INFO_BLOCK_SIZE;
 602          * everything else is either a request we don't know or
 603          * something we send regardless of request */
 604         switch (request) {
 605         case NBD_INFO_NAME:
 606             sendname = true;
 607             break;
 608         case NBD_INFO_BLOCK_SIZE:
 609             blocksize = true;
 610             break;
 611         }
 612     }
 613     if (client->optlen) {
 614         return nbd_reject_length(client, false, errp);
 615     }
 616
 617     exp = nbd_export_find(name);
 618     if (!exp) {
 619         g_autofree char *sane_name = nbd_sanitize_name(name);
 620
 621         return nbd_negotiate_send_rep_err(client, NBD_REP_ERR_UNKNOWN,
 622                                           errp, "export '%s' not present",
 623                                           sane_name);
 624     }
 625
 626     /* Don't bother sending NBD_INFO_NAME unless client requested it */
 627     if (sendname) {
 628         rc = nbd_negotiate_send_info(client, NBD_INFO_NAME, namelen, name,
 629                                      errp);
 630         if (rc < 0) {
 631             return rc;
 632         }
 633     }
 634
 635     /* Send NBD_INFO_DESCRIPTION only if available, regardless of
 636      * client request */
 637     if (exp->description) {
 638         size_t len = strlen(exp->description);
 639
 640         assert(len <= NBD_MAX_STRING_SIZE);
 641         rc = nbd_negotiate_send_info(client, NBD_INFO_DESCRIPTION,
 642                                      len, exp->description, errp);
 643         if (rc < 0) {
 644             return rc;
 645         }
 646     }
 647
 648     /* Send NBD_INFO_BLOCK_SIZE always, but tweak the minimum size
 649      * according to whether the client requested it, and according to
 650      * whether this is OPT_INFO or OPT_GO. */
 651     /* minimum - 1 for back-compat, or actual if client will obey it. */
 652     if (client->opt == NBD_OPT_INFO || blocksize) {
 653         check_align = sizes[0] = blk_get_request_alignment(exp->blk);
 654     } else {
 655         sizes[0] = 1;
 656     }
 657     assert(sizes[0] <= NBD_MAX_BUFFER_SIZE);
 658     /* preferred - Hard-code to 4096 for now.
 659      * TODO: is blk_bs(blk)->bl.opt_transfer appropriate? */
 660     sizes[1] = MAX(4096, sizes[0]);
 661     /* maximum - At most 32M, but smaller as appropriate. */
 662     sizes[2] = MIN(blk_get_max_transfer(exp->blk), NBD_MAX_BUFFER_SIZE);
 663     trace_nbd_negotiate_handle_info_block_size(sizes[0], sizes[1], sizes[2]);
 664     sizes[0] = cpu_to_be32(sizes[0]);
 665     sizes[1] = cpu_to_be32(sizes[1]);
 666     sizes[2] = cpu_to_be32(sizes[2]);
 667     rc = nbd_negotiate_send_info(client, NBD_INFO_BLOCK_SIZE,
 668                                  sizeof(sizes), sizes, errp);
 669     if (rc < 0) {
 670         return rc;
 671     }
 672
 673     /* Send NBD_INFO_EXPORT always */
 674     myflags = exp->nbdflags;
 675     if (client->structured_reply) {
 676         myflags |= NBD_FLAG_SEND_DF;
 677     }
 678     trace_nbd_negotiate_new_style_size_flags(exp->size, myflags);
 679     stq_be_p(buf, exp->size);
 680     stw_be_p(buf + 8, myflags);
 681     rc = nbd_negotiate_send_info(client, NBD_INFO_EXPORT,
 682                                  sizeof(buf), buf, errp);
 683     if (rc < 0) {
 684         return rc;
 685     }
 686
 687     /*
 688      * If the client is just asking for NBD_OPT_INFO, but forgot to
 689      * request block sizes in a situation that would impact
 690      * performance, then return an error. But for NBD_OPT_GO, we
 691      * tolerate all clients, regardless of alignments.
 692      */
 693     if (client->opt == NBD_OPT_INFO && !blocksize &&
 694         blk_get_request_alignment(exp->blk) > 1) {
 695         return nbd_negotiate_send_rep_err(client,
 696                                           NBD_REP_ERR_BLOCK_SIZE_REQD,
 697                                           errp,
 698                                           "request NBD_INFO_BLOCK_SIZE to "
 699                                           "use this export");
 700     }
 701
 702     /* Final reply */
 703     rc = nbd_negotiate_send_rep(client, NBD_REP_ACK, errp);
 704     if (rc < 0) {
 705         return rc;
 706     }
 707
 708     if (client->opt == NBD_OPT_GO) {
 709         client->exp = exp;
 710         client->check_align = check_align;
 711         QTAILQ_INSERT_TAIL(&client->exp->clients, client, next);
 712         nbd_export_get(client->exp);
 713         nbd_check_meta_export(client);
 714         rc = 1;
 715     }
 716     return rc;
 717 }
 718
 719
 720 /* Handle NBD_OPT_STARTTLS. Return NULL to drop connection, or else the
 721  * new channel for all further (now-encrypted) communication. */
 722 static QIOChannel *nbd_negotiate_handle_starttls(NBDClient *client,
 723                                                  Error **errp)
 724 {
 725     QIOChannel *ioc;
 726     QIOChannelTLS *tioc;
 727     struct NBDTLSHandshakeData data = { 0 };
 728
 729     assert(client->opt == NBD_OPT_STARTTLS);
 730
 731     trace_nbd_negotiate_handle_starttls();
 732     ioc = client->ioc;
 733
 734     if (nbd_negotiate_send_rep(client, NBD_REP_ACK, errp) < 0) {
 735         return NULL;
 736     }
 737
 738     tioc = qio_channel_tls_new_server(ioc,
 739                                       client->tlscreds,
 740                                       client->tlsauthz,
 741                                       errp);
 742     if (!tioc) {
 743         return NULL;
 744     }
 745
 746     qio_channel_set_name(QIO_CHANNEL(tioc), "nbd-server-tls");
 747     trace_nbd_negotiate_handle_starttls_handshake();
 748     data.loop = g_main_loop_new(g_main_context_default(), FALSE);
 749     qio_channel_tls_handshake(tioc,
 750                               nbd_tls_handshake,
 751                               &data,
 752                               NULL,
 753                               NULL);
 754
 755     if (!data.complete) {
 756         g_main_loop_run(data.loop);
 757     }
 758     g_main_loop_unref(data.loop);
 759     if (data.error) {
 760         object_unref(OBJECT(tioc));
 761         error_propagate(errp, data.error);
 762         return NULL;
 763     }
 764
 765     return QIO_CHANNEL(tioc);
 766 }
 767
 768 /* nbd_negotiate_send_meta_context
 769  *
 770  * Send one chunk of reply to NBD_OPT_{LIST,SET}_META_CONTEXT
 771  *
 772  * For NBD_OPT_LIST_META_CONTEXT @context_id is ignored, 0 is used instead.
 773  */
 774 static int nbd_negotiate_send_meta_context(NBDClient *client,
 775                                            const char *context,
 776                                            uint32_t context_id,
 777                                            Error **errp)
 778 {
 779     NBDOptionReplyMetaContext opt;
 780     struct iovec iov[] = {
 781         {.iov_base = &opt, .iov_len = sizeof(opt)},
 782         {.iov_base = (void *)context, .iov_len = strlen(context)}
 783     };
 784
 785     assert(iov[1].iov_len <= NBD_MAX_STRING_SIZE);
 786     if (client->opt == NBD_OPT_LIST_META_CONTEXT) {
 787         context_id = 0;
 788     }
 789
 790     trace_nbd_negotiate_meta_query_reply(context, context_id);
 791     set_be_option_rep(&opt.h, client->opt, NBD_REP_META_CONTEXT,
 792                       sizeof(opt) - sizeof(opt.h) + iov[1].iov_len);
 793     stl_be_p(&opt.context_id, context_id);
 794
 795     return qio_channel_writev_all(client->ioc, iov, 2, errp) < 0 ? -EIO : 0;
 796 }
 797
 798 /* Read strlen(@pattern) bytes, and set @match to true if they match @pattern.
 799  * @match is never set to false.
 800  *
 801  * Return -errno on I/O error, 0 if option was completely handled by
 802  * sending a reply about inconsistent lengths, or 1 on success.
 803  *
 804  * Note: return code = 1 doesn't mean that we've read exactly @pattern.
 805  * It only means that there are no errors.
 806  */
 807 static int nbd_meta_pattern(NBDClient *client, const char *pattern, bool *match,
 808                             Error **errp)
 809 {
 810     int ret;
 811     char *query;
 812     size_t len = strlen(pattern);
 813
 814     assert(len);
 815
 816     query = g_malloc(len);
 817     ret = nbd_opt_read(client, query, len, errp);
 818     if (ret <= 0) {
 819         g_free(query);
 820         return ret;
 821     }
 822
 823     if (strncmp(query, pattern, len) == 0) {
 824         trace_nbd_negotiate_meta_query_parse(pattern);
 825         *match = true;
 826     } else {
 827         trace_nbd_negotiate_meta_query_skip("pattern not matched");
 828     }
 829     g_free(query);
 830
 831     return 1;
 832 }
 833
 834 /*
 835  * Read @len bytes, and set @match to true if they match @pattern, or if @len
 836  * is 0 and the client is performing _LIST_. @match is never set to false.
 837  *
 838  * Return -errno on I/O error, 0 if option was completely handled by
 839  * sending a reply about inconsistent lengths, or 1 on success.
 840  *
 841  * Note: return code = 1 doesn't mean that we've read exactly @pattern.
 842  * It only means that there are no errors.
 843  */
 844 static int nbd_meta_empty_or_pattern(NBDClient *client, const char *pattern,
 845                                      uint32_t len, bool *match, Error **errp)
 846 {
 847     if (len == 0) {
 848         if (client->opt == NBD_OPT_LIST_META_CONTEXT) {
 849             *match = true;
 850         }
 851         trace_nbd_negotiate_meta_query_parse("empty");
 852         return 1;
 853     }
 854
 855     if (len != strlen(pattern)) {
 856         trace_nbd_negotiate_meta_query_skip("different lengths");
 857         return nbd_opt_skip(client, len, errp);
 858     }
 859
 860     return nbd_meta_pattern(client, pattern, match, errp);
 861 }
 862
 863 /* nbd_meta_base_query
 864  *
 865  * Handle queries to 'base' namespace. For now, only the base:allocation
 866  * context is available.  'len' is the amount of text remaining to be read from
 867  * the current name, after the 'base:' portion has been stripped.
 868  *
 869  * Return -errno on I/O error, 0 if option was completely handled by
 870  * sending a reply about inconsistent lengths, or 1 on success.
 871  */
 872 static int nbd_meta_base_query(NBDClient *client, NBDExportMetaContexts *meta,
 873                                uint32_t len, Error **errp)
 874 {
 875     return nbd_meta_empty_or_pattern(client, "allocation", len,
 876                                      &meta->base_allocation, errp);
 877 }
 878
 879 /* nbd_meta_bitmap_query
 880  *
 881  * Handle query to 'qemu:' namespace.
 882  * @len is the amount of text remaining to be read from the current name, after
 883  * the 'qemu:' portion has been stripped.
 884  *
 885  * Return -errno on I/O error, 0 if option was completely handled by
 886  * sending a reply about inconsistent lengths, or 1 on success. */
 887 static int nbd_meta_qemu_query(NBDClient *client, NBDExportMetaContexts *meta,
 888                                uint32_t len, Error **errp)
 889 {
 890     bool dirty_bitmap = false;
 891     size_t dirty_bitmap_len = strlen("dirty-bitmap:");
 892     int ret;
 893
 894     if (!meta->exp->export_bitmap) {
 895         trace_nbd_negotiate_meta_query_skip("no dirty-bitmap exported");
 896         return nbd_opt_skip(client, len, errp);
 897     }
 898
 899     if (len == 0) {
 900         if (client->opt == NBD_OPT_LIST_META_CONTEXT) {
 901             meta->bitmap = true;
 902         }
 903         trace_nbd_negotiate_meta_query_parse("empty");
 904         return 1;
 905     }
 906
 907     if (len < dirty_bitmap_len) {
 908         trace_nbd_negotiate_meta_query_skip("not dirty-bitmap:");
 909         return nbd_opt_skip(client, len, errp);
 910     }
 911
 912     len -= dirty_bitmap_len;
 913     ret = nbd_meta_pattern(client, "dirty-bitmap:", &dirty_bitmap, errp);
 914     if (ret <= 0) {
 915         return ret;
 916     }
 917     if (!dirty_bitmap) {
 918         trace_nbd_negotiate_meta_query_skip("not dirty-bitmap:");
 919         return nbd_opt_skip(client, len, errp);
 920     }
 921
 922     trace_nbd_negotiate_meta_query_parse("dirty-bitmap:");
 923
 924     return nbd_meta_empty_or_pattern(
 925             client, meta->exp->export_bitmap_context +
 926             strlen("qemu:dirty_bitmap:"), len, &meta->bitmap, errp);
 927 }
 928
 929 /* nbd_negotiate_meta_query
 930  *
 931  * Parse namespace name and call corresponding function to parse body of the
 932  * query.
 933  *
 934  * The only supported namespaces are 'base' and 'qemu'.
 935  *
 936  * The function aims not wasting time and memory to read long unknown namespace
 937  * names.
 938  *
 939  * Return -errno on I/O error, 0 if option was completely handled by
 940  * sending a reply about inconsistent lengths, or 1 on success. */
 941 static int nbd_negotiate_meta_query(NBDClient *client,
 942                                     NBDExportMetaContexts *meta, Error **errp)
 943 {
 944     /*
 945      * Both 'qemu' and 'base' namespaces have length = 5 including a
 946      * colon. If another length namespace is later introduced, this
 947      * should certainly be refactored.
 948      */
 949     int ret;
 950     size_t ns_len = 5;
 951     char ns[5];
 952     uint32_t len;
 953
 954     ret = nbd_opt_read(client, &len, sizeof(len), errp);
 955     if (ret <= 0) {
 956         return ret;
 957     }
 958     len = cpu_to_be32(len);
 959
 960     if (len > NBD_MAX_STRING_SIZE) {
 961         trace_nbd_negotiate_meta_query_skip("length too long");
 962         return nbd_opt_skip(client, len, errp);
 963     }
 964     if (len < ns_len) {
 965         trace_nbd_negotiate_meta_query_skip("length too short");
 966         return nbd_opt_skip(client, len, errp);
 967     }
 968
 969     len -= ns_len;
 970     ret = nbd_opt_read(client, ns, ns_len, errp);
 971     if (ret <= 0) {
 972         return ret;
 973     }
 974
 975     if (!strncmp(ns, "base:", ns_len)) {
 976         trace_nbd_negotiate_meta_query_parse("base:");
 977         return nbd_meta_base_query(client, meta, len, errp);
 978     } else if (!strncmp(ns, "qemu:", ns_len)) {
 979         trace_nbd_negotiate_meta_query_parse("qemu:");
 980         return nbd_meta_qemu_query(client, meta, len, errp);
 981     }
 982
 983     trace_nbd_negotiate_meta_query_skip("unknown namespace");
 984     return nbd_opt_skip(client, len, errp);
 985 }
 986
 987 /* nbd_negotiate_meta_queries
 988  * Handle NBD_OPT_LIST_META_CONTEXT and NBD_OPT_SET_META_CONTEXT
 989  *
 990  * Return -errno on I/O error, or 0 if option was completely handled. */
 991 static int nbd_negotiate_meta_queries(NBDClient *client,
 992                                       NBDExportMetaContexts *meta, Error **errp)
 993 {
 994     int ret;
 995     g_autofree char *export_name = NULL;
 996     NBDExportMetaContexts local_meta;
 997     uint32_t nb_queries;
 998     int i;
 999
1000     if (!client->structured_reply) {
1001         return nbd_opt_invalid(client, errp,
1002                                "request option '%s' when structured reply "
1003                                "is not negotiated",
1004                                nbd_opt_lookup(client->opt));
1005     }
1006
1007     if (client->opt == NBD_OPT_LIST_META_CONTEXT) {
1008         /* Only change the caller's meta on SET. */
1009         meta = &local_meta;
1010     }
1011
1012     memset(meta, 0, sizeof(*meta));
1013
1014     ret = nbd_opt_read_name(client, &export_name, NULL, errp);
1015     if (ret <= 0) {
1016         return ret;
1017     }
1018
1019     meta->exp = nbd_export_find(export_name);
1020     if (meta->exp == NULL) {
1021         g_autofree char *sane_name = nbd_sanitize_name(export_name);
1022
1023         return nbd_opt_drop(client, NBD_REP_ERR_UNKNOWN, errp,
1024                             "export '%s' not present", sane_name);
1025     }
1026
1027     ret = nbd_opt_read(client, &nb_queries, sizeof(nb_queries), errp);
1028     if (ret <= 0) {
1029         return ret;
1030     }
1031     nb_queries = cpu_to_be32(nb_queries);
1032     trace_nbd_negotiate_meta_context(nbd_opt_lookup(client->opt),
1033                                      export_name, nb_queries);
1034
1035     if (client->opt == NBD_OPT_LIST_META_CONTEXT && !nb_queries) {
1036         /* enable all known contexts */
1037         meta->base_allocation = true;
1038         meta->bitmap = !!meta->exp->export_bitmap;
1039     } else {
1040         for (i = 0; i < nb_queries; ++i) {
1041             ret = nbd_negotiate_meta_query(client, meta, errp);
1042             if (ret <= 0) {
1043                 return ret;
1044             }
1045         }
1046     }
1047
1048     if (meta->base_allocation) {
1049         ret = nbd_negotiate_send_meta_context(client, "base:allocation",
1050                                               NBD_META_ID_BASE_ALLOCATION,
1051                                               errp);
1052         if (ret < 0) {
1053             return ret;
1054         }
1055     }
1056
1057     if (meta->bitmap) {
1058         ret = nbd_negotiate_send_meta_context(client,
1059                                               meta->exp->export_bitmap_context,
1060                                               NBD_META_ID_DIRTY_BITMAP,
1061                                               errp);
1062         if (ret < 0) {
1063             return ret;
1064         }
1065     }
1066
1067     ret = nbd_negotiate_send_rep(client, NBD_REP_ACK, errp);
1068     if (ret == 0) {
1069         meta->valid = true;
1070     }
1071
1072     return ret;
1073 }
1074
1075 /* nbd_negotiate_options
1076  * Process all NBD_OPT_* client option commands, during fixed newstyle
1077  * negotiation.
1078  * Return:
1079  * -errno  on error, errp is set
1080  * 0       on successful negotiation, errp is not set
1081  * 1       if client sent NBD_OPT_ABORT, i.e. on valid disconnect,
1082  *         errp is not set
1083  */
1084 static int nbd_negotiate_options(NBDClient *client, Error **errp)
1085 {
1086     uint32_t flags;
1087     bool fixedNewstyle = false;
1088     bool no_zeroes = false;
1089
1090     /* Client sends:
1091         [ 0 ..   3]   client flags
1092
1093        Then we loop until NBD_OPT_EXPORT_NAME or NBD_OPT_GO:
1094         [ 0 ..   7]   NBD_OPTS_MAGIC
1095         [ 8 ..  11]   NBD option
1096         [12 ..  15]   Data length
1097         ...           Rest of request
1098
1099         [ 0 ..   7]   NBD_OPTS_MAGIC
1100         [ 8 ..  11]   Second NBD option
1101         [12 ..  15]   Data length
1102         ...           Rest of request
1103     */
1104
1105     if (nbd_read32(client->ioc, &flags, "flags", errp) < 0) {
1106         return -EIO;
1107     }
1108     trace_nbd_negotiate_options_flags(flags);
1109     if (flags & NBD_FLAG_C_FIXED_NEWSTYLE) {
1110         fixedNewstyle = true;
1111         flags &= ~NBD_FLAG_C_FIXED_NEWSTYLE;
1112     }
1113     if (flags & NBD_FLAG_C_NO_ZEROES) {
1114         no_zeroes = true;
1115         flags &= ~NBD_FLAG_C_NO_ZEROES;
1116     }
1117     if (flags != 0) {
1118         error_setg(errp, "Unknown client flags 0x%" PRIx32 " received", flags);
1119         return -EINVAL;
1120     }
1121
1122     while (1) {
1123         int ret;
1124         uint32_t option, length;
1125         uint64_t magic;
1126
1127         if (nbd_read64(client->ioc, &magic, "opts magic", errp) < 0) {
1128             return -EINVAL;
1129         }
1130         trace_nbd_negotiate_options_check_magic(magic);
1131         if (magic != NBD_OPTS_MAGIC) {
1132             error_setg(errp, "Bad magic received");
1133             return -EINVAL;
1134         }
1135
1136         if (nbd_read32(client->ioc, &option, "option", errp) < 0) {
1137             return -EINVAL;
1138         }
1139         client->opt = option;
1140
1141         if (nbd_read32(client->ioc, &length, "option length", errp) < 0) {
1142             return -EINVAL;
1143         }
1144         assert(!client->optlen);
1145         client->optlen = length;
1146
1147         if (length > NBD_MAX_BUFFER_SIZE) {
1148             error_setg(errp, "len (%" PRIu32" ) is larger than max len (%u)",
1149                        length, NBD_MAX_BUFFER_SIZE);
1150             return -EINVAL;
1151         }
1152
1153         trace_nbd_negotiate_options_check_option(option,
1154                                                  nbd_opt_lookup(option));
1155         if (client->tlscreds &&
1156             client->ioc == (QIOChannel *)client->sioc) {
1157             QIOChannel *tioc;
1158             if (!fixedNewstyle) {
1159                 error_setg(errp, "Unsupported option 0x%" PRIx32, option);
1160                 return -EINVAL;
1161             }
1162             switch (option) {
1163             case NBD_OPT_STARTTLS:
1164                 if (length) {
1165                     /* Unconditionally drop the connection if the client
1166                      * can't start a TLS negotiation correctly */
1167                     return nbd_reject_length(client, true, errp);
1168                 }
1169                 tioc = nbd_negotiate_handle_starttls(client, errp);
1170                 if (!tioc) {
1171                     return -EIO;
1172                 }
1173                 ret = 0;
1174                 object_unref(OBJECT(client->ioc));
1175                 client->ioc = QIO_CHANNEL(tioc);
1176                 break;
1177
1178             case NBD_OPT_EXPORT_NAME:
1179                 /* No way to return an error to client, so drop connection */
1180                 error_setg(errp, "Option 0x%x not permitted before TLS",
1181                            option);
1182                 return -EINVAL;
1183
1184             default:
1185                 /* Let the client keep trying, unless they asked to
1186                  * quit. Always try to give an error back to the
1187                  * client; but when replying to OPT_ABORT, be aware
1188                  * that the client may hang up before receiving the
1189                  * error, in which case we are fine ignoring the
1190                  * resulting EPIPE. */
1191                 ret = nbd_opt_drop(client, NBD_REP_ERR_TLS_REQD,
1192                                    option == NBD_OPT_ABORT ? NULL : errp,
1193                                    "Option 0x%" PRIx32
1194                                    " not permitted before TLS", option);
1195                 if (option == NBD_OPT_ABORT) {
1196                     return 1;
1197                 }
1198                 break;
1199             }
1200         } else if (fixedNewstyle) {
1201             switch (option) {
1202             case NBD_OPT_LIST:
1203                 if (length) {
1204                     ret = nbd_reject_length(client, false, errp);
1205                 } else {
1206                     ret = nbd_negotiate_handle_list(client, errp);
1207                 }
1208                 break;
1209
1210             case NBD_OPT_ABORT:
1211                 /* NBD spec says we must try to reply before
1212                  * disconnecting, but that we must also tolerate
1213                  * guests that don't wait for our reply. */
1214                 nbd_negotiate_send_rep(client, NBD_REP_ACK, NULL);
1215                 return 1;
1216
1217             case NBD_OPT_EXPORT_NAME:
1218                 return nbd_negotiate_handle_export_name(client, no_zeroes,
1219                                                         errp);
1220
1221             case NBD_OPT_INFO:
1222             case NBD_OPT_GO:
1223                 ret = nbd_negotiate_handle_info(client, errp);
1224                 if (ret == 1) {
1225                     assert(option == NBD_OPT_GO);
1226                     return 0;
1227                 }
1228                 break;
1229
1230             case NBD_OPT_STARTTLS:
1231                 if (length) {
1232                     ret = nbd_reject_length(client, false, errp);
1233                 } else if (client->tlscreds) {
1234                     ret = nbd_negotiate_send_rep_err(client,
1235                                                      NBD_REP_ERR_INVALID, errp,
1236                                                      "TLS already enabled");
1237                 } else {
1238                     ret = nbd_negotiate_send_rep_err(client,
1239                                                      NBD_REP_ERR_POLICY, errp,
1240                                                      "TLS not configured");
1241                 }
1242                 break;
1243
1244             case NBD_OPT_STRUCTURED_REPLY:
1245                 if (length) {
1246                     ret = nbd_reject_length(client, false, errp);
1247                 } else if (client->structured_reply) {
1248                     ret = nbd_negotiate_send_rep_err(
1249                         client, NBD_REP_ERR_INVALID, errp,
1250                         "structured reply already negotiated");
1251                 } else {
1252                     ret = nbd_negotiate_send_rep(client, NBD_REP_ACK, errp);
1253                     client->structured_reply = true;
1254                 }
1255                 break;
1256
1257             case NBD_OPT_LIST_META_CONTEXT:
1258             case NBD_OPT_SET_META_CONTEXT:
1259                 ret = nbd_negotiate_meta_queries(client, &client->export_meta,
1260                                                  errp);
1261                 break;
1262
1263             default:
1264                 ret = nbd_opt_drop(client, NBD_REP_ERR_UNSUP, errp,
1265                                    "Unsupported option %" PRIu32 " (%s)",
1266                                    option, nbd_opt_lookup(option));
1267                 break;
1268             }
1269         } else {
1270             /*
1271              * If broken new-style we should drop the connection
1272              * for anything except NBD_OPT_EXPORT_NAME
1273              */
1274             switch (option) {
1275             case NBD_OPT_EXPORT_NAME:
1276                 return nbd_negotiate_handle_export_name(client, no_zeroes,
1277                                                         errp);
1278
1279             default:
1280                 error_setg(errp, "Unsupported option %" PRIu32 " (%s)",
1281                            option, nbd_opt_lookup(option));
1282                 return -EINVAL;
1283             }
1284         }
1285         if (ret < 0) {
1286             return ret;
1287         }
1288     }
1289 }
1290
1291 /* nbd_negotiate
1292  * Return:
1293  * -errno  on error, errp is set
1294  * 0       on successful negotiation, errp is not set
1295  * 1       if client sent NBD_OPT_ABORT, i.e. on valid disconnect,
1296  *         errp is not set
1297  */
1298 static coroutine_fn int nbd_negotiate(NBDClient *client, Error **errp)
1299 {
1300     ERRP_GUARD();
1301     char buf[NBD_OLDSTYLE_NEGOTIATE_SIZE] = "";
1302     int ret;
1303
1304     /* Old style negotiation header, no room for options
1305         [ 0 ..   7]   passwd       ("NBDMAGIC")
1306         [ 8 ..  15]   magic        (NBD_CLIENT_MAGIC)
1307         [16 ..  23]   size
1308         [24 ..  27]   export flags (zero-extended)
1309         [28 .. 151]   reserved     (0)
1310
1311        New style negotiation header, client can send options
1312         [ 0 ..   7]   passwd       ("NBDMAGIC")
1313         [ 8 ..  15]   magic        (NBD_OPTS_MAGIC)
1314         [16 ..  17]   server flags (0)
1315         ....options sent, ending in NBD_OPT_EXPORT_NAME or NBD_OPT_GO....
1316      */
1317
1318     qio_channel_set_blocking(client->ioc, false, NULL);
1319
1320     trace_nbd_negotiate_begin();
1321     memcpy(buf, "NBDMAGIC", 8);
1322
1323     stq_be_p(buf + 8, NBD_OPTS_MAGIC);
1324     stw_be_p(buf + 16, NBD_FLAG_FIXED_NEWSTYLE | NBD_FLAG_NO_ZEROES);
1325
1326     if (nbd_write(client->ioc, buf, 18, errp) < 0) {
1327         error_prepend(errp, "write failed: ");
1328         return -EINVAL;
1329     }
1330     ret = nbd_negotiate_options(client, errp);
1331     if (ret != 0) {
1332         if (ret < 0) {
1333             error_prepend(errp, "option negotiation failed: ");
1334         }
1335         return ret;
1336     }
1337
1338     /* Attach the channel to the same AioContext as the export */
1339     if (client->exp && client->exp->ctx) {
1340         qio_channel_attach_aio_context(client->ioc, client->exp->ctx);
1341     }
1342
1343     assert(!client->optlen);
1344     trace_nbd_negotiate_success();
1345
1346     return 0;
1347 }
1348
1349 static int nbd_receive_request(QIOChannel *ioc, NBDRequest *request,
1350                                Error **errp)
1351 {
1352     uint8_t buf[NBD_REQUEST_SIZE];
1353     uint32_t magic;
1354     int ret;
1355
1356     ret = nbd_read(ioc, buf, sizeof(buf), "request", errp);
1357     if (ret < 0) {
1358         return ret;
1359     }
1360
1361     /* Request
1362        [ 0 ..  3]   magic   (NBD_REQUEST_MAGIC)
1363        [ 4 ..  5]   flags   (NBD_CMD_FLAG_FUA, ...)
1364        [ 6 ..  7]   type    (NBD_CMD_READ, ...)
1365        [ 8 .. 15]   handle
1366        [16 .. 23]   from
1367        [24 .. 27]   len
1368      */
1369
1370     magic = ldl_be_p(buf);
1371     request->flags  = lduw_be_p(buf + 4);
1372     request->type   = lduw_be_p(buf + 6);
1373     request->handle = ldq_be_p(buf + 8);
1374     request->from   = ldq_be_p(buf + 16);
1375     request->len    = ldl_be_p(buf + 24);
1376
1377     trace_nbd_receive_request(magic, request->flags, request->type,
1378                               request->from, request->len);
1379
1380     if (magic != NBD_REQUEST_MAGIC) {
1381         error_setg(errp, "invalid magic (got 0x%" PRIx32 ")", magic);
1382         return -EINVAL;
1383     }
1384     return 0;
1385 }
1386
1387 #define MAX_NBD_REQUESTS 16
1388
1389 void nbd_client_get(NBDClient *client)
1390 {
1391     client->refcount++;
1392 }
1393
1394 void nbd_client_put(NBDClient *client)
1395 {
1396     if (--client->refcount == 0) {
1397         /* The last reference should be dropped by client->close,
1398          * which is called by client_close.
1399          */
1400         assert(client->closing);
1401
1402         qio_channel_detach_aio_context(client->ioc);
1403         object_unref(OBJECT(client->sioc));
1404         object_unref(OBJECT(client->ioc));
1405         if (client->tlscreds) {
1406             object_unref(OBJECT(client->tlscreds));
1407         }
1408         g_free(client->tlsauthz);
1409         if (client->exp) {
1410             QTAILQ_REMOVE(&client->exp->clients, client, next);
1411             nbd_export_put(client->exp);
1412         }
1413         g_free(client);
1414     }
1415 }
1416
1417 static void client_close(NBDClient *client, bool negotiated)
1418 {
1419     if (client->closing) {
1420         return;
1421     }
1422
1423     client->closing = true;
1424
1425     /* Force requests to finish.  They will drop their own references,
1426      * then we'll close the socket and free the NBDClient.
1427      */
1428     qio_channel_shutdown(client->ioc, QIO_CHANNEL_SHUTDOWN_BOTH,
1429                          NULL);
1430
1431     /* Also tell the client, so that they release their reference.  */
1432     if (client->close_fn) {
1433         client->close_fn(client, negotiated);
1434     }
1435 }
1436
1437 static NBDRequestData *nbd_request_get(NBDClient *client)
1438 {
1439     NBDRequestData *req;
1440
1441     assert(client->nb_requests <= MAX_NBD_REQUESTS - 1);
1442     client->nb_requests++;
1443
1444     req = g_new0(NBDRequestData, 1);
1445     nbd_client_get(client);
1446     req->client = client;
1447     return req;
1448 }
1449
1450 static void nbd_request_put(NBDRequestData *req)
1451 {
1452     NBDClient *client = req->client;
1453
1454     if (req->data) {
1455         qemu_vfree(req->data);
1456     }
1457     g_free(req);
1458
1459     client->nb_requests--;
1460     nbd_client_receive_next_request(client);
1461
1462     nbd_client_put(client);
1463 }
1464
1465 static void blk_aio_attached(AioContext *ctx, void *opaque)
1466 {
1467     NBDExport *exp = opaque;
1468     NBDClient *client;
1469
1470     trace_nbd_blk_aio_attached(exp->name, ctx);
1471
1472     exp->ctx = ctx;
1473
1474     QTAILQ_FOREACH(client, &exp->clients, next) {
1475         qio_channel_attach_aio_context(client->ioc, ctx);
1476         if (client->recv_coroutine) {
1477             aio_co_schedule(ctx, client->recv_coroutine);
1478         }
1479         if (client->send_coroutine) {
1480             aio_co_schedule(ctx, client->send_coroutine);
1481         }
1482     }
1483 }
1484
1485 static void blk_aio_detach(void *opaque)
1486 {
1487     NBDExport *exp = opaque;
1488     NBDClient *client;
1489
1490     trace_nbd_blk_aio_detach(exp->name, exp->ctx);
1491
1492     QTAILQ_FOREACH(client, &exp->clients, next) {
1493         qio_channel_detach_aio_context(client->ioc);
1494     }
1495
1496     exp->ctx = NULL;
1497 }
1498
1499 static void nbd_eject_notifier(Notifier *n, void *data)
1500 {
1501     NBDExport *exp = container_of(n, NBDExport, eject_notifier);
1502     AioContext *aio_context;
1503
1504     aio_context = exp->ctx;
1505     aio_context_acquire(aio_context);
1506     nbd_export_close(exp);
1507     aio_context_release(aio_context);
1508 }
1509
1510 NBDExport *nbd_export_new(BlockDriverState *bs, uint64_t dev_offset,
1511                           uint64_t size, const char *name, const char *desc,
1512                           const char *bitmap, bool readonly, bool shared,
1513                           void (*close)(NBDExport *), bool writethrough,
1514                           BlockBackend *on_eject_blk, Error **errp)
1515 {
1516     AioContext *ctx;
1517     BlockBackend *blk;
1518     NBDExport *exp;
1519     uint64_t perm;
1520     int ret;
1521
1522     exp = g_new0(NBDExport, 1);
1523     exp->common = (BlockExport) {
1524         .drv = &blk_exp_nbd,
1525     };
1526
1527     /*
1528      * NBD exports are used for non-shared storage migration.  Make sure
1529      * that BDRV_O_INACTIVE is cleared and the image is ready for write
1530      * access since the export could be available before migration handover.
1531      * ctx was acquired in the caller.
1532      */
1533     assert(name && strlen(name) <= NBD_MAX_STRING_SIZE);
1534     ctx = bdrv_get_aio_context(bs);
1535     bdrv_invalidate_cache(bs, NULL);
1536
1537     /* Don't allow resize while the NBD server is running, otherwise we don't
1538      * care what happens with the node. */
1539     perm = BLK_PERM_CONSISTENT_READ;
1540     if (!readonly) {
1541         perm |= BLK_PERM_WRITE;
1542     }
1543     blk = blk_new(ctx, perm,
1544                   BLK_PERM_CONSISTENT_READ | BLK_PERM_WRITE_UNCHANGED |
1545                   BLK_PERM_WRITE | BLK_PERM_GRAPH_MOD);
1546     ret = blk_insert_bs(blk, bs, errp);
1547     if (ret < 0) {
1548         goto fail;
1549     }
1550     blk_set_enable_write_cache(blk, !writethrough);
1551     blk_set_allow_aio_context_change(blk, true);
1552
1553     exp->refcount = 1;
1554     QTAILQ_INIT(&exp->clients);
1555     exp->blk = blk;
1556     assert(dev_offset <= INT64_MAX);
1557     exp->dev_offset = dev_offset;
1558     exp->name = g_strdup(name);
1559     assert(!desc || strlen(desc) <= NBD_MAX_STRING_SIZE);
1560     exp->description = g_strdup(desc);
1561     exp->nbdflags = (NBD_FLAG_HAS_FLAGS | NBD_FLAG_SEND_FLUSH |
1562                      NBD_FLAG_SEND_FUA | NBD_FLAG_SEND_CACHE);
1563     if (readonly) {
1564         exp->nbdflags |= NBD_FLAG_READ_ONLY;
1565         if (shared) {
1566             exp->nbdflags |= NBD_FLAG_CAN_MULTI_CONN;
1567         }
1568     } else {
1569         exp->nbdflags |= (NBD_FLAG_SEND_TRIM | NBD_FLAG_SEND_WRITE_ZEROES |
1570                           NBD_FLAG_SEND_FAST_ZERO);
1571     }
1572     assert(size <= INT64_MAX - dev_offset);
1573     exp->size = QEMU_ALIGN_DOWN(size, BDRV_SECTOR_SIZE);
1574
1575     if (bitmap) {
1576         BdrvDirtyBitmap *bm = NULL;
1577
1578         while (bs) {
1579             bm = bdrv_find_dirty_bitmap(bs, bitmap);
1580             if (bm != NULL) {
1581                 break;
1582             }
1583
1584             bs = bdrv_filter_or_cow_bs(bs);
1585         }
1586
1587         if (bm == NULL) {
1588             error_setg(errp, "Bitmap '%s' is not found", bitmap);
1589             goto fail;
1590         }
1591
1592         if (bdrv_dirty_bitmap_check(bm, BDRV_BITMAP_ALLOW_RO, errp)) {
1593             goto fail;
1594         }
1595
1596         if (readonly && bdrv_is_writable(bs) &&
1597             bdrv_dirty_bitmap_enabled(bm)) {
1598             error_setg(errp,
1599                        "Enabled bitmap '%s' incompatible with readonly export",
1600                        bitmap);
1601             goto fail;
1602         }
1603
1604         bdrv_dirty_bitmap_set_busy(bm, true);
1605         exp->export_bitmap = bm;
1606         assert(strlen(bitmap) <= BDRV_BITMAP_MAX_NAME_SIZE);
1607         exp->export_bitmap_context = g_strdup_printf("qemu:dirty-bitmap:%s",
1608                                                      bitmap);
1609         assert(strlen(exp->export_bitmap_context) < NBD_MAX_STRING_SIZE);
1610     }
1611
1612     exp->close = close;
1613     exp->ctx = ctx;
1614     blk_add_aio_context_notifier(blk, blk_aio_attached, blk_aio_detach, exp);
1615
1616     if (on_eject_blk) {
1617         blk_ref(on_eject_blk);
1618         exp->eject_notifier_blk = on_eject_blk;
1619         exp->eject_notifier.notify = nbd_eject_notifier;
1620         blk_add_remove_bs_notifier(on_eject_blk, &exp->eject_notifier);
1621     }
1622     QTAILQ_INSERT_TAIL(&exports, exp, next);
1623     nbd_export_get(exp);
1624     return exp;
1625
1626 fail:
1627     blk_unref(blk);
1628     g_free(exp->name);
1629     g_free(exp->description);
1630     g_free(exp);
1631     return NULL;
1632 }
1633
1634 NBDExport *nbd_export_find(const char *name)
1635 {
1636     NBDExport *exp;
1637     QTAILQ_FOREACH(exp, &exports, next) {
1638         if (strcmp(name, exp->name) == 0) {
1639             return exp;
1640         }
1641     }
1642
1643     return NULL;
1644 }
1645
1646 AioContext *
1647 nbd_export_aio_context(NBDExport *exp)
1648 {
1649     return exp->ctx;
1650 }
1651
1652 void nbd_export_close(NBDExport *exp)
1653 {
1654     NBDClient *client, *next;
1655
1656     nbd_export_get(exp);
1657     /*
1658      * TODO: Should we expand QMP NbdServerRemoveNode enum to allow a
1659      * close mode that stops advertising the export to new clients but
1660      * still permits existing clients to run to completion? Because of
1661      * that possibility, nbd_export_close() can be called more than
1662      * once on an export.
1663      */
1664     QTAILQ_FOREACH_SAFE(client, &exp->clients, next, next) {
1665         client_close(client, true);
1666     }
1667     if (exp->name) {
1668         nbd_export_put(exp);
1669         g_free(exp->name);
1670         exp->name = NULL;
1671         QTAILQ_REMOVE(&exports, exp, next);
1672         QTAILQ_INSERT_TAIL(&closed_exports, exp, next);
1673     }
1674     g_free(exp->description);
1675     exp->description = NULL;
1676     nbd_export_put(exp);
1677 }
1678
1679 void nbd_export_remove(NBDExport *exp, NbdServerRemoveMode mode, Error **errp)
1680 {
1681     ERRP_GUARD();
1682     if (mode == NBD_SERVER_REMOVE_MODE_HARD || QTAILQ_EMPTY(&exp->clients)) {
1683         nbd_export_close(exp);
1684         return;
1685     }
1686
1687     assert(mode == NBD_SERVER_REMOVE_MODE_SAFE);
1688
1689     error_setg(errp, "export '%s' still in use", exp->name);
1690     error_append_hint(errp, "Use mode='hard' to force client disconnect\n");
1691 }
1692
1693 void nbd_export_get(NBDExport *exp)
1694 {
1695     assert(exp->refcount > 0);
1696     exp->refcount++;
1697 }
1698
1699 void nbd_export_put(NBDExport *exp)
1700 {
1701     assert(exp->refcount > 0);
1702     if (exp->refcount == 1) {
1703         nbd_export_close(exp);
1704     }
1705
1706     /* nbd_export_close() may theoretically reduce refcount to 0. It may happen
1707      * if someone calls nbd_export_put() on named export not through
1708      * nbd_export_set_name() when refcount is 1. So, let's assert that
1709      * it is > 0.
1710      */
1711     assert(exp->refcount > 0);
1712     if (--exp->refcount == 0) {
1713         assert(exp->name == NULL);
1714         assert(exp->description == NULL);
1715
1716         if (exp->close) {
1717             exp->close(exp);
1718         }
1719
1720         if (exp->blk) {
1721             if (exp->eject_notifier_blk) {
1722                 notifier_remove(&exp->eject_notifier);
1723                 blk_unref(exp->eject_notifier_blk);
1724             }
1725             blk_remove_aio_context_notifier(exp->blk, blk_aio_attached,
1726                                             blk_aio_detach, exp);
1727             blk_unref(exp->blk);
1728             exp->blk = NULL;
1729         }
1730
1731         if (exp->export_bitmap) {
1732             bdrv_dirty_bitmap_set_busy(exp->export_bitmap, false);
1733             g_free(exp->export_bitmap_context);
1734         }
1735
1736         QTAILQ_REMOVE(&closed_exports, exp, next);
1737         g_free(exp);
1738         aio_wait_kick();
1739     }
1740 }
1741
1742 const BlockExportDriver blk_exp_nbd = {
1743     .type               = BLOCK_EXPORT_TYPE_NBD,
1744     .create             = nbd_export_create,
1745 };
1746
1747 void nbd_export_close_all(void)
1748 {
1749     NBDExport *exp, *next;
1750     AioContext *aio_context;
1751
1752     QTAILQ_FOREACH_SAFE(exp, &exports, next, next) {
1753         aio_context = exp->ctx;
1754         aio_context_acquire(aio_context);
1755         nbd_export_close(exp);
1756         aio_context_release(aio_context);
1757     }
1758
1759     AIO_WAIT_WHILE(NULL, !(QTAILQ_EMPTY(&exports) &&
1760                            QTAILQ_EMPTY(&closed_exports)));
1761 }
1762
1763 static int coroutine_fn nbd_co_send_iov(NBDClient *client, struct iovec *iov,
1764                                         unsigned niov, Error **errp)
1765 {
1766     int ret;
1767
1768     g_assert(qemu_in_coroutine());
1769     qemu_co_mutex_lock(&client->send_lock);
1770     client->send_coroutine = qemu_coroutine_self();
1771
1772     ret = qio_channel_writev_all(client->ioc, iov, niov, errp) < 0 ? -EIO : 0;
1773
1774     client->send_coroutine = NULL;
1775     qemu_co_mutex_unlock(&client->send_lock);
1776
1777     return ret;
1778 }
1779
1780 static inline void set_be_simple_reply(NBDSimpleReply *reply, uint64_t error,
1781                                        uint64_t handle)
1782 {
1783     stl_be_p(&reply->magic, NBD_SIMPLE_REPLY_MAGIC);
1784     stl_be_p(&reply->error, error);
1785     stq_be_p(&reply->handle, handle);
1786 }
1787
1788 static int nbd_co_send_simple_reply(NBDClient *client,
1789                                     uint64_t handle,
1790                                     uint32_t error,
1791                                     void *data,
1792                                     size_t len,
1793                                     Error **errp)
1794 {
1795     NBDSimpleReply reply;
1796     int nbd_err = system_errno_to_nbd_errno(error);
1797     struct iovec iov[] = {
1798         {.iov_base = &reply, .iov_len = sizeof(reply)},
1799         {.iov_base = data, .iov_len = len}
1800     };
1801
1802     trace_nbd_co_send_simple_reply(handle, nbd_err, nbd_err_lookup(nbd_err),
1803                                    len);
1804     set_be_simple_reply(&reply, nbd_err, handle);
1805
1806     return nbd_co_send_iov(client, iov, len ? 2 : 1, errp);
1807 }
1808
1809 static inline void set_be_chunk(NBDStructuredReplyChunk *chunk, uint16_t flags,
1810                                 uint16_t type, uint64_t handle, uint32_t length)
1811 {
1812     stl_be_p(&chunk->magic, NBD_STRUCTURED_REPLY_MAGIC);
1813     stw_be_p(&chunk->flags, flags);
1814     stw_be_p(&chunk->type, type);
1815     stq_be_p(&chunk->handle, handle);
1816     stl_be_p(&chunk->length, length);
1817 }
1818
1819 static int coroutine_fn nbd_co_send_structured_done(NBDClient *client,
1820                                                     uint64_t handle,
1821                                                     Error **errp)
1822 {
1823     NBDStructuredReplyChunk chunk;
1824     struct iovec iov[] = {
1825         {.iov_base = &chunk, .iov_len = sizeof(chunk)},
1826     };
1827
1828     trace_nbd_co_send_structured_done(handle);
1829     set_be_chunk(&chunk, NBD_REPLY_FLAG_DONE, NBD_REPLY_TYPE_NONE, handle, 0);
1830
1831     return nbd_co_send_iov(client, iov, 1, errp);
1832 }
1833
1834 static int coroutine_fn nbd_co_send_structured_read(NBDClient *client,
1835                                                     uint64_t handle,
1836                                                     uint64_t offset,
1837                                                     void *data,
1838                                                     size_t size,
1839                                                     bool final,
1840                                                     Error **errp)
1841 {
1842     NBDStructuredReadData chunk;
1843     struct iovec iov[] = {
1844         {.iov_base = &chunk, .iov_len = sizeof(chunk)},
1845         {.iov_base = data, .iov_len = size}
1846     };
1847
1848     assert(size);
1849     trace_nbd_co_send_structured_read(handle, offset, data, size);
1850     set_be_chunk(&chunk.h, final ? NBD_REPLY_FLAG_DONE : 0,
1851                  NBD_REPLY_TYPE_OFFSET_DATA, handle,
1852                  sizeof(chunk) - sizeof(chunk.h) + size);
1853     stq_be_p(&chunk.offset, offset);
1854
1855     return nbd_co_send_iov(client, iov, 2, errp);
1856 }
1857
1858 static int coroutine_fn nbd_co_send_structured_error(NBDClient *client,
1859                                                      uint64_t handle,
1860                                                      uint32_t error,
1861                                                      const char *msg,
1862                                                      Error **errp)
1863 {
1864     NBDStructuredError chunk;
1865     int nbd_err = system_errno_to_nbd_errno(error);
1866     struct iovec iov[] = {
1867         {.iov_base = &chunk, .iov_len = sizeof(chunk)},
1868         {.iov_base = (char *)msg, .iov_len = msg ? strlen(msg) : 0},
1869     };
1870
1871     assert(nbd_err);
1872     trace_nbd_co_send_structured_error(handle, nbd_err,
1873                                        nbd_err_lookup(nbd_err), msg ? msg : "");
1874     set_be_chunk(&chunk.h, NBD_REPLY_FLAG_DONE, NBD_REPLY_TYPE_ERROR, handle,
1875                  sizeof(chunk) - sizeof(chunk.h) + iov[1].iov_len);
1876     stl_be_p(&chunk.error, nbd_err);
1877     stw_be_p(&chunk.message_length, iov[1].iov_len);
1878
1879     return nbd_co_send_iov(client, iov, 1 + !!iov[1].iov_len, errp);
1880 }
1881
1882 /* Do a sparse read and send the structured reply to the client.
1883  * Returns -errno if sending fails. bdrv_block_status_above() failure is
1884  * reported to the client, at which point this function succeeds.
1885  */
1886 static int coroutine_fn nbd_co_send_sparse_read(NBDClient *client,
1887                                                 uint64_t handle,
1888                                                 uint64_t offset,
1889                                                 uint8_t *data,
1890                                                 size_t size,
1891                                                 Error **errp)
1892 {
1893     int ret = 0;
1894     NBDExport *exp = client->exp;
1895     size_t progress = 0;
1896
1897     while (progress < size) {
1898         int64_t pnum;
1899         int status = bdrv_block_status_above(blk_bs(exp->blk), NULL,
1900                                              offset + progress,
1901                                              size - progress, &pnum, NULL,
1902                                              NULL);
1903         bool final;
1904
1905         if (status < 0) {
1906             char *msg = g_strdup_printf("unable to check for holes: %s",
1907                                         strerror(-status));
1908
1909             ret = nbd_co_send_structured_error(client, handle, -status, msg,
1910                                                errp);
1911             g_free(msg);
1912             return ret;
1913         }
1914         assert(pnum && pnum <= size - progress);
1915         final = progress + pnum == size;
1916         if (status & BDRV_BLOCK_ZERO) {
1917             NBDStructuredReadHole chunk;
1918             struct iovec iov[] = {
1919                 {.iov_base = &chunk, .iov_len = sizeof(chunk)},
1920             };
1921
1922             trace_nbd_co_send_structured_read_hole(handle, offset + progress,
1923                                                    pnum);
1924             set_be_chunk(&chunk.h, final ? NBD_REPLY_FLAG_DONE : 0,
1925                          NBD_REPLY_TYPE_OFFSET_HOLE,
1926                          handle, sizeof(chunk) - sizeof(chunk.h));
1927             stq_be_p(&chunk.offset, offset + progress);
1928             stl_be_p(&chunk.length, pnum);
1929             ret = nbd_co_send_iov(client, iov, 1, errp);
1930         } else {
1931             ret = blk_pread(exp->blk, offset + progress + exp->dev_offset,
1932                             data + progress, pnum);
1933             if (ret < 0) {
1934                 error_setg_errno(errp, -ret, "reading from file failed");
1935                 break;
1936             }
1937             ret = nbd_co_send_structured_read(client, handle, offset + progress,
1938                                               data + progress, pnum, final,
1939                                               errp);
1940         }
1941
1942         if (ret < 0) {
1943             break;
1944         }
1945         progress += pnum;
1946     }
1947     return ret;
1948 }
1949
1950 typedef struct NBDExtentArray {
1951     NBDExtent *extents;
1952     unsigned int nb_alloc;
1953     unsigned int count;
1954     uint64_t total_length;
1955     bool can_add;
1956     bool converted_to_be;
1957 } NBDExtentArray;
1958
1959 static NBDExtentArray *nbd_extent_array_new(unsigned int nb_alloc)
1960 {
1961     NBDExtentArray *ea = g_new0(NBDExtentArray, 1);
1962
1963     ea->nb_alloc = nb_alloc;
1964     ea->extents = g_new(NBDExtent, nb_alloc);
1965     ea->can_add = true;
1966
1967     return ea;
1968 }
1969
1970 static void nbd_extent_array_free(NBDExtentArray *ea)
1971 {
1972     g_free(ea->extents);
1973     g_free(ea);
1974 }
1975 G_DEFINE_AUTOPTR_CLEANUP_FUNC(NBDExtentArray, nbd_extent_array_free);
1976
1977 /* Further modifications of the array after conversion are abandoned */
1978 static void nbd_extent_array_convert_to_be(NBDExtentArray *ea)
1979 {
1980     int i;
1981
1982     assert(!ea->converted_to_be);
1983     ea->can_add = false;
1984     ea->converted_to_be = true;
1985
1986     for (i = 0; i < ea->count; i++) {
1987         ea->extents[i].flags = cpu_to_be32(ea->extents[i].flags);
1988         ea->extents[i].length = cpu_to_be32(ea->extents[i].length);
1989     }
1990 }
1991
1992 /*
1993  * Add extent to NBDExtentArray. If extent can't be added (no available space),
1994  * return -1.
1995  * For safety, when returning -1 for the first time, .can_add is set to false,
1996  * further call to nbd_extent_array_add() will crash.
1997  * (to avoid the situation, when after failing to add an extent (returned -1),
1998  * user miss this failure and add another extent, which is successfully added
1999  * (array is full, but new extent may be squashed into the last one), then we
2000  * have invalid array with skipped extent)
2001  */
2002 static int nbd_extent_array_add(NBDExtentArray *ea,
2003                                 uint32_t length, uint32_t flags)
2004 {
2005     assert(ea->can_add);
2006
2007     if (!length) {
2008         return 0;
2009     }
2010
2011     /* Extend previous extent if flags are the same */
2012     if (ea->count > 0 && flags == ea->extents[ea->count - 1].flags) {
2013         uint64_t sum = (uint64_t)length + ea->extents[ea->count - 1].length;
2014
2015         if (sum <= UINT32_MAX) {
2016             ea->extents[ea->count - 1].length = sum;
2017             ea->total_length += length;
2018             return 0;
2019         }
2020     }
2021
2022     if (ea->count >= ea->nb_alloc) {
2023         ea->can_add = false;
2024         return -1;
2025     }
2026
2027     ea->total_length += length;
2028     ea->extents[ea->count] = (NBDExtent) {.length = length, .flags = flags};
2029     ea->count++;
2030
2031     return 0;
2032 }
2033
2034 static int blockstatus_to_extents(BlockDriverState *bs, uint64_t offset,
2035                                   uint64_t bytes, NBDExtentArray *ea)
2036 {
2037     while (bytes) {
2038         uint32_t flags;
2039         int64_t num;
2040         int ret = bdrv_block_status_above(bs, NULL, offset, bytes, &num,
2041                                           NULL, NULL);
2042
2043         if (ret < 0) {
2044             return ret;
2045         }
2046
2047         flags = (ret & BDRV_BLOCK_ALLOCATED ? 0 : NBD_STATE_HOLE) |
2048                 (ret & BDRV_BLOCK_ZERO      ? NBD_STATE_ZERO : 0);
2049
2050         if (nbd_extent_array_add(ea, num, flags) < 0) {
2051             return 0;
2052         }
2053
2054         offset += num;
2055         bytes -= num;
2056     }
2057
2058     return 0;
2059 }
2060
2061 /*
2062  * nbd_co_send_extents
2063  *
2064  * @ea is converted to BE by the function
2065  * @last controls whether NBD_REPLY_FLAG_DONE is sent.
2066  */
2067 static int nbd_co_send_extents(NBDClient *client, uint64_t handle,
2068                                NBDExtentArray *ea,
2069                                bool last, uint32_t context_id, Error **errp)
2070 {
2071     NBDStructuredMeta chunk;
2072     struct iovec iov[] = {
2073         {.iov_base = &chunk, .iov_len = sizeof(chunk)},
2074         {.iov_base = ea->extents, .iov_len = ea->count * sizeof(ea->extents[0])}
2075     };
2076
2077     nbd_extent_array_convert_to_be(ea);
2078
2079     trace_nbd_co_send_extents(handle, ea->count, context_id, ea->total_length,
2080                               last);
2081     set_be_chunk(&chunk.h, last ? NBD_REPLY_FLAG_DONE : 0,
2082                  NBD_REPLY_TYPE_BLOCK_STATUS,
2083                  handle, sizeof(chunk) - sizeof(chunk.h) + iov[1].iov_len);
2084     stl_be_p(&chunk.context_id, context_id);
2085
2086     return nbd_co_send_iov(client, iov, 2, errp);
2087 }
2088
2089 /* Get block status from the exported device and send it to the client */
2090 static int nbd_co_send_block_status(NBDClient *client, uint64_t handle,
2091                                     BlockDriverState *bs, uint64_t offset,
2092                                     uint32_t length, bool dont_fragment,
2093                                     bool last, uint32_t context_id,
2094                                     Error **errp)
2095 {
2096     int ret;
2097     unsigned int nb_extents = dont_fragment ? 1 : NBD_MAX_BLOCK_STATUS_EXTENTS;
2098     g_autoptr(NBDExtentArray) ea = nbd_extent_array_new(nb_extents);
2099
2100     ret = blockstatus_to_extents(bs, offset, length, ea);
2101     if (ret < 0) {
2102         return nbd_co_send_structured_error(
2103                 client, handle, -ret, "can't get block status", errp);
2104     }
2105
2106     return nbd_co_send_extents(client, handle, ea, last, context_id, errp);
2107 }
2108
2109 /* Populate @ea from a dirty bitmap. */
2110 static void bitmap_to_extents(BdrvDirtyBitmap *bitmap,
2111                               uint64_t offset, uint64_t length,
2112                               NBDExtentArray *es)
2113 {
2114     int64_t start, dirty_start, dirty_count;
2115     int64_t end = offset + length;
2116     bool full = false;
2117
2118     bdrv_dirty_bitmap_lock(bitmap);
2119
2120     for (start = offset;
2121          bdrv_dirty_bitmap_next_dirty_area(bitmap, start, end, INT32_MAX,
2122                                            &dirty_start, &dirty_count);
2123          start = dirty_start + dirty_count)
2124     {
2125         if ((nbd_extent_array_add(es, dirty_start - start, 0) < 0) ||
2126             (nbd_extent_array_add(es, dirty_count, NBD_STATE_DIRTY) < 0))
2127         {
2128             full = true;
2129             break;
2130         }
2131     }
2132
2133     if (!full) {
2134         /* last non dirty extent */
2135         nbd_extent_array_add(es, end - start, 0);
2136     }
2137
2138     bdrv_dirty_bitmap_unlock(bitmap);
2139 }
2140
2141 static int nbd_co_send_bitmap(NBDClient *client, uint64_t handle,
2142                               BdrvDirtyBitmap *bitmap, uint64_t offset,
2143                               uint32_t length, bool dont_fragment, bool last,
2144                               uint32_t context_id, Error **errp)
2145 {
2146     unsigned int nb_extents = dont_fragment ? 1 : NBD_MAX_BLOCK_STATUS_EXTENTS;
2147     g_autoptr(NBDExtentArray) ea = nbd_extent_array_new(nb_extents);
2148
2149     bitmap_to_extents(bitmap, offset, length, ea);
2150
2151     return nbd_co_send_extents(client, handle, ea, last, context_id, errp);
2152 }
2153
2154 /* nbd_co_receive_request
2155  * Collect a client request. Return 0 if request looks valid, -EIO to drop
2156  * connection right away, and any other negative value to report an error to
2157  * the client (although the caller may still need to disconnect after reporting
2158  * the error).
2159  */
2160 static int nbd_co_receive_request(NBDRequestData *req, NBDRequest *request,
2161                                   Error **errp)
2162 {
2163     NBDClient *client = req->client;
2164     int valid_flags;
2165
2166     g_assert(qemu_in_coroutine());
2167     assert(client->recv_coroutine == qemu_coroutine_self());
2168     if (nbd_receive_request(client->ioc, request, errp) < 0) {
2169         return -EIO;
2170     }
2171
2172     trace_nbd_co_receive_request_decode_type(request->handle, request->type,
2173                                              nbd_cmd_lookup(request->type));
2174
2175     if (request->type != NBD_CMD_WRITE) {
2176         /* No payload, we are ready to read the next request.  */
2177         req->complete = true;
2178     }
2179
2180     if (request->type == NBD_CMD_DISC) {
2181         /* Special case: we're going to disconnect without a reply,
2182          * whether or not flags, from, or len are bogus */
2183         return -EIO;
2184     }
2185
2186     if (request->type == NBD_CMD_READ || request->type == NBD_CMD_WRITE ||
2187         request->type == NBD_CMD_CACHE)
2188     {
2189         if (request->len > NBD_MAX_BUFFER_SIZE) {
2190             error_setg(errp, "len (%" PRIu32" ) is larger than max len (%u)",
2191                        request->len, NBD_MAX_BUFFER_SIZE);
2192             return -EINVAL;
2193         }
2194
2195         if (request->type != NBD_CMD_CACHE) {
2196             req->data = blk_try_blockalign(client->exp->blk, request->len);
2197             if (req->data == NULL) {
2198                 error_setg(errp, "No memory");
2199                 return -ENOMEM;
2200             }
2201         }
2202     }
2203
2204     if (request->type == NBD_CMD_WRITE) {
2205         if (nbd_read(client->ioc, req->data, request->len, "CMD_WRITE data",
2206                      errp) < 0)
2207         {
2208             return -EIO;
2209         }
2210         req->complete = true;
2211
2212         trace_nbd_co_receive_request_payload_received(request->handle,
2213                                                       request->len);
2214     }
2215
2216     /* Sanity checks. */
2217     if (client->exp->nbdflags & NBD_FLAG_READ_ONLY &&
2218         (request->type == NBD_CMD_WRITE ||
2219          request->type == NBD_CMD_WRITE_ZEROES ||
2220          request->type == NBD_CMD_TRIM)) {
2221         error_setg(errp, "Export is read-only");
2222         return -EROFS;
2223     }
2224     if (request->from > client->exp->size ||
2225         request->len > client->exp->size - request->from) {
2226         error_setg(errp, "operation past EOF; From: %" PRIu64 ", Len: %" PRIu32
2227                    ", Size: %" PRIu64, request->from, request->len,
2228                    client->exp->size);
2229         return (request->type == NBD_CMD_WRITE ||
2230                 request->type == NBD_CMD_WRITE_ZEROES) ? -ENOSPC : -EINVAL;
2231     }
2232     if (client->check_align && !QEMU_IS_ALIGNED(request->from | request->len,
2233                                                 client->check_align)) {
2234         /*
2235          * The block layer gracefully handles unaligned requests, but
2236          * it's still worth tracing client non-compliance
2237          */
2238         trace_nbd_co_receive_align_compliance(nbd_cmd_lookup(request->type),
2239                                               request->from,
2240                                               request->len,
2241                                               client->check_align);
2242     }
2243     valid_flags = NBD_CMD_FLAG_FUA;
2244     if (request->type == NBD_CMD_READ && client->structured_reply) {
2245         valid_flags |= NBD_CMD_FLAG_DF;
2246     } else if (request->type == NBD_CMD_WRITE_ZEROES) {
2247         valid_flags |= NBD_CMD_FLAG_NO_HOLE | NBD_CMD_FLAG_FAST_ZERO;
2248     } else if (request->type == NBD_CMD_BLOCK_STATUS) {
2249         valid_flags |= NBD_CMD_FLAG_REQ_ONE;
2250     }
2251     if (request->flags & ~valid_flags) {
2252         error_setg(errp, "unsupported flags for command %s (got 0x%x)",
2253                    nbd_cmd_lookup(request->type), request->flags);
2254         return -EINVAL;
2255     }
2256
2257     return 0;
2258 }
2259
2260 /* Send simple reply without a payload, or a structured error
2261  * @error_msg is ignored if @ret >= 0
2262  * Returns 0 if connection is still live, -errno on failure to talk to client
2263  */
2264 static coroutine_fn int nbd_send_generic_reply(NBDClient *client,
2265                                                uint64_t handle,
2266                                                int ret,
2267                                                const char *error_msg,
2268                                                Error **errp)
2269 {
2270     if (client->structured_reply && ret < 0) {
2271         return nbd_co_send_structured_error(client, handle, -ret, error_msg,
2272                                             errp);
2273     } else {
2274         return nbd_co_send_simple_reply(client, handle, ret < 0 ? -ret : 0,
2275                                         NULL, 0, errp);
2276     }
2277 }
2278
2279 /* Handle NBD_CMD_READ request.
2280  * Return -errno if sending fails. Other errors are reported directly to the
2281  * client as an error reply. */
2282 static coroutine_fn int nbd_do_cmd_read(NBDClient *client, NBDRequest *request,
2283                                         uint8_t *data, Error **errp)
2284 {
2285     int ret;
2286     NBDExport *exp = client->exp;
2287
2288     assert(request->type == NBD_CMD_READ);
2289
2290     /* XXX: NBD Protocol only documents use of FUA with WRITE */
2291     if (request->flags & NBD_CMD_FLAG_FUA) {
2292         ret = blk_co_flush(exp->blk);
2293         if (ret < 0) {
2294             return nbd_send_generic_reply(client, request->handle, ret,
2295                                           "flush failed", errp);
2296         }
2297     }
2298
2299     if (client->structured_reply && !(request->flags & NBD_CMD_FLAG_DF) &&
2300         request->len)
2301     {
2302         return nbd_co_send_sparse_read(client, request->handle, request->from,
2303                                        data, request->len, errp);
2304     }
2305
2306     ret = blk_pread(exp->blk, request->from + exp->dev_offset, data,
2307                     request->len);
2308     if (ret < 0) {
2309         return nbd_send_generic_reply(client, request->handle, ret,
2310                                       "reading from file failed", errp);
2311     }
2312
2313     if (client->structured_reply) {
2314         if (request->len) {
2315             return nbd_co_send_structured_read(client, request->handle,
2316                                                request->from, data,
2317                                                request->len, true, errp);
2318         } else {
2319             return nbd_co_send_structured_done(client, request->handle, errp);
2320         }
2321     } else {
2322         return nbd_co_send_simple_reply(client, request->handle, 0,
2323                                         data, request->len, errp);
2324     }
2325 }
2326
2327 /*
2328  * nbd_do_cmd_cache
2329  *
2330  * Handle NBD_CMD_CACHE request.
2331  * Return -errno if sending fails. Other errors are reported directly to the
2332  * client as an error reply.
2333  */
2334 static coroutine_fn int nbd_do_cmd_cache(NBDClient *client, NBDRequest *request,
2335                                          Error **errp)
2336 {
2337     int ret;
2338     NBDExport *exp = client->exp;
2339
2340     assert(request->type == NBD_CMD_CACHE);
2341
2342     ret = blk_co_preadv(exp->blk, request->from + exp->dev_offset, request->len,
2343                         NULL, BDRV_REQ_COPY_ON_READ | BDRV_REQ_PREFETCH);
2344
2345     return nbd_send_generic_reply(client, request->handle, ret,
2346                                   "caching data failed", errp);
2347 }
2348
2349 /* Handle NBD request.
2350  * Return -errno if sending fails. Other errors are reported directly to the
2351  * client as an error reply. */
2352 static coroutine_fn int nbd_handle_request(NBDClient *client,
2353                                            NBDRequest *request,
2354                                            uint8_t *data, Error **errp)
2355 {
2356     int ret;
2357     int flags;
2358     NBDExport *exp = client->exp;
2359     char *msg;
2360
2361     switch (request->type) {
2362     case NBD_CMD_CACHE:
2363         return nbd_do_cmd_cache(client, request, errp);
2364
2365     case NBD_CMD_READ:
2366         return nbd_do_cmd_read(client, request, data, errp);
2367
2368     case NBD_CMD_WRITE:
2369         flags = 0;
2370         if (request->flags & NBD_CMD_FLAG_FUA) {
2371             flags |= BDRV_REQ_FUA;
2372         }
2373         ret = blk_pwrite(exp->blk, request->from + exp->dev_offset,
2374                          data, request->len, flags);
2375         return nbd_send_generic_reply(client, request->handle, ret,
2376                                       "writing to file failed", errp);
2377
2378     case NBD_CMD_WRITE_ZEROES:
2379         flags = 0;
2380         if (request->flags & NBD_CMD_FLAG_FUA) {
2381             flags |= BDRV_REQ_FUA;
2382         }
2383         if (!(request->flags & NBD_CMD_FLAG_NO_HOLE)) {
2384             flags |= BDRV_REQ_MAY_UNMAP;
2385         }
2386         if (request->flags & NBD_CMD_FLAG_FAST_ZERO) {
2387             flags |= BDRV_REQ_NO_FALLBACK;
2388         }
2389         ret = 0;
2390         /* FIXME simplify this when blk_pwrite_zeroes switches to 64-bit */
2391         while (ret >= 0 && request->len) {
2392             int align = client->check_align ?: 1;
2393             int len = MIN(request->len, QEMU_ALIGN_DOWN(BDRV_REQUEST_MAX_BYTES,
2394                                                         align));
2395             ret = blk_pwrite_zeroes(exp->blk, request->from + exp->dev_offset,
2396                                     len, flags);
2397             request->len -= len;
2398             request->from += len;
2399         }
2400         return nbd_send_generic_reply(client, request->handle, ret,
2401                                       "writing to file failed", errp);
2402
2403     case NBD_CMD_DISC:
2404         /* unreachable, thanks to special case in nbd_co_receive_request() */
2405         abort();
2406
2407     case NBD_CMD_FLUSH:
2408         ret = blk_co_flush(exp->blk);
2409         return nbd_send_generic_reply(client, request->handle, ret,
2410                                       "flush failed", errp);
2411
2412     case NBD_CMD_TRIM:
2413         ret = 0;
2414         /* FIXME simplify this when blk_co_pdiscard switches to 64-bit */
2415         while (ret >= 0 && request->len) {
2416             int align = client->check_align ?: 1;
2417             int len = MIN(request->len, QEMU_ALIGN_DOWN(BDRV_REQUEST_MAX_BYTES,
2418                                                         align));
2419             ret = blk_co_pdiscard(exp->blk, request->from + exp->dev_offset,
2420                                   len);
2421             request->len -= len;
2422             request->from += len;
2423         }
2424         if (ret >= 0 && request->flags & NBD_CMD_FLAG_FUA) {
2425             ret = blk_co_flush(exp->blk);
2426         }
2427         return nbd_send_generic_reply(client, request->handle, ret,
2428                                       "discard failed", errp);
2429
2430     case NBD_CMD_BLOCK_STATUS:
2431         if (!request->len) {
2432             return nbd_send_generic_reply(client, request->handle, -EINVAL,
2433                                           "need non-zero length", errp);
2434         }
2435         if (client->export_meta.valid &&
2436             (client->export_meta.base_allocation ||
2437              client->export_meta.bitmap))
2438         {
2439             bool dont_fragment = request->flags & NBD_CMD_FLAG_REQ_ONE;
2440
2441             if (client->export_meta.base_allocation) {
2442                 ret = nbd_co_send_block_status(client, request->handle,
2443                                                blk_bs(exp->blk), request->from,
2444                                                request->len, dont_fragment,
2445                                                !client->export_meta.bitmap,
2446                                                NBD_META_ID_BASE_ALLOCATION,
2447                                                errp);
2448                 if (ret < 0) {
2449                     return ret;
2450                 }
2451             }
2452
2453             if (client->export_meta.bitmap) {
2454                 ret = nbd_co_send_bitmap(client, request->handle,
2455                                          client->exp->export_bitmap,
2456                                          request->from, request->len,
2457                                          dont_fragment,
2458                                          true, NBD_META_ID_DIRTY_BITMAP, errp);
2459                 if (ret < 0) {
2460                     return ret;
2461                 }
2462             }
2463
2464             return 0;
2465         } else {
2466             return nbd_send_generic_reply(client, request->handle, -EINVAL,
2467                                           "CMD_BLOCK_STATUS not negotiated",
2468                                           errp);
2469         }
2470
2471     default:
2472         msg = g_strdup_printf("invalid request type (%" PRIu32 ") received",
2473                               request->type);
2474         ret = nbd_send_generic_reply(client, request->handle, -EINVAL, msg,
2475                                      errp);
2476         g_free(msg);
2477         return ret;
2478     }
2479 }
2480
2481 /* Owns a reference to the NBDClient passed as opaque.  */
2482 static coroutine_fn void nbd_trip(void *opaque)
2483 {
2484     NBDClient *client = opaque;
2485     NBDRequestData *req;
2486     NBDRequest request = { 0 };    /* GCC thinks it can be used uninitialized */
2487     int ret;
2488     Error *local_err = NULL;
2489
2490     trace_nbd_trip();
2491     if (client->closing) {
2492         nbd_client_put(client);
2493         return;
2494     }
2495
2496     req = nbd_request_get(client);
2497     ret = nbd_co_receive_request(req, &request, &local_err);
2498     client->recv_coroutine = NULL;
2499
2500     if (client->closing) {
2501         /*
2502          * The client may be closed when we are blocked in
2503          * nbd_co_receive_request()
2504          */
2505         goto done;
2506     }
2507
2508     nbd_client_receive_next_request(client);
2509     if (ret == -EIO) {
2510         goto disconnect;
2511     }
2512
2513     if (ret < 0) {
2514         /* It wans't -EIO, so, according to nbd_co_receive_request()
2515          * semantics, we should return the error to the client. */
2516         Error *export_err = local_err;
2517
2518         local_err = NULL;
2519         ret = nbd_send_generic_reply(client, request.handle, -EINVAL,
2520                                      error_get_pretty(export_err), &local_err);
2521         error_free(export_err);
2522     } else {
2523         ret = nbd_handle_request(client, &request, req->data, &local_err);
2524     }
2525     if (ret < 0) {
2526         error_prepend(&local_err, "Failed to send reply: ");
2527         goto disconnect;
2528     }
2529
2530     /* We must disconnect after NBD_CMD_WRITE if we did not
2531      * read the payload.
2532      */
2533     if (!req->complete) {
2534         error_setg(&local_err, "Request handling failed in intermediate state");
2535         goto disconnect;
2536     }
2537
2538 done:
2539     nbd_request_put(req);
2540     nbd_client_put(client);
2541     return;
2542
2543 disconnect:
2544     if (local_err) {
2545         error_reportf_err(local_err, "Disconnect client, due to: ");
2546     }
2547     nbd_request_put(req);
2548     client_close(client, true);
2549     nbd_client_put(client);
2550 }
2551
2552 static void nbd_client_receive_next_request(NBDClient *client)
2553 {
2554     if (!client->recv_coroutine && client->nb_requests < MAX_NBD_REQUESTS) {
2555         nbd_client_get(client);
2556         client->recv_coroutine = qemu_coroutine_create(nbd_trip, client);
2557         aio_co_schedule(client->exp->ctx, client->recv_coroutine);
2558     }
2559 }
2560
2561 static coroutine_fn void nbd_co_client_start(void *opaque)
2562 {
2563     NBDClient *client = opaque;
2564     Error *local_err = NULL;
2565
2566     qemu_co_mutex_init(&client->send_lock);
2567
2568     if (nbd_negotiate(client, &local_err)) {
2569         if (local_err) {
2570             error_report_err(local_err);
2571         }
2572         client_close(client, false);
2573         return;
2574     }
2575
2576     nbd_client_receive_next_request(client);
2577 }
2578
2579 /*
2580  * Create a new client listener using the given channel @sioc.
2581  * Begin servicing it in a coroutine.  When the connection closes, call
2582  * @close_fn with an indication of whether the client completed negotiation.
2583  */
2584 void nbd_client_new(QIOChannelSocket *sioc,
2585                     QCryptoTLSCreds *tlscreds,
2586                     const char *tlsauthz,
2587                     void (*close_fn)(NBDClient *, bool))
2588 {
2589     NBDClient *client;
2590     Coroutine *co;
2591
2592     client = g_new0(NBDClient, 1);
2593     client->refcount = 1;
2594     client->tlscreds = tlscreds;
2595     if (tlscreds) {
2596         object_ref(OBJECT(client->tlscreds));
2597     }
2598     client->tlsauthz = g_strdup(tlsauthz);
2599     client->sioc = sioc;
2600     object_ref(OBJECT(client->sioc));
2601     client->ioc = QIO_CHANNEL(sioc);
2602     object_ref(OBJECT(client->ioc));
2603     client->close_fn = close_fn;
2604
2605     co = qemu_coroutine_create(nbd_co_client_start, client);
2606     qemu_coroutine_enter(co);
2607 }