blob: 827a7aadba444cdb128284f5b4ba43934c78c3db [file] [log] [blame]
Jes Sorensenc1b0b932010-10-26 10:39:19 +02001/*
2 * os-posix-lib.c
3 *
4 * Copyright (c) 2003-2008 Fabrice Bellard
5 * Copyright (c) 2010 Red Hat, Inc.
6 *
7 * QEMU library functions on POSIX which are shared between QEMU and
8 * the QEMU tools.
9 *
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:
16 *
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
19 *
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
26 * THE SOFTWARE.
27 */
28
Peter Maydellaafd7582016-01-29 17:49:55 +000029#include "qemu/osdep.h"
Stefan Hajnoczi13401ba2013-11-14 11:54:16 +010030#include <termios.h>
Stefan Hajnoczi13401ba2013-11-14 11:54:16 +010031
Laszlo Erseke2ea3512013-05-18 06:31:48 +020032#include <glib/gprintf.h>
33
Paolo Bonzini9c17d612012-12-17 18:20:04 +010034#include "sysemu/sysemu.h"
Jes Sorensenc1b0b932010-10-26 10:39:19 +020035#include "trace.h"
Markus Armbrusterda34e652016-03-14 09:01:28 +010036#include "qapi/error.h"
David Hildenbrand29b838c2021-12-17 14:46:10 +010037#include "qemu/error-report.h"
Peter Maydellb85ea5f2022-02-08 20:08:52 +000038#include "qemu/madvise.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010039#include "qemu/sockets.h"
Markus Armbrusterdb725812019-08-12 07:23:50 +020040#include "qemu/thread.h"
Fam Zheng10f5bff2014-02-10 14:48:51 +080041#include <libgen.h>
Veronia Bahaaf348b6d2016-03-20 19:16:19 +020042#include "qemu/cutils.h"
Daniele Buonoc905a362020-12-04 18:06:12 -050043#include "qemu/compiler.h"
David Hildenbrand89aec642021-12-17 14:46:07 +010044#include "qemu/units.h"
Jes Sorensenc1b0b932010-10-26 10:39:19 +020045
Paolo Bonzinicbcfa042011-09-12 16:20:11 +020046#ifdef CONFIG_LINUX
47#include <sys/syscall.h>
48#endif
Paolo Bonzinicbcfa042011-09-12 16:20:11 +020049
Andreas Färber41975b22014-03-13 14:27:59 +010050#ifdef __FreeBSD__
David Carlier9548a892020-05-26 08:25:26 +010051#include <sys/thr.h>
Marc-André Lureau06680b12022-05-25 16:41:26 +020052#include <sys/types.h>
53#include <sys/user.h>
Michal Privoznik7dc9ae42016-09-27 17:24:56 +020054#include <libutil.h>
Andreas Färber41975b22014-03-13 14:27:59 +010055#endif
56
Kamil Rytarowski094611b2017-10-28 21:48:33 +020057#ifdef __NetBSD__
David Carlier9548a892020-05-26 08:25:26 +010058#include <lwp.h>
Kamil Rytarowski094611b2017-10-28 21:48:33 +020059#endif
60
Markus Armbrustera9c94272016-06-22 19:11:19 +020061#include "qemu/mmap-alloc.h"
Michael S. Tsirkin794e8f32015-09-24 14:41:17 +030062
Peter Lieven7d992e42016-09-27 11:58:45 +020063#ifdef CONFIG_DEBUG_STACK_USAGE
64#include "qemu/error-report.h"
65#endif
66
Jitendra Kolhedfd0dcc2017-03-21 02:50:06 -040067#define MAX_MEM_PREALLOC_THREAD_COUNT 16
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +053068
David Hildenbranddba50672021-12-17 14:46:06 +010069struct MemsetThread;
70
71typedef struct MemsetContext {
72 bool all_threads_created;
73 bool any_thread_failed;
74 struct MemsetThread *threads;
75 int num_threads;
76} MemsetContext;
77
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +053078struct MemsetThread {
79 char *addr;
Stefan Weile947d472017-10-16 22:29:12 +020080 size_t numpages;
81 size_t hpagesize;
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +053082 QemuThread pgthread;
83 sigjmp_buf env;
David Hildenbranddba50672021-12-17 14:46:06 +010084 MemsetContext *context;
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +053085};
86typedef struct MemsetThread MemsetThread;
87
David Hildenbranddba50672021-12-17 14:46:06 +010088/* used by sigbus_handler() */
89static MemsetContext *sigbus_memset_context;
David Hildenbrand29b838c2021-12-17 14:46:10 +010090struct sigaction sigbus_oldact;
David Hildenbranda960d662021-12-17 14:46:09 +010091static QemuMutex sigbus_mutex;
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +053092
bauerchen037fb5e2020-02-11 17:10:35 +080093static QemuMutex page_mutex;
94static QemuCond page_cond;
bauerchen037fb5e2020-02-11 17:10:35 +080095
Paolo Bonzinicbcfa042011-09-12 16:20:11 +020096int qemu_get_thread_id(void)
97{
98#if defined(__linux__)
99 return syscall(SYS_gettid);
David Carlier9548a892020-05-26 08:25:26 +0100100#elif defined(__FreeBSD__)
101 /* thread id is up to INT_MAX */
102 long tid;
103 thr_self(&tid);
104 return (int)tid;
105#elif defined(__NetBSD__)
106 return _lwp_self();
David CARLIER8edbca52020-07-20 10:25:36 +0100107#elif defined(__OpenBSD__)
108 return getthrid();
Paolo Bonzinicbcfa042011-09-12 16:20:11 +0200109#else
110 return getpid();
111#endif
112}
Alexandre Raymondf97742d2011-06-06 23:34:10 -0400113
114int qemu_daemon(int nochdir, int noclose)
115{
116 return daemon(nochdir, noclose);
117}
118
Marc-André Lureau9e6bdef2018-08-31 16:53:12 +0200119bool qemu_write_pidfile(const char *path, Error **errp)
120{
121 int fd;
122 char pidstr[32];
123
124 while (1) {
125 struct stat a, b;
Marc-André Lureau35f7f3f2018-08-31 16:53:13 +0200126 struct flock lock = {
127 .l_type = F_WRLCK,
128 .l_whence = SEEK_SET,
129 .l_len = 0,
130 };
Marc-André Lureau9e6bdef2018-08-31 16:53:12 +0200131
Marc-André Lureau1b34d082022-04-20 17:26:20 +0400132 fd = qemu_create(path, O_WRONLY, S_IRUSR | S_IWUSR, errp);
Marc-André Lureau9e6bdef2018-08-31 16:53:12 +0200133 if (fd == -1) {
Marc-André Lureau9e6bdef2018-08-31 16:53:12 +0200134 return false;
135 }
136
137 if (fstat(fd, &b) < 0) {
138 error_setg_errno(errp, errno, "Cannot stat file");
139 goto fail_close;
140 }
141
Marc-André Lureau35f7f3f2018-08-31 16:53:13 +0200142 if (fcntl(fd, F_SETLK, &lock)) {
Marc-André Lureau9e6bdef2018-08-31 16:53:12 +0200143 error_setg_errno(errp, errno, "Cannot lock pid file");
144 goto fail_close;
145 }
146
147 /*
148 * Now make sure the path we locked is the same one that now
149 * exists on the filesystem.
150 */
151 if (stat(path, &a) < 0) {
152 /*
153 * PID file disappeared, someone else must be racing with
154 * us, so try again.
155 */
156 close(fd);
157 continue;
158 }
159
160 if (a.st_ino == b.st_ino) {
161 break;
162 }
163
164 /*
165 * PID file was recreated, someone else must be racing with
166 * us, so try again.
167 */
168 close(fd);
169 }
170
171 if (ftruncate(fd, 0) < 0) {
172 error_setg_errno(errp, errno, "Failed to truncate pid file");
173 goto fail_unlink;
174 }
175
176 snprintf(pidstr, sizeof(pidstr), FMT_pid "\n", getpid());
Marc-André Lureau96eb9b22022-04-20 17:26:19 +0400177 if (qemu_write_full(fd, pidstr, strlen(pidstr)) != strlen(pidstr)) {
Marc-André Lureau9e6bdef2018-08-31 16:53:12 +0200178 error_setg(errp, "Failed to write pid file");
179 goto fail_unlink;
180 }
181
182 return true;
183
184fail_unlink:
185 unlink(path);
186fail_close:
187 close(fd);
188 return false;
189}
190
Jes Sorensenc1b0b932010-10-26 10:39:19 +0200191/* alloc shared memory pages */
David Hildenbrand8dbe22c2021-05-10 13:43:21 +0200192void *qemu_anon_ram_alloc(size_t size, uint64_t *alignment, bool shared,
193 bool noreserve)
Jes Sorensenc1b0b932010-10-26 10:39:19 +0200194{
David Hildenbrand8dbe22c2021-05-10 13:43:21 +0200195 const uint32_t qemu_map_flags = (shared ? QEMU_MAP_SHARED : 0) |
196 (noreserve ? QEMU_MAP_NORESERVE : 0);
Avi Kivity36b58622011-09-05 11:07:05 +0300197 size_t align = QEMU_VMALLOC_ALIGN;
David Hildenbrandb444f5c2021-05-10 13:43:20 +0200198 void *ptr = qemu_ram_mmap(-1, size, align, qemu_map_flags, 0);
Avi Kivity36b58622011-09-05 11:07:05 +0300199
Paolo Bonzini7dda5dc2013-04-09 17:43:43 +0200200 if (ptr == MAP_FAILED) {
Markus Armbruster39228252013-07-31 15:11:11 +0200201 return NULL;
Stefan Weilc2a82382011-10-31 21:29:46 +0100202 }
Stefan Weilc2a82382011-10-31 21:29:46 +0100203
Igor Mammedova2b257d2014-10-31 16:38:37 +0000204 if (alignment) {
205 *alignment = align;
206 }
Michael S. Tsirkinc2dfc5b2015-09-10 16:36:51 +0300207
Paolo Bonzini6eebf952013-05-13 16:19:55 +0200208 trace_qemu_anon_ram_alloc(size, ptr);
Jes Sorensenc7f41112011-07-25 17:13:36 +0200209 return ptr;
Jes Sorensenc1b0b932010-10-26 10:39:19 +0200210}
211
Paolo Bonzinie7a09b92013-05-13 16:19:56 +0200212void qemu_anon_ram_free(void *ptr, size_t size)
213{
214 trace_qemu_anon_ram_free(ptr, size);
Murilo Opsfelder Araujo53adb9d2019-01-30 21:36:05 -0200215 qemu_ram_munmap(-1, ptr, size);
Paolo Bonzinie7a09b92013-05-13 16:19:56 +0200216}
217
Marc-André Lureauff5927b2022-04-25 17:33:47 +0400218void qemu_socket_set_block(int fd)
Paolo Bonzini154b9a02011-10-05 09:17:32 +0200219{
Marc-André Lureau22e135f2022-04-25 11:56:42 +0400220 g_unix_set_fd_nonblocking(fd, false, NULL);
Paolo Bonzini154b9a02011-10-05 09:17:32 +0200221}
222
Marc-André Lureauff5927b2022-04-25 17:33:47 +0400223int qemu_socket_try_set_nonblock(int fd)
Jes Sorensen9549e762010-10-26 10:39:20 +0200224{
Marc-André Lureau22e135f2022-04-25 11:56:42 +0400225 return g_unix_set_fd_nonblocking(fd, true, NULL) ? 0 : -errno;
Laurent Vivier894022e2020-07-07 20:45:14 +0200226}
227
Marc-André Lureauff5927b2022-04-25 17:33:47 +0400228void qemu_socket_set_nonblock(int fd)
Laurent Vivier894022e2020-07-07 20:45:14 +0200229{
230 int f;
Marc-André Lureauff5927b2022-04-25 17:33:47 +0400231 f = qemu_socket_try_set_nonblock(fd);
Laurent Vivier894022e2020-07-07 20:45:14 +0200232 assert(f == 0);
Jes Sorensen9549e762010-10-26 10:39:20 +0200233}
234
Sebastian Ottlik606600a2013-10-02 12:23:12 +0200235int socket_set_fast_reuse(int fd)
236{
237 int val = 1, ret;
238
239 ret = setsockopt(fd, SOL_SOCKET, SO_REUSEADDR,
240 (const char *)&val, sizeof(val));
241
242 assert(ret == 0);
243
244 return ret;
245}
246
Jes Sorensen9549e762010-10-26 10:39:20 +0200247void qemu_set_cloexec(int fd)
248{
249 int f;
250 f = fcntl(fd, F_GETFD);
Stefano Stabellini7e6478e2017-05-09 12:04:52 -0700251 assert(f != -1);
252 f = fcntl(fd, F_SETFD, f | FD_CLOEXEC);
253 assert(f != -1);
Jes Sorensen9549e762010-10-26 10:39:20 +0200254}
Jes Sorensen70e72ce2010-10-26 10:39:21 +0200255
Guoyi Tu3c63b4e2022-08-23 15:50:39 +0800256int qemu_socketpair(int domain, int type, int protocol, int sv[2])
257{
258 int ret;
259
260#ifdef SOCK_CLOEXEC
261 ret = socketpair(domain, type | SOCK_CLOEXEC, protocol, sv);
262 if (ret != -1 || errno != EINVAL) {
263 return ret;
264 }
265#endif
266 ret = socketpair(domain, type, protocol, sv);;
267 if (ret == 0) {
268 qemu_set_cloexec(sv[0]);
269 qemu_set_cloexec(sv[1]);
270 }
271
272 return ret;
273}
274
Laszlo Erseke2ea3512013-05-18 06:31:48 +0200275char *
Marc-André Lureau1fbf2662022-04-20 17:26:21 +0400276qemu_get_local_state_dir(void)
Laszlo Erseke2ea3512013-05-18 06:31:48 +0200277{
Marc-André Lureau1fbf2662022-04-20 17:26:21 +0400278 return get_relocated_path(CONFIG_QEMU_LOCALSTATEDIR);
Laszlo Erseke2ea3512013-05-18 06:31:48 +0200279}
Stefan Hajnoczi13401ba2013-11-14 11:54:16 +0100280
281void qemu_set_tty_echo(int fd, bool echo)
282{
283 struct termios tty;
284
285 tcgetattr(fd, &tty);
286
287 if (echo) {
288 tty.c_lflag |= ECHO | ECHONL | ICANON | IEXTEN;
289 } else {
290 tty.c_lflag &= ~(ECHO | ECHONL | ICANON | IEXTEN);
291 }
292
293 tcsetattr(fd, TCSANOW, &tty);
294}
Fam Zheng10f5bff2014-02-10 14:48:51 +0800295
David Hildenbrand29b838c2021-12-17 14:46:10 +0100296#ifdef CONFIG_LINUX
297static void sigbus_handler(int signal, siginfo_t *siginfo, void *ctx)
298#else /* CONFIG_LINUX */
Paolo Bonzini38183312014-05-14 17:43:21 +0800299static void sigbus_handler(int signal)
David Hildenbrand29b838c2021-12-17 14:46:10 +0100300#endif /* CONFIG_LINUX */
Paolo Bonzini38183312014-05-14 17:43:21 +0800301{
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +0530302 int i;
David Hildenbranddba50672021-12-17 14:46:06 +0100303
304 if (sigbus_memset_context) {
305 for (i = 0; i < sigbus_memset_context->num_threads; i++) {
306 MemsetThread *thread = &sigbus_memset_context->threads[i];
307
308 if (qemu_thread_is_self(&thread->pgthread)) {
309 siglongjmp(thread->env, 1);
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +0530310 }
311 }
312 }
David Hildenbrand29b838c2021-12-17 14:46:10 +0100313
314#ifdef CONFIG_LINUX
315 /*
316 * We assume that the MCE SIGBUS handler could have been registered. We
317 * should never receive BUS_MCEERR_AO on any of our threads, but only on
318 * the main thread registered for PR_MCE_KILL_EARLY. Further, we should not
319 * receive BUS_MCEERR_AR triggered by action of other threads on one of
320 * our threads. So, no need to check for unrelated SIGBUS when seeing one
321 * for our threads.
322 *
323 * We will forward to the MCE handler, which will either handle the SIGBUS
324 * or reinstall the default SIGBUS handler and reraise the SIGBUS. The
325 * default SIGBUS handler will crash the process, so we don't care.
326 */
327 if (sigbus_oldact.sa_flags & SA_SIGINFO) {
328 sigbus_oldact.sa_sigaction(signal, siginfo, ctx);
329 return;
330 }
331#endif /* CONFIG_LINUX */
332 warn_report("os_mem_prealloc: unrelated SIGBUS detected and ignored");
Paolo Bonzini38183312014-05-14 17:43:21 +0800333}
334
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +0530335static void *do_touch_pages(void *arg)
336{
337 MemsetThread *memset_args = (MemsetThread *)arg;
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +0530338 sigset_t set, oldset;
David Hildenbrand6c427ab2021-12-17 14:46:04 +0100339 int ret = 0;
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +0530340
bauerchen037fb5e2020-02-11 17:10:35 +0800341 /*
342 * On Linux, the page faults from the loop below can cause mmap_sem
343 * contention with allocation of the thread stacks. Do not start
344 * clearing until all threads have been created.
345 */
346 qemu_mutex_lock(&page_mutex);
David Hildenbranddba50672021-12-17 14:46:06 +0100347 while (!memset_args->context->all_threads_created) {
bauerchen037fb5e2020-02-11 17:10:35 +0800348 qemu_cond_wait(&page_cond, &page_mutex);
349 }
350 qemu_mutex_unlock(&page_mutex);
351
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +0530352 /* unblock SIGBUS */
353 sigemptyset(&set);
354 sigaddset(&set, SIGBUS);
355 pthread_sigmask(SIG_UNBLOCK, &set, &oldset);
356
357 if (sigsetjmp(memset_args->env, 1)) {
David Hildenbrand6c427ab2021-12-17 14:46:04 +0100358 ret = -EFAULT;
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +0530359 } else {
Stefan Weile947d472017-10-16 22:29:12 +0200360 char *addr = memset_args->addr;
361 size_t numpages = memset_args->numpages;
362 size_t hpagesize = memset_args->hpagesize;
363 size_t i;
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +0530364 for (i = 0; i < numpages; i++) {
Daniel P. Berrange9dc44aa2017-03-03 11:32:55 +0000365 /*
366 * Read & write back the same value, so we don't
367 * corrupt existing user/app data that might be
368 * stored.
369 *
370 * 'volatile' to stop compiler optimizing this away
371 * to a no-op
Daniel P. Berrange9dc44aa2017-03-03 11:32:55 +0000372 */
373 *(volatile char *)addr = *addr;
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +0530374 addr += hpagesize;
375 }
376 }
377 pthread_sigmask(SIG_SETMASK, &oldset, NULL);
David Hildenbrand6c427ab2021-12-17 14:46:04 +0100378 return (void *)(uintptr_t)ret;
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +0530379}
380
David Hildenbranda384bfa2021-12-17 14:46:05 +0100381static void *do_madv_populate_write_pages(void *arg)
382{
383 MemsetThread *memset_args = (MemsetThread *)arg;
384 const size_t size = memset_args->numpages * memset_args->hpagesize;
385 char * const addr = memset_args->addr;
386 int ret = 0;
387
388 /* See do_touch_pages(). */
389 qemu_mutex_lock(&page_mutex);
David Hildenbranddba50672021-12-17 14:46:06 +0100390 while (!memset_args->context->all_threads_created) {
David Hildenbranda384bfa2021-12-17 14:46:05 +0100391 qemu_cond_wait(&page_cond, &page_mutex);
392 }
393 qemu_mutex_unlock(&page_mutex);
394
395 if (size && qemu_madvise(addr, size, QEMU_MADV_POPULATE_WRITE)) {
396 ret = -errno;
397 }
398 return (void *)(uintptr_t)ret;
399}
400
David Hildenbrand89aec642021-12-17 14:46:07 +0100401static inline int get_memset_num_threads(size_t hpagesize, size_t numpages,
402 int smp_cpus)
Jitendra Kolhedfd0dcc2017-03-21 02:50:06 -0400403{
404 long host_procs = sysconf(_SC_NPROCESSORS_ONLN);
405 int ret = 1;
406
407 if (host_procs > 0) {
408 ret = MIN(MIN(host_procs, MAX_MEM_PREALLOC_THREAD_COUNT), smp_cpus);
409 }
David Hildenbrand89aec642021-12-17 14:46:07 +0100410
411 /* Especially with gigantic pages, don't create more threads than pages. */
412 ret = MIN(ret, numpages);
413 /* Don't start threads to prealloc comparatively little memory. */
414 ret = MIN(ret, MAX(1, hpagesize * numpages / (64 * MiB)));
415
Jitendra Kolhedfd0dcc2017-03-21 02:50:06 -0400416 /* In case sysconf() fails, we fall back to single threaded */
417 return ret;
418}
419
David Hildenbrand6c427ab2021-12-17 14:46:04 +0100420static int touch_all_pages(char *area, size_t hpagesize, size_t numpages,
David Hildenbranda384bfa2021-12-17 14:46:05 +0100421 int smp_cpus, bool use_madv_populate_write)
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +0530422{
Paolo Bonzini78b3f672020-03-10 18:58:30 +0100423 static gsize initialized = 0;
David Hildenbranddba50672021-12-17 14:46:06 +0100424 MemsetContext context = {
David Hildenbrand89aec642021-12-17 14:46:07 +0100425 .num_threads = get_memset_num_threads(hpagesize, numpages, smp_cpus),
David Hildenbranddba50672021-12-17 14:46:06 +0100426 };
bauerchen037fb5e2020-02-11 17:10:35 +0800427 size_t numpages_per_thread, leftover;
David Hildenbranda384bfa2021-12-17 14:46:05 +0100428 void *(*touch_fn)(void *);
David Hildenbrand6c427ab2021-12-17 14:46:04 +0100429 int ret = 0, i = 0;
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +0530430 char *addr = area;
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +0530431
Paolo Bonzini78b3f672020-03-10 18:58:30 +0100432 if (g_once_init_enter(&initialized)) {
433 qemu_mutex_init(&page_mutex);
434 qemu_cond_init(&page_cond);
435 g_once_init_leave(&initialized, 1);
436 }
437
David Hildenbranda384bfa2021-12-17 14:46:05 +0100438 if (use_madv_populate_write) {
David Hildenbrandac86e5c2021-12-17 14:46:08 +0100439 /* Avoid creating a single thread for MADV_POPULATE_WRITE */
440 if (context.num_threads == 1) {
441 if (qemu_madvise(area, hpagesize * numpages,
442 QEMU_MADV_POPULATE_WRITE)) {
443 return -errno;
444 }
445 return 0;
446 }
David Hildenbranda384bfa2021-12-17 14:46:05 +0100447 touch_fn = do_madv_populate_write_pages;
448 } else {
449 touch_fn = do_touch_pages;
450 }
451
David Hildenbranddba50672021-12-17 14:46:06 +0100452 context.threads = g_new0(MemsetThread, context.num_threads);
453 numpages_per_thread = numpages / context.num_threads;
454 leftover = numpages % context.num_threads;
455 for (i = 0; i < context.num_threads; i++) {
456 context.threads[i].addr = addr;
457 context.threads[i].numpages = numpages_per_thread + (i < leftover);
458 context.threads[i].hpagesize = hpagesize;
459 context.threads[i].context = &context;
460 qemu_thread_create(&context.threads[i].pgthread, "touch_pages",
461 touch_fn, &context.threads[i],
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +0530462 QEMU_THREAD_JOINABLE);
David Hildenbranddba50672021-12-17 14:46:06 +0100463 addr += context.threads[i].numpages * hpagesize;
464 }
465
466 if (!use_madv_populate_write) {
467 sigbus_memset_context = &context;
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +0530468 }
Bauerchen278fb162020-04-06 10:36:54 +0800469
470 qemu_mutex_lock(&page_mutex);
David Hildenbranddba50672021-12-17 14:46:06 +0100471 context.all_threads_created = true;
bauerchen037fb5e2020-02-11 17:10:35 +0800472 qemu_cond_broadcast(&page_cond);
Bauerchen278fb162020-04-06 10:36:54 +0800473 qemu_mutex_unlock(&page_mutex);
bauerchen037fb5e2020-02-11 17:10:35 +0800474
David Hildenbranddba50672021-12-17 14:46:06 +0100475 for (i = 0; i < context.num_threads; i++) {
476 int tmp = (uintptr_t)qemu_thread_join(&context.threads[i].pgthread);
David Hildenbrand6c427ab2021-12-17 14:46:04 +0100477
478 if (tmp) {
479 ret = tmp;
480 }
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +0530481 }
David Hildenbranddba50672021-12-17 14:46:06 +0100482
483 if (!use_madv_populate_write) {
484 sigbus_memset_context = NULL;
485 }
486 g_free(context.threads);
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +0530487
David Hildenbrand6c427ab2021-12-17 14:46:04 +0100488 return ret;
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +0530489}
490
David Hildenbranda384bfa2021-12-17 14:46:05 +0100491static bool madv_populate_write_possible(char *area, size_t pagesize)
492{
493 return !qemu_madvise(area, pagesize, QEMU_MADV_POPULATE_WRITE) ||
494 errno != EINVAL;
495}
496
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +0530497void os_mem_prealloc(int fd, char *area, size_t memory, int smp_cpus,
498 Error **errp)
Paolo Bonzini38183312014-05-14 17:43:21 +0800499{
David Hildenbranda960d662021-12-17 14:46:09 +0100500 static gsize initialized;
Stefan Weilb7bf8f52014-06-24 22:52:29 +0200501 int ret;
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +0530502 size_t hpagesize = qemu_fd_getpagesize(fd);
503 size_t numpages = DIV_ROUND_UP(memory, hpagesize);
David Hildenbranda384bfa2021-12-17 14:46:05 +0100504 bool use_madv_populate_write;
David Hildenbrand29b838c2021-12-17 14:46:10 +0100505 struct sigaction act;
Paolo Bonzini38183312014-05-14 17:43:21 +0800506
David Hildenbranda384bfa2021-12-17 14:46:05 +0100507 /*
508 * Sense on every invocation, as MADV_POPULATE_WRITE cannot be used for
509 * some special mappings, such as mapping /dev/mem.
510 */
511 use_madv_populate_write = madv_populate_write_possible(area, hpagesize);
Paolo Bonzini38183312014-05-14 17:43:21 +0800512
David Hildenbranda384bfa2021-12-17 14:46:05 +0100513 if (!use_madv_populate_write) {
David Hildenbranda960d662021-12-17 14:46:09 +0100514 if (g_once_init_enter(&initialized)) {
515 qemu_mutex_init(&sigbus_mutex);
516 g_once_init_leave(&initialized, 1);
517 }
518
519 qemu_mutex_lock(&sigbus_mutex);
David Hildenbranda384bfa2021-12-17 14:46:05 +0100520 memset(&act, 0, sizeof(act));
David Hildenbrand29b838c2021-12-17 14:46:10 +0100521#ifdef CONFIG_LINUX
522 act.sa_sigaction = &sigbus_handler;
523 act.sa_flags = SA_SIGINFO;
524#else /* CONFIG_LINUX */
David Hildenbranda384bfa2021-12-17 14:46:05 +0100525 act.sa_handler = &sigbus_handler;
526 act.sa_flags = 0;
David Hildenbrand29b838c2021-12-17 14:46:10 +0100527#endif /* CONFIG_LINUX */
David Hildenbranda384bfa2021-12-17 14:46:05 +0100528
David Hildenbrand29b838c2021-12-17 14:46:10 +0100529 ret = sigaction(SIGBUS, &act, &sigbus_oldact);
David Hildenbranda384bfa2021-12-17 14:46:05 +0100530 if (ret) {
David Hildenbranddd4fc602022-01-11 13:08:30 +0100531 qemu_mutex_unlock(&sigbus_mutex);
David Hildenbranda384bfa2021-12-17 14:46:05 +0100532 error_setg_errno(errp, errno,
533 "os_mem_prealloc: failed to install signal handler");
534 return;
535 }
Paolo Bonzini38183312014-05-14 17:43:21 +0800536 }
537
Jitendra Kolhe1e356fc2017-02-24 09:01:43 +0530538 /* touch pages simultaneously */
David Hildenbranda384bfa2021-12-17 14:46:05 +0100539 ret = touch_all_pages(area, hpagesize, numpages, smp_cpus,
540 use_madv_populate_write);
David Hildenbrand6c427ab2021-12-17 14:46:04 +0100541 if (ret) {
542 error_setg_errno(errp, -ret,
543 "os_mem_prealloc: preallocating memory failed");
Stefan Weilb7bf8f52014-06-24 22:52:29 +0200544 }
Igor Mammedov056b68a2016-07-20 11:54:03 +0200545
David Hildenbranda384bfa2021-12-17 14:46:05 +0100546 if (!use_madv_populate_write) {
David Hildenbrand29b838c2021-12-17 14:46:10 +0100547 ret = sigaction(SIGBUS, &sigbus_oldact, NULL);
David Hildenbranda384bfa2021-12-17 14:46:05 +0100548 if (ret) {
549 /* Terminate QEMU since it can't recover from error */
550 perror("os_mem_prealloc: failed to reinstall signal handler");
551 exit(1);
552 }
David Hildenbranda960d662021-12-17 14:46:09 +0100553 qemu_mutex_unlock(&sigbus_mutex);
Igor Mammedov056b68a2016-07-20 11:54:03 +0200554 }
Paolo Bonzini38183312014-05-14 17:43:21 +0800555}
Daniel P. Berranged57e4e42015-05-12 17:09:19 +0100556
Michal Privoznik7dc9ae42016-09-27 17:24:56 +0200557char *qemu_get_pid_name(pid_t pid)
558{
559 char *name = NULL;
560
561#if defined(__FreeBSD__)
562 /* BSDs don't have /proc, but they provide a nice substitute */
563 struct kinfo_proc *proc = kinfo_getproc(pid);
564
565 if (proc) {
566 name = g_strdup(proc->ki_comm);
567 free(proc);
568 }
569#else
570 /* Assume a system with reasonable procfs */
571 char *pid_path;
572 size_t len;
573
574 pid_path = g_strdup_printf("/proc/%d/cmdline", pid);
575 g_file_get_contents(pid_path, &name, &len, NULL);
576 g_free(pid_path);
577#endif
578
579 return name;
580}
581
582
Daniel P. Berrange57cb38b2015-08-28 14:40:01 +0100583pid_t qemu_fork(Error **errp)
584{
585 sigset_t oldmask, newmask;
586 struct sigaction sig_action;
587 int saved_errno;
588 pid_t pid;
589
590 /*
591 * Need to block signals now, so that child process can safely
592 * kill off caller's signal handlers without a race.
593 */
594 sigfillset(&newmask);
595 if (pthread_sigmask(SIG_SETMASK, &newmask, &oldmask) != 0) {
596 error_setg_errno(errp, errno,
597 "cannot block signals");
598 return -1;
599 }
600
601 pid = fork();
602 saved_errno = errno;
603
604 if (pid < 0) {
605 /* attempt to restore signal mask, but ignore failure, to
606 * avoid obscuring the fork failure */
607 (void)pthread_sigmask(SIG_SETMASK, &oldmask, NULL);
608 error_setg_errno(errp, saved_errno,
609 "cannot fork child process");
610 errno = saved_errno;
611 return -1;
612 } else if (pid) {
613 /* parent process */
614
615 /* Restore our original signal mask now that the child is
616 * safely running. Only documented failures are EFAULT (not
617 * possible, since we are using just-grabbed mask) or EINVAL
618 * (not possible, since we are using correct arguments). */
619 (void)pthread_sigmask(SIG_SETMASK, &oldmask, NULL);
620 } else {
621 /* child process */
622 size_t i;
623
624 /* Clear out all signal handlers from parent so nothing
625 * unexpected can happen in our child once we unblock
626 * signals */
627 sig_action.sa_handler = SIG_DFL;
628 sig_action.sa_flags = 0;
629 sigemptyset(&sig_action.sa_mask);
630
631 for (i = 1; i < NSIG; i++) {
632 /* Only possible errors are EFAULT or EINVAL The former
633 * won't happen, the latter we expect, so no need to check
634 * return value */
635 (void)sigaction(i, &sig_action, NULL);
636 }
637
638 /* Unmask all signals in child, since we've no idea what the
639 * caller's done with their signal mask and don't want to
640 * propagate that to children */
641 sigemptyset(&newmask);
642 if (pthread_sigmask(SIG_SETMASK, &newmask, NULL) != 0) {
643 Error *local_err = NULL;
644 error_setg_errno(&local_err, errno,
645 "cannot unblock signals");
646 error_report_err(local_err);
647 _exit(1);
648 }
649 }
650 return pid;
651}
Peter Lieven8737d9e2016-09-27 11:58:40 +0200652
653void *qemu_alloc_stack(size_t *sz)
654{
655 void *ptr, *guardpage;
Brad Smithfc3d1ba2018-10-19 08:52:39 -0400656 int flags;
Peter Lieven7d992e42016-09-27 11:58:45 +0200657#ifdef CONFIG_DEBUG_STACK_USAGE
658 void *ptr2;
659#endif
Marc-André Lureau8e3b0cb2022-03-23 19:57:22 +0400660 size_t pagesz = qemu_real_host_page_size();
Peter Lieven8737d9e2016-09-27 11:58:40 +0200661#ifdef _SC_THREAD_STACK_MIN
662 /* avoid stacks smaller than _SC_THREAD_STACK_MIN */
663 long min_stack_sz = sysconf(_SC_THREAD_STACK_MIN);
664 *sz = MAX(MAX(min_stack_sz, 0), *sz);
665#endif
666 /* adjust stack size to a multiple of the page size */
667 *sz = ROUND_UP(*sz, pagesz);
668 /* allocate one extra page for the guard page */
669 *sz += pagesz;
670
Brad Smithfc3d1ba2018-10-19 08:52:39 -0400671 flags = MAP_PRIVATE | MAP_ANONYMOUS;
672#if defined(MAP_STACK) && defined(__OpenBSD__)
673 /* Only enable MAP_STACK on OpenBSD. Other OS's such as
674 * Linux/FreeBSD/NetBSD have a flag with the same name
675 * but have differing functionality. OpenBSD will SEGV
676 * if it spots execution with a stack pointer pointing
677 * at memory that was not allocated with MAP_STACK.
678 */
679 flags |= MAP_STACK;
680#endif
681
682 ptr = mmap(NULL, *sz, PROT_READ | PROT_WRITE, flags, -1, 0);
Peter Lieven8737d9e2016-09-27 11:58:40 +0200683 if (ptr == MAP_FAILED) {
Eduardo Habkoste916a6e2017-08-29 18:20:53 -0300684 perror("failed to allocate memory for stack");
Peter Lieven8737d9e2016-09-27 11:58:40 +0200685 abort();
686 }
687
688#if defined(HOST_IA64)
689 /* separate register stack */
690 guardpage = ptr + (((*sz - pagesz) / 2) & ~pagesz);
691#elif defined(HOST_HPPA)
692 /* stack grows up */
693 guardpage = ptr + *sz - pagesz;
694#else
695 /* stack grows down */
696 guardpage = ptr;
697#endif
698 if (mprotect(guardpage, pagesz, PROT_NONE) != 0) {
Eduardo Habkoste916a6e2017-08-29 18:20:53 -0300699 perror("failed to set up stack guard page");
Peter Lieven8737d9e2016-09-27 11:58:40 +0200700 abort();
701 }
702
Peter Lieven7d992e42016-09-27 11:58:45 +0200703#ifdef CONFIG_DEBUG_STACK_USAGE
704 for (ptr2 = ptr + pagesz; ptr2 < ptr + *sz; ptr2 += sizeof(uint32_t)) {
705 *(uint32_t *)ptr2 = 0xdeadbeaf;
706 }
707#endif
708
Peter Lieven8737d9e2016-09-27 11:58:40 +0200709 return ptr;
710}
711
Peter Lieven7d992e42016-09-27 11:58:45 +0200712#ifdef CONFIG_DEBUG_STACK_USAGE
713static __thread unsigned int max_stack_usage;
714#endif
715
Peter Lieven8737d9e2016-09-27 11:58:40 +0200716void qemu_free_stack(void *stack, size_t sz)
717{
Peter Lieven7d992e42016-09-27 11:58:45 +0200718#ifdef CONFIG_DEBUG_STACK_USAGE
719 unsigned int usage;
720 void *ptr;
721
Marc-André Lureau8e3b0cb2022-03-23 19:57:22 +0400722 for (ptr = stack + qemu_real_host_page_size(); ptr < stack + sz;
Peter Lieven7d992e42016-09-27 11:58:45 +0200723 ptr += sizeof(uint32_t)) {
724 if (*(uint32_t *)ptr != 0xdeadbeaf) {
725 break;
726 }
727 }
728 usage = sz - (uintptr_t) (ptr - stack);
729 if (usage > max_stack_usage) {
730 error_report("thread %d max stack usage increased from %u to %u",
731 qemu_get_thread_id(), max_stack_usage, usage);
732 max_stack_usage = usage;
733 }
734#endif
735
Peter Lieven8737d9e2016-09-27 11:58:40 +0200736 munmap(stack, sz);
737}
Paolo Bonzinid98d4072017-02-08 13:22:12 +0100738
Daniele Buonoc905a362020-12-04 18:06:12 -0500739/*
740 * Disable CFI checks.
741 * We are going to call a signal hander directly. Such handler may or may not
742 * have been defined in our binary, so there's no guarantee that the pointer
743 * used to set the handler is a cfi-valid pointer. Since the handlers are
744 * stored in kernel memory, changing the handler to an attacker-defined
745 * function requires being able to call a sigaction() syscall,
746 * which is not as easy as overwriting a pointer in memory.
747 */
748QEMU_DISABLE_CFI
Paolo Bonzinid98d4072017-02-08 13:22:12 +0100749void sigaction_invoke(struct sigaction *action,
750 struct qemu_signalfd_siginfo *info)
751{
Peter Maydell02ffa032017-07-20 17:32:21 +0100752 siginfo_t si = {};
Paolo Bonzinid98d4072017-02-08 13:22:12 +0100753 si.si_signo = info->ssi_signo;
754 si.si_errno = info->ssi_errno;
755 si.si_code = info->ssi_code;
756
757 /* Convert the minimal set of fields defined by POSIX.
758 * Positive si_code values are reserved for kernel-generated
759 * signals, where the valid siginfo fields are determined by
760 * the signal number. But according to POSIX, it is unspecified
761 * whether SI_USER and SI_QUEUE have values less than or equal to
762 * zero.
763 */
764 if (info->ssi_code == SI_USER || info->ssi_code == SI_QUEUE ||
765 info->ssi_code <= 0) {
766 /* SIGTERM, etc. */
767 si.si_pid = info->ssi_pid;
768 si.si_uid = info->ssi_uid;
769 } else if (info->ssi_signo == SIGILL || info->ssi_signo == SIGFPE ||
770 info->ssi_signo == SIGSEGV || info->ssi_signo == SIGBUS) {
771 si.si_addr = (void *)(uintptr_t)info->ssi_addr;
772 } else if (info->ssi_signo == SIGCHLD) {
773 si.si_pid = info->ssi_pid;
774 si.si_status = info->ssi_status;
775 si.si_uid = info->ssi_uid;
Paolo Bonzinid98d4072017-02-08 13:22:12 +0100776 }
777 action->sa_sigaction(info->ssi_signo, &si, NULL);
778}
Michal Privoznike47f4762020-06-22 20:19:35 +0200779
Alex Bennéead06ef02020-07-24 07:44:57 +0100780size_t qemu_get_host_physmem(void)
781{
782#ifdef _SC_PHYS_PAGES
783 long pages = sysconf(_SC_PHYS_PAGES);
784 if (pages > 0) {
Marc-André Lureau8e3b0cb2022-03-23 19:57:22 +0400785 if (pages > SIZE_MAX / qemu_real_host_page_size()) {
Alex Bennéead06ef02020-07-24 07:44:57 +0100786 return SIZE_MAX;
787 } else {
Marc-André Lureau8e3b0cb2022-03-23 19:57:22 +0400788 return pages * qemu_real_host_page_size();
Alex Bennéead06ef02020-07-24 07:44:57 +0100789 }
790 }
791#endif
792 return 0;
793}
Marc-André Lureaue9c4e0a2022-03-23 19:57:40 +0400794
Marc-André Lureau73991a92022-04-20 17:26:03 +0400795int qemu_msync(void *addr, size_t length, int fd)
796{
797 size_t align_mask = ~(qemu_real_host_page_size() - 1);
798
799 /**
800 * There are no strict reqs as per the length of mapping
801 * to be synced. Still the length needs to follow the address
802 * alignment changes. Additionally - round the size to the multiple
803 * of PAGE_SIZE
804 */
805 length += ((uintptr_t)addr & (qemu_real_host_page_size() - 1));
806 length = (length + ~align_mask) & align_mask;
807
808 addr = (void *)((uintptr_t)addr & align_mask);
809
810 return msync(addr, length, MS_SYNC);
811}