numa: add -numa node,memdev= option
[qemu.git] / include / qemu-common.h
1
2 /* Common header file that is included by all of QEMU.
3 *
4 * This file is supposed to be included only by .c files. No header file should
5 * depend on qemu-common.h, as this would easily lead to circular header
6 * dependencies.
7 *
8 * If a header file uses a definition from qemu-common.h, that definition
9 * must be moved to a separate header file, and the header that uses it
10 * must include that header.
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 /* we put basic includes here to avoid repeating them in device drivers */
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
45 #ifdef _WIN32
46 #include "sysemu/os-win32.h"
47 #endif
48
49 #ifdef CONFIG_POSIX
50 #include "sysemu/os-posix.h"
51 #endif
52
53 #ifndef O_LARGEFILE
54 #define O_LARGEFILE 0
55 #endif
56 #ifndef O_BINARY
57 #define O_BINARY 0
58 #endif
59 #ifndef MAP_ANONYMOUS
60 #define MAP_ANONYMOUS MAP_ANON
61 #endif
62 #ifndef ENOMEDIUM
63 #define ENOMEDIUM ENODEV
64 #endif
65 #if !defined(ENOTSUP)
66 #define ENOTSUP 4096
67 #endif
68 #if !defined(ECANCELED)
69 #define ECANCELED 4097
70 #endif
71 #if !defined(EMEDIUMTYPE)
72 #define EMEDIUMTYPE 4098
73 #endif
74 #ifndef TIME_MAX
75 #define TIME_MAX LONG_MAX
76 #endif
77
78 /* HOST_LONG_BITS is the size of a native pointer in bits. */
79 #if UINTPTR_MAX == UINT32_MAX
80 # define HOST_LONG_BITS 32
81 #elif UINTPTR_MAX == UINT64_MAX
82 # define HOST_LONG_BITS 64
83 #else
84 # error Unknown pointer size
85 #endif
86
87 typedef int (*fprintf_function)(FILE *f, const char *fmt, ...)
88 GCC_FMT_ATTR(2, 3);
89
90 #ifdef _WIN32
91 #define fsync _commit
92 #if !defined(lseek)
93 # define lseek _lseeki64
94 #endif
95 int qemu_ftruncate64(int, int64_t);
96 #if !defined(ftruncate)
97 # define ftruncate qemu_ftruncate64
98 #endif
99
100 static inline char *realpath(const char *path, char *resolved_path)
101 {
102 _fullpath(resolved_path, path, _MAX_PATH);
103 return resolved_path;
104 }
105 #endif
106
107 /* icount */
108 void configure_icount(const char *option);
109 extern int use_icount;
110
111 #include "qemu/osdep.h"
112 #include "qemu/bswap.h"
113
114 /* FIXME: Remove NEED_CPU_H. */
115 #ifdef NEED_CPU_H
116 #include "cpu.h"
117 #endif /* !defined(NEED_CPU_H) */
118
119 /* main function, renamed */
120 #if defined(CONFIG_COCOA)
121 int qemu_main(int argc, char **argv, char **envp);
122 #endif
123
124 void qemu_get_timedate(struct tm *tm, int offset);
125 int qemu_timedate_diff(struct tm *tm);
126
127 /**
128 * is_help_option:
129 * @s: string to test
130 *
131 * Check whether @s is one of the standard strings which indicate
132 * that the user is asking for a list of the valid values for a
133 * command option like -cpu or -M. The current accepted strings
134 * are 'help' and '?'. '?' is deprecated (it is a shell wildcard
135 * which makes it annoying to use in a reliable way) but provided
136 * for backwards compatibility.
137 *
138 * Returns: true if @s is a request for a list.
139 */
140 static inline bool is_help_option(const char *s)
141 {
142 return !strcmp(s, "?") || !strcmp(s, "help");
143 }
144
145 /* cutils.c */
146 void pstrcpy(char *buf, int buf_size, const char *str);
147 void strpadcpy(char *buf, int buf_size, const char *str, char pad);
148 char *pstrcat(char *buf, int buf_size, const char *s);
149 int strstart(const char *str, const char *val, const char **ptr);
150 int stristart(const char *str, const char *val, const char **ptr);
151 int qemu_strnlen(const char *s, int max_len);
152 char *qemu_strsep(char **input, const char *delim);
153 time_t mktimegm(struct tm *tm);
154 int qemu_fls(int i);
155 int qemu_fdatasync(int fd);
156 int fcntl_setfl(int fd, int flag);
157 int qemu_parse_fd(const char *param);
158
159 int parse_uint(const char *s, unsigned long long *value, char **endptr,
160 int base);
161 int parse_uint_full(const char *s, unsigned long long *value, int base);
162
163 /*
164 * strtosz() suffixes used to specify the default treatment of an
165 * argument passed to strtosz() without an explicit suffix.
166 * These should be defined using upper case characters in the range
167 * A-Z, as strtosz() will use qemu_toupper() on the given argument
168 * prior to comparison.
169 */
170 #define STRTOSZ_DEFSUFFIX_EB 'E'
171 #define STRTOSZ_DEFSUFFIX_PB 'P'
172 #define STRTOSZ_DEFSUFFIX_TB 'T'
173 #define STRTOSZ_DEFSUFFIX_GB 'G'
174 #define STRTOSZ_DEFSUFFIX_MB 'M'
175 #define STRTOSZ_DEFSUFFIX_KB 'K'
176 #define STRTOSZ_DEFSUFFIX_B 'B'
177 int64_t strtosz(const char *nptr, char **end);
178 int64_t strtosz_suffix(const char *nptr, char **end, const char default_suffix);
179 int64_t strtosz_suffix_unit(const char *nptr, char **end,
180 const char default_suffix, int64_t unit);
181
182 /* used to print char* safely */
183 #define STR_OR_NULL(str) ((str) ? (str) : "null")
184
185 /* path.c */
186 void init_paths(const char *prefix);
187 const char *path(const char *pathname);
188
189 #define qemu_isalnum(c) isalnum((unsigned char)(c))
190 #define qemu_isalpha(c) isalpha((unsigned char)(c))
191 #define qemu_iscntrl(c) iscntrl((unsigned char)(c))
192 #define qemu_isdigit(c) isdigit((unsigned char)(c))
193 #define qemu_isgraph(c) isgraph((unsigned char)(c))
194 #define qemu_islower(c) islower((unsigned char)(c))
195 #define qemu_isprint(c) isprint((unsigned char)(c))
196 #define qemu_ispunct(c) ispunct((unsigned char)(c))
197 #define qemu_isspace(c) isspace((unsigned char)(c))
198 #define qemu_isupper(c) isupper((unsigned char)(c))
199 #define qemu_isxdigit(c) isxdigit((unsigned char)(c))
200 #define qemu_tolower(c) tolower((unsigned char)(c))
201 #define qemu_toupper(c) toupper((unsigned char)(c))
202 #define qemu_isascii(c) isascii((unsigned char)(c))
203 #define qemu_toascii(c) toascii((unsigned char)(c))
204
205 void *qemu_oom_check(void *ptr);
206
207 ssize_t qemu_write_full(int fd, const void *buf, size_t count)
208 QEMU_WARN_UNUSED_RESULT;
209 ssize_t qemu_send_full(int fd, const void *buf, size_t count, int flags)
210 QEMU_WARN_UNUSED_RESULT;
211 ssize_t qemu_recv_full(int fd, void *buf, size_t count, int flags)
212 QEMU_WARN_UNUSED_RESULT;
213
214 #ifndef _WIN32
215 int qemu_pipe(int pipefd[2]);
216 /* like openpty() but also makes it raw; return master fd */
217 int qemu_openpty_raw(int *aslave, char *pty_name);
218 #endif
219
220 #ifdef _WIN32
221 /* MinGW needs type casts for the 'buf' and 'optval' arguments. */
222 #define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
223 getsockopt(sockfd, level, optname, (void *)optval, optlen)
224 #define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
225 setsockopt(sockfd, level, optname, (const void *)optval, optlen)
226 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, (void *)buf, len, flags)
227 #define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
228 sendto(sockfd, (const void *)buf, len, flags, destaddr, addrlen)
229 #else
230 #define qemu_getsockopt(sockfd, level, optname, optval, optlen) \
231 getsockopt(sockfd, level, optname, optval, optlen)
232 #define qemu_setsockopt(sockfd, level, optname, optval, optlen) \
233 setsockopt(sockfd, level, optname, optval, optlen)
234 #define qemu_recv(sockfd, buf, len, flags) recv(sockfd, buf, len, flags)
235 #define qemu_sendto(sockfd, buf, len, flags, destaddr, addrlen) \
236 sendto(sockfd, buf, len, flags, destaddr, addrlen)
237 #endif
238
239 /* Error handling. */
240
241 void QEMU_NORETURN hw_error(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
242
243 struct ParallelIOArg {
244 void *buffer;
245 int count;
246 };
247
248 typedef int (*DMA_transfer_handler) (void *opaque, int nchan, int pos, int size);
249
250 typedef uint64_t pcibus_t;
251
252 typedef struct PCIHostDeviceAddress {
253 unsigned int domain;
254 unsigned int bus;
255 unsigned int slot;
256 unsigned int function;
257 } PCIHostDeviceAddress;
258
259 void tcg_exec_init(unsigned long tb_size);
260 bool tcg_enabled(void);
261
262 void cpu_exec_init_all(void);
263
264 /* CPU save/load. */
265 #ifdef CPU_SAVE_VERSION
266 void cpu_save(QEMUFile *f, void *opaque);
267 int cpu_load(QEMUFile *f, void *opaque, int version_id);
268 #endif
269
270 /* Unblock cpu */
271 void qemu_cpu_kick_self(void);
272
273 /* work queue */
274 struct qemu_work_item {
275 struct qemu_work_item *next;
276 void (*func)(void *data);
277 void *data;
278 int done;
279 bool free;
280 };
281
282
283 /**
284 * Sends a (part of) iovec down a socket, yielding when the socket is full, or
285 * Receives data into a (part of) iovec from a socket,
286 * yielding when there is no data in the socket.
287 * The same interface as qemu_sendv_recvv(), with added yielding.
288 * XXX should mark these as coroutine_fn
289 */
290 ssize_t qemu_co_sendv_recvv(int sockfd, struct iovec *iov, unsigned iov_cnt,
291 size_t offset, size_t bytes, bool do_send);
292 #define qemu_co_recvv(sockfd, iov, iov_cnt, offset, bytes) \
293 qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, false)
294 #define qemu_co_sendv(sockfd, iov, iov_cnt, offset, bytes) \
295 qemu_co_sendv_recvv(sockfd, iov, iov_cnt, offset, bytes, true)
296
297 /**
298 * The same as above, but with just a single buffer
299 */
300 ssize_t qemu_co_send_recv(int sockfd, void *buf, size_t bytes, bool do_send);
301 #define qemu_co_recv(sockfd, buf, bytes) \
302 qemu_co_send_recv(sockfd, buf, bytes, false)
303 #define qemu_co_send(sockfd, buf, bytes) \
304 qemu_co_send_recv(sockfd, buf, bytes, true)
305
306 typedef struct QEMUIOVector {
307 struct iovec *iov;
308 int niov;
309 int nalloc;
310 size_t size;
311 } QEMUIOVector;
312
313 void qemu_iovec_init(QEMUIOVector *qiov, int alloc_hint);
314 void qemu_iovec_init_external(QEMUIOVector *qiov, struct iovec *iov, int niov);
315 void qemu_iovec_add(QEMUIOVector *qiov, void *base, size_t len);
316 void qemu_iovec_concat(QEMUIOVector *dst,
317 QEMUIOVector *src, size_t soffset, size_t sbytes);
318 void qemu_iovec_concat_iov(QEMUIOVector *dst,
319 struct iovec *src_iov, unsigned int src_cnt,
320 size_t soffset, size_t sbytes);
321 bool qemu_iovec_is_zero(QEMUIOVector *qiov);
322 void qemu_iovec_destroy(QEMUIOVector *qiov);
323 void qemu_iovec_reset(QEMUIOVector *qiov);
324 size_t qemu_iovec_to_buf(QEMUIOVector *qiov, size_t offset,
325 void *buf, size_t bytes);
326 size_t qemu_iovec_from_buf(QEMUIOVector *qiov, size_t offset,
327 const void *buf, size_t bytes);
328 size_t qemu_iovec_memset(QEMUIOVector *qiov, size_t offset,
329 int fillc, size_t bytes);
330 ssize_t qemu_iovec_compare(QEMUIOVector *a, QEMUIOVector *b);
331 void qemu_iovec_clone(QEMUIOVector *dest, const QEMUIOVector *src, void *buf);
332
333 bool buffer_is_zero(const void *buf, size_t len);
334
335 void qemu_progress_init(int enabled, float min_skip);
336 void qemu_progress_end(void);
337 void qemu_progress_print(float delta, int max);
338 const char *qemu_get_vm_name(void);
339
340 #define QEMU_FILE_TYPE_BIOS 0
341 #define QEMU_FILE_TYPE_KEYMAP 1
342 char *qemu_find_file(int type, const char *name);
343
344 /* OS specific functions */
345 void os_setup_early_signal_handling(void);
346 char *os_find_datadir(void);
347 void os_parse_cmd_args(int index, const char *optarg);
348 void os_pidfile_error(void);
349
350 /* Convert a byte between binary and BCD. */
351 static inline uint8_t to_bcd(uint8_t val)
352 {
353 return ((val / 10) << 4) | (val % 10);
354 }
355
356 static inline uint8_t from_bcd(uint8_t val)
357 {
358 return ((val >> 4) * 10) + (val & 0x0f);
359 }
360
361 /* compute with 96 bit intermediate result: (a*b)/c */
362 static inline uint64_t muldiv64(uint64_t a, uint32_t b, uint32_t c)
363 {
364 union {
365 uint64_t ll;
366 struct {
367 #ifdef HOST_WORDS_BIGENDIAN
368 uint32_t high, low;
369 #else
370 uint32_t low, high;
371 #endif
372 } l;
373 } u, res;
374 uint64_t rl, rh;
375
376 u.ll = a;
377 rl = (uint64_t)u.l.low * (uint64_t)b;
378 rh = (uint64_t)u.l.high * (uint64_t)b;
379 rh += (rl >> 32);
380 res.l.high = rh / c;
381 res.l.low = (((rh % c) << 32) + (rl & 0xffffffff)) / c;
382 return res.ll;
383 }
384
385 /* Round number down to multiple */
386 #define QEMU_ALIGN_DOWN(n, m) ((n) / (m) * (m))
387
388 /* Round number up to multiple */
389 #define QEMU_ALIGN_UP(n, m) QEMU_ALIGN_DOWN((n) + (m) - 1, (m))
390
391 static inline bool is_power_of_2(uint64_t value)
392 {
393 if (!value) {
394 return 0;
395 }
396
397 return !(value & (value - 1));
398 }
399
400 /* round down to the nearest power of 2*/
401 int64_t pow2floor(int64_t value);
402
403 #include "qemu/module.h"
404
405 /*
406 * Implementation of ULEB128 (http://en.wikipedia.org/wiki/LEB128)
407 * Input is limited to 14-bit numbers
408 */
409
410 int uleb128_encode_small(uint8_t *out, uint32_t n);
411 int uleb128_decode_small(const uint8_t *in, uint32_t *n);
412
413 /* unicode.c */
414 int mod_utf8_codepoint(const char *s, size_t n, char **end);
415
416 /*
417 * Hexdump a buffer to a file. An optional string prefix is added to every line
418 */
419
420 void qemu_hexdump(const char *buf, FILE *fp, const char *prefix, size_t size);
421
422 /* vector definitions */
423 #ifdef __ALTIVEC__
424 #include <altivec.h>
425 /* The altivec.h header says we're allowed to undef these for
426 * C++ compatibility. Here we don't care about C++, but we
427 * undef them anyway to avoid namespace pollution.
428 */
429 #undef vector
430 #undef pixel
431 #undef bool
432 #define VECTYPE __vector unsigned char
433 #define SPLAT(p) vec_splat(vec_ld(0, p), 0)
434 #define ALL_EQ(v1, v2) vec_all_eq(v1, v2)
435 /* altivec.h may redefine the bool macro as vector type.
436 * Reset it to POSIX semantics. */
437 #define bool _Bool
438 #elif defined __SSE2__
439 #include <emmintrin.h>
440 #define VECTYPE __m128i
441 #define SPLAT(p) _mm_set1_epi8(*(p))
442 #define ALL_EQ(v1, v2) (_mm_movemask_epi8(_mm_cmpeq_epi8(v1, v2)) == 0xFFFF)
443 #else
444 #define VECTYPE unsigned long
445 #define SPLAT(p) (*(p) * (~0UL / 255))
446 #define ALL_EQ(v1, v2) ((v1) == (v2))
447 #endif
448
449 #define BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR 8
450 static inline bool
451 can_use_buffer_find_nonzero_offset(const void *buf, size_t len)
452 {
453 return (len % (BUFFER_FIND_NONZERO_OFFSET_UNROLL_FACTOR
454 * sizeof(VECTYPE)) == 0
455 && ((uintptr_t) buf) % sizeof(VECTYPE) == 0);
456 }
457 size_t buffer_find_nonzero_offset(const void *buf, size_t len);
458
459 /*
460 * helper to parse debug environment variables
461 */
462 int parse_debug_env(const char *name, int max, int initial);
463
464 const char *qemu_ether_ntoa(const MACAddr *mac);
465
466 #endif