xref: /openbmc/qemu/bsd-user/main.c (revision 63cca1067ac70df2d71c0064f7bf53e19334223c)
1 /*
2  *  qemu bsd user main
3  *
4  *  Copyright (c) 2003-2008 Fabrice Bellard
5  *  Copyright (c) 2013-14 Stacey Son
6  *
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.
11  *
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.
16  *
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/>.
19  */
20 
21 #include <sys/types.h>
22 #include <sys/time.h>
23 #include <sys/resource.h>
24 #include <sys/sysctl.h>
25 
26 #include "qemu/osdep.h"
27 #include "qemu-common.h"
28 #include "qemu/units.h"
29 #include "qemu/accel.h"
30 #include "sysemu/tcg.h"
31 #include "qemu-version.h"
32 #include <machine/trap.h>
33 
34 #include "qapi/error.h"
35 #include "qemu.h"
36 #include "qemu/config-file.h"
37 #include "qemu/error-report.h"
38 #include "qemu/path.h"
39 #include "qemu/help_option.h"
40 #include "qemu/module.h"
41 #include "exec/exec-all.h"
42 #include "tcg/tcg.h"
43 #include "qemu/timer.h"
44 #include "qemu/envlist.h"
45 #include "qemu/cutils.h"
46 #include "exec/log.h"
47 #include "trace/control.h"
48 #include "crypto/init.h"
49 #include "qemu/guest-random.h"
50 
51 #include "host-os.h"
52 #include "target_arch_cpu.h"
53 
54 int singlestep;
55 unsigned long mmap_min_addr;
56 uintptr_t guest_base;
57 bool have_guest_base;
58 unsigned long reserved_va;
59 
60 static const char *interp_prefix = CONFIG_QEMU_INTERP_PREFIX;
61 const char *qemu_uname_release;
62 enum BSDType bsd_type;
63 char qemu_proc_pathname[PATH_MAX];  /* full path to exeutable */
64 
65 unsigned long target_maxtsiz = TARGET_MAXTSIZ;   /* max text size */
66 unsigned long target_dfldsiz = TARGET_DFLDSIZ;   /* initial data size limit */
67 unsigned long target_maxdsiz = TARGET_MAXDSIZ;   /* max data size */
68 unsigned long target_dflssiz = TARGET_DFLSSIZ;   /* initial data size limit */
69 unsigned long target_maxssiz = TARGET_MAXSSIZ;   /* max stack size */
70 unsigned long target_sgrowsiz = TARGET_SGROWSIZ; /* amount to grow stack */
71 
72 /* Helper routines for implementing atomic operations. */
73 
74 void fork_start(void)
75 {
76     start_exclusive();
77     cpu_list_lock();
78     mmap_fork_start();
79 }
80 
81 void fork_end(int child)
82 {
83     if (child) {
84         CPUState *cpu, *next_cpu;
85         /*
86          * Child processes created by fork() only have a single thread.  Discard
87          * information about the parent threads.
88          */
89         CPU_FOREACH_SAFE(cpu, next_cpu) {
90             if (cpu != thread_cpu) {
91                 QTAILQ_REMOVE_RCU(&cpus, cpu, node);
92             }
93         }
94         mmap_fork_end(child);
95         /*
96          * qemu_init_cpu_list() takes care of reinitializing the exclusive
97          * state, so we don't need to end_exclusive() here.
98          */
99         qemu_init_cpu_list();
100         gdbserver_fork(thread_cpu);
101     } else {
102         mmap_fork_end(child);
103         cpu_list_unlock();
104         end_exclusive();
105     }
106 }
107 
108 void cpu_loop(CPUArchState *env)
109 {
110     target_cpu_loop(env);
111 }
112 
113 static void usage(void)
114 {
115     printf("qemu-" TARGET_NAME " version " QEMU_FULL_VERSION
116            "\n" QEMU_COPYRIGHT "\n"
117            "usage: qemu-" TARGET_NAME " [options] program [arguments...]\n"
118            "BSD CPU emulator (compiled for %s emulation)\n"
119            "\n"
120            "Standard options:\n"
121            "-h                print this help\n"
122            "-g port           wait gdb connection to port\n"
123            "-L path           set the elf interpreter prefix (default=%s)\n"
124            "-s size           set the stack size in bytes (default=%ld)\n"
125            "-cpu model        select CPU (-cpu help for list)\n"
126            "-drop-ld-preload  drop LD_PRELOAD for target process\n"
127            "-E var=value      sets/modifies targets environment variable(s)\n"
128            "-U var            unsets targets environment variable(s)\n"
129            "-B address        set guest_base address to address\n"
130            "-bsd type         select emulated BSD type FreeBSD/NetBSD/OpenBSD (default)\n"
131            "\n"
132            "Debug options:\n"
133            "-d item1[,...]    enable logging of specified items\n"
134            "                  (use '-d help' for a list of log items)\n"
135            "-D logfile        write logs to 'logfile' (default stderr)\n"
136            "-singlestep       always run in singlestep mode\n"
137            "-strace           log system calls\n"
138            "-trace            [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
139            "                  specify tracing options\n"
140            "\n"
141            "Environment variables:\n"
142            "QEMU_STRACE       Print system calls and arguments similar to the\n"
143            "                  'strace' program.  Enable by setting to any value.\n"
144            "You can use -E and -U options to set/unset environment variables\n"
145            "for target process.  It is possible to provide several variables\n"
146            "by repeating the option.  For example:\n"
147            "    -E var1=val2 -E var2=val2 -U LD_PRELOAD -U LD_DEBUG\n"
148            "Note that if you provide several changes to single variable\n"
149            "last change will stay in effect.\n"
150            "\n"
151            QEMU_HELP_BOTTOM "\n"
152            ,
153            TARGET_NAME,
154            interp_prefix,
155            target_dflssiz);
156     exit(1);
157 }
158 
159 __thread CPUState *thread_cpu;
160 
161 bool qemu_cpu_is_self(CPUState *cpu)
162 {
163     return thread_cpu == cpu;
164 }
165 
166 void qemu_cpu_kick(CPUState *cpu)
167 {
168     cpu_exit(cpu);
169 }
170 
171 /* Assumes contents are already zeroed.  */
172 void init_task_state(TaskState *ts)
173 {
174     int i;
175 
176     ts->used = 1;
177     ts->first_free = ts->sigqueue_table;
178     for (i = 0; i < MAX_SIGQUEUE_SIZE - 1; i++) {
179         ts->sigqueue_table[i].next = &ts->sigqueue_table[i + 1];
180     }
181     ts->sigqueue_table[i].next = NULL;
182 }
183 
184 void gemu_log(const char *fmt, ...)
185 {
186     va_list ap;
187 
188     va_start(ap, fmt);
189     vfprintf(stderr, fmt, ap);
190     va_end(ap);
191 }
192 
193 static void
194 adjust_ssize(void)
195 {
196     struct rlimit rl;
197 
198     if (getrlimit(RLIMIT_STACK, &rl) != 0) {
199         return;
200     }
201 
202     target_maxssiz = MIN(target_maxssiz, rl.rlim_max);
203     target_dflssiz = MIN(MAX(target_dflssiz, rl.rlim_cur), target_maxssiz);
204 
205     rl.rlim_max = target_maxssiz;
206     rl.rlim_cur = target_dflssiz;
207     setrlimit(RLIMIT_STACK, &rl);
208 }
209 
210 static void save_proc_pathname(char *argv0)
211 {
212     int mib[4];
213     size_t len;
214 
215     mib[0] = CTL_KERN;
216     mib[1] = KERN_PROC;
217     mib[2] = KERN_PROC_PATHNAME;
218     mib[3] = -1;
219 
220     len = sizeof(qemu_proc_pathname);
221     if (sysctl(mib, 4, qemu_proc_pathname, &len, NULL, 0)) {
222         perror("sysctl");
223     }
224 }
225 
226 int main(int argc, char **argv)
227 {
228     const char *filename;
229     const char *cpu_model;
230     const char *cpu_type;
231     const char *log_file = NULL;
232     const char *log_mask = NULL;
233     const char *seed_optarg = NULL;
234     struct target_pt_regs regs1, *regs = &regs1;
235     struct image_info info1, *info = &info1;
236     struct bsd_binprm bprm;
237     TaskState *ts;
238     CPUArchState *env;
239     CPUState *cpu;
240     int optind, rv;
241     const char *r;
242     const char *gdbstub = NULL;
243     char **target_environ, **wrk;
244     envlist_t *envlist = NULL;
245     bsd_type = HOST_DEFAULT_BSD_TYPE;
246 
247     adjust_ssize();
248 
249     if (argc <= 1) {
250         usage();
251     }
252 
253     save_proc_pathname(argv[0]);
254 
255     error_init(argv[0]);
256     module_call_init(MODULE_INIT_TRACE);
257     qemu_init_cpu_list();
258     module_call_init(MODULE_INIT_QOM);
259 
260     envlist = envlist_create();
261 
262     /* add current environment into the list */
263     for (wrk = environ; *wrk != NULL; wrk++) {
264         (void) envlist_setenv(envlist, *wrk);
265     }
266 
267     cpu_model = NULL;
268 
269     qemu_add_opts(&qemu_trace_opts);
270 
271     optind = 1;
272     for (;;) {
273         if (optind >= argc) {
274             break;
275         }
276         r = argv[optind];
277         if (r[0] != '-') {
278             break;
279         }
280         optind++;
281         r++;
282         if (!strcmp(r, "-")) {
283             break;
284         } else if (!strcmp(r, "d")) {
285             if (optind >= argc) {
286                 break;
287             }
288             log_mask = argv[optind++];
289         } else if (!strcmp(r, "D")) {
290             if (optind >= argc) {
291                 break;
292             }
293             log_file = argv[optind++];
294         } else if (!strcmp(r, "E")) {
295             r = argv[optind++];
296             if (envlist_setenv(envlist, r) != 0) {
297                 usage();
298             }
299         } else if (!strcmp(r, "ignore-environment")) {
300             envlist_free(envlist);
301             envlist = envlist_create();
302         } else if (!strcmp(r, "U")) {
303             r = argv[optind++];
304             if (envlist_unsetenv(envlist, r) != 0) {
305                 usage();
306             }
307         } else if (!strcmp(r, "s")) {
308             r = argv[optind++];
309             rv = qemu_strtoul(r, &r, 0, &target_dflssiz);
310             if (rv < 0 || target_dflssiz <= 0) {
311                 usage();
312             }
313             if (*r == 'M') {
314                 target_dflssiz *= 1024 * 1024;
315             } else if (*r == 'k' || *r == 'K') {
316                 target_dflssiz *= 1024;
317             }
318             if (target_dflssiz > target_maxssiz) {
319                 usage();
320             }
321         } else if (!strcmp(r, "L")) {
322             interp_prefix = argv[optind++];
323         } else if (!strcmp(r, "p")) {
324             qemu_host_page_size = atoi(argv[optind++]);
325             if (qemu_host_page_size == 0 ||
326                 (qemu_host_page_size & (qemu_host_page_size - 1)) != 0) {
327                 fprintf(stderr, "page size must be a power of two\n");
328                 exit(1);
329             }
330         } else if (!strcmp(r, "g")) {
331             gdbstub = g_strdup(argv[optind++]);
332         } else if (!strcmp(r, "r")) {
333             qemu_uname_release = argv[optind++];
334         } else if (!strcmp(r, "cpu")) {
335             cpu_model = argv[optind++];
336             if (is_help_option(cpu_model)) {
337                 /* XXX: implement xxx_cpu_list for targets that still miss it */
338 #if defined(cpu_list)
339                 cpu_list();
340 #endif
341                 exit(1);
342             }
343         } else if (!strcmp(r, "B")) {
344             rv = qemu_strtoul(argv[optind++], NULL, 0, &guest_base);
345             if (rv < 0) {
346                 usage();
347             }
348             have_guest_base = true;
349         } else if (!strcmp(r, "drop-ld-preload")) {
350             (void) envlist_unsetenv(envlist, "LD_PRELOAD");
351         } else if (!strcmp(r, "bsd")) {
352             if (!strcasecmp(argv[optind], "freebsd")) {
353                 bsd_type = target_freebsd;
354             } else if (!strcasecmp(argv[optind], "netbsd")) {
355                 bsd_type = target_netbsd;
356             } else if (!strcasecmp(argv[optind], "openbsd")) {
357                 bsd_type = target_openbsd;
358             } else {
359                 usage();
360             }
361             optind++;
362         } else if (!strcmp(r, "seed")) {
363             seed_optarg = optarg;
364         } else if (!strcmp(r, "singlestep")) {
365             singlestep = 1;
366         } else if (!strcmp(r, "strace")) {
367             do_strace = 1;
368         } else if (!strcmp(r, "trace")) {
369             trace_opt_parse(optarg);
370         } else {
371             usage();
372         }
373     }
374 
375     /* init debug */
376     qemu_log_needs_buffers();
377     qemu_set_log_filename(log_file, &error_fatal);
378     if (log_mask) {
379         int mask;
380 
381         mask = qemu_str_to_log_mask(log_mask);
382         if (!mask) {
383             qemu_print_log_usage(stdout);
384             exit(1);
385         }
386         qemu_set_log(mask);
387     }
388 
389     if (optind >= argc) {
390         usage();
391     }
392     filename = argv[optind];
393 
394     if (!trace_init_backends()) {
395         exit(1);
396     }
397     trace_init_file();
398 
399     /* Zero out regs */
400     memset(regs, 0, sizeof(struct target_pt_regs));
401 
402     /* Zero bsd params */
403     memset(&bprm, 0, sizeof(bprm));
404 
405     /* Zero out image_info */
406     memset(info, 0, sizeof(struct image_info));
407 
408     /* Scan interp_prefix dir for replacement files. */
409     init_paths(interp_prefix);
410 
411     if (cpu_model == NULL) {
412         cpu_model = TARGET_DEFAULT_CPU_MODEL;
413     }
414 
415     cpu_type = parse_cpu_option(cpu_model);
416 
417     /* init tcg before creating CPUs and to get qemu_host_page_size */
418     {
419         AccelClass *ac = ACCEL_GET_CLASS(current_accel());
420 
421         accel_init_interfaces(ac);
422         ac->init_machine(NULL);
423     }
424     cpu = cpu_create(cpu_type);
425     env = cpu->env_ptr;
426     cpu_reset(cpu);
427     thread_cpu = cpu;
428 
429     if (getenv("QEMU_STRACE")) {
430         do_strace = 1;
431     }
432 
433     target_environ = envlist_to_environ(envlist, NULL);
434     envlist_free(envlist);
435 
436     {
437         Error *err = NULL;
438         if (seed_optarg != NULL) {
439             qemu_guest_random_seed_main(seed_optarg, &err);
440         } else {
441             qcrypto_init(&err);
442         }
443         if (err) {
444             error_reportf_err(err, "cannot initialize crypto: ");
445             exit(1);
446         }
447     }
448 
449     /*
450      * Now that page sizes are configured we can do
451      * proper page alignment for guest_base.
452      */
453     guest_base = HOST_PAGE_ALIGN(guest_base);
454 
455     if (loader_exec(filename, argv + optind, target_environ, regs, info,
456                     &bprm) != 0) {
457         printf("Error loading %s\n", filename);
458         _exit(1);
459     }
460 
461     for (wrk = target_environ; *wrk; wrk++) {
462         g_free(*wrk);
463     }
464 
465     g_free(target_environ);
466 
467     if (qemu_loglevel_mask(CPU_LOG_PAGE)) {
468         qemu_log("guest_base  %p\n", (void *)guest_base);
469         log_page_dump("binary load");
470 
471         qemu_log("start_brk   0x" TARGET_ABI_FMT_lx "\n", info->start_brk);
472         qemu_log("end_code    0x" TARGET_ABI_FMT_lx "\n", info->end_code);
473         qemu_log("start_code  0x" TARGET_ABI_FMT_lx "\n",
474                  info->start_code);
475         qemu_log("start_data  0x" TARGET_ABI_FMT_lx "\n",
476                  info->start_data);
477         qemu_log("end_data    0x" TARGET_ABI_FMT_lx "\n", info->end_data);
478         qemu_log("start_stack 0x" TARGET_ABI_FMT_lx "\n",
479                  info->start_stack);
480         qemu_log("brk         0x" TARGET_ABI_FMT_lx "\n", info->brk);
481         qemu_log("entry       0x" TARGET_ABI_FMT_lx "\n", info->entry);
482     }
483 
484     /* build Task State */
485     ts = g_new0(TaskState, 1);
486     init_task_state(ts);
487     ts->info = info;
488     ts->bprm = &bprm;
489     cpu->opaque = ts;
490 
491     target_set_brk(info->brk);
492     syscall_init();
493     signal_init();
494 
495     /*
496      * Now that we've loaded the binary, GUEST_BASE is fixed.  Delay
497      * generating the prologue until now so that the prologue can take
498      * the real value of GUEST_BASE into account.
499      */
500     tcg_prologue_init(tcg_ctx);
501 
502     target_cpu_init(env, regs);
503 
504     if (gdbstub) {
505         gdbserver_start(gdbstub);
506         gdb_handlesig(cpu, 0);
507     }
508     cpu_loop(env);
509     /* never exits */
510     return 0;
511 }
512