4 * Copyright (c) 2003-2008 Fabrice Bellard
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
20 #include "qemu/osdep.h"
21 #include "qemu-common.h"
22 #include "qemu/units.h"
23 #include "qemu/accel.h"
24 #include "sysemu/tcg.h"
25 #include "qemu-version.h"
26 #include <sys/syscall.h>
27 #include <sys/resource.h>
30 #include "qapi/error.h"
32 #include "qemu/path.h"
33 #include "qemu/queue.h"
34 #include "qemu/config-file.h"
35 #include "qemu/cutils.h"
36 #include "qemu/error-report.h"
37 #include "qemu/help_option.h"
38 #include "qemu/module.h"
39 #include "qemu/plugin.h"
41 #include "exec/exec-all.h"
43 #include "qemu/timer.h"
44 #include "qemu/envlist.h"
45 #include "qemu/guest-random.h"
47 #include "trace/control.h"
48 #include "target_elf.h"
49 #include "cpu_loop-common.h"
50 #include "crypto/init.h"
55 static const char *argv0
;
56 static const char *gdbstub
;
57 static envlist_t
*envlist
;
58 static const char *cpu_model
;
59 static const char *cpu_type
;
60 static const char *seed_optarg
;
61 unsigned long mmap_min_addr
;
66 * Used to implement backwards-compatibility for the `-strace`, and
67 * QEMU_STRACE options. Without this, the QEMU_LOG can be overwritten by
68 * -strace, or vice versa.
70 static bool enable_strace
;
73 * The last log mask given by the user in an environment variable or argument.
74 * Used to support command line arguments overriding environment variables.
76 static int last_log_mask
;
79 * When running 32-on-64 we should make sure we can fit all of the possible
80 * guest address space into a contiguous chunk of virtual host memory.
82 * This way we will never overlap with our own libraries or binaries or stack
83 * or anything else that QEMU maps.
85 * Many cpus reserve the high bit (or more than one for some 64-bit cpus)
86 * of the address for the kernel. Some cpus rely on this and user space
87 * uses the high bit(s) for pointer tagging and the like. For them, we
88 * must preserve the expected address space.
90 #ifndef MAX_RESERVED_VA
91 # if HOST_LONG_BITS > TARGET_VIRT_ADDR_SPACE_BITS
92 # if TARGET_VIRT_ADDR_SPACE_BITS == 32 && \
93 (TARGET_LONG_BITS == 32 || defined(TARGET_ABI32))
94 /* There are a number of places where we assign reserved_va to a variable
95 of type abi_ulong and expect it to fit. Avoid the last page. */
96 # define MAX_RESERVED_VA(CPU) (0xfffffffful & TARGET_PAGE_MASK)
98 # define MAX_RESERVED_VA(CPU) (1ul << TARGET_VIRT_ADDR_SPACE_BITS)
101 # define MAX_RESERVED_VA(CPU) 0
105 unsigned long reserved_va
;
107 static void usage(int exitcode
);
109 static const char *interp_prefix
= CONFIG_QEMU_INTERP_PREFIX
;
110 const char *qemu_uname_release
;
112 /* XXX: on x86 MAP_GROWSDOWN only works if ESP <= address + 32, so
113 we allocate a bigger stack. Need a better solution, for example
114 by remapping the process stack directly at the right place */
115 unsigned long guest_stack_size
= 8 * 1024 * 1024UL;
117 #if defined(TARGET_I386)
118 int cpu_get_pic_interrupt(CPUX86State
*env
)
124 /***********************************************************/
125 /* Helper routines for implementing atomic operations. */
127 /* Make sure everything is in a consistent state for calling fork(). */
128 void fork_start(void)
135 void fork_end(int child
)
137 mmap_fork_end(child
);
139 CPUState
*cpu
, *next_cpu
;
140 /* Child processes created by fork() only have a single thread.
141 Discard information about the parent threads. */
142 CPU_FOREACH_SAFE(cpu
, next_cpu
) {
143 if (cpu
!= thread_cpu
) {
144 QTAILQ_REMOVE_RCU(&cpus
, cpu
, node
);
147 qemu_init_cpu_list();
148 gdbserver_fork(thread_cpu
);
149 /* qemu_init_cpu_list() takes care of reinitializing the
150 * exclusive state, so we don't need to end_exclusive() here.
158 __thread CPUState
*thread_cpu
;
160 bool qemu_cpu_is_self(CPUState
*cpu
)
162 return thread_cpu
== cpu
;
165 void qemu_cpu_kick(CPUState
*cpu
)
170 void task_settid(TaskState
*ts
)
172 if (ts
->ts_tid
== 0) {
173 ts
->ts_tid
= (pid_t
)syscall(SYS_gettid
);
177 void stop_all_tasks(void)
180 * We trust that when using NPTL, start_exclusive()
181 * handles thread stopping correctly.
186 /* Assumes contents are already zeroed. */
187 void init_task_state(TaskState
*ts
)
190 ts
->sigaltstack_used
= (struct target_sigaltstack
) {
193 .ss_flags
= TARGET_SS_DISABLE
,
197 CPUArchState
*cpu_copy(CPUArchState
*env
)
199 CPUState
*cpu
= env_cpu(env
);
200 CPUState
*new_cpu
= cpu_create(cpu_type
);
201 CPUArchState
*new_env
= new_cpu
->env_ptr
;
205 /* Reset non arch specific state */
208 new_cpu
->tcg_cflags
= cpu
->tcg_cflags
;
209 memcpy(new_env
, env
, sizeof(CPUArchState
));
211 /* Clone all break/watchpoints.
212 Note: Once we support ptrace with hw-debug register access, make sure
213 BP_CPU break/watchpoints are handled correctly on clone. */
214 QTAILQ_INIT(&new_cpu
->breakpoints
);
215 QTAILQ_INIT(&new_cpu
->watchpoints
);
216 QTAILQ_FOREACH(bp
, &cpu
->breakpoints
, entry
) {
217 cpu_breakpoint_insert(new_cpu
, bp
->pc
, bp
->flags
, NULL
);
219 QTAILQ_FOREACH(wp
, &cpu
->watchpoints
, entry
) {
220 cpu_watchpoint_insert(new_cpu
, wp
->vaddr
, wp
->len
, wp
->flags
, NULL
);
226 static void handle_arg_help(const char *arg
)
231 static void handle_arg_log(const char *arg
)
233 last_log_mask
= qemu_str_to_log_mask(arg
);
234 if (!last_log_mask
) {
235 qemu_print_log_usage(stdout
);
240 static void handle_arg_dfilter(const char *arg
)
242 qemu_set_dfilter_ranges(arg
, &error_fatal
);
245 static void handle_arg_log_filename(const char *arg
)
247 qemu_set_log_filename(arg
, &error_fatal
);
250 static void handle_arg_set_env(const char *arg
)
254 while ((token
= strsep(&p
, ",")) != NULL
) {
255 if (envlist_setenv(envlist
, token
) != 0) {
262 static void handle_arg_unset_env(const char *arg
)
266 while ((token
= strsep(&p
, ",")) != NULL
) {
267 if (envlist_unsetenv(envlist
, token
) != 0) {
274 static void handle_arg_argv0(const char *arg
)
279 static void handle_arg_stack_size(const char *arg
)
282 guest_stack_size
= strtoul(arg
, &p
, 0);
283 if (guest_stack_size
== 0) {
288 guest_stack_size
*= MiB
;
289 } else if (*p
== 'k' || *p
== 'K') {
290 guest_stack_size
*= KiB
;
294 static void handle_arg_ld_prefix(const char *arg
)
296 interp_prefix
= strdup(arg
);
299 static void handle_arg_pagesize(const char *arg
)
301 qemu_host_page_size
= atoi(arg
);
302 if (qemu_host_page_size
== 0 ||
303 (qemu_host_page_size
& (qemu_host_page_size
- 1)) != 0) {
304 fprintf(stderr
, "page size must be a power of two\n");
309 static void handle_arg_seed(const char *arg
)
314 static void handle_arg_gdb(const char *arg
)
316 gdbstub
= g_strdup(arg
);
319 static void handle_arg_uname(const char *arg
)
321 qemu_uname_release
= strdup(arg
);
324 static void handle_arg_cpu(const char *arg
)
326 cpu_model
= strdup(arg
);
327 if (cpu_model
== NULL
|| is_help_option(cpu_model
)) {
328 /* XXX: implement xxx_cpu_list for targets that still miss it */
329 #if defined(cpu_list)
336 static void handle_arg_guest_base(const char *arg
)
338 guest_base
= strtol(arg
, NULL
, 0);
339 have_guest_base
= true;
342 static void handle_arg_reserved_va(const char *arg
)
346 reserved_va
= strtoul(arg
, &p
, 0);
360 unsigned long unshifted
= reserved_va
;
362 reserved_va
<<= shift
;
363 if (reserved_va
>> shift
!= unshifted
) {
364 fprintf(stderr
, "Reserved virtual address too big\n");
369 fprintf(stderr
, "Unrecognised -R size suffix '%s'\n", p
);
374 static void handle_arg_singlestep(const char *arg
)
379 static void handle_arg_strace(const char *arg
)
381 enable_strace
= true;
384 static void handle_arg_version(const char *arg
)
386 printf("qemu-" TARGET_NAME
" version " QEMU_FULL_VERSION
387 "\n" QEMU_COPYRIGHT
"\n");
391 static void handle_arg_trace(const char *arg
)
393 trace_opt_parse(arg
);
396 #if defined(TARGET_XTENSA)
397 static void handle_arg_abi_call0(const char *arg
)
399 xtensa_set_abi_call0();
403 static QemuPluginList plugins
= QTAILQ_HEAD_INITIALIZER(plugins
);
406 static void handle_arg_plugin(const char *arg
)
408 qemu_plugin_opt_parse(arg
, &plugins
);
412 struct qemu_argument
{
416 void (*handle_opt
)(const char *arg
);
421 static const struct qemu_argument arg_table
[] = {
422 {"h", "", false, handle_arg_help
,
423 "", "print this help"},
424 {"help", "", false, handle_arg_help
,
426 {"g", "QEMU_GDB", true, handle_arg_gdb
,
427 "port", "wait gdb connection to 'port'"},
428 {"L", "QEMU_LD_PREFIX", true, handle_arg_ld_prefix
,
429 "path", "set the elf interpreter prefix to 'path'"},
430 {"s", "QEMU_STACK_SIZE", true, handle_arg_stack_size
,
431 "size", "set the stack size to 'size' bytes"},
432 {"cpu", "QEMU_CPU", true, handle_arg_cpu
,
433 "model", "select CPU (-cpu help for list)"},
434 {"E", "QEMU_SET_ENV", true, handle_arg_set_env
,
435 "var=value", "sets targets environment variable (see below)"},
436 {"U", "QEMU_UNSET_ENV", true, handle_arg_unset_env
,
437 "var", "unsets targets environment variable (see below)"},
438 {"0", "QEMU_ARGV0", true, handle_arg_argv0
,
439 "argv0", "forces target process argv[0] to be 'argv0'"},
440 {"r", "QEMU_UNAME", true, handle_arg_uname
,
441 "uname", "set qemu uname release string to 'uname'"},
442 {"B", "QEMU_GUEST_BASE", true, handle_arg_guest_base
,
443 "address", "set guest_base address to 'address'"},
444 {"R", "QEMU_RESERVED_VA", true, handle_arg_reserved_va
,
445 "size", "reserve 'size' bytes for guest virtual address space"},
446 {"d", "QEMU_LOG", true, handle_arg_log
,
447 "item[,...]", "enable logging of specified items "
448 "(use '-d help' for a list of items)"},
449 {"dfilter", "QEMU_DFILTER", true, handle_arg_dfilter
,
450 "range[,...]","filter logging based on address range"},
451 {"D", "QEMU_LOG_FILENAME", true, handle_arg_log_filename
,
452 "logfile", "write logs to 'logfile' (default stderr)"},
453 {"p", "QEMU_PAGESIZE", true, handle_arg_pagesize
,
454 "pagesize", "set the host page size to 'pagesize'"},
455 {"singlestep", "QEMU_SINGLESTEP", false, handle_arg_singlestep
,
456 "", "run in singlestep mode"},
457 {"strace", "QEMU_STRACE", false, handle_arg_strace
,
458 "", "log system calls"},
459 {"seed", "QEMU_RAND_SEED", true, handle_arg_seed
,
460 "", "Seed for pseudo-random number generator"},
461 {"trace", "QEMU_TRACE", true, handle_arg_trace
,
462 "", "[[enable=]<pattern>][,events=<file>][,file=<file>]"},
464 {"plugin", "QEMU_PLUGIN", true, handle_arg_plugin
,
465 "", "[file=]<file>[,arg=<string>]"},
467 {"version", "QEMU_VERSION", false, handle_arg_version
,
468 "", "display version information and exit"},
469 #if defined(TARGET_XTENSA)
470 {"xtensa-abi-call0", "QEMU_XTENSA_ABI_CALL0", false, handle_arg_abi_call0
,
471 "", "assume CALL0 Xtensa ABI"},
473 {NULL
, NULL
, false, NULL
, NULL
, NULL
}
476 static void usage(int exitcode
)
478 const struct qemu_argument
*arginfo
;
482 printf("usage: qemu-" TARGET_NAME
" [options] program [arguments...]\n"
483 "Linux CPU emulator (compiled for " TARGET_NAME
" emulation)\n"
485 "Options and associated environment variables:\n"
488 /* Calculate column widths. We must always have at least enough space
489 * for the column header.
491 maxarglen
= strlen("Argument");
492 maxenvlen
= strlen("Env-variable");
494 for (arginfo
= arg_table
; arginfo
->handle_opt
!= NULL
; arginfo
++) {
495 int arglen
= strlen(arginfo
->argv
);
496 if (arginfo
->has_arg
) {
497 arglen
+= strlen(arginfo
->example
) + 1;
499 if (strlen(arginfo
->env
) > maxenvlen
) {
500 maxenvlen
= strlen(arginfo
->env
);
502 if (arglen
> maxarglen
) {
507 printf("%-*s %-*s Description\n", maxarglen
+1, "Argument",
508 maxenvlen
, "Env-variable");
510 for (arginfo
= arg_table
; arginfo
->handle_opt
!= NULL
; arginfo
++) {
511 if (arginfo
->has_arg
) {
512 printf("-%s %-*s %-*s %s\n", arginfo
->argv
,
513 (int)(maxarglen
- strlen(arginfo
->argv
) - 1),
514 arginfo
->example
, maxenvlen
, arginfo
->env
, arginfo
->help
);
516 printf("-%-*s %-*s %s\n", maxarglen
, arginfo
->argv
,
517 maxenvlen
, arginfo
->env
,
524 "QEMU_LD_PREFIX = %s\n"
525 "QEMU_STACK_SIZE = %ld byte\n",
530 "You can use -E and -U options or the QEMU_SET_ENV and\n"
531 "QEMU_UNSET_ENV environment variables to set and unset\n"
532 "environment variables for the target process.\n"
533 "It is possible to provide several variables by separating them\n"
534 "by commas in getsubopt(3) style. Additionally it is possible to\n"
535 "provide the -E and -U options multiple times.\n"
536 "The following lines are equivalent:\n"
537 " -E var1=val2 -E var2=val2 -U LD_PRELOAD -U LD_DEBUG\n"
538 " -E var1=val2,var2=val2 -U LD_PRELOAD,LD_DEBUG\n"
539 " QEMU_SET_ENV=var1=val2,var2=val2 QEMU_UNSET_ENV=LD_PRELOAD,LD_DEBUG\n"
540 "Note that if you provide several changes to a single variable\n"
541 "the last change will stay in effect.\n"
543 QEMU_HELP_BOTTOM
"\n");
548 static int parse_args(int argc
, char **argv
)
552 const struct qemu_argument
*arginfo
;
554 for (arginfo
= arg_table
; arginfo
->handle_opt
!= NULL
; arginfo
++) {
555 if (arginfo
->env
== NULL
) {
559 r
= getenv(arginfo
->env
);
561 arginfo
->handle_opt(r
);
567 if (optind
>= argc
) {
576 if (!strcmp(r
, "-")) {
579 /* Treat --foo the same as -foo. */
584 for (arginfo
= arg_table
; arginfo
->handle_opt
!= NULL
; arginfo
++) {
585 if (!strcmp(r
, arginfo
->argv
)) {
586 if (arginfo
->has_arg
) {
587 if (optind
>= argc
) {
588 (void) fprintf(stderr
,
589 "qemu: missing argument for option '%s'\n", r
);
592 arginfo
->handle_opt(argv
[optind
]);
595 arginfo
->handle_opt(NULL
);
601 /* no option matched the current argv */
602 if (arginfo
->handle_opt
== NULL
) {
603 (void) fprintf(stderr
, "qemu: unknown option '%s'\n", r
);
608 if (optind
>= argc
) {
609 (void) fprintf(stderr
, "qemu: no user program specified\n");
613 exec_path
= argv
[optind
];
618 int main(int argc
, char **argv
, char **envp
)
620 struct target_pt_regs regs1
, *regs
= ®s1
;
621 struct image_info info1
, *info
= &info1
;
622 struct linux_binprm bprm
;
627 char **target_environ
, **wrk
;
634 unsigned long max_reserved_va
;
637 module_call_init(MODULE_INIT_TRACE
);
638 qemu_init_cpu_list();
639 module_call_init(MODULE_INIT_QOM
);
641 envlist
= envlist_create();
643 /* add current environment into the list */
644 for (wrk
= environ
; *wrk
!= NULL
; wrk
++) {
645 (void) envlist_setenv(envlist
, *wrk
);
648 /* Read the stack limit from the kernel. If it's "unlimited",
649 then we can do little else besides use the default. */
652 if (getrlimit(RLIMIT_STACK
, &lim
) == 0
653 && lim
.rlim_cur
!= RLIM_INFINITY
654 && lim
.rlim_cur
== (target_long
)lim
.rlim_cur
) {
655 guest_stack_size
= lim
.rlim_cur
;
661 qemu_add_opts(&qemu_trace_opts
);
662 qemu_plugin_add_opts();
664 optind
= parse_args(argc
, argv
);
666 log_mask
= last_log_mask
| (enable_strace
? LOG_STRACE
: 0);
668 qemu_log_needs_buffers();
669 qemu_set_log(log_mask
);
672 if (!trace_init_backends()) {
676 qemu_plugin_load_list(&plugins
, &error_fatal
);
679 memset(regs
, 0, sizeof(struct target_pt_regs
));
681 /* Zero out image_info */
682 memset(info
, 0, sizeof(struct image_info
));
684 memset(&bprm
, 0, sizeof (bprm
));
686 /* Scan interp_prefix dir for replacement files. */
687 init_paths(interp_prefix
);
689 init_qemu_uname_release();
691 execfd
= qemu_getauxval(AT_EXECFD
);
693 execfd
= open(exec_path
, O_RDONLY
);
695 printf("Error while loading %s: %s\n", exec_path
, strerror(errno
));
700 if (cpu_model
== NULL
) {
701 cpu_model
= cpu_get_model(get_elf_eflags(execfd
));
703 cpu_type
= parse_cpu_option(cpu_model
);
705 /* init tcg before creating CPUs and to get qemu_host_page_size */
707 AccelClass
*ac
= ACCEL_GET_CLASS(current_accel());
709 ac
->init_machine(NULL
);
710 accel_init_interfaces(ac
);
712 cpu
= cpu_create(cpu_type
);
718 * Reserving too much vm space via mmap can run into problems
719 * with rlimits, oom due to page table creation, etc. We will
720 * still try it, if directed by the command-line option, but
723 max_reserved_va
= MAX_RESERVED_VA(cpu
);
724 if (reserved_va
!= 0) {
725 if (max_reserved_va
&& reserved_va
> max_reserved_va
) {
726 fprintf(stderr
, "Reserved virtual address too big\n");
729 } else if (HOST_LONG_BITS
== 64 && TARGET_VIRT_ADDR_SPACE_BITS
<= 32) {
731 * reserved_va must be aligned with the host page size
732 * as it is used with mmap()
734 reserved_va
= max_reserved_va
& qemu_host_page_mask
;
739 if (seed_optarg
!= NULL
) {
740 qemu_guest_random_seed_main(seed_optarg
, &err
);
745 error_reportf_err(err
, "cannot initialize crypto: ");
750 target_environ
= envlist_to_environ(envlist
, NULL
);
751 envlist_free(envlist
);
754 * Read in mmap_min_addr kernel parameter. This value is used
755 * When loading the ELF image to determine whether guest_base
756 * is needed. It is also used in mmap_find_vma.
761 if ((fp
= fopen("/proc/sys/vm/mmap_min_addr", "r")) != NULL
) {
763 if (fscanf(fp
, "%lu", &tmp
) == 1 && tmp
!= 0) {
765 qemu_log_mask(CPU_LOG_PAGE
, "host mmap_min_addr=0x%lx\n",
773 * We prefer to not make NULL pointers accessible to QEMU.
774 * If we're in a chroot with no /proc, fall back to 1 page.
776 if (mmap_min_addr
== 0) {
777 mmap_min_addr
= qemu_host_page_size
;
778 qemu_log_mask(CPU_LOG_PAGE
,
779 "host mmap_min_addr=0x%lx (fallback)\n",
784 * Prepare copy of argv vector for target.
786 target_argc
= argc
- optind
;
787 target_argv
= calloc(target_argc
+ 1, sizeof (char *));
788 if (target_argv
== NULL
) {
789 (void) fprintf(stderr
, "Unable to allocate memory for target_argv\n");
794 * If argv0 is specified (using '-0' switch) we replace
795 * argv[0] pointer with the given one.
799 target_argv
[i
++] = strdup(argv0
);
801 for (; i
< target_argc
; i
++) {
802 target_argv
[i
] = strdup(argv
[optind
+ i
]);
804 target_argv
[target_argc
] = NULL
;
806 ts
= g_new0(TaskState
, 1);
808 /* build Task State */
814 ret
= loader_exec(execfd
, exec_path
, target_argv
, target_environ
, regs
,
817 printf("Error while loading %s: %s\n", exec_path
, strerror(-ret
));
821 for (wrk
= target_environ
; *wrk
; wrk
++) {
825 g_free(target_environ
);
827 if (qemu_loglevel_mask(CPU_LOG_PAGE
)) {
828 qemu_log("guest_base %p\n", (void *)guest_base
);
829 log_page_dump("binary load");
831 qemu_log("start_brk 0x" TARGET_ABI_FMT_lx
"\n", info
->start_brk
);
832 qemu_log("end_code 0x" TARGET_ABI_FMT_lx
"\n", info
->end_code
);
833 qemu_log("start_code 0x" TARGET_ABI_FMT_lx
"\n", info
->start_code
);
834 qemu_log("start_data 0x" TARGET_ABI_FMT_lx
"\n", info
->start_data
);
835 qemu_log("end_data 0x" TARGET_ABI_FMT_lx
"\n", info
->end_data
);
836 qemu_log("start_stack 0x" TARGET_ABI_FMT_lx
"\n", info
->start_stack
);
837 qemu_log("brk 0x" TARGET_ABI_FMT_lx
"\n", info
->brk
);
838 qemu_log("entry 0x" TARGET_ABI_FMT_lx
"\n", info
->entry
);
839 qemu_log("argv_start 0x" TARGET_ABI_FMT_lx
"\n", info
->arg_start
);
840 qemu_log("env_start 0x" TARGET_ABI_FMT_lx
"\n",
841 info
->arg_end
+ (abi_ulong
)sizeof(abi_ulong
));
842 qemu_log("auxv_start 0x" TARGET_ABI_FMT_lx
"\n", info
->saved_auxv
);
845 target_set_brk(info
->brk
);
849 /* Now that we've loaded the binary, GUEST_BASE is fixed. Delay
850 generating the prologue until now so that the prologue can take
851 the real value of GUEST_BASE into account. */
852 tcg_prologue_init(tcg_ctx
);
855 target_cpu_copy_regs(env
, regs
);
858 if (gdbserver_start(gdbstub
) < 0) {
859 fprintf(stderr
, "qemu: could not open gdbserver on %s\n",
863 gdb_handlesig(cpu
, 0);