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