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"
47 #include <sys/syscall.h>
51 #include <sys/sysctl.h>
58 #include <sys/sysctl.h>
63 #include <mach-o/dyld.h>
67 #include <kernel/image.h>
70 #include "qemu/mmap-alloc.h"
72 #ifdef CONFIG_DEBUG_STACK_USAGE
73 #include "qemu/error-report.h"
76 #define MAX_MEM_PREALLOC_THREAD_COUNT 16
80 typedef struct MemsetContext {
81 bool all_threads_created;
82 bool any_thread_failed;
83 struct MemsetThread *threads;
93 MemsetContext *context;
95 typedef struct MemsetThread MemsetThread;
97 /* used by sigbus_handler() */
98 static MemsetContext *sigbus_memset_context;
99 struct sigaction sigbus_oldact;
100 static QemuMutex sigbus_mutex;
102 static QemuMutex page_mutex;
103 static QemuCond page_cond;
105 int qemu_get_thread_id(void)
107 #if defined(__linux__)
108 return syscall(SYS_gettid);
109 #elif defined(__FreeBSD__)
110 /* thread id is up to INT_MAX */
114 #elif defined(__NetBSD__)
116 #elif defined(__OpenBSD__)
123 int qemu_daemon(int nochdir, int noclose)
125 return daemon(nochdir, noclose);
128 bool qemu_write_pidfile(const char *path, Error **errp)
135 struct flock lock = {
137 .l_whence = SEEK_SET,
141 fd = qemu_create(path, O_WRONLY, S_IRUSR | S_IWUSR, errp);
146 if (fstat(fd, &b) < 0) {
147 error_setg_errno(errp, errno, "Cannot stat file");
151 if (fcntl(fd, F_SETLK, &lock)) {
152 error_setg_errno(errp, errno, "Cannot lock pid file");
157 * Now make sure the path we locked is the same one that now
158 * exists on the filesystem.
160 if (stat(path, &a) < 0) {
162 * PID file disappeared, someone else must be racing with
169 if (a.st_ino == b.st_ino) {
174 * PID file was recreated, someone else must be racing with
180 if (ftruncate(fd, 0) < 0) {
181 error_setg_errno(errp, errno, "Failed to truncate pid file");
185 snprintf(pidstr, sizeof(pidstr), FMT_pid "\n", getpid());
186 if (qemu_write_full(fd, pidstr, strlen(pidstr)) != strlen(pidstr)) {
187 error_setg(errp, "Failed to write pid file");
200 /* alloc shared memory pages */
201 void *qemu_anon_ram_alloc(size_t size, uint64_t *alignment, bool shared,
204 const uint32_t qemu_map_flags = (shared ? QEMU_MAP_SHARED : 0) |
205 (noreserve ? QEMU_MAP_NORESERVE : 0);
206 size_t align = QEMU_VMALLOC_ALIGN;
207 void *ptr = qemu_ram_mmap(-1, size, align, qemu_map_flags, 0);
209 if (ptr == MAP_FAILED) {
217 trace_qemu_anon_ram_alloc(size, ptr);
221 void qemu_anon_ram_free(void *ptr, size_t size)
223 trace_qemu_anon_ram_free(ptr, size);
224 qemu_ram_munmap(-1, ptr, size);
227 void qemu_set_block(int fd)
230 f = fcntl(fd, F_GETFL);
232 f = fcntl(fd, F_SETFL, f & ~O_NONBLOCK);
236 int qemu_try_set_nonblock(int fd)
239 f = fcntl(fd, F_GETFL);
243 if (fcntl(fd, F_SETFL, f | O_NONBLOCK) == -1) {
249 void qemu_set_nonblock(int fd)
252 f = qemu_try_set_nonblock(fd);
256 int socket_set_fast_reuse(int fd)
260 ret = setsockopt(fd, SOL_SOCKET, SO_REUSEADDR,
261 (const char *)&val, sizeof(val));
268 void qemu_set_cloexec(int fd)
271 f = fcntl(fd, F_GETFD);
273 f = fcntl(fd, F_SETFD, f | FD_CLOEXEC);
278 qemu_get_local_state_dir(void)
280 return get_relocated_path(CONFIG_QEMU_LOCALSTATEDIR);
283 void qemu_set_tty_echo(int fd, bool echo)
290 tty.c_lflag |= ECHO | ECHONL | ICANON | IEXTEN;
292 tty.c_lflag &= ~(ECHO | ECHONL | ICANON | IEXTEN);
295 tcsetattr(fd, TCSANOW, &tty);
298 static const char *exec_dir;
300 void qemu_init_exec_dir(const char *argv0)
309 #if defined(__linux__)
312 len = readlink("/proc/self/exe", buf, sizeof(buf) - 1);
318 #elif defined(__FreeBSD__) \
319 || (defined(__NetBSD__) && defined(KERN_PROC_PATHNAME))
321 #if defined(__FreeBSD__)
322 static int mib[4] = {CTL_KERN, KERN_PROC, KERN_PROC_PATHNAME, -1};
324 static int mib[4] = {CTL_KERN, KERN_PROC_ARGS, -1, KERN_PROC_PATHNAME};
326 size_t len = sizeof(buf) - 1;
329 if (!sysctl(mib, ARRAY_SIZE(mib), buf, &len, NULL, 0) &&
331 buf[sizeof(buf) - 1] = '\0';
335 #elif defined(__APPLE__)
337 char fpath[PATH_MAX];
338 uint32_t len = sizeof(fpath);
339 if (_NSGetExecutablePath(fpath, &len) == 0) {
340 p = realpath(fpath, buf);
346 #elif defined(__HAIKU__)
352 while (get_next_image_info(0, &c, &ii) == B_OK) {
353 if (ii.type == B_APP_IMAGE) {
354 strncpy(buf, ii.name, sizeof(buf));
355 buf[sizeof(buf) - 1] = 0;
362 /* If we don't have any way of figuring out the actual executable
363 location then try argv[0]. */
365 p = realpath(argv0, buf);
368 exec_dir = g_path_get_dirname(p);
370 exec_dir = CONFIG_BINDIR;
374 const char *qemu_get_exec_dir(void)
380 static void sigbus_handler(int signal, siginfo_t *siginfo, void *ctx)
381 #else /* CONFIG_LINUX */
382 static void sigbus_handler(int signal)
383 #endif /* CONFIG_LINUX */
387 if (sigbus_memset_context) {
388 for (i = 0; i < sigbus_memset_context->num_threads; i++) {
389 MemsetThread *thread = &sigbus_memset_context->threads[i];
391 if (qemu_thread_is_self(&thread->pgthread)) {
392 siglongjmp(thread->env, 1);
399 * We assume that the MCE SIGBUS handler could have been registered. We
400 * should never receive BUS_MCEERR_AO on any of our threads, but only on
401 * the main thread registered for PR_MCE_KILL_EARLY. Further, we should not
402 * receive BUS_MCEERR_AR triggered by action of other threads on one of
403 * our threads. So, no need to check for unrelated SIGBUS when seeing one
406 * We will forward to the MCE handler, which will either handle the SIGBUS
407 * or reinstall the default SIGBUS handler and reraise the SIGBUS. The
408 * default SIGBUS handler will crash the process, so we don't care.
410 if (sigbus_oldact.sa_flags & SA_SIGINFO) {
411 sigbus_oldact.sa_sigaction(signal, siginfo, ctx);
414 #endif /* CONFIG_LINUX */
415 warn_report("os_mem_prealloc: unrelated SIGBUS detected and ignored");
418 static void *do_touch_pages(void *arg)
420 MemsetThread *memset_args = (MemsetThread *)arg;
421 sigset_t set, oldset;
425 * On Linux, the page faults from the loop below can cause mmap_sem
426 * contention with allocation of the thread stacks. Do not start
427 * clearing until all threads have been created.
429 qemu_mutex_lock(&page_mutex);
430 while (!memset_args->context->all_threads_created) {
431 qemu_cond_wait(&page_cond, &page_mutex);
433 qemu_mutex_unlock(&page_mutex);
437 sigaddset(&set, SIGBUS);
438 pthread_sigmask(SIG_UNBLOCK, &set, &oldset);
440 if (sigsetjmp(memset_args->env, 1)) {
443 char *addr = memset_args->addr;
444 size_t numpages = memset_args->numpages;
445 size_t hpagesize = memset_args->hpagesize;
447 for (i = 0; i < numpages; i++) {
449 * Read & write back the same value, so we don't
450 * corrupt existing user/app data that might be
453 * 'volatile' to stop compiler optimizing this away
456 *(volatile char *)addr = *addr;
460 pthread_sigmask(SIG_SETMASK, &oldset, NULL);
461 return (void *)(uintptr_t)ret;
464 static void *do_madv_populate_write_pages(void *arg)
466 MemsetThread *memset_args = (MemsetThread *)arg;
467 const size_t size = memset_args->numpages * memset_args->hpagesize;
468 char * const addr = memset_args->addr;
471 /* See do_touch_pages(). */
472 qemu_mutex_lock(&page_mutex);
473 while (!memset_args->context->all_threads_created) {
474 qemu_cond_wait(&page_cond, &page_mutex);
476 qemu_mutex_unlock(&page_mutex);
478 if (size && qemu_madvise(addr, size, QEMU_MADV_POPULATE_WRITE)) {
481 return (void *)(uintptr_t)ret;
484 static inline int get_memset_num_threads(size_t hpagesize, size_t numpages,
487 long host_procs = sysconf(_SC_NPROCESSORS_ONLN);
490 if (host_procs > 0) {
491 ret = MIN(MIN(host_procs, MAX_MEM_PREALLOC_THREAD_COUNT), smp_cpus);
494 /* Especially with gigantic pages, don't create more threads than pages. */
495 ret = MIN(ret, numpages);
496 /* Don't start threads to prealloc comparatively little memory. */
497 ret = MIN(ret, MAX(1, hpagesize * numpages / (64 * MiB)));
499 /* In case sysconf() fails, we fall back to single threaded */
503 static int touch_all_pages(char *area, size_t hpagesize, size_t numpages,
504 int smp_cpus, bool use_madv_populate_write)
506 static gsize initialized = 0;
507 MemsetContext context = {
508 .num_threads = get_memset_num_threads(hpagesize, numpages, smp_cpus),
510 size_t numpages_per_thread, leftover;
511 void *(*touch_fn)(void *);
515 if (g_once_init_enter(&initialized)) {
516 qemu_mutex_init(&page_mutex);
517 qemu_cond_init(&page_cond);
518 g_once_init_leave(&initialized, 1);
521 if (use_madv_populate_write) {
522 /* Avoid creating a single thread for MADV_POPULATE_WRITE */
523 if (context.num_threads == 1) {
524 if (qemu_madvise(area, hpagesize * numpages,
525 QEMU_MADV_POPULATE_WRITE)) {
530 touch_fn = do_madv_populate_write_pages;
532 touch_fn = do_touch_pages;
535 context.threads = g_new0(MemsetThread, context.num_threads);
536 numpages_per_thread = numpages / context.num_threads;
537 leftover = numpages % context.num_threads;
538 for (i = 0; i < context.num_threads; i++) {
539 context.threads[i].addr = addr;
540 context.threads[i].numpages = numpages_per_thread + (i < leftover);
541 context.threads[i].hpagesize = hpagesize;
542 context.threads[i].context = &context;
543 qemu_thread_create(&context.threads[i].pgthread, "touch_pages",
544 touch_fn, &context.threads[i],
545 QEMU_THREAD_JOINABLE);
546 addr += context.threads[i].numpages * hpagesize;
549 if (!use_madv_populate_write) {
550 sigbus_memset_context = &context;
553 qemu_mutex_lock(&page_mutex);
554 context.all_threads_created = true;
555 qemu_cond_broadcast(&page_cond);
556 qemu_mutex_unlock(&page_mutex);
558 for (i = 0; i < context.num_threads; i++) {
559 int tmp = (uintptr_t)qemu_thread_join(&context.threads[i].pgthread);
566 if (!use_madv_populate_write) {
567 sigbus_memset_context = NULL;
569 g_free(context.threads);
574 static bool madv_populate_write_possible(char *area, size_t pagesize)
576 return !qemu_madvise(area, pagesize, QEMU_MADV_POPULATE_WRITE) ||
580 void os_mem_prealloc(int fd, char *area, size_t memory, int smp_cpus,
583 static gsize initialized;
585 size_t hpagesize = qemu_fd_getpagesize(fd);
586 size_t numpages = DIV_ROUND_UP(memory, hpagesize);
587 bool use_madv_populate_write;
588 struct sigaction act;
591 * Sense on every invocation, as MADV_POPULATE_WRITE cannot be used for
592 * some special mappings, such as mapping /dev/mem.
594 use_madv_populate_write = madv_populate_write_possible(area, hpagesize);
596 if (!use_madv_populate_write) {
597 if (g_once_init_enter(&initialized)) {
598 qemu_mutex_init(&sigbus_mutex);
599 g_once_init_leave(&initialized, 1);
602 qemu_mutex_lock(&sigbus_mutex);
603 memset(&act, 0, sizeof(act));
605 act.sa_sigaction = &sigbus_handler;
606 act.sa_flags = SA_SIGINFO;
607 #else /* CONFIG_LINUX */
608 act.sa_handler = &sigbus_handler;
610 #endif /* CONFIG_LINUX */
612 ret = sigaction(SIGBUS, &act, &sigbus_oldact);
614 qemu_mutex_unlock(&sigbus_mutex);
615 error_setg_errno(errp, errno,
616 "os_mem_prealloc: failed to install signal handler");
621 /* touch pages simultaneously */
622 ret = touch_all_pages(area, hpagesize, numpages, smp_cpus,
623 use_madv_populate_write);
625 error_setg_errno(errp, -ret,
626 "os_mem_prealloc: preallocating memory failed");
629 if (!use_madv_populate_write) {
630 ret = sigaction(SIGBUS, &sigbus_oldact, NULL);
632 /* Terminate QEMU since it can't recover from error */
633 perror("os_mem_prealloc: failed to reinstall signal handler");
636 qemu_mutex_unlock(&sigbus_mutex);
640 char *qemu_get_pid_name(pid_t pid)
644 #if defined(__FreeBSD__)
645 /* BSDs don't have /proc, but they provide a nice substitute */
646 struct kinfo_proc *proc = kinfo_getproc(pid);
649 name = g_strdup(proc->ki_comm);
653 /* Assume a system with reasonable procfs */
657 pid_path = g_strdup_printf("/proc/%d/cmdline", pid);
658 g_file_get_contents(pid_path, &name, &len, NULL);
666 pid_t qemu_fork(Error **errp)
668 sigset_t oldmask, newmask;
669 struct sigaction sig_action;
674 * Need to block signals now, so that child process can safely
675 * kill off caller's signal handlers without a race.
677 sigfillset(&newmask);
678 if (pthread_sigmask(SIG_SETMASK, &newmask, &oldmask) != 0) {
679 error_setg_errno(errp, errno,
680 "cannot block signals");
688 /* attempt to restore signal mask, but ignore failure, to
689 * avoid obscuring the fork failure */
690 (void)pthread_sigmask(SIG_SETMASK, &oldmask, NULL);
691 error_setg_errno(errp, saved_errno,
692 "cannot fork child process");
698 /* Restore our original signal mask now that the child is
699 * safely running. Only documented failures are EFAULT (not
700 * possible, since we are using just-grabbed mask) or EINVAL
701 * (not possible, since we are using correct arguments). */
702 (void)pthread_sigmask(SIG_SETMASK, &oldmask, NULL);
707 /* Clear out all signal handlers from parent so nothing
708 * unexpected can happen in our child once we unblock
710 sig_action.sa_handler = SIG_DFL;
711 sig_action.sa_flags = 0;
712 sigemptyset(&sig_action.sa_mask);
714 for (i = 1; i < NSIG; i++) {
715 /* Only possible errors are EFAULT or EINVAL The former
716 * won't happen, the latter we expect, so no need to check
718 (void)sigaction(i, &sig_action, NULL);
721 /* Unmask all signals in child, since we've no idea what the
722 * caller's done with their signal mask and don't want to
723 * propagate that to children */
724 sigemptyset(&newmask);
725 if (pthread_sigmask(SIG_SETMASK, &newmask, NULL) != 0) {
726 Error *local_err = NULL;
727 error_setg_errno(&local_err, errno,
728 "cannot unblock signals");
729 error_report_err(local_err);
736 void *qemu_alloc_stack(size_t *sz)
738 void *ptr, *guardpage;
740 #ifdef CONFIG_DEBUG_STACK_USAGE
743 size_t pagesz = qemu_real_host_page_size();
744 #ifdef _SC_THREAD_STACK_MIN
745 /* avoid stacks smaller than _SC_THREAD_STACK_MIN */
746 long min_stack_sz = sysconf(_SC_THREAD_STACK_MIN);
747 *sz = MAX(MAX(min_stack_sz, 0), *sz);
749 /* adjust stack size to a multiple of the page size */
750 *sz = ROUND_UP(*sz, pagesz);
751 /* allocate one extra page for the guard page */
754 flags = MAP_PRIVATE | MAP_ANONYMOUS;
755 #if defined(MAP_STACK) && defined(__OpenBSD__)
756 /* Only enable MAP_STACK on OpenBSD. Other OS's such as
757 * Linux/FreeBSD/NetBSD have a flag with the same name
758 * but have differing functionality. OpenBSD will SEGV
759 * if it spots execution with a stack pointer pointing
760 * at memory that was not allocated with MAP_STACK.
765 ptr = mmap(NULL, *sz, PROT_READ | PROT_WRITE, flags, -1, 0);
766 if (ptr == MAP_FAILED) {
767 perror("failed to allocate memory for stack");
771 #if defined(HOST_IA64)
772 /* separate register stack */
773 guardpage = ptr + (((*sz - pagesz) / 2) & ~pagesz);
774 #elif defined(HOST_HPPA)
776 guardpage = ptr + *sz - pagesz;
778 /* stack grows down */
781 if (mprotect(guardpage, pagesz, PROT_NONE) != 0) {
782 perror("failed to set up stack guard page");
786 #ifdef CONFIG_DEBUG_STACK_USAGE
787 for (ptr2 = ptr + pagesz; ptr2 < ptr + *sz; ptr2 += sizeof(uint32_t)) {
788 *(uint32_t *)ptr2 = 0xdeadbeaf;
795 #ifdef CONFIG_DEBUG_STACK_USAGE
796 static __thread unsigned int max_stack_usage;
799 void qemu_free_stack(void *stack, size_t sz)
801 #ifdef CONFIG_DEBUG_STACK_USAGE
805 for (ptr = stack + qemu_real_host_page_size(); ptr < stack + sz;
806 ptr += sizeof(uint32_t)) {
807 if (*(uint32_t *)ptr != 0xdeadbeaf) {
811 usage = sz - (uintptr_t) (ptr - stack);
812 if (usage > max_stack_usage) {
813 error_report("thread %d max stack usage increased from %u to %u",
814 qemu_get_thread_id(), max_stack_usage, usage);
815 max_stack_usage = usage;
823 * Disable CFI checks.
824 * We are going to call a signal hander directly. Such handler may or may not
825 * have been defined in our binary, so there's no guarantee that the pointer
826 * used to set the handler is a cfi-valid pointer. Since the handlers are
827 * stored in kernel memory, changing the handler to an attacker-defined
828 * function requires being able to call a sigaction() syscall,
829 * which is not as easy as overwriting a pointer in memory.
832 void sigaction_invoke(struct sigaction *action,
833 struct qemu_signalfd_siginfo *info)
836 si.si_signo = info->ssi_signo;
837 si.si_errno = info->ssi_errno;
838 si.si_code = info->ssi_code;
840 /* Convert the minimal set of fields defined by POSIX.
841 * Positive si_code values are reserved for kernel-generated
842 * signals, where the valid siginfo fields are determined by
843 * the signal number. But according to POSIX, it is unspecified
844 * whether SI_USER and SI_QUEUE have values less than or equal to
847 if (info->ssi_code == SI_USER || info->ssi_code == SI_QUEUE ||
848 info->ssi_code <= 0) {
850 si.si_pid = info->ssi_pid;
851 si.si_uid = info->ssi_uid;
852 } else if (info->ssi_signo == SIGILL || info->ssi_signo == SIGFPE ||
853 info->ssi_signo == SIGSEGV || info->ssi_signo == SIGBUS) {
854 si.si_addr = (void *)(uintptr_t)info->ssi_addr;
855 } else if (info->ssi_signo == SIGCHLD) {
856 si.si_pid = info->ssi_pid;
857 si.si_status = info->ssi_status;
858 si.si_uid = info->ssi_uid;
860 action->sa_sigaction(info->ssi_signo, &si, NULL);
863 size_t qemu_get_host_physmem(void)
865 #ifdef _SC_PHYS_PAGES
866 long pages = sysconf(_SC_PHYS_PAGES);
868 if (pages > SIZE_MAX / qemu_real_host_page_size()) {
871 return pages * qemu_real_host_page_size();
878 int qemu_msync(void *addr, size_t length, int fd)
880 size_t align_mask = ~(qemu_real_host_page_size() - 1);
883 * There are no strict reqs as per the length of mapping
884 * to be synced. Still the length needs to follow the address
885 * alignment changes. Additionally - round the size to the multiple
888 length += ((uintptr_t)addr & (qemu_real_host_page_size() - 1));
889 length = (length + ~align_mask) & align_mask;
891 addr = (void *)((uintptr_t)addr & align_mask);
893 return msync(addr, length, MS_SYNC);