xref: /kvmtool/builtin-run.c (revision 6a5e9cf4e630095ceea44ee60887018baf66af0b)
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_sigquit(int sig)
131 {
132 	int i;
133 
134 	for (i = 0; i < nrcpus; i++) {
135 		struct kvm_cpu *cpu = kvm_cpus[i];
136 
137 		kvm_cpu__show_registers(cpu);
138 		kvm_cpu__show_code(cpu);
139 		kvm_cpu__show_page_tables(cpu);
140 	}
141 
142 	serial8250__inject_sysrq(kvm);
143 }
144 
145 static void handle_sigalrm(int sig)
146 {
147 	serial8250__inject_interrupt(kvm);
148 	virtio_console__inject_interrupt(kvm);
149 }
150 
151 static void *kvm_cpu_thread(void *arg)
152 {
153 	current_kvm_cpu		= arg;
154 
155 	if (kvm_cpu__start(current_kvm_cpu))
156 		goto panic_kvm;
157 
158 	kvm_cpu__delete(current_kvm_cpu);
159 
160 	return (void *) (intptr_t) 0;
161 
162 panic_kvm:
163 	fprintf(stderr, "KVM exit reason: %u (\"%s\")\n",
164 		current_kvm_cpu->kvm_run->exit_reason,
165 		kvm_exit_reasons[current_kvm_cpu->kvm_run->exit_reason]);
166 	if (current_kvm_cpu->kvm_run->exit_reason == KVM_EXIT_UNKNOWN)
167 		fprintf(stderr, "KVM exit code: 0x%Lu\n",
168 			current_kvm_cpu->kvm_run->hw.hardware_exit_reason);
169 
170 	kvm_cpu__show_registers(current_kvm_cpu);
171 	kvm_cpu__show_code(current_kvm_cpu);
172 	kvm_cpu__show_page_tables(current_kvm_cpu);
173 
174 	kvm_cpu__delete(current_kvm_cpu);
175 
176 	return (void *) (intptr_t) 1;
177 }
178 
179 static char kernel[PATH_MAX];
180 const char *host_kernels[] = {
181 	"/boot/vmlinuz",
182 	"/boot/bzImage",
183 	NULL
184 };
185 const char *default_kernels[] = {
186 	"./bzImage",
187 	"../../arch/x86/boot/bzImage",
188 	NULL
189 };
190 
191 static void kernel_usage_with_options(void)
192 {
193 	const char **k;
194 	struct utsname uts;
195 
196 	fprintf(stderr, "Fatal: could not find default kernel image in:\n");
197 	k = &default_kernels[0];
198 	while (*k) {
199 		fprintf(stderr, "\t%s\n", *k);
200 		k++;
201 	}
202 
203 	if (uname(&uts) < 0)
204 		return;
205 
206 	k = &host_kernels[0];
207 	while (*k) {
208 		if (snprintf(kernel, PATH_MAX, "%s-%s", *k, uts.release) < 0)
209 			return;
210 		fprintf(stderr, "\t%s\n", kernel);
211 		k++;
212 	}
213 	fprintf(stderr, "\nPlease see 'kvm run --help' for more options.\n\n");
214 }
215 
216 static u64 host_ram_size(void)
217 {
218 	long page_size;
219 	long nr_pages;
220 
221 	nr_pages	= sysconf(_SC_PHYS_PAGES);
222 
223 	page_size	= sysconf(_SC_PAGE_SIZE);
224 
225 	return (nr_pages * page_size) >> MB_SHIFT;
226 }
227 
228 /*
229  * If user didn't specify how much memory it wants to allocate for the guest,
230  * avoid filling the whole host RAM.
231  */
232 #define RAM_SIZE_RATIO		0.8
233 
234 static u64 get_ram_size(int nr_cpus)
235 {
236 	long available;
237 	long ram_size;
238 
239 	ram_size	= 64 * (nr_cpus + 3);
240 
241 	available	= host_ram_size() * RAM_SIZE_RATIO;
242 
243 	if (ram_size > available)
244 		ram_size	= available;
245 
246 	return ram_size;
247 }
248 
249 static const char *find_kernel(void)
250 {
251 	const char **k;
252 	struct stat st;
253 	struct utsname uts;
254 
255 	k = &default_kernels[0];
256 	while (*k) {
257 		if (stat(*k, &st) < 0 || !S_ISREG(st.st_mode)) {
258 			k++;
259 			continue;
260 		}
261 		strncpy(kernel, *k, PATH_MAX);
262 		return kernel;
263 	}
264 
265 	if (uname(&uts) < 0)
266 		return NULL;
267 
268 	k = &host_kernels[0];
269 	while (*k) {
270 		if (snprintf(kernel, PATH_MAX, "%s-%s", *k, uts.release) < 0)
271 			return NULL;
272 
273 		if (stat(kernel, &st) < 0 || !S_ISREG(st.st_mode)) {
274 			k++;
275 			continue;
276 		}
277 		return kernel;
278 
279 	}
280 	return NULL;
281 }
282 
283 static int root_device(char *dev, long *part)
284 {
285 	struct stat st;
286 
287 	if (stat("/", &st) < 0)
288 		return -1;
289 
290 	*part = minor(st.st_dev);
291 
292 	sprintf(dev, "/dev/block/%u:0", major(st.st_dev));
293 	if (access(dev, R_OK) < 0)
294 		return -1;
295 
296 	return 0;
297 }
298 
299 static char *host_image(char *cmd_line, size_t size)
300 {
301 	char *t;
302 	char device[PATH_MAX];
303 	long part = 0;
304 
305 	t = malloc(PATH_MAX);
306 	if (!t)
307 		return NULL;
308 
309 	/* check for the root file system */
310 	if (root_device(device, &part) < 0) {
311 		free(t);
312 		return NULL;
313 	}
314 	strncpy(t, device, PATH_MAX);
315 	if (!strstr(cmd_line, "root=")) {
316 		char tmp[PATH_MAX];
317 		snprintf(tmp, sizeof(tmp), "root=/dev/vda%ld rw ", part);
318 		strlcat(cmd_line, tmp, size);
319 	}
320 	return t;
321 }
322 
323 int kvm_cmd_run(int argc, const char **argv, const char *prefix)
324 {
325 	static char real_cmdline[2048];
326 	unsigned int nr_online_cpus;
327 	int max_cpus;
328 	int exit_code = 0;
329 	int i;
330 	struct virtio_net_parameters net_params;
331 	char *hi;
332 
333 	signal(SIGALRM, handle_sigalrm);
334 	signal(SIGQUIT, handle_sigquit);
335 
336 	while (argc != 0) {
337 		argc = parse_options(argc, argv, options, run_usage,
338 				PARSE_OPT_STOP_AT_NON_OPTION);
339 		if (argc != 0) {
340 			if (kernel_filename) {
341 				fprintf(stderr, "Cannot handle parameter: "
342 						"%s\n", argv[0]);
343 				usage_with_options(run_usage, options);
344 				return EINVAL;
345 			}
346 			/* first unhandled parameter is treated as a kernel
347 			   image
348 			 */
349 			kernel_filename = argv[0];
350 			argv++;
351 			argc--;
352 		}
353 
354 	}
355 
356 	if (!kernel_filename)
357 		kernel_filename = find_kernel();
358 
359 	if (!kernel_filename) {
360 		kernel_usage_with_options();
361 		return EINVAL;
362 	}
363 
364 	if (nrcpus < 1 || nrcpus > KVM_NR_CPUS)
365 		die("Number of CPUs %d is out of [1;%d] range", nrcpus, KVM_NR_CPUS);
366 
367 	if (!ram_size)
368 		ram_size	= get_ram_size(nrcpus);
369 
370 	if (ram_size < MIN_RAM_SIZE_MB)
371 		die("Not enough memory specified: %lluMB (min %lluMB)", ram_size, MIN_RAM_SIZE_MB);
372 
373 	if (ram_size > host_ram_size())
374 		warning("Guest memory size %lluMB exceeds host physical RAM size %lluMB", ram_size, host_ram_size());
375 
376 	ram_size <<= MB_SHIFT;
377 
378 	if (!kvm_dev)
379 		kvm_dev = DEFAULT_KVM_DEV;
380 
381 	if (!console)
382 		console = DEFAULT_CONSOLE;
383 
384 	if (!strncmp(console, "virtio", 6))
385 		active_console  = CONSOLE_VIRTIO;
386 	else
387 		active_console  = CONSOLE_8250;
388 
389 	if (!host_ip_addr)
390 		host_ip_addr = DEFAULT_HOST_ADDR;
391 
392 	if (!guest_mac)
393 		guest_mac = DEFAULT_GUEST_MAC;
394 
395 	if (!script)
396 		script = DEFAULT_SCRIPT;
397 
398 	term_init();
399 
400 	kvm = kvm__init(kvm_dev, ram_size);
401 
402 	max_cpus = kvm__max_cpus(kvm);
403 
404 	if (nrcpus > max_cpus) {
405 		printf("  # Limit the number of CPUs to %d\n", max_cpus);
406 		kvm->nrcpus	= max_cpus;
407 	}
408 
409 	kvm->nrcpus = nrcpus;
410 
411 	memset(real_cmdline, 0, sizeof(real_cmdline));
412 	strcpy(real_cmdline, "notsc noapic noacpi pci=conf1 console=ttyS0 earlyprintk=serial");
413 	if (kernel_cmdline)
414 		strlcat(real_cmdline, kernel_cmdline, sizeof(real_cmdline));
415 
416 	hi = NULL;
417 	if (!image_filename[0]) {
418 		hi = host_image(real_cmdline, sizeof(real_cmdline));
419 		if (hi) {
420 			image_filename[0] = hi;
421 			readonly_image[0] = true;
422 			image_count++;
423 		}
424 	}
425 
426 	if (!strstr(real_cmdline, "root="))
427 		strlcat(real_cmdline, " root=/dev/vda rw ", sizeof(real_cmdline));
428 
429 	for (i = 0; i < image_count; i++) {
430 		if (image_filename[i]) {
431 			struct disk_image *disk = disk_image__open(image_filename[i], readonly_image[i]);
432 			if (!disk)
433 				die("unable to load disk image %s", image_filename[i]);
434 
435 			virtio_blk__init(kvm, disk);
436 		}
437 	}
438 	free(hi);
439 
440 	if (!kvm__load_kernel(kvm, kernel_filename, initrd_filename,
441 				real_cmdline))
442 		die("unable to load kernel %s", kernel_filename);
443 
444 	ioport__setup_legacy();
445 
446 	rtc__init();
447 
448 	serial8250__init(kvm);
449 
450 	pci__init();
451 
452 	if (active_console == CONSOLE_VIRTIO)
453 		virtio_console__init(kvm);
454 
455 	if (virtio_rng)
456 		virtio_rng__init(kvm);
457 
458 	if (!network)
459 		network = DEFAULT_NETWORK;
460 
461 	if (!strncmp(network, "virtio", 6)) {
462 		net_params = (struct virtio_net_parameters) {
463 			.host_ip = host_ip_addr,
464 			.self = kvm,
465 			.script = script
466 		};
467 		sscanf(guest_mac,	"%hhx:%hhx:%hhx:%hhx:%hhx:%hhx",
468 							net_params.guest_mac,
469 							net_params.guest_mac+1,
470 							net_params.guest_mac+2,
471 							net_params.guest_mac+3,
472 							net_params.guest_mac+4,
473 							net_params.guest_mac+5);
474 
475 		virtio_net__init(&net_params);
476 	}
477 
478 	kvm__start_timer(kvm);
479 
480 	kvm__setup_bios(kvm);
481 
482 	for (i = 0; i < nrcpus; i++) {
483 		kvm_cpus[i] = kvm_cpu__init(kvm, i);
484 		if (!kvm_cpus[i])
485 			die("unable to initialize KVM VCPU");
486 
487 		if (single_step)
488 			kvm_cpu__enable_singlestep(kvm_cpus[i]);
489 	}
490 
491 	kvm__init_ram(kvm);
492 
493 	nr_online_cpus = sysconf(_SC_NPROCESSORS_ONLN);
494 	thread_pool__init(nr_online_cpus);
495 
496 	for (i = 0; i < nrcpus; i++) {
497 		if (pthread_create(&kvm_cpus[i]->thread, NULL, kvm_cpu_thread, kvm_cpus[i]) != 0)
498 			die("unable to create KVM VCPU thread");
499 	}
500 
501 	for (i = 0; i < nrcpus; i++) {
502 		void *ret;
503 
504 		if (pthread_join(kvm_cpus[i]->thread, &ret) != 0)
505 			die("pthread_join");
506 
507 		if (ret != NULL)
508 			exit_code	= 1;
509 	}
510 
511 	kvm__delete(kvm);
512 
513 	if (!exit_code)
514 		printf("\n  # KVM session ended normally.\n");
515 
516 	return exit_code;
517 }
518