Merge tag 'pull-request-2024-06-12' of https://gitlab.com/thuth/qemu into staging
[qemu/kevin.git] / bsd-user / main.c
blobdcad266c2c99bd07eea8988146210e158aca3b4f
1 /*
2 * qemu bsd user main
4 * Copyright (c) 2003-2008 Fabrice Bellard
5 * Copyright (c) 2013-14 Stacey Son
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 #include "qemu/osdep.h"
22 #include <sys/resource.h>
23 #include <sys/sysctl.h>
25 #include "qemu/help-texts.h"
26 #include "qemu/units.h"
27 #include "qemu/accel.h"
28 #include "qemu-version.h"
29 #include <machine/trap.h>
31 #include "qapi/error.h"
32 #include "qemu.h"
33 #include "qemu/config-file.h"
34 #include "qemu/error-report.h"
35 #include "qemu/path.h"
36 #include "qemu/help_option.h"
37 #include "qemu/module.h"
38 #include "exec/exec-all.h"
39 #include "user/guest-base.h"
40 #include "tcg/startup.h"
41 #include "qemu/timer.h"
42 #include "qemu/envlist.h"
43 #include "qemu/cutils.h"
44 #include "exec/log.h"
45 #include "trace/control.h"
46 #include "crypto/init.h"
47 #include "qemu/guest-random.h"
48 #include "gdbstub/user.h"
49 #include "exec/page-vary.h"
51 #include "host-os.h"
52 #include "target_arch_cpu.h"
56 * TODO: Remove these and rely only on qemu_real_host_page_size().
58 uintptr_t qemu_host_page_size;
59 intptr_t qemu_host_page_mask;
61 static bool opt_one_insn_per_tb;
62 uintptr_t guest_base;
63 bool have_guest_base;
65 * When running 32-on-64 we should make sure we can fit all of the possible
66 * guest address space into a contiguous chunk of virtual host memory.
68 * This way we will never overlap with our own libraries or binaries or stack
69 * or anything else that QEMU maps.
71 * Many cpus reserve the high bit (or more than one for some 64-bit cpus)
72 * of the address for the kernel. Some cpus rely on this and user space
73 * uses the high bit(s) for pointer tagging and the like. For them, we
74 * must preserve the expected address space.
76 #ifndef MAX_RESERVED_VA
77 # if HOST_LONG_BITS > TARGET_VIRT_ADDR_SPACE_BITS
78 # if TARGET_VIRT_ADDR_SPACE_BITS == 32 && \
79 (TARGET_LONG_BITS == 32 || defined(TARGET_ABI32))
80 # define MAX_RESERVED_VA(CPU) 0xfffffffful
81 # else
82 # define MAX_RESERVED_VA(CPU) ((1ul << TARGET_VIRT_ADDR_SPACE_BITS) - 1)
83 # endif
84 # else
85 # define MAX_RESERVED_VA(CPU) 0
86 # endif
87 #endif
89 unsigned long reserved_va;
91 const char *interp_prefix = CONFIG_QEMU_INTERP_PREFIX;
92 const char *qemu_uname_release;
93 char qemu_proc_pathname[PATH_MAX]; /* full path to exeutable */
95 unsigned long target_maxtsiz = TARGET_MAXTSIZ; /* max text size */
96 unsigned long target_dfldsiz = TARGET_DFLDSIZ; /* initial data size limit */
97 unsigned long target_maxdsiz = TARGET_MAXDSIZ; /* max data size */
98 unsigned long target_dflssiz = TARGET_DFLSSIZ; /* initial data size limit */
99 unsigned long target_maxssiz = TARGET_MAXSSIZ; /* max stack size */
100 unsigned long target_sgrowsiz = TARGET_SGROWSIZ; /* amount to grow stack */
102 /* Helper routines for implementing atomic operations. */
104 void fork_start(void)
106 start_exclusive();
107 cpu_list_lock();
108 mmap_fork_start();
109 gdbserver_fork_start();
112 void fork_end(pid_t pid)
114 bool child = pid == 0;
116 if (child) {
117 CPUState *cpu, *next_cpu;
119 * Child processes created by fork() only have a single thread. Discard
120 * information about the parent threads.
122 CPU_FOREACH_SAFE(cpu, next_cpu) {
123 if (cpu != thread_cpu) {
124 QTAILQ_REMOVE_RCU(&cpus_queue, cpu, node);
127 mmap_fork_end(child);
129 * qemu_init_cpu_list() takes care of reinitializing the exclusive
130 * state, so we don't need to end_exclusive() here.
132 qemu_init_cpu_list();
133 get_task_state(thread_cpu)->ts_tid = qemu_get_thread_id();
134 gdbserver_fork_end(thread_cpu, pid);
135 } else {
136 mmap_fork_end(child);
137 cpu_list_unlock();
138 gdbserver_fork_end(thread_cpu, pid);
139 end_exclusive();
143 void cpu_loop(CPUArchState *env)
145 target_cpu_loop(env);
148 static void usage(void)
150 printf("qemu-" TARGET_NAME " version " QEMU_FULL_VERSION
151 "\n" QEMU_COPYRIGHT "\n"
152 "usage: qemu-" TARGET_NAME " [options] program [arguments...]\n"
153 "BSD CPU emulator (compiled for %s emulation)\n"
154 "\n"
155 "Standard options:\n"
156 "-h print this help\n"
157 "-g port wait gdb connection to port\n"
158 "-L path set the elf interpreter prefix (default=%s)\n"
159 "-s size set the stack size in bytes (default=%ld)\n"
160 "-cpu model select CPU (-cpu help for list)\n"
161 "-drop-ld-preload drop LD_PRELOAD for target process\n"
162 "-E var=value sets/modifies targets environment variable(s)\n"
163 "-U var unsets targets environment variable(s)\n"
164 "-B address set guest_base address to address\n"
165 "\n"
166 "Debug options:\n"
167 "-d item1[,...] enable logging of specified items\n"
168 " (use '-d help' for a list of log items)\n"
169 "-D logfile write logs to 'logfile' (default stderr)\n"
170 "-one-insn-per-tb run with one guest instruction per emulated TB\n"
171 "-strace log system calls\n"
172 "-trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
173 " specify tracing options\n"
174 "\n"
175 "Environment variables:\n"
176 "QEMU_STRACE Print system calls and arguments similar to the\n"
177 " 'strace' program. Enable by setting to any value.\n"
178 "You can use -E and -U options to set/unset environment variables\n"
179 "for target process. It is possible to provide several variables\n"
180 "by repeating the option. For example:\n"
181 " -E var1=val2 -E var2=val2 -U LD_PRELOAD -U LD_DEBUG\n"
182 "Note that if you provide several changes to single variable\n"
183 "last change will stay in effect.\n"
184 "\n"
185 QEMU_HELP_BOTTOM "\n"
187 TARGET_NAME,
188 interp_prefix,
189 target_dflssiz);
190 exit(1);
193 __thread CPUState *thread_cpu;
195 void stop_all_tasks(void)
198 * We trust when using NPTL (pthreads) start_exclusive() handles thread
199 * stopping correctly.
201 start_exclusive();
204 bool qemu_cpu_is_self(CPUState *cpu)
206 return thread_cpu == cpu;
209 void qemu_cpu_kick(CPUState *cpu)
211 cpu_exit(cpu);
214 /* Assumes contents are already zeroed. */
215 static void init_task_state(TaskState *ts)
217 ts->sigaltstack_used = (struct target_sigaltstack) {
218 .ss_sp = 0,
219 .ss_size = 0,
220 .ss_flags = TARGET_SS_DISABLE,
224 void gemu_log(const char *fmt, ...)
226 va_list ap;
228 va_start(ap, fmt);
229 vfprintf(stderr, fmt, ap);
230 va_end(ap);
233 static void
234 adjust_ssize(void)
236 struct rlimit rl;
238 if (getrlimit(RLIMIT_STACK, &rl) != 0) {
239 return;
242 target_maxssiz = MIN(target_maxssiz, rl.rlim_max);
243 target_dflssiz = MIN(MAX(target_dflssiz, rl.rlim_cur), target_maxssiz);
245 rl.rlim_max = target_maxssiz;
246 rl.rlim_cur = target_dflssiz;
247 setrlimit(RLIMIT_STACK, &rl);
250 static void save_proc_pathname(char *argv0)
252 int mib[4];
253 size_t len;
255 mib[0] = CTL_KERN;
256 mib[1] = KERN_PROC;
257 mib[2] = KERN_PROC_PATHNAME;
258 mib[3] = -1;
260 len = sizeof(qemu_proc_pathname);
261 if (sysctl(mib, 4, qemu_proc_pathname, &len, NULL, 0)) {
262 perror("sysctl");
266 int main(int argc, char **argv)
268 const char *filename;
269 const char *cpu_model;
270 const char *cpu_type;
271 const char *log_file = NULL;
272 const char *log_mask = NULL;
273 const char *seed_optarg = NULL;
274 struct target_pt_regs regs1, *regs = &regs1;
275 struct image_info info1, *info = &info1;
276 struct bsd_binprm bprm;
277 TaskState *ts;
278 CPUArchState *env;
279 CPUState *cpu;
280 int optind, rv;
281 const char *r;
282 const char *gdbstub = NULL;
283 char **target_environ, **wrk;
284 envlist_t *envlist = NULL;
285 char *argv0 = NULL;
286 int host_page_size;
287 unsigned long max_reserved_va;
289 adjust_ssize();
291 if (argc <= 1) {
292 usage();
295 save_proc_pathname(argv[0]);
297 error_init(argv[0]);
298 module_call_init(MODULE_INIT_TRACE);
299 qemu_init_cpu_list();
300 module_call_init(MODULE_INIT_QOM);
302 envlist = envlist_create();
305 * add current environment into the list
306 * envlist_setenv adds to the front of the list; to preserve environ
307 * order add from back to front
309 for (wrk = environ; *wrk != NULL; wrk++) {
310 continue;
312 while (wrk != environ) {
313 wrk--;
314 (void) envlist_setenv(envlist, *wrk);
317 qemu_host_page_size = getpagesize();
318 qemu_host_page_size = MAX(qemu_host_page_size, TARGET_PAGE_SIZE);
320 cpu_model = NULL;
322 qemu_add_opts(&qemu_trace_opts);
324 optind = 1;
325 for (;;) {
326 if (optind >= argc) {
327 break;
329 r = argv[optind];
330 if (r[0] != '-') {
331 break;
333 optind++;
334 r++;
335 if (!strcmp(r, "-")) {
336 break;
337 } else if (!strcmp(r, "d")) {
338 if (optind >= argc) {
339 break;
341 log_mask = argv[optind++];
342 } else if (!strcmp(r, "D")) {
343 if (optind >= argc) {
344 break;
346 log_file = argv[optind++];
347 } else if (!strcmp(r, "E")) {
348 r = argv[optind++];
349 if (envlist_setenv(envlist, r) != 0) {
350 usage();
352 } else if (!strcmp(r, "ignore-environment")) {
353 envlist_free(envlist);
354 envlist = envlist_create();
355 } else if (!strcmp(r, "U")) {
356 r = argv[optind++];
357 if (envlist_unsetenv(envlist, r) != 0) {
358 usage();
360 } else if (!strcmp(r, "s")) {
361 r = argv[optind++];
362 rv = qemu_strtoul(r, &r, 0, &target_dflssiz);
363 if (rv < 0 || target_dflssiz <= 0) {
364 usage();
366 if (*r == 'M') {
367 target_dflssiz *= 1024 * 1024;
368 } else if (*r == 'k' || *r == 'K') {
369 target_dflssiz *= 1024;
371 if (target_dflssiz > target_maxssiz) {
372 usage();
374 } else if (!strcmp(r, "L")) {
375 interp_prefix = argv[optind++];
376 } else if (!strcmp(r, "p")) {
377 unsigned size, want = qemu_real_host_page_size();
379 r = argv[optind++];
380 if (qemu_strtoui(r, NULL, 10, &size) || size != want) {
381 warn_report("Deprecated page size option cannot "
382 "change host page size (%u)", want);
384 } else if (!strcmp(r, "g")) {
385 gdbstub = g_strdup(argv[optind++]);
386 } else if (!strcmp(r, "r")) {
387 qemu_uname_release = argv[optind++];
388 } else if (!strcmp(r, "cpu")) {
389 cpu_model = argv[optind++];
390 if (is_help_option(cpu_model)) {
391 list_cpus();
392 exit(1);
394 } else if (!strcmp(r, "B")) {
395 rv = qemu_strtoul(argv[optind++], NULL, 0, &guest_base);
396 if (rv < 0) {
397 usage();
399 have_guest_base = true;
400 } else if (!strcmp(r, "drop-ld-preload")) {
401 (void) envlist_unsetenv(envlist, "LD_PRELOAD");
402 } else if (!strcmp(r, "seed")) {
403 seed_optarg = optarg;
404 } else if (!strcmp(r, "one-insn-per-tb")) {
405 opt_one_insn_per_tb = true;
406 } else if (!strcmp(r, "strace")) {
407 do_strace = 1;
408 } else if (!strcmp(r, "trace")) {
409 trace_opt_parse(optarg);
410 } else if (!strcmp(r, "0")) {
411 argv0 = argv[optind++];
412 } else {
413 usage();
417 qemu_host_page_mask = -qemu_host_page_size;
419 /* init debug */
421 int mask = 0;
422 if (log_mask) {
423 mask = qemu_str_to_log_mask(log_mask);
424 if (!mask) {
425 qemu_print_log_usage(stdout);
426 exit(1);
429 qemu_set_log_filename_flags(log_file, mask, &error_fatal);
432 if (optind >= argc) {
433 usage();
435 filename = argv[optind];
436 if (argv0) {
437 argv[optind] = argv0;
440 if (!trace_init_backends()) {
441 exit(1);
443 trace_init_file();
445 /* Zero out regs */
446 memset(regs, 0, sizeof(struct target_pt_regs));
448 /* Zero bsd params */
449 memset(&bprm, 0, sizeof(bprm));
451 /* Zero out image_info */
452 memset(info, 0, sizeof(struct image_info));
454 /* Scan interp_prefix dir for replacement files. */
455 init_paths(interp_prefix);
457 if (cpu_model == NULL) {
458 cpu_model = TARGET_DEFAULT_CPU_MODEL;
461 cpu_type = parse_cpu_option(cpu_model);
463 /* init tcg before creating CPUs and to get qemu_host_page_size */
465 AccelState *accel = current_accel();
466 AccelClass *ac = ACCEL_GET_CLASS(accel);
468 accel_init_interfaces(ac);
469 object_property_set_bool(OBJECT(accel), "one-insn-per-tb",
470 opt_one_insn_per_tb, &error_abort);
471 ac->init_machine(NULL);
475 * Finalize page size before creating CPUs.
476 * This will do nothing if !TARGET_PAGE_BITS_VARY.
477 * The most efficient setting is to match the host.
479 host_page_size = qemu_real_host_page_size();
480 set_preferred_target_page_bits(ctz32(host_page_size));
481 finalize_target_page_bits();
483 cpu = cpu_create(cpu_type);
484 env = cpu_env(cpu);
485 cpu_reset(cpu);
486 thread_cpu = cpu;
489 * Reserving too much vm space via mmap can run into problems with rlimits,
490 * oom due to page table creation, etc. We will still try it, if directed
491 * by the command-line option, but not by default. Unless we're running a
492 * target address space of 32 or fewer bits on a host with 64 bits.
494 max_reserved_va = MAX_RESERVED_VA(cpu);
495 if (reserved_va != 0) {
496 if ((reserved_va + 1) % host_page_size) {
497 char *s = size_to_str(host_page_size);
498 fprintf(stderr, "Reserved virtual address not aligned mod %s\n", s);
499 g_free(s);
500 exit(EXIT_FAILURE);
502 if (max_reserved_va && reserved_va > max_reserved_va) {
503 fprintf(stderr, "Reserved virtual address too big\n");
504 exit(EXIT_FAILURE);
506 } else if (HOST_LONG_BITS == 64 && TARGET_VIRT_ADDR_SPACE_BITS <= 32) {
507 /* MAX_RESERVED_VA + 1 is a large power of 2, so is aligned. */
508 reserved_va = max_reserved_va;
511 if (getenv("QEMU_STRACE")) {
512 do_strace = 1;
515 target_environ = envlist_to_environ(envlist, NULL);
516 envlist_free(envlist);
519 Error *err = NULL;
520 if (seed_optarg != NULL) {
521 qemu_guest_random_seed_main(seed_optarg, &err);
522 } else {
523 qcrypto_init(&err);
525 if (err) {
526 error_reportf_err(err, "cannot initialize crypto: ");
527 exit(1);
532 * Now that page sizes are configured we can do
533 * proper page alignment for guest_base.
535 if (have_guest_base) {
536 if (guest_base & ~qemu_host_page_mask) {
537 error_report("Selected guest base not host page aligned");
538 exit(1);
543 * If reserving host virtual address space, do so now.
544 * Combined with '-B', ensure that the chosen range is free.
546 if (reserved_va) {
547 void *p;
549 if (have_guest_base) {
550 p = mmap((void *)guest_base, reserved_va + 1, PROT_NONE,
551 MAP_ANON | MAP_PRIVATE | MAP_FIXED | MAP_EXCL, -1, 0);
552 } else {
553 p = mmap(NULL, reserved_va + 1, PROT_NONE,
554 MAP_ANON | MAP_PRIVATE, -1, 0);
556 if (p == MAP_FAILED) {
557 const char *err = strerror(errno);
558 char *sz = size_to_str(reserved_va + 1);
560 if (have_guest_base) {
561 error_report("Cannot allocate %s bytes at -B %p for guest "
562 "address space: %s", sz, (void *)guest_base, err);
563 } else {
564 error_report("Cannot allocate %s bytes for guest "
565 "address space: %s", sz, err);
567 exit(1);
569 guest_base = (uintptr_t)p;
570 have_guest_base = true;
572 /* Ensure that mmap_next_start is within range. */
573 if (reserved_va <= mmap_next_start) {
574 mmap_next_start = (reserved_va / 4 * 3)
575 & TARGET_PAGE_MASK & qemu_host_page_mask;
579 if (loader_exec(filename, argv + optind, target_environ, regs, info,
580 &bprm) != 0) {
581 printf("Error loading %s\n", filename);
582 _exit(1);
585 for (wrk = target_environ; *wrk; wrk++) {
586 g_free(*wrk);
589 g_free(target_environ);
591 if (qemu_loglevel_mask(CPU_LOG_PAGE)) {
592 FILE *f = qemu_log_trylock();
593 if (f) {
594 fprintf(f, "guest_base %p\n", (void *)guest_base);
595 fprintf(f, "page layout changed following binary load\n");
596 page_dump(f);
598 fprintf(f, "end_code 0x" TARGET_ABI_FMT_lx "\n",
599 info->end_code);
600 fprintf(f, "start_code 0x" TARGET_ABI_FMT_lx "\n",
601 info->start_code);
602 fprintf(f, "start_data 0x" TARGET_ABI_FMT_lx "\n",
603 info->start_data);
604 fprintf(f, "end_data 0x" TARGET_ABI_FMT_lx "\n",
605 info->end_data);
606 fprintf(f, "start_stack 0x" TARGET_ABI_FMT_lx "\n",
607 info->start_stack);
608 fprintf(f, "brk 0x" TARGET_ABI_FMT_lx "\n", info->brk);
609 fprintf(f, "entry 0x" TARGET_ABI_FMT_lx "\n", info->entry);
611 qemu_log_unlock(f);
615 /* build Task State */
616 ts = g_new0(TaskState, 1);
617 init_task_state(ts);
618 ts->info = info;
619 ts->bprm = &bprm;
620 cpu->opaque = ts;
622 target_set_brk(info->brk);
623 syscall_init();
624 signal_init();
627 * Now that we've loaded the binary, GUEST_BASE is fixed. Delay
628 * generating the prologue until now so that the prologue can take
629 * the real value of GUEST_BASE into account.
631 tcg_prologue_init();
633 target_cpu_init(env, regs);
635 if (gdbstub) {
636 gdbserver_start(gdbstub);
637 gdb_handlesig(cpu, 0, NULL, NULL, 0);
639 cpu_loop(env);
640 /* never exits */
641 return 0;