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/units.h"
22 #include "sysemu/tcg.h"
23 #include "qemu-version.h"
24 #include <sys/syscall.h>
25 #include <sys/resource.h>
27 #include "qapi/error.h"
29 #include "qemu/path.h"
30 #include "qemu/config-file.h"
31 #include "qemu/cutils.h"
32 #include "qemu/error-report.h"
33 #include "qemu/help_option.h"
34 #include "qemu/module.h"
36 #include "exec/exec-all.h"
38 #include "qemu/timer.h"
39 #include "qemu/envlist.h"
40 #include "qemu/guest-random.h"
42 #include "trace/control.h"
43 #include "target_elf.h"
44 #include "cpu_loop-common.h"
45 #include "crypto/init.h"
50 static const char *filename
;
51 static const char *argv0
;
52 static int gdbstub_port
;
53 static envlist_t
*envlist
;
54 static const char *cpu_model
;
55 static const char *cpu_type
;
56 static const char *seed_optarg
;
57 unsigned long mmap_min_addr
;
58 unsigned long guest_base
;
62 * When running 32-on-64 we should make sure we can fit all of the possible
63 * guest address space into a contiguous chunk of virtual host memory.
65 * This way we will never overlap with our own libraries or binaries or stack
66 * or anything else that QEMU maps.
68 * Many cpus reserve the high bit (or more than one for some 64-bit cpus)
69 * of the address for the kernel. Some cpus rely on this and user space
70 * uses the high bit(s) for pointer tagging and the like. For them, we
71 * must preserve the expected address space.
73 #ifndef MAX_RESERVED_VA
74 # if HOST_LONG_BITS > TARGET_VIRT_ADDR_SPACE_BITS
75 # if TARGET_VIRT_ADDR_SPACE_BITS == 32 && \
76 (TARGET_LONG_BITS == 32 || defined(TARGET_ABI32))
77 /* There are a number of places where we assign reserved_va to a variable
78 of type abi_ulong and expect it to fit. Avoid the last page. */
79 # define MAX_RESERVED_VA (0xfffffffful & TARGET_PAGE_MASK)
81 # define MAX_RESERVED_VA (1ul << TARGET_VIRT_ADDR_SPACE_BITS)
84 # define MAX_RESERVED_VA 0
88 unsigned long reserved_va
;
90 static void usage(int exitcode
);
92 static const char *interp_prefix
= CONFIG_QEMU_INTERP_PREFIX
;
93 const char *qemu_uname_release
;
95 /* XXX: on x86 MAP_GROWSDOWN only works if ESP <= address + 32, so
96 we allocate a bigger stack. Need a better solution, for example
97 by remapping the process stack directly at the right place */
98 unsigned long guest_stack_size
= 8 * 1024 * 1024UL;
100 void gemu_log(const char *fmt
, ...)
105 vfprintf(stderr
, fmt
, ap
);
109 #if defined(TARGET_I386)
110 int cpu_get_pic_interrupt(CPUX86State
*env
)
116 /***********************************************************/
117 /* Helper routines for implementing atomic operations. */
119 /* Make sure everything is in a consistent state for calling fork(). */
120 void fork_start(void)
127 void fork_end(int child
)
129 mmap_fork_end(child
);
131 CPUState
*cpu
, *next_cpu
;
132 /* Child processes created by fork() only have a single thread.
133 Discard information about the parent threads. */
134 CPU_FOREACH_SAFE(cpu
, next_cpu
) {
135 if (cpu
!= thread_cpu
) {
136 QTAILQ_REMOVE_RCU(&cpus
, cpu
, node
);
139 qemu_init_cpu_list();
140 gdbserver_fork(thread_cpu
);
141 /* qemu_init_cpu_list() takes care of reinitializing the
142 * exclusive state, so we don't need to end_exclusive() here.
150 __thread CPUState
*thread_cpu
;
152 bool qemu_cpu_is_self(CPUState
*cpu
)
154 return thread_cpu
== cpu
;
157 void qemu_cpu_kick(CPUState
*cpu
)
162 void task_settid(TaskState
*ts
)
164 if (ts
->ts_tid
== 0) {
165 ts
->ts_tid
= (pid_t
)syscall(SYS_gettid
);
169 void stop_all_tasks(void)
172 * We trust that when using NPTL, start_exclusive()
173 * handles thread stopping correctly.
178 /* Assumes contents are already zeroed. */
179 void init_task_state(TaskState
*ts
)
184 CPUArchState
*cpu_copy(CPUArchState
*env
)
186 CPUState
*cpu
= env_cpu(env
);
187 CPUState
*new_cpu
= cpu_create(cpu_type
);
188 CPUArchState
*new_env
= new_cpu
->env_ptr
;
192 /* Reset non arch specific state */
195 memcpy(new_env
, env
, sizeof(CPUArchState
));
197 /* Clone all break/watchpoints.
198 Note: Once we support ptrace with hw-debug register access, make sure
199 BP_CPU break/watchpoints are handled correctly on clone. */
200 QTAILQ_INIT(&new_cpu
->breakpoints
);
201 QTAILQ_INIT(&new_cpu
->watchpoints
);
202 QTAILQ_FOREACH(bp
, &cpu
->breakpoints
, entry
) {
203 cpu_breakpoint_insert(new_cpu
, bp
->pc
, bp
->flags
, NULL
);
205 QTAILQ_FOREACH(wp
, &cpu
->watchpoints
, entry
) {
206 cpu_watchpoint_insert(new_cpu
, wp
->vaddr
, wp
->len
, wp
->flags
, NULL
);
212 static void handle_arg_help(const char *arg
)
217 static void handle_arg_log(const char *arg
)
221 mask
= qemu_str_to_log_mask(arg
);
223 qemu_print_log_usage(stdout
);
226 qemu_log_needs_buffers();
230 static void handle_arg_dfilter(const char *arg
)
232 qemu_set_dfilter_ranges(arg
, NULL
);
235 static void handle_arg_log_filename(const char *arg
)
237 qemu_set_log_filename(arg
, &error_fatal
);
240 static void handle_arg_set_env(const char *arg
)
244 while ((token
= strsep(&p
, ",")) != NULL
) {
245 if (envlist_setenv(envlist
, token
) != 0) {
252 static void handle_arg_unset_env(const char *arg
)
256 while ((token
= strsep(&p
, ",")) != NULL
) {
257 if (envlist_unsetenv(envlist
, token
) != 0) {
264 static void handle_arg_argv0(const char *arg
)
269 static void handle_arg_stack_size(const char *arg
)
272 guest_stack_size
= strtoul(arg
, &p
, 0);
273 if (guest_stack_size
== 0) {
278 guest_stack_size
*= MiB
;
279 } else if (*p
== 'k' || *p
== 'K') {
280 guest_stack_size
*= KiB
;
284 static void handle_arg_ld_prefix(const char *arg
)
286 interp_prefix
= strdup(arg
);
289 static void handle_arg_pagesize(const char *arg
)
291 qemu_host_page_size
= atoi(arg
);
292 if (qemu_host_page_size
== 0 ||
293 (qemu_host_page_size
& (qemu_host_page_size
- 1)) != 0) {
294 fprintf(stderr
, "page size must be a power of two\n");
299 static void handle_arg_seed(const char *arg
)
304 static void handle_arg_gdb(const char *arg
)
306 gdbstub_port
= atoi(arg
);
309 static void handle_arg_uname(const char *arg
)
311 qemu_uname_release
= strdup(arg
);
314 static void handle_arg_cpu(const char *arg
)
316 cpu_model
= strdup(arg
);
317 if (cpu_model
== NULL
|| is_help_option(cpu_model
)) {
318 /* XXX: implement xxx_cpu_list for targets that still miss it */
319 #if defined(cpu_list)
326 static void handle_arg_guest_base(const char *arg
)
328 guest_base
= strtol(arg
, NULL
, 0);
332 static void handle_arg_reserved_va(const char *arg
)
336 reserved_va
= strtoul(arg
, &p
, 0);
350 unsigned long unshifted
= reserved_va
;
352 reserved_va
<<= shift
;
353 if (reserved_va
>> shift
!= unshifted
354 || (MAX_RESERVED_VA
&& reserved_va
> MAX_RESERVED_VA
)) {
355 fprintf(stderr
, "Reserved virtual address too big\n");
360 fprintf(stderr
, "Unrecognised -R size suffix '%s'\n", p
);
365 static void handle_arg_singlestep(const char *arg
)
370 static void handle_arg_strace(const char *arg
)
375 static void handle_arg_version(const char *arg
)
377 printf("qemu-" TARGET_NAME
" version " QEMU_FULL_VERSION
378 "\n" QEMU_COPYRIGHT
"\n");
382 static char *trace_file
;
383 static void handle_arg_trace(const char *arg
)
386 trace_file
= trace_opt_parse(arg
);
389 struct qemu_argument
{
393 void (*handle_opt
)(const char *arg
);
398 static const struct qemu_argument arg_table
[] = {
399 {"h", "", false, handle_arg_help
,
400 "", "print this help"},
401 {"help", "", false, handle_arg_help
,
403 {"g", "QEMU_GDB", true, handle_arg_gdb
,
404 "port", "wait gdb connection to 'port'"},
405 {"L", "QEMU_LD_PREFIX", true, handle_arg_ld_prefix
,
406 "path", "set the elf interpreter prefix to 'path'"},
407 {"s", "QEMU_STACK_SIZE", true, handle_arg_stack_size
,
408 "size", "set the stack size to 'size' bytes"},
409 {"cpu", "QEMU_CPU", true, handle_arg_cpu
,
410 "model", "select CPU (-cpu help for list)"},
411 {"E", "QEMU_SET_ENV", true, handle_arg_set_env
,
412 "var=value", "sets targets environment variable (see below)"},
413 {"U", "QEMU_UNSET_ENV", true, handle_arg_unset_env
,
414 "var", "unsets targets environment variable (see below)"},
415 {"0", "QEMU_ARGV0", true, handle_arg_argv0
,
416 "argv0", "forces target process argv[0] to be 'argv0'"},
417 {"r", "QEMU_UNAME", true, handle_arg_uname
,
418 "uname", "set qemu uname release string to 'uname'"},
419 {"B", "QEMU_GUEST_BASE", true, handle_arg_guest_base
,
420 "address", "set guest_base address to 'address'"},
421 {"R", "QEMU_RESERVED_VA", true, handle_arg_reserved_va
,
422 "size", "reserve 'size' bytes for guest virtual address space"},
423 {"d", "QEMU_LOG", true, handle_arg_log
,
424 "item[,...]", "enable logging of specified items "
425 "(use '-d help' for a list of items)"},
426 {"dfilter", "QEMU_DFILTER", true, handle_arg_dfilter
,
427 "range[,...]","filter logging based on address range"},
428 {"D", "QEMU_LOG_FILENAME", true, handle_arg_log_filename
,
429 "logfile", "write logs to 'logfile' (default stderr)"},
430 {"p", "QEMU_PAGESIZE", true, handle_arg_pagesize
,
431 "pagesize", "set the host page size to 'pagesize'"},
432 {"singlestep", "QEMU_SINGLESTEP", false, handle_arg_singlestep
,
433 "", "run in singlestep mode"},
434 {"strace", "QEMU_STRACE", false, handle_arg_strace
,
435 "", "log system calls"},
436 {"seed", "QEMU_RAND_SEED", true, handle_arg_seed
,
437 "", "Seed for pseudo-random number generator"},
438 {"trace", "QEMU_TRACE", true, handle_arg_trace
,
439 "", "[[enable=]<pattern>][,events=<file>][,file=<file>]"},
440 {"version", "QEMU_VERSION", false, handle_arg_version
,
441 "", "display version information and exit"},
442 {NULL
, NULL
, false, NULL
, NULL
, NULL
}
445 static void usage(int exitcode
)
447 const struct qemu_argument
*arginfo
;
451 printf("usage: qemu-" TARGET_NAME
" [options] program [arguments...]\n"
452 "Linux CPU emulator (compiled for " TARGET_NAME
" emulation)\n"
454 "Options and associated environment variables:\n"
457 /* Calculate column widths. We must always have at least enough space
458 * for the column header.
460 maxarglen
= strlen("Argument");
461 maxenvlen
= strlen("Env-variable");
463 for (arginfo
= arg_table
; arginfo
->handle_opt
!= NULL
; arginfo
++) {
464 int arglen
= strlen(arginfo
->argv
);
465 if (arginfo
->has_arg
) {
466 arglen
+= strlen(arginfo
->example
) + 1;
468 if (strlen(arginfo
->env
) > maxenvlen
) {
469 maxenvlen
= strlen(arginfo
->env
);
471 if (arglen
> maxarglen
) {
476 printf("%-*s %-*s Description\n", maxarglen
+1, "Argument",
477 maxenvlen
, "Env-variable");
479 for (arginfo
= arg_table
; arginfo
->handle_opt
!= NULL
; arginfo
++) {
480 if (arginfo
->has_arg
) {
481 printf("-%s %-*s %-*s %s\n", arginfo
->argv
,
482 (int)(maxarglen
- strlen(arginfo
->argv
) - 1),
483 arginfo
->example
, maxenvlen
, arginfo
->env
, arginfo
->help
);
485 printf("-%-*s %-*s %s\n", maxarglen
, arginfo
->argv
,
486 maxenvlen
, arginfo
->env
,
493 "QEMU_LD_PREFIX = %s\n"
494 "QEMU_STACK_SIZE = %ld byte\n",
499 "You can use -E and -U options or the QEMU_SET_ENV and\n"
500 "QEMU_UNSET_ENV environment variables to set and unset\n"
501 "environment variables for the target process.\n"
502 "It is possible to provide several variables by separating them\n"
503 "by commas in getsubopt(3) style. Additionally it is possible to\n"
504 "provide the -E and -U options multiple times.\n"
505 "The following lines are equivalent:\n"
506 " -E var1=val2 -E var2=val2 -U LD_PRELOAD -U LD_DEBUG\n"
507 " -E var1=val2,var2=val2 -U LD_PRELOAD,LD_DEBUG\n"
508 " QEMU_SET_ENV=var1=val2,var2=val2 QEMU_UNSET_ENV=LD_PRELOAD,LD_DEBUG\n"
509 "Note that if you provide several changes to a single variable\n"
510 "the last change will stay in effect.\n"
512 QEMU_HELP_BOTTOM
"\n");
517 static int parse_args(int argc
, char **argv
)
521 const struct qemu_argument
*arginfo
;
523 for (arginfo
= arg_table
; arginfo
->handle_opt
!= NULL
; arginfo
++) {
524 if (arginfo
->env
== NULL
) {
528 r
= getenv(arginfo
->env
);
530 arginfo
->handle_opt(r
);
536 if (optind
>= argc
) {
545 if (!strcmp(r
, "-")) {
548 /* Treat --foo the same as -foo. */
553 for (arginfo
= arg_table
; arginfo
->handle_opt
!= NULL
; arginfo
++) {
554 if (!strcmp(r
, arginfo
->argv
)) {
555 if (arginfo
->has_arg
) {
556 if (optind
>= argc
) {
557 (void) fprintf(stderr
,
558 "qemu: missing argument for option '%s'\n", r
);
561 arginfo
->handle_opt(argv
[optind
]);
564 arginfo
->handle_opt(NULL
);
570 /* no option matched the current argv */
571 if (arginfo
->handle_opt
== NULL
) {
572 (void) fprintf(stderr
, "qemu: unknown option '%s'\n", r
);
577 if (optind
>= argc
) {
578 (void) fprintf(stderr
, "qemu: no user program specified\n");
582 filename
= argv
[optind
];
583 exec_path
= argv
[optind
];
588 int main(int argc
, char **argv
, char **envp
)
590 struct target_pt_regs regs1
, *regs
= ®s1
;
591 struct image_info info1
, *info
= &info1
;
592 struct linux_binprm bprm
;
597 char **target_environ
, **wrk
;
605 module_call_init(MODULE_INIT_TRACE
);
606 qemu_init_cpu_list();
607 module_call_init(MODULE_INIT_QOM
);
609 envlist
= envlist_create();
611 /* add current environment into the list */
612 for (wrk
= environ
; *wrk
!= NULL
; wrk
++) {
613 (void) envlist_setenv(envlist
, *wrk
);
616 /* Read the stack limit from the kernel. If it's "unlimited",
617 then we can do little else besides use the default. */
620 if (getrlimit(RLIMIT_STACK
, &lim
) == 0
621 && lim
.rlim_cur
!= RLIM_INFINITY
622 && lim
.rlim_cur
== (target_long
)lim
.rlim_cur
) {
623 guest_stack_size
= lim
.rlim_cur
;
629 qemu_add_opts(&qemu_trace_opts
);
631 optind
= parse_args(argc
, argv
);
633 if (!trace_init_backends()) {
636 trace_init_file(trace_file
);
639 memset(regs
, 0, sizeof(struct target_pt_regs
));
641 /* Zero out image_info */
642 memset(info
, 0, sizeof(struct image_info
));
644 memset(&bprm
, 0, sizeof (bprm
));
646 /* Scan interp_prefix dir for replacement files. */
647 init_paths(interp_prefix
);
649 init_qemu_uname_release();
651 execfd
= qemu_getauxval(AT_EXECFD
);
653 execfd
= open(filename
, O_RDONLY
);
655 printf("Error while loading %s: %s\n", filename
, strerror(errno
));
660 if (cpu_model
== NULL
) {
661 cpu_model
= cpu_get_model(get_elf_eflags(execfd
));
663 cpu_type
= parse_cpu_option(cpu_model
);
665 /* init tcg before creating CPUs and to get qemu_host_page_size */
668 /* Reserving *too* much vm space via mmap can run into problems
669 with rlimits, oom due to page table creation, etc. We will still try it,
670 if directed by the command-line option, but not by default. */
671 if (HOST_LONG_BITS
== 64 &&
672 TARGET_VIRT_ADDR_SPACE_BITS
<= 32 &&
674 /* reserved_va must be aligned with the host page size
675 * as it is used with mmap()
677 reserved_va
= MAX_RESERVED_VA
& qemu_host_page_mask
;
680 cpu
= cpu_create(cpu_type
);
686 if (getenv("QEMU_STRACE")) {
690 if (seed_optarg
== NULL
) {
691 seed_optarg
= getenv("QEMU_RAND_SEED");
695 if (seed_optarg
!= NULL
) {
696 qemu_guest_random_seed_main(seed_optarg
, &err
);
701 error_reportf_err(err
, "cannot initialize crypto: ");
706 target_environ
= envlist_to_environ(envlist
, NULL
);
707 envlist_free(envlist
);
710 * Now that page sizes are configured in tcg_exec_init() we can do
711 * proper page alignment for guest_base.
713 guest_base
= HOST_PAGE_ALIGN(guest_base
);
715 if (reserved_va
|| have_guest_base
) {
716 guest_base
= init_guest_space(guest_base
, reserved_va
, 0,
718 if (guest_base
== (unsigned long)-1) {
719 fprintf(stderr
, "Unable to reserve 0x%lx bytes of virtual address "
720 "space for use as guest address space (check your virtual "
721 "memory ulimit setting or reserve less using -R option)\n",
727 mmap_next_start
= reserved_va
;
732 * Read in mmap_min_addr kernel parameter. This value is used
733 * When loading the ELF image to determine whether guest_base
734 * is needed. It is also used in mmap_find_vma.
739 if ((fp
= fopen("/proc/sys/vm/mmap_min_addr", "r")) != NULL
) {
741 if (fscanf(fp
, "%lu", &tmp
) == 1) {
743 qemu_log_mask(CPU_LOG_PAGE
, "host mmap_min_addr=0x%lx\n", mmap_min_addr
);
750 * Prepare copy of argv vector for target.
752 target_argc
= argc
- optind
;
753 target_argv
= calloc(target_argc
+ 1, sizeof (char *));
754 if (target_argv
== NULL
) {
755 (void) fprintf(stderr
, "Unable to allocate memory for target_argv\n");
760 * If argv0 is specified (using '-0' switch) we replace
761 * argv[0] pointer with the given one.
765 target_argv
[i
++] = strdup(argv0
);
767 for (; i
< target_argc
; i
++) {
768 target_argv
[i
] = strdup(argv
[optind
+ i
]);
770 target_argv
[target_argc
] = NULL
;
772 ts
= g_new0(TaskState
, 1);
774 /* build Task State */
780 ret
= loader_exec(execfd
, filename
, target_argv
, target_environ
, regs
,
783 printf("Error while loading %s: %s\n", filename
, strerror(-ret
));
787 for (wrk
= target_environ
; *wrk
; wrk
++) {
791 g_free(target_environ
);
793 if (qemu_loglevel_mask(CPU_LOG_PAGE
)) {
794 qemu_log("guest_base 0x%lx\n", guest_base
);
797 qemu_log("start_brk 0x" TARGET_ABI_FMT_lx
"\n", info
->start_brk
);
798 qemu_log("end_code 0x" TARGET_ABI_FMT_lx
"\n", info
->end_code
);
799 qemu_log("start_code 0x" TARGET_ABI_FMT_lx
"\n", info
->start_code
);
800 qemu_log("start_data 0x" TARGET_ABI_FMT_lx
"\n", info
->start_data
);
801 qemu_log("end_data 0x" TARGET_ABI_FMT_lx
"\n", info
->end_data
);
802 qemu_log("start_stack 0x" TARGET_ABI_FMT_lx
"\n", info
->start_stack
);
803 qemu_log("brk 0x" TARGET_ABI_FMT_lx
"\n", info
->brk
);
804 qemu_log("entry 0x" TARGET_ABI_FMT_lx
"\n", info
->entry
);
805 qemu_log("argv_start 0x" TARGET_ABI_FMT_lx
"\n", info
->arg_start
);
806 qemu_log("env_start 0x" TARGET_ABI_FMT_lx
"\n",
807 info
->arg_end
+ (abi_ulong
)sizeof(abi_ulong
));
808 qemu_log("auxv_start 0x" TARGET_ABI_FMT_lx
"\n", info
->saved_auxv
);
811 target_set_brk(info
->brk
);
815 /* Now that we've loaded the binary, GUEST_BASE is fixed. Delay
816 generating the prologue until now so that the prologue can take
817 the real value of GUEST_BASE into account. */
818 tcg_prologue_init(tcg_ctx
);
821 target_cpu_copy_regs(env
, regs
);
824 if (gdbserver_start(gdbstub_port
) < 0) {
825 fprintf(stderr
, "qemu: could not open gdbserver on port %d\n",
829 gdb_handlesig(cpu
, 0);