xref: /openbmc/qemu/bsd-user/main.c (revision b8012648b38274aa996f1477c422a79e2d44110b)
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     char *argv0 = NULL;
247 
248     adjust_ssize();
249 
250     if (argc <= 1) {
251         usage();
252     }
253 
254     save_proc_pathname(argv[0]);
255 
256     error_init(argv[0]);
257     module_call_init(MODULE_INIT_TRACE);
258     qemu_init_cpu_list();
259     module_call_init(MODULE_INIT_QOM);
260 
261     envlist = envlist_create();
262 
263     /* add current environment into the list */
264     for (wrk = environ; *wrk != NULL; wrk++) {
265         (void) envlist_setenv(envlist, *wrk);
266     }
267 
268     cpu_model = NULL;
269 
270     qemu_add_opts(&qemu_trace_opts);
271 
272     optind = 1;
273     for (;;) {
274         if (optind >= argc) {
275             break;
276         }
277         r = argv[optind];
278         if (r[0] != '-') {
279             break;
280         }
281         optind++;
282         r++;
283         if (!strcmp(r, "-")) {
284             break;
285         } else if (!strcmp(r, "d")) {
286             if (optind >= argc) {
287                 break;
288             }
289             log_mask = argv[optind++];
290         } else if (!strcmp(r, "D")) {
291             if (optind >= argc) {
292                 break;
293             }
294             log_file = argv[optind++];
295         } else if (!strcmp(r, "E")) {
296             r = argv[optind++];
297             if (envlist_setenv(envlist, r) != 0) {
298                 usage();
299             }
300         } else if (!strcmp(r, "ignore-environment")) {
301             envlist_free(envlist);
302             envlist = envlist_create();
303         } else if (!strcmp(r, "U")) {
304             r = argv[optind++];
305             if (envlist_unsetenv(envlist, r) != 0) {
306                 usage();
307             }
308         } else if (!strcmp(r, "s")) {
309             r = argv[optind++];
310             rv = qemu_strtoul(r, &r, 0, &target_dflssiz);
311             if (rv < 0 || target_dflssiz <= 0) {
312                 usage();
313             }
314             if (*r == 'M') {
315                 target_dflssiz *= 1024 * 1024;
316             } else if (*r == 'k' || *r == 'K') {
317                 target_dflssiz *= 1024;
318             }
319             if (target_dflssiz > target_maxssiz) {
320                 usage();
321             }
322         } else if (!strcmp(r, "L")) {
323             interp_prefix = argv[optind++];
324         } else if (!strcmp(r, "p")) {
325             qemu_host_page_size = atoi(argv[optind++]);
326             if (qemu_host_page_size == 0 ||
327                 (qemu_host_page_size & (qemu_host_page_size - 1)) != 0) {
328                 fprintf(stderr, "page size must be a power of two\n");
329                 exit(1);
330             }
331         } else if (!strcmp(r, "g")) {
332             gdbstub = g_strdup(argv[optind++]);
333         } else if (!strcmp(r, "r")) {
334             qemu_uname_release = argv[optind++];
335         } else if (!strcmp(r, "cpu")) {
336             cpu_model = argv[optind++];
337             if (is_help_option(cpu_model)) {
338                 /* XXX: implement xxx_cpu_list for targets that still miss it */
339 #if defined(cpu_list)
340                 cpu_list();
341 #endif
342                 exit(1);
343             }
344         } else if (!strcmp(r, "B")) {
345             rv = qemu_strtoul(argv[optind++], NULL, 0, &guest_base);
346             if (rv < 0) {
347                 usage();
348             }
349             have_guest_base = true;
350         } else if (!strcmp(r, "drop-ld-preload")) {
351             (void) envlist_unsetenv(envlist, "LD_PRELOAD");
352         } else if (!strcmp(r, "bsd")) {
353             if (!strcasecmp(argv[optind], "freebsd")) {
354                 bsd_type = target_freebsd;
355             } else if (!strcasecmp(argv[optind], "netbsd")) {
356                 bsd_type = target_netbsd;
357             } else if (!strcasecmp(argv[optind], "openbsd")) {
358                 bsd_type = target_openbsd;
359             } else {
360                 usage();
361             }
362             optind++;
363         } else if (!strcmp(r, "seed")) {
364             seed_optarg = optarg;
365         } else if (!strcmp(r, "singlestep")) {
366             singlestep = 1;
367         } else if (!strcmp(r, "strace")) {
368             do_strace = 1;
369         } else if (!strcmp(r, "trace")) {
370             trace_opt_parse(optarg);
371         } else if (!strcmp(r, "0")) {
372             argv0 = argv[optind++];
373         } else {
374             usage();
375         }
376     }
377 
378     /* init debug */
379     qemu_log_needs_buffers();
380     qemu_set_log_filename(log_file, &error_fatal);
381     if (log_mask) {
382         int mask;
383 
384         mask = qemu_str_to_log_mask(log_mask);
385         if (!mask) {
386             qemu_print_log_usage(stdout);
387             exit(1);
388         }
389         qemu_set_log(mask);
390     }
391 
392     if (optind >= argc) {
393         usage();
394     }
395     filename = argv[optind];
396     if (argv0) {
397         argv[optind] = argv0;
398     }
399 
400     if (!trace_init_backends()) {
401         exit(1);
402     }
403     trace_init_file();
404 
405     /* Zero out regs */
406     memset(regs, 0, sizeof(struct target_pt_regs));
407 
408     /* Zero bsd params */
409     memset(&bprm, 0, sizeof(bprm));
410 
411     /* Zero out image_info */
412     memset(info, 0, sizeof(struct image_info));
413 
414     /* Scan interp_prefix dir for replacement files. */
415     init_paths(interp_prefix);
416 
417     if (cpu_model == NULL) {
418         cpu_model = TARGET_DEFAULT_CPU_MODEL;
419     }
420 
421     cpu_type = parse_cpu_option(cpu_model);
422 
423     /* init tcg before creating CPUs and to get qemu_host_page_size */
424     {
425         AccelClass *ac = ACCEL_GET_CLASS(current_accel());
426 
427         accel_init_interfaces(ac);
428         ac->init_machine(NULL);
429     }
430     cpu = cpu_create(cpu_type);
431     env = cpu->env_ptr;
432     cpu_reset(cpu);
433     thread_cpu = cpu;
434 
435     if (getenv("QEMU_STRACE")) {
436         do_strace = 1;
437     }
438 
439     target_environ = envlist_to_environ(envlist, NULL);
440     envlist_free(envlist);
441 
442     {
443         Error *err = NULL;
444         if (seed_optarg != NULL) {
445             qemu_guest_random_seed_main(seed_optarg, &err);
446         } else {
447             qcrypto_init(&err);
448         }
449         if (err) {
450             error_reportf_err(err, "cannot initialize crypto: ");
451             exit(1);
452         }
453     }
454 
455     /*
456      * Now that page sizes are configured we can do
457      * proper page alignment for guest_base.
458      */
459     guest_base = HOST_PAGE_ALIGN(guest_base);
460 
461     if (loader_exec(filename, argv + optind, target_environ, regs, info,
462                     &bprm) != 0) {
463         printf("Error loading %s\n", filename);
464         _exit(1);
465     }
466 
467     for (wrk = target_environ; *wrk; wrk++) {
468         g_free(*wrk);
469     }
470 
471     g_free(target_environ);
472 
473     if (qemu_loglevel_mask(CPU_LOG_PAGE)) {
474         qemu_log("guest_base  %p\n", (void *)guest_base);
475         log_page_dump("binary load");
476 
477         qemu_log("start_brk   0x" TARGET_ABI_FMT_lx "\n", info->start_brk);
478         qemu_log("end_code    0x" TARGET_ABI_FMT_lx "\n", info->end_code);
479         qemu_log("start_code  0x" TARGET_ABI_FMT_lx "\n",
480                  info->start_code);
481         qemu_log("start_data  0x" TARGET_ABI_FMT_lx "\n",
482                  info->start_data);
483         qemu_log("end_data    0x" TARGET_ABI_FMT_lx "\n", info->end_data);
484         qemu_log("start_stack 0x" TARGET_ABI_FMT_lx "\n",
485                  info->start_stack);
486         qemu_log("brk         0x" TARGET_ABI_FMT_lx "\n", info->brk);
487         qemu_log("entry       0x" TARGET_ABI_FMT_lx "\n", info->entry);
488     }
489 
490     /* build Task State */
491     ts = g_new0(TaskState, 1);
492     init_task_state(ts);
493     ts->info = info;
494     ts->bprm = &bprm;
495     cpu->opaque = ts;
496 
497     target_set_brk(info->brk);
498     syscall_init();
499     signal_init();
500 
501     /*
502      * Now that we've loaded the binary, GUEST_BASE is fixed.  Delay
503      * generating the prologue until now so that the prologue can take
504      * the real value of GUEST_BASE into account.
505      */
506     tcg_prologue_init(tcg_ctx);
507 
508     target_cpu_init(env, regs);
509 
510     if (gdbstub) {
511         gdbserver_start(gdbstub);
512         gdb_handlesig(cpu, 0);
513     }
514     cpu_loop(env);
515     /* never exits */
516     return 0;
517 }
518