4 * Copyright (c) 2003-2008 Fabrice Bellard
5 * Copyright (c) 2010 Red Hat, Inc.
7 * QEMU library functions on POSIX which are shared between QEMU and
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
23 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
29 #include "qemu/osdep.h"
32 #include <glib/gprintf.h>
34 #include "sysemu/sysemu.h"
36 #include "qapi/error.h"
37 #include "qemu/error-report.h"
38 #include "qemu/madvise.h"
39 #include "qemu/sockets.h"
40 #include "qemu/thread.h"
42 #include "qemu/cutils.h"
43 #include "qemu/compiler.h"
44 #include "qemu/units.h"
45 #include "qemu/thread-context.h"
48 #include <sys/syscall.h>
53 #include <sys/types.h>
62 #include "qemu/mmap-alloc.h"
64 #ifdef CONFIG_DEBUG_STACK_USAGE
65 #include "qemu/error-report.h"
68 #define MAX_MEM_PREALLOC_THREAD_COUNT 16
72 typedef struct MemsetContext
{
73 bool all_threads_created
;
74 bool any_thread_failed
;
75 struct MemsetThread
*threads
;
85 MemsetContext
*context
;
87 typedef struct MemsetThread MemsetThread
;
89 /* used by sigbus_handler() */
90 static MemsetContext
*sigbus_memset_context
;
91 struct sigaction sigbus_oldact
;
92 static QemuMutex sigbus_mutex
;
94 static QemuMutex page_mutex
;
95 static QemuCond page_cond
;
97 int qemu_get_thread_id(void)
99 #if defined(__linux__)
100 return syscall(SYS_gettid
);
101 #elif defined(__FreeBSD__)
102 /* thread id is up to INT_MAX */
106 #elif defined(__NetBSD__)
108 #elif defined(__OpenBSD__)
115 int qemu_daemon(int nochdir
, int noclose
)
117 return daemon(nochdir
, noclose
);
120 bool qemu_write_pidfile(const char *path
, Error
**errp
)
127 struct flock lock
= {
129 .l_whence
= SEEK_SET
,
133 fd
= qemu_create(path
, O_WRONLY
, S_IRUSR
| S_IWUSR
, errp
);
138 if (fstat(fd
, &b
) < 0) {
139 error_setg_errno(errp
, errno
, "Cannot stat file");
143 if (fcntl(fd
, F_SETLK
, &lock
)) {
144 error_setg_errno(errp
, errno
, "Cannot lock pid file");
149 * Now make sure the path we locked is the same one that now
150 * exists on the filesystem.
152 if (stat(path
, &a
) < 0) {
154 * PID file disappeared, someone else must be racing with
161 if (a
.st_ino
== b
.st_ino
) {
166 * PID file was recreated, someone else must be racing with
172 if (ftruncate(fd
, 0) < 0) {
173 error_setg_errno(errp
, errno
, "Failed to truncate pid file");
177 snprintf(pidstr
, sizeof(pidstr
), FMT_pid
"\n", getpid());
178 if (qemu_write_full(fd
, pidstr
, strlen(pidstr
)) != strlen(pidstr
)) {
179 error_setg(errp
, "Failed to write pid file");
192 /* alloc shared memory pages */
193 void *qemu_anon_ram_alloc(size_t size
, uint64_t *alignment
, bool shared
,
196 const uint32_t qemu_map_flags
= (shared
? QEMU_MAP_SHARED
: 0) |
197 (noreserve
? QEMU_MAP_NORESERVE
: 0);
198 size_t align
= QEMU_VMALLOC_ALIGN
;
199 void *ptr
= qemu_ram_mmap(-1, size
, align
, qemu_map_flags
, 0);
201 if (ptr
== MAP_FAILED
) {
209 trace_qemu_anon_ram_alloc(size
, ptr
);
213 void qemu_anon_ram_free(void *ptr
, size_t size
)
215 trace_qemu_anon_ram_free(ptr
, size
);
216 qemu_ram_munmap(-1, ptr
, size
);
219 void qemu_socket_set_block(int fd
)
221 g_unix_set_fd_nonblocking(fd
, false, NULL
);
224 int qemu_socket_try_set_nonblock(int fd
)
226 return g_unix_set_fd_nonblocking(fd
, true, NULL
) ? 0 : -errno
;
229 void qemu_socket_set_nonblock(int fd
)
232 f
= qemu_socket_try_set_nonblock(fd
);
236 int socket_set_fast_reuse(int fd
)
240 ret
= setsockopt(fd
, SOL_SOCKET
, SO_REUSEADDR
,
241 (const char *)&val
, sizeof(val
));
248 void qemu_set_cloexec(int fd
)
251 f
= fcntl(fd
, F_GETFD
);
253 f
= fcntl(fd
, F_SETFD
, f
| FD_CLOEXEC
);
257 int qemu_socketpair(int domain
, int type
, int protocol
, int sv
[2])
262 ret
= socketpair(domain
, type
| SOCK_CLOEXEC
, protocol
, sv
);
263 if (ret
!= -1 || errno
!= EINVAL
) {
267 ret
= socketpair(domain
, type
, protocol
, sv
);;
269 qemu_set_cloexec(sv
[0]);
270 qemu_set_cloexec(sv
[1]);
277 qemu_get_local_state_dir(void)
279 return get_relocated_path(CONFIG_QEMU_LOCALSTATEDIR
);
282 void qemu_set_tty_echo(int fd
, bool echo
)
289 tty
.c_lflag
|= ECHO
| ECHONL
| ICANON
| IEXTEN
;
291 tty
.c_lflag
&= ~(ECHO
| ECHONL
| ICANON
| IEXTEN
);
294 tcsetattr(fd
, TCSANOW
, &tty
);
298 static void sigbus_handler(int signal
, siginfo_t
*siginfo
, void *ctx
)
299 #else /* CONFIG_LINUX */
300 static void sigbus_handler(int signal
)
301 #endif /* CONFIG_LINUX */
305 if (sigbus_memset_context
) {
306 for (i
= 0; i
< sigbus_memset_context
->num_threads
; i
++) {
307 MemsetThread
*thread
= &sigbus_memset_context
->threads
[i
];
309 if (qemu_thread_is_self(&thread
->pgthread
)) {
310 siglongjmp(thread
->env
, 1);
317 * We assume that the MCE SIGBUS handler could have been registered. We
318 * should never receive BUS_MCEERR_AO on any of our threads, but only on
319 * the main thread registered for PR_MCE_KILL_EARLY. Further, we should not
320 * receive BUS_MCEERR_AR triggered by action of other threads on one of
321 * our threads. So, no need to check for unrelated SIGBUS when seeing one
324 * We will forward to the MCE handler, which will either handle the SIGBUS
325 * or reinstall the default SIGBUS handler and reraise the SIGBUS. The
326 * default SIGBUS handler will crash the process, so we don't care.
328 if (sigbus_oldact
.sa_flags
& SA_SIGINFO
) {
329 sigbus_oldact
.sa_sigaction(signal
, siginfo
, ctx
);
332 #endif /* CONFIG_LINUX */
333 warn_report("qemu_prealloc_mem: unrelated SIGBUS detected and ignored");
336 static void *do_touch_pages(void *arg
)
338 MemsetThread
*memset_args
= (MemsetThread
*)arg
;
339 sigset_t set
, oldset
;
343 * On Linux, the page faults from the loop below can cause mmap_sem
344 * contention with allocation of the thread stacks. Do not start
345 * clearing until all threads have been created.
347 qemu_mutex_lock(&page_mutex
);
348 while (!memset_args
->context
->all_threads_created
) {
349 qemu_cond_wait(&page_cond
, &page_mutex
);
351 qemu_mutex_unlock(&page_mutex
);
355 sigaddset(&set
, SIGBUS
);
356 pthread_sigmask(SIG_UNBLOCK
, &set
, &oldset
);
358 if (sigsetjmp(memset_args
->env
, 1)) {
361 char *addr
= memset_args
->addr
;
362 size_t numpages
= memset_args
->numpages
;
363 size_t hpagesize
= memset_args
->hpagesize
;
365 for (i
= 0; i
< numpages
; i
++) {
367 * Read & write back the same value, so we don't
368 * corrupt existing user/app data that might be
371 * 'volatile' to stop compiler optimizing this away
374 *(volatile char *)addr
= *addr
;
378 pthread_sigmask(SIG_SETMASK
, &oldset
, NULL
);
379 return (void *)(uintptr_t)ret
;
382 static void *do_madv_populate_write_pages(void *arg
)
384 MemsetThread
*memset_args
= (MemsetThread
*)arg
;
385 const size_t size
= memset_args
->numpages
* memset_args
->hpagesize
;
386 char * const addr
= memset_args
->addr
;
389 /* See do_touch_pages(). */
390 qemu_mutex_lock(&page_mutex
);
391 while (!memset_args
->context
->all_threads_created
) {
392 qemu_cond_wait(&page_cond
, &page_mutex
);
394 qemu_mutex_unlock(&page_mutex
);
396 if (size
&& qemu_madvise(addr
, size
, QEMU_MADV_POPULATE_WRITE
)) {
399 return (void *)(uintptr_t)ret
;
402 static inline int get_memset_num_threads(size_t hpagesize
, size_t numpages
,
405 long host_procs
= sysconf(_SC_NPROCESSORS_ONLN
);
408 if (host_procs
> 0) {
409 ret
= MIN(MIN(host_procs
, MAX_MEM_PREALLOC_THREAD_COUNT
), max_threads
);
412 /* Especially with gigantic pages, don't create more threads than pages. */
413 ret
= MIN(ret
, numpages
);
414 /* Don't start threads to prealloc comparatively little memory. */
415 ret
= MIN(ret
, MAX(1, hpagesize
* numpages
/ (64 * MiB
)));
417 /* In case sysconf() fails, we fall back to single threaded */
421 static int touch_all_pages(char *area
, size_t hpagesize
, size_t numpages
,
422 int max_threads
, ThreadContext
*tc
,
423 bool use_madv_populate_write
)
425 static gsize initialized
= 0;
426 MemsetContext context
= {
427 .num_threads
= get_memset_num_threads(hpagesize
, numpages
, max_threads
),
429 size_t numpages_per_thread
, leftover
;
430 void *(*touch_fn
)(void *);
434 if (g_once_init_enter(&initialized
)) {
435 qemu_mutex_init(&page_mutex
);
436 qemu_cond_init(&page_cond
);
437 g_once_init_leave(&initialized
, 1);
440 if (use_madv_populate_write
) {
441 /* Avoid creating a single thread for MADV_POPULATE_WRITE */
442 if (context
.num_threads
== 1) {
443 if (qemu_madvise(area
, hpagesize
* numpages
,
444 QEMU_MADV_POPULATE_WRITE
)) {
449 touch_fn
= do_madv_populate_write_pages
;
451 touch_fn
= do_touch_pages
;
454 context
.threads
= g_new0(MemsetThread
, context
.num_threads
);
455 numpages_per_thread
= numpages
/ context
.num_threads
;
456 leftover
= numpages
% context
.num_threads
;
457 for (i
= 0; i
< context
.num_threads
; i
++) {
458 context
.threads
[i
].addr
= addr
;
459 context
.threads
[i
].numpages
= numpages_per_thread
+ (i
< leftover
);
460 context
.threads
[i
].hpagesize
= hpagesize
;
461 context
.threads
[i
].context
= &context
;
463 thread_context_create_thread(tc
, &context
.threads
[i
].pgthread
,
465 touch_fn
, &context
.threads
[i
],
466 QEMU_THREAD_JOINABLE
);
468 qemu_thread_create(&context
.threads
[i
].pgthread
, "touch_pages",
469 touch_fn
, &context
.threads
[i
],
470 QEMU_THREAD_JOINABLE
);
472 addr
+= context
.threads
[i
].numpages
* hpagesize
;
475 if (!use_madv_populate_write
) {
476 sigbus_memset_context
= &context
;
479 qemu_mutex_lock(&page_mutex
);
480 context
.all_threads_created
= true;
481 qemu_cond_broadcast(&page_cond
);
482 qemu_mutex_unlock(&page_mutex
);
484 for (i
= 0; i
< context
.num_threads
; i
++) {
485 int tmp
= (uintptr_t)qemu_thread_join(&context
.threads
[i
].pgthread
);
492 if (!use_madv_populate_write
) {
493 sigbus_memset_context
= NULL
;
495 g_free(context
.threads
);
500 static bool madv_populate_write_possible(char *area
, size_t pagesize
)
502 return !qemu_madvise(area
, pagesize
, QEMU_MADV_POPULATE_WRITE
) ||
506 void qemu_prealloc_mem(int fd
, char *area
, size_t sz
, int max_threads
,
507 ThreadContext
*tc
, Error
**errp
)
509 static gsize initialized
;
511 size_t hpagesize
= qemu_fd_getpagesize(fd
);
512 size_t numpages
= DIV_ROUND_UP(sz
, hpagesize
);
513 bool use_madv_populate_write
;
514 struct sigaction act
;
517 * Sense on every invocation, as MADV_POPULATE_WRITE cannot be used for
518 * some special mappings, such as mapping /dev/mem.
520 use_madv_populate_write
= madv_populate_write_possible(area
, hpagesize
);
522 if (!use_madv_populate_write
) {
523 if (g_once_init_enter(&initialized
)) {
524 qemu_mutex_init(&sigbus_mutex
);
525 g_once_init_leave(&initialized
, 1);
528 qemu_mutex_lock(&sigbus_mutex
);
529 memset(&act
, 0, sizeof(act
));
531 act
.sa_sigaction
= &sigbus_handler
;
532 act
.sa_flags
= SA_SIGINFO
;
533 #else /* CONFIG_LINUX */
534 act
.sa_handler
= &sigbus_handler
;
536 #endif /* CONFIG_LINUX */
538 ret
= sigaction(SIGBUS
, &act
, &sigbus_oldact
);
540 qemu_mutex_unlock(&sigbus_mutex
);
541 error_setg_errno(errp
, errno
,
542 "qemu_prealloc_mem: failed to install signal handler");
547 /* touch pages simultaneously */
548 ret
= touch_all_pages(area
, hpagesize
, numpages
, max_threads
, tc
,
549 use_madv_populate_write
);
551 error_setg_errno(errp
, -ret
,
552 "qemu_prealloc_mem: preallocating memory failed");
555 if (!use_madv_populate_write
) {
556 ret
= sigaction(SIGBUS
, &sigbus_oldact
, NULL
);
558 /* Terminate QEMU since it can't recover from error */
559 perror("qemu_prealloc_mem: failed to reinstall signal handler");
562 qemu_mutex_unlock(&sigbus_mutex
);
566 char *qemu_get_pid_name(pid_t pid
)
570 #if defined(__FreeBSD__)
571 /* BSDs don't have /proc, but they provide a nice substitute */
572 struct kinfo_proc
*proc
= kinfo_getproc(pid
);
575 name
= g_strdup(proc
->ki_comm
);
579 /* Assume a system with reasonable procfs */
583 pid_path
= g_strdup_printf("/proc/%d/cmdline", pid
);
584 g_file_get_contents(pid_path
, &name
, &len
, NULL
);
592 pid_t
qemu_fork(Error
**errp
)
594 sigset_t oldmask
, newmask
;
595 struct sigaction sig_action
;
600 * Need to block signals now, so that child process can safely
601 * kill off caller's signal handlers without a race.
603 sigfillset(&newmask
);
604 if (pthread_sigmask(SIG_SETMASK
, &newmask
, &oldmask
) != 0) {
605 error_setg_errno(errp
, errno
,
606 "cannot block signals");
614 /* attempt to restore signal mask, but ignore failure, to
615 * avoid obscuring the fork failure */
616 (void)pthread_sigmask(SIG_SETMASK
, &oldmask
, NULL
);
617 error_setg_errno(errp
, saved_errno
,
618 "cannot fork child process");
624 /* Restore our original signal mask now that the child is
625 * safely running. Only documented failures are EFAULT (not
626 * possible, since we are using just-grabbed mask) or EINVAL
627 * (not possible, since we are using correct arguments). */
628 (void)pthread_sigmask(SIG_SETMASK
, &oldmask
, NULL
);
633 /* Clear out all signal handlers from parent so nothing
634 * unexpected can happen in our child once we unblock
636 sig_action
.sa_handler
= SIG_DFL
;
637 sig_action
.sa_flags
= 0;
638 sigemptyset(&sig_action
.sa_mask
);
640 for (i
= 1; i
< NSIG
; i
++) {
641 /* Only possible errors are EFAULT or EINVAL The former
642 * won't happen, the latter we expect, so no need to check
644 (void)sigaction(i
, &sig_action
, NULL
);
647 /* Unmask all signals in child, since we've no idea what the
648 * caller's done with their signal mask and don't want to
649 * propagate that to children */
650 sigemptyset(&newmask
);
651 if (pthread_sigmask(SIG_SETMASK
, &newmask
, NULL
) != 0) {
652 Error
*local_err
= NULL
;
653 error_setg_errno(&local_err
, errno
,
654 "cannot unblock signals");
655 error_report_err(local_err
);
662 void *qemu_alloc_stack(size_t *sz
)
664 void *ptr
, *guardpage
;
666 #ifdef CONFIG_DEBUG_STACK_USAGE
669 size_t pagesz
= qemu_real_host_page_size();
670 #ifdef _SC_THREAD_STACK_MIN
671 /* avoid stacks smaller than _SC_THREAD_STACK_MIN */
672 long min_stack_sz
= sysconf(_SC_THREAD_STACK_MIN
);
673 *sz
= MAX(MAX(min_stack_sz
, 0), *sz
);
675 /* adjust stack size to a multiple of the page size */
676 *sz
= ROUND_UP(*sz
, pagesz
);
677 /* allocate one extra page for the guard page */
680 flags
= MAP_PRIVATE
| MAP_ANONYMOUS
;
681 #if defined(MAP_STACK) && defined(__OpenBSD__)
682 /* Only enable MAP_STACK on OpenBSD. Other OS's such as
683 * Linux/FreeBSD/NetBSD have a flag with the same name
684 * but have differing functionality. OpenBSD will SEGV
685 * if it spots execution with a stack pointer pointing
686 * at memory that was not allocated with MAP_STACK.
691 ptr
= mmap(NULL
, *sz
, PROT_READ
| PROT_WRITE
, flags
, -1, 0);
692 if (ptr
== MAP_FAILED
) {
693 perror("failed to allocate memory for stack");
697 #if defined(HOST_IA64)
698 /* separate register stack */
699 guardpage
= ptr
+ (((*sz
- pagesz
) / 2) & ~pagesz
);
700 #elif defined(HOST_HPPA)
702 guardpage
= ptr
+ *sz
- pagesz
;
704 /* stack grows down */
707 if (mprotect(guardpage
, pagesz
, PROT_NONE
) != 0) {
708 perror("failed to set up stack guard page");
712 #ifdef CONFIG_DEBUG_STACK_USAGE
713 for (ptr2
= ptr
+ pagesz
; ptr2
< ptr
+ *sz
; ptr2
+= sizeof(uint32_t)) {
714 *(uint32_t *)ptr2
= 0xdeadbeaf;
721 #ifdef CONFIG_DEBUG_STACK_USAGE
722 static __thread
unsigned int max_stack_usage
;
725 void qemu_free_stack(void *stack
, size_t sz
)
727 #ifdef CONFIG_DEBUG_STACK_USAGE
731 for (ptr
= stack
+ qemu_real_host_page_size(); ptr
< stack
+ sz
;
732 ptr
+= sizeof(uint32_t)) {
733 if (*(uint32_t *)ptr
!= 0xdeadbeaf) {
737 usage
= sz
- (uintptr_t) (ptr
- stack
);
738 if (usage
> max_stack_usage
) {
739 error_report("thread %d max stack usage increased from %u to %u",
740 qemu_get_thread_id(), max_stack_usage
, usage
);
741 max_stack_usage
= usage
;
749 * Disable CFI checks.
750 * We are going to call a signal hander directly. Such handler may or may not
751 * have been defined in our binary, so there's no guarantee that the pointer
752 * used to set the handler is a cfi-valid pointer. Since the handlers are
753 * stored in kernel memory, changing the handler to an attacker-defined
754 * function requires being able to call a sigaction() syscall,
755 * which is not as easy as overwriting a pointer in memory.
758 void sigaction_invoke(struct sigaction
*action
,
759 struct qemu_signalfd_siginfo
*info
)
762 si
.si_signo
= info
->ssi_signo
;
763 si
.si_errno
= info
->ssi_errno
;
764 si
.si_code
= info
->ssi_code
;
766 /* Convert the minimal set of fields defined by POSIX.
767 * Positive si_code values are reserved for kernel-generated
768 * signals, where the valid siginfo fields are determined by
769 * the signal number. But according to POSIX, it is unspecified
770 * whether SI_USER and SI_QUEUE have values less than or equal to
773 if (info
->ssi_code
== SI_USER
|| info
->ssi_code
== SI_QUEUE
||
774 info
->ssi_code
<= 0) {
776 si
.si_pid
= info
->ssi_pid
;
777 si
.si_uid
= info
->ssi_uid
;
778 } else if (info
->ssi_signo
== SIGILL
|| info
->ssi_signo
== SIGFPE
||
779 info
->ssi_signo
== SIGSEGV
|| info
->ssi_signo
== SIGBUS
) {
780 si
.si_addr
= (void *)(uintptr_t)info
->ssi_addr
;
781 } else if (info
->ssi_signo
== SIGCHLD
) {
782 si
.si_pid
= info
->ssi_pid
;
783 si
.si_status
= info
->ssi_status
;
784 si
.si_uid
= info
->ssi_uid
;
786 action
->sa_sigaction(info
->ssi_signo
, &si
, NULL
);
789 size_t qemu_get_host_physmem(void)
791 #ifdef _SC_PHYS_PAGES
792 long pages
= sysconf(_SC_PHYS_PAGES
);
794 if (pages
> SIZE_MAX
/ qemu_real_host_page_size()) {
797 return pages
* qemu_real_host_page_size();
804 int qemu_msync(void *addr
, size_t length
, int fd
)
806 size_t align_mask
= ~(qemu_real_host_page_size() - 1);
809 * There are no strict reqs as per the length of mapping
810 * to be synced. Still the length needs to follow the address
811 * alignment changes. Additionally - round the size to the multiple
814 length
+= ((uintptr_t)addr
& (qemu_real_host_page_size() - 1));
815 length
= (length
+ ~align_mask
) & align_mask
;
817 addr
= (void *)((uintptr_t)addr
& align_mask
);
819 return msync(addr
, length
, MS_SYNC
);