migration/qemu-file.c

   1 /*
   2  * QEMU System Emulator
   3  *
   4  * Copyright (c) 2003-2008 Fabrice Bellard
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24 #include "qemu/osdep.h"
  25 #include <zlib.h>
  26 #include "qemu/madvise.h"
  27 #include "qemu/error-report.h"
  28 #include "qemu/iov.h"
  29 #include "migration.h"
  30 #include "qemu-file.h"
  31 #include "trace.h"
  32 #include "qapi/error.h"
  33
  34 #define IO_BUF_SIZE 32768
  35 #define MAX_IOV_SIZE MIN_CONST(IOV_MAX, 64)
  36
  37 struct QEMUFile {
  38     const QEMUFileOps *ops;
  39     const QEMUFileHooks *hooks;
  40     QIOChannel *ioc;
  41     bool is_writable;
  42
  43     /*
  44      * Maximum amount of data in bytes to transfer during one
  45      * rate limiting time window
  46      */
  47     int64_t rate_limit_max;
  48     /*
  49      * Total amount of data in bytes queued for transfer
  50      * during this rate limiting time window
  51      */
  52     int64_t rate_limit_used;
  53
  54     /* The sum of bytes transferred on the wire */
  55     int64_t total_transferred;
  56
  57     int buf_index;
  58     int buf_size; /* 0 when writing */
  59     uint8_t buf[IO_BUF_SIZE];
  60
  61     DECLARE_BITMAP(may_free, MAX_IOV_SIZE);
  62     struct iovec iov[MAX_IOV_SIZE];
  63     unsigned int iovcnt;
  64
  65     int last_error;
  66     Error *last_error_obj;
  67     /* has the file has been shutdown */
  68     bool shutdown;
  69 };
  70
  71 /*
  72  * Stop a file from being read/written - not all backing files can do this
  73  * typically only sockets can.
  74  *
  75  * TODO: convert to propagate Error objects instead of squashing
  76  * to a fixed errno value
  77  */
  78 int qemu_file_shutdown(QEMUFile *f)
  79 {
  80     int ret = 0;
  81
  82     f->shutdown = true;
  83     if (!qio_channel_has_feature(f->ioc,
  84                                  QIO_CHANNEL_FEATURE_SHUTDOWN)) {
  85         return -ENOSYS;
  86     }
  87
  88     if (qio_channel_shutdown(f->ioc, QIO_CHANNEL_SHUTDOWN_BOTH, NULL) < 0) {
  89         ret = -EIO;
  90     }
  91
  92     if (!f->last_error) {
  93         qemu_file_set_error(f, -EIO);
  94     }
  95     return ret;
  96 }
  97
  98 /*
  99  * Result: QEMUFile* for a 'return path' for comms in the opposite direction
 100  *         NULL if not available
 101  */
 102 QEMUFile *qemu_file_get_return_path(QEMUFile *f)
 103 {
 104     if (!f->ops->get_return_path) {
 105         return NULL;
 106     }
 107     return f->ops->get_return_path(f->ioc);
 108 }
 109
 110 bool qemu_file_mode_is_not_valid(const char *mode)
 111 {
 112     if (mode == NULL ||
 113         (mode[0] != 'r' && mode[0] != 'w') ||
 114         mode[1] != 'b' || mode[2] != 0) {
 115         fprintf(stderr, "qemu_fopen: Argument validity check failed\n");
 116         return true;
 117     }
 118
 119     return false;
 120 }
 121
 122 static QEMUFile *qemu_file_new_impl(QIOChannel *ioc,
 123                                     const QEMUFileOps *ops,
 124                                     bool is_writable)
 125 {
 126     QEMUFile *f;
 127
 128     f = g_new0(QEMUFile, 1);
 129
 130     f->ioc = ioc;
 131     f->ops = ops;
 132     f->is_writable = is_writable;
 133
 134     return f;
 135 }
 136
 137 QEMUFile *qemu_file_new_output(QIOChannel *ioc, const QEMUFileOps *ops)
 138 {
 139     return qemu_file_new_impl(ioc, ops, true);
 140 }
 141
 142 QEMUFile *qemu_file_new_input(QIOChannel *ioc, const QEMUFileOps *ops)
 143 {
 144     return qemu_file_new_impl(ioc, ops, false);
 145 }
 146
 147
 148 void qemu_file_set_hooks(QEMUFile *f, const QEMUFileHooks *hooks)
 149 {
 150     f->hooks = hooks;
 151 }
 152
 153 /*
 154  * Get last error for stream f with optional Error*
 155  *
 156  * Return negative error value if there has been an error on previous
 157  * operations, return 0 if no error happened.
 158  * Optional, it returns Error* in errp, but it may be NULL even if return value
 159  * is not 0.
 160  *
 161  */
 162 int qemu_file_get_error_obj(QEMUFile *f, Error **errp)
 163 {
 164     if (errp) {
 165         *errp = f->last_error_obj ? error_copy(f->last_error_obj) : NULL;
 166     }
 167     return f->last_error;
 168 }
 169
 170 /*
 171  * Set the last error for stream f with optional Error*
 172  */
 173 void qemu_file_set_error_obj(QEMUFile *f, int ret, Error *err)
 174 {
 175     if (f->last_error == 0 && ret) {
 176         f->last_error = ret;
 177         error_propagate(&f->last_error_obj, err);
 178     } else if (err) {
 179         error_report_err(err);
 180     }
 181 }
 182
 183 /*
 184  * Get last error for stream f
 185  *
 186  * Return negative error value if there has been an error on previous
 187  * operations, return 0 if no error happened.
 188  *
 189  */
 190 int qemu_file_get_error(QEMUFile *f)
 191 {
 192     return qemu_file_get_error_obj(f, NULL);
 193 }
 194
 195 /*
 196  * Set the last error for stream f
 197  */
 198 void qemu_file_set_error(QEMUFile *f, int ret)
 199 {
 200     qemu_file_set_error_obj(f, ret, NULL);
 201 }
 202
 203 bool qemu_file_is_writable(QEMUFile *f)
 204 {
 205     return f->is_writable;
 206 }
 207
 208 static void qemu_iovec_release_ram(QEMUFile *f)
 209 {
 210     struct iovec iov;
 211     unsigned long idx;
 212
 213     /* Find and release all the contiguous memory ranges marked as may_free. */
 214     idx = find_next_bit(f->may_free, f->iovcnt, 0);
 215     if (idx >= f->iovcnt) {
 216         return;
 217     }
 218     iov = f->iov[idx];
 219
 220     /* The madvise() in the loop is called for iov within a continuous range and
 221      * then reinitialize the iov. And in the end, madvise() is called for the
 222      * last iov.
 223      */
 224     while ((idx = find_next_bit(f->may_free, f->iovcnt, idx + 1)) < f->iovcnt) {
 225         /* check for adjacent buffer and coalesce them */
 226         if (iov.iov_base + iov.iov_len == f->iov[idx].iov_base) {
 227             iov.iov_len += f->iov[idx].iov_len;
 228             continue;
 229         }
 230         if (qemu_madvise(iov.iov_base, iov.iov_len, QEMU_MADV_DONTNEED) < 0) {
 231             error_report("migrate: madvise DONTNEED failed %p %zd: %s",
 232                          iov.iov_base, iov.iov_len, strerror(errno));
 233         }
 234         iov = f->iov[idx];
 235     }
 236     if (qemu_madvise(iov.iov_base, iov.iov_len, QEMU_MADV_DONTNEED) < 0) {
 237             error_report("migrate: madvise DONTNEED failed %p %zd: %s",
 238                          iov.iov_base, iov.iov_len, strerror(errno));
 239     }
 240     memset(f->may_free, 0, sizeof(f->may_free));
 241 }
 242
 243 /**
 244  * Flushes QEMUFile buffer
 245  *
 246  * This will flush all pending data. If data was only partially flushed, it
 247  * will set an error state.
 248  */
 249 void qemu_fflush(QEMUFile *f)
 250 {
 251     ssize_t ret = 0;
 252     ssize_t expect = 0;
 253     Error *local_error = NULL;
 254
 255     if (!qemu_file_is_writable(f)) {
 256         return;
 257     }
 258
 259     if (f->shutdown) {
 260         return;
 261     }
 262     if (f->iovcnt > 0) {
 263         expect = iov_size(f->iov, f->iovcnt);
 264         ret = f->ops->writev_buffer(f->ioc, f->iov, f->iovcnt,
 265                                     f->total_transferred, &local_error);
 266
 267         qemu_iovec_release_ram(f);
 268     }
 269
 270     if (ret >= 0) {
 271         f->total_transferred += ret;
 272     }
 273     /* We expect the QEMUFile write impl to send the full
 274      * data set we requested, so sanity check that.
 275      */
 276     if (ret != expect) {
 277         qemu_file_set_error_obj(f, ret < 0 ? ret : -EIO, local_error);
 278     }
 279     f->buf_index = 0;
 280     f->iovcnt = 0;
 281 }
 282
 283 void ram_control_before_iterate(QEMUFile *f, uint64_t flags)
 284 {
 285     int ret = 0;
 286
 287     if (f->hooks && f->hooks->before_ram_iterate) {
 288         ret = f->hooks->before_ram_iterate(f, flags, NULL);
 289         if (ret < 0) {
 290             qemu_file_set_error(f, ret);
 291         }
 292     }
 293 }
 294
 295 void ram_control_after_iterate(QEMUFile *f, uint64_t flags)
 296 {
 297     int ret = 0;
 298
 299     if (f->hooks && f->hooks->after_ram_iterate) {
 300         ret = f->hooks->after_ram_iterate(f, flags, NULL);
 301         if (ret < 0) {
 302             qemu_file_set_error(f, ret);
 303         }
 304     }
 305 }
 306
 307 void ram_control_load_hook(QEMUFile *f, uint64_t flags, void *data)
 308 {
 309     int ret = -EINVAL;
 310
 311     if (f->hooks && f->hooks->hook_ram_load) {
 312         ret = f->hooks->hook_ram_load(f, flags, data);
 313         if (ret < 0) {
 314             qemu_file_set_error(f, ret);
 315         }
 316     } else {
 317         /*
 318          * Hook is a hook specifically requested by the source sending a flag
 319          * that expects there to be a hook on the destination.
 320          */
 321         if (flags == RAM_CONTROL_HOOK) {
 322             qemu_file_set_error(f, ret);
 323         }
 324     }
 325 }
 326
 327 size_t ram_control_save_page(QEMUFile *f, ram_addr_t block_offset,
 328                              ram_addr_t offset, size_t size,
 329                              uint64_t *bytes_sent)
 330 {
 331     if (f->hooks && f->hooks->save_page) {
 332         int ret = f->hooks->save_page(f, block_offset,
 333                                       offset, size, bytes_sent);
 334         if (ret != RAM_SAVE_CONTROL_NOT_SUPP) {
 335             f->rate_limit_used += size;
 336         }
 337
 338         if (ret != RAM_SAVE_CONTROL_DELAYED &&
 339             ret != RAM_SAVE_CONTROL_NOT_SUPP) {
 340             if (bytes_sent && *bytes_sent > 0) {
 341                 qemu_file_credit_transfer(f, *bytes_sent);
 342             } else if (ret < 0) {
 343                 qemu_file_set_error(f, ret);
 344             }
 345         }
 346
 347         return ret;
 348     }
 349
 350     return RAM_SAVE_CONTROL_NOT_SUPP;
 351 }
 352
 353 /*
 354  * Attempt to fill the buffer from the underlying file
 355  * Returns the number of bytes read, or negative value for an error.
 356  *
 357  * Note that it can return a partially full buffer even in a not error/not EOF
 358  * case if the underlying file descriptor gives a short read, and that can
 359  * happen even on a blocking fd.
 360  */
 361 static ssize_t qemu_fill_buffer(QEMUFile *f)
 362 {
 363     int len;
 364     int pending;
 365     Error *local_error = NULL;
 366
 367     assert(!qemu_file_is_writable(f));
 368
 369     pending = f->buf_size - f->buf_index;
 370     if (pending > 0) {
 371         memmove(f->buf, f->buf + f->buf_index, pending);
 372     }
 373     f->buf_index = 0;
 374     f->buf_size = pending;
 375
 376     if (f->shutdown) {
 377         return 0;
 378     }
 379
 380     len = f->ops->get_buffer(f->ioc, f->buf + pending, f->total_transferred,
 381                              IO_BUF_SIZE - pending, &local_error);
 382     if (len > 0) {
 383         f->buf_size += len;
 384         f->total_transferred += len;
 385     } else if (len == 0) {
 386         qemu_file_set_error_obj(f, -EIO, local_error);
 387     } else if (len != -EAGAIN) {
 388         qemu_file_set_error_obj(f, len, local_error);
 389     } else {
 390         error_free(local_error);
 391     }
 392
 393     return len;
 394 }
 395
 396 void qemu_file_credit_transfer(QEMUFile *f, size_t size)
 397 {
 398     f->total_transferred += size;
 399 }
 400
 401 /** Closes the file
 402  *
 403  * Returns negative error value if any error happened on previous operations or
 404  * while closing the file. Returns 0 or positive number on success.
 405  *
 406  * The meaning of return value on success depends on the specific backend
 407  * being used.
 408  */
 409 int qemu_fclose(QEMUFile *f)
 410 {
 411     int ret, ret2;
 412     qemu_fflush(f);
 413     ret = qemu_file_get_error(f);
 414
 415     ret2 = qio_channel_close(f->ioc, NULL);
 416     if (ret >= 0) {
 417         ret = ret2;
 418     }
 419     g_clear_pointer(&f->ioc, object_unref);
 420
 421     /* If any error was spotted before closing, we should report it
 422      * instead of the close() return value.
 423      */
 424     if (f->last_error) {
 425         ret = f->last_error;
 426     }
 427     error_free(f->last_error_obj);
 428     g_free(f);
 429     trace_qemu_file_fclose();
 430     return ret;
 431 }
 432
 433 /*
 434  * Add buf to iovec. Do flush if iovec is full.
 435  *
 436  * Return values:
 437  * 1 iovec is full and flushed
 438  * 0 iovec is not flushed
 439  *
 440  */
 441 static int add_to_iovec(QEMUFile *f, const uint8_t *buf, size_t size,
 442                         bool may_free)
 443 {
 444     /* check for adjacent buffer and coalesce them */
 445     if (f->iovcnt > 0 && buf == f->iov[f->iovcnt - 1].iov_base +
 446         f->iov[f->iovcnt - 1].iov_len &&
 447         may_free == test_bit(f->iovcnt - 1, f->may_free))
 448     {
 449         f->iov[f->iovcnt - 1].iov_len += size;
 450     } else {
 451         if (f->iovcnt >= MAX_IOV_SIZE) {
 452             /* Should only happen if a previous fflush failed */
 453             assert(f->shutdown || !qemu_file_is_writable(f));
 454             return 1;
 455         }
 456         if (may_free) {
 457             set_bit(f->iovcnt, f->may_free);
 458         }
 459         f->iov[f->iovcnt].iov_base = (uint8_t *)buf;
 460         f->iov[f->iovcnt++].iov_len = size;
 461     }
 462
 463     if (f->iovcnt >= MAX_IOV_SIZE) {
 464         qemu_fflush(f);
 465         return 1;
 466     }
 467
 468     return 0;
 469 }
 470
 471 static void add_buf_to_iovec(QEMUFile *f, size_t len)
 472 {
 473     if (!add_to_iovec(f, f->buf + f->buf_index, len, false)) {
 474         f->buf_index += len;
 475         if (f->buf_index == IO_BUF_SIZE) {
 476             qemu_fflush(f);
 477         }
 478     }
 479 }
 480
 481 void qemu_put_buffer_async(QEMUFile *f, const uint8_t *buf, size_t size,
 482                            bool may_free)
 483 {
 484     if (f->last_error) {
 485         return;
 486     }
 487
 488     f->rate_limit_used += size;
 489     add_to_iovec(f, buf, size, may_free);
 490 }
 491
 492 void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, size_t size)
 493 {
 494     size_t l;
 495
 496     if (f->last_error) {
 497         return;
 498     }
 499
 500     while (size > 0) {
 501         l = IO_BUF_SIZE - f->buf_index;
 502         if (l > size) {
 503             l = size;
 504         }
 505         memcpy(f->buf + f->buf_index, buf, l);
 506         f->rate_limit_used += l;
 507         add_buf_to_iovec(f, l);
 508         if (qemu_file_get_error(f)) {
 509             break;
 510         }
 511         buf += l;
 512         size -= l;
 513     }
 514 }
 515
 516 void qemu_put_byte(QEMUFile *f, int v)
 517 {
 518     if (f->last_error) {
 519         return;
 520     }
 521
 522     f->buf[f->buf_index] = v;
 523     f->rate_limit_used++;
 524     add_buf_to_iovec(f, 1);
 525 }
 526
 527 void qemu_file_skip(QEMUFile *f, int size)
 528 {
 529     if (f->buf_index + size <= f->buf_size) {
 530         f->buf_index += size;
 531     }
 532 }
 533
 534 /*
 535  * Read 'size' bytes from file (at 'offset') without moving the
 536  * pointer and set 'buf' to point to that data.
 537  *
 538  * It will return size bytes unless there was an error, in which case it will
 539  * return as many as it managed to read (assuming blocking fd's which
 540  * all current QEMUFile are)
 541  */
 542 size_t qemu_peek_buffer(QEMUFile *f, uint8_t **buf, size_t size, size_t offset)
 543 {
 544     ssize_t pending;
 545     size_t index;
 546
 547     assert(!qemu_file_is_writable(f));
 548     assert(offset < IO_BUF_SIZE);
 549     assert(size <= IO_BUF_SIZE - offset);
 550
 551     /* The 1st byte to read from */
 552     index = f->buf_index + offset;
 553     /* The number of available bytes starting at index */
 554     pending = f->buf_size - index;
 555
 556     /*
 557      * qemu_fill_buffer might return just a few bytes, even when there isn't
 558      * an error, so loop collecting them until we get enough.
 559      */
 560     while (pending < size) {
 561         int received = qemu_fill_buffer(f);
 562
 563         if (received <= 0) {
 564             break;
 565         }
 566
 567         index = f->buf_index + offset;
 568         pending = f->buf_size - index;
 569     }
 570
 571     if (pending <= 0) {
 572         return 0;
 573     }
 574     if (size > pending) {
 575         size = pending;
 576     }
 577
 578     *buf = f->buf + index;
 579     return size;
 580 }
 581
 582 /*
 583  * Read 'size' bytes of data from the file into buf.
 584  * 'size' can be larger than the internal buffer.
 585  *
 586  * It will return size bytes unless there was an error, in which case it will
 587  * return as many as it managed to read (assuming blocking fd's which
 588  * all current QEMUFile are)
 589  */
 590 size_t qemu_get_buffer(QEMUFile *f, uint8_t *buf, size_t size)
 591 {
 592     size_t pending = size;
 593     size_t done = 0;
 594
 595     while (pending > 0) {
 596         size_t res;
 597         uint8_t *src;
 598
 599         res = qemu_peek_buffer(f, &src, MIN(pending, IO_BUF_SIZE), 0);
 600         if (res == 0) {
 601             return done;
 602         }
 603         memcpy(buf, src, res);
 604         qemu_file_skip(f, res);
 605         buf += res;
 606         pending -= res;
 607         done += res;
 608     }
 609     return done;
 610 }
 611
 612 /*
 613  * Read 'size' bytes of data from the file.
 614  * 'size' can be larger than the internal buffer.
 615  *
 616  * The data:
 617  *   may be held on an internal buffer (in which case *buf is updated
 618  *     to point to it) that is valid until the next qemu_file operation.
 619  * OR
 620  *   will be copied to the *buf that was passed in.
 621  *
 622  * The code tries to avoid the copy if possible.
 623  *
 624  * It will return size bytes unless there was an error, in which case it will
 625  * return as many as it managed to read (assuming blocking fd's which
 626  * all current QEMUFile are)
 627  *
 628  * Note: Since **buf may get changed, the caller should take care to
 629  *       keep a pointer to the original buffer if it needs to deallocate it.
 630  */
 631 size_t qemu_get_buffer_in_place(QEMUFile *f, uint8_t **buf, size_t size)
 632 {
 633     if (size < IO_BUF_SIZE) {
 634         size_t res;
 635         uint8_t *src = NULL;
 636
 637         res = qemu_peek_buffer(f, &src, size, 0);
 638
 639         if (res == size) {
 640             qemu_file_skip(f, res);
 641             *buf = src;
 642             return res;
 643         }
 644     }
 645
 646     return qemu_get_buffer(f, *buf, size);
 647 }
 648
 649 /*
 650  * Peeks a single byte from the buffer; this isn't guaranteed to work if
 651  * offset leaves a gap after the previous read/peeked data.
 652  */
 653 int qemu_peek_byte(QEMUFile *f, int offset)
 654 {
 655     int index = f->buf_index + offset;
 656
 657     assert(!qemu_file_is_writable(f));
 658     assert(offset < IO_BUF_SIZE);
 659
 660     if (index >= f->buf_size) {
 661         qemu_fill_buffer(f);
 662         index = f->buf_index + offset;
 663         if (index >= f->buf_size) {
 664             return 0;
 665         }
 666     }
 667     return f->buf[index];
 668 }
 669
 670 int qemu_get_byte(QEMUFile *f)
 671 {
 672     int result;
 673
 674     result = qemu_peek_byte(f, 0);
 675     qemu_file_skip(f, 1);
 676     return result;
 677 }
 678
 679 int64_t qemu_file_total_transferred_fast(QEMUFile *f)
 680 {
 681     int64_t ret = f->total_transferred;
 682     int i;
 683
 684     for (i = 0; i < f->iovcnt; i++) {
 685         ret += f->iov[i].iov_len;
 686     }
 687
 688     return ret;
 689 }
 690
 691 int64_t qemu_file_total_transferred(QEMUFile *f)
 692 {
 693     qemu_fflush(f);
 694     return f->total_transferred;
 695 }
 696
 697 int qemu_file_rate_limit(QEMUFile *f)
 698 {
 699     if (f->shutdown) {
 700         return 1;
 701     }
 702     if (qemu_file_get_error(f)) {
 703         return 1;
 704     }
 705     if (f->rate_limit_max > 0 && f->rate_limit_used > f->rate_limit_max) {
 706         return 1;
 707     }
 708     return 0;
 709 }
 710
 711 int64_t qemu_file_get_rate_limit(QEMUFile *f)
 712 {
 713     return f->rate_limit_max;
 714 }
 715
 716 void qemu_file_set_rate_limit(QEMUFile *f, int64_t limit)
 717 {
 718     f->rate_limit_max = limit;
 719 }
 720
 721 void qemu_file_reset_rate_limit(QEMUFile *f)
 722 {
 723     f->rate_limit_used = 0;
 724 }
 725
 726 void qemu_file_acct_rate_limit(QEMUFile *f, int64_t len)
 727 {
 728     f->rate_limit_used += len;
 729 }
 730
 731 void qemu_put_be16(QEMUFile *f, unsigned int v)
 732 {
 733     qemu_put_byte(f, v >> 8);
 734     qemu_put_byte(f, v);
 735 }
 736
 737 void qemu_put_be32(QEMUFile *f, unsigned int v)
 738 {
 739     qemu_put_byte(f, v >> 24);
 740     qemu_put_byte(f, v >> 16);
 741     qemu_put_byte(f, v >> 8);
 742     qemu_put_byte(f, v);
 743 }
 744
 745 void qemu_put_be64(QEMUFile *f, uint64_t v)
 746 {
 747     qemu_put_be32(f, v >> 32);
 748     qemu_put_be32(f, v);
 749 }
 750
 751 unsigned int qemu_get_be16(QEMUFile *f)
 752 {
 753     unsigned int v;
 754     v = qemu_get_byte(f) << 8;
 755     v |= qemu_get_byte(f);
 756     return v;
 757 }
 758
 759 unsigned int qemu_get_be32(QEMUFile *f)
 760 {
 761     unsigned int v;
 762     v = (unsigned int)qemu_get_byte(f) << 24;
 763     v |= qemu_get_byte(f) << 16;
 764     v |= qemu_get_byte(f) << 8;
 765     v |= qemu_get_byte(f);
 766     return v;
 767 }
 768
 769 uint64_t qemu_get_be64(QEMUFile *f)
 770 {
 771     uint64_t v;
 772     v = (uint64_t)qemu_get_be32(f) << 32;
 773     v |= qemu_get_be32(f);
 774     return v;
 775 }
 776
 777 /* return the size after compression, or negative value on error */
 778 static int qemu_compress_data(z_stream *stream, uint8_t *dest, size_t dest_len,
 779                               const uint8_t *source, size_t source_len)
 780 {
 781     int err;
 782
 783     err = deflateReset(stream);
 784     if (err != Z_OK) {
 785         return -1;
 786     }
 787
 788     stream->avail_in = source_len;
 789     stream->next_in = (uint8_t *)source;
 790     stream->avail_out = dest_len;
 791     stream->next_out = dest;
 792
 793     err = deflate(stream, Z_FINISH);
 794     if (err != Z_STREAM_END) {
 795         return -1;
 796     }
 797
 798     return stream->next_out - dest;
 799 }
 800
 801 /* Compress size bytes of data start at p and store the compressed
 802  * data to the buffer of f.
 803  *
 804  * Since the file is dummy file with empty_ops, return -1 if f has no space to
 805  * save the compressed data.
 806  */
 807 ssize_t qemu_put_compression_data(QEMUFile *f, z_stream *stream,
 808                                   const uint8_t *p, size_t size)
 809 {
 810     ssize_t blen = IO_BUF_SIZE - f->buf_index - sizeof(int32_t);
 811
 812     if (blen < compressBound(size)) {
 813         return -1;
 814     }
 815
 816     blen = qemu_compress_data(stream, f->buf + f->buf_index + sizeof(int32_t),
 817                               blen, p, size);
 818     if (blen < 0) {
 819         return -1;
 820     }
 821
 822     qemu_put_be32(f, blen);
 823     add_buf_to_iovec(f, blen);
 824     return blen + sizeof(int32_t);
 825 }
 826
 827 /* Put the data in the buffer of f_src to the buffer of f_des, and
 828  * then reset the buf_index of f_src to 0.
 829  */
 830
 831 int qemu_put_qemu_file(QEMUFile *f_des, QEMUFile *f_src)
 832 {
 833     int len = 0;
 834
 835     if (f_src->buf_index > 0) {
 836         len = f_src->buf_index;
 837         qemu_put_buffer(f_des, f_src->buf, f_src->buf_index);
 838         f_src->buf_index = 0;
 839         f_src->iovcnt = 0;
 840     }
 841     return len;
 842 }
 843
 844 /*
 845  * Get a string whose length is determined by a single preceding byte
 846  * A preallocated 256 byte buffer must be passed in.
 847  * Returns: len on success and a 0 terminated string in the buffer
 848  *          else 0
 849  *          (Note a 0 length string will return 0 either way)
 850  */
 851 size_t qemu_get_counted_string(QEMUFile *f, char buf[256])
 852 {
 853     size_t len = qemu_get_byte(f);
 854     size_t res = qemu_get_buffer(f, (uint8_t *)buf, len);
 855
 856     buf[res] = 0;
 857
 858     return res == len ? res : 0;
 859 }
 860
 861 /*
 862  * Put a string with one preceding byte containing its length. The length of
 863  * the string should be less than 256.
 864  */
 865 void qemu_put_counted_string(QEMUFile *f, const char *str)
 866 {
 867     size_t len = strlen(str);
 868
 869     assert(len < 256);
 870     qemu_put_byte(f, len);
 871     qemu_put_buffer(f, (const uint8_t *)str, len);
 872 }
 873
 874 /*
 875  * Set the blocking state of the QEMUFile.
 876  * Note: On some transports the OS only keeps a single blocking state for
 877  *       both directions, and thus changing the blocking on the main
 878  *       QEMUFile can also affect the return path.
 879  */
 880 void qemu_file_set_blocking(QEMUFile *f, bool block)
 881 {
 882     qio_channel_set_blocking(f->ioc, block, NULL);
 883 }
 884
 885 /*
 886  * qemu_file_get_ioc:
 887  *
 888  * Get the ioc object for the file, without incrementing
 889  * the reference count.
 890  *
 891  * Returns: the ioc object
 892  */
 893 QIOChannel *qemu_file_get_ioc(QEMUFile *file)
 894 {
 895     return file->ioc;
 896 }