]>
Commit | Line | Data |
---|---|---|
701a8f76 PB |
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 | #ifndef QEMU_FILE_H | |
25 | #define QEMU_FILE_H 1 | |
43487c67 | 26 | #include "exec/cpu-common.h" |
701a8f76 | 27 | |
deb22f9a DDAG |
28 | #include <stdint.h> |
29 | ||
701a8f76 PB |
30 | /* This function writes a chunk of data to a file at the given position. |
31 | * The pos argument can be ignored if the file is only being used for | |
32 | * streaming. The handler should try to write all of the data it can. | |
33 | */ | |
a202a4c0 DDAG |
34 | typedef ssize_t (QEMUFilePutBufferFunc)(void *opaque, const uint8_t *buf, |
35 | int64_t pos, size_t size); | |
701a8f76 PB |
36 | |
37 | /* Read a chunk of data from a file at the given position. The pos argument | |
38 | * can be ignored if the file is only be used for streaming. The number of | |
39 | * bytes actually read should be returned. | |
40 | */ | |
a202a4c0 DDAG |
41 | typedef ssize_t (QEMUFileGetBufferFunc)(void *opaque, uint8_t *buf, |
42 | int64_t pos, size_t size); | |
701a8f76 PB |
43 | |
44 | /* Close a file | |
45 | * | |
46 | * Return negative error number on error, 0 or positive value on success. | |
47 | * | |
48 | * The meaning of return value on success depends on the specific back-end being | |
49 | * used. | |
50 | */ | |
51 | typedef int (QEMUFileCloseFunc)(void *opaque); | |
52 | ||
70eb6330 PB |
53 | /* Called to return the OS file descriptor associated to the QEMUFile. |
54 | */ | |
55 | typedef int (QEMUFileGetFD)(void *opaque); | |
56 | ||
d913829f OW |
57 | /* |
58 | * This function writes an iovec to file. | |
59 | */ | |
60 | typedef ssize_t (QEMUFileWritevBufferFunc)(void *opaque, struct iovec *iov, | |
05fcc848 | 61 | int iovcnt, int64_t pos); |
d913829f | 62 | |
43487c67 MH |
63 | /* |
64 | * This function provides hooks around different | |
65 | * stages of RAM migration. | |
632e3a5c DDAG |
66 | * 'opaque' is the backend specific data in QEMUFile |
67 | * 'data' is call specific data associated with the 'flags' value | |
43487c67 | 68 | */ |
632e3a5c DDAG |
69 | typedef int (QEMURamHookFunc)(QEMUFile *f, void *opaque, uint64_t flags, |
70 | void *data); | |
43487c67 MH |
71 | |
72 | /* | |
73 | * Constants used by ram_control_* hooks | |
74 | */ | |
632e3a5c DDAG |
75 | #define RAM_CONTROL_SETUP 0 |
76 | #define RAM_CONTROL_ROUND 1 | |
77 | #define RAM_CONTROL_HOOK 2 | |
78 | #define RAM_CONTROL_FINISH 3 | |
79 | #define RAM_CONTROL_BLOCK_REG 4 | |
43487c67 MH |
80 | |
81 | /* | |
82 | * This function allows override of where the RAM page | |
83 | * is saved (such as RDMA, for example.) | |
84 | */ | |
85 | typedef size_t (QEMURamSaveFunc)(QEMUFile *f, void *opaque, | |
86 | ram_addr_t block_offset, | |
87 | ram_addr_t offset, | |
88 | size_t size, | |
6e1dea46 | 89 | uint64_t *bytes_sent); |
43487c67 | 90 | |
e1a8c9b6 DDAG |
91 | /* |
92 | * Stop any read or write (depending on flags) on the underlying | |
93 | * transport on the QEMUFile. | |
94 | * Existing blocking reads/writes must be woken | |
95 | * Returns 0 on success, -err on error | |
96 | */ | |
97 | typedef int (QEMUFileShutdownFunc)(void *opaque, bool rd, bool wr); | |
98 | ||
9229bf3c PB |
99 | typedef struct QEMUFileOps { |
100 | QEMUFilePutBufferFunc *put_buffer; | |
101 | QEMUFileGetBufferFunc *get_buffer; | |
102 | QEMUFileCloseFunc *close; | |
70eb6330 | 103 | QEMUFileGetFD *get_fd; |
d913829f | 104 | QEMUFileWritevBufferFunc *writev_buffer; |
43487c67 MH |
105 | QEMURamHookFunc *before_ram_iterate; |
106 | QEMURamHookFunc *after_ram_iterate; | |
107 | QEMURamHookFunc *hook_ram_load; | |
108 | QEMURamSaveFunc *save_page; | |
e1a8c9b6 | 109 | QEMUFileShutdownFunc *shut_down; |
9229bf3c PB |
110 | } QEMUFileOps; |
111 | ||
deb22f9a DDAG |
112 | struct QEMUSizedBuffer { |
113 | struct iovec *iov; | |
114 | size_t n_iov; | |
115 | size_t size; /* total allocated size in all iov's */ | |
116 | size_t used; /* number of used bytes */ | |
117 | }; | |
118 | ||
9229bf3c | 119 | QEMUFile *qemu_fopen_ops(void *opaque, const QEMUFileOps *ops); |
701a8f76 PB |
120 | QEMUFile *qemu_fopen(const char *filename, const char *mode); |
121 | QEMUFile *qemu_fdopen(int fd, const char *mode); | |
0cc3f3cc | 122 | QEMUFile *qemu_fopen_socket(int fd, const char *mode); |
701a8f76 | 123 | QEMUFile *qemu_popen_cmd(const char *command, const char *mode); |
deb22f9a | 124 | QEMUFile *qemu_bufopen(const char *mode, QEMUSizedBuffer *input); |
70eb6330 | 125 | int qemu_get_fd(QEMUFile *f); |
701a8f76 | 126 | int qemu_fclose(QEMUFile *f); |
ad55ab42 | 127 | int64_t qemu_ftell(QEMUFile *f); |
97221400 | 128 | int64_t qemu_ftell_fast(QEMUFile *f); |
56f3835f | 129 | void qemu_put_buffer(QEMUFile *f, const uint8_t *buf, size_t size); |
701a8f76 | 130 | void qemu_put_byte(QEMUFile *f, int v); |
6181ec24 OW |
131 | /* |
132 | * put_buffer without copying the buffer. | |
133 | * The buffer should be available till it is sent asynchronously. | |
134 | */ | |
56f3835f | 135 | void qemu_put_buffer_async(QEMUFile *f, const uint8_t *buf, size_t size); |
bc1256f7 | 136 | bool qemu_file_mode_is_not_valid(const char *mode); |
e68dd365 | 137 | bool qemu_file_is_writable(QEMUFile *f); |
701a8f76 | 138 | |
deb22f9a | 139 | QEMUSizedBuffer *qsb_create(const uint8_t *buffer, size_t len); |
deb22f9a DDAG |
140 | void qsb_free(QEMUSizedBuffer *); |
141 | size_t qsb_set_length(QEMUSizedBuffer *qsb, size_t length); | |
142 | size_t qsb_get_length(const QEMUSizedBuffer *qsb); | |
143 | ssize_t qsb_get_buffer(const QEMUSizedBuffer *, off_t start, size_t count, | |
144 | uint8_t *buf); | |
145 | ssize_t qsb_write_at(QEMUSizedBuffer *qsb, const uint8_t *buf, | |
146 | off_t pos, size_t count); | |
147 | ||
148 | ||
149 | /* | |
150 | * For use on files opened with qemu_bufopen | |
151 | */ | |
152 | const QEMUSizedBuffer *qemu_buf_get(QEMUFile *f); | |
153 | ||
701a8f76 PB |
154 | static inline void qemu_put_ubyte(QEMUFile *f, unsigned int v) |
155 | { | |
156 | qemu_put_byte(f, (int)v); | |
157 | } | |
158 | ||
159 | #define qemu_put_sbyte qemu_put_byte | |
160 | ||
161 | void qemu_put_be16(QEMUFile *f, unsigned int v); | |
162 | void qemu_put_be32(QEMUFile *f, unsigned int v); | |
163 | void qemu_put_be64(QEMUFile *f, uint64_t v); | |
56f3835f DDAG |
164 | size_t qemu_peek_buffer(QEMUFile *f, uint8_t **buf, size_t size, size_t offset); |
165 | size_t qemu_get_buffer(QEMUFile *f, uint8_t *buf, size_t size); | |
44f0eadc LL |
166 | ssize_t qemu_put_compression_data(QEMUFile *f, const uint8_t *p, size_t size, |
167 | int level); | |
168 | int qemu_put_qemu_file(QEMUFile *f_des, QEMUFile *f_src); | |
548f52ea DDAG |
169 | /* |
170 | * Note that you can only peek continuous bytes from where the current pointer | |
171 | * is; you aren't guaranteed to be able to peak to +n bytes unless you've | |
172 | * previously peeked +n-1. | |
173 | */ | |
c961514f | 174 | int qemu_peek_byte(QEMUFile *f, int offset); |
701a8f76 | 175 | int qemu_get_byte(QEMUFile *f); |
c961514f | 176 | void qemu_file_skip(QEMUFile *f, int size); |
2b0ce079 | 177 | void qemu_update_position(QEMUFile *f, size_t size); |
701a8f76 PB |
178 | |
179 | static inline unsigned int qemu_get_ubyte(QEMUFile *f) | |
180 | { | |
181 | return (unsigned int)qemu_get_byte(f); | |
182 | } | |
183 | ||
184 | #define qemu_get_sbyte qemu_get_byte | |
185 | ||
186 | unsigned int qemu_get_be16(QEMUFile *f); | |
187 | unsigned int qemu_get_be32(QEMUFile *f); | |
188 | uint64_t qemu_get_be64(QEMUFile *f); | |
189 | ||
190 | int qemu_file_rate_limit(QEMUFile *f); | |
1964a397 PB |
191 | void qemu_file_reset_rate_limit(QEMUFile *f); |
192 | void qemu_file_set_rate_limit(QEMUFile *f, int64_t new_rate); | |
701a8f76 PB |
193 | int64_t qemu_file_get_rate_limit(QEMUFile *f); |
194 | int qemu_file_get_error(QEMUFile *f); | |
c961514f | 195 | void qemu_file_set_error(QEMUFile *f, int ret); |
e1a8c9b6 | 196 | int qemu_file_shutdown(QEMUFile *f); |
be903b2a | 197 | void qemu_fflush(QEMUFile *f); |
701a8f76 | 198 | |
701a8f76 PB |
199 | static inline void qemu_put_be64s(QEMUFile *f, const uint64_t *pv) |
200 | { | |
201 | qemu_put_be64(f, *pv); | |
202 | } | |
203 | ||
204 | static inline void qemu_put_be32s(QEMUFile *f, const uint32_t *pv) | |
205 | { | |
206 | qemu_put_be32(f, *pv); | |
207 | } | |
208 | ||
209 | static inline void qemu_put_be16s(QEMUFile *f, const uint16_t *pv) | |
210 | { | |
211 | qemu_put_be16(f, *pv); | |
212 | } | |
213 | ||
214 | static inline void qemu_put_8s(QEMUFile *f, const uint8_t *pv) | |
215 | { | |
216 | qemu_put_byte(f, *pv); | |
217 | } | |
218 | ||
219 | static inline void qemu_get_be64s(QEMUFile *f, uint64_t *pv) | |
220 | { | |
221 | *pv = qemu_get_be64(f); | |
222 | } | |
223 | ||
224 | static inline void qemu_get_be32s(QEMUFile *f, uint32_t *pv) | |
225 | { | |
226 | *pv = qemu_get_be32(f); | |
227 | } | |
228 | ||
229 | static inline void qemu_get_be16s(QEMUFile *f, uint16_t *pv) | |
230 | { | |
231 | *pv = qemu_get_be16(f); | |
232 | } | |
233 | ||
234 | static inline void qemu_get_8s(QEMUFile *f, uint8_t *pv) | |
235 | { | |
236 | *pv = qemu_get_byte(f); | |
237 | } | |
238 | ||
239 | // Signed versions for type safety | |
56f3835f | 240 | static inline void qemu_put_sbuffer(QEMUFile *f, const int8_t *buf, size_t size) |
701a8f76 PB |
241 | { |
242 | qemu_put_buffer(f, (const uint8_t *)buf, size); | |
243 | } | |
244 | ||
245 | static inline void qemu_put_sbe16(QEMUFile *f, int v) | |
246 | { | |
247 | qemu_put_be16(f, (unsigned int)v); | |
248 | } | |
249 | ||
250 | static inline void qemu_put_sbe32(QEMUFile *f, int v) | |
251 | { | |
252 | qemu_put_be32(f, (unsigned int)v); | |
253 | } | |
254 | ||
255 | static inline void qemu_put_sbe64(QEMUFile *f, int64_t v) | |
256 | { | |
257 | qemu_put_be64(f, (uint64_t)v); | |
258 | } | |
259 | ||
260 | static inline size_t qemu_get_sbuffer(QEMUFile *f, int8_t *buf, int size) | |
261 | { | |
262 | return qemu_get_buffer(f, (uint8_t *)buf, size); | |
263 | } | |
264 | ||
265 | static inline int qemu_get_sbe16(QEMUFile *f) | |
266 | { | |
267 | return (int)qemu_get_be16(f); | |
268 | } | |
269 | ||
270 | static inline int qemu_get_sbe32(QEMUFile *f) | |
271 | { | |
272 | return (int)qemu_get_be32(f); | |
273 | } | |
274 | ||
275 | static inline int64_t qemu_get_sbe64(QEMUFile *f) | |
276 | { | |
277 | return (int64_t)qemu_get_be64(f); | |
278 | } | |
279 | ||
280 | static inline void qemu_put_s8s(QEMUFile *f, const int8_t *pv) | |
281 | { | |
282 | qemu_put_8s(f, (const uint8_t *)pv); | |
283 | } | |
284 | ||
285 | static inline void qemu_put_sbe16s(QEMUFile *f, const int16_t *pv) | |
286 | { | |
287 | qemu_put_be16s(f, (const uint16_t *)pv); | |
288 | } | |
289 | ||
290 | static inline void qemu_put_sbe32s(QEMUFile *f, const int32_t *pv) | |
291 | { | |
292 | qemu_put_be32s(f, (const uint32_t *)pv); | |
293 | } | |
294 | ||
295 | static inline void qemu_put_sbe64s(QEMUFile *f, const int64_t *pv) | |
296 | { | |
297 | qemu_put_be64s(f, (const uint64_t *)pv); | |
298 | } | |
299 | ||
300 | static inline void qemu_get_s8s(QEMUFile *f, int8_t *pv) | |
301 | { | |
302 | qemu_get_8s(f, (uint8_t *)pv); | |
303 | } | |
304 | ||
305 | static inline void qemu_get_sbe16s(QEMUFile *f, int16_t *pv) | |
306 | { | |
307 | qemu_get_be16s(f, (uint16_t *)pv); | |
308 | } | |
309 | ||
310 | static inline void qemu_get_sbe32s(QEMUFile *f, int32_t *pv) | |
311 | { | |
312 | qemu_get_be32s(f, (uint32_t *)pv); | |
313 | } | |
314 | ||
315 | static inline void qemu_get_sbe64s(QEMUFile *f, int64_t *pv) | |
316 | { | |
317 | qemu_get_be64s(f, (uint64_t *)pv); | |
318 | } | |
b3af1bc9 DDAG |
319 | |
320 | size_t qemu_get_counted_string(QEMUFile *f, char buf[256]); | |
321 | ||
701a8f76 | 322 | #endif |