7 #include <sys/utsname.h>
12 /* user defined header files */
13 #include <linux/types.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>
26 #include <kvm/ioport.h>
27 #include <kvm/threadpool.h>
29 /* header files for gitish interface */
30 #include <kvm/kvm-run.h>
31 #include <kvm/parse-options.h>
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"
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
45 static struct kvm *kvm;
46 static struct kvm_cpu *kvm_cpus[KVM_NR_CPUS];
47 static __thread struct kvm_cpu *current_kvm_cpu;
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;
67 static int nrcpus = 1;
69 static const char * const run_usage[] = {
70 "kvm run [<options>] [<kernel image>]",
74 static int img_name_parser(const struct option *opt, const char *arg, int unset)
78 if (image_count >= MAX_DISK_IMAGES)
79 die("Currently only 4 images are supported");
81 image_filename[image_count] = arg;
82 sep = strstr(arg, ",");
84 if (strcmp(sep + 1, "ro") == 0)
85 readonly_image[image_count] = 1;
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",
101 OPT_BOOLEAN('\0', "virtio-rng", &virtio_rng,
102 "Enable virtio Random Number Generator"),
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"),
112 OPT_GROUP("Networking options:"),
113 OPT_STRING('n', "network", &network, "virtio",
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"),
130 static void handle_sigquit(int sig)
134 for (i = 0; i < nrcpus; i++) {
135 struct kvm_cpu *cpu = kvm_cpus[i];
137 kvm_cpu__show_registers(cpu);
138 kvm_cpu__show_code(cpu);
139 kvm_cpu__show_page_tables(cpu);
142 serial8250__inject_sysrq(kvm);
145 static void handle_sigalrm(int sig)
147 serial8250__inject_interrupt(kvm);
148 virtio_console__inject_interrupt(kvm);
151 static void *kvm_cpu_thread(void *arg)
153 current_kvm_cpu = arg;
155 if (kvm_cpu__start(current_kvm_cpu))
158 kvm_cpu__delete(current_kvm_cpu);
160 return (void *) (intptr_t) 0;
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);
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);
174 kvm_cpu__delete(current_kvm_cpu);
176 return (void *) (intptr_t) 1;
179 static char kernel[PATH_MAX];
180 const char *host_kernels[] = {
185 const char *default_kernels[] = {
187 "../../arch/x86/boot/bzImage",
191 static void kernel_usage_with_options(void)
196 fprintf(stderr, "Fatal: could not find default kernel image in:\n");
197 k = &default_kernels[0];
199 fprintf(stderr, "\t%s\n", *k);
206 k = &host_kernels[0];
208 if (snprintf(kernel, PATH_MAX, "%s-%s", *k, uts.release) < 0)
210 fprintf(stderr, "\t%s\n", kernel);
213 fprintf(stderr, "\nPlease see 'kvm run --help' for more options.\n\n");
216 static u64 host_ram_size(void)
221 nr_pages = sysconf(_SC_PHYS_PAGES);
223 page_size = sysconf(_SC_PAGE_SIZE);
225 return (nr_pages * page_size) >> MB_SHIFT;
229 * If user didn't specify how much memory it wants to allocate for the guest,
230 * avoid filling the whole host RAM.
232 #define RAM_SIZE_RATIO 0.8
234 static u64 get_ram_size(int nr_cpus)
239 ram_size = 64 * (nr_cpus + 3);
241 available = host_ram_size() * RAM_SIZE_RATIO;
243 if (ram_size > available)
244 ram_size = available;
249 static const char *find_kernel(void)
255 k = &default_kernels[0];
257 if (stat(*k, &st) < 0 || !S_ISREG(st.st_mode)) {
261 strncpy(kernel, *k, PATH_MAX);
268 k = &host_kernels[0];
270 if (snprintf(kernel, PATH_MAX, "%s-%s", *k, uts.release) < 0)
273 if (stat(kernel, &st) < 0 || !S_ISREG(st.st_mode)) {
283 static int root_device(char *dev, long *part)
287 if (stat("/", &st) < 0)
290 *part = minor(st.st_dev);
292 sprintf(dev, "/dev/block/%u:0", major(st.st_dev));
293 if (access(dev, R_OK) < 0)
299 static char *host_image(char *cmd_line, size_t size)
302 char device[PATH_MAX];
305 t = malloc(PATH_MAX);
309 /* check for the root file system */
310 if (root_device(device, &part) < 0) {
314 strncpy(t, device, PATH_MAX);
315 if (!strstr(cmd_line, "root=")) {
317 snprintf(tmp, sizeof(tmp), "root=/dev/vda%ld rw ", part);
318 strlcat(cmd_line, tmp, size);
323 int kvm_cmd_run(int argc, const char **argv, const char *prefix)
325 static char real_cmdline[2048];
326 unsigned int nr_online_cpus;
330 struct virtio_net_parameters net_params;
333 signal(SIGALRM, handle_sigalrm);
334 signal(SIGQUIT, handle_sigquit);
337 argc = parse_options(argc, argv, options, run_usage,
338 PARSE_OPT_STOP_AT_NON_OPTION);
340 if (kernel_filename) {
341 fprintf(stderr, "Cannot handle parameter: "
343 usage_with_options(run_usage, options);
346 /* first unhandled parameter is treated as a kernel
349 kernel_filename = argv[0];
356 if (!kernel_filename)
357 kernel_filename = find_kernel();
359 if (!kernel_filename) {
360 kernel_usage_with_options();
364 if (nrcpus < 1 || nrcpus > KVM_NR_CPUS)
365 die("Number of CPUs %d is out of [1;%d] range", nrcpus, KVM_NR_CPUS);
368 ram_size = get_ram_size(nrcpus);
370 if (ram_size < MIN_RAM_SIZE_MB)
371 die("Not enough memory specified: %lluMB (min %lluMB)", ram_size, MIN_RAM_SIZE_MB);
373 if (ram_size > host_ram_size())
374 warning("Guest memory size %lluMB exceeds host physical RAM size %lluMB", ram_size, host_ram_size());
376 ram_size <<= MB_SHIFT;
379 kvm_dev = DEFAULT_KVM_DEV;
382 console = DEFAULT_CONSOLE;
384 if (!strncmp(console, "virtio", 6))
385 active_console = CONSOLE_VIRTIO;
387 active_console = CONSOLE_8250;
390 host_ip_addr = DEFAULT_HOST_ADDR;
393 guest_mac = DEFAULT_GUEST_MAC;
396 script = DEFAULT_SCRIPT;
400 kvm = kvm__init(kvm_dev, ram_size);
402 max_cpus = kvm__max_cpus(kvm);
404 if (nrcpus > max_cpus) {
405 printf(" # Limit the number of CPUs to %d\n", max_cpus);
406 kvm->nrcpus = max_cpus;
409 kvm->nrcpus = nrcpus;
411 memset(real_cmdline, 0, sizeof(real_cmdline));
412 strcpy(real_cmdline, "notsc noapic noacpi pci=conf1 console=ttyS0 earlyprintk=serial");
414 strlcat(real_cmdline, kernel_cmdline, sizeof(real_cmdline));
417 if (!image_filename[0]) {
418 hi = host_image(real_cmdline, sizeof(real_cmdline));
420 image_filename[0] = hi;
421 readonly_image[0] = true;
426 if (!strstr(real_cmdline, "root="))
427 strlcat(real_cmdline, " root=/dev/vda rw ", sizeof(real_cmdline));
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]);
433 die("unable to load disk image %s", image_filename[i]);
435 virtio_blk__init(kvm, disk);
440 if (!kvm__load_kernel(kvm, kernel_filename, initrd_filename,
442 die("unable to load kernel %s", kernel_filename);
444 ioport__setup_legacy();
448 serial8250__init(kvm);
452 if (active_console == CONSOLE_VIRTIO)
453 virtio_console__init(kvm);
456 virtio_rng__init(kvm);
459 network = DEFAULT_NETWORK;
461 if (!strncmp(network, "virtio", 6)) {
462 net_params = (struct virtio_net_parameters) {
463 .host_ip = host_ip_addr,
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);
475 virtio_net__init(&net_params);
478 kvm__start_timer(kvm);
480 kvm__setup_bios(kvm);
482 for (i = 0; i < nrcpus; i++) {
483 kvm_cpus[i] = kvm_cpu__init(kvm, i);
485 die("unable to initialize KVM VCPU");
488 kvm_cpu__enable_singlestep(kvm_cpus[i]);
493 nr_online_cpus = sysconf(_SC_NPROCESSORS_ONLN);
494 thread_pool__init(nr_online_cpus);
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");
501 for (i = 0; i < nrcpus; i++) {
504 if (pthread_join(kvm_cpus[i]->thread, &ret) != 0)
514 printf("\n # KVM session ended normally.\n");