xref: /kvmtool/builtin-run.c (revision 18bd8c3bd2a7df24b691d26bd36116cb730fb0a0)
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 /*
217  * If user didn't specify how much memory it wants to allocate for the guest,
218  * avoid filling the whole host RAM.
219  */
220 #define RAM_SIZE_RATIO		0.8
221 
222 static u64 get_ram_size(int nr_cpus)
223 {
224 	long available;
225 	long page_size;
226 	long nr_pages;
227 	long ram_size;
228 
229 	ram_size	= 64 * (nr_cpus + 3);
230 
231 	nr_pages	= sysconf(_SC_PHYS_PAGES);
232 
233 	page_size	= sysconf(_SC_PAGE_SIZE);
234 
235 	available	= ((nr_pages * page_size) >> MB_SHIFT) * RAM_SIZE_RATIO;
236 
237 	if (ram_size > available)
238 		ram_size	= available;
239 
240 	return ram_size;
241 }
242 
243 static const char *find_kernel(void)
244 {
245 	const char **k;
246 	struct stat st;
247 	struct utsname uts;
248 
249 	k = &default_kernels[0];
250 	while (*k) {
251 		if (stat(*k, &st) < 0 || !S_ISREG(st.st_mode)) {
252 			k++;
253 			continue;
254 		}
255 		strncpy(kernel, *k, PATH_MAX);
256 		return kernel;
257 	}
258 
259 	if (uname(&uts) < 0)
260 		return NULL;
261 
262 	k = &host_kernels[0];
263 	while (*k) {
264 		if (snprintf(kernel, PATH_MAX, "%s-%s", *k, uts.release) < 0)
265 			return NULL;
266 
267 		if (stat(kernel, &st) < 0 || !S_ISREG(st.st_mode)) {
268 			k++;
269 			continue;
270 		}
271 		return kernel;
272 
273 	}
274 	return NULL;
275 }
276 
277 static int root_device(char *dev, long *part)
278 {
279 	struct stat st;
280 
281 	if (stat("/", &st) < 0)
282 		return -1;
283 
284 	*part = minor(st.st_dev);
285 
286 	sprintf(dev, "/dev/block/%u:0", major(st.st_dev));
287 	if (access(dev, R_OK) < 0)
288 		return -1;
289 
290 	return 0;
291 }
292 
293 static char *host_image(char *cmd_line, size_t size)
294 {
295 	char *t;
296 	char device[PATH_MAX];
297 	long part = 0;
298 
299 	t = malloc(PATH_MAX);
300 	if (!t)
301 		return NULL;
302 
303 	/* check for the root file system */
304 	if (root_device(device, &part) < 0) {
305 		free(t);
306 		return NULL;
307 	}
308 	strncpy(t, device, PATH_MAX);
309 	if (!strstr(cmd_line, "root=")) {
310 		char tmp[PATH_MAX];
311 		snprintf(tmp, sizeof(tmp), "root=/dev/vda%ld rw ", part);
312 		strlcat(cmd_line, tmp, size);
313 	}
314 	return t;
315 }
316 
317 int kvm_cmd_run(int argc, const char **argv, const char *prefix)
318 {
319 	static char real_cmdline[2048];
320 	unsigned int nr_online_cpus;
321 	int max_cpus;
322 	int exit_code = 0;
323 	int i;
324 	struct virtio_net_parameters net_params;
325 	char *hi;
326 
327 	signal(SIGALRM, handle_sigalrm);
328 	signal(SIGQUIT, handle_sigquit);
329 
330 	while (argc != 0) {
331 		argc = parse_options(argc, argv, options, run_usage,
332 				PARSE_OPT_STOP_AT_NON_OPTION);
333 		if (argc != 0) {
334 			if (kernel_filename) {
335 				fprintf(stderr, "Cannot handle parameter: "
336 						"%s\n", argv[0]);
337 				usage_with_options(run_usage, options);
338 				return EINVAL;
339 			}
340 			/* first unhandled parameter is treated as a kernel
341 			   image
342 			 */
343 			kernel_filename = argv[0];
344 			argv++;
345 			argc--;
346 		}
347 
348 	}
349 
350 	if (!kernel_filename)
351 		kernel_filename = find_kernel();
352 
353 	if (!kernel_filename) {
354 		kernel_usage_with_options();
355 		return EINVAL;
356 	}
357 
358 	if (nrcpus < 1 || nrcpus > KVM_NR_CPUS)
359 		die("Number of CPUs %d is out of [1;%d] range", nrcpus, KVM_NR_CPUS);
360 
361 	if (!ram_size)
362 		ram_size	= get_ram_size(nrcpus);
363 
364 	if (ram_size < MIN_RAM_SIZE_MB)
365 		die("Not enough memory specified: %lluMB (min %lluMB)", ram_size, MIN_RAM_SIZE_MB);
366 
367 	ram_size <<= MB_SHIFT;
368 
369 	if (!kvm_dev)
370 		kvm_dev = DEFAULT_KVM_DEV;
371 
372 	if (!console)
373 		console = DEFAULT_CONSOLE;
374 
375 	if (!strncmp(console, "virtio", 6))
376 		active_console  = CONSOLE_VIRTIO;
377 	else
378 		active_console  = CONSOLE_8250;
379 
380 	if (!host_ip_addr)
381 		host_ip_addr = DEFAULT_HOST_ADDR;
382 
383 	if (!guest_mac)
384 		guest_mac = DEFAULT_GUEST_MAC;
385 
386 	if (!script)
387 		script = DEFAULT_SCRIPT;
388 
389 	term_init();
390 
391 	kvm = kvm__init(kvm_dev, ram_size);
392 
393 	max_cpus = kvm__max_cpus(kvm);
394 
395 	if (nrcpus > max_cpus) {
396 		printf("  # Limit the number of CPUs to %d\n", max_cpus);
397 		kvm->nrcpus	= max_cpus;
398 	}
399 
400 	kvm->nrcpus = nrcpus;
401 
402 	memset(real_cmdline, 0, sizeof(real_cmdline));
403 	strcpy(real_cmdline, "notsc noapic noacpi pci=conf1 console=ttyS0 ");
404 	if (kernel_cmdline)
405 		strlcat(real_cmdline, kernel_cmdline, sizeof(real_cmdline));
406 
407 	hi = NULL;
408 	if (!image_filename[0]) {
409 		hi = host_image(real_cmdline, sizeof(real_cmdline));
410 		if (hi) {
411 			image_filename[0] = hi;
412 			readonly_image[0] = true;
413 			image_count++;
414 		}
415 	}
416 
417 	if (!strstr(real_cmdline, "root="))
418 		strlcat(real_cmdline, " root=/dev/vda rw ", sizeof(real_cmdline));
419 
420 	for (i = 0; i < image_count; i++) {
421 		if (image_filename[i]) {
422 			struct disk_image *disk = disk_image__open(image_filename[i], readonly_image[i]);
423 			if (!disk)
424 				die("unable to load disk image %s", image_filename[i]);
425 
426 			virtio_blk__init(kvm, disk);
427 		}
428 	}
429 	free(hi);
430 
431 	if (!kvm__load_kernel(kvm, kernel_filename, initrd_filename,
432 				real_cmdline))
433 		die("unable to load kernel %s", kernel_filename);
434 
435 	ioport__setup_legacy();
436 
437 	rtc__init();
438 
439 	serial8250__init(kvm);
440 
441 	pci__init();
442 
443 	if (active_console == CONSOLE_VIRTIO)
444 		virtio_console__init(kvm);
445 
446 	if (virtio_rng)
447 		virtio_rng__init(kvm);
448 
449 	if (!network)
450 		network = DEFAULT_NETWORK;
451 
452 	if (!strncmp(network, "virtio", 6)) {
453 		net_params = (struct virtio_net_parameters) {
454 			.host_ip = host_ip_addr,
455 			.self = kvm,
456 			.script = script
457 		};
458 		sscanf(guest_mac,	"%hhx:%hhx:%hhx:%hhx:%hhx:%hhx",
459 							net_params.guest_mac,
460 							net_params.guest_mac+1,
461 							net_params.guest_mac+2,
462 							net_params.guest_mac+3,
463 							net_params.guest_mac+4,
464 							net_params.guest_mac+5);
465 
466 		virtio_net__init(&net_params);
467 	}
468 
469 	kvm__start_timer(kvm);
470 
471 	kvm__setup_bios(kvm);
472 
473 	for (i = 0; i < nrcpus; i++) {
474 		kvm_cpus[i] = kvm_cpu__init(kvm, i);
475 		if (!kvm_cpus[i])
476 			die("unable to initialize KVM VCPU");
477 
478 		if (single_step)
479 			kvm_cpu__enable_singlestep(kvm_cpus[i]);
480 	}
481 
482 	kvm__init_ram(kvm);
483 
484 	nr_online_cpus = sysconf(_SC_NPROCESSORS_ONLN);
485 	thread_pool__init(nr_online_cpus);
486 
487 	for (i = 0; i < nrcpus; i++) {
488 		if (pthread_create(&kvm_cpus[i]->thread, NULL, kvm_cpu_thread, kvm_cpus[i]) != 0)
489 			die("unable to create KVM VCPU thread");
490 	}
491 
492 	for (i = 0; i < nrcpus; i++) {
493 		void *ret;
494 
495 		if (pthread_join(kvm_cpus[i]->thread, &ret) != 0)
496 			die("pthread_join");
497 
498 		if (ret != NULL)
499 			exit_code	= 1;
500 	}
501 
502 	kvm__delete(kvm);
503 
504 	if (!exit_code)
505 		printf("\n  # KVM session ended normally.\n");
506 
507 	return exit_code;
508 }
509