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/>.
19 #include "qemu/osdep.h"
20 #include "qemu/units.h"
21 #include "qemu-version.h"
22 #include <sys/syscall.h>
23 #include <sys/resource.h>
25 #include "qapi/error.h"
27 #include "qemu/path.h"
28 #include "qemu/config-file.h"
29 #include "qemu/cutils.h"
30 #include "qemu/error-report.h"
31 #include "qemu/help_option.h"
33 #include "exec/exec-all.h"
35 #include "qemu/timer.h"
36 #include "qemu/envlist.h"
37 #include "qemu/guest-random.h"
39 #include "trace/control.h"
40 #include "target_elf.h"
41 #include "cpu_loop-common.h"
42 #include "crypto/init.h"
47 static const char *filename
;
48 static const char *argv0
;
49 static int gdbstub_port
;
50 static envlist_t
*envlist
;
51 static const char *cpu_model
;
52 static const char *cpu_type
;
53 static const char *seed_optarg
;
54 unsigned long mmap_min_addr
;
55 unsigned long guest_base
;
59 * When running 32-on-64 we should make sure we can fit all of the possible
60 * guest address space into a contiguous chunk of virtual host memory.
62 * This way we will never overlap with our own libraries or binaries or stack
63 * or anything else that QEMU maps.
65 * Many cpus reserve the high bit (or more than one for some 64-bit cpus)
66 * of the address for the kernel. Some cpus rely on this and user space
67 * uses the high bit(s) for pointer tagging and the like. For them, we
68 * must preserve the expected address space.
70 #ifndef MAX_RESERVED_VA
71 # if HOST_LONG_BITS > TARGET_VIRT_ADDR_SPACE_BITS
72 # if TARGET_VIRT_ADDR_SPACE_BITS == 32 && \
73 (TARGET_LONG_BITS == 32 || defined(TARGET_ABI32))
74 /* There are a number of places where we assign reserved_va to a variable
75 of type abi_ulong and expect it to fit. Avoid the last page. */
76 # define MAX_RESERVED_VA (0xfffffffful & TARGET_PAGE_MASK)
78 # define MAX_RESERVED_VA (1ul << TARGET_VIRT_ADDR_SPACE_BITS)
81 # define MAX_RESERVED_VA 0
85 unsigned long reserved_va
;
87 static void usage(int exitcode
);
89 static const char *interp_prefix
= CONFIG_QEMU_INTERP_PREFIX
;
90 const char *qemu_uname_release
;
92 /* XXX: on x86 MAP_GROWSDOWN only works if ESP <= address + 32, so
93 we allocate a bigger stack. Need a better solution, for example
94 by remapping the process stack directly at the right place */
95 unsigned long guest_stack_size
= 8 * 1024 * 1024UL;
97 void gemu_log(const char *fmt
, ...)
102 vfprintf(stderr
, fmt
, ap
);
106 #if defined(TARGET_I386)
107 int cpu_get_pic_interrupt(CPUX86State
*env
)
113 /***********************************************************/
114 /* Helper routines for implementing atomic operations. */
116 /* Make sure everything is in a consistent state for calling fork(). */
117 void fork_start(void)
124 void fork_end(int child
)
126 mmap_fork_end(child
);
128 CPUState
*cpu
, *next_cpu
;
129 /* Child processes created by fork() only have a single thread.
130 Discard information about the parent threads. */
131 CPU_FOREACH_SAFE(cpu
, next_cpu
) {
132 if (cpu
!= thread_cpu
) {
133 QTAILQ_REMOVE_RCU(&cpus
, cpu
, node
);
136 qemu_init_cpu_list();
137 gdbserver_fork(thread_cpu
);
138 /* qemu_init_cpu_list() takes care of reinitializing the
139 * exclusive state, so we don't need to end_exclusive() here.
147 __thread CPUState
*thread_cpu
;
149 bool qemu_cpu_is_self(CPUState
*cpu
)
151 return thread_cpu
== cpu
;
154 void qemu_cpu_kick(CPUState
*cpu
)
159 void task_settid(TaskState
*ts
)
161 if (ts
->ts_tid
== 0) {
162 ts
->ts_tid
= (pid_t
)syscall(SYS_gettid
);
166 void stop_all_tasks(void)
169 * We trust that when using NPTL, start_exclusive()
170 * handles thread stopping correctly.
175 /* Assumes contents are already zeroed. */
176 void init_task_state(TaskState
*ts
)
181 CPUArchState
*cpu_copy(CPUArchState
*env
)
183 CPUState
*cpu
= ENV_GET_CPU(env
);
184 CPUState
*new_cpu
= cpu_create(cpu_type
);
185 CPUArchState
*new_env
= new_cpu
->env_ptr
;
189 /* Reset non arch specific state */
192 memcpy(new_env
, env
, sizeof(CPUArchState
));
194 /* Clone all break/watchpoints.
195 Note: Once we support ptrace with hw-debug register access, make sure
196 BP_CPU break/watchpoints are handled correctly on clone. */
197 QTAILQ_INIT(&new_cpu
->breakpoints
);
198 QTAILQ_INIT(&new_cpu
->watchpoints
);
199 QTAILQ_FOREACH(bp
, &cpu
->breakpoints
, entry
) {
200 cpu_breakpoint_insert(new_cpu
, bp
->pc
, bp
->flags
, NULL
);
202 QTAILQ_FOREACH(wp
, &cpu
->watchpoints
, entry
) {
203 cpu_watchpoint_insert(new_cpu
, wp
->vaddr
, wp
->len
, wp
->flags
, NULL
);
209 static void handle_arg_help(const char *arg
)
214 static void handle_arg_log(const char *arg
)
218 mask
= qemu_str_to_log_mask(arg
);
220 qemu_print_log_usage(stdout
);
223 qemu_log_needs_buffers();
227 static void handle_arg_dfilter(const char *arg
)
229 qemu_set_dfilter_ranges(arg
, NULL
);
232 static void handle_arg_log_filename(const char *arg
)
234 qemu_set_log_filename(arg
, &error_fatal
);
237 static void handle_arg_set_env(const char *arg
)
241 while ((token
= strsep(&p
, ",")) != NULL
) {
242 if (envlist_setenv(envlist
, token
) != 0) {
249 static void handle_arg_unset_env(const char *arg
)
253 while ((token
= strsep(&p
, ",")) != NULL
) {
254 if (envlist_unsetenv(envlist
, token
) != 0) {
261 static void handle_arg_argv0(const char *arg
)
266 static void handle_arg_stack_size(const char *arg
)
269 guest_stack_size
= strtoul(arg
, &p
, 0);
270 if (guest_stack_size
== 0) {
275 guest_stack_size
*= MiB
;
276 } else if (*p
== 'k' || *p
== 'K') {
277 guest_stack_size
*= KiB
;
281 static void handle_arg_ld_prefix(const char *arg
)
283 interp_prefix
= strdup(arg
);
286 static void handle_arg_pagesize(const char *arg
)
288 qemu_host_page_size
= atoi(arg
);
289 if (qemu_host_page_size
== 0 ||
290 (qemu_host_page_size
& (qemu_host_page_size
- 1)) != 0) {
291 fprintf(stderr
, "page size must be a power of two\n");
296 static void handle_arg_seed(const char *arg
)
301 static void handle_arg_gdb(const char *arg
)
303 gdbstub_port
= atoi(arg
);
306 static void handle_arg_uname(const char *arg
)
308 qemu_uname_release
= strdup(arg
);
311 static void handle_arg_cpu(const char *arg
)
313 cpu_model
= strdup(arg
);
314 if (cpu_model
== NULL
|| is_help_option(cpu_model
)) {
315 /* XXX: implement xxx_cpu_list for targets that still miss it */
316 #if defined(cpu_list)
323 static void handle_arg_guest_base(const char *arg
)
325 guest_base
= strtol(arg
, NULL
, 0);
329 static void handle_arg_reserved_va(const char *arg
)
333 reserved_va
= strtoul(arg
, &p
, 0);
347 unsigned long unshifted
= reserved_va
;
349 reserved_va
<<= shift
;
350 if (reserved_va
>> shift
!= unshifted
351 || (MAX_RESERVED_VA
&& reserved_va
> MAX_RESERVED_VA
)) {
352 fprintf(stderr
, "Reserved virtual address too big\n");
357 fprintf(stderr
, "Unrecognised -R size suffix '%s'\n", p
);
362 static void handle_arg_singlestep(const char *arg
)
367 static void handle_arg_strace(const char *arg
)
372 static void handle_arg_version(const char *arg
)
374 printf("qemu-" TARGET_NAME
" version " QEMU_FULL_VERSION
375 "\n" QEMU_COPYRIGHT
"\n");
379 static char *trace_file
;
380 static void handle_arg_trace(const char *arg
)
383 trace_file
= trace_opt_parse(arg
);
386 struct qemu_argument
{
390 void (*handle_opt
)(const char *arg
);
395 static const struct qemu_argument arg_table
[] = {
396 {"h", "", false, handle_arg_help
,
397 "", "print this help"},
398 {"help", "", false, handle_arg_help
,
400 {"g", "QEMU_GDB", true, handle_arg_gdb
,
401 "port", "wait gdb connection to 'port'"},
402 {"L", "QEMU_LD_PREFIX", true, handle_arg_ld_prefix
,
403 "path", "set the elf interpreter prefix to 'path'"},
404 {"s", "QEMU_STACK_SIZE", true, handle_arg_stack_size
,
405 "size", "set the stack size to 'size' bytes"},
406 {"cpu", "QEMU_CPU", true, handle_arg_cpu
,
407 "model", "select CPU (-cpu help for list)"},
408 {"E", "QEMU_SET_ENV", true, handle_arg_set_env
,
409 "var=value", "sets targets environment variable (see below)"},
410 {"U", "QEMU_UNSET_ENV", true, handle_arg_unset_env
,
411 "var", "unsets targets environment variable (see below)"},
412 {"0", "QEMU_ARGV0", true, handle_arg_argv0
,
413 "argv0", "forces target process argv[0] to be 'argv0'"},
414 {"r", "QEMU_UNAME", true, handle_arg_uname
,
415 "uname", "set qemu uname release string to 'uname'"},
416 {"B", "QEMU_GUEST_BASE", true, handle_arg_guest_base
,
417 "address", "set guest_base address to 'address'"},
418 {"R", "QEMU_RESERVED_VA", true, handle_arg_reserved_va
,
419 "size", "reserve 'size' bytes for guest virtual address space"},
420 {"d", "QEMU_LOG", true, handle_arg_log
,
421 "item[,...]", "enable logging of specified items "
422 "(use '-d help' for a list of items)"},
423 {"dfilter", "QEMU_DFILTER", true, handle_arg_dfilter
,
424 "range[,...]","filter logging based on address range"},
425 {"D", "QEMU_LOG_FILENAME", true, handle_arg_log_filename
,
426 "logfile", "write logs to 'logfile' (default stderr)"},
427 {"p", "QEMU_PAGESIZE", true, handle_arg_pagesize
,
428 "pagesize", "set the host page size to 'pagesize'"},
429 {"singlestep", "QEMU_SINGLESTEP", false, handle_arg_singlestep
,
430 "", "run in singlestep mode"},
431 {"strace", "QEMU_STRACE", false, handle_arg_strace
,
432 "", "log system calls"},
433 {"seed", "QEMU_RAND_SEED", true, handle_arg_seed
,
434 "", "Seed for pseudo-random number generator"},
435 {"trace", "QEMU_TRACE", true, handle_arg_trace
,
436 "", "[[enable=]<pattern>][,events=<file>][,file=<file>]"},
437 {"version", "QEMU_VERSION", false, handle_arg_version
,
438 "", "display version information and exit"},
439 {NULL
, NULL
, false, NULL
, NULL
, NULL
}
442 static void usage(int exitcode
)
444 const struct qemu_argument
*arginfo
;
448 printf("usage: qemu-" TARGET_NAME
" [options] program [arguments...]\n"
449 "Linux CPU emulator (compiled for " TARGET_NAME
" emulation)\n"
451 "Options and associated environment variables:\n"
454 /* Calculate column widths. We must always have at least enough space
455 * for the column header.
457 maxarglen
= strlen("Argument");
458 maxenvlen
= strlen("Env-variable");
460 for (arginfo
= arg_table
; arginfo
->handle_opt
!= NULL
; arginfo
++) {
461 int arglen
= strlen(arginfo
->argv
);
462 if (arginfo
->has_arg
) {
463 arglen
+= strlen(arginfo
->example
) + 1;
465 if (strlen(arginfo
->env
) > maxenvlen
) {
466 maxenvlen
= strlen(arginfo
->env
);
468 if (arglen
> maxarglen
) {
473 printf("%-*s %-*s Description\n", maxarglen
+1, "Argument",
474 maxenvlen
, "Env-variable");
476 for (arginfo
= arg_table
; arginfo
->handle_opt
!= NULL
; arginfo
++) {
477 if (arginfo
->has_arg
) {
478 printf("-%s %-*s %-*s %s\n", arginfo
->argv
,
479 (int)(maxarglen
- strlen(arginfo
->argv
) - 1),
480 arginfo
->example
, maxenvlen
, arginfo
->env
, arginfo
->help
);
482 printf("-%-*s %-*s %s\n", maxarglen
, arginfo
->argv
,
483 maxenvlen
, arginfo
->env
,
490 "QEMU_LD_PREFIX = %s\n"
491 "QEMU_STACK_SIZE = %ld byte\n",
496 "You can use -E and -U options or the QEMU_SET_ENV and\n"
497 "QEMU_UNSET_ENV environment variables to set and unset\n"
498 "environment variables for the target process.\n"
499 "It is possible to provide several variables by separating them\n"
500 "by commas in getsubopt(3) style. Additionally it is possible to\n"
501 "provide the -E and -U options multiple times.\n"
502 "The following lines are equivalent:\n"
503 " -E var1=val2 -E var2=val2 -U LD_PRELOAD -U LD_DEBUG\n"
504 " -E var1=val2,var2=val2 -U LD_PRELOAD,LD_DEBUG\n"
505 " QEMU_SET_ENV=var1=val2,var2=val2 QEMU_UNSET_ENV=LD_PRELOAD,LD_DEBUG\n"
506 "Note that if you provide several changes to a single variable\n"
507 "the last change will stay in effect.\n"
509 QEMU_HELP_BOTTOM
"\n");
514 static int parse_args(int argc
, char **argv
)
518 const struct qemu_argument
*arginfo
;
520 for (arginfo
= arg_table
; arginfo
->handle_opt
!= NULL
; arginfo
++) {
521 if (arginfo
->env
== NULL
) {
525 r
= getenv(arginfo
->env
);
527 arginfo
->handle_opt(r
);
533 if (optind
>= argc
) {
542 if (!strcmp(r
, "-")) {
545 /* Treat --foo the same as -foo. */
550 for (arginfo
= arg_table
; arginfo
->handle_opt
!= NULL
; arginfo
++) {
551 if (!strcmp(r
, arginfo
->argv
)) {
552 if (arginfo
->has_arg
) {
553 if (optind
>= argc
) {
554 (void) fprintf(stderr
,
555 "qemu: missing argument for option '%s'\n", r
);
558 arginfo
->handle_opt(argv
[optind
]);
561 arginfo
->handle_opt(NULL
);
567 /* no option matched the current argv */
568 if (arginfo
->handle_opt
== NULL
) {
569 (void) fprintf(stderr
, "qemu: unknown option '%s'\n", r
);
574 if (optind
>= argc
) {
575 (void) fprintf(stderr
, "qemu: no user program specified\n");
579 filename
= argv
[optind
];
580 exec_path
= argv
[optind
];
585 int main(int argc
, char **argv
, char **envp
)
587 struct target_pt_regs regs1
, *regs
= ®s1
;
588 struct image_info info1
, *info
= &info1
;
589 struct linux_binprm bprm
;
594 char **target_environ
, **wrk
;
602 module_call_init(MODULE_INIT_TRACE
);
603 qemu_init_cpu_list();
604 module_call_init(MODULE_INIT_QOM
);
606 envlist
= envlist_create();
608 /* add current environment into the list */
609 for (wrk
= environ
; *wrk
!= NULL
; wrk
++) {
610 (void) envlist_setenv(envlist
, *wrk
);
613 /* Read the stack limit from the kernel. If it's "unlimited",
614 then we can do little else besides use the default. */
617 if (getrlimit(RLIMIT_STACK
, &lim
) == 0
618 && lim
.rlim_cur
!= RLIM_INFINITY
619 && lim
.rlim_cur
== (target_long
)lim
.rlim_cur
) {
620 guest_stack_size
= lim
.rlim_cur
;
626 qemu_add_opts(&qemu_trace_opts
);
628 optind
= parse_args(argc
, argv
);
630 if (!trace_init_backends()) {
633 trace_init_file(trace_file
);
636 memset(regs
, 0, sizeof(struct target_pt_regs
));
638 /* Zero out image_info */
639 memset(info
, 0, sizeof(struct image_info
));
641 memset(&bprm
, 0, sizeof (bprm
));
643 /* Scan interp_prefix dir for replacement files. */
644 init_paths(interp_prefix
);
646 init_qemu_uname_release();
648 execfd
= qemu_getauxval(AT_EXECFD
);
650 execfd
= open(filename
, O_RDONLY
);
652 printf("Error while loading %s: %s\n", filename
, strerror(errno
));
657 if (cpu_model
== NULL
) {
658 cpu_model
= cpu_get_model(get_elf_eflags(execfd
));
660 cpu_type
= parse_cpu_option(cpu_model
);
662 /* init tcg before creating CPUs and to get qemu_host_page_size */
665 /* Reserving *too* much vm space via mmap can run into problems
666 with rlimits, oom due to page table creation, etc. We will still try it,
667 if directed by the command-line option, but not by default. */
668 if (HOST_LONG_BITS
== 64 &&
669 TARGET_VIRT_ADDR_SPACE_BITS
<= 32 &&
671 /* reserved_va must be aligned with the host page size
672 * as it is used with mmap()
674 reserved_va
= MAX_RESERVED_VA
& qemu_host_page_mask
;
677 cpu
= cpu_create(cpu_type
);
683 if (getenv("QEMU_STRACE")) {
687 if (seed_optarg
== NULL
) {
688 seed_optarg
= getenv("QEMU_RAND_SEED");
692 if (seed_optarg
!= NULL
) {
693 qemu_guest_random_seed_main(seed_optarg
, &err
);
698 error_reportf_err(err
, "cannot initialize crypto: ");
703 target_environ
= envlist_to_environ(envlist
, NULL
);
704 envlist_free(envlist
);
707 * Now that page sizes are configured in tcg_exec_init() we can do
708 * proper page alignment for guest_base.
710 guest_base
= HOST_PAGE_ALIGN(guest_base
);
712 if (reserved_va
|| have_guest_base
) {
713 guest_base
= init_guest_space(guest_base
, reserved_va
, 0,
715 if (guest_base
== (unsigned long)-1) {
716 fprintf(stderr
, "Unable to reserve 0x%lx bytes of virtual address "
717 "space for use as guest address space (check your virtual "
718 "memory ulimit setting or reserve less using -R option)\n",
724 mmap_next_start
= reserved_va
;
729 * Read in mmap_min_addr kernel parameter. This value is used
730 * When loading the ELF image to determine whether guest_base
731 * is needed. It is also used in mmap_find_vma.
736 if ((fp
= fopen("/proc/sys/vm/mmap_min_addr", "r")) != NULL
) {
738 if (fscanf(fp
, "%lu", &tmp
) == 1) {
740 qemu_log_mask(CPU_LOG_PAGE
, "host mmap_min_addr=0x%lx\n", mmap_min_addr
);
747 * Prepare copy of argv vector for target.
749 target_argc
= argc
- optind
;
750 target_argv
= calloc(target_argc
+ 1, sizeof (char *));
751 if (target_argv
== NULL
) {
752 (void) fprintf(stderr
, "Unable to allocate memory for target_argv\n");
757 * If argv0 is specified (using '-0' switch) we replace
758 * argv[0] pointer with the given one.
762 target_argv
[i
++] = strdup(argv0
);
764 for (; i
< target_argc
; i
++) {
765 target_argv
[i
] = strdup(argv
[optind
+ i
]);
767 target_argv
[target_argc
] = NULL
;
769 ts
= g_new0(TaskState
, 1);
771 /* build Task State */
777 ret
= loader_exec(execfd
, filename
, target_argv
, target_environ
, regs
,
780 printf("Error while loading %s: %s\n", filename
, strerror(-ret
));
784 for (wrk
= target_environ
; *wrk
; wrk
++) {
788 g_free(target_environ
);
790 if (qemu_loglevel_mask(CPU_LOG_PAGE
)) {
791 qemu_log("guest_base 0x%lx\n", guest_base
);
794 qemu_log("start_brk 0x" TARGET_ABI_FMT_lx
"\n", info
->start_brk
);
795 qemu_log("end_code 0x" TARGET_ABI_FMT_lx
"\n", info
->end_code
);
796 qemu_log("start_code 0x" TARGET_ABI_FMT_lx
"\n", info
->start_code
);
797 qemu_log("start_data 0x" TARGET_ABI_FMT_lx
"\n", info
->start_data
);
798 qemu_log("end_data 0x" TARGET_ABI_FMT_lx
"\n", info
->end_data
);
799 qemu_log("start_stack 0x" TARGET_ABI_FMT_lx
"\n", info
->start_stack
);
800 qemu_log("brk 0x" TARGET_ABI_FMT_lx
"\n", info
->brk
);
801 qemu_log("entry 0x" TARGET_ABI_FMT_lx
"\n", info
->entry
);
802 qemu_log("argv_start 0x" TARGET_ABI_FMT_lx
"\n", info
->arg_start
);
803 qemu_log("env_start 0x" TARGET_ABI_FMT_lx
"\n",
804 info
->arg_end
+ (abi_ulong
)sizeof(abi_ulong
));
805 qemu_log("auxv_start 0x" TARGET_ABI_FMT_lx
"\n", info
->saved_auxv
);
808 target_set_brk(info
->brk
);
812 /* Now that we've loaded the binary, GUEST_BASE is fixed. Delay
813 generating the prologue until now so that the prologue can take
814 the real value of GUEST_BASE into account. */
815 tcg_prologue_init(tcg_ctx
);
818 target_cpu_copy_regs(env
, regs
);
821 if (gdbserver_start(gdbstub_port
) < 0) {
822 fprintf(stderr
, "qemu: could not open gdbserver on port %d\n",
826 gdb_handlesig(cpu
, 0);