xref: /kvmtool/builtin-run.c (revision d74181cc2b3574eb315a7d4b4394ca4cac70ce5f)
1 #include <stdio.h>
2 #include <string.h>
3 #include <signal.h>
4 #include <unistd.h>
5 #include <stdlib.h>
6 #include <termios.h>
7 #include <sys/utsname.h>
8 #include <sys/types.h>
9 #include <sys/stat.h>
10 #include <ctype.h>
11 
12 /* user defined header files */
13 #include <linux/types.h>
14 #include <kvm/kvm.h>
15 #include <kvm/kvm-cpu.h>
16 #include <kvm/8250-serial.h>
17 #include <kvm/virtio-blk.h>
18 #include <kvm/virtio-net.h>
19 #include <kvm/virtio-console.h>
20 #include <kvm/virtio-rng.h>
21 #include <kvm/disk-image.h>
22 #include <kvm/util.h>
23 #include <kvm/pci.h>
24 #include <kvm/rtc.h>
25 #include <kvm/term.h>
26 #include <kvm/ioport.h>
27 #include <kvm/threadpool.h>
28 
29 /* header files for gitish interface  */
30 #include <kvm/kvm-run.h>
31 #include <kvm/parse-options.h>
32 
33 #define DEFAULT_KVM_DEV		"/dev/kvm"
34 #define DEFAULT_CONSOLE		"serial"
35 #define DEFAULT_NETWORK		"virtio"
36 #define DEFAULT_HOST_ADDR	"192.168.33.2"
37 #define DEFAULT_GUEST_MAC	"00:11:22:33:44:55"
38 #define DEFAULT_SCRIPT		"none"
39 
40 #define MB_SHIFT		(20)
41 #define MIN_RAM_SIZE_MB		(64ULL)
42 #define MIN_RAM_SIZE_BYTE	(MIN_RAM_SIZE_MB << MB_SHIFT)
43 #define MAX_DISK_IMAGES		4
44 
45 static struct kvm *kvm;
46 static struct kvm_cpu *kvm_cpus[KVM_NR_CPUS];
47 static __thread struct kvm_cpu *current_kvm_cpu;
48 
49 static u64 ram_size;
50 static u8  image_count;
51 static const char *kernel_cmdline;
52 static const char *kernel_filename;
53 static const char *initrd_filename;
54 static const char *image_filename[MAX_DISK_IMAGES];
55 static const char *console;
56 static const char *kvm_dev;
57 static const char *network;
58 static const char *host_ip_addr;
59 static const char *guest_mac;
60 static const char *script;
61 static bool single_step;
62 static bool readonly_image[MAX_DISK_IMAGES];
63 static bool virtio_rng;
64 extern bool ioport_debug;
65 extern int  active_console;
66 
67 static int nrcpus = 1;
68 
69 static const char * const run_usage[] = {
70 	"kvm run [<options>] [<kernel image>]",
71 	NULL
72 };
73 
74 static int img_name_parser(const struct option *opt, const char *arg, int unset)
75 {
76 	char *sep;
77 
78 	if (image_count >= MAX_DISK_IMAGES)
79 		die("Currently only 4 images are supported");
80 
81 	image_filename[image_count] = arg;
82 	sep = strstr(arg, ",");
83 	if (sep) {
84 		if (strcmp(sep + 1, "ro") == 0)
85 			readonly_image[image_count] = 1;
86 		*sep = 0;
87 	}
88 
89 	image_count++;
90 
91 	return 0;
92 }
93 
94 static const struct option options[] = {
95 	OPT_GROUP("Basic options:"),
96 	OPT_INTEGER('\0', "cpus", &nrcpus, "Number of CPUs"),
97 	OPT_U64('m', "mem", &ram_size, "Virtual machine memory size in MiB."),
98 	OPT_CALLBACK('i', "image", NULL, "image", "Disk image", img_name_parser),
99 	OPT_STRING('c', "console", &console, "serial or virtio",
100 			"Console to use"),
101 	OPT_BOOLEAN('\0', "virtio-rng", &virtio_rng,
102 			"Enable virtio Random Number Generator"),
103 
104 	OPT_GROUP("Kernel options:"),
105 	OPT_STRING('k', "kernel", &kernel_filename, "kernel",
106 			"Kernel to boot in virtual machine"),
107 	OPT_STRING('r', "initrd", &initrd_filename, "initrd",
108 			"Initial RAM disk image"),
109 	OPT_STRING('p', "params", &kernel_cmdline, "params",
110 			"Kernel command line arguments"),
111 
112 	OPT_GROUP("Networking options:"),
113 	OPT_STRING('n', "network", &network, "virtio",
114 			"Network to use"),
115 	OPT_STRING('\0', "host-ip-addr", &host_ip_addr, "a.b.c.d",
116 			"Assign this address to the host side networking"),
117 	OPT_STRING('\0', "guest-mac", &guest_mac, "aa:bb:cc:dd:ee:ff",
118 			"Assign this address to the guest side NIC"),
119 	OPT_STRING('\0', "tapscript", &script, "Script path",
120 			 "Assign a script to process created tap device"),
121 	OPT_GROUP("Debug options:"),
122 	OPT_STRING('d', "kvm-dev", &kvm_dev, "kvm-dev", "KVM device file"),
123 	OPT_BOOLEAN('s', "single-step", &single_step,
124 			"Enable single stepping"),
125 	OPT_BOOLEAN('g', "ioport-debug", &ioport_debug,
126 			"Enable ioport debugging"),
127 	OPT_END()
128 };
129 
130 static void handle_sigusr1(int sig)
131 {
132 	struct kvm_cpu *cpu = current_kvm_cpu;
133 
134 	if (!cpu)
135 		return;
136 
137 	kvm_cpu__show_registers(cpu);
138 	kvm_cpu__show_code(cpu);
139 	kvm_cpu__show_page_tables(cpu);
140 }
141 
142 static void handle_sigquit(int sig)
143 {
144 	int i;
145 
146 	for (i = 0; i < nrcpus; i++) {
147 		struct kvm_cpu *cpu = kvm_cpus[i];
148 
149 		if (!cpu)
150 			continue;
151 
152 		pthread_kill(cpu->thread, SIGUSR1);
153 	}
154 
155 	serial8250__inject_sysrq(kvm);
156 }
157 
158 static void handle_sigalrm(int sig)
159 {
160 	serial8250__inject_interrupt(kvm);
161 	virtio_console__inject_interrupt(kvm);
162 }
163 
164 static void *kvm_cpu_thread(void *arg)
165 {
166 	current_kvm_cpu		= arg;
167 
168 	if (kvm_cpu__start(current_kvm_cpu))
169 		goto panic_kvm;
170 
171 	kvm_cpu__delete(current_kvm_cpu);
172 
173 	return (void *) (intptr_t) 0;
174 
175 panic_kvm:
176 	fprintf(stderr, "KVM exit reason: %u (\"%s\")\n",
177 		current_kvm_cpu->kvm_run->exit_reason,
178 		kvm_exit_reasons[current_kvm_cpu->kvm_run->exit_reason]);
179 	if (current_kvm_cpu->kvm_run->exit_reason == KVM_EXIT_UNKNOWN)
180 		fprintf(stderr, "KVM exit code: 0x%Lu\n",
181 			current_kvm_cpu->kvm_run->hw.hardware_exit_reason);
182 
183 	kvm_cpu__show_registers(current_kvm_cpu);
184 	kvm_cpu__show_code(current_kvm_cpu);
185 	kvm_cpu__show_page_tables(current_kvm_cpu);
186 
187 	kvm_cpu__delete(current_kvm_cpu);
188 
189 	return (void *) (intptr_t) 1;
190 }
191 
192 static char kernel[PATH_MAX];
193 const char *host_kernels[] = {
194 	"/boot/vmlinuz",
195 	"/boot/bzImage",
196 	NULL
197 };
198 const char *default_kernels[] = {
199 	"./bzImage",
200 	"../../arch/x86/boot/bzImage",
201 	NULL
202 };
203 
204 static void kernel_usage_with_options(void)
205 {
206 	const char **k;
207 	struct utsname uts;
208 
209 	fprintf(stderr, "Fatal: could not find default kernel image in:\n");
210 	k = &default_kernels[0];
211 	while (*k) {
212 		fprintf(stderr, "\t%s\n", *k);
213 		k++;
214 	}
215 
216 	if (uname(&uts) < 0)
217 		return;
218 
219 	k = &host_kernels[0];
220 	while (*k) {
221 		if (snprintf(kernel, PATH_MAX, "%s-%s", *k, uts.release) < 0)
222 			return;
223 		fprintf(stderr, "\t%s\n", kernel);
224 		k++;
225 	}
226 	fprintf(stderr, "\nPlease see 'kvm run --help' for more options.\n\n");
227 }
228 
229 static u64 host_ram_size(void)
230 {
231 	long page_size;
232 	long nr_pages;
233 
234 	nr_pages	= sysconf(_SC_PHYS_PAGES);
235 
236 	page_size	= sysconf(_SC_PAGE_SIZE);
237 
238 	return (nr_pages * page_size) >> MB_SHIFT;
239 }
240 
241 /*
242  * If user didn't specify how much memory it wants to allocate for the guest,
243  * avoid filling the whole host RAM.
244  */
245 #define RAM_SIZE_RATIO		0.8
246 
247 static u64 get_ram_size(int nr_cpus)
248 {
249 	long available;
250 	long ram_size;
251 
252 	ram_size	= 64 * (nr_cpus + 3);
253 
254 	available	= host_ram_size() * RAM_SIZE_RATIO;
255 
256 	if (ram_size > available)
257 		ram_size	= available;
258 
259 	return ram_size;
260 }
261 
262 static const char *find_kernel(void)
263 {
264 	const char **k;
265 	struct stat st;
266 	struct utsname uts;
267 
268 	k = &default_kernels[0];
269 	while (*k) {
270 		if (stat(*k, &st) < 0 || !S_ISREG(st.st_mode)) {
271 			k++;
272 			continue;
273 		}
274 		strncpy(kernel, *k, PATH_MAX);
275 		return kernel;
276 	}
277 
278 	if (uname(&uts) < 0)
279 		return NULL;
280 
281 	k = &host_kernels[0];
282 	while (*k) {
283 		if (snprintf(kernel, PATH_MAX, "%s-%s", *k, uts.release) < 0)
284 			return NULL;
285 
286 		if (stat(kernel, &st) < 0 || !S_ISREG(st.st_mode)) {
287 			k++;
288 			continue;
289 		}
290 		return kernel;
291 
292 	}
293 	return NULL;
294 }
295 
296 static int root_device(char *dev, long *part)
297 {
298 	struct stat st;
299 
300 	if (stat("/", &st) < 0)
301 		return -1;
302 
303 	*part = minor(st.st_dev);
304 
305 	sprintf(dev, "/dev/block/%u:0", major(st.st_dev));
306 	if (access(dev, R_OK) < 0)
307 		return -1;
308 
309 	return 0;
310 }
311 
312 static char *host_image(char *cmd_line, size_t size)
313 {
314 	char *t;
315 	char device[PATH_MAX];
316 	long part = 0;
317 
318 	t = malloc(PATH_MAX);
319 	if (!t)
320 		return NULL;
321 
322 	/* check for the root file system */
323 	if (root_device(device, &part) < 0) {
324 		free(t);
325 		return NULL;
326 	}
327 	strncpy(t, device, PATH_MAX);
328 	if (!strstr(cmd_line, "root=")) {
329 		char tmp[PATH_MAX];
330 		snprintf(tmp, sizeof(tmp), "root=/dev/vda%ld rw ", part);
331 		strlcat(cmd_line, tmp, size);
332 	}
333 	return t;
334 }
335 
336 int kvm_cmd_run(int argc, const char **argv, const char *prefix)
337 {
338 	static char real_cmdline[2048];
339 	unsigned int nr_online_cpus;
340 	int max_cpus;
341 	int exit_code = 0;
342 	int i;
343 	struct virtio_net_parameters net_params;
344 	char *hi;
345 
346 	signal(SIGALRM, handle_sigalrm);
347 	signal(SIGQUIT, handle_sigquit);
348 	signal(SIGUSR1, handle_sigusr1);
349 
350 	while (argc != 0) {
351 		argc = parse_options(argc, argv, options, run_usage,
352 				PARSE_OPT_STOP_AT_NON_OPTION);
353 		if (argc != 0) {
354 			if (kernel_filename) {
355 				fprintf(stderr, "Cannot handle parameter: "
356 						"%s\n", argv[0]);
357 				usage_with_options(run_usage, options);
358 				return EINVAL;
359 			}
360 			/* first unhandled parameter is treated as a kernel
361 			   image
362 			 */
363 			kernel_filename = argv[0];
364 			argv++;
365 			argc--;
366 		}
367 
368 	}
369 
370 	if (!kernel_filename)
371 		kernel_filename = find_kernel();
372 
373 	if (!kernel_filename) {
374 		kernel_usage_with_options();
375 		return EINVAL;
376 	}
377 
378 	if (nrcpus < 1 || nrcpus > KVM_NR_CPUS)
379 		die("Number of CPUs %d is out of [1;%d] range", nrcpus, KVM_NR_CPUS);
380 
381 	if (!ram_size)
382 		ram_size	= get_ram_size(nrcpus);
383 
384 	if (ram_size < MIN_RAM_SIZE_MB)
385 		die("Not enough memory specified: %lluMB (min %lluMB)", ram_size, MIN_RAM_SIZE_MB);
386 
387 	if (ram_size > host_ram_size())
388 		warning("Guest memory size %lluMB exceeds host physical RAM size %lluMB", ram_size, host_ram_size());
389 
390 	ram_size <<= MB_SHIFT;
391 
392 	if (!kvm_dev)
393 		kvm_dev = DEFAULT_KVM_DEV;
394 
395 	if (!console)
396 		console = DEFAULT_CONSOLE;
397 
398 	if (!strncmp(console, "virtio", 6))
399 		active_console  = CONSOLE_VIRTIO;
400 	else
401 		active_console  = CONSOLE_8250;
402 
403 	if (!host_ip_addr)
404 		host_ip_addr = DEFAULT_HOST_ADDR;
405 
406 	if (!guest_mac)
407 		guest_mac = DEFAULT_GUEST_MAC;
408 
409 	if (!script)
410 		script = DEFAULT_SCRIPT;
411 
412 	term_init();
413 
414 	kvm = kvm__init(kvm_dev, ram_size);
415 
416 	max_cpus = kvm__max_cpus(kvm);
417 
418 	if (nrcpus > max_cpus) {
419 		printf("  # Limit the number of CPUs to %d\n", max_cpus);
420 		kvm->nrcpus	= max_cpus;
421 	}
422 
423 	kvm->nrcpus = nrcpus;
424 
425 	memset(real_cmdline, 0, sizeof(real_cmdline));
426 	strcpy(real_cmdline, "notsc noapic noacpi pci=conf1 console=ttyS0 earlyprintk=serial");
427 	strcat(real_cmdline, " ");
428 	if (kernel_cmdline)
429 		strlcat(real_cmdline, kernel_cmdline, sizeof(real_cmdline));
430 
431 	hi = NULL;
432 	if (!image_filename[0]) {
433 		hi = host_image(real_cmdline, sizeof(real_cmdline));
434 		if (hi) {
435 			image_filename[0] = hi;
436 			readonly_image[0] = true;
437 			image_count++;
438 		}
439 	}
440 
441 	if (!strstr(real_cmdline, "root="))
442 		strlcat(real_cmdline, " root=/dev/vda rw ", sizeof(real_cmdline));
443 
444 	for (i = 0; i < image_count; i++) {
445 		if (image_filename[i]) {
446 			struct disk_image *disk = disk_image__open(image_filename[i], readonly_image[i]);
447 			if (!disk)
448 				die("unable to load disk image %s", image_filename[i]);
449 
450 			virtio_blk__init(kvm, disk);
451 		}
452 	}
453 	free(hi);
454 
455 	if (!kvm__load_kernel(kvm, kernel_filename, initrd_filename,
456 				real_cmdline))
457 		die("unable to load kernel %s", kernel_filename);
458 
459 	ioport__setup_legacy();
460 
461 	rtc__init();
462 
463 	serial8250__init(kvm);
464 
465 	pci__init();
466 
467 	if (active_console == CONSOLE_VIRTIO)
468 		virtio_console__init(kvm);
469 
470 	if (virtio_rng)
471 		virtio_rng__init(kvm);
472 
473 	if (!network)
474 		network = DEFAULT_NETWORK;
475 
476 	if (!strncmp(network, "virtio", 6)) {
477 		net_params = (struct virtio_net_parameters) {
478 			.host_ip = host_ip_addr,
479 			.self = kvm,
480 			.script = script
481 		};
482 		sscanf(guest_mac,	"%hhx:%hhx:%hhx:%hhx:%hhx:%hhx",
483 							net_params.guest_mac,
484 							net_params.guest_mac+1,
485 							net_params.guest_mac+2,
486 							net_params.guest_mac+3,
487 							net_params.guest_mac+4,
488 							net_params.guest_mac+5);
489 
490 		virtio_net__init(&net_params);
491 	}
492 
493 	kvm__start_timer(kvm);
494 
495 	kvm__setup_bios(kvm);
496 
497 	for (i = 0; i < nrcpus; i++) {
498 		kvm_cpus[i] = kvm_cpu__init(kvm, i);
499 		if (!kvm_cpus[i])
500 			die("unable to initialize KVM VCPU");
501 
502 		if (single_step)
503 			kvm_cpu__enable_singlestep(kvm_cpus[i]);
504 	}
505 
506 	kvm__init_ram(kvm);
507 
508 	nr_online_cpus = sysconf(_SC_NPROCESSORS_ONLN);
509 	thread_pool__init(nr_online_cpus);
510 
511 	for (i = 0; i < nrcpus; i++) {
512 		if (pthread_create(&kvm_cpus[i]->thread, NULL, kvm_cpu_thread, kvm_cpus[i]) != 0)
513 			die("unable to create KVM VCPU thread");
514 	}
515 
516 	for (i = 0; i < nrcpus; i++) {
517 		void *ret;
518 
519 		if (pthread_join(kvm_cpus[i]->thread, &ret) != 0)
520 			die("pthread_join");
521 
522 		if (ret != NULL)
523 			exit_code	= 1;
524 	}
525 
526 	kvm__delete(kvm);
527 
528 	if (!exit_code)
529 		printf("\n  # KVM session ended normally.\n");
530 
531 	return exit_code;
532 }
533