1
2
3
4
5
6
7
8
9
10
11
12#ifndef QEMU_COMMON_H
13#define QEMU_COMMON_H
14
15#include "qemu/compiler.h"
16#include "config-host.h"
17#include "qemu/typedefs.h"
18
19#if defined(__arm__) || defined(__sparc__) || defined(__mips__) || defined(__hppa__) || defined(__ia64__)
20#define WORDS_ALIGNED
21#endif
22
23#define TFR(expr) do { if ((expr) != -1) break; } while (errno == EINTR)
24
25
26#include <stdlib.h>
27#include <stdio.h>
28#include <stdarg.h>
29#include <stdbool.h>
30#include <string.h>
31#include <strings.h>
32#include <inttypes.h>
33#include <limits.h>
34#include <time.h>
35#include <ctype.h>
36#include <errno.h>
37#include <unistd.h>
38#include <fcntl.h>
39#include <sys/stat.h>
40#include <sys/time.h>
41#include <assert.h>
42#include <signal.h>
43#include "glib-compat.h"
44#include "qemu/option.h"
45
46#ifdef _WIN32
47#include "sysemu/os-win32.h"
48#endif
49
50#ifdef CONFIG_POSIX
51#include "sysemu/os-posix.h"
52#endif
53
54#ifndef O_LARGEFILE
55#define O_LARGEFILE 0
56#endif
57#ifndef O_BINARY
58#define O_BINARY 0
59#endif
60#ifndef MAP_ANONYMOUS
61#define MAP_ANONYMOUS MAP_ANON
62#endif
63#ifndef ENOMEDIUM
64#define ENOMEDIUM ENODEV
65#endif
66#if !defined(ENOTSUP)
67#define ENOTSUP 4096
68#endif
69#if !defined(ECANCELED)
70#define ECANCELED 4097
71#endif
72#if !defined(EMEDIUMTYPE)
73#define EMEDIUMTYPE 4098
74#endif
75#ifndef TIME_MAX
76#define TIME_MAX LONG_MAX
77#endif
78
79
80#if UINTPTR_MAX == UINT32_MAX
81# define HOST_LONG_BITS 32
82#elif UINTPTR_MAX == UINT64_MAX
83# define HOST_LONG_BITS 64
84#else
85# error Unknown pointer size
86#endif
87
88typedef int (*fprintf_function)(FILE *f, const char *fmt, ...)
89 GCC_FMT_ATTR(2, 3);
90
91#ifdef _WIN32
92#define fsync _commit
93#if !defined(lseek)
94# define lseek _lseeki64
95#endif
96int qemu_ftruncate64(int, int64_t);
97#if !defined(ftruncate)
98# define ftruncate qemu_ftruncate64
99#endif
100
101static inline char *realpath(const char *path, char *resolved_path)
102{
103 _fullpath(resolved_path, path, _MAX_PATH);
104 return resolved_path;
105}
106#endif
107
108void cpu_ticks_init(void);
109
110
111void configure_icount(QemuOpts *opts, Error **errp);
112extern int use_icount;
113extern int icount_align_option;
114
115extern int64_t max_delay;
116extern int64_t max_advance;
117void dump_drift_info(FILE *f, fprintf_function cpu_fprintf);
118
119#include "qemu/osdep.h"
120#include "qemu/bswap.h"
121
122
123#ifdef NEED_CPU_H
124#include "cpu.h"
125#endif
126
127
128#if defined(CONFIG_COCOA)
129int qemu_main(int argc, char **argv, char **envp);
130#endif
131
132void qemu_get_timedate(struct tm *tm, int offset);
133int qemu_timedate_diff(struct tm *tm);
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148static inline bool is_help_option(const char *s)
149{
150 return !strcmp(s, "?") || !strcmp(s, "help");
151}
152
153
154void pstrcpy(char *buf, int buf_size, const char *str);
155void strpadcpy(char *buf, int buf_size, const char *str, char pad);
156char *pstrcat(char *buf, int buf_size, const char *s);
157int strstart(const char *str, const char *val, const char **ptr);
158int stristart(const char *str, const char *val, const char **ptr);
159int qemu_strnlen(const char *s, int max_len);
160char *qemu_strsep(char **input, const char *delim);
161time_t mktimegm(struct tm *tm);
162int qemu_fls(int i);
163int qemu_fdatasync(int fd);
164int fcntl_setfl(int fd, int flag);
165int qemu_parse_fd(const char *param);
166
167int parse_uint(const char *s, unsigned long long *value, char **endptr,
168 int base);
169int parse_uint_full(const char *s, unsigned long long *value, int base);
170
171
172
173
174
175
176
177
178#define STRTOSZ_DEFSUFFIX_EB 'E'
179#define STRTOSZ_DEFSUFFIX_PB 'P'
180#define STRTOSZ_DEFSUFFIX_TB 'T'
181#define STRTOSZ_DEFSUFFIX_GB 'G'
182#define STRTOSZ_DEFSUFFIX_MB 'M'
183#define STRTOSZ_DEFSUFFIX_KB 'K'
184#define STRTOSZ_DEFSUFFIX_B 'B'
185int64_t strtosz(const char *nptr, char **end);
186int64_t strtosz_suffix(const char *nptr, char **end, const char default_suffix);
187int64_t strtosz_suffix_unit(const char *nptr, char **end,
188 const char default_suffix, int64_t unit);
189
190
191#define STR_OR_NULL(str) ((str) ? (str) : "null")
192
193
194bool id_wellformed(const char *id);
195
196
197void init_paths(const char *prefix);
198const char *path(const char *pathname);
199
200#define qemu_isalnum(c) isalnum((unsigned char)(c))
201#define qemu_isalpha(c) isalpha((unsigned char)(c))
202#define qemu_iscntrl(c) iscntrl((unsigned char)(c))
203#define qemu_isdigit(c) isdigit((unsigned char)(c))
204#define qemu_isgraph(c) isgraph((unsigned char)(c))
205#define qemu_islower(c) islower((unsigned char)(c))
206#define qemu_isprint(c) isprint((unsigned char)(c))
207#define qemu_ispunct(c) ispunct((unsigned char)(c))
208#define qemu_isspace(c) isspace((unsigned char)(c))
209#define qemu_isupper(c) isupper((unsigned char)(c))
210#define qemu_isxdigit(c) isxdigit((unsigned char)(c))
211#define qemu_tolower(c) tolower((unsigned char)(c))
212#define qemu_toupper(c) toupper((unsigned char)(c))
213#define qemu_isascii(c) isascii((unsigned char)(c))
214#define qemu_toascii(c) toascii((unsigned char)(c))
215
216void *qemu_oom_check(void *ptr);
217
218ssize_t qemu_write_full(int fd, const void *buf, size_t count)
219 QEMU_WARN_UNUSED_RESULT;
220ssize_t qemu_send_full(int fd, const void *buf, size_t count, int flags)
221 QEMU_WARN_UNUSED_RESULT;
222ssize_t qemu_recv_full(int fd, void *buf, size_t count, int flags)
223 QEMU_WARN_UNUSED_RESULT;
224
225#ifndef _WIN32
226int qemu_pipe(int pipefd[2]);
227
228int qemu_openpty_raw(int *aslave, char *pty_name);
229#endif
230
231#ifdef _WIN32
232
233#define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
234 getsockopt(sockfd, level, optname, (void *)optval, optlen)
235#define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
236 setsockopt(sockfd, level, optname, (const void *)optval, optlen)
237#define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags)
238#define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
239 sendto(sockfd, (const void *)buf, len, flags, destaddr, addrlen)
240#else
241#define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
242 getsockopt(sockfd, level, optname, optval, optlen)
243#define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
244 setsockopt(sockfd, level, optname, optval, optlen)
245#define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags)
246#define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
247 sendto(sockfd, buf, len, flags, destaddr, addrlen)
248#endif
249
250
251
252void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
253
254struct ParallelIOArg {
255 void *buffer;
256 int count;
257};
258
259typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
260
261typedef uint64_t pcibus_t;
262
263typedef struct PCIHostDeviceAddress {
264 unsigned int domain;
265 unsigned int bus;
266 unsigned int slot;
267 unsigned int function;
268} PCIHostDeviceAddress;
269
270void tcg_exec_init(unsigned long tb_size);
271bool tcg_enabled(void);
272
273void cpu_exec_init_all(void);
274
275
276#ifdef CPU_SAVE_VERSION
277void cpu_save(QEMUFile *f, void *opaque);
278int cpu_load(QEMUFile *f, void *opaque, int version_id);
279#endif
280
281
282void qemu_cpu_kick_self(void);
283
284
285struct qemu_work_item {
286 struct qemu_work_item *next;
287 void (*func)(void *data);
288 void *data;
289 int done;
290 bool free;
291};
292
293
294
295
296
297
298
299
300
301ssize_t qemu_co_sendv_recvv(int sockfd, struct iovec *iov, unsigned iov_cnt,
302 size_t offset, size_t bytes, bool do_send);
303#define qemu_co_recvv(sockfd, iov, iov_cnt, offset, bytes) \
304 qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, false)
305#define qemu_co_sendv(sockfd, iov, iov_cnt, offset, bytes) \
306 qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, true)
307
308
309
310
311ssize_t qemu_co_send_recv(int sockfd, void *buf, size_t bytes, bool do_send);
312#define qemu_co_recv(sockfd, buf, bytes) \
313 qemu_co_send_recv(sockfd, buf, bytes, false)
314#define qemu_co_send(sockfd, buf, bytes) \
315 qemu_co_send_recv(sockfd, buf, bytes, true)
316
317typedef struct QEMUIOVector {
318 struct iovec *iov;
319 int niov;
320 int nalloc;
321 size_t size;
322} QEMUIOVector;
323
324void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
325void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
326void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
327void qemu_iovec_concat(QEMUIOVector *dst,
328 QEMUIOVector *src, size_t soffset, size_t sbytes);
329size_t qemu_iovec_concat_iov(QEMUIOVector *dst,
330 struct iovec *src_iov, unsigned int src_cnt,
331 size_t soffset, size_t sbytes);
332bool qemu_iovec_is_zero(QEMUIOVector *qiov);
333void qemu_iovec_destroy(QEMUIOVector *qiov);
334void qemu_iovec_reset(QEMUIOVector *qiov);
335size_t qemu_iovec_to_buf(QEMUIOVector *qiov, size_t offset,
336 void *buf, size_t bytes);
337size_t qemu_iovec_from_buf(QEMUIOVector *qiov, size_t offset,
338 const void *buf, size_t bytes);
339size_t qemu_iovec_memset(QEMUIOVector *qiov, size_t offset,
340 int fillc, size_t bytes);
341ssize_t qemu_iovec_compare(QEMUIOVector *a, QEMUIOVector *b);
342void qemu_iovec_clone(QEMUIOVector *dest, const QEMUIOVector *src, void *buf);
343void qemu_iovec_discard_back(QEMUIOVector *qiov, size_t bytes);
344
345bool buffer_is_zero(const void *buf, size_t len);
346
347void qemu_progress_init(int enabled, float min_skip);
348void qemu_progress_end(void);
349void qemu_progress_print(float delta, int max);
350const char *qemu_get_vm_name(void);
351
352#define QEMU_FILE_TYPE_BIOS 0
353#define QEMU_FILE_TYPE_KEYMAP 1
354char *qemu_find_file(int type, const char *name);
355
356
357void os_setup_early_signal_handling(void);
358char *os_find_datadir(void);
359void os_parse_cmd_args(int index, const char *optarg);
360
361
362static inline uint8_t to_bcd(uint8_t val)
363{
364 return ((val / 10) << 4) | (val % 10);
365}
366
367static inline uint8_t from_bcd(uint8_t val)
368{
369 return ((val >> 4) * 10) + (val & 0x0f);
370}
371
372
373static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
374{
375 union {
376 uint64_t ll;
377 struct {
378#ifdef HOST_WORDS_BIGENDIAN
379 uint32_t high, low;
380#else
381 uint32_t low, high;
382#endif
383 } l;
384 } u, res;
385 uint64_t rl, rh;
386
387 u.ll = a;
388 rl = (uint64_t)u.l.low * (uint64_t)b;
389 rh = (uint64_t)u.l.high * (uint64_t)b;
390 rh += (rl >> 32);
391 res.l.high = rh / c;
392 res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
393 return res.ll;
394}
395
396
397#define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
398
399
400#define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
401
402static inline bool is_power_of_2(uint64_t value)
403{
404 if (!value) {
405 return 0;
406 }
407
408 return !(value & (value - 1));
409}
410
411
412int64_t pow2floor(int64_t value);
413
414#include "qemu/module.h"
415
416
417
418
419
420
421int uleb128_encode_small(uint8_t *out, uint32_t n);
422int uleb128_decode_small(const uint8_t *in, uint32_t *n);
423
424
425int mod_utf8_codepoint(const char *s, size_t n, char **end);
426
427
428
429
430
431void qemu_hexdump(const char *buf, FILE *fp, const char *prefix, size_t size);
432
433
434#ifdef __ALTIVEC__
435#include <altivec.h>
436
437
438
439
440#undef vector
441#undef pixel
442#undef bool
443#define VECTYPE __vector unsigned char
444#define SPLAT(p) vec_splat(vec_ld(0, p), 0)
445#define ALL_EQ(v1, v2) vec_all_eq(v1, v2)
446
447
448#define bool _Bool
449#elif defined __SSE2__
450#include <emmintrin.h>
451#define VECTYPE __m128i
452#define SPLAT(p) _mm_set1_epi8(*(p))
453#define ALL_EQ(v1, v2) (_mm_movemask_epi8(_mm_cmpeq_epi8(v1, v2)) == 0xFFFF)
454#else
455#define VECTYPE unsigned long
456#define SPLAT(p) (*(p) * (~0UL / 255))
457#define ALL_EQ(v1, v2) ((v1) == (v2))
458#endif
459
460#define BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR 8
461static inline bool
462can_use_buffer_find_nonzero_offset(const void *buf, size_t len)
463{
464 return (len % (BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR
465 * sizeof(VECTYPE)) == 0
466 && ((uintptr_t) buf) % sizeof(VECTYPE) == 0);
467}
468size_t buffer_find_nonzero_offset(const void *buf, size_t len);
469
470
471
472
473int parse_debug_env(const char *name, int max, int initial);
474
475const char *qemu_ether_ntoa(const MACAddr *mac);
476
477#endif
478