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"
35 #include "exec/exec-all.h"
37 #include "qemu/timer.h"
38 #include "qemu/envlist.h"
39 #include "qemu/guest-random.h"
41 #include "trace/control.h"
42 #include "target_elf.h"
43 #include "cpu_loop-common.h"
44 #include "crypto/init.h"
49 static const char *filename
;
50 static const char *argv0
;
51 static int gdbstub_port
;
52 static envlist_t
*envlist
;
53 static const char *cpu_model
;
54 static const char *cpu_type
;
55 static const char *seed_optarg
;
56 unsigned long mmap_min_addr
;
57 unsigned long guest_base
;
61 * When running 32-on-64 we should make sure we can fit all of the possible
62 * guest address space into a contiguous chunk of virtual host memory.
64 * This way we will never overlap with our own libraries or binaries or stack
65 * or anything else that QEMU maps.
67 * Many cpus reserve the high bit (or more than one for some 64-bit cpus)
68 * of the address for the kernel. Some cpus rely on this and user space
69 * uses the high bit(s) for pointer tagging and the like. For them, we
70 * must preserve the expected address space.
72 #ifndef MAX_RESERVED_VA
73 # if HOST_LONG_BITS > TARGET_VIRT_ADDR_SPACE_BITS
74 # if TARGET_VIRT_ADDR_SPACE_BITS == 32 && \
75 (TARGET_LONG_BITS == 32 || defined(TARGET_ABI32))
76 /* There are a number of places where we assign reserved_va to a variable
77 of type abi_ulong and expect it to fit. Avoid the last page. */
78 # define MAX_RESERVED_VA (0xfffffffful & TARGET_PAGE_MASK)
80 # define MAX_RESERVED_VA (1ul << TARGET_VIRT_ADDR_SPACE_BITS)
83 # define MAX_RESERVED_VA 0
87 unsigned long reserved_va
;
89 static void usage(int exitcode
);
91 static const char *interp_prefix
= CONFIG_QEMU_INTERP_PREFIX
;
92 const char *qemu_uname_release
;
94 /* XXX: on x86 MAP_GROWSDOWN only works if ESP <= address + 32, so
95 we allocate a bigger stack. Need a better solution, for example
96 by remapping the process stack directly at the right place */
97 unsigned long guest_stack_size
= 8 * 1024 * 1024UL;
99 void gemu_log(const char *fmt
, ...)
104 vfprintf(stderr
, fmt
, ap
);
108 #if defined(TARGET_I386)
109 int cpu_get_pic_interrupt(CPUX86State
*env
)
115 /***********************************************************/
116 /* Helper routines for implementing atomic operations. */
118 /* Make sure everything is in a consistent state for calling fork(). */
119 void fork_start(void)
126 void fork_end(int child
)
128 mmap_fork_end(child
);
130 CPUState
*cpu
, *next_cpu
;
131 /* Child processes created by fork() only have a single thread.
132 Discard information about the parent threads. */
133 CPU_FOREACH_SAFE(cpu
, next_cpu
) {
134 if (cpu
!= thread_cpu
) {
135 QTAILQ_REMOVE_RCU(&cpus
, cpu
, node
);
138 qemu_init_cpu_list();
139 gdbserver_fork(thread_cpu
);
140 /* qemu_init_cpu_list() takes care of reinitializing the
141 * exclusive state, so we don't need to end_exclusive() here.
149 __thread CPUState
*thread_cpu
;
151 bool qemu_cpu_is_self(CPUState
*cpu
)
153 return thread_cpu
== cpu
;
156 void qemu_cpu_kick(CPUState
*cpu
)
161 void task_settid(TaskState
*ts
)
163 if (ts
->ts_tid
== 0) {
164 ts
->ts_tid
= (pid_t
)syscall(SYS_gettid
);
168 void stop_all_tasks(void)
171 * We trust that when using NPTL, start_exclusive()
172 * handles thread stopping correctly.
177 /* Assumes contents are already zeroed. */
178 void init_task_state(TaskState
*ts
)
183 CPUArchState
*cpu_copy(CPUArchState
*env
)
185 CPUState
*cpu
= env_cpu(env
);
186 CPUState
*new_cpu
= cpu_create(cpu_type
);
187 CPUArchState
*new_env
= new_cpu
->env_ptr
;
191 /* Reset non arch specific state */
194 memcpy(new_env
, env
, sizeof(CPUArchState
));
196 /* Clone all break/watchpoints.
197 Note: Once we support ptrace with hw-debug register access, make sure
198 BP_CPU break/watchpoints are handled correctly on clone. */
199 QTAILQ_INIT(&new_cpu
->breakpoints
);
200 QTAILQ_INIT(&new_cpu
->watchpoints
);
201 QTAILQ_FOREACH(bp
, &cpu
->breakpoints
, entry
) {
202 cpu_breakpoint_insert(new_cpu
, bp
->pc
, bp
->flags
, NULL
);
204 QTAILQ_FOREACH(wp
, &cpu
->watchpoints
, entry
) {
205 cpu_watchpoint_insert(new_cpu
, wp
->vaddr
, wp
->len
, wp
->flags
, NULL
);
211 static void handle_arg_help(const char *arg
)
216 static void handle_arg_log(const char *arg
)
220 mask
= qemu_str_to_log_mask(arg
);
222 qemu_print_log_usage(stdout
);
225 qemu_log_needs_buffers();
229 static void handle_arg_dfilter(const char *arg
)
231 qemu_set_dfilter_ranges(arg
, NULL
);
234 static void handle_arg_log_filename(const char *arg
)
236 qemu_set_log_filename(arg
, &error_fatal
);
239 static void handle_arg_set_env(const char *arg
)
243 while ((token
= strsep(&p
, ",")) != NULL
) {
244 if (envlist_setenv(envlist
, token
) != 0) {
251 static void handle_arg_unset_env(const char *arg
)
255 while ((token
= strsep(&p
, ",")) != NULL
) {
256 if (envlist_unsetenv(envlist
, token
) != 0) {
263 static void handle_arg_argv0(const char *arg
)
268 static void handle_arg_stack_size(const char *arg
)
271 guest_stack_size
= strtoul(arg
, &p
, 0);
272 if (guest_stack_size
== 0) {
277 guest_stack_size
*= MiB
;
278 } else if (*p
== 'k' || *p
== 'K') {
279 guest_stack_size
*= KiB
;
283 static void handle_arg_ld_prefix(const char *arg
)
285 interp_prefix
= strdup(arg
);
288 static void handle_arg_pagesize(const char *arg
)
290 qemu_host_page_size
= atoi(arg
);
291 if (qemu_host_page_size
== 0 ||
292 (qemu_host_page_size
& (qemu_host_page_size
- 1)) != 0) {
293 fprintf(stderr
, "page size must be a power of two\n");
298 static void handle_arg_seed(const char *arg
)
303 static void handle_arg_gdb(const char *arg
)
305 gdbstub_port
= atoi(arg
);
308 static void handle_arg_uname(const char *arg
)
310 qemu_uname_release
= strdup(arg
);
313 static void handle_arg_cpu(const char *arg
)
315 cpu_model
= strdup(arg
);
316 if (cpu_model
== NULL
|| is_help_option(cpu_model
)) {
317 /* XXX: implement xxx_cpu_list for targets that still miss it */
318 #if defined(cpu_list)
325 static void handle_arg_guest_base(const char *arg
)
327 guest_base
= strtol(arg
, NULL
, 0);
331 static void handle_arg_reserved_va(const char *arg
)
335 reserved_va
= strtoul(arg
, &p
, 0);
349 unsigned long unshifted
= reserved_va
;
351 reserved_va
<<= shift
;
352 if (reserved_va
>> shift
!= unshifted
353 || (MAX_RESERVED_VA
&& reserved_va
> MAX_RESERVED_VA
)) {
354 fprintf(stderr
, "Reserved virtual address too big\n");
359 fprintf(stderr
, "Unrecognised -R size suffix '%s'\n", p
);
364 static void handle_arg_singlestep(const char *arg
)
369 static void handle_arg_strace(const char *arg
)
374 static void handle_arg_version(const char *arg
)
376 printf("qemu-" TARGET_NAME
" version " QEMU_FULL_VERSION
377 "\n" QEMU_COPYRIGHT
"\n");
381 static char *trace_file
;
382 static void handle_arg_trace(const char *arg
)
385 trace_file
= trace_opt_parse(arg
);
388 struct qemu_argument
{
392 void (*handle_opt
)(const char *arg
);
397 static const struct qemu_argument arg_table
[] = {
398 {"h", "", false, handle_arg_help
,
399 "", "print this help"},
400 {"help", "", false, handle_arg_help
,
402 {"g", "QEMU_GDB", true, handle_arg_gdb
,
403 "port", "wait gdb connection to 'port'"},
404 {"L", "QEMU_LD_PREFIX", true, handle_arg_ld_prefix
,
405 "path", "set the elf interpreter prefix to 'path'"},
406 {"s", "QEMU_STACK_SIZE", true, handle_arg_stack_size
,
407 "size", "set the stack size to 'size' bytes"},
408 {"cpu", "QEMU_CPU", true, handle_arg_cpu
,
409 "model", "select CPU (-cpu help for list)"},
410 {"E", "QEMU_SET_ENV", true, handle_arg_set_env
,
411 "var=value", "sets targets environment variable (see below)"},
412 {"U", "QEMU_UNSET_ENV", true, handle_arg_unset_env
,
413 "var", "unsets targets environment variable (see below)"},
414 {"0", "QEMU_ARGV0", true, handle_arg_argv0
,
415 "argv0", "forces target process argv[0] to be 'argv0'"},
416 {"r", "QEMU_UNAME", true, handle_arg_uname
,
417 "uname", "set qemu uname release string to 'uname'"},
418 {"B", "QEMU_GUEST_BASE", true, handle_arg_guest_base
,
419 "address", "set guest_base address to 'address'"},
420 {"R", "QEMU_RESERVED_VA", true, handle_arg_reserved_va
,
421 "size", "reserve 'size' bytes for guest virtual address space"},
422 {"d", "QEMU_LOG", true, handle_arg_log
,
423 "item[,...]", "enable logging of specified items "
424 "(use '-d help' for a list of items)"},
425 {"dfilter", "QEMU_DFILTER", true, handle_arg_dfilter
,
426 "range[,...]","filter logging based on address range"},
427 {"D", "QEMU_LOG_FILENAME", true, handle_arg_log_filename
,
428 "logfile", "write logs to 'logfile' (default stderr)"},
429 {"p", "QEMU_PAGESIZE", true, handle_arg_pagesize
,
430 "pagesize", "set the host page size to 'pagesize'"},
431 {"singlestep", "QEMU_SINGLESTEP", false, handle_arg_singlestep
,
432 "", "run in singlestep mode"},
433 {"strace", "QEMU_STRACE", false, handle_arg_strace
,
434 "", "log system calls"},
435 {"seed", "QEMU_RAND_SEED", true, handle_arg_seed
,
436 "", "Seed for pseudo-random number generator"},
437 {"trace", "QEMU_TRACE", true, handle_arg_trace
,
438 "", "[[enable=]<pattern>][,events=<file>][,file=<file>]"},
439 {"version", "QEMU_VERSION", false, handle_arg_version
,
440 "", "display version information and exit"},
441 {NULL
, NULL
, false, NULL
, NULL
, NULL
}
444 static void usage(int exitcode
)
446 const struct qemu_argument
*arginfo
;
450 printf("usage: qemu-" TARGET_NAME
" [options] program [arguments...]\n"
451 "Linux CPU emulator (compiled for " TARGET_NAME
" emulation)\n"
453 "Options and associated environment variables:\n"
456 /* Calculate column widths. We must always have at least enough space
457 * for the column header.
459 maxarglen
= strlen("Argument");
460 maxenvlen
= strlen("Env-variable");
462 for (arginfo
= arg_table
; arginfo
->handle_opt
!= NULL
; arginfo
++) {
463 int arglen
= strlen(arginfo
->argv
);
464 if (arginfo
->has_arg
) {
465 arglen
+= strlen(arginfo
->example
) + 1;
467 if (strlen(arginfo
->env
) > maxenvlen
) {
468 maxenvlen
= strlen(arginfo
->env
);
470 if (arglen
> maxarglen
) {
475 printf("%-*s %-*s Description\n", maxarglen
+1, "Argument",
476 maxenvlen
, "Env-variable");
478 for (arginfo
= arg_table
; arginfo
->handle_opt
!= NULL
; arginfo
++) {
479 if (arginfo
->has_arg
) {
480 printf("-%s %-*s %-*s %s\n", arginfo
->argv
,
481 (int)(maxarglen
- strlen(arginfo
->argv
) - 1),
482 arginfo
->example
, maxenvlen
, arginfo
->env
, arginfo
->help
);
484 printf("-%-*s %-*s %s\n", maxarglen
, arginfo
->argv
,
485 maxenvlen
, arginfo
->env
,
492 "QEMU_LD_PREFIX = %s\n"
493 "QEMU_STACK_SIZE = %ld byte\n",
498 "You can use -E and -U options or the QEMU_SET_ENV and\n"
499 "QEMU_UNSET_ENV environment variables to set and unset\n"
500 "environment variables for the target process.\n"
501 "It is possible to provide several variables by separating them\n"
502 "by commas in getsubopt(3) style. Additionally it is possible to\n"
503 "provide the -E and -U options multiple times.\n"
504 "The following lines are equivalent:\n"
505 " -E var1=val2 -E var2=val2 -U LD_PRELOAD -U LD_DEBUG\n"
506 " -E var1=val2,var2=val2 -U LD_PRELOAD,LD_DEBUG\n"
507 " QEMU_SET_ENV=var1=val2,var2=val2 QEMU_UNSET_ENV=LD_PRELOAD,LD_DEBUG\n"
508 "Note that if you provide several changes to a single variable\n"
509 "the last change will stay in effect.\n"
511 QEMU_HELP_BOTTOM
"\n");
516 static int parse_args(int argc
, char **argv
)
520 const struct qemu_argument
*arginfo
;
522 for (arginfo
= arg_table
; arginfo
->handle_opt
!= NULL
; arginfo
++) {
523 if (arginfo
->env
== NULL
) {
527 r
= getenv(arginfo
->env
);
529 arginfo
->handle_opt(r
);
535 if (optind
>= argc
) {
544 if (!strcmp(r
, "-")) {
547 /* Treat --foo the same as -foo. */
552 for (arginfo
= arg_table
; arginfo
->handle_opt
!= NULL
; arginfo
++) {
553 if (!strcmp(r
, arginfo
->argv
)) {
554 if (arginfo
->has_arg
) {
555 if (optind
>= argc
) {
556 (void) fprintf(stderr
,
557 "qemu: missing argument for option '%s'\n", r
);
560 arginfo
->handle_opt(argv
[optind
]);
563 arginfo
->handle_opt(NULL
);
569 /* no option matched the current argv */
570 if (arginfo
->handle_opt
== NULL
) {
571 (void) fprintf(stderr
, "qemu: unknown option '%s'\n", r
);
576 if (optind
>= argc
) {
577 (void) fprintf(stderr
, "qemu: no user program specified\n");
581 filename
= argv
[optind
];
582 exec_path
= argv
[optind
];
587 int main(int argc
, char **argv
, char **envp
)
589 struct target_pt_regs regs1
, *regs
= ®s1
;
590 struct image_info info1
, *info
= &info1
;
591 struct linux_binprm bprm
;
596 char **target_environ
, **wrk
;
604 module_call_init(MODULE_INIT_TRACE
);
605 qemu_init_cpu_list();
606 module_call_init(MODULE_INIT_QOM
);
608 envlist
= envlist_create();
610 /* add current environment into the list */
611 for (wrk
= environ
; *wrk
!= NULL
; wrk
++) {
612 (void) envlist_setenv(envlist
, *wrk
);
615 /* Read the stack limit from the kernel. If it's "unlimited",
616 then we can do little else besides use the default. */
619 if (getrlimit(RLIMIT_STACK
, &lim
) == 0
620 && lim
.rlim_cur
!= RLIM_INFINITY
621 && lim
.rlim_cur
== (target_long
)lim
.rlim_cur
) {
622 guest_stack_size
= lim
.rlim_cur
;
628 qemu_add_opts(&qemu_trace_opts
);
630 optind
= parse_args(argc
, argv
);
632 if (!trace_init_backends()) {
635 trace_init_file(trace_file
);
638 memset(regs
, 0, sizeof(struct target_pt_regs
));
640 /* Zero out image_info */
641 memset(info
, 0, sizeof(struct image_info
));
643 memset(&bprm
, 0, sizeof (bprm
));
645 /* Scan interp_prefix dir for replacement files. */
646 init_paths(interp_prefix
);
648 init_qemu_uname_release();
650 execfd
= qemu_getauxval(AT_EXECFD
);
652 execfd
= open(filename
, O_RDONLY
);
654 printf("Error while loading %s: %s\n", filename
, strerror(errno
));
659 if (cpu_model
== NULL
) {
660 cpu_model
= cpu_get_model(get_elf_eflags(execfd
));
662 cpu_type
= parse_cpu_option(cpu_model
);
664 /* init tcg before creating CPUs and to get qemu_host_page_size */
667 /* Reserving *too* much vm space via mmap can run into problems
668 with rlimits, oom due to page table creation, etc. We will still try it,
669 if directed by the command-line option, but not by default. */
670 if (HOST_LONG_BITS
== 64 &&
671 TARGET_VIRT_ADDR_SPACE_BITS
<= 32 &&
673 /* reserved_va must be aligned with the host page size
674 * as it is used with mmap()
676 reserved_va
= MAX_RESERVED_VA
& qemu_host_page_mask
;
679 cpu
= cpu_create(cpu_type
);
685 if (getenv("QEMU_STRACE")) {
689 if (seed_optarg
== NULL
) {
690 seed_optarg
= getenv("QEMU_RAND_SEED");
694 if (seed_optarg
!= NULL
) {
695 qemu_guest_random_seed_main(seed_optarg
, &err
);
700 error_reportf_err(err
, "cannot initialize crypto: ");
705 target_environ
= envlist_to_environ(envlist
, NULL
);
706 envlist_free(envlist
);
709 * Now that page sizes are configured in tcg_exec_init() we can do
710 * proper page alignment for guest_base.
712 guest_base
= HOST_PAGE_ALIGN(guest_base
);
714 if (reserved_va
|| have_guest_base
) {
715 guest_base
= init_guest_space(guest_base
, reserved_va
, 0,
717 if (guest_base
== (unsigned long)-1) {
718 fprintf(stderr
, "Unable to reserve 0x%lx bytes of virtual address "
719 "space for use as guest address space (check your virtual "
720 "memory ulimit setting or reserve less using -R option)\n",
726 mmap_next_start
= reserved_va
;
731 * Read in mmap_min_addr kernel parameter. This value is used
732 * When loading the ELF image to determine whether guest_base
733 * is needed. It is also used in mmap_find_vma.
738 if ((fp
= fopen("/proc/sys/vm/mmap_min_addr", "r")) != NULL
) {
740 if (fscanf(fp
, "%lu", &tmp
) == 1) {
742 qemu_log_mask(CPU_LOG_PAGE
, "host mmap_min_addr=0x%lx\n", mmap_min_addr
);
749 * Prepare copy of argv vector for target.
751 target_argc
= argc
- optind
;
752 target_argv
= calloc(target_argc
+ 1, sizeof (char *));
753 if (target_argv
== NULL
) {
754 (void) fprintf(stderr
, "Unable to allocate memory for target_argv\n");
759 * If argv0 is specified (using '-0' switch) we replace
760 * argv[0] pointer with the given one.
764 target_argv
[i
++] = strdup(argv0
);
766 for (; i
< target_argc
; i
++) {
767 target_argv
[i
] = strdup(argv
[optind
+ i
]);
769 target_argv
[target_argc
] = NULL
;
771 ts
= g_new0(TaskState
, 1);
773 /* build Task State */
779 ret
= loader_exec(execfd
, filename
, target_argv
, target_environ
, regs
,
782 printf("Error while loading %s: %s\n", filename
, strerror(-ret
));
786 for (wrk
= target_environ
; *wrk
; wrk
++) {
790 g_free(target_environ
);
792 if (qemu_loglevel_mask(CPU_LOG_PAGE
)) {
793 qemu_log("guest_base 0x%lx\n", guest_base
);
796 qemu_log("start_brk 0x" TARGET_ABI_FMT_lx
"\n", info
->start_brk
);
797 qemu_log("end_code 0x" TARGET_ABI_FMT_lx
"\n", info
->end_code
);
798 qemu_log("start_code 0x" TARGET_ABI_FMT_lx
"\n", info
->start_code
);
799 qemu_log("start_data 0x" TARGET_ABI_FMT_lx
"\n", info
->start_data
);
800 qemu_log("end_data 0x" TARGET_ABI_FMT_lx
"\n", info
->end_data
);
801 qemu_log("start_stack 0x" TARGET_ABI_FMT_lx
"\n", info
->start_stack
);
802 qemu_log("brk 0x" TARGET_ABI_FMT_lx
"\n", info
->brk
);
803 qemu_log("entry 0x" TARGET_ABI_FMT_lx
"\n", info
->entry
);
804 qemu_log("argv_start 0x" TARGET_ABI_FMT_lx
"\n", info
->arg_start
);
805 qemu_log("env_start 0x" TARGET_ABI_FMT_lx
"\n",
806 info
->arg_end
+ (abi_ulong
)sizeof(abi_ulong
));
807 qemu_log("auxv_start 0x" TARGET_ABI_FMT_lx
"\n", info
->saved_auxv
);
810 target_set_brk(info
->brk
);
814 /* Now that we've loaded the binary, GUEST_BASE is fixed. Delay
815 generating the prologue until now so that the prologue can take
816 the real value of GUEST_BASE into account. */
817 tcg_prologue_init(tcg_ctx
);
820 target_cpu_copy_regs(env
, regs
);
823 if (gdbserver_start(gdbstub_port
) < 0) {
824 fprintf(stderr
, "qemu: could not open gdbserver on port %d\n",
828 gdb_handlesig(cpu
, 0);