migration/qemu-file.h

   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
  25 #ifndef MIGRATION_QEMU_FILE_H
  26 #define MIGRATION_QEMU_FILE_H
  27
  28 #include <zlib.h>
  29 #include "exec/cpu-common.h"
  30 #include "io/channel.h"
  31
  32 QEMUFile *qemu_file_new_input(QIOChannel *ioc);
  33 QEMUFile *qemu_file_new_output(QIOChannel *ioc);
  34 int qemu_fclose(QEMUFile *f);
  35
  36 /*
  37  * qemu_file_transferred:
  38  *
  39  * Report the total number of bytes transferred with
  40  * this file.
  41  *
  42  * For writable files, any pending buffers will be
  43  * flushed, so the reported value will be equal to
  44  * the number of bytes transferred on the wire.
  45  *
  46  * For readable files, the reported value will be
  47  * equal to the number of bytes transferred on the
  48  * wire.
  49  *
  50  * Returns: the total bytes transferred
  51  */
  52 uint64_t qemu_file_transferred(QEMUFile *f);
  53
  54 /*
  55  * qemu_file_transferred_noflush:
  56  *
  57  * As qemu_file_transferred except for writable files, where no flush
  58  * is performed and the reported amount will include the size of any
  59  * queued buffers, on top of the amount actually transferred.
  60  *
  61  * Returns: the total bytes transferred and queued
  62  */
  63 uint64_t qemu_file_transferred_noflush(QEMUFile *f);
  64
  65 /*
  66  * put_buffer without copying the buffer.
  67  * The buffer should be available till it is sent asynchronously.
  68  */
  69 void qemu_put_buffer_async(QEMUFile *f, const uint8_t *buf, size_t size,
  70                            bool may_free);
  71
  72 #include "migration/qemu-file-types.h"
  73
  74 size_t coroutine_mixed_fn qemu_peek_buffer(QEMUFile *f, uint8_t **buf, size_t size, size_t offset);
  75 size_t coroutine_mixed_fn qemu_get_buffer_in_place(QEMUFile *f, uint8_t **buf, size_t size);
  76 ssize_t qemu_put_compression_data(QEMUFile *f, z_stream *stream,
  77                                   const uint8_t *p, size_t size);
  78 int qemu_put_qemu_file(QEMUFile *f_des, QEMUFile *f_src);
  79 bool qemu_file_buffer_empty(QEMUFile *file);
  80
  81 /*
  82  * Note that you can only peek continuous bytes from where the current pointer
  83  * is; you aren't guaranteed to be able to peak to +n bytes unless you've
  84  * previously peeked +n-1.
  85  */
  86 int coroutine_mixed_fn qemu_peek_byte(QEMUFile *f, int offset);
  87 void qemu_file_skip(QEMUFile *f, int size);
  88 int qemu_file_get_error_obj_any(QEMUFile *f1, QEMUFile *f2, Error **errp);
  89 void qemu_file_set_error_obj(QEMUFile *f, int ret, Error *err);
  90 void qemu_file_set_error(QEMUFile *f, int ret);
  91 int qemu_file_shutdown(QEMUFile *f);
  92 QEMUFile *qemu_file_get_return_path(QEMUFile *f);
  93 void qemu_fflush(QEMUFile *f);
  94 void qemu_file_set_blocking(QEMUFile *f, bool block);
  95 int qemu_file_get_to_fd(QEMUFile *f, int fd, size_t size);
  96
  97 QIOChannel *qemu_file_get_ioc(QEMUFile *file);
  98
  99 #endif